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