convert some vectors to smallvector.
[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/DerivedTypes.h"
50 #include "llvm/InlineAsm.h"
51 #include "llvm/Instructions.h"
52 #include "llvm/Intrinsics.h"
53 #include "llvm/PassManager.h"
54 #include "llvm/ValueSymbolTable.h"
55 #include "llvm/Analysis/Dominators.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
71   struct VISIBILITY_HIDDEN
72      Verifier : public FunctionPass, InstVisitor<Verifier> {
73     bool Broken;          // Is this module found to be broken?
74     bool RealPass;        // Are we not being run by a PassManager?
75     VerifierFailureAction action;
76                           // What to do if verification fails.
77     Module *Mod;          // Module we are verifying right now
78     ETForest *EF;     // ET-Forest, caution can be null!
79     std::stringstream msgs;  // A stringstream to collect messages
80
81     /// InstInThisBlock - when verifying a basic block, keep track of all of the
82     /// instructions we have seen so far.  This allows us to do efficient
83     /// dominance checks for the case when an instruction has an operand that is
84     /// an instruction in the same block.
85     SmallPtrSet<Instruction*, 16> InstsInThisBlock;
86
87     Verifier()
88         : Broken(false), RealPass(true), action(AbortProcessAction),
89           EF(0), msgs( std::ios::app | std::ios::out ) {}
90     Verifier( VerifierFailureAction ctn )
91         : Broken(false), RealPass(true), action(ctn), EF(0),
92           msgs( std::ios::app | std::ios::out ) {}
93     Verifier(bool AB )
94         : Broken(false), RealPass(true),
95           action( AB ? AbortProcessAction : PrintMessageAction), EF(0),
96           msgs( std::ios::app | std::ios::out ) {}
97     Verifier(ETForest &ef)
98       : Broken(false), RealPass(false), action(PrintMessageAction),
99         EF(&ef), msgs( std::ios::app | std::ios::out ) {}
100
101
102     bool doInitialization(Module &M) {
103       Mod = &M;
104       verifyTypeSymbolTable(M.getTypeSymbolTable());
105       verifyValueSymbolTable(M.getValueSymbolTable());
106
107       // If this is a real pass, in a pass manager, we must abort before
108       // returning back to the pass manager, or else the pass manager may try to
109       // run other passes on the broken module.
110       if (RealPass)
111         return abortIfBroken();
112       return false;
113     }
114
115     bool runOnFunction(Function &F) {
116       // Get dominator information if we are being run by PassManager
117       if (RealPass) EF = &getAnalysis<ETForest>();
118       
119       visit(F);
120       InstsInThisBlock.clear();
121
122       // If this is a real pass, in a pass manager, we must abort before
123       // returning back to the pass manager, or else the pass manager may try to
124       // run other passes on the broken module.
125       if (RealPass)
126         return abortIfBroken();
127
128       return false;
129     }
130
131     bool doFinalization(Module &M) {
132       // Scan through, checking all of the external function's linkage now...
133       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
134         visitGlobalValue(*I);
135
136         // Check to make sure function prototypes are okay.
137         if (I->isDeclaration()) visitFunction(*I);
138       }
139
140       for (Module::global_iterator I = M.global_begin(), E = M.global_end(); 
141            I != E; ++I)
142         visitGlobalVariable(*I);
143
144       // If the module is broken, abort at this time.
145       return abortIfBroken();
146     }
147
148     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
149       AU.setPreservesAll();
150       if (RealPass)
151         AU.addRequired<ETForest>();
152     }
153
154     /// abortIfBroken - If the module is broken and we are supposed to abort on
155     /// this condition, do so.
156     ///
157     bool abortIfBroken() {
158       if (Broken) {
159         msgs << "Broken module found, ";
160         switch (action) {
161           case AbortProcessAction:
162             msgs << "compilation aborted!\n";
163             cerr << msgs.str();
164             abort();
165           case PrintMessageAction:
166             msgs << "verification continues.\n";
167             cerr << msgs.str();
168             return false;
169           case ReturnStatusAction:
170             msgs << "compilation terminated.\n";
171             return Broken;
172         }
173       }
174       return false;
175     }
176
177
178     // Verification methods...
179     void verifyTypeSymbolTable(TypeSymbolTable &ST);
180     void verifyValueSymbolTable(ValueSymbolTable &ST);
181     void visitGlobalValue(GlobalValue &GV);
182     void visitGlobalVariable(GlobalVariable &GV);
183     void visitFunction(Function &F);
184     void visitBasicBlock(BasicBlock &BB);
185     void visitTruncInst(TruncInst &I);
186     void visitZExtInst(ZExtInst &I);
187     void visitSExtInst(SExtInst &I);
188     void visitFPTruncInst(FPTruncInst &I);
189     void visitFPExtInst(FPExtInst &I);
190     void visitFPToUIInst(FPToUIInst &I);
191     void visitFPToSIInst(FPToSIInst &I);
192     void visitUIToFPInst(UIToFPInst &I);
193     void visitSIToFPInst(SIToFPInst &I);
194     void visitIntToPtrInst(IntToPtrInst &I);
195     void visitPtrToIntInst(PtrToIntInst &I);
196     void visitBitCastInst(BitCastInst &I);
197     void visitPHINode(PHINode &PN);
198     void visitBinaryOperator(BinaryOperator &B);
199     void visitICmpInst(ICmpInst &IC);
200     void visitFCmpInst(FCmpInst &FC);
201     void visitExtractElementInst(ExtractElementInst &EI);
202     void visitInsertElementInst(InsertElementInst &EI);
203     void visitShuffleVectorInst(ShuffleVectorInst &EI);
204     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
205     void visitCallInst(CallInst &CI);
206     void visitGetElementPtrInst(GetElementPtrInst &GEP);
207     void visitLoadInst(LoadInst &LI);
208     void visitStoreInst(StoreInst &SI);
209     void visitInstruction(Instruction &I);
210     void visitTerminatorInst(TerminatorInst &I);
211     void visitReturnInst(ReturnInst &RI);
212     void visitSwitchInst(SwitchInst &SI);
213     void visitSelectInst(SelectInst &SI);
214     void visitUserOp1(Instruction &I);
215     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
216     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
217
218     void VerifyIntrinsicPrototype(Function *F, ...);
219
220     void WriteValue(const Value *V) {
221       if (!V) return;
222       if (isa<Instruction>(V)) {
223         msgs << *V;
224       } else {
225         WriteAsOperand(msgs, V, true, Mod);
226         msgs << "\n";
227       }
228     }
229
230     void WriteType(const Type* T ) {
231       if ( !T ) return;
232       WriteTypeSymbolic(msgs, T, Mod );
233     }
234
235
236     // CheckFailed - A check failed, so print out the condition and the message
237     // that failed.  This provides a nice place to put a breakpoint if you want
238     // to see why something is not correct.
239     void CheckFailed(const std::string &Message,
240                      const Value *V1 = 0, const Value *V2 = 0,
241                      const Value *V3 = 0, const Value *V4 = 0) {
242       msgs << Message << "\n";
243       WriteValue(V1);
244       WriteValue(V2);
245       WriteValue(V3);
246       WriteValue(V4);
247       Broken = true;
248     }
249
250     void CheckFailed( const std::string& Message, const Value* V1,
251                       const Type* T2, const Value* V3 = 0 ) {
252       msgs << Message << "\n";
253       WriteValue(V1);
254       WriteType(T2);
255       WriteValue(V3);
256       Broken = true;
257     }
258   };
259
260   RegisterPass<Verifier> X("verify", "Module Verifier");
261 } // End anonymous namespace
262
263
264 // Assert - We know that cond should be true, if not print an error message.
265 #define Assert(C, M) \
266   do { if (!(C)) { CheckFailed(M); return; } } while (0)
267 #define Assert1(C, M, V1) \
268   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
269 #define Assert2(C, M, V1, V2) \
270   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
271 #define Assert3(C, M, V1, V2, V3) \
272   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
273 #define Assert4(C, M, V1, V2, V3, V4) \
274   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
275
276
277 void Verifier::visitGlobalValue(GlobalValue &GV) {
278   Assert1(!GV.isDeclaration() ||
279           GV.hasExternalLinkage() ||
280           GV.hasDLLImportLinkage() ||
281           GV.hasExternalWeakLinkage(),
282   "Global is external, but doesn't have external or dllimport or weak linkage!",
283           &GV);
284
285   Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
286           "Global is marked as dllimport, but not external", &GV);
287   
288   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
289           "Only global variables can have appending linkage!", &GV);
290
291   if (GV.hasAppendingLinkage()) {
292     GlobalVariable &GVar = cast<GlobalVariable>(GV);
293     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
294             "Only global arrays can have appending linkage!", &GV);
295   }
296 }
297
298 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
299   if (GV.hasInitializer())
300     Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
301             "Global variable initializer type does not match global "
302             "variable type!", &GV);
303
304   visitGlobalValue(GV);
305 }
306
307 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
308 }
309
310 // verifySymbolTable - Verify that a function or module symbol table is ok
311 //
312 void Verifier::verifyValueSymbolTable(ValueSymbolTable &ST) {
313
314   // Loop over all of the values in the symbol table.
315   for (ValueSymbolTable::const_iterator VI = ST.begin(), VE = ST.end(); 
316        VI != VE; ++VI) {
317     Value *V = VI->second;
318     // Check that there are no void typed values in the symbol table.  Values
319     // with a void type cannot be put into symbol tables because they cannot
320     // have names!
321     Assert1(V->getType() != Type::VoidTy,
322       "Values with void type are not allowed to have names!", V);
323   }
324 }
325
326 // visitFunction - Verify that a function is ok.
327 //
328 void Verifier::visitFunction(Function &F) {
329   // Check function arguments.
330   const FunctionType *FT = F.getFunctionType();
331   unsigned NumArgs = F.getArgumentList().size();
332
333   Assert2(FT->getNumParams() == NumArgs,
334           "# formal arguments must match # of arguments for function type!",
335           &F, FT);
336   Assert1(F.getReturnType()->isFirstClassType() ||
337           F.getReturnType() == Type::VoidTy,
338           "Functions cannot return aggregate values!", &F);
339
340   Assert1(!FT->isStructReturn() ||
341           (FT->getReturnType() == Type::VoidTy && 
342            FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
343           "Invalid struct-return function!", &F);
344
345   // Check that this function meets the restrictions on this calling convention.
346   switch (F.getCallingConv()) {
347   default:
348     break;
349   case CallingConv::C:
350     break;
351   case CallingConv::Fast:
352   case CallingConv::Cold:
353   case CallingConv::X86_FastCall:
354     Assert1(!F.isVarArg(),
355             "Varargs functions must have C calling conventions!", &F);
356     break;
357   }
358   
359   // Check that the argument values match the function type for this function...
360   unsigned i = 0;
361   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
362        I != E; ++I, ++i) {
363     Assert2(I->getType() == FT->getParamType(i),
364             "Argument value does not match function argument type!",
365             I, FT->getParamType(i));
366     // Make sure no aggregates are passed by value.
367     Assert1(I->getType()->isFirstClassType(),
368             "Functions cannot take aggregates as arguments by value!", I);
369    }
370
371   if (!F.isDeclaration()) {
372     // Verify that this function (which has a body) is not named "llvm.*".  It
373     // is not legal to define intrinsics.
374     if (F.getName().size() >= 5)
375       Assert1(F.getName().substr(0, 5) != "llvm.",
376               "llvm intrinsics cannot be defined!", &F);
377     
378     verifyValueSymbolTable(F.getValueSymbolTable());
379
380     // Check the entry node
381     BasicBlock *Entry = &F.getEntryBlock();
382     Assert1(pred_begin(Entry) == pred_end(Entry),
383             "Entry block to function must not have predecessors!", Entry);
384   }
385 }
386
387
388 // verifyBasicBlock - Verify that a basic block is well formed...
389 //
390 void Verifier::visitBasicBlock(BasicBlock &BB) {
391   InstsInThisBlock.clear();
392
393   // Ensure that basic blocks have terminators!
394   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
395
396   // Check constraints that this basic block imposes on all of the PHI nodes in
397   // it.
398   if (isa<PHINode>(BB.front())) {
399     SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
400     SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
401     std::sort(Preds.begin(), Preds.end());
402     PHINode *PN;
403     for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
404
405       // Ensure that PHI nodes have at least one entry!
406       Assert1(PN->getNumIncomingValues() != 0,
407               "PHI nodes must have at least one entry.  If the block is dead, "
408               "the PHI should be removed!", PN);
409       Assert1(PN->getNumIncomingValues() == Preds.size(),
410               "PHINode should have one entry for each predecessor of its "
411               "parent basic block!", PN);
412
413       // Get and sort all incoming values in the PHI node...
414       Values.clear();
415       Values.reserve(PN->getNumIncomingValues());
416       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
417         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
418                                         PN->getIncomingValue(i)));
419       std::sort(Values.begin(), Values.end());
420
421       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
422         // Check to make sure that if there is more than one entry for a
423         // particular basic block in this PHI node, that the incoming values are
424         // all identical.
425         //
426         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
427                 Values[i].second == Values[i-1].second,
428                 "PHI node has multiple entries for the same basic block with "
429                 "different incoming values!", PN, Values[i].first,
430                 Values[i].second, Values[i-1].second);
431
432         // Check to make sure that the predecessors and PHI node entries are
433         // matched up.
434         Assert3(Values[i].first == Preds[i],
435                 "PHI node entries do not match predecessors!", PN,
436                 Values[i].first, Preds[i]);
437       }
438     }
439   }
440 }
441
442 void Verifier::visitTerminatorInst(TerminatorInst &I) {
443   // Ensure that terminators only exist at the end of the basic block.
444   Assert1(&I == I.getParent()->getTerminator(),
445           "Terminator found in the middle of a basic block!", I.getParent());
446   visitInstruction(I);
447 }
448
449 void Verifier::visitReturnInst(ReturnInst &RI) {
450   Function *F = RI.getParent()->getParent();
451   if (RI.getNumOperands() == 0)
452     Assert2(F->getReturnType() == Type::VoidTy,
453             "Found return instr that returns void in Function of non-void "
454             "return type!", &RI, F->getReturnType());
455   else
456     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
457             "Function return type does not match operand "
458             "type of return inst!", &RI, F->getReturnType());
459
460   // Check to make sure that the return value has necessary properties for
461   // terminators...
462   visitTerminatorInst(RI);
463 }
464
465 void Verifier::visitSwitchInst(SwitchInst &SI) {
466   // Check to make sure that all of the constants in the switch instruction
467   // have the same type as the switched-on value.
468   const Type *SwitchTy = SI.getCondition()->getType();
469   for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
470     Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
471             "Switch constants must all be same type as switch value!", &SI);
472
473   visitTerminatorInst(SI);
474 }
475
476 void Verifier::visitSelectInst(SelectInst &SI) {
477   Assert1(SI.getCondition()->getType() == Type::Int1Ty,
478           "Select condition type must be bool!", &SI);
479   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
480           "Select values must have identical types!", &SI);
481   Assert1(SI.getTrueValue()->getType() == SI.getType(),
482           "Select values must have same type as select instruction!", &SI);
483   visitInstruction(SI);
484 }
485
486
487 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
488 /// a pass, if any exist, it's an error.
489 ///
490 void Verifier::visitUserOp1(Instruction &I) {
491   Assert1(0, "User-defined operators should not live outside of a pass!", &I);
492 }
493
494 void Verifier::visitTruncInst(TruncInst &I) {
495   // Get the source and destination types
496   const Type *SrcTy = I.getOperand(0)->getType();
497   const Type *DestTy = I.getType();
498
499   // Get the size of the types in bits, we'll need this later
500   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
501   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
502
503   Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
504   Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
505   Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
506
507   visitInstruction(I);
508 }
509
510 void Verifier::visitZExtInst(ZExtInst &I) {
511   // Get the source and destination types
512   const Type *SrcTy = I.getOperand(0)->getType();
513   const Type *DestTy = I.getType();
514
515   // Get the size of the types in bits, we'll need this later
516   Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
517   Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
518   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
519   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
520
521   Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
522
523   visitInstruction(I);
524 }
525
526 void Verifier::visitSExtInst(SExtInst &I) {
527   // Get the source and destination types
528   const Type *SrcTy = I.getOperand(0)->getType();
529   const Type *DestTy = I.getType();
530
531   // Get the size of the types in bits, we'll need this later
532   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
533   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
534
535   Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
536   Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
537   Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
538
539   visitInstruction(I);
540 }
541
542 void Verifier::visitFPTruncInst(FPTruncInst &I) {
543   // Get the source and destination types
544   const Type *SrcTy = I.getOperand(0)->getType();
545   const Type *DestTy = I.getType();
546   // Get the size of the types in bits, we'll need this later
547   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
548   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
549
550   Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
551   Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
552   Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
553
554   visitInstruction(I);
555 }
556
557 void Verifier::visitFPExtInst(FPExtInst &I) {
558   // Get the source and destination types
559   const Type *SrcTy = I.getOperand(0)->getType();
560   const Type *DestTy = I.getType();
561
562   // Get the size of the types in bits, we'll need this later
563   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
564   unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
565
566   Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
567   Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
568   Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
569
570   visitInstruction(I);
571 }
572
573 void Verifier::visitUIToFPInst(UIToFPInst &I) {
574   // Get the source and destination types
575   const Type *SrcTy = I.getOperand(0)->getType();
576   const Type *DestTy = I.getType();
577
578   Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
579   Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
580
581   visitInstruction(I);
582 }
583
584 void Verifier::visitSIToFPInst(SIToFPInst &I) {
585   // Get the source and destination types
586   const Type *SrcTy = I.getOperand(0)->getType();
587   const Type *DestTy = I.getType();
588
589   Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
590   Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
591
592   visitInstruction(I);
593 }
594
595 void Verifier::visitFPToUIInst(FPToUIInst &I) {
596   // Get the source and destination types
597   const Type *SrcTy = I.getOperand(0)->getType();
598   const Type *DestTy = I.getType();
599
600   Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
601   Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
602
603   visitInstruction(I);
604 }
605
606 void Verifier::visitFPToSIInst(FPToSIInst &I) {
607   // Get the source and destination types
608   const Type *SrcTy = I.getOperand(0)->getType();
609   const Type *DestTy = I.getType();
610
611   Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
612   Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
613
614   visitInstruction(I);
615 }
616
617 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
618   // Get the source and destination types
619   const Type *SrcTy = I.getOperand(0)->getType();
620   const Type *DestTy = I.getType();
621
622   Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
623   Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
624
625   visitInstruction(I);
626 }
627
628 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
629   // Get the source and destination types
630   const Type *SrcTy = I.getOperand(0)->getType();
631   const Type *DestTy = I.getType();
632
633   Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
634   Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
635
636   visitInstruction(I);
637 }
638
639 void Verifier::visitBitCastInst(BitCastInst &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   // BitCast implies a no-op cast of type only. No bits change.
649   // However, you can't cast pointers to anything but pointers.
650   Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
651           "Bitcast requires both operands to be pointer or neither", &I);
652   Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
653
654   visitInstruction(I);
655 }
656
657 /// visitPHINode - Ensure that a PHI node is well formed.
658 ///
659 void Verifier::visitPHINode(PHINode &PN) {
660   // Ensure that the PHI nodes are all grouped together at the top of the block.
661   // This can be tested by checking whether the instruction before this is
662   // either nonexistent (because this is begin()) or is a PHI node.  If not,
663   // then there is some other instruction before a PHI.
664   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
665           "PHI nodes not grouped at top of basic block!",
666           &PN, PN.getParent());
667
668   // Check that all of the operands of the PHI node have the same type as the
669   // result.
670   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
671     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
672             "PHI node operands are not the same type as the result!", &PN);
673
674   // All other PHI node constraints are checked in the visitBasicBlock method.
675
676   visitInstruction(PN);
677 }
678
679 void Verifier::visitCallInst(CallInst &CI) {
680   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
681           "Called function must be a pointer!", &CI);
682   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
683   Assert1(isa<FunctionType>(FPTy->getElementType()),
684           "Called function is not pointer to function type!", &CI);
685
686   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
687
688   // Verify that the correct number of arguments are being passed
689   if (FTy->isVarArg())
690     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
691             "Called function requires more parameters than were provided!",&CI);
692   else
693     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
694             "Incorrect number of arguments passed to called function!", &CI);
695
696   // Verify that all arguments to the call match the function type...
697   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
698     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
699             "Call parameter type does not match function signature!",
700             CI.getOperand(i+1), FTy->getParamType(i), &CI);
701
702   if (Function *F = CI.getCalledFunction())
703     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
704       visitIntrinsicFunctionCall(ID, CI);
705
706   visitInstruction(CI);
707 }
708
709 /// visitBinaryOperator - Check that both arguments to the binary operator are
710 /// of the same type!
711 ///
712 void Verifier::visitBinaryOperator(BinaryOperator &B) {
713   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
714           "Both operands to a binary operator are not of the same type!", &B);
715
716   switch (B.getOpcode()) {
717   // Check that logical operators are only used with integral operands.
718   case Instruction::And:
719   case Instruction::Or:
720   case Instruction::Xor:
721     Assert1(B.getType()->isInteger() ||
722             (isa<PackedType>(B.getType()) && 
723              cast<PackedType>(B.getType())->getElementType()->isInteger()),
724             "Logical operators only work with integral types!", &B);
725     Assert1(B.getType() == B.getOperand(0)->getType(),
726             "Logical operators must have same type for operands and result!",
727             &B);
728     break;
729   case Instruction::Shl:
730   case Instruction::LShr:
731   case Instruction::AShr:
732     Assert1(B.getType()->isInteger(),
733             "Shift must return an integer result!", &B);
734     Assert1(B.getType() == B.getOperand(0)->getType(),
735             "Shift return type must be same as operands!", &B);
736     /* FALL THROUGH */
737   default:
738     // Arithmetic operators only work on integer or fp values
739     Assert1(B.getType() == B.getOperand(0)->getType(),
740             "Arithmetic operators must have same type for operands and result!",
741             &B);
742     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
743             isa<PackedType>(B.getType()),
744             "Arithmetic operators must have integer, fp, or packed type!", &B);
745     break;
746   }
747
748   visitInstruction(B);
749 }
750
751 void Verifier::visitICmpInst(ICmpInst& IC) {
752   // Check that the operands are the same type
753   const Type* Op0Ty = IC.getOperand(0)->getType();
754   const Type* Op1Ty = IC.getOperand(1)->getType();
755   Assert1(Op0Ty == Op1Ty,
756           "Both operands to ICmp instruction are not of the same type!", &IC);
757   // Check that the operands are the right type
758   Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
759           "Invalid operand types for ICmp instruction", &IC);
760   visitInstruction(IC);
761 }
762
763 void Verifier::visitFCmpInst(FCmpInst& FC) {
764   // Check that the operands are the same type
765   const Type* Op0Ty = FC.getOperand(0)->getType();
766   const Type* Op1Ty = FC.getOperand(1)->getType();
767   Assert1(Op0Ty == Op1Ty,
768           "Both operands to FCmp instruction are not of the same type!", &FC);
769   // Check that the operands are the right type
770   Assert1(Op0Ty->isFloatingPoint(),
771           "Invalid operand types for FCmp instruction", &FC);
772   visitInstruction(FC);
773 }
774
775 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
776   Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
777                                               EI.getOperand(1)),
778           "Invalid extractelement operands!", &EI);
779   visitInstruction(EI);
780 }
781
782 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
783   Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
784                                              IE.getOperand(1),
785                                              IE.getOperand(2)),
786           "Invalid insertelement operands!", &IE);
787   visitInstruction(IE);
788 }
789
790 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
791   Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
792                                              SV.getOperand(2)),
793           "Invalid shufflevector operands!", &SV);
794   Assert1(SV.getType() == SV.getOperand(0)->getType(),
795           "Result of shufflevector must match first operand type!", &SV);
796   
797   // Check to see if Mask is valid.
798   if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
799     for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
800       Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
801               isa<UndefValue>(MV->getOperand(i)),
802               "Invalid shufflevector shuffle mask!", &SV);
803     }
804   } else {
805     Assert1(isa<UndefValue>(SV.getOperand(2)) || 
806             isa<ConstantAggregateZero>(SV.getOperand(2)),
807             "Invalid shufflevector shuffle mask!", &SV);
808   }
809   
810   visitInstruction(SV);
811 }
812
813 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
814   SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
815   const Type *ElTy =
816     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
817                                       &Idxs[0], Idxs.size(), true);
818   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
819   Assert2(isa<PointerType>(GEP.getType()) &&
820           cast<PointerType>(GEP.getType())->getElementType() == ElTy,
821           "GEP is not of right type for indices!", &GEP, ElTy);
822   visitInstruction(GEP);
823 }
824
825 void Verifier::visitLoadInst(LoadInst &LI) {
826   const Type *ElTy =
827     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
828   Assert2(ElTy == LI.getType(),
829           "Load result type does not match pointer operand type!", &LI, ElTy);
830   visitInstruction(LI);
831 }
832
833 void Verifier::visitStoreInst(StoreInst &SI) {
834   const Type *ElTy =
835     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
836   Assert2(ElTy == SI.getOperand(0)->getType(),
837           "Stored value type does not match pointer operand type!", &SI, ElTy);
838   visitInstruction(SI);
839 }
840
841
842 /// verifyInstruction - Verify that an instruction is well formed.
843 ///
844 void Verifier::visitInstruction(Instruction &I) {
845   BasicBlock *BB = I.getParent();
846   Assert1(BB, "Instruction not embedded in basic block!", &I);
847
848   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
849     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
850          UI != UE; ++UI)
851       Assert1(*UI != (User*)&I ||
852               !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
853               "Only PHI nodes may reference their own value!", &I);
854   }
855
856   // Check that void typed values don't have names
857   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
858           "Instruction has a name, but provides a void value!", &I);
859
860   // Check that the return value of the instruction is either void or a legal
861   // value type.
862   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
863           "Instruction returns a non-scalar type!", &I);
864
865   // Check that all uses of the instruction, if they are instructions
866   // themselves, actually have parent basic blocks.  If the use is not an
867   // instruction, it is an error!
868   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
869        UI != UE; ++UI) {
870     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
871             *UI);
872     Instruction *Used = cast<Instruction>(*UI);
873     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
874             " embeded in a basic block!", &I, Used);
875   }
876
877   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
878     Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
879
880     // Check to make sure that only first-class-values are operands to
881     // instructions.
882     Assert1(I.getOperand(i)->getType()->isFirstClassType(),
883             "Instruction operands must be first-class values!", &I);
884   
885     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
886       // Check to make sure that the "address of" an intrinsic function is never
887       // taken.
888       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
889               "Cannot take the address of an intrinsic!", &I);
890     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
891       Assert1(OpBB->getParent() == BB->getParent(),
892               "Referring to a basic block in another function!", &I);
893     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
894       Assert1(OpArg->getParent() == BB->getParent(),
895               "Referring to an argument in another function!", &I);
896     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
897       BasicBlock *OpBlock = Op->getParent();
898
899       // Check that a definition dominates all of its uses.
900       if (!isa<PHINode>(I)) {
901         // Invoke results are only usable in the normal destination, not in the
902         // exceptional destination.
903         if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
904           OpBlock = II->getNormalDest();
905           
906           Assert2(OpBlock != II->getUnwindDest(),
907                   "No uses of invoke possible due to dominance structure!",
908                   Op, II);
909           
910           // If the normal successor of an invoke instruction has multiple
911           // predecessors, then the normal edge from the invoke is critical, so
912           // the invoke value can only be live if the destination block
913           // dominates all of it's predecessors (other than the invoke) or if
914           // the invoke value is only used by a phi in the successor.
915           if (!OpBlock->getSinglePredecessor() &&
916               EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
917             // The first case we allow is if the use is a PHI operand in the
918             // normal block, and if that PHI operand corresponds to the invoke's
919             // block.
920             bool Bad = true;
921             if (PHINode *PN = dyn_cast<PHINode>(&I))
922               if (PN->getParent() == OpBlock &&
923                   PN->getIncomingBlock(i/2) == Op->getParent())
924                 Bad = false;
925             
926             // If it is used by something non-phi, then the other case is that
927             // 'OpBlock' dominates all of its predecessors other than the
928             // invoke.  In this case, the invoke value can still be used.
929             if (Bad) {
930               Bad = false;
931               for (pred_iterator PI = pred_begin(OpBlock),
932                    E = pred_end(OpBlock); PI != E; ++PI) {
933                 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
934                   Bad = true;
935                   break;
936                 }
937               }
938             }
939             Assert2(!Bad,
940                     "Invoke value defined on critical edge but not dead!", &I,
941                     Op);
942           }
943         } else if (OpBlock == BB) {
944           // If they are in the same basic block, make sure that the definition
945           // comes before the use.
946           Assert2(InstsInThisBlock.count(Op) ||
947                   !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
948                   "Instruction does not dominate all uses!", Op, &I);
949         }
950
951         // Definition must dominate use unless use is unreachable!
952         Assert2(EF->dominates(OpBlock, BB) ||
953                 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
954                 "Instruction does not dominate all uses!", Op, &I);
955       } else {
956         // PHI nodes are more difficult than other nodes because they actually
957         // "use" the value in the predecessor basic blocks they correspond to.
958         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
959         Assert2(EF->dominates(OpBlock, PredBB) ||
960                 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
961                 "Instruction does not dominate all uses!", Op, &I);
962       }
963     } else if (isa<InlineAsm>(I.getOperand(i))) {
964       Assert1(i == 0 && isa<CallInst>(I),
965               "Cannot take the address of an inline asm!", &I);
966     }
967   }
968   InstsInThisBlock.insert(&I);
969 }
970
971 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
972 ///
973 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
974   Function *IF = CI.getCalledFunction();
975   Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!", IF);
976   
977 #define GET_INTRINSIC_VERIFIER
978 #include "llvm/Intrinsics.gen"
979 #undef GET_INTRINSIC_VERIFIER
980 }
981
982 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
983 /// Intrinsics.gen.  This implements a little state machine that verifies the
984 /// prototype of intrinsics.
985 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
986   va_list VA;
987   va_start(VA, F);
988   
989   const FunctionType *FTy = F->getFunctionType();
990   
991   // Note that "arg#0" is the return type.
992   for (unsigned ArgNo = 0; 1; ++ArgNo) {
993     int TypeID = va_arg(VA, int);
994
995     if (TypeID == -2) {
996       break;
997     }
998
999     if (TypeID == -1) {
1000       if (ArgNo != FTy->getNumParams()+1)
1001         CheckFailed("Intrinsic prototype has too many arguments!", F);
1002       break;
1003     }
1004
1005     if (ArgNo == FTy->getNumParams()+1) {
1006       CheckFailed("Intrinsic prototype has too few arguments!", F);
1007       break;
1008     }
1009     
1010     const Type *Ty;
1011     if (ArgNo == 0) 
1012       Ty = FTy->getReturnType();
1013     else
1014       Ty = FTy->getParamType(ArgNo-1);
1015     
1016     if (TypeID != Ty->getTypeID()) {
1017       if (ArgNo == 0)
1018         CheckFailed("Intrinsic prototype has incorrect result type!", F);
1019       else
1020         CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1021       break;
1022     }
1023
1024     if (TypeID == Type::IntegerTyID) {
1025       unsigned GotBits = (unsigned) va_arg(VA, int);
1026       unsigned ExpectBits = cast<IntegerType>(Ty)->getBitWidth();
1027       if (GotBits != ExpectBits) {
1028         std::string bitmsg = " Expecting " + utostr(ExpectBits) + " but got " +
1029                              utostr(GotBits) + " bits.";
1030         if (ArgNo == 0)
1031           CheckFailed("Intrinsic prototype has incorrect integer result width!"
1032                       + bitmsg, F);
1033         else
1034           CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1035                       "incorrect integer width!" + bitmsg, F);
1036         break;
1037       }
1038     } else if (TypeID == Type::PackedTyID) {
1039       // If this is a packed argument, verify the number and type of elements.
1040       const PackedType *PTy = cast<PackedType>(Ty);
1041       int ElemTy = va_arg(VA, int);
1042       if (ElemTy != PTy->getElementType()->getTypeID()) {
1043         CheckFailed("Intrinsic prototype has incorrect vector element type!",
1044                     F);
1045         break;
1046       }
1047       if (ElemTy == Type::IntegerTyID) {
1048         unsigned NumBits = (unsigned)va_arg(VA, int);
1049         unsigned ExpectedBits = 
1050           cast<IntegerType>(PTy->getElementType())->getBitWidth();
1051         if (NumBits != ExpectedBits) {
1052           CheckFailed("Intrinsic prototype has incorrect vector element type!",
1053                       F);
1054           break;
1055         }
1056       }
1057       if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1058         CheckFailed("Intrinsic prototype has incorrect number of "
1059                     "vector elements!",F);
1060           break;
1061       }
1062     }
1063   }
1064
1065   va_end(VA);
1066 }
1067
1068
1069 //===----------------------------------------------------------------------===//
1070 //  Implement the public interfaces to this file...
1071 //===----------------------------------------------------------------------===//
1072
1073 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1074   return new Verifier(action);
1075 }
1076
1077
1078 // verifyFunction - Create
1079 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1080   Function &F = const_cast<Function&>(f);
1081   assert(!F.isDeclaration() && "Cannot verify external functions");
1082
1083   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1084   Verifier *V = new Verifier(action);
1085   FPM.add(V);
1086   FPM.run(F);
1087   return V->Broken;
1088 }
1089
1090 /// verifyModule - Check a module for errors, printing messages on stderr.
1091 /// Return true if the module is corrupt.
1092 ///
1093 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1094                         std::string *ErrorInfo) {
1095   PassManager PM;
1096   Verifier *V = new Verifier(action);
1097   PM.add(V);
1098   PM.run((Module&)M);
1099   
1100   if (ErrorInfo && V->Broken)
1101     *ErrorInfo = V->msgs.str();
1102   return V->Broken;
1103 }
1104
1105 // vim: sw=2