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