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