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