contrib/compiler-rt/lib/asan/asan_flags.inc

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