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/Support/Streams.h"
  59 #include "llvm/ADT/StringExtras.h"
  60 #include "llvm/ADT/STLExtras.h"
  61 #include "llvm/Support/Compiler.h"
  62 #include <algorithm>
  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       verifyTypeSymbolTable(M.getTypeSymbolTable());
 103       verifyValueSymbolTable(M.getValueSymbolTable());
 104
 105       // If this is a real pass, in a pass manager, we must abort before
 106       // returning back to the pass manager, or else the pass manager may try to
 107       // run other passes on the broken module.
 108       if (RealPass)
 109         return abortIfBroken();
 110       return false;
 111     }
 112
 113     bool runOnFunction(Function &F) {
 114       // Get dominator information if we are being run by PassManager
 115       if (RealPass) EF = &getAnalysis<ETForest>();
 116
 117       visit(F);
 118       InstsInThisBlock.clear();
 119
 120       // If this is a real pass, in a pass manager, we must abort before
 121       // returning back to the pass manager, or else the pass manager may try to
 122       // run other passes on the broken module.
 123       if (RealPass)
 124         return abortIfBroken();
 125
 126       return false;
 127     }
 128
 129     bool doFinalization(Module &M) {
 130       // Scan through, checking all of the external function's linkage now...
 131       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 132         visitGlobalValue(*I);
 133
 134         // Check to make sure function prototypes are okay.
 135         if (I->isDeclaration()) visitFunction(*I);
 136       }
 137
 138       for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 139            I != E; ++I)
 140         visitGlobalVariable(*I);
 141
 142       // If the module is broken, abort at this time.
 143       return abortIfBroken();
 144     }
 145
 146     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 147       AU.setPreservesAll();
 148       if (RealPass)
 149         AU.addRequired<ETForest>();
 150     }
 151
 152     /// abortIfBroken - If the module is broken and we are supposed to abort on
 153     /// this condition, do so.
 154     ///
 155     bool abortIfBroken() {
 156       if (Broken) {
 157         msgs << "Broken module found, ";
 158         switch (action) {
 159           case AbortProcessAction:
 160             msgs << "compilation aborted!\n";
 161             cerr << msgs.str();
 162             abort();
 163           case PrintMessageAction:
 164             msgs << "verification continues.\n";
 165             cerr << msgs.str();
 166             return false;
 167           case ReturnStatusAction:
 168             msgs << "compilation terminated.\n";
 169             return Broken;
 170         }
 171       }
 172       return false;
 173     }
 174
 175
 176     // Verification methods...
 177     void verifyTypeSymbolTable(TypeSymbolTable &ST);
 178     void verifyValueSymbolTable(SymbolTable &ST);
 179     void visitGlobalValue(GlobalValue &GV);
 180     void visitGlobalVariable(GlobalVariable &GV);
 181     void visitFunction(Function &F);
 182     void visitBasicBlock(BasicBlock &BB);
 183     void visitTruncInst(TruncInst &I);
 184     void visitZExtInst(ZExtInst &I);
 185     void visitSExtInst(SExtInst &I);
 186     void visitFPTruncInst(FPTruncInst &I);
 187     void visitFPExtInst(FPExtInst &I);
 188     void visitFPToUIInst(FPToUIInst &I);
 189     void visitFPToSIInst(FPToSIInst &I);
 190     void visitUIToFPInst(UIToFPInst &I);
 191     void visitSIToFPInst(SIToFPInst &I);
 192     void visitIntToPtrInst(IntToPtrInst &I);
 193     void visitPtrToIntInst(PtrToIntInst &I);
 194     void visitBitCastInst(BitCastInst &I);
 195     void visitPHINode(PHINode &PN);
 196     void visitBinaryOperator(BinaryOperator &B);
 197     void visitICmpInst(ICmpInst &IC);
 198     void visitFCmpInst(FCmpInst &FC);
 199     void visitExtractElementInst(ExtractElementInst &EI);
 200     void visitInsertElementInst(InsertElementInst &EI);
 201     void visitShuffleVectorInst(ShuffleVectorInst &EI);
 202     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 203     void visitCallInst(CallInst &CI);
 204     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 205     void visitLoadInst(LoadInst &LI);
 206     void visitStoreInst(StoreInst &SI);
 207     void visitInstruction(Instruction &I);
 208     void visitTerminatorInst(TerminatorInst &I);
 209     void visitReturnInst(ReturnInst &RI);
 210     void visitSwitchInst(SwitchInst &SI);
 211     void visitSelectInst(SelectInst &SI);
 212     void visitUserOp1(Instruction &I);
 213     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 214     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 215
 216     void VerifyIntrinsicPrototype(Function *F, ...);
 217
 218     void WriteValue(const Value *V) {
 219       if (!V) return;
 220       if (isa<Instruction>(V)) {
 221         msgs << *V;
 222       } else {
 223         WriteAsOperand(msgs, V, true, Mod);
 224         msgs << "\n";
 225       }
 226     }
 227
 228     void WriteType(const Type* T ) {
 229       if ( !T ) return;
 230       WriteTypeSymbolic(msgs, T, Mod );
 231     }
 232
 233
 234     // CheckFailed - A check failed, so print out the condition and the message
 235     // that failed.  This provides a nice place to put a breakpoint if you want
 236     // to see why something is not correct.
 237     void CheckFailed(const std::string &Message,
 238                      const Value *V1 = 0, const Value *V2 = 0,
 239                      const Value *V3 = 0, const Value *V4 = 0) {
 240       msgs << Message << "\n";
 241       WriteValue(V1);
 242       WriteValue(V2);
 243       WriteValue(V3);
 244       WriteValue(V4);
 245       Broken = true;
 246     }
 247
 248     void CheckFailed( const std::string& Message, const Value* V1,
 249                       const Type* T2, const Value* V3 = 0 ) {
 250       msgs << Message << "\n";
 251       WriteValue(V1);
 252       WriteType(T2);
 253       WriteValue(V3);
 254       Broken = true;
 255     }
 256   };
 257
 258   RegisterPass<Verifier> X("verify", "Module Verifier");
 259 } // End anonymous namespace
 260
 261
 262 // Assert - We know that cond should be true, if not print an error message.
 263 #define Assert(C, M) \
 264   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 265 #define Assert1(C, M, V1) \
 266   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 267 #define Assert2(C, M, V1, V2) \
 268   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 269 #define Assert3(C, M, V1, V2, V3) \
 270   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 271 #define Assert4(C, M, V1, V2, V3, V4) \
 272   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 273
 274
 275 void Verifier::visitGlobalValue(GlobalValue &GV) {
 276   Assert1(!GV.isDeclaration() ||
 277           GV.hasExternalLinkage() ||
 278           GV.hasDLLImportLinkage() ||
 279           GV.hasExternalWeakLinkage(),
 280   "Global is external, but doesn't have external or dllimport or weak linkage!",
 281           &GV);
 282
 283   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
 284           "Global is marked as dllimport, but not external", &GV);
 285
 286   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 287           "Only global variables can have appending linkage!", &GV);
 288
 289   if (GV.hasAppendingLinkage()) {
 290     GlobalVariable &GVar = cast<GlobalVariable>(GV);
 291     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
 292             "Only global arrays can have appending linkage!", &GV);
 293   }
 294 }
 295
 296 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 297   if (GV.hasInitializer())
 298     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 299             "Global variable initializer type does not match global "
 300             "variable type!", &GV);
 301
 302   visitGlobalValue(GV);
 303 }
 304
 305 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 306 }
 307
 308 // verifySymbolTable - Verify that a function or module symbol table is ok
 309 //
 310 void Verifier::verifyValueSymbolTable(SymbolTable &ST) {
 311
 312   // Loop over all of the values in all type planes in the symbol table.
 313   for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
 314        PE = ST.plane_end(); PI != PE; ++PI)
 315     for (SymbolTable::value_const_iterator VI = PI->second.begin(),
 316          VE = PI->second.end(); VI != VE; ++VI) {
 317       Value *V = VI->second;
 318       // Check that there are no void typed values in the symbol table.  Values
 319       // with a void type cannot be put into symbol tables because they cannot
 320       // have names!
 321       Assert1(V->getType() != Type::VoidTy,
 322         "Values with void type are not allowed to have names!", V);
 323     }
 324 }
 325
 326 // visitFunction - Verify that a function is ok.
 327 //
 328 void Verifier::visitFunction(Function &F) {
 329   // Check function arguments.
 330   const FunctionType *FT = F.getFunctionType();
 331   unsigned NumArgs = F.getArgumentList().size();
 332
 333   Assert2(FT->getNumParams() == NumArgs,
 334           "# formal arguments must match # of arguments for function type!",
 335           &F, FT);
 336   Assert1(F.getReturnType()->isFirstClassType() ||
 337           F.getReturnType() == Type::VoidTy,
 338           "Functions cannot return aggregate values!", &F);
 339
 340   Assert1(!FT->isStructReturn() ||
 341           (FT->getReturnType() == Type::VoidTy &&
 342            FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
 343           "Invalid struct-return function!", &F);
 344
 345   // Check that this function meets the restrictions on this calling convention.
 346   switch (F.getCallingConv()) {
 347   default:
 348     break;
 349   case CallingConv::C:
 350     break;
 351   case CallingConv::Fast:
 352   case CallingConv::Cold:
 353   case CallingConv::X86_FastCall:
 354     Assert1(!F.isVarArg(),
 355             "Varargs functions must have C calling conventions!", &F);
 356     break;
 357   }
 358
 359   // Check that the argument values match the function type for this function...
 360   unsigned i = 0;
 361   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 362        I != E; ++I, ++i) {
 363     Assert2(I->getType() == FT->getParamType(i),
 364             "Argument value does not match function argument type!",
 365             I, FT->getParamType(i));
 366     // Make sure no aggregates are passed by value.
 367     Assert1(I->getType()->isFirstClassType(),
 368             "Functions cannot take aggregates as arguments by value!", I);
 369    }
 370
 371   if (!F.isDeclaration()) {
 372     // Verify that this function (which has a body) is not named "llvm.*".  It
 373     // is not legal to define intrinsics.
 374     if (F.getName().size() >= 5)
 375       Assert1(F.getName().substr(0, 5) != "llvm.",
 376               "llvm intrinsics cannot be defined!", &F);
 377
 378     verifyValueSymbolTable(F.getValueSymbolTable());
 379
 380     // Check the entry node
 381     BasicBlock *Entry = &F.getEntryBlock();
 382     Assert1(pred_begin(Entry) == pred_end(Entry),
 383             "Entry block to function must not have predecessors!", Entry);
 384   }
 385 }
 386
 387
 388 // verifyBasicBlock - Verify that a basic block is well formed...
 389 //
 390 void Verifier::visitBasicBlock(BasicBlock &BB) {
 391   InstsInThisBlock.clear();
 392
 393   // Ensure that basic blocks have terminators!
 394   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 395
 396   // Check constraints that this basic block imposes on all of the PHI nodes in
 397   // it.
 398   if (isa<PHINode>(BB.front())) {
 399     std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
 400     std::sort(Preds.begin(), Preds.end());
 401     PHINode *PN;
 402     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 403
 404       // Ensure that PHI nodes have at least one entry!
 405       Assert1(PN->getNumIncomingValues() != 0,
 406               "PHI nodes must have at least one entry.  If the block is dead, "
 407               "the PHI should be removed!", PN);
 408       Assert1(PN->getNumIncomingValues() == Preds.size(),
 409               "PHINode should have one entry for each predecessor of its "
 410               "parent basic block!", PN);
 411
 412       // Get and sort all incoming values in the PHI node...
 413       std::vector<std::pair<BasicBlock*, Value*> > Values;
 414       Values.reserve(PN->getNumIncomingValues());
 415       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 416         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 417                                         PN->getIncomingValue(i)));
 418       std::sort(Values.begin(), Values.end());
 419
 420       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 421         // Check to make sure that if there is more than one entry for a
 422         // particular basic block in this PHI node, that the incoming values are
 423         // all identical.
 424         //
 425         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 426                 Values[i].second == Values[i-1].second,
 427                 "PHI node has multiple entries for the same basic block with "
 428                 "different incoming values!", PN, Values[i].first,
 429                 Values[i].second, Values[i-1].second);
 430
 431         // Check to make sure that the predecessors and PHI node entries are
 432         // matched up.
 433         Assert3(Values[i].first == Preds[i],
 434                 "PHI node entries do not match predecessors!", PN,
 435                 Values[i].first, Preds[i]);
 436       }
 437     }
 438   }
 439 }
 440
 441 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 442   // Ensure that terminators only exist at the end of the basic block.
 443   Assert1(&I == I.getParent()->getTerminator(),
 444           "Terminator found in the middle of a basic block!", I.getParent());
 445   visitInstruction(I);
 446 }
 447
 448 void Verifier::visitReturnInst(ReturnInst &RI) {
 449   Function *F = RI.getParent()->getParent();
 450   if (RI.getNumOperands() == 0)
 451     Assert2(F->getReturnType() == Type::VoidTy,
 452             "Found return instr that returns void in Function of non-void "
 453             "return type!", &RI, F->getReturnType());
 454   else
 455     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 456             "Function return type does not match operand "
 457             "type of return inst!", &RI, F->getReturnType());
 458
 459   // Check to make sure that the return value has necessary properties for
 460   // terminators...
 461   visitTerminatorInst(RI);
 462 }
 463
 464 void Verifier::visitSwitchInst(SwitchInst &SI) {
 465   // Check to make sure that all of the constants in the switch instruction
 466   // have the same type as the switched-on value.
 467   const Type *SwitchTy = SI.getCondition()->getType();
 468   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 469     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 470             "Switch constants must all be same type as switch value!", &SI);
 471
 472   visitTerminatorInst(SI);
 473 }
 474
 475 void Verifier::visitSelectInst(SelectInst &SI) {
 476   Assert1(SI.getCondition()->getType() == Type::Int1Ty,
 477           "Select condition type must be bool!", &SI);
 478   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 479           "Select values must have identical types!", &SI);
 480   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 481           "Select values must have same type as select instruction!", &SI);
 482   visitInstruction(SI);
 483 }
 484
 485
 486 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 487 /// a pass, if any exist, it's an error.
 488 ///
 489 void Verifier::visitUserOp1(Instruction &I) {
 490   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 491 }
 492
 493 void Verifier::visitTruncInst(TruncInst &I) {
 494   // Get the source and destination types
 495   const Type *SrcTy = I.getOperand(0)->getType();
 496   const Type *DestTy = I.getType();
 497
 498   // Get the size of the types in bits, we'll need this later
 499   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 500   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 501
 502   Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
 503   Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
 504   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 505
 506   visitInstruction(I);
 507 }
 508
 509 void Verifier::visitZExtInst(ZExtInst &I) {
 510   // Get the source and destination types
 511   const Type *SrcTy = I.getOperand(0)->getType();
 512   const Type *DestTy = I.getType();
 513
 514   // Get the size of the types in bits, we'll need this later
 515   Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
 516   Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
 517   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 518   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 519
 520   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 521
 522   visitInstruction(I);
 523 }
 524
 525 void Verifier::visitSExtInst(SExtInst &I) {
 526   // Get the source and destination types
 527   const Type *SrcTy = I.getOperand(0)->getType();
 528   const Type *DestTy = I.getType();
 529
 530   // Get the size of the types in bits, we'll need this later
 531   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 532   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 533
 534   Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
 535   Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
 536   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 537
 538   visitInstruction(I);
 539 }
 540
 541 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 542   // Get the source and destination types
 543   const Type *SrcTy = I.getOperand(0)->getType();
 544   const Type *DestTy = I.getType();
 545   // Get the size of the types in bits, we'll need this later
 546   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 547   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 548
 549   Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
 550   Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
 551   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 552
 553   visitInstruction(I);
 554 }
 555
 556 void Verifier::visitFPExtInst(FPExtInst &I) {
 557   // Get the source and destination types
 558   const Type *SrcTy = I.getOperand(0)->getType();
 559   const Type *DestTy = I.getType();
 560
 561   // Get the size of the types in bits, we'll need this later
 562   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 563   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 564
 565   Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
 566   Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
 567   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 568
 569   visitInstruction(I);
 570 }
 571
 572 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 573   // Get the source and destination types
 574   const Type *SrcTy = I.getOperand(0)->getType();
 575   const Type *DestTy = I.getType();
 576
 577   Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
 578   Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
 579
 580   visitInstruction(I);
 581 }
 582
 583 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 584   // Get the source and destination types
 585   const Type *SrcTy = I.getOperand(0)->getType();
 586   const Type *DestTy = I.getType();
 587
 588   Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
 589   Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
 590
 591   visitInstruction(I);
 592 }
 593
 594 void Verifier::visitFPToUIInst(FPToUIInst &I) {
 595   // Get the source and destination types
 596   const Type *SrcTy = I.getOperand(0)->getType();
 597   const Type *DestTy = I.getType();
 598
 599   Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
 600   Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
 601
 602   visitInstruction(I);
 603 }
 604
 605 void Verifier::visitFPToSIInst(FPToSIInst &I) {
 606   // Get the source and destination types
 607   const Type *SrcTy = I.getOperand(0)->getType();
 608   const Type *DestTy = I.getType();
 609
 610   Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
 611   Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
 612
 613   visitInstruction(I);
 614 }
 615
 616 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
 617   // Get the source and destination types
 618   const Type *SrcTy = I.getOperand(0)->getType();
 619   const Type *DestTy = I.getType();
 620
 621   Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
 622   Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
 623
 624   visitInstruction(I);
 625 }
 626
 627 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
 628   // Get the source and destination types
 629   const Type *SrcTy = I.getOperand(0)->getType();
 630   const Type *DestTy = I.getType();
 631
 632   Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
 633   Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
 634
 635   visitInstruction(I);
 636 }
 637
 638 void Verifier::visitBitCastInst(BitCastInst &I) {
 639   // Get the source and destination types
 640   const Type *SrcTy = I.getOperand(0)->getType();
 641   const Type *DestTy = I.getType();
 642
 643   // Get the size of the types in bits, we'll need this later
 644   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 645   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 646
 647   // BitCast implies a no-op cast of type only. No bits change.
 648   // However, you can't cast pointers to anything but pointers.
 649   Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
 650           "Bitcast requires both operands to be pointer or neither", &I);
 651   Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
 652
 653   visitInstruction(I);
 654 }
 655
 656 /// visitPHINode - Ensure that a PHI node is well formed.
 657 ///
 658 void Verifier::visitPHINode(PHINode &PN) {
 659   // Ensure that the PHI nodes are all grouped together at the top of the block.
 660   // This can be tested by checking whether the instruction before this is
 661   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 662   // then there is some other instruction before a PHI.
 663   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
 664           "PHI nodes not grouped at top of basic block!",
 665           &PN, PN.getParent());
 666
 667   // Check that all of the operands of the PHI node have the same type as the
 668   // result.
 669   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 670     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 671             "PHI node operands are not the same type as the result!", &PN);
 672
 673   // All other PHI node constraints are checked in the visitBasicBlock method.
 674
 675   visitInstruction(PN);
 676 }
 677
 678 void Verifier::visitCallInst(CallInst &CI) {
 679   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 680           "Called function must be a pointer!", &CI);
 681   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 682   Assert1(isa<FunctionType>(FPTy->getElementType()),
 683           "Called function is not pointer to function type!", &CI);
 684
 685   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 686
 687   // Verify that the correct number of arguments are being passed
 688   if (FTy->isVarArg())
 689     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 690             "Called function requires more parameters than were provided!",&CI);
 691   else
 692     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 693             "Incorrect number of arguments passed to called function!", &CI);
 694
 695   // Verify that all arguments to the call match the function type...
 696   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 697     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 698             "Call parameter type does not match function signature!",
 699             CI.getOperand(i+1), FTy->getParamType(i), &CI);
 700
 701   if (Function *F = CI.getCalledFunction())
 702     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 703       visitIntrinsicFunctionCall(ID, CI);
 704
 705   visitInstruction(CI);
 706 }
 707
 708 /// visitBinaryOperator - Check that both arguments to the binary operator are
 709 /// of the same type!
 710 ///
 711 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 712   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 713           "Both operands to a binary operator are not of the same type!", &B);
 714
 715   switch (B.getOpcode()) {
 716   // Check that logical operators are only used with integral operands.
 717   case Instruction::And:
 718   case Instruction::Or:
 719   case Instruction::Xor:
 720     Assert1(B.getType()->isInteger() ||
 721             (isa<PackedType>(B.getType()) &&
 722              cast<PackedType>(B.getType())->getElementType()->isInteger()),
 723             "Logical operators only work with integral types!", &B);
 724     Assert1(B.getType() == B.getOperand(0)->getType(),
 725             "Logical operators must have same type for operands and result!",
 726             &B);
 727     break;
 728   case Instruction::Shl:
 729   case Instruction::LShr:
 730   case Instruction::AShr:
 731     Assert1(B.getType()->isInteger(),
 732             "Shift must return an integer result!", &B);
 733     Assert1(B.getType() == B.getOperand(0)->getType(),
 734             "Shift return type must be same as operands!", &B);
 735     /* FALL THROUGH */
 736   default:
 737     // Arithmetic operators only work on integer or fp values
 738     Assert1(B.getType() == B.getOperand(0)->getType(),
 739             "Arithmetic operators must have same type for operands and result!",
 740             &B);
 741     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 742             isa<PackedType>(B.getType()),
 743             "Arithmetic operators must have integer, fp, or packed type!", &B);
 744     break;
 745   }
 746
 747   visitInstruction(B);
 748 }
 749
 750 void Verifier::visitICmpInst(ICmpInst& IC) {
 751   // Check that the operands are the same type
 752   const Type* Op0Ty = IC.getOperand(0)->getType();
 753   const Type* Op1Ty = IC.getOperand(1)->getType();
 754   Assert1(Op0Ty == Op1Ty,
 755           "Both operands to ICmp instruction are not of the same type!", &IC);
 756   // Check that the operands are the right type
 757   Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
 758           "Invalid operand types for ICmp instruction", &IC);
 759   visitInstruction(IC);
 760 }
 761
 762 void Verifier::visitFCmpInst(FCmpInst& FC) {
 763   // Check that the operands are the same type
 764   const Type* Op0Ty = FC.getOperand(0)->getType();
 765   const Type* Op1Ty = FC.getOperand(1)->getType();
 766   Assert1(Op0Ty == Op1Ty,
 767           "Both operands to FCmp instruction are not of the same type!", &FC);
 768   // Check that the operands are the right type
 769   Assert1(Op0Ty->isFloatingPoint(),
 770           "Invalid operand types for FCmp instruction", &FC);
 771   visitInstruction(FC);
 772 }
 773
 774 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
 775   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
 776                                               EI.getOperand(1)),
 777           "Invalid extractelement operands!", &EI);
 778   visitInstruction(EI);
 779 }
 780
 781 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
 782   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
 783                                              IE.getOperand(1),
 784                                              IE.getOperand(2)),
 785           "Invalid insertelement operands!", &IE);
 786   visitInstruction(IE);
 787 }
 788
 789 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
 790   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
 791                                              SV.getOperand(2)),
 792           "Invalid shufflevector operands!", &SV);
 793   Assert1(SV.getType() == SV.getOperand(0)->getType(),
 794           "Result of shufflevector must match first operand type!", &SV);
 795
 796   // Check to see if Mask is valid.
 797   if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
 798     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
 799       Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
 800               isa<UndefValue>(MV->getOperand(i)),
 801               "Invalid shufflevector shuffle mask!", &SV);
 802     }
 803   } else {
 804     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
 805             isa<ConstantAggregateZero>(SV.getOperand(2)),
 806             "Invalid shufflevector shuffle mask!", &SV);
 807   }
 808
 809   visitInstruction(SV);
 810 }
 811
 812 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 813   const Type *ElTy =
 814     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
 815                    std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
 816   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 817   Assert2(PointerType::get(ElTy) == GEP.getType(),
 818           "GEP is not of right type for indices!", &GEP, ElTy);
 819   visitInstruction(GEP);
 820 }
 821
 822 void Verifier::visitLoadInst(LoadInst &LI) {
 823   const Type *ElTy =
 824     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
 825   Assert2(ElTy == LI.getType(),
 826           "Load result type does not match pointer operand type!", &LI, ElTy);
 827   visitInstruction(LI);
 828 }
 829
 830 void Verifier::visitStoreInst(StoreInst &SI) {
 831   const Type *ElTy =
 832     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
 833   Assert2(ElTy == SI.getOperand(0)->getType(),
 834           "Stored value type does not match pointer operand type!", &SI, ElTy);
 835   visitInstruction(SI);
 836 }
 837
 838
 839 /// verifyInstruction - Verify that an instruction is well formed.
 840 ///
 841 void Verifier::visitInstruction(Instruction &I) {
 842   BasicBlock *BB = I.getParent();
 843   Assert1(BB, "Instruction not embedded in basic block!", &I);
 844
 845   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 846     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 847          UI != UE; ++UI)
 848       Assert1(*UI != (User*)&I ||
 849               !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 850               "Only PHI nodes may reference their own value!", &I);
 851   }
 852
 853   // Check that void typed values don't have names
 854   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 855           "Instruction has a name, but provides a void value!", &I);
 856
 857   // Check that the return value of the instruction is either void or a legal
 858   // value type.
 859   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
 860           "Instruction returns a non-scalar type!", &I);
 861
 862   // Check that all uses of the instruction, if they are instructions
 863   // themselves, actually have parent basic blocks.  If the use is not an
 864   // instruction, it is an error!
 865   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 866        UI != UE; ++UI) {
 867     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
 868             *UI);
 869     Instruction *Used = cast<Instruction>(*UI);
 870     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
 871             " embeded in a basic block!", &I, Used);
 872   }
 873
 874   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
 875     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
 876
 877     // Check to make sure that only first-class-values are operands to
 878     // instructions.
 879     Assert1(I.getOperand(i)->getType()->isFirstClassType(),
 880             "Instruction operands must be first-class values!", &I);
 881
 882     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
 883       // Check to make sure that the "address of" an intrinsic function is never
 884       // taken.
 885       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
 886               "Cannot take the address of an intrinsic!", &I);
 887     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
 888       Assert1(OpBB->getParent() == BB->getParent(),
 889               "Referring to a basic block in another function!", &I);
 890     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
 891       Assert1(OpArg->getParent() == BB->getParent(),
 892               "Referring to an argument in another function!", &I);
 893     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
 894       BasicBlock *OpBlock = Op->getParent();
 895
 896       // Check that a definition dominates all of its uses.
 897       if (!isa<PHINode>(I)) {
 898         // Invoke results are only usable in the normal destination, not in the
 899         // exceptional destination.
 900         if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
 901           OpBlock = II->getNormalDest();
 902
 903           Assert2(OpBlock != II->getUnwindDest(),
 904                   "No uses of invoke possible due to dominance structure!",
 905                   Op, II);
 906
 907           // If the normal successor of an invoke instruction has multiple
 908           // predecessors, then the normal edge from the invoke is critical, so
 909           // the invoke value can only be live if the destination block
 910           // dominates all of it's predecessors (other than the invoke) or if
 911           // the invoke value is only used by a phi in the successor.
 912           if (!OpBlock->getSinglePredecessor() &&
 913               EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
 914             // The first case we allow is if the use is a PHI operand in the
 915             // normal block, and if that PHI operand corresponds to the invoke's
 916             // block.
 917             bool Bad = true;
 918             if (PHINode *PN = dyn_cast<PHINode>(&I))
 919               if (PN->getParent() == OpBlock &&
 920                   PN->getIncomingBlock(i/2) == Op->getParent())
 921                 Bad = false;
 922
 923             // If it is used by something non-phi, then the other case is that
 924             // 'OpBlock' dominates all of its predecessors other than the
 925             // invoke.  In this case, the invoke value can still be used.
 926             if (Bad) {
 927               Bad = false;
 928               for (pred_iterator PI = pred_begin(OpBlock),
 929                    E = pred_end(OpBlock); PI != E; ++PI) {
 930                 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
 931                   Bad = true;
 932                   break;
 933                 }
 934               }
 935             }
 936             Assert2(!Bad,
 937                     "Invoke value defined on critical edge but not dead!", &I,
 938                     Op);
 939           }
 940         } else if (OpBlock == BB) {
 941           // If they are in the same basic block, make sure that the definition
 942           // comes before the use.
 943           Assert2(InstsInThisBlock.count(Op) ||
 944                   !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 945                   "Instruction does not dominate all uses!", Op, &I);
 946         }
 947
 948         // Definition must dominate use unless use is unreachable!
 949         Assert2(EF->dominates(OpBlock, BB) ||
 950                 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
 951                 "Instruction does not dominate all uses!", Op, &I);
 952       } else {
 953         // PHI nodes are more difficult than other nodes because they actually
 954         // "use" the value in the predecessor basic blocks they correspond to.
 955         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
 956         Assert2(EF->dominates(OpBlock, PredBB) ||
 957                 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
 958                 "Instruction does not dominate all uses!", Op, &I);
 959       }
 960     } else if (isa<InlineAsm>(I.getOperand(i))) {
 961       Assert1(i == 0 && isa<CallInst>(I),
 962               "Cannot take the address of an inline asm!", &I);
 963     }
 964   }
 965   InstsInThisBlock.insert(&I);
 966 }
 967
 968 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
 969 ///
 970 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
 971   Function *IF = CI.getCalledFunction();
 972   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!", IF);
 973
 974 #define GET_INTRINSIC_VERIFIER
 975 #include "llvm/Intrinsics.gen"
 976 #undef GET_INTRINSIC_VERIFIER
 977 }
 978
 979 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
 980 /// Intrinsics.gen.  This implements a little state machine that verifies the
 981 /// prototype of intrinsics.
 982 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
 983   va_list VA;
 984   va_start(VA, F);
 985
 986   const FunctionType *FTy = F->getFunctionType();
 987
 988   // Note that "arg#0" is the return type.
 989   for (unsigned ArgNo = 0; 1; ++ArgNo) {
 990     int TypeID = va_arg(VA, int);
 991
 992     if (TypeID == -1) {
 993       if (ArgNo != FTy->getNumParams()+1)
 994         CheckFailed("Intrinsic prototype has too many arguments!", F);
 995       break;
 996     }
 997
 998     if (ArgNo == FTy->getNumParams()+1) {
 999       CheckFailed("Intrinsic prototype has too few arguments!", F);
1000       break;
1001     }
1002
1003     const Type *Ty;
1004     if (ArgNo == 0)
1005       Ty = FTy->getReturnType();
1006     else
1007       Ty = FTy->getParamType(ArgNo-1);
1008
1009     if (TypeID != Ty->getTypeID()) {
1010       if (ArgNo == 0)
1011         CheckFailed("Intrinsic prototype has incorrect result type!", F);
1012       else
1013         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1014       break;
1015     }
1016
1017     if (TypeID == Type::IntegerTyID) {
1018       unsigned GotBits = (unsigned) va_arg(VA, int);
1019       unsigned ExpectBits = cast<IntegerType>(Ty)->getBitWidth();
1020       if (GotBits != ExpectBits) {
1021         std::string bitmsg = " Expecting " + utostr(ExpectBits) + " but got " +
1022                              utostr(GotBits) + " bits.";
1023         if (ArgNo == 0)
1024           CheckFailed("Intrinsic prototype has incorrect integer result width!"
1025                       + bitmsg, F);
1026         else
1027           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1028                       "incorrect integer width!" + bitmsg, F);
1029         break;
1030       }
1031     } else if (TypeID == Type::PackedTyID) {
1032       // If this is a packed argument, verify the number and type of elements.
1033       const PackedType *PTy = cast<PackedType>(Ty);
1034       int ElemTy = va_arg(VA, int);
1035       if (ElemTy != PTy->getElementType()->getTypeID()) {
1036         CheckFailed("Intrinsic prototype has incorrect vector element type!",
1037                     F);
1038         break;
1039       }
1040       if (ElemTy == Type::IntegerTyID) {
1041         unsigned NumBits = (unsigned)va_arg(VA, int);
1042         unsigned ExpectedBits =
1043           cast<IntegerType>(PTy->getElementType())->getBitWidth();
1044         if (NumBits != ExpectedBits) {
1045           CheckFailed("Intrinsic prototype has incorrect vector element type!",
1046                       F);
1047           break;
1048         }
1049       }
1050       if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1051         CheckFailed("Intrinsic prototype has incorrect number of "
1052                     "vector elements!",F);
1053           break;
1054       }
1055     }
1056   }
1057
1058   va_end(VA);
1059 }
1060
1061
1062 //===----------------------------------------------------------------------===//
1063 //  Implement the public interfaces to this file...
1064 //===----------------------------------------------------------------------===//
1065
1066 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1067   return new Verifier(action);
1068 }
1069
1070
1071 // verifyFunction - Create
1072 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1073   Function &F = const_cast<Function&>(f);
1074   assert(!F.isDeclaration() && "Cannot verify external functions");
1075
1076   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1077   Verifier *V = new Verifier(action);
1078   FPM.add(V);
1079   FPM.run(F);
1080   return V->Broken;
1081 }
1082
1083 /// verifyModule - Check a module for errors, printing messages on stderr.
1084 /// Return true if the module is corrupt.
1085 ///
1086 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1087                         std::string *ErrorInfo) {
1088   PassManager PM;
1089   Verifier *V = new Verifier(action);
1090   PM.add(V);
1091   PM.run((Module&)M);
1092
1093   if (ErrorInfo && V->Broken)
1094     *ErrorInfo = V->msgs.str();
1095   return V->Broken;
1096 }
1097
1098 // vim: sw=2