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