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