Fold two assertions with backwards error messages into one with a
[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 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 //  . Function's 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/Constants.h"
45 #include "llvm/Pass.h"
46 #include "llvm/Module.h"
47 #include "llvm/ModuleProvider.h"
48 #include "llvm/DerivedTypes.h"
49 #include "llvm/Instructions.h"
50 #include "llvm/Intrinsics.h"
51 #include "llvm/PassManager.h"
52 #include "llvm/SymbolTable.h"
53 #include "llvm/Analysis/Dominators.h"
54 #include "llvm/Support/CFG.h"
55 #include "llvm/Support/InstVisitor.h"
56 #include "Support/STLExtras.h"
57 #include <algorithm>
58 #include <sstream>
59 using namespace llvm;
60
61 namespace {  // Anonymous namespace for class
62
63   struct Verifier : public FunctionPass, InstVisitor<Verifier> {
64     bool Broken;          // Is this module found to be broken?
65     bool RealPass;        // Are we not being run by a PassManager?
66     VerifierFailureAction action;
67                           // What to do if verification fails.
68     Module *Mod;          // Module we are verifying right now
69     DominatorSet *DS;     // Dominator set, caution can be null!
70     std::stringstream msgs;  // A stringstream to collect messages
71
72     Verifier() 
73         : Broken(false), RealPass(true), action(AbortProcessAction),
74           DS(0), msgs( std::ios_base::app | std::ios_base::out ) {}
75     Verifier( VerifierFailureAction ctn )
76         : Broken(false), RealPass(true), action(ctn), DS(0), 
77           msgs( std::ios_base::app | std::ios_base::out ) {}
78     Verifier(bool AB ) 
79         : Broken(false), RealPass(true), 
80           action( AB ? AbortProcessAction : PrintMessageAction), DS(0), 
81           msgs( std::ios_base::app | std::ios_base::out ) {}
82     Verifier(DominatorSet &ds) 
83       : Broken(false), RealPass(false), action(PrintMessageAction),
84         DS(&ds), msgs( std::ios_base::app | std::ios_base::out ) {}
85
86
87     bool doInitialization(Module &M) {
88       Mod = &M;
89       verifySymbolTable(M.getSymbolTable());
90
91       // If this is a real pass, in a pass manager, we must abort before
92       // returning back to the pass manager, or else the pass manager may try to
93       // run other passes on the broken module.
94       if (RealPass)
95         abortIfBroken();
96       return false;
97     }
98
99     bool runOnFunction(Function &F) {
100       // Get dominator information if we are being run by PassManager
101       if (RealPass) DS = &getAnalysis<DominatorSet>();
102       visit(F);
103
104       // If this is a real pass, in a pass manager, we must abort before
105       // returning back to the pass manager, or else the pass manager may try to
106       // run other passes on the broken module.
107       if (RealPass)
108         abortIfBroken();
109
110       return false;
111     }
112
113     bool doFinalization(Module &M) {
114       // Scan through, checking all of the external function's linkage now...
115       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
116         visitGlobalValue(*I);
117
118       for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
119         visitGlobalValue(*I);
120
121       // If the module is broken, abort at this time.
122       abortIfBroken();
123       return false;
124     }
125
126     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
127       AU.setPreservesAll();
128       if (RealPass)
129         AU.addRequired<DominatorSet>();
130     }
131
132     /// abortIfBroken - If the module is broken and we are supposed to abort on
133     /// this condition, do so.
134     ///
135     void abortIfBroken() {
136       if (Broken)
137       {
138         msgs << "Broken module found, ";
139         switch (action)
140         {
141           case AbortProcessAction:
142             msgs << "compilation aborted!\n";
143             std::cerr << msgs.str();
144             abort();
145           case ThrowExceptionAction:
146             msgs << "verification terminated.\n";
147             throw msgs.str();
148           case PrintMessageAction:
149             msgs << "verification continues.\n";
150             std::cerr << msgs.str();
151             break;
152           case ReturnStatusAction:
153             break;
154         }
155       }
156     }
157
158
159     // Verification methods...
160     void verifySymbolTable(SymbolTable &ST);
161     void visitGlobalValue(GlobalValue &GV);
162     void visitFunction(Function &F);
163     void visitBasicBlock(BasicBlock &BB);
164     void visitPHINode(PHINode &PN);
165     void visitBinaryOperator(BinaryOperator &B);
166     void visitShiftInst(ShiftInst &SI);
167     void visitVANextInst(VANextInst &VAN) { visitInstruction(VAN); }
168     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
169     void visitCallInst(CallInst &CI);
170     void visitGetElementPtrInst(GetElementPtrInst &GEP);
171     void visitLoadInst(LoadInst &LI);
172     void visitStoreInst(StoreInst &SI);
173     void visitInstruction(Instruction &I);
174     void visitTerminatorInst(TerminatorInst &I);
175     void visitReturnInst(ReturnInst &RI);
176     void visitSelectInst(SelectInst &SI);
177     void visitUserOp1(Instruction &I);
178     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
179     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
180
181
182     void WriteValue(const Value *V) {
183       if (!V) return;
184       if (isa<Instruction>(V)) {
185         msgs << *V;
186       } else if (const Type *Ty = dyn_cast<Type>(V)) {
187         WriteTypeSymbolic(msgs, Ty, Mod);
188       } else {
189         WriteAsOperand (msgs, V, true, true, Mod);
190         msgs << "\n";
191       }
192     }
193
194
195     // CheckFailed - A check failed, so print out the condition and the message
196     // that failed.  This provides a nice place to put a breakpoint if you want
197     // to see why something is not correct.
198     void CheckFailed(const std::string &Message,
199                      const Value *V1 = 0, const Value *V2 = 0,
200                      const Value *V3 = 0, const Value *V4 = 0) {
201       msgs << Message << "\n";
202       WriteValue(V1);
203       WriteValue(V2);
204       WriteValue(V3);
205       WriteValue(V4);
206       Broken = true;
207     }
208   };
209
210   RegisterOpt<Verifier> X("verify", "Module Verifier");
211 } // End anonymous namespace
212
213
214 // Assert - We know that cond should be true, if not print an error message.
215 #define Assert(C, M) \
216   do { if (!(C)) { CheckFailed(M); return; } } while (0)
217 #define Assert1(C, M, V1) \
218   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
219 #define Assert2(C, M, V1, V2) \
220   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
221 #define Assert3(C, M, V1, V2, V3) \
222   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
223 #define Assert4(C, M, V1, V2, V3, V4) \
224   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
225
226
227 void Verifier::visitGlobalValue(GlobalValue &GV) {
228   Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
229           "Global is external, but doesn't have external linkage!", &GV);
230   Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
231           "Only global variables can have appending linkage!", &GV);
232
233   if (GV.hasAppendingLinkage()) {
234     GlobalVariable &GVar = cast<GlobalVariable>(GV);
235     Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
236             "Only global arrays can have appending linkage!", &GV);
237   }
238 }
239
240 // verifySymbolTable - Verify that a function or module symbol table is ok
241 //
242 void Verifier::verifySymbolTable(SymbolTable &ST) {
243   // Loop over all of the types in the symbol table...
244   for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
245     for (SymbolTable::type_iterator I = TI->second.begin(),
246            E = TI->second.end(); I != E; ++I) {
247       Value *V = I->second;
248
249       // Check that there are no void typed values in the symbol table.  Values
250       // with a void type cannot be put into symbol tables because they cannot
251       // have names!
252       Assert1(V->getType() != Type::VoidTy,
253               "Values with void type are not allowed to have names!", V);
254     }
255 }
256
257
258 // visitFunction - Verify that a function is ok.
259 //
260 void Verifier::visitFunction(Function &F) {
261   // Check function arguments...
262   const FunctionType *FT = F.getFunctionType();
263   unsigned NumArgs = F.getArgumentList().size();
264
265   Assert2(FT->getNumParams() == NumArgs,
266           "# formal arguments must match # of arguments for function type!",
267           &F, FT);
268   Assert1(F.getReturnType()->isFirstClassType() ||
269           F.getReturnType() == Type::VoidTy,
270           "Functions cannot return aggregate values!", &F);
271
272   // Check that the argument values match the function type for this function...
273   unsigned i = 0;
274   for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
275     Assert2(I->getType() == FT->getParamType(i),
276             "Argument value does not match function argument type!",
277             I, FT->getParamType(i));
278
279   if (!F.isExternal()) {
280     verifySymbolTable(F.getSymbolTable());
281
282     // Check the entry node
283     BasicBlock *Entry = &F.getEntryBlock();
284     Assert1(pred_begin(Entry) == pred_end(Entry),
285             "Entry block to function must not have predecessors!", Entry);
286   }
287 }
288
289
290 // verifyBasicBlock - Verify that a basic block is well formed...
291 //
292 void Verifier::visitBasicBlock(BasicBlock &BB) {
293   // Check constraints that this basic block imposes on all of the PHI nodes in
294   // it.
295   if (isa<PHINode>(BB.front())) {
296     std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
297     std::sort(Preds.begin(), Preds.end());
298     
299     for (BasicBlock::iterator I = BB.begin();
300          PHINode *PN = dyn_cast<PHINode>(I); ++I) {
301
302       // Ensure that PHI nodes have at least one entry!
303       Assert1(PN->getNumIncomingValues() != 0,
304               "PHI nodes must have at least one entry.  If the block is dead, "
305               "the PHI should be removed!", PN);
306       Assert1(PN->getNumIncomingValues() == Preds.size(),
307               "PHINode should have one entry for each predecessor of its "
308               "parent basic block!", PN);
309       
310       // Get and sort all incoming values in the PHI node...
311       std::vector<std::pair<BasicBlock*, Value*> > Values;
312       Values.reserve(PN->getNumIncomingValues());
313       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
314         Values.push_back(std::make_pair(PN->getIncomingBlock(i),
315                                         PN->getIncomingValue(i)));
316       std::sort(Values.begin(), Values.end());
317       
318       for (unsigned i = 0, e = Values.size(); i != e; ++i) {
319         // Check to make sure that if there is more than one entry for a
320         // particular basic block in this PHI node, that the incoming values are
321         // all identical.
322         //
323         Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
324                 Values[i].second == Values[i-1].second,
325                 "PHI node has multiple entries for the same basic block with "
326                 "different incoming values!", PN, Values[i].first,
327                 Values[i].second, Values[i-1].second);
328         
329         // Check to make sure that the predecessors and PHI node entries are
330         // matched up.
331         Assert3(Values[i].first == Preds[i],
332                 "PHI node entries do not match predecessors!", PN,
333                 Values[i].first, Preds[i]);        
334       }
335     }
336   }
337
338   // Ensure that basic blocks have terminators!
339   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
340 }
341
342 void Verifier::visitTerminatorInst(TerminatorInst &I) {
343   // Ensure that terminators only exist at the end of the basic block.
344   Assert1(&I == I.getParent()->getTerminator(),
345           "Terminator found in the middle of a basic block!", I.getParent());
346   visitInstruction(I);
347 }
348
349 void Verifier::visitReturnInst(ReturnInst &RI) {
350   Function *F = RI.getParent()->getParent();
351   if (RI.getNumOperands() == 0)
352     Assert1(F->getReturnType() == Type::VoidTy,
353             "Function returns no value, but ret instruction found that does!",
354             &RI);
355   else
356     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
357             "Function return type does not match operand "
358             "type of return inst!", &RI, F->getReturnType());
359
360   // Check to make sure that the return value has necessary properties for
361   // terminators...
362   visitTerminatorInst(RI);
363 }
364
365 void Verifier::visitSelectInst(SelectInst &SI) {
366   Assert1(SI.getCondition()->getType() == Type::BoolTy,
367           "Select condition type must be bool!", &SI);
368   Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
369           "Select values must have identical types!", &SI);
370   Assert1(SI.getTrueValue()->getType() == SI.getType(),
371           "Select values must have same type as select instruction!", &SI);
372 }
373
374
375 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
376 /// a pass, if any exist, it's an error.
377 ///
378 void Verifier::visitUserOp1(Instruction &I) {
379   Assert1(0, "User-defined operators should not live outside of a pass!",
380           &I);
381 }
382
383 /// visitPHINode - Ensure that a PHI node is well formed.
384 ///
385 void Verifier::visitPHINode(PHINode &PN) {
386   // Ensure that the PHI nodes are all grouped together at the top of the block.
387   // This can be tested by checking whether the instruction before this is
388   // either nonexistent (because this is begin()) or is a PHI node.  If not,
389   // then there is some other instruction before a PHI.
390   Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
391           "PHI nodes not grouped at top of basic block!",
392           &PN, PN.getParent());
393
394   // Check that all of the operands of the PHI node have the same type as the
395   // result.
396   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
397     Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
398             "PHI node operands are not the same type as the result!", &PN);
399
400   // All other PHI node constraints are checked in the visitBasicBlock method.
401
402   visitInstruction(PN);
403 }
404
405 void Verifier::visitCallInst(CallInst &CI) {
406   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
407           "Called function must be a pointer!", &CI);
408   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
409   Assert1(isa<FunctionType>(FPTy->getElementType()),
410           "Called function is not pointer to function type!", &CI);
411
412   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
413
414   // Verify that the correct number of arguments are being passed
415   if (FTy->isVarArg())
416     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
417             "Called function requires more parameters than were provided!",&CI);
418   else
419     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
420             "Incorrect number of arguments passed to called function!", &CI);
421
422   // Verify that all arguments to the call match the function type...
423   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
424     Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
425             "Call parameter type does not match function signature!",
426             CI.getOperand(i+1), FTy->getParamType(i), &CI);
427
428   if (Function *F = CI.getCalledFunction())
429     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
430       visitIntrinsicFunctionCall(ID, CI);
431
432   visitInstruction(CI);
433 }
434
435 /// visitBinaryOperator - Check that both arguments to the binary operator are
436 /// of the same type!
437 ///
438 void Verifier::visitBinaryOperator(BinaryOperator &B) {
439   Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
440           "Both operands to a binary operator are not of the same type!", &B);
441
442   // Check that logical operators are only used with integral operands.
443   if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
444       B.getOpcode() == Instruction::Xor) {
445     Assert1(B.getType()->isIntegral(),
446             "Logical operators only work with integral types!", &B);
447     Assert1(B.getType() == B.getOperand(0)->getType(),
448             "Logical operators must have same type for operands and result!",
449             &B);
450   } else if (isa<SetCondInst>(B)) {
451     // Check that setcc instructions return bool
452     Assert1(B.getType() == Type::BoolTy,
453             "setcc instructions must return boolean values!", &B);
454   } else {
455     // Arithmetic operators only work on integer or fp values
456     Assert1(B.getType() == B.getOperand(0)->getType(),
457             "Arithmetic operators must have same type for operands and result!",
458             &B);
459     Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
460             "Arithmetic operators must have integer or fp type!", &B);
461   }
462   
463   visitInstruction(B);
464 }
465
466 void Verifier::visitShiftInst(ShiftInst &SI) {
467   Assert1(SI.getType()->isInteger(),
468           "Shift must return an integer result!", &SI);
469   Assert1(SI.getType() == SI.getOperand(0)->getType(),
470           "Shift return type must be same as first operand!", &SI);
471   Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
472           "Second operand to shift must be ubyte type!", &SI);
473   visitInstruction(SI);
474 }
475
476 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
477   const Type *ElTy =
478     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
479                    std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
480   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
481   Assert2(PointerType::get(ElTy) == GEP.getType(),
482           "GEP is not of right type for indices!", &GEP, ElTy);
483   visitInstruction(GEP);
484 }
485
486 void Verifier::visitLoadInst(LoadInst &LI) {
487   const Type *ElTy =
488     cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
489   Assert2(ElTy == LI.getType(),
490           "Load result type does not match pointer operand type!", &LI, ElTy);
491   visitInstruction(LI);
492 }
493
494 void Verifier::visitStoreInst(StoreInst &SI) {
495   const Type *ElTy =
496     cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
497   Assert2(ElTy == SI.getOperand(0)->getType(),
498           "Stored value type does not match pointer operand type!", &SI, ElTy);
499   visitInstruction(SI);
500 }
501
502
503 /// verifyInstruction - Verify that an instruction is well formed.
504 ///
505 void Verifier::visitInstruction(Instruction &I) {
506   BasicBlock *BB = I.getParent();  
507   Assert1(BB, "Instruction not embedded in basic block!", &I);
508
509   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
510     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
511          UI != UE; ++UI)
512       Assert1(*UI != (User*)&I ||
513               !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
514               "Only PHI nodes may reference their own value!", &I);
515   }
516
517   // Check that void typed values don't have names
518   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
519           "Instruction has a name, but provides a void value!", &I);
520
521   // Check that the return value of the instruction is either void or a legal
522   // value type.
523   Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
524           "Instruction returns a non-scalar type!", &I);
525
526   // Check that all uses of the instruction, if they are instructions
527   // themselves, actually have parent basic blocks.  If the use is not an
528   // instruction, it is an error!
529   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
530        UI != UE; ++UI) {
531     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
532             *UI);
533     Instruction *Used = cast<Instruction>(*UI);
534     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
535             " embeded in a basic block!", &I, Used);
536   }
537
538   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
539     // Check to make sure that the "address of" an intrinsic function is never
540     // taken.
541     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
542       Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
543               "Cannot take the address of an intrinsic!", &I);
544     } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
545       Assert1(OpBB->getParent() == BB->getParent(),
546               "Referring to a basic block in another function!", &I);
547     } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
548       Assert1(OpArg->getParent() == BB->getParent(),
549               "Referring to an argument in another function!", &I);
550     } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
551       BasicBlock *OpBlock = Op->getParent();
552
553       // Check that a definition dominates all of its uses.
554       if (!isa<PHINode>(I)) {
555         // Invoke results are only usable in the normal destination, not in the
556         // exceptional destination.
557         if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
558           OpBlock = II->getNormalDest();
559         else if (OpBlock == BB) {
560           // If they are in the same basic block, make sure that the definition
561           // comes before the use.
562           Assert2(DS->dominates(Op, &I),
563                   "Instruction does not dominate all uses!", Op, &I);
564         }
565
566         // Definition must dominate use unless use is unreachable!
567         Assert2(DS->dominates(OpBlock, BB) ||
568                 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
569                 "Instruction does not dominate all uses!", Op, &I);
570       } else {
571         // PHI nodes are more difficult than other nodes because they actually
572         // "use" the value in the predecessor basic blocks they correspond to.
573         BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
574         Assert2(DS->dominates(OpBlock, PredBB) ||
575                 !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
576                 "Instruction does not dominate all uses!", Op, &I);
577       }
578     }
579   }
580 }
581
582 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
583 ///
584 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
585   Function *IF = CI.getCalledFunction();
586   const FunctionType *FT = IF->getFunctionType();
587   Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
588   unsigned NumArgs = 0;
589
590   // FIXME: this should check the return type of each intrinsic as well, also
591   // arguments!
592   switch (ID) {
593   case Intrinsic::vastart:
594     Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
595             "llvm.va_start intrinsic may only occur in function with variable"
596             " args!", &CI);
597     NumArgs = 0;
598     break;
599   case Intrinsic::vaend:          NumArgs = 1; break;
600   case Intrinsic::vacopy:         NumArgs = 1; break;
601
602   case Intrinsic::returnaddress:
603   case Intrinsic::frameaddress:
604     Assert1(isa<PointerType>(FT->getReturnType()),
605             "llvm.(frame|return)address must return pointers", IF);
606     Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
607        "llvm.(frame|return)address require a single constant integer argument",
608             &CI);
609     NumArgs = 1;
610     break;
611
612   // Verify that read and write port have integral parameters of the correct
613   // signed-ness.
614   case Intrinsic::writeport:
615     Assert1(FT->getNumParams() == 2,
616             "Illegal # arguments for intrinsic function!", IF);
617     Assert1(FT->getParamType(0)->isIntegral(),
618             "First argument not unsigned int!", IF);
619     Assert1(FT->getParamType(1)->isUnsigned(),
620             "First argument not unsigned int!", IF);
621     NumArgs = 2;
622     break;
623
624   case Intrinsic::writeio:
625     Assert1(FT->getNumParams() == 2,
626             "Illegal # arguments for intrinsic function!", IF);
627     Assert1(FT->getParamType(0)->isFirstClassType(),
628             "First argument not a first class type!", IF);
629     Assert1(FT->getParamType(1)->getPrimitiveID() == Type::PointerTyID,
630             "Second argument not a pointer!", IF);
631     NumArgs = 2;
632     break;
633
634   case Intrinsic::readport:
635     Assert1(FT->getNumParams() == 1,
636             "Illegal # arguments for intrinsic function!", IF);
637     Assert1(FT->getReturnType()->isFirstClassType(),
638             "Return type is not a first class type!", IF);
639     Assert1(FT->getParamType(0)->isUnsigned(),
640             "First argument not unsigned int!", IF);
641     NumArgs = 1;
642     break;
643
644   case Intrinsic:: readio: {
645     const Type * ParamType  = FT->getParamType(0);
646     const Type * ReturnType = FT->getReturnType();
647
648     Assert1(FT->getNumParams() == 1,
649             "Illegal # arguments for intrinsic function!", IF);
650     Assert1(isa<PointerType>(ParamType),
651             "First argument not a pointer!", IF);
652     Assert1(((cast<PointerType>(ParamType)->getElementType()) == ReturnType),
653             "Pointer type doesn't match return type!", IF);
654     NumArgs = 1;
655     break;
656   }
657
658   case Intrinsic::setjmp:          NumArgs = 1; break;
659   case Intrinsic::longjmp:         NumArgs = 2; break;
660   case Intrinsic::sigsetjmp:       NumArgs = 2; break;
661   case Intrinsic::siglongjmp:      NumArgs = 2; break;
662
663   case Intrinsic::dbg_stoppoint:   NumArgs = 4; break;
664   case Intrinsic::dbg_region_start:NumArgs = 1; break;
665   case Intrinsic::dbg_region_end:  NumArgs = 1; break;
666   case Intrinsic::dbg_func_start:  NumArgs = 1; break;
667   case Intrinsic::dbg_declare:     NumArgs = 1; break;
668
669   case Intrinsic::memcpy:          NumArgs = 4; break;
670   case Intrinsic::memmove:         NumArgs = 4; break;
671   case Intrinsic::memset:          NumArgs = 4; break;
672  
673   case Intrinsic::alpha_ctlz:      NumArgs = 1; break;
674   case Intrinsic::alpha_cttz:      NumArgs = 1; break;
675   case Intrinsic::alpha_ctpop:     NumArgs = 1; break;
676   case Intrinsic::alpha_umulh:     NumArgs = 2; break;
677   case Intrinsic::alpha_vecop:     NumArgs = 4; break;
678   case Intrinsic::alpha_pup:       NumArgs = 3; break;
679   case Intrinsic::alpha_bytezap:   NumArgs = 2; break;
680   case Intrinsic::alpha_bytemanip: NumArgs = 3; break;
681   case Intrinsic::alpha_dfpbop:    NumArgs = 3; break;
682   case Intrinsic::alpha_dfpuop:    NumArgs = 2; break;
683   case Intrinsic::alpha_unordered: NumArgs = 2; break;
684   case Intrinsic::alpha_uqtodfp:   NumArgs = 2; break;
685   case Intrinsic::alpha_uqtosfp:   NumArgs = 2; break;
686   case Intrinsic::alpha_dfptosq:   NumArgs = 2; break;
687   case Intrinsic::alpha_sfptosq:   NumArgs = 2; break;
688
689   case Intrinsic::not_intrinsic: 
690     assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
691   }
692
693   Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
694                                              FT->isVarArg()),
695           "Illegal # arguments for intrinsic function!", IF);
696 }
697
698
699 //===----------------------------------------------------------------------===//
700 //  Implement the public interfaces to this file...
701 //===----------------------------------------------------------------------===//
702
703 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
704   return new Verifier(action);
705 }
706
707
708 // verifyFunction - Create 
709 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
710   Function &F = const_cast<Function&>(f);
711   assert(!F.isExternal() && "Cannot verify external functions");
712   
713   FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
714   Verifier *V = new Verifier(action);
715   FPM.add(V);
716   FPM.run(F);
717   return V->Broken;
718 }
719
720 /// verifyModule - Check a module for errors, printing messages on stderr.
721 /// Return true if the module is corrupt.
722 ///
723 bool llvm::verifyModule(const Module &M, VerifierFailureAction action) {
724   PassManager PM;
725   Verifier *V = new Verifier(action);
726   PM.add(V);
727   PM.run((Module&)M);
728   return V->Broken;
729 }