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 "BlackList.h"
  19 #include "llvm/Function.h"
  20 #include "llvm/IRBuilder.h"
  21 #include "llvm/InlineAsm.h"
  22 #include "llvm/IntrinsicInst.h"
  23 #include "llvm/LLVMContext.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/Type.h"
  26 #include "llvm/ADT/ArrayRef.h"
  27 #include "llvm/ADT/OwningPtr.h"
  28 #include "llvm/ADT/SmallSet.h"
  29 #include "llvm/ADT/SmallString.h"
  30 #include "llvm/ADT/SmallVector.h"
  31 #include "llvm/ADT/StringExtras.h"
  32 #include "llvm/ADT/Triple.h"
  33 #include "llvm/Support/CommandLine.h"
  34 #include "llvm/Support/DataTypes.h"
  35 #include "llvm/Support/Debug.h"
  36 #include "llvm/Support/raw_ostream.h"
  37 #include "llvm/Support/system_error.h"
  38 #include "llvm/DataLayout.h"
  39 #include "llvm/Target/TargetMachine.h"
  40 #include "llvm/Transforms/Instrumentation.h"
  41 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  42 #include "llvm/Transforms/Utils/ModuleUtils.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 static const uint64_t kDefaultShadowOffsetAndroid = 0;
  53
  54 static const size_t kMaxStackMallocSize = 1 << 16;  // 64K
  55 static const uintptr_t kCurrentStackFrameMagic = 0x41B58AB3;
  56 static const uintptr_t kRetiredStackFrameMagic = 0x45E0360E;
  57
  58 static const char *kAsanModuleCtorName = "asan.module_ctor";
  59 static const char *kAsanModuleDtorName = "asan.module_dtor";
  60 static const int   kAsanCtorAndCtorPriority = 1;
  61 static const char *kAsanReportErrorTemplate = "__asan_report_";
  62 static const char *kAsanRegisterGlobalsName = "__asan_register_globals";
  63 static const char *kAsanUnregisterGlobalsName = "__asan_unregister_globals";
  64 static const char *kAsanPoisonGlobalsName = "__asan_before_dynamic_init";
  65 static const char *kAsanUnpoisonGlobalsName = "__asan_after_dynamic_init";
  66 static const char *kAsanInitName = "__asan_init";
  67 static const char *kAsanHandleNoReturnName = "__asan_handle_no_return";
  68 static const char *kAsanMappingOffsetName = "__asan_mapping_offset";
  69 static const char *kAsanMappingScaleName = "__asan_mapping_scale";
  70 static const char *kAsanStackMallocName = "__asan_stack_malloc";
  71 static const char *kAsanStackFreeName = "__asan_stack_free";
  72
  73 static const int kAsanStackLeftRedzoneMagic = 0xf1;
  74 static const int kAsanStackMidRedzoneMagic = 0xf2;
  75 static const int kAsanStackRightRedzoneMagic = 0xf3;
  76 static const int kAsanStackPartialRedzoneMagic = 0xf4;
  77
  78 // Accesses sizes are powers of two: 1, 2, 4, 8, 16.
  79 static const size_t kNumberOfAccessSizes = 5;
  80
  81 // Command-line flags.
  82
  83 // This flag may need to be replaced with -f[no-]asan-reads.
  84 static cl::opt<bool> ClInstrumentReads("asan-instrument-reads",
  85        cl::desc("instrument read instructions"), cl::Hidden, cl::init(true));
  86 static cl::opt<bool> ClInstrumentWrites("asan-instrument-writes",
  87        cl::desc("instrument write instructions"), cl::Hidden, cl::init(true));
  88 static cl::opt<bool> ClInstrumentAtomics("asan-instrument-atomics",
  89        cl::desc("instrument atomic instructions (rmw, cmpxchg)"),
  90        cl::Hidden, cl::init(true));
  91 static cl::opt<bool> ClAlwaysSlowPath("asan-always-slow-path",
  92        cl::desc("use instrumentation with slow path for all accesses"),
  93        cl::Hidden, cl::init(false));
  94 // This flag limits the number of instructions to be instrumented
  95 // in any given BB. Normally, this should be set to unlimited (INT_MAX),
  96 // but due to http://llvm.org/bugs/show_bug.cgi?id=12652 we temporary
  97 // set it to 10000.
  98 static cl::opt<int> ClMaxInsnsToInstrumentPerBB("asan-max-ins-per-bb",
  99        cl::init(10000),
 100        cl::desc("maximal number of instructions to instrument in any given BB"),
 101        cl::Hidden);
 102 // This flag may need to be replaced with -f[no]asan-stack.
 103 static cl::opt<bool> ClStack("asan-stack",
 104        cl::desc("Handle stack memory"), cl::Hidden, cl::init(true));
 105 // This flag may need to be replaced with -f[no]asan-use-after-return.
 106 static cl::opt<bool> ClUseAfterReturn("asan-use-after-return",
 107        cl::desc("Check return-after-free"), cl::Hidden, cl::init(false));
 108 // This flag may need to be replaced with -f[no]asan-globals.
 109 static cl::opt<bool> ClGlobals("asan-globals",
 110        cl::desc("Handle global objects"), cl::Hidden, cl::init(true));
 111 static cl::opt<bool> ClInitializers("asan-initialization-order",
 112        cl::desc("Handle C++ initializer order"), cl::Hidden, cl::init(false));
 113 static cl::opt<bool> ClMemIntrin("asan-memintrin",
 114        cl::desc("Handle memset/memcpy/memmove"), cl::Hidden, cl::init(true));
 115 // This flag may need to be replaced with -fasan-blacklist.
 116 static cl::opt<std::string>  ClBlackListFile("asan-blacklist",
 117        cl::desc("File containing the list of functions to ignore "
 118                 "during instrumentation"), cl::Hidden);
 119
 120 // These flags allow to change the shadow mapping.
 121 // The shadow mapping looks like
 122 //    Shadow = (Mem >> scale) + (1 << offset_log)
 123 static cl::opt<int> ClMappingScale("asan-mapping-scale",
 124        cl::desc("scale of asan shadow mapping"), cl::Hidden, cl::init(0));
 125 static cl::opt<int> ClMappingOffsetLog("asan-mapping-offset-log",
 126        cl::desc("offset of asan shadow mapping"), cl::Hidden, cl::init(-1));
 127
 128 // Optimization flags. Not user visible, used mostly for testing
 129 // and benchmarking the tool.
 130 static cl::opt<bool> ClOpt("asan-opt",
 131        cl::desc("Optimize instrumentation"), cl::Hidden, cl::init(true));
 132 static cl::opt<bool> ClOptSameTemp("asan-opt-same-temp",
 133        cl::desc("Instrument the same temp just once"), cl::Hidden,
 134        cl::init(true));
 135 static cl::opt<bool> ClOptGlobals("asan-opt-globals",
 136        cl::desc("Don't instrument scalar globals"), cl::Hidden, cl::init(true));
 137
 138 // Debug flags.
 139 static cl::opt<int> ClDebug("asan-debug", cl::desc("debug"), cl::Hidden,
 140                             cl::init(0));
 141 static cl::opt<int> ClDebugStack("asan-debug-stack", cl::desc("debug stack"),
 142                                  cl::Hidden, cl::init(0));
 143 static cl::opt<std::string> ClDebugFunc("asan-debug-func",
 144                                         cl::Hidden, cl::desc("Debug func"));
 145 static cl::opt<int> ClDebugMin("asan-debug-min", cl::desc("Debug min inst"),
 146                                cl::Hidden, cl::init(-1));
 147 static cl::opt<int> ClDebugMax("asan-debug-max", cl::desc("Debug man inst"),
 148                                cl::Hidden, cl::init(-1));
 149
 150 namespace {
 151 /// AddressSanitizer: instrument the code in module to find memory bugs.
 152 struct AddressSanitizer : public FunctionPass {
 153   AddressSanitizer();
 154   virtual const char *getPassName() const;
 155   void instrumentMop(Instruction *I);
 156   void instrumentAddress(Instruction *OrigIns, IRBuilder<> &IRB,
 157                          Value *Addr, uint32_t TypeSize, bool IsWrite);
 158   Value *createSlowPathCmp(IRBuilder<> &IRB, Value *AddrLong,
 159                            Value *ShadowValue, uint32_t TypeSize);
 160   Instruction *generateCrashCode(Instruction *InsertBefore, Value *Addr,
 161                                  bool IsWrite, size_t AccessSizeIndex);
 162   bool instrumentMemIntrinsic(MemIntrinsic *MI);
 163   void instrumentMemIntrinsicParam(Instruction *OrigIns, Value *Addr,
 164                                    Value *Size,
 165                                    Instruction *InsertBefore, bool IsWrite);
 166   Value *memToShadow(Value *Shadow, IRBuilder<> &IRB);
 167   bool runOnFunction(Function &F);
 168   void createInitializerPoisonCalls(Module &M,
 169                                     Value *FirstAddr, Value *LastAddr);
 170   bool maybeInsertAsanInitAtFunctionEntry(Function &F);
 171   bool poisonStackInFunction(Function &F);
 172   virtual bool doInitialization(Module &M);
 173   virtual bool doFinalization(Module &M);
 174   bool insertGlobalRedzones(Module &M);
 175   static char ID;  // Pass identification, replacement for typeid
 176
 177  private:
 178   uint64_t getAllocaSizeInBytes(AllocaInst *AI) {
 179     Type *Ty = AI->getAllocatedType();
 180     uint64_t SizeInBytes = TD->getTypeAllocSize(Ty);
 181     return SizeInBytes;
 182   }
 183   uint64_t getAlignedSize(uint64_t SizeInBytes) {
 184     return ((SizeInBytes + RedzoneSize - 1)
 185             / RedzoneSize) * RedzoneSize;
 186   }
 187   uint64_t getAlignedAllocaSize(AllocaInst *AI) {
 188     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 189     return getAlignedSize(SizeInBytes);
 190   }
 191
 192   Function *checkInterfaceFunction(Constant *FuncOrBitcast);
 193   bool ShouldInstrumentGlobal(GlobalVariable *G);
 194   void PoisonStack(const ArrayRef<AllocaInst*> &AllocaVec, IRBuilder<> IRB,
 195                    Value *ShadowBase, bool DoPoison);
 196   bool LooksLikeCodeInBug11395(Instruction *I);
 197   void FindDynamicInitializers(Module &M);
 198   bool HasDynamicInitializer(GlobalVariable *G);
 199
 200   LLVMContext *C;
 201   DataLayout *TD;
 202   uint64_t MappingOffset;
 203   int MappingScale;
 204   size_t RedzoneSize;
 205   int LongSize;
 206   Type *IntptrTy;
 207   Type *IntptrPtrTy;
 208   Function *AsanCtorFunction;
 209   Function *AsanInitFunction;
 210   Function *AsanStackMallocFunc, *AsanStackFreeFunc;
 211   Function *AsanHandleNoReturnFunc;
 212   Instruction *CtorInsertBefore;
 213   OwningPtr<BlackList> BL;
 214   // This array is indexed by AccessIsWrite and log2(AccessSize).
 215   Function *AsanErrorCallback[2][kNumberOfAccessSizes];
 216   InlineAsm *EmptyAsm;
 217   SmallSet<GlobalValue*, 32> DynamicallyInitializedGlobals;
 218   SmallSet<GlobalValue*, 32> GlobalsCreatedByAsan;
 219 };
 220
 221 }  // namespace
 222
 223 char AddressSanitizer::ID = 0;
 224 INITIALIZE_PASS(AddressSanitizer, "asan",
 225     "AddressSanitizer: detects use-after-free and out-of-bounds bugs.",
 226     false, false)
 227 AddressSanitizer::AddressSanitizer() : FunctionPass(ID) { }
 228 FunctionPass *llvm::createAddressSanitizerPass() {
 229   return new AddressSanitizer();
 230 }
 231
 232 const char *AddressSanitizer::getPassName() const {
 233   return "AddressSanitizer";
 234 }
 235
 236 static size_t TypeSizeToSizeIndex(uint32_t TypeSize) {
 237   size_t Res = CountTrailingZeros_32(TypeSize / 8);
 238   assert(Res < kNumberOfAccessSizes);
 239   return Res;
 240 }
 241
 242 // Create a constant for Str so that we can pass it to the run-time lib.
 243 static GlobalVariable *createPrivateGlobalForString(Module &M, StringRef Str) {
 244   Constant *StrConst = ConstantDataArray::getString(M.getContext(), Str);
 245   return new GlobalVariable(M, StrConst->getType(), true,
 246                             GlobalValue::PrivateLinkage, StrConst, "");
 247 }
 248
 249 Value *AddressSanitizer::memToShadow(Value *Shadow, IRBuilder<> &IRB) {
 250   // Shadow >> scale
 251   Shadow = IRB.CreateLShr(Shadow, MappingScale);
 252   if (MappingOffset == 0)
 253     return Shadow;
 254   // (Shadow >> scale) | offset
 255   return IRB.CreateOr(Shadow, ConstantInt::get(IntptrTy,
 256                                                MappingOffset));
 257 }
 258
 259 void AddressSanitizer::instrumentMemIntrinsicParam(
 260     Instruction *OrigIns,
 261     Value *Addr, Value *Size, Instruction *InsertBefore, bool IsWrite) {
 262   // Check the first byte.
 263   {
 264     IRBuilder<> IRB(InsertBefore);
 265     instrumentAddress(OrigIns, IRB, Addr, 8, IsWrite);
 266   }
 267   // Check the last byte.
 268   {
 269     IRBuilder<> IRB(InsertBefore);
 270     Value *SizeMinusOne = IRB.CreateSub(
 271         Size, ConstantInt::get(Size->getType(), 1));
 272     SizeMinusOne = IRB.CreateIntCast(SizeMinusOne, IntptrTy, false);
 273     Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 274     Value *AddrPlusSizeMinisOne = IRB.CreateAdd(AddrLong, SizeMinusOne);
 275     instrumentAddress(OrigIns, IRB, AddrPlusSizeMinisOne, 8, IsWrite);
 276   }
 277 }
 278
 279 // Instrument memset/memmove/memcpy
 280 bool AddressSanitizer::instrumentMemIntrinsic(MemIntrinsic *MI) {
 281   Value *Dst = MI->getDest();
 282   MemTransferInst *MemTran = dyn_cast<MemTransferInst>(MI);
 283   Value *Src = MemTran ? MemTran->getSource() : 0;
 284   Value *Length = MI->getLength();
 285
 286   Constant *ConstLength = dyn_cast<Constant>(Length);
 287   Instruction *InsertBefore = MI;
 288   if (ConstLength) {
 289     if (ConstLength->isNullValue()) return false;
 290   } else {
 291     // The size is not a constant so it could be zero -- check at run-time.
 292     IRBuilder<> IRB(InsertBefore);
 293
 294     Value *Cmp = IRB.CreateICmpNE(Length,
 295                                   Constant::getNullValue(Length->getType()));
 296     InsertBefore = SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), false);
 297   }
 298
 299   instrumentMemIntrinsicParam(MI, Dst, Length, InsertBefore, true);
 300   if (Src)
 301     instrumentMemIntrinsicParam(MI, Src, Length, InsertBefore, false);
 302   return true;
 303 }
 304
 305 // If I is an interesting memory access, return the PointerOperand
 306 // and set IsWrite. Otherwise return NULL.
 307 static Value *isInterestingMemoryAccess(Instruction *I, bool *IsWrite) {
 308   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 309     if (!ClInstrumentReads) return NULL;
 310     *IsWrite = false;
 311     return LI->getPointerOperand();
 312   }
 313   if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 314     if (!ClInstrumentWrites) return NULL;
 315     *IsWrite = true;
 316     return SI->getPointerOperand();
 317   }
 318   if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(I)) {
 319     if (!ClInstrumentAtomics) return NULL;
 320     *IsWrite = true;
 321     return RMW->getPointerOperand();
 322   }
 323   if (AtomicCmpXchgInst *XCHG = dyn_cast<AtomicCmpXchgInst>(I)) {
 324     if (!ClInstrumentAtomics) return NULL;
 325     *IsWrite = true;
 326     return XCHG->getPointerOperand();
 327   }
 328   return NULL;
 329 }
 330
 331 void AddressSanitizer::FindDynamicInitializers(Module& M) {
 332   // Clang generates metadata identifying all dynamically initialized globals.
 333   NamedMDNode *DynamicGlobals =
 334       M.getNamedMetadata("llvm.asan.dynamically_initialized_globals");
 335   if (!DynamicGlobals)
 336     return;
 337   for (int i = 0, n = DynamicGlobals->getNumOperands(); i < n; ++i) {
 338     MDNode *MDN = DynamicGlobals->getOperand(i);
 339     assert(MDN->getNumOperands() == 1);
 340     Value *VG = MDN->getOperand(0);
 341     // The optimizer may optimize away a global entirely, in which case we
 342     // cannot instrument access to it.
 343     if (!VG)
 344       continue;
 345
 346     GlobalVariable *G = cast<GlobalVariable>(VG);
 347     DynamicallyInitializedGlobals.insert(G);
 348   }
 349 }
 350 // Returns true if a global variable is initialized dynamically in this TU.
 351 bool AddressSanitizer::HasDynamicInitializer(GlobalVariable *G) {
 352   return DynamicallyInitializedGlobals.count(G);
 353 }
 354
 355 void AddressSanitizer::instrumentMop(Instruction *I) {
 356   bool IsWrite = false;
 357   Value *Addr = isInterestingMemoryAccess(I, &IsWrite);
 358   assert(Addr);
 359   if (ClOpt && ClOptGlobals) {
 360     if (GlobalVariable *G = dyn_cast<GlobalVariable>(Addr)) {
 361       // If initialization order checking is disabled, a simple access to a
 362       // dynamically initialized global is always valid.
 363       if (!ClInitializers)
 364         return;
 365       // If a global variable does not have dynamic initialization we don't
 366       // have to instrument it.  However, if a global has external linkage, we
 367       // assume it has dynamic initialization, as it may have an initializer
 368       // in a different TU.
 369       if (G->getLinkage() != GlobalVariable::ExternalLinkage &&
 370           !HasDynamicInitializer(G))
 371         return;
 372     }
 373   }
 374
 375   Type *OrigPtrTy = Addr->getType();
 376   Type *OrigTy = cast<PointerType>(OrigPtrTy)->getElementType();
 377
 378   assert(OrigTy->isSized());
 379   uint32_t TypeSize = TD->getTypeStoreSizeInBits(OrigTy);
 380
 381   if (TypeSize != 8  && TypeSize != 16 &&
 382       TypeSize != 32 && TypeSize != 64 && TypeSize != 128) {
 383     // Ignore all unusual sizes.
 384     return;
 385   }
 386
 387   IRBuilder<> IRB(I);
 388   instrumentAddress(I, IRB, Addr, TypeSize, IsWrite);
 389 }
 390
 391 // Validate the result of Module::getOrInsertFunction called for an interface
 392 // function of AddressSanitizer. If the instrumented module defines a function
 393 // with the same name, their prototypes must match, otherwise
 394 // getOrInsertFunction returns a bitcast.
 395 Function *AddressSanitizer::checkInterfaceFunction(Constant *FuncOrBitcast) {
 396   if (isa<Function>(FuncOrBitcast)) return cast<Function>(FuncOrBitcast);
 397   FuncOrBitcast->dump();
 398   report_fatal_error("trying to redefine an AddressSanitizer "
 399                      "interface function");
 400 }
 401
 402 Instruction *AddressSanitizer::generateCrashCode(
 403     Instruction *InsertBefore, Value *Addr,
 404     bool IsWrite, size_t AccessSizeIndex) {
 405   IRBuilder<> IRB(InsertBefore);
 406   CallInst *Call = IRB.CreateCall(AsanErrorCallback[IsWrite][AccessSizeIndex],
 407                                   Addr);
 408   // We don't do Call->setDoesNotReturn() because the BB already has
 409   // UnreachableInst at the end.
 410   // This EmptyAsm is required to avoid callback merge.
 411   IRB.CreateCall(EmptyAsm);
 412   return Call;
 413 }
 414
 415 Value *AddressSanitizer::createSlowPathCmp(IRBuilder<> &IRB, Value *AddrLong,
 416                                             Value *ShadowValue,
 417                                             uint32_t TypeSize) {
 418   size_t Granularity = 1 << MappingScale;
 419   // Addr & (Granularity - 1)
 420   Value *LastAccessedByte = IRB.CreateAnd(
 421       AddrLong, ConstantInt::get(IntptrTy, Granularity - 1));
 422   // (Addr & (Granularity - 1)) + size - 1
 423   if (TypeSize / 8 > 1)
 424     LastAccessedByte = IRB.CreateAdd(
 425         LastAccessedByte, ConstantInt::get(IntptrTy, TypeSize / 8 - 1));
 426   // (uint8_t) ((Addr & (Granularity-1)) + size - 1)
 427   LastAccessedByte = IRB.CreateIntCast(
 428       LastAccessedByte, ShadowValue->getType(), false);
 429   // ((uint8_t) ((Addr & (Granularity-1)) + size - 1)) >= ShadowValue
 430   return IRB.CreateICmpSGE(LastAccessedByte, ShadowValue);
 431 }
 432
 433 void AddressSanitizer::instrumentAddress(Instruction *OrigIns,
 434                                          IRBuilder<> &IRB, Value *Addr,
 435                                          uint32_t TypeSize, bool IsWrite) {
 436   Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 437
 438   Type *ShadowTy  = IntegerType::get(
 439       *C, std::max(8U, TypeSize >> MappingScale));
 440   Type *ShadowPtrTy = PointerType::get(ShadowTy, 0);
 441   Value *ShadowPtr = memToShadow(AddrLong, IRB);
 442   Value *CmpVal = Constant::getNullValue(ShadowTy);
 443   Value *ShadowValue = IRB.CreateLoad(
 444       IRB.CreateIntToPtr(ShadowPtr, ShadowPtrTy));
 445
 446   Value *Cmp = IRB.CreateICmpNE(ShadowValue, CmpVal);
 447   size_t AccessSizeIndex = TypeSizeToSizeIndex(TypeSize);
 448   size_t Granularity = 1 << MappingScale;
 449   TerminatorInst *CrashTerm = 0;
 450
 451   if (ClAlwaysSlowPath || (TypeSize < 8 * Granularity)) {
 452     TerminatorInst *CheckTerm =
 453         SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), false);
 454     assert(dyn_cast<BranchInst>(CheckTerm)->isUnconditional());
 455     BasicBlock *NextBB = CheckTerm->getSuccessor(0);
 456     IRB.SetInsertPoint(CheckTerm);
 457     Value *Cmp2 = createSlowPathCmp(IRB, AddrLong, ShadowValue, TypeSize);
 458     BasicBlock *CrashBlock =
 459         BasicBlock::Create(*C, "", NextBB->getParent(), NextBB);
 460     CrashTerm = new UnreachableInst(*C, CrashBlock);
 461     BranchInst *NewTerm = BranchInst::Create(CrashBlock, NextBB, Cmp2);
 462     ReplaceInstWithInst(CheckTerm, NewTerm);
 463   } else {
 464     CrashTerm = SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), true);
 465   }
 466
 467   Instruction *Crash =
 468       generateCrashCode(CrashTerm, AddrLong, IsWrite, AccessSizeIndex);
 469   Crash->setDebugLoc(OrigIns->getDebugLoc());
 470 }
 471
 472 void AddressSanitizer::createInitializerPoisonCalls(Module &M,
 473                                                     Value *FirstAddr,
 474                                                     Value *LastAddr) {
 475   // We do all of our poisoning and unpoisoning within _GLOBAL__I_a.
 476   Function *GlobalInit = M.getFunction("_GLOBAL__I_a");
 477   // If that function is not present, this TU contains no globals, or they have
 478   // all been optimized away
 479   if (!GlobalInit)
 480     return;
 481
 482   // Set up the arguments to our poison/unpoison functions.
 483   IRBuilder<> IRB(GlobalInit->begin()->getFirstInsertionPt());
 484
 485   // Declare our poisoning and unpoisoning functions.
 486   Function *AsanPoisonGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 487       kAsanPoisonGlobalsName, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
 488   AsanPoisonGlobals->setLinkage(Function::ExternalLinkage);
 489   Function *AsanUnpoisonGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 490       kAsanUnpoisonGlobalsName, IRB.getVoidTy(), NULL));
 491   AsanUnpoisonGlobals->setLinkage(Function::ExternalLinkage);
 492
 493   // Add a call to poison all external globals before the given function starts.
 494   IRB.CreateCall2(AsanPoisonGlobals, FirstAddr, LastAddr);
 495
 496   // Add calls to unpoison all globals before each return instruction.
 497   for (Function::iterator I = GlobalInit->begin(), E = GlobalInit->end();
 498       I != E; ++I) {
 499     if (ReturnInst *RI = dyn_cast<ReturnInst>(I->getTerminator())) {
 500       CallInst::Create(AsanUnpoisonGlobals, "", RI);
 501     }
 502   }
 503 }
 504
 505 bool AddressSanitizer::ShouldInstrumentGlobal(GlobalVariable *G) {
 506   Type *Ty = cast<PointerType>(G->getType())->getElementType();
 507   DEBUG(dbgs() << "GLOBAL: " << *G << "\n");
 508
 509   if (BL->isIn(*G)) return false;
 510   if (!Ty->isSized()) return false;
 511   if (!G->hasInitializer()) return false;
 512   if (GlobalsCreatedByAsan.count(G)) return false; // Our own global.
 513   // Touch only those globals that will not be defined in other modules.
 514   // Don't handle ODR type linkages since other modules may be built w/o asan.
 515   if (G->getLinkage() != GlobalVariable::ExternalLinkage &&
 516       G->getLinkage() != GlobalVariable::PrivateLinkage &&
 517       G->getLinkage() != GlobalVariable::InternalLinkage)
 518     return false;
 519   // Two problems with thread-locals:
 520   //   - The address of the main thread's copy can't be computed at link-time.
 521   //   - Need to poison all copies, not just the main thread's one.
 522   if (G->isThreadLocal())
 523     return false;
 524   // For now, just ignore this Alloca if the alignment is large.
 525   if (G->getAlignment() > RedzoneSize) return false;
 526
 527   // Ignore all the globals with the names starting with "\01L_OBJC_".
 528   // Many of those are put into the .cstring section. The linker compresses
 529   // that section by removing the spare \0s after the string terminator, so
 530   // our redzones get broken.
 531   if ((G->getName().find("\01L_OBJC_") == 0) ||
 532       (G->getName().find("\01l_OBJC_") == 0)) {
 533     DEBUG(dbgs() << "Ignoring \\01L_OBJC_* global: " << *G);
 534     return false;
 535   }
 536
 537   if (G->hasSection()) {
 538     StringRef Section(G->getSection());
 539     // Ignore the globals from the __OBJC section. The ObjC runtime assumes
 540     // those conform to /usr/lib/objc/runtime.h, so we can't add redzones to
 541     // them.
 542     if ((Section.find("__OBJC,") == 0) ||
 543         (Section.find("__DATA, __objc_") == 0)) {
 544       DEBUG(dbgs() << "Ignoring ObjC runtime global: " << *G);
 545       return false;
 546     }
 547     // See http://code.google.com/p/address-sanitizer/issues/detail?id=32
 548     // Constant CFString instances are compiled in the following way:
 549     //  -- the string buffer is emitted into
 550     //     __TEXT,__cstring,cstring_literals
 551     //  -- the constant NSConstantString structure referencing that buffer
 552     //     is placed into __DATA,__cfstring
 553     // Therefore there's no point in placing redzones into __DATA,__cfstring.
 554     // Moreover, it causes the linker to crash on OS X 10.7
 555     if (Section.find("__DATA,__cfstring") == 0) {
 556       DEBUG(dbgs() << "Ignoring CFString: " << *G);
 557       return false;
 558     }
 559   }
 560
 561   return true;
 562 }
 563
 564 // This function replaces all global variables with new variables that have
 565 // trailing redzones. It also creates a function that poisons
 566 // redzones and inserts this function into llvm.global_ctors.
 567 bool AddressSanitizer::insertGlobalRedzones(Module &M) {
 568   SmallVector<GlobalVariable *, 16> GlobalsToChange;
 569
 570   for (Module::GlobalListType::iterator G = M.global_begin(),
 571        E = M.global_end(); G != E; ++G) {
 572     if (ShouldInstrumentGlobal(G))
 573       GlobalsToChange.push_back(G);
 574   }
 575
 576   size_t n = GlobalsToChange.size();
 577   if (n == 0) return false;
 578
 579   // A global is described by a structure
 580   //   size_t beg;
 581   //   size_t size;
 582   //   size_t size_with_redzone;
 583   //   const char *name;
 584   //   size_t has_dynamic_init;
 585   // We initialize an array of such structures and pass it to a run-time call.
 586   StructType *GlobalStructTy = StructType::get(IntptrTy, IntptrTy,
 587                                                IntptrTy, IntptrTy,
 588                                                IntptrTy, NULL);
 589   SmallVector<Constant *, 16> Initializers(n), DynamicInit;
 590
 591   IRBuilder<> IRB(CtorInsertBefore);
 592
 593   if (ClInitializers)
 594     FindDynamicInitializers(M);
 595
 596   // The addresses of the first and last dynamically initialized globals in
 597   // this TU.  Used in initialization order checking.
 598   Value *FirstDynamic = 0, *LastDynamic = 0;
 599
 600   for (size_t i = 0; i < n; i++) {
 601     GlobalVariable *G = GlobalsToChange[i];
 602     PointerType *PtrTy = cast<PointerType>(G->getType());
 603     Type *Ty = PtrTy->getElementType();
 604     uint64_t SizeInBytes = TD->getTypeAllocSize(Ty);
 605     uint64_t RightRedzoneSize = RedzoneSize +
 606         (RedzoneSize - (SizeInBytes % RedzoneSize));
 607     Type *RightRedZoneTy = ArrayType::get(IRB.getInt8Ty(), RightRedzoneSize);
 608     // Determine whether this global should be poisoned in initialization.
 609     bool GlobalHasDynamicInitializer = HasDynamicInitializer(G);
 610     // Don't check initialization order if this global is blacklisted.
 611     GlobalHasDynamicInitializer &= !BL->isInInit(*G);
 612
 613     StructType *NewTy = StructType::get(Ty, RightRedZoneTy, NULL);
 614     Constant *NewInitializer = ConstantStruct::get(
 615         NewTy, G->getInitializer(),
 616         Constant::getNullValue(RightRedZoneTy), NULL);
 617
 618     SmallString<2048> DescriptionOfGlobal = G->getName();
 619     DescriptionOfGlobal += " (";
 620     DescriptionOfGlobal += M.getModuleIdentifier();
 621     DescriptionOfGlobal += ")";
 622     GlobalVariable *Name = createPrivateGlobalForString(M, DescriptionOfGlobal);
 623
 624     // Create a new global variable with enough space for a redzone.
 625     GlobalVariable *NewGlobal = new GlobalVariable(
 626         M, NewTy, G->isConstant(), G->getLinkage(),
 627         NewInitializer, "", G, G->getThreadLocalMode());
 628     NewGlobal->copyAttributesFrom(G);
 629     NewGlobal->setAlignment(RedzoneSize);
 630
 631     Value *Indices2[2];
 632     Indices2[0] = IRB.getInt32(0);
 633     Indices2[1] = IRB.getInt32(0);
 634
 635     G->replaceAllUsesWith(
 636         ConstantExpr::getGetElementPtr(NewGlobal, Indices2, true));
 637     NewGlobal->takeName(G);
 638     G->eraseFromParent();
 639
 640     Initializers[i] = ConstantStruct::get(
 641         GlobalStructTy,
 642         ConstantExpr::getPointerCast(NewGlobal, IntptrTy),
 643         ConstantInt::get(IntptrTy, SizeInBytes),
 644         ConstantInt::get(IntptrTy, SizeInBytes + RightRedzoneSize),
 645         ConstantExpr::getPointerCast(Name, IntptrTy),
 646         ConstantInt::get(IntptrTy, GlobalHasDynamicInitializer),
 647         NULL);
 648
 649     // Populate the first and last globals declared in this TU.
 650     if (ClInitializers && GlobalHasDynamicInitializer) {
 651       LastDynamic = ConstantExpr::getPointerCast(NewGlobal, IntptrTy);
 652       if (FirstDynamic == 0)
 653         FirstDynamic = LastDynamic;
 654     }
 655
 656     DEBUG(dbgs() << "NEW GLOBAL: " << *NewGlobal << "\n");
 657   }
 658
 659   ArrayType *ArrayOfGlobalStructTy = ArrayType::get(GlobalStructTy, n);
 660   GlobalVariable *AllGlobals = new GlobalVariable(
 661       M, ArrayOfGlobalStructTy, false, GlobalVariable::PrivateLinkage,
 662       ConstantArray::get(ArrayOfGlobalStructTy, Initializers), "");
 663
 664   // Create calls for poisoning before initializers run and unpoisoning after.
 665   if (ClInitializers && FirstDynamic && LastDynamic)
 666     createInitializerPoisonCalls(M, FirstDynamic, LastDynamic);
 667
 668   Function *AsanRegisterGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 669       kAsanRegisterGlobalsName, IRB.getVoidTy(),
 670       IntptrTy, IntptrTy, NULL));
 671   AsanRegisterGlobals->setLinkage(Function::ExternalLinkage);
 672
 673   IRB.CreateCall2(AsanRegisterGlobals,
 674                   IRB.CreatePointerCast(AllGlobals, IntptrTy),
 675                   ConstantInt::get(IntptrTy, n));
 676
 677   // We also need to unregister globals at the end, e.g. when a shared library
 678   // gets closed.
 679   Function *AsanDtorFunction = Function::Create(
 680       FunctionType::get(Type::getVoidTy(*C), false),
 681       GlobalValue::InternalLinkage, kAsanModuleDtorName, &M);
 682   BasicBlock *AsanDtorBB = BasicBlock::Create(*C, "", AsanDtorFunction);
 683   IRBuilder<> IRB_Dtor(ReturnInst::Create(*C, AsanDtorBB));
 684   Function *AsanUnregisterGlobals =
 685       checkInterfaceFunction(M.getOrInsertFunction(
 686           kAsanUnregisterGlobalsName,
 687           IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
 688   AsanUnregisterGlobals->setLinkage(Function::ExternalLinkage);
 689
 690   IRB_Dtor.CreateCall2(AsanUnregisterGlobals,
 691                        IRB.CreatePointerCast(AllGlobals, IntptrTy),
 692                        ConstantInt::get(IntptrTy, n));
 693   appendToGlobalDtors(M, AsanDtorFunction, kAsanCtorAndCtorPriority);
 694
 695   DEBUG(dbgs() << M);
 696   return true;
 697 }
 698
 699 // virtual
 700 bool AddressSanitizer::doInitialization(Module &M) {
 701   // Initialize the private fields. No one has accessed them before.
 702   TD = getAnalysisIfAvailable<DataLayout>();
 703
 704   if (!TD)
 705     return false;
 706   BL.reset(new BlackList(ClBlackListFile));
 707
 708   C = &(M.getContext());
 709   LongSize = TD->getPointerSizeInBits();
 710   IntptrTy = Type::getIntNTy(*C, LongSize);
 711   IntptrPtrTy = PointerType::get(IntptrTy, 0);
 712
 713   AsanCtorFunction = Function::Create(
 714       FunctionType::get(Type::getVoidTy(*C), false),
 715       GlobalValue::InternalLinkage, kAsanModuleCtorName, &M);
 716   BasicBlock *AsanCtorBB = BasicBlock::Create(*C, "", AsanCtorFunction);
 717   CtorInsertBefore = ReturnInst::Create(*C, AsanCtorBB);
 718
 719   // call __asan_init in the module ctor.
 720   IRBuilder<> IRB(CtorInsertBefore);
 721   AsanInitFunction = checkInterfaceFunction(
 722       M.getOrInsertFunction(kAsanInitName, IRB.getVoidTy(), NULL));
 723   AsanInitFunction->setLinkage(Function::ExternalLinkage);
 724   IRB.CreateCall(AsanInitFunction);
 725
 726   // Create __asan_report* callbacks.
 727   for (size_t AccessIsWrite = 0; AccessIsWrite <= 1; AccessIsWrite++) {
 728     for (size_t AccessSizeIndex = 0; AccessSizeIndex < kNumberOfAccessSizes;
 729          AccessSizeIndex++) {
 730       // IsWrite and TypeSize are encoded in the function name.
 731       std::string FunctionName = std::string(kAsanReportErrorTemplate) +
 732           (AccessIsWrite ? "store" : "load") + itostr(1 << AccessSizeIndex);
 733       // If we are merging crash callbacks, they have two parameters.
 734       AsanErrorCallback[AccessIsWrite][AccessSizeIndex] = cast<Function>(
 735           M.getOrInsertFunction(FunctionName, IRB.getVoidTy(), IntptrTy, NULL));
 736     }
 737   }
 738
 739   AsanStackMallocFunc = checkInterfaceFunction(M.getOrInsertFunction(
 740       kAsanStackMallocName, IntptrTy, IntptrTy, IntptrTy, NULL));
 741   AsanStackFreeFunc = checkInterfaceFunction(M.getOrInsertFunction(
 742       kAsanStackFreeName, IRB.getVoidTy(),
 743       IntptrTy, IntptrTy, IntptrTy, NULL));
 744   AsanHandleNoReturnFunc = checkInterfaceFunction(M.getOrInsertFunction(
 745       kAsanHandleNoReturnName, IRB.getVoidTy(), NULL));
 746
 747   // We insert an empty inline asm after __asan_report* to avoid callback merge.
 748   EmptyAsm = InlineAsm::get(FunctionType::get(IRB.getVoidTy(), false),
 749                             StringRef(""), StringRef(""),
 750                             /*hasSideEffects=*/true);
 751
 752   llvm::Triple targetTriple(M.getTargetTriple());
 753   bool isAndroid = targetTriple.getEnvironment() == llvm::Triple::Android;
 754
 755   MappingOffset = isAndroid ? kDefaultShadowOffsetAndroid :
 756     (LongSize == 32 ? kDefaultShadowOffset32 : kDefaultShadowOffset64);
 757   if (ClMappingOffsetLog >= 0) {
 758     if (ClMappingOffsetLog == 0) {
 759       // special case
 760       MappingOffset = 0;
 761     } else {
 762       MappingOffset = 1ULL << ClMappingOffsetLog;
 763     }
 764   }
 765   MappingScale = kDefaultShadowScale;
 766   if (ClMappingScale) {
 767     MappingScale = ClMappingScale;
 768   }
 769   // Redzone used for stack and globals is at least 32 bytes.
 770   // For scales 6 and 7, the redzone has to be 64 and 128 bytes respectively.
 771   RedzoneSize = std::max(32, (int)(1 << MappingScale));
 772
 773
 774   if (ClMappingOffsetLog >= 0) {
 775     // Tell the run-time the current values of mapping offset and scale.
 776     GlobalValue *asan_mapping_offset =
 777         new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
 778                        ConstantInt::get(IntptrTy, MappingOffset),
 779                        kAsanMappingOffsetName);
 780     // Read the global, otherwise it may be optimized away.
 781     IRB.CreateLoad(asan_mapping_offset, true);
 782   }
 783   if (ClMappingScale) {
 784     GlobalValue *asan_mapping_scale =
 785         new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
 786                            ConstantInt::get(IntptrTy, MappingScale),
 787                            kAsanMappingScaleName);
 788     // Read the global, otherwise it may be optimized away.
 789     IRB.CreateLoad(asan_mapping_scale, true);
 790   }
 791
 792   appendToGlobalCtors(M, AsanCtorFunction, kAsanCtorAndCtorPriority);
 793
 794   return true;
 795 }
 796
 797 bool AddressSanitizer::doFinalization(Module &M) {
 798   // We transform the globals at the very end so that the optimization analysis
 799   // works on the original globals.
 800   if (ClGlobals)
 801     return insertGlobalRedzones(M);
 802   return false;
 803 }
 804
 805
 806 bool AddressSanitizer::maybeInsertAsanInitAtFunctionEntry(Function &F) {
 807   // For each NSObject descendant having a +load method, this method is invoked
 808   // by the ObjC runtime before any of the static constructors is called.
 809   // Therefore we need to instrument such methods with a call to __asan_init
 810   // at the beginning in order to initialize our runtime before any access to
 811   // the shadow memory.
 812   // We cannot just ignore these methods, because they may call other
 813   // instrumented functions.
 814   if (F.getName().find(" load]") != std::string::npos) {
 815     IRBuilder<> IRB(F.begin()->begin());
 816     IRB.CreateCall(AsanInitFunction);
 817     return true;
 818   }
 819   return false;
 820 }
 821
 822 bool AddressSanitizer::runOnFunction(Function &F) {
 823   if (BL->isIn(F)) return false;
 824   if (&F == AsanCtorFunction) return false;
 825   DEBUG(dbgs() << "ASAN instrumenting:\n" << F << "\n");
 826
 827   // If needed, insert __asan_init before checking for AddressSafety attr.
 828   maybeInsertAsanInitAtFunctionEntry(F);
 829
 830   if (!F.getFnAttributes().hasAttribute(Attributes::AddressSafety))
 831     return false;
 832
 833   if (!ClDebugFunc.empty() && ClDebugFunc != F.getName())
 834     return false;
 835
 836   // We want to instrument every address only once per basic block (unless there
 837   // are calls between uses).
 838   SmallSet<Value*, 16> TempsToInstrument;
 839   SmallVector<Instruction*, 16> ToInstrument;
 840   SmallVector<Instruction*, 8> NoReturnCalls;
 841   bool IsWrite;
 842
 843   // Fill the set of memory operations to instrument.
 844   for (Function::iterator FI = F.begin(), FE = F.end();
 845        FI != FE; ++FI) {
 846     TempsToInstrument.clear();
 847     int NumInsnsPerBB = 0;
 848     for (BasicBlock::iterator BI = FI->begin(), BE = FI->end();
 849          BI != BE; ++BI) {
 850       if (LooksLikeCodeInBug11395(BI)) return false;
 851       if (Value *Addr = isInterestingMemoryAccess(BI, &IsWrite)) {
 852         if (ClOpt && ClOptSameTemp) {
 853           if (!TempsToInstrument.insert(Addr))
 854             continue;  // We've seen this temp in the current BB.
 855         }
 856       } else if (isa<MemIntrinsic>(BI) && ClMemIntrin) {
 857         // ok, take it.
 858       } else {
 859         if (CallInst *CI = dyn_cast<CallInst>(BI)) {
 860           // A call inside BB.
 861           TempsToInstrument.clear();
 862           if (CI->doesNotReturn()) {
 863             NoReturnCalls.push_back(CI);
 864           }
 865         }
 866         continue;
 867       }
 868       ToInstrument.push_back(BI);
 869       NumInsnsPerBB++;
 870       if (NumInsnsPerBB >= ClMaxInsnsToInstrumentPerBB)
 871         break;
 872     }
 873   }
 874
 875   // Instrument.
 876   int NumInstrumented = 0;
 877   for (size_t i = 0, n = ToInstrument.size(); i != n; i++) {
 878     Instruction *Inst = ToInstrument[i];
 879     if (ClDebugMin < 0 || ClDebugMax < 0 ||
 880         (NumInstrumented >= ClDebugMin && NumInstrumented <= ClDebugMax)) {
 881       if (isInterestingMemoryAccess(Inst, &IsWrite))
 882         instrumentMop(Inst);
 883       else
 884         instrumentMemIntrinsic(cast<MemIntrinsic>(Inst));
 885     }
 886     NumInstrumented++;
 887   }
 888
 889   bool ChangedStack = poisonStackInFunction(F);
 890
 891   // We must unpoison the stack before every NoReturn call (throw, _exit, etc).
 892   // See e.g. http://code.google.com/p/address-sanitizer/issues/detail?id=37
 893   for (size_t i = 0, n = NoReturnCalls.size(); i != n; i++) {
 894     Instruction *CI = NoReturnCalls[i];
 895     IRBuilder<> IRB(CI);
 896     IRB.CreateCall(AsanHandleNoReturnFunc);
 897   }
 898   DEBUG(dbgs() << "ASAN done instrumenting:\n" << F << "\n");
 899
 900   return NumInstrumented > 0 || ChangedStack || !NoReturnCalls.empty();
 901 }
 902
 903 static uint64_t ValueForPoison(uint64_t PoisonByte, size_t ShadowRedzoneSize) {
 904   if (ShadowRedzoneSize == 1) return PoisonByte;
 905   if (ShadowRedzoneSize == 2) return (PoisonByte << 8) + PoisonByte;
 906   if (ShadowRedzoneSize == 4)
 907     return (PoisonByte << 24) + (PoisonByte << 16) +
 908         (PoisonByte << 8) + (PoisonByte);
 909   llvm_unreachable("ShadowRedzoneSize is either 1, 2 or 4");
 910 }
 911
 912 static void PoisonShadowPartialRightRedzone(uint8_t *Shadow,
 913                                             size_t Size,
 914                                             size_t RedzoneSize,
 915                                             size_t ShadowGranularity,
 916                                             uint8_t Magic) {
 917   for (size_t i = 0; i < RedzoneSize;
 918        i+= ShadowGranularity, Shadow++) {
 919     if (i + ShadowGranularity <= Size) {
 920       *Shadow = 0;  // fully addressable
 921     } else if (i >= Size) {
 922       *Shadow = Magic;  // unaddressable
 923     } else {
 924       *Shadow = Size - i;  // first Size-i bytes are addressable
 925     }
 926   }
 927 }
 928
 929 void AddressSanitizer::PoisonStack(const ArrayRef<AllocaInst*> &AllocaVec,
 930                                    IRBuilder<> IRB,
 931                                    Value *ShadowBase, bool DoPoison) {
 932   size_t ShadowRZSize = RedzoneSize >> MappingScale;
 933   assert(ShadowRZSize >= 1 && ShadowRZSize <= 4);
 934   Type *RZTy = Type::getIntNTy(*C, ShadowRZSize * 8);
 935   Type *RZPtrTy = PointerType::get(RZTy, 0);
 936
 937   Value *PoisonLeft  = ConstantInt::get(RZTy,
 938     ValueForPoison(DoPoison ? kAsanStackLeftRedzoneMagic : 0LL, ShadowRZSize));
 939   Value *PoisonMid   = ConstantInt::get(RZTy,
 940     ValueForPoison(DoPoison ? kAsanStackMidRedzoneMagic : 0LL, ShadowRZSize));
 941   Value *PoisonRight = ConstantInt::get(RZTy,
 942     ValueForPoison(DoPoison ? kAsanStackRightRedzoneMagic : 0LL, ShadowRZSize));
 943
 944   // poison the first red zone.
 945   IRB.CreateStore(PoisonLeft, IRB.CreateIntToPtr(ShadowBase, RZPtrTy));
 946
 947   // poison all other red zones.
 948   uint64_t Pos = RedzoneSize;
 949   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
 950     AllocaInst *AI = AllocaVec[i];
 951     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 952     uint64_t AlignedSize = getAlignedAllocaSize(AI);
 953     assert(AlignedSize - SizeInBytes < RedzoneSize);
 954     Value *Ptr = NULL;
 955
 956     Pos += AlignedSize;
 957
 958     assert(ShadowBase->getType() == IntptrTy);
 959     if (SizeInBytes < AlignedSize) {
 960       // Poison the partial redzone at right
 961       Ptr = IRB.CreateAdd(
 962           ShadowBase, ConstantInt::get(IntptrTy,
 963                                        (Pos >> MappingScale) - ShadowRZSize));
 964       size_t AddressableBytes = RedzoneSize - (AlignedSize - SizeInBytes);
 965       uint32_t Poison = 0;
 966       if (DoPoison) {
 967         PoisonShadowPartialRightRedzone((uint8_t*)&Poison, AddressableBytes,
 968                                         RedzoneSize,
 969                                         1ULL << MappingScale,
 970                                         kAsanStackPartialRedzoneMagic);
 971       }
 972       Value *PartialPoison = ConstantInt::get(RZTy, Poison);
 973       IRB.CreateStore(PartialPoison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
 974     }
 975
 976     // Poison the full redzone at right.
 977     Ptr = IRB.CreateAdd(ShadowBase,
 978                         ConstantInt::get(IntptrTy, Pos >> MappingScale));
 979     Value *Poison = i == AllocaVec.size() - 1 ? PoisonRight : PoisonMid;
 980     IRB.CreateStore(Poison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
 981
 982     Pos += RedzoneSize;
 983   }
 984 }
 985
 986 // Workaround for bug 11395: we don't want to instrument stack in functions
 987 // with large assembly blobs (32-bit only), otherwise reg alloc may crash.
 988 // FIXME: remove once the bug 11395 is fixed.
 989 bool AddressSanitizer::LooksLikeCodeInBug11395(Instruction *I) {
 990   if (LongSize != 32) return false;
 991   CallInst *CI = dyn_cast<CallInst>(I);
 992   if (!CI || !CI->isInlineAsm()) return false;
 993   if (CI->getNumArgOperands() <= 5) return false;
 994   // We have inline assembly with quite a few arguments.
 995   return true;
 996 }
 997
 998 // Find all static Alloca instructions and put
 999 // poisoned red zones around all of them.
1000 // Then unpoison everything back before the function returns.
1001 //
1002 // Stack poisoning does not play well with exception handling.
1003 // When an exception is thrown, we essentially bypass the code
1004 // that unpoisones the stack. This is why the run-time library has
1005 // to intercept __cxa_throw (as well as longjmp, etc) and unpoison the entire
1006 // stack in the interceptor. This however does not work inside the
1007 // actual function which catches the exception. Most likely because the
1008 // compiler hoists the load of the shadow value somewhere too high.
1009 // This causes asan to report a non-existing bug on 453.povray.
1010 // It sounds like an LLVM bug.
1011 bool AddressSanitizer::poisonStackInFunction(Function &F) {
1012   if (!ClStack) return false;
1013   SmallVector<AllocaInst*, 16> AllocaVec;
1014   SmallVector<Instruction*, 8> RetVec;
1015   uint64_t TotalSize = 0;
1016
1017   // Filter out Alloca instructions we want (and can) handle.
1018   // Collect Ret instructions.
1019   for (Function::iterator FI = F.begin(), FE = F.end();
1020        FI != FE; ++FI) {
1021     BasicBlock &BB = *FI;
1022     for (BasicBlock::iterator BI = BB.begin(), BE = BB.end();
1023          BI != BE; ++BI) {
1024       if (isa<ReturnInst>(BI)) {
1025           RetVec.push_back(BI);
1026           continue;
1027       }
1028
1029       AllocaInst *AI = dyn_cast<AllocaInst>(BI);
1030       if (!AI) continue;
1031       if (AI->isArrayAllocation()) continue;
1032       if (!AI->isStaticAlloca()) continue;
1033       if (!AI->getAllocatedType()->isSized()) continue;
1034       if (AI->getAlignment() > RedzoneSize) continue;
1035       AllocaVec.push_back(AI);
1036       uint64_t AlignedSize =  getAlignedAllocaSize(AI);
1037       TotalSize += AlignedSize;
1038     }
1039   }
1040
1041   if (AllocaVec.empty()) return false;
1042
1043   uint64_t LocalStackSize = TotalSize + (AllocaVec.size() + 1) * RedzoneSize;
1044
1045   bool DoStackMalloc = ClUseAfterReturn
1046       && LocalStackSize <= kMaxStackMallocSize;
1047
1048   Instruction *InsBefore = AllocaVec[0];
1049   IRBuilder<> IRB(InsBefore);
1050
1051
1052   Type *ByteArrayTy = ArrayType::get(IRB.getInt8Ty(), LocalStackSize);
1053   AllocaInst *MyAlloca =
1054       new AllocaInst(ByteArrayTy, "MyAlloca", InsBefore);
1055   MyAlloca->setAlignment(RedzoneSize);
1056   assert(MyAlloca->isStaticAlloca());
1057   Value *OrigStackBase = IRB.CreatePointerCast(MyAlloca, IntptrTy);
1058   Value *LocalStackBase = OrigStackBase;
1059
1060   if (DoStackMalloc) {
1061     LocalStackBase = IRB.CreateCall2(AsanStackMallocFunc,
1062         ConstantInt::get(IntptrTy, LocalStackSize), OrigStackBase);
1063   }
1064
1065   // This string will be parsed by the run-time (DescribeStackAddress).
1066   SmallString<2048> StackDescriptionStorage;
1067   raw_svector_ostream StackDescription(StackDescriptionStorage);
1068   StackDescription << F.getName() << " " << AllocaVec.size() << " ";
1069
1070   uint64_t Pos = RedzoneSize;
1071   // Replace Alloca instructions with base+offset.
1072   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
1073     AllocaInst *AI = AllocaVec[i];
1074     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
1075     StringRef Name = AI->getName();
1076     StackDescription << Pos << " " << SizeInBytes << " "
1077                      << Name.size() << " " << Name << " ";
1078     uint64_t AlignedSize = getAlignedAllocaSize(AI);
1079     assert((AlignedSize % RedzoneSize) == 0);
1080     AI->replaceAllUsesWith(
1081         IRB.CreateIntToPtr(
1082             IRB.CreateAdd(LocalStackBase, ConstantInt::get(IntptrTy, Pos)),
1083             AI->getType()));
1084     Pos += AlignedSize + RedzoneSize;
1085   }
1086   assert(Pos == LocalStackSize);
1087
1088   // Write the Magic value and the frame description constant to the redzone.
1089   Value *BasePlus0 = IRB.CreateIntToPtr(LocalStackBase, IntptrPtrTy);
1090   IRB.CreateStore(ConstantInt::get(IntptrTy, kCurrentStackFrameMagic),
1091                   BasePlus0);
1092   Value *BasePlus1 = IRB.CreateAdd(LocalStackBase,
1093                                    ConstantInt::get(IntptrTy, LongSize/8));
1094   BasePlus1 = IRB.CreateIntToPtr(BasePlus1, IntptrPtrTy);
1095   GlobalVariable *StackDescriptionGlobal =
1096       createPrivateGlobalForString(*F.getParent(), StackDescription.str());
1097   GlobalsCreatedByAsan.insert(StackDescriptionGlobal);
1098   Value *Description = IRB.CreatePointerCast(StackDescriptionGlobal, IntptrTy);
1099   IRB.CreateStore(Description, BasePlus1);
1100
1101   // Poison the stack redzones at the entry.
1102   Value *ShadowBase = memToShadow(LocalStackBase, IRB);
1103   PoisonStack(ArrayRef<AllocaInst*>(AllocaVec), IRB, ShadowBase, true);
1104
1105   // Unpoison the stack before all ret instructions.
1106   for (size_t i = 0, n = RetVec.size(); i < n; i++) {
1107     Instruction *Ret = RetVec[i];
1108     IRBuilder<> IRBRet(Ret);
1109
1110     // Mark the current frame as retired.
1111     IRBRet.CreateStore(ConstantInt::get(IntptrTy, kRetiredStackFrameMagic),
1112                        BasePlus0);
1113     // Unpoison the stack.
1114     PoisonStack(ArrayRef<AllocaInst*>(AllocaVec), IRBRet, ShadowBase, false);
1115
1116     if (DoStackMalloc) {
1117       IRBRet.CreateCall3(AsanStackFreeFunc, LocalStackBase,
1118                          ConstantInt::get(IntptrTy, LocalStackSize),
1119                          OrigStackBase);
1120     }
1121   }
1122
1123   // We are done. Remove the old unused alloca instructions.
1124   for (size_t i = 0, n = AllocaVec.size(); i < n; i++)
1125     AllocaVec[i]->eraseFromParent();
1126
1127   if (ClDebugStack) {
1128     DEBUG(dbgs() << F);
1129   }
1130
1131   return true;
1132 }