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