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