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/SmallPtrSet.h"
60 #include "llvm/ADT/SmallVector.h"
61 #include "llvm/ADT/StringExtras.h"
62 #include "llvm/ADT/STLExtras.h"
63 #include "llvm/Support/Compiler.h"
69 namespace { // Anonymous namespace for class
71 struct VISIBILITY_HIDDEN
72 Verifier : public FunctionPass, InstVisitor<Verifier> {
73 bool Broken; // Is this module found to be broken?
74 bool RealPass; // Are we not being run by a PassManager?
75 VerifierFailureAction action;
76 // What to do if verification fails.
77 Module *Mod; // Module we are verifying right now
78 ETForest *EF; // ET-Forest, caution can be null!
79 std::stringstream msgs; // A stringstream to collect messages
81 /// InstInThisBlock - when verifying a basic block, keep track of all of the
82 /// instructions we have seen so far. This allows us to do efficient
83 /// dominance checks for the case when an instruction has an operand that is
84 /// an instruction in the same block.
85 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
88 : Broken(false), RealPass(true), action(AbortProcessAction),
89 EF(0), msgs( std::ios::app | std::ios::out ) {}
90 Verifier( VerifierFailureAction ctn )
91 : Broken(false), RealPass(true), action(ctn), EF(0),
92 msgs( std::ios::app | std::ios::out ) {}
94 : Broken(false), RealPass(true),
95 action( AB ? AbortProcessAction : PrintMessageAction), EF(0),
96 msgs( std::ios::app | std::ios::out ) {}
97 Verifier(ETForest &ef)
98 : Broken(false), RealPass(false), action(PrintMessageAction),
99 EF(&ef), msgs( std::ios::app | std::ios::out ) {}
102 bool doInitialization(Module &M) {
104 verifyTypeSymbolTable(M.getTypeSymbolTable());
105 verifyValueSymbolTable(M.getValueSymbolTable());
107 // If this is a real pass, in a pass manager, we must abort before
108 // returning back to the pass manager, or else the pass manager may try to
109 // run other passes on the broken module.
111 return abortIfBroken();
115 bool runOnFunction(Function &F) {
116 // Get dominator information if we are being run by PassManager
117 if (RealPass) EF = &getAnalysis<ETForest>();
120 InstsInThisBlock.clear();
122 // If this is a real pass, in a pass manager, we must abort before
123 // returning back to the pass manager, or else the pass manager may try to
124 // run other passes on the broken module.
126 return abortIfBroken();
131 bool doFinalization(Module &M) {
132 // Scan through, checking all of the external function's linkage now...
133 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
134 visitGlobalValue(*I);
136 // Check to make sure function prototypes are okay.
137 if (I->isDeclaration()) visitFunction(*I);
140 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
142 visitGlobalVariable(*I);
144 // If the module is broken, abort at this time.
145 return abortIfBroken();
148 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
149 AU.setPreservesAll();
151 AU.addRequired<ETForest>();
154 /// abortIfBroken - If the module is broken and we are supposed to abort on
155 /// this condition, do so.
157 bool abortIfBroken() {
159 msgs << "Broken module found, ";
161 case AbortProcessAction:
162 msgs << "compilation aborted!\n";
165 case PrintMessageAction:
166 msgs << "verification continues.\n";
169 case ReturnStatusAction:
170 msgs << "compilation terminated.\n";
178 // Verification methods...
179 void verifyTypeSymbolTable(TypeSymbolTable &ST);
180 void verifyValueSymbolTable(ValueSymbolTable &ST);
181 void visitGlobalValue(GlobalValue &GV);
182 void visitGlobalVariable(GlobalVariable &GV);
183 void visitFunction(Function &F);
184 void visitBasicBlock(BasicBlock &BB);
185 void visitTruncInst(TruncInst &I);
186 void visitZExtInst(ZExtInst &I);
187 void visitSExtInst(SExtInst &I);
188 void visitFPTruncInst(FPTruncInst &I);
189 void visitFPExtInst(FPExtInst &I);
190 void visitFPToUIInst(FPToUIInst &I);
191 void visitFPToSIInst(FPToSIInst &I);
192 void visitUIToFPInst(UIToFPInst &I);
193 void visitSIToFPInst(SIToFPInst &I);
194 void visitIntToPtrInst(IntToPtrInst &I);
195 void visitPtrToIntInst(PtrToIntInst &I);
196 void visitBitCastInst(BitCastInst &I);
197 void visitPHINode(PHINode &PN);
198 void visitBinaryOperator(BinaryOperator &B);
199 void visitICmpInst(ICmpInst &IC);
200 void visitFCmpInst(FCmpInst &FC);
201 void visitExtractElementInst(ExtractElementInst &EI);
202 void visitInsertElementInst(InsertElementInst &EI);
203 void visitShuffleVectorInst(ShuffleVectorInst &EI);
204 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
205 void visitCallInst(CallInst &CI);
206 void visitGetElementPtrInst(GetElementPtrInst &GEP);
207 void visitLoadInst(LoadInst &LI);
208 void visitStoreInst(StoreInst &SI);
209 void visitInstruction(Instruction &I);
210 void visitTerminatorInst(TerminatorInst &I);
211 void visitReturnInst(ReturnInst &RI);
212 void visitSwitchInst(SwitchInst &SI);
213 void visitSelectInst(SelectInst &SI);
214 void visitUserOp1(Instruction &I);
215 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
216 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
218 void VerifyIntrinsicPrototype(Function *F, ...);
220 void WriteValue(const Value *V) {
222 if (isa<Instruction>(V)) {
225 WriteAsOperand(msgs, V, true, Mod);
230 void WriteType(const Type* T ) {
232 WriteTypeSymbolic(msgs, T, Mod );
236 // CheckFailed - A check failed, so print out the condition and the message
237 // that failed. This provides a nice place to put a breakpoint if you want
238 // to see why something is not correct.
239 void CheckFailed(const std::string &Message,
240 const Value *V1 = 0, const Value *V2 = 0,
241 const Value *V3 = 0, const Value *V4 = 0) {
242 msgs << Message << "\n";
250 void CheckFailed( const std::string& Message, const Value* V1,
251 const Type* T2, const Value* V3 = 0 ) {
252 msgs << Message << "\n";
260 RegisterPass<Verifier> X("verify", "Module Verifier");
261 } // End anonymous namespace
264 // Assert - We know that cond should be true, if not print an error message.
265 #define Assert(C, M) \
266 do { if (!(C)) { CheckFailed(M); return; } } while (0)
267 #define Assert1(C, M, V1) \
268 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
269 #define Assert2(C, M, V1, V2) \
270 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
271 #define Assert3(C, M, V1, V2, V3) \
272 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
273 #define Assert4(C, M, V1, V2, V3, V4) \
274 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
277 void Verifier::visitGlobalValue(GlobalValue &GV) {
278 Assert1(!GV.isDeclaration() ||
279 GV.hasExternalLinkage() ||
280 GV.hasDLLImportLinkage() ||
281 GV.hasExternalWeakLinkage(),
282 "Global is external, but doesn't have external or dllimport or weak linkage!",
285 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
286 "Global is marked as dllimport, but not external", &GV);
288 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
289 "Only global variables can have appending linkage!", &GV);
291 if (GV.hasAppendingLinkage()) {
292 GlobalVariable &GVar = cast<GlobalVariable>(GV);
293 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
294 "Only global arrays can have appending linkage!", &GV);
298 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
299 if (GV.hasInitializer())
300 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
301 "Global variable initializer type does not match global "
302 "variable type!", &GV);
304 visitGlobalValue(GV);
307 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
310 // verifySymbolTable - Verify that a function or module symbol table is ok
312 void Verifier::verifyValueSymbolTable(ValueSymbolTable &ST) {
314 // Loop over all of the values in the symbol table.
315 for (ValueSymbolTable::const_iterator VI = ST.begin(), VE = ST.end();
317 Value *V = VI->second;
318 // Check that there are no void typed values in the symbol table. Values
319 // with a void type cannot be put into symbol tables because they cannot
321 Assert1(V->getType() != Type::VoidTy,
322 "Values with void type are not allowed to have names!", V);
326 // visitFunction - Verify that a function is ok.
328 void Verifier::visitFunction(Function &F) {
329 // Check function arguments.
330 const FunctionType *FT = F.getFunctionType();
331 unsigned NumArgs = F.getArgumentList().size();
333 Assert2(FT->getNumParams() == NumArgs,
334 "# formal arguments must match # of arguments for function type!",
336 Assert1(F.getReturnType()->isFirstClassType() ||
337 F.getReturnType() == Type::VoidTy,
338 "Functions cannot return aggregate values!", &F);
340 Assert1(!FT->isStructReturn() ||
341 (FT->getReturnType() == Type::VoidTy &&
342 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
343 "Invalid struct-return function!", &F);
345 // Check that this function meets the restrictions on this calling convention.
346 switch (F.getCallingConv()) {
351 case CallingConv::Fast:
352 case CallingConv::Cold:
353 case CallingConv::X86_FastCall:
354 Assert1(!F.isVarArg(),
355 "Varargs functions must have C calling conventions!", &F);
359 // Check that the argument values match the function type for this function...
361 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
363 Assert2(I->getType() == FT->getParamType(i),
364 "Argument value does not match function argument type!",
365 I, FT->getParamType(i));
366 // Make sure no aggregates are passed by value.
367 Assert1(I->getType()->isFirstClassType(),
368 "Functions cannot take aggregates as arguments by value!", I);
371 if (!F.isDeclaration()) {
372 // Verify that this function (which has a body) is not named "llvm.*". It
373 // is not legal to define intrinsics.
374 if (F.getName().size() >= 5)
375 Assert1(F.getName().substr(0, 5) != "llvm.",
376 "llvm intrinsics cannot be defined!", &F);
378 verifyValueSymbolTable(F.getValueSymbolTable());
380 // Check the entry node
381 BasicBlock *Entry = &F.getEntryBlock();
382 Assert1(pred_begin(Entry) == pred_end(Entry),
383 "Entry block to function must not have predecessors!", Entry);
388 // verifyBasicBlock - Verify that a basic block is well formed...
390 void Verifier::visitBasicBlock(BasicBlock &BB) {
391 InstsInThisBlock.clear();
393 // Ensure that basic blocks have terminators!
394 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
396 // Check constraints that this basic block imposes on all of the PHI nodes in
398 if (isa<PHINode>(BB.front())) {
399 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
400 std::sort(Preds.begin(), Preds.end());
402 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
404 // Ensure that PHI nodes have at least one entry!
405 Assert1(PN->getNumIncomingValues() != 0,
406 "PHI nodes must have at least one entry. If the block is dead, "
407 "the PHI should be removed!", PN);
408 Assert1(PN->getNumIncomingValues() == Preds.size(),
409 "PHINode should have one entry for each predecessor of its "
410 "parent basic block!", PN);
412 // Get and sort all incoming values in the PHI node...
413 std::vector<std::pair<BasicBlock*, Value*> > Values;
414 Values.reserve(PN->getNumIncomingValues());
415 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
416 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
417 PN->getIncomingValue(i)));
418 std::sort(Values.begin(), Values.end());
420 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
421 // Check to make sure that if there is more than one entry for a
422 // particular basic block in this PHI node, that the incoming values are
425 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
426 Values[i].second == Values[i-1].second,
427 "PHI node has multiple entries for the same basic block with "
428 "different incoming values!", PN, Values[i].first,
429 Values[i].second, Values[i-1].second);
431 // Check to make sure that the predecessors and PHI node entries are
433 Assert3(Values[i].first == Preds[i],
434 "PHI node entries do not match predecessors!", PN,
435 Values[i].first, Preds[i]);
441 void Verifier::visitTerminatorInst(TerminatorInst &I) {
442 // Ensure that terminators only exist at the end of the basic block.
443 Assert1(&I == I.getParent()->getTerminator(),
444 "Terminator found in the middle of a basic block!", I.getParent());
448 void Verifier::visitReturnInst(ReturnInst &RI) {
449 Function *F = RI.getParent()->getParent();
450 if (RI.getNumOperands() == 0)
451 Assert2(F->getReturnType() == Type::VoidTy,
452 "Found return instr that returns void in Function of non-void "
453 "return type!", &RI, F->getReturnType());
455 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
456 "Function return type does not match operand "
457 "type of return inst!", &RI, F->getReturnType());
459 // Check to make sure that the return value has necessary properties for
461 visitTerminatorInst(RI);
464 void Verifier::visitSwitchInst(SwitchInst &SI) {
465 // Check to make sure that all of the constants in the switch instruction
466 // have the same type as the switched-on value.
467 const Type *SwitchTy = SI.getCondition()->getType();
468 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
469 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
470 "Switch constants must all be same type as switch value!", &SI);
472 visitTerminatorInst(SI);
475 void Verifier::visitSelectInst(SelectInst &SI) {
476 Assert1(SI.getCondition()->getType() == Type::Int1Ty,
477 "Select condition type must be bool!", &SI);
478 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
479 "Select values must have identical types!", &SI);
480 Assert1(SI.getTrueValue()->getType() == SI.getType(),
481 "Select values must have same type as select instruction!", &SI);
482 visitInstruction(SI);
486 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
487 /// a pass, if any exist, it's an error.
489 void Verifier::visitUserOp1(Instruction &I) {
490 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
493 void Verifier::visitTruncInst(TruncInst &I) {
494 // Get the source and destination types
495 const Type *SrcTy = I.getOperand(0)->getType();
496 const Type *DestTy = I.getType();
498 // Get the size of the types in bits, we'll need this later
499 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
500 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
502 Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
503 Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
504 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
509 void Verifier::visitZExtInst(ZExtInst &I) {
510 // Get the source and destination types
511 const Type *SrcTy = I.getOperand(0)->getType();
512 const Type *DestTy = I.getType();
514 // Get the size of the types in bits, we'll need this later
515 Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
516 Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
517 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
518 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
520 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
525 void Verifier::visitSExtInst(SExtInst &I) {
526 // Get the source and destination types
527 const Type *SrcTy = I.getOperand(0)->getType();
528 const Type *DestTy = I.getType();
530 // Get the size of the types in bits, we'll need this later
531 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
532 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
534 Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
535 Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
536 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
541 void Verifier::visitFPTruncInst(FPTruncInst &I) {
542 // Get the source and destination types
543 const Type *SrcTy = I.getOperand(0)->getType();
544 const Type *DestTy = I.getType();
545 // Get the size of the types in bits, we'll need this later
546 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
547 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
549 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
550 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
551 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
556 void Verifier::visitFPExtInst(FPExtInst &I) {
557 // Get the source and destination types
558 const Type *SrcTy = I.getOperand(0)->getType();
559 const Type *DestTy = I.getType();
561 // Get the size of the types in bits, we'll need this later
562 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
563 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
565 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
566 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
567 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
572 void Verifier::visitUIToFPInst(UIToFPInst &I) {
573 // Get the source and destination types
574 const Type *SrcTy = I.getOperand(0)->getType();
575 const Type *DestTy = I.getType();
577 Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
578 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
583 void Verifier::visitSIToFPInst(SIToFPInst &I) {
584 // Get the source and destination types
585 const Type *SrcTy = I.getOperand(0)->getType();
586 const Type *DestTy = I.getType();
588 Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
589 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
594 void Verifier::visitFPToUIInst(FPToUIInst &I) {
595 // Get the source and destination types
596 const Type *SrcTy = I.getOperand(0)->getType();
597 const Type *DestTy = I.getType();
599 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
600 Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
605 void Verifier::visitFPToSIInst(FPToSIInst &I) {
606 // Get the source and destination types
607 const Type *SrcTy = I.getOperand(0)->getType();
608 const Type *DestTy = I.getType();
610 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
611 Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
616 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
617 // Get the source and destination types
618 const Type *SrcTy = I.getOperand(0)->getType();
619 const Type *DestTy = I.getType();
621 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
622 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
627 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
628 // Get the source and destination types
629 const Type *SrcTy = I.getOperand(0)->getType();
630 const Type *DestTy = I.getType();
632 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
633 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
638 void Verifier::visitBitCastInst(BitCastInst &I) {
639 // Get the source and destination types
640 const Type *SrcTy = I.getOperand(0)->getType();
641 const Type *DestTy = I.getType();
643 // Get the size of the types in bits, we'll need this later
644 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
645 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
647 // BitCast implies a no-op cast of type only. No bits change.
648 // However, you can't cast pointers to anything but pointers.
649 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
650 "Bitcast requires both operands to be pointer or neither", &I);
651 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
656 /// visitPHINode - Ensure that a PHI node is well formed.
658 void Verifier::visitPHINode(PHINode &PN) {
659 // Ensure that the PHI nodes are all grouped together at the top of the block.
660 // This can be tested by checking whether the instruction before this is
661 // either nonexistent (because this is begin()) or is a PHI node. If not,
662 // then there is some other instruction before a PHI.
663 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
664 "PHI nodes not grouped at top of basic block!",
665 &PN, PN.getParent());
667 // Check that all of the operands of the PHI node have the same type as the
669 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
670 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
671 "PHI node operands are not the same type as the result!", &PN);
673 // All other PHI node constraints are checked in the visitBasicBlock method.
675 visitInstruction(PN);
678 void Verifier::visitCallInst(CallInst &CI) {
679 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
680 "Called function must be a pointer!", &CI);
681 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
682 Assert1(isa<FunctionType>(FPTy->getElementType()),
683 "Called function is not pointer to function type!", &CI);
685 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
687 // Verify that the correct number of arguments are being passed
689 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
690 "Called function requires more parameters than were provided!",&CI);
692 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
693 "Incorrect number of arguments passed to called function!", &CI);
695 // Verify that all arguments to the call match the function type...
696 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
697 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
698 "Call parameter type does not match function signature!",
699 CI.getOperand(i+1), FTy->getParamType(i), &CI);
701 if (Function *F = CI.getCalledFunction())
702 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
703 visitIntrinsicFunctionCall(ID, CI);
705 visitInstruction(CI);
708 /// visitBinaryOperator - Check that both arguments to the binary operator are
709 /// of the same type!
711 void Verifier::visitBinaryOperator(BinaryOperator &B) {
712 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
713 "Both operands to a binary operator are not of the same type!", &B);
715 switch (B.getOpcode()) {
716 // Check that logical operators are only used with integral operands.
717 case Instruction::And:
718 case Instruction::Or:
719 case Instruction::Xor:
720 Assert1(B.getType()->isInteger() ||
721 (isa<PackedType>(B.getType()) &&
722 cast<PackedType>(B.getType())->getElementType()->isInteger()),
723 "Logical operators only work with integral types!", &B);
724 Assert1(B.getType() == B.getOperand(0)->getType(),
725 "Logical operators must have same type for operands and result!",
728 case Instruction::Shl:
729 case Instruction::LShr:
730 case Instruction::AShr:
731 Assert1(B.getType()->isInteger(),
732 "Shift must return an integer result!", &B);
733 Assert1(B.getType() == B.getOperand(0)->getType(),
734 "Shift return type must be same as operands!", &B);
737 // Arithmetic operators only work on integer or fp values
738 Assert1(B.getType() == B.getOperand(0)->getType(),
739 "Arithmetic operators must have same type for operands and result!",
741 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
742 isa<PackedType>(B.getType()),
743 "Arithmetic operators must have integer, fp, or packed type!", &B);
750 void Verifier::visitICmpInst(ICmpInst& IC) {
751 // Check that the operands are the same type
752 const Type* Op0Ty = IC.getOperand(0)->getType();
753 const Type* Op1Ty = IC.getOperand(1)->getType();
754 Assert1(Op0Ty == Op1Ty,
755 "Both operands to ICmp instruction are not of the same type!", &IC);
756 // Check that the operands are the right type
757 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
758 "Invalid operand types for ICmp instruction", &IC);
759 visitInstruction(IC);
762 void Verifier::visitFCmpInst(FCmpInst& FC) {
763 // Check that the operands are the same type
764 const Type* Op0Ty = FC.getOperand(0)->getType();
765 const Type* Op1Ty = FC.getOperand(1)->getType();
766 Assert1(Op0Ty == Op1Ty,
767 "Both operands to FCmp instruction are not of the same type!", &FC);
768 // Check that the operands are the right type
769 Assert1(Op0Ty->isFloatingPoint(),
770 "Invalid operand types for FCmp instruction", &FC);
771 visitInstruction(FC);
774 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
775 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
777 "Invalid extractelement operands!", &EI);
778 visitInstruction(EI);
781 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
782 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
785 "Invalid insertelement operands!", &IE);
786 visitInstruction(IE);
789 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
790 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
792 "Invalid shufflevector operands!", &SV);
793 Assert1(SV.getType() == SV.getOperand(0)->getType(),
794 "Result of shufflevector must match first operand type!", &SV);
796 // Check to see if Mask is valid.
797 if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
798 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
799 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
800 isa<UndefValue>(MV->getOperand(i)),
801 "Invalid shufflevector shuffle mask!", &SV);
804 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
805 isa<ConstantAggregateZero>(SV.getOperand(2)),
806 "Invalid shufflevector shuffle mask!", &SV);
809 visitInstruction(SV);
812 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
813 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
815 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
816 &Idxs[0], Idxs.size(), true);
817 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
818 Assert2(isa<PointerType>(GEP.getType()) &&
819 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
820 "GEP is not of right type for indices!", &GEP, ElTy);
821 visitInstruction(GEP);
824 void Verifier::visitLoadInst(LoadInst &LI) {
826 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
827 Assert2(ElTy == LI.getType(),
828 "Load result type does not match pointer operand type!", &LI, ElTy);
829 visitInstruction(LI);
832 void Verifier::visitStoreInst(StoreInst &SI) {
834 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
835 Assert2(ElTy == SI.getOperand(0)->getType(),
836 "Stored value type does not match pointer operand type!", &SI, ElTy);
837 visitInstruction(SI);
841 /// verifyInstruction - Verify that an instruction is well formed.
843 void Verifier::visitInstruction(Instruction &I) {
844 BasicBlock *BB = I.getParent();
845 Assert1(BB, "Instruction not embedded in basic block!", &I);
847 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
848 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
850 Assert1(*UI != (User*)&I ||
851 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
852 "Only PHI nodes may reference their own value!", &I);
855 // Check that void typed values don't have names
856 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
857 "Instruction has a name, but provides a void value!", &I);
859 // Check that the return value of the instruction is either void or a legal
861 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
862 "Instruction returns a non-scalar type!", &I);
864 // Check that all uses of the instruction, if they are instructions
865 // themselves, actually have parent basic blocks. If the use is not an
866 // instruction, it is an error!
867 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
869 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
871 Instruction *Used = cast<Instruction>(*UI);
872 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
873 " embeded in a basic block!", &I, Used);
876 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
877 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
879 // Check to make sure that only first-class-values are operands to
881 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
882 "Instruction operands must be first-class values!", &I);
884 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
885 // Check to make sure that the "address of" an intrinsic function is never
887 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
888 "Cannot take the address of an intrinsic!", &I);
889 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
890 Assert1(OpBB->getParent() == BB->getParent(),
891 "Referring to a basic block in another function!", &I);
892 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
893 Assert1(OpArg->getParent() == BB->getParent(),
894 "Referring to an argument in another function!", &I);
895 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
896 BasicBlock *OpBlock = Op->getParent();
898 // Check that a definition dominates all of its uses.
899 if (!isa<PHINode>(I)) {
900 // Invoke results are only usable in the normal destination, not in the
901 // exceptional destination.
902 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
903 OpBlock = II->getNormalDest();
905 Assert2(OpBlock != II->getUnwindDest(),
906 "No uses of invoke possible due to dominance structure!",
909 // If the normal successor of an invoke instruction has multiple
910 // predecessors, then the normal edge from the invoke is critical, so
911 // the invoke value can only be live if the destination block
912 // dominates all of it's predecessors (other than the invoke) or if
913 // the invoke value is only used by a phi in the successor.
914 if (!OpBlock->getSinglePredecessor() &&
915 EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
916 // The first case we allow is if the use is a PHI operand in the
917 // normal block, and if that PHI operand corresponds to the invoke's
920 if (PHINode *PN = dyn_cast<PHINode>(&I))
921 if (PN->getParent() == OpBlock &&
922 PN->getIncomingBlock(i/2) == Op->getParent())
925 // If it is used by something non-phi, then the other case is that
926 // 'OpBlock' dominates all of its predecessors other than the
927 // invoke. In this case, the invoke value can still be used.
930 for (pred_iterator PI = pred_begin(OpBlock),
931 E = pred_end(OpBlock); PI != E; ++PI) {
932 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
939 "Invoke value defined on critical edge but not dead!", &I,
942 } else if (OpBlock == BB) {
943 // If they are in the same basic block, make sure that the definition
944 // comes before the use.
945 Assert2(InstsInThisBlock.count(Op) ||
946 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
947 "Instruction does not dominate all uses!", Op, &I);
950 // Definition must dominate use unless use is unreachable!
951 Assert2(EF->dominates(OpBlock, BB) ||
952 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
953 "Instruction does not dominate all uses!", Op, &I);
955 // PHI nodes are more difficult than other nodes because they actually
956 // "use" the value in the predecessor basic blocks they correspond to.
957 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
958 Assert2(EF->dominates(OpBlock, PredBB) ||
959 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
960 "Instruction does not dominate all uses!", Op, &I);
962 } else if (isa<InlineAsm>(I.getOperand(i))) {
963 Assert1(i == 0 && isa<CallInst>(I),
964 "Cannot take the address of an inline asm!", &I);
967 InstsInThisBlock.insert(&I);
970 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
972 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
973 Function *IF = CI.getCalledFunction();
974 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!", IF);
976 #define GET_INTRINSIC_VERIFIER
977 #include "llvm/Intrinsics.gen"
978 #undef GET_INTRINSIC_VERIFIER
981 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
982 /// Intrinsics.gen. This implements a little state machine that verifies the
983 /// prototype of intrinsics.
984 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
988 const FunctionType *FTy = F->getFunctionType();
990 // Note that "arg#0" is the return type.
991 for (unsigned ArgNo = 0; 1; ++ArgNo) {
992 int TypeID = va_arg(VA, int);
999 if (ArgNo != FTy->getNumParams()+1)
1000 CheckFailed("Intrinsic prototype has too many arguments!", F);
1004 if (ArgNo == FTy->getNumParams()+1) {
1005 CheckFailed("Intrinsic prototype has too few arguments!", F);
1011 Ty = FTy->getReturnType();
1013 Ty = FTy->getParamType(ArgNo-1);
1015 if (TypeID != Ty->getTypeID()) {
1017 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1019 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1023 if (TypeID == Type::IntegerTyID) {
1024 unsigned GotBits = (unsigned) va_arg(VA, int);
1025 unsigned ExpectBits = cast<IntegerType>(Ty)->getBitWidth();
1026 if (GotBits != ExpectBits) {
1027 std::string bitmsg = " Expecting " + utostr(ExpectBits) + " but got " +
1028 utostr(GotBits) + " bits.";
1030 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1033 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1034 "incorrect integer width!" + bitmsg, F);
1037 } else if (TypeID == Type::PackedTyID) {
1038 // If this is a packed argument, verify the number and type of elements.
1039 const PackedType *PTy = cast<PackedType>(Ty);
1040 int ElemTy = va_arg(VA, int);
1041 if (ElemTy != PTy->getElementType()->getTypeID()) {
1042 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1046 if (ElemTy == Type::IntegerTyID) {
1047 unsigned NumBits = (unsigned)va_arg(VA, int);
1048 unsigned ExpectedBits =
1049 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1050 if (NumBits != ExpectedBits) {
1051 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1056 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1057 CheckFailed("Intrinsic prototype has incorrect number of "
1058 "vector elements!",F);
1068 //===----------------------------------------------------------------------===//
1069 // Implement the public interfaces to this file...
1070 //===----------------------------------------------------------------------===//
1072 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1073 return new Verifier(action);
1077 // verifyFunction - Create
1078 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1079 Function &F = const_cast<Function&>(f);
1080 assert(!F.isDeclaration() && "Cannot verify external functions");
1082 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1083 Verifier *V = new Verifier(action);
1089 /// verifyModule - Check a module for errors, printing messages on stderr.
1090 /// Return true if the module is corrupt.
1092 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1093 std::string *ErrorInfo) {
1095 Verifier *V = new Verifier(action);
1099 if (ErrorInfo && V->Broken)
1100 *ErrorInfo = V->msgs.str();