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