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 visitSwitchInst(SwitchInst &SI);
 177     void visitSelectInst(SelectInst &SI);
 178     void visitUserOp1(Instruction &I);
 179     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 180     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 181
 182
 183     void WriteValue(const Value *V) {
 184       if (!V) return;
 185       if (isa<Instruction>(V)) {
 186         msgs << *V;
 187       } else {
 188         WriteAsOperand (msgs, V, true, true, Mod);
 189         msgs << "\n";
 190       }
 191     }
 192
 193     void WriteType(const Type* T ) {
 194       if ( !T ) return;
 195       WriteTypeSymbolic(msgs, T, Mod );
 196     }
 197
 198
 199     // CheckFailed - A check failed, so print out the condition and the message
 200     // that failed.  This provides a nice place to put a breakpoint if you want
 201     // to see why something is not correct.
 202     void CheckFailed(const std::string &Message,
 203                      const Value *V1 = 0, const Value *V2 = 0,
 204                      const Value *V3 = 0, const Value *V4 = 0) {
 205       msgs << Message << "\n";
 206       WriteValue(V1);
 207       WriteValue(V2);
 208       WriteValue(V3);
 209       WriteValue(V4);
 210       Broken = true;
 211     }
 212
 213     void CheckFailed( const std::string& Message, const Value* V1,
 214                       const Type* T2, const Value* V3 = 0 ) {
 215       msgs << Message << "\n";
 216       WriteValue(V1);
 217       WriteType(T2);
 218       WriteValue(V3);
 219     }
 220   };
 221
 222   RegisterOpt<Verifier> X("verify", "Module Verifier");
 223 } // End anonymous namespace
 224
 225
 226 // Assert - We know that cond should be true, if not print an error message.
 227 #define Assert(C, M) \
 228   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 229 #define Assert1(C, M, V1) \
 230   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 231 #define Assert2(C, M, V1, V2) \
 232   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 233 #define Assert3(C, M, V1, V2, V3) \
 234   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 235 #define Assert4(C, M, V1, V2, V3, V4) \
 236   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 237
 238
 239 void Verifier::visitGlobalValue(GlobalValue &GV) {
 240   Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
 241           "Global is external, but doesn't have external linkage!", &GV);
 242   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 243           "Only global variables can have appending linkage!", &GV);
 244
 245   if (GV.hasAppendingLinkage()) {
 246     GlobalVariable &GVar = cast<GlobalVariable>(GV);
 247     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
 248             "Only global arrays can have appending linkage!", &GV);
 249   }
 250 }
 251
 252 // verifySymbolTable - Verify that a function or module symbol table is ok
 253 //
 254 void Verifier::verifySymbolTable(SymbolTable &ST) {
 255
 256   // Loop over all of the values in all type planes in the symbol table.
 257   for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
 258        PE = ST.plane_end(); PI != PE; ++PI)
 259     for (SymbolTable::value_const_iterator VI = PI->second.begin(),
 260          VE = PI->second.end(); VI != VE; ++VI) {
 261       Value *V = VI->second;
 262       // Check that there are no void typed values in the symbol table.  Values
 263       // with a void type cannot be put into symbol tables because they cannot
 264       // have names!
 265       Assert1(V->getType() != Type::VoidTy,
 266         "Values with void type are not allowed to have names!", V);
 267     }
 268 }
 269
 270 // visitFunction - Verify that a function is ok.
 271 //
 272 void Verifier::visitFunction(Function &F) {
 273   // Check function arguments...
 274   const FunctionType *FT = F.getFunctionType();
 275   unsigned NumArgs = F.getArgumentList().size();
 276
 277   Assert2(FT->getNumParams() == NumArgs,
 278           "# formal arguments must match # of arguments for function type!",
 279           &F, FT);
 280   Assert1(F.getReturnType()->isFirstClassType() ||
 281           F.getReturnType() == Type::VoidTy,
 282           "Functions cannot return aggregate values!", &F);
 283
 284   // Check that the argument values match the function type for this function...
 285   unsigned i = 0;
 286   for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
 287     Assert2(I->getType() == FT->getParamType(i),
 288             "Argument value does not match function argument type!",
 289             I, FT->getParamType(i));
 290
 291   if (!F.isExternal()) {
 292     verifySymbolTable(F.getSymbolTable());
 293
 294     // Check the entry node
 295     BasicBlock *Entry = &F.getEntryBlock();
 296     Assert1(pred_begin(Entry) == pred_end(Entry),
 297             "Entry block to function must not have predecessors!", Entry);
 298   }
 299 }
 300
 301
 302 // verifyBasicBlock - Verify that a basic block is well formed...
 303 //
 304 void Verifier::visitBasicBlock(BasicBlock &BB) {
 305   // Check constraints that this basic block imposes on all of the PHI nodes in
 306   // it.
 307   if (isa<PHINode>(BB.front())) {
 308     std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
 309     std::sort(Preds.begin(), Preds.end());
 310
 311     for (BasicBlock::iterator I = BB.begin();
 312          PHINode *PN = dyn_cast<PHINode>(I); ++I) {
 313
 314       // Ensure that PHI nodes have at least one entry!
 315       Assert1(PN->getNumIncomingValues() != 0,
 316               "PHI nodes must have at least one entry.  If the block is dead, "
 317               "the PHI should be removed!", PN);
 318       Assert1(PN->getNumIncomingValues() == Preds.size(),
 319               "PHINode should have one entry for each predecessor of its "
 320               "parent basic block!", PN);
 321
 322       // Get and sort all incoming values in the PHI node...
 323       std::vector<std::pair<BasicBlock*, Value*> > Values;
 324       Values.reserve(PN->getNumIncomingValues());
 325       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 326         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 327                                         PN->getIncomingValue(i)));
 328       std::sort(Values.begin(), Values.end());
 329
 330       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 331         // Check to make sure that if there is more than one entry for a
 332         // particular basic block in this PHI node, that the incoming values are
 333         // all identical.
 334         //
 335         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 336                 Values[i].second == Values[i-1].second,
 337                 "PHI node has multiple entries for the same basic block with "
 338                 "different incoming values!", PN, Values[i].first,
 339                 Values[i].second, Values[i-1].second);
 340
 341         // Check to make sure that the predecessors and PHI node entries are
 342         // matched up.
 343         Assert3(Values[i].first == Preds[i],
 344                 "PHI node entries do not match predecessors!", PN,
 345                 Values[i].first, Preds[i]);
 346       }
 347     }
 348   }
 349
 350   // Ensure that basic blocks have terminators!
 351   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 352 }
 353
 354 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 355   // Ensure that terminators only exist at the end of the basic block.
 356   Assert1(&I == I.getParent()->getTerminator(),
 357           "Terminator found in the middle of a basic block!", I.getParent());
 358   visitInstruction(I);
 359 }
 360
 361 void Verifier::visitReturnInst(ReturnInst &RI) {
 362   Function *F = RI.getParent()->getParent();
 363   if (RI.getNumOperands() == 0)
 364     Assert1(F->getReturnType() == Type::VoidTy,
 365             "Function returns no value, but ret instruction found that does!",
 366             &RI);
 367   else
 368     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 369             "Function return type does not match operand "
 370             "type of return inst!", &RI, F->getReturnType());
 371
 372   // Check to make sure that the return value has necessary properties for
 373   // terminators...
 374   visitTerminatorInst(RI);
 375 }
 376
 377 void Verifier::visitSwitchInst(SwitchInst &SI) {
 378   // Check to make sure that all of the constants in the switch instruction
 379   // have the same type as the switched-on value.
 380   const Type *SwitchTy = SI.getCondition()->getType();
 381   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 382     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 383             "Switch constants must all be same type as switch value!", &SI);
 384
 385   visitTerminatorInst(SI);
 386 }
 387
 388 void Verifier::visitSelectInst(SelectInst &SI) {
 389   Assert1(SI.getCondition()->getType() == Type::BoolTy,
 390           "Select condition type must be bool!", &SI);
 391   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 392           "Select values must have identical types!", &SI);
 393   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 394           "Select values must have same type as select instruction!", &SI);
 395 }
 396
 397
 398 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 399 /// a pass, if any exist, it's an error.
 400 ///
 401 void Verifier::visitUserOp1(Instruction &I) {
 402   Assert1(0, "User-defined operators should not live outside of a pass!",
 403           &I);
 404 }
 405
 406 /// visitPHINode - Ensure that a PHI node is well formed.
 407 ///
 408 void Verifier::visitPHINode(PHINode &PN) {
 409   // Ensure that the PHI nodes are all grouped together at the top of the block.
 410   // This can be tested by checking whether the instruction before this is
 411   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 412   // then there is some other instruction before a PHI.
 413   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
 414           "PHI nodes not grouped at top of basic block!",
 415           &PN, PN.getParent());
 416
 417   // Check that all of the operands of the PHI node have the same type as the
 418   // result.
 419   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 420     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 421             "PHI node operands are not the same type as the result!", &PN);
 422
 423   // All other PHI node constraints are checked in the visitBasicBlock method.
 424
 425   visitInstruction(PN);
 426 }
 427
 428 void Verifier::visitCallInst(CallInst &CI) {
 429   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 430           "Called function must be a pointer!", &CI);
 431   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 432   Assert1(isa<FunctionType>(FPTy->getElementType()),
 433           "Called function is not pointer to function type!", &CI);
 434
 435   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 436
 437   // Verify that the correct number of arguments are being passed
 438   if (FTy->isVarArg())
 439     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 440             "Called function requires more parameters than were provided!",&CI);
 441   else
 442     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 443             "Incorrect number of arguments passed to called function!", &CI);
 444
 445   // Verify that all arguments to the call match the function type...
 446   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 447     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 448             "Call parameter type does not match function signature!",
 449             CI.getOperand(i+1), FTy->getParamType(i), &CI);
 450
 451   if (Function *F = CI.getCalledFunction())
 452     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 453       visitIntrinsicFunctionCall(ID, CI);
 454
 455   visitInstruction(CI);
 456 }
 457
 458 /// visitBinaryOperator - Check that both arguments to the binary operator are
 459 /// of the same type!
 460 ///
 461 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 462   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 463           "Both operands to a binary operator are not of the same type!", &B);
 464
 465   // Check that logical operators are only used with integral operands.
 466   if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
 467       B.getOpcode() == Instruction::Xor) {
 468     Assert1(B.getType()->isIntegral(),
 469             "Logical operators only work with integral types!", &B);
 470     Assert1(B.getType() == B.getOperand(0)->getType(),
 471             "Logical operators must have same type for operands and result!",
 472             &B);
 473   } else if (isa<SetCondInst>(B)) {
 474     // Check that setcc instructions return bool
 475     Assert1(B.getType() == Type::BoolTy,
 476             "setcc instructions must return boolean values!", &B);
 477   } else {
 478     // Arithmetic operators only work on integer or fp values
 479     Assert1(B.getType() == B.getOperand(0)->getType(),
 480             "Arithmetic operators must have same type for operands and result!",
 481             &B);
 482     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
 483             "Arithmetic operators must have integer or fp type!", &B);
 484   }
 485
 486   visitInstruction(B);
 487 }
 488
 489 void Verifier::visitShiftInst(ShiftInst &SI) {
 490   Assert1(SI.getType()->isInteger(),
 491           "Shift must return an integer result!", &SI);
 492   Assert1(SI.getType() == SI.getOperand(0)->getType(),
 493           "Shift return type must be same as first operand!", &SI);
 494   Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
 495           "Second operand to shift must be ubyte type!", &SI);
 496   visitInstruction(SI);
 497 }
 498
 499 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 500   const Type *ElTy =
 501     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 502                    std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
 503   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 504   Assert2(PointerType::get(ElTy) == GEP.getType(),
 505           "GEP is not of right type for indices!", &GEP, ElTy);
 506   visitInstruction(GEP);
 507 }
 508
 509 void Verifier::visitLoadInst(LoadInst &LI) {
 510   const Type *ElTy =
 511     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
 512   Assert2(ElTy == LI.getType(),
 513           "Load result type does not match pointer operand type!", &LI, ElTy);
 514   visitInstruction(LI);
 515 }
 516
 517 void Verifier::visitStoreInst(StoreInst &SI) {
 518   const Type *ElTy =
 519     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
 520   Assert2(ElTy == SI.getOperand(0)->getType(),
 521           "Stored value type does not match pointer operand type!", &SI, ElTy);
 522   visitInstruction(SI);
 523 }
 524
 525
 526 /// verifyInstruction - Verify that an instruction is well formed.
 527 ///
 528 void Verifier::visitInstruction(Instruction &I) {
 529   BasicBlock *BB = I.getParent();
 530   Assert1(BB, "Instruction not embedded in basic block!", &I);
 531
 532   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 533     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 534          UI != UE; ++UI)
 535       Assert1(*UI != (User*)&I ||
 536               !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
 537               "Only PHI nodes may reference their own value!", &I);
 538   }
 539
 540   // Check that void typed values don't have names
 541   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 542           "Instruction has a name, but provides a void value!", &I);
 543
 544   // Check that the return value of the instruction is either void or a legal
 545   // value type.
 546   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
 547           "Instruction returns a non-scalar type!", &I);
 548
 549   // Check that all uses of the instruction, if they are instructions
 550   // themselves, actually have parent basic blocks.  If the use is not an
 551   // instruction, it is an error!
 552   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 553        UI != UE; ++UI) {
 554     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
 555             *UI);
 556     Instruction *Used = cast<Instruction>(*UI);
 557     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
 558             " embeded in a basic block!", &I, Used);
 559   }
 560
 561   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
 562     // Check to make sure that the "address of" an intrinsic function is never
 563     // taken.
 564     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
 565       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
 566               "Cannot take the address of an intrinsic!", &I);
 567     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
 568       Assert1(OpBB->getParent() == BB->getParent(),
 569               "Referring to a basic block in another function!", &I);
 570     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
 571       Assert1(OpArg->getParent() == BB->getParent(),
 572               "Referring to an argument in another function!", &I);
 573     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
 574       BasicBlock *OpBlock = Op->getParent();
 575
 576       // Check that a definition dominates all of its uses.
 577       if (!isa<PHINode>(I)) {
 578         // Invoke results are only usable in the normal destination, not in the
 579         // exceptional destination.
 580         if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
 581           OpBlock = II->getNormalDest();
 582         else if (OpBlock == BB) {
 583           // If they are in the same basic block, make sure that the definition
 584           // comes before the use.
 585           Assert2(DS->dominates(Op, &I),
 586                   "Instruction does not dominate all uses!", Op, &I);
 587         }
 588
 589         // Definition must dominate use unless use is unreachable!
 590         Assert2(DS->dominates(OpBlock, BB) ||
 591                 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
 592                 "Instruction does not dominate all uses!", Op, &I);
 593       } else {
 594         // PHI nodes are more difficult than other nodes because they actually
 595         // "use" the value in the predecessor basic blocks they correspond to.
 596         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
 597         Assert2(DS->dominates(OpBlock, PredBB) ||
 598                 !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
 599                 "Instruction does not dominate all uses!", Op, &I);
 600       }
 601     }
 602   }
 603 }
 604
 605 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
 606 ///
 607 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
 608   Function *IF = CI.getCalledFunction();
 609   const FunctionType *FT = IF->getFunctionType();
 610   Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
 611   unsigned NumArgs = 0;
 612
 613   // FIXME: this should check the return type of each intrinsic as well, also
 614   // arguments!
 615   switch (ID) {
 616   case Intrinsic::vastart:
 617     Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
 618             "llvm.va_start intrinsic may only occur in function with variable"
 619             " args!", &CI);
 620     NumArgs = 0;
 621     break;
 622   case Intrinsic::vaend:          NumArgs = 1; break;
 623   case Intrinsic::vacopy:         NumArgs = 1; break;
 624
 625   case Intrinsic::returnaddress:
 626   case Intrinsic::frameaddress:
 627     Assert1(isa<PointerType>(FT->getReturnType()),
 628             "llvm.(frame|return)address must return pointers", IF);
 629     Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
 630        "llvm.(frame|return)address require a single constant integer argument",
 631             &CI);
 632     NumArgs = 1;
 633     break;
 634
 635   // Verify that read and write port have integral parameters of the correct
 636   // signed-ness.
 637   case Intrinsic::writeport:
 638     Assert1(FT->getNumParams() == 2,
 639             "Illegal # arguments for intrinsic function!", IF);
 640     Assert1(FT->getParamType(0)->isIntegral(),
 641             "First argument not unsigned int!", IF);
 642     Assert1(FT->getParamType(1)->isUnsigned(),
 643             "First argument not unsigned int!", IF);
 644     NumArgs = 2;
 645     break;
 646
 647   case Intrinsic::writeio:
 648     Assert1(FT->getNumParams() == 2,
 649             "Illegal # arguments for intrinsic function!", IF);
 650     Assert1(FT->getParamType(0)->isFirstClassType(),
 651             "First argument not a first class type!", IF);
 652     Assert1(FT->getParamType(1)->getPrimitiveID() == Type::PointerTyID,
 653             "Second argument not a pointer!", IF);
 654     NumArgs = 2;
 655     break;
 656
 657   case Intrinsic::readport:
 658     Assert1(FT->getNumParams() == 1,
 659             "Illegal # arguments for intrinsic function!", IF);
 660     Assert1(FT->getReturnType()->isFirstClassType(),
 661             "Return type is not a first class type!", IF);
 662     Assert1(FT->getParamType(0)->isUnsigned(),
 663             "First argument not unsigned int!", IF);
 664     NumArgs = 1;
 665     break;
 666
 667   case Intrinsic::readio: {
 668     const PointerType *ParamType = dyn_cast<PointerType>(FT->getParamType(0));
 669     const Type *ReturnType = FT->getReturnType();
 670
 671     Assert1(FT->getNumParams() == 1,
 672             "Illegal # arguments for intrinsic function!", IF);
 673     Assert1(ParamType, "First argument not a pointer!", IF);
 674     Assert1(ParamType->getElementType() == ReturnType,
 675             "Pointer type doesn't match return type!", IF);
 676     NumArgs = 1;
 677     break;
 678   }
 679
 680   case Intrinsic::setjmp:          NumArgs = 1; break;
 681   case Intrinsic::longjmp:         NumArgs = 2; break;
 682   case Intrinsic::sigsetjmp:       NumArgs = 2; break;
 683   case Intrinsic::siglongjmp:      NumArgs = 2; break;
 684
 685   case Intrinsic::gcroot:
 686     Assert1(FT->getNumParams() == 2,
 687             "Illegal # arguments for intrinsic function!", IF);
 688     Assert1(isa<Constant>(CI.getOperand(2)) ||
 689             isa<GlobalValue>(CI.getOperand(2)),
 690             "Second argument to llvm.gcroot must be a constant!", &CI);
 691     NumArgs = 2;
 692     break;
 693   case Intrinsic::gcread:          NumArgs = 1; break;
 694   case Intrinsic::gcwrite:         NumArgs = 2; break;
 695
 696   case Intrinsic::dbg_stoppoint:   NumArgs = 4; break;
 697   case Intrinsic::dbg_region_start:NumArgs = 1; break;
 698   case Intrinsic::dbg_region_end:  NumArgs = 1; break;
 699   case Intrinsic::dbg_func_start:  NumArgs = 1; break;
 700   case Intrinsic::dbg_declare:     NumArgs = 1; break;
 701
 702   case Intrinsic::memcpy:          NumArgs = 4; break;
 703   case Intrinsic::memmove:         NumArgs = 4; break;
 704   case Intrinsic::memset:          NumArgs = 4; break;
 705
 706   case Intrinsic::alpha_ctlz:      NumArgs = 1; break;
 707   case Intrinsic::alpha_cttz:      NumArgs = 1; break;
 708   case Intrinsic::alpha_ctpop:     NumArgs = 1; break;
 709   case Intrinsic::alpha_umulh:     NumArgs = 2; break;
 710   case Intrinsic::alpha_vecop:     NumArgs = 4; break;
 711   case Intrinsic::alpha_pup:       NumArgs = 3; break;
 712   case Intrinsic::alpha_bytezap:   NumArgs = 2; break;
 713   case Intrinsic::alpha_bytemanip: NumArgs = 3; break;
 714   case Intrinsic::alpha_dfpbop:    NumArgs = 3; break;
 715   case Intrinsic::alpha_dfpuop:    NumArgs = 2; break;
 716   case Intrinsic::alpha_unordered: NumArgs = 2; break;
 717   case Intrinsic::alpha_uqtodfp:   NumArgs = 2; break;
 718   case Intrinsic::alpha_uqtosfp:   NumArgs = 2; break;
 719   case Intrinsic::alpha_dfptosq:   NumArgs = 2; break;
 720   case Intrinsic::alpha_sfptosq:   NumArgs = 2; break;
 721
 722   case Intrinsic::not_intrinsic:
 723     assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
 724   }
 725
 726   Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
 727                                              FT->isVarArg()),
 728           "Illegal # arguments for intrinsic function!", IF);
 729 }
 730
 731
 732 //===----------------------------------------------------------------------===//
 733 //  Implement the public interfaces to this file...
 734 //===----------------------------------------------------------------------===//
 735
 736 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
 737   return new Verifier(action);
 738 }
 739
 740
 741 // verifyFunction - Create
 742 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
 743   Function &F = const_cast<Function&>(f);
 744   assert(!F.isExternal() && "Cannot verify external functions");
 745
 746   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
 747   Verifier *V = new Verifier(action);
 748   FPM.add(V);
 749   FPM.run(F);
 750   return V->Broken;
 751 }
 752
 753 /// verifyModule - Check a module for errors, printing messages on stderr.
 754 /// Return true if the module is corrupt.
 755 ///
 756 bool llvm::verifyModule(const Module &M, VerifierFailureAction action) {
 757   PassManager PM;
 758   Verifier *V = new Verifier(action);
 759   PM.add(V);
 760   PM.run((Module&)M);
 761   return V->Broken;
 762 }
 763
 764 // vim: sw=2