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