lib/VMCore/Verifier.cpp

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