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