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