-//===- Pass.cpp - LLVM Pass Infrastructure Impementation ------------------===//
+//===- 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
//
//===----------------------------------------------------------------------===//
+#include "llvm/Pass.h"
#include "llvm/PassManager.h"
+#include "llvm/PassRegistry.h"
#include "llvm/Module.h"
-#include "llvm/Method.h"
-#include "Support/STLExtras.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/StringMap.h"
+#include "llvm/Assembly/PrintModulePass.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/PassNameParser.h"
+#include "llvm/Support/raw_ostream.h"
+#include "llvm/System/Atomic.h"
+#include "llvm/System/Mutex.h"
+#include "llvm/System/Threading.h"
#include <algorithm>
+#include <map>
+#include <set>
+using namespace llvm;
-// Source of unique analysis ID #'s.
-unsigned AnalysisID::NextID = 0;
-
-void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
- assert(P->Resolver == 0 && "Pass already in a PassManager!");
- P->Resolver = AR;
-}
-
-
-// Pass debugging information. Often it is useful to find out what pass is
-// running when a crash occurs in a utility. When this library is compiled with
-// debugging on, a command line option (--debug-pass) is enabled that causes the
-// pass name to be printed before it executes.
-//
-#ifndef NDEBUG
-#include "Support/CommandLine.h"
-#include <typeinfo>
-#include <iostream>
-
-// Different debug levels that can be enabled...
-enum PassDebugLevel {
- None, PassStructure, PassExecutions, PassDetails
-};
-
-static cl::Enum<enum PassDebugLevel> PassDebugging("debug-pass", cl::Hidden,
- "Print PassManager debugging information",
- clEnumVal(None , "disable debug output"),
- clEnumVal(PassStructure , "print pass structure before run()"),
- clEnumVal(PassExecutions, "print pass name before it is executed"),
- clEnumVal(PassDetails , "print pass details when it is executed"), 0);
-
-void PMDebug::PrintPassStructure(Pass *P) {
- if (PassDebugging >= PassStructure)
- P->dumpPassStructure();
-}
-
-void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
- Pass *P, Value *V) {
- if (PassDebugging >= PassExecutions) {
- std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
- << typeid(*P).name();
- if (V) {
- std::cerr << "' on ";
- switch (V->getValueType()) {
- case Value::ModuleVal:
- std::cerr << "Module\n"; return;
- case Value::MethodVal:
- std::cerr << "Method '" << V->getName(); break;
- case Value::BasicBlockVal:
- std::cerr << "BasicBlock '" << V->getName(); break;
- default:
- std::cerr << typeid(*V).name() << " '" << V->getName(); break;
- }
- }
- std::cerr << "'...\n";
- }
+//===----------------------------------------------------------------------===//
+// Pass Implementation
+//
+
+Pass::Pass(PassKind K, intptr_t pid) : Resolver(0), PassID(pid), Kind(K) {
+ assert(pid && "pid cannot be 0");
}
-void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
- Pass *P, const Pass::AnalysisSet &Set) {
- if (PassDebugging >= PassDetails && !Set.empty()) {
- std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
- for (unsigned i = 0; i < Set.size(); ++i) {
- Pass *P = Set[i].createPass(); // Good thing this is just debug code...
- std::cerr << " " << typeid(*P).name();
- delete P;
- }
- std::cerr << "\n";
- }
+Pass::Pass(PassKind K, const void *pid)
+ : Resolver(0), PassID((intptr_t)pid), Kind(K) {
+ assert(pid && "pid cannot be 0");
+}
+
+// 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(const PassInfo *AnalysisID) const {
+ return Resolver->getAnalysisIfAvailable(AnalysisID, 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 {
+ if (const PassInfo *PI = getPassInfo())
+ 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;
}
-// dumpPassStructure - Implement the -debug-passes=PassStructure option
-void Pass::dumpPassStructure(unsigned Offset = 0) {
- std::cerr << std::string(Offset*2, ' ') << typeid(*this).name() << "\n";
+void Pass::getAnalysisUsage(AnalysisUsage &) const {
+ // By default, no analysis results are used, all are invalidated.
}
-#endif
+void Pass::releaseMemory() {
+ // By default, don't do anything.
+}
+
+void Pass::verifyAnalysis() const {
+ // By default, don't do anything.
+}
+
+void *Pass::getAdjustedAnalysisPointer(const PassInfo *) {
+ 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);
+}
//===----------------------------------------------------------------------===//
-// Pass Implementation
+// ImmutablePass Implementation
//
+// Force out-of-line virtual method.
+ImmutablePass::~ImmutablePass() { }
-void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisSet &Required,
- AnalysisSet &Destroyed, AnalysisSet &Provided) {
- PM->addPass(this, Required, Destroyed, Provided);
+void ImmutablePass::initializePass() {
+ // By default, don't do anything.
}
//===----------------------------------------------------------------------===//
-// MethodPass Implementation
+// FunctionPass Implementation
//
-// run - On a module, we run this pass by initializing, ronOnMethod'ing once
-// for every method in the module, then by finalizing.
+Pass *FunctionPass::createPrinterPass(raw_ostream &O,
+ const std::string &Banner) const {
+ return createPrintFunctionPass(Banner, &O);
+}
+
+// run - On a module, we run this pass by initializing, runOnFunction'ing once
+// for every function in the module, then by finalizing.
//
-bool MethodPass::run(Module *M) {
+bool FunctionPass::runOnModule(Module &M) {
bool Changed = doInitialization(M);
-
- for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (!(*I)->isExternal()) // Passes are not run on external methods!
- Changed |= runOnMethod(*I);
-
+
+ for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
+ if (!I->isDeclaration()) // Passes are not run on external functions!
+ Changed |= runOnFunction(*I);
+
return Changed | doFinalization(M);
}
-// run - On a method, we simply initialize, run the method, then finalize.
+// run - On a function, we simply initialize, run the function, then finalize.
//
-bool MethodPass::run(Method *M) {
- if (M->isExternal()) return false; // Passes are not run on external methods!
+bool FunctionPass::run(Function &F) {
+ // Passes are not run on external functions!
+ if (F.isDeclaration()) return false;
+
+ bool Changed = doInitialization(*F.getParent());
+ Changed |= runOnFunction(F);
+ return Changed | doFinalization(*F.getParent());
+}
- return doInitialization(M->getParent()) | runOnMethod(M)
- | doFinalization(M->getParent());
+bool FunctionPass::doInitialization(Module &) {
+ // By default, don't do anything.
+ return false;
}
-void MethodPass::addToPassManager(PassManagerT<Module> *PM,
- AnalysisSet &Required, AnalysisSet &Destroyed,
- AnalysisSet &Provided) {
- PM->addPass(this, Required, Destroyed, Provided);
+bool FunctionPass::doFinalization(Module &) {
+ // By default, don't do anything.
+ return false;
}
-void MethodPass::addToPassManager(PassManagerT<Method> *PM,
- AnalysisSet &Required, AnalysisSet &Destroyed,
- AnalysisSet &Provided) {
- PM->addPass(this, Required, Destroyed, Provided);
+PassManagerType FunctionPass::getPotentialPassManagerType() const {
+ return PMT_FunctionPassManager;
}
//===----------------------------------------------------------------------===//
// BasicBlockPass Implementation
//
-// To run this pass on a method, we simply call runOnBasicBlock once for each
-// method.
+Pass *BasicBlockPass::createPrinterPass(raw_ostream &O,
+ const std::string &Banner) const {
+
+ llvm_unreachable("BasicBlockPass printing unsupported.");
+ return 0;
+}
+
+// To run this pass on a function, we simply call runOnBasicBlock once for each
+// function.
//
-bool BasicBlockPass::runOnMethod(Method *M) {
- bool Changed = false;
- for (Method::iterator I = M->begin(), E = M->end(); I != E; ++I)
+bool BasicBlockPass::runOnFunction(Function &F) {
+ bool Changed = doInitialization(F);
+ for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
Changed |= runOnBasicBlock(*I);
- return Changed;
+ return Changed | doFinalization(F);
+}
+
+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;
+}
+
+//===----------------------------------------------------------------------===//
+// Pass Registration mechanism
+//
+
+static std::vector<PassRegistrationListener*> *Listeners = 0;
+static sys::SmartMutex<true> ListenersLock;
+
+// getPassInfo - Return the PassInfo data structure that corresponds to this
+// pass...
+const PassInfo *Pass::getPassInfo() const {
+ return lookupPassInfo(PassID);
+}
+
+const PassInfo *Pass::lookupPassInfo(intptr_t TI) {
+ return PassRegistry::getPassRegistry()->getPassInfo(TI);
+}
+
+const PassInfo *Pass::lookupPassInfo(StringRef Arg) {
+ return PassRegistry::getPassRegistry()->getPassInfo(Arg);
+}
+
+void PassInfo::registerPass() {
+ PassRegistry::getPassRegistry()->registerPass(*this);
+
+ // Notify any listeners.
+ sys::SmartScopedLock<true> Lock(ListenersLock);
+ if (Listeners)
+ for (std::vector<PassRegistrationListener*>::iterator
+ I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
+ (*I)->passRegistered(this);
+}
+
+void PassInfo::unregisterPass() {
+ PassRegistry::getPassRegistry()->unregisterPass(*this);
+}
+
+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, intptr_t InterfaceID,
+ intptr_t PassID, bool isDefault)
+ : PassInfo(Name, InterfaceID) {
+
+ PassInfo *InterfaceInfo =
+ const_cast<PassInfo*>(Pass::lookupPassInfo(InterfaceID));
+ if (InterfaceInfo == 0) {
+ // First reference to Interface, register it now.
+ registerPass();
+ InterfaceInfo = this;
+ }
+ assert(isAnalysisGroup() &&
+ "Trying to join an analysis group that is a normal pass!");
+
+ if (PassID) {
+ const PassInfo *ImplementationInfo = Pass::lookupPassInfo(PassID);
+ assert(ImplementationInfo &&
+ "Must register pass before adding to AnalysisGroup!");
+
+ // Make sure we keep track of the fact that the implementation implements
+ // the interface.
+ PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
+ IIPI->addInterfaceImplemented(InterfaceInfo);
+
+ PassRegistry::getPassRegistry()->registerAnalysisGroup(InterfaceInfo, IIPI, isDefault);
+ }
}
-// To run directly on the basic block, we initialize, runOnBasicBlock, then
-// finalize.
+
+//===----------------------------------------------------------------------===//
+// PassRegistrationListener implementation
//
-bool BasicBlockPass::run(BasicBlock *BB) {
- Module *M = BB->getParent()->getParent();
- return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M);
+
+// PassRegistrationListener ctor - Add the current object to the list of
+// PassRegistrationListeners...
+PassRegistrationListener::PassRegistrationListener() {
+ sys::SmartScopedLock<true> Lock(ListenersLock);
+ if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
+ Listeners->push_back(this);
}
-void BasicBlockPass::addToPassManager(PassManagerT<Method> *PM,
- AnalysisSet &Required,
- AnalysisSet &Destroyed,
- AnalysisSet &Provided) {
- PM->addPass(this, Required, Destroyed, Provided);
+// dtor - Remove object from list of listeners...
+PassRegistrationListener::~PassRegistrationListener() {
+ sys::SmartScopedLock<true> Lock(ListenersLock);
+ std::vector<PassRegistrationListener*>::iterator I =
+ std::find(Listeners->begin(), Listeners->end(), this);
+ assert(Listeners && I != Listeners->end() &&
+ "PassRegistrationListener not registered!");
+ Listeners->erase(I);
+
+ if (Listeners->empty()) {
+ delete Listeners;
+ Listeners = 0;
+ }
}
-void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
- AnalysisSet &Required,
- AnalysisSet &Destroyed,
- AnalysisSet &Provided) {
- PM->addPass(this, Required, Destroyed, Provided);
+// 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);
+ }
+ };
+}
+
+// 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::addRequiredID(AnalysisID ID) {
+ assert(ID && "Pass class not registered!");
+ Required.push_back(ID);
+ return *this;
+}
+
+AnalysisUsage &AnalysisUsage::addRequiredTransitiveID(AnalysisID ID) {
+ assert(ID && "Pass class not registered!");
+ Required.push_back(ID);
+ RequiredTransitive.push_back(ID);
+ return *this;
+}
projects / oota-llvm.git / blobdiff