//===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
-//
+//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+//
//===----------------------------------------------------------------------===//
//
// This file defines the function verifier interface, that can be used for some
#include "llvm/Analysis/Verifier.h"
#include "llvm/Assembly/Writer.h"
+#include "llvm/CallingConv.h"
#include "llvm/Constants.h"
#include "llvm/Pass.h"
#include "llvm/Module.h"
#include "llvm/ModuleProvider.h"
#include "llvm/DerivedTypes.h"
+#include "llvm/InlineAsm.h"
#include "llvm/Instructions.h"
#include "llvm/Intrinsics.h"
#include "llvm/PassManager.h"
#include "llvm/Analysis/Dominators.h"
#include "llvm/Support/CFG.h"
#include "llvm/Support/InstVisitor.h"
+#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/STLExtras.h"
#include <algorithm>
#include <iostream>
#include <sstream>
+#include <cstdarg>
using namespace llvm;
namespace { // Anonymous namespace for class
VerifierFailureAction action;
// What to do if verification fails.
Module *Mod; // Module we are verifying right now
- DominatorSet *DS; // Dominator set, caution can be null!
+ ETForest *EF; // ET-Forest, caution can be null!
std::stringstream msgs; // A stringstream to collect messages
- Verifier()
+ /// InstInThisBlock - when verifying a basic block, keep track of all of the
+ /// instructions we have seen so far. This allows us to do efficient
+ /// dominance checks for the case when an instruction has an operand that is
+ /// an instruction in the same block.
+ std::set<Instruction*> InstsInThisBlock;
+
+ Verifier()
: Broken(false), RealPass(true), action(AbortProcessAction),
- DS(0), msgs( std::ios_base::app | std::ios_base::out ) {}
+ EF(0), msgs( std::ios::app | std::ios::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(true), action(ctn), EF(0),
+ msgs( std::ios::app | std::ios::out ) {}
+ Verifier(bool AB )
+ : Broken(false), RealPass(true),
+ action( AB ? AbortProcessAction : PrintMessageAction), EF(0),
+ msgs( std::ios::app | std::ios::out ) {}
+ Verifier(ETForest &ef)
: Broken(false), RealPass(false), action(PrintMessageAction),
- DS(&ds), msgs( std::ios_base::app | std::ios_base::out ) {}
+ EF(&ef), msgs( std::ios::app | std::ios::out ) {}
bool doInitialization(Module &M) {
bool runOnFunction(Function &F) {
// Get dominator information if we are being run by PassManager
- if (RealPass) DS = &getAnalysis<DominatorSet>();
+ if (RealPass) EF = &getAnalysis<ETForest>();
visit(F);
+ InstsInThisBlock.clear();
// 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
if (I->isExternal()) visitFunction(*I);
}
- for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
- visitGlobalValue(*I);
+ for (Module::global_iterator I = M.global_begin(), E = M.global_end();
+ I != E; ++I)
+ visitGlobalVariable(*I);
// If the module is broken, abort at this time.
abortIfBroken();
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
if (RealPass)
- AU.addRequired<DominatorSet>();
+ AU.addRequired<ETForest>();
}
/// abortIfBroken - If the module is broken and we are supposed to abort on
// Verification methods...
void verifySymbolTable(SymbolTable &ST);
void visitGlobalValue(GlobalValue &GV);
+ void visitGlobalVariable(GlobalVariable &GV);
void visitFunction(Function &F);
void visitBasicBlock(BasicBlock &BB);
void visitPHINode(PHINode &PN);
void visitBinaryOperator(BinaryOperator &B);
void visitShiftInst(ShiftInst &SI);
- void visitVANextInst(VANextInst &VAN) { visitInstruction(VAN); }
+ void visitExtractElementInst(ExtractElementInst &EI);
+ void visitInsertElementInst(InsertElementInst &EI);
void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
void visitCallInst(CallInst &CI);
void visitGetElementPtrInst(GetElementPtrInst &GEP);
void visitUserOp2(Instruction &I) { visitUserOp1(I); }
void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
+ void VerifyIntrinsicPrototype(Function *F, ...);
void WriteValue(const Value *V) {
if (!V) return;
Broken = true;
}
- void CheckFailed( const std::string& Message, const Value* V1,
+ void CheckFailed( const std::string& Message, const Value* V1,
const Type* T2, const Value* V3 = 0 ) {
msgs << Message << "\n";
WriteValue(V1);
}
}
+void Verifier::visitGlobalVariable(GlobalVariable &GV) {
+ if (GV.hasInitializer())
+ Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
+ "Global variable initializer type does not match global "
+ "variable type!", &GV);
+
+ visitGlobalValue(GV);
+}
+
+
// verifySymbolTable - Verify that a function or module symbol table is ok
//
void Verifier::verifySymbolTable(SymbolTable &ST) {
// Loop over all of the values in all type planes in the symbol table.
- for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
+ 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) {
// visitFunction - Verify that a function is ok.
//
void Verifier::visitFunction(Function &F) {
- // Check function arguments...
+ Assert1(!F.isVarArg() || F.getCallingConv() == CallingConv::C,
+ "Varargs functions must have C calling conventions!", &F);
+
+ // Check function arguments.
const FunctionType *FT = F.getFunctionType();
unsigned NumArgs = F.getArgumentList().size();
// 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::arg_iterator I = F.arg_begin(), E = F.arg_end(); 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(),
+ Assert1(I->getType()->isFirstClassType(),
"Functions cannot take aggregates as arguments by value!", I);
}
// verifyBasicBlock - Verify that a basic block is well formed...
//
void Verifier::visitBasicBlock(BasicBlock &BB) {
+ InstsInThisBlock.clear();
+
+ // Ensure that basic blocks have terminators!
+ Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
+
// Check constraints that this basic block imposes on all of the PHI nodes in
// it.
if (isa<PHINode>(BB.front())) {
std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
std::sort(Preds.begin(), Preds.end());
- PHINode *PN;
+ 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() == 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;
Values.reserve(PN->getNumIncomingValues());
Values.push_back(std::make_pair(PN->getIncomingBlock(i),
PN->getIncomingValue(i)));
std::sort(Values.begin(), Values.end());
-
+
for (unsigned i = 0, e = Values.size(); i != e; ++i) {
// Check to make sure that if there is more than one entry for a
// particular basic block in this PHI node, that the incoming values are
"PHI node has multiple entries for the same basic block with "
"different incoming values!", PN, Values[i].first,
Values[i].second, Values[i-1].second);
-
+
// Check to make sure that the predecessors and PHI node entries are
// matched up.
Assert3(Values[i].first == Preds[i],
"PHI node entries do not match predecessors!", PN,
- Values[i].first, Preds[i]);
+ Values[i].first, Preds[i]);
}
}
}
-
- // Ensure that basic blocks have terminators!
- Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
}
void Verifier::visitTerminatorInst(TerminatorInst &I) {
void Verifier::visitReturnInst(ReturnInst &RI) {
Function *F = RI.getParent()->getParent();
if (RI.getNumOperands() == 0)
- Assert1(F->getReturnType() == Type::VoidTy,
- "Function returns no value, but ret instruction found that does!",
- &RI);
+ Assert2(F->getReturnType() == Type::VoidTy,
+ "Found return instr that returns void in Function of non-void "
+ "return type!", &RI, F->getReturnType());
else
Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
"Function return type does not match operand "
"Select values must have identical types!", &SI);
Assert1(SI.getTrueValue()->getType() == SI.getType(),
"Select values must have same type as select instruction!", &SI);
+ visitInstruction(SI);
}
/// 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);
+ Assert1(0, "User-defined operators should not live outside of a pass!", &I);
}
/// visitPHINode - Ensure that a PHI node is well formed.
// Check that logical operators are only used with integral operands.
if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
B.getOpcode() == Instruction::Xor) {
- Assert1(B.getType()->isIntegral(),
+ Assert1(B.getType()->isIntegral() ||
+ (isa<PackedType>(B.getType()) &&
+ cast<PackedType>(B.getType())->getElementType()->isIntegral()),
"Logical operators only work with integral types!", &B);
Assert1(B.getType() == B.getOperand(0)->getType(),
"Logical operators must have same type for operands and result!",
Assert1(B.getType() == B.getOperand(0)->getType(),
"Arithmetic operators must have same type for operands and result!",
&B);
- Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
+ Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
isa<PackedType>(B.getType()),
"Arithmetic operators must have integer, fp, or packed type!", &B);
}
-
+
visitInstruction(B);
}
visitInstruction(SI);
}
+void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
+ Assert1(isa<PackedType>(EI.getOperand(0)->getType()),
+ "First operand to extractelement must be packed type!", &EI);
+ Assert1(EI.getOperand(1)->getType() == Type::UIntTy,
+ "Second operand to extractelement must be uint type!", &EI);
+ Assert1(EI.getType() ==
+ cast<PackedType>(EI.getOperand(0)->getType())->getElementType(),
+ "Extractelement return type must match "
+ "first operand element type!", &EI);
+ visitInstruction(EI);
+}
+
+void Verifier::visitInsertElementInst(InsertElementInst &IE) {
+ Assert1(isa<PackedType>(IE.getOperand(0)->getType()),
+ "First operand to insertelement must be packed type!", &IE);
+ Assert1(IE.getOperand(1)->getType() ==
+ cast<PackedType>(IE.getOperand(0)->getType())->getElementType(),
+ "Second operand to insertelement must match "
+ "first operand element type!", &IE);
+ Assert1(IE.getOperand(2)->getType() == Type::UIntTy,
+ "Third operand to insertelement must be uint type!", &IE);
+ visitInstruction(IE);
+}
+
void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
const Type *ElTy =
GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
/// verifyInstruction - Verify that an instruction is well formed.
///
void Verifier::visitInstruction(Instruction &I) {
- BasicBlock *BB = I.getParent();
+ 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 ||
- !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
+ !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
"Only PHI nodes may reference their own value!", &I);
}
for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
// Check to make sure that the "address of" an intrinsic function is never
// taken.
+ Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &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 (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),
+ Assert2(InstsInThisBlock.count(Op) ||
+ !EF->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) ||
- !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
+ Assert2(EF->dominates(OpBlock, BB) ||
+ !EF->dominates(&BB->getParent()->getEntryBlock(), BB),
"Instruction does not dominate all uses!", Op, &I);
} else {
// PHI nodes are more difficult than other nodes because they actually
// "use" the value in the predecessor basic blocks they correspond to.
BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
- Assert2(DS->dominates(OpBlock, PredBB) ||
- !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
+ Assert2(EF->dominates(OpBlock, PredBB) ||
+ !EF->dominates(&BB->getParent()->getEntryBlock(), PredBB),
"Instruction does not dominate all uses!", Op, &I);
}
+ } else if (isa<InlineAsm>(I.getOperand(i))) {
+ Assert1(i == 0 && isa<CallInst>(I),
+ "Cannot take the address of an inline asm!", &I);
}
}
+ InstsInThisBlock.insert(&I);
}
/// 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();
+ const FunctionType *FTy = IF->getFunctionType();
Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
- unsigned NumArgs = 0;
-
- // FIXME: this should check the return type of each intrinsic as well, also
- // arguments!
- switch (ID) {
- 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::vaend: NumArgs = 1; break;
- case Intrinsic::vacopy: NumArgs = 1; break;
-
- case Intrinsic::returnaddress:
- case Intrinsic::frameaddress:
- Assert1(isa<PointerType>(FT->getReturnType()),
- "llvm.(frame|return)address must return pointers", IF);
- Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
- "llvm.(frame|return)address require a single constant integer argument",
- &CI);
- 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;
- }
+
+#define GET_INTRINSIC_VERIFIER
+#include "llvm/Intrinsics.gen"
+#undef GET_INTRINSIC_VERIFIER
+}
- 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;
- case Intrinsic::dbg_func_start: NumArgs = 1; break;
- case Intrinsic::dbg_declare: NumArgs = 1; break;
-
- case Intrinsic::memcpy: NumArgs = 4; break;
- case Intrinsic::memmove: NumArgs = 4; break;
- case Intrinsic::memset: NumArgs = 4; break;
-
- case Intrinsic::alpha_ctlz: NumArgs = 1; break;
- case Intrinsic::alpha_cttz: NumArgs = 1; break;
- case Intrinsic::alpha_ctpop: NumArgs = 1; break;
- case Intrinsic::alpha_umulh: NumArgs = 2; break;
- case Intrinsic::alpha_vecop: NumArgs = 4; break;
- case Intrinsic::alpha_pup: NumArgs = 3; break;
- case Intrinsic::alpha_bytezap: NumArgs = 2; break;
- case Intrinsic::alpha_bytemanip: NumArgs = 3; break;
- case Intrinsic::alpha_dfpbop: NumArgs = 3; break;
- case Intrinsic::alpha_dfpuop: NumArgs = 2; break;
- case Intrinsic::alpha_unordered: NumArgs = 2; break;
- case Intrinsic::alpha_uqtodfp: NumArgs = 2; break;
- case Intrinsic::alpha_uqtosfp: NumArgs = 2; break;
- case Intrinsic::alpha_dfptosq: NumArgs = 2; break;
- case Intrinsic::alpha_sfptosq: NumArgs = 2; break;
-
- case Intrinsic::not_intrinsic:
- assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
+/// VerifyIntrinsicPrototype - TableGen emits calls to this function into
+/// Intrinsics.gen. This implements a little state machine that verifies the
+/// prototype of intrinsics.
+void Verifier::VerifyIntrinsicPrototype(Function *F, ...) {
+ va_list VA;
+ va_start(VA, F);
+
+ const FunctionType *FTy = F->getFunctionType();
+
+ // Note that "arg#0" is the return type.
+ for (unsigned ArgNo = 0; 1; ++ArgNo) {
+ int TypeID = va_arg(VA, int);
+
+ if (TypeID == -1) {
+ if (ArgNo != FTy->getNumParams()+1)
+ CheckFailed("Intrinsic prototype has too many arguments!", F);
+ break;
+ }
+
+ if (ArgNo == FTy->getNumParams()+1) {
+ CheckFailed("Intrinsic prototype has too few arguments!", F);
+ break;
+ }
+
+ const Type *Ty;
+ if (ArgNo == 0)
+ Ty = FTy->getReturnType();
+ else
+ Ty = FTy->getParamType(ArgNo-1);
+
+ if (Ty->getTypeID() != TypeID) {
+ if (ArgNo == 0)
+ CheckFailed("Intrinsic prototype has incorrect result type!", F);
+ else
+ CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
+ break;
+ }
+
+ // If this is a packed argument, verify the number and type of elements.
+ if (TypeID == Type::PackedTyID) {
+ const PackedType *PTy = cast<PackedType>(Ty);
+ if (va_arg(VA, int) != PTy->getElementType()->getTypeID()) {
+ CheckFailed("Intrinsic prototype has incorrect vector element type!",F);
+ break;
+ }
+
+ if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
+ CheckFailed("Intrinsic prototype has incorrect number of "
+ "vector elements!",F);
+ break;
+ }
+ }
}
- Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
- FT->isVarArg()),
- "Illegal # arguments for intrinsic function!", IF);
+ va_end(VA);
}
}
-// verifyFunction - Create
+// verifyFunction - Create
bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
Function &F = const_cast<Function&>(f);
assert(!F.isExternal() && "Cannot verify external functions");
-
+
FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
Verifier *V = new Verifier(action);
FPM.add(V);