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