1include "../../include/lldb/Core/PropertiesBase.td"
2
3let Definition = "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  def OSPluginReportsAllThreads: Property<"os-plugin-reports-all-threads", "Boolean">,
8    Global,
9    DefaultTrue,
10    Desc<"Set to False if your OS Plugins doesn't report all threads on each stop.">;
11}
12
13let Definition = "target" in {
14  def DefaultArch: Property<"default-arch", "Arch">,
15    Global,
16    DefaultStringValue<"">,
17    Desc<"Default architecture to choose, when there's a choice.">;
18  def MoveToNearestCode: Property<"move-to-nearest-code", "Boolean">,
19    DefaultTrue,
20    Desc<"Move breakpoints to nearest code.">;
21  def Language: Property<"language", "Language">,
22    DefaultEnumValue<"eLanguageTypeUnknown">,
23    Desc<"The language to use when interpreting expressions entered in commands.">;
24  def ExprPrefix: Property<"expr-prefix", "FileSpec">,
25    DefaultStringValue<"">,
26    Desc<"Path to a file containing expressions to be prepended to all expressions.">;
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 are used to track the change of location between a source file when built, and where it exists on the current system.  It consists of an array of duples, the first element of each duple is some part (starting at the root) of the path to the file when it was built, and the second is where the remainder of the original build hierarchy is rooted on the local system.  Each element of the array is checked in order and the first one that results in a match wins.">;
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", "Boolean">,
53    DefaultFalse,
54    Desc<"Import the C++ std module to improve debugging STL containers.">;
55  def AutoApplyFixIts: Property<"auto-apply-fixits", "Boolean">,
56    DefaultTrue,
57    Desc<"Automatically apply fix-it hints to expressions.">;
58  def RetriesWithFixIts: Property<"retries-with-fixits", "UInt64">,
59    DefaultUnsignedValue<1>,
60    Desc<"Maximum number of attempts to fix an expression with Fix-Its">;
61  def NotifyAboutFixIts: Property<"notify-about-fixits", "Boolean">,
62    DefaultTrue,
63    Desc<"Print the fixed expression text.">;
64  def SaveObjects: Property<"save-jit-objects", "Boolean">,
65    DefaultFalse,
66    Desc<"Save intermediate object files generated by the LLVM JIT">;
67  def MaxZeroPaddingInFloatFormat: Property<"max-zero-padding-in-float-format", "UInt64">,
68    DefaultUnsignedValue<6>,
69    Desc<"The maximum number of zeroes to insert when displaying a very small float before falling back to scientific notation.">;
70  def MaxChildrenCount: Property<"max-children-count", "SInt64">,
71    DefaultUnsignedValue<256>,
72    Desc<"Maximum number of children to expand in any level of depth.">;
73  def MaxSummaryLength: Property<"max-string-summary-length", "SInt64">,
74    DefaultUnsignedValue<1024>,
75    Desc<"Maximum number of characters to show when using %s in summary strings.">;
76  def MaxMemReadSize: Property<"max-memory-read-size", "SInt64">,
77    DefaultUnsignedValue<1024>,
78    Desc<"Maximum number of bytes that 'memory read' will fetch before --force must be specified.">;
79  def BreakpointUseAvoidList: Property<"breakpoints-use-platform-avoid-list", "Boolean">,
80    DefaultTrue,
81    Desc<"Consult the platform module avoid list when setting non-module specific breakpoints.">;
82  def Arg0: Property<"arg0", "String">,
83    DefaultStringValue<"">,
84    Desc<"The first argument passed to the program in the argument array which can be different from the executable itself.">;
85  def RunArgs: Property<"run-args", "Args">,
86    DefaultStringValue<"">,
87    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.">;
88  def EnvVars: Property<"env-vars", "Dictionary">,
89    ElementType<"String">,
90    Desc<"A list of user provided environment variables to be passed to the executable's environment, and their values.">;
91  def UnsetEnvVars: Property<"unset-env-vars", "Array">,
92    ElementType<"String">,
93    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.">;
94  def InheritEnv: Property<"inherit-env", "Boolean">,
95    DefaultTrue,
96    Desc<"Inherit the environment from the process that is running LLDB.">;
97  def InputPath: Property<"input-path", "FileSpec">,
98    DefaultStringValue<"">,
99    Desc<"The file/path to be used by the executable program for reading its standard input.">;
100  def OutputPath: Property<"output-path", "FileSpec">,
101    DefaultStringValue<"">,
102    Desc<"The file/path to be used by the executable program for writing its standard output.">;
103  def ErrorPath: Property<"error-path", "FileSpec">,
104    DefaultStringValue<"">,
105    Desc<"The file/path to be used by the executable program for writing its standard error.">;
106  def DetachOnError: Property<"detach-on-error", "Boolean">,
107    DefaultTrue,
108    Desc<"debugserver will detach (rather than killing) a process if it loses connection with lldb.">;
109  def PreloadSymbols: Property<"preload-symbols", "Boolean">,
110    DefaultTrue,
111    Desc<"Enable loading of symbol tables before they are needed.">;
112  def DisableASLR: Property<"disable-aslr", "Boolean">,
113    DefaultTrue,
114    Desc<"Disable Address Space Layout Randomization (ASLR)">;
115  def DisableSTDIO: Property<"disable-stdio", "Boolean">,
116    DefaultFalse,
117    Desc<"Disable stdin/stdout for process (e.g. for a GUI application)">;
118  def InlineStrategy: Property<"inline-breakpoint-strategy", "Enum">,
119    DefaultEnumValue<"eInlineBreakpointsAlways">,
120    EnumValues<"OptionEnumValues(g_inline_breakpoint_enums)">,
121    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.">;
122  def DisassemblyFlavor: Property<"x86-disassembly-flavor", "Enum">,
123    DefaultEnumValue<"eX86DisFlavorDefault">,
124    EnumValues<"OptionEnumValues(g_x86_dis_flavor_value_types)">,
125    Desc<"The default disassembly flavor to use for x86 or x86-64 targets.">;
126  def UseHexImmediates: Property<"use-hex-immediates", "Boolean">,
127    DefaultTrue,
128    Desc<"Show immediates in disassembly as hexadecimal.">;
129  def HexImmediateStyle: Property<"hex-immediate-style", "Enum">,
130    DefaultEnumValue<"Disassembler::eHexStyleC">,
131    EnumValues<"OptionEnumValues(g_hex_immediate_style_values)">,
132    Desc<"Which style to use for printing hexadecimal disassembly values.">;
133  def UseFastStepping: Property<"use-fast-stepping", "Boolean">,
134    DefaultTrue,
135    Desc<"Use a fast stepping algorithm based on running from branch to branch rather than instruction single-stepping.">;
136  def LoadScriptFromSymbolFile: Property<"load-script-from-symbol-file", "Enum">,
137    DefaultEnumValue<"eLoadScriptFromSymFileWarn">,
138    EnumValues<"OptionEnumValues(g_load_script_from_sym_file_values)">,
139    Desc<"Allow LLDB to load scripting resources embedded in symbol files when available.">;
140  def LoadCWDlldbinitFile: Property<"load-cwd-lldbinit", "Enum">,
141    DefaultEnumValue<"eLoadCWDlldbinitWarn">,
142    EnumValues<"OptionEnumValues(g_load_cwd_lldbinit_values)">,
143    Desc<"Allow LLDB to .lldbinit files from the current directory automatically.">;
144  def MemoryModuleLoadLevel: Property<"memory-module-load-level", "Enum">,
145    DefaultEnumValue<"eMemoryModuleLoadLevelComplete">,
146    EnumValues<"OptionEnumValues(g_memory_module_load_level_values)">,
147    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). ">;
148  def DisplayExpressionsInCrashlogs: Property<"display-expression-in-crashlogs", "Boolean">,
149    DefaultFalse,
150    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.">;
151  def TrapHandlerNames: Property<"trap-handler-names", "Array">,
152    Global,
153    ElementType<"String">,
154    Desc<"A list of trap handler function names, e.g. a common Unix user process one is _sigtramp.">;
155  def DisplayRuntimeSupportValues: Property<"display-runtime-support-values", "Boolean">,
156    DefaultFalse,
157    Desc<"If true, LLDB will show variables that are meant to support the operation of a language's runtime support.">;
158  def DisplayRecognizedArguments: Property<"display-recognized-arguments", "Boolean">,
159    DefaultFalse,
160    Desc<"Show recognized arguments in variable listings by default.">;
161  def NonStopModeEnabled: Property<"non-stop-mode", "Boolean">,
162    DefaultFalse,
163    Desc<"Disable lock-step debugging, instead control threads independently.">;
164  def RequireHardwareBreakpoints: Property<"require-hardware-breakpoint", "Boolean">,
165    DefaultFalse,
166    Desc<"Require all breakpoints to be hardware breakpoints.">;
167  def AutoInstallMainExecutable: Property<"auto-install-main-executable", "Boolean">,
168    DefaultTrue,
169    Desc<"Always install the main executable when connected to a remote platform.">;
170}
171
172let Definition = "process" in {
173  def DisableMemCache: Property<"disable-memory-cache", "Boolean">,
174    DefaultFalse,
175    Desc<"Disable reading and caching of memory in fixed-size units.">;
176  def ExtraStartCommand: Property<"extra-startup-command", "Array">,
177    ElementType<"String">,
178    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;'">;
179  def IgnoreBreakpointsInExpressions: Property<"ignore-breakpoints-in-expressions", "Boolean">,
180    Global,
181    DefaultTrue,
182    Desc<"If true, breakpoints will be ignored during expression evaluation.">;
183  def UnwindOnErrorInExpressions: Property<"unwind-on-error-in-expressions", "Boolean">,
184    Global,
185    DefaultTrue,
186    Desc<"If true, errors in expression evaluation will unwind the stack back to the state before the call.">;
187  def PythonOSPluginPath: Property<"python-os-plugin-path", "FileSpec">,
188    DefaultUnsignedValue<1>,
189    Desc<"A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class.">;
190  def StopOnSharedLibraryEvents: Property<"stop-on-sharedlibrary-events", "Boolean">,
191    Global,
192    DefaultFalse,
193    Desc<"If true, stop when a shared library is loaded or unloaded.">;
194  def DetachKeepsStopped: Property<"detach-keeps-stopped", "Boolean">,
195    Global,
196    DefaultFalse,
197    Desc<"If true, detach will attempt to keep the process stopped.">;
198  def MemCacheLineSize: Property<"memory-cache-line-size", "UInt64">,
199    DefaultUnsignedValue<512>,
200    Desc<"The memory cache line size">;
201  def WarningOptimization: Property<"optimization-warnings", "Boolean">,
202    DefaultTrue,
203    Desc<"If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected.">;
204  def StopOnExec: Property<"stop-on-exec", "Boolean">,
205    Global,
206    DefaultTrue,
207    Desc<"If true, stop when a shared library is loaded or unloaded.">;
208  def UtilityExpressionTimeout: Property<"utility-expression-timeout", "UInt64">,
209    DefaultUnsignedValue<15>,
210    Desc<"The time in seconds to wait for LLDB-internal utility expressions.">;
211}
212
213let Definition = "platform" in {
214  def UseModuleCache: Property<"use-module-cache", "Boolean">,
215    Global,
216    DefaultTrue,
217    Desc<"Use module cache.">;
218  def ModuleCacheDirectory: Property<"module-cache-directory", "FileSpec">,
219    Global,
220    DefaultStringValue<"">,
221    Desc<"Root directory for cached modules.">;
222}
223
224let Definition = "thread" in {
225  def StepInAvoidsNoDebug: Property<"step-in-avoid-nodebug", "Boolean">,
226    Global,
227    DefaultTrue,
228    Desc<"If true, step-in will not stop in functions with no debug information.">;
229  def StepOutAvoidsNoDebug: Property<"step-out-avoid-nodebug", "Boolean">,
230    Global,
231    DefaultFalse,
232    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.">;
233  def StepAvoidRegex: Property<"step-avoid-regexp", "Regex">,
234    Global,
235    DefaultStringValue<"^std::">,
236    Desc<"A regular expression defining functions step-in won't stop in.">;
237  def StepAvoidLibraries: Property<"step-avoid-libraries", "FileSpecList">,
238    Global,
239    DefaultStringValue<"">,
240    Desc<"A list of libraries that source stepping won't stop in.">;
241  def EnableThreadTrace: Property<"trace-thread", "Boolean">,
242    DefaultFalse,
243    Desc<"If true, this thread will single-step and log execution.">;
244  def MaxBacktraceDepth: Property<"max-backtrace-depth", "UInt64">,
245    DefaultUnsignedValue<300000>,
246    Desc<"Maximum number of frames to backtrace.">;
247}
248