-//===- PassManagerT.h - Container for Passes ---------------------*- C++ -*--=//
+//===- PassManagerT.h - Container for Passes --------------------*- C++ -*-===//
+//
+// 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 defines the PassManagerT class. This class is used to hold,
// maintain, and optimize execution of Pass's. The PassManager class ensures
#include "llvm/Pass.h"
#include "Support/CommandLine.h"
+#include "Support/LeakDetector.h"
+#include "Support/Timer.h"
#include <algorithm>
#include <iostream>
-class Annotable;
+
+namespace llvm {
//===----------------------------------------------------------------------===//
// Pass debugging information. Often it is useful to find out what pass is
}
static void PrintArgumentInformation(const Pass *P);
- static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
+ static void PrintPassInformation(unsigned,const char*,Pass *, Module *);
+ static void PrintPassInformation(unsigned,const char*,Pass *, Function *);
+ static void PrintPassInformation(unsigned,const char*,Pass *, BasicBlock *);
static void PrintAnalysisSetInfo(unsigned,const char*,Pass *P,
const std::vector<AnalysisID> &);
};
// amount of time each pass takes to execute. This only happens when
// -time-passes is enabled on the command line.
//
-struct TimeRecord { // TimeRecord - Data we collect and print for each pass
- double Elapsed; // Wall clock time elapsed in seconds
- double UserTime; // User time elapsed
- double SystemTime; // System time elapsed
- unsigned long MaxRSS; // Maximum resident set size (in bytes)
- unsigned long RSSTemp; // Temp for calculating maxrss
-
- TimeRecord() : Elapsed(0), UserTime(0), SystemTime(0), MaxRSS(0) {}
- void passStart(const TimeRecord &T);
- void passEnd(const TimeRecord &T);
- void sum(const TimeRecord &TR);
- bool operator<(const TimeRecord &TR) const {
- return UserTime+SystemTime < TR.UserTime+TR.SystemTime;
- }
-
- void print(const char *PassName, const TimeRecord &TotalTime) const;
-};
class TimingInfo {
- std::map<Pass*, TimeRecord> TimingData;
- TimingInfo() {} // Private ctor, must use create member
-public:
- // Create method. If Timing is enabled, this creates and returns a new timing
- // object, otherwise it returns null.
- //
- static TimingInfo *create();
+ std::map<Pass*, Timer> TimingData;
+ TimerGroup TG;
+ // Private ctor, must use 'create' member
+ TimingInfo() : TG("... Pass execution timing report ...") {}
+public:
// TimingDtor - Print out information about timing information
- ~TimingInfo();
+ ~TimingInfo() {
+ // Delete all of the timers...
+ TimingData.clear();
+ // TimerGroup is deleted next, printing the report.
+ }
- void passStarted(Pass *P);
- void passEnded(Pass *P);
+ // 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.
+ static void createTheTimeInfo();
+
+ void passStarted(Pass *P) {
+ if (dynamic_cast<AnalysisResolver*>(P)) return;
+ std::map<Pass*, Timer>::iterator I = TimingData.find(P);
+ if (I == TimingData.end())
+ I=TimingData.insert(std::make_pair(P, Timer(P->getPassName(), TG))).first;
+ I->second.startTimer();
+ }
+ void passEnded(Pass *P) {
+ if (dynamic_cast<AnalysisResolver*>(P)) return;
+ std::map<Pass*, Timer>::iterator I = TimingData.find(P);
+ assert (I != TimingData.end() && "passStarted/passEnded not nested right!");
+ I->second.stopTimer();
+ }
};
-
+static TimingInfo *TheTimeInfo;
//===----------------------------------------------------------------------===//
// Declare the PassManagerTraits which will be specialized...
typedef typename Traits::BatcherClass BatcherClass;
typedef typename Traits::ParentClass ParentClass;
- friend typename Traits::PassClass;
- friend typename Traits::SubPassClass;
- friend class Traits;
+#ifndef _MSC_VER
+ friend class PassManagerTraits<UnitType>::PassClass;
+ friend class PassManagerTraits<UnitType>::SubPassClass;
+#else
+ friend PassClass;
+ friend SubPassClass;
+#endif
+ friend class PassManagerTraits<UnitType>;
+ friend class ImmutablePass;
std::vector<PassClass*> Passes; // List of passes to run
+ std::vector<ImmutablePass*> ImmutablePasses; // List of immutable passes
// The parent of this pass manager...
ParentClass * const Parent;
for (typename std::vector<PassClass*>::iterator
I = Passes.begin(), E = Passes.end(); I != E; ++I)
delete *I;
+
+ for (std::vector<ImmutablePass*>::iterator
+ I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
+ delete *I;
}
// run - Run all of the queued passes on the specified module in an optimal
closeBatcher();
CurrentAnalyses.clear();
+ TimingInfo::createTheTimeInfo();
+
+ // Add any immutable passes to the CurrentAnalyses set...
+ for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
+ ImmutablePass *IPass = ImmutablePasses[i];
+ if (const PassInfo *PI = IPass->getPassInfo()) {
+ CurrentAnalyses[PI] = IPass;
+
+ const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+ for (unsigned i = 0, e = II.size(); i != e; ++i)
+ CurrentAnalyses[II[i]] = IPass;
+ }
+ }
+
// LastUserOf - This contains the inverted LastUseOfMap...
std::map<Pass *, std::vector<Pass*> > LastUserOf;
for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
E = LastUseOf.end(); I != E; ++I)
LastUserOf[I->second].push_back(I->first);
-
// Output debug information...
if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
PassClass *P = Passes[i];
- PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P,
- (Annotable*)M);
+ PMDebug::PrintPassInformation(getDepth(), "Executing Pass", P, M);
// Get information about what analyses the pass uses...
AnalysisUsage AnUsage;
PMDebug::PrintAnalysisSetInfo(getDepth(), "Required", P,
AnUsage.getRequiredSet());
-#ifndef NDEBUG
- // All Required analyses should be available to the pass as it runs!
- for (std::vector<AnalysisID>::const_iterator
+ // All Required analyses should be available to the pass as it runs! Here
+ // we fill in the AnalysisImpls member of the pass so that it can
+ // successfully use the getAnalysis() method to retrieve the
+ // implementations it needs.
+ //
+ P->AnalysisImpls.clear();
+ P->AnalysisImpls.reserve(AnUsage.getRequiredSet().size());
+ for (std::vector<const PassInfo *>::const_iterator
I = AnUsage.getRequiredSet().begin(),
E = AnUsage.getRequiredSet().end(); I != E; ++I) {
- assert(getAnalysisOrNullUp(*I) && "Analysis used but not available!");
+ Pass *Impl = getAnalysisOrNullUp(*I);
+ if (Impl == 0) {
+ std::cerr << "Analysis '" << (*I)->getPassName()
+ << "' used but not available!";
+ assert(0 && "Analysis used but not available!");
+ } else if (PassDebugging == Details) {
+ if ((*I)->getPassName() != std::string(Impl->getPassName()))
+ std::cerr << " Interface '" << (*I)->getPassName()
+ << "' implemented by '" << Impl->getPassName() << "'\n";
+ }
+ P->AnalysisImpls.push_back(std::make_pair(*I, Impl));
}
-#endif
// Run the sub pass!
- startPass(P);
+ if (TheTimeInfo) TheTimeInfo->passStarted(P);
bool Changed = runPass(P, M);
- endPass(P);
+ if (TheTimeInfo) TheTimeInfo->passEnded(P);
MadeChanges |= Changed;
+ // Check for memory leaks by the pass...
+ LeakDetector::checkForGarbage(std::string("after running pass '") +
+ P->getPassName() + "'");
+
if (Changed)
- PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P,
- (Annotable*)M);
+ PMDebug::PrintPassInformation(getDepth()+1, "Made Modification", P, M);
PMDebug::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
AnUsage.getPreservedSet());
// Erase all analyses not in the preserved set...
- if (!AnUsage.preservesAll()) {
+ if (!AnUsage.getPreservesAll()) {
const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
E = CurrentAnalyses.end(); I != E; )
PreservedSet.end())
++I; // This analysis is preserved, leave it in the available set...
else {
-#if MAP_DOESNT_HAVE_BROKEN_ERASE_MEMBER
- I = CurrentAnalyses.erase(I); // Analysis not preserved!
-#else
- // GCC 2.95.3 STL doesn't have correct erase member!
- CurrentAnalyses.erase(I);
- I = CurrentAnalyses.begin();
-#endif
+ if (!dynamic_cast<ImmutablePass*>(I->second)) {
+ std::map<AnalysisID, Pass*>::iterator J = I++;
+ CurrentAnalyses.erase(J); // Analysis not preserved!
+ } else {
+ ++I;
+ }
}
}
// Add the current pass to the set of passes that have been run, and are
// thus available to users.
//
- if (const PassInfo *PI = P->getPassInfo())
+ if (const PassInfo *PI = P->getPassInfo()) {
CurrentAnalyses[PI] = P;
+ // This pass is the current implementation of all of the interfaces it
+ // implements as well.
+ //
+ const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+ for (unsigned i = 0, e = II.size(); i != e; ++i)
+ CurrentAnalyses[II[i]] = P;
+ }
+
// Free memory for any passes that we are the last use of...
std::vector<Pass*> &DeadPass = LastUserOf[P];
for (std::vector<Pass*>::iterator I = DeadPass.begin(),E = DeadPass.end();
I != E; ++I) {
- PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I,
- (Annotable*)M);
+ PMDebug::PrintPassInformation(getDepth()+1, "Freeing Pass", *I, M);
(*I)->releaseMemory();
}
+
+ // Make sure to remove dead passes from the CurrentAnalyses list...
+ for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin();
+ I != CurrentAnalyses.end(); ) {
+ std::vector<Pass*>::iterator DPI = std::find(DeadPass.begin(),
+ DeadPass.end(), I->second);
+ if (DPI != DeadPass.end()) { // This pass is dead now... remove it
+ std::map<AnalysisID, Pass*>::iterator IDead = I++;
+ CurrentAnalyses.erase(IDead);
+ } else {
+ ++I; // Move on to the next element...
+ }
+ }
}
+
return MadeChanges;
}
// dumpPassStructure - Implement the -debug-passes=PassStructure option
virtual void dumpPassStructure(unsigned Offset = 0) {
+ // Print out the immutable passes...
+ for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i)
+ ImmutablePasses[i]->dumpPassStructure(0);
+
std::cerr << std::string(Offset*2, ' ') << Traits::getPMName()
<< " Pass Manager\n";
for (typename std::vector<PassClass*>::iterator
}
}
- Pass *getAnalysisOrNullDown(AnalysisID ID) const {
- std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
- if (I == CurrentAnalyses.end()) {
- if (Batcher)
- return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
- return 0;
+ Pass *getImmutablePassOrNull(const PassInfo *ID) const {
+ for (unsigned i = 0, e = ImmutablePasses.size(); i != e; ++i) {
+ const PassInfo *IPID = ImmutablePasses[i]->getPassInfo();
+ if (IPID == ID)
+ return ImmutablePasses[i];
+
+ // This pass is the current implementation of all of the interfaces it
+ // implements as well.
+ //
+ const std::vector<const PassInfo*> &II =
+ IPID->getInterfacesImplemented();
+ for (unsigned j = 0, e = II.size(); j != e; ++j)
+ if (II[j] == ID) return ImmutablePasses[i];
}
- return I->second;
+ return 0;
}
- Pass *getAnalysisOrNullUp(AnalysisID ID) const {
+ Pass *getAnalysisOrNullDown(const PassInfo *ID) const {
std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
- if (I == CurrentAnalyses.end()) {
- if (Parent)
- return Parent->getAnalysisOrNullUp(ID);
- return 0;
- }
- return I->second;
- }
- // {start/end}Pass - Called when a pass is started, it just propogates
- // information up to the top level PassManagerT object to tell it that a pass
- // has started or ended. This is used to gather timing information about
- // passes.
- //
- void startPass(Pass *P) {
- if (Parent) Parent->startPass(P);
- else PassStarted(P);
+ if (I != CurrentAnalyses.end())
+ return I->second; // Found it.
+
+ if (Pass *P = getImmutablePassOrNull(ID))
+ return P;
+
+ if (Batcher)
+ return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
+ return 0;
}
- void endPass(Pass *P) {
- if (Parent) Parent->endPass(P);
- else PassEnded(P);
+
+ Pass *getAnalysisOrNullUp(const PassInfo *ID) const {
+ std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
+ if (I != CurrentAnalyses.end())
+ return I->second; // Found it.
+
+ if (Parent) // Try scanning...
+ return Parent->getAnalysisOrNullUp(ID);
+ else if (!ImmutablePasses.empty())
+ return getImmutablePassOrNull(ID);
+ return 0;
}
// markPassUsed - Inform higher level pass managers (and ourselves)
// make sure that analyses are not free'd before we have to use
// them...
//
- void markPassUsed(AnalysisID P, Pass *User) {
- std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.find(P);
+ void markPassUsed(const PassInfo *P, Pass *User) {
+ std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(P);
+
if (I != CurrentAnalyses.end()) {
LastUseOf[I->second] = User; // Local pass, extend the lifetime
+
+ // Prolong live range of analyses that are needed after an analysis pass
+ // is destroyed, for querying by subsequent passes
+ AnalysisUsage AnUsage;
+ I->second->getAnalysisUsage(AnUsage);
+ const std::vector<AnalysisID> &IDs = AnUsage.getRequiredTransitiveSet();
+ for (std::vector<AnalysisID>::const_iterator i = IDs.begin(),
+ e = IDs.end(); i != e; ++i)
+ markPassUsed(*i, User);
+
} else {
// Pass not in current available set, must be a higher level pass
- // available to us, propogate to parent pass manager... We tell the
+ // available to us, propagate to parent pass manager... We tell the
// parent that we (the passmanager) are using the analysis so that it
// frees the analysis AFTER this pass manager runs.
//
- assert(Parent != 0 && "Pass available but not found! "
- "Did your analysis pass 'Provide' itself?");
- Parent->markPassUsed(P, this);
+ if (Parent) {
+ Parent->markPassUsed(P, this);
+ } else {
+ assert(getAnalysisOrNullUp(P) &&
+ dynamic_cast<ImmutablePass*>(getAnalysisOrNullUp(P)) &&
+ "Pass available but not found! "
+ "Perhaps this is a module pass requiring a function pass?");
+ }
}
}
-
+
// Return the number of parent PassManagers that exist
virtual unsigned getDepth() const {
if (Parent == 0) return 0;
return Passes[N];
}
- // add - Add a pass to the queue of passes to run. This passes ownership of
+ // add - Add a pass to the queue of passes to run. This gives ownership of
// the Pass to the PassManager. When the PassManager is destroyed, the pass
// will be destroyed as well, so there is no need to delete the pass. This
// implies that all passes MUST be new'd.
P->addToPassManager(this, AnUsage);
}
-private:
+ // add - H4x0r an ImmutablePass into a PassManager that might not be
+ // expecting one.
+ //
+ void add(ImmutablePass *P) {
+ // Get information about what analyses the pass uses...
+ AnalysisUsage AnUsage;
+ P->getAnalysisUsage(AnUsage);
+ const std::vector<AnalysisID> &Required = AnUsage.getRequiredSet();
+
+ // Loop over all of the analyses used by this pass,
+ for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
+ E = Required.end(); I != E; ++I) {
+ if (getAnalysisOrNullDown(*I) == 0)
+ add((PassClass*)(*I)->createPass());
+ }
+ // Add the ImmutablePass to this PassManager.
+ addPass(P, AnUsage);
+ }
+
+private:
// addPass - These functions are used to implement the subclass specific
// behaviors present in PassManager. Basically the add(Pass*) method ends up
// reflecting its behavior into a Pass::addToPassManager call. Subclasses of
markPassUsed(*I, P); // Mark *I as used by P
// Erase all analyses not in the preserved set...
- if (!AnUsage.preservesAll()) {
+ if (!AnUsage.getPreservesAll()) {
const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
for (std::map<AnalysisID, Pass*>::iterator I = CurrentAnalyses.begin(),
- E = CurrentAnalyses.end(); I != E; )
- if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) !=
- PreservedSet.end())
- ++I; // This analysis is preserved, leave it in the available set...
- else {
-#if MAP_DOESNT_HAVE_BROKEN_ERASE_MEMBER
- I = CurrentAnalyses.erase(I); // Analysis not preserved!
-#else
- CurrentAnalyses.erase(I);// GCC 2.95.3 STL doesn't have correct erase!
+ E = CurrentAnalyses.end(); I != E; ) {
+ if (std::find(PreservedSet.begin(), PreservedSet.end(), I->first) ==
+ PreservedSet.end()) { // Analysis not preserved!
+ CurrentAnalyses.erase(I); // Remove from available analyses
I = CurrentAnalyses.begin();
-#endif
+ } else {
+ ++I;
}
+ }
}
// Add this pass to the currently available set...
- if (const PassInfo *PI = P->getPassInfo())
+ if (const PassInfo *PI = P->getPassInfo()) {
CurrentAnalyses[PI] = P;
+ // This pass is the current implementation of all of the interfaces it
+ // implements as well.
+ //
+ const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+ for (unsigned i = 0, e = II.size(); i != e; ++i)
+ CurrentAnalyses[II[i]] = P;
+ }
+
// For now assume that our results are never used...
LastUseOf[P] = P;
}
Batcher = 0;
}
}
+
+public:
+ // When an ImmutablePass is added, it gets added to the top level pass
+ // manager.
+ void addPass(ImmutablePass *IP, AnalysisUsage &AU) {
+ if (Parent) { // Make sure this request goes to the top level passmanager...
+ Parent->addPass(IP, AU);
+ return;
+ }
+
+ // Set the Resolver instance variable in the Pass so that it knows where to
+ // find this object...
+ //
+ setAnalysisResolver(IP, this);
+ ImmutablePasses.push_back(IP);
+
+ // All Required analyses should be available to the pass as it initializes!
+ // Here we fill in the AnalysisImpls member of the pass so that it can
+ // successfully use the getAnalysis() method to retrieve the implementations
+ // it needs.
+ //
+ IP->AnalysisImpls.clear();
+ IP->AnalysisImpls.reserve(AU.getRequiredSet().size());
+ for (std::vector<const PassInfo *>::const_iterator
+ I = AU.getRequiredSet().begin(),
+ E = AU.getRequiredSet().end(); I != E; ++I) {
+ Pass *Impl = getAnalysisOrNullUp(*I);
+ if (Impl == 0) {
+ std::cerr << "Analysis '" << (*I)->getPassName()
+ << "' used but not available!";
+ assert(0 && "Analysis used but not available!");
+ } else if (PassDebugging == Details) {
+ if ((*I)->getPassName() != std::string(Impl->getPassName()))
+ std::cerr << " Interface '" << (*I)->getPassName()
+ << "' implemented by '" << Impl->getPassName() << "'\n";
+ }
+ IP->AnalysisImpls.push_back(std::make_pair(*I, Impl));
+ }
+
+ // Initialize the immutable pass...
+ IP->initializePass();
+ }
};
return P->runOnBasicBlock(*M);
}
- // Dummy implementation of PassStarted/PassEnded
- static void PassStarted(Pass *P) {}
- static void PassEnded(Pass *P) {}
-
// getPMName() - Return the name of the unit the PassManager operates on for
// debugging.
const char *getPMName() const { return "BasicBlock"; }
// Implement the BasicBlockPass interface...
virtual bool doInitialization(Module &M);
+ virtual bool doInitialization(Function &F);
virtual bool runOnBasicBlock(BasicBlock &BB);
+ virtual bool doFinalization(Function &F);
virtual bool doFinalization(Module &M);
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
return P->runOnFunction(*F);
}
- // Dummy implementation of PassStarted/PassEnded
- static void PassStarted(Pass *P) {}
- static void PassEnded(Pass *P) {}
-
// getPMName() - Return the name of the unit the PassManager operates on for
// debugging.
const char *getPMName() const { return "Function"; }
const char *getPMName() const { return "Module"; }
virtual const char *getPassName() const { return "Module Pass Manager"; }
- // TimingInformation - This data member maintains timing information for each
- // of the passes that is executed.
- //
- TimingInfo *TimeInfo;
-
- // PassStarted/Ended - This callback is notified any time a pass is started
- // or stops. This is used to collect timing information about the different
- // passes being executed.
- //
- void PassStarted(Pass *P) {
- if (TimeInfo) TimeInfo->passStarted(P);
- }
- void PassEnded(Pass *P) {
- if (TimeInfo) TimeInfo->passEnded(P);
- }
-
// run - Implement the PassManager interface...
bool run(Module &M) {
- TimeInfo = TimingInfo::create();
- bool Result = ((PassManagerT<Module>*)this)->runOnUnit(&M);
- if (TimeInfo) {
- delete TimeInfo;
- TimeInfo = 0;
- }
- return Result;
+ return ((PassManagerT<Module>*)this)->runOnUnit(&M);
}
-
- // PassManagerTraits constructor - Create a timing info object if the user
- // specified timing info should be collected on the command line.
- //
- PassManagerTraits() : TimeInfo(0) {}
};
return Changed;
}
+inline bool PassManagerTraits<BasicBlock>::doInitialization(Function &F) {
+ bool Changed = false;
+ for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
+ ((PMType*)this)->Passes[i]->doInitialization(F);
+ return Changed;
+}
+
inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock &BB) {
return ((PMType*)this)->runOnUnit(&BB);
}
+inline bool PassManagerTraits<BasicBlock>::doFinalization(Function &F) {
+ bool Changed = false;
+ for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
+ ((PMType*)this)->Passes[i]->doFinalization(F);
+ return Changed;
+}
+
inline bool PassManagerTraits<BasicBlock>::doFinalization(Module &M) {
bool Changed = false;
for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
return Changed;
}
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff