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