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 PreferDynamic: Property<"prefer-dynamic-value", "Enum">,
24    DefaultEnumValue<"eDynamicDontRunTarget">,
25    EnumValues<"OptionEnumValues(g_dynamic_value_types)">,
26    Desc<"Should printed values be shown as their dynamic value.">;
27  def EnableSynthetic: Property<"enable-synthetic-value", "Boolean">,
28    DefaultTrue,
29    Desc<"Should synthetic values be used by default whenever available.">;
30  def SkipPrologue: Property<"skip-prologue", "Boolean">,
31    DefaultTrue,
32    Desc<"Skip function prologues when setting breakpoints by name.">;
33  def SourceMap: Property<"source-map", "PathMap">,
34    DefaultStringValue<"">,
35    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.">;
36  def ExecutableSearchPaths: Property<"exec-search-paths", "FileSpecList">,
37    DefaultStringValue<"">,
38    Desc<"Executable search paths to use when locating executable files whose paths don't match the local file system.">;
39  def DebugFileSearchPaths: Property<"debug-file-search-paths", "FileSpecList">,
40    DefaultStringValue<"">,
41    Desc<"List of directories to be searched when locating debug symbol files. See also symbols.enable-external-lookup.">;
42  def ClangModuleSearchPaths: Property<"clang-module-search-paths", "FileSpecList">,
43    DefaultStringValue<"">,
44    Desc<"List of directories to be searched when locating modules for Clang.">;
45  def AutoImportClangModules: Property<"auto-import-clang-modules", "Boolean">,
46    DefaultTrue,
47    Desc<"Automatically load Clang modules referred to by the program.">;
48  def ImportStdModule: Property<"import-std-module", "Boolean">,
49    DefaultFalse,
50    Desc<"Import the C++ std module to improve debugging STL containers.">;
51  def AutoApplyFixIts: Property<"auto-apply-fixits", "Boolean">,
52    DefaultTrue,
53    Desc<"Automatically apply fix-it hints to expressions.">;
54  def RetriesWithFixIts: Property<"retries-with-fixits", "UInt64">,
55    DefaultUnsignedValue<1>,
56    Desc<"Maximum number of attempts to fix an expression with Fix-Its">;
57  def NotifyAboutFixIts: Property<"notify-about-fixits", "Boolean">,
58    DefaultTrue,
59    Desc<"Print the fixed expression text.">;
60  def SaveObjects: Property<"save-jit-objects", "Boolean">,
61    DefaultFalse,
62    Desc<"Save intermediate object files generated by the LLVM JIT">;
63  def MaxZeroPaddingInFloatFormat: Property<"max-zero-padding-in-float-format", "UInt64">,
64    DefaultUnsignedValue<6>,
65    Desc<"The maximum number of zeroes to insert when displaying a very small float before falling back to scientific notation.">;
66  def MaxChildrenCount: Property<"max-children-count", "SInt64">,
67    DefaultUnsignedValue<256>,
68    Desc<"Maximum number of children to expand in any level of depth.">;
69  def MaxSummaryLength: Property<"max-string-summary-length", "SInt64">,
70    DefaultUnsignedValue<1024>,
71    Desc<"Maximum number of characters to show when using %s in summary strings.">;
72  def MaxMemReadSize: Property<"max-memory-read-size", "SInt64">,
73    DefaultUnsignedValue<1024>,
74    Desc<"Maximum number of bytes that 'memory read' will fetch before --force must be specified.">;
75  def BreakpointUseAvoidList: Property<"breakpoints-use-platform-avoid-list", "Boolean">,
76    DefaultTrue,
77    Desc<"Consult the platform module avoid list when setting non-module specific breakpoints.">;
78  def Arg0: Property<"arg0", "String">,
79    DefaultStringValue<"">,
80    Desc<"The first argument passed to the program in the argument array which can be different from the executable itself.">;
81  def RunArgs: Property<"run-args", "Args">,
82    DefaultStringValue<"">,
83    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.">;
84  def EnvVars: Property<"env-vars", "Dictionary">,
85    ElementType<"String">,
86    Desc<"A list of user provided environment variables to be passed to the executable's environment, and their values.">;
87  def UnsetEnvVars: Property<"unset-env-vars", "Array">,
88    ElementType<"String">,
89    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.">;
90  def InheritEnv: Property<"inherit-env", "Boolean">,
91    DefaultTrue,
92    Desc<"Inherit the environment from the process that is running LLDB.">;
93  def InputPath: Property<"input-path", "FileSpec">,
94    DefaultStringValue<"">,
95    Desc<"The file/path to be used by the executable program for reading its standard input.">;
96  def OutputPath: Property<"output-path", "FileSpec">,
97    DefaultStringValue<"">,
98    Desc<"The file/path to be used by the executable program for writing its standard output.">;
99  def ErrorPath: Property<"error-path", "FileSpec">,
100    DefaultStringValue<"">,
101    Desc<"The file/path to be used by the executable program for writing its standard error.">;
102  def DetachOnError: Property<"detach-on-error", "Boolean">,
103    DefaultTrue,
104    Desc<"debugserver will detach (rather than killing) a process if it loses connection with lldb.">;
105  def PreloadSymbols: Property<"preload-symbols", "Boolean">,
106    DefaultTrue,
107    Desc<"Enable loading of symbol tables before they are needed.">;
108  def DisableASLR: Property<"disable-aslr", "Boolean">,
109    DefaultTrue,
110    Desc<"Disable Address Space Layout Randomization (ASLR)">;
111  def DisableSTDIO: Property<"disable-stdio", "Boolean">,
112    DefaultFalse,
113    Desc<"Disable stdin/stdout for process (e.g. for a GUI application)">;
114  def InheritTCC: Property<"inherit-tcc", "Boolean">,
115    DefaultFalse,
116    Desc<"Inherit the TCC permissions from the inferior's parent instead of making the process itself responsible.">;
117  def InlineStrategy: Property<"inline-breakpoint-strategy", "Enum">,
118    DefaultEnumValue<"eInlineBreakpointsAlways">,
119    EnumValues<"OptionEnumValues(g_inline_breakpoint_enums)">,
120    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.">;
121  def DisassemblyFlavor: Property<"x86-disassembly-flavor", "Enum">,
122    DefaultEnumValue<"eX86DisFlavorDefault">,
123    EnumValues<"OptionEnumValues(g_x86_dis_flavor_value_types)">,
124    Desc<"The default disassembly flavor to use for x86 or x86-64 targets.">;
125  def UseHexImmediates: Property<"use-hex-immediates", "Boolean">,
126    DefaultTrue,
127    Desc<"Show immediates in disassembly as hexadecimal.">;
128  def HexImmediateStyle: Property<"hex-immediate-style", "Enum">,
129    DefaultEnumValue<"Disassembler::eHexStyleC">,
130    EnumValues<"OptionEnumValues(g_hex_immediate_style_values)">,
131    Desc<"Which style to use for printing hexadecimal disassembly values.">;
132  def UseFastStepping: Property<"use-fast-stepping", "Boolean">,
133    DefaultTrue,
134    Desc<"Use a fast stepping algorithm based on running from branch to branch rather than instruction single-stepping.">;
135  def LoadScriptFromSymbolFile: Property<"load-script-from-symbol-file", "Enum">,
136    DefaultEnumValue<"eLoadScriptFromSymFileWarn">,
137    EnumValues<"OptionEnumValues(g_load_script_from_sym_file_values)">,
138    Desc<"Allow LLDB to load scripting resources embedded in symbol files when available.">;
139  def LoadCWDlldbinitFile: Property<"load-cwd-lldbinit", "Enum">,
140    DefaultEnumValue<"eLoadCWDlldbinitWarn">,
141    EnumValues<"OptionEnumValues(g_load_cwd_lldbinit_values)">,
142    Desc<"Allow LLDB to .lldbinit files from the current directory automatically.">;
143  def MemoryModuleLoadLevel: Property<"memory-module-load-level", "Enum">,
144    DefaultEnumValue<"eMemoryModuleLoadLevelComplete">,
145    EnumValues<"OptionEnumValues(g_memory_module_load_level_values)">,
146    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). ">;
147  def DisplayExpressionsInCrashlogs: Property<"display-expression-in-crashlogs", "Boolean">,
148    DefaultFalse,
149    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.">;
150  def TrapHandlerNames: Property<"trap-handler-names", "Array">,
151    Global,
152    ElementType<"String">,
153    Desc<"A list of trap handler function names, e.g. a common Unix user process one is _sigtramp.">;
154  def DisplayRuntimeSupportValues: Property<"display-runtime-support-values", "Boolean">,
155    DefaultFalse,
156    Desc<"If true, LLDB will show variables that are meant to support the operation of a language's runtime support.">;
157  def DisplayRecognizedArguments: Property<"display-recognized-arguments", "Boolean">,
158    DefaultFalse,
159    Desc<"Show recognized arguments in variable listings by default.">;
160  def NonStopModeEnabled: Property<"non-stop-mode", "Boolean">,
161    DefaultFalse,
162    Desc<"Disable lock-step debugging, instead control threads independently.">;
163  def RequireHardwareBreakpoints: Property<"require-hardware-breakpoint", "Boolean">,
164    DefaultFalse,
165    Desc<"Require all breakpoints to be hardware breakpoints.">;
166  def AutoInstallMainExecutable: Property<"auto-install-main-executable", "Boolean">,
167    DefaultTrue,
168    Desc<"Always install the main executable when connected to a remote platform.">;
169}
170
171let Definition = "process_experimental" in {
172  def OSPluginReportsAllThreads: Property<"os-plugin-reports-all-threads", "Boolean">,
173    Global,
174    DefaultTrue,
175    Desc<"Set to False if your OS Plugins doesn't report all threads on each stop.">;
176}
177
178let Definition = "process" in {
179  def DisableMemCache: Property<"disable-memory-cache", "Boolean">,
180    DefaultFalse,
181    Desc<"Disable reading and caching of memory in fixed-size units.">;
182  def ExtraStartCommand: Property<"extra-startup-command", "Array">,
183    ElementType<"String">,
184    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;'">;
185  def IgnoreBreakpointsInExpressions: Property<"ignore-breakpoints-in-expressions", "Boolean">,
186    Global,
187    DefaultTrue,
188    Desc<"If true, breakpoints will be ignored during expression evaluation.">;
189  def UnwindOnErrorInExpressions: Property<"unwind-on-error-in-expressions", "Boolean">,
190    Global,
191    DefaultTrue,
192    Desc<"If true, errors in expression evaluation will unwind the stack back to the state before the call.">;
193  def PythonOSPluginPath: Property<"python-os-plugin-path", "FileSpec">,
194    DefaultUnsignedValue<1>,
195    Desc<"A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class.">;
196  def StopOnSharedLibraryEvents: Property<"stop-on-sharedlibrary-events", "Boolean">,
197    Global,
198    DefaultFalse,
199    Desc<"If true, stop when a shared library is loaded or unloaded.">;
200  def DetachKeepsStopped: Property<"detach-keeps-stopped", "Boolean">,
201    Global,
202    DefaultFalse,
203    Desc<"If true, detach will attempt to keep the process stopped.">;
204  def MemCacheLineSize: Property<"memory-cache-line-size", "UInt64">,
205    DefaultUnsignedValue<512>,
206    Desc<"The memory cache line size">;
207  def WarningOptimization: Property<"optimization-warnings", "Boolean">,
208    DefaultTrue,
209    Desc<"If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected.">;
210  def WarningUnsupportedLanguage: Property<"unsupported-language-warnings", "Boolean">,
211    DefaultTrue,
212    Desc<"If true, warn when stopped in code that is written in a source language that LLDB does not support.">;
213  def StopOnExec: Property<"stop-on-exec", "Boolean">,
214    Global,
215    DefaultTrue,
216    Desc<"If true, stop when a shared library is loaded or unloaded.">;
217  def UtilityExpressionTimeout: Property<"utility-expression-timeout", "UInt64">,
218    DefaultUnsignedValue<15>,
219    Desc<"The time in seconds to wait for LLDB-internal utility expressions.">;
220  def SteppingRunsAllThreads: Property<"run-all-threads", "Boolean">,
221    DefaultFalse,
222    Desc<"If true, stepping operations will run all threads.  This is equivalent to setting the run-mode option to 'all-threads'.">;
223}
224
225let Definition = "platform" in {
226  def UseModuleCache: Property<"use-module-cache", "Boolean">,
227    Global,
228    DefaultTrue,
229    Desc<"Use module cache.">;
230  def ModuleCacheDirectory: Property<"module-cache-directory", "FileSpec">,
231    Global,
232    DefaultStringValue<"">,
233    Desc<"Root directory for cached modules.">;
234}
235
236let Definition = "thread" in {
237  def StepInAvoidsNoDebug: Property<"step-in-avoid-nodebug", "Boolean">,
238    Global,
239    DefaultTrue,
240    Desc<"If true, step-in will not stop in functions with no debug information.">;
241  def StepOutAvoidsNoDebug: Property<"step-out-avoid-nodebug", "Boolean">,
242    Global,
243    DefaultFalse,
244    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.">;
245  def StepAvoidRegex: Property<"step-avoid-regexp", "Regex">,
246    Global,
247    DefaultStringValue<"^std::">,
248    Desc<"A regular expression defining functions step-in won't stop in.">;
249  def StepAvoidLibraries: Property<"step-avoid-libraries", "FileSpecList">,
250    Global,
251    DefaultStringValue<"">,
252    Desc<"A list of libraries that source stepping won't stop in.">;
253  def EnableThreadTrace: Property<"trace-thread", "Boolean">,
254    DefaultFalse,
255    Desc<"If true, this thread will single-step and log execution.">;
256  def MaxBacktraceDepth: Property<"max-backtrace-depth", "UInt64">,
257    DefaultUnsignedValue<300000>,
258    Desc<"Maximum number of frames to backtrace.">;
259}
260