6ab5e58c4cccd6106f483d9a8a694b1412fb1f2e
[oota-llvm.git] / lib / IR / Verifier.cpp
1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
12 //
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
15 //
16 //  * Both of a binary operator's parameters are of the same type
17 //  * Verify that the indices of mem access instructions match other operands
18 //  * Verify that arithmetic and other things are only performed on first-class
19 //    types.  Verify that shifts & logicals only happen on integrals f.e.
20 //  * All of the constants in a switch statement are of the correct type
21 //  * The code is in valid SSA form
22 //  * It should be illegal to put a label into any other type (like a structure)
23 //    or to return one. [except constant arrays!]
24 //  * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 //  * PHI nodes must have an entry for each predecessor, with no extras.
26 //  * PHI nodes must be the first thing in a basic block, all grouped together
27 //  * PHI nodes must have at least one entry
28 //  * All basic blocks should only end with terminator insts, not contain them
29 //  * The entry node to a function must not have predecessors
30 //  * All Instructions must be embedded into a basic block
31 //  * Functions cannot take a void-typed parameter
32 //  * Verify that a function's argument list agrees with it's declared type.
33 //  * It is illegal to specify a name for a void value.
34 //  * It is illegal to have a internal global value with no initializer
35 //  * It is illegal to have a ret instruction that returns a value that does not
36 //    agree with the function return value type.
37 //  * Function call argument types match the function prototype
38 //  * A landing pad is defined by a landingpad instruction, and can be jumped to
39 //    only by the unwind edge of an invoke instruction.
40 //  * A landingpad instruction must be the first non-PHI instruction in the
41 //    block.
42 //  * All landingpad instructions must use the same personality function with
43 //    the same function.
44 //  * All other things that are tested by asserts spread about the code...
45 //
46 //===----------------------------------------------------------------------===//
47
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/Pass.h"
72 #include "llvm/Support/CommandLine.h"
73 #include "llvm/Support/Debug.h"
74 #include "llvm/Support/ErrorHandling.h"
75 #include "llvm/Support/raw_ostream.h"
76 #include <algorithm>
77 #include <cstdarg>
78 using namespace llvm;
79
80 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(false));
81
82 namespace {
83 struct VerifierSupport {
84   raw_ostream &OS;
85   const Module *M;
86
87   /// \brief Track the brokenness of the module while recursively visiting.
88   bool Broken;
89
90   explicit VerifierSupport(raw_ostream &OS)
91       : OS(OS), M(nullptr), Broken(false) {}
92
93   void WriteValue(const Value *V) {
94     if (!V)
95       return;
96     if (isa<Instruction>(V)) {
97       OS << *V << '\n';
98     } else {
99       V->printAsOperand(OS, true, M);
100       OS << '\n';
101     }
102   }
103
104   void WriteType(Type *T) {
105     if (!T)
106       return;
107     OS << ' ' << *T;
108   }
109
110   // CheckFailed - A check failed, so print out the condition and the message
111   // that failed.  This provides a nice place to put a breakpoint if you want
112   // to see why something is not correct.
113   void CheckFailed(const Twine &Message, const Value *V1 = nullptr,
114                    const Value *V2 = nullptr, const Value *V3 = nullptr,
115                    const Value *V4 = nullptr) {
116     OS << Message.str() << "\n";
117     WriteValue(V1);
118     WriteValue(V2);
119     WriteValue(V3);
120     WriteValue(V4);
121     Broken = true;
122   }
123
124   void CheckFailed(const Twine &Message, const Value *V1, Type *T2,
125                    const Value *V3 = nullptr) {
126     OS << Message.str() << "\n";
127     WriteValue(V1);
128     WriteType(T2);
129     WriteValue(V3);
130     Broken = true;
131   }
132
133   void CheckFailed(const Twine &Message, Type *T1, Type *T2 = nullptr,
134                    Type *T3 = nullptr) {
135     OS << Message.str() << "\n";
136     WriteType(T1);
137     WriteType(T2);
138     WriteType(T3);
139     Broken = true;
140   }
141 };
142 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
143   friend class InstVisitor<Verifier>;
144
145   LLVMContext *Context;
146   const DataLayout *DL;
147   DominatorTree DT;
148
149   /// \brief When verifying a basic block, keep track of all of the
150   /// instructions we have seen so far.
151   ///
152   /// This allows us to do efficient dominance checks for the case when an
153   /// instruction has an operand that is an instruction in the same block.
154   SmallPtrSet<Instruction *, 16> InstsInThisBlock;
155
156   /// \brief Keep track of the metadata nodes that have been checked already.
157   SmallPtrSet<MDNode *, 32> MDNodes;
158
159   /// \brief The personality function referenced by the LandingPadInsts.
160   /// All LandingPadInsts within the same function must use the same
161   /// personality function.
162   const Value *PersonalityFn;
163
164 public:
165   explicit Verifier(raw_ostream &OS = dbgs())
166       : VerifierSupport(OS), Context(nullptr), DL(nullptr),
167         PersonalityFn(nullptr) {}
168
169   bool verify(const Function &F) {
170     M = F.getParent();
171     Context = &M->getContext();
172
173     // First ensure the function is well-enough formed to compute dominance
174     // information.
175     if (F.empty()) {
176       OS << "Function '" << F.getName()
177          << "' does not contain an entry block!\n";
178       return false;
179     }
180     for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
181       if (I->empty() || !I->back().isTerminator()) {
182         OS << "Basic Block in function '" << F.getName()
183            << "' does not have terminator!\n";
184         I->printAsOperand(OS, true);
185         OS << "\n";
186         return false;
187       }
188     }
189
190     // Now directly compute a dominance tree. We don't rely on the pass
191     // manager to provide this as it isolates us from a potentially
192     // out-of-date dominator tree and makes it significantly more complex to
193     // run this code outside of a pass manager.
194     // FIXME: It's really gross that we have to cast away constness here.
195     DT.recalculate(const_cast<Function &>(F));
196
197     Broken = false;
198     // FIXME: We strip const here because the inst visitor strips const.
199     visit(const_cast<Function &>(F));
200     InstsInThisBlock.clear();
201     PersonalityFn = nullptr;
202
203     return !Broken;
204   }
205
206   bool verify(const Module &M) {
207     this->M = &M;
208     Context = &M.getContext();
209     Broken = false;
210
211     // Scan through, checking all of the external function's linkage now...
212     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
213       visitGlobalValue(*I);
214
215       // Check to make sure function prototypes are okay.
216       if (I->isDeclaration())
217         visitFunction(*I);
218     }
219
220     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
221          I != E; ++I)
222       visitGlobalVariable(*I);
223
224     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
225          I != E; ++I)
226       visitGlobalAlias(*I);
227
228     for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
229                                                E = M.named_metadata_end();
230          I != E; ++I)
231       visitNamedMDNode(*I);
232
233     visitModuleFlags(M);
234     visitModuleIdents(M);
235
236     return !Broken;
237   }
238
239 private:
240   // Verification methods...
241   void visitGlobalValue(const GlobalValue &GV);
242   void visitGlobalVariable(const GlobalVariable &GV);
243   void visitGlobalAlias(const GlobalAlias &GA);
244   void visitNamedMDNode(const NamedMDNode &NMD);
245   void visitMDNode(MDNode &MD, Function *F);
246   void visitModuleIdents(const Module &M);
247   void visitModuleFlags(const Module &M);
248   void visitModuleFlag(const MDNode *Op,
249                        DenseMap<const MDString *, const MDNode *> &SeenIDs,
250                        SmallVectorImpl<const MDNode *> &Requirements);
251   void visitFunction(const Function &F);
252   void visitBasicBlock(BasicBlock &BB);
253
254   // InstVisitor overrides...
255   using InstVisitor<Verifier>::visit;
256   void visit(Instruction &I);
257
258   void visitTruncInst(TruncInst &I);
259   void visitZExtInst(ZExtInst &I);
260   void visitSExtInst(SExtInst &I);
261   void visitFPTruncInst(FPTruncInst &I);
262   void visitFPExtInst(FPExtInst &I);
263   void visitFPToUIInst(FPToUIInst &I);
264   void visitFPToSIInst(FPToSIInst &I);
265   void visitUIToFPInst(UIToFPInst &I);
266   void visitSIToFPInst(SIToFPInst &I);
267   void visitIntToPtrInst(IntToPtrInst &I);
268   void visitPtrToIntInst(PtrToIntInst &I);
269   void visitBitCastInst(BitCastInst &I);
270   void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
271   void visitPHINode(PHINode &PN);
272   void visitBinaryOperator(BinaryOperator &B);
273   void visitICmpInst(ICmpInst &IC);
274   void visitFCmpInst(FCmpInst &FC);
275   void visitExtractElementInst(ExtractElementInst &EI);
276   void visitInsertElementInst(InsertElementInst &EI);
277   void visitShuffleVectorInst(ShuffleVectorInst &EI);
278   void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
279   void visitCallInst(CallInst &CI);
280   void visitInvokeInst(InvokeInst &II);
281   void visitGetElementPtrInst(GetElementPtrInst &GEP);
282   void visitLoadInst(LoadInst &LI);
283   void visitStoreInst(StoreInst &SI);
284   void verifyDominatesUse(Instruction &I, unsigned i);
285   void visitInstruction(Instruction &I);
286   void visitTerminatorInst(TerminatorInst &I);
287   void visitBranchInst(BranchInst &BI);
288   void visitReturnInst(ReturnInst &RI);
289   void visitSwitchInst(SwitchInst &SI);
290   void visitIndirectBrInst(IndirectBrInst &BI);
291   void visitSelectInst(SelectInst &SI);
292   void visitUserOp1(Instruction &I);
293   void visitUserOp2(Instruction &I) { visitUserOp1(I); }
294   void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
295   void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
296   void visitAtomicRMWInst(AtomicRMWInst &RMWI);
297   void visitFenceInst(FenceInst &FI);
298   void visitAllocaInst(AllocaInst &AI);
299   void visitExtractValueInst(ExtractValueInst &EVI);
300   void visitInsertValueInst(InsertValueInst &IVI);
301   void visitLandingPadInst(LandingPadInst &LPI);
302
303   void VerifyCallSite(CallSite CS);
304   void verifyMustTailCall(CallInst &CI);
305   bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
306                         unsigned ArgNo, std::string &Suffix);
307   bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
308                            SmallVectorImpl<Type *> &ArgTys);
309   bool VerifyIntrinsicIsVarArg(bool isVarArg,
310                                ArrayRef<Intrinsic::IITDescriptor> &Infos);
311   bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
312   void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
313                             const Value *V);
314   void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
315                             bool isReturnValue, const Value *V);
316   void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
317                            const Value *V);
318
319   void VerifyBitcastType(const Value *V, Type *DestTy, Type *SrcTy);
320   void VerifyConstantExprBitcastType(const ConstantExpr *CE);
321 };
322 class DebugInfoVerifier : public VerifierSupport {
323 public:
324   explicit DebugInfoVerifier(raw_ostream &OS = dbgs()) : VerifierSupport(OS) {}
325
326   bool verify(const Module &M) {
327     this->M = &M;
328     verifyDebugInfo();
329     return !Broken;
330   }
331
332 private:
333   void verifyDebugInfo();
334   void processInstructions(DebugInfoFinder &Finder);
335   void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
336 };
337 } // End anonymous namespace
338
339 // Assert - We know that cond should be true, if not print an error message.
340 #define Assert(C, M) \
341   do { if (!(C)) { CheckFailed(M); return; } } while (0)
342 #define Assert1(C, M, V1) \
343   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
344 #define Assert2(C, M, V1, V2) \
345   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
346 #define Assert3(C, M, V1, V2, V3) \
347   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
348 #define Assert4(C, M, V1, V2, V3, V4) \
349   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
350
351 void Verifier::visit(Instruction &I) {
352   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
353     Assert1(I.getOperand(i) != nullptr, "Operand is null", &I);
354   InstVisitor<Verifier>::visit(I);
355 }
356
357
358 void Verifier::visitGlobalValue(const GlobalValue &GV) {
359   Assert1(!GV.isDeclaration() || GV.isMaterializable() ||
360               GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
361           "Global is external, but doesn't have external or weak linkage!",
362           &GV);
363
364   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
365           "Only global variables can have appending linkage!", &GV);
366
367   if (GV.hasAppendingLinkage()) {
368     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
369     Assert1(GVar && GVar->getType()->getElementType()->isArrayTy(),
370             "Only global arrays can have appending linkage!", GVar);
371   }
372 }
373
374 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
375   if (GV.hasInitializer()) {
376     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
377             "Global variable initializer type does not match global "
378             "variable type!", &GV);
379
380     // If the global has common linkage, it must have a zero initializer and
381     // cannot be constant.
382     if (GV.hasCommonLinkage()) {
383       Assert1(GV.getInitializer()->isNullValue(),
384               "'common' global must have a zero initializer!", &GV);
385       Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
386               &GV);
387     }
388   } else {
389     Assert1(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
390             "invalid linkage type for global declaration", &GV);
391   }
392
393   if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
394                        GV.getName() == "llvm.global_dtors")) {
395     Assert1(!GV.hasInitializer() || GV.hasAppendingLinkage(),
396             "invalid linkage for intrinsic global variable", &GV);
397     // Don't worry about emitting an error for it not being an array,
398     // visitGlobalValue will complain on appending non-array.
399     if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType())) {
400       StructType *STy = dyn_cast<StructType>(ATy->getElementType());
401       PointerType *FuncPtrTy =
402           FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
403       Assert1(STy && STy->getNumElements() == 2 &&
404               STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
405               STy->getTypeAtIndex(1) == FuncPtrTy,
406               "wrong type for intrinsic global variable", &GV);
407     }
408   }
409
410   if (GV.hasName() && (GV.getName() == "llvm.used" ||
411                        GV.getName() == "llvm.compiler.used")) {
412     Assert1(!GV.hasInitializer() || GV.hasAppendingLinkage(),
413             "invalid linkage for intrinsic global variable", &GV);
414     Type *GVType = GV.getType()->getElementType();
415     if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
416       PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
417       Assert1(PTy, "wrong type for intrinsic global variable", &GV);
418       if (GV.hasInitializer()) {
419         const Constant *Init = GV.getInitializer();
420         const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
421         Assert1(InitArray, "wrong initalizer for intrinsic global variable",
422                 Init);
423         for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
424           Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
425           Assert1(
426               isa<GlobalVariable>(V) || isa<Function>(V) || isa<GlobalAlias>(V),
427               "invalid llvm.used member", V);
428           Assert1(V->hasName(), "members of llvm.used must be named", V);
429         }
430       }
431     }
432   }
433
434   Assert1(!GV.hasDLLImportStorageClass() ||
435           (GV.isDeclaration() && GV.hasExternalLinkage()) ||
436           GV.hasAvailableExternallyLinkage(),
437           "Global is marked as dllimport, but not external", &GV);
438
439   if (!GV.hasInitializer()) {
440     visitGlobalValue(GV);
441     return;
442   }
443
444   // Walk any aggregate initializers looking for bitcasts between address spaces
445   SmallPtrSet<const Value *, 4> Visited;
446   SmallVector<const Value *, 4> WorkStack;
447   WorkStack.push_back(cast<Value>(GV.getInitializer()));
448
449   while (!WorkStack.empty()) {
450     const Value *V = WorkStack.pop_back_val();
451     if (!Visited.insert(V))
452       continue;
453
454     if (const User *U = dyn_cast<User>(V)) {
455       for (unsigned I = 0, N = U->getNumOperands(); I != N; ++I)
456         WorkStack.push_back(U->getOperand(I));
457     }
458
459     if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
460       VerifyConstantExprBitcastType(CE);
461       if (Broken)
462         return;
463     }
464   }
465
466   visitGlobalValue(GV);
467 }
468
469 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
470   Assert1(!GA.getName().empty(),
471           "Alias name cannot be empty!", &GA);
472   Assert1(GlobalAlias::isValidLinkage(GA.getLinkage()),
473           "Alias should have external or external weak linkage!", &GA);
474   Assert1(GA.getAliasee(),
475           "Aliasee cannot be NULL!", &GA);
476   Assert1(!GA.hasUnnamedAddr(), "Alias cannot have unnamed_addr!", &GA);
477
478   const Constant *Aliasee = GA.getAliasee();
479   const GlobalValue *GV = dyn_cast<GlobalValue>(Aliasee);
480
481   if (!GV) {
482     const ConstantExpr *CE = dyn_cast<ConstantExpr>(Aliasee);
483     if (CE && (CE->getOpcode() == Instruction::BitCast ||
484                CE->getOpcode() == Instruction::AddrSpaceCast ||
485                CE->getOpcode() == Instruction::GetElementPtr))
486       GV = dyn_cast<GlobalValue>(CE->getOperand(0));
487
488     Assert1(GV, "Aliasee should be either GlobalValue, bitcast or "
489                 "addrspacecast of GlobalValue",
490             &GA);
491
492     if (CE->getOpcode() == Instruction::BitCast) {
493       unsigned SrcAS = GV->getType()->getPointerAddressSpace();
494       unsigned DstAS = CE->getType()->getPointerAddressSpace();
495
496       Assert1(SrcAS == DstAS,
497               "Alias bitcasts cannot be between different address spaces",
498               &GA);
499     }
500   }
501   Assert1(!GV->isDeclaration(), "Alias must point to a definition", &GA);
502   if (const GlobalAlias *GAAliasee = dyn_cast<GlobalAlias>(GV)) {
503     Assert1(!GAAliasee->mayBeOverridden(), "Alias cannot point to a weak alias",
504             &GA);
505   }
506
507   visitGlobalValue(GA);
508 }
509
510 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
511   for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
512     MDNode *MD = NMD.getOperand(i);
513     if (!MD)
514       continue;
515
516     Assert1(!MD->isFunctionLocal(),
517             "Named metadata operand cannot be function local!", MD);
518     visitMDNode(*MD, nullptr);
519   }
520 }
521
522 void Verifier::visitMDNode(MDNode &MD, Function *F) {
523   // Only visit each node once.  Metadata can be mutually recursive, so this
524   // avoids infinite recursion here, as well as being an optimization.
525   if (!MDNodes.insert(&MD))
526     return;
527
528   for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
529     Value *Op = MD.getOperand(i);
530     if (!Op)
531       continue;
532     if (isa<Constant>(Op) || isa<MDString>(Op))
533       continue;
534     if (MDNode *N = dyn_cast<MDNode>(Op)) {
535       Assert2(MD.isFunctionLocal() || !N->isFunctionLocal(),
536               "Global metadata operand cannot be function local!", &MD, N);
537       visitMDNode(*N, F);
538       continue;
539     }
540     Assert2(MD.isFunctionLocal(), "Invalid operand for global metadata!", &MD, Op);
541
542     // If this was an instruction, bb, or argument, verify that it is in the
543     // function that we expect.
544     Function *ActualF = nullptr;
545     if (Instruction *I = dyn_cast<Instruction>(Op))
546       ActualF = I->getParent()->getParent();
547     else if (BasicBlock *BB = dyn_cast<BasicBlock>(Op))
548       ActualF = BB->getParent();
549     else if (Argument *A = dyn_cast<Argument>(Op))
550       ActualF = A->getParent();
551     assert(ActualF && "Unimplemented function local metadata case!");
552
553     Assert2(ActualF == F, "function-local metadata used in wrong function",
554             &MD, Op);
555   }
556 }
557
558 void Verifier::visitModuleIdents(const Module &M) {
559   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
560   if (!Idents) 
561     return;
562   
563   // llvm.ident takes a list of metadata entry. Each entry has only one string.
564   // Scan each llvm.ident entry and make sure that this requirement is met.
565   for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
566     const MDNode *N = Idents->getOperand(i);
567     Assert1(N->getNumOperands() == 1,
568             "incorrect number of operands in llvm.ident metadata", N);
569     Assert1(isa<MDString>(N->getOperand(0)),
570             ("invalid value for llvm.ident metadata entry operand"
571              "(the operand should be a string)"),
572             N->getOperand(0));
573   } 
574 }
575
576 void Verifier::visitModuleFlags(const Module &M) {
577   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
578   if (!Flags) return;
579
580   // Scan each flag, and track the flags and requirements.
581   DenseMap<const MDString*, const MDNode*> SeenIDs;
582   SmallVector<const MDNode*, 16> Requirements;
583   for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
584     visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
585   }
586
587   // Validate that the requirements in the module are valid.
588   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
589     const MDNode *Requirement = Requirements[I];
590     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
591     const Value *ReqValue = Requirement->getOperand(1);
592
593     const MDNode *Op = SeenIDs.lookup(Flag);
594     if (!Op) {
595       CheckFailed("invalid requirement on flag, flag is not present in module",
596                   Flag);
597       continue;
598     }
599
600     if (Op->getOperand(2) != ReqValue) {
601       CheckFailed(("invalid requirement on flag, "
602                    "flag does not have the required value"),
603                   Flag);
604       continue;
605     }
606   }
607 }
608
609 void
610 Verifier::visitModuleFlag(const MDNode *Op,
611                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
612                           SmallVectorImpl<const MDNode *> &Requirements) {
613   // Each module flag should have three arguments, the merge behavior (a
614   // constant int), the flag ID (an MDString), and the value.
615   Assert1(Op->getNumOperands() == 3,
616           "incorrect number of operands in module flag", Op);
617   ConstantInt *Behavior = dyn_cast<ConstantInt>(Op->getOperand(0));
618   MDString *ID = dyn_cast<MDString>(Op->getOperand(1));
619   Assert1(Behavior,
620           "invalid behavior operand in module flag (expected constant integer)",
621           Op->getOperand(0));
622   unsigned BehaviorValue = Behavior->getZExtValue();
623   Assert1(ID,
624           "invalid ID operand in module flag (expected metadata string)",
625           Op->getOperand(1));
626
627   // Sanity check the values for behaviors with additional requirements.
628   switch (BehaviorValue) {
629   default:
630     Assert1(false,
631             "invalid behavior operand in module flag (unexpected constant)",
632             Op->getOperand(0));
633     break;
634
635   case Module::Error:
636   case Module::Warning:
637   case Module::Override:
638     // These behavior types accept any value.
639     break;
640
641   case Module::Require: {
642     // The value should itself be an MDNode with two operands, a flag ID (an
643     // MDString), and a value.
644     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
645     Assert1(Value && Value->getNumOperands() == 2,
646             "invalid value for 'require' module flag (expected metadata pair)",
647             Op->getOperand(2));
648     Assert1(isa<MDString>(Value->getOperand(0)),
649             ("invalid value for 'require' module flag "
650              "(first value operand should be a string)"),
651             Value->getOperand(0));
652
653     // Append it to the list of requirements, to check once all module flags are
654     // scanned.
655     Requirements.push_back(Value);
656     break;
657   }
658
659   case Module::Append:
660   case Module::AppendUnique: {
661     // These behavior types require the operand be an MDNode.
662     Assert1(isa<MDNode>(Op->getOperand(2)),
663             "invalid value for 'append'-type module flag "
664             "(expected a metadata node)", Op->getOperand(2));
665     break;
666   }
667   }
668
669   // Unless this is a "requires" flag, check the ID is unique.
670   if (BehaviorValue != Module::Require) {
671     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
672     Assert1(Inserted,
673             "module flag identifiers must be unique (or of 'require' type)",
674             ID);
675   }
676 }
677
678 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
679                                     bool isFunction, const Value *V) {
680   unsigned Slot = ~0U;
681   for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
682     if (Attrs.getSlotIndex(I) == Idx) {
683       Slot = I;
684       break;
685     }
686
687   assert(Slot != ~0U && "Attribute set inconsistency!");
688
689   for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
690          I != E; ++I) {
691     if (I->isStringAttribute())
692       continue;
693
694     if (I->getKindAsEnum() == Attribute::NoReturn ||
695         I->getKindAsEnum() == Attribute::NoUnwind ||
696         I->getKindAsEnum() == Attribute::NoInline ||
697         I->getKindAsEnum() == Attribute::AlwaysInline ||
698         I->getKindAsEnum() == Attribute::OptimizeForSize ||
699         I->getKindAsEnum() == Attribute::StackProtect ||
700         I->getKindAsEnum() == Attribute::StackProtectReq ||
701         I->getKindAsEnum() == Attribute::StackProtectStrong ||
702         I->getKindAsEnum() == Attribute::NoRedZone ||
703         I->getKindAsEnum() == Attribute::NoImplicitFloat ||
704         I->getKindAsEnum() == Attribute::Naked ||
705         I->getKindAsEnum() == Attribute::InlineHint ||
706         I->getKindAsEnum() == Attribute::StackAlignment ||
707         I->getKindAsEnum() == Attribute::UWTable ||
708         I->getKindAsEnum() == Attribute::NonLazyBind ||
709         I->getKindAsEnum() == Attribute::ReturnsTwice ||
710         I->getKindAsEnum() == Attribute::SanitizeAddress ||
711         I->getKindAsEnum() == Attribute::SanitizeThread ||
712         I->getKindAsEnum() == Attribute::SanitizeMemory ||
713         I->getKindAsEnum() == Attribute::MinSize ||
714         I->getKindAsEnum() == Attribute::NoDuplicate ||
715         I->getKindAsEnum() == Attribute::Builtin ||
716         I->getKindAsEnum() == Attribute::NoBuiltin ||
717         I->getKindAsEnum() == Attribute::Cold ||
718         I->getKindAsEnum() == Attribute::OptimizeNone) {
719       if (!isFunction) {
720         CheckFailed("Attribute '" + I->getAsString() +
721                     "' only applies to functions!", V);
722         return;
723       }
724     } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
725                I->getKindAsEnum() == Attribute::ReadNone) {
726       if (Idx == 0) {
727         CheckFailed("Attribute '" + I->getAsString() +
728                     "' does not apply to function returns");
729         return;
730       }
731     } else if (isFunction) {
732       CheckFailed("Attribute '" + I->getAsString() +
733                   "' does not apply to functions!", V);
734       return;
735     }
736   }
737 }
738
739 // VerifyParameterAttrs - Check the given attributes for an argument or return
740 // value of the specified type.  The value V is printed in error messages.
741 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
742                                     bool isReturnValue, const Value *V) {
743   if (!Attrs.hasAttributes(Idx))
744     return;
745
746   VerifyAttributeTypes(Attrs, Idx, false, V);
747
748   if (isReturnValue)
749     Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
750             !Attrs.hasAttribute(Idx, Attribute::Nest) &&
751             !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
752             !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
753             !Attrs.hasAttribute(Idx, Attribute::Returned) &&
754             !Attrs.hasAttribute(Idx, Attribute::InAlloca),
755             "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
756             "'returned' do not apply to return values!", V);
757
758   // Check for mutually incompatible attributes.  Only inreg is compatible with
759   // sret.
760   unsigned AttrCount = 0;
761   AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
762   AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
763   AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
764                Attrs.hasAttribute(Idx, Attribute::InReg);
765   AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
766   Assert1(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
767                           "and 'sret' are incompatible!", V);
768
769   Assert1(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
770             Attrs.hasAttribute(Idx, Attribute::ReadOnly)), "Attributes "
771           "'inalloca and readonly' are incompatible!", V);
772
773   Assert1(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
774             Attrs.hasAttribute(Idx, Attribute::Returned)), "Attributes "
775           "'sret and returned' are incompatible!", V);
776
777   Assert1(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
778             Attrs.hasAttribute(Idx, Attribute::SExt)), "Attributes "
779           "'zeroext and signext' are incompatible!", V);
780
781   Assert1(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
782             Attrs.hasAttribute(Idx, Attribute::ReadOnly)), "Attributes "
783           "'readnone and readonly' are incompatible!", V);
784
785   Assert1(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
786             Attrs.hasAttribute(Idx, Attribute::AlwaysInline)), "Attributes "
787           "'noinline and alwaysinline' are incompatible!", V);
788
789   Assert1(!AttrBuilder(Attrs, Idx).
790             hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
791           "Wrong types for attribute: " +
792           AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx), V);
793
794   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
795     if (!PTy->getElementType()->isSized()) {
796       Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
797               !Attrs.hasAttribute(Idx, Attribute::InAlloca),
798               "Attributes 'byval' and 'inalloca' do not support unsized types!",
799               V);
800     }
801   } else {
802     Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal),
803             "Attribute 'byval' only applies to parameters with pointer type!",
804             V);
805   }
806 }
807
808 // VerifyFunctionAttrs - Check parameter attributes against a function type.
809 // The value V is printed in error messages.
810 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
811                                    const Value *V) {
812   if (Attrs.isEmpty())
813     return;
814
815   bool SawNest = false;
816   bool SawReturned = false;
817   bool SawSRet = false;
818
819   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
820     unsigned Idx = Attrs.getSlotIndex(i);
821
822     Type *Ty;
823     if (Idx == 0)
824       Ty = FT->getReturnType();
825     else if (Idx-1 < FT->getNumParams())
826       Ty = FT->getParamType(Idx-1);
827     else
828       break;  // VarArgs attributes, verified elsewhere.
829
830     VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
831
832     if (Idx == 0)
833       continue;
834
835     if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
836       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
837       SawNest = true;
838     }
839
840     if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
841       Assert1(!SawReturned, "More than one parameter has attribute returned!",
842               V);
843       Assert1(Ty->canLosslesslyBitCastTo(FT->getReturnType()), "Incompatible "
844               "argument and return types for 'returned' attribute", V);
845       SawReturned = true;
846     }
847
848     if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
849       Assert1(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
850       Assert1(Idx == 1 || Idx == 2,
851               "Attribute 'sret' is not on first or second parameter!", V);
852       SawSRet = true;
853     }
854
855     if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
856       Assert1(Idx == FT->getNumParams(),
857               "inalloca isn't on the last parameter!", V);
858     }
859   }
860
861   if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
862     return;
863
864   VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
865
866   Assert1(!(Attrs.hasAttribute(AttributeSet::FunctionIndex,
867                                Attribute::ReadNone) &&
868             Attrs.hasAttribute(AttributeSet::FunctionIndex,
869                                Attribute::ReadOnly)),
870           "Attributes 'readnone and readonly' are incompatible!", V);
871
872   Assert1(!(Attrs.hasAttribute(AttributeSet::FunctionIndex,
873                                Attribute::NoInline) &&
874             Attrs.hasAttribute(AttributeSet::FunctionIndex,
875                                Attribute::AlwaysInline)),
876           "Attributes 'noinline and alwaysinline' are incompatible!", V);
877
878   if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 
879                          Attribute::OptimizeNone)) {
880     Assert1(Attrs.hasAttribute(AttributeSet::FunctionIndex,
881                                Attribute::NoInline),
882             "Attribute 'optnone' requires 'noinline'!", V);
883
884     Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
885                                 Attribute::OptimizeForSize),
886             "Attributes 'optsize and optnone' are incompatible!", V);
887
888     Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
889                                 Attribute::MinSize),
890             "Attributes 'minsize and optnone' are incompatible!", V);
891   }
892 }
893
894 void Verifier::VerifyBitcastType(const Value *V, Type *DestTy, Type *SrcTy) {
895   // Get the size of the types in bits, we'll need this later
896   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
897   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
898
899   // BitCast implies a no-op cast of type only. No bits change.
900   // However, you can't cast pointers to anything but pointers.
901   Assert1(SrcTy->isPointerTy() == DestTy->isPointerTy(),
902           "Bitcast requires both operands to be pointer or neither", V);
903   Assert1(SrcBitSize == DestBitSize,
904           "Bitcast requires types of same width", V);
905
906   // Disallow aggregates.
907   Assert1(!SrcTy->isAggregateType(),
908           "Bitcast operand must not be aggregate", V);
909   Assert1(!DestTy->isAggregateType(),
910           "Bitcast type must not be aggregate", V);
911
912   // Without datalayout, assume all address spaces are the same size.
913   // Don't check if both types are not pointers.
914   // Skip casts between scalars and vectors.
915   if (!DL ||
916       !SrcTy->isPtrOrPtrVectorTy() ||
917       !DestTy->isPtrOrPtrVectorTy() ||
918       SrcTy->isVectorTy() != DestTy->isVectorTy()) {
919     return;
920   }
921
922   unsigned SrcAS = SrcTy->getPointerAddressSpace();
923   unsigned DstAS = DestTy->getPointerAddressSpace();
924
925   Assert1(SrcAS == DstAS,
926           "Bitcasts between pointers of different address spaces is not legal."
927           "Use AddrSpaceCast instead.", V);
928 }
929
930 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
931   if (CE->getOpcode() == Instruction::BitCast) {
932     Type *SrcTy = CE->getOperand(0)->getType();
933     Type *DstTy = CE->getType();
934     VerifyBitcastType(CE, DstTy, SrcTy);
935   }
936 }
937
938 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
939   if (Attrs.getNumSlots() == 0)
940     return true;
941
942   unsigned LastSlot = Attrs.getNumSlots() - 1;
943   unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
944   if (LastIndex <= Params
945       || (LastIndex == AttributeSet::FunctionIndex
946           && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
947     return true;
948
949   return false;
950 }
951
952 // visitFunction - Verify that a function is ok.
953 //
954 void Verifier::visitFunction(const Function &F) {
955   // Check function arguments.
956   FunctionType *FT = F.getFunctionType();
957   unsigned NumArgs = F.arg_size();
958
959   Assert1(Context == &F.getContext(),
960           "Function context does not match Module context!", &F);
961
962   Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
963   Assert2(FT->getNumParams() == NumArgs,
964           "# formal arguments must match # of arguments for function type!",
965           &F, FT);
966   Assert1(F.getReturnType()->isFirstClassType() ||
967           F.getReturnType()->isVoidTy() ||
968           F.getReturnType()->isStructTy(),
969           "Functions cannot return aggregate values!", &F);
970
971   Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
972           "Invalid struct return type!", &F);
973
974   AttributeSet Attrs = F.getAttributes();
975
976   Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
977           "Attribute after last parameter!", &F);
978
979   // Check function attributes.
980   VerifyFunctionAttrs(FT, Attrs, &F);
981
982   // On function declarations/definitions, we do not support the builtin
983   // attribute. We do not check this in VerifyFunctionAttrs since that is
984   // checking for Attributes that can/can not ever be on functions.
985   Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
986                               Attribute::Builtin),
987           "Attribute 'builtin' can only be applied to a callsite.", &F);
988
989   // Check that this function meets the restrictions on this calling convention.
990   switch (F.getCallingConv()) {
991   default:
992     break;
993   case CallingConv::C:
994     break;
995   case CallingConv::Fast:
996   case CallingConv::Cold:
997   case CallingConv::X86_FastCall:
998   case CallingConv::X86_ThisCall:
999   case CallingConv::Intel_OCL_BI:
1000   case CallingConv::PTX_Kernel:
1001   case CallingConv::PTX_Device:
1002     Assert1(!F.isVarArg(),
1003             "Varargs functions must have C calling conventions!", &F);
1004     break;
1005   }
1006
1007   bool isLLVMdotName = F.getName().size() >= 5 &&
1008                        F.getName().substr(0, 5) == "llvm.";
1009
1010   // Check that the argument values match the function type for this function...
1011   unsigned i = 0;
1012   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1013        ++I, ++i) {
1014     Assert2(I->getType() == FT->getParamType(i),
1015             "Argument value does not match function argument type!",
1016             I, FT->getParamType(i));
1017     Assert1(I->getType()->isFirstClassType(),
1018             "Function arguments must have first-class types!", I);
1019     if (!isLLVMdotName)
1020       Assert2(!I->getType()->isMetadataTy(),
1021               "Function takes metadata but isn't an intrinsic", I, &F);
1022   }
1023
1024   if (F.isMaterializable()) {
1025     // Function has a body somewhere we can't see.
1026   } else if (F.isDeclaration()) {
1027     Assert1(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1028             "invalid linkage type for function declaration", &F);
1029   } else {
1030     // Verify that this function (which has a body) is not named "llvm.*".  It
1031     // is not legal to define intrinsics.
1032     Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1033
1034     // Check the entry node
1035     const BasicBlock *Entry = &F.getEntryBlock();
1036     Assert1(pred_begin(Entry) == pred_end(Entry),
1037             "Entry block to function must not have predecessors!", Entry);
1038
1039     // The address of the entry block cannot be taken, unless it is dead.
1040     if (Entry->hasAddressTaken()) {
1041       Assert1(!BlockAddress::lookup(Entry)->isConstantUsed(),
1042               "blockaddress may not be used with the entry block!", Entry);
1043     }
1044   }
1045
1046   // If this function is actually an intrinsic, verify that it is only used in
1047   // direct call/invokes, never having its "address taken".
1048   if (F.getIntrinsicID()) {
1049     const User *U;
1050     if (F.hasAddressTaken(&U))
1051       Assert1(0, "Invalid user of intrinsic instruction!", U);
1052   }
1053
1054   Assert1(!F.hasDLLImportStorageClass() ||
1055           (F.isDeclaration() && F.hasExternalLinkage()) ||
1056           F.hasAvailableExternallyLinkage(),
1057           "Function is marked as dllimport, but not external.", &F);
1058 }
1059
1060 // verifyBasicBlock - Verify that a basic block is well formed...
1061 //
1062 void Verifier::visitBasicBlock(BasicBlock &BB) {
1063   InstsInThisBlock.clear();
1064
1065   // Ensure that basic blocks have terminators!
1066   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1067
1068   // Check constraints that this basic block imposes on all of the PHI nodes in
1069   // it.
1070   if (isa<PHINode>(BB.front())) {
1071     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1072     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1073     std::sort(Preds.begin(), Preds.end());
1074     PHINode *PN;
1075     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1076       // Ensure that PHI nodes have at least one entry!
1077       Assert1(PN->getNumIncomingValues() != 0,
1078               "PHI nodes must have at least one entry.  If the block is dead, "
1079               "the PHI should be removed!", PN);
1080       Assert1(PN->getNumIncomingValues() == Preds.size(),
1081               "PHINode should have one entry for each predecessor of its "
1082               "parent basic block!", PN);
1083
1084       // Get and sort all incoming values in the PHI node...
1085       Values.clear();
1086       Values.reserve(PN->getNumIncomingValues());
1087       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1088         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1089                                         PN->getIncomingValue(i)));
1090       std::sort(Values.begin(), Values.end());
1091
1092       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1093         // Check to make sure that if there is more than one entry for a
1094         // particular basic block in this PHI node, that the incoming values are
1095         // all identical.
1096         //
1097         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
1098                 Values[i].second == Values[i-1].second,
1099                 "PHI node has multiple entries for the same basic block with "
1100                 "different incoming values!", PN, Values[i].first,
1101                 Values[i].second, Values[i-1].second);
1102
1103         // Check to make sure that the predecessors and PHI node entries are
1104         // matched up.
1105         Assert3(Values[i].first == Preds[i],
1106                 "PHI node entries do not match predecessors!", PN,
1107                 Values[i].first, Preds[i]);
1108       }
1109     }
1110   }
1111 }
1112
1113 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1114   // Ensure that terminators only exist at the end of the basic block.
1115   Assert1(&I == I.getParent()->getTerminator(),
1116           "Terminator found in the middle of a basic block!", I.getParent());
1117   visitInstruction(I);
1118 }
1119
1120 void Verifier::visitBranchInst(BranchInst &BI) {
1121   if (BI.isConditional()) {
1122     Assert2(BI.getCondition()->getType()->isIntegerTy(1),
1123             "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1124   }
1125   visitTerminatorInst(BI);
1126 }
1127
1128 void Verifier::visitReturnInst(ReturnInst &RI) {
1129   Function *F = RI.getParent()->getParent();
1130   unsigned N = RI.getNumOperands();
1131   if (F->getReturnType()->isVoidTy())
1132     Assert2(N == 0,
1133             "Found return instr that returns non-void in Function of void "
1134             "return type!", &RI, F->getReturnType());
1135   else
1136     Assert2(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1137             "Function return type does not match operand "
1138             "type of return inst!", &RI, F->getReturnType());
1139
1140   // Check to make sure that the return value has necessary properties for
1141   // terminators...
1142   visitTerminatorInst(RI);
1143 }
1144
1145 void Verifier::visitSwitchInst(SwitchInst &SI) {
1146   // Check to make sure that all of the constants in the switch instruction
1147   // have the same type as the switched-on value.
1148   Type *SwitchTy = SI.getCondition()->getType();
1149   SmallPtrSet<ConstantInt*, 32> Constants;
1150   for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1151     Assert1(i.getCaseValue()->getType() == SwitchTy,
1152             "Switch constants must all be same type as switch value!", &SI);
1153     Assert2(Constants.insert(i.getCaseValue()),
1154             "Duplicate integer as switch case", &SI, i.getCaseValue());
1155   }
1156
1157   visitTerminatorInst(SI);
1158 }
1159
1160 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1161   Assert1(BI.getAddress()->getType()->isPointerTy(),
1162           "Indirectbr operand must have pointer type!", &BI);
1163   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1164     Assert1(BI.getDestination(i)->getType()->isLabelTy(),
1165             "Indirectbr destinations must all have pointer type!", &BI);
1166
1167   visitTerminatorInst(BI);
1168 }
1169
1170 void Verifier::visitSelectInst(SelectInst &SI) {
1171   Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1172                                           SI.getOperand(2)),
1173           "Invalid operands for select instruction!", &SI);
1174
1175   Assert1(SI.getTrueValue()->getType() == SI.getType(),
1176           "Select values must have same type as select instruction!", &SI);
1177   visitInstruction(SI);
1178 }
1179
1180 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1181 /// a pass, if any exist, it's an error.
1182 ///
1183 void Verifier::visitUserOp1(Instruction &I) {
1184   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
1185 }
1186
1187 void Verifier::visitTruncInst(TruncInst &I) {
1188   // Get the source and destination types
1189   Type *SrcTy = I.getOperand(0)->getType();
1190   Type *DestTy = I.getType();
1191
1192   // Get the size of the types in bits, we'll need this later
1193   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1194   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1195
1196   Assert1(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1197   Assert1(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1198   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1199           "trunc source and destination must both be a vector or neither", &I);
1200   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
1201
1202   visitInstruction(I);
1203 }
1204
1205 void Verifier::visitZExtInst(ZExtInst &I) {
1206   // Get the source and destination types
1207   Type *SrcTy = I.getOperand(0)->getType();
1208   Type *DestTy = I.getType();
1209
1210   // Get the size of the types in bits, we'll need this later
1211   Assert1(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1212   Assert1(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1213   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1214           "zext source and destination must both be a vector or neither", &I);
1215   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1216   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1217
1218   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
1219
1220   visitInstruction(I);
1221 }
1222
1223 void Verifier::visitSExtInst(SExtInst &I) {
1224   // Get the source and destination types
1225   Type *SrcTy = I.getOperand(0)->getType();
1226   Type *DestTy = I.getType();
1227
1228   // Get the size of the types in bits, we'll need this later
1229   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1230   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1231
1232   Assert1(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1233   Assert1(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1234   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1235           "sext source and destination must both be a vector or neither", &I);
1236   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
1237
1238   visitInstruction(I);
1239 }
1240
1241 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1242   // Get the source and destination types
1243   Type *SrcTy = I.getOperand(0)->getType();
1244   Type *DestTy = I.getType();
1245   // Get the size of the types in bits, we'll need this later
1246   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1247   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1248
1249   Assert1(SrcTy->isFPOrFPVectorTy(),"FPTrunc only operates on FP", &I);
1250   Assert1(DestTy->isFPOrFPVectorTy(),"FPTrunc only produces an FP", &I);
1251   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1252           "fptrunc source and destination must both be a vector or neither",&I);
1253   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
1254
1255   visitInstruction(I);
1256 }
1257
1258 void Verifier::visitFPExtInst(FPExtInst &I) {
1259   // Get the source and destination types
1260   Type *SrcTy = I.getOperand(0)->getType();
1261   Type *DestTy = I.getType();
1262
1263   // Get the size of the types in bits, we'll need this later
1264   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1265   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1266
1267   Assert1(SrcTy->isFPOrFPVectorTy(),"FPExt only operates on FP", &I);
1268   Assert1(DestTy->isFPOrFPVectorTy(),"FPExt only produces an FP", &I);
1269   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1270           "fpext source and destination must both be a vector or neither", &I);
1271   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
1272
1273   visitInstruction(I);
1274 }
1275
1276 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1277   // Get the source and destination types
1278   Type *SrcTy = I.getOperand(0)->getType();
1279   Type *DestTy = I.getType();
1280
1281   bool SrcVec = SrcTy->isVectorTy();
1282   bool DstVec = DestTy->isVectorTy();
1283
1284   Assert1(SrcVec == DstVec,
1285           "UIToFP source and dest must both be vector or scalar", &I);
1286   Assert1(SrcTy->isIntOrIntVectorTy(),
1287           "UIToFP source must be integer or integer vector", &I);
1288   Assert1(DestTy->isFPOrFPVectorTy(),
1289           "UIToFP result must be FP or FP vector", &I);
1290
1291   if (SrcVec && DstVec)
1292     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1293             cast<VectorType>(DestTy)->getNumElements(),
1294             "UIToFP source and dest vector length mismatch", &I);
1295
1296   visitInstruction(I);
1297 }
1298
1299 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1300   // Get the source and destination types
1301   Type *SrcTy = I.getOperand(0)->getType();
1302   Type *DestTy = I.getType();
1303
1304   bool SrcVec = SrcTy->isVectorTy();
1305   bool DstVec = DestTy->isVectorTy();
1306
1307   Assert1(SrcVec == DstVec,
1308           "SIToFP source and dest must both be vector or scalar", &I);
1309   Assert1(SrcTy->isIntOrIntVectorTy(),
1310           "SIToFP source must be integer or integer vector", &I);
1311   Assert1(DestTy->isFPOrFPVectorTy(),
1312           "SIToFP result must be FP or FP vector", &I);
1313
1314   if (SrcVec && DstVec)
1315     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1316             cast<VectorType>(DestTy)->getNumElements(),
1317             "SIToFP source and dest vector length mismatch", &I);
1318
1319   visitInstruction(I);
1320 }
1321
1322 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1323   // Get the source and destination types
1324   Type *SrcTy = I.getOperand(0)->getType();
1325   Type *DestTy = I.getType();
1326
1327   bool SrcVec = SrcTy->isVectorTy();
1328   bool DstVec = DestTy->isVectorTy();
1329
1330   Assert1(SrcVec == DstVec,
1331           "FPToUI source and dest must both be vector or scalar", &I);
1332   Assert1(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1333           &I);
1334   Assert1(DestTy->isIntOrIntVectorTy(),
1335           "FPToUI result must be integer or integer vector", &I);
1336
1337   if (SrcVec && DstVec)
1338     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1339             cast<VectorType>(DestTy)->getNumElements(),
1340             "FPToUI source and dest vector length mismatch", &I);
1341
1342   visitInstruction(I);
1343 }
1344
1345 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1346   // Get the source and destination types
1347   Type *SrcTy = I.getOperand(0)->getType();
1348   Type *DestTy = I.getType();
1349
1350   bool SrcVec = SrcTy->isVectorTy();
1351   bool DstVec = DestTy->isVectorTy();
1352
1353   Assert1(SrcVec == DstVec,
1354           "FPToSI source and dest must both be vector or scalar", &I);
1355   Assert1(SrcTy->isFPOrFPVectorTy(),
1356           "FPToSI source must be FP or FP vector", &I);
1357   Assert1(DestTy->isIntOrIntVectorTy(),
1358           "FPToSI result must be integer or integer vector", &I);
1359
1360   if (SrcVec && DstVec)
1361     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1362             cast<VectorType>(DestTy)->getNumElements(),
1363             "FPToSI source and dest vector length mismatch", &I);
1364
1365   visitInstruction(I);
1366 }
1367
1368 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1369   // Get the source and destination types
1370   Type *SrcTy = I.getOperand(0)->getType();
1371   Type *DestTy = I.getType();
1372
1373   Assert1(SrcTy->getScalarType()->isPointerTy(),
1374           "PtrToInt source must be pointer", &I);
1375   Assert1(DestTy->getScalarType()->isIntegerTy(),
1376           "PtrToInt result must be integral", &I);
1377   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1378           "PtrToInt type mismatch", &I);
1379
1380   if (SrcTy->isVectorTy()) {
1381     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1382     VectorType *VDest = dyn_cast<VectorType>(DestTy);
1383     Assert1(VSrc->getNumElements() == VDest->getNumElements(),
1384           "PtrToInt Vector width mismatch", &I);
1385   }
1386
1387   visitInstruction(I);
1388 }
1389
1390 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1391   // Get the source and destination types
1392   Type *SrcTy = I.getOperand(0)->getType();
1393   Type *DestTy = I.getType();
1394
1395   Assert1(SrcTy->getScalarType()->isIntegerTy(),
1396           "IntToPtr source must be an integral", &I);
1397   Assert1(DestTy->getScalarType()->isPointerTy(),
1398           "IntToPtr result must be a pointer",&I);
1399   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1400           "IntToPtr type mismatch", &I);
1401   if (SrcTy->isVectorTy()) {
1402     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1403     VectorType *VDest = dyn_cast<VectorType>(DestTy);
1404     Assert1(VSrc->getNumElements() == VDest->getNumElements(),
1405           "IntToPtr Vector width mismatch", &I);
1406   }
1407   visitInstruction(I);
1408 }
1409
1410 void Verifier::visitBitCastInst(BitCastInst &I) {
1411   Type *SrcTy = I.getOperand(0)->getType();
1412   Type *DestTy = I.getType();
1413   VerifyBitcastType(&I, DestTy, SrcTy);
1414   visitInstruction(I);
1415 }
1416
1417 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1418   Type *SrcTy = I.getOperand(0)->getType();
1419   Type *DestTy = I.getType();
1420
1421   Assert1(SrcTy->isPtrOrPtrVectorTy(),
1422           "AddrSpaceCast source must be a pointer", &I);
1423   Assert1(DestTy->isPtrOrPtrVectorTy(),
1424           "AddrSpaceCast result must be a pointer", &I);
1425   Assert1(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1426           "AddrSpaceCast must be between different address spaces", &I);
1427   if (SrcTy->isVectorTy())
1428     Assert1(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1429             "AddrSpaceCast vector pointer number of elements mismatch", &I);
1430   visitInstruction(I);
1431 }
1432
1433 /// visitPHINode - Ensure that a PHI node is well formed.
1434 ///
1435 void Verifier::visitPHINode(PHINode &PN) {
1436   // Ensure that the PHI nodes are all grouped together at the top of the block.
1437   // This can be tested by checking whether the instruction before this is
1438   // either nonexistent (because this is begin()) or is a PHI node.  If not,
1439   // then there is some other instruction before a PHI.
1440   Assert2(&PN == &PN.getParent()->front() ||
1441           isa<PHINode>(--BasicBlock::iterator(&PN)),
1442           "PHI nodes not grouped at top of basic block!",
1443           &PN, PN.getParent());
1444
1445   // Check that all of the values of the PHI node have the same type as the
1446   // result, and that the incoming blocks are really basic blocks.
1447   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1448     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1449             "PHI node operands are not the same type as the result!", &PN);
1450   }
1451
1452   // All other PHI node constraints are checked in the visitBasicBlock method.
1453
1454   visitInstruction(PN);
1455 }
1456
1457 void Verifier::VerifyCallSite(CallSite CS) {
1458   Instruction *I = CS.getInstruction();
1459
1460   Assert1(CS.getCalledValue()->getType()->isPointerTy(),
1461           "Called function must be a pointer!", I);
1462   PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1463
1464   Assert1(FPTy->getElementType()->isFunctionTy(),
1465           "Called function is not pointer to function type!", I);
1466   FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1467
1468   // Verify that the correct number of arguments are being passed
1469   if (FTy->isVarArg())
1470     Assert1(CS.arg_size() >= FTy->getNumParams(),
1471             "Called function requires more parameters than were provided!",I);
1472   else
1473     Assert1(CS.arg_size() == FTy->getNumParams(),
1474             "Incorrect number of arguments passed to called function!", I);
1475
1476   // Verify that all arguments to the call match the function type.
1477   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1478     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1479             "Call parameter type does not match function signature!",
1480             CS.getArgument(i), FTy->getParamType(i), I);
1481
1482   AttributeSet Attrs = CS.getAttributes();
1483
1484   Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1485           "Attribute after last parameter!", I);
1486
1487   // Verify call attributes.
1488   VerifyFunctionAttrs(FTy, Attrs, I);
1489
1490   // Conservatively check the inalloca argument.
1491   // We have a bug if we can find that there is an underlying alloca without
1492   // inalloca.
1493   if (CS.hasInAllocaArgument()) {
1494     Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
1495     if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
1496       Assert2(AI->isUsedWithInAlloca(),
1497               "inalloca argument for call has mismatched alloca", AI, I);
1498   }
1499
1500   if (FTy->isVarArg()) {
1501     // FIXME? is 'nest' even legal here?
1502     bool SawNest = false;
1503     bool SawReturned = false;
1504
1505     for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
1506       if (Attrs.hasAttribute(Idx, Attribute::Nest))
1507         SawNest = true;
1508       if (Attrs.hasAttribute(Idx, Attribute::Returned))
1509         SawReturned = true;
1510     }
1511
1512     // Check attributes on the varargs part.
1513     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1514       Type *Ty = CS.getArgument(Idx-1)->getType();
1515       VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
1516
1517       if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1518         Assert1(!SawNest, "More than one parameter has attribute nest!", I);
1519         SawNest = true;
1520       }
1521
1522       if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1523         Assert1(!SawReturned, "More than one parameter has attribute returned!",
1524                 I);
1525         Assert1(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
1526                 "Incompatible argument and return types for 'returned' "
1527                 "attribute", I);
1528         SawReturned = true;
1529       }
1530
1531       Assert1(!Attrs.hasAttribute(Idx, Attribute::StructRet),
1532               "Attribute 'sret' cannot be used for vararg call arguments!", I);
1533
1534       if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
1535         Assert1(Idx == CS.arg_size(), "inalloca isn't on the last argument!",
1536                 I);
1537     }
1538   }
1539
1540   // Verify that there's no metadata unless it's a direct call to an intrinsic.
1541   if (CS.getCalledFunction() == nullptr ||
1542       !CS.getCalledFunction()->getName().startswith("llvm.")) {
1543     for (FunctionType::param_iterator PI = FTy->param_begin(),
1544            PE = FTy->param_end(); PI != PE; ++PI)
1545       Assert1(!(*PI)->isMetadataTy(),
1546               "Function has metadata parameter but isn't an intrinsic", I);
1547   }
1548
1549   visitInstruction(*I);
1550 }
1551
1552 /// Two types are "congruent" if they are identical, or if they are both pointer
1553 /// types with different pointee types and the same address space.
1554 static bool isTypeCongruent(Type *L, Type *R) {
1555   if (L == R)
1556     return true;
1557   PointerType *PL = dyn_cast<PointerType>(L);
1558   PointerType *PR = dyn_cast<PointerType>(R);
1559   if (!PL || !PR)
1560     return false;
1561   return PL->getAddressSpace() == PR->getAddressSpace();
1562 }
1563
1564 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
1565   static const Attribute::AttrKind ABIAttrs[] = {
1566       Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
1567       Attribute::InReg, Attribute::Returned};
1568   AttrBuilder Copy;
1569   for (auto AK : ABIAttrs) {
1570     if (Attrs.hasAttribute(I + 1, AK))
1571       Copy.addAttribute(AK);
1572   }
1573   if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
1574     Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
1575   return Copy;
1576 }
1577
1578 void Verifier::verifyMustTailCall(CallInst &CI) {
1579   Assert1(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
1580
1581   // - The caller and callee prototypes must match.  Pointer types of
1582   //   parameters or return types may differ in pointee type, but not
1583   //   address space.
1584   Function *F = CI.getParent()->getParent();
1585   auto GetFnTy = [](Value *V) {
1586     return cast<FunctionType>(
1587         cast<PointerType>(V->getType())->getElementType());
1588   };
1589   FunctionType *CallerTy = GetFnTy(F);
1590   FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
1591   Assert1(CallerTy->getNumParams() == CalleeTy->getNumParams(),
1592           "cannot guarantee tail call due to mismatched parameter counts", &CI);
1593   Assert1(CallerTy->isVarArg() == CalleeTy->isVarArg(),
1594           "cannot guarantee tail call due to mismatched varargs", &CI);
1595   Assert1(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
1596           "cannot guarantee tail call due to mismatched return types", &CI);
1597   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1598     Assert1(
1599         isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
1600         "cannot guarantee tail call due to mismatched parameter types", &CI);
1601   }
1602
1603   // - The calling conventions of the caller and callee must match.
1604   Assert1(F->getCallingConv() == CI.getCallingConv(),
1605           "cannot guarantee tail call due to mismatched calling conv", &CI);
1606
1607   // - All ABI-impacting function attributes, such as sret, byval, inreg,
1608   //   returned, and inalloca, must match.
1609   AttributeSet CallerAttrs = F->getAttributes();
1610   AttributeSet CalleeAttrs = CI.getAttributes();
1611   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1612     AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
1613     AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
1614     Assert2(CallerABIAttrs == CalleeABIAttrs,
1615             "cannot guarantee tail call due to mismatched ABI impacting "
1616             "function attributes", &CI, CI.getOperand(I));
1617   }
1618
1619   // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
1620   //   or a pointer bitcast followed by a ret instruction.
1621   // - The ret instruction must return the (possibly bitcasted) value
1622   //   produced by the call or void.
1623   Value *RetVal = &CI;
1624   Instruction *Next = CI.getNextNode();
1625
1626   // Handle the optional bitcast.
1627   if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
1628     Assert1(BI->getOperand(0) == RetVal,
1629             "bitcast following musttail call must use the call", BI);
1630     RetVal = BI;
1631     Next = BI->getNextNode();
1632   }
1633
1634   // Check the return.
1635   ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
1636   Assert1(Ret, "musttail call must be precede a ret with an optional bitcast",
1637           &CI);
1638   Assert1(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
1639           "musttail call result must be returned", Ret);
1640 }
1641
1642 void Verifier::visitCallInst(CallInst &CI) {
1643   VerifyCallSite(&CI);
1644
1645   if (CI.isMustTailCall())
1646     verifyMustTailCall(CI);
1647
1648   if (Function *F = CI.getCalledFunction())
1649     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1650       visitIntrinsicFunctionCall(ID, CI);
1651 }
1652
1653 void Verifier::visitInvokeInst(InvokeInst &II) {
1654   VerifyCallSite(&II);
1655
1656   // Verify that there is a landingpad instruction as the first non-PHI
1657   // instruction of the 'unwind' destination.
1658   Assert1(II.getUnwindDest()->isLandingPad(),
1659           "The unwind destination does not have a landingpad instruction!",&II);
1660
1661   visitTerminatorInst(II);
1662 }
1663
1664 /// visitBinaryOperator - Check that both arguments to the binary operator are
1665 /// of the same type!
1666 ///
1667 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1668   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1669           "Both operands to a binary operator are not of the same type!", &B);
1670
1671   switch (B.getOpcode()) {
1672   // Check that integer arithmetic operators are only used with
1673   // integral operands.
1674   case Instruction::Add:
1675   case Instruction::Sub:
1676   case Instruction::Mul:
1677   case Instruction::SDiv:
1678   case Instruction::UDiv:
1679   case Instruction::SRem:
1680   case Instruction::URem:
1681     Assert1(B.getType()->isIntOrIntVectorTy(),
1682             "Integer arithmetic operators only work with integral types!", &B);
1683     Assert1(B.getType() == B.getOperand(0)->getType(),
1684             "Integer arithmetic operators must have same type "
1685             "for operands and result!", &B);
1686     break;
1687   // Check that floating-point arithmetic operators are only used with
1688   // floating-point operands.
1689   case Instruction::FAdd:
1690   case Instruction::FSub:
1691   case Instruction::FMul:
1692   case Instruction::FDiv:
1693   case Instruction::FRem:
1694     Assert1(B.getType()->isFPOrFPVectorTy(),
1695             "Floating-point arithmetic operators only work with "
1696             "floating-point types!", &B);
1697     Assert1(B.getType() == B.getOperand(0)->getType(),
1698             "Floating-point arithmetic operators must have same type "
1699             "for operands and result!", &B);
1700     break;
1701   // Check that logical operators are only used with integral operands.
1702   case Instruction::And:
1703   case Instruction::Or:
1704   case Instruction::Xor:
1705     Assert1(B.getType()->isIntOrIntVectorTy(),
1706             "Logical operators only work with integral types!", &B);
1707     Assert1(B.getType() == B.getOperand(0)->getType(),
1708             "Logical operators must have same type for operands and result!",
1709             &B);
1710     break;
1711   case Instruction::Shl:
1712   case Instruction::LShr:
1713   case Instruction::AShr:
1714     Assert1(B.getType()->isIntOrIntVectorTy(),
1715             "Shifts only work with integral types!", &B);
1716     Assert1(B.getType() == B.getOperand(0)->getType(),
1717             "Shift return type must be same as operands!", &B);
1718     break;
1719   default:
1720     llvm_unreachable("Unknown BinaryOperator opcode!");
1721   }
1722
1723   visitInstruction(B);
1724 }
1725
1726 void Verifier::visitICmpInst(ICmpInst &IC) {
1727   // Check that the operands are the same type
1728   Type *Op0Ty = IC.getOperand(0)->getType();
1729   Type *Op1Ty = IC.getOperand(1)->getType();
1730   Assert1(Op0Ty == Op1Ty,
1731           "Both operands to ICmp instruction are not of the same type!", &IC);
1732   // Check that the operands are the right type
1733   Assert1(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
1734           "Invalid operand types for ICmp instruction", &IC);
1735   // Check that the predicate is valid.
1736   Assert1(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1737           IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
1738           "Invalid predicate in ICmp instruction!", &IC);
1739
1740   visitInstruction(IC);
1741 }
1742
1743 void Verifier::visitFCmpInst(FCmpInst &FC) {
1744   // Check that the operands are the same type
1745   Type *Op0Ty = FC.getOperand(0)->getType();
1746   Type *Op1Ty = FC.getOperand(1)->getType();
1747   Assert1(Op0Ty == Op1Ty,
1748           "Both operands to FCmp instruction are not of the same type!", &FC);
1749   // Check that the operands are the right type
1750   Assert1(Op0Ty->isFPOrFPVectorTy(),
1751           "Invalid operand types for FCmp instruction", &FC);
1752   // Check that the predicate is valid.
1753   Assert1(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
1754           FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
1755           "Invalid predicate in FCmp instruction!", &FC);
1756
1757   visitInstruction(FC);
1758 }
1759
1760 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1761   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1762                                               EI.getOperand(1)),
1763           "Invalid extractelement operands!", &EI);
1764   visitInstruction(EI);
1765 }
1766
1767 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1768   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1769                                              IE.getOperand(1),
1770                                              IE.getOperand(2)),
1771           "Invalid insertelement operands!", &IE);
1772   visitInstruction(IE);
1773 }
1774
1775 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1776   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1777                                              SV.getOperand(2)),
1778           "Invalid shufflevector operands!", &SV);
1779   visitInstruction(SV);
1780 }
1781
1782 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1783   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
1784
1785   Assert1(isa<PointerType>(TargetTy),
1786     "GEP base pointer is not a vector or a vector of pointers", &GEP);
1787   Assert1(cast<PointerType>(TargetTy)->getElementType()->isSized(),
1788           "GEP into unsized type!", &GEP);
1789   Assert1(GEP.getPointerOperandType()->isVectorTy() ==
1790           GEP.getType()->isVectorTy(), "Vector GEP must return a vector value",
1791           &GEP);
1792
1793   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1794   Type *ElTy =
1795     GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
1796   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1797
1798   Assert2(GEP.getType()->getScalarType()->isPointerTy() &&
1799           cast<PointerType>(GEP.getType()->getScalarType())->getElementType()
1800           == ElTy, "GEP is not of right type for indices!", &GEP, ElTy);
1801
1802   if (GEP.getPointerOperandType()->isVectorTy()) {
1803     // Additional checks for vector GEPs.
1804     unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
1805     Assert1(GepWidth == GEP.getType()->getVectorNumElements(),
1806             "Vector GEP result width doesn't match operand's", &GEP);
1807     for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
1808       Type *IndexTy = Idxs[i]->getType();
1809       Assert1(IndexTy->isVectorTy(),
1810               "Vector GEP must have vector indices!", &GEP);
1811       unsigned IndexWidth = IndexTy->getVectorNumElements();
1812       Assert1(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
1813     }
1814   }
1815   visitInstruction(GEP);
1816 }
1817
1818 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
1819   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
1820 }
1821
1822 void Verifier::visitLoadInst(LoadInst &LI) {
1823   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1824   Assert1(PTy, "Load operand must be a pointer.", &LI);
1825   Type *ElTy = PTy->getElementType();
1826   Assert2(ElTy == LI.getType(),
1827           "Load result type does not match pointer operand type!", &LI, ElTy);
1828   if (LI.isAtomic()) {
1829     Assert1(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
1830             "Load cannot have Release ordering", &LI);
1831     Assert1(LI.getAlignment() != 0,
1832             "Atomic load must specify explicit alignment", &LI);
1833     if (!ElTy->isPointerTy()) {
1834       Assert2(ElTy->isIntegerTy(),
1835               "atomic load operand must have integer type!",
1836               &LI, ElTy);
1837       unsigned Size = ElTy->getPrimitiveSizeInBits();
1838       Assert2(Size >= 8 && !(Size & (Size - 1)),
1839               "atomic load operand must be power-of-two byte-sized integer",
1840               &LI, ElTy);
1841     }
1842   } else {
1843     Assert1(LI.getSynchScope() == CrossThread,
1844             "Non-atomic load cannot have SynchronizationScope specified", &LI);
1845   }
1846
1847   if (MDNode *Range = LI.getMetadata(LLVMContext::MD_range)) {
1848     unsigned NumOperands = Range->getNumOperands();
1849     Assert1(NumOperands % 2 == 0, "Unfinished range!", Range);
1850     unsigned NumRanges = NumOperands / 2;
1851     Assert1(NumRanges >= 1, "It should have at least one range!", Range);
1852
1853     ConstantRange LastRange(1); // Dummy initial value
1854     for (unsigned i = 0; i < NumRanges; ++i) {
1855       ConstantInt *Low = dyn_cast<ConstantInt>(Range->getOperand(2*i));
1856       Assert1(Low, "The lower limit must be an integer!", Low);
1857       ConstantInt *High = dyn_cast<ConstantInt>(Range->getOperand(2*i + 1));
1858       Assert1(High, "The upper limit must be an integer!", High);
1859       Assert1(High->getType() == Low->getType() &&
1860               High->getType() == ElTy, "Range types must match load type!",
1861               &LI);
1862
1863       APInt HighV = High->getValue();
1864       APInt LowV = Low->getValue();
1865       ConstantRange CurRange(LowV, HighV);
1866       Assert1(!CurRange.isEmptySet() && !CurRange.isFullSet(),
1867               "Range must not be empty!", Range);
1868       if (i != 0) {
1869         Assert1(CurRange.intersectWith(LastRange).isEmptySet(),
1870                 "Intervals are overlapping", Range);
1871         Assert1(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
1872                 Range);
1873         Assert1(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
1874                 Range);
1875       }
1876       LastRange = ConstantRange(LowV, HighV);
1877     }
1878     if (NumRanges > 2) {
1879       APInt FirstLow =
1880         dyn_cast<ConstantInt>(Range->getOperand(0))->getValue();
1881       APInt FirstHigh =
1882         dyn_cast<ConstantInt>(Range->getOperand(1))->getValue();
1883       ConstantRange FirstRange(FirstLow, FirstHigh);
1884       Assert1(FirstRange.intersectWith(LastRange).isEmptySet(),
1885               "Intervals are overlapping", Range);
1886       Assert1(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
1887               Range);
1888     }
1889
1890
1891   }
1892
1893   visitInstruction(LI);
1894 }
1895
1896 void Verifier::visitStoreInst(StoreInst &SI) {
1897   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1898   Assert1(PTy, "Store operand must be a pointer.", &SI);
1899   Type *ElTy = PTy->getElementType();
1900   Assert2(ElTy == SI.getOperand(0)->getType(),
1901           "Stored value type does not match pointer operand type!",
1902           &SI, ElTy);
1903   if (SI.isAtomic()) {
1904     Assert1(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
1905             "Store cannot have Acquire ordering", &SI);
1906     Assert1(SI.getAlignment() != 0,
1907             "Atomic store must specify explicit alignment", &SI);
1908     if (!ElTy->isPointerTy()) {
1909       Assert2(ElTy->isIntegerTy(),
1910               "atomic store operand must have integer type!",
1911               &SI, ElTy);
1912       unsigned Size = ElTy->getPrimitiveSizeInBits();
1913       Assert2(Size >= 8 && !(Size & (Size - 1)),
1914               "atomic store operand must be power-of-two byte-sized integer",
1915               &SI, ElTy);
1916     }
1917   } else {
1918     Assert1(SI.getSynchScope() == CrossThread,
1919             "Non-atomic store cannot have SynchronizationScope specified", &SI);
1920   }
1921   visitInstruction(SI);
1922 }
1923
1924 void Verifier::visitAllocaInst(AllocaInst &AI) {
1925   SmallPtrSet<const Type*, 4> Visited;
1926   PointerType *PTy = AI.getType();
1927   Assert1(PTy->getAddressSpace() == 0,
1928           "Allocation instruction pointer not in the generic address space!",
1929           &AI);
1930   Assert1(PTy->getElementType()->isSized(&Visited), "Cannot allocate unsized type",
1931           &AI);
1932   Assert1(AI.getArraySize()->getType()->isIntegerTy(),
1933           "Alloca array size must have integer type", &AI);
1934
1935   visitInstruction(AI);
1936 }
1937
1938 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
1939
1940   // FIXME: more conditions???
1941   Assert1(CXI.getSuccessOrdering() != NotAtomic,
1942           "cmpxchg instructions must be atomic.", &CXI);
1943   Assert1(CXI.getFailureOrdering() != NotAtomic,
1944           "cmpxchg instructions must be atomic.", &CXI);
1945   Assert1(CXI.getSuccessOrdering() != Unordered,
1946           "cmpxchg instructions cannot be unordered.", &CXI);
1947   Assert1(CXI.getFailureOrdering() != Unordered,
1948           "cmpxchg instructions cannot be unordered.", &CXI);
1949   Assert1(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
1950           "cmpxchg instructions be at least as constrained on success as fail",
1951           &CXI);
1952   Assert1(CXI.getFailureOrdering() != Release &&
1953               CXI.getFailureOrdering() != AcquireRelease,
1954           "cmpxchg failure ordering cannot include release semantics", &CXI);
1955
1956   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
1957   Assert1(PTy, "First cmpxchg operand must be a pointer.", &CXI);
1958   Type *ElTy = PTy->getElementType();
1959   Assert2(ElTy->isIntegerTy(),
1960           "cmpxchg operand must have integer type!",
1961           &CXI, ElTy);
1962   unsigned Size = ElTy->getPrimitiveSizeInBits();
1963   Assert2(Size >= 8 && !(Size & (Size - 1)),
1964           "cmpxchg operand must be power-of-two byte-sized integer",
1965           &CXI, ElTy);
1966   Assert2(ElTy == CXI.getOperand(1)->getType(),
1967           "Expected value type does not match pointer operand type!",
1968           &CXI, ElTy);
1969   Assert2(ElTy == CXI.getOperand(2)->getType(),
1970           "Stored value type does not match pointer operand type!",
1971           &CXI, ElTy);
1972   visitInstruction(CXI);
1973 }
1974
1975 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
1976   Assert1(RMWI.getOrdering() != NotAtomic,
1977           "atomicrmw instructions must be atomic.", &RMWI);
1978   Assert1(RMWI.getOrdering() != Unordered,
1979           "atomicrmw instructions cannot be unordered.", &RMWI);
1980   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
1981   Assert1(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
1982   Type *ElTy = PTy->getElementType();
1983   Assert2(ElTy->isIntegerTy(),
1984           "atomicrmw operand must have integer type!",
1985           &RMWI, ElTy);
1986   unsigned Size = ElTy->getPrimitiveSizeInBits();
1987   Assert2(Size >= 8 && !(Size & (Size - 1)),
1988           "atomicrmw operand must be power-of-two byte-sized integer",
1989           &RMWI, ElTy);
1990   Assert2(ElTy == RMWI.getOperand(1)->getType(),
1991           "Argument value type does not match pointer operand type!",
1992           &RMWI, ElTy);
1993   Assert1(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
1994           RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
1995           "Invalid binary operation!", &RMWI);
1996   visitInstruction(RMWI);
1997 }
1998
1999 void Verifier::visitFenceInst(FenceInst &FI) {
2000   const AtomicOrdering Ordering = FI.getOrdering();
2001   Assert1(Ordering == Acquire || Ordering == Release ||
2002           Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2003           "fence instructions may only have "
2004           "acquire, release, acq_rel, or seq_cst ordering.", &FI);
2005   visitInstruction(FI);
2006 }
2007
2008 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2009   Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2010                                            EVI.getIndices()) ==
2011           EVI.getType(),
2012           "Invalid ExtractValueInst operands!", &EVI);
2013
2014   visitInstruction(EVI);
2015 }
2016
2017 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2018   Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2019                                            IVI.getIndices()) ==
2020           IVI.getOperand(1)->getType(),
2021           "Invalid InsertValueInst operands!", &IVI);
2022
2023   visitInstruction(IVI);
2024 }
2025
2026 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2027   BasicBlock *BB = LPI.getParent();
2028
2029   // The landingpad instruction is ill-formed if it doesn't have any clauses and
2030   // isn't a cleanup.
2031   Assert1(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2032           "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2033
2034   // The landingpad instruction defines its parent as a landing pad block. The
2035   // landing pad block may be branched to only by the unwind edge of an invoke.
2036   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2037     const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2038     Assert1(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2039             "Block containing LandingPadInst must be jumped to "
2040             "only by the unwind edge of an invoke.", &LPI);
2041   }
2042
2043   // The landingpad instruction must be the first non-PHI instruction in the
2044   // block.
2045   Assert1(LPI.getParent()->getLandingPadInst() == &LPI,
2046           "LandingPadInst not the first non-PHI instruction in the block.",
2047           &LPI);
2048
2049   // The personality functions for all landingpad instructions within the same
2050   // function should match.
2051   if (PersonalityFn)
2052     Assert1(LPI.getPersonalityFn() == PersonalityFn,
2053             "Personality function doesn't match others in function", &LPI);
2054   PersonalityFn = LPI.getPersonalityFn();
2055
2056   // All operands must be constants.
2057   Assert1(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2058           &LPI);
2059   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2060     Value *Clause = LPI.getClause(i);
2061     Assert1(isa<Constant>(Clause), "Clause is not constant!", &LPI);
2062     if (LPI.isCatch(i)) {
2063       Assert1(isa<PointerType>(Clause->getType()),
2064               "Catch operand does not have pointer type!", &LPI);
2065     } else {
2066       Assert1(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2067       Assert1(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2068               "Filter operand is not an array of constants!", &LPI);
2069     }
2070   }
2071
2072   visitInstruction(LPI);
2073 }
2074
2075 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2076   Instruction *Op = cast<Instruction>(I.getOperand(i));
2077   // If the we have an invalid invoke, don't try to compute the dominance.
2078   // We already reject it in the invoke specific checks and the dominance
2079   // computation doesn't handle multiple edges.
2080   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2081     if (II->getNormalDest() == II->getUnwindDest())
2082       return;
2083   }
2084
2085   const Use &U = I.getOperandUse(i);
2086   Assert2(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2087           "Instruction does not dominate all uses!", Op, &I);
2088 }
2089
2090 /// verifyInstruction - Verify that an instruction is well formed.
2091 ///
2092 void Verifier::visitInstruction(Instruction &I) {
2093   BasicBlock *BB = I.getParent();
2094   Assert1(BB, "Instruction not embedded in basic block!", &I);
2095
2096   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
2097     for (User *U : I.users()) {
2098       Assert1(U != (User*)&I || !DT.isReachableFromEntry(BB),
2099               "Only PHI nodes may reference their own value!", &I);
2100     }
2101   }
2102
2103   // Check that void typed values don't have names
2104   Assert1(!I.getType()->isVoidTy() || !I.hasName(),
2105           "Instruction has a name, but provides a void value!", &I);
2106
2107   // Check that the return value of the instruction is either void or a legal
2108   // value type.
2109   Assert1(I.getType()->isVoidTy() ||
2110           I.getType()->isFirstClassType(),
2111           "Instruction returns a non-scalar type!", &I);
2112
2113   // Check that the instruction doesn't produce metadata. Calls are already
2114   // checked against the callee type.
2115   Assert1(!I.getType()->isMetadataTy() ||
2116           isa<CallInst>(I) || isa<InvokeInst>(I),
2117           "Invalid use of metadata!", &I);
2118
2119   // Check that all uses of the instruction, if they are instructions
2120   // themselves, actually have parent basic blocks.  If the use is not an
2121   // instruction, it is an error!
2122   for (Use &U : I.uses()) {
2123     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2124       Assert2(Used->getParent() != nullptr, "Instruction referencing"
2125               " instruction not embedded in a basic block!", &I, Used);
2126     else {
2127       CheckFailed("Use of instruction is not an instruction!", U);
2128       return;
2129     }
2130   }
2131
2132   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2133     Assert1(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2134
2135     // Check to make sure that only first-class-values are operands to
2136     // instructions.
2137     if (!I.getOperand(i)->getType()->isFirstClassType()) {
2138       Assert1(0, "Instruction operands must be first-class values!", &I);
2139     }
2140
2141     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2142       // Check to make sure that the "address of" an intrinsic function is never
2143       // taken.
2144       Assert1(!F->isIntrinsic() || i == (isa<CallInst>(I) ? e-1 : 0),
2145               "Cannot take the address of an intrinsic!", &I);
2146       Assert1(!F->isIntrinsic() || isa<CallInst>(I) ||
2147               F->getIntrinsicID() == Intrinsic::donothing,
2148               "Cannot invoke an intrinsinc other than donothing", &I);
2149       Assert1(F->getParent() == M, "Referencing function in another module!",
2150               &I);
2151     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2152       Assert1(OpBB->getParent() == BB->getParent(),
2153               "Referring to a basic block in another function!", &I);
2154     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2155       Assert1(OpArg->getParent() == BB->getParent(),
2156               "Referring to an argument in another function!", &I);
2157     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2158       Assert1(GV->getParent() == M, "Referencing global in another module!",
2159               &I);
2160     } else if (isa<Instruction>(I.getOperand(i))) {
2161       verifyDominatesUse(I, i);
2162     } else if (isa<InlineAsm>(I.getOperand(i))) {
2163       Assert1((i + 1 == e && isa<CallInst>(I)) ||
2164               (i + 3 == e && isa<InvokeInst>(I)),
2165               "Cannot take the address of an inline asm!", &I);
2166     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2167       if (CE->getType()->isPtrOrPtrVectorTy()) {
2168         // If we have a ConstantExpr pointer, we need to see if it came from an
2169         // illegal bitcast (inttoptr <constant int> )
2170         SmallVector<const ConstantExpr *, 4> Stack;
2171         SmallPtrSet<const ConstantExpr *, 4> Visited;
2172         Stack.push_back(CE);
2173
2174         while (!Stack.empty()) {
2175           const ConstantExpr *V = Stack.pop_back_val();
2176           if (!Visited.insert(V))
2177             continue;
2178
2179           VerifyConstantExprBitcastType(V);
2180
2181           for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2182             if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2183               Stack.push_back(Op);
2184           }
2185         }
2186       }
2187     }
2188   }
2189
2190   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2191     Assert1(I.getType()->isFPOrFPVectorTy(),
2192             "fpmath requires a floating point result!", &I);
2193     Assert1(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2194     Value *Op0 = MD->getOperand(0);
2195     if (ConstantFP *CFP0 = dyn_cast_or_null<ConstantFP>(Op0)) {
2196       APFloat Accuracy = CFP0->getValueAPF();
2197       Assert1(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2198               "fpmath accuracy not a positive number!", &I);
2199     } else {
2200       Assert1(false, "invalid fpmath accuracy!", &I);
2201     }
2202   }
2203
2204   MDNode *MD = I.getMetadata(LLVMContext::MD_range);
2205   Assert1(!MD || isa<LoadInst>(I), "Ranges are only for loads!", &I);
2206
2207   InstsInThisBlock.insert(&I);
2208 }
2209
2210 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2211 /// intrinsic argument or return value) matches the type constraints specified
2212 /// by the .td file (e.g. an "any integer" argument really is an integer).
2213 ///
2214 /// This return true on error but does not print a message.
2215 bool Verifier::VerifyIntrinsicType(Type *Ty,
2216                                    ArrayRef<Intrinsic::IITDescriptor> &Infos,
2217                                    SmallVectorImpl<Type*> &ArgTys) {
2218   using namespace Intrinsic;
2219
2220   // If we ran out of descriptors, there are too many arguments.
2221   if (Infos.empty()) return true;
2222   IITDescriptor D = Infos.front();
2223   Infos = Infos.slice(1);
2224
2225   switch (D.Kind) {
2226   case IITDescriptor::Void: return !Ty->isVoidTy();
2227   case IITDescriptor::VarArg: return true;
2228   case IITDescriptor::MMX:  return !Ty->isX86_MMXTy();
2229   case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2230   case IITDescriptor::Half: return !Ty->isHalfTy();
2231   case IITDescriptor::Float: return !Ty->isFloatTy();
2232   case IITDescriptor::Double: return !Ty->isDoubleTy();
2233   case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2234   case IITDescriptor::Vector: {
2235     VectorType *VT = dyn_cast<VectorType>(Ty);
2236     return !VT || VT->getNumElements() != D.Vector_Width ||
2237            VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2238   }
2239   case IITDescriptor::Pointer: {
2240     PointerType *PT = dyn_cast<PointerType>(Ty);
2241     return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2242            VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2243   }
2244
2245   case IITDescriptor::Struct: {
2246     StructType *ST = dyn_cast<StructType>(Ty);
2247     if (!ST || ST->getNumElements() != D.Struct_NumElements)
2248       return true;
2249
2250     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2251       if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2252         return true;
2253     return false;
2254   }
2255
2256   case IITDescriptor::Argument:
2257     // Two cases here - If this is the second occurrence of an argument, verify
2258     // that the later instance matches the previous instance.
2259     if (D.getArgumentNumber() < ArgTys.size())
2260       return Ty != ArgTys[D.getArgumentNumber()];
2261
2262     // Otherwise, if this is the first instance of an argument, record it and
2263     // verify the "Any" kind.
2264     assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2265     ArgTys.push_back(Ty);
2266
2267     switch (D.getArgumentKind()) {
2268     case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2269     case IITDescriptor::AK_AnyFloat:   return !Ty->isFPOrFPVectorTy();
2270     case IITDescriptor::AK_AnyVector:  return !isa<VectorType>(Ty);
2271     case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2272     }
2273     llvm_unreachable("all argument kinds not covered");
2274
2275   case IITDescriptor::ExtendArgument: {
2276     // This may only be used when referring to a previous vector argument.
2277     if (D.getArgumentNumber() >= ArgTys.size())
2278       return true;
2279
2280     Type *NewTy = ArgTys[D.getArgumentNumber()];
2281     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2282       NewTy = VectorType::getExtendedElementVectorType(VTy);
2283     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2284       NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2285     else
2286       return true;
2287
2288     return Ty != NewTy;
2289   }
2290   case IITDescriptor::TruncArgument: {
2291     // This may only be used when referring to a previous vector argument.
2292     if (D.getArgumentNumber() >= ArgTys.size())
2293       return true;
2294
2295     Type *NewTy = ArgTys[D.getArgumentNumber()];
2296     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2297       NewTy = VectorType::getTruncatedElementVectorType(VTy);
2298     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2299       NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2300     else
2301       return true;
2302
2303     return Ty != NewTy;
2304   }
2305   case IITDescriptor::HalfVecArgument:
2306     // This may only be used when referring to a previous vector argument.
2307     return D.getArgumentNumber() >= ArgTys.size() ||
2308            !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2309            VectorType::getHalfElementsVectorType(
2310                          cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2311   }
2312   llvm_unreachable("unhandled");
2313 }
2314
2315 /// \brief Verify if the intrinsic has variable arguments.
2316 /// This method is intended to be called after all the fixed arguments have been
2317 /// verified first.
2318 ///
2319 /// This method returns true on error and does not print an error message.
2320 bool
2321 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2322                                   ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2323   using namespace Intrinsic;
2324
2325   // If there are no descriptors left, then it can't be a vararg.
2326   if (Infos.empty())
2327     return isVarArg ? true : false;
2328
2329   // There should be only one descriptor remaining at this point.
2330   if (Infos.size() != 1)
2331     return true;
2332
2333   // Check and verify the descriptor.
2334   IITDescriptor D = Infos.front();
2335   Infos = Infos.slice(1);
2336   if (D.Kind == IITDescriptor::VarArg)
2337     return isVarArg ? false : true;
2338
2339   return true;
2340 }
2341
2342 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2343 ///
2344 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2345   Function *IF = CI.getCalledFunction();
2346   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2347           IF);
2348
2349   // Verify that the intrinsic prototype lines up with what the .td files
2350   // describe.
2351   FunctionType *IFTy = IF->getFunctionType();
2352   bool IsVarArg = IFTy->isVarArg();
2353
2354   SmallVector<Intrinsic::IITDescriptor, 8> Table;
2355   getIntrinsicInfoTableEntries(ID, Table);
2356   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2357
2358   SmallVector<Type *, 4> ArgTys;
2359   Assert1(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2360           "Intrinsic has incorrect return type!", IF);
2361   for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2362     Assert1(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2363             "Intrinsic has incorrect argument type!", IF);
2364
2365   // Verify if the intrinsic call matches the vararg property.
2366   if (IsVarArg)
2367     Assert1(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2368             "Intrinsic was not defined with variable arguments!", IF);
2369   else
2370     Assert1(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2371             "Callsite was not defined with variable arguments!", IF);
2372
2373   // All descriptors should be absorbed by now.
2374   Assert1(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2375
2376   // Now that we have the intrinsic ID and the actual argument types (and we
2377   // know they are legal for the intrinsic!) get the intrinsic name through the
2378   // usual means.  This allows us to verify the mangling of argument types into
2379   // the name.
2380   const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2381   Assert1(ExpectedName == IF->getName(),
2382           "Intrinsic name not mangled correctly for type arguments! "
2383           "Should be: " + ExpectedName, IF);
2384
2385   // If the intrinsic takes MDNode arguments, verify that they are either global
2386   // or are local to *this* function.
2387   for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2388     if (MDNode *MD = dyn_cast<MDNode>(CI.getArgOperand(i)))
2389       visitMDNode(*MD, CI.getParent()->getParent());
2390
2391   switch (ID) {
2392   default:
2393     break;
2394   case Intrinsic::ctlz:  // llvm.ctlz
2395   case Intrinsic::cttz:  // llvm.cttz
2396     Assert1(isa<ConstantInt>(CI.getArgOperand(1)),
2397             "is_zero_undef argument of bit counting intrinsics must be a "
2398             "constant int", &CI);
2399     break;
2400   case Intrinsic::dbg_declare: {  // llvm.dbg.declare
2401     Assert1(CI.getArgOperand(0) && isa<MDNode>(CI.getArgOperand(0)),
2402                 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2403     MDNode *MD = cast<MDNode>(CI.getArgOperand(0));
2404     Assert1(MD->getNumOperands() == 1,
2405                 "invalid llvm.dbg.declare intrinsic call 2", &CI);
2406   } break;
2407   case Intrinsic::memcpy:
2408   case Intrinsic::memmove:
2409   case Intrinsic::memset:
2410     Assert1(isa<ConstantInt>(CI.getArgOperand(3)),
2411             "alignment argument of memory intrinsics must be a constant int",
2412             &CI);
2413     Assert1(isa<ConstantInt>(CI.getArgOperand(4)),
2414             "isvolatile argument of memory intrinsics must be a constant int",
2415             &CI);
2416     break;
2417   case Intrinsic::gcroot:
2418   case Intrinsic::gcwrite:
2419   case Intrinsic::gcread:
2420     if (ID == Intrinsic::gcroot) {
2421       AllocaInst *AI =
2422         dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2423       Assert1(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
2424       Assert1(isa<Constant>(CI.getArgOperand(1)),
2425               "llvm.gcroot parameter #2 must be a constant.", &CI);
2426       if (!AI->getType()->getElementType()->isPointerTy()) {
2427         Assert1(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
2428                 "llvm.gcroot parameter #1 must either be a pointer alloca, "
2429                 "or argument #2 must be a non-null constant.", &CI);
2430       }
2431     }
2432
2433     Assert1(CI.getParent()->getParent()->hasGC(),
2434             "Enclosing function does not use GC.", &CI);
2435     break;
2436   case Intrinsic::init_trampoline:
2437     Assert1(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
2438             "llvm.init_trampoline parameter #2 must resolve to a function.",
2439             &CI);
2440     break;
2441   case Intrinsic::prefetch:
2442     Assert1(isa<ConstantInt>(CI.getArgOperand(1)) &&
2443             isa<ConstantInt>(CI.getArgOperand(2)) &&
2444             cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
2445             cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
2446             "invalid arguments to llvm.prefetch",
2447             &CI);
2448     break;
2449   case Intrinsic::stackprotector:
2450     Assert1(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
2451             "llvm.stackprotector parameter #2 must resolve to an alloca.",
2452             &CI);
2453     break;
2454   case Intrinsic::lifetime_start:
2455   case Intrinsic::lifetime_end:
2456   case Intrinsic::invariant_start:
2457     Assert1(isa<ConstantInt>(CI.getArgOperand(0)),
2458             "size argument of memory use markers must be a constant integer",
2459             &CI);
2460     break;
2461   case Intrinsic::invariant_end:
2462     Assert1(isa<ConstantInt>(CI.getArgOperand(1)),
2463             "llvm.invariant.end parameter #2 must be a constant integer", &CI);
2464     break;
2465   }
2466 }
2467
2468 void DebugInfoVerifier::verifyDebugInfo() {
2469   if (!VerifyDebugInfo)
2470     return;
2471
2472   DebugInfoFinder Finder;
2473   Finder.processModule(*M);
2474   processInstructions(Finder);
2475
2476   // Verify Debug Info.
2477   //
2478   // NOTE:  The loud braces are necessary for MSVC compatibility.
2479   for (DICompileUnit CU : Finder.compile_units()) {
2480     Assert1(CU.Verify(), "DICompileUnit does not Verify!", CU);
2481   }
2482   for (DISubprogram S : Finder.subprograms()) {
2483     Assert1(S.Verify(), "DISubprogram does not Verify!", S);
2484   }
2485   for (DIGlobalVariable GV : Finder.global_variables()) {
2486     Assert1(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
2487   }
2488   for (DIType T : Finder.types()) {
2489     Assert1(T.Verify(), "DIType does not Verify!", T);
2490   }
2491   for (DIScope S : Finder.scopes()) {
2492     Assert1(S.Verify(), "DIScope does not Verify!", S);
2493   }
2494 }
2495
2496 void DebugInfoVerifier::processInstructions(DebugInfoFinder &Finder) {
2497   for (const Function &F : *M)
2498     for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
2499       if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
2500         Finder.processLocation(*M, DILocation(MD));
2501       if (const CallInst *CI = dyn_cast<CallInst>(&*I))
2502         processCallInst(Finder, *CI);
2503     }
2504 }
2505
2506 void DebugInfoVerifier::processCallInst(DebugInfoFinder &Finder,
2507                                         const CallInst &CI) {
2508   if (Function *F = CI.getCalledFunction())
2509     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2510       switch (ID) {
2511       case Intrinsic::dbg_declare:
2512         Finder.processDeclare(*M, cast<DbgDeclareInst>(&CI));
2513         break;
2514       case Intrinsic::dbg_value:
2515         Finder.processValue(*M, cast<DbgValueInst>(&CI));
2516         break;
2517       default:
2518         break;
2519       }
2520 }
2521
2522 //===----------------------------------------------------------------------===//
2523 //  Implement the public interfaces to this file...
2524 //===----------------------------------------------------------------------===//
2525
2526 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
2527   Function &F = const_cast<Function &>(f);
2528   assert(!F.isDeclaration() && "Cannot verify external functions");
2529
2530   raw_null_ostream NullStr;
2531   Verifier V(OS ? *OS : NullStr);
2532
2533   // Note that this function's return value is inverted from what you would
2534   // expect of a function called "verify".
2535   return !V.verify(F);
2536 }
2537
2538 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
2539   raw_null_ostream NullStr;
2540   Verifier V(OS ? *OS : NullStr);
2541
2542   bool Broken = false;
2543   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
2544     if (!I->isDeclaration())
2545       Broken |= !V.verify(*I);
2546
2547   // Note that this function's return value is inverted from what you would
2548   // expect of a function called "verify".
2549   DebugInfoVerifier DIV(OS ? *OS : NullStr);
2550   return !V.verify(M) || !DIV.verify(M) || Broken;
2551 }
2552
2553 namespace {
2554 struct VerifierLegacyPass : public FunctionPass {
2555   static char ID;
2556
2557   Verifier V;
2558   bool FatalErrors;
2559
2560   VerifierLegacyPass() : FunctionPass(ID), FatalErrors(true) {
2561     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2562   }
2563   explicit VerifierLegacyPass(bool FatalErrors)
2564       : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
2565     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2566   }
2567
2568   bool runOnFunction(Function &F) override {
2569     if (!V.verify(F) && FatalErrors)
2570       report_fatal_error("Broken function found, compilation aborted!");
2571
2572     return false;
2573   }
2574
2575   bool doFinalization(Module &M) override {
2576     if (!V.verify(M) && FatalErrors)
2577       report_fatal_error("Broken module found, compilation aborted!");
2578
2579     return false;
2580   }
2581
2582   void getAnalysisUsage(AnalysisUsage &AU) const override {
2583     AU.setPreservesAll();
2584   }
2585 };
2586 struct DebugInfoVerifierLegacyPass : public ModulePass {
2587   static char ID;
2588
2589   DebugInfoVerifier V;
2590   bool FatalErrors;
2591
2592   DebugInfoVerifierLegacyPass() : ModulePass(ID), FatalErrors(true) {
2593     initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2594   }
2595   explicit DebugInfoVerifierLegacyPass(bool FatalErrors)
2596       : ModulePass(ID), V(dbgs()), FatalErrors(FatalErrors) {
2597     initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2598   }
2599
2600   bool runOnModule(Module &M) override {
2601     if (!V.verify(M) && FatalErrors)
2602       report_fatal_error("Broken debug info found, compilation aborted!");
2603
2604     return false;
2605   }
2606
2607   void getAnalysisUsage(AnalysisUsage &AU) const override {
2608     AU.setPreservesAll();
2609   }
2610 };
2611 }
2612
2613 char VerifierLegacyPass::ID = 0;
2614 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
2615
2616 char DebugInfoVerifierLegacyPass::ID = 0;
2617 INITIALIZE_PASS(DebugInfoVerifierLegacyPass, "verify-di", "Debug Info Verifier",
2618                 false, false)
2619
2620 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
2621   return new VerifierLegacyPass(FatalErrors);
2622 }
2623
2624 ModulePass *llvm::createDebugInfoVerifierPass(bool FatalErrors) {
2625   return new DebugInfoVerifierLegacyPass(FatalErrors);
2626 }
2627
2628 PreservedAnalyses VerifierPass::run(Module *M) {
2629   if (verifyModule(*M, &dbgs()) && FatalErrors)
2630     report_fatal_error("Broken module found, compilation aborted!");
2631
2632   return PreservedAnalyses::all();
2633 }
2634
2635 PreservedAnalyses VerifierPass::run(Function *F) {
2636   if (verifyFunction(*F, &dbgs()) && FatalErrors)
2637     report_fatal_error("Broken function found, compilation aborted!");
2638
2639   return PreservedAnalyses::all();
2640 }