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