lib/Transforms/Instrumentation/ThreadSanitizer.cpp

   1 //===-- ThreadSanitizer.cpp - race detector -------------------------------===//
   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, a race detector.
  11 //
  12 // The tool is under development, for the details about previous versions see
  13 // http://code.google.com/p/data-race-test
  14 //
  15 // The instrumentation phase is quite simple:
  16 //   - Insert calls to run-time library before every memory access.
  17 //      - Optimizations may apply to avoid instrumenting some of the accesses.
  18 //   - Insert calls at function entry/exit.
  19 // The rest is handled by the run-time library.
  20 //===----------------------------------------------------------------------===//
  21
  22 #include "llvm/Transforms/Instrumentation.h"
  23 #include "llvm/ADT/SmallSet.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/ADT/SmallVector.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/ADT/StringExtras.h"
  28 #include "llvm/IR/DataLayout.h"
  29 #include "llvm/IR/Function.h"
  30 #include "llvm/IR/IRBuilder.h"
  31 #include "llvm/IR/IntrinsicInst.h"
  32 #include "llvm/IR/Intrinsics.h"
  33 #include "llvm/IR/LLVMContext.h"
  34 #include "llvm/IR/Metadata.h"
  35 #include "llvm/IR/Module.h"
  36 #include "llvm/IR/Type.h"
  37 #include "llvm/Support/CommandLine.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/MathExtras.h"
  40 #include "llvm/Support/raw_ostream.h"
  41 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  42 #include "llvm/Transforms/Utils/ModuleUtils.h"
  43 #include "llvm/Transforms/Utils/SpecialCaseList.h"
  44
  45 using namespace llvm;
  46
  47 #define DEBUG_TYPE "tsan"
  48
  49 static cl::opt<std::string>  ClBlacklistFile("tsan-blacklist",
  50        cl::desc("Blacklist file"), cl::Hidden);
  51 static cl::opt<bool>  ClInstrumentMemoryAccesses(
  52     "tsan-instrument-memory-accesses", cl::init(true),
  53     cl::desc("Instrument memory accesses"), cl::Hidden);
  54 static cl::opt<bool>  ClInstrumentFuncEntryExit(
  55     "tsan-instrument-func-entry-exit", cl::init(true),
  56     cl::desc("Instrument function entry and exit"), cl::Hidden);
  57 static cl::opt<bool>  ClInstrumentAtomics(
  58     "tsan-instrument-atomics", cl::init(true),
  59     cl::desc("Instrument atomics"), cl::Hidden);
  60 static cl::opt<bool>  ClInstrumentMemIntrinsics(
  61     "tsan-instrument-memintrinsics", cl::init(true),
  62     cl::desc("Instrument memintrinsics (memset/memcpy/memmove)"), cl::Hidden);
  63
  64 STATISTIC(NumInstrumentedReads, "Number of instrumented reads");
  65 STATISTIC(NumInstrumentedWrites, "Number of instrumented writes");
  66 STATISTIC(NumOmittedReadsBeforeWrite,
  67           "Number of reads ignored due to following writes");
  68 STATISTIC(NumAccessesWithBadSize, "Number of accesses with bad size");
  69 STATISTIC(NumInstrumentedVtableWrites, "Number of vtable ptr writes");
  70 STATISTIC(NumInstrumentedVtableReads, "Number of vtable ptr reads");
  71 STATISTIC(NumOmittedReadsFromConstantGlobals,
  72           "Number of reads from constant globals");
  73 STATISTIC(NumOmittedReadsFromVtable, "Number of vtable reads");
  74
  75 namespace {
  76
  77 /// ThreadSanitizer: instrument the code in module to find races.
  78 struct ThreadSanitizer : public FunctionPass {
  79   ThreadSanitizer(StringRef BlacklistFile = StringRef())
  80       : FunctionPass(ID),
  81         DL(nullptr),
  82         BlacklistFile(BlacklistFile.empty() ? ClBlacklistFile
  83                                             : BlacklistFile) { }
  84   const char *getPassName() const override;
  85   bool runOnFunction(Function &F) override;
  86   bool doInitialization(Module &M) override;
  87   static char ID;  // Pass identification, replacement for typeid.
  88
  89  private:
  90   void initializeCallbacks(Module &M);
  91   bool instrumentLoadOrStore(Instruction *I);
  92   bool instrumentAtomic(Instruction *I);
  93   bool instrumentMemIntrinsic(Instruction *I);
  94   void chooseInstructionsToInstrument(SmallVectorImpl<Instruction*> &Local,
  95                                       SmallVectorImpl<Instruction*> &All);
  96   bool addrPointsToConstantData(Value *Addr);
  97   int getMemoryAccessFuncIndex(Value *Addr);
  98
  99   const DataLayout *DL;
 100   Type *IntptrTy;
 101   SmallString<64> BlacklistFile;
 102   std::unique_ptr<SpecialCaseList> BL;
 103   IntegerType *OrdTy;
 104   // Callbacks to run-time library are computed in doInitialization.
 105   Function *TsanFuncEntry;
 106   Function *TsanFuncExit;
 107   // Accesses sizes are powers of two: 1, 2, 4, 8, 16.
 108   static const size_t kNumberOfAccessSizes = 5;
 109   Function *TsanRead[kNumberOfAccessSizes];
 110   Function *TsanWrite[kNumberOfAccessSizes];
 111   Function *TsanAtomicLoad[kNumberOfAccessSizes];
 112   Function *TsanAtomicStore[kNumberOfAccessSizes];
 113   Function *TsanAtomicRMW[AtomicRMWInst::LAST_BINOP + 1][kNumberOfAccessSizes];
 114   Function *TsanAtomicCAS[kNumberOfAccessSizes];
 115   Function *TsanAtomicThreadFence;
 116   Function *TsanAtomicSignalFence;
 117   Function *TsanVptrUpdate;
 118   Function *TsanVptrLoad;
 119   Function *MemmoveFn, *MemcpyFn, *MemsetFn;
 120 };
 121 }  // namespace
 122
 123 char ThreadSanitizer::ID = 0;
 124 INITIALIZE_PASS(ThreadSanitizer, "tsan",
 125     "ThreadSanitizer: detects data races.",
 126     false, false)
 127
 128 const char *ThreadSanitizer::getPassName() const {
 129   return "ThreadSanitizer";
 130 }
 131
 132 FunctionPass *llvm::createThreadSanitizerPass(StringRef BlacklistFile) {
 133   return new ThreadSanitizer(BlacklistFile);
 134 }
 135
 136 static Function *checkInterfaceFunction(Constant *FuncOrBitcast) {
 137   if (Function *F = dyn_cast<Function>(FuncOrBitcast))
 138      return F;
 139   FuncOrBitcast->dump();
 140   report_fatal_error("ThreadSanitizer interface function redefined");
 141 }
 142
 143 void ThreadSanitizer::initializeCallbacks(Module &M) {
 144   IRBuilder<> IRB(M.getContext());
 145   // Initialize the callbacks.
 146   TsanFuncEntry = checkInterfaceFunction(M.getOrInsertFunction(
 147       "__tsan_func_entry", IRB.getVoidTy(), IRB.getInt8PtrTy(), NULL));
 148   TsanFuncExit = checkInterfaceFunction(M.getOrInsertFunction(
 149       "__tsan_func_exit", IRB.getVoidTy(), NULL));
 150   OrdTy = IRB.getInt32Ty();
 151   for (size_t i = 0; i < kNumberOfAccessSizes; ++i) {
 152     const size_t ByteSize = 1 << i;
 153     const size_t BitSize = ByteSize * 8;
 154     SmallString<32> ReadName("__tsan_read" + itostr(ByteSize));
 155     TsanRead[i] = checkInterfaceFunction(M.getOrInsertFunction(
 156         ReadName, IRB.getVoidTy(), IRB.getInt8PtrTy(), NULL));
 157
 158     SmallString<32> WriteName("__tsan_write" + itostr(ByteSize));
 159     TsanWrite[i] = checkInterfaceFunction(M.getOrInsertFunction(
 160         WriteName, IRB.getVoidTy(), IRB.getInt8PtrTy(), NULL));
 161
 162     Type *Ty = Type::getIntNTy(M.getContext(), BitSize);
 163     Type *PtrTy = Ty->getPointerTo();
 164     SmallString<32> AtomicLoadName("__tsan_atomic" + itostr(BitSize) +
 165                                    "_load");
 166     TsanAtomicLoad[i] = checkInterfaceFunction(M.getOrInsertFunction(
 167         AtomicLoadName, Ty, PtrTy, OrdTy, NULL));
 168
 169     SmallString<32> AtomicStoreName("__tsan_atomic" + itostr(BitSize) +
 170                                     "_store");
 171     TsanAtomicStore[i] = checkInterfaceFunction(M.getOrInsertFunction(
 172         AtomicStoreName, IRB.getVoidTy(), PtrTy, Ty, OrdTy,
 173         NULL));
 174
 175     for (int op = AtomicRMWInst::FIRST_BINOP;
 176         op <= AtomicRMWInst::LAST_BINOP; ++op) {
 177       TsanAtomicRMW[op][i] = nullptr;
 178       const char *NamePart = nullptr;
 179       if (op == AtomicRMWInst::Xchg)
 180         NamePart = "_exchange";
 181       else if (op == AtomicRMWInst::Add)
 182         NamePart = "_fetch_add";
 183       else if (op == AtomicRMWInst::Sub)
 184         NamePart = "_fetch_sub";
 185       else if (op == AtomicRMWInst::And)
 186         NamePart = "_fetch_and";
 187       else if (op == AtomicRMWInst::Or)
 188         NamePart = "_fetch_or";
 189       else if (op == AtomicRMWInst::Xor)
 190         NamePart = "_fetch_xor";
 191       else if (op == AtomicRMWInst::Nand)
 192         NamePart = "_fetch_nand";
 193       else
 194         continue;
 195       SmallString<32> RMWName("__tsan_atomic" + itostr(BitSize) + NamePart);
 196       TsanAtomicRMW[op][i] = checkInterfaceFunction(M.getOrInsertFunction(
 197           RMWName, Ty, PtrTy, Ty, OrdTy, NULL));
 198     }
 199
 200     SmallString<32> AtomicCASName("__tsan_atomic" + itostr(BitSize) +
 201                                   "_compare_exchange_val");
 202     TsanAtomicCAS[i] = checkInterfaceFunction(M.getOrInsertFunction(
 203         AtomicCASName, Ty, PtrTy, Ty, Ty, OrdTy, OrdTy, NULL));
 204   }
 205   TsanVptrUpdate = checkInterfaceFunction(M.getOrInsertFunction(
 206       "__tsan_vptr_update", IRB.getVoidTy(), IRB.getInt8PtrTy(),
 207       IRB.getInt8PtrTy(), NULL));
 208   TsanVptrLoad = checkInterfaceFunction(M.getOrInsertFunction(
 209       "__tsan_vptr_read", IRB.getVoidTy(), IRB.getInt8PtrTy(), NULL));
 210   TsanAtomicThreadFence = checkInterfaceFunction(M.getOrInsertFunction(
 211       "__tsan_atomic_thread_fence", IRB.getVoidTy(), OrdTy, NULL));
 212   TsanAtomicSignalFence = checkInterfaceFunction(M.getOrInsertFunction(
 213       "__tsan_atomic_signal_fence", IRB.getVoidTy(), OrdTy, NULL));
 214
 215   MemmoveFn = checkInterfaceFunction(M.getOrInsertFunction(
 216     "memmove", IRB.getInt8PtrTy(), IRB.getInt8PtrTy(),
 217     IRB.getInt8PtrTy(), IntptrTy, NULL));
 218   MemcpyFn = checkInterfaceFunction(M.getOrInsertFunction(
 219     "memcpy", IRB.getInt8PtrTy(), IRB.getInt8PtrTy(), IRB.getInt8PtrTy(),
 220     IntptrTy, NULL));
 221   MemsetFn = checkInterfaceFunction(M.getOrInsertFunction(
 222     "memset", IRB.getInt8PtrTy(), IRB.getInt8PtrTy(), IRB.getInt32Ty(),
 223     IntptrTy, NULL));
 224 }
 225
 226 bool ThreadSanitizer::doInitialization(Module &M) {
 227   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
 228   if (!DLP)
 229     report_fatal_error("data layout missing");
 230   DL = &DLP->getDataLayout();
 231   BL.reset(SpecialCaseList::createOrDie(BlacklistFile));
 232
 233   // Always insert a call to __tsan_init into the module's CTORs.
 234   IRBuilder<> IRB(M.getContext());
 235   IntptrTy = IRB.getIntPtrTy(DL);
 236   Value *TsanInit = M.getOrInsertFunction("__tsan_init",
 237                                           IRB.getVoidTy(), NULL);
 238   appendToGlobalCtors(M, cast<Function>(TsanInit), 0);
 239
 240   return true;
 241 }
 242
 243 static bool isVtableAccess(Instruction *I) {
 244   if (MDNode *Tag = I->getMetadata(LLVMContext::MD_tbaa))
 245     return Tag->isTBAAVtableAccess();
 246   return false;
 247 }
 248
 249 bool ThreadSanitizer::addrPointsToConstantData(Value *Addr) {
 250   // If this is a GEP, just analyze its pointer operand.
 251   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Addr))
 252     Addr = GEP->getPointerOperand();
 253
 254   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
 255     if (GV->isConstant()) {
 256       // Reads from constant globals can not race with any writes.
 257       NumOmittedReadsFromConstantGlobals++;
 258       return true;
 259     }
 260   } else if (LoadInst *L = dyn_cast<LoadInst>(Addr)) {
 261     if (isVtableAccess(L)) {
 262       // Reads from a vtable pointer can not race with any writes.
 263       NumOmittedReadsFromVtable++;
 264       return true;
 265     }
 266   }
 267   return false;
 268 }
 269
 270 // Instrumenting some of the accesses may be proven redundant.
 271 // Currently handled:
 272 //  - read-before-write (within same BB, no calls between)
 273 //
 274 // We do not handle some of the patterns that should not survive
 275 // after the classic compiler optimizations.
 276 // E.g. two reads from the same temp should be eliminated by CSE,
 277 // two writes should be eliminated by DSE, etc.
 278 //
 279 // 'Local' is a vector of insns within the same BB (no calls between).
 280 // 'All' is a vector of insns that will be instrumented.
 281 void ThreadSanitizer::chooseInstructionsToInstrument(
 282     SmallVectorImpl<Instruction*> &Local,
 283     SmallVectorImpl<Instruction*> &All) {
 284   SmallSet<Value*, 8> WriteTargets;
 285   // Iterate from the end.
 286   for (SmallVectorImpl<Instruction*>::reverse_iterator It = Local.rbegin(),
 287        E = Local.rend(); It != E; ++It) {
 288     Instruction *I = *It;
 289     if (StoreInst *Store = dyn_cast<StoreInst>(I)) {
 290       WriteTargets.insert(Store->getPointerOperand());
 291     } else {
 292       LoadInst *Load = cast<LoadInst>(I);
 293       Value *Addr = Load->getPointerOperand();
 294       if (WriteTargets.count(Addr)) {
 295         // We will write to this temp, so no reason to analyze the read.
 296         NumOmittedReadsBeforeWrite++;
 297         continue;
 298       }
 299       if (addrPointsToConstantData(Addr)) {
 300         // Addr points to some constant data -- it can not race with any writes.
 301         continue;
 302       }
 303     }
 304     All.push_back(I);
 305   }
 306   Local.clear();
 307 }
 308
 309 static bool isAtomic(Instruction *I) {
 310   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 311     return LI->isAtomic() && LI->getSynchScope() == CrossThread;
 312   if (StoreInst *SI = dyn_cast<StoreInst>(I))
 313     return SI->isAtomic() && SI->getSynchScope() == CrossThread;
 314   if (isa<AtomicRMWInst>(I))
 315     return true;
 316   if (isa<AtomicCmpXchgInst>(I))
 317     return true;
 318   if (isa<FenceInst>(I))
 319     return true;
 320   return false;
 321 }
 322
 323 bool ThreadSanitizer::runOnFunction(Function &F) {
 324   if (!DL) return false;
 325   initializeCallbacks(*F.getParent());
 326   SmallVector<Instruction*, 8> RetVec;
 327   SmallVector<Instruction*, 8> AllLoadsAndStores;
 328   SmallVector<Instruction*, 8> LocalLoadsAndStores;
 329   SmallVector<Instruction*, 8> AtomicAccesses;
 330   SmallVector<Instruction*, 8> MemIntrinCalls;
 331   bool Res = false;
 332   bool HasCalls = false;
 333   bool SanitizeFunction =
 334       F.hasFnAttribute(Attribute::SanitizeThread) && !BL->isIn(F);
 335
 336   // Traverse all instructions, collect loads/stores/returns, check for calls.
 337   for (auto &BB : F) {
 338     for (auto &Inst : BB) {
 339       if (isAtomic(&Inst))
 340         AtomicAccesses.push_back(&Inst);
 341       else if (isa<LoadInst>(Inst) || isa<StoreInst>(Inst))
 342         LocalLoadsAndStores.push_back(&Inst);
 343       else if (isa<ReturnInst>(Inst))
 344         RetVec.push_back(&Inst);
 345       else if (isa<CallInst>(Inst) || isa<InvokeInst>(Inst)) {
 346         if (isa<MemIntrinsic>(Inst))
 347           MemIntrinCalls.push_back(&Inst);
 348         HasCalls = true;
 349         chooseInstructionsToInstrument(LocalLoadsAndStores, AllLoadsAndStores);
 350       }
 351     }
 352     chooseInstructionsToInstrument(LocalLoadsAndStores, AllLoadsAndStores);
 353   }
 354
 355   // We have collected all loads and stores.
 356   // FIXME: many of these accesses do not need to be checked for races
 357   // (e.g. variables that do not escape, etc).
 358
 359   // Instrument memory accesses only if we want to report bugs in the function.
 360   if (ClInstrumentMemoryAccesses && SanitizeFunction)
 361     for (auto Inst : AllLoadsAndStores) {
 362       Res |= instrumentLoadOrStore(Inst);
 363     }
 364
 365   // Instrument atomic memory accesses in any case (they can be used to
 366   // implement synchronization).
 367   if (ClInstrumentAtomics)
 368     for (auto Inst : AtomicAccesses) {
 369       Res |= instrumentAtomic(Inst);
 370     }
 371
 372   if (ClInstrumentMemIntrinsics && SanitizeFunction)
 373     for (auto Inst : MemIntrinCalls) {
 374       Res |= instrumentMemIntrinsic(Inst);
 375     }
 376
 377   // Instrument function entry/exit points if there were instrumented accesses.
 378   if ((Res || HasCalls) && ClInstrumentFuncEntryExit) {
 379     IRBuilder<> IRB(F.getEntryBlock().getFirstNonPHI());
 380     Value *ReturnAddress = IRB.CreateCall(
 381         Intrinsic::getDeclaration(F.getParent(), Intrinsic::returnaddress),
 382         IRB.getInt32(0));
 383     IRB.CreateCall(TsanFuncEntry, ReturnAddress);
 384     for (auto RetInst : RetVec) {
 385       IRBuilder<> IRBRet(RetInst);
 386       IRBRet.CreateCall(TsanFuncExit);
 387     }
 388     Res = true;
 389   }
 390   return Res;
 391 }
 392
 393 bool ThreadSanitizer::instrumentLoadOrStore(Instruction *I) {
 394   IRBuilder<> IRB(I);
 395   bool IsWrite = isa<StoreInst>(*I);
 396   Value *Addr = IsWrite
 397       ? cast<StoreInst>(I)->getPointerOperand()
 398       : cast<LoadInst>(I)->getPointerOperand();
 399   int Idx = getMemoryAccessFuncIndex(Addr);
 400   if (Idx < 0)
 401     return false;
 402   if (IsWrite && isVtableAccess(I)) {
 403     DEBUG(dbgs() << "  VPTR : " << *I << "\n");
 404     Value *StoredValue = cast<StoreInst>(I)->getValueOperand();
 405     // StoredValue may be a vector type if we are storing several vptrs at once.
 406     // In this case, just take the first element of the vector since this is
 407     // enough to find vptr races.
 408     if (isa<VectorType>(StoredValue->getType()))
 409       StoredValue = IRB.CreateExtractElement(
 410           StoredValue, ConstantInt::get(IRB.getInt32Ty(), 0));
 411     if (StoredValue->getType()->isIntegerTy())
 412       StoredValue = IRB.CreateIntToPtr(StoredValue, IRB.getInt8PtrTy());
 413     // Call TsanVptrUpdate.
 414     IRB.CreateCall2(TsanVptrUpdate,
 415                     IRB.CreatePointerCast(Addr, IRB.getInt8PtrTy()),
 416                     IRB.CreatePointerCast(StoredValue, IRB.getInt8PtrTy()));
 417     NumInstrumentedVtableWrites++;
 418     return true;
 419   }
 420   if (!IsWrite && isVtableAccess(I)) {
 421     IRB.CreateCall(TsanVptrLoad,
 422                    IRB.CreatePointerCast(Addr, IRB.getInt8PtrTy()));
 423     NumInstrumentedVtableReads++;
 424     return true;
 425   }
 426   Value *OnAccessFunc = IsWrite ? TsanWrite[Idx] : TsanRead[Idx];
 427   IRB.CreateCall(OnAccessFunc, IRB.CreatePointerCast(Addr, IRB.getInt8PtrTy()));
 428   if (IsWrite) NumInstrumentedWrites++;
 429   else         NumInstrumentedReads++;
 430   return true;
 431 }
 432
 433 static ConstantInt *createOrdering(IRBuilder<> *IRB, AtomicOrdering ord) {
 434   uint32_t v = 0;
 435   switch (ord) {
 436     case NotAtomic:              assert(false);
 437     case Unordered:              // Fall-through.
 438     case Monotonic:              v = 0; break;
 439     // case Consume:                v = 1; break;  // Not specified yet.
 440     case Acquire:                v = 2; break;
 441     case Release:                v = 3; break;
 442     case AcquireRelease:         v = 4; break;
 443     case SequentiallyConsistent: v = 5; break;
 444   }
 445   return IRB->getInt32(v);
 446 }
 447
 448 // If a memset intrinsic gets inlined by the code gen, we will miss races on it.
 449 // So, we either need to ensure the intrinsic is not inlined, or instrument it.
 450 // We do not instrument memset/memmove/memcpy intrinsics (too complicated),
 451 // instead we simply replace them with regular function calls, which are then
 452 // intercepted by the run-time.
 453 // Since tsan is running after everyone else, the calls should not be
 454 // replaced back with intrinsics. If that becomes wrong at some point,
 455 // we will need to call e.g. __tsan_memset to avoid the intrinsics.
 456 bool ThreadSanitizer::instrumentMemIntrinsic(Instruction *I) {
 457   IRBuilder<> IRB(I);
 458   if (MemSetInst *M = dyn_cast<MemSetInst>(I)) {
 459     IRB.CreateCall3(MemsetFn,
 460       IRB.CreatePointerCast(M->getArgOperand(0), IRB.getInt8PtrTy()),
 461       IRB.CreateIntCast(M->getArgOperand(1), IRB.getInt32Ty(), false),
 462       IRB.CreateIntCast(M->getArgOperand(2), IntptrTy, false));
 463     I->eraseFromParent();
 464   } else if (MemTransferInst *M = dyn_cast<MemTransferInst>(I)) {
 465     IRB.CreateCall3(isa<MemCpyInst>(M) ? MemcpyFn : MemmoveFn,
 466       IRB.CreatePointerCast(M->getArgOperand(0), IRB.getInt8PtrTy()),
 467       IRB.CreatePointerCast(M->getArgOperand(1), IRB.getInt8PtrTy()),
 468       IRB.CreateIntCast(M->getArgOperand(2), IntptrTy, false));
 469     I->eraseFromParent();
 470   }
 471   return false;
 472 }
 473
 474 // Both llvm and ThreadSanitizer atomic operations are based on C++11/C1x
 475 // standards.  For background see C++11 standard.  A slightly older, publicly
 476 // available draft of the standard (not entirely up-to-date, but close enough
 477 // for casual browsing) is available here:
 478 // http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3242.pdf
 479 // The following page contains more background information:
 480 // http://www.hpl.hp.com/personal/Hans_Boehm/c++mm/
 481
 482 bool ThreadSanitizer::instrumentAtomic(Instruction *I) {
 483   IRBuilder<> IRB(I);
 484   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 485     Value *Addr = LI->getPointerOperand();
 486     int Idx = getMemoryAccessFuncIndex(Addr);
 487     if (Idx < 0)
 488       return false;
 489     const size_t ByteSize = 1 << Idx;
 490     const size_t BitSize = ByteSize * 8;
 491     Type *Ty = Type::getIntNTy(IRB.getContext(), BitSize);
 492     Type *PtrTy = Ty->getPointerTo();
 493     Value *Args[] = {IRB.CreatePointerCast(Addr, PtrTy),
 494                      createOrdering(&IRB, LI->getOrdering())};
 495     CallInst *C = CallInst::Create(TsanAtomicLoad[Idx],
 496                                    ArrayRef<Value*>(Args));
 497     ReplaceInstWithInst(I, C);
 498
 499   } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 500     Value *Addr = SI->getPointerOperand();
 501     int Idx = getMemoryAccessFuncIndex(Addr);
 502     if (Idx < 0)
 503       return false;
 504     const size_t ByteSize = 1 << Idx;
 505     const size_t BitSize = ByteSize * 8;
 506     Type *Ty = Type::getIntNTy(IRB.getContext(), BitSize);
 507     Type *PtrTy = Ty->getPointerTo();
 508     Value *Args[] = {IRB.CreatePointerCast(Addr, PtrTy),
 509                      IRB.CreateIntCast(SI->getValueOperand(), Ty, false),
 510                      createOrdering(&IRB, SI->getOrdering())};
 511     CallInst *C = CallInst::Create(TsanAtomicStore[Idx],
 512                                    ArrayRef<Value*>(Args));
 513     ReplaceInstWithInst(I, C);
 514   } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I)) {
 515     Value *Addr = RMWI->getPointerOperand();
 516     int Idx = getMemoryAccessFuncIndex(Addr);
 517     if (Idx < 0)
 518       return false;
 519     Function *F = TsanAtomicRMW[RMWI->getOperation()][Idx];
 520     if (!F)
 521       return false;
 522     const size_t ByteSize = 1 << Idx;
 523     const size_t BitSize = ByteSize * 8;
 524     Type *Ty = Type::getIntNTy(IRB.getContext(), BitSize);
 525     Type *PtrTy = Ty->getPointerTo();
 526     Value *Args[] = {IRB.CreatePointerCast(Addr, PtrTy),
 527                      IRB.CreateIntCast(RMWI->getValOperand(), Ty, false),
 528                      createOrdering(&IRB, RMWI->getOrdering())};
 529     CallInst *C = CallInst::Create(F, ArrayRef<Value*>(Args));
 530     ReplaceInstWithInst(I, C);
 531   } else if (AtomicCmpXchgInst *CASI = dyn_cast<AtomicCmpXchgInst>(I)) {
 532     Value *Addr = CASI->getPointerOperand();
 533     int Idx = getMemoryAccessFuncIndex(Addr);
 534     if (Idx < 0)
 535       return false;
 536     const size_t ByteSize = 1 << Idx;
 537     const size_t BitSize = ByteSize * 8;
 538     Type *Ty = Type::getIntNTy(IRB.getContext(), BitSize);
 539     Type *PtrTy = Ty->getPointerTo();
 540     Value *Args[] = {IRB.CreatePointerCast(Addr, PtrTy),
 541                      IRB.CreateIntCast(CASI->getCompareOperand(), Ty, false),
 542                      IRB.CreateIntCast(CASI->getNewValOperand(), Ty, false),
 543                      createOrdering(&IRB, CASI->getSuccessOrdering()),
 544                      createOrdering(&IRB, CASI->getFailureOrdering())};
 545     CallInst *C = CallInst::Create(TsanAtomicCAS[Idx], ArrayRef<Value*>(Args));
 546     ReplaceInstWithInst(I, C);
 547   } else if (FenceInst *FI = dyn_cast<FenceInst>(I)) {
 548     Value *Args[] = {createOrdering(&IRB, FI->getOrdering())};
 549     Function *F = FI->getSynchScope() == SingleThread ?
 550         TsanAtomicSignalFence : TsanAtomicThreadFence;
 551     CallInst *C = CallInst::Create(F, ArrayRef<Value*>(Args));
 552     ReplaceInstWithInst(I, C);
 553   }
 554   return true;
 555 }
 556
 557 int ThreadSanitizer::getMemoryAccessFuncIndex(Value *Addr) {
 558   Type *OrigPtrTy = Addr->getType();
 559   Type *OrigTy = cast<PointerType>(OrigPtrTy)->getElementType();
 560   assert(OrigTy->isSized());
 561   uint32_t TypeSize = DL->getTypeStoreSizeInBits(OrigTy);
 562   if (TypeSize != 8  && TypeSize != 16 &&
 563       TypeSize != 32 && TypeSize != 64 && TypeSize != 128) {
 564     NumAccessesWithBadSize++;
 565     // Ignore all unusual sizes.
 566     return -1;
 567   }
 568   size_t Idx = countTrailingZeros(TypeSize / 8);
 569   assert(Idx < kNumberOfAccessSizes);
 570   return Idx;
 571 }