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