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