contrib/compiler-rt/lib/tsan/rtl/tsan_rtl.cc

   1 //===-- tsan_rtl.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 // Main file (entry points) for the TSan run-time.
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "sanitizer_common/sanitizer_atomic.h"
  16 #include "sanitizer_common/sanitizer_common.h"
  17 #include "sanitizer_common/sanitizer_file.h"
  18 #include "sanitizer_common/sanitizer_libc.h"
  19 #include "sanitizer_common/sanitizer_stackdepot.h"
  20 #include "sanitizer_common/sanitizer_placement_new.h"
  21 #include "sanitizer_common/sanitizer_symbolizer.h"
  22 #include "tsan_defs.h"
  23 #include "tsan_platform.h"
  24 #include "tsan_rtl.h"
  25 #include "tsan_mman.h"
  26 #include "tsan_suppressions.h"
  27 #include "tsan_symbolize.h"
  28 #include "ubsan/ubsan_init.h"
  29
  30 #ifdef __SSE3__
  31 // <emmintrin.h> transitively includes <stdlib.h>,
  32 // and it's prohibited to include std headers into tsan runtime.
  33 // So we do this dirty trick.
  34 #define _MM_MALLOC_H_INCLUDED
  35 #define __MM_MALLOC_H
  36 #include <emmintrin.h>
  37 typedef __m128i m128;
  38 #endif
  39
  40 volatile int __tsan_resumed = 0;
  41
  42 extern "C" void __tsan_resume() {
  43   __tsan_resumed = 1;
  44 }
  45
  46 namespace __tsan {
  47
  48 #if !SANITIZER_GO && !SANITIZER_MAC
  49 __attribute__((tls_model("initial-exec")))
  50 THREADLOCAL char cur_thread_placeholder[sizeof(ThreadState)] ALIGNED(64);
  51 #endif
  52 static char ctx_placeholder[sizeof(Context)] ALIGNED(64);
  53 Context *ctx;
  54
  55 // Can be overriden by a front-end.
  56 #ifdef TSAN_EXTERNAL_HOOKS
  57 bool OnFinalize(bool failed);
  58 void OnInitialize();
  59 #else
  60 SANITIZER_WEAK_CXX_DEFAULT_IMPL
  61 bool OnFinalize(bool failed) {
  62   return failed;
  63 }
  64 SANITIZER_WEAK_CXX_DEFAULT_IMPL
  65 void OnInitialize() {}
  66 #endif
  67
  68 static char thread_registry_placeholder[sizeof(ThreadRegistry)];
  69
  70 static ThreadContextBase *CreateThreadContext(u32 tid) {
  71   // Map thread trace when context is created.
  72   char name[50];
  73   internal_snprintf(name, sizeof(name), "trace %u", tid);
  74   MapThreadTrace(GetThreadTrace(tid), TraceSize() * sizeof(Event), name);
  75   const uptr hdr = GetThreadTraceHeader(tid);
  76   internal_snprintf(name, sizeof(name), "trace header %u", tid);
  77   MapThreadTrace(hdr, sizeof(Trace), name);
  78   new((void*)hdr) Trace();
  79   // We are going to use only a small part of the trace with the default
  80   // value of history_size. However, the constructor writes to the whole trace.
  81   // Unmap the unused part.
  82   uptr hdr_end = hdr + sizeof(Trace);
  83   hdr_end -= sizeof(TraceHeader) * (kTraceParts - TraceParts());
  84   hdr_end = RoundUp(hdr_end, GetPageSizeCached());
  85   if (hdr_end < hdr + sizeof(Trace))
  86     UnmapOrDie((void*)hdr_end, hdr + sizeof(Trace) - hdr_end);
  87   void *mem = internal_alloc(MBlockThreadContex, sizeof(ThreadContext));
  88   return new(mem) ThreadContext(tid);
  89 }
  90
  91 #if !SANITIZER_GO
  92 static const u32 kThreadQuarantineSize = 16;
  93 #else
  94 static const u32 kThreadQuarantineSize = 64;
  95 #endif
  96
  97 Context::Context()
  98   : initialized()
  99   , report_mtx(MutexTypeReport, StatMtxReport)
 100   , nreported()
 101   , nmissed_expected()
 102   , thread_registry(new(thread_registry_placeholder) ThreadRegistry(
 103       CreateThreadContext, kMaxTid, kThreadQuarantineSize, kMaxTidReuse))
 104   , racy_mtx(MutexTypeRacy, StatMtxRacy)
 105   , racy_stacks()
 106   , racy_addresses()
 107   , fired_suppressions_mtx(MutexTypeFired, StatMtxFired)
 108   , clock_alloc("clock allocator") {
 109   fired_suppressions.reserve(8);
 110 }
 111
 112 // The objects are allocated in TLS, so one may rely on zero-initialization.
 113 ThreadState::ThreadState(Context *ctx, int tid, int unique_id, u64 epoch,
 114                          unsigned reuse_count,
 115                          uptr stk_addr, uptr stk_size,
 116                          uptr tls_addr, uptr tls_size)
 117   : fast_state(tid, epoch)
 118   // Do not touch these, rely on zero initialization,
 119   // they may be accessed before the ctor.
 120   // , ignore_reads_and_writes()
 121   // , ignore_interceptors()
 122   , clock(tid, reuse_count)
 123 #if !SANITIZER_GO
 124   , jmp_bufs()
 125 #endif
 126   , tid(tid)
 127   , unique_id(unique_id)
 128   , stk_addr(stk_addr)
 129   , stk_size(stk_size)
 130   , tls_addr(tls_addr)
 131   , tls_size(tls_size)
 132 #if !SANITIZER_GO
 133   , last_sleep_clock(tid)
 134 #endif
 135 {
 136 }
 137
 138 #if !SANITIZER_GO
 139 static void MemoryProfiler(Context *ctx, fd_t fd, int i) {
 140   uptr n_threads;
 141   uptr n_running_threads;
 142   ctx->thread_registry->GetNumberOfThreads(&n_threads, &n_running_threads);
 143   InternalMmapVector<char> buf(4096);
 144   WriteMemoryProfile(buf.data(), buf.size(), n_threads, n_running_threads);
 145   WriteToFile(fd, buf.data(), internal_strlen(buf.data()));
 146 }
 147
 148 static void BackgroundThread(void *arg) {
 149   // This is a non-initialized non-user thread, nothing to see here.
 150   // We don't use ScopedIgnoreInterceptors, because we want ignores to be
 151   // enabled even when the thread function exits (e.g. during pthread thread
 152   // shutdown code).
 153   cur_thread()->ignore_interceptors++;
 154   const u64 kMs2Ns = 1000 * 1000;
 155
 156   fd_t mprof_fd = kInvalidFd;
 157   if (flags()->profile_memory && flags()->profile_memory[0]) {
 158     if (internal_strcmp(flags()->profile_memory, "stdout") == 0) {
 159       mprof_fd = 1;
 160     } else if (internal_strcmp(flags()->profile_memory, "stderr") == 0) {
 161       mprof_fd = 2;
 162     } else {
 163       InternalScopedString filename(kMaxPathLength);
 164       filename.append("%s.%d", flags()->profile_memory, (int)internal_getpid());
 165       fd_t fd = OpenFile(filename.data(), WrOnly);
 166       if (fd == kInvalidFd) {
 167         Printf("ThreadSanitizer: failed to open memory profile file '%s'\n",
 168             &filename[0]);
 169       } else {
 170         mprof_fd = fd;
 171       }
 172     }
 173   }
 174
 175   u64 last_flush = NanoTime();
 176   uptr last_rss = 0;
 177   for (int i = 0;
 178       atomic_load(&ctx->stop_background_thread, memory_order_relaxed) == 0;
 179       i++) {
 180     SleepForMillis(100);
 181     u64 now = NanoTime();
 182
 183     // Flush memory if requested.
 184     if (flags()->flush_memory_ms > 0) {
 185       if (last_flush + flags()->flush_memory_ms * kMs2Ns < now) {
 186         VPrintf(1, "ThreadSanitizer: periodic memory flush\n");
 187         FlushShadowMemory();
 188         last_flush = NanoTime();
 189       }
 190     }
 191     // GetRSS can be expensive on huge programs, so don't do it every 100ms.
 192     if (flags()->memory_limit_mb > 0) {
 193       uptr rss = GetRSS();
 194       uptr limit = uptr(flags()->memory_limit_mb) << 20;
 195       VPrintf(1, "ThreadSanitizer: memory flush check"
 196                  " RSS=%llu LAST=%llu LIMIT=%llu\n",
 197               (u64)rss >> 20, (u64)last_rss >> 20, (u64)limit >> 20);
 198       if (2 * rss > limit + last_rss) {
 199         VPrintf(1, "ThreadSanitizer: flushing memory due to RSS\n");
 200         FlushShadowMemory();
 201         rss = GetRSS();
 202         VPrintf(1, "ThreadSanitizer: memory flushed RSS=%llu\n", (u64)rss>>20);
 203       }
 204       last_rss = rss;
 205     }
 206
 207     // Write memory profile if requested.
 208     if (mprof_fd != kInvalidFd)
 209       MemoryProfiler(ctx, mprof_fd, i);
 210
 211     // Flush symbolizer cache if requested.
 212     if (flags()->flush_symbolizer_ms > 0) {
 213       u64 last = atomic_load(&ctx->last_symbolize_time_ns,
 214                              memory_order_relaxed);
 215       if (last != 0 && last + flags()->flush_symbolizer_ms * kMs2Ns < now) {
 216         Lock l(&ctx->report_mtx);
 217         ScopedErrorReportLock l2;
 218         SymbolizeFlush();
 219         atomic_store(&ctx->last_symbolize_time_ns, 0, memory_order_relaxed);
 220       }
 221     }
 222   }
 223 }
 224
 225 static void StartBackgroundThread() {
 226   ctx->background_thread = internal_start_thread(&BackgroundThread, 0);
 227 }
 228
 229 #ifndef __mips__
 230 static void StopBackgroundThread() {
 231   atomic_store(&ctx->stop_background_thread, 1, memory_order_relaxed);
 232   internal_join_thread(ctx->background_thread);
 233   ctx->background_thread = 0;
 234 }
 235 #endif
 236 #endif
 237
 238 void DontNeedShadowFor(uptr addr, uptr size) {
 239   ReleaseMemoryPagesToOS(MemToShadow(addr), MemToShadow(addr + size));
 240 }
 241
 242 void MapShadow(uptr addr, uptr size) {
 243   // Global data is not 64K aligned, but there are no adjacent mappings,
 244   // so we can get away with unaligned mapping.
 245   // CHECK_EQ(addr, addr & ~((64 << 10) - 1));  // windows wants 64K alignment
 246   const uptr kPageSize = GetPageSizeCached();
 247   uptr shadow_begin = RoundDownTo((uptr)MemToShadow(addr), kPageSize);
 248   uptr shadow_end = RoundUpTo((uptr)MemToShadow(addr + size), kPageSize);
 249   if (!MmapFixedNoReserve(shadow_begin, shadow_end - shadow_begin, "shadow"))
 250     Die();
 251
 252   // Meta shadow is 2:1, so tread carefully.
 253   static bool data_mapped = false;
 254   static uptr mapped_meta_end = 0;
 255   uptr meta_begin = (uptr)MemToMeta(addr);
 256   uptr meta_end = (uptr)MemToMeta(addr + size);
 257   meta_begin = RoundDownTo(meta_begin, 64 << 10);
 258   meta_end = RoundUpTo(meta_end, 64 << 10);
 259   if (!data_mapped) {
 260     // First call maps data+bss.
 261     data_mapped = true;
 262     if (!MmapFixedNoReserve(meta_begin, meta_end - meta_begin, "meta shadow"))
 263       Die();
 264   } else {
 265     // Mapping continous heap.
 266     // Windows wants 64K alignment.
 267     meta_begin = RoundDownTo(meta_begin, 64 << 10);
 268     meta_end = RoundUpTo(meta_end, 64 << 10);
 269     if (meta_end <= mapped_meta_end)
 270       return;
 271     if (meta_begin < mapped_meta_end)
 272       meta_begin = mapped_meta_end;
 273     if (!MmapFixedNoReserve(meta_begin, meta_end - meta_begin, "meta shadow"))
 274       Die();
 275     mapped_meta_end = meta_end;
 276   }
 277   VPrintf(2, "mapped meta shadow for (%p-%p) at (%p-%p)\n",
 278       addr, addr+size, meta_begin, meta_end);
 279 }
 280
 281 void MapThreadTrace(uptr addr, uptr size, const char *name) {
 282   DPrintf("#0: Mapping trace at %p-%p(0x%zx)\n", addr, addr + size, size);
 283   CHECK_GE(addr, TraceMemBeg());
 284   CHECK_LE(addr + size, TraceMemEnd());
 285   CHECK_EQ(addr, addr & ~((64 << 10) - 1));  // windows wants 64K alignment
 286   if (!MmapFixedNoReserve(addr, size, name)) {
 287     Printf("FATAL: ThreadSanitizer can not mmap thread trace (%p/%p)\n",
 288         addr, size);
 289     Die();
 290   }
 291 }
 292
 293 static void CheckShadowMapping() {
 294   uptr beg, end;
 295   for (int i = 0; GetUserRegion(i, &beg, &end); i++) {
 296     // Skip cases for empty regions (heap definition for architectures that
 297     // do not use 64-bit allocator).
 298     if (beg == end)
 299       continue;
 300     VPrintf(3, "checking shadow region %p-%p\n", beg, end);
 301     uptr prev = 0;
 302     for (uptr p0 = beg; p0 <= end; p0 += (end - beg) / 4) {
 303       for (int x = -(int)kShadowCell; x <= (int)kShadowCell; x += kShadowCell) {
 304         const uptr p = RoundDown(p0 + x, kShadowCell);
 305         if (p < beg || p >= end)
 306           continue;
 307         const uptr s = MemToShadow(p);
 308         const uptr m = (uptr)MemToMeta(p);
 309         VPrintf(3, "  checking pointer %p: shadow=%p meta=%p\n", p, s, m);
 310         CHECK(IsAppMem(p));
 311         CHECK(IsShadowMem(s));
 312         CHECK_EQ(p, ShadowToMem(s));
 313         CHECK(IsMetaMem(m));
 314         if (prev) {
 315           // Ensure that shadow and meta mappings are linear within a single
 316           // user range. Lots of code that processes memory ranges assumes it.
 317           const uptr prev_s = MemToShadow(prev);
 318           const uptr prev_m = (uptr)MemToMeta(prev);
 319           CHECK_EQ(s - prev_s, (p - prev) * kShadowMultiplier);
 320           CHECK_EQ((m - prev_m) / kMetaShadowSize,
 321                    (p - prev) / kMetaShadowCell);
 322         }
 323         prev = p;
 324       }
 325     }
 326   }
 327 }
 328
 329 #if !SANITIZER_GO
 330 static void OnStackUnwind(const SignalContext &sig, const void *,
 331                           BufferedStackTrace *stack) {
 332   uptr top = 0;
 333   uptr bottom = 0;
 334   bool fast = common_flags()->fast_unwind_on_fatal;
 335   if (fast) GetThreadStackTopAndBottom(false, &top, &bottom);
 336   stack->Unwind(kStackTraceMax, sig.pc, sig.bp, sig.context, top, bottom, fast);
 337 }
 338
 339 static void TsanOnDeadlySignal(int signo, void *siginfo, void *context) {
 340   HandleDeadlySignal(siginfo, context, GetTid(), &OnStackUnwind, nullptr);
 341 }
 342 #endif
 343
 344 void Initialize(ThreadState *thr) {
 345   // Thread safe because done before all threads exist.
 346   static bool is_initialized = false;
 347   if (is_initialized)
 348     return;
 349   is_initialized = true;
 350   // We are not ready to handle interceptors yet.
 351   ScopedIgnoreInterceptors ignore;
 352   SanitizerToolName = "ThreadSanitizer";
 353   // Install tool-specific callbacks in sanitizer_common.
 354   SetCheckFailedCallback(TsanCheckFailed);
 355
 356   ctx = new(ctx_placeholder) Context;
 357   const char *options = GetEnv(SANITIZER_GO ? "GORACE" : "TSAN_OPTIONS");
 358   CacheBinaryName();
 359   CheckASLR();
 360   InitializeFlags(&ctx->flags, options);
 361   AvoidCVE_2016_2143();
 362   InitializePlatformEarly();
 363 #if !SANITIZER_GO
 364   // Re-exec ourselves if we need to set additional env or command line args.
 365   MaybeReexec();
 366
 367   InitializeAllocator();
 368   ReplaceSystemMalloc();
 369 #endif
 370   if (common_flags()->detect_deadlocks)
 371     ctx->dd = DDetector::Create(flags());
 372   Processor *proc = ProcCreate();
 373   ProcWire(proc, thr);
 374   InitializeInterceptors();
 375   CheckShadowMapping();
 376   InitializePlatform();
 377   InitializeMutex();
 378   InitializeDynamicAnnotations();
 379 #if !SANITIZER_GO
 380   InitializeShadowMemory();
 381   InitializeAllocatorLate();
 382   InstallDeadlySignalHandlers(TsanOnDeadlySignal);
 383 #endif
 384   // Setup correct file descriptor for error reports.
 385   __sanitizer_set_report_path(common_flags()->log_path);
 386   InitializeSuppressions();
 387 #if !SANITIZER_GO
 388   InitializeLibIgnore();
 389   Symbolizer::GetOrInit()->AddHooks(EnterSymbolizer, ExitSymbolizer);
 390 #endif
 391
 392   VPrintf(1, "***** Running under ThreadSanitizer v2 (pid %d) *****\n",
 393           (int)internal_getpid());
 394
 395   // Initialize thread 0.
 396   int tid = ThreadCreate(thr, 0, 0, true);
 397   CHECK_EQ(tid, 0);
 398   ThreadStart(thr, tid, GetTid(), /*workerthread*/ false);
 399 #if TSAN_CONTAINS_UBSAN
 400   __ubsan::InitAsPlugin();
 401 #endif
 402   ctx->initialized = true;
 403
 404 #if !SANITIZER_GO
 405   Symbolizer::LateInitialize();
 406 #endif
 407
 408   if (flags()->stop_on_start) {
 409     Printf("ThreadSanitizer is suspended at startup (pid %d)."
 410            " Call __tsan_resume().\n",
 411            (int)internal_getpid());
 412     while (__tsan_resumed == 0) {}
 413   }
 414
 415   OnInitialize();
 416 }
 417
 418 void MaybeSpawnBackgroundThread() {
 419   // On MIPS, TSan initialization is run before
 420   // __pthread_initialize_minimal_internal() is finished, so we can not spawn
 421   // new threads.
 422 #if !SANITIZER_GO && !defined(__mips__)
 423   static atomic_uint32_t bg_thread = {};
 424   if (atomic_load(&bg_thread, memory_order_relaxed) == 0 &&
 425       atomic_exchange(&bg_thread, 1, memory_order_relaxed) == 0) {
 426     StartBackgroundThread();
 427     SetSandboxingCallback(StopBackgroundThread);
 428   }
 429 #endif
 430 }
 431
 432
 433 int Finalize(ThreadState *thr) {
 434   bool failed = false;
 435
 436   if (common_flags()->print_module_map == 1) PrintModuleMap();
 437
 438   if (flags()->atexit_sleep_ms > 0 && ThreadCount(thr) > 1)
 439     SleepForMillis(flags()->atexit_sleep_ms);
 440
 441   // Wait for pending reports.
 442   ctx->report_mtx.Lock();
 443   { ScopedErrorReportLock l; }
 444   ctx->report_mtx.Unlock();
 445
 446 #if !SANITIZER_GO
 447   if (Verbosity()) AllocatorPrintStats();
 448 #endif
 449
 450   ThreadFinalize(thr);
 451
 452   if (ctx->nreported) {
 453     failed = true;
 454 #if !SANITIZER_GO
 455     Printf("ThreadSanitizer: reported %d warnings\n", ctx->nreported);
 456 #else
 457     Printf("Found %d data race(s)\n", ctx->nreported);
 458 #endif
 459   }
 460
 461   if (ctx->nmissed_expected) {
 462     failed = true;
 463     Printf("ThreadSanitizer: missed %d expected races\n",
 464         ctx->nmissed_expected);
 465   }
 466
 467   if (common_flags()->print_suppressions)
 468     PrintMatchedSuppressions();
 469 #if !SANITIZER_GO
 470   if (flags()->print_benign)
 471     PrintMatchedBenignRaces();
 472 #endif
 473
 474   failed = OnFinalize(failed);
 475
 476 #if TSAN_COLLECT_STATS
 477   StatAggregate(ctx->stat, thr->stat);
 478   StatOutput(ctx->stat);
 479 #endif
 480
 481   return failed ? common_flags()->exitcode : 0;
 482 }
 483
 484 #if !SANITIZER_GO
 485 void ForkBefore(ThreadState *thr, uptr pc) {
 486   ctx->thread_registry->Lock();
 487   ctx->report_mtx.Lock();
 488 }
 489
 490 void ForkParentAfter(ThreadState *thr, uptr pc) {
 491   ctx->report_mtx.Unlock();
 492   ctx->thread_registry->Unlock();
 493 }
 494
 495 void ForkChildAfter(ThreadState *thr, uptr pc) {
 496   ctx->report_mtx.Unlock();
 497   ctx->thread_registry->Unlock();
 498
 499   uptr nthread = 0;
 500   ctx->thread_registry->GetNumberOfThreads(0, 0, &nthread /* alive threads */);
 501   VPrintf(1, "ThreadSanitizer: forked new process with pid %d,"
 502       " parent had %d threads\n", (int)internal_getpid(), (int)nthread);
 503   if (nthread == 1) {
 504     StartBackgroundThread();
 505   } else {
 506     // We've just forked a multi-threaded process. We cannot reasonably function
 507     // after that (some mutexes may be locked before fork). So just enable
 508     // ignores for everything in the hope that we will exec soon.
 509     ctx->after_multithreaded_fork = true;
 510     thr->ignore_interceptors++;
 511     ThreadIgnoreBegin(thr, pc);
 512     ThreadIgnoreSyncBegin(thr, pc);
 513   }
 514 }
 515 #endif
 516
 517 #if SANITIZER_GO
 518 NOINLINE
 519 void GrowShadowStack(ThreadState *thr) {
 520   const int sz = thr->shadow_stack_end - thr->shadow_stack;
 521   const int newsz = 2 * sz;
 522   uptr *newstack = (uptr*)internal_alloc(MBlockShadowStack,
 523       newsz * sizeof(uptr));
 524   internal_memcpy(newstack, thr->shadow_stack, sz * sizeof(uptr));
 525   internal_free(thr->shadow_stack);
 526   thr->shadow_stack = newstack;
 527   thr->shadow_stack_pos = newstack + sz;
 528   thr->shadow_stack_end = newstack + newsz;
 529 }
 530 #endif
 531
 532 u32 CurrentStackId(ThreadState *thr, uptr pc) {
 533   if (!thr->is_inited)  // May happen during bootstrap.
 534     return 0;
 535   if (pc != 0) {
 536 #if !SANITIZER_GO
 537     DCHECK_LT(thr->shadow_stack_pos, thr->shadow_stack_end);
 538 #else
 539     if (thr->shadow_stack_pos == thr->shadow_stack_end)
 540       GrowShadowStack(thr);
 541 #endif
 542     thr->shadow_stack_pos[0] = pc;
 543     thr->shadow_stack_pos++;
 544   }
 545   u32 id = StackDepotPut(
 546       StackTrace(thr->shadow_stack, thr->shadow_stack_pos - thr->shadow_stack));
 547   if (pc != 0)
 548     thr->shadow_stack_pos--;
 549   return id;
 550 }
 551
 552 void TraceSwitch(ThreadState *thr) {
 553 #if !SANITIZER_GO
 554   if (ctx->after_multithreaded_fork)
 555     return;
 556 #endif
 557   thr->nomalloc++;
 558   Trace *thr_trace = ThreadTrace(thr->tid);
 559   Lock l(&thr_trace->mtx);
 560   unsigned trace = (thr->fast_state.epoch() / kTracePartSize) % TraceParts();
 561   TraceHeader *hdr = &thr_trace->headers[trace];
 562   hdr->epoch0 = thr->fast_state.epoch();
 563   ObtainCurrentStack(thr, 0, &hdr->stack0);
 564   hdr->mset0 = thr->mset;
 565   thr->nomalloc--;
 566 }
 567
 568 Trace *ThreadTrace(int tid) {
 569   return (Trace*)GetThreadTraceHeader(tid);
 570 }
 571
 572 uptr TraceTopPC(ThreadState *thr) {
 573   Event *events = (Event*)GetThreadTrace(thr->tid);
 574   uptr pc = events[thr->fast_state.GetTracePos()];
 575   return pc;
 576 }
 577
 578 uptr TraceSize() {
 579   return (uptr)(1ull << (kTracePartSizeBits + flags()->history_size + 1));
 580 }
 581
 582 uptr TraceParts() {
 583   return TraceSize() / kTracePartSize;
 584 }
 585
 586 #if !SANITIZER_GO
 587 extern "C" void __tsan_trace_switch() {
 588   TraceSwitch(cur_thread());
 589 }
 590
 591 extern "C" void __tsan_report_race() {
 592   ReportRace(cur_thread());
 593 }
 594 #endif
 595
 596 ALWAYS_INLINE
 597 Shadow LoadShadow(u64 *p) {
 598   u64 raw = atomic_load((atomic_uint64_t*)p, memory_order_relaxed);
 599   return Shadow(raw);
 600 }
 601
 602 ALWAYS_INLINE
 603 void StoreShadow(u64 *sp, u64 s) {
 604   atomic_store((atomic_uint64_t*)sp, s, memory_order_relaxed);
 605 }
 606
 607 ALWAYS_INLINE
 608 void StoreIfNotYetStored(u64 *sp, u64 *s) {
 609   StoreShadow(sp, *s);
 610   *s = 0;
 611 }
 612
 613 ALWAYS_INLINE
 614 void HandleRace(ThreadState *thr, u64 *shadow_mem,
 615                               Shadow cur, Shadow old) {
 616   thr->racy_state[0] = cur.raw();
 617   thr->racy_state[1] = old.raw();
 618   thr->racy_shadow_addr = shadow_mem;
 619 #if !SANITIZER_GO
 620   HACKY_CALL(__tsan_report_race);
 621 #else
 622   ReportRace(thr);
 623 #endif
 624 }
 625
 626 static inline bool HappensBefore(Shadow old, ThreadState *thr) {
 627   return thr->clock.get(old.TidWithIgnore()) >= old.epoch();
 628 }
 629
 630 ALWAYS_INLINE
 631 void MemoryAccessImpl1(ThreadState *thr, uptr addr,
 632     int kAccessSizeLog, bool kAccessIsWrite, bool kIsAtomic,
 633     u64 *shadow_mem, Shadow cur) {
 634   StatInc(thr, StatMop);
 635   StatInc(thr, kAccessIsWrite ? StatMopWrite : StatMopRead);
 636   StatInc(thr, (StatType)(StatMop1 + kAccessSizeLog));
 637
 638   // This potentially can live in an MMX/SSE scratch register.
 639   // The required intrinsics are:
 640   // __m128i _mm_move_epi64(__m128i*);
 641   // _mm_storel_epi64(u64*, __m128i);
 642   u64 store_word = cur.raw();
 643
 644   // scan all the shadow values and dispatch to 4 categories:
 645   // same, replace, candidate and race (see comments below).
 646   // we consider only 3 cases regarding access sizes:
 647   // equal, intersect and not intersect. initially I considered
 648   // larger and smaller as well, it allowed to replace some
 649   // 'candidates' with 'same' or 'replace', but I think
 650   // it's just not worth it (performance- and complexity-wise).
 651
 652   Shadow old(0);
 653
 654   // It release mode we manually unroll the loop,
 655   // because empirically gcc generates better code this way.
 656   // However, we can't afford unrolling in debug mode, because the function
 657   // consumes almost 4K of stack. Gtest gives only 4K of stack to death test
 658   // threads, which is not enough for the unrolled loop.
 659 #if SANITIZER_DEBUG
 660   for (int idx = 0; idx < 4; idx++) {
 661 #include "tsan_update_shadow_word_inl.h"
 662   }
 663 #else
 664   int idx = 0;
 665 #include "tsan_update_shadow_word_inl.h"
 666   idx = 1;
 667 #include "tsan_update_shadow_word_inl.h"
 668   idx = 2;
 669 #include "tsan_update_shadow_word_inl.h"
 670   idx = 3;
 671 #include "tsan_update_shadow_word_inl.h"
 672 #endif
 673
 674   // we did not find any races and had already stored
 675   // the current access info, so we are done
 676   if (LIKELY(store_word == 0))
 677     return;
 678   // choose a random candidate slot and replace it
 679   StoreShadow(shadow_mem + (cur.epoch() % kShadowCnt), store_word);
 680   StatInc(thr, StatShadowReplace);
 681   return;
 682  RACE:
 683   HandleRace(thr, shadow_mem, cur, old);
 684   return;
 685 }
 686
 687 void UnalignedMemoryAccess(ThreadState *thr, uptr pc, uptr addr,
 688     int size, bool kAccessIsWrite, bool kIsAtomic) {
 689   while (size) {
 690     int size1 = 1;
 691     int kAccessSizeLog = kSizeLog1;
 692     if (size >= 8 && (addr & ~7) == ((addr + 7) & ~7)) {
 693       size1 = 8;
 694       kAccessSizeLog = kSizeLog8;
 695     } else if (size >= 4 && (addr & ~7) == ((addr + 3) & ~7)) {
 696       size1 = 4;
 697       kAccessSizeLog = kSizeLog4;
 698     } else if (size >= 2 && (addr & ~7) == ((addr + 1) & ~7)) {
 699       size1 = 2;
 700       kAccessSizeLog = kSizeLog2;
 701     }
 702     MemoryAccess(thr, pc, addr, kAccessSizeLog, kAccessIsWrite, kIsAtomic);
 703     addr += size1;
 704     size -= size1;
 705   }
 706 }
 707
 708 ALWAYS_INLINE
 709 bool ContainsSameAccessSlow(u64 *s, u64 a, u64 sync_epoch, bool is_write) {
 710   Shadow cur(a);
 711   for (uptr i = 0; i < kShadowCnt; i++) {
 712     Shadow old(LoadShadow(&s[i]));
 713     if (Shadow::Addr0AndSizeAreEqual(cur, old) &&
 714         old.TidWithIgnore() == cur.TidWithIgnore() &&
 715         old.epoch() > sync_epoch &&
 716         old.IsAtomic() == cur.IsAtomic() &&
 717         old.IsRead() <= cur.IsRead())
 718       return true;
 719   }
 720   return false;
 721 }
 722
 723 #if defined(__SSE3__)
 724 #define SHUF(v0, v1, i0, i1, i2, i3) _mm_castps_si128(_mm_shuffle_ps( \
 725     _mm_castsi128_ps(v0), _mm_castsi128_ps(v1), \
 726     (i0)*1 + (i1)*4 + (i2)*16 + (i3)*64))
 727 ALWAYS_INLINE
 728 bool ContainsSameAccessFast(u64 *s, u64 a, u64 sync_epoch, bool is_write) {
 729   // This is an optimized version of ContainsSameAccessSlow.
 730   // load current access into access[0:63]
 731   const m128 access     = _mm_cvtsi64_si128(a);
 732   // duplicate high part of access in addr0:
 733   // addr0[0:31]        = access[32:63]
 734   // addr0[32:63]       = access[32:63]
 735   // addr0[64:95]       = access[32:63]
 736   // addr0[96:127]      = access[32:63]
 737   const m128 addr0      = SHUF(access, access, 1, 1, 1, 1);
 738   // load 4 shadow slots
 739   const m128 shadow0    = _mm_load_si128((__m128i*)s);
 740   const m128 shadow1    = _mm_load_si128((__m128i*)s + 1);
 741   // load high parts of 4 shadow slots into addr_vect:
 742   // addr_vect[0:31]    = shadow0[32:63]
 743   // addr_vect[32:63]   = shadow0[96:127]
 744   // addr_vect[64:95]   = shadow1[32:63]
 745   // addr_vect[96:127]  = shadow1[96:127]
 746   m128 addr_vect        = SHUF(shadow0, shadow1, 1, 3, 1, 3);
 747   if (!is_write) {
 748     // set IsRead bit in addr_vect
 749     const m128 rw_mask1 = _mm_cvtsi64_si128(1<<15);
 750     const m128 rw_mask  = SHUF(rw_mask1, rw_mask1, 0, 0, 0, 0);
 751     addr_vect           = _mm_or_si128(addr_vect, rw_mask);
 752   }
 753   // addr0 == addr_vect?
 754   const m128 addr_res   = _mm_cmpeq_epi32(addr0, addr_vect);
 755   // epoch1[0:63]       = sync_epoch
 756   const m128 epoch1     = _mm_cvtsi64_si128(sync_epoch);
 757   // epoch[0:31]        = sync_epoch[0:31]
 758   // epoch[32:63]       = sync_epoch[0:31]
 759   // epoch[64:95]       = sync_epoch[0:31]
 760   // epoch[96:127]      = sync_epoch[0:31]
 761   const m128 epoch      = SHUF(epoch1, epoch1, 0, 0, 0, 0);
 762   // load low parts of shadow cell epochs into epoch_vect:
 763   // epoch_vect[0:31]   = shadow0[0:31]
 764   // epoch_vect[32:63]  = shadow0[64:95]
 765   // epoch_vect[64:95]  = shadow1[0:31]
 766   // epoch_vect[96:127] = shadow1[64:95]
 767   const m128 epoch_vect = SHUF(shadow0, shadow1, 0, 2, 0, 2);
 768   // epoch_vect >= sync_epoch?
 769   const m128 epoch_res  = _mm_cmpgt_epi32(epoch_vect, epoch);
 770   // addr_res & epoch_res
 771   const m128 res        = _mm_and_si128(addr_res, epoch_res);
 772   // mask[0] = res[7]
 773   // mask[1] = res[15]
 774   // ...
 775   // mask[15] = res[127]
 776   const int mask        = _mm_movemask_epi8(res);
 777   return mask != 0;
 778 }
 779 #endif
 780
 781 ALWAYS_INLINE
 782 bool ContainsSameAccess(u64 *s, u64 a, u64 sync_epoch, bool is_write) {
 783 #if defined(__SSE3__)
 784   bool res = ContainsSameAccessFast(s, a, sync_epoch, is_write);
 785   // NOTE: this check can fail if the shadow is concurrently mutated
 786   // by other threads. But it still can be useful if you modify
 787   // ContainsSameAccessFast and want to ensure that it's not completely broken.
 788   // DCHECK_EQ(res, ContainsSameAccessSlow(s, a, sync_epoch, is_write));
 789   return res;
 790 #else
 791   return ContainsSameAccessSlow(s, a, sync_epoch, is_write);
 792 #endif
 793 }
 794
 795 ALWAYS_INLINE USED
 796 void MemoryAccess(ThreadState *thr, uptr pc, uptr addr,
 797     int kAccessSizeLog, bool kAccessIsWrite, bool kIsAtomic) {
 798   u64 *shadow_mem = (u64*)MemToShadow(addr);
 799   DPrintf2("#%d: MemoryAccess: @%p %p size=%d"
 800       " is_write=%d shadow_mem=%p {%zx, %zx, %zx, %zx}\n",
 801       (int)thr->fast_state.tid(), (void*)pc, (void*)addr,
 802       (int)(1 << kAccessSizeLog), kAccessIsWrite, shadow_mem,
 803       (uptr)shadow_mem[0], (uptr)shadow_mem[1],
 804       (uptr)shadow_mem[2], (uptr)shadow_mem[3]);
 805 #if SANITIZER_DEBUG
 806   if (!IsAppMem(addr)) {
 807     Printf("Access to non app mem %zx\n", addr);
 808     DCHECK(IsAppMem(addr));
 809   }
 810   if (!IsShadowMem((uptr)shadow_mem)) {
 811     Printf("Bad shadow addr %p (%zx)\n", shadow_mem, addr);
 812     DCHECK(IsShadowMem((uptr)shadow_mem));
 813   }
 814 #endif
 815
 816   if (!SANITIZER_GO && *shadow_mem == kShadowRodata) {
 817     // Access to .rodata section, no races here.
 818     // Measurements show that it can be 10-20% of all memory accesses.
 819     StatInc(thr, StatMop);
 820     StatInc(thr, kAccessIsWrite ? StatMopWrite : StatMopRead);
 821     StatInc(thr, (StatType)(StatMop1 + kAccessSizeLog));
 822     StatInc(thr, StatMopRodata);
 823     return;
 824   }
 825
 826   FastState fast_state = thr->fast_state;
 827   if (fast_state.GetIgnoreBit()) {
 828     StatInc(thr, StatMop);
 829     StatInc(thr, kAccessIsWrite ? StatMopWrite : StatMopRead);
 830     StatInc(thr, (StatType)(StatMop1 + kAccessSizeLog));
 831     StatInc(thr, StatMopIgnored);
 832     return;
 833   }
 834
 835   Shadow cur(fast_state);
 836   cur.SetAddr0AndSizeLog(addr & 7, kAccessSizeLog);
 837   cur.SetWrite(kAccessIsWrite);
 838   cur.SetAtomic(kIsAtomic);
 839
 840   if (LIKELY(ContainsSameAccess(shadow_mem, cur.raw(),
 841       thr->fast_synch_epoch, kAccessIsWrite))) {
 842     StatInc(thr, StatMop);
 843     StatInc(thr, kAccessIsWrite ? StatMopWrite : StatMopRead);
 844     StatInc(thr, (StatType)(StatMop1 + kAccessSizeLog));
 845     StatInc(thr, StatMopSame);
 846     return;
 847   }
 848
 849   if (kCollectHistory) {
 850     fast_state.IncrementEpoch();
 851     thr->fast_state = fast_state;
 852     TraceAddEvent(thr, fast_state, EventTypeMop, pc);
 853     cur.IncrementEpoch();
 854   }
 855
 856   MemoryAccessImpl1(thr, addr, kAccessSizeLog, kAccessIsWrite, kIsAtomic,
 857       shadow_mem, cur);
 858 }
 859
 860 // Called by MemoryAccessRange in tsan_rtl_thread.cc
 861 ALWAYS_INLINE USED
 862 void MemoryAccessImpl(ThreadState *thr, uptr addr,
 863     int kAccessSizeLog, bool kAccessIsWrite, bool kIsAtomic,
 864     u64 *shadow_mem, Shadow cur) {
 865   if (LIKELY(ContainsSameAccess(shadow_mem, cur.raw(),
 866       thr->fast_synch_epoch, kAccessIsWrite))) {
 867     StatInc(thr, StatMop);
 868     StatInc(thr, kAccessIsWrite ? StatMopWrite : StatMopRead);
 869     StatInc(thr, (StatType)(StatMop1 + kAccessSizeLog));
 870     StatInc(thr, StatMopSame);
 871     return;
 872   }
 873
 874   MemoryAccessImpl1(thr, addr, kAccessSizeLog, kAccessIsWrite, kIsAtomic,
 875       shadow_mem, cur);
 876 }
 877
 878 static void MemoryRangeSet(ThreadState *thr, uptr pc, uptr addr, uptr size,
 879                            u64 val) {
 880   (void)thr;
 881   (void)pc;
 882   if (size == 0)
 883     return;
 884   // FIXME: fix me.
 885   uptr offset = addr % kShadowCell;
 886   if (offset) {
 887     offset = kShadowCell - offset;
 888     if (size <= offset)
 889       return;
 890     addr += offset;
 891     size -= offset;
 892   }
 893   DCHECK_EQ(addr % 8, 0);
 894   // If a user passes some insane arguments (memset(0)),
 895   // let it just crash as usual.
 896   if (!IsAppMem(addr) || !IsAppMem(addr + size - 1))
 897     return;
 898   // Don't want to touch lots of shadow memory.
 899   // If a program maps 10MB stack, there is no need reset the whole range.
 900   size = (size + (kShadowCell - 1)) & ~(kShadowCell - 1);
 901   // UnmapOrDie/MmapFixedNoReserve does not work on Windows.
 902   if (SANITIZER_WINDOWS || size < common_flags()->clear_shadow_mmap_threshold) {
 903     u64 *p = (u64*)MemToShadow(addr);
 904     CHECK(IsShadowMem((uptr)p));
 905     CHECK(IsShadowMem((uptr)(p + size * kShadowCnt / kShadowCell - 1)));
 906     // FIXME: may overwrite a part outside the region
 907     for (uptr i = 0; i < size / kShadowCell * kShadowCnt;) {
 908       p[i++] = val;
 909       for (uptr j = 1; j < kShadowCnt; j++)
 910         p[i++] = 0;
 911     }
 912   } else {
 913     // The region is big, reset only beginning and end.
 914     const uptr kPageSize = GetPageSizeCached();
 915     u64 *begin = (u64*)MemToShadow(addr);
 916     u64 *end = begin + size / kShadowCell * kShadowCnt;
 917     u64 *p = begin;
 918     // Set at least first kPageSize/2 to page boundary.
 919     while ((p < begin + kPageSize / kShadowSize / 2) || ((uptr)p % kPageSize)) {
 920       *p++ = val;
 921       for (uptr j = 1; j < kShadowCnt; j++)
 922         *p++ = 0;
 923     }
 924     // Reset middle part.
 925     u64 *p1 = p;
 926     p = RoundDown(end, kPageSize);
 927     UnmapOrDie((void*)p1, (uptr)p - (uptr)p1);
 928     if (!MmapFixedNoReserve((uptr)p1, (uptr)p - (uptr)p1))
 929       Die();
 930     // Set the ending.
 931     while (p < end) {
 932       *p++ = val;
 933       for (uptr j = 1; j < kShadowCnt; j++)
 934         *p++ = 0;
 935     }
 936   }
 937 }
 938
 939 void MemoryResetRange(ThreadState *thr, uptr pc, uptr addr, uptr size) {
 940   MemoryRangeSet(thr, pc, addr, size, 0);
 941 }
 942
 943 void MemoryRangeFreed(ThreadState *thr, uptr pc, uptr addr, uptr size) {
 944   // Processing more than 1k (4k of shadow) is expensive,
 945   // can cause excessive memory consumption (user does not necessary touch
 946   // the whole range) and most likely unnecessary.
 947   if (size > 1024)
 948     size = 1024;
 949   CHECK_EQ(thr->is_freeing, false);
 950   thr->is_freeing = true;
 951   MemoryAccessRange(thr, pc, addr, size, true);
 952   thr->is_freeing = false;
 953   if (kCollectHistory) {
 954     thr->fast_state.IncrementEpoch();
 955     TraceAddEvent(thr, thr->fast_state, EventTypeMop, pc);
 956   }
 957   Shadow s(thr->fast_state);
 958   s.ClearIgnoreBit();
 959   s.MarkAsFreed();
 960   s.SetWrite(true);
 961   s.SetAddr0AndSizeLog(0, 3);
 962   MemoryRangeSet(thr, pc, addr, size, s.raw());
 963 }
 964
 965 void MemoryRangeImitateWrite(ThreadState *thr, uptr pc, uptr addr, uptr size) {
 966   if (kCollectHistory) {
 967     thr->fast_state.IncrementEpoch();
 968     TraceAddEvent(thr, thr->fast_state, EventTypeMop, pc);
 969   }
 970   Shadow s(thr->fast_state);
 971   s.ClearIgnoreBit();
 972   s.SetWrite(true);
 973   s.SetAddr0AndSizeLog(0, 3);
 974   MemoryRangeSet(thr, pc, addr, size, s.raw());
 975 }
 976
 977 ALWAYS_INLINE USED
 978 void FuncEntry(ThreadState *thr, uptr pc) {
 979   StatInc(thr, StatFuncEnter);
 980   DPrintf2("#%d: FuncEntry %p\n", (int)thr->fast_state.tid(), (void*)pc);
 981   if (kCollectHistory) {
 982     thr->fast_state.IncrementEpoch();
 983     TraceAddEvent(thr, thr->fast_state, EventTypeFuncEnter, pc);
 984   }
 985
 986   // Shadow stack maintenance can be replaced with
 987   // stack unwinding during trace switch (which presumably must be faster).
 988   DCHECK_GE(thr->shadow_stack_pos, thr->shadow_stack);
 989 #if !SANITIZER_GO
 990   DCHECK_LT(thr->shadow_stack_pos, thr->shadow_stack_end);
 991 #else
 992   if (thr->shadow_stack_pos == thr->shadow_stack_end)
 993     GrowShadowStack(thr);
 994 #endif
 995   thr->shadow_stack_pos[0] = pc;
 996   thr->shadow_stack_pos++;
 997 }
 998
 999 ALWAYS_INLINE USED
1000 void FuncExit(ThreadState *thr) {
1001   StatInc(thr, StatFuncExit);
1002   DPrintf2("#%d: FuncExit\n", (int)thr->fast_state.tid());
1003   if (kCollectHistory) {
1004     thr->fast_state.IncrementEpoch();
1005     TraceAddEvent(thr, thr->fast_state, EventTypeFuncExit, 0);
1006   }
1007
1008   DCHECK_GT(thr->shadow_stack_pos, thr->shadow_stack);
1009 #if !SANITIZER_GO
1010   DCHECK_LT(thr->shadow_stack_pos, thr->shadow_stack_end);
1011 #endif
1012   thr->shadow_stack_pos--;
1013 }
1014
1015 void ThreadIgnoreBegin(ThreadState *thr, uptr pc, bool save_stack) {
1016   DPrintf("#%d: ThreadIgnoreBegin\n", thr->tid);
1017   thr->ignore_reads_and_writes++;
1018   CHECK_GT(thr->ignore_reads_and_writes, 0);
1019   thr->fast_state.SetIgnoreBit();
1020 #if !SANITIZER_GO
1021   if (save_stack && !ctx->after_multithreaded_fork)
1022     thr->mop_ignore_set.Add(CurrentStackId(thr, pc));
1023 #endif
1024 }
1025
1026 void ThreadIgnoreEnd(ThreadState *thr, uptr pc) {
1027   DPrintf("#%d: ThreadIgnoreEnd\n", thr->tid);
1028   CHECK_GT(thr->ignore_reads_and_writes, 0);
1029   thr->ignore_reads_and_writes--;
1030   if (thr->ignore_reads_and_writes == 0) {
1031     thr->fast_state.ClearIgnoreBit();
1032 #if !SANITIZER_GO
1033     thr->mop_ignore_set.Reset();
1034 #endif
1035   }
1036 }
1037
1038 #if !SANITIZER_GO
1039 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
1040 uptr __tsan_testonly_shadow_stack_current_size() {
1041   ThreadState *thr = cur_thread();
1042   return thr->shadow_stack_pos - thr->shadow_stack;
1043 }
1044 #endif
1045
1046 void ThreadIgnoreSyncBegin(ThreadState *thr, uptr pc, bool save_stack) {
1047   DPrintf("#%d: ThreadIgnoreSyncBegin\n", thr->tid);
1048   thr->ignore_sync++;
1049   CHECK_GT(thr->ignore_sync, 0);
1050 #if !SANITIZER_GO
1051   if (save_stack && !ctx->after_multithreaded_fork)
1052     thr->sync_ignore_set.Add(CurrentStackId(thr, pc));
1053 #endif
1054 }
1055
1056 void ThreadIgnoreSyncEnd(ThreadState *thr, uptr pc) {
1057   DPrintf("#%d: ThreadIgnoreSyncEnd\n", thr->tid);
1058   CHECK_GT(thr->ignore_sync, 0);
1059   thr->ignore_sync--;
1060 #if !SANITIZER_GO
1061   if (thr->ignore_sync == 0)
1062     thr->sync_ignore_set.Reset();
1063 #endif
1064 }
1065
1066 bool MD5Hash::operator==(const MD5Hash &other) const {
1067   return hash[0] == other.hash[0] && hash[1] == other.hash[1];
1068 }
1069
1070 #if SANITIZER_DEBUG
1071 void build_consistency_debug() {}
1072 #else
1073 void build_consistency_release() {}
1074 #endif
1075
1076 #if TSAN_COLLECT_STATS
1077 void build_consistency_stats() {}
1078 #else
1079 void build_consistency_nostats() {}
1080 #endif
1081
1082 }  // namespace __tsan
1083
1084 #if !SANITIZER_GO
1085 // Must be included in this file to make sure everything is inlined.
1086 #include "tsan_interface_inl.h"
1087 #endif