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/Pass.h"
  72 #include "llvm/Support/CommandLine.h"
  73 #include "llvm/Support/Debug.h"
  74 #include "llvm/Support/ErrorHandling.h"
  75 #include "llvm/Support/raw_ostream.h"
  76 #include <algorithm>
  77 #include <cstdarg>
  78 using namespace llvm;
  79
  80 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(false));
  81
  82 namespace {
  83 struct VerifierSupport {
  84   raw_ostream &OS;
  85   const Module *M;
  86
  87   /// \brief Track the brokenness of the module while recursively visiting.
  88   bool Broken;
  89
  90   explicit VerifierSupport(raw_ostream &OS)
  91       : OS(OS), M(nullptr), Broken(false) {}
  92
  93   void WriteValue(const Value *V) {
  94     if (!V)
  95       return;
  96     if (isa<Instruction>(V)) {
  97       OS << *V << '\n';
  98     } else {
  99       V->printAsOperand(OS, true, M);
 100       OS << '\n';
 101     }
 102   }
 103
 104   void WriteType(Type *T) {
 105     if (!T)
 106       return;
 107     OS << ' ' << *T;
 108   }
 109
 110   // CheckFailed - A check failed, so print out the condition and the message
 111   // that failed.  This provides a nice place to put a breakpoint if you want
 112   // to see why something is not correct.
 113   void CheckFailed(const Twine &Message, const Value *V1 = nullptr,
 114                    const Value *V2 = nullptr, const Value *V3 = nullptr,
 115                    const Value *V4 = nullptr) {
 116     OS << Message.str() << "\n";
 117     WriteValue(V1);
 118     WriteValue(V2);
 119     WriteValue(V3);
 120     WriteValue(V4);
 121     Broken = true;
 122   }
 123
 124   void CheckFailed(const Twine &Message, const Value *V1, Type *T2,
 125                    const Value *V3 = nullptr) {
 126     OS << Message.str() << "\n";
 127     WriteValue(V1);
 128     WriteType(T2);
 129     WriteValue(V3);
 130     Broken = true;
 131   }
 132
 133   void CheckFailed(const Twine &Message, Type *T1, Type *T2 = nullptr,
 134                    Type *T3 = nullptr) {
 135     OS << Message.str() << "\n";
 136     WriteType(T1);
 137     WriteType(T2);
 138     WriteType(T3);
 139     Broken = true;
 140   }
 141 };
 142 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
 143   friend class InstVisitor<Verifier>;
 144
 145   LLVMContext *Context;
 146   const DataLayout *DL;
 147   DominatorTree DT;
 148
 149   /// \brief When verifying a basic block, keep track of all of the
 150   /// instructions we have seen so far.
 151   ///
 152   /// This allows us to do efficient dominance checks for the case when an
 153   /// instruction has an operand that is an instruction in the same block.
 154   SmallPtrSet<Instruction *, 16> InstsInThisBlock;
 155
 156   /// \brief Keep track of the metadata nodes that have been checked already.
 157   SmallPtrSet<MDNode *, 32> MDNodes;
 158
 159   /// \brief The personality function referenced by the LandingPadInsts.
 160   /// All LandingPadInsts within the same function must use the same
 161   /// personality function.
 162   const Value *PersonalityFn;
 163
 164 public:
 165   explicit Verifier(raw_ostream &OS = dbgs())
 166       : VerifierSupport(OS), Context(nullptr), DL(nullptr),
 167         PersonalityFn(nullptr) {}
 168
 169   bool verify(const Function &F) {
 170     M = F.getParent();
 171     Context = &M->getContext();
 172
 173     // First ensure the function is well-enough formed to compute dominance
 174     // information.
 175     if (F.empty()) {
 176       OS << "Function '" << F.getName()
 177          << "' does not contain an entry block!\n";
 178       return false;
 179     }
 180     for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
 181       if (I->empty() || !I->back().isTerminator()) {
 182         OS << "Basic Block in function '" << F.getName()
 183            << "' does not have terminator!\n";
 184         I->printAsOperand(OS, true);
 185         OS << "\n";
 186         return false;
 187       }
 188     }
 189
 190     // Now directly compute a dominance tree. We don't rely on the pass
 191     // manager to provide this as it isolates us from a potentially
 192     // out-of-date dominator tree and makes it significantly more complex to
 193     // run this code outside of a pass manager.
 194     // FIXME: It's really gross that we have to cast away constness here.
 195     DT.recalculate(const_cast<Function &>(F));
 196
 197     Broken = false;
 198     // FIXME: We strip const here because the inst visitor strips const.
 199     visit(const_cast<Function &>(F));
 200     InstsInThisBlock.clear();
 201     PersonalityFn = nullptr;
 202
 203     return !Broken;
 204   }
 205
 206   bool verify(const Module &M) {
 207     this->M = &M;
 208     Context = &M.getContext();
 209     Broken = false;
 210
 211     // Scan through, checking all of the external function's linkage now...
 212     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
 213       visitGlobalValue(*I);
 214
 215       // Check to make sure function prototypes are okay.
 216       if (I->isDeclaration())
 217         visitFunction(*I);
 218     }
 219
 220     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 221          I != E; ++I)
 222       visitGlobalVariable(*I);
 223
 224     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
 225          I != E; ++I)
 226       visitGlobalAlias(*I);
 227
 228     for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
 229                                                E = M.named_metadata_end();
 230          I != E; ++I)
 231       visitNamedMDNode(*I);
 232
 233     visitModuleFlags(M);
 234     visitModuleIdents(M);
 235
 236     return !Broken;
 237   }
 238
 239 private:
 240   // Verification methods...
 241   void visitGlobalValue(const GlobalValue &GV);
 242   void visitGlobalVariable(const GlobalVariable &GV);
 243   void visitGlobalAlias(const GlobalAlias &GA);
 244   void visitNamedMDNode(const NamedMDNode &NMD);
 245   void visitMDNode(MDNode &MD, Function *F);
 246   void visitModuleIdents(const Module &M);
 247   void visitModuleFlags(const Module &M);
 248   void visitModuleFlag(const MDNode *Op,
 249                        DenseMap<const MDString *, const MDNode *> &SeenIDs,
 250                        SmallVectorImpl<const MDNode *> &Requirements);
 251   void visitFunction(const Function &F);
 252   void visitBasicBlock(BasicBlock &BB);
 253
 254   // InstVisitor overrides...
 255   using InstVisitor<Verifier>::visit;
 256   void visit(Instruction &I);
 257
 258   void visitTruncInst(TruncInst &I);
 259   void visitZExtInst(ZExtInst &I);
 260   void visitSExtInst(SExtInst &I);
 261   void visitFPTruncInst(FPTruncInst &I);
 262   void visitFPExtInst(FPExtInst &I);
 263   void visitFPToUIInst(FPToUIInst &I);
 264   void visitFPToSIInst(FPToSIInst &I);
 265   void visitUIToFPInst(UIToFPInst &I);
 266   void visitSIToFPInst(SIToFPInst &I);
 267   void visitIntToPtrInst(IntToPtrInst &I);
 268   void visitPtrToIntInst(PtrToIntInst &I);
 269   void visitBitCastInst(BitCastInst &I);
 270   void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
 271   void visitPHINode(PHINode &PN);
 272   void visitBinaryOperator(BinaryOperator &B);
 273   void visitICmpInst(ICmpInst &IC);
 274   void visitFCmpInst(FCmpInst &FC);
 275   void visitExtractElementInst(ExtractElementInst &EI);
 276   void visitInsertElementInst(InsertElementInst &EI);
 277   void visitShuffleVectorInst(ShuffleVectorInst &EI);
 278   void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 279   void visitCallInst(CallInst &CI);
 280   void visitInvokeInst(InvokeInst &II);
 281   void visitGetElementPtrInst(GetElementPtrInst &GEP);
 282   void visitLoadInst(LoadInst &LI);
 283   void visitStoreInst(StoreInst &SI);
 284   void verifyDominatesUse(Instruction &I, unsigned i);
 285   void visitInstruction(Instruction &I);
 286   void visitTerminatorInst(TerminatorInst &I);
 287   void visitBranchInst(BranchInst &BI);
 288   void visitReturnInst(ReturnInst &RI);
 289   void visitSwitchInst(SwitchInst &SI);
 290   void visitIndirectBrInst(IndirectBrInst &BI);
 291   void visitSelectInst(SelectInst &SI);
 292   void visitUserOp1(Instruction &I);
 293   void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 294   void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 295   void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
 296   void visitAtomicRMWInst(AtomicRMWInst &RMWI);
 297   void visitFenceInst(FenceInst &FI);
 298   void visitAllocaInst(AllocaInst &AI);
 299   void visitExtractValueInst(ExtractValueInst &EVI);
 300   void visitInsertValueInst(InsertValueInst &IVI);
 301   void visitLandingPadInst(LandingPadInst &LPI);
 302
 303   void VerifyCallSite(CallSite CS);
 304   bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
 305                         unsigned ArgNo, std::string &Suffix);
 306   bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
 307                            SmallVectorImpl<Type *> &ArgTys);
 308   bool VerifyIntrinsicIsVarArg(bool isVarArg,
 309                                ArrayRef<Intrinsic::IITDescriptor> &Infos);
 310   bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
 311   void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
 312                             const Value *V);
 313   void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
 314                             bool isReturnValue, const Value *V);
 315   void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
 316                            const Value *V);
 317
 318   void VerifyBitcastType(const Value *V, Type *DestTy, Type *SrcTy);
 319   void VerifyConstantExprBitcastType(const ConstantExpr *CE);
 320 };
 321 class DebugInfoVerifier : public VerifierSupport {
 322 public:
 323   explicit DebugInfoVerifier(raw_ostream &OS = dbgs()) : VerifierSupport(OS) {}
 324
 325   bool verify(const Module &M) {
 326     this->M = &M;
 327     verifyDebugInfo();
 328     return !Broken;
 329   }
 330
 331 private:
 332   void verifyDebugInfo();
 333   void processInstructions(DebugInfoFinder &Finder);
 334   void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
 335 };
 336 } // End anonymous namespace
 337
 338 // Assert - We know that cond should be true, if not print an error message.
 339 #define Assert(C, M) \
 340   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 341 #define Assert1(C, M, V1) \
 342   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 343 #define Assert2(C, M, V1, V2) \
 344   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 345 #define Assert3(C, M, V1, V2, V3) \
 346   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 347 #define Assert4(C, M, V1, V2, V3, V4) \
 348   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 349
 350 void Verifier::visit(Instruction &I) {
 351   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
 352     Assert1(I.getOperand(i) != nullptr, "Operand is null", &I);
 353   InstVisitor<Verifier>::visit(I);
 354 }
 355
 356
 357 void Verifier::visitGlobalValue(const GlobalValue &GV) {
 358   Assert1(!GV.isDeclaration() ||
 359           GV.isMaterializable() ||
 360           GV.hasExternalLinkage() ||
 361           GV.hasExternalWeakLinkage() ||
 362           (isa<GlobalAlias>(GV) &&
 363            (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
 364           "Global is external, but doesn't have external or weak linkage!",
 365           &GV);
 366
 367   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 368           "Only global variables can have appending linkage!", &GV);
 369
 370   if (GV.hasAppendingLinkage()) {
 371     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
 372     Assert1(GVar && GVar->getType()->getElementType()->isArrayTy(),
 373             "Only global arrays can have appending linkage!", GVar);
 374   }
 375 }
 376
 377 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
 378   if (GV.hasInitializer()) {
 379     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 380             "Global variable initializer type does not match global "
 381             "variable type!", &GV);
 382
 383     // If the global has common linkage, it must have a zero initializer and
 384     // cannot be constant.
 385     if (GV.hasCommonLinkage()) {
 386       Assert1(GV.getInitializer()->isNullValue(),
 387               "'common' global must have a zero initializer!", &GV);
 388       Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
 389               &GV);
 390     }
 391   } else {
 392     Assert1(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
 393             "invalid linkage type for global declaration", &GV);
 394   }
 395
 396   if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
 397                        GV.getName() == "llvm.global_dtors")) {
 398     Assert1(!GV.hasInitializer() || GV.hasAppendingLinkage(),
 399             "invalid linkage for intrinsic global variable", &GV);
 400     // Don't worry about emitting an error for it not being an array,
 401     // visitGlobalValue will complain on appending non-array.
 402     if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType())) {
 403       StructType *STy = dyn_cast<StructType>(ATy->getElementType());
 404       PointerType *FuncPtrTy =
 405           FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
 406       Assert1(STy && STy->getNumElements() == 2 &&
 407               STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
 408               STy->getTypeAtIndex(1) == FuncPtrTy,
 409               "wrong type for intrinsic global variable", &GV);
 410     }
 411   }
 412
 413   if (GV.hasName() && (GV.getName() == "llvm.used" ||
 414                        GV.getName() == "llvm.compiler.used")) {
 415     Assert1(!GV.hasInitializer() || GV.hasAppendingLinkage(),
 416             "invalid linkage for intrinsic global variable", &GV);
 417     Type *GVType = GV.getType()->getElementType();
 418     if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
 419       PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
 420       Assert1(PTy, "wrong type for intrinsic global variable", &GV);
 421       if (GV.hasInitializer()) {
 422         const Constant *Init = GV.getInitializer();
 423         const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
 424         Assert1(InitArray, "wrong initalizer for intrinsic global variable",
 425                 Init);
 426         for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
 427           Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
 428           Assert1(
 429               isa<GlobalVariable>(V) || isa<Function>(V) || isa<GlobalAlias>(V),
 430               "invalid llvm.used member", V);
 431           Assert1(V->hasName(), "members of llvm.used must be named", V);
 432         }
 433       }
 434     }
 435   }
 436
 437   Assert1(!GV.hasDLLImportStorageClass() ||
 438           (GV.isDeclaration() && GV.hasExternalLinkage()) ||
 439           GV.hasAvailableExternallyLinkage(),
 440           "Global is marked as dllimport, but not external", &GV);
 441
 442   if (!GV.hasInitializer()) {
 443     visitGlobalValue(GV);
 444     return;
 445   }
 446
 447   // Walk any aggregate initializers looking for bitcasts between address spaces
 448   SmallPtrSet<const Value *, 4> Visited;
 449   SmallVector<const Value *, 4> WorkStack;
 450   WorkStack.push_back(cast<Value>(GV.getInitializer()));
 451
 452   while (!WorkStack.empty()) {
 453     const Value *V = WorkStack.pop_back_val();
 454     if (!Visited.insert(V))
 455       continue;
 456
 457     if (const User *U = dyn_cast<User>(V)) {
 458       for (unsigned I = 0, N = U->getNumOperands(); I != N; ++I)
 459         WorkStack.push_back(U->getOperand(I));
 460     }
 461
 462     if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 463       VerifyConstantExprBitcastType(CE);
 464       if (Broken)
 465         return;
 466     }
 467   }
 468
 469   visitGlobalValue(GV);
 470 }
 471
 472 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
 473   Assert1(!GA.getName().empty(),
 474           "Alias name cannot be empty!", &GA);
 475   Assert1(GlobalAlias::isValidLinkage(GA.getLinkage()),
 476           "Alias should have external or external weak linkage!", &GA);
 477   Assert1(GA.getAliasee(),
 478           "Aliasee cannot be NULL!", &GA);
 479   Assert1(GA.getType() == GA.getAliasee()->getType(),
 480           "Alias and aliasee types should match!", &GA);
 481   Assert1(!GA.hasUnnamedAddr(), "Alias cannot have unnamed_addr!", &GA);
 482   Assert1(!GA.hasSection(), "Alias cannot have a section!", &GA);
 483   Assert1(!GA.getAlignment(), "Alias connot have an alignment", &GA);
 484
 485   const Constant *Aliasee = GA.getAliasee();
 486   const GlobalValue *GV = dyn_cast<GlobalValue>(Aliasee);
 487
 488   if (!GV) {
 489     const ConstantExpr *CE = dyn_cast<ConstantExpr>(Aliasee);
 490     if (CE && (CE->getOpcode() == Instruction::BitCast ||
 491                CE->getOpcode() == Instruction::AddrSpaceCast ||
 492                CE->getOpcode() == Instruction::GetElementPtr))
 493       GV = dyn_cast<GlobalValue>(CE->getOperand(0));
 494
 495     Assert1(GV, "Aliasee should be either GlobalValue, bitcast or "
 496                 "addrspacecast of GlobalValue",
 497             &GA);
 498
 499     if (CE->getOpcode() == Instruction::BitCast) {
 500       unsigned SrcAS = GV->getType()->getPointerAddressSpace();
 501       unsigned DstAS = CE->getType()->getPointerAddressSpace();
 502
 503       Assert1(SrcAS == DstAS,
 504               "Alias bitcasts cannot be between different address spaces",
 505               &GA);
 506     }
 507   }
 508   Assert1(!GV->isDeclaration(), "Alias must point to a definition", &GA);
 509   if (const GlobalAlias *GAAliasee = dyn_cast<GlobalAlias>(GV)) {
 510     Assert1(!GAAliasee->mayBeOverridden(), "Alias cannot point to a weak alias",
 511             &GA);
 512   }
 513
 514   const GlobalValue *AG = GA.getAliasedGlobal();
 515   Assert1(AG, "Aliasing chain should end with function or global variable",
 516           &GA);
 517
 518   visitGlobalValue(GA);
 519 }
 520
 521 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
 522   for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
 523     MDNode *MD = NMD.getOperand(i);
 524     if (!MD)
 525       continue;
 526
 527     Assert1(!MD->isFunctionLocal(),
 528             "Named metadata operand cannot be function local!", MD);
 529     visitMDNode(*MD, nullptr);
 530   }
 531 }
 532
 533 void Verifier::visitMDNode(MDNode &MD, Function *F) {
 534   // Only visit each node once.  Metadata can be mutually recursive, so this
 535   // avoids infinite recursion here, as well as being an optimization.
 536   if (!MDNodes.insert(&MD))
 537     return;
 538
 539   for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
 540     Value *Op = MD.getOperand(i);
 541     if (!Op)
 542       continue;
 543     if (isa<Constant>(Op) || isa<MDString>(Op))
 544       continue;
 545     if (MDNode *N = dyn_cast<MDNode>(Op)) {
 546       Assert2(MD.isFunctionLocal() || !N->isFunctionLocal(),
 547               "Global metadata operand cannot be function local!", &MD, N);
 548       visitMDNode(*N, F);
 549       continue;
 550     }
 551     Assert2(MD.isFunctionLocal(), "Invalid operand for global metadata!", &MD, Op);
 552
 553     // If this was an instruction, bb, or argument, verify that it is in the
 554     // function that we expect.
 555     Function *ActualF = nullptr;
 556     if (Instruction *I = dyn_cast<Instruction>(Op))
 557       ActualF = I->getParent()->getParent();
 558     else if (BasicBlock *BB = dyn_cast<BasicBlock>(Op))
 559       ActualF = BB->getParent();
 560     else if (Argument *A = dyn_cast<Argument>(Op))
 561       ActualF = A->getParent();
 562     assert(ActualF && "Unimplemented function local metadata case!");
 563
 564     Assert2(ActualF == F, "function-local metadata used in wrong function",
 565             &MD, Op);
 566   }
 567 }
 568
 569 void Verifier::visitModuleIdents(const Module &M) {
 570   const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
 571   if (!Idents)
 572     return;
 573
 574   // llvm.ident takes a list of metadata entry. Each entry has only one string.
 575   // Scan each llvm.ident entry and make sure that this requirement is met.
 576   for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
 577     const MDNode *N = Idents->getOperand(i);
 578     Assert1(N->getNumOperands() == 1,
 579             "incorrect number of operands in llvm.ident metadata", N);
 580     Assert1(isa<MDString>(N->getOperand(0)),
 581             ("invalid value for llvm.ident metadata entry operand"
 582              "(the operand should be a string)"),
 583             N->getOperand(0));
 584   }
 585 }
 586
 587 void Verifier::visitModuleFlags(const Module &M) {
 588   const NamedMDNode *Flags = M.getModuleFlagsMetadata();
 589   if (!Flags) return;
 590
 591   // Scan each flag, and track the flags and requirements.
 592   DenseMap<const MDString*, const MDNode*> SeenIDs;
 593   SmallVector<const MDNode*, 16> Requirements;
 594   for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
 595     visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
 596   }
 597
 598   // Validate that the requirements in the module are valid.
 599   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
 600     const MDNode *Requirement = Requirements[I];
 601     const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
 602     const Value *ReqValue = Requirement->getOperand(1);
 603
 604     const MDNode *Op = SeenIDs.lookup(Flag);
 605     if (!Op) {
 606       CheckFailed("invalid requirement on flag, flag is not present in module",
 607                   Flag);
 608       continue;
 609     }
 610
 611     if (Op->getOperand(2) != ReqValue) {
 612       CheckFailed(("invalid requirement on flag, "
 613                    "flag does not have the required value"),
 614                   Flag);
 615       continue;
 616     }
 617   }
 618 }
 619
 620 void
 621 Verifier::visitModuleFlag(const MDNode *Op,
 622                           DenseMap<const MDString *, const MDNode *> &SeenIDs,
 623                           SmallVectorImpl<const MDNode *> &Requirements) {
 624   // Each module flag should have three arguments, the merge behavior (a
 625   // constant int), the flag ID (an MDString), and the value.
 626   Assert1(Op->getNumOperands() == 3,
 627           "incorrect number of operands in module flag", Op);
 628   ConstantInt *Behavior = dyn_cast<ConstantInt>(Op->getOperand(0));
 629   MDString *ID = dyn_cast<MDString>(Op->getOperand(1));
 630   Assert1(Behavior,
 631           "invalid behavior operand in module flag (expected constant integer)",
 632           Op->getOperand(0));
 633   unsigned BehaviorValue = Behavior->getZExtValue();
 634   Assert1(ID,
 635           "invalid ID operand in module flag (expected metadata string)",
 636           Op->getOperand(1));
 637
 638   // Sanity check the values for behaviors with additional requirements.
 639   switch (BehaviorValue) {
 640   default:
 641     Assert1(false,
 642             "invalid behavior operand in module flag (unexpected constant)",
 643             Op->getOperand(0));
 644     break;
 645
 646   case Module::Error:
 647   case Module::Warning:
 648   case Module::Override:
 649     // These behavior types accept any value.
 650     break;
 651
 652   case Module::Require: {
 653     // The value should itself be an MDNode with two operands, a flag ID (an
 654     // MDString), and a value.
 655     MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
 656     Assert1(Value && Value->getNumOperands() == 2,
 657             "invalid value for 'require' module flag (expected metadata pair)",
 658             Op->getOperand(2));
 659     Assert1(isa<MDString>(Value->getOperand(0)),
 660             ("invalid value for 'require' module flag "
 661              "(first value operand should be a string)"),
 662             Value->getOperand(0));
 663
 664     // Append it to the list of requirements, to check once all module flags are
 665     // scanned.
 666     Requirements.push_back(Value);
 667     break;
 668   }
 669
 670   case Module::Append:
 671   case Module::AppendUnique: {
 672     // These behavior types require the operand be an MDNode.
 673     Assert1(isa<MDNode>(Op->getOperand(2)),
 674             "invalid value for 'append'-type module flag "
 675             "(expected a metadata node)", Op->getOperand(2));
 676     break;
 677   }
 678   }
 679
 680   // Unless this is a "requires" flag, check the ID is unique.
 681   if (BehaviorValue != Module::Require) {
 682     bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
 683     Assert1(Inserted,
 684             "module flag identifiers must be unique (or of 'require' type)",
 685             ID);
 686   }
 687 }
 688
 689 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
 690                                     bool isFunction, const Value *V) {
 691   unsigned Slot = ~0U;
 692   for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
 693     if (Attrs.getSlotIndex(I) == Idx) {
 694       Slot = I;
 695       break;
 696     }
 697
 698   assert(Slot != ~0U && "Attribute set inconsistency!");
 699
 700   for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
 701          I != E; ++I) {
 702     if (I->isStringAttribute())
 703       continue;
 704
 705     if (I->getKindAsEnum() == Attribute::NoReturn ||
 706         I->getKindAsEnum() == Attribute::NoUnwind ||
 707         I->getKindAsEnum() == Attribute::NoInline ||
 708         I->getKindAsEnum() == Attribute::AlwaysInline ||
 709         I->getKindAsEnum() == Attribute::OptimizeForSize ||
 710         I->getKindAsEnum() == Attribute::StackProtect ||
 711         I->getKindAsEnum() == Attribute::StackProtectReq ||
 712         I->getKindAsEnum() == Attribute::StackProtectStrong ||
 713         I->getKindAsEnum() == Attribute::NoRedZone ||
 714         I->getKindAsEnum() == Attribute::NoImplicitFloat ||
 715         I->getKindAsEnum() == Attribute::Naked ||
 716         I->getKindAsEnum() == Attribute::InlineHint ||
 717         I->getKindAsEnum() == Attribute::StackAlignment ||
 718         I->getKindAsEnum() == Attribute::UWTable ||
 719         I->getKindAsEnum() == Attribute::NonLazyBind ||
 720         I->getKindAsEnum() == Attribute::ReturnsTwice ||
 721         I->getKindAsEnum() == Attribute::SanitizeAddress ||
 722         I->getKindAsEnum() == Attribute::SanitizeThread ||
 723         I->getKindAsEnum() == Attribute::SanitizeMemory ||
 724         I->getKindAsEnum() == Attribute::MinSize ||
 725         I->getKindAsEnum() == Attribute::NoDuplicate ||
 726         I->getKindAsEnum() == Attribute::Builtin ||
 727         I->getKindAsEnum() == Attribute::NoBuiltin ||
 728         I->getKindAsEnum() == Attribute::Cold ||
 729         I->getKindAsEnum() == Attribute::OptimizeNone) {
 730       if (!isFunction) {
 731         CheckFailed("Attribute '" + I->getAsString() +
 732                     "' only applies to functions!", V);
 733         return;
 734       }
 735     } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
 736                I->getKindAsEnum() == Attribute::ReadNone) {
 737       if (Idx == 0) {
 738         CheckFailed("Attribute '" + I->getAsString() +
 739                     "' does not apply to function returns");
 740         return;
 741       }
 742     } else if (isFunction) {
 743       CheckFailed("Attribute '" + I->getAsString() +
 744                   "' does not apply to functions!", V);
 745       return;
 746     }
 747   }
 748 }
 749
 750 // VerifyParameterAttrs - Check the given attributes for an argument or return
 751 // value of the specified type.  The value V is printed in error messages.
 752 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
 753                                     bool isReturnValue, const Value *V) {
 754   if (!Attrs.hasAttributes(Idx))
 755     return;
 756
 757   VerifyAttributeTypes(Attrs, Idx, false, V);
 758
 759   if (isReturnValue)
 760     Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
 761             !Attrs.hasAttribute(Idx, Attribute::Nest) &&
 762             !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
 763             !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
 764             !Attrs.hasAttribute(Idx, Attribute::Returned) &&
 765             !Attrs.hasAttribute(Idx, Attribute::InAlloca),
 766             "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
 767             "'returned' do not apply to return values!", V);
 768
 769   // Check for mutually incompatible attributes.  Only inreg is compatible with
 770   // sret.
 771   unsigned AttrCount = 0;
 772   AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
 773   AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
 774   AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
 775                Attrs.hasAttribute(Idx, Attribute::InReg);
 776   AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
 777   Assert1(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
 778                           "and 'sret' are incompatible!", V);
 779
 780   Assert1(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
 781             Attrs.hasAttribute(Idx, Attribute::ReadOnly)), "Attributes "
 782           "'inalloca and readonly' are incompatible!", V);
 783
 784   Assert1(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
 785             Attrs.hasAttribute(Idx, Attribute::Returned)), "Attributes "
 786           "'sret and returned' are incompatible!", V);
 787
 788   Assert1(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
 789             Attrs.hasAttribute(Idx, Attribute::SExt)), "Attributes "
 790           "'zeroext and signext' are incompatible!", V);
 791
 792   Assert1(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
 793             Attrs.hasAttribute(Idx, Attribute::ReadOnly)), "Attributes "
 794           "'readnone and readonly' are incompatible!", V);
 795
 796   Assert1(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
 797             Attrs.hasAttribute(Idx, Attribute::AlwaysInline)), "Attributes "
 798           "'noinline and alwaysinline' are incompatible!", V);
 799
 800   Assert1(!AttrBuilder(Attrs, Idx).
 801             hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
 802           "Wrong types for attribute: " +
 803           AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx), V);
 804
 805   if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 806     if (!PTy->getElementType()->isSized()) {
 807       Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
 808               !Attrs.hasAttribute(Idx, Attribute::InAlloca),
 809               "Attributes 'byval' and 'inalloca' do not support unsized types!",
 810               V);
 811     }
 812   } else {
 813     Assert1(!Attrs.hasAttribute(Idx, Attribute::ByVal),
 814             "Attribute 'byval' only applies to parameters with pointer type!",
 815             V);
 816   }
 817 }
 818
 819 // VerifyFunctionAttrs - Check parameter attributes against a function type.
 820 // The value V is printed in error messages.
 821 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
 822                                    const Value *V) {
 823   if (Attrs.isEmpty())
 824     return;
 825
 826   bool SawNest = false;
 827   bool SawReturned = false;
 828
 829   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
 830     unsigned Idx = Attrs.getSlotIndex(i);
 831
 832     Type *Ty;
 833     if (Idx == 0)
 834       Ty = FT->getReturnType();
 835     else if (Idx-1 < FT->getNumParams())
 836       Ty = FT->getParamType(Idx-1);
 837     else
 838       break;  // VarArgs attributes, verified elsewhere.
 839
 840     VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
 841
 842     if (Idx == 0)
 843       continue;
 844
 845     if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
 846       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
 847       SawNest = true;
 848     }
 849
 850     if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
 851       Assert1(!SawReturned, "More than one parameter has attribute returned!",
 852               V);
 853       Assert1(Ty->canLosslesslyBitCastTo(FT->getReturnType()), "Incompatible "
 854               "argument and return types for 'returned' attribute", V);
 855       SawReturned = true;
 856     }
 857
 858     if (Attrs.hasAttribute(Idx, Attribute::StructRet))
 859       Assert1(Idx == 1, "Attribute sret is not on first parameter!", V);
 860
 861     if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
 862       Assert1(Idx == FT->getNumParams(),
 863               "inalloca isn't on the last parameter!", V);
 864     }
 865   }
 866
 867   if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
 868     return;
 869
 870   VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
 871
 872   Assert1(!(Attrs.hasAttribute(AttributeSet::FunctionIndex,
 873                                Attribute::ReadNone) &&
 874             Attrs.hasAttribute(AttributeSet::FunctionIndex,
 875                                Attribute::ReadOnly)),
 876           "Attributes 'readnone and readonly' are incompatible!", V);
 877
 878   Assert1(!(Attrs.hasAttribute(AttributeSet::FunctionIndex,
 879                                Attribute::NoInline) &&
 880             Attrs.hasAttribute(AttributeSet::FunctionIndex,
 881                                Attribute::AlwaysInline)),
 882           "Attributes 'noinline and alwaysinline' are incompatible!", V);
 883
 884   if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
 885                          Attribute::OptimizeNone)) {
 886     Assert1(Attrs.hasAttribute(AttributeSet::FunctionIndex,
 887                                Attribute::NoInline),
 888             "Attribute 'optnone' requires 'noinline'!", V);
 889
 890     Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
 891                                 Attribute::OptimizeForSize),
 892             "Attributes 'optsize and optnone' are incompatible!", V);
 893
 894     Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
 895                                 Attribute::MinSize),
 896             "Attributes 'minsize and optnone' are incompatible!", V);
 897   }
 898 }
 899
 900 void Verifier::VerifyBitcastType(const Value *V, Type *DestTy, Type *SrcTy) {
 901   // Get the size of the types in bits, we'll need this later
 902   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 903   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 904
 905   // BitCast implies a no-op cast of type only. No bits change.
 906   // However, you can't cast pointers to anything but pointers.
 907   Assert1(SrcTy->isPointerTy() == DestTy->isPointerTy(),
 908           "Bitcast requires both operands to be pointer or neither", V);
 909   Assert1(SrcBitSize == DestBitSize,
 910           "Bitcast requires types of same width", V);
 911
 912   // Disallow aggregates.
 913   Assert1(!SrcTy->isAggregateType(),
 914           "Bitcast operand must not be aggregate", V);
 915   Assert1(!DestTy->isAggregateType(),
 916           "Bitcast type must not be aggregate", V);
 917
 918   // Without datalayout, assume all address spaces are the same size.
 919   // Don't check if both types are not pointers.
 920   // Skip casts between scalars and vectors.
 921   if (!DL ||
 922       !SrcTy->isPtrOrPtrVectorTy() ||
 923       !DestTy->isPtrOrPtrVectorTy() ||
 924       SrcTy->isVectorTy() != DestTy->isVectorTy()) {
 925     return;
 926   }
 927
 928   unsigned SrcAS = SrcTy->getPointerAddressSpace();
 929   unsigned DstAS = DestTy->getPointerAddressSpace();
 930
 931   Assert1(SrcAS == DstAS,
 932           "Bitcasts between pointers of different address spaces is not legal."
 933           "Use AddrSpaceCast instead.", V);
 934 }
 935
 936 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
 937   if (CE->getOpcode() == Instruction::BitCast) {
 938     Type *SrcTy = CE->getOperand(0)->getType();
 939     Type *DstTy = CE->getType();
 940     VerifyBitcastType(CE, DstTy, SrcTy);
 941   }
 942 }
 943
 944 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
 945   if (Attrs.getNumSlots() == 0)
 946     return true;
 947
 948   unsigned LastSlot = Attrs.getNumSlots() - 1;
 949   unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
 950   if (LastIndex <= Params
 951       || (LastIndex == AttributeSet::FunctionIndex
 952           && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
 953     return true;
 954
 955   return false;
 956 }
 957
 958 // visitFunction - Verify that a function is ok.
 959 //
 960 void Verifier::visitFunction(const Function &F) {
 961   // Check function arguments.
 962   FunctionType *FT = F.getFunctionType();
 963   unsigned NumArgs = F.arg_size();
 964
 965   Assert1(Context == &F.getContext(),
 966           "Function context does not match Module context!", &F);
 967
 968   Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
 969   Assert2(FT->getNumParams() == NumArgs,
 970           "# formal arguments must match # of arguments for function type!",
 971           &F, FT);
 972   Assert1(F.getReturnType()->isFirstClassType() ||
 973           F.getReturnType()->isVoidTy() ||
 974           F.getReturnType()->isStructTy(),
 975           "Functions cannot return aggregate values!", &F);
 976
 977   Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
 978           "Invalid struct return type!", &F);
 979
 980   AttributeSet Attrs = F.getAttributes();
 981
 982   Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
 983           "Attribute after last parameter!", &F);
 984
 985   // Check function attributes.
 986   VerifyFunctionAttrs(FT, Attrs, &F);
 987
 988   // On function declarations/definitions, we do not support the builtin
 989   // attribute. We do not check this in VerifyFunctionAttrs since that is
 990   // checking for Attributes that can/can not ever be on functions.
 991   Assert1(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
 992                               Attribute::Builtin),
 993           "Attribute 'builtin' can only be applied to a callsite.", &F);
 994
 995   // Check that this function meets the restrictions on this calling convention.
 996   switch (F.getCallingConv()) {
 997   default:
 998     break;
 999   case CallingConv::C:
1000     break;
1001   case CallingConv::Fast:
1002   case CallingConv::Cold:
1003   case CallingConv::X86_FastCall:
1004   case CallingConv::X86_ThisCall:
1005   case CallingConv::Intel_OCL_BI:
1006   case CallingConv::PTX_Kernel:
1007   case CallingConv::PTX_Device:
1008     Assert1(!F.isVarArg(),
1009             "Varargs functions must have C calling conventions!", &F);
1010     break;
1011   }
1012
1013   bool isLLVMdotName = F.getName().size() >= 5 &&
1014                        F.getName().substr(0, 5) == "llvm.";
1015
1016   // Check that the argument values match the function type for this function...
1017   unsigned i = 0;
1018   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1019        ++I, ++i) {
1020     Assert2(I->getType() == FT->getParamType(i),
1021             "Argument value does not match function argument type!",
1022             I, FT->getParamType(i));
1023     Assert1(I->getType()->isFirstClassType(),
1024             "Function arguments must have first-class types!", I);
1025     if (!isLLVMdotName)
1026       Assert2(!I->getType()->isMetadataTy(),
1027               "Function takes metadata but isn't an intrinsic", I, &F);
1028   }
1029
1030   if (F.isMaterializable()) {
1031     // Function has a body somewhere we can't see.
1032   } else if (F.isDeclaration()) {
1033     Assert1(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1034             "invalid linkage type for function declaration", &F);
1035   } else {
1036     // Verify that this function (which has a body) is not named "llvm.*".  It
1037     // is not legal to define intrinsics.
1038     Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1039
1040     // Check the entry node
1041     const BasicBlock *Entry = &F.getEntryBlock();
1042     Assert1(pred_begin(Entry) == pred_end(Entry),
1043             "Entry block to function must not have predecessors!", Entry);
1044
1045     // The address of the entry block cannot be taken, unless it is dead.
1046     if (Entry->hasAddressTaken()) {
1047       Assert1(!BlockAddress::lookup(Entry)->isConstantUsed(),
1048               "blockaddress may not be used with the entry block!", Entry);
1049     }
1050   }
1051
1052   // If this function is actually an intrinsic, verify that it is only used in
1053   // direct call/invokes, never having its "address taken".
1054   if (F.getIntrinsicID()) {
1055     const User *U;
1056     if (F.hasAddressTaken(&U))
1057       Assert1(0, "Invalid user of intrinsic instruction!", U);
1058   }
1059
1060   Assert1(!F.hasDLLImportStorageClass() ||
1061           (F.isDeclaration() && F.hasExternalLinkage()) ||
1062           F.hasAvailableExternallyLinkage(),
1063           "Function is marked as dllimport, but not external.", &F);
1064 }
1065
1066 // verifyBasicBlock - Verify that a basic block is well formed...
1067 //
1068 void Verifier::visitBasicBlock(BasicBlock &BB) {
1069   InstsInThisBlock.clear();
1070
1071   // Ensure that basic blocks have terminators!
1072   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1073
1074   // Check constraints that this basic block imposes on all of the PHI nodes in
1075   // it.
1076   if (isa<PHINode>(BB.front())) {
1077     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1078     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1079     std::sort(Preds.begin(), Preds.end());
1080     PHINode *PN;
1081     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1082       // Ensure that PHI nodes have at least one entry!
1083       Assert1(PN->getNumIncomingValues() != 0,
1084               "PHI nodes must have at least one entry.  If the block is dead, "
1085               "the PHI should be removed!", PN);
1086       Assert1(PN->getNumIncomingValues() == Preds.size(),
1087               "PHINode should have one entry for each predecessor of its "
1088               "parent basic block!", PN);
1089
1090       // Get and sort all incoming values in the PHI node...
1091       Values.clear();
1092       Values.reserve(PN->getNumIncomingValues());
1093       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1094         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1095                                         PN->getIncomingValue(i)));
1096       std::sort(Values.begin(), Values.end());
1097
1098       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1099         // Check to make sure that if there is more than one entry for a
1100         // particular basic block in this PHI node, that the incoming values are
1101         // all identical.
1102         //
1103         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
1104                 Values[i].second == Values[i-1].second,
1105                 "PHI node has multiple entries for the same basic block with "
1106                 "different incoming values!", PN, Values[i].first,
1107                 Values[i].second, Values[i-1].second);
1108
1109         // Check to make sure that the predecessors and PHI node entries are
1110         // matched up.
1111         Assert3(Values[i].first == Preds[i],
1112                 "PHI node entries do not match predecessors!", PN,
1113                 Values[i].first, Preds[i]);
1114       }
1115     }
1116   }
1117 }
1118
1119 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1120   // Ensure that terminators only exist at the end of the basic block.
1121   Assert1(&I == I.getParent()->getTerminator(),
1122           "Terminator found in the middle of a basic block!", I.getParent());
1123   visitInstruction(I);
1124 }
1125
1126 void Verifier::visitBranchInst(BranchInst &BI) {
1127   if (BI.isConditional()) {
1128     Assert2(BI.getCondition()->getType()->isIntegerTy(1),
1129             "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1130   }
1131   visitTerminatorInst(BI);
1132 }
1133
1134 void Verifier::visitReturnInst(ReturnInst &RI) {
1135   Function *F = RI.getParent()->getParent();
1136   unsigned N = RI.getNumOperands();
1137   if (F->getReturnType()->isVoidTy())
1138     Assert2(N == 0,
1139             "Found return instr that returns non-void in Function of void "
1140             "return type!", &RI, F->getReturnType());
1141   else
1142     Assert2(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1143             "Function return type does not match operand "
1144             "type of return inst!", &RI, F->getReturnType());
1145
1146   // Check to make sure that the return value has necessary properties for
1147   // terminators...
1148   visitTerminatorInst(RI);
1149 }
1150
1151 void Verifier::visitSwitchInst(SwitchInst &SI) {
1152   // Check to make sure that all of the constants in the switch instruction
1153   // have the same type as the switched-on value.
1154   Type *SwitchTy = SI.getCondition()->getType();
1155   SmallPtrSet<ConstantInt*, 32> Constants;
1156   for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1157     Assert1(i.getCaseValue()->getType() == SwitchTy,
1158             "Switch constants must all be same type as switch value!", &SI);
1159     Assert2(Constants.insert(i.getCaseValue()),
1160             "Duplicate integer as switch case", &SI, i.getCaseValue());
1161   }
1162
1163   visitTerminatorInst(SI);
1164 }
1165
1166 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1167   Assert1(BI.getAddress()->getType()->isPointerTy(),
1168           "Indirectbr operand must have pointer type!", &BI);
1169   for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1170     Assert1(BI.getDestination(i)->getType()->isLabelTy(),
1171             "Indirectbr destinations must all have pointer type!", &BI);
1172
1173   visitTerminatorInst(BI);
1174 }
1175
1176 void Verifier::visitSelectInst(SelectInst &SI) {
1177   Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1178                                           SI.getOperand(2)),
1179           "Invalid operands for select instruction!", &SI);
1180
1181   Assert1(SI.getTrueValue()->getType() == SI.getType(),
1182           "Select values must have same type as select instruction!", &SI);
1183   visitInstruction(SI);
1184 }
1185
1186 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1187 /// a pass, if any exist, it's an error.
1188 ///
1189 void Verifier::visitUserOp1(Instruction &I) {
1190   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
1191 }
1192
1193 void Verifier::visitTruncInst(TruncInst &I) {
1194   // Get the source and destination types
1195   Type *SrcTy = I.getOperand(0)->getType();
1196   Type *DestTy = I.getType();
1197
1198   // Get the size of the types in bits, we'll need this later
1199   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1200   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1201
1202   Assert1(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1203   Assert1(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1204   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1205           "trunc source and destination must both be a vector or neither", &I);
1206   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
1207
1208   visitInstruction(I);
1209 }
1210
1211 void Verifier::visitZExtInst(ZExtInst &I) {
1212   // Get the source and destination types
1213   Type *SrcTy = I.getOperand(0)->getType();
1214   Type *DestTy = I.getType();
1215
1216   // Get the size of the types in bits, we'll need this later
1217   Assert1(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1218   Assert1(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1219   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1220           "zext source and destination must both be a vector or neither", &I);
1221   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1222   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1223
1224   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
1225
1226   visitInstruction(I);
1227 }
1228
1229 void Verifier::visitSExtInst(SExtInst &I) {
1230   // Get the source and destination types
1231   Type *SrcTy = I.getOperand(0)->getType();
1232   Type *DestTy = I.getType();
1233
1234   // Get the size of the types in bits, we'll need this later
1235   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1236   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1237
1238   Assert1(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1239   Assert1(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1240   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1241           "sext source and destination must both be a vector or neither", &I);
1242   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
1243
1244   visitInstruction(I);
1245 }
1246
1247 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1248   // Get the source and destination types
1249   Type *SrcTy = I.getOperand(0)->getType();
1250   Type *DestTy = I.getType();
1251   // Get the size of the types in bits, we'll need this later
1252   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1253   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1254
1255   Assert1(SrcTy->isFPOrFPVectorTy(),"FPTrunc only operates on FP", &I);
1256   Assert1(DestTy->isFPOrFPVectorTy(),"FPTrunc only produces an FP", &I);
1257   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1258           "fptrunc source and destination must both be a vector or neither",&I);
1259   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
1260
1261   visitInstruction(I);
1262 }
1263
1264 void Verifier::visitFPExtInst(FPExtInst &I) {
1265   // Get the source and destination types
1266   Type *SrcTy = I.getOperand(0)->getType();
1267   Type *DestTy = I.getType();
1268
1269   // Get the size of the types in bits, we'll need this later
1270   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1271   unsigned DestBitSize = DestTy->getScalarSizeInBits();
1272
1273   Assert1(SrcTy->isFPOrFPVectorTy(),"FPExt only operates on FP", &I);
1274   Assert1(DestTy->isFPOrFPVectorTy(),"FPExt only produces an FP", &I);
1275   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1276           "fpext source and destination must both be a vector or neither", &I);
1277   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
1278
1279   visitInstruction(I);
1280 }
1281
1282 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1283   // Get the source and destination types
1284   Type *SrcTy = I.getOperand(0)->getType();
1285   Type *DestTy = I.getType();
1286
1287   bool SrcVec = SrcTy->isVectorTy();
1288   bool DstVec = DestTy->isVectorTy();
1289
1290   Assert1(SrcVec == DstVec,
1291           "UIToFP source and dest must both be vector or scalar", &I);
1292   Assert1(SrcTy->isIntOrIntVectorTy(),
1293           "UIToFP source must be integer or integer vector", &I);
1294   Assert1(DestTy->isFPOrFPVectorTy(),
1295           "UIToFP result must be FP or FP vector", &I);
1296
1297   if (SrcVec && DstVec)
1298     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1299             cast<VectorType>(DestTy)->getNumElements(),
1300             "UIToFP source and dest vector length mismatch", &I);
1301
1302   visitInstruction(I);
1303 }
1304
1305 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1306   // Get the source and destination types
1307   Type *SrcTy = I.getOperand(0)->getType();
1308   Type *DestTy = I.getType();
1309
1310   bool SrcVec = SrcTy->isVectorTy();
1311   bool DstVec = DestTy->isVectorTy();
1312
1313   Assert1(SrcVec == DstVec,
1314           "SIToFP source and dest must both be vector or scalar", &I);
1315   Assert1(SrcTy->isIntOrIntVectorTy(),
1316           "SIToFP source must be integer or integer vector", &I);
1317   Assert1(DestTy->isFPOrFPVectorTy(),
1318           "SIToFP result must be FP or FP vector", &I);
1319
1320   if (SrcVec && DstVec)
1321     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1322             cast<VectorType>(DestTy)->getNumElements(),
1323             "SIToFP source and dest vector length mismatch", &I);
1324
1325   visitInstruction(I);
1326 }
1327
1328 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1329   // Get the source and destination types
1330   Type *SrcTy = I.getOperand(0)->getType();
1331   Type *DestTy = I.getType();
1332
1333   bool SrcVec = SrcTy->isVectorTy();
1334   bool DstVec = DestTy->isVectorTy();
1335
1336   Assert1(SrcVec == DstVec,
1337           "FPToUI source and dest must both be vector or scalar", &I);
1338   Assert1(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1339           &I);
1340   Assert1(DestTy->isIntOrIntVectorTy(),
1341           "FPToUI result must be integer or integer vector", &I);
1342
1343   if (SrcVec && DstVec)
1344     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1345             cast<VectorType>(DestTy)->getNumElements(),
1346             "FPToUI source and dest vector length mismatch", &I);
1347
1348   visitInstruction(I);
1349 }
1350
1351 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1352   // Get the source and destination types
1353   Type *SrcTy = I.getOperand(0)->getType();
1354   Type *DestTy = I.getType();
1355
1356   bool SrcVec = SrcTy->isVectorTy();
1357   bool DstVec = DestTy->isVectorTy();
1358
1359   Assert1(SrcVec == DstVec,
1360           "FPToSI source and dest must both be vector or scalar", &I);
1361   Assert1(SrcTy->isFPOrFPVectorTy(),
1362           "FPToSI source must be FP or FP vector", &I);
1363   Assert1(DestTy->isIntOrIntVectorTy(),
1364           "FPToSI result must be integer or integer vector", &I);
1365
1366   if (SrcVec && DstVec)
1367     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1368             cast<VectorType>(DestTy)->getNumElements(),
1369             "FPToSI source and dest vector length mismatch", &I);
1370
1371   visitInstruction(I);
1372 }
1373
1374 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1375   // Get the source and destination types
1376   Type *SrcTy = I.getOperand(0)->getType();
1377   Type *DestTy = I.getType();
1378
1379   Assert1(SrcTy->getScalarType()->isPointerTy(),
1380           "PtrToInt source must be pointer", &I);
1381   Assert1(DestTy->getScalarType()->isIntegerTy(),
1382           "PtrToInt result must be integral", &I);
1383   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1384           "PtrToInt type mismatch", &I);
1385
1386   if (SrcTy->isVectorTy()) {
1387     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1388     VectorType *VDest = dyn_cast<VectorType>(DestTy);
1389     Assert1(VSrc->getNumElements() == VDest->getNumElements(),
1390           "PtrToInt Vector width mismatch", &I);
1391   }
1392
1393   visitInstruction(I);
1394 }
1395
1396 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1397   // Get the source and destination types
1398   Type *SrcTy = I.getOperand(0)->getType();
1399   Type *DestTy = I.getType();
1400
1401   Assert1(SrcTy->getScalarType()->isIntegerTy(),
1402           "IntToPtr source must be an integral", &I);
1403   Assert1(DestTy->getScalarType()->isPointerTy(),
1404           "IntToPtr result must be a pointer",&I);
1405   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1406           "IntToPtr type mismatch", &I);
1407   if (SrcTy->isVectorTy()) {
1408     VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1409     VectorType *VDest = dyn_cast<VectorType>(DestTy);
1410     Assert1(VSrc->getNumElements() == VDest->getNumElements(),
1411           "IntToPtr Vector width mismatch", &I);
1412   }
1413   visitInstruction(I);
1414 }
1415
1416 void Verifier::visitBitCastInst(BitCastInst &I) {
1417   Type *SrcTy = I.getOperand(0)->getType();
1418   Type *DestTy = I.getType();
1419   VerifyBitcastType(&I, DestTy, SrcTy);
1420   visitInstruction(I);
1421 }
1422
1423 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1424   Type *SrcTy = I.getOperand(0)->getType();
1425   Type *DestTy = I.getType();
1426
1427   Assert1(SrcTy->isPtrOrPtrVectorTy(),
1428           "AddrSpaceCast source must be a pointer", &I);
1429   Assert1(DestTy->isPtrOrPtrVectorTy(),
1430           "AddrSpaceCast result must be a pointer", &I);
1431   Assert1(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1432           "AddrSpaceCast must be between different address spaces", &I);
1433   if (SrcTy->isVectorTy())
1434     Assert1(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1435             "AddrSpaceCast vector pointer number of elements mismatch", &I);
1436   visitInstruction(I);
1437 }
1438
1439 /// visitPHINode - Ensure that a PHI node is well formed.
1440 ///
1441 void Verifier::visitPHINode(PHINode &PN) {
1442   // Ensure that the PHI nodes are all grouped together at the top of the block.
1443   // This can be tested by checking whether the instruction before this is
1444   // either nonexistent (because this is begin()) or is a PHI node.  If not,
1445   // then there is some other instruction before a PHI.
1446   Assert2(&PN == &PN.getParent()->front() ||
1447           isa<PHINode>(--BasicBlock::iterator(&PN)),
1448           "PHI nodes not grouped at top of basic block!",
1449           &PN, PN.getParent());
1450
1451   // Check that all of the values of the PHI node have the same type as the
1452   // result, and that the incoming blocks are really basic blocks.
1453   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1454     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1455             "PHI node operands are not the same type as the result!", &PN);
1456   }
1457
1458   // All other PHI node constraints are checked in the visitBasicBlock method.
1459
1460   visitInstruction(PN);
1461 }
1462
1463 void Verifier::VerifyCallSite(CallSite CS) {
1464   Instruction *I = CS.getInstruction();
1465
1466   Assert1(CS.getCalledValue()->getType()->isPointerTy(),
1467           "Called function must be a pointer!", I);
1468   PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1469
1470   Assert1(FPTy->getElementType()->isFunctionTy(),
1471           "Called function is not pointer to function type!", I);
1472   FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1473
1474   // Verify that the correct number of arguments are being passed
1475   if (FTy->isVarArg())
1476     Assert1(CS.arg_size() >= FTy->getNumParams(),
1477             "Called function requires more parameters than were provided!",I);
1478   else
1479     Assert1(CS.arg_size() == FTy->getNumParams(),
1480             "Incorrect number of arguments passed to called function!", I);
1481
1482   // Verify that all arguments to the call match the function type.
1483   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1484     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1485             "Call parameter type does not match function signature!",
1486             CS.getArgument(i), FTy->getParamType(i), I);
1487
1488   AttributeSet Attrs = CS.getAttributes();
1489
1490   Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1491           "Attribute after last parameter!", I);
1492
1493   // Verify call attributes.
1494   VerifyFunctionAttrs(FTy, Attrs, I);
1495
1496   if (FTy->isVarArg()) {
1497     // FIXME? is 'nest' even legal here?
1498     bool SawNest = false;
1499     bool SawReturned = false;
1500
1501     for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
1502       if (Attrs.hasAttribute(Idx, Attribute::Nest))
1503         SawNest = true;
1504       if (Attrs.hasAttribute(Idx, Attribute::Returned))
1505         SawReturned = true;
1506     }
1507
1508     // Check attributes on the varargs part.
1509     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1510       Type *Ty = CS.getArgument(Idx-1)->getType();
1511       VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
1512
1513       if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1514         Assert1(!SawNest, "More than one parameter has attribute nest!", I);
1515         SawNest = true;
1516       }
1517
1518       if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1519         Assert1(!SawReturned, "More than one parameter has attribute returned!",
1520                 I);
1521         Assert1(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
1522                 "Incompatible argument and return types for 'returned' "
1523                 "attribute", I);
1524         SawReturned = true;
1525       }
1526
1527       Assert1(!Attrs.hasAttribute(Idx, Attribute::StructRet),
1528               "Attribute 'sret' cannot be used for vararg call arguments!", I);
1529
1530       if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
1531         Assert1(Idx == CS.arg_size(), "inalloca isn't on the last argument!",
1532                 I);
1533     }
1534   }
1535
1536   // Verify that there's no metadata unless it's a direct call to an intrinsic.
1537   if (CS.getCalledFunction() == nullptr ||
1538       !CS.getCalledFunction()->getName().startswith("llvm.")) {
1539     for (FunctionType::param_iterator PI = FTy->param_begin(),
1540            PE = FTy->param_end(); PI != PE; ++PI)
1541       Assert1(!(*PI)->isMetadataTy(),
1542               "Function has metadata parameter but isn't an intrinsic", I);
1543   }
1544
1545   visitInstruction(*I);
1546 }
1547
1548 void Verifier::visitCallInst(CallInst &CI) {
1549   VerifyCallSite(&CI);
1550
1551   if (Function *F = CI.getCalledFunction())
1552     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1553       visitIntrinsicFunctionCall(ID, CI);
1554 }
1555
1556 void Verifier::visitInvokeInst(InvokeInst &II) {
1557   VerifyCallSite(&II);
1558
1559   // Verify that there is a landingpad instruction as the first non-PHI
1560   // instruction of the 'unwind' destination.
1561   Assert1(II.getUnwindDest()->isLandingPad(),
1562           "The unwind destination does not have a landingpad instruction!",&II);
1563
1564   visitTerminatorInst(II);
1565 }
1566
1567 /// visitBinaryOperator - Check that both arguments to the binary operator are
1568 /// of the same type!
1569 ///
1570 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1571   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1572           "Both operands to a binary operator are not of the same type!", &B);
1573
1574   switch (B.getOpcode()) {
1575   // Check that integer arithmetic operators are only used with
1576   // integral operands.
1577   case Instruction::Add:
1578   case Instruction::Sub:
1579   case Instruction::Mul:
1580   case Instruction::SDiv:
1581   case Instruction::UDiv:
1582   case Instruction::SRem:
1583   case Instruction::URem:
1584     Assert1(B.getType()->isIntOrIntVectorTy(),
1585             "Integer arithmetic operators only work with integral types!", &B);
1586     Assert1(B.getType() == B.getOperand(0)->getType(),
1587             "Integer arithmetic operators must have same type "
1588             "for operands and result!", &B);
1589     break;
1590   // Check that floating-point arithmetic operators are only used with
1591   // floating-point operands.
1592   case Instruction::FAdd:
1593   case Instruction::FSub:
1594   case Instruction::FMul:
1595   case Instruction::FDiv:
1596   case Instruction::FRem:
1597     Assert1(B.getType()->isFPOrFPVectorTy(),
1598             "Floating-point arithmetic operators only work with "
1599             "floating-point types!", &B);
1600     Assert1(B.getType() == B.getOperand(0)->getType(),
1601             "Floating-point arithmetic operators must have same type "
1602             "for operands and result!", &B);
1603     break;
1604   // Check that logical operators are only used with integral operands.
1605   case Instruction::And:
1606   case Instruction::Or:
1607   case Instruction::Xor:
1608     Assert1(B.getType()->isIntOrIntVectorTy(),
1609             "Logical operators only work with integral types!", &B);
1610     Assert1(B.getType() == B.getOperand(0)->getType(),
1611             "Logical operators must have same type for operands and result!",
1612             &B);
1613     break;
1614   case Instruction::Shl:
1615   case Instruction::LShr:
1616   case Instruction::AShr:
1617     Assert1(B.getType()->isIntOrIntVectorTy(),
1618             "Shifts only work with integral types!", &B);
1619     Assert1(B.getType() == B.getOperand(0)->getType(),
1620             "Shift return type must be same as operands!", &B);
1621     break;
1622   default:
1623     llvm_unreachable("Unknown BinaryOperator opcode!");
1624   }
1625
1626   visitInstruction(B);
1627 }
1628
1629 void Verifier::visitICmpInst(ICmpInst &IC) {
1630   // Check that the operands are the same type
1631   Type *Op0Ty = IC.getOperand(0)->getType();
1632   Type *Op1Ty = IC.getOperand(1)->getType();
1633   Assert1(Op0Ty == Op1Ty,
1634           "Both operands to ICmp instruction are not of the same type!", &IC);
1635   // Check that the operands are the right type
1636   Assert1(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
1637           "Invalid operand types for ICmp instruction", &IC);
1638   // Check that the predicate is valid.
1639   Assert1(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1640           IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
1641           "Invalid predicate in ICmp instruction!", &IC);
1642
1643   visitInstruction(IC);
1644 }
1645
1646 void Verifier::visitFCmpInst(FCmpInst &FC) {
1647   // Check that the operands are the same type
1648   Type *Op0Ty = FC.getOperand(0)->getType();
1649   Type *Op1Ty = FC.getOperand(1)->getType();
1650   Assert1(Op0Ty == Op1Ty,
1651           "Both operands to FCmp instruction are not of the same type!", &FC);
1652   // Check that the operands are the right type
1653   Assert1(Op0Ty->isFPOrFPVectorTy(),
1654           "Invalid operand types for FCmp instruction", &FC);
1655   // Check that the predicate is valid.
1656   Assert1(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
1657           FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
1658           "Invalid predicate in FCmp instruction!", &FC);
1659
1660   visitInstruction(FC);
1661 }
1662
1663 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1664   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1665                                               EI.getOperand(1)),
1666           "Invalid extractelement operands!", &EI);
1667   visitInstruction(EI);
1668 }
1669
1670 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1671   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1672                                              IE.getOperand(1),
1673                                              IE.getOperand(2)),
1674           "Invalid insertelement operands!", &IE);
1675   visitInstruction(IE);
1676 }
1677
1678 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1679   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1680                                              SV.getOperand(2)),
1681           "Invalid shufflevector operands!", &SV);
1682   visitInstruction(SV);
1683 }
1684
1685 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1686   Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
1687
1688   Assert1(isa<PointerType>(TargetTy),
1689     "GEP base pointer is not a vector or a vector of pointers", &GEP);
1690   Assert1(cast<PointerType>(TargetTy)->getElementType()->isSized(),
1691           "GEP into unsized type!", &GEP);
1692   Assert1(GEP.getPointerOperandType()->isVectorTy() ==
1693           GEP.getType()->isVectorTy(), "Vector GEP must return a vector value",
1694           &GEP);
1695
1696   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1697   Type *ElTy =
1698     GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
1699   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1700
1701   Assert2(GEP.getType()->getScalarType()->isPointerTy() &&
1702           cast<PointerType>(GEP.getType()->getScalarType())->getElementType()
1703           == ElTy, "GEP is not of right type for indices!", &GEP, ElTy);
1704
1705   if (GEP.getPointerOperandType()->isVectorTy()) {
1706     // Additional checks for vector GEPs.
1707     unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
1708     Assert1(GepWidth == GEP.getType()->getVectorNumElements(),
1709             "Vector GEP result width doesn't match operand's", &GEP);
1710     for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
1711       Type *IndexTy = Idxs[i]->getType();
1712       Assert1(IndexTy->isVectorTy(),
1713               "Vector GEP must have vector indices!", &GEP);
1714       unsigned IndexWidth = IndexTy->getVectorNumElements();
1715       Assert1(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
1716     }
1717   }
1718   visitInstruction(GEP);
1719 }
1720
1721 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
1722   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
1723 }
1724
1725 void Verifier::visitLoadInst(LoadInst &LI) {
1726   PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1727   Assert1(PTy, "Load operand must be a pointer.", &LI);
1728   Type *ElTy = PTy->getElementType();
1729   Assert2(ElTy == LI.getType(),
1730           "Load result type does not match pointer operand type!", &LI, ElTy);
1731   if (LI.isAtomic()) {
1732     Assert1(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
1733             "Load cannot have Release ordering", &LI);
1734     Assert1(LI.getAlignment() != 0,
1735             "Atomic load must specify explicit alignment", &LI);
1736     if (!ElTy->isPointerTy()) {
1737       Assert2(ElTy->isIntegerTy(),
1738               "atomic load operand must have integer type!",
1739               &LI, ElTy);
1740       unsigned Size = ElTy->getPrimitiveSizeInBits();
1741       Assert2(Size >= 8 && !(Size & (Size - 1)),
1742               "atomic load operand must be power-of-two byte-sized integer",
1743               &LI, ElTy);
1744     }
1745   } else {
1746     Assert1(LI.getSynchScope() == CrossThread,
1747             "Non-atomic load cannot have SynchronizationScope specified", &LI);
1748   }
1749
1750   if (MDNode *Range = LI.getMetadata(LLVMContext::MD_range)) {
1751     unsigned NumOperands = Range->getNumOperands();
1752     Assert1(NumOperands % 2 == 0, "Unfinished range!", Range);
1753     unsigned NumRanges = NumOperands / 2;
1754     Assert1(NumRanges >= 1, "It should have at least one range!", Range);
1755
1756     ConstantRange LastRange(1); // Dummy initial value
1757     for (unsigned i = 0; i < NumRanges; ++i) {
1758       ConstantInt *Low = dyn_cast<ConstantInt>(Range->getOperand(2*i));
1759       Assert1(Low, "The lower limit must be an integer!", Low);
1760       ConstantInt *High = dyn_cast<ConstantInt>(Range->getOperand(2*i + 1));
1761       Assert1(High, "The upper limit must be an integer!", High);
1762       Assert1(High->getType() == Low->getType() &&
1763               High->getType() == ElTy, "Range types must match load type!",
1764               &LI);
1765
1766       APInt HighV = High->getValue();
1767       APInt LowV = Low->getValue();
1768       ConstantRange CurRange(LowV, HighV);
1769       Assert1(!CurRange.isEmptySet() && !CurRange.isFullSet(),
1770               "Range must not be empty!", Range);
1771       if (i != 0) {
1772         Assert1(CurRange.intersectWith(LastRange).isEmptySet(),
1773                 "Intervals are overlapping", Range);
1774         Assert1(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
1775                 Range);
1776         Assert1(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
1777                 Range);
1778       }
1779       LastRange = ConstantRange(LowV, HighV);
1780     }
1781     if (NumRanges > 2) {
1782       APInt FirstLow =
1783         dyn_cast<ConstantInt>(Range->getOperand(0))->getValue();
1784       APInt FirstHigh =
1785         dyn_cast<ConstantInt>(Range->getOperand(1))->getValue();
1786       ConstantRange FirstRange(FirstLow, FirstHigh);
1787       Assert1(FirstRange.intersectWith(LastRange).isEmptySet(),
1788               "Intervals are overlapping", Range);
1789       Assert1(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
1790               Range);
1791     }
1792
1793
1794   }
1795
1796   visitInstruction(LI);
1797 }
1798
1799 void Verifier::visitStoreInst(StoreInst &SI) {
1800   PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1801   Assert1(PTy, "Store operand must be a pointer.", &SI);
1802   Type *ElTy = PTy->getElementType();
1803   Assert2(ElTy == SI.getOperand(0)->getType(),
1804           "Stored value type does not match pointer operand type!",
1805           &SI, ElTy);
1806   if (SI.isAtomic()) {
1807     Assert1(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
1808             "Store cannot have Acquire ordering", &SI);
1809     Assert1(SI.getAlignment() != 0,
1810             "Atomic store must specify explicit alignment", &SI);
1811     if (!ElTy->isPointerTy()) {
1812       Assert2(ElTy->isIntegerTy(),
1813               "atomic store operand must have integer type!",
1814               &SI, ElTy);
1815       unsigned Size = ElTy->getPrimitiveSizeInBits();
1816       Assert2(Size >= 8 && !(Size & (Size - 1)),
1817               "atomic store operand must be power-of-two byte-sized integer",
1818               &SI, ElTy);
1819     }
1820   } else {
1821     Assert1(SI.getSynchScope() == CrossThread,
1822             "Non-atomic store cannot have SynchronizationScope specified", &SI);
1823   }
1824   visitInstruction(SI);
1825 }
1826
1827 void Verifier::visitAllocaInst(AllocaInst &AI) {
1828   SmallPtrSet<const Type*, 4> Visited;
1829   PointerType *PTy = AI.getType();
1830   Assert1(PTy->getAddressSpace() == 0,
1831           "Allocation instruction pointer not in the generic address space!",
1832           &AI);
1833   Assert1(PTy->getElementType()->isSized(&Visited), "Cannot allocate unsized type",
1834           &AI);
1835   Assert1(AI.getArraySize()->getType()->isIntegerTy(),
1836           "Alloca array size must have integer type", &AI);
1837
1838   visitInstruction(AI);
1839 }
1840
1841 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
1842
1843   // FIXME: more conditions???
1844   Assert1(CXI.getSuccessOrdering() != NotAtomic,
1845           "cmpxchg instructions must be atomic.", &CXI);
1846   Assert1(CXI.getFailureOrdering() != NotAtomic,
1847           "cmpxchg instructions must be atomic.", &CXI);
1848   Assert1(CXI.getSuccessOrdering() != Unordered,
1849           "cmpxchg instructions cannot be unordered.", &CXI);
1850   Assert1(CXI.getFailureOrdering() != Unordered,
1851           "cmpxchg instructions cannot be unordered.", &CXI);
1852   Assert1(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
1853           "cmpxchg instructions be at least as constrained on success as fail",
1854           &CXI);
1855   Assert1(CXI.getFailureOrdering() != Release &&
1856               CXI.getFailureOrdering() != AcquireRelease,
1857           "cmpxchg failure ordering cannot include release semantics", &CXI);
1858
1859   PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
1860   Assert1(PTy, "First cmpxchg operand must be a pointer.", &CXI);
1861   Type *ElTy = PTy->getElementType();
1862   Assert2(ElTy->isIntegerTy(),
1863           "cmpxchg operand must have integer type!",
1864           &CXI, ElTy);
1865   unsigned Size = ElTy->getPrimitiveSizeInBits();
1866   Assert2(Size >= 8 && !(Size & (Size - 1)),
1867           "cmpxchg operand must be power-of-two byte-sized integer",
1868           &CXI, ElTy);
1869   Assert2(ElTy == CXI.getOperand(1)->getType(),
1870           "Expected value type does not match pointer operand type!",
1871           &CXI, ElTy);
1872   Assert2(ElTy == CXI.getOperand(2)->getType(),
1873           "Stored value type does not match pointer operand type!",
1874           &CXI, ElTy);
1875   visitInstruction(CXI);
1876 }
1877
1878 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
1879   Assert1(RMWI.getOrdering() != NotAtomic,
1880           "atomicrmw instructions must be atomic.", &RMWI);
1881   Assert1(RMWI.getOrdering() != Unordered,
1882           "atomicrmw instructions cannot be unordered.", &RMWI);
1883   PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
1884   Assert1(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
1885   Type *ElTy = PTy->getElementType();
1886   Assert2(ElTy->isIntegerTy(),
1887           "atomicrmw operand must have integer type!",
1888           &RMWI, ElTy);
1889   unsigned Size = ElTy->getPrimitiveSizeInBits();
1890   Assert2(Size >= 8 && !(Size & (Size - 1)),
1891           "atomicrmw operand must be power-of-two byte-sized integer",
1892           &RMWI, ElTy);
1893   Assert2(ElTy == RMWI.getOperand(1)->getType(),
1894           "Argument value type does not match pointer operand type!",
1895           &RMWI, ElTy);
1896   Assert1(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
1897           RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
1898           "Invalid binary operation!", &RMWI);
1899   visitInstruction(RMWI);
1900 }
1901
1902 void Verifier::visitFenceInst(FenceInst &FI) {
1903   const AtomicOrdering Ordering = FI.getOrdering();
1904   Assert1(Ordering == Acquire || Ordering == Release ||
1905           Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
1906           "fence instructions may only have "
1907           "acquire, release, acq_rel, or seq_cst ordering.", &FI);
1908   visitInstruction(FI);
1909 }
1910
1911 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1912   Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1913                                            EVI.getIndices()) ==
1914           EVI.getType(),
1915           "Invalid ExtractValueInst operands!", &EVI);
1916
1917   visitInstruction(EVI);
1918 }
1919
1920 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1921   Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1922                                            IVI.getIndices()) ==
1923           IVI.getOperand(1)->getType(),
1924           "Invalid InsertValueInst operands!", &IVI);
1925
1926   visitInstruction(IVI);
1927 }
1928
1929 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
1930   BasicBlock *BB = LPI.getParent();
1931
1932   // The landingpad instruction is ill-formed if it doesn't have any clauses and
1933   // isn't a cleanup.
1934   Assert1(LPI.getNumClauses() > 0 || LPI.isCleanup(),
1935           "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
1936
1937   // The landingpad instruction defines its parent as a landing pad block. The
1938   // landing pad block may be branched to only by the unwind edge of an invoke.
1939   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
1940     const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
1941     Assert1(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
1942             "Block containing LandingPadInst must be jumped to "
1943             "only by the unwind edge of an invoke.", &LPI);
1944   }
1945
1946   // The landingpad instruction must be the first non-PHI instruction in the
1947   // block.
1948   Assert1(LPI.getParent()->getLandingPadInst() == &LPI,
1949           "LandingPadInst not the first non-PHI instruction in the block.",
1950           &LPI);
1951
1952   // The personality functions for all landingpad instructions within the same
1953   // function should match.
1954   if (PersonalityFn)
1955     Assert1(LPI.getPersonalityFn() == PersonalityFn,
1956             "Personality function doesn't match others in function", &LPI);
1957   PersonalityFn = LPI.getPersonalityFn();
1958
1959   // All operands must be constants.
1960   Assert1(isa<Constant>(PersonalityFn), "Personality function is not constant!",
1961           &LPI);
1962   for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
1963     Value *Clause = LPI.getClause(i);
1964     Assert1(isa<Constant>(Clause), "Clause is not constant!", &LPI);
1965     if (LPI.isCatch(i)) {
1966       Assert1(isa<PointerType>(Clause->getType()),
1967               "Catch operand does not have pointer type!", &LPI);
1968     } else {
1969       Assert1(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
1970       Assert1(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
1971               "Filter operand is not an array of constants!", &LPI);
1972     }
1973   }
1974
1975   visitInstruction(LPI);
1976 }
1977
1978 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
1979   Instruction *Op = cast<Instruction>(I.getOperand(i));
1980   // If the we have an invalid invoke, don't try to compute the dominance.
1981   // We already reject it in the invoke specific checks and the dominance
1982   // computation doesn't handle multiple edges.
1983   if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1984     if (II->getNormalDest() == II->getUnwindDest())
1985       return;
1986   }
1987
1988   const Use &U = I.getOperandUse(i);
1989   Assert2(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
1990           "Instruction does not dominate all uses!", Op, &I);
1991 }
1992
1993 /// verifyInstruction - Verify that an instruction is well formed.
1994 ///
1995 void Verifier::visitInstruction(Instruction &I) {
1996   BasicBlock *BB = I.getParent();
1997   Assert1(BB, "Instruction not embedded in basic block!", &I);
1998
1999   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
2000     for (User *U : I.users()) {
2001       Assert1(U != (User*)&I || !DT.isReachableFromEntry(BB),
2002               "Only PHI nodes may reference their own value!", &I);
2003     }
2004   }
2005
2006   // Check that void typed values don't have names
2007   Assert1(!I.getType()->isVoidTy() || !I.hasName(),
2008           "Instruction has a name, but provides a void value!", &I);
2009
2010   // Check that the return value of the instruction is either void or a legal
2011   // value type.
2012   Assert1(I.getType()->isVoidTy() ||
2013           I.getType()->isFirstClassType(),
2014           "Instruction returns a non-scalar type!", &I);
2015
2016   // Check that the instruction doesn't produce metadata. Calls are already
2017   // checked against the callee type.
2018   Assert1(!I.getType()->isMetadataTy() ||
2019           isa<CallInst>(I) || isa<InvokeInst>(I),
2020           "Invalid use of metadata!", &I);
2021
2022   // Check that all uses of the instruction, if they are instructions
2023   // themselves, actually have parent basic blocks.  If the use is not an
2024   // instruction, it is an error!
2025   for (Use &U : I.uses()) {
2026     if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2027       Assert2(Used->getParent() != nullptr, "Instruction referencing"
2028               " instruction not embedded in a basic block!", &I, Used);
2029     else {
2030       CheckFailed("Use of instruction is not an instruction!", U);
2031       return;
2032     }
2033   }
2034
2035   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2036     Assert1(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2037
2038     // Check to make sure that only first-class-values are operands to
2039     // instructions.
2040     if (!I.getOperand(i)->getType()->isFirstClassType()) {
2041       Assert1(0, "Instruction operands must be first-class values!", &I);
2042     }
2043
2044     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2045       // Check to make sure that the "address of" an intrinsic function is never
2046       // taken.
2047       Assert1(!F->isIntrinsic() || i == (isa<CallInst>(I) ? e-1 : 0),
2048               "Cannot take the address of an intrinsic!", &I);
2049       Assert1(!F->isIntrinsic() || isa<CallInst>(I) ||
2050               F->getIntrinsicID() == Intrinsic::donothing,
2051               "Cannot invoke an intrinsinc other than donothing", &I);
2052       Assert1(F->getParent() == M, "Referencing function in another module!",
2053               &I);
2054     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2055       Assert1(OpBB->getParent() == BB->getParent(),
2056               "Referring to a basic block in another function!", &I);
2057     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2058       Assert1(OpArg->getParent() == BB->getParent(),
2059               "Referring to an argument in another function!", &I);
2060     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2061       Assert1(GV->getParent() == M, "Referencing global in another module!",
2062               &I);
2063     } else if (isa<Instruction>(I.getOperand(i))) {
2064       verifyDominatesUse(I, i);
2065     } else if (isa<InlineAsm>(I.getOperand(i))) {
2066       Assert1((i + 1 == e && isa<CallInst>(I)) ||
2067               (i + 3 == e && isa<InvokeInst>(I)),
2068               "Cannot take the address of an inline asm!", &I);
2069     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2070       if (CE->getType()->isPtrOrPtrVectorTy()) {
2071         // If we have a ConstantExpr pointer, we need to see if it came from an
2072         // illegal bitcast (inttoptr <constant int> )
2073         SmallVector<const ConstantExpr *, 4> Stack;
2074         SmallPtrSet<const ConstantExpr *, 4> Visited;
2075         Stack.push_back(CE);
2076
2077         while (!Stack.empty()) {
2078           const ConstantExpr *V = Stack.pop_back_val();
2079           if (!Visited.insert(V))
2080             continue;
2081
2082           VerifyConstantExprBitcastType(V);
2083
2084           for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2085             if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2086               Stack.push_back(Op);
2087           }
2088         }
2089       }
2090     }
2091   }
2092
2093   if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2094     Assert1(I.getType()->isFPOrFPVectorTy(),
2095             "fpmath requires a floating point result!", &I);
2096     Assert1(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2097     Value *Op0 = MD->getOperand(0);
2098     if (ConstantFP *CFP0 = dyn_cast_or_null<ConstantFP>(Op0)) {
2099       APFloat Accuracy = CFP0->getValueAPF();
2100       Assert1(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2101               "fpmath accuracy not a positive number!", &I);
2102     } else {
2103       Assert1(false, "invalid fpmath accuracy!", &I);
2104     }
2105   }
2106
2107   MDNode *MD = I.getMetadata(LLVMContext::MD_range);
2108   Assert1(!MD || isa<LoadInst>(I), "Ranges are only for loads!", &I);
2109
2110   InstsInThisBlock.insert(&I);
2111 }
2112
2113 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2114 /// intrinsic argument or return value) matches the type constraints specified
2115 /// by the .td file (e.g. an "any integer" argument really is an integer).
2116 ///
2117 /// This return true on error but does not print a message.
2118 bool Verifier::VerifyIntrinsicType(Type *Ty,
2119                                    ArrayRef<Intrinsic::IITDescriptor> &Infos,
2120                                    SmallVectorImpl<Type*> &ArgTys) {
2121   using namespace Intrinsic;
2122
2123   // If we ran out of descriptors, there are too many arguments.
2124   if (Infos.empty()) return true;
2125   IITDescriptor D = Infos.front();
2126   Infos = Infos.slice(1);
2127
2128   switch (D.Kind) {
2129   case IITDescriptor::Void: return !Ty->isVoidTy();
2130   case IITDescriptor::VarArg: return true;
2131   case IITDescriptor::MMX:  return !Ty->isX86_MMXTy();
2132   case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2133   case IITDescriptor::Half: return !Ty->isHalfTy();
2134   case IITDescriptor::Float: return !Ty->isFloatTy();
2135   case IITDescriptor::Double: return !Ty->isDoubleTy();
2136   case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2137   case IITDescriptor::Vector: {
2138     VectorType *VT = dyn_cast<VectorType>(Ty);
2139     return !VT || VT->getNumElements() != D.Vector_Width ||
2140            VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2141   }
2142   case IITDescriptor::Pointer: {
2143     PointerType *PT = dyn_cast<PointerType>(Ty);
2144     return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2145            VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2146   }
2147
2148   case IITDescriptor::Struct: {
2149     StructType *ST = dyn_cast<StructType>(Ty);
2150     if (!ST || ST->getNumElements() != D.Struct_NumElements)
2151       return true;
2152
2153     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2154       if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2155         return true;
2156     return false;
2157   }
2158
2159   case IITDescriptor::Argument:
2160     // Two cases here - If this is the second occurrence of an argument, verify
2161     // that the later instance matches the previous instance.
2162     if (D.getArgumentNumber() < ArgTys.size())
2163       return Ty != ArgTys[D.getArgumentNumber()];
2164
2165     // Otherwise, if this is the first instance of an argument, record it and
2166     // verify the "Any" kind.
2167     assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2168     ArgTys.push_back(Ty);
2169
2170     switch (D.getArgumentKind()) {
2171     case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2172     case IITDescriptor::AK_AnyFloat:   return !Ty->isFPOrFPVectorTy();
2173     case IITDescriptor::AK_AnyVector:  return !isa<VectorType>(Ty);
2174     case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2175     }
2176     llvm_unreachable("all argument kinds not covered");
2177
2178   case IITDescriptor::ExtendArgument: {
2179     // This may only be used when referring to a previous vector argument.
2180     if (D.getArgumentNumber() >= ArgTys.size())
2181       return true;
2182
2183     Type *NewTy = ArgTys[D.getArgumentNumber()];
2184     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2185       NewTy = VectorType::getExtendedElementVectorType(VTy);
2186     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2187       NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2188     else
2189       return true;
2190
2191     return Ty != NewTy;
2192   }
2193   case IITDescriptor::TruncArgument: {
2194     // This may only be used when referring to a previous vector argument.
2195     if (D.getArgumentNumber() >= ArgTys.size())
2196       return true;
2197
2198     Type *NewTy = ArgTys[D.getArgumentNumber()];
2199     if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2200       NewTy = VectorType::getTruncatedElementVectorType(VTy);
2201     else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2202       NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2203     else
2204       return true;
2205
2206     return Ty != NewTy;
2207   }
2208   case IITDescriptor::HalfVecArgument:
2209     // This may only be used when referring to a previous vector argument.
2210     return D.getArgumentNumber() >= ArgTys.size() ||
2211            !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2212            VectorType::getHalfElementsVectorType(
2213                          cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2214   }
2215   llvm_unreachable("unhandled");
2216 }
2217
2218 /// \brief Verify if the intrinsic has variable arguments.
2219 /// This method is intended to be called after all the fixed arguments have been
2220 /// verified first.
2221 ///
2222 /// This method returns true on error and does not print an error message.
2223 bool
2224 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2225                                   ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2226   using namespace Intrinsic;
2227
2228   // If there are no descriptors left, then it can't be a vararg.
2229   if (Infos.empty())
2230     return isVarArg ? true : false;
2231
2232   // There should be only one descriptor remaining at this point.
2233   if (Infos.size() != 1)
2234     return true;
2235
2236   // Check and verify the descriptor.
2237   IITDescriptor D = Infos.front();
2238   Infos = Infos.slice(1);
2239   if (D.Kind == IITDescriptor::VarArg)
2240     return isVarArg ? false : true;
2241
2242   return true;
2243 }
2244
2245 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2246 ///
2247 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2248   Function *IF = CI.getCalledFunction();
2249   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2250           IF);
2251
2252   // Verify that the intrinsic prototype lines up with what the .td files
2253   // describe.
2254   FunctionType *IFTy = IF->getFunctionType();
2255   bool IsVarArg = IFTy->isVarArg();
2256
2257   SmallVector<Intrinsic::IITDescriptor, 8> Table;
2258   getIntrinsicInfoTableEntries(ID, Table);
2259   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2260
2261   SmallVector<Type *, 4> ArgTys;
2262   Assert1(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2263           "Intrinsic has incorrect return type!", IF);
2264   for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2265     Assert1(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2266             "Intrinsic has incorrect argument type!", IF);
2267
2268   // Verify if the intrinsic call matches the vararg property.
2269   if (IsVarArg)
2270     Assert1(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2271             "Intrinsic was not defined with variable arguments!", IF);
2272   else
2273     Assert1(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2274             "Callsite was not defined with variable arguments!", IF);
2275
2276   // All descriptors should be absorbed by now.
2277   Assert1(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2278
2279   // Now that we have the intrinsic ID and the actual argument types (and we
2280   // know they are legal for the intrinsic!) get the intrinsic name through the
2281   // usual means.  This allows us to verify the mangling of argument types into
2282   // the name.
2283   const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2284   Assert1(ExpectedName == IF->getName(),
2285           "Intrinsic name not mangled correctly for type arguments! "
2286           "Should be: " + ExpectedName, IF);
2287
2288   // If the intrinsic takes MDNode arguments, verify that they are either global
2289   // or are local to *this* function.
2290   for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2291     if (MDNode *MD = dyn_cast<MDNode>(CI.getArgOperand(i)))
2292       visitMDNode(*MD, CI.getParent()->getParent());
2293
2294   switch (ID) {
2295   default:
2296     break;
2297   case Intrinsic::ctlz:  // llvm.ctlz
2298   case Intrinsic::cttz:  // llvm.cttz
2299     Assert1(isa<ConstantInt>(CI.getArgOperand(1)),
2300             "is_zero_undef argument of bit counting intrinsics must be a "
2301             "constant int", &CI);
2302     break;
2303   case Intrinsic::dbg_declare: {  // llvm.dbg.declare
2304     Assert1(CI.getArgOperand(0) && isa<MDNode>(CI.getArgOperand(0)),
2305                 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2306     MDNode *MD = cast<MDNode>(CI.getArgOperand(0));
2307     Assert1(MD->getNumOperands() == 1,
2308                 "invalid llvm.dbg.declare intrinsic call 2", &CI);
2309   } break;
2310   case Intrinsic::memcpy:
2311   case Intrinsic::memmove:
2312   case Intrinsic::memset:
2313     Assert1(isa<ConstantInt>(CI.getArgOperand(3)),
2314             "alignment argument of memory intrinsics must be a constant int",
2315             &CI);
2316     Assert1(isa<ConstantInt>(CI.getArgOperand(4)),
2317             "isvolatile argument of memory intrinsics must be a constant int",
2318             &CI);
2319     break;
2320   case Intrinsic::gcroot:
2321   case Intrinsic::gcwrite:
2322   case Intrinsic::gcread:
2323     if (ID == Intrinsic::gcroot) {
2324       AllocaInst *AI =
2325         dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2326       Assert1(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
2327       Assert1(isa<Constant>(CI.getArgOperand(1)),
2328               "llvm.gcroot parameter #2 must be a constant.", &CI);
2329       if (!AI->getType()->getElementType()->isPointerTy()) {
2330         Assert1(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
2331                 "llvm.gcroot parameter #1 must either be a pointer alloca, "
2332                 "or argument #2 must be a non-null constant.", &CI);
2333       }
2334     }
2335
2336     Assert1(CI.getParent()->getParent()->hasGC(),
2337             "Enclosing function does not use GC.", &CI);
2338     break;
2339   case Intrinsic::init_trampoline:
2340     Assert1(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
2341             "llvm.init_trampoline parameter #2 must resolve to a function.",
2342             &CI);
2343     break;
2344   case Intrinsic::prefetch:
2345     Assert1(isa<ConstantInt>(CI.getArgOperand(1)) &&
2346             isa<ConstantInt>(CI.getArgOperand(2)) &&
2347             cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
2348             cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
2349             "invalid arguments to llvm.prefetch",
2350             &CI);
2351     break;
2352   case Intrinsic::stackprotector:
2353     Assert1(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
2354             "llvm.stackprotector parameter #2 must resolve to an alloca.",
2355             &CI);
2356     break;
2357   case Intrinsic::lifetime_start:
2358   case Intrinsic::lifetime_end:
2359   case Intrinsic::invariant_start:
2360     Assert1(isa<ConstantInt>(CI.getArgOperand(0)),
2361             "size argument of memory use markers must be a constant integer",
2362             &CI);
2363     break;
2364   case Intrinsic::invariant_end:
2365     Assert1(isa<ConstantInt>(CI.getArgOperand(1)),
2366             "llvm.invariant.end parameter #2 must be a constant integer", &CI);
2367     break;
2368   }
2369 }
2370
2371 void DebugInfoVerifier::verifyDebugInfo() {
2372   if (!VerifyDebugInfo)
2373     return;
2374
2375   DebugInfoFinder Finder;
2376   Finder.processModule(*M);
2377   processInstructions(Finder);
2378
2379   // Verify Debug Info.
2380   for (DICompileUnit CU : Finder.compile_units())
2381     Assert1(CU.Verify(), "DICompileUnit does not Verify!", CU);
2382   for (DISubprogram S : Finder.subprograms())
2383     Assert1(S.Verify(), "DISubprogram does not Verify!", S);
2384   for (DIGlobalVariable GV : Finder.global_variables())
2385     Assert1(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
2386   for (DIType T : Finder.types())
2387     Assert1(T.Verify(), "DIType does not Verify!", T);
2388   for (DIScope S : Finder.scopes())
2389     Assert1(S.Verify(), "DIScope does not Verify!", S);
2390 }
2391
2392 void DebugInfoVerifier::processInstructions(DebugInfoFinder &Finder) {
2393   for (const Function &F : *M)
2394     for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
2395       if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
2396         Finder.processLocation(*M, DILocation(MD));
2397       if (const CallInst *CI = dyn_cast<CallInst>(&*I))
2398         processCallInst(Finder, *CI);
2399     }
2400 }
2401
2402 void DebugInfoVerifier::processCallInst(DebugInfoFinder &Finder,
2403                                         const CallInst &CI) {
2404   if (Function *F = CI.getCalledFunction())
2405     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2406       switch (ID) {
2407       case Intrinsic::dbg_declare:
2408         Finder.processDeclare(*M, cast<DbgDeclareInst>(&CI));
2409         break;
2410       case Intrinsic::dbg_value:
2411         Finder.processValue(*M, cast<DbgValueInst>(&CI));
2412         break;
2413       default:
2414         break;
2415       }
2416 }
2417
2418 //===----------------------------------------------------------------------===//
2419 //  Implement the public interfaces to this file...
2420 //===----------------------------------------------------------------------===//
2421
2422 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
2423   Function &F = const_cast<Function &>(f);
2424   assert(!F.isDeclaration() && "Cannot verify external functions");
2425
2426   raw_null_ostream NullStr;
2427   Verifier V(OS ? *OS : NullStr);
2428
2429   // Note that this function's return value is inverted from what you would
2430   // expect of a function called "verify".
2431   return !V.verify(F);
2432 }
2433
2434 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
2435   raw_null_ostream NullStr;
2436   Verifier V(OS ? *OS : NullStr);
2437
2438   bool Broken = false;
2439   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
2440     if (!I->isDeclaration())
2441       Broken |= !V.verify(*I);
2442
2443   // Note that this function's return value is inverted from what you would
2444   // expect of a function called "verify".
2445   DebugInfoVerifier DIV(OS ? *OS : NullStr);
2446   return !V.verify(M) || !DIV.verify(M) || Broken;
2447 }
2448
2449 namespace {
2450 struct VerifierLegacyPass : public FunctionPass {
2451   static char ID;
2452
2453   Verifier V;
2454   bool FatalErrors;
2455
2456   VerifierLegacyPass() : FunctionPass(ID), FatalErrors(true) {
2457     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2458   }
2459   explicit VerifierLegacyPass(bool FatalErrors)
2460       : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
2461     initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2462   }
2463
2464   bool runOnFunction(Function &F) override {
2465     if (!V.verify(F) && FatalErrors)
2466       report_fatal_error("Broken function found, compilation aborted!");
2467
2468     return false;
2469   }
2470
2471   bool doFinalization(Module &M) override {
2472     if (!V.verify(M) && FatalErrors)
2473       report_fatal_error("Broken module found, compilation aborted!");
2474
2475     return false;
2476   }
2477
2478   void getAnalysisUsage(AnalysisUsage &AU) const override {
2479     AU.setPreservesAll();
2480   }
2481 };
2482 struct DebugInfoVerifierLegacyPass : public ModulePass {
2483   static char ID;
2484
2485   DebugInfoVerifier V;
2486   bool FatalErrors;
2487
2488   DebugInfoVerifierLegacyPass() : ModulePass(ID), FatalErrors(true) {
2489     initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2490   }
2491   explicit DebugInfoVerifierLegacyPass(bool FatalErrors)
2492       : ModulePass(ID), V(dbgs()), FatalErrors(FatalErrors) {
2493     initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
2494   }
2495
2496   bool runOnModule(Module &M) override {
2497     if (!V.verify(M) && FatalErrors)
2498       report_fatal_error("Broken debug info found, compilation aborted!");
2499
2500     return false;
2501   }
2502
2503   void getAnalysisUsage(AnalysisUsage &AU) const override {
2504     AU.setPreservesAll();
2505   }
2506 };
2507 }
2508
2509 char VerifierLegacyPass::ID = 0;
2510 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
2511
2512 char DebugInfoVerifierLegacyPass::ID = 0;
2513 INITIALIZE_PASS(DebugInfoVerifierLegacyPass, "verify-di", "Debug Info Verifier",
2514                 false, false)
2515
2516 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
2517   return new VerifierLegacyPass(FatalErrors);
2518 }
2519
2520 ModulePass *llvm::createDebugInfoVerifierPass(bool FatalErrors) {
2521   return new DebugInfoVerifierLegacyPass(FatalErrors);
2522 }
2523
2524 PreservedAnalyses VerifierPass::run(Module *M) {
2525   if (verifyModule(*M, &dbgs()) && FatalErrors)
2526     report_fatal_error("Broken module found, compilation aborted!");
2527
2528   return PreservedAnalyses::all();
2529 }
2530
2531 PreservedAnalyses VerifierPass::run(Function *F) {
2532   if (verifyFunction(*F, &dbgs()) && FatalErrors)
2533     report_fatal_error("Broken function found, compilation aborted!");
2534
2535   return PreservedAnalyses::all();
2536 }