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