xref: /freebsd/contrib/llvm-project/compiler-rt/lib/tsan/rtl/tsan_flags.cpp (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
1 //===-- tsan_flags.cpp ----------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file is a part of ThreadSanitizer (TSan), a race detector.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "sanitizer_common/sanitizer_flags.h"
14 #include "sanitizer_common/sanitizer_flag_parser.h"
15 #include "sanitizer_common/sanitizer_libc.h"
16 #include "tsan_flags.h"
17 #include "tsan_rtl.h"
18 #include "tsan_mman.h"
19 #include "ubsan/ubsan_flags.h"
20 
21 namespace __tsan {
22 
23 // Can be overriden in frontend.
24 #ifdef TSAN_EXTERNAL_HOOKS
25 extern "C" const char* __tsan_default_options();
26 #else
27 SANITIZER_WEAK_DEFAULT_IMPL
28 const char *__tsan_default_options() {
29   return "";
30 }
31 #endif
32 
33 void Flags::SetDefaults() {
34 #define TSAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
35 #include "tsan_flags.inc"
36 #undef TSAN_FLAG
37   // DDFlags
38   second_deadlock_stack = false;
39 }
40 
41 void RegisterTsanFlags(FlagParser *parser, Flags *f) {
42 #define TSAN_FLAG(Type, Name, DefaultValue, Description) \
43   RegisterFlag(parser, #Name, Description, &f->Name);
44 #include "tsan_flags.inc"
45 #undef TSAN_FLAG
46   // DDFlags
47   RegisterFlag(parser, "second_deadlock_stack",
48       "Report where each mutex is locked in deadlock reports",
49       &f->second_deadlock_stack);
50 }
51 
52 void InitializeFlags(Flags *f, const char *env, const char *env_option_name) {
53   SetCommonFlagsDefaults();
54   {
55     // Override some common flags defaults.
56     CommonFlags cf;
57     cf.CopyFrom(*common_flags());
58     cf.external_symbolizer_path = GetEnv("TSAN_SYMBOLIZER_PATH");
59     cf.allow_addr2line = true;
60     if (SANITIZER_GO) {
61       // Does not work as expected for Go: runtime handles SIGABRT and crashes.
62       cf.abort_on_error = false;
63       // Go does not have mutexes.
64       cf.detect_deadlocks = false;
65     }
66     cf.print_suppressions = false;
67     cf.stack_trace_format = "    #%n %f %S %M";
68     cf.exitcode = 66;
69     cf.intercept_tls_get_addr = true;
70     OverrideCommonFlags(cf);
71   }
72 
73   f->SetDefaults();
74 
75   FlagParser parser;
76   RegisterTsanFlags(&parser, f);
77   RegisterCommonFlags(&parser);
78 
79 #if TSAN_CONTAINS_UBSAN
80   __ubsan::Flags *uf = __ubsan::flags();
81   uf->SetDefaults();
82 
83   FlagParser ubsan_parser;
84   __ubsan::RegisterUbsanFlags(&ubsan_parser, uf);
85   RegisterCommonFlags(&ubsan_parser);
86 #endif
87 
88   // Let a frontend override.
89   parser.ParseString(__tsan_default_options());
90 #if TSAN_CONTAINS_UBSAN
91   const char *ubsan_default_options = __ubsan_default_options();
92   ubsan_parser.ParseString(ubsan_default_options);
93 #endif
94   // Override from command line.
95   parser.ParseString(env, env_option_name);
96 #if TSAN_CONTAINS_UBSAN
97   ubsan_parser.ParseStringFromEnv("UBSAN_OPTIONS");
98 #endif
99 
100   // Check flags.
101   if (!f->report_bugs) {
102     f->report_thread_leaks = false;
103     f->report_destroy_locked = false;
104     f->report_signal_unsafe = false;
105   }
106 
107   InitializeCommonFlags();
108 
109   if (Verbosity()) ReportUnrecognizedFlags();
110 
111   if (common_flags()->help) parser.PrintFlagDescriptions();
112 
113   if (f->io_sync < 0 || f->io_sync > 2) {
114     Printf("ThreadSanitizer: incorrect value for io_sync"
115            " (must be [0..2])\n");
116     Die();
117   }
118 }
119 
120 }  // namespace __tsan
121