]>
Commit | Line | Data |
---|---|---|
696d846a MO |
1 | //===-- sanitizer_flags.h ---------------------------------------*- C++ -*-===// |
2 | // | |
b667dd70 ML |
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
4 | // See https://llvm.org/LICENSE.txt for license information. | |
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |
696d846a MO |
6 | // |
7 | //===----------------------------------------------------------------------===// | |
8 | // | |
9 | // This file describes common flags available in all sanitizers. | |
10 | // | |
11 | //===----------------------------------------------------------------------===// | |
12 | ||
13 | #ifndef COMMON_FLAG | |
14 | #error "Define COMMON_FLAG prior to including this file!" | |
15 | #endif | |
16 | ||
17 | // COMMON_FLAG(Type, Name, DefaultValue, Description) | |
18 | // Supported types: bool, const char *, int, uptr. | |
19 | // Default value must be a compile-time constant. | |
20 | // Description must be a string literal. | |
21 | ||
22 | COMMON_FLAG( | |
23 | bool, symbolize, true, | |
24 | "If set, use the online symbolizer from common sanitizer runtime to turn " | |
25 | "virtual addresses to file/line locations.") | |
26 | COMMON_FLAG( | |
27 | const char *, external_symbolizer_path, nullptr, | |
28 | "Path to external symbolizer. If empty, the tool will search $PATH for " | |
29 | "the symbolizer.") | |
30 | COMMON_FLAG( | |
31 | bool, allow_addr2line, false, | |
32 | "If set, allows online symbolizer to run addr2line binary to symbolize " | |
33 | "stack traces (addr2line will only be used if llvm-symbolizer binary is " | |
34 | "unavailable.") | |
35 | COMMON_FLAG(const char *, strip_path_prefix, "", | |
36 | "Strips this prefix from file paths in error reports.") | |
37 | COMMON_FLAG(bool, fast_unwind_on_check, false, | |
38 | "If available, use the fast frame-pointer-based unwinder on " | |
39 | "internal CHECK failures.") | |
40 | COMMON_FLAG(bool, fast_unwind_on_fatal, false, | |
41 | "If available, use the fast frame-pointer-based unwinder on fatal " | |
42 | "errors.") | |
43 | COMMON_FLAG(bool, fast_unwind_on_malloc, true, | |
44 | "If available, use the fast frame-pointer-based unwinder on " | |
45 | "malloc/free.") | |
46 | COMMON_FLAG(bool, handle_ioctl, false, "Intercept and handle ioctl requests.") | |
47 | COMMON_FLAG(int, malloc_context_size, 1, | |
48 | "Max number of stack frames kept for each allocation/deallocation.") | |
49 | COMMON_FLAG( | |
50 | const char *, log_path, "stderr", | |
51 | "Write logs to \"log_path.pid\". The special values are \"stdout\" and " | |
52 | "\"stderr\". The default is \"stderr\".") | |
53 | COMMON_FLAG( | |
54 | bool, log_exe_name, false, | |
55 | "Mention name of executable when reporting error and " | |
56 | "append executable name to logs (as in \"log_path.exe_name.pid\").") | |
57 | COMMON_FLAG( | |
eac97531 | 58 | bool, log_to_syslog, (bool)SANITIZER_ANDROID || (bool)SANITIZER_MAC, |
696d846a MO |
59 | "Write all sanitizer output to syslog in addition to other means of " |
60 | "logging.") | |
61 | COMMON_FLAG( | |
62 | int, verbosity, 0, | |
63 | "Verbosity level (0 - silent, 1 - a bit of output, 2+ - more output).") | |
eac97531 ML |
64 | COMMON_FLAG(bool, strip_env, 1, |
65 | "Whether to remove the sanitizer from DYLD_INSERT_LIBRARIES to " | |
66 | "avoid passing it to children. Default is true.") | |
5d3805fc | 67 | COMMON_FLAG(bool, detect_leaks, !SANITIZER_MAC, "Enable memory leak detection.") |
696d846a MO |
68 | COMMON_FLAG( |
69 | bool, leak_check_at_exit, true, | |
70 | "Invoke leak checking in an atexit handler. Has no effect if " | |
71 | "detect_leaks=false, or if __lsan_do_leak_check() is called before the " | |
72 | "handler has a chance to run.") | |
73 | COMMON_FLAG(bool, allocator_may_return_null, false, | |
74 | "If false, the allocator will crash instead of returning 0 on " | |
75 | "out-of-memory.") | |
76 | COMMON_FLAG(bool, print_summary, true, | |
77 | "If false, disable printing error summaries in addition to error " | |
78 | "reports.") | |
5d3805fc JJ |
79 | COMMON_FLAG(int, print_module_map, 0, |
80 | "OS X only (0 - don't print, 1 - print only once before process " | |
81 | "exits, 2 - print after each report).") | |
696d846a | 82 | COMMON_FLAG(bool, check_printf, true, "Check printf arguments.") |
5d3805fc JJ |
83 | #define COMMON_FLAG_HANDLE_SIGNAL_HELP(signal) \ |
84 | "Controls custom tool's " #signal " handler (0 - do not registers the " \ | |
85 | "handler, 1 - register the handler and allow user to set own, " \ | |
86 | "2 - registers the handler and block user from changing it). " | |
87 | COMMON_FLAG(HandleSignalMode, handle_segv, kHandleSignalYes, | |
88 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGSEGV)) | |
89 | COMMON_FLAG(HandleSignalMode, handle_sigbus, kHandleSignalYes, | |
90 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGBUS)) | |
91 | COMMON_FLAG(HandleSignalMode, handle_abort, kHandleSignalNo, | |
92 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGABRT)) | |
93 | COMMON_FLAG(HandleSignalMode, handle_sigill, kHandleSignalNo, | |
94 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGILL)) | |
eac97531 ML |
95 | COMMON_FLAG(HandleSignalMode, handle_sigtrap, kHandleSignalNo, |
96 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGTRAP)) | |
5d3805fc JJ |
97 | COMMON_FLAG(HandleSignalMode, handle_sigfpe, kHandleSignalYes, |
98 | COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGFPE)) | |
99 | #undef COMMON_FLAG_HANDLE_SIGNAL_HELP | |
100 | COMMON_FLAG(bool, allow_user_segv_handler, true, | |
101 | "Deprecated. True has no effect, use handle_sigbus=1. If false, " | |
102 | "handle_*=1 will be upgraded to handle_*=2.") | |
696d846a MO |
103 | COMMON_FLAG(bool, use_sigaltstack, true, |
104 | "If set, uses alternate stack for signal handling.") | |
b667dd70 | 105 | COMMON_FLAG(bool, detect_deadlocks, true, |
696d846a MO |
106 | "If set, deadlock detection is enabled.") |
107 | COMMON_FLAG( | |
108 | uptr, clear_shadow_mmap_threshold, 64 * 1024, | |
109 | "Large shadow regions are zero-filled using mmap(NORESERVE) instead of " | |
110 | "memset(). This is the threshold size in bytes.") | |
111 | COMMON_FLAG(const char *, color, "auto", | |
112 | "Colorize reports: (always|never|auto).") | |
113 | COMMON_FLAG( | |
114 | bool, legacy_pthread_cond, false, | |
115 | "Enables support for dynamic libraries linked with libpthread 2.2.5.") | |
116 | COMMON_FLAG(bool, intercept_tls_get_addr, false, "Intercept __tls_get_addr.") | |
117 | COMMON_FLAG(bool, help, false, "Print the flag descriptions.") | |
118 | COMMON_FLAG(uptr, mmap_limit_mb, 0, | |
119 | "Limit the amount of mmap-ed memory (excluding shadow) in Mb; " | |
120 | "not a user-facing flag, used mosly for testing the tools") | |
121 | COMMON_FLAG(uptr, hard_rss_limit_mb, 0, | |
122 | "Hard RSS limit in Mb." | |
123 | " If non-zero, a background thread is spawned at startup" | |
124 | " which periodically reads RSS and aborts the process if the" | |
125 | " limit is reached") | |
126 | COMMON_FLAG(uptr, soft_rss_limit_mb, 0, | |
127 | "Soft RSS limit in Mb." | |
128 | " If non-zero, a background thread is spawned at startup" | |
129 | " which periodically reads RSS. If the limit is reached" | |
130 | " all subsequent malloc/new calls will fail or return NULL" | |
131 | " (depending on the value of allocator_may_return_null)" | |
132 | " until the RSS goes below the soft limit." | |
133 | " This limit does not affect memory allocations other than" | |
134 | " malloc/new.") | |
cb7dc4da ML |
135 | COMMON_FLAG(uptr, max_allocation_size_mb, 0, |
136 | "If non-zero, malloc/new calls larger than this size will return " | |
137 | "nullptr (or crash if allocator_may_return_null=false).") | |
10189819 | 138 | COMMON_FLAG(bool, heap_profile, false, "Experimental heap profiler, asan-only") |
eac97531 ML |
139 | COMMON_FLAG(s32, allocator_release_to_os_interval_ms, |
140 | ((bool)SANITIZER_FUCHSIA || (bool)SANITIZER_WINDOWS) ? -1 : 5000, | |
141 | "Only affects a 64-bit allocator. If set, tries to release unused " | |
142 | "memory to the OS, but not more often than this interval (in " | |
143 | "milliseconds). Negative values mean do not attempt to release " | |
144 | "memory to the OS.\n") | |
696d846a MO |
145 | COMMON_FLAG(bool, can_use_proc_maps_statm, true, |
146 | "If false, do not attempt to read /proc/maps/statm." | |
147 | " Mostly useful for testing sanitizers.") | |
148 | COMMON_FLAG( | |
149 | bool, coverage, false, | |
150 | "If set, coverage information will be dumped at program shutdown (if the " | |
151 | "coverage instrumentation was enabled at compile time).") | |
696d846a MO |
152 | COMMON_FLAG(const char *, coverage_dir, ".", |
153 | "Target directory for coverage dumps. Defaults to the current " | |
154 | "directory.") | |
155 | COMMON_FLAG(bool, full_address_space, false, | |
156 | "Sanitize complete address space; " | |
157 | "by default kernel area on 32-bit platforms will not be sanitized") | |
158 | COMMON_FLAG(bool, print_suppressions, true, | |
159 | "Print matched suppressions at exit.") | |
160 | COMMON_FLAG( | |
10189819 MO |
161 | bool, disable_coredump, (SANITIZER_WORDSIZE == 64) && !SANITIZER_GO, |
162 | "Disable core dumping. By default, disable_coredump=1 on 64-bit to avoid" | |
163 | " dumping a 16T+ core file. Ignored on OSes that don't dump core by" | |
164 | " default and for sanitizers that don't reserve lots of virtual memory.") | |
696d846a MO |
165 | COMMON_FLAG(bool, use_madv_dontdump, true, |
166 | "If set, instructs kernel to not store the (huge) shadow " | |
167 | "in core file.") | |
168 | COMMON_FLAG(bool, symbolize_inline_frames, true, | |
169 | "Print inlined frames in stacktraces. Defaults to true.") | |
170 | COMMON_FLAG(bool, symbolize_vs_style, false, | |
171 | "Print file locations in Visual Studio style (e.g: " | |
172 | " file(10,42): ...") | |
10189819 MO |
173 | COMMON_FLAG(int, dedup_token_length, 0, |
174 | "If positive, after printing a stack trace also print a short " | |
175 | "string token based on this number of frames that will simplify " | |
176 | "deduplication of the reports. " | |
177 | "Example: 'DEDUP_TOKEN: foo-bar-main'. Default is 0.") | |
696d846a MO |
178 | COMMON_FLAG(const char *, stack_trace_format, "DEFAULT", |
179 | "Format string used to render stack frames. " | |
180 | "See sanitizer_stacktrace_printer.h for the format description. " | |
181 | "Use DEFAULT to get default format.") | |
182 | COMMON_FLAG(bool, no_huge_pages_for_shadow, true, | |
183 | "If true, the shadow is not allowed to use huge pages. ") | |
184 | COMMON_FLAG(bool, strict_string_checks, false, | |
185 | "If set check that string arguments are properly null-terminated") | |
186 | COMMON_FLAG(bool, intercept_strstr, true, | |
187 | "If set, uses custom wrappers for strstr and strcasestr functions " | |
188 | "to find more errors.") | |
189 | COMMON_FLAG(bool, intercept_strspn, true, | |
190 | "If set, uses custom wrappers for strspn and strcspn function " | |
191 | "to find more errors.") | |
5d3805fc JJ |
192 | COMMON_FLAG(bool, intercept_strtok, true, |
193 | "If set, uses a custom wrapper for the strtok function " | |
194 | "to find more errors.") | |
696d846a MO |
195 | COMMON_FLAG(bool, intercept_strpbrk, true, |
196 | "If set, uses custom wrappers for strpbrk function " | |
197 | "to find more errors.") | |
10189819 MO |
198 | COMMON_FLAG(bool, intercept_strlen, true, |
199 | "If set, uses custom wrappers for strlen and strnlen functions " | |
200 | "to find more errors.") | |
5d3805fc JJ |
201 | COMMON_FLAG(bool, intercept_strndup, true, |
202 | "If set, uses custom wrappers for strndup functions " | |
203 | "to find more errors.") | |
10189819 MO |
204 | COMMON_FLAG(bool, intercept_strchr, true, |
205 | "If set, uses custom wrappers for strchr, strchrnul, and strrchr " | |
206 | "functions to find more errors.") | |
696d846a MO |
207 | COMMON_FLAG(bool, intercept_memcmp, true, |
208 | "If set, uses custom wrappers for memcmp function " | |
209 | "to find more errors.") | |
210 | COMMON_FLAG(bool, strict_memcmp, true, | |
211 | "If true, assume that memcmp(p1, p2, n) always reads n bytes before " | |
212 | "comparing p1 and p2.") | |
10189819 MO |
213 | COMMON_FLAG(bool, intercept_memmem, true, |
214 | "If set, uses a wrapper for memmem() to find more errors.") | |
215 | COMMON_FLAG(bool, intercept_intrin, true, | |
216 | "If set, uses custom wrappers for memset/memcpy/memmove " | |
217 | "intrinsics to find more errors.") | |
218 | COMMON_FLAG(bool, intercept_stat, true, | |
219 | "If set, uses custom wrappers for *stat functions " | |
220 | "to find more errors.") | |
221 | COMMON_FLAG(bool, intercept_send, true, | |
222 | "If set, uses custom wrappers for send* functions " | |
223 | "to find more errors.") | |
b667dd70 ML |
224 | COMMON_FLAG(bool, decorate_proc_maps, (bool)SANITIZER_ANDROID, |
225 | "If set, decorate sanitizer mappings in /proc/self/maps with " | |
226 | "user-readable names") | |
696d846a MO |
227 | COMMON_FLAG(int, exitcode, 1, "Override the program exit status if the tool " |
228 | "found an error") | |
229 | COMMON_FLAG( | |
eac97531 | 230 | bool, abort_on_error, (bool)SANITIZER_ANDROID || (bool)SANITIZER_MAC, |
696d846a MO |
231 | "If set, the tool calls abort() instead of _exit() after printing the " |
232 | "error report.") | |
10189819 MO |
233 | COMMON_FLAG(bool, suppress_equal_pcs, true, |
234 | "Deduplicate multiple reports for single source location in " | |
235 | "halt_on_error=false mode (asan only).") | |
236 | COMMON_FLAG(bool, print_cmdline, false, "Print command line on crash " | |
237 | "(asan only).") | |
238 | COMMON_FLAG(bool, html_cov_report, false, "Generate html coverage report.") | |
239 | COMMON_FLAG(const char *, sancov_path, "sancov", "Sancov tool location.") | |
5d3805fc JJ |
240 | COMMON_FLAG(bool, dump_instruction_bytes, false, |
241 | "If true, dump 16 bytes starting at the instruction that caused SEGV") | |
242 | COMMON_FLAG(bool, dump_registers, true, | |
243 | "If true, dump values of CPU registers when SEGV happens. Only " | |
244 | "available on OS X for now.") | |
eac97531 ML |
245 | COMMON_FLAG(bool, detect_write_exec, false, |
246 | "If true, triggers warning when writable-executable pages requests " | |
247 | "are being made") | |
b667dd70 ML |
248 | COMMON_FLAG(bool, test_only_emulate_no_memorymap, false, |
249 | "TEST ONLY fail to read memory mappings to emulate sanitized " | |
250 | "\"init\"") |