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