Revert "Prevent alias from pointing to weak aliases."
[oota-llvm.git] / 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/IRBuilder.h"
54 #include "llvm/IR/InlineAsm.h"
55 #include "llvm/IR/InstVisitor.h"
56 #include "llvm/IR/LLVMContext.h"
57 #include "llvm/IR/MDBuilder.h"
58 #include "llvm/IR/Type.h"
59 #include "llvm/IR/Value.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   const 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   std::unique_ptr<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) override;
217   bool runOnModule(Module &M) override;
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   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
347   if (!DLP)
348     return false;
349   DL = &DLP->getDataLayout();
350
351   Mod = &M;
352   Ctx = &M.getContext();
353   ShadowTy = IntegerType::get(*Ctx, ShadowWidth);
354   ShadowPtrTy = PointerType::getUnqual(ShadowTy);
355   IntptrTy = DL->getIntPtrType(*Ctx);
356   ZeroShadow = ConstantInt::getSigned(ShadowTy, 0);
357   ShadowPtrMask = ConstantInt::getSigned(IntptrTy, ~0x700000000000LL);
358   ShadowPtrMul = ConstantInt::getSigned(IntptrTy, ShadowWidth / 8);
359
360   Type *DFSanUnionArgs[2] = { ShadowTy, ShadowTy };
361   DFSanUnionFnTy =
362       FunctionType::get(ShadowTy, DFSanUnionArgs, /*isVarArg=*/ false);
363   Type *DFSanUnionLoadArgs[2] = { ShadowPtrTy, IntptrTy };
364   DFSanUnionLoadFnTy =
365       FunctionType::get(ShadowTy, DFSanUnionLoadArgs, /*isVarArg=*/ false);
366   DFSanUnimplementedFnTy = FunctionType::get(
367       Type::getVoidTy(*Ctx), Type::getInt8PtrTy(*Ctx), /*isVarArg=*/false);
368   Type *DFSanSetLabelArgs[3] = { ShadowTy, Type::getInt8PtrTy(*Ctx), IntptrTy };
369   DFSanSetLabelFnTy = FunctionType::get(Type::getVoidTy(*Ctx),
370                                         DFSanSetLabelArgs, /*isVarArg=*/false);
371   DFSanNonzeroLabelFnTy = FunctionType::get(
372       Type::getVoidTy(*Ctx), ArrayRef<Type *>(), /*isVarArg=*/false);
373
374   if (GetArgTLSPtr) {
375     Type *ArgTLSTy = ArrayType::get(ShadowTy, 64);
376     ArgTLS = 0;
377     GetArgTLS = ConstantExpr::getIntToPtr(
378         ConstantInt::get(IntptrTy, uintptr_t(GetArgTLSPtr)),
379         PointerType::getUnqual(
380             FunctionType::get(PointerType::getUnqual(ArgTLSTy), (Type *)0)));
381   }
382   if (GetRetvalTLSPtr) {
383     RetvalTLS = 0;
384     GetRetvalTLS = ConstantExpr::getIntToPtr(
385         ConstantInt::get(IntptrTy, uintptr_t(GetRetvalTLSPtr)),
386         PointerType::getUnqual(
387             FunctionType::get(PointerType::getUnqual(ShadowTy), (Type *)0)));
388   }
389
390   ColdCallWeights = MDBuilder(*Ctx).createBranchWeights(1, 1000);
391   return true;
392 }
393
394 bool DataFlowSanitizer::isInstrumented(const Function *F) {
395   return !ABIList->isIn(*F, "uninstrumented");
396 }
397
398 bool DataFlowSanitizer::isInstrumented(const GlobalAlias *GA) {
399   return !ABIList->isIn(*GA, "uninstrumented");
400 }
401
402 DataFlowSanitizer::InstrumentedABI DataFlowSanitizer::getInstrumentedABI() {
403   return ClArgsABI ? IA_Args : IA_TLS;
404 }
405
406 DataFlowSanitizer::WrapperKind DataFlowSanitizer::getWrapperKind(Function *F) {
407   if (ABIList->isIn(*F, "functional"))
408     return WK_Functional;
409   if (ABIList->isIn(*F, "discard"))
410     return WK_Discard;
411   if (ABIList->isIn(*F, "custom"))
412     return WK_Custom;
413
414   return WK_Warning;
415 }
416
417 void DataFlowSanitizer::addGlobalNamePrefix(GlobalValue *GV) {
418   std::string GVName = GV->getName(), Prefix = "dfs$";
419   GV->setName(Prefix + GVName);
420
421   // Try to change the name of the function in module inline asm.  We only do
422   // this for specific asm directives, currently only ".symver", to try to avoid
423   // corrupting asm which happens to contain the symbol name as a substring.
424   // Note that the substitution for .symver assumes that the versioned symbol
425   // also has an instrumented name.
426   std::string Asm = GV->getParent()->getModuleInlineAsm();
427   std::string SearchStr = ".symver " + GVName + ",";
428   size_t Pos = Asm.find(SearchStr);
429   if (Pos != std::string::npos) {
430     Asm.replace(Pos, SearchStr.size(),
431                 ".symver " + Prefix + GVName + "," + Prefix);
432     GV->getParent()->setModuleInlineAsm(Asm);
433   }
434 }
435
436 Function *
437 DataFlowSanitizer::buildWrapperFunction(Function *F, StringRef NewFName,
438                                         GlobalValue::LinkageTypes NewFLink,
439                                         FunctionType *NewFT) {
440   FunctionType *FT = F->getFunctionType();
441   Function *NewF = Function::Create(NewFT, NewFLink, NewFName,
442                                     F->getParent());
443   NewF->copyAttributesFrom(F);
444   NewF->removeAttributes(
445       AttributeSet::ReturnIndex,
446       AttributeFuncs::typeIncompatible(NewFT->getReturnType(),
447                                        AttributeSet::ReturnIndex));
448
449   BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", NewF);
450   std::vector<Value *> Args;
451   unsigned n = FT->getNumParams();
452   for (Function::arg_iterator ai = NewF->arg_begin(); n != 0; ++ai, --n)
453     Args.push_back(&*ai);
454   CallInst *CI = CallInst::Create(F, Args, "", BB);
455   if (FT->getReturnType()->isVoidTy())
456     ReturnInst::Create(*Ctx, BB);
457   else
458     ReturnInst::Create(*Ctx, CI, BB);
459
460   return NewF;
461 }
462
463 Constant *DataFlowSanitizer::getOrBuildTrampolineFunction(FunctionType *FT,
464                                                           StringRef FName) {
465   FunctionType *FTT = getTrampolineFunctionType(FT);
466   Constant *C = Mod->getOrInsertFunction(FName, FTT);
467   Function *F = dyn_cast<Function>(C);
468   if (F && F->isDeclaration()) {
469     F->setLinkage(GlobalValue::LinkOnceODRLinkage);
470     BasicBlock *BB = BasicBlock::Create(*Ctx, "entry", F);
471     std::vector<Value *> Args;
472     Function::arg_iterator AI = F->arg_begin(); ++AI;
473     for (unsigned N = FT->getNumParams(); N != 0; ++AI, --N)
474       Args.push_back(&*AI);
475     CallInst *CI =
476         CallInst::Create(&F->getArgumentList().front(), Args, "", BB);
477     ReturnInst *RI;
478     if (FT->getReturnType()->isVoidTy())
479       RI = ReturnInst::Create(*Ctx, BB);
480     else
481       RI = ReturnInst::Create(*Ctx, CI, BB);
482
483     DFSanFunction DFSF(*this, F, /*IsNativeABI=*/true);
484     Function::arg_iterator ValAI = F->arg_begin(), ShadowAI = AI; ++ValAI;
485     for (unsigned N = FT->getNumParams(); N != 0; ++ValAI, ++ShadowAI, --N)
486       DFSF.ValShadowMap[ValAI] = ShadowAI;
487     DFSanVisitor(DFSF).visitCallInst(*CI);
488     if (!FT->getReturnType()->isVoidTy())
489       new StoreInst(DFSF.getShadow(RI->getReturnValue()),
490                     &F->getArgumentList().back(), RI);
491   }
492
493   return C;
494 }
495
496 bool DataFlowSanitizer::runOnModule(Module &M) {
497   if (!DL)
498     return false;
499
500   if (ABIList->isIn(M, "skip"))
501     return false;
502
503   if (!GetArgTLSPtr) {
504     Type *ArgTLSTy = ArrayType::get(ShadowTy, 64);
505     ArgTLS = Mod->getOrInsertGlobal("__dfsan_arg_tls", ArgTLSTy);
506     if (GlobalVariable *G = dyn_cast<GlobalVariable>(ArgTLS))
507       G->setThreadLocalMode(GlobalVariable::InitialExecTLSModel);
508   }
509   if (!GetRetvalTLSPtr) {
510     RetvalTLS = Mod->getOrInsertGlobal("__dfsan_retval_tls", ShadowTy);
511     if (GlobalVariable *G = dyn_cast<GlobalVariable>(RetvalTLS))
512       G->setThreadLocalMode(GlobalVariable::InitialExecTLSModel);
513   }
514
515   DFSanUnionFn = Mod->getOrInsertFunction("__dfsan_union", DFSanUnionFnTy);
516   if (Function *F = dyn_cast<Function>(DFSanUnionFn)) {
517     F->addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
518     F->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
519     F->addAttribute(1, Attribute::ZExt);
520     F->addAttribute(2, Attribute::ZExt);
521   }
522   DFSanUnionLoadFn =
523       Mod->getOrInsertFunction("__dfsan_union_load", DFSanUnionLoadFnTy);
524   if (Function *F = dyn_cast<Function>(DFSanUnionLoadFn)) {
525     F->addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
526     F->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
527   }
528   DFSanUnimplementedFn =
529       Mod->getOrInsertFunction("__dfsan_unimplemented", DFSanUnimplementedFnTy);
530   DFSanSetLabelFn =
531       Mod->getOrInsertFunction("__dfsan_set_label", DFSanSetLabelFnTy);
532   if (Function *F = dyn_cast<Function>(DFSanSetLabelFn)) {
533     F->addAttribute(1, Attribute::ZExt);
534   }
535   DFSanNonzeroLabelFn =
536       Mod->getOrInsertFunction("__dfsan_nonzero_label", DFSanNonzeroLabelFnTy);
537
538   std::vector<Function *> FnsToInstrument;
539   llvm::SmallPtrSet<Function *, 2> FnsWithNativeABI;
540   for (Module::iterator i = M.begin(), e = M.end(); i != e; ++i) {
541     if (!i->isIntrinsic() &&
542         i != DFSanUnionFn &&
543         i != DFSanUnionLoadFn &&
544         i != DFSanUnimplementedFn &&
545         i != DFSanSetLabelFn &&
546         i != DFSanNonzeroLabelFn)
547       FnsToInstrument.push_back(&*i);
548   }
549
550   // Give function aliases prefixes when necessary, and build wrappers where the
551   // instrumentedness is inconsistent.
552   for (Module::alias_iterator i = M.alias_begin(), e = M.alias_end(); i != e;) {
553     GlobalAlias *GA = &*i;
554     ++i;
555     // Don't stop on weak.  We assume people aren't playing games with the
556     // instrumentedness of overridden weak aliases.
557     if (Function *F = dyn_cast<Function>(
558             GA->resolveAliasedGlobal(/*stopOnWeak=*/false))) {
559       bool GAInst = isInstrumented(GA), FInst = isInstrumented(F);
560       if (GAInst && FInst) {
561         addGlobalNamePrefix(GA);
562       } else if (GAInst != FInst) {
563         // Non-instrumented alias of an instrumented function, or vice versa.
564         // Replace the alias with a native-ABI wrapper of the aliasee.  The pass
565         // below will take care of instrumenting it.
566         Function *NewF =
567             buildWrapperFunction(F, "", GA->getLinkage(), F->getFunctionType());
568         GA->replaceAllUsesWith(NewF);
569         NewF->takeName(GA);
570         GA->eraseFromParent();
571         FnsToInstrument.push_back(NewF);
572       }
573     }
574   }
575
576   AttrBuilder B;
577   B.addAttribute(Attribute::ReadOnly).addAttribute(Attribute::ReadNone);
578   ReadOnlyNoneAttrs = AttributeSet::get(*Ctx, AttributeSet::FunctionIndex, B);
579
580   // First, change the ABI of every function in the module.  ABI-listed
581   // functions keep their original ABI and get a wrapper function.
582   for (std::vector<Function *>::iterator i = FnsToInstrument.begin(),
583                                          e = FnsToInstrument.end();
584        i != e; ++i) {
585     Function &F = **i;
586     FunctionType *FT = F.getFunctionType();
587
588     bool IsZeroArgsVoidRet = (FT->getNumParams() == 0 && !FT->isVarArg() &&
589                               FT->getReturnType()->isVoidTy());
590
591     if (isInstrumented(&F)) {
592       // Instrumented functions get a 'dfs$' prefix.  This allows us to more
593       // easily identify cases of mismatching ABIs.
594       if (getInstrumentedABI() == IA_Args && !IsZeroArgsVoidRet) {
595         FunctionType *NewFT = getArgsFunctionType(FT);
596         Function *NewF = Function::Create(NewFT, F.getLinkage(), "", &M);
597         NewF->copyAttributesFrom(&F);
598         NewF->removeAttributes(
599             AttributeSet::ReturnIndex,
600             AttributeFuncs::typeIncompatible(NewFT->getReturnType(),
601                                              AttributeSet::ReturnIndex));
602         for (Function::arg_iterator FArg = F.arg_begin(),
603                                     NewFArg = NewF->arg_begin(),
604                                     FArgEnd = F.arg_end();
605              FArg != FArgEnd; ++FArg, ++NewFArg) {
606           FArg->replaceAllUsesWith(NewFArg);
607         }
608         NewF->getBasicBlockList().splice(NewF->begin(), F.getBasicBlockList());
609
610         for (Function::user_iterator UI = F.user_begin(), UE = F.user_end();
611              UI != UE;) {
612           BlockAddress *BA = dyn_cast<BlockAddress>(*UI);
613           ++UI;
614           if (BA) {
615             BA->replaceAllUsesWith(
616                 BlockAddress::get(NewF, BA->getBasicBlock()));
617             delete BA;
618           }
619         }
620         F.replaceAllUsesWith(
621             ConstantExpr::getBitCast(NewF, PointerType::getUnqual(FT)));
622         NewF->takeName(&F);
623         F.eraseFromParent();
624         *i = NewF;
625         addGlobalNamePrefix(NewF);
626       } else {
627         addGlobalNamePrefix(&F);
628       }
629                // Hopefully, nobody will try to indirectly call a vararg
630                // function... yet.
631     } else if (FT->isVarArg()) {
632       UnwrappedFnMap[&F] = &F;
633       *i = 0;
634     } else if (!IsZeroArgsVoidRet || getWrapperKind(&F) == WK_Custom) {
635       // Build a wrapper function for F.  The wrapper simply calls F, and is
636       // added to FnsToInstrument so that any instrumentation according to its
637       // WrapperKind is done in the second pass below.
638       FunctionType *NewFT = getInstrumentedABI() == IA_Args
639                                 ? getArgsFunctionType(FT)
640                                 : FT;
641       Function *NewF = buildWrapperFunction(
642           &F, std::string("dfsw$") + std::string(F.getName()),
643           GlobalValue::LinkOnceODRLinkage, NewFT);
644       if (getInstrumentedABI() == IA_TLS)
645         NewF->removeAttributes(AttributeSet::FunctionIndex, ReadOnlyNoneAttrs);
646
647       Value *WrappedFnCst =
648           ConstantExpr::getBitCast(NewF, PointerType::getUnqual(FT));
649       F.replaceAllUsesWith(WrappedFnCst);
650       UnwrappedFnMap[WrappedFnCst] = &F;
651       *i = NewF;
652
653       if (!F.isDeclaration()) {
654         // This function is probably defining an interposition of an
655         // uninstrumented function and hence needs to keep the original ABI.
656         // But any functions it may call need to use the instrumented ABI, so
657         // we instrument it in a mode which preserves the original ABI.
658         FnsWithNativeABI.insert(&F);
659
660         // This code needs to rebuild the iterators, as they may be invalidated
661         // by the push_back, taking care that the new range does not include
662         // any functions added by this code.
663         size_t N = i - FnsToInstrument.begin(),
664                Count = e - FnsToInstrument.begin();
665         FnsToInstrument.push_back(&F);
666         i = FnsToInstrument.begin() + N;
667         e = FnsToInstrument.begin() + Count;
668       }
669     }
670   }
671
672   for (std::vector<Function *>::iterator i = FnsToInstrument.begin(),
673                                          e = FnsToInstrument.end();
674        i != e; ++i) {
675     if (!*i || (*i)->isDeclaration())
676       continue;
677
678     removeUnreachableBlocks(**i);
679
680     DFSanFunction DFSF(*this, *i, FnsWithNativeABI.count(*i));
681
682     // DFSanVisitor may create new basic blocks, which confuses df_iterator.
683     // Build a copy of the list before iterating over it.
684     llvm::SmallVector<BasicBlock *, 4> BBList;
685     std::copy(df_begin(&(*i)->getEntryBlock()), df_end(&(*i)->getEntryBlock()),
686               std::back_inserter(BBList));
687
688     for (llvm::SmallVector<BasicBlock *, 4>::iterator i = BBList.begin(),
689                                                       e = BBList.end();
690          i != e; ++i) {
691       Instruction *Inst = &(*i)->front();
692       while (1) {
693         // DFSanVisitor may split the current basic block, changing the current
694         // instruction's next pointer and moving the next instruction to the
695         // tail block from which we should continue.
696         Instruction *Next = Inst->getNextNode();
697         // DFSanVisitor may delete Inst, so keep track of whether it was a
698         // terminator.
699         bool IsTerminator = isa<TerminatorInst>(Inst);
700         if (!DFSF.SkipInsts.count(Inst))
701           DFSanVisitor(DFSF).visit(Inst);
702         if (IsTerminator)
703           break;
704         Inst = Next;
705       }
706     }
707
708     // We will not necessarily be able to compute the shadow for every phi node
709     // until we have visited every block.  Therefore, the code that handles phi
710     // nodes adds them to the PHIFixups list so that they can be properly
711     // handled here.
712     for (std::vector<std::pair<PHINode *, PHINode *> >::iterator
713              i = DFSF.PHIFixups.begin(),
714              e = DFSF.PHIFixups.end();
715          i != e; ++i) {
716       for (unsigned val = 0, n = i->first->getNumIncomingValues(); val != n;
717            ++val) {
718         i->second->setIncomingValue(
719             val, DFSF.getShadow(i->first->getIncomingValue(val)));
720       }
721     }
722
723     // -dfsan-debug-nonzero-labels will split the CFG in all kinds of crazy
724     // places (i.e. instructions in basic blocks we haven't even begun visiting
725     // yet).  To make our life easier, do this work in a pass after the main
726     // instrumentation.
727     if (ClDebugNonzeroLabels) {
728       for (DenseSet<Value *>::iterator i = DFSF.NonZeroChecks.begin(),
729                                        e = DFSF.NonZeroChecks.end();
730            i != e; ++i) {
731         Instruction *Pos;
732         if (Instruction *I = dyn_cast<Instruction>(*i))
733           Pos = I->getNextNode();
734         else
735           Pos = DFSF.F->getEntryBlock().begin();
736         while (isa<PHINode>(Pos) || isa<AllocaInst>(Pos))
737           Pos = Pos->getNextNode();
738         IRBuilder<> IRB(Pos);
739         Value *Ne = IRB.CreateICmpNE(*i, DFSF.DFS.ZeroShadow);
740         BranchInst *BI = cast<BranchInst>(SplitBlockAndInsertIfThen(
741             Ne, Pos, /*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   BranchInst *BI = cast<BranchInst>(SplitBlockAndInsertIfThen(
842       Ne, Pos, /*Unreachable=*/false, ColdCallWeights));
843   IRBuilder<> ThenIRB(BI);
844   CallInst *Call = ThenIRB.CreateCall2(DFSanUnionFn, V1, V2);
845   Call->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
846   Call->addAttribute(1, Attribute::ZExt);
847   Call->addAttribute(2, Attribute::ZExt);
848
849   BasicBlock *Tail = BI->getSuccessor(0);
850   PHINode *Phi = PHINode::Create(ShadowTy, 2, "", Tail->begin());
851   Phi->addIncoming(Call, Call->getParent());
852   Phi->addIncoming(V1, Head);
853   return Phi;
854 }
855
856 // A convenience function which folds the shadows of each of the operands
857 // of the provided instruction Inst, inserting the IR before Inst.  Returns
858 // the computed union Value.
859 Value *DFSanFunction::combineOperandShadows(Instruction *Inst) {
860   if (Inst->getNumOperands() == 0)
861     return DFS.ZeroShadow;
862
863   Value *Shadow = getShadow(Inst->getOperand(0));
864   for (unsigned i = 1, n = Inst->getNumOperands(); i != n; ++i) {
865     Shadow = DFS.combineShadows(Shadow, getShadow(Inst->getOperand(i)), Inst);
866   }
867   return Shadow;
868 }
869
870 void DFSanVisitor::visitOperandShadowInst(Instruction &I) {
871   Value *CombinedShadow = DFSF.combineOperandShadows(&I);
872   DFSF.setShadow(&I, CombinedShadow);
873 }
874
875 // Generates IR to load shadow corresponding to bytes [Addr, Addr+Size), where
876 // Addr has alignment Align, and take the union of each of those shadows.
877 Value *DFSanFunction::loadShadow(Value *Addr, uint64_t Size, uint64_t Align,
878                                  Instruction *Pos) {
879   if (AllocaInst *AI = dyn_cast<AllocaInst>(Addr)) {
880     llvm::DenseMap<AllocaInst *, AllocaInst *>::iterator i =
881         AllocaShadowMap.find(AI);
882     if (i != AllocaShadowMap.end()) {
883       IRBuilder<> IRB(Pos);
884       return IRB.CreateLoad(i->second);
885     }
886   }
887
888   uint64_t ShadowAlign = Align * DFS.ShadowWidth / 8;
889   SmallVector<Value *, 2> Objs;
890   GetUnderlyingObjects(Addr, Objs, DFS.DL);
891   bool AllConstants = true;
892   for (SmallVector<Value *, 2>::iterator i = Objs.begin(), e = Objs.end();
893        i != e; ++i) {
894     if (isa<Function>(*i) || isa<BlockAddress>(*i))
895       continue;
896     if (isa<GlobalVariable>(*i) && cast<GlobalVariable>(*i)->isConstant())
897       continue;
898
899     AllConstants = false;
900     break;
901   }
902   if (AllConstants)
903     return DFS.ZeroShadow;
904
905   Value *ShadowAddr = DFS.getShadowAddress(Addr, Pos);
906   switch (Size) {
907   case 0:
908     return DFS.ZeroShadow;
909   case 1: {
910     LoadInst *LI = new LoadInst(ShadowAddr, "", Pos);
911     LI->setAlignment(ShadowAlign);
912     return LI;
913   }
914   case 2: {
915     IRBuilder<> IRB(Pos);
916     Value *ShadowAddr1 =
917         IRB.CreateGEP(ShadowAddr, ConstantInt::get(DFS.IntptrTy, 1));
918     return DFS.combineShadows(IRB.CreateAlignedLoad(ShadowAddr, ShadowAlign),
919                               IRB.CreateAlignedLoad(ShadowAddr1, ShadowAlign),
920                               Pos);
921   }
922   }
923   if (Size % (64 / DFS.ShadowWidth) == 0) {
924     // Fast path for the common case where each byte has identical shadow: load
925     // shadow 64 bits at a time, fall out to a __dfsan_union_load call if any
926     // shadow is non-equal.
927     BasicBlock *FallbackBB = BasicBlock::Create(*DFS.Ctx, "", F);
928     IRBuilder<> FallbackIRB(FallbackBB);
929     CallInst *FallbackCall = FallbackIRB.CreateCall2(
930         DFS.DFSanUnionLoadFn, ShadowAddr, ConstantInt::get(DFS.IntptrTy, Size));
931     FallbackCall->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
932
933     // Compare each of the shadows stored in the loaded 64 bits to each other,
934     // by computing (WideShadow rotl ShadowWidth) == WideShadow.
935     IRBuilder<> IRB(Pos);
936     Value *WideAddr =
937         IRB.CreateBitCast(ShadowAddr, Type::getInt64PtrTy(*DFS.Ctx));
938     Value *WideShadow = IRB.CreateAlignedLoad(WideAddr, ShadowAlign);
939     Value *TruncShadow = IRB.CreateTrunc(WideShadow, DFS.ShadowTy);
940     Value *ShlShadow = IRB.CreateShl(WideShadow, DFS.ShadowWidth);
941     Value *ShrShadow = IRB.CreateLShr(WideShadow, 64 - DFS.ShadowWidth);
942     Value *RotShadow = IRB.CreateOr(ShlShadow, ShrShadow);
943     Value *ShadowsEq = IRB.CreateICmpEQ(WideShadow, RotShadow);
944
945     BasicBlock *Head = Pos->getParent();
946     BasicBlock *Tail = Head->splitBasicBlock(Pos);
947     // In the following code LastBr will refer to the previous basic block's
948     // conditional branch instruction, whose true successor is fixed up to point
949     // to the next block during the loop below or to the tail after the final
950     // iteration.
951     BranchInst *LastBr = BranchInst::Create(FallbackBB, FallbackBB, ShadowsEq);
952     ReplaceInstWithInst(Head->getTerminator(), LastBr);
953
954     for (uint64_t Ofs = 64 / DFS.ShadowWidth; Ofs != Size;
955          Ofs += 64 / DFS.ShadowWidth) {
956       BasicBlock *NextBB = BasicBlock::Create(*DFS.Ctx, "", F);
957       IRBuilder<> NextIRB(NextBB);
958       WideAddr = NextIRB.CreateGEP(WideAddr, ConstantInt::get(DFS.IntptrTy, 1));
959       Value *NextWideShadow = NextIRB.CreateAlignedLoad(WideAddr, ShadowAlign);
960       ShadowsEq = NextIRB.CreateICmpEQ(WideShadow, NextWideShadow);
961       LastBr->setSuccessor(0, NextBB);
962       LastBr = NextIRB.CreateCondBr(ShadowsEq, FallbackBB, FallbackBB);
963     }
964
965     LastBr->setSuccessor(0, Tail);
966     FallbackIRB.CreateBr(Tail);
967     PHINode *Shadow = PHINode::Create(DFS.ShadowTy, 2, "", &Tail->front());
968     Shadow->addIncoming(FallbackCall, FallbackBB);
969     Shadow->addIncoming(TruncShadow, LastBr->getParent());
970     return Shadow;
971   }
972
973   IRBuilder<> IRB(Pos);
974   CallInst *FallbackCall = IRB.CreateCall2(
975       DFS.DFSanUnionLoadFn, ShadowAddr, ConstantInt::get(DFS.IntptrTy, Size));
976   FallbackCall->addAttribute(AttributeSet::ReturnIndex, Attribute::ZExt);
977   return FallbackCall;
978 }
979
980 void DFSanVisitor::visitLoadInst(LoadInst &LI) {
981   uint64_t Size = DFSF.DFS.DL->getTypeStoreSize(LI.getType());
982   uint64_t Align;
983   if (ClPreserveAlignment) {
984     Align = LI.getAlignment();
985     if (Align == 0)
986       Align = DFSF.DFS.DL->getABITypeAlignment(LI.getType());
987   } else {
988     Align = 1;
989   }
990   IRBuilder<> IRB(&LI);
991   Value *Shadow = DFSF.loadShadow(LI.getPointerOperand(), Size, Align, &LI);
992   if (ClCombinePointerLabelsOnLoad) {
993     Value *PtrShadow = DFSF.getShadow(LI.getPointerOperand());
994     Shadow = DFSF.DFS.combineShadows(Shadow, PtrShadow, &LI);
995   }
996   if (Shadow != DFSF.DFS.ZeroShadow)
997     DFSF.NonZeroChecks.insert(Shadow);
998
999   DFSF.setShadow(&LI, Shadow);
1000 }
1001
1002 void DFSanFunction::storeShadow(Value *Addr, uint64_t Size, uint64_t Align,
1003                                 Value *Shadow, Instruction *Pos) {
1004   if (AllocaInst *AI = dyn_cast<AllocaInst>(Addr)) {
1005     llvm::DenseMap<AllocaInst *, AllocaInst *>::iterator i =
1006         AllocaShadowMap.find(AI);
1007     if (i != AllocaShadowMap.end()) {
1008       IRBuilder<> IRB(Pos);
1009       IRB.CreateStore(Shadow, i->second);
1010       return;
1011     }
1012   }
1013
1014   uint64_t ShadowAlign = Align * DFS.ShadowWidth / 8;
1015   IRBuilder<> IRB(Pos);
1016   Value *ShadowAddr = DFS.getShadowAddress(Addr, Pos);
1017   if (Shadow == DFS.ZeroShadow) {
1018     IntegerType *ShadowTy = IntegerType::get(*DFS.Ctx, Size * DFS.ShadowWidth);
1019     Value *ExtZeroShadow = ConstantInt::get(ShadowTy, 0);
1020     Value *ExtShadowAddr =
1021         IRB.CreateBitCast(ShadowAddr, PointerType::getUnqual(ShadowTy));
1022     IRB.CreateAlignedStore(ExtZeroShadow, ExtShadowAddr, ShadowAlign);
1023     return;
1024   }
1025
1026   const unsigned ShadowVecSize = 128 / DFS.ShadowWidth;
1027   uint64_t Offset = 0;
1028   if (Size >= ShadowVecSize) {
1029     VectorType *ShadowVecTy = VectorType::get(DFS.ShadowTy, ShadowVecSize);
1030     Value *ShadowVec = UndefValue::get(ShadowVecTy);
1031     for (unsigned i = 0; i != ShadowVecSize; ++i) {
1032       ShadowVec = IRB.CreateInsertElement(
1033           ShadowVec, Shadow, ConstantInt::get(Type::getInt32Ty(*DFS.Ctx), i));
1034     }
1035     Value *ShadowVecAddr =
1036         IRB.CreateBitCast(ShadowAddr, PointerType::getUnqual(ShadowVecTy));
1037     do {
1038       Value *CurShadowVecAddr = IRB.CreateConstGEP1_32(ShadowVecAddr, Offset);
1039       IRB.CreateAlignedStore(ShadowVec, CurShadowVecAddr, ShadowAlign);
1040       Size -= ShadowVecSize;
1041       ++Offset;
1042     } while (Size >= ShadowVecSize);
1043     Offset *= ShadowVecSize;
1044   }
1045   while (Size > 0) {
1046     Value *CurShadowAddr = IRB.CreateConstGEP1_32(ShadowAddr, Offset);
1047     IRB.CreateAlignedStore(Shadow, CurShadowAddr, ShadowAlign);
1048     --Size;
1049     ++Offset;
1050   }
1051 }
1052
1053 void DFSanVisitor::visitStoreInst(StoreInst &SI) {
1054   uint64_t Size =
1055       DFSF.DFS.DL->getTypeStoreSize(SI.getValueOperand()->getType());
1056   uint64_t Align;
1057   if (ClPreserveAlignment) {
1058     Align = SI.getAlignment();
1059     if (Align == 0)
1060       Align = DFSF.DFS.DL->getABITypeAlignment(SI.getValueOperand()->getType());
1061   } else {
1062     Align = 1;
1063   }
1064
1065   Value* Shadow = DFSF.getShadow(SI.getValueOperand());
1066   if (ClCombinePointerLabelsOnStore) {
1067     Value *PtrShadow = DFSF.getShadow(SI.getPointerOperand());
1068     Shadow = DFSF.DFS.combineShadows(Shadow, PtrShadow, &SI);
1069   }
1070   DFSF.storeShadow(SI.getPointerOperand(), Size, Align, Shadow, &SI);
1071 }
1072
1073 void DFSanVisitor::visitBinaryOperator(BinaryOperator &BO) {
1074   visitOperandShadowInst(BO);
1075 }
1076
1077 void DFSanVisitor::visitCastInst(CastInst &CI) { visitOperandShadowInst(CI); }
1078
1079 void DFSanVisitor::visitCmpInst(CmpInst &CI) { visitOperandShadowInst(CI); }
1080
1081 void DFSanVisitor::visitGetElementPtrInst(GetElementPtrInst &GEPI) {
1082   visitOperandShadowInst(GEPI);
1083 }
1084
1085 void DFSanVisitor::visitExtractElementInst(ExtractElementInst &I) {
1086   visitOperandShadowInst(I);
1087 }
1088
1089 void DFSanVisitor::visitInsertElementInst(InsertElementInst &I) {
1090   visitOperandShadowInst(I);
1091 }
1092
1093 void DFSanVisitor::visitShuffleVectorInst(ShuffleVectorInst &I) {
1094   visitOperandShadowInst(I);
1095 }
1096
1097 void DFSanVisitor::visitExtractValueInst(ExtractValueInst &I) {
1098   visitOperandShadowInst(I);
1099 }
1100
1101 void DFSanVisitor::visitInsertValueInst(InsertValueInst &I) {
1102   visitOperandShadowInst(I);
1103 }
1104
1105 void DFSanVisitor::visitAllocaInst(AllocaInst &I) {
1106   bool AllLoadsStores = true;
1107   for (User *U : I.users()) {
1108     if (isa<LoadInst>(U))
1109       continue;
1110
1111     if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1112       if (SI->getPointerOperand() == &I)
1113         continue;
1114     }
1115
1116     AllLoadsStores = false;
1117     break;
1118   }
1119   if (AllLoadsStores) {
1120     IRBuilder<> IRB(&I);
1121     DFSF.AllocaShadowMap[&I] = IRB.CreateAlloca(DFSF.DFS.ShadowTy);
1122   }
1123   DFSF.setShadow(&I, DFSF.DFS.ZeroShadow);
1124 }
1125
1126 void DFSanVisitor::visitSelectInst(SelectInst &I) {
1127   Value *CondShadow = DFSF.getShadow(I.getCondition());
1128   Value *TrueShadow = DFSF.getShadow(I.getTrueValue());
1129   Value *FalseShadow = DFSF.getShadow(I.getFalseValue());
1130
1131   if (isa<VectorType>(I.getCondition()->getType())) {
1132     DFSF.setShadow(
1133         &I, DFSF.DFS.combineShadows(
1134                 CondShadow,
1135                 DFSF.DFS.combineShadows(TrueShadow, FalseShadow, &I), &I));
1136   } else {
1137     Value *ShadowSel;
1138     if (TrueShadow == FalseShadow) {
1139       ShadowSel = TrueShadow;
1140     } else {
1141       ShadowSel =
1142           SelectInst::Create(I.getCondition(), TrueShadow, FalseShadow, "", &I);
1143     }
1144     DFSF.setShadow(&I, DFSF.DFS.combineShadows(CondShadow, ShadowSel, &I));
1145   }
1146 }
1147
1148 void DFSanVisitor::visitMemSetInst(MemSetInst &I) {
1149   IRBuilder<> IRB(&I);
1150   Value *ValShadow = DFSF.getShadow(I.getValue());
1151   IRB.CreateCall3(
1152       DFSF.DFS.DFSanSetLabelFn, ValShadow,
1153       IRB.CreateBitCast(I.getDest(), Type::getInt8PtrTy(*DFSF.DFS.Ctx)),
1154       IRB.CreateZExtOrTrunc(I.getLength(), DFSF.DFS.IntptrTy));
1155 }
1156
1157 void DFSanVisitor::visitMemTransferInst(MemTransferInst &I) {
1158   IRBuilder<> IRB(&I);
1159   Value *DestShadow = DFSF.DFS.getShadowAddress(I.getDest(), &I);
1160   Value *SrcShadow = DFSF.DFS.getShadowAddress(I.getSource(), &I);
1161   Value *LenShadow = IRB.CreateMul(
1162       I.getLength(),
1163       ConstantInt::get(I.getLength()->getType(), DFSF.DFS.ShadowWidth / 8));
1164   Value *AlignShadow;
1165   if (ClPreserveAlignment) {
1166     AlignShadow = IRB.CreateMul(I.getAlignmentCst(),
1167                                 ConstantInt::get(I.getAlignmentCst()->getType(),
1168                                                  DFSF.DFS.ShadowWidth / 8));
1169   } else {
1170     AlignShadow = ConstantInt::get(I.getAlignmentCst()->getType(),
1171                                    DFSF.DFS.ShadowWidth / 8);
1172   }
1173   Type *Int8Ptr = Type::getInt8PtrTy(*DFSF.DFS.Ctx);
1174   DestShadow = IRB.CreateBitCast(DestShadow, Int8Ptr);
1175   SrcShadow = IRB.CreateBitCast(SrcShadow, Int8Ptr);
1176   IRB.CreateCall5(I.getCalledValue(), DestShadow, SrcShadow, LenShadow,
1177                   AlignShadow, I.getVolatileCst());
1178 }
1179
1180 void DFSanVisitor::visitReturnInst(ReturnInst &RI) {
1181   if (!DFSF.IsNativeABI && RI.getReturnValue()) {
1182     switch (DFSF.IA) {
1183     case DataFlowSanitizer::IA_TLS: {
1184       Value *S = DFSF.getShadow(RI.getReturnValue());
1185       IRBuilder<> IRB(&RI);
1186       IRB.CreateStore(S, DFSF.getRetvalTLS());
1187       break;
1188     }
1189     case DataFlowSanitizer::IA_Args: {
1190       IRBuilder<> IRB(&RI);
1191       Type *RT = DFSF.F->getFunctionType()->getReturnType();
1192       Value *InsVal =
1193           IRB.CreateInsertValue(UndefValue::get(RT), RI.getReturnValue(), 0);
1194       Value *InsShadow =
1195           IRB.CreateInsertValue(InsVal, DFSF.getShadow(RI.getReturnValue()), 1);
1196       RI.setOperand(0, InsShadow);
1197       break;
1198     }
1199     }
1200   }
1201 }
1202
1203 void DFSanVisitor::visitCallSite(CallSite CS) {
1204   Function *F = CS.getCalledFunction();
1205   if ((F && F->isIntrinsic()) || isa<InlineAsm>(CS.getCalledValue())) {
1206     visitOperandShadowInst(*CS.getInstruction());
1207     return;
1208   }
1209
1210   IRBuilder<> IRB(CS.getInstruction());
1211
1212   DenseMap<Value *, Function *>::iterator i =
1213       DFSF.DFS.UnwrappedFnMap.find(CS.getCalledValue());
1214   if (i != DFSF.DFS.UnwrappedFnMap.end()) {
1215     Function *F = i->second;
1216     switch (DFSF.DFS.getWrapperKind(F)) {
1217     case DataFlowSanitizer::WK_Warning: {
1218       CS.setCalledFunction(F);
1219       IRB.CreateCall(DFSF.DFS.DFSanUnimplementedFn,
1220                      IRB.CreateGlobalStringPtr(F->getName()));
1221       DFSF.setShadow(CS.getInstruction(), DFSF.DFS.ZeroShadow);
1222       return;
1223     }
1224     case DataFlowSanitizer::WK_Discard: {
1225       CS.setCalledFunction(F);
1226       DFSF.setShadow(CS.getInstruction(), DFSF.DFS.ZeroShadow);
1227       return;
1228     }
1229     case DataFlowSanitizer::WK_Functional: {
1230       CS.setCalledFunction(F);
1231       visitOperandShadowInst(*CS.getInstruction());
1232       return;
1233     }
1234     case DataFlowSanitizer::WK_Custom: {
1235       // Don't try to handle invokes of custom functions, it's too complicated.
1236       // Instead, invoke the dfsw$ wrapper, which will in turn call the __dfsw_
1237       // wrapper.
1238       if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction())) {
1239         FunctionType *FT = F->getFunctionType();
1240         FunctionType *CustomFT = DFSF.DFS.getCustomFunctionType(FT);
1241         std::string CustomFName = "__dfsw_";
1242         CustomFName += F->getName();
1243         Constant *CustomF =
1244             DFSF.DFS.Mod->getOrInsertFunction(CustomFName, CustomFT);
1245         if (Function *CustomFn = dyn_cast<Function>(CustomF)) {
1246           CustomFn->copyAttributesFrom(F);
1247
1248           // Custom functions returning non-void will write to the return label.
1249           if (!FT->getReturnType()->isVoidTy()) {
1250             CustomFn->removeAttributes(AttributeSet::FunctionIndex,
1251                                        DFSF.DFS.ReadOnlyNoneAttrs);
1252           }
1253         }
1254
1255         std::vector<Value *> Args;
1256
1257         CallSite::arg_iterator i = CS.arg_begin();
1258         for (unsigned n = FT->getNumParams(); n != 0; ++i, --n) {
1259           Type *T = (*i)->getType();
1260           FunctionType *ParamFT;
1261           if (isa<PointerType>(T) &&
1262               (ParamFT = dyn_cast<FunctionType>(
1263                    cast<PointerType>(T)->getElementType()))) {
1264             std::string TName = "dfst";
1265             TName += utostr(FT->getNumParams() - n);
1266             TName += "$";
1267             TName += F->getName();
1268             Constant *T = DFSF.DFS.getOrBuildTrampolineFunction(ParamFT, TName);
1269             Args.push_back(T);
1270             Args.push_back(
1271                 IRB.CreateBitCast(*i, Type::getInt8PtrTy(*DFSF.DFS.Ctx)));
1272           } else {
1273             Args.push_back(*i);
1274           }
1275         }
1276
1277         i = CS.arg_begin();
1278         for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1279           Args.push_back(DFSF.getShadow(*i));
1280
1281         if (!FT->getReturnType()->isVoidTy()) {
1282           if (!DFSF.LabelReturnAlloca) {
1283             DFSF.LabelReturnAlloca =
1284                 new AllocaInst(DFSF.DFS.ShadowTy, "labelreturn",
1285                                DFSF.F->getEntryBlock().begin());
1286           }
1287           Args.push_back(DFSF.LabelReturnAlloca);
1288         }
1289
1290         CallInst *CustomCI = IRB.CreateCall(CustomF, Args);
1291         CustomCI->setCallingConv(CI->getCallingConv());
1292         CustomCI->setAttributes(CI->getAttributes());
1293
1294         if (!FT->getReturnType()->isVoidTy()) {
1295           LoadInst *LabelLoad = IRB.CreateLoad(DFSF.LabelReturnAlloca);
1296           DFSF.setShadow(CustomCI, LabelLoad);
1297         }
1298
1299         CI->replaceAllUsesWith(CustomCI);
1300         CI->eraseFromParent();
1301         return;
1302       }
1303       break;
1304     }
1305     }
1306   }
1307
1308   FunctionType *FT = cast<FunctionType>(
1309       CS.getCalledValue()->getType()->getPointerElementType());
1310   if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_TLS) {
1311     for (unsigned i = 0, n = FT->getNumParams(); i != n; ++i) {
1312       IRB.CreateStore(DFSF.getShadow(CS.getArgument(i)),
1313                       DFSF.getArgTLS(i, CS.getInstruction()));
1314     }
1315   }
1316
1317   Instruction *Next = 0;
1318   if (!CS.getType()->isVoidTy()) {
1319     if (InvokeInst *II = dyn_cast<InvokeInst>(CS.getInstruction())) {
1320       if (II->getNormalDest()->getSinglePredecessor()) {
1321         Next = II->getNormalDest()->begin();
1322       } else {
1323         BasicBlock *NewBB =
1324             SplitEdge(II->getParent(), II->getNormalDest(), &DFSF.DFS);
1325         Next = NewBB->begin();
1326       }
1327     } else {
1328       Next = CS->getNextNode();
1329     }
1330
1331     if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_TLS) {
1332       IRBuilder<> NextIRB(Next);
1333       LoadInst *LI = NextIRB.CreateLoad(DFSF.getRetvalTLS());
1334       DFSF.SkipInsts.insert(LI);
1335       DFSF.setShadow(CS.getInstruction(), LI);
1336       DFSF.NonZeroChecks.insert(LI);
1337     }
1338   }
1339
1340   // Do all instrumentation for IA_Args down here to defer tampering with the
1341   // CFG in a way that SplitEdge may be able to detect.
1342   if (DFSF.DFS.getInstrumentedABI() == DataFlowSanitizer::IA_Args) {
1343     FunctionType *NewFT = DFSF.DFS.getArgsFunctionType(FT);
1344     Value *Func =
1345         IRB.CreateBitCast(CS.getCalledValue(), PointerType::getUnqual(NewFT));
1346     std::vector<Value *> Args;
1347
1348     CallSite::arg_iterator i = CS.arg_begin(), e = CS.arg_end();
1349     for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1350       Args.push_back(*i);
1351
1352     i = CS.arg_begin();
1353     for (unsigned n = FT->getNumParams(); n != 0; ++i, --n)
1354       Args.push_back(DFSF.getShadow(*i));
1355
1356     if (FT->isVarArg()) {
1357       unsigned VarArgSize = CS.arg_size() - FT->getNumParams();
1358       ArrayType *VarArgArrayTy = ArrayType::get(DFSF.DFS.ShadowTy, VarArgSize);
1359       AllocaInst *VarArgShadow =
1360           new AllocaInst(VarArgArrayTy, "", DFSF.F->getEntryBlock().begin());
1361       Args.push_back(IRB.CreateConstGEP2_32(VarArgShadow, 0, 0));
1362       for (unsigned n = 0; i != e; ++i, ++n) {
1363         IRB.CreateStore(DFSF.getShadow(*i),
1364                         IRB.CreateConstGEP2_32(VarArgShadow, 0, n));
1365         Args.push_back(*i);
1366       }
1367     }
1368
1369     CallSite NewCS;
1370     if (InvokeInst *II = dyn_cast<InvokeInst>(CS.getInstruction())) {
1371       NewCS = IRB.CreateInvoke(Func, II->getNormalDest(), II->getUnwindDest(),
1372                                Args);
1373     } else {
1374       NewCS = IRB.CreateCall(Func, Args);
1375     }
1376     NewCS.setCallingConv(CS.getCallingConv());
1377     NewCS.setAttributes(CS.getAttributes().removeAttributes(
1378         *DFSF.DFS.Ctx, AttributeSet::ReturnIndex,
1379         AttributeFuncs::typeIncompatible(NewCS.getInstruction()->getType(),
1380                                          AttributeSet::ReturnIndex)));
1381
1382     if (Next) {
1383       ExtractValueInst *ExVal =
1384           ExtractValueInst::Create(NewCS.getInstruction(), 0, "", Next);
1385       DFSF.SkipInsts.insert(ExVal);
1386       ExtractValueInst *ExShadow =
1387           ExtractValueInst::Create(NewCS.getInstruction(), 1, "", Next);
1388       DFSF.SkipInsts.insert(ExShadow);
1389       DFSF.setShadow(ExVal, ExShadow);
1390       DFSF.NonZeroChecks.insert(ExShadow);
1391
1392       CS.getInstruction()->replaceAllUsesWith(ExVal);
1393     }
1394
1395     CS.getInstruction()->eraseFromParent();
1396   }
1397 }
1398
1399 void DFSanVisitor::visitPHINode(PHINode &PN) {
1400   PHINode *ShadowPN =
1401       PHINode::Create(DFSF.DFS.ShadowTy, PN.getNumIncomingValues(), "", &PN);
1402
1403   // Give the shadow phi node valid predecessors to fool SplitEdge into working.
1404   Value *UndefShadow = UndefValue::get(DFSF.DFS.ShadowTy);
1405   for (PHINode::block_iterator i = PN.block_begin(), e = PN.block_end(); i != e;
1406        ++i) {
1407     ShadowPN->addIncoming(UndefShadow, *i);
1408   }
1409
1410   DFSF.PHIFixups.push_back(std::make_pair(&PN, ShadowPN));
1411   DFSF.setShadow(&PN, ShadowPN);
1412 }