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