1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the function verifier interface, that can be used for some
10 // sanity checking of input to the system.
11 //
12 // Note that this does not provide full `Java style' security and verifications,
13 // instead it just tries to ensure that code is well-formed.
14 //
15 //  * Both of a binary operator's parameters are of the same type
16 //  * Verify that the indices of mem access instructions match other operands
17 //  * Verify that arithmetic and other things are only performed on first-class
18 //    types.  Verify that shifts & logicals only happen on integrals f.e.
19 //  * All of the constants in a switch statement are of the correct type
20 //  * The code is in valid SSA form
21 //  * It should be illegal to put a label into any other type (like a structure)
22 //    or to return one. [except constant arrays!]
23 //  * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
24 //  * PHI nodes must have an entry for each predecessor, with no extras.
25 //  * PHI nodes must be the first thing in a basic block, all grouped together
26 //  * PHI nodes must have at least one entry
27 //  * All basic blocks should only end with terminator insts, not contain them
28 //  * The entry node to a function must not have predecessors
29 //  * All Instructions must be embedded into a basic block
30 //  * Functions cannot take a void-typed parameter
31 //  * Verify that a function's argument list agrees with it's declared type.
32 //  * It is illegal to specify a name for a void value.
33 //  * It is illegal to have a internal global value with no initializer
34 //  * It is illegal to have a ret instruction that returns a value that does not
35 //    agree with the function return value type.
36 //  * Function call argument types match the function prototype
37 //  * A landing pad is defined by a landingpad instruction, and can be jumped to
38 //    only by the unwind edge of an invoke instruction.
39 //  * A landingpad instruction must be the first non-PHI instruction in the
40 //    block.
41 //  * Landingpad instructions must be in a function with a personality function.
42 //  * All other things that are tested by asserts spread about the code...
43 //
44 //===----------------------------------------------------------------------===//
45 
46 #include "llvm/IR/Verifier.h"
47 #include "llvm/ADT/APFloat.h"
48 #include "llvm/ADT/APInt.h"
49 #include "llvm/ADT/ArrayRef.h"
50 #include "llvm/ADT/DenseMap.h"
51 #include "llvm/ADT/MapVector.h"
52 #include "llvm/ADT/Optional.h"
53 #include "llvm/ADT/STLExtras.h"
54 #include "llvm/ADT/SmallPtrSet.h"
55 #include "llvm/ADT/SmallSet.h"
56 #include "llvm/ADT/SmallVector.h"
57 #include "llvm/ADT/StringExtras.h"
58 #include "llvm/ADT/StringMap.h"
59 #include "llvm/ADT/StringRef.h"
60 #include "llvm/ADT/Twine.h"
61 #include "llvm/ADT/ilist.h"
62 #include "llvm/BinaryFormat/Dwarf.h"
63 #include "llvm/IR/Argument.h"
64 #include "llvm/IR/Attributes.h"
65 #include "llvm/IR/BasicBlock.h"
66 #include "llvm/IR/CFG.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/Dominators.h"
78 #include "llvm/IR/Function.h"
79 #include "llvm/IR/GlobalAlias.h"
80 #include "llvm/IR/GlobalValue.h"
81 #include "llvm/IR/GlobalVariable.h"
82 #include "llvm/IR/InlineAsm.h"
83 #include "llvm/IR/InstVisitor.h"
84 #include "llvm/IR/InstrTypes.h"
85 #include "llvm/IR/Instruction.h"
86 #include "llvm/IR/Instructions.h"
87 #include "llvm/IR/IntrinsicInst.h"
88 #include "llvm/IR/Intrinsics.h"
89 #include "llvm/IR/IntrinsicsWebAssembly.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/InitializePasses.h"
101 #include "llvm/Pass.h"
102 #include "llvm/Support/AtomicOrdering.h"
103 #include "llvm/Support/Casting.h"
104 #include "llvm/Support/CommandLine.h"
105 #include "llvm/Support/Debug.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> VerifyNoAliasScopeDomination(
119     "verify-noalias-scope-decl-dom", cl::Hidden, cl::init(false),
120     cl::desc("Ensure that llvm.experimental.noalias.scope.decl for identical "
121              "scopes are not dominating"));
122 
123 namespace llvm {
124 
125 struct VerifierSupport {
126   raw_ostream *OS;
127   const Module &M;
128   ModuleSlotTracker MST;
129   Triple TT;
130   const DataLayout &DL;
131   LLVMContext &Context;
132 
133   /// Track the brokenness of the module while recursively visiting.
134   bool Broken = false;
135   /// Broken debug info can be "recovered" from by stripping the debug info.
136   bool BrokenDebugInfo = false;
137   /// Whether to treat broken debug info as an error.
138   bool TreatBrokenDebugInfoAsError = true;
139 
140   explicit VerifierSupport(raw_ostream *OS, const Module &M)
141       : OS(OS), M(M), MST(&M), TT(M.getTargetTriple()), DL(M.getDataLayout()),
142         Context(M.getContext()) {}
143 
144 private:
145   void Write(const Module *M) {
146     *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
147   }
148 
149   void Write(const Value *V) {
150     if (V)
151       Write(*V);
152   }
153 
154   void Write(const Value &V) {
155     if (isa<Instruction>(V)) {
156       V.print(*OS, MST);
157       *OS << '\n';
158     } else {
159       V.printAsOperand(*OS, true, MST);
160       *OS << '\n';
161     }
162   }
163 
164   void Write(const Metadata *MD) {
165     if (!MD)
166       return;
167     MD->print(*OS, MST, &M);
168     *OS << '\n';
169   }
170 
171   template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
172     Write(MD.get());
173   }
174 
175   void Write(const NamedMDNode *NMD) {
176     if (!NMD)
177       return;
178     NMD->print(*OS, MST);
179     *OS << '\n';
180   }
181 
182   void Write(Type *T) {
183     if (!T)
184       return;
185     *OS << ' ' << *T;
186   }
187 
188   void Write(const Comdat *C) {
189     if (!C)
190       return;
191     *OS << *C;
192   }
193 
194   void Write(const APInt *AI) {
195     if (!AI)
196       return;
197     *OS << *AI << '\n';
198   }
199 
200   void Write(const unsigned i) { *OS << i << '\n'; }
201 
202   // NOLINTNEXTLINE(readability-identifier-naming)
203   void Write(const Attribute *A) {
204     if (!A)
205       return;
206     *OS << A->getAsString() << '\n';
207   }
208 
209   // NOLINTNEXTLINE(readability-identifier-naming)
210   void Write(const AttributeSet *AS) {
211     if (!AS)
212       return;
213     *OS << AS->getAsString() << '\n';
214   }
215 
216   // NOLINTNEXTLINE(readability-identifier-naming)
217   void Write(const AttributeList *AL) {
218     if (!AL)
219       return;
220     AL->print(*OS);
221   }
222 
223   template <typename T> void Write(ArrayRef<T> Vs) {
224     for (const T &V : Vs)
225       Write(V);
226   }
227 
228   template <typename T1, typename... Ts>
229   void WriteTs(const T1 &V1, const Ts &... Vs) {
230     Write(V1);
231     WriteTs(Vs...);
232   }
233 
234   template <typename... Ts> void WriteTs() {}
235 
236 public:
237   /// A check failed, so printout out the condition and the message.
238   ///
239   /// This provides a nice place to put a breakpoint if you want to see why
240   /// something is not correct.
241   void CheckFailed(const Twine &Message) {
242     if (OS)
243       *OS << Message << '\n';
244     Broken = true;
245   }
246 
247   /// A check failed (with values to print).
248   ///
249   /// This calls the Message-only version so that the above is easier to set a
250   /// breakpoint on.
251   template <typename T1, typename... Ts>
252   void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
253     CheckFailed(Message);
254     if (OS)
255       WriteTs(V1, Vs...);
256   }
257 
258   /// A debug info check failed.
259   void DebugInfoCheckFailed(const Twine &Message) {
260     if (OS)
261       *OS << Message << '\n';
262     Broken |= TreatBrokenDebugInfoAsError;
263     BrokenDebugInfo = true;
264   }
265 
266   /// A debug info check failed (with values to print).
267   template <typename T1, typename... Ts>
268   void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
269                             const Ts &... Vs) {
270     DebugInfoCheckFailed(Message);
271     if (OS)
272       WriteTs(V1, Vs...);
273   }
274 };
275 
276 } // namespace llvm
277 
278 namespace {
279 
280 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
281   friend class InstVisitor<Verifier>;
282 
283   DominatorTree DT;
284 
285   /// When verifying a basic block, keep track of all of the
286   /// instructions we have seen so far.
287   ///
288   /// This allows us to do efficient dominance checks for the case when an
289   /// instruction has an operand that is an instruction in the same block.
290   SmallPtrSet<Instruction *, 16> InstsInThisBlock;
291 
292   /// Keep track of the metadata nodes that have been checked already.
293   SmallPtrSet<const Metadata *, 32> MDNodes;
294 
295   /// Keep track which DISubprogram is attached to which function.
296   DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments;
297 
298   /// Track all DICompileUnits visited.
299   SmallPtrSet<const Metadata *, 2> CUVisited;
300 
301   /// The result type for a landingpad.
302   Type *LandingPadResultTy;
303 
304   /// Whether we've seen a call to @llvm.localescape in this function
305   /// already.
306   bool SawFrameEscape;
307 
308   /// Whether the current function has a DISubprogram attached to it.
309   bool HasDebugInfo = false;
310 
311   /// The current source language.
312   dwarf::SourceLanguage CurrentSourceLang = dwarf::DW_LANG_lo_user;
313 
314   /// Whether source was present on the first DIFile encountered in each CU.
315   DenseMap<const DICompileUnit *, bool> HasSourceDebugInfo;
316 
317   /// Stores the count of how many objects were passed to llvm.localescape for a
318   /// given function and the largest index passed to llvm.localrecover.
319   DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
320 
321   // Maps catchswitches and cleanuppads that unwind to siblings to the
322   // terminators that indicate the unwind, used to detect cycles therein.
323   MapVector<Instruction *, Instruction *> SiblingFuncletInfo;
324 
325   /// Cache of constants visited in search of ConstantExprs.
326   SmallPtrSet<const Constant *, 32> ConstantExprVisited;
327 
328   /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
329   SmallVector<const Function *, 4> DeoptimizeDeclarations;
330 
331   /// Cache of attribute lists verified.
332   SmallPtrSet<const void *, 32> AttributeListsVisited;
333 
334   // Verify that this GlobalValue is only used in this module.
335   // This map is used to avoid visiting uses twice. We can arrive at a user
336   // twice, if they have multiple operands. In particular for very large
337   // constant expressions, we can arrive at a particular user many times.
338   SmallPtrSet<const Value *, 32> GlobalValueVisited;
339 
340   // Keeps track of duplicate function argument debug info.
341   SmallVector<const DILocalVariable *, 16> DebugFnArgs;
342 
343   TBAAVerifier TBAAVerifyHelper;
344 
345   SmallVector<IntrinsicInst *, 4> NoAliasScopeDecls;
346 
347   void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
348 
349 public:
350   explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
351                     const Module &M)
352       : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
353         SawFrameEscape(false), TBAAVerifyHelper(this) {
354     TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
355   }
356 
357   bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
358 
359   bool verify(const Function &F) {
360     assert(F.getParent() == &M &&
361            "An instance of this class only works with a specific module!");
362 
363     // First ensure the function is well-enough formed to compute dominance
364     // information, and directly compute a dominance tree. We don't rely on the
365     // pass manager to provide this as it isolates us from a potentially
366     // out-of-date dominator tree and makes it significantly more complex to run
367     // this code outside of a pass manager.
368     // FIXME: It's really gross that we have to cast away constness here.
369     if (!F.empty())
370       DT.recalculate(const_cast<Function &>(F));
371 
372     for (const BasicBlock &BB : F) {
373       if (!BB.empty() && BB.back().isTerminator())
374         continue;
375 
376       if (OS) {
377         *OS << "Basic Block in function '" << F.getName()
378             << "' does not have terminator!\n";
379         BB.printAsOperand(*OS, true, MST);
380         *OS << "\n";
381       }
382       return false;
383     }
384 
385     Broken = false;
386     // FIXME: We strip const here because the inst visitor strips const.
387     visit(const_cast<Function &>(F));
388     verifySiblingFuncletUnwinds();
389     InstsInThisBlock.clear();
390     DebugFnArgs.clear();
391     LandingPadResultTy = nullptr;
392     SawFrameEscape = false;
393     SiblingFuncletInfo.clear();
394     verifyNoAliasScopeDecl();
395     NoAliasScopeDecls.clear();
396 
397     return !Broken;
398   }
399 
400   /// Verify the module that this instance of \c Verifier was initialized with.
401   bool verify() {
402     Broken = false;
403 
404     // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
405     for (const Function &F : M)
406       if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
407         DeoptimizeDeclarations.push_back(&F);
408 
409     // Now that we've visited every function, verify that we never asked to
410     // recover a frame index that wasn't escaped.
411     verifyFrameRecoverIndices();
412     for (const GlobalVariable &GV : M.globals())
413       visitGlobalVariable(GV);
414 
415     for (const GlobalAlias &GA : M.aliases())
416       visitGlobalAlias(GA);
417 
418     for (const NamedMDNode &NMD : M.named_metadata())
419       visitNamedMDNode(NMD);
420 
421     for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
422       visitComdat(SMEC.getValue());
423 
424     visitModuleFlags(M);
425     visitModuleIdents(M);
426     visitModuleCommandLines(M);
427 
428     verifyCompileUnits();
429 
430     verifyDeoptimizeCallingConvs();
431     DISubprogramAttachments.clear();
432     return !Broken;
433   }
434 
435 private:
436   /// Whether a metadata node is allowed to be, or contain, a DILocation.
437   enum class AreDebugLocsAllowed { No, Yes };
438 
439   // Verification methods...
440   void visitGlobalValue(const GlobalValue &GV);
441   void visitGlobalVariable(const GlobalVariable &GV);
442   void visitGlobalAlias(const GlobalAlias &GA);
443   void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
444   void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
445                            const GlobalAlias &A, const Constant &C);
446   void visitNamedMDNode(const NamedMDNode &NMD);
447   void visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs);
448   void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
449   void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
450   void visitComdat(const Comdat &C);
451   void visitModuleIdents(const Module &M);
452   void visitModuleCommandLines(const Module &M);
453   void visitModuleFlags(const Module &M);
454   void visitModuleFlag(const MDNode *Op,
455                        DenseMap<const MDString *, const MDNode *> &SeenIDs,
456                        SmallVectorImpl<const MDNode *> &Requirements);
457   void visitModuleFlagCGProfileEntry(const MDOperand &MDO);
458   void visitFunction(const Function &F);
459   void visitBasicBlock(BasicBlock &BB);
460   void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
461   void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
462   void visitProfMetadata(Instruction &I, MDNode *MD);
463   void visitAnnotationMetadata(MDNode *Annotation);
464 
465   template <class Ty> bool isValidMetadataArray(const MDTuple &N);
466 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
467 #include "llvm/IR/Metadata.def"
468   void visitDIScope(const DIScope &N);
469   void visitDIVariable(const DIVariable &N);
470   void visitDILexicalBlockBase(const DILexicalBlockBase &N);
471   void visitDITemplateParameter(const DITemplateParameter &N);
472 
473   void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
474 
475   // InstVisitor overrides...
476   using InstVisitor<Verifier>::visit;
477   void visit(Instruction &I);
478 
479   void visitTruncInst(TruncInst &I);
480   void visitZExtInst(ZExtInst &I);
481   void visitSExtInst(SExtInst &I);
482   void visitFPTruncInst(FPTruncInst &I);
483   void visitFPExtInst(FPExtInst &I);
484   void visitFPToUIInst(FPToUIInst &I);
485   void visitFPToSIInst(FPToSIInst &I);
486   void visitUIToFPInst(UIToFPInst &I);
487   void visitSIToFPInst(SIToFPInst &I);
488   void visitIntToPtrInst(IntToPtrInst &I);
489   void visitPtrToIntInst(PtrToIntInst &I);
490   void visitBitCastInst(BitCastInst &I);
491   void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
492   void visitPHINode(PHINode &PN);
493   void visitCallBase(CallBase &Call);
494   void visitUnaryOperator(UnaryOperator &U);
495   void visitBinaryOperator(BinaryOperator &B);
496   void visitICmpInst(ICmpInst &IC);
497   void visitFCmpInst(FCmpInst &FC);
498   void visitExtractElementInst(ExtractElementInst &EI);
499   void visitInsertElementInst(InsertElementInst &EI);
500   void visitShuffleVectorInst(ShuffleVectorInst &EI);
501   void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
502   void visitCallInst(CallInst &CI);
503   void visitInvokeInst(InvokeInst &II);
504   void visitGetElementPtrInst(GetElementPtrInst &GEP);
505   void visitLoadInst(LoadInst &LI);
506   void visitStoreInst(StoreInst &SI);
507   void verifyDominatesUse(Instruction &I, unsigned i);
508   void visitInstruction(Instruction &I);
509   void visitTerminator(Instruction &I);
510   void visitBranchInst(BranchInst &BI);
511   void visitReturnInst(ReturnInst &RI);
512   void visitSwitchInst(SwitchInst &SI);
513   void visitIndirectBrInst(IndirectBrInst &BI);
514   void visitCallBrInst(CallBrInst &CBI);
515   void visitSelectInst(SelectInst &SI);
516   void visitUserOp1(Instruction &I);
517   void visitUserOp2(Instruction &I) { visitUserOp1(I); }
518   void visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call);
519   void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
520   void visitDbgIntrinsic(StringRef Kind, DbgVariableIntrinsic &DII);
521   void visitDbgLabelIntrinsic(StringRef Kind, DbgLabelInst &DLI);
522   void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
523   void visitAtomicRMWInst(AtomicRMWInst &RMWI);
524   void visitFenceInst(FenceInst &FI);
525   void visitAllocaInst(AllocaInst &AI);
526   void visitExtractValueInst(ExtractValueInst &EVI);
527   void visitInsertValueInst(InsertValueInst &IVI);
528   void visitEHPadPredecessors(Instruction &I);
529   void visitLandingPadInst(LandingPadInst &LPI);
530   void visitResumeInst(ResumeInst &RI);
531   void visitCatchPadInst(CatchPadInst &CPI);
532   void visitCatchReturnInst(CatchReturnInst &CatchReturn);
533   void visitCleanupPadInst(CleanupPadInst &CPI);
534   void visitFuncletPadInst(FuncletPadInst &FPI);
535   void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
536   void visitCleanupReturnInst(CleanupReturnInst &CRI);
537 
538   void verifySwiftErrorCall(CallBase &Call, const Value *SwiftErrorVal);
539   void verifySwiftErrorValue(const Value *SwiftErrorVal);
540   void verifyMustTailCall(CallInst &CI);
541   bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
542   void verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
543                             const Value *V);
544   void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
545   void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
546                            const Value *V, bool IsIntrinsic);
547   void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
548 
549   void visitConstantExprsRecursively(const Constant *EntryC);
550   void visitConstantExpr(const ConstantExpr *CE);
551   void verifyStatepoint(const CallBase &Call);
552   void verifyFrameRecoverIndices();
553   void verifySiblingFuncletUnwinds();
554 
555   void verifyFragmentExpression(const DbgVariableIntrinsic &I);
556   template <typename ValueOrMetadata>
557   void verifyFragmentExpression(const DIVariable &V,
558                                 DIExpression::FragmentInfo Fragment,
559                                 ValueOrMetadata *Desc);
560   void verifyFnArgs(const DbgVariableIntrinsic &I);
561   void verifyNotEntryValue(const DbgVariableIntrinsic &I);
562 
563   /// Module-level debug info verification...
564   void verifyCompileUnits();
565 
566   /// Module-level verification that all @llvm.experimental.deoptimize
567   /// declarations share the same calling convention.
568   void verifyDeoptimizeCallingConvs();
569 
570   /// Verify all-or-nothing property of DIFile source attribute within a CU.
571   void verifySourceDebugInfo(const DICompileUnit &U, const DIFile &F);
572 
573   /// Verify the llvm.experimental.noalias.scope.decl declarations
574   void verifyNoAliasScopeDecl();
575 };
576 
577 } // end anonymous namespace
578 
579 /// We know that cond should be true, if not print an error message.
580 #define Assert(C, ...) \
581   do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
582 
583 /// We know that a debug info condition should be true, if not print
584 /// an error message.
585 #define AssertDI(C, ...) \
586   do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
587 
588 void Verifier::visit(Instruction &I) {
589   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
590     Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
591   InstVisitor<Verifier>::visit(I);
592 }
593 
594 // Helper to recursively iterate over indirect users. By
595 // returning false, the callback can ask to stop recursing
596 // further.
597 static void forEachUser(const Value *User,
598                         SmallPtrSet<const Value *, 32> &Visited,
599                         llvm::function_ref<bool(const Value *)> Callback) {
600   if (!Visited.insert(User).second)
601     return;
602   for (const Value *TheNextUser : User->materialized_users())
603     if (Callback(TheNextUser))
604       forEachUser(TheNextUser, Visited, Callback);
605 }
606 
607 void Verifier::visitGlobalValue(const GlobalValue &GV) {
608   Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
609          "Global is external, but doesn't have external or weak linkage!", &GV);
610 
611   if (const GlobalObject *GO = dyn_cast<GlobalObject>(&GV))
612     Assert(GO->getAlignment() <= Value::MaximumAlignment,
613            "huge alignment values are unsupported", GO);
614   Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
615          "Only global variables can have appending linkage!", &GV);
616 
617   if (GV.hasAppendingLinkage()) {
618     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
619     Assert(GVar && GVar->getValueType()->isArrayTy(),
620            "Only global arrays can have appending linkage!", GVar);
621   }
622 
623   if (GV.isDeclarationForLinker())
624     Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
625 
626   if (GV.hasDLLImportStorageClass()) {
627     Assert(!GV.isDSOLocal(),
628            "GlobalValue with DLLImport Storage is dso_local!", &GV);
629 
630     Assert((GV.isDeclaration() &&
631             (GV.hasExternalLinkage() || GV.hasExternalWeakLinkage())) ||
632                GV.hasAvailableExternallyLinkage(),
633            "Global is marked as dllimport, but not external", &GV);
634   }
635 
636   if (GV.isImplicitDSOLocal())
637     Assert(GV.isDSOLocal(),
638            "GlobalValue with local linkage or non-default "
639            "visibility must be dso_local!",
640            &GV);
641 
642   forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
643     if (const Instruction *I = dyn_cast<Instruction>(V)) {
644       if (!I->getParent() || !I->getParent()->getParent())
645         CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
646                     I);
647       else if (I->getParent()->getParent()->getParent() != &M)
648         CheckFailed("Global is referenced in a different module!", &GV, &M, I,
649                     I->getParent()->getParent(),
650                     I->getParent()->getParent()->getParent());
651       return false;
652     } else if (const Function *F = dyn_cast<Function>(V)) {
653       if (F->getParent() != &M)
654         CheckFailed("Global is used by function in a different module", &GV, &M,
655                     F, F->getParent());
656       return false;
657     }
658     return true;
659   });
660 }
661 
662 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
663   if (GV.hasInitializer()) {
664     Assert(GV.getInitializer()->getType() == GV.getValueType(),
665            "Global variable initializer type does not match global "
666            "variable type!",
667            &GV);
668     // If the global has common linkage, it must have a zero initializer and
669     // cannot be constant.
670     if (GV.hasCommonLinkage()) {
671       Assert(GV.getInitializer()->isNullValue(),
672              "'common' global must have a zero initializer!", &GV);
673       Assert(!GV.isConstant(), "'common' global may not be marked constant!",
674              &GV);
675       Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
676     }
677   }
678 
679   if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
680                        GV.getName() == "llvm.global_dtors")) {
681     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
682            "invalid linkage for intrinsic global variable", &GV);
683     // Don't worry about emitting an error for it not being an array,
684     // visitGlobalValue will complain on appending non-array.
685     if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
686       StructType *STy = dyn_cast<StructType>(ATy->getElementType());
687       PointerType *FuncPtrTy =
688           FunctionType::get(Type::getVoidTy(Context), false)->
689           getPointerTo(DL.getProgramAddressSpace());
690       Assert(STy &&
691                  (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
692                  STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
693                  STy->getTypeAtIndex(1) == FuncPtrTy,
694              "wrong type for intrinsic global variable", &GV);
695       Assert(STy->getNumElements() == 3,
696              "the third field of the element type is mandatory, "
697              "specify i8* null to migrate from the obsoleted 2-field form");
698       Type *ETy = STy->getTypeAtIndex(2);
699       Assert(ETy->isPointerTy() &&
700                  cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
701              "wrong type for intrinsic global variable", &GV);
702     }
703   }
704 
705   if (GV.hasName() && (GV.getName() == "llvm.used" ||
706                        GV.getName() == "llvm.compiler.used")) {
707     Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
708            "invalid linkage for intrinsic global variable", &GV);
709     Type *GVType = GV.getValueType();
710     if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
711       PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
712       Assert(PTy, "wrong type for intrinsic global variable", &GV);
713       if (GV.hasInitializer()) {
714         const Constant *Init = GV.getInitializer();
715         const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
716         Assert(InitArray, "wrong initalizer for intrinsic global variable",
717                Init);
718         for (Value *Op : InitArray->operands()) {
719           Value *V = Op->stripPointerCasts();
720           Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
721                      isa<GlobalAlias>(V),
722                  "invalid llvm.used member", V);
723           Assert(V->hasName(), "members of llvm.used must be named", V);
724         }
725       }
726     }
727   }
728 
729   // Visit any debug info attachments.
730   SmallVector<MDNode *, 1> MDs;
731   GV.getMetadata(LLVMContext::MD_dbg, MDs);
732   for (auto *MD : MDs) {
733     if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
734       visitDIGlobalVariableExpression(*GVE);
735     else
736       AssertDI(false, "!dbg attachment of global variable must be a "
737                       "DIGlobalVariableExpression");
738   }
739 
740   // Scalable vectors cannot be global variables, since we don't know
741   // the runtime size. If the global is an array containing scalable vectors,
742   // that will be caught by the isValidElementType methods in StructType or
743   // ArrayType instead.
744   Assert(!isa<ScalableVectorType>(GV.getValueType()),
745          "Globals cannot contain scalable vectors", &GV);
746 
747   if (auto *STy = dyn_cast<StructType>(GV.getValueType()))
748     Assert(!STy->containsScalableVectorType(),
749            "Globals cannot contain scalable vectors", &GV);
750 
751   if (!GV.hasInitializer()) {
752     visitGlobalValue(GV);
753     return;
754   }
755 
756   // Walk any aggregate initializers looking for bitcasts between address spaces
757   visitConstantExprsRecursively(GV.getInitializer());
758 
759   visitGlobalValue(GV);
760 }
761 
762 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
763   SmallPtrSet<const GlobalAlias*, 4> Visited;
764   Visited.insert(&GA);
765   visitAliaseeSubExpr(Visited, GA, C);
766 }
767 
768 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
769                                    const GlobalAlias &GA, const Constant &C) {
770   if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
771     Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
772            &GA);
773 
774     if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
775       Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
776 
777       Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
778              &GA);
779     } else {
780       // Only continue verifying subexpressions of GlobalAliases.
781       // Do not recurse into global initializers.
782       return;
783     }
784   }
785 
786   if (const auto *CE = dyn_cast<ConstantExpr>(&C))
787     visitConstantExprsRecursively(CE);
788 
789   for (const Use &U : C.operands()) {
790     Value *V = &*U;
791     if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
792       visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
793     else if (const auto *C2 = dyn_cast<Constant>(V))
794       visitAliaseeSubExpr(Visited, GA, *C2);
795   }
796 }
797 
798 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
799   Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
800          "Alias should have private, internal, linkonce, weak, linkonce_odr, "
801          "weak_odr, or external linkage!",
802          &GA);
803   const Constant *Aliasee = GA.getAliasee();
804   Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
805   Assert(GA.getType() == Aliasee->getType(),
806          "Alias and aliasee types should match!", &GA);
807 
808   Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
809          "Aliasee should be either GlobalValue or ConstantExpr", &GA);
810 
811   visitAliaseeSubExpr(GA, *Aliasee);
812 
813   visitGlobalValue(GA);
814 }
815 
816 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
817   // There used to be various other llvm.dbg.* nodes, but we don't support
818   // upgrading them and we want to reserve the namespace for future uses.
819   if (NMD.getName().startswith("llvm.dbg."))
820     AssertDI(NMD.getName() == "llvm.dbg.cu",
821              "unrecognized named metadata node in the llvm.dbg namespace",
822              &NMD);
823   for (const MDNode *MD : NMD.operands()) {
824     if (NMD.getName() == "llvm.dbg.cu")
825       AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
826 
827     if (!MD)
828       continue;
829 
830     visitMDNode(*MD, AreDebugLocsAllowed::Yes);
831   }
832 }
833 
834 void Verifier::visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs) {
835   // Only visit each node once.  Metadata can be mutually recursive, so this
836   // avoids infinite recursion here, as well as being an optimization.
837   if (!MDNodes.insert(&MD).second)
838     return;
839 
840   Assert(&MD.getContext() == &Context,
841          "MDNode context does not match Module context!", &MD);
842 
843   switch (MD.getMetadataID()) {
844   default:
845     llvm_unreachable("Invalid MDNode subclass");
846   case Metadata::MDTupleKind:
847     break;
848 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS)                                  \
849   case Metadata::CLASS##Kind:                                                  \
850     visit##CLASS(cast<CLASS>(MD));                                             \
851     break;
852 #include "llvm/IR/Metadata.def"
853   }
854 
855   for (const Metadata *Op : MD.operands()) {
856     if (!Op)
857       continue;
858     Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
859            &MD, Op);
860     AssertDI(!isa<DILocation>(Op) || AllowLocs == AreDebugLocsAllowed::Yes,
861              "DILocation not allowed within this metadata node", &MD, Op);
862     if (auto *N = dyn_cast<MDNode>(Op)) {
863       visitMDNode(*N, AllowLocs);
864       continue;
865     }
866     if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
867       visitValueAsMetadata(*V, nullptr);
868       continue;
869     }
870   }
871 
872   // Check these last, so we diagnose problems in operands first.
873   Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
874   Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
875 }
876 
877 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
878   Assert(MD.getValue(), "Expected valid value", &MD);
879   Assert(!MD.getValue()->getType()->isMetadataTy(),
880          "Unexpected metadata round-trip through values", &MD, MD.getValue());
881 
882   auto *L = dyn_cast<LocalAsMetadata>(&MD);
883   if (!L)
884     return;
885 
886   Assert(F, "function-local metadata used outside a function", L);
887 
888   // If this was an instruction, bb, or argument, verify that it is in the
889   // function that we expect.
890   Function *ActualF = nullptr;
891   if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
892     Assert(I->getParent(), "function-local metadata not in basic block", L, I);
893     ActualF = I->getParent()->getParent();
894   } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
895     ActualF = BB->getParent();
896   else if (Argument *A = dyn_cast<Argument>(L->getValue()))
897     ActualF = A->getParent();
898   assert(ActualF && "Unimplemented function local metadata case!");
899 
900   Assert(ActualF == F, "function-local metadata used in wrong function", L);
901 }
902 
903 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
904   Metadata *MD = MDV.getMetadata();
905   if (auto *N = dyn_cast<MDNode>(MD)) {
906     visitMDNode(*N, AreDebugLocsAllowed::No);
907     return;
908   }
909 
910   // Only visit each node once.  Metadata can be mutually recursive, so this
911   // avoids infinite recursion here, as well as being an optimization.
912   if (!MDNodes.insert(MD).second)
913     return;
914 
915   if (auto *V = dyn_cast<ValueAsMetadata>(MD))
916     visitValueAsMetadata(*V, F);
917 }
918 
919 static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
920 static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
921 static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
922 
923 void Verifier::visitDILocation(const DILocation &N) {
924   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
925            "location requires a valid scope", &N, N.getRawScope());
926   if (auto *IA = N.getRawInlinedAt())
927     AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
928   if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
929     AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
930 }
931 
932 void Verifier::visitGenericDINode(const GenericDINode &N) {
933   AssertDI(N.getTag(), "invalid tag", &N);
934 }
935 
936 void Verifier::visitDIScope(const DIScope &N) {
937   if (auto *F = N.getRawFile())
938     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
939 }
940 
941 void Verifier::visitDISubrange(const DISubrange &N) {
942   AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
943   bool HasAssumedSizedArraySupport = dwarf::isFortran(CurrentSourceLang);
944   AssertDI(HasAssumedSizedArraySupport || N.getRawCountNode() ||
945                N.getRawUpperBound(),
946            "Subrange must contain count or upperBound", &N);
947   AssertDI(!N.getRawCountNode() || !N.getRawUpperBound(),
948            "Subrange can have any one of count or upperBound", &N);
949   auto *CBound = N.getRawCountNode();
950   AssertDI(!CBound || isa<ConstantAsMetadata>(CBound) ||
951                isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
952            "Count must be signed constant or DIVariable or DIExpression", &N);
953   auto Count = N.getCount();
954   AssertDI(!Count || !Count.is<ConstantInt *>() ||
955                Count.get<ConstantInt *>()->getSExtValue() >= -1,
956            "invalid subrange count", &N);
957   auto *LBound = N.getRawLowerBound();
958   AssertDI(!LBound || isa<ConstantAsMetadata>(LBound) ||
959                isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
960            "LowerBound must be signed constant or DIVariable or DIExpression",
961            &N);
962   auto *UBound = N.getRawUpperBound();
963   AssertDI(!UBound || isa<ConstantAsMetadata>(UBound) ||
964                isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
965            "UpperBound must be signed constant or DIVariable or DIExpression",
966            &N);
967   auto *Stride = N.getRawStride();
968   AssertDI(!Stride || isa<ConstantAsMetadata>(Stride) ||
969                isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
970            "Stride must be signed constant or DIVariable or DIExpression", &N);
971 }
972 
973 void Verifier::visitDIGenericSubrange(const DIGenericSubrange &N) {
974   AssertDI(N.getTag() == dwarf::DW_TAG_generic_subrange, "invalid tag", &N);
975   AssertDI(N.getRawCountNode() || N.getRawUpperBound(),
976            "GenericSubrange must contain count or upperBound", &N);
977   AssertDI(!N.getRawCountNode() || !N.getRawUpperBound(),
978            "GenericSubrange can have any one of count or upperBound", &N);
979   auto *CBound = N.getRawCountNode();
980   AssertDI(!CBound || isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
981            "Count must be signed constant or DIVariable or DIExpression", &N);
982   auto *LBound = N.getRawLowerBound();
983   AssertDI(LBound, "GenericSubrange must contain lowerBound", &N);
984   AssertDI(isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
985            "LowerBound must be signed constant or DIVariable or DIExpression",
986            &N);
987   auto *UBound = N.getRawUpperBound();
988   AssertDI(!UBound || isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
989            "UpperBound must be signed constant or DIVariable or DIExpression",
990            &N);
991   auto *Stride = N.getRawStride();
992   AssertDI(Stride, "GenericSubrange must contain stride", &N);
993   AssertDI(isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
994            "Stride must be signed constant or DIVariable or DIExpression", &N);
995 }
996 
997 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
998   AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
999 }
1000 
1001 void Verifier::visitDIBasicType(const DIBasicType &N) {
1002   AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
1003                N.getTag() == dwarf::DW_TAG_unspecified_type ||
1004                N.getTag() == dwarf::DW_TAG_string_type,
1005            "invalid tag", &N);
1006 }
1007 
1008 void Verifier::visitDIStringType(const DIStringType &N) {
1009   AssertDI(N.getTag() == dwarf::DW_TAG_string_type, "invalid tag", &N);
1010   AssertDI(!(N.isBigEndian() && N.isLittleEndian()) ,
1011             "has conflicting flags", &N);
1012 }
1013 
1014 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
1015   // Common scope checks.
1016   visitDIScope(N);
1017 
1018   AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
1019                N.getTag() == dwarf::DW_TAG_pointer_type ||
1020                N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
1021                N.getTag() == dwarf::DW_TAG_reference_type ||
1022                N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
1023                N.getTag() == dwarf::DW_TAG_const_type ||
1024                N.getTag() == dwarf::DW_TAG_volatile_type ||
1025                N.getTag() == dwarf::DW_TAG_restrict_type ||
1026                N.getTag() == dwarf::DW_TAG_atomic_type ||
1027                N.getTag() == dwarf::DW_TAG_member ||
1028                N.getTag() == dwarf::DW_TAG_inheritance ||
1029                N.getTag() == dwarf::DW_TAG_friend ||
1030                N.getTag() == dwarf::DW_TAG_set_type,
1031            "invalid tag", &N);
1032   if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
1033     AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
1034              N.getRawExtraData());
1035   }
1036 
1037   if (N.getTag() == dwarf::DW_TAG_set_type) {
1038     if (auto *T = N.getRawBaseType()) {
1039       auto *Enum = dyn_cast_or_null<DICompositeType>(T);
1040       auto *Basic = dyn_cast_or_null<DIBasicType>(T);
1041       AssertDI(
1042           (Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type) ||
1043               (Basic && (Basic->getEncoding() == dwarf::DW_ATE_unsigned ||
1044                          Basic->getEncoding() == dwarf::DW_ATE_signed ||
1045                          Basic->getEncoding() == dwarf::DW_ATE_unsigned_char ||
1046                          Basic->getEncoding() == dwarf::DW_ATE_signed_char ||
1047                          Basic->getEncoding() == dwarf::DW_ATE_boolean)),
1048           "invalid set base type", &N, T);
1049     }
1050   }
1051 
1052   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1053   AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
1054            N.getRawBaseType());
1055 
1056   if (N.getDWARFAddressSpace()) {
1057     AssertDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
1058                  N.getTag() == dwarf::DW_TAG_reference_type ||
1059                  N.getTag() == dwarf::DW_TAG_rvalue_reference_type,
1060              "DWARF address space only applies to pointer or reference types",
1061              &N);
1062   }
1063 }
1064 
1065 /// Detect mutually exclusive flags.
1066 static bool hasConflictingReferenceFlags(unsigned Flags) {
1067   return ((Flags & DINode::FlagLValueReference) &&
1068           (Flags & DINode::FlagRValueReference)) ||
1069          ((Flags & DINode::FlagTypePassByValue) &&
1070           (Flags & DINode::FlagTypePassByReference));
1071 }
1072 
1073 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
1074   auto *Params = dyn_cast<MDTuple>(&RawParams);
1075   AssertDI(Params, "invalid template params", &N, &RawParams);
1076   for (Metadata *Op : Params->operands()) {
1077     AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
1078              &N, Params, Op);
1079   }
1080 }
1081 
1082 void Verifier::visitDICompositeType(const DICompositeType &N) {
1083   // Common scope checks.
1084   visitDIScope(N);
1085 
1086   AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
1087                N.getTag() == dwarf::DW_TAG_structure_type ||
1088                N.getTag() == dwarf::DW_TAG_union_type ||
1089                N.getTag() == dwarf::DW_TAG_enumeration_type ||
1090                N.getTag() == dwarf::DW_TAG_class_type ||
1091                N.getTag() == dwarf::DW_TAG_variant_part,
1092            "invalid tag", &N);
1093 
1094   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1095   AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
1096            N.getRawBaseType());
1097 
1098   AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
1099            "invalid composite elements", &N, N.getRawElements());
1100   AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
1101            N.getRawVTableHolder());
1102   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1103            "invalid reference flags", &N);
1104   unsigned DIBlockByRefStruct = 1 << 4;
1105   AssertDI((N.getFlags() & DIBlockByRefStruct) == 0,
1106            "DIBlockByRefStruct on DICompositeType is no longer supported", &N);
1107 
1108   if (N.isVector()) {
1109     const DINodeArray Elements = N.getElements();
1110     AssertDI(Elements.size() == 1 &&
1111              Elements[0]->getTag() == dwarf::DW_TAG_subrange_type,
1112              "invalid vector, expected one element of type subrange", &N);
1113   }
1114 
1115   if (auto *Params = N.getRawTemplateParams())
1116     visitTemplateParams(N, *Params);
1117 
1118   if (auto *D = N.getRawDiscriminator()) {
1119     AssertDI(isa<DIDerivedType>(D) && N.getTag() == dwarf::DW_TAG_variant_part,
1120              "discriminator can only appear on variant part");
1121   }
1122 
1123   if (N.getRawDataLocation()) {
1124     AssertDI(N.getTag() == dwarf::DW_TAG_array_type,
1125              "dataLocation can only appear in array type");
1126   }
1127 
1128   if (N.getRawAssociated()) {
1129     AssertDI(N.getTag() == dwarf::DW_TAG_array_type,
1130              "associated can only appear in array type");
1131   }
1132 
1133   if (N.getRawAllocated()) {
1134     AssertDI(N.getTag() == dwarf::DW_TAG_array_type,
1135              "allocated can only appear in array type");
1136   }
1137 
1138   if (N.getRawRank()) {
1139     AssertDI(N.getTag() == dwarf::DW_TAG_array_type,
1140              "rank can only appear in array type");
1141   }
1142 }
1143 
1144 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
1145   AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
1146   if (auto *Types = N.getRawTypeArray()) {
1147     AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
1148     for (Metadata *Ty : N.getTypeArray()->operands()) {
1149       AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
1150     }
1151   }
1152   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1153            "invalid reference flags", &N);
1154 }
1155 
1156 void Verifier::visitDIFile(const DIFile &N) {
1157   AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
1158   Optional<DIFile::ChecksumInfo<StringRef>> Checksum = N.getChecksum();
1159   if (Checksum) {
1160     AssertDI(Checksum->Kind <= DIFile::ChecksumKind::CSK_Last,
1161              "invalid checksum kind", &N);
1162     size_t Size;
1163     switch (Checksum->Kind) {
1164     case DIFile::CSK_MD5:
1165       Size = 32;
1166       break;
1167     case DIFile::CSK_SHA1:
1168       Size = 40;
1169       break;
1170     case DIFile::CSK_SHA256:
1171       Size = 64;
1172       break;
1173     }
1174     AssertDI(Checksum->Value.size() == Size, "invalid checksum length", &N);
1175     AssertDI(Checksum->Value.find_if_not(llvm::isHexDigit) == StringRef::npos,
1176              "invalid checksum", &N);
1177   }
1178 }
1179 
1180 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
1181   AssertDI(N.isDistinct(), "compile units must be distinct", &N);
1182   AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
1183 
1184   // Don't bother verifying the compilation directory or producer string
1185   // as those could be empty.
1186   AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
1187            N.getRawFile());
1188   AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
1189            N.getFile());
1190 
1191   CurrentSourceLang = (dwarf::SourceLanguage)N.getSourceLanguage();
1192 
1193   verifySourceDebugInfo(N, *N.getFile());
1194 
1195   AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
1196            "invalid emission kind", &N);
1197 
1198   if (auto *Array = N.getRawEnumTypes()) {
1199     AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
1200     for (Metadata *Op : N.getEnumTypes()->operands()) {
1201       auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
1202       AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
1203                "invalid enum type", &N, N.getEnumTypes(), Op);
1204     }
1205   }
1206   if (auto *Array = N.getRawRetainedTypes()) {
1207     AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
1208     for (Metadata *Op : N.getRetainedTypes()->operands()) {
1209       AssertDI(Op && (isa<DIType>(Op) ||
1210                       (isa<DISubprogram>(Op) &&
1211                        !cast<DISubprogram>(Op)->isDefinition())),
1212                "invalid retained type", &N, Op);
1213     }
1214   }
1215   if (auto *Array = N.getRawGlobalVariables()) {
1216     AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
1217     for (Metadata *Op : N.getGlobalVariables()->operands()) {
1218       AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1219                "invalid global variable ref", &N, Op);
1220     }
1221   }
1222   if (auto *Array = N.getRawImportedEntities()) {
1223     AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
1224     for (Metadata *Op : N.getImportedEntities()->operands()) {
1225       AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1226                &N, Op);
1227     }
1228   }
1229   if (auto *Array = N.getRawMacros()) {
1230     AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1231     for (Metadata *Op : N.getMacros()->operands()) {
1232       AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1233     }
1234   }
1235   CUVisited.insert(&N);
1236 }
1237 
1238 void Verifier::visitDISubprogram(const DISubprogram &N) {
1239   AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1240   AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1241   if (auto *F = N.getRawFile())
1242     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1243   else
1244     AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
1245   if (auto *T = N.getRawType())
1246     AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1247   AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1248            N.getRawContainingType());
1249   if (auto *Params = N.getRawTemplateParams())
1250     visitTemplateParams(N, *Params);
1251   if (auto *S = N.getRawDeclaration())
1252     AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1253              "invalid subprogram declaration", &N, S);
1254   if (auto *RawNode = N.getRawRetainedNodes()) {
1255     auto *Node = dyn_cast<MDTuple>(RawNode);
1256     AssertDI(Node, "invalid retained nodes list", &N, RawNode);
1257     for (Metadata *Op : Node->operands()) {
1258       AssertDI(Op && (isa<DILocalVariable>(Op) || isa<DILabel>(Op)),
1259                "invalid retained nodes, expected DILocalVariable or DILabel",
1260                &N, Node, Op);
1261     }
1262   }
1263   AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1264            "invalid reference flags", &N);
1265 
1266   auto *Unit = N.getRawUnit();
1267   if (N.isDefinition()) {
1268     // Subprogram definitions (not part of the type hierarchy).
1269     AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1270     AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1271     AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
1272     if (N.getFile())
1273       verifySourceDebugInfo(*N.getUnit(), *N.getFile());
1274   } else {
1275     // Subprogram declarations (part of the type hierarchy).
1276     AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
1277   }
1278 
1279   if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1280     auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1281     AssertDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1282     for (Metadata *Op : ThrownTypes->operands())
1283       AssertDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1284                Op);
1285   }
1286 
1287   if (N.areAllCallsDescribed())
1288     AssertDI(N.isDefinition(),
1289              "DIFlagAllCallsDescribed must be attached to a definition");
1290 }
1291 
1292 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1293   AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1294   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1295            "invalid local scope", &N, N.getRawScope());
1296   if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1297     AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
1298 }
1299 
1300 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1301   visitDILexicalBlockBase(N);
1302 
1303   AssertDI(N.getLine() || !N.getColumn(),
1304            "cannot have column info without line info", &N);
1305 }
1306 
1307 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1308   visitDILexicalBlockBase(N);
1309 }
1310 
1311 void Verifier::visitDICommonBlock(const DICommonBlock &N) {
1312   AssertDI(N.getTag() == dwarf::DW_TAG_common_block, "invalid tag", &N);
1313   if (auto *S = N.getRawScope())
1314     AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1315   if (auto *S = N.getRawDecl())
1316     AssertDI(isa<DIGlobalVariable>(S), "invalid declaration", &N, S);
1317 }
1318 
1319 void Verifier::visitDINamespace(const DINamespace &N) {
1320   AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1321   if (auto *S = N.getRawScope())
1322     AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1323 }
1324 
1325 void Verifier::visitDIMacro(const DIMacro &N) {
1326   AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1327                N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1328            "invalid macinfo type", &N);
1329   AssertDI(!N.getName().empty(), "anonymous macro", &N);
1330   if (!N.getValue().empty()) {
1331     assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1332   }
1333 }
1334 
1335 void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1336   AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1337            "invalid macinfo type", &N);
1338   if (auto *F = N.getRawFile())
1339     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1340 
1341   if (auto *Array = N.getRawElements()) {
1342     AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1343     for (Metadata *Op : N.getElements()->operands()) {
1344       AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1345     }
1346   }
1347 }
1348 
1349 void Verifier::visitDIArgList(const DIArgList &N) {
1350   AssertDI(!N.getNumOperands(),
1351            "DIArgList should have no operands other than a list of "
1352            "ValueAsMetadata",
1353            &N);
1354 }
1355 
1356 void Verifier::visitDIModule(const DIModule &N) {
1357   AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1358   AssertDI(!N.getName().empty(), "anonymous module", &N);
1359 }
1360 
1361 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1362   AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1363 }
1364 
1365 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1366   visitDITemplateParameter(N);
1367 
1368   AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1369            &N);
1370 }
1371 
1372 void Verifier::visitDITemplateValueParameter(
1373     const DITemplateValueParameter &N) {
1374   visitDITemplateParameter(N);
1375 
1376   AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1377                N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1378                N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1379            "invalid tag", &N);
1380 }
1381 
1382 void Verifier::visitDIVariable(const DIVariable &N) {
1383   if (auto *S = N.getRawScope())
1384     AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1385   if (auto *F = N.getRawFile())
1386     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1387 }
1388 
1389 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1390   // Checks common to all variables.
1391   visitDIVariable(N);
1392 
1393   AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1394   AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1395   // Assert only if the global variable is not an extern
1396   if (N.isDefinition())
1397     AssertDI(N.getType(), "missing global variable type", &N);
1398   if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1399     AssertDI(isa<DIDerivedType>(Member),
1400              "invalid static data member declaration", &N, Member);
1401   }
1402 }
1403 
1404 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1405   // Checks common to all variables.
1406   visitDIVariable(N);
1407 
1408   AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1409   AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1410   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1411            "local variable requires a valid scope", &N, N.getRawScope());
1412   if (auto Ty = N.getType())
1413     AssertDI(!isa<DISubroutineType>(Ty), "invalid type", &N, N.getType());
1414 }
1415 
1416 void Verifier::visitDILabel(const DILabel &N) {
1417   if (auto *S = N.getRawScope())
1418     AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1419   if (auto *F = N.getRawFile())
1420     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1421 
1422   AssertDI(N.getTag() == dwarf::DW_TAG_label, "invalid tag", &N);
1423   AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1424            "label requires a valid scope", &N, N.getRawScope());
1425 }
1426 
1427 void Verifier::visitDIExpression(const DIExpression &N) {
1428   AssertDI(N.isValid(), "invalid expression", &N);
1429 }
1430 
1431 void Verifier::visitDIGlobalVariableExpression(
1432     const DIGlobalVariableExpression &GVE) {
1433   AssertDI(GVE.getVariable(), "missing variable");
1434   if (auto *Var = GVE.getVariable())
1435     visitDIGlobalVariable(*Var);
1436   if (auto *Expr = GVE.getExpression()) {
1437     visitDIExpression(*Expr);
1438     if (auto Fragment = Expr->getFragmentInfo())
1439       verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE);
1440   }
1441 }
1442 
1443 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1444   AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1445   if (auto *T = N.getRawType())
1446     AssertDI(isType(T), "invalid type ref", &N, T);
1447   if (auto *F = N.getRawFile())
1448     AssertDI(isa<DIFile>(F), "invalid file", &N, F);
1449 }
1450 
1451 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1452   AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1453                N.getTag() == dwarf::DW_TAG_imported_declaration,
1454            "invalid tag", &N);
1455   if (auto *S = N.getRawScope())
1456     AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1457   AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1458            N.getRawEntity());
1459 }
1460 
1461 void Verifier::visitComdat(const Comdat &C) {
1462   // In COFF the Module is invalid if the GlobalValue has private linkage.
1463   // Entities with private linkage don't have entries in the symbol table.
1464   if (TT.isOSBinFormatCOFF())
1465     if (const GlobalValue *GV = M.getNamedValue(C.getName()))
1466       Assert(!GV->hasPrivateLinkage(),
1467              "comdat global value has private linkage", GV);
1468 }
1469 
1470 void Verifier::visitModuleIdents(const Module &M) {
1471   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1472   if (!Idents)
1473     return;
1474 
1475   // llvm.ident takes a list of metadata entry. Each entry has only one string.
1476   // Scan each llvm.ident entry and make sure that this requirement is met.
1477   for (const MDNode *N : Idents->operands()) {
1478     Assert(N->getNumOperands() == 1,
1479            "incorrect number of operands in llvm.ident metadata", N);
1480     Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1481            ("invalid value for llvm.ident metadata entry operand"
1482             "(the operand should be a string)"),
1483            N->getOperand(0));
1484   }
1485 }
1486 
1487 void Verifier::visitModuleCommandLines(const Module &M) {
1488   const NamedMDNode *CommandLines = M.getNamedMetadata("llvm.commandline");
1489   if (!CommandLines)
1490     return;
1491 
1492   // llvm.commandline takes a list of metadata entry. Each entry has only one
1493   // string. Scan each llvm.commandline entry and make sure that this
1494   // requirement is met.
1495   for (const MDNode *N : CommandLines->operands()) {
1496     Assert(N->getNumOperands() == 1,
1497            "incorrect number of operands in llvm.commandline metadata", N);
1498     Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1499            ("invalid value for llvm.commandline metadata entry operand"
1500             "(the operand should be a string)"),
1501            N->getOperand(0));
1502   }
1503 }
1504 
1505 void Verifier::visitModuleFlags(const Module &M) {
1506   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1507   if (!Flags) return;
1508 
1509   // Scan each flag, and track the flags and requirements.
1510   DenseMap<const MDString*, const MDNode*> SeenIDs;
1511   SmallVector<const MDNode*, 16> Requirements;
1512   for (const MDNode *MDN : Flags->operands())
1513     visitModuleFlag(MDN, SeenIDs, Requirements);
1514 
1515   // Validate that the requirements in the module are valid.
1516   for (const MDNode *Requirement : Requirements) {
1517     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1518     const Metadata *ReqValue = Requirement->getOperand(1);
1519 
1520     const MDNode *Op = SeenIDs.lookup(Flag);
1521     if (!Op) {
1522       CheckFailed("invalid requirement on flag, flag is not present in module",
1523                   Flag);
1524       continue;
1525     }
1526 
1527     if (Op->getOperand(2) != ReqValue) {
1528       CheckFailed(("invalid requirement on flag, "
1529                    "flag does not have the required value"),
1530                   Flag);
1531       continue;
1532     }
1533   }
1534 }
1535 
1536 void
1537 Verifier::visitModuleFlag(const MDNode *Op,
1538                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
1539                           SmallVectorImpl<const MDNode *> &Requirements) {
1540   // Each module flag should have three arguments, the merge behavior (a
1541   // constant int), the flag ID (an MDString), and the value.
1542   Assert(Op->getNumOperands() == 3,
1543          "incorrect number of operands in module flag", Op);
1544   Module::ModFlagBehavior MFB;
1545   if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1546     Assert(
1547         mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1548         "invalid behavior operand in module flag (expected constant integer)",
1549         Op->getOperand(0));
1550     Assert(false,
1551            "invalid behavior operand in module flag (unexpected constant)",
1552            Op->getOperand(0));
1553   }
1554   MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1555   Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1556          Op->getOperand(1));
1557 
1558   // Sanity check the values for behaviors with additional requirements.
1559   switch (MFB) {
1560   case Module::Error:
1561   case Module::Warning:
1562   case Module::Override:
1563     // These behavior types accept any value.
1564     break;
1565 
1566   case Module::Max: {
1567     Assert(mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)),
1568            "invalid value for 'max' module flag (expected constant integer)",
1569            Op->getOperand(2));
1570     break;
1571   }
1572 
1573   case Module::Require: {
1574     // The value should itself be an MDNode with two operands, a flag ID (an
1575     // MDString), and a value.
1576     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1577     Assert(Value && Value->getNumOperands() == 2,
1578            "invalid value for 'require' module flag (expected metadata pair)",
1579            Op->getOperand(2));
1580     Assert(isa<MDString>(Value->getOperand(0)),
1581            ("invalid value for 'require' module flag "
1582             "(first value operand should be a string)"),
1583            Value->getOperand(0));
1584 
1585     // Append it to the list of requirements, to check once all module flags are
1586     // scanned.
1587     Requirements.push_back(Value);
1588     break;
1589   }
1590 
1591   case Module::Append:
1592   case Module::AppendUnique: {
1593     // These behavior types require the operand be an MDNode.
1594     Assert(isa<MDNode>(Op->getOperand(2)),
1595            "invalid value for 'append'-type module flag "
1596            "(expected a metadata node)",
1597            Op->getOperand(2));
1598     break;
1599   }
1600   }
1601 
1602   // Unless this is a "requires" flag, check the ID is unique.
1603   if (MFB != Module::Require) {
1604     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1605     Assert(Inserted,
1606            "module flag identifiers must be unique (or of 'require' type)", ID);
1607   }
1608 
1609   if (ID->getString() == "wchar_size") {
1610     ConstantInt *Value
1611       = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
1612     Assert(Value, "wchar_size metadata requires constant integer argument");
1613   }
1614 
1615   if (ID->getString() == "Linker Options") {
1616     // If the llvm.linker.options named metadata exists, we assume that the
1617     // bitcode reader has upgraded the module flag. Otherwise the flag might
1618     // have been created by a client directly.
1619     Assert(M.getNamedMetadata("llvm.linker.options"),
1620            "'Linker Options' named metadata no longer supported");
1621   }
1622 
1623   if (ID->getString() == "SemanticInterposition") {
1624     ConstantInt *Value =
1625         mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
1626     Assert(Value,
1627            "SemanticInterposition metadata requires constant integer argument");
1628   }
1629 
1630   if (ID->getString() == "CG Profile") {
1631     for (const MDOperand &MDO : cast<MDNode>(Op->getOperand(2))->operands())
1632       visitModuleFlagCGProfileEntry(MDO);
1633   }
1634 }
1635 
1636 void Verifier::visitModuleFlagCGProfileEntry(const MDOperand &MDO) {
1637   auto CheckFunction = [&](const MDOperand &FuncMDO) {
1638     if (!FuncMDO)
1639       return;
1640     auto F = dyn_cast<ValueAsMetadata>(FuncMDO);
1641     Assert(F && isa<Function>(F->getValue()->stripPointerCasts()),
1642            "expected a Function or null", FuncMDO);
1643   };
1644   auto Node = dyn_cast_or_null<MDNode>(MDO);
1645   Assert(Node && Node->getNumOperands() == 3, "expected a MDNode triple", MDO);
1646   CheckFunction(Node->getOperand(0));
1647   CheckFunction(Node->getOperand(1));
1648   auto Count = dyn_cast_or_null<ConstantAsMetadata>(Node->getOperand(2));
1649   Assert(Count && Count->getType()->isIntegerTy(),
1650          "expected an integer constant", Node->getOperand(2));
1651 }
1652 
1653 /// Return true if this attribute kind only applies to functions.
1654 static bool isFuncOnlyAttr(Attribute::AttrKind Kind) {
1655   switch (Kind) {
1656   case Attribute::NoMerge:
1657   case Attribute::NoReturn:
1658   case Attribute::NoSync:
1659   case Attribute::WillReturn:
1660   case Attribute::NoCallback:
1661   case Attribute::NoCfCheck:
1662   case Attribute::NoUnwind:
1663   case Attribute::NoInline:
1664   case Attribute::AlwaysInline:
1665   case Attribute::OptimizeForSize:
1666   case Attribute::StackProtect:
1667   case Attribute::StackProtectReq:
1668   case Attribute::StackProtectStrong:
1669   case Attribute::SafeStack:
1670   case Attribute::ShadowCallStack:
1671   case Attribute::NoRedZone:
1672   case Attribute::NoImplicitFloat:
1673   case Attribute::Naked:
1674   case Attribute::InlineHint:
1675   case Attribute::UWTable:
1676   case Attribute::VScaleRange:
1677   case Attribute::NonLazyBind:
1678   case Attribute::ReturnsTwice:
1679   case Attribute::SanitizeAddress:
1680   case Attribute::SanitizeHWAddress:
1681   case Attribute::SanitizeMemTag:
1682   case Attribute::SanitizeThread:
1683   case Attribute::SanitizeMemory:
1684   case Attribute::MinSize:
1685   case Attribute::NoDuplicate:
1686   case Attribute::Builtin:
1687   case Attribute::NoBuiltin:
1688   case Attribute::Cold:
1689   case Attribute::Hot:
1690   case Attribute::OptForFuzzing:
1691   case Attribute::OptimizeNone:
1692   case Attribute::JumpTable:
1693   case Attribute::Convergent:
1694   case Attribute::ArgMemOnly:
1695   case Attribute::NoRecurse:
1696   case Attribute::InaccessibleMemOnly:
1697   case Attribute::InaccessibleMemOrArgMemOnly:
1698   case Attribute::AllocSize:
1699   case Attribute::SpeculativeLoadHardening:
1700   case Attribute::Speculatable:
1701   case Attribute::StrictFP:
1702   case Attribute::NullPointerIsValid:
1703   case Attribute::MustProgress:
1704   case Attribute::NoProfile:
1705     return true;
1706   default:
1707     break;
1708   }
1709   return false;
1710 }
1711 
1712 /// Return true if this is a function attribute that can also appear on
1713 /// arguments.
1714 static bool isFuncOrArgAttr(Attribute::AttrKind Kind) {
1715   return Kind == Attribute::ReadOnly || Kind == Attribute::WriteOnly ||
1716          Kind == Attribute::ReadNone || Kind == Attribute::NoFree ||
1717          Kind == Attribute::Preallocated || Kind == Attribute::StackAlignment;
1718 }
1719 
1720 void Verifier::verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
1721                                     const Value *V) {
1722   for (Attribute A : Attrs) {
1723 
1724     if (A.isStringAttribute()) {
1725 #define GET_ATTR_NAMES
1726 #define ATTRIBUTE_ENUM(ENUM_NAME, DISPLAY_NAME)
1727 #define ATTRIBUTE_STRBOOL(ENUM_NAME, DISPLAY_NAME)                             \
1728   if (A.getKindAsString() == #DISPLAY_NAME) {                                  \
1729     auto V = A.getValueAsString();                                             \
1730     if (!(V.empty() || V == "true" || V == "false"))                           \
1731       CheckFailed("invalid value for '" #DISPLAY_NAME "' attribute: " + V +    \
1732                   "");                                                         \
1733   }
1734 
1735 #include "llvm/IR/Attributes.inc"
1736       continue;
1737     }
1738 
1739     if (A.isIntAttribute() !=
1740         Attribute::doesAttrKindHaveArgument(A.getKindAsEnum())) {
1741       CheckFailed("Attribute '" + A.getAsString() + "' should have an Argument",
1742                   V);
1743       return;
1744     }
1745 
1746     if (isFuncOnlyAttr(A.getKindAsEnum())) {
1747       if (!IsFunction) {
1748         CheckFailed("Attribute '" + A.getAsString() +
1749                         "' only applies to functions!",
1750                     V);
1751         return;
1752       }
1753     } else if (IsFunction && !isFuncOrArgAttr(A.getKindAsEnum())) {
1754       CheckFailed("Attribute '" + A.getAsString() +
1755                       "' does not apply to functions!",
1756                   V);
1757       return;
1758     }
1759   }
1760 }
1761 
1762 // VerifyParameterAttrs - Check the given attributes for an argument or return
1763 // value of the specified type.  The value V is printed in error messages.
1764 void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
1765                                     const Value *V) {
1766   if (!Attrs.hasAttributes())
1767     return;
1768 
1769   verifyAttributeTypes(Attrs, /*IsFunction=*/false, V);
1770 
1771   if (Attrs.hasAttribute(Attribute::ImmArg)) {
1772     Assert(Attrs.getNumAttributes() == 1,
1773            "Attribute 'immarg' is incompatible with other attributes", V);
1774   }
1775 
1776   // Check for mutually incompatible attributes.  Only inreg is compatible with
1777   // sret.
1778   unsigned AttrCount = 0;
1779   AttrCount += Attrs.hasAttribute(Attribute::ByVal);
1780   AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
1781   AttrCount += Attrs.hasAttribute(Attribute::Preallocated);
1782   AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
1783                Attrs.hasAttribute(Attribute::InReg);
1784   AttrCount += Attrs.hasAttribute(Attribute::Nest);
1785   AttrCount += Attrs.hasAttribute(Attribute::ByRef);
1786   Assert(AttrCount <= 1,
1787          "Attributes 'byval', 'inalloca', 'preallocated', 'inreg', 'nest', "
1788          "'byref', and 'sret' are incompatible!",
1789          V);
1790 
1791   Assert(!(Attrs.hasAttribute(Attribute::InAlloca) &&
1792            Attrs.hasAttribute(Attribute::ReadOnly)),
1793          "Attributes "
1794          "'inalloca and readonly' are incompatible!",
1795          V);
1796 
1797   Assert(!(Attrs.hasAttribute(Attribute::StructRet) &&
1798            Attrs.hasAttribute(Attribute::Returned)),
1799          "Attributes "
1800          "'sret and returned' are incompatible!",
1801          V);
1802 
1803   Assert(!(Attrs.hasAttribute(Attribute::ZExt) &&
1804            Attrs.hasAttribute(Attribute::SExt)),
1805          "Attributes "
1806          "'zeroext and signext' are incompatible!",
1807          V);
1808 
1809   Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1810            Attrs.hasAttribute(Attribute::ReadOnly)),
1811          "Attributes "
1812          "'readnone and readonly' are incompatible!",
1813          V);
1814 
1815   Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1816            Attrs.hasAttribute(Attribute::WriteOnly)),
1817          "Attributes "
1818          "'readnone and writeonly' are incompatible!",
1819          V);
1820 
1821   Assert(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
1822            Attrs.hasAttribute(Attribute::WriteOnly)),
1823          "Attributes "
1824          "'readonly and writeonly' are incompatible!",
1825          V);
1826 
1827   Assert(!(Attrs.hasAttribute(Attribute::NoInline) &&
1828            Attrs.hasAttribute(Attribute::AlwaysInline)),
1829          "Attributes "
1830          "'noinline and alwaysinline' are incompatible!",
1831          V);
1832 
1833   AttrBuilder IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty);
1834   Assert(!AttrBuilder(Attrs).overlaps(IncompatibleAttrs),
1835          "Wrong types for attribute: " +
1836              AttributeSet::get(Context, IncompatibleAttrs).getAsString(),
1837          V);
1838 
1839   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1840     SmallPtrSet<Type*, 4> Visited;
1841     if (!PTy->getElementType()->isSized(&Visited)) {
1842       Assert(!Attrs.hasAttribute(Attribute::ByVal) &&
1843              !Attrs.hasAttribute(Attribute::ByRef) &&
1844              !Attrs.hasAttribute(Attribute::InAlloca) &&
1845              !Attrs.hasAttribute(Attribute::Preallocated),
1846              "Attributes 'byval', 'byref', 'inalloca', and 'preallocated' do not "
1847              "support unsized types!",
1848              V);
1849     }
1850     if (!isa<PointerType>(PTy->getElementType()))
1851       Assert(!Attrs.hasAttribute(Attribute::SwiftError),
1852              "Attribute 'swifterror' only applies to parameters "
1853              "with pointer to pointer type!",
1854              V);
1855 
1856     if (Attrs.hasAttribute(Attribute::ByRef)) {
1857       Assert(Attrs.getByRefType() == PTy->getElementType(),
1858              "Attribute 'byref' type does not match parameter!", V);
1859     }
1860 
1861     if (Attrs.hasAttribute(Attribute::ByVal) && Attrs.getByValType()) {
1862       Assert(Attrs.getByValType() == PTy->getElementType(),
1863              "Attribute 'byval' type does not match parameter!", V);
1864     }
1865 
1866     if (Attrs.hasAttribute(Attribute::Preallocated)) {
1867       Assert(Attrs.getPreallocatedType() == PTy->getElementType(),
1868              "Attribute 'preallocated' type does not match parameter!", V);
1869     }
1870 
1871     if (Attrs.hasAttribute(Attribute::InAlloca)) {
1872       Assert(Attrs.getInAllocaType() == PTy->getElementType(),
1873              "Attribute 'inalloca' type does not match parameter!", V);
1874     }
1875   } else {
1876     Assert(!Attrs.hasAttribute(Attribute::ByVal),
1877            "Attribute 'byval' only applies to parameters with pointer type!",
1878            V);
1879     Assert(!Attrs.hasAttribute(Attribute::ByRef),
1880            "Attribute 'byref' only applies to parameters with pointer type!",
1881            V);
1882     Assert(!Attrs.hasAttribute(Attribute::SwiftError),
1883            "Attribute 'swifterror' only applies to parameters "
1884            "with pointer type!",
1885            V);
1886   }
1887 }
1888 
1889 // Check parameter attributes against a function type.
1890 // The value V is printed in error messages.
1891 void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
1892                                    const Value *V, bool IsIntrinsic) {
1893   if (Attrs.isEmpty())
1894     return;
1895 
1896   if (AttributeListsVisited.insert(Attrs.getRawPointer()).second) {
1897     Assert(Attrs.hasParentContext(Context),
1898            "Attribute list does not match Module context!", &Attrs, V);
1899     for (const auto &AttrSet : Attrs) {
1900       Assert(!AttrSet.hasAttributes() || AttrSet.hasParentContext(Context),
1901              "Attribute set does not match Module context!", &AttrSet, V);
1902       for (const auto &A : AttrSet) {
1903         Assert(A.hasParentContext(Context),
1904                "Attribute does not match Module context!", &A, V);
1905       }
1906     }
1907   }
1908 
1909   bool SawNest = false;
1910   bool SawReturned = false;
1911   bool SawSRet = false;
1912   bool SawSwiftSelf = false;
1913   bool SawSwiftError = false;
1914 
1915   // Verify return value attributes.
1916   AttributeSet RetAttrs = Attrs.getRetAttributes();
1917   Assert((!RetAttrs.hasAttribute(Attribute::ByVal) &&
1918           !RetAttrs.hasAttribute(Attribute::Nest) &&
1919           !RetAttrs.hasAttribute(Attribute::StructRet) &&
1920           !RetAttrs.hasAttribute(Attribute::NoCapture) &&
1921           !RetAttrs.hasAttribute(Attribute::NoFree) &&
1922           !RetAttrs.hasAttribute(Attribute::Returned) &&
1923           !RetAttrs.hasAttribute(Attribute::InAlloca) &&
1924           !RetAttrs.hasAttribute(Attribute::Preallocated) &&
1925           !RetAttrs.hasAttribute(Attribute::ByRef) &&
1926           !RetAttrs.hasAttribute(Attribute::SwiftSelf) &&
1927           !RetAttrs.hasAttribute(Attribute::SwiftError)),
1928          "Attributes 'byval', 'inalloca', 'preallocated', 'byref', "
1929          "'nest', 'sret', 'nocapture', 'nofree', "
1930          "'returned', 'swiftself', and 'swifterror' do not apply to return "
1931          "values!",
1932          V);
1933   Assert((!RetAttrs.hasAttribute(Attribute::ReadOnly) &&
1934           !RetAttrs.hasAttribute(Attribute::WriteOnly) &&
1935           !RetAttrs.hasAttribute(Attribute::ReadNone)),
1936          "Attribute '" + RetAttrs.getAsString() +
1937              "' does not apply to function returns",
1938          V);
1939   verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
1940 
1941   // Verify parameter attributes.
1942   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1943     Type *Ty = FT->getParamType(i);
1944     AttributeSet ArgAttrs = Attrs.getParamAttributes(i);
1945 
1946     if (!IsIntrinsic) {
1947       Assert(!ArgAttrs.hasAttribute(Attribute::ImmArg),
1948              "immarg attribute only applies to intrinsics",V);
1949     }
1950 
1951     verifyParameterAttrs(ArgAttrs, Ty, V);
1952 
1953     if (ArgAttrs.hasAttribute(Attribute::Nest)) {
1954       Assert(!SawNest, "More than one parameter has attribute nest!", V);
1955       SawNest = true;
1956     }
1957 
1958     if (ArgAttrs.hasAttribute(Attribute::Returned)) {
1959       Assert(!SawReturned, "More than one parameter has attribute returned!",
1960              V);
1961       Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1962              "Incompatible argument and return types for 'returned' attribute",
1963              V);
1964       SawReturned = true;
1965     }
1966 
1967     if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
1968       Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1969       Assert(i == 0 || i == 1,
1970              "Attribute 'sret' is not on first or second parameter!", V);
1971       SawSRet = true;
1972     }
1973 
1974     if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
1975       Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1976       SawSwiftSelf = true;
1977     }
1978 
1979     if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
1980       Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1981              V);
1982       SawSwiftError = true;
1983     }
1984 
1985     if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
1986       Assert(i == FT->getNumParams() - 1,
1987              "inalloca isn't on the last parameter!", V);
1988     }
1989   }
1990 
1991   if (!Attrs.hasAttributes(AttributeList::FunctionIndex))
1992     return;
1993 
1994   verifyAttributeTypes(Attrs.getFnAttributes(), /*IsFunction=*/true, V);
1995 
1996   Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1997            Attrs.hasFnAttribute(Attribute::ReadOnly)),
1998          "Attributes 'readnone and readonly' are incompatible!", V);
1999 
2000   Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
2001            Attrs.hasFnAttribute(Attribute::WriteOnly)),
2002          "Attributes 'readnone and writeonly' are incompatible!", V);
2003 
2004   Assert(!(Attrs.hasFnAttribute(Attribute::ReadOnly) &&
2005            Attrs.hasFnAttribute(Attribute::WriteOnly)),
2006          "Attributes 'readonly and writeonly' are incompatible!", V);
2007 
2008   Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
2009            Attrs.hasFnAttribute(Attribute::InaccessibleMemOrArgMemOnly)),
2010          "Attributes 'readnone and inaccessiblemem_or_argmemonly' are "
2011          "incompatible!",
2012          V);
2013 
2014   Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
2015            Attrs.hasFnAttribute(Attribute::InaccessibleMemOnly)),
2016          "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
2017 
2018   Assert(!(Attrs.hasFnAttribute(Attribute::NoInline) &&
2019            Attrs.hasFnAttribute(Attribute::AlwaysInline)),
2020          "Attributes 'noinline and alwaysinline' are incompatible!", V);
2021 
2022   if (Attrs.hasFnAttribute(Attribute::OptimizeNone)) {
2023     Assert(Attrs.hasFnAttribute(Attribute::NoInline),
2024            "Attribute 'optnone' requires 'noinline'!", V);
2025 
2026     Assert(!Attrs.hasFnAttribute(Attribute::OptimizeForSize),
2027            "Attributes 'optsize and optnone' are incompatible!", V);
2028 
2029     Assert(!Attrs.hasFnAttribute(Attribute::MinSize),
2030            "Attributes 'minsize and optnone' are incompatible!", V);
2031   }
2032 
2033   if (Attrs.hasFnAttribute(Attribute::JumpTable)) {
2034     const GlobalValue *GV = cast<GlobalValue>(V);
2035     Assert(GV->hasGlobalUnnamedAddr(),
2036            "Attribute 'jumptable' requires 'unnamed_addr'", V);
2037   }
2038 
2039   if (Attrs.hasFnAttribute(Attribute::AllocSize)) {
2040     std::pair<unsigned, Optional<unsigned>> Args =
2041         Attrs.getAllocSizeArgs(AttributeList::FunctionIndex);
2042 
2043     auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
2044       if (ParamNo >= FT->getNumParams()) {
2045         CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
2046         return false;
2047       }
2048 
2049       if (!FT->getParamType(ParamNo)->isIntegerTy()) {
2050         CheckFailed("'allocsize' " + Name +
2051                         " argument must refer to an integer parameter",
2052                     V);
2053         return false;
2054       }
2055 
2056       return true;
2057     };
2058 
2059     if (!CheckParam("element size", Args.first))
2060       return;
2061 
2062     if (Args.second && !CheckParam("number of elements", *Args.second))
2063       return;
2064   }
2065 
2066   if (Attrs.hasFnAttribute(Attribute::VScaleRange)) {
2067     std::pair<unsigned, unsigned> Args =
2068         Attrs.getVScaleRangeArgs(AttributeList::FunctionIndex);
2069 
2070     if (Args.first > Args.second && Args.second != 0)
2071       CheckFailed("'vscale_range' minimum cannot be greater than maximum", V);
2072   }
2073 
2074   if (Attrs.hasFnAttribute("frame-pointer")) {
2075     StringRef FP = Attrs.getAttribute(AttributeList::FunctionIndex,
2076                                       "frame-pointer").getValueAsString();
2077     if (FP != "all" && FP != "non-leaf" && FP != "none")
2078       CheckFailed("invalid value for 'frame-pointer' attribute: " + FP, V);
2079   }
2080 
2081   if (Attrs.hasFnAttribute("patchable-function-prefix")) {
2082     StringRef S = Attrs
2083                       .getAttribute(AttributeList::FunctionIndex,
2084                                     "patchable-function-prefix")
2085                       .getValueAsString();
2086     unsigned N;
2087     if (S.getAsInteger(10, N))
2088       CheckFailed(
2089           "\"patchable-function-prefix\" takes an unsigned integer: " + S, V);
2090   }
2091   if (Attrs.hasFnAttribute("patchable-function-entry")) {
2092     StringRef S = Attrs
2093                       .getAttribute(AttributeList::FunctionIndex,
2094                                     "patchable-function-entry")
2095                       .getValueAsString();
2096     unsigned N;
2097     if (S.getAsInteger(10, N))
2098       CheckFailed(
2099           "\"patchable-function-entry\" takes an unsigned integer: " + S, V);
2100   }
2101 }
2102 
2103 void Verifier::verifyFunctionMetadata(
2104     ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
2105   for (const auto &Pair : MDs) {
2106     if (Pair.first == LLVMContext::MD_prof) {
2107       MDNode *MD = Pair.second;
2108       Assert(MD->getNumOperands() >= 2,
2109              "!prof annotations should have no less than 2 operands", MD);
2110 
2111       // Check first operand.
2112       Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
2113              MD);
2114       Assert(isa<MDString>(MD->getOperand(0)),
2115              "expected string with name of the !prof annotation", MD);
2116       MDString *MDS = cast<MDString>(MD->getOperand(0));
2117       StringRef ProfName = MDS->getString();
2118       Assert(ProfName.equals("function_entry_count") ||
2119                  ProfName.equals("synthetic_function_entry_count"),
2120              "first operand should be 'function_entry_count'"
2121              " or 'synthetic_function_entry_count'",
2122              MD);
2123 
2124       // Check second operand.
2125       Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
2126              MD);
2127       Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
2128              "expected integer argument to function_entry_count", MD);
2129     }
2130   }
2131 }
2132 
2133 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
2134   if (!ConstantExprVisited.insert(EntryC).second)
2135     return;
2136 
2137   SmallVector<const Constant *, 16> Stack;
2138   Stack.push_back(EntryC);
2139 
2140   while (!Stack.empty()) {
2141     const Constant *C = Stack.pop_back_val();
2142 
2143     // Check this constant expression.
2144     if (const auto *CE = dyn_cast<ConstantExpr>(C))
2145       visitConstantExpr(CE);
2146 
2147     if (const auto *GV = dyn_cast<GlobalValue>(C)) {
2148       // Global Values get visited separately, but we do need to make sure
2149       // that the global value is in the correct module
2150       Assert(GV->getParent() == &M, "Referencing global in another module!",
2151              EntryC, &M, GV, GV->getParent());
2152       continue;
2153     }
2154 
2155     // Visit all sub-expressions.
2156     for (const Use &U : C->operands()) {
2157       const auto *OpC = dyn_cast<Constant>(U);
2158       if (!OpC)
2159         continue;
2160       if (!ConstantExprVisited.insert(OpC).second)
2161         continue;
2162       Stack.push_back(OpC);
2163     }
2164   }
2165 }
2166 
2167 void Verifier::visitConstantExpr(const ConstantExpr *CE) {
2168   if (CE->getOpcode() == Instruction::BitCast)
2169     Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
2170                                  CE->getType()),
2171            "Invalid bitcast", CE);
2172 
2173   if (CE->getOpcode() == Instruction::IntToPtr ||
2174       CE->getOpcode() == Instruction::PtrToInt) {
2175     auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
2176                       ? CE->getType()
2177                       : CE->getOperand(0)->getType();
2178     StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
2179                         ? "inttoptr not supported for non-integral pointers"
2180                         : "ptrtoint not supported for non-integral pointers";
2181     Assert(
2182         !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
2183         Msg);
2184   }
2185 }
2186 
2187 bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
2188   // There shouldn't be more attribute sets than there are parameters plus the
2189   // function and return value.
2190   return Attrs.getNumAttrSets() <= Params + 2;
2191 }
2192 
2193 /// Verify that statepoint intrinsic is well formed.
2194 void Verifier::verifyStatepoint(const CallBase &Call) {
2195   assert(Call.getCalledFunction() &&
2196          Call.getCalledFunction()->getIntrinsicID() ==
2197              Intrinsic::experimental_gc_statepoint);
2198 
2199   Assert(!Call.doesNotAccessMemory() && !Call.onlyReadsMemory() &&
2200              !Call.onlyAccessesArgMemory(),
2201          "gc.statepoint must read and write all memory to preserve "
2202          "reordering restrictions required by safepoint semantics",
2203          Call);
2204 
2205   const int64_t NumPatchBytes =
2206       cast<ConstantInt>(Call.getArgOperand(1))->getSExtValue();
2207   assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
2208   Assert(NumPatchBytes >= 0,
2209          "gc.statepoint number of patchable bytes must be "
2210          "positive",
2211          Call);
2212 
2213   const Value *Target = Call.getArgOperand(2);
2214   auto *PT = dyn_cast<PointerType>(Target->getType());
2215   Assert(PT && PT->getElementType()->isFunctionTy(),
2216          "gc.statepoint callee must be of function pointer type", Call, Target);
2217   FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
2218 
2219   const int NumCallArgs = cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue();
2220   Assert(NumCallArgs >= 0,
2221          "gc.statepoint number of arguments to underlying call "
2222          "must be positive",
2223          Call);
2224   const int NumParams = (int)TargetFuncType->getNumParams();
2225   if (TargetFuncType->isVarArg()) {
2226     Assert(NumCallArgs >= NumParams,
2227            "gc.statepoint mismatch in number of vararg call args", Call);
2228 
2229     // TODO: Remove this limitation
2230     Assert(TargetFuncType->getReturnType()->isVoidTy(),
2231            "gc.statepoint doesn't support wrapping non-void "
2232            "vararg functions yet",
2233            Call);
2234   } else
2235     Assert(NumCallArgs == NumParams,
2236            "gc.statepoint mismatch in number of call args", Call);
2237 
2238   const uint64_t Flags
2239     = cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue();
2240   Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
2241          "unknown flag used in gc.statepoint flags argument", Call);
2242 
2243   // Verify that the types of the call parameter arguments match
2244   // the type of the wrapped callee.
2245   AttributeList Attrs = Call.getAttributes();
2246   for (int i = 0; i < NumParams; i++) {
2247     Type *ParamType = TargetFuncType->getParamType(i);
2248     Type *ArgType = Call.getArgOperand(5 + i)->getType();
2249     Assert(ArgType == ParamType,
2250            "gc.statepoint call argument does not match wrapped "
2251            "function type",
2252            Call);
2253 
2254     if (TargetFuncType->isVarArg()) {
2255       AttributeSet ArgAttrs = Attrs.getParamAttributes(5 + i);
2256       Assert(!ArgAttrs.hasAttribute(Attribute::StructRet),
2257              "Attribute 'sret' cannot be used for vararg call arguments!",
2258              Call);
2259     }
2260   }
2261 
2262   const int EndCallArgsInx = 4 + NumCallArgs;
2263 
2264   const Value *NumTransitionArgsV = Call.getArgOperand(EndCallArgsInx + 1);
2265   Assert(isa<ConstantInt>(NumTransitionArgsV),
2266          "gc.statepoint number of transition arguments "
2267          "must be constant integer",
2268          Call);
2269   const int NumTransitionArgs =
2270       cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
2271   Assert(NumTransitionArgs == 0,
2272          "gc.statepoint w/inline transition bundle is deprecated", Call);
2273   const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
2274 
2275   const Value *NumDeoptArgsV = Call.getArgOperand(EndTransitionArgsInx + 1);
2276   Assert(isa<ConstantInt>(NumDeoptArgsV),
2277          "gc.statepoint number of deoptimization arguments "
2278          "must be constant integer",
2279          Call);
2280   const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
2281   Assert(NumDeoptArgs == 0,
2282          "gc.statepoint w/inline deopt operands is deprecated", Call);
2283 
2284   const int ExpectedNumArgs = 7 + NumCallArgs;
2285   Assert(ExpectedNumArgs == (int)Call.arg_size(),
2286          "gc.statepoint too many arguments", Call);
2287 
2288   // Check that the only uses of this gc.statepoint are gc.result or
2289   // gc.relocate calls which are tied to this statepoint and thus part
2290   // of the same statepoint sequence
2291   for (const User *U : Call.users()) {
2292     const CallInst *UserCall = dyn_cast<const CallInst>(U);
2293     Assert(UserCall, "illegal use of statepoint token", Call, U);
2294     if (!UserCall)
2295       continue;
2296     Assert(isa<GCRelocateInst>(UserCall) || isa<GCResultInst>(UserCall),
2297            "gc.result or gc.relocate are the only value uses "
2298            "of a gc.statepoint",
2299            Call, U);
2300     if (isa<GCResultInst>(UserCall)) {
2301       Assert(UserCall->getArgOperand(0) == &Call,
2302              "gc.result connected to wrong gc.statepoint", Call, UserCall);
2303     } else if (isa<GCRelocateInst>(Call)) {
2304       Assert(UserCall->getArgOperand(0) == &Call,
2305              "gc.relocate connected to wrong gc.statepoint", Call, UserCall);
2306     }
2307   }
2308 
2309   // Note: It is legal for a single derived pointer to be listed multiple
2310   // times.  It's non-optimal, but it is legal.  It can also happen after
2311   // insertion if we strip a bitcast away.
2312   // Note: It is really tempting to check that each base is relocated and
2313   // that a derived pointer is never reused as a base pointer.  This turns
2314   // out to be problematic since optimizations run after safepoint insertion
2315   // can recognize equality properties that the insertion logic doesn't know
2316   // about.  See example statepoint.ll in the verifier subdirectory
2317 }
2318 
2319 void Verifier::verifyFrameRecoverIndices() {
2320   for (auto &Counts : FrameEscapeInfo) {
2321     Function *F = Counts.first;
2322     unsigned EscapedObjectCount = Counts.second.first;
2323     unsigned MaxRecoveredIndex = Counts.second.second;
2324     Assert(MaxRecoveredIndex <= EscapedObjectCount,
2325            "all indices passed to llvm.localrecover must be less than the "
2326            "number of arguments passed to llvm.localescape in the parent "
2327            "function",
2328            F);
2329   }
2330 }
2331 
2332 static Instruction *getSuccPad(Instruction *Terminator) {
2333   BasicBlock *UnwindDest;
2334   if (auto *II = dyn_cast<InvokeInst>(Terminator))
2335     UnwindDest = II->getUnwindDest();
2336   else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
2337     UnwindDest = CSI->getUnwindDest();
2338   else
2339     UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
2340   return UnwindDest->getFirstNonPHI();
2341 }
2342 
2343 void Verifier::verifySiblingFuncletUnwinds() {
2344   SmallPtrSet<Instruction *, 8> Visited;
2345   SmallPtrSet<Instruction *, 8> Active;
2346   for (const auto &Pair : SiblingFuncletInfo) {
2347     Instruction *PredPad = Pair.first;
2348     if (Visited.count(PredPad))
2349       continue;
2350     Active.insert(PredPad);
2351     Instruction *Terminator = Pair.second;
2352     do {
2353       Instruction *SuccPad = getSuccPad(Terminator);
2354       if (Active.count(SuccPad)) {
2355         // Found a cycle; report error
2356         Instruction *CyclePad = SuccPad;
2357         SmallVector<Instruction *, 8> CycleNodes;
2358         do {
2359           CycleNodes.push_back(CyclePad);
2360           Instruction *CycleTerminator = SiblingFuncletInfo[CyclePad];
2361           if (CycleTerminator != CyclePad)
2362             CycleNodes.push_back(CycleTerminator);
2363           CyclePad = getSuccPad(CycleTerminator);
2364         } while (CyclePad != SuccPad);
2365         Assert(false, "EH pads can't handle each other's exceptions",
2366                ArrayRef<Instruction *>(CycleNodes));
2367       }
2368       // Don't re-walk a node we've already checked
2369       if (!Visited.insert(SuccPad).second)
2370         break;
2371       // Walk to this successor if it has a map entry.
2372       PredPad = SuccPad;
2373       auto TermI = SiblingFuncletInfo.find(PredPad);
2374       if (TermI == SiblingFuncletInfo.end())
2375         break;
2376       Terminator = TermI->second;
2377       Active.insert(PredPad);
2378     } while (true);
2379     // Each node only has one successor, so we've walked all the active
2380     // nodes' successors.
2381     Active.clear();
2382   }
2383 }
2384 
2385 // visitFunction - Verify that a function is ok.
2386 //
2387 void Verifier::visitFunction(const Function &F) {
2388   visitGlobalValue(F);
2389 
2390   // Check function arguments.
2391   FunctionType *FT = F.getFunctionType();
2392   unsigned NumArgs = F.arg_size();
2393 
2394   Assert(&Context == &F.getContext(),
2395          "Function context does not match Module context!", &F);
2396 
2397   Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
2398   Assert(FT->getNumParams() == NumArgs,
2399          "# formal arguments must match # of arguments for function type!", &F,
2400          FT);
2401   Assert(F.getReturnType()->isFirstClassType() ||
2402              F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
2403          "Functions cannot return aggregate values!", &F);
2404 
2405   Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
2406          "Invalid struct return type!", &F);
2407 
2408   AttributeList Attrs = F.getAttributes();
2409 
2410   Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
2411          "Attribute after last parameter!", &F);
2412 
2413   bool isLLVMdotName = F.getName().size() >= 5 &&
2414                        F.getName().substr(0, 5) == "llvm.";
2415 
2416   // Check function attributes.
2417   verifyFunctionAttrs(FT, Attrs, &F, isLLVMdotName);
2418 
2419   // On function declarations/definitions, we do not support the builtin
2420   // attribute. We do not check this in VerifyFunctionAttrs since that is
2421   // checking for Attributes that can/can not ever be on functions.
2422   Assert(!Attrs.hasFnAttribute(Attribute::Builtin),
2423          "Attribute 'builtin' can only be applied to a callsite.", &F);
2424 
2425   // Check that this function meets the restrictions on this calling convention.
2426   // Sometimes varargs is used for perfectly forwarding thunks, so some of these
2427   // restrictions can be lifted.
2428   switch (F.getCallingConv()) {
2429   default:
2430   case CallingConv::C:
2431     break;
2432   case CallingConv::X86_INTR: {
2433     Assert(F.arg_empty() || Attrs.hasParamAttribute(0, Attribute::ByVal),
2434            "Calling convention parameter requires byval", &F);
2435     break;
2436   }
2437   case CallingConv::AMDGPU_KERNEL:
2438   case CallingConv::SPIR_KERNEL:
2439     Assert(F.getReturnType()->isVoidTy(),
2440            "Calling convention requires void return type", &F);
2441     LLVM_FALLTHROUGH;
2442   case CallingConv::AMDGPU_VS:
2443   case CallingConv::AMDGPU_HS:
2444   case CallingConv::AMDGPU_GS:
2445   case CallingConv::AMDGPU_PS:
2446   case CallingConv::AMDGPU_CS:
2447     Assert(!F.hasStructRetAttr(),
2448            "Calling convention does not allow sret", &F);
2449     if (F.getCallingConv() != CallingConv::SPIR_KERNEL) {
2450       const unsigned StackAS = DL.getAllocaAddrSpace();
2451       unsigned i = 0;
2452       for (const Argument &Arg : F.args()) {
2453         Assert(!Attrs.hasParamAttribute(i, Attribute::ByVal),
2454                "Calling convention disallows byval", &F);
2455         Assert(!Attrs.hasParamAttribute(i, Attribute::Preallocated),
2456                "Calling convention disallows preallocated", &F);
2457         Assert(!Attrs.hasParamAttribute(i, Attribute::InAlloca),
2458                "Calling convention disallows inalloca", &F);
2459 
2460         if (Attrs.hasParamAttribute(i, Attribute::ByRef)) {
2461           // FIXME: Should also disallow LDS and GDS, but we don't have the enum
2462           // value here.
2463           Assert(Arg.getType()->getPointerAddressSpace() != StackAS,
2464                  "Calling convention disallows stack byref", &F);
2465         }
2466 
2467         ++i;
2468       }
2469     }
2470 
2471     LLVM_FALLTHROUGH;
2472   case CallingConv::Fast:
2473   case CallingConv::Cold:
2474   case CallingConv::Intel_OCL_BI:
2475   case CallingConv::PTX_Kernel:
2476   case CallingConv::PTX_Device:
2477     Assert(!F.isVarArg(), "Calling convention does not support varargs or "
2478                           "perfect forwarding!",
2479            &F);
2480     break;
2481   }
2482 
2483   // Check that the argument values match the function type for this function...
2484   unsigned i = 0;
2485   for (const Argument &Arg : F.args()) {
2486     Assert(Arg.getType() == FT->getParamType(i),
2487            "Argument value does not match function argument type!", &Arg,
2488            FT->getParamType(i));
2489     Assert(Arg.getType()->isFirstClassType(),
2490            "Function arguments must have first-class types!", &Arg);
2491     if (!isLLVMdotName) {
2492       Assert(!Arg.getType()->isMetadataTy(),
2493              "Function takes metadata but isn't an intrinsic", &Arg, &F);
2494       Assert(!Arg.getType()->isTokenTy(),
2495              "Function takes token but isn't an intrinsic", &Arg, &F);
2496       Assert(!Arg.getType()->isX86_AMXTy(),
2497              "Function takes x86_amx but isn't an intrinsic", &Arg, &F);
2498     }
2499 
2500     // Check that swifterror argument is only used by loads and stores.
2501     if (Attrs.hasParamAttribute(i, Attribute::SwiftError)) {
2502       verifySwiftErrorValue(&Arg);
2503     }
2504     ++i;
2505   }
2506 
2507   if (!isLLVMdotName) {
2508     Assert(!F.getReturnType()->isTokenTy(),
2509            "Function returns a token but isn't an intrinsic", &F);
2510     Assert(!F.getReturnType()->isX86_AMXTy(),
2511            "Function returns a x86_amx but isn't an intrinsic", &F);
2512   }
2513 
2514   // Get the function metadata attachments.
2515   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2516   F.getAllMetadata(MDs);
2517   assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
2518   verifyFunctionMetadata(MDs);
2519 
2520   // Check validity of the personality function
2521   if (F.hasPersonalityFn()) {
2522     auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2523     if (Per)
2524       Assert(Per->getParent() == F.getParent(),
2525              "Referencing personality function in another module!",
2526              &F, F.getParent(), Per, Per->getParent());
2527   }
2528 
2529   if (F.isMaterializable()) {
2530     // Function has a body somewhere we can't see.
2531     Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2532            MDs.empty() ? nullptr : MDs.front().second);
2533   } else if (F.isDeclaration()) {
2534     for (const auto &I : MDs) {
2535       // This is used for call site debug information.
2536       AssertDI(I.first != LLVMContext::MD_dbg ||
2537                    !cast<DISubprogram>(I.second)->isDistinct(),
2538                "function declaration may only have a unique !dbg attachment",
2539                &F);
2540       Assert(I.first != LLVMContext::MD_prof,
2541              "function declaration may not have a !prof attachment", &F);
2542 
2543       // Verify the metadata itself.
2544       visitMDNode(*I.second, AreDebugLocsAllowed::Yes);
2545     }
2546     Assert(!F.hasPersonalityFn(),
2547            "Function declaration shouldn't have a personality routine", &F);
2548   } else {
2549     // Verify that this function (which has a body) is not named "llvm.*".  It
2550     // is not legal to define intrinsics.
2551     Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
2552 
2553     // Check the entry node
2554     const BasicBlock *Entry = &F.getEntryBlock();
2555     Assert(pred_empty(Entry),
2556            "Entry block to function must not have predecessors!", Entry);
2557 
2558     // The address of the entry block cannot be taken, unless it is dead.
2559     if (Entry->hasAddressTaken()) {
2560       Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2561              "blockaddress may not be used with the entry block!", Entry);
2562     }
2563 
2564     unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
2565     // Visit metadata attachments.
2566     for (const auto &I : MDs) {
2567       // Verify that the attachment is legal.
2568       auto AllowLocs = AreDebugLocsAllowed::No;
2569       switch (I.first) {
2570       default:
2571         break;
2572       case LLVMContext::MD_dbg: {
2573         ++NumDebugAttachments;
2574         AssertDI(NumDebugAttachments == 1,
2575                  "function must have a single !dbg attachment", &F, I.second);
2576         AssertDI(isa<DISubprogram>(I.second),
2577                  "function !dbg attachment must be a subprogram", &F, I.second);
2578         AssertDI(cast<DISubprogram>(I.second)->isDistinct(),
2579                  "function definition may only have a distinct !dbg attachment",
2580                  &F);
2581 
2582         auto *SP = cast<DISubprogram>(I.second);
2583         const Function *&AttachedTo = DISubprogramAttachments[SP];
2584         AssertDI(!AttachedTo || AttachedTo == &F,
2585                  "DISubprogram attached to more than one function", SP, &F);
2586         AttachedTo = &F;
2587         AllowLocs = AreDebugLocsAllowed::Yes;
2588         break;
2589       }
2590       case LLVMContext::MD_prof:
2591         ++NumProfAttachments;
2592         Assert(NumProfAttachments == 1,
2593                "function must have a single !prof attachment", &F, I.second);
2594         break;
2595       }
2596 
2597       // Verify the metadata itself.
2598       visitMDNode(*I.second, AllowLocs);
2599     }
2600   }
2601 
2602   // If this function is actually an intrinsic, verify that it is only used in
2603   // direct call/invokes, never having its "address taken".
2604   // Only do this if the module is materialized, otherwise we don't have all the
2605   // uses.
2606   if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
2607     const User *U;
2608     if (F.hasAddressTaken(&U))
2609       Assert(false, "Invalid user of intrinsic instruction!", U);
2610   }
2611 
2612   auto *N = F.getSubprogram();
2613   HasDebugInfo = (N != nullptr);
2614   if (!HasDebugInfo)
2615     return;
2616 
2617   // Check that all !dbg attachments lead to back to N.
2618   //
2619   // FIXME: Check this incrementally while visiting !dbg attachments.
2620   // FIXME: Only check when N is the canonical subprogram for F.
2621   SmallPtrSet<const MDNode *, 32> Seen;
2622   auto VisitDebugLoc = [&](const Instruction &I, const MDNode *Node) {
2623     // Be careful about using DILocation here since we might be dealing with
2624     // broken code (this is the Verifier after all).
2625     const DILocation *DL = dyn_cast_or_null<DILocation>(Node);
2626     if (!DL)
2627       return;
2628     if (!Seen.insert(DL).second)
2629       return;
2630 
2631     Metadata *Parent = DL->getRawScope();
2632     AssertDI(Parent && isa<DILocalScope>(Parent),
2633              "DILocation's scope must be a DILocalScope", N, &F, &I, DL,
2634              Parent);
2635 
2636     DILocalScope *Scope = DL->getInlinedAtScope();
2637     Assert(Scope, "Failed to find DILocalScope", DL);
2638 
2639     if (!Seen.insert(Scope).second)
2640       return;
2641 
2642     DISubprogram *SP = Scope->getSubprogram();
2643 
2644     // Scope and SP could be the same MDNode and we don't want to skip
2645     // validation in that case
2646     if (SP && ((Scope != SP) && !Seen.insert(SP).second))
2647       return;
2648 
2649     AssertDI(SP->describes(&F),
2650              "!dbg attachment points at wrong subprogram for function", N, &F,
2651              &I, DL, Scope, SP);
2652   };
2653   for (auto &BB : F)
2654     for (auto &I : BB) {
2655       VisitDebugLoc(I, I.getDebugLoc().getAsMDNode());
2656       // The llvm.loop annotations also contain two DILocations.
2657       if (auto MD = I.getMetadata(LLVMContext::MD_loop))
2658         for (unsigned i = 1; i < MD->getNumOperands(); ++i)
2659           VisitDebugLoc(I, dyn_cast_or_null<MDNode>(MD->getOperand(i)));
2660       if (BrokenDebugInfo)
2661         return;
2662     }
2663 }
2664 
2665 // verifyBasicBlock - Verify that a basic block is well formed...
2666 //
2667 void Verifier::visitBasicBlock(BasicBlock &BB) {
2668   InstsInThisBlock.clear();
2669 
2670   // Ensure that basic blocks have terminators!
2671   Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
2672 
2673   // Check constraints that this basic block imposes on all of the PHI nodes in
2674   // it.
2675   if (isa<PHINode>(BB.front())) {
2676     SmallVector<BasicBlock *, 8> Preds(predecessors(&BB));
2677     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
2678     llvm::sort(Preds);
2679     for (const PHINode &PN : BB.phis()) {
2680       Assert(PN.getNumIncomingValues() == Preds.size(),
2681              "PHINode should have one entry for each predecessor of its "
2682              "parent basic block!",
2683              &PN);
2684 
2685       // Get and sort all incoming values in the PHI node...
2686       Values.clear();
2687       Values.reserve(PN.getNumIncomingValues());
2688       for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
2689         Values.push_back(
2690             std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
2691       llvm::sort(Values);
2692 
2693       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2694         // Check to make sure that if there is more than one entry for a
2695         // particular basic block in this PHI node, that the incoming values are
2696         // all identical.
2697         //
2698         Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2699                    Values[i].second == Values[i - 1].second,
2700                "PHI node has multiple entries for the same basic block with "
2701                "different incoming values!",
2702                &PN, Values[i].first, Values[i].second, Values[i - 1].second);
2703 
2704         // Check to make sure that the predecessors and PHI node entries are
2705         // matched up.
2706         Assert(Values[i].first == Preds[i],
2707                "PHI node entries do not match predecessors!", &PN,
2708                Values[i].first, Preds[i]);
2709       }
2710     }
2711   }
2712 
2713   // Check that all instructions have their parent pointers set up correctly.
2714   for (auto &I : BB)
2715   {
2716     Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
2717   }
2718 }
2719 
2720 void Verifier::visitTerminator(Instruction &I) {
2721   // Ensure that terminators only exist at the end of the basic block.
2722   Assert(&I == I.getParent()->getTerminator(),
2723          "Terminator found in the middle of a basic block!", I.getParent());
2724   visitInstruction(I);
2725 }
2726 
2727 void Verifier::visitBranchInst(BranchInst &BI) {
2728   if (BI.isConditional()) {
2729     Assert(BI.getCondition()->getType()->isIntegerTy(1),
2730            "Branch condition is not 'i1' type!", &BI, BI.getCondition());
2731   }
2732   visitTerminator(BI);
2733 }
2734 
2735 void Verifier::visitReturnInst(ReturnInst &RI) {
2736   Function *F = RI.getParent()->getParent();
2737   unsigned N = RI.getNumOperands();
2738   if (F->getReturnType()->isVoidTy())
2739     Assert(N == 0,
2740            "Found return instr that returns non-void in Function of void "
2741            "return type!",
2742            &RI, F->getReturnType());
2743   else
2744     Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2745            "Function return type does not match operand "
2746            "type of return inst!",
2747            &RI, F->getReturnType());
2748 
2749   // Check to make sure that the return value has necessary properties for
2750   // terminators...
2751   visitTerminator(RI);
2752 }
2753 
2754 void Verifier::visitSwitchInst(SwitchInst &SI) {
2755   // Check to make sure that all of the constants in the switch instruction
2756   // have the same type as the switched-on value.
2757   Type *SwitchTy = SI.getCondition()->getType();
2758   SmallPtrSet<ConstantInt*, 32> Constants;
2759   for (auto &Case : SI.cases()) {
2760     Assert(Case.getCaseValue()->getType() == SwitchTy,
2761            "Switch constants must all be same type as switch value!", &SI);
2762     Assert(Constants.insert(Case.getCaseValue()).second,
2763            "Duplicate integer as switch case", &SI, Case.getCaseValue());
2764   }
2765 
2766   visitTerminator(SI);
2767 }
2768 
2769 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
2770   Assert(BI.getAddress()->getType()->isPointerTy(),
2771          "Indirectbr operand must have pointer type!", &BI);
2772   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
2773     Assert(BI.getDestination(i)->getType()->isLabelTy(),
2774            "Indirectbr destinations must all have pointer type!", &BI);
2775 
2776   visitTerminator(BI);
2777 }
2778 
2779 void Verifier::visitCallBrInst(CallBrInst &CBI) {
2780   Assert(CBI.isInlineAsm(), "Callbr is currently only used for asm-goto!",
2781          &CBI);
2782   for (unsigned i = 0, e = CBI.getNumSuccessors(); i != e; ++i)
2783     Assert(CBI.getSuccessor(i)->getType()->isLabelTy(),
2784            "Callbr successors must all have pointer type!", &CBI);
2785   for (unsigned i = 0, e = CBI.getNumOperands(); i != e; ++i) {
2786     Assert(i >= CBI.getNumArgOperands() || !isa<BasicBlock>(CBI.getOperand(i)),
2787            "Using an unescaped label as a callbr argument!", &CBI);
2788     if (isa<BasicBlock>(CBI.getOperand(i)))
2789       for (unsigned j = i + 1; j != e; ++j)
2790         Assert(CBI.getOperand(i) != CBI.getOperand(j),
2791                "Duplicate callbr destination!", &CBI);
2792   }
2793   {
2794     SmallPtrSet<BasicBlock *, 4> ArgBBs;
2795     for (Value *V : CBI.args())
2796       if (auto *BA = dyn_cast<BlockAddress>(V))
2797         ArgBBs.insert(BA->getBasicBlock());
2798     for (BasicBlock *BB : CBI.getIndirectDests())
2799       Assert(ArgBBs.count(BB), "Indirect label missing from arglist.", &CBI);
2800   }
2801 
2802   visitTerminator(CBI);
2803 }
2804 
2805 void Verifier::visitSelectInst(SelectInst &SI) {
2806   Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2807                                          SI.getOperand(2)),
2808          "Invalid operands for select instruction!", &SI);
2809 
2810   Assert(SI.getTrueValue()->getType() == SI.getType(),
2811          "Select values must have same type as select instruction!", &SI);
2812   visitInstruction(SI);
2813 }
2814 
2815 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2816 /// a pass, if any exist, it's an error.
2817 ///
2818 void Verifier::visitUserOp1(Instruction &I) {
2819   Assert(false, "User-defined operators should not live outside of a pass!", &I);
2820 }
2821 
2822 void Verifier::visitTruncInst(TruncInst &I) {
2823   // Get the source and destination types
2824   Type *SrcTy = I.getOperand(0)->getType();
2825   Type *DestTy = I.getType();
2826 
2827   // Get the size of the types in bits, we'll need this later
2828   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2829   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2830 
2831   Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2832   Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2833   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2834          "trunc source and destination must both be a vector or neither", &I);
2835   Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
2836 
2837   visitInstruction(I);
2838 }
2839 
2840 void Verifier::visitZExtInst(ZExtInst &I) {
2841   // Get the source and destination types
2842   Type *SrcTy = I.getOperand(0)->getType();
2843   Type *DestTy = I.getType();
2844 
2845   // Get the size of the types in bits, we'll need this later
2846   Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2847   Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2848   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2849          "zext source and destination must both be a vector or neither", &I);
2850   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2851   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2852 
2853   Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
2854 
2855   visitInstruction(I);
2856 }
2857 
2858 void Verifier::visitSExtInst(SExtInst &I) {
2859   // Get the source and destination types
2860   Type *SrcTy = I.getOperand(0)->getType();
2861   Type *DestTy = I.getType();
2862 
2863   // Get the size of the types in bits, we'll need this later
2864   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2865   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2866 
2867   Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2868   Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2869   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2870          "sext source and destination must both be a vector or neither", &I);
2871   Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
2872 
2873   visitInstruction(I);
2874 }
2875 
2876 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2877   // Get the source and destination types
2878   Type *SrcTy = I.getOperand(0)->getType();
2879   Type *DestTy = I.getType();
2880   // Get the size of the types in bits, we'll need this later
2881   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2882   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2883 
2884   Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2885   Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2886   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2887          "fptrunc source and destination must both be a vector or neither", &I);
2888   Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2889 
2890   visitInstruction(I);
2891 }
2892 
2893 void Verifier::visitFPExtInst(FPExtInst &I) {
2894   // Get the source and destination types
2895   Type *SrcTy = I.getOperand(0)->getType();
2896   Type *DestTy = I.getType();
2897 
2898   // Get the size of the types in bits, we'll need this later
2899   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2900   unsigned DestBitSize = DestTy->getScalarSizeInBits();
2901 
2902   Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2903   Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2904   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2905          "fpext source and destination must both be a vector or neither", &I);
2906   Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2907 
2908   visitInstruction(I);
2909 }
2910 
2911 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2912   // Get the source and destination types
2913   Type *SrcTy = I.getOperand(0)->getType();
2914   Type *DestTy = I.getType();
2915 
2916   bool SrcVec = SrcTy->isVectorTy();
2917   bool DstVec = DestTy->isVectorTy();
2918 
2919   Assert(SrcVec == DstVec,
2920          "UIToFP source and dest must both be vector or scalar", &I);
2921   Assert(SrcTy->isIntOrIntVectorTy(),
2922          "UIToFP source must be integer or integer vector", &I);
2923   Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2924          &I);
2925 
2926   if (SrcVec && DstVec)
2927     Assert(cast<VectorType>(SrcTy)->getElementCount() ==
2928                cast<VectorType>(DestTy)->getElementCount(),
2929            "UIToFP source and dest vector length mismatch", &I);
2930 
2931   visitInstruction(I);
2932 }
2933 
2934 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2935   // Get the source and destination types
2936   Type *SrcTy = I.getOperand(0)->getType();
2937   Type *DestTy = I.getType();
2938 
2939   bool SrcVec = SrcTy->isVectorTy();
2940   bool DstVec = DestTy->isVectorTy();
2941 
2942   Assert(SrcVec == DstVec,
2943          "SIToFP source and dest must both be vector or scalar", &I);
2944   Assert(SrcTy->isIntOrIntVectorTy(),
2945          "SIToFP source must be integer or integer vector", &I);
2946   Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2947          &I);
2948 
2949   if (SrcVec && DstVec)
2950     Assert(cast<VectorType>(SrcTy)->getElementCount() ==
2951                cast<VectorType>(DestTy)->getElementCount(),
2952            "SIToFP source and dest vector length mismatch", &I);
2953 
2954   visitInstruction(I);
2955 }
2956 
2957 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2958   // Get the source and destination types
2959   Type *SrcTy = I.getOperand(0)->getType();
2960   Type *DestTy = I.getType();
2961 
2962   bool SrcVec = SrcTy->isVectorTy();
2963   bool DstVec = DestTy->isVectorTy();
2964 
2965   Assert(SrcVec == DstVec,
2966          "FPToUI source and dest must both be vector or scalar", &I);
2967   Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2968          &I);
2969   Assert(DestTy->isIntOrIntVectorTy(),
2970          "FPToUI result must be integer or integer vector", &I);
2971 
2972   if (SrcVec && DstVec)
2973     Assert(cast<VectorType>(SrcTy)->getElementCount() ==
2974                cast<VectorType>(DestTy)->getElementCount(),
2975            "FPToUI source and dest vector length mismatch", &I);
2976 
2977   visitInstruction(I);
2978 }
2979 
2980 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2981   // Get the source and destination types
2982   Type *SrcTy = I.getOperand(0)->getType();
2983   Type *DestTy = I.getType();
2984 
2985   bool SrcVec = SrcTy->isVectorTy();
2986   bool DstVec = DestTy->isVectorTy();
2987 
2988   Assert(SrcVec == DstVec,
2989          "FPToSI source and dest must both be vector or scalar", &I);
2990   Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2991          &I);
2992   Assert(DestTy->isIntOrIntVectorTy(),
2993          "FPToSI result must be integer or integer vector", &I);
2994 
2995   if (SrcVec && DstVec)
2996     Assert(cast<VectorType>(SrcTy)->getElementCount() ==
2997                cast<VectorType>(DestTy)->getElementCount(),
2998            "FPToSI source and dest vector length mismatch", &I);
2999 
3000   visitInstruction(I);
3001 }
3002 
3003 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
3004   // Get the source and destination types
3005   Type *SrcTy = I.getOperand(0)->getType();
3006   Type *DestTy = I.getType();
3007 
3008   Assert(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
3009 
3010   if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
3011     Assert(!DL.isNonIntegralPointerType(PTy),
3012            "ptrtoint not supported for non-integral pointers");
3013 
3014   Assert(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
3015   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
3016          &I);
3017 
3018   if (SrcTy->isVectorTy()) {
3019     auto *VSrc = cast<VectorType>(SrcTy);
3020     auto *VDest = cast<VectorType>(DestTy);
3021     Assert(VSrc->getElementCount() == VDest->getElementCount(),
3022            "PtrToInt Vector width mismatch", &I);
3023   }
3024 
3025   visitInstruction(I);
3026 }
3027 
3028 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
3029   // Get the source and destination types
3030   Type *SrcTy = I.getOperand(0)->getType();
3031   Type *DestTy = I.getType();
3032 
3033   Assert(SrcTy->isIntOrIntVectorTy(),
3034          "IntToPtr source must be an integral", &I);
3035   Assert(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
3036 
3037   if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
3038     Assert(!DL.isNonIntegralPointerType(PTy),
3039            "inttoptr not supported for non-integral pointers");
3040 
3041   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
3042          &I);
3043   if (SrcTy->isVectorTy()) {
3044     auto *VSrc = cast<VectorType>(SrcTy);
3045     auto *VDest = cast<VectorType>(DestTy);
3046     Assert(VSrc->getElementCount() == VDest->getElementCount(),
3047            "IntToPtr Vector width mismatch", &I);
3048   }
3049   visitInstruction(I);
3050 }
3051 
3052 void Verifier::visitBitCastInst(BitCastInst &I) {
3053   Assert(
3054       CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
3055       "Invalid bitcast", &I);
3056   visitInstruction(I);
3057 }
3058 
3059 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
3060   Type *SrcTy = I.getOperand(0)->getType();
3061   Type *DestTy = I.getType();
3062 
3063   Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
3064          &I);
3065   Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
3066          &I);
3067   Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
3068          "AddrSpaceCast must be between different address spaces", &I);
3069   if (auto *SrcVTy = dyn_cast<VectorType>(SrcTy))
3070     Assert(SrcVTy->getElementCount() ==
3071                cast<VectorType>(DestTy)->getElementCount(),
3072            "AddrSpaceCast vector pointer number of elements mismatch", &I);
3073   visitInstruction(I);
3074 }
3075 
3076 /// visitPHINode - Ensure that a PHI node is well formed.
3077 ///
3078 void Verifier::visitPHINode(PHINode &PN) {
3079   // Ensure that the PHI nodes are all grouped together at the top of the block.
3080   // This can be tested by checking whether the instruction before this is
3081   // either nonexistent (because this is begin()) or is a PHI node.  If not,
3082   // then there is some other instruction before a PHI.
3083   Assert(&PN == &PN.getParent()->front() ||
3084              isa<PHINode>(--BasicBlock::iterator(&PN)),
3085          "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
3086 
3087   // Check that a PHI doesn't yield a Token.
3088   Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
3089 
3090   // Check that all of the values of the PHI node have the same type as the
3091   // result, and that the incoming blocks are really basic blocks.
3092   for (Value *IncValue : PN.incoming_values()) {
3093     Assert(PN.getType() == IncValue->getType(),
3094            "PHI node operands are not the same type as the result!", &PN);
3095   }
3096 
3097   // All other PHI node constraints are checked in the visitBasicBlock method.
3098 
3099   visitInstruction(PN);
3100 }
3101 
3102 void Verifier::visitCallBase(CallBase &Call) {
3103   Assert(Call.getCalledOperand()->getType()->isPointerTy(),
3104          "Called function must be a pointer!", Call);
3105   PointerType *FPTy = cast<PointerType>(Call.getCalledOperand()->getType());
3106 
3107   Assert(FPTy->getElementType()->isFunctionTy(),
3108          "Called function is not pointer to function type!", Call);
3109 
3110   Assert(FPTy->getElementType() == Call.getFunctionType(),
3111          "Called function is not the same type as the call!", Call);
3112 
3113   FunctionType *FTy = Call.getFunctionType();
3114 
3115   // Verify that the correct number of arguments are being passed
3116   if (FTy->isVarArg())
3117     Assert(Call.arg_size() >= FTy->getNumParams(),
3118            "Called function requires more parameters than were provided!",
3119            Call);
3120   else
3121     Assert(Call.arg_size() == FTy->getNumParams(),
3122            "Incorrect number of arguments passed to called function!", Call);
3123 
3124   // Verify that all arguments to the call match the function type.
3125   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
3126     Assert(Call.getArgOperand(i)->getType() == FTy->getParamType(i),
3127            "Call parameter type does not match function signature!",
3128            Call.getArgOperand(i), FTy->getParamType(i), Call);
3129 
3130   AttributeList Attrs = Call.getAttributes();
3131 
3132   Assert(verifyAttributeCount(Attrs, Call.arg_size()),
3133          "Attribute after last parameter!", Call);
3134 
3135   bool IsIntrinsic = Call.getCalledFunction() &&
3136                      Call.getCalledFunction()->getName().startswith("llvm.");
3137 
3138   Function *Callee =
3139       dyn_cast<Function>(Call.getCalledOperand()->stripPointerCasts());
3140 
3141   if (Attrs.hasFnAttribute(Attribute::Speculatable)) {
3142     // Don't allow speculatable on call sites, unless the underlying function
3143     // declaration is also speculatable.
3144     Assert(Callee && Callee->isSpeculatable(),
3145            "speculatable attribute may not apply to call sites", Call);
3146   }
3147 
3148   if (Attrs.hasFnAttribute(Attribute::Preallocated)) {
3149     Assert(Call.getCalledFunction()->getIntrinsicID() ==
3150                Intrinsic::call_preallocated_arg,
3151            "preallocated as a call site attribute can only be on "
3152            "llvm.call.preallocated.arg");
3153   }
3154 
3155   // Verify call attributes.
3156   verifyFunctionAttrs(FTy, Attrs, &Call, IsIntrinsic);
3157 
3158   // Conservatively check the inalloca argument.
3159   // We have a bug if we can find that there is an underlying alloca without
3160   // inalloca.
3161   if (Call.hasInAllocaArgument()) {
3162     Value *InAllocaArg = Call.getArgOperand(FTy->getNumParams() - 1);
3163     if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
3164       Assert(AI->isUsedWithInAlloca(),
3165              "inalloca argument for call has mismatched alloca", AI, Call);
3166   }
3167 
3168   // For each argument of the callsite, if it has the swifterror argument,
3169   // make sure the underlying alloca/parameter it comes from has a swifterror as
3170   // well.
3171   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
3172     if (Call.paramHasAttr(i, Attribute::SwiftError)) {
3173       Value *SwiftErrorArg = Call.getArgOperand(i);
3174       if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
3175         Assert(AI->isSwiftError(),
3176                "swifterror argument for call has mismatched alloca", AI, Call);
3177         continue;
3178       }
3179       auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
3180       Assert(ArgI,
3181              "swifterror argument should come from an alloca or parameter",
3182              SwiftErrorArg, Call);
3183       Assert(ArgI->hasSwiftErrorAttr(),
3184              "swifterror argument for call has mismatched parameter", ArgI,
3185              Call);
3186     }
3187 
3188     if (Attrs.hasParamAttribute(i, Attribute::ImmArg)) {
3189       // Don't allow immarg on call sites, unless the underlying declaration
3190       // also has the matching immarg.
3191       Assert(Callee && Callee->hasParamAttribute(i, Attribute::ImmArg),
3192              "immarg may not apply only to call sites",
3193              Call.getArgOperand(i), Call);
3194     }
3195 
3196     if (Call.paramHasAttr(i, Attribute::ImmArg)) {
3197       Value *ArgVal = Call.getArgOperand(i);
3198       Assert(isa<ConstantInt>(ArgVal) || isa<ConstantFP>(ArgVal),
3199              "immarg operand has non-immediate parameter", ArgVal, Call);
3200     }
3201 
3202     if (Call.paramHasAttr(i, Attribute::Preallocated)) {
3203       Value *ArgVal = Call.getArgOperand(i);
3204       bool hasOB =
3205           Call.countOperandBundlesOfType(LLVMContext::OB_preallocated) != 0;
3206       bool isMustTail = Call.isMustTailCall();
3207       Assert(hasOB != isMustTail,
3208              "preallocated operand either requires a preallocated bundle or "
3209              "the call to be musttail (but not both)",
3210              ArgVal, Call);
3211     }
3212   }
3213 
3214   if (FTy->isVarArg()) {
3215     // FIXME? is 'nest' even legal here?
3216     bool SawNest = false;
3217     bool SawReturned = false;
3218 
3219     for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
3220       if (Attrs.hasParamAttribute(Idx, Attribute::Nest))
3221         SawNest = true;
3222       if (Attrs.hasParamAttribute(Idx, Attribute::Returned))
3223         SawReturned = true;
3224     }
3225 
3226     // Check attributes on the varargs part.
3227     for (unsigned Idx = FTy->getNumParams(); Idx < Call.arg_size(); ++Idx) {
3228       Type *Ty = Call.getArgOperand(Idx)->getType();
3229       AttributeSet ArgAttrs = Attrs.getParamAttributes(Idx);
3230       verifyParameterAttrs(ArgAttrs, Ty, &Call);
3231 
3232       if (ArgAttrs.hasAttribute(Attribute::Nest)) {
3233         Assert(!SawNest, "More than one parameter has attribute nest!", Call);
3234         SawNest = true;
3235       }
3236 
3237       if (ArgAttrs.hasAttribute(Attribute::Returned)) {
3238         Assert(!SawReturned, "More than one parameter has attribute returned!",
3239                Call);
3240         Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
3241                "Incompatible argument and return types for 'returned' "
3242                "attribute",
3243                Call);
3244         SawReturned = true;
3245       }
3246 
3247       // Statepoint intrinsic is vararg but the wrapped function may be not.
3248       // Allow sret here and check the wrapped function in verifyStatepoint.
3249       if (!Call.getCalledFunction() ||
3250           Call.getCalledFunction()->getIntrinsicID() !=
3251               Intrinsic::experimental_gc_statepoint)
3252         Assert(!ArgAttrs.hasAttribute(Attribute::StructRet),
3253                "Attribute 'sret' cannot be used for vararg call arguments!",
3254                Call);
3255 
3256       if (ArgAttrs.hasAttribute(Attribute::InAlloca))
3257         Assert(Idx == Call.arg_size() - 1,
3258                "inalloca isn't on the last argument!", Call);
3259     }
3260   }
3261 
3262   // Verify that there's no metadata unless it's a direct call to an intrinsic.
3263   if (!IsIntrinsic) {
3264     for (Type *ParamTy : FTy->params()) {
3265       Assert(!ParamTy->isMetadataTy(),
3266              "Function has metadata parameter but isn't an intrinsic", Call);
3267       Assert(!ParamTy->isTokenTy(),
3268              "Function has token parameter but isn't an intrinsic", Call);
3269     }
3270   }
3271 
3272   // Verify that indirect calls don't return tokens.
3273   if (!Call.getCalledFunction()) {
3274     Assert(!FTy->getReturnType()->isTokenTy(),
3275            "Return type cannot be token for indirect call!");
3276     Assert(!FTy->getReturnType()->isX86_AMXTy(),
3277            "Return type cannot be x86_amx for indirect call!");
3278   }
3279 
3280   if (Function *F = Call.getCalledFunction())
3281     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
3282       visitIntrinsicCall(ID, Call);
3283 
3284   // Verify that a callsite has at most one "deopt", at most one "funclet", at
3285   // most one "gc-transition", at most one "cfguardtarget",
3286   // and at most one "preallocated" operand bundle.
3287   bool FoundDeoptBundle = false, FoundFuncletBundle = false,
3288        FoundGCTransitionBundle = false, FoundCFGuardTargetBundle = false,
3289        FoundPreallocatedBundle = false, FoundGCLiveBundle = false,
3290        FoundAttachedCallBundle = false;
3291   for (unsigned i = 0, e = Call.getNumOperandBundles(); i < e; ++i) {
3292     OperandBundleUse BU = Call.getOperandBundleAt(i);
3293     uint32_t Tag = BU.getTagID();
3294     if (Tag == LLVMContext::OB_deopt) {
3295       Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", Call);
3296       FoundDeoptBundle = true;
3297     } else if (Tag == LLVMContext::OB_gc_transition) {
3298       Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
3299              Call);
3300       FoundGCTransitionBundle = true;
3301     } else if (Tag == LLVMContext::OB_funclet) {
3302       Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", Call);
3303       FoundFuncletBundle = true;
3304       Assert(BU.Inputs.size() == 1,
3305              "Expected exactly one funclet bundle operand", Call);
3306       Assert(isa<FuncletPadInst>(BU.Inputs.front()),
3307              "Funclet bundle operands should correspond to a FuncletPadInst",
3308              Call);
3309     } else if (Tag == LLVMContext::OB_cfguardtarget) {
3310       Assert(!FoundCFGuardTargetBundle,
3311              "Multiple CFGuardTarget operand bundles", Call);
3312       FoundCFGuardTargetBundle = true;
3313       Assert(BU.Inputs.size() == 1,
3314              "Expected exactly one cfguardtarget bundle operand", Call);
3315     } else if (Tag == LLVMContext::OB_preallocated) {
3316       Assert(!FoundPreallocatedBundle, "Multiple preallocated operand bundles",
3317              Call);
3318       FoundPreallocatedBundle = true;
3319       Assert(BU.Inputs.size() == 1,
3320              "Expected exactly one preallocated bundle operand", Call);
3321       auto Input = dyn_cast<IntrinsicInst>(BU.Inputs.front());
3322       Assert(Input &&
3323                  Input->getIntrinsicID() == Intrinsic::call_preallocated_setup,
3324              "\"preallocated\" argument must be a token from "
3325              "llvm.call.preallocated.setup",
3326              Call);
3327     } else if (Tag == LLVMContext::OB_gc_live) {
3328       Assert(!FoundGCLiveBundle, "Multiple gc-live operand bundles",
3329              Call);
3330       FoundGCLiveBundle = true;
3331     } else if (Tag == LLVMContext::OB_clang_arc_attachedcall) {
3332       Assert(!FoundAttachedCallBundle,
3333              "Multiple \"clang.arc.attachedcall\" operand bundles", Call);
3334       FoundAttachedCallBundle = true;
3335     }
3336   }
3337 
3338   if (FoundAttachedCallBundle)
3339     Assert(FTy->getReturnType()->isPointerTy(),
3340            "a call with operand bundle \"clang.arc.attachedcall\" must call a "
3341            "function returning a pointer",
3342            Call);
3343 
3344   // Verify that each inlinable callsite of a debug-info-bearing function in a
3345   // debug-info-bearing function has a debug location attached to it. Failure to
3346   // do so causes assertion failures when the inliner sets up inline scope info.
3347   if (Call.getFunction()->getSubprogram() && Call.getCalledFunction() &&
3348       Call.getCalledFunction()->getSubprogram())
3349     AssertDI(Call.getDebugLoc(),
3350              "inlinable function call in a function with "
3351              "debug info must have a !dbg location",
3352              Call);
3353 
3354   visitInstruction(Call);
3355 }
3356 
3357 /// Two types are "congruent" if they are identical, or if they are both pointer
3358 /// types with different pointee types and the same address space.
3359 static bool isTypeCongruent(Type *L, Type *R) {
3360   if (L == R)
3361     return true;
3362   PointerType *PL = dyn_cast<PointerType>(L);
3363   PointerType *PR = dyn_cast<PointerType>(R);
3364   if (!PL || !PR)
3365     return false;
3366   return PL->getAddressSpace() == PR->getAddressSpace();
3367 }
3368 
3369 static AttrBuilder getParameterABIAttributes(int I, AttributeList Attrs) {
3370   static const Attribute::AttrKind ABIAttrs[] = {
3371       Attribute::StructRet,    Attribute::ByVal,     Attribute::InAlloca,
3372       Attribute::InReg,        Attribute::SwiftSelf, Attribute::SwiftError,
3373       Attribute::Preallocated, Attribute::ByRef,     Attribute::StackAlignment};
3374   AttrBuilder Copy;
3375   for (auto AK : ABIAttrs) {
3376     if (Attrs.hasParamAttribute(I, AK))
3377       Copy.addAttribute(AK);
3378   }
3379 
3380   // `align` is ABI-affecting only in combination with `byval` or `byref`.
3381   if (Attrs.hasParamAttribute(I, Attribute::Alignment) &&
3382       (Attrs.hasParamAttribute(I, Attribute::ByVal) ||
3383        Attrs.hasParamAttribute(I, Attribute::ByRef)))
3384     Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
3385   return Copy;
3386 }
3387 
3388 void Verifier::verifyMustTailCall(CallInst &CI) {
3389   Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
3390 
3391   // - The caller and callee prototypes must match.  Pointer types of
3392   //   parameters or return types may differ in pointee type, but not
3393   //   address space.
3394   Function *F = CI.getParent()->getParent();
3395   FunctionType *CallerTy = F->getFunctionType();
3396   FunctionType *CalleeTy = CI.getFunctionType();
3397   if (!CI.getCalledFunction() || !CI.getCalledFunction()->isIntrinsic()) {
3398     Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
3399            "cannot guarantee tail call due to mismatched parameter counts",
3400            &CI);
3401     for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
3402       Assert(
3403           isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
3404           "cannot guarantee tail call due to mismatched parameter types", &CI);
3405     }
3406   }
3407   Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
3408          "cannot guarantee tail call due to mismatched varargs", &CI);
3409   Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
3410          "cannot guarantee tail call due to mismatched return types", &CI);
3411 
3412   // - The calling conventions of the caller and callee must match.
3413   Assert(F->getCallingConv() == CI.getCallingConv(),
3414          "cannot guarantee tail call due to mismatched calling conv", &CI);
3415 
3416   // - All ABI-impacting function attributes, such as sret, byval, inreg,
3417   //   returned, preallocated, and inalloca, must match.
3418   AttributeList CallerAttrs = F->getAttributes();
3419   AttributeList CalleeAttrs = CI.getAttributes();
3420   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
3421     AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
3422     AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
3423     Assert(CallerABIAttrs == CalleeABIAttrs,
3424            "cannot guarantee tail call due to mismatched ABI impacting "
3425            "function attributes",
3426            &CI, CI.getOperand(I));
3427   }
3428 
3429   // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
3430   //   or a pointer bitcast followed by a ret instruction.
3431   // - The ret instruction must return the (possibly bitcasted) value
3432   //   produced by the call or void.
3433   Value *RetVal = &CI;
3434   Instruction *Next = CI.getNextNode();
3435 
3436   // Handle the optional bitcast.
3437   if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
3438     Assert(BI->getOperand(0) == RetVal,
3439            "bitcast following musttail call must use the call", BI);
3440     RetVal = BI;
3441     Next = BI->getNextNode();
3442   }
3443 
3444   // Check the return.
3445   ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
3446   Assert(Ret, "musttail call must precede a ret with an optional bitcast",
3447          &CI);
3448   Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
3449          "musttail call result must be returned", Ret);
3450 }
3451 
3452 void Verifier::visitCallInst(CallInst &CI) {
3453   visitCallBase(CI);
3454 
3455   if (CI.isMustTailCall())
3456     verifyMustTailCall(CI);
3457 }
3458 
3459 void Verifier::visitInvokeInst(InvokeInst &II) {
3460   visitCallBase(II);
3461 
3462   // Verify that the first non-PHI instruction of the unwind destination is an
3463   // exception handling instruction.
3464   Assert(
3465       II.getUnwindDest()->isEHPad(),
3466       "The unwind destination does not have an exception handling instruction!",
3467       &II);
3468 
3469   visitTerminator(II);
3470 }
3471 
3472 /// visitUnaryOperator - Check the argument to the unary operator.
3473 ///
3474 void Verifier::visitUnaryOperator(UnaryOperator &U) {
3475   Assert(U.getType() == U.getOperand(0)->getType(),
3476          "Unary operators must have same type for"
3477          "operands and result!",
3478          &U);
3479 
3480   switch (U.getOpcode()) {
3481   // Check that floating-point arithmetic operators are only used with
3482   // floating-point operands.
3483   case Instruction::FNeg:
3484     Assert(U.getType()->isFPOrFPVectorTy(),
3485            "FNeg operator only works with float types!", &U);
3486     break;
3487   default:
3488     llvm_unreachable("Unknown UnaryOperator opcode!");
3489   }
3490 
3491   visitInstruction(U);
3492 }
3493 
3494 /// visitBinaryOperator - Check that both arguments to the binary operator are
3495 /// of the same type!
3496 ///
3497 void Verifier::visitBinaryOperator(BinaryOperator &B) {
3498   Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
3499          "Both operands to a binary operator are not of the same type!", &B);
3500 
3501   switch (B.getOpcode()) {
3502   // Check that integer arithmetic operators are only used with
3503   // integral operands.
3504   case Instruction::Add:
3505   case Instruction::Sub:
3506   case Instruction::Mul:
3507   case Instruction::SDiv:
3508   case Instruction::UDiv:
3509   case Instruction::SRem:
3510   case Instruction::URem:
3511     Assert(B.getType()->isIntOrIntVectorTy(),
3512            "Integer arithmetic operators only work with integral types!", &B);
3513     Assert(B.getType() == B.getOperand(0)->getType(),
3514            "Integer arithmetic operators must have same type "
3515            "for operands and result!",
3516            &B);
3517     break;
3518   // Check that floating-point arithmetic operators are only used with
3519   // floating-point operands.
3520   case Instruction::FAdd:
3521   case Instruction::FSub:
3522   case Instruction::FMul:
3523   case Instruction::FDiv:
3524   case Instruction::FRem:
3525     Assert(B.getType()->isFPOrFPVectorTy(),
3526            "Floating-point arithmetic operators only work with "
3527            "floating-point types!",
3528            &B);
3529     Assert(B.getType() == B.getOperand(0)->getType(),
3530            "Floating-point arithmetic operators must have same type "
3531            "for operands and result!",
3532            &B);
3533     break;
3534   // Check that logical operators are only used with integral operands.
3535   case Instruction::And:
3536   case Instruction::Or:
3537   case Instruction::Xor:
3538     Assert(B.getType()->isIntOrIntVectorTy(),
3539            "Logical operators only work with integral types!", &B);
3540     Assert(B.getType() == B.getOperand(0)->getType(),
3541            "Logical operators must have same type for operands and result!",
3542            &B);
3543     break;
3544   case Instruction::Shl:
3545   case Instruction::LShr:
3546   case Instruction::AShr:
3547     Assert(B.getType()->isIntOrIntVectorTy(),
3548            "Shifts only work with integral types!", &B);
3549     Assert(B.getType() == B.getOperand(0)->getType(),
3550            "Shift return type must be same as operands!", &B);
3551     break;
3552   default:
3553     llvm_unreachable("Unknown BinaryOperator opcode!");
3554   }
3555 
3556   visitInstruction(B);
3557 }
3558 
3559 void Verifier::visitICmpInst(ICmpInst &IC) {
3560   // Check that the operands are the same type
3561   Type *Op0Ty = IC.getOperand(0)->getType();
3562   Type *Op1Ty = IC.getOperand(1)->getType();
3563   Assert(Op0Ty == Op1Ty,
3564          "Both operands to ICmp instruction are not of the same type!", &IC);
3565   // Check that the operands are the right type
3566   Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
3567          "Invalid operand types for ICmp instruction", &IC);
3568   // Check that the predicate is valid.
3569   Assert(IC.isIntPredicate(),
3570          "Invalid predicate in ICmp instruction!", &IC);
3571 
3572   visitInstruction(IC);
3573 }
3574 
3575 void Verifier::visitFCmpInst(FCmpInst &FC) {
3576   // Check that the operands are the same type
3577   Type *Op0Ty = FC.getOperand(0)->getType();
3578   Type *Op1Ty = FC.getOperand(1)->getType();
3579   Assert(Op0Ty == Op1Ty,
3580          "Both operands to FCmp instruction are not of the same type!", &FC);
3581   // Check that the operands are the right type
3582   Assert(Op0Ty->isFPOrFPVectorTy(),
3583          "Invalid operand types for FCmp instruction", &FC);
3584   // Check that the predicate is valid.
3585   Assert(FC.isFPPredicate(),
3586          "Invalid predicate in FCmp instruction!", &FC);
3587 
3588   visitInstruction(FC);
3589 }
3590 
3591 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
3592   Assert(
3593       ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
3594       "Invalid extractelement operands!", &EI);
3595   visitInstruction(EI);
3596 }
3597 
3598 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
3599   Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
3600                                             IE.getOperand(2)),
3601          "Invalid insertelement operands!", &IE);
3602   visitInstruction(IE);
3603 }
3604 
3605 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
3606   Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
3607                                             SV.getShuffleMask()),
3608          "Invalid shufflevector operands!", &SV);
3609   visitInstruction(SV);
3610 }
3611 
3612 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
3613   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
3614 
3615   Assert(isa<PointerType>(TargetTy),
3616          "GEP base pointer is not a vector or a vector of pointers", &GEP);
3617   Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
3618 
3619   SmallVector<Value *, 16> Idxs(GEP.indices());
3620   Assert(all_of(
3621       Idxs, [](Value* V) { return V->getType()->isIntOrIntVectorTy(); }),
3622       "GEP indexes must be integers", &GEP);
3623   Type *ElTy =
3624       GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
3625   Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
3626 
3627   Assert(GEP.getType()->isPtrOrPtrVectorTy() &&
3628              GEP.getResultElementType() == ElTy,
3629          "GEP is not of right type for indices!", &GEP, ElTy);
3630 
3631   if (auto *GEPVTy = dyn_cast<VectorType>(GEP.getType())) {
3632     // Additional checks for vector GEPs.
3633     ElementCount GEPWidth = GEPVTy->getElementCount();
3634     if (GEP.getPointerOperandType()->isVectorTy())
3635       Assert(
3636           GEPWidth ==
3637               cast<VectorType>(GEP.getPointerOperandType())->getElementCount(),
3638           "Vector GEP result width doesn't match operand's", &GEP);
3639     for (Value *Idx : Idxs) {
3640       Type *IndexTy = Idx->getType();
3641       if (auto *IndexVTy = dyn_cast<VectorType>(IndexTy)) {
3642         ElementCount IndexWidth = IndexVTy->getElementCount();
3643         Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
3644       }
3645       Assert(IndexTy->isIntOrIntVectorTy(),
3646              "All GEP indices should be of integer type");
3647     }
3648   }
3649 
3650   if (auto *PTy = dyn_cast<PointerType>(GEP.getType())) {
3651     Assert(GEP.getAddressSpace() == PTy->getAddressSpace(),
3652            "GEP address space doesn't match type", &GEP);
3653   }
3654 
3655   visitInstruction(GEP);
3656 }
3657 
3658 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3659   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3660 }
3661 
3662 void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3663   assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
3664          "precondition violation");
3665 
3666   unsigned NumOperands = Range->getNumOperands();
3667   Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
3668   unsigned NumRanges = NumOperands / 2;
3669   Assert(NumRanges >= 1, "It should have at least one range!", Range);
3670 
3671   ConstantRange LastRange(1, true); // Dummy initial value
3672   for (unsigned i = 0; i < NumRanges; ++i) {
3673     ConstantInt *Low =
3674         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
3675     Assert(Low, "The lower limit must be an integer!", Low);
3676     ConstantInt *High =
3677         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
3678     Assert(High, "The upper limit must be an integer!", High);
3679     Assert(High->getType() == Low->getType() && High->getType() == Ty,
3680            "Range types must match instruction type!", &I);
3681 
3682     APInt HighV = High->getValue();
3683     APInt LowV = Low->getValue();
3684     ConstantRange CurRange(LowV, HighV);
3685     Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3686            "Range must not be empty!", Range);
3687     if (i != 0) {
3688       Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3689              "Intervals are overlapping", Range);
3690       Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3691              Range);
3692       Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3693              Range);
3694     }
3695     LastRange = ConstantRange(LowV, HighV);
3696   }
3697   if (NumRanges > 2) {
3698     APInt FirstLow =
3699         mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
3700     APInt FirstHigh =
3701         mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
3702     ConstantRange FirstRange(FirstLow, FirstHigh);
3703     Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3704            "Intervals are overlapping", Range);
3705     Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3706            Range);
3707   }
3708 }
3709 
3710 void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3711   unsigned Size = DL.getTypeSizeInBits(Ty);
3712   Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3713   Assert(!(Size & (Size - 1)),
3714          "atomic memory access' operand must have a power-of-two size", Ty, I);
3715 }
3716 
3717 void Verifier::visitLoadInst(LoadInst &LI) {
3718   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
3719   Assert(PTy, "Load operand must be a pointer.", &LI);
3720   Type *ElTy = LI.getType();
3721   Assert(LI.getAlignment() <= Value::MaximumAlignment,
3722          "huge alignment values are unsupported", &LI);
3723   Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
3724   if (LI.isAtomic()) {
3725     Assert(LI.getOrdering() != AtomicOrdering::Release &&
3726                LI.getOrdering() != AtomicOrdering::AcquireRelease,
3727            "Load cannot have Release ordering", &LI);
3728     Assert(LI.getAlignment() != 0,
3729            "Atomic load must specify explicit alignment", &LI);
3730     Assert(ElTy->isIntOrPtrTy() || ElTy->isFloatingPointTy(),
3731            "atomic load operand must have integer, pointer, or floating point "
3732            "type!",
3733            ElTy, &LI);
3734     checkAtomicMemAccessSize(ElTy, &LI);
3735   } else {
3736     Assert(LI.getSyncScopeID() == SyncScope::System,
3737            "Non-atomic load cannot have SynchronizationScope specified", &LI);
3738   }
3739 
3740   visitInstruction(LI);
3741 }
3742 
3743 void Verifier::visitStoreInst(StoreInst &SI) {
3744   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
3745   Assert(PTy, "Store operand must be a pointer.", &SI);
3746   Type *ElTy = PTy->getElementType();
3747   Assert(ElTy == SI.getOperand(0)->getType(),
3748          "Stored value type does not match pointer operand type!", &SI, ElTy);
3749   Assert(SI.getAlignment() <= Value::MaximumAlignment,
3750          "huge alignment values are unsupported", &SI);
3751   Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
3752   if (SI.isAtomic()) {
3753     Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3754                SI.getOrdering() != AtomicOrdering::AcquireRelease,
3755            "Store cannot have Acquire ordering", &SI);
3756     Assert(SI.getAlignment() != 0,
3757            "Atomic store must specify explicit alignment", &SI);
3758     Assert(ElTy->isIntOrPtrTy() || ElTy->isFloatingPointTy(),
3759            "atomic store operand must have integer, pointer, or floating point "
3760            "type!",
3761            ElTy, &SI);
3762     checkAtomicMemAccessSize(ElTy, &SI);
3763   } else {
3764     Assert(SI.getSyncScopeID() == SyncScope::System,
3765            "Non-atomic store cannot have SynchronizationScope specified", &SI);
3766   }
3767   visitInstruction(SI);
3768 }
3769 
3770 /// Check that SwiftErrorVal is used as a swifterror argument in CS.
3771 void Verifier::verifySwiftErrorCall(CallBase &Call,
3772                                     const Value *SwiftErrorVal) {
3773   for (const auto &I : llvm::enumerate(Call.args())) {
3774     if (I.value() == SwiftErrorVal) {
3775       Assert(Call.paramHasAttr(I.index(), Attribute::SwiftError),
3776              "swifterror value when used in a callsite should be marked "
3777              "with swifterror attribute",
3778              SwiftErrorVal, Call);
3779     }
3780   }
3781 }
3782 
3783 void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3784   // Check that swifterror value is only used by loads, stores, or as
3785   // a swifterror argument.
3786   for (const User *U : SwiftErrorVal->users()) {
3787     Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3788            isa<InvokeInst>(U),
3789            "swifterror value can only be loaded and stored from, or "
3790            "as a swifterror argument!",
3791            SwiftErrorVal, U);
3792     // If it is used by a store, check it is the second operand.
3793     if (auto StoreI = dyn_cast<StoreInst>(U))
3794       Assert(StoreI->getOperand(1) == SwiftErrorVal,
3795              "swifterror value should be the second operand when used "
3796              "by stores", SwiftErrorVal, U);
3797     if (auto *Call = dyn_cast<CallBase>(U))
3798       verifySwiftErrorCall(*const_cast<CallBase *>(Call), SwiftErrorVal);
3799   }
3800 }
3801 
3802 void Verifier::visitAllocaInst(AllocaInst &AI) {
3803   SmallPtrSet<Type*, 4> Visited;
3804   PointerType *PTy = AI.getType();
3805   // TODO: Relax this restriction?
3806   Assert(PTy->getAddressSpace() == DL.getAllocaAddrSpace(),
3807          "Allocation instruction pointer not in the stack address space!",
3808          &AI);
3809   Assert(AI.getAllocatedType()->isSized(&Visited),
3810          "Cannot allocate unsized type", &AI);
3811   Assert(AI.getArraySize()->getType()->isIntegerTy(),
3812          "Alloca array size must have integer type", &AI);
3813   Assert(AI.getAlignment() <= Value::MaximumAlignment,
3814          "huge alignment values are unsupported", &AI);
3815 
3816   if (AI.isSwiftError()) {
3817     verifySwiftErrorValue(&AI);
3818   }
3819 
3820   visitInstruction(AI);
3821 }
3822 
3823 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
3824 
3825   // FIXME: more conditions???
3826   Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
3827          "cmpxchg instructions must be atomic.", &CXI);
3828   Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
3829          "cmpxchg instructions must be atomic.", &CXI);
3830   Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
3831          "cmpxchg instructions cannot be unordered.", &CXI);
3832   Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
3833          "cmpxchg instructions cannot be unordered.", &CXI);
3834   Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3835              CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
3836          "cmpxchg failure ordering cannot include release semantics", &CXI);
3837 
3838   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
3839   Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
3840   Type *ElTy = PTy->getElementType();
3841   Assert(ElTy->isIntOrPtrTy(),
3842          "cmpxchg operand must have integer or pointer type", ElTy, &CXI);
3843   checkAtomicMemAccessSize(ElTy, &CXI);
3844   Assert(ElTy == CXI.getOperand(1)->getType(),
3845          "Expected value type does not match pointer operand type!", &CXI,
3846          ElTy);
3847   Assert(ElTy == CXI.getOperand(2)->getType(),
3848          "Stored value type does not match pointer operand type!", &CXI, ElTy);
3849   visitInstruction(CXI);
3850 }
3851 
3852 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
3853   Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
3854          "atomicrmw instructions must be atomic.", &RMWI);
3855   Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
3856          "atomicrmw instructions cannot be unordered.", &RMWI);
3857   auto Op = RMWI.getOperation();
3858   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
3859   Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
3860   Type *ElTy = PTy->getElementType();
3861   if (Op == AtomicRMWInst::Xchg) {
3862     Assert(ElTy->isIntegerTy() || ElTy->isFloatingPointTy(), "atomicrmw " +
3863            AtomicRMWInst::getOperationName(Op) +
3864            " operand must have integer or floating point type!",
3865            &RMWI, ElTy);
3866   } else if (AtomicRMWInst::isFPOperation(Op)) {
3867     Assert(ElTy->isFloatingPointTy(), "atomicrmw " +
3868            AtomicRMWInst::getOperationName(Op) +
3869            " operand must have floating point type!",
3870            &RMWI, ElTy);
3871   } else {
3872     Assert(ElTy->isIntegerTy(), "atomicrmw " +
3873            AtomicRMWInst::getOperationName(Op) +
3874            " operand must have integer type!",
3875            &RMWI, ElTy);
3876   }
3877   checkAtomicMemAccessSize(ElTy, &RMWI);
3878   Assert(ElTy == RMWI.getOperand(1)->getType(),
3879          "Argument value type does not match pointer operand type!", &RMWI,
3880          ElTy);
3881   Assert(AtomicRMWInst::FIRST_BINOP <= Op && Op <= AtomicRMWInst::LAST_BINOP,
3882          "Invalid binary operation!", &RMWI);
3883   visitInstruction(RMWI);
3884 }
3885 
3886 void Verifier::visitFenceInst(FenceInst &FI) {
3887   const AtomicOrdering Ordering = FI.getOrdering();
3888   Assert(Ordering == AtomicOrdering::Acquire ||
3889              Ordering == AtomicOrdering::Release ||
3890              Ordering == AtomicOrdering::AcquireRelease ||
3891              Ordering == AtomicOrdering::SequentiallyConsistent,
3892          "fence instructions may only have acquire, release, acq_rel, or "
3893          "seq_cst ordering.",
3894          &FI);
3895   visitInstruction(FI);
3896 }
3897 
3898 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
3899   Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3900                                           EVI.getIndices()) == EVI.getType(),
3901          "Invalid ExtractValueInst operands!", &EVI);
3902 
3903   visitInstruction(EVI);
3904 }
3905 
3906 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
3907   Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3908                                           IVI.getIndices()) ==
3909              IVI.getOperand(1)->getType(),
3910          "Invalid InsertValueInst operands!", &IVI);
3911 
3912   visitInstruction(IVI);
3913 }
3914 
3915 static Value *getParentPad(Value *EHPad) {
3916   if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3917     return FPI->getParentPad();
3918 
3919   return cast<CatchSwitchInst>(EHPad)->getParentPad();
3920 }
3921 
3922 void Verifier::visitEHPadPredecessors(Instruction &I) {
3923   assert(I.isEHPad());
3924 
3925   BasicBlock *BB = I.getParent();
3926   Function *F = BB->getParent();
3927 
3928   Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3929 
3930   if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3931     // The landingpad instruction defines its parent as a landing pad block. The
3932     // landing pad block may be branched to only by the unwind edge of an
3933     // invoke.
3934     for (BasicBlock *PredBB : predecessors(BB)) {
3935       const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3936       Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3937              "Block containing LandingPadInst must be jumped to "
3938              "only by the unwind edge of an invoke.",
3939              LPI);
3940     }
3941     return;
3942   }
3943   if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3944     if (!pred_empty(BB))
3945       Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3946              "Block containg CatchPadInst must be jumped to "
3947              "only by its catchswitch.",
3948              CPI);
3949     Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3950            "Catchswitch cannot unwind to one of its catchpads",
3951            CPI->getCatchSwitch(), CPI);
3952     return;
3953   }
3954 
3955   // Verify that each pred has a legal terminator with a legal to/from EH
3956   // pad relationship.
3957   Instruction *ToPad = &I;
3958   Value *ToPadParent = getParentPad(ToPad);
3959   for (BasicBlock *PredBB : predecessors(BB)) {
3960     Instruction *TI = PredBB->getTerminator();
3961     Value *FromPad;
3962     if (auto *II = dyn_cast<InvokeInst>(TI)) {
3963       Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
3964              "EH pad must be jumped to via an unwind edge", ToPad, II);
3965       if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3966         FromPad = Bundle->Inputs[0];
3967       else
3968         FromPad = ConstantTokenNone::get(II->getContext());
3969     } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3970       FromPad = CRI->getOperand(0);
3971       Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3972     } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3973       FromPad = CSI;
3974     } else {
3975       Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3976     }
3977 
3978     // The edge may exit from zero or more nested pads.
3979     SmallSet<Value *, 8> Seen;
3980     for (;; FromPad = getParentPad(FromPad)) {
3981       Assert(FromPad != ToPad,
3982              "EH pad cannot handle exceptions raised within it", FromPad, TI);
3983       if (FromPad == ToPadParent) {
3984         // This is a legal unwind edge.
3985         break;
3986       }
3987       Assert(!isa<ConstantTokenNone>(FromPad),
3988              "A single unwind edge may only enter one EH pad", TI);
3989       Assert(Seen.insert(FromPad).second,
3990              "EH pad jumps through a cycle of pads", FromPad);
3991     }
3992   }
3993 }
3994 
3995 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
3996   // The landingpad instruction is ill-formed if it doesn't have any clauses and
3997   // isn't a cleanup.
3998   Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3999          "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
4000 
4001   visitEHPadPredecessors(LPI);
4002 
4003   if (!LandingPadResultTy)
4004     LandingPadResultTy = LPI.getType();
4005   else
4006     Assert(LandingPadResultTy == LPI.getType(),
4007            "The landingpad instruction should have a consistent result type "
4008            "inside a function.",
4009            &LPI);
4010 
4011   Function *F = LPI.getParent()->getParent();
4012   Assert(F->hasPersonalityFn(),
4013          "LandingPadInst needs to be in a function with a personality.", &LPI);
4014 
4015   // The landingpad instruction must be the first non-PHI instruction in the
4016   // block.
4017   Assert(LPI.getParent()->getLandingPadInst() == &LPI,
4018          "LandingPadInst not the first non-PHI instruction in the block.",
4019          &LPI);
4020 
4021   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
4022     Constant *Clause = LPI.getClause(i);
4023     if (LPI.isCatch(i)) {
4024       Assert(isa<PointerType>(Clause->getType()),
4025              "Catch operand does not have pointer type!", &LPI);
4026     } else {
4027       Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
4028       Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
4029              "Filter operand is not an array of constants!", &LPI);
4030     }
4031   }
4032 
4033   visitInstruction(LPI);
4034 }
4035 
4036 void Verifier::visitResumeInst(ResumeInst &RI) {
4037   Assert(RI.getFunction()->hasPersonalityFn(),
4038          "ResumeInst needs to be in a function with a personality.", &RI);
4039 
4040   if (!LandingPadResultTy)
4041     LandingPadResultTy = RI.getValue()->getType();
4042   else
4043     Assert(LandingPadResultTy == RI.getValue()->getType(),
4044            "The resume instruction should have a consistent result type "
4045            "inside a function.",
4046            &RI);
4047 
4048   visitTerminator(RI);
4049 }
4050 
4051 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
4052   BasicBlock *BB = CPI.getParent();
4053 
4054   Function *F = BB->getParent();
4055   Assert(F->hasPersonalityFn(),
4056          "CatchPadInst needs to be in a function with a personality.", &CPI);
4057 
4058   Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
4059          "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
4060          CPI.getParentPad());
4061 
4062   // The catchpad instruction must be the first non-PHI instruction in the
4063   // block.
4064   Assert(BB->getFirstNonPHI() == &CPI,
4065          "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
4066 
4067   visitEHPadPredecessors(CPI);
4068   visitFuncletPadInst(CPI);
4069 }
4070 
4071 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
4072   Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
4073          "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
4074          CatchReturn.getOperand(0));
4075 
4076   visitTerminator(CatchReturn);
4077 }
4078 
4079 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
4080   BasicBlock *BB = CPI.getParent();
4081 
4082   Function *F = BB->getParent();
4083   Assert(F->hasPersonalityFn(),
4084          "CleanupPadInst needs to be in a function with a personality.", &CPI);
4085 
4086   // The cleanuppad instruction must be the first non-PHI instruction in the
4087   // block.
4088   Assert(BB->getFirstNonPHI() == &CPI,
4089          "CleanupPadInst not the first non-PHI instruction in the block.",
4090          &CPI);
4091 
4092   auto *ParentPad = CPI.getParentPad();
4093   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
4094          "CleanupPadInst has an invalid parent.", &CPI);
4095 
4096   visitEHPadPredecessors(CPI);
4097   visitFuncletPadInst(CPI);
4098 }
4099 
4100 void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
4101   User *FirstUser = nullptr;
4102   Value *FirstUnwindPad = nullptr;
4103   SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
4104   SmallSet<FuncletPadInst *, 8> Seen;
4105 
4106   while (!Worklist.empty()) {
4107     FuncletPadInst *CurrentPad = Worklist.pop_back_val();
4108     Assert(Seen.insert(CurrentPad).second,
4109            "FuncletPadInst must not be nested within itself", CurrentPad);
4110     Value *UnresolvedAncestorPad = nullptr;
4111     for (User *U : CurrentPad->users()) {
4112       BasicBlock *UnwindDest;
4113       if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
4114         UnwindDest = CRI->getUnwindDest();
4115       } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
4116         // We allow catchswitch unwind to caller to nest
4117         // within an outer pad that unwinds somewhere else,
4118         // because catchswitch doesn't have a nounwind variant.
4119         // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
4120         if (CSI->unwindsToCaller())
4121           continue;
4122         UnwindDest = CSI->getUnwindDest();
4123       } else if (auto *II = dyn_cast<InvokeInst>(U)) {
4124         UnwindDest = II->getUnwindDest();
4125       } else if (isa<CallInst>(U)) {
4126         // Calls which don't unwind may be found inside funclet
4127         // pads that unwind somewhere else.  We don't *require*
4128         // such calls to be annotated nounwind.
4129         continue;
4130       } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
4131         // The unwind dest for a cleanup can only be found by
4132         // recursive search.  Add it to the worklist, and we'll
4133         // search for its first use that determines where it unwinds.
4134         Worklist.push_back(CPI);
4135         continue;
4136       } else {
4137         Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
4138         continue;
4139       }
4140 
4141       Value *UnwindPad;
4142       bool ExitsFPI;
4143       if (UnwindDest) {
4144         UnwindPad = UnwindDest->getFirstNonPHI();
4145         if (!cast<Instruction>(UnwindPad)->isEHPad())
4146           continue;
4147         Value *UnwindParent = getParentPad(UnwindPad);
4148         // Ignore unwind edges that don't exit CurrentPad.
4149         if (UnwindParent == CurrentPad)
4150           continue;
4151         // Determine whether the original funclet pad is exited,
4152         // and if we are scanning nested pads determine how many
4153         // of them are exited so we can stop searching their
4154         // children.
4155         Value *ExitedPad = CurrentPad;
4156         ExitsFPI = false;
4157         do {
4158           if (ExitedPad == &FPI) {
4159             ExitsFPI = true;
4160             // Now we can resolve any ancestors of CurrentPad up to
4161             // FPI, but not including FPI since we need to make sure
4162             // to check all direct users of FPI for consistency.
4163             UnresolvedAncestorPad = &FPI;
4164             break;
4165           }
4166           Value *ExitedParent = getParentPad(ExitedPad);
4167           if (ExitedParent == UnwindParent) {
4168             // ExitedPad is the ancestor-most pad which this unwind
4169             // edge exits, so we can resolve up to it, meaning that
4170             // ExitedParent is the first ancestor still unresolved.
4171             UnresolvedAncestorPad = ExitedParent;
4172             break;
4173           }
4174           ExitedPad = ExitedParent;
4175         } while (!isa<ConstantTokenNone>(ExitedPad));
4176       } else {
4177         // Unwinding to caller exits all pads.
4178         UnwindPad = ConstantTokenNone::get(FPI.getContext());
4179         ExitsFPI = true;
4180         UnresolvedAncestorPad = &FPI;
4181       }
4182 
4183       if (ExitsFPI) {
4184         // This unwind edge exits FPI.  Make sure it agrees with other
4185         // such edges.
4186         if (FirstUser) {
4187           Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
4188                                               "pad must have the same unwind "
4189                                               "dest",
4190                  &FPI, U, FirstUser);
4191         } else {
4192           FirstUser = U;
4193           FirstUnwindPad = UnwindPad;
4194           // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
4195           if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
4196               getParentPad(UnwindPad) == getParentPad(&FPI))
4197             SiblingFuncletInfo[&FPI] = cast<Instruction>(U);
4198         }
4199       }
4200       // Make sure we visit all uses of FPI, but for nested pads stop as
4201       // soon as we know where they unwind to.
4202       if (CurrentPad != &FPI)
4203         break;
4204     }
4205     if (UnresolvedAncestorPad) {
4206       if (CurrentPad == UnresolvedAncestorPad) {
4207         // When CurrentPad is FPI itself, we don't mark it as resolved even if
4208         // we've found an unwind edge that exits it, because we need to verify
4209         // all direct uses of FPI.
4210         assert(CurrentPad == &FPI);
4211         continue;
4212       }
4213       // Pop off the worklist any nested pads that we've found an unwind
4214       // destination for.  The pads on the worklist are the uncles,
4215       // great-uncles, etc. of CurrentPad.  We've found an unwind destination
4216       // for all ancestors of CurrentPad up to but not including
4217       // UnresolvedAncestorPad.
4218       Value *ResolvedPad = CurrentPad;
4219       while (!Worklist.empty()) {
4220         Value *UnclePad = Worklist.back();
4221         Value *AncestorPad = getParentPad(UnclePad);
4222         // Walk ResolvedPad up the ancestor list until we either find the
4223         // uncle's parent or the last resolved ancestor.
4224         while (ResolvedPad != AncestorPad) {
4225           Value *ResolvedParent = getParentPad(ResolvedPad);
4226           if (ResolvedParent == UnresolvedAncestorPad) {
4227             break;
4228           }
4229           ResolvedPad = ResolvedParent;
4230         }
4231         // If the resolved ancestor search didn't find the uncle's parent,
4232         // then the uncle is not yet resolved.
4233         if (ResolvedPad != AncestorPad)
4234           break;
4235         // This uncle is resolved, so pop it from the worklist.
4236         Worklist.pop_back();
4237       }
4238     }
4239   }
4240 
4241   if (FirstUnwindPad) {
4242     if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
4243       BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
4244       Value *SwitchUnwindPad;
4245       if (SwitchUnwindDest)
4246         SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
4247       else
4248         SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
4249       Assert(SwitchUnwindPad == FirstUnwindPad,
4250              "Unwind edges out of a catch must have the same unwind dest as "
4251              "the parent catchswitch",
4252              &FPI, FirstUser, CatchSwitch);
4253     }
4254   }
4255 
4256   visitInstruction(FPI);
4257 }
4258 
4259 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
4260   BasicBlock *BB = CatchSwitch.getParent();
4261 
4262   Function *F = BB->getParent();
4263   Assert(F->hasPersonalityFn(),
4264          "CatchSwitchInst needs to be in a function with a personality.",
4265          &CatchSwitch);
4266 
4267   // The catchswitch instruction must be the first non-PHI instruction in the
4268   // block.
4269   Assert(BB->getFirstNonPHI() == &CatchSwitch,
4270          "CatchSwitchInst not the first non-PHI instruction in the block.",
4271          &CatchSwitch);
4272 
4273   auto *ParentPad = CatchSwitch.getParentPad();
4274   Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
4275          "CatchSwitchInst has an invalid parent.", ParentPad);
4276 
4277   if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
4278     Instruction *I = UnwindDest->getFirstNonPHI();
4279     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
4280            "CatchSwitchInst must unwind to an EH block which is not a "
4281            "landingpad.",
4282            &CatchSwitch);
4283 
4284     // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
4285     if (getParentPad(I) == ParentPad)
4286       SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
4287   }
4288 
4289   Assert(CatchSwitch.getNumHandlers() != 0,
4290          "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
4291 
4292   for (BasicBlock *Handler : CatchSwitch.handlers()) {
4293     Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
4294            "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
4295   }
4296 
4297   visitEHPadPredecessors(CatchSwitch);
4298   visitTerminator(CatchSwitch);
4299 }
4300 
4301 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
4302   Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
4303          "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
4304          CRI.getOperand(0));
4305 
4306   if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
4307     Instruction *I = UnwindDest->getFirstNonPHI();
4308     Assert(I->isEHPad() && !isa<LandingPadInst>(I),
4309            "CleanupReturnInst must unwind to an EH block which is not a "
4310            "landingpad.",
4311            &CRI);
4312   }
4313 
4314   visitTerminator(CRI);
4315 }
4316 
4317 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
4318   Instruction *Op = cast<Instruction>(I.getOperand(i));
4319   // If the we have an invalid invoke, don't try to compute the dominance.
4320   // We already reject it in the invoke specific checks and the dominance
4321   // computation doesn't handle multiple edges.
4322   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
4323     if (II->getNormalDest() == II->getUnwindDest())
4324       return;
4325   }
4326 
4327   // Quick check whether the def has already been encountered in the same block.
4328   // PHI nodes are not checked to prevent accepting preceding PHIs, because PHI
4329   // uses are defined to happen on the incoming edge, not at the instruction.
4330   //
4331   // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
4332   // wrapping an SSA value, assert that we've already encountered it.  See
4333   // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
4334   if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
4335     return;
4336 
4337   const Use &U = I.getOperandUse(i);
4338   Assert(DT.dominates(Op, U),
4339          "Instruction does not dominate all uses!", Op, &I);
4340 }
4341 
4342 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
4343   Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
4344          "apply only to pointer types", &I);
4345   Assert((isa<LoadInst>(I) || isa<IntToPtrInst>(I)),
4346          "dereferenceable, dereferenceable_or_null apply only to load"
4347          " and inttoptr instructions, use attributes for calls or invokes", &I);
4348   Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
4349          "take one operand!", &I);
4350   ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
4351   Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
4352          "dereferenceable_or_null metadata value must be an i64!", &I);
4353 }
4354 
4355 void Verifier::visitProfMetadata(Instruction &I, MDNode *MD) {
4356   Assert(MD->getNumOperands() >= 2,
4357          "!prof annotations should have no less than 2 operands", MD);
4358 
4359   // Check first operand.
4360   Assert(MD->getOperand(0) != nullptr, "first operand should not be null", MD);
4361   Assert(isa<MDString>(MD->getOperand(0)),
4362          "expected string with name of the !prof annotation", MD);
4363   MDString *MDS = cast<MDString>(MD->getOperand(0));
4364   StringRef ProfName = MDS->getString();
4365 
4366   // Check consistency of !prof branch_weights metadata.
4367   if (ProfName.equals("branch_weights")) {
4368     if (isa<InvokeInst>(&I)) {
4369       Assert(MD->getNumOperands() == 2 || MD->getNumOperands() == 3,
4370              "Wrong number of InvokeInst branch_weights operands", MD);
4371     } else {
4372       unsigned ExpectedNumOperands = 0;
4373       if (BranchInst *BI = dyn_cast<BranchInst>(&I))
4374         ExpectedNumOperands = BI->getNumSuccessors();
4375       else if (SwitchInst *SI = dyn_cast<SwitchInst>(&I))
4376         ExpectedNumOperands = SI->getNumSuccessors();
4377       else if (isa<CallInst>(&I))
4378         ExpectedNumOperands = 1;
4379       else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(&I))
4380         ExpectedNumOperands = IBI->getNumDestinations();
4381       else if (isa<SelectInst>(&I))
4382         ExpectedNumOperands = 2;
4383       else
4384         CheckFailed("!prof branch_weights are not allowed for this instruction",
4385                     MD);
4386 
4387       Assert(MD->getNumOperands() == 1 + ExpectedNumOperands,
4388              "Wrong number of operands", MD);
4389     }
4390     for (unsigned i = 1; i < MD->getNumOperands(); ++i) {
4391       auto &MDO = MD->getOperand(i);
4392       Assert(MDO, "second operand should not be null", MD);
4393       Assert(mdconst::dyn_extract<ConstantInt>(MDO),
4394              "!prof brunch_weights operand is not a const int");
4395     }
4396   }
4397 }
4398 
4399 void Verifier::visitAnnotationMetadata(MDNode *Annotation) {
4400   Assert(isa<MDTuple>(Annotation), "annotation must be a tuple");
4401   Assert(Annotation->getNumOperands() >= 1,
4402          "annotation must have at least one operand");
4403   for (const MDOperand &Op : Annotation->operands())
4404     Assert(isa<MDString>(Op.get()), "operands must be strings");
4405 }
4406 
4407 /// verifyInstruction - Verify that an instruction is well formed.
4408 ///
4409 void Verifier::visitInstruction(Instruction &I) {
4410   BasicBlock *BB = I.getParent();
4411   Assert(BB, "Instruction not embedded in basic block!", &I);
4412 
4413   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
4414     for (User *U : I.users()) {
4415       Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
4416              "Only PHI nodes may reference their own value!", &I);
4417     }
4418   }
4419 
4420   // Check that void typed values don't have names
4421   Assert(!I.getType()->isVoidTy() || !I.hasName(),
4422          "Instruction has a name, but provides a void value!", &I);
4423 
4424   // Check that the return value of the instruction is either void or a legal
4425   // value type.
4426   Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
4427          "Instruction returns a non-scalar type!", &I);
4428 
4429   // Check that the instruction doesn't produce metadata. Calls are already
4430   // checked against the callee type.
4431   Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
4432          "Invalid use of metadata!", &I);
4433 
4434   // Check that all uses of the instruction, if they are instructions
4435   // themselves, actually have parent basic blocks.  If the use is not an
4436   // instruction, it is an error!
4437   for (Use &U : I.uses()) {
4438     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
4439       Assert(Used->getParent() != nullptr,
4440              "Instruction referencing"
4441              " instruction not embedded in a basic block!",
4442              &I, Used);
4443     else {
4444       CheckFailed("Use of instruction is not an instruction!", U);
4445       return;
4446     }
4447   }
4448 
4449   // Get a pointer to the call base of the instruction if it is some form of
4450   // call.
4451   const CallBase *CBI = dyn_cast<CallBase>(&I);
4452 
4453   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
4454     Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
4455 
4456     // Check to make sure that only first-class-values are operands to
4457     // instructions.
4458     if (!I.getOperand(i)->getType()->isFirstClassType()) {
4459       Assert(false, "Instruction operands must be first-class values!", &I);
4460     }
4461 
4462     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
4463       // Check to make sure that the "address of" an intrinsic function is never
4464       // taken.
4465       Assert(!F->isIntrinsic() ||
4466                  (CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i)),
4467              "Cannot take the address of an intrinsic!", &I);
4468       Assert(
4469           !F->isIntrinsic() || isa<CallInst>(I) ||
4470               F->getIntrinsicID() == Intrinsic::donothing ||
4471               F->getIntrinsicID() == Intrinsic::coro_resume ||
4472               F->getIntrinsicID() == Intrinsic::coro_destroy ||
4473               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
4474               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
4475               F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint ||
4476               F->getIntrinsicID() == Intrinsic::wasm_rethrow,
4477           "Cannot invoke an intrinsic other than donothing, patchpoint, "
4478           "statepoint, coro_resume or coro_destroy",
4479           &I);
4480       Assert(F->getParent() == &M, "Referencing function in another module!",
4481              &I, &M, F, F->getParent());
4482     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
4483       Assert(OpBB->getParent() == BB->getParent(),
4484              "Referring to a basic block in another function!", &I);
4485     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
4486       Assert(OpArg->getParent() == BB->getParent(),
4487              "Referring to an argument in another function!", &I);
4488     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
4489       Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
4490              &M, GV, GV->getParent());
4491     } else if (isa<Instruction>(I.getOperand(i))) {
4492       verifyDominatesUse(I, i);
4493     } else if (isa<InlineAsm>(I.getOperand(i))) {
4494       Assert(CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i),
4495              "Cannot take the address of an inline asm!", &I);
4496     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
4497       if (CE->getType()->isPtrOrPtrVectorTy() ||
4498           !DL.getNonIntegralAddressSpaces().empty()) {
4499         // If we have a ConstantExpr pointer, we need to see if it came from an
4500         // illegal bitcast.  If the datalayout string specifies non-integral
4501         // address spaces then we also need to check for illegal ptrtoint and
4502         // inttoptr expressions.
4503         visitConstantExprsRecursively(CE);
4504       }
4505     }
4506   }
4507 
4508   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
4509     Assert(I.getType()->isFPOrFPVectorTy(),
4510            "fpmath requires a floating point result!", &I);
4511     Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
4512     if (ConstantFP *CFP0 =
4513             mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
4514       const APFloat &Accuracy = CFP0->getValueAPF();
4515       Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
4516              "fpmath accuracy must have float type", &I);
4517       Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
4518              "fpmath accuracy not a positive number!", &I);
4519     } else {
4520       Assert(false, "invalid fpmath accuracy!", &I);
4521     }
4522   }
4523 
4524   if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
4525     Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
4526            "Ranges are only for loads, calls and invokes!", &I);
4527     visitRangeMetadata(I, Range, I.getType());
4528   }
4529 
4530   if (I.getMetadata(LLVMContext::MD_nonnull)) {
4531     Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
4532            &I);
4533     Assert(isa<LoadInst>(I),
4534            "nonnull applies only to load instructions, use attributes"
4535            " for calls or invokes",
4536            &I);
4537   }
4538 
4539   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
4540     visitDereferenceableMetadata(I, MD);
4541 
4542   if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
4543     visitDereferenceableMetadata(I, MD);
4544 
4545   if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
4546     TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
4547 
4548   if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
4549     Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
4550            &I);
4551     Assert(isa<LoadInst>(I), "align applies only to load instructions, "
4552            "use attributes for calls or invokes", &I);
4553     Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
4554     ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
4555     Assert(CI && CI->getType()->isIntegerTy(64),
4556            "align metadata value must be an i64!", &I);
4557     uint64_t Align = CI->getZExtValue();
4558     Assert(isPowerOf2_64(Align),
4559            "align metadata value must be a power of 2!", &I);
4560     Assert(Align <= Value::MaximumAlignment,
4561            "alignment is larger that implementation defined limit", &I);
4562   }
4563 
4564   if (MDNode *MD = I.getMetadata(LLVMContext::MD_prof))
4565     visitProfMetadata(I, MD);
4566 
4567   if (MDNode *Annotation = I.getMetadata(LLVMContext::MD_annotation))
4568     visitAnnotationMetadata(Annotation);
4569 
4570   if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
4571     AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
4572     visitMDNode(*N, AreDebugLocsAllowed::Yes);
4573   }
4574 
4575   if (auto *DII = dyn_cast<DbgVariableIntrinsic>(&I)) {
4576     verifyFragmentExpression(*DII);
4577     verifyNotEntryValue(*DII);
4578   }
4579 
4580   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4581   I.getAllMetadata(MDs);
4582   for (auto Attachment : MDs) {
4583     unsigned Kind = Attachment.first;
4584     auto AllowLocs =
4585         (Kind == LLVMContext::MD_dbg || Kind == LLVMContext::MD_loop)
4586             ? AreDebugLocsAllowed::Yes
4587             : AreDebugLocsAllowed::No;
4588     visitMDNode(*Attachment.second, AllowLocs);
4589   }
4590 
4591   InstsInThisBlock.insert(&I);
4592 }
4593 
4594 /// Allow intrinsics to be verified in different ways.
4595 void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) {
4596   Function *IF = Call.getCalledFunction();
4597   Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
4598          IF);
4599 
4600   // Verify that the intrinsic prototype lines up with what the .td files
4601   // describe.
4602   FunctionType *IFTy = IF->getFunctionType();
4603   bool IsVarArg = IFTy->isVarArg();
4604 
4605   SmallVector<Intrinsic::IITDescriptor, 8> Table;
4606   getIntrinsicInfoTableEntries(ID, Table);
4607   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
4608 
4609   // Walk the descriptors to extract overloaded types.
4610   SmallVector<Type *, 4> ArgTys;
4611   Intrinsic::MatchIntrinsicTypesResult Res =
4612       Intrinsic::matchIntrinsicSignature(IFTy, TableRef, ArgTys);
4613   Assert(Res != Intrinsic::MatchIntrinsicTypes_NoMatchRet,
4614          "Intrinsic has incorrect return type!", IF);
4615   Assert(Res != Intrinsic::MatchIntrinsicTypes_NoMatchArg,
4616          "Intrinsic has incorrect argument type!", IF);
4617 
4618   // Verify if the intrinsic call matches the vararg property.
4619   if (IsVarArg)
4620     Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
4621            "Intrinsic was not defined with variable arguments!", IF);
4622   else
4623     Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
4624            "Callsite was not defined with variable arguments!", IF);
4625 
4626   // All descriptors should be absorbed by now.
4627   Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
4628 
4629   // Now that we have the intrinsic ID and the actual argument types (and we
4630   // know they are legal for the intrinsic!) get the intrinsic name through the
4631   // usual means.  This allows us to verify the mangling of argument types into
4632   // the name.
4633   const std::string ExpectedName =
4634       Intrinsic::getName(ID, ArgTys, IF->getParent(), IFTy);
4635   Assert(ExpectedName == IF->getName(),
4636          "Intrinsic name not mangled correctly for type arguments! "
4637          "Should be: " +
4638              ExpectedName,
4639          IF);
4640 
4641   // If the intrinsic takes MDNode arguments, verify that they are either global
4642   // or are local to *this* function.
4643   for (Value *V : Call.args()) {
4644     if (auto *MD = dyn_cast<MetadataAsValue>(V))
4645       visitMetadataAsValue(*MD, Call.getCaller());
4646     if (auto *Const = dyn_cast<Constant>(V))
4647       Assert(!Const->getType()->isX86_AMXTy(),
4648              "const x86_amx is not allowed in argument!");
4649   }
4650 
4651   switch (ID) {
4652   default:
4653     break;
4654   case Intrinsic::assume: {
4655     for (auto &Elem : Call.bundle_op_infos()) {
4656       Assert(Elem.Tag->getKey() == "ignore" ||
4657                  Attribute::isExistingAttribute(Elem.Tag->getKey()),
4658              "tags must be valid attribute names");
4659       Attribute::AttrKind Kind =
4660           Attribute::getAttrKindFromName(Elem.Tag->getKey());
4661       unsigned ArgCount = Elem.End - Elem.Begin;
4662       if (Kind == Attribute::Alignment) {
4663         Assert(ArgCount <= 3 && ArgCount >= 2,
4664                "alignment assumptions should have 2 or 3 arguments");
4665         Assert(Call.getOperand(Elem.Begin)->getType()->isPointerTy(),
4666                "first argument should be a pointer");
4667         Assert(Call.getOperand(Elem.Begin + 1)->getType()->isIntegerTy(),
4668                "second argument should be an integer");
4669         if (ArgCount == 3)
4670           Assert(Call.getOperand(Elem.Begin + 2)->getType()->isIntegerTy(),
4671                  "third argument should be an integer if present");
4672         return;
4673       }
4674       Assert(ArgCount <= 2, "to many arguments");
4675       if (Kind == Attribute::None)
4676         break;
4677       if (Attribute::doesAttrKindHaveArgument(Kind)) {
4678         Assert(ArgCount == 2, "this attribute should have 2 arguments");
4679         Assert(isa<ConstantInt>(Call.getOperand(Elem.Begin + 1)),
4680                "the second argument should be a constant integral value");
4681       } else if (isFuncOnlyAttr(Kind)) {
4682         Assert((ArgCount) == 0, "this attribute has no argument");
4683       } else if (!isFuncOrArgAttr(Kind)) {
4684         Assert((ArgCount) == 1, "this attribute should have one argument");
4685       }
4686     }
4687     break;
4688   }
4689   case Intrinsic::coro_id: {
4690     auto *InfoArg = Call.getArgOperand(3)->stripPointerCasts();
4691     if (isa<ConstantPointerNull>(InfoArg))
4692       break;
4693     auto *GV = dyn_cast<GlobalVariable>(InfoArg);
4694     Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
4695            "info argument of llvm.coro.id must refer to an initialized "
4696            "constant");
4697     Constant *Init = GV->getInitializer();
4698     Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
4699            "info argument of llvm.coro.id must refer to either a struct or "
4700            "an array");
4701     break;
4702   }
4703 #define INSTRUCTION(NAME, NARGS, ROUND_MODE, INTRINSIC)                        \
4704   case Intrinsic::INTRINSIC:
4705 #include "llvm/IR/ConstrainedOps.def"
4706     visitConstrainedFPIntrinsic(cast<ConstrainedFPIntrinsic>(Call));
4707     break;
4708   case Intrinsic::dbg_declare: // llvm.dbg.declare
4709     Assert(isa<MetadataAsValue>(Call.getArgOperand(0)),
4710            "invalid llvm.dbg.declare intrinsic call 1", Call);
4711     visitDbgIntrinsic("declare", cast<DbgVariableIntrinsic>(Call));
4712     break;
4713   case Intrinsic::dbg_addr: // llvm.dbg.addr
4714     visitDbgIntrinsic("addr", cast<DbgVariableIntrinsic>(Call));
4715     break;
4716   case Intrinsic::dbg_value: // llvm.dbg.value
4717     visitDbgIntrinsic("value", cast<DbgVariableIntrinsic>(Call));
4718     break;
4719   case Intrinsic::dbg_label: // llvm.dbg.label
4720     visitDbgLabelIntrinsic("label", cast<DbgLabelInst>(Call));
4721     break;
4722   case Intrinsic::memcpy:
4723   case Intrinsic::memcpy_inline:
4724   case Intrinsic::memmove:
4725   case Intrinsic::memset: {
4726     const auto *MI = cast<MemIntrinsic>(&Call);
4727     auto IsValidAlignment = [&](unsigned Alignment) -> bool {
4728       return Alignment == 0 || isPowerOf2_32(Alignment);
4729     };
4730     Assert(IsValidAlignment(MI->getDestAlignment()),
4731            "alignment of arg 0 of memory intrinsic must be 0 or a power of 2",
4732            Call);
4733     if (const auto *MTI = dyn_cast<MemTransferInst>(MI)) {
4734       Assert(IsValidAlignment(MTI->getSourceAlignment()),
4735              "alignment of arg 1 of memory intrinsic must be 0 or a power of 2",
4736              Call);
4737     }
4738 
4739     break;
4740   }
4741   case Intrinsic::memcpy_element_unordered_atomic:
4742   case Intrinsic::memmove_element_unordered_atomic:
4743   case Intrinsic::memset_element_unordered_atomic: {
4744     const auto *AMI = cast<AtomicMemIntrinsic>(&Call);
4745 
4746     ConstantInt *ElementSizeCI =
4747         cast<ConstantInt>(AMI->getRawElementSizeInBytes());
4748     const APInt &ElementSizeVal = ElementSizeCI->getValue();
4749     Assert(ElementSizeVal.isPowerOf2(),
4750            "element size of the element-wise atomic memory intrinsic "
4751            "must be a power of 2",
4752            Call);
4753 
4754     auto IsValidAlignment = [&](uint64_t Alignment) {
4755       return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4756     };
4757     uint64_t DstAlignment = AMI->getDestAlignment();
4758     Assert(IsValidAlignment(DstAlignment),
4759            "incorrect alignment of the destination argument", Call);
4760     if (const auto *AMT = dyn_cast<AtomicMemTransferInst>(AMI)) {
4761       uint64_t SrcAlignment = AMT->getSourceAlignment();
4762       Assert(IsValidAlignment(SrcAlignment),
4763              "incorrect alignment of the source argument", Call);
4764     }
4765     break;
4766   }
4767   case Intrinsic::call_preallocated_setup: {
4768     auto *NumArgs = dyn_cast<ConstantInt>(Call.getArgOperand(0));
4769     Assert(NumArgs != nullptr,
4770            "llvm.call.preallocated.setup argument must be a constant");
4771     bool FoundCall = false;
4772     for (User *U : Call.users()) {
4773       auto *UseCall = dyn_cast<CallBase>(U);
4774       Assert(UseCall != nullptr,
4775              "Uses of llvm.call.preallocated.setup must be calls");
4776       const Function *Fn = UseCall->getCalledFunction();
4777       if (Fn && Fn->getIntrinsicID() == Intrinsic::call_preallocated_arg) {
4778         auto *AllocArgIndex = dyn_cast<ConstantInt>(UseCall->getArgOperand(1));
4779         Assert(AllocArgIndex != nullptr,
4780                "llvm.call.preallocated.alloc arg index must be a constant");
4781         auto AllocArgIndexInt = AllocArgIndex->getValue();
4782         Assert(AllocArgIndexInt.sge(0) &&
4783                    AllocArgIndexInt.slt(NumArgs->getValue()),
4784                "llvm.call.preallocated.alloc arg index must be between 0 and "
4785                "corresponding "
4786                "llvm.call.preallocated.setup's argument count");
4787       } else if (Fn && Fn->getIntrinsicID() ==
4788                            Intrinsic::call_preallocated_teardown) {
4789         // nothing to do
4790       } else {
4791         Assert(!FoundCall, "Can have at most one call corresponding to a "
4792                            "llvm.call.preallocated.setup");
4793         FoundCall = true;
4794         size_t NumPreallocatedArgs = 0;
4795         for (unsigned i = 0; i < UseCall->getNumArgOperands(); i++) {
4796           if (UseCall->paramHasAttr(i, Attribute::Preallocated)) {
4797             ++NumPreallocatedArgs;
4798           }
4799         }
4800         Assert(NumPreallocatedArgs != 0,
4801                "cannot use preallocated intrinsics on a call without "
4802                "preallocated arguments");
4803         Assert(NumArgs->equalsInt(NumPreallocatedArgs),
4804                "llvm.call.preallocated.setup arg size must be equal to number "
4805                "of preallocated arguments "
4806                "at call site",
4807                Call, *UseCall);
4808         // getOperandBundle() cannot be called if more than one of the operand
4809         // bundle exists. There is already a check elsewhere for this, so skip
4810         // here if we see more than one.
4811         if (UseCall->countOperandBundlesOfType(LLVMContext::OB_preallocated) >
4812             1) {
4813           return;
4814         }
4815         auto PreallocatedBundle =
4816             UseCall->getOperandBundle(LLVMContext::OB_preallocated);
4817         Assert(PreallocatedBundle,
4818                "Use of llvm.call.preallocated.setup outside intrinsics "
4819                "must be in \"preallocated\" operand bundle");
4820         Assert(PreallocatedBundle->Inputs.front().get() == &Call,
4821                "preallocated bundle must have token from corresponding "
4822                "llvm.call.preallocated.setup");
4823       }
4824     }
4825     break;
4826   }
4827   case Intrinsic::call_preallocated_arg: {
4828     auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
4829     Assert(Token && Token->getCalledFunction()->getIntrinsicID() ==
4830                         Intrinsic::call_preallocated_setup,
4831            "llvm.call.preallocated.arg token argument must be a "
4832            "llvm.call.preallocated.setup");
4833     Assert(Call.hasFnAttr(Attribute::Preallocated),
4834            "llvm.call.preallocated.arg must be called with a \"preallocated\" "
4835            "call site attribute");
4836     break;
4837   }
4838   case Intrinsic::call_preallocated_teardown: {
4839     auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
4840     Assert(Token && Token->getCalledFunction()->getIntrinsicID() ==
4841                         Intrinsic::call_preallocated_setup,
4842            "llvm.call.preallocated.teardown token argument must be a "
4843            "llvm.call.preallocated.setup");
4844     break;
4845   }
4846   case Intrinsic::gcroot:
4847   case Intrinsic::gcwrite:
4848   case Intrinsic::gcread:
4849     if (ID == Intrinsic::gcroot) {
4850       AllocaInst *AI =
4851           dyn_cast<AllocaInst>(Call.getArgOperand(0)->stripPointerCasts());
4852       Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", Call);
4853       Assert(isa<Constant>(Call.getArgOperand(1)),
4854              "llvm.gcroot parameter #2 must be a constant.", Call);
4855       if (!AI->getAllocatedType()->isPointerTy()) {
4856         Assert(!isa<ConstantPointerNull>(Call.getArgOperand(1)),
4857                "llvm.gcroot parameter #1 must either be a pointer alloca, "
4858                "or argument #2 must be a non-null constant.",
4859                Call);
4860       }
4861     }
4862 
4863     Assert(Call.getParent()->getParent()->hasGC(),
4864            "Enclosing function does not use GC.", Call);
4865     break;
4866   case Intrinsic::init_trampoline:
4867     Assert(isa<Function>(Call.getArgOperand(1)->stripPointerCasts()),
4868            "llvm.init_trampoline parameter #2 must resolve to a function.",
4869            Call);
4870     break;
4871   case Intrinsic::prefetch:
4872     Assert(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2 &&
4873            cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 4,
4874            "invalid arguments to llvm.prefetch", Call);
4875     break;
4876   case Intrinsic::stackprotector:
4877     Assert(isa<AllocaInst>(Call.getArgOperand(1)->stripPointerCasts()),
4878            "llvm.stackprotector parameter #2 must resolve to an alloca.", Call);
4879     break;
4880   case Intrinsic::localescape: {
4881     BasicBlock *BB = Call.getParent();
4882     Assert(BB == &BB->getParent()->front(),
4883            "llvm.localescape used outside of entry block", Call);
4884     Assert(!SawFrameEscape,
4885            "multiple calls to llvm.localescape in one function", Call);
4886     for (Value *Arg : Call.args()) {
4887       if (isa<ConstantPointerNull>(Arg))
4888         continue; // Null values are allowed as placeholders.
4889       auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
4890       Assert(AI && AI->isStaticAlloca(),
4891              "llvm.localescape only accepts static allocas", Call);
4892     }
4893     FrameEscapeInfo[BB->getParent()].first = Call.getNumArgOperands();
4894     SawFrameEscape = true;
4895     break;
4896   }
4897   case Intrinsic::localrecover: {
4898     Value *FnArg = Call.getArgOperand(0)->stripPointerCasts();
4899     Function *Fn = dyn_cast<Function>(FnArg);
4900     Assert(Fn && !Fn->isDeclaration(),
4901            "llvm.localrecover first "
4902            "argument must be function defined in this module",
4903            Call);
4904     auto *IdxArg = cast<ConstantInt>(Call.getArgOperand(2));
4905     auto &Entry = FrameEscapeInfo[Fn];
4906     Entry.second = unsigned(
4907         std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
4908     break;
4909   }
4910 
4911   case Intrinsic::experimental_gc_statepoint:
4912     if (auto *CI = dyn_cast<CallInst>(&Call))
4913       Assert(!CI->isInlineAsm(),
4914              "gc.statepoint support for inline assembly unimplemented", CI);
4915     Assert(Call.getParent()->getParent()->hasGC(),
4916            "Enclosing function does not use GC.", Call);
4917 
4918     verifyStatepoint(Call);
4919     break;
4920   case Intrinsic::experimental_gc_result: {
4921     Assert(Call.getParent()->getParent()->hasGC(),
4922            "Enclosing function does not use GC.", Call);
4923     // Are we tied to a statepoint properly?
4924     const auto *StatepointCall = dyn_cast<CallBase>(Call.getArgOperand(0));
4925     const Function *StatepointFn =
4926         StatepointCall ? StatepointCall->getCalledFunction() : nullptr;
4927     Assert(StatepointFn && StatepointFn->isDeclaration() &&
4928                StatepointFn->getIntrinsicID() ==
4929                    Intrinsic::experimental_gc_statepoint,
4930            "gc.result operand #1 must be from a statepoint", Call,
4931            Call.getArgOperand(0));
4932 
4933     // Assert that result type matches wrapped callee.
4934     const Value *Target = StatepointCall->getArgOperand(2);
4935     auto *PT = cast<PointerType>(Target->getType());
4936     auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
4937     Assert(Call.getType() == TargetFuncType->getReturnType(),
4938            "gc.result result type does not match wrapped callee", Call);
4939     break;
4940   }
4941   case Intrinsic::experimental_gc_relocate: {
4942     Assert(Call.getNumArgOperands() == 3, "wrong number of arguments", Call);
4943 
4944     Assert(isa<PointerType>(Call.getType()->getScalarType()),
4945            "gc.relocate must return a pointer or a vector of pointers", Call);
4946 
4947     // Check that this relocate is correctly tied to the statepoint
4948 
4949     // This is case for relocate on the unwinding path of an invoke statepoint
4950     if (LandingPadInst *LandingPad =
4951             dyn_cast<LandingPadInst>(Call.getArgOperand(0))) {
4952 
4953       const BasicBlock *InvokeBB =
4954           LandingPad->getParent()->getUniquePredecessor();
4955 
4956       // Landingpad relocates should have only one predecessor with invoke
4957       // statepoint terminator
4958       Assert(InvokeBB, "safepoints should have unique landingpads",
4959              LandingPad->getParent());
4960       Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4961              InvokeBB);
4962       Assert(isa<GCStatepointInst>(InvokeBB->getTerminator()),
4963              "gc relocate should be linked to a statepoint", InvokeBB);
4964     } else {
4965       // In all other cases relocate should be tied to the statepoint directly.
4966       // This covers relocates on a normal return path of invoke statepoint and
4967       // relocates of a call statepoint.
4968       auto Token = Call.getArgOperand(0);
4969       Assert(isa<GCStatepointInst>(Token),
4970              "gc relocate is incorrectly tied to the statepoint", Call, Token);
4971     }
4972 
4973     // Verify rest of the relocate arguments.
4974     const CallBase &StatepointCall =
4975       *cast<GCRelocateInst>(Call).getStatepoint();
4976 
4977     // Both the base and derived must be piped through the safepoint.
4978     Value *Base = Call.getArgOperand(1);
4979     Assert(isa<ConstantInt>(Base),
4980            "gc.relocate operand #2 must be integer offset", Call);
4981 
4982     Value *Derived = Call.getArgOperand(2);
4983     Assert(isa<ConstantInt>(Derived),
4984            "gc.relocate operand #3 must be integer offset", Call);
4985 
4986     const uint64_t BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4987     const uint64_t DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4988 
4989     // Check the bounds
4990     if (auto Opt = StatepointCall.getOperandBundle(LLVMContext::OB_gc_live)) {
4991       Assert(BaseIndex < Opt->Inputs.size(),
4992              "gc.relocate: statepoint base index out of bounds", Call);
4993       Assert(DerivedIndex < Opt->Inputs.size(),
4994              "gc.relocate: statepoint derived index out of bounds", Call);
4995     }
4996 
4997     // Relocated value must be either a pointer type or vector-of-pointer type,
4998     // but gc_relocate does not need to return the same pointer type as the
4999     // relocated pointer. It can be casted to the correct type later if it's
5000     // desired. However, they must have the same address space and 'vectorness'
5001     GCRelocateInst &Relocate = cast<GCRelocateInst>(Call);
5002     Assert(Relocate.getDerivedPtr()->getType()->isPtrOrPtrVectorTy(),
5003            "gc.relocate: relocated value must be a gc pointer", Call);
5004 
5005     auto ResultType = Call.getType();
5006     auto DerivedType = Relocate.getDerivedPtr()->getType();
5007     Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
5008            "gc.relocate: vector relocates to vector and pointer to pointer",
5009            Call);
5010     Assert(
5011         ResultType->getPointerAddressSpace() ==
5012             DerivedType->getPointerAddressSpace(),
5013         "gc.relocate: relocating a pointer shouldn't change its address space",
5014         Call);
5015     break;
5016   }
5017   case Intrinsic::eh_exceptioncode:
5018   case Intrinsic::eh_exceptionpointer: {
5019     Assert(isa<CatchPadInst>(Call.getArgOperand(0)),
5020            "eh.exceptionpointer argument must be a catchpad", Call);
5021     break;
5022   }
5023   case Intrinsic::get_active_lane_mask: {
5024     Assert(Call.getType()->isVectorTy(), "get_active_lane_mask: must return a "
5025            "vector", Call);
5026     auto *ElemTy = Call.getType()->getScalarType();
5027     Assert(ElemTy->isIntegerTy(1), "get_active_lane_mask: element type is not "
5028            "i1", Call);
5029     break;
5030   }
5031   case Intrinsic::masked_load: {
5032     Assert(Call.getType()->isVectorTy(), "masked_load: must return a vector",
5033            Call);
5034 
5035     Value *Ptr = Call.getArgOperand(0);
5036     ConstantInt *Alignment = cast<ConstantInt>(Call.getArgOperand(1));
5037     Value *Mask = Call.getArgOperand(2);
5038     Value *PassThru = Call.getArgOperand(3);
5039     Assert(Mask->getType()->isVectorTy(), "masked_load: mask must be vector",
5040            Call);
5041     Assert(Alignment->getValue().isPowerOf2(),
5042            "masked_load: alignment must be a power of 2", Call);
5043 
5044     // DataTy is the overloaded type
5045     Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
5046     Assert(DataTy == Call.getType(),
5047            "masked_load: return must match pointer type", Call);
5048     Assert(PassThru->getType() == DataTy,
5049            "masked_load: pass through and data type must match", Call);
5050     Assert(cast<VectorType>(Mask->getType())->getElementCount() ==
5051                cast<VectorType>(DataTy)->getElementCount(),
5052            "masked_load: vector mask must be same length as data", Call);
5053     break;
5054   }
5055   case Intrinsic::masked_store: {
5056     Value *Val = Call.getArgOperand(0);
5057     Value *Ptr = Call.getArgOperand(1);
5058     ConstantInt *Alignment = cast<ConstantInt>(Call.getArgOperand(2));
5059     Value *Mask = Call.getArgOperand(3);
5060     Assert(Mask->getType()->isVectorTy(), "masked_store: mask must be vector",
5061            Call);
5062     Assert(Alignment->getValue().isPowerOf2(),
5063            "masked_store: alignment must be a power of 2", Call);
5064 
5065     // DataTy is the overloaded type
5066     Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
5067     Assert(DataTy == Val->getType(),
5068            "masked_store: storee must match pointer type", Call);
5069     Assert(cast<VectorType>(Mask->getType())->getElementCount() ==
5070                cast<VectorType>(DataTy)->getElementCount(),
5071            "masked_store: vector mask must be same length as data", Call);
5072     break;
5073   }
5074 
5075   case Intrinsic::masked_gather: {
5076     const APInt &Alignment =
5077         cast<ConstantInt>(Call.getArgOperand(1))->getValue();
5078     Assert(Alignment.isNullValue() || Alignment.isPowerOf2(),
5079            "masked_gather: alignment must be 0 or a power of 2", Call);
5080     break;
5081   }
5082   case Intrinsic::masked_scatter: {
5083     const APInt &Alignment =
5084         cast<ConstantInt>(Call.getArgOperand(2))->getValue();
5085     Assert(Alignment.isNullValue() || Alignment.isPowerOf2(),
5086            "masked_scatter: alignment must be 0 or a power of 2", Call);
5087     break;
5088   }
5089 
5090   case Intrinsic::experimental_guard: {
5091     Assert(isa<CallInst>(Call), "experimental_guard cannot be invoked", Call);
5092     Assert(Call.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
5093            "experimental_guard must have exactly one "
5094            "\"deopt\" operand bundle");
5095     break;
5096   }
5097 
5098   case Intrinsic::experimental_deoptimize: {
5099     Assert(isa<CallInst>(Call), "experimental_deoptimize cannot be invoked",
5100            Call);
5101     Assert(Call.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
5102            "experimental_deoptimize must have exactly one "
5103            "\"deopt\" operand bundle");
5104     Assert(Call.getType() == Call.getFunction()->getReturnType(),
5105            "experimental_deoptimize return type must match caller return type");
5106 
5107     if (isa<CallInst>(Call)) {
5108       auto *RI = dyn_cast<ReturnInst>(Call.getNextNode());
5109       Assert(RI,
5110              "calls to experimental_deoptimize must be followed by a return");
5111 
5112       if (!Call.getType()->isVoidTy() && RI)
5113         Assert(RI->getReturnValue() == &Call,
5114                "calls to experimental_deoptimize must be followed by a return "
5115                "of the value computed by experimental_deoptimize");
5116     }
5117 
5118     break;
5119   }
5120   case Intrinsic::vector_reduce_and:
5121   case Intrinsic::vector_reduce_or:
5122   case Intrinsic::vector_reduce_xor:
5123   case Intrinsic::vector_reduce_add:
5124   case Intrinsic::vector_reduce_mul:
5125   case Intrinsic::vector_reduce_smax:
5126   case Intrinsic::vector_reduce_smin:
5127   case Intrinsic::vector_reduce_umax:
5128   case Intrinsic::vector_reduce_umin: {
5129     Type *ArgTy = Call.getArgOperand(0)->getType();
5130     Assert(ArgTy->isIntOrIntVectorTy() && ArgTy->isVectorTy(),
5131            "Intrinsic has incorrect argument type!");
5132     break;
5133   }
5134   case Intrinsic::vector_reduce_fmax:
5135   case Intrinsic::vector_reduce_fmin: {
5136     Type *ArgTy = Call.getArgOperand(0)->getType();
5137     Assert(ArgTy->isFPOrFPVectorTy() && ArgTy->isVectorTy(),
5138            "Intrinsic has incorrect argument type!");
5139     break;
5140   }
5141   case Intrinsic::vector_reduce_fadd:
5142   case Intrinsic::vector_reduce_fmul: {
5143     // Unlike the other reductions, the first argument is a start value. The
5144     // second argument is the vector to be reduced.
5145     Type *ArgTy = Call.getArgOperand(1)->getType();
5146     Assert(ArgTy->isFPOrFPVectorTy() && ArgTy->isVectorTy(),
5147            "Intrinsic has incorrect argument type!");
5148     break;
5149   }
5150   case Intrinsic::smul_fix:
5151   case Intrinsic::smul_fix_sat:
5152   case Intrinsic::umul_fix:
5153   case Intrinsic::umul_fix_sat:
5154   case Intrinsic::sdiv_fix:
5155   case Intrinsic::sdiv_fix_sat:
5156   case Intrinsic::udiv_fix:
5157   case Intrinsic::udiv_fix_sat: {
5158     Value *Op1 = Call.getArgOperand(0);
5159     Value *Op2 = Call.getArgOperand(1);
5160     Assert(Op1->getType()->isIntOrIntVectorTy(),
5161            "first operand of [us][mul|div]_fix[_sat] must be an int type or "
5162            "vector of ints");
5163     Assert(Op2->getType()->isIntOrIntVectorTy(),
5164            "second operand of [us][mul|div]_fix[_sat] must be an int type or "
5165            "vector of ints");
5166 
5167     auto *Op3 = cast<ConstantInt>(Call.getArgOperand(2));
5168     Assert(Op3->getType()->getBitWidth() <= 32,
5169            "third argument of [us][mul|div]_fix[_sat] must fit within 32 bits");
5170 
5171     if (ID == Intrinsic::smul_fix || ID == Intrinsic::smul_fix_sat ||
5172         ID == Intrinsic::sdiv_fix || ID == Intrinsic::sdiv_fix_sat) {
5173       Assert(
5174           Op3->getZExtValue() < Op1->getType()->getScalarSizeInBits(),
5175           "the scale of s[mul|div]_fix[_sat] must be less than the width of "
5176           "the operands");
5177     } else {
5178       Assert(Op3->getZExtValue() <= Op1->getType()->getScalarSizeInBits(),
5179              "the scale of u[mul|div]_fix[_sat] must be less than or equal "
5180              "to the width of the operands");
5181     }
5182     break;
5183   }
5184   case Intrinsic::lround:
5185   case Intrinsic::llround:
5186   case Intrinsic::lrint:
5187   case Intrinsic::llrint: {
5188     Type *ValTy = Call.getArgOperand(0)->getType();
5189     Type *ResultTy = Call.getType();
5190     Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(),
5191            "Intrinsic does not support vectors", &Call);
5192     break;
5193   }
5194   case Intrinsic::bswap: {
5195     Type *Ty = Call.getType();
5196     unsigned Size = Ty->getScalarSizeInBits();
5197     Assert(Size % 16 == 0, "bswap must be an even number of bytes", &Call);
5198     break;
5199   }
5200   case Intrinsic::invariant_start: {
5201     ConstantInt *InvariantSize = dyn_cast<ConstantInt>(Call.getArgOperand(0));
5202     Assert(InvariantSize &&
5203                (!InvariantSize->isNegative() || InvariantSize->isMinusOne()),
5204            "invariant_start parameter must be -1, 0 or a positive number",
5205            &Call);
5206     break;
5207   }
5208   case Intrinsic::matrix_multiply:
5209   case Intrinsic::matrix_transpose:
5210   case Intrinsic::matrix_column_major_load:
5211   case Intrinsic::matrix_column_major_store: {
5212     Function *IF = Call.getCalledFunction();
5213     ConstantInt *Stride = nullptr;
5214     ConstantInt *NumRows;
5215     ConstantInt *NumColumns;
5216     VectorType *ResultTy;
5217     Type *Op0ElemTy = nullptr;
5218     Type *Op1ElemTy = nullptr;
5219     switch (ID) {
5220     case Intrinsic::matrix_multiply:
5221       NumRows = cast<ConstantInt>(Call.getArgOperand(2));
5222       NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
5223       ResultTy = cast<VectorType>(Call.getType());
5224       Op0ElemTy =
5225           cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType();
5226       Op1ElemTy =
5227           cast<VectorType>(Call.getArgOperand(1)->getType())->getElementType();
5228       break;
5229     case Intrinsic::matrix_transpose:
5230       NumRows = cast<ConstantInt>(Call.getArgOperand(1));
5231       NumColumns = cast<ConstantInt>(Call.getArgOperand(2));
5232       ResultTy = cast<VectorType>(Call.getType());
5233       Op0ElemTy =
5234           cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType();
5235       break;
5236     case Intrinsic::matrix_column_major_load:
5237       Stride = dyn_cast<ConstantInt>(Call.getArgOperand(1));
5238       NumRows = cast<ConstantInt>(Call.getArgOperand(3));
5239       NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
5240       ResultTy = cast<VectorType>(Call.getType());
5241       Op0ElemTy =
5242           cast<PointerType>(Call.getArgOperand(0)->getType())->getElementType();
5243       break;
5244     case Intrinsic::matrix_column_major_store:
5245       Stride = dyn_cast<ConstantInt>(Call.getArgOperand(2));
5246       NumRows = cast<ConstantInt>(Call.getArgOperand(4));
5247       NumColumns = cast<ConstantInt>(Call.getArgOperand(5));
5248       ResultTy = cast<VectorType>(Call.getArgOperand(0)->getType());
5249       Op0ElemTy =
5250           cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType();
5251       Op1ElemTy =
5252           cast<PointerType>(Call.getArgOperand(1)->getType())->getElementType();
5253       break;
5254     default:
5255       llvm_unreachable("unexpected intrinsic");
5256     }
5257 
5258     Assert(ResultTy->getElementType()->isIntegerTy() ||
5259            ResultTy->getElementType()->isFloatingPointTy(),
5260            "Result type must be an integer or floating-point type!", IF);
5261 
5262     Assert(ResultTy->getElementType() == Op0ElemTy,
5263            "Vector element type mismatch of the result and first operand "
5264            "vector!", IF);
5265 
5266     if (Op1ElemTy)
5267       Assert(ResultTy->getElementType() == Op1ElemTy,
5268              "Vector element type mismatch of the result and second operand "
5269              "vector!", IF);
5270 
5271     Assert(cast<FixedVectorType>(ResultTy)->getNumElements() ==
5272                NumRows->getZExtValue() * NumColumns->getZExtValue(),
5273            "Result of a matrix operation does not fit in the returned vector!");
5274 
5275     if (Stride)
5276       Assert(Stride->getZExtValue() >= NumRows->getZExtValue(),
5277              "Stride must be greater or equal than the number of rows!", IF);
5278 
5279     break;
5280   }
5281   case Intrinsic::experimental_stepvector: {
5282     VectorType *VecTy = dyn_cast<VectorType>(Call.getType());
5283     Assert(VecTy && VecTy->getScalarType()->isIntegerTy() &&
5284                VecTy->getScalarSizeInBits() >= 8,
5285            "experimental_stepvector only supported for vectors of integers "
5286            "with a bitwidth of at least 8.",
5287            &Call);
5288     break;
5289   }
5290   case Intrinsic::experimental_vector_insert: {
5291     VectorType *VecTy = cast<VectorType>(Call.getArgOperand(0)->getType());
5292     VectorType *SubVecTy = cast<VectorType>(Call.getArgOperand(1)->getType());
5293 
5294     Assert(VecTy->getElementType() == SubVecTy->getElementType(),
5295            "experimental_vector_insert parameters must have the same element "
5296            "type.",
5297            &Call);
5298     break;
5299   }
5300   case Intrinsic::experimental_vector_extract: {
5301     VectorType *ResultTy = cast<VectorType>(Call.getType());
5302     VectorType *VecTy = cast<VectorType>(Call.getArgOperand(0)->getType());
5303 
5304     Assert(ResultTy->getElementType() == VecTy->getElementType(),
5305            "experimental_vector_extract result must have the same element "
5306            "type as the input vector.",
5307            &Call);
5308     break;
5309   }
5310   case Intrinsic::experimental_noalias_scope_decl: {
5311     NoAliasScopeDecls.push_back(cast<IntrinsicInst>(&Call));
5312     break;
5313   }
5314   };
5315 }
5316 
5317 /// Carefully grab the subprogram from a local scope.
5318 ///
5319 /// This carefully grabs the subprogram from a local scope, avoiding the
5320 /// built-in assertions that would typically fire.
5321 static DISubprogram *getSubprogram(Metadata *LocalScope) {
5322   if (!LocalScope)
5323     return nullptr;
5324 
5325   if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
5326     return SP;
5327 
5328   if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
5329     return getSubprogram(LB->getRawScope());
5330 
5331   // Just return null; broken scope chains are checked elsewhere.
5332   assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
5333   return nullptr;
5334 }
5335 
5336 void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
5337   unsigned NumOperands;
5338   bool HasRoundingMD;
5339   switch (FPI.getIntrinsicID()) {
5340 #define INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC)                         \
5341   case Intrinsic::INTRINSIC:                                                   \
5342     NumOperands = NARG;                                                        \
5343     HasRoundingMD = ROUND_MODE;                                                \
5344     break;
5345 #include "llvm/IR/ConstrainedOps.def"
5346   default:
5347     llvm_unreachable("Invalid constrained FP intrinsic!");
5348   }
5349   NumOperands += (1 + HasRoundingMD);
5350   // Compare intrinsics carry an extra predicate metadata operand.
5351   if (isa<ConstrainedFPCmpIntrinsic>(FPI))
5352     NumOperands += 1;
5353   Assert((FPI.getNumArgOperands() == NumOperands),
5354          "invalid arguments for constrained FP intrinsic", &FPI);
5355 
5356   switch (FPI.getIntrinsicID()) {
5357   case Intrinsic::experimental_constrained_lrint:
5358   case Intrinsic::experimental_constrained_llrint: {
5359     Type *ValTy = FPI.getArgOperand(0)->getType();
5360     Type *ResultTy = FPI.getType();
5361     Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(),
5362            "Intrinsic does not support vectors", &FPI);
5363   }
5364     break;
5365 
5366   case Intrinsic::experimental_constrained_lround:
5367   case Intrinsic::experimental_constrained_llround: {
5368     Type *ValTy = FPI.getArgOperand(0)->getType();
5369     Type *ResultTy = FPI.getType();
5370     Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(),
5371            "Intrinsic does not support vectors", &FPI);
5372     break;
5373   }
5374 
5375   case Intrinsic::experimental_constrained_fcmp:
5376   case Intrinsic::experimental_constrained_fcmps: {
5377     auto Pred = cast<ConstrainedFPCmpIntrinsic>(&FPI)->getPredicate();
5378     Assert(CmpInst::isFPPredicate(Pred),
5379            "invalid predicate for constrained FP comparison intrinsic", &FPI);
5380     break;
5381   }
5382 
5383   case Intrinsic::experimental_constrained_fptosi:
5384   case Intrinsic::experimental_constrained_fptoui: {
5385     Value *Operand = FPI.getArgOperand(0);
5386     uint64_t NumSrcElem = 0;
5387     Assert(Operand->getType()->isFPOrFPVectorTy(),
5388            "Intrinsic first argument must be floating point", &FPI);
5389     if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
5390       NumSrcElem = cast<FixedVectorType>(OperandT)->getNumElements();
5391     }
5392 
5393     Operand = &FPI;
5394     Assert((NumSrcElem > 0) == Operand->getType()->isVectorTy(),
5395            "Intrinsic first argument and result disagree on vector use", &FPI);
5396     Assert(Operand->getType()->isIntOrIntVectorTy(),
5397            "Intrinsic result must be an integer", &FPI);
5398     if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
5399       Assert(NumSrcElem == cast<FixedVectorType>(OperandT)->getNumElements(),
5400              "Intrinsic first argument and result vector lengths must be equal",
5401              &FPI);
5402     }
5403   }
5404     break;
5405 
5406   case Intrinsic::experimental_constrained_sitofp:
5407   case Intrinsic::experimental_constrained_uitofp: {
5408     Value *Operand = FPI.getArgOperand(0);
5409     uint64_t NumSrcElem = 0;
5410     Assert(Operand->getType()->isIntOrIntVectorTy(),
5411            "Intrinsic first argument must be integer", &FPI);
5412     if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
5413       NumSrcElem = cast<FixedVectorType>(OperandT)->getNumElements();
5414     }
5415 
5416     Operand = &FPI;
5417     Assert((NumSrcElem > 0) == Operand->getType()->isVectorTy(),
5418            "Intrinsic first argument and result disagree on vector use", &FPI);
5419     Assert(Operand->getType()->isFPOrFPVectorTy(),
5420            "Intrinsic result must be a floating point", &FPI);
5421     if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
5422       Assert(NumSrcElem == cast<FixedVectorType>(OperandT)->getNumElements(),
5423              "Intrinsic first argument and result vector lengths must be equal",
5424              &FPI);
5425     }
5426   } break;
5427 
5428   case Intrinsic::experimental_constrained_fptrunc:
5429   case Intrinsic::experimental_constrained_fpext: {
5430     Value *Operand = FPI.getArgOperand(0);
5431     Type *OperandTy = Operand->getType();
5432     Value *Result = &FPI;
5433     Type *ResultTy = Result->getType();
5434     Assert(OperandTy->isFPOrFPVectorTy(),
5435            "Intrinsic first argument must be FP or FP vector", &FPI);
5436     Assert(ResultTy->isFPOrFPVectorTy(),
5437            "Intrinsic result must be FP or FP vector", &FPI);
5438     Assert(OperandTy->isVectorTy() == ResultTy->isVectorTy(),
5439            "Intrinsic first argument and result disagree on vector use", &FPI);
5440     if (OperandTy->isVectorTy()) {
5441       Assert(cast<FixedVectorType>(OperandTy)->getNumElements() ==
5442                  cast<FixedVectorType>(ResultTy)->getNumElements(),
5443              "Intrinsic first argument and result vector lengths must be equal",
5444              &FPI);
5445     }
5446     if (FPI.getIntrinsicID() == Intrinsic::experimental_constrained_fptrunc) {
5447       Assert(OperandTy->getScalarSizeInBits() > ResultTy->getScalarSizeInBits(),
5448              "Intrinsic first argument's type must be larger than result type",
5449              &FPI);
5450     } else {
5451       Assert(OperandTy->getScalarSizeInBits() < ResultTy->getScalarSizeInBits(),
5452              "Intrinsic first argument's type must be smaller than result type",
5453              &FPI);
5454     }
5455   }
5456     break;
5457 
5458   default:
5459     break;
5460   }
5461 
5462   // If a non-metadata argument is passed in a metadata slot then the
5463   // error will be caught earlier when the incorrect argument doesn't
5464   // match the specification in the intrinsic call table. Thus, no
5465   // argument type check is needed here.
5466 
5467   Assert(FPI.getExceptionBehavior().hasValue(),
5468          "invalid exception behavior argument", &FPI);
5469   if (HasRoundingMD) {
5470     Assert(FPI.getRoundingMode().hasValue(),
5471            "invalid rounding mode argument", &FPI);
5472   }
5473 }
5474 
5475 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgVariableIntrinsic &DII) {
5476   auto *MD = DII.getRawLocation();
5477   AssertDI(isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD) ||
5478                (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
5479            "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
5480   AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
5481          "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
5482          DII.getRawVariable());
5483   AssertDI(isa<DIExpression>(DII.getRawExpression()),
5484          "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
5485          DII.getRawExpression());
5486 
5487   // Ignore broken !dbg attachments; they're checked elsewhere.
5488   if (MDNode *N = DII.getDebugLoc().getAsMDNode())
5489     if (!isa<DILocation>(N))
5490       return;
5491 
5492   BasicBlock *BB = DII.getParent();
5493   Function *F = BB ? BB->getParent() : nullptr;
5494 
5495   // The scopes for variables and !dbg attachments must agree.
5496   DILocalVariable *Var = DII.getVariable();
5497   DILocation *Loc = DII.getDebugLoc();
5498   AssertDI(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
5499            &DII, BB, F);
5500 
5501   DISubprogram *VarSP = getSubprogram(Var->getRawScope());
5502   DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
5503   if (!VarSP || !LocSP)
5504     return; // Broken scope chains are checked elsewhere.
5505 
5506   AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
5507                                " variable and !dbg attachment",
5508            &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
5509            Loc->getScope()->getSubprogram());
5510 
5511   // This check is redundant with one in visitLocalVariable().
5512   AssertDI(isType(Var->getRawType()), "invalid type ref", Var,
5513            Var->getRawType());
5514   verifyFnArgs(DII);
5515 }
5516 
5517 void Verifier::visitDbgLabelIntrinsic(StringRef Kind, DbgLabelInst &DLI) {
5518   AssertDI(isa<DILabel>(DLI.getRawLabel()),
5519          "invalid llvm.dbg." + Kind + " intrinsic variable", &DLI,
5520          DLI.getRawLabel());
5521 
5522   // Ignore broken !dbg attachments; they're checked elsewhere.
5523   if (MDNode *N = DLI.getDebugLoc().getAsMDNode())
5524     if (!isa<DILocation>(N))
5525       return;
5526 
5527   BasicBlock *BB = DLI.getParent();
5528   Function *F = BB ? BB->getParent() : nullptr;
5529 
5530   // The scopes for variables and !dbg attachments must agree.
5531   DILabel *Label = DLI.getLabel();
5532   DILocation *Loc = DLI.getDebugLoc();
5533   Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
5534          &DLI, BB, F);
5535 
5536   DISubprogram *LabelSP = getSubprogram(Label->getRawScope());
5537   DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
5538   if (!LabelSP || !LocSP)
5539     return;
5540 
5541   AssertDI(LabelSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
5542                              " label and !dbg attachment",
5543            &DLI, BB, F, Label, Label->getScope()->getSubprogram(), Loc,
5544            Loc->getScope()->getSubprogram());
5545 }
5546 
5547 void Verifier::verifyFragmentExpression(const DbgVariableIntrinsic &I) {
5548   DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(I.getRawVariable());
5549   DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression());
5550 
5551   // We don't know whether this intrinsic verified correctly.
5552   if (!V || !E || !E->isValid())
5553     return;
5554 
5555   // Nothing to do if this isn't a DW_OP_LLVM_fragment expression.
5556   auto Fragment = E->getFragmentInfo();
5557   if (!Fragment)
5558     return;
5559 
5560   // The frontend helps out GDB by emitting the members of local anonymous
5561   // unions as artificial local variables with shared storage. When SROA splits
5562   // the storage for artificial local variables that are smaller than the entire
5563   // union, the overhang piece will be outside of the allotted space for the
5564   // variable and this check fails.
5565   // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
5566   if (V->isArtificial())
5567     return;
5568 
5569   verifyFragmentExpression(*V, *Fragment, &I);
5570 }
5571 
5572 template <typename ValueOrMetadata>
5573 void Verifier::verifyFragmentExpression(const DIVariable &V,
5574                                         DIExpression::FragmentInfo Fragment,
5575                                         ValueOrMetadata *Desc) {
5576   // If there's no size, the type is broken, but that should be checked
5577   // elsewhere.
5578   auto VarSize = V.getSizeInBits();
5579   if (!VarSize)
5580     return;
5581 
5582   unsigned FragSize = Fragment.SizeInBits;
5583   unsigned FragOffset = Fragment.OffsetInBits;
5584   AssertDI(FragSize + FragOffset <= *VarSize,
5585          "fragment is larger than or outside of variable", Desc, &V);
5586   AssertDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V);
5587 }
5588 
5589 void Verifier::verifyFnArgs(const DbgVariableIntrinsic &I) {
5590   // This function does not take the scope of noninlined function arguments into
5591   // account. Don't run it if current function is nodebug, because it may
5592   // contain inlined debug intrinsics.
5593   if (!HasDebugInfo)
5594     return;
5595 
5596   // For performance reasons only check non-inlined ones.
5597   if (I.getDebugLoc()->getInlinedAt())
5598     return;
5599 
5600   DILocalVariable *Var = I.getVariable();
5601   AssertDI(Var, "dbg intrinsic without variable");
5602 
5603   unsigned ArgNo = Var->getArg();
5604   if (!ArgNo)
5605     return;
5606 
5607   // Verify there are no duplicate function argument debug info entries.
5608   // These will cause hard-to-debug assertions in the DWARF backend.
5609   if (DebugFnArgs.size() < ArgNo)
5610     DebugFnArgs.resize(ArgNo, nullptr);
5611 
5612   auto *Prev = DebugFnArgs[ArgNo - 1];
5613   DebugFnArgs[ArgNo - 1] = Var;
5614   AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I,
5615            Prev, Var);
5616 }
5617 
5618 void Verifier::verifyNotEntryValue(const DbgVariableIntrinsic &I) {
5619   DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression());
5620 
5621   // We don't know whether this intrinsic verified correctly.
5622   if (!E || !E->isValid())
5623     return;
5624 
5625   AssertDI(!E->isEntryValue(), "Entry values are only allowed in MIR", &I);
5626 }
5627 
5628 void Verifier::verifyCompileUnits() {
5629   // When more than one Module is imported into the same context, such as during
5630   // an LTO build before linking the modules, ODR type uniquing may cause types
5631   // to point to a different CU. This check does not make sense in this case.
5632   if (M.getContext().isODRUniquingDebugTypes())
5633     return;
5634   auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
5635   SmallPtrSet<const Metadata *, 2> Listed;
5636   if (CUs)
5637     Listed.insert(CUs->op_begin(), CUs->op_end());
5638   for (auto *CU : CUVisited)
5639     AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
5640   CUVisited.clear();
5641 }
5642 
5643 void Verifier::verifyDeoptimizeCallingConvs() {
5644   if (DeoptimizeDeclarations.empty())
5645     return;
5646 
5647   const Function *First = DeoptimizeDeclarations[0];
5648   for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
5649     Assert(First->getCallingConv() == F->getCallingConv(),
5650            "All llvm.experimental.deoptimize declarations must have the same "
5651            "calling convention",
5652            First, F);
5653   }
5654 }
5655 
5656 void Verifier::verifySourceDebugInfo(const DICompileUnit &U, const DIFile &F) {
5657   bool HasSource = F.getSource().hasValue();
5658   if (!HasSourceDebugInfo.count(&U))
5659     HasSourceDebugInfo[&U] = HasSource;
5660   AssertDI(HasSource == HasSourceDebugInfo[&U],
5661            "inconsistent use of embedded source");
5662 }
5663 
5664 void Verifier::verifyNoAliasScopeDecl() {
5665   if (NoAliasScopeDecls.empty())
5666     return;
5667 
5668   // only a single scope must be declared at a time.
5669   for (auto *II : NoAliasScopeDecls) {
5670     assert(II->getIntrinsicID() == Intrinsic::experimental_noalias_scope_decl &&
5671            "Not a llvm.experimental.noalias.scope.decl ?");
5672     const auto *ScopeListMV = dyn_cast<MetadataAsValue>(
5673         II->getOperand(Intrinsic::NoAliasScopeDeclScopeArg));
5674     Assert(ScopeListMV != nullptr,
5675            "llvm.experimental.noalias.scope.decl must have a MetadataAsValue "
5676            "argument",
5677            II);
5678 
5679     const auto *ScopeListMD = dyn_cast<MDNode>(ScopeListMV->getMetadata());
5680     Assert(ScopeListMD != nullptr, "!id.scope.list must point to an MDNode",
5681            II);
5682     Assert(ScopeListMD->getNumOperands() == 1,
5683            "!id.scope.list must point to a list with a single scope", II);
5684   }
5685 
5686   // Only check the domination rule when requested. Once all passes have been
5687   // adapted this option can go away.
5688   if (!VerifyNoAliasScopeDomination)
5689     return;
5690 
5691   // Now sort the intrinsics based on the scope MDNode so that declarations of
5692   // the same scopes are next to each other.
5693   auto GetScope = [](IntrinsicInst *II) {
5694     const auto *ScopeListMV = cast<MetadataAsValue>(
5695         II->getOperand(Intrinsic::NoAliasScopeDeclScopeArg));
5696     return &cast<MDNode>(ScopeListMV->getMetadata())->getOperand(0);
5697   };
5698 
5699   // We are sorting on MDNode pointers here. For valid input IR this is ok.
5700   // TODO: Sort on Metadata ID to avoid non-deterministic error messages.
5701   auto Compare = [GetScope](IntrinsicInst *Lhs, IntrinsicInst *Rhs) {
5702     return GetScope(Lhs) < GetScope(Rhs);
5703   };
5704 
5705   llvm::sort(NoAliasScopeDecls, Compare);
5706 
5707   // Go over the intrinsics and check that for the same scope, they are not
5708   // dominating each other.
5709   auto ItCurrent = NoAliasScopeDecls.begin();
5710   while (ItCurrent != NoAliasScopeDecls.end()) {
5711     auto CurScope = GetScope(*ItCurrent);
5712     auto ItNext = ItCurrent;
5713     do {
5714       ++ItNext;
5715     } while (ItNext != NoAliasScopeDecls.end() &&
5716              GetScope(*ItNext) == CurScope);
5717 
5718     // [ItCurrent, ItNext) represents the declarations for the same scope.
5719     // Ensure they are not dominating each other.. but only if it is not too
5720     // expensive.
5721     if (ItNext - ItCurrent < 32)
5722       for (auto *I : llvm::make_range(ItCurrent, ItNext))
5723         for (auto *J : llvm::make_range(ItCurrent, ItNext))
5724           if (I != J)
5725             Assert(!DT.dominates(I, J),
5726                    "llvm.experimental.noalias.scope.decl dominates another one "
5727                    "with the same scope",
5728                    I);
5729     ItCurrent = ItNext;
5730   }
5731 }
5732 
5733 //===----------------------------------------------------------------------===//
5734 //  Implement the public interfaces to this file...
5735 //===----------------------------------------------------------------------===//
5736 
5737 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
5738   Function &F = const_cast<Function &>(f);
5739 
5740   // Don't use a raw_null_ostream.  Printing IR is expensive.
5741   Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
5742 
5743   // Note that this function's return value is inverted from what you would
5744   // expect of a function called "verify".
5745   return !V.verify(F);
5746 }
5747 
5748 bool llvm::verifyModule(const Module &M, raw_ostream *OS,
5749                         bool *BrokenDebugInfo) {
5750   // Don't use a raw_null_ostream.  Printing IR is expensive.
5751   Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
5752 
5753   bool Broken = false;
5754   for (const Function &F : M)
5755     Broken |= !V.verify(F);
5756 
5757   Broken |= !V.verify();
5758   if (BrokenDebugInfo)
5759     *BrokenDebugInfo = V.hasBrokenDebugInfo();
5760   // Note that this function's return value is inverted from what you would
5761   // expect of a function called "verify".
5762   return Broken;
5763 }
5764 
5765 namespace {
5766 
5767 struct VerifierLegacyPass : public FunctionPass {
5768   static char ID;
5769 
5770   std::unique_ptr<Verifier> V;
5771   bool FatalErrors = true;
5772 
5773   VerifierLegacyPass() : FunctionPass(ID) {
5774     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
5775   }
5776   explicit VerifierLegacyPass(bool FatalErrors)
5777       : FunctionPass(ID),
5778         FatalErrors(FatalErrors) {
5779     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
5780   }
5781 
5782   bool doInitialization(Module &M) override {
5783     V = std::make_unique<Verifier>(
5784         &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
5785     return false;
5786   }
5787 
5788   bool runOnFunction(Function &F) override {
5789     if (!V->verify(F) && FatalErrors) {
5790       errs() << "in function " << F.getName() << '\n';
5791       report_fatal_error("Broken function found, compilation aborted!");
5792     }
5793     return false;
5794   }
5795 
5796   bool doFinalization(Module &M) override {
5797     bool HasErrors = false;
5798     for (Function &F : M)
5799       if (F.isDeclaration())
5800         HasErrors |= !V->verify(F);
5801 
5802     HasErrors |= !V->verify();
5803     if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo()))
5804       report_fatal_error("Broken module found, compilation aborted!");
5805     return false;
5806   }
5807 
5808   void getAnalysisUsage(AnalysisUsage &AU) const override {
5809     AU.setPreservesAll();
5810   }
5811 };
5812 
5813 } // end anonymous namespace
5814 
5815 /// Helper to issue failure from the TBAA verification
5816 template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
5817   if (Diagnostic)
5818     return Diagnostic->CheckFailed(Args...);
5819 }
5820 
5821 #define AssertTBAA(C, ...)                                                     \
5822   do {                                                                         \
5823     if (!(C)) {                                                                \
5824       CheckFailed(__VA_ARGS__);                                                \
5825       return false;                                                            \
5826     }                                                                          \
5827   } while (false)
5828 
5829 /// Verify that \p BaseNode can be used as the "base type" in the struct-path
5830 /// TBAA scheme.  This means \p BaseNode is either a scalar node, or a
5831 /// struct-type node describing an aggregate data structure (like a struct).
5832 TBAAVerifier::TBAABaseNodeSummary
5833 TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode,
5834                                  bool IsNewFormat) {
5835   if (BaseNode->getNumOperands() < 2) {
5836     CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
5837     return {true, ~0u};
5838   }
5839 
5840   auto Itr = TBAABaseNodes.find(BaseNode);
5841   if (Itr != TBAABaseNodes.end())
5842     return Itr->second;
5843 
5844   auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat);
5845   auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
5846   (void)InsertResult;
5847   assert(InsertResult.second && "We just checked!");
5848   return Result;
5849 }
5850 
5851 TBAAVerifier::TBAABaseNodeSummary
5852 TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode,
5853                                      bool IsNewFormat) {
5854   const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
5855 
5856   if (BaseNode->getNumOperands() == 2) {
5857     // Scalar nodes can only be accessed at offset 0.
5858     return isValidScalarTBAANode(BaseNode)
5859                ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
5860                : InvalidNode;
5861   }
5862 
5863   if (IsNewFormat) {
5864     if (BaseNode->getNumOperands() % 3 != 0) {
5865       CheckFailed("Access tag nodes must have the number of operands that is a "
5866                   "multiple of 3!", BaseNode);
5867       return InvalidNode;
5868     }
5869   } else {
5870     if (BaseNode->getNumOperands() % 2 != 1) {
5871       CheckFailed("Struct tag nodes must have an odd number of operands!",
5872                   BaseNode);
5873       return InvalidNode;
5874     }
5875   }
5876 
5877   // Check the type size field.
5878   if (IsNewFormat) {
5879     auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
5880         BaseNode->getOperand(1));
5881     if (!TypeSizeNode) {
5882       CheckFailed("Type size nodes must be constants!", &I, BaseNode);
5883       return InvalidNode;
5884     }
5885   }
5886 
5887   // Check the type name field. In the new format it can be anything.
5888   if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) {
5889     CheckFailed("Struct tag nodes have a string as their first operand",
5890                 BaseNode);
5891     return InvalidNode;
5892   }
5893 
5894   bool Failed = false;
5895 
5896   Optional<APInt> PrevOffset;
5897   unsigned BitWidth = ~0u;
5898 
5899   // We've already checked that BaseNode is not a degenerate root node with one
5900   // operand in \c verifyTBAABaseNode, so this loop should run at least once.
5901   unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
5902   unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
5903   for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
5904            Idx += NumOpsPerField) {
5905     const MDOperand &FieldTy = BaseNode->getOperand(Idx);
5906     const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
5907     if (!isa<MDNode>(FieldTy)) {
5908       CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
5909       Failed = true;
5910       continue;
5911     }
5912 
5913     auto *OffsetEntryCI =
5914         mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
5915     if (!OffsetEntryCI) {
5916       CheckFailed("Offset entries must be constants!", &I, BaseNode);
5917       Failed = true;
5918       continue;
5919     }
5920 
5921     if (BitWidth == ~0u)
5922       BitWidth = OffsetEntryCI->getBitWidth();
5923 
5924     if (OffsetEntryCI->getBitWidth() != BitWidth) {
5925       CheckFailed(
5926           "Bitwidth between the offsets and struct type entries must match", &I,
5927           BaseNode);
5928       Failed = true;
5929       continue;
5930     }
5931 
5932     // NB! As far as I can tell, we generate a non-strictly increasing offset
5933     // sequence only from structs that have zero size bit fields.  When
5934     // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
5935     // pick the field lexically the latest in struct type metadata node.  This
5936     // mirrors the actual behavior of the alias analysis implementation.
5937     bool IsAscending =
5938         !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
5939 
5940     if (!IsAscending) {
5941       CheckFailed("Offsets must be increasing!", &I, BaseNode);
5942       Failed = true;
5943     }
5944 
5945     PrevOffset = OffsetEntryCI->getValue();
5946 
5947     if (IsNewFormat) {
5948       auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
5949           BaseNode->getOperand(Idx + 2));
5950       if (!MemberSizeNode) {
5951         CheckFailed("Member size entries must be constants!", &I, BaseNode);
5952         Failed = true;
5953         continue;
5954       }
5955     }
5956   }
5957 
5958   return Failed ? InvalidNode
5959                 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
5960 }
5961 
5962 static bool IsRootTBAANode(const MDNode *MD) {
5963   return MD->getNumOperands() < 2;
5964 }
5965 
5966 static bool IsScalarTBAANodeImpl(const MDNode *MD,
5967                                  SmallPtrSetImpl<const MDNode *> &Visited) {
5968   if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
5969     return false;
5970 
5971   if (!isa<MDString>(MD->getOperand(0)))
5972     return false;
5973 
5974   if (MD->getNumOperands() == 3) {
5975     auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
5976     if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
5977       return false;
5978   }
5979 
5980   auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
5981   return Parent && Visited.insert(Parent).second &&
5982          (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
5983 }
5984 
5985 bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
5986   auto ResultIt = TBAAScalarNodes.find(MD);
5987   if (ResultIt != TBAAScalarNodes.end())
5988     return ResultIt->second;
5989 
5990   SmallPtrSet<const MDNode *, 4> Visited;
5991   bool Result = IsScalarTBAANodeImpl(MD, Visited);
5992   auto InsertResult = TBAAScalarNodes.insert({MD, Result});
5993   (void)InsertResult;
5994   assert(InsertResult.second && "Just checked!");
5995 
5996   return Result;
5997 }
5998 
5999 /// Returns the field node at the offset \p Offset in \p BaseNode.  Update \p
6000 /// Offset in place to be the offset within the field node returned.
6001 ///
6002 /// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
6003 MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
6004                                                    const MDNode *BaseNode,
6005                                                    APInt &Offset,
6006                                                    bool IsNewFormat) {
6007   assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
6008 
6009   // Scalar nodes have only one possible "field" -- their parent in the access
6010   // hierarchy.  Offset must be zero at this point, but our caller is supposed
6011   // to Assert that.
6012   if (BaseNode->getNumOperands() == 2)
6013     return cast<MDNode>(BaseNode->getOperand(1));
6014 
6015   unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
6016   unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
6017   for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
6018            Idx += NumOpsPerField) {
6019     auto *OffsetEntryCI =
6020         mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
6021     if (OffsetEntryCI->getValue().ugt(Offset)) {
6022       if (Idx == FirstFieldOpNo) {
6023         CheckFailed("Could not find TBAA parent in struct type node", &I,
6024                     BaseNode, &Offset);
6025         return nullptr;
6026       }
6027 
6028       unsigned PrevIdx = Idx - NumOpsPerField;
6029       auto *PrevOffsetEntryCI =
6030           mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1));
6031       Offset -= PrevOffsetEntryCI->getValue();
6032       return cast<MDNode>(BaseNode->getOperand(PrevIdx));
6033     }
6034   }
6035 
6036   unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField;
6037   auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
6038       BaseNode->getOperand(LastIdx + 1));
6039   Offset -= LastOffsetEntryCI->getValue();
6040   return cast<MDNode>(BaseNode->getOperand(LastIdx));
6041 }
6042 
6043 static bool isNewFormatTBAATypeNode(llvm::MDNode *Type) {
6044   if (!Type || Type->getNumOperands() < 3)
6045     return false;
6046 
6047   // In the new format type nodes shall have a reference to the parent type as
6048   // its first operand.
6049   MDNode *Parent = dyn_cast_or_null<MDNode>(Type->getOperand(0));
6050   if (!Parent)
6051     return false;
6052 
6053   return true;
6054 }
6055 
6056 bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
6057   AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
6058                  isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
6059                  isa<AtomicCmpXchgInst>(I),
6060              "This instruction shall not have a TBAA access tag!", &I);
6061 
6062   bool IsStructPathTBAA =
6063       isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
6064 
6065   AssertTBAA(
6066       IsStructPathTBAA,
6067       "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
6068 
6069   MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
6070   MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
6071 
6072   bool IsNewFormat = isNewFormatTBAATypeNode(AccessType);
6073 
6074   if (IsNewFormat) {
6075     AssertTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5,
6076                "Access tag metadata must have either 4 or 5 operands", &I, MD);
6077   } else {
6078     AssertTBAA(MD->getNumOperands() < 5,
6079                "Struct tag metadata must have either 3 or 4 operands", &I, MD);
6080   }
6081 
6082   // Check the access size field.
6083   if (IsNewFormat) {
6084     auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
6085         MD->getOperand(3));
6086     AssertTBAA(AccessSizeNode, "Access size field must be a constant", &I, MD);
6087   }
6088 
6089   // Check the immutability flag.
6090   unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3;
6091   if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) {
6092     auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>(
6093         MD->getOperand(ImmutabilityFlagOpNo));
6094     AssertTBAA(IsImmutableCI,
6095                "Immutability tag on struct tag metadata must be a constant",
6096                &I, MD);
6097     AssertTBAA(
6098         IsImmutableCI->isZero() || IsImmutableCI->isOne(),
6099         "Immutability part of the struct tag metadata must be either 0 or 1",
6100         &I, MD);
6101   }
6102 
6103   AssertTBAA(BaseNode && AccessType,
6104              "Malformed struct tag metadata: base and access-type "
6105              "should be non-null and point to Metadata nodes",
6106              &I, MD, BaseNode, AccessType);
6107 
6108   if (!IsNewFormat) {
6109     AssertTBAA(isValidScalarTBAANode(AccessType),
6110                "Access type node must be a valid scalar type", &I, MD,
6111                AccessType);
6112   }
6113 
6114   auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
6115   AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
6116 
6117   APInt Offset = OffsetCI->getValue();
6118   bool SeenAccessTypeInPath = false;
6119 
6120   SmallPtrSet<MDNode *, 4> StructPath;
6121 
6122   for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
6123        BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset,
6124                                                IsNewFormat)) {
6125     if (!StructPath.insert(BaseNode).second) {
6126       CheckFailed("Cycle detected in struct path", &I, MD);
6127       return false;
6128     }
6129 
6130     bool Invalid;
6131     unsigned BaseNodeBitWidth;
6132     std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode,
6133                                                              IsNewFormat);
6134 
6135     // If the base node is invalid in itself, then we've already printed all the
6136     // errors we wanted to print.
6137     if (Invalid)
6138       return false;
6139 
6140     SeenAccessTypeInPath |= BaseNode == AccessType;
6141 
6142     if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
6143       AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
6144                  &I, MD, &Offset);
6145 
6146     AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
6147                    (BaseNodeBitWidth == 0 && Offset == 0) ||
6148                    (IsNewFormat && BaseNodeBitWidth == ~0u),
6149                "Access bit-width not the same as description bit-width", &I, MD,
6150                BaseNodeBitWidth, Offset.getBitWidth());
6151 
6152     if (IsNewFormat && SeenAccessTypeInPath)
6153       break;
6154   }
6155 
6156   AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
6157              &I, MD);
6158   return true;
6159 }
6160 
6161 char VerifierLegacyPass::ID = 0;
6162 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
6163 
6164 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
6165   return new VerifierLegacyPass(FatalErrors);
6166 }
6167 
6168 AnalysisKey VerifierAnalysis::Key;
6169 VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
6170                                                ModuleAnalysisManager &) {
6171   Result Res;
6172   Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
6173   return Res;
6174 }
6175 
6176 VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
6177                                                FunctionAnalysisManager &) {
6178   return { llvm::verifyFunction(F, &dbgs()), false };
6179 }
6180 
6181 PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
6182   auto Res = AM.getResult<VerifierAnalysis>(M);
6183   if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken))
6184     report_fatal_error("Broken module found, compilation aborted!");
6185 
6186   return PreservedAnalyses::all();
6187 }
6188 
6189 PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
6190   auto res = AM.getResult<VerifierAnalysis>(F);
6191   if (res.IRBroken && FatalErrors)
6192     report_fatal_error("Broken function found, compilation aborted!");
6193 
6194   return PreservedAnalyses::all();
6195 }
6196