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