1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
3 // This file defines the function verifier interface, that can be used for some
4 // sanity checking of input to the system.
6 // Note that this does not provide full 'java style' security and verifications,
7 // instead it just tries to ensure that code is well formed.
9 // * Both of a binary operator's parameters are the same type
10 // * Verify that the indices of mem access instructions match other operands
11 // * Verify that arithmetic and other things are only performed on first class
12 // types. Verify that shifts & logicals only happen on integrals f.e.
13 // . All of the constants in a switch statement are of the correct type
14 // * The code is in valid SSA form
15 // . It should be illegal to put a label into any other type (like a structure)
16 // or to return one. [except constant arrays!]
17 // * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
18 // * PHI nodes must have an entry for each predecessor, with no extras.
19 // * PHI nodes must be the first thing in a basic block, all grouped together
20 // * PHI nodes must have at least one entry
21 // * All basic blocks should only end with terminator insts, not contain them
22 // * The entry node to a function must not have predecessors
23 // * All Instructions must be embeded into a basic block
24 // . Function's cannot take a void typed parameter
25 // * Verify that a function's argument list agrees with it's declared type.
26 // * It is illegal to specify a name for a void value.
27 // * It is illegal to have a internal global value with no intitalizer
28 // * It is illegal to have a ret instruction that returns a value that does not
29 // agree with the function return value type.
30 // * Function call argument types match the function prototype
31 // * All other things that are tested by asserts spread about the code...
33 //===----------------------------------------------------------------------===//
35 #include "llvm/Analysis/Verifier.h"
36 #include "llvm/Pass.h"
37 #include "llvm/Module.h"
38 #include "llvm/DerivedTypes.h"
39 #include "llvm/iPHINode.h"
40 #include "llvm/iTerminators.h"
41 #include "llvm/iOther.h"
42 #include "llvm/iOperators.h"
43 #include "llvm/iMemory.h"
44 #include "llvm/SymbolTable.h"
45 #include "llvm/PassManager.h"
46 #include "llvm/Analysis/Dominators.h"
47 #include "llvm/Support/CFG.h"
48 #include "llvm/Support/InstVisitor.h"
49 #include "Support/STLExtras.h"
52 namespace { // Anonymous namespace for class
54 struct Verifier : public FunctionPass, InstVisitor<Verifier> {
55 bool Broken; // Is this module found to be broken?
56 bool RealPass; // Are we not being run by a PassManager?
57 bool AbortBroken; // If broken, should it or should it not abort?
59 DominatorSet *DS; // Dominator set, caution can be null!
61 Verifier() : Broken(false), RealPass(true), AbortBroken(true), DS(0) {}
62 Verifier(bool AB) : Broken(false), RealPass(true), AbortBroken(AB), DS(0) {}
63 Verifier(DominatorSet &ds)
64 : Broken(false), RealPass(false), AbortBroken(false), DS(&ds) {}
67 bool doInitialization(Module &M) {
68 verifySymbolTable(M.getSymbolTable());
70 // If this is a real pass, in a pass manager, we must abort before
71 // returning back to the pass manager, or else the pass manager may try to
72 // run other passes on the broken module.
79 bool runOnFunction(Function &F) {
80 // Get dominator information if we are being run by PassManager
81 if (RealPass) DS = &getAnalysis<DominatorSet>();
84 // If this is a real pass, in a pass manager, we must abort before
85 // returning back to the pass manager, or else the pass manager may try to
86 // run other passes on the broken module.
94 bool doFinalization(Module &M) {
95 // Scan through, checking all of the external function's linkage now...
96 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
99 for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
100 if (I->isExternal() && I->hasInternalLinkage())
101 CheckFailed("Global Variable is external with internal linkage!", I);
103 // If the module is broken, abort at this time.
108 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
109 AU.setPreservesAll();
111 AU.addRequired<DominatorSet>();
114 // abortIfBroken - If the module is broken and we are supposed to abort on
115 // this condition, do so.
117 void abortIfBroken() const {
118 if (Broken && AbortBroken) {
119 std::cerr << "Broken module found, compilation aborted!\n";
125 // Verification methods...
126 void verifySymbolTable(SymbolTable &ST);
127 void visitGlobalValue(GlobalValue &GV);
128 void visitFunction(Function &F);
129 void visitBasicBlock(BasicBlock &BB);
130 void visitPHINode(PHINode &PN);
131 void visitBinaryOperator(BinaryOperator &B);
132 void visitShiftInst(ShiftInst &SI);
133 void visitCallInst(CallInst &CI);
134 void visitGetElementPtrInst(GetElementPtrInst &GEP);
135 void visitLoadInst(LoadInst &LI);
136 void visitStoreInst(StoreInst &SI);
137 void visitInstruction(Instruction &I);
138 void visitTerminatorInst(TerminatorInst &I);
139 void visitReturnInst(ReturnInst &RI);
140 void visitUserOp1(Instruction &I);
141 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
143 // CheckFailed - A check failed, so print out the condition and the message
144 // that failed. This provides a nice place to put a breakpoint if you want
145 // to see why something is not correct.
147 inline void CheckFailed(const std::string &Message,
148 const Value *V1 = 0, const Value *V2 = 0,
149 const Value *V3 = 0, const Value *V4 = 0) {
150 std::cerr << Message << "\n";
151 if (V1) std::cerr << *V1 << "\n";
152 if (V2) std::cerr << *V2 << "\n";
153 if (V3) std::cerr << *V3 << "\n";
154 if (V4) std::cerr << *V4 << "\n";
159 RegisterPass<Verifier> X("verify", "Module Verifier");
162 // Assert - We know that cond should be true, if not print an error message.
163 #define Assert(C, M) \
164 do { if (!(C)) { CheckFailed(M); return; } } while (0)
165 #define Assert1(C, M, V1) \
166 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
167 #define Assert2(C, M, V1, V2) \
168 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
169 #define Assert3(C, M, V1, V2, V3) \
170 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
171 #define Assert4(C, M, V1, V2, V3, V4) \
172 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
175 void Verifier::visitGlobalValue(GlobalValue &GV) {
176 Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
177 "Global value has Internal Linkage!", &GV);
178 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
179 "Only global variables can have appending linkage!", &GV);
181 if (GV.hasAppendingLinkage()) {
182 GlobalVariable &GVar = cast<GlobalVariable>(GV);
183 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
184 "Only global arrays can have appending linkage!", &GV);
188 // verifySymbolTable - Verify that a function or module symbol table is ok
190 void Verifier::verifySymbolTable(SymbolTable &ST) {
191 // Loop over all of the types in the symbol table...
192 for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
193 for (SymbolTable::type_iterator I = TI->second.begin(),
194 E = TI->second.end(); I != E; ++I) {
195 Value *V = I->second;
197 // Check that there are no void typed values in the symbol table. Values
198 // with a void type cannot be put into symbol tables because they cannot
200 Assert1(V->getType() != Type::VoidTy,
201 "Values with void type are not allowed to have names!", V);
206 // visitFunction - Verify that a function is ok.
208 void Verifier::visitFunction(Function &F) {
209 // Check function arguments...
210 const FunctionType *FT = F.getFunctionType();
211 unsigned NumArgs = F.getArgumentList().size();
213 Assert2(FT->getNumParams() == NumArgs,
214 "# formal arguments must match # of arguments for function type!",
217 // Check that the argument values match the function type for this function...
219 for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
220 Assert2(I->getType() == FT->getParamType(i),
221 "Argument value does not match function argument type!",
222 I, FT->getParamType(i));
224 if (!F.isExternal()) {
225 verifySymbolTable(F.getSymbolTable());
227 // Check the entry node
228 BasicBlock *Entry = &F.getEntryNode();
229 Assert1(pred_begin(Entry) == pred_end(Entry),
230 "Entry block to function must not have predecessors!", Entry);
235 // verifyBasicBlock - Verify that a basic block is well formed...
237 void Verifier::visitBasicBlock(BasicBlock &BB) {
238 // Ensure that basic blocks have terminators!
239 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
242 void Verifier::visitTerminatorInst(TerminatorInst &I) {
243 // Ensure that terminators only exist at the end of the basic block.
244 Assert1(&I == I.getParent()->getTerminator(),
245 "Terminator found in the middle of a basic block!", I.getParent());
249 void Verifier::visitReturnInst(ReturnInst &RI) {
250 Function *F = RI.getParent()->getParent();
251 if (RI.getNumOperands() == 0)
252 Assert1(F->getReturnType() == Type::VoidTy,
253 "Function returns no value, but ret instruction found that does!",
256 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
257 "Function return type does not match operand "
258 "type of return inst!", &RI, F->getReturnType());
260 // Check to make sure that the return value has neccesary properties for
262 visitTerminatorInst(RI);
265 // visitUserOp1 - User defined operators shouldn't live beyond the lifetime of a
266 // pass, if any exist, it's an error.
268 void Verifier::visitUserOp1(Instruction &I) {
269 Assert1(0, "User-defined operators should not live outside of a pass!",
273 // visitPHINode - Ensure that a PHI node is well formed.
274 void Verifier::visitPHINode(PHINode &PN) {
275 // Ensure that the PHI nodes are all grouped together at the top of the block.
276 // This can be tested by checking whether the instruction before this is
277 // either nonexistant (because this is begin()) or is a PHI node. If not,
278 // then there is some other instruction before a PHI.
279 Assert2(PN.getPrev() == 0 || isa<PHINode>(PN.getPrev()),
280 "PHI nodes not grouped at top of basic block!",
281 &PN, PN.getParent());
283 // Ensure that PHI nodes have at least one entry!
284 Assert1(PN.getNumIncomingValues() != 0,
285 "PHI nodes must have at least one entry. If the block is dead, "
286 "the PHI should be removed!",
289 std::vector<BasicBlock*> Preds(pred_begin(PN.getParent()),
290 pred_end(PN.getParent()));
291 // Loop over all of the incoming values, make sure that there are
292 // predecessors for each one...
294 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
295 // Make sure all of the incoming values are the right types...
296 Assert2(PN.getType() == PN.getIncomingValue(i)->getType(),
297 "PHI node argument type does not agree with PHI node type!",
298 &PN, PN.getIncomingValue(i));
300 BasicBlock *BB = PN.getIncomingBlock(i);
301 std::vector<BasicBlock*>::iterator PI =
302 find(Preds.begin(), Preds.end(), BB);
303 Assert2(PI != Preds.end(), "PHI node has entry for basic block that"
304 " is not a predecessor!", &PN, BB);
308 // There should be no entries left in the predecessor list...
309 for (std::vector<BasicBlock*>::iterator I = Preds.begin(),
310 E = Preds.end(); I != E; ++I)
311 Assert2(0, "PHI node does not have entry for a predecessor basic block!",
314 // Now we go through and check to make sure that if there is more than one
315 // entry for a particular basic block in this PHI node, that the incoming
316 // values are all identical.
318 std::vector<std::pair<BasicBlock*, Value*> > Values;
319 Values.reserve(PN.getNumIncomingValues());
320 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
321 Values.push_back(std::make_pair(PN.getIncomingBlock(i),
322 PN.getIncomingValue(i)));
324 // Sort the Values vector so that identical basic block entries are adjacent.
325 std::sort(Values.begin(), Values.end());
327 // Check for identical basic blocks with differing incoming values...
328 for (unsigned i = 1, e = PN.getNumIncomingValues(); i < e; ++i)
329 Assert4(Values[i].first != Values[i-1].first ||
330 Values[i].second == Values[i-1].second,
331 "PHI node has multiple entries for the same basic block with "
332 "different incoming values!", &PN, Values[i].first,
333 Values[i].second, Values[i-1].second);
335 visitInstruction(PN);
338 void Verifier::visitCallInst(CallInst &CI) {
339 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
340 "Called function must be a pointer!", &CI);
341 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
342 Assert1(isa<FunctionType>(FPTy->getElementType()),
343 "Called function is not pointer to function type!", &CI);
345 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
347 // Verify that the correct number of arguments are being passed
349 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
350 "Called function requires more parameters than were provided!",&CI);
352 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
353 "Incorrect number of arguments passed to called function!", &CI);
355 // Verify that all arguments to the call match the function type...
356 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
357 Assert2(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
358 "Call parameter type does not match function signature!",
359 CI.getOperand(i+1), FTy->getParamType(i));
361 visitInstruction(CI);
364 // visitBinaryOperator - Check that both arguments to the binary operator are
367 void Verifier::visitBinaryOperator(BinaryOperator &B) {
368 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
369 "Both operands to a binary operator are not of the same type!", &B);
371 // Check that logical operators are only used with integral operands.
372 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
373 B.getOpcode() == Instruction::Xor) {
374 Assert1(B.getType()->isIntegral(),
375 "Logical operators only work with integral types!", &B);
376 Assert1(B.getType() == B.getOperand(0)->getType(),
377 "Logical operators must have same type for operands and result!",
379 } else if (isa<SetCondInst>(B)) {
380 // Check that setcc instructions return bool
381 Assert1(B.getType() == Type::BoolTy,
382 "setcc instructions must return boolean values!", &B);
384 // Arithmetic operators only work on integer or fp values
385 Assert1(B.getType() == B.getOperand(0)->getType(),
386 "Arithmetic operators must have same type for operands and result!",
388 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
389 "Arithmetic operators must have integer or fp type!", &B);
395 void Verifier::visitShiftInst(ShiftInst &SI) {
396 Assert1(SI.getType()->isInteger(),
397 "Shift must return an integer result!", &SI);
398 Assert1(SI.getType() == SI.getOperand(0)->getType(),
399 "Shift return type must be same as first operand!", &SI);
400 Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
401 "Second operand to shift must be ubyte type!", &SI);
402 visitInstruction(SI);
407 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
409 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
410 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
411 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
412 Assert2(PointerType::get(ElTy) == GEP.getType(),
413 "GEP is not of right type for indices!", &GEP, ElTy);
414 visitInstruction(GEP);
417 void Verifier::visitLoadInst(LoadInst &LI) {
419 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
420 Assert2(ElTy == LI.getType(),
421 "Load is not of right type for indices!", &LI, ElTy);
422 visitInstruction(LI);
425 void Verifier::visitStoreInst(StoreInst &SI) {
427 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
428 Assert2(ElTy == SI.getOperand(0)->getType(),
429 "Stored value is not of right type for indices!", &SI, ElTy);
430 visitInstruction(SI);
434 // verifyInstruction - Verify that an instruction is well formed.
436 void Verifier::visitInstruction(Instruction &I) {
437 BasicBlock *BB = I.getParent();
438 Assert1(BB, "Instruction not embedded in basic block!", &I);
440 // Check that all uses of the instruction, if they are instructions
441 // themselves, actually have parent basic blocks. If the use is not an
442 // instruction, it is an error!
444 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
446 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
448 Instruction *Used = cast<Instruction>(*UI);
449 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
450 " embeded in a basic block!", &I, Used);
453 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
454 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
456 Assert1(*UI != (User*)&I,
457 "Only PHI nodes may reference their own value!", &I);
460 // Check that void typed values don't have names
461 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
462 "Instruction has a name, but provides a void value!", &I);
464 // Check that a definition dominates all of its uses.
466 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
468 Instruction *Use = cast<Instruction>(*UI);
470 // PHI nodes are more difficult than other nodes because they actually
471 // "use" the value in the predecessor basic blocks they correspond to.
472 if (PHINode *PN = dyn_cast<PHINode>(Use)) {
473 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
474 if (&I == PN->getIncomingValue(i)) {
475 // Make sure that I dominates the end of pred(i)
476 BasicBlock *Pred = PN->getIncomingBlock(i);
478 // Use must be dominated by by definition unless use is unreachable!
479 Assert2(DS->dominates(BB, Pred) ||
480 !DS->dominates(&BB->getParent()->getEntryNode(), Pred),
481 "Instruction does not dominate all uses!",
486 // Use must be dominated by by definition unless use is unreachable!
487 Assert2(DS->dominates(&I, Use) ||
488 !DS->dominates(&BB->getParent()->getEntryNode(),Use->getParent()),
489 "Instruction does not dominate all uses!", &I, Use);
495 //===----------------------------------------------------------------------===//
496 // Implement the public interfaces to this file...
497 //===----------------------------------------------------------------------===//
499 Pass *createVerifierPass() {
500 return new Verifier();
504 // verifyFunction - Create
505 bool verifyFunction(const Function &f) {
506 Function &F = (Function&)f;
507 assert(!F.isExternal() && "Cannot verify external functions");
510 DS.doInitialization(*F.getParent());
516 DS.doFinalization(*F.getParent());
521 // verifyModule - Check a module for errors, printing messages on stderr.
522 // Return true if the module is corrupt.
524 bool verifyModule(const Module &M) {
526 Verifier *V = new Verifier();