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