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