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

   1 //===-- tsan_rtl_thread.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_placement_new.h"
  15 #include "tsan_rtl.h"
  16 #include "tsan_mman.h"
  17 #include "tsan_platform.h"
  18 #include "tsan_report.h"
  19 #include "tsan_sync.h"
  20
  21 namespace __tsan {
  22
  23 // ThreadContext implementation.
  24
  25 ThreadContext::ThreadContext(int tid)
  26   : ThreadContextBase(tid)
  27   , thr()
  28   , sync()
  29   , epoch0()
  30   , epoch1() {
  31 }
  32
  33 #ifndef SANITIZER_GO
  34 ThreadContext::~ThreadContext() {
  35 }
  36 #endif
  37
  38 void ThreadContext::OnDead() {
  39   CHECK_EQ(sync.size(), 0);
  40 }
  41
  42 void ThreadContext::OnJoined(void *arg) {
  43   ThreadState *caller_thr = static_cast<ThreadState *>(arg);
  44   AcquireImpl(caller_thr, 0, &sync);
  45   sync.Reset(&caller_thr->clock_cache);
  46 }
  47
  48 struct OnCreatedArgs {
  49   ThreadState *thr;
  50   uptr pc;
  51 };
  52
  53 void ThreadContext::OnCreated(void *arg) {
  54   thr = 0;
  55   if (tid == 0)
  56     return;
  57   OnCreatedArgs *args = static_cast<OnCreatedArgs *>(arg);
  58   args->thr->fast_state.IncrementEpoch();
  59   // Can't increment epoch w/o writing to the trace as well.
  60   TraceAddEvent(args->thr, args->thr->fast_state, EventTypeMop, 0);
  61   ReleaseImpl(args->thr, 0, &sync);
  62   creation_stack_id = CurrentStackId(args->thr, args->pc);
  63   if (reuse_count == 0)
  64     StatInc(args->thr, StatThreadMaxTid);
  65 }
  66
  67 void ThreadContext::OnReset() {
  68   CHECK_EQ(sync.size(), 0);
  69   FlushUnneededShadowMemory(GetThreadTrace(tid), TraceSize() * sizeof(Event));
  70   //!!! FlushUnneededShadowMemory(GetThreadTraceHeader(tid), sizeof(Trace));
  71 }
  72
  73 void ThreadContext::OnDetached(void *arg) {
  74   ThreadState *thr1 = static_cast<ThreadState*>(arg);
  75   sync.Reset(&thr1->clock_cache);
  76 }
  77
  78 struct OnStartedArgs {
  79   ThreadState *thr;
  80   uptr stk_addr;
  81   uptr stk_size;
  82   uptr tls_addr;
  83   uptr tls_size;
  84 };
  85
  86 void ThreadContext::OnStarted(void *arg) {
  87   OnStartedArgs *args = static_cast<OnStartedArgs*>(arg);
  88   thr = args->thr;
  89   // RoundUp so that one trace part does not contain events
  90   // from different threads.
  91   epoch0 = RoundUp(epoch1 + 1, kTracePartSize);
  92   epoch1 = (u64)-1;
  93   new(thr) ThreadState(ctx, tid, unique_id, epoch0, reuse_count,
  94       args->stk_addr, args->stk_size, args->tls_addr, args->tls_size);
  95 #ifndef SANITIZER_GO
  96   thr->shadow_stack = &ThreadTrace(thr->tid)->shadow_stack[0];
  97   thr->shadow_stack_pos = thr->shadow_stack;
  98   thr->shadow_stack_end = thr->shadow_stack + kShadowStackSize;
  99 #else
 100   // Setup dynamic shadow stack.
 101   const int kInitStackSize = 8;
 102   thr->shadow_stack = (uptr*)internal_alloc(MBlockShadowStack,
 103       kInitStackSize * sizeof(uptr));
 104   thr->shadow_stack_pos = thr->shadow_stack;
 105   thr->shadow_stack_end = thr->shadow_stack + kInitStackSize;
 106 #endif
 107 #ifndef SANITIZER_GO
 108   AllocatorThreadStart(thr);
 109 #endif
 110   if (common_flags()->detect_deadlocks) {
 111     thr->dd_pt = ctx->dd->CreatePhysicalThread();
 112     thr->dd_lt = ctx->dd->CreateLogicalThread(unique_id);
 113   }
 114   thr->fast_state.SetHistorySize(flags()->history_size);
 115   // Commit switch to the new part of the trace.
 116   // TraceAddEvent will reset stack0/mset0 in the new part for us.
 117   TraceAddEvent(thr, thr->fast_state, EventTypeMop, 0);
 118
 119   thr->fast_synch_epoch = epoch0;
 120   AcquireImpl(thr, 0, &sync);
 121   StatInc(thr, StatSyncAcquire);
 122   sync.Reset(&thr->clock_cache);
 123   DPrintf("#%d: ThreadStart epoch=%zu stk_addr=%zx stk_size=%zx "
 124           "tls_addr=%zx tls_size=%zx\n",
 125           tid, (uptr)epoch0, args->stk_addr, args->stk_size,
 126           args->tls_addr, args->tls_size);
 127 }
 128
 129 void ThreadContext::OnFinished() {
 130   if (!detached) {
 131     thr->fast_state.IncrementEpoch();
 132     // Can't increment epoch w/o writing to the trace as well.
 133     TraceAddEvent(thr, thr->fast_state, EventTypeMop, 0);
 134     ReleaseImpl(thr, 0, &sync);
 135   }
 136   epoch1 = thr->fast_state.epoch();
 137
 138   if (common_flags()->detect_deadlocks) {
 139     ctx->dd->DestroyPhysicalThread(thr->dd_pt);
 140     ctx->dd->DestroyLogicalThread(thr->dd_lt);
 141   }
 142   ctx->clock_alloc.FlushCache(&thr->clock_cache);
 143   ctx->metamap.OnThreadIdle(thr);
 144 #ifndef SANITIZER_GO
 145   AllocatorThreadFinish(thr);
 146 #endif
 147   thr->~ThreadState();
 148 #if TSAN_COLLECT_STATS
 149   StatAggregate(ctx->stat, thr->stat);
 150 #endif
 151   thr = 0;
 152 }
 153
 154 #ifndef SANITIZER_GO
 155 struct ThreadLeak {
 156   ThreadContext *tctx;
 157   int count;
 158 };
 159
 160 static void MaybeReportThreadLeak(ThreadContextBase *tctx_base, void *arg) {
 161   Vector<ThreadLeak> &leaks = *(Vector<ThreadLeak>*)arg;
 162   ThreadContext *tctx = static_cast<ThreadContext*>(tctx_base);
 163   if (tctx->detached || tctx->status != ThreadStatusFinished)
 164     return;
 165   for (uptr i = 0; i < leaks.Size(); i++) {
 166     if (leaks[i].tctx->creation_stack_id == tctx->creation_stack_id) {
 167       leaks[i].count++;
 168       return;
 169     }
 170   }
 171   ThreadLeak leak = {tctx, 1};
 172   leaks.PushBack(leak);
 173 }
 174 #endif
 175
 176 #ifndef SANITIZER_GO
 177 static void ReportIgnoresEnabled(ThreadContext *tctx, IgnoreSet *set) {
 178   if (tctx->tid == 0) {
 179     Printf("ThreadSanitizer: main thread finished with ignores enabled\n");
 180   } else {
 181     Printf("ThreadSanitizer: thread T%d %s finished with ignores enabled,"
 182       " created at:\n", tctx->tid, tctx->name);
 183     PrintStack(SymbolizeStackId(tctx->creation_stack_id));
 184   }
 185   Printf("  One of the following ignores was not ended"
 186       " (in order of probability)\n");
 187   for (uptr i = 0; i < set->Size(); i++) {
 188     Printf("  Ignore was enabled at:\n");
 189     PrintStack(SymbolizeStackId(set->At(i)));
 190   }
 191   Die();
 192 }
 193
 194 static void ThreadCheckIgnore(ThreadState *thr) {
 195   if (ctx->after_multithreaded_fork)
 196     return;
 197   if (thr->ignore_reads_and_writes)
 198     ReportIgnoresEnabled(thr->tctx, &thr->mop_ignore_set);
 199   if (thr->ignore_sync)
 200     ReportIgnoresEnabled(thr->tctx, &thr->sync_ignore_set);
 201 }
 202 #else
 203 static void ThreadCheckIgnore(ThreadState *thr) {}
 204 #endif
 205
 206 void ThreadFinalize(ThreadState *thr) {
 207   ThreadCheckIgnore(thr);
 208 #ifndef SANITIZER_GO
 209   if (!flags()->report_thread_leaks)
 210     return;
 211   ThreadRegistryLock l(ctx->thread_registry);
 212   Vector<ThreadLeak> leaks(MBlockScopedBuf);
 213   ctx->thread_registry->RunCallbackForEachThreadLocked(
 214       MaybeReportThreadLeak, &leaks);
 215   for (uptr i = 0; i < leaks.Size(); i++) {
 216     ScopedReport rep(ReportTypeThreadLeak);
 217     rep.AddThread(leaks[i].tctx, true);
 218     rep.SetCount(leaks[i].count);
 219     OutputReport(thr, rep);
 220   }
 221 #endif
 222 }
 223
 224 int ThreadCount(ThreadState *thr) {
 225   uptr result;
 226   ctx->thread_registry->GetNumberOfThreads(0, 0, &result);
 227   return (int)result;
 228 }
 229
 230 int ThreadCreate(ThreadState *thr, uptr pc, uptr uid, bool detached) {
 231   StatInc(thr, StatThreadCreate);
 232   OnCreatedArgs args = { thr, pc };
 233   int tid = ctx->thread_registry->CreateThread(uid, detached, thr->tid, &args);
 234   DPrintf("#%d: ThreadCreate tid=%d uid=%zu\n", thr->tid, tid, uid);
 235   StatSet(thr, StatThreadMaxAlive, ctx->thread_registry->GetMaxAliveThreads());
 236   return tid;
 237 }
 238
 239 void ThreadStart(ThreadState *thr, int tid, uptr os_id) {
 240   uptr stk_addr = 0;
 241   uptr stk_size = 0;
 242   uptr tls_addr = 0;
 243   uptr tls_size = 0;
 244 #ifndef SANITIZER_GO
 245   GetThreadStackAndTls(tid == 0, &stk_addr, &stk_size, &tls_addr, &tls_size);
 246
 247   if (tid) {
 248     if (stk_addr && stk_size)
 249       MemoryRangeImitateWrite(thr, /*pc=*/ 1, stk_addr, stk_size);
 250
 251     if (tls_addr && tls_size) {
 252       // Check that the thr object is in tls;
 253       const uptr thr_beg = (uptr)thr;
 254       const uptr thr_end = (uptr)thr + sizeof(*thr);
 255       CHECK_GE(thr_beg, tls_addr);
 256       CHECK_LE(thr_beg, tls_addr + tls_size);
 257       CHECK_GE(thr_end, tls_addr);
 258       CHECK_LE(thr_end, tls_addr + tls_size);
 259       // Since the thr object is huge, skip it.
 260       MemoryRangeImitateWrite(thr, /*pc=*/ 2, tls_addr, thr_beg - tls_addr);
 261       MemoryRangeImitateWrite(thr, /*pc=*/ 2,
 262           thr_end, tls_addr + tls_size - thr_end);
 263     }
 264   }
 265 #endif
 266
 267   ThreadRegistry *tr = ctx->thread_registry;
 268   OnStartedArgs args = { thr, stk_addr, stk_size, tls_addr, tls_size };
 269   tr->StartThread(tid, os_id, &args);
 270
 271   tr->Lock();
 272   thr->tctx = (ThreadContext*)tr->GetThreadLocked(tid);
 273   tr->Unlock();
 274
 275 #ifndef SANITIZER_GO
 276   if (ctx->after_multithreaded_fork) {
 277     thr->ignore_interceptors++;
 278     ThreadIgnoreBegin(thr, 0);
 279     ThreadIgnoreSyncBegin(thr, 0);
 280   }
 281 #endif
 282 }
 283
 284 void ThreadFinish(ThreadState *thr) {
 285   ThreadCheckIgnore(thr);
 286   StatInc(thr, StatThreadFinish);
 287   if (thr->stk_addr && thr->stk_size)
 288     DontNeedShadowFor(thr->stk_addr, thr->stk_size);
 289   if (thr->tls_addr && thr->tls_size)
 290     DontNeedShadowFor(thr->tls_addr, thr->tls_size);
 291   thr->is_dead = true;
 292   ctx->thread_registry->FinishThread(thr->tid);
 293 }
 294
 295 static bool FindThreadByUid(ThreadContextBase *tctx, void *arg) {
 296   uptr uid = (uptr)arg;
 297   if (tctx->user_id == uid && tctx->status != ThreadStatusInvalid) {
 298     tctx->user_id = 0;
 299     return true;
 300   }
 301   return false;
 302 }
 303
 304 int ThreadTid(ThreadState *thr, uptr pc, uptr uid) {
 305   int res = ctx->thread_registry->FindThread(FindThreadByUid, (void*)uid);
 306   DPrintf("#%d: ThreadTid uid=%zu tid=%d\n", thr->tid, uid, res);
 307   return res;
 308 }
 309
 310 void ThreadJoin(ThreadState *thr, uptr pc, int tid) {
 311   CHECK_GT(tid, 0);
 312   CHECK_LT(tid, kMaxTid);
 313   DPrintf("#%d: ThreadJoin tid=%d\n", thr->tid, tid);
 314   ctx->thread_registry->JoinThread(tid, thr);
 315 }
 316
 317 void ThreadDetach(ThreadState *thr, uptr pc, int tid) {
 318   CHECK_GT(tid, 0);
 319   CHECK_LT(tid, kMaxTid);
 320   ctx->thread_registry->DetachThread(tid, thr);
 321 }
 322
 323 void ThreadSetName(ThreadState *thr, const char *name) {
 324   ctx->thread_registry->SetThreadName(thr->tid, name);
 325 }
 326
 327 void MemoryAccessRange(ThreadState *thr, uptr pc, uptr addr,
 328                        uptr size, bool is_write) {
 329   if (size == 0)
 330     return;
 331
 332   u64 *shadow_mem = (u64*)MemToShadow(addr);
 333   DPrintf2("#%d: MemoryAccessRange: @%p %p size=%d is_write=%d\n",
 334       thr->tid, (void*)pc, (void*)addr,
 335       (int)size, is_write);
 336
 337 #if SANITIZER_DEBUG
 338   if (!IsAppMem(addr)) {
 339     Printf("Access to non app mem %zx\n", addr);
 340     DCHECK(IsAppMem(addr));
 341   }
 342   if (!IsAppMem(addr + size - 1)) {
 343     Printf("Access to non app mem %zx\n", addr + size - 1);
 344     DCHECK(IsAppMem(addr + size - 1));
 345   }
 346   if (!IsShadowMem((uptr)shadow_mem)) {
 347     Printf("Bad shadow addr %p (%zx)\n", shadow_mem, addr);
 348     DCHECK(IsShadowMem((uptr)shadow_mem));
 349   }
 350   if (!IsShadowMem((uptr)(shadow_mem + size * kShadowCnt / 8 - 1))) {
 351     Printf("Bad shadow addr %p (%zx)\n",
 352                shadow_mem + size * kShadowCnt / 8 - 1, addr + size - 1);
 353     DCHECK(IsShadowMem((uptr)(shadow_mem + size * kShadowCnt / 8 - 1)));
 354   }
 355 #endif
 356
 357   StatInc(thr, StatMopRange);
 358
 359   if (*shadow_mem == kShadowRodata) {
 360     // Access to .rodata section, no races here.
 361     // Measurements show that it can be 10-20% of all memory accesses.
 362     StatInc(thr, StatMopRangeRodata);
 363     return;
 364   }
 365
 366   FastState fast_state = thr->fast_state;
 367   if (fast_state.GetIgnoreBit())
 368     return;
 369
 370   fast_state.IncrementEpoch();
 371   thr->fast_state = fast_state;
 372   TraceAddEvent(thr, fast_state, EventTypeMop, pc);
 373
 374   bool unaligned = (addr % kShadowCell) != 0;
 375
 376   // Handle unaligned beginning, if any.
 377   for (; addr % kShadowCell && size; addr++, size--) {
 378     int const kAccessSizeLog = 0;
 379     Shadow cur(fast_state);
 380     cur.SetWrite(is_write);
 381     cur.SetAddr0AndSizeLog(addr & (kShadowCell - 1), kAccessSizeLog);
 382     MemoryAccessImpl(thr, addr, kAccessSizeLog, is_write, false,
 383         shadow_mem, cur);
 384   }
 385   if (unaligned)
 386     shadow_mem += kShadowCnt;
 387   // Handle middle part, if any.
 388   for (; size >= kShadowCell; addr += kShadowCell, size -= kShadowCell) {
 389     int const kAccessSizeLog = 3;
 390     Shadow cur(fast_state);
 391     cur.SetWrite(is_write);
 392     cur.SetAddr0AndSizeLog(0, kAccessSizeLog);
 393     MemoryAccessImpl(thr, addr, kAccessSizeLog, is_write, false,
 394         shadow_mem, cur);
 395     shadow_mem += kShadowCnt;
 396   }
 397   // Handle ending, if any.
 398   for (; size; addr++, size--) {
 399     int const kAccessSizeLog = 0;
 400     Shadow cur(fast_state);
 401     cur.SetWrite(is_write);
 402     cur.SetAddr0AndSizeLog(addr & (kShadowCell - 1), kAccessSizeLog);
 403     MemoryAccessImpl(thr, addr, kAccessSizeLog, is_write, false,
 404         shadow_mem, cur);
 405   }
 406 }
 407
 408 }  // namespace __tsan