lib/VMCore/Verifier.cpp

   1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
   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 //  * All other things that are tested by asserts spread about the code...
  39 //
  40 //===----------------------------------------------------------------------===//
  41
  42 #include "llvm/Analysis/Verifier.h"
  43 #include "llvm/CallingConv.h"
  44 #include "llvm/Constants.h"
  45 #include "llvm/DerivedTypes.h"
  46 #include "llvm/InlineAsm.h"
  47 #include "llvm/IntrinsicInst.h"
  48 #include "llvm/Metadata.h"
  49 #include "llvm/Module.h"
  50 #include "llvm/Pass.h"
  51 #include "llvm/PassManager.h"
  52 #include "llvm/TypeSymbolTable.h"
  53 #include "llvm/Analysis/Dominators.h"
  54 #include "llvm/Assembly/Writer.h"
  55 #include "llvm/CodeGen/ValueTypes.h"
  56 #include "llvm/Support/CallSite.h"
  57 #include "llvm/Support/CFG.h"
  58 #include "llvm/Support/Debug.h"
  59 #include "llvm/Support/InstVisitor.h"
  60 #include "llvm/ADT/SetVector.h"
  61 #include "llvm/ADT/SmallPtrSet.h"
  62 #include "llvm/ADT/SmallVector.h"
  63 #include "llvm/ADT/StringExtras.h"
  64 #include "llvm/ADT/STLExtras.h"
  65 #include "llvm/Support/ErrorHandling.h"
  66 #include "llvm/Support/raw_ostream.h"
  67 #include <algorithm>
  68 #include <cstdarg>
  69 using namespace llvm;
  70
  71 namespace {  // Anonymous namespace for class
  72   struct PreVerifier : public FunctionPass {
  73     static char ID; // Pass ID, replacement for typeid
  74
  75     PreVerifier() : FunctionPass(&ID) { }
  76
  77     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  78       AU.setPreservesAll();
  79     }
  80
  81     // Check that the prerequisites for successful DominatorTree construction
  82     // are satisfied.
  83     bool runOnFunction(Function &F) {
  84       bool Broken = false;
  85
  86       for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
  87         if (I->empty() || !I->back().isTerminator()) {
  88           dbgs() << "Basic Block in function '" << F.getName()
  89                  << "' does not have terminator!\n";
  90           WriteAsOperand(dbgs(), I, true);
  91           dbgs() << "\n";
  92           Broken = true;
  93         }
  94       }
  95
  96       if (Broken)
  97         report_fatal_error("Broken module, no Basic Block terminator!");
  98
  99       return false;
 100     }
 101   };
 102 }
 103
 104 char PreVerifier::ID = 0;
 105 static RegisterPass<PreVerifier>
 106 PreVer("preverify", "Preliminary module verification");
 107 static const PassInfo *const PreVerifyID = &PreVer;
 108
 109 namespace {
 110   class TypeSet : public AbstractTypeUser {
 111   public:
 112     TypeSet() {}
 113
 114     /// Insert a type into the set of types.
 115     bool insert(const Type *Ty) {
 116       if (!Types.insert(Ty))
 117         return false;
 118       if (Ty->isAbstract())
 119         Ty->addAbstractTypeUser(this);
 120       return true;
 121     }
 122
 123     // Remove ourselves as abstract type listeners for any types that remain
 124     // abstract when the TypeSet is destroyed.
 125     ~TypeSet() {
 126       for (SmallSetVector<const Type *, 16>::iterator I = Types.begin(),
 127              E = Types.end(); I != E; ++I) {
 128         const Type *Ty = *I;
 129         if (Ty->isAbstract())
 130           Ty->removeAbstractTypeUser(this);
 131       }
 132     }
 133
 134     // Abstract type user interface.
 135
 136     /// Remove types from the set when refined. Do not insert the type it was
 137     /// refined to because that type hasn't been verified yet.
 138     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 139       Types.remove(OldTy);
 140       OldTy->removeAbstractTypeUser(this);
 141     }
 142
 143     /// Stop listening for changes to a type which is no longer abstract.
 144     void typeBecameConcrete(const DerivedType *AbsTy) {
 145       AbsTy->removeAbstractTypeUser(this);
 146     }
 147
 148     void dump() const {}
 149
 150   private:
 151     SmallSetVector<const Type *, 16> Types;
 152
 153     // Disallow copying.
 154     TypeSet(const TypeSet &);
 155     TypeSet &operator=(const TypeSet &);
 156   };
 157
 158   struct Verifier : public FunctionPass, public InstVisitor<Verifier> {
 159     static char ID; // Pass ID, replacement for typeid
 160     bool Broken;          // Is this module found to be broken?
 161     bool RealPass;        // Are we not being run by a PassManager?
 162     VerifierFailureAction action;
 163                           // What to do if verification fails.
 164     Module *Mod;          // Module we are verifying right now
 165     LLVMContext *Context; // Context within which we are verifying
 166     DominatorTree *DT;    // Dominator Tree, caution can be null!
 167
 168     std::string Messages;
 169     raw_string_ostream MessagesStr;
 170
 171     /// InstInThisBlock - when verifying a basic block, keep track of all of the
 172     /// instructions we have seen so far.  This allows us to do efficient
 173     /// dominance checks for the case when an instruction has an operand that is
 174     /// an instruction in the same block.
 175     SmallPtrSet<Instruction*, 16> InstsInThisBlock;
 176
 177     /// Types - keep track of the types that have been checked already.
 178     TypeSet Types;
 179
 180     /// MDNodes - keep track of the metadata nodes that have been checked
 181     /// already.
 182     SmallPtrSet<MDNode *, 32> MDNodes;
 183
 184     Verifier()
 185       : FunctionPass(&ID),
 186       Broken(false), RealPass(true), action(AbortProcessAction),
 187       Mod(0), Context(0), DT(0), MessagesStr(Messages) {}
 188     explicit Verifier(VerifierFailureAction ctn)
 189       : FunctionPass(&ID),
 190       Broken(false), RealPass(true), action(ctn), Mod(0), Context(0), DT(0),
 191       MessagesStr(Messages) {}
 192     explicit Verifier(bool AB)
 193       : FunctionPass(&ID),
 194       Broken(false), RealPass(true),
 195       action( AB ? AbortProcessAction : PrintMessageAction), Mod(0),
 196       Context(0), DT(0), MessagesStr(Messages) {}
 197     explicit Verifier(DominatorTree &dt)
 198       : FunctionPass(&ID),
 199       Broken(false), RealPass(false), action(PrintMessageAction), Mod(0),
 200       Context(0), DT(&dt), MessagesStr(Messages) {}
 201
 202
 203     bool doInitialization(Module &M) {
 204       Mod = &M;
 205       Context = &M.getContext();
 206       verifyTypeSymbolTable(M.getTypeSymbolTable());
 207
 208       // If this is a real pass, in a pass manager, we must abort before
 209       // returning back to the pass manager, or else the pass manager may try to
 210       // run other passes on the broken module.
 211       if (RealPass)
 212         return abortIfBroken();
 213       return false;
 214     }
 215
 216     bool runOnFunction(Function &F) {
 217       // Get dominator information if we are being run by PassManager
 218       if (RealPass) DT = &getAnalysis<DominatorTree>();
 219
 220       Mod = F.getParent();
 221       if (!Context) Context = &F.getContext();
 222
 223       visit(F);
 224       InstsInThisBlock.clear();
 225
 226       // If this is a real pass, in a pass manager, we must abort before
 227       // returning back to the pass manager, or else the pass manager may try to
 228       // run other passes on the broken module.
 229       if (RealPass)
 230         return abortIfBroken();
 231
 232       return false;
 233     }
 234
 235     bool doFinalization(Module &M) {
 236       // Scan through, checking all of the external function's linkage now...
 237       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 238         visitGlobalValue(*I);
 239
 240         // Check to make sure function prototypes are okay.
 241         if (I->isDeclaration()) visitFunction(*I);
 242       }
 243
 244       for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 245            I != E; ++I)
 246         visitGlobalVariable(*I);
 247
 248       for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
 249            I != E; ++I)
 250         visitGlobalAlias(*I);
 251
 252       for (Module::named_metadata_iterator I = M.named_metadata_begin(),
 253            E = M.named_metadata_end(); I != E; ++I)
 254         visitNamedMDNode(*I);
 255
 256       // If the module is broken, abort at this time.
 257       return abortIfBroken();
 258     }
 259
 260     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 261       AU.setPreservesAll();
 262       AU.addRequiredID(PreVerifyID);
 263       if (RealPass)
 264         AU.addRequired<DominatorTree>();
 265     }
 266
 267     /// abortIfBroken - If the module is broken and we are supposed to abort on
 268     /// this condition, do so.
 269     ///
 270     bool abortIfBroken() {
 271       if (!Broken) return false;
 272       MessagesStr << "Broken module found, ";
 273       switch (action) {
 274       default: llvm_unreachable("Unknown action");
 275       case AbortProcessAction:
 276         MessagesStr << "compilation aborted!\n";
 277         dbgs() << MessagesStr.str();
 278         // Client should choose different reaction if abort is not desired
 279         abort();
 280       case PrintMessageAction:
 281         MessagesStr << "verification continues.\n";
 282         dbgs() << MessagesStr.str();
 283         return false;
 284       case ReturnStatusAction:
 285         MessagesStr << "compilation terminated.\n";
 286         return true;
 287       }
 288     }
 289
 290
 291     // Verification methods...
 292     void verifyTypeSymbolTable(TypeSymbolTable &ST);
 293     void visitGlobalValue(GlobalValue &GV);
 294     void visitGlobalVariable(GlobalVariable &GV);
 295     void visitGlobalAlias(GlobalAlias &GA);
 296     void visitNamedMDNode(NamedMDNode &NMD);
 297     void visitMDNode(MDNode &MD, Function *F);
 298     void visitFunction(Function &F);
 299     void visitBasicBlock(BasicBlock &BB);
 300     using InstVisitor<Verifier>::visit;
 301
 302     void visit(Instruction &I);
 303
 304     void visitTruncInst(TruncInst &I);
 305     void visitZExtInst(ZExtInst &I);
 306     void visitSExtInst(SExtInst &I);
 307     void visitFPTruncInst(FPTruncInst &I);
 308     void visitFPExtInst(FPExtInst &I);
 309     void visitFPToUIInst(FPToUIInst &I);
 310     void visitFPToSIInst(FPToSIInst &I);
 311     void visitUIToFPInst(UIToFPInst &I);
 312     void visitSIToFPInst(SIToFPInst &I);
 313     void visitIntToPtrInst(IntToPtrInst &I);
 314     void visitPtrToIntInst(PtrToIntInst &I);
 315     void visitBitCastInst(BitCastInst &I);
 316     void visitPHINode(PHINode &PN);
 317     void visitBinaryOperator(BinaryOperator &B);
 318     void visitICmpInst(ICmpInst &IC);
 319     void visitFCmpInst(FCmpInst &FC);
 320     void visitExtractElementInst(ExtractElementInst &EI);
 321     void visitInsertElementInst(InsertElementInst &EI);
 322     void visitShuffleVectorInst(ShuffleVectorInst &EI);
 323     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 324     void visitCallInst(CallInst &CI);
 325     void visitInvokeInst(InvokeInst &II);
 326     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 327     void visitLoadInst(LoadInst &LI);
 328     void visitStoreInst(StoreInst &SI);
 329     void visitInstruction(Instruction &I);
 330     void visitTerminatorInst(TerminatorInst &I);
 331     void visitBranchInst(BranchInst &BI);
 332     void visitReturnInst(ReturnInst &RI);
 333     void visitSwitchInst(SwitchInst &SI);
 334     void visitSelectInst(SelectInst &SI);
 335     void visitUserOp1(Instruction &I);
 336     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 337     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 338     void visitAllocaInst(AllocaInst &AI);
 339     void visitExtractValueInst(ExtractValueInst &EVI);
 340     void visitInsertValueInst(InsertValueInst &IVI);
 341
 342     void VerifyCallSite(CallSite CS);
 343     bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
 344                           int VT, unsigned ArgNo, std::string &Suffix);
 345     void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
 346                                   unsigned RetNum, unsigned ParamNum, ...);
 347     void VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
 348                               bool isReturnValue, const Value *V);
 349     void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
 350                              const Value *V);
 351     void VerifyType(const Type *Ty);
 352
 353     void WriteValue(const Value *V) {
 354       if (!V) return;
 355       if (isa<Instruction>(V)) {
 356         MessagesStr << *V << '\n';
 357       } else {
 358         WriteAsOperand(MessagesStr, V, true, Mod);
 359         MessagesStr << '\n';
 360       }
 361     }
 362
 363     void WriteType(const Type *T) {
 364       if (!T) return;
 365       MessagesStr << ' ';
 366       WriteTypeSymbolic(MessagesStr, T, Mod);
 367     }
 368
 369
 370     // CheckFailed - A check failed, so print out the condition and the message
 371     // that failed.  This provides a nice place to put a breakpoint if you want
 372     // to see why something is not correct.
 373     void CheckFailed(const Twine &Message,
 374                      const Value *V1 = 0, const Value *V2 = 0,
 375                      const Value *V3 = 0, const Value *V4 = 0) {
 376       MessagesStr << Message.str() << "\n";
 377       WriteValue(V1);
 378       WriteValue(V2);
 379       WriteValue(V3);
 380       WriteValue(V4);
 381       Broken = true;
 382     }
 383
 384     void CheckFailed(const Twine &Message, const Value *V1,
 385                      const Type *T2, const Value *V3 = 0) {
 386       MessagesStr << Message.str() << "\n";
 387       WriteValue(V1);
 388       WriteType(T2);
 389       WriteValue(V3);
 390       Broken = true;
 391     }
 392
 393     void CheckFailed(const Twine &Message, const Type *T1,
 394                      const Type *T2 = 0, const Type *T3 = 0) {
 395       MessagesStr << Message.str() << "\n";
 396       WriteType(T1);
 397       WriteType(T2);
 398       WriteType(T3);
 399       Broken = true;
 400     }
 401   };
 402 } // End anonymous namespace
 403
 404 char Verifier::ID = 0;
 405 static RegisterPass<Verifier> X("verify", "Module Verifier");
 406
 407 // Assert - We know that cond should be true, if not print an error message.
 408 #define Assert(C, M) \
 409   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 410 #define Assert1(C, M, V1) \
 411   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 412 #define Assert2(C, M, V1, V2) \
 413   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 414 #define Assert3(C, M, V1, V2, V3) \
 415   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 416 #define Assert4(C, M, V1, V2, V3, V4) \
 417   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 418
 419 void Verifier::visit(Instruction &I) {
 420   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
 421     Assert1(I.getOperand(i) != 0, "Operand is null", &I);
 422   InstVisitor<Verifier>::visit(I);
 423 }
 424
 425
 426 void Verifier::visitGlobalValue(GlobalValue &GV) {
 427   Assert1(!GV.isDeclaration() ||
 428           GV.isMaterializable() ||
 429           GV.hasExternalLinkage() ||
 430           GV.hasDLLImportLinkage() ||
 431           GV.hasExternalWeakLinkage() ||
 432           (isa<GlobalAlias>(GV) &&
 433            (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
 434   "Global is external, but doesn't have external or dllimport or weak linkage!",
 435           &GV);
 436
 437   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
 438           "Global is marked as dllimport, but not external", &GV);
 439
 440   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 441           "Only global variables can have appending linkage!", &GV);
 442
 443   if (GV.hasAppendingLinkage()) {
 444     GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
 445     Assert1(GVar && GVar->getType()->getElementType()->isArrayTy(),
 446             "Only global arrays can have appending linkage!", GVar);
 447   }
 448 }
 449
 450 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 451   if (GV.hasInitializer()) {
 452     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 453             "Global variable initializer type does not match global "
 454             "variable type!", &GV);
 455
 456     // If the global has common linkage, it must have a zero initializer and
 457     // cannot be constant.
 458     if (GV.hasCommonLinkage()) {
 459       Assert1(GV.getInitializer()->isNullValue(),
 460               "'common' global must have a zero initializer!", &GV);
 461       Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
 462               &GV);
 463     }
 464   } else {
 465     Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
 466             GV.hasExternalWeakLinkage(),
 467             "invalid linkage type for global declaration", &GV);
 468   }
 469
 470   visitGlobalValue(GV);
 471 }
 472
 473 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
 474   Assert1(!GA.getName().empty(),
 475           "Alias name cannot be empty!", &GA);
 476   Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
 477           GA.hasWeakLinkage(),
 478           "Alias should have external or external weak linkage!", &GA);
 479   Assert1(GA.getAliasee(),
 480           "Aliasee cannot be NULL!", &GA);
 481   Assert1(GA.getType() == GA.getAliasee()->getType(),
 482           "Alias and aliasee types should match!", &GA);
 483
 484   if (!isa<GlobalValue>(GA.getAliasee())) {
 485     const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
 486     Assert1(CE &&
 487             (CE->getOpcode() == Instruction::BitCast ||
 488              CE->getOpcode() == Instruction::GetElementPtr) &&
 489             isa<GlobalValue>(CE->getOperand(0)),
 490             "Aliasee should be either GlobalValue or bitcast of GlobalValue",
 491             &GA);
 492   }
 493
 494   const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
 495   Assert1(Aliasee,
 496           "Aliasing chain should end with function or global variable", &GA);
 497
 498   visitGlobalValue(GA);
 499 }
 500
 501 void Verifier::visitNamedMDNode(NamedMDNode &NMD) {
 502   for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
 503     MDNode *MD = NMD.getOperand(i);
 504     if (!MD)
 505       continue;
 506
 507     Assert2(!MD->isFunctionLocal(),
 508             "Named metadata operand cannot be function local!", &NMD, MD);
 509     visitMDNode(*MD, 0);
 510   }
 511 }
 512
 513 void Verifier::visitMDNode(MDNode &MD, Function *F) {
 514   // Only visit each node once.  Metadata can be mutually recursive, so this
 515   // avoids infinite recursion here, as well as being an optimization.
 516   if (!MDNodes.insert(&MD))
 517     return;
 518
 519   for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
 520     Value *Op = MD.getOperand(i);
 521     if (!Op)
 522       continue;
 523     if (isa<Constant>(Op) || isa<MDString>(Op) || isa<NamedMDNode>(Op))
 524       continue;
 525     if (MDNode *N = dyn_cast<MDNode>(Op)) {
 526       Assert2(MD.isFunctionLocal() || !N->isFunctionLocal(),
 527               "Global metadata operand cannot be function local!", &MD, N);
 528       visitMDNode(*N, F);
 529       continue;
 530     }
 531     Assert2(MD.isFunctionLocal(), "Invalid operand for global metadata!", &MD, Op);
 532
 533     // If this was an instruction, bb, or argument, verify that it is in the
 534     // function that we expect.
 535     Function *ActualF = 0;
 536     if (Instruction *I = dyn_cast<Instruction>(Op))
 537       ActualF = I->getParent()->getParent();
 538     else if (BasicBlock *BB = dyn_cast<BasicBlock>(Op))
 539       ActualF = BB->getParent();
 540     else if (Argument *A = dyn_cast<Argument>(Op))
 541       ActualF = A->getParent();
 542     assert(ActualF && "Unimplemented function local metadata case!");
 543
 544     Assert2(ActualF == F, "function-local metadata used in wrong function",
 545             &MD, Op);
 546   }
 547 }
 548
 549 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 550   for (TypeSymbolTable::iterator I = ST.begin(), E = ST.end(); I != E; ++I)
 551     VerifyType(I->second);
 552 }
 553
 554 // VerifyParameterAttrs - Check the given attributes for an argument or return
 555 // value of the specified type.  The value V is printed in error messages.
 556 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
 557                                     bool isReturnValue, const Value *V) {
 558   if (Attrs == Attribute::None)
 559     return;
 560
 561   Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
 562   Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
 563           " only applies to the function!", V);
 564
 565   if (isReturnValue) {
 566     Attributes RetI = Attrs & Attribute::ParameterOnly;
 567     Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
 568             " does not apply to return values!", V);
 569   }
 570
 571   for (unsigned i = 0;
 572        i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
 573     Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
 574     Assert1(!(MutI & (MutI - 1)), "Attributes " +
 575             Attribute::getAsString(MutI) + " are incompatible!", V);
 576   }
 577
 578   Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
 579   Assert1(!TypeI, "Wrong type for attribute " +
 580           Attribute::getAsString(TypeI), V);
 581
 582   Attributes ByValI = Attrs & Attribute::ByVal;
 583   if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 584     Assert1(!ByValI || PTy->getElementType()->isSized(),
 585             "Attribute " + Attribute::getAsString(ByValI) +
 586             " does not support unsized types!", V);
 587   } else {
 588     Assert1(!ByValI,
 589             "Attribute " + Attribute::getAsString(ByValI) +
 590             " only applies to parameters with pointer type!", V);
 591   }
 592 }
 593
 594 // VerifyFunctionAttrs - Check parameter attributes against a function type.
 595 // The value V is printed in error messages.
 596 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
 597                                    const AttrListPtr &Attrs,
 598                                    const Value *V) {
 599   if (Attrs.isEmpty())
 600     return;
 601
 602   bool SawNest = false;
 603
 604   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
 605     const AttributeWithIndex &Attr = Attrs.getSlot(i);
 606
 607     const Type *Ty;
 608     if (Attr.Index == 0)
 609       Ty = FT->getReturnType();
 610     else if (Attr.Index-1 < FT->getNumParams())
 611       Ty = FT->getParamType(Attr.Index-1);
 612     else
 613       break;  // VarArgs attributes, verified elsewhere.
 614
 615     VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
 616
 617     if (Attr.Attrs & Attribute::Nest) {
 618       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
 619       SawNest = true;
 620     }
 621
 622     if (Attr.Attrs & Attribute::StructRet)
 623       Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
 624   }
 625
 626   Attributes FAttrs = Attrs.getFnAttributes();
 627   Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
 628   Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
 629           " does not apply to the function!", V);
 630
 631   for (unsigned i = 0;
 632        i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
 633     Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
 634     Assert1(!(MutI & (MutI - 1)), "Attributes " +
 635             Attribute::getAsString(MutI) + " are incompatible!", V);
 636   }
 637 }
 638
 639 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
 640   if (Attrs.isEmpty())
 641     return true;
 642
 643   unsigned LastSlot = Attrs.getNumSlots() - 1;
 644   unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
 645   if (LastIndex <= Params
 646       || (LastIndex == (unsigned)~0
 647           && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
 648     return true;
 649
 650   return false;
 651 }
 652
 653 // visitFunction - Verify that a function is ok.
 654 //
 655 void Verifier::visitFunction(Function &F) {
 656   // Check function arguments.
 657   const FunctionType *FT = F.getFunctionType();
 658   unsigned NumArgs = F.arg_size();
 659
 660   Assert1(Context == &F.getContext(),
 661           "Function context does not match Module context!", &F);
 662
 663   Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
 664   Assert2(FT->getNumParams() == NumArgs,
 665           "# formal arguments must match # of arguments for function type!",
 666           &F, FT);
 667   Assert1(F.getReturnType()->isFirstClassType() ||
 668           F.getReturnType()->isVoidTy() ||
 669           F.getReturnType()->isStructTy(),
 670           "Functions cannot return aggregate values!", &F);
 671
 672   Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
 673           "Invalid struct return type!", &F);
 674
 675   const AttrListPtr &Attrs = F.getAttributes();
 676
 677   Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
 678           "Attributes after last parameter!", &F);
 679
 680   // Check function attributes.
 681   VerifyFunctionAttrs(FT, Attrs, &F);
 682
 683   // Check that this function meets the restrictions on this calling convention.
 684   switch (F.getCallingConv()) {
 685   default:
 686     break;
 687   case CallingConv::C:
 688     break;
 689   case CallingConv::Fast:
 690   case CallingConv::Cold:
 691   case CallingConv::X86_FastCall:
 692   case CallingConv::X86_ThisCall:
 693     Assert1(!F.isVarArg(),
 694             "Varargs functions must have C calling conventions!", &F);
 695     break;
 696   }
 697
 698   bool isLLVMdotName = F.getName().size() >= 5 &&
 699                        F.getName().substr(0, 5) == "llvm.";
 700
 701   // Check that the argument values match the function type for this function...
 702   unsigned i = 0;
 703   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 704        I != E; ++I, ++i) {
 705     Assert2(I->getType() == FT->getParamType(i),
 706             "Argument value does not match function argument type!",
 707             I, FT->getParamType(i));
 708     Assert1(I->getType()->isFirstClassType(),
 709             "Function arguments must have first-class types!", I);
 710     if (!isLLVMdotName)
 711       Assert2(!I->getType()->isMetadataTy(),
 712               "Function takes metadata but isn't an intrinsic", I, &F);
 713   }
 714
 715   if (F.isMaterializable()) {
 716     // Function has a body somewhere we can't see.
 717   } else if (F.isDeclaration()) {
 718     Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
 719             F.hasExternalWeakLinkage(),
 720             "invalid linkage type for function declaration", &F);
 721   } else {
 722     // Verify that this function (which has a body) is not named "llvm.*".  It
 723     // is not legal to define intrinsics.
 724     Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
 725
 726     // Check the entry node
 727     BasicBlock *Entry = &F.getEntryBlock();
 728     Assert1(pred_begin(Entry) == pred_end(Entry),
 729             "Entry block to function must not have predecessors!", Entry);
 730
 731     // The address of the entry block cannot be taken, unless it is dead.
 732     if (Entry->hasAddressTaken()) {
 733       Assert1(!BlockAddress::get(Entry)->isConstantUsed(),
 734               "blockaddress may not be used with the entry block!", Entry);
 735     }
 736   }
 737
 738   // If this function is actually an intrinsic, verify that it is only used in
 739   // direct call/invokes, never having its "address taken".
 740   if (F.getIntrinsicID()) {
 741     const User *U;
 742     if (F.hasAddressTaken(&U))
 743       Assert1(0, "Invalid user of intrinsic instruction!", U);
 744   }
 745 }
 746
 747 // verifyBasicBlock - Verify that a basic block is well formed...
 748 //
 749 void Verifier::visitBasicBlock(BasicBlock &BB) {
 750   InstsInThisBlock.clear();
 751
 752   // Ensure that basic blocks have terminators!
 753   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 754
 755   // Check constraints that this basic block imposes on all of the PHI nodes in
 756   // it.
 757   if (isa<PHINode>(BB.front())) {
 758     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
 759     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
 760     std::sort(Preds.begin(), Preds.end());
 761     PHINode *PN;
 762     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 763       // Ensure that PHI nodes have at least one entry!
 764       Assert1(PN->getNumIncomingValues() != 0,
 765               "PHI nodes must have at least one entry.  If the block is dead, "
 766               "the PHI should be removed!", PN);
 767       Assert1(PN->getNumIncomingValues() == Preds.size(),
 768               "PHINode should have one entry for each predecessor of its "
 769               "parent basic block!", PN);
 770
 771       // Get and sort all incoming values in the PHI node...
 772       Values.clear();
 773       Values.reserve(PN->getNumIncomingValues());
 774       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 775         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 776                                         PN->getIncomingValue(i)));
 777       std::sort(Values.begin(), Values.end());
 778
 779       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 780         // Check to make sure that if there is more than one entry for a
 781         // particular basic block in this PHI node, that the incoming values are
 782         // all identical.
 783         //
 784         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 785                 Values[i].second == Values[i-1].second,
 786                 "PHI node has multiple entries for the same basic block with "
 787                 "different incoming values!", PN, Values[i].first,
 788                 Values[i].second, Values[i-1].second);
 789
 790         // Check to make sure that the predecessors and PHI node entries are
 791         // matched up.
 792         Assert3(Values[i].first == Preds[i],
 793                 "PHI node entries do not match predecessors!", PN,
 794                 Values[i].first, Preds[i]);
 795       }
 796     }
 797   }
 798 }
 799
 800 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 801   // Ensure that terminators only exist at the end of the basic block.
 802   Assert1(&I == I.getParent()->getTerminator(),
 803           "Terminator found in the middle of a basic block!", I.getParent());
 804   visitInstruction(I);
 805 }
 806
 807 void Verifier::visitBranchInst(BranchInst &BI) {
 808   if (BI.isConditional()) {
 809     Assert2(BI.getCondition()->getType()->isIntegerTy(1),
 810             "Branch condition is not 'i1' type!", &BI, BI.getCondition());
 811   }
 812   visitTerminatorInst(BI);
 813 }
 814
 815 void Verifier::visitReturnInst(ReturnInst &RI) {
 816   Function *F = RI.getParent()->getParent();
 817   unsigned N = RI.getNumOperands();
 818   if (F->getReturnType()->isVoidTy())
 819     Assert2(N == 0,
 820             "Found return instr that returns non-void in Function of void "
 821             "return type!", &RI, F->getReturnType());
 822   else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
 823     // Exactly one return value and it matches the return type. Good.
 824   } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
 825     // The return type is a struct; check for multiple return values.
 826     Assert2(STy->getNumElements() == N,
 827             "Incorrect number of return values in ret instruction!",
 828             &RI, F->getReturnType());
 829     for (unsigned i = 0; i != N; ++i)
 830       Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
 831               "Function return type does not match operand "
 832               "type of return inst!", &RI, F->getReturnType());
 833   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
 834     // The return type is an array; check for multiple return values.
 835     Assert2(ATy->getNumElements() == N,
 836             "Incorrect number of return values in ret instruction!",
 837             &RI, F->getReturnType());
 838     for (unsigned i = 0; i != N; ++i)
 839       Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
 840               "Function return type does not match operand "
 841               "type of return inst!", &RI, F->getReturnType());
 842   } else {
 843     CheckFailed("Function return type does not match operand "
 844                 "type of return inst!", &RI, F->getReturnType());
 845   }
 846
 847   // Check to make sure that the return value has necessary properties for
 848   // terminators...
 849   visitTerminatorInst(RI);
 850 }
 851
 852 void Verifier::visitSwitchInst(SwitchInst &SI) {
 853   // Check to make sure that all of the constants in the switch instruction
 854   // have the same type as the switched-on value.
 855   const Type *SwitchTy = SI.getCondition()->getType();
 856   SmallPtrSet<ConstantInt*, 32> Constants;
 857   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i) {
 858     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 859             "Switch constants must all be same type as switch value!", &SI);
 860     Assert2(Constants.insert(SI.getCaseValue(i)),
 861             "Duplicate integer as switch case", &SI, SI.getCaseValue(i));
 862   }
 863
 864   visitTerminatorInst(SI);
 865 }
 866
 867 void Verifier::visitSelectInst(SelectInst &SI) {
 868   Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
 869                                           SI.getOperand(2)),
 870           "Invalid operands for select instruction!", &SI);
 871
 872   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 873           "Select values must have same type as select instruction!", &SI);
 874   visitInstruction(SI);
 875 }
 876
 877 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 878 /// a pass, if any exist, it's an error.
 879 ///
 880 void Verifier::visitUserOp1(Instruction &I) {
 881   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 882 }
 883
 884 void Verifier::visitTruncInst(TruncInst &I) {
 885   // Get the source and destination types
 886   const Type *SrcTy = I.getOperand(0)->getType();
 887   const Type *DestTy = I.getType();
 888
 889   // Get the size of the types in bits, we'll need this later
 890   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 891   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 892
 893   Assert1(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
 894   Assert1(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
 895   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 896           "trunc source and destination must both be a vector or neither", &I);
 897   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 898
 899   visitInstruction(I);
 900 }
 901
 902 void Verifier::visitZExtInst(ZExtInst &I) {
 903   // Get the source and destination types
 904   const Type *SrcTy = I.getOperand(0)->getType();
 905   const Type *DestTy = I.getType();
 906
 907   // Get the size of the types in bits, we'll need this later
 908   Assert1(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
 909   Assert1(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
 910   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 911           "zext source and destination must both be a vector or neither", &I);
 912   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 913   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 914
 915   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 916
 917   visitInstruction(I);
 918 }
 919
 920 void Verifier::visitSExtInst(SExtInst &I) {
 921   // Get the source and destination types
 922   const Type *SrcTy = I.getOperand(0)->getType();
 923   const Type *DestTy = I.getType();
 924
 925   // Get the size of the types in bits, we'll need this later
 926   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 927   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 928
 929   Assert1(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
 930   Assert1(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
 931   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 932           "sext source and destination must both be a vector or neither", &I);
 933   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 934
 935   visitInstruction(I);
 936 }
 937
 938 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 939   // Get the source and destination types
 940   const Type *SrcTy = I.getOperand(0)->getType();
 941   const Type *DestTy = I.getType();
 942   // Get the size of the types in bits, we'll need this later
 943   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 944   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 945
 946   Assert1(SrcTy->isFPOrFPVectorTy(),"FPTrunc only operates on FP", &I);
 947   Assert1(DestTy->isFPOrFPVectorTy(),"FPTrunc only produces an FP", &I);
 948   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 949           "fptrunc source and destination must both be a vector or neither",&I);
 950   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 951
 952   visitInstruction(I);
 953 }
 954
 955 void Verifier::visitFPExtInst(FPExtInst &I) {
 956   // Get the source and destination types
 957   const Type *SrcTy = I.getOperand(0)->getType();
 958   const Type *DestTy = I.getType();
 959
 960   // Get the size of the types in bits, we'll need this later
 961   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 962   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 963
 964   Assert1(SrcTy->isFPOrFPVectorTy(),"FPExt only operates on FP", &I);
 965   Assert1(DestTy->isFPOrFPVectorTy(),"FPExt only produces an FP", &I);
 966   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 967           "fpext source and destination must both be a vector or neither", &I);
 968   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 969
 970   visitInstruction(I);
 971 }
 972
 973 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 974   // Get the source and destination types
 975   const Type *SrcTy = I.getOperand(0)->getType();
 976   const Type *DestTy = I.getType();
 977
 978   bool SrcVec = SrcTy->isVectorTy();
 979   bool DstVec = DestTy->isVectorTy();
 980
 981   Assert1(SrcVec == DstVec,
 982           "UIToFP source and dest must both be vector or scalar", &I);
 983   Assert1(SrcTy->isIntOrIntVectorTy(),
 984           "UIToFP source must be integer or integer vector", &I);
 985   Assert1(DestTy->isFPOrFPVectorTy(),
 986           "UIToFP result must be FP or FP vector", &I);
 987
 988   if (SrcVec && DstVec)
 989     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 990             cast<VectorType>(DestTy)->getNumElements(),
 991             "UIToFP source and dest vector length mismatch", &I);
 992
 993   visitInstruction(I);
 994 }
 995
 996 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 997   // Get the source and destination types
 998   const Type *SrcTy = I.getOperand(0)->getType();
 999   const Type *DestTy = I.getType();
1000
1001   bool SrcVec = SrcTy->isVectorTy();
1002   bool DstVec = DestTy->isVectorTy();
1003
1004   Assert1(SrcVec == DstVec,
1005           "SIToFP source and dest must both be vector or scalar", &I);
1006   Assert1(SrcTy->isIntOrIntVectorTy(),
1007           "SIToFP source must be integer or integer vector", &I);
1008   Assert1(DestTy->isFPOrFPVectorTy(),
1009           "SIToFP result must be FP or FP vector", &I);
1010
1011   if (SrcVec && DstVec)
1012     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1013             cast<VectorType>(DestTy)->getNumElements(),
1014             "SIToFP source and dest vector length mismatch", &I);
1015
1016   visitInstruction(I);
1017 }
1018
1019 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1020   // Get the source and destination types
1021   const Type *SrcTy = I.getOperand(0)->getType();
1022   const Type *DestTy = I.getType();
1023
1024   bool SrcVec = SrcTy->isVectorTy();
1025   bool DstVec = DestTy->isVectorTy();
1026
1027   Assert1(SrcVec == DstVec,
1028           "FPToUI source and dest must both be vector or scalar", &I);
1029   Assert1(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1030           &I);
1031   Assert1(DestTy->isIntOrIntVectorTy(),
1032           "FPToUI result must be integer or integer vector", &I);
1033
1034   if (SrcVec && DstVec)
1035     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1036             cast<VectorType>(DestTy)->getNumElements(),
1037             "FPToUI source and dest vector length mismatch", &I);
1038
1039   visitInstruction(I);
1040 }
1041
1042 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1043   // Get the source and destination types
1044   const Type *SrcTy = I.getOperand(0)->getType();
1045   const Type *DestTy = I.getType();
1046
1047   bool SrcVec = SrcTy->isVectorTy();
1048   bool DstVec = DestTy->isVectorTy();
1049
1050   Assert1(SrcVec == DstVec,
1051           "FPToSI source and dest must both be vector or scalar", &I);
1052   Assert1(SrcTy->isFPOrFPVectorTy(),
1053           "FPToSI source must be FP or FP vector", &I);
1054   Assert1(DestTy->isIntOrIntVectorTy(),
1055           "FPToSI result must be integer or integer vector", &I);
1056
1057   if (SrcVec && DstVec)
1058     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1059             cast<VectorType>(DestTy)->getNumElements(),
1060             "FPToSI source and dest vector length mismatch", &I);
1061
1062   visitInstruction(I);
1063 }
1064
1065 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1066   // Get the source and destination types
1067   const Type *SrcTy = I.getOperand(0)->getType();
1068   const Type *DestTy = I.getType();
1069
1070   Assert1(SrcTy->isPointerTy(), "PtrToInt source must be pointer", &I);
1071   Assert1(DestTy->isIntegerTy(), "PtrToInt result must be integral", &I);
1072
1073   visitInstruction(I);
1074 }
1075
1076 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1077   // Get the source and destination types
1078   const Type *SrcTy = I.getOperand(0)->getType();
1079   const Type *DestTy = I.getType();
1080
1081   Assert1(SrcTy->isIntegerTy(), "IntToPtr source must be an integral", &I);
1082   Assert1(DestTy->isPointerTy(), "IntToPtr result must be a pointer",&I);
1083
1084   visitInstruction(I);
1085 }
1086
1087 void Verifier::visitBitCastInst(BitCastInst &I) {
1088   // Get the source and destination types
1089   const Type *SrcTy = I.getOperand(0)->getType();
1090   const Type *DestTy = I.getType();
1091
1092   // Get the size of the types in bits, we'll need this later
1093   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1094   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
1095
1096   // BitCast implies a no-op cast of type only. No bits change.
1097   // However, you can't cast pointers to anything but pointers.
1098   Assert1(DestTy->isPointerTy() == DestTy->isPointerTy(),
1099           "Bitcast requires both operands to be pointer or neither", &I);
1100   Assert1(SrcBitSize == DestBitSize, "Bitcast requires types of same width",&I);
1101
1102   // Disallow aggregates.
1103   Assert1(!SrcTy->isAggregateType(),
1104           "Bitcast operand must not be aggregate", &I);
1105   Assert1(!DestTy->isAggregateType(),
1106           "Bitcast type must not be aggregate", &I);
1107
1108   visitInstruction(I);
1109 }
1110
1111 /// visitPHINode - Ensure that a PHI node is well formed.
1112 ///
1113 void Verifier::visitPHINode(PHINode &PN) {
1114   // Ensure that the PHI nodes are all grouped together at the top of the block.
1115   // This can be tested by checking whether the instruction before this is
1116   // either nonexistent (because this is begin()) or is a PHI node.  If not,
1117   // then there is some other instruction before a PHI.
1118   Assert2(&PN == &PN.getParent()->front() ||
1119           isa<PHINode>(--BasicBlock::iterator(&PN)),
1120           "PHI nodes not grouped at top of basic block!",
1121           &PN, PN.getParent());
1122
1123   // Check that all of the values of the PHI node have the same type as the
1124   // result, and that the incoming blocks are really basic blocks.
1125   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1126     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1127             "PHI node operands are not the same type as the result!", &PN);
1128     Assert1(isa<BasicBlock>(PN.getOperand(
1129                 PHINode::getOperandNumForIncomingBlock(i))),
1130             "PHI node incoming block is not a BasicBlock!", &PN);
1131   }
1132
1133   // All other PHI node constraints are checked in the visitBasicBlock method.
1134
1135   visitInstruction(PN);
1136 }
1137
1138 void Verifier::VerifyCallSite(CallSite CS) {
1139   Instruction *I = CS.getInstruction();
1140
1141   Assert1(CS.getCalledValue()->getType()->isPointerTy(),
1142           "Called function must be a pointer!", I);
1143   const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1144
1145   Assert1(FPTy->getElementType()->isFunctionTy(),
1146           "Called function is not pointer to function type!", I);
1147   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1148
1149   // Verify that the correct number of arguments are being passed
1150   if (FTy->isVarArg())
1151     Assert1(CS.arg_size() >= FTy->getNumParams(),
1152             "Called function requires more parameters than were provided!",I);
1153   else
1154     Assert1(CS.arg_size() == FTy->getNumParams(),
1155             "Incorrect number of arguments passed to called function!", I);
1156
1157   // Verify that all arguments to the call match the function type.
1158   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1159     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1160             "Call parameter type does not match function signature!",
1161             CS.getArgument(i), FTy->getParamType(i), I);
1162
1163   const AttrListPtr &Attrs = CS.getAttributes();
1164
1165   Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1166           "Attributes after last parameter!", I);
1167
1168   // Verify call attributes.
1169   VerifyFunctionAttrs(FTy, Attrs, I);
1170
1171   if (FTy->isVarArg())
1172     // Check attributes on the varargs part.
1173     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1174       Attributes Attr = Attrs.getParamAttributes(Idx);
1175
1176       VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1177
1178       Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1179       Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1180               " cannot be used for vararg call arguments!", I);
1181     }
1182
1183   // Verify that there's no metadata unless it's a direct call to an intrinsic.
1184   if (!CS.getCalledFunction() ||
1185       !CS.getCalledFunction()->getName().startswith("llvm.")) {
1186     for (FunctionType::param_iterator PI = FTy->param_begin(),
1187            PE = FTy->param_end(); PI != PE; ++PI)
1188       Assert1(!PI->get()->isMetadataTy(),
1189               "Function has metadata parameter but isn't an intrinsic", I);
1190   }
1191
1192   visitInstruction(*I);
1193 }
1194
1195 void Verifier::visitCallInst(CallInst &CI) {
1196   VerifyCallSite(&CI);
1197
1198   if (Function *F = CI.getCalledFunction())
1199     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1200       visitIntrinsicFunctionCall(ID, CI);
1201 }
1202
1203 void Verifier::visitInvokeInst(InvokeInst &II) {
1204   VerifyCallSite(&II);
1205 }
1206
1207 /// visitBinaryOperator - Check that both arguments to the binary operator are
1208 /// of the same type!
1209 ///
1210 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1211   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1212           "Both operands to a binary operator are not of the same type!", &B);
1213
1214   switch (B.getOpcode()) {
1215   // Check that integer arithmetic operators are only used with
1216   // integral operands.
1217   case Instruction::Add:
1218   case Instruction::Sub:
1219   case Instruction::Mul:
1220   case Instruction::SDiv:
1221   case Instruction::UDiv:
1222   case Instruction::SRem:
1223   case Instruction::URem:
1224     Assert1(B.getType()->isIntOrIntVectorTy(),
1225             "Integer arithmetic operators only work with integral types!", &B);
1226     Assert1(B.getType() == B.getOperand(0)->getType(),
1227             "Integer arithmetic operators must have same type "
1228             "for operands and result!", &B);
1229     break;
1230   // Check that floating-point arithmetic operators are only used with
1231   // floating-point operands.
1232   case Instruction::FAdd:
1233   case Instruction::FSub:
1234   case Instruction::FMul:
1235   case Instruction::FDiv:
1236   case Instruction::FRem:
1237     Assert1(B.getType()->isFPOrFPVectorTy(),
1238             "Floating-point arithmetic operators only work with "
1239             "floating-point types!", &B);
1240     Assert1(B.getType() == B.getOperand(0)->getType(),
1241             "Floating-point arithmetic operators must have same type "
1242             "for operands and result!", &B);
1243     break;
1244   // Check that logical operators are only used with integral operands.
1245   case Instruction::And:
1246   case Instruction::Or:
1247   case Instruction::Xor:
1248     Assert1(B.getType()->isIntOrIntVectorTy(),
1249             "Logical operators only work with integral types!", &B);
1250     Assert1(B.getType() == B.getOperand(0)->getType(),
1251             "Logical operators must have same type for operands and result!",
1252             &B);
1253     break;
1254   case Instruction::Shl:
1255   case Instruction::LShr:
1256   case Instruction::AShr:
1257     Assert1(B.getType()->isIntOrIntVectorTy(),
1258             "Shifts only work with integral types!", &B);
1259     Assert1(B.getType() == B.getOperand(0)->getType(),
1260             "Shift return type must be same as operands!", &B);
1261     break;
1262   default:
1263     llvm_unreachable("Unknown BinaryOperator opcode!");
1264   }
1265
1266   visitInstruction(B);
1267 }
1268
1269 void Verifier::visitICmpInst(ICmpInst& IC) {
1270   // Check that the operands are the same type
1271   const Type* Op0Ty = IC.getOperand(0)->getType();
1272   const Type* Op1Ty = IC.getOperand(1)->getType();
1273   Assert1(Op0Ty == Op1Ty,
1274           "Both operands to ICmp instruction are not of the same type!", &IC);
1275   // Check that the operands are the right type
1276   Assert1(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPointerTy(),
1277           "Invalid operand types for ICmp instruction", &IC);
1278
1279   visitInstruction(IC);
1280 }
1281
1282 void Verifier::visitFCmpInst(FCmpInst& FC) {
1283   // Check that the operands are the same type
1284   const Type* Op0Ty = FC.getOperand(0)->getType();
1285   const Type* Op1Ty = FC.getOperand(1)->getType();
1286   Assert1(Op0Ty == Op1Ty,
1287           "Both operands to FCmp instruction are not of the same type!", &FC);
1288   // Check that the operands are the right type
1289   Assert1(Op0Ty->isFPOrFPVectorTy(),
1290           "Invalid operand types for FCmp instruction", &FC);
1291   visitInstruction(FC);
1292 }
1293
1294 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1295   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1296                                               EI.getOperand(1)),
1297           "Invalid extractelement operands!", &EI);
1298   visitInstruction(EI);
1299 }
1300
1301 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1302   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1303                                              IE.getOperand(1),
1304                                              IE.getOperand(2)),
1305           "Invalid insertelement operands!", &IE);
1306   visitInstruction(IE);
1307 }
1308
1309 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1310   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1311                                              SV.getOperand(2)),
1312           "Invalid shufflevector operands!", &SV);
1313
1314   const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1315   Assert1(VTy, "Operands are not a vector type", &SV);
1316
1317   // Check to see if Mask is valid.
1318   if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1319     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1320       if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1321         Assert1(!CI->uge(VTy->getNumElements()*2),
1322                 "Invalid shufflevector shuffle mask!", &SV);
1323       } else {
1324         Assert1(isa<UndefValue>(MV->getOperand(i)),
1325                 "Invalid shufflevector shuffle mask!", &SV);
1326       }
1327     }
1328   } else {
1329     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1330             isa<ConstantAggregateZero>(SV.getOperand(2)),
1331             "Invalid shufflevector shuffle mask!", &SV);
1332   }
1333
1334   visitInstruction(SV);
1335 }
1336
1337 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1338   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1339   const Type *ElTy =
1340     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1341                                       Idxs.begin(), Idxs.end());
1342   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1343   Assert2(GEP.getType()->isPointerTy() &&
1344           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1345           "GEP is not of right type for indices!", &GEP, ElTy);
1346   visitInstruction(GEP);
1347 }
1348
1349 void Verifier::visitLoadInst(LoadInst &LI) {
1350   const PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1351   Assert1(PTy, "Load operand must be a pointer.", &LI);
1352   const Type *ElTy = PTy->getElementType();
1353   Assert2(ElTy == LI.getType(),
1354           "Load result type does not match pointer operand type!", &LI, ElTy);
1355   visitInstruction(LI);
1356 }
1357
1358 void Verifier::visitStoreInst(StoreInst &SI) {
1359   const PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1360   Assert1(PTy, "Store operand must be a pointer.", &SI);
1361   const Type *ElTy = PTy->getElementType();
1362   Assert2(ElTy == SI.getOperand(0)->getType(),
1363           "Stored value type does not match pointer operand type!",
1364           &SI, ElTy);
1365   visitInstruction(SI);
1366 }
1367
1368 void Verifier::visitAllocaInst(AllocaInst &AI) {
1369   const PointerType *PTy = AI.getType();
1370   Assert1(PTy->getAddressSpace() == 0,
1371           "Allocation instruction pointer not in the generic address space!",
1372           &AI);
1373   Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1374           &AI);
1375   Assert1(AI.getArraySize()->getType()->isIntegerTy(),
1376           "Alloca array size must have integer type", &AI);
1377   visitInstruction(AI);
1378 }
1379
1380 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1381   Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1382                                            EVI.idx_begin(), EVI.idx_end()) ==
1383           EVI.getType(),
1384           "Invalid ExtractValueInst operands!", &EVI);
1385
1386   visitInstruction(EVI);
1387 }
1388
1389 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1390   Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1391                                            IVI.idx_begin(), IVI.idx_end()) ==
1392           IVI.getOperand(1)->getType(),
1393           "Invalid InsertValueInst operands!", &IVI);
1394
1395   visitInstruction(IVI);
1396 }
1397
1398 /// verifyInstruction - Verify that an instruction is well formed.
1399 ///
1400 void Verifier::visitInstruction(Instruction &I) {
1401   BasicBlock *BB = I.getParent();
1402   Assert1(BB, "Instruction not embedded in basic block!", &I);
1403
1404   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
1405     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1406          UI != UE; ++UI)
1407       Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1408               "Only PHI nodes may reference their own value!", &I);
1409   }
1410
1411   // Verify that if this is a terminator that it is at the end of the block.
1412   if (isa<TerminatorInst>(I))
1413     Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1414
1415   // Check that void typed values don't have names
1416   Assert1(!I.getType()->isVoidTy() || !I.hasName(),
1417           "Instruction has a name, but provides a void value!", &I);
1418
1419   // Check that the return value of the instruction is either void or a legal
1420   // value type.
1421   Assert1(I.getType()->isVoidTy() ||
1422           I.getType()->isFirstClassType(),
1423           "Instruction returns a non-scalar type!", &I);
1424
1425   // Check that the instruction doesn't produce metadata. Calls are already
1426   // checked against the callee type.
1427   Assert1(!I.getType()->isMetadataTy() ||
1428           isa<CallInst>(I) || isa<InvokeInst>(I),
1429           "Invalid use of metadata!", &I);
1430
1431   // Check that all uses of the instruction, if they are instructions
1432   // themselves, actually have parent basic blocks.  If the use is not an
1433   // instruction, it is an error!
1434   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1435        UI != UE; ++UI) {
1436     if (Instruction *Used = dyn_cast<Instruction>(*UI))
1437       Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1438               " embedded in a basic block!", &I, Used);
1439     else {
1440       CheckFailed("Use of instruction is not an instruction!", *UI);
1441       return;
1442     }
1443   }
1444
1445   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1446     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1447
1448     // Check to make sure that only first-class-values are operands to
1449     // instructions.
1450     if (!I.getOperand(i)->getType()->isFirstClassType()) {
1451       Assert1(0, "Instruction operands must be first-class values!", &I);
1452     }
1453
1454     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1455       // Check to make sure that the "address of" an intrinsic function is never
1456       // taken.
1457       Assert1(!F->isIntrinsic() || (i + 1 == e && isa<CallInst>(I)),
1458               "Cannot take the address of an intrinsic!", &I);
1459       Assert1(F->getParent() == Mod, "Referencing function in another module!",
1460               &I);
1461     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1462       Assert1(OpBB->getParent() == BB->getParent(),
1463               "Referring to a basic block in another function!", &I);
1464     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1465       Assert1(OpArg->getParent() == BB->getParent(),
1466               "Referring to an argument in another function!", &I);
1467     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1468       Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1469               &I);
1470     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1471       BasicBlock *OpBlock = Op->getParent();
1472
1473       // Check that a definition dominates all of its uses.
1474       if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1475         // Invoke results are only usable in the normal destination, not in the
1476         // exceptional destination.
1477         BasicBlock *NormalDest = II->getNormalDest();
1478
1479         Assert2(NormalDest != II->getUnwindDest(),
1480                 "No uses of invoke possible due to dominance structure!",
1481                 Op, &I);
1482
1483         // PHI nodes differ from other nodes because they actually "use" the
1484         // value in the predecessor basic blocks they correspond to.
1485         BasicBlock *UseBlock = BB;
1486         if (isa<PHINode>(I))
1487           UseBlock = dyn_cast<BasicBlock>(I.getOperand(i+1));
1488         Assert2(UseBlock, "Invoke operand is PHI node with bad incoming-BB",
1489                 Op, &I);
1490
1491         if (isa<PHINode>(I) && UseBlock == OpBlock) {
1492           // Special case of a phi node in the normal destination or the unwind
1493           // destination.
1494           Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1495                   "Invoke result not available in the unwind destination!",
1496                   Op, &I);
1497         } else {
1498           Assert2(DT->dominates(NormalDest, UseBlock) ||
1499                   !DT->isReachableFromEntry(UseBlock),
1500                   "Invoke result does not dominate all uses!", Op, &I);
1501
1502           // If the normal successor of an invoke instruction has multiple
1503           // predecessors, then the normal edge from the invoke is critical,
1504           // so the invoke value can only be live if the destination block
1505           // dominates all of it's predecessors (other than the invoke).
1506           if (!NormalDest->getSinglePredecessor() &&
1507               DT->isReachableFromEntry(UseBlock))
1508             // If it is used by something non-phi, then the other case is that
1509             // 'NormalDest' dominates all of its predecessors other than the
1510             // invoke.  In this case, the invoke value can still be used.
1511             for (pred_iterator PI = pred_begin(NormalDest),
1512                  E = pred_end(NormalDest); PI != E; ++PI)
1513               if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1514                   DT->isReachableFromEntry(*PI)) {
1515                 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1516                 return;
1517               }
1518         }
1519       } else if (isa<PHINode>(I)) {
1520         // PHI nodes are more difficult than other nodes because they actually
1521         // "use" the value in the predecessor basic blocks they correspond to.
1522         BasicBlock *PredBB = dyn_cast<BasicBlock>(I.getOperand(i+1));
1523         Assert2(PredBB && (DT->dominates(OpBlock, PredBB) ||
1524                            !DT->isReachableFromEntry(PredBB)),
1525                 "Instruction does not dominate all uses!", Op, &I);
1526       } else {
1527         if (OpBlock == BB) {
1528           // If they are in the same basic block, make sure that the definition
1529           // comes before the use.
1530           Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1531                   "Instruction does not dominate all uses!", Op, &I);
1532         }
1533
1534         // Definition must dominate use unless use is unreachable!
1535         Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1536                 !DT->isReachableFromEntry(BB),
1537                 "Instruction does not dominate all uses!", Op, &I);
1538       }
1539     } else if (isa<InlineAsm>(I.getOperand(i))) {
1540       Assert1((i + 1 == e && isa<CallInst>(I)) ||
1541               (i + 3 == e && isa<InvokeInst>(I)),
1542               "Cannot take the address of an inline asm!", &I);
1543     }
1544   }
1545   InstsInThisBlock.insert(&I);
1546
1547   VerifyType(I.getType());
1548 }
1549
1550 /// VerifyType - Verify that a type is well formed.
1551 ///
1552 void Verifier::VerifyType(const Type *Ty) {
1553   if (!Types.insert(Ty)) return;
1554
1555   Assert1(Context == &Ty->getContext(),
1556           "Type context does not match Module context!", Ty);
1557
1558   switch (Ty->getTypeID()) {
1559   case Type::FunctionTyID: {
1560     const FunctionType *FTy = cast<FunctionType>(Ty);
1561
1562     const Type *RetTy = FTy->getReturnType();
1563     Assert2(FunctionType::isValidReturnType(RetTy),
1564             "Function type with invalid return type", RetTy, FTy);
1565     VerifyType(RetTy);
1566
1567     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1568       const Type *ElTy = FTy->getParamType(i);
1569       Assert2(FunctionType::isValidArgumentType(ElTy),
1570               "Function type with invalid parameter type", ElTy, FTy);
1571       VerifyType(ElTy);
1572     }
1573   } break;
1574   case Type::StructTyID: {
1575     const StructType *STy = cast<StructType>(Ty);
1576     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1577       const Type *ElTy = STy->getElementType(i);
1578       Assert2(StructType::isValidElementType(ElTy),
1579               "Structure type with invalid element type", ElTy, STy);
1580       VerifyType(ElTy);
1581     }
1582   } break;
1583   case Type::UnionTyID: {
1584     const UnionType *UTy = cast<UnionType>(Ty);
1585     for (unsigned i = 0, e = UTy->getNumElements(); i != e; ++i) {
1586       const Type *ElTy = UTy->getElementType(i);
1587       Assert2(UnionType::isValidElementType(ElTy),
1588               "Union type with invalid element type", ElTy, UTy);
1589       VerifyType(ElTy);
1590     }
1591   } break;
1592   case Type::ArrayTyID: {
1593     const ArrayType *ATy = cast<ArrayType>(Ty);
1594     Assert1(ArrayType::isValidElementType(ATy->getElementType()),
1595             "Array type with invalid element type", ATy);
1596     VerifyType(ATy->getElementType());
1597   } break;
1598   case Type::PointerTyID: {
1599     const PointerType *PTy = cast<PointerType>(Ty);
1600     Assert1(PointerType::isValidElementType(PTy->getElementType()),
1601             "Pointer type with invalid element type", PTy);
1602     VerifyType(PTy->getElementType());
1603   } break;
1604   case Type::VectorTyID: {
1605     const VectorType *VTy = cast<VectorType>(Ty);
1606     Assert1(VectorType::isValidElementType(VTy->getElementType()),
1607             "Vector type with invalid element type", VTy);
1608     VerifyType(VTy->getElementType());
1609   } break;
1610   default:
1611     break;
1612   }
1613 }
1614
1615 // Flags used by TableGen to mark intrinsic parameters with the
1616 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1617 static const unsigned ExtendedElementVectorType = 0x40000000;
1618 static const unsigned TruncatedElementVectorType = 0x20000000;
1619
1620 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1621 ///
1622 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1623   Function *IF = CI.getCalledFunction();
1624   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1625           IF);
1626
1627 #define GET_INTRINSIC_VERIFIER
1628 #include "llvm/Intrinsics.gen"
1629 #undef GET_INTRINSIC_VERIFIER
1630
1631   // If the intrinsic takes MDNode arguments, verify that they are either global
1632   // or are local to *this* function.
1633   for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
1634     if (MDNode *MD = dyn_cast<MDNode>(CI.getArgOperand(i)))
1635       visitMDNode(*MD, CI.getParent()->getParent());
1636
1637   switch (ID) {
1638   default:
1639     break;
1640   case Intrinsic::dbg_declare: {  // llvm.dbg.declare
1641     Assert1(CI.getArgOperand(0) && isa<MDNode>(CI.getArgOperand(0)),
1642                 "invalid llvm.dbg.declare intrinsic call 1", &CI);
1643     MDNode *MD = cast<MDNode>(CI.getArgOperand(0));
1644     Assert1(MD->getNumOperands() == 1,
1645                 "invalid llvm.dbg.declare intrinsic call 2", &CI);
1646   } break;
1647   case Intrinsic::memcpy:
1648   case Intrinsic::memmove:
1649   case Intrinsic::memset:
1650     Assert1(isa<ConstantInt>(CI.getArgOperand(3)),
1651             "alignment argument of memory intrinsics must be a constant int",
1652             &CI);
1653     break;
1654   case Intrinsic::gcroot:
1655   case Intrinsic::gcwrite:
1656   case Intrinsic::gcread:
1657     if (ID == Intrinsic::gcroot) {
1658       AllocaInst *AI =
1659         dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
1660       Assert1(AI && AI->getType()->getElementType()->isPointerTy(),
1661               "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1662       Assert1(isa<Constant>(CI.getArgOperand(1)),
1663               "llvm.gcroot parameter #2 must be a constant.", &CI);
1664     }
1665
1666     Assert1(CI.getParent()->getParent()->hasGC(),
1667             "Enclosing function does not use GC.", &CI);
1668     break;
1669   case Intrinsic::init_trampoline:
1670     Assert1(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
1671             "llvm.init_trampoline parameter #2 must resolve to a function.",
1672             &CI);
1673     break;
1674   case Intrinsic::prefetch:
1675     Assert1(isa<ConstantInt>(CI.getArgOperand(1)) &&
1676             isa<ConstantInt>(CI.getArgOperand(2)) &&
1677             cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
1678             cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
1679             "invalid arguments to llvm.prefetch",
1680             &CI);
1681     break;
1682   case Intrinsic::stackprotector:
1683     Assert1(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
1684             "llvm.stackprotector parameter #2 must resolve to an alloca.",
1685             &CI);
1686     break;
1687   case Intrinsic::lifetime_start:
1688   case Intrinsic::lifetime_end:
1689   case Intrinsic::invariant_start:
1690     Assert1(isa<ConstantInt>(CI.getArgOperand(0)),
1691             "size argument of memory use markers must be a constant integer",
1692             &CI);
1693     break;
1694   case Intrinsic::invariant_end:
1695     Assert1(isa<ConstantInt>(CI.getArgOperand(1)),
1696             "llvm.invariant.end parameter #2 must be a constant integer", &CI);
1697     break;
1698   }
1699 }
1700
1701 /// Produce a string to identify an intrinsic parameter or return value.
1702 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1703 /// parameters beginning with NumRets.
1704 ///
1705 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1706   if (ArgNo >= NumRets)
1707     return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1708   if (NumRets == 1)
1709     return "Intrinsic result type";
1710   return "Intrinsic result type #" + utostr(ArgNo);
1711 }
1712
1713 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1714                                 int VT, unsigned ArgNo, std::string &Suffix) {
1715   const FunctionType *FTy = F->getFunctionType();
1716
1717   unsigned NumElts = 0;
1718   const Type *EltTy = Ty;
1719   const VectorType *VTy = dyn_cast<VectorType>(Ty);
1720   if (VTy) {
1721     EltTy = VTy->getElementType();
1722     NumElts = VTy->getNumElements();
1723   }
1724
1725   const Type *RetTy = FTy->getReturnType();
1726   const StructType *ST = dyn_cast<StructType>(RetTy);
1727   unsigned NumRetVals;
1728   if (RetTy->isVoidTy())
1729     NumRetVals = 0;
1730   else if (ST)
1731     NumRetVals = ST->getNumElements();
1732   else
1733     NumRetVals = 1;
1734
1735   if (VT < 0) {
1736     int Match = ~VT;
1737
1738     // Check flags that indicate a type that is an integral vector type with
1739     // elements that are larger or smaller than the elements of the matched
1740     // type.
1741     if ((Match & (ExtendedElementVectorType |
1742                   TruncatedElementVectorType)) != 0) {
1743       const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1744       if (!VTy || !IEltTy) {
1745         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1746                     "an integral vector type.", F);
1747         return false;
1748       }
1749       // Adjust the current Ty (in the opposite direction) rather than
1750       // the type being matched against.
1751       if ((Match & ExtendedElementVectorType) != 0) {
1752         if ((IEltTy->getBitWidth() & 1) != 0) {
1753           CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " vector "
1754                       "element bit-width is odd.", F);
1755           return false;
1756         }
1757         Ty = VectorType::getTruncatedElementVectorType(VTy);
1758       } else
1759         Ty = VectorType::getExtendedElementVectorType(VTy);
1760       Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1761     }
1762
1763     if (Match <= static_cast<int>(NumRetVals - 1)) {
1764       if (ST)
1765         RetTy = ST->getElementType(Match);
1766
1767       if (Ty != RetTy) {
1768         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " does not "
1769                     "match return type.", F);
1770         return false;
1771       }
1772     } else {
1773       if (Ty != FTy->getParamType(Match - NumRetVals)) {
1774         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " does not "
1775                     "match parameter %" + utostr(Match - NumRetVals) + ".", F);
1776         return false;
1777       }
1778     }
1779   } else if (VT == MVT::iAny) {
1780     if (!EltTy->isIntegerTy()) {
1781       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1782                   "an integer type.", F);
1783       return false;
1784     }
1785
1786     unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1787     Suffix += ".";
1788
1789     if (EltTy != Ty)
1790       Suffix += "v" + utostr(NumElts);
1791
1792     Suffix += "i" + utostr(GotBits);
1793
1794     // Check some constraints on various intrinsics.
1795     switch (ID) {
1796     default: break; // Not everything needs to be checked.
1797     case Intrinsic::bswap:
1798       if (GotBits < 16 || GotBits % 16 != 0) {
1799         CheckFailed("Intrinsic requires even byte width argument", F);
1800         return false;
1801       }
1802       break;
1803     }
1804   } else if (VT == MVT::fAny) {
1805     if (!EltTy->isFloatingPointTy()) {
1806       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1807                   "a floating-point type.", F);
1808       return false;
1809     }
1810
1811     Suffix += ".";
1812
1813     if (EltTy != Ty)
1814       Suffix += "v" + utostr(NumElts);
1815
1816     Suffix += EVT::getEVT(EltTy).getEVTString();
1817   } else if (VT == MVT::vAny) {
1818     if (!VTy) {
1819       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a vector type.",
1820                   F);
1821       return false;
1822     }
1823     Suffix += ".v" + utostr(NumElts) + EVT::getEVT(EltTy).getEVTString();
1824   } else if (VT == MVT::iPTR) {
1825     if (!Ty->isPointerTy()) {
1826       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a "
1827                   "pointer and a pointer is required.", F);
1828       return false;
1829     }
1830   } else if (VT == MVT::iPTRAny) {
1831     // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1832     // and iPTR. In the verifier, we can not distinguish which case we have so
1833     // allow either case to be legal.
1834     if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1835       Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1836         EVT::getEVT(PTyp->getElementType()).getEVTString();
1837     } else {
1838       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a "
1839                   "pointer and a pointer is required.", F);
1840       return false;
1841     }
1842   } else if (EVT((MVT::SimpleValueType)VT).isVector()) {
1843     EVT VVT = EVT((MVT::SimpleValueType)VT);
1844
1845     // If this is a vector argument, verify the number and type of elements.
1846     if (VVT.getVectorElementType() != EVT::getEVT(EltTy)) {
1847       CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1848       return false;
1849     }
1850
1851     if (VVT.getVectorNumElements() != NumElts) {
1852       CheckFailed("Intrinsic prototype has incorrect number of "
1853                   "vector elements!", F);
1854       return false;
1855     }
1856   } else if (EVT((MVT::SimpleValueType)VT).getTypeForEVT(Ty->getContext()) !=
1857              EltTy) {
1858     CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is wrong!", F);
1859     return false;
1860   } else if (EltTy != Ty) {
1861     CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is a vector "
1862                 "and a scalar is required.", F);
1863     return false;
1864   }
1865
1866   return true;
1867 }
1868
1869 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1870 /// Intrinsics.gen.  This implements a little state machine that verifies the
1871 /// prototype of intrinsics.
1872 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1873                                         unsigned NumRetVals,
1874                                         unsigned NumParams, ...) {
1875   va_list VA;
1876   va_start(VA, NumParams);
1877   const FunctionType *FTy = F->getFunctionType();
1878
1879   // For overloaded intrinsics, the Suffix of the function name must match the
1880   // types of the arguments. This variable keeps track of the expected
1881   // suffix, to be checked at the end.
1882   std::string Suffix;
1883
1884   if (FTy->getNumParams() + FTy->isVarArg() != NumParams) {
1885     CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1886     return;
1887   }
1888
1889   const Type *Ty = FTy->getReturnType();
1890   const StructType *ST = dyn_cast<StructType>(Ty);
1891
1892   if (NumRetVals == 0 && !Ty->isVoidTy()) {
1893     CheckFailed("Intrinsic should return void", F);
1894     return;
1895   }
1896
1897   // Verify the return types.
1898   if (ST && ST->getNumElements() != NumRetVals) {
1899     CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1900     return;
1901   }
1902
1903   for (unsigned ArgNo = 0; ArgNo != NumRetVals; ++ArgNo) {
1904     int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1905
1906     if (ST) Ty = ST->getElementType(ArgNo);
1907     if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1908       break;
1909   }
1910
1911   // Verify the parameter types.
1912   for (unsigned ArgNo = 0; ArgNo != NumParams; ++ArgNo) {
1913     int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1914
1915     if (VT == MVT::isVoid && ArgNo > 0) {
1916       if (!FTy->isVarArg())
1917         CheckFailed("Intrinsic prototype has no '...'!", F);
1918       break;
1919     }
1920
1921     if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT,
1922                           ArgNo + NumRetVals, Suffix))
1923       break;
1924   }
1925
1926   va_end(VA);
1927
1928   // For intrinsics without pointer arguments, if we computed a Suffix then the
1929   // intrinsic is overloaded and we need to make sure that the name of the
1930   // function is correct. We add the suffix to the name of the intrinsic and
1931   // compare against the given function name. If they are not the same, the
1932   // function name is invalid. This ensures that overloading of intrinsics
1933   // uses a sane and consistent naming convention.  Note that intrinsics with
1934   // pointer argument may or may not be overloaded so we will check assuming it
1935   // has a suffix and not.
1936   if (!Suffix.empty()) {
1937     std::string Name(Intrinsic::getName(ID));
1938     if (Name + Suffix != F->getName()) {
1939       CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1940                   F->getName().substr(Name.length()) + "'. It should be '" +
1941                   Suffix + "'", F);
1942     }
1943   }
1944
1945   // Check parameter attributes.
1946   Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1947           "Intrinsic has wrong parameter attributes!", F);
1948 }
1949
1950
1951 //===----------------------------------------------------------------------===//
1952 //  Implement the public interfaces to this file...
1953 //===----------------------------------------------------------------------===//
1954
1955 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1956   return new Verifier(action);
1957 }
1958
1959
1960 /// verifyFunction - Check a function for errors, printing messages on stderr.
1961 /// Return true if the function is corrupt.
1962 ///
1963 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1964   Function &F = const_cast<Function&>(f);
1965   assert(!F.isDeclaration() && "Cannot verify external functions");
1966
1967   FunctionPassManager FPM(F.getParent());
1968   Verifier *V = new Verifier(action);
1969   FPM.add(V);
1970   FPM.run(F);
1971   return V->Broken;
1972 }
1973
1974 /// verifyModule - Check a module for errors, printing messages on stderr.
1975 /// Return true if the module is corrupt.
1976 ///
1977 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1978                         std::string *ErrorInfo) {
1979   PassManager PM;
1980   Verifier *V = new Verifier(action);
1981   PM.add(V);
1982   PM.run(const_cast<Module&>(M));
1983
1984   if (ErrorInfo && V->Broken)
1985     *ErrorInfo = V->MessagesStr.str();
1986   return V->Broken;
1987 }