1 //===-- tsan_suppressions.cc ----------------------------------------------===//
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 ThreadSanitizer (TSan), a race detector.
12 //===----------------------------------------------------------------------===//
14 #include "sanitizer_common/sanitizer_common.h"
15 #include "sanitizer_common/sanitizer_libc.h"
16 #include "sanitizer_common/sanitizer_placement_new.h"
17 #include "sanitizer_common/sanitizer_suppressions.h"
18 #include "tsan_suppressions.h"
20 #include "tsan_flags.h"
21 #include "tsan_mman.h"
22 #include "tsan_platform.h"
25 // Suppressions for true/false positives in standard libraries.
26 static const char *const std_suppressions =
27 // Libstdc++ 4.4 has data races in std::string.
28 // See http://crbug.com/181502 for an example.
30 "race:^_M_is_leaked$\n"
31 // False positive when using std <thread>.
32 // Happens because we miss atomic synchronization in libstdc++.
33 // See http://llvm.org/bugs/show_bug.cgi?id=17066 for details.
34 "race:std::_Sp_counted_ptr_inplace<std::thread::_Impl\n";
36 // Can be overriden in frontend.
37 SANITIZER_WEAK_DEFAULT_IMPL
38 const char *__tsan_default_suppressions() {
45 ALIGNED(64) static char suppression_placeholder[sizeof(SuppressionContext)];
46 static SuppressionContext *suppression_ctx = nullptr;
47 static const char *kSuppressionTypes[] = {
48 kSuppressionRace, kSuppressionRaceTop, kSuppressionMutex,
49 kSuppressionThread, kSuppressionSignal, kSuppressionLib,
50 kSuppressionDeadlock};
52 void InitializeSuppressions() {
53 CHECK_EQ(nullptr, suppression_ctx);
54 suppression_ctx = new (suppression_placeholder) // NOLINT
55 SuppressionContext(kSuppressionTypes, ARRAY_SIZE(kSuppressionTypes));
56 suppression_ctx->ParseFromFile(flags()->suppressions);
58 suppression_ctx->Parse(__tsan_default_suppressions());
59 suppression_ctx->Parse(std_suppressions);
63 SuppressionContext *Suppressions() {
64 CHECK(suppression_ctx);
65 return suppression_ctx;
68 static const char *conv(ReportType typ) {
69 if (typ == ReportTypeRace)
70 return kSuppressionRace;
71 else if (typ == ReportTypeVptrRace)
72 return kSuppressionRace;
73 else if (typ == ReportTypeUseAfterFree)
74 return kSuppressionRace;
75 else if (typ == ReportTypeVptrUseAfterFree)
76 return kSuppressionRace;
77 else if (typ == ReportTypeExternalRace)
78 return kSuppressionRace;
79 else if (typ == ReportTypeThreadLeak)
80 return kSuppressionThread;
81 else if (typ == ReportTypeMutexDestroyLocked)
82 return kSuppressionMutex;
83 else if (typ == ReportTypeMutexDoubleLock)
84 return kSuppressionMutex;
85 else if (typ == ReportTypeMutexInvalidAccess)
86 return kSuppressionMutex;
87 else if (typ == ReportTypeMutexBadUnlock)
88 return kSuppressionMutex;
89 else if (typ == ReportTypeMutexBadReadLock)
90 return kSuppressionMutex;
91 else if (typ == ReportTypeMutexBadReadUnlock)
92 return kSuppressionMutex;
93 else if (typ == ReportTypeSignalUnsafe)
94 return kSuppressionSignal;
95 else if (typ == ReportTypeErrnoInSignal)
96 return kSuppressionNone;
97 else if (typ == ReportTypeDeadlock)
98 return kSuppressionDeadlock;
99 Printf("ThreadSanitizer: unknown report type %d\n", typ);
103 static uptr IsSuppressed(const char *stype, const AddressInfo &info,
105 if (suppression_ctx->Match(info.function, stype, sp) ||
106 suppression_ctx->Match(info.file, stype, sp) ||
107 suppression_ctx->Match(info.module, stype, sp)) {
108 VPrintf(2, "ThreadSanitizer: matched suppression '%s'\n", (*sp)->templ);
109 atomic_fetch_add(&(*sp)->hit_count, 1, memory_order_relaxed);
115 uptr IsSuppressed(ReportType typ, const ReportStack *stack, Suppression **sp) {
116 CHECK(suppression_ctx);
117 if (!suppression_ctx->SuppressionCount() || stack == 0 ||
118 !stack->suppressable)
120 const char *stype = conv(typ);
121 if (0 == internal_strcmp(stype, kSuppressionNone))
123 for (const SymbolizedStack *frame = stack->frames; frame;
124 frame = frame->next) {
125 uptr pc = IsSuppressed(stype, frame->info, sp);
129 if (0 == internal_strcmp(stype, kSuppressionRace) && stack->frames != nullptr)
130 return IsSuppressed(kSuppressionRaceTop, stack->frames->info, sp);
134 uptr IsSuppressed(ReportType typ, const ReportLocation *loc, Suppression **sp) {
135 CHECK(suppression_ctx);
136 if (!suppression_ctx->SuppressionCount() || loc == 0 ||
137 loc->type != ReportLocationGlobal || !loc->suppressable)
139 const char *stype = conv(typ);
140 if (0 == internal_strcmp(stype, kSuppressionNone))
143 const DataInfo &global = loc->global;
144 if (suppression_ctx->Match(global.name, stype, &s) ||
145 suppression_ctx->Match(global.module, stype, &s)) {
146 VPrintf(2, "ThreadSanitizer: matched suppression '%s'\n", s->templ);
147 atomic_fetch_add(&s->hit_count, 1, memory_order_relaxed);
154 void PrintMatchedSuppressions() {
155 InternalMmapVector<Suppression *> matched(1);
156 CHECK(suppression_ctx);
157 suppression_ctx->GetMatched(&matched);
161 for (uptr i = 0; i < matched.size(); i++)
162 hit_count += atomic_load_relaxed(&matched[i]->hit_count);
163 Printf("ThreadSanitizer: Matched %d suppressions (pid=%d):\n", hit_count,
164 (int)internal_getpid());
165 for (uptr i = 0; i < matched.size(); i++) {
166 Printf("%d %s:%s\n", atomic_load_relaxed(&matched[i]->hit_count),
167 matched[i]->type, matched[i]->templ);
170 } // namespace __tsan