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