lib/Transforms/Instrumentation/DataFlowSanitizer.cpp

   1 //===-- DataFlowSanitizer.cpp - dynamic data flow analysis ----------------===//
   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 /// \file
  10 /// This file is a part of DataFlowSanitizer, a generalised dynamic data flow
  11 /// analysis.
  12 ///
  13 /// Unlike other Sanitizer tools, this tool is not designed to detect a specific
  14 /// class of bugs on its own.  Instead, it provides a generic dynamic data flow
  15 /// analysis framework to be used by clients to help detect application-specific
  16 /// issues within their own code.
  17 ///
  18 /// The analysis is based on automatic propagation of data flow labels (also
  19 /// known as taint labels) through a program as it performs computation.  Each
  20 /// byte of application memory is backed by two bytes of shadow memory which
  21 /// hold the label.  On Linux/x86_64, memory is laid out as follows:
  22 ///
  23 /// +--------------------+ 0x800000000000 (top of memory)
  24 /// | application memory |
  25 /// +--------------------+ 0x700000008000 (kAppAddr)
  26 /// |                    |
  27 /// |       unused       |
  28 /// |                    |
  29 /// +--------------------+ 0x200200000000 (kUnusedAddr)
  30 /// |    union table     |
  31 /// +--------------------+ 0x200000000000 (kUnionTableAddr)
  32 /// |   shadow memory    |
  33 /// +--------------------+ 0x000000010000 (kShadowAddr)
  34 /// | reserved by kernel |
  35 /// +--------------------+ 0x000000000000
  36 ///
  37 /// To derive a shadow memory address from an application memory address,
  38 /// bits 44-46 are cleared to bring the address into the range
  39 /// [0x000000008000,0x100000000000).  Then the address is shifted left by 1 to
  40 /// account for the double byte representation of shadow labels and move the
  41 /// address into the shadow memory range.  See the function
  42 /// DataFlowSanitizer::getShadowAddress below.
  43 ///
  44 /// For more information, please refer to the design document:
  45 /// http://clang.llvm.org/docs/DataFlowSanitizerDesign.html
  46
  47 #include "llvm/Transforms/Instrumentation.h"
  48 #include "llvm/ADT/DenseMap.h"
  49 #include "llvm/ADT/DenseSet.h"
  50 #include "llvm/ADT/DepthFirstIterator.h"
  51 #include "llvm/ADT/StringExtras.h"
  52 #include "llvm/Analysis/ValueTracking.h"
  53 #include "llvm/IR/InlineAsm.h"
  54 #include "llvm/IR/IRBuilder.h"
  55 #include "llvm/IR/LLVMContext.h"
  56 #include "llvm/IR/MDBuilder.h"
  57 #include "llvm/IR/Type.h"
  58 #include "llvm/IR/Value.h"
  59 #include "llvm/InstVisitor.h"
  60 #include "llvm/Pass.h"
  61 #include "llvm/Support/CommandLine.h"
  62 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  63 #include "llvm/Transforms/Utils/Local.h"
  64 #include "llvm/Transforms/Utils/SpecialCaseList.h"
  65 #include <iterator>
  66
  67 using namespace llvm;
  68
  69 // The -dfsan-preserve-alignment flag controls whether this pass assumes that
  70 // alignment requirements provided by the input IR are correct.  For example,
  71 // if the input IR contains a load with alignment 8, this flag will cause
  72 // the shadow load to have alignment 16.  This flag is disabled by default as
  73 // we have unfortunately encountered too much code (including Clang itself;
  74 // see PR14291) which performs misaligned access.
  75 static cl::opt<bool> ClPreserveAlignment(
  76     "dfsan-preserve-alignment",
  77     cl::desc("respect alignment requirements provided by input IR"), cl::Hidden,
  78     cl::init(false));
  79
  80 // The ABI list file controls how shadow parameters are passed.  The pass treats
  81 // every function labelled "uninstrumented" in the ABI list file as conforming
  82 // to the "native" (i.e. unsanitized) ABI.  Unless the ABI list contains
  83 // additional annotations for those functions, a call to one of those functions
  84 // will produce a warning message, as the labelling behaviour of the function is
  85 // unknown.  The other supported annotations are "functional" and "discard",
  86 // which are described below under DataFlowSanitizer::WrapperKind.
  87 static cl::opt<std::string> ClABIListFile(
  88     "dfsan-abilist",
  89     cl::desc("File listing native ABI functions and how the pass treats them"),
  90     cl::Hidden);
  91
  92 // Controls whether the pass uses IA_Args or IA_TLS as the ABI for instrumented
  93 // functions (see DataFlowSanitizer::InstrumentedABI below).
  94 static cl::opt<bool> ClArgsABI(
  95     "dfsan-args-abi",
  96     cl::desc("Use the argument ABI rather than the TLS ABI"),
  97     cl::Hidden);
  98
  99 // Controls whether the pass includes or ignores the labels of pointers in load
 100 // instructions.
 101 static cl::opt<bool> ClCombinePointerLabelsOnLoad(
 102     "dfsan-combine-pointer-labels-on-load",
 103     cl::desc("Combine the label of the pointer with the label of the data when "
 104              "loading from memory."),
 105     cl::Hidden, cl::init(true));
 106
 107 // Controls whether the pass includes or ignores the labels of pointers in
 108 // stores instructions.
 109 static cl::opt<bool> ClCombinePointerLabelsOnStore(
 110     "dfsan-combine-pointer-labels-on-store",
 111     cl::desc("Combine the label of the pointer with the label of the data when "
 112              "storing in memory."),
 113     cl::Hidden, cl::init(false));
 114
 115 static cl::opt<bool> ClDebugNonzeroLabels(
 116     "dfsan-debug-nonzero-labels",
 117     cl::desc("Insert calls to __dfsan_nonzero_label on observing a parameter, "
 118              "load or return with a nonzero label"),
 119     cl::Hidden);
 120
 121 namespace {
 122
 123 class DataFlowSanitizer : public ModulePass {
 124   friend struct DFSanFunction;
 125   friend class DFSanVisitor;
 126
 127   enum {
 128     ShadowWidth = 16
 129   };
 130
 131   /// Which ABI should be used for instrumented functions?
 132   enum InstrumentedABI {
 133     /// Argument and return value labels are passed through additional
 134     /// arguments and by modifying the return type.
 135     IA_Args,
 136
 137     /// Argument and return value labels are passed through TLS variables
 138     /// __dfsan_arg_tls and __dfsan_retval_tls.
 139     IA_TLS
 140   };
 141
 142   /// How should calls to uninstrumented functions be handled?
 143   enum WrapperKind {
 144     /// This function is present in an uninstrumented form but we don't know
 145     /// how it should be handled.  Print a warning and call the function anyway.
 146     /// Don't label the return value.
 147     WK_Warning,
 148
 149     /// This function does not write to (user-accessible) memory, and its return
 150     /// value is unlabelled.
 151     WK_Discard,
 152
 153     /// This function does not write to (user-accessible) memory, and the label
 154     /// of its return value is the union of the label of its arguments.
 155     WK_Functional,
 156
 157     /// Instead of calling the function, a custom wrapper __dfsw_F is called,
 158     /// where F is the name of the function.  This function may wrap the
 159     /// original function or provide its own implementation.  This is similar to
 160     /// the IA_Args ABI, except that IA_Args uses a struct return type to
 161     /// pass the return value shadow in a register, while WK_Custom uses an
 162     /// extra pointer argument to return the shadow.  This allows the wrapped
 163     /// form of the function type to be expressed in C.
 164     WK_Custom
 165   };
 166
 167   DataLayout *DL;
 168   Module *Mod;
 169   LLVMContext *Ctx;
 170   IntegerType *ShadowTy;
 171   PointerType *ShadowPtrTy;
 172   IntegerType *IntptrTy;
 173   ConstantInt *ZeroShadow;
 174   ConstantInt *ShadowPtrMask;
 175   ConstantInt *ShadowPtrMul;
 176   Constant *ArgTLS;
 177   Constant *RetvalTLS;
 178   void *(*GetArgTLSPtr)();
 179   void *(*GetRetvalTLSPtr)();
 180   Constant *GetArgTLS;
 181   Constant *GetRetvalTLS;
 182   FunctionType *DFSanUnionFnTy;
 183   FunctionType *DFSanUnionLoadFnTy;
 184   FunctionType *DFSanUnimplementedFnTy;
 185   FunctionType *DFSanSetLabelFnTy;
 186   FunctionType *DFSanNonzeroLabelFnTy;
 187   Constant *DFSanUnionFn;
 188   Constant *DFSanUnionLoadFn;
 189   Constant *DFSanUnimplementedFn;
 190   Constant *DFSanSetLabelFn;
 191   Constant *DFSanNonzeroLabelFn;
 192   MDNode *ColdCallWeights;
 193   OwningPtr<SpecialCaseList> ABIList;
 194   DenseMap<Value *, Function *> UnwrappedFnMap;
 195   AttributeSet ReadOnlyNoneAttrs;
 196
 197   Value *getShadowAddress(Value *Addr, Instruction *Pos);
 198   Value *combineShadows(Value *V1, Value *V2, Instruction *Pos);
 199   bool isInstrumented(const Function *F);
 200   bool isInstrumented(const GlobalAlias *GA);
 201   FunctionType *getArgsFunctionType(FunctionType *T);
 202   FunctionType *getTrampolineFunctionType(FunctionType *T);
 203   FunctionType *getCustomFunctionType(FunctionType *T);
 204   InstrumentedABI getInstrumentedABI();
 205   WrapperKind getWrapperKind(Function *F);
 206   void addGlobalNamePrefix(GlobalValue *GV);
 207   Function *buildWrapperFunction(Function *F, StringRef NewFName,
 208                                  GlobalValue::LinkageTypes NewFLink,
 209                                  FunctionType *NewFT);
 210   Constant *getOrBuildTrampolineFunction(FunctionType *FT, StringRef FName);
 211
 212  public:
 213   DataFlowSanitizer(StringRef ABIListFile = StringRef(),
 214                     void *(*getArgTLS)() = 0, void *(*getRetValTLS)() = 0);
 215   static char ID;
 216   bool doInitialization(Module &M);
 217   bool runOnModule(Module &M);
 218 };
 219
 220 struct DFSanFunction {
 221   DataFlowSanitizer &DFS;
 222   Function *F;
 223   DataFlowSanitizer::InstrumentedABI IA;
 224   bool IsNativeABI;
 225   Value *ArgTLSPtr;
 226   Value *RetvalTLSPtr;
 227   AllocaInst *LabelReturnAlloca;
 228   DenseMap<Value *, Value *> ValShadowMap;
 229   DenseMap<AllocaInst *, AllocaInst *> AllocaShadowMap;
 230   std::vector<std::pair<PHINode *, PHINode *> > PHIFixups;
 231   DenseSet<Instruction *> SkipInsts;
 232   DenseSet<Value *> NonZeroChecks;
 233
 234   DFSanFunction(DataFlowSanitizer &DFS, Function *F, bool IsNativeABI)
 235       : DFS(DFS), F(F), IA(DFS.getInstrumentedABI()),
 236         IsNativeABI(IsNativeABI), ArgTLSPtr(0), RetvalTLSPtr(0),
 237         LabelReturnAlloca(0) {}
 238   Value *getArgTLSPtr();
 239   Value *getArgTLS(unsigned Index, Instruction *Pos);
 240   Value *getRetvalTLS();
 241   Value *getShadow(Value *V);
 242   void setShadow(Instruction *I, Value *Shadow);
 243   Value *combineOperandShadows(Instruction *Inst);
 244   Value *loadShadow(Value *ShadowAddr, uint64_t Size, uint64_t Align,
 245                     Instruction *Pos);
 246   void storeShadow(Value *Addr, uint64_t Size, uint64_t Align, Value *Shadow,
 247                    Instruction *Pos);
 248 };
 249
 250 class DFSanVisitor : public InstVisitor<DFSanVisitor> {
 251  public:
 252   DFSanFunction &DFSF;
 253   DFSanVisitor(DFSanFunction &DFSF) : DFSF(DFSF) {}
 254
 255   void visitOperandShadowInst(Instruction &I);
 256
 257   void visitBinaryOperator(BinaryOperator &BO);
 258   void visitCastInst(CastInst &CI);
 259   void visitCmpInst(CmpInst &CI);
 260   void visitGetElementPtrInst(GetElementPtrInst &GEPI);
 261   void visitLoadInst(LoadInst &LI);
 262   void visitStoreInst(StoreInst &SI);
 263   void visitReturnInst(ReturnInst &RI);
 264   void visitCallSite(CallSite CS);
 265   void visitPHINode(PHINode &PN);
 266   void visitExtractElementInst(ExtractElementInst &I);
 267   void visitInsertElementInst(InsertElementInst &I);
 268   void visitShuffleVectorInst(ShuffleVectorInst &I);
 269   void visitExtractValueInst(ExtractValueInst &I);
 270   void visitInsertValueInst(InsertValueInst &I);
 271   void visitAllocaInst(AllocaInst &I);
 272   void visitSelectInst(SelectInst &I);
 273   void visitMemSetInst(MemSetInst &I);
 274   void visitMemTransferInst(MemTransferInst &I);
 275 };
 276
 277 }
 278
 279 char DataFlowSanitizer::ID;
 280 INITIALIZE_PASS(DataFlowSanitizer, "dfsan",
 281                 "DataFlowSanitizer: dynamic data flow analysis.", false, false)
 282
 283 ModulePass *llvm::createDataFlowSanitizerPass(StringRef ABIListFile,
 284                                               void *(*getArgTLS)(),
 285                                               void *(*getRetValTLS)()) {
 286   return new DataFlowSanitizer(ABIListFile, getArgTLS, getRetValTLS);
 287 }
 288
 289 DataFlowSanitizer::DataFlowSanitizer(StringRef ABIListFile,
 290                                      void *(*getArgTLS)(),
 291                                      void *(*getRetValTLS)())
 292     : ModulePass(ID), GetArgTLSPtr(getArgTLS), GetRetvalTLSPtr(getRetValTLS),
 293       ABIList(SpecialCaseList::createOrDie(ABIListFile.empty() ? ClABIListFile
 294                                                                : ABIListFile)) {
 295 }
 296
 297 FunctionType *DataFlowSanitizer::getArgsFunctionType(FunctionType *T) {
 298   llvm::SmallVector<Type *, 4> ArgTypes;
 299   std::copy(T->param_begin(), T->param_end(), std::back_inserter(ArgTypes));
 300   for (unsigned i = 0, e = T->getNumParams(); i != e; ++i)
 301     ArgTypes.push_back(ShadowTy);
 302   if (T->isVarArg())
 303     ArgTypes.push_back(ShadowPtrTy);
 304   Type *RetType = T->getReturnType();
 305   if (!RetType->isVoidTy())
 306     RetType = StructType::get(RetType, ShadowTy, (Type *)0);
 307   return FunctionType::get(RetType, ArgTypes, T->isVarArg());
 308 }
 309
 310 FunctionType *DataFlowSanitizer::getTrampolineFunctionType(FunctionType *T) {
 311   assert(!T->isVarArg());
 312   llvm::SmallVector<Type *, 4> ArgTypes;
 313   ArgTypes.push_back(T->getPointerTo());
 314   std::copy(T->param_begin(), T->param_end(), std::back_inserter(ArgTypes));
 315   for (unsigned i = 0, e = T->getNumParams(); i != e; ++i)
 316     ArgTypes.push_back(ShadowTy);
 317   Type *RetType = T->getReturnType();
 318   if (!RetType->isVoidTy())
 319     ArgTypes.push_back(ShadowPtrTy);
 320   return FunctionType::get(T->getReturnType(), ArgTypes, false);
 321 }
 322
 323 FunctionType *DataFlowSanitizer::getCustomFunctionType(FunctionType *T) {
 324   assert(!T->isVarArg());
 325   llvm::SmallVector<Type *, 4> ArgTypes;
 326   for (FunctionType::param_iterator i = T->param_begin(), e = T->param_end();
 327        i != e; ++i) {
 328     FunctionType *FT;
 329     if (isa<PointerType>(*i) && (FT = dyn_cast<FunctionType>(cast<PointerType>(
 330                                      *i)->getElementType()))) {
 331       ArgTypes.push_back(getTrampolineFunctionType(FT)->getPointerTo());
 332       ArgTypes.push_back(Type::getInt8PtrTy(*Ctx));
 333     } else {
 334       ArgTypes.push_back(*i);
 335     }
 336   }
 337   for (unsigned i = 0, e = T->getNumParams(); i != e; ++i)
 338     ArgTypes.push_back(ShadowTy);
 339   Type *RetType = T->getReturnType();
 340   if (!RetType->isVoidTy())
 341     ArgTypes.push_back(ShadowPtrTy);
 342   return FunctionType::get(T->getReturnType(), ArgTypes, false);
 343 }
 344
 345 bool DataFlowSanitizer::doInitialization(Module &M) {
 346   DL = getAnalysisIfAvailable<DataLayout>();
 347   if (!DL)
 348     return false;
 349
 350   Mod = &M;
 351   Ctx = &M.getContext();
 352   ShadowTy = IntegerType::get(*Ctx, ShadowWidth);
 353   ShadowPtrTy = PointerType::getUnqual(ShadowTy);
 354   IntptrTy = DL->getIntPtrType(*Ctx);
 355   ZeroShadow = ConstantInt::getSigned(ShadowTy, 0);
 356   ShadowPtrMask = ConstantInt::getSigned(IntptrTy, ~0x700000000000LL);
 357   ShadowPtrMul = ConstantInt::getSigned(IntptrTy, ShadowWidth / 8);
 358
 359   Type *DFSanUnionArgs[2] = { ShadowTy, ShadowTy };
 360   DFSanUnionFnTy =
 361       FunctionType::get(ShadowTy, DFSanUnionArgs, /*isVarArg=*/ false);
 362   Type *DFSanUnionLoadArgs[2] = { ShadowPtrTy, IntptrTy };
 363   DFSanUnionLoadFnTy =
 364       FunctionType::get(ShadowTy, DFSanUnionLoadArgs, /*isVarArg=*/ false);
 365   DFSanUnimplementedFnTy = FunctionType::get(
 366       Type::getVoidTy(*Ctx), Type::getInt8PtrTy(*Ctx), /*isVarArg=*/false);
 367   Type *DFSanSetLabelArgs[3] = { ShadowTy, Type::getInt8PtrTy(*Ctx), IntptrTy };
 368   DFSanSetLabelFnTy = FunctionType::get(Type::getVoidTy(*Ctx),
 369                                         DFSanSetLabelArgs, /*isVarArg=*/false);
 370   DFSanNonzeroLabelFnTy = FunctionType::get(
 371       Type::getVoidTy(*Ctx), ArrayRef<Type *>(), /*isVarArg=*/false);
 372
 373   if (GetArgTLSPtr) {
 374     Type *ArgTLSTy = ArrayType::get(ShadowTy, 64);
 375     ArgTLS = 0;
 376     GetArgTLS = ConstantExpr::getIntToPtr(
 377         ConstantInt::get(IntptrTy, uintptr_t(GetArgTLSPtr)),
 378         PointerType::getUnqual(
 379             FunctionType::get(PointerType::getUnqual(ArgTLSTy), (Type *)0)));
 380   }
 381   if (GetRetvalTLSPtr) {
 382     RetvalTLS = 0;
 383     GetRetvalTLS = ConstantExpr::getIntToPtr(
 384         ConstantInt::get(IntptrTy, uintptr_t(GetRetvalTLSPtr)),
 385         PointerType::getUnqual(
 386             FunctionType::get(PointerType::getUnqual(ShadowTy), (Type *)0)));
 387   }
 388
 389   ColdCallWeights = MDBuilder(*Ctx).createBranchWeights(1, 1000);
 390   return true;
 391 }
 392
 393 bool DataFlowSanitizer::isInstrumented(const Function *F) {
 394   return !ABIList->isIn(*F, "uninstrumented");
 395 }
 396
 397 bool DataFlowSanitizer::isInstrumented(const GlobalAlias *GA) {
 398   return !ABIList->isIn(*GA, "uninstrumented");
 399 }
 400
 401 DataFlowSanitizer::InstrumentedABI DataFlowSanitizer::getInstrumentedABI() {
 402   return ClArgsABI ? IA_Args : IA_TLS;
 403 }
 404
 405 DataFlowSanitizer::WrapperKind DataFlowSanitizer::getWrapperKind(Function *F) {
 406   if (ABIList->isIn(*F, "functional"))
 407     return WK_Functional;
 408   if (ABIList->isIn(*F, "discard"))
 409     return WK_Discard;
 410   if (ABIList->isIn(*F, "custom"))
 411     return WK_Custom;
 412
 413   return WK_Warning;
 414 }
 415
 416 void DataFlowSanitizer::addGlobalNamePrefix(GlobalValue *GV) {
 417   std::string GVName = GV->getName(), Prefix = "dfs$";
 418   GV->setName(Prefix + GVName);
 419
 420   // Try to change the name of the function in module inline asm.  We only do
 421   // this for specific asm directives, currently only ".symver", to try to avoid
 422   // corrupting asm which happens to contain the symbol name as a substring.
 423   // Note that the substitution for .symver assumes that the versioned symbol
 424   // also has an instrumented name.
 425   std::string Asm = GV->getParent()->getModuleInlineAsm();
 426   std::string SearchStr = ".symver " + GVName + ",";
 427   size_t Pos = Asm.find(SearchStr);
 428   if (Pos != std::string::npos) {
 429     Asm.replace(Pos, SearchStr.size(),
 430                 ".symver " + Prefix + GVName + "," + Prefix);
 431     GV->getParent()->setModuleInlineAsm(Asm);
 432   }
 433 }
 434
 435 Function *
 436 DataFlowSanitizer::buildWrapperFunction(Function *F, StringRef NewFName,
 437                                         GlobalValue::LinkageTypes NewFLink,
 438                                         FunctionType *NewFT) {
 439   FunctionType *FT = F->getFunctionType();
 440   Function *NewF = Function::Create(NewFT, NewFLink, NewFName,
 441                                     F->getParent());
 442   NewF->copyAttributesFrom(F);
 443   NewF->removeAttributes(
 444       AttributeSet::ReturnIndex,
 445       AttributeFuncs::typeIncompatible(NewFT->getReturnType(),
 446                                        AttributeSet::ReturnIndex));
 447
 448   BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", NewF);
 449   std::vector<Value *> Args;
 450   unsigned n = FT->getNumParams();
 451   for (Function::arg_iterator ai = NewF->arg_begin(); n != 0; ++ai, --n)
 452     Args.push_back(&*ai);
 453   CallInst *CI = CallInst::Create(F, Args, "", BB);
 454   if (FT->getReturnType()->isVoidTy())
 455     ReturnInst::Create(*Ctx, BB);
 456   else
 457     ReturnInst::Create(*Ctx, CI, BB);
 458
 459   return NewF;
 460 }
 461
 462 Constant *DataFlowSanitizer::getOrBuildTrampolineFunction(FunctionType *FT,
 463                                                           StringRef FName) {
 464   FunctionType *FTT = getTrampolineFunctionType(FT);
 465   Constant *C = Mod->getOrInsertFunction(FName, FTT);
 466   Function *F = dyn_cast<Function>(C);
 467   if (F && F->isDeclaration()) {
 468     F->setLinkage(GlobalValue::LinkOnceODRLinkage);
 469     BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", F);
 470     std::vector<Value *> Args;
 471     Function::arg_iterator AI = F->arg_begin(); ++AI;
 472     for (unsigned N = FT->getNumParams(); N != 0; ++AI, --N)
 473       Args.push_back(&*AI);
 474     CallInst *CI =
 475         CallInst::Create(&F->getArgumentList().front(), Args, "", BB);
 476     ReturnInst *RI;
 477     if (FT->getReturnType()->isVoidTy())
 478       RI = ReturnInst::Create(*Ctx, BB);
 479     else
 480       RI = ReturnInst::Create(*Ctx, CI, BB);
 481
 482     DFSanFunction DFSF(*this, F, /*IsNativeABI=*/true);
 483     Function::arg_iterator ValAI = F->arg_begin(), ShadowAI = AI; ++ValAI;
 484     for (unsigned N = FT->getNumParams(); N != 0; ++ValAI, ++ShadowAI, --N)
 485       DFSF.ValShadowMap[ValAI] = ShadowAI;
 486     DFSanVisitor(DFSF).visitCallInst(*CI);
 487     if (!FT->getReturnType()->isVoidTy())
 488       new StoreInst(DFSF.getShadow(RI->getReturnValue()),
 489                     &F->getArgumentList().back(), RI);
 490   }
 491
 492   return C;
 493 }
 494
 495 bool DataFlowSanitizer::runOnModule(Module &M) {
 496   if (!DL)
 497     return false;
 498
 499   if (ABIList->isIn(M, "skip"))
 500     return false;
 501
 502   if (!GetArgTLSPtr) {
 503     Type *ArgTLSTy = ArrayType::get(ShadowTy, 64);
 504     ArgTLS = Mod->getOrInsertGlobal("__dfsan_arg_tls", ArgTLSTy);
 505     if (GlobalVariable *G = dyn_cast<GlobalVariable>(ArgTLS))
 506       G->setThreadLocalMode(GlobalVariable::InitialExecTLSModel);
 507   }
 508   if (!GetRetvalTLSPtr) {
 509     RetvalTLS = Mod->getOrInsertGlobal("__dfsan_retval_tls", ShadowTy);
 510     if (GlobalVariable *G = dyn_cast<GlobalVariable>(RetvalTLS))
 511       G->setThreadLocalMode(GlobalVariable::InitialExecTLSModel);
 512   }
 513
 514   DFSanUnionFn = Mod->getOrInsertFunction("__dfsan_union", DFSanUnionFnTy);
 515   if (Function *F = dyn_cast<Function>(DFSanUnionFn)) {
 516     F->addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
 517     F->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
 518     F->addAttribute(1, Attribute::ZExt);
 519     F->addAttribute(2, Attribute::ZExt);
 520   }
 521   DFSanUnionLoadFn =
 522       Mod->getOrInsertFunction("__dfsan_union_load", DFSanUnionLoadFnTy);
 523   if (Function *F = dyn_cast<Function>(DFSanUnionLoadFn)) {
 524     F->addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
 525     F->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
 526   }
 527   DFSanUnimplementedFn =
 528       Mod->getOrInsertFunction("__dfsan_unimplemented", DFSanUnimplementedFnTy);
 529   DFSanSetLabelFn =
 530       Mod->getOrInsertFunction("__dfsan_set_label", DFSanSetLabelFnTy);
 531   if (Function *F = dyn_cast<Function>(DFSanSetLabelFn)) {
 532     F->addAttribute(1, Attribute::ZExt);
 533   }
 534   DFSanNonzeroLabelFn =
 535       Mod->getOrInsertFunction("__dfsan_nonzero_label", DFSanNonzeroLabelFnTy);
 536
 537   std::vector<Function *> FnsToInstrument;
 538   llvm::SmallPtrSet<Function *, 2> FnsWithNativeABI;
 539   for (Module::iterator i = M.begin(), e = M.end(); i != e; ++i) {
 540     if (!i->isIntrinsic() &&
 541         i != DFSanUnionFn &&
 542         i != DFSanUnionLoadFn &&
 543         i != DFSanUnimplementedFn &&
 544         i != DFSanSetLabelFn &&
 545         i != DFSanNonzeroLabelFn)
 546       FnsToInstrument.push_back(&*i);
 547   }
 548
 549   // Give function aliases prefixes when necessary, and build wrappers where the
 550   // instrumentedness is inconsistent.
 551   for (Module::alias_iterator i = M.alias_begin(), e = M.alias_end(); i != e;) {
 552     GlobalAlias *GA = &*i;
 553     ++i;
 554     // Don't stop on weak.  We assume people aren't playing games with the
 555     // instrumentedness of overridden weak aliases.
 556     if (Function *F = dyn_cast<Function>(
 557             GA->resolveAliasedGlobal(/*stopOnWeak=*/false))) {
 558       bool GAInst = isInstrumented(GA), FInst = isInstrumented(F);
 559       if (GAInst && FInst) {
 560         addGlobalNamePrefix(GA);
 561       } else if (GAInst != FInst) {
 562         // Non-instrumented alias of an instrumented function, or vice versa.
 563         // Replace the alias with a native-ABI wrapper of the aliasee.  The pass
 564         // below will take care of instrumenting it.
 565         Function *NewF =
 566             buildWrapperFunction(F, "", GA->getLinkage(), F->getFunctionType());
 567         GA->replaceAllUsesWith(NewF);
 568         NewF->takeName(GA);
 569         GA->eraseFromParent();
 570         FnsToInstrument.push_back(NewF);
 571       }
 572     }
 573   }
 574
 575   AttrBuilder B;
 576   B.addAttribute(Attribute::ReadOnly).addAttribute(Attribute::ReadNone);
 577   ReadOnlyNoneAttrs = AttributeSet::get(*Ctx, AttributeSet::FunctionIndex, B);
 578
 579   // First, change the ABI of every function in the module.  ABI-listed
 580   // functions keep their original ABI and get a wrapper function.
 581   for (std::vector<Function *>::iterator i = FnsToInstrument.begin(),
 582                                          e = FnsToInstrument.end();
 583        i != e; ++i) {
 584     Function &F = **i;
 585     FunctionType *FT = F.getFunctionType();
 586
 587     bool IsZeroArgsVoidRet = (FT->getNumParams() == 0 && !FT->isVarArg() &&
 588                               FT->getReturnType()->isVoidTy());
 589
 590     if (isInstrumented(&F)) {
 591       // Instrumented functions get a 'dfs$' prefix.  This allows us to more
 592       // easily identify cases of mismatching ABIs.
 593       if (getInstrumentedABI() == IA_Args && !IsZeroArgsVoidRet) {
 594         FunctionType *NewFT = getArgsFunctionType(FT);
 595         Function *NewF = Function::Create(NewFT, F.getLinkage(), "", &M);
 596         NewF->copyAttributesFrom(&F);
 597         NewF->removeAttributes(
 598             AttributeSet::ReturnIndex,
 599             AttributeFuncs::typeIncompatible(NewFT->getReturnType(),
 600                                              AttributeSet::ReturnIndex));
 601         for (Function::arg_iterator FArg = F.arg_begin(),
 602                                     NewFArg = NewF->arg_begin(),
 603                                     FArgEnd = F.arg_end();
 604              FArg != FArgEnd; ++FArg, ++NewFArg) {
 605           FArg->replaceAllUsesWith(NewFArg);
 606         }
 607         NewF->getBasicBlockList().splice(NewF->begin(), F.getBasicBlockList());
 608
 609         for (Function::use_iterator ui = F.use_begin(), ue = F.use_end();
 610              ui != ue;) {
 611           BlockAddress *BA = dyn_cast<BlockAddress>(ui.getUse().getUser());
 612           ++ui;
 613           if (BA) {
 614             BA->replaceAllUsesWith(
 615                 BlockAddress::get(NewF, BA->getBasicBlock()));
 616             delete BA;
 617           }
 618         }
 619         F.replaceAllUsesWith(
 620             ConstantExpr::getBitCast(NewF, PointerType::getUnqual(FT)));
 621         NewF->takeName(&F);
 622         F.eraseFromParent();
 623         *i = NewF;
 624         addGlobalNamePrefix(NewF);
 625       } else {
 626         addGlobalNamePrefix(&F);
 627       }
 628                // Hopefully, nobody will try to indirectly call a vararg
 629                // function... yet.
 630     } else if (FT->isVarArg()) {
 631       UnwrappedFnMap[&F] = &F;
 632       *i = 0;
 633     } else if (!IsZeroArgsVoidRet || getWrapperKind(&F) == WK_Custom) {
 634       // Build a wrapper function for F.  The wrapper simply calls F, and is
 635       // added to FnsToInstrument so that any instrumentation according to its
 636       // WrapperKind is done in the second pass below.
 637       FunctionType *NewFT = getInstrumentedABI() == IA_Args
 638                                 ? getArgsFunctionType(FT)
 639                                 : FT;
 640       Function *NewF = buildWrapperFunction(
 641           &F, std::string("dfsw$") + std::string(F.getName()),
 642           GlobalValue::LinkOnceODRLinkage, NewFT);
 643       if (getInstrumentedABI() == IA_TLS)
 644         NewF->removeAttributes(AttributeSet::FunctionIndex, ReadOnlyNoneAttrs);
 645
 646       Value *WrappedFnCst =
 647           ConstantExpr::getBitCast(NewF, PointerType::getUnqual(FT));
 648       F.replaceAllUsesWith(WrappedFnCst);
 649       UnwrappedFnMap[WrappedFnCst] = &F;
 650       *i = NewF;
 651
 652       if (!F.isDeclaration()) {
 653         // This function is probably defining an interposition of an
 654         // uninstrumented function and hence needs to keep the original ABI.
 655         // But any functions it may call need to use the instrumented ABI, so
 656         // we instrument it in a mode which preserves the original ABI.
 657         FnsWithNativeABI.insert(&F);
 658
 659         // This code needs to rebuild the iterators, as they may be invalidated
 660         // by the push_back, taking care that the new range does not include
 661         // any functions added by this code.
 662         size_t N = i - FnsToInstrument.begin(),
 663                Count = e - FnsToInstrument.begin();
 664         FnsToInstrument.push_back(&F);
 665         i = FnsToInstrument.begin() + N;
 666         e = FnsToInstrument.begin() + Count;
 667       }
 668     }
 669   }
 670
 671   for (std::vector<Function *>::iterator i = FnsToInstrument.begin(),
 672                                          e = FnsToInstrument.end();
 673        i != e; ++i) {
 674     if (!*i || (*i)->isDeclaration())
 675       continue;
 676
 677     removeUnreachableBlocks(**i);
 678
 679     DFSanFunction DFSF(*this, *i, FnsWithNativeABI.count(*i));
 680
 681     // DFSanVisitor may create new basic blocks, which confuses df_iterator.
 682     // Build a copy of the list before iterating over it.
 683     llvm::SmallVector<BasicBlock *, 4> BBList;
 684     std::copy(df_begin(&(*i)->getEntryBlock()), df_end(&(*i)->getEntryBlock()),
 685               std::back_inserter(BBList));
 686
 687     for (llvm::SmallVector<BasicBlock *, 4>::iterator i = BBList.begin(),
 688                                                       e = BBList.end();
 689          i != e; ++i) {
 690       Instruction *Inst = &(*i)->front();
 691       while (1) {
 692         // DFSanVisitor may split the current basic block, changing the current
 693         // instruction's next pointer and moving the next instruction to the
 694         // tail block from which we should continue.
 695         Instruction *Next = Inst->getNextNode();
 696         // DFSanVisitor may delete Inst, so keep track of whether it was a
 697         // terminator.
 698         bool IsTerminator = isa<TerminatorInst>(Inst);
 699         if (!DFSF.SkipInsts.count(Inst))
 700           DFSanVisitor(DFSF).visit(Inst);
 701         if (IsTerminator)
 702           break;
 703         Inst = Next;
 704       }
 705     }
 706
 707     // We will not necessarily be able to compute the shadow for every phi node
 708     // until we have visited every block.  Therefore, the code that handles phi
 709     // nodes adds them to the PHIFixups list so that they can be properly
 710     // handled here.
 711     for (std::vector<std::pair<PHINode *, PHINode *> >::iterator
 712              i = DFSF.PHIFixups.begin(),
 713              e = DFSF.PHIFixups.end();
 714          i != e; ++i) {
 715       for (unsigned val = 0, n = i->first->getNumIncomingValues(); val != n;
 716            ++val) {
 717         i->second->setIncomingValue(
 718             val, DFSF.getShadow(i->first->getIncomingValue(val)));
 719       }
 720     }
 721
 722     // -dfsan-debug-nonzero-labels will split the CFG in all kinds of crazy
 723     // places (i.e. instructions in basic blocks we haven't even begun visiting
 724     // yet).  To make our life easier, do this work in a pass after the main
 725     // instrumentation.
 726     if (ClDebugNonzeroLabels) {
 727       for (DenseSet<Value *>::iterator i = DFSF.NonZeroChecks.begin(),
 728                                        e = DFSF.NonZeroChecks.end();
 729            i != e; ++i) {
 730         Instruction *Pos;
 731         if (Instruction *I = dyn_cast<Instruction>(*i))
 732           Pos = I->getNextNode();
 733         else
 734           Pos = DFSF.F->getEntryBlock().begin();
 735         while (isa<PHINode>(Pos) || isa<AllocaInst>(Pos))
 736           Pos = Pos->getNextNode();
 737         IRBuilder<> IRB(Pos);
 738         Instruction *NeInst = cast<Instruction>(
 739             IRB.CreateICmpNE(*i, DFSF.DFS.ZeroShadow));
 740         BranchInst *BI = cast<BranchInst>(SplitBlockAndInsertIfThen(
 741             NeInst, /*Unreachable=*/ false, ColdCallWeights));
 742         IRBuilder<> ThenIRB(BI);
 743         ThenIRB.CreateCall(DFSF.DFS.DFSanNonzeroLabelFn);
 744       }
 745     }
 746   }
 747
 748   return false;
 749 }
 750
 751 Value *DFSanFunction::getArgTLSPtr() {
 752   if (ArgTLSPtr)
 753     return ArgTLSPtr;
 754   if (DFS.ArgTLS)
 755     return ArgTLSPtr = DFS.ArgTLS;
 756
 757   IRBuilder<> IRB(F->getEntryBlock().begin());
 758   return ArgTLSPtr = IRB.CreateCall(DFS.GetArgTLS);
 759 }
 760
 761 Value *DFSanFunction::getRetvalTLS() {
 762   if (RetvalTLSPtr)
 763     return RetvalTLSPtr;
 764   if (DFS.RetvalTLS)
 765     return RetvalTLSPtr = DFS.RetvalTLS;
 766
 767   IRBuilder<> IRB(F->getEntryBlock().begin());
 768   return RetvalTLSPtr = IRB.CreateCall(DFS.GetRetvalTLS);
 769 }
 770
 771 Value *DFSanFunction::getArgTLS(unsigned Idx, Instruction *Pos) {
 772   IRBuilder<> IRB(Pos);
 773   return IRB.CreateConstGEP2_64(getArgTLSPtr(), 0, Idx);
 774 }
 775
 776 Value *DFSanFunction::getShadow(Value *V) {
 777   if (!isa<Argument>(V) && !isa<Instruction>(V))
 778     return DFS.ZeroShadow;
 779   Value *&Shadow = ValShadowMap[V];
 780   if (!Shadow) {
 781     if (Argument *A = dyn_cast<Argument>(V)) {
 782       if (IsNativeABI)
 783         return DFS.ZeroShadow;
 784       switch (IA) {
 785       case DataFlowSanitizer::IA_TLS: {
 786         Value *ArgTLSPtr = getArgTLSPtr();
 787         Instruction *ArgTLSPos =
 788             DFS.ArgTLS ? &*F->getEntryBlock().begin()
 789                        : cast<Instruction>(ArgTLSPtr)->getNextNode();
 790         IRBuilder<> IRB(ArgTLSPos);
 791         Shadow = IRB.CreateLoad(getArgTLS(A->getArgNo(), ArgTLSPos));
 792         break;
 793       }
 794       case DataFlowSanitizer::IA_Args: {
 795         unsigned ArgIdx = A->getArgNo() + F->getArgumentList().size() / 2;
 796         Function::arg_iterator i = F->arg_begin();
 797         while (ArgIdx--)
 798           ++i;
 799         Shadow = i;
 800         assert(Shadow->getType() == DFS.ShadowTy);
 801         break;
 802       }
 803       }
 804       NonZeroChecks.insert(Shadow);
 805     } else {
 806       Shadow = DFS.ZeroShadow;
 807     }
 808   }
 809   return Shadow;
 810 }
 811
 812 void DFSanFunction::setShadow(Instruction *I, Value *Shadow) {
 813   assert(!ValShadowMap.count(I));
 814   assert(Shadow->getType() == DFS.ShadowTy);
 815   ValShadowMap[I] = Shadow;
 816 }
 817
 818 Value *DataFlowSanitizer::getShadowAddress(Value *Addr, Instruction *Pos) {
 819   assert(Addr != RetvalTLS && "Reinstrumenting?");
 820   IRBuilder<> IRB(Pos);
 821   return IRB.CreateIntToPtr(
 822       IRB.CreateMul(
 823           IRB.CreateAnd(IRB.CreatePtrToInt(Addr, IntptrTy), ShadowPtrMask),
 824           ShadowPtrMul),
 825       ShadowPtrTy);
 826 }
 827
 828 // Generates IR to compute the union of the two given shadows, inserting it
 829 // before Pos.  Returns the computed union Value.
 830 Value *DataFlowSanitizer::combineShadows(Value *V1, Value *V2,
 831                                          Instruction *Pos) {
 832   if (V1 == ZeroShadow)
 833     return V2;
 834   if (V2 == ZeroShadow)
 835     return V1;
 836   if (V1 == V2)
 837     return V1;
 838   IRBuilder<> IRB(Pos);
 839   BasicBlock *Head = Pos->getParent();
 840   Value *Ne = IRB.CreateICmpNE(V1, V2);
 841   Instruction *NeInst = dyn_cast<Instruction>(Ne);
 842   if (NeInst) {
 843     BranchInst *BI = cast<BranchInst>(SplitBlockAndInsertIfThen(
 844         NeInst, /*Unreachable=*/ false, ColdCallWeights));
 845     IRBuilder<> ThenIRB(BI);
 846     CallInst *Call = ThenIRB.CreateCall2(DFSanUnionFn, V1, V2);
 847     Call->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
 848     Call->addAttribute(1, Attribute::ZExt);
 849     Call->addAttribute(2, Attribute::ZExt);
 850
 851     BasicBlock *Tail = BI->getSuccessor(0);
 852     PHINode *Phi = PHINode::Create(ShadowTy, 2, "", Tail->begin());
 853     Phi->addIncoming(Call, Call->getParent());
 854     Phi->addIncoming(V1, Head);
 855     Pos = Phi;
 856     return Phi;
 857   } else {
 858     assert(0 && "todo");
 859     return 0;
 860   }
 861 }
 862
 863 // A convenience function which folds the shadows of each of the operands
 864 // of the provided instruction Inst, inserting the IR before Inst.  Returns
 865 // the computed union Value.
 866 Value *DFSanFunction::combineOperandShadows(Instruction *Inst) {
 867   if (Inst->getNumOperands() == 0)
 868     return DFS.ZeroShadow;
 869
 870   Value *Shadow = getShadow(Inst->getOperand(0));
 871   for (unsigned i = 1, n = Inst->getNumOperands(); i != n; ++i) {
 872     Shadow = DFS.combineShadows(Shadow, getShadow(Inst->getOperand(i)), Inst);
 873   }
 874   return Shadow;
 875 }
 876
 877 void DFSanVisitor::visitOperandShadowInst(Instruction &I) {
 878   Value *CombinedShadow = DFSF.combineOperandShadows(&I);
 879   DFSF.setShadow(&I, CombinedShadow);
 880 }
 881
 882 // Generates IR to load shadow corresponding to bytes [Addr, Addr+Size), where
 883 // Addr has alignment Align, and take the union of each of those shadows.
 884 Value *DFSanFunction::loadShadow(Value *Addr, uint64_t Size, uint64_t Align,
 885                                  Instruction *Pos) {
 886   if (AllocaInst *AI = dyn_cast<AllocaInst>(Addr)) {
 887     llvm::DenseMap<AllocaInst *, AllocaInst *>::iterator i =
 888         AllocaShadowMap.find(AI);
 889     if (i != AllocaShadowMap.end()) {
 890       IRBuilder<> IRB(Pos);
 891       return IRB.CreateLoad(i->second);
 892     }
 893   }
 894
 895   uint64_t ShadowAlign = Align * DFS.ShadowWidth / 8;
 896   SmallVector<Value *, 2> Objs;
 897   GetUnderlyingObjects(Addr, Objs, DFS.DL);
 898   bool AllConstants = true;
 899   for (SmallVector<Value *, 2>::iterator i = Objs.begin(), e = Objs.end();
 900        i != e; ++i) {
 901     if (isa<Function>(*i) || isa<BlockAddress>(*i))
 902       continue;
 903     if (isa<GlobalVariable>(*i) && cast<GlobalVariable>(*i)->isConstant())
 904       continue;
 905
 906     AllConstants = false;
 907     break;
 908   }
 909   if (AllConstants)
 910     return DFS.ZeroShadow;
 911
 912   Value *ShadowAddr = DFS.getShadowAddress(Addr, Pos);
 913   switch (Size) {
 914   case 0:
 915     return DFS.ZeroShadow;
 916   case 1: {
 917     LoadInst *LI = new LoadInst(ShadowAddr, "", Pos);
 918     LI->setAlignment(ShadowAlign);
 919     return LI;
 920   }
 921   case 2: {
 922     IRBuilder<> IRB(Pos);
 923     Value *ShadowAddr1 =
 924         IRB.CreateGEP(ShadowAddr, ConstantInt::get(DFS.IntptrTy, 1));
 925     return DFS.combineShadows(IRB.CreateAlignedLoad(ShadowAddr, ShadowAlign),
 926                               IRB.CreateAlignedLoad(ShadowAddr1, ShadowAlign),
 927                               Pos);
 928   }
 929   }
 930   if (Size % (64 / DFS.ShadowWidth) == 0) {
 931     // Fast path for the common case where each byte has identical shadow: load
 932     // shadow 64 bits at a time, fall out to a __dfsan_union_load call if any
 933     // shadow is non-equal.
 934     BasicBlock *FallbackBB = BasicBlock::Create(*DFS.Ctx, "", F);
 935     IRBuilder<> FallbackIRB(FallbackBB);
 936     CallInst *FallbackCall = FallbackIRB.CreateCall2(
 937         DFS.DFSanUnionLoadFn, ShadowAddr, ConstantInt::get(DFS.IntptrTy, Size));
 938     FallbackCall->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
 939
 940     // Compare each of the shadows stored in the loaded 64 bits to each other,
 941     // by computing (WideShadow rotl ShadowWidth) == WideShadow.
 942     IRBuilder<> IRB(Pos);
 943     Value *WideAddr =
 944         IRB.CreateBitCast(ShadowAddr, Type::getInt64PtrTy(*DFS.Ctx));
 945     Value *WideShadow = IRB.CreateAlignedLoad(WideAddr, ShadowAlign);
 946     Value *TruncShadow = IRB.CreateTrunc(WideShadow, DFS.ShadowTy);
 947     Value *ShlShadow = IRB.CreateShl(WideShadow, DFS.ShadowWidth);
 948     Value *ShrShadow = IRB.CreateLShr(WideShadow, 64 - DFS.ShadowWidth);
 949     Value *RotShadow = IRB.CreateOr(ShlShadow, ShrShadow);
 950     Value *ShadowsEq = IRB.CreateICmpEQ(WideShadow, RotShadow);
 951
 952     BasicBlock *Head = Pos->getParent();
 953     BasicBlock *Tail = Head->splitBasicBlock(Pos);
 954     // In the following code LastBr will refer to the previous basic block's
 955     // conditional branch instruction, whose true successor is fixed up to point
 956     // to the next block during the loop below or to the tail after the final
 957     // iteration.
 958     BranchInst *LastBr = BranchInst::Create(FallbackBB, FallbackBB, ShadowsEq);
 959     ReplaceInstWithInst(Head->getTerminator(), LastBr);
 960
 961     for (uint64_t Ofs = 64 / DFS.ShadowWidth; Ofs != Size;
 962          Ofs += 64 / DFS.ShadowWidth) {
 963       BasicBlock *NextBB = BasicBlock::Create(*DFS.Ctx, "", F);
 964       IRBuilder<> NextIRB(NextBB);
 965       WideAddr = NextIRB.CreateGEP(WideAddr, ConstantInt::get(DFS.IntptrTy, 1));
 966       Value *NextWideShadow = NextIRB.CreateAlignedLoad(WideAddr, ShadowAlign);
 967       ShadowsEq = NextIRB.CreateICmpEQ(WideShadow, NextWideShadow);
 968       LastBr->setSuccessor(0, NextBB);
 969       LastBr = NextIRB.CreateCondBr(ShadowsEq, FallbackBB, FallbackBB);
 970     }
 971
 972     LastBr->setSuccessor(0, Tail);
 973     FallbackIRB.CreateBr(Tail);
 974     PHINode *Shadow = PHINode::Create(DFS.ShadowTy, 2, "", &Tail->front());
 975     Shadow->addIncoming(FallbackCall, FallbackBB);
 976     Shadow->addIncoming(TruncShadow, LastBr->getParent());
 977     return Shadow;
 978   }
 979
 980   IRBuilder<> IRB(Pos);
 981   CallInst *FallbackCall = IRB.CreateCall2(
 982       DFS.DFSanUnionLoadFn, ShadowAddr, ConstantInt::get(DFS.IntptrTy, Size));
 983   FallbackCall->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
 984   return FallbackCall;
 985 }
 986
 987 void DFSanVisitor::visitLoadInst(LoadInst &LI) {
 988   uint64_t Size = DFSF.DFS.DL->getTypeStoreSize(LI.getType());
 989   uint64_t Align;
 990   if (ClPreserveAlignment) {
 991     Align = LI.getAlignment();
 992     if (Align == 0)
 993       Align = DFSF.DFS.DL->getABITypeAlignment(LI.getType());
 994   } else {
 995     Align = 1;
 996   }
 997   IRBuilder<> IRB(&LI);
 998   Value *Shadow = DFSF.loadShadow(LI.getPointerOperand(), Size, Align, &LI);
 999   if (ClCombinePointerLabelsOnLoad) {
1000     Value *PtrShadow = DFSF.getShadow(LI.getPointerOperand());
1001     Shadow = DFSF.DFS.combineShadows(Shadow, PtrShadow, &LI);
1002   }
1003   if (Shadow != DFSF.DFS.ZeroShadow)
1004     DFSF.NonZeroChecks.insert(Shadow);
1005
1006   DFSF.setShadow(&LI, Shadow);
1007 }
1008
1009 void DFSanFunction::storeShadow(Value *Addr, uint64_t Size, uint64_t Align,
1010                                 Value *Shadow, Instruction *Pos) {
1011   if (AllocaInst *AI = dyn_cast<AllocaInst>(Addr)) {
1012     llvm::DenseMap<AllocaInst *, AllocaInst *>::iterator i =
1013         AllocaShadowMap.find(AI);
1014     if (i != AllocaShadowMap.end()) {
1015       IRBuilder<> IRB(Pos);
1016       IRB.CreateStore(Shadow, i->second);
1017       return;
1018     }
1019   }
1020
1021   uint64_t ShadowAlign = Align * DFS.ShadowWidth / 8;
1022   IRBuilder<> IRB(Pos);
1023   Value *ShadowAddr = DFS.getShadowAddress(Addr, Pos);
1024   if (Shadow == DFS.ZeroShadow) {
1025     IntegerType *ShadowTy = IntegerType::get(*DFS.Ctx, Size * DFS.ShadowWidth);
1026     Value *ExtZeroShadow = ConstantInt::get(ShadowTy, 0);
1027     Value *ExtShadowAddr =
1028         IRB.CreateBitCast(ShadowAddr, PointerType::getUnqual(ShadowTy));
1029     IRB.CreateAlignedStore(ExtZeroShadow, ExtShadowAddr, ShadowAlign);
1030     return;
1031   }
1032
1033   const unsigned ShadowVecSize = 128 / DFS.ShadowWidth;
1034   uint64_t Offset = 0;
1035   if (Size >= ShadowVecSize) {
1036     VectorType *ShadowVecTy = VectorType::get(DFS.ShadowTy, ShadowVecSize);
1037     Value *ShadowVec = UndefValue::get(ShadowVecTy);
1038     for (unsigned i = 0; i != ShadowVecSize; ++i) {
1039       ShadowVec = IRB.CreateInsertElement(
1040           ShadowVec, Shadow, ConstantInt::get(Type::getInt32Ty(*DFS.Ctx), i));
1041     }
1042     Value *ShadowVecAddr =
1043         IRB.CreateBitCast(ShadowAddr, PointerType::getUnqual(ShadowVecTy));
1044     do {
1045       Value *CurShadowVecAddr = IRB.CreateConstGEP1_32(ShadowVecAddr, Offset);
1046       IRB.CreateAlignedStore(ShadowVec, CurShadowVecAddr, ShadowAlign);
1047       Size -= ShadowVecSize;
1048       ++Offset;
1049     } while (Size >= ShadowVecSize);
1050     Offset *= ShadowVecSize;
1051   }
1052   while (Size > 0) {
1053     Value *CurShadowAddr = IRB.CreateConstGEP1_32(ShadowAddr, Offset);
1054     IRB.CreateAlignedStore(Shadow, CurShadowAddr, ShadowAlign);
1055     --Size;
1056     ++Offset;
1057   }
1058 }
1059
1060 void DFSanVisitor::visitStoreInst(StoreInst &SI) {
1061   uint64_t Size =
1062       DFSF.DFS.DL->getTypeStoreSize(SI.getValueOperand()->getType());
1063   uint64_t Align;
1064   if (ClPreserveAlignment) {
1065     Align = SI.getAlignment();
1066     if (Align == 0)
1067       Align = DFSF.DFS.DL->getABITypeAlignment(SI.getValueOperand()->getType());
1068   } else {
1069     Align = 1;
1070   }
1071
1072   Value* Shadow = DFSF.getShadow(SI.getValueOperand());
1073   if (ClCombinePointerLabelsOnStore) {
1074     Value *PtrShadow = DFSF.getShadow(SI.getPointerOperand());
1075     Shadow = DFSF.DFS.combineShadows(Shadow, PtrShadow, &SI);
1076   }
1077   DFSF.storeShadow(SI.getPointerOperand(), Size, Align, Shadow, &SI);
1078 }
1079
1080 void DFSanVisitor::visitBinaryOperator(BinaryOperator &BO) {
1081   visitOperandShadowInst(BO);
1082 }
1083
1084 void DFSanVisitor::visitCastInst(CastInst &CI) { visitOperandShadowInst(CI); }
1085
1086 void DFSanVisitor::visitCmpInst(CmpInst &CI) { visitOperandShadowInst(CI); }
1087
1088 void DFSanVisitor::visitGetElementPtrInst(GetElementPtrInst &GEPI) {
1089   visitOperandShadowInst(GEPI);
1090 }
1091
1092 void DFSanVisitor::visitExtractElementInst(ExtractElementInst &I) {
1093   visitOperandShadowInst(I);
1094 }
1095
1096 void DFSanVisitor::visitInsertElementInst(InsertElementInst &I) {
1097   visitOperandShadowInst(I);
1098 }
1099
1100 void DFSanVisitor::visitShuffleVectorInst(ShuffleVectorInst &I) {
1101   visitOperandShadowInst(I);
1102 }
1103
1104 void DFSanVisitor::visitExtractValueInst(ExtractValueInst &I) {
1105   visitOperandShadowInst(I);
1106 }
1107
1108 void DFSanVisitor::visitInsertValueInst(InsertValueInst &I) {
1109   visitOperandShadowInst(I);
1110 }
1111
1112 void DFSanVisitor::visitAllocaInst(AllocaInst &I) {
1113   bool AllLoadsStores = true;
1114   for (Instruction::use_iterator i = I.use_begin(), e = I.use_end(); i != e;
1115        ++i) {
1116     if (isa<LoadInst>(*i))
1117       continue;
1118
1119     if (StoreInst *SI = dyn_cast<StoreInst>(*i)) {
1120       if (SI->getPointerOperand() == &I)
1121         continue;
1122     }
1123
1124     AllLoadsStores = false;
1125     break;
1126   }
1127   if (AllLoadsStores) {
1128     IRBuilder<> IRB(&I);
1129     DFSF.AllocaShadowMap[&I] = IRB.CreateAlloca(DFSF.DFS.ShadowTy);
1130   }
1131   DFSF.setShadow(&I, DFSF.DFS.ZeroShadow);
1132 }
1133
1134 void DFSanVisitor::visitSelectInst(SelectInst &I) {
1135   Value *CondShadow = DFSF.getShadow(I.getCondition());
1136   Value *TrueShadow = DFSF.getShadow(I.getTrueValue());
1137   Value *FalseShadow = DFSF.getShadow(I.getFalseValue());
1138
1139   if (isa<VectorType>(I.getCondition()->getType())) {
1140     DFSF.setShadow(
1141         &I, DFSF.DFS.combineShadows(
1142                 CondShadow,
1143                 DFSF.DFS.combineShadows(TrueShadow, FalseShadow, &I), &I));
1144   } else {
1145     Value *ShadowSel;
1146     if (TrueShadow == FalseShadow) {
1147       ShadowSel = TrueShadow;
1148     } else {
1149       ShadowSel =
1150           SelectInst::Create(I.getCondition(), TrueShadow, FalseShadow, "", &I);
1151     }
1152     DFSF.setShadow(&I, DFSF.DFS.combineShadows(CondShadow, ShadowSel, &I));
1153   }
1154 }
1155
1156 void DFSanVisitor::visitMemSetInst(MemSetInst &I) {
1157   IRBuilder<> IRB(&I);
1158   Value *ValShadow = DFSF.getShadow(I.getValue());
1159   IRB.CreateCall3(
1160       DFSF.DFS.DFSanSetLabelFn, ValShadow,
1161       IRB.CreateBitCast(I.getDest(), Type::getInt8PtrTy(*DFSF.DFS.Ctx)),
1162       IRB.CreateZExtOrTrunc(I.getLength(), DFSF.DFS.IntptrTy));
1163 }
1164
1165 void DFSanVisitor::visitMemTransferInst(MemTransferInst &I) {
1166   IRBuilder<> IRB(&I);
1167   Value *DestShadow = DFSF.DFS.getShadowAddress(I.getDest(), &I);
1168   Value *SrcShadow = DFSF.DFS.getShadowAddress(I.getSource(), &I);
1169   Value *LenShadow = IRB.CreateMul(
1170       I.getLength(),
1171       ConstantInt::get(I.getLength()->getType(), DFSF.DFS.ShadowWidth / 8));
1172   Value *AlignShadow;
1173   if (ClPreserveAlignment) {
1174     AlignShadow = IRB.CreateMul(I.getAlignmentCst(),
1175                                 ConstantInt::get(I.getAlignmentCst()->getType(),
1176                                                  DFSF.DFS.ShadowWidth / 8));
1177   } else {
1178     AlignShadow = ConstantInt::get(I.getAlignmentCst()->getType(),
1179                                    DFSF.DFS.ShadowWidth / 8);
1180   }
1181   Type *Int8Ptr = Type::getInt8PtrTy(*DFSF.DFS.Ctx);
1182   DestShadow = IRB.CreateBitCast(DestShadow, Int8Ptr);
1183   SrcShadow = IRB.CreateBitCast(SrcShadow, Int8Ptr);
1184   IRB.CreateCall5(I.getCalledValue(), DestShadow, SrcShadow, LenShadow,
1185                   AlignShadow, I.getVolatileCst());
1186 }
1187
1188 void DFSanVisitor::visitReturnInst(ReturnInst &RI) {
1189   if (!DFSF.IsNativeABI && RI.getReturnValue()) {
1190     switch (DFSF.IA) {
1191     case DataFlowSanitizer::IA_TLS: {
1192       Value *S = DFSF.getShadow(RI.getReturnValue());
1193       IRBuilder<> IRB(&RI);
1194       IRB.CreateStore(S, DFSF.getRetvalTLS());
1195       break;
1196     }
1197     case DataFlowSanitizer::IA_Args: {
1198       IRBuilder<> IRB(&RI);
1199       Type *RT = DFSF.F->getFunctionType()->getReturnType();
1200       Value *InsVal =
1201           IRB.CreateInsertValue(UndefValue::get(RT), RI.getReturnValue(), 0);
1202       Value *InsShadow =
1203           IRB.CreateInsertValue(InsVal, DFSF.getShadow(RI.getReturnValue()), 1);
1204       RI.setOperand(0, InsShadow);
1205       break;
1206     }
1207     }
1208   }
1209 }
1210
1211 void DFSanVisitor::visitCallSite(CallSite CS) {
1212   Function *F = CS.getCalledFunction();
1213   if ((F && F->isIntrinsic()) || isa<InlineAsm>(CS.getCalledValue())) {
1214     visitOperandShadowInst(*CS.getInstruction());
1215     return;
1216   }
1217
1218   IRBuilder<> IRB(CS.getInstruction());
1219
1220   DenseMap<Value *, Function *>::iterator i =
1221       DFSF.DFS.UnwrappedFnMap.find(CS.getCalledValue());
1222   if (i != DFSF.DFS.UnwrappedFnMap.end()) {
1223     Function *F = i->second;
1224     switch (DFSF.DFS.getWrapperKind(F)) {
1225     case DataFlowSanitizer::WK_Warning: {
1226       CS.setCalledFunction(F);
1227       IRB.CreateCall(DFSF.DFS.DFSanUnimplementedFn,
1228                      IRB.CreateGlobalStringPtr(F->getName()));
1229       DFSF.setShadow(CS.getInstruction(), DFSF.DFS.ZeroShadow);
1230       return;
1231     }
1232     case DataFlowSanitizer::WK_Discard: {
1233       CS.setCalledFunction(F);
1234       DFSF.setShadow(CS.getInstruction(), DFSF.DFS.ZeroShadow);
1235       return;
1236     }
1237     case DataFlowSanitizer::WK_Functional: {
1238       CS.setCalledFunction(F);
1239       visitOperandShadowInst(*CS.getInstruction());
1240       return;
1241     }
1242     case DataFlowSanitizer::WK_Custom: {
1243       // Don't try to handle invokes of custom functions, it's too complicated.
1244       // Instead, invoke the dfsw$ wrapper, which will in turn call the __dfsw_
1245       // wrapper.
1246       if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction())) {
1247         FunctionType *FT = F->getFunctionType();
1248         FunctionType *CustomFT = DFSF.DFS.getCustomFunctionType(FT);
1249         std::string CustomFName = "__dfsw_";
1250         CustomFName += F->getName();
1251         Constant *CustomF =
1252             DFSF.DFS.Mod->getOrInsertFunction(CustomFName, CustomFT);
1253         if (Function *CustomFn = dyn_cast<Function>(CustomF)) {
1254           CustomFn->copyAttributesFrom(F);
1255
1256           // Custom functions returning non-void will write to the return label.
1257           if (!FT->getReturnType()->isVoidTy()) {
1258             CustomFn->removeAttributes(AttributeSet::FunctionIndex,
1259                                        DFSF.DFS.ReadOnlyNoneAttrs);
1260           }
1261         }
1262
1263         std::vector<Value *> Args;
1264
1265         CallSite::arg_iterator i = CS.arg_begin();
1266         for (unsigned n = FT->getNumParams(); n != 0; ++i, --n) {
1267           Type *T = (*i)->getType();
1268           FunctionType *ParamFT;
1269           if (isa<PointerType>(T) &&
1270               (ParamFT = dyn_cast<FunctionType>(
1271                    cast<PointerType>(T)->getElementType()))) {
1272             std::string TName = "dfst";
1273             TName += utostr(FT->getNumParams() - n);
1274             TName += "$";
1275             TName += F->getName();
1276             Constant *T = DFSF.DFS.getOrBuildTrampolineFunction(ParamFT, TName);
1277             Args.push_back(T);
1278             Args.push_back(
1279                 IRB.CreateBitCast(*i, Type::getInt8PtrTy(*DFSF.DFS.Ctx)));
1280           } else {
1281             Args.push_back(*i);
1282           }
1283         }
1284
1285         i = CS.arg_begin();
1286         for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1287           Args.push_back(DFSF.getShadow(*i));
1288
1289         if (!FT->getReturnType()->isVoidTy()) {
1290           if (!DFSF.LabelReturnAlloca) {
1291             DFSF.LabelReturnAlloca =
1292                 new AllocaInst(DFSF.DFS.ShadowTy, "labelreturn",
1293                                DFSF.F->getEntryBlock().begin());
1294           }
1295           Args.push_back(DFSF.LabelReturnAlloca);
1296         }
1297
1298         CallInst *CustomCI = IRB.CreateCall(CustomF, Args);
1299         CustomCI->setCallingConv(CI->getCallingConv());
1300         CustomCI->setAttributes(CI->getAttributes());
1301
1302         if (!FT->getReturnType()->isVoidTy()) {
1303           LoadInst *LabelLoad = IRB.CreateLoad(DFSF.LabelReturnAlloca);
1304           DFSF.setShadow(CustomCI, LabelLoad);
1305         }
1306
1307         CI->replaceAllUsesWith(CustomCI);
1308         CI->eraseFromParent();
1309         return;
1310       }
1311       break;
1312     }
1313     }
1314   }
1315
1316   FunctionType *FT = cast<FunctionType>(
1317       CS.getCalledValue()->getType()->getPointerElementType());
1318   if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_TLS) {
1319     for (unsigned i = 0, n = FT->getNumParams(); i != n; ++i) {
1320       IRB.CreateStore(DFSF.getShadow(CS.getArgument(i)),
1321                       DFSF.getArgTLS(i, CS.getInstruction()));
1322     }
1323   }
1324
1325   Instruction *Next = 0;
1326   if (!CS.getType()->isVoidTy()) {
1327     if (InvokeInst *II = dyn_cast<InvokeInst>(CS.getInstruction())) {
1328       if (II->getNormalDest()->getSinglePredecessor()) {
1329         Next = II->getNormalDest()->begin();
1330       } else {
1331         BasicBlock *NewBB =
1332             SplitEdge(II->getParent(), II->getNormalDest(), &DFSF.DFS);
1333         Next = NewBB->begin();
1334       }
1335     } else {
1336       Next = CS->getNextNode();
1337     }
1338
1339     if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_TLS) {
1340       IRBuilder<> NextIRB(Next);
1341       LoadInst *LI = NextIRB.CreateLoad(DFSF.getRetvalTLS());
1342       DFSF.SkipInsts.insert(LI);
1343       DFSF.setShadow(CS.getInstruction(), LI);
1344       DFSF.NonZeroChecks.insert(LI);
1345     }
1346   }
1347
1348   // Do all instrumentation for IA_Args down here to defer tampering with the
1349   // CFG in a way that SplitEdge may be able to detect.
1350   if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_Args) {
1351     FunctionType *NewFT = DFSF.DFS.getArgsFunctionType(FT);
1352     Value *Func =
1353         IRB.CreateBitCast(CS.getCalledValue(), PointerType::getUnqual(NewFT));
1354     std::vector<Value *> Args;
1355
1356     CallSite::arg_iterator i = CS.arg_begin(), e = CS.arg_end();
1357     for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1358       Args.push_back(*i);
1359
1360     i = CS.arg_begin();
1361     for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1362       Args.push_back(DFSF.getShadow(*i));
1363
1364     if (FT->isVarArg()) {
1365       unsigned VarArgSize = CS.arg_size() - FT->getNumParams();
1366       ArrayType *VarArgArrayTy = ArrayType::get(DFSF.DFS.ShadowTy, VarArgSize);
1367       AllocaInst *VarArgShadow =
1368           new AllocaInst(VarArgArrayTy, "", DFSF.F->getEntryBlock().begin());
1369       Args.push_back(IRB.CreateConstGEP2_32(VarArgShadow, 0, 0));
1370       for (unsigned n = 0; i != e; ++i, ++n) {
1371         IRB.CreateStore(DFSF.getShadow(*i),
1372                         IRB.CreateConstGEP2_32(VarArgShadow, 0, n));
1373         Args.push_back(*i);
1374       }
1375     }
1376
1377     CallSite NewCS;
1378     if (InvokeInst *II = dyn_cast<InvokeInst>(CS.getInstruction())) {
1379       NewCS = IRB.CreateInvoke(Func, II->getNormalDest(), II->getUnwindDest(),
1380                                Args);
1381     } else {
1382       NewCS = IRB.CreateCall(Func, Args);
1383     }
1384     NewCS.setCallingConv(CS.getCallingConv());
1385     NewCS.setAttributes(CS.getAttributes().removeAttributes(
1386         *DFSF.DFS.Ctx, AttributeSet::ReturnIndex,
1387         AttributeFuncs::typeIncompatible(NewCS.getInstruction()->getType(),
1388                                          AttributeSet::ReturnIndex)));
1389
1390     if (Next) {
1391       ExtractValueInst *ExVal =
1392           ExtractValueInst::Create(NewCS.getInstruction(), 0, "", Next);
1393       DFSF.SkipInsts.insert(ExVal);
1394       ExtractValueInst *ExShadow =
1395           ExtractValueInst::Create(NewCS.getInstruction(), 1, "", Next);
1396       DFSF.SkipInsts.insert(ExShadow);
1397       DFSF.setShadow(ExVal, ExShadow);
1398       DFSF.NonZeroChecks.insert(ExShadow);
1399
1400       CS.getInstruction()->replaceAllUsesWith(ExVal);
1401     }
1402
1403     CS.getInstruction()->eraseFromParent();
1404   }
1405 }
1406
1407 void DFSanVisitor::visitPHINode(PHINode &PN) {
1408   PHINode *ShadowPN =
1409       PHINode::Create(DFSF.DFS.ShadowTy, PN.getNumIncomingValues(), "", &PN);
1410
1411   // Give the shadow phi node valid predecessors to fool SplitEdge into working.
1412   Value *UndefShadow = UndefValue::get(DFSF.DFS.ShadowTy);
1413   for (PHINode::block_iterator i = PN.block_begin(), e = PN.block_end(); i != e;
1414        ++i) {
1415     ShadowPN->addIncoming(UndefShadow, *i);
1416   }
1417
1418   DFSF.PHIFixups.push_back(std::make_pair(&PN, ShadowPN));
1419   DFSF.setShadow(&PN, ShadowPN);
1420 }