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