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