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