1//===-- tsan_flags.cc -----------------------------------------------------===//
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 ThreadSanitizer (TSan), a race detector.
11//
12//===----------------------------------------------------------------------===//
13
14#include "sanitizer_common/sanitizer_flags.h"
15#include "sanitizer_common/sanitizer_flag_parser.h"
16#include "sanitizer_common/sanitizer_libc.h"
17#include "tsan_flags.h"
18#include "tsan_rtl.h"
19#include "tsan_mman.h"
20#include "ubsan/ubsan_flags.h"
21
22namespace __tsan {
23
24// Can be overriden in frontend.
25#ifdef TSAN_EXTERNAL_HOOKS
26extern "C" const char* __tsan_default_options();
27#else
28SANITIZER_WEAK_DEFAULT_IMPL
29const char *__tsan_default_options() {
30  return "";
31}
32#endif
33
34void Flags::SetDefaults() {
35#define TSAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
36#include "tsan_flags.inc"
37#undef TSAN_FLAG
38  // DDFlags
39  second_deadlock_stack = false;
40}
41
42void RegisterTsanFlags(FlagParser *parser, Flags *f) {
43#define TSAN_FLAG(Type, Name, DefaultValue, Description) \
44  RegisterFlag(parser, #Name, Description, &f->Name);
45#include "tsan_flags.inc"
46#undef TSAN_FLAG
47  // DDFlags
48  RegisterFlag(parser, "second_deadlock_stack",
49      "Report where each mutex is locked in deadlock reports",
50      &f->second_deadlock_stack);
51}
52
53void InitializeFlags(Flags *f, const char *env) {
54  SetCommonFlagsDefaults();
55  {
56    // Override some common flags defaults.
57    CommonFlags cf;
58    cf.CopyFrom(*common_flags());
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::MaybeCallUbsanDefaultOptions();
92  ubsan_parser.ParseString(ubsan_default_options);
93#endif
94  // Override from command line.
95  parser.ParseString(env);
96#if TSAN_CONTAINS_UBSAN
97  ubsan_parser.ParseString(GetEnv("UBSAN_OPTIONS"));
98#endif
99
100  // Sanity check.
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->history_size < 0 || f->history_size > 7) {
114    Printf("ThreadSanitizer: incorrect value for history_size"
115           " (must be [0..7])\n");
116    Die();
117  }
118
119  if (f->io_sync < 0 || f->io_sync > 2) {
120    Printf("ThreadSanitizer: incorrect value for io_sync"
121           " (must be [0..2])\n");
122    Die();
123  }
124}
125
126}  // namespace __tsan
127