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