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