lib/IR/Verifier.cpp

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