37b56f8efc769aa21cf0a96a2a13b9e899948714
[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 //  * Landingpad instructions must be in a function with a personality function.
43 //  * All other things that are tested by asserts spread about the code...
44 //
45 //===----------------------------------------------------------------------===//
46
47 #include "llvm/IR/Verifier.h"
48 #include "llvm/ADT/MapVector.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/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
77 #include <algorithm>
78 #include <cstdarg>
79 using namespace llvm;
80
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
82
83 namespace {
84 struct VerifierSupport {
85   raw_ostream &OS;
86   const Module *M;
87
88   /// \brief Track the brokenness of the module while recursively visiting.
89   bool Broken;
90
91   explicit VerifierSupport(raw_ostream &OS)
92       : OS(OS), M(nullptr), Broken(false) {}
93
94 private:
95   template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
96     Write(&*I);
97   }
98
99   void Write(const Module *M) {
100     if (!M)
101       return;
102     OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
103   }
104
105   void Write(const Value *V) {
106     if (!V)
107       return;
108     if (isa<Instruction>(V)) {
109       OS << *V << '\n';
110     } else {
111       V->printAsOperand(OS, true, M);
112       OS << '\n';
113     }
114   }
115   void Write(ImmutableCallSite CS) {
116     Write(CS.getInstruction());
117   }
118
119   void Write(const Metadata *MD) {
120     if (!MD)
121       return;
122     MD->print(OS, M);
123     OS << '\n';
124   }
125
126   template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
127     Write(MD.get());
128   }
129
130   void Write(const NamedMDNode *NMD) {
131     if (!NMD)
132       return;
133     NMD->print(OS);
134     OS << '\n';
135   }
136
137   void Write(Type *T) {
138     if (!T)
139       return;
140     OS << ' ' << *T;
141   }
142
143   void Write(const Comdat *C) {
144     if (!C)
145       return;
146     OS << *C;
147   }
148
149   template <typename T> void Write(ArrayRef<T> Vs) {
150     for (const T &V : Vs)
151       Write(V);
152   }
153
154   template <typename T1, typename... Ts>
155   void WriteTs(const T1 &V1, const Ts &... Vs) {
156     Write(V1);
157     WriteTs(Vs...);
158   }
159
160   template <typename... Ts> void WriteTs() {}
161
162 public:
163   /// \brief A check failed, so printout out the condition and the message.
164   ///
165   /// This provides a nice place to put a breakpoint if you want to see why
166   /// something is not correct.
167   void CheckFailed(const Twine &Message) {
168     OS << Message << '\n';
169     Broken = true;
170   }
171
172   /// \brief A check failed (with values to print).
173   ///
174   /// This calls the Message-only version so that the above is easier to set a
175   /// breakpoint on.
176   template <typename T1, typename... Ts>
177   void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
178     CheckFailed(Message);
179     WriteTs(V1, Vs...);
180   }
181 };
182
183 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
184   friend class InstVisitor<Verifier>;
185
186   LLVMContext *Context;
187   DominatorTree DT;
188
189   /// \brief When verifying a basic block, keep track of all of the
190   /// instructions we have seen so far.
191   ///
192   /// This allows us to do efficient dominance checks for the case when an
193   /// instruction has an operand that is an instruction in the same block.
194   SmallPtrSet<Instruction *, 16> InstsInThisBlock;
195
196   /// \brief Keep track of the metadata nodes that have been checked already.
197   SmallPtrSet<const Metadata *, 32> MDNodes;
198
199   /// \brief Track unresolved string-based type references.
200   SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
201
202   /// \brief The result type for a landingpad.
203   Type *LandingPadResultTy;
204
205   /// \brief Whether we've seen a call to @llvm.localescape in this function
206   /// already.
207   bool SawFrameEscape;
208
209   /// Stores the count of how many objects were passed to llvm.localescape for a
210   /// given function and the largest index passed to llvm.localrecover.
211   DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
212
213   // Maps catchswitches and cleanuppads that unwind to siblings to the
214   // terminators that indicate the unwind, used to detect cycles therein.
215   MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
216
217   /// Cache of constants visited in search of ConstantExprs.
218   SmallPtrSet<const Constant *, 32> ConstantExprVisited;
219
220   void checkAtomicMemAccessSize(const Module *M, Type *Ty,
221                                 const Instruction *I);
222 public:
223   explicit Verifier(raw_ostream &OS)
224       : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
225         SawFrameEscape(false) {}
226
227   bool verify(const Function &F) {
228     M = F.getParent();
229     Context = &M->getContext();
230
231     // First ensure the function is well-enough formed to compute dominance
232     // information.
233     if (F.empty()) {
234       OS << "Function '" << F.getName()
235          << "' does not contain an entry block!\n";
236       return false;
237     }
238     for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
239       if (I->empty() || !I->back().isTerminator()) {
240         OS << "Basic Block in function '" << F.getName()
241            << "' does not have terminator!\n";
242         I->printAsOperand(OS, true);
243         OS << "\n";
244         return false;
245       }
246     }
247
248     // Now directly compute a dominance tree. We don't rely on the pass
249     // manager to provide this as it isolates us from a potentially
250     // out-of-date dominator tree and makes it significantly more complex to
251     // run this code outside of a pass manager.
252     // FIXME: It's really gross that we have to cast away constness here.
253     DT.recalculate(const_cast<Function &>(F));
254
255     Broken = false;
256     // FIXME: We strip const here because the inst visitor strips const.
257     visit(const_cast<Function &>(F));
258     verifySiblingFuncletUnwinds();
259     InstsInThisBlock.clear();
260     LandingPadResultTy = nullptr;
261     SawFrameEscape = false;
262     SiblingFuncletInfo.clear();
263
264     return !Broken;
265   }
266
267   bool verify(const Module &M) {
268     this->M = &M;
269     Context = &M.getContext();
270     Broken = false;
271
272     // Scan through, checking all of the external function's linkage now...
273     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
274       visitGlobalValue(*I);
275
276       // Check to make sure function prototypes are okay.
277       if (I->isDeclaration())
278         visitFunction(*I);
279     }
280
281     // Now that we've visited every function, verify that we never asked to
282     // recover a frame index that wasn't escaped.
283     verifyFrameRecoverIndices();
284
285     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
286          I != E; ++I)
287       visitGlobalVariable(*I);
288
289     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
290          I != E; ++I)
291       visitGlobalAlias(*I);
292
293     for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
294                                                E = M.named_metadata_end();
295          I != E; ++I)
296       visitNamedMDNode(*I);
297
298     for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
299       visitComdat(SMEC.getValue());
300
301     visitModuleFlags(M);
302     visitModuleIdents(M);
303
304     // Verify type referneces last.
305     verifyTypeRefs();
306
307     return !Broken;
308   }
309
310 private:
311   // Verification methods...
312   void visitGlobalValue(const GlobalValue &GV);
313   void visitGlobalVariable(const GlobalVariable &GV);
314   void visitGlobalAlias(const GlobalAlias &GA);
315   void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
316   void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
317                            const GlobalAlias &A, const Constant &C);
318   void visitNamedMDNode(const NamedMDNode &NMD);
319   void visitMDNode(const MDNode &MD);
320   void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
321   void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
322   void visitComdat(const Comdat &C);
323   void visitModuleIdents(const Module &M);
324   void visitModuleFlags(const Module &M);
325   void visitModuleFlag(const MDNode *Op,
326                        DenseMap<const MDString *, const MDNode *> &SeenIDs,
327                        SmallVectorImpl<const MDNode *> &Requirements);
328   void visitFunction(const Function &F);
329   void visitBasicBlock(BasicBlock &BB);
330   void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
331   void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
332
333   template <class Ty> bool isValidMetadataArray(const MDTuple &N);
334 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
335 #include "llvm/IR/Metadata.def"
336   void visitDIScope(const DIScope &N);
337   void visitDIVariable(const DIVariable &N);
338   void visitDILexicalBlockBase(const DILexicalBlockBase &N);
339   void visitDITemplateParameter(const DITemplateParameter &N);
340
341   void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
342
343   /// \brief Check for a valid string-based type reference.
344   ///
345   /// Checks if \c MD is a string-based type reference.  If it is, keeps track
346   /// of it (and its user, \c N) for error messages later.
347   bool isValidUUID(const MDNode &N, const Metadata *MD);
348
349   /// \brief Check for a valid type reference.
350   ///
351   /// Checks for subclasses of \a DIType, or \a isValidUUID().
352   bool isTypeRef(const MDNode &N, const Metadata *MD);
353
354   /// \brief Check for a valid scope reference.
355   ///
356   /// Checks for subclasses of \a DIScope, or \a isValidUUID().
357   bool isScopeRef(const MDNode &N, const Metadata *MD);
358
359   /// \brief Check for a valid debug info reference.
360   ///
361   /// Checks for subclasses of \a DINode, or \a isValidUUID().
362   bool isDIRef(const MDNode &N, const Metadata *MD);
363
364   // InstVisitor overrides...
365   using InstVisitor<Verifier>::visit;
366   void visit(Instruction &I);
367
368   void visitTruncInst(TruncInst &I);
369   void visitZExtInst(ZExtInst &I);
370   void visitSExtInst(SExtInst &I);
371   void visitFPTruncInst(FPTruncInst &I);
372   void visitFPExtInst(FPExtInst &I);
373   void visitFPToUIInst(FPToUIInst &I);
374   void visitFPToSIInst(FPToSIInst &I);
375   void visitUIToFPInst(UIToFPInst &I);
376   void visitSIToFPInst(SIToFPInst &I);
377   void visitIntToPtrInst(IntToPtrInst &I);
378   void visitPtrToIntInst(PtrToIntInst &I);
379   void visitBitCastInst(BitCastInst &I);
380   void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
381   void visitPHINode(PHINode &PN);
382   void visitBinaryOperator(BinaryOperator &B);
383   void visitICmpInst(ICmpInst &IC);
384   void visitFCmpInst(FCmpInst &FC);
385   void visitExtractElementInst(ExtractElementInst &EI);
386   void visitInsertElementInst(InsertElementInst &EI);
387   void visitShuffleVectorInst(ShuffleVectorInst &EI);
388   void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
389   void visitCallInst(CallInst &CI);
390   void visitInvokeInst(InvokeInst &II);
391   void visitGetElementPtrInst(GetElementPtrInst &GEP);
392   void visitLoadInst(LoadInst &LI);
393   void visitStoreInst(StoreInst &SI);
394   void verifyDominatesUse(Instruction &I, unsigned i);
395   void visitInstruction(Instruction &I);
396   void visitTerminatorInst(TerminatorInst &I);
397   void visitBranchInst(BranchInst &BI);
398   void visitReturnInst(ReturnInst &RI);
399   void visitSwitchInst(SwitchInst &SI);
400   void visitIndirectBrInst(IndirectBrInst &BI);
401   void visitSelectInst(SelectInst &SI);
402   void visitUserOp1(Instruction &I);
403   void visitUserOp2(Instruction &I) { visitUserOp1(I); }
404   void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
405   template <class DbgIntrinsicTy>
406   void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
407   void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
408   void visitAtomicRMWInst(AtomicRMWInst &RMWI);
409   void visitFenceInst(FenceInst &FI);
410   void visitAllocaInst(AllocaInst &AI);
411   void visitExtractValueInst(ExtractValueInst &EVI);
412   void visitInsertValueInst(InsertValueInst &IVI);
413   void visitEHPadPredecessors(Instruction &I);
414   void visitLandingPadInst(LandingPadInst &LPI);
415   void visitCatchPadInst(CatchPadInst &CPI);
416   void visitCatchReturnInst(CatchReturnInst &CatchReturn);
417   void visitCleanupPadInst(CleanupPadInst &CPI);
418   void visitFuncletPadInst(FuncletPadInst &FPI);
419   void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
420   void visitCleanupReturnInst(CleanupReturnInst &CRI);
421
422   void VerifyCallSite(CallSite CS);
423   void verifyMustTailCall(CallInst &CI);
424   bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
425                         unsigned ArgNo, std::string &Suffix);
426   bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
427                            SmallVectorImpl<Type *> &ArgTys);
428   bool VerifyIntrinsicIsVarArg(bool isVarArg,
429                                ArrayRef<Intrinsic::IITDescriptor> &Infos);
430   bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
431   void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
432                             const Value *V);
433   void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
434                             bool isReturnValue, const Value *V);
435   void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
436                            const Value *V);
437   void VerifyFunctionMetadata(
438       const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
439
440   void visitConstantExprsRecursively(const Constant *EntryC);
441   void visitConstantExpr(const ConstantExpr *CE);
442   void VerifyStatepoint(ImmutableCallSite CS);
443   void verifyFrameRecoverIndices();
444   void verifySiblingFuncletUnwinds();
445
446   // Module-level debug info verification...
447   void verifyTypeRefs();
448   template <class MapTy>
449   void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
450                                 const MapTy &TypeRefs);
451   void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
452 };
453 } // End anonymous namespace
454
455 // Assert - We know that cond should be true, if not print an error message.
456 #define Assert(C, ...) \
457   do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
458
459 void Verifier::visit(Instruction &I) {
460   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
461     Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
462   InstVisitor<Verifier>::visit(I);
463 }
464
465
466 void Verifier::visitGlobalValue(const GlobalValue &GV) {
467   Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
468              GV.hasExternalWeakLinkage(),
469          "Global is external, but doesn't have external or weak linkage!", &GV);
470
471   Assert(GV.getAlignment() <= Value::MaximumAlignment,
472          "huge alignment values are unsupported", &GV);
473   Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
474          "Only global variables can have appending linkage!", &GV);
475
476   if (GV.hasAppendingLinkage()) {
477     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
478     Assert(GVar && GVar->getValueType()->isArrayTy(),
479            "Only global arrays can have appending linkage!", GVar);
480   }
481
482   if (GV.isDeclarationForLinker())
483     Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
484 }
485
486 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
487   if (GV.hasInitializer()) {
488     Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
489            "Global variable initializer type does not match global "
490            "variable type!",
491            &GV);
492
493     // If the global has common linkage, it must have a zero initializer and
494     // cannot be constant.
495     if (GV.hasCommonLinkage()) {
496       Assert(GV.getInitializer()->isNullValue(),
497              "'common' global must have a zero initializer!", &GV);
498       Assert(!GV.isConstant(), "'common' global may not be marked constant!",
499              &GV);
500       Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
501     }
502   } else {
503     Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
504            "invalid linkage type for global declaration", &GV);
505   }
506
507   if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
508                        GV.getName() == "llvm.global_dtors")) {
509     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
510            "invalid linkage for intrinsic global variable", &GV);
511     // Don't worry about emitting an error for it not being an array,
512     // visitGlobalValue will complain on appending non-array.
513     if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
514       StructType *STy = dyn_cast<StructType>(ATy->getElementType());
515       PointerType *FuncPtrTy =
516           FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
517       // FIXME: Reject the 2-field form in LLVM 4.0.
518       Assert(STy &&
519                  (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
520                  STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
521                  STy->getTypeAtIndex(1) == FuncPtrTy,
522              "wrong type for intrinsic global variable", &GV);
523       if (STy->getNumElements() == 3) {
524         Type *ETy = STy->getTypeAtIndex(2);
525         Assert(ETy->isPointerTy() &&
526                    cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
527                "wrong type for intrinsic global variable", &GV);
528       }
529     }
530   }
531
532   if (GV.hasName() && (GV.getName() == "llvm.used" ||
533                        GV.getName() == "llvm.compiler.used")) {
534     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
535            "invalid linkage for intrinsic global variable", &GV);
536     Type *GVType = GV.getValueType();
537     if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
538       PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
539       Assert(PTy, "wrong type for intrinsic global variable", &GV);
540       if (GV.hasInitializer()) {
541         const Constant *Init = GV.getInitializer();
542         const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
543         Assert(InitArray, "wrong initalizer for intrinsic global variable",
544                Init);
545         for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
546           Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
547           Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
548                      isa<GlobalAlias>(V),
549                  "invalid llvm.used member", V);
550           Assert(V->hasName(), "members of llvm.used must be named", V);
551         }
552       }
553     }
554   }
555
556   Assert(!GV.hasDLLImportStorageClass() ||
557              (GV.isDeclaration() && GV.hasExternalLinkage()) ||
558              GV.hasAvailableExternallyLinkage(),
559          "Global is marked as dllimport, but not external", &GV);
560
561   if (!GV.hasInitializer()) {
562     visitGlobalValue(GV);
563     return;
564   }
565
566   // Walk any aggregate initializers looking for bitcasts between address spaces
567   visitConstantExprsRecursively(GV.getInitializer());
568
569   visitGlobalValue(GV);
570 }
571
572 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
573   SmallPtrSet<const GlobalAlias*, 4> Visited;
574   Visited.insert(&GA);
575   visitAliaseeSubExpr(Visited, GA, C);
576 }
577
578 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
579                                    const GlobalAlias &GA, const Constant &C) {
580   if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
581     Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
582            &GA);
583
584     if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
585       Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
586
587       Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
588              &GA);
589     } else {
590       // Only continue verifying subexpressions of GlobalAliases.
591       // Do not recurse into global initializers.
592       return;
593     }
594   }
595
596   if (const auto *CE = dyn_cast<ConstantExpr>(&C))
597     visitConstantExprsRecursively(CE);
598
599   for (const Use &U : C.operands()) {
600     Value *V = &*U;
601     if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
602       visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
603     else if (const auto *C2 = dyn_cast<Constant>(V))
604       visitAliaseeSubExpr(Visited, GA, *C2);
605   }
606 }
607
608 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
609   Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
610          "Alias should have private, internal, linkonce, weak, linkonce_odr, "
611          "weak_odr, or external linkage!",
612          &GA);
613   const Constant *Aliasee = GA.getAliasee();
614   Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
615   Assert(GA.getType() == Aliasee->getType(),
616          "Alias and aliasee types should match!", &GA);
617
618   Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
619          "Aliasee should be either GlobalValue or ConstantExpr", &GA);
620
621   visitAliaseeSubExpr(GA, *Aliasee);
622
623   visitGlobalValue(GA);
624 }
625
626 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
627   for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
628     MDNode *MD = NMD.getOperand(i);
629
630     if (NMD.getName() == "llvm.dbg.cu") {
631       Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
632     }
633
634     if (!MD)
635       continue;
636
637     visitMDNode(*MD);
638   }
639 }
640
641 void Verifier::visitMDNode(const MDNode &MD) {
642   // Only visit each node once.  Metadata can be mutually recursive, so this
643   // avoids infinite recursion here, as well as being an optimization.
644   if (!MDNodes.insert(&MD).second)
645     return;
646
647   switch (MD.getMetadataID()) {
648   default:
649     llvm_unreachable("Invalid MDNode subclass");
650   case Metadata::MDTupleKind:
651     break;
652 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
653   case Metadata::CLASS##Kind:                                                  \
654     visit##CLASS(cast<CLASS>(MD));                                             \
655     break;
656 #include "llvm/IR/Metadata.def"
657   }
658
659   for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
660     Metadata *Op = MD.getOperand(i);
661     if (!Op)
662       continue;
663     Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
664            &MD, Op);
665     if (auto *N = dyn_cast<MDNode>(Op)) {
666       visitMDNode(*N);
667       continue;
668     }
669     if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
670       visitValueAsMetadata(*V, nullptr);
671       continue;
672     }
673   }
674
675   // Check these last, so we diagnose problems in operands first.
676   Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
677   Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
678 }
679
680 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
681   Assert(MD.getValue(), "Expected valid value", &MD);
682   Assert(!MD.getValue()->getType()->isMetadataTy(),
683          "Unexpected metadata round-trip through values", &MD, MD.getValue());
684
685   auto *L = dyn_cast<LocalAsMetadata>(&MD);
686   if (!L)
687     return;
688
689   Assert(F, "function-local metadata used outside a function", L);
690
691   // If this was an instruction, bb, or argument, verify that it is in the
692   // function that we expect.
693   Function *ActualF = nullptr;
694   if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
695     Assert(I->getParent(), "function-local metadata not in basic block", L, I);
696     ActualF = I->getParent()->getParent();
697   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
698     ActualF = BB->getParent();
699   else if (Argument *A = dyn_cast<Argument>(L->getValue()))
700     ActualF = A->getParent();
701   assert(ActualF && "Unimplemented function local metadata case!");
702
703   Assert(ActualF == F, "function-local metadata used in wrong function", L);
704 }
705
706 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
707   Metadata *MD = MDV.getMetadata();
708   if (auto *N = dyn_cast<MDNode>(MD)) {
709     visitMDNode(*N);
710     return;
711   }
712
713   // Only visit each node once.  Metadata can be mutually recursive, so this
714   // avoids infinite recursion here, as well as being an optimization.
715   if (!MDNodes.insert(MD).second)
716     return;
717
718   if (auto *V = dyn_cast<ValueAsMetadata>(MD))
719     visitValueAsMetadata(*V, F);
720 }
721
722 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
723   auto *S = dyn_cast<MDString>(MD);
724   if (!S)
725     return false;
726   if (S->getString().empty())
727     return false;
728
729   // Keep track of names of types referenced via UUID so we can check that they
730   // actually exist.
731   UnresolvedTypeRefs.insert(std::make_pair(S, &N));
732   return true;
733 }
734
735 /// \brief Check if a value can be a reference to a type.
736 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
737   return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
738 }
739
740 /// \brief Check if a value can be a ScopeRef.
741 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
742   return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
743 }
744
745 /// \brief Check if a value can be a debug info ref.
746 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
747   return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
748 }
749
750 template <class Ty>
751 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
752   for (Metadata *MD : N.operands()) {
753     if (MD) {
754       if (!isa<Ty>(MD))
755         return false;
756     } else {
757       if (!AllowNull)
758         return false;
759     }
760   }
761   return true;
762 }
763
764 template <class Ty>
765 bool isValidMetadataArray(const MDTuple &N) {
766   return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
767 }
768
769 template <class Ty>
770 bool isValidMetadataNullArray(const MDTuple &N) {
771   return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
772 }
773
774 void Verifier::visitDILocation(const DILocation &N) {
775   Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
776          "location requires a valid scope", &N, N.getRawScope());
777   if (auto *IA = N.getRawInlinedAt())
778     Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
779 }
780
781 void Verifier::visitGenericDINode(const GenericDINode &N) {
782   Assert(N.getTag(), "invalid tag", &N);
783 }
784
785 void Verifier::visitDIScope(const DIScope &N) {
786   if (auto *F = N.getRawFile())
787     Assert(isa<DIFile>(F), "invalid file", &N, F);
788 }
789
790 void Verifier::visitDISubrange(const DISubrange &N) {
791   Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
792   Assert(N.getCount() >= -1, "invalid subrange count", &N);
793 }
794
795 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
796   Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
797 }
798
799 void Verifier::visitDIBasicType(const DIBasicType &N) {
800   Assert(N.getTag() == dwarf::DW_TAG_base_type ||
801              N.getTag() == dwarf::DW_TAG_unspecified_type,
802          "invalid tag", &N);
803 }
804
805 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
806   // Common scope checks.
807   visitDIScope(N);
808
809   Assert(N.getTag() == dwarf::DW_TAG_typedef ||
810              N.getTag() == dwarf::DW_TAG_pointer_type ||
811              N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
812              N.getTag() == dwarf::DW_TAG_reference_type ||
813              N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
814              N.getTag() == dwarf::DW_TAG_const_type ||
815              N.getTag() == dwarf::DW_TAG_volatile_type ||
816              N.getTag() == dwarf::DW_TAG_restrict_type ||
817              N.getTag() == dwarf::DW_TAG_member ||
818              N.getTag() == dwarf::DW_TAG_inheritance ||
819              N.getTag() == dwarf::DW_TAG_friend,
820          "invalid tag", &N);
821   if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
822     Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
823            N.getExtraData());
824   }
825
826   Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
827   Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
828          N.getBaseType());
829 }
830
831 static bool hasConflictingReferenceFlags(unsigned Flags) {
832   return (Flags & DINode::FlagLValueReference) &&
833          (Flags & DINode::FlagRValueReference);
834 }
835
836 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
837   auto *Params = dyn_cast<MDTuple>(&RawParams);
838   Assert(Params, "invalid template params", &N, &RawParams);
839   for (Metadata *Op : Params->operands()) {
840     Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
841            Params, Op);
842   }
843 }
844
845 void Verifier::visitDICompositeType(const DICompositeType &N) {
846   // Common scope checks.
847   visitDIScope(N);
848
849   Assert(N.getTag() == dwarf::DW_TAG_array_type ||
850              N.getTag() == dwarf::DW_TAG_structure_type ||
851              N.getTag() == dwarf::DW_TAG_union_type ||
852              N.getTag() == dwarf::DW_TAG_enumeration_type ||
853              N.getTag() == dwarf::DW_TAG_class_type,
854          "invalid tag", &N);
855
856   Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
857   Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
858          N.getBaseType());
859
860   Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
861          "invalid composite elements", &N, N.getRawElements());
862   Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
863          N.getRawVTableHolder());
864   Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
865          &N);
866   if (auto *Params = N.getRawTemplateParams())
867     visitTemplateParams(N, *Params);
868
869   if (N.getTag() == dwarf::DW_TAG_class_type ||
870       N.getTag() == dwarf::DW_TAG_union_type) {
871     Assert(N.getFile() && !N.getFile()->getFilename().empty(),
872            "class/union requires a filename", &N, N.getFile());
873   }
874 }
875
876 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
877   Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
878   if (auto *Types = N.getRawTypeArray()) {
879     Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
880     for (Metadata *Ty : N.getTypeArray()->operands()) {
881       Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
882     }
883   }
884   Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
885          &N);
886 }
887
888 void Verifier::visitDIFile(const DIFile &N) {
889   Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
890 }
891
892 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
893   Assert(N.isDistinct(), "compile units must be distinct", &N);
894   Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
895
896   // Don't bother verifying the compilation directory or producer string
897   // as those could be empty.
898   Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
899          N.getRawFile());
900   Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
901          N.getFile());
902
903   if (auto *Array = N.getRawEnumTypes()) {
904     Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
905     for (Metadata *Op : N.getEnumTypes()->operands()) {
906       auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
907       Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
908              "invalid enum type", &N, N.getEnumTypes(), Op);
909     }
910   }
911   if (auto *Array = N.getRawRetainedTypes()) {
912     Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
913     for (Metadata *Op : N.getRetainedTypes()->operands()) {
914       Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
915     }
916   }
917   if (auto *Array = N.getRawSubprograms()) {
918     Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
919     for (Metadata *Op : N.getSubprograms()->operands()) {
920       Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
921     }
922   }
923   if (auto *Array = N.getRawGlobalVariables()) {
924     Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
925     for (Metadata *Op : N.getGlobalVariables()->operands()) {
926       Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
927              Op);
928     }
929   }
930   if (auto *Array = N.getRawImportedEntities()) {
931     Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
932     for (Metadata *Op : N.getImportedEntities()->operands()) {
933       Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
934              Op);
935     }
936   }
937   if (auto *Array = N.getRawMacros()) {
938     Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
939     for (Metadata *Op : N.getMacros()->operands()) {
940       Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
941     }
942   }
943 }
944
945 void Verifier::visitDISubprogram(const DISubprogram &N) {
946   Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
947   Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
948   if (auto *T = N.getRawType())
949     Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
950   Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
951          N.getRawContainingType());
952   if (auto *Params = N.getRawTemplateParams())
953     visitTemplateParams(N, *Params);
954   if (auto *S = N.getRawDeclaration()) {
955     Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
956            "invalid subprogram declaration", &N, S);
957   }
958   if (auto *RawVars = N.getRawVariables()) {
959     auto *Vars = dyn_cast<MDTuple>(RawVars);
960     Assert(Vars, "invalid variable list", &N, RawVars);
961     for (Metadata *Op : Vars->operands()) {
962       Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
963              Op);
964     }
965   }
966   Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
967          &N);
968
969   if (N.isDefinition())
970     Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
971 }
972
973 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
974   Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
975   Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
976          "invalid local scope", &N, N.getRawScope());
977 }
978
979 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
980   visitDILexicalBlockBase(N);
981
982   Assert(N.getLine() || !N.getColumn(),
983          "cannot have column info without line info", &N);
984 }
985
986 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
987   visitDILexicalBlockBase(N);
988 }
989
990 void Verifier::visitDINamespace(const DINamespace &N) {
991   Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
992   if (auto *S = N.getRawScope())
993     Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
994 }
995
996 void Verifier::visitDIMacro(const DIMacro &N) {
997   Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
998          N.getMacinfoType() == dwarf::DW_MACINFO_undef,
999          "invalid macinfo type", &N);
1000   Assert(!N.getName().empty(), "anonymous macro", &N);
1001   if (!N.getValue().empty()) {
1002     assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1003   }
1004 }
1005
1006 void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1007   Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1008          "invalid macinfo type", &N);
1009   if (auto *F = N.getRawFile())
1010     Assert(isa<DIFile>(F), "invalid file", &N, F);
1011
1012   if (auto *Array = N.getRawElements()) {
1013     Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1014     for (Metadata *Op : N.getElements()->operands()) {
1015       Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1016     }
1017   }
1018 }
1019
1020 void Verifier::visitDIModule(const DIModule &N) {
1021   Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1022   Assert(!N.getName().empty(), "anonymous module", &N);
1023 }
1024
1025 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1026   Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1027 }
1028
1029 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1030   visitDITemplateParameter(N);
1031
1032   Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1033          &N);
1034 }
1035
1036 void Verifier::visitDITemplateValueParameter(
1037     const DITemplateValueParameter &N) {
1038   visitDITemplateParameter(N);
1039
1040   Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1041              N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1042              N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1043          "invalid tag", &N);
1044 }
1045
1046 void Verifier::visitDIVariable(const DIVariable &N) {
1047   if (auto *S = N.getRawScope())
1048     Assert(isa<DIScope>(S), "invalid scope", &N, S);
1049   Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1050   if (auto *F = N.getRawFile())
1051     Assert(isa<DIFile>(F), "invalid file", &N, F);
1052 }
1053
1054 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1055   // Checks common to all variables.
1056   visitDIVariable(N);
1057
1058   Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1059   Assert(!N.getName().empty(), "missing global variable name", &N);
1060   if (auto *V = N.getRawVariable()) {
1061     Assert(isa<ConstantAsMetadata>(V) &&
1062                !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1063            "invalid global varaible ref", &N, V);
1064   }
1065   if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1066     Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1067            &N, Member);
1068   }
1069 }
1070
1071 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1072   // Checks common to all variables.
1073   visitDIVariable(N);
1074
1075   Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1076   Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1077          "local variable requires a valid scope", &N, N.getRawScope());
1078 }
1079
1080 void Verifier::visitDIExpression(const DIExpression &N) {
1081   Assert(N.isValid(), "invalid expression", &N);
1082 }
1083
1084 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1085   Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1086   if (auto *T = N.getRawType())
1087     Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1088   if (auto *F = N.getRawFile())
1089     Assert(isa<DIFile>(F), "invalid file", &N, F);
1090 }
1091
1092 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1093   Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1094              N.getTag() == dwarf::DW_TAG_imported_declaration,
1095          "invalid tag", &N);
1096   if (auto *S = N.getRawScope())
1097     Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1098   Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1099          N.getEntity());
1100 }
1101
1102 void Verifier::visitComdat(const Comdat &C) {
1103   // The Module is invalid if the GlobalValue has private linkage.  Entities
1104   // with private linkage don't have entries in the symbol table.
1105   if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1106     Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1107            GV);
1108 }
1109
1110 void Verifier::visitModuleIdents(const Module &M) {
1111   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1112   if (!Idents) 
1113     return;
1114   
1115   // llvm.ident takes a list of metadata entry. Each entry has only one string.
1116   // Scan each llvm.ident entry and make sure that this requirement is met.
1117   for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1118     const MDNode *N = Idents->getOperand(i);
1119     Assert(N->getNumOperands() == 1,
1120            "incorrect number of operands in llvm.ident metadata", N);
1121     Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1122            ("invalid value for llvm.ident metadata entry operand"
1123             "(the operand should be a string)"),
1124            N->getOperand(0));
1125   } 
1126 }
1127
1128 void Verifier::visitModuleFlags(const Module &M) {
1129   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1130   if (!Flags) return;
1131
1132   // Scan each flag, and track the flags and requirements.
1133   DenseMap<const MDString*, const MDNode*> SeenIDs;
1134   SmallVector<const MDNode*, 16> Requirements;
1135   for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1136     visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1137   }
1138
1139   // Validate that the requirements in the module are valid.
1140   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1141     const MDNode *Requirement = Requirements[I];
1142     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1143     const Metadata *ReqValue = Requirement->getOperand(1);
1144
1145     const MDNode *Op = SeenIDs.lookup(Flag);
1146     if (!Op) {
1147       CheckFailed("invalid requirement on flag, flag is not present in module",
1148                   Flag);
1149       continue;
1150     }
1151
1152     if (Op->getOperand(2) != ReqValue) {
1153       CheckFailed(("invalid requirement on flag, "
1154                    "flag does not have the required value"),
1155                   Flag);
1156       continue;
1157     }
1158   }
1159 }
1160
1161 void
1162 Verifier::visitModuleFlag(const MDNode *Op,
1163                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
1164                           SmallVectorImpl<const MDNode *> &Requirements) {
1165   // Each module flag should have three arguments, the merge behavior (a
1166   // constant int), the flag ID (an MDString), and the value.
1167   Assert(Op->getNumOperands() == 3,
1168          "incorrect number of operands in module flag", Op);
1169   Module::ModFlagBehavior MFB;
1170   if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1171     Assert(
1172         mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1173         "invalid behavior operand in module flag (expected constant integer)",
1174         Op->getOperand(0));
1175     Assert(false,
1176            "invalid behavior operand in module flag (unexpected constant)",
1177            Op->getOperand(0));
1178   }
1179   MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1180   Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1181          Op->getOperand(1));
1182
1183   // Sanity check the values for behaviors with additional requirements.
1184   switch (MFB) {
1185   case Module::Error:
1186   case Module::Warning:
1187   case Module::Override:
1188     // These behavior types accept any value.
1189     break;
1190
1191   case Module::Require: {
1192     // The value should itself be an MDNode with two operands, a flag ID (an
1193     // MDString), and a value.
1194     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1195     Assert(Value && Value->getNumOperands() == 2,
1196            "invalid value for 'require' module flag (expected metadata pair)",
1197            Op->getOperand(2));
1198     Assert(isa<MDString>(Value->getOperand(0)),
1199            ("invalid value for 'require' module flag "
1200             "(first value operand should be a string)"),
1201            Value->getOperand(0));
1202
1203     // Append it to the list of requirements, to check once all module flags are
1204     // scanned.
1205     Requirements.push_back(Value);
1206     break;
1207   }
1208
1209   case Module::Append:
1210   case Module::AppendUnique: {
1211     // These behavior types require the operand be an MDNode.
1212     Assert(isa<MDNode>(Op->getOperand(2)),
1213            "invalid value for 'append'-type module flag "
1214            "(expected a metadata node)",
1215            Op->getOperand(2));
1216     break;
1217   }
1218   }
1219
1220   // Unless this is a "requires" flag, check the ID is unique.
1221   if (MFB != Module::Require) {
1222     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1223     Assert(Inserted,
1224            "module flag identifiers must be unique (or of 'require' type)", ID);
1225   }
1226 }
1227
1228 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1229                                     bool isFunction, const Value *V) {
1230   unsigned Slot = ~0U;
1231   for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1232     if (Attrs.getSlotIndex(I) == Idx) {
1233       Slot = I;
1234       break;
1235     }
1236
1237   assert(Slot != ~0U && "Attribute set inconsistency!");
1238
1239   for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1240          I != E; ++I) {
1241     if (I->isStringAttribute())
1242       continue;
1243
1244     if (I->getKindAsEnum() == Attribute::NoReturn ||
1245         I->getKindAsEnum() == Attribute::NoUnwind ||
1246         I->getKindAsEnum() == Attribute::NoInline ||
1247         I->getKindAsEnum() == Attribute::AlwaysInline ||
1248         I->getKindAsEnum() == Attribute::OptimizeForSize ||
1249         I->getKindAsEnum() == Attribute::StackProtect ||
1250         I->getKindAsEnum() == Attribute::StackProtectReq ||
1251         I->getKindAsEnum() == Attribute::StackProtectStrong ||
1252         I->getKindAsEnum() == Attribute::SafeStack ||
1253         I->getKindAsEnum() == Attribute::NoRedZone ||
1254         I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1255         I->getKindAsEnum() == Attribute::Naked ||
1256         I->getKindAsEnum() == Attribute::InlineHint ||
1257         I->getKindAsEnum() == Attribute::StackAlignment ||
1258         I->getKindAsEnum() == Attribute::UWTable ||
1259         I->getKindAsEnum() == Attribute::NonLazyBind ||
1260         I->getKindAsEnum() == Attribute::ReturnsTwice ||
1261         I->getKindAsEnum() == Attribute::SanitizeAddress ||
1262         I->getKindAsEnum() == Attribute::SanitizeThread ||
1263         I->getKindAsEnum() == Attribute::SanitizeMemory ||
1264         I->getKindAsEnum() == Attribute::MinSize ||
1265         I->getKindAsEnum() == Attribute::NoDuplicate ||
1266         I->getKindAsEnum() == Attribute::Builtin ||
1267         I->getKindAsEnum() == Attribute::NoBuiltin ||
1268         I->getKindAsEnum() == Attribute::Cold ||
1269         I->getKindAsEnum() == Attribute::OptimizeNone ||
1270         I->getKindAsEnum() == Attribute::JumpTable ||
1271         I->getKindAsEnum() == Attribute::Convergent ||
1272         I->getKindAsEnum() == Attribute::ArgMemOnly ||
1273         I->getKindAsEnum() == Attribute::NoRecurse ||
1274         I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1275         I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
1276       if (!isFunction) {
1277         CheckFailed("Attribute '" + I->getAsString() +
1278                     "' only applies to functions!", V);
1279         return;
1280       }
1281     } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1282                I->getKindAsEnum() == Attribute::ReadNone) {
1283       if (Idx == 0) {
1284         CheckFailed("Attribute '" + I->getAsString() +
1285                     "' does not apply to function returns");
1286         return;
1287       }
1288     } else if (isFunction) {
1289       CheckFailed("Attribute '" + I->getAsString() +
1290                   "' does not apply to functions!", V);
1291       return;
1292     }
1293   }
1294 }
1295
1296 // VerifyParameterAttrs - Check the given attributes for an argument or return
1297 // value of the specified type.  The value V is printed in error messages.
1298 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1299                                     bool isReturnValue, const Value *V) {
1300   if (!Attrs.hasAttributes(Idx))
1301     return;
1302
1303   VerifyAttributeTypes(Attrs, Idx, false, V);
1304
1305   if (isReturnValue)
1306     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1307                !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1308                !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1309                !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1310                !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1311                !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1312            "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1313            "'returned' do not apply to return values!",
1314            V);
1315
1316   // Check for mutually incompatible attributes.  Only inreg is compatible with
1317   // sret.
1318   unsigned AttrCount = 0;
1319   AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1320   AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1321   AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1322                Attrs.hasAttribute(Idx, Attribute::InReg);
1323   AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1324   Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1325                          "and 'sret' are incompatible!",
1326          V);
1327
1328   Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1329            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1330          "Attributes "
1331          "'inalloca and readonly' are incompatible!",
1332          V);
1333
1334   Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1335            Attrs.hasAttribute(Idx, Attribute::Returned)),
1336          "Attributes "
1337          "'sret and returned' are incompatible!",
1338          V);
1339
1340   Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1341            Attrs.hasAttribute(Idx, Attribute::SExt)),
1342          "Attributes "
1343          "'zeroext and signext' are incompatible!",
1344          V);
1345
1346   Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1347            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1348          "Attributes "
1349          "'readnone and readonly' are incompatible!",
1350          V);
1351
1352   Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1353            Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1354          "Attributes "
1355          "'noinline and alwaysinline' are incompatible!",
1356          V);
1357
1358   Assert(!AttrBuilder(Attrs, Idx)
1359               .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1360          "Wrong types for attribute: " +
1361          AttributeSet::get(*Context, Idx,
1362                         AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1363          V);
1364
1365   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1366     SmallPtrSet<Type*, 4> Visited;
1367     if (!PTy->getElementType()->isSized(&Visited)) {
1368       Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1369                  !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1370              "Attributes 'byval' and 'inalloca' do not support unsized types!",
1371              V);
1372     }
1373   } else {
1374     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1375            "Attribute 'byval' only applies to parameters with pointer type!",
1376            V);
1377   }
1378 }
1379
1380 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1381 // The value V is printed in error messages.
1382 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1383                                    const Value *V) {
1384   if (Attrs.isEmpty())
1385     return;
1386
1387   bool SawNest = false;
1388   bool SawReturned = false;
1389   bool SawSRet = false;
1390
1391   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1392     unsigned Idx = Attrs.getSlotIndex(i);
1393
1394     Type *Ty;
1395     if (Idx == 0)
1396       Ty = FT->getReturnType();
1397     else if (Idx-1 < FT->getNumParams())
1398       Ty = FT->getParamType(Idx-1);
1399     else
1400       break;  // VarArgs attributes, verified elsewhere.
1401
1402     VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1403
1404     if (Idx == 0)
1405       continue;
1406
1407     if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1408       Assert(!SawNest, "More than one parameter has attribute nest!", V);
1409       SawNest = true;
1410     }
1411
1412     if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1413       Assert(!SawReturned, "More than one parameter has attribute returned!",
1414              V);
1415       Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1416              "Incompatible "
1417              "argument and return types for 'returned' attribute",
1418              V);
1419       SawReturned = true;
1420     }
1421
1422     if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1423       Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1424       Assert(Idx == 1 || Idx == 2,
1425              "Attribute 'sret' is not on first or second parameter!", V);
1426       SawSRet = true;
1427     }
1428
1429     if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1430       Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1431              V);
1432     }
1433   }
1434
1435   if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1436     return;
1437
1438   VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1439
1440   Assert(
1441       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1442         Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1443       "Attributes 'readnone and readonly' are incompatible!", V);
1444
1445   Assert(
1446       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1447         Attrs.hasAttribute(AttributeSet::FunctionIndex, 
1448                            Attribute::InaccessibleMemOrArgMemOnly)),
1449       "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1450
1451   Assert(
1452       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1453         Attrs.hasAttribute(AttributeSet::FunctionIndex, 
1454                            Attribute::InaccessibleMemOnly)),
1455       "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1456
1457   Assert(
1458       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1459         Attrs.hasAttribute(AttributeSet::FunctionIndex,
1460                            Attribute::AlwaysInline)),
1461       "Attributes 'noinline and alwaysinline' are incompatible!", V);
1462
1463   if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 
1464                          Attribute::OptimizeNone)) {
1465     Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1466            "Attribute 'optnone' requires 'noinline'!", V);
1467
1468     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1469                                Attribute::OptimizeForSize),
1470            "Attributes 'optsize and optnone' are incompatible!", V);
1471
1472     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1473            "Attributes 'minsize and optnone' are incompatible!", V);
1474   }
1475
1476   if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1477                          Attribute::JumpTable)) {
1478     const GlobalValue *GV = cast<GlobalValue>(V);
1479     Assert(GV->hasUnnamedAddr(),
1480            "Attribute 'jumptable' requires 'unnamed_addr'", V);
1481   }
1482 }
1483
1484 void Verifier::VerifyFunctionMetadata(
1485     const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1486   if (MDs.empty())
1487     return;
1488
1489   for (unsigned i = 0; i < MDs.size(); i++) {
1490     if (MDs[i].first == LLVMContext::MD_prof) {
1491       MDNode *MD = MDs[i].second;
1492       Assert(MD->getNumOperands() == 2,
1493              "!prof annotations should have exactly 2 operands", MD);
1494
1495       // Check first operand.
1496       Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1497              MD);
1498       Assert(isa<MDString>(MD->getOperand(0)),
1499              "expected string with name of the !prof annotation", MD);
1500       MDString *MDS = cast<MDString>(MD->getOperand(0));
1501       StringRef ProfName = MDS->getString();
1502       Assert(ProfName.equals("function_entry_count"),
1503              "first operand should be 'function_entry_count'", MD);
1504
1505       // Check second operand.
1506       Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1507              MD);
1508       Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1509              "expected integer argument to function_entry_count", MD);
1510     }
1511   }
1512 }
1513
1514 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1515   if (!ConstantExprVisited.insert(EntryC).second)
1516     return;
1517
1518   SmallVector<const Constant *, 16> Stack;
1519   Stack.push_back(EntryC);
1520
1521   while (!Stack.empty()) {
1522     const Constant *C = Stack.pop_back_val();
1523
1524     // Check this constant expression.
1525     if (const auto *CE = dyn_cast<ConstantExpr>(C))
1526       visitConstantExpr(CE);
1527
1528     // Visit all sub-expressions.
1529     for (const Use &U : C->operands()) {
1530       const auto *OpC = dyn_cast<Constant>(U);
1531       if (!OpC)
1532         continue;
1533       if (isa<GlobalValue>(OpC))
1534         continue; // Global values get visited separately.
1535       if (!ConstantExprVisited.insert(OpC).second)
1536         continue;
1537       Stack.push_back(OpC);
1538     }
1539   }
1540 }
1541
1542 void Verifier::visitConstantExpr(const ConstantExpr *CE) {
1543   if (CE->getOpcode() != Instruction::BitCast)
1544     return;
1545
1546   Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1547                                CE->getType()),
1548          "Invalid bitcast", CE);
1549 }
1550
1551 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1552   if (Attrs.getNumSlots() == 0)
1553     return true;
1554
1555   unsigned LastSlot = Attrs.getNumSlots() - 1;
1556   unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1557   if (LastIndex <= Params
1558       || (LastIndex == AttributeSet::FunctionIndex
1559           && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1560     return true;
1561
1562   return false;
1563 }
1564
1565 /// \brief Verify that statepoint intrinsic is well formed.
1566 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1567   assert(CS.getCalledFunction() &&
1568          CS.getCalledFunction()->getIntrinsicID() ==
1569            Intrinsic::experimental_gc_statepoint);
1570
1571   const Instruction &CI = *CS.getInstruction();
1572
1573   Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1574          !CS.onlyAccessesArgMemory(),
1575          "gc.statepoint must read and write all memory to preserve "
1576          "reordering restrictions required by safepoint semantics",
1577          &CI);
1578
1579   const Value *IDV = CS.getArgument(0);
1580   Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1581          &CI);
1582
1583   const Value *NumPatchBytesV = CS.getArgument(1);
1584   Assert(isa<ConstantInt>(NumPatchBytesV),
1585          "gc.statepoint number of patchable bytes must be a constant integer",
1586          &CI);
1587   const int64_t NumPatchBytes =
1588       cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1589   assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1590   Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1591                              "positive",
1592          &CI);
1593
1594   const Value *Target = CS.getArgument(2);
1595   auto *PT = dyn_cast<PointerType>(Target->getType());
1596   Assert(PT && PT->getElementType()->isFunctionTy(),
1597          "gc.statepoint callee must be of function pointer type", &CI, Target);
1598   FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1599
1600   const Value *NumCallArgsV = CS.getArgument(3);
1601   Assert(isa<ConstantInt>(NumCallArgsV),
1602          "gc.statepoint number of arguments to underlying call "
1603          "must be constant integer",
1604          &CI);
1605   const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1606   Assert(NumCallArgs >= 0,
1607          "gc.statepoint number of arguments to underlying call "
1608          "must be positive",
1609          &CI);
1610   const int NumParams = (int)TargetFuncType->getNumParams();
1611   if (TargetFuncType->isVarArg()) {
1612     Assert(NumCallArgs >= NumParams,
1613            "gc.statepoint mismatch in number of vararg call args", &CI);
1614
1615     // TODO: Remove this limitation
1616     Assert(TargetFuncType->getReturnType()->isVoidTy(),
1617            "gc.statepoint doesn't support wrapping non-void "
1618            "vararg functions yet",
1619            &CI);
1620   } else
1621     Assert(NumCallArgs == NumParams,
1622            "gc.statepoint mismatch in number of call args", &CI);
1623
1624   const Value *FlagsV = CS.getArgument(4);
1625   Assert(isa<ConstantInt>(FlagsV),
1626          "gc.statepoint flags must be constant integer", &CI);
1627   const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1628   Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1629          "unknown flag used in gc.statepoint flags argument", &CI);
1630
1631   // Verify that the types of the call parameter arguments match
1632   // the type of the wrapped callee.
1633   for (int i = 0; i < NumParams; i++) {
1634     Type *ParamType = TargetFuncType->getParamType(i);
1635     Type *ArgType = CS.getArgument(5 + i)->getType();
1636     Assert(ArgType == ParamType,
1637            "gc.statepoint call argument does not match wrapped "
1638            "function type",
1639            &CI);
1640   }
1641
1642   const int EndCallArgsInx = 4 + NumCallArgs;
1643
1644   const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1645   Assert(isa<ConstantInt>(NumTransitionArgsV),
1646          "gc.statepoint number of transition arguments "
1647          "must be constant integer",
1648          &CI);
1649   const int NumTransitionArgs =
1650       cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1651   Assert(NumTransitionArgs >= 0,
1652          "gc.statepoint number of transition arguments must be positive", &CI);
1653   const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1654
1655   const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1656   Assert(isa<ConstantInt>(NumDeoptArgsV),
1657          "gc.statepoint number of deoptimization arguments "
1658          "must be constant integer",
1659          &CI);
1660   const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1661   Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1662                             "must be positive",
1663          &CI);
1664
1665   const int ExpectedNumArgs =
1666       7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1667   Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1668          "gc.statepoint too few arguments according to length fields", &CI);
1669
1670   // Check that the only uses of this gc.statepoint are gc.result or 
1671   // gc.relocate calls which are tied to this statepoint and thus part
1672   // of the same statepoint sequence
1673   for (const User *U : CI.users()) {
1674     const CallInst *Call = dyn_cast<const CallInst>(U);
1675     Assert(Call, "illegal use of statepoint token", &CI, U);
1676     if (!Call) continue;
1677     Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
1678            "gc.result or gc.relocate are the only value uses"
1679            "of a gc.statepoint",
1680            &CI, U);
1681     if (isGCResult(Call)) {
1682       Assert(Call->getArgOperand(0) == &CI,
1683              "gc.result connected to wrong gc.statepoint", &CI, Call);
1684     } else if (isa<GCRelocateInst>(Call)) {
1685       Assert(Call->getArgOperand(0) == &CI,
1686              "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1687     }
1688   }
1689
1690   // Note: It is legal for a single derived pointer to be listed multiple
1691   // times.  It's non-optimal, but it is legal.  It can also happen after
1692   // insertion if we strip a bitcast away.
1693   // Note: It is really tempting to check that each base is relocated and
1694   // that a derived pointer is never reused as a base pointer.  This turns
1695   // out to be problematic since optimizations run after safepoint insertion
1696   // can recognize equality properties that the insertion logic doesn't know
1697   // about.  See example statepoint.ll in the verifier subdirectory
1698 }
1699
1700 void Verifier::verifyFrameRecoverIndices() {
1701   for (auto &Counts : FrameEscapeInfo) {
1702     Function *F = Counts.first;
1703     unsigned EscapedObjectCount = Counts.second.first;
1704     unsigned MaxRecoveredIndex = Counts.second.second;
1705     Assert(MaxRecoveredIndex <= EscapedObjectCount,
1706            "all indices passed to llvm.localrecover must be less than the "
1707            "number of arguments passed ot llvm.localescape in the parent "
1708            "function",
1709            F);
1710   }
1711 }
1712
1713 static Instruction *getSuccPad(TerminatorInst *Terminator) {
1714   BasicBlock *UnwindDest;
1715   if (auto *II = dyn_cast<InvokeInst>(Terminator))
1716     UnwindDest = II->getUnwindDest();
1717   else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1718     UnwindDest = CSI->getUnwindDest();
1719   else
1720     UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1721   return UnwindDest->getFirstNonPHI();
1722 }
1723
1724 void Verifier::verifySiblingFuncletUnwinds() {
1725   SmallPtrSet<Instruction *, 8> Visited;
1726   SmallPtrSet<Instruction *, 8> Active;
1727   for (const auto &Pair : SiblingFuncletInfo) {
1728     Instruction *PredPad = Pair.first;
1729     if (Visited.count(PredPad))
1730       continue;
1731     Active.insert(PredPad);
1732     TerminatorInst *Terminator = Pair.second;
1733     do {
1734       Instruction *SuccPad = getSuccPad(Terminator);
1735       if (Active.count(SuccPad)) {
1736         // Found a cycle; report error
1737         Instruction *CyclePad = SuccPad;
1738         SmallVector<Instruction *, 8> CycleNodes;
1739         do {
1740           CycleNodes.push_back(CyclePad);
1741           TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1742           if (CycleTerminator != CyclePad)
1743             CycleNodes.push_back(CycleTerminator);
1744           CyclePad = getSuccPad(CycleTerminator);
1745         } while (CyclePad != SuccPad);
1746         Assert(false, "EH pads can't handle each other's exceptions",
1747                ArrayRef<Instruction *>(CycleNodes));
1748       }
1749       // Don't re-walk a node we've already checked
1750       if (!Visited.insert(SuccPad).second)
1751         break;
1752       // Walk to this successor if it has a map entry.
1753       PredPad = SuccPad;
1754       auto TermI = SiblingFuncletInfo.find(PredPad);
1755       if (TermI == SiblingFuncletInfo.end())
1756         break;
1757       Terminator = TermI->second;
1758       Active.insert(PredPad);
1759     } while (true);
1760     // Each node only has one successor, so we've walked all the active
1761     // nodes' successors.
1762     Active.clear();
1763   }
1764 }
1765
1766 // visitFunction - Verify that a function is ok.
1767 //
1768 void Verifier::visitFunction(const Function &F) {
1769   // Check function arguments.
1770   FunctionType *FT = F.getFunctionType();
1771   unsigned NumArgs = F.arg_size();
1772
1773   Assert(Context == &F.getContext(),
1774          "Function context does not match Module context!", &F);
1775
1776   Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1777   Assert(FT->getNumParams() == NumArgs,
1778          "# formal arguments must match # of arguments for function type!", &F,
1779          FT);
1780   Assert(F.getReturnType()->isFirstClassType() ||
1781              F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1782          "Functions cannot return aggregate values!", &F);
1783
1784   Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1785          "Invalid struct return type!", &F);
1786
1787   AttributeSet Attrs = F.getAttributes();
1788
1789   Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1790          "Attribute after last parameter!", &F);
1791
1792   // Check function attributes.
1793   VerifyFunctionAttrs(FT, Attrs, &F);
1794
1795   // On function declarations/definitions, we do not support the builtin
1796   // attribute. We do not check this in VerifyFunctionAttrs since that is
1797   // checking for Attributes that can/can not ever be on functions.
1798   Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1799          "Attribute 'builtin' can only be applied to a callsite.", &F);
1800
1801   // Check that this function meets the restrictions on this calling convention.
1802   // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1803   // restrictions can be lifted.
1804   switch (F.getCallingConv()) {
1805   default:
1806   case CallingConv::C:
1807     break;
1808   case CallingConv::Fast:
1809   case CallingConv::Cold:
1810   case CallingConv::Intel_OCL_BI:
1811   case CallingConv::PTX_Kernel:
1812   case CallingConv::PTX_Device:
1813     Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1814                           "perfect forwarding!",
1815            &F);
1816     break;
1817   }
1818
1819   bool isLLVMdotName = F.getName().size() >= 5 &&
1820                        F.getName().substr(0, 5) == "llvm.";
1821
1822   // Check that the argument values match the function type for this function...
1823   unsigned i = 0;
1824   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1825        ++I, ++i) {
1826     Assert(I->getType() == FT->getParamType(i),
1827            "Argument value does not match function argument type!", I,
1828            FT->getParamType(i));
1829     Assert(I->getType()->isFirstClassType(),
1830            "Function arguments must have first-class types!", I);
1831     if (!isLLVMdotName) {
1832       Assert(!I->getType()->isMetadataTy(),
1833              "Function takes metadata but isn't an intrinsic", I, &F);
1834       Assert(!I->getType()->isTokenTy(),
1835              "Function takes token but isn't an intrinsic", I, &F);
1836     }
1837   }
1838
1839   if (!isLLVMdotName)
1840     Assert(!F.getReturnType()->isTokenTy(),
1841            "Functions returns a token but isn't an intrinsic", &F);
1842
1843   // Get the function metadata attachments.
1844   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1845   F.getAllMetadata(MDs);
1846   assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1847   VerifyFunctionMetadata(MDs);
1848
1849   // Check validity of the personality function
1850   if (F.hasPersonalityFn()) {
1851     auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1852     if (Per)
1853       Assert(Per->getParent() == F.getParent(),
1854              "Referencing personality function in another module!",
1855              &F, F.getParent(), Per, Per->getParent());
1856   }
1857
1858   if (F.isMaterializable()) {
1859     // Function has a body somewhere we can't see.
1860     Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1861            MDs.empty() ? nullptr : MDs.front().second);
1862   } else if (F.isDeclaration()) {
1863     Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1864            "invalid linkage type for function declaration", &F);
1865     Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1866            MDs.empty() ? nullptr : MDs.front().second);
1867     Assert(!F.hasPersonalityFn(),
1868            "Function declaration shouldn't have a personality routine", &F);
1869   } else {
1870     // Verify that this function (which has a body) is not named "llvm.*".  It
1871     // is not legal to define intrinsics.
1872     Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1873
1874     // Check the entry node
1875     const BasicBlock *Entry = &F.getEntryBlock();
1876     Assert(pred_empty(Entry),
1877            "Entry block to function must not have predecessors!", Entry);
1878
1879     // The address of the entry block cannot be taken, unless it is dead.
1880     if (Entry->hasAddressTaken()) {
1881       Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1882              "blockaddress may not be used with the entry block!", Entry);
1883     }
1884
1885     // Visit metadata attachments.
1886     for (const auto &I : MDs) {
1887       // Verify that the attachment is legal.
1888       switch (I.first) {
1889       default:
1890         break;
1891       case LLVMContext::MD_dbg:
1892         Assert(isa<DISubprogram>(I.second),
1893                "function !dbg attachment must be a subprogram", &F, I.second);
1894         break;
1895       }
1896
1897       // Verify the metadata itself.
1898       visitMDNode(*I.second);
1899     }
1900   }
1901
1902   // If this function is actually an intrinsic, verify that it is only used in
1903   // direct call/invokes, never having its "address taken".
1904   // Only do this if the module is materialized, otherwise we don't have all the
1905   // uses.
1906   if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
1907     const User *U;
1908     if (F.hasAddressTaken(&U))
1909       Assert(0, "Invalid user of intrinsic instruction!", U);
1910   }
1911
1912   Assert(!F.hasDLLImportStorageClass() ||
1913              (F.isDeclaration() && F.hasExternalLinkage()) ||
1914              F.hasAvailableExternallyLinkage(),
1915          "Function is marked as dllimport, but not external.", &F);
1916
1917   auto *N = F.getSubprogram();
1918   if (!N)
1919     return;
1920
1921   // Check that all !dbg attachments lead to back to N (or, at least, another
1922   // subprogram that describes the same function).
1923   //
1924   // FIXME: Check this incrementally while visiting !dbg attachments.
1925   // FIXME: Only check when N is the canonical subprogram for F.
1926   SmallPtrSet<const MDNode *, 32> Seen;
1927   for (auto &BB : F)
1928     for (auto &I : BB) {
1929       // Be careful about using DILocation here since we might be dealing with
1930       // broken code (this is the Verifier after all).
1931       DILocation *DL =
1932           dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1933       if (!DL)
1934         continue;
1935       if (!Seen.insert(DL).second)
1936         continue;
1937
1938       DILocalScope *Scope = DL->getInlinedAtScope();
1939       if (Scope && !Seen.insert(Scope).second)
1940         continue;
1941
1942       DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
1943
1944       // Scope and SP could be the same MDNode and we don't want to skip
1945       // validation in that case
1946       if (SP && ((Scope != SP) && !Seen.insert(SP).second))
1947         continue;
1948
1949       // FIXME: Once N is canonical, check "SP == &N".
1950       Assert(SP->describes(&F),
1951              "!dbg attachment points at wrong subprogram for function", N, &F,
1952              &I, DL, Scope, SP);
1953     }
1954 }
1955
1956 // verifyBasicBlock - Verify that a basic block is well formed...
1957 //
1958 void Verifier::visitBasicBlock(BasicBlock &BB) {
1959   InstsInThisBlock.clear();
1960
1961   // Ensure that basic blocks have terminators!
1962   Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1963
1964   // Check constraints that this basic block imposes on all of the PHI nodes in
1965   // it.
1966   if (isa<PHINode>(BB.front())) {
1967     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1968     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1969     std::sort(Preds.begin(), Preds.end());
1970     PHINode *PN;
1971     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1972       // Ensure that PHI nodes have at least one entry!
1973       Assert(PN->getNumIncomingValues() != 0,
1974              "PHI nodes must have at least one entry.  If the block is dead, "
1975              "the PHI should be removed!",
1976              PN);
1977       if (PN->getNumIncomingValues() != Preds.size()) {
1978         dbgs() << "Problematic function: \n" << *PN->getParent()->getParent() << "\n";
1979         dbgs() << "Problematic block: \n" << *PN->getParent() << "\n";
1980       }
1981       Assert(PN->getNumIncomingValues() == Preds.size(),
1982              "PHINode should have one entry for each predecessor of its "
1983              "parent basic block!",
1984              PN);
1985
1986       // Get and sort all incoming values in the PHI node...
1987       Values.clear();
1988       Values.reserve(PN->getNumIncomingValues());
1989       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1990         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1991                                         PN->getIncomingValue(i)));
1992       std::sort(Values.begin(), Values.end());
1993
1994       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1995         // Check to make sure that if there is more than one entry for a
1996         // particular basic block in this PHI node, that the incoming values are
1997         // all identical.
1998         //
1999         Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2000                    Values[i].second == Values[i - 1].second,
2001                "PHI node has multiple entries for the same basic block with "
2002                "different incoming values!",
2003                PN, Values[i].first, Values[i].second, Values[i - 1].second);
2004
2005         // Check to make sure that the predecessors and PHI node entries are
2006         // matched up.
2007         Assert(Values[i].first == Preds[i],
2008                "PHI node entries do not match predecessors!", PN,
2009                Values[i].first, Preds[i]);
2010       }
2011     }
2012   }
2013
2014   // Check that all instructions have their parent pointers set up correctly.
2015   for (auto &I : BB)
2016   {
2017     Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
2018   }
2019 }
2020
2021 void Verifier::visitTerminatorInst(TerminatorInst &I) {
2022   // Ensure that terminators only exist at the end of the basic block.
2023   Assert(&I == I.getParent()->getTerminator(),
2024          "Terminator found in the middle of a basic block!", I.getParent());
2025   visitInstruction(I);
2026 }
2027
2028 void Verifier::visitBranchInst(BranchInst &BI) {
2029   if (BI.isConditional()) {
2030     Assert(BI.getCondition()->getType()->isIntegerTy(1),
2031            "Branch condition is not 'i1' type!", &BI, BI.getCondition());
2032   }
2033   visitTerminatorInst(BI);
2034 }
2035
2036 void Verifier::visitReturnInst(ReturnInst &RI) {
2037   Function *F = RI.getParent()->getParent();
2038   unsigned N = RI.getNumOperands();
2039   if (F->getReturnType()->isVoidTy())
2040     Assert(N == 0,
2041            "Found return instr that returns non-void in Function of void "
2042            "return type!",
2043            &RI, F->getReturnType());
2044   else
2045     Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2046            "Function return type does not match operand "
2047            "type of return inst!",
2048            &RI, F->getReturnType());
2049
2050   // Check to make sure that the return value has necessary properties for
2051   // terminators...
2052   visitTerminatorInst(RI);
2053 }
2054
2055 void Verifier::visitSwitchInst(SwitchInst &SI) {
2056   // Check to make sure that all of the constants in the switch instruction
2057   // have the same type as the switched-on value.
2058   Type *SwitchTy = SI.getCondition()->getType();
2059   SmallPtrSet<ConstantInt*, 32> Constants;
2060   for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
2061     Assert(i.getCaseValue()->getType() == SwitchTy,
2062            "Switch constants must all be same type as switch value!", &SI);
2063     Assert(Constants.insert(i.getCaseValue()).second,
2064            "Duplicate integer as switch case", &SI, i.getCaseValue());
2065   }
2066
2067   visitTerminatorInst(SI);
2068 }
2069
2070 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
2071   Assert(BI.getAddress()->getType()->isPointerTy(),
2072          "Indirectbr operand must have pointer type!", &BI);
2073   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
2074     Assert(BI.getDestination(i)->getType()->isLabelTy(),
2075            "Indirectbr destinations must all have pointer type!", &BI);
2076
2077   visitTerminatorInst(BI);
2078 }
2079
2080 void Verifier::visitSelectInst(SelectInst &SI) {
2081   Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2082                                          SI.getOperand(2)),
2083          "Invalid operands for select instruction!", &SI);
2084
2085   Assert(SI.getTrueValue()->getType() == SI.getType(),
2086          "Select values must have same type as select instruction!", &SI);
2087   visitInstruction(SI);
2088 }
2089
2090 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2091 /// a pass, if any exist, it's an error.
2092 ///
2093 void Verifier::visitUserOp1(Instruction &I) {
2094   Assert(0, "User-defined operators should not live outside of a pass!", &I);
2095 }
2096
2097 void Verifier::visitTruncInst(TruncInst &I) {
2098   // Get the source and destination types
2099   Type *SrcTy = I.getOperand(0)->getType();
2100   Type *DestTy = I.getType();
2101
2102   // Get the size of the types in bits, we'll need this later
2103   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2104   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2105
2106   Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2107   Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2108   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2109          "trunc source and destination must both be a vector or neither", &I);
2110   Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
2111
2112   visitInstruction(I);
2113 }
2114
2115 void Verifier::visitZExtInst(ZExtInst &I) {
2116   // Get the source and destination types
2117   Type *SrcTy = I.getOperand(0)->getType();
2118   Type *DestTy = I.getType();
2119
2120   // Get the size of the types in bits, we'll need this later
2121   Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2122   Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2123   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2124          "zext source and destination must both be a vector or neither", &I);
2125   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2126   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2127
2128   Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
2129
2130   visitInstruction(I);
2131 }
2132
2133 void Verifier::visitSExtInst(SExtInst &I) {
2134   // Get the source and destination types
2135   Type *SrcTy = I.getOperand(0)->getType();
2136   Type *DestTy = I.getType();
2137
2138   // Get the size of the types in bits, we'll need this later
2139   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2140   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2141
2142   Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2143   Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2144   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2145          "sext source and destination must both be a vector or neither", &I);
2146   Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
2147
2148   visitInstruction(I);
2149 }
2150
2151 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2152   // Get the source and destination types
2153   Type *SrcTy = I.getOperand(0)->getType();
2154   Type *DestTy = I.getType();
2155   // Get the size of the types in bits, we'll need this later
2156   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2157   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2158
2159   Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2160   Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2161   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2162          "fptrunc source and destination must both be a vector or neither", &I);
2163   Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2164
2165   visitInstruction(I);
2166 }
2167
2168 void Verifier::visitFPExtInst(FPExtInst &I) {
2169   // Get the source and destination types
2170   Type *SrcTy = I.getOperand(0)->getType();
2171   Type *DestTy = I.getType();
2172
2173   // Get the size of the types in bits, we'll need this later
2174   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2175   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2176
2177   Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2178   Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2179   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2180          "fpext source and destination must both be a vector or neither", &I);
2181   Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2182
2183   visitInstruction(I);
2184 }
2185
2186 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2187   // Get the source and destination types
2188   Type *SrcTy = I.getOperand(0)->getType();
2189   Type *DestTy = I.getType();
2190
2191   bool SrcVec = SrcTy->isVectorTy();
2192   bool DstVec = DestTy->isVectorTy();
2193
2194   Assert(SrcVec == DstVec,
2195          "UIToFP source and dest must both be vector or scalar", &I);
2196   Assert(SrcTy->isIntOrIntVectorTy(),
2197          "UIToFP source must be integer or integer vector", &I);
2198   Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2199          &I);
2200
2201   if (SrcVec && DstVec)
2202     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2203                cast<VectorType>(DestTy)->getNumElements(),
2204            "UIToFP source and dest vector length mismatch", &I);
2205
2206   visitInstruction(I);
2207 }
2208
2209 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2210   // Get the source and destination types
2211   Type *SrcTy = I.getOperand(0)->getType();
2212   Type *DestTy = I.getType();
2213
2214   bool SrcVec = SrcTy->isVectorTy();
2215   bool DstVec = DestTy->isVectorTy();
2216
2217   Assert(SrcVec == DstVec,
2218          "SIToFP source and dest must both be vector or scalar", &I);
2219   Assert(SrcTy->isIntOrIntVectorTy(),
2220          "SIToFP source must be integer or integer vector", &I);
2221   Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2222          &I);
2223
2224   if (SrcVec && DstVec)
2225     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2226                cast<VectorType>(DestTy)->getNumElements(),
2227            "SIToFP source and dest vector length mismatch", &I);
2228
2229   visitInstruction(I);
2230 }
2231
2232 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2233   // Get the source and destination types
2234   Type *SrcTy = I.getOperand(0)->getType();
2235   Type *DestTy = I.getType();
2236
2237   bool SrcVec = SrcTy->isVectorTy();
2238   bool DstVec = DestTy->isVectorTy();
2239
2240   Assert(SrcVec == DstVec,
2241          "FPToUI source and dest must both be vector or scalar", &I);
2242   Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2243          &I);
2244   Assert(DestTy->isIntOrIntVectorTy(),
2245          "FPToUI result must be integer or integer vector", &I);
2246
2247   if (SrcVec && DstVec)
2248     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2249                cast<VectorType>(DestTy)->getNumElements(),
2250            "FPToUI source and dest vector length mismatch", &I);
2251
2252   visitInstruction(I);
2253 }
2254
2255 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2256   // Get the source and destination types
2257   Type *SrcTy = I.getOperand(0)->getType();
2258   Type *DestTy = I.getType();
2259
2260   bool SrcVec = SrcTy->isVectorTy();
2261   bool DstVec = DestTy->isVectorTy();
2262
2263   Assert(SrcVec == DstVec,
2264          "FPToSI source and dest must both be vector or scalar", &I);
2265   Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2266          &I);
2267   Assert(DestTy->isIntOrIntVectorTy(),
2268          "FPToSI result must be integer or integer vector", &I);
2269
2270   if (SrcVec && DstVec)
2271     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2272                cast<VectorType>(DestTy)->getNumElements(),
2273            "FPToSI source and dest vector length mismatch", &I);
2274
2275   visitInstruction(I);
2276 }
2277
2278 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2279   // Get the source and destination types
2280   Type *SrcTy = I.getOperand(0)->getType();
2281   Type *DestTy = I.getType();
2282
2283   Assert(SrcTy->getScalarType()->isPointerTy(),
2284          "PtrToInt source must be pointer", &I);
2285   Assert(DestTy->getScalarType()->isIntegerTy(),
2286          "PtrToInt result must be integral", &I);
2287   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2288          &I);
2289
2290   if (SrcTy->isVectorTy()) {
2291     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2292     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2293     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2294            "PtrToInt Vector width mismatch", &I);
2295   }
2296
2297   visitInstruction(I);
2298 }
2299
2300 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2301   // Get the source and destination types
2302   Type *SrcTy = I.getOperand(0)->getType();
2303   Type *DestTy = I.getType();
2304
2305   Assert(SrcTy->getScalarType()->isIntegerTy(),
2306          "IntToPtr source must be an integral", &I);
2307   Assert(DestTy->getScalarType()->isPointerTy(),
2308          "IntToPtr result must be a pointer", &I);
2309   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2310          &I);
2311   if (SrcTy->isVectorTy()) {
2312     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2313     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2314     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2315            "IntToPtr Vector width mismatch", &I);
2316   }
2317   visitInstruction(I);
2318 }
2319
2320 void Verifier::visitBitCastInst(BitCastInst &I) {
2321   Assert(
2322       CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2323       "Invalid bitcast", &I);
2324   visitInstruction(I);
2325 }
2326
2327 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2328   Type *SrcTy = I.getOperand(0)->getType();
2329   Type *DestTy = I.getType();
2330
2331   Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2332          &I);
2333   Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2334          &I);
2335   Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2336          "AddrSpaceCast must be between different address spaces", &I);
2337   if (SrcTy->isVectorTy())
2338     Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2339            "AddrSpaceCast vector pointer number of elements mismatch", &I);
2340   visitInstruction(I);
2341 }
2342
2343 /// visitPHINode - Ensure that a PHI node is well formed.
2344 ///
2345 void Verifier::visitPHINode(PHINode &PN) {
2346   // Ensure that the PHI nodes are all grouped together at the top of the block.
2347   // This can be tested by checking whether the instruction before this is
2348   // either nonexistent (because this is begin()) or is a PHI node.  If not,
2349   // then there is some other instruction before a PHI.
2350   Assert(&PN == &PN.getParent()->front() ||
2351              isa<PHINode>(--BasicBlock::iterator(&PN)),
2352          "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2353
2354   // Check that a PHI doesn't yield a Token.
2355   Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2356
2357   // Check that all of the values of the PHI node have the same type as the
2358   // result, and that the incoming blocks are really basic blocks.
2359   for (Value *IncValue : PN.incoming_values()) {
2360     Assert(PN.getType() == IncValue->getType(),
2361            "PHI node operands are not the same type as the result!", &PN);
2362   }
2363
2364   // All other PHI node constraints are checked in the visitBasicBlock method.
2365
2366   visitInstruction(PN);
2367 }
2368
2369 void Verifier::VerifyCallSite(CallSite CS) {
2370   Instruction *I = CS.getInstruction();
2371
2372   Assert(CS.getCalledValue()->getType()->isPointerTy(),
2373          "Called function must be a pointer!", I);
2374   PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2375
2376   Assert(FPTy->getElementType()->isFunctionTy(),
2377          "Called function is not pointer to function type!", I);
2378
2379   Assert(FPTy->getElementType() == CS.getFunctionType(),
2380          "Called function is not the same type as the call!", I);
2381
2382   FunctionType *FTy = CS.getFunctionType();
2383
2384   // Verify that the correct number of arguments are being passed
2385   if (FTy->isVarArg())
2386     Assert(CS.arg_size() >= FTy->getNumParams(),
2387            "Called function requires more parameters than were provided!", I);
2388   else
2389     Assert(CS.arg_size() == FTy->getNumParams(),
2390            "Incorrect number of arguments passed to called function!", I);
2391
2392   // Verify that all arguments to the call match the function type.
2393   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2394     Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2395            "Call parameter type does not match function signature!",
2396            CS.getArgument(i), FTy->getParamType(i), I);
2397
2398   AttributeSet Attrs = CS.getAttributes();
2399
2400   Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2401          "Attribute after last parameter!", I);
2402
2403   // Verify call attributes.
2404   VerifyFunctionAttrs(FTy, Attrs, I);
2405
2406   // Conservatively check the inalloca argument.
2407   // We have a bug if we can find that there is an underlying alloca without
2408   // inalloca.
2409   if (CS.hasInAllocaArgument()) {
2410     Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2411     if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2412       Assert(AI->isUsedWithInAlloca(),
2413              "inalloca argument for call has mismatched alloca", AI, I);
2414   }
2415
2416   if (FTy->isVarArg()) {
2417     // FIXME? is 'nest' even legal here?
2418     bool SawNest = false;
2419     bool SawReturned = false;
2420
2421     for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2422       if (Attrs.hasAttribute(Idx, Attribute::Nest))
2423         SawNest = true;
2424       if (Attrs.hasAttribute(Idx, Attribute::Returned))
2425         SawReturned = true;
2426     }
2427
2428     // Check attributes on the varargs part.
2429     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2430       Type *Ty = CS.getArgument(Idx-1)->getType();
2431       VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2432
2433       if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2434         Assert(!SawNest, "More than one parameter has attribute nest!", I);
2435         SawNest = true;
2436       }
2437
2438       if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2439         Assert(!SawReturned, "More than one parameter has attribute returned!",
2440                I);
2441         Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2442                "Incompatible argument and return types for 'returned' "
2443                "attribute",
2444                I);
2445         SawReturned = true;
2446       }
2447
2448       Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2449              "Attribute 'sret' cannot be used for vararg call arguments!", I);
2450
2451       if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2452         Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2453     }
2454   }
2455
2456   // Verify that there's no metadata unless it's a direct call to an intrinsic.
2457   if (CS.getCalledFunction() == nullptr ||
2458       !CS.getCalledFunction()->getName().startswith("llvm.")) {
2459     for (Type *ParamTy : FTy->params()) {
2460       Assert(!ParamTy->isMetadataTy(),
2461              "Function has metadata parameter but isn't an intrinsic", I);
2462       Assert(!ParamTy->isTokenTy(),
2463              "Function has token parameter but isn't an intrinsic", I);
2464     }
2465   }
2466
2467   // Verify that indirect calls don't return tokens.
2468   if (CS.getCalledFunction() == nullptr)
2469     Assert(!FTy->getReturnType()->isTokenTy(),
2470            "Return type cannot be token for indirect call!");
2471
2472   if (Function *F = CS.getCalledFunction())
2473     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2474       visitIntrinsicCallSite(ID, CS);
2475
2476   // Verify that a callsite has at most one "deopt" and one "funclet" operand
2477   // bundle.
2478   bool FoundDeoptBundle = false, FoundFuncletBundle = false;
2479   for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
2480     OperandBundleUse BU = CS.getOperandBundleAt(i);
2481     uint32_t Tag = BU.getTagID();
2482     if (Tag == LLVMContext::OB_deopt) {
2483       Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2484       FoundDeoptBundle = true;
2485     }
2486     if (Tag == LLVMContext::OB_funclet) {
2487       Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2488       FoundFuncletBundle = true;
2489       Assert(BU.Inputs.size() == 1,
2490              "Expected exactly one funclet bundle operand", I);
2491       Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2492              "Funclet bundle operands should correspond to a FuncletPadInst",
2493              I);
2494     }
2495   }
2496
2497   visitInstruction(*I);
2498 }
2499
2500 /// Two types are "congruent" if they are identical, or if they are both pointer
2501 /// types with different pointee types and the same address space.
2502 static bool isTypeCongruent(Type *L, Type *R) {
2503   if (L == R)
2504     return true;
2505   PointerType *PL = dyn_cast<PointerType>(L);
2506   PointerType *PR = dyn_cast<PointerType>(R);
2507   if (!PL || !PR)
2508     return false;
2509   return PL->getAddressSpace() == PR->getAddressSpace();
2510 }
2511
2512 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2513   static const Attribute::AttrKind ABIAttrs[] = {
2514       Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2515       Attribute::InReg, Attribute::Returned};
2516   AttrBuilder Copy;
2517   for (auto AK : ABIAttrs) {
2518     if (Attrs.hasAttribute(I + 1, AK))
2519       Copy.addAttribute(AK);
2520   }
2521   if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2522     Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2523   return Copy;
2524 }
2525
2526 void Verifier::verifyMustTailCall(CallInst &CI) {
2527   Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2528
2529   // - The caller and callee prototypes must match.  Pointer types of
2530   //   parameters or return types may differ in pointee type, but not
2531   //   address space.
2532   Function *F = CI.getParent()->getParent();
2533   FunctionType *CallerTy = F->getFunctionType();
2534   FunctionType *CalleeTy = CI.getFunctionType();
2535   Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2536          "cannot guarantee tail call due to mismatched parameter counts", &CI);
2537   Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2538          "cannot guarantee tail call due to mismatched varargs", &CI);
2539   Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2540          "cannot guarantee tail call due to mismatched return types", &CI);
2541   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2542     Assert(
2543         isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2544         "cannot guarantee tail call due to mismatched parameter types", &CI);
2545   }
2546
2547   // - The calling conventions of the caller and callee must match.
2548   Assert(F->getCallingConv() == CI.getCallingConv(),
2549          "cannot guarantee tail call due to mismatched calling conv", &CI);
2550
2551   // - All ABI-impacting function attributes, such as sret, byval, inreg,
2552   //   returned, and inalloca, must match.
2553   AttributeSet CallerAttrs = F->getAttributes();
2554   AttributeSet CalleeAttrs = CI.getAttributes();
2555   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2556     AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2557     AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2558     Assert(CallerABIAttrs == CalleeABIAttrs,
2559            "cannot guarantee tail call due to mismatched ABI impacting "
2560            "function attributes",
2561            &CI, CI.getOperand(I));
2562   }
2563
2564   // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2565   //   or a pointer bitcast followed by a ret instruction.
2566   // - The ret instruction must return the (possibly bitcasted) value
2567   //   produced by the call or void.
2568   Value *RetVal = &CI;
2569   Instruction *Next = CI.getNextNode();
2570
2571   // Handle the optional bitcast.
2572   if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2573     Assert(BI->getOperand(0) == RetVal,
2574            "bitcast following musttail call must use the call", BI);
2575     RetVal = BI;
2576     Next = BI->getNextNode();
2577   }
2578
2579   // Check the return.
2580   ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2581   Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2582          &CI);
2583   Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2584          "musttail call result must be returned", Ret);
2585 }
2586
2587 void Verifier::visitCallInst(CallInst &CI) {
2588   VerifyCallSite(&CI);
2589
2590   if (CI.isMustTailCall())
2591     verifyMustTailCall(CI);
2592 }
2593
2594 void Verifier::visitInvokeInst(InvokeInst &II) {
2595   VerifyCallSite(&II);
2596
2597   // Verify that the first non-PHI instruction of the unwind destination is an
2598   // exception handling instruction.
2599   Assert(
2600       II.getUnwindDest()->isEHPad(),
2601       "The unwind destination does not have an exception handling instruction!",
2602       &II);
2603
2604   visitTerminatorInst(II);
2605 }
2606
2607 /// visitBinaryOperator - Check that both arguments to the binary operator are
2608 /// of the same type!
2609 ///
2610 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2611   Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2612          "Both operands to a binary operator are not of the same type!", &B);
2613
2614   switch (B.getOpcode()) {
2615   // Check that integer arithmetic operators are only used with
2616   // integral operands.
2617   case Instruction::Add:
2618   case Instruction::Sub:
2619   case Instruction::Mul:
2620   case Instruction::SDiv:
2621   case Instruction::UDiv:
2622   case Instruction::SRem:
2623   case Instruction::URem:
2624     Assert(B.getType()->isIntOrIntVectorTy(),
2625            "Integer arithmetic operators only work with integral types!", &B);
2626     Assert(B.getType() == B.getOperand(0)->getType(),
2627            "Integer arithmetic operators must have same type "
2628            "for operands and result!",
2629            &B);
2630     break;
2631   // Check that floating-point arithmetic operators are only used with
2632   // floating-point operands.
2633   case Instruction::FAdd:
2634   case Instruction::FSub:
2635   case Instruction::FMul:
2636   case Instruction::FDiv:
2637   case Instruction::FRem:
2638     Assert(B.getType()->isFPOrFPVectorTy(),
2639            "Floating-point arithmetic operators only work with "
2640            "floating-point types!",
2641            &B);
2642     Assert(B.getType() == B.getOperand(0)->getType(),
2643            "Floating-point arithmetic operators must have same type "
2644            "for operands and result!",
2645            &B);
2646     break;
2647   // Check that logical operators are only used with integral operands.
2648   case Instruction::And:
2649   case Instruction::Or:
2650   case Instruction::Xor:
2651     Assert(B.getType()->isIntOrIntVectorTy(),
2652            "Logical operators only work with integral types!", &B);
2653     Assert(B.getType() == B.getOperand(0)->getType(),
2654            "Logical operators must have same type for operands and result!",
2655            &B);
2656     break;
2657   case Instruction::Shl:
2658   case Instruction::LShr:
2659   case Instruction::AShr:
2660     Assert(B.getType()->isIntOrIntVectorTy(),
2661            "Shifts only work with integral types!", &B);
2662     Assert(B.getType() == B.getOperand(0)->getType(),
2663            "Shift return type must be same as operands!", &B);
2664     break;
2665   default:
2666     llvm_unreachable("Unknown BinaryOperator opcode!");
2667   }
2668
2669   visitInstruction(B);
2670 }
2671
2672 void Verifier::visitICmpInst(ICmpInst &IC) {
2673   // Check that the operands are the same type
2674   Type *Op0Ty = IC.getOperand(0)->getType();
2675   Type *Op1Ty = IC.getOperand(1)->getType();
2676   Assert(Op0Ty == Op1Ty,
2677          "Both operands to ICmp instruction are not of the same type!", &IC);
2678   // Check that the operands are the right type
2679   Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2680          "Invalid operand types for ICmp instruction", &IC);
2681   // Check that the predicate is valid.
2682   Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2683              IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2684          "Invalid predicate in ICmp instruction!", &IC);
2685
2686   visitInstruction(IC);
2687 }
2688
2689 void Verifier::visitFCmpInst(FCmpInst &FC) {
2690   // Check that the operands are the same type
2691   Type *Op0Ty = FC.getOperand(0)->getType();
2692   Type *Op1Ty = FC.getOperand(1)->getType();
2693   Assert(Op0Ty == Op1Ty,
2694          "Both operands to FCmp instruction are not of the same type!", &FC);
2695   // Check that the operands are the right type
2696   Assert(Op0Ty->isFPOrFPVectorTy(),
2697          "Invalid operand types for FCmp instruction", &FC);
2698   // Check that the predicate is valid.
2699   Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2700              FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2701          "Invalid predicate in FCmp instruction!", &FC);
2702
2703   visitInstruction(FC);
2704 }
2705
2706 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2707   Assert(
2708       ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2709       "Invalid extractelement operands!", &EI);
2710   visitInstruction(EI);
2711 }
2712
2713 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2714   Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2715                                             IE.getOperand(2)),
2716          "Invalid insertelement operands!", &IE);
2717   visitInstruction(IE);
2718 }
2719
2720 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2721   Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2722                                             SV.getOperand(2)),
2723          "Invalid shufflevector operands!", &SV);
2724   visitInstruction(SV);
2725 }
2726
2727 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2728   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2729
2730   Assert(isa<PointerType>(TargetTy),
2731          "GEP base pointer is not a vector or a vector of pointers", &GEP);
2732   Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2733   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2734   Type *ElTy =
2735       GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2736   Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2737
2738   Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2739              GEP.getResultElementType() == ElTy,
2740          "GEP is not of right type for indices!", &GEP, ElTy);
2741
2742   if (GEP.getType()->isVectorTy()) {
2743     // Additional checks for vector GEPs.
2744     unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2745     if (GEP.getPointerOperandType()->isVectorTy())
2746       Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2747              "Vector GEP result width doesn't match operand's", &GEP);
2748     for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2749       Type *IndexTy = Idxs[i]->getType();
2750       if (IndexTy->isVectorTy()) {
2751         unsigned IndexWidth = IndexTy->getVectorNumElements();
2752         Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2753       }
2754       Assert(IndexTy->getScalarType()->isIntegerTy(),
2755              "All GEP indices should be of integer type");
2756     }
2757   }
2758   visitInstruction(GEP);
2759 }
2760
2761 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2762   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2763 }
2764
2765 void Verifier::visitRangeMetadata(Instruction& I,
2766                                   MDNode* Range, Type* Ty) {
2767   assert(Range &&
2768          Range == I.getMetadata(LLVMContext::MD_range) &&
2769          "precondition violation");
2770
2771   unsigned NumOperands = Range->getNumOperands();
2772   Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2773   unsigned NumRanges = NumOperands / 2;
2774   Assert(NumRanges >= 1, "It should have at least one range!", Range);
2775
2776   ConstantRange LastRange(1); // Dummy initial value
2777   for (unsigned i = 0; i < NumRanges; ++i) {
2778     ConstantInt *Low =
2779         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2780     Assert(Low, "The lower limit must be an integer!", Low);
2781     ConstantInt *High =
2782         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2783     Assert(High, "The upper limit must be an integer!", High);
2784     Assert(High->getType() == Low->getType() && High->getType() == Ty,
2785            "Range types must match instruction type!", &I);
2786
2787     APInt HighV = High->getValue();
2788     APInt LowV = Low->getValue();
2789     ConstantRange CurRange(LowV, HighV);
2790     Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2791            "Range must not be empty!", Range);
2792     if (i != 0) {
2793       Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2794              "Intervals are overlapping", Range);
2795       Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2796              Range);
2797       Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2798              Range);
2799     }
2800     LastRange = ConstantRange(LowV, HighV);
2801   }
2802   if (NumRanges > 2) {
2803     APInt FirstLow =
2804         mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2805     APInt FirstHigh =
2806         mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2807     ConstantRange FirstRange(FirstLow, FirstHigh);
2808     Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2809            "Intervals are overlapping", Range);
2810     Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2811            Range);
2812   }
2813 }
2814
2815 void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2816                                         const Instruction *I) {
2817   unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2818   Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2819   Assert(!(Size & (Size - 1)),
2820          "atomic memory access' operand must have a power-of-two size", Ty, I);
2821 }
2822
2823 void Verifier::visitLoadInst(LoadInst &LI) {
2824   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2825   Assert(PTy, "Load operand must be a pointer.", &LI);
2826   Type *ElTy = LI.getType();
2827   Assert(LI.getAlignment() <= Value::MaximumAlignment,
2828          "huge alignment values are unsupported", &LI);
2829   if (LI.isAtomic()) {
2830     Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2831            "Load cannot have Release ordering", &LI);
2832     Assert(LI.getAlignment() != 0,
2833            "Atomic load must specify explicit alignment", &LI);
2834     Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2835                ElTy->isFloatingPointTy(),
2836            "atomic load operand must have integer, pointer, or floating point "
2837            "type!",
2838            ElTy, &LI);
2839     checkAtomicMemAccessSize(M, ElTy, &LI);
2840   } else {
2841     Assert(LI.getSynchScope() == CrossThread,
2842            "Non-atomic load cannot have SynchronizationScope specified", &LI);
2843   }
2844
2845   visitInstruction(LI);
2846 }
2847
2848 void Verifier::visitStoreInst(StoreInst &SI) {
2849   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2850   Assert(PTy, "Store operand must be a pointer.", &SI);
2851   Type *ElTy = PTy->getElementType();
2852   Assert(ElTy == SI.getOperand(0)->getType(),
2853          "Stored value type does not match pointer operand type!", &SI, ElTy);
2854   Assert(SI.getAlignment() <= Value::MaximumAlignment,
2855          "huge alignment values are unsupported", &SI);
2856   if (SI.isAtomic()) {
2857     Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2858            "Store cannot have Acquire ordering", &SI);
2859     Assert(SI.getAlignment() != 0,
2860            "Atomic store must specify explicit alignment", &SI);
2861     Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2862                ElTy->isFloatingPointTy(),
2863            "atomic store operand must have integer, pointer, or floating point "
2864            "type!",
2865            ElTy, &SI);
2866     checkAtomicMemAccessSize(M, ElTy, &SI);
2867   } else {
2868     Assert(SI.getSynchScope() == CrossThread,
2869            "Non-atomic store cannot have SynchronizationScope specified", &SI);
2870   }
2871   visitInstruction(SI);
2872 }
2873
2874 void Verifier::visitAllocaInst(AllocaInst &AI) {
2875   SmallPtrSet<Type*, 4> Visited;
2876   PointerType *PTy = AI.getType();
2877   Assert(PTy->getAddressSpace() == 0,
2878          "Allocation instruction pointer not in the generic address space!",
2879          &AI);
2880   Assert(AI.getAllocatedType()->isSized(&Visited),
2881          "Cannot allocate unsized type", &AI);
2882   Assert(AI.getArraySize()->getType()->isIntegerTy(),
2883          "Alloca array size must have integer type", &AI);
2884   Assert(AI.getAlignment() <= Value::MaximumAlignment,
2885          "huge alignment values are unsupported", &AI);
2886
2887   visitInstruction(AI);
2888 }
2889
2890 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2891
2892   // FIXME: more conditions???
2893   Assert(CXI.getSuccessOrdering() != NotAtomic,
2894          "cmpxchg instructions must be atomic.", &CXI);
2895   Assert(CXI.getFailureOrdering() != NotAtomic,
2896          "cmpxchg instructions must be atomic.", &CXI);
2897   Assert(CXI.getSuccessOrdering() != Unordered,
2898          "cmpxchg instructions cannot be unordered.", &CXI);
2899   Assert(CXI.getFailureOrdering() != Unordered,
2900          "cmpxchg instructions cannot be unordered.", &CXI);
2901   Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2902          "cmpxchg instructions be at least as constrained on success as fail",
2903          &CXI);
2904   Assert(CXI.getFailureOrdering() != Release &&
2905              CXI.getFailureOrdering() != AcquireRelease,
2906          "cmpxchg failure ordering cannot include release semantics", &CXI);
2907
2908   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2909   Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2910   Type *ElTy = PTy->getElementType();
2911   Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2912          ElTy);
2913   checkAtomicMemAccessSize(M, ElTy, &CXI);
2914   Assert(ElTy == CXI.getOperand(1)->getType(),
2915          "Expected value type does not match pointer operand type!", &CXI,
2916          ElTy);
2917   Assert(ElTy == CXI.getOperand(2)->getType(),
2918          "Stored value type does not match pointer operand type!", &CXI, ElTy);
2919   visitInstruction(CXI);
2920 }
2921
2922 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2923   Assert(RMWI.getOrdering() != NotAtomic,
2924          "atomicrmw instructions must be atomic.", &RMWI);
2925   Assert(RMWI.getOrdering() != Unordered,
2926          "atomicrmw instructions cannot be unordered.", &RMWI);
2927   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2928   Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2929   Type *ElTy = PTy->getElementType();
2930   Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2931          &RMWI, ElTy);
2932   checkAtomicMemAccessSize(M, ElTy, &RMWI);
2933   Assert(ElTy == RMWI.getOperand(1)->getType(),
2934          "Argument value type does not match pointer operand type!", &RMWI,
2935          ElTy);
2936   Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2937              RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2938          "Invalid binary operation!", &RMWI);
2939   visitInstruction(RMWI);
2940 }
2941
2942 void Verifier::visitFenceInst(FenceInst &FI) {
2943   const AtomicOrdering Ordering = FI.getOrdering();
2944   Assert(Ordering == Acquire || Ordering == Release ||
2945              Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2946          "fence instructions may only have "
2947          "acquire, release, acq_rel, or seq_cst ordering.",
2948          &FI);
2949   visitInstruction(FI);
2950 }
2951
2952 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2953   Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2954                                           EVI.getIndices()) == EVI.getType(),
2955          "Invalid ExtractValueInst operands!", &EVI);
2956
2957   visitInstruction(EVI);
2958 }
2959
2960 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2961   Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2962                                           IVI.getIndices()) ==
2963              IVI.getOperand(1)->getType(),
2964          "Invalid InsertValueInst operands!", &IVI);
2965
2966   visitInstruction(IVI);
2967 }
2968
2969 static Value *getParentPad(Value *EHPad) {
2970   if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
2971     return FPI->getParentPad();
2972
2973   return cast<CatchSwitchInst>(EHPad)->getParentPad();
2974 }
2975
2976 void Verifier::visitEHPadPredecessors(Instruction &I) {
2977   assert(I.isEHPad());
2978
2979   BasicBlock *BB = I.getParent();
2980   Function *F = BB->getParent();
2981
2982   Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2983
2984   if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2985     // The landingpad instruction defines its parent as a landing pad block. The
2986     // landing pad block may be branched to only by the unwind edge of an
2987     // invoke.
2988     for (BasicBlock *PredBB : predecessors(BB)) {
2989       const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2990       Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2991              "Block containing LandingPadInst must be jumped to "
2992              "only by the unwind edge of an invoke.",
2993              LPI);
2994     }
2995     return;
2996   }
2997   if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2998     if (!pred_empty(BB))
2999       Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3000              "Block containg CatchPadInst must be jumped to "
3001              "only by its catchswitch.",
3002              CPI);
3003     Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3004            "Catchswitch cannot unwind to one of its catchpads",
3005            CPI->getCatchSwitch(), CPI);
3006     return;
3007   }
3008
3009   // Verify that each pred has a legal terminator with a legal to/from EH
3010   // pad relationship.
3011   Instruction *ToPad = &I;
3012   Value *ToPadParent = getParentPad(ToPad);
3013   for (BasicBlock *PredBB : predecessors(BB)) {
3014     TerminatorInst *TI = PredBB->getTerminator();
3015     Value *FromPad;
3016     if (auto *II = dyn_cast<InvokeInst>(TI)) {
3017       Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
3018              "EH pad must be jumped to via an unwind edge", ToPad, II);
3019       if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3020         FromPad = Bundle->Inputs[0];
3021       else
3022         FromPad = ConstantTokenNone::get(II->getContext());
3023     } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3024       FromPad = CRI->getCleanupPad();
3025       Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3026     } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3027       FromPad = CSI;
3028     } else {
3029       Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3030     }
3031
3032     // The edge may exit from zero or more nested pads.
3033     for (;; FromPad = getParentPad(FromPad)) {
3034       Assert(FromPad != ToPad,
3035              "EH pad cannot handle exceptions raised within it", FromPad, TI);
3036       if (FromPad == ToPadParent) {
3037         // This is a legal unwind edge.
3038         break;
3039       }
3040       Assert(!isa<ConstantTokenNone>(FromPad),
3041              "A single unwind edge may only enter one EH pad", TI);
3042     }
3043   }
3044 }
3045
3046 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
3047   // The landingpad instruction is ill-formed if it doesn't have any clauses and
3048   // isn't a cleanup.
3049   Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3050          "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
3051
3052   visitEHPadPredecessors(LPI);
3053
3054   if (!LandingPadResultTy)
3055     LandingPadResultTy = LPI.getType();
3056   else
3057     Assert(LandingPadResultTy == LPI.getType(),
3058            "The landingpad instruction should have a consistent result type "
3059            "inside a function.",
3060            &LPI);
3061
3062   Function *F = LPI.getParent()->getParent();
3063   Assert(F->hasPersonalityFn(),
3064          "LandingPadInst needs to be in a function with a personality.", &LPI);
3065
3066   // The landingpad instruction must be the first non-PHI instruction in the
3067   // block.
3068   Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3069          "LandingPadInst not the first non-PHI instruction in the block.",
3070          &LPI);
3071
3072   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
3073     Constant *Clause = LPI.getClause(i);
3074     if (LPI.isCatch(i)) {
3075       Assert(isa<PointerType>(Clause->getType()),
3076              "Catch operand does not have pointer type!", &LPI);
3077     } else {
3078       Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3079       Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3080              "Filter operand is not an array of constants!", &LPI);
3081     }
3082   }
3083
3084   visitInstruction(LPI);
3085 }
3086
3087 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
3088   visitEHPadPredecessors(CPI);
3089
3090   BasicBlock *BB = CPI.getParent();
3091
3092   Function *F = BB->getParent();
3093   Assert(F->hasPersonalityFn(),
3094          "CatchPadInst needs to be in a function with a personality.", &CPI);
3095
3096   Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3097          "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3098          CPI.getParentPad());
3099
3100   // The catchpad instruction must be the first non-PHI instruction in the
3101   // block.
3102   Assert(BB->getFirstNonPHI() == &CPI,
3103          "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
3104
3105   visitFuncletPadInst(CPI);
3106 }
3107
3108 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3109   Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3110          "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3111          CatchReturn.getOperand(0));
3112
3113   visitTerminatorInst(CatchReturn);
3114 }
3115
3116 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3117   visitEHPadPredecessors(CPI);
3118
3119   BasicBlock *BB = CPI.getParent();
3120
3121   Function *F = BB->getParent();
3122   Assert(F->hasPersonalityFn(),
3123          "CleanupPadInst needs to be in a function with a personality.", &CPI);
3124
3125   // The cleanuppad instruction must be the first non-PHI instruction in the
3126   // block.
3127   Assert(BB->getFirstNonPHI() == &CPI,
3128          "CleanupPadInst not the first non-PHI instruction in the block.",
3129          &CPI);
3130
3131   auto *ParentPad = CPI.getParentPad();
3132   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3133          "CleanupPadInst has an invalid parent.", &CPI);
3134
3135   visitFuncletPadInst(CPI);
3136 }
3137
3138 void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3139   User *FirstUser = nullptr;
3140   Value *FirstUnwindPad = nullptr;
3141   SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
3142   while (!Worklist.empty()) {
3143     FuncletPadInst *CurrentPad = Worklist.pop_back_val();
3144     Value *UnresolvedAncestorPad = nullptr;
3145     for (User *U : CurrentPad->users()) {
3146       BasicBlock *UnwindDest;
3147       if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3148         UnwindDest = CRI->getUnwindDest();
3149       } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3150         // We allow catchswitch unwind to caller to nest
3151         // within an outer pad that unwinds somewhere else,
3152         // because catchswitch doesn't have a nounwind variant.
3153         // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3154         if (CSI->unwindsToCaller())
3155           continue;
3156         UnwindDest = CSI->getUnwindDest();
3157       } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3158         UnwindDest = II->getUnwindDest();
3159       } else if (isa<CallInst>(U)) {
3160         // Calls which don't unwind may be found inside funclet
3161         // pads that unwind somewhere else.  We don't *require*
3162         // such calls to be annotated nounwind.
3163         continue;
3164       } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3165         // The unwind dest for a cleanup can only be found by
3166         // recursive search.  Add it to the worklist, and we'll
3167         // search for its first use that determines where it unwinds.
3168         Worklist.push_back(CPI);
3169         continue;
3170       } else {
3171         Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3172         continue;
3173       }
3174
3175       Value *UnwindPad;
3176       bool ExitsFPI;
3177       if (UnwindDest) {
3178         UnwindPad = UnwindDest->getFirstNonPHI();
3179         Value *UnwindParent = getParentPad(UnwindPad);
3180         // Ignore unwind edges that don't exit CurrentPad.
3181         if (UnwindParent == CurrentPad)
3182           continue;
3183         // Determine whether the original funclet pad is exited,
3184         // and if we are scanning nested pads determine how many
3185         // of them are exited so we can stop searching their
3186         // children.
3187         Value *ExitedPad = CurrentPad;
3188         ExitsFPI = false;
3189         do {
3190           if (ExitedPad == &FPI) {
3191             ExitsFPI = true;
3192             // Now we can resolve any ancestors of CurrentPad up to
3193             // FPI, but not including FPI since we need to make sure
3194             // to check all direct users of FPI for consistency.
3195             UnresolvedAncestorPad = &FPI;
3196             break;
3197           }
3198           Value *ExitedParent = getParentPad(ExitedPad);
3199           if (ExitedParent == UnwindParent) {
3200             // ExitedPad is the ancestor-most pad which this unwind
3201             // edge exits, so we can resolve up to it, meaning that
3202             // ExitedParent is the first ancestor still unresolved.
3203             UnresolvedAncestorPad = ExitedParent;
3204             break;
3205           }
3206           ExitedPad = ExitedParent;
3207         } while (!isa<ConstantTokenNone>(ExitedPad));
3208       } else {
3209         // Unwinding to caller exits all pads.
3210         UnwindPad = ConstantTokenNone::get(FPI.getContext());
3211         ExitsFPI = true;
3212         UnresolvedAncestorPad = &FPI;
3213       }
3214
3215       if (ExitsFPI) {
3216         // This unwind edge exits FPI.  Make sure it agrees with other
3217         // such edges.
3218         if (FirstUser) {
3219           Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3220                                               "pad must have the same unwind "
3221                                               "dest",
3222                  &FPI, U, FirstUser);
3223         } else {
3224           FirstUser = U;
3225           FirstUnwindPad = UnwindPad;
3226           // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3227           if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3228               getParentPad(UnwindPad) == getParentPad(&FPI))
3229             SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
3230         }
3231       }
3232       // Make sure we visit all uses of FPI, but for nested pads stop as
3233       // soon as we know where they unwind to.
3234       if (CurrentPad != &FPI)
3235         break;
3236     }
3237     if (UnresolvedAncestorPad) {
3238       if (CurrentPad == UnresolvedAncestorPad) {
3239         // When CurrentPad is FPI itself, we don't mark it as resolved even if
3240         // we've found an unwind edge that exits it, because we need to verify
3241         // all direct uses of FPI.
3242         assert(CurrentPad == &FPI);
3243         continue;
3244       }
3245       // Pop off the worklist any nested pads that we've found an unwind
3246       // destination for.  The pads on the worklist are the uncles,
3247       // great-uncles, etc. of CurrentPad.  We've found an unwind destination
3248       // for all ancestors of CurrentPad up to but not including
3249       // UnresolvedAncestorPad.
3250       Value *ResolvedPad = CurrentPad;
3251       while (!Worklist.empty()) {
3252         Value *UnclePad = Worklist.back();
3253         Value *AncestorPad = getParentPad(UnclePad);
3254         // Walk ResolvedPad up the ancestor list until we either find the
3255         // uncle's parent or the last resolved ancestor.
3256         while (ResolvedPad != AncestorPad) {
3257           Value *ResolvedParent = getParentPad(ResolvedPad);
3258           if (ResolvedParent == UnresolvedAncestorPad) {
3259             break;
3260           }
3261           ResolvedPad = ResolvedParent;
3262         }
3263         // If the resolved ancestor search didn't find the uncle's parent,
3264         // then the uncle is not yet resolved.
3265         if (ResolvedPad != AncestorPad)
3266           break;
3267         // This uncle is resolved, so pop it from the worklist.
3268         Worklist.pop_back();
3269       }
3270     }
3271   }
3272
3273   if (FirstUnwindPad) {
3274     if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3275       BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3276       Value *SwitchUnwindPad;
3277       if (SwitchUnwindDest)
3278         SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3279       else
3280         SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3281       Assert(SwitchUnwindPad == FirstUnwindPad,
3282              "Unwind edges out of a catch must have the same unwind dest as "
3283              "the parent catchswitch",
3284              &FPI, FirstUser, CatchSwitch);
3285     }
3286   }
3287
3288   visitInstruction(FPI);
3289 }
3290
3291 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3292   visitEHPadPredecessors(CatchSwitch);
3293
3294   BasicBlock *BB = CatchSwitch.getParent();
3295
3296   Function *F = BB->getParent();
3297   Assert(F->hasPersonalityFn(),
3298          "CatchSwitchInst needs to be in a function with a personality.",
3299          &CatchSwitch);
3300
3301   // The catchswitch instruction must be the first non-PHI instruction in the
3302   // block.
3303   Assert(BB->getFirstNonPHI() == &CatchSwitch,
3304          "CatchSwitchInst not the first non-PHI instruction in the block.",
3305          &CatchSwitch);
3306
3307   auto *ParentPad = CatchSwitch.getParentPad();
3308   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3309          "CatchSwitchInst has an invalid parent.", ParentPad);
3310
3311   if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
3312     Instruction *I = UnwindDest->getFirstNonPHI();
3313     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3314            "CatchSwitchInst must unwind to an EH block which is not a "
3315            "landingpad.",
3316            &CatchSwitch);
3317
3318     // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3319     if (getParentPad(I) == ParentPad)
3320       SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3321   }
3322
3323   Assert(CatchSwitch.getNumHandlers() != 0,
3324          "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3325
3326   for (BasicBlock *Handler : CatchSwitch.handlers()) {
3327     Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3328            "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
3329   }
3330
3331   visitTerminatorInst(CatchSwitch);
3332 }
3333
3334 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
3335   Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3336          "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3337          CRI.getOperand(0));
3338
3339   if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3340     Instruction *I = UnwindDest->getFirstNonPHI();
3341     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3342            "CleanupReturnInst must unwind to an EH block which is not a "
3343            "landingpad.",
3344            &CRI);
3345   }
3346
3347   visitTerminatorInst(CRI);
3348 }
3349
3350 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3351   Instruction *Op = cast<Instruction>(I.getOperand(i));
3352   // If the we have an invalid invoke, don't try to compute the dominance.
3353   // We already reject it in the invoke specific checks and the dominance
3354   // computation doesn't handle multiple edges.
3355   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3356     if (II->getNormalDest() == II->getUnwindDest())
3357       return;
3358   }
3359
3360   const Use &U = I.getOperandUse(i);
3361   if (!(InstsInThisBlock.count(Op) || DT.dominates(Op, U))) {
3362     dbgs() << "Problematic function: \n" << *I.getParent()->getParent() << "\n";
3363   }
3364   Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3365          "Instruction does not dominate all uses!", Op, &I);
3366 }
3367
3368 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3369   Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3370          "apply only to pointer types", &I);
3371   Assert(isa<LoadInst>(I),
3372          "dereferenceable, dereferenceable_or_null apply only to load"
3373          " instructions, use attributes for calls or invokes", &I);
3374   Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3375          "take one operand!", &I);
3376   ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3377   Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3378          "dereferenceable_or_null metadata value must be an i64!", &I);
3379 }
3380
3381 /// verifyInstruction - Verify that an instruction is well formed.
3382 ///
3383 void Verifier::visitInstruction(Instruction &I) {
3384   BasicBlock *BB = I.getParent();
3385   Assert(BB, "Instruction not embedded in basic block!", &I);
3386
3387   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
3388     for (User *U : I.users()) {
3389       Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3390              "Only PHI nodes may reference their own value!", &I);
3391     }
3392   }
3393
3394   // Check that void typed values don't have names
3395   Assert(!I.getType()->isVoidTy() || !I.hasName(),
3396          "Instruction has a name, but provides a void value!", &I);
3397
3398   // Check that the return value of the instruction is either void or a legal
3399   // value type.
3400   Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3401          "Instruction returns a non-scalar type!", &I);
3402
3403   // Check that the instruction doesn't produce metadata. Calls are already
3404   // checked against the callee type.
3405   Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3406          "Invalid use of metadata!", &I);
3407
3408   // Check that all uses of the instruction, if they are instructions
3409   // themselves, actually have parent basic blocks.  If the use is not an
3410   // instruction, it is an error!
3411   for (Use &U : I.uses()) {
3412     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3413       Assert(Used->getParent() != nullptr,
3414              "Instruction referencing"
3415              " instruction not embedded in a basic block!",
3416              &I, Used);
3417     else {
3418       CheckFailed("Use of instruction is not an instruction!", U);
3419       return;
3420     }
3421   }
3422
3423   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3424     Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3425
3426     // Check to make sure that only first-class-values are operands to
3427     // instructions.
3428     if (!I.getOperand(i)->getType()->isFirstClassType()) {
3429       Assert(0, "Instruction operands must be first-class values!", &I);
3430     }
3431
3432     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3433       // Check to make sure that the "address of" an intrinsic function is never
3434       // taken.
3435       Assert(
3436           !F->isIntrinsic() ||
3437               i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3438           "Cannot take the address of an intrinsic!", &I);
3439       Assert(
3440           !F->isIntrinsic() || isa<CallInst>(I) ||
3441               F->getIntrinsicID() == Intrinsic::donothing ||
3442               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3443               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3444               F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3445           "Cannot invoke an intrinsinc other than"
3446           " donothing or patchpoint",
3447           &I);
3448       Assert(F->getParent() == M, "Referencing function in another module!",
3449              &I, M, F, F->getParent());
3450     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3451       Assert(OpBB->getParent() == BB->getParent(),
3452              "Referring to a basic block in another function!", &I);
3453     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3454       Assert(OpArg->getParent() == BB->getParent(),
3455              "Referring to an argument in another function!", &I);
3456     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3457       Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
3458     } else if (isa<Instruction>(I.getOperand(i))) {
3459       verifyDominatesUse(I, i);
3460     } else if (isa<InlineAsm>(I.getOperand(i))) {
3461       Assert((i + 1 == e && isa<CallInst>(I)) ||
3462                  (i + 3 == e && isa<InvokeInst>(I)),
3463              "Cannot take the address of an inline asm!", &I);
3464     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3465       if (CE->getType()->isPtrOrPtrVectorTy()) {
3466         // If we have a ConstantExpr pointer, we need to see if it came from an
3467         // illegal bitcast (inttoptr <constant int> )
3468         visitConstantExprsRecursively(CE);
3469       }
3470     }
3471   }
3472
3473   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3474     Assert(I.getType()->isFPOrFPVectorTy(),
3475            "fpmath requires a floating point result!", &I);
3476     Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3477     if (ConstantFP *CFP0 =
3478             mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3479       APFloat Accuracy = CFP0->getValueAPF();
3480       Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3481              "fpmath accuracy not a positive number!", &I);
3482     } else {
3483       Assert(false, "invalid fpmath accuracy!", &I);
3484     }
3485   }
3486
3487   if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3488     Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3489            "Ranges are only for loads, calls and invokes!", &I);
3490     visitRangeMetadata(I, Range, I.getType());
3491   }
3492
3493   if (I.getMetadata(LLVMContext::MD_nonnull)) {
3494     Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3495            &I);
3496     Assert(isa<LoadInst>(I),
3497            "nonnull applies only to load instructions, use attributes"
3498            " for calls or invokes",
3499            &I);
3500   }
3501
3502   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3503     visitDereferenceableMetadata(I, MD);
3504
3505   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3506     visitDereferenceableMetadata(I, MD);
3507
3508   if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3509     Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3510            &I);
3511     Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3512            "use attributes for calls or invokes", &I);
3513     Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3514     ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3515     Assert(CI && CI->getType()->isIntegerTy(64),
3516            "align metadata value must be an i64!", &I);
3517     uint64_t Align = CI->getZExtValue();
3518     Assert(isPowerOf2_64(Align),
3519            "align metadata value must be a power of 2!", &I);
3520     Assert(Align <= Value::MaximumAlignment,
3521            "alignment is larger that implementation defined limit", &I);
3522   }
3523
3524   if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3525     Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3526     visitMDNode(*N);
3527   }
3528
3529   InstsInThisBlock.insert(&I);
3530 }
3531
3532 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3533 /// intrinsic argument or return value) matches the type constraints specified
3534 /// by the .td file (e.g. an "any integer" argument really is an integer).
3535 ///
3536 /// This return true on error but does not print a message.
3537 bool Verifier::VerifyIntrinsicType(Type *Ty,
3538                                    ArrayRef<Intrinsic::IITDescriptor> &Infos,
3539                                    SmallVectorImpl<Type*> &ArgTys) {
3540   using namespace Intrinsic;
3541
3542   // If we ran out of descriptors, there are too many arguments.
3543   if (Infos.empty()) return true;
3544   IITDescriptor D = Infos.front();
3545   Infos = Infos.slice(1);
3546
3547   switch (D.Kind) {
3548   case IITDescriptor::Void: return !Ty->isVoidTy();
3549   case IITDescriptor::VarArg: return true;
3550   case IITDescriptor::MMX:  return !Ty->isX86_MMXTy();
3551   case IITDescriptor::Token: return !Ty->isTokenTy();
3552   case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3553   case IITDescriptor::Half: return !Ty->isHalfTy();
3554   case IITDescriptor::Float: return !Ty->isFloatTy();
3555   case IITDescriptor::Double: return !Ty->isDoubleTy();
3556   case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3557   case IITDescriptor::Vector: {
3558     VectorType *VT = dyn_cast<VectorType>(Ty);
3559     return !VT || VT->getNumElements() != D.Vector_Width ||
3560            VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3561   }
3562   case IITDescriptor::Pointer: {
3563     PointerType *PT = dyn_cast<PointerType>(Ty);
3564     return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3565            VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3566   }
3567
3568   case IITDescriptor::Struct: {
3569     StructType *ST = dyn_cast<StructType>(Ty);
3570     if (!ST || ST->getNumElements() != D.Struct_NumElements)
3571       return true;
3572
3573     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3574       if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3575         return true;
3576     return false;
3577   }
3578
3579   case IITDescriptor::Argument:
3580     // Two cases here - If this is the second occurrence of an argument, verify
3581     // that the later instance matches the previous instance.
3582     if (D.getArgumentNumber() < ArgTys.size())
3583       return Ty != ArgTys[D.getArgumentNumber()];
3584
3585     // Otherwise, if this is the first instance of an argument, record it and
3586     // verify the "Any" kind.
3587     assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3588     ArgTys.push_back(Ty);
3589
3590     switch (D.getArgumentKind()) {
3591     case IITDescriptor::AK_Any:        return false; // Success
3592     case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3593     case IITDescriptor::AK_AnyFloat:   return !Ty->isFPOrFPVectorTy();
3594     case IITDescriptor::AK_AnyVector:  return !isa<VectorType>(Ty);
3595     case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3596     }
3597     llvm_unreachable("all argument kinds not covered");
3598
3599   case IITDescriptor::ExtendArgument: {
3600     // This may only be used when referring to a previous vector argument.
3601     if (D.getArgumentNumber() >= ArgTys.size())
3602       return true;
3603