lib/IR/Verifier.cpp

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