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