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