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/Metadata.h"
  49 #include "llvm/Module.h"
  50 #include "llvm/Pass.h"
  51 #include "llvm/PassManager.h"
  52 #include "llvm/TypeSymbolTable.h"
  53 #include "llvm/Analysis/Dominators.h"
  54 #include "llvm/Assembly/Writer.h"
  55 #include "llvm/CodeGen/ValueTypes.h"
  56 #include "llvm/Support/CallSite.h"
  57 #include "llvm/Support/CFG.h"
  58 #include "llvm/Support/Debug.h"
  59 #include "llvm/Support/InstVisitor.h"
  60 #include "llvm/ADT/SetVector.h"
  61 #include "llvm/ADT/SmallPtrSet.h"
  62 #include "llvm/ADT/SmallVector.h"
  63 #include "llvm/ADT/StringExtras.h"
  64 #include "llvm/ADT/STLExtras.h"
  65 #include "llvm/Support/ErrorHandling.h"
  66 #include "llvm/Support/raw_ostream.h"
  67 #include <algorithm>
  68 #include <cstdarg>
  69 using namespace llvm;
  70
  71 namespace {  // Anonymous namespace for class
  72   struct PreVerifier : public FunctionPass {
  73     static char ID; // Pass ID, replacement for typeid
  74
  75     PreVerifier() : FunctionPass(&ID) { }
  76
  77     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  78       AU.setPreservesAll();
  79     }
  80
  81     // Check that the prerequisites for successful DominatorTree construction
  82     // are satisfied.
  83     bool runOnFunction(Function &F) {
  84       bool Broken = false;
  85
  86       for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
  87         if (I->empty() || !I->back().isTerminator()) {
  88           dbgs() << "Basic Block does not have terminator!\n";
  89           WriteAsOperand(dbgs(), I, true);
  90           dbgs() << "\n";
  91           Broken = true;
  92         }
  93       }
  94
  95       if (Broken)
  96         report_fatal_error("Broken module, no Basic Block terminator!");
  97
  98       return false;
  99     }
 100   };
 101 }
 102
 103 char PreVerifier::ID = 0;
 104 static RegisterPass<PreVerifier>
 105 PreVer("preverify", "Preliminary module verification");
 106 static const PassInfo *const PreVerifyID = &PreVer;
 107
 108 namespace {
 109   class TypeSet : public AbstractTypeUser {
 110   public:
 111     TypeSet() {}
 112
 113     /// Insert a type into the set of types.
 114     bool insert(const Type *Ty) {
 115       if (!Types.insert(Ty))
 116         return false;
 117       if (Ty->isAbstract())
 118         Ty->addAbstractTypeUser(this);
 119       return true;
 120     }
 121
 122     // Remove ourselves as abstract type listeners for any types that remain
 123     // abstract when the TypeSet is destroyed.
 124     ~TypeSet() {
 125       for (SmallSetVector<const Type *, 16>::iterator I = Types.begin(),
 126              E = Types.end(); I != E; ++I) {
 127         const Type *Ty = *I;
 128         if (Ty->isAbstract())
 129           Ty->removeAbstractTypeUser(this);
 130       }
 131     }
 132
 133     // Abstract type user interface.
 134
 135     /// Remove types from the set when refined. Do not insert the type it was
 136     /// refined to because that type hasn't been verified yet.
 137     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
 138       Types.remove(OldTy);
 139       OldTy->removeAbstractTypeUser(this);
 140     }
 141
 142     /// Stop listening for changes to a type which is no longer abstract.
 143     void typeBecameConcrete(const DerivedType *AbsTy) {
 144       AbsTy->removeAbstractTypeUser(this);
 145     }
 146
 147     void dump() const {}
 148
 149   private:
 150     SmallSetVector<const Type *, 16> Types;
 151
 152     // Disallow copying.
 153     TypeSet(const TypeSet &);
 154     TypeSet &operator=(const TypeSet &);
 155   };
 156
 157   struct Verifier : public FunctionPass, public InstVisitor<Verifier> {
 158     static char ID; // Pass ID, replacement for typeid
 159     bool Broken;          // Is this module found to be broken?
 160     bool RealPass;        // Are we not being run by a PassManager?
 161     VerifierFailureAction action;
 162                           // What to do if verification fails.
 163     Module *Mod;          // Module we are verifying right now
 164     LLVMContext *Context; // Context within which we are verifying
 165     DominatorTree *DT;    // Dominator Tree, caution can be null!
 166
 167     std::string Messages;
 168     raw_string_ostream MessagesStr;
 169
 170     /// InstInThisBlock - when verifying a basic block, keep track of all of the
 171     /// instructions we have seen so far.  This allows us to do efficient
 172     /// dominance checks for the case when an instruction has an operand that is
 173     /// an instruction in the same block.
 174     SmallPtrSet<Instruction*, 16> InstsInThisBlock;
 175
 176     /// Types - keep track of the types that have been checked already.
 177     TypeSet Types;
 178
 179     /// MDNodes - keep track of the metadata nodes that have been checked
 180     /// already.
 181     SmallPtrSet<MDNode *, 32> MDNodes;
 182
 183     Verifier()
 184       : FunctionPass(&ID),
 185       Broken(false), RealPass(true), action(AbortProcessAction),
 186       Mod(0), Context(0), DT(0), MessagesStr(Messages) {}
 187     explicit Verifier(VerifierFailureAction ctn)
 188       : FunctionPass(&ID),
 189       Broken(false), RealPass(true), action(ctn), Mod(0), Context(0), DT(0),
 190       MessagesStr(Messages) {}
 191     explicit Verifier(bool AB)
 192       : FunctionPass(&ID),
 193       Broken(false), RealPass(true),
 194       action( AB ? AbortProcessAction : PrintMessageAction), Mod(0),
 195       Context(0), DT(0), MessagesStr(Messages) {}
 196     explicit Verifier(DominatorTree &dt)
 197       : FunctionPass(&ID),
 198       Broken(false), RealPass(false), action(PrintMessageAction), Mod(0),
 199       Context(0), DT(&dt), MessagesStr(Messages) {}
 200
 201
 202     bool doInitialization(Module &M) {
 203       Mod = &M;
 204       Context = &M.getContext();
 205       verifyTypeSymbolTable(M.getTypeSymbolTable());
 206
 207       // If this is a real pass, in a pass manager, we must abort before
 208       // returning back to the pass manager, or else the pass manager may try to
 209       // run other passes on the broken module.
 210       if (RealPass)
 211         return abortIfBroken();
 212       return false;
 213     }
 214
 215     bool runOnFunction(Function &F) {
 216       // Get dominator information if we are being run by PassManager
 217       if (RealPass) DT = &getAnalysis<DominatorTree>();
 218
 219       Mod = F.getParent();
 220       if (!Context) Context = &F.getContext();
 221
 222       visit(F);
 223       InstsInThisBlock.clear();
 224
 225       // If this is a real pass, in a pass manager, we must abort before
 226       // returning back to the pass manager, or else the pass manager may try to
 227       // run other passes on the broken module.
 228       if (RealPass)
 229         return abortIfBroken();
 230
 231       return false;
 232     }
 233
 234     bool doFinalization(Module &M) {
 235       // Scan through, checking all of the external function's linkage now...
 236       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
 237         visitGlobalValue(*I);
 238
 239         // Check to make sure function prototypes are okay.
 240         if (I->isDeclaration()) visitFunction(*I);
 241       }
 242
 243       for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 244            I != E; ++I)
 245         visitGlobalVariable(*I);
 246
 247       for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
 248            I != E; ++I)
 249         visitGlobalAlias(*I);
 250
 251       for (Module::named_metadata_iterator I = M.named_metadata_begin(),
 252            E = M.named_metadata_end(); I != E; ++I)
 253         visitNamedMDNode(*I);
 254
 255       // If the module is broken, abort at this time.
 256       return abortIfBroken();
 257     }
 258
 259     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 260       AU.setPreservesAll();
 261       AU.addRequiredID(PreVerifyID);
 262       if (RealPass)
 263         AU.addRequired<DominatorTree>();
 264     }
 265
 266     /// abortIfBroken - If the module is broken and we are supposed to abort on
 267     /// this condition, do so.
 268     ///
 269     bool abortIfBroken() {
 270       if (!Broken) return false;
 271       MessagesStr << "Broken module found, ";
 272       switch (action) {
 273       default: llvm_unreachable("Unknown action");
 274       case AbortProcessAction:
 275         MessagesStr << "compilation aborted!\n";
 276         dbgs() << MessagesStr.str();
 277         // Client should choose different reaction if abort is not desired
 278         abort();
 279       case PrintMessageAction:
 280         MessagesStr << "verification continues.\n";
 281         dbgs() << MessagesStr.str();
 282         return false;
 283       case ReturnStatusAction:
 284         MessagesStr << "compilation terminated.\n";
 285         return true;
 286       }
 287     }
 288
 289
 290     // Verification methods...
 291     void verifyTypeSymbolTable(TypeSymbolTable &ST);
 292     void visitGlobalValue(GlobalValue &GV);
 293     void visitGlobalVariable(GlobalVariable &GV);
 294     void visitGlobalAlias(GlobalAlias &GA);
 295     void visitNamedMDNode(NamedMDNode &NMD);
 296     void visitMDNode(MDNode &MD, Function *F);
 297     void visitFunction(Function &F);
 298     void visitBasicBlock(BasicBlock &BB);
 299     using InstVisitor<Verifier>::visit;
 300
 301     void visit(Instruction &I);
 302
 303     void visitTruncInst(TruncInst &I);
 304     void visitZExtInst(ZExtInst &I);
 305     void visitSExtInst(SExtInst &I);
 306     void visitFPTruncInst(FPTruncInst &I);
 307     void visitFPExtInst(FPExtInst &I);
 308     void visitFPToUIInst(FPToUIInst &I);
 309     void visitFPToSIInst(FPToSIInst &I);
 310     void visitUIToFPInst(UIToFPInst &I);
 311     void visitSIToFPInst(SIToFPInst &I);
 312     void visitIntToPtrInst(IntToPtrInst &I);
 313     void visitPtrToIntInst(PtrToIntInst &I);
 314     void visitBitCastInst(BitCastInst &I);
 315     void visitPHINode(PHINode &PN);
 316     void visitBinaryOperator(BinaryOperator &B);
 317     void visitICmpInst(ICmpInst &IC);
 318     void visitFCmpInst(FCmpInst &FC);
 319     void visitExtractElementInst(ExtractElementInst &EI);
 320     void visitInsertElementInst(InsertElementInst &EI);
 321     void visitShuffleVectorInst(ShuffleVectorInst &EI);
 322     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
 323     void visitCallInst(CallInst &CI);
 324     void visitInvokeInst(InvokeInst &II);
 325     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 326     void visitLoadInst(LoadInst &LI);
 327     void visitStoreInst(StoreInst &SI);
 328     void visitInstruction(Instruction &I);
 329     void visitTerminatorInst(TerminatorInst &I);
 330     void visitBranchInst(BranchInst &BI);
 331     void visitReturnInst(ReturnInst &RI);
 332     void visitSwitchInst(SwitchInst &SI);
 333     void visitSelectInst(SelectInst &SI);
 334     void visitUserOp1(Instruction &I);
 335     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
 336     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
 337     void visitAllocaInst(AllocaInst &AI);
 338     void visitExtractValueInst(ExtractValueInst &EVI);
 339     void visitInsertValueInst(InsertValueInst &IVI);
 340
 341     void VerifyCallSite(CallSite CS);
 342     bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
 343                           int VT, unsigned ArgNo, std::string &Suffix);
 344     void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
 345                                   unsigned RetNum, unsigned ParamNum, ...);
 346     void VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
 347                               bool isReturnValue, const Value *V);
 348     void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
 349                              const Value *V);
 350     void VerifyType(const Type *Ty);
 351
 352     void WriteValue(const Value *V) {
 353       if (!V) return;
 354       if (isa<Instruction>(V)) {
 355         MessagesStr << *V << '\n';
 356       } else {
 357         WriteAsOperand(MessagesStr, V, true, Mod);
 358         MessagesStr << '\n';
 359       }
 360     }
 361
 362     void WriteType(const Type *T) {
 363       if (!T) return;
 364       MessagesStr << ' ';
 365       WriteTypeSymbolic(MessagesStr, T, Mod);
 366     }
 367
 368
 369     // CheckFailed - A check failed, so print out the condition and the message
 370     // that failed.  This provides a nice place to put a breakpoint if you want
 371     // to see why something is not correct.
 372     void CheckFailed(const Twine &Message,
 373                      const Value *V1 = 0, const Value *V2 = 0,
 374                      const Value *V3 = 0, const Value *V4 = 0) {
 375       MessagesStr << Message.str() << "\n";
 376       WriteValue(V1);
 377       WriteValue(V2);
 378       WriteValue(V3);
 379       WriteValue(V4);
 380       Broken = true;
 381     }
 382
 383     void CheckFailed(const Twine &Message, const Value *V1,
 384                      const Type *T2, const Value *V3 = 0) {
 385       MessagesStr << Message.str() << "\n";
 386       WriteValue(V1);
 387       WriteType(T2);
 388       WriteValue(V3);
 389       Broken = true;
 390     }
 391
 392     void CheckFailed(const Twine &Message, const Type *T1,
 393                      const Type *T2 = 0, const Type *T3 = 0) {
 394       MessagesStr << Message.str() << "\n";
 395       WriteType(T1);
 396       WriteType(T2);
 397       WriteType(T3);
 398       Broken = true;
 399     }
 400   };
 401 } // End anonymous namespace
 402
 403 char Verifier::ID = 0;
 404 static RegisterPass<Verifier> X("verify", "Module Verifier");
 405
 406 // Assert - We know that cond should be true, if not print an error message.
 407 #define Assert(C, M) \
 408   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 409 #define Assert1(C, M, V1) \
 410   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 411 #define Assert2(C, M, V1, V2) \
 412   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 413 #define Assert3(C, M, V1, V2, V3) \
 414   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 415 #define Assert4(C, M, V1, V2, V3, V4) \
 416   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 417
 418 void Verifier::visit(Instruction &I) {
 419   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
 420     Assert1(I.getOperand(i) != 0, "Operand is null", &I);
 421   InstVisitor<Verifier>::visit(I);
 422 }
 423
 424
 425 void Verifier::visitGlobalValue(GlobalValue &GV) {
 426   Assert1(!GV.isDeclaration() ||
 427           GV.isMaterializable() ||
 428           GV.hasExternalLinkage() ||
 429           GV.hasDLLImportLinkage() ||
 430           GV.hasExternalWeakLinkage() ||
 431           (isa<GlobalAlias>(GV) &&
 432            (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
 433   "Global is external, but doesn't have external or dllimport or weak linkage!",
 434           &GV);
 435
 436   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
 437           "Global is marked as dllimport, but not external", &GV);
 438
 439   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
 440           "Only global variables can have appending linkage!", &GV);
 441
 442   if (GV.hasAppendingLinkage()) {
 443     GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
 444     Assert1(GVar && GVar->getType()->getElementType()->isArrayTy(),
 445             "Only global arrays can have appending linkage!", GVar);
 446   }
 447 }
 448
 449 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
 450   if (GV.hasInitializer()) {
 451     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
 452             "Global variable initializer type does not match global "
 453             "variable type!", &GV);
 454
 455     // If the global has common linkage, it must have a zero initializer and
 456     // cannot be constant.
 457     if (GV.hasCommonLinkage()) {
 458       Assert1(GV.getInitializer()->isNullValue(),
 459               "'common' global must have a zero initializer!", &GV);
 460       Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
 461               &GV);
 462     }
 463   } else {
 464     Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
 465             GV.hasExternalWeakLinkage(),
 466             "invalid linkage type for global declaration", &GV);
 467   }
 468
 469   visitGlobalValue(GV);
 470 }
 471
 472 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
 473   Assert1(!GA.getName().empty(),
 474           "Alias name cannot be empty!", &GA);
 475   Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
 476           GA.hasWeakLinkage(),
 477           "Alias should have external or external weak linkage!", &GA);
 478   Assert1(GA.getAliasee(),
 479           "Aliasee cannot be NULL!", &GA);
 480   Assert1(GA.getType() == GA.getAliasee()->getType(),
 481           "Alias and aliasee types should match!", &GA);
 482
 483   if (!isa<GlobalValue>(GA.getAliasee())) {
 484     const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
 485     Assert1(CE &&
 486             (CE->getOpcode() == Instruction::BitCast ||
 487              CE->getOpcode() == Instruction::GetElementPtr) &&
 488             isa<GlobalValue>(CE->getOperand(0)),
 489             "Aliasee should be either GlobalValue or bitcast of GlobalValue",
 490             &GA);
 491   }
 492
 493   const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
 494   Assert1(Aliasee,
 495           "Aliasing chain should end with function or global variable", &GA);
 496
 497   visitGlobalValue(GA);
 498 }
 499
 500 void Verifier::visitNamedMDNode(NamedMDNode &NMD) {
 501   for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
 502     MDNode *MD = NMD.getOperand(i);
 503     if (!MD)
 504       continue;
 505
 506     Assert2(!MD->isFunctionLocal(),
 507             "Named metadata operand cannot be function local!", &NMD, MD);
 508     visitMDNode(*MD, 0);
 509   }
 510 }
 511
 512 void Verifier::visitMDNode(MDNode &MD, Function *F) {
 513   // Only visit each node once.  Metadata can be mutually recursive, so this
 514   // avoids infinite recursion here, as well as being an optimization.
 515   if (!MDNodes.insert(&MD))
 516     return;
 517
 518   for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
 519     Value *Op = MD.getOperand(i);
 520     if (!Op)
 521       continue;
 522     if (isa<Constant>(Op) || isa<MDString>(Op) || isa<NamedMDNode>(Op))
 523       continue;
 524     if (MDNode *N = dyn_cast<MDNode>(Op)) {
 525       Assert2(MD.isFunctionLocal() || !N->isFunctionLocal(),
 526               "Global metadata operand cannot be function local!", &MD, N);
 527       visitMDNode(*N, F);
 528       continue;
 529     }
 530     Assert2(MD.isFunctionLocal(), "Invalid operand for global metadata!", &MD, Op);
 531
 532     // If this was an instruction, bb, or argument, verify that it is in the
 533     // function that we expect.
 534     Function *ActualF = 0;
 535     if (Instruction *I = dyn_cast<Instruction>(Op))
 536       ActualF = I->getParent()->getParent();
 537     else if (BasicBlock *BB = dyn_cast<BasicBlock>(Op))
 538       ActualF = BB->getParent();
 539     else if (Argument *A = dyn_cast<Argument>(Op))
 540       ActualF = A->getParent();
 541     assert(ActualF && "Unimplemented function local metadata case!");
 542
 543     Assert2(ActualF == F, "function-local metadata used in wrong function",
 544             &MD, Op);
 545   }
 546 }
 547
 548 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 549   for (TypeSymbolTable::iterator I = ST.begin(), E = ST.end(); I != E; ++I)
 550     VerifyType(I->second);
 551 }
 552
 553 // VerifyParameterAttrs - Check the given attributes for an argument or return
 554 // value of the specified type.  The value V is printed in error messages.
 555 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
 556                                     bool isReturnValue, const Value *V) {
 557   if (Attrs == Attribute::None)
 558     return;
 559
 560   Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
 561   Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
 562           " only applies to the function!", V);
 563
 564   if (isReturnValue) {
 565     Attributes RetI = Attrs & Attribute::ParameterOnly;
 566     Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
 567             " does not apply to return values!", V);
 568   }
 569
 570   for (unsigned i = 0;
 571        i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
 572     Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
 573     Assert1(!(MutI & (MutI - 1)), "Attributes " +
 574             Attribute::getAsString(MutI) + " are incompatible!", V);
 575   }
 576
 577   Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
 578   Assert1(!TypeI, "Wrong type for attribute " +
 579           Attribute::getAsString(TypeI), V);
 580
 581   Attributes ByValI = Attrs & Attribute::ByVal;
 582   if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 583     Assert1(!ByValI || PTy->getElementType()->isSized(),
 584             "Attribute " + Attribute::getAsString(ByValI) +
 585             " does not support unsized types!", V);
 586   } else {
 587     Assert1(!ByValI,
 588             "Attribute " + Attribute::getAsString(ByValI) +
 589             " only applies to parameters with pointer type!", V);
 590   }
 591 }
 592
 593 // VerifyFunctionAttrs - Check parameter attributes against a function type.
 594 // The value V is printed in error messages.
 595 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
 596                                    const AttrListPtr &Attrs,
 597                                    const Value *V) {
 598   if (Attrs.isEmpty())
 599     return;
 600
 601   bool SawNest = false;
 602
 603   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
 604     const AttributeWithIndex &Attr = Attrs.getSlot(i);
 605
 606     const Type *Ty;
 607     if (Attr.Index == 0)
 608       Ty = FT->getReturnType();
 609     else if (Attr.Index-1 < FT->getNumParams())
 610       Ty = FT->getParamType(Attr.Index-1);
 611     else
 612       break;  // VarArgs attributes, verified elsewhere.
 613
 614     VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
 615
 616     if (Attr.Attrs & Attribute::Nest) {
 617       Assert1(!SawNest, "More than one parameter has attribute nest!", V);
 618       SawNest = true;
 619     }
 620
 621     if (Attr.Attrs & Attribute::StructRet)
 622       Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
 623   }
 624
 625   Attributes FAttrs = Attrs.getFnAttributes();
 626   Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
 627   Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
 628           " does not apply to the function!", V);
 629
 630   for (unsigned i = 0;
 631        i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
 632     Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
 633     Assert1(!(MutI & (MutI - 1)), "Attributes " +
 634             Attribute::getAsString(MutI) + " are incompatible!", V);
 635   }
 636 }
 637
 638 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
 639   if (Attrs.isEmpty())
 640     return true;
 641
 642   unsigned LastSlot = Attrs.getNumSlots() - 1;
 643   unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
 644   if (LastIndex <= Params
 645       || (LastIndex == (unsigned)~0
 646           && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
 647     return true;
 648
 649   return false;
 650 }
 651
 652 // visitFunction - Verify that a function is ok.
 653 //
 654 void Verifier::visitFunction(Function &F) {
 655   // Check function arguments.
 656   const FunctionType *FT = F.getFunctionType();
 657   unsigned NumArgs = F.arg_size();
 658
 659   Assert1(Context == &F.getContext(),
 660           "Function context does not match Module context!", &F);
 661
 662   Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
 663   Assert2(FT->getNumParams() == NumArgs,
 664           "# formal arguments must match # of arguments for function type!",
 665           &F, FT);
 666   Assert1(F.getReturnType()->isFirstClassType() ||
 667           F.getReturnType()->isVoidTy() ||
 668           F.getReturnType()->isStructTy(),
 669           "Functions cannot return aggregate values!", &F);
 670
 671   Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
 672           "Invalid struct return type!", &F);
 673
 674   const AttrListPtr &Attrs = F.getAttributes();
 675
 676   Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
 677           "Attributes after last parameter!", &F);
 678
 679   // Check function attributes.
 680   VerifyFunctionAttrs(FT, Attrs, &F);
 681
 682   // Check that this function meets the restrictions on this calling convention.
 683   switch (F.getCallingConv()) {
 684   default:
 685     break;
 686   case CallingConv::C:
 687     break;
 688   case CallingConv::Fast:
 689   case CallingConv::Cold:
 690   case CallingConv::X86_FastCall:
 691     Assert1(!F.isVarArg(),
 692             "Varargs functions must have C calling conventions!", &F);
 693     break;
 694   }
 695
 696   bool isLLVMdotName = F.getName().size() >= 5 &&
 697                        F.getName().substr(0, 5) == "llvm.";
 698
 699   // Check that the argument values match the function type for this function...
 700   unsigned i = 0;
 701   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
 702        I != E; ++I, ++i) {
 703     Assert2(I->getType() == FT->getParamType(i),
 704             "Argument value does not match function argument type!",
 705             I, FT->getParamType(i));
 706     Assert1(I->getType()->isFirstClassType(),
 707             "Function arguments must have first-class types!", I);
 708     if (!isLLVMdotName)
 709       Assert2(!I->getType()->isMetadataTy(),
 710               "Function takes metadata but isn't an intrinsic", I, &F);
 711   }
 712
 713   if (F.isMaterializable()) {
 714     // Function has a body somewhere we can't see.
 715   } else if (F.isDeclaration()) {
 716     Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
 717             F.hasExternalWeakLinkage(),
 718             "invalid linkage type for function declaration", &F);
 719   } else {
 720     // Verify that this function (which has a body) is not named "llvm.*".  It
 721     // is not legal to define intrinsics.
 722     Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
 723
 724     // Check the entry node
 725     BasicBlock *Entry = &F.getEntryBlock();
 726     Assert1(pred_begin(Entry) == pred_end(Entry),
 727             "Entry block to function must not have predecessors!", Entry);
 728
 729     // The address of the entry block cannot be taken, unless it is dead.
 730     if (Entry->hasAddressTaken()) {
 731       Assert1(!BlockAddress::get(Entry)->isConstantUsed(),
 732               "blockaddress may not be used with the entry block!", Entry);
 733     }
 734   }
 735
 736   // If this function is actually an intrinsic, verify that it is only used in
 737   // direct call/invokes, never having its "address taken".
 738   if (F.getIntrinsicID()) {
 739     const User *U;
 740     if (F.hasAddressTaken(&U))
 741       Assert1(0, "Invalid user of intrinsic instruction!", U);
 742   }
 743 }
 744
 745 // verifyBasicBlock - Verify that a basic block is well formed...
 746 //
 747 void Verifier::visitBasicBlock(BasicBlock &BB) {
 748   InstsInThisBlock.clear();
 749
 750   // Ensure that basic blocks have terminators!
 751   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 752
 753   // Check constraints that this basic block imposes on all of the PHI nodes in
 754   // it.
 755   if (isa<PHINode>(BB.front())) {
 756     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
 757     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
 758     std::sort(Preds.begin(), Preds.end());
 759     PHINode *PN;
 760     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
 761       // Ensure that PHI nodes have at least one entry!
 762       Assert1(PN->getNumIncomingValues() != 0,
 763               "PHI nodes must have at least one entry.  If the block is dead, "
 764               "the PHI should be removed!", PN);
 765       Assert1(PN->getNumIncomingValues() == Preds.size(),
 766               "PHINode should have one entry for each predecessor of its "
 767               "parent basic block!", PN);
 768
 769       // Get and sort all incoming values in the PHI node...
 770       Values.clear();
 771       Values.reserve(PN->getNumIncomingValues());
 772       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 773         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
 774                                         PN->getIncomingValue(i)));
 775       std::sort(Values.begin(), Values.end());
 776
 777       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
 778         // Check to make sure that if there is more than one entry for a
 779         // particular basic block in this PHI node, that the incoming values are
 780         // all identical.
 781         //
 782         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
 783                 Values[i].second == Values[i-1].second,
 784                 "PHI node has multiple entries for the same basic block with "
 785                 "different incoming values!", PN, Values[i].first,
 786                 Values[i].second, Values[i-1].second);
 787
 788         // Check to make sure that the predecessors and PHI node entries are
 789         // matched up.
 790         Assert3(Values[i].first == Preds[i],
 791                 "PHI node entries do not match predecessors!", PN,
 792                 Values[i].first, Preds[i]);
 793       }
 794     }
 795   }
 796 }
 797
 798 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 799   // Ensure that terminators only exist at the end of the basic block.
 800   Assert1(&I == I.getParent()->getTerminator(),
 801           "Terminator found in the middle of a basic block!", I.getParent());
 802   visitInstruction(I);
 803 }
 804
 805 void Verifier::visitBranchInst(BranchInst &BI) {
 806   if (BI.isConditional()) {
 807     Assert2(BI.getCondition()->getType()->isIntegerTy(1),
 808             "Branch condition is not 'i1' type!", &BI, BI.getCondition());
 809   }
 810   visitTerminatorInst(BI);
 811 }
 812
 813 void Verifier::visitReturnInst(ReturnInst &RI) {
 814   Function *F = RI.getParent()->getParent();
 815   unsigned N = RI.getNumOperands();
 816   if (F->getReturnType()->isVoidTy())
 817     Assert2(N == 0,
 818             "Found return instr that returns non-void in Function of void "
 819             "return type!", &RI, F->getReturnType());
 820   else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
 821     // Exactly one return value and it matches the return type. Good.
 822   } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
 823     // The return type is a struct; check for multiple return values.
 824     Assert2(STy->getNumElements() == N,
 825             "Incorrect number of return values in ret instruction!",
 826             &RI, F->getReturnType());
 827     for (unsigned i = 0; i != N; ++i)
 828       Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
 829               "Function return type does not match operand "
 830               "type of return inst!", &RI, F->getReturnType());
 831   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
 832     // The return type is an array; check for multiple return values.
 833     Assert2(ATy->getNumElements() == N,
 834             "Incorrect number of return values in ret instruction!",
 835             &RI, F->getReturnType());
 836     for (unsigned i = 0; i != N; ++i)
 837       Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
 838               "Function return type does not match operand "
 839               "type of return inst!", &RI, F->getReturnType());
 840   } else {
 841     CheckFailed("Function return type does not match operand "
 842                 "type of return inst!", &RI, F->getReturnType());
 843   }
 844
 845   // Check to make sure that the return value has necessary properties for
 846   // terminators...
 847   visitTerminatorInst(RI);
 848 }
 849
 850 void Verifier::visitSwitchInst(SwitchInst &SI) {
 851   // Check to make sure that all of the constants in the switch instruction
 852   // have the same type as the switched-on value.
 853   const Type *SwitchTy = SI.getCondition()->getType();
 854   SmallPtrSet<ConstantInt*, 32> Constants;
 855   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i) {
 856     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
 857             "Switch constants must all be same type as switch value!", &SI);
 858     Assert2(Constants.insert(SI.getCaseValue(i)),
 859             "Duplicate integer as switch case", &SI, SI.getCaseValue(i));
 860   }
 861
 862   visitTerminatorInst(SI);
 863 }
 864
 865 void Verifier::visitSelectInst(SelectInst &SI) {
 866   Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
 867                                           SI.getOperand(2)),
 868           "Invalid operands for select instruction!", &SI);
 869
 870   Assert1(SI.getTrueValue()->getType() == SI.getType(),
 871           "Select values must have same type as select instruction!", &SI);
 872   visitInstruction(SI);
 873 }
 874
 875 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
 876 /// a pass, if any exist, it's an error.
 877 ///
 878 void Verifier::visitUserOp1(Instruction &I) {
 879   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
 880 }
 881
 882 void Verifier::visitTruncInst(TruncInst &I) {
 883   // Get the source and destination types
 884   const Type *SrcTy = I.getOperand(0)->getType();
 885   const Type *DestTy = I.getType();
 886
 887   // Get the size of the types in bits, we'll need this later
 888   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 889   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 890
 891   Assert1(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
 892   Assert1(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
 893   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 894           "trunc source and destination must both be a vector or neither", &I);
 895   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
 896
 897   visitInstruction(I);
 898 }
 899
 900 void Verifier::visitZExtInst(ZExtInst &I) {
 901   // Get the source and destination types
 902   const Type *SrcTy = I.getOperand(0)->getType();
 903   const Type *DestTy = I.getType();
 904
 905   // Get the size of the types in bits, we'll need this later
 906   Assert1(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
 907   Assert1(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
 908   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 909           "zext source and destination must both be a vector or neither", &I);
 910   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 911   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 912
 913   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
 914
 915   visitInstruction(I);
 916 }
 917
 918 void Verifier::visitSExtInst(SExtInst &I) {
 919   // Get the source and destination types
 920   const Type *SrcTy = I.getOperand(0)->getType();
 921   const Type *DestTy = I.getType();
 922
 923   // Get the size of the types in bits, we'll need this later
 924   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 925   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 926
 927   Assert1(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
 928   Assert1(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
 929   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 930           "sext source and destination must both be a vector or neither", &I);
 931   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
 932
 933   visitInstruction(I);
 934 }
 935
 936 void Verifier::visitFPTruncInst(FPTruncInst &I) {
 937   // Get the source and destination types
 938   const Type *SrcTy = I.getOperand(0)->getType();
 939   const Type *DestTy = I.getType();
 940   // Get the size of the types in bits, we'll need this later
 941   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 942   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 943
 944   Assert1(SrcTy->isFPOrFPVectorTy(),"FPTrunc only operates on FP", &I);
 945   Assert1(DestTy->isFPOrFPVectorTy(),"FPTrunc only produces an FP", &I);
 946   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 947           "fptrunc source and destination must both be a vector or neither",&I);
 948   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
 949
 950   visitInstruction(I);
 951 }
 952
 953 void Verifier::visitFPExtInst(FPExtInst &I) {
 954   // Get the source and destination types
 955   const Type *SrcTy = I.getOperand(0)->getType();
 956   const Type *DestTy = I.getType();
 957
 958   // Get the size of the types in bits, we'll need this later
 959   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
 960   unsigned DestBitSize = DestTy->getScalarSizeInBits();
 961
 962   Assert1(SrcTy->isFPOrFPVectorTy(),"FPExt only operates on FP", &I);
 963   Assert1(DestTy->isFPOrFPVectorTy(),"FPExt only produces an FP", &I);
 964   Assert1(SrcTy->isVectorTy() == DestTy->isVectorTy(),
 965           "fpext source and destination must both be a vector or neither", &I);
 966   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
 967
 968   visitInstruction(I);
 969 }
 970
 971 void Verifier::visitUIToFPInst(UIToFPInst &I) {
 972   // Get the source and destination types
 973   const Type *SrcTy = I.getOperand(0)->getType();
 974   const Type *DestTy = I.getType();
 975
 976   bool SrcVec = SrcTy->isVectorTy();
 977   bool DstVec = DestTy->isVectorTy();
 978
 979   Assert1(SrcVec == DstVec,
 980           "UIToFP source and dest must both be vector or scalar", &I);
 981   Assert1(SrcTy->isIntOrIntVectorTy(),
 982           "UIToFP source must be integer or integer vector", &I);
 983   Assert1(DestTy->isFPOrFPVectorTy(),
 984           "UIToFP result must be FP or FP vector", &I);
 985
 986   if (SrcVec && DstVec)
 987     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
 988             cast<VectorType>(DestTy)->getNumElements(),
 989             "UIToFP source and dest vector length mismatch", &I);
 990
 991   visitInstruction(I);
 992 }
 993
 994 void Verifier::visitSIToFPInst(SIToFPInst &I) {
 995   // Get the source and destination types
 996   const Type *SrcTy = I.getOperand(0)->getType();
 997   const Type *DestTy = I.getType();
 998
 999   bool SrcVec = SrcTy->isVectorTy();
1000   bool DstVec = DestTy->isVectorTy();
1001
1002   Assert1(SrcVec == DstVec,
1003           "SIToFP source and dest must both be vector or scalar", &I);
1004   Assert1(SrcTy->isIntOrIntVectorTy(),
1005           "SIToFP source must be integer or integer vector", &I);
1006   Assert1(DestTy->isFPOrFPVectorTy(),
1007           "SIToFP result must be FP or FP vector", &I);
1008
1009   if (SrcVec && DstVec)
1010     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1011             cast<VectorType>(DestTy)->getNumElements(),
1012             "SIToFP source and dest vector length mismatch", &I);
1013
1014   visitInstruction(I);
1015 }
1016
1017 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1018   // Get the source and destination types
1019   const Type *SrcTy = I.getOperand(0)->getType();
1020   const Type *DestTy = I.getType();
1021
1022   bool SrcVec = SrcTy->isVectorTy();
1023   bool DstVec = DestTy->isVectorTy();
1024
1025   Assert1(SrcVec == DstVec,
1026           "FPToUI source and dest must both be vector or scalar", &I);
1027   Assert1(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1028           &I);
1029   Assert1(DestTy->isIntOrIntVectorTy(),
1030           "FPToUI result must be integer or integer vector", &I);
1031
1032   if (SrcVec && DstVec)
1033     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1034             cast<VectorType>(DestTy)->getNumElements(),
1035             "FPToUI source and dest vector length mismatch", &I);
1036
1037   visitInstruction(I);
1038 }
1039
1040 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1041   // Get the source and destination types
1042   const Type *SrcTy = I.getOperand(0)->getType();
1043   const Type *DestTy = I.getType();
1044
1045   bool SrcVec = SrcTy->isVectorTy();
1046   bool DstVec = DestTy->isVectorTy();
1047
1048   Assert1(SrcVec == DstVec,
1049           "FPToSI source and dest must both be vector or scalar", &I);
1050   Assert1(SrcTy->isFPOrFPVectorTy(),
1051           "FPToSI source must be FP or FP vector", &I);
1052   Assert1(DestTy->isIntOrIntVectorTy(),
1053           "FPToSI result must be integer or integer vector", &I);
1054
1055   if (SrcVec && DstVec)
1056     Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
1057             cast<VectorType>(DestTy)->getNumElements(),
1058             "FPToSI source and dest vector length mismatch", &I);
1059
1060   visitInstruction(I);
1061 }
1062
1063 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1064   // Get the source and destination types
1065   const Type *SrcTy = I.getOperand(0)->getType();
1066   const Type *DestTy = I.getType();
1067
1068   Assert1(SrcTy->isPointerTy(), "PtrToInt source must be pointer", &I);
1069   Assert1(DestTy->isIntegerTy(), "PtrToInt result must be integral", &I);
1070
1071   visitInstruction(I);
1072 }
1073
1074 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1075   // Get the source and destination types
1076   const Type *SrcTy = I.getOperand(0)->getType();
1077   const Type *DestTy = I.getType();
1078
1079   Assert1(SrcTy->isIntegerTy(), "IntToPtr source must be an integral", &I);
1080   Assert1(DestTy->isPointerTy(), "IntToPtr result must be a pointer",&I);
1081
1082   visitInstruction(I);
1083 }
1084
1085 void Verifier::visitBitCastInst(BitCastInst &I) {
1086   // Get the source and destination types
1087   const Type *SrcTy = I.getOperand(0)->getType();
1088   const Type *DestTy = I.getType();
1089
1090   // Get the size of the types in bits, we'll need this later
1091   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1092   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
1093
1094   // BitCast implies a no-op cast of type only. No bits change.
1095   // However, you can't cast pointers to anything but pointers.
1096   Assert1(DestTy->isPointerTy() == DestTy->isPointerTy(),
1097           "Bitcast requires both operands to be pointer or neither", &I);
1098   Assert1(SrcBitSize == DestBitSize, "Bitcast requires types of same width",&I);
1099
1100   // Disallow aggregates.
1101   Assert1(!SrcTy->isAggregateType(),
1102           "Bitcast operand must not be aggregate", &I);
1103   Assert1(!DestTy->isAggregateType(),
1104           "Bitcast type must not be aggregate", &I);
1105
1106   visitInstruction(I);
1107 }
1108
1109 /// visitPHINode - Ensure that a PHI node is well formed.
1110 ///
1111 void Verifier::visitPHINode(PHINode &PN) {
1112   // Ensure that the PHI nodes are all grouped together at the top of the block.
1113   // This can be tested by checking whether the instruction before this is
1114   // either nonexistent (because this is begin()) or is a PHI node.  If not,
1115   // then there is some other instruction before a PHI.
1116   Assert2(&PN == &PN.getParent()->front() ||
1117           isa<PHINode>(--BasicBlock::iterator(&PN)),
1118           "PHI nodes not grouped at top of basic block!",
1119           &PN, PN.getParent());
1120
1121   // Check that all of the values of the PHI node have the same type as the
1122   // result, and that the incoming blocks are really basic blocks.
1123   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1124     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1125             "PHI node operands are not the same type as the result!", &PN);
1126     Assert1(isa<BasicBlock>(PN.getOperand(
1127                 PHINode::getOperandNumForIncomingBlock(i))),
1128             "PHI node incoming block is not a BasicBlock!", &PN);
1129   }
1130
1131   // All other PHI node constraints are checked in the visitBasicBlock method.
1132
1133   visitInstruction(PN);
1134 }
1135
1136 void Verifier::VerifyCallSite(CallSite CS) {
1137   Instruction *I = CS.getInstruction();
1138
1139   Assert1(CS.getCalledValue()->getType()->isPointerTy(),
1140           "Called function must be a pointer!", I);
1141   const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1142
1143   Assert1(FPTy->getElementType()->isFunctionTy(),
1144           "Called function is not pointer to function type!", I);
1145   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1146
1147   // Verify that the correct number of arguments are being passed
1148   if (FTy->isVarArg())
1149     Assert1(CS.arg_size() >= FTy->getNumParams(),
1150             "Called function requires more parameters than were provided!",I);
1151   else
1152     Assert1(CS.arg_size() == FTy->getNumParams(),
1153             "Incorrect number of arguments passed to called function!", I);
1154
1155   // Verify that all arguments to the call match the function type...
1156   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1157     Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1158             "Call parameter type does not match function signature!",
1159             CS.getArgument(i), FTy->getParamType(i), I);
1160
1161   const AttrListPtr &Attrs = CS.getAttributes();
1162
1163   Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1164           "Attributes after last parameter!", I);
1165
1166   // Verify call attributes.
1167   VerifyFunctionAttrs(FTy, Attrs, I);
1168
1169   if (FTy->isVarArg())
1170     // Check attributes on the varargs part.
1171     for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1172       Attributes Attr = Attrs.getParamAttributes(Idx);
1173
1174       VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1175
1176       Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1177       Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1178               " cannot be used for vararg call arguments!", I);
1179     }
1180
1181   // Verify that there's no metadata unless it's a direct call to an intrinsic.
1182   if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1183       CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1184     for (FunctionType::param_iterator PI = FTy->param_begin(),
1185            PE = FTy->param_end(); PI != PE; ++PI)
1186       Assert1(!PI->get()->isMetadataTy(),
1187               "Function has metadata parameter but isn't an intrinsic", I);
1188   }
1189
1190   visitInstruction(*I);
1191 }
1192
1193 void Verifier::visitCallInst(CallInst &CI) {
1194   VerifyCallSite(&CI);
1195
1196   if (Function *F = CI.getCalledFunction())
1197     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1198       visitIntrinsicFunctionCall(ID, CI);
1199 }
1200
1201 void Verifier::visitInvokeInst(InvokeInst &II) {
1202   VerifyCallSite(&II);
1203 }
1204
1205 /// visitBinaryOperator - Check that both arguments to the binary operator are
1206 /// of the same type!
1207 ///
1208 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1209   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1210           "Both operands to a binary operator are not of the same type!", &B);
1211
1212   switch (B.getOpcode()) {
1213   // Check that integer arithmetic operators are only used with
1214   // integral operands.
1215   case Instruction::Add:
1216   case Instruction::Sub:
1217   case Instruction::Mul:
1218   case Instruction::SDiv:
1219   case Instruction::UDiv:
1220   case Instruction::SRem:
1221   case Instruction::URem:
1222     Assert1(B.getType()->isIntOrIntVectorTy(),
1223             "Integer arithmetic operators only work with integral types!", &B);
1224     Assert1(B.getType() == B.getOperand(0)->getType(),
1225             "Integer arithmetic operators must have same type "
1226             "for operands and result!", &B);
1227     break;
1228   // Check that floating-point arithmetic operators are only used with
1229   // floating-point operands.
1230   case Instruction::FAdd:
1231   case Instruction::FSub:
1232   case Instruction::FMul:
1233   case Instruction::FDiv:
1234   case Instruction::FRem:
1235     Assert1(B.getType()->isFPOrFPVectorTy(),
1236             "Floating-point arithmetic operators only work with "
1237             "floating-point types!", &B);
1238     Assert1(B.getType() == B.getOperand(0)->getType(),
1239             "Floating-point arithmetic operators must have same type "
1240             "for operands and result!", &B);
1241     break;
1242   // Check that logical operators are only used with integral operands.
1243   case Instruction::And:
1244   case Instruction::Or:
1245   case Instruction::Xor:
1246     Assert1(B.getType()->isIntOrIntVectorTy(),
1247             "Logical operators only work with integral types!", &B);
1248     Assert1(B.getType() == B.getOperand(0)->getType(),
1249             "Logical operators must have same type for operands and result!",
1250             &B);
1251     break;
1252   case Instruction::Shl:
1253   case Instruction::LShr:
1254   case Instruction::AShr:
1255     Assert1(B.getType()->isIntOrIntVectorTy(),
1256             "Shifts only work with integral types!", &B);
1257     Assert1(B.getType() == B.getOperand(0)->getType(),
1258             "Shift return type must be same as operands!", &B);
1259     break;
1260   default:
1261     llvm_unreachable("Unknown BinaryOperator opcode!");
1262   }
1263
1264   visitInstruction(B);
1265 }
1266
1267 void Verifier::visitICmpInst(ICmpInst& IC) {
1268   // Check that the operands are the same type
1269   const Type* Op0Ty = IC.getOperand(0)->getType();
1270   const Type* Op1Ty = IC.getOperand(1)->getType();
1271   Assert1(Op0Ty == Op1Ty,
1272           "Both operands to ICmp instruction are not of the same type!", &IC);
1273   // Check that the operands are the right type
1274   Assert1(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPointerTy(),
1275           "Invalid operand types for ICmp instruction", &IC);
1276
1277   visitInstruction(IC);
1278 }
1279
1280 void Verifier::visitFCmpInst(FCmpInst& FC) {
1281   // Check that the operands are the same type
1282   const Type* Op0Ty = FC.getOperand(0)->getType();
1283   const Type* Op1Ty = FC.getOperand(1)->getType();
1284   Assert1(Op0Ty == Op1Ty,
1285           "Both operands to FCmp instruction are not of the same type!", &FC);
1286   // Check that the operands are the right type
1287   Assert1(Op0Ty->isFPOrFPVectorTy(),
1288           "Invalid operand types for FCmp instruction", &FC);
1289   visitInstruction(FC);
1290 }
1291
1292 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1293   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1294                                               EI.getOperand(1)),
1295           "Invalid extractelement operands!", &EI);
1296   visitInstruction(EI);
1297 }
1298
1299 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1300   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1301                                              IE.getOperand(1),
1302                                              IE.getOperand(2)),
1303           "Invalid insertelement operands!", &IE);
1304   visitInstruction(IE);
1305 }
1306
1307 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1308   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1309                                              SV.getOperand(2)),
1310           "Invalid shufflevector operands!", &SV);
1311
1312   const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1313   Assert1(VTy, "Operands are not a vector type", &SV);
1314
1315   // Check to see if Mask is valid.
1316   if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1317     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1318       if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1319         Assert1(!CI->uge(VTy->getNumElements()*2),
1320                 "Invalid shufflevector shuffle mask!", &SV);
1321       } else {
1322         Assert1(isa<UndefValue>(MV->getOperand(i)),
1323                 "Invalid shufflevector shuffle mask!", &SV);
1324       }
1325     }
1326   } else {
1327     Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1328             isa<ConstantAggregateZero>(SV.getOperand(2)),
1329             "Invalid shufflevector shuffle mask!", &SV);
1330   }
1331
1332   visitInstruction(SV);
1333 }
1334
1335 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1336   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1337   const Type *ElTy =
1338     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1339                                       Idxs.begin(), Idxs.end());
1340   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1341   Assert2(GEP.getType()->isPointerTy() &&
1342           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1343           "GEP is not of right type for indices!", &GEP, ElTy);
1344   visitInstruction(GEP);
1345 }
1346
1347 void Verifier::visitLoadInst(LoadInst &LI) {
1348   const PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1349   Assert1(PTy, "Load operand must be a pointer.", &LI);
1350   const Type *ElTy = PTy->getElementType();
1351   Assert2(ElTy == LI.getType(),
1352           "Load result type does not match pointer operand type!", &LI, ElTy);
1353   visitInstruction(LI);
1354 }
1355
1356 void Verifier::visitStoreInst(StoreInst &SI) {
1357   const PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1358   Assert1(PTy, "Load operand must be a pointer.", &SI);
1359   const Type *ElTy = PTy->getElementType();
1360   Assert2(ElTy == SI.getOperand(0)->getType(),
1361           "Stored value type does not match pointer operand type!",
1362           &SI, ElTy);
1363   visitInstruction(SI);
1364 }
1365
1366 void Verifier::visitAllocaInst(AllocaInst &AI) {
1367   const PointerType *PTy = AI.getType();
1368   Assert1(PTy->getAddressSpace() == 0,
1369           "Allocation instruction pointer not in the generic address space!",
1370           &AI);
1371   Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1372           &AI);
1373   Assert1(AI.getArraySize()->getType()->isIntegerTy(32),
1374           "Alloca array size must be i32", &AI);
1375   visitInstruction(AI);
1376 }
1377
1378 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1379   Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1380                                            EVI.idx_begin(), EVI.idx_end()) ==
1381           EVI.getType(),
1382           "Invalid ExtractValueInst operands!", &EVI);
1383
1384   visitInstruction(EVI);
1385 }
1386
1387 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1388   Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1389                                            IVI.idx_begin(), IVI.idx_end()) ==
1390           IVI.getOperand(1)->getType(),
1391           "Invalid InsertValueInst operands!", &IVI);
1392
1393   visitInstruction(IVI);
1394 }
1395
1396 /// verifyInstruction - Verify that an instruction is well formed.
1397 ///
1398 void Verifier::visitInstruction(Instruction &I) {
1399   BasicBlock *BB = I.getParent();
1400   Assert1(BB, "Instruction not embedded in basic block!", &I);
1401
1402   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
1403     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1404          UI != UE; ++UI)
1405       Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1406               "Only PHI nodes may reference their own value!", &I);
1407   }
1408
1409   // Verify that if this is a terminator that it is at the end of the block.
1410   if (isa<TerminatorInst>(I))
1411     Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1412
1413   // Check that void typed values don't have names
1414   Assert1(!I.getType()->isVoidTy() || !I.hasName(),
1415           "Instruction has a name, but provides a void value!", &I);
1416
1417   // Check that the return value of the instruction is either void or a legal
1418   // value type.
1419   Assert1(I.getType()->isVoidTy() ||
1420           I.getType()->isFirstClassType(),
1421           "Instruction returns a non-scalar type!", &I);
1422
1423   // Check that the instruction doesn't produce metadata. Calls are already
1424   // checked against the callee type.
1425   Assert1(!I.getType()->isMetadataTy() ||
1426           isa<CallInst>(I) || isa<InvokeInst>(I),
1427           "Invalid use of metadata!", &I);
1428
1429   // Check that all uses of the instruction, if they are instructions
1430   // themselves, actually have parent basic blocks.  If the use is not an
1431   // instruction, it is an error!
1432   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1433        UI != UE; ++UI) {
1434     if (Instruction *Used = dyn_cast<Instruction>(*UI))
1435       Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1436               " embedded in a basic block!", &I, Used);
1437     else {
1438       CheckFailed("Use of instruction is not an instruction!", *UI);
1439       return;
1440     }
1441   }
1442
1443   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1444     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1445
1446     // Check to make sure that only first-class-values are operands to
1447     // instructions.
1448     if (!I.getOperand(i)->getType()->isFirstClassType()) {
1449       Assert1(0, "Instruction operands must be first-class values!", &I);
1450     }
1451
1452     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1453       // Check to make sure that the "address of" an intrinsic function is never
1454       // taken.
1455       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1456               "Cannot take the address of an intrinsic!", &I);
1457       Assert1(F->getParent() == Mod, "Referencing function in another module!",
1458               &I);
1459     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1460       Assert1(OpBB->getParent() == BB->getParent(),
1461               "Referring to a basic block in another function!", &I);
1462     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1463       Assert1(OpArg->getParent() == BB->getParent(),
1464               "Referring to an argument in another function!", &I);
1465     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1466       Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1467               &I);
1468     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1469       BasicBlock *OpBlock = Op->getParent();
1470
1471       // Check that a definition dominates all of its uses.
1472       if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1473         // Invoke results are only usable in the normal destination, not in the
1474         // exceptional destination.
1475         BasicBlock *NormalDest = II->getNormalDest();
1476
1477         Assert2(NormalDest != II->getUnwindDest(),
1478                 "No uses of invoke possible due to dominance structure!",
1479                 Op, &I);
1480
1481         // PHI nodes differ from other nodes because they actually "use" the
1482         // value in the predecessor basic blocks they correspond to.
1483         BasicBlock *UseBlock = BB;
1484         if (isa<PHINode>(I))
1485           UseBlock = dyn_cast<BasicBlock>(I.getOperand(i+1));
1486         Assert2(UseBlock, "Invoke operand is PHI node with bad incoming-BB",
1487                 Op, &I);
1488
1489         if (isa<PHINode>(I) && UseBlock == OpBlock) {
1490           // Special case of a phi node in the normal destination or the unwind
1491           // destination.
1492           Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1493                   "Invoke result not available in the unwind destination!",
1494                   Op, &I);
1495         } else {
1496           Assert2(DT->dominates(NormalDest, UseBlock) ||
1497                   !DT->isReachableFromEntry(UseBlock),
1498                   "Invoke result does not dominate all uses!", Op, &I);
1499
1500           // If the normal successor of an invoke instruction has multiple
1501           // predecessors, then the normal edge from the invoke is critical,
1502           // so the invoke value can only be live if the destination block
1503           // dominates all of it's predecessors (other than the invoke).
1504           if (!NormalDest->getSinglePredecessor() &&
1505               DT->isReachableFromEntry(UseBlock))
1506             // If it is used by something non-phi, then the other case is that
1507             // 'NormalDest' dominates all of its predecessors other than the
1508             // invoke.  In this case, the invoke value can still be used.
1509             for (pred_iterator PI = pred_begin(NormalDest),
1510                  E = pred_end(NormalDest); PI != E; ++PI)
1511               if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1512                   DT->isReachableFromEntry(*PI)) {
1513                 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1514                 return;
1515               }
1516         }
1517       } else if (isa<PHINode>(I)) {
1518         // PHI nodes are more difficult than other nodes because they actually
1519         // "use" the value in the predecessor basic blocks they correspond to.
1520         BasicBlock *PredBB = dyn_cast<BasicBlock>(I.getOperand(i+1));
1521         Assert2(PredBB && (DT->dominates(OpBlock, PredBB) ||
1522                            !DT->isReachableFromEntry(PredBB)),
1523                 "Instruction does not dominate all uses!", Op, &I);
1524       } else {
1525         if (OpBlock == BB) {
1526           // If they are in the same basic block, make sure that the definition
1527           // comes before the use.
1528           Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1529                   "Instruction does not dominate all uses!", Op, &I);
1530         }
1531
1532         // Definition must dominate use unless use is unreachable!
1533         Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1534                 !DT->isReachableFromEntry(BB),
1535                 "Instruction does not dominate all uses!", Op, &I);
1536       }
1537     } else if (isa<InlineAsm>(I.getOperand(i))) {
1538       Assert1((i == 0 && isa<CallInst>(I)) || (i + 3 == e && isa<InvokeInst>(I)),
1539               "Cannot take the address of an inline asm!", &I);
1540     }
1541   }
1542   InstsInThisBlock.insert(&I);
1543
1544   VerifyType(I.getType());
1545 }
1546
1547 /// VerifyType - Verify that a type is well formed.
1548 ///
1549 void Verifier::VerifyType(const Type *Ty) {
1550   if (!Types.insert(Ty)) return;
1551
1552   Assert1(Context == &Ty->getContext(),
1553           "Type context does not match Module context!", Ty);
1554
1555   switch (Ty->getTypeID()) {
1556   case Type::FunctionTyID: {
1557     const FunctionType *FTy = cast<FunctionType>(Ty);
1558
1559     const Type *RetTy = FTy->getReturnType();
1560     Assert2(FunctionType::isValidReturnType(RetTy),
1561             "Function type with invalid return type", RetTy, FTy);
1562     VerifyType(RetTy);
1563
1564     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1565       const Type *ElTy = FTy->getParamType(i);
1566       Assert2(FunctionType::isValidArgumentType(ElTy),
1567               "Function type with invalid parameter type", ElTy, FTy);
1568       VerifyType(ElTy);
1569     }
1570   } break;
1571   case Type::StructTyID: {
1572     const StructType *STy = cast<StructType>(Ty);
1573     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1574       const Type *ElTy = STy->getElementType(i);
1575       Assert2(StructType::isValidElementType(ElTy),
1576               "Structure type with invalid element type", ElTy, STy);
1577       VerifyType(ElTy);
1578     }
1579   } break;
1580   case Type::UnionTyID: {
1581     const UnionType *UTy = cast<UnionType>(Ty);
1582     for (unsigned i = 0, e = UTy->getNumElements(); i != e; ++i) {
1583       const Type *ElTy = UTy->getElementType(i);
1584       Assert2(UnionType::isValidElementType(ElTy),
1585               "Union type with invalid element type", ElTy, UTy);
1586       VerifyType(ElTy);
1587     }
1588   } break;
1589   case Type::ArrayTyID: {
1590     const ArrayType *ATy = cast<ArrayType>(Ty);
1591     Assert1(ArrayType::isValidElementType(ATy->getElementType()),
1592             "Array type with invalid element type", ATy);
1593     VerifyType(ATy->getElementType());
1594   } break;
1595   case Type::PointerTyID: {
1596     const PointerType *PTy = cast<PointerType>(Ty);
1597     Assert1(PointerType::isValidElementType(PTy->getElementType()),
1598             "Pointer type with invalid element type", PTy);
1599     VerifyType(PTy->getElementType());
1600   } break;
1601   case Type::VectorTyID: {
1602     const VectorType *VTy = cast<VectorType>(Ty);
1603     Assert1(VectorType::isValidElementType(VTy->getElementType()),
1604             "Vector type with invalid element type", VTy);
1605     VerifyType(VTy->getElementType());
1606   } break;
1607   default:
1608     break;
1609   }
1610 }
1611
1612 // Flags used by TableGen to mark intrinsic parameters with the
1613 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1614 static const unsigned ExtendedElementVectorType = 0x40000000;
1615 static const unsigned TruncatedElementVectorType = 0x20000000;
1616
1617 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1618 ///
1619 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1620   Function *IF = CI.getCalledFunction();
1621   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1622           IF);
1623
1624 #define GET_INTRINSIC_VERIFIER
1625 #include "llvm/Intrinsics.gen"
1626 #undef GET_INTRINSIC_VERIFIER
1627
1628   // If the intrinsic takes MDNode arguments, verify that they are either global
1629   // or are local to *this* function.
1630   for (unsigned i = 1, e = CI.getNumOperands(); i != e; ++i)
1631     if (MDNode *MD = dyn_cast<MDNode>(CI.getOperand(i)))
1632       visitMDNode(*MD, CI.getParent()->getParent());
1633
1634   switch (ID) {
1635   default:
1636     break;
1637   case Intrinsic::dbg_declare: {  // llvm.dbg.declare
1638     Assert1(CI.getOperand(1) && isa<MDNode>(CI.getOperand(1)),
1639                 "invalid llvm.dbg.declare intrinsic call 1", &CI);
1640     MDNode *MD = cast<MDNode>(CI.getOperand(1));
1641     Assert1(MD->getNumOperands() == 1,
1642                 "invalid llvm.dbg.declare intrinsic call 2", &CI);
1643   } break;
1644   case Intrinsic::memcpy:
1645   case Intrinsic::memmove:
1646   case Intrinsic::memset:
1647     Assert1(isa<ConstantInt>(CI.getOperand(4)),
1648             "alignment argument of memory intrinsics must be a constant int",
1649             &CI);
1650     break;
1651   case Intrinsic::gcroot:
1652   case Intrinsic::gcwrite:
1653   case Intrinsic::gcread:
1654     if (ID == Intrinsic::gcroot) {
1655       AllocaInst *AI =
1656         dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1657       Assert1(AI && AI->getType()->getElementType()->isPointerTy(),
1658               "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1659       Assert1(isa<Constant>(CI.getOperand(2)),
1660               "llvm.gcroot parameter #2 must be a constant.", &CI);
1661     }
1662
1663     Assert1(CI.getParent()->getParent()->hasGC(),
1664             "Enclosing function does not use GC.", &CI);
1665     break;
1666   case Intrinsic::init_trampoline:
1667     Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1668             "llvm.init_trampoline parameter #2 must resolve to a function.",
1669             &CI);
1670     break;
1671   case Intrinsic::prefetch:
1672     Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1673             isa<ConstantInt>(CI.getOperand(3)) &&
1674             cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1675             cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1676             "invalid arguments to llvm.prefetch",
1677             &CI);
1678     break;
1679   case Intrinsic::stackprotector:
1680     Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1681             "llvm.stackprotector parameter #2 must resolve to an alloca.",
1682             &CI);
1683     break;
1684   case Intrinsic::lifetime_start:
1685   case Intrinsic::lifetime_end:
1686   case Intrinsic::invariant_start:
1687     Assert1(isa<ConstantInt>(CI.getOperand(1)),
1688             "size argument of memory use markers must be a constant integer",
1689             &CI);
1690     break;
1691   case Intrinsic::invariant_end:
1692     Assert1(isa<ConstantInt>(CI.getOperand(2)),
1693             "llvm.invariant.end parameter #2 must be a constant integer", &CI);
1694     break;
1695   }
1696 }
1697
1698 /// Produce a string to identify an intrinsic parameter or return value.
1699 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1700 /// parameters beginning with NumRets.
1701 ///
1702 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1703   if (ArgNo >= NumRets)
1704     return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1705   if (NumRets == 1)
1706     return "Intrinsic result type";
1707   return "Intrinsic result type #" + utostr(ArgNo);
1708 }
1709
1710 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1711                                 int VT, unsigned ArgNo, std::string &Suffix) {
1712   const FunctionType *FTy = F->getFunctionType();
1713
1714   unsigned NumElts = 0;
1715   const Type *EltTy = Ty;
1716   const VectorType *VTy = dyn_cast<VectorType>(Ty);
1717   if (VTy) {
1718     EltTy = VTy->getElementType();
1719     NumElts = VTy->getNumElements();
1720   }
1721
1722   const Type *RetTy = FTy->getReturnType();
1723   const StructType *ST = dyn_cast<StructType>(RetTy);
1724   unsigned NumRetVals;
1725   if (RetTy->isVoidTy())
1726     NumRetVals = 0;
1727   else if (ST)
1728     NumRetVals = ST->getNumElements();
1729   else
1730     NumRetVals = 1;
1731
1732   if (VT < 0) {
1733     int Match = ~VT;
1734
1735     // Check flags that indicate a type that is an integral vector type with
1736     // elements that are larger or smaller than the elements of the matched
1737     // type.
1738     if ((Match & (ExtendedElementVectorType |
1739                   TruncatedElementVectorType)) != 0) {
1740       const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1741       if (!VTy || !IEltTy) {
1742         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1743                     "an integral vector type.", F);
1744         return false;
1745       }
1746       // Adjust the current Ty (in the opposite direction) rather than
1747       // the type being matched against.
1748       if ((Match & ExtendedElementVectorType) != 0) {
1749         if ((IEltTy->getBitWidth() & 1) != 0) {
1750           CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " vector "
1751                       "element bit-width is odd.", F);
1752           return false;
1753         }
1754         Ty = VectorType::getTruncatedElementVectorType(VTy);
1755       } else
1756         Ty = VectorType::getExtendedElementVectorType(VTy);
1757       Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1758     }
1759
1760     if (Match <= static_cast<int>(NumRetVals - 1)) {
1761       if (ST)
1762         RetTy = ST->getElementType(Match);
1763
1764       if (Ty != RetTy) {
1765         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " does not "
1766                     "match return type.", F);
1767         return false;
1768       }
1769     } else {
1770       if (Ty != FTy->getParamType(Match - NumRetVals)) {
1771         CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " does not "
1772                     "match parameter %" + utostr(Match - NumRetVals) + ".", F);
1773         return false;
1774       }
1775     }
1776   } else if (VT == MVT::iAny) {
1777     if (!EltTy->isIntegerTy()) {
1778       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1779                   "an integer type.", F);
1780       return false;
1781     }
1782
1783     unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1784     Suffix += ".";
1785
1786     if (EltTy != Ty)
1787       Suffix += "v" + utostr(NumElts);
1788
1789     Suffix += "i" + utostr(GotBits);
1790
1791     // Check some constraints on various intrinsics.
1792     switch (ID) {
1793     default: break; // Not everything needs to be checked.
1794     case Intrinsic::bswap:
1795       if (GotBits < 16 || GotBits % 16 != 0) {
1796         CheckFailed("Intrinsic requires even byte width argument", F);
1797         return false;
1798       }
1799       break;
1800     }
1801   } else if (VT == MVT::fAny) {
1802     if (!EltTy->isFloatingPointTy()) {
1803       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not "
1804                   "a floating-point type.", F);
1805       return false;
1806     }
1807
1808     Suffix += ".";
1809
1810     if (EltTy != Ty)
1811       Suffix += "v" + utostr(NumElts);
1812
1813     Suffix += EVT::getEVT(EltTy).getEVTString();
1814   } else if (VT == MVT::vAny) {
1815     if (!VTy) {
1816       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a vector type.",
1817                   F);
1818       return false;
1819     }
1820     Suffix += ".v" + utostr(NumElts) + EVT::getEVT(EltTy).getEVTString();
1821   } else if (VT == MVT::iPTR) {
1822     if (!Ty->isPointerTy()) {
1823       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a "
1824                   "pointer and a pointer is required.", F);
1825       return false;
1826     }
1827   } else if (VT == MVT::iPTRAny) {
1828     // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1829     // and iPTR. In the verifier, we can not distinguish which case we have so
1830     // allow either case to be legal.
1831     if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1832       Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1833         EVT::getEVT(PTyp->getElementType()).getEVTString();
1834     } else {
1835       CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is not a "
1836                   "pointer and a pointer is required.", F);
1837       return false;
1838     }
1839   } else if (EVT((MVT::SimpleValueType)VT).isVector()) {
1840     EVT VVT = EVT((MVT::SimpleValueType)VT);
1841
1842     // If this is a vector argument, verify the number and type of elements.
1843     if (VVT.getVectorElementType() != EVT::getEVT(EltTy)) {
1844       CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1845       return false;
1846     }
1847
1848     if (VVT.getVectorNumElements() != NumElts) {
1849       CheckFailed("Intrinsic prototype has incorrect number of "
1850                   "vector elements!", F);
1851       return false;
1852     }
1853   } else if (EVT((MVT::SimpleValueType)VT).getTypeForEVT(Ty->getContext()) !=
1854              EltTy) {
1855     CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is wrong!", F);
1856     return false;
1857   } else if (EltTy != Ty) {
1858     CheckFailed(IntrinsicParam(ArgNo, NumRetVals) + " is a vector "
1859                 "and a scalar is required.", F);
1860     return false;
1861   }
1862
1863   return true;
1864 }
1865
1866 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1867 /// Intrinsics.gen.  This implements a little state machine that verifies the
1868 /// prototype of intrinsics.
1869 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1870                                         unsigned NumRetVals,
1871                                         unsigned NumParams, ...) {
1872   va_list VA;
1873   va_start(VA, NumParams);
1874   const FunctionType *FTy = F->getFunctionType();
1875
1876   // For overloaded intrinsics, the Suffix of the function name must match the
1877   // types of the arguments. This variable keeps track of the expected
1878   // suffix, to be checked at the end.
1879   std::string Suffix;
1880
1881   if (FTy->getNumParams() + FTy->isVarArg() != NumParams) {
1882     CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1883     return;
1884   }
1885
1886   const Type *Ty = FTy->getReturnType();
1887   const StructType *ST = dyn_cast<StructType>(Ty);
1888
1889   if (NumRetVals == 0 && !Ty->isVoidTy()) {
1890     CheckFailed("Intrinsic should return void", F);
1891     return;
1892   }
1893
1894   // Verify the return types.
1895   if (ST && ST->getNumElements() != NumRetVals) {
1896     CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1897     return;
1898   }
1899
1900   for (unsigned ArgNo = 0; ArgNo != NumRetVals; ++ArgNo) {
1901     int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1902
1903     if (ST) Ty = ST->getElementType(ArgNo);
1904     if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1905       break;
1906   }
1907
1908   // Verify the parameter types.
1909   for (unsigned ArgNo = 0; ArgNo != NumParams; ++ArgNo) {
1910     int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1911
1912     if (VT == MVT::isVoid && ArgNo > 0) {
1913       if (!FTy->isVarArg())
1914         CheckFailed("Intrinsic prototype has no '...'!", F);
1915       break;
1916     }
1917
1918     if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT,
1919                           ArgNo + NumRetVals, Suffix))
1920       break;
1921   }
1922
1923   va_end(VA);
1924
1925   // For intrinsics without pointer arguments, if we computed a Suffix then the
1926   // intrinsic is overloaded and we need to make sure that the name of the
1927   // function is correct. We add the suffix to the name of the intrinsic and
1928   // compare against the given function name. If they are not the same, the
1929   // function name is invalid. This ensures that overloading of intrinsics
1930   // uses a sane and consistent naming convention.  Note that intrinsics with
1931   // pointer argument may or may not be overloaded so we will check assuming it
1932   // has a suffix and not.
1933   if (!Suffix.empty()) {
1934     std::string Name(Intrinsic::getName(ID));
1935     if (Name + Suffix != F->getName()) {
1936       CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1937                   F->getName().substr(Name.length()) + "'. It should be '" +
1938                   Suffix + "'", F);
1939     }
1940   }
1941
1942   // Check parameter attributes.
1943   Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1944           "Intrinsic has wrong parameter attributes!", F);
1945 }
1946
1947
1948 //===----------------------------------------------------------------------===//
1949 //  Implement the public interfaces to this file...
1950 //===----------------------------------------------------------------------===//
1951
1952 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1953   return new Verifier(action);
1954 }
1955
1956
1957 /// verifyFunction - Check a function for errors, printing messages on stderr.
1958 /// Return true if the function is corrupt.
1959 ///
1960 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1961   Function &F = const_cast<Function&>(f);
1962   assert(!F.isDeclaration() && "Cannot verify external functions");
1963
1964   FunctionPassManager FPM(F.getParent());
1965   Verifier *V = new Verifier(action);
1966   FPM.add(V);
1967   FPM.run(F);
1968   return V->Broken;
1969 }
1970
1971 /// verifyModule - Check a module for errors, printing messages on stderr.
1972 /// Return true if the module is corrupt.
1973 ///
1974 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1975                         std::string *ErrorInfo) {
1976   PassManager PM;
1977   Verifier *V = new Verifier(action);
1978   PM.add(V);
1979   PM.run(const_cast<Module&>(M));
1980
1981   if (ErrorInfo && V->Broken)
1982     *ErrorInfo = V->MessagesStr.str();
1983   return V->Broken;
1984 }