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