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/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   // Note that when calling a varargs function, the following test disallows
 394   // parameter attributes for the arguments corresponding to the varargs part.
 395   Assert1(Attrs->size() &&
 396           Attrs->getParamIndex(Attrs->size()-1) <= FT->getNumParams(),
 397           "Attributes after end of type!", V);
 398
 399   bool SawNest = false;
 400
 401   for (unsigned Idx = 0; Idx <= FT->getNumParams(); ++Idx) {
 402     uint16_t Attr = Attrs->getParamAttrs(Idx);
 403
 404     if (!Idx) {
 405       uint16_t RetI = Attr & ParamAttr::ParameterOnly;
 406       Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
 407               "does not apply to return values!", V);
 408     } else {
 409       uint16_t ParmI = Attr & ParamAttr::ReturnOnly;
 410       Assert1(!ParmI, "Attribute " + Attrs->getParamAttrsText(ParmI) +
 411               "only applies to return values!", V);
 412     }
 413
 414     for (unsigned i = 0;
 415          i < array_lengthof(ParamAttr::MutuallyIncompatible); ++i) {
 416       uint16_t MutI = Attr & ParamAttr::MutuallyIncompatible[i];
 417       Assert1(!(MutI & (MutI - 1)), "Attributes " +
 418               Attrs->getParamAttrsText(MutI) + "are incompatible!", V);
 419     }
 420
 421     uint16_t IType = Attr & ParamAttr::IntegerTypeOnly;
 422     Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
 423             "Attribute " + Attrs->getParamAttrsText(IType) +
 424             "should only apply to Integer type!", V);
 425
 426     uint16_t PType = Attr & ParamAttr::PointerTypeOnly;
 427     Assert1(!PType || isa<PointerType>(FT->getParamType(Idx-1)),
 428             "Attribute " + Attrs->getParamAttrsText(PType) +
 429             "should only apply to Pointer type!", V);
 430
 431     if (Attr & ParamAttr::ByVal) {
 432       const PointerType *Ty =
 433           dyn_cast<PointerType>(FT->getParamType(Idx-1));
 434       Assert1(!Ty || isa<StructType>(Ty->getElementType()),
 435               "Attribute byval should only apply to pointer to structs!", V);
 436     }
 437
 438     if (Attr & ParamAttr::Nest) {
 439       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
 440       SawNest = true;
 441     }
 442
 443     if (Attr & ParamAttr::StructRet) {
 444       Assert1(Idx == 1, "Attribute sret not on first parameter!", V);
 445     }
 446   }
 447 }
 448
 449 // visitFunction - Verify that a function is ok.
 450 //
 451 void Verifier::visitFunction(Function &F) {
 452   // Check function arguments.
 453   const FunctionType *FT = F.getFunctionType();
 454   unsigned NumArgs = F.arg_size();
 455
 456   Assert2(FT->getNumParams() == NumArgs,
 457           "# formal arguments must match # of arguments for function type!",
 458           &F, FT);
 459   Assert1(F.getReturnType()->isFirstClassType() ||
 460           F.getReturnType() == Type::VoidTy,
 461           "Functions cannot return aggregate values!", &F);
 462
 463   Assert1(!F.isStructReturn() || FT->getReturnType() == Type::VoidTy,
 464           "Invalid struct-return function!", &F);
 465
 466   // Check function attributes.
 467   VerifyParamAttrs(FT, F.getParamAttrs(), &F);
 468
 469   // Check that this function meets the restrictions on this calling convention.
 470   switch (F.getCallingConv()) {
 471   default:
 472     break;
 473   case CallingConv::C:
 474     break;
 475   case CallingConv::Fast:
 476   case CallingConv::Cold:
 477   case CallingConv::X86_FastCall:
 478     Assert1(!F.isVarArg(),
 479             "Varargs functions must have C calling conventions!", &F);
 480     break;
 481   }
 482
 483   // Check that the argument values match the function type for this function...
 484   unsigned i = 0;
 485   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 486        I != E; ++I, ++i) {
 487     Assert2(I->getType() == FT->getParamType(i),
 488             "Argument value does not match function argument type!",
 489             I, FT->getParamType(i));
 490     // Make sure no aggregates are passed by value.
 491     Assert1(I->getType()->isFirstClassType(),
 492             "Functions cannot take aggregates as arguments by value!", I);
 493    }
 494
 495   if (F.isDeclaration()) {
 496     Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
 497             F.hasExternalWeakLinkage(),
 498             "invalid linkage type for function declaration", &F);
 499   } else {
 500     // Verify that this function (which has a body) is not named "llvm.*".  It
 501     // is not legal to define intrinsics.
 502     if (F.getName().size() >= 5)
 503       Assert1(F.getName().substr(0, 5) != "llvm.",
 504               "llvm intrinsics cannot be defined!", &F);
 505
 506     // Check the entry node
 507     BasicBlock *Entry = &F.getEntryBlock();
 508     Assert1(pred_begin(Entry) == pred_end(Entry),
 509             "Entry block to function must not have predecessors!", Entry);
 510   }
 511 }
 512
 513
 514 // verifyBasicBlock - Verify that a basic block is well formed...
 515 //
 516 void Verifier::visitBasicBlock(BasicBlock &BB) {
 517   InstsInThisBlock.clear();
 518
 519   // Ensure that basic blocks have terminators!
 520   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 521
 522   // Check constraints that this basic block imposes on all of the PHI nodes in
 523   // it.
 524   if (isa<PHINode>(BB.front())) {
 525     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
 526     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
 527     std::sort(Preds.begin(), Preds.end());
 528     PHINode *PN;
 529     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 530
 531       // Ensure that PHI nodes have at least one entry!
 532       Assert1(PN->getNumIncomingValues() != 0,
 533               "PHI nodes must have at least one entry.  If the block is dead, "
 534               "the PHI should be removed!", PN);
 535       Assert1(PN->getNumIncomingValues() == Preds.size(),
 536               "PHINode should have one entry for each predecessor of its "
 537               "parent basic block!", PN);
 538
 539       // Get and sort all incoming values in the PHI node...
 540       Values.clear();
 541       Values.reserve(PN->getNumIncomingValues());
 542       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 543         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 544                                         PN->getIncomingValue(i)));
 545       std::sort(Values.begin(), Values.end());
 546
 547       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 548         // Check to make sure that if there is more than one entry for a
 549         // particular basic block in this PHI node, that the incoming values are
 550         // all identical.
 551         //
 552         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 553                 Values[i].second == Values[i-1].second,
 554                 "PHI node has multiple entries for the same basic block with "
 555                 "different incoming values!", PN, Values[i].first,
 556                 Values[i].second, Values[i-1].second);
 557
 558         // Check to make sure that the predecessors and PHI node entries are
 559         // matched up.
 560         Assert3(Values[i].first == Preds[i],
 561                 "PHI node entries do not match predecessors!", PN,
 562                 Values[i].first, Preds[i]);
 563       }
 564     }
 565   }
 566 }
 567
 568 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 569   // Ensure that terminators only exist at the end of the basic block.
 570   Assert1(&I == I.getParent()->getTerminator(),
 571           "Terminator found in the middle of a basic block!", I.getParent());
 572   visitInstruction(I);
 573 }
 574
 575 void Verifier::visitReturnInst(ReturnInst &RI) {
 576   Function *F = RI.getParent()->getParent();
 577   if (RI.getNumOperands() == 0)
 578     Assert2(F->getReturnType() == Type::VoidTy,
 579             "Found return instr that returns void in Function of non-void "
 580             "return type!", &RI, F->getReturnType());
 581   else
 582     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 583             "Function return type does not match operand "
 584             "type of return inst!", &RI, F->getReturnType());
 585
 586   // Check to make sure that the return value has necessary properties for
 587   // terminators...
 588   visitTerminatorInst(RI);
 589 }
 590
 591 void Verifier::visitSwitchInst(SwitchInst &SI) {
 592   // Check to make sure that all of the constants in the switch instruction
 593   // have the same type as the switched-on value.
 594   const Type *SwitchTy = SI.getCondition()->getType();
 595   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 596     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 597             "Switch constants must all be same type as switch value!", &SI);
 598
 599   visitTerminatorInst(SI);
 600 }
 601
 602 void Verifier::visitSelectInst(SelectInst &SI) {
 603   Assert1(SI.getCondition()->getType() == Type::Int1Ty,
 604           "Select condition type must be bool!", &SI);
 605   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 606           "Select values must have identical types!", &SI);
 607   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 608           "Select values must have same type as select instruction!", &SI);
 609   visitInstruction(SI);
 610 }
 611
 612
 613 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 614 /// a pass, if any exist, it's an error.
 615 ///
 616 void Verifier::visitUserOp1(Instruction &I) {
 617   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 618 }
 619
 620 void Verifier::visitTruncInst(TruncInst &I) {
 621   // Get the source and destination types
 622   const Type *SrcTy = I.getOperand(0)->getType();
 623   const Type *DestTy = I.getType();
 624
 625   // Get the size of the types in bits, we'll need this later
 626   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 627   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 628
 629   Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
 630   Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
 631   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 632
 633   visitInstruction(I);
 634 }
 635
 636 void Verifier::visitZExtInst(ZExtInst &I) {
 637   // Get the source and destination types
 638   const Type *SrcTy = I.getOperand(0)->getType();
 639   const Type *DestTy = I.getType();
 640
 641   // Get the size of the types in bits, we'll need this later
 642   Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
 643   Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
 644   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 645   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 646
 647   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 648
 649   visitInstruction(I);
 650 }
 651
 652 void Verifier::visitSExtInst(SExtInst &I) {
 653   // Get the source and destination types
 654   const Type *SrcTy = I.getOperand(0)->getType();
 655   const Type *DestTy = I.getType();
 656
 657   // Get the size of the types in bits, we'll need this later
 658   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 659   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 660
 661   Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
 662   Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
 663   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 664
 665   visitInstruction(I);
 666 }
 667
 668 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 669   // Get the source and destination types
 670   const Type *SrcTy = I.getOperand(0)->getType();
 671   const Type *DestTy = I.getType();
 672   // Get the size of the types in bits, we'll need this later
 673   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 674   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 675
 676   Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
 677   Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
 678   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 679
 680   visitInstruction(I);
 681 }
 682
 683 void Verifier::visitFPExtInst(FPExtInst &I) {
 684   // Get the source and destination types
 685   const Type *SrcTy = I.getOperand(0)->getType();
 686   const Type *DestTy = I.getType();
 687
 688   // Get the size of the types in bits, we'll need this later
 689   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 690   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 691
 692   Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
 693   Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
 694   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 695
 696   visitInstruction(I);
 697 }
 698
 699 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 700   // Get the source and destination types
 701   const Type *SrcTy = I.getOperand(0)->getType();
 702   const Type *DestTy = I.getType();
 703
 704   bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
 705   bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
 706
 707   Assert1(SrcVec == DstVec,"UIToFP source and dest must both be vector or scalar", &I);
 708   Assert1(SrcTy->isIntOrIntVector(),"UIToFP source must be integer or integer vector", &I);
 709   Assert1(DestTy->isFPOrFPVector(),"UIToFP result must be FP or FP vector", &I);
 710
 711   if (SrcVec && DstVec)
 712     Assert1(cast<VectorType>(SrcTy)->getNumElements() == cast<VectorType>(DestTy)->getNumElements(),
 713             "UIToFP source and dest vector length mismatch", &I);
 714
 715   visitInstruction(I);
 716 }
 717
 718 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 719   // Get the source and destination types
 720   const Type *SrcTy = I.getOperand(0)->getType();
 721   const Type *DestTy = I.getType();
 722
 723   bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
 724   bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
 725
 726   Assert1(SrcVec == DstVec,"SIToFP source and dest must both be vector or scalar", &I);
 727   Assert1(SrcTy->isIntOrIntVector(),"SIToFP source must be integer or integer vector", &I);
 728   Assert1(DestTy->isFPOrFPVector(),"SIToFP result must be FP or FP vector", &I);
 729
 730   if (SrcVec && DstVec)
 731     Assert1(cast<VectorType>(SrcTy)->getNumElements() == cast<VectorType>(DestTy)->getNumElements(),
 732             "SIToFP source and dest vector length mismatch", &I);
 733
 734   visitInstruction(I);
 735 }
 736
 737 void Verifier::visitFPToUIInst(FPToUIInst &I) {
 738   // Get the source and destination types
 739   const Type *SrcTy = I.getOperand(0)->getType();
 740   const Type *DestTy = I.getType();
 741
 742   bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
 743   bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
 744
 745   Assert1(SrcVec == DstVec,"FPToUI source and dest must both be vector or scalar", &I);
 746   Assert1(SrcTy->isFPOrFPVector(),"FPToUI source must be FP or FP vector", &I);
 747   Assert1(DestTy->isIntOrIntVector(),"FPToUI result must be integer or integer vector", &I);
 748
 749   if (SrcVec && DstVec)
 750     Assert1(cast<VectorType>(SrcTy)->getNumElements() == cast<VectorType>(DestTy)->getNumElements(),
 751             "FPToUI source and dest vector length mismatch", &I);
 752
 753   visitInstruction(I);
 754 }
 755
 756 void Verifier::visitFPToSIInst(FPToSIInst &I) {
 757   // Get the source and destination types
 758   const Type *SrcTy = I.getOperand(0)->getType();
 759   const Type *DestTy = I.getType();
 760
 761   bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
 762   bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
 763
 764   Assert1(SrcVec == DstVec,"FPToSI source and dest must both be vector or scalar", &I);
 765   Assert1(SrcTy->isFPOrFPVector(),"FPToSI source must be FP or FP vector", &I);
 766   Assert1(DestTy->isIntOrIntVector(),"FPToSI result must be integer or integer vector", &I);
 767
 768   if (SrcVec && DstVec)
 769     Assert1(cast<VectorType>(SrcTy)->getNumElements() == cast<VectorType>(DestTy)->getNumElements(),
 770             "FPToSI source and dest vector length mismatch", &I);
 771
 772   visitInstruction(I);
 773 }
 774
 775 void Verifier::visitPtrToIntInst(PtrToIntInst &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(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
 781   Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
 782
 783   visitInstruction(I);
 784 }
 785
 786 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
 787   // Get the source and destination types
 788   const Type *SrcTy = I.getOperand(0)->getType();
 789   const Type *DestTy = I.getType();
 790
 791   Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
 792   Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
 793
 794   visitInstruction(I);
 795 }
 796
 797 void Verifier::visitBitCastInst(BitCastInst &I) {
 798   // Get the source and destination types
 799   const Type *SrcTy = I.getOperand(0)->getType();
 800   const Type *DestTy = I.getType();
 801
 802   // Get the size of the types in bits, we'll need this later
 803   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 804   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 805
 806   // BitCast implies a no-op cast of type only. No bits change.
 807   // However, you can't cast pointers to anything but pointers.
 808   Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
 809           "Bitcast requires both operands to be pointer or neither", &I);
 810   Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
 811
 812   visitInstruction(I);
 813 }
 814
 815 /// visitPHINode - Ensure that a PHI node is well formed.
 816 ///
 817 void Verifier::visitPHINode(PHINode &PN) {
 818   // Ensure that the PHI nodes are all grouped together at the top of the block.
 819   // This can be tested by checking whether the instruction before this is
 820   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 821   // then there is some other instruction before a PHI.
 822   Assert2(&PN == &PN.getParent()->front() ||
 823           isa<PHINode>(--BasicBlock::iterator(&PN)),
 824           "PHI nodes not grouped at top of basic block!",
 825           &PN, PN.getParent());
 826
 827   // Check that all of the operands of the PHI node have the same type as the
 828   // result.
 829   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 830     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 831             "PHI node operands are not the same type as the result!", &PN);
 832
 833   // All other PHI node constraints are checked in the visitBasicBlock method.
 834
 835   visitInstruction(PN);
 836 }
 837
 838 void Verifier::VerifyCallSite(CallSite CS) {
 839   Instruction *I = CS.getInstruction();
 840
 841   Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
 842           "Called function must be a pointer!", I);
 843   const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
 844   Assert1(isa<FunctionType>(FPTy->getElementType()),
 845           "Called function is not pointer to function type!", I);
 846
 847   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 848
 849   // Verify that the correct number of arguments are being passed
 850   if (FTy->isVarArg())
 851     Assert1(CS.arg_size() >= FTy->getNumParams(),
 852             "Called function requires more parameters than were provided!",I);
 853   else
 854     Assert1(CS.arg_size() == FTy->getNumParams(),
 855             "Incorrect number of arguments passed to called function!", I);
 856
 857   // Verify that all arguments to the call match the function type...
 858   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 859     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
 860             "Call parameter type does not match function signature!",
 861             CS.getArgument(i), FTy->getParamType(i), I);
 862
 863   // Verify call attributes.
 864   VerifyParamAttrs(FTy, CS.getParamAttrs(), I);
 865
 866   visitInstruction(*I);
 867 }
 868
 869 void Verifier::visitCallInst(CallInst &CI) {
 870   VerifyCallSite(&CI);
 871
 872   if (Function *F = CI.getCalledFunction()) {
 873     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 874       visitIntrinsicFunctionCall(ID, CI);
 875   }
 876 }
 877
 878 void Verifier::visitInvokeInst(InvokeInst &II) {
 879   VerifyCallSite(&II);
 880 }
 881
 882 /// visitBinaryOperator - Check that both arguments to the binary operator are
 883 /// of the same type!
 884 ///
 885 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 886   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 887           "Both operands to a binary operator are not of the same type!", &B);
 888
 889   switch (B.getOpcode()) {
 890   // Check that logical operators are only used with integral operands.
 891   case Instruction::And:
 892   case Instruction::Or:
 893   case Instruction::Xor:
 894     Assert1(B.getType()->isInteger() ||
 895             (isa<VectorType>(B.getType()) &&
 896              cast<VectorType>(B.getType())->getElementType()->isInteger()),
 897             "Logical operators only work with integral types!", &B);
 898     Assert1(B.getType() == B.getOperand(0)->getType(),
 899             "Logical operators must have same type for operands and result!",
 900             &B);
 901     break;
 902   case Instruction::Shl:
 903   case Instruction::LShr:
 904   case Instruction::AShr:
 905     Assert1(B.getType()->isInteger(),
 906             "Shift must return an integer result!", &B);
 907     Assert1(B.getType() == B.getOperand(0)->getType(),
 908             "Shift return type must be same as operands!", &B);
 909     /* FALL THROUGH */
 910   default:
 911     // Arithmetic operators only work on integer or fp values
 912     Assert1(B.getType() == B.getOperand(0)->getType(),
 913             "Arithmetic operators must have same type for operands and result!",
 914             &B);
 915     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 916             isa<VectorType>(B.getType()),
 917             "Arithmetic operators must have integer, fp, or vector type!", &B);
 918     break;
 919   }
 920
 921   visitInstruction(B);
 922 }
 923
 924 void Verifier::visitICmpInst(ICmpInst& IC) {
 925   // Check that the operands are the same type
 926   const Type* Op0Ty = IC.getOperand(0)->getType();
 927   const Type* Op1Ty = IC.getOperand(1)->getType();
 928   Assert1(Op0Ty == Op1Ty,
 929           "Both operands to ICmp instruction are not of the same type!", &IC);
 930   // Check that the operands are the right type
 931   Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
 932           "Invalid operand types for ICmp instruction", &IC);
 933   visitInstruction(IC);
 934 }
 935
 936 void Verifier::visitFCmpInst(FCmpInst& FC) {
 937   // Check that the operands are the same type
 938   const Type* Op0Ty = FC.getOperand(0)->getType();
 939   const Type* Op1Ty = FC.getOperand(1)->getType();
 940   Assert1(Op0Ty == Op1Ty,
 941           "Both operands to FCmp instruction are not of the same type!", &FC);
 942   // Check that the operands are the right type
 943   Assert1(Op0Ty->isFloatingPoint(),
 944           "Invalid operand types for FCmp instruction", &FC);
 945   visitInstruction(FC);
 946 }
 947
 948 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
 949   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
 950                                               EI.getOperand(1)),
 951           "Invalid extractelement operands!", &EI);
 952   visitInstruction(EI);
 953 }
 954
 955 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
 956   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
 957                                              IE.getOperand(1),
 958                                              IE.getOperand(2)),
 959           "Invalid insertelement operands!", &IE);
 960   visitInstruction(IE);
 961 }
 962
 963 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
 964   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
 965                                              SV.getOperand(2)),
 966           "Invalid shufflevector operands!", &SV);
 967   Assert1(SV.getType() == SV.getOperand(0)->getType(),
 968           "Result of shufflevector must match first operand type!", &SV);
 969
 970   // Check to see if Mask is valid.
 971   if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
 972     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
 973       Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
 974               isa<UndefValue>(MV->getOperand(i)),
 975               "Invalid shufflevector shuffle mask!", &SV);
 976     }
 977   } else {
 978     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
 979             isa<ConstantAggregateZero>(SV.getOperand(2)),
 980             "Invalid shufflevector shuffle mask!", &SV);
 981   }
 982
 983   visitInstruction(SV);
 984 }
 985
 986 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 987   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
 988   const Type *ElTy =
 989     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 990                                       Idxs.begin(), Idxs.end(), true);
 991   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 992   Assert2(isa<PointerType>(GEP.getType()) &&
 993           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
 994           "GEP is not of right type for indices!", &GEP, ElTy);
 995   visitInstruction(GEP);
 996 }
 997
 998 void Verifier::visitLoadInst(LoadInst &LI) {
 999   const Type *ElTy =
1000     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1001   Assert2(ElTy == LI.getType(),
1002           "Load result type does not match pointer operand type!", &LI, ElTy);
1003   visitInstruction(LI);
1004 }
1005
1006 void Verifier::visitStoreInst(StoreInst &SI) {
1007   const Type *ElTy =
1008     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1009   Assert2(ElTy == SI.getOperand(0)->getType(),
1010           "Stored value type does not match pointer operand type!", &SI, ElTy);
1011   visitInstruction(SI);
1012 }
1013
1014 void Verifier::visitAllocationInst(AllocationInst &AI) {
1015   const PointerType *Ptr = AI.getType();
1016   Assert(Ptr->getAddressSpace() == 0,
1017     "Allocation instruction pointer not in the generic address space!");
1018   visitInstruction(AI);
1019 }
1020
1021
1022 /// verifyInstruction - Verify that an instruction is well formed.
1023 ///
1024 void Verifier::visitInstruction(Instruction &I) {
1025   BasicBlock *BB = I.getParent();
1026   Assert1(BB, "Instruction not embedded in basic block!", &I);
1027
1028   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
1029     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1030          UI != UE; ++UI)
1031       Assert1(*UI != (User*)&I ||
1032               !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1033               "Only PHI nodes may reference their own value!", &I);
1034   }
1035
1036   // Check that void typed values don't have names
1037   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1038           "Instruction has a name, but provides a void value!", &I);
1039
1040   // Check that the return value of the instruction is either void or a legal
1041   // value type.
1042   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
1043           "Instruction returns a non-scalar type!", &I);
1044
1045   // Check that all uses of the instruction, if they are instructions
1046   // themselves, actually have parent basic blocks.  If the use is not an
1047   // instruction, it is an error!
1048   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1049        UI != UE; ++UI) {
1050     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1051             *UI);
1052     Instruction *Used = cast<Instruction>(*UI);
1053     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1054             " embeded in a basic block!", &I, Used);
1055   }
1056
1057   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1058     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1059
1060     // Check to make sure that only first-class-values are operands to
1061     // instructions.
1062     Assert1(I.getOperand(i)->getType()->isFirstClassType(),
1063             "Instruction operands must be first-class values!", &I);
1064
1065     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1066       // Check to make sure that the "address of" an intrinsic function is never
1067       // taken.
1068       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1069               "Cannot take the address of an intrinsic!", &I);
1070       Assert1(F->getParent() == Mod, "Referencing function in another module!",
1071               &I);
1072     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1073       Assert1(OpBB->getParent() == BB->getParent(),
1074               "Referring to a basic block in another function!", &I);
1075     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1076       Assert1(OpArg->getParent() == BB->getParent(),
1077               "Referring to an argument in another function!", &I);
1078     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1079       Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1080               &I);
1081     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1082       BasicBlock *OpBlock = Op->getParent();
1083
1084       // Check that a definition dominates all of its uses.
1085       if (!isa<PHINode>(I)) {
1086         // Invoke results are only usable in the normal destination, not in the
1087         // exceptional destination.
1088         if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1089           OpBlock = II->getNormalDest();
1090
1091           Assert2(OpBlock != II->getUnwindDest(),
1092                   "No uses of invoke possible due to dominance structure!",
1093                   Op, II);
1094
1095           // If the normal successor of an invoke instruction has multiple
1096           // predecessors, then the normal edge from the invoke is critical, so
1097           // the invoke value can only be live if the destination block
1098           // dominates all of it's predecessors (other than the invoke) or if
1099           // the invoke value is only used by a phi in the successor.
1100           if (!OpBlock->getSinglePredecessor() &&
1101               DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1102             // The first case we allow is if the use is a PHI operand in the
1103             // normal block, and if that PHI operand corresponds to the invoke's
1104             // block.
1105             bool Bad = true;
1106             if (PHINode *PN = dyn_cast<PHINode>(&I))
1107               if (PN->getParent() == OpBlock &&
1108                   PN->getIncomingBlock(i/2) == Op->getParent())
1109                 Bad = false;
1110
1111             // If it is used by something non-phi, then the other case is that
1112             // 'OpBlock' dominates all of its predecessors other than the
1113             // invoke.  In this case, the invoke value can still be used.
1114             if (Bad) {
1115               Bad = false;
1116               for (pred_iterator PI = pred_begin(OpBlock),
1117                    E = pred_end(OpBlock); PI != E; ++PI) {
1118                 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1119                   Bad = true;
1120                   break;
1121                 }
1122               }
1123             }
1124             Assert2(!Bad,
1125                     "Invoke value defined on critical edge but not dead!", &I,
1126                     Op);
1127           }
1128         } else if (OpBlock == BB) {
1129           // If they are in the same basic block, make sure that the definition
1130           // comes before the use.
1131           Assert2(InstsInThisBlock.count(Op) ||
1132                   !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1133                   "Instruction does not dominate all uses!", Op, &I);
1134         }
1135
1136         // Definition must dominate use unless use is unreachable!
1137         Assert2(DT->dominates(OpBlock, BB) ||
1138                 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1139                 "Instruction does not dominate all uses!", Op, &I);
1140       } else {
1141         // PHI nodes are more difficult than other nodes because they actually
1142         // "use" the value in the predecessor basic blocks they correspond to.
1143         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1144         Assert2(DT->dominates(OpBlock, PredBB) ||
1145                 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1146                 "Instruction does not dominate all uses!", Op, &I);
1147       }
1148     } else if (isa<InlineAsm>(I.getOperand(i))) {
1149       Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1150               "Cannot take the address of an inline asm!", &I);
1151     }
1152   }
1153   InstsInThisBlock.insert(&I);
1154 }
1155
1156 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1157 ///
1158 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1159   Function *IF = CI.getCalledFunction();
1160   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1161           IF);
1162
1163 #define GET_INTRINSIC_VERIFIER
1164 #include "llvm/Intrinsics.gen"
1165 #undef GET_INTRINSIC_VERIFIER
1166
1167   switch (ID) {
1168   default:
1169     break;
1170   case Intrinsic::gcroot: {
1171       Type *PtrTy    = PointerType::getUnqual(Type::Int8Ty),
1172            *PtrPtrTy = PointerType::getUnqual(PtrTy);
1173       Assert1(CI.getOperand(1)->getType() == PtrPtrTy,
1174               "Intrinsic parameter #1 is not i8**.", &CI);
1175       Assert1(CI.getOperand(2)->getType() == PtrTy,
1176               "Intrinsic parameter #2 is not i8*.", &CI);
1177       Assert1(
1178             isa<AllocaInst>(IntrinsicInst::StripPointerCasts(CI.getOperand(1))),
1179             "llvm.gcroot parameter #1 must be an alloca.",
1180               &CI);
1181       Assert1(isa<Constant>(CI.getOperand(2)),
1182               "llvm.gcroot parameter #2 must be a constant.", &CI);
1183     } break;
1184   case Intrinsic::gcwrite: {
1185       Type *PtrTy    = PointerType::getUnqual(Type::Int8Ty),
1186            *PtrPtrTy = PointerType::getUnqual(PtrTy);
1187       Assert1(CI.getOperand(1)->getType() == PtrTy,
1188               "Intrinsic parameter #1 is not a i8*.", &CI);
1189       Assert1(CI.getOperand(2)->getType() == PtrTy,
1190               "Intrinsic parameter #2 is not a i8*.", &CI);
1191       Assert1(CI.getOperand(3)->getType() == PtrPtrTy,
1192               "Intrinsic parameter #3 is not a i8**.", &CI);
1193     } break;
1194   case Intrinsic::gcread: {
1195       Type *PtrTy    = PointerType::getUnqual(Type::Int8Ty),
1196            *PtrPtrTy = PointerType::getUnqual(PtrTy);
1197       Assert1(CI.getOperand(1)->getType() == PtrTy,
1198               "Intrinsic parameter #1 is not a i8*.", &CI);
1199       Assert1(CI.getOperand(2)->getType() == PtrPtrTy,
1200               "Intrinsic parameter #2 is not a i8**.", &CI);
1201     } break;
1202   case Intrinsic::init_trampoline:
1203     Assert1(isa<Function>(IntrinsicInst::StripPointerCasts(CI.getOperand(2))),
1204             "llvm.init_trampoline parameter #2 must resolve to a function.",
1205             &CI);
1206     break;
1207   }
1208 }
1209
1210 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1211 /// Intrinsics.gen.  This implements a little state machine that verifies the
1212 /// prototype of intrinsics.
1213 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID,
1214                                         Function *F,
1215                                         unsigned Count, ...) {
1216   va_list VA;
1217   va_start(VA, Count);
1218
1219   const FunctionType *FTy = F->getFunctionType();
1220
1221   // For overloaded intrinsics, the Suffix of the function name must match the
1222   // types of the arguments. This variable keeps track of the expected
1223   // suffix, to be checked at the end.
1224   std::string Suffix;
1225
1226   if (FTy->getNumParams() + FTy->isVarArg() != Count - 1) {
1227     CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1228     return;
1229   }
1230
1231   // Note that "arg#0" is the return type.
1232   for (unsigned ArgNo = 0; ArgNo < Count; ++ArgNo) {
1233     MVT::ValueType VT = va_arg(VA, MVT::ValueType);
1234
1235     if (VT == MVT::isVoid && ArgNo > 0) {
1236       if (!FTy->isVarArg())
1237         CheckFailed("Intrinsic prototype has no '...'!", F);
1238       break;
1239     }
1240
1241     const Type *Ty;
1242     if (ArgNo == 0)
1243       Ty = FTy->getReturnType();
1244     else
1245       Ty = FTy->getParamType(ArgNo-1);
1246
1247     unsigned NumElts = 0;
1248     const Type *EltTy = Ty;
1249     if (const VectorType *VTy = dyn_cast<VectorType>(Ty)) {
1250       EltTy = VTy->getElementType();
1251       NumElts = VTy->getNumElements();
1252     }
1253
1254     if ((int)VT < 0) {
1255       int Match = ~VT;
1256       if (Match == 0) {
1257         if (Ty != FTy->getReturnType()) {
1258           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1259                       "match return type.", F);
1260           break;
1261         }
1262       } else {
1263         if (Ty != FTy->getParamType(Match-1)) {
1264           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1265                       "match parameter %" + utostr(Match-1) + ".", F);
1266           break;
1267         }
1268       }
1269     } else if (VT == MVT::iAny) {
1270       if (!EltTy->isInteger()) {
1271         if (ArgNo == 0)
1272           CheckFailed("Intrinsic result type is not "
1273                       "an integer type.", F);
1274         else
1275           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1276                       "an integer type.", F);
1277         break;
1278       }
1279       unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1280       Suffix += ".";
1281       if (EltTy != Ty)
1282         Suffix += "v" + utostr(NumElts);
1283       Suffix += "i" + utostr(GotBits);;
1284       // Check some constraints on various intrinsics.
1285       switch (ID) {
1286         default: break; // Not everything needs to be checked.
1287         case Intrinsic::bswap:
1288           if (GotBits < 16 || GotBits % 16 != 0)
1289             CheckFailed("Intrinsic requires even byte width argument", F);
1290           break;
1291       }
1292     } else if (VT == MVT::fAny) {
1293       if (!EltTy->isFloatingPoint()) {
1294         if (ArgNo == 0)
1295           CheckFailed("Intrinsic result type is not "
1296                       "a floating-point type.", F);
1297         else
1298           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1299                       "a floating-point type.", F);
1300         break;
1301       }
1302       Suffix += ".";
1303       if (EltTy != Ty)
1304         Suffix += "v" + utostr(NumElts);
1305       Suffix += MVT::getValueTypeString(MVT::getValueType(EltTy));
1306     } else if (VT == MVT::iPTR) {
1307       if (!isa<PointerType>(Ty)) {
1308         if (ArgNo == 0)
1309           CheckFailed("Intrinsic result type is not a "
1310                       "pointer and a pointer is required.", F);
1311         else
1312           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not a "
1313                       "pointer and a pointer is required.", F);
1314         break;
1315       }
1316     } else if (MVT::isVector(VT)) {
1317       // If this is a vector argument, verify the number and type of elements.
1318       if (MVT::getVectorElementType(VT) != MVT::getValueType(EltTy)) {
1319         CheckFailed("Intrinsic prototype has incorrect vector element type!",
1320                     F);
1321         break;
1322       }
1323       if (MVT::getVectorNumElements(VT) != NumElts) {
1324         CheckFailed("Intrinsic prototype has incorrect number of "
1325                     "vector elements!",F);
1326         break;
1327       }
1328     } else if (MVT::getTypeForValueType(VT) != EltTy) {
1329       if (ArgNo == 0)
1330         CheckFailed("Intrinsic prototype has incorrect result type!", F);
1331       else
1332         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1333       break;
1334     } else if (EltTy != Ty) {
1335       if (ArgNo == 0)
1336         CheckFailed("Intrinsic result type is vector "
1337                     "and a scalar is required.", F);
1338       else
1339         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is vector "
1340                     "and a scalar is required.", F);
1341     }
1342   }
1343
1344   va_end(VA);
1345
1346   // If we computed a Suffix then the intrinsic is overloaded and we need to
1347   // make sure that the name of the function is correct. We add the suffix to
1348   // the name of the intrinsic and compare against the given function name. If
1349   // they are not the same, the function name is invalid. This ensures that
1350   // overloading of intrinsics uses a sane and consistent naming convention.
1351   if (!Suffix.empty()) {
1352     std::string Name(Intrinsic::getName(ID));
1353     if (Name + Suffix != F->getName())
1354       CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1355                   F->getName().substr(Name.length()) + "'. It should be '" +
1356                   Suffix + "'", F);
1357   }
1358 }
1359
1360
1361 //===----------------------------------------------------------------------===//
1362 //  Implement the public interfaces to this file...
1363 //===----------------------------------------------------------------------===//
1364
1365 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1366   return new Verifier(action);
1367 }
1368
1369
1370 // verifyFunction - Create
1371 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1372   Function &F = const_cast<Function&>(f);
1373   assert(!F.isDeclaration() && "Cannot verify external functions");
1374
1375   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1376   Verifier *V = new Verifier(action);
1377   FPM.add(V);
1378   FPM.run(F);
1379   return V->Broken;
1380 }
1381
1382 /// verifyModule - Check a module for errors, printing messages on stderr.
1383 /// Return true if the module is corrupt.
1384 ///
1385 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1386                         std::string *ErrorInfo) {
1387   PassManager PM;
1388   Verifier *V = new Verifier(action);
1389   PM.add(V);
1390   PM.run((Module&)M);
1391
1392   if (ErrorInfo && V->Broken)
1393     *ErrorInfo = V->msgs.str();
1394   return V->Broken;
1395 }
1396
1397 // vim: sw=2