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 verifySymbolTable(M.getSymbolTable());
104 // If this is a real pass, in a pass manager, we must abort before
105 // returning back to the pass manager, or else the pass manager may try to
106 // run other passes on the broken module.
108 return abortIfBroken();
112 bool runOnFunction(Function &F) {
113 // Get dominator information if we are being run by PassManager
114 if (RealPass) EF = &getAnalysis<ETForest>();
117 InstsInThisBlock.clear();
119 // If this is a real pass, in a pass manager, we must abort before
120 // returning back to the pass manager, or else the pass manager may try to
121 // run other passes on the broken module.
123 return abortIfBroken();
128 bool doFinalization(Module &M) {
129 // Scan through, checking all of the external function's linkage now...
130 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
131 visitGlobalValue(*I);
133 // Check to make sure function prototypes are okay.
134 if (I->isExternal()) visitFunction(*I);
137 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
139 visitGlobalVariable(*I);
141 // If the module is broken, abort at this time.
142 return abortIfBroken();
145 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
146 AU.setPreservesAll();
148 AU.addRequired<ETForest>();
151 /// abortIfBroken - If the module is broken and we are supposed to abort on
152 /// this condition, do so.
154 bool abortIfBroken() {
156 msgs << "Broken module found, ";
158 case AbortProcessAction:
159 msgs << "compilation aborted!\n";
162 case PrintMessageAction:
163 msgs << "verification continues.\n";
166 case ReturnStatusAction:
167 msgs << "compilation terminated.\n";
175 // Verification methods...
176 void verifySymbolTable(SymbolTable &ST);
177 void visitGlobalValue(GlobalValue &GV);
178 void visitGlobalVariable(GlobalVariable &GV);
179 void visitFunction(Function &F);
180 void visitBasicBlock(BasicBlock &BB);
181 void visitTruncInst(TruncInst &I);
182 void visitZExtInst(ZExtInst &I);
183 void visitSExtInst(SExtInst &I);
184 void visitFPTruncInst(FPTruncInst &I);
185 void visitFPExtInst(FPExtInst &I);
186 void visitFPToUIInst(FPToUIInst &I);
187 void visitFPToSIInst(FPToSIInst &I);
188 void visitUIToFPInst(UIToFPInst &I);
189 void visitSIToFPInst(SIToFPInst &I);
190 void visitIntToPtrInst(IntToPtrInst &I);
191 void visitPtrToIntInst(PtrToIntInst &I);
192 void visitBitCastInst(BitCastInst &I);
193 void visitPHINode(PHINode &PN);
194 void visitBinaryOperator(BinaryOperator &B);
195 void visitICmpInst(ICmpInst &IC);
196 void visitFCmpInst(FCmpInst &FC);
197 void visitShiftInst(ShiftInst &SI);
198 void visitExtractElementInst(ExtractElementInst &EI);
199 void visitInsertElementInst(InsertElementInst &EI);
200 void visitShuffleVectorInst(ShuffleVectorInst &EI);
201 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
202 void visitCallInst(CallInst &CI);
203 void visitGetElementPtrInst(GetElementPtrInst &GEP);
204 void visitLoadInst(LoadInst &LI);
205 void visitStoreInst(StoreInst &SI);
206 void visitInstruction(Instruction &I);
207 void visitTerminatorInst(TerminatorInst &I);
208 void visitReturnInst(ReturnInst &RI);
209 void visitSwitchInst(SwitchInst &SI);
210 void visitSelectInst(SelectInst &SI);
211 void visitUserOp1(Instruction &I);
212 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
213 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
215 void VerifyIntrinsicPrototype(Function *F, ...);
217 void WriteValue(const Value *V) {
219 if (isa<Instruction>(V)) {
222 WriteAsOperand(msgs, V, true, Mod);
227 void WriteType(const Type* T ) {
229 WriteTypeSymbolic(msgs, T, Mod );
233 // CheckFailed - A check failed, so print out the condition and the message
234 // that failed. This provides a nice place to put a breakpoint if you want
235 // to see why something is not correct.
236 void CheckFailed(const std::string &Message,
237 const Value *V1 = 0, const Value *V2 = 0,
238 const Value *V3 = 0, const Value *V4 = 0) {
239 msgs << Message << "\n";
247 void CheckFailed( const std::string& Message, const Value* V1,
248 const Type* T2, const Value* V3 = 0 ) {
249 msgs << Message << "\n";
257 RegisterPass<Verifier> X("verify", "Module Verifier");
258 } // End anonymous namespace
261 // Assert - We know that cond should be true, if not print an error message.
262 #define Assert(C, M) \
263 do { if (!(C)) { CheckFailed(M); return; } } while (0)
264 #define Assert1(C, M, V1) \
265 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
266 #define Assert2(C, M, V1, V2) \
267 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
268 #define Assert3(C, M, V1, V2, V3) \
269 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
270 #define Assert4(C, M, V1, V2, V3, V4) \
271 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
274 void Verifier::visitGlobalValue(GlobalValue &GV) {
275 Assert1(!GV.isExternal() ||
276 GV.hasExternalLinkage() ||
277 GV.hasDLLImportLinkage() ||
278 GV.hasExternalWeakLinkage(),
279 "Global is external, but doesn't have external or dllimport or weak linkage!",
282 Assert1(!GV.hasDLLImportLinkage() || GV.isExternal(),
283 "Global is marked as dllimport, but not external", &GV);
285 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
286 "Only global variables can have appending linkage!", &GV);
288 if (GV.hasAppendingLinkage()) {
289 GlobalVariable &GVar = cast<GlobalVariable>(GV);
290 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
291 "Only global arrays can have appending linkage!", &GV);
295 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
296 if (GV.hasInitializer())
297 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
298 "Global variable initializer type does not match global "
299 "variable type!", &GV);
301 visitGlobalValue(GV);
305 // verifySymbolTable - Verify that a function or module symbol table is ok
307 void Verifier::verifySymbolTable(SymbolTable &ST) {
309 // Loop over all of the values in all type planes in the symbol table.
310 for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
311 PE = ST.plane_end(); PI != PE; ++PI)
312 for (SymbolTable::value_const_iterator VI = PI->second.begin(),
313 VE = PI->second.end(); VI != VE; ++VI) {
314 Value *V = VI->second;
315 // Check that there are no void typed values in the symbol table. Values
316 // with a void type cannot be put into symbol tables because they cannot
318 Assert1(V->getType() != Type::VoidTy,
319 "Values with void type are not allowed to have names!", V);
323 // visitFunction - Verify that a function is ok.
325 void Verifier::visitFunction(Function &F) {
326 // Check function arguments.
327 const FunctionType *FT = F.getFunctionType();
328 unsigned NumArgs = F.getArgumentList().size();
330 Assert2(FT->getNumParams() == NumArgs,
331 "# formal arguments must match # of arguments for function type!",
333 Assert1(F.getReturnType()->isFirstClassType() ||
334 F.getReturnType() == Type::VoidTy,
335 "Functions cannot return aggregate values!", &F);
337 // Check that this function meets the restrictions on this calling convention.
338 switch (F.getCallingConv()) {
343 case CallingConv::CSRet:
344 Assert1(FT->getReturnType() == Type::VoidTy &&
345 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0)),
346 "Invalid struct-return function!", &F);
348 case CallingConv::Fast:
349 case CallingConv::Cold:
350 case CallingConv::X86_FastCall:
351 Assert1(!F.isVarArg(),
352 "Varargs functions must have C calling conventions!", &F);
356 // Check that the argument values match the function type for this function...
358 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
360 Assert2(I->getType() == FT->getParamType(i),
361 "Argument value does not match function argument type!",
362 I, FT->getParamType(i));
363 // Make sure no aggregates are passed by value.
364 Assert1(I->getType()->isFirstClassType(),
365 "Functions cannot take aggregates as arguments by value!", I);
368 if (!F.isExternal()) {
369 // Verify that this function (which has a body) is not named "llvm.*". It
370 // is not legal to define intrinsics.
371 if (F.getName().size() >= 5)
372 Assert1(F.getName().substr(0, 5) != "llvm.",
373 "llvm intrinsics cannot be defined!", &F);
375 verifySymbolTable(F.getSymbolTable());
377 // Check the entry node
378 BasicBlock *Entry = &F.getEntryBlock();
379 Assert1(pred_begin(Entry) == pred_end(Entry),
380 "Entry block to function must not have predecessors!", Entry);
385 // verifyBasicBlock - Verify that a basic block is well formed...
387 void Verifier::visitBasicBlock(BasicBlock &BB) {
388 InstsInThisBlock.clear();
390 // Ensure that basic blocks have terminators!
391 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
393 // Check constraints that this basic block imposes on all of the PHI nodes in
395 if (isa<PHINode>(BB.front())) {
396 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
397 std::sort(Preds.begin(), Preds.end());
399 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
401 // Ensure that PHI nodes have at least one entry!
402 Assert1(PN->getNumIncomingValues() != 0,
403 "PHI nodes must have at least one entry. If the block is dead, "
404 "the PHI should be removed!", PN);
405 Assert1(PN->getNumIncomingValues() == Preds.size(),
406 "PHINode should have one entry for each predecessor of its "
407 "parent basic block!", PN);
409 // Get and sort all incoming values in the PHI node...
410 std::vector<std::pair<BasicBlock*, Value*> > Values;
411 Values.reserve(PN->getNumIncomingValues());
412 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
413 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
414 PN->getIncomingValue(i)));
415 std::sort(Values.begin(), Values.end());
417 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
418 // Check to make sure that if there is more than one entry for a
419 // particular basic block in this PHI node, that the incoming values are
422 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
423 Values[i].second == Values[i-1].second,
424 "PHI node has multiple entries for the same basic block with "
425 "different incoming values!", PN, Values[i].first,
426 Values[i].second, Values[i-1].second);
428 // Check to make sure that the predecessors and PHI node entries are
430 Assert3(Values[i].first == Preds[i],
431 "PHI node entries do not match predecessors!", PN,
432 Values[i].first, Preds[i]);
438 void Verifier::visitTerminatorInst(TerminatorInst &I) {
439 // Ensure that terminators only exist at the end of the basic block.
440 Assert1(&I == I.getParent()->getTerminator(),
441 "Terminator found in the middle of a basic block!", I.getParent());
445 void Verifier::visitReturnInst(ReturnInst &RI) {
446 Function *F = RI.getParent()->getParent();
447 if (RI.getNumOperands() == 0)
448 Assert2(F->getReturnType() == Type::VoidTy,
449 "Found return instr that returns void in Function of non-void "
450 "return type!", &RI, F->getReturnType());
452 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
453 "Function return type does not match operand "
454 "type of return inst!", &RI, F->getReturnType());
456 // Check to make sure that the return value has necessary properties for
458 visitTerminatorInst(RI);
461 void Verifier::visitSwitchInst(SwitchInst &SI) {
462 // Check to make sure that all of the constants in the switch instruction
463 // have the same type as the switched-on value.
464 const Type *SwitchTy = SI.getCondition()->getType();
465 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
466 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
467 "Switch constants must all be same type as switch value!", &SI);
469 visitTerminatorInst(SI);
472 void Verifier::visitSelectInst(SelectInst &SI) {
473 Assert1(SI.getCondition()->getType() == Type::BoolTy,
474 "Select condition type must be bool!", &SI);
475 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
476 "Select values must have identical types!", &SI);
477 Assert1(SI.getTrueValue()->getType() == SI.getType(),
478 "Select values must have same type as select instruction!", &SI);
479 visitInstruction(SI);
483 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
484 /// a pass, if any exist, it's an error.
486 void Verifier::visitUserOp1(Instruction &I) {
487 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
490 void Verifier::visitTruncInst(TruncInst &I) {
491 // Get the source and destination types
492 const Type *SrcTy = I.getOperand(0)->getType();
493 const Type *DestTy = I.getType();
495 // Get the size of the types in bits, we'll need this later
496 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
497 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
499 Assert1(SrcTy->isIntegral(), "Trunc only operates on integer", &I);
500 Assert1(DestTy->isIntegral(),"Trunc only produces integral", &I);
501 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
506 void Verifier::visitZExtInst(ZExtInst &I) {
507 // Get the source and destination types
508 const Type *SrcTy = I.getOperand(0)->getType();
509 const Type *DestTy = I.getType();
511 // Get the size of the types in bits, we'll need this later
512 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
513 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
515 Assert1(SrcTy->isIntegral(),"ZExt only operates on integral", &I);
516 Assert1(DestTy->isInteger(),"ZExt only produces an integer", &I);
517 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
522 void Verifier::visitSExtInst(SExtInst &I) {
523 // Get the source and destination types
524 const Type *SrcTy = I.getOperand(0)->getType();
525 const Type *DestTy = I.getType();
527 // Get the size of the types in bits, we'll need this later
528 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
529 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
531 Assert1(SrcTy->isIntegral(),"SExt only operates on integral", &I);
532 Assert1(DestTy->isInteger(),"SExt only produces an integer", &I);
533 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
538 void Verifier::visitFPTruncInst(FPTruncInst &I) {
539 // Get the source and destination types
540 const Type *SrcTy = I.getOperand(0)->getType();
541 const Type *DestTy = I.getType();
542 // Get the size of the types in bits, we'll need this later
543 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
544 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
546 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
547 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
548 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
553 void Verifier::visitFPExtInst(FPExtInst &I) {
554 // Get the source and destination types
555 const Type *SrcTy = I.getOperand(0)->getType();
556 const Type *DestTy = I.getType();
558 // Get the size of the types in bits, we'll need this later
559 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
560 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
562 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
563 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
564 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
569 void Verifier::visitUIToFPInst(UIToFPInst &I) {
570 // Get the source and destination types
571 const Type *SrcTy = I.getOperand(0)->getType();
572 const Type *DestTy = I.getType();
574 Assert1(SrcTy->isIntegral(),"UInt2FP source must be integral", &I);
575 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
580 void Verifier::visitSIToFPInst(SIToFPInst &I) {
581 // Get the source and destination types
582 const Type *SrcTy = I.getOperand(0)->getType();
583 const Type *DestTy = I.getType();
585 Assert1(SrcTy->isIntegral(),"SInt2FP source must be integral", &I);
586 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
591 void Verifier::visitFPToUIInst(FPToUIInst &I) {
592 // Get the source and destination types
593 const Type *SrcTy = I.getOperand(0)->getType();
594 const Type *DestTy = I.getType();
596 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
597 Assert1(DestTy->isIntegral(),"FP2UInt result must be integral", &I);
602 void Verifier::visitFPToSIInst(FPToSIInst &I) {
603 // Get the source and destination types
604 const Type *SrcTy = I.getOperand(0)->getType();
605 const Type *DestTy = I.getType();
607 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
608 Assert1(DestTy->isIntegral(),"FP2ToI result must be integral", &I);
613 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
614 // Get the source and destination types
615 const Type *SrcTy = I.getOperand(0)->getType();
616 const Type *DestTy = I.getType();
618 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
619 Assert1(DestTy->isIntegral(), "PtrToInt result must be integral", &I);
624 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
625 // Get the source and destination types
626 const Type *SrcTy = I.getOperand(0)->getType();
627 const Type *DestTy = I.getType();
629 Assert1(SrcTy->isIntegral(), "IntToPtr source must be an integral", &I);
630 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
635 void Verifier::visitBitCastInst(BitCastInst &I) {
636 // Get the source and destination types
637 const Type *SrcTy = I.getOperand(0)->getType();
638 const Type *DestTy = I.getType();
640 // Get the size of the types in bits, we'll need this later
641 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
642 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
644 // BitCast implies a no-op cast of type only. No bits change.
645 // However, you can't cast pointers to anything but pointers.
646 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
647 "Bitcast requires both operands to be pointer or neither", &I);
648 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
653 /// visitPHINode - Ensure that a PHI node is well formed.
655 void Verifier::visitPHINode(PHINode &PN) {
656 // Ensure that the PHI nodes are all grouped together at the top of the block.
657 // This can be tested by checking whether the instruction before this is
658 // either nonexistent (because this is begin()) or is a PHI node. If not,
659 // then there is some other instruction before a PHI.
660 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
661 "PHI nodes not grouped at top of basic block!",
662 &PN, PN.getParent());
664 // Check that all of the operands of the PHI node have the same type as the
666 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
667 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
668 "PHI node operands are not the same type as the result!", &PN);
670 // All other PHI node constraints are checked in the visitBasicBlock method.
672 visitInstruction(PN);
675 void Verifier::visitCallInst(CallInst &CI) {
676 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
677 "Called function must be a pointer!", &CI);
678 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
679 Assert1(isa<FunctionType>(FPTy->getElementType()),
680 "Called function is not pointer to function type!", &CI);
682 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
684 // Verify that the correct number of arguments are being passed
686 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
687 "Called function requires more parameters than were provided!",&CI);
689 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
690 "Incorrect number of arguments passed to called function!", &CI);
692 // Verify that all arguments to the call match the function type...
693 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
694 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
695 "Call parameter type does not match function signature!",
696 CI.getOperand(i+1), FTy->getParamType(i), &CI);
698 if (Function *F = CI.getCalledFunction())
699 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
700 visitIntrinsicFunctionCall(ID, CI);
702 visitInstruction(CI);
705 /// visitBinaryOperator - Check that both arguments to the binary operator are
706 /// of the same type!
708 void Verifier::visitBinaryOperator(BinaryOperator &B) {
709 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
710 "Both operands to a binary operator are not of the same type!", &B);
712 // Check that logical operators are only used with integral operands.
713 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
714 B.getOpcode() == Instruction::Xor) {
715 Assert1(B.getType()->isIntegral() ||
716 (isa<PackedType>(B.getType()) &&
717 cast<PackedType>(B.getType())->getElementType()->isIntegral()),
718 "Logical operators only work with integral types!", &B);
719 Assert1(B.getType() == B.getOperand(0)->getType(),
720 "Logical operators must have same type for operands and result!",
723 // Arithmetic operators only work on integer or fp values
724 Assert1(B.getType() == B.getOperand(0)->getType(),
725 "Arithmetic operators must have same type for operands and result!",
727 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
728 isa<PackedType>(B.getType()),
729 "Arithmetic operators must have integer, fp, or packed type!", &B);
735 void Verifier::visitICmpInst(ICmpInst& IC) {
736 // Check that the operands are the same type
737 const Type* Op0Ty = IC.getOperand(0)->getType();
738 const Type* Op1Ty = IC.getOperand(1)->getType();
739 Assert1(Op0Ty == Op1Ty,
740 "Both operands to ICmp instruction are not of the same type!", &IC);
741 // Check that the operands are the right type
742 Assert1(Op0Ty->isIntegral() || Op0Ty->getTypeID() == Type::PointerTyID ||
743 (isa<PackedType>(Op0Ty) &&
744 cast<PackedType>(Op0Ty)->getElementType()->isIntegral()),
745 "Invalid operand types for ICmp instruction", &IC);
746 visitInstruction(IC);
749 void Verifier::visitFCmpInst(FCmpInst& FC) {
750 // Check that the operands are the same type
751 const Type* Op0Ty = FC.getOperand(0)->getType();
752 const Type* Op1Ty = FC.getOperand(1)->getType();
753 Assert1(Op0Ty == Op1Ty,
754 "Both operands to FCmp instruction are not of the same type!", &FC);
755 // Check that the operands are the right type
756 Assert1(Op0Ty->isFloatingPoint() || (isa<PackedType>(Op0Ty) &&
757 cast<PackedType>(Op0Ty)->getElementType()->isFloatingPoint()),
758 "Invalid operand types for FCmp instruction", &FC);
759 visitInstruction(FC);
762 void Verifier::visitShiftInst(ShiftInst &SI) {
763 Assert1(SI.getType()->isInteger(),
764 "Shift must return an integer result!", &SI);
765 Assert1(SI.getType() == SI.getOperand(0)->getType(),
766 "Shift return type must be same as first operand!", &SI);
767 Assert1(SI.getOperand(1)->getType() == Type::Int8Ty,
768 "Second operand to shift must be ubyte type!", &SI);
769 visitInstruction(SI);
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->isExternal(), "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 (Ty->getTypeID() != TypeID) {
1009 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1011 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1015 // If this is a packed argument, verify the number and type of elements.
1016 if (TypeID == Type::PackedTyID) {
1017 const PackedType *PTy = cast<PackedType>(Ty);
1018 if (va_arg(VA, int) != PTy->getElementType()->getTypeID()) {
1019 CheckFailed("Intrinsic prototype has incorrect vector element type!",F);
1023 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1024 CheckFailed("Intrinsic prototype has incorrect number of "
1025 "vector elements!",F);
1035 //===----------------------------------------------------------------------===//
1036 // Implement the public interfaces to this file...
1037 //===----------------------------------------------------------------------===//
1039 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1040 return new Verifier(action);
1044 // verifyFunction - Create
1045 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1046 Function &F = const_cast<Function&>(f);
1047 assert(!F.isExternal() && "Cannot verify external functions");
1049 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1050 Verifier *V = new Verifier(action);
1056 /// verifyModule - Check a module for errors, printing messages on stderr.
1057 /// Return true if the module is corrupt.
1059 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1060 std::string *ErrorInfo) {
1062 Verifier *V = new Verifier(action);
1066 if (ErrorInfo && V->Broken)
1067 *ErrorInfo = V->msgs.str();