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