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