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