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