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