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/DiagnosticInfo.h"
63 #include "llvm/IR/Dominators.h"
64 #include "llvm/IR/InlineAsm.h"
65 #include "llvm/IR/InstIterator.h"
66 #include "llvm/IR/InstVisitor.h"
67 #include "llvm/IR/IntrinsicInst.h"
68 #include "llvm/IR/LLVMContext.h"
69 #include "llvm/IR/Metadata.h"
70 #include "llvm/IR/Module.h"
71 #include "llvm/IR/ModuleSlotTracker.h"
72 #include "llvm/IR/PassManager.h"
73 #include "llvm/IR/Statepoint.h"
74 #include "llvm/Pass.h"
75 #include "llvm/Support/CommandLine.h"
76 #include "llvm/Support/Debug.h"
77 #include "llvm/Support/ErrorHandling.h"
78 #include "llvm/Support/raw_ostream.h"
79 #include <algorithm>
80 #include <cstdarg>
81 using namespace llvm;
82 
83 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 
85 namespace {
86 struct VerifierSupport {
87   raw_ostream *OS;
88   const Module &M;
89   ModuleSlotTracker MST;
90   const DataLayout &DL;
91   LLVMContext &Context;
92 
93   /// Track the brokenness of the module while recursively visiting.
94   bool Broken = false;
95   /// Broken debug info can be "recovered" from by stripping the debug info.
96   bool BrokenDebugInfo = false;
97   /// Whether to treat broken debug info as an error.
98   bool TreatBrokenDebugInfoAsError = true;
99 
100   explicit VerifierSupport(raw_ostream *OS, const Module &M)
101       : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
102 
103 private:
104   template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
105     Write(&*I);
106   }
107 
108   void Write(const Module *M) {
109     *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
110   }
111 
112   void Write(const Value *V) {
113     if (!V)
114       return;
115     if (isa<Instruction>(V)) {
116       V->print(*OS, MST);
117       *OS << '\n';
118     } else {
119       V->printAsOperand(*OS, true, MST);
120       *OS << '\n';
121     }
122   }
123   void Write(ImmutableCallSite CS) {
124     Write(CS.getInstruction());
125   }
126 
127   void Write(const Metadata *MD) {
128     if (!MD)
129       return;
130     MD->print(*OS, MST, &M);
131     *OS << '\n';
132   }
133 
134   template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
135     Write(MD.get());
136   }
137 
138   void Write(const NamedMDNode *NMD) {
139     if (!NMD)
140       return;
141     NMD->print(*OS, MST);
142     *OS << '\n';
143   }
144 
145   void Write(Type *T) {
146     if (!T)
147       return;
148     *OS << ' ' << *T;
149   }
150 
151   void Write(const Comdat *C) {
152     if (!C)
153       return;
154     *OS << *C;
155   }
156 
157   template <typename T> void Write(ArrayRef<T> Vs) {
158     for (const T &V : Vs)
159       Write(V);
160   }
161 
162   template <typename T1, typename... Ts>
163   void WriteTs(const T1 &V1, const Ts &... Vs) {
164     Write(V1);
165     WriteTs(Vs...);
166   }
167 
168   template <typename... Ts> void WriteTs() {}
169 
170 public:
171   /// \brief A check failed, so printout out the condition and the message.
172   ///
173   /// This provides a nice place to put a breakpoint if you want to see why
174   /// something is not correct.
175   void CheckFailed(const Twine &Message) {
176     if (OS)
177       *OS << Message << '\n';
178     Broken = true;
179   }
180 
181   /// \brief A check failed (with values to print).
182   ///
183   /// This calls the Message-only version so that the above is easier to set a
184   /// breakpoint on.
185   template <typename T1, typename... Ts>
186   void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
187     CheckFailed(Message);
188     if (OS)
189       WriteTs(V1, Vs...);
190   }
191 
192   /// A debug info check failed.
193   void DebugInfoCheckFailed(const Twine &Message) {
194     if (OS)
195       *OS << Message << '\n';
196     Broken |= TreatBrokenDebugInfoAsError;
197     BrokenDebugInfo = true;
198   }
199 
200   /// A debug info check failed (with values to print).
201   template <typename T1, typename... Ts>
202   void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
203                             const Ts &... Vs) {
204     DebugInfoCheckFailed(Message);
205     if (OS)
206       WriteTs(V1, Vs...);
207   }
208 };
209 
210 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
211   friend class InstVisitor<Verifier>;
212 
213   DominatorTree DT;
214 
215   /// \brief When verifying a basic block, keep track of all of the
216   /// instructions we have seen so far.
217   ///
218   /// This allows us to do efficient dominance checks for the case when an
219   /// instruction has an operand that is an instruction in the same block.
220   SmallPtrSet<Instruction *, 16> InstsInThisBlock;
221 
222   /// \brief Keep track of the metadata nodes that have been checked already.
223   SmallPtrSet<const Metadata *, 32> MDNodes;
224 
225   /// Track all DICompileUnits visited.
226   SmallPtrSet<const Metadata *, 2> CUVisited;
227 
228   /// \brief The result type for a landingpad.
229   Type *LandingPadResultTy;
230 
231   /// \brief Whether we've seen a call to @llvm.localescape in this function
232   /// already.
233   bool SawFrameEscape;
234 
235   /// Stores the count of how many objects were passed to llvm.localescape for a
236   /// given function and the largest index passed to llvm.localrecover.
237   DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
238 
239   // Maps catchswitches and cleanuppads that unwind to siblings to the
240   // terminators that indicate the unwind, used to detect cycles therein.
241   MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
242 
243   /// Cache of constants visited in search of ConstantExprs.
244   SmallPtrSet<const Constant *, 32> ConstantExprVisited;
245 
246   /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
247   SmallVector<const Function *, 4> DeoptimizeDeclarations;
248 
249   // Verify that this GlobalValue is only used in this module.
250   // This map is used to avoid visiting uses twice. We can arrive at a user
251   // twice, if they have multiple operands. In particular for very large
252   // constant expressions, we can arrive at a particular user many times.
253   SmallPtrSet<const Value *, 32> GlobalValueVisited;
254 
255   void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
256 
257 public:
258   explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
259                     const Module &M)
260       : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
261         SawFrameEscape(false) {
262     TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
263   }
264 
265   bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
266 
267   bool verify(const Function &F) {
268     assert(F.getParent() == &M &&
269            "An instance of this class only works with a specific module!");
270 
271     // First ensure the function is well-enough formed to compute dominance
272     // information, and directly compute a dominance tree. We don't rely on the
273     // pass manager to provide this as it isolates us from a potentially
274     // out-of-date dominator tree and makes it significantly more complex to run
275     // this code outside of a pass manager.
276     // FIXME: It's really gross that we have to cast away constness here.
277     if (!F.empty())
278       DT.recalculate(const_cast<Function &>(F));
279 
280     for (const BasicBlock &BB : F) {
281       if (!BB.empty() && BB.back().isTerminator())
282         continue;
283 
284       if (OS) {
285         *OS << "Basic Block in function '" << F.getName()
286             << "' does not have terminator!\n";
287         BB.printAsOperand(*OS, true, MST);
288         *OS << "\n";
289       }
290       return false;
291     }
292 
293     Broken = false;
294     // FIXME: We strip const here because the inst visitor strips const.
295     visit(const_cast<Function &>(F));
296     verifySiblingFuncletUnwinds();
297     InstsInThisBlock.clear();
298     LandingPadResultTy = nullptr;
299     SawFrameEscape = false;
300     SiblingFuncletInfo.clear();
301 
302     return !Broken;
303   }
304 
305   /// Verify the module that this instance of \c Verifier was initialized with.
306   bool verify() {
307     Broken = false;
308 
309     // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
310     for (const Function &F : M)
311       if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
312         DeoptimizeDeclarations.push_back(&F);
313 
314     // Now that we've visited every function, verify that we never asked to
315     // recover a frame index that wasn't escaped.
316     verifyFrameRecoverIndices();
317     for (const GlobalVariable &GV : M.globals())
318       visitGlobalVariable(GV);
319 
320     for (const GlobalAlias &GA : M.aliases())
321       visitGlobalAlias(GA);
322 
323     for (const NamedMDNode &NMD : M.named_metadata())
324       visitNamedMDNode(NMD);
325 
326     for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
327       visitComdat(SMEC.getValue());
328 
329     visitModuleFlags(M);
330     visitModuleIdents(M);
331 
332     verifyCompileUnits();
333 
334     verifyDeoptimizeCallingConvs();
335 
336     return !Broken;
337   }
338 
339 private:
340   // Verification methods...
341   void visitGlobalValue(const GlobalValue &GV);
342   void visitGlobalVariable(const GlobalVariable &GV);
343   void visitGlobalAlias(const GlobalAlias &GA);
344   void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
345   void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
346                            const GlobalAlias &A, const Constant &C);
347   void visitNamedMDNode(const NamedMDNode &NMD);
348   void visitMDNode(const MDNode &MD);
349   void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
350   void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
351   void visitComdat(const Comdat &C);
352   void visitModuleIdents(const Module &M);
353   void visitModuleFlags(const Module &M);
354   void visitModuleFlag(const MDNode *Op,
355                        DenseMap<const MDString *, const MDNode *> &SeenIDs,
356                        SmallVectorImpl<const MDNode *> &Requirements);
357   void visitFunction(const Function &F);
358   void visitBasicBlock(BasicBlock &BB);
359   void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
360   void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
361 
362   template <class Ty> bool isValidMetadataArray(const MDTuple &N);
363 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
364 #include "llvm/IR/Metadata.def"
365   void visitDIScope(const DIScope &N);
366   void visitDIVariable(const DIVariable &N);
367   void visitDILexicalBlockBase(const DILexicalBlockBase &N);
368   void visitDITemplateParameter(const DITemplateParameter &N);
369 
370   void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
371 
372   // InstVisitor overrides...
373   using InstVisitor<Verifier>::visit;
374   void visit(Instruction &I);
375 
376   void visitTruncInst(TruncInst &I);
377   void visitZExtInst(ZExtInst &I);
378   void visitSExtInst(SExtInst &I);
379   void visitFPTruncInst(FPTruncInst &I);
380   void visitFPExtInst(FPExtInst &I);
381   void visitFPToUIInst(FPToUIInst &I);
382   void visitFPToSIInst(FPToSIInst &I);
383   void visitUIToFPInst(UIToFPInst &I);
384   void visitSIToFPInst(SIToFPInst &I);
385   void visitIntToPtrInst(IntToPtrInst &I);
386   void visitPtrToIntInst(PtrToIntInst &I);
387   void visitBitCastInst(BitCastInst &I);
388   void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
389   void visitPHINode(PHINode &PN);
390   void visitBinaryOperator(BinaryOperator &B);
391   void visitICmpInst(ICmpInst &IC);
392   void visitFCmpInst(FCmpInst &FC);
393   void visitExtractElementInst(ExtractElementInst &EI);
394   void visitInsertElementInst(InsertElementInst &EI);
395   void visitShuffleVectorInst(ShuffleVectorInst &EI);
396   void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
397   void visitCallInst(CallInst &CI);
398   void visitInvokeInst(InvokeInst &II);
399   void visitGetElementPtrInst(GetElementPtrInst &GEP);
400   void visitLoadInst(LoadInst &LI);
401   void visitStoreInst(StoreInst &SI);
402   void verifyDominatesUse(Instruction &I, unsigned i);
403   void visitInstruction(Instruction &I);
404   void visitTerminatorInst(TerminatorInst &I);
405   void visitBranchInst(BranchInst &BI);
406   void visitReturnInst(ReturnInst &RI);
407   void visitSwitchInst(SwitchInst &SI);
408   void visitIndirectBrInst(IndirectBrInst &BI);
409   void visitSelectInst(SelectInst &SI);
410   void visitUserOp1(Instruction &I);
411   void visitUserOp2(Instruction &I) { visitUserOp1(I); }
412   void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
413   template <class DbgIntrinsicTy>
414   void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
415   void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
416   void visitAtomicRMWInst(AtomicRMWInst &RMWI);
417   void visitFenceInst(FenceInst &FI);
418   void visitAllocaInst(AllocaInst &AI);
419   void visitExtractValueInst(ExtractValueInst &EVI);
420   void visitInsertValueInst(InsertValueInst &IVI);
421   void visitEHPadPredecessors(Instruction &I);
422   void visitLandingPadInst(LandingPadInst &LPI);
423   void visitResumeInst(ResumeInst &RI);
424   void visitCatchPadInst(CatchPadInst &CPI);
425   void visitCatchReturnInst(CatchReturnInst &CatchReturn);
426   void visitCleanupPadInst(CleanupPadInst &CPI);
427   void visitFuncletPadInst(FuncletPadInst &FPI);
428   void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
429   void visitCleanupReturnInst(CleanupReturnInst &CRI);
430 
431   void verifyCallSite(CallSite CS);
432   void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
433   void verifySwiftErrorValue(const Value *SwiftErrorVal);
434   void verifyMustTailCall(CallInst &CI);
435   bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
436                         unsigned ArgNo, std::string &Suffix);
437   bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
438   void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
439                             const Value *V);
440   void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
441                             bool isReturnValue, const Value *V);
442   void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
443                            const Value *V);
444   void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
445 
446   void visitConstantExprsRecursively(const Constant *EntryC);
447   void visitConstantExpr(const ConstantExpr *CE);
448   void verifyStatepoint(ImmutableCallSite CS);
449   void verifyFrameRecoverIndices();
450   void verifySiblingFuncletUnwinds();
451 
452   void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
453 
454   /// Module-level debug info verification...
455   void verifyCompileUnits();
456 
457   /// Module-level verification that all @llvm.experimental.deoptimize
458   /// declarations share the same calling convention.
459   void verifyDeoptimizeCallingConvs();
460 };
461 } // End anonymous namespace
462 
463 /// We know that cond should be true, if not print an error message.
464 #define Assert(C, ...) \
465   do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
466 
467 /// We know that a debug info condition should be true, if not print
468 /// an error message.
469 #define AssertDI(C, ...) \
470   do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (0)
471 
472 
473 void Verifier::visit(Instruction &I) {
474   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
475     Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
476   InstVisitor<Verifier>::visit(I);
477 }
478 
479 // Helper to recursively iterate over indirect users. By
480 // returning false, the callback can ask to stop recursing
481 // further.
482 static void forEachUser(const Value *User,
483                         SmallPtrSet<const Value *, 32> &Visited,
484                         llvm::function_ref<bool(const Value *)> Callback) {
485   if (!Visited.insert(User).second)
486     return;
487   for (const Value *TheNextUser : User->materialized_users())
488     if (Callback(TheNextUser))
489       forEachUser(TheNextUser, Visited, Callback);
490 }
491 
492 void Verifier::visitGlobalValue(const GlobalValue &GV) {
493   Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
494          "Global is external, but doesn't have external or weak linkage!", &GV);
495 
496   Assert(GV.getAlignment() <= Value::MaximumAlignment,
497          "huge alignment values are unsupported", &GV);
498   Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
499          "Only global variables can have appending linkage!", &GV);
500 
501   if (GV.hasAppendingLinkage()) {
502     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
503     Assert(GVar && GVar->getValueType()->isArrayTy(),
504            "Only global arrays can have appending linkage!", GVar);
505   }
506 
507   if (GV.isDeclarationForLinker())
508     Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
509 
510   forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
511     if (const Instruction *I = dyn_cast<Instruction>(V)) {
512       if (!I->getParent() || !I->getParent()->getParent())
513         CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
514                     I);
515       else if (I->getParent()->getParent()->getParent() != &M)
516         CheckFailed("Global is referenced in a different module!", &GV, &M, I,
517                     I->getParent()->getParent(),
518                     I->getParent()->getParent()->getParent());
519       return false;
520     } else if (const Function *F = dyn_cast<Function>(V)) {
521       if (F->getParent() != &M)
522         CheckFailed("Global is used by function in a different module", &GV, &M,
523                     F, F->getParent());
524       return false;
525     }
526     return true;
527   });
528 }
529 
530 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
531   if (GV.hasInitializer()) {
532     Assert(GV.getInitializer()->getType() == GV.getValueType(),
533            "Global variable initializer type does not match global "
534            "variable type!",
535            &GV);
536 
537     // If the global has common linkage, it must have a zero initializer and
538     // cannot be constant.
539     if (GV.hasCommonLinkage()) {
540       Assert(GV.getInitializer()->isNullValue(),
541              "'common' global must have a zero initializer!", &GV);
542       Assert(!GV.isConstant(), "'common' global may not be marked constant!",
543              &GV);
544       Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
545     }
546   }
547 
548   if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
549                        GV.getName() == "llvm.global_dtors")) {
550     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
551            "invalid linkage for intrinsic global variable", &GV);
552     // Don't worry about emitting an error for it not being an array,
553     // visitGlobalValue will complain on appending non-array.
554     if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
555       StructType *STy = dyn_cast<StructType>(ATy->getElementType());
556       PointerType *FuncPtrTy =
557           FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
558       // FIXME: Reject the 2-field form in LLVM 4.0.
559       Assert(STy &&
560                  (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
561                  STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
562                  STy->getTypeAtIndex(1) == FuncPtrTy,
563              "wrong type for intrinsic global variable", &GV);
564       if (STy->getNumElements() == 3) {
565         Type *ETy = STy->getTypeAtIndex(2);
566         Assert(ETy->isPointerTy() &&
567                    cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
568                "wrong type for intrinsic global variable", &GV);
569       }
570     }
571   }
572 
573   if (GV.hasName() && (GV.getName() == "llvm.used" ||
574                        GV.getName() == "llvm.compiler.used")) {
575     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
576            "invalid linkage for intrinsic global variable", &GV);
577     Type *GVType = GV.getValueType();
578     if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
579       PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
580       Assert(PTy, "wrong type for intrinsic global variable", &GV);
581       if (GV.hasInitializer()) {
582         const Constant *Init = GV.getInitializer();
583         const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
584         Assert(InitArray, "wrong initalizer for intrinsic global variable",
585                Init);
586         for (Value *Op : InitArray->operands()) {
587           Value *V = Op->stripPointerCastsNoFollowAliases();
588           Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
589                      isa<GlobalAlias>(V),
590                  "invalid llvm.used member", V);
591           Assert(V->hasName(), "members of llvm.used must be named", V);
592         }
593       }
594     }
595   }
596 
597   Assert(!GV.hasDLLImportStorageClass() ||
598              (GV.isDeclaration() && GV.hasExternalLinkage()) ||
599              GV.hasAvailableExternallyLinkage(),
600          "Global is marked as dllimport, but not external", &GV);
601 
602   if (!GV.hasInitializer()) {
603     visitGlobalValue(GV);
604     return;
605   }
606 
607   // Walk any aggregate initializers looking for bitcasts between address spaces
608   visitConstantExprsRecursively(GV.getInitializer());
609 
610   visitGlobalValue(GV);
611 }
612 
613 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
614   SmallPtrSet<const GlobalAlias*, 4> Visited;
615   Visited.insert(&GA);
616   visitAliaseeSubExpr(Visited, GA, C);
617 }
618 
619 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
620                                    const GlobalAlias &GA, const Constant &C) {
621   if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
622     Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
623            &GA);
624 
625     if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
626       Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
627 
628       Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
629              &GA);
630     } else {
631       // Only continue verifying subexpressions of GlobalAliases.
632       // Do not recurse into global initializers.
633       return;
634     }
635   }
636 
637   if (const auto *CE = dyn_cast<ConstantExpr>(&C))
638     visitConstantExprsRecursively(CE);
639 
640   for (const Use &U : C.operands()) {
641     Value *V = &*U;
642     if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
643       visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
644     else if (const auto *C2 = dyn_cast<Constant>(V))
645       visitAliaseeSubExpr(Visited, GA, *C2);
646   }
647 }
648 
649 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
650   Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
651          "Alias should have private, internal, linkonce, weak, linkonce_odr, "
652          "weak_odr, or external linkage!",
653          &GA);
654   const Constant *Aliasee = GA.getAliasee();
655   Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
656   Assert(GA.getType() == Aliasee->getType(),
657          "Alias and aliasee types should match!", &GA);
658 
659   Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
660          "Aliasee should be either GlobalValue or ConstantExpr", &GA);
661 
662   visitAliaseeSubExpr(GA, *Aliasee);
663 
664   visitGlobalValue(GA);
665 }
666 
667 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
668   for (const MDNode *MD : NMD.operands()) {
669     if (NMD.getName() == "llvm.dbg.cu") {
670       AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
671     }
672 
673     if (!MD)
674       continue;
675 
676     visitMDNode(*MD);
677   }
678 }
679 
680 void Verifier::visitMDNode(const MDNode &MD) {
681   // Only visit each node once.  Metadata can be mutually recursive, so this
682   // avoids infinite recursion here, as well as being an optimization.
683   if (!MDNodes.insert(&MD).second)
684     return;
685 
686   switch (MD.getMetadataID()) {
687   default:
688     llvm_unreachable("Invalid MDNode subclass");
689   case Metadata::MDTupleKind:
690     break;
691 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
692   case Metadata::CLASS##Kind:                                                  \
693     visit##CLASS(cast<CLASS>(MD));                                             \
694     break;
695 #include "llvm/IR/Metadata.def"
696   }
697 
698   for (const Metadata *Op : MD.operands()) {
699     if (!Op)
700       continue;
701     Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
702            &MD, Op);
703     if (auto *N = dyn_cast<MDNode>(Op)) {
704       visitMDNode(*N);
705       continue;
706     }
707     if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
708       visitValueAsMetadata(*V, nullptr);
709       continue;
710     }
711   }
712 
713   // Check these last, so we diagnose problems in operands first.
714   Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
715   Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
716 }
717 
718 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
719   Assert(MD.getValue(), "Expected valid value", &MD);
720   Assert(!MD.getValue()->getType()->isMetadataTy(),
721          "Unexpected metadata round-trip through values", &MD, MD.getValue());
722 
723   auto *L = dyn_cast<LocalAsMetadata>(&MD);
724   if (!L)
725     return;
726 
727   Assert(F, "function-local metadata used outside a function", L);
728 
729   // If this was an instruction, bb, or argument, verify that it is in the
730   // function that we expect.
731   Function *ActualF = nullptr;
732   if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
733     Assert(I->getParent(), "function-local metadata not in basic block", L, I);
734     ActualF = I->getParent()->getParent();
735   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
736     ActualF = BB->getParent();
737   else if (Argument *A = dyn_cast<Argument>(L->getValue()))
738     ActualF = A->getParent();
739   assert(ActualF && "Unimplemented function local metadata case!");
740 
741   Assert(ActualF == F, "function-local metadata used in wrong function", L);
742 }
743 
744 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
745   Metadata *MD = MDV.getMetadata();
746   if (auto *N = dyn_cast<MDNode>(MD)) {
747     visitMDNode(*N);
748     return;
749   }
750 
751   // Only visit each node once.  Metadata can be mutually recursive, so this
752   // avoids infinite recursion here, as well as being an optimization.
753   if (!MDNodes.insert(MD).second)
754     return;
755 
756   if (auto *V = dyn_cast<ValueAsMetadata>(MD))
757     visitValueAsMetadata(*V, F);
758 }
759 
760 static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
761 static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
762 static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
763 
764 template <class Ty>
765 static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
766   for (Metadata *MD : N.operands()) {
767     if (MD) {
768       if (!isa<Ty>(MD))
769         return false;
770     } else {
771       if (!AllowNull)
772         return false;
773     }
774   }
775   return true;
776 }
777 
778 template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
779   return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
780 }
781 
782 template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
783   return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
784 }
785 
786 void Verifier::visitDILocation(const DILocation &N) {
787   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
788            "location requires a valid scope", &N, N.getRawScope());
789   if (auto *IA = N.getRawInlinedAt())
790     AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
791 }
792 
793 void Verifier::visitGenericDINode(const GenericDINode &N) {
794   AssertDI(N.getTag(), "invalid tag", &N);
795 }
796 
797 void Verifier::visitDIScope(const DIScope &N) {
798   if (auto *F = N.getRawFile())
799     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
800 }
801 
802 void Verifier::visitDISubrange(const DISubrange &N) {
803   AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
804   AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
805 }
806 
807 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
808   AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
809 }
810 
811 void Verifier::visitDIBasicType(const DIBasicType &N) {
812   AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
813                N.getTag() == dwarf::DW_TAG_unspecified_type,
814            "invalid tag", &N);
815 }
816 
817 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
818   // Common scope checks.
819   visitDIScope(N);
820 
821   AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
822                N.getTag() == dwarf::DW_TAG_pointer_type ||
823                N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
824                N.getTag() == dwarf::DW_TAG_reference_type ||
825                N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
826                N.getTag() == dwarf::DW_TAG_const_type ||
827                N.getTag() == dwarf::DW_TAG_volatile_type ||
828                N.getTag() == dwarf::DW_TAG_restrict_type ||
829                N.getTag() == dwarf::DW_TAG_member ||
830                N.getTag() == dwarf::DW_TAG_inheritance ||
831                N.getTag() == dwarf::DW_TAG_friend,
832            "invalid tag", &N);
833   if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
834     AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
835              N.getRawExtraData());
836   }
837 
838   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
839   AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
840            N.getRawBaseType());
841 }
842 
843 static bool hasConflictingReferenceFlags(unsigned Flags) {
844   return (Flags & DINode::FlagLValueReference) &&
845          (Flags & DINode::FlagRValueReference);
846 }
847 
848 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
849   auto *Params = dyn_cast<MDTuple>(&RawParams);
850   AssertDI(Params, "invalid template params", &N, &RawParams);
851   for (Metadata *Op : Params->operands()) {
852     AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
853              &N, Params, Op);
854   }
855 }
856 
857 void Verifier::visitDICompositeType(const DICompositeType &N) {
858   // Common scope checks.
859   visitDIScope(N);
860 
861   AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
862                N.getTag() == dwarf::DW_TAG_structure_type ||
863                N.getTag() == dwarf::DW_TAG_union_type ||
864                N.getTag() == dwarf::DW_TAG_enumeration_type ||
865                N.getTag() == dwarf::DW_TAG_class_type,
866            "invalid tag", &N);
867 
868   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
869   AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
870            N.getRawBaseType());
871 
872   AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
873            "invalid composite elements", &N, N.getRawElements());
874   AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
875            N.getRawVTableHolder());
876   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
877            "invalid reference flags", &N);
878   if (auto *Params = N.getRawTemplateParams())
879     visitTemplateParams(N, *Params);
880 
881   if (N.getTag() == dwarf::DW_TAG_class_type ||
882       N.getTag() == dwarf::DW_TAG_union_type) {
883     AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
884              "class/union requires a filename", &N, N.getFile());
885   }
886 }
887 
888 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
889   AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
890   if (auto *Types = N.getRawTypeArray()) {
891     AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
892     for (Metadata *Ty : N.getTypeArray()->operands()) {
893       AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
894     }
895   }
896   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
897            "invalid reference flags", &N);
898 }
899 
900 void Verifier::visitDIFile(const DIFile &N) {
901   AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
902 }
903 
904 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
905   AssertDI(N.isDistinct(), "compile units must be distinct", &N);
906   AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
907 
908   // Don't bother verifying the compilation directory or producer string
909   // as those could be empty.
910   AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
911            N.getRawFile());
912   AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
913            N.getFile());
914 
915   AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
916            "invalid emission kind", &N);
917 
918   if (auto *Array = N.getRawEnumTypes()) {
919     AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
920     for (Metadata *Op : N.getEnumTypes()->operands()) {
921       auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
922       AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
923                "invalid enum type", &N, N.getEnumTypes(), Op);
924     }
925   }
926   if (auto *Array = N.getRawRetainedTypes()) {
927     AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
928     for (Metadata *Op : N.getRetainedTypes()->operands()) {
929       AssertDI(Op && (isa<DIType>(Op) ||
930                       (isa<DISubprogram>(Op) &&
931                        cast<DISubprogram>(Op)->isDefinition() == false)),
932                "invalid retained type", &N, Op);
933     }
934   }
935   if (auto *Array = N.getRawGlobalVariables()) {
936     AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
937     for (Metadata *Op : N.getGlobalVariables()->operands()) {
938       AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
939                &N, Op);
940     }
941   }
942   if (auto *Array = N.getRawImportedEntities()) {
943     AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
944     for (Metadata *Op : N.getImportedEntities()->operands()) {
945       AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
946                &N, Op);
947     }
948   }
949   if (auto *Array = N.getRawMacros()) {
950     AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
951     for (Metadata *Op : N.getMacros()->operands()) {
952       AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
953     }
954   }
955   CUVisited.insert(&N);
956 }
957 
958 void Verifier::visitDISubprogram(const DISubprogram &N) {
959   AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
960   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
961   if (auto *F = N.getRawFile())
962     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
963   if (auto *T = N.getRawType())
964     AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
965   AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
966            N.getRawContainingType());
967   if (auto *Params = N.getRawTemplateParams())
968     visitTemplateParams(N, *Params);
969   if (auto *S = N.getRawDeclaration())
970     AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
971              "invalid subprogram declaration", &N, S);
972   if (auto *RawVars = N.getRawVariables()) {
973     auto *Vars = dyn_cast<MDTuple>(RawVars);
974     AssertDI(Vars, "invalid variable list", &N, RawVars);
975     for (Metadata *Op : Vars->operands()) {
976       AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
977                Vars, Op);
978     }
979   }
980   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
981            "invalid reference flags", &N);
982 
983   auto *Unit = N.getRawUnit();
984   if (N.isDefinition()) {
985     // Subprogram definitions (not part of the type hierarchy).
986     AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
987     AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
988     AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
989   } else {
990     // Subprogram declarations (part of the type hierarchy).
991     AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
992   }
993 }
994 
995 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
996   AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
997   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
998            "invalid local scope", &N, N.getRawScope());
999 }
1000 
1001 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1002   visitDILexicalBlockBase(N);
1003 
1004   AssertDI(N.getLine() || !N.getColumn(),
1005            "cannot have column info without line info", &N);
1006 }
1007 
1008 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1009   visitDILexicalBlockBase(N);
1010 }
1011 
1012 void Verifier::visitDINamespace(const DINamespace &N) {
1013   AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1014   if (auto *S = N.getRawScope())
1015     AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1016 }
1017 
1018 void Verifier::visitDIMacro(const DIMacro &N) {
1019   AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1020                N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1021            "invalid macinfo type", &N);
1022   AssertDI(!N.getName().empty(), "anonymous macro", &N);
1023   if (!N.getValue().empty()) {
1024     assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1025   }
1026 }
1027 
1028 void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1029   AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1030            "invalid macinfo type", &N);
1031   if (auto *F = N.getRawFile())
1032     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1033 
1034   if (auto *Array = N.getRawElements()) {
1035     AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1036     for (Metadata *Op : N.getElements()->operands()) {
1037       AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1038     }
1039   }
1040 }
1041 
1042 void Verifier::visitDIModule(const DIModule &N) {
1043   AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1044   AssertDI(!N.getName().empty(), "anonymous module", &N);
1045 }
1046 
1047 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1048   AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1049 }
1050 
1051 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1052   visitDITemplateParameter(N);
1053 
1054   AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1055            &N);
1056 }
1057 
1058 void Verifier::visitDITemplateValueParameter(
1059     const DITemplateValueParameter &N) {
1060   visitDITemplateParameter(N);
1061 
1062   AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1063                N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1064                N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1065            "invalid tag", &N);
1066 }
1067 
1068 void Verifier::visitDIVariable(const DIVariable &N) {
1069   if (auto *S = N.getRawScope())
1070     AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1071   AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1072   if (auto *F = N.getRawFile())
1073     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1074 }
1075 
1076 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1077   // Checks common to all variables.
1078   visitDIVariable(N);
1079 
1080   AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1081   AssertDI(!N.getName().empty(), "missing global variable name", &N);
1082   if (auto *V = N.getRawVariable()) {
1083     AssertDI(isa<ConstantAsMetadata>(V) &&
1084                  !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1085              "invalid global varaible ref", &N, V);
1086     visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
1087   }
1088   if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1089     AssertDI(isa<DIDerivedType>(Member),
1090              "invalid static data member declaration", &N, Member);
1091   }
1092 }
1093 
1094 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1095   // Checks common to all variables.
1096   visitDIVariable(N);
1097 
1098   AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1099   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1100            "local variable requires a valid scope", &N, N.getRawScope());
1101 }
1102 
1103 void Verifier::visitDIExpression(const DIExpression &N) {
1104   AssertDI(N.isValid(), "invalid expression", &N);
1105 }
1106 
1107 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1108   AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1109   if (auto *T = N.getRawType())
1110     AssertDI(isType(T), "invalid type ref", &N, T);
1111   if (auto *F = N.getRawFile())
1112     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1113 }
1114 
1115 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1116   AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1117                N.getTag() == dwarf::DW_TAG_imported_declaration,
1118            "invalid tag", &N);
1119   if (auto *S = N.getRawScope())
1120     AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1121   AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1122            N.getRawEntity());
1123 }
1124 
1125 void Verifier::visitComdat(const Comdat &C) {
1126   // The Module is invalid if the GlobalValue has private linkage.  Entities
1127   // with private linkage don't have entries in the symbol table.
1128   if (const GlobalValue *GV = M.getNamedValue(C.getName()))
1129     Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1130            GV);
1131 }
1132 
1133 void Verifier::visitModuleIdents(const Module &M) {
1134   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1135   if (!Idents)
1136     return;
1137 
1138   // llvm.ident takes a list of metadata entry. Each entry has only one string.
1139   // Scan each llvm.ident entry and make sure that this requirement is met.
1140   for (const MDNode *N : Idents->operands()) {
1141     Assert(N->getNumOperands() == 1,
1142            "incorrect number of operands in llvm.ident metadata", N);
1143     Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1144            ("invalid value for llvm.ident metadata entry operand"
1145             "(the operand should be a string)"),
1146            N->getOperand(0));
1147   }
1148 }
1149 
1150 void Verifier::visitModuleFlags(const Module &M) {
1151   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1152   if (!Flags) return;
1153 
1154   // Scan each flag, and track the flags and requirements.
1155   DenseMap<const MDString*, const MDNode*> SeenIDs;
1156   SmallVector<const MDNode*, 16> Requirements;
1157   for (const MDNode *MDN : Flags->operands())
1158     visitModuleFlag(MDN, SeenIDs, Requirements);
1159 
1160   // Validate that the requirements in the module are valid.
1161   for (const MDNode *Requirement : Requirements) {
1162     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1163     const Metadata *ReqValue = Requirement->getOperand(1);
1164 
1165     const MDNode *Op = SeenIDs.lookup(Flag);
1166     if (!Op) {
1167       CheckFailed("invalid requirement on flag, flag is not present in module",
1168                   Flag);
1169       continue;
1170     }
1171 
1172     if (Op->getOperand(2) != ReqValue) {
1173       CheckFailed(("invalid requirement on flag, "
1174                    "flag does not have the required value"),
1175                   Flag);
1176       continue;
1177     }
1178   }
1179 }
1180 
1181 void
1182 Verifier::visitModuleFlag(const MDNode *Op,
1183                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
1184                           SmallVectorImpl<const MDNode *> &Requirements) {
1185   // Each module flag should have three arguments, the merge behavior (a
1186   // constant int), the flag ID (an MDString), and the value.
1187   Assert(Op->getNumOperands() == 3,
1188          "incorrect number of operands in module flag", Op);
1189   Module::ModFlagBehavior MFB;
1190   if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1191     Assert(
1192         mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1193         "invalid behavior operand in module flag (expected constant integer)",
1194         Op->getOperand(0));
1195     Assert(false,
1196            "invalid behavior operand in module flag (unexpected constant)",
1197            Op->getOperand(0));
1198   }
1199   MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1200   Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1201          Op->getOperand(1));
1202 
1203   // Sanity check the values for behaviors with additional requirements.
1204   switch (MFB) {
1205   case Module::Error:
1206   case Module::Warning:
1207   case Module::Override:
1208     // These behavior types accept any value.
1209     break;
1210 
1211   case Module::Require: {
1212     // The value should itself be an MDNode with two operands, a flag ID (an
1213     // MDString), and a value.
1214     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1215     Assert(Value && Value->getNumOperands() == 2,
1216            "invalid value for 'require' module flag (expected metadata pair)",
1217            Op->getOperand(2));
1218     Assert(isa<MDString>(Value->getOperand(0)),
1219            ("invalid value for 'require' module flag "
1220             "(first value operand should be a string)"),
1221            Value->getOperand(0));
1222 
1223     // Append it to the list of requirements, to check once all module flags are
1224     // scanned.
1225     Requirements.push_back(Value);
1226     break;
1227   }
1228 
1229   case Module::Append:
1230   case Module::AppendUnique: {
1231     // These behavior types require the operand be an MDNode.
1232     Assert(isa<MDNode>(Op->getOperand(2)),
1233            "invalid value for 'append'-type module flag "
1234            "(expected a metadata node)",
1235            Op->getOperand(2));
1236     break;
1237   }
1238   }
1239 
1240   // Unless this is a "requires" flag, check the ID is unique.
1241   if (MFB != Module::Require) {
1242     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1243     Assert(Inserted,
1244            "module flag identifiers must be unique (or of 'require' type)", ID);
1245   }
1246 }
1247 
1248 void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1249                                     bool isFunction, const Value *V) {
1250   unsigned Slot = ~0U;
1251   for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1252     if (Attrs.getSlotIndex(I) == Idx) {
1253       Slot = I;
1254       break;
1255     }
1256 
1257   assert(Slot != ~0U && "Attribute set inconsistency!");
1258 
1259   for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1260          I != E; ++I) {
1261     if (I->isStringAttribute())
1262       continue;
1263 
1264     if (I->getKindAsEnum() == Attribute::NoReturn ||
1265         I->getKindAsEnum() == Attribute::NoUnwind ||
1266         I->getKindAsEnum() == Attribute::NoInline ||
1267         I->getKindAsEnum() == Attribute::AlwaysInline ||
1268         I->getKindAsEnum() == Attribute::OptimizeForSize ||
1269         I->getKindAsEnum() == Attribute::StackProtect ||
1270         I->getKindAsEnum() == Attribute::StackProtectReq ||
1271         I->getKindAsEnum() == Attribute::StackProtectStrong ||
1272         I->getKindAsEnum() == Attribute::SafeStack ||
1273         I->getKindAsEnum() == Attribute::NoRedZone ||
1274         I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1275         I->getKindAsEnum() == Attribute::Naked ||
1276         I->getKindAsEnum() == Attribute::InlineHint ||
1277         I->getKindAsEnum() == Attribute::StackAlignment ||
1278         I->getKindAsEnum() == Attribute::UWTable ||
1279         I->getKindAsEnum() == Attribute::NonLazyBind ||
1280         I->getKindAsEnum() == Attribute::ReturnsTwice ||
1281         I->getKindAsEnum() == Attribute::SanitizeAddress ||
1282         I->getKindAsEnum() == Attribute::SanitizeThread ||
1283         I->getKindAsEnum() == Attribute::SanitizeMemory ||
1284         I->getKindAsEnum() == Attribute::MinSize ||
1285         I->getKindAsEnum() == Attribute::NoDuplicate ||
1286         I->getKindAsEnum() == Attribute::Builtin ||
1287         I->getKindAsEnum() == Attribute::NoBuiltin ||
1288         I->getKindAsEnum() == Attribute::Cold ||
1289         I->getKindAsEnum() == Attribute::OptimizeNone ||
1290         I->getKindAsEnum() == Attribute::JumpTable ||
1291         I->getKindAsEnum() == Attribute::Convergent ||
1292         I->getKindAsEnum() == Attribute::ArgMemOnly ||
1293         I->getKindAsEnum() == Attribute::NoRecurse ||
1294         I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1295         I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1296         I->getKindAsEnum() == Attribute::AllocSize) {
1297       if (!isFunction) {
1298         CheckFailed("Attribute '" + I->getAsString() +
1299                     "' only applies to functions!", V);
1300         return;
1301       }
1302     } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1303                I->getKindAsEnum() == Attribute::WriteOnly ||
1304                I->getKindAsEnum() == Attribute::ReadNone) {
1305       if (Idx == 0) {
1306         CheckFailed("Attribute '" + I->getAsString() +
1307                     "' does not apply to function returns");
1308         return;
1309       }
1310     } else if (isFunction) {
1311       CheckFailed("Attribute '" + I->getAsString() +
1312                   "' does not apply to functions!", V);
1313       return;
1314     }
1315   }
1316 }
1317 
1318 // VerifyParameterAttrs - Check the given attributes for an argument or return
1319 // value of the specified type.  The value V is printed in error messages.
1320 void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1321                                     bool isReturnValue, const Value *V) {
1322   if (!Attrs.hasAttributes(Idx))
1323     return;
1324 
1325   verifyAttributeTypes(Attrs, Idx, false, V);
1326 
1327   if (isReturnValue)
1328     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1329                !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1330                !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1331                !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1332                !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1333                !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1334                !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1335                !Attrs.hasAttribute(Idx, Attribute::SwiftError),
1336            "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
1337            "'returned', 'swiftself', and 'swifterror' do not apply to return "
1338            "values!",
1339            V);
1340 
1341   // Check for mutually incompatible attributes.  Only inreg is compatible with
1342   // sret.
1343   unsigned AttrCount = 0;
1344   AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1345   AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1346   AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1347                Attrs.hasAttribute(Idx, Attribute::InReg);
1348   AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1349   Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1350                          "and 'sret' are incompatible!",
1351          V);
1352 
1353   Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1354            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1355          "Attributes "
1356          "'inalloca and readonly' are incompatible!",
1357          V);
1358 
1359   Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1360            Attrs.hasAttribute(Idx, Attribute::Returned)),
1361          "Attributes "
1362          "'sret and returned' are incompatible!",
1363          V);
1364 
1365   Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1366            Attrs.hasAttribute(Idx, Attribute::SExt)),
1367          "Attributes "
1368          "'zeroext and signext' are incompatible!",
1369          V);
1370 
1371   Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1372            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1373          "Attributes "
1374          "'readnone and readonly' are incompatible!",
1375          V);
1376 
1377   Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1378            Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1379          "Attributes "
1380          "'readnone and writeonly' are incompatible!",
1381          V);
1382 
1383   Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1384            Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1385          "Attributes "
1386          "'readonly and writeonly' are incompatible!",
1387          V);
1388 
1389   Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1390            Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1391          "Attributes "
1392          "'noinline and alwaysinline' are incompatible!",
1393          V);
1394 
1395   Assert(
1396       !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1397       "Wrong types for attribute: " +
1398           AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1399               .getAsString(Idx),
1400       V);
1401 
1402   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1403     SmallPtrSet<Type*, 4> Visited;
1404     if (!PTy->getElementType()->isSized(&Visited)) {
1405       Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1406                  !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1407              "Attributes 'byval' and 'inalloca' do not support unsized types!",
1408              V);
1409     }
1410     if (!isa<PointerType>(PTy->getElementType()))
1411       Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1412              "Attribute 'swifterror' only applies to parameters "
1413              "with pointer to pointer type!",
1414              V);
1415   } else {
1416     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1417            "Attribute 'byval' only applies to parameters with pointer type!",
1418            V);
1419     Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1420            "Attribute 'swifterror' only applies to parameters "
1421            "with pointer type!",
1422            V);
1423   }
1424 }
1425 
1426 // Check parameter attributes against a function type.
1427 // The value V is printed in error messages.
1428 void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1429                                    const Value *V) {
1430   if (Attrs.isEmpty())
1431     return;
1432 
1433   bool SawNest = false;
1434   bool SawReturned = false;
1435   bool SawSRet = false;
1436   bool SawSwiftSelf = false;
1437   bool SawSwiftError = false;
1438 
1439   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1440     unsigned Idx = Attrs.getSlotIndex(i);
1441 
1442     Type *Ty;
1443     if (Idx == 0)
1444       Ty = FT->getReturnType();
1445     else if (Idx-1 < FT->getNumParams())
1446       Ty = FT->getParamType(Idx-1);
1447     else
1448       break;  // VarArgs attributes, verified elsewhere.
1449 
1450     verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1451 
1452     if (Idx == 0)
1453       continue;
1454 
1455     if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1456       Assert(!SawNest, "More than one parameter has attribute nest!", V);
1457       SawNest = true;
1458     }
1459 
1460     if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1461       Assert(!SawReturned, "More than one parameter has attribute returned!",
1462              V);
1463       Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1464              "Incompatible "
1465              "argument and return types for 'returned' attribute",
1466              V);
1467       SawReturned = true;
1468     }
1469 
1470     if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1471       Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1472       Assert(Idx == 1 || Idx == 2,
1473              "Attribute 'sret' is not on first or second parameter!", V);
1474       SawSRet = true;
1475     }
1476 
1477     if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1478       Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1479       SawSwiftSelf = true;
1480     }
1481 
1482     if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1483       Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1484              V);
1485       SawSwiftError = true;
1486     }
1487 
1488     if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1489       Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1490              V);
1491     }
1492   }
1493 
1494   if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1495     return;
1496 
1497   verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1498 
1499   Assert(
1500       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1501         Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1502       "Attributes 'readnone and readonly' are incompatible!", V);
1503 
1504   Assert(
1505       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1506         Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1507       "Attributes 'readnone and writeonly' are incompatible!", V);
1508 
1509   Assert(
1510       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1511         Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1512       "Attributes 'readonly and writeonly' are incompatible!", V);
1513 
1514   Assert(
1515       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1516         Attrs.hasAttribute(AttributeSet::FunctionIndex,
1517                            Attribute::InaccessibleMemOrArgMemOnly)),
1518       "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1519 
1520   Assert(
1521       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1522         Attrs.hasAttribute(AttributeSet::FunctionIndex,
1523                            Attribute::InaccessibleMemOnly)),
1524       "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1525 
1526   Assert(
1527       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1528         Attrs.hasAttribute(AttributeSet::FunctionIndex,
1529                            Attribute::AlwaysInline)),
1530       "Attributes 'noinline and alwaysinline' are incompatible!", V);
1531 
1532   if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1533                          Attribute::OptimizeNone)) {
1534     Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1535            "Attribute 'optnone' requires 'noinline'!", V);
1536 
1537     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1538                                Attribute::OptimizeForSize),
1539            "Attributes 'optsize and optnone' are incompatible!", V);
1540 
1541     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1542            "Attributes 'minsize and optnone' are incompatible!", V);
1543   }
1544 
1545   if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1546                          Attribute::JumpTable)) {
1547     const GlobalValue *GV = cast<GlobalValue>(V);
1548     Assert(GV->hasGlobalUnnamedAddr(),
1549            "Attribute 'jumptable' requires 'unnamed_addr'", V);
1550   }
1551 
1552   if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1553     std::pair<unsigned, Optional<unsigned>> Args =
1554         Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1555 
1556     auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1557       if (ParamNo >= FT->getNumParams()) {
1558         CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1559         return false;
1560       }
1561 
1562       if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1563         CheckFailed("'allocsize' " + Name +
1564                         " argument must refer to an integer parameter",
1565                     V);
1566         return false;
1567       }
1568 
1569       return true;
1570     };
1571 
1572     if (!CheckParam("element size", Args.first))
1573       return;
1574 
1575     if (Args.second && !CheckParam("number of elements", *Args.second))
1576       return;
1577   }
1578 }
1579 
1580 void Verifier::verifyFunctionMetadata(
1581     ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
1582   for (const auto &Pair : MDs) {
1583     if (Pair.first == LLVMContext::MD_prof) {
1584       MDNode *MD = Pair.second;
1585       Assert(MD->getNumOperands() == 2,
1586              "!prof annotations should have exactly 2 operands", MD);
1587 
1588       // Check first operand.
1589       Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1590              MD);
1591       Assert(isa<MDString>(MD->getOperand(0)),
1592              "expected string with name of the !prof annotation", MD);
1593       MDString *MDS = cast<MDString>(MD->getOperand(0));
1594       StringRef ProfName = MDS->getString();
1595       Assert(ProfName.equals("function_entry_count"),
1596              "first operand should be 'function_entry_count'", MD);
1597 
1598       // Check second operand.
1599       Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1600              MD);
1601       Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1602              "expected integer argument to function_entry_count", MD);
1603     }
1604   }
1605 }
1606 
1607 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1608   if (!ConstantExprVisited.insert(EntryC).second)
1609     return;
1610 
1611   SmallVector<const Constant *, 16> Stack;
1612   Stack.push_back(EntryC);
1613 
1614   while (!Stack.empty()) {
1615     const Constant *C = Stack.pop_back_val();
1616 
1617     // Check this constant expression.
1618     if (const auto *CE = dyn_cast<ConstantExpr>(C))
1619       visitConstantExpr(CE);
1620 
1621     if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1622       // Global Values get visited separately, but we do need to make sure
1623       // that the global value is in the correct module
1624       Assert(GV->getParent() == &M, "Referencing global in another module!",
1625              EntryC, &M, GV, GV->getParent());
1626       continue;
1627     }
1628 
1629     // Visit all sub-expressions.
1630     for (const Use &U : C->operands()) {
1631       const auto *OpC = dyn_cast<Constant>(U);
1632       if (!OpC)
1633         continue;
1634       if (!ConstantExprVisited.insert(OpC).second)
1635         continue;
1636       Stack.push_back(OpC);
1637     }
1638   }
1639 }
1640 
1641 void Verifier::visitConstantExpr(const ConstantExpr *CE) {
1642   if (CE->getOpcode() == Instruction::BitCast)
1643     Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1644                                  CE->getType()),
1645            "Invalid bitcast", CE);
1646 
1647   if (CE->getOpcode() == Instruction::IntToPtr ||
1648       CE->getOpcode() == Instruction::PtrToInt) {
1649     auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1650                       ? CE->getType()
1651                       : CE->getOperand(0)->getType();
1652     StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1653                         ? "inttoptr not supported for non-integral pointers"
1654                         : "ptrtoint not supported for non-integral pointers";
1655     Assert(
1656         !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1657         Msg);
1658   }
1659 }
1660 
1661 bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1662   if (Attrs.getNumSlots() == 0)
1663     return true;
1664 
1665   unsigned LastSlot = Attrs.getNumSlots() - 1;
1666   unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1667   if (LastIndex <= Params
1668       || (LastIndex == AttributeSet::FunctionIndex
1669           && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1670     return true;
1671 
1672   return false;
1673 }
1674 
1675 /// Verify that statepoint intrinsic is well formed.
1676 void Verifier::verifyStatepoint(ImmutableCallSite CS) {
1677   assert(CS.getCalledFunction() &&
1678          CS.getCalledFunction()->getIntrinsicID() ==
1679            Intrinsic::experimental_gc_statepoint);
1680 
1681   const Instruction &CI = *CS.getInstruction();
1682 
1683   Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1684          !CS.onlyAccessesArgMemory(),
1685          "gc.statepoint must read and write all memory to preserve "
1686          "reordering restrictions required by safepoint semantics",
1687          &CI);
1688 
1689   const Value *IDV = CS.getArgument(0);
1690   Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1691          &CI);
1692 
1693   const Value *NumPatchBytesV = CS.getArgument(1);
1694   Assert(isa<ConstantInt>(NumPatchBytesV),
1695          "gc.statepoint number of patchable bytes must be a constant integer",
1696          &CI);
1697   const int64_t NumPatchBytes =
1698       cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1699   assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1700   Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1701                              "positive",
1702          &CI);
1703 
1704   const Value *Target = CS.getArgument(2);
1705   auto *PT = dyn_cast<PointerType>(Target->getType());
1706   Assert(PT && PT->getElementType()->isFunctionTy(),
1707          "gc.statepoint callee must be of function pointer type", &CI, Target);
1708   FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1709 
1710   const Value *NumCallArgsV = CS.getArgument(3);
1711   Assert(isa<ConstantInt>(NumCallArgsV),
1712          "gc.statepoint number of arguments to underlying call "
1713          "must be constant integer",
1714          &CI);
1715   const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1716   Assert(NumCallArgs >= 0,
1717          "gc.statepoint number of arguments to underlying call "
1718          "must be positive",
1719          &CI);
1720   const int NumParams = (int)TargetFuncType->getNumParams();
1721   if (TargetFuncType->isVarArg()) {
1722     Assert(NumCallArgs >= NumParams,
1723            "gc.statepoint mismatch in number of vararg call args", &CI);
1724 
1725     // TODO: Remove this limitation
1726     Assert(TargetFuncType->getReturnType()->isVoidTy(),
1727            "gc.statepoint doesn't support wrapping non-void "
1728            "vararg functions yet",
1729            &CI);
1730   } else
1731     Assert(NumCallArgs == NumParams,
1732            "gc.statepoint mismatch in number of call args", &CI);
1733 
1734   const Value *FlagsV = CS.getArgument(4);
1735   Assert(isa<ConstantInt>(FlagsV),
1736          "gc.statepoint flags must be constant integer", &CI);
1737   const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1738   Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1739          "unknown flag used in gc.statepoint flags argument", &CI);
1740 
1741   // Verify that the types of the call parameter arguments match
1742   // the type of the wrapped callee.
1743   for (int i = 0; i < NumParams; i++) {
1744     Type *ParamType = TargetFuncType->getParamType(i);
1745     Type *ArgType = CS.getArgument(5 + i)->getType();
1746     Assert(ArgType == ParamType,
1747            "gc.statepoint call argument does not match wrapped "
1748            "function type",
1749            &CI);
1750   }
1751 
1752   const int EndCallArgsInx = 4 + NumCallArgs;
1753 
1754   const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1755   Assert(isa<ConstantInt>(NumTransitionArgsV),
1756          "gc.statepoint number of transition arguments "
1757          "must be constant integer",
1758          &CI);
1759   const int NumTransitionArgs =
1760       cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1761   Assert(NumTransitionArgs >= 0,
1762          "gc.statepoint number of transition arguments must be positive", &CI);
1763   const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1764 
1765   const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1766   Assert(isa<ConstantInt>(NumDeoptArgsV),
1767          "gc.statepoint number of deoptimization arguments "
1768          "must be constant integer",
1769          &CI);
1770   const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1771   Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1772                             "must be positive",
1773          &CI);
1774 
1775   const int ExpectedNumArgs =
1776       7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1777   Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1778          "gc.statepoint too few arguments according to length fields", &CI);
1779 
1780   // Check that the only uses of this gc.statepoint are gc.result or
1781   // gc.relocate calls which are tied to this statepoint and thus part
1782   // of the same statepoint sequence
1783   for (const User *U : CI.users()) {
1784     const CallInst *Call = dyn_cast<const CallInst>(U);
1785     Assert(Call, "illegal use of statepoint token", &CI, U);
1786     if (!Call) continue;
1787     Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
1788            "gc.result or gc.relocate are the only value uses "
1789            "of a gc.statepoint",
1790            &CI, U);
1791     if (isa<GCResultInst>(Call)) {
1792       Assert(Call->getArgOperand(0) == &CI,
1793              "gc.result connected to wrong gc.statepoint", &CI, Call);
1794     } else if (isa<GCRelocateInst>(Call)) {
1795       Assert(Call->getArgOperand(0) == &CI,
1796              "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1797     }
1798   }
1799 
1800   // Note: It is legal for a single derived pointer to be listed multiple
1801   // times.  It's non-optimal, but it is legal.  It can also happen after
1802   // insertion if we strip a bitcast away.
1803   // Note: It is really tempting to check that each base is relocated and
1804   // that a derived pointer is never reused as a base pointer.  This turns
1805   // out to be problematic since optimizations run after safepoint insertion
1806   // can recognize equality properties that the insertion logic doesn't know
1807   // about.  See example statepoint.ll in the verifier subdirectory
1808 }
1809 
1810 void Verifier::verifyFrameRecoverIndices() {
1811   for (auto &Counts : FrameEscapeInfo) {
1812     Function *F = Counts.first;
1813     unsigned EscapedObjectCount = Counts.second.first;
1814     unsigned MaxRecoveredIndex = Counts.second.second;
1815     Assert(MaxRecoveredIndex <= EscapedObjectCount,
1816            "all indices passed to llvm.localrecover must be less than the "
1817            "number of arguments passed ot llvm.localescape in the parent "
1818            "function",
1819            F);
1820   }
1821 }
1822 
1823 static Instruction *getSuccPad(TerminatorInst *Terminator) {
1824   BasicBlock *UnwindDest;
1825   if (auto *II = dyn_cast<InvokeInst>(Terminator))
1826     UnwindDest = II->getUnwindDest();
1827   else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1828     UnwindDest = CSI->getUnwindDest();
1829   else
1830     UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1831   return UnwindDest->getFirstNonPHI();
1832 }
1833 
1834 void Verifier::verifySiblingFuncletUnwinds() {
1835   SmallPtrSet<Instruction *, 8> Visited;
1836   SmallPtrSet<Instruction *, 8> Active;
1837   for (const auto &Pair : SiblingFuncletInfo) {
1838     Instruction *PredPad = Pair.first;
1839     if (Visited.count(PredPad))
1840       continue;
1841     Active.insert(PredPad);
1842     TerminatorInst *Terminator = Pair.second;
1843     do {
1844       Instruction *SuccPad = getSuccPad(Terminator);
1845       if (Active.count(SuccPad)) {
1846         // Found a cycle; report error
1847         Instruction *CyclePad = SuccPad;
1848         SmallVector<Instruction *, 8> CycleNodes;
1849         do {
1850           CycleNodes.push_back(CyclePad);
1851           TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1852           if (CycleTerminator != CyclePad)
1853             CycleNodes.push_back(CycleTerminator);
1854           CyclePad = getSuccPad(CycleTerminator);
1855         } while (CyclePad != SuccPad);
1856         Assert(false, "EH pads can't handle each other's exceptions",
1857                ArrayRef<Instruction *>(CycleNodes));
1858       }
1859       // Don't re-walk a node we've already checked
1860       if (!Visited.insert(SuccPad).second)
1861         break;
1862       // Walk to this successor if it has a map entry.
1863       PredPad = SuccPad;
1864       auto TermI = SiblingFuncletInfo.find(PredPad);
1865       if (TermI == SiblingFuncletInfo.end())
1866         break;
1867       Terminator = TermI->second;
1868       Active.insert(PredPad);
1869     } while (true);
1870     // Each node only has one successor, so we've walked all the active
1871     // nodes' successors.
1872     Active.clear();
1873   }
1874 }
1875 
1876 // visitFunction - Verify that a function is ok.
1877 //
1878 void Verifier::visitFunction(const Function &F) {
1879   visitGlobalValue(F);
1880 
1881   // Check function arguments.
1882   FunctionType *FT = F.getFunctionType();
1883   unsigned NumArgs = F.arg_size();
1884 
1885   Assert(&Context == &F.getContext(),
1886          "Function context does not match Module context!", &F);
1887 
1888   Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1889   Assert(FT->getNumParams() == NumArgs,
1890          "# formal arguments must match # of arguments for function type!", &F,
1891          FT);
1892   Assert(F.getReturnType()->isFirstClassType() ||
1893              F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1894          "Functions cannot return aggregate values!", &F);
1895 
1896   Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1897          "Invalid struct return type!", &F);
1898 
1899   AttributeSet Attrs = F.getAttributes();
1900 
1901   Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
1902          "Attribute after last parameter!", &F);
1903 
1904   // Check function attributes.
1905   verifyFunctionAttrs(FT, Attrs, &F);
1906 
1907   // On function declarations/definitions, we do not support the builtin
1908   // attribute. We do not check this in VerifyFunctionAttrs since that is
1909   // checking for Attributes that can/can not ever be on functions.
1910   Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1911          "Attribute 'builtin' can only be applied to a callsite.", &F);
1912 
1913   // Check that this function meets the restrictions on this calling convention.
1914   // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1915   // restrictions can be lifted.
1916   switch (F.getCallingConv()) {
1917   default:
1918   case CallingConv::C:
1919     break;
1920   case CallingConv::Fast:
1921   case CallingConv::Cold:
1922   case CallingConv::Intel_OCL_BI:
1923   case CallingConv::PTX_Kernel:
1924   case CallingConv::PTX_Device:
1925     Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1926                           "perfect forwarding!",
1927            &F);
1928     break;
1929   }
1930 
1931   bool isLLVMdotName = F.getName().size() >= 5 &&
1932                        F.getName().substr(0, 5) == "llvm.";
1933 
1934   // Check that the argument values match the function type for this function...
1935   unsigned i = 0;
1936   for (const Argument &Arg : F.args()) {
1937     Assert(Arg.getType() == FT->getParamType(i),
1938            "Argument value does not match function argument type!", &Arg,
1939            FT->getParamType(i));
1940     Assert(Arg.getType()->isFirstClassType(),
1941            "Function arguments must have first-class types!", &Arg);
1942     if (!isLLVMdotName) {
1943       Assert(!Arg.getType()->isMetadataTy(),
1944              "Function takes metadata but isn't an intrinsic", &Arg, &F);
1945       Assert(!Arg.getType()->isTokenTy(),
1946              "Function takes token but isn't an intrinsic", &Arg, &F);
1947     }
1948 
1949     // Check that swifterror argument is only used by loads and stores.
1950     if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1951       verifySwiftErrorValue(&Arg);
1952     }
1953     ++i;
1954   }
1955 
1956   if (!isLLVMdotName)
1957     Assert(!F.getReturnType()->isTokenTy(),
1958            "Functions returns a token but isn't an intrinsic", &F);
1959 
1960   // Get the function metadata attachments.
1961   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1962   F.getAllMetadata(MDs);
1963   assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1964   verifyFunctionMetadata(MDs);
1965 
1966   // Check validity of the personality function
1967   if (F.hasPersonalityFn()) {
1968     auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1969     if (Per)
1970       Assert(Per->getParent() == F.getParent(),
1971              "Referencing personality function in another module!",
1972              &F, F.getParent(), Per, Per->getParent());
1973   }
1974 
1975   if (F.isMaterializable()) {
1976     // Function has a body somewhere we can't see.
1977     Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1978            MDs.empty() ? nullptr : MDs.front().second);
1979   } else if (F.isDeclaration()) {
1980     for (const auto &I : MDs) {
1981       AssertDI(I.first != LLVMContext::MD_dbg,
1982                "function declaration may not have a !dbg attachment", &F);
1983       Assert(I.first != LLVMContext::MD_prof,
1984              "function declaration may not have a !prof attachment", &F);
1985 
1986       // Verify the metadata itself.
1987       visitMDNode(*I.second);
1988     }
1989     Assert(!F.hasPersonalityFn(),
1990            "Function declaration shouldn't have a personality routine", &F);
1991   } else {
1992     // Verify that this function (which has a body) is not named "llvm.*".  It
1993     // is not legal to define intrinsics.
1994     Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1995 
1996     // Check the entry node
1997     const BasicBlock *Entry = &F.getEntryBlock();
1998     Assert(pred_empty(Entry),
1999            "Entry block to function must not have predecessors!", Entry);
2000 
2001     // The address of the entry block cannot be taken, unless it is dead.
2002     if (Entry->hasAddressTaken()) {
2003       Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2004              "blockaddress may not be used with the entry block!", Entry);
2005     }
2006 
2007     unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
2008     // Visit metadata attachments.
2009     for (const auto &I : MDs) {
2010       // Verify that the attachment is legal.
2011       switch (I.first) {
2012       default:
2013         break;
2014       case LLVMContext::MD_dbg:
2015         ++NumDebugAttachments;
2016         AssertDI(NumDebugAttachments == 1,
2017                  "function must have a single !dbg attachment", &F, I.second);
2018         AssertDI(isa<DISubprogram>(I.second),
2019                  "function !dbg attachment must be a subprogram", &F, I.second);
2020         break;
2021       case LLVMContext::MD_prof:
2022         ++NumProfAttachments;
2023         Assert(NumProfAttachments == 1,
2024                "function must have a single !prof attachment", &F, I.second);
2025         break;
2026       }
2027 
2028       // Verify the metadata itself.
2029       visitMDNode(*I.second);
2030     }
2031   }
2032 
2033   // If this function is actually an intrinsic, verify that it is only used in
2034   // direct call/invokes, never having its "address taken".
2035   // Only do this if the module is materialized, otherwise we don't have all the
2036   // uses.
2037   if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
2038     const User *U;
2039     if (F.hasAddressTaken(&U))
2040       Assert(0, "Invalid user of intrinsic instruction!", U);
2041   }
2042 
2043   Assert(!F.hasDLLImportStorageClass() ||
2044              (F.isDeclaration() && F.hasExternalLinkage()) ||
2045              F.hasAvailableExternallyLinkage(),
2046          "Function is marked as dllimport, but not external.", &F);
2047 
2048   auto *N = F.getSubprogram();
2049   if (!N)
2050     return;
2051 
2052   visitDISubprogram(*N);
2053 
2054   // Check that all !dbg attachments lead to back to N (or, at least, another
2055   // subprogram that describes the same function).
2056   //
2057   // FIXME: Check this incrementally while visiting !dbg attachments.
2058   // FIXME: Only check when N is the canonical subprogram for F.
2059   SmallPtrSet<const MDNode *, 32> Seen;
2060   for (auto &BB : F)
2061     for (auto &I : BB) {
2062       // Be careful about using DILocation here since we might be dealing with
2063       // broken code (this is the Verifier after all).
2064       DILocation *DL =
2065           dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2066       if (!DL)
2067         continue;
2068       if (!Seen.insert(DL).second)
2069         continue;
2070 
2071       DILocalScope *Scope = DL->getInlinedAtScope();
2072       if (Scope && !Seen.insert(Scope).second)
2073         continue;
2074 
2075       DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
2076 
2077       // Scope and SP could be the same MDNode and we don't want to skip
2078       // validation in that case
2079       if (SP && ((Scope != SP) && !Seen.insert(SP).second))
2080         continue;
2081 
2082       // FIXME: Once N is canonical, check "SP == &N".
2083       Assert(SP->describes(&F),
2084              "!dbg attachment points at wrong subprogram for function", N, &F,
2085              &I, DL, Scope, SP);
2086     }
2087 }
2088 
2089 // verifyBasicBlock - Verify that a basic block is well formed...
2090 //
2091 void Verifier::visitBasicBlock(BasicBlock &BB) {
2092   InstsInThisBlock.clear();
2093 
2094   // Ensure that basic blocks have terminators!
2095   Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
2096 
2097   // Check constraints that this basic block imposes on all of the PHI nodes in
2098   // it.
2099   if (isa<PHINode>(BB.front())) {
2100     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2101     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
2102     std::sort(Preds.begin(), Preds.end());
2103     PHINode *PN;
2104     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
2105       // Ensure that PHI nodes have at least one entry!
2106       Assert(PN->getNumIncomingValues() != 0,
2107              "PHI nodes must have at least one entry.  If the block is dead, "
2108              "the PHI should be removed!",
2109              PN);
2110       Assert(PN->getNumIncomingValues() == Preds.size(),
2111              "PHINode should have one entry for each predecessor of its "
2112              "parent basic block!",
2113              PN);
2114 
2115       // Get and sort all incoming values in the PHI node...
2116       Values.clear();
2117       Values.reserve(PN->getNumIncomingValues());
2118       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2119         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2120                                         PN->getIncomingValue(i)));
2121       std::sort(Values.begin(), Values.end());
2122 
2123       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2124         // Check to make sure that if there is more than one entry for a
2125         // particular basic block in this PHI node, that the incoming values are
2126         // all identical.
2127         //
2128         Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2129                    Values[i].second == Values[i - 1].second,
2130                "PHI node has multiple entries for the same basic block with "
2131                "different incoming values!",
2132                PN, Values[i].first, Values[i].second, Values[i - 1].second);
2133 
2134         // Check to make sure that the predecessors and PHI node entries are
2135         // matched up.
2136         Assert(Values[i].first == Preds[i],
2137                "PHI node entries do not match predecessors!", PN,
2138                Values[i].first, Preds[i]);
2139       }
2140     }
2141   }
2142 
2143   // Check that all instructions have their parent pointers set up correctly.
2144   for (auto &I : BB)
2145   {
2146     Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
2147   }
2148 }
2149 
2150 void Verifier::visitTerminatorInst(TerminatorInst &I) {
2151   // Ensure that terminators only exist at the end of the basic block.
2152   Assert(&I == I.getParent()->getTerminator(),
2153          "Terminator found in the middle of a basic block!", I.getParent());
2154   visitInstruction(I);
2155 }
2156 
2157 void Verifier::visitBranchInst(BranchInst &BI) {
2158   if (BI.isConditional()) {
2159     Assert(BI.getCondition()->getType()->isIntegerTy(1),
2160            "Branch condition is not 'i1' type!", &BI, BI.getCondition());
2161   }
2162   visitTerminatorInst(BI);
2163 }
2164 
2165 void Verifier::visitReturnInst(ReturnInst &RI) {
2166   Function *F = RI.getParent()->getParent();
2167   unsigned N = RI.getNumOperands();
2168   if (F->getReturnType()->isVoidTy())
2169     Assert(N == 0,
2170            "Found return instr that returns non-void in Function of void "
2171            "return type!",
2172            &RI, F->getReturnType());
2173   else
2174     Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2175            "Function return type does not match operand "
2176            "type of return inst!",
2177            &RI, F->getReturnType());
2178 
2179   // Check to make sure that the return value has necessary properties for
2180   // terminators...
2181   visitTerminatorInst(RI);
2182 }
2183 
2184 void Verifier::visitSwitchInst(SwitchInst &SI) {
2185   // Check to make sure that all of the constants in the switch instruction
2186   // have the same type as the switched-on value.
2187   Type *SwitchTy = SI.getCondition()->getType();
2188   SmallPtrSet<ConstantInt*, 32> Constants;
2189   for (auto &Case : SI.cases()) {
2190     Assert(Case.getCaseValue()->getType() == SwitchTy,
2191            "Switch constants must all be same type as switch value!", &SI);
2192     Assert(Constants.insert(Case.getCaseValue()).second,
2193            "Duplicate integer as switch case", &SI, Case.getCaseValue());
2194   }
2195 
2196   visitTerminatorInst(SI);
2197 }
2198 
2199 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
2200   Assert(BI.getAddress()->getType()->isPointerTy(),
2201          "Indirectbr operand must have pointer type!", &BI);
2202   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
2203     Assert(BI.getDestination(i)->getType()->isLabelTy(),
2204            "Indirectbr destinations must all have pointer type!", &BI);
2205 
2206   visitTerminatorInst(BI);
2207 }
2208 
2209 void Verifier::visitSelectInst(SelectInst &SI) {
2210   Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2211                                          SI.getOperand(2)),
2212          "Invalid operands for select instruction!", &SI);
2213 
2214   Assert(SI.getTrueValue()->getType() == SI.getType(),
2215          "Select values must have same type as select instruction!", &SI);
2216   visitInstruction(SI);
2217 }
2218 
2219 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2220 /// a pass, if any exist, it's an error.
2221 ///
2222 void Verifier::visitUserOp1(Instruction &I) {
2223   Assert(0, "User-defined operators should not live outside of a pass!", &I);
2224 }
2225 
2226 void Verifier::visitTruncInst(TruncInst &I) {
2227   // Get the source and destination types
2228   Type *SrcTy = I.getOperand(0)->getType();
2229   Type *DestTy = I.getType();
2230 
2231   // Get the size of the types in bits, we'll need this later
2232   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2233   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2234 
2235   Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2236   Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2237   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2238          "trunc source and destination must both be a vector or neither", &I);
2239   Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
2240 
2241   visitInstruction(I);
2242 }
2243 
2244 void Verifier::visitZExtInst(ZExtInst &I) {
2245   // Get the source and destination types
2246   Type *SrcTy = I.getOperand(0)->getType();
2247   Type *DestTy = I.getType();
2248 
2249   // Get the size of the types in bits, we'll need this later
2250   Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2251   Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2252   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2253          "zext source and destination must both be a vector or neither", &I);
2254   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2255   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2256 
2257   Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
2258 
2259   visitInstruction(I);
2260 }
2261 
2262 void Verifier::visitSExtInst(SExtInst &I) {
2263   // Get the source and destination types
2264   Type *SrcTy = I.getOperand(0)->getType();
2265   Type *DestTy = I.getType();
2266 
2267   // Get the size of the types in bits, we'll need this later
2268   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2269   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2270 
2271   Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2272   Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2273   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2274          "sext source and destination must both be a vector or neither", &I);
2275   Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
2276 
2277   visitInstruction(I);
2278 }
2279 
2280 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2281   // Get the source and destination types
2282   Type *SrcTy = I.getOperand(0)->getType();
2283   Type *DestTy = I.getType();
2284   // Get the size of the types in bits, we'll need this later
2285   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2286   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2287 
2288   Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2289   Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2290   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2291          "fptrunc source and destination must both be a vector or neither", &I);
2292   Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2293 
2294   visitInstruction(I);
2295 }
2296 
2297 void Verifier::visitFPExtInst(FPExtInst &I) {
2298   // Get the source and destination types
2299   Type *SrcTy = I.getOperand(0)->getType();
2300   Type *DestTy = I.getType();
2301 
2302   // Get the size of the types in bits, we'll need this later
2303   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2304   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2305 
2306   Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2307   Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2308   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2309          "fpext source and destination must both be a vector or neither", &I);
2310   Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2311 
2312   visitInstruction(I);
2313 }
2314 
2315 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2316   // Get the source and destination types
2317   Type *SrcTy = I.getOperand(0)->getType();
2318   Type *DestTy = I.getType();
2319 
2320   bool SrcVec = SrcTy->isVectorTy();
2321   bool DstVec = DestTy->isVectorTy();
2322 
2323   Assert(SrcVec == DstVec,
2324          "UIToFP source and dest must both be vector or scalar", &I);
2325   Assert(SrcTy->isIntOrIntVectorTy(),
2326          "UIToFP source must be integer or integer vector", &I);
2327   Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2328          &I);
2329 
2330   if (SrcVec && DstVec)
2331     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2332                cast<VectorType>(DestTy)->getNumElements(),
2333            "UIToFP source and dest vector length mismatch", &I);
2334 
2335   visitInstruction(I);
2336 }
2337 
2338 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2339   // Get the source and destination types
2340   Type *SrcTy = I.getOperand(0)->getType();
2341   Type *DestTy = I.getType();
2342 
2343   bool SrcVec = SrcTy->isVectorTy();
2344   bool DstVec = DestTy->isVectorTy();
2345 
2346   Assert(SrcVec == DstVec,
2347          "SIToFP source and dest must both be vector or scalar", &I);
2348   Assert(SrcTy->isIntOrIntVectorTy(),
2349          "SIToFP source must be integer or integer vector", &I);
2350   Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2351          &I);
2352 
2353   if (SrcVec && DstVec)
2354     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2355                cast<VectorType>(DestTy)->getNumElements(),
2356            "SIToFP source and dest vector length mismatch", &I);
2357 
2358   visitInstruction(I);
2359 }
2360 
2361 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2362   // Get the source and destination types
2363   Type *SrcTy = I.getOperand(0)->getType();
2364   Type *DestTy = I.getType();
2365 
2366   bool SrcVec = SrcTy->isVectorTy();
2367   bool DstVec = DestTy->isVectorTy();
2368 
2369   Assert(SrcVec == DstVec,
2370          "FPToUI source and dest must both be vector or scalar", &I);
2371   Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2372          &I);
2373   Assert(DestTy->isIntOrIntVectorTy(),
2374          "FPToUI result must be integer or integer vector", &I);
2375 
2376   if (SrcVec && DstVec)
2377     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2378                cast<VectorType>(DestTy)->getNumElements(),
2379            "FPToUI source and dest vector length mismatch", &I);
2380 
2381   visitInstruction(I);
2382 }
2383 
2384 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2385   // Get the source and destination types
2386   Type *SrcTy = I.getOperand(0)->getType();
2387   Type *DestTy = I.getType();
2388 
2389   bool SrcVec = SrcTy->isVectorTy();
2390   bool DstVec = DestTy->isVectorTy();
2391 
2392   Assert(SrcVec == DstVec,
2393          "FPToSI source and dest must both be vector or scalar", &I);
2394   Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2395          &I);
2396   Assert(DestTy->isIntOrIntVectorTy(),
2397          "FPToSI result must be integer or integer vector", &I);
2398 
2399   if (SrcVec && DstVec)
2400     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2401                cast<VectorType>(DestTy)->getNumElements(),
2402            "FPToSI source and dest vector length mismatch", &I);
2403 
2404   visitInstruction(I);
2405 }
2406 
2407 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2408   // Get the source and destination types
2409   Type *SrcTy = I.getOperand(0)->getType();
2410   Type *DestTy = I.getType();
2411 
2412   Assert(SrcTy->getScalarType()->isPointerTy(),
2413          "PtrToInt source must be pointer", &I);
2414 
2415   if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
2416     Assert(!DL.isNonIntegralPointerType(PTy),
2417            "ptrtoint not supported for non-integral pointers");
2418 
2419   Assert(DestTy->getScalarType()->isIntegerTy(),
2420          "PtrToInt result must be integral", &I);
2421   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2422          &I);
2423 
2424   if (SrcTy->isVectorTy()) {
2425     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2426     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2427     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2428            "PtrToInt Vector width mismatch", &I);
2429   }
2430 
2431   visitInstruction(I);
2432 }
2433 
2434 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2435   // Get the source and destination types
2436   Type *SrcTy = I.getOperand(0)->getType();
2437   Type *DestTy = I.getType();
2438 
2439   Assert(SrcTy->getScalarType()->isIntegerTy(),
2440          "IntToPtr source must be an integral", &I);
2441   Assert(DestTy->getScalarType()->isPointerTy(),
2442          "IntToPtr result must be a pointer", &I);
2443 
2444   if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
2445     Assert(!DL.isNonIntegralPointerType(PTy),
2446            "inttoptr not supported for non-integral pointers");
2447 
2448   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2449          &I);
2450   if (SrcTy->isVectorTy()) {
2451     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2452     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2453     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2454            "IntToPtr Vector width mismatch", &I);
2455   }
2456   visitInstruction(I);
2457 }
2458 
2459 void Verifier::visitBitCastInst(BitCastInst &I) {
2460   Assert(
2461       CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2462       "Invalid bitcast", &I);
2463   visitInstruction(I);
2464 }
2465 
2466 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2467   Type *SrcTy = I.getOperand(0)->getType();
2468   Type *DestTy = I.getType();
2469 
2470   Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2471          &I);
2472   Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2473          &I);
2474   Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2475          "AddrSpaceCast must be between different address spaces", &I);
2476   if (SrcTy->isVectorTy())
2477     Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2478            "AddrSpaceCast vector pointer number of elements mismatch", &I);
2479   visitInstruction(I);
2480 }
2481 
2482 /// visitPHINode - Ensure that a PHI node is well formed.
2483 ///
2484 void Verifier::visitPHINode(PHINode &PN) {
2485   // Ensure that the PHI nodes are all grouped together at the top of the block.
2486   // This can be tested by checking whether the instruction before this is
2487   // either nonexistent (because this is begin()) or is a PHI node.  If not,
2488   // then there is some other instruction before a PHI.
2489   Assert(&PN == &PN.getParent()->front() ||
2490              isa<PHINode>(--BasicBlock::iterator(&PN)),
2491          "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2492 
2493   // Check that a PHI doesn't yield a Token.
2494   Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2495 
2496   // Check that all of the values of the PHI node have the same type as the
2497   // result, and that the incoming blocks are really basic blocks.
2498   for (Value *IncValue : PN.incoming_values()) {
2499     Assert(PN.getType() == IncValue->getType(),
2500            "PHI node operands are not the same type as the result!", &PN);
2501   }
2502 
2503   // All other PHI node constraints are checked in the visitBasicBlock method.
2504 
2505   visitInstruction(PN);
2506 }
2507 
2508 void Verifier::verifyCallSite(CallSite CS) {
2509   Instruction *I = CS.getInstruction();
2510 
2511   Assert(CS.getCalledValue()->getType()->isPointerTy(),
2512          "Called function must be a pointer!", I);
2513   PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2514 
2515   Assert(FPTy->getElementType()->isFunctionTy(),
2516          "Called function is not pointer to function type!", I);
2517 
2518   Assert(FPTy->getElementType() == CS.getFunctionType(),
2519          "Called function is not the same type as the call!", I);
2520 
2521   FunctionType *FTy = CS.getFunctionType();
2522 
2523   // Verify that the correct number of arguments are being passed
2524   if (FTy->isVarArg())
2525     Assert(CS.arg_size() >= FTy->getNumParams(),
2526            "Called function requires more parameters than were provided!", I);
2527   else
2528     Assert(CS.arg_size() == FTy->getNumParams(),
2529            "Incorrect number of arguments passed to called function!", I);
2530 
2531   // Verify that all arguments to the call match the function type.
2532   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2533     Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2534            "Call parameter type does not match function signature!",
2535            CS.getArgument(i), FTy->getParamType(i), I);
2536 
2537   AttributeSet Attrs = CS.getAttributes();
2538 
2539   Assert(verifyAttributeCount(Attrs, CS.arg_size()),
2540          "Attribute after last parameter!", I);
2541 
2542   // Verify call attributes.
2543   verifyFunctionAttrs(FTy, Attrs, I);
2544 
2545   // Conservatively check the inalloca argument.
2546   // We have a bug if we can find that there is an underlying alloca without
2547   // inalloca.
2548   if (CS.hasInAllocaArgument()) {
2549     Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2550     if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2551       Assert(AI->isUsedWithInAlloca(),
2552              "inalloca argument for call has mismatched alloca", AI, I);
2553   }
2554 
2555   // For each argument of the callsite, if it has the swifterror argument,
2556   // make sure the underlying alloca has swifterror as well.
2557   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2558     if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2559       Value *SwiftErrorArg = CS.getArgument(i);
2560       auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2561       Assert(AI, "swifterror argument should come from alloca", AI, I);
2562       if (AI)
2563         Assert(AI->isSwiftError(),
2564                "swifterror argument for call has mismatched alloca", AI, I);
2565     }
2566 
2567   if (FTy->isVarArg()) {
2568     // FIXME? is 'nest' even legal here?
2569     bool SawNest = false;
2570     bool SawReturned = false;
2571 
2572     for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2573       if (Attrs.hasAttribute(Idx, Attribute::Nest))
2574         SawNest = true;
2575       if (Attrs.hasAttribute(Idx, Attribute::Returned))
2576         SawReturned = true;
2577     }
2578 
2579     // Check attributes on the varargs part.
2580     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2581       Type *Ty = CS.getArgument(Idx-1)->getType();
2582       verifyParameterAttrs(Attrs, Idx, Ty, false, I);
2583 
2584       if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2585         Assert(!SawNest, "More than one parameter has attribute nest!", I);
2586         SawNest = true;
2587       }
2588 
2589       if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2590         Assert(!SawReturned, "More than one parameter has attribute returned!",
2591                I);
2592         Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2593                "Incompatible argument and return types for 'returned' "
2594                "attribute",
2595                I);
2596         SawReturned = true;
2597       }
2598 
2599       Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2600              "Attribute 'sret' cannot be used for vararg call arguments!", I);
2601 
2602       if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2603         Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2604     }
2605   }
2606 
2607   // Verify that there's no metadata unless it's a direct call to an intrinsic.
2608   if (CS.getCalledFunction() == nullptr ||
2609       !CS.getCalledFunction()->getName().startswith("llvm.")) {
2610     for (Type *ParamTy : FTy->params()) {
2611       Assert(!ParamTy->isMetadataTy(),
2612              "Function has metadata parameter but isn't an intrinsic", I);
2613       Assert(!ParamTy->isTokenTy(),
2614              "Function has token parameter but isn't an intrinsic", I);
2615     }
2616   }
2617 
2618   // Verify that indirect calls don't return tokens.
2619   if (CS.getCalledFunction() == nullptr)
2620     Assert(!FTy->getReturnType()->isTokenTy(),
2621            "Return type cannot be token for indirect call!");
2622 
2623   if (Function *F = CS.getCalledFunction())
2624     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2625       visitIntrinsicCallSite(ID, CS);
2626 
2627   // Verify that a callsite has at most one "deopt", at most one "funclet" and
2628   // at most one "gc-transition" operand bundle.
2629   bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2630        FoundGCTransitionBundle = false;
2631   for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
2632     OperandBundleUse BU = CS.getOperandBundleAt(i);
2633     uint32_t Tag = BU.getTagID();
2634     if (Tag == LLVMContext::OB_deopt) {
2635       Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2636       FoundDeoptBundle = true;
2637     } else if (Tag == LLVMContext::OB_gc_transition) {
2638       Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2639              I);
2640       FoundGCTransitionBundle = true;
2641     } else if (Tag == LLVMContext::OB_funclet) {
2642       Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2643       FoundFuncletBundle = true;
2644       Assert(BU.Inputs.size() == 1,
2645              "Expected exactly one funclet bundle operand", I);
2646       Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2647              "Funclet bundle operands should correspond to a FuncletPadInst",
2648              I);
2649     }
2650   }
2651 
2652   // Verify that each inlinable callsite of a debug-info-bearing function in a
2653   // debug-info-bearing function has a debug location attached to it. Failure to
2654   // do so causes assertion failures when the inliner sets up inline scope info.
2655   if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2656       CS.getCalledFunction()->getSubprogram())
2657     Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2658                              "info must have a !dbg location",
2659            I);
2660 
2661   visitInstruction(*I);
2662 }
2663 
2664 /// Two types are "congruent" if they are identical, or if they are both pointer
2665 /// types with different pointee types and the same address space.
2666 static bool isTypeCongruent(Type *L, Type *R) {
2667   if (L == R)
2668     return true;
2669   PointerType *PL = dyn_cast<PointerType>(L);
2670   PointerType *PR = dyn_cast<PointerType>(R);
2671   if (!PL || !PR)
2672     return false;
2673   return PL->getAddressSpace() == PR->getAddressSpace();
2674 }
2675 
2676 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2677   static const Attribute::AttrKind ABIAttrs[] = {
2678       Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2679       Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2680       Attribute::SwiftError};
2681   AttrBuilder Copy;
2682   for (auto AK : ABIAttrs) {
2683     if (Attrs.hasAttribute(I + 1, AK))
2684       Copy.addAttribute(AK);
2685   }
2686   if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2687     Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2688   return Copy;
2689 }
2690 
2691 void Verifier::verifyMustTailCall(CallInst &CI) {
2692   Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2693 
2694   // - The caller and callee prototypes must match.  Pointer types of
2695   //   parameters or return types may differ in pointee type, but not
2696   //   address space.
2697   Function *F = CI.getParent()->getParent();
2698   FunctionType *CallerTy = F->getFunctionType();
2699   FunctionType *CalleeTy = CI.getFunctionType();
2700   Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2701          "cannot guarantee tail call due to mismatched parameter counts", &CI);
2702   Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2703          "cannot guarantee tail call due to mismatched varargs", &CI);
2704   Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2705          "cannot guarantee tail call due to mismatched return types", &CI);
2706   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2707     Assert(
2708         isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2709         "cannot guarantee tail call due to mismatched parameter types", &CI);
2710   }
2711 
2712   // - The calling conventions of the caller and callee must match.
2713   Assert(F->getCallingConv() == CI.getCallingConv(),
2714          "cannot guarantee tail call due to mismatched calling conv", &CI);
2715 
2716   // - All ABI-impacting function attributes, such as sret, byval, inreg,
2717   //   returned, and inalloca, must match.
2718   AttributeSet CallerAttrs = F->getAttributes();
2719   AttributeSet CalleeAttrs = CI.getAttributes();
2720   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2721     AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2722     AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2723     Assert(CallerABIAttrs == CalleeABIAttrs,
2724            "cannot guarantee tail call due to mismatched ABI impacting "
2725            "function attributes",
2726            &CI, CI.getOperand(I));
2727   }
2728 
2729   // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2730   //   or a pointer bitcast followed by a ret instruction.
2731   // - The ret instruction must return the (possibly bitcasted) value
2732   //   produced by the call or void.
2733   Value *RetVal = &CI;
2734   Instruction *Next = CI.getNextNode();
2735 
2736   // Handle the optional bitcast.
2737   if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2738     Assert(BI->getOperand(0) == RetVal,
2739            "bitcast following musttail call must use the call", BI);
2740     RetVal = BI;
2741     Next = BI->getNextNode();
2742   }
2743 
2744   // Check the return.
2745   ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2746   Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2747          &CI);
2748   Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2749          "musttail call result must be returned", Ret);
2750 }
2751 
2752 void Verifier::visitCallInst(CallInst &CI) {
2753   verifyCallSite(&CI);
2754 
2755   if (CI.isMustTailCall())
2756     verifyMustTailCall(CI);
2757 }
2758 
2759 void Verifier::visitInvokeInst(InvokeInst &II) {
2760   verifyCallSite(&II);
2761 
2762   // Verify that the first non-PHI instruction of the unwind destination is an
2763   // exception handling instruction.
2764   Assert(
2765       II.getUnwindDest()->isEHPad(),
2766       "The unwind destination does not have an exception handling instruction!",
2767       &II);
2768 
2769   visitTerminatorInst(II);
2770 }
2771 
2772 /// visitBinaryOperator - Check that both arguments to the binary operator are
2773 /// of the same type!
2774 ///
2775 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2776   Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2777          "Both operands to a binary operator are not of the same type!", &B);
2778 
2779   switch (B.getOpcode()) {
2780   // Check that integer arithmetic operators are only used with
2781   // integral operands.
2782   case Instruction::Add:
2783   case Instruction::Sub:
2784   case Instruction::Mul:
2785   case Instruction::SDiv:
2786   case Instruction::UDiv:
2787   case Instruction::SRem:
2788   case Instruction::URem:
2789     Assert(B.getType()->isIntOrIntVectorTy(),
2790            "Integer arithmetic operators only work with integral types!", &B);
2791     Assert(B.getType() == B.getOperand(0)->getType(),
2792            "Integer arithmetic operators must have same type "
2793            "for operands and result!",
2794            &B);
2795     break;
2796   // Check that floating-point arithmetic operators are only used with
2797   // floating-point operands.
2798   case Instruction::FAdd:
2799   case Instruction::FSub:
2800   case Instruction::FMul:
2801   case Instruction::FDiv:
2802   case Instruction::FRem:
2803     Assert(B.getType()->isFPOrFPVectorTy(),
2804            "Floating-point arithmetic operators only work with "
2805            "floating-point types!",
2806            &B);
2807     Assert(B.getType() == B.getOperand(0)->getType(),
2808            "Floating-point arithmetic operators must have same type "
2809            "for operands and result!",
2810            &B);
2811     break;
2812   // Check that logical operators are only used with integral operands.
2813   case Instruction::And:
2814   case Instruction::Or:
2815   case Instruction::Xor:
2816     Assert(B.getType()->isIntOrIntVectorTy(),
2817            "Logical operators only work with integral types!", &B);
2818     Assert(B.getType() == B.getOperand(0)->getType(),
2819            "Logical operators must have same type for operands and result!",
2820            &B);
2821     break;
2822   case Instruction::Shl:
2823   case Instruction::LShr:
2824   case Instruction::AShr:
2825     Assert(B.getType()->isIntOrIntVectorTy(),
2826            "Shifts only work with integral types!", &B);
2827     Assert(B.getType() == B.getOperand(0)->getType(),
2828            "Shift return type must be same as operands!", &B);
2829     break;
2830   default:
2831     llvm_unreachable("Unknown BinaryOperator opcode!");
2832   }
2833 
2834   visitInstruction(B);
2835 }
2836 
2837 void Verifier::visitICmpInst(ICmpInst &IC) {
2838   // Check that the operands are the same type
2839   Type *Op0Ty = IC.getOperand(0)->getType();
2840   Type *Op1Ty = IC.getOperand(1)->getType();
2841   Assert(Op0Ty == Op1Ty,
2842          "Both operands to ICmp instruction are not of the same type!", &IC);
2843   // Check that the operands are the right type
2844   Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2845          "Invalid operand types for ICmp instruction", &IC);
2846   // Check that the predicate is valid.
2847   Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2848              IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2849          "Invalid predicate in ICmp instruction!", &IC);
2850 
2851   visitInstruction(IC);
2852 }
2853 
2854 void Verifier::visitFCmpInst(FCmpInst &FC) {
2855   // Check that the operands are the same type
2856   Type *Op0Ty = FC.getOperand(0)->getType();
2857   Type *Op1Ty = FC.getOperand(1)->getType();
2858   Assert(Op0Ty == Op1Ty,
2859          "Both operands to FCmp instruction are not of the same type!", &FC);
2860   // Check that the operands are the right type
2861   Assert(Op0Ty->isFPOrFPVectorTy(),
2862          "Invalid operand types for FCmp instruction", &FC);
2863   // Check that the predicate is valid.
2864   Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2865              FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2866          "Invalid predicate in FCmp instruction!", &FC);
2867 
2868   visitInstruction(FC);
2869 }
2870 
2871 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2872   Assert(
2873       ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2874       "Invalid extractelement operands!", &EI);
2875   visitInstruction(EI);
2876 }
2877 
2878 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2879   Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2880                                             IE.getOperand(2)),
2881          "Invalid insertelement operands!", &IE);
2882   visitInstruction(IE);
2883 }
2884 
2885 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2886   Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2887                                             SV.getOperand(2)),
2888          "Invalid shufflevector operands!", &SV);
2889   visitInstruction(SV);
2890 }
2891 
2892 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2893   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2894 
2895   Assert(isa<PointerType>(TargetTy),
2896          "GEP base pointer is not a vector or a vector of pointers", &GEP);
2897   Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2898   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2899   Type *ElTy =
2900       GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2901   Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2902 
2903   Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2904              GEP.getResultElementType() == ElTy,
2905          "GEP is not of right type for indices!", &GEP, ElTy);
2906 
2907   if (GEP.getType()->isVectorTy()) {
2908     // Additional checks for vector GEPs.
2909     unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2910     if (GEP.getPointerOperandType()->isVectorTy())
2911       Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2912              "Vector GEP result width doesn't match operand's", &GEP);
2913     for (Value *Idx : Idxs) {
2914       Type *IndexTy = Idx->getType();
2915       if (IndexTy->isVectorTy()) {
2916         unsigned IndexWidth = IndexTy->getVectorNumElements();
2917         Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2918       }
2919       Assert(IndexTy->getScalarType()->isIntegerTy(),
2920              "All GEP indices should be of integer type");
2921     }
2922   }
2923   visitInstruction(GEP);
2924 }
2925 
2926 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2927   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2928 }
2929 
2930 void Verifier::visitRangeMetadata(Instruction& I,
2931                                   MDNode* Range, Type* Ty) {
2932   assert(Range &&
2933          Range == I.getMetadata(LLVMContext::MD_range) &&
2934          "precondition violation");
2935 
2936   unsigned NumOperands = Range->getNumOperands();
2937   Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2938   unsigned NumRanges = NumOperands / 2;
2939   Assert(NumRanges >= 1, "It should have at least one range!", Range);
2940 
2941   ConstantRange LastRange(1); // Dummy initial value
2942   for (unsigned i = 0; i < NumRanges; ++i) {
2943     ConstantInt *Low =
2944         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2945     Assert(Low, "The lower limit must be an integer!", Low);
2946     ConstantInt *High =
2947         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2948     Assert(High, "The upper limit must be an integer!", High);
2949     Assert(High->getType() == Low->getType() && High->getType() == Ty,
2950            "Range types must match instruction type!", &I);
2951 
2952     APInt HighV = High->getValue();
2953     APInt LowV = Low->getValue();
2954     ConstantRange CurRange(LowV, HighV);
2955     Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2956            "Range must not be empty!", Range);
2957     if (i != 0) {
2958       Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2959              "Intervals are overlapping", Range);
2960       Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2961              Range);
2962       Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2963              Range);
2964     }
2965     LastRange = ConstantRange(LowV, HighV);
2966   }
2967   if (NumRanges > 2) {
2968     APInt FirstLow =
2969         mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2970     APInt FirstHigh =
2971         mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2972     ConstantRange FirstRange(FirstLow, FirstHigh);
2973     Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2974            "Intervals are overlapping", Range);
2975     Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2976            Range);
2977   }
2978 }
2979 
2980 void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
2981   unsigned Size = DL.getTypeSizeInBits(Ty);
2982   Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2983   Assert(!(Size & (Size - 1)),
2984          "atomic memory access' operand must have a power-of-two size", Ty, I);
2985 }
2986 
2987 void Verifier::visitLoadInst(LoadInst &LI) {
2988   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2989   Assert(PTy, "Load operand must be a pointer.", &LI);
2990   Type *ElTy = LI.getType();
2991   Assert(LI.getAlignment() <= Value::MaximumAlignment,
2992          "huge alignment values are unsupported", &LI);
2993   Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
2994   if (LI.isAtomic()) {
2995     Assert(LI.getOrdering() != AtomicOrdering::Release &&
2996                LI.getOrdering() != AtomicOrdering::AcquireRelease,
2997            "Load cannot have Release ordering", &LI);
2998     Assert(LI.getAlignment() != 0,
2999            "Atomic load must specify explicit alignment", &LI);
3000     Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3001                ElTy->isFloatingPointTy(),
3002            "atomic load operand must have integer, pointer, or floating point "
3003            "type!",
3004            ElTy, &LI);
3005     checkAtomicMemAccessSize(ElTy, &LI);
3006   } else {
3007     Assert(LI.getSynchScope() == CrossThread,
3008            "Non-atomic load cannot have SynchronizationScope specified", &LI);
3009   }
3010 
3011   visitInstruction(LI);
3012 }
3013 
3014 void Verifier::visitStoreInst(StoreInst &SI) {
3015   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
3016   Assert(PTy, "Store operand must be a pointer.", &SI);
3017   Type *ElTy = PTy->getElementType();
3018   Assert(ElTy == SI.getOperand(0)->getType(),
3019          "Stored value type does not match pointer operand type!", &SI, ElTy);
3020   Assert(SI.getAlignment() <= Value::MaximumAlignment,
3021          "huge alignment values are unsupported", &SI);
3022   Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
3023   if (SI.isAtomic()) {
3024     Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3025                SI.getOrdering() != AtomicOrdering::AcquireRelease,
3026            "Store cannot have Acquire ordering", &SI);
3027     Assert(SI.getAlignment() != 0,
3028            "Atomic store must specify explicit alignment", &SI);
3029     Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3030                ElTy->isFloatingPointTy(),
3031            "atomic store operand must have integer, pointer, or floating point "
3032            "type!",
3033            ElTy, &SI);
3034     checkAtomicMemAccessSize(ElTy, &SI);
3035   } else {
3036     Assert(SI.getSynchScope() == CrossThread,
3037            "Non-atomic store cannot have SynchronizationScope specified", &SI);
3038   }
3039   visitInstruction(SI);
3040 }
3041 
3042 /// Check that SwiftErrorVal is used as a swifterror argument in CS.
3043 void Verifier::verifySwiftErrorCallSite(CallSite CS,
3044                                         const Value *SwiftErrorVal) {
3045   unsigned Idx = 0;
3046   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3047        I != E; ++I, ++Idx) {
3048     if (*I == SwiftErrorVal) {
3049       Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3050              "swifterror value when used in a callsite should be marked "
3051              "with swifterror attribute",
3052               SwiftErrorVal, CS);
3053     }
3054   }
3055 }
3056 
3057 void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3058   // Check that swifterror value is only used by loads, stores, or as
3059   // a swifterror argument.
3060   for (const User *U : SwiftErrorVal->users()) {
3061     Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3062            isa<InvokeInst>(U),
3063            "swifterror value can only be loaded and stored from, or "
3064            "as a swifterror argument!",
3065            SwiftErrorVal, U);
3066     // If it is used by a store, check it is the second operand.
3067     if (auto StoreI = dyn_cast<StoreInst>(U))
3068       Assert(StoreI->getOperand(1) == SwiftErrorVal,
3069              "swifterror value should be the second operand when used "
3070              "by stores", SwiftErrorVal, U);
3071     if (auto CallI = dyn_cast<CallInst>(U))
3072       verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3073     if (auto II = dyn_cast<InvokeInst>(U))
3074       verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3075   }
3076 }
3077 
3078 void Verifier::visitAllocaInst(AllocaInst &AI) {
3079   SmallPtrSet<Type*, 4> Visited;
3080   PointerType *PTy = AI.getType();
3081   Assert(PTy->getAddressSpace() == 0,
3082          "Allocation instruction pointer not in the generic address space!",
3083          &AI);
3084   Assert(AI.getAllocatedType()->isSized(&Visited),
3085          "Cannot allocate unsized type", &AI);
3086   Assert(AI.getArraySize()->getType()->isIntegerTy(),
3087          "Alloca array size must have integer type", &AI);
3088   Assert(AI.getAlignment() <= Value::MaximumAlignment,
3089          "huge alignment values are unsupported", &AI);
3090 
3091   if (AI.isSwiftError()) {
3092     verifySwiftErrorValue(&AI);
3093   }
3094 
3095   visitInstruction(AI);
3096 }
3097 
3098 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
3099 
3100   // FIXME: more conditions???
3101   Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
3102          "cmpxchg instructions must be atomic.", &CXI);
3103   Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
3104          "cmpxchg instructions must be atomic.", &CXI);
3105   Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
3106          "cmpxchg instructions cannot be unordered.", &CXI);
3107   Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
3108          "cmpxchg instructions cannot be unordered.", &CXI);
3109   Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3110          "cmpxchg instructions failure argument shall be no stronger than the "
3111          "success argument",
3112          &CXI);
3113   Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3114              CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
3115          "cmpxchg failure ordering cannot include release semantics", &CXI);
3116 
3117   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
3118   Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
3119   Type *ElTy = PTy->getElementType();
3120   Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3121         "cmpxchg operand must have integer or pointer type",
3122          ElTy, &CXI);
3123   checkAtomicMemAccessSize(ElTy, &CXI);
3124   Assert(ElTy == CXI.getOperand(1)->getType(),
3125          "Expected value type does not match pointer operand type!", &CXI,
3126          ElTy);
3127   Assert(ElTy == CXI.getOperand(2)->getType(),
3128          "Stored value type does not match pointer operand type!", &CXI, ElTy);
3129   visitInstruction(CXI);
3130 }
3131 
3132 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
3133   Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
3134          "atomicrmw instructions must be atomic.", &RMWI);
3135   Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
3136          "atomicrmw instructions cannot be unordered.", &RMWI);
3137   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
3138   Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
3139   Type *ElTy = PTy->getElementType();
3140   Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3141          &RMWI, ElTy);
3142   checkAtomicMemAccessSize(ElTy, &RMWI);
3143   Assert(ElTy == RMWI.getOperand(1)->getType(),
3144          "Argument value type does not match pointer operand type!", &RMWI,
3145          ElTy);
3146   Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3147              RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3148          "Invalid binary operation!", &RMWI);
3149   visitInstruction(RMWI);
3150 }
3151 
3152 void Verifier::visitFenceInst(FenceInst &FI) {
3153   const AtomicOrdering Ordering = FI.getOrdering();
3154   Assert(Ordering == AtomicOrdering::Acquire ||
3155              Ordering == AtomicOrdering::Release ||
3156              Ordering == AtomicOrdering::AcquireRelease ||
3157              Ordering == AtomicOrdering::SequentiallyConsistent,
3158          "fence instructions may only have acquire, release, acq_rel, or "
3159          "seq_cst ordering.",
3160          &FI);
3161   visitInstruction(FI);
3162 }
3163 
3164 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
3165   Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3166                                           EVI.getIndices()) == EVI.getType(),
3167          "Invalid ExtractValueInst operands!", &EVI);
3168 
3169   visitInstruction(EVI);
3170 }
3171 
3172 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
3173   Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3174                                           IVI.getIndices()) ==
3175              IVI.getOperand(1)->getType(),
3176          "Invalid InsertValueInst operands!", &IVI);
3177 
3178   visitInstruction(IVI);
3179 }
3180 
3181 static Value *getParentPad(Value *EHPad) {
3182   if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3183     return FPI->getParentPad();
3184 
3185   return cast<CatchSwitchInst>(EHPad)->getParentPad();
3186 }
3187 
3188 void Verifier::visitEHPadPredecessors(Instruction &I) {
3189   assert(I.isEHPad());
3190 
3191   BasicBlock *BB = I.getParent();
3192   Function *F = BB->getParent();
3193 
3194   Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3195 
3196   if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3197     // The landingpad instruction defines its parent as a landing pad block. The
3198     // landing pad block may be branched to only by the unwind edge of an
3199     // invoke.
3200     for (BasicBlock *PredBB : predecessors(BB)) {
3201       const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3202       Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3203              "Block containing LandingPadInst must be jumped to "
3204              "only by the unwind edge of an invoke.",
3205              LPI);
3206     }
3207     return;
3208   }
3209   if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3210     if (!pred_empty(BB))
3211       Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3212              "Block containg CatchPadInst must be jumped to "
3213              "only by its catchswitch.",
3214              CPI);
3215     Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3216            "Catchswitch cannot unwind to one of its catchpads",
3217            CPI->getCatchSwitch(), CPI);
3218     return;
3219   }
3220 
3221   // Verify that each pred has a legal terminator with a legal to/from EH
3222   // pad relationship.
3223   Instruction *ToPad = &I;
3224   Value *ToPadParent = getParentPad(ToPad);
3225   for (BasicBlock *PredBB : predecessors(BB)) {
3226     TerminatorInst *TI = PredBB->getTerminator();
3227     Value *FromPad;
3228     if (auto *II = dyn_cast<InvokeInst>(TI)) {
3229       Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
3230              "EH pad must be jumped to via an unwind edge", ToPad, II);
3231       if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3232         FromPad = Bundle->Inputs[0];
3233       else
3234         FromPad = ConstantTokenNone::get(II->getContext());
3235     } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3236       FromPad = CRI->getOperand(0);
3237       Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3238     } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3239       FromPad = CSI;
3240     } else {
3241       Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3242     }
3243 
3244     // The edge may exit from zero or more nested pads.
3245     SmallSet<Value *, 8> Seen;
3246     for (;; FromPad = getParentPad(FromPad)) {
3247       Assert(FromPad != ToPad,
3248              "EH pad cannot handle exceptions raised within it", FromPad, TI);
3249       if (FromPad == ToPadParent) {
3250         // This is a legal unwind edge.
3251         break;
3252       }
3253       Assert(!isa<ConstantTokenNone>(FromPad),
3254              "A single unwind edge may only enter one EH pad", TI);
3255       Assert(Seen.insert(FromPad).second,
3256              "EH pad jumps through a cycle of pads", FromPad);
3257     }
3258   }
3259 }
3260 
3261 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
3262   // The landingpad instruction is ill-formed if it doesn't have any clauses and
3263   // isn't a cleanup.
3264   Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3265          "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
3266 
3267   visitEHPadPredecessors(LPI);
3268 
3269   if (!LandingPadResultTy)
3270     LandingPadResultTy = LPI.getType();
3271   else
3272     Assert(LandingPadResultTy == LPI.getType(),
3273            "The landingpad instruction should have a consistent result type "
3274            "inside a function.",
3275            &LPI);
3276 
3277   Function *F = LPI.getParent()->getParent();
3278   Assert(F->hasPersonalityFn(),
3279          "LandingPadInst needs to be in a function with a personality.", &LPI);
3280 
3281   // The landingpad instruction must be the first non-PHI instruction in the
3282   // block.
3283   Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3284          "LandingPadInst not the first non-PHI instruction in the block.",
3285          &LPI);
3286 
3287   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
3288     Constant *Clause = LPI.getClause(i);
3289     if (LPI.isCatch(i)) {
3290       Assert(isa<PointerType>(Clause->getType()),
3291              "Catch operand does not have pointer type!", &LPI);
3292     } else {
3293       Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3294       Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3295              "Filter operand is not an array of constants!", &LPI);
3296     }
3297   }
3298 
3299   visitInstruction(LPI);
3300 }
3301 
3302 void Verifier::visitResumeInst(ResumeInst &RI) {
3303   Assert(RI.getFunction()->hasPersonalityFn(),
3304          "ResumeInst needs to be in a function with a personality.", &RI);
3305 
3306   if (!LandingPadResultTy)
3307     LandingPadResultTy = RI.getValue()->getType();
3308   else
3309     Assert(LandingPadResultTy == RI.getValue()->getType(),
3310            "The resume instruction should have a consistent result type "
3311            "inside a function.",
3312            &RI);
3313 
3314   visitTerminatorInst(RI);
3315 }
3316 
3317 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
3318   BasicBlock *BB = CPI.getParent();
3319 
3320   Function *F = BB->getParent();
3321   Assert(F->hasPersonalityFn(),
3322          "CatchPadInst needs to be in a function with a personality.", &CPI);
3323 
3324   Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3325          "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3326          CPI.getParentPad());
3327 
3328   // The catchpad instruction must be the first non-PHI instruction in the
3329   // block.
3330   Assert(BB->getFirstNonPHI() == &CPI,
3331          "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
3332 
3333   visitEHPadPredecessors(CPI);
3334   visitFuncletPadInst(CPI);
3335 }
3336 
3337 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3338   Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3339          "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3340          CatchReturn.getOperand(0));
3341 
3342   visitTerminatorInst(CatchReturn);
3343 }
3344 
3345 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3346   BasicBlock *BB = CPI.getParent();
3347 
3348   Function *F = BB->getParent();
3349   Assert(F->hasPersonalityFn(),
3350          "CleanupPadInst needs to be in a function with a personality.", &CPI);
3351 
3352   // The cleanuppad instruction must be the first non-PHI instruction in the
3353   // block.
3354   Assert(BB->getFirstNonPHI() == &CPI,
3355          "CleanupPadInst not the first non-PHI instruction in the block.",
3356          &CPI);
3357 
3358   auto *ParentPad = CPI.getParentPad();
3359   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3360          "CleanupPadInst has an invalid parent.", &CPI);
3361 
3362   visitEHPadPredecessors(CPI);
3363   visitFuncletPadInst(CPI);
3364 }
3365 
3366 void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3367   User *FirstUser = nullptr;
3368   Value *FirstUnwindPad = nullptr;
3369   SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
3370   SmallSet<FuncletPadInst *, 8> Seen;
3371 
3372   while (!Worklist.empty()) {
3373     FuncletPadInst *CurrentPad = Worklist.pop_back_val();
3374     Assert(Seen.insert(CurrentPad).second,
3375            "FuncletPadInst must not be nested within itself", CurrentPad);
3376     Value *UnresolvedAncestorPad = nullptr;
3377     for (User *U : CurrentPad->users()) {
3378       BasicBlock *UnwindDest;
3379       if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3380         UnwindDest = CRI->getUnwindDest();
3381       } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3382         // We allow catchswitch unwind to caller to nest
3383         // within an outer pad that unwinds somewhere else,
3384         // because catchswitch doesn't have a nounwind variant.
3385         // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3386         if (CSI->unwindsToCaller())
3387           continue;
3388         UnwindDest = CSI->getUnwindDest();
3389       } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3390         UnwindDest = II->getUnwindDest();
3391       } else if (isa<CallInst>(U)) {
3392         // Calls which don't unwind may be found inside funclet
3393         // pads that unwind somewhere else.  We don't *require*
3394         // such calls to be annotated nounwind.
3395         continue;
3396       } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3397         // The unwind dest for a cleanup can only be found by
3398         // recursive search.  Add it to the worklist, and we'll
3399         // search for its first use that determines where it unwinds.
3400         Worklist.push_back(CPI);
3401         continue;
3402       } else {
3403         Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3404         continue;
3405       }
3406 
3407       Value *UnwindPad;
3408       bool ExitsFPI;
3409       if (UnwindDest) {
3410         UnwindPad = UnwindDest->getFirstNonPHI();
3411         if (!cast<Instruction>(UnwindPad)->isEHPad())
3412           continue;
3413         Value *UnwindParent = getParentPad(UnwindPad);
3414         // Ignore unwind edges that don't exit CurrentPad.
3415         if (UnwindParent == CurrentPad)
3416           continue;
3417         // Determine whether the original funclet pad is exited,
3418         // and if we are scanning nested pads determine how many
3419         // of them are exited so we can stop searching their
3420         // children.
3421         Value *ExitedPad = CurrentPad;
3422         ExitsFPI = false;
3423         do {
3424           if (ExitedPad == &FPI) {
3425             ExitsFPI = true;
3426             // Now we can resolve any ancestors of CurrentPad up to
3427             // FPI, but not including FPI since we need to make sure
3428             // to check all direct users of FPI for consistency.
3429             UnresolvedAncestorPad = &FPI;
3430             break;
3431           }
3432           Value *ExitedParent = getParentPad(ExitedPad);
3433           if (ExitedParent == UnwindParent) {
3434             // ExitedPad is the ancestor-most pad which this unwind
3435             // edge exits, so we can resolve up to it, meaning that
3436             // ExitedParent is the first ancestor still unresolved.
3437             UnresolvedAncestorPad = ExitedParent;
3438             break;
3439           }
3440           ExitedPad = ExitedParent;
3441         } while (!isa<ConstantTokenNone>(ExitedPad));
3442       } else {
3443         // Unwinding to caller exits all pads.
3444         UnwindPad = ConstantTokenNone::get(FPI.getContext());
3445         ExitsFPI = true;
3446         UnresolvedAncestorPad = &FPI;
3447       }
3448 
3449       if (ExitsFPI) {
3450         // This unwind edge exits FPI.  Make sure it agrees with other
3451         // such edges.
3452         if (FirstUser) {
3453           Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3454                                               "pad must have the same unwind "
3455                                               "dest",
3456                  &FPI, U, FirstUser);
3457         } else {
3458           FirstUser = U;
3459           FirstUnwindPad = UnwindPad;
3460           // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3461           if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3462               getParentPad(UnwindPad) == getParentPad(&FPI))
3463             SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
3464         }
3465       }
3466       // Make sure we visit all uses of FPI, but for nested pads stop as
3467       // soon as we know where they unwind to.
3468       if (CurrentPad != &FPI)
3469         break;
3470     }
3471     if (UnresolvedAncestorPad) {
3472       if (CurrentPad == UnresolvedAncestorPad) {
3473         // When CurrentPad is FPI itself, we don't mark it as resolved even if
3474         // we've found an unwind edge that exits it, because we need to verify
3475         // all direct uses of FPI.
3476         assert(CurrentPad == &FPI);
3477         continue;
3478       }
3479       // Pop off the worklist any nested pads that we've found an unwind
3480       // destination for.  The pads on the worklist are the uncles,
3481       // great-uncles, etc. of CurrentPad.  We've found an unwind destination
3482       // for all ancestors of CurrentPad up to but not including
3483       // UnresolvedAncestorPad.
3484       Value *ResolvedPad = CurrentPad;
3485       while (!Worklist.empty()) {
3486         Value *UnclePad = Worklist.back();
3487         Value *AncestorPad = getParentPad(UnclePad);
3488         // Walk ResolvedPad up the ancestor list until we either find the
3489         // uncle's parent or the last resolved ancestor.
3490         while (ResolvedPad != AncestorPad) {
3491           Value *ResolvedParent = getParentPad(ResolvedPad);
3492           if (ResolvedParent == UnresolvedAncestorPad) {
3493             break;
3494           }
3495           ResolvedPad = ResolvedParent;
3496         }
3497         // If the resolved ancestor search didn't find the uncle's parent,
3498         // then the uncle is not yet resolved.
3499         if (ResolvedPad != AncestorPad)
3500           break;
3501         // This uncle is resolved, so pop it from the worklist.
3502         Worklist.pop_back();
3503       }
3504     }
3505   }
3506 
3507   if (FirstUnwindPad) {
3508     if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3509       BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3510       Value *SwitchUnwindPad;
3511       if (SwitchUnwindDest)
3512         SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3513       else
3514         SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3515       Assert(SwitchUnwindPad == FirstUnwindPad,
3516              "Unwind edges out of a catch must have the same unwind dest as "
3517              "the parent catchswitch",
3518              &FPI, FirstUser, CatchSwitch);
3519     }
3520   }
3521 
3522   visitInstruction(FPI);
3523 }
3524 
3525 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3526   BasicBlock *BB = CatchSwitch.getParent();
3527 
3528   Function *F = BB->getParent();
3529   Assert(F->hasPersonalityFn(),
3530          "CatchSwitchInst needs to be in a function with a personality.",
3531          &CatchSwitch);
3532 
3533   // The catchswitch instruction must be the first non-PHI instruction in the
3534   // block.
3535   Assert(BB->getFirstNonPHI() == &CatchSwitch,
3536          "CatchSwitchInst not the first non-PHI instruction in the block.",
3537          &CatchSwitch);
3538 
3539   auto *ParentPad = CatchSwitch.getParentPad();
3540   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3541          "CatchSwitchInst has an invalid parent.", ParentPad);
3542 
3543   if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
3544     Instruction *I = UnwindDest->getFirstNonPHI();
3545     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3546            "CatchSwitchInst must unwind to an EH block which is not a "
3547            "landingpad.",
3548            &CatchSwitch);
3549 
3550     // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3551     if (getParentPad(I) == ParentPad)
3552       SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3553   }
3554 
3555   Assert(CatchSwitch.getNumHandlers() != 0,
3556          "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3557 
3558   for (BasicBlock *Handler : CatchSwitch.handlers()) {
3559     Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3560            "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
3561   }
3562 
3563   visitEHPadPredecessors(CatchSwitch);
3564   visitTerminatorInst(CatchSwitch);
3565 }
3566 
3567 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
3568   Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3569          "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3570          CRI.getOperand(0));
3571 
3572   if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3573     Instruction *I = UnwindDest->getFirstNonPHI();
3574     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3575            "CleanupReturnInst must unwind to an EH block which is not a "
3576            "landingpad.",
3577            &CRI);
3578   }
3579 
3580   visitTerminatorInst(CRI);
3581 }
3582 
3583 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3584   Instruction *Op = cast<Instruction>(I.getOperand(i));
3585   // If the we have an invalid invoke, don't try to compute the dominance.
3586   // We already reject it in the invoke specific checks and the dominance
3587   // computation doesn't handle multiple edges.
3588   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3589     if (II->getNormalDest() == II->getUnwindDest())
3590       return;
3591   }
3592 
3593   // Quick check whether the def has already been encountered in the same block.
3594   // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3595   // uses are defined to happen on the incoming edge, not at the instruction.
3596   //
3597   // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3598   // wrapping an SSA value, assert that we've already encountered it.  See
3599   // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
3600   if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3601     return;
3602 
3603   const Use &U = I.getOperandUse(i);
3604   Assert(DT.dominates(Op, U),
3605          "Instruction does not dominate all uses!", Op, &I);
3606 }
3607 
3608 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3609   Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3610          "apply only to pointer types", &I);
3611   Assert(isa<LoadInst>(I),
3612          "dereferenceable, dereferenceable_or_null apply only to load"
3613          " instructions, use attributes for calls or invokes", &I);
3614   Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3615          "take one operand!", &I);
3616   ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3617   Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3618          "dereferenceable_or_null metadata value must be an i64!", &I);
3619 }
3620 
3621 /// verifyInstruction - Verify that an instruction is well formed.
3622 ///
3623 void Verifier::visitInstruction(Instruction &I) {
3624   BasicBlock *BB = I.getParent();
3625   Assert(BB, "Instruction not embedded in basic block!", &I);
3626 
3627   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
3628     for (User *U : I.users()) {
3629       Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3630              "Only PHI nodes may reference their own value!", &I);
3631     }
3632   }
3633 
3634   // Check that void typed values don't have names
3635   Assert(!I.getType()->isVoidTy() || !I.hasName(),
3636          "Instruction has a name, but provides a void value!", &I);
3637 
3638   // Check that the return value of the instruction is either void or a legal
3639   // value type.
3640   Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3641          "Instruction returns a non-scalar type!", &I);
3642 
3643   // Check that the instruction doesn't produce metadata. Calls are already
3644   // checked against the callee type.
3645   Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3646          "Invalid use of metadata!", &I);
3647 
3648   // Check that all uses of the instruction, if they are instructions
3649   // themselves, actually have parent basic blocks.  If the use is not an
3650   // instruction, it is an error!
3651   for (Use &U : I.uses()) {
3652     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3653       Assert(Used->getParent() != nullptr,
3654              "Instruction referencing"
3655              " instruction not embedded in a basic block!",
3656              &I, Used);
3657     else {
3658       CheckFailed("Use of instruction is not an instruction!", U);
3659       return;
3660     }
3661   }
3662 
3663   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3664     Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3665 
3666     // Check to make sure that only first-class-values are operands to
3667     // instructions.
3668     if (!I.getOperand(i)->getType()->isFirstClassType()) {
3669       Assert(0, "Instruction operands must be first-class values!", &I);
3670     }
3671 
3672     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3673       // Check to make sure that the "address of" an intrinsic function is never
3674       // taken.
3675       Assert(
3676           !F->isIntrinsic() ||
3677               i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3678           "Cannot take the address of an intrinsic!", &I);
3679       Assert(
3680           !F->isIntrinsic() || isa<CallInst>(I) ||
3681               F->getIntrinsicID() == Intrinsic::donothing ||
3682               F->getIntrinsicID() == Intrinsic::coro_resume ||
3683               F->getIntrinsicID() == Intrinsic::coro_destroy ||
3684               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3685               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3686               F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3687           "Cannot invoke an intrinsic other than donothing, patchpoint, "
3688           "statepoint, coro_resume or coro_destroy",
3689           &I);
3690       Assert(F->getParent() == &M, "Referencing function in another module!",
3691              &I, &M, F, F->getParent());
3692     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3693       Assert(OpBB->getParent() == BB->getParent(),
3694              "Referring to a basic block in another function!", &I);
3695     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3696       Assert(OpArg->getParent() == BB->getParent(),
3697              "Referring to an argument in another function!", &I);
3698     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3699       Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3700              &M, GV, GV->getParent());
3701     } else if (isa<Instruction>(I.getOperand(i))) {
3702       verifyDominatesUse(I, i);
3703     } else if (isa<InlineAsm>(I.getOperand(i))) {
3704       Assert((i + 1 == e && isa<CallInst>(I)) ||
3705                  (i + 3 == e && isa<InvokeInst>(I)),
3706              "Cannot take the address of an inline asm!", &I);
3707     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3708       if (CE->getType()->isPtrOrPtrVectorTy() ||
3709           !DL.getNonIntegralAddressSpaces().empty()) {
3710         // If we have a ConstantExpr pointer, we need to see if it came from an
3711         // illegal bitcast.  If the datalayout string specifies non-integral
3712         // address spaces then we also need to check for illegal ptrtoint and
3713         // inttoptr expressions.
3714         visitConstantExprsRecursively(CE);
3715       }
3716     }
3717   }
3718 
3719   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3720     Assert(I.getType()->isFPOrFPVectorTy(),
3721            "fpmath requires a floating point result!", &I);
3722     Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3723     if (ConstantFP *CFP0 =
3724             mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3725       const APFloat &Accuracy = CFP0->getValueAPF();
3726       Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle,
3727              "fpmath accuracy must have float type", &I);
3728       Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3729              "fpmath accuracy not a positive number!", &I);
3730     } else {
3731       Assert(false, "invalid fpmath accuracy!", &I);
3732     }
3733   }
3734 
3735   if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3736     Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3737            "Ranges are only for loads, calls and invokes!", &I);
3738     visitRangeMetadata(I, Range, I.getType());
3739   }
3740 
3741   if (I.getMetadata(LLVMContext::MD_nonnull)) {
3742     Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3743            &I);
3744     Assert(isa<LoadInst>(I),
3745            "nonnull applies only to load instructions, use attributes"
3746            " for calls or invokes",
3747            &I);
3748   }
3749 
3750   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3751     visitDereferenceableMetadata(I, MD);
3752 
3753   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3754     visitDereferenceableMetadata(I, MD);
3755 
3756   if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3757     Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3758            &I);
3759     Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3760            "use attributes for calls or invokes", &I);
3761     Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3762     ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3763     Assert(CI && CI->getType()->isIntegerTy(64),
3764            "align metadata value must be an i64!", &I);
3765     uint64_t Align = CI->getZExtValue();
3766     Assert(isPowerOf2_64(Align),
3767            "align metadata value must be a power of 2!", &I);
3768     Assert(Align <= Value::MaximumAlignment,
3769            "alignment is larger that implementation defined limit", &I);
3770   }
3771 
3772   if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3773     AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3774     visitMDNode(*N);
3775   }
3776 
3777   if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3778     verifyBitPieceExpression(*DII);
3779 
3780   InstsInThisBlock.insert(&I);
3781 }
3782 
3783 /// Allow intrinsics to be verified in different ways.
3784 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3785   Function *IF = CS.getCalledFunction();
3786   Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3787          IF);
3788 
3789   // Verify that the intrinsic prototype lines up with what the .td files
3790   // describe.
3791   FunctionType *IFTy = IF->getFunctionType();
3792   bool IsVarArg = IFTy->isVarArg();
3793 
3794   SmallVector<Intrinsic::IITDescriptor, 8> Table;
3795   getIntrinsicInfoTableEntries(ID, Table);
3796   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3797 
3798   SmallVector<Type *, 4> ArgTys;
3799   Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3800                                         TableRef, ArgTys),
3801          "Intrinsic has incorrect return type!", IF);
3802   for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3803     Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3804                                           TableRef, ArgTys),
3805            "Intrinsic has incorrect argument type!", IF);
3806 
3807   // Verify if the intrinsic call matches the vararg property.
3808   if (IsVarArg)
3809     Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
3810            "Intrinsic was not defined with variable arguments!", IF);
3811   else
3812     Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
3813            "Callsite was not defined with variable arguments!", IF);
3814 
3815   // All descriptors should be absorbed by now.
3816   Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3817 
3818   // Now that we have the intrinsic ID and the actual argument types (and we
3819   // know they are legal for the intrinsic!) get the intrinsic name through the
3820   // usual means.  This allows us to verify the mangling of argument types into
3821   // the name.
3822   const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3823   Assert(ExpectedName == IF->getName(),
3824          "Intrinsic name not mangled correctly for type arguments! "
3825          "Should be: " +
3826              ExpectedName,
3827          IF);
3828 
3829   // If the intrinsic takes MDNode arguments, verify that they are either global
3830   // or are local to *this* function.
3831   for (Value *V : CS.args())
3832     if (auto *MD = dyn_cast<MetadataAsValue>(V))
3833       visitMetadataAsValue(*MD, CS.getCaller());
3834 
3835   switch (ID) {
3836   default:
3837     break;
3838   case Intrinsic::coro_id: {
3839     auto *InfoArg = CS.getArgOperand(2)->stripPointerCasts();
3840     if (isa<ConstantPointerNull>(InfoArg))
3841       break;
3842     auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3843     Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3844       "info argument of llvm.coro.begin must refer to an initialized "
3845       "constant");
3846     Constant *Init = GV->getInitializer();
3847     Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3848       "info argument of llvm.coro.begin must refer to either a struct or "
3849       "an array");
3850     break;
3851   }
3852   case Intrinsic::ctlz:  // llvm.ctlz
3853   case Intrinsic::cttz:  // llvm.cttz
3854     Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3855            "is_zero_undef argument of bit counting intrinsics must be a "
3856            "constant int",
3857            CS);
3858     break;
3859   case Intrinsic::dbg_declare: // llvm.dbg.declare
3860     Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3861            "invalid llvm.dbg.declare intrinsic call 1", CS);
3862     visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3863     break;
3864   case Intrinsic::dbg_value: // llvm.dbg.value
3865     visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3866     break;
3867   case Intrinsic::memcpy:
3868   case Intrinsic::memmove:
3869   case Intrinsic::memset: {
3870     ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3871     Assert(AlignCI,
3872            "alignment argument of memory intrinsics must be a constant int",
3873            CS);
3874     const APInt &AlignVal = AlignCI->getValue();
3875     Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3876            "alignment argument of memory intrinsics must be a power of 2", CS);
3877     Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3878            "isvolatile argument of memory intrinsics must be a constant int",
3879            CS);
3880     break;
3881   }
3882   case Intrinsic::gcroot:
3883   case Intrinsic::gcwrite:
3884   case Intrinsic::gcread:
3885     if (ID == Intrinsic::gcroot) {
3886       AllocaInst *AI =
3887         dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3888       Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3889       Assert(isa<Constant>(CS.getArgOperand(1)),
3890              "llvm.gcroot parameter #2 must be a constant.", CS);
3891       if (!AI->getAllocatedType()->isPointerTy()) {
3892         Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3893                "llvm.gcroot parameter #1 must either be a pointer alloca, "
3894                "or argument #2 must be a non-null constant.",
3895                CS);
3896       }
3897     }
3898 
3899     Assert(CS.getParent()->getParent()->hasGC(),
3900            "Enclosing function does not use GC.", CS);
3901     break;
3902   case Intrinsic::init_trampoline:
3903     Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3904            "llvm.init_trampoline parameter #2 must resolve to a function.",
3905            CS);
3906     break;
3907   case Intrinsic::prefetch:
3908     Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3909                isa<ConstantInt>(CS.getArgOperand(2)) &&
3910                cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3911                cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3912            "invalid arguments to llvm.prefetch", CS);
3913     break;
3914   case Intrinsic::stackprotector:
3915     Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3916            "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3917     break;
3918   case Intrinsic::lifetime_start:
3919   case Intrinsic::lifetime_end:
3920   case Intrinsic::invariant_start:
3921     Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3922            "size argument of memory use markers must be a constant integer",
3923            CS);
3924     break;
3925   case Intrinsic::invariant_end:
3926     Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3927            "llvm.invariant.end parameter #2 must be a constant integer", CS);
3928     break;
3929 
3930   case Intrinsic::localescape: {
3931     BasicBlock *BB = CS.getParent();
3932     Assert(BB == &BB->getParent()->front(),
3933            "llvm.localescape used outside of entry block", CS);
3934     Assert(!SawFrameEscape,
3935            "multiple calls to llvm.localescape in one function", CS);
3936     for (Value *Arg : CS.args()) {
3937       if (isa<ConstantPointerNull>(Arg))
3938         continue; // Null values are allowed as placeholders.
3939       auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3940       Assert(AI && AI->isStaticAlloca(),
3941              "llvm.localescape only accepts static allocas", CS);
3942     }
3943     FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3944     SawFrameEscape = true;
3945     break;
3946   }
3947   case Intrinsic::localrecover: {
3948     Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3949     Function *Fn = dyn_cast<Function>(FnArg);
3950     Assert(Fn && !Fn->isDeclaration(),
3951            "llvm.localrecover first "
3952            "argument must be function defined in this module",
3953            CS);
3954     auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3955     Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3956            CS);
3957     auto &Entry = FrameEscapeInfo[Fn];
3958     Entry.second = unsigned(
3959         std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3960     break;
3961   }
3962 
3963   case Intrinsic::experimental_gc_statepoint:
3964     Assert(!CS.isInlineAsm(),
3965            "gc.statepoint support for inline assembly unimplemented", CS);
3966     Assert(CS.getParent()->getParent()->hasGC(),
3967            "Enclosing function does not use GC.", CS);
3968 
3969     verifyStatepoint(CS);
3970     break;
3971   case Intrinsic::experimental_gc_result: {
3972     Assert(CS.getParent()->getParent()->hasGC(),
3973            "Enclosing function does not use GC.", CS);
3974     // Are we tied to a statepoint properly?
3975     CallSite StatepointCS(CS.getArgOperand(0));
3976     const Function *StatepointFn =
3977       StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3978     Assert(StatepointFn && StatepointFn->isDeclaration() &&
3979                StatepointFn->getIntrinsicID() ==
3980                    Intrinsic::experimental_gc_statepoint,
3981            "gc.result operand #1 must be from a statepoint", CS,
3982            CS.getArgOperand(0));
3983 
3984     // Assert that result type matches wrapped callee.
3985     const Value *Target = StatepointCS.getArgument(2);
3986     auto *PT = cast<PointerType>(Target->getType());
3987     auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
3988     Assert(CS.getType() == TargetFuncType->getReturnType(),
3989            "gc.result result type does not match wrapped callee", CS);
3990     break;
3991   }
3992   case Intrinsic::experimental_gc_relocate: {
3993     Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3994 
3995     Assert(isa<PointerType>(CS.getType()->getScalarType()),
3996            "gc.relocate must return a pointer or a vector of pointers", CS);
3997 
3998     // Check that this relocate is correctly tied to the statepoint
3999 
4000     // This is case for relocate on the unwinding path of an invoke statepoint
4001     if (LandingPadInst *LandingPad =
4002           dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
4003 
4004       const BasicBlock *InvokeBB =
4005           LandingPad->getParent()->getUniquePredecessor();
4006 
4007       // Landingpad relocates should have only one predecessor with invoke
4008       // statepoint terminator
4009       Assert(InvokeBB, "safepoints should have unique landingpads",
4010              LandingPad->getParent());
4011       Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4012              InvokeBB);
4013       Assert(isStatepoint(InvokeBB->getTerminator()),
4014              "gc relocate should be linked to a statepoint", InvokeBB);
4015     }
4016     else {
4017       // In all other cases relocate should be tied to the statepoint directly.
4018       // This covers relocates on a normal return path of invoke statepoint and
4019       // relocates of a call statepoint.
4020       auto Token = CS.getArgOperand(0);
4021       Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
4022              "gc relocate is incorrectly tied to the statepoint", CS, Token);
4023     }
4024 
4025     // Verify rest of the relocate arguments.
4026 
4027     ImmutableCallSite StatepointCS(
4028         cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
4029 
4030     // Both the base and derived must be piped through the safepoint.
4031     Value* Base = CS.getArgOperand(1);
4032     Assert(isa<ConstantInt>(Base),
4033            "gc.relocate operand #2 must be integer offset", CS);
4034 
4035     Value* Derived = CS.getArgOperand(2);
4036     Assert(isa<ConstantInt>(Derived),
4037            "gc.relocate operand #3 must be integer offset", CS);
4038 
4039     const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4040     const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4041     // Check the bounds
4042     Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
4043            "gc.relocate: statepoint base index out of bounds", CS);
4044     Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
4045            "gc.relocate: statepoint derived index out of bounds", CS);
4046 
4047     // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
4048     // section of the statepoint's argument.
4049     Assert(StatepointCS.arg_size() > 0,
4050            "gc.statepoint: insufficient arguments");
4051     Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
4052            "gc.statement: number of call arguments must be constant integer");
4053     const unsigned NumCallArgs =
4054         cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4055     Assert(StatepointCS.arg_size() > NumCallArgs + 5,
4056            "gc.statepoint: mismatch in number of call arguments");
4057     Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
4058            "gc.statepoint: number of transition arguments must be "
4059            "a constant integer");
4060     const int NumTransitionArgs =
4061         cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4062             ->getZExtValue();
4063     const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
4064     Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
4065            "gc.statepoint: number of deoptimization arguments must be "
4066            "a constant integer");
4067     const int NumDeoptArgs =
4068         cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4069             ->getZExtValue();
4070     const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
4071     const int GCParamArgsEnd = StatepointCS.arg_size();
4072     Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4073            "gc.relocate: statepoint base index doesn't fall within the "
4074            "'gc parameters' section of the statepoint call",
4075            CS);
4076     Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4077            "gc.relocate: statepoint derived index doesn't fall within the "
4078            "'gc parameters' section of the statepoint call",
4079            CS);
4080 
4081     // Relocated value must be either a pointer type or vector-of-pointer type,
4082     // but gc_relocate does not need to return the same pointer type as the
4083     // relocated pointer. It can be casted to the correct type later if it's
4084     // desired. However, they must have the same address space and 'vectorness'
4085     GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
4086     Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
4087            "gc.relocate: relocated value must be a gc pointer", CS);
4088 
4089     auto ResultType = CS.getType();
4090     auto DerivedType = Relocate.getDerivedPtr()->getType();
4091     Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
4092            "gc.relocate: vector relocates to vector and pointer to pointer",
4093            CS);
4094     Assert(
4095         ResultType->getPointerAddressSpace() ==
4096             DerivedType->getPointerAddressSpace(),
4097         "gc.relocate: relocating a pointer shouldn't change its address space",
4098         CS);
4099     break;
4100   }
4101   case Intrinsic::eh_exceptioncode:
4102   case Intrinsic::eh_exceptionpointer: {
4103     Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4104            "eh.exceptionpointer argument must be a catchpad", CS);
4105     break;
4106   }
4107   case Intrinsic::masked_load: {
4108     Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4109 
4110     Value *Ptr = CS.getArgOperand(0);
4111     //Value *Alignment = CS.getArgOperand(1);
4112     Value *Mask = CS.getArgOperand(2);
4113     Value *PassThru = CS.getArgOperand(3);
4114     Assert(Mask->getType()->isVectorTy(),
4115            "masked_load: mask must be vector", CS);
4116 
4117     // DataTy is the overloaded type
4118     Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4119     Assert(DataTy == CS.getType(),
4120            "masked_load: return must match pointer type", CS);
4121     Assert(PassThru->getType() == DataTy,
4122            "masked_load: pass through and data type must match", CS);
4123     Assert(Mask->getType()->getVectorNumElements() ==
4124            DataTy->getVectorNumElements(),
4125            "masked_load: vector mask must be same length as data", CS);
4126     break;
4127   }
4128   case Intrinsic::masked_store: {
4129     Value *Val = CS.getArgOperand(0);
4130     Value *Ptr = CS.getArgOperand(1);
4131     //Value *Alignment = CS.getArgOperand(2);
4132     Value *Mask = CS.getArgOperand(3);
4133     Assert(Mask->getType()->isVectorTy(),
4134            "masked_store: mask must be vector", CS);
4135 
4136     // DataTy is the overloaded type
4137     Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4138     Assert(DataTy == Val->getType(),
4139            "masked_store: storee must match pointer type", CS);
4140     Assert(Mask->getType()->getVectorNumElements() ==
4141            DataTy->getVectorNumElements(),
4142            "masked_store: vector mask must be same length as data", CS);
4143     break;
4144   }
4145 
4146   case Intrinsic::experimental_guard: {
4147     Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4148     Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4149            "experimental_guard must have exactly one "
4150            "\"deopt\" operand bundle");
4151     break;
4152   }
4153 
4154   case Intrinsic::experimental_deoptimize: {
4155     Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4156     Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4157            "experimental_deoptimize must have exactly one "
4158            "\"deopt\" operand bundle");
4159     Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4160            "experimental_deoptimize return type must match caller return type");
4161 
4162     if (CS.isCall()) {
4163       auto *DeoptCI = CS.getInstruction();
4164       auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4165       Assert(RI,
4166              "calls to experimental_deoptimize must be followed by a return");
4167 
4168       if (!CS.getType()->isVoidTy() && RI)
4169         Assert(RI->getReturnValue() == DeoptCI,
4170                "calls to experimental_deoptimize must be followed by a return "
4171                "of the value computed by experimental_deoptimize");
4172     }
4173 
4174     break;
4175   }
4176   };
4177 }
4178 
4179 /// \brief Carefully grab the subprogram from a local scope.
4180 ///
4181 /// This carefully grabs the subprogram from a local scope, avoiding the
4182 /// built-in assertions that would typically fire.
4183 static DISubprogram *getSubprogram(Metadata *LocalScope) {
4184   if (!LocalScope)
4185     return nullptr;
4186 
4187   if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
4188     return SP;
4189 
4190   if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
4191     return getSubprogram(LB->getRawScope());
4192 
4193   // Just return null; broken scope chains are checked elsewhere.
4194   assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
4195   return nullptr;
4196 }
4197 
4198 template <class DbgIntrinsicTy>
4199 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4200   auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4201   AssertDI(isa<ValueAsMetadata>(MD) ||
4202              (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4203          "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
4204   AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
4205          "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4206          DII.getRawVariable());
4207   AssertDI(isa<DIExpression>(DII.getRawExpression()),
4208          "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4209          DII.getRawExpression());
4210 
4211   // Ignore broken !dbg attachments; they're checked elsewhere.
4212   if (MDNode *N = DII.getDebugLoc().getAsMDNode())
4213     if (!isa<DILocation>(N))
4214       return;
4215 
4216   BasicBlock *BB = DII.getParent();
4217   Function *F = BB ? BB->getParent() : nullptr;
4218 
4219   // The scopes for variables and !dbg attachments must agree.
4220   DILocalVariable *Var = DII.getVariable();
4221   DILocation *Loc = DII.getDebugLoc();
4222   Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4223          &DII, BB, F);
4224 
4225   DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4226   DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
4227   if (!VarSP || !LocSP)
4228     return; // Broken scope chains are checked elsewhere.
4229 
4230   Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4231                              " variable and !dbg attachment",
4232          &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4233          Loc->getScope()->getSubprogram());
4234 }
4235 
4236 static uint64_t getVariableSize(const DILocalVariable &V) {
4237   // Be careful of broken types (checked elsewhere).
4238   const Metadata *RawType = V.getRawType();
4239   while (RawType) {
4240     // Try to get the size directly.
4241     if (auto *T = dyn_cast<DIType>(RawType))
4242       if (uint64_t Size = T->getSizeInBits())
4243         return Size;
4244 
4245     if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
4246       // Look at the base type.
4247       RawType = DT->getRawBaseType();
4248       continue;
4249     }
4250 
4251     // Missing type or size.
4252     break;
4253   }
4254 
4255   // Fail gracefully.
4256   return 0;
4257 }
4258 
4259 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
4260   DILocalVariable *V;
4261   DIExpression *E;
4262   if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
4263     V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4264     E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
4265   } else {
4266     auto *DDI = cast<DbgDeclareInst>(&I);
4267     V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4268     E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
4269   }
4270 
4271   // We don't know whether this intrinsic verified correctly.
4272   if (!V || !E || !E->isValid())
4273     return;
4274 
4275   // Nothing to do if this isn't a bit piece expression.
4276   if (!E->isBitPiece())
4277     return;
4278 
4279   // The frontend helps out GDB by emitting the members of local anonymous
4280   // unions as artificial local variables with shared storage. When SROA splits
4281   // the storage for artificial local variables that are smaller than the entire
4282   // union, the overhang piece will be outside of the allotted space for the
4283   // variable and this check fails.
4284   // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4285   if (V->isArtificial())
4286     return;
4287 
4288   // If there's no size, the type is broken, but that should be checked
4289   // elsewhere.
4290   uint64_t VarSize = getVariableSize(*V);
4291   if (!VarSize)
4292     return;
4293 
4294   unsigned PieceSize = E->getBitPieceSize();
4295   unsigned PieceOffset = E->getBitPieceOffset();
4296   Assert(PieceSize + PieceOffset <= VarSize,
4297          "piece is larger than or outside of variable", &I, V, E);
4298   Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
4299 }
4300 
4301 void Verifier::verifyCompileUnits() {
4302   auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
4303   SmallPtrSet<const Metadata *, 2> Listed;
4304   if (CUs)
4305     Listed.insert(CUs->op_begin(), CUs->op_end());
4306   Assert(
4307       all_of(CUVisited,
4308              [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4309       "All DICompileUnits must be listed in llvm.dbg.cu");
4310   CUVisited.clear();
4311 }
4312 
4313 void Verifier::verifyDeoptimizeCallingConvs() {
4314   if (DeoptimizeDeclarations.empty())
4315     return;
4316 
4317   const Function *First = DeoptimizeDeclarations[0];
4318   for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
4319     Assert(First->getCallingConv() == F->getCallingConv(),
4320            "All llvm.experimental.deoptimize declarations must have the same "
4321            "calling convention",
4322            First, F);
4323   }
4324 }
4325 
4326 //===----------------------------------------------------------------------===//
4327 //  Implement the public interfaces to this file...
4328 //===----------------------------------------------------------------------===//
4329 
4330 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
4331   Function &F = const_cast<Function &>(f);
4332 
4333   // Don't use a raw_null_ostream.  Printing IR is expensive.
4334   Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
4335 
4336   // Note that this function's return value is inverted from what you would
4337   // expect of a function called "verify".
4338   return !V.verify(F);
4339 }
4340 
4341 bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4342                         bool *BrokenDebugInfo) {
4343   // Don't use a raw_null_ostream.  Printing IR is expensive.
4344   Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
4345 
4346   bool Broken = false;
4347   for (const Function &F : M)
4348     Broken |= !V.verify(F);
4349 
4350   Broken |= !V.verify();
4351   if (BrokenDebugInfo)
4352     *BrokenDebugInfo = V.hasBrokenDebugInfo();
4353   // Note that this function's return value is inverted from what you would
4354   // expect of a function called "verify".
4355   return Broken;
4356 }
4357 
4358 namespace {
4359 struct VerifierLegacyPass : public FunctionPass {
4360   static char ID;
4361 
4362   std::unique_ptr<Verifier> V;
4363   bool FatalErrors = true;
4364 
4365   VerifierLegacyPass() : FunctionPass(ID) {
4366     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
4367   }
4368   explicit VerifierLegacyPass(bool FatalErrors)
4369       : FunctionPass(ID),
4370         FatalErrors(FatalErrors) {
4371     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
4372   }
4373 
4374   bool doInitialization(Module &M) override {
4375     V = llvm::make_unique<Verifier>(
4376         &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4377     return false;
4378   }
4379 
4380   bool runOnFunction(Function &F) override {
4381     if (!V->verify(F) && FatalErrors)
4382       report_fatal_error("Broken function found, compilation aborted!");
4383 
4384     return false;
4385   }
4386 
4387   bool doFinalization(Module &M) override {
4388     bool HasErrors = false;
4389     for (Function &F : M)
4390       if (F.isDeclaration())
4391         HasErrors |= !V->verify(F);
4392 
4393     HasErrors |= !V->verify();
4394     if (FatalErrors) {
4395       if (HasErrors)
4396         report_fatal_error("Broken module found, compilation aborted!");
4397       assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
4398     }
4399 
4400     // Strip broken debug info.
4401     if (V->hasBrokenDebugInfo()) {
4402       DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4403       M.getContext().diagnose(DiagInvalid);
4404       if (!StripDebugInfo(M))
4405         report_fatal_error("Failed to strip malformed debug info");
4406     }
4407     return false;
4408   }
4409 
4410   void getAnalysisUsage(AnalysisUsage &AU) const override {
4411     AU.setPreservesAll();
4412   }
4413 };
4414 }
4415 
4416 char VerifierLegacyPass::ID = 0;
4417 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
4418 
4419 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
4420   return new VerifierLegacyPass(FatalErrors);
4421 }
4422 
4423 char VerifierAnalysis::PassID;
4424 VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4425                                                ModuleAnalysisManager &) {
4426   Result Res;
4427   Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4428   return Res;
4429 }
4430 
4431 VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4432                                                FunctionAnalysisManager &) {
4433   return { llvm::verifyFunction(F, &dbgs()), false };
4434 }
4435 
4436 PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4437   auto Res = AM.getResult<VerifierAnalysis>(M);
4438   if (FatalErrors) {
4439     if (Res.IRBroken)
4440       report_fatal_error("Broken module found, compilation aborted!");
4441     assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4442   }
4443 
4444   // Strip broken debug info.
4445   if (Res.DebugInfoBroken) {
4446     DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4447     M.getContext().diagnose(DiagInvalid);
4448     if (!StripDebugInfo(M))
4449       report_fatal_error("Failed to strip malformed debug info");
4450   }
4451   return PreservedAnalyses::all();
4452 }
4453 
4454 PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4455   auto res = AM.getResult<VerifierAnalysis>(F);
4456   if (res.IRBroken && FatalErrors)
4457     report_fatal_error("Broken function found, compilation aborted!");
4458 
4459   return PreservedAnalyses::all();
4460 }
4461