lib/VMCore/Verifier.cpp

   1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/CallingConv.h"
  44 #include "llvm/Constants.h"
  45 #include "llvm/DerivedTypes.h"
  46 #include "llvm/InlineAsm.h"
  47 #include "llvm/IntrinsicInst.h"
  48 #include "llvm/Module.h"
  49 #include "llvm/ModuleProvider.h"
  50 #include "llvm/Pass.h"
  51 #include "llvm/PassManager.h"
  52 #include "llvm/Analysis/Dominators.h"
  53 #include "llvm/Assembly/Writer.h"
  54 #include "llvm/CodeGen/ValueTypes.h"
  55 #include "llvm/Support/CallSite.h"
  56 #include "llvm/Support/CFG.h"
  57 #include "llvm/Support/InstVisitor.h"
  58 #include "llvm/Support/Streams.h"
  59 #include "llvm/ADT/SmallPtrSet.h"
  60 #include "llvm/ADT/SmallVector.h"
  61 #include "llvm/ADT/StringExtras.h"
  62 #include "llvm/ADT/STLExtras.h"
  63 #include "llvm/Support/Compiler.h"
  64 #include <algorithm>
  65 #include <sstream>
  66 #include <cstdarg>
  67 using namespace llvm;
  68
  69 namespace {  // Anonymous namespace for class
  70   struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
  71     static char ID; // Pass ID, replacement for typeid
  72
  73     PreVerifier() : FunctionPass((intptr_t)&ID) { }
  74
  75     // Check that the prerequisites for successful DominatorTree construction
  76     // are satisfied.
  77     bool runOnFunction(Function &F) {
  78       bool Broken = false;
  79
  80       for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
  81         if (I->empty() || !I->back().isTerminator()) {
  82           cerr << "Basic Block does not have terminator!\n";
  83           WriteAsOperand(*cerr, I, true);
  84           cerr << "\n";
  85           Broken = true;
  86         }
  87       }
  88
  89       if (Broken)
  90         abort();
  91
  92       return false;
  93     }
  94   };
  95
  96   char PreVerifier::ID = 0;
  97   RegisterPass<PreVerifier> PreVer("preverify", "Preliminary module verification");
  98   const PassInfo *PreVerifyID = PreVer.getPassInfo();
  99
 100   struct VISIBILITY_HIDDEN
 101      Verifier : public FunctionPass, InstVisitor<Verifier> {
 102     static char ID; // Pass ID, replacement for typeid
 103     bool Broken;          // Is this module found to be broken?
 104     bool RealPass;        // Are we not being run by a PassManager?
 105     VerifierFailureAction action;
 106                           // What to do if verification fails.
 107     Module *Mod;          // Module we are verifying right now
 108     DominatorTree *DT; // Dominator Tree, caution can be null!
 109     std::stringstream msgs;  // A stringstream to collect messages
 110
 111     /// InstInThisBlock - when verifying a basic block, keep track of all of the
 112     /// instructions we have seen so far.  This allows us to do efficient
 113     /// dominance checks for the case when an instruction has an operand that is
 114     /// an instruction in the same block.
 115     SmallPtrSet<Instruction*, 16> InstsInThisBlock;
 116
 117     Verifier()
 118       : FunctionPass((intptr_t)&ID),
 119       Broken(false), RealPass(true), action(AbortProcessAction),
 120       DT(0), msgs( std::ios::app | std::ios::out ) {}
 121     Verifier( VerifierFailureAction ctn )
 122       : FunctionPass((intptr_t)&ID),
 123       Broken(false), RealPass(true), action(ctn), DT(0),
 124       msgs( std::ios::app | std::ios::out ) {}
 125     Verifier(bool AB )
 126       : FunctionPass((intptr_t)&ID),
 127       Broken(false), RealPass(true),
 128       action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
 129       msgs( std::ios::app | std::ios::out ) {}
 130     Verifier(DominatorTree &dt)
 131       : FunctionPass((intptr_t)&ID),
 132       Broken(false), RealPass(false), action(PrintMessageAction),
 133       DT(&dt), msgs( std::ios::app | std::ios::out ) {}
 134
 135
 136     bool doInitialization(Module &M) {
 137       Mod = &M;
 138       verifyTypeSymbolTable(M.getTypeSymbolTable());
 139
 140       // If this is a real pass, in a pass manager, we must abort before
 141       // returning back to the pass manager, or else the pass manager may try to
 142       // run other passes on the broken module.
 143       if (RealPass)
 144         return abortIfBroken();
 145       return false;
 146     }
 147
 148     bool runOnFunction(Function &F) {
 149       // Get dominator information if we are being run by PassManager
 150       if (RealPass) DT = &getAnalysis<DominatorTree>();
 151
 152       Mod = F.getParent();
 153
 154       visit(F);
 155       InstsInThisBlock.clear();
 156
 157       // If this is a real pass, in a pass manager, we must abort before
 158       // returning back to the pass manager, or else the pass manager may try to
 159       // run other passes on the broken module.
 160       if (RealPass)
 161         return abortIfBroken();
 162
 163       return false;
 164     }
 165
 166     bool doFinalization(Module &M) {
 167       // Scan through, checking all of the external function's linkage now...
 168       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 169         visitGlobalValue(*I);
 170
 171         // Check to make sure function prototypes are okay.
 172         if (I->isDeclaration()) visitFunction(*I);
 173       }
 174
 175       for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 176            I != E; ++I)
 177         visitGlobalVariable(*I);
 178
 179       for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
 180            I != E; ++I)
 181         visitGlobalAlias(*I);
 182
 183       // If the module is broken, abort at this time.
 184       return abortIfBroken();
 185     }
 186
 187     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 188       AU.setPreservesAll();
 189       AU.addRequiredID(PreVerifyID);
 190       if (RealPass)
 191         AU.addRequired<DominatorTree>();
 192     }
 193
 194     /// abortIfBroken - If the module is broken and we are supposed to abort on
 195     /// this condition, do so.
 196     ///
 197     bool abortIfBroken() {
 198       if (Broken) {
 199         msgs << "Broken module found, ";
 200         switch (action) {
 201           case AbortProcessAction:
 202             msgs << "compilation aborted!\n";
 203             cerr << msgs.str();
 204             abort();
 205           case PrintMessageAction:
 206             msgs << "verification continues.\n";
 207             cerr << msgs.str();
 208             return false;
 209           case ReturnStatusAction:
 210             msgs << "compilation terminated.\n";
 211             return Broken;
 212         }
 213       }
 214       return false;
 215     }
 216
 217
 218     // Verification methods...
 219     void verifyTypeSymbolTable(TypeSymbolTable &ST);
 220     void visitGlobalValue(GlobalValue &GV);
 221     void visitGlobalVariable(GlobalVariable &GV);
 222     void visitGlobalAlias(GlobalAlias &GA);
 223     void visitFunction(Function &F);
 224     void visitBasicBlock(BasicBlock &BB);
 225     void visitTruncInst(TruncInst &I);
 226     void visitZExtInst(ZExtInst &I);
 227     void visitSExtInst(SExtInst &I);
 228     void visitFPTruncInst(FPTruncInst &I);
 229     void visitFPExtInst(FPExtInst &I);
 230     void visitFPToUIInst(FPToUIInst &I);
 231     void visitFPToSIInst(FPToSIInst &I);
 232     void visitUIToFPInst(UIToFPInst &I);
 233     void visitSIToFPInst(SIToFPInst &I);
 234     void visitIntToPtrInst(IntToPtrInst &I);
 235     void visitPtrToIntInst(PtrToIntInst &I);
 236     void visitBitCastInst(BitCastInst &I);
 237     void visitPHINode(PHINode &PN);
 238     void visitBinaryOperator(BinaryOperator &B);
 239     void visitICmpInst(ICmpInst &IC);
 240     void visitFCmpInst(FCmpInst &FC);
 241     void visitExtractElementInst(ExtractElementInst &EI);
 242     void visitInsertElementInst(InsertElementInst &EI);
 243     void visitShuffleVectorInst(ShuffleVectorInst &EI);
 244     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 245     void visitCallInst(CallInst &CI);
 246     void visitInvokeInst(InvokeInst &II);
 247     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 248     void visitLoadInst(LoadInst &LI);
 249     void visitStoreInst(StoreInst &SI);
 250     void visitInstruction(Instruction &I);
 251     void visitTerminatorInst(TerminatorInst &I);
 252     void visitReturnInst(ReturnInst &RI);
 253     void visitSwitchInst(SwitchInst &SI);
 254     void visitSelectInst(SelectInst &SI);
 255     void visitUserOp1(Instruction &I);
 256     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 257     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 258     void visitAllocationInst(AllocationInst &AI);
 259     void visitGetResultInst(GetResultInst &GRI);
 260
 261     void VerifyCallSite(CallSite CS);
 262     void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
 263                                   unsigned Count, ...);
 264     void VerifyAttrs(ParameterAttributes Attrs, const Type *Ty,
 265                      bool isReturnValue, const Value *V);
 266     void VerifyFunctionAttrs(const FunctionType *FT, const PAListPtr &Attrs,
 267                              const Value *V);
 268
 269     void WriteValue(const Value *V) {
 270       if (!V) return;
 271       if (isa<Instruction>(V)) {
 272         msgs << *V;
 273       } else {
 274         WriteAsOperand(msgs, V, true, Mod);
 275         msgs << "\n";
 276       }
 277     }
 278
 279     void WriteType(const Type* T ) {
 280       if ( !T ) return;
 281       WriteTypeSymbolic(msgs, T, Mod );
 282     }
 283
 284
 285     // CheckFailed - A check failed, so print out the condition and the message
 286     // that failed.  This provides a nice place to put a breakpoint if you want
 287     // to see why something is not correct.
 288     void CheckFailed(const std::string &Message,
 289                      const Value *V1 = 0, const Value *V2 = 0,
 290                      const Value *V3 = 0, const Value *V4 = 0) {
 291       msgs << Message << "\n";
 292       WriteValue(V1);
 293       WriteValue(V2);
 294       WriteValue(V3);
 295       WriteValue(V4);
 296       Broken = true;
 297     }
 298
 299     void CheckFailed( const std::string& Message, const Value* V1,
 300                       const Type* T2, const Value* V3 = 0 ) {
 301       msgs << Message << "\n";
 302       WriteValue(V1);
 303       WriteType(T2);
 304       WriteValue(V3);
 305       Broken = true;
 306     }
 307   };
 308
 309   char Verifier::ID = 0;
 310   RegisterPass<Verifier> X("verify", "Module Verifier");
 311 } // End anonymous namespace
 312
 313
 314 // Assert - We know that cond should be true, if not print an error message.
 315 #define Assert(C, M) \
 316   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 317 #define Assert1(C, M, V1) \
 318   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 319 #define Assert2(C, M, V1, V2) \
 320   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 321 #define Assert3(C, M, V1, V2, V3) \
 322   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 323 #define Assert4(C, M, V1, V2, V3, V4) \
 324   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 325
 326
 327 void Verifier::visitGlobalValue(GlobalValue &GV) {
 328   Assert1(!GV.isDeclaration() ||
 329           GV.hasExternalLinkage() ||
 330           GV.hasDLLImportLinkage() ||
 331           GV.hasExternalWeakLinkage() ||
 332           (isa<GlobalAlias>(GV) &&
 333            (GV.hasInternalLinkage() || GV.hasWeakLinkage())),
 334   "Global is external, but doesn't have external or dllimport or weak linkage!",
 335           &GV);
 336
 337   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
 338           "Global is marked as dllimport, but not external", &GV);
 339
 340   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 341           "Only global variables can have appending linkage!", &GV);
 342
 343   if (GV.hasAppendingLinkage()) {
 344     GlobalVariable &GVar = cast<GlobalVariable>(GV);
 345     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
 346             "Only global arrays can have appending linkage!", &GV);
 347   }
 348 }
 349
 350 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 351   if (GV.hasInitializer()) {
 352     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 353             "Global variable initializer type does not match global "
 354             "variable type!", &GV);
 355   } else {
 356     Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
 357             GV.hasExternalWeakLinkage(),
 358             "invalid linkage type for global declaration", &GV);
 359   }
 360
 361   visitGlobalValue(GV);
 362 }
 363
 364 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
 365   Assert1(!GA.getName().empty(),
 366           "Alias name cannot be empty!", &GA);
 367   Assert1(GA.hasExternalLinkage() || GA.hasInternalLinkage() ||
 368           GA.hasWeakLinkage(),
 369           "Alias should have external or external weak linkage!", &GA);
 370   Assert1(GA.getType() == GA.getAliasee()->getType(),
 371           "Alias and aliasee types should match!", &GA);
 372
 373   if (!isa<GlobalValue>(GA.getAliasee())) {
 374     const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
 375     Assert1(CE && CE->getOpcode() == Instruction::BitCast &&
 376             isa<GlobalValue>(CE->getOperand(0)),
 377             "Aliasee should be either GlobalValue or bitcast of GlobalValue",
 378             &GA);
 379   }
 380
 381   const GlobalValue* Aliasee = GA.resolveAliasedGlobal();
 382   Assert1(Aliasee,
 383           "Aliasing chain should end with global function or global variable",
 384           &GA);
 385
 386   visitGlobalValue(GA);
 387 }
 388
 389 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 390 }
 391
 392 // VerifyAttrs - Check the given parameter attributes for an argument or return
 393 // value of the specified type.  The value V is printed in error messages.
 394 void Verifier::VerifyAttrs(ParameterAttributes Attrs, const Type *Ty,
 395                            bool isReturnValue, const Value *V) {
 396   if (Attrs == ParamAttr::None)
 397     return;
 398
 399   if (isReturnValue) {
 400     ParameterAttributes RetI = Attrs & ParamAttr::ParameterOnly;
 401     Assert1(!RetI, "Attribute " + ParamAttr::getAsString(RetI) +
 402             "does not apply to return values!", V);
 403   } else {
 404     ParameterAttributes ParmI = Attrs & ParamAttr::ReturnOnly;
 405     Assert1(!ParmI, "Attribute " + ParamAttr::getAsString(ParmI) +
 406             "only applies to return values!", V);
 407   }
 408
 409   for (unsigned i = 0;
 410        i < array_lengthof(ParamAttr::MutuallyIncompatible); ++i) {
 411     ParameterAttributes MutI = Attrs & ParamAttr::MutuallyIncompatible[i];
 412     Assert1(!(MutI & (MutI - 1)), "Attributes " +
 413             ParamAttr::getAsString(MutI) + "are incompatible!", V);
 414   }
 415
 416   ParameterAttributes TypeI = Attrs & ParamAttr::typeIncompatible(Ty);
 417   Assert1(!TypeI, "Wrong type for attribute " +
 418           ParamAttr::getAsString(TypeI), V);
 419 }
 420
 421 // VerifyFunctionAttrs - Check parameter attributes against a function type.
 422 // The value V is printed in error messages.
 423 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
 424                                    const PAListPtr &Attrs,
 425                                    const Value *V) {
 426   if (Attrs.isEmpty())
 427     return;
 428
 429   bool SawNest = false;
 430
 431   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
 432     const ParamAttrsWithIndex &Attr = Attrs.getSlot(i);
 433
 434     const Type *Ty;
 435     if (Attr.Index == 0)
 436       Ty = FT->getReturnType();
 437     else if (Attr.Index-1 < FT->getNumParams())
 438       Ty = FT->getParamType(Attr.Index-1);
 439     else
 440       break;  // VarArgs attributes, don't verify.
 441
 442     VerifyAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
 443
 444     if (Attr.Attrs & ParamAttr::Nest) {
 445       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
 446       SawNest = true;
 447     }
 448
 449     if (Attr.Attrs & ParamAttr::StructRet)
 450       Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
 451   }
 452 }
 453
 454 // visitFunction - Verify that a function is ok.
 455 //
 456 void Verifier::visitFunction(Function &F) {
 457   // Check function arguments.
 458   const FunctionType *FT = F.getFunctionType();
 459   unsigned NumArgs = F.arg_size();
 460
 461   Assert2(FT->getNumParams() == NumArgs,
 462           "# formal arguments must match # of arguments for function type!",
 463           &F, FT);
 464   Assert1(F.getReturnType()->isFirstClassType() ||
 465           F.getReturnType() == Type::VoidTy ||
 466           isa<StructType>(F.getReturnType()),
 467           "Functions cannot return aggregate values!", &F);
 468
 469   Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
 470           "Invalid struct return type!", &F);
 471
 472   const PAListPtr &Attrs = F.getParamAttrs();
 473
 474   Assert1(Attrs.isEmpty() ||
 475           Attrs.getSlot(Attrs.getNumSlots()-1).Index <= FT->getNumParams(),
 476           "Attributes after last parameter!", &F);
 477
 478   // Check function attributes.
 479   VerifyFunctionAttrs(FT, Attrs, &F);
 480
 481   // Check that this function meets the restrictions on this calling convention.
 482   switch (F.getCallingConv()) {
 483   default:
 484     break;
 485   case CallingConv::C:
 486     break;
 487   case CallingConv::Fast:
 488   case CallingConv::Cold:
 489   case CallingConv::X86_FastCall:
 490     Assert1(!F.isVarArg(),
 491             "Varargs functions must have C calling conventions!", &F);
 492     break;
 493   }
 494
 495   // Check that the argument values match the function type for this function...
 496   unsigned i = 0;
 497   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 498        I != E; ++I, ++i) {
 499     Assert2(I->getType() == FT->getParamType(i),
 500             "Argument value does not match function argument type!",
 501             I, FT->getParamType(i));
 502     // Make sure no aggregates are passed by value.
 503     Assert1(I->getType()->isFirstClassType(),
 504             "Functions cannot take aggregates as arguments by value!", I);
 505    }
 506
 507   if (F.isDeclaration()) {
 508     Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
 509             F.hasExternalWeakLinkage(),
 510             "invalid linkage type for function declaration", &F);
 511   } else {
 512     // Verify that this function (which has a body) is not named "llvm.*".  It
 513     // is not legal to define intrinsics.
 514     if (F.getName().size() >= 5)
 515       Assert1(F.getName().substr(0, 5) != "llvm.",
 516               "llvm intrinsics cannot be defined!", &F);
 517
 518     // Check the entry node
 519     BasicBlock *Entry = &F.getEntryBlock();
 520     Assert1(pred_begin(Entry) == pred_end(Entry),
 521             "Entry block to function must not have predecessors!", Entry);
 522   }
 523 }
 524
 525
 526 // verifyBasicBlock - Verify that a basic block is well formed...
 527 //
 528 void Verifier::visitBasicBlock(BasicBlock &BB) {
 529   InstsInThisBlock.clear();
 530
 531   // Ensure that basic blocks have terminators!
 532   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 533
 534   // Check constraints that this basic block imposes on all of the PHI nodes in
 535   // it.
 536   if (isa<PHINode>(BB.front())) {
 537     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
 538     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
 539     std::sort(Preds.begin(), Preds.end());
 540     PHINode *PN;
 541     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 542
 543       // Ensure that PHI nodes have at least one entry!
 544       Assert1(PN->getNumIncomingValues() != 0,
 545               "PHI nodes must have at least one entry.  If the block is dead, "
 546               "the PHI should be removed!", PN);
 547       Assert1(PN->getNumIncomingValues() == Preds.size(),
 548               "PHINode should have one entry for each predecessor of its "
 549               "parent basic block!", PN);
 550
 551       // Get and sort all incoming values in the PHI node...
 552       Values.clear();
 553       Values.reserve(PN->getNumIncomingValues());
 554       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 555         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 556                                         PN->getIncomingValue(i)));
 557       std::sort(Values.begin(), Values.end());
 558
 559       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 560         // Check to make sure that if there is more than one entry for a
 561         // particular basic block in this PHI node, that the incoming values are
 562         // all identical.
 563         //
 564         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 565                 Values[i].second == Values[i-1].second,
 566                 "PHI node has multiple entries for the same basic block with "
 567                 "different incoming values!", PN, Values[i].first,
 568                 Values[i].second, Values[i-1].second);
 569
 570         // Check to make sure that the predecessors and PHI node entries are
 571         // matched up.
 572         Assert3(Values[i].first == Preds[i],
 573                 "PHI node entries do not match predecessors!", PN,
 574                 Values[i].first, Preds[i]);
 575       }
 576     }
 577   }
 578 }
 579
 580 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 581   // Ensure that terminators only exist at the end of the basic block.
 582   Assert1(&I == I.getParent()->getTerminator(),
 583           "Terminator found in the middle of a basic block!", I.getParent());
 584   visitInstruction(I);
 585 }
 586
 587 void Verifier::visitReturnInst(ReturnInst &RI) {
 588   Function *F = RI.getParent()->getParent();
 589   unsigned N = RI.getNumOperands();
 590   if (N == 0)
 591     Assert2(F->getReturnType() == Type::VoidTy,
 592             "Found return instr that returns void in Function of non-void "
 593             "return type!", &RI, F->getReturnType());
 594   else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
 595     for (unsigned i = 0; i < N; i++)
 596       Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
 597               "Function return type does not match operand "
 598               "type of return inst!", &RI, F->getReturnType());
 599   }
 600   else if (N == 1)
 601     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 602             "Function return type does not match operand "
 603             "type of return inst!", &RI, F->getReturnType());
 604   else
 605     Assert1(0, "Invalid return type!", &RI);
 606
 607   // Check to make sure that the return value has necessary properties for
 608   // terminators...
 609   visitTerminatorInst(RI);
 610 }
 611
 612 void Verifier::visitSwitchInst(SwitchInst &SI) {
 613   // Check to make sure that all of the constants in the switch instruction
 614   // have the same type as the switched-on value.
 615   const Type *SwitchTy = SI.getCondition()->getType();
 616   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
 617     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 618             "Switch constants must all be same type as switch value!", &SI);
 619
 620   visitTerminatorInst(SI);
 621 }
 622
 623 void Verifier::visitSelectInst(SelectInst &SI) {
 624   Assert1(SI.getCondition()->getType() == Type::Int1Ty,
 625           "Select condition type must be bool!", &SI);
 626   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
 627           "Select values must have identical types!", &SI);
 628   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 629           "Select values must have same type as select instruction!", &SI);
 630   visitInstruction(SI);
 631 }
 632
 633
 634 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 635 /// a pass, if any exist, it's an error.
 636 ///
 637 void Verifier::visitUserOp1(Instruction &I) {
 638   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 639 }
 640
 641 void Verifier::visitTruncInst(TruncInst &I) {
 642   // Get the source and destination types
 643   const Type *SrcTy = I.getOperand(0)->getType();
 644   const Type *DestTy = I.getType();
 645
 646   // Get the size of the types in bits, we'll need this later
 647   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 648   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 649
 650   Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
 651   Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
 652   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 653
 654   visitInstruction(I);
 655 }
 656
 657 void Verifier::visitZExtInst(ZExtInst &I) {
 658   // Get the source and destination types
 659   const Type *SrcTy = I.getOperand(0)->getType();
 660   const Type *DestTy = I.getType();
 661
 662   // Get the size of the types in bits, we'll need this later
 663   Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
 664   Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
 665   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 666   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 667
 668   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 669
 670   visitInstruction(I);
 671 }
 672
 673 void Verifier::visitSExtInst(SExtInst &I) {
 674   // Get the source and destination types
 675   const Type *SrcTy = I.getOperand(0)->getType();
 676   const Type *DestTy = I.getType();
 677
 678   // Get the size of the types in bits, we'll need this later
 679   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 680   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 681
 682   Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
 683   Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
 684   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 685
 686   visitInstruction(I);
 687 }
 688
 689 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 690   // Get the source and destination types
 691   const Type *SrcTy = I.getOperand(0)->getType();
 692   const Type *DestTy = I.getType();
 693   // Get the size of the types in bits, we'll need this later
 694   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 695   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 696
 697   Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
 698   Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
 699   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 700
 701   visitInstruction(I);
 702 }
 703
 704 void Verifier::visitFPExtInst(FPExtInst &I) {
 705   // Get the source and destination types
 706   const Type *SrcTy = I.getOperand(0)->getType();
 707   const Type *DestTy = I.getType();
 708
 709   // Get the size of the types in bits, we'll need this later
 710   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 711   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 712
 713   Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
 714   Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
 715   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 716
 717   visitInstruction(I);
 718 }
 719
 720 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 721   // Get the source and destination types
 722   const Type *SrcTy = I.getOperand(0)->getType();
 723   const Type *DestTy = I.getType();
 724
 725   bool SrcVec = isa<VectorType>(SrcTy);
 726   bool DstVec = isa<VectorType>(DestTy);
 727
 728   Assert1(SrcVec == DstVec,
 729           "UIToFP source and dest must both be vector or scalar", &I);
 730   Assert1(SrcTy->isIntOrIntVector(),
 731           "UIToFP source must be integer or integer vector", &I);
 732   Assert1(DestTy->isFPOrFPVector(),
 733           "UIToFP result must be FP or FP vector", &I);
 734
 735   if (SrcVec && DstVec)
 736     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 737             cast<VectorType>(DestTy)->getNumElements(),
 738             "UIToFP source and dest vector length mismatch", &I);
 739
 740   visitInstruction(I);
 741 }
 742
 743 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 744   // Get the source and destination types
 745   const Type *SrcTy = I.getOperand(0)->getType();
 746   const Type *DestTy = I.getType();
 747
 748   bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
 749   bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
 750
 751   Assert1(SrcVec == DstVec,
 752           "SIToFP source and dest must both be vector or scalar", &I);
 753   Assert1(SrcTy->isIntOrIntVector(),
 754           "SIToFP source must be integer or integer vector", &I);
 755   Assert1(DestTy->isFPOrFPVector(),
 756           "SIToFP result must be FP or FP vector", &I);
 757
 758   if (SrcVec && DstVec)
 759     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 760             cast<VectorType>(DestTy)->getNumElements(),
 761             "SIToFP source and dest vector length mismatch", &I);
 762
 763   visitInstruction(I);
 764 }
 765
 766 void Verifier::visitFPToUIInst(FPToUIInst &I) {
 767   // Get the source and destination types
 768   const Type *SrcTy = I.getOperand(0)->getType();
 769   const Type *DestTy = I.getType();
 770
 771   bool SrcVec = isa<VectorType>(SrcTy);
 772   bool DstVec = isa<VectorType>(DestTy);
 773
 774   Assert1(SrcVec == DstVec,
 775           "FPToUI source and dest must both be vector or scalar", &I);
 776   Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
 777   Assert1(DestTy->isIntOrIntVector(),
 778           "FPToUI result must be integer or integer vector", &I);
 779
 780   if (SrcVec && DstVec)
 781     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 782             cast<VectorType>(DestTy)->getNumElements(),
 783             "FPToUI source and dest vector length mismatch", &I);
 784
 785   visitInstruction(I);
 786 }
 787
 788 void Verifier::visitFPToSIInst(FPToSIInst &I) {
 789   // Get the source and destination types
 790   const Type *SrcTy = I.getOperand(0)->getType();
 791   const Type *DestTy = I.getType();
 792
 793   bool SrcVec = isa<VectorType>(SrcTy);
 794   bool DstVec = isa<VectorType>(DestTy);
 795
 796   Assert1(SrcVec == DstVec,
 797           "FPToSI source and dest must both be vector or scalar", &I);
 798   Assert1(SrcTy->isFPOrFPVector(),
 799           "FPToSI source must be FP or FP vector", &I);
 800   Assert1(DestTy->isIntOrIntVector(),
 801           "FPToSI result must be integer or integer vector", &I);
 802
 803   if (SrcVec && DstVec)
 804     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 805             cast<VectorType>(DestTy)->getNumElements(),
 806             "FPToSI source and dest vector length mismatch", &I);
 807
 808   visitInstruction(I);
 809 }
 810
 811 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
 812   // Get the source and destination types
 813   const Type *SrcTy = I.getOperand(0)->getType();
 814   const Type *DestTy = I.getType();
 815
 816   Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
 817   Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
 818
 819   visitInstruction(I);
 820 }
 821
 822 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
 823   // Get the source and destination types
 824   const Type *SrcTy = I.getOperand(0)->getType();
 825   const Type *DestTy = I.getType();
 826
 827   Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
 828   Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
 829
 830   visitInstruction(I);
 831 }
 832
 833 void Verifier::visitBitCastInst(BitCastInst &I) {
 834   // Get the source and destination types
 835   const Type *SrcTy = I.getOperand(0)->getType();
 836   const Type *DestTy = I.getType();
 837
 838   // Get the size of the types in bits, we'll need this later
 839   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
 840   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
 841
 842   // BitCast implies a no-op cast of type only. No bits change.
 843   // However, you can't cast pointers to anything but pointers.
 844   Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
 845           "Bitcast requires both operands to be pointer or neither", &I);
 846   Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
 847
 848   visitInstruction(I);
 849 }
 850
 851 /// visitPHINode - Ensure that a PHI node is well formed.
 852 ///
 853 void Verifier::visitPHINode(PHINode &PN) {
 854   // Ensure that the PHI nodes are all grouped together at the top of the block.
 855   // This can be tested by checking whether the instruction before this is
 856   // either nonexistent (because this is begin()) or is a PHI node.  If not,
 857   // then there is some other instruction before a PHI.
 858   Assert2(&PN == &PN.getParent()->front() ||
 859           isa<PHINode>(--BasicBlock::iterator(&PN)),
 860           "PHI nodes not grouped at top of basic block!",
 861           &PN, PN.getParent());
 862
 863   // Check that all of the operands of the PHI node have the same type as the
 864   // result.
 865   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 866     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
 867             "PHI node operands are not the same type as the result!", &PN);
 868
 869   // All other PHI node constraints are checked in the visitBasicBlock method.
 870
 871   visitInstruction(PN);
 872 }
 873
 874 void Verifier::VerifyCallSite(CallSite CS) {
 875   Instruction *I = CS.getInstruction();
 876
 877   Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
 878           "Called function must be a pointer!", I);
 879   const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
 880   Assert1(isa<FunctionType>(FPTy->getElementType()),
 881           "Called function is not pointer to function type!", I);
 882
 883   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 884
 885   // Verify that the correct number of arguments are being passed
 886   if (FTy->isVarArg())
 887     Assert1(CS.arg_size() >= FTy->getNumParams(),
 888             "Called function requires more parameters than were provided!",I);
 889   else
 890     Assert1(CS.arg_size() == FTy->getNumParams(),
 891             "Incorrect number of arguments passed to called function!", I);
 892
 893   // Verify that all arguments to the call match the function type...
 894   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 895     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
 896             "Call parameter type does not match function signature!",
 897             CS.getArgument(i), FTy->getParamType(i), I);
 898
 899   const PAListPtr &Attrs = CS.getParamAttrs();
 900
 901   Assert1(Attrs.isEmpty() ||
 902           Attrs.getSlot(Attrs.getNumSlots()-1).Index <= CS.arg_size(),
 903           "Attributes after last parameter!", I);
 904
 905   // Verify call attributes.
 906   VerifyFunctionAttrs(FTy, Attrs, I);
 907
 908   if (FTy->isVarArg())
 909     // Check attributes on the varargs part.
 910     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
 911       ParameterAttributes Attr = Attrs.getParamAttrs(Idx);
 912
 913       VerifyAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
 914
 915       ParameterAttributes VArgI = Attr & ParamAttr::VarArgsIncompatible;
 916       Assert1(!VArgI, "Attribute " + ParamAttr::getAsString(VArgI) +
 917               "cannot be used for vararg call arguments!", I);
 918     }
 919
 920   visitInstruction(*I);
 921 }
 922
 923 void Verifier::visitCallInst(CallInst &CI) {
 924   VerifyCallSite(&CI);
 925
 926   if (Function *F = CI.getCalledFunction()) {
 927     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
 928       visitIntrinsicFunctionCall(ID, CI);
 929   }
 930 }
 931
 932 void Verifier::visitInvokeInst(InvokeInst &II) {
 933   VerifyCallSite(&II);
 934 }
 935
 936 /// visitBinaryOperator - Check that both arguments to the binary operator are
 937 /// of the same type!
 938 ///
 939 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 940   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 941           "Both operands to a binary operator are not of the same type!", &B);
 942
 943   switch (B.getOpcode()) {
 944   // Check that logical operators are only used with integral operands.
 945   case Instruction::And:
 946   case Instruction::Or:
 947   case Instruction::Xor:
 948     Assert1(B.getType()->isInteger() ||
 949             (isa<VectorType>(B.getType()) &&
 950              cast<VectorType>(B.getType())->getElementType()->isInteger()),
 951             "Logical operators only work with integral types!", &B);
 952     Assert1(B.getType() == B.getOperand(0)->getType(),
 953             "Logical operators must have same type for operands and result!",
 954             &B);
 955     break;
 956   case Instruction::Shl:
 957   case Instruction::LShr:
 958   case Instruction::AShr:
 959     Assert1(B.getType()->isInteger(),
 960             "Shift must return an integer result!", &B);
 961     Assert1(B.getType() == B.getOperand(0)->getType(),
 962             "Shift return type must be same as operands!", &B);
 963     /* FALL THROUGH */
 964   default:
 965     // Arithmetic operators only work on integer or fp values
 966     Assert1(B.getType() == B.getOperand(0)->getType(),
 967             "Arithmetic operators must have same type for operands and result!",
 968             &B);
 969     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
 970             isa<VectorType>(B.getType()),
 971             "Arithmetic operators must have integer, fp, or vector type!", &B);
 972     break;
 973   }
 974
 975   visitInstruction(B);
 976 }
 977
 978 void Verifier::visitICmpInst(ICmpInst& IC) {
 979   // Check that the operands are the same type
 980   const Type* Op0Ty = IC.getOperand(0)->getType();
 981   const Type* Op1Ty = IC.getOperand(1)->getType();
 982   Assert1(Op0Ty == Op1Ty,
 983           "Both operands to ICmp instruction are not of the same type!", &IC);
 984   // Check that the operands are the right type
 985   Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
 986           "Invalid operand types for ICmp instruction", &IC);
 987   visitInstruction(IC);
 988 }
 989
 990 void Verifier::visitFCmpInst(FCmpInst& FC) {
 991   // Check that the operands are the same type
 992   const Type* Op0Ty = FC.getOperand(0)->getType();
 993   const Type* Op1Ty = FC.getOperand(1)->getType();
 994   Assert1(Op0Ty == Op1Ty,
 995           "Both operands to FCmp instruction are not of the same type!", &FC);
 996   // Check that the operands are the right type
 997   Assert1(Op0Ty->isFloatingPoint(),
 998           "Invalid operand types for FCmp instruction", &FC);
 999   visitInstruction(FC);
1000 }
1001
1002 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1003   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1004                                               EI.getOperand(1)),
1005           "Invalid extractelement operands!", &EI);
1006   visitInstruction(EI);
1007 }
1008
1009 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1010   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1011                                              IE.getOperand(1),
1012                                              IE.getOperand(2)),
1013           "Invalid insertelement operands!", &IE);
1014   visitInstruction(IE);
1015 }
1016
1017 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1018   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1019                                              SV.getOperand(2)),
1020           "Invalid shufflevector operands!", &SV);
1021   Assert1(SV.getType() == SV.getOperand(0)->getType(),
1022           "Result of shufflevector must match first operand type!", &SV);
1023
1024   // Check to see if Mask is valid.
1025   if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1026     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1027       Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
1028               isa<UndefValue>(MV->getOperand(i)),
1029               "Invalid shufflevector shuffle mask!", &SV);
1030     }
1031   } else {
1032     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1033             isa<ConstantAggregateZero>(SV.getOperand(2)),
1034             "Invalid shufflevector shuffle mask!", &SV);
1035   }
1036
1037   visitInstruction(SV);
1038 }
1039
1040 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1041   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1042   const Type *ElTy =
1043     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1044                                       Idxs.begin(), Idxs.end(), true);
1045   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1046   Assert2(isa<PointerType>(GEP.getType()) &&
1047           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1048           "GEP is not of right type for indices!", &GEP, ElTy);
1049   visitInstruction(GEP);
1050 }
1051
1052 void Verifier::visitLoadInst(LoadInst &LI) {
1053   const Type *ElTy =
1054     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1055   Assert2(ElTy == LI.getType(),
1056           "Load result type does not match pointer operand type!", &LI, ElTy);
1057   visitInstruction(LI);
1058 }
1059
1060 void Verifier::visitStoreInst(StoreInst &SI) {
1061   const Type *ElTy =
1062     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1063   Assert2(ElTy == SI.getOperand(0)->getType(),
1064           "Stored value type does not match pointer operand type!", &SI, ElTy);
1065   visitInstruction(SI);
1066 }
1067
1068 void Verifier::visitAllocationInst(AllocationInst &AI) {
1069   const PointerType *PTy = AI.getType();
1070   Assert1(PTy->getAddressSpace() == 0,
1071           "Allocation instruction pointer not in the generic address space!",
1072           &AI);
1073   Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1074           &AI);
1075   visitInstruction(AI);
1076 }
1077
1078 void Verifier::visitGetResultInst(GetResultInst &GRI) {
1079   Assert1(GRI.isValidOperands(GRI.getAggregateValue(), GRI.getIndex()),
1080           "Invalid GetResultInst operands!", &GRI);
1081   visitInstruction(GRI);
1082 }
1083
1084
1085 /// verifyInstruction - Verify that an instruction is well formed.
1086 ///
1087 void Verifier::visitInstruction(Instruction &I) {
1088   BasicBlock *BB = I.getParent();
1089   Assert1(BB, "Instruction not embedded in basic block!", &I);
1090
1091   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
1092     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1093          UI != UE; ++UI)
1094       Assert1(*UI != (User*)&I ||
1095               !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1096               "Only PHI nodes may reference their own value!", &I);
1097   }
1098
1099   // Verify that if this is a terminator that it is at the end of the block.
1100   if (isa<TerminatorInst>(I))
1101     Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1102
1103
1104   // Check that void typed values don't have names
1105   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1106           "Instruction has a name, but provides a void value!", &I);
1107
1108   // Check that the return value of the instruction is either void or a legal
1109   // value type.
1110   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1111           || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1112               && isa<StructType>(I.getType())),
1113           "Instruction returns a non-scalar type!", &I);
1114
1115   // Check that all uses of the instruction, if they are instructions
1116   // themselves, actually have parent basic blocks.  If the use is not an
1117   // instruction, it is an error!
1118   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1119        UI != UE; ++UI) {
1120     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1121             *UI);
1122     Instruction *Used = cast<Instruction>(*UI);
1123     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1124             " embeded in a basic block!", &I, Used);
1125   }
1126
1127   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1128     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1129
1130     // Check to make sure that only first-class-values are operands to
1131     // instructions.
1132     if (!I.getOperand(i)->getType()->isFirstClassType()) {
1133       if (isa<ReturnInst>(I) || isa<GetResultInst>(I))
1134         Assert1(isa<StructType>(I.getOperand(i)->getType()),
1135                 "Invalid ReturnInst operands!", &I);
1136       else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
1137         if (const PointerType *PT = dyn_cast<PointerType>
1138             (I.getOperand(i)->getType())) {
1139           const Type *ETy = PT->getElementType();
1140           Assert1(isa<StructType>(ETy), "Invalid CallInst operands!", &I);
1141         }
1142         else
1143           Assert1(0, "Invalid CallInst operands!", &I);
1144       }
1145       else
1146         Assert1(0, "Instruction operands must be first-class values!", &I);
1147     }
1148
1149     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1150       // Check to make sure that the "address of" an intrinsic function is never
1151       // taken.
1152       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1153               "Cannot take the address of an intrinsic!", &I);
1154       Assert1(F->getParent() == Mod, "Referencing function in another module!",
1155               &I);
1156     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1157       Assert1(OpBB->getParent() == BB->getParent(),
1158               "Referring to a basic block in another function!", &I);
1159     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1160       Assert1(OpArg->getParent() == BB->getParent(),
1161               "Referring to an argument in another function!", &I);
1162     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1163       Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1164               &I);
1165     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1166       BasicBlock *OpBlock = Op->getParent();
1167
1168       // Check that a definition dominates all of its uses.
1169       if (!isa<PHINode>(I)) {
1170         // Invoke results are only usable in the normal destination, not in the
1171         // exceptional destination.
1172         if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1173           OpBlock = II->getNormalDest();
1174
1175           Assert2(OpBlock != II->getUnwindDest(),
1176                   "No uses of invoke possible due to dominance structure!",
1177                   Op, II);
1178
1179           // If the normal successor of an invoke instruction has multiple
1180           // predecessors, then the normal edge from the invoke is critical, so
1181           // the invoke value can only be live if the destination block
1182           // dominates all of it's predecessors (other than the invoke) or if
1183           // the invoke value is only used by a phi in the successor.
1184           if (!OpBlock->getSinglePredecessor() &&
1185               DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1186             // The first case we allow is if the use is a PHI operand in the
1187             // normal block, and if that PHI operand corresponds to the invoke's
1188             // block.
1189             bool Bad = true;
1190             if (PHINode *PN = dyn_cast<PHINode>(&I))
1191               if (PN->getParent() == OpBlock &&
1192                   PN->getIncomingBlock(i/2) == Op->getParent())
1193                 Bad = false;
1194
1195             // If it is used by something non-phi, then the other case is that
1196             // 'OpBlock' dominates all of its predecessors other than the
1197             // invoke.  In this case, the invoke value can still be used.
1198             if (Bad) {
1199               Bad = false;
1200               for (pred_iterator PI = pred_begin(OpBlock),
1201                    E = pred_end(OpBlock); PI != E; ++PI) {
1202                 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1203                   Bad = true;
1204                   break;
1205                 }
1206               }
1207             }
1208             Assert2(!Bad,
1209                     "Invoke value defined on critical edge but not dead!", &I,
1210                     Op);
1211           }
1212         } else if (OpBlock == BB) {
1213           // If they are in the same basic block, make sure that the definition
1214           // comes before the use.
1215           Assert2(InstsInThisBlock.count(Op) ||
1216                   !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1217                   "Instruction does not dominate all uses!", Op, &I);
1218         }
1219
1220         // Definition must dominate use unless use is unreachable!
1221         Assert2(DT->dominates(OpBlock, BB) ||
1222                 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1223                 "Instruction does not dominate all uses!", Op, &I);
1224       } else {
1225         // PHI nodes are more difficult than other nodes because they actually
1226         // "use" the value in the predecessor basic blocks they correspond to.
1227         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1228         Assert2(DT->dominates(OpBlock, PredBB) ||
1229                 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1230                 "Instruction does not dominate all uses!", Op, &I);
1231       }
1232     } else if (isa<InlineAsm>(I.getOperand(i))) {
1233       Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1234               "Cannot take the address of an inline asm!", &I);
1235     }
1236   }
1237   InstsInThisBlock.insert(&I);
1238 }
1239
1240 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1241 ///
1242 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1243   Function *IF = CI.getCalledFunction();
1244   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1245           IF);
1246
1247 #define GET_INTRINSIC_VERIFIER
1248 #include "llvm/Intrinsics.gen"
1249 #undef GET_INTRINSIC_VERIFIER
1250
1251   switch (ID) {
1252   default:
1253     break;
1254   case Intrinsic::gcroot:
1255   case Intrinsic::gcwrite:
1256   case Intrinsic::gcread: {
1257       Type *PtrTy    = PointerType::getUnqual(Type::Int8Ty),
1258            *PtrPtrTy = PointerType::getUnqual(PtrTy);
1259
1260       switch (ID) {
1261       default:
1262         break;
1263       case Intrinsic::gcroot:
1264         Assert1(CI.getOperand(1)->getType() == PtrPtrTy,
1265                 "Intrinsic parameter #1 is not i8**.", &CI);
1266         Assert1(CI.getOperand(2)->getType() == PtrTy,
1267                 "Intrinsic parameter #2 is not i8*.", &CI);
1268         Assert1(isa<AllocaInst>(
1269                   IntrinsicInst::StripPointerCasts(CI.getOperand(1))),
1270                 "llvm.gcroot parameter #1 must be an alloca.", &CI);
1271         Assert1(isa<Constant>(CI.getOperand(2)),
1272                 "llvm.gcroot parameter #2 must be a constant.", &CI);
1273         break;
1274       case Intrinsic::gcwrite:
1275         Assert1(CI.getOperand(1)->getType() == PtrTy,
1276                 "Intrinsic parameter #1 is not a i8*.", &CI);
1277         Assert1(CI.getOperand(2)->getType() == PtrTy,
1278                 "Intrinsic parameter #2 is not a i8*.", &CI);
1279         Assert1(CI.getOperand(3)->getType() == PtrPtrTy,
1280                 "Intrinsic parameter #3 is not a i8**.", &CI);
1281         break;
1282       case Intrinsic::gcread:
1283         Assert1(CI.getOperand(1)->getType() == PtrTy,
1284                 "Intrinsic parameter #1 is not a i8*.", &CI);
1285         Assert1(CI.getOperand(2)->getType() == PtrPtrTy,
1286                 "Intrinsic parameter #2 is not a i8**.", &CI);
1287         break;
1288       }
1289
1290       Assert1(CI.getParent()->getParent()->hasCollector(),
1291               "Enclosing function does not specify a collector algorithm.",
1292               &CI);
1293     } break;
1294   case Intrinsic::init_trampoline:
1295     Assert1(isa<Function>(IntrinsicInst::StripPointerCasts(CI.getOperand(2))),
1296             "llvm.init_trampoline parameter #2 must resolve to a function.",
1297             &CI);
1298     break;
1299   }
1300 }
1301
1302 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1303 /// Intrinsics.gen.  This implements a little state machine that verifies the
1304 /// prototype of intrinsics.
1305 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID,
1306                                         Function *F,
1307                                         unsigned Count, ...) {
1308   va_list VA;
1309   va_start(VA, Count);
1310
1311   const FunctionType *FTy = F->getFunctionType();
1312
1313   // For overloaded intrinsics, the Suffix of the function name must match the
1314   // types of the arguments. This variable keeps track of the expected
1315   // suffix, to be checked at the end.
1316   std::string Suffix;
1317
1318   if (FTy->getNumParams() + FTy->isVarArg() != Count - 1) {
1319     CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1320     return;
1321   }
1322
1323   // Note that "arg#0" is the return type.
1324   for (unsigned ArgNo = 0; ArgNo < Count; ++ArgNo) {
1325     MVT::ValueType VT = va_arg(VA, MVT::ValueType);
1326
1327     if (VT == MVT::isVoid && ArgNo > 0) {
1328       if (!FTy->isVarArg())
1329         CheckFailed("Intrinsic prototype has no '...'!", F);
1330       break;
1331     }
1332
1333     const Type *Ty;
1334     if (ArgNo == 0)
1335       Ty = FTy->getReturnType();
1336     else
1337       Ty = FTy->getParamType(ArgNo-1);
1338
1339     unsigned NumElts = 0;
1340     const Type *EltTy = Ty;
1341     if (const VectorType *VTy = dyn_cast<VectorType>(Ty)) {
1342       EltTy = VTy->getElementType();
1343       NumElts = VTy->getNumElements();
1344     }
1345
1346     if ((int)VT < 0) {
1347       int Match = ~VT;
1348       if (Match == 0) {
1349         if (Ty != FTy->getReturnType()) {
1350           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1351                       "match return type.", F);
1352           break;
1353         }
1354       } else {
1355         if (Ty != FTy->getParamType(Match-1)) {
1356           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " does not "
1357                       "match parameter %" + utostr(Match-1) + ".", F);
1358           break;
1359         }
1360       }
1361     } else if (VT == MVT::iAny) {
1362       if (!EltTy->isInteger()) {
1363         if (ArgNo == 0)
1364           CheckFailed("Intrinsic result type is not "
1365                       "an integer type.", F);
1366         else
1367           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1368                       "an integer type.", F);
1369         break;
1370       }
1371       unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1372       Suffix += ".";
1373       if (EltTy != Ty)
1374         Suffix += "v" + utostr(NumElts);
1375       Suffix += "i" + utostr(GotBits);;
1376       // Check some constraints on various intrinsics.
1377       switch (ID) {
1378         default: break; // Not everything needs to be checked.
1379         case Intrinsic::bswap:
1380           if (GotBits < 16 || GotBits % 16 != 0)
1381             CheckFailed("Intrinsic requires even byte width argument", F);
1382           break;
1383       }
1384     } else if (VT == MVT::fAny) {
1385       if (!EltTy->isFloatingPoint()) {
1386         if (ArgNo == 0)
1387           CheckFailed("Intrinsic result type is not "
1388                       "a floating-point type.", F);
1389         else
1390           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not "
1391                       "a floating-point type.", F);
1392         break;
1393       }
1394       Suffix += ".";
1395       if (EltTy != Ty)
1396         Suffix += "v" + utostr(NumElts);
1397       Suffix += MVT::getValueTypeString(MVT::getValueType(EltTy));
1398     } else if (VT == MVT::iPTR) {
1399       if (!isa<PointerType>(Ty)) {
1400         if (ArgNo == 0)
1401           CheckFailed("Intrinsic result type is not a "
1402                       "pointer and a pointer is required.", F);
1403         else
1404           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is not a "
1405                       "pointer and a pointer is required.", F);
1406         break;
1407       }
1408     } else if (MVT::isVector(VT)) {
1409       // If this is a vector argument, verify the number and type of elements.
1410       if (MVT::getVectorElementType(VT) != MVT::getValueType(EltTy)) {
1411         CheckFailed("Intrinsic prototype has incorrect vector element type!",
1412                     F);
1413         break;
1414       }
1415       if (MVT::getVectorNumElements(VT) != NumElts) {
1416         CheckFailed("Intrinsic prototype has incorrect number of "
1417                     "vector elements!",F);
1418         break;
1419       }
1420     } else if (MVT::getTypeForValueType(VT) != EltTy) {
1421       if (ArgNo == 0)
1422         CheckFailed("Intrinsic prototype has incorrect result type!", F);
1423       else
1424         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1425       break;
1426     } else if (EltTy != Ty) {
1427       if (ArgNo == 0)
1428         CheckFailed("Intrinsic result type is vector "
1429                     "and a scalar is required.", F);
1430       else
1431         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is vector "
1432                     "and a scalar is required.", F);
1433     }
1434   }
1435
1436   va_end(VA);
1437
1438   // If we computed a Suffix then the intrinsic is overloaded and we need to
1439   // make sure that the name of the function is correct. We add the suffix to
1440   // the name of the intrinsic and compare against the given function name. If
1441   // they are not the same, the function name is invalid. This ensures that
1442   // overloading of intrinsics uses a sane and consistent naming convention.
1443   if (!Suffix.empty()) {
1444     std::string Name(Intrinsic::getName(ID));
1445     if (Name + Suffix != F->getName())
1446       CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1447                   F->getName().substr(Name.length()) + "'. It should be '" +
1448                   Suffix + "'", F);
1449   }
1450 }
1451
1452
1453 //===----------------------------------------------------------------------===//
1454 //  Implement the public interfaces to this file...
1455 //===----------------------------------------------------------------------===//
1456
1457 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1458   return new Verifier(action);
1459 }
1460
1461
1462 // verifyFunction - Create
1463 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1464   Function &F = const_cast<Function&>(f);
1465   assert(!F.isDeclaration() && "Cannot verify external functions");
1466
1467   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1468   Verifier *V = new Verifier(action);
1469   FPM.add(V);
1470   FPM.run(F);
1471   return V->Broken;
1472 }
1473
1474 /// verifyModule - Check a module for errors, printing messages on stderr.
1475 /// Return true if the module is corrupt.
1476 ///
1477 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1478                         std::string *ErrorInfo) {
1479   PassManager PM;
1480   Verifier *V = new Verifier(action);
1481   PM.add(V);
1482   PM.run((Module&)M);
1483
1484   if (ErrorInfo && V->Broken)
1485     *ErrorInfo = V->msgs.str();
1486   return V->Broken;
1487 }
1488
1489 // vim: sw=2