lib/IR/Verifier.cpp

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