lib/VMCore/Verifier.cpp

   1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 int %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/Assembly/Writer.h"
  44 #include "llvm/CallingConv.h"
  45 #include "llvm/Constants.h"
  46 #include "llvm/Pass.h"
  47 #include "llvm/Module.h"
  48 #include "llvm/ModuleProvider.h"
  49 #include "llvm/ParameterAttributes.h"
  50 #include "llvm/DerivedTypes.h"
  51 #include "llvm/InlineAsm.h"
  52 #include "llvm/IntrinsicInst.h"
  53 #include "llvm/PassManager.h"
  54 #include "llvm/Analysis/Dominators.h"
  55 #include "llvm/CodeGen/ValueTypes.h"
  56 #include "llvm/Support/CFG.h"
  57 #include "llvm/Support/InstVisitor.h"
  58 #include "llvm/Support/Streams.h"
  59 #include "llvm/ADT/SmallPtrSet.h"
  60 #include "llvm/ADT/SmallVector.h"
  61 #include "llvm/ADT/StringExtras.h"
  62 #include "llvm/ADT/STLExtras.h"
  63 #include "llvm/Support/CommandLine.h"
  64 #include "llvm/Support/Compiler.h"
  65 #include <algorithm>
  66 #include <sstream>
  67 #include <cstdarg>
  68 using namespace llvm;
  69
  70 namespace {  // Anonymous namespace for class
  71   cl::opt<bool>
  72   Pedantic("verify-pedantic",
  73            cl::desc("Reject code with undefined behaviour"));
  74
  75   struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
  76     static char ID; // Pass ID, replacement for typeid
  77
  78     PreVerifier() : FunctionPass((intptr_t)&ID) { }
  79
  80     bool runOnFunction(Function &F) {
  81       for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
  82         assert(I->back().isTerminator()
  83                && "Block does not end with a terminator?");
  84
  85         return false;
  86     }
  87   };
  88
  89   char PreVerifier::ID = 0;
  90   RegisterPass<PreVerifier> PreVer("preverify", "Preliminary module verification");
  91   const PassInfo *PreVerifyID = PreVer.getPassInfo();
  92
  93   struct VISIBILITY_HIDDEN
  94      Verifier : public FunctionPass, InstVisitor<Verifier> {
  95     static char ID; // Pass ID, replacement for typeid
  96     bool Broken;          // Is this module found to be broken?
  97     bool RealPass;        // Are we not being run by a PassManager?
  98     VerifierFailureAction action;
  99                           // What to do if verification fails.
 100     Module *Mod;          // Module we are verifying right now
 101     DominatorTree *DT; // Dominator Tree, caution can be null!
 102     std::stringstream msgs;  // A stringstream to collect messages
 103
 104     /// InstInThisBlock - when verifying a basic block, keep track of all of the
 105     /// instructions we have seen so far.  This allows us to do efficient
 106     /// dominance checks for the case when an instruction has an operand that is
 107     /// an instruction in the same block.
 108     SmallPtrSet<Instruction*, 16> InstsInThisBlock;
 109
 110     Verifier()
 111       : FunctionPass((intptr_t)&ID),
 112       Broken(false), RealPass(true), action(AbortProcessAction),
 113       DT(0), msgs( std::ios::app | std::ios::out ) {}
 114     Verifier( VerifierFailureAction ctn )
 115       : FunctionPass((intptr_t)&ID),
 116       Broken(false), RealPass(true), action(ctn), DT(0),
 117       msgs( std::ios::app | std::ios::out ) {}
 118     Verifier(bool AB )
 119       : FunctionPass((intptr_t)&ID),
 120       Broken(false), RealPass(true),
 121       action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
 122       msgs( std::ios::app | std::ios::out ) {}
 123     Verifier(DominatorTree &dt)
 124       : FunctionPass((intptr_t)&ID),
 125       Broken(false), RealPass(false), action(PrintMessageAction),
 126       DT(&dt), msgs( std::ios::app | std::ios::out ) {}
 127
 128
 129     bool doInitialization(Module &M) {
 130       Mod = &M;
 131       verifyTypeSymbolTable(M.getTypeSymbolTable());
 132
 133       // If this is a real pass, in a pass manager, we must abort before
 134       // returning back to the pass manager, or else the pass manager may try to
 135       // run other passes on the broken module.
 136       if (RealPass)
 137         return abortIfBroken();
 138       return false;
 139     }
 140
 141     bool runOnFunction(Function &F) {
 142       // Get dominator information if we are being run by PassManager
 143       if (RealPass) DT = &getAnalysis<DominatorTree>();
 144
 145       Mod = F.getParent();
 146
 147       visit(F);
 148       InstsInThisBlock.clear();
 149
 150       // If this is a real pass, in a pass manager, we must abort before
 151       // returning back to the pass manager, or else the pass manager may try to
 152       // run other passes on the broken module.
 153       if (RealPass)
 154         return abortIfBroken();
 155
 156       return false;
 157     }
 158
 159     bool doFinalization(Module &M) {
 160       // Scan through, checking all of the external function's linkage now...
 161       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 162         visitGlobalValue(*I);
 163
 164         // Check to make sure function prototypes are okay.
 165         if (I->isDeclaration()) visitFunction(*I);
 166       }
 167
 168       for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 169            I != E; ++I)
 170         visitGlobalVariable(*I);
 171
 172       for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
 173            I != E; ++I)
 174         visitGlobalAlias(*I);
 175
 176       // If the module is broken, abort at this time.
 177       return abortIfBroken();
 178     }
 179
 180     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 181       AU.setPreservesAll();
 182       AU.addRequiredID(PreVerifyID);
 183       if (RealPass)
 184         AU.addRequired<DominatorTree>();
 185     }
 186
 187     /// abortIfBroken - If the module is broken and we are supposed to abort on
 188     /// this condition, do so.
 189     ///
 190     bool abortIfBroken() {
 191       if (Broken) {
 192         msgs << "Broken module found, ";
 193         switch (action) {
 194           case AbortProcessAction:
 195             msgs << "compilation aborted!\n";
 196             cerr << msgs.str();
 197             abort();
 198           case PrintMessageAction:
 199             msgs << "verification continues.\n";
 200             cerr << msgs.str();
 201             return false;
 202           case ReturnStatusAction:
 203             msgs << "compilation terminated.\n";
 204             return Broken;
 205         }
 206       }
 207       return false;
 208     }
 209
 210
 211     // Verification methods...
 212     void verifyTypeSymbolTable(TypeSymbolTable &ST);
 213     void visitGlobalValue(GlobalValue &GV);
 214     void visitGlobalVariable(GlobalVariable &GV);
 215     void visitGlobalAlias(GlobalAlias &GA);
 216     void visitFunction(Function &F);
 217     void visitBasicBlock(BasicBlock &BB);
 218     void visitTruncInst(TruncInst &I);
 219     void visitZExtInst(ZExtInst &I);
 220     void visitSExtInst(SExtInst &I);
 221     void visitFPTruncInst(FPTruncInst &I);
 222     void visitFPExtInst(FPExtInst &I);
 223     void visitFPToUIInst(FPToUIInst &I);
 224     void visitFPToSIInst(FPToSIInst &I);
 225     void visitUIToFPInst(UIToFPInst &I);
 226     void visitSIToFPInst(SIToFPInst &I);
 227     void visitIntToPtrInst(IntToPtrInst &I);
 228     void visitPtrToIntInst(PtrToIntInst &I);
 229     void visitBitCastInst(BitCastInst &I);
 230     void visitPHINode(PHINode &PN);
 231     void visitBinaryOperator(BinaryOperator &B);
 232     void visitICmpInst(ICmpInst &IC);
 233     void visitFCmpInst(FCmpInst &FC);
 234     void visitExtractElementInst(ExtractElementInst &EI);
 235     void visitInsertElementInst(InsertElementInst &EI);
 236     void visitShuffleVectorInst(ShuffleVectorInst &EI);
 237     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 238     void visitCallInst(CallInst &CI);
 239     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 240     void visitLoadInst(LoadInst &LI);
 241     void visitStoreInst(StoreInst &SI);
 242     void visitInstruction(Instruction &I);
 243     void visitTerminatorInst(TerminatorInst &I);
 244     void visitReturnInst(ReturnInst &RI);
 245     void visitSwitchInst(SwitchInst &SI);
 246     void visitSelectInst(SelectInst &SI);
 247     void visitUserOp1(Instruction &I);
 248     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 249     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 250
 251     void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
 252                                   unsigned Count, ...);
 253
 254     void WriteValue(const Value *V) {
 255       if (!V) return;
 256       if (isa<Instruction>(V)) {
 257         msgs << *V;
 258       } else {
 259         WriteAsOperand(msgs, V, true, Mod);
 260         msgs << "\n";
 261       }
 262     }
 263
 264     void WriteType(const Type* T ) {
 265       if ( !T ) return;
 266       WriteTypeSymbolic(msgs, T, Mod );
 267     }
 268
 269
 270     // CheckFailed - A check failed, so print out the condition and the message
 271     // that failed.  This provides a nice place to put a breakpoint if you want
 272     // to see why something is not correct.
 273     void CheckFailed(const std::string &Message,
 274                      const Value *V1 = 0, const Value *V2 = 0,
 275                      const Value *V3 = 0, const Value *V4 = 0) {
 276       msgs << Message << "\n";
 277       WriteValue(V1);
 278       WriteValue(V2);
 279       WriteValue(V3);
 280       WriteValue(V4);
 281       Broken = true;
 282     }
 283
 284     void CheckFailed( const std::string& Message, const Value* V1,
 285                       const Type* T2, const Value* V3 = 0 ) {
 286       msgs << Message << "\n";
 287       WriteValue(V1);
 288       WriteType(T2);
 289       WriteValue(V3);
 290       Broken = true;
 291     }
 292   };
 293
 294   char Verifier::ID = 0;
 295   RegisterPass<Verifier> X("verify", "Module Verifier");
 296 } // End anonymous namespace
 297
 298
 299 // Assert - We know that cond should be true, if not print an error message.
 300 #define Assert(C, M) \
 301   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 302 #define Assert1(C, M, V1) \
 303   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 304 #define Assert2(C, M, V1, V2) \
 305   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 306 #define Assert3(C, M, V1, V2, V3) \
 307   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 308 #define Assert4(C, M, V1, V2, V3, V4) \
 309   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 310
 311
 312 void Verifier::visitGlobalValue(GlobalValue &GV) {
 313   Assert1(!GV.isDeclaration() ||
 314           GV.hasExternalLinkage() ||
 315           GV.hasDLLImportLinkage() ||
 316           GV.hasExternalWeakLinkage() ||
 317           (isa<GlobalAlias>(GV) &&
 318            (GV.hasInternalLinkage() || GV.hasWeakLinkage())),
 319   "Global is external, but doesn't have external or dllimport or weak linkage!",
 320           &GV);
 321
 322   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
 323           "Global is marked as dllimport, but not external", &GV);
 324
 325   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 326           "Only global variables can have appending linkage!", &GV);
 327
 328   if (GV.hasAppendingLinkage()) {
 329     GlobalVariable &GVar = cast<GlobalVariable>(GV);
 330     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
 331             "Only global arrays can have appending linkage!", &GV);
 332   }
 333 }
 334
 335 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 336   if (GV.hasInitializer()) {
 337     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 338             "Global variable initializer type does not match global "
 339             "variable type!", &GV);
 340   } else {
 341     Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
 342             GV.hasExternalWeakLinkage(),
 343             "invalid linkage type for global declaration", &GV);
 344   }
 345
 346   visitGlobalValue(GV);
 347 }
 348
 349 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
 350   Assert1(!GA.getName().empty(),
 351           "Alias name cannot be empty!", &GA);
 352   Assert1(GA.hasExternalLinkage() || GA.hasInternalLinkage() ||
 353           GA.hasWeakLinkage(),
 354           "Alias should have external or external weak linkage!", &GA);
 355   Assert1(GA.getType() == GA.getAliasee()->getType(),
 356           "Alias and aliasee types should match!", &GA);
 357
 358   if (!isa<GlobalValue>(GA.getAliasee())) {
 359     const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
 360     Assert1(CE && CE->getOpcode() == Instruction::BitCast &&
 361             isa<GlobalValue>(CE->getOperand(0)),
 362             "Aliasee should be either GlobalValue or bitcast of GlobalValue",
 363             &GA);
 364   }
 365
 366   visitGlobalValue(GA);
 367 }
 368
 369 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 370 }
 371
 372 // visitFunction - Verify that a function is ok.
 373 //
 374 void Verifier::visitFunction(Function &F) {
 375   // Check function arguments.
 376   const FunctionType *FT = F.getFunctionType();
 377   unsigned NumArgs = F.arg_size();
 378
 379   Assert2(FT->getNumParams() == NumArgs,
 380           "# formal arguments must match # of arguments for function type!",
 381           &F, FT);
 382   Assert1(F.getReturnType()->isFirstClassType() ||
 383           F.getReturnType() == Type::VoidTy,
 384           "Functions cannot return aggregate values!", &F);
 385
 386   Assert1(!FT->isStructReturn() || FT->getReturnType() == Type::VoidTy,
 387           "Invalid struct-return function!", &F);
 388
 389   const uint16_t ReturnIncompatible =
 390     ParamAttr::ByVal | ParamAttr::InReg |
 391     ParamAttr::Nest  | ParamAttr::StructRet;
 392
 393   const uint16_t ParameterIncompatible =
 394     ParamAttr::NoReturn | ParamAttr::NoUnwind;
 395
 396   const uint16_t MutuallyIncompatible =
 397     ParamAttr::ByVal | ParamAttr::InReg |
 398     ParamAttr::Nest  | ParamAttr::StructRet;
 399
 400   const uint16_t MutuallyIncompatible2 =
 401     ParamAttr::ZExt | ParamAttr::SExt;
 402
 403   const uint16_t IntegerTypeOnly =
 404     ParamAttr::SExt | ParamAttr::ZExt;
 405
 406   const uint16_t PointerTypeOnly =
 407     ParamAttr::ByVal   | ParamAttr::Nest |
 408     ParamAttr::NoAlias | ParamAttr::StructRet;
 409
 410   bool SawSRet = false;
 411
 412   if (const ParamAttrsList *Attrs = FT->getParamAttrs()) {
 413     unsigned Idx = 1;
 414     bool SawNest = false;
 415
 416     uint16_t RetI = Attrs->getParamAttrs(0) & ReturnIncompatible;
 417     Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
 418             "should not apply to functions!", &F);
 419     uint16_t MutI = Attrs->getParamAttrs(0) & MutuallyIncompatible2;
 420     Assert1(MutI != MutuallyIncompatible2, "Attributes" +
 421             Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
 422
 423     for (FunctionType::param_iterator I = FT->param_begin(),
 424          E = FT->param_end(); I != E; ++I, ++Idx) {
 425
 426       uint16_t Attr = Attrs->getParamAttrs(Idx);
 427
 428       uint16_t ParmI = Attr & ParameterIncompatible;
 429       Assert1(!ParmI, "Attribute " + Attrs->getParamAttrsText(ParmI) +
 430               "should only be applied to function!", &F);
 431
 432       uint16_t MutI = Attr & MutuallyIncompatible;
 433       Assert1(!(MutI & (MutI - 1)), "Attributes " +
 434               Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
 435
 436       uint16_t MutI2 = Attr & MutuallyIncompatible2;
 437       Assert1(MutI2 != MutuallyIncompatible2, "Attributes" +
 438               Attrs->getParamAttrsText(MutI2) + "are incompatible!", &F);
 439
 440       uint16_t IType = Attr & IntegerTypeOnly;
 441       Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
 442               "Attribute " + Attrs->getParamAttrsText(IType) +
 443               "should only apply to Integer type!", &F);
 444
 445       uint16_t PType = Attr & PointerTypeOnly;
 446       Assert1(!PType || isa<PointerType>(FT->getParamType(Idx-1)),
 447               "Attribute " + Attrs->getParamAttrsText(PType) +
 448               "should only apply to Pointer type!", &F);
 449
 450       if (Attrs->paramHasAttr(Idx, ParamAttr::ByVal)) {
 451         const PointerType *Ty =
 452             dyn_cast<PointerType>(FT->getParamType(Idx-1));
 453         Assert1(!Ty || isa<StructType>(Ty->getElementType()),
 454                 "Attribute byval should only apply to pointer to structs!", &F);
 455       }
 456
 457       if (Attrs->paramHasAttr(Idx, ParamAttr::Nest)) {
 458         Assert1(!SawNest, "More than one parameter has attribute nest!", &F);
 459         SawNest = true;
 460       }
 461
 462       if (Attrs->paramHasAttr(Idx, ParamAttr::StructRet)) {
 463         SawSRet = true;
 464         Assert1(Idx == 1, "Attribute sret not on first parameter!", &F);
 465       }
 466     }
 467   }
 468
 469   Assert1(SawSRet == FT->isStructReturn(),
 470           "StructReturn function with no sret attribute!", &F);
 471
 472   // Check that this function meets the restrictions on this calling convention.
 473   switch (F.getCallingConv()) {
 474   default:
 475     break;
 476   case CallingConv::C:
 477     break;
 478   case CallingConv::Fast:
 479   case CallingConv::Cold:
 480   case CallingConv::X86_FastCall:
 481     Assert1(!F.isVarArg(),
 482             "Varargs functions must have C calling conventions!", &F);
 483     break;
 484   }
 485
 486   // Check that the argument values match the function type for this function...
 487   unsigned i = 0;
 488   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 489        I != E; ++I, ++i) {
 490     Assert2(I->getType() == FT->getParamType(i),
 491             "Argument value does not match function argument type!",
 492             I, FT->getParamType(i));
 493     // Make sure no aggregates are passed by value.
 494     Assert1(I->getType()->isFirstClassType(),
 495             "Functions cannot take aggregates as arguments by value!", I);
 496    }
 497
 498   if (F.isDeclaration()) {
 499     Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
 500             F.hasExternalWeakLinkage(),
 501             "invalid linkage type for function declaration", &F);
 502   } else {
 503     // Verify that this function (which has a body) is not named "llvm.*".  It
 504     // is not legal to define intrinsics.
 505     if (F.getName().size() >= 5)
 506       Assert1(F.getName().substr(0, 5) != "llvm.",
 507               "llvm intrinsics cannot be defined!", &F);
 508
 509     // Check the entry node
 510     BasicBlock *Entry = &F.getEntryBlock();
 511     Assert1(pred_begin(Entry) == pred_end(Entry),
 512             "Entry block to function must not have predecessors!", Entry);
 513   }
 514 }
 515
 516
 517 // verifyBasicBlock - Verify that a basic block is well formed...
 518 //
 519 void Verifier::visitBasicBlock(BasicBlock &BB) {
 520   InstsInThisBlock.clear();
 521
 522   // Ensure that basic blocks have terminators!
 523   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 524
 525   // Check constraints that this basic block imposes on all of the PHI nodes in
 526   // it.
 527   if (isa<PHINode>(BB.front())) {
 528     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
 529     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
 530     std::sort(Preds.begin(), Preds.end());
 531     PHINode *PN;
 532     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 533
 534       // Ensure that PHI nodes have at least one entry!
 535       Assert1(PN->getNumIncomingValues() != 0,
 536               "PHI nodes must have at least one entry.  If the block is dead, "
 537               "the PHI should be removed!", PN);
 538       Assert1(PN->getNumIncomingValues() == Preds.size(),
 539               "PHINode should have one entry for each predecessor of its "
 540               "parent basic block!", PN);
 541
 542       // Get and sort all incoming values in the PHI node...
 543       Values.clear();
 544       Values.reserve(PN->getNumIncomingValues());
 545       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 546         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 547                                         PN->getIncomingValue(i)));
 548       std::sort(Values.begin(), Values.end());
 549
 550       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 551         // Check to make sure that if there is more than one entry for a
 552         // particular basic block in this PHI node, that the incoming values are
 553         // all identical.
 554         //
 555         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 556                 Values[i].second == Values[i-1].second,
 557                 "PHI node has multiple entries for the same basic block with "
 558                 "different incoming values!", PN, Values[i].first,
 559                 Values[i].second, Values[i-1].second);
 560
 561         // Check to make sure that the predecessors and PHI node entries are
 562         // matched up.
 563         Assert3(Values[i].first == Preds[i],
 564                 "PHI node entries do not match predecessors!", PN,
 565                 Values[i].first, Preds[i]);
 566       }
 567     }
 568   }
 569 }
 570
 571 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 572   // Ensure that terminators only exist at the end of the basic block.
 573   Assert1(&I == I.getParent()->getTerminator(),
 574           "Terminator found in the middle of a basic block!", I.getParent());
 575   visitInstruction(I);
 576 }
 577
 578 void Verifier::visitReturnInst(ReturnInst &RI) {
 579   Function *F = RI.getParent()->getParent();
 580   if (RI.getNumOperands() == 0)
 581     Assert2(F->getReturnType() == Type::VoidTy,
 582             "Found return instr that returns void in Function of non-void "
 583             "return type!", &RI, F->getReturnType());
 584   else
 585     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 586             "Function return type does not match operand "
 587             "type of return inst!", &RI, F->getReturnType());
 588
 589   // Check to make sure that the return value has necessary properties for
 590   // terminators...
 591   visitTerminatorInst(RI);
 592 }
 593
 594 void Verifier::visitSwitchInst(SwitchInst &SI) {
 595   // Check to make sure that all of the constants in the switch instruction
 596   // have the same type as the switched-on value.
 597   const Type *SwitchTy = SI.getCondition()->getType();
 598   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 599     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 600             "Switch constants must all be same type as switch value!", &SI);
 601
 602   visitTerminatorInst(SI);
 603 }
 604
 605 void Verifier::visitSelectInst(SelectInst &SI) {
 606   Assert1(SI.getCondition()->getType() == Type::Int1Ty,
 607           "Select condition type must be bool!", &SI);
 608   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 609           "Select values must have identical types!", &SI);
 610   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 611           "Select values must have same type as select instruction!", &SI);
 612   visitInstruction(SI);
 613 }
 614
 615
 616 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 617 /// a pass, if any exist, it's an error.
 618 ///
 619 void Verifier::visitUserOp1(Instruction &I) {
 620   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 621 }
 622
 623 void Verifier::visitTruncInst(TruncInst &I) {
 624   // Get the source and destination types
 625   const Type *SrcTy = I.getOperand(0)->getType();
 626   const Type *DestTy = I.getType();
 627
 628   // Get the size of the types in bits, we'll need this later
 629   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 630   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 631
 632   Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
 633   Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
 634   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 635
 636   visitInstruction(I);
 637 }
 638
 639 void Verifier::visitZExtInst(ZExtInst &I) {
 640   // Get the source and destination types
 641   const Type *SrcTy = I.getOperand(0)->getType();
 642   const Type *DestTy = I.getType();
 643
 644   // Get the size of the types in bits, we'll need this later
 645   Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
 646   Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
 647   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 648   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 649
 650   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 651
 652   visitInstruction(I);
 653 }
 654
 655 void Verifier::visitSExtInst(SExtInst &I) {
 656   // Get the source and destination types
 657   const Type *SrcTy = I.getOperand(0)->getType();
 658   const Type *DestTy = I.getType();
 659
 660   // Get the size of the types in bits, we'll need this later
 661   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 662   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 663
 664   Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
 665   Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
 666   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 667
 668   visitInstruction(I);
 669 }
 670
 671 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 672   // Get the source and destination types
 673   const Type *SrcTy = I.getOperand(0)->getType();
 674   const Type *DestTy = I.getType();
 675   // Get the size of the types in bits, we'll need this later
 676   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 677   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 678
 679   Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
 680   Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
 681   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 682
 683   visitInstruction(I);
 684 }
 685
 686 void Verifier::visitFPExtInst(FPExtInst &I) {
 687   // Get the source and destination types
 688   const Type *SrcTy = I.getOperand(0)->getType();
 689   const Type *DestTy = I.getType();
 690
 691   // Get the size of the types in bits, we'll need this later
 692   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 693   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 694
 695   Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
 696   Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
 697   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 698
 699   visitInstruction(I);
 700 }
 701
 702 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 703   // Get the source and destination types
 704   const Type *SrcTy = I.getOperand(0)->getType();
 705   const Type *DestTy = I.getType();
 706
 707   Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
 708   Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
 709
 710   visitInstruction(I);
 711 }
 712
 713 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 714   // Get the source and destination types
 715   const Type *SrcTy = I.getOperand(0)->getType();
 716   const Type *DestTy = I.getType();
 717
 718   Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
 719   Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
 720
 721   visitInstruction(I);
 722 }
 723
 724 void Verifier::visitFPToUIInst(FPToUIInst &I) {
 725   // Get the source and destination types
 726   const Type *SrcTy = I.getOperand(0)->getType();
 727   const Type *DestTy = I.getType();
 728
 729   Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
 730   Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
 731
 732   visitInstruction(I);
 733 }
 734
 735 void Verifier::visitFPToSIInst(FPToSIInst &I) {
 736   // Get the source and destination types
 737   const Type *SrcTy = I.getOperand(0)->getType();
 738   const Type *DestTy = I.getType();
 739
 740   Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
 741   Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
 742
 743   visitInstruction(I);
 744 }
 745
 746 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
 747   // Get the source and destination types
 748   const Type *SrcTy = I.getOperand(0)->getType();
 749   const Type *DestTy = I.getType();
 750
 751   Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
 752   Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
 753
 754   visitInstruction(I);
 755 }
 756
 757 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
 758   // Get the source and destination types
 759   const Type *SrcTy = I.getOperand(0)->getType();
 760   const Type *DestTy = I.getType();
 761
 762   Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
 763   Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
 764
 765   visitInstruction(I);
 766 }
 767
 768 void Verifier::visitBitCastInst(BitCastInst &I) {
 769   // Get the source and destination types
 770   const Type *SrcTy = I.getOperand(0)->getType();
 771   const Type *DestTy = I.getType();
 772
 773   // Get the size of the types in bits, we'll need this later
 774   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 775   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 776
 777   // BitCast implies a no-op cast of type only. No bits change.
 778   // However, you can't cast pointers to anything but pointers.
 779   Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
 780           "Bitcast requires both operands to be pointer or neither", &I);
 781   Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
 782
 783   visitInstruction(I);
 784 }
 785
 786 /// visitPHINode - Ensure that a PHI node is well formed.
 787 ///
 788 void Verifier::visitPHINode(PHINode &PN) {
 789   // Ensure that the PHI nodes are all grouped together at the top of the block.
 790   // This can be tested by checking whether the instruction before this is
 791   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 792   // then there is some other instruction before a PHI.
 793   Assert2(&PN == &PN.getParent()->front() ||
 794           isa<PHINode>(--BasicBlock::iterator(&PN)),
 795           "PHI nodes not grouped at top of basic block!",
 796           &PN, PN.getParent());
 797
 798   // Check that all of the operands of the PHI node have the same type as the
 799   // result.
 800   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 801     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 802             "PHI node operands are not the same type as the result!", &PN);
 803
 804   // All other PHI node constraints are checked in the visitBasicBlock method.
 805
 806   visitInstruction(PN);
 807 }
 808
 809 void Verifier::visitCallInst(CallInst &CI) {
 810   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 811           "Called function must be a pointer!", &CI);
 812   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 813   Assert1(isa<FunctionType>(FPTy->getElementType()),
 814           "Called function is not pointer to function type!", &CI);
 815
 816   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 817
 818   // Verify that the correct number of arguments are being passed
 819   if (FTy->isVarArg())
 820     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 821             "Called function requires more parameters than were provided!",&CI);
 822   else
 823     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 824             "Incorrect number of arguments passed to called function!", &CI);
 825
 826   // Verify that all arguments to the call match the function type...
 827   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 828     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 829             "Call parameter type does not match function signature!",
 830             CI.getOperand(i+1), FTy->getParamType(i), &CI);
 831
 832   if (Function *F = CI.getCalledFunction()) {
 833     if (Pedantic) {
 834       // Verify that calling convention of Function and CallInst match
 835       Assert1(F->getCallingConv() == CI.getCallingConv(),
 836               "Call uses different calling convention than function", &CI);
 837     }
 838
 839     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 840       visitIntrinsicFunctionCall(ID, CI);
 841   }
 842
 843   visitInstruction(CI);
 844 }
 845
 846 /// visitBinaryOperator - Check that both arguments to the binary operator are
 847 /// of the same type!
 848 ///
 849 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 850   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 851           "Both operands to a binary operator are not of the same type!", &B);
 852
 853   switch (B.getOpcode()) {
 854   // Check that logical operators are only used with integral operands.
 855   case Instruction::And:
 856   case Instruction::Or:
 857   case Instruction::Xor:
 858     Assert1(B.getType()->isInteger() ||
 859             (isa<VectorType>(B.getType()) &&
 860              cast<VectorType>(B.getType())->getElementType()->isInteger()),
 861             "Logical operators only work with integral types!", &B);
 862     Assert1(B.getType() == B.getOperand(0)->getType(),
 863             "Logical operators must have same type for operands and result!",
 864             &B);
 865     break;
 866   case Instruction::Shl:
 867   case Instruction::LShr:
 868   case Instruction::AShr:
 869     Assert1(B.getType()->isInteger(),
 870             "Shift must return an integer result!", &B);
 871     Assert1(B.getType() == B.getOperand(0)->getType(),
 872             "Shift return type must be same as operands!", &B);
 873     /* FALL THROUGH */
 874   default:
 875     // Arithmetic operators only work on integer or fp values
 876     Assert1(B.getType() == B.getOperand(0)->getType(),
 877             "Arithmetic operators must have same type for operands and result!",
 878             &B);
 879     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 880             isa<VectorType>(B.getType()),
 881             "Arithmetic operators must have integer, fp, or vector type!", &B);
 882     break;
 883   }
 884
 885   visitInstruction(B);
 886 }
 887
 888 void Verifier::visitICmpInst(ICmpInst& IC) {
 889   // Check that the operands are the same type
 890   const Type* Op0Ty = IC.getOperand(0)->getType();
 891   const Type* Op1Ty = IC.getOperand(1)->getType();
 892   Assert1(Op0Ty == Op1Ty,
 893           "Both operands to ICmp instruction are not of the same type!", &IC);
 894   // Check that the operands are the right type
 895   Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
 896           "Invalid operand types for ICmp instruction", &IC);
 897   visitInstruction(IC);
 898 }
 899
 900 void Verifier::visitFCmpInst(FCmpInst& FC) {
 901   // Check that the operands are the same type
 902   const Type* Op0Ty = FC.getOperand(0)->getType();
 903   const Type* Op1Ty = FC.getOperand(1)->getType();
 904   Assert1(Op0Ty == Op1Ty,
 905           "Both operands to FCmp instruction are not of the same type!", &FC);
 906   // Check that the operands are the right type
 907   Assert1(Op0Ty->isFloatingPoint(),
 908           "Invalid operand types for FCmp instruction", &FC);
 909   visitInstruction(FC);
 910 }
 911
 912 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
 913   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
 914                                               EI.getOperand(1)),
 915           "Invalid extractelement operands!", &EI);
 916   visitInstruction(EI);
 917 }
 918
 919 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
 920   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
 921                                              IE.getOperand(1),
 922                                              IE.getOperand(2)),
 923           "Invalid insertelement operands!", &IE);
 924   visitInstruction(IE);
 925 }
 926
 927 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
 928   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
 929                                              SV.getOperand(2)),
 930           "Invalid shufflevector operands!", &SV);
 931   Assert1(SV.getType() == SV.getOperand(0)->getType(),
 932           "Result of shufflevector must match first operand type!", &SV);
 933
 934   // Check to see if Mask is valid.
 935   if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
 936     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
 937       Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
 938               isa<UndefValue>(MV->getOperand(i)),
 939               "Invalid shufflevector shuffle mask!", &SV);
 940     }
 941   } else {
 942     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
 943             isa<ConstantAggregateZero>(SV.getOperand(2)),
 944             "Invalid shufflevector shuffle mask!", &SV);
 945   }
 946
 947   visitInstruction(SV);
 948 }
 949
 950 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 951   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
 952   const Type *ElTy =
 953     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 954                                       Idxs.begin(), Idxs.end(), true);
 955   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 956   Assert2(isa<PointerType>(GEP.getType()) &&
 957           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
 958           "GEP is not of right type for indices!", &GEP, ElTy);
 959   visitInstruction(GEP);
 960 }
 961
 962 void Verifier::visitLoadInst(LoadInst &LI) {
 963   const Type *ElTy =
 964     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
 965   Assert2(ElTy == LI.getType(),
 966           "Load result type does not match pointer operand type!", &LI, ElTy);
 967   visitInstruction(LI);
 968 }
 969
 970 void Verifier::visitStoreInst(StoreInst &SI) {
 971   const Type *ElTy =
 972     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
 973   Assert2(ElTy == SI.getOperand(0)->getType(),
 974           "Stored value type does not match pointer operand type!", &SI, ElTy);
 975   visitInstruction(SI);
 976 }
 977
 978
 979 /// verifyInstruction - Verify that an instruction is well formed.
 980 ///
 981 void Verifier::visitInstruction(Instruction &I) {
 982   BasicBlock *BB = I.getParent();
 983   Assert1(BB, "Instruction not embedded in basic block!", &I);
 984
 985   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 986     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 987          UI != UE; ++UI)
 988       Assert1(*UI != (User*)&I ||
 989               !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
 990               "Only PHI nodes may reference their own value!", &I);
 991   }
 992
 993   // Check that void typed values don't have names
 994   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 995           "Instruction has a name, but provides a void value!", &I);
 996
 997   // Check that the return value of the instruction is either void or a legal
 998   // value type.
 999   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
1000           "Instruction returns a non-scalar type!", &I);
1001
1002   // Check that all uses of the instruction, if they are instructions
1003   // themselves, actually have parent basic blocks.  If the use is not an
1004   // instruction, it is an error!
1005   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1006        UI != UE; ++UI) {
1007     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1008             *UI);
1009     Instruction *Used = cast<Instruction>(*UI);
1010     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1011             " embeded in a basic block!", &I, Used);
1012   }
1013
1014   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1015     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1016
1017     // Check to make sure that only first-class-values are operands to
1018     // instructions.
1019     Assert1(I.getOperand(i)->getType()->isFirstClassType(),
1020             "Instruction operands must be first-class values!", &I);
1021
1022     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1023       // Check to make sure that the "address of" an intrinsic function is never
1024       // taken.
1025       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1026               "Cannot take the address of an intrinsic!", &I);
1027       Assert1(F->getParent() == Mod, "Referencing function in another module!",
1028               &I);
1029     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1030       Assert1(OpBB->getParent() == BB->getParent(),
1031               "Referring to a basic block in another function!", &I);
1032     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1033       Assert1(OpArg->getParent() == BB->getParent(),
1034               "Referring to an argument in another function!", &I);
1035     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1036       Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1037               &I);
1038     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1039       BasicBlock *OpBlock = Op->getParent();
1040
1041       // Check that a definition dominates all of its uses.
1042       if (!isa<PHINode>(I)) {
1043         // Invoke results are only usable in the normal destination, not in the
1044         // exceptional destination.
1045         if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1046           OpBlock = II->getNormalDest();
1047
1048           Assert2(OpBlock != II->getUnwindDest(),
1049                   "No uses of invoke possible due to dominance structure!",
1050                   Op, II);
1051
1052           // If the normal successor of an invoke instruction has multiple
1053           // predecessors, then the normal edge from the invoke is critical, so
1054           // the invoke value can only be live if the destination block
1055           // dominates all of it's predecessors (other than the invoke) or if
1056           // the invoke value is only used by a phi in the successor.
1057           if (!OpBlock->getSinglePredecessor() &&
1058               DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1059             // The first case we allow is if the use is a PHI operand in the
1060             // normal block, and if that PHI operand corresponds to the invoke's
1061             // block.
1062             bool Bad = true;
1063             if (PHINode *PN = dyn_cast<PHINode>(&I))
1064               if (PN->getParent() == OpBlock &&
1065                   PN->getIncomingBlock(i/2) == Op->getParent())
1066                 Bad = false;
1067
1068             // If it is used by something non-phi, then the other case is that
1069             // 'OpBlock' dominates all of its predecessors other than the
1070             // invoke.  In this case, the invoke value can still be used.
1071             if (Bad) {
1072               Bad = false;
1073               for (pred_iterator PI = pred_begin(OpBlock),
1074                    E = pred_end(OpBlock); PI != E; ++PI) {
1075                 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1076                   Bad = true;
1077                   break;
1078                 }
1079               }
1080             }
1081             Assert2(!Bad,
1082                     "Invoke value defined on critical edge but not dead!", &I,
1083                     Op);
1084           }
1085         } else if (OpBlock == BB) {
1086           // If they are in the same basic block, make sure that the definition
1087           // comes before the use.
1088           Assert2(InstsInThisBlock.count(Op) ||
1089                   !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1090                   "Instruction does not dominate all uses!", Op, &I);
1091         }
1092
1093         // Definition must dominate use unless use is unreachable!
1094         Assert2(DT->dominates(OpBlock, BB) ||
1095                 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1096                 "Instruction does not dominate all uses!", Op, &I);
1097       } else {
1098         // PHI nodes are more difficult than other nodes because they actually
1099         // "use" the value in the predecessor basic blocks they correspond to.
1100         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1101         Assert2(DT->dominates(OpBlock, PredBB) ||
1102                 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1103                 "Instruction does not dominate all uses!", Op, &I);
1104       }
1105     } else if (isa<InlineAsm>(I.getOperand(i))) {
1106       Assert1(i == 0 && isa<CallInst>(I),
1107               "Cannot take the address of an inline asm!", &I);
1108     }
1109   }
1110   InstsInThisBlock.insert(&I);
1111 }
1112
1113 static bool HasPtrPtrType(Value *Val) {
1114   if (const PointerType *PtrTy = dyn_cast<PointerType>(Val->getType()))
1115     return isa<PointerType>(PtrTy->getElementType());
1116   return false;
1117 }
1118
1119 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1120 ///
1121 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1122   Function *IF = CI.getCalledFunction();
1123   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1124           IF);
1125
1126 #define GET_INTRINSIC_VERIFIER
1127 #include "llvm/Intrinsics.gen"
1128 #undef GET_INTRINSIC_VERIFIER
1129
1130   switch (ID) {
1131   default:
1132     break;
1133   case Intrinsic::gcroot:
1134     Assert1(HasPtrPtrType(CI.getOperand(1)),
1135             "llvm.gcroot parameter #1 must be a pointer to a pointer.", &CI);
1136     Assert1(isa<AllocaInst>(IntrinsicInst::StripPointerCasts(CI.getOperand(1))),
1137             "llvm.gcroot parameter #1 must be an alloca (or a bitcast of one).",
1138             &CI);
1139     Assert1(isa<Constant>(CI.getOperand(2)),
1140             "llvm.gcroot parameter #2 must be a constant.", &CI);
1141     break;
1142   case Intrinsic::gcwrite:
1143     Assert1(CI.getOperand(3)->getType()
1144             == PointerType::get(CI.getOperand(1)->getType()),
1145             "Call to llvm.gcwrite must be with type 'void (%ty*, %ty2*, %ty**)'.",
1146             &CI);
1147     break;
1148   case Intrinsic::gcread:
1149     Assert1(CI.getOperand(2)->getType() == PointerType::get(CI.getType()),
1150             "Call to llvm.gcread must be with type '%ty* (%ty2*, %ty**).'",
1151             &CI);
1152     break;
1153   case Intrinsic::init_trampoline:
1154     Assert1(isa<Function>(IntrinsicInst::StripPointerCasts(CI.getOperand(2))),
1155             "llvm.init_trampoline parameter #2 must resolve to a function.",
1156             &CI);
1157   }
1158 }
1159
1160 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1161 /// Intrinsics.gen.  This implements a little state machine that verifies the
1162 /// prototype of intrinsics.
1163 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID,
1164                                         Function *F,
1165                                         unsigned Count, ...) {
1166   va_list VA;
1167   va_start(VA, Count);
1168
1169   const FunctionType *FTy = F->getFunctionType();
1170
1171   // For overloaded intrinsics, the Suffix of the function name must match the
1172   // types of the arguments. This variable keeps track of the expected
1173   // suffix, to be checked at the end.
1174   std::string Suffix;
1175
1176   if (FTy->getNumParams() + FTy->isVarArg() != Count - 1) {
1177     CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1178     return;
1179   }
1180
1181   // Note that "arg#0" is the return type.
1182   for (unsigned ArgNo = 0; ArgNo < Count; ++ArgNo) {
1183     MVT::ValueType VT = va_arg(VA, MVT::ValueType);
1184
1185     if (VT == MVT::isVoid && ArgNo > 0) {
1186       if (!FTy->isVarArg())
1187         CheckFailed("Intrinsic prototype has no '...'!", F);
1188       break;
1189     }
1190
1191     const Type *Ty;
1192     if (ArgNo == 0)
1193       Ty = FTy->getReturnType();
1194     else
1195       Ty = FTy->getParamType(ArgNo-1);
1196
1197     unsigned NumElts = 0;
1198     const Type *EltTy = Ty;
1199     if (const VectorType *VTy = dyn_cast<VectorType>(Ty)) {
1200       EltTy = VTy->getElementType();
1201       NumElts = VTy->getNumElements();
1202     }
1203
1204     if ((int)VT < 0) {
1205       int Match = ~VT;
1206       if (Match == 0) {
1207         if (Ty != FTy->getReturnType()) {
1208           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1209                       "match return type.", F);
1210           break;
1211         }
1212       } else {
1213         if (Ty != FTy->getParamType(Match-1)) {
1214           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1215                       "match parameter %" + utostr(Match-1) + ".", F);
1216           break;
1217         }
1218       }
1219     } else if (VT == MVT::iAny) {
1220       if (!EltTy->isInteger()) {
1221         if (ArgNo == 0)
1222           CheckFailed("Intrinsic result type is not "
1223                       "an integer type.", F);
1224         else
1225           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1226                       "an integer type.", F);
1227         break;
1228       }
1229       unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1230       Suffix += ".";
1231       if (EltTy != Ty)
1232         Suffix += "v" + utostr(NumElts);
1233       Suffix += "i" + utostr(GotBits);;
1234       // Check some constraints on various intrinsics.
1235       switch (ID) {
1236         default: break; // Not everything needs to be checked.
1237         case Intrinsic::bswap:
1238           if (GotBits < 16 || GotBits % 16 != 0)
1239             CheckFailed("Intrinsic requires even byte width argument", F);
1240           break;
1241       }
1242     } else if (VT == MVT::fAny) {
1243       if (!EltTy->isFloatingPoint()) {
1244         if (ArgNo == 0)
1245           CheckFailed("Intrinsic result type is not "
1246                       "a floating-point type.", F);
1247         else
1248           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1249                       "a floating-point type.", F);
1250         break;
1251       }
1252       Suffix += ".";
1253       if (EltTy != Ty)
1254         Suffix += "v" + utostr(NumElts);
1255       Suffix += MVT::getValueTypeString(MVT::getValueType(EltTy));
1256     } else if (VT == MVT::iPTR) {
1257       if (!isa<PointerType>(Ty)) {
1258         if (ArgNo == 0)
1259           CheckFailed("Intrinsic result type is not a "
1260                       "pointer and a pointer is required.", F);
1261         else
1262           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not a "
1263                       "pointer and a pointer is required.", F);
1264         break;
1265       }
1266     } else if (MVT::isVector(VT)) {
1267       // If this is a vector argument, verify the number and type of elements.
1268       if (MVT::getVectorElementType(VT) != MVT::getValueType(EltTy)) {
1269         CheckFailed("Intrinsic prototype has incorrect vector element type!",
1270                     F);
1271         break;
1272       }
1273       if (MVT::getVectorNumElements(VT) != NumElts) {
1274         CheckFailed("Intrinsic prototype has incorrect number of "
1275                     "vector elements!",F);
1276         break;
1277       }
1278     } else if (MVT::getTypeForValueType(VT) != EltTy) {
1279       if (ArgNo == 0)
1280         CheckFailed("Intrinsic prototype has incorrect result type!", F);
1281       else
1282         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1283       break;
1284     } else if (EltTy != Ty) {
1285       if (ArgNo == 0)
1286         CheckFailed("Intrinsic result type is vector "
1287                     "and a scalar is required.", F);
1288       else
1289         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is vector "
1290                     "and a scalar is required.", F);
1291     }
1292   }
1293
1294   va_end(VA);
1295
1296   // If we computed a Suffix then the intrinsic is overloaded and we need to
1297   // make sure that the name of the function is correct. We add the suffix to
1298   // the name of the intrinsic and compare against the given function name. If
1299   // they are not the same, the function name is invalid. This ensures that
1300   // overloading of intrinsics uses a sane and consistent naming convention.
1301   if (!Suffix.empty()) {
1302     std::string Name(Intrinsic::getName(ID));
1303     if (Name + Suffix != F->getName())
1304       CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1305                   F->getName().substr(Name.length()) + "'. It should be '" +
1306                   Suffix + "'", F);
1307   }
1308 }
1309
1310
1311 //===----------------------------------------------------------------------===//
1312 //  Implement the public interfaces to this file...
1313 //===----------------------------------------------------------------------===//
1314
1315 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1316   return new Verifier(action);
1317 }
1318
1319
1320 // verifyFunction - Create
1321 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1322   Function &F = const_cast<Function&>(f);
1323   assert(!F.isDeclaration() && "Cannot verify external functions");
1324
1325   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1326   Verifier *V = new Verifier(action);
1327   FPM.add(V);
1328   FPM.run(F);
1329   return V->Broken;
1330 }
1331
1332 /// verifyModule - Check a module for errors, printing messages on stderr.
1333 /// Return true if the module is corrupt.
1334 ///
1335 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1336                         std::string *ErrorInfo) {
1337   PassManager PM;
1338   Verifier *V = new Verifier(action);
1339   PM.add(V);
1340   PM.run((Module&)M);
1341
1342   if (ErrorInfo && V->Broken)
1343     *ErrorInfo = V->msgs.str();
1344   return V->Broken;
1345 }
1346
1347 // vim: sw=2