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