libsanitizer/asan/asan_flags.inc

   1 //===-- asan_flags.inc ------------------------------------------*- 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 // ASan runtime flags.
   9 //
  10 //===----------------------------------------------------------------------===//
  11 #ifndef ASAN_FLAG
  12 # error "Define ASAN_FLAG prior to including this file!"
  13 #endif
  14
  15 // ASAN_FLAG(Type, Name, DefaultValue, Description)
  16 // See COMMON_FLAG in sanitizer_flags.inc for more details.
  17
  18 ASAN_FLAG(int, quarantine_size, -1,
  19             "Deprecated, please use quarantine_size_mb.")
  20 ASAN_FLAG(int, quarantine_size_mb, -1,
  21           "Size (in Mb) of quarantine used to detect use-after-free "
  22           "errors. Lower value may reduce memory usage but increase the "
  23           "chance of false negatives.")
  24 ASAN_FLAG(int, redzone, 16,
  25           "Minimal size (in bytes) of redzones around heap objects. "
  26           "Requirement: redzone >= 16, is a power of two.")
  27 ASAN_FLAG(int, max_redzone, 2048,
  28           "Maximal size (in bytes) of redzones around heap objects.")
  29 ASAN_FLAG(
  30     bool, debug, false,
  31     "If set, prints some debugging information and does additional checks.")
  32 ASAN_FLAG(
  33     int, report_globals, 1,
  34     "Controls the way to handle globals (0 - don't detect buffer overflow on "
  35     "globals, 1 - detect buffer overflow, 2 - print data about registered "
  36     "globals).")
  37 ASAN_FLAG(bool, check_initialization_order, false,
  38           "If set, attempts to catch initialization order issues.")
  39 ASAN_FLAG(
  40     bool, replace_str, true,
  41     "If set, uses custom wrappers and replacements for libc string functions "
  42     "to find more errors.")
  43 ASAN_FLAG(bool, replace_intrin, true,
  44           "If set, uses custom wrappers for memset/memcpy/memmove intrinsics.")
  45 ASAN_FLAG(bool, detect_stack_use_after_return, false,
  46           "Enables stack-use-after-return checking at run-time.")
  47 ASAN_FLAG(int, min_uar_stack_size_log, 16, // We can't do smaller anyway.
  48           "Minimum fake stack size log.")
  49 ASAN_FLAG(int, max_uar_stack_size_log,
  50           20, // 1Mb per size class, i.e. ~11Mb per thread
  51           "Maximum fake stack size log.")
  52 ASAN_FLAG(bool, uar_noreserve, false,
  53           "Use mmap with 'noreserve' flag to allocate fake stack.")
  54 ASAN_FLAG(
  55     int, max_malloc_fill_size, 0x1000,  // By default, fill only the first 4K.
  56     "ASan allocator flag. max_malloc_fill_size is the maximal amount of "
  57     "bytes that will be filled with malloc_fill_byte on malloc.")
  58 ASAN_FLAG(int, malloc_fill_byte, 0xbe,
  59           "Value used to fill the newly allocated memory.")
  60 ASAN_FLAG(bool, allow_user_poisoning, true,
  61           "If set, user may manually mark memory regions as poisoned or "
  62           "unpoisoned.")
  63 ASAN_FLAG(
  64     int, sleep_before_dying, 0,
  65     "Number of seconds to sleep between printing an error report and "
  66     "terminating the program. Useful for debugging purposes (e.g. when one "
  67     "needs to attach gdb).")
  68 ASAN_FLAG(bool, check_malloc_usable_size, true,
  69           "Allows the users to work around the bug in Nvidia drivers prior to "
  70           "295.*.")
  71 ASAN_FLAG(bool, unmap_shadow_on_exit, false,
  72           "If set, explicitly unmaps the (huge) shadow at exit.")
  73 ASAN_FLAG(bool, protect_shadow_gap, true, "If set, mprotect the shadow gap")
  74 ASAN_FLAG(bool, print_stats, false,
  75           "Print various statistics after printing an error message or if "
  76           "atexit=1.")
  77 ASAN_FLAG(bool, print_legend, true, "Print the legend for the shadow bytes.")
  78 ASAN_FLAG(bool, print_scariness, false,
  79           "Print the scariness score. Experimental.")
  80 ASAN_FLAG(bool, atexit, false,
  81           "If set, prints ASan exit stats even after program terminates "
  82           "successfully.")
  83 ASAN_FLAG(
  84     bool, print_full_thread_history, true,
  85     "If set, prints thread creation stacks for the threads involved in the "
  86     "report and their ancestors up to the main thread.")
  87 ASAN_FLAG(
  88     bool, poison_heap, true,
  89     "Poison (or not) the heap memory on [de]allocation. Zero value is useful "
  90     "for benchmarking the allocator or instrumentator.")
  91 ASAN_FLAG(bool, poison_partial, true,
  92           "If true, poison partially addressable 8-byte aligned words "
  93           "(default=true). This flag affects heap and global buffers, but not "
  94           "stack buffers.")
  95 ASAN_FLAG(bool, poison_array_cookie, true,
  96           "Poison (or not) the array cookie after operator new[].")
  97
  98 // Turn off alloc/dealloc mismatch checker on Mac and Windows for now.
  99 // https://github.com/google/sanitizers/issues/131
 100 // https://github.com/google/sanitizers/issues/309
 101 // TODO(glider,timurrrr): Fix known issues and enable this back.
 102 ASAN_FLAG(bool, alloc_dealloc_mismatch,
 103           !SANITIZER_MAC && !SANITIZER_WINDOWS && !SANITIZER_ANDROID,
 104           "Report errors on malloc/delete, new/free, new/delete[], etc.")
 105
 106 ASAN_FLAG(bool, new_delete_type_mismatch, true,
 107           "Report errors on mismatch between size of new and delete.")
 108 ASAN_FLAG(
 109     bool, strict_init_order, false,
 110     "If true, assume that dynamic initializers can never access globals from "
 111     "other modules, even if the latter are already initialized.")
 112 ASAN_FLAG(
 113     bool, start_deactivated, false,
 114     "If true, ASan tweaks a bunch of other flags (quarantine, redzone, heap "
 115     "poisoning) to reduce memory consumption as much as possible, and "
 116     "restores them to original values when the first instrumented module is "
 117     "loaded into the process. This is mainly intended to be used on "
 118     "Android. ")
 119 ASAN_FLAG(
 120     int, detect_invalid_pointer_pairs, 0,
 121     "If non-zero, try to detect operations like <, <=, >, >= and - on "
 122     "invalid pointer pairs (e.g. when pointers belong to different objects). "
 123     "The bigger the value the harder we try.")
 124 ASAN_FLAG(
 125     bool, detect_container_overflow, true,
 126     "If true, honor the container overflow annotations. See "
 127     "https://github.com/google/sanitizers/wiki/AddressSanitizerContainerOverflow")
 128 ASAN_FLAG(int, detect_odr_violation, 2,
 129           "If >=2, detect violation of One-Definition-Rule (ODR); "
 130           "If ==1, detect ODR-violation only if the two variables "
 131           "have different sizes")
 132 ASAN_FLAG(bool, dump_instruction_bytes, false,
 133           "If true, dump 16 bytes starting at the instruction that caused SEGV")
 134 ASAN_FLAG(const char *, suppressions, "", "Suppressions file name.")
 135 ASAN_FLAG(bool, halt_on_error, true,
 136           "Crash the program after printing the first error report "
 137           "(WARNING: USE AT YOUR OWN RISK!)")
 138 ASAN_FLAG(bool, use_odr_indicator, false,
 139           "Use special ODR indicator symbol for ODR violation detection")