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/ADT/StringExtras.h"
59 #include "llvm/ADT/STLExtras.h"
60 #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>();
116 InstsInThisBlock.clear();
118 // If this is a real pass, in a pass manager, we must abort before
119 // returning back to the pass manager, or else the pass manager may try to
120 // run other passes on the broken module.
122 return abortIfBroken();
127 bool doFinalization(Module &M) {
128 // Scan through, checking all of the external function's linkage now...
129 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
130 visitGlobalValue(*I);
132 // Check to make sure function prototypes are okay.
133 if (I->isExternal()) visitFunction(*I);
136 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
138 visitGlobalVariable(*I);
140 // If the module is broken, abort at this time.
141 return abortIfBroken();
144 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
145 AU.setPreservesAll();
147 AU.addRequired<ETForest>();
150 /// abortIfBroken - If the module is broken and we are supposed to abort on
151 /// this condition, do so.
153 bool abortIfBroken() {
155 msgs << "Broken module found, ";
157 case AbortProcessAction:
158 msgs << "compilation aborted!\n";
159 std::cerr << msgs.str();
161 case PrintMessageAction:
162 msgs << "verification continues.\n";
163 std::cerr << msgs.str();
165 case ReturnStatusAction:
166 msgs << "compilation terminated.\n";
174 // Verification methods...
175 void verifySymbolTable(SymbolTable &ST);
176 void visitGlobalValue(GlobalValue &GV);
177 void visitGlobalVariable(GlobalVariable &GV);
178 void visitFunction(Function &F);
179 void visitBasicBlock(BasicBlock &BB);
180 void visitPHINode(PHINode &PN);
181 void visitBinaryOperator(BinaryOperator &B);
182 void visitShiftInst(ShiftInst &SI);
183 void visitExtractElementInst(ExtractElementInst &EI);
184 void visitInsertElementInst(InsertElementInst &EI);
185 void visitShuffleVectorInst(ShuffleVectorInst &EI);
186 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
187 void visitCallInst(CallInst &CI);
188 void visitGetElementPtrInst(GetElementPtrInst &GEP);
189 void visitLoadInst(LoadInst &LI);
190 void visitStoreInst(StoreInst &SI);
191 void visitInstruction(Instruction &I);
192 void visitTerminatorInst(TerminatorInst &I);
193 void visitReturnInst(ReturnInst &RI);
194 void visitSwitchInst(SwitchInst &SI);
195 void visitSelectInst(SelectInst &SI);
196 void visitUserOp1(Instruction &I);
197 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
198 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
200 void VerifyIntrinsicPrototype(Function *F, ...);
202 void WriteValue(const Value *V) {
204 if (isa<Instruction>(V)) {
207 WriteAsOperand (msgs, V, true, true, Mod);
212 void WriteType(const Type* T ) {
214 WriteTypeSymbolic(msgs, T, Mod );
218 // CheckFailed - A check failed, so print out the condition and the message
219 // that failed. This provides a nice place to put a breakpoint if you want
220 // to see why something is not correct.
221 void CheckFailed(const std::string &Message,
222 const Value *V1 = 0, const Value *V2 = 0,
223 const Value *V3 = 0, const Value *V4 = 0) {
224 msgs << Message << "\n";
232 void CheckFailed( const std::string& Message, const Value* V1,
233 const Type* T2, const Value* V3 = 0 ) {
234 msgs << Message << "\n";
242 RegisterPass<Verifier> X("verify", "Module Verifier");
243 } // End anonymous namespace
246 // Assert - We know that cond should be true, if not print an error message.
247 #define Assert(C, M) \
248 do { if (!(C)) { CheckFailed(M); return; } } while (0)
249 #define Assert1(C, M, V1) \
250 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
251 #define Assert2(C, M, V1, V2) \
252 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
253 #define Assert3(C, M, V1, V2, V3) \
254 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
255 #define Assert4(C, M, V1, V2, V3, V4) \
256 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
259 void Verifier::visitGlobalValue(GlobalValue &GV) {
260 Assert1(!GV.isExternal() ||
261 GV.hasExternalLinkage() ||
262 GV.hasDLLImportLinkage() ||
263 GV.hasExternalWeakLinkage(),
264 "Global is external, but doesn't have external or dllimport or weak linkage!",
267 Assert1(!GV.hasDLLImportLinkage() || GV.isExternal(),
268 "Global is marked as dllimport, but not external", &GV);
270 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
271 "Only global variables can have appending linkage!", &GV);
273 if (GV.hasAppendingLinkage()) {
274 GlobalVariable &GVar = cast<GlobalVariable>(GV);
275 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
276 "Only global arrays can have appending linkage!", &GV);
280 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
281 if (GV.hasInitializer())
282 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
283 "Global variable initializer type does not match global "
284 "variable type!", &GV);
286 visitGlobalValue(GV);
290 // verifySymbolTable - Verify that a function or module symbol table is ok
292 void Verifier::verifySymbolTable(SymbolTable &ST) {
294 // Loop over all of the values in all type planes in the symbol table.
295 for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
296 PE = ST.plane_end(); PI != PE; ++PI)
297 for (SymbolTable::value_const_iterator VI = PI->second.begin(),
298 VE = PI->second.end(); VI != VE; ++VI) {
299 Value *V = VI->second;
300 // Check that there are no void typed values in the symbol table. Values
301 // with a void type cannot be put into symbol tables because they cannot
303 Assert1(V->getType() != Type::VoidTy,
304 "Values with void type are not allowed to have names!", V);
308 // visitFunction - Verify that a function is ok.
310 void Verifier::visitFunction(Function &F) {
311 // Check function arguments.
312 const FunctionType *FT = F.getFunctionType();
313 unsigned NumArgs = F.getArgumentList().size();
315 Assert2(FT->getNumParams() == NumArgs,
316 "# formal arguments must match # of arguments for function type!",
318 Assert1(F.getReturnType()->isFirstClassType() ||
319 F.getReturnType() == Type::VoidTy,
320 "Functions cannot return aggregate values!", &F);
322 // Check that this function meets the restrictions on this calling convention.
323 switch (F.getCallingConv()) {
328 case CallingConv::CSRet:
329 Assert1(FT->getReturnType() == Type::VoidTy &&
330 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0)),
331 "Invalid struct-return function!", &F);
333 case CallingConv::Fast:
334 case CallingConv::Cold:
335 case CallingConv::X86_FastCall:
336 Assert1(!F.isVarArg(),
337 "Varargs functions must have C calling conventions!", &F);
341 // Check that the argument values match the function type for this function...
343 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I, ++i) {
344 Assert2(I->getType() == FT->getParamType(i),
345 "Argument value does not match function argument type!",
346 I, FT->getParamType(i));
347 // Make sure no aggregates are passed by value.
348 Assert1(I->getType()->isFirstClassType(),
349 "Functions cannot take aggregates as arguments by value!", I);
352 if (!F.isExternal()) {
353 verifySymbolTable(F.getSymbolTable());
355 // Check the entry node
356 BasicBlock *Entry = &F.getEntryBlock();
357 Assert1(pred_begin(Entry) == pred_end(Entry),
358 "Entry block to function must not have predecessors!", Entry);
363 // verifyBasicBlock - Verify that a basic block is well formed...
365 void Verifier::visitBasicBlock(BasicBlock &BB) {
366 InstsInThisBlock.clear();
368 // Ensure that basic blocks have terminators!
369 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
371 // Check constraints that this basic block imposes on all of the PHI nodes in
373 if (isa<PHINode>(BB.front())) {
374 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
375 std::sort(Preds.begin(), Preds.end());
377 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
379 // Ensure that PHI nodes have at least one entry!
380 Assert1(PN->getNumIncomingValues() != 0,
381 "PHI nodes must have at least one entry. If the block is dead, "
382 "the PHI should be removed!", PN);
383 Assert1(PN->getNumIncomingValues() == Preds.size(),
384 "PHINode should have one entry for each predecessor of its "
385 "parent basic block!", PN);
387 // Get and sort all incoming values in the PHI node...
388 std::vector<std::pair<BasicBlock*, Value*> > Values;
389 Values.reserve(PN->getNumIncomingValues());
390 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
391 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
392 PN->getIncomingValue(i)));
393 std::sort(Values.begin(), Values.end());
395 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
396 // Check to make sure that if there is more than one entry for a
397 // particular basic block in this PHI node, that the incoming values are
400 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
401 Values[i].second == Values[i-1].second,
402 "PHI node has multiple entries for the same basic block with "
403 "different incoming values!", PN, Values[i].first,
404 Values[i].second, Values[i-1].second);
406 // Check to make sure that the predecessors and PHI node entries are
408 Assert3(Values[i].first == Preds[i],
409 "PHI node entries do not match predecessors!", PN,
410 Values[i].first, Preds[i]);
416 void Verifier::visitTerminatorInst(TerminatorInst &I) {
417 // Ensure that terminators only exist at the end of the basic block.
418 Assert1(&I == I.getParent()->getTerminator(),
419 "Terminator found in the middle of a basic block!", I.getParent());
423 void Verifier::visitReturnInst(ReturnInst &RI) {
424 Function *F = RI.getParent()->getParent();
425 if (RI.getNumOperands() == 0)
426 Assert2(F->getReturnType() == Type::VoidTy,
427 "Found return instr that returns void in Function of non-void "
428 "return type!", &RI, F->getReturnType());
430 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
431 "Function return type does not match operand "
432 "type of return inst!", &RI, F->getReturnType());
434 // Check to make sure that the return value has necessary properties for
436 visitTerminatorInst(RI);
439 void Verifier::visitSwitchInst(SwitchInst &SI) {
440 // Check to make sure that all of the constants in the switch instruction
441 // have the same type as the switched-on value.
442 const Type *SwitchTy = SI.getCondition()->getType();
443 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
444 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
445 "Switch constants must all be same type as switch value!", &SI);
447 visitTerminatorInst(SI);
450 void Verifier::visitSelectInst(SelectInst &SI) {
451 Assert1(SI.getCondition()->getType() == Type::BoolTy,
452 "Select condition type must be bool!", &SI);
453 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
454 "Select values must have identical types!", &SI);
455 Assert1(SI.getTrueValue()->getType() == SI.getType(),
456 "Select values must have same type as select instruction!", &SI);
457 visitInstruction(SI);
461 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
462 /// a pass, if any exist, it's an error.
464 void Verifier::visitUserOp1(Instruction &I) {
465 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
468 /// visitPHINode - Ensure that a PHI node is well formed.
470 void Verifier::visitPHINode(PHINode &PN) {
471 // Ensure that the PHI nodes are all grouped together at the top of the block.
472 // This can be tested by checking whether the instruction before this is
473 // either nonexistent (because this is begin()) or is a PHI node. If not,
474 // then there is some other instruction before a PHI.
475 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
476 "PHI nodes not grouped at top of basic block!",
477 &PN, PN.getParent());
479 // Check that all of the operands of the PHI node have the same type as the
481 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
482 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
483 "PHI node operands are not the same type as the result!", &PN);
485 // All other PHI node constraints are checked in the visitBasicBlock method.
487 visitInstruction(PN);
490 void Verifier::visitCallInst(CallInst &CI) {
491 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
492 "Called function must be a pointer!", &CI);
493 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
494 Assert1(isa<FunctionType>(FPTy->getElementType()),
495 "Called function is not pointer to function type!", &CI);
497 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
499 // Verify that the correct number of arguments are being passed
501 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
502 "Called function requires more parameters than were provided!",&CI);
504 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
505 "Incorrect number of arguments passed to called function!", &CI);
507 // Verify that all arguments to the call match the function type...
508 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
509 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
510 "Call parameter type does not match function signature!",
511 CI.getOperand(i+1), FTy->getParamType(i), &CI);
513 if (Function *F = CI.getCalledFunction())
514 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
515 visitIntrinsicFunctionCall(ID, CI);
517 visitInstruction(CI);
520 /// visitBinaryOperator - Check that both arguments to the binary operator are
521 /// of the same type!
523 void Verifier::visitBinaryOperator(BinaryOperator &B) {
524 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
525 "Both operands to a binary operator are not of the same type!", &B);
527 // Check that logical operators are only used with integral operands.
528 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
529 B.getOpcode() == Instruction::Xor) {
530 Assert1(B.getType()->isIntegral() ||
531 (isa<PackedType>(B.getType()) &&
532 cast<PackedType>(B.getType())->getElementType()->isIntegral()),
533 "Logical operators only work with integral types!", &B);
534 Assert1(B.getType() == B.getOperand(0)->getType(),
535 "Logical operators must have same type for operands and result!",
537 } else if (isa<SetCondInst>(B)) {
538 // Check that setcc instructions return bool
539 Assert1(B.getType() == Type::BoolTy,
540 "setcc instructions must return boolean values!", &B);
542 // Arithmetic operators only work on integer or fp values
543 Assert1(B.getType() == B.getOperand(0)->getType(),
544 "Arithmetic operators must have same type for operands and result!",
546 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
547 isa<PackedType>(B.getType()),
548 "Arithmetic operators must have integer, fp, or packed type!", &B);
554 void Verifier::visitShiftInst(ShiftInst &SI) {
555 Assert1(SI.getType()->isInteger(),
556 "Shift must return an integer result!", &SI);
557 Assert1(SI.getType() == SI.getOperand(0)->getType(),
558 "Shift return type must be same as first operand!", &SI);
559 Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
560 "Second operand to shift must be ubyte type!", &SI);
561 visitInstruction(SI);
564 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
565 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
567 "Invalid extractelement operands!", &EI);
568 visitInstruction(EI);
571 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
572 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
575 "Invalid insertelement operands!", &IE);
576 visitInstruction(IE);
579 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
580 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
582 "Invalid shufflevector operands!", &SV);
583 Assert1(SV.getType() == SV.getOperand(0)->getType(),
584 "Result of shufflevector must match first operand type!", &SV);
586 // Check to see if Mask is valid.
587 if (const ConstantPacked *MV = dyn_cast<ConstantPacked>(SV.getOperand(2))) {
588 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
589 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
590 isa<UndefValue>(MV->getOperand(i)),
591 "Invalid shufflevector shuffle mask!", &SV);
594 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
595 isa<ConstantAggregateZero>(SV.getOperand(2)),
596 "Invalid shufflevector shuffle mask!", &SV);
599 visitInstruction(SV);
602 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
604 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
605 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
606 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
607 Assert2(PointerType::get(ElTy) == GEP.getType(),
608 "GEP is not of right type for indices!", &GEP, ElTy);
609 visitInstruction(GEP);
612 void Verifier::visitLoadInst(LoadInst &LI) {
614 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
615 Assert2(ElTy == LI.getType(),
616 "Load result type does not match pointer operand type!", &LI, ElTy);
617 visitInstruction(LI);
620 void Verifier::visitStoreInst(StoreInst &SI) {
622 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
623 Assert2(ElTy == SI.getOperand(0)->getType(),
624 "Stored value type does not match pointer operand type!", &SI, ElTy);
625 visitInstruction(SI);
629 /// verifyInstruction - Verify that an instruction is well formed.
631 void Verifier::visitInstruction(Instruction &I) {
632 BasicBlock *BB = I.getParent();
633 Assert1(BB, "Instruction not embedded in basic block!", &I);
635 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
636 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
638 Assert1(*UI != (User*)&I ||
639 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
640 "Only PHI nodes may reference their own value!", &I);
643 // Check that void typed values don't have names
644 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
645 "Instruction has a name, but provides a void value!", &I);
647 // Check that the return value of the instruction is either void or a legal
649 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
650 "Instruction returns a non-scalar type!", &I);
652 // Check that all uses of the instruction, if they are instructions
653 // themselves, actually have parent basic blocks. If the use is not an
654 // instruction, it is an error!
655 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
657 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
659 Instruction *Used = cast<Instruction>(*UI);
660 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
661 " embeded in a basic block!", &I, Used);
664 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
665 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
667 // Check to make sure that only first-class-values are operands to
669 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
670 "Instruction operands must be first-class values!", &I);
672 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
673 // Check to make sure that the "address of" an intrinsic function is never
675 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
676 "Cannot take the address of an intrinsic!", &I);
677 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
678 Assert1(OpBB->getParent() == BB->getParent(),
679 "Referring to a basic block in another function!", &I);
680 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
681 Assert1(OpArg->getParent() == BB->getParent(),
682 "Referring to an argument in another function!", &I);
683 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
684 BasicBlock *OpBlock = Op->getParent();
686 // Check that a definition dominates all of its uses.
687 if (!isa<PHINode>(I)) {
688 // Invoke results are only usable in the normal destination, not in the
689 // exceptional destination.
690 if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
691 OpBlock = II->getNormalDest();
692 else if (OpBlock == BB) {
693 // If they are in the same basic block, make sure that the definition
694 // comes before the use.
695 Assert2(InstsInThisBlock.count(Op) ||
696 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
697 "Instruction does not dominate all uses!", Op, &I);
700 // Definition must dominate use unless use is unreachable!
701 Assert2(EF->dominates(OpBlock, BB) ||
702 !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
703 "Instruction does not dominate all uses!", Op, &I);
705 // PHI nodes are more difficult than other nodes because they actually
706 // "use" the value in the predecessor basic blocks they correspond to.
707 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
708 Assert2(EF->dominates(OpBlock, PredBB) ||
709 !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
710 "Instruction does not dominate all uses!", Op, &I);
712 } else if (isa<InlineAsm>(I.getOperand(i))) {
713 Assert1(i == 0 && isa<CallInst>(I),
714 "Cannot take the address of an inline asm!", &I);
717 InstsInThisBlock.insert(&I);
720 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
722 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
723 Function *IF = CI.getCalledFunction();
724 Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
726 #define GET_INTRINSIC_VERIFIER
727 #include "llvm/Intrinsics.gen"
728 #undef GET_INTRINSIC_VERIFIER
731 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
732 /// Intrinsics.gen. This implements a little state machine that verifies the
733 /// prototype of intrinsics.
734 void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
738 const FunctionType *FTy = F->getFunctionType();
740 // Note that "arg#0" is the return type.
741 for (unsigned ArgNo = 0; 1; ++ArgNo) {
742 int TypeID = va_arg(VA, int);
745 if (ArgNo != FTy->getNumParams()+1)
746 CheckFailed("Intrinsic prototype has too many arguments!", F);
750 if (ArgNo == FTy->getNumParams()+1) {
751 CheckFailed("Intrinsic prototype has too few arguments!", F);
757 Ty = FTy->getReturnType();
759 Ty = FTy->getParamType(ArgNo-1);
761 if (Ty->getTypeID() != TypeID) {
763 CheckFailed("Intrinsic prototype has incorrect result type!", F);
765 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
769 // If this is a packed argument, verify the number and type of elements.
770 if (TypeID == Type::PackedTyID) {
771 const PackedType *PTy = cast<PackedType>(Ty);
772 if (va_arg(VA, int) != PTy->getElementType()->getTypeID()) {
773 CheckFailed("Intrinsic prototype has incorrect vector element type!",F);
777 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
778 CheckFailed("Intrinsic prototype has incorrect number of "
779 "vector elements!",F);
789 //===----------------------------------------------------------------------===//
790 // Implement the public interfaces to this file...
791 //===----------------------------------------------------------------------===//
793 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
794 return new Verifier(action);
798 // verifyFunction - Create
799 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
800 Function &F = const_cast<Function&>(f);
801 assert(!F.isExternal() && "Cannot verify external functions");
803 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
804 Verifier *V = new Verifier(action);
810 /// verifyModule - Check a module for errors, printing messages on stderr.
811 /// Return true if the module is corrupt.
813 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
814 std::string *ErrorInfo) {
816 Verifier *V = new Verifier(action);
820 if (ErrorInfo && V->Broken)
821 *ErrorInfo = V->msgs.str();