lib/VMCore/Verifier.cpp

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