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