1//===-- sanitizer_flags.h ---------------------------------------*- C++ -*-===//
2//
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
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
22COMMON_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.")
26COMMON_FLAG(
27 const char *, external_symbolizer_path, nullptr,
28 "Path to external symbolizer. If empty, the tool will search $PATH for "
29 "the symbolizer.")
30COMMON_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.")
35COMMON_FLAG(const char *, strip_path_prefix, "",
36 "Strips this prefix from file paths in error reports.")
37COMMON_FLAG(bool, fast_unwind_on_check, false,
38 "If available, use the fast frame-pointer-based unwinder on "
39 "internal CHECK failures.")
40COMMON_FLAG(bool, fast_unwind_on_fatal, false,
41 "If available, use the fast frame-pointer-based unwinder on fatal "
42 "errors.")
43// ARM thumb/thumb2 frame pointer is inconsistent on GCC and Clang [1]
44// and fast-unwider is also unreliable with mixing arm and thumb code [2].
45// [1] https://gcc.gnu.org/bugzilla/show_bug.cgi?id=92172
46// [2] https://bugs.llvm.org/show_bug.cgi?id=44158
47COMMON_FLAG(bool, fast_unwind_on_malloc,
48 !(SANITIZER_LINUX && !SANITIZER_ANDROID && SANITIZER_ARM),
49 "If available, use the fast frame-pointer-based unwinder on "
50 "malloc/free.")
51COMMON_FLAG(bool, handle_ioctl, false, "Intercept and handle ioctl requests.")
52COMMON_FLAG(int, malloc_context_size, 1,
53 "Max number of stack frames kept for each allocation/deallocation.")
54COMMON_FLAG(
55 const char *, log_path, nullptr,
56 "Write logs to \"log_path.pid\". The special values are \"stdout\" and "
57 "\"stderr\". If unspecified, defaults to \"stderr\".")
58COMMON_FLAG(
59 bool, log_exe_name, false,
60 "Mention name of executable when reporting error and "
61 "append executable name to logs (as in \"log_path.exe_name.pid\").")
62COMMON_FLAG(const char *, log_suffix, nullptr,
63 "String to append to log file name, e.g. \".txt\".")
64COMMON_FLAG(
65 bool, log_to_syslog, (bool)SANITIZER_ANDROID || (bool)SANITIZER_APPLE,
66 "Write all sanitizer output to syslog in addition to other means of "
67 "logging.")
68COMMON_FLAG(bool, log_fallback_to_stderr, false,
69 "When set, fallback to stderr if we are unable to open log path.")
70COMMON_FLAG(
71 int, verbosity, 0,
72 "Verbosity level (0 - silent, 1 - a bit of output, 2+ - more output).")
73COMMON_FLAG(bool, strip_env, true,
74 "Whether to remove the sanitizer from DYLD_INSERT_LIBRARIES to "
75 "avoid passing it to children on Apple platforms. Default is true.")
76COMMON_FLAG(bool, verify_interceptors, true,
77 "Verify that interceptors are working on Apple platforms. Default "
78 "is true.")
79COMMON_FLAG(bool, detect_leaks, !SANITIZER_APPLE, "Enable memory leak detection.")
80COMMON_FLAG(
81 bool, leak_check_at_exit, true,
82 "Invoke leak checking in an atexit handler. Has no effect if "
83 "detect_leaks=false, or if __lsan_do_leak_check() is called before the "
84 "handler has a chance to run.")
85COMMON_FLAG(bool, allocator_may_return_null, false,
86 "If false, the allocator will crash instead of returning 0 on "
87 "out-of-memory.")
88COMMON_FLAG(bool, print_summary, true,
89 "If false, disable printing error summaries in addition to error "
90 "reports.")
91COMMON_FLAG(int, print_module_map, 0,
92 "Print the process module map where supported (0 - don't print, "
93 "1 - print only once before process exits, 2 - print after each "
94 "report).")
95COMMON_FLAG(bool, check_printf, true, "Check printf arguments.")
96#define COMMON_FLAG_HANDLE_SIGNAL_HELP(signal) \
97 "Controls custom tool's " #signal " handler (0 - do not registers the " \
98 "handler, 1 - register the handler and allow user to set own, " \
99 "2 - registers the handler and block user from changing it). "
100COMMON_FLAG(HandleSignalMode, handle_segv, kHandleSignalYes,
101 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGSEGV))
102COMMON_FLAG(HandleSignalMode, handle_sigbus, kHandleSignalYes,
103 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGBUS))
104COMMON_FLAG(HandleSignalMode, handle_abort, kHandleSignalNo,
105 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGABRT))
106COMMON_FLAG(HandleSignalMode, handle_sigill, kHandleSignalNo,
107 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGILL))
108COMMON_FLAG(HandleSignalMode, handle_sigtrap, kHandleSignalNo,
109 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGTRAP))
110COMMON_FLAG(HandleSignalMode, handle_sigfpe, kHandleSignalYes,
111 COMMON_FLAG_HANDLE_SIGNAL_HELP(SIGFPE))
112#undef COMMON_FLAG_HANDLE_SIGNAL_HELP
113COMMON_FLAG(bool, allow_user_segv_handler, true,
114 "Deprecated. True has no effect, use handle_sigbus=1. If false, "
115 "handle_*=1 will be upgraded to handle_*=2.")
116COMMON_FLAG(bool, cloak_sanitizer_signal_handlers, false,
117 "If set, signal/sigaction will pretend that sanitizers did not "
118 "preinstall any signal handlers. If the user subsequently installs "
119 "a signal handler, this will disable cloaking for the respective "
120 "signal.")
121COMMON_FLAG(bool, use_sigaltstack, true,
122 "If set, uses alternate stack for signal handling.")
123COMMON_FLAG(bool, detect_deadlocks, true,
124 "If set, deadlock detection is enabled.")
125COMMON_FLAG(
126 uptr, clear_shadow_mmap_threshold, 64 * 1024,
127 "Large shadow regions are zero-filled using mmap(NORESERVE) instead of "
128 "memset(). This is the threshold size in bytes.")
129COMMON_FLAG(const char *, color, "auto",
130 "Colorize reports: (always|never|auto).")
131COMMON_FLAG(
132 bool, legacy_pthread_cond, false,
133 "Enables support for dynamic libraries linked with libpthread 2.2.5.")
134COMMON_FLAG(bool, intercept_tls_get_addr, false, "Intercept __tls_get_addr.")
135COMMON_FLAG(bool, help, false, "Print the flag descriptions.")
136COMMON_FLAG(uptr, mmap_limit_mb, 0,
137 "Limit the amount of mmap-ed memory (excluding shadow) in Mb; "
138 "not a user-facing flag, used mosly for testing the tools")
139COMMON_FLAG(uptr, hard_rss_limit_mb, 0,
140 "Hard RSS limit in Mb."
141 " If non-zero, a background thread is spawned at startup"
142 " which periodically reads RSS and aborts the process if the"
143 " limit is reached")
144COMMON_FLAG(uptr, soft_rss_limit_mb, 0,
145 "Soft RSS limit in Mb."
146 " If non-zero, a background thread is spawned at startup"
147 " which periodically reads RSS. If the limit is reached"
148 " all subsequent malloc/new calls will fail or return NULL"
149 " (depending on the value of allocator_may_return_null)"
150 " until the RSS goes below the soft limit."
151 " This limit does not affect memory allocations other than"
152 " malloc/new.")
153COMMON_FLAG(uptr, max_allocation_size_mb, 0,
154 "If non-zero, malloc/new calls larger than this size will return "
155 "nullptr (or crash if allocator_may_return_null=false).")
156COMMON_FLAG(bool, heap_profile, false, "Experimental heap profiler, asan-only")
157COMMON_FLAG(s32, allocator_release_to_os_interval_ms,
158 ((bool)SANITIZER_FUCHSIA || (bool)SANITIZER_WINDOWS) ? -1 : 5000,
159 "Only affects a 64-bit allocator. If set, tries to release unused "
160 "memory to the OS, but not more often than this interval (in "
161 "milliseconds). Negative values mean do not attempt to release "
162 "memory to the OS.\n")
163COMMON_FLAG(bool, can_use_proc_maps_statm, true,
164 "If false, do not attempt to read /proc/maps/statm."
165 " Mostly useful for testing sanitizers.")
166COMMON_FLAG(
167 bool, coverage, false,
168 "If set, coverage information will be dumped at program shutdown (if the "
169 "coverage instrumentation was enabled at compile time).")
170COMMON_FLAG(const char *, coverage_dir, ".",
171 "Target directory for coverage dumps. Defaults to the current "
172 "directory.")
173COMMON_FLAG(const char *, cov_8bit_counters_out, "",
174 "If non-empty, write 8bit counters to this file. ")
175COMMON_FLAG(const char *, cov_pcs_out, "",
176 "If non-empty, write the coverage pc table to this file. ")
177COMMON_FLAG(bool, full_address_space, false,
178 "Sanitize complete address space; "
179 "by default kernel area on 32-bit platforms will not be sanitized")
180COMMON_FLAG(bool, print_suppressions, true,
181 "Print matched suppressions at exit.")
182COMMON_FLAG(
183 bool, disable_coredump, (SANITIZER_WORDSIZE == 64) && !SANITIZER_GO,
184 "Disable core dumping. By default, disable_coredump=1 on 64-bit to avoid"
185 " dumping a 16T+ core file. Ignored on OSes that don't dump core by"
186 " default and for sanitizers that don't reserve lots of virtual memory.")
187COMMON_FLAG(bool, use_madv_dontdump, true,
188 "If set, instructs kernel to not store the (huge) shadow "
189 "in core file.")
190COMMON_FLAG(bool, symbolize_inline_frames, true,
191 "Print inlined frames in stacktraces. Defaults to true.")
192COMMON_FLAG(bool, demangle, true, "Print demangled symbols.")
193COMMON_FLAG(bool, symbolize_vs_style, false,
194 "Print file locations in Visual Studio style (e.g: "
195 " file(10,42): ...")
196COMMON_FLAG(int, dedup_token_length, 0,
197 "If positive, after printing a stack trace also print a short "
198 "string token based on this number of frames that will simplify "
199 "deduplication of the reports. "
200 "Example: 'DEDUP_TOKEN: foo-bar-main'. Default is 0.")
201COMMON_FLAG(const char *, stack_trace_format, "DEFAULT",
202 "Format string used to render stack frames. "
203 "See sanitizer_stacktrace_printer.h for the format description. "
204 "Use DEFAULT to get default format.")
205COMMON_FLAG(int, compress_stack_depot, 0,
206 "Compress stack depot to save memory.")
207COMMON_FLAG(bool, no_huge_pages_for_shadow, true,
208 "If true, the shadow is not allowed to use huge pages. ")
209COMMON_FLAG(bool, strict_string_checks, false,
210 "If set check that string arguments are properly null-terminated")
211COMMON_FLAG(bool, intercept_strstr, true,
212 "If set, uses custom wrappers for strstr and strcasestr functions "
213 "to find more errors.")
214COMMON_FLAG(bool, intercept_strspn, true,
215 "If set, uses custom wrappers for strspn and strcspn function "
216 "to find more errors.")
217COMMON_FLAG(bool, intercept_strtok, true,
218 "If set, uses a custom wrapper for the strtok function "
219 "to find more errors.")
220COMMON_FLAG(bool, intercept_strpbrk, true,
221 "If set, uses custom wrappers for strpbrk function "
222 "to find more errors.")
223COMMON_FLAG(
224 bool, intercept_strcmp, true,
225 "If set, uses custom wrappers for strcmp functions to find more errors.")
226COMMON_FLAG(bool, intercept_strlen, true,
227 "If set, uses custom wrappers for strlen and strnlen functions "
228 "to find more errors.")
229COMMON_FLAG(bool, intercept_strndup, true,
230 "If set, uses custom wrappers for strndup functions "
231 "to find more errors.")
232COMMON_FLAG(bool, intercept_strchr, true,
233 "If set, uses custom wrappers for strchr, strchrnul, and strrchr "
234 "functions to find more errors.")
235COMMON_FLAG(bool, intercept_memcmp, true,
236 "If set, uses custom wrappers for memcmp function "
237 "to find more errors.")
238COMMON_FLAG(bool, strict_memcmp, true,
239 "If true, assume that memcmp(p1, p2, n) always reads n bytes before "
240 "comparing p1 and p2.")
241COMMON_FLAG(bool, intercept_memmem, true,
242 "If set, uses a wrapper for memmem() to find more errors.")
243COMMON_FLAG(bool, intercept_intrin, true,
244 "If set, uses custom wrappers for memset/memcpy/memmove "
245 "intrinsics to find more errors.")
246COMMON_FLAG(bool, intercept_stat, true,
247 "If set, uses custom wrappers for *stat functions "
248 "to find more errors.")
249COMMON_FLAG(bool, intercept_send, true,
250 "If set, uses custom wrappers for send* functions "
251 "to find more errors.")
252COMMON_FLAG(bool, decorate_proc_maps, (bool)SANITIZER_ANDROID,
253 "If set, decorate sanitizer mappings in /proc/self/maps with "
254 "user-readable names")
255COMMON_FLAG(int, exitcode, 1, "Override the program exit status if the tool "
256 "found an error")
257COMMON_FLAG(
258 bool, abort_on_error, (bool)SANITIZER_ANDROID || (bool)SANITIZER_APPLE,
259 "If set, the tool calls abort() instead of _exit() after printing the "
260 "error report.")
261COMMON_FLAG(bool, suppress_equal_pcs, true,
262 "Deduplicate multiple reports for single source location in "
263 "halt_on_error=false mode (asan only).")
264COMMON_FLAG(bool, print_cmdline, false, "Print command line on crash "
265 "(asan only).")
266COMMON_FLAG(bool, html_cov_report, false, "Generate html coverage report.")
267COMMON_FLAG(const char *, sancov_path, "sancov", "Sancov tool location.")
268COMMON_FLAG(bool, dump_instruction_bytes, false,
269 "If true, dump 16 bytes starting at the instruction that caused SEGV")
270COMMON_FLAG(bool, dump_registers, true,
271 "If true, dump values of CPU registers when SEGV happens. Only "
272 "available on OS X for now.")
273COMMON_FLAG(bool, detect_write_exec, false,
274 "If true, triggers warning when writable-executable pages requests "
275 "are being made")
276COMMON_FLAG(bool, test_only_emulate_no_memorymap, false,
277 "TEST ONLY fail to read memory mappings to emulate sanitized "
278 "\"init\"")
279// With static linking, dladdr((void*)pthread_join) or similar will return the
280// path to the main program. This flag will replace dlopen(<main program,...>
281// with dlopen(NULL,...), which is the correct way to get a handle to the main
282// program.
283COMMON_FLAG(bool, test_only_replace_dlopen_main_program, false,
284 "TEST ONLY replace dlopen(<main program>,...) with dlopen(NULL)")
285
286COMMON_FLAG(bool, enable_symbolizer_markup, SANITIZER_FUCHSIA,
287 "Use sanitizer symbolizer markup, available on Linux "
288 "and always set true for Fuchsia.")
289
290COMMON_FLAG(bool, detect_invalid_join, true,
291 "If set, check invalid joins of threads.")
292