lib/IR/Verifier.cpp

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