asan_flags.h revision e1c68c319a0113be832da17a777892353a8b5f23 
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  // Verbosity level (0 - silent, 1 - a bit of output, 2+ - more output).
36  int  verbosity;
37  // Size (in bytes) of redzones around heap objects.
38  // Requirement: redzone >= 32, is a power of two.
39  int  redzone;
40  // If set, prints some debugging information and does additional checks.
41  bool debug;
42  // Controls the way to handle globals (0 - don't detect buffer overflow
43  // on globals, 1 - detect buffer overflow, 2 - print data about registered
44  // globals).
45  int  report_globals;
46  // If set, attempts to catch initialization order issues.
47  bool check_initialization_order;
48  // If set, uses custom wrappers and replacements for libc string functions
49  // to find more errors.
50  bool replace_str;
51  // If set, uses custom wrappers for memset/memcpy/memmove intinsics.
52  bool replace_intrin;
53  // Used on Mac only.
54  bool mac_ignore_invalid_free;
55  // Enables stack-use-after-return checking at run-time.
56  bool detect_stack_use_after_return;
57  // The minimal fake stack size log.
58  int uar_stack_size_log;
59  // ASan allocator flag. max_malloc_fill_size is the maximal amount of bytes
60  // that will be filled with malloc_fill_byte on malloc.
61  int max_malloc_fill_size, malloc_fill_byte;
62  // Override exit status if something was reported.
63  int  exitcode;
64  // If set, user may manually mark memory regions as poisoned or unpoisoned.
65  bool allow_user_poisoning;
66  // Number of seconds to sleep between printing an error report and
67  // terminating application. Useful for debug purposes (when one needs
68  // to attach gdb, for example).
69  int  sleep_before_dying;
70  // If set, registers ASan custom segv handler.
71  bool handle_segv;
72  // If set, allows user register segv handler even if ASan registers one.
73  bool allow_user_segv_handler;
74  // If set, uses alternate stack for signal handling.
75  bool use_sigaltstack;
76  // Allow the users to work around the bug in Nvidia drivers prior to 295.*.
77  bool check_malloc_usable_size;
78  // If set, explicitly unmaps (huge) shadow at exit.
79  bool unmap_shadow_on_exit;
80  // If set, calls abort() instead of _exit() after printing an error report.
81  bool abort_on_error;
82  // Print various statistics after printing an error message or if atexit=1.
83  bool print_stats;
84  // Print the legend for the shadow bytes.
85  bool print_legend;
86  // If set, prints ASan exit stats even after program terminates successfully.
87  bool atexit;
88  // By default, disable core dumper on 64-bit - it makes little sense
89  // to dump 16T+ core.
90  bool disable_core;
91  // Allow the tool to re-exec the program. This may interfere badly with the
92  // debugger.
93  bool allow_reexec;
94  // If set, prints not only thread creation stacks for threads in error report,
95  // but also thread creation stacks for threads that created those threads,
96  // etc. up to main thread.
97  bool print_full_thread_history;
98  // Poison (or not) the heap memory on [de]allocation. Zero value is useful
99  // for benchmarking the allocator or instrumentator.
100  bool poison_heap;
101  // Report errors on malloc/delete, new/free, new/delete[], etc.
102  bool alloc_dealloc_mismatch;
103  // Use stack depot instead of storing stacks in the redzones.
104  bool use_stack_depot;
105  // If true, assume that memcmp(p1, p2, n) always reads n bytes before
106  // comparing p1 and p2.
107  bool strict_memcmp;
108  // If true, assume that dynamic initializers can never access globals from
109  // other modules, even if the latter are already initialized.
110  bool strict_init_order;
111};
112
113extern Flags asan_flags_dont_use_directly;
114inline Flags *flags() {
115  return &asan_flags_dont_use_directly;
116}
117void InitializeFlags(Flags *f, const char *env);
118
119}  // namespace __asan
120
121#endif  // ASAN_FLAGS_H
122