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