1603c4be006d8c53905d736bf1f19a49f5ce98276Alexey Samsonov//===-- tsan_suppressions.cc ----------------------------------------------===// 27ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// 37ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// The LLVM Compiler Infrastructure 47ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// 57ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// This file is distributed under the University of Illinois Open Source 67ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// License. See LICENSE.TXT for details. 77ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// 87ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany//===----------------------------------------------------------------------===// 97ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// 107ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// This file is a part of ThreadSanitizer (TSan), a race detector. 117ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany// 127ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany//===----------------------------------------------------------------------===// 137ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 140969bcf2c936126b1f6e636b978aade8fc207437Alexey Samsonov#include "sanitizer_common/sanitizer_common.h" 157f9c5a220b2768a450696bbd157a0e6f2e9ceea3Alexey Samsonov#include "sanitizer_common/sanitizer_libc.h" 16a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev#include "sanitizer_common/sanitizer_placement_new.h" 17a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev#include "sanitizer_common/sanitizer_suppressions.h" 187ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany#include "tsan_suppressions.h" 197ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany#include "tsan_rtl.h" 207ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany#include "tsan_flags.h" 217ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany#include "tsan_mman.h" 227ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany#include "tsan_platform.h" 237ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 24a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// Suppressions for true/false positives in standard libraries. 25a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukovstatic const char *const std_suppressions = 26a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// Libstdc++ 4.4 has data races in std::string. 27a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// See http://crbug.com/181502 for an example. 28a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov"race:^_M_rep$\n" 29a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov"race:^_M_is_leaked$\n" 30a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// False positive when using std <thread>. 31a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// Happens because we miss atomic synchronization in libstdc++. 32a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov// See http://llvm.org/bugs/show_bug.cgi?id=17066 for details. 33da506a9ae831f275267ddc9ee74e5474246369b1Alexey Samsonov"race:std::_Sp_counted_ptr_inplace<std::thread::_Impl\n"; 34a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov 35c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov// Can be overriden in frontend. 36c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov#ifndef TSAN_GO 37c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukovextern "C" const char *WEAK __tsan_default_suppressions() { 38c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov return 0; 39c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov} 40c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov#endif 41c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov 427ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryanynamespace __tsan { 437ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 44a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveevstatic SuppressionContext* g_ctx; 457ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 467ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryanystatic char *ReadFile(const char *filename) { 477ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany if (filename == 0 || filename[0] == 0) 487ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany return 0; 4914c8bd7250742749e44e306c02a56cf47ad1db82Alexey Samsonov InternalScopedBuffer<char> tmp(4*1024); 506422c32996ec2d65b2ebc77dda36b613dbd1571aDmitry Vyukov if (filename[0] == '/' || GetPwd() == 0) 511dc4cf7e253aefa3ce3bd4a1d349a13647e8b2eaAlexey Samsonov internal_snprintf(tmp.data(), tmp.size(), "%s", filename); 527ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany else 531dc4cf7e253aefa3ce3bd4a1d349a13647e8b2eaAlexey Samsonov internal_snprintf(tmp.data(), tmp.size(), "%s/%s", GetPwd(), filename); 549578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne uptr openrv = OpenFile(tmp.data(), false); 559578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne if (internal_iserror(openrv)) { 56b1fe3021eca0843e37878d224ee7f32e32f40d99Alexey Samsonov Printf("ThreadSanitizer: failed to open suppressions file '%s'\n", 5714c8bd7250742749e44e306c02a56cf47ad1db82Alexey Samsonov tmp.data()); 587ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany Die(); 597ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany } 609578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne fd_t fd = openrv; 617ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany const uptr fsize = internal_filesize(fd); 627ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany if (fsize == (uptr)-1) { 63b1fe3021eca0843e37878d224ee7f32e32f40d99Alexey Samsonov Printf("ThreadSanitizer: failed to stat suppressions file '%s'\n", 6414c8bd7250742749e44e306c02a56cf47ad1db82Alexey Samsonov tmp.data()); 657ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany Die(); 667ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany } 677ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany char *buf = (char*)internal_alloc(MBlockSuppression, fsize + 1); 687ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany if (fsize != internal_read(fd, buf, fsize)) { 69b1fe3021eca0843e37878d224ee7f32e32f40d99Alexey Samsonov Printf("ThreadSanitizer: failed to read suppressions file '%s'\n", 7014c8bd7250742749e44e306c02a56cf47ad1db82Alexey Samsonov tmp.data()); 717ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany Die(); 727ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany } 737ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany internal_close(fd); 747ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany buf[fsize] = 0; 757ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany return buf; 767ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany} 777ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 787ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryanyvoid InitializeSuppressions() { 79a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev ALIGNED(64) static char placeholder_[sizeof(SuppressionContext)]; 80a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx = new(placeholder_) SuppressionContext; 81c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov const char *supp = ReadFile(flags()->suppressions); 82a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Parse(supp); 83c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov#ifndef TSAN_GO 84c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov supp = __tsan_default_suppressions(); 85a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Parse(supp); 86a117492b30509744a2b3e1e84c7b56e9ad76c0c9Dmitry Vyukov g_ctx->Parse(std_suppressions); 87c2b9f1c1d54e857e56462e65155381faddf398dfDmitry Vyukov#endif 887ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany} 897ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany 904af0f21c0c98950df1136dbec8824a029ed5bb8eDmitry VyukovSuppressionContext *GetSuppressionContext() { 914af0f21c0c98950df1136dbec8824a029ed5bb8eDmitry Vyukov CHECK_NE(g_ctx, 0); 924af0f21c0c98950df1136dbec8824a029ed5bb8eDmitry Vyukov return g_ctx; 934af0f21c0c98950df1136dbec8824a029ed5bb8eDmitry Vyukov} 944af0f21c0c98950df1136dbec8824a029ed5bb8eDmitry Vyukov 9539968339a07d790aadcf27534f92a0de8c0c90fbDmitry VyukovSuppressionType conv(ReportType typ) { 967ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany if (typ == ReportTypeRace) 9739968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionRace; 9824cdfee9776abddcd6c96240e398706667029e0dDmitry Vyukov else if (typ == ReportTypeVptrRace) 9939968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionRace; 10024cdfee9776abddcd6c96240e398706667029e0dDmitry Vyukov else if (typ == ReportTypeUseAfterFree) 10145c652e3b3068f5a0626977e4506c71cfdba8ad3Alexander Potapenko return SuppressionRace; 1027ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany else if (typ == ReportTypeThreadLeak) 10339968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionThread; 1047ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany else if (typ == ReportTypeMutexDestroyLocked) 10539968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionMutex; 1062d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines else if (typ == ReportTypeMutexDoubleLock) 1072d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return SuppressionMutex; 1082d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines else if (typ == ReportTypeMutexBadUnlock) 1092d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return SuppressionMutex; 1102d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines else if (typ == ReportTypeMutexBadReadLock) 1112d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return SuppressionMutex; 1122d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines else if (typ == ReportTypeMutexBadReadUnlock) 1132d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return SuppressionMutex; 1147ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany else if (typ == ReportTypeSignalUnsafe) 11539968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionSignal; 11624cdfee9776abddcd6c96240e398706667029e0dDmitry Vyukov else if (typ == ReportTypeErrnoInSignal) 11739968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return SuppressionNone; 1182d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines else if (typ == ReportTypeDeadlock) 1192d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return SuppressionDeadlock; 12039968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov Printf("ThreadSanitizer: unknown report type %d\n", typ), 12139968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov Die(); 12239968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov} 12339968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov 12439968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukovuptr IsSuppressed(ReportType typ, const ReportStack *stack, Suppression **sp) { 125a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev CHECK(g_ctx); 1265d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines if (!g_ctx->SuppressionCount() || stack == 0 || !stack->suppressable) 1275d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines return 0; 12839968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov SuppressionType stype = conv(typ); 12939968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov if (stype == SuppressionNone) 130158c6ac3bb46753db217f9c2c73485811a3a1890Dmitry Vyukov return 0; 131a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev Suppression *s; 1327ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany for (const ReportStack *frame = stack; frame; frame = frame->next) { 133a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev if (g_ctx->Match(frame->func, stype, &s) || 134a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Match(frame->file, stype, &s) || 135a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Match(frame->module, stype, &s)) { 136a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev DPrintf("ThreadSanitizer: matched suppression '%s'\n", s->templ); 137a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev s->hit_count++; 138a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev *sp = s; 139a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev return frame->pc; 1407ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany } 1417ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany } 142158c6ac3bb46753db217f9c2c73485811a3a1890Dmitry Vyukov return 0; 1437ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany} 144f754eb501d6bd163fff6747716b7703fe45be4b8Dmitry Vyukov 14539968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukovuptr IsSuppressed(ReportType typ, const ReportLocation *loc, Suppression **sp) { 146a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev CHECK(g_ctx); 147a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev if (!g_ctx->SuppressionCount() || loc == 0 || 1485d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines loc->type != ReportLocationGlobal || !loc->suppressable) 14939968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return 0; 15039968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov SuppressionType stype = conv(typ); 15139968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov if (stype == SuppressionNone) 15239968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return 0; 153a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev Suppression *s; 154a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev if (g_ctx->Match(loc->name, stype, &s) || 155a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Match(loc->file, stype, &s) || 156a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->Match(loc->module, stype, &s)) { 157f2c844564c14e5438494083bf6db304a33673df2Sergey Matveev DPrintf("ThreadSanitizer: matched suppression '%s'\n", s->templ); 158a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev s->hit_count++; 159a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev *sp = s; 16039968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return loc->addr; 16139968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov } 16239968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov return 0; 16339968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov} 16439968339a07d790aadcf27534f92a0de8c0c90fbDmitry Vyukov 165f754eb501d6bd163fff6747716b7703fe45be4b8Dmitry Vyukovvoid PrintMatchedSuppressions() { 166a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev CHECK(g_ctx); 167a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev InternalMmapVector<Suppression *> matched(1); 168a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev g_ctx->GetMatched(&matched); 169a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev if (!matched.size()) 170f754eb501d6bd163fff6747716b7703fe45be4b8Dmitry Vyukov return; 171a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev int hit_count = 0; 172a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev for (uptr i = 0; i < matched.size(); i++) 173a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev hit_count += matched[i]->hit_count; 174a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev Printf("ThreadSanitizer: Matched %d suppressions (pid=%d):\n", hit_count, 175a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev (int)internal_getpid()); 176a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev for (uptr i = 0; i < matched.size(); i++) { 177a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev Printf("%d %s:%s\n", matched[i]->hit_count, 178a52e5c6f371bcc66e89792db1219a557664aab8dSergey Matveev SuppressionTypeString(matched[i]->type), matched[i]->templ); 179f754eb501d6bd163fff6747716b7703fe45be4b8Dmitry Vyukov } 180f754eb501d6bd163fff6747716b7703fe45be4b8Dmitry Vyukov} 1817ac41484ea322e0ea5774df681660269f5dc321eKostya Serebryany} // namespace __tsan 182