1include "OptionsBase.td" 2 3let Command = "target modules dump symtab" in { 4 def tm_sort : Option<"sort", "s">, Group<1>, 5 Desc<"Supply a sort order when dumping the symbol table.">, 6 EnumArg<"SortOrder", "OptionEnumValues(g_sort_option_enumeration)">; 7 def tm_smn : Option<"show-mangled-names", "m">, Group<1>, 8 Desc<"Do not demangle symbol names before showing them.">; 9} 10 11let Command = "help" in { 12 def help_hide_aliases : Option<"hide-aliases", "a">, 13 Desc<"Hide aliases in the command list.">; 14 def help_hide_user : Option<"hide-user-commands", "u">, 15 Desc<"Hide user-defined commands from the list.">; 16 def help_show_hidden : Option<"show-hidden-commands", "h">, 17 Desc<"Include commands prefixed with an underscore.">; 18} 19 20let Command = "settings set" in { 21 def setset_global : Option<"global", "g">, 22 Desc<"Apply the new value to the global default value.">; 23 def setset_force : Option<"force", "f">, 24 Desc<"Force an empty value to be accepted as the default.">; 25} 26 27let Command = "settings write" in { 28 def setwrite_file : Option<"file", "f">, Required, Arg<"Filename">, 29 Completion<"DiskFile">, 30 Desc<"The file into which to write the settings.">; 31 def setwrite_append : Option<"append", "a">, 32 Desc<"Append to saved settings file if it exists.">; 33} 34 35let Command = "settings read" in { 36 def setread_file : Option<"file", "f">, Required, Arg<"Filename">, 37 Completion<"DiskFile">, 38 Desc<"The file from which to read the settings.">; 39} 40 41let Command = "settings clear" in { 42 def setclear_all : Option<"all", "a">, 43 Desc<"Clear all settings.">; 44} 45 46let Command = "breakpoint list" in { 47 // FIXME: We need to add an "internal" command, and then add this sort of 48 // thing to it. But I need to see it for now, and don't want to wait. 49 def blist_internal : Option<"internal", "i">, 50 Desc<"Show debugger internal breakpoints">; 51 def blist_brief : Option<"brief", "b">, Group<1>, 52 Desc<"Give a brief description of the breakpoint (no location info).">; 53 def blist_full : Option<"full", "f">, Group<2>, 54 Desc<"Give a full description of the breakpoint and its locations.">; 55 def blist_verbose : Option<"verbose", "v">, Group<3>, 56 Desc<"Explain everything we know about the breakpoint (for debugging " 57 "debugger bugs).">; 58 def blist_dummy_bp : Option<"dummy-breakpoints", "D">, 59 Desc<"List Dummy breakpoints - i.e. breakpoints set before a file is " 60 "provided, which prime new targets.">; 61} 62 63let Command = "breakpoint modify" in { 64 def breakpoint_modify_ignore_count : Option<"ignore-count", "i">, Group<1>, 65 Arg<"Count">, 66 Desc<"Set the number of times this breakpoint is skipped before stopping.">; 67 def breakpoint_modify_one_shot : Option<"one-shot", "o">, Group<1>, 68 Arg<"Boolean">, 69 Desc<"The breakpoint is deleted the first time it stop causes a stop.">; 70 def breakpoint_modify_thread_index : Option<"thread-index", "x">, Group<1>, 71 Arg<"ThreadIndex">, Desc<"The breakpoint stops only for the thread whose " 72 "index matches this argument.">; 73 def breakpoint_modify_thread_id : Option<"thread-id", "t">, Group<1>, 74 Arg<"ThreadID">, Desc<"The breakpoint stops only for the thread whose TID " 75 "matches this argument. The token 'current' resolves to the current thread's ID.">; 76 def breakpoint_modify_thread_name : Option<"thread-name", "T">, Group<1>, 77 Arg<"ThreadName">, Desc<"The breakpoint stops only for the thread whose " 78 "thread name matches this argument.">; 79 def breakpoint_modify_queue_name : Option<"queue-name", "q">, Group<1>, 80 Arg<"QueueName">, Desc<"The breakpoint stops only for threads in the queue " 81 "whose name is given by this argument.">; 82 def breakpoint_modify_condition : Option<"condition", "c">, Group<1>, 83 Arg<"Expression">, Desc<"The breakpoint stops only if this condition " 84 "expression evaluates to true.">; 85 def breakpoint_modify_auto_continue : Option<"auto-continue", "G">, Group<1>, 86 Arg<"Boolean">, 87 Desc<"The breakpoint will auto-continue after running its commands.">; 88 def breakpoint_modify_enable : Option<"enable", "e">, Group<2>, 89 Desc<"Enable the breakpoint.">; 90 def breakpoint_modify_disable : Option<"disable", "d">, Group<3>, 91 Desc<"Disable the breakpoint.">; 92 def breakpoint_modify_command : Option<"command", "C">, Group<4>, 93 Arg<"Command">, 94 Desc<"A command to run when the breakpoint is hit, can be provided more " 95 "than once, the commands will get run in order left to right.">; 96} 97 98let Command = "breakpoint dummy" in { 99 def breakpoint_dummy_options_dummy_breakpoints : 100 Option<"dummy-breakpoints", "D">, Group<1>, 101 Desc<"Act on Dummy breakpoints - i.e. breakpoints set before a file is " 102 "provided, which prime new targets.">; 103} 104 105let Command = "breakpoint set" in { 106 def breakpoint_set_shlib : Option<"shlib", "s">, Arg<"ShlibName">, 107 Completion<"Module">, Groups<[1,2,3,4,5,6,7,8,9,11,12]>, // *not* in group 10 108 Desc<"Set the breakpoint only in this shared library. Can repeat this " 109 "option multiple times to specify multiple shared libraries.">; 110 def breakpoint_set_hardware : Option<"hardware", "H">, 111 Desc<"Require the breakpoint to use hardware breakpoints.">; 112 def breakpoint_set_file : Option<"file", "f">, Arg<"Filename">, 113 Completion<"SourceFile">, Groups<[1,3,4,5,6,7,8,9,11]>, 114 Desc<"Specifies the source file in which to set this breakpoint. Note, by " 115 "default lldb only looks for files that are #included if they use the " 116 "standard include file extensions. To set breakpoints on .c/.cpp/.m/.mm " 117 "files that are #included, set target.inline-breakpoint-strategy to " 118 "\"always\".">; 119 def breakpoint_set_line : Option<"line", "l">, Group<1>, Arg<"LineNum">, 120 Required, 121 Desc<"Specifies the line number on which to set this breakpoint.">; 122 def breakpoint_set_column : Option<"column", "u">, Group<1>, Arg<"ColumnNum">, 123 Desc<"Specifies the column number on which to set this breakpoint.">; 124 def breakpoint_set_address : Option<"address", "a">, Group<2>, 125 Arg<"AddressOrExpression">, Required, 126 Desc<"Set the breakpoint at the specified address. If the address maps " 127 "uniquely to a particular binary, then the address will be converted to " 128 "a \"file\"address, so that the breakpoint will track that binary+offset " 129 "no matter where the binary eventually loads. Alternately, if you also " 130 "specify the module - with the -s option - then the address will be " 131 "treated as a file address in that module, and resolved accordingly. " 132 "Again, this will allow lldb to track that offset on subsequent reloads. " 133 " The module need not have been loaded at the time you specify this " 134 "breakpoint, and will get resolved when the module is loaded.">; 135 def breakpoint_set_name : Option<"name", "n">, Group<3>, Arg<"FunctionName">, 136 Completion<"Symbol">, Required, 137 Desc<"Set the breakpoint by function name. Can be repeated multiple times " 138 "to makeone breakpoint for multiple names">; 139 def breakpoint_set_source_regexp_function : 140 Option<"source-regexp-function", "X">, Group<9>, Arg<"FunctionName">, 141 Completion<"Symbol">, 142 Desc<"When used with '-p' limits the source regex to source contained in " 143 "the namedfunctions. Can be repeated multiple times.">; 144 def breakpoint_set_fullname : Option<"fullname", "F">, Group<4>, 145 Arg<"FullName">, Required, Completion<"Symbol">, 146 Desc<"Set the breakpoint by fully qualified function names. For C++ this " 147 "means namespaces and all arguments, and for Objective-C this means a full " 148 "functionprototype with class and selector. Can be repeated multiple times" 149 " to make one breakpoint for multiple names.">; 150 def breakpoint_set_selector : Option<"selector", "S">, Group<5>, 151 Arg<"Selector">, Required, 152 Desc<"Set the breakpoint by ObjC selector name. Can be repeated multiple " 153 "times to make one breakpoint for multiple Selectors.">; 154 def breakpoint_set_method : Option<"method", "M">, Group<6>, Arg<"Method">, 155 Required, Desc<"Set the breakpoint by C++ method names. Can be repeated " 156 "multiple times to make one breakpoint for multiple methods.">; 157 def breakpoint_set_func_regex : Option<"func-regex", "r">, Group<7>, 158 Arg<"RegularExpression">, Required, Desc<"Set the breakpoint by function " 159 "name, evaluating a regular-expression to find the function name(s).">; 160 def breakpoint_set_basename : Option<"basename", "b">, Group<8>, 161 Arg<"FunctionName">, Required, Completion<"Symbol">, 162 Desc<"Set the breakpoint by function basename (C++ namespaces and arguments" 163 " will beignored). Can be repeated multiple times to make one breakpoint " 164 "for multiplesymbols.">; 165 def breakpoint_set_source_pattern_regexp : 166 Option<"source-pattern-regexp", "p">, Group<9>, Arg<"RegularExpression">, 167 Required, Desc<"Set the breakpoint by specifying a regular expression which" 168 " is matched against the source text in a source file or files specified " 169 "with the -f can be specified more than once. If no source files " 170 "are specified, uses the current \"default source file\". If you want to " 171 "match against all source files, pass the \"--all-files\" option.">; 172 def breakpoint_set_all_files : Option<"all-files", "A">, Group<9>, 173 Desc<"All files are searched for source pattern matches.">; 174 def breakpoint_set_language_exception : Option<"language-exception", "E">, 175 Group<10>, Arg<"Language">, Required, 176 Desc<"Set the breakpoint on exceptions thrown by the specified language " 177 "(without options, on throw but not catch.)">; 178 def breakpoint_set_on_throw : Option<"on-throw", "w">, Group<10>, 179 Arg<"Boolean">, Desc<"Set the breakpoint on exception throW.">; 180 def breakpoint_set_on_catch : Option<"on-catch", "h">, Group<10>, 181 Arg<"Boolean">, Desc<"Set the breakpoint on exception catcH.">; 182 def breakpoint_set_language : Option<"language", "L">, GroupRange<3, 8>, 183 Arg<"Language">, 184 Desc<"Specifies the Language to use when interpreting the breakpoint's " 185 "expression (note: currently only implemented for setting breakpoints on " 186 "identifiers). If not set the target.language setting is used.">; 187 def breakpoint_set_skip_prologue : Option<"skip-prologue", "K">, 188 Arg<"Boolean">, Groups<[1,3,4,5,6,7,8,12]>, 189 Desc<"sKip the prologue if the breakpoint is at the beginning of a " 190 "function. If not set the target.skip-prologue setting is used.">; 191 def breakpoint_set_breakpoint_name : Option<"breakpoint-name", "N">, 192 Arg<"BreakpointName">, 193 Desc<"Adds this to the list of names for this breakpoint.">; 194 def breakpoint_set_address_slide : Option<"address-slide", "R">, 195 Arg<"Address">, Groups<[1,3,4,5,6,7,8,12]>, 196 Desc<"Add the specified offset to whatever address(es) the breakpoint " 197 "resolves to. At present this applies the offset directly as given, and " 198 "doesn't try to align it to instruction boundaries.">; 199 def breakpoint_set_move_to_nearest_code : Option<"move-to-nearest-code", "m">, 200 Groups<[1,9,12]>, Arg<"Boolean">, 201 Desc<"Move breakpoints to nearest code. If not set the " 202 "target.move-to-nearest-code setting is used.">; 203 def breakpoint_set_file_colon_line : Option<"joint-specifier", "y">, Group<12>, Arg<"FileLineColumn">, 204 Required, Completion<"SourceFile">, 205 Desc<"A specifier in the form filename:line[:column] for setting file & line breakpoints.">; 206 /* Don't add this option till it actually does something useful... 207 def breakpoint_set_exception_typename : Option<"exception-typename", "O">, 208 Arg<"TypeName">, Desc<"The breakpoint will only stop if an " 209 "exception Object of this type is thrown. Can be repeated multiple times " 210 "to stop for multiple object types">; 211 */ 212} 213 214let Command = "breakpoint clear" in { 215 def breakpoint_clear_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 216 Completion<"SourceFile">, 217 Desc<"Specify the breakpoint by source location in this particular file.">; 218 def breakpoint_clear_line : Option<"line", "l">, Group<1>, Arg<"LineNum">, 219 Required, 220 Desc<"Specify the breakpoint by source location at this particular line.">; 221} 222 223let Command = "breakpoint delete" in { 224 def breakpoint_delete_force : Option<"force", "f">, Group<1>, 225 Desc<"Delete all breakpoints without querying for confirmation.">; 226 def breakpoint_delete_dummy_breakpoints : Option<"dummy-breakpoints", "D">, 227 Group<1>, Desc<"Delete Dummy breakpoints - i.e. breakpoints set before a " 228 "file is provided, which prime new targets.">; 229 def breakpoint_delete_disabled : Option<"disabled", "d">, Group<1>, 230 Desc<"Delete all breakpoints which are currently disabled. When using the disabled option " 231 "any breakpoints listed on the command line are EXCLUDED from deletion.">; 232} 233 234let Command = "breakpoint name" in { 235 def breakpoint_name_name : Option<"name", "N">, Group<1>, 236 Arg<"BreakpointName">, Desc<"Specifies a breakpoint name to use.">; 237 def breakpoint_name_breakpoint_id : Option<"breakpoint-id", "B">, Group<2>, 238 Arg<"BreakpointID">, Desc<"Specify a breakpoint ID to use.">; 239 def breakpoint_name_dummy_breakpoints : Option<"dummy-breakpoints", "D">, 240 Group<3>, Desc<"Operate on Dummy breakpoints - i.e. breakpoints set before " 241 "a file is provided, which prime new targets.">; 242 def breakpoint_name_help_string : Option<"help-string", "H">, Group<4>, 243 Arg<"None">, Desc<"A help string describing the purpose of this name.">; 244} 245 246let Command = "breakpoint access" in { 247 def breakpoint_access_allow_list : Option<"allow-list", "L">, Group<1>, 248 Arg<"Boolean">, Desc<"Determines whether the breakpoint will show up in " 249 "break list if not referred to explicitly.">; 250 def breakpoint_access_allow_disable : Option<"allow-disable", "A">, Group<2>, 251 Arg<"Boolean">, Desc<"Determines whether the breakpoint can be disabled by " 252 "name or when all breakpoints are disabled.">; 253 def breakpoint_access_allow_delete : Option<"allow-delete", "D">, Group<3>, 254 Arg<"Boolean">, Desc<"Determines whether the breakpoint can be deleted by " 255 "name or when all breakpoints are deleted.">; 256} 257 258let Command = "breakpoint read" in { 259 def breakpoint_read_file : Option<"file", "f">, Arg<"Filename">, Required, 260 Completion<"DiskFile">, 261 Desc<"The file from which to read the breakpoints.">; 262 def breakpoint_read_breakpoint_name : Option<"breakpoint-name", "N">, 263 Arg<"BreakpointName">, Desc<"Only read in breakpoints with this name.">; 264} 265 266let Command = "breakpoint write" in { 267 def breakpoint_write_file : Option<"file", "f">, Arg<"Filename">, Required, 268 Completion<"DiskFile">, 269 Desc<"The file into which to write the breakpoints.">; 270 def breakpoint_write_append : Option<"append", "a">, 271 Desc<"Append to saved breakpoints file if it exists.">; 272} 273 274let Command = "breakpoint command add" in { 275 def breakpoint_add_one_liner : Option<"one-liner", "o">, Group<1>, 276 Arg<"OneLiner">, Desc<"Specify a one-line breakpoint command inline. Be " 277 "sure to surround it with quotes.">; 278 def breakpoint_add_stop_on_error : Option<"stop-on-error", "e">, 279 Arg<"Boolean">, Desc<"Specify whether breakpoint command execution should " 280 "terminate on error.">; 281 def breakpoint_add_script_type : Option<"script-type", "s">, 282 EnumArg<"None", "ScriptOptionEnum()">, 283 Desc<"Specify the language for the commands - if none is specified, the " 284 "lldb command interpreter will be used.">; 285 def breakpoint_add_dummy_breakpoints : Option<"dummy-breakpoints", "D">, 286 Desc<"Sets Dummy breakpoints - i.e. breakpoints set before a file is " 287 "provided, which prime new targets.">; 288} 289 290let Command = "breakpoint command delete" in { 291 def breakpoint_command_delete_dummy_breakpoints : 292 Option<"dummy-breakpoints", "D">, Group<1>, 293 Desc<"Delete commands from Dummy breakpoints - i.e. breakpoints set before " 294 "a file is provided, which prime new targets.">; 295} 296 297let Command = "disassemble" in { 298 def disassemble_options_bytes : Option<"bytes", "b">, 299 Desc<"Show opcode bytes when disassembling.">; 300 def disassemble_options_context : Option<"context", "C">, Arg<"NumLines">, 301 Desc<"Number of context lines of source to show.">; 302 def disassemble_options_mixed : Option<"mixed", "m">, 303 Desc<"Enable mixed source and assembly display.">; 304 def disassemble_options_raw : Option<"raw", "r">, 305 Desc<"Print raw disassembly with no symbol information.">; 306 def disassemble_options_plugin : Option<"plugin", "P">, Arg<"Plugin">, 307 Desc<"Name of the disassembler plugin you want to use.">; 308 def disassemble_options_flavor : Option<"flavor", "F">, 309 Arg<"DisassemblyFlavor">, Desc<"Name of the disassembly flavor you want to " 310 "use. Currently the only valid options are default, and for Intel " 311 "architectures, att and intel.">; 312 def disassemble_options_arch : Option<"arch", "A">, Arg<"Architecture">, 313 Desc<"Specify the architecture to use from cross disassembly.">; 314 def disassemble_options_start_address : Option<"start-address", "s">, 315 Groups<[1,2]>, Arg<"AddressOrExpression">, Required, 316 Desc<"Address at which to start disassembling.">; 317 def disassemble_options_end_address : Option<"end-address", "e">, Group<1>, 318 Arg<"AddressOrExpression">, Desc<"Address at which to end disassembling.">; 319 def disassemble_options_count : Option<"count", "c">, Groups<[2,3,4,5,7]>, 320 Arg<"NumLines">, Desc<"Number of instructions to display.">; 321 def disassemble_options_name : Option<"name", "n">, Group<3>, 322 Arg<"FunctionName">, Completion<"Symbol">, 323 Desc<"Disassemble entire contents of the given function name.">; 324 def disassemble_options_frame : Option<"frame", "f">, Group<4>, 325 Desc<"Disassemble from the start of the current frame's function.">; 326 def disassemble_options_pc : Option<"pc", "p">, Group<5>, 327 Desc<"Disassemble around the current pc.">; 328 def disassemble_options_line : Option<"line", "l">, Group<6>, 329 Desc<"Disassemble the current frame's current source line instructions if " 330 "there is debug line table information, else disassemble around the pc.">; 331 def disassemble_options_address : Option<"address", "a">, Group<7>, 332 Arg<"AddressOrExpression">, 333 Desc<"Disassemble function containing this address.">; 334 def disassemble_options_force : Option<"force", "\\x01">, Groups<[2,3,4,5,7]>, 335 Desc<"Force dissasembly of large functions.">; 336} 337 338let Command = "expression" in { 339 def expression_options_all_threads : Option<"all-threads", "a">, 340 Groups<[1,2]>, Arg<"Boolean">, Desc<"Should we run all threads if the " 341 "execution doesn't complete on one thread.">; 342 def expression_options_ignore_breakpoints : Option<"ignore-breakpoints", "i">, 343 Groups<[1,2]>, Arg<"Boolean">, 344 Desc<"Ignore breakpoint hits while running expressions">; 345 def expression_options_timeout : Option<"timeout", "t">, Groups<[1,2]>, 346 Arg<"UnsignedInteger">, 347 Desc<"Timeout value (in microseconds) for running the expression.">; 348 def expression_options_unwind_on_error : Option<"unwind-on-error", "u">, 349 Groups<[1,2]>, Arg<"Boolean">, 350 Desc<"Clean up program state if the expression causes a crash, or raises a " 351 "signal. Note, unlike gdb hitting a breakpoint is controlled by another " 352 "option (-i).">; 353 def expression_options_debug : Option<"debug", "g">, Groups<[1,2]>, 354 Desc<"When specified, debug the JIT code by setting a breakpoint on the " 355 "first instruction and forcing breakpoints to not be ignored (-i0) and no " 356 "unwinding to happen on error (-u0).">; 357 def expression_options_language : Option<"language", "l">, Groups<[1,2,3]>, 358 Arg<"Language">, Desc<"Specifies the Language to use when parsing the " 359 "expression. If not set the target.language setting is used.">; 360 def expression_options_apply_fixits : Option<"apply-fixits", "X">, 361 Groups<[1,2]>, Arg<"Language">, Desc<"If true, simple fix-it hints will be " 362 "automatically applied to the expression.">; 363 def expression_options_description_verbosity : 364 Option<"description-verbosity", "v">, Group<1>, 365 OptionalEnumArg<"DescriptionVerbosity", "DescriptionVerbosityTypes()">, 366 Desc<"How verbose should the output of this expression be, if the object " 367 "description is asked for.">; 368 def expression_options_top_level : Option<"top-level", "p">, Groups<[1,2]>, 369 Desc<"Interpret the expression as a complete translation unit, without " 370 "injecting it into the local context. Allows declaration of persistent, " 371 "top-level entities without a $ prefix.">; 372 def expression_options_allow_jit : Option<"allow-jit", "j">, Groups<[1,2]>, 373 Arg<"Boolean">, 374 Desc<"Controls whether the expression can fall back to being JITted if it's " 375 "not supported by the interpreter (defaults to true).">; 376} 377 378let Command = "frame diag" in { 379 def frame_diag_register : Option<"register", "r">, Group<1>, 380 Arg<"RegisterName">, Desc<"A register to diagnose.">; 381 def frame_diag_address : Option<"address", "a">, Group<1>, Arg<"Address">, 382 Desc<"An address to diagnose.">; 383 def frame_diag_offset : Option<"offset", "o">, Group<1>, Arg<"Offset">, 384 Desc<"An optional offset. Requires --register.">; 385} 386 387let Command = "frame select" in { 388 def frame_select_relative : Option<"relative", "r">, Group<1>, Arg<"Offset">, 389 Desc<"A relative frame index offset from the current frame index.">; 390} 391 392let Command = "frame recognizer add" in { 393 def frame_recognizer_shlib : Option<"shlib", "s">, Arg<"ShlibName">, 394 Completion<"Module">, 395 Desc<"Name of the module or shared library that this recognizer applies " 396 "to.">; 397 def frame_recognizer_function : Option<"function", "n">, Arg<"Name">, 398 Completion<"Symbol">, 399 Desc<"Name of the function that this recognizer applies to. " 400 "Can be specified more than once except if -x|--regex is provided.">; 401 def frame_recognizer_python_class : Option<"python-class", "l">, Group<2>, 402 Arg<"PythonClass">, 403 Desc<"Give the name of a Python class to use for this frame recognizer.">; 404 def frame_recognizer_regex : Option<"regex", "x">, 405 Desc<"Function name and module name are actually regular expressions.">; 406 def frame_recognizer_first_instruction_only : Option<"first-instruction-only", "f">, Arg<"Boolean">, 407 Desc<"If true, only apply this recognizer to frames whose PC currently points to the " 408 "first instruction of the specified function. If false, the recognizer " 409 "will always be applied, regardless of the current position within the specified function. The " 410 "implementor should keep in mind that some features, e.g. accessing function argument " 411 "values via $arg<N>, are not guaranteed to work reliably in this case, so extra care must " 412 "be taken to make the recognizer operate correctly. Defaults to true.">; 413} 414 415let Command = "history" in { 416 def history_count : Option<"count", "c">, Group<1>, Arg<"UnsignedInteger">, 417 Desc<"How many history commands to print.">; 418 def history_start_index : Option<"start-index", "s">, Group<1>, 419 Arg<"UnsignedInteger">, Desc<"Index at which to start printing history " 420 "commands (or end to mean tail mode).">; 421 def history_end_index : Option<"end-index", "e">, Group<1>, 422 Arg<"UnsignedInteger">, 423 Desc<"Index at which to stop printing history commands.">; 424 def history_clear : Option<"clear", "C">, Group<2>, 425 Desc<"Clears the current command history.">; 426} 427 428let Command = "log" in { 429 def log_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 430 Desc<"Set the destination file to log to.">; 431 def log_threadsafe : Option<"threadsafe", "t">, Group<1>, 432 Desc<"Enable thread safe logging to avoid interweaved log lines.">; 433 def log_verbose : Option<"verbose", "v">, Group<1>, 434 Desc<"Enable verbose logging.">; 435 def log_sequence : Option<"sequence", "s">, Group<1>, 436 Desc<"Prepend all log lines with an increasing integer sequence id.">; 437 def log_timestamp : Option<"timestamp", "T">, Group<1>, 438 Desc<"Prepend all log lines with a timestamp.">; 439 def log_pid_tid : Option<"pid-tid", "p">, Group<1>, 440 Desc<"Prepend all log lines with the process and thread ID that generates " 441 "the log line.">; 442 def log_thread_name : Option<"thread-name", "n">, Group<1>, 443 Desc<"Prepend all log lines with the thread name for the thread that " 444 "generates the log line.">; 445 446 def log_stack : Option<"stack", "S">, Group<1>, 447 Desc<"Append a stack backtrace to each log line.">; 448 def log_append : Option<"append", "a">, Group<1>, 449 Desc<"Append to the log file instead of overwriting.">; 450 def log_file_function : Option<"file-function", "F">, Group<1>, 451 Desc<"Prepend the names of files and function that generate the logs.">; 452} 453 454let Command = "reproducer dump" in { 455 def reproducer_provider : Option<"provider", "p">, Group<1>, 456 EnumArg<"None", "ReproducerProviderType()">, 457 Required, Desc<"The reproducer provider to dump.">; 458 def reproducer_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 459 Desc<"The reproducer path. If a reproducer is replayed and no path is " 460 "provided, that reproducer is dumped.">; 461} 462 463let Command = "reproducer verify" in { 464 def reproducer_verify_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 465 Desc<"The reproducer path. If a reproducer is replayed and no path is " 466 "provided, that reproducer is dumped.">; 467} 468 469let Command = "reproducer xcrash" in { 470 def reproducer_signal : Option<"signal", "s">, Group<1>, 471 EnumArg<"None", "ReproducerSignalType()">, 472 Required, Desc<"The signal to crash the debugger.">; 473} 474 475let Command = "memory read" in { 476 def memory_read_num_per_line : Option<"num-per-line", "l">, Group<1>, 477 Arg<"NumberPerLine">, Desc<"The number of items per line to display.">; 478 def memory_read_binary : Option<"binary", "b">, Group<2>, 479 Desc<"If true, memory will be saved as binary. If false, the memory is " 480 "saved save as an ASCII dump that uses the format, size, count and number " 481 "per line settings.">; 482 def memory_read_type : Option<"type", "t">, Groups<[3,4]>, Arg<"Name">, 483 Required, Desc<"The name of a type to view memory as.">; 484 def memory_read_language : Option<"language", "x">, Group<4>, Arg<"Language">, 485 Desc<"The language of the type to view memory as.">; 486 def memory_read_offset : Option<"offset", "E">, Group<3>, Arg<"Count">, 487 Desc<"How many elements of the specified type to skip before starting to " 488 "display data.">; 489 def memory_read_force : Option<"force", "r">, Groups<[1,2,3]>, 490 Desc<"Necessary if reading over target.max-memory-read-size bytes.">; 491 def memory_read_show_tags : Option<"show-tags", "\\x01">, Group<1>, 492 Desc<"Include memory tags in output (does not apply to binary output).">; 493} 494 495let Command = "memory find" in { 496 def memory_find_expression : Option<"expression", "e">, Group<1>, 497 Arg<"Expression">, Required, 498 Desc<"Evaluate an expression to obtain a byte pattern.">; 499 def memory_find_string : Option<"string", "s">, Group<2>, Arg<"Name">, 500 Required, Desc<"Use text to find a byte pattern.">; 501 def memory_find_count : Option<"count", "c">, Arg<"Count">, 502 Desc<"How many times to perform the search.">; 503 def memory_find_dump_offset : Option<"dump-offset", "o">, Arg<"Offset">, 504 Desc<"When dumping memory for a match, an offset from the match location to" 505 " start dumping from.">; 506} 507 508let Command = "memory write" in { 509 def memory_write_infile : Option<"infile", "i">, Group<1>, Arg<"Filename">, 510 Required, Desc<"Write memory using the contents of a file.">; 511 def memory_write_offset : Option<"offset", "o">, Group<1>, Arg<"Offset">, 512 Desc<"Start writing bytes from an offset within the input file.">; 513} 514 515let Command = "memory tag write" in { 516 def memory_write_end_addr : Option<"end-addr", "e">, Group<1>, 517 Arg<"AddressOrExpression">, Desc< 518 "Set tags for start address to end-addr, repeating tags as needed" 519 " to cover the range. (instead of calculating the range from the" 520 " number of tags given)">; 521} 522 523let Command = "register read" in { 524 def register_read_alternate : Option<"alternate", "A">, 525 Desc<"Display register names using the alternate register name if there " 526 "is one.">; 527 def register_read_set : Option<"set", "s">, Group<1>, Arg<"Index">, 528 Desc<"Specify which register sets to dump by index.">; 529 def register_read_all : Option<"all", "a">, Group<2>, 530 Desc<"Show all register sets.">; 531} 532 533let Command = "source" in { 534 def source_stop_on_error : Option<"stop-on-error", "e">, Arg<"Boolean">, 535 Desc<"If true, stop executing commands on error.">; 536 def source_stop_on_continue : Option<"stop-on-continue", "c">, Arg<"Boolean">, 537 Desc<"If true, stop executing commands on continue.">; 538 def source_silent_run : Option<"silent-run", "s">, Arg<"Boolean">, 539 Desc<"If true don't echo commands while executing.">; 540 def cmd_relative_to_command_file : Option<"relative-to-command-file", "C">, 541 Desc<"Resolve non-absolute paths relative to the location of the " 542 "current command file. This argument can only be used when the command is " 543 "being sourced from a file.">; 544} 545 546let Command = "alias" in { 547 def alias_help : Option<"help", "h">, Arg<"HelpText">, 548 Desc<"Help text for this command">; 549 def alias_long_help : Option<"long-help", "H">, Arg<"HelpText">, 550 Desc<"Long help text for this command">; 551} 552 553let Command = "regex" in { 554 def regex_help : Option<"help", "h">, Group<1>, Arg<"None">, 555 Desc<"The help text to display for this command.">; 556 def regex_syntax : Option<"syntax", "s">, Group<1>, Arg<"None">, 557 Desc<"A syntax string showing the typical usage syntax.">; 558} 559 560let Command = "permissions" in { 561 def permissions_permissions_value : Option<"permissions-value", "v">, 562 Arg<"PermissionsNumber">, 563 Desc<"Give out the numeric value for permissions (e.g. 757)">; 564 def permissions_permissions_string : Option<"permissions-string", "s">, 565 Arg<"PermissionsString">, 566 Desc<"Give out the string value for permissions (e.g. rwxr-xr--).">; 567 def permissions_user_read : Option<"user-read", "r">, 568 Desc<"Allow user to read.">; 569 def permissions_user_write : Option<"user-write", "w">, 570 Desc<"Allow user to write.">; 571 def permissions_user_exec : Option<"user-exec", "x">, 572 Desc<"Allow user to execute.">; 573 def permissions_group_read : Option<"group-read", "R">, 574 Desc<"Allow group to read.">; 575 def permissions_group_write : Option<"group-write", "W">, 576 Desc<"Allow group to write.">; 577 def permissions_group_exec : Option<"group-exec", "X">, 578 Desc<"Allow group to execute.">; 579 def permissions_world_read : Option<"world-read", "d">, 580 Desc<"Allow world to read.">; 581 def permissions_world_write : Option<"world-write", "t">, 582 Desc<"Allow world to write.">; 583 def permissions_world_exec : Option<"world-exec", "e">, 584 Desc<"Allow world to execute.">; 585} 586 587let Command = "platform fread" in { 588 def platform_fread_offset : Option<"offset", "o">, Group<1>, Arg<"Index">, 589 Desc<"Offset into the file at which to start reading.">; 590 def platform_fread_count : Option<"count", "c">, Group<1>, Arg<"Count">, 591 Desc<"Number of bytes to read from the file.">; 592} 593 594let Command = "platform fwrite" in { 595 def platform_fwrite_offset : Option<"offset", "o">, Group<1>, Arg<"Index">, 596 Desc<"Offset into the file at which to start reading.">; 597 def platform_fwrite_data : Option<"data", "d">, Group<1>, Arg<"Value">, 598 Desc<"Text to write to the file.">; 599} 600 601let Command = "platform process list" in { 602 def platform_process_list_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">, 603 Desc<"List the process info for a specific process ID.">; 604 def platform_process_list_name : Option<"name", "n">, Group<2>, 605 Arg<"ProcessName">, Required, 606 Desc<"Find processes with executable basenames that match a string.">; 607 def platform_process_list_ends_with : Option<"ends-with", "e">, Group<3>, 608 Arg<"ProcessName">, Required, 609 Desc<"Find processes with executable basenames that end with a string.">; 610 def platform_process_list_starts_with : Option<"starts-with", "s">, Group<4>, 611 Arg<"ProcessName">, Required, 612 Desc<"Find processes with executable basenames that start with a string.">; 613 def platform_process_list_contains : Option<"contains", "c">, Group<5>, 614 Arg<"ProcessName">, Required, 615 Desc<"Find processes with executable basenames that contain a string.">; 616 def platform_process_list_regex : Option<"regex", "r">, Group<6>, 617 Arg<"RegularExpression">, Required, 618 Desc<"Find processes with executable basenames that match a regular " 619 "expression.">; 620 def platform_process_list_parent : Option<"parent", "P">, GroupRange<2, 6>, 621 Arg<"Pid">, Desc<"Find processes that have a matching parent process ID.">; 622 def platform_process_list_uid : Option<"uid", "u">, GroupRange<2, 6>, 623 Arg<"UnsignedInteger">, Validator<"&posix_validator">, 624 Desc<"Find processes that have a matching user ID.">; 625 def platform_process_list_euid : Option<"euid", "U">, GroupRange<2, 6>, 626 Arg<"UnsignedInteger">, Validator<"&posix_validator">, 627 Desc<"Find processes that have a matching effective user ID.">; 628 def platform_process_list_gid : Option<"gid", "g">, GroupRange<2, 6>, 629 Arg<"UnsignedInteger">, Validator<"&posix_validator">, 630 Desc<"Find processes that have a matching group ID.">; 631 def platform_process_list_egid : Option<"egid", "G">, GroupRange<2, 6>, 632 Arg<"UnsignedInteger">, Validator<"&posix_validator">, 633 Desc<"Find processes that have a matching effective group ID.">; 634 def platform_process_list_arch : Option<"arch", "a">, GroupRange<2, 6>, 635 Arg<"Architecture">, 636 Desc<"Find processes that have a matching architecture.">; 637 def platform_process_list_show_args : Option<"show-args", "A">, 638 GroupRange<1, 6>, 639 Desc<"Show process arguments instead of the process executable basename.">; 640 def platform_process_list_all_users: Option<"all-users", "x">, 641 GroupRange<1,6>, 642 Desc<"Show processes matching all user IDs.">; 643 def platform_process_list_verbose : Option<"verbose", "v">, GroupRange<1, 6>, 644 Desc<"Enable verbose output.">; 645} 646 647let Command = "platform process attach" in { 648 def platform_process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">, 649 Desc<"Name of the process plugin you want to use.">; 650 def platform_process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">, 651 Desc<"The process ID of an existing process to attach to.">; 652 def platform_process_attach_name : Option<"name", "n">, Group<2>, 653 Arg<"ProcessName">, Desc<"The name of the process to attach to.">; 654 def platform_process_attach_waitfor : Option<"waitfor", "w">, Group<2>, 655 Desc<"Wait for the process with <process-name> to launch.">; 656} 657 658let Command = "platform shell" in { 659 def platform_shell_host : Option<"host", "h">, 660 Desc<"Run the commands on the host shell when enabled.">; 661 def platform_shell_timeout : Option<"timeout", "t">, Arg<"Value">, 662 Desc<"Seconds to wait for the remote host to finish running the command.">; 663 def platform_shell_interpreter : Option<"shell", "s">, Arg<"Path">, 664 Desc<"Shell interpreter path. This is the binary used to run the command.">; 665} 666 667let Command = "process launch" in { 668 def process_launch_stop_at_entry : Option<"stop-at-entry", "s">, 669 Desc<"Stop at the entry point of the program when launching a process.">; 670 def process_launch_disable_aslr : Option<"disable-aslr", "A">, Arg<"Boolean">, 671 Desc<"Set whether to disable address space layout randomization when launching a process.">; 672 def process_launch_plugin : Option<"plugin", "P">, Arg<"Plugin">, 673 Desc<"Name of the process plugin you want to use.">; 674 def process_launch_working_dir : Option<"working-dir", "w">, Arg<"DirectoryName">, 675 Desc<"Set the current working directory to <path> when running the inferior.">; 676 def process_launch_arch : Option<"arch", "a">, Arg<"Architecture">, 677 Desc<"Set the architecture for the process to launch when ambiguous.">; 678 def process_launch_environment : Option<"environment", "E">, 679 Arg<"None">, Desc<"Specify an environment variable name/value string " 680 "(--environment NAME=VALUE). Can be specified multiple times for subsequent " 681 "environment entries.">; 682 def process_launch_shell : Option<"shell", "c">, GroupRange<1,3>, 683 OptionalArg<"Filename">, Desc<"Run the process in a shell (not supported on all platforms).">; 684 def process_launch_stdin : Option<"stdin", "i">, Group<1>, 685 Arg<"Filename">, Desc<"Redirect stdin for the process to <filename>.">; 686 def process_launch_stdout : Option<"stdout", "o">, Group<1>, 687 Arg<"Filename">, Desc<"Redirect stdout for the process to <filename>.">; 688 def process_launch_stderr : Option<"stderr", "e">, Group<1>, 689 Arg<"Filename">, Desc<"Redirect stderr for the process to <filename>.">; 690 def process_launch_tty : Option<"tty", "t">, Group<2>, 691 Desc<"Start the process in a terminal (not supported on all platforms).">; 692 def process_launch_no_stdio : Option<"no-stdio", "n">, Group<3>, 693 Desc<"Do not set up for terminal I/O to go to running process.">; 694 def process_launch_shell_expand_args : Option<"shell-expand-args", "X">, Group<4>, 695 Arg<"Boolean">, Desc<"Set whether to shell expand arguments to the process when launching.">; 696} 697 698let Command = "process attach" in { 699 def process_attach_continue : Option<"continue", "c">, 700 Desc<"Immediately continue the process once attached.">; 701 def process_attach_plugin : Option<"plugin", "P">, Arg<"Plugin">, 702 Desc<"Name of the process plugin you want to use.">; 703 def process_attach_pid : Option<"pid", "p">, Group<1>, Arg<"Pid">, 704 Desc<"The process ID of an existing process to attach to.">; 705 def process_attach_name : Option<"name", "n">, Group<2>, Arg<"ProcessName">, 706 Desc<"The name of the process to attach to.">; 707 def process_attach_include_existing : Option<"include-existing", "i">, 708 Group<2>, Desc<"Include existing processes when doing attach -w.">; 709 def process_attach_waitfor : Option<"waitfor", "w">, Group<2>, 710 Desc<"Wait for the process with <process-name> to launch.">; 711} 712 713let Command = "process continue" in { 714 def process_continue_ignore_count : Option<"ignore-count", "i">, 715 Arg<"UnsignedInteger">, Desc<"Ignore <N> crossings of the breakpoint (if it" 716 " exists) for the currently selected thread.">; 717} 718 719let Command = "process detach" in { 720 def process_detach_keep_stopped : Option<"keep-stopped", "s">, Group<1>, 721 Arg<"Boolean">, Desc<"Whether or not the process should be kept stopped on" 722 " detach (if possible).">; 723} 724 725let Command = "process connect" in { 726 def process_connect_plugin : Option<"plugin", "p">, Arg<"Plugin">, 727 Desc<"Name of the process plugin you want to use.">; 728} 729 730let Command = "process load" in { 731 def process_load_install : Option<"install", "i">, OptionalArg<"Path">, 732 Desc<"Install the shared library to the target. If specified without an " 733 "argument then the library will installed in the current working " 734 "directory.">; 735} 736 737let Command = "process handle" in { 738 def process_handle_stop : Option<"stop", "s">, Group<1>, Arg<"Boolean">, 739 Desc<"Whether or not the process should be stopped if the signal is " 740 "received.">; 741 def process_handle_notify : Option<"notify", "n">, Group<1>, Arg<"Boolean">, 742 Desc<"Whether or not the debugger should notify the user if the signal is " 743 "received.">; 744 def process_handle_pass : Option<"pass", "p">, Group<1>, Arg<"Boolean">, 745 Desc<"Whether or not the signal should be passed to the process.">; 746} 747 748let Command = "process status" in { 749 def process_status_verbose : Option<"verbose", "v">, Group<1>, 750 Desc<"Show verbose process status including extended crash information.">; 751} 752 753let Command = "process save_core" in { 754 def process_save_core_style : Option<"style", "s">, Group<1>, 755 EnumArg<"SaveCoreStyle", "SaveCoreStyles()">, Desc<"Request a specific style " 756 "of corefile to be saved.">; 757 def process_save_core_plugin_name : Option<"plugin-name", "p">, 758 OptionalArg<"Plugin">, Desc<"Specify a plugin name to create the core file." 759 "This allows core files to be saved in different formats.">; 760} 761 762let Command = "process trace save" in { 763 def process_trace_save_directory: Option<"directory", "d">, 764 Group<1>, 765 Arg<"Value">, Required, 766 Desc<"The directory where the trace will be saved." 767 "It will be created if it does not exist.">; 768} 769 770let Command = "script import" in { 771 def script_import_allow_reload : Option<"allow-reload", "r">, Group<1>, 772 Desc<"Allow the script to be loaded even if it was already loaded before. " 773 "This argument exists for backwards compatibility, but reloading is always " 774 "allowed, whether you specify it or not.">; 775 def relative_to_command_file : Option<"relative-to-command-file", "c">, 776 Group<1>, Desc<"Resolve non-absolute paths relative to the location of the " 777 "current command file. This argument can only be used when the command is " 778 "being sourced from a file.">; 779 def silent : Option<"silent", "s">, Group<1>, 780 Desc<"If true don't print any script output while importing.">; 781} 782 783let Command = "script add" in { 784 def script_add_function : Option<"function", "f">, Group<1>, 785 Arg<"PythonFunction">, 786 Desc<"Name of the Python function to bind to this command name.">; 787 def script_add_class : Option<"class", "c">, Group<2>, Arg<"PythonClass">, 788 Desc<"Name of the Python class to bind to this command name.">; 789 def script_add_help : Option<"help", "h">, Group<1>, Arg<"HelpText">, 790 Desc<"The help text to display for this command.">; 791 def script_add_overwrite : Option<"overwrite", "o">, Groups<[1,2]>, 792 Desc<"Overwrite an existing command at this node.">; 793 def script_add_synchronicity : Option<"synchronicity", "s">, 794 EnumArg<"ScriptedCommandSynchronicity", "ScriptSynchroType()">, 795 Desc<"Set the synchronicity of this command's executions with regard to " 796 "LLDB event system.">; 797} 798 799let Command = "container add" in { 800 def container_add_help : Option<"help", "h">, Arg<"HelpText">, 801 Desc<"Help text for this command">; 802 def container_add_long_help : Option<"long-help", "H">, Arg<"HelpText">, 803 Desc<"Long help text for this command">; 804 def container_add_overwrite : Option<"overwrite", "o">, Group<1>, 805 Desc<"Overwrite an existing command at this node.">; 806} 807 808let Command = "script" in { 809 def script_language : Option<"language", "l">, 810 EnumArg<"ScriptLang", "ScriptOptionEnum()">, Desc<"Specify the scripting " 811 " language. If none is specific the default scripting language is used.">; 812} 813 814let Command = "source info" in { 815 def source_info_count : Option<"count", "c">, Arg<"Count">, 816 Desc<"The number of line entries to display.">; 817 def source_info_shlib : Option<"shlib", "s">, Groups<[1,2]>, Arg<"ShlibName">, 818 Completion<"Module">, Desc<"Look up the source in the given module or " 819 "shared library (can be specified more than once).">; 820 def source_info_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 821 Completion<"SourceFile">, Desc<"The file from which to display source.">; 822 def source_info_line : Option<"line", "l">, Group<1>, Arg<"LineNum">, 823 Desc<"The line number at which to start the displaying lines.">; 824 def source_info_end_line : Option<"end-line", "e">, Group<1>, Arg<"LineNum">, 825 Desc<"The line number at which to stop displaying lines.">; 826 def source_info_name : Option<"name", "n">, Group<2>, Arg<"Symbol">, 827 Completion<"Symbol">, 828 Desc<"The name of a function whose source to display.">; 829 def source_info_address : Option<"address", "a">, Group<3>, 830 Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source" 831 " information for the corresponding file and line.">; 832} 833 834let Command = "source list" in { 835 def source_list_count : Option<"count", "c">, Arg<"Count">, 836 Desc<"The number of source lines to display.">; 837 def source_list_shlib : Option<"shlib", "s">, Groups<[1,2,5]>, Arg<"ShlibName">, 838 Completion<"Module">, 839 Desc<"Look up the source file in the given shared library.">; 840 def source_list_show_breakpoints : Option<"show-breakpoints", "b">, 841 Desc<"Show the line table locations from the debug information that " 842 "indicate valid places to set source level breakpoints.">; 843 def source_list_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 844 Completion<"SourceFile">, Desc<"The file from which to display source.">; 845 def source_list_line : Option<"line", "l">, Group<1>, Arg<"LineNum">, 846 Desc<"The line number at which to start the display source.">; 847 def source_list_name : Option<"name", "n">, Group<2>, Arg<"Symbol">, 848 Completion<"Symbol">, 849 Desc<"The name of a function whose source to display.">; 850 def source_list_address : Option<"address", "a">, Group<3>, 851 Arg<"AddressOrExpression">, Desc<"Lookup the address and display the source" 852 " information for the corresponding file and line.">; 853 def source_list_reverse : Option<"reverse", "r">, Group<4>, Desc<"Reverse the" 854 " listing to look backwards from the last displayed block of source.">; 855 def source_list_file_colon_line : Option<"joint-specifier", "y">, Group<5>, 856 Arg<"FileLineColumn">, Completion<"SourceFile">, 857 Desc<"A specifier in the form filename:line[:column] from which to display" 858 " source.">; 859} 860 861let Command = "target dependents" in { 862 def dependents_no_dependents : Option<"no-dependents", "d">, Group<1>, 863 OptionalEnumArg<"Value", "OptionEnumValues(g_dependents_enumaration)">, 864 Desc<"Whether or not to load dependents when creating a target. If the " 865 "option is not specified, the value is implicitly 'default'. If the " 866 "option is specified but without a value, the value is implicitly " 867 "'true'.">; 868} 869 870let Command = "target modules dump" in { 871 def target_modules_dump_verbose : Option<"verbose", "v">, 872 Desc<"Enable verbose dump.">; 873} 874 875let Command = "target modules list" in { 876 def target_modules_list_address : Option<"address", "a">, Group<1>, 877 Arg<"AddressOrExpression">, Desc<"Display the image at this address.">; 878 def target_modules_list_arch : Option<"arch", "A">, Group<1>, 879 OptionalArg<"Width">, Desc<"Display the architecture when listing images.">; 880 def target_modules_list_triple : Option<"triple", "t">, Group<1>, 881 OptionalArg<"Width">, Desc<"Display the triple when listing images.">; 882 def target_modules_list_header : Option<"header", "h">, Group<1>, 883 Desc<"Display the image base address as a load address if debugging, a file" 884 " address otherwise.">; 885 def target_modules_list_offset : Option<"offset", "o">, Group<1>, 886 Desc<"Display the image load address offset from the base file address " 887 "(the slide amount).">; 888 def target_modules_list_uuid : Option<"uuid", "u">, Group<1>, 889 Desc<"Display the UUID when listing images.">; 890 def target_modules_list_fullpath : Option<"fullpath", "f">, Group<1>, 891 OptionalArg<"Width">, 892 Desc<"Display the fullpath to the image object file.">; 893 def target_modules_list_directory : Option<"directory", "d">, Group<1>, 894 OptionalArg<"Width">, Desc<"Display the directory with optional width for " 895 "the image object file.">; 896 def target_modules_list_basename : Option<"basename", "b">, Group<1>, 897 OptionalArg<"Width">, Desc<"Display the basename with optional width for " 898 "the image object file.">; 899 def target_modules_list_symfile : Option<"symfile", "s">, Group<1>, 900 OptionalArg<"Width">, Desc<"Display the fullpath to the image symbol file " 901 "with optional width.">; 902 def target_modules_list_symfile_unique : Option<"symfile-unique", "S">, 903 Group<1>, OptionalArg<"Width">, Desc<"Display the symbol file with optional" 904 " width only if it is different from the executable object file.">; 905 def target_modules_list_mod_time : Option<"mod-time", "m">, Group<1>, 906 OptionalArg<"Width">, Desc<"Display the modification time with optional " 907 "width of the module.">; 908 def target_modules_list_ref_count : Option<"ref-count", "r">, Group<1>, 909 OptionalArg<"Width">, Desc<"Display the reference count if the module is " 910 "still in the shared module cache.">; 911 def target_modules_list_pointer : Option<"pointer", "p">, Group<1>, 912 OptionalArg<"None">, Desc<"Display the module pointer.">; 913 def target_modules_list_global : Option<"global", "g">, Group<1>, 914 Desc<"Display the modules from the global module list, not just the " 915 "current target.">; 916} 917 918let Command = "target modules show unwind" in { 919 def target_modules_show_unwind_name : Option<"name", "n">, Group<1>, 920 Arg<"FunctionName">, 921 Desc<"Show unwind instructions for a function or symbol name.">; 922 def target_modules_show_unwind_address : Option<"address", "a">, Group<2>, 923 Arg<"AddressOrExpression">, Desc<"Show unwind instructions for a function " 924 "or symbol containing an address">; 925} 926 927let Command = "target modules lookup" in { 928 def target_modules_lookup_address : Option<"address", "a">, Group<1>, 929 Arg<"AddressOrExpression">, Required, Desc<"Lookup an address in one or " 930 "more target modules.">; 931 def target_modules_lookup_offset : Option<"offset", "o">, Group<1>, 932 Arg<"Offset">, Desc<"When looking up an address subtract <offset> from any " 933 "addresses before doing the lookup.">; 934 // FIXME: re-enable regex for types when the LookupTypeInModule actually uses 935 // the regex option by adding to group 6. 936 def target_modules_lookup_regex : Option<"regex", "r">, Groups<[2,4,5]>, 937 Desc<"The <name> argument for name lookups are regular expressions.">; 938 def target_modules_lookup_symbol : Option<"symbol", "s">, Group<2>, 939 Arg<"Symbol">, Required, Desc<"Lookup a symbol by name in the symbol tables" 940 " in one or more target modules.">; 941 def target_modules_lookup_file : Option<"file", "f">, Group<3>, 942 Arg<"Filename">, Required, Desc<"Lookup a file by fullpath or basename in " 943 "one or more target modules.">; 944 def target_modules_lookup_line : Option<"line", "l">, Group<3>, 945 Arg<"LineNum">, Desc<"Lookup a line number in a file (must be used in " 946 "conjunction with --file).">; 947 def target_modules_lookup_no_inlines : Option<"no-inlines", "i">, 948 GroupRange<3,5>, 949 Desc<"Ignore inline entries (must be used in conjunction with --file or " 950 "--function).">; 951 def target_modules_lookup_function : Option<"function", "F">, Group<4>, 952 Arg<"FunctionName">, Required, Desc<"Lookup a function by name in the debug" 953 " symbols in one or more target modules.">; 954 def target_modules_lookup_name : Option<"name", "n">, Group<5>, 955 Arg<"FunctionOrSymbol">, Required, Desc<"Lookup a function or symbol by " 956 "name in one or more target modules.">; 957 def target_modules_lookup_type : Option<"type", "t">, Group<6>, Arg<"Name">, 958 Required, Desc<"Lookup a type by name in the debug symbols in one or more " 959 "target modules.">; 960 def target_modules_lookup_verbose : Option<"verbose", "v">, 961 Desc<"Enable verbose lookup information.">; 962 def target_modules_lookup_all : Option<"all", "A">, Desc<"Print all matches, " 963 "not just the best match, if a best match is available.">; 964} 965 966let Command = "target stop hook add" in { 967 def target_stop_hook_add_one_liner : Option<"one-liner", "o">, GroupRange<1,3>, 968 Arg<"OneLiner">, Desc<"Add a command for the stop hook. Can be specified " 969 "more than once, and commands will be run in the order they appear.">; 970 def target_stop_hook_add_shlib : Option<"shlib", "s">, Arg<"ShlibName">, 971 Completion<"Module">, 972 Desc<"Set the module within which the stop-hook is to be run.">; 973 def target_stop_hook_add_thread_index : Option<"thread-index", "x">, 974 Arg<"ThreadIndex">, Desc<"The stop hook is run only for the thread whose " 975 "index matches this argument.">; 976 def target_stop_hook_add_thread_id : Option<"thread-id", "t">, 977 Arg<"ThreadID">, Desc<"The stop hook is run only for the thread whose TID " 978 "matches this argument.">; 979 def target_stop_hook_add_thread_name : Option<"thread-name", "T">, 980 Arg<"ThreadName">, Desc<"The stop hook is run only for the thread whose " 981 "thread name matches this argument.">; 982 def target_stop_hook_add_queue_name : Option<"queue-name", "q">, 983 Arg<"QueueName">, Desc<"The stop hook is run only for threads in the queue " 984 "whose name is given by this argument.">; 985 def target_stop_hook_add_file : Option<"file", "f">, Groups<[1,4]>, 986 Arg<"Filename">, Desc<"Specify the source file within which the stop-hook " 987 "is to be run.">, Completion<"SourceFile">; 988 def target_stop_hook_add_start_line : Option<"start-line", "l">, Groups<[1,4]>, 989 Arg<"LineNum">, Desc<"Set the start of the line range for which the " 990 "stop-hook is to be run.">; 991 def target_stop_hook_add_end_line : Option<"end-line", "e">, Groups<[1,4]>, 992 Arg<"LineNum">, Desc<"Set the end of the line range for which the stop-hook" 993 " is to be run.">; 994 def target_stop_hook_add_classname : Option<"classname", "c">, Groups<[2,5]>, 995 Arg<"ClassName">, 996 Desc<"Specify the class within which the stop-hook is to be run.">; 997 def target_stop_hook_add_name : Option<"name", "n">, Groups<[3,6]>, 998 Arg<"FunctionName">, Desc<"Set the function name within which the stop hook" 999 " will be run.">, Completion<"Symbol">; 1000 def target_stop_hook_add_auto_continue : Option<"auto-continue", "G">, 1001 Arg<"Boolean">, Desc<"The breakpoint will auto-continue after running its" 1002 " commands.">; 1003} 1004 1005let Command = "thread backtrace" in { 1006 def thread_backtrace_count : Option<"count", "c">, Group<1>, Arg<"Count">, 1007 Desc<"How many frames to display (-1 for all)">; 1008 def thread_backtrace_start : Option<"start", "s">, Group<1>, 1009 Arg<"FrameIndex">, Desc<"Frame in which to start the backtrace">; 1010 def thread_backtrace_extended : Option<"extended", "e">, Group<1>, 1011 Arg<"Boolean">, Desc<"Show the extended backtrace, if available">; 1012} 1013 1014let Command = "thread step scope" in { 1015 def thread_step_scope_step_in_avoids_no_debug : 1016 Option<"step-in-avoids-no-debug", "a">, Group<1>, Arg<"Boolean">, 1017 Desc<"A boolean value that sets whether stepping into functions will step " 1018 "over functions with no debug information.">; 1019 def thread_step_scope_step_out_avoids_no_debug : 1020 Option<"step-out-avoids-no-debug", "A">, Group<1>, Arg<"Boolean">, 1021 Desc<"A boolean value, if true stepping out of functions will continue to" 1022 " step out till it hits a function with debug information.">; 1023 def thread_step_scope_count : Option<"count", "c">, Group<1>, Arg<"Count">, 1024 Desc<"How many times to perform the stepping operation - currently only " 1025 "supported for step-inst and next-inst.">; 1026 def thread_step_scope_end_linenumber : Option<"end-linenumber", "e">, 1027 Group<1>, Arg<"LineNum">, Desc<"The line at which to stop stepping - " 1028 "defaults to the next line and only supported for step-in and step-over." 1029 " You can also pass the string 'block' to step to the end of the current" 1030 " block. This is particularly use in conjunction with --step-target to" 1031 " step through a complex calling sequence.">; 1032 def thread_step_scope_run_mode : Option<"run-mode", "m">, Group<1>, 1033 EnumArg<"RunMode", "TriRunningModes()">, Desc<"Determine how to run other " 1034 "threads while stepping the current thread.">; 1035 def thread_step_scope_step_over_regexp : Option<"step-over-regexp", "r">, 1036 Group<1>, Arg<"RegularExpression">, Desc<"A regular expression that defines " 1037 "function names to not to stop at when stepping in.">; 1038 def thread_step_scope_step_in_target : Option<"step-in-target", "t">, 1039 Group<1>, Arg<"FunctionName">, Desc<"The name of the directly called " 1040 "function step in should stop at when stepping into.">; 1041} 1042 1043let Command = "thread until" in { 1044 def thread_until_frame : Option<"frame", "f">, Group<1>, Arg<"FrameIndex">, 1045 Desc<"Frame index for until operation - defaults to 0">; 1046 def thread_until_thread : Option<"thread", "t">, Group<1>, Arg<"ThreadIndex">, 1047 Desc<"Thread index for the thread for until operation">; 1048 def thread_until_run_mode : Option<"run-mode", "m">, Group<1>, 1049 EnumArg<"RunMode", "DuoRunningModes()">, Desc<"Determine how to run other " 1050 "threads while stepping this one">; 1051 def thread_until_address : Option<"address", "a">, Group<1>, 1052 Arg<"AddressOrExpression">, Desc<"Run until we reach the specified address, " 1053 "or leave the function - can be specified multiple times.">; 1054} 1055 1056let Command = "thread info" in { 1057 def thread_info_json : Option<"json", "j">, Desc<"Display the thread info in" 1058 " JSON format.">; 1059 def thread_info_stop_info : Option<"stop-info", "s">, Desc<"Display the " 1060 "extended stop info in JSON format.">; 1061} 1062 1063let Command = "thread return" in { 1064 def thread_return_from_expression : Option<"from-expression", "x">, 1065 Desc<"Return from the innermost expression evaluation.">; 1066} 1067 1068let Command = "thread jump" in { 1069 def thread_jump_file : Option<"file", "f">, Group<1>, Arg<"Filename">, 1070 Completion<"SourceFile">, Desc<"Specifies the source file to jump to.">; 1071 def thread_jump_line : Option<"line", "l">, Group<1>, Arg<"LineNum">, 1072 Required, Desc<"Specifies the line number to jump to.">; 1073 def thread_jump_by : Option<"by", "b">, Group<2>, Arg<"Offset">, Required, 1074 Desc<"Jumps by a relative line offset from the current line.">; 1075 def thread_jump_address : Option<"address", "a">, Group<3>, 1076 Arg<"AddressOrExpression">, Required, Desc<"Jumps to a specific address.">; 1077 def thread_jump_force : Option<"force", "r">, Groups<[1,2,3]>, 1078 Desc<"Allows the PC to leave the current function.">; 1079} 1080 1081let Command = "thread plan list" in { 1082 def thread_plan_list_verbose : Option<"verbose", "v">, Group<1>, 1083 Desc<"Display more information about the thread plans">; 1084 def thread_plan_list_internal : Option<"internal", "i">, Group<1>, 1085 Desc<"Display internal as well as user thread plans">; 1086 def thread_plan_list_thread_id : Option<"thread-id", "t">, Group<1>, 1087 Arg<"ThreadID">, Desc<"List the thread plans for this TID, can be " 1088 "specified more than once.">; 1089 def thread_plan_list_unreported : Option<"unreported", "u">, Group<1>, 1090 Desc<"Display thread plans for unreported threads">; 1091} 1092 1093let Command = "thread trace dump instructions" in { 1094 def thread_trace_dump_instructions_forwards: Option<"forwards", "f">, Group<1>, 1095 Desc<"If specified, the trace is traversed forwards chronologically " 1096 "starting at the oldest instruction. Otherwise, it starts at the most " 1097 "recent one and the traversal is backwards.">; 1098 def thread_trace_dump_instructions_count : Option<"count", "c">, Group<1>, 1099 Arg<"Count">, 1100 Desc<"The number of instructions to display starting at the most recent " 1101 "instruction, or the oldest if --forwards is provided.">; 1102 def thread_trace_dump_instructions_skip: Option<"skip", "s">, 1103 Group<1>, 1104 Arg<"Index">, 1105 Desc<"How many instruction to skip from the end of the trace to start " 1106 "dumping instructions, or from the beginning if --forwards is provided">; 1107 def thread_trace_dump_instructions_raw : Option<"raw", "r">, 1108 Group<1>, 1109 Desc<"Dump only instruction address without disassembly nor symbol information.">; 1110 def thread_trace_dump_instructions_show_tsc : Option<"tsc", "t">, 1111 Group<1>, 1112 Desc<"For each instruction, print the corresponding timestamp counter if available.">; 1113} 1114 1115let Command = "thread trace dump info" in { 1116 def thread_trace_dump_info_verbose : Option<"verbose", "v">, Group<1>, 1117 Desc<"show verbose thread trace dump info">; 1118} 1119 1120let Command = "type summary add" in { 1121 def type_summary_add_category : Option<"category", "w">, Arg<"Name">, 1122 Desc<"Add this to the given category instead of the default one.">; 1123 def type_summary_add_cascade : Option<"cascade", "C">, Arg<"Boolean">, 1124 Desc<"If true, cascade through typedef chains.">; 1125 def type_summary_add_no_value : Option<"no-value", "v">, 1126 Desc<"Don't show the value, just show the summary, for this type.">; 1127 def type_summary_add_skip_pointers : Option<"skip-pointers", "p">, 1128 Desc<"Don't use this format for pointers-to-type objects.">; 1129 def type_summary_add_skip_references : Option<"skip-references", "r">, 1130 Desc<"Don't use this format for references-to-type objects.">; 1131 def type_summary_add_regex : Option<"regex", "x">, 1132 Desc<"Type names are actually regular expressions.">; 1133 def type_summary_add_inline_children : Option<"inline-children", "c">, 1134 Group<1>, Required, 1135 Desc<"If true, inline all child values into summary string.">; 1136 def type_summary_add_omit_names : Option<"omit-names", "O">, Group<1>, 1137 Desc<"If true, omit value names in the summary display.">; 1138 def type_summary_add_summary_string : Option<"summary-string", "s">, Group<2>, 1139 Arg<"SummaryString">, Required, 1140 Desc<"Summary string used to display text and object contents.">; 1141 def type_summary_add_python_script : Option<"python-script", "o">, Group<3>, 1142 Arg<"PythonScript">, 1143 Desc<"Give a one-liner Python script as part of the command.">; 1144 def type_summary_add_python_function : Option<"python-function", "F">, 1145 Group<3>, Arg<"PythonFunction">, 1146 Desc<"Give the name of a Python function to use for this type.">; 1147 def type_summary_add_input_python : Option<"input-python", "P">, Group<3>, 1148 Desc<"Input Python code to use for this type manually.">; 1149 def type_summary_add_expand : Option<"expand", "e">, Groups<[2,3]>, 1150 Desc<"Expand aggregate data types to show children on separate lines.">; 1151 def type_summary_add_hide_empty : Option<"hide-empty", "h">, Groups<[2,3]>, 1152 Desc<"Do not expand aggregate data types with no children.">; 1153 def type_summary_add_name : Option<"name", "n">, Groups<[2,3]>, Arg<"Name">, 1154 Desc<"A name for this summary string.">; 1155} 1156 1157let Command = "type synth add" in { 1158 def type_synth_add_cascade : Option<"cascade", "C">, Arg<"Boolean">, 1159 Desc<"If true, cascade through typedef chains.">; 1160 def type_synth_add_skip_pointers : Option<"skip-pointers", "p">, 1161 Desc<"Don't use this format for pointers-to-type objects.">; 1162 def type_synth_add_skip_references : Option<"skip-references", "r">, 1163 Desc<"Don't use this format for references-to-type objects.">; 1164 def type_synth_add_category : Option<"category", "w">, Arg<"Name">, 1165 Desc<"Add this to the given category instead of the default one.">; 1166 def type_synth_add_python_class : Option<"python-class", "l">, Group<2>, 1167 Arg<"PythonClass">, 1168 Desc<"Use this Python class to produce synthetic children.">; 1169 def type_synth_add_input_python : Option<"input-python", "P">, Group<3>, 1170 Desc<"Type Python code to generate a class that provides synthetic " 1171 "children.">; 1172 def type_synth_add_regex : Option<"regex", "x">, 1173 Desc<"Type names are actually regular expressions.">; 1174} 1175 1176let Command = "type format add" in { 1177 def type_format_add_category : Option<"category", "w">, Arg<"Name">, 1178 Desc<"Add this to the given category instead of the default one.">; 1179 def type_format_add_cascade : Option<"cascade", "C">, Arg<"Boolean">, 1180 Desc<"If true, cascade through typedef chains.">; 1181 def type_format_add_skip_pointers : Option<"skip-pointers", "p">, 1182 Desc<"Don't use this format for pointers-to-type objects.">; 1183 def type_format_add_skip_references : Option<"skip-references", "r">, 1184 Desc<"Don't use this format for references-to-type objects.">; 1185 def type_format_add_regex : Option<"regex", "x">, 1186 Desc<"Type names are actually regular expressions.">; 1187 def type_format_add_type : Option<"type", "t">, Group<2>, Arg<"Name">, 1188 Desc<"Format variables as if they were of this type.">; 1189} 1190 1191let Command = "type formatter delete" in { 1192 def type_formatter_delete_all : Option<"all", "a">, Group<1>, 1193 Desc<"Delete from every category.">; 1194 def type_formatter_delete_category : Option<"category", "w">, Group<2>, 1195 Arg<"Name">, Desc<"Delete from given category.">; 1196 def type_formatter_delete_language : Option<"language", "l">, Group<3>, 1197 Arg<"Language">, Desc<"Delete from given language's category.">; 1198} 1199 1200let Command = "type formatter clear" in { 1201 def type_formatter_clear_all : Option<"all", "a">, 1202 Desc<"Clear every category.">; 1203} 1204 1205let Command = "type formatter list" in { 1206 def type_formatter_list_category_regex : Option<"category-regex", "w">, 1207 Group<1>, Arg<"Name">, Desc<"Only show categories matching this filter.">; 1208 def type_formatter_list_language : Option<"language", "l">, Group<2>, 1209 Arg<"Language">, Desc<"Only show the category for a specific language.">; 1210} 1211 1212let Command = "type category define" in { 1213 def type_category_define_enabled : Option<"enabled", "e">, 1214 Desc<"If specified, this category will be created enabled.">; 1215 def type_category_define_language : Option<"language", "l">, Arg<"Language">, 1216 Desc<"Specify the language that this category is supported for.">; 1217} 1218 1219let Command = "type category enable" in { 1220 def type_category_enable_language : Option<"language", "l">, Arg<"Language">, 1221 Desc<"Enable the category for this language.">; 1222} 1223 1224let Command = "type category disable" in { 1225 def type_category_disable_language : Option<"language", "l">, Arg<"Language">, 1226 Desc<"Enable the category for this language.">; 1227} 1228 1229let Command = "type filter add" in { 1230 def type_filter_add_cascade : Option<"cascade", "C">, Arg<"Boolean">, 1231 Desc<"If true, cascade through typedef chains.">; 1232 def type_filter_add_skip_pointers : Option<"skip-pointers", "p">, 1233 Desc<"Don't use this format for pointers-to-type objects.">; 1234 def type_filter_add_skip_references : Option<"skip-references", "r">, 1235 Desc<"Don't use this format for references-to-type objects.">; 1236 def type_filter_add_category : Option<"category", "w">, Arg<"Name">, 1237 Desc<"Add this to the given category instead of the default one.">; 1238 def type_filter_add_child : Option<"child", "c">, Arg<"ExpressionPath">, 1239 Desc<"Include this expression path in the synthetic view.">; 1240 def type_filter_add_regex : Option<"regex", "x">, 1241 Desc<"Type names are actually regular expressions.">; 1242} 1243 1244let Command = "type lookup" in { 1245 def type_lookup_show_help : Option<"show-help", "h">, 1246 Desc<"Display available help for types">; 1247 def type_lookup_language : Option<"language", "l">, Arg<"Language">, 1248 Desc<"Which language's types should the search scope be">; 1249} 1250 1251let Command = "watchpoint list" in { 1252 def watchpoint_list_brief : Option<"brief", "b">, Group<1>, Desc<"Give a " 1253 "brief description of the watchpoint (no location info).">; 1254 def watchpoint_list_full : Option<"full", "f">, Group<2>, Desc<"Give a full " 1255 "description of the watchpoint and its locations.">; 1256 def watchpoint_list_verbose : Option<"verbose", "v">, Group<3>, Desc<"Explain " 1257 "everything we know about the watchpoint (for debugging debugger bugs).">; 1258} 1259 1260let Command = "watchpoint ignore" in { 1261 def watchpoint_ignore_ignore_count : Option<"ignore-count", "i">, 1262 Arg<"Count">, Required, Desc<"Set the number of times this watchpoint is" 1263 " skipped before stopping.">; 1264} 1265 1266let Command = "watchpoint modify" in { 1267 def watchpoint_modify_condition : Option<"condition", "c">, Arg<"Expression">, 1268 Desc<"The watchpoint stops only if this condition expression evaluates " 1269 "to true.">; 1270} 1271 1272let Command = "watchpoint command add" in { 1273 def watchpoint_command_add_one_liner : Option<"one-liner", "o">, Group<1>, 1274 Arg<"OneLiner">, Desc<"Specify a one-line watchpoint command inline. Be " 1275 "sure to surround it with quotes.">; 1276 def watchpoint_command_add_stop_on_error : Option<"stop-on-error", "e">, 1277 Arg<"Boolean">, Desc<"Specify whether watchpoint command execution should " 1278 "terminate on error.">; 1279 def watchpoint_command_add_script_type : Option<"script-type", "s">, 1280 EnumArg<"None", "ScriptOptionEnum()">, Desc<"Specify the language for the" 1281 " commands - if none is specified, the lldb command interpreter will be " 1282 "used.">; 1283 def watchpoint_command_add_python_function : Option<"python-function", "F">, 1284 Group<2>, Arg<"PythonFunction">, Desc<"Give the name of a Python function " 1285 "to run as command for this watchpoint. Be sure to give a module name if " 1286 "appropriate.">; 1287} 1288 1289let Command = "watchpoint delete" in { 1290 def watchpoint_delete_force : Option<"force", "f">, Group<1>, 1291 Desc<"Delete all watchpoints without querying for confirmation.">; 1292} 1293 1294let Command = "trace load" in { 1295 def trace_load_verbose : Option<"verbose", "v">, Group<1>, 1296 Desc<"Show verbose trace load logging for debugging the plug-in " 1297 "implementation.">; 1298} 1299 1300let Command = "trace dump" in { 1301 def trace_dump_verbose : Option<"verbose", "v">, Group<1>, 1302 Desc<"Show verbose trace information.">; 1303} 1304 1305let Command = "trace schema" in { 1306 def trace_schema_verbose : Option<"verbose", "v">, Group<1>, 1307 Desc<"Show verbose trace schema logging for debugging the plug-in.">; 1308} 1309 1310let Command = "statistics dump" in { 1311 def statistics_dump_all: Option<"all-targets", "a">, Group<1>, 1312 Desc<"Include statistics for all targets.">; 1313} 1314