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