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