lib/IR/Verifier.cpp

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