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/Analysis/Dominators.h"
55 #include "llvm/Support/CFG.h"
56 #include "llvm/Support/InstVisitor.h"
57 #include "llvm/Support/Streams.h"
58 #include "llvm/ADT/SmallPtrSet.h"
59 #include "llvm/ADT/SmallVector.h"
60 #include "llvm/ADT/StringExtras.h"
61 #include "llvm/ADT/STLExtras.h"
62 #include "llvm/Support/Compiler.h"
68 namespace { // Anonymous namespace for class
70 struct VISIBILITY_HIDDEN
71 Verifier : public FunctionPass, InstVisitor<Verifier> {
72 bool Broken; // Is this module found to be broken?
73 bool RealPass; // Are we not being run by a PassManager?
74 VerifierFailureAction action;
75 // What to do if verification fails.
76 Module *Mod; // Module we are verifying right now
77 ETForest *EF; // ET-Forest, caution can be null!
78 std::stringstream msgs; // A stringstream to collect messages
80 /// InstInThisBlock - when verifying a basic block, keep track of all of the
81 /// instructions we have seen so far. This allows us to do efficient
82 /// dominance checks for the case when an instruction has an operand that is
83 /// an instruction in the same block.
84 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
87 : Broken(false), RealPass(true), action(AbortProcessAction),
88 EF(0), msgs( std::ios::app | std::ios::out ) {}
89 Verifier( VerifierFailureAction ctn )
90 : Broken(false), RealPass(true), action(ctn), EF(0),
91 msgs( std::ios::app | std::ios::out ) {}
93 : Broken(false), RealPass(true),
94 action( AB ? AbortProcessAction : PrintMessageAction), EF(0),
95 msgs( std::ios::app | std::ios::out ) {}
96 Verifier(ETForest &ef)
97 : Broken(false), RealPass(false), action(PrintMessageAction),
98 EF(&ef), msgs( std::ios::app | std::ios::out ) {}
101 bool doInitialization(Module &M) {
103 verifyTypeSymbolTable(M.getTypeSymbolTable());
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>();
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 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
146 visitGlobalAlias(*I);
148 // If the module is broken, abort at this time.
149 return abortIfBroken();
152 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
153 AU.setPreservesAll();
155 AU.addRequired<ETForest>();
158 /// abortIfBroken - If the module is broken and we are supposed to abort on
159 /// this condition, do so.
161 bool abortIfBroken() {
163 msgs << "Broken module found, ";
165 case AbortProcessAction:
166 msgs << "compilation aborted!\n";
169 case PrintMessageAction:
170 msgs << "verification continues.\n";
173 case ReturnStatusAction:
174 msgs << "compilation terminated.\n";
182 // Verification methods...
183 void verifyTypeSymbolTable(TypeSymbolTable &ST);
184 void visitGlobalValue(GlobalValue &GV);
185 void visitGlobalVariable(GlobalVariable &GV);
186 void visitGlobalAlias(GlobalAlias &GA);
187 void visitFunction(Function &F);
188 void visitBasicBlock(BasicBlock &BB);
189 void visitTruncInst(TruncInst &I);
190 void visitZExtInst(ZExtInst &I);
191 void visitSExtInst(SExtInst &I);
192 void visitFPTruncInst(FPTruncInst &I);
193 void visitFPExtInst(FPExtInst &I);
194 void visitFPToUIInst(FPToUIInst &I);
195 void visitFPToSIInst(FPToSIInst &I);
196 void visitUIToFPInst(UIToFPInst &I);
197 void visitSIToFPInst(SIToFPInst &I);
198 void visitIntToPtrInst(IntToPtrInst &I);
199 void visitPtrToIntInst(PtrToIntInst &I);
200 void visitBitCastInst(BitCastInst &I);
201 void visitPHINode(PHINode &PN);
202 void visitBinaryOperator(BinaryOperator &B);
203 void visitICmpInst(ICmpInst &IC);
204 void visitFCmpInst(FCmpInst &FC);
205 void visitExtractElementInst(ExtractElementInst &EI);
206 void visitInsertElementInst(InsertElementInst &EI);
207 void visitShuffleVectorInst(ShuffleVectorInst &EI);
208 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
209 void visitCallInst(CallInst &CI);
210 void visitGetElementPtrInst(GetElementPtrInst &GEP);
211 void visitLoadInst(LoadInst &LI);
212 void visitStoreInst(StoreInst &SI);
213 void visitInstruction(Instruction &I);
214 void visitTerminatorInst(TerminatorInst &I);
215 void visitReturnInst(ReturnInst &RI);
216 void visitSwitchInst(SwitchInst &SI);
217 void visitSelectInst(SelectInst &SI);
218 void visitUserOp1(Instruction &I);
219 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
220 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
222 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F, ...);
224 void WriteValue(const Value *V) {
226 if (isa<Instruction>(V)) {
229 WriteAsOperand(msgs, V, true, Mod);
234 void WriteType(const Type* T ) {
236 WriteTypeSymbolic(msgs, T, Mod );
240 // CheckFailed - A check failed, so print out the condition and the message
241 // that failed. This provides a nice place to put a breakpoint if you want
242 // to see why something is not correct.
243 void CheckFailed(const std::string &Message,
244 const Value *V1 = 0, const Value *V2 = 0,
245 const Value *V3 = 0, const Value *V4 = 0) {
246 msgs << Message << "\n";
254 void CheckFailed( const std::string& Message, const Value* V1,
255 const Type* T2, const Value* V3 = 0 ) {
256 msgs << Message << "\n";
264 RegisterPass<Verifier> X("verify", "Module Verifier");
265 } // End anonymous namespace
268 // Assert - We know that cond should be true, if not print an error message.
269 #define Assert(C, M) \
270 do { if (!(C)) { CheckFailed(M); return; } } while (0)
271 #define Assert1(C, M, V1) \
272 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
273 #define Assert2(C, M, V1, V2) \
274 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
275 #define Assert3(C, M, V1, V2, V3) \
276 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
277 #define Assert4(C, M, V1, V2, V3, V4) \
278 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
281 void Verifier::visitGlobalValue(GlobalValue &GV) {
282 Assert1(!GV.isDeclaration() ||
283 GV.hasExternalLinkage() ||
284 GV.hasDLLImportLinkage() ||
285 GV.hasExternalWeakLinkage() ||
286 (isa<GlobalAlias>(GV) &&
287 (GV.hasInternalLinkage() || GV.hasWeakLinkage())),
288 "Global is external, but doesn't have external or dllimport or weak linkage!",
291 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
292 "Global is marked as dllimport, but not external", &GV);
294 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
295 "Only global variables can have appending linkage!", &GV);
297 if (GV.hasAppendingLinkage()) {
298 GlobalVariable &GVar = cast<GlobalVariable>(GV);
299 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
300 "Only global arrays can have appending linkage!", &GV);
304 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
305 if (GV.hasInitializer())
306 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
307 "Global variable initializer type does not match global "
308 "variable type!", &GV);
310 visitGlobalValue(GV);
313 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
314 Assert1(!GA.getName().empty(),
315 "Alias name cannot be empty!", &GA);
316 Assert1(GA.hasExternalLinkage() || GA.hasInternalLinkage() ||
318 "Alias should have external or external weak linkage!", &GA);
319 Assert1(GA.getType() == GA.getAliasee()->getType(),
320 "Alias and aliasee types should match!", &GA);
322 visitGlobalValue(GA);
325 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
328 // visitFunction - Verify that a function is ok.
330 void Verifier::visitFunction(Function &F) {
331 // Check function arguments.
332 const FunctionType *FT = F.getFunctionType();
333 unsigned NumArgs = F.getArgumentList().size();
335 Assert2(FT->getNumParams() == NumArgs,
336 "# formal arguments must match # of arguments for function type!",
338 Assert1(F.getReturnType()->isFirstClassType() ||
339 F.getReturnType() == Type::VoidTy,
340 "Functions cannot return aggregate values!", &F);
342 Assert1(!FT->isStructReturn() ||
343 (FT->getReturnType() == Type::VoidTy &&
344 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
345 "Invalid struct-return function!", &F);
347 // Check that this function meets the restrictions on this calling convention.
348 switch (F.getCallingConv()) {
353 case CallingConv::Fast:
354 case CallingConv::Cold:
355 case CallingConv::X86_FastCall:
356 Assert1(!F.isVarArg(),
357 "Varargs functions must have C calling conventions!", &F);
361 // Check that the argument values match the function type for this function...
363 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
365 Assert2(I->getType() == FT->getParamType(i),
366 "Argument value does not match function argument type!",
367 I, FT->getParamType(i));
368 // Make sure no aggregates are passed by value.
369 Assert1(I->getType()->isFirstClassType(),
370 "Functions cannot take aggregates as arguments by value!", I);
373 if (!F.isDeclaration()) {
374 // Verify that this function (which has a body) is not named "llvm.*". It
375 // is not legal to define intrinsics.
376 if (F.getName().size() >= 5)
377 Assert1(F.getName().substr(0, 5) != "llvm.",
378 "llvm intrinsics cannot be defined!", &F);
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 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
400 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
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...
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 == &PN.getParent()->front() ||
665 isa<PHINode>(--BasicBlock::iterator(&PN)),
666 "PHI nodes not grouped at top of basic block!",
667 &PN, PN.getParent());
669 // Check that all of the operands of the PHI node have the same type as the
671 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
672 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
673 "PHI node operands are not the same type as the result!", &PN);
675 // All other PHI node constraints are checked in the visitBasicBlock method.
677 visitInstruction(PN);
680 void Verifier::visitCallInst(CallInst &CI) {
681 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
682 "Called function must be a pointer!", &CI);
683 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
684 Assert1(isa<FunctionType>(FPTy->getElementType()),
685 "Called function is not pointer to function type!", &CI);
687 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
689 // Verify that the correct number of arguments are being passed
691 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
692 "Called function requires more parameters than were provided!",&CI);
694 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
695 "Incorrect number of arguments passed to called function!", &CI);
697 // Verify that all arguments to the call match the function type...
698 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
699 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
700 "Call parameter type does not match function signature!",
701 CI.getOperand(i+1), FTy->getParamType(i), &CI);
703 if (Function *F = CI.getCalledFunction())
704 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
705 visitIntrinsicFunctionCall(ID, CI);
707 visitInstruction(CI);
710 /// visitBinaryOperator - Check that both arguments to the binary operator are
711 /// of the same type!
713 void Verifier::visitBinaryOperator(BinaryOperator &B) {
714 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
715 "Both operands to a binary operator are not of the same type!", &B);
717 switch (B.getOpcode()) {
718 // Check that logical operators are only used with integral operands.
719 case Instruction::And:
720 case Instruction::Or:
721 case Instruction::Xor:
722 Assert1(B.getType()->isInteger() ||
723 (isa<VectorType>(B.getType()) &&
724 cast<VectorType>(B.getType())->getElementType()->isInteger()),
725 "Logical operators only work with integral types!", &B);
726 Assert1(B.getType() == B.getOperand(0)->getType(),
727 "Logical operators must have same type for operands and result!",
730 case Instruction::Shl:
731 case Instruction::LShr:
732 case Instruction::AShr:
733 Assert1(B.getType()->isInteger(),
734 "Shift must return an integer result!", &B);
735 Assert1(B.getType() == B.getOperand(0)->getType(),
736 "Shift return type must be same as operands!", &B);
739 // Arithmetic operators only work on integer or fp values
740 Assert1(B.getType() == B.getOperand(0)->getType(),
741 "Arithmetic operators must have same type for operands and result!",
743 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
744 isa<VectorType>(B.getType()),
745 "Arithmetic operators must have integer, fp, or vector type!", &B);
752 void Verifier::visitICmpInst(ICmpInst& IC) {
753 // Check that the operands are the same type
754 const Type* Op0Ty = IC.getOperand(0)->getType();
755 const Type* Op1Ty = IC.getOperand(1)->getType();
756 Assert1(Op0Ty == Op1Ty,
757 "Both operands to ICmp instruction are not of the same type!", &IC);
758 // Check that the operands are the right type
759 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
760 "Invalid operand types for ICmp instruction", &IC);
761 visitInstruction(IC);
764 void Verifier::visitFCmpInst(FCmpInst& FC) {
765 // Check that the operands are the same type
766 const Type* Op0Ty = FC.getOperand(0)->getType();
767 const Type* Op1Ty = FC.getOperand(1)->getType();
768 Assert1(Op0Ty == Op1Ty,
769 "Both operands to FCmp instruction are not of the same type!", &FC);
770 // Check that the operands are the right type
771 Assert1(Op0Ty->isFloatingPoint(),
772 "Invalid operand types for FCmp instruction", &FC);
773 visitInstruction(FC);
776 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
777 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
779 "Invalid extractelement operands!", &EI);
780 visitInstruction(EI);
783 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
784 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
787 "Invalid insertelement operands!", &IE);
788 visitInstruction(IE);
791 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
792 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
794 "Invalid shufflevector operands!", &SV);
795 Assert1(SV.getType() == SV.getOperand(0)->getType(),
796 "Result of shufflevector must match first operand type!", &SV);
798 // Check to see if Mask is valid.
799 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
800 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
801 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
802 isa<UndefValue>(MV->getOperand(i)),
803 "Invalid shufflevector shuffle mask!", &SV);
806 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
807 isa<ConstantAggregateZero>(SV.getOperand(2)),
808 "Invalid shufflevector shuffle mask!", &SV);
811 visitInstruction(SV);
814 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
815 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
817 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
818 &Idxs[0], Idxs.size(), true);
819 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
820 Assert2(isa<PointerType>(GEP.getType()) &&
821 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
822 "GEP is not of right type for indices!", &GEP, ElTy);
823 visitInstruction(GEP);
826 void Verifier::visitLoadInst(LoadInst &LI) {
828 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
829 Assert2(ElTy == LI.getType(),
830 "Load result type does not match pointer operand type!", &LI, ElTy);
831 visitInstruction(LI);
834 void Verifier::visitStoreInst(StoreInst &SI) {
836 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
837 Assert2(ElTy == SI.getOperand(0)->getType(),
838 "Stored value type does not match pointer operand type!", &SI, ElTy);
839 visitInstruction(SI);
843 /// verifyInstruction - Verify that an instruction is well formed.
845 void Verifier::visitInstruction(Instruction &I) {
846 BasicBlock *BB = I.getParent();
847 Assert1(BB, "Instruction not embedded in basic block!", &I);
849 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
850 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
852 Assert1(*UI != (User*)&I ||
853 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
854 "Only PHI nodes may reference their own value!", &I);
857 // Check that void typed values don't have names
858 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
859 "Instruction has a name, but provides a void value!", &I);
861 // Check that the return value of the instruction is either void or a legal
863 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
864 "Instruction returns a non-scalar type!", &I);
866 // Check that all uses of the instruction, if they are instructions
867 // themselves, actually have parent basic blocks. If the use is not an
868 // instruction, it is an error!
869 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
871 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
873 Instruction *Used = cast<Instruction>(*UI);
874 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
875 " embeded in a basic block!", &I, Used);
878 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
879 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
881 // Check to make sure that only first-class-values are operands to
883 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
884 "Instruction operands must be first-class values!", &I);
886 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
887 // Check to make sure that the "address of" an intrinsic function is never
889 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
890 "Cannot take the address of an intrinsic!", &I);
891 Assert1(F->getParent() == Mod, "Referencing function in another module!",
893 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
894 Assert1(OpBB->getParent() == BB->getParent(),
895 "Referring to a basic block in another function!", &I);
896 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
897 Assert1(OpArg->getParent() == BB->getParent(),
898 "Referring to an argument in another function!", &I);
899 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
900 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
902 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
903 BasicBlock *OpBlock = Op->getParent();
905 // Check that a definition dominates all of its uses.
906 if (!isa<PHINode>(I)) {
907 // Invoke results are only usable in the normal destination, not in the
908 // exceptional destination.
909 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
910 OpBlock = II->getNormalDest();
912 Assert2(OpBlock != II->getUnwindDest(),
913 "No uses of invoke possible due to dominance structure!",
916 // If the normal successor of an invoke instruction has multiple
917 // predecessors, then the normal edge from the invoke is critical, so
918 // the invoke value can only be live if the destination block
919 // dominates all of it's predecessors (other than the invoke) or if
920 // the invoke value is only used by a phi in the successor.
921 if (!OpBlock->getSinglePredecessor() &&
922 EF->dominates(&BB->getParent()->getEntryBlock(), BB)) {
923 // The first case we allow is if the use is a PHI operand in the
924 // normal block, and if that PHI operand corresponds to the invoke's
927 if (PHINode *PN = dyn_cast<PHINode>(&I))
928 if (PN->getParent() == OpBlock &&
929 PN->getIncomingBlock(i/2) == Op->getParent())
932 // If it is used by something non-phi, then the other case is that
933 // 'OpBlock' dominates all of its predecessors other than the
934 // invoke. In this case, the invoke value can still be used.
937 for (pred_iterator PI = pred_begin(OpBlock),
938 E = pred_end(OpBlock); PI != E; ++PI) {
939 if (*PI != II->getParent() && !EF->dominates(OpBlock, *PI)) {
946 "Invoke value defined on critical edge but not dead!", &I,
949 } else if (OpBlock == BB) {
950 // If they are in the same basic block, make sure that the definition
951 // comes before the use.
952 Assert2(InstsInThisBlock.count(Op) ||
953 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
954 "Instruction does not dominate all uses!", Op, &I);
957 // Definition must dominate use unless use is unreachable!
958 Assert2(EF->dominates(OpBlock, BB) ||
959 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
960 "Instruction does not dominate all uses!", Op, &I);
962 // PHI nodes are more difficult than other nodes because they actually
963 // "use" the value in the predecessor basic blocks they correspond to.
964 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
965 Assert2(EF->dominates(OpBlock, PredBB) ||
966 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
967 "Instruction does not dominate all uses!", Op, &I);
969 } else if (isa<InlineAsm>(I.getOperand(i))) {
970 Assert1(i == 0 && isa<CallInst>(I),
971 "Cannot take the address of an inline asm!", &I);
974 InstsInThisBlock.insert(&I);
977 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
979 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
980 Function *IF = CI.getCalledFunction();
981 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
984 #define GET_INTRINSIC_VERIFIER
985 #include "llvm/Intrinsics.gen"
986 #undef GET_INTRINSIC_VERIFIER
989 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
990 /// Intrinsics.gen. This implements a little state machine that verifies the
991 /// prototype of intrinsics.
992 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F, ...) {
996 const FunctionType *FTy = F->getFunctionType();
998 // For overloaded intrinsics, the Suffix of the function name must match the
999 // types of the arguments. This variable keeps track of the expected
1000 // suffix, to be checked at the end.
1003 // Note that "arg#0" is the return type.
1004 for (unsigned ArgNo = 0; 1; ++ArgNo) {
1005 int TypeID = va_arg(VA, int);
1012 if (ArgNo != FTy->getNumParams()+1)
1013 CheckFailed("Intrinsic prototype has too many arguments!", F);
1017 if (ArgNo == FTy->getNumParams()+1) {
1018 CheckFailed("Intrinsic prototype has too few arguments!", F);
1024 Ty = FTy->getReturnType();
1026 Ty = FTy->getParamType(ArgNo-1);
1028 if (TypeID != Ty->getTypeID()) {
1030 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1032 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1036 if (TypeID == Type::IntegerTyID) {
1037 unsigned ExpectedBits = (unsigned) va_arg(VA, int);
1038 unsigned GotBits = cast<IntegerType>(Ty)->getBitWidth();
1039 if (ExpectedBits == 0) {
1040 Suffix += ".i" + utostr(GotBits);
1041 } else if (GotBits != ExpectedBits) {
1042 std::string bitmsg = " Expected " + utostr(ExpectedBits) + " but got "+
1043 utostr(GotBits) + " bits.";
1045 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1048 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1049 "incorrect integer width!" + bitmsg, F);
1052 // Check some constraints on various intrinsics.
1054 default: break; // Not everything needs to be checked.
1055 case Intrinsic::bswap:
1056 if (GotBits < 16 || GotBits % 16 != 0)
1057 CheckFailed("Intrinsic requires even byte width argument", F);
1059 case Intrinsic::part_set:
1060 case Intrinsic::part_select:
1062 unsigned ResultBits =
1063 cast<IntegerType>(FTy->getReturnType())->getBitWidth();
1064 if (GotBits != ResultBits)
1065 CheckFailed("Intrinsic requires the bit widths of the first "
1066 "parameter and the result to match", F);
1070 } else if (TypeID == Type::VectorTyID) {
1071 // If this is a packed argument, verify the number and type of elements.
1072 const VectorType *PTy = cast<VectorType>(Ty);
1073 int ElemTy = va_arg(VA, int);
1074 if (ElemTy != PTy->getElementType()->getTypeID()) {
1075 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1079 if (ElemTy == Type::IntegerTyID) {
1080 unsigned NumBits = (unsigned)va_arg(VA, int);
1081 unsigned ExpectedBits =
1082 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1083 if (NumBits != ExpectedBits) {
1084 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1089 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1090 CheckFailed("Intrinsic prototype has incorrect number of "
1091 "vector elements!",F);
1099 // If we computed a Suffix then the intrinsic is overloaded and we need to
1100 // make sure that the name of the function is correct. We add the suffix to
1101 // the name of the intrinsic and compare against the given function name. If
1102 // they are not the same, the function name is invalid. This ensures that
1103 // overloading of intrinsics uses a sane and consistent naming convention.
1104 if (!Suffix.empty()) {
1105 std::string Name(Intrinsic::getName(ID));
1106 if (Name + Suffix != F->getName())
1107 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1108 F->getName().substr(Name.length()) + "'. It should be '" +
1114 //===----------------------------------------------------------------------===//
1115 // Implement the public interfaces to this file...
1116 //===----------------------------------------------------------------------===//
1118 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1119 return new Verifier(action);
1123 // verifyFunction - Create
1124 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1125 Function &F = const_cast<Function&>(f);
1126 assert(!F.isDeclaration() && "Cannot verify external functions");
1128 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1129 Verifier *V = new Verifier(action);
1135 /// verifyModule - Check a module for errors, printing messages on stderr.
1136 /// Return true if the module is corrupt.
1138 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1139 std::string *ErrorInfo) {
1141 Verifier *V = new Verifier(action);
1145 if (ErrorInfo && V->Broken)
1146 *ErrorInfo = V->msgs.str();