295 lines
8.4 KiB
C++
295 lines
8.4 KiB
C++
//===- Pass.cpp - LLVM Pass Infrastructure Implementation -----------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the LLVM Pass infrastructure. It is primarily
|
|
// responsible with ensuring that passes are executed and batched together
|
|
// optimally.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Pass.h"
|
|
#include "llvm/PassRegistry.h"
|
|
#include "llvm/Assembly/PrintModulePass.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/PassNameParser.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
using namespace llvm;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Pass Implementation
|
|
//
|
|
|
|
Pass::Pass(PassKind K, char &pid) : Resolver(0), PassID(&pid), Kind(K) { }
|
|
|
|
// Force out-of-line virtual method.
|
|
Pass::~Pass() {
|
|
delete Resolver;
|
|
}
|
|
|
|
// Force out-of-line virtual method.
|
|
ModulePass::~ModulePass() { }
|
|
|
|
Pass *ModulePass::createPrinterPass(raw_ostream &O,
|
|
const std::string &Banner) const {
|
|
return createPrintModulePass(&O, false, Banner);
|
|
}
|
|
|
|
PassManagerType ModulePass::getPotentialPassManagerType() const {
|
|
return PMT_ModulePassManager;
|
|
}
|
|
|
|
bool Pass::mustPreserveAnalysisID(char &AID) const {
|
|
return Resolver->getAnalysisIfAvailable(&AID, true) != 0;
|
|
}
|
|
|
|
// dumpPassStructure - Implement the -debug-passes=Structure option
|
|
void Pass::dumpPassStructure(unsigned Offset) {
|
|
dbgs().indent(Offset*2) << getPassName() << "\n";
|
|
}
|
|
|
|
/// getPassName - Return a nice clean name for a pass. This usually
|
|
/// implemented in terms of the name that is registered by one of the
|
|
/// Registration templates, but can be overloaded directly.
|
|
///
|
|
const char *Pass::getPassName() const {
|
|
AnalysisID AID = getPassID();
|
|
const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(AID);
|
|
if (PI)
|
|
return PI->getPassName();
|
|
return "Unnamed pass: implement Pass::getPassName()";
|
|
}
|
|
|
|
void Pass::preparePassManager(PMStack &) {
|
|
// By default, don't do anything.
|
|
}
|
|
|
|
PassManagerType Pass::getPotentialPassManagerType() const {
|
|
// Default implementation.
|
|
return PMT_Unknown;
|
|
}
|
|
|
|
void Pass::getAnalysisUsage(AnalysisUsage &) const {
|
|
// By default, no analysis results are used, all are invalidated.
|
|
}
|
|
|
|
void Pass::releaseMemory() {
|
|
// By default, don't do anything.
|
|
}
|
|
|
|
void Pass::verifyAnalysis() const {
|
|
// By default, don't do anything.
|
|
}
|
|
|
|
void *Pass::getAdjustedAnalysisPointer(AnalysisID AID) {
|
|
return this;
|
|
}
|
|
|
|
ImmutablePass *Pass::getAsImmutablePass() {
|
|
return 0;
|
|
}
|
|
|
|
PMDataManager *Pass::getAsPMDataManager() {
|
|
return 0;
|
|
}
|
|
|
|
void Pass::setResolver(AnalysisResolver *AR) {
|
|
assert(!Resolver && "Resolver is already set");
|
|
Resolver = AR;
|
|
}
|
|
|
|
// print - Print out the internal state of the pass. This is called by Analyze
|
|
// to print out the contents of an analysis. Otherwise it is not necessary to
|
|
// implement this method.
|
|
//
|
|
void Pass::print(raw_ostream &O,const Module*) const {
|
|
O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
|
|
}
|
|
|
|
// dump - call print(cerr);
|
|
void Pass::dump() const {
|
|
print(dbgs(), 0);
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// ImmutablePass Implementation
|
|
//
|
|
// Force out-of-line virtual method.
|
|
ImmutablePass::~ImmutablePass() { }
|
|
|
|
void ImmutablePass::initializePass() {
|
|
// By default, don't do anything.
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// FunctionPass Implementation
|
|
//
|
|
|
|
Pass *FunctionPass::createPrinterPass(raw_ostream &O,
|
|
const std::string &Banner) const {
|
|
return createPrintFunctionPass(Banner, &O);
|
|
}
|
|
|
|
bool FunctionPass::doInitialization(Module &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
bool FunctionPass::doFinalization(Module &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
PassManagerType FunctionPass::getPotentialPassManagerType() const {
|
|
return PMT_FunctionPassManager;
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// BasicBlockPass Implementation
|
|
//
|
|
|
|
Pass *BasicBlockPass::createPrinterPass(raw_ostream &O,
|
|
const std::string &Banner) const {
|
|
|
|
llvm_unreachable("BasicBlockPass printing unsupported.");
|
|
return 0;
|
|
}
|
|
|
|
bool BasicBlockPass::doInitialization(Module &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
bool BasicBlockPass::doInitialization(Function &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
bool BasicBlockPass::doFinalization(Function &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
bool BasicBlockPass::doFinalization(Module &) {
|
|
// By default, don't do anything.
|
|
return false;
|
|
}
|
|
|
|
PassManagerType BasicBlockPass::getPotentialPassManagerType() const {
|
|
return PMT_BasicBlockPassManager;
|
|
}
|
|
|
|
const PassInfo *Pass::lookupPassInfo(const void *TI) {
|
|
return PassRegistry::getPassRegistry()->getPassInfo(TI);
|
|
}
|
|
|
|
const PassInfo *Pass::lookupPassInfo(StringRef Arg) {
|
|
return PassRegistry::getPassRegistry()->getPassInfo(Arg);
|
|
}
|
|
|
|
Pass *PassInfo::createPass() const {
|
|
assert((!isAnalysisGroup() || NormalCtor) &&
|
|
"No default implementation found for analysis group!");
|
|
assert(NormalCtor &&
|
|
"Cannot call createPass on PassInfo without default ctor!");
|
|
return NormalCtor();
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Analysis Group Implementation Code
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// RegisterAGBase implementation
|
|
//
|
|
RegisterAGBase::RegisterAGBase(const char *Name, const void *InterfaceID,
|
|
const void *PassID, bool isDefault)
|
|
: PassInfo(Name, InterfaceID) {
|
|
PassRegistry::getPassRegistry()->registerAnalysisGroup(InterfaceID, PassID,
|
|
*this, isDefault);
|
|
}
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// PassRegistrationListener implementation
|
|
//
|
|
|
|
// PassRegistrationListener ctor - Add the current object to the list of
|
|
// PassRegistrationListeners...
|
|
PassRegistrationListener::PassRegistrationListener() {
|
|
PassRegistry::getPassRegistry()->addRegistrationListener(this);
|
|
}
|
|
|
|
// dtor - Remove object from list of listeners...
|
|
PassRegistrationListener::~PassRegistrationListener() {
|
|
PassRegistry::getPassRegistry()->removeRegistrationListener(this);
|
|
}
|
|
|
|
// enumeratePasses - Iterate over the registered passes, calling the
|
|
// passEnumerate callback on each PassInfo object.
|
|
//
|
|
void PassRegistrationListener::enumeratePasses() {
|
|
PassRegistry::getPassRegistry()->enumerateWith(this);
|
|
}
|
|
|
|
PassNameParser::~PassNameParser() {}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// AnalysisUsage Class Implementation
|
|
//
|
|
|
|
namespace {
|
|
struct GetCFGOnlyPasses : public PassRegistrationListener {
|
|
typedef AnalysisUsage::VectorType VectorType;
|
|
VectorType &CFGOnlyList;
|
|
GetCFGOnlyPasses(VectorType &L) : CFGOnlyList(L) {}
|
|
|
|
void passEnumerate(const PassInfo *P) {
|
|
if (P->isCFGOnlyPass())
|
|
CFGOnlyList.push_back(P->getTypeInfo());
|
|
}
|
|
};
|
|
}
|
|
|
|
// setPreservesCFG - This function should be called to by the pass, iff they do
|
|
// not:
|
|
//
|
|
// 1. Add or remove basic blocks from the function
|
|
// 2. Modify terminator instructions in any way.
|
|
//
|
|
// This function annotates the AnalysisUsage info object to say that analyses
|
|
// that only depend on the CFG are preserved by this pass.
|
|
//
|
|
void AnalysisUsage::setPreservesCFG() {
|
|
// Since this transformation doesn't modify the CFG, it preserves all analyses
|
|
// that only depend on the CFG (like dominators, loop info, etc...)
|
|
GetCFGOnlyPasses(Preserved).enumeratePasses();
|
|
}
|
|
|
|
AnalysisUsage &AnalysisUsage::addPreserved(StringRef Arg) {
|
|
const PassInfo *PI = Pass::lookupPassInfo(Arg);
|
|
// If the pass exists, preserve it. Otherwise silently do nothing.
|
|
if (PI) Preserved.push_back(PI->getTypeInfo());
|
|
return *this;
|
|
}
|
|
|
|
AnalysisUsage &AnalysisUsage::addRequiredID(const void *ID) {
|
|
Required.push_back(ID);
|
|
return *this;
|
|
}
|
|
|
|
AnalysisUsage &AnalysisUsage::addRequiredID(char &ID) {
|
|
Required.push_back(&ID);
|
|
return *this;
|
|
}
|
|
|
|
AnalysisUsage &AnalysisUsage::addRequiredTransitiveID(char &ID) {
|
|
Required.push_back(&ID);
|
|
RequiredTransitive.push_back(&ID);
|
|
return *this;
|
|
}
|