lib/IR/Verifier.cpp

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