libsanitizer/sanitizer_common/sanitizer_flags.inc

   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
  21 COMMON_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.")
  25 COMMON_FLAG(
  26     const char *, external_symbolizer_path, nullptr,
  27     "Path to external symbolizer. If empty, the tool will search $PATH for "
  28     "the symbolizer.")
  29 COMMON_FLAG(
  30     bool, allow_addr2line, false,
  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.")
  34 COMMON_FLAG(const char *, strip_path_prefix, "",
  35             "Strips this prefix from file paths in error reports.")
  36 COMMON_FLAG(bool, fast_unwind_on_check, false,
  37             "If available, use the fast frame-pointer-based unwinder on "
  38             "internal CHECK failures.")
  39 COMMON_FLAG(bool, fast_unwind_on_fatal, false,
  40             "If available, use the fast frame-pointer-based unwinder on fatal "
  41             "errors.")
  42 COMMON_FLAG(bool, fast_unwind_on_malloc, true,
  43             "If available, use the fast frame-pointer-based unwinder on "
  44             "malloc/free.")
  45 COMMON_FLAG(bool, handle_ioctl, false, "Intercept and handle ioctl requests.")
  46 COMMON_FLAG(int, malloc_context_size, 1,
  47             "Max number of stack frames kept for each allocation/deallocation.")
  48 COMMON_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\".")
  52 COMMON_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\").")
  56 COMMON_FLAG(
  57     bool, log_to_syslog, SANITIZER_ANDROID || SANITIZER_MAC,
  58     "Write all sanitizer output to syslog in addition to other means of "
  59     "logging.")
  60 COMMON_FLAG(
  61     int, verbosity, 0,
  62     "Verbosity level (0 - silent, 1 - a bit of output, 2+ - more output).")
  63 COMMON_FLAG(bool, detect_leaks, (SANITIZER_WORDSIZE == 64),
  64             "Enable memory leak detection.")
  65 COMMON_FLAG(
  66     bool, leak_check_at_exit, true,
  67     "Invoke leak checking in an atexit handler. Has no effect if "
  68     "detect_leaks=false, or if __lsan_do_leak_check() is called before the "
  69     "handler has a chance to run.")
  70 COMMON_FLAG(bool, allocator_may_return_null, false,
  71             "If false, the allocator will crash instead of returning 0 on "
  72             "out-of-memory.")
  73 COMMON_FLAG(bool, print_summary, true,
  74             "If false, disable printing error summaries in addition to error "
  75             "reports.")
  76 COMMON_FLAG(bool, check_printf, true, "Check printf arguments.")
  77 COMMON_FLAG(bool, handle_segv, true,
  78             "If set, registers the tool's custom SIGSEGV/SIGBUS handler.")
  79 COMMON_FLAG(bool, handle_abort, false,
  80             "If set, registers the tool's custom SIGABRT handler.")
  81 COMMON_FLAG(bool, handle_sigill, false,
  82             "If set, registers the tool's custom SIGILL handler.")
  83 COMMON_FLAG(bool, handle_sigfpe, true,
  84             "If set, registers the tool's custom SIGFPE handler.")
  85 COMMON_FLAG(bool, allow_user_segv_handler, false,
  86             "If set, allows user to register a SEGV handler even if the tool "
  87             "registers one.")
  88 COMMON_FLAG(bool, use_sigaltstack, true,
  89             "If set, uses alternate stack for signal handling.")
  90 COMMON_FLAG(bool, detect_deadlocks, false,
  91             "If set, deadlock detection is enabled.")
  92 COMMON_FLAG(
  93     uptr, clear_shadow_mmap_threshold, 64 * 1024,
  94     "Large shadow regions are zero-filled using mmap(NORESERVE) instead of "
  95     "memset(). This is the threshold size in bytes.")
  96 COMMON_FLAG(const char *, color, "auto",
  97             "Colorize reports: (always|never|auto).")
  98 COMMON_FLAG(
  99     bool, legacy_pthread_cond, false,
 100     "Enables support for dynamic libraries linked with libpthread 2.2.5.")
 101 COMMON_FLAG(bool, intercept_tls_get_addr, false, "Intercept __tls_get_addr.")
 102 COMMON_FLAG(bool, help, false, "Print the flag descriptions.")
 103 COMMON_FLAG(uptr, mmap_limit_mb, 0,
 104             "Limit the amount of mmap-ed memory (excluding shadow) in Mb; "
 105             "not a user-facing flag, used mosly for testing the tools")
 106 COMMON_FLAG(uptr, hard_rss_limit_mb, 0,
 107             "Hard RSS limit in Mb."
 108             " If non-zero, a background thread is spawned at startup"
 109             " which periodically reads RSS and aborts the process if the"
 110             " limit is reached")
 111 COMMON_FLAG(uptr, soft_rss_limit_mb, 0,
 112             "Soft RSS limit in Mb."
 113             " If non-zero, a background thread is spawned at startup"
 114             " which periodically reads RSS. If the limit is reached"
 115             " all subsequent malloc/new calls will fail or return NULL"
 116             " (depending on the value of allocator_may_return_null)"
 117             " until the RSS goes below the soft limit."
 118             " This limit does not affect memory allocations other than"
 119             " malloc/new.")
 120 COMMON_FLAG(bool, heap_profile, false, "Experimental heap profiler, asan-only")
 121 COMMON_FLAG(bool, allocator_release_to_os, false,
 122             "Experimental. If true, try to periodically release unused"
 123             " memory to the OS.\n")
 124 COMMON_FLAG(bool, can_use_proc_maps_statm, true,
 125             "If false, do not attempt to read /proc/maps/statm."
 126             " Mostly useful for testing sanitizers.")
 127 COMMON_FLAG(
 128     bool, coverage, false,
 129     "If set, coverage information will be dumped at program shutdown (if the "
 130     "coverage instrumentation was enabled at compile time).")
 131 COMMON_FLAG(bool, coverage_pcs, true,
 132             "If set (and if 'coverage' is set too), the coverage information "
 133             "will be dumped as a set of PC offsets for every module.")
 134 COMMON_FLAG(bool, coverage_order_pcs, false,
 135              "If true, the PCs will be dumped in the order they've"
 136              " appeared during the execution.")
 137 COMMON_FLAG(bool, coverage_bitset, false,
 138             "If set (and if 'coverage' is set too), the coverage information "
 139             "will also be dumped as a bitset to a separate file.")
 140 COMMON_FLAG(bool, coverage_counters, false,
 141             "If set (and if 'coverage' is set too), the bitmap that corresponds"
 142             " to coverage counters will be dumped.")
 143 COMMON_FLAG(bool, coverage_direct, SANITIZER_ANDROID,
 144             "If set, coverage information will be dumped directly to a memory "
 145             "mapped file. This way data is not lost even if the process is "
 146             "suddenly killed.")
 147 COMMON_FLAG(const char *, coverage_dir, ".",
 148             "Target directory for coverage dumps. Defaults to the current "
 149             "directory.")
 150 COMMON_FLAG(bool, full_address_space, false,
 151             "Sanitize complete address space; "
 152             "by default kernel area on 32-bit platforms will not be sanitized")
 153 COMMON_FLAG(bool, print_suppressions, true,
 154             "Print matched suppressions at exit.")
 155 COMMON_FLAG(
 156     bool, disable_coredump, (SANITIZER_WORDSIZE == 64) && !SANITIZER_GO,
 157     "Disable core dumping. By default, disable_coredump=1 on 64-bit to avoid"
 158     " dumping a 16T+ core file. Ignored on OSes that don't dump core by"
 159     " default and for sanitizers that don't reserve lots of virtual memory.")
 160 COMMON_FLAG(bool, use_madv_dontdump, true,
 161           "If set, instructs kernel to not store the (huge) shadow "
 162           "in core file.")
 163 COMMON_FLAG(bool, symbolize_inline_frames, true,
 164             "Print inlined frames in stacktraces. Defaults to true.")
 165 COMMON_FLAG(bool, symbolize_vs_style, false,
 166             "Print file locations in Visual Studio style (e.g: "
 167             " file(10,42): ...")
 168 COMMON_FLAG(int, dedup_token_length, 0,
 169             "If positive, after printing a stack trace also print a short "
 170             "string token based on this number of frames that will simplify "
 171             "deduplication of the reports. "
 172             "Example: 'DEDUP_TOKEN: foo-bar-main'. Default is 0.")
 173 COMMON_FLAG(const char *, stack_trace_format, "DEFAULT",
 174             "Format string used to render stack frames. "
 175             "See sanitizer_stacktrace_printer.h for the format description. "
 176             "Use DEFAULT to get default format.")
 177 COMMON_FLAG(bool, no_huge_pages_for_shadow, true,
 178             "If true, the shadow is not allowed to use huge pages. ")
 179 COMMON_FLAG(bool, strict_string_checks, false,
 180             "If set check that string arguments are properly null-terminated")
 181 COMMON_FLAG(bool, intercept_strstr, true,
 182             "If set, uses custom wrappers for strstr and strcasestr functions "
 183             "to find more errors.")
 184 COMMON_FLAG(bool, intercept_strspn, true,
 185             "If set, uses custom wrappers for strspn and strcspn function "
 186             "to find more errors.")
 187 COMMON_FLAG(bool, intercept_strpbrk, true,
 188             "If set, uses custom wrappers for strpbrk function "
 189             "to find more errors.")
 190 COMMON_FLAG(bool, intercept_strlen, true,
 191             "If set, uses custom wrappers for strlen and strnlen functions "
 192             "to find more errors.")
 193 COMMON_FLAG(bool, intercept_strchr, true,
 194             "If set, uses custom wrappers for strchr, strchrnul, and strrchr "
 195             "functions to find more errors.")
 196 COMMON_FLAG(bool, intercept_memcmp, true,
 197             "If set, uses custom wrappers for memcmp function "
 198             "to find more errors.")
 199 COMMON_FLAG(bool, strict_memcmp, true,
 200           "If true, assume that memcmp(p1, p2, n) always reads n bytes before "
 201           "comparing p1 and p2.")
 202 COMMON_FLAG(bool, intercept_memmem, true,
 203             "If set, uses a wrapper for memmem() to find more errors.")
 204 COMMON_FLAG(bool, intercept_intrin, true,
 205             "If set, uses custom wrappers for memset/memcpy/memmove "
 206             "intrinsics to find more errors.")
 207 COMMON_FLAG(bool, intercept_stat, true,
 208             "If set, uses custom wrappers for *stat functions "
 209             "to find more errors.")
 210 COMMON_FLAG(bool, intercept_send, true,
 211             "If set, uses custom wrappers for send* functions "
 212             "to find more errors.")
 213 COMMON_FLAG(bool, decorate_proc_maps, false, "If set, decorate sanitizer "
 214                                              "mappings in /proc/self/maps with "
 215                                              "user-readable names")
 216 COMMON_FLAG(int, exitcode, 1, "Override the program exit status if the tool "
 217                               "found an error")
 218 COMMON_FLAG(
 219     bool, abort_on_error, SANITIZER_ANDROID || SANITIZER_MAC,
 220     "If set, the tool calls abort() instead of _exit() after printing the "
 221     "error report.")
 222 COMMON_FLAG(bool, suppress_equal_pcs, true,
 223             "Deduplicate multiple reports for single source location in "
 224             "halt_on_error=false mode (asan only).")
 225 COMMON_FLAG(bool, print_cmdline, false, "Print command line on crash "
 226             "(asan, ubsan and lsan only).")
 227 COMMON_FLAG(bool, html_cov_report, false, "Generate html coverage report.")
 228 COMMON_FLAG(const char *, sancov_path, "sancov", "Sancov tool location.")