1 //===-- asan_flags.cc -------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is a part of AddressSanitizer, an address sanity checker.
12 // ASan flag parsing logic.
13 //===----------------------------------------------------------------------===//
15 #include "asan_activation.h"
16 #include "asan_flags.h"
17 #include "asan_interface_internal.h"
18 #include "asan_stack.h"
19 #include "lsan/lsan_common.h"
20 #include "sanitizer_common/sanitizer_common.h"
21 #include "sanitizer_common/sanitizer_flags.h"
22 #include "sanitizer_common/sanitizer_flag_parser.h"
23 #include "ubsan/ubsan_flags.h"
24 #include "ubsan/ubsan_platform.h"
28 Flags asan_flags_dont_use_directly
; // use via flags().
30 static const char *MaybeCallAsanDefaultOptions() {
31 return (&__asan_default_options
) ? __asan_default_options() : "";
34 static const char *MaybeUseAsanDefaultOptionsCompileDefinition() {
35 #ifdef ASAN_DEFAULT_OPTIONS
36 // Stringize the macro value.
37 # define ASAN_STRINGIZE(x) #x
38 # define ASAN_STRINGIZE_OPTIONS(options) ASAN_STRINGIZE(options)
39 return ASAN_STRINGIZE_OPTIONS(ASAN_DEFAULT_OPTIONS
);
45 void Flags::SetDefaults() {
46 #define ASAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
47 #include "asan_flags.inc"
51 static void RegisterAsanFlags(FlagParser
*parser
, Flags
*f
) {
52 #define ASAN_FLAG(Type, Name, DefaultValue, Description) \
53 RegisterFlag(parser, #Name, Description, &f->Name);
54 #include "asan_flags.inc"
58 void InitializeFlags() {
59 // Set the default values and prepare for parsing ASan and common flags.
60 SetCommonFlagsDefaults();
63 cf
.CopyFrom(*common_flags());
64 cf
.detect_leaks
= CAN_SANITIZE_LEAKS
;
65 cf
.external_symbolizer_path
= GetEnv("ASAN_SYMBOLIZER_PATH");
66 cf
.malloc_context_size
= kDefaultMallocContextSize
;
67 cf
.intercept_tls_get_addr
= true;
69 OverrideCommonFlags(cf
);
74 FlagParser asan_parser
;
75 RegisterAsanFlags(&asan_parser
, f
);
76 RegisterCommonFlags(&asan_parser
);
78 // Set the default values and prepare for parsing LSan and UBSan flags
79 // (which can also overwrite common flags).
80 #if CAN_SANITIZE_LEAKS
81 __lsan::Flags
*lf
= __lsan::flags();
84 FlagParser lsan_parser
;
85 __lsan::RegisterLsanFlags(&lsan_parser
, lf
);
86 RegisterCommonFlags(&lsan_parser
);
90 __ubsan::Flags
*uf
= __ubsan::flags();
93 FlagParser ubsan_parser
;
94 __ubsan::RegisterUbsanFlags(&ubsan_parser
, uf
);
95 RegisterCommonFlags(&ubsan_parser
);
98 // Override from ASan compile definition.
99 const char *asan_compile_def
= MaybeUseAsanDefaultOptionsCompileDefinition();
100 asan_parser
.ParseString(asan_compile_def
);
102 // Override from user-specified string.
103 const char *asan_default_options
= MaybeCallAsanDefaultOptions();
104 asan_parser
.ParseString(asan_default_options
);
106 const char *ubsan_default_options
= __ubsan::MaybeCallUbsanDefaultOptions();
107 ubsan_parser
.ParseString(ubsan_default_options
);
110 // Override from command line.
111 asan_parser
.ParseString(GetEnv("ASAN_OPTIONS"));
112 #if CAN_SANITIZE_LEAKS
113 lsan_parser
.ParseString(GetEnv("LSAN_OPTIONS"));
116 ubsan_parser
.ParseString(GetEnv("UBSAN_OPTIONS"));
119 // Let activation flags override current settings. On Android they come
120 // from a system property. On other platforms this is no-op.
121 if (!flags()->start_deactivated
) {
123 GetExtraActivationFlags(buf
, sizeof(buf
));
124 asan_parser
.ParseString(buf
);
127 SetVerbosity(common_flags()->verbosity
);
129 // TODO(eugenis): dump all flags at verbosity>=2?
130 if (Verbosity()) ReportUnrecognizedFlags();
132 if (common_flags()->help
) {
133 // TODO(samsonov): print all of the flags (ASan, LSan, common).
134 asan_parser
.PrintFlagDescriptions();
138 if (!CAN_SANITIZE_LEAKS
&& common_flags()->detect_leaks
) {
139 Report("%s: detect_leaks is not supported on this platform.\n",
143 // Make "strict_init_order" imply "check_initialization_order".
144 // TODO(samsonov): Use a single runtime flag for an init-order checker.
145 if (f
->strict_init_order
) {
146 f
->check_initialization_order
= true;
148 CHECK_LE((uptr
)common_flags()->malloc_context_size
, kStackTraceMax
);
149 CHECK_LE(f
->min_uar_stack_size_log
, f
->max_uar_stack_size_log
);
150 CHECK_GE(f
->redzone
, 16);
151 CHECK_GE(f
->max_redzone
, f
->redzone
);
152 CHECK_LE(f
->max_redzone
, 2048);
153 CHECK(IsPowerOfTwo(f
->redzone
));
154 CHECK(IsPowerOfTwo(f
->max_redzone
));
156 // quarantine_size is deprecated but we still honor it.
157 // quarantine_size can not be used together with quarantine_size_mb.
158 if (f
->quarantine_size
>= 0 && f
->quarantine_size_mb
>= 0) {
159 Report("%s: please use either 'quarantine_size' (deprecated) or "
160 "quarantine_size_mb, but not both\n", SanitizerToolName
);
163 if (f
->quarantine_size
>= 0)
164 f
->quarantine_size_mb
= f
->quarantine_size
>> 20;
165 if (f
->quarantine_size_mb
< 0) {
166 const int kDefaultQuarantineSizeMb
=
167 (ASAN_LOW_MEMORY
) ? 1UL << 6 : 1UL << 8;
168 f
->quarantine_size_mb
= kDefaultQuarantineSizeMb
;
172 } // namespace __asan
174 #if !SANITIZER_SUPPORTS_WEAK_HOOKS
176 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
177 const char* __asan_default_options() { return ""; }