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