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/Constants.h"
  45 #include "llvm/Pass.h"
  46 #include "llvm/Module.h"
  47 #include "llvm/ModuleProvider.h"
  48 #include "llvm/DerivedTypes.h"
  49 #include "llvm/Instructions.h"
  50 #include "llvm/Intrinsics.h"
  51 #include "llvm/PassManager.h"
  52 #include "llvm/SymbolTable.h"
  53 #include "llvm/Analysis/Dominators.h"
  54 #include "llvm/Support/CFG.h"
  55 #include "llvm/Support/InstVisitor.h"
  56 #include "llvm/ADT/STLExtras.h"
  57 #include <algorithm>
  58 #include <iostream>
  59 #include <sstream>
  60 using namespace llvm;
  61
  62 namespace {  // Anonymous namespace for class
  63
  64   struct Verifier : public FunctionPass, InstVisitor<Verifier> {
  65     bool Broken;          // Is this module found to be broken?
  66     bool RealPass;        // Are we not being run by a PassManager?
  67     VerifierFailureAction action;
  68                           // What to do if verification fails.
  69     Module *Mod;          // Module we are verifying right now
  70     DominatorSet *DS;     // Dominator set, caution can be null!
  71     std::stringstream msgs;  // A stringstream to collect messages
  72
  73     /// InstInThisBlock - when verifying a basic block, keep track of all of the
  74     /// instructions we have seen so far.  This allows us to do efficient
  75     /// dominance checks for the case when an instruction has an operand that is
  76     /// an instruction in the same block.
  77     std::set<Instruction*> InstsInThisBlock;
  78
  79     Verifier()
  80         : Broken(false), RealPass(true), action(AbortProcessAction),
  81           DS(0), msgs( std::ios::app | std::ios::out ) {}
  82     Verifier( VerifierFailureAction ctn )
  83         : Broken(false), RealPass(true), action(ctn), DS(0),
  84           msgs( std::ios::app | std::ios::out ) {}
  85     Verifier(bool AB )
  86         : Broken(false), RealPass(true),
  87           action( AB ? AbortProcessAction : PrintMessageAction), DS(0),
  88           msgs( std::ios::app | std::ios::out ) {}
  89     Verifier(DominatorSet &ds)
  90       : Broken(false), RealPass(false), action(PrintMessageAction),
  91         DS(&ds), msgs( std::ios::app | std::ios::out ) {}
  92
  93
  94     bool doInitialization(Module &M) {
  95       Mod = &M;
  96       verifySymbolTable(M.getSymbolTable());
  97
  98       // If this is a real pass, in a pass manager, we must abort before
  99       // returning back to the pass manager, or else the pass manager may try to
 100       // run other passes on the broken module.
 101       if (RealPass)
 102         abortIfBroken();
 103       return false;
 104     }
 105
 106     bool runOnFunction(Function &F) {
 107       // Get dominator information if we are being run by PassManager
 108       if (RealPass) DS = &getAnalysis<DominatorSet>();
 109       visit(F);
 110       InstsInThisBlock.clear();
 111
 112       // If this is a real pass, in a pass manager, we must abort before
 113       // returning back to the pass manager, or else the pass manager may try to
 114       // run other passes on the broken module.
 115       if (RealPass)
 116         abortIfBroken();
 117
 118       return false;
 119     }
 120
 121     bool doFinalization(Module &M) {
 122       // Scan through, checking all of the external function's linkage now...
 123       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 124         visitGlobalValue(*I);
 125
 126         // Check to make sure function prototypes are okay.
 127         if (I->isExternal()) visitFunction(*I);
 128       }
 129
 130       for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
 131         visitGlobalVariable(*I);
 132
 133       // If the module is broken, abort at this time.
 134       abortIfBroken();
 135       return false;
 136     }
 137
 138     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 139       AU.setPreservesAll();
 140       if (RealPass)
 141         AU.addRequired<DominatorSet>();
 142     }
 143
 144     /// abortIfBroken - If the module is broken and we are supposed to abort on
 145     /// this condition, do so.
 146     ///
 147     void abortIfBroken() {
 148       if (Broken)
 149       {
 150         msgs << "Broken module found, ";
 151         switch (action)
 152         {
 153           case AbortProcessAction:
 154             msgs << "compilation aborted!\n";
 155             std::cerr << msgs.str();
 156             abort();
 157           case ThrowExceptionAction:
 158             msgs << "verification terminated.\n";
 159             throw msgs.str();
 160           case PrintMessageAction:
 161             msgs << "verification continues.\n";
 162             std::cerr << msgs.str();
 163             break;
 164           case ReturnStatusAction:
 165             break;
 166         }
 167       }
 168     }
 169
 170
 171     // Verification methods...
 172     void verifySymbolTable(SymbolTable &ST);
 173     void visitGlobalValue(GlobalValue &GV);
 174     void visitGlobalVariable(GlobalVariable &GV);
 175     void visitFunction(Function &F);
 176     void visitBasicBlock(BasicBlock &BB);
 177     void visitPHINode(PHINode &PN);
 178     void visitBinaryOperator(BinaryOperator &B);
 179     void visitShiftInst(ShiftInst &SI);
 180     void visitVANextInst(VANextInst &VAN) { visitInstruction(VAN); }
 181     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 182     void visitCallInst(CallInst &CI);
 183     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 184     void visitLoadInst(LoadInst &LI);
 185     void visitStoreInst(StoreInst &SI);
 186     void visitInstruction(Instruction &I);
 187     void visitTerminatorInst(TerminatorInst &I);
 188     void visitReturnInst(ReturnInst &RI);
 189     void visitSwitchInst(SwitchInst &SI);
 190     void visitSelectInst(SelectInst &SI);
 191     void visitUserOp1(Instruction &I);
 192     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 193     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 194
 195
 196     void WriteValue(const Value *V) {
 197       if (!V) return;
 198       if (isa<Instruction>(V)) {
 199         msgs << *V;
 200       } else {
 201         WriteAsOperand (msgs, V, true, true, Mod);
 202         msgs << "\n";
 203       }
 204     }
 205
 206     void WriteType(const Type* T ) {
 207       if ( !T ) return;
 208       WriteTypeSymbolic(msgs, T, Mod );
 209     }
 210
 211
 212     // CheckFailed - A check failed, so print out the condition and the message
 213     // that failed.  This provides a nice place to put a breakpoint if you want
 214     // to see why something is not correct.
 215     void CheckFailed(const std::string &Message,
 216                      const Value *V1 = 0, const Value *V2 = 0,
 217                      const Value *V3 = 0, const Value *V4 = 0) {
 218       msgs << Message << "\n";
 219       WriteValue(V1);
 220       WriteValue(V2);
 221       WriteValue(V3);
 222       WriteValue(V4);
 223       Broken = true;
 224     }
 225
 226     void CheckFailed( const std::string& Message, const Value* V1,
 227                       const Type* T2, const Value* V3 = 0 ) {
 228       msgs << Message << "\n";
 229       WriteValue(V1);
 230       WriteType(T2);
 231       WriteValue(V3);
 232       Broken = true;
 233     }
 234   };
 235
 236   RegisterOpt<Verifier> X("verify", "Module Verifier");
 237 } // End anonymous namespace
 238
 239
 240 // Assert - We know that cond should be true, if not print an error message.
 241 #define Assert(C, M) \
 242   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 243 #define Assert1(C, M, V1) \
 244   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 245 #define Assert2(C, M, V1, V2) \
 246   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 247 #define Assert3(C, M, V1, V2, V3) \
 248   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 249 #define Assert4(C, M, V1, V2, V3, V4) \
 250   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 251
 252
 253 void Verifier::visitGlobalValue(GlobalValue &GV) {
 254   Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
 255           "Global is external, but doesn't have external linkage!", &GV);
 256   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 257           "Only global variables can have appending linkage!", &GV);
 258
 259   if (GV.hasAppendingLinkage()) {
 260     GlobalVariable &GVar = cast<GlobalVariable>(GV);
 261     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
 262             "Only global arrays can have appending linkage!", &GV);
 263   }
 264 }
 265
 266 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 267   if (GV.hasInitializer())
 268     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 269             "Global variable initializer type does not match global "
 270             "variable type!", &GV);
 271
 272   visitGlobalValue(GV);
 273 }
 274
 275
 276 // verifySymbolTable - Verify that a function or module symbol table is ok
 277 //
 278 void Verifier::verifySymbolTable(SymbolTable &ST) {
 279
 280   // Loop over all of the values in all type planes in the symbol table.
 281   for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
 282        PE = ST.plane_end(); PI != PE; ++PI)
 283     for (SymbolTable::value_const_iterator VI = PI->second.begin(),
 284          VE = PI->second.end(); VI != VE; ++VI) {
 285       Value *V = VI->second;
 286       // Check that there are no void typed values in the symbol table.  Values
 287       // with a void type cannot be put into symbol tables because they cannot
 288       // have names!
 289       Assert1(V->getType() != Type::VoidTy,
 290         "Values with void type are not allowed to have names!", V);
 291     }
 292 }
 293
 294 // visitFunction - Verify that a function is ok.
 295 //
 296 void Verifier::visitFunction(Function &F) {
 297   // Check function arguments...
 298   const FunctionType *FT = F.getFunctionType();
 299   unsigned NumArgs = F.getArgumentList().size();
 300
 301   Assert2(FT->getNumParams() == NumArgs,
 302           "# formal arguments must match # of arguments for function type!",
 303           &F, FT);
 304   Assert1(F.getReturnType()->isFirstClassType() ||
 305           F.getReturnType() == Type::VoidTy,
 306           "Functions cannot return aggregate values!", &F);
 307
 308   // Check that the argument values match the function type for this function...
 309   unsigned i = 0;
 310   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I, ++i) {
 311     Assert2(I->getType() == FT->getParamType(i),
 312             "Argument value does not match function argument type!",
 313             I, FT->getParamType(i));
 314     // Make sure no aggregates are passed by value.
 315     Assert1(I->getType()->isFirstClassType(),
 316             "Functions cannot take aggregates as arguments by value!", I);
 317    }
 318
 319   if (!F.isExternal()) {
 320     verifySymbolTable(F.getSymbolTable());
 321
 322     // Check the entry node
 323     BasicBlock *Entry = &F.getEntryBlock();
 324     Assert1(pred_begin(Entry) == pred_end(Entry),
 325             "Entry block to function must not have predecessors!", Entry);
 326   }
 327 }
 328
 329
 330 // verifyBasicBlock - Verify that a basic block is well formed...
 331 //
 332 void Verifier::visitBasicBlock(BasicBlock &BB) {
 333   InstsInThisBlock.clear();
 334
 335   // Ensure that basic blocks have terminators!
 336   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 337
 338   // Check constraints that this basic block imposes on all of the PHI nodes in
 339   // it.
 340   if (isa<PHINode>(BB.front())) {
 341     std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
 342     std::sort(Preds.begin(), Preds.end());
 343     PHINode *PN;
 344     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 345
 346       // Ensure that PHI nodes have at least one entry!
 347       Assert1(PN->getNumIncomingValues() != 0,
 348               "PHI nodes must have at least one entry.  If the block is dead, "
 349               "the PHI should be removed!", PN);
 350       Assert1(PN->getNumIncomingValues() == Preds.size(),
 351               "PHINode should have one entry for each predecessor of its "
 352               "parent basic block!", PN);
 353
 354       // Get and sort all incoming values in the PHI node...
 355       std::vector<std::pair<BasicBlock*, Value*> > Values;
 356       Values.reserve(PN->getNumIncomingValues());
 357       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 358         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 359                                         PN->getIncomingValue(i)));
 360       std::sort(Values.begin(), Values.end());
 361
 362       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 363         // Check to make sure that if there is more than one entry for a
 364         // particular basic block in this PHI node, that the incoming values are
 365         // all identical.
 366         //
 367         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 368                 Values[i].second == Values[i-1].second,
 369                 "PHI node has multiple entries for the same basic block with "
 370                 "different incoming values!", PN, Values[i].first,
 371                 Values[i].second, Values[i-1].second);
 372
 373         // Check to make sure that the predecessors and PHI node entries are
 374         // matched up.
 375         Assert3(Values[i].first == Preds[i],
 376                 "PHI node entries do not match predecessors!", PN,
 377                 Values[i].first, Preds[i]);
 378       }
 379     }
 380   }
 381 }
 382
 383 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 384   // Ensure that terminators only exist at the end of the basic block.
 385   Assert1(&I == I.getParent()->getTerminator(),
 386           "Terminator found in the middle of a basic block!", I.getParent());
 387   visitInstruction(I);
 388 }
 389
 390 void Verifier::visitReturnInst(ReturnInst &RI) {
 391   Function *F = RI.getParent()->getParent();
 392   if (RI.getNumOperands() == 0)
 393     Assert2(F->getReturnType() == Type::VoidTy,
 394             "Found return instr that returns void in Function of non-void "
 395             "return type!", &RI, F->getReturnType());
 396   else
 397     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 398             "Function return type does not match operand "
 399             "type of return inst!", &RI, F->getReturnType());
 400
 401   // Check to make sure that the return value has necessary properties for
 402   // terminators...
 403   visitTerminatorInst(RI);
 404 }
 405
 406 void Verifier::visitSwitchInst(SwitchInst &SI) {
 407   // Check to make sure that all of the constants in the switch instruction
 408   // have the same type as the switched-on value.
 409   const Type *SwitchTy = SI.getCondition()->getType();
 410   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 411     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 412             "Switch constants must all be same type as switch value!", &SI);
 413
 414   visitTerminatorInst(SI);
 415 }
 416
 417 void Verifier::visitSelectInst(SelectInst &SI) {
 418   Assert1(SI.getCondition()->getType() == Type::BoolTy,
 419           "Select condition type must be bool!", &SI);
 420   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 421           "Select values must have identical types!", &SI);
 422   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 423           "Select values must have same type as select instruction!", &SI);
 424   visitInstruction(SI);
 425 }
 426
 427
 428 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 429 /// a pass, if any exist, it's an error.
 430 ///
 431 void Verifier::visitUserOp1(Instruction &I) {
 432   Assert1(0, "User-defined operators should not live outside of a pass!",
 433           &I);
 434 }
 435
 436 /// visitPHINode - Ensure that a PHI node is well formed.
 437 ///
 438 void Verifier::visitPHINode(PHINode &PN) {
 439   // Ensure that the PHI nodes are all grouped together at the top of the block.
 440   // This can be tested by checking whether the instruction before this is
 441   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 442   // then there is some other instruction before a PHI.
 443   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
 444           "PHI nodes not grouped at top of basic block!",
 445           &PN, PN.getParent());
 446
 447   // Check that all of the operands of the PHI node have the same type as the
 448   // result.
 449   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 450     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 451             "PHI node operands are not the same type as the result!", &PN);
 452
 453   // All other PHI node constraints are checked in the visitBasicBlock method.
 454
 455   visitInstruction(PN);
 456 }
 457
 458 void Verifier::visitCallInst(CallInst &CI) {
 459   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 460           "Called function must be a pointer!", &CI);
 461   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 462   Assert1(isa<FunctionType>(FPTy->getElementType()),
 463           "Called function is not pointer to function type!", &CI);
 464
 465   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 466
 467   // Verify that the correct number of arguments are being passed
 468   if (FTy->isVarArg())
 469     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 470             "Called function requires more parameters than were provided!",&CI);
 471   else
 472     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 473             "Incorrect number of arguments passed to called function!", &CI);
 474
 475   // Verify that all arguments to the call match the function type...
 476   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 477     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 478             "Call parameter type does not match function signature!",
 479             CI.getOperand(i+1), FTy->getParamType(i), &CI);
 480
 481   if (Function *F = CI.getCalledFunction())
 482     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 483       visitIntrinsicFunctionCall(ID, CI);
 484
 485   visitInstruction(CI);
 486 }
 487
 488 /// visitBinaryOperator - Check that both arguments to the binary operator are
 489 /// of the same type!
 490 ///
 491 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 492   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 493           "Both operands to a binary operator are not of the same type!", &B);
 494
 495   // Check that logical operators are only used with integral operands.
 496   if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
 497       B.getOpcode() == Instruction::Xor) {
 498     Assert1(B.getType()->isIntegral(),
 499             "Logical operators only work with integral types!", &B);
 500     Assert1(B.getType() == B.getOperand(0)->getType(),
 501             "Logical operators must have same type for operands and result!",
 502             &B);
 503   } else if (isa<SetCondInst>(B)) {
 504     // Check that setcc instructions return bool
 505     Assert1(B.getType() == Type::BoolTy,
 506             "setcc instructions must return boolean values!", &B);
 507   } else {
 508     // Arithmetic operators only work on integer or fp values
 509     Assert1(B.getType() == B.getOperand(0)->getType(),
 510             "Arithmetic operators must have same type for operands and result!",
 511             &B);
 512     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 513             isa<PackedType>(B.getType()),
 514             "Arithmetic operators must have integer, fp, or packed type!", &B);
 515   }
 516
 517   visitInstruction(B);
 518 }
 519
 520 void Verifier::visitShiftInst(ShiftInst &SI) {
 521   Assert1(SI.getType()->isInteger(),
 522           "Shift must return an integer result!", &SI);
 523   Assert1(SI.getType() == SI.getOperand(0)->getType(),
 524           "Shift return type must be same as first operand!", &SI);
 525   Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
 526           "Second operand to shift must be ubyte type!", &SI);
 527   visitInstruction(SI);
 528 }
 529
 530 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 531   const Type *ElTy =
 532     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 533                    std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
 534   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 535   Assert2(PointerType::get(ElTy) == GEP.getType(),
 536           "GEP is not of right type for indices!", &GEP, ElTy);
 537   visitInstruction(GEP);
 538 }
 539
 540 void Verifier::visitLoadInst(LoadInst &LI) {
 541   const Type *ElTy =
 542     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
 543   Assert2(ElTy == LI.getType(),
 544           "Load result type does not match pointer operand type!", &LI, ElTy);
 545   visitInstruction(LI);
 546 }
 547
 548 void Verifier::visitStoreInst(StoreInst &SI) {
 549   const Type *ElTy =
 550     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
 551   Assert2(ElTy == SI.getOperand(0)->getType(),
 552           "Stored value type does not match pointer operand type!", &SI, ElTy);
 553   visitInstruction(SI);
 554 }
 555
 556
 557 /// verifyInstruction - Verify that an instruction is well formed.
 558 ///
 559 void Verifier::visitInstruction(Instruction &I) {
 560   BasicBlock *BB = I.getParent();
 561   Assert1(BB, "Instruction not embedded in basic block!", &I);
 562
 563   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 564     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 565          UI != UE; ++UI)
 566       Assert1(*UI != (User*)&I ||
 567               !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
 568               "Only PHI nodes may reference their own value!", &I);
 569   }
 570
 571   // Check that void typed values don't have names
 572   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 573           "Instruction has a name, but provides a void value!", &I);
 574
 575   // Check that the return value of the instruction is either void or a legal
 576   // value type.
 577   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
 578           "Instruction returns a non-scalar type!", &I);
 579
 580   // Check that all uses of the instruction, if they are instructions
 581   // themselves, actually have parent basic blocks.  If the use is not an
 582   // instruction, it is an error!
 583   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 584        UI != UE; ++UI) {
 585     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
 586             *UI);
 587     Instruction *Used = cast<Instruction>(*UI);
 588     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
 589             " embeded in a basic block!", &I, Used);
 590   }
 591
 592   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
 593     // Check to make sure that the "address of" an intrinsic function is never
 594     // taken.
 595     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
 596     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
 597       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
 598               "Cannot take the address of an intrinsic!", &I);
 599     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
 600       Assert1(OpBB->getParent() == BB->getParent(),
 601               "Referring to a basic block in another function!", &I);
 602     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
 603       Assert1(OpArg->getParent() == BB->getParent(),
 604               "Referring to an argument in another function!", &I);
 605     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
 606       BasicBlock *OpBlock = Op->getParent();
 607
 608       // Check that a definition dominates all of its uses.
 609       if (!isa<PHINode>(I)) {
 610         // Invoke results are only usable in the normal destination, not in the
 611         // exceptional destination.
 612         if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
 613           OpBlock = II->getNormalDest();
 614         else if (OpBlock == BB) {
 615           // If they are in the same basic block, make sure that the definition
 616           // comes before the use.
 617           Assert2(InstsInThisBlock.count(Op) ||
 618                   !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
 619                   "Instruction does not dominate all uses!", Op, &I);
 620         }
 621
 622         // Definition must dominate use unless use is unreachable!
 623         Assert2(DS->dominates(OpBlock, BB) ||
 624                 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
 625                 "Instruction does not dominate all uses!", Op, &I);
 626       } else {
 627         // PHI nodes are more difficult than other nodes because they actually
 628         // "use" the value in the predecessor basic blocks they correspond to.
 629         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
 630         Assert2(DS->dominates(OpBlock, PredBB) ||
 631                 !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
 632                 "Instruction does not dominate all uses!", Op, &I);
 633       }
 634     }
 635   }
 636   InstsInThisBlock.insert(&I);
 637 }
 638
 639 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
 640 ///
 641 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
 642   Function *IF = CI.getCalledFunction();
 643   const FunctionType *FT = IF->getFunctionType();
 644   Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
 645   unsigned NumArgs = 0;
 646
 647   // FIXME: this should check the return type of each intrinsic as well, also
 648   // arguments!
 649   switch (ID) {
 650   case Intrinsic::vastart:
 651     Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
 652             "llvm.va_start intrinsic may only occur in function with variable"
 653             " args!", &CI);
 654     NumArgs = 0;
 655     break;
 656   case Intrinsic::vaend:          NumArgs = 1; break;
 657   case Intrinsic::vacopy:         NumArgs = 1; break;
 658
 659   case Intrinsic::returnaddress:
 660   case Intrinsic::frameaddress:
 661     Assert1(isa<PointerType>(FT->getReturnType()),
 662             "llvm.(frame|return)address must return pointers", IF);
 663     Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
 664        "llvm.(frame|return)address require a single constant integer argument",
 665             &CI);
 666     NumArgs = 1;
 667     break;
 668
 669   // Verify that read and write port have integral parameters of the correct
 670   // signed-ness.
 671   case Intrinsic::writeport:
 672     Assert1(FT->getNumParams() == 2,
 673             "Illegal # arguments for intrinsic function!", IF);
 674     Assert1(FT->getParamType(0)->isIntegral(),
 675             "First argument not unsigned int!", IF);
 676     Assert1(FT->getParamType(1)->isUnsigned(),
 677             "First argument not unsigned int!", IF);
 678     NumArgs = 2;
 679     break;
 680
 681   case Intrinsic::writeio:
 682     Assert1(FT->getNumParams() == 2,
 683             "Illegal # arguments for intrinsic function!", IF);
 684     Assert1(FT->getParamType(0)->isFirstClassType(),
 685             "First argument not a first class type!", IF);
 686     Assert1(isa<PointerType>(FT->getParamType(1)),
 687             "Second argument not a pointer!", IF);
 688     NumArgs = 2;
 689     break;
 690
 691   case Intrinsic::readport:
 692     Assert1(FT->getNumParams() == 1,
 693             "Illegal # arguments for intrinsic function!", IF);
 694     Assert1(FT->getReturnType()->isFirstClassType(),
 695             "Return type is not a first class type!", IF);
 696     Assert1(FT->getParamType(0)->isUnsigned(),
 697             "First argument not unsigned int!", IF);
 698     NumArgs = 1;
 699     break;
 700
 701   case Intrinsic::readio: {
 702     const PointerType *ParamType = dyn_cast<PointerType>(FT->getParamType(0));
 703     const Type *ReturnType = FT->getReturnType();
 704
 705     Assert1(FT->getNumParams() == 1,
 706             "Illegal # arguments for intrinsic function!", IF);
 707     Assert1(ParamType, "First argument not a pointer!", IF);
 708     Assert1(ParamType->getElementType() == ReturnType,
 709             "Pointer type doesn't match return type!", IF);
 710     NumArgs = 1;
 711     break;
 712   }
 713
 714   case Intrinsic::isunordered:
 715     Assert1(FT->getNumParams() == 2,
 716             "Illegal # arguments for intrinsic function!", IF);
 717     Assert1(FT->getReturnType() == Type::BoolTy,
 718             "Return type is not bool!", IF);
 719     Assert1(FT->getParamType(0) == FT->getParamType(1),
 720             "Arguments must be of the same type!", IF);
 721     Assert1(FT->getParamType(0)->isFloatingPoint(),
 722             "Argument is not a floating point type!", IF);
 723     NumArgs = 2;
 724     break;
 725
 726   case Intrinsic::sqrt:
 727     Assert1(FT->getNumParams() == 1,
 728             "Illegal # arguments for intrinsic function!", IF);
 729     Assert1(FT->getParamType(0)->isFloatingPoint(),
 730             "Argument is not a floating point type!", IF);
 731     Assert1(FT->getReturnType() == FT->getParamType(0),
 732             "Return type is not the same as argument type!", IF);
 733     NumArgs = 1;
 734     break;
 735
 736   case Intrinsic::setjmp:          NumArgs = 1; break;
 737   case Intrinsic::longjmp:         NumArgs = 2; break;
 738   case Intrinsic::sigsetjmp:       NumArgs = 2; break;
 739   case Intrinsic::siglongjmp:      NumArgs = 2; break;
 740
 741   case Intrinsic::gcroot:
 742     Assert1(FT->getNumParams() == 2,
 743             "Illegal # arguments for intrinsic function!", IF);
 744     Assert1(isa<Constant>(CI.getOperand(2)),
 745             "Second argument to llvm.gcroot must be a constant!", &CI);
 746     NumArgs = 2;
 747     break;
 748   case Intrinsic::gcread:          NumArgs = 2; break;
 749   case Intrinsic::gcwrite:         NumArgs = 3; break;
 750
 751   case Intrinsic::dbg_stoppoint:   NumArgs = 4; break;
 752   case Intrinsic::dbg_region_start:NumArgs = 1; break;
 753   case Intrinsic::dbg_region_end:  NumArgs = 1; break;
 754   case Intrinsic::dbg_func_start:  NumArgs = 1; break;
 755   case Intrinsic::dbg_declare:     NumArgs = 1; break;
 756
 757   case Intrinsic::memcpy:          NumArgs = 4; break;
 758   case Intrinsic::memmove:         NumArgs = 4; break;
 759   case Intrinsic::memset:          NumArgs = 4; break;
 760
 761   case Intrinsic::prefetch:        NumArgs = 3; break;
 762   case Intrinsic::pcmarker:
 763     NumArgs = 1;
 764     Assert1(isa<Constant>(CI.getOperand(1)),
 765             "First argument to llvm.pcmarker must be a constant!", &CI);
 766     break;
 767
 768   case Intrinsic::not_intrinsic:
 769     assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
 770   }
 771
 772   Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
 773                                              FT->isVarArg()),
 774           "Illegal # arguments for intrinsic function!", IF);
 775 }
 776
 777
 778 //===----------------------------------------------------------------------===//
 779 //  Implement the public interfaces to this file...
 780 //===----------------------------------------------------------------------===//
 781
 782 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
 783   return new Verifier(action);
 784 }
 785
 786
 787 // verifyFunction - Create
 788 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
 789   Function &F = const_cast<Function&>(f);
 790   assert(!F.isExternal() && "Cannot verify external functions");
 791
 792   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
 793   Verifier *V = new Verifier(action);
 794   FPM.add(V);
 795   FPM.run(F);
 796   return V->Broken;
 797 }
 798
 799 /// verifyModule - Check a module for errors, printing messages on stderr.
 800 /// Return true if the module is corrupt.
 801 ///
 802 bool llvm::verifyModule(const Module &M, VerifierFailureAction action) {
 803   PassManager PM;
 804   Verifier *V = new Verifier(action);
 805   PM.add(V);
 806   PM.run((Module&)M);
 807   return V->Broken;
 808 }
 809
 810 // vim: sw=2