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