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