lib/VMCore/Verifier.cpp

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