X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FVMCore%2FPass.cpp;h=6db5d7e24c5ef2f4eec9eb5cc0680261411ba4a6;hb=9036d80d7b696daec0eb4738848b18a2a6e4fe1f;hp=24f14f804bf23b767deaebb69d0ca51f99a5fe79;hpb=db8d8eff2f4a08e9f6c97bca1408ee3ab49566fa;p=oota-llvm.git diff --git a/lib/VMCore/Pass.cpp b/lib/VMCore/Pass.cpp index 24f14f804bf..6db5d7e24c5 100644 --- a/lib/VMCore/Pass.cpp +++ b/lib/VMCore/Pass.cpp @@ -1,4 +1,11 @@ -//===- 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 @@ -6,281 +13,67 @@ // //===----------------------------------------------------------------------===// +#include "llvm/Pass.h" #include "llvm/PassManager.h" -#include "PassManagerT.h" // PassManagerT implementation #include "llvm/Module.h" -#include "Support/STLExtras.h" -#include "Support/TypeInfo.h" -#include -#include -#include -#include - -//===----------------------------------------------------------------------===// -// AnalysisID Class Implementation -// - -static std::vector CFGOnlyAnalyses; - -void RegisterPassBase::setPreservesCFG() { - CFGOnlyAnalyses.push_back(PIObj); -} +#include "llvm/ModuleProvider.h" +#include "llvm/ADT/STLExtras.h" +#include "llvm/Support/ManagedStatic.h" +#include +#include +#include +using namespace llvm; //===----------------------------------------------------------------------===// -// AnalysisResolver Class Implementation -// - -void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) { - assert(P->Resolver == 0 && "Pass already in a PassManager!"); - P->Resolver = AR; -} - -//===----------------------------------------------------------------------===// -// AnalysisUsage Class Implementation -// - -// preservesCFG - 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::preservesCFG() { - // Since this transformation doesn't modify the CFG, it preserves all analyses - // that only depend on the CFG (like dominators, loop info, etc...) - // - Preserved.insert(Preserved.end(), - CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end()); -} - - -//===----------------------------------------------------------------------===// -// PassManager implementation - The PassManager class is a simple Pimpl class -// that wraps the PassManagerT template. -// -PassManager::PassManager() : PM(new PassManagerT()) {} -PassManager::~PassManager() { delete PM; } -void PassManager::add(Pass *P) { PM->add(P); } -bool PassManager::run(Module &M) { return PM->run(M); } - - -//===----------------------------------------------------------------------===// -// 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. -// -static cl::opt -EnableTiming("time-passes", - cl::desc("Time each pass, printing elapsed time for each on exit")); - -static TimeRecord getTimeRecord() { - static unsigned long PageSize = 0; - - if (PageSize == 0) { -#ifdef _SC_PAGE_SIZE - PageSize = sysconf(_SC_PAGE_SIZE); -#else -#ifdef _SC_PAGESIZE - PageSize = sysconf(_SC_PAGESIZE); -#else - PageSize = getpagesize(); -#endif -#endif - } - - struct rusage RU; - struct timeval T; - gettimeofday(&T, 0); - if (getrusage(RUSAGE_SELF, &RU)) { - perror("getrusage call failed: -time-passes info incorrect!"); - } - - TimeRecord Result; - Result.Elapsed = T.tv_sec + T.tv_usec/1000000.0; - Result.UserTime = RU.ru_utime.tv_sec + RU.ru_utime.tv_usec/1000000.0; - Result.SystemTime = RU.ru_stime.tv_sec + RU.ru_stime.tv_usec/1000000.0; - Result.MaxRSS = RU.ru_maxrss*PageSize; - - return Result; -} - -void TimeRecord::passStart(const TimeRecord &T) { - Elapsed -= T.Elapsed; - UserTime -= T.UserTime; - SystemTime -= T.SystemTime; - RSSTemp = T.MaxRSS; -} - -void TimeRecord::passEnd(const TimeRecord &T) { - Elapsed += T.Elapsed; - UserTime += T.UserTime; - SystemTime += T.SystemTime; - RSSTemp = T.MaxRSS - RSSTemp; - MaxRSS = std::max(MaxRSS, RSSTemp); -} - -static void printVal(double Val, double Total) { - if (Total < 1e-7) // Avoid dividing by zero... - fprintf(stderr, " ----- "); - else - fprintf(stderr, " %7.4f (%5.1f%%)", Val, Val*100/Total); -} - -void TimeRecord::print(const char *PassName, const TimeRecord &Total) const { - printVal(UserTime, Total.UserTime); - printVal(SystemTime, Total.SystemTime); - printVal(UserTime+SystemTime, Total.UserTime+Total.SystemTime); - printVal(Elapsed, Total.Elapsed); - - fprintf(stderr, " "); - - if (Total.MaxRSS) - std::cerr << MaxRSS << "\t"; - std::cerr << PassName << "\n"; -} - - -// Create method. If Timing is enabled, this creates and returns a new timing -// object, otherwise it returns null. +// Pass Implementation // -TimingInfo *TimingInfo::create() { - return EnableTiming ? new TimingInfo() : 0; -} - -void TimingInfo::passStarted(Pass *P) { - TimingData[P].passStart(getTimeRecord()); -} -void TimingInfo::passEnded(Pass *P) { - TimingData[P].passEnd(getTimeRecord()); -} -void TimeRecord::sum(const TimeRecord &TR) { - Elapsed += TR.Elapsed; - UserTime += TR.UserTime; - SystemTime += TR.SystemTime; - MaxRSS += TR.MaxRSS; -} - -// TimingDtor - Print out information about timing information -TimingInfo::~TimingInfo() { - // Iterate over all of the data, converting it into the dual of the data map, - // so that the data is sorted by amount of time taken, instead of pointer. - // - std::vector > Data; - TimeRecord Total; - for (std::map::iterator I = TimingData.begin(), - E = TimingData.end(); I != E; ++I) - // Throw out results for "grouping" pass managers... - if (!dynamic_cast(I->first)) { - Data.push_back(std::make_pair(I->second, I->first)); - Total.sum(I->second); - } - - // Sort the data by time as the primary key, in reverse order... - std::sort(Data.begin(), Data.end(), - std::greater >()); - - // Print out timing header... - std::cerr << std::string(79, '=') << "\n" - << " ... Pass execution timing report ...\n" - << std::string(79, '=') << "\n Total Execution Time: " - << (Total.UserTime+Total.SystemTime) << " seconds (" - << Total.Elapsed << " wall clock)\n\n ---User Time--- " - << "--System Time-- --User+System-- ---Wall Time---"; - - if (Total.MaxRSS) - std::cerr << " ---Mem---"; - std::cerr << " --- Pass Name ---\n"; - - // Loop through all of the timing data, printing it out... - for (unsigned i = 0, e = Data.size(); i != e; ++i) - Data[i].first.print(Data[i].second->getPassName(), Total); - - Total.print("TOTAL", Total); -} - - -void PMDebug::PrintArgumentInformation(const Pass *P) { - // Print out passes in pass manager... - if (const AnalysisResolver *PM = dynamic_cast(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->getPassType() & PassInfo::Optimization) - std::cerr << " -" << PI->getPassArgument(); - } -} - -void PMDebug::PrintPassInformation(unsigned Depth, const char *Action, - Pass *P, Annotable *V) { - if (PassDebugging >= Executions) { - std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '" - << P->getPassName(); - if (V) { - std::cerr << "' on "; - - if (dynamic_cast(V)) { - std::cerr << "Module\n"; return; - } else if (Function *F = dynamic_cast(V)) - std::cerr << "Function '" << F->getName(); - else if (BasicBlock *BB = dynamic_cast(V)) - std::cerr << "BasicBlock '" << BB->getName(); - else if (Value *Val = dynamic_cast(V)) - std::cerr << typeid(*Val).name() << " '" << Val->getName(); - } - std::cerr << "'...\n"; - } -} -void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg, - Pass *P, const std::vector &Set){ - if (PassDebugging >= Details && !Set.empty()) { - std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:"; - for (unsigned i = 0; i != Set.size(); ++i) - std::cerr << " " << Set[i]->getPassName(); - std::cerr << "\n"; - } +// Force out-of-line virtual method. +Pass::~Pass() { + delete Resolver; } -//===----------------------------------------------------------------------===// -// Pass Implementation -// +// Force out-of-line virtual method. +ModulePass::~ModulePass() { } -void Pass::addToPassManager(PassManagerT *PM, AnalysisUsage &AU) { - PM->addPass(this, AU); +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) { - std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n"; + cerr << std::string(Offset*2, ' ') << getPassName() << "\n"; } -// getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass. -// +/// 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 typeid(*this).name(); + return "Unnamed pass: implement Pass::getPassName()"; } -// print - Print out the internal state of the pass. This is called by Analyse -// to print out the contents of an analysis. Otherwise it is not neccesary to +// 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 { +void Pass::print(std::ostream &O,const Module*) const { O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n"; } -// dump - call print(std::cerr); +// dump - call print(cerr); void Pass::dump() const { - print(std::cerr, 0); + print(*cerr.stream(), 0); } +//===----------------------------------------------------------------------===// +// ImmutablePass Implementation +// +// Force out-of-line virtual method. +ImmutablePass::~ImmutablePass() { } + //===----------------------------------------------------------------------===// // FunctionPass Implementation // @@ -288,33 +81,25 @@ void Pass::dump() const { // run - On a module, we run this pass by initializing, runOnFunction'ing once // for every function in the module, then by finalizing. // -bool FunctionPass::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 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; - return doInitialization(*F.getParent()) | runOnFunction(F) - | doFinalization(*F.getParent()); -} - -void FunctionPass::addToPassManager(PassManagerT *PM, - AnalysisUsage &AU) { - PM->addPass(this, AU); -} - -void FunctionPass::addToPassManager(PassManagerT *PM, - AnalysisUsage &AU) { - PM->addPass(this, AU); + bool Changed = doInitialization(*F.getParent()); + Changed |= runOnFunction(F); + return Changed | doFinalization(*F.getParent()); } //===----------------------------------------------------------------------===// @@ -325,87 +110,152 @@ void FunctionPass::addToPassManager(PassManagerT *PM, // function. // bool BasicBlockPass::runOnFunction(Function &F) { - bool Changed = false; + 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); } -// To run directly on the basic block, we initialize, runOnBasicBlock, then -// finalize. +//===----------------------------------------------------------------------===// +// Pass Registration mechanism // -bool BasicBlockPass::run(BasicBlock &BB) { - Module &M = *BB.getParent()->getParent(); - return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M); -} - -void BasicBlockPass::addToPassManager(PassManagerT *PM, - AnalysisUsage &AU) { - PM->addPass(this, AU); -} +namespace { +class PassRegistrar { + /// PassInfoMap - Keep track of the passinfo object for each registered llvm + /// pass. + typedef std::map MapType; + MapType PassInfoMap; + + /// AnalysisGroupInfo - Keep track of information for each analysis group. + struct AnalysisGroupInfo { + const PassInfo *DefaultImpl; + std::set Implementations; + AnalysisGroupInfo() : DefaultImpl(0) {} + }; + + /// AnalysisGroupInfoMap - Information for each analysis group. + std::map AnalysisGroupInfoMap; -void BasicBlockPass::addToPassManager(PassManagerT *PM, - AnalysisUsage &AU) { - PM->addPass(this, AU); +public: + + const PassInfo *GetPassInfo(intptr_t TI) const { + MapType::const_iterator I = PassInfoMap.find(TI); + return I != PassInfoMap.end() ? I->second : 0; + } + + void RegisterPass(const PassInfo &PI) { + bool Inserted = + PassInfoMap.insert(std::make_pair(PI.getTypeInfo(),&PI)).second; + assert(Inserted && "Pass registered multiple times!"); Inserted=Inserted; + } + + 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); + } + + void EnumerateWith(PassRegistrationListener *L) { + for (MapType::const_iterator I = PassInfoMap.begin(), + E = PassInfoMap.end(); I != E; ++I) + L->passEnumerate(I->second); + } + + + /// Analysis Group Mechanisms. + void RegisterAnalysisGroup(PassInfo *InterfaceInfo, + const PassInfo *ImplementationInfo, + bool isDefault) { + AnalysisGroupInfo &AGI = AnalysisGroupInfoMap[InterfaceInfo]; + assert(AGI.Implementations.count(ImplementationInfo) == 0 && + "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 && + "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()); + } + } +}; } - -//===----------------------------------------------------------------------===// -// Pass Registration mechanism -// -static std::map *PassInfoMap = 0; static std::vector *Listeners = 0; +// 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; + if (!PassRegistrarObj) + 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; - if (PassInfoMap == 0) return 0; - std::map::iterator I = PassInfoMap->find(typeid(*this)); - return (I != PassInfoMap->end()) ? I->second : 0; + return lookupPassInfo(PassID); } -void RegisterPassBase::registerPass(PassInfo *PI) { - if (PassInfoMap == 0) - PassInfoMap = new std::map(); +const PassInfo *Pass::lookupPassInfo(intptr_t TI) { + return getPassRegistrar()->GetPassInfo(TI); +} - assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() && - "Pass already registered!"); - PIObj = PI; - PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI)); +void PassInfo::registerPass() { + getPassRegistrar()->RegisterPass(*this); - // Notify any listeners... + // Notify any listeners. if (Listeners) for (std::vector::iterator I = Listeners->begin(), E = Listeners->end(); I != E; ++I) - (*I)->passRegistered(PI); + (*I)->passRegistered(this); } -RegisterPassBase::~RegisterPassBase() { - assert(PassInfoMap && "Pass registered but not in map!"); - std::map::iterator I = - PassInfoMap->find(PIObj->getTypeInfo()); - assert(I != PassInfoMap->end() && "Pass registered but not in map!"); - - // Remove pass from the map... - PassInfoMap->erase(I); - if (PassInfoMap->empty()) { - delete PassInfoMap; - PassInfoMap = 0; - } +void PassInfo::unregisterPass() { + getPassRegistrar()->UnregisterPass(*this); +} - // Notify any listeners... - if (Listeners) - for (std::vector::iterator - I = Listeners->begin(), E = Listeners->end(); I != E; ++I) - (*I)->passUnregistered(PIObj); +//===----------------------------------------------------------------------===// +// Analysis Group Implementation Code +//===----------------------------------------------------------------------===// - // Delete the PassInfo object itself... - delete PIObj; +// RegisterAGBase implementation +// +RegisterAGBase::RegisterAGBase(const char *Name, intptr_t InterfaceID, + intptr_t PassID, bool isDefault) + : PassInfo(Name, InterfaceID), + ImplementationInfo(0), isDefaultImplementation(isDefault) { + + InterfaceInfo = const_cast(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) { + 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(ImplementationInfo); + IIPI->addInterfaceImplemented(InterfaceInfo); + + getPassRegistrar()->RegisterAnalysisGroup(InterfaceInfo, IIPI, isDefault); + } } - //===----------------------------------------------------------------------===// // PassRegistrationListener implementation // @@ -435,8 +285,39 @@ PassRegistrationListener::~PassRegistrationListener() { // passEnumerate callback on each PassInfo object. // void PassRegistrationListener::enumeratePasses() { - if (PassInfoMap) - for (std::map::iterator I = PassInfoMap->begin(), - E = PassInfoMap->end(); I != E; ++I) - passEnumerate(I->second); + getPassRegistrar()->EnumerateWith(this); } + +//===----------------------------------------------------------------------===// +// 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(); +} + +