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