lib/VMCore/Verifier.cpp

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