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