lib/IR/Verifier.cpp

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