lib/VMCore/Verifier.cpp

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