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