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