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