lib/Transforms/Instrumentation/AddressSanitizer.cpp

   1 //===-- AddressSanitizer.cpp - memory error detector ------------*- C++ -*-===//
   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 AddressSanitizer, an address sanity checker.
  11 // Details of the algorithm:
  12 //  http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerAlgorithm
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "asan"
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/ADT/SmallSet.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/ADT/SmallVector.h"
  23 #include "llvm/ADT/StringExtras.h"
  24 #include "llvm/Function.h"
  25 #include "llvm/InlineAsm.h"
  26 #include "llvm/IntrinsicInst.h"
  27 #include "llvm/LLVMContext.h"
  28 #include "llvm/Module.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/DataTypes.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/IRBuilder.h"
  33 #include "llvm/Support/MemoryBuffer.h"
  34 #include "llvm/Support/Regex.h"
  35 #include "llvm/Support/raw_ostream.h"
  36 #include "llvm/Support/system_error.h"
  37 #include "llvm/Target/TargetData.h"
  38 #include "llvm/Target/TargetMachine.h"
  39 #include "llvm/Transforms/Instrumentation.h"
  40 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  41 #include "llvm/Transforms/Utils/ModuleUtils.h"
  42 #include "llvm/Type.h"
  43
  44 #include <string>
  45 #include <algorithm>
  46
  47 using namespace llvm;
  48
  49 static const uint64_t kDefaultShadowScale = 3;
  50 static const uint64_t kDefaultShadowOffset32 = 1ULL << 29;
  51 static const uint64_t kDefaultShadowOffset64 = 1ULL << 44;
  52
  53 static const size_t kMaxStackMallocSize = 1 << 16;  // 64K
  54 static const uintptr_t kCurrentStackFrameMagic = 0x41B58AB3;
  55 static const uintptr_t kRetiredStackFrameMagic = 0x45E0360E;
  56
  57 static const char *kAsanModuleCtorName = "asan.module_ctor";
  58 static const char *kAsanReportErrorTemplate = "__asan_report_";
  59 static const char *kAsanRegisterGlobalsName = "__asan_register_globals";
  60 static const char *kAsanInitName = "__asan_init";
  61 static const char *kAsanMappingOffsetName = "__asan_mapping_offset";
  62 static const char *kAsanMappingScaleName = "__asan_mapping_scale";
  63 static const char *kAsanStackMallocName = "__asan_stack_malloc";
  64 static const char *kAsanStackFreeName = "__asan_stack_free";
  65
  66 static const int kAsanStackLeftRedzoneMagic = 0xf1;
  67 static const int kAsanStackMidRedzoneMagic = 0xf2;
  68 static const int kAsanStackRightRedzoneMagic = 0xf3;
  69 static const int kAsanStackPartialRedzoneMagic = 0xf4;
  70
  71 // Command-line flags.
  72
  73 // This flag may need to be replaced with -f[no-]asan-reads.
  74 static cl::opt<bool> ClInstrumentReads("asan-instrument-reads",
  75        cl::desc("instrument read instructions"), cl::Hidden, cl::init(true));
  76 static cl::opt<bool> ClInstrumentWrites("asan-instrument-writes",
  77        cl::desc("instrument write instructions"), cl::Hidden, cl::init(true));
  78 // This flag may need to be replaced with -f[no]asan-stack.
  79 static cl::opt<bool> ClStack("asan-stack",
  80        cl::desc("Handle stack memory"), cl::Hidden, cl::init(true));
  81 // This flag may need to be replaced with -f[no]asan-use-after-return.
  82 static cl::opt<bool> ClUseAfterReturn("asan-use-after-return",
  83        cl::desc("Check return-after-free"), cl::Hidden, cl::init(false));
  84 // This flag may need to be replaced with -f[no]asan-globals.
  85 static cl::opt<bool> ClGlobals("asan-globals",
  86        cl::desc("Handle global objects"), cl::Hidden, cl::init(true));
  87 static cl::opt<bool> ClMemIntrin("asan-memintrin",
  88        cl::desc("Handle memset/memcpy/memmove"), cl::Hidden, cl::init(true));
  89 // This flag may need to be replaced with -fasan-blacklist.
  90 static cl::opt<std::string>  ClBlackListFile("asan-blacklist",
  91        cl::desc("File containing the list of functions to ignore "
  92                 "during instrumentation"), cl::Hidden);
  93 static cl::opt<bool> ClUseCall("asan-use-call",
  94        cl::desc("Use function call to generate a crash"), cl::Hidden,
  95        cl::init(true));
  96
  97 // These flags allow to change the shadow mapping.
  98 // The shadow mapping looks like
  99 //    Shadow = (Mem >> scale) + (1 << offset_log)
 100 static cl::opt<int> ClMappingScale("asan-mapping-scale",
 101        cl::desc("scale of asan shadow mapping"), cl::Hidden, cl::init(0));
 102 static cl::opt<int> ClMappingOffsetLog("asan-mapping-offset-log",
 103        cl::desc("offset of asan shadow mapping"), cl::Hidden, cl::init(-1));
 104
 105 // Optimization flags. Not user visible, used mostly for testing
 106 // and benchmarking the tool.
 107 static cl::opt<bool> ClOpt("asan-opt",
 108        cl::desc("Optimize instrumentation"), cl::Hidden, cl::init(true));
 109 static cl::opt<bool> ClOptSameTemp("asan-opt-same-temp",
 110        cl::desc("Instrument the same temp just once"), cl::Hidden,
 111        cl::init(true));
 112 static cl::opt<bool> ClOptGlobals("asan-opt-globals",
 113        cl::desc("Don't instrument scalar globals"), cl::Hidden, cl::init(true));
 114
 115 // Debug flags.
 116 static cl::opt<int> ClDebug("asan-debug", cl::desc("debug"), cl::Hidden,
 117                             cl::init(0));
 118 static cl::opt<int> ClDebugStack("asan-debug-stack", cl::desc("debug stack"),
 119                                  cl::Hidden, cl::init(0));
 120 static cl::opt<std::string> ClDebugFunc("asan-debug-func",
 121                                         cl::Hidden, cl::desc("Debug func"));
 122 static cl::opt<int> ClDebugMin("asan-debug-min", cl::desc("Debug min inst"),
 123                                cl::Hidden, cl::init(-1));
 124 static cl::opt<int> ClDebugMax("asan-debug-max", cl::desc("Debug man inst"),
 125                                cl::Hidden, cl::init(-1));
 126
 127 namespace {
 128
 129 // Blacklisted functions are not instrumented.
 130 // The blacklist file contains one or more lines like this:
 131 // ---
 132 // fun:FunctionWildCard
 133 // ---
 134 // This is similar to the "ignore" feature of ThreadSanitizer.
 135 // http://code.google.com/p/data-race-test/wiki/ThreadSanitizerIgnores
 136 class BlackList {
 137  public:
 138   BlackList(const std::string &Path);
 139   bool isIn(const Function &F);
 140  private:
 141   Regex *Functions;
 142 };
 143
 144 /// AddressSanitizer: instrument the code in module to find memory bugs.
 145 struct AddressSanitizer : public ModulePass {
 146   AddressSanitizer();
 147   void instrumentMop(Instruction *I);
 148   void instrumentAddress(Instruction *OrigIns, IRBuilder<> &IRB,
 149                          Value *Addr, uint32_t TypeSize, bool IsWrite);
 150   Instruction *generateCrashCode(IRBuilder<> &IRB, Value *Addr,
 151                                  bool IsWrite, uint32_t TypeSize);
 152   bool instrumentMemIntrinsic(MemIntrinsic *MI);
 153   void instrumentMemIntrinsicParam(Instruction *OrigIns, Value *Addr,
 154                                   Value *Size,
 155                                    Instruction *InsertBefore, bool IsWrite);
 156   Value *memToShadow(Value *Shadow, IRBuilder<> &IRB);
 157   bool handleFunction(Module &M, Function &F);
 158   bool poisonStackInFunction(Module &M, Function &F);
 159   virtual bool runOnModule(Module &M);
 160   bool insertGlobalRedzones(Module &M);
 161   BranchInst *splitBlockAndInsertIfThen(Instruction *SplitBefore, Value *Cmp);
 162   static char ID;  // Pass identification, replacement for typeid
 163
 164  private:
 165
 166   uint64_t getAllocaSizeInBytes(AllocaInst *AI) {
 167     Type *Ty = AI->getAllocatedType();
 168     uint64_t SizeInBytes = TD->getTypeStoreSizeInBits(Ty) / 8;
 169     return SizeInBytes;
 170   }
 171   uint64_t getAlignedSize(uint64_t SizeInBytes) {
 172     return ((SizeInBytes + RedzoneSize - 1)
 173             / RedzoneSize) * RedzoneSize;
 174   }
 175   uint64_t getAlignedAllocaSize(AllocaInst *AI) {
 176     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 177     return getAlignedSize(SizeInBytes);
 178   }
 179
 180   void PoisonStack(const ArrayRef<AllocaInst*> &AllocaVec, IRBuilder<> IRB,
 181                    Value *ShadowBase, bool DoPoison);
 182   bool LooksLikeCodeInBug11395(Instruction *I);
 183
 184   Module      *CurrentModule;
 185   LLVMContext *C;
 186   TargetData *TD;
 187   uint64_t MappingOffset;
 188   int MappingScale;
 189   size_t RedzoneSize;
 190   int LongSize;
 191   Type *IntptrTy;
 192   Type *IntptrPtrTy;
 193   Function *AsanCtorFunction;
 194   Function *AsanInitFunction;
 195   Instruction *CtorInsertBefore;
 196   OwningPtr<BlackList> BL;
 197 };
 198 }  // namespace
 199
 200 char AddressSanitizer::ID = 0;
 201 INITIALIZE_PASS(AddressSanitizer, "asan",
 202     "AddressSanitizer: detects use-after-free and out-of-bounds bugs.",
 203     false, false)
 204 AddressSanitizer::AddressSanitizer() : ModulePass(ID) { }
 205 ModulePass *llvm::createAddressSanitizerPass() {
 206   return new AddressSanitizer();
 207 }
 208
 209 // Create a constant for Str so that we can pass it to the run-time lib.
 210 static GlobalVariable *createPrivateGlobalForString(Module &M, StringRef Str) {
 211   Constant *StrConst = ConstantArray::get(M.getContext(), Str);
 212   return new GlobalVariable(M, StrConst->getType(), true,
 213                             GlobalValue::PrivateLinkage, StrConst, "");
 214 }
 215
 216 // Split the basic block and insert an if-then code.
 217 // Before:
 218 //   Head
 219 //   SplitBefore
 220 //   Tail
 221 // After:
 222 //   Head
 223 //   if (Cmp)
 224 //     NewBasicBlock
 225 //   SplitBefore
 226 //   Tail
 227 //
 228 // Returns the NewBasicBlock's terminator.
 229 BranchInst *AddressSanitizer::splitBlockAndInsertIfThen(
 230     Instruction *SplitBefore, Value *Cmp) {
 231   BasicBlock *Head = SplitBefore->getParent();
 232   BasicBlock *Tail = Head->splitBasicBlock(SplitBefore);
 233   TerminatorInst *HeadOldTerm = Head->getTerminator();
 234   BasicBlock *NewBasicBlock =
 235       BasicBlock::Create(*C, "", Head->getParent());
 236   BranchInst *HeadNewTerm = BranchInst::Create(/*ifTrue*/NewBasicBlock,
 237                                                /*ifFalse*/Tail,
 238                                                Cmp);
 239   ReplaceInstWithInst(HeadOldTerm, HeadNewTerm);
 240
 241   BranchInst *CheckTerm = BranchInst::Create(Tail, NewBasicBlock);
 242   return CheckTerm;
 243 }
 244
 245 Value *AddressSanitizer::memToShadow(Value *Shadow, IRBuilder<> &IRB) {
 246   // Shadow >> scale
 247   Shadow = IRB.CreateLShr(Shadow, MappingScale);
 248   if (MappingOffset == 0)
 249     return Shadow;
 250   // (Shadow >> scale) | offset
 251   return IRB.CreateOr(Shadow, ConstantInt::get(IntptrTy,
 252                                                MappingOffset));
 253 }
 254
 255 void AddressSanitizer::instrumentMemIntrinsicParam(Instruction *OrigIns,
 256     Value *Addr, Value *Size, Instruction *InsertBefore, bool IsWrite) {
 257   // Check the first byte.
 258   {
 259     IRBuilder<> IRB(InsertBefore);
 260     instrumentAddress(OrigIns, IRB, Addr, 8, IsWrite);
 261   }
 262   // Check the last byte.
 263   {
 264     IRBuilder<> IRB(InsertBefore);
 265     Value *SizeMinusOne = IRB.CreateSub(
 266         Size, ConstantInt::get(Size->getType(), 1));
 267     SizeMinusOne = IRB.CreateIntCast(SizeMinusOne, IntptrTy, false);
 268     Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 269     Value *AddrPlusSizeMinisOne = IRB.CreateAdd(AddrLong, SizeMinusOne);
 270     instrumentAddress(OrigIns, IRB, AddrPlusSizeMinisOne, 8, IsWrite);
 271   }
 272 }
 273
 274 // Instrument memset/memmove/memcpy
 275 bool AddressSanitizer::instrumentMemIntrinsic(MemIntrinsic *MI) {
 276   Value *Dst = MI->getDest();
 277   MemTransferInst *MemTran = dyn_cast<MemTransferInst>(MI);
 278   Value *Src = MemTran ? MemTran->getSource() : NULL;
 279   Value *Length = MI->getLength();
 280
 281   Constant *ConstLength = dyn_cast<Constant>(Length);
 282   Instruction *InsertBefore = MI;
 283   if (ConstLength) {
 284     if (ConstLength->isNullValue()) return false;
 285   } else {
 286     // The size is not a constant so it could be zero -- check at run-time.
 287     IRBuilder<> IRB(InsertBefore);
 288
 289     Value *Cmp = IRB.CreateICmpNE(Length,
 290                                    Constant::getNullValue(Length->getType()));
 291     InsertBefore = splitBlockAndInsertIfThen(InsertBefore, Cmp);
 292   }
 293
 294   instrumentMemIntrinsicParam(MI, Dst, Length, InsertBefore, true);
 295   if (Src)
 296     instrumentMemIntrinsicParam(MI, Src, Length, InsertBefore, false);
 297   return true;
 298 }
 299
 300 static Value *getLDSTOperand(Instruction *I) {
 301   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 302     return LI->getPointerOperand();
 303   }
 304   return cast<StoreInst>(*I).getPointerOperand();
 305 }
 306
 307 void AddressSanitizer::instrumentMop(Instruction *I) {
 308   int IsWrite = isa<StoreInst>(*I);
 309   Value *Addr = getLDSTOperand(I);
 310   if (ClOpt && ClOptGlobals && isa<GlobalVariable>(Addr)) {
 311     // We are accessing a global scalar variable. Nothing to catch here.
 312     return;
 313   }
 314   Type *OrigPtrTy = Addr->getType();
 315   Type *OrigTy = cast<PointerType>(OrigPtrTy)->getElementType();
 316
 317   assert(OrigTy->isSized());
 318   uint32_t TypeSize = TD->getTypeStoreSizeInBits(OrigTy);
 319
 320   if (TypeSize != 8  && TypeSize != 16 &&
 321       TypeSize != 32 && TypeSize != 64 && TypeSize != 128) {
 322     // Ignore all unusual sizes.
 323     return;
 324   }
 325
 326   IRBuilder<> IRB(I);
 327   instrumentAddress(I, IRB, Addr, TypeSize, IsWrite);
 328 }
 329
 330 Instruction *AddressSanitizer::generateCrashCode(
 331     IRBuilder<> &IRB, Value *Addr, bool IsWrite, uint32_t TypeSize) {
 332
 333   if (ClUseCall) {
 334     // Here we use a call instead of arch-specific asm to report an error.
 335     // This is almost always slower (because the codegen needs to generate
 336     // prologue/epilogue for otherwise leaf functions) and generates more code.
 337     // This mode could be useful if we can not use SIGILL for some reason.
 338     //
 339     // IsWrite and TypeSize are encoded in the function name.
 340     std::string FunctionName = std::string(kAsanReportErrorTemplate) +
 341         (IsWrite ? "store" : "load") + itostr(TypeSize / 8);
 342     Value *ReportWarningFunc = CurrentModule->getOrInsertFunction(
 343         FunctionName, IRB.getVoidTy(), IntptrTy, NULL);
 344     CallInst *Call = IRB.CreateCall(ReportWarningFunc, Addr);
 345     Call->setDoesNotReturn();
 346     return Call;
 347   }
 348
 349   uint32_t LogOfSizeInBytes = CountTrailingZeros_32(TypeSize / 8);
 350   assert(8U * (1 << LogOfSizeInBytes) == TypeSize);
 351   uint8_t TelltaleValue = IsWrite * 8 + LogOfSizeInBytes;
 352   assert(TelltaleValue < 16);
 353
 354   // Move the failing address to %rax/%eax
 355   FunctionType *Fn1Ty = FunctionType::get(
 356       IRB.getVoidTy(), ArrayRef<Type*>(IntptrTy), false);
 357   const char *MovStr = LongSize == 32
 358       ? "mov $0, %eax" : "mov $0, %rax";
 359   Value *AsmMov = InlineAsm::get(
 360       Fn1Ty, StringRef(MovStr), StringRef("r"), true);
 361   IRB.CreateCall(AsmMov, Addr);
 362
 363   // crash with ud2; could use int3, but it is less friendly to gdb.
 364   // after ud2 put a 1-byte instruction that encodes the access type and size.
 365
 366   const char *TelltaleInsns[16] = {
 367     "push   %eax",  // 0x50
 368     "push   %ecx",  // 0x51
 369     "push   %edx",  // 0x52
 370     "push   %ebx",  // 0x53
 371     "push   %esp",  // 0x54
 372     "push   %ebp",  // 0x55
 373     "push   %esi",  // 0x56
 374     "push   %edi",  // 0x57
 375     "pop    %eax",  // 0x58
 376     "pop    %ecx",  // 0x59
 377     "pop    %edx",  // 0x5a
 378     "pop    %ebx",  // 0x5b
 379     "pop    %esp",  // 0x5c
 380     "pop    %ebp",  // 0x5d
 381     "pop    %esi",  // 0x5e
 382     "pop    %edi"   // 0x5f
 383   };
 384
 385   std::string AsmStr = "ud2;";
 386   AsmStr += TelltaleInsns[TelltaleValue];
 387   Value *MyAsm = InlineAsm::get(FunctionType::get(Type::getVoidTy(*C), false),
 388                                 StringRef(AsmStr), StringRef(""), true);
 389   CallInst *AsmCall = IRB.CreateCall(MyAsm);
 390
 391   // This saves us one jump, but triggers a bug in RA (or somewhere else):
 392   // while building 483.xalancbmk the compiler goes into infinite loop in
 393   // llvm::SpillPlacement::iterate() / RAGreedy::growRegion
 394   // AsmCall->setDoesNotReturn();
 395   return AsmCall;
 396 }
 397
 398 void AddressSanitizer::instrumentAddress(Instruction *OrigIns,
 399                                          IRBuilder<> &IRB, Value *Addr,
 400                                          uint32_t TypeSize, bool IsWrite) {
 401   Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 402
 403   Type *ShadowTy  = IntegerType::get(
 404       *C, std::max(8U, TypeSize >> MappingScale));
 405   Type *ShadowPtrTy = PointerType::get(ShadowTy, 0);
 406   Value *ShadowPtr = memToShadow(AddrLong, IRB);
 407   Value *CmpVal = Constant::getNullValue(ShadowTy);
 408   Value *ShadowValue = IRB.CreateLoad(
 409       IRB.CreateIntToPtr(ShadowPtr, ShadowPtrTy));
 410
 411   Value *Cmp = IRB.CreateICmpNE(ShadowValue, CmpVal);
 412
 413   Instruction *CheckTerm = splitBlockAndInsertIfThen(
 414       cast<Instruction>(Cmp)->getNextNode(), Cmp);
 415   IRBuilder<> IRB2(CheckTerm);
 416
 417   size_t Granularity = 1 << MappingScale;
 418   if (TypeSize < 8 * Granularity) {
 419     // Addr & (Granularity - 1)
 420     Value *Lower3Bits = IRB2.CreateAnd(
 421         AddrLong, ConstantInt::get(IntptrTy, Granularity - 1));
 422     // (Addr & (Granularity - 1)) + size - 1
 423     Value *LastAccessedByte = IRB2.CreateAdd(
 424         Lower3Bits, ConstantInt::get(IntptrTy, TypeSize / 8 - 1));
 425     // (uint8_t) ((Addr & (Granularity-1)) + size - 1)
 426     LastAccessedByte = IRB2.CreateIntCast(
 427         LastAccessedByte, IRB.getInt8Ty(), false);
 428     // ((uint8_t) ((Addr & (Granularity-1)) + size - 1)) >= ShadowValue
 429     Value *Cmp2 = IRB2.CreateICmpSGE(LastAccessedByte, ShadowValue);
 430
 431     CheckTerm = splitBlockAndInsertIfThen(CheckTerm, Cmp2);
 432   }
 433
 434   IRBuilder<> IRB1(CheckTerm);
 435   Instruction *Crash = generateCrashCode(IRB1, AddrLong, IsWrite, TypeSize);
 436   Crash->setDebugLoc(OrigIns->getDebugLoc());
 437 }
 438
 439 // This function replaces all global variables with new variables that have
 440 // trailing redzones. It also creates a function that poisons
 441 // redzones and inserts this function into llvm.global_ctors.
 442 bool AddressSanitizer::insertGlobalRedzones(Module &M) {
 443   SmallVector<GlobalVariable *, 16> GlobalsToChange;
 444
 445   for (Module::GlobalListType::iterator G = M.getGlobalList().begin(),
 446        E = M.getGlobalList().end(); G != E; ++G) {
 447     Type *Ty = cast<PointerType>(G->getType())->getElementType();
 448     DEBUG(dbgs() << "GLOBAL: " << *G);
 449
 450     if (!Ty->isSized()) continue;
 451     if (!G->hasInitializer()) continue;
 452     // Touch only those globals that will not be defined in other modules.
 453     // Don't handle ODR type linkages since other modules may be built w/o asan.
 454     if (G->getLinkage() != GlobalVariable::ExternalLinkage &&
 455         G->getLinkage() != GlobalVariable::PrivateLinkage &&
 456         G->getLinkage() != GlobalVariable::InternalLinkage)
 457       continue;
 458     // For now, just ignore this Alloca if the alignment is large.
 459     if (G->getAlignment() > RedzoneSize) continue;
 460
 461     // Ignore all the globals with the names starting with "\01L_OBJC_".
 462     // Many of those are put into the .cstring section. The linker compresses
 463     // that section by removing the spare \0s after the string terminator, so
 464     // our redzones get broken.
 465     if ((G->getName().find("\01L_OBJC_") == 0) ||
 466         (G->getName().find("\01l_OBJC_") == 0)) {
 467       DEBUG(dbgs() << "Ignoring \\01L_OBJC_* global: " << *G);
 468       continue;
 469     }
 470
 471     // Ignore the globals from the __OBJC section. The ObjC runtime assumes
 472     // those conform to /usr/lib/objc/runtime.h, so we can't add redzones to
 473     // them.
 474     if (G->hasSection()) {
 475       StringRef Section(G->getSection());
 476       if ((Section.find("__OBJC,") == 0) ||
 477           (Section.find("__DATA, __objc_") == 0)) {
 478         DEBUG(dbgs() << "Ignoring ObjC runtime global: " << *G);
 479         continue;
 480       }
 481     }
 482
 483     GlobalsToChange.push_back(G);
 484   }
 485
 486   size_t n = GlobalsToChange.size();
 487   if (n == 0) return false;
 488
 489   // A global is described by a structure
 490   //   size_t beg;
 491   //   size_t size;
 492   //   size_t size_with_redzone;
 493   //   const char *name;
 494   // We initialize an array of such structures and pass it to a run-time call.
 495   StructType *GlobalStructTy = StructType::get(IntptrTy, IntptrTy,
 496                                                IntptrTy, IntptrTy, NULL);
 497   SmallVector<Constant *, 16> Initializers(n);
 498
 499   IRBuilder<> IRB(CtorInsertBefore);
 500
 501   for (size_t i = 0; i < n; i++) {
 502     GlobalVariable *G = GlobalsToChange[i];
 503     PointerType *PtrTy = cast<PointerType>(G->getType());
 504     Type *Ty = PtrTy->getElementType();
 505     uint64_t SizeInBytes = TD->getTypeStoreSizeInBits(Ty) / 8;
 506     uint64_t RightRedzoneSize = RedzoneSize +
 507         (RedzoneSize - (SizeInBytes % RedzoneSize));
 508     Type *RightRedZoneTy = ArrayType::get(IRB.getInt8Ty(), RightRedzoneSize);
 509
 510     StructType *NewTy = StructType::get(Ty, RightRedZoneTy, NULL);
 511     Constant *NewInitializer = ConstantStruct::get(
 512         NewTy, G->getInitializer(),
 513         Constant::getNullValue(RightRedZoneTy), NULL);
 514
 515     GlobalVariable *Name = createPrivateGlobalForString(M, G->getName());
 516
 517     // Create a new global variable with enough space for a redzone.
 518     GlobalVariable *NewGlobal = new GlobalVariable(
 519         M, NewTy, G->isConstant(), G->getLinkage(),
 520         NewInitializer, "", G, G->isThreadLocal());
 521     NewGlobal->copyAttributesFrom(G);
 522     NewGlobal->setAlignment(RedzoneSize);
 523
 524     Value *Indices2[2];
 525     Indices2[0] = IRB.getInt32(0);
 526     Indices2[1] = IRB.getInt32(0);
 527
 528     G->replaceAllUsesWith(
 529         ConstantExpr::getGetElementPtr(NewGlobal, Indices2, 2));
 530     NewGlobal->takeName(G);
 531     G->eraseFromParent();
 532
 533     Initializers[i] = ConstantStruct::get(
 534         GlobalStructTy,
 535         ConstantExpr::getPointerCast(NewGlobal, IntptrTy),
 536         ConstantInt::get(IntptrTy, SizeInBytes),
 537         ConstantInt::get(IntptrTy, SizeInBytes + RightRedzoneSize),
 538         ConstantExpr::getPointerCast(Name, IntptrTy),
 539         NULL);
 540     DEBUG(dbgs() << "NEW GLOBAL:\n" << *NewGlobal);
 541   }
 542
 543   ArrayType *ArrayOfGlobalStructTy = ArrayType::get(GlobalStructTy, n);
 544   GlobalVariable *AllGlobals = new GlobalVariable(
 545       M, ArrayOfGlobalStructTy, false, GlobalVariable::PrivateLinkage,
 546       ConstantArray::get(ArrayOfGlobalStructTy, Initializers), "");
 547
 548   Function *AsanRegisterGlobals = cast<Function>(M.getOrInsertFunction(
 549       kAsanRegisterGlobalsName, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
 550   AsanRegisterGlobals->setLinkage(Function::ExternalLinkage);
 551
 552   IRB.CreateCall2(AsanRegisterGlobals,
 553                   IRB.CreatePointerCast(AllGlobals, IntptrTy),
 554                   ConstantInt::get(IntptrTy, n));
 555
 556   DEBUG(dbgs() << M);
 557   return true;
 558 }
 559
 560 // virtual
 561 bool AddressSanitizer::runOnModule(Module &M) {
 562   // Initialize the private fields. No one has accessed them before.
 563   TD = getAnalysisIfAvailable<TargetData>();
 564   if (!TD)
 565     return false;
 566   BL.reset(new BlackList(ClBlackListFile));
 567
 568   CurrentModule = &M;
 569   C = &(M.getContext());
 570   LongSize = TD->getPointerSizeInBits();
 571   IntptrTy = Type::getIntNTy(*C, LongSize);
 572   IntptrPtrTy = PointerType::get(IntptrTy, 0);
 573
 574   AsanCtorFunction = Function::Create(
 575       FunctionType::get(Type::getVoidTy(*C), false),
 576       GlobalValue::InternalLinkage, kAsanModuleCtorName, &M);
 577   BasicBlock *AsanCtorBB = BasicBlock::Create(*C, "", AsanCtorFunction);
 578   CtorInsertBefore = ReturnInst::Create(*C, AsanCtorBB);
 579
 580   // call __asan_init in the module ctor.
 581   IRBuilder<> IRB(CtorInsertBefore);
 582   AsanInitFunction = cast<Function>(
 583       M.getOrInsertFunction(kAsanInitName, IRB.getVoidTy(), NULL));
 584   AsanInitFunction->setLinkage(Function::ExternalLinkage);
 585   IRB.CreateCall(AsanInitFunction);
 586
 587   MappingOffset = LongSize == 32
 588       ? kDefaultShadowOffset32 : kDefaultShadowOffset64;
 589   if (ClMappingOffsetLog >= 0) {
 590     if (ClMappingOffsetLog == 0) {
 591       // special case
 592       MappingOffset = 0;
 593     } else {
 594       MappingOffset = 1ULL << ClMappingOffsetLog;
 595     }
 596   }
 597   MappingScale = kDefaultShadowScale;
 598   if (ClMappingScale) {
 599     MappingScale = ClMappingScale;
 600   }
 601   // Redzone used for stack and globals is at least 32 bytes.
 602   // For scales 6 and 7, the redzone has to be 64 and 128 bytes respectively.
 603   RedzoneSize = std::max(32, (int)(1 << MappingScale));
 604
 605   bool Res = false;
 606
 607   if (ClGlobals)
 608     Res |= insertGlobalRedzones(M);
 609
 610   // Tell the run-time the current values of mapping offset and scale.
 611   GlobalValue *asan_mapping_offset =
 612       new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
 613                      ConstantInt::get(IntptrTy, MappingOffset),
 614                      kAsanMappingOffsetName);
 615   GlobalValue *asan_mapping_scale =
 616       new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
 617                          ConstantInt::get(IntptrTy, MappingScale),
 618                          kAsanMappingScaleName);
 619   // Read these globals, otherwise they may be optimized away.
 620   IRB.CreateLoad(asan_mapping_scale, true);
 621   IRB.CreateLoad(asan_mapping_offset, true);
 622
 623
 624   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
 625     if (F->isDeclaration()) continue;
 626     Res |= handleFunction(M, *F);
 627   }
 628
 629   appendToGlobalCtors(M, AsanCtorFunction, 1 /*high priority*/);
 630
 631   return Res;
 632 }
 633
 634 bool AddressSanitizer::handleFunction(Module &M, Function &F) {
 635   if (BL->isIn(F)) return false;
 636   if (&F == AsanCtorFunction) return false;
 637
 638   if (!ClDebugFunc.empty() && ClDebugFunc != F.getName())
 639     return false;
 640   // We want to instrument every address only once per basic block
 641   // (unless there are calls between uses).
 642   SmallSet<Value*, 16> TempsToInstrument;
 643   SmallVector<Instruction*, 16> ToInstrument;
 644
 645   // Fill the set of memory operations to instrument.
 646   for (Function::iterator FI = F.begin(), FE = F.end();
 647        FI != FE; ++FI) {
 648     TempsToInstrument.clear();
 649     for (BasicBlock::iterator BI = FI->begin(), BE = FI->end();
 650          BI != BE; ++BI) {
 651       if ((isa<LoadInst>(BI) && ClInstrumentReads) ||
 652           (isa<StoreInst>(BI) && ClInstrumentWrites)) {
 653         Value *Addr = getLDSTOperand(BI);
 654         if (ClOpt && ClOptSameTemp) {
 655           if (!TempsToInstrument.insert(Addr))
 656             continue;  // We've seen this temp in the current BB.
 657         }
 658       } else if (isa<MemIntrinsic>(BI) && ClMemIntrin) {
 659         // ok, take it.
 660       } else {
 661         if (isa<CallInst>(BI)) {
 662           // A call inside BB.
 663           TempsToInstrument.clear();
 664         }
 665         continue;
 666       }
 667       ToInstrument.push_back(BI);
 668     }
 669   }
 670
 671   // Instrument.
 672   int NumInstrumented = 0;
 673   for (size_t i = 0, n = ToInstrument.size(); i != n; i++) {
 674     Instruction *Inst = ToInstrument[i];
 675     if (ClDebugMin < 0 || ClDebugMax < 0 ||
 676         (NumInstrumented >= ClDebugMin && NumInstrumented <= ClDebugMax)) {
 677       if (isa<StoreInst>(Inst) || isa<LoadInst>(Inst))
 678         instrumentMop(Inst);
 679       else
 680         instrumentMemIntrinsic(cast<MemIntrinsic>(Inst));
 681     }
 682     NumInstrumented++;
 683   }
 684
 685   DEBUG(dbgs() << F);
 686
 687   bool ChangedStack = poisonStackInFunction(M, F);
 688
 689   // For each NSObject descendant having a +load method, this method is invoked
 690   // by the ObjC runtime before any of the static constructors is called.
 691   // Therefore we need to instrument such methods with a call to __asan_init
 692   // at the beginning in order to initialize our runtime before any access to
 693   // the shadow memory.
 694   // We cannot just ignore these methods, because they may call other
 695   // instrumented functions.
 696   if (F.getName().find(" load]") != std::string::npos) {
 697     IRBuilder<> IRB(F.begin()->begin());
 698     IRB.CreateCall(AsanInitFunction);
 699   }
 700
 701   return NumInstrumented > 0 || ChangedStack;
 702 }
 703
 704 static uint64_t ValueForPoison(uint64_t PoisonByte, size_t ShadowRedzoneSize) {
 705   if (ShadowRedzoneSize == 1) return PoisonByte;
 706   if (ShadowRedzoneSize == 2) return (PoisonByte << 8) + PoisonByte;
 707   if (ShadowRedzoneSize == 4)
 708     return (PoisonByte << 24) + (PoisonByte << 16) +
 709         (PoisonByte << 8) + (PoisonByte);
 710   assert(0 && "ShadowRedzoneSize is either 1, 2 or 4");
 711   return 0;
 712 }
 713
 714 static void PoisonShadowPartialRightRedzone(uint8_t *Shadow,
 715                                             size_t Size,
 716                                             size_t RedzoneSize,
 717                                             size_t ShadowGranularity,
 718                                             uint8_t Magic) {
 719   for (size_t i = 0; i < RedzoneSize;
 720        i+= ShadowGranularity, Shadow++) {
 721     if (i + ShadowGranularity <= Size) {
 722       *Shadow = 0;  // fully addressable
 723     } else if (i >= Size) {
 724       *Shadow = Magic;  // unaddressable
 725     } else {
 726       *Shadow = Size - i;  // first Size-i bytes are addressable
 727     }
 728   }
 729 }
 730
 731 void AddressSanitizer::PoisonStack(const ArrayRef<AllocaInst*> &AllocaVec,
 732                                    IRBuilder<> IRB,
 733                                    Value *ShadowBase, bool DoPoison) {
 734   size_t ShadowRZSize = RedzoneSize >> MappingScale;
 735   assert(ShadowRZSize >= 1 && ShadowRZSize <= 4);
 736   Type *RZTy = Type::getIntNTy(*C, ShadowRZSize * 8);
 737   Type *RZPtrTy = PointerType::get(RZTy, 0);
 738
 739   Value *PoisonLeft  = ConstantInt::get(RZTy,
 740     ValueForPoison(DoPoison ? kAsanStackLeftRedzoneMagic : 0LL, ShadowRZSize));
 741   Value *PoisonMid   = ConstantInt::get(RZTy,
 742     ValueForPoison(DoPoison ? kAsanStackMidRedzoneMagic : 0LL, ShadowRZSize));
 743   Value *PoisonRight = ConstantInt::get(RZTy,
 744     ValueForPoison(DoPoison ? kAsanStackRightRedzoneMagic : 0LL, ShadowRZSize));
 745
 746   // poison the first red zone.
 747   IRB.CreateStore(PoisonLeft, IRB.CreateIntToPtr(ShadowBase, RZPtrTy));
 748
 749   // poison all other red zones.
 750   uint64_t Pos = RedzoneSize;
 751   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
 752     AllocaInst *AI = AllocaVec[i];
 753     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 754     uint64_t AlignedSize = getAlignedAllocaSize(AI);
 755     assert(AlignedSize - SizeInBytes < RedzoneSize);
 756     Value *Ptr = NULL;
 757
 758     Pos += AlignedSize;
 759
 760     assert(ShadowBase->getType() == IntptrTy);
 761     if (SizeInBytes < AlignedSize) {
 762       // Poison the partial redzone at right
 763       Ptr = IRB.CreateAdd(
 764           ShadowBase, ConstantInt::get(IntptrTy,
 765                                        (Pos >> MappingScale) - ShadowRZSize));
 766       size_t AddressableBytes = RedzoneSize - (AlignedSize - SizeInBytes);
 767       uint32_t Poison = 0;
 768       if (DoPoison) {
 769         PoisonShadowPartialRightRedzone((uint8_t*)&Poison, AddressableBytes,
 770                                         RedzoneSize,
 771                                         1ULL << MappingScale,
 772                                         kAsanStackPartialRedzoneMagic);
 773       }
 774       Value *PartialPoison = ConstantInt::get(RZTy, Poison);
 775       IRB.CreateStore(PartialPoison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
 776     }
 777
 778     // Poison the full redzone at right.
 779     Ptr = IRB.CreateAdd(ShadowBase,
 780                         ConstantInt::get(IntptrTy, Pos >> MappingScale));
 781     Value *Poison = i == AllocaVec.size() - 1 ? PoisonRight : PoisonMid;
 782     IRB.CreateStore(Poison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
 783
 784     Pos += RedzoneSize;
 785   }
 786 }
 787
 788 // Workaround for bug 11395: we don't want to instrument stack in functions
 789 // with large assembly blobs (32-bit only), otherwise reg alloc may crash.
 790 bool AddressSanitizer::LooksLikeCodeInBug11395(Instruction *I) {
 791   if (LongSize != 32) return false;
 792   CallInst *CI = dyn_cast<CallInst>(I);
 793   if (!CI || !CI->isInlineAsm()) return false;
 794   if (CI->getNumArgOperands() <= 5) return false;
 795   // We have inline assembly with quite a few arguments.
 796   return true;
 797 }
 798
 799 // Find all static Alloca instructions and put
 800 // poisoned red zones around all of them.
 801 // Then unpoison everything back before the function returns.
 802 //
 803 // Stack poisoning does not play well with exception handling.
 804 // When an exception is thrown, we essentially bypass the code
 805 // that unpoisones the stack. This is why the run-time library has
 806 // to intercept __cxa_throw (as well as longjmp, etc) and unpoison the entire
 807 // stack in the interceptor. This however does not work inside the
 808 // actual function which catches the exception. Most likely because the
 809 // compiler hoists the load of the shadow value somewhere too high.
 810 // This causes asan to report a non-existing bug on 453.povray.
 811 // It sounds like an LLVM bug.
 812 bool AddressSanitizer::poisonStackInFunction(Module &M, Function &F) {
 813   if (!ClStack) return false;
 814   SmallVector<AllocaInst*, 16> AllocaVec;
 815   SmallVector<Instruction*, 8> RetVec;
 816   uint64_t TotalSize = 0;
 817
 818   // Filter out Alloca instructions we want (and can) handle.
 819   // Collect Ret instructions.
 820   for (Function::iterator FI = F.begin(), FE = F.end();
 821        FI != FE; ++FI) {
 822     BasicBlock &BB = *FI;
 823     for (BasicBlock::iterator BI = BB.begin(), BE = BB.end();
 824          BI != BE; ++BI) {
 825       if (LooksLikeCodeInBug11395(BI)) return false;
 826       if (isa<ReturnInst>(BI)) {
 827           RetVec.push_back(BI);
 828           continue;
 829       }
 830
 831       AllocaInst *AI = dyn_cast<AllocaInst>(BI);
 832       if (!AI) continue;
 833       if (AI->isArrayAllocation()) continue;
 834       if (!AI->isStaticAlloca()) continue;
 835       if (!AI->getAllocatedType()->isSized()) continue;
 836       if (AI->getAlignment() > RedzoneSize) continue;
 837       AllocaVec.push_back(AI);
 838       uint64_t AlignedSize =  getAlignedAllocaSize(AI);
 839       TotalSize += AlignedSize;
 840     }
 841   }
 842
 843   if (AllocaVec.empty()) return false;
 844
 845   uint64_t LocalStackSize = TotalSize + (AllocaVec.size() + 1) * RedzoneSize;
 846
 847   bool DoStackMalloc = ClUseAfterReturn
 848       && LocalStackSize <= kMaxStackMallocSize;
 849
 850   Instruction *InsBefore = AllocaVec[0];
 851   IRBuilder<> IRB(InsBefore);
 852
 853
 854   Type *ByteArrayTy = ArrayType::get(IRB.getInt8Ty(), LocalStackSize);
 855   AllocaInst *MyAlloca =
 856       new AllocaInst(ByteArrayTy, "MyAlloca", InsBefore);
 857   MyAlloca->setAlignment(RedzoneSize);
 858   assert(MyAlloca->isStaticAlloca());
 859   Value *OrigStackBase = IRB.CreatePointerCast(MyAlloca, IntptrTy);
 860   Value *LocalStackBase = OrigStackBase;
 861
 862   if (DoStackMalloc) {
 863     Value *AsanStackMallocFunc = M.getOrInsertFunction(
 864         kAsanStackMallocName, IntptrTy, IntptrTy, IntptrTy, NULL);
 865     LocalStackBase = IRB.CreateCall2(AsanStackMallocFunc,
 866         ConstantInt::get(IntptrTy, LocalStackSize), OrigStackBase);
 867   }
 868
 869   // This string will be parsed by the run-time (DescribeStackAddress).
 870   SmallString<2048> StackDescriptionStorage;
 871   raw_svector_ostream StackDescription(StackDescriptionStorage);
 872   StackDescription << F.getName() << " " << AllocaVec.size() << " ";
 873
 874   uint64_t Pos = RedzoneSize;
 875   // Replace Alloca instructions with base+offset.
 876   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
 877     AllocaInst *AI = AllocaVec[i];
 878     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 879     StringRef Name = AI->getName();
 880     StackDescription << Pos << " " << SizeInBytes << " "
 881                      << Name.size() << " " << Name << " ";
 882     uint64_t AlignedSize = getAlignedAllocaSize(AI);
 883     assert((AlignedSize % RedzoneSize) == 0);
 884     AI->replaceAllUsesWith(
 885         IRB.CreateIntToPtr(
 886             IRB.CreateAdd(LocalStackBase, ConstantInt::get(IntptrTy, Pos)),
 887             AI->getType()));
 888     Pos += AlignedSize + RedzoneSize;
 889   }
 890   assert(Pos == LocalStackSize);
 891
 892   // Write the Magic value and the frame description constant to the redzone.
 893   Value *BasePlus0 = IRB.CreateIntToPtr(LocalStackBase, IntptrPtrTy);
 894   IRB.CreateStore(ConstantInt::get(IntptrTy, kCurrentStackFrameMagic),
 895                   BasePlus0);
 896   Value *BasePlus1 = IRB.CreateAdd(LocalStackBase,
 897                                    ConstantInt::get(IntptrTy, LongSize/8));
 898   BasePlus1 = IRB.CreateIntToPtr(BasePlus1, IntptrPtrTy);
 899   Value *Description = IRB.CreatePointerCast(
 900       createPrivateGlobalForString(M, StackDescription.str()),
 901       IntptrTy);
 902   IRB.CreateStore(Description, BasePlus1);
 903
 904   // Poison the stack redzones at the entry.
 905   Value *ShadowBase = memToShadow(LocalStackBase, IRB);
 906   PoisonStack(ArrayRef<AllocaInst*>(AllocaVec), IRB, ShadowBase, true);
 907
 908   Value *AsanStackFreeFunc = NULL;
 909   if (DoStackMalloc) {
 910     AsanStackFreeFunc = M.getOrInsertFunction(
 911         kAsanStackFreeName, IRB.getVoidTy(),
 912         IntptrTy, IntptrTy, IntptrTy, NULL);
 913   }
 914
 915   // Unpoison the stack before all ret instructions.
 916   for (size_t i = 0, n = RetVec.size(); i < n; i++) {
 917     Instruction *Ret = RetVec[i];
 918     IRBuilder<> IRBRet(Ret);
 919
 920     // Mark the current frame as retired.
 921     IRBRet.CreateStore(ConstantInt::get(IntptrTy, kRetiredStackFrameMagic),
 922                        BasePlus0);
 923     // Unpoison the stack.
 924     PoisonStack(ArrayRef<AllocaInst*>(AllocaVec), IRBRet, ShadowBase, false);
 925
 926     if (DoStackMalloc) {
 927       IRBRet.CreateCall3(AsanStackFreeFunc, LocalStackBase,
 928                          ConstantInt::get(IntptrTy, LocalStackSize),
 929                          OrigStackBase);
 930     }
 931   }
 932
 933   if (ClDebugStack) {
 934     DEBUG(dbgs() << F);
 935   }
 936
 937   return true;
 938 }
 939
 940 BlackList::BlackList(const std::string &Path) {
 941   Functions = NULL;
 942   const char *kFunPrefix = "fun:";
 943   if (!ClBlackListFile.size()) return;
 944   std::string Fun;
 945
 946   OwningPtr<MemoryBuffer> File;
 947   if (error_code EC = MemoryBuffer::getFile(ClBlackListFile.c_str(), File)) {
 948     errs() << EC.message();
 949     exit(1);
 950   }
 951   MemoryBuffer *Buff = File.take();
 952   const char *Data = Buff->getBufferStart();
 953   size_t DataLen = Buff->getBufferSize();
 954   SmallVector<StringRef, 16> Lines;
 955   SplitString(StringRef(Data, DataLen), Lines, "\n\r");
 956   for (size_t i = 0, numLines = Lines.size(); i < numLines; i++) {
 957     if (Lines[i].startswith(kFunPrefix)) {
 958       std::string ThisFunc = Lines[i].substr(strlen(kFunPrefix));
 959       if (Fun.size()) {
 960         Fun += "|";
 961       }
 962       // add ThisFunc replacing * with .*
 963       for (size_t j = 0, n = ThisFunc.size(); j < n; j++) {
 964         if (ThisFunc[j] == '*')
 965           Fun += '.';
 966         Fun += ThisFunc[j];
 967       }
 968     }
 969   }
 970   if (Fun.size()) {
 971     Functions = new Regex(Fun);
 972   }
 973 }
 974
 975 bool BlackList::isIn(const Function &F) {
 976   if (Functions) {
 977     bool Res = Functions->match(F.getName());
 978     return Res;
 979   }
 980   return false;
 981 }