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