//
// 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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
//
//===----------------------------------------------------------------------===//
+#include "llvm/Pass.h"
#include "llvm/PassManager.h"
-#ifdef USE_OLD_PASSMANAGER
-#include "PassManagerT.h" // PassManagerT implementation
-#endif
#include "llvm/Module.h"
-#include "llvm/ModuleProvider.h"
#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/StringMap.h"
+#include "llvm/Support/Debug.h"
#include "llvm/Support/ManagedStatic.h"
-#include "llvm/Support/TypeInfo.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;
//===----------------------------------------------------------------------===//
-// AnalysisResolver Class Implementation
-//
-
-AnalysisResolver::~AnalysisResolver() {
-}
-void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
- assert(P->Resolver == 0 && "Pass already in a PassManager!");
- P->Resolver = AR;
-}
-
-#ifdef USE_OLD_PASSMANAGER
-//===----------------------------------------------------------------------===//
-// PassManager implementation - The PassManager class is a simple Pimpl class
-// that wraps the PassManagerT template.
-//
-PassManager::PassManager() : PM(new ModulePassManager()) {}
-PassManager::~PassManager() { delete PM; }
-void PassManager::add(Pass *P) {
- ModulePass *MP = dynamic_cast<ModulePass*>(P);
- assert(MP && "Not a modulepass?");
- PM->add(MP);
-}
-bool PassManager::run(Module &M) { return PM->runOnModule(M); }
-
-//===----------------------------------------------------------------------===//
-// FunctionPassManager implementation - The FunctionPassManager class
-// is a simple Pimpl class that wraps the PassManagerT template. It
-// is like PassManager, but only deals in FunctionPasses.
+// Pass Implementation
//
-FunctionPassManager::FunctionPassManager(ModuleProvider *P) :
- PM(new FunctionPassManagerT()), MP(P) {}
-FunctionPassManager::~FunctionPassManager() { delete PM; }
-void FunctionPassManager::add(FunctionPass *P) { PM->add(P); }
-void FunctionPassManager::add(ImmutablePass *IP) { PM->add(IP); }
-/// doInitialization - Run all of the initializers for the function passes.
-///
-bool FunctionPassManager::doInitialization() {
- return PM->doInitialization(*MP->getModule());
+// Force out-of-line virtual method.
+Pass::~Pass() {
+ delete Resolver;
}
-bool FunctionPassManager::run(Function &F) {
- std::string errstr;
- if (MP->materializeFunction(&F, &errstr)) {
- cerr << "Error reading bytecode file: " << errstr << "\n";
- abort();
- }
- return PM->runOnFunction(F);
-}
+// Force out-of-line virtual method.
+ModulePass::~ModulePass() { }
-/// doFinalization - Run all of the initializers for the function passes.
-///
-bool FunctionPassManager::doFinalization() {
- return PM->doFinalization(*MP->getModule());
+PassManagerType ModulePass::getPotentialPassManagerType() const {
+ return PMT_ModulePassManager;
}
-
-//===----------------------------------------------------------------------===//
-// TimingInfo Class - This class is used to calculate information about the
-// amount of time each pass takes to execute. This only happens with
-// -time-passes is enabled on the command line.
-//
-bool llvm::TimePassesIsEnabled = false;
-static cl::opt<bool,true>
-EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
- cl::desc("Time each pass, printing elapsed time for each on exit"));
-
-// createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
-// a non null value (if the -time-passes option is enabled) or it leaves it
-// null. It may be called multiple times.
-void TimingInfo::createTheTimeInfo() {
- if (!TimePassesIsEnabled || TheTimeInfo) return;
-
- // Constructed the first time this is called, iff -time-passes is enabled.
- // This guarantees that the object will be constructed before static globals,
- // thus it will be destroyed before them.
- static ManagedStatic<TimingInfo> TTI;
- TheTimeInfo = &*TTI;
-}
-
-void PMDebug::PrintArgumentInformation(const Pass *P) {
- // Print out passes in pass manager...
- if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
- for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
- PrintArgumentInformation(PM->getContainedPass(i));
-
- } else { // Normal pass. Print argument information...
- // Print out arguments for registered passes that are _optimizations_
- if (const PassInfo *PI = P->getPassInfo())
- if (!PI->isAnalysisGroup())
- cerr << " -" << PI->getPassArgument();
- }
-}
-
-void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
- Pass *P, Module *M) {
- if (PassDebugging >= PDLExecutions) {
- cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
- << P->getPassName();
- if (M) cerr << "' on Module '" << M->getModuleIdentifier() << "'\n";
- cerr << "'...\n";
- }
+bool Pass::mustPreserveAnalysisID(const PassInfo *AnalysisID) const {
+ return Resolver->getAnalysisIfAvailable(AnalysisID, true) != 0;
}
-void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
- Pass *P, Function *F) {
- if (PassDebugging >= PDLExecutions) {
- cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
- << P->getPassName();
- if (F) cerr << "' on Function '" << F->getName();
- cerr << "'...\n";
- }
+// dumpPassStructure - Implement the -debug-passes=Structure option
+void Pass::dumpPassStructure(unsigned Offset) {
+ dbgs().indent(Offset*2) << getPassName() << "\n";
}
-void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
- Pass *P, BasicBlock *BB) {
- if (PassDebugging >= PDLExecutions) {
- cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
- << P->getPassName();
- if (BB) cerr << "' on BasicBlock '" << BB->getName();
- cerr << "'...\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 PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
- Pass *P, const std::vector<AnalysisID> &Set){
- if (PassDebugging >= PDLDetails && !Set.empty()) {
- cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
- for (unsigned i = 0; i != Set.size(); ++i) {
- if (i) cerr << ",";
- cerr << " " << Set[i]->getPassName();
- }
- cerr << "\n";
- }
+void Pass::preparePassManager(PMStack &) {
+ // By default, don't do anything.
}
-#endif
-//===----------------------------------------------------------------------===//
-// Pass Implementation
-//
-
-#ifdef USE_OLD_PASSMANAGER
-void ModulePass::addToPassManager(ModulePassManager *PM, AnalysisUsage &AU) {
- PM->addPass(this, AU);
+PassManagerType Pass::getPotentialPassManagerType() const {
+ // Default implementation.
+ return PMT_Unknown;
}
-#endif
-bool Pass::mustPreserveAnalysisID(const PassInfo *AnalysisID) const {
-#ifdef USE_OLD_PASSMANAGER
- return Resolver->getAnalysisToUpdate(AnalysisID) != 0;
-#else
- return Resolver_New->getAnalysisToUpdate(AnalysisID, true) != 0;
-#endif
+void Pass::getAnalysisUsage(AnalysisUsage &) const {
+ // By default, no analysis results are used, all are invalidated.
}
-// dumpPassStructure - Implement the -debug-passes=Structure option
-void Pass::dumpPassStructure(unsigned Offset) {
- cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
+void Pass::releaseMemory() {
+ // By default, don't do anything.
}
-// getPassName - Use C++ RTTI to get a SOMEWHAT intelligible name for the pass.
-//
-const char *Pass::getPassName() const {
- if (const PassInfo *PI = getPassInfo())
- return PI->getPassName();
- return typeid(*this).name();
+void Pass::verifyAnalysis() const {
+ // By default, don't do anything.
}
// 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(std::ostream &O,const Module*) const {
+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(*cerr.stream(), 0);
+ print(dbgs(), 0);
}
//===----------------------------------------------------------------------===//
// ImmutablePass Implementation
//
-#ifdef USE_OLD_PASSMANAGER
-void ImmutablePass::addToPassManager(ModulePassManager *PM,
- AnalysisUsage &AU) {
- PM->addPass(this, AU);
+// Force out-of-line virtual method.
+ImmutablePass::~ImmutablePass() { }
+
+void ImmutablePass::initializePass() {
+ // By default, don't do anything.
}
-#endif
//===----------------------------------------------------------------------===//
// FunctionPass Implementation
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 functions!
+ if (!I->isDeclaration()) // Passes are not run on external functions!
Changed |= runOnFunction(*I);
return Changed | doFinalization(M);
// run - On a function, we simply initialize, run the function, then finalize.
//
bool FunctionPass::run(Function &F) {
- if (F.isExternal()) return false;// Passes are not run on external functions!
+ // 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());
}
-#ifdef USE_OLD_PASSMANAGER
-void FunctionPass::addToPassManager(ModulePassManager *PM,
- AnalysisUsage &AU) {
- PM->addPass(this, AU);
+bool FunctionPass::doInitialization(Module &) {
+ // By default, don't do anything.
+ return false;
+}
+
+bool FunctionPass::doFinalization(Module &) {
+ // By default, don't do anything.
+ return false;
}
-void FunctionPass::addToPassManager(FunctionPassManagerT *PM,
- AnalysisUsage &AU) {
- PM->addPass(this, AU);
+PassManagerType FunctionPass::getPotentialPassManagerType() const {
+ return PMT_FunctionPassManager;
}
-#endif
//===----------------------------------------------------------------------===//
// BasicBlockPass Implementation
return Changed | doFinalization(F);
}
-// To run directly on the basic block, we initialize, runOnBasicBlock, then
-// finalize.
-//
-bool BasicBlockPass::runPass(BasicBlock &BB) {
- Function &F = *BB.getParent();
- Module &M = *F.getParent();
- bool Changed = doInitialization(M);
- Changed |= doInitialization(F);
- Changed |= runOnBasicBlock(BB);
- Changed |= doFinalization(F);
- Changed |= doFinalization(M);
- return Changed;
+bool BasicBlockPass::doInitialization(Module &) {
+ // By default, don't do anything.
+ return false;
}
-#ifdef USE_OLD_PASSMANAGER
-void BasicBlockPass::addToPassManager(FunctionPassManagerT *PM,
- AnalysisUsage &AU) {
- PM->addPass(this, AU);
+bool BasicBlockPass::doInitialization(Function &) {
+ // By default, don't do anything.
+ return false;
}
-void BasicBlockPass::addToPassManager(BasicBlockPassManager *PM,
- AnalysisUsage &AU) {
- PM->addPass(this, AU);
+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;
}
-#endif
//===----------------------------------------------------------------------===//
// Pass Registration mechanism
class PassRegistrar {
/// PassInfoMap - Keep track of the passinfo object for each registered llvm
/// pass.
- std::map<TypeInfo, PassInfo*> PassInfoMap;
+ typedef std::map<intptr_t, const PassInfo*> MapType;
+ MapType PassInfoMap;
+
+ typedef StringMap<const PassInfo*> StringMapType;
+ StringMapType PassInfoStringMap;
/// AnalysisGroupInfo - Keep track of information for each analysis group.
struct AnalysisGroupInfo {
- const PassInfo *DefaultImpl;
std::set<const PassInfo *> Implementations;
- AnalysisGroupInfo() : DefaultImpl(0) {}
};
/// AnalysisGroupInfoMap - Information for each analysis group.
public:
- const PassInfo *GetPassInfo(const std::type_info &TI) const {
- std::map<TypeInfo, PassInfo*>::const_iterator I = PassInfoMap.find(TI);
+ const PassInfo *GetPassInfo(intptr_t TI) const {
+ MapType::const_iterator I = PassInfoMap.find(TI);
return I != PassInfoMap.end() ? I->second : 0;
}
- void RegisterPass(PassInfo &PI) {
+ const PassInfo *GetPassInfo(StringRef Arg) const {
+ StringMapType::const_iterator I = PassInfoStringMap.find(Arg);
+ return I != PassInfoStringMap.end() ? I->second : 0;
+ }
+
+ void RegisterPass(const PassInfo &PI) {
bool Inserted =
- PassInfoMap.insert(std::make_pair(TypeInfo(PI.getTypeInfo()),&PI)).second;
- assert(Inserted && "Pass registered multiple times!");
+ PassInfoMap.insert(std::make_pair(PI.getTypeInfo(),&PI)).second;
+ assert(Inserted && "Pass registered multiple times!"); Inserted=Inserted;
+ PassInfoStringMap[PI.getPassArgument()] = &PI;
}
- void UnregisterPass(PassInfo &PI) {
- std::map<TypeInfo, PassInfo*>::iterator I =
- PassInfoMap.find(PI.getTypeInfo());
+ void UnregisterPass(const PassInfo &PI) {
+ MapType::iterator I = PassInfoMap.find(PI.getTypeInfo());
assert(I != PassInfoMap.end() && "Pass registered but not in map!");
// Remove pass from the map.
PassInfoMap.erase(I);
+ PassInfoStringMap.erase(PI.getPassArgument());
}
void EnumerateWith(PassRegistrationListener *L) {
- for (std::map<TypeInfo, PassInfo*>::const_iterator I = PassInfoMap.begin(),
+ for (MapType::const_iterator I = PassInfoMap.begin(),
E = PassInfoMap.end(); I != E; ++I)
L->passEnumerate(I->second);
}
"Cannot add a pass to the same analysis group more than once!");
AGI.Implementations.insert(ImplementationInfo);
if (isDefault) {
- assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
+ assert(InterfaceInfo->getNormalCtor() == 0 &&
"Default implementation for analysis group already specified!");
assert(ImplementationInfo->getNormalCtor() &&
"Cannot specify pass as default if it does not have a default ctor");
- AGI.DefaultImpl = ImplementationInfo;
InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
}
}
};
}
-static ManagedStatic<PassRegistrar> PassRegistrarObj;
static std::vector<PassRegistrationListener*> *Listeners = 0;
+static sys::SmartMutex<true> ListenersLock;
+
+// FIXME: This should use ManagedStatic to manage the pass registrar.
+// Unfortunately, we can't do this, because passes are registered with static
+// ctors, and having llvm_shutdown clear this map prevents successful
+// ressurection after llvm_shutdown is run.
+static PassRegistrar *getPassRegistrar() {
+ static PassRegistrar *PassRegistrarObj = 0;
+
+ // Use double-checked locking to safely initialize the registrar when
+ // we're running in multithreaded mode.
+ PassRegistrar* tmp = PassRegistrarObj;
+ if (llvm_is_multithreaded()) {
+ sys::MemoryFence();
+ if (!tmp) {
+ llvm_acquire_global_lock();
+ tmp = PassRegistrarObj;
+ if (!tmp) {
+ tmp = new PassRegistrar();
+ sys::MemoryFence();
+ PassRegistrarObj = tmp;
+ }
+ llvm_release_global_lock();
+ }
+ } else if (!tmp) {
+ PassRegistrarObj = new PassRegistrar();
+ }
+
+ return PassRegistrarObj;
+}
// getPassInfo - Return the PassInfo data structure that corresponds to this
// pass...
const PassInfo *Pass::getPassInfo() const {
- if (PassInfoCache) return PassInfoCache;
- return lookupPassInfo(typeid(*this));
+ return lookupPassInfo(PassID);
+}
+
+const PassInfo *Pass::lookupPassInfo(intptr_t TI) {
+ return getPassRegistrar()->GetPassInfo(TI);
}
-const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
- return PassRegistrarObj->GetPassInfo(TI);
+const PassInfo *Pass::lookupPassInfo(StringRef Arg) {
+ return getPassRegistrar()->GetPassInfo(Arg);
}
-void RegisterPassBase::registerPass() {
- PassRegistrarObj->RegisterPass(PIObj);
+void PassInfo::registerPass() {
+ getPassRegistrar()->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(&PIObj);
+ (*I)->passRegistered(this);
}
-void RegisterPassBase::unregisterPass() {
- PassRegistrarObj->UnregisterPass(PIObj);
+void PassInfo::unregisterPass() {
+ getPassRegistrar()->UnregisterPass(*this);
}
//===----------------------------------------------------------------------===//
// RegisterAGBase implementation
//
-RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
- const std::type_info *Pass, bool isDefault)
- : RegisterPassBase(Interface),
- ImplementationInfo(0), isDefaultImplementation(isDefault) {
+RegisterAGBase::RegisterAGBase(const char *Name, intptr_t InterfaceID,
+ intptr_t PassID, bool isDefault)
+ : PassInfo(Name, InterfaceID) {
- InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
+ PassInfo *InterfaceInfo =
+ const_cast<PassInfo*>(Pass::lookupPassInfo(InterfaceID));
if (InterfaceInfo == 0) {
// First reference to Interface, register it now.
registerPass();
- InterfaceInfo = &PIObj;
+ InterfaceInfo = this;
}
- assert(PIObj.isAnalysisGroup() &&
+ assert(isAnalysisGroup() &&
"Trying to join an analysis group that is a normal pass!");
- if (Pass) {
- ImplementationInfo = Pass::lookupPassInfo(*Pass);
+ if (PassID) {
+ const PassInfo *ImplementationInfo = Pass::lookupPassInfo(PassID);
assert(ImplementationInfo &&
"Must register pass before adding to AnalysisGroup!");
PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
IIPI->addInterfaceImplemented(InterfaceInfo);
- PassRegistrarObj->RegisterAnalysisGroup(InterfaceInfo, IIPI, isDefault);
+ getPassRegistrar()->RegisterAnalysisGroup(InterfaceInfo, IIPI, isDefault);
}
}
-void RegisterAGBase::setGroupName(const char *Name) {
- assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
- InterfaceInfo->setPassName(Name);
-}
-
//===----------------------------------------------------------------------===//
// PassRegistrationListener implementation
// 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);
}
// 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() &&
// passEnumerate callback on each PassInfo object.
//
void PassRegistrationListener::enumeratePasses() {
- PassRegistrarObj->EnumerateWith(this);
+ getPassRegistrar()->EnumerateWith(this);
}
+PassNameParser::~PassNameParser() {}
+
//===----------------------------------------------------------------------===//
// AnalysisUsage Class Implementation
//
namespace {
struct GetCFGOnlyPasses : public PassRegistrationListener {
- std::vector<AnalysisID> &CFGOnlyList;
- GetCFGOnlyPasses(std::vector<AnalysisID> &L) : CFGOnlyList(L) {}
+ typedef AnalysisUsage::VectorType VectorType;
+ VectorType &CFGOnlyList;
+ GetCFGOnlyPasses(VectorType &L) : CFGOnlyList(L) {}
void passEnumerate(const PassInfo *P) {
if (P->isCFGOnlyPass())