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