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