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