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