X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FVMCore%2FPass.cpp;h=5079b4ea65eba147829be64ad571ffa4bbd4b3da;hb=551ccae044b0ff658fe629dd67edd5ffe75d10e8;hp=39766e357057bffd25f972962eb46209c7171f4d;hpb=48c1bc7b3a7a0ee9b30da43b83f63f210c65ee91;p=oota-llvm.git diff --git a/lib/VMCore/Pass.cpp b/lib/VMCore/Pass.cpp index 39766e35705..5079b4ea65e 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 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 implements the LLVM Pass infrastructure. It is primarily // responsible with ensuring that passes are executed and batched together @@ -9,21 +16,29 @@ #include "llvm/PassManager.h" #include "PassManagerT.h" // PassManagerT implementation #include "llvm/Module.h" -#include "Support/STLExtras.h" -#include "Support/TypeInfo.h" -#include +#include "llvm/ModuleProvider.h" +#include "llvm/ADT/STLExtras.h" +#include "llvm/Support/TypeInfo.h" #include -#include -#include +#include +using namespace llvm; + +// IncludeFile - Stub function used to help linking out. +IncludeFile::IncludeFile(void*) {} //===----------------------------------------------------------------------===// // AnalysisID Class Implementation // -static std::vector CFGOnlyAnalyses; +// getCFGOnlyAnalyses - A wrapper around the CFGOnlyAnalyses which make it +// initializer order independent. +static std::vector &getCFGOnlyAnalyses() { + static std::vector CFGOnlyAnalyses; + return CFGOnlyAnalyses; +} -void RegisterPassBase::setPreservesCFG() { - CFGOnlyAnalyses.push_back(PIObj); +void RegisterPassBase::setOnlyUsesCFG() { + getCFGOnlyAnalyses().push_back(PIObj); } //===----------------------------------------------------------------------===// @@ -39,7 +54,7 @@ void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) { // AnalysisUsage Class Implementation // -// preservesCFG - This function should be called to by the pass, iff they do +// setPreservesCFG - This function should be called to by the pass, iff they do // not: // // 1. Add or remove basic blocks from the function @@ -48,12 +63,12 @@ void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) { // 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() { +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...) // Preserved.insert(Preserved.end(), - CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end()); + getCFGOnlyAnalyses().begin(), getCFGOnlyAnalyses().end()); } @@ -66,66 +81,53 @@ PassManager::~PassManager() { delete PM; } void PassManager::add(Pass *P) { PM->add(P); } bool PassManager::run(Module &M) { return PM->run(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. +// +FunctionPassManager::FunctionPassManager(ModuleProvider *P) : + PM(new PassManagerT()), MP(P) {} +FunctionPassManager::~FunctionPassManager() { delete PM; } +void FunctionPassManager::add(FunctionPass *P) { PM->add(P); } +void FunctionPassManager::add(ImmutablePass *IP) { PM->add(IP); } +bool FunctionPassManager::run(Function &F) { + try { + MP->materializeFunction(&F); + } catch (std::string& errstr) { + std::cerr << "Error reading bytecode file: " << errstr << "\n"; + abort(); + } catch (...) { + std::cerr << "Error reading bytecode file!\n"; + abort(); + } + return PM->run(F); +} + //===----------------------------------------------------------------------===// // 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", +bool llvm::TimePassesIsEnabled = false; +static cl::opt +EnableTiming("time-passes", cl::location(TimePassesIsEnabled), cl::desc("Time each pass, printing elapsed time for each on exit")); -static double getTime() { - struct timeval T; - gettimeofday(&T, 0); - return T.tv_sec + T.tv_usec/1000000.0; -} - -// Create method. If Timing is enabled, this creates and returns a new timing -// object, otherwise it returns null. -// -TimingInfo *TimingInfo::create() { - return EnableTiming ? new TimingInfo() : 0; -} - -void TimingInfo::passStarted(Pass *P) { TimingData[P] -= getTime(); } -void TimingInfo::passEnded(Pass *P) { TimingData[P] += getTime(); } - -// 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; - double TotalTime = 0; - 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)); - TotalTime += 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: " << TotalTime - << " seconds\n\n % Time: Seconds:\tPass Name:\n"; - - // Loop through all of the timing data, printing it out... - for (unsigned i = 0, e = Data.size(); i != e; ++i) { - fprintf(stderr, " %6.2f%% %fs\t%s\n", Data[i].first*100 / TotalTime, - Data[i].first, Data[i].second->getPassName()); - } - std::cerr << " 100.00% " << TotalTime << "s\tTOTAL\n" - << std::string(79, '=') << "\n"; +// 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 TimingInfo TTI; + TheTimeInfo = &TTI; } - void PMDebug::PrintArgumentInformation(const Pass *P) { // Print out passes in pass manager... if (const AnalysisResolver *PM = dynamic_cast(P)) { @@ -141,22 +143,31 @@ void PMDebug::PrintArgumentInformation(const Pass *P) { } void PMDebug::PrintPassInformation(unsigned Depth, const char *Action, - Pass *P, Annotable *V) { + Pass *P, Module *M) { 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(); - } + if (M) std::cerr << "' on Module '" << M->getModuleIdentifier() << "'\n"; + std::cerr << "'...\n"; + } +} + +void PMDebug::PrintPassInformation(unsigned Depth, const char *Action, + Pass *P, Function *F) { + if (PassDebugging >= Executions) { + std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '" + << P->getPassName(); + if (F) std::cerr << "' on Function '" << F->getName(); + std::cerr << "'...\n"; + } +} + +void PMDebug::PrintPassInformation(unsigned Depth, const char *Action, + Pass *P, BasicBlock *BB) { + if (PassDebugging >= Executions) { + std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '" + << P->getPassName(); + if (BB) std::cerr << "' on BasicBlock '" << BB->getName(); std::cerr << "'...\n"; } } @@ -165,8 +176,10 @@ 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(); + for (unsigned i = 0; i != Set.size(); ++i) { + if (i) std::cerr << ","; + std::cerr << " " << Set[i]->getPassName(); + } std::cerr << "\n"; } } @@ -179,12 +192,16 @@ void Pass::addToPassManager(PassManagerT *PM, AnalysisUsage &AU) { PM->addPass(this, AU); } +bool Pass::mustPreserveAnalysisID(const PassInfo *AnalysisID) const { + return Resolver->getAnalysisToUpdate(AnalysisID) != 0; +} + // dumpPassStructure - Implement the -debug-passes=Structure option void Pass::dumpPassStructure(unsigned Offset) { std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n"; } -// getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass. +// getPassName - Use C++ RTTI to get a SOMEWHAT intelligible name for the pass. // const char *Pass::getPassName() const { if (const PassInfo *PI = getPassInfo()) @@ -192,8 +209,8 @@ const char *Pass::getPassName() const { return typeid(*this).name(); } -// 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 { @@ -205,6 +222,15 @@ void Pass::dump() const { print(std::cerr, 0); } +//===----------------------------------------------------------------------===// +// ImmutablePass Implementation +// +void ImmutablePass::addToPassManager(PassManagerT *PM, + AnalysisUsage &AU) { + PM->addPass(this, AU); +} + + //===----------------------------------------------------------------------===// // FunctionPass Implementation // @@ -249,18 +275,20 @@ 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. // bool BasicBlockPass::run(BasicBlock &BB) { - Module &M = *BB.getParent()->getParent(); - return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M); + Function &F = *BB.getParent(); + Module &M = *F.getParent(); + return doInitialization(M) | doInitialization(F) | runOnBasicBlock(BB) | + doFinalization(F) | doFinalization(M); } void BasicBlockPass::addToPassManager(PassManagerT *PM, @@ -284,8 +312,12 @@ static std::vector *Listeners = 0; // pass... const PassInfo *Pass::getPassInfo() const { if (PassInfoCache) return PassInfoCache; + return lookupPassInfo(typeid(*this)); +} + +const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) { if (PassInfoMap == 0) return 0; - std::map::iterator I = PassInfoMap->find(typeid(*this)); + std::map::iterator I = PassInfoMap->find(TI); return (I != PassInfoMap->end()) ? I->second : 0; } @@ -305,10 +337,10 @@ void RegisterPassBase::registerPass(PassInfo *PI) { (*I)->passRegistered(PI); } -RegisterPassBase::~RegisterPassBase() { +void RegisterPassBase::unregisterPass(PassInfo *PI) { assert(PassInfoMap && "Pass registered but not in map!"); std::map::iterator I = - PassInfoMap->find(PIObj->getTypeInfo()); + PassInfoMap->find(PI->getTypeInfo()); assert(I != PassInfoMap->end() && "Pass registered but not in map!"); // Remove pass from the map... @@ -322,12 +354,101 @@ RegisterPassBase::~RegisterPassBase() { if (Listeners) for (std::vector::iterator I = Listeners->begin(), E = Listeners->end(); I != E; ++I) - (*I)->passUnregistered(PIObj); + (*I)->passUnregistered(PI); // Delete the PassInfo object itself... - delete PIObj; + delete PI; } +//===----------------------------------------------------------------------===// +// Analysis Group Implementation Code +//===----------------------------------------------------------------------===// + +struct AnalysisGroupInfo { + const PassInfo *DefaultImpl; + std::set Implementations; + AnalysisGroupInfo() : DefaultImpl(0) {} +}; + +static std::map *AnalysisGroupInfoMap = 0; + +// RegisterAGBase implementation +// +RegisterAGBase::RegisterAGBase(const std::type_info &Interface, + const std::type_info *Pass, bool isDefault) + : ImplementationInfo(0), isDefaultImplementation(isDefault) { + + InterfaceInfo = const_cast(Pass::lookupPassInfo(Interface)); + if (InterfaceInfo == 0) { // First reference to Interface, add it now. + InterfaceInfo = // Create the new PassInfo for the interface... + new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0); + registerPass(InterfaceInfo); + PIObj = 0; + } + assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup && + "Trying to join an analysis group that is a normal pass!"); + + if (Pass) { + ImplementationInfo = Pass::lookupPassInfo(*Pass); + 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); + + // Lazily allocate to avoid nasty initialization order dependencies + if (AnalysisGroupInfoMap == 0) + AnalysisGroupInfoMap = new std::map(); + + 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()); + } + } +} + +void RegisterAGBase::setGroupName(const char *Name) { + assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!"); + InterfaceInfo->setPassName(Name); +} + +RegisterAGBase::~RegisterAGBase() { + if (ImplementationInfo) { + assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?"); + AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo]; + + assert(AGI.Implementations.count(ImplementationInfo) && + "Pass not a member of analysis group?"); + + if (AGI.DefaultImpl == ImplementationInfo) + AGI.DefaultImpl = 0; + + AGI.Implementations.erase(ImplementationInfo); + + // Last member of this analysis group? Unregister PassInfo, delete map entry + if (AGI.Implementations.empty()) { + assert(AGI.DefaultImpl == 0 && + "Default implementation didn't unregister?"); + AnalysisGroupInfoMap->erase(InterfaceInfo); + if (AnalysisGroupInfoMap->empty()) { // Delete map if empty + delete AnalysisGroupInfoMap; + AnalysisGroupInfoMap = 0; + } + + unregisterPass(InterfaceInfo); + } + } +} //===----------------------------------------------------------------------===//