lib/IR/Verifier.cpp

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