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