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/SymbolTable.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(SymbolTable &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 visitShiftInst(ShiftInst &SI);
200 void visitExtractElementInst(ExtractElementInst &EI);
201 void visitInsertElementInst(InsertElementInst &EI);
202 void visitShuffleVectorInst(ShuffleVectorInst &EI);
203 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
204 void visitCallInst(CallInst &CI);
205 void visitGetElementPtrInst(GetElementPtrInst &GEP);
206 void visitLoadInst(LoadInst &LI);
207 void visitStoreInst(StoreInst &SI);
208 void visitInstruction(Instruction &I);
209 void visitTerminatorInst(TerminatorInst &I);
210 void visitReturnInst(ReturnInst &RI);
211 void visitSwitchInst(SwitchInst &SI);
212 void visitSelectInst(SelectInst &SI);
213 void visitUserOp1(Instruction &I);
214 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
215 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
217 void VerifyIntrinsicPrototype(Function *F, ...);
219 void WriteValue(const Value *V) {
221 if (isa<Instruction>(V)) {
224 WriteAsOperand(msgs, V, true, Mod);
229 void WriteType(const Type* T ) {
231 WriteTypeSymbolic(msgs, T, Mod );
235 // CheckFailed - A check failed, so print out the condition and the message
236 // that failed. This provides a nice place to put a breakpoint if you want
237 // to see why something is not correct.
238 void CheckFailed(const std::string &Message,
239 const Value *V1 = 0, const Value *V2 = 0,
240 const Value *V3 = 0, const Value *V4 = 0) {
241 msgs << Message << "\n";
249 void CheckFailed( const std::string& Message, const Value* V1,
250 const Type* T2, const Value* V3 = 0 ) {
251 msgs << Message << "\n";
259 RegisterPass<Verifier> X("verify", "Module Verifier");
260 } // End anonymous namespace
263 // Assert - We know that cond should be true, if not print an error message.
264 #define Assert(C, M) \
265 do { if (!(C)) { CheckFailed(M); return; } } while (0)
266 #define Assert1(C, M, V1) \
267 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
268 #define Assert2(C, M, V1, V2) \
269 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
270 #define Assert3(C, M, V1, V2, V3) \
271 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
272 #define Assert4(C, M, V1, V2, V3, V4) \
273 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
276 void Verifier::visitGlobalValue(GlobalValue &GV) {
277 Assert1(!GV.isDeclaration() ||
278 GV.hasExternalLinkage() ||
279 GV.hasDLLImportLinkage() ||
280 GV.hasExternalWeakLinkage(),
281 "Global is external, but doesn't have external or dllimport or weak linkage!",
284 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
285 "Global is marked as dllimport, but not external", &GV);
287 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
288 "Only global variables can have appending linkage!", &GV);
290 if (GV.hasAppendingLinkage()) {
291 GlobalVariable &GVar = cast<GlobalVariable>(GV);
292 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
293 "Only global arrays can have appending linkage!", &GV);
297 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
298 if (GV.hasInitializer())
299 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
300 "Global variable initializer type does not match global "
301 "variable type!", &GV);
303 visitGlobalValue(GV);
306 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
309 // verifySymbolTable - Verify that a function or module symbol table is ok
311 void Verifier::verifyValueSymbolTable(SymbolTable &ST) {
313 // Loop over all of the values in all type planes in the symbol table.
314 for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
315 PE = ST.plane_end(); PI != PE; ++PI)
316 for (SymbolTable::value_const_iterator VI = PI->second.begin(),
317 VE = PI->second.end(); VI != VE; ++VI) {
318 Value *V = VI->second;
319 // Check that there are no void typed values in the symbol table. Values
320 // with a void type cannot be put into symbol tables because they cannot
322 Assert1(V->getType() != Type::VoidTy,
323 "Values with void type are not allowed to have names!", V);
327 // visitFunction - Verify that a function is ok.
329 void Verifier::visitFunction(Function &F) {
330 // Check function arguments.
331 const FunctionType *FT = F.getFunctionType();
332 unsigned NumArgs = F.getArgumentList().size();
334 Assert2(FT->getNumParams() == NumArgs,
335 "# formal arguments must match # of arguments for function type!",
337 Assert1(F.getReturnType()->isFirstClassType() ||
338 F.getReturnType() == Type::VoidTy,
339 "Functions cannot return aggregate values!", &F);
341 Assert1(!FT->isStructReturn() ||
342 (FT->getReturnType() == Type::VoidTy &&
343 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
344 "Invalid struct-return function!", &F);
346 // Check that this function meets the restrictions on this calling convention.
347 switch (F.getCallingConv()) {
352 case CallingConv::Fast:
353 case CallingConv::Cold:
354 case CallingConv::X86_FastCall:
355 Assert1(!F.isVarArg(),
356 "Varargs functions must have C calling conventions!", &F);
360 // Check that the argument values match the function type for this function...
362 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
364 Assert2(I->getType() == FT->getParamType(i),
365 "Argument value does not match function argument type!",
366 I, FT->getParamType(i));
367 // Make sure no aggregates are passed by value.
368 Assert1(I->getType()->isFirstClassType(),
369 "Functions cannot take aggregates as arguments by value!", I);
372 if (!F.isDeclaration()) {
373 // Verify that this function (which has a body) is not named "llvm.*". It
374 // is not legal to define intrinsics.
375 if (F.getName().size() >= 5)
376 Assert1(F.getName().substr(0, 5) != "llvm.",
377 "llvm intrinsics cannot be defined!", &F);
379 verifyValueSymbolTable(F.getValueSymbolTable());
381 // Check the entry node
382 BasicBlock *Entry = &F.getEntryBlock();
383 Assert1(pred_begin(Entry) == pred_end(Entry),
384 "Entry block to function must not have predecessors!", Entry);
389 // verifyBasicBlock - Verify that a basic block is well formed...
391 void Verifier::visitBasicBlock(BasicBlock &BB) {
392 InstsInThisBlock.clear();
394 // Ensure that basic blocks have terminators!
395 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
397 // Check constraints that this basic block imposes on all of the PHI nodes in
399 if (isa<PHINode>(BB.front())) {
400 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
401 std::sort(Preds.begin(), Preds.end());
403 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
405 // Ensure that PHI nodes have at least one entry!
406 Assert1(PN->getNumIncomingValues() != 0,
407 "PHI nodes must have at least one entry. If the block is dead, "
408 "the PHI should be removed!", PN);
409 Assert1(PN->getNumIncomingValues() == Preds.size(),
410 "PHINode should have one entry for each predecessor of its "
411 "parent basic block!", PN);
413 // Get and sort all incoming values in the PHI node...
414 std::vector<std::pair<BasicBlock*, Value*> > Values;
415 Values.reserve(PN->getNumIncomingValues());
416 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
417 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
418 PN->getIncomingValue(i)));
419 std::sort(Values.begin(), Values.end());
421 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
422 // Check to make sure that if there is more than one entry for a
423 // particular basic block in this PHI node, that the incoming values are
426 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
427 Values[i].second == Values[i-1].second,
428 "PHI node has multiple entries for the same basic block with "
429 "different incoming values!", PN, Values[i].first,
430 Values[i].second, Values[i-1].second);
432 // Check to make sure that the predecessors and PHI node entries are
434 Assert3(Values[i].first == Preds[i],
435 "PHI node entries do not match predecessors!", PN,
436 Values[i].first, Preds[i]);
442 void Verifier::visitTerminatorInst(TerminatorInst &I) {
443 // Ensure that terminators only exist at the end of the basic block.
444 Assert1(&I == I.getParent()->getTerminator(),
445 "Terminator found in the middle of a basic block!", I.getParent());
449 void Verifier::visitReturnInst(ReturnInst &RI) {
450 Function *F = RI.getParent()->getParent();
451 if (RI.getNumOperands() == 0)
452 Assert2(F->getReturnType() == Type::VoidTy,
453 "Found return instr that returns void in Function of non-void "
454 "return type!", &RI, F->getReturnType());
456 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
457 "Function return type does not match operand "
458 "type of return inst!", &RI, F->getReturnType());
460 // Check to make sure that the return value has necessary properties for
462 visitTerminatorInst(RI);
465 void Verifier::visitSwitchInst(SwitchInst &SI) {
466 // Check to make sure that all of the constants in the switch instruction
467 // have the same type as the switched-on value.
468 const Type *SwitchTy = SI.getCondition()->getType();
469 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
470 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
471 "Switch constants must all be same type as switch value!", &SI);
473 visitTerminatorInst(SI);
476 void Verifier::visitSelectInst(SelectInst &SI) {
477 Assert1(SI.getCondition()->getType() == Type::Int1Ty,
478 "Select condition type must be bool!", &SI);
479 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
480 "Select values must have identical types!", &SI);
481 Assert1(SI.getTrueValue()->getType() == SI.getType(),
482 "Select values must have same type as select instruction!", &SI);
483 visitInstruction(SI);
487 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
488 /// a pass, if any exist, it's an error.
490 void Verifier::visitUserOp1(Instruction &I) {
491 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
494 void Verifier::visitTruncInst(TruncInst &I) {
495 // Get the source and destination types
496 const Type *SrcTy = I.getOperand(0)->getType();
497 const Type *DestTy = I.getType();
499 // Get the size of the types in bits, we'll need this later
500 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
501 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
503 Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
504 Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
505 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
510 void Verifier::visitZExtInst(ZExtInst &I) {
511 // Get the source and destination types
512 const Type *SrcTy = I.getOperand(0)->getType();
513 const Type *DestTy = I.getType();
515 // Get the size of the types in bits, we'll need this later
516 Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
517 Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
518 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
519 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
521 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
526 void Verifier::visitSExtInst(SExtInst &I) {
527 // Get the source and destination types
528 const Type *SrcTy = I.getOperand(0)->getType();
529 const Type *DestTy = I.getType();
531 // Get the size of the types in bits, we'll need this later
532 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
533 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
535 Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
536 Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
537 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
542 void Verifier::visitFPTruncInst(FPTruncInst &I) {
543 // Get the source and destination types
544 const Type *SrcTy = I.getOperand(0)->getType();
545 const Type *DestTy = I.getType();
546 // Get the size of the types in bits, we'll need this later
547 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
548 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
550 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
551 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
552 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
557 void Verifier::visitFPExtInst(FPExtInst &I) {
558 // Get the source and destination types
559 const Type *SrcTy = I.getOperand(0)->getType();
560 const Type *DestTy = I.getType();
562 // Get the size of the types in bits, we'll need this later
563 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
564 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
566 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
567 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
568 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
573 void Verifier::visitUIToFPInst(UIToFPInst &I) {
574 // Get the source and destination types
575 const Type *SrcTy = I.getOperand(0)->getType();
576 const Type *DestTy = I.getType();
578 Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
579 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
584 void Verifier::visitSIToFPInst(SIToFPInst &I) {
585 // Get the source and destination types
586 const Type *SrcTy = I.getOperand(0)->getType();
587 const Type *DestTy = I.getType();
589 Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
590 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
595 void Verifier::visitFPToUIInst(FPToUIInst &I) {
596 // Get the source and destination types
597 const Type *SrcTy = I.getOperand(0)->getType();
598 const Type *DestTy = I.getType();
600 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
601 Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
606 void Verifier::visitFPToSIInst(FPToSIInst &I) {
607 // Get the source and destination types
608 const Type *SrcTy = I.getOperand(0)->getType();
609 const Type *DestTy = I.getType();
611 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
612 Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
617 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
618 // Get the source and destination types
619 const Type *SrcTy = I.getOperand(0)->getType();
620 const Type *DestTy = I.getType();
622 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
623 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
628 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
629 // Get the source and destination types
630 const Type *SrcTy = I.getOperand(0)->getType();
631 const Type *DestTy = I.getType();
633 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
634 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
639 void Verifier::visitBitCastInst(BitCastInst &I) {
640 // Get the source and destination types
641 const Type *SrcTy = I.getOperand(0)->getType();
642 const Type *DestTy = I.getType();
644 // Get the size of the types in bits, we'll need this later
645 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
646 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
648 // BitCast implies a no-op cast of type only. No bits change.
649 // However, you can't cast pointers to anything but pointers.
650 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
651 "Bitcast requires both operands to be pointer or neither", &I);
652 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
657 /// visitPHINode - Ensure that a PHI node is well formed.
659 void Verifier::visitPHINode(PHINode &PN) {
660 // Ensure that the PHI nodes are all grouped together at the top of the block.
661 // This can be tested by checking whether the instruction before this is
662 // either nonexistent (because this is begin()) or is a PHI node. If not,
663 // then there is some other instruction before a PHI.
664 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
665 "PHI nodes not grouped at top of basic block!",
666 &PN, PN.getParent());
668 // Check that all of the operands of the PHI node have the same type as the
670 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
671 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
672 "PHI node operands are not the same type as the result!", &PN);
674 // All other PHI node constraints are checked in the visitBasicBlock method.
676 visitInstruction(PN);
679 void Verifier::visitCallInst(CallInst &CI) {
680 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
681 "Called function must be a pointer!", &CI);
682 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
683 Assert1(isa<FunctionType>(FPTy->getElementType()),
684 "Called function is not pointer to function type!", &CI);
686 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
688 // Verify that the correct number of arguments are being passed
690 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
691 "Called function requires more parameters than were provided!",&CI);
693 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
694 "Incorrect number of arguments passed to called function!", &CI);
696 // Verify that all arguments to the call match the function type...
697 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
698 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
699 "Call parameter type does not match function signature!",
700 CI.getOperand(i+1), FTy->getParamType(i), &CI);
702 if (Function *F = CI.getCalledFunction())
703 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
704 visitIntrinsicFunctionCall(ID, CI);
706 visitInstruction(CI);
709 /// visitBinaryOperator - Check that both arguments to the binary operator are
710 /// of the same type!
712 void Verifier::visitBinaryOperator(BinaryOperator &B) {
713 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
714 "Both operands to a binary operator are not of the same type!", &B);
716 // Check that logical operators are only used with integral operands.
717 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
718 B.getOpcode() == Instruction::Xor) {
719 Assert1(B.getType()->isInteger() ||
720 (isa<PackedType>(B.getType()) &&
721 cast<PackedType>(B.getType())->getElementType()->isInteger()),
722 "Logical operators only work with integral types!", &B);
723 Assert1(B.getType() == B.getOperand(0)->getType(),
724 "Logical operators must have same type for operands and result!",
727 // Arithmetic operators only work on integer or fp values
728 Assert1(B.getType() == B.getOperand(0)->getType(),
729 "Arithmetic operators must have same type for operands and result!",
731 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
732 isa<PackedType>(B.getType()),
733 "Arithmetic operators must have integer, fp, or packed type!", &B);
739 void Verifier::visitICmpInst(ICmpInst& IC) {
740 // Check that the operands are the same type
741 const Type* Op0Ty = IC.getOperand(0)->getType();
742 const Type* Op1Ty = IC.getOperand(1)->getType();
743 Assert1(Op0Ty == Op1Ty,
744 "Both operands to ICmp instruction are not of the same type!", &IC);
745 // Check that the operands are the right type
746 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
747 "Invalid operand types for ICmp instruction", &IC);
748 visitInstruction(IC);
751 void Verifier::visitFCmpInst(FCmpInst& FC) {
752 // Check that the operands are the same type
753 const Type* Op0Ty = FC.getOperand(0)->getType();
754 const Type* Op1Ty = FC.getOperand(1)->getType();
755 Assert1(Op0Ty == Op1Ty,
756 "Both operands to FCmp instruction are not of the same type!", &FC);
757 // Check that the operands are the right type
758 Assert1(Op0Ty->isFloatingPoint(),
759 "Invalid operand types for FCmp instruction", &FC);
760 visitInstruction(FC);
763 void Verifier::visitShiftInst(ShiftInst &SI) {
764 Assert1(SI.getType()->isInteger(),
765 "Shift must return an integer result!", &SI);
766 Assert1(SI.getType() == SI.getOperand(0)->getType(),
767 "Shift return type must be same as first operand!", &SI);
768 Assert1(SI.getOperand(1)->getType() == Type::Int8Ty,
769 "Second operand to shift must be ubyte type!", &SI);
770 visitInstruction(SI);
773 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
774 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
776 "Invalid extractelement operands!", &EI);
777 visitInstruction(EI);
780 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
781 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
784 "Invalid insertelement operands!", &IE);
785 visitInstruction(IE);
788 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
789 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
791 "Invalid shufflevector operands!", &SV);
792 Assert1(SV.getType() == SV.getOperand(0)->getType(),
793 "Result of shufflevector must match first operand type!", &SV);
795 // Check to see if Mask is valid.
796 if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
797 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
798 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
799 isa<UndefValue>(MV->getOperand(i)),
800 "Invalid shufflevector shuffle mask!", &SV);
803 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
804 isa<ConstantAggregateZero>(SV.getOperand(2)),
805 "Invalid shufflevector shuffle mask!", &SV);
808 visitInstruction(SV);
811 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
813 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
814 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
815 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
816 Assert2(PointerType::get(ElTy) == GEP.getType(),
817 "GEP is not of right type for indices!", &GEP, ElTy);
818 visitInstruction(GEP);
821 void Verifier::visitLoadInst(LoadInst &LI) {
823 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
824 Assert2(ElTy == LI.getType(),
825 "Load result type does not match pointer operand type!", &LI, ElTy);
826 visitInstruction(LI);
829 void Verifier::visitStoreInst(StoreInst &SI) {
831 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
832 Assert2(ElTy == SI.getOperand(0)->getType(),
833 "Stored value type does not match pointer operand type!", &SI, ElTy);
834 visitInstruction(SI);
838 /// verifyInstruction - Verify that an instruction is well formed.
840 void Verifier::visitInstruction(Instruction &I) {
841 BasicBlock *BB = I.getParent();
842 Assert1(BB, "Instruction not embedded in basic block!", &I);
844 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
845 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
847 Assert1(*UI != (User*)&I ||
848 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
849 "Only PHI nodes may reference their own value!", &I);
852 // Check that void typed values don't have names
853 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
854 "Instruction has a name, but provides a void value!", &I);
856 // Check that the return value of the instruction is either void or a legal
858 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
859 "Instruction returns a non-scalar type!", &I);
861 // Check that all uses of the instruction, if they are instructions
862 // themselves, actually have parent basic blocks. If the use is not an
863 // instruction, it is an error!
864 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
866 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
868 Instruction *Used = cast<Instruction>(*UI);
869 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
870 " embeded in a basic block!", &I, Used);
873 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
874 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
876 // Check to make sure that only first-class-values are operands to
878 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
879 "Instruction operands must be first-class values!", &I);
881 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
882 // Check to make sure that the "address of" an intrinsic function is never
884 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
885 "Cannot take the address of an intrinsic!", &I);
886 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
887 Assert1(OpBB->getParent() == BB->getParent(),
888 "Referring to a basic block in another function!", &I);
889 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
890 Assert1(OpArg->getParent() == BB->getParent(),
891 "Referring to an argument in another function!", &I);
892 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
893 BasicBlock *OpBlock = Op->getParent();
895 // Check that a definition dominates all of its uses.
896 if (!isa<PHINode>(I)) {
897 // Invoke results are only usable in the normal destination, not in the
898 // exceptional destination.
899 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
900 OpBlock = II->getNormalDest();
902 Assert2(OpBlock != II->getUnwindDest(),
903 "No uses of invoke possible due to dominance structure!",
906 // If the normal successor of an invoke instruction has multiple
907 // predecessors, then the normal edge from the invoke is critical, so
908 // the invoke value can only be live if the destination block
909 // dominates all of it's predecessors (other than the invoke) or if
910 // the invoke value is only used by a phi in the successor.
911 if (!OpBlock->getSinglePredecessor() &&
912 EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
913 // The first case we allow is if the use is a PHI operand in the
914 // normal block, and if that PHI operand corresponds to the invoke's
917 if (PHINode *PN = dyn_cast<PHINode>(&I))
918 if (PN->getParent() == OpBlock &&
919 PN->getIncomingBlock(i/2) == Op->getParent())
922 // If it is used by something non-phi, then the other case is that
923 // 'OpBlock' dominates all of its predecessors other than the
924 // invoke. In this case, the invoke value can still be used.
927 for (pred_iterator PI = pred_begin(OpBlock),
928 E = pred_end(OpBlock); PI != E; ++PI) {
929 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
936 "Invoke value defined on critical edge but not dead!", &I,
939 } else if (OpBlock == BB) {
940 // If they are in the same basic block, make sure that the definition
941 // comes before the use.
942 Assert2(InstsInThisBlock.count(Op) ||
943 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
944 "Instruction does not dominate all uses!", Op, &I);
947 // Definition must dominate use unless use is unreachable!
948 Assert2(EF->dominates(OpBlock, BB) ||
949 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
950 "Instruction does not dominate all uses!", Op, &I);
952 // PHI nodes are more difficult than other nodes because they actually
953 // "use" the value in the predecessor basic blocks they correspond to.
954 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
955 Assert2(EF->dominates(OpBlock, PredBB) ||
956 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
957 "Instruction does not dominate all uses!", Op, &I);
959 } else if (isa<InlineAsm>(I.getOperand(i))) {
960 Assert1(i == 0 && isa<CallInst>(I),
961 "Cannot take the address of an inline asm!", &I);
964 InstsInThisBlock.insert(&I);
967 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
969 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
970 Function *IF = CI.getCalledFunction();
971 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!", IF);
973 #define GET_INTRINSIC_VERIFIER
974 #include "llvm/Intrinsics.gen"
975 #undef GET_INTRINSIC_VERIFIER
978 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
979 /// Intrinsics.gen. This implements a little state machine that verifies the
980 /// prototype of intrinsics.
981 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
985 const FunctionType *FTy = F->getFunctionType();
987 // Note that "arg#0" is the return type.
988 for (unsigned ArgNo = 0; 1; ++ArgNo) {
989 int TypeID = va_arg(VA, int);
992 if (ArgNo != FTy->getNumParams()+1)
993 CheckFailed("Intrinsic prototype has too many arguments!", F);
997 if (ArgNo == FTy->getNumParams()+1) {
998 CheckFailed("Intrinsic prototype has too few arguments!", F);
1004 Ty = FTy->getReturnType();
1006 Ty = FTy->getParamType(ArgNo-1);
1008 if (TypeID != Ty->getTypeID()) {
1010 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1012 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1016 if (TypeID == Type::IntegerTyID) {
1017 unsigned GotBits = (unsigned) va_arg(VA, int);
1018 unsigned ExpectBits = cast<IntegerType>(Ty)->getBitWidth();
1019 if (GotBits != ExpectBits) {
1020 std::string bitmsg = " Expecting " + utostr(ExpectBits) + " but got " +
1021 utostr(GotBits) + " bits.";
1023 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1026 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1027 "incorrect integer width!" + bitmsg, F);
1030 } else if (TypeID == Type::PackedTyID) {
1031 // If this is a packed argument, verify the number and type of elements.
1032 const PackedType *PTy = cast<PackedType>(Ty);
1033 int ElemTy = va_arg(VA, int);
1034 if (ElemTy != PTy->getElementType()->getTypeID()) {
1035 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1039 if (ElemTy == Type::IntegerTyID) {
1040 unsigned NumBits = (unsigned)va_arg(VA, int);
1041 unsigned ExpectedBits =
1042 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1043 if (NumBits != ExpectedBits) {
1044 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1049 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1050 CheckFailed("Intrinsic prototype has incorrect number of "
1051 "vector elements!",F);
1061 //===----------------------------------------------------------------------===//
1062 // Implement the public interfaces to this file...
1063 //===----------------------------------------------------------------------===//
1065 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1066 return new Verifier(action);
1070 // verifyFunction - Create
1071 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1072 Function &F = const_cast<Function&>(f);
1073 assert(!F.isDeclaration() && "Cannot verify external functions");
1075 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1076 Verifier *V = new Verifier(action);
1082 /// verifyModule - Check a module for errors, printing messages on stderr.
1083 /// Return true if the module is corrupt.
1085 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1086 std::string *ErrorInfo) {
1088 Verifier *V = new Verifier(action);
1092 if (ErrorInfo && V->Broken)
1093 *ErrorInfo = V->msgs.str();