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   Assert1(!F.isVarArg() || F.getCallingConv() == CallingConv::C,
 306           "Varargs functions must have C calling conventions!", &F);
 307
 308   // Check function arguments.
 309   const FunctionType *FT = F.getFunctionType();
 310   unsigned NumArgs = F.getArgumentList().size();
 311
 312   Assert2(FT->getNumParams() == NumArgs,
 313           "# formal arguments must match # of arguments for function type!",
 314           &F, FT);
 315   Assert1(F.getReturnType()->isFirstClassType() ||
 316           F.getReturnType() == Type::VoidTy,
 317           "Functions cannot return aggregate values!", &F);
 318
 319   // Check that the argument values match the function type for this function...
 320   unsigned i = 0;
 321   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I, ++i) {
 322     Assert2(I->getType() == FT->getParamType(i),
 323             "Argument value does not match function argument type!",
 324             I, FT->getParamType(i));
 325     // Make sure no aggregates are passed by value.
 326     Assert1(I->getType()->isFirstClassType(),
 327             "Functions cannot take aggregates as arguments by value!", I);
 328    }
 329
 330   if (!F.isExternal()) {
 331     verifySymbolTable(F.getSymbolTable());
 332
 333     // Check the entry node
 334     BasicBlock *Entry = &F.getEntryBlock();
 335     Assert1(pred_begin(Entry) == pred_end(Entry),
 336             "Entry block to function must not have predecessors!", Entry);
 337   }
 338 }
 339
 340
 341 // verifyBasicBlock - Verify that a basic block is well formed...
 342 //
 343 void Verifier::visitBasicBlock(BasicBlock &BB) {
 344   InstsInThisBlock.clear();
 345
 346   // Ensure that basic blocks have terminators!
 347   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 348
 349   // Check constraints that this basic block imposes on all of the PHI nodes in
 350   // it.
 351   if (isa<PHINode>(BB.front())) {
 352     std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
 353     std::sort(Preds.begin(), Preds.end());
 354     PHINode *PN;
 355     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 356
 357       // Ensure that PHI nodes have at least one entry!
 358       Assert1(PN->getNumIncomingValues() != 0,
 359               "PHI nodes must have at least one entry.  If the block is dead, "
 360               "the PHI should be removed!", PN);
 361       Assert1(PN->getNumIncomingValues() == Preds.size(),
 362               "PHINode should have one entry for each predecessor of its "
 363               "parent basic block!", PN);
 364
 365       // Get and sort all incoming values in the PHI node...
 366       std::vector<std::pair<BasicBlock*, Value*> > Values;
 367       Values.reserve(PN->getNumIncomingValues());
 368       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 369         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 370                                         PN->getIncomingValue(i)));
 371       std::sort(Values.begin(), Values.end());
 372
 373       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 374         // Check to make sure that if there is more than one entry for a
 375         // particular basic block in this PHI node, that the incoming values are
 376         // all identical.
 377         //
 378         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 379                 Values[i].second == Values[i-1].second,
 380                 "PHI node has multiple entries for the same basic block with "
 381                 "different incoming values!", PN, Values[i].first,
 382                 Values[i].second, Values[i-1].second);
 383
 384         // Check to make sure that the predecessors and PHI node entries are
 385         // matched up.
 386         Assert3(Values[i].first == Preds[i],
 387                 "PHI node entries do not match predecessors!", PN,
 388                 Values[i].first, Preds[i]);
 389       }
 390     }
 391   }
 392 }
 393
 394 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 395   // Ensure that terminators only exist at the end of the basic block.
 396   Assert1(&I == I.getParent()->getTerminator(),
 397           "Terminator found in the middle of a basic block!", I.getParent());
 398   visitInstruction(I);
 399 }
 400
 401 void Verifier::visitReturnInst(ReturnInst &RI) {
 402   Function *F = RI.getParent()->getParent();
 403   if (RI.getNumOperands() == 0)
 404     Assert2(F->getReturnType() == Type::VoidTy,
 405             "Found return instr that returns void in Function of non-void "
 406             "return type!", &RI, F->getReturnType());
 407   else
 408     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 409             "Function return type does not match operand "
 410             "type of return inst!", &RI, F->getReturnType());
 411
 412   // Check to make sure that the return value has necessary properties for
 413   // terminators...
 414   visitTerminatorInst(RI);
 415 }
 416
 417 void Verifier::visitSwitchInst(SwitchInst &SI) {
 418   // Check to make sure that all of the constants in the switch instruction
 419   // have the same type as the switched-on value.
 420   const Type *SwitchTy = SI.getCondition()->getType();
 421   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 422     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 423             "Switch constants must all be same type as switch value!", &SI);
 424
 425   visitTerminatorInst(SI);
 426 }
 427
 428 void Verifier::visitSelectInst(SelectInst &SI) {
 429   Assert1(SI.getCondition()->getType() == Type::BoolTy,
 430           "Select condition type must be bool!", &SI);
 431   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 432           "Select values must have identical types!", &SI);
 433   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 434           "Select values must have same type as select instruction!", &SI);
 435   visitInstruction(SI);
 436 }
 437
 438
 439 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 440 /// a pass, if any exist, it's an error.
 441 ///
 442 void Verifier::visitUserOp1(Instruction &I) {
 443   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 444 }
 445
 446 /// visitPHINode - Ensure that a PHI node is well formed.
 447 ///
 448 void Verifier::visitPHINode(PHINode &PN) {
 449   // Ensure that the PHI nodes are all grouped together at the top of the block.
 450   // This can be tested by checking whether the instruction before this is
 451   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 452   // then there is some other instruction before a PHI.
 453   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
 454           "PHI nodes not grouped at top of basic block!",
 455           &PN, PN.getParent());
 456
 457   // Check that all of the operands of the PHI node have the same type as the
 458   // result.
 459   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 460     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 461             "PHI node operands are not the same type as the result!", &PN);
 462
 463   // All other PHI node constraints are checked in the visitBasicBlock method.
 464
 465   visitInstruction(PN);
 466 }
 467
 468 void Verifier::visitCallInst(CallInst &CI) {
 469   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 470           "Called function must be a pointer!", &CI);
 471   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 472   Assert1(isa<FunctionType>(FPTy->getElementType()),
 473           "Called function is not pointer to function type!", &CI);
 474
 475   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 476
 477   // Verify that the correct number of arguments are being passed
 478   if (FTy->isVarArg())
 479     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 480             "Called function requires more parameters than were provided!",&CI);
 481   else
 482     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 483             "Incorrect number of arguments passed to called function!", &CI);
 484
 485   // Verify that all arguments to the call match the function type...
 486   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 487     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 488             "Call parameter type does not match function signature!",
 489             CI.getOperand(i+1), FTy->getParamType(i), &CI);
 490
 491   if (Function *F = CI.getCalledFunction())
 492     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 493       visitIntrinsicFunctionCall(ID, CI);
 494
 495   visitInstruction(CI);
 496 }
 497
 498 /// visitBinaryOperator - Check that both arguments to the binary operator are
 499 /// of the same type!
 500 ///
 501 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 502   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 503           "Both operands to a binary operator are not of the same type!", &B);
 504
 505   // Check that logical operators are only used with integral operands.
 506   if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
 507       B.getOpcode() == Instruction::Xor) {
 508     Assert1(B.getType()->isIntegral() ||
 509             (isa<PackedType>(B.getType()) &&
 510              cast<PackedType>(B.getType())->getElementType()->isIntegral()),
 511             "Logical operators only work with integral types!", &B);
 512     Assert1(B.getType() == B.getOperand(0)->getType(),
 513             "Logical operators must have same type for operands and result!",
 514             &B);
 515   } else if (isa<SetCondInst>(B)) {
 516     // Check that setcc instructions return bool
 517     Assert1(B.getType() == Type::BoolTy,
 518             "setcc instructions must return boolean values!", &B);
 519   } else {
 520     // Arithmetic operators only work on integer or fp values
 521     Assert1(B.getType() == B.getOperand(0)->getType(),
 522             "Arithmetic operators must have same type for operands and result!",
 523             &B);
 524     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 525             isa<PackedType>(B.getType()),
 526             "Arithmetic operators must have integer, fp, or packed type!", &B);
 527   }
 528
 529   visitInstruction(B);
 530 }
 531
 532 void Verifier::visitShiftInst(ShiftInst &SI) {
 533   Assert1(SI.getType()->isInteger(),
 534           "Shift must return an integer result!", &SI);
 535   Assert1(SI.getType() == SI.getOperand(0)->getType(),
 536           "Shift return type must be same as first operand!", &SI);
 537   Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
 538           "Second operand to shift must be ubyte type!", &SI);
 539   visitInstruction(SI);
 540 }
 541
 542 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
 543   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
 544                                               EI.getOperand(1)),
 545           "Invalid extractelement operands!", &EI);
 546   visitInstruction(EI);
 547 }
 548
 549 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
 550   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
 551                                              IE.getOperand(1),
 552                                              IE.getOperand(2)),
 553           "Invalid insertelement operands!", &IE);
 554   visitInstruction(IE);
 555 }
 556
 557 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
 558   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
 559                                              SV.getOperand(2)),
 560           "Invalid shufflevector operands!", &SV);
 561   Assert1(SV.getType() == SV.getOperand(0)->getType(),
 562           "Result of shufflevector must match first operand type!", &SV);
 563
 564   // Check to see if Mask is valid.
 565   if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
 566     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
 567       Assert1(isa<ConstantUInt>(MV->getOperand(i)) ||
 568               isa<UndefValue>(MV->getOperand(i)),
 569               "Invalid shufflevector shuffle mask!", &SV);
 570     }
 571   } else {
 572     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
 573             isa<ConstantAggregateZero>(SV.getOperand(2)),
 574             "Invalid shufflevector shuffle mask!", &SV);
 575   }
 576
 577   visitInstruction(SV);
 578 }
 579
 580 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 581   const Type *ElTy =
 582     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 583                    std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
 584   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 585   Assert2(PointerType::get(ElTy) == GEP.getType(),
 586           "GEP is not of right type for indices!", &GEP, ElTy);
 587   visitInstruction(GEP);
 588 }
 589
 590 void Verifier::visitLoadInst(LoadInst &LI) {
 591   const Type *ElTy =
 592     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
 593   Assert2(ElTy == LI.getType(),
 594           "Load result type does not match pointer operand type!", &LI, ElTy);
 595   visitInstruction(LI);
 596 }
 597
 598 void Verifier::visitStoreInst(StoreInst &SI) {
 599   const Type *ElTy =
 600     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
 601   Assert2(ElTy == SI.getOperand(0)->getType(),
 602           "Stored value type does not match pointer operand type!", &SI, ElTy);
 603   visitInstruction(SI);
 604 }
 605
 606
 607 /// verifyInstruction - Verify that an instruction is well formed.
 608 ///
 609 void Verifier::visitInstruction(Instruction &I) {
 610   BasicBlock *BB = I.getParent();
 611   Assert1(BB, "Instruction not embedded in basic block!", &I);
 612
 613   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 614     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 615          UI != UE; ++UI)
 616       Assert1(*UI != (User*)&I ||
 617               !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 618               "Only PHI nodes may reference their own value!", &I);
 619   }
 620
 621   // Check that void typed values don't have names
 622   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 623           "Instruction has a name, but provides a void value!", &I);
 624
 625   // Check that the return value of the instruction is either void or a legal
 626   // value type.
 627   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
 628           "Instruction returns a non-scalar type!", &I);
 629
 630   // Check that all uses of the instruction, if they are instructions
 631   // themselves, actually have parent basic blocks.  If the use is not an
 632   // instruction, it is an error!
 633   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 634        UI != UE; ++UI) {
 635     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
 636             *UI);
 637     Instruction *Used = cast<Instruction>(*UI);
 638     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
 639             " embeded in a basic block!", &I, Used);
 640   }
 641
 642   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
 643     // Check to make sure that the "address of" an intrinsic function is never
 644     // taken.
 645     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
 646     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
 647       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
 648               "Cannot take the address of an intrinsic!", &I);
 649     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
 650       Assert1(OpBB->getParent() == BB->getParent(),
 651               "Referring to a basic block in another function!", &I);
 652     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
 653       Assert1(OpArg->getParent() == BB->getParent(),
 654               "Referring to an argument in another function!", &I);
 655     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
 656       BasicBlock *OpBlock = Op->getParent();
 657
 658       // Check that a definition dominates all of its uses.
 659       if (!isa<PHINode>(I)) {
 660         // Invoke results are only usable in the normal destination, not in the
 661         // exceptional destination.
 662         if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
 663           OpBlock = II->getNormalDest();
 664         else if (OpBlock == BB) {
 665           // If they are in the same basic block, make sure that the definition
 666           // comes before the use.
 667           Assert2(InstsInThisBlock.count(Op) ||
 668                   !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 669                   "Instruction does not dominate all uses!", Op, &I);
 670         }
 671
 672         // Definition must dominate use unless use is unreachable!
 673         Assert2(EF->dominates(OpBlock, BB) ||
 674                 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 675                 "Instruction does not dominate all uses!", Op, &I);
 676       } else {
 677         // PHI nodes are more difficult than other nodes because they actually
 678         // "use" the value in the predecessor basic blocks they correspond to.
 679         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
 680         Assert2(EF->dominates(OpBlock, PredBB) ||
 681                 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
 682                 "Instruction does not dominate all uses!", Op, &I);
 683       }
 684     } else if (isa<InlineAsm>(I.getOperand(i))) {
 685       Assert1(i == 0 && isa<CallInst>(I),
 686               "Cannot take the address of an inline asm!", &I);
 687     }
 688   }
 689   InstsInThisBlock.insert(&I);
 690 }
 691
 692 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
 693 ///
 694 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
 695   Function *IF = CI.getCalledFunction();
 696   const FunctionType *FTy = IF->getFunctionType();
 697   Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
 698
 699 #define GET_INTRINSIC_VERIFIER
 700 #include "llvm/Intrinsics.gen"
 701 #undef GET_INTRINSIC_VERIFIER
 702 }
 703
 704 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
 705 /// Intrinsics.gen.  This implements a little state machine that verifies the
 706 /// prototype of intrinsics.
 707 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
 708   va_list VA;
 709   va_start(VA, F);
 710
 711   const FunctionType *FTy = F->getFunctionType();
 712
 713   // Note that "arg#0" is the return type.
 714   for (unsigned ArgNo = 0; 1; ++ArgNo) {
 715     int TypeID = va_arg(VA, int);
 716
 717     if (TypeID == -1) {
 718       if (ArgNo != FTy->getNumParams()+1)
 719         CheckFailed("Intrinsic prototype has too many arguments!", F);
 720       break;
 721     }
 722
 723     if (ArgNo == FTy->getNumParams()+1) {
 724       CheckFailed("Intrinsic prototype has too few arguments!", F);
 725       break;
 726     }
 727
 728     const Type *Ty;
 729     if (ArgNo == 0)
 730       Ty = FTy->getReturnType();
 731     else
 732       Ty = FTy->getParamType(ArgNo-1);
 733
 734     if (Ty->getTypeID() != TypeID) {
 735       if (ArgNo == 0)
 736         CheckFailed("Intrinsic prototype has incorrect result type!", F);
 737       else
 738         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
 739       break;
 740     }
 741
 742     // If this is a packed argument, verify the number and type of elements.
 743     if (TypeID == Type::PackedTyID) {
 744       const PackedType *PTy = cast<PackedType>(Ty);
 745       if (va_arg(VA, int) != PTy->getElementType()->getTypeID()) {
 746         CheckFailed("Intrinsic prototype has incorrect vector element type!",F);
 747         break;
 748       }
 749
 750       if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
 751         CheckFailed("Intrinsic prototype has incorrect number of "
 752                     "vector elements!",F);
 753         break;
 754       }
 755     }
 756   }
 757
 758   va_end(VA);
 759 }
 760
 761
 762 //===----------------------------------------------------------------------===//
 763 //  Implement the public interfaces to this file...
 764 //===----------------------------------------------------------------------===//
 765
 766 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
 767   return new Verifier(action);
 768 }
 769
 770
 771 // verifyFunction - Create
 772 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
 773   Function &F = const_cast<Function&>(f);
 774   assert(!F.isExternal() && "Cannot verify external functions");
 775
 776   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
 777   Verifier *V = new Verifier(action);
 778   FPM.add(V);
 779   FPM.run(F);
 780   return V->Broken;
 781 }
 782
 783 /// verifyModule - Check a module for errors, printing messages on stderr.
 784 /// Return true if the module is corrupt.
 785 ///
 786 bool llvm::verifyModule(const Module &M, VerifierFailureAction action) {
 787   PassManager PM;
 788   Verifier *V = new Verifier(action);
 789   PM.add(V);
 790   PM.run((Module&)M);
 791   return V->Broken;
 792 }
 793
 794 // vim: sw=2