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