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/Transforms/Instrumentation.h"
  19 #include "llvm/ADT/ArrayRef.h"
  20 #include "llvm/ADT/DenseMap.h"
  21 #include "llvm/ADT/DepthFirstIterator.h"
  22 #include "llvm/ADT/OwningPtr.h"
  23 #include "llvm/ADT/SmallSet.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/ADT/SmallVector.h"
  26 #include "llvm/ADT/StringExtras.h"
  27 #include "llvm/ADT/Triple.h"
  28 #include "llvm/DIBuilder.h"
  29 #include "llvm/IR/DataLayout.h"
  30 #include "llvm/IR/Function.h"
  31 #include "llvm/IR/IRBuilder.h"
  32 #include "llvm/IR/InlineAsm.h"
  33 #include "llvm/IR/IntrinsicInst.h"
  34 #include "llvm/IR/LLVMContext.h"
  35 #include "llvm/IR/Module.h"
  36 #include "llvm/IR/Type.h"
  37 #include "llvm/InstVisitor.h"
  38 #include "llvm/Support/CallSite.h"
  39 #include "llvm/Support/CommandLine.h"
  40 #include "llvm/Support/DataTypes.h"
  41 #include "llvm/Support/Debug.h"
  42 #include "llvm/Support/Endian.h"
  43 #include "llvm/Support/raw_ostream.h"
  44 #include "llvm/Support/system_error.h"
  45 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  46 #include "llvm/Transforms/Utils/BlackList.h"
  47 #include "llvm/Transforms/Utils/Cloning.h"
  48 #include "llvm/Transforms/Utils/Local.h"
  49 #include "llvm/Transforms/Utils/ModuleUtils.h"
  50 #include <algorithm>
  51 #include <string>
  52
  53 using namespace llvm;
  54
  55 static const uint64_t kDefaultShadowScale = 3;
  56 static const uint64_t kDefaultShadowOffset32 = 1ULL << 29;
  57 static const uint64_t kDefaultShadowOffset64 = 1ULL << 44;
  58 static const uint64_t kDefaultShort64bitShadowOffset = 0x7FFF8000;  // < 2G.
  59 static const uint64_t kPPC64_ShadowOffset64 = 1ULL << 41;
  60 static const uint64_t kMIPS32_ShadowOffset32 = 0x0aaa8000;
  61
  62 static const size_t kMaxStackMallocSize = 1 << 16;  // 64K
  63 static const uintptr_t kCurrentStackFrameMagic = 0x41B58AB3;
  64 static const uintptr_t kRetiredStackFrameMagic = 0x45E0360E;
  65
  66 static const char *kAsanModuleCtorName = "asan.module_ctor";
  67 static const char *kAsanModuleDtorName = "asan.module_dtor";
  68 static const int   kAsanCtorAndCtorPriority = 1;
  69 static const char *kAsanReportErrorTemplate = "__asan_report_";
  70 static const char *kAsanReportLoadN = "__asan_report_load_n";
  71 static const char *kAsanReportStoreN = "__asan_report_store_n";
  72 static const char *kAsanRegisterGlobalsName = "__asan_register_globals";
  73 static const char *kAsanUnregisterGlobalsName = "__asan_unregister_globals";
  74 static const char *kAsanPoisonGlobalsName = "__asan_before_dynamic_init";
  75 static const char *kAsanUnpoisonGlobalsName = "__asan_after_dynamic_init";
  76 static const char *kAsanInitName = "__asan_init_v3";
  77 static const char *kAsanHandleNoReturnName = "__asan_handle_no_return";
  78 static const char *kAsanMappingOffsetName = "__asan_mapping_offset";
  79 static const char *kAsanMappingScaleName = "__asan_mapping_scale";
  80 static const char *kAsanStackMallocName = "__asan_stack_malloc";
  81 static const char *kAsanStackFreeName = "__asan_stack_free";
  82 static const char *kAsanGenPrefix = "__asan_gen_";
  83 static const char *kAsanPoisonStackMemoryName = "__asan_poison_stack_memory";
  84 static const char *kAsanUnpoisonStackMemoryName =
  85     "__asan_unpoison_stack_memory";
  86
  87 static const int kAsanStackLeftRedzoneMagic = 0xf1;
  88 static const int kAsanStackMidRedzoneMagic = 0xf2;
  89 static const int kAsanStackRightRedzoneMagic = 0xf3;
  90 static const int kAsanStackPartialRedzoneMagic = 0xf4;
  91
  92 // Accesses sizes are powers of two: 1, 2, 4, 8, 16.
  93 static const size_t kNumberOfAccessSizes = 5;
  94
  95 // Command-line flags.
  96
  97 // This flag may need to be replaced with -f[no-]asan-reads.
  98 static cl::opt<bool> ClInstrumentReads("asan-instrument-reads",
  99        cl::desc("instrument read instructions"), cl::Hidden, cl::init(true));
 100 static cl::opt<bool> ClInstrumentWrites("asan-instrument-writes",
 101        cl::desc("instrument write instructions"), cl::Hidden, cl::init(true));
 102 static cl::opt<bool> ClInstrumentAtomics("asan-instrument-atomics",
 103        cl::desc("instrument atomic instructions (rmw, cmpxchg)"),
 104        cl::Hidden, cl::init(true));
 105 static cl::opt<bool> ClAlwaysSlowPath("asan-always-slow-path",
 106        cl::desc("use instrumentation with slow path for all accesses"),
 107        cl::Hidden, cl::init(false));
 108 // This flag limits the number of instructions to be instrumented
 109 // in any given BB. Normally, this should be set to unlimited (INT_MAX),
 110 // but due to http://llvm.org/bugs/show_bug.cgi?id=12652 we temporary
 111 // set it to 10000.
 112 static cl::opt<int> ClMaxInsnsToInstrumentPerBB("asan-max-ins-per-bb",
 113        cl::init(10000),
 114        cl::desc("maximal number of instructions to instrument in any given BB"),
 115        cl::Hidden);
 116 // This flag may need to be replaced with -f[no]asan-stack.
 117 static cl::opt<bool> ClStack("asan-stack",
 118        cl::desc("Handle stack memory"), cl::Hidden, cl::init(true));
 119 // This flag may need to be replaced with -f[no]asan-use-after-return.
 120 static cl::opt<bool> ClUseAfterReturn("asan-use-after-return",
 121        cl::desc("Check return-after-free"), cl::Hidden, cl::init(false));
 122 // This flag may need to be replaced with -f[no]asan-globals.
 123 static cl::opt<bool> ClGlobals("asan-globals",
 124        cl::desc("Handle global objects"), cl::Hidden, cl::init(true));
 125 static cl::opt<bool> ClInitializers("asan-initialization-order",
 126        cl::desc("Handle C++ initializer order"), cl::Hidden, cl::init(false));
 127 static cl::opt<bool> ClMemIntrin("asan-memintrin",
 128        cl::desc("Handle memset/memcpy/memmove"), cl::Hidden, cl::init(true));
 129 static cl::opt<bool> ClRealignStack("asan-realign-stack",
 130        cl::desc("Realign stack to 32"), cl::Hidden, cl::init(true));
 131 static cl::opt<std::string> ClBlacklistFile("asan-blacklist",
 132        cl::desc("File containing the list of objects to ignore "
 133                 "during instrumentation"), cl::Hidden);
 134
 135 // This is an experimental feature that will allow to choose between
 136 // instrumented and non-instrumented code at link-time.
 137 // If this option is on, just before instrumenting a function we create its
 138 // clone; if the function is not changed by asan the clone is deleted.
 139 // If we end up with a clone, we put the instrumented function into a section
 140 // called "ASAN" and the uninstrumented function into a section called "NOASAN".
 141 //
 142 // This is still a prototype, we need to figure out a way to keep two copies of
 143 // a function so that the linker can easily choose one of them.
 144 static cl::opt<bool> ClKeepUninstrumented("asan-keep-uninstrumented-functions",
 145        cl::desc("Keep uninstrumented copies of functions"),
 146        cl::Hidden, cl::init(false));
 147
 148 // These flags allow to change the shadow mapping.
 149 // The shadow mapping looks like
 150 //    Shadow = (Mem >> scale) + (1 << offset_log)
 151 static cl::opt<int> ClMappingScale("asan-mapping-scale",
 152        cl::desc("scale of asan shadow mapping"), cl::Hidden, cl::init(0));
 153 static cl::opt<int> ClMappingOffsetLog("asan-mapping-offset-log",
 154        cl::desc("offset of asan shadow mapping"), cl::Hidden, cl::init(-1));
 155 static cl::opt<bool> ClShort64BitOffset("asan-short-64bit-mapping-offset",
 156        cl::desc("Use short immediate constant as the mapping offset for 64bit"),
 157        cl::Hidden, cl::init(true));
 158
 159 // Optimization flags. Not user visible, used mostly for testing
 160 // and benchmarking the tool.
 161 static cl::opt<bool> ClOpt("asan-opt",
 162        cl::desc("Optimize instrumentation"), cl::Hidden, cl::init(true));
 163 static cl::opt<bool> ClOptSameTemp("asan-opt-same-temp",
 164        cl::desc("Instrument the same temp just once"), cl::Hidden,
 165        cl::init(true));
 166 static cl::opt<bool> ClOptGlobals("asan-opt-globals",
 167        cl::desc("Don't instrument scalar globals"), cl::Hidden, cl::init(true));
 168
 169 static cl::opt<bool> ClCheckLifetime("asan-check-lifetime",
 170        cl::desc("Use llvm.lifetime intrinsics to insert extra checks"),
 171        cl::Hidden, cl::init(false));
 172
 173 // Debug flags.
 174 static cl::opt<int> ClDebug("asan-debug", cl::desc("debug"), cl::Hidden,
 175                             cl::init(0));
 176 static cl::opt<int> ClDebugStack("asan-debug-stack", cl::desc("debug stack"),
 177                                  cl::Hidden, cl::init(0));
 178 static cl::opt<std::string> ClDebugFunc("asan-debug-func",
 179                                         cl::Hidden, cl::desc("Debug func"));
 180 static cl::opt<int> ClDebugMin("asan-debug-min", cl::desc("Debug min inst"),
 181                                cl::Hidden, cl::init(-1));
 182 static cl::opt<int> ClDebugMax("asan-debug-max", cl::desc("Debug man inst"),
 183                                cl::Hidden, cl::init(-1));
 184
 185 namespace {
 186 /// A set of dynamically initialized globals extracted from metadata.
 187 class SetOfDynamicallyInitializedGlobals {
 188  public:
 189   void Init(Module& M) {
 190     // Clang generates metadata identifying all dynamically initialized globals.
 191     NamedMDNode *DynamicGlobals =
 192         M.getNamedMetadata("llvm.asan.dynamically_initialized_globals");
 193     if (!DynamicGlobals)
 194       return;
 195     for (int i = 0, n = DynamicGlobals->getNumOperands(); i < n; ++i) {
 196       MDNode *MDN = DynamicGlobals->getOperand(i);
 197       assert(MDN->getNumOperands() == 1);
 198       Value *VG = MDN->getOperand(0);
 199       // The optimizer may optimize away a global entirely, in which case we
 200       // cannot instrument access to it.
 201       if (!VG)
 202         continue;
 203       DynInitGlobals.insert(cast<GlobalVariable>(VG));
 204     }
 205   }
 206   bool Contains(GlobalVariable *G) { return DynInitGlobals.count(G) != 0; }
 207  private:
 208   SmallSet<GlobalValue*, 32> DynInitGlobals;
 209 };
 210
 211 /// This struct defines the shadow mapping using the rule:
 212 ///   shadow = (mem >> Scale) ADD-or-OR Offset.
 213 struct ShadowMapping {
 214   int Scale;
 215   uint64_t Offset;
 216   bool OrShadowOffset;
 217 };
 218
 219 static ShadowMapping getShadowMapping(const Module &M, int LongSize,
 220                                       bool ZeroBaseShadow) {
 221   llvm::Triple TargetTriple(M.getTargetTriple());
 222   bool IsAndroid = TargetTriple.getEnvironment() == llvm::Triple::Android;
 223   bool IsMacOSX = TargetTriple.getOS() == llvm::Triple::MacOSX;
 224   bool IsPPC64 = TargetTriple.getArch() == llvm::Triple::ppc64;
 225   bool IsX86_64 = TargetTriple.getArch() == llvm::Triple::x86_64;
 226   bool IsMIPS32 = TargetTriple.getArch() == llvm::Triple::mips ||
 227                   TargetTriple.getArch() == llvm::Triple::mipsel;
 228
 229   ShadowMapping Mapping;
 230
 231   // OR-ing shadow offset if more efficient (at least on x86),
 232   // but on ppc64 we have to use add since the shadow offset is not neccesary
 233   // 1/8-th of the address space.
 234   Mapping.OrShadowOffset = !IsPPC64 && !ClShort64BitOffset;
 235
 236   Mapping.Offset = (IsAndroid || ZeroBaseShadow) ? 0 :
 237       (LongSize == 32 ?
 238        (IsMIPS32 ? kMIPS32_ShadowOffset32 : kDefaultShadowOffset32) :
 239        IsPPC64 ? kPPC64_ShadowOffset64 : kDefaultShadowOffset64);
 240   if (!ZeroBaseShadow && ClShort64BitOffset && IsX86_64 && !IsMacOSX) {
 241     assert(LongSize == 64);
 242     Mapping.Offset = kDefaultShort64bitShadowOffset;
 243   }
 244   if (!ZeroBaseShadow && ClMappingOffsetLog >= 0) {
 245     // Zero offset log is the special case.
 246     Mapping.Offset = (ClMappingOffsetLog == 0) ? 0 : 1ULL << ClMappingOffsetLog;
 247   }
 248
 249   Mapping.Scale = kDefaultShadowScale;
 250   if (ClMappingScale) {
 251     Mapping.Scale = ClMappingScale;
 252   }
 253
 254   return Mapping;
 255 }
 256
 257 static size_t RedzoneSizeForScale(int MappingScale) {
 258   // Redzone used for stack and globals is at least 32 bytes.
 259   // For scales 6 and 7, the redzone has to be 64 and 128 bytes respectively.
 260   return std::max(32U, 1U << MappingScale);
 261 }
 262
 263 /// AddressSanitizer: instrument the code in module to find memory bugs.
 264 struct AddressSanitizer : public FunctionPass {
 265   AddressSanitizer(bool CheckInitOrder = true,
 266                    bool CheckUseAfterReturn = false,
 267                    bool CheckLifetime = false,
 268                    StringRef BlacklistFile = StringRef(),
 269                    bool ZeroBaseShadow = false)
 270       : FunctionPass(ID),
 271         CheckInitOrder(CheckInitOrder || ClInitializers),
 272         CheckUseAfterReturn(CheckUseAfterReturn || ClUseAfterReturn),
 273         CheckLifetime(CheckLifetime || ClCheckLifetime),
 274         BlacklistFile(BlacklistFile.empty() ? ClBlacklistFile
 275                                             : BlacklistFile),
 276         ZeroBaseShadow(ZeroBaseShadow) {}
 277   virtual const char *getPassName() const {
 278     return "AddressSanitizerFunctionPass";
 279   }
 280   void instrumentMop(Instruction *I);
 281   void instrumentAddress(Instruction *OrigIns, Instruction *InsertBefore,
 282                          Value *Addr, uint32_t TypeSize, bool IsWrite,
 283                          Value *SizeArgument);
 284   Value *createSlowPathCmp(IRBuilder<> &IRB, Value *AddrLong,
 285                            Value *ShadowValue, uint32_t TypeSize);
 286   Instruction *generateCrashCode(Instruction *InsertBefore, Value *Addr,
 287                                  bool IsWrite, size_t AccessSizeIndex,
 288                                  Value *SizeArgument);
 289   bool instrumentMemIntrinsic(MemIntrinsic *MI);
 290   void instrumentMemIntrinsicParam(Instruction *OrigIns, Value *Addr,
 291                                    Value *Size,
 292                                    Instruction *InsertBefore, bool IsWrite);
 293   Value *memToShadow(Value *Shadow, IRBuilder<> &IRB);
 294   bool runOnFunction(Function &F);
 295   bool maybeInsertAsanInitAtFunctionEntry(Function &F);
 296   void emitShadowMapping(Module &M, IRBuilder<> &IRB) const;
 297   virtual bool doInitialization(Module &M);
 298   static char ID;  // Pass identification, replacement for typeid
 299
 300  private:
 301   void initializeCallbacks(Module &M);
 302
 303   bool ShouldInstrumentGlobal(GlobalVariable *G);
 304   bool LooksLikeCodeInBug11395(Instruction *I);
 305   void FindDynamicInitializers(Module &M);
 306
 307   bool CheckInitOrder;
 308   bool CheckUseAfterReturn;
 309   bool CheckLifetime;
 310   SmallString<64> BlacklistFile;
 311   bool ZeroBaseShadow;
 312
 313   LLVMContext *C;
 314   DataLayout *TD;
 315   int LongSize;
 316   Type *IntptrTy;
 317   ShadowMapping Mapping;
 318   Function *AsanCtorFunction;
 319   Function *AsanInitFunction;
 320   Function *AsanHandleNoReturnFunc;
 321   OwningPtr<BlackList> BL;
 322   // This array is indexed by AccessIsWrite and log2(AccessSize).
 323   Function *AsanErrorCallback[2][kNumberOfAccessSizes];
 324   // This array is indexed by AccessIsWrite.
 325   Function *AsanErrorCallbackSized[2];
 326   InlineAsm *EmptyAsm;
 327   SetOfDynamicallyInitializedGlobals DynamicallyInitializedGlobals;
 328
 329   friend struct FunctionStackPoisoner;
 330 };
 331
 332 class AddressSanitizerModule : public ModulePass {
 333  public:
 334   AddressSanitizerModule(bool CheckInitOrder = true,
 335                          StringRef BlacklistFile = StringRef(),
 336                          bool ZeroBaseShadow = false)
 337       : ModulePass(ID),
 338         CheckInitOrder(CheckInitOrder || ClInitializers),
 339         BlacklistFile(BlacklistFile.empty() ? ClBlacklistFile
 340                                             : BlacklistFile),
 341         ZeroBaseShadow(ZeroBaseShadow) {}
 342   bool runOnModule(Module &M);
 343   static char ID;  // Pass identification, replacement for typeid
 344   virtual const char *getPassName() const {
 345     return "AddressSanitizerModule";
 346   }
 347
 348  private:
 349   void initializeCallbacks(Module &M);
 350
 351   bool ShouldInstrumentGlobal(GlobalVariable *G);
 352   void createInitializerPoisonCalls(Module &M, GlobalValue *ModuleName);
 353   size_t RedzoneSize() const {
 354     return RedzoneSizeForScale(Mapping.Scale);
 355   }
 356
 357   bool CheckInitOrder;
 358   SmallString<64> BlacklistFile;
 359   bool ZeroBaseShadow;
 360
 361   OwningPtr<BlackList> BL;
 362   SetOfDynamicallyInitializedGlobals DynamicallyInitializedGlobals;
 363   Type *IntptrTy;
 364   LLVMContext *C;
 365   DataLayout *TD;
 366   ShadowMapping Mapping;
 367   Function *AsanPoisonGlobals;
 368   Function *AsanUnpoisonGlobals;
 369   Function *AsanRegisterGlobals;
 370   Function *AsanUnregisterGlobals;
 371 };
 372
 373 // Stack poisoning does not play well with exception handling.
 374 // When an exception is thrown, we essentially bypass the code
 375 // that unpoisones the stack. This is why the run-time library has
 376 // to intercept __cxa_throw (as well as longjmp, etc) and unpoison the entire
 377 // stack in the interceptor. This however does not work inside the
 378 // actual function which catches the exception. Most likely because the
 379 // compiler hoists the load of the shadow value somewhere too high.
 380 // This causes asan to report a non-existing bug on 453.povray.
 381 // It sounds like an LLVM bug.
 382 struct FunctionStackPoisoner : public InstVisitor<FunctionStackPoisoner> {
 383   Function &F;
 384   AddressSanitizer &ASan;
 385   DIBuilder DIB;
 386   LLVMContext *C;
 387   Type *IntptrTy;
 388   Type *IntptrPtrTy;
 389   ShadowMapping Mapping;
 390
 391   SmallVector<AllocaInst*, 16> AllocaVec;
 392   SmallVector<Instruction*, 8> RetVec;
 393   uint64_t TotalStackSize;
 394   unsigned StackAlignment;
 395
 396   Function *AsanStackMallocFunc, *AsanStackFreeFunc;
 397   Function *AsanPoisonStackMemoryFunc, *AsanUnpoisonStackMemoryFunc;
 398
 399   // Stores a place and arguments of poisoning/unpoisoning call for alloca.
 400   struct AllocaPoisonCall {
 401     IntrinsicInst *InsBefore;
 402     uint64_t Size;
 403     bool DoPoison;
 404   };
 405   SmallVector<AllocaPoisonCall, 8> AllocaPoisonCallVec;
 406
 407   // Maps Value to an AllocaInst from which the Value is originated.
 408   typedef DenseMap<Value*, AllocaInst*> AllocaForValueMapTy;
 409   AllocaForValueMapTy AllocaForValue;
 410
 411   FunctionStackPoisoner(Function &F, AddressSanitizer &ASan)
 412       : F(F), ASan(ASan), DIB(*F.getParent()), C(ASan.C),
 413         IntptrTy(ASan.IntptrTy), IntptrPtrTy(PointerType::get(IntptrTy, 0)),
 414         Mapping(ASan.Mapping),
 415         TotalStackSize(0), StackAlignment(1 << Mapping.Scale) {}
 416
 417   bool runOnFunction() {
 418     if (!ClStack) return false;
 419     // Collect alloca, ret, lifetime instructions etc.
 420     for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
 421          DE = df_end(&F.getEntryBlock()); DI != DE; ++DI) {
 422       BasicBlock *BB = *DI;
 423       visit(*BB);
 424     }
 425     if (AllocaVec.empty()) return false;
 426
 427     initializeCallbacks(*F.getParent());
 428
 429     poisonStack();
 430
 431     if (ClDebugStack) {
 432       DEBUG(dbgs() << F);
 433     }
 434     return true;
 435   }
 436
 437   // Finds all static Alloca instructions and puts
 438   // poisoned red zones around all of them.
 439   // Then unpoison everything back before the function returns.
 440   void poisonStack();
 441
 442   // ----------------------- Visitors.
 443   /// \brief Collect all Ret instructions.
 444   void visitReturnInst(ReturnInst &RI) {
 445     RetVec.push_back(&RI);
 446   }
 447
 448   /// \brief Collect Alloca instructions we want (and can) handle.
 449   void visitAllocaInst(AllocaInst &AI) {
 450     if (!isInterestingAlloca(AI)) return;
 451
 452     StackAlignment = std::max(StackAlignment, AI.getAlignment());
 453     AllocaVec.push_back(&AI);
 454     uint64_t AlignedSize =  getAlignedAllocaSize(&AI);
 455     TotalStackSize += AlignedSize;
 456   }
 457
 458   /// \brief Collect lifetime intrinsic calls to check for use-after-scope
 459   /// errors.
 460   void visitIntrinsicInst(IntrinsicInst &II) {
 461     if (!ASan.CheckLifetime) return;
 462     Intrinsic::ID ID = II.getIntrinsicID();
 463     if (ID != Intrinsic::lifetime_start &&
 464         ID != Intrinsic::lifetime_end)
 465       return;
 466     // Found lifetime intrinsic, add ASan instrumentation if necessary.
 467     ConstantInt *Size = dyn_cast<ConstantInt>(II.getArgOperand(0));
 468     // If size argument is undefined, don't do anything.
 469     if (Size->isMinusOne()) return;
 470     // Check that size doesn't saturate uint64_t and can
 471     // be stored in IntptrTy.
 472     const uint64_t SizeValue = Size->getValue().getLimitedValue();
 473     if (SizeValue == ~0ULL ||
 474         !ConstantInt::isValueValidForType(IntptrTy, SizeValue))
 475       return;
 476     // Find alloca instruction that corresponds to llvm.lifetime argument.
 477     AllocaInst *AI = findAllocaForValue(II.getArgOperand(1));
 478     if (!AI) return;
 479     bool DoPoison = (ID == Intrinsic::lifetime_end);
 480     AllocaPoisonCall APC = {&II, SizeValue, DoPoison};
 481     AllocaPoisonCallVec.push_back(APC);
 482   }
 483
 484   // ---------------------- Helpers.
 485   void initializeCallbacks(Module &M);
 486
 487   // Check if we want (and can) handle this alloca.
 488   bool isInterestingAlloca(AllocaInst &AI) {
 489     return (!AI.isArrayAllocation() &&
 490             AI.isStaticAlloca() &&
 491             AI.getAllocatedType()->isSized());
 492   }
 493
 494   size_t RedzoneSize() const {
 495     return RedzoneSizeForScale(Mapping.Scale);
 496   }
 497   uint64_t getAllocaSizeInBytes(AllocaInst *AI) {
 498     Type *Ty = AI->getAllocatedType();
 499     uint64_t SizeInBytes = ASan.TD->getTypeAllocSize(Ty);
 500     return SizeInBytes;
 501   }
 502   uint64_t getAlignedSize(uint64_t SizeInBytes) {
 503     size_t RZ = RedzoneSize();
 504     return ((SizeInBytes + RZ - 1) / RZ) * RZ;
 505   }
 506   uint64_t getAlignedAllocaSize(AllocaInst *AI) {
 507     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
 508     return getAlignedSize(SizeInBytes);
 509   }
 510   /// Finds alloca where the value comes from.
 511   AllocaInst *findAllocaForValue(Value *V);
 512   void poisonRedZones(const ArrayRef<AllocaInst*> &AllocaVec, IRBuilder<> IRB,
 513                       Value *ShadowBase, bool DoPoison);
 514   void poisonAlloca(Value *V, uint64_t Size, IRBuilder<> IRB, bool DoPoison);
 515 };
 516
 517 }  // namespace
 518
 519 char AddressSanitizer::ID = 0;
 520 INITIALIZE_PASS(AddressSanitizer, "asan",
 521     "AddressSanitizer: detects use-after-free and out-of-bounds bugs.",
 522     false, false)
 523 FunctionPass *llvm::createAddressSanitizerFunctionPass(
 524     bool CheckInitOrder, bool CheckUseAfterReturn, bool CheckLifetime,
 525     StringRef BlacklistFile, bool ZeroBaseShadow) {
 526   return new AddressSanitizer(CheckInitOrder, CheckUseAfterReturn,
 527                               CheckLifetime, BlacklistFile, ZeroBaseShadow);
 528 }
 529
 530 char AddressSanitizerModule::ID = 0;
 531 INITIALIZE_PASS(AddressSanitizerModule, "asan-module",
 532     "AddressSanitizer: detects use-after-free and out-of-bounds bugs."
 533     "ModulePass", false, false)
 534 ModulePass *llvm::createAddressSanitizerModulePass(
 535     bool CheckInitOrder, StringRef BlacklistFile, bool ZeroBaseShadow) {
 536   return new AddressSanitizerModule(CheckInitOrder, BlacklistFile,
 537                                     ZeroBaseShadow);
 538 }
 539
 540 static size_t TypeSizeToSizeIndex(uint32_t TypeSize) {
 541   size_t Res = countTrailingZeros(TypeSize / 8);
 542   assert(Res < kNumberOfAccessSizes);
 543   return Res;
 544 }
 545
 546 // Create a constant for Str so that we can pass it to the run-time lib.
 547 static GlobalVariable *createPrivateGlobalForString(Module &M, StringRef Str) {
 548   Constant *StrConst = ConstantDataArray::getString(M.getContext(), Str);
 549   GlobalVariable *GV = new GlobalVariable(M, StrConst->getType(), true,
 550                             GlobalValue::PrivateLinkage, StrConst,
 551                             kAsanGenPrefix);
 552   GV->setUnnamedAddr(true);  // Ok to merge these.
 553   GV->setAlignment(1);  // Strings may not be merged w/o setting align 1.
 554   return GV;
 555 }
 556
 557 static bool GlobalWasGeneratedByAsan(GlobalVariable *G) {
 558   return G->getName().find(kAsanGenPrefix) == 0;
 559 }
 560
 561 Value *AddressSanitizer::memToShadow(Value *Shadow, IRBuilder<> &IRB) {
 562   // Shadow >> scale
 563   Shadow = IRB.CreateLShr(Shadow, Mapping.Scale);
 564   if (Mapping.Offset == 0)
 565     return Shadow;
 566   // (Shadow >> scale) | offset
 567   if (Mapping.OrShadowOffset)
 568     return IRB.CreateOr(Shadow, ConstantInt::get(IntptrTy, Mapping.Offset));
 569   else
 570     return IRB.CreateAdd(Shadow, ConstantInt::get(IntptrTy, Mapping.Offset));
 571 }
 572
 573 void AddressSanitizer::instrumentMemIntrinsicParam(
 574     Instruction *OrigIns,
 575     Value *Addr, Value *Size, Instruction *InsertBefore, bool IsWrite) {
 576   IRBuilder<> IRB(InsertBefore);
 577   if (Size->getType() != IntptrTy)
 578     Size = IRB.CreateIntCast(Size, IntptrTy, false);
 579   // Check the first byte.
 580   instrumentAddress(OrigIns, InsertBefore, Addr, 8, IsWrite, Size);
 581   // Check the last byte.
 582   IRB.SetInsertPoint(InsertBefore);
 583   Value *SizeMinusOne = IRB.CreateSub(Size, ConstantInt::get(IntptrTy, 1));
 584   Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 585   Value *AddrLast = IRB.CreateAdd(AddrLong, SizeMinusOne);
 586   instrumentAddress(OrigIns, InsertBefore, AddrLast, 8, IsWrite, Size);
 587 }
 588
 589 // Instrument memset/memmove/memcpy
 590 bool AddressSanitizer::instrumentMemIntrinsic(MemIntrinsic *MI) {
 591   Value *Dst = MI->getDest();
 592   MemTransferInst *MemTran = dyn_cast<MemTransferInst>(MI);
 593   Value *Src = MemTran ? MemTran->getSource() : 0;
 594   Value *Length = MI->getLength();
 595
 596   Constant *ConstLength = dyn_cast<Constant>(Length);
 597   Instruction *InsertBefore = MI;
 598   if (ConstLength) {
 599     if (ConstLength->isNullValue()) return false;
 600   } else {
 601     // The size is not a constant so it could be zero -- check at run-time.
 602     IRBuilder<> IRB(InsertBefore);
 603
 604     Value *Cmp = IRB.CreateICmpNE(Length,
 605                                   Constant::getNullValue(Length->getType()));
 606     InsertBefore = SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), false);
 607   }
 608
 609   instrumentMemIntrinsicParam(MI, Dst, Length, InsertBefore, true);
 610   if (Src)
 611     instrumentMemIntrinsicParam(MI, Src, Length, InsertBefore, false);
 612   return true;
 613 }
 614
 615 // If I is an interesting memory access, return the PointerOperand
 616 // and set IsWrite. Otherwise return NULL.
 617 static Value *isInterestingMemoryAccess(Instruction *I, bool *IsWrite) {
 618   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 619     if (!ClInstrumentReads) return NULL;
 620     *IsWrite = false;
 621     return LI->getPointerOperand();
 622   }
 623   if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 624     if (!ClInstrumentWrites) return NULL;
 625     *IsWrite = true;
 626     return SI->getPointerOperand();
 627   }
 628   if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(I)) {
 629     if (!ClInstrumentAtomics) return NULL;
 630     *IsWrite = true;
 631     return RMW->getPointerOperand();
 632   }
 633   if (AtomicCmpXchgInst *XCHG = dyn_cast<AtomicCmpXchgInst>(I)) {
 634     if (!ClInstrumentAtomics) return NULL;
 635     *IsWrite = true;
 636     return XCHG->getPointerOperand();
 637   }
 638   return NULL;
 639 }
 640
 641 void AddressSanitizer::instrumentMop(Instruction *I) {
 642   bool IsWrite = false;
 643   Value *Addr = isInterestingMemoryAccess(I, &IsWrite);
 644   assert(Addr);
 645   if (ClOpt && ClOptGlobals) {
 646     if (GlobalVariable *G = dyn_cast<GlobalVariable>(Addr)) {
 647       // If initialization order checking is disabled, a simple access to a
 648       // dynamically initialized global is always valid.
 649       if (!CheckInitOrder)
 650         return;
 651       // If a global variable does not have dynamic initialization we don't
 652       // have to instrument it.  However, if a global does not have initailizer
 653       // at all, we assume it has dynamic initializer (in other TU).
 654       if (G->hasInitializer() && !DynamicallyInitializedGlobals.Contains(G))
 655         return;
 656     }
 657   }
 658
 659   Type *OrigPtrTy = Addr->getType();
 660   Type *OrigTy = cast<PointerType>(OrigPtrTy)->getElementType();
 661
 662   assert(OrigTy->isSized());
 663   uint32_t TypeSize = TD->getTypeStoreSizeInBits(OrigTy);
 664
 665   assert((TypeSize % 8) == 0);
 666
 667   // Instrument a 1-, 2-, 4-, 8-, or 16- byte access with one check.
 668   if (TypeSize == 8  || TypeSize == 16 ||
 669       TypeSize == 32 || TypeSize == 64 || TypeSize == 128)
 670     return instrumentAddress(I, I, Addr, TypeSize, IsWrite, 0);
 671   // Instrument unusual size (but still multiple of 8).
 672   // We can not do it with a single check, so we do 1-byte check for the first
 673   // and the last bytes. We call __asan_report_*_n(addr, real_size) to be able
 674   // to report the actual access size.
 675   IRBuilder<> IRB(I);
 676   Value *LastByte =  IRB.CreateIntToPtr(
 677       IRB.CreateAdd(IRB.CreatePointerCast(Addr, IntptrTy),
 678                     ConstantInt::get(IntptrTy, TypeSize / 8 - 1)),
 679       OrigPtrTy);
 680   Value *Size = ConstantInt::get(IntptrTy, TypeSize / 8);
 681   instrumentAddress(I, I, Addr, 8, IsWrite, Size);
 682   instrumentAddress(I, I, LastByte, 8, IsWrite, Size);
 683 }
 684
 685 // Validate the result of Module::getOrInsertFunction called for an interface
 686 // function of AddressSanitizer. If the instrumented module defines a function
 687 // with the same name, their prototypes must match, otherwise
 688 // getOrInsertFunction returns a bitcast.
 689 static Function *checkInterfaceFunction(Constant *FuncOrBitcast) {
 690   if (isa<Function>(FuncOrBitcast)) return cast<Function>(FuncOrBitcast);
 691   FuncOrBitcast->dump();
 692   report_fatal_error("trying to redefine an AddressSanitizer "
 693                      "interface function");
 694 }
 695
 696 Instruction *AddressSanitizer::generateCrashCode(
 697     Instruction *InsertBefore, Value *Addr,
 698     bool IsWrite, size_t AccessSizeIndex, Value *SizeArgument) {
 699   IRBuilder<> IRB(InsertBefore);
 700   CallInst *Call = SizeArgument
 701     ? IRB.CreateCall2(AsanErrorCallbackSized[IsWrite], Addr, SizeArgument)
 702     : IRB.CreateCall(AsanErrorCallback[IsWrite][AccessSizeIndex], Addr);
 703
 704   // We don't do Call->setDoesNotReturn() because the BB already has
 705   // UnreachableInst at the end.
 706   // This EmptyAsm is required to avoid callback merge.
 707   IRB.CreateCall(EmptyAsm);
 708   return Call;
 709 }
 710
 711 Value *AddressSanitizer::createSlowPathCmp(IRBuilder<> &IRB, Value *AddrLong,
 712                                             Value *ShadowValue,
 713                                             uint32_t TypeSize) {
 714   size_t Granularity = 1 << Mapping.Scale;
 715   // Addr & (Granularity - 1)
 716   Value *LastAccessedByte = IRB.CreateAnd(
 717       AddrLong, ConstantInt::get(IntptrTy, Granularity - 1));
 718   // (Addr & (Granularity - 1)) + size - 1
 719   if (TypeSize / 8 > 1)
 720     LastAccessedByte = IRB.CreateAdd(
 721         LastAccessedByte, ConstantInt::get(IntptrTy, TypeSize / 8 - 1));
 722   // (uint8_t) ((Addr & (Granularity-1)) + size - 1)
 723   LastAccessedByte = IRB.CreateIntCast(
 724       LastAccessedByte, ShadowValue->getType(), false);
 725   // ((uint8_t) ((Addr & (Granularity-1)) + size - 1)) >= ShadowValue
 726   return IRB.CreateICmpSGE(LastAccessedByte, ShadowValue);
 727 }
 728
 729 void AddressSanitizer::instrumentAddress(Instruction *OrigIns,
 730                                          Instruction *InsertBefore,
 731                                          Value *Addr, uint32_t TypeSize,
 732                                          bool IsWrite, Value *SizeArgument) {
 733   IRBuilder<> IRB(InsertBefore);
 734   Value *AddrLong = IRB.CreatePointerCast(Addr, IntptrTy);
 735
 736   Type *ShadowTy  = IntegerType::get(
 737       *C, std::max(8U, TypeSize >> Mapping.Scale));
 738   Type *ShadowPtrTy = PointerType::get(ShadowTy, 0);
 739   Value *ShadowPtr = memToShadow(AddrLong, IRB);
 740   Value *CmpVal = Constant::getNullValue(ShadowTy);
 741   Value *ShadowValue = IRB.CreateLoad(
 742       IRB.CreateIntToPtr(ShadowPtr, ShadowPtrTy));
 743
 744   Value *Cmp = IRB.CreateICmpNE(ShadowValue, CmpVal);
 745   size_t AccessSizeIndex = TypeSizeToSizeIndex(TypeSize);
 746   size_t Granularity = 1 << Mapping.Scale;
 747   TerminatorInst *CrashTerm = 0;
 748
 749   if (ClAlwaysSlowPath || (TypeSize < 8 * Granularity)) {
 750     TerminatorInst *CheckTerm =
 751         SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), false);
 752     assert(dyn_cast<BranchInst>(CheckTerm)->isUnconditional());
 753     BasicBlock *NextBB = CheckTerm->getSuccessor(0);
 754     IRB.SetInsertPoint(CheckTerm);
 755     Value *Cmp2 = createSlowPathCmp(IRB, AddrLong, ShadowValue, TypeSize);
 756     BasicBlock *CrashBlock =
 757         BasicBlock::Create(*C, "", NextBB->getParent(), NextBB);
 758     CrashTerm = new UnreachableInst(*C, CrashBlock);
 759     BranchInst *NewTerm = BranchInst::Create(CrashBlock, NextBB, Cmp2);
 760     ReplaceInstWithInst(CheckTerm, NewTerm);
 761   } else {
 762     CrashTerm = SplitBlockAndInsertIfThen(cast<Instruction>(Cmp), true);
 763   }
 764
 765   Instruction *Crash = generateCrashCode(
 766       CrashTerm, AddrLong, IsWrite, AccessSizeIndex, SizeArgument);
 767   Crash->setDebugLoc(OrigIns->getDebugLoc());
 768 }
 769
 770 void AddressSanitizerModule::createInitializerPoisonCalls(
 771     Module &M, GlobalValue *ModuleName) {
 772   // We do all of our poisoning and unpoisoning within _GLOBAL__I_a.
 773   Function *GlobalInit = M.getFunction("_GLOBAL__I_a");
 774   // If that function is not present, this TU contains no globals, or they have
 775   // all been optimized away
 776   if (!GlobalInit)
 777     return;
 778
 779   // Set up the arguments to our poison/unpoison functions.
 780   IRBuilder<> IRB(GlobalInit->begin()->getFirstInsertionPt());
 781
 782   // Add a call to poison all external globals before the given function starts.
 783   Value *ModuleNameAddr = ConstantExpr::getPointerCast(ModuleName, IntptrTy);
 784   IRB.CreateCall(AsanPoisonGlobals, ModuleNameAddr);
 785
 786   // Add calls to unpoison all globals before each return instruction.
 787   for (Function::iterator I = GlobalInit->begin(), E = GlobalInit->end();
 788       I != E; ++I) {
 789     if (ReturnInst *RI = dyn_cast<ReturnInst>(I->getTerminator())) {
 790       CallInst::Create(AsanUnpoisonGlobals, "", RI);
 791     }
 792   }
 793 }
 794
 795 bool AddressSanitizerModule::ShouldInstrumentGlobal(GlobalVariable *G) {
 796   Type *Ty = cast<PointerType>(G->getType())->getElementType();
 797   DEBUG(dbgs() << "GLOBAL: " << *G << "\n");
 798
 799   if (BL->isIn(*G)) return false;
 800   if (!Ty->isSized()) return false;
 801   if (!G->hasInitializer()) return false;
 802   if (GlobalWasGeneratedByAsan(G)) return false;  // Our own global.
 803   // Touch only those globals that will not be defined in other modules.
 804   // Don't handle ODR type linkages since other modules may be built w/o asan.
 805   if (G->getLinkage() != GlobalVariable::ExternalLinkage &&
 806       G->getLinkage() != GlobalVariable::PrivateLinkage &&
 807       G->getLinkage() != GlobalVariable::InternalLinkage)
 808     return false;
 809   // Two problems with thread-locals:
 810   //   - The address of the main thread's copy can't be computed at link-time.
 811   //   - Need to poison all copies, not just the main thread's one.
 812   if (G->isThreadLocal())
 813     return false;
 814   // For now, just ignore this Alloca if the alignment is large.
 815   if (G->getAlignment() > RedzoneSize()) return false;
 816
 817   // Ignore all the globals with the names starting with "\01L_OBJC_".
 818   // Many of those are put into the .cstring section. The linker compresses
 819   // that section by removing the spare \0s after the string terminator, so
 820   // our redzones get broken.
 821   if ((G->getName().find("\01L_OBJC_") == 0) ||
 822       (G->getName().find("\01l_OBJC_") == 0)) {
 823     DEBUG(dbgs() << "Ignoring \\01L_OBJC_* global: " << *G);
 824     return false;
 825   }
 826
 827   if (G->hasSection()) {
 828     StringRef Section(G->getSection());
 829     // Ignore the globals from the __OBJC section. The ObjC runtime assumes
 830     // those conform to /usr/lib/objc/runtime.h, so we can't add redzones to
 831     // them.
 832     if ((Section.find("__OBJC,") == 0) ||
 833         (Section.find("__DATA, __objc_") == 0)) {
 834       DEBUG(dbgs() << "Ignoring ObjC runtime global: " << *G);
 835       return false;
 836     }
 837     // See http://code.google.com/p/address-sanitizer/issues/detail?id=32
 838     // Constant CFString instances are compiled in the following way:
 839     //  -- the string buffer is emitted into
 840     //     __TEXT,__cstring,cstring_literals
 841     //  -- the constant NSConstantString structure referencing that buffer
 842     //     is placed into __DATA,__cfstring
 843     // Therefore there's no point in placing redzones into __DATA,__cfstring.
 844     // Moreover, it causes the linker to crash on OS X 10.7
 845     if (Section.find("__DATA,__cfstring") == 0) {
 846       DEBUG(dbgs() << "Ignoring CFString: " << *G);
 847       return false;
 848     }
 849   }
 850
 851   return true;
 852 }
 853
 854 void AddressSanitizerModule::initializeCallbacks(Module &M) {
 855   IRBuilder<> IRB(*C);
 856   // Declare our poisoning and unpoisoning functions.
 857   AsanPoisonGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 858       kAsanPoisonGlobalsName, IRB.getVoidTy(), IntptrTy, NULL));
 859   AsanPoisonGlobals->setLinkage(Function::ExternalLinkage);
 860   AsanUnpoisonGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 861       kAsanUnpoisonGlobalsName, IRB.getVoidTy(), NULL));
 862   AsanUnpoisonGlobals->setLinkage(Function::ExternalLinkage);
 863   // Declare functions that register/unregister globals.
 864   AsanRegisterGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 865       kAsanRegisterGlobalsName, IRB.getVoidTy(),
 866       IntptrTy, IntptrTy, NULL));
 867   AsanRegisterGlobals->setLinkage(Function::ExternalLinkage);
 868   AsanUnregisterGlobals = checkInterfaceFunction(M.getOrInsertFunction(
 869       kAsanUnregisterGlobalsName,
 870       IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
 871   AsanUnregisterGlobals->setLinkage(Function::ExternalLinkage);
 872 }
 873
 874 // This function replaces all global variables with new variables that have
 875 // trailing redzones. It also creates a function that poisons
 876 // redzones and inserts this function into llvm.global_ctors.
 877 bool AddressSanitizerModule::runOnModule(Module &M) {
 878   if (!ClGlobals) return false;
 879   TD = getAnalysisIfAvailable<DataLayout>();
 880   if (!TD)
 881     return false;
 882   BL.reset(new BlackList(BlacklistFile));
 883   if (BL->isIn(M)) return false;
 884   C = &(M.getContext());
 885   int LongSize = TD->getPointerSizeInBits();
 886   IntptrTy = Type::getIntNTy(*C, LongSize);
 887   Mapping = getShadowMapping(M, LongSize, ZeroBaseShadow);
 888   initializeCallbacks(M);
 889   DynamicallyInitializedGlobals.Init(M);
 890
 891   SmallVector<GlobalVariable *, 16> GlobalsToChange;
 892
 893   for (Module::GlobalListType::iterator G = M.global_begin(),
 894        E = M.global_end(); G != E; ++G) {
 895     if (ShouldInstrumentGlobal(G))
 896       GlobalsToChange.push_back(G);
 897   }
 898
 899   size_t n = GlobalsToChange.size();
 900   if (n == 0) return false;
 901
 902   // A global is described by a structure
 903   //   size_t beg;
 904   //   size_t size;
 905   //   size_t size_with_redzone;
 906   //   const char *name;
 907   //   const char *module_name;
 908   //   size_t has_dynamic_init;
 909   // We initialize an array of such structures and pass it to a run-time call.
 910   StructType *GlobalStructTy = StructType::get(IntptrTy, IntptrTy,
 911                                                IntptrTy, IntptrTy,
 912                                                IntptrTy, IntptrTy, NULL);
 913   SmallVector<Constant *, 16> Initializers(n), DynamicInit;
 914
 915
 916   Function *CtorFunc = M.getFunction(kAsanModuleCtorName);
 917   assert(CtorFunc);
 918   IRBuilder<> IRB(CtorFunc->getEntryBlock().getTerminator());
 919
 920   bool HasDynamicallyInitializedGlobals = false;
 921
 922   GlobalVariable *ModuleName = createPrivateGlobalForString(
 923       M, M.getModuleIdentifier());
 924   // We shouldn't merge same module names, as this string serves as unique
 925   // module ID in runtime.
 926   ModuleName->setUnnamedAddr(false);
 927
 928   for (size_t i = 0; i < n; i++) {
 929     static const uint64_t kMaxGlobalRedzone = 1 << 18;
 930     GlobalVariable *G = GlobalsToChange[i];
 931     PointerType *PtrTy = cast<PointerType>(G->getType());
 932     Type *Ty = PtrTy->getElementType();
 933     uint64_t SizeInBytes = TD->getTypeAllocSize(Ty);
 934     uint64_t MinRZ = RedzoneSize();
 935     // MinRZ <= RZ <= kMaxGlobalRedzone
 936     // and trying to make RZ to be ~ 1/4 of SizeInBytes.
 937     uint64_t RZ = std::max(MinRZ,
 938                          std::min(kMaxGlobalRedzone,
 939                                   (SizeInBytes / MinRZ / 4) * MinRZ));
 940     uint64_t RightRedzoneSize = RZ;
 941     // Round up to MinRZ
 942     if (SizeInBytes % MinRZ)
 943       RightRedzoneSize += MinRZ - (SizeInBytes % MinRZ);
 944     assert(((RightRedzoneSize + SizeInBytes) % MinRZ) == 0);
 945     Type *RightRedZoneTy = ArrayType::get(IRB.getInt8Ty(), RightRedzoneSize);
 946     // Determine whether this global should be poisoned in initialization.
 947     bool GlobalHasDynamicInitializer =
 948         DynamicallyInitializedGlobals.Contains(G);
 949     // Don't check initialization order if this global is blacklisted.
 950     GlobalHasDynamicInitializer &= !BL->isInInit(*G);
 951
 952     StructType *NewTy = StructType::get(Ty, RightRedZoneTy, NULL);
 953     Constant *NewInitializer = ConstantStruct::get(
 954         NewTy, G->getInitializer(),
 955         Constant::getNullValue(RightRedZoneTy), NULL);
 956
 957     GlobalVariable *Name = createPrivateGlobalForString(M, G->getName());
 958
 959     // Create a new global variable with enough space for a redzone.
 960     GlobalVariable *NewGlobal = new GlobalVariable(
 961         M, NewTy, G->isConstant(), G->getLinkage(),
 962         NewInitializer, "", G, G->getThreadLocalMode());
 963     NewGlobal->copyAttributesFrom(G);
 964     NewGlobal->setAlignment(MinRZ);
 965
 966     Value *Indices2[2];
 967     Indices2[0] = IRB.getInt32(0);
 968     Indices2[1] = IRB.getInt32(0);
 969
 970     G->replaceAllUsesWith(
 971         ConstantExpr::getGetElementPtr(NewGlobal, Indices2, true));
 972     NewGlobal->takeName(G);
 973     G->eraseFromParent();
 974
 975     Initializers[i] = ConstantStruct::get(
 976         GlobalStructTy,
 977         ConstantExpr::getPointerCast(NewGlobal, IntptrTy),
 978         ConstantInt::get(IntptrTy, SizeInBytes),
 979         ConstantInt::get(IntptrTy, SizeInBytes + RightRedzoneSize),
 980         ConstantExpr::getPointerCast(Name, IntptrTy),
 981         ConstantExpr::getPointerCast(ModuleName, IntptrTy),
 982         ConstantInt::get(IntptrTy, GlobalHasDynamicInitializer),
 983         NULL);
 984
 985     // Populate the first and last globals declared in this TU.
 986     if (CheckInitOrder && GlobalHasDynamicInitializer)
 987       HasDynamicallyInitializedGlobals = true;
 988
 989     DEBUG(dbgs() << "NEW GLOBAL: " << *NewGlobal << "\n");
 990   }
 991
 992   ArrayType *ArrayOfGlobalStructTy = ArrayType::get(GlobalStructTy, n);
 993   GlobalVariable *AllGlobals = new GlobalVariable(
 994       M, ArrayOfGlobalStructTy, false, GlobalVariable::PrivateLinkage,
 995       ConstantArray::get(ArrayOfGlobalStructTy, Initializers), "");
 996
 997   // Create calls for poisoning before initializers run and unpoisoning after.
 998   if (CheckInitOrder && HasDynamicallyInitializedGlobals)
 999     createInitializerPoisonCalls(M, ModuleName);
1000   IRB.CreateCall2(AsanRegisterGlobals,
1001                   IRB.CreatePointerCast(AllGlobals, IntptrTy),
1002                   ConstantInt::get(IntptrTy, n));
1003
1004   // We also need to unregister globals at the end, e.g. when a shared library
1005   // gets closed.
1006   Function *AsanDtorFunction = Function::Create(
1007       FunctionType::get(Type::getVoidTy(*C), false),
1008       GlobalValue::InternalLinkage, kAsanModuleDtorName, &M);
1009   BasicBlock *AsanDtorBB = BasicBlock::Create(*C, "", AsanDtorFunction);
1010   IRBuilder<> IRB_Dtor(ReturnInst::Create(*C, AsanDtorBB));
1011   IRB_Dtor.CreateCall2(AsanUnregisterGlobals,
1012                        IRB.CreatePointerCast(AllGlobals, IntptrTy),
1013                        ConstantInt::get(IntptrTy, n));
1014   appendToGlobalDtors(M, AsanDtorFunction, kAsanCtorAndCtorPriority);
1015
1016   DEBUG(dbgs() << M);
1017   return true;
1018 }
1019
1020 void AddressSanitizer::initializeCallbacks(Module &M) {
1021   IRBuilder<> IRB(*C);
1022   // Create __asan_report* callbacks.
1023   for (size_t AccessIsWrite = 0; AccessIsWrite <= 1; AccessIsWrite++) {
1024     for (size_t AccessSizeIndex = 0; AccessSizeIndex < kNumberOfAccessSizes;
1025          AccessSizeIndex++) {
1026       // IsWrite and TypeSize are encoded in the function name.
1027       std::string FunctionName = std::string(kAsanReportErrorTemplate) +
1028           (AccessIsWrite ? "store" : "load") + itostr(1 << AccessSizeIndex);
1029       // If we are merging crash callbacks, they have two parameters.
1030       AsanErrorCallback[AccessIsWrite][AccessSizeIndex] =
1031           checkInterfaceFunction(M.getOrInsertFunction(
1032               FunctionName, IRB.getVoidTy(), IntptrTy, NULL));
1033     }
1034   }
1035   AsanErrorCallbackSized[0] = checkInterfaceFunction(M.getOrInsertFunction(
1036               kAsanReportLoadN, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
1037   AsanErrorCallbackSized[1] = checkInterfaceFunction(M.getOrInsertFunction(
1038               kAsanReportStoreN, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
1039
1040   AsanHandleNoReturnFunc = checkInterfaceFunction(M.getOrInsertFunction(
1041       kAsanHandleNoReturnName, IRB.getVoidTy(), NULL));
1042   // We insert an empty inline asm after __asan_report* to avoid callback merge.
1043   EmptyAsm = InlineAsm::get(FunctionType::get(IRB.getVoidTy(), false),
1044                             StringRef(""), StringRef(""),
1045                             /*hasSideEffects=*/true);
1046 }
1047
1048 void AddressSanitizer::emitShadowMapping(Module &M, IRBuilder<> &IRB) const {
1049   // Tell the values of mapping offset and scale to the run-time.
1050   GlobalValue *asan_mapping_offset =
1051       new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
1052                      ConstantInt::get(IntptrTy, Mapping.Offset),
1053                      kAsanMappingOffsetName);
1054   // Read the global, otherwise it may be optimized away.
1055   IRB.CreateLoad(asan_mapping_offset, true);
1056
1057   GlobalValue *asan_mapping_scale =
1058       new GlobalVariable(M, IntptrTy, true, GlobalValue::LinkOnceODRLinkage,
1059                          ConstantInt::get(IntptrTy, Mapping.Scale),
1060                          kAsanMappingScaleName);
1061   // Read the global, otherwise it may be optimized away.
1062   IRB.CreateLoad(asan_mapping_scale, true);
1063 }
1064
1065 // virtual
1066 bool AddressSanitizer::doInitialization(Module &M) {
1067   // Initialize the private fields. No one has accessed them before.
1068   TD = getAnalysisIfAvailable<DataLayout>();
1069
1070   if (!TD)
1071     return false;
1072   BL.reset(new BlackList(BlacklistFile));
1073   DynamicallyInitializedGlobals.Init(M);
1074
1075   C = &(M.getContext());
1076   LongSize = TD->getPointerSizeInBits();
1077   IntptrTy = Type::getIntNTy(*C, LongSize);
1078
1079   AsanCtorFunction = Function::Create(
1080       FunctionType::get(Type::getVoidTy(*C), false),
1081       GlobalValue::InternalLinkage, kAsanModuleCtorName, &M);
1082   BasicBlock *AsanCtorBB = BasicBlock::Create(*C, "", AsanCtorFunction);
1083   // call __asan_init in the module ctor.
1084   IRBuilder<> IRB(ReturnInst::Create(*C, AsanCtorBB));
1085   AsanInitFunction = checkInterfaceFunction(
1086       M.getOrInsertFunction(kAsanInitName, IRB.getVoidTy(), NULL));
1087   AsanInitFunction->setLinkage(Function::ExternalLinkage);
1088   IRB.CreateCall(AsanInitFunction);
1089
1090   Mapping = getShadowMapping(M, LongSize, ZeroBaseShadow);
1091   emitShadowMapping(M, IRB);
1092
1093   appendToGlobalCtors(M, AsanCtorFunction, kAsanCtorAndCtorPriority);
1094   return true;
1095 }
1096
1097 bool AddressSanitizer::maybeInsertAsanInitAtFunctionEntry(Function &F) {
1098   // For each NSObject descendant having a +load method, this method is invoked
1099   // by the ObjC runtime before any of the static constructors is called.
1100   // Therefore we need to instrument such methods with a call to __asan_init
1101   // at the beginning in order to initialize our runtime before any access to
1102   // the shadow memory.
1103   // We cannot just ignore these methods, because they may call other
1104   // instrumented functions.
1105   if (F.getName().find(" load]") != std::string::npos) {
1106     IRBuilder<> IRB(F.begin()->begin());
1107     IRB.CreateCall(AsanInitFunction);
1108     return true;
1109   }
1110   return false;
1111 }
1112
1113 bool AddressSanitizer::runOnFunction(Function &F) {
1114   if (BL->isIn(F)) return false;
1115   if (&F == AsanCtorFunction) return false;
1116   if (F.getLinkage() == GlobalValue::AvailableExternallyLinkage) return false;
1117   DEBUG(dbgs() << "ASAN instrumenting:\n" << F << "\n");
1118   initializeCallbacks(*F.getParent());
1119
1120   // If needed, insert __asan_init before checking for SanitizeAddress attr.
1121   maybeInsertAsanInitAtFunctionEntry(F);
1122
1123   if (!F.hasFnAttribute(Attribute::SanitizeAddress))
1124     return false;
1125
1126   if (!ClDebugFunc.empty() && ClDebugFunc != F.getName())
1127     return false;
1128
1129   // We want to instrument every address only once per basic block (unless there
1130   // are calls between uses).
1131   SmallSet<Value*, 16> TempsToInstrument;
1132   SmallVector<Instruction*, 16> ToInstrument;
1133   SmallVector<Instruction*, 8> NoReturnCalls;
1134   int NumAllocas = 0;
1135   bool IsWrite;
1136
1137   // Fill the set of memory operations to instrument.
1138   for (Function::iterator FI = F.begin(), FE = F.end();
1139        FI != FE; ++FI) {
1140     TempsToInstrument.clear();
1141     int NumInsnsPerBB = 0;
1142     for (BasicBlock::iterator BI = FI->begin(), BE = FI->end();
1143          BI != BE; ++BI) {
1144       if (LooksLikeCodeInBug11395(BI)) return false;
1145       if (Value *Addr = isInterestingMemoryAccess(BI, &IsWrite)) {
1146         if (ClOpt && ClOptSameTemp) {
1147           if (!TempsToInstrument.insert(Addr))
1148             continue;  // We've seen this temp in the current BB.
1149         }
1150       } else if (isa<MemIntrinsic>(BI) && ClMemIntrin) {
1151         // ok, take it.
1152       } else {
1153         if (isa<AllocaInst>(BI))
1154           NumAllocas++;
1155         CallSite CS(BI);
1156         if (CS) {
1157           // A call inside BB.
1158           TempsToInstrument.clear();
1159           if (CS.doesNotReturn())
1160             NoReturnCalls.push_back(CS.getInstruction());
1161         }
1162         continue;
1163       }
1164       ToInstrument.push_back(BI);
1165       NumInsnsPerBB++;
1166       if (NumInsnsPerBB >= ClMaxInsnsToInstrumentPerBB)
1167         break;
1168     }
1169   }
1170
1171   Function *UninstrumentedDuplicate = 0;
1172   bool LikelyToInstrument =
1173       !NoReturnCalls.empty() || !ToInstrument.empty() || (NumAllocas > 0);
1174   if (ClKeepUninstrumented && LikelyToInstrument) {
1175     ValueToValueMapTy VMap;
1176     UninstrumentedDuplicate = CloneFunction(&F, VMap, false);
1177     UninstrumentedDuplicate->removeFnAttr(Attribute::SanitizeAddress);
1178     UninstrumentedDuplicate->setName("NOASAN_" + F.getName());
1179     F.getParent()->getFunctionList().push_back(UninstrumentedDuplicate);
1180   }
1181
1182   // Instrument.
1183   int NumInstrumented = 0;
1184   for (size_t i = 0, n = ToInstrument.size(); i != n; i++) {
1185     Instruction *Inst = ToInstrument[i];
1186     if (ClDebugMin < 0 || ClDebugMax < 0 ||
1187         (NumInstrumented >= ClDebugMin && NumInstrumented <= ClDebugMax)) {
1188       if (isInterestingMemoryAccess(Inst, &IsWrite))
1189         instrumentMop(Inst);
1190       else
1191         instrumentMemIntrinsic(cast<MemIntrinsic>(Inst));
1192     }
1193     NumInstrumented++;
1194   }
1195
1196   FunctionStackPoisoner FSP(F, *this);
1197   bool ChangedStack = FSP.runOnFunction();
1198
1199   // We must unpoison the stack before every NoReturn call (throw, _exit, etc).
1200   // See e.g. http://code.google.com/p/address-sanitizer/issues/detail?id=37
1201   for (size_t i = 0, n = NoReturnCalls.size(); i != n; i++) {
1202     Instruction *CI = NoReturnCalls[i];
1203     IRBuilder<> IRB(CI);
1204     IRB.CreateCall(AsanHandleNoReturnFunc);
1205   }
1206
1207   bool res = NumInstrumented > 0 || ChangedStack || !NoReturnCalls.empty();
1208   DEBUG(dbgs() << "ASAN done instrumenting: " << res << " " << F << "\n");
1209
1210   if (ClKeepUninstrumented) {
1211     if (!res) {
1212       // No instrumentation is done, no need for the duplicate.
1213       if (UninstrumentedDuplicate)
1214         UninstrumentedDuplicate->eraseFromParent();
1215     } else {
1216       // The function was instrumented. We must have the duplicate.
1217       assert(UninstrumentedDuplicate);
1218       UninstrumentedDuplicate->setSection("NOASAN");
1219       assert(!F.hasSection());
1220       F.setSection("ASAN");
1221     }
1222   }
1223
1224   return res;
1225 }
1226
1227 static uint64_t ValueForPoison(uint64_t PoisonByte, size_t ShadowRedzoneSize) {
1228   if (ShadowRedzoneSize == 1) return PoisonByte;
1229   if (ShadowRedzoneSize == 2) return (PoisonByte << 8) + PoisonByte;
1230   if (ShadowRedzoneSize == 4)
1231     return (PoisonByte << 24) + (PoisonByte << 16) +
1232         (PoisonByte << 8) + (PoisonByte);
1233   llvm_unreachable("ShadowRedzoneSize is either 1, 2 or 4");
1234 }
1235
1236 static void PoisonShadowPartialRightRedzone(uint8_t *Shadow,
1237                                             size_t Size,
1238                                             size_t RZSize,
1239                                             size_t ShadowGranularity,
1240                                             uint8_t Magic) {
1241   for (size_t i = 0; i < RZSize;
1242        i+= ShadowGranularity, Shadow++) {
1243     if (i + ShadowGranularity <= Size) {
1244       *Shadow = 0;  // fully addressable
1245     } else if (i >= Size) {
1246       *Shadow = Magic;  // unaddressable
1247     } else {
1248       *Shadow = Size - i;  // first Size-i bytes are addressable
1249     }
1250   }
1251 }
1252
1253 // Workaround for bug 11395: we don't want to instrument stack in functions
1254 // with large assembly blobs (32-bit only), otherwise reg alloc may crash.
1255 // FIXME: remove once the bug 11395 is fixed.
1256 bool AddressSanitizer::LooksLikeCodeInBug11395(Instruction *I) {
1257   if (LongSize != 32) return false;
1258   CallInst *CI = dyn_cast<CallInst>(I);
1259   if (!CI || !CI->isInlineAsm()) return false;
1260   if (CI->getNumArgOperands() <= 5) return false;
1261   // We have inline assembly with quite a few arguments.
1262   return true;
1263 }
1264
1265 void FunctionStackPoisoner::initializeCallbacks(Module &M) {
1266   IRBuilder<> IRB(*C);
1267   AsanStackMallocFunc = checkInterfaceFunction(M.getOrInsertFunction(
1268       kAsanStackMallocName, IntptrTy, IntptrTy, IntptrTy, NULL));
1269   AsanStackFreeFunc = checkInterfaceFunction(M.getOrInsertFunction(
1270       kAsanStackFreeName, IRB.getVoidTy(),
1271       IntptrTy, IntptrTy, IntptrTy, NULL));
1272   AsanPoisonStackMemoryFunc = checkInterfaceFunction(M.getOrInsertFunction(
1273       kAsanPoisonStackMemoryName, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
1274   AsanUnpoisonStackMemoryFunc = checkInterfaceFunction(M.getOrInsertFunction(
1275       kAsanUnpoisonStackMemoryName, IRB.getVoidTy(), IntptrTy, IntptrTy, NULL));
1276 }
1277
1278 void FunctionStackPoisoner::poisonRedZones(
1279   const ArrayRef<AllocaInst*> &AllocaVec, IRBuilder<> IRB, Value *ShadowBase,
1280   bool DoPoison) {
1281   size_t ShadowRZSize = RedzoneSize() >> Mapping.Scale;
1282   assert(ShadowRZSize >= 1 && ShadowRZSize <= 4);
1283   Type *RZTy = Type::getIntNTy(*C, ShadowRZSize * 8);
1284   Type *RZPtrTy = PointerType::get(RZTy, 0);
1285
1286   Value *PoisonLeft  = ConstantInt::get(RZTy,
1287     ValueForPoison(DoPoison ? kAsanStackLeftRedzoneMagic : 0LL, ShadowRZSize));
1288   Value *PoisonMid   = ConstantInt::get(RZTy,
1289     ValueForPoison(DoPoison ? kAsanStackMidRedzoneMagic : 0LL, ShadowRZSize));
1290   Value *PoisonRight = ConstantInt::get(RZTy,
1291     ValueForPoison(DoPoison ? kAsanStackRightRedzoneMagic : 0LL, ShadowRZSize));
1292
1293   // poison the first red zone.
1294   IRB.CreateStore(PoisonLeft, IRB.CreateIntToPtr(ShadowBase, RZPtrTy));
1295
1296   // poison all other red zones.
1297   uint64_t Pos = RedzoneSize();
1298   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
1299     AllocaInst *AI = AllocaVec[i];
1300     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
1301     uint64_t AlignedSize = getAlignedAllocaSize(AI);
1302     assert(AlignedSize - SizeInBytes < RedzoneSize());
1303     Value *Ptr = NULL;
1304
1305     Pos += AlignedSize;
1306
1307     assert(ShadowBase->getType() == IntptrTy);
1308     if (SizeInBytes < AlignedSize) {
1309       // Poison the partial redzone at right
1310       Ptr = IRB.CreateAdd(
1311           ShadowBase, ConstantInt::get(IntptrTy,
1312                                        (Pos >> Mapping.Scale) - ShadowRZSize));
1313       size_t AddressableBytes = RedzoneSize() - (AlignedSize - SizeInBytes);
1314       uint32_t Poison = 0;
1315       if (DoPoison) {
1316         PoisonShadowPartialRightRedzone((uint8_t*)&Poison, AddressableBytes,
1317                                         RedzoneSize(),
1318                                         1ULL << Mapping.Scale,
1319                                         kAsanStackPartialRedzoneMagic);
1320         Poison =
1321             ASan.TD->isLittleEndian()
1322                 ? support::endian::byte_swap<uint32_t, support::little>(Poison)
1323                 : support::endian::byte_swap<uint32_t, support::big>(Poison);
1324       }
1325       Value *PartialPoison = ConstantInt::get(RZTy, Poison);
1326       IRB.CreateStore(PartialPoison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
1327     }
1328
1329     // Poison the full redzone at right.
1330     Ptr = IRB.CreateAdd(ShadowBase,
1331                         ConstantInt::get(IntptrTy, Pos >> Mapping.Scale));
1332     bool LastAlloca = (i == AllocaVec.size() - 1);
1333     Value *Poison = LastAlloca ? PoisonRight : PoisonMid;
1334     IRB.CreateStore(Poison, IRB.CreateIntToPtr(Ptr, RZPtrTy));
1335
1336     Pos += RedzoneSize();
1337   }
1338 }
1339
1340 void FunctionStackPoisoner::poisonStack() {
1341   uint64_t LocalStackSize = TotalStackSize +
1342                             (AllocaVec.size() + 1) * RedzoneSize();
1343
1344   bool DoStackMalloc = ASan.CheckUseAfterReturn
1345       && LocalStackSize <= kMaxStackMallocSize;
1346
1347   assert(AllocaVec.size() > 0);
1348   Instruction *InsBefore = AllocaVec[0];
1349   IRBuilder<> IRB(InsBefore);
1350
1351
1352   Type *ByteArrayTy = ArrayType::get(IRB.getInt8Ty(), LocalStackSize);
1353   AllocaInst *MyAlloca =
1354       new AllocaInst(ByteArrayTy, "MyAlloca", InsBefore);
1355   if (ClRealignStack && StackAlignment < RedzoneSize())
1356     StackAlignment = RedzoneSize();
1357   MyAlloca->setAlignment(StackAlignment);
1358   assert(MyAlloca->isStaticAlloca());
1359   Value *OrigStackBase = IRB.CreatePointerCast(MyAlloca, IntptrTy);
1360   Value *LocalStackBase = OrigStackBase;
1361
1362   if (DoStackMalloc) {
1363     LocalStackBase = IRB.CreateCall2(AsanStackMallocFunc,
1364         ConstantInt::get(IntptrTy, LocalStackSize), OrigStackBase);
1365   }
1366
1367   // This string will be parsed by the run-time (DescribeAddressIfStack).
1368   SmallString<2048> StackDescriptionStorage;
1369   raw_svector_ostream StackDescription(StackDescriptionStorage);
1370   StackDescription << AllocaVec.size() << " ";
1371
1372   // Insert poison calls for lifetime intrinsics for alloca.
1373   bool HavePoisonedAllocas = false;
1374   for (size_t i = 0, n = AllocaPoisonCallVec.size(); i < n; i++) {
1375     const AllocaPoisonCall &APC = AllocaPoisonCallVec[i];
1376     IntrinsicInst *II = APC.InsBefore;
1377     AllocaInst *AI = findAllocaForValue(II->getArgOperand(1));
1378     assert(AI);
1379     IRBuilder<> IRB(II);
1380     poisonAlloca(AI, APC.Size, IRB, APC.DoPoison);
1381     HavePoisonedAllocas |= APC.DoPoison;
1382   }
1383
1384   uint64_t Pos = RedzoneSize();
1385   // Replace Alloca instructions with base+offset.
1386   for (size_t i = 0, n = AllocaVec.size(); i < n; i++) {
1387     AllocaInst *AI = AllocaVec[i];
1388     uint64_t SizeInBytes = getAllocaSizeInBytes(AI);
1389     StringRef Name = AI->getName();
1390     StackDescription << Pos << " " << SizeInBytes << " "
1391                      << Name.size() << " " << Name << " ";
1392     uint64_t AlignedSize = getAlignedAllocaSize(AI);
1393     assert((AlignedSize % RedzoneSize()) == 0);
1394     Value *NewAllocaPtr = IRB.CreateIntToPtr(
1395             IRB.CreateAdd(LocalStackBase, ConstantInt::get(IntptrTy, Pos)),
1396             AI->getType());
1397     replaceDbgDeclareForAlloca(AI, NewAllocaPtr, DIB);
1398     AI->replaceAllUsesWith(NewAllocaPtr);
1399     Pos += AlignedSize + RedzoneSize();
1400   }
1401   assert(Pos == LocalStackSize);
1402
1403   // The left-most redzone has enough space for at least 4 pointers.
1404   // Write the Magic value to redzone[0].
1405   Value *BasePlus0 = IRB.CreateIntToPtr(LocalStackBase, IntptrPtrTy);
1406   IRB.CreateStore(ConstantInt::get(IntptrTy, kCurrentStackFrameMagic),
1407                   BasePlus0);
1408   // Write the frame description constant to redzone[1].
1409   Value *BasePlus1 = IRB.CreateIntToPtr(
1410     IRB.CreateAdd(LocalStackBase, ConstantInt::get(IntptrTy, ASan.LongSize/8)),
1411     IntptrPtrTy);
1412   GlobalVariable *StackDescriptionGlobal =
1413       createPrivateGlobalForString(*F.getParent(), StackDescription.str());
1414   Value *Description = IRB.CreatePointerCast(StackDescriptionGlobal,
1415                                              IntptrTy);
1416   IRB.CreateStore(Description, BasePlus1);
1417   // Write the PC to redzone[2].
1418   Value *BasePlus2 = IRB.CreateIntToPtr(
1419     IRB.CreateAdd(LocalStackBase, ConstantInt::get(IntptrTy,
1420                                                    2 * ASan.LongSize/8)),
1421     IntptrPtrTy);
1422   IRB.CreateStore(IRB.CreatePointerCast(&F, IntptrTy), BasePlus2);
1423
1424   // Poison the stack redzones at the entry.
1425   Value *ShadowBase = ASan.memToShadow(LocalStackBase, IRB);
1426   poisonRedZones(AllocaVec, IRB, ShadowBase, true);
1427
1428   // Unpoison the stack before all ret instructions.
1429   for (size_t i = 0, n = RetVec.size(); i < n; i++) {
1430     Instruction *Ret = RetVec[i];
1431     IRBuilder<> IRBRet(Ret);
1432     // Mark the current frame as retired.
1433     IRBRet.CreateStore(ConstantInt::get(IntptrTy, kRetiredStackFrameMagic),
1434                        BasePlus0);
1435     // Unpoison the stack.
1436     poisonRedZones(AllocaVec, IRBRet, ShadowBase, false);
1437     if (DoStackMalloc) {
1438       // In use-after-return mode, mark the whole stack frame unaddressable.
1439       IRBRet.CreateCall3(AsanStackFreeFunc, LocalStackBase,
1440                          ConstantInt::get(IntptrTy, LocalStackSize),
1441                          OrigStackBase);
1442     } else if (HavePoisonedAllocas) {
1443       // If we poisoned some allocas in llvm.lifetime analysis,
1444       // unpoison whole stack frame now.
1445       assert(LocalStackBase == OrigStackBase);
1446       poisonAlloca(LocalStackBase, LocalStackSize, IRBRet, false);
1447     }
1448   }
1449
1450   // We are done. Remove the old unused alloca instructions.
1451   for (size_t i = 0, n = AllocaVec.size(); i < n; i++)
1452     AllocaVec[i]->eraseFromParent();
1453 }
1454
1455 void FunctionStackPoisoner::poisonAlloca(Value *V, uint64_t Size,
1456                                          IRBuilder<> IRB, bool DoPoison) {
1457   // For now just insert the call to ASan runtime.
1458   Value *AddrArg = IRB.CreatePointerCast(V, IntptrTy);
1459   Value *SizeArg = ConstantInt::get(IntptrTy, Size);
1460   IRB.CreateCall2(DoPoison ? AsanPoisonStackMemoryFunc
1461                            : AsanUnpoisonStackMemoryFunc,
1462                   AddrArg, SizeArg);
1463 }
1464
1465 // Handling llvm.lifetime intrinsics for a given %alloca:
1466 // (1) collect all llvm.lifetime.xxx(%size, %value) describing the alloca.
1467 // (2) if %size is constant, poison memory for llvm.lifetime.end (to detect
1468 //     invalid accesses) and unpoison it for llvm.lifetime.start (the memory
1469 //     could be poisoned by previous llvm.lifetime.end instruction, as the
1470 //     variable may go in and out of scope several times, e.g. in loops).
1471 // (3) if we poisoned at least one %alloca in a function,
1472 //     unpoison the whole stack frame at function exit.
1473
1474 AllocaInst *FunctionStackPoisoner::findAllocaForValue(Value *V) {
1475   if (AllocaInst *AI = dyn_cast<AllocaInst>(V))
1476     // We're intested only in allocas we can handle.
1477     return isInterestingAlloca(*AI) ? AI : 0;
1478   // See if we've already calculated (or started to calculate) alloca for a
1479   // given value.
1480   AllocaForValueMapTy::iterator I = AllocaForValue.find(V);
1481   if (I != AllocaForValue.end())
1482     return I->second;
1483   // Store 0 while we're calculating alloca for value V to avoid
1484   // infinite recursion if the value references itself.
1485   AllocaForValue[V] = 0;
1486   AllocaInst *Res = 0;
1487   if (CastInst *CI = dyn_cast<CastInst>(V))
1488     Res = findAllocaForValue(CI->getOperand(0));
1489   else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1490     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1491       Value *IncValue = PN->getIncomingValue(i);
1492       // Allow self-referencing phi-nodes.
1493       if (IncValue == PN) continue;
1494       AllocaInst *IncValueAI = findAllocaForValue(IncValue);
1495       // AI for incoming values should exist and should all be equal.
1496       if (IncValueAI == 0 || (Res != 0 && IncValueAI != Res))
1497         return 0;
1498       Res = IncValueAI;
1499     }
1500   }
1501   if (Res != 0)
1502     AllocaForValue[V] = Res;
1503   return Res;
1504 }