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)
97 if (I->isExternal() && I->hasInternalLinkage())
98 CheckFailed("Function Declaration has Internal Linkage!", I);
100 for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
101 if (I->isExternal() && I->hasInternalLinkage())
102 CheckFailed("Global Variable is external with internal linkage!", I);
104 // If the module is broken, abort at this time.
109 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
110 AU.setPreservesAll();
112 AU.addRequired<DominatorSet>();
115 // abortIfBroken - If the module is broken and we are supposed to abort on
116 // this condition, do so.
118 void abortIfBroken() const {
119 if (Broken && AbortBroken) {
120 std::cerr << "Broken module found, compilation aborted!\n";
125 // Verification methods...
126 void verifySymbolTable(SymbolTable &ST);
127 void visitFunction(Function &F);
128 void visitBasicBlock(BasicBlock &BB);
129 void visitPHINode(PHINode &PN);
130 void visitBinaryOperator(BinaryOperator &B);
131 void visitShiftInst(ShiftInst &SI);
132 void visitCallInst(CallInst &CI);
133 void visitGetElementPtrInst(GetElementPtrInst &GEP);
134 void visitLoadInst(LoadInst &LI);
135 void visitStoreInst(StoreInst &SI);
136 void visitInstruction(Instruction &I);
137 void visitTerminatorInst(TerminatorInst &I);
138 void visitReturnInst(ReturnInst &RI);
139 void visitUserOp1(Instruction &I);
140 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
142 // CheckFailed - A check failed, so print out the condition and the message
143 // that failed. This provides a nice place to put a breakpoint if you want
144 // to see why something is not correct.
146 inline void CheckFailed(const std::string &Message,
147 const Value *V1 = 0, const Value *V2 = 0,
148 const Value *V3 = 0, const Value *V4 = 0) {
149 std::cerr << Message << "\n";
150 if (V1) std::cerr << *V1 << "\n";
151 if (V2) std::cerr << *V2 << "\n";
152 if (V3) std::cerr << *V3 << "\n";
153 if (V4) std::cerr << *V4 << "\n";
158 RegisterPass<Verifier> X("verify", "Module Verifier");
161 // Assert - We know that cond should be true, if not print an error message.
162 #define Assert(C, M) \
163 do { if (!(C)) { CheckFailed(M); return; } } while (0)
164 #define Assert1(C, M, V1) \
165 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
166 #define Assert2(C, M, V1, V2) \
167 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
168 #define Assert3(C, M, V1, V2, V3) \
169 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
170 #define Assert4(C, M, V1, V2, V3, V4) \
171 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
174 // verifySymbolTable - Verify that a function or module symbol table is ok
176 void Verifier::verifySymbolTable(SymbolTable &ST) {
177 // Loop over all of the types in the symbol table...
178 for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
179 for (SymbolTable::type_iterator I = TI->second.begin(),
180 E = TI->second.end(); I != E; ++I) {
181 Value *V = I->second;
183 // Check that there are no void typed values in the symbol table. Values
184 // with a void type cannot be put into symbol tables because they cannot
186 Assert1(V->getType() != Type::VoidTy,
187 "Values with void type are not allowed to have names!", V);
192 // visitFunction - Verify that a function is ok.
194 void Verifier::visitFunction(Function &F) {
195 // Check function arguments...
196 const FunctionType *FT = F.getFunctionType();
197 unsigned NumArgs = F.getArgumentList().size();
199 Assert2(!FT->isVarArg(), "Cannot define varargs functions in LLVM!", &F, FT);
200 Assert2(FT->getNumParams() == NumArgs,
201 "# formal arguments must match # of arguments for function type!",
204 // Check that the argument values match the function type for this function...
206 for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
207 Assert2(I->getType() == FT->getParamType(i),
208 "Argument value does not match function argument type!",
209 I, FT->getParamType(i));
211 if (!F.isExternal()) {
212 verifySymbolTable(F.getSymbolTable());
214 // Check the entry node
215 BasicBlock *Entry = &F.getEntryNode();
216 Assert1(pred_begin(Entry) == pred_end(Entry),
217 "Entry block to function must not have predecessors!", Entry);
222 // verifyBasicBlock - Verify that a basic block is well formed...
224 void Verifier::visitBasicBlock(BasicBlock &BB) {
225 // Ensure that basic blocks have terminators!
226 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
229 void Verifier::visitTerminatorInst(TerminatorInst &I) {
230 // Ensure that terminators only exist at the end of the basic block.
231 Assert1(&I == I.getParent()->getTerminator(),
232 "Terminator found in the middle of a basic block!", I.getParent());
236 void Verifier::visitReturnInst(ReturnInst &RI) {
237 Function *F = RI.getParent()->getParent();
238 if (RI.getNumOperands() == 0)
239 Assert1(F->getReturnType() == Type::VoidTy,
240 "Function returns no value, but ret instruction found that does!",
243 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
244 "Function return type does not match operand "
245 "type of return inst!", &RI, F->getReturnType());
247 // Check to make sure that the return value has neccesary properties for
249 visitTerminatorInst(RI);
252 // visitUserOp1 - User defined operators shouldn't live beyond the lifetime of a
253 // pass, if any exist, it's an error.
255 void Verifier::visitUserOp1(Instruction &I) {
256 Assert1(0, "User-defined operators should not live outside of a pass!",
260 // visitPHINode - Ensure that a PHI node is well formed.
261 void Verifier::visitPHINode(PHINode &PN) {
262 // Ensure that the PHI nodes are all grouped together at the top of the block.
263 // This can be tested by checking whether the instruction before this is
264 // either nonexistant (because this is begin()) or is a PHI node. If not,
265 // then there is some other instruction before a PHI.
266 Assert2(PN.getPrev() == 0 || isa<PHINode>(PN.getPrev()),
267 "PHI nodes not grouped at top of basic block!",
268 &PN, PN.getParent());
270 // Ensure that PHI nodes have at least one entry!
271 Assert1(PN.getNumIncomingValues() != 0,
272 "PHI nodes must have at least one entry. If the block is dead, "
273 "the PHI should be removed!",
276 std::vector<BasicBlock*> Preds(pred_begin(PN.getParent()),
277 pred_end(PN.getParent()));
278 // Loop over all of the incoming values, make sure that there are
279 // predecessors for each one...
281 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
282 // Make sure all of the incoming values are the right types...
283 Assert2(PN.getType() == PN.getIncomingValue(i)->getType(),
284 "PHI node argument type does not agree with PHI node type!",
285 &PN, PN.getIncomingValue(i));
287 BasicBlock *BB = PN.getIncomingBlock(i);
288 std::vector<BasicBlock*>::iterator PI =
289 find(Preds.begin(), Preds.end(), BB);
290 Assert2(PI != Preds.end(), "PHI node has entry for basic block that"
291 " is not a predecessor!", &PN, BB);
295 // There should be no entries left in the predecessor list...
296 for (std::vector<BasicBlock*>::iterator I = Preds.begin(),
297 E = Preds.end(); I != E; ++I)
298 Assert2(0, "PHI node does not have entry for a predecessor basic block!",
301 // Now we go through and check to make sure that if there is more than one
302 // entry for a particular basic block in this PHI node, that the incoming
303 // values are all identical.
305 std::vector<std::pair<BasicBlock*, Value*> > Values;
306 Values.reserve(PN.getNumIncomingValues());
307 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
308 Values.push_back(std::make_pair(PN.getIncomingBlock(i),
309 PN.getIncomingValue(i)));
311 // Sort the Values vector so that identical basic block entries are adjacent.
312 std::sort(Values.begin(), Values.end());
314 // Check for identical basic blocks with differing incoming values...
315 for (unsigned i = 1, e = PN.getNumIncomingValues(); i < e; ++i)
316 Assert4(Values[i].first != Values[i-1].first ||
317 Values[i].second == Values[i-1].second,
318 "PHI node has multiple entries for the same basic block with "
319 "different incoming values!", &PN, Values[i].first,
320 Values[i].second, Values[i-1].second);
322 visitInstruction(PN);
325 void Verifier::visitCallInst(CallInst &CI) {
326 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
327 "Called function must be a pointer!", &CI);
328 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
329 Assert1(isa<FunctionType>(FPTy->getElementType()),
330 "Called function is not pointer to function type!", &CI);
332 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
334 // Verify that the correct number of arguments are being passed
336 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
337 "Called function requires more parameters than were provided!",&CI);
339 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
340 "Incorrect number of arguments passed to called function!", &CI);
342 // Verify that all arguments to the call match the function type...
343 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
344 Assert2(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
345 "Call parameter type does not match function signature!",
346 CI.getOperand(i+1), FTy->getParamType(i));
348 visitInstruction(CI);
351 // visitBinaryOperator - Check that both arguments to the binary operator are
354 void Verifier::visitBinaryOperator(BinaryOperator &B) {
355 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
356 "Both operands to a binary operator are not of the same type!", &B);
358 // Check that logical operators are only used with integral operands.
359 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
360 B.getOpcode() == Instruction::Xor) {
361 Assert1(B.getType()->isIntegral(),
362 "Logical operators only work with integral types!", &B);
363 Assert1(B.getType() == B.getOperand(0)->getType(),
364 "Logical operators must have same type for operands and result!",
366 } else if (isa<SetCondInst>(B)) {
367 // Check that setcc instructions return bool
368 Assert1(B.getType() == Type::BoolTy,
369 "setcc instructions must return boolean values!", &B);
371 // Arithmetic operators only work on integer or fp values
372 Assert1(B.getType() == B.getOperand(0)->getType(),
373 "Arithmetic operators must have same type for operands and result!",
375 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
376 "Arithmetic operators must have integer or fp type!", &B);
382 void Verifier::visitShiftInst(ShiftInst &SI) {
383 Assert1(SI.getType()->isInteger(),
384 "Shift must return an integer result!", &SI);
385 Assert1(SI.getType() == SI.getOperand(0)->getType(),
386 "Shift return type must be same as first operand!", &SI);
387 Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
388 "Second operand to shift must be ubyte type!", &SI);
389 visitInstruction(SI);
394 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
396 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
397 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
398 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
399 Assert2(PointerType::get(ElTy) == GEP.getType(),
400 "GEP is not of right type for indices!", &GEP, ElTy);
401 visitInstruction(GEP);
404 void Verifier::visitLoadInst(LoadInst &LI) {
406 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
407 Assert2(ElTy == LI.getType(),
408 "Load is not of right type for indices!", &LI, ElTy);
409 visitInstruction(LI);
412 void Verifier::visitStoreInst(StoreInst &SI) {
414 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
415 Assert2(ElTy == SI.getOperand(0)->getType(),
416 "Stored value is not of right type for indices!", &SI, ElTy);
417 visitInstruction(SI);
421 // verifyInstruction - Verify that an instruction is well formed.
423 void Verifier::visitInstruction(Instruction &I) {
424 BasicBlock *BB = I.getParent();
425 Assert1(BB, "Instruction not embedded in basic block!", &I);
427 // Check that all uses of the instruction, if they are instructions
428 // themselves, actually have parent basic blocks. If the use is not an
429 // instruction, it is an error!
431 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
433 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
435 Instruction *Used = cast<Instruction>(*UI);
436 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
437 " embeded in a basic block!", &I, Used);
440 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
441 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
443 Assert1(*UI != (User*)&I,
444 "Only PHI nodes may reference their own value!", &I);
447 // Check that void typed values don't have names
448 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
449 "Instruction has a name, but provides a void value!", &I);
451 // Check that a definition dominates all of its uses.
453 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
455 Instruction *Use = cast<Instruction>(*UI);
457 // PHI nodes are more difficult than other nodes because they actually
458 // "use" the value in the predecessor basic blocks they correspond to.
459 if (PHINode *PN = dyn_cast<PHINode>(Use)) {
460 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
461 if (&I == PN->getIncomingValue(i)) {
462 // Make sure that I dominates the end of pred(i)
463 BasicBlock *Pred = PN->getIncomingBlock(i);
465 // Use must be dominated by by definition unless use is unreachable!
466 Assert2(DS->dominates(BB, Pred) ||
467 !DS->dominates(&BB->getParent()->getEntryNode(), Pred),
468 "Instruction does not dominate all uses!",
473 // Use must be dominated by by definition unless use is unreachable!
474 Assert2(DS->dominates(&I, Use) ||
475 !DS->dominates(&BB->getParent()->getEntryNode(),Use->getParent()),
476 "Instruction does not dominate all uses!", &I, Use);
482 //===----------------------------------------------------------------------===//
483 // Implement the public interfaces to this file...
484 //===----------------------------------------------------------------------===//
486 Pass *createVerifierPass() {
487 return new Verifier();
491 // verifyFunction - Create
492 bool verifyFunction(const Function &f) {
493 Function &F = (Function&)f;
494 assert(!F.isExternal() && "Cannot verify external functions");
497 DS.doInitialization(*F.getParent());
503 DS.doFinalization(*F.getParent());
508 // verifyModule - Check a module for errors, printing messages on stderr.
509 // Return true if the module is corrupt.
511 bool verifyModule(const Module &M) {
513 Verifier *V = new Verifier();