lib/VMCore/Verifier.cpp

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