1include "../../include/lldb/Core/PropertiesBase.td"
2
3let Definition = "target_experimental" in {
4  def InjectLocalVars : Property<"inject-local-vars", "Boolean">,
5    Global, DefaultTrue,
6    Desc<"If true, inject local variables explicitly into the expression text. This will fix symbol resolution when there are name collisions between ivars and local variables. But it can make expressions run much more slowly.">;
7}
8
9let Definition = "target" in {
10  def DefaultArch: Property<"default-arch", "Arch">,
11    Global,
12    DefaultStringValue<"">,
13    Desc<"Default architecture to choose, when there's a choice.">;
14  def MoveToNearestCode: Property<"move-to-nearest-code", "Boolean">,
15    DefaultTrue,
16    Desc<"Move breakpoints to nearest code.">;
17  def Language: Property<"language", "Language">,
18    DefaultEnumValue<"eLanguageTypeUnknown">,
19    Desc<"The language to use when interpreting expressions entered in commands.">;
20  def ExprPrefix: Property<"expr-prefix", "FileSpec">,
21    DefaultStringValue<"">,
22    Desc<"Path to a file containing expressions to be prepended to all expressions.">;
23  def ExprErrorLimit: Property<"expr-error-limit", "UInt64">,
24    DefaultUnsignedValue<5>,
25    Desc<"The maximum amount of errors to emit while parsing an expression. "
26         "A value of 0 means to always continue parsing if possible.">;
27  def PreferDynamic: Property<"prefer-dynamic-value", "Enum">,
28    DefaultEnumValue<"eDynamicDontRunTarget">,
29    EnumValues<"OptionEnumValues(g_dynamic_value_types)">,
30    Desc<"Should printed values be shown as their dynamic value.">;
31  def EnableSynthetic: Property<"enable-synthetic-value", "Boolean">,
32    DefaultTrue,
33    Desc<"Should synthetic values be used by default whenever available.">;
34  def SkipPrologue: Property<"skip-prologue", "Boolean">,
35    DefaultTrue,
36    Desc<"Skip function prologues when setting breakpoints by name.">;
37  def SourceMap: Property<"source-map", "PathMap">,
38    DefaultStringValue<"">,
39    Desc<"Source path remappings apply substitutions to the paths of source files, typically needed to debug from a different host than the one that built the target.  The source-map property consists of an array of pairs, the first element is a path prefix, and the second is its replacement.  The syntax is `prefix1 replacement1 prefix2 replacement2...`.  The pairs are checked in order, the first prefix that matches is used, and that prefix is substituted with the replacement.  A common pattern is to use source-map in conjunction with the clang -fdebug-prefix-map flag.  In the build, use `-fdebug-prefix-map=/path/to/build_dir=.` to rewrite the host specific build directory to `.`.  Then for debugging, use `settings set target.source-map . /path/to/local_dir` to convert `.` to a valid local path.">;
40  def ExecutableSearchPaths: Property<"exec-search-paths", "FileSpecList">,
41    DefaultStringValue<"">,
42    Desc<"Executable search paths to use when locating executable files whose paths don't match the local file system.">;
43  def DebugFileSearchPaths: Property<"debug-file-search-paths", "FileSpecList">,
44    DefaultStringValue<"">,
45    Desc<"List of directories to be searched when locating debug symbol files. See also symbols.enable-external-lookup.">;
46  def ClangModuleSearchPaths: Property<"clang-module-search-paths", "FileSpecList">,
47    DefaultStringValue<"">,
48    Desc<"List of directories to be searched when locating modules for Clang.">;
49  def AutoImportClangModules: Property<"auto-import-clang-modules", "Boolean">,
50    DefaultTrue,
51    Desc<"Automatically load Clang modules referred to by the program.">;
52  def ImportStdModule: Property<"import-std-module", "Enum">,
53    DefaultEnumValue<"eImportStdModuleFalse">,
54    EnumValues<"OptionEnumValues(g_import_std_module_value_types)">,
55    Desc<"Import the 'std' C++ module to improve expression parsing involving "
56         " C++ standard library types.">;
57  def DynamicClassInfoHelper: Property<"objc-dynamic-class-extractor", "Enum">,
58    DefaultEnumValue<"eDynamicClassInfoHelperAuto">,
59    EnumValues<"OptionEnumValues(g_dynamic_class_info_helper_value_types)">,
60    Desc<"Configure how LLDB parses dynamic Objective-C class metadata. By default LLDB will choose the most appropriate method for the target OS.">;
61  def AutoApplyFixIts: Property<"auto-apply-fixits", "Boolean">,
62    DefaultTrue,
63    Desc<"Automatically apply fix-it hints to expressions.">;
64  def RetriesWithFixIts: Property<"retries-with-fixits", "UInt64">,
65    DefaultUnsignedValue<1>,
66    Desc<"Maximum number of attempts to fix an expression with Fix-Its">;
67  def NotifyAboutFixIts: Property<"notify-about-fixits", "Boolean">,
68    DefaultTrue,
69    Desc<"Print the fixed expression text.">;
70  def SaveObjectsDir: Property<"save-jit-objects-dir", "FileSpec">,
71    DefaultStringValue<"">,
72    Desc<"If specified, the directory to save intermediate object files generated by the LLVM JIT">;
73  def MaxZeroPaddingInFloatFormat: Property<"max-zero-padding-in-float-format", "UInt64">,
74    DefaultUnsignedValue<6>,
75    Desc<"The maximum number of zeroes to insert when displaying a very small float before falling back to scientific notation.">;
76  def MaxChildrenCount: Property<"max-children-count", "SInt64">,
77    DefaultUnsignedValue<256>,
78    Desc<"Maximum number of children to expand in any level of depth.">;
79  def MaxChildrenDepth: Property<"max-children-depth", "UInt64">,
80    DefaultUnsignedValue<0xFFFFFFFF>,
81    Desc<"Maximum depth to expand children.">;
82  def MaxSummaryLength: Property<"max-string-summary-length", "SInt64">,
83    DefaultUnsignedValue<1024>,
84    Desc<"Maximum number of characters to show when using %s in summary strings.">;
85  def MaxMemReadSize: Property<"max-memory-read-size", "SInt64">,
86    DefaultUnsignedValue<1024>,
87    Desc<"Maximum number of bytes that 'memory read' will fetch before --force must be specified.">;
88  def BreakpointUseAvoidList: Property<"breakpoints-use-platform-avoid-list", "Boolean">,
89    DefaultTrue,
90    Desc<"Consult the platform module avoid list when setting non-module specific breakpoints.">;
91  def Arg0: Property<"arg0", "String">,
92    DefaultStringValue<"">,
93    Desc<"The first argument passed to the program in the argument array which can be different from the executable itself.">;
94  def RunArgs: Property<"run-args", "Args">,
95    DefaultStringValue<"">,
96    Desc<"A list containing all the arguments to be passed to the executable when it is run. Note that this does NOT include the argv[0] which is in target.arg0.">;
97  def EnvVars: Property<"env-vars", "Dictionary">,
98    ElementType<"String">,
99    Desc<"A list of user provided environment variables to be passed to the executable's environment, and their values.">;
100  def UnsetEnvVars: Property<"unset-env-vars", "Array">,
101    ElementType<"String">,
102    Desc<"A list of environment variable names to be unset in the inferior's environment. This is most useful to unset some host environment variables when target.inherit-env is true. target.env-vars takes precedence over target.unset-env-vars.">;
103  def InheritEnv: Property<"inherit-env", "Boolean">,
104    DefaultTrue,
105    Desc<"Inherit the environment from the process that is running LLDB.">;
106  def InputPath: Property<"input-path", "FileSpec">,
107    DefaultStringValue<"">,
108    Desc<"The file/path to be used by the executable program for reading its standard input.">;
109  def OutputPath: Property<"output-path", "FileSpec">,
110    DefaultStringValue<"">,
111    Desc<"The file/path to be used by the executable program for writing its standard output.">;
112  def ErrorPath: Property<"error-path", "FileSpec">,
113    DefaultStringValue<"">,
114    Desc<"The file/path to be used by the executable program for writing its standard error.">;
115  def DetachOnError: Property<"detach-on-error", "Boolean">,
116    DefaultTrue,
117    Desc<"debugserver will detach (rather than killing) a process if it loses connection with lldb.">;
118  def PreloadSymbols: Property<"preload-symbols", "Boolean">,
119    DefaultTrue,
120    Desc<"Enable loading of symbol tables before they are needed.">;
121  def DisableASLR: Property<"disable-aslr", "Boolean">,
122    DefaultTrue,
123    Desc<"Disable Address Space Layout Randomization (ASLR)">;
124  def DisableSTDIO: Property<"disable-stdio", "Boolean">,
125    DefaultFalse,
126    Desc<"Disable stdin/stdout for process (e.g. for a GUI application)">;
127  def InheritTCC: Property<"inherit-tcc", "Boolean">,
128    DefaultFalse,
129    Desc<"Inherit the TCC permissions from the inferior's parent instead of making the process itself responsible.">;
130  def InlineStrategy: Property<"inline-breakpoint-strategy", "Enum">,
131    DefaultEnumValue<"eInlineBreakpointsAlways">,
132    EnumValues<"OptionEnumValues(g_inline_breakpoint_enums)">,
133    Desc<"The strategy to use when settings breakpoints by file and line. Breakpoint locations can end up being inlined by the compiler, so that a compile unit 'a.c' might contain an inlined function from another source file. Usually this is limited to breakpoint locations from inlined functions from header or other include files, or more accurately non-implementation source files. Sometimes code might #include implementation files and cause inlined breakpoint locations in inlined implementation files. Always checking for inlined breakpoint locations can be expensive (memory and time), so if you have a project with many headers and find that setting breakpoints is slow, then you can change this setting to headers. This setting allows you to control exactly which strategy is used when setting file and line breakpoints.">;
134  def DisassemblyFlavor: Property<"x86-disassembly-flavor", "Enum">,
135    DefaultEnumValue<"eX86DisFlavorDefault">,
136    EnumValues<"OptionEnumValues(g_x86_dis_flavor_value_types)">,
137    Desc<"The default disassembly flavor to use for x86 or x86-64 targets.">;
138  def UseHexImmediates: Property<"use-hex-immediates", "Boolean">,
139    DefaultTrue,
140    Desc<"Show immediates in disassembly as hexadecimal.">;
141  def HexImmediateStyle: Property<"hex-immediate-style", "Enum">,
142    DefaultEnumValue<"Disassembler::eHexStyleC">,
143    EnumValues<"OptionEnumValues(g_hex_immediate_style_values)">,
144    Desc<"Which style to use for printing hexadecimal disassembly values.">;
145  def UseFastStepping: Property<"use-fast-stepping", "Boolean">,
146    DefaultTrue,
147    Desc<"Use a fast stepping algorithm based on running from branch to branch rather than instruction single-stepping.">;
148  def LoadScriptFromSymbolFile: Property<"load-script-from-symbol-file", "Enum">,
149    DefaultEnumValue<"eLoadScriptFromSymFileWarn">,
150    EnumValues<"OptionEnumValues(g_load_script_from_sym_file_values)">,
151    Desc<"Allow LLDB to load scripting resources embedded in symbol files when available.">;
152  def LoadCWDlldbinitFile: Property<"load-cwd-lldbinit", "Enum">,
153    DefaultEnumValue<"eLoadCWDlldbinitWarn">,
154    EnumValues<"OptionEnumValues(g_load_cwd_lldbinit_values)">,
155    Desc<"Allow LLDB to .lldbinit files from the current directory automatically.">;
156  def MemoryModuleLoadLevel: Property<"memory-module-load-level", "Enum">,
157    DefaultEnumValue<"eMemoryModuleLoadLevelComplete">,
158    EnumValues<"OptionEnumValues(g_memory_module_load_level_values)">,
159    Desc<"Loading modules from memory can be slow as reading the symbol tables and other data can take a long time depending on your connection to the debug target. This setting helps users control how much information gets loaded when loading modules from memory.'complete' is the default value for this setting which will load all sections and symbols by reading them from memory (slowest, most accurate). 'partial' will load sections and attempt to find function bounds without downloading the symbol table (faster, still accurate, missing symbol names). 'minimal' is the fastest setting and will load section data with no symbols, but should rarely be used as stack frames in these memory regions will be inaccurate and not provide any context (fastest). ">;
160  def DisplayExpressionsInCrashlogs: Property<"display-expression-in-crashlogs", "Boolean">,
161    DefaultFalse,
162    Desc<"Expressions that crash will show up in crash logs if the host system supports executable specific crash log strings and this setting is set to true.">;
163  def TrapHandlerNames: Property<"trap-handler-names", "Array">,
164    Global,
165    ElementType<"String">,
166    Desc<"A list of trap handler function names, e.g. a common Unix user process one is _sigtramp.">;
167  def DisplayRuntimeSupportValues: Property<"display-runtime-support-values", "Boolean">,
168    DefaultFalse,
169    Desc<"If true, LLDB will show variables that are meant to support the operation of a language's runtime support.">;
170  def DisplayRecognizedArguments: Property<"display-recognized-arguments", "Boolean">,
171    DefaultFalse,
172    Desc<"Show recognized arguments in variable listings by default.">;
173  def RequireHardwareBreakpoints: Property<"require-hardware-breakpoint", "Boolean">,
174    DefaultFalse,
175    Desc<"Require all breakpoints to be hardware breakpoints.">;
176  def AutoInstallMainExecutable: Property<"auto-install-main-executable", "Boolean">,
177    DefaultTrue,
178    Desc<"Always install the main executable when connected to a remote platform.">;
179  def DebugUtilityExpression: Property<"debug-utility-expression", "Boolean">,
180    DefaultFalse,
181    Desc<"Enable debugging of LLDB-internal utility expressions.">;
182}
183
184let Definition = "process_experimental" in {
185  def OSPluginReportsAllThreads: Property<"os-plugin-reports-all-threads", "Boolean">,
186    Global,
187    DefaultTrue,
188    Desc<"Set to False if your OS Plugins doesn't report all threads on each stop.">;
189}
190
191let Definition = "process" in {
192  def DisableMemCache: Property<"disable-memory-cache", "Boolean">,
193    DefaultFalse,
194    Desc<"Disable reading and caching of memory in fixed-size units.">;
195  def ExtraStartCommand: Property<"extra-startup-command", "Array">,
196    ElementType<"String">,
197    Desc<"A list containing extra commands understood by the particular process plugin used.  For instance, to turn on debugserver logging set this to 'QSetLogging:bitmask=LOG_DEFAULT;'">;
198  def IgnoreBreakpointsInExpressions: Property<"ignore-breakpoints-in-expressions", "Boolean">,
199    Global,
200    DefaultTrue,
201    Desc<"If true, breakpoints will be ignored during expression evaluation.">;
202  def UnwindOnErrorInExpressions: Property<"unwind-on-error-in-expressions", "Boolean">,
203    Global,
204    DefaultTrue,
205    Desc<"If true, errors in expression evaluation will unwind the stack back to the state before the call.">;
206  def PythonOSPluginPath: Property<"python-os-plugin-path", "FileSpec">,
207    DefaultUnsignedValue<1>,
208    Desc<"A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class.">;
209  def StopOnSharedLibraryEvents: Property<"stop-on-sharedlibrary-events", "Boolean">,
210    Global,
211    DefaultFalse,
212    Desc<"If true, stop when a shared library is loaded or unloaded.">;
213  def DisableLangRuntimeUnwindPlans: Property<"disable-language-runtime-unwindplans", "Boolean">,
214    Global,
215    DefaultFalse,
216    Desc<"If true, LanguageRuntime plugins' UnwindPlans will not be used when backtracing.">;
217  def DetachKeepsStopped: Property<"detach-keeps-stopped", "Boolean">,
218    Global,
219    DefaultFalse,
220    Desc<"If true, detach will attempt to keep the process stopped.">;
221  def MemCacheLineSize: Property<"memory-cache-line-size", "UInt64">,
222    DefaultUnsignedValue<512>,
223    Desc<"The memory cache line size">;
224  def WarningOptimization: Property<"optimization-warnings", "Boolean">,
225    DefaultTrue,
226    Desc<"If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected.">;
227  def WarningUnsupportedLanguage: Property<"unsupported-language-warnings", "Boolean">,
228    DefaultTrue,
229    Desc<"If true, warn when stopped in code that is written in a source language that LLDB does not support.">;
230  def StopOnExec: Property<"stop-on-exec", "Boolean">,
231    Global,
232    DefaultTrue,
233    Desc<"If true, stop when the inferior exec's.">;
234  def UtilityExpressionTimeout: Property<"utility-expression-timeout", "UInt64">,
235    DefaultUnsignedValue<15>,
236    Desc<"The time in seconds to wait for LLDB-internal utility expressions.">;
237  def InterruptTimeout: Property<"interrupt-timeout", "UInt64">,
238    DefaultUnsignedValue<20>,
239    Desc<"The time in seconds to wait for an interrupt succeed in stopping the target.">;
240  def SteppingRunsAllThreads: Property<"run-all-threads", "Boolean">,
241    DefaultFalse,
242    Desc<"If true, stepping operations will run all threads.  This is equivalent to setting the run-mode option to 'all-threads'.">;
243  def VirtualAddressableBits: Property<"virtual-addressable-bits", "UInt64">,
244    DefaultUnsignedValue<0>,
245    Desc<"The number of bits used for addressing. If the value is 39, then bits 0..38 are used for addressing. The default value of 0 means unspecified.">;
246  def FollowForkMode: Property<"follow-fork-mode", "Enum">,
247    DefaultEnumValue<"eFollowParent">,
248    EnumValues<"OptionEnumValues(g_follow_fork_mode_values)">,
249    Desc<"Debugger's behavior upon fork or vfork.">;
250}
251
252let Definition = "platform" in {
253  def UseModuleCache: Property<"use-module-cache", "Boolean">,
254    Global,
255    DefaultTrue,
256    Desc<"Use module cache.">;
257  def ModuleCacheDirectory: Property<"module-cache-directory", "FileSpec">,
258    Global,
259    DefaultStringValue<"">,
260    Desc<"Root directory for cached modules.">;
261}
262
263let Definition = "thread" in {
264  def StepInAvoidsNoDebug: Property<"step-in-avoid-nodebug", "Boolean">,
265    Global,
266    DefaultTrue,
267    Desc<"If true, step-in will not stop in functions with no debug information.">;
268  def StepOutAvoidsNoDebug: Property<"step-out-avoid-nodebug", "Boolean">,
269    Global,
270    DefaultFalse,
271    Desc<"If true, when step-in/step-out/step-over leave the current frame, they will continue to step out till they come to a function with debug information. Passing a frame argument to step-out will override this option.">;
272  def StepAvoidRegex: Property<"step-avoid-regexp", "Regex">,
273    Global,
274    DefaultStringValue<"^std::">,
275    Desc<"A regular expression defining functions step-in won't stop in.">;
276  def StepAvoidLibraries: Property<"step-avoid-libraries", "FileSpecList">,
277    Global,
278    DefaultStringValue<"">,
279    Desc<"A list of libraries that source stepping won't stop in.">;
280  def EnableThreadTrace: Property<"trace-thread", "Boolean">,
281    DefaultFalse,
282    Desc<"If true, this thread will single-step and log execution.">;
283  def MaxBacktraceDepth: Property<"max-backtrace-depth", "UInt64">,
284    DefaultUnsignedValue<600000>,
285    Desc<"Maximum number of frames to backtrace.">;
286}
287