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