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