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