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