[Statepoints] Let patchable statepoints have a symbolic call target.
[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   Assert(bool(N.getArg()) == (N.getTag() == dwarf::DW_TAG_arg_variable),
1067          "local variable should have arg iff it's a DW_TAG_arg_variable", &N);
1068 }
1069
1070 void Verifier::visitDIExpression(const DIExpression &N) {
1071   Assert(N.isValid(), "invalid expression", &N);
1072 }
1073
1074 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1075   Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1076   if (auto *T = N.getRawType())
1077     Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1078   if (auto *F = N.getRawFile())
1079     Assert(isa<DIFile>(F), "invalid file", &N, F);
1080 }
1081
1082 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1083   Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1084              N.getTag() == dwarf::DW_TAG_imported_declaration,
1085          "invalid tag", &N);
1086   if (auto *S = N.getRawScope())
1087     Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1088   Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1089          N.getEntity());
1090 }
1091
1092 void Verifier::visitComdat(const Comdat &C) {
1093   // The Module is invalid if the GlobalValue has private linkage.  Entities
1094   // with private linkage don't have entries in the symbol table.
1095   if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1096     Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1097            GV);
1098 }
1099
1100 void Verifier::visitModuleIdents(const Module &M) {
1101   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1102   if (!Idents) 
1103     return;
1104   
1105   // llvm.ident takes a list of metadata entry. Each entry has only one string.
1106   // Scan each llvm.ident entry and make sure that this requirement is met.
1107   for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1108     const MDNode *N = Idents->getOperand(i);
1109     Assert(N->getNumOperands() == 1,
1110            "incorrect number of operands in llvm.ident metadata", N);
1111     Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1112            ("invalid value for llvm.ident metadata entry operand"
1113             "(the operand should be a string)"),
1114            N->getOperand(0));
1115   } 
1116 }
1117
1118 void Verifier::visitModuleFlags(const Module &M) {
1119   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1120   if (!Flags) return;
1121
1122   // Scan each flag, and track the flags and requirements.
1123   DenseMap<const MDString*, const MDNode*> SeenIDs;
1124   SmallVector<const MDNode*, 16> Requirements;
1125   for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1126     visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1127   }
1128
1129   // Validate that the requirements in the module are valid.
1130   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1131     const MDNode *Requirement = Requirements[I];
1132     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1133     const Metadata *ReqValue = Requirement->getOperand(1);
1134
1135     const MDNode *Op = SeenIDs.lookup(Flag);
1136     if (!Op) {
1137       CheckFailed("invalid requirement on flag, flag is not present in module",
1138                   Flag);
1139       continue;
1140     }
1141
1142     if (Op->getOperand(2) != ReqValue) {
1143       CheckFailed(("invalid requirement on flag, "
1144                    "flag does not have the required value"),
1145                   Flag);
1146       continue;
1147     }
1148   }
1149 }
1150
1151 void
1152 Verifier::visitModuleFlag(const MDNode *Op,
1153                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
1154                           SmallVectorImpl<const MDNode *> &Requirements) {
1155   // Each module flag should have three arguments, the merge behavior (a
1156   // constant int), the flag ID (an MDString), and the value.
1157   Assert(Op->getNumOperands() == 3,
1158          "incorrect number of operands in module flag", Op);
1159   Module::ModFlagBehavior MFB;
1160   if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1161     Assert(
1162         mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1163         "invalid behavior operand in module flag (expected constant integer)",
1164         Op->getOperand(0));
1165     Assert(false,
1166            "invalid behavior operand in module flag (unexpected constant)",
1167            Op->getOperand(0));
1168   }
1169   MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1170   Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1171          Op->getOperand(1));
1172
1173   // Sanity check the values for behaviors with additional requirements.
1174   switch (MFB) {
1175   case Module::Error:
1176   case Module::Warning:
1177   case Module::Override:
1178     // These behavior types accept any value.
1179     break;
1180
1181   case Module::Require: {
1182     // The value should itself be an MDNode with two operands, a flag ID (an
1183     // MDString), and a value.
1184     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1185     Assert(Value && Value->getNumOperands() == 2,
1186            "invalid value for 'require' module flag (expected metadata pair)",
1187            Op->getOperand(2));
1188     Assert(isa<MDString>(Value->getOperand(0)),
1189            ("invalid value for 'require' module flag "
1190             "(first value operand should be a string)"),
1191            Value->getOperand(0));
1192
1193     // Append it to the list of requirements, to check once all module flags are
1194     // scanned.
1195     Requirements.push_back(Value);
1196     break;
1197   }
1198
1199   case Module::Append:
1200   case Module::AppendUnique: {
1201     // These behavior types require the operand be an MDNode.
1202     Assert(isa<MDNode>(Op->getOperand(2)),
1203            "invalid value for 'append'-type module flag "
1204            "(expected a metadata node)",
1205            Op->getOperand(2));
1206     break;
1207   }
1208   }
1209
1210   // Unless this is a "requires" flag, check the ID is unique.
1211   if (MFB != Module::Require) {
1212     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1213     Assert(Inserted,
1214            "module flag identifiers must be unique (or of 'require' type)", ID);
1215   }
1216 }
1217
1218 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1219                                     bool isFunction, const Value *V) {
1220   unsigned Slot = ~0U;
1221   for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1222     if (Attrs.getSlotIndex(I) == Idx) {
1223       Slot = I;
1224       break;
1225     }
1226
1227   assert(Slot != ~0U && "Attribute set inconsistency!");
1228
1229   for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1230          I != E; ++I) {
1231     if (I->isStringAttribute())
1232       continue;
1233
1234     if (I->getKindAsEnum() == Attribute::NoReturn ||
1235         I->getKindAsEnum() == Attribute::NoUnwind ||
1236         I->getKindAsEnum() == Attribute::NoInline ||
1237         I->getKindAsEnum() == Attribute::AlwaysInline ||
1238         I->getKindAsEnum() == Attribute::OptimizeForSize ||
1239         I->getKindAsEnum() == Attribute::StackProtect ||
1240         I->getKindAsEnum() == Attribute::StackProtectReq ||
1241         I->getKindAsEnum() == Attribute::StackProtectStrong ||
1242         I->getKindAsEnum() == Attribute::SafeStack ||
1243         I->getKindAsEnum() == Attribute::NoRedZone ||
1244         I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1245         I->getKindAsEnum() == Attribute::Naked ||
1246         I->getKindAsEnum() == Attribute::InlineHint ||
1247         I->getKindAsEnum() == Attribute::StackAlignment ||
1248         I->getKindAsEnum() == Attribute::UWTable ||
1249         I->getKindAsEnum() == Attribute::NonLazyBind ||
1250         I->getKindAsEnum() == Attribute::ReturnsTwice ||
1251         I->getKindAsEnum() == Attribute::SanitizeAddress ||
1252         I->getKindAsEnum() == Attribute::SanitizeThread ||
1253         I->getKindAsEnum() == Attribute::SanitizeMemory ||
1254         I->getKindAsEnum() == Attribute::MinSize ||
1255         I->getKindAsEnum() == Attribute::NoDuplicate ||
1256         I->getKindAsEnum() == Attribute::Builtin ||
1257         I->getKindAsEnum() == Attribute::NoBuiltin ||
1258         I->getKindAsEnum() == Attribute::Cold ||
1259         I->getKindAsEnum() == Attribute::OptimizeNone ||
1260         I->getKindAsEnum() == Attribute::JumpTable ||
1261         I->getKindAsEnum() == Attribute::Convergent ||
1262         I->getKindAsEnum() == Attribute::ArgMemOnly) {
1263       if (!isFunction) {
1264         CheckFailed("Attribute '" + I->getAsString() +
1265                     "' only applies to functions!", V);
1266         return;
1267       }
1268     } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1269                I->getKindAsEnum() == Attribute::ReadNone) {
1270       if (Idx == 0) {
1271         CheckFailed("Attribute '" + I->getAsString() +
1272                     "' does not apply to function returns");
1273         return;
1274       }
1275     } else if (isFunction) {
1276       CheckFailed("Attribute '" + I->getAsString() +
1277                   "' does not apply to functions!", V);
1278       return;
1279     }
1280   }
1281 }
1282
1283 // VerifyParameterAttrs - Check the given attributes for an argument or return
1284 // value of the specified type.  The value V is printed in error messages.
1285 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1286                                     bool isReturnValue, const Value *V) {
1287   if (!Attrs.hasAttributes(Idx))
1288     return;
1289
1290   VerifyAttributeTypes(Attrs, Idx, false, V);
1291
1292   if (isReturnValue)
1293     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1294                !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1295                !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1296                !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1297                !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1298                !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1299            "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1300            "'returned' do not apply to return values!",
1301            V);
1302
1303   // Check for mutually incompatible attributes.  Only inreg is compatible with
1304   // sret.
1305   unsigned AttrCount = 0;
1306   AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1307   AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1308   AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1309                Attrs.hasAttribute(Idx, Attribute::InReg);
1310   AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1311   Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1312                          "and 'sret' are incompatible!",
1313          V);
1314
1315   Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1316            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1317          "Attributes "
1318          "'inalloca and readonly' are incompatible!",
1319          V);
1320
1321   Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1322            Attrs.hasAttribute(Idx, Attribute::Returned)),
1323          "Attributes "
1324          "'sret and returned' are incompatible!",
1325          V);
1326
1327   Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1328            Attrs.hasAttribute(Idx, Attribute::SExt)),
1329          "Attributes "
1330          "'zeroext and signext' are incompatible!",
1331          V);
1332
1333   Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1334            Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1335          "Attributes "
1336          "'readnone and readonly' are incompatible!",
1337          V);
1338
1339   Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1340            Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1341          "Attributes "
1342          "'noinline and alwaysinline' are incompatible!",
1343          V);
1344
1345   Assert(!AttrBuilder(Attrs, Idx)
1346               .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1347          "Wrong types for attribute: " +
1348          AttributeSet::get(*Context, Idx,
1349                         AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1350          V);
1351
1352   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1353     SmallPtrSet<const Type*, 4> Visited;
1354     if (!PTy->getElementType()->isSized(&Visited)) {
1355       Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1356                  !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1357              "Attributes 'byval' and 'inalloca' do not support unsized types!",
1358              V);
1359     }
1360   } else {
1361     Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1362            "Attribute 'byval' only applies to parameters with pointer type!",
1363            V);
1364   }
1365 }
1366
1367 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1368 // The value V is printed in error messages.
1369 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1370                                    const Value *V) {
1371   if (Attrs.isEmpty())
1372     return;
1373
1374   bool SawNest = false;
1375   bool SawReturned = false;
1376   bool SawSRet = false;
1377
1378   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1379     unsigned Idx = Attrs.getSlotIndex(i);
1380
1381     Type *Ty;
1382     if (Idx == 0)
1383       Ty = FT->getReturnType();
1384     else if (Idx-1 < FT->getNumParams())
1385       Ty = FT->getParamType(Idx-1);
1386     else
1387       break;  // VarArgs attributes, verified elsewhere.
1388
1389     VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1390
1391     if (Idx == 0)
1392       continue;
1393
1394     if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1395       Assert(!SawNest, "More than one parameter has attribute nest!", V);
1396       SawNest = true;
1397     }
1398
1399     if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1400       Assert(!SawReturned, "More than one parameter has attribute returned!",
1401              V);
1402       Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1403              "Incompatible "
1404              "argument and return types for 'returned' attribute",
1405              V);
1406       SawReturned = true;
1407     }
1408
1409     if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1410       Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1411       Assert(Idx == 1 || Idx == 2,
1412              "Attribute 'sret' is not on first or second parameter!", V);
1413       SawSRet = true;
1414     }
1415
1416     if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1417       Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1418              V);
1419     }
1420   }
1421
1422   if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1423     return;
1424
1425   VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1426
1427   Assert(
1428       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1429         Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1430       "Attributes 'readnone and readonly' are incompatible!", V);
1431
1432   Assert(
1433       !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1434         Attrs.hasAttribute(AttributeSet::FunctionIndex,
1435                            Attribute::AlwaysInline)),
1436       "Attributes 'noinline and alwaysinline' are incompatible!", V);
1437
1438   if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 
1439                          Attribute::OptimizeNone)) {
1440     Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1441            "Attribute 'optnone' requires 'noinline'!", V);
1442
1443     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1444                                Attribute::OptimizeForSize),
1445            "Attributes 'optsize and optnone' are incompatible!", V);
1446
1447     Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1448            "Attributes 'minsize and optnone' are incompatible!", V);
1449   }
1450
1451   if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1452                          Attribute::JumpTable)) {
1453     const GlobalValue *GV = cast<GlobalValue>(V);
1454     Assert(GV->hasUnnamedAddr(),
1455            "Attribute 'jumptable' requires 'unnamed_addr'", V);
1456   }
1457 }
1458
1459 void Verifier::VerifyFunctionMetadata(
1460     const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1461   if (MDs.empty())
1462     return;
1463
1464   for (unsigned i = 0; i < MDs.size(); i++) {
1465     if (MDs[i].first == LLVMContext::MD_prof) {
1466       MDNode *MD = MDs[i].second;
1467       Assert(MD->getNumOperands() == 2,
1468              "!prof annotations should have exactly 2 operands", MD);
1469
1470       // Check first operand.
1471       Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1472              MD);
1473       Assert(isa<MDString>(MD->getOperand(0)),
1474              "expected string with name of the !prof annotation", MD);
1475       MDString *MDS = cast<MDString>(MD->getOperand(0));
1476       StringRef ProfName = MDS->getString();
1477       Assert(ProfName.equals("function_entry_count"),
1478              "first operand should be 'function_entry_count'", MD);
1479
1480       // Check second operand.
1481       Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1482              MD);
1483       Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1484              "expected integer argument to function_entry_count", MD);
1485     }
1486   }
1487 }
1488
1489 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1490   if (CE->getOpcode() != Instruction::BitCast)
1491     return;
1492
1493   Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1494                                CE->getType()),
1495          "Invalid bitcast", CE);
1496 }
1497
1498 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1499   if (Attrs.getNumSlots() == 0)
1500     return true;
1501
1502   unsigned LastSlot = Attrs.getNumSlots() - 1;
1503   unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1504   if (LastIndex <= Params
1505       || (LastIndex == AttributeSet::FunctionIndex
1506           && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1507     return true;
1508
1509   return false;
1510 }
1511
1512 /// \brief Verify that statepoint intrinsic is well formed.
1513 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1514   assert(CS.getCalledFunction() &&
1515          CS.getCalledFunction()->getIntrinsicID() ==
1516            Intrinsic::experimental_gc_statepoint);
1517
1518   const Instruction &CI = *CS.getInstruction();
1519
1520   Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1521          !CS.onlyAccessesArgMemory(),
1522          "gc.statepoint must read and write all memory to preserve "
1523          "reordering restrictions required by safepoint semantics",
1524          &CI);
1525
1526   const Value *IDV = CS.getArgument(0);
1527   Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1528          &CI);
1529
1530   const Value *NumPatchBytesV = CS.getArgument(1);
1531   Assert(isa<ConstantInt>(NumPatchBytesV),
1532          "gc.statepoint number of patchable bytes must be a constant integer",
1533          &CI);
1534   const int64_t NumPatchBytes =
1535       cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1536   assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1537   Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1538                              "positive",
1539          &CI);
1540
1541   const Value *Target = CS.getArgument(2);
1542   const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1543   Assert(PT && PT->getElementType()->isFunctionTy(),
1544          "gc.statepoint callee must be of function pointer type", &CI, Target);
1545   FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1546
1547   const Value *NumCallArgsV = CS.getArgument(3);
1548   Assert(isa<ConstantInt>(NumCallArgsV),
1549          "gc.statepoint number of arguments to underlying call "
1550          "must be constant integer",
1551          &CI);
1552   const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1553   Assert(NumCallArgs >= 0,
1554          "gc.statepoint number of arguments to underlying call "
1555          "must be positive",
1556          &CI);
1557   const int NumParams = (int)TargetFuncType->getNumParams();
1558   if (TargetFuncType->isVarArg()) {
1559     Assert(NumCallArgs >= NumParams,
1560            "gc.statepoint mismatch in number of vararg call args", &CI);
1561
1562     // TODO: Remove this limitation
1563     Assert(TargetFuncType->getReturnType()->isVoidTy(),
1564            "gc.statepoint doesn't support wrapping non-void "
1565            "vararg functions yet",
1566            &CI);
1567   } else
1568     Assert(NumCallArgs == NumParams,
1569            "gc.statepoint mismatch in number of call args", &CI);
1570
1571   const Value *FlagsV = CS.getArgument(4);
1572   Assert(isa<ConstantInt>(FlagsV),
1573          "gc.statepoint flags must be constant integer", &CI);
1574   const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1575   Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1576          "unknown flag used in gc.statepoint flags argument", &CI);
1577
1578   // Verify that the types of the call parameter arguments match
1579   // the type of the wrapped callee.
1580   for (int i = 0; i < NumParams; i++) {
1581     Type *ParamType = TargetFuncType->getParamType(i);
1582     Type *ArgType = CS.getArgument(5 + i)->getType();
1583     Assert(ArgType == ParamType,
1584            "gc.statepoint call argument does not match wrapped "
1585            "function type",
1586            &CI);
1587   }
1588
1589   const int EndCallArgsInx = 4 + NumCallArgs;
1590
1591   const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1592   Assert(isa<ConstantInt>(NumTransitionArgsV),
1593          "gc.statepoint number of transition arguments "
1594          "must be constant integer",
1595          &CI);
1596   const int NumTransitionArgs =
1597       cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1598   Assert(NumTransitionArgs >= 0,
1599          "gc.statepoint number of transition arguments must be positive", &CI);
1600   const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1601
1602   const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1603   Assert(isa<ConstantInt>(NumDeoptArgsV),
1604          "gc.statepoint number of deoptimization arguments "
1605          "must be constant integer",
1606          &CI);
1607   const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1608   Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1609                             "must be positive",
1610          &CI);
1611
1612   const int ExpectedNumArgs =
1613       7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1614   Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1615          "gc.statepoint too few arguments according to length fields", &CI);
1616
1617   // Check that the only uses of this gc.statepoint are gc.result or 
1618   // gc.relocate calls which are tied to this statepoint and thus part
1619   // of the same statepoint sequence
1620   for (const User *U : CI.users()) {
1621     const CallInst *Call = dyn_cast<const CallInst>(U);
1622     Assert(Call, "illegal use of statepoint token", &CI, U);
1623     if (!Call) continue;
1624     Assert(isGCRelocate(Call) || isGCResult(Call),
1625            "gc.result or gc.relocate are the only value uses"
1626            "of a gc.statepoint",
1627            &CI, U);
1628     if (isGCResult(Call)) {
1629       Assert(Call->getArgOperand(0) == &CI,
1630              "gc.result connected to wrong gc.statepoint", &CI, Call);
1631     } else if (isGCRelocate(Call)) {
1632       Assert(Call->getArgOperand(0) == &CI,
1633              "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1634     }
1635   }
1636
1637   // Note: It is legal for a single derived pointer to be listed multiple
1638   // times.  It's non-optimal, but it is legal.  It can also happen after
1639   // insertion if we strip a bitcast away.
1640   // Note: It is really tempting to check that each base is relocated and
1641   // that a derived pointer is never reused as a base pointer.  This turns
1642   // out to be problematic since optimizations run after safepoint insertion
1643   // can recognize equality properties that the insertion logic doesn't know
1644   // about.  See example statepoint.ll in the verifier subdirectory
1645 }
1646
1647 void Verifier::verifyFrameRecoverIndices() {
1648   for (auto &Counts : FrameEscapeInfo) {
1649     Function *F = Counts.first;
1650     unsigned EscapedObjectCount = Counts.second.first;
1651     unsigned MaxRecoveredIndex = Counts.second.second;
1652     Assert(MaxRecoveredIndex <= EscapedObjectCount,
1653            "all indices passed to llvm.localrecover must be less than the "
1654            "number of arguments passed ot llvm.localescape in the parent "
1655            "function",
1656            F);
1657   }
1658 }
1659
1660 // visitFunction - Verify that a function is ok.
1661 //
1662 void Verifier::visitFunction(const Function &F) {
1663   // Check function arguments.
1664   FunctionType *FT = F.getFunctionType();
1665   unsigned NumArgs = F.arg_size();
1666
1667   Assert(Context == &F.getContext(),
1668          "Function context does not match Module context!", &F);
1669
1670   Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1671   Assert(FT->getNumParams() == NumArgs,
1672          "# formal arguments must match # of arguments for function type!", &F,
1673          FT);
1674   Assert(F.getReturnType()->isFirstClassType() ||
1675              F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1676          "Functions cannot return aggregate values!", &F);
1677
1678   Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1679          "Invalid struct return type!", &F);
1680
1681   AttributeSet Attrs = F.getAttributes();
1682
1683   Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1684          "Attribute after last parameter!", &F);
1685
1686   // Check function attributes.
1687   VerifyFunctionAttrs(FT, Attrs, &F);
1688
1689   // On function declarations/definitions, we do not support the builtin
1690   // attribute. We do not check this in VerifyFunctionAttrs since that is
1691   // checking for Attributes that can/can not ever be on functions.
1692   Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1693          "Attribute 'builtin' can only be applied to a callsite.", &F);
1694
1695   // Check that this function meets the restrictions on this calling convention.
1696   // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1697   // restrictions can be lifted.
1698   switch (F.getCallingConv()) {
1699   default:
1700   case CallingConv::C:
1701     break;
1702   case CallingConv::Fast:
1703   case CallingConv::Cold:
1704   case CallingConv::Intel_OCL_BI:
1705   case CallingConv::PTX_Kernel:
1706   case CallingConv::PTX_Device:
1707     Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1708                           "perfect forwarding!",
1709            &F);
1710     break;
1711   }
1712
1713   bool isLLVMdotName = F.getName().size() >= 5 &&
1714                        F.getName().substr(0, 5) == "llvm.";
1715
1716   // Check that the argument values match the function type for this function...
1717   unsigned i = 0;
1718   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1719        ++I, ++i) {
1720     Assert(I->getType() == FT->getParamType(i),
1721            "Argument value does not match function argument type!", I,
1722            FT->getParamType(i));
1723     Assert(I->getType()->isFirstClassType(),
1724            "Function arguments must have first-class types!", I);
1725     if (!isLLVMdotName)
1726       Assert(!I->getType()->isMetadataTy(),
1727              "Function takes metadata but isn't an intrinsic", I, &F);
1728   }
1729
1730   // Get the function metadata attachments.
1731   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1732   F.getAllMetadata(MDs);
1733   assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1734   VerifyFunctionMetadata(MDs);
1735
1736   if (F.isMaterializable()) {
1737     // Function has a body somewhere we can't see.
1738     Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1739            MDs.empty() ? nullptr : MDs.front().second);
1740   } else if (F.isDeclaration()) {
1741     Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1742            "invalid linkage type for function declaration", &F);
1743     Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1744            MDs.empty() ? nullptr : MDs.front().second);
1745     Assert(!F.hasPersonalityFn(),
1746            "Function declaration shouldn't have a personality routine", &F);
1747   } else {
1748     // Verify that this function (which has a body) is not named "llvm.*".  It
1749     // is not legal to define intrinsics.
1750     Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1751
1752     // Check the entry node
1753     const BasicBlock *Entry = &F.getEntryBlock();
1754     Assert(pred_empty(Entry),
1755            "Entry block to function must not have predecessors!", Entry);
1756
1757     // The address of the entry block cannot be taken, unless it is dead.
1758     if (Entry->hasAddressTaken()) {
1759       Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1760              "blockaddress may not be used with the entry block!", Entry);
1761     }
1762
1763     // Visit metadata attachments.
1764     for (const auto &I : MDs)
1765       visitMDNode(*I.second);
1766   }
1767
1768   // If this function is actually an intrinsic, verify that it is only used in
1769   // direct call/invokes, never having its "address taken".
1770   if (F.getIntrinsicID()) {
1771     const User *U;
1772     if (F.hasAddressTaken(&U))
1773       Assert(0, "Invalid user of intrinsic instruction!", U);
1774   }
1775
1776   Assert(!F.hasDLLImportStorageClass() ||
1777              (F.isDeclaration() && F.hasExternalLinkage()) ||
1778              F.hasAvailableExternallyLinkage(),
1779          "Function is marked as dllimport, but not external.", &F);
1780 }
1781
1782 // verifyBasicBlock - Verify that a basic block is well formed...
1783 //
1784 void Verifier::visitBasicBlock(BasicBlock &BB) {
1785   InstsInThisBlock.clear();
1786
1787   // Ensure that basic blocks have terminators!
1788   Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1789
1790   // Check constraints that this basic block imposes on all of the PHI nodes in
1791   // it.
1792   if (isa<PHINode>(BB.front())) {
1793     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1794     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1795     std::sort(Preds.begin(), Preds.end());
1796     PHINode *PN;
1797     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1798       // Ensure that PHI nodes have at least one entry!
1799       Assert(PN->getNumIncomingValues() != 0,
1800              "PHI nodes must have at least one entry.  If the block is dead, "
1801              "the PHI should be removed!",
1802              PN);
1803       Assert(PN->getNumIncomingValues() == Preds.size(),
1804              "PHINode should have one entry for each predecessor of its "
1805              "parent basic block!",
1806              PN);
1807
1808       // Get and sort all incoming values in the PHI node...
1809       Values.clear();
1810       Values.reserve(PN->getNumIncomingValues());
1811       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1812         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1813                                         PN->getIncomingValue(i)));
1814       std::sort(Values.begin(), Values.end());
1815
1816       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1817         // Check to make sure that if there is more than one entry for a
1818         // particular basic block in this PHI node, that the incoming values are
1819         // all identical.
1820         //
1821         Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1822                    Values[i].second == Values[i - 1].second,
1823                "PHI node has multiple entries for the same basic block with "
1824                "different incoming values!",
1825                PN, Values[i].first, Values[i].second, Values[i - 1].second);
1826
1827         // Check to make sure that the predecessors and PHI node entries are
1828         // matched up.
1829         Assert(Values[i].first == Preds[i],
1830                "PHI node entries do not match predecessors!", PN,
1831                Values[i].first, Preds[i]);
1832       }
1833     }
1834   }
1835
1836   // Check that all instructions have their parent pointers set up correctly.
1837   for (auto &I : BB)
1838   {
1839     Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1840   }
1841 }
1842
1843 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1844   // Ensure that terminators only exist at the end of the basic block.
1845   Assert(&I == I.getParent()->getTerminator(),
1846          "Terminator found in the middle of a basic block!", I.getParent());
1847   visitInstruction(I);
1848 }
1849
1850 void Verifier::visitBranchInst(BranchInst &BI) {
1851   if (BI.isConditional()) {
1852     Assert(BI.getCondition()->getType()->isIntegerTy(1),
1853            "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1854   }
1855   visitTerminatorInst(BI);
1856 }
1857
1858 void Verifier::visitReturnInst(ReturnInst &RI) {
1859   Function *F = RI.getParent()->getParent();
1860   unsigned N = RI.getNumOperands();
1861   if (F->getReturnType()->isVoidTy())
1862     Assert(N == 0,
1863            "Found return instr that returns non-void in Function of void "
1864            "return type!",
1865            &RI, F->getReturnType());
1866   else
1867     Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1868            "Function return type does not match operand "
1869            "type of return inst!",
1870            &RI, F->getReturnType());
1871
1872   // Check to make sure that the return value has necessary properties for
1873   // terminators...
1874   visitTerminatorInst(RI);
1875 }
1876
1877 void Verifier::visitSwitchInst(SwitchInst &SI) {
1878   // Check to make sure that all of the constants in the switch instruction
1879   // have the same type as the switched-on value.
1880   Type *SwitchTy = SI.getCondition()->getType();
1881   SmallPtrSet<ConstantInt*, 32> Constants;
1882   for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1883     Assert(i.getCaseValue()->getType() == SwitchTy,
1884            "Switch constants must all be same type as switch value!", &SI);
1885     Assert(Constants.insert(i.getCaseValue()).second,
1886            "Duplicate integer as switch case", &SI, i.getCaseValue());
1887   }
1888
1889   visitTerminatorInst(SI);
1890 }
1891
1892 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1893   Assert(BI.getAddress()->getType()->isPointerTy(),
1894          "Indirectbr operand must have pointer type!", &BI);
1895   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1896     Assert(BI.getDestination(i)->getType()->isLabelTy(),
1897            "Indirectbr destinations must all have pointer type!", &BI);
1898
1899   visitTerminatorInst(BI);
1900 }
1901
1902 void Verifier::visitSelectInst(SelectInst &SI) {
1903   Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1904                                          SI.getOperand(2)),
1905          "Invalid operands for select instruction!", &SI);
1906
1907   Assert(SI.getTrueValue()->getType() == SI.getType(),
1908          "Select values must have same type as select instruction!", &SI);
1909   visitInstruction(SI);
1910 }
1911
1912 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1913 /// a pass, if any exist, it's an error.
1914 ///
1915 void Verifier::visitUserOp1(Instruction &I) {
1916   Assert(0, "User-defined operators should not live outside of a pass!", &I);
1917 }
1918
1919 void Verifier::visitTruncInst(TruncInst &I) {
1920   // Get the source and destination types
1921   Type *SrcTy = I.getOperand(0)->getType();
1922   Type *DestTy = I.getType();
1923
1924   // Get the size of the types in bits, we'll need this later
1925   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1926   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1927
1928   Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1929   Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1930   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1931          "trunc source and destination must both be a vector or neither", &I);
1932   Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1933
1934   visitInstruction(I);
1935 }
1936
1937 void Verifier::visitZExtInst(ZExtInst &I) {
1938   // Get the source and destination types
1939   Type *SrcTy = I.getOperand(0)->getType();
1940   Type *DestTy = I.getType();
1941
1942   // Get the size of the types in bits, we'll need this later
1943   Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1944   Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1945   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1946          "zext source and destination must both be a vector or neither", &I);
1947   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1948   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1949
1950   Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1951
1952   visitInstruction(I);
1953 }
1954
1955 void Verifier::visitSExtInst(SExtInst &I) {
1956   // Get the source and destination types
1957   Type *SrcTy = I.getOperand(0)->getType();
1958   Type *DestTy = I.getType();
1959
1960   // Get the size of the types in bits, we'll need this later
1961   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1962   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1963
1964   Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1965   Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1966   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1967          "sext source and destination must both be a vector or neither", &I);
1968   Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1969
1970   visitInstruction(I);
1971 }
1972
1973 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1974   // Get the source and destination types
1975   Type *SrcTy = I.getOperand(0)->getType();
1976   Type *DestTy = I.getType();
1977   // Get the size of the types in bits, we'll need this later
1978   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1979   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1980
1981   Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1982   Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1983   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1984          "fptrunc source and destination must both be a vector or neither", &I);
1985   Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1986
1987   visitInstruction(I);
1988 }
1989
1990 void Verifier::visitFPExtInst(FPExtInst &I) {
1991   // Get the source and destination types
1992   Type *SrcTy = I.getOperand(0)->getType();
1993   Type *DestTy = I.getType();
1994
1995   // Get the size of the types in bits, we'll need this later
1996   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1997   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1998
1999   Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2000   Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2001   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2002          "fpext source and destination must both be a vector or neither", &I);
2003   Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2004
2005   visitInstruction(I);
2006 }
2007
2008 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2009   // Get the source and destination types
2010   Type *SrcTy = I.getOperand(0)->getType();
2011   Type *DestTy = I.getType();
2012
2013   bool SrcVec = SrcTy->isVectorTy();
2014   bool DstVec = DestTy->isVectorTy();
2015
2016   Assert(SrcVec == DstVec,
2017          "UIToFP source and dest must both be vector or scalar", &I);
2018   Assert(SrcTy->isIntOrIntVectorTy(),
2019          "UIToFP source must be integer or integer vector", &I);
2020   Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2021          &I);
2022
2023   if (SrcVec && DstVec)
2024     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2025                cast<VectorType>(DestTy)->getNumElements(),
2026            "UIToFP source and dest vector length mismatch", &I);
2027
2028   visitInstruction(I);
2029 }
2030
2031 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2032   // Get the source and destination types
2033   Type *SrcTy = I.getOperand(0)->getType();
2034   Type *DestTy = I.getType();
2035
2036   bool SrcVec = SrcTy->isVectorTy();
2037   bool DstVec = DestTy->isVectorTy();
2038
2039   Assert(SrcVec == DstVec,
2040          "SIToFP source and dest must both be vector or scalar", &I);
2041   Assert(SrcTy->isIntOrIntVectorTy(),
2042          "SIToFP source must be integer or integer vector", &I);
2043   Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2044          &I);
2045
2046   if (SrcVec && DstVec)
2047     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2048                cast<VectorType>(DestTy)->getNumElements(),
2049            "SIToFP source and dest vector length mismatch", &I);
2050
2051   visitInstruction(I);
2052 }
2053
2054 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2055   // Get the source and destination types
2056   Type *SrcTy = I.getOperand(0)->getType();
2057   Type *DestTy = I.getType();
2058
2059   bool SrcVec = SrcTy->isVectorTy();
2060   bool DstVec = DestTy->isVectorTy();
2061
2062   Assert(SrcVec == DstVec,
2063          "FPToUI source and dest must both be vector or scalar", &I);
2064   Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2065          &I);
2066   Assert(DestTy->isIntOrIntVectorTy(),
2067          "FPToUI result must be integer or integer vector", &I);
2068
2069   if (SrcVec && DstVec)
2070     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2071                cast<VectorType>(DestTy)->getNumElements(),
2072            "FPToUI source and dest vector length mismatch", &I);
2073
2074   visitInstruction(I);
2075 }
2076
2077 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2078   // Get the source and destination types
2079   Type *SrcTy = I.getOperand(0)->getType();
2080   Type *DestTy = I.getType();
2081
2082   bool SrcVec = SrcTy->isVectorTy();
2083   bool DstVec = DestTy->isVectorTy();
2084
2085   Assert(SrcVec == DstVec,
2086          "FPToSI source and dest must both be vector or scalar", &I);
2087   Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2088          &I);
2089   Assert(DestTy->isIntOrIntVectorTy(),
2090          "FPToSI result must be integer or integer vector", &I);
2091
2092   if (SrcVec && DstVec)
2093     Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2094                cast<VectorType>(DestTy)->getNumElements(),
2095            "FPToSI source and dest vector length mismatch", &I);
2096
2097   visitInstruction(I);
2098 }
2099
2100 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2101   // Get the source and destination types
2102   Type *SrcTy = I.getOperand(0)->getType();
2103   Type *DestTy = I.getType();
2104
2105   Assert(SrcTy->getScalarType()->isPointerTy(),
2106          "PtrToInt source must be pointer", &I);
2107   Assert(DestTy->getScalarType()->isIntegerTy(),
2108          "PtrToInt result must be integral", &I);
2109   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2110          &I);
2111
2112   if (SrcTy->isVectorTy()) {
2113     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2114     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2115     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2116            "PtrToInt Vector width mismatch", &I);
2117   }
2118
2119   visitInstruction(I);
2120 }
2121
2122 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2123   // Get the source and destination types
2124   Type *SrcTy = I.getOperand(0)->getType();
2125   Type *DestTy = I.getType();
2126
2127   Assert(SrcTy->getScalarType()->isIntegerTy(),
2128          "IntToPtr source must be an integral", &I);
2129   Assert(DestTy->getScalarType()->isPointerTy(),
2130          "IntToPtr result must be a pointer", &I);
2131   Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2132          &I);
2133   if (SrcTy->isVectorTy()) {
2134     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2135     VectorType *VDest = dyn_cast<VectorType>(DestTy);
2136     Assert(VSrc->getNumElements() == VDest->getNumElements(),
2137            "IntToPtr Vector width mismatch", &I);
2138   }
2139   visitInstruction(I);
2140 }
2141
2142 void Verifier::visitBitCastInst(BitCastInst &I) {
2143   Assert(
2144       CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2145       "Invalid bitcast", &I);
2146   visitInstruction(I);
2147 }
2148
2149 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2150   Type *SrcTy = I.getOperand(0)->getType();
2151   Type *DestTy = I.getType();
2152
2153   Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2154          &I);
2155   Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2156          &I);
2157   Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2158          "AddrSpaceCast must be between different address spaces", &I);
2159   if (SrcTy->isVectorTy())
2160     Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2161            "AddrSpaceCast vector pointer number of elements mismatch", &I);
2162   visitInstruction(I);
2163 }
2164
2165 /// visitPHINode - Ensure that a PHI node is well formed.
2166 ///
2167 void Verifier::visitPHINode(PHINode &PN) {
2168   // Ensure that the PHI nodes are all grouped together at the top of the block.
2169   // This can be tested by checking whether the instruction before this is
2170   // either nonexistent (because this is begin()) or is a PHI node.  If not,
2171   // then there is some other instruction before a PHI.
2172   Assert(&PN == &PN.getParent()->front() ||
2173              isa<PHINode>(--BasicBlock::iterator(&PN)),
2174          "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2175
2176   // Check that all of the values of the PHI node have the same type as the
2177   // result, and that the incoming blocks are really basic blocks.
2178   for (Value *IncValue : PN.incoming_values()) {
2179     Assert(PN.getType() == IncValue->getType(),
2180            "PHI node operands are not the same type as the result!", &PN);
2181   }
2182
2183   // All other PHI node constraints are checked in the visitBasicBlock method.
2184
2185   visitInstruction(PN);
2186 }
2187
2188 void Verifier::VerifyCallSite(CallSite CS) {
2189   Instruction *I = CS.getInstruction();
2190
2191   Assert(CS.getCalledValue()->getType()->isPointerTy(),
2192          "Called function must be a pointer!", I);
2193   PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2194
2195   Assert(FPTy->getElementType()->isFunctionTy(),
2196          "Called function is not pointer to function type!", I);
2197
2198   Assert(FPTy->getElementType() == CS.getFunctionType(),
2199          "Called function is not the same type as the call!", I);
2200
2201   FunctionType *FTy = CS.getFunctionType();
2202
2203   // Verify that the correct number of arguments are being passed
2204   if (FTy->isVarArg())
2205     Assert(CS.arg_size() >= FTy->getNumParams(),
2206            "Called function requires more parameters than were provided!", I);
2207   else
2208     Assert(CS.arg_size() == FTy->getNumParams(),
2209            "Incorrect number of arguments passed to called function!", I);
2210
2211   // Verify that all arguments to the call match the function type.
2212   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2213     Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2214            "Call parameter type does not match function signature!",
2215            CS.getArgument(i), FTy->getParamType(i), I);
2216
2217   AttributeSet Attrs = CS.getAttributes();
2218
2219   Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2220          "Attribute after last parameter!", I);
2221
2222   // Verify call attributes.
2223   VerifyFunctionAttrs(FTy, Attrs, I);
2224
2225   // Conservatively check the inalloca argument.
2226   // We have a bug if we can find that there is an underlying alloca without
2227   // inalloca.
2228   if (CS.hasInAllocaArgument()) {
2229     Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2230     if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2231       Assert(AI->isUsedWithInAlloca(),
2232              "inalloca argument for call has mismatched alloca", AI, I);
2233   }
2234
2235   if (FTy->isVarArg()) {
2236     // FIXME? is 'nest' even legal here?
2237     bool SawNest = false;
2238     bool SawReturned = false;
2239
2240     for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2241       if (Attrs.hasAttribute(Idx, Attribute::Nest))
2242         SawNest = true;
2243       if (Attrs.hasAttribute(Idx, Attribute::Returned))
2244         SawReturned = true;
2245     }
2246
2247     // Check attributes on the varargs part.
2248     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2249       Type *Ty = CS.getArgument(Idx-1)->getType();
2250       VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2251
2252       if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2253         Assert(!SawNest, "More than one parameter has attribute nest!", I);
2254         SawNest = true;
2255       }
2256
2257       if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2258         Assert(!SawReturned, "More than one parameter has attribute returned!",
2259                I);
2260         Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2261                "Incompatible argument and return types for 'returned' "
2262                "attribute",
2263                I);
2264         SawReturned = true;
2265       }
2266
2267       Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2268              "Attribute 'sret' cannot be used for vararg call arguments!", I);
2269
2270       if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2271         Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2272     }
2273   }
2274
2275   // Verify that there's no metadata unless it's a direct call to an intrinsic.
2276   if (CS.getCalledFunction() == nullptr ||
2277       !CS.getCalledFunction()->getName().startswith("llvm.")) {
2278     for (FunctionType::param_iterator PI = FTy->param_begin(),
2279            PE = FTy->param_end(); PI != PE; ++PI)
2280       Assert(!(*PI)->isMetadataTy(),
2281              "Function has metadata parameter but isn't an intrinsic", I);
2282   }
2283
2284   if (Function *F = CS.getCalledFunction())
2285     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2286       visitIntrinsicCallSite(ID, CS);
2287
2288   visitInstruction(*I);
2289 }
2290
2291 /// Two types are "congruent" if they are identical, or if they are both pointer
2292 /// types with different pointee types and the same address space.
2293 static bool isTypeCongruent(Type *L, Type *R) {
2294   if (L == R)
2295     return true;
2296   PointerType *PL = dyn_cast<PointerType>(L);
2297   PointerType *PR = dyn_cast<PointerType>(R);
2298   if (!PL || !PR)
2299     return false;
2300   return PL->getAddressSpace() == PR->getAddressSpace();
2301 }
2302
2303 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2304   static const Attribute::AttrKind ABIAttrs[] = {
2305       Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2306       Attribute::InReg, Attribute::Returned};
2307   AttrBuilder Copy;
2308   for (auto AK : ABIAttrs) {
2309     if (Attrs.hasAttribute(I + 1, AK))
2310       Copy.addAttribute(AK);
2311   }
2312   if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2313     Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2314   return Copy;
2315 }
2316
2317 void Verifier::verifyMustTailCall(CallInst &CI) {
2318   Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2319
2320   // - The caller and callee prototypes must match.  Pointer types of
2321   //   parameters or return types may differ in pointee type, but not
2322   //   address space.
2323   Function *F = CI.getParent()->getParent();
2324   FunctionType *CallerTy = F->getFunctionType();
2325   FunctionType *CalleeTy = CI.getFunctionType();
2326   Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2327          "cannot guarantee tail call due to mismatched parameter counts", &CI);
2328   Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2329          "cannot guarantee tail call due to mismatched varargs", &CI);
2330   Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2331          "cannot guarantee tail call due to mismatched return types", &CI);
2332   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2333     Assert(
2334         isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2335         "cannot guarantee tail call due to mismatched parameter types", &CI);
2336   }
2337
2338   // - The calling conventions of the caller and callee must match.
2339   Assert(F->getCallingConv() == CI.getCallingConv(),
2340          "cannot guarantee tail call due to mismatched calling conv", &CI);
2341
2342   // - All ABI-impacting function attributes, such as sret, byval, inreg,
2343   //   returned, and inalloca, must match.
2344   AttributeSet CallerAttrs = F->getAttributes();
2345   AttributeSet CalleeAttrs = CI.getAttributes();
2346   for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2347     AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2348     AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2349     Assert(CallerABIAttrs == CalleeABIAttrs,
2350            "cannot guarantee tail call due to mismatched ABI impacting "
2351            "function attributes",
2352            &CI, CI.getOperand(I));
2353   }
2354
2355   // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2356   //   or a pointer bitcast followed by a ret instruction.
2357   // - The ret instruction must return the (possibly bitcasted) value
2358   //   produced by the call or void.
2359   Value *RetVal = &CI;
2360   Instruction *Next = CI.getNextNode();
2361
2362   // Handle the optional bitcast.
2363   if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2364     Assert(BI->getOperand(0) == RetVal,
2365            "bitcast following musttail call must use the call", BI);
2366     RetVal = BI;
2367     Next = BI->getNextNode();
2368   }
2369
2370   // Check the return.
2371   ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2372   Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2373          &CI);
2374   Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2375          "musttail call result must be returned", Ret);
2376 }
2377
2378 void Verifier::visitCallInst(CallInst &CI) {
2379   VerifyCallSite(&CI);
2380
2381   if (CI.isMustTailCall())
2382     verifyMustTailCall(CI);
2383 }
2384
2385 void Verifier::visitInvokeInst(InvokeInst &II) {
2386   VerifyCallSite(&II);
2387
2388   // Verify that there is a landingpad instruction as the first non-PHI
2389   // instruction of the 'unwind' destination.
2390   Assert(II.getUnwindDest()->isLandingPad(),
2391          "The unwind destination does not have a landingpad instruction!", &II);
2392
2393   visitTerminatorInst(II);
2394 }
2395
2396 /// visitBinaryOperator - Check that both arguments to the binary operator are
2397 /// of the same type!
2398 ///
2399 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2400   Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2401          "Both operands to a binary operator are not of the same type!", &B);
2402
2403   switch (B.getOpcode()) {
2404   // Check that integer arithmetic operators are only used with
2405   // integral operands.
2406   case Instruction::Add:
2407   case Instruction::Sub:
2408   case Instruction::Mul:
2409   case Instruction::SDiv:
2410   case Instruction::UDiv:
2411   case Instruction::SRem:
2412   case Instruction::URem:
2413     Assert(B.getType()->isIntOrIntVectorTy(),
2414            "Integer arithmetic operators only work with integral types!", &B);
2415     Assert(B.getType() == B.getOperand(0)->getType(),
2416            "Integer arithmetic operators must have same type "
2417            "for operands and result!",
2418            &B);
2419     break;
2420   // Check that floating-point arithmetic operators are only used with
2421   // floating-point operands.
2422   case Instruction::FAdd:
2423   case Instruction::FSub:
2424   case Instruction::FMul:
2425   case Instruction::FDiv:
2426   case Instruction::FRem:
2427     Assert(B.getType()->isFPOrFPVectorTy(),
2428            "Floating-point arithmetic operators only work with "
2429            "floating-point types!",
2430            &B);
2431     Assert(B.getType() == B.getOperand(0)->getType(),
2432            "Floating-point arithmetic operators must have same type "
2433            "for operands and result!",
2434            &B);
2435     break;
2436   // Check that logical operators are only used with integral operands.
2437   case Instruction::And:
2438   case Instruction::Or:
2439   case Instruction::Xor:
2440     Assert(B.getType()->isIntOrIntVectorTy(),
2441            "Logical operators only work with integral types!", &B);
2442     Assert(B.getType() == B.getOperand(0)->getType(),
2443            "Logical operators must have same type for operands and result!",
2444            &B);
2445     break;
2446   case Instruction::Shl:
2447   case Instruction::LShr:
2448   case Instruction::AShr:
2449     Assert(B.getType()->isIntOrIntVectorTy(),
2450            "Shifts only work with integral types!", &B);
2451     Assert(B.getType() == B.getOperand(0)->getType(),
2452            "Shift return type must be same as operands!", &B);
2453     break;
2454   default:
2455     llvm_unreachable("Unknown BinaryOperator opcode!");
2456   }
2457
2458   visitInstruction(B);
2459 }
2460
2461 void Verifier::visitICmpInst(ICmpInst &IC) {
2462   // Check that the operands are the same type
2463   Type *Op0Ty = IC.getOperand(0)->getType();
2464   Type *Op1Ty = IC.getOperand(1)->getType();
2465   Assert(Op0Ty == Op1Ty,
2466          "Both operands to ICmp instruction are not of the same type!", &IC);
2467   // Check that the operands are the right type
2468   Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2469          "Invalid operand types for ICmp instruction", &IC);
2470   // Check that the predicate is valid.
2471   Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2472              IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2473          "Invalid predicate in ICmp instruction!", &IC);
2474
2475   visitInstruction(IC);
2476 }
2477
2478 void Verifier::visitFCmpInst(FCmpInst &FC) {
2479   // Check that the operands are the same type
2480   Type *Op0Ty = FC.getOperand(0)->getType();
2481   Type *Op1Ty = FC.getOperand(1)->getType();
2482   Assert(Op0Ty == Op1Ty,
2483          "Both operands to FCmp instruction are not of the same type!", &FC);
2484   // Check that the operands are the right type
2485   Assert(Op0Ty->isFPOrFPVectorTy(),
2486          "Invalid operand types for FCmp instruction", &FC);
2487   // Check that the predicate is valid.
2488   Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2489              FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2490          "Invalid predicate in FCmp instruction!", &FC);
2491
2492   visitInstruction(FC);
2493 }
2494
2495 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2496   Assert(
2497       ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2498       "Invalid extractelement operands!", &EI);
2499   visitInstruction(EI);
2500 }
2501
2502 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2503   Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2504                                             IE.getOperand(2)),
2505          "Invalid insertelement operands!", &IE);
2506   visitInstruction(IE);
2507 }
2508
2509 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2510   Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2511                                             SV.getOperand(2)),
2512          "Invalid shufflevector operands!", &SV);
2513   visitInstruction(SV);
2514 }
2515
2516 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2517   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2518
2519   Assert(isa<PointerType>(TargetTy),
2520          "GEP base pointer is not a vector or a vector of pointers", &GEP);
2521   Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2522   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2523   Type *ElTy =
2524       GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2525   Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2526
2527   Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2528              GEP.getResultElementType() == ElTy,
2529          "GEP is not of right type for indices!", &GEP, ElTy);
2530
2531   if (GEP.getType()->isVectorTy()) {
2532     // Additional checks for vector GEPs.
2533     unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2534     if (GEP.getPointerOperandType()->isVectorTy())
2535       Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2536              "Vector GEP result width doesn't match operand's", &GEP);
2537     for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2538       Type *IndexTy = Idxs[i]->getType();
2539       if (IndexTy->isVectorTy()) {
2540         unsigned IndexWidth = IndexTy->getVectorNumElements();
2541         Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2542       }
2543       Assert(IndexTy->getScalarType()->isIntegerTy(),
2544              "All GEP indices should be of integer type");
2545     }
2546   }
2547   visitInstruction(GEP);
2548 }
2549
2550 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2551   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2552 }
2553
2554 void Verifier::visitRangeMetadata(Instruction& I,
2555                                   MDNode* Range, Type* Ty) {
2556   assert(Range &&
2557          Range == I.getMetadata(LLVMContext::MD_range) &&
2558          "precondition violation");
2559
2560   unsigned NumOperands = Range->getNumOperands();
2561   Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2562   unsigned NumRanges = NumOperands / 2;
2563   Assert(NumRanges >= 1, "It should have at least one range!", Range);
2564
2565   ConstantRange LastRange(1); // Dummy initial value
2566   for (unsigned i = 0; i < NumRanges; ++i) {
2567     ConstantInt *Low =
2568         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2569     Assert(Low, "The lower limit must be an integer!", Low);
2570     ConstantInt *High =
2571         mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2572     Assert(High, "The upper limit must be an integer!", High);
2573     Assert(High->getType() == Low->getType() && High->getType() == Ty,
2574            "Range types must match instruction type!", &I);
2575
2576     APInt HighV = High->getValue();
2577     APInt LowV = Low->getValue();
2578     ConstantRange CurRange(LowV, HighV);
2579     Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2580            "Range must not be empty!", Range);
2581     if (i != 0) {
2582       Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2583              "Intervals are overlapping", Range);
2584       Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2585              Range);
2586       Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2587              Range);
2588     }
2589     LastRange = ConstantRange(LowV, HighV);
2590   }
2591   if (NumRanges > 2) {
2592     APInt FirstLow =
2593         mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2594     APInt FirstHigh =
2595         mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2596     ConstantRange FirstRange(FirstLow, FirstHigh);
2597     Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2598            "Intervals are overlapping", Range);
2599     Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2600            Range);
2601   }
2602 }
2603
2604 void Verifier::visitLoadInst(LoadInst &LI) {
2605   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2606   Assert(PTy, "Load operand must be a pointer.", &LI);
2607   Type *ElTy = LI.getType();
2608   Assert(LI.getAlignment() <= Value::MaximumAlignment,
2609          "huge alignment values are unsupported", &LI);
2610   if (LI.isAtomic()) {
2611     Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2612            "Load cannot have Release ordering", &LI);
2613     Assert(LI.getAlignment() != 0,
2614            "Atomic load must specify explicit alignment", &LI);
2615     if (!ElTy->isPointerTy()) {
2616       Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2617              &LI, ElTy);
2618       unsigned Size = ElTy->getPrimitiveSizeInBits();
2619       Assert(Size >= 8 && !(Size & (Size - 1)),
2620              "atomic load operand must be power-of-two byte-sized integer", &LI,
2621              ElTy);
2622     }
2623   } else {
2624     Assert(LI.getSynchScope() == CrossThread,
2625            "Non-atomic load cannot have SynchronizationScope specified", &LI);
2626   }
2627
2628   visitInstruction(LI);
2629 }
2630
2631 void Verifier::visitStoreInst(StoreInst &SI) {
2632   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2633   Assert(PTy, "Store operand must be a pointer.", &SI);
2634   Type *ElTy = PTy->getElementType();
2635   Assert(ElTy == SI.getOperand(0)->getType(),
2636          "Stored value type does not match pointer operand type!", &SI, ElTy);
2637   Assert(SI.getAlignment() <= Value::MaximumAlignment,
2638          "huge alignment values are unsupported", &SI);
2639   if (SI.isAtomic()) {
2640     Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2641            "Store cannot have Acquire ordering", &SI);
2642     Assert(SI.getAlignment() != 0,
2643            "Atomic store must specify explicit alignment", &SI);
2644     if (!ElTy->isPointerTy()) {
2645       Assert(ElTy->isIntegerTy(),
2646              "atomic store operand must have integer type!", &SI, ElTy);
2647       unsigned Size = ElTy->getPrimitiveSizeInBits();
2648       Assert(Size >= 8 && !(Size & (Size - 1)),
2649              "atomic store operand must be power-of-two byte-sized integer",
2650              &SI, ElTy);
2651     }
2652   } else {
2653     Assert(SI.getSynchScope() == CrossThread,
2654            "Non-atomic store cannot have SynchronizationScope specified", &SI);
2655   }
2656   visitInstruction(SI);
2657 }
2658
2659 void Verifier::visitAllocaInst(AllocaInst &AI) {
2660   SmallPtrSet<const Type*, 4> Visited;
2661   PointerType *PTy = AI.getType();
2662   Assert(PTy->getAddressSpace() == 0,
2663          "Allocation instruction pointer not in the generic address space!",
2664          &AI);
2665   Assert(AI.getAllocatedType()->isSized(&Visited),
2666          "Cannot allocate unsized type", &AI);
2667   Assert(AI.getArraySize()->getType()->isIntegerTy(),
2668          "Alloca array size must have integer type", &AI);
2669   Assert(AI.getAlignment() <= Value::MaximumAlignment,
2670          "huge alignment values are unsupported", &AI);
2671
2672   visitInstruction(AI);
2673 }
2674
2675 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2676
2677   // FIXME: more conditions???
2678   Assert(CXI.getSuccessOrdering() != NotAtomic,
2679          "cmpxchg instructions must be atomic.", &CXI);
2680   Assert(CXI.getFailureOrdering() != NotAtomic,
2681          "cmpxchg instructions must be atomic.", &CXI);
2682   Assert(CXI.getSuccessOrdering() != Unordered,
2683          "cmpxchg instructions cannot be unordered.", &CXI);
2684   Assert(CXI.getFailureOrdering() != Unordered,
2685          "cmpxchg instructions cannot be unordered.", &CXI);
2686   Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2687          "cmpxchg instructions be at least as constrained on success as fail",
2688          &CXI);
2689   Assert(CXI.getFailureOrdering() != Release &&
2690              CXI.getFailureOrdering() != AcquireRelease,
2691          "cmpxchg failure ordering cannot include release semantics", &CXI);
2692
2693   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2694   Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2695   Type *ElTy = PTy->getElementType();
2696   Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2697          ElTy);
2698   unsigned Size = ElTy->getPrimitiveSizeInBits();
2699   Assert(Size >= 8 && !(Size & (Size - 1)),
2700          "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2701   Assert(ElTy == CXI.getOperand(1)->getType(),
2702          "Expected value type does not match pointer operand type!", &CXI,
2703          ElTy);
2704   Assert(ElTy == CXI.getOperand(2)->getType(),
2705          "Stored value type does not match pointer operand type!", &CXI, ElTy);
2706   visitInstruction(CXI);
2707 }
2708
2709 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2710   Assert(RMWI.getOrdering() != NotAtomic,
2711          "atomicrmw instructions must be atomic.", &RMWI);
2712   Assert(RMWI.getOrdering() != Unordered,
2713          "atomicrmw instructions cannot be unordered.", &RMWI);
2714   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2715   Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2716   Type *ElTy = PTy->getElementType();
2717   Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2718          &RMWI, ElTy);
2719   unsigned Size = ElTy->getPrimitiveSizeInBits();
2720   Assert(Size >= 8 && !(Size & (Size - 1)),
2721          "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2722          ElTy);
2723   Assert(ElTy == RMWI.getOperand(1)->getType(),
2724          "Argument value type does not match pointer operand type!", &RMWI,
2725          ElTy);
2726   Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2727              RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2728          "Invalid binary operation!", &RMWI);
2729   visitInstruction(RMWI);
2730 }
2731
2732 void Verifier::visitFenceInst(FenceInst &FI) {
2733   const AtomicOrdering Ordering = FI.getOrdering();
2734   Assert(Ordering == Acquire || Ordering == Release ||
2735              Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2736          "fence instructions may only have "
2737          "acquire, release, acq_rel, or seq_cst ordering.",
2738          &FI);
2739   visitInstruction(FI);
2740 }
2741
2742 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2743   Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2744                                           EVI.getIndices()) == EVI.getType(),
2745          "Invalid ExtractValueInst operands!", &EVI);
2746
2747   visitInstruction(EVI);
2748 }
2749
2750 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2751   Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2752                                           IVI.getIndices()) ==
2753              IVI.getOperand(1)->getType(),
2754          "Invalid InsertValueInst operands!", &IVI);
2755
2756   visitInstruction(IVI);
2757 }
2758
2759 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2760   BasicBlock *BB = LPI.getParent();
2761
2762   // The landingpad instruction is ill-formed if it doesn't have any clauses and
2763   // isn't a cleanup.
2764   Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2765          "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2766
2767   // The landingpad instruction defines its parent as a landing pad block. The
2768   // landing pad block may be branched to only by the unwind edge of an invoke.
2769   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2770     const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2771     Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2772            "Block containing LandingPadInst must be jumped to "
2773            "only by the unwind edge of an invoke.",
2774            &LPI);
2775   }
2776
2777   Function *F = LPI.getParent()->getParent();
2778   Assert(F->hasPersonalityFn(),
2779          "LandingPadInst needs to be in a function with a personality.", &LPI);
2780
2781   // The landingpad instruction must be the first non-PHI instruction in the
2782   // block.
2783   Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2784          "LandingPadInst not the first non-PHI instruction in the block.",
2785          &LPI);
2786
2787   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2788     Constant *Clause = LPI.getClause(i);
2789     if (LPI.isCatch(i)) {
2790       Assert(isa<PointerType>(Clause->getType()),
2791              "Catch operand does not have pointer type!", &LPI);
2792     } else {
2793       Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2794       Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2795              "Filter operand is not an array of constants!", &LPI);
2796     }
2797   }
2798
2799   visitInstruction(LPI);
2800 }
2801
2802 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2803   Instruction *Op = cast<Instruction>(I.getOperand(i));
2804   // If the we have an invalid invoke, don't try to compute the dominance.
2805   // We already reject it in the invoke specific checks and the dominance
2806   // computation doesn't handle multiple edges.
2807   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2808     if (II->getNormalDest() == II->getUnwindDest())
2809       return;
2810   }
2811
2812   const Use &U = I.getOperandUse(i);
2813   Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2814          "Instruction does not dominate all uses!", Op, &I);
2815 }
2816
2817 /// verifyInstruction - Verify that an instruction is well formed.
2818 ///
2819 void Verifier::visitInstruction(Instruction &I) {
2820   BasicBlock *BB = I.getParent();
2821   Assert(BB, "Instruction not embedded in basic block!", &I);
2822
2823   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
2824     for (User *U : I.users()) {
2825       Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2826              "Only PHI nodes may reference their own value!", &I);
2827     }
2828   }
2829
2830   // Check that void typed values don't have names
2831   Assert(!I.getType()->isVoidTy() || !I.hasName(),
2832          "Instruction has a name, but provides a void value!", &I);
2833
2834   // Check that the return value of the instruction is either void or a legal
2835   // value type.
2836   Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2837          "Instruction returns a non-scalar type!", &I);
2838
2839   // Check that the instruction doesn't produce metadata. Calls are already
2840   // checked against the callee type.
2841   Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2842          "Invalid use of metadata!", &I);
2843
2844   // Check that all uses of the instruction, if they are instructions
2845   // themselves, actually have parent basic blocks.  If the use is not an
2846   // instruction, it is an error!
2847   for (Use &U : I.uses()) {
2848     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2849       Assert(Used->getParent() != nullptr,
2850              "Instruction referencing"
2851              " instruction not embedded in a basic block!",
2852              &I, Used);
2853     else {
2854       CheckFailed("Use of instruction is not an instruction!", U);
2855       return;
2856     }
2857   }
2858
2859   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2860     Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2861
2862     // Check to make sure that only first-class-values are operands to
2863     // instructions.
2864     if (!I.getOperand(i)->getType()->isFirstClassType()) {
2865       Assert(0, "Instruction operands must be first-class values!", &I);
2866     }
2867
2868     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2869       // Check to make sure that the "address of" an intrinsic function is never
2870       // taken.
2871       Assert(
2872           !F->isIntrinsic() ||
2873               i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2874           "Cannot take the address of an intrinsic!", &I);
2875       Assert(
2876           !F->isIntrinsic() || isa<CallInst>(I) ||
2877               F->getIntrinsicID() == Intrinsic::donothing ||
2878               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2879               F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2880               F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2881           "Cannot invoke an intrinsinc other than"
2882           " donothing or patchpoint",
2883           &I);
2884       Assert(F->getParent() == M, "Referencing function in another module!",
2885              &I);
2886     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2887       Assert(OpBB->getParent() == BB->getParent(),
2888              "Referring to a basic block in another function!", &I);
2889     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2890       Assert(OpArg->getParent() == BB->getParent(),
2891              "Referring to an argument in another function!", &I);
2892     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2893       Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2894     } else if (isa<Instruction>(I.getOperand(i))) {
2895       verifyDominatesUse(I, i);
2896     } else if (isa<InlineAsm>(I.getOperand(i))) {
2897       Assert((i + 1 == e && isa<CallInst>(I)) ||
2898                  (i + 3 == e && isa<InvokeInst>(I)),
2899              "Cannot take the address of an inline asm!", &I);
2900     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2901       if (CE->getType()->isPtrOrPtrVectorTy()) {
2902         // If we have a ConstantExpr pointer, we need to see if it came from an
2903         // illegal bitcast (inttoptr <constant int> )
2904         SmallVector<const ConstantExpr *, 4> Stack;
2905         SmallPtrSet<const ConstantExpr *, 4> Visited;
2906         Stack.push_back(CE);
2907
2908         while (!Stack.empty()) {
2909           const ConstantExpr *V = Stack.pop_back_val();
2910           if (!Visited.insert(V).second)
2911             continue;
2912
2913           VerifyConstantExprBitcastType(V);
2914
2915           for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2916             if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2917               Stack.push_back(Op);
2918           }
2919         }
2920       }
2921     }
2922   }
2923
2924   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2925     Assert(I.getType()->isFPOrFPVectorTy(),
2926            "fpmath requires a floating point result!", &I);
2927     Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2928     if (ConstantFP *CFP0 =
2929             mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2930       APFloat Accuracy = CFP0->getValueAPF();
2931       Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2932              "fpmath accuracy not a positive number!", &I);
2933     } else {
2934       Assert(false, "invalid fpmath accuracy!", &I);
2935     }
2936   }
2937
2938   if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2939     Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2940            "Ranges are only for loads, calls and invokes!", &I);
2941     visitRangeMetadata(I, Range, I.getType());
2942   }
2943
2944   if (I.getMetadata(LLVMContext::MD_nonnull)) {
2945     Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2946            &I);
2947     Assert(isa<LoadInst>(I),
2948            "nonnull applies only to load instructions, use attributes"
2949            " for calls or invokes",
2950            &I);
2951   }
2952
2953   if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2954     Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
2955     visitMDNode(*N);
2956   }
2957
2958   InstsInThisBlock.insert(&I);
2959 }
2960
2961 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2962 /// intrinsic argument or return value) matches the type constraints specified
2963 /// by the .td file (e.g. an "any integer" argument really is an integer).
2964 ///
2965 /// This return true on error but does not print a message.
2966 bool Verifier::VerifyIntrinsicType(Type *Ty,
2967                                    ArrayRef<Intrinsic::IITDescriptor> &Infos,
2968                                    SmallVectorImpl<Type*> &ArgTys) {
2969   using namespace Intrinsic;
2970
2971   // If we ran out of descriptors, there are too many arguments.
2972   if (Infos.empty()) return true;
2973   IITDescriptor D = Infos.front();
2974   Infos = Infos.slice(1);
2975
2976   switch (D.Kind) {
2977   case IITDescriptor::Void: return !Ty->isVoidTy();
2978   case IITDescriptor::VarArg: return true;
2979   case IITDescriptor::MMX:  return !Ty->isX86_MMXTy();
2980   case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2981   case IITDescriptor::Half: return !Ty->isHalfTy();
2982   case IITDescriptor::Float: return !Ty->isFloatTy();
2983   case IITDescriptor::Double: return !Ty->isDoubleTy();
2984   case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2985   case IITDescriptor::Vector: {
2986     VectorType *VT = dyn_cast<VectorType>(Ty);
2987     return !VT || VT->getNumElements() != D.Vector_Width ||
2988            VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2989   }
2990   case IITDescriptor::Pointer: {
2991     PointerType *PT = dyn_cast<PointerType>(Ty);
2992     return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2993            VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2994   }
2995
2996   case IITDescriptor::Struct: {
2997     StructType *ST = dyn_cast<StructType>(Ty);
2998     if (!ST || ST->getNumElements() != D.Struct_NumElements)
2999       return true;
3000
3001     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3002       if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3003         return true;
3004     return false;
3005   }
3006
3007   case IITDescriptor::Argument:
3008     // Two cases here - If this is the second occurrence of an argument, verify
3009     // that the later instance matches the previous instance.
3010     if (D.getArgumentNumber() < ArgTys.size())
3011       return Ty != ArgTys[D.getArgumentNumber()];
3012
3013     // Otherwise, if this is the first instance of an argument, record it and
3014     // verify the "Any" kind.
3015     assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3016     ArgTys.push_back(Ty);
3017
3018     switch (D.getArgumentKind()) {
3019     case IITDescriptor::AK_Any:        return false; // Success
3020     case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3021     case IITDescriptor::AK_AnyFloat:   return !Ty->isFPOrFPVectorTy();
3022     case IITDescriptor::AK_AnyVector:  return !isa<VectorType>(Ty);
3023     case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3024     }
3025     llvm_unreachable("all argument kinds not covered");
3026
3027   case IITDescriptor::ExtendArgument: {
3028     // This may only be used when referring to a previous vector argument.
3029     if (D.getArgumentNumber() >= ArgTys.size())
3030       return true;
3031
3032     Type *NewTy = ArgTys[D.getArgumentNumber()];
3033     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3034       NewTy = VectorType::getExtendedElementVectorType(VTy);
3035     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3036       NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3037     else
3038       return true;
3039
3040     return Ty != NewTy;
3041   }
3042   case IITDescriptor::TruncArgument: {
3043     // This may only be used when referring to a previous vector argument.
3044     if (D.getArgumentNumber() >= ArgTys.size())
3045       return true;
3046
3047     Type *NewTy = ArgTys[D.getArgumentNumber()];
3048     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3049       NewTy = VectorType::getTruncatedElementVectorType(VTy);
3050     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3051       NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3052     else
3053       return true;
3054
3055     return Ty != NewTy;
3056   }
3057   case IITDescriptor::HalfVecArgument:
3058     // This may only be used when referring to a previous vector argument.
3059     return D.getArgumentNumber() >= ArgTys.size() ||
3060            !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3061            VectorType::getHalfElementsVectorType(
3062                          cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3063   case IITDescriptor::SameVecWidthArgument: {
3064     if (D.getArgumentNumber() >= ArgTys.size())
3065       return true;
3066     VectorType * ReferenceType =
3067       dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3068     VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3069     if (!ThisArgType || !ReferenceType || 
3070         (ReferenceType->getVectorNumElements() !=
3071          ThisArgType->getVectorNumElements()))
3072       return true;
3073     return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3074                                Infos, ArgTys);
3075   }
3076   case IITDescriptor::PtrToArgument: {
3077     if (D.getArgumentNumber() >= ArgTys.size())
3078       return true;
3079     Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3080     PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3081     return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3082   }
3083   case IITDescriptor::VecOfPtrsToElt: {
3084     if (D.getArgumentNumber() >= ArgTys.size())
3085       return true;
3086     VectorType * ReferenceType =
3087       dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3088     VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3089     if (!ThisArgVecTy || !ReferenceType || 
3090         (ReferenceType->getVectorNumElements() !=
3091          ThisArgVecTy->getVectorNumElements()))
3092       return true;
3093     PointerType *ThisArgEltTy =
3094       dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3095     if (!ThisArgEltTy)
3096       return true;
3097     return ThisArgEltTy->getElementType() !=
3098            ReferenceType->getVectorElementType();
3099   }
3100   }
3101   llvm_unreachable("unhandled");
3102 }
3103
3104 /// \brief Verify if the intrinsic has variable arguments.
3105 /// This method is intended to be called after all the fixed arguments have been
3106 /// verified first.
3107 ///
3108 /// This method returns true on error and does not print an error message.
3109 bool
3110 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3111                                   ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3112   using namespace Intrinsic;
3113
3114   // If there are no descriptors left, then it can't be a vararg.
3115   if (Infos.empty())
3116     return isVarArg;
3117
3118   // There should be only one descriptor remaining at this point.
3119   if (Infos.size() != 1)
3120     return true;
3121
3122   // Check and verify the descriptor.
3123   IITDescriptor D = Infos.front();
3124   Infos = Infos.slice(1);
3125   if (D.Kind == IITDescriptor::VarArg)
3126     return !isVarArg;
3127
3128   return true;
3129 }
3130
3131 /// Allow intrinsics to be verified in different ways.
3132 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3133   Function *IF = CS.getCalledFunction();
3134   Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3135          IF);
3136
3137   // Verify that the intrinsic prototype lines up with what the .td files
3138   // describe.
3139   FunctionType *IFTy = IF->getFunctionType();
3140   bool IsVarArg = IFTy->isVarArg();
3141
3142   SmallVector<Intrinsic::IITDescriptor, 8> Table;
3143   getIntrinsicInfoTableEntries(ID, Table);
3144   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3145
3146   SmallVector<Type *, 4> ArgTys;
3147   Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3148          "Intrinsic has incorrect return type!", IF);
3149   for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3150     Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3151            "Intrinsic has incorrect argument type!", IF);
3152
3153   // Verify if the intrinsic call matches the vararg property.
3154   if (IsVarArg)
3155     Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3156            "Intrinsic was not defined with variable arguments!", IF);
3157   else
3158     Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3159            "Callsite was not defined with variable arguments!", IF);
3160
3161   // All descriptors should be absorbed by now.
3162   Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3163
3164   // Now that we have the intrinsic ID and the actual argument types (and we
3165   // know they are legal for the intrinsic!) get the intrinsic name through the
3166   // usual means.  This allows us to verify the mangling of argument types into
3167   // the name.
3168   const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3169   Assert(ExpectedName == IF->getName(),
3170          "Intrinsic name not mangled correctly for type arguments! "
3171          "Should be: " +
3172              ExpectedName,
3173          IF);
3174
3175   // If the intrinsic takes MDNode arguments, verify that they are either global
3176   // or are local to *this* function.
3177   for (Value *V : CS.args()) 
3178     if (auto *MD = dyn_cast<MetadataAsValue>(V))
3179       visitMetadataAsValue(*MD, CS.getCaller());
3180
3181   switch (ID) {
3182   default:
3183     break;
3184   case Intrinsic::ctlz:  // llvm.ctlz
3185   case Intrinsic::cttz:  // llvm.cttz
3186     Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3187            "is_zero_undef argument of bit counting intrinsics must be a "
3188            "constant int",
3189            CS);
3190     break;
3191   case Intrinsic::dbg_declare: // llvm.dbg.declare
3192     Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3193            "invalid llvm.dbg.declare intrinsic call 1", CS);
3194     visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3195     break;
3196   case Intrinsic::dbg_value: // llvm.dbg.value
3197     visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3198     break;
3199   case Intrinsic::memcpy:
3200   case Intrinsic::memmove:
3201   case Intrinsic::memset: {
3202     ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3203     Assert(AlignCI,
3204            "alignment argument of memory intrinsics must be a constant int",
3205            CS);
3206     const APInt &AlignVal = AlignCI->getValue();
3207     Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3208            "alignment argument of memory intrinsics must be a power of 2", CS);
3209     Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3210            "isvolatile argument of memory intrinsics must be a constant int",
3211            CS);
3212     break;
3213   }
3214   case Intrinsic::gcroot:
3215   case Intrinsic::gcwrite:
3216   case Intrinsic::gcread:
3217     if (ID == Intrinsic::gcroot) {
3218       AllocaInst *AI =
3219         dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3220       Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3221       Assert(isa<Constant>(CS.getArgOperand(1)),
3222              "llvm.gcroot parameter #2 must be a constant.", CS);
3223       if (!AI->getAllocatedType()->isPointerTy()) {
3224         Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3225                "llvm.gcroot parameter #1 must either be a pointer alloca, "
3226                "or argument #2 must be a non-null constant.",
3227                CS);
3228       }
3229     }
3230
3231     Assert(CS.getParent()->getParent()->hasGC(),
3232            "Enclosing function does not use GC.", CS);
3233     break;
3234   case Intrinsic::init_trampoline:
3235     Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3236            "llvm.init_trampoline parameter #2 must resolve to a function.",
3237            CS);
3238     break;
3239   case Intrinsic::prefetch:
3240     Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3241                isa<ConstantInt>(CS.getArgOperand(2)) &&
3242                cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3243                cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3244            "invalid arguments to llvm.prefetch", CS);
3245     break;
3246   case Intrinsic::stackprotector:
3247     Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3248            "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3249     break;
3250   case Intrinsic::lifetime_start:
3251   case Intrinsic::lifetime_end:
3252   case Intrinsic::invariant_start:
3253     Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3254            "size argument of memory use markers must be a constant integer",
3255            CS);
3256     break;
3257   case Intrinsic::invariant_end:
3258     Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3259            "llvm.invariant.end parameter #2 must be a constant integer", CS);
3260     break;
3261
3262   case Intrinsic::localescape: {
3263     BasicBlock *BB = CS.getParent();
3264     Assert(BB == &BB->getParent()->front(),
3265            "llvm.localescape used outside of entry block", CS);
3266     Assert(!SawFrameEscape,
3267            "multiple calls to llvm.localescape in one function", CS);
3268     for (Value *Arg : CS.args()) {
3269       if (isa<ConstantPointerNull>(Arg))
3270         continue; // Null values are allowed as placeholders.
3271       auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3272       Assert(AI && AI->isStaticAlloca(),
3273              "llvm.localescape only accepts static allocas", CS);
3274     }
3275     FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3276     SawFrameEscape = true;
3277     break;
3278   }
3279   case Intrinsic::localrecover: {
3280     Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3281     Function *Fn = dyn_cast<Function>(FnArg);
3282     Assert(Fn && !Fn->isDeclaration(),
3283            "llvm.localrecover first "
3284            "argument must be function defined in this module",
3285            CS);
3286     auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3287     Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3288            CS);
3289     auto &Entry = FrameEscapeInfo[Fn];
3290     Entry.second = unsigned(
3291         std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3292     break;
3293   }
3294
3295   case Intrinsic::experimental_gc_statepoint:
3296     Assert(!CS.isInlineAsm(),
3297            "gc.statepoint support for inline assembly unimplemented", CS);
3298     Assert(CS.getParent()->getParent()->hasGC(),
3299            "Enclosing function does not use GC.", CS);
3300
3301     VerifyStatepoint(CS);
3302     break;
3303   case Intrinsic::experimental_gc_result_int:
3304   case Intrinsic::experimental_gc_result_float:
3305   case Intrinsic::experimental_gc_result_ptr:
3306   case Intrinsic::experimental_gc_result: {
3307     Assert(CS.getParent()->getParent()->hasGC(),
3308            "Enclosing function does not use GC.", CS);
3309     // Are we tied to a statepoint properly?
3310     CallSite StatepointCS(CS.getArgOperand(0));
3311     const Function *StatepointFn =
3312       StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3313     Assert(StatepointFn && StatepointFn->isDeclaration() &&
3314                StatepointFn->getIntrinsicID() ==
3315                    Intrinsic::experimental_gc_statepoint,
3316            "gc.result operand #1 must be from a statepoint", CS,
3317            CS.getArgOperand(0));
3318
3319     // Assert that result type matches wrapped callee.
3320     const Value *Target = StatepointCS.getArgument(2);
3321     const PointerType *PT = cast<PointerType>(Target->getType());
3322     const FunctionType *TargetFuncType =
3323       cast<FunctionType>(PT->getElementType());
3324     Assert(CS.getType() == TargetFuncType->getReturnType(),
3325            "gc.result result type does not match wrapped callee", CS);
3326     break;
3327   }
3328   case Intrinsic::experimental_gc_relocate: {
3329     Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3330
3331     // Check that this relocate is correctly tied to the statepoint
3332
3333     // This is case for relocate on the unwinding path of an invoke statepoint
3334     if (ExtractValueInst *ExtractValue =
3335           dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3336       Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3337              "gc relocate on unwind path incorrectly linked to the statepoint",
3338              CS);
3339
3340       const BasicBlock *InvokeBB =
3341         ExtractValue->getParent()->getUniquePredecessor();
3342
3343       // Landingpad relocates should have only one predecessor with invoke
3344       // statepoint terminator
3345       Assert(InvokeBB, "safepoints should have unique landingpads",
3346              ExtractValue->getParent());
3347       Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3348              InvokeBB);
3349       Assert(isStatepoint(InvokeBB->getTerminator()),
3350              "gc relocate should be linked to a statepoint", InvokeBB);
3351     }
3352     else {
3353       // In all other cases relocate should be tied to the statepoint directly.
3354       // This covers relocates on a normal return path of invoke statepoint and
3355       // relocates of a call statepoint
3356       auto Token = CS.getArgOperand(0);
3357       Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3358              "gc relocate is incorrectly tied to the statepoint", CS, Token);
3359     }
3360
3361     // Verify rest of the relocate arguments
3362
3363     GCRelocateOperands Ops(CS);
3364     ImmutableCallSite StatepointCS(Ops.getStatepoint());
3365
3366     // Both the base and derived must be piped through the safepoint
3367     Value* Base = CS.getArgOperand(1);
3368     Assert(isa<ConstantInt>(Base),
3369            "gc.relocate operand #2 must be integer offset", CS);
3370
3371     Value* Derived = CS.getArgOperand(2);
3372     Assert(isa<ConstantInt>(Derived),
3373            "gc.relocate operand #3 must be integer offset", CS);
3374
3375     const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3376     const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3377     // Check the bounds
3378     Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3379            "gc.relocate: statepoint base index out of bounds", CS);
3380     Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3381            "gc.relocate: statepoint derived index out of bounds", CS);
3382
3383     // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3384     // section of the statepoint's argument
3385     Assert(StatepointCS.arg_size() > 0,
3386            "gc.statepoint: insufficient arguments");
3387     Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3388            "gc.statement: number of call arguments must be constant integer");
3389     const unsigned NumCallArgs =
3390         cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3391     Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3392            "gc.statepoint: mismatch in number of call arguments");
3393     Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3394            "gc.statepoint: number of transition arguments must be "
3395            "a constant integer");
3396     const int NumTransitionArgs =
3397         cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3398             ->getZExtValue();
3399     const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3400     Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3401            "gc.statepoint: number of deoptimization arguments must be "
3402            "a constant integer");
3403     const int NumDeoptArgs =
3404       cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3405     const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3406     const int GCParamArgsEnd = StatepointCS.arg_size();
3407     Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3408            "gc.relocate: statepoint base index doesn't fall within the "
3409            "'gc parameters' section of the statepoint call",
3410            CS);
3411     Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3412            "gc.relocate: statepoint derived index doesn't fall within the "
3413            "'gc parameters' section of the statepoint call",
3414            CS);
3415
3416     // Relocated value must be a pointer type, but gc_relocate does not need to return the
3417     // same pointer type as the relocated pointer. It can be casted to the correct type later
3418     // if it's desired. However, they must have the same address space.
3419     GCRelocateOperands Operands(CS);
3420     Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3421            "gc.relocate: relocated value must be a gc pointer", CS);
3422
3423     // gc_relocate return type must be a pointer type, and is verified earlier in
3424     // VerifyIntrinsicType().
3425     Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3426            cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3427            "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3428     break;
3429   }
3430   };
3431 }
3432
3433 /// \brief Carefully grab the subprogram from a local scope.
3434 ///
3435 /// This carefully grabs the subprogram from a local scope, avoiding the
3436 /// built-in assertions that would typically fire.
3437 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3438   if (!LocalScope)
3439     return nullptr;
3440
3441   if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3442     return SP;
3443
3444   if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3445     return getSubprogram(LB->getRawScope());
3446
3447   // Just return null; broken scope chains are checked elsewhere.
3448   assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3449   return nullptr;
3450 }
3451
3452 template <class DbgIntrinsicTy>
3453 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3454   auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3455   Assert(isa<ValueAsMetadata>(MD) ||
3456              (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3457          "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3458   Assert(isa<DILocalVariable>(DII.getRawVariable()),
3459          "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3460          DII.getRawVariable());
3461   Assert(isa<DIExpression>(DII.getRawExpression()),
3462          "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3463          DII.getRawExpression());
3464
3465   // Ignore broken !dbg attachments; they're checked elsewhere.
3466   if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3467     if (!isa<DILocation>(N))
3468       return;
3469
3470   BasicBlock *BB = DII.getParent();
3471   Function *F = BB ? BB->getParent() : nullptr;
3472
3473   // The scopes for variables and !dbg attachments must agree.
3474   DILocalVariable *Var = DII.getVariable();
3475   DILocation *Loc = DII.getDebugLoc();
3476   Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3477          &DII, BB, F);
3478
3479   DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3480   DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3481   if (!VarSP || !LocSP)
3482     return; // Broken scope chains are checked elsewhere.
3483
3484   Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3485                              " variable and !dbg attachment",
3486          &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3487          Loc->getScope()->getSubprogram());
3488 }
3489
3490 template <class MapTy>
3491 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3492   // Be careful of broken types (checked elsewhere).
3493   const Metadata *RawType = V.getRawType();
3494   while (RawType) {
3495     // Try to get the size directly.
3496     if (auto *T = dyn_cast<DIType>(RawType))
3497       if (uint64_t Size = T->getSizeInBits())
3498         return Size;
3499
3500     if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3501       // Look at the base type.
3502       RawType = DT->getRawBaseType();
3503       continue;
3504     }
3505
3506     if (auto *S = dyn_cast<MDString>(RawType)) {
3507       // Don't error on missing types (checked elsewhere).
3508       RawType = Map.lookup(S);
3509       continue;
3510     }
3511
3512     // Missing type or size.
3513     break;
3514   }
3515
3516   // Fail gracefully.
3517   return 0;
3518 }
3519
3520 template <class MapTy>
3521 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3522                                         const MapTy &TypeRefs) {
3523   DILocalVariable *V;
3524   DIExpression *E;
3525   if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3526     V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3527     E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3528   } else {
3529     auto *DDI = cast<DbgDeclareInst>(&I);
3530     V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3531     E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3532   }
3533
3534   // We don't know whether this intrinsic verified correctly.
3535   if (!V || !E || !E->isValid())
3536     return;
3537
3538   // Nothing to do if this isn't a bit piece expression.
3539   if (!E->isBitPiece())
3540     return;
3541
3542   // The frontend helps out GDB by emitting the members of local anonymous
3543   // unions as artificial local variables with shared storage. When SROA splits
3544   // the storage for artificial local variables that are smaller than the entire
3545   // union, the overhang piece will be outside of the allotted space for the
3546   // variable and this check fails.
3547   // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3548   if (V->isArtificial())
3549     return;
3550
3551   // If there's no size, the type is broken, but that should be checked
3552   // elsewhere.
3553   uint64_t VarSize = getVariableSize(*V, TypeRefs);
3554   if (!VarSize)
3555     return;
3556
3557   unsigned PieceSize = E->getBitPieceSize();
3558   unsigned PieceOffset = E->getBitPieceOffset();
3559   Assert(PieceSize + PieceOffset <= VarSize,
3560          "piece is larger than or outside of variable", &I, V, E);
3561   Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3562 }
3563
3564 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3565   // This is in its own function so we get an error for each bad type ref (not
3566   // just the first).
3567   Assert(false, "unresolved type ref", S, N);
3568 }
3569
3570 void Verifier::verifyTypeRefs() {
3571   auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3572   if (!CUs)
3573     return;
3574
3575   // Visit all the compile units again to map the type references.
3576   SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3577   for (auto *CU : CUs->operands())
3578     if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3579       for (DIType *Op : Ts)
3580         if (auto *T = dyn_cast<DICompositeType>(Op))
3581           if (auto *S = T->getRawIdentifier()) {
3582             UnresolvedTypeRefs.erase(S);
3583             TypeRefs.insert(std::make_pair(S, T));
3584           }
3585
3586   // Verify debug info intrinsic bit piece expressions.  This needs a second
3587   // pass through the intructions, since we haven't built TypeRefs yet when
3588   // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3589   // later/now would queue up some that could be later deleted.
3590   for (const Function &F : *M)
3591     for (const BasicBlock &BB : F)
3592       for (const Instruction &I : BB)
3593         if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3594           verifyBitPieceExpression(*DII, TypeRefs);
3595
3596   // Return early if all typerefs were resolved.
3597   if (UnresolvedTypeRefs.empty())
3598     return;
3599
3600   // Sort the unresolved references by name so the output is deterministic.
3601   typedef std::pair<const MDString *, const MDNode *> TypeRef;
3602   SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3603                                       UnresolvedTypeRefs.end());
3604   std::sort(Unresolved.begin(), Unresolved.end(),
3605             [](const TypeRef &LHS, const TypeRef &RHS) {
3606     return LHS.first->getString() < RHS.first->getString();
3607   });
3608
3609   // Visit the unresolved refs (printing out the errors).
3610   for (const TypeRef &TR : Unresolved)
3611     visitUnresolvedTypeRef(TR.first, TR.second);
3612 }
3613
3614 //===----------------------------------------------------------------------===//
3615 //  Implement the public interfaces to this file...
3616 //===----------------------------------------------------------------------===//
3617
3618 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3619   Function &F = const_cast<Function &>(f);
3620   assert(!F.isDeclaration() && "Cannot verify external functions");
3621
3622   raw_null_ostream NullStr;
3623   Verifier V(OS ? *OS : NullStr);
3624
3625   // Note that this function's return value is inverted from what you would
3626   // expect of a function called "verify".
3627   return !V.verify(F);
3628 }
3629
3630 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3631   raw_null_ostream NullStr;
3632   Verifier V(OS ? *OS : NullStr);
3633
3634   bool Broken = false;
3635   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3636     if (!I->isDeclaration() && !I->isMaterializable())
3637       Broken |= !V.verify(*I);
3638
3639   // Note that this function's return value is inverted from what you would
3640   // expect of a function called "verify".
3641   return !V.verify(M) || Broken;
3642 }
3643
3644 namespace {
3645 struct VerifierLegacyPass : public FunctionPass {
3646   static char ID;
3647
3648   Verifier V;
3649   bool FatalErrors;
3650
3651   VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3652     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3653   }
3654   explicit VerifierLegacyPass(bool FatalErrors)
3655       : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3656     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3657   }
3658
3659   bool runOnFunction(Function &F) override {
3660     if (!V.verify(F) && FatalErrors)
3661       report_fatal_error("Broken function found, compilation aborted!");
3662
3663     return false;
3664   }
3665
3666   bool doFinalization(Module &M) override {
3667     if (!V.verify(M) && FatalErrors)
3668       report_fatal_error("Broken module found, compilation aborted!");
3669
3670     return false;
3671   }
3672
3673   void getAnalysisUsage(AnalysisUsage &AU) const override {
3674     AU.setPreservesAll();
3675   }
3676 };
3677 }
3678
3679 char VerifierLegacyPass::ID = 0;
3680 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3681
3682 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3683   return new VerifierLegacyPass(FatalErrors);
3684 }
3685
3686 PreservedAnalyses VerifierPass::run(Module &M) {
3687   if (verifyModule(M, &dbgs()) && FatalErrors)
3688     report_fatal_error("Broken module found, compilation aborted!");
3689
3690   return PreservedAnalyses::all();
3691 }
3692
3693 PreservedAnalyses VerifierPass::run(Function &F) {
3694   if (verifyFunction(F, &dbgs()) && FatalErrors)
3695     report_fatal_error("Broken function found, compilation aborted!");
3696
3697   return PreservedAnalyses::all();
3698 }