asan_flags.h revision dbd69cc9ccda50efd0305cd0ce9bad50defe4b42 
1//===-- asan_flags.h -------------------------------------------*- 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// This file is a part of AddressSanitizer, an address sanity checker.
11//
12// ASan runtime flags.
13//===----------------------------------------------------------------------===//
14
15#ifndef ASAN_FLAGS_H
16#define ASAN_FLAGS_H
17
18#include "sanitizer_common/sanitizer_internal_defs.h"
19
20// ASan flag values can be defined in four ways:
21// 1) initialized with default values at startup.
22// 2) overriden during compilation of ASan runtime by providing
23//    compile definition ASAN_DEFAULT_OPTIONS.
24// 3) overriden from string returned by user-specified function
25//    __asan_default_options().
26// 4) overriden from env variable ASAN_OPTIONS.
27
28namespace __asan {
29
30struct Flags {
31  // Size (in bytes) of quarantine used to detect use-after-free errors.
32  // Lower value may reduce memory usage but increase the chance of
33  // false negatives.
34  int  quarantine_size;
35  // Size (in bytes) of redzones around heap objects.
36  // Requirement: redzone >= 32, is a power of two.
37  int  redzone;
38  // If set, prints some debugging information and does additional checks.
39  bool debug;
40  // Controls the way to handle globals (0 - don't detect buffer overflow
41  // on globals, 1 - detect buffer overflow, 2 - print data about registered
42  // globals).
43  int  report_globals;
44  // If set, attempts to catch initialization order issues.
45  bool check_initialization_order;
46  // If set, uses custom wrappers and replacements for libc string functions
47  // to find more errors.
48  bool replace_str;
49  // If set, uses custom wrappers for memset/memcpy/memmove intinsics.
50  bool replace_intrin;
51  // Used on Mac only.
52  bool mac_ignore_invalid_free;
53  // Enables stack-use-after-return checking at run-time.
54  bool detect_stack_use_after_return;
55  // The minimal fake stack size log.
56  int uar_stack_size_log;
57  // ASan allocator flag. max_malloc_fill_size is the maximal amount of bytes
58  // that will be filled with malloc_fill_byte on malloc.
59  int max_malloc_fill_size, malloc_fill_byte;
60  // Override exit status if something was reported.
61  int  exitcode;
62  // If set, user may manually mark memory regions as poisoned or unpoisoned.
63  bool allow_user_poisoning;
64  // Number of seconds to sleep between printing an error report and
65  // terminating application. Useful for debug purposes (when one needs
66  // to attach gdb, for example).
67  int  sleep_before_dying;
68  // If set, registers ASan custom segv handler.
69  bool handle_segv;
70  // If set, allows user register segv handler even if ASan registers one.
71  bool allow_user_segv_handler;
72  // If set, uses alternate stack for signal handling.
73  bool use_sigaltstack;
74  // Allow the users to work around the bug in Nvidia drivers prior to 295.*.
75  bool check_malloc_usable_size;
76  // If set, explicitly unmaps (huge) shadow at exit.
77  bool unmap_shadow_on_exit;
78  // If set, calls abort() instead of _exit() after printing an error report.
79  bool abort_on_error;
80  // Print various statistics after printing an error message or if atexit=1.
81  bool print_stats;
82  // Print the legend for the shadow bytes.
83  bool print_legend;
84  // If set, prints ASan exit stats even after program terminates successfully.
85  bool atexit;
86  // If set, coverage information will be dumped at shutdown time if the
87  // appropriate instrumentation was enabled.
88  bool coverage;
89  // By default, disable core dumper on 64-bit - it makes little sense
90  // to dump 16T+ core.
91  bool disable_core;
92  // Allow the tool to re-exec the program. This may interfere badly with the
93  // debugger.
94  bool allow_reexec;
95  // If set, prints not only thread creation stacks for threads in error report,
96  // but also thread creation stacks for threads that created those threads,
97  // etc. up to main thread.
98  bool print_full_thread_history;
99  // Poison (or not) the heap memory on [de]allocation. Zero value is useful
100  // for benchmarking the allocator or instrumentator.
101  bool poison_heap;
102  // If true, poison partially addressable 8-byte aligned words (default=true).
103  // This flag affects heap and global buffers, but not stack buffers.
104  bool poison_partial;
105  // Report errors on malloc/delete, new/free, new/delete[], etc.
106  bool alloc_dealloc_mismatch;
107  // If true, assume that memcmp(p1, p2, n) always reads n bytes before
108  // comparing p1 and p2.
109  bool strict_memcmp;
110  // If true, assume that dynamic initializers can never access globals from
111  // other modules, even if the latter are already initialized.
112  bool strict_init_order;
113};
114
115extern Flags asan_flags_dont_use_directly;
116inline Flags *flags() {
117  return &asan_flags_dont_use_directly;
118}
119void InitializeFlags(Flags *f, const char *env);
120
121}  // namespace __asan
122
123#endif  // ASAN_FLAGS_H
124