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