// This file defines the function verifier interface, that can be used for some
// sanity checking of input to the system.
//
-// Note that this does not provide full 'java style' security and verifications,
-// instead it just tries to ensure that code is well formed.
+// Note that this does not provide full `Java style' security and verifications,
+// instead it just tries to ensure that code is well-formed.
//
-// * Both of a binary operator's parameters are the same type
+// * Both of a binary operator's parameters are of the same type
// * Verify that the indices of mem access instructions match other operands
-// * Verify that arithmetic and other things are only performed on first class
+// * Verify that arithmetic and other things are only performed on first-class
// types. Verify that shifts & logicals only happen on integrals f.e.
-// . All of the constants in a switch statement are of the correct type
+// * All of the constants in a switch statement are of the correct type
// * The code is in valid SSA form
-// . It should be illegal to put a label into any other type (like a structure)
+// * It should be illegal to put a label into any other type (like a structure)
// or to return one. [except constant arrays!]
// * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
// * PHI nodes must have an entry for each predecessor, with no extras.
// * All basic blocks should only end with terminator insts, not contain them
// * The entry node to a function must not have predecessors
// * All Instructions must be embedded into a basic block
-// . Function's cannot take a void typed parameter
+// * Functions cannot take a void-typed parameter
// * Verify that a function's argument list agrees with it's declared type.
// * It is illegal to specify a name for a void value.
// * It is illegal to have a internal global value with no initializer
#include "llvm/Constants.h"
#include "llvm/Pass.h"
#include "llvm/Module.h"
+#include "llvm/ModuleProvider.h"
#include "llvm/DerivedTypes.h"
#include "llvm/Instructions.h"
#include "llvm/Intrinsics.h"
#include "llvm/Support/InstVisitor.h"
#include "Support/STLExtras.h"
#include <algorithm>
+#include <iostream>
+#include <sstream>
using namespace llvm;
namespace { // Anonymous namespace for class
struct Verifier : public FunctionPass, InstVisitor<Verifier> {
bool Broken; // Is this module found to be broken?
bool RealPass; // Are we not being run by a PassManager?
- bool AbortBroken; // If broken, should it or should it not abort?
- Module *Mod; // Module we are verifying right now
- DominatorSet *DS; // Dominator set, caution can be null!
-
- Verifier() : Broken(false), RealPass(true), AbortBroken(true), DS(0) {}
- Verifier(bool AB) : Broken(false), RealPass(true), AbortBroken(AB), DS(0) {}
+ VerifierFailureAction action;
+ // What to do if verification fails.
+ Module *Mod; // Module we are verifying right now
+ DominatorSet *DS; // Dominator set, caution can be null!
+ std::stringstream msgs; // A stringstream to collect messages
+
+ Verifier()
+ : Broken(false), RealPass(true), action(AbortProcessAction),
+ DS(0), msgs( std::ios_base::app | std::ios_base::out ) {}
+ Verifier( VerifierFailureAction ctn )
+ : Broken(false), RealPass(true), action(ctn), DS(0),
+ msgs( std::ios_base::app | std::ios_base::out ) {}
+ Verifier(bool AB )
+ : Broken(false), RealPass(true),
+ action( AB ? AbortProcessAction : PrintMessageAction), DS(0),
+ msgs( std::ios_base::app | std::ios_base::out ) {}
Verifier(DominatorSet &ds)
- : Broken(false), RealPass(false), AbortBroken(false), DS(&ds) {}
+ : Broken(false), RealPass(false), action(PrintMessageAction),
+ DS(&ds), msgs( std::ios_base::app | std::ios_base::out ) {}
bool doInitialization(Module &M) {
// If this is a real pass, in a pass manager, we must abort before
// returning back to the pass manager, or else the pass manager may try to
// run other passes on the broken module.
- //
if (RealPass)
abortIfBroken();
return false;
// If this is a real pass, in a pass manager, we must abort before
// returning back to the pass manager, or else the pass manager may try to
// run other passes on the broken module.
- //
if (RealPass)
abortIfBroken();
bool doFinalization(Module &M) {
// Scan through, checking all of the external function's linkage now...
- for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
+ for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
visitGlobalValue(*I);
+ // Check to make sure function prototypes are okay.
+ if (I->isExternal()) visitFunction(*I);
+ }
+
for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
visitGlobalValue(*I);
AU.addRequired<DominatorSet>();
}
- // abortIfBroken - If the module is broken and we are supposed to abort on
- // this condition, do so.
- //
- void abortIfBroken() const {
- if (Broken && AbortBroken) {
- std::cerr << "Broken module found, compilation aborted!\n";
- abort();
+ /// abortIfBroken - If the module is broken and we are supposed to abort on
+ /// this condition, do so.
+ ///
+ void abortIfBroken() {
+ if (Broken)
+ {
+ msgs << "Broken module found, ";
+ switch (action)
+ {
+ case AbortProcessAction:
+ msgs << "compilation aborted!\n";
+ std::cerr << msgs.str();
+ abort();
+ case ThrowExceptionAction:
+ msgs << "verification terminated.\n";
+ throw msgs.str();
+ case PrintMessageAction:
+ msgs << "verification continues.\n";
+ std::cerr << msgs.str();
+ break;
+ case ReturnStatusAction:
+ break;
+ }
}
}
void visitInstruction(Instruction &I);
void visitTerminatorInst(TerminatorInst &I);
void visitReturnInst(ReturnInst &RI);
+ void visitSwitchInst(SwitchInst &SI);
+ void visitSelectInst(SelectInst &SI);
void visitUserOp1(Instruction &I);
void visitUserOp2(Instruction &I) { visitUserOp1(I); }
void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
void WriteValue(const Value *V) {
if (!V) return;
if (isa<Instruction>(V)) {
- std::cerr << *V;
- } else if (const Type *Ty = dyn_cast<Type>(V)) {
- WriteTypeSymbolic(std::cerr, Ty, Mod);
+ msgs << *V;
} else {
- WriteAsOperand (std::cerr, V, true, true, Mod);
- std::cerr << "\n";
+ WriteAsOperand (msgs, V, true, true, Mod);
+ msgs << "\n";
}
}
+ void WriteType(const Type* T ) {
+ if ( !T ) return;
+ WriteTypeSymbolic(msgs, T, Mod );
+ }
+
// CheckFailed - A check failed, so print out the condition and the message
// that failed. This provides a nice place to put a breakpoint if you want
// to see why something is not correct.
- //
void CheckFailed(const std::string &Message,
const Value *V1 = 0, const Value *V2 = 0,
const Value *V3 = 0, const Value *V4 = 0) {
- std::cerr << Message << "\n";
+ msgs << Message << "\n";
WriteValue(V1);
WriteValue(V2);
WriteValue(V3);
WriteValue(V4);
Broken = true;
}
+
+ void CheckFailed( const std::string& Message, const Value* V1,
+ const Type* T2, const Value* V3 = 0 ) {
+ msgs << Message << "\n";
+ WriteValue(V1);
+ WriteType(T2);
+ WriteValue(V3);
+ Broken = true;
+ }
};
RegisterOpt<Verifier> X("verify", "Module Verifier");
// verifySymbolTable - Verify that a function or module symbol table is ok
//
void Verifier::verifySymbolTable(SymbolTable &ST) {
- // Loop over all of the types in the symbol table...
- for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
- for (SymbolTable::type_iterator I = TI->second.begin(),
- E = TI->second.end(); I != E; ++I) {
- Value *V = I->second;
+ // Loop over all of the values in all type planes in the symbol table.
+ for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
+ PE = ST.plane_end(); PI != PE; ++PI)
+ for (SymbolTable::value_const_iterator VI = PI->second.begin(),
+ VE = PI->second.end(); VI != VE; ++VI) {
+ Value *V = VI->second;
// Check that there are no void typed values in the symbol table. Values
// with a void type cannot be put into symbol tables because they cannot
// have names!
Assert1(V->getType() != Type::VoidTy,
- "Values with void type are not allowed to have names!", V);
+ "Values with void type are not allowed to have names!", V);
}
}
-
// visitFunction - Verify that a function is ok.
//
void Verifier::visitFunction(Function &F) {
// Check that the argument values match the function type for this function...
unsigned i = 0;
- for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
+ for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i) {
Assert2(I->getType() == FT->getParamType(i),
"Argument value does not match function argument type!",
I, FT->getParamType(i));
+ // Make sure no aggregates are passed by value.
+ Assert1(I->getType()->isFirstClassType(),
+ "Functions cannot take aggregates as arguments by value!", I);
+ }
if (!F.isExternal()) {
verifySymbolTable(F.getSymbolTable());
if (isa<PHINode>(BB.front())) {
std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
std::sort(Preds.begin(), Preds.end());
-
- for (BasicBlock::iterator I = BB.begin();
- PHINode *PN = dyn_cast<PHINode>(I); ++I) {
+ PHINode *PN;
+ for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
// Ensure that PHI nodes have at least one entry!
Assert1(PN->getNumIncomingValues() != 0,
"PHI nodes must have at least one entry. If the block is dead, "
"the PHI should be removed!", PN);
- Assert1(PN->getNumIncomingValues() >= Preds.size(),
- "PHINode has more entries than the basic block has predecessors!",
- PN);
- Assert1(PN->getNumIncomingValues() <= Preds.size(),
- "PHINode has less entries than the basic block has predecessors!",
- PN);
+ Assert1(PN->getNumIncomingValues() == Preds.size(),
+ "PHINode should have one entry for each predecessor of its "
+ "parent basic block!", PN);
// Get and sort all incoming values in the PHI node...
std::vector<std::pair<BasicBlock*, Value*> > Values;
visitTerminatorInst(RI);
}
-// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of a
-// pass, if any exist, it's an error.
-//
+void Verifier::visitSwitchInst(SwitchInst &SI) {
+ // Check to make sure that all of the constants in the switch instruction
+ // have the same type as the switched-on value.
+ const Type *SwitchTy = SI.getCondition()->getType();
+ for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
+ Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
+ "Switch constants must all be same type as switch value!", &SI);
+
+ visitTerminatorInst(SI);
+}
+
+void Verifier::visitSelectInst(SelectInst &SI) {
+ Assert1(SI.getCondition()->getType() == Type::BoolTy,
+ "Select condition type must be bool!", &SI);
+ Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
+ "Select values must have identical types!", &SI);
+ Assert1(SI.getTrueValue()->getType() == SI.getType(),
+ "Select values must have same type as select instruction!", &SI);
+}
+
+
+/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
+/// a pass, if any exist, it's an error.
+///
void Verifier::visitUserOp1(Instruction &I) {
Assert1(0, "User-defined operators should not live outside of a pass!",
&I);
}
-// visitPHINode - Ensure that a PHI node is well formed.
+/// visitPHINode - Ensure that a PHI node is well formed.
+///
void Verifier::visitPHINode(PHINode &PN) {
// Ensure that the PHI nodes are all grouped together at the top of the block.
// This can be tested by checking whether the instruction before this is
visitInstruction(CI);
}
-// visitBinaryOperator - Check that both arguments to the binary operator are
-// of the same type!
-//
+/// visitBinaryOperator - Check that both arguments to the binary operator are
+/// of the same type!
+///
void Verifier::visitBinaryOperator(BinaryOperator &B) {
Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
"Both operands to a binary operator are not of the same type!", &B);
}
-// verifyInstruction - Verify that an instruction is well formed.
-//
+/// verifyInstruction - Verify that an instruction is well formed.
+///
void Verifier::visitInstruction(Instruction &I) {
BasicBlock *BB = I.getParent();
Assert1(BB, "Instruction not embedded in basic block!", &I);
if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
UI != UE; ++UI)
- Assert1(*UI != (User*)&I,
+ Assert1(*UI != (User*)&I ||
+ !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
"Only PHI nodes may reference their own value!", &I);
}
Assert1(I.getType() != Type::VoidTy || !I.hasName(),
"Instruction has a name, but provides a void value!", &I);
+ // Check that the return value of the instruction is either void or a legal
+ // value type.
+ Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
+ "Instruction returns a non-scalar type!", &I);
+
// Check that all uses of the instruction, if they are instructions
// themselves, actually have parent basic blocks. If the use is not an
// instruction, it is an error!
- //
for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
UI != UE; ++UI) {
Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
// Check to make sure that the "address of" an intrinsic function is never
// taken.
- if (Function *F = dyn_cast<Function>(I.getOperand(i)))
+ if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
"Cannot take the address of an intrinsic!", &I);
-
- else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
+ } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
+ Assert1(OpBB->getParent() == BB->getParent(),
+ "Referring to a basic block in another function!", &I);
+ } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
+ Assert1(OpArg->getParent() == BB->getParent(),
+ "Referring to an argument in another function!", &I);
+ } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
BasicBlock *OpBlock = Op->getParent();
// Check that a definition dominates all of its uses.
- //
if (!isa<PHINode>(I)) {
// Invoke results are only usable in the normal destination, not in the
// exceptional destination.
if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
OpBlock = II->getNormalDest();
+ else if (OpBlock == BB) {
+ // If they are in the same basic block, make sure that the definition
+ // comes before the use.
+ Assert2(DS->dominates(Op, &I) ||
+ !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
+ "Instruction does not dominate all uses!", Op, &I);
+ }
// Definition must dominate use unless use is unreachable!
Assert2(DS->dominates(OpBlock, BB) ||
}
/// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
+///
void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
Function *IF = CI.getCalledFunction();
const FunctionType *FT = IF->getFunctionType();
// FIXME: this should check the return type of each intrinsic as well, also
// arguments!
switch (ID) {
- case Intrinsic::va_start:
+ case Intrinsic::vastart:
Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
"llvm.va_start intrinsic may only occur in function with variable"
" args!", &CI);
NumArgs = 0;
break;
- case Intrinsic::va_end: NumArgs = 1; break;
- case Intrinsic::va_copy: NumArgs = 1; break;
+ case Intrinsic::vaend: NumArgs = 1; break;
+ case Intrinsic::vacopy: NumArgs = 1; break;
case Intrinsic::returnaddress:
case Intrinsic::frameaddress:
NumArgs = 1;
break;
+ // Verify that read and write port have integral parameters of the correct
+ // signed-ness.
+ case Intrinsic::writeport:
+ Assert1(FT->getNumParams() == 2,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(FT->getParamType(0)->isIntegral(),
+ "First argument not unsigned int!", IF);
+ Assert1(FT->getParamType(1)->isUnsigned(),
+ "First argument not unsigned int!", IF);
+ NumArgs = 2;
+ break;
+
+ case Intrinsic::writeio:
+ Assert1(FT->getNumParams() == 2,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(FT->getParamType(0)->isFirstClassType(),
+ "First argument not a first class type!", IF);
+ Assert1(isa<PointerType>(FT->getParamType(1)),
+ "Second argument not a pointer!", IF);
+ NumArgs = 2;
+ break;
+
+ case Intrinsic::readport:
+ Assert1(FT->getNumParams() == 1,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(FT->getReturnType()->isFirstClassType(),
+ "Return type is not a first class type!", IF);
+ Assert1(FT->getParamType(0)->isUnsigned(),
+ "First argument not unsigned int!", IF);
+ NumArgs = 1;
+ break;
+
+ case Intrinsic::readio: {
+ const PointerType *ParamType = dyn_cast<PointerType>(FT->getParamType(0));
+ const Type *ReturnType = FT->getReturnType();
+
+ Assert1(FT->getNumParams() == 1,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(ParamType, "First argument not a pointer!", IF);
+ Assert1(ParamType->getElementType() == ReturnType,
+ "Pointer type doesn't match return type!", IF);
+ NumArgs = 1;
+ break;
+ }
+
+ case Intrinsic::isunordered:
+ Assert1(FT->getNumParams() == 2,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(FT->getReturnType() == Type::BoolTy,
+ "Return type is not bool!", IF);
+ Assert1(FT->getParamType(0) == FT->getParamType(1),
+ "Arguments must be of the same type!", IF);
+ Assert1(FT->getParamType(0)->isFloatingPoint(),
+ "Argument is not a floating point type!", IF);
+ NumArgs = 2;
+ break;
+
case Intrinsic::setjmp: NumArgs = 1; break;
case Intrinsic::longjmp: NumArgs = 2; break;
case Intrinsic::sigsetjmp: NumArgs = 2; break;
case Intrinsic::siglongjmp: NumArgs = 2; break;
+ case Intrinsic::gcroot:
+ Assert1(FT->getNumParams() == 2,
+ "Illegal # arguments for intrinsic function!", IF);
+ Assert1(isa<Constant>(CI.getOperand(2)),
+ "Second argument to llvm.gcroot must be a constant!", &CI);
+ NumArgs = 2;
+ break;
+ case Intrinsic::gcread: NumArgs = 2; break;
+ case Intrinsic::gcwrite: NumArgs = 3; break;
+
case Intrinsic::dbg_stoppoint: NumArgs = 4; break;
case Intrinsic::dbg_region_start:NumArgs = 1; break;
case Intrinsic::dbg_region_end: NumArgs = 1; break;
// Implement the public interfaces to this file...
//===----------------------------------------------------------------------===//
-FunctionPass *llvm::createVerifierPass() {
- return new Verifier();
+FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
+ return new Verifier(action);
}
// verifyFunction - Create
-bool llvm::verifyFunction(const Function &f) {
- Function &F = (Function&)f;
+bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
+ Function &F = const_cast<Function&>(f);
assert(!F.isExternal() && "Cannot verify external functions");
-
- DominatorSet DS;
- DS.doInitialization(*F.getParent());
- DS.runOnFunction(F);
-
- Verifier V(DS);
- V.runOnFunction(F);
-
- DS.doFinalization(*F.getParent());
-
- return V.Broken;
+
+ FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
+ Verifier *V = new Verifier(action);
+ FPM.add(V);
+ FPM.run(F);
+ return V->Broken;
}
-// verifyModule - Check a module for errors, printing messages on stderr.
-// Return true if the module is corrupt.
-//
-bool llvm::verifyModule(const Module &M) {
+/// verifyModule - Check a module for errors, printing messages on stderr.
+/// Return true if the module is corrupt.
+///
+bool llvm::verifyModule(const Module &M, VerifierFailureAction action) {
PassManager PM;
- Verifier *V = new Verifier();
+ Verifier *V = new Verifier(action);
PM.add(V);
PM.run((Module&)M);
return V->Broken;
}
+
+// vim: sw=2
projects / oota-llvm.git / blobdiff