lib/IR/Verifier.cpp

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