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