1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
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.
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...
40 //===----------------------------------------------------------------------===//
42 #include "llvm/Analysis/Verifier.h"
43 #include "llvm/Assembly/Writer.h"
44 #include "llvm/CallingConv.h"
45 #include "llvm/Constants.h"
46 #include "llvm/Pass.h"
47 #include "llvm/Module.h"
48 #include "llvm/ModuleProvider.h"
49 #include "llvm/DerivedTypes.h"
50 #include "llvm/InlineAsm.h"
51 #include "llvm/Instructions.h"
52 #include "llvm/Intrinsics.h"
53 #include "llvm/PassManager.h"
54 #include "llvm/ValueSymbolTable.h"
55 #include "llvm/Analysis/Dominators.h"
56 #include "llvm/Support/CFG.h"
57 #include "llvm/Support/InstVisitor.h"
58 #include "llvm/Support/Streams.h"
59 #include "llvm/ADT/StringExtras.h"
60 #include "llvm/ADT/STLExtras.h"
61 #include "llvm/Support/Compiler.h"
67 namespace { // Anonymous namespace for class
69 struct VISIBILITY_HIDDEN
70 Verifier : public FunctionPass, InstVisitor<Verifier> {
71 bool Broken; // Is this module found to be broken?
72 bool RealPass; // Are we not being run by a PassManager?
73 VerifierFailureAction action;
74 // What to do if verification fails.
75 Module *Mod; // Module we are verifying right now
76 ETForest *EF; // ET-Forest, caution can be null!
77 std::stringstream msgs; // A stringstream to collect messages
79 /// InstInThisBlock - when verifying a basic block, keep track of all of the
80 /// instructions we have seen so far. This allows us to do efficient
81 /// dominance checks for the case when an instruction has an operand that is
82 /// an instruction in the same block.
83 std::set<Instruction*> InstsInThisBlock;
86 : Broken(false), RealPass(true), action(AbortProcessAction),
87 EF(0), msgs( std::ios::app | std::ios::out ) {}
88 Verifier( VerifierFailureAction ctn )
89 : Broken(false), RealPass(true), action(ctn), EF(0),
90 msgs( std::ios::app | std::ios::out ) {}
92 : Broken(false), RealPass(true),
93 action( AB ? AbortProcessAction : PrintMessageAction), EF(0),
94 msgs( std::ios::app | std::ios::out ) {}
95 Verifier(ETForest &ef)
96 : Broken(false), RealPass(false), action(PrintMessageAction),
97 EF(&ef), msgs( std::ios::app | std::ios::out ) {}
100 bool doInitialization(Module &M) {
102 verifyTypeSymbolTable(M.getTypeSymbolTable());
103 verifyValueSymbolTable(M.getValueSymbolTable());
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.
109 return abortIfBroken();
113 bool runOnFunction(Function &F) {
114 // Get dominator information if we are being run by PassManager
115 if (RealPass) EF = &getAnalysis<ETForest>();
118 InstsInThisBlock.clear();
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.
124 return abortIfBroken();
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);
134 // Check to make sure function prototypes are okay.
135 if (I->isDeclaration()) visitFunction(*I);
138 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
140 visitGlobalVariable(*I);
142 // If the module is broken, abort at this time.
143 return abortIfBroken();
146 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
147 AU.setPreservesAll();
149 AU.addRequired<ETForest>();
152 /// abortIfBroken - If the module is broken and we are supposed to abort on
153 /// this condition, do so.
155 bool abortIfBroken() {
157 msgs << "Broken module found, ";
159 case AbortProcessAction:
160 msgs << "compilation aborted!\n";
163 case PrintMessageAction:
164 msgs << "verification continues.\n";
167 case ReturnStatusAction:
168 msgs << "compilation terminated.\n";
176 // Verification methods...
177 void verifyTypeSymbolTable(TypeSymbolTable &ST);
178 void verifyValueSymbolTable(ValueSymbolTable &ST);
179 void visitGlobalValue(GlobalValue &GV);
180 void visitGlobalVariable(GlobalVariable &GV);
181 void visitFunction(Function &F);
182 void visitBasicBlock(BasicBlock &BB);
183 void visitTruncInst(TruncInst &I);
184 void visitZExtInst(ZExtInst &I);
185 void visitSExtInst(SExtInst &I);
186 void visitFPTruncInst(FPTruncInst &I);
187 void visitFPExtInst(FPExtInst &I);
188 void visitFPToUIInst(FPToUIInst &I);
189 void visitFPToSIInst(FPToSIInst &I);
190 void visitUIToFPInst(UIToFPInst &I);
191 void visitSIToFPInst(SIToFPInst &I);
192 void visitIntToPtrInst(IntToPtrInst &I);
193 void visitPtrToIntInst(PtrToIntInst &I);
194 void visitBitCastInst(BitCastInst &I);
195 void visitPHINode(PHINode &PN);
196 void visitBinaryOperator(BinaryOperator &B);
197 void visitICmpInst(ICmpInst &IC);
198 void visitFCmpInst(FCmpInst &FC);
199 void visitExtractElementInst(ExtractElementInst &EI);
200 void visitInsertElementInst(InsertElementInst &EI);
201 void visitShuffleVectorInst(ShuffleVectorInst &EI);
202 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
203 void visitCallInst(CallInst &CI);
204 void visitGetElementPtrInst(GetElementPtrInst &GEP);
205 void visitLoadInst(LoadInst &LI);
206 void visitStoreInst(StoreInst &SI);
207 void visitInstruction(Instruction &I);
208 void visitTerminatorInst(TerminatorInst &I);
209 void visitReturnInst(ReturnInst &RI);
210 void visitSwitchInst(SwitchInst &SI);
211 void visitSelectInst(SelectInst &SI);
212 void visitUserOp1(Instruction &I);
213 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
214 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
216 void VerifyIntrinsicPrototype(Function *F, ...);
218 void WriteValue(const Value *V) {
220 if (isa<Instruction>(V)) {
223 WriteAsOperand(msgs, V, true, Mod);
228 void WriteType(const Type* T ) {
230 WriteTypeSymbolic(msgs, T, Mod );
234 // CheckFailed - A check failed, so print out the condition and the message
235 // that failed. This provides a nice place to put a breakpoint if you want
236 // to see why something is not correct.
237 void CheckFailed(const std::string &Message,
238 const Value *V1 = 0, const Value *V2 = 0,
239 const Value *V3 = 0, const Value *V4 = 0) {
240 msgs << Message << "\n";
248 void CheckFailed( const std::string& Message, const Value* V1,
249 const Type* T2, const Value* V3 = 0 ) {
250 msgs << Message << "\n";
258 RegisterPass<Verifier> X("verify", "Module Verifier");
259 } // End anonymous namespace
262 // Assert - We know that cond should be true, if not print an error message.
263 #define Assert(C, M) \
264 do { if (!(C)) { CheckFailed(M); return; } } while (0)
265 #define Assert1(C, M, V1) \
266 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
267 #define Assert2(C, M, V1, V2) \
268 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
269 #define Assert3(C, M, V1, V2, V3) \
270 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
271 #define Assert4(C, M, V1, V2, V3, V4) \
272 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
275 void Verifier::visitGlobalValue(GlobalValue &GV) {
276 Assert1(!GV.isDeclaration() ||
277 GV.hasExternalLinkage() ||
278 GV.hasDLLImportLinkage() ||
279 GV.hasExternalWeakLinkage(),
280 "Global is external, but doesn't have external or dllimport or weak linkage!",
283 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
284 "Global is marked as dllimport, but not external", &GV);
286 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
287 "Only global variables can have appending linkage!", &GV);
289 if (GV.hasAppendingLinkage()) {
290 GlobalVariable &GVar = cast<GlobalVariable>(GV);
291 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
292 "Only global arrays can have appending linkage!", &GV);
296 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
297 if (GV.hasInitializer())
298 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
299 "Global variable initializer type does not match global "
300 "variable type!", &GV);
302 visitGlobalValue(GV);
305 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
308 // verifySymbolTable - Verify that a function or module symbol table is ok
310 void Verifier::verifyValueSymbolTable(ValueSymbolTable &ST) {
312 // Loop over all of the values in the symbol table.
313 for (ValueSymbolTable::const_iterator VI = ST.begin(), VE = ST.end();
315 Value *V = VI->second;
316 // Check that there are no void typed values in the symbol table. Values
317 // with a void type cannot be put into symbol tables because they cannot
319 Assert1(V->getType() != Type::VoidTy,
320 "Values with void type are not allowed to have names!", V);
324 // visitFunction - Verify that a function is ok.
326 void Verifier::visitFunction(Function &F) {
327 // Check function arguments.
328 const FunctionType *FT = F.getFunctionType();
329 unsigned NumArgs = F.getArgumentList().size();
331 Assert2(FT->getNumParams() == NumArgs,
332 "# formal arguments must match # of arguments for function type!",
334 Assert1(F.getReturnType()->isFirstClassType() ||
335 F.getReturnType() == Type::VoidTy,
336 "Functions cannot return aggregate values!", &F);
338 Assert1(!FT->isStructReturn() ||
339 (FT->getReturnType() == Type::VoidTy &&
340 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
341 "Invalid struct-return function!", &F);
343 // Check that this function meets the restrictions on this calling convention.
344 switch (F.getCallingConv()) {
349 case CallingConv::Fast:
350 case CallingConv::Cold:
351 case CallingConv::X86_FastCall:
352 Assert1(!F.isVarArg(),
353 "Varargs functions must have C calling conventions!", &F);
357 // Check that the argument values match the function type for this function...
359 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
361 Assert2(I->getType() == FT->getParamType(i),
362 "Argument value does not match function argument type!",
363 I, FT->getParamType(i));
364 // Make sure no aggregates are passed by value.
365 Assert1(I->getType()->isFirstClassType(),
366 "Functions cannot take aggregates as arguments by value!", I);
369 if (!F.isDeclaration()) {
370 // Verify that this function (which has a body) is not named "llvm.*". It
371 // is not legal to define intrinsics.
372 if (F.getName().size() >= 5)
373 Assert1(F.getName().substr(0, 5) != "llvm.",
374 "llvm intrinsics cannot be defined!", &F);
376 verifyValueSymbolTable(F.getValueSymbolTable());
378 // Check the entry node
379 BasicBlock *Entry = &F.getEntryBlock();
380 Assert1(pred_begin(Entry) == pred_end(Entry),
381 "Entry block to function must not have predecessors!", Entry);
386 // verifyBasicBlock - Verify that a basic block is well formed...
388 void Verifier::visitBasicBlock(BasicBlock &BB) {
389 InstsInThisBlock.clear();
391 // Ensure that basic blocks have terminators!
392 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
394 // Check constraints that this basic block imposes on all of the PHI nodes in
396 if (isa<PHINode>(BB.front())) {
397 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
398 std::sort(Preds.begin(), Preds.end());
400 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
402 // Ensure that PHI nodes have at least one entry!
403 Assert1(PN->getNumIncomingValues() != 0,
404 "PHI nodes must have at least one entry. If the block is dead, "
405 "the PHI should be removed!", PN);
406 Assert1(PN->getNumIncomingValues() == Preds.size(),
407 "PHINode should have one entry for each predecessor of its "
408 "parent basic block!", PN);
410 // Get and sort all incoming values in the PHI node...
411 std::vector<std::pair<BasicBlock*, Value*> > Values;
412 Values.reserve(PN->getNumIncomingValues());
413 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
414 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
415 PN->getIncomingValue(i)));
416 std::sort(Values.begin(), Values.end());
418 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
419 // Check to make sure that if there is more than one entry for a
420 // particular basic block in this PHI node, that the incoming values are
423 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
424 Values[i].second == Values[i-1].second,
425 "PHI node has multiple entries for the same basic block with "
426 "different incoming values!", PN, Values[i].first,
427 Values[i].second, Values[i-1].second);
429 // Check to make sure that the predecessors and PHI node entries are
431 Assert3(Values[i].first == Preds[i],
432 "PHI node entries do not match predecessors!", PN,
433 Values[i].first, Preds[i]);
439 void Verifier::visitTerminatorInst(TerminatorInst &I) {
440 // Ensure that terminators only exist at the end of the basic block.
441 Assert1(&I == I.getParent()->getTerminator(),
442 "Terminator found in the middle of a basic block!", I.getParent());
446 void Verifier::visitReturnInst(ReturnInst &RI) {
447 Function *F = RI.getParent()->getParent();
448 if (RI.getNumOperands() == 0)
449 Assert2(F->getReturnType() == Type::VoidTy,
450 "Found return instr that returns void in Function of non-void "
451 "return type!", &RI, F->getReturnType());
453 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
454 "Function return type does not match operand "
455 "type of return inst!", &RI, F->getReturnType());
457 // Check to make sure that the return value has necessary properties for
459 visitTerminatorInst(RI);
462 void Verifier::visitSwitchInst(SwitchInst &SI) {
463 // Check to make sure that all of the constants in the switch instruction
464 // have the same type as the switched-on value.
465 const Type *SwitchTy = SI.getCondition()->getType();
466 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
467 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
468 "Switch constants must all be same type as switch value!", &SI);
470 visitTerminatorInst(SI);
473 void Verifier::visitSelectInst(SelectInst &SI) {
474 Assert1(SI.getCondition()->getType() == Type::Int1Ty,
475 "Select condition type must be bool!", &SI);
476 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
477 "Select values must have identical types!", &SI);
478 Assert1(SI.getTrueValue()->getType() == SI.getType(),
479 "Select values must have same type as select instruction!", &SI);
480 visitInstruction(SI);
484 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
485 /// a pass, if any exist, it's an error.
487 void Verifier::visitUserOp1(Instruction &I) {
488 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
491 void Verifier::visitTruncInst(TruncInst &I) {
492 // Get the source and destination types
493 const Type *SrcTy = I.getOperand(0)->getType();
494 const Type *DestTy = I.getType();
496 // Get the size of the types in bits, we'll need this later
497 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
498 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
500 Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
501 Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
502 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
507 void Verifier::visitZExtInst(ZExtInst &I) {
508 // Get the source and destination types
509 const Type *SrcTy = I.getOperand(0)->getType();
510 const Type *DestTy = I.getType();
512 // Get the size of the types in bits, we'll need this later
513 Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
514 Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
515 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
516 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
518 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
523 void Verifier::visitSExtInst(SExtInst &I) {
524 // Get the source and destination types
525 const Type *SrcTy = I.getOperand(0)->getType();
526 const Type *DestTy = I.getType();
528 // Get the size of the types in bits, we'll need this later
529 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
530 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
532 Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
533 Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
534 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
539 void Verifier::visitFPTruncInst(FPTruncInst &I) {
540 // Get the source and destination types
541 const Type *SrcTy = I.getOperand(0)->getType();
542 const Type *DestTy = I.getType();
543 // Get the size of the types in bits, we'll need this later
544 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
545 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
547 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
548 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
549 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
554 void Verifier::visitFPExtInst(FPExtInst &I) {
555 // Get the source and destination types
556 const Type *SrcTy = I.getOperand(0)->getType();
557 const Type *DestTy = I.getType();
559 // Get the size of the types in bits, we'll need this later
560 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
561 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
563 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
564 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
565 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
570 void Verifier::visitUIToFPInst(UIToFPInst &I) {
571 // Get the source and destination types
572 const Type *SrcTy = I.getOperand(0)->getType();
573 const Type *DestTy = I.getType();
575 Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
576 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
581 void Verifier::visitSIToFPInst(SIToFPInst &I) {
582 // Get the source and destination types
583 const Type *SrcTy = I.getOperand(0)->getType();
584 const Type *DestTy = I.getType();
586 Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
587 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
592 void Verifier::visitFPToUIInst(FPToUIInst &I) {
593 // Get the source and destination types
594 const Type *SrcTy = I.getOperand(0)->getType();
595 const Type *DestTy = I.getType();
597 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
598 Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
603 void Verifier::visitFPToSIInst(FPToSIInst &I) {
604 // Get the source and destination types
605 const Type *SrcTy = I.getOperand(0)->getType();
606 const Type *DestTy = I.getType();
608 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
609 Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
614 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
615 // Get the source and destination types
616 const Type *SrcTy = I.getOperand(0)->getType();
617 const Type *DestTy = I.getType();
619 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
620 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
625 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
626 // Get the source and destination types
627 const Type *SrcTy = I.getOperand(0)->getType();
628 const Type *DestTy = I.getType();
630 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
631 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
636 void Verifier::visitBitCastInst(BitCastInst &I) {
637 // Get the source and destination types
638 const Type *SrcTy = I.getOperand(0)->getType();
639 const Type *DestTy = I.getType();
641 // Get the size of the types in bits, we'll need this later
642 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
643 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
645 // BitCast implies a no-op cast of type only. No bits change.
646 // However, you can't cast pointers to anything but pointers.
647 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
648 "Bitcast requires both operands to be pointer or neither", &I);
649 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
654 /// visitPHINode - Ensure that a PHI node is well formed.
656 void Verifier::visitPHINode(PHINode &PN) {
657 // Ensure that the PHI nodes are all grouped together at the top of the block.
658 // This can be tested by checking whether the instruction before this is
659 // either nonexistent (because this is begin()) or is a PHI node. If not,
660 // then there is some other instruction before a PHI.
661 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
662 "PHI nodes not grouped at top of basic block!",
663 &PN, PN.getParent());
665 // Check that all of the operands of the PHI node have the same type as the
667 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
668 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
669 "PHI node operands are not the same type as the result!", &PN);
671 // All other PHI node constraints are checked in the visitBasicBlock method.
673 visitInstruction(PN);
676 void Verifier::visitCallInst(CallInst &CI) {
677 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
678 "Called function must be a pointer!", &CI);
679 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
680 Assert1(isa<FunctionType>(FPTy->getElementType()),
681 "Called function is not pointer to function type!", &CI);
683 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
685 // Verify that the correct number of arguments are being passed
687 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
688 "Called function requires more parameters than were provided!",&CI);
690 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
691 "Incorrect number of arguments passed to called function!", &CI);
693 // Verify that all arguments to the call match the function type...
694 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
695 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
696 "Call parameter type does not match function signature!",
697 CI.getOperand(i+1), FTy->getParamType(i), &CI);
699 if (Function *F = CI.getCalledFunction())
700 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
701 visitIntrinsicFunctionCall(ID, CI);
703 visitInstruction(CI);
706 /// visitBinaryOperator - Check that both arguments to the binary operator are
707 /// of the same type!
709 void Verifier::visitBinaryOperator(BinaryOperator &B) {
710 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
711 "Both operands to a binary operator are not of the same type!", &B);
713 switch (B.getOpcode()) {
714 // Check that logical operators are only used with integral operands.
715 case Instruction::And:
716 case Instruction::Or:
717 case Instruction::Xor:
718 Assert1(B.getType()->isInteger() ||
719 (isa<PackedType>(B.getType()) &&
720 cast<PackedType>(B.getType())->getElementType()->isInteger()),
721 "Logical operators only work with integral types!", &B);
722 Assert1(B.getType() == B.getOperand(0)->getType(),
723 "Logical operators must have same type for operands and result!",
726 case Instruction::Shl:
727 case Instruction::LShr:
728 case Instruction::AShr:
729 Assert1(B.getType()->isInteger(),
730 "Shift must return an integer result!", &B);
731 Assert1(B.getType() == B.getOperand(0)->getType(),
732 "Shift return type must be same as operands!", &B);
735 // Arithmetic operators only work on integer or fp values
736 Assert1(B.getType() == B.getOperand(0)->getType(),
737 "Arithmetic operators must have same type for operands and result!",
739 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
740 isa<PackedType>(B.getType()),
741 "Arithmetic operators must have integer, fp, or packed type!", &B);
748 void Verifier::visitICmpInst(ICmpInst& IC) {
749 // Check that the operands are the same type
750 const Type* Op0Ty = IC.getOperand(0)->getType();
751 const Type* Op1Ty = IC.getOperand(1)->getType();
752 Assert1(Op0Ty == Op1Ty,
753 "Both operands to ICmp instruction are not of the same type!", &IC);
754 // Check that the operands are the right type
755 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
756 "Invalid operand types for ICmp instruction", &IC);
757 visitInstruction(IC);
760 void Verifier::visitFCmpInst(FCmpInst& FC) {
761 // Check that the operands are the same type
762 const Type* Op0Ty = FC.getOperand(0)->getType();
763 const Type* Op1Ty = FC.getOperand(1)->getType();
764 Assert1(Op0Ty == Op1Ty,
765 "Both operands to FCmp instruction are not of the same type!", &FC);
766 // Check that the operands are the right type
767 Assert1(Op0Ty->isFloatingPoint(),
768 "Invalid operand types for FCmp instruction", &FC);
769 visitInstruction(FC);
772 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
773 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
775 "Invalid extractelement operands!", &EI);
776 visitInstruction(EI);
779 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
780 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
783 "Invalid insertelement operands!", &IE);
784 visitInstruction(IE);
787 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
788 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
790 "Invalid shufflevector operands!", &SV);
791 Assert1(SV.getType() == SV.getOperand(0)->getType(),
792 "Result of shufflevector must match first operand type!", &SV);
794 // Check to see if Mask is valid.
795 if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
796 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
797 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
798 isa<UndefValue>(MV->getOperand(i)),
799 "Invalid shufflevector shuffle mask!", &SV);
802 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
803 isa<ConstantAggregateZero>(SV.getOperand(2)),
804 "Invalid shufflevector shuffle mask!", &SV);
807 visitInstruction(SV);
810 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
812 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
813 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
814 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
815 Assert2(PointerType::get(ElTy) == GEP.getType(),
816 "GEP is not of right type for indices!", &GEP, ElTy);
817 visitInstruction(GEP);
820 void Verifier::visitLoadInst(LoadInst &LI) {
822 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
823 Assert2(ElTy == LI.getType(),
824 "Load result type does not match pointer operand type!", &LI, ElTy);
825 visitInstruction(LI);
828 void Verifier::visitStoreInst(StoreInst &SI) {
830 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
831 Assert2(ElTy == SI.getOperand(0)->getType(),
832 "Stored value type does not match pointer operand type!", &SI, ElTy);
833 visitInstruction(SI);
837 /// verifyInstruction - Verify that an instruction is well formed.
839 void Verifier::visitInstruction(Instruction &I) {
840 BasicBlock *BB = I.getParent();
841 Assert1(BB, "Instruction not embedded in basic block!", &I);
843 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
844 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
846 Assert1(*UI != (User*)&I ||
847 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
848 "Only PHI nodes may reference their own value!", &I);
851 // Check that void typed values don't have names
852 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
853 "Instruction has a name, but provides a void value!", &I);
855 // Check that the return value of the instruction is either void or a legal
857 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
858 "Instruction returns a non-scalar type!", &I);
860 // Check that all uses of the instruction, if they are instructions
861 // themselves, actually have parent basic blocks. If the use is not an
862 // instruction, it is an error!
863 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
865 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
867 Instruction *Used = cast<Instruction>(*UI);
868 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
869 " embeded in a basic block!", &I, Used);
872 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
873 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
875 // Check to make sure that only first-class-values are operands to
877 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
878 "Instruction operands must be first-class values!", &I);
880 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
881 // Check to make sure that the "address of" an intrinsic function is never
883 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
884 "Cannot take the address of an intrinsic!", &I);
885 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
886 Assert1(OpBB->getParent() == BB->getParent(),
887 "Referring to a basic block in another function!", &I);
888 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
889 Assert1(OpArg->getParent() == BB->getParent(),
890 "Referring to an argument in another function!", &I);
891 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
892 BasicBlock *OpBlock = Op->getParent();
894 // Check that a definition dominates all of its uses.
895 if (!isa<PHINode>(I)) {
896 // Invoke results are only usable in the normal destination, not in the
897 // exceptional destination.
898 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
899 OpBlock = II->getNormalDest();
901 Assert2(OpBlock != II->getUnwindDest(),
902 "No uses of invoke possible due to dominance structure!",
905 // If the normal successor of an invoke instruction has multiple
906 // predecessors, then the normal edge from the invoke is critical, so
907 // the invoke value can only be live if the destination block
908 // dominates all of it's predecessors (other than the invoke) or if
909 // the invoke value is only used by a phi in the successor.
910 if (!OpBlock->getSinglePredecessor() &&
911 EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
912 // The first case we allow is if the use is a PHI operand in the
913 // normal block, and if that PHI operand corresponds to the invoke's
916 if (PHINode *PN = dyn_cast<PHINode>(&I))
917 if (PN->getParent() == OpBlock &&
918 PN->getIncomingBlock(i/2) == Op->getParent())
921 // If it is used by something non-phi, then the other case is that
922 // 'OpBlock' dominates all of its predecessors other than the
923 // invoke. In this case, the invoke value can still be used.
926 for (pred_iterator PI = pred_begin(OpBlock),
927 E = pred_end(OpBlock); PI != E; ++PI) {
928 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
935 "Invoke value defined on critical edge but not dead!", &I,
938 } else if (OpBlock == BB) {
939 // If they are in the same basic block, make sure that the definition
940 // comes before the use.
941 Assert2(InstsInThisBlock.count(Op) ||
942 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
943 "Instruction does not dominate all uses!", Op, &I);
946 // Definition must dominate use unless use is unreachable!
947 Assert2(EF->dominates(OpBlock, BB) ||
948 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
949 "Instruction does not dominate all uses!", Op, &I);
951 // PHI nodes are more difficult than other nodes because they actually
952 // "use" the value in the predecessor basic blocks they correspond to.
953 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
954 Assert2(EF->dominates(OpBlock, PredBB) ||
955 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
956 "Instruction does not dominate all uses!", Op, &I);
958 } else if (isa<InlineAsm>(I.getOperand(i))) {
959 Assert1(i == 0 && isa<CallInst>(I),
960 "Cannot take the address of an inline asm!", &I);
963 InstsInThisBlock.insert(&I);
966 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
968 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
969 Function *IF = CI.getCalledFunction();
970 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!", IF);
972 #define GET_INTRINSIC_VERIFIER
973 #include "llvm/Intrinsics.gen"
974 #undef GET_INTRINSIC_VERIFIER
977 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
978 /// Intrinsics.gen. This implements a little state machine that verifies the
979 /// prototype of intrinsics.
980 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
984 const FunctionType *FTy = F->getFunctionType();
986 // Note that "arg#0" is the return type.
987 for (unsigned ArgNo = 0; 1; ++ArgNo) {
988 int TypeID = va_arg(VA, int);
991 if (ArgNo != FTy->getNumParams()+1)
992 CheckFailed("Intrinsic prototype has too many arguments!", F);
996 if (ArgNo == FTy->getNumParams()+1) {
997 CheckFailed("Intrinsic prototype has too few arguments!", F);
1003 Ty = FTy->getReturnType();
1005 Ty = FTy->getParamType(ArgNo-1);
1007 if (TypeID != Ty->getTypeID()) {
1009 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1011 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1015 if (TypeID == Type::IntegerTyID) {
1016 unsigned GotBits = (unsigned) va_arg(VA, int);
1017 unsigned ExpectBits = cast<IntegerType>(Ty)->getBitWidth();
1018 if (GotBits != ExpectBits) {
1019 std::string bitmsg = " Expecting " + utostr(ExpectBits) + " but got " +
1020 utostr(GotBits) + " bits.";
1022 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1025 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1026 "incorrect integer width!" + bitmsg, F);
1029 } else if (TypeID == Type::PackedTyID) {
1030 // If this is a packed argument, verify the number and type of elements.
1031 const PackedType *PTy = cast<PackedType>(Ty);
1032 int ElemTy = va_arg(VA, int);
1033 if (ElemTy != PTy->getElementType()->getTypeID()) {
1034 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1038 if (ElemTy == Type::IntegerTyID) {
1039 unsigned NumBits = (unsigned)va_arg(VA, int);
1040 unsigned ExpectedBits =
1041 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1042 if (NumBits != ExpectedBits) {
1043 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1048 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1049 CheckFailed("Intrinsic prototype has incorrect number of "
1050 "vector elements!",F);
1060 //===----------------------------------------------------------------------===//
1061 // Implement the public interfaces to this file...
1062 //===----------------------------------------------------------------------===//
1064 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1065 return new Verifier(action);
1069 // verifyFunction - Create
1070 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1071 Function &F = const_cast<Function&>(f);
1072 assert(!F.isDeclaration() && "Cannot verify external functions");
1074 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1075 Verifier *V = new Verifier(action);
1081 /// verifyModule - Check a module for errors, printing messages on stderr.
1082 /// Return true if the module is corrupt.
1084 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1085 std::string *ErrorInfo) {
1087 Verifier *V = new Verifier(action);
1091 if (ErrorInfo && V->Broken)
1092 *ErrorInfo = V->msgs.str();