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