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