#define LLVM_PASSMANAGER_T_H
#include "llvm/Pass.h"
-#include <string>
+#include "Support/CommandLine.h"
+#include "Support/LeakDetector.h"
#include <algorithm>
+#include <iostream>
class Annotable;
+//===----------------------------------------------------------------------===//
+// 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.
+//
+
+// Different debug levels that can be enabled...
+enum PassDebugLevel {
+ None, Arguments, Structure, Executions, Details
+};
+
+static cl::opt<enum PassDebugLevel>
+PassDebugging("debug-pass", cl::Hidden,
+ cl::desc("Print PassManager debugging information"),
+ cl::values(
+ clEnumVal(None , "disable debug output"),
+ clEnumVal(Arguments , "print pass arguments to pass to 'opt'"),
+ clEnumVal(Structure , "print pass structure before run()"),
+ clEnumVal(Executions, "print pass name before it is executed"),
+ clEnumVal(Details , "print pass details when it is executed"),
+ 0));
+
//===----------------------------------------------------------------------===//
// PMDebug class - a set of debugging functions, that are not to be
// instantiated by the template.
//
struct PMDebug {
- // If compiled in debug mode, these functions can be enabled by setting
- // -debug-pass on the command line of the tool being used.
- //
- static void PrintPassStructure(Pass *P);
+ static void PerformPassStartupStuff(Pass *P) {
+ // If debugging is enabled, print out argument information...
+ if (PassDebugging >= Arguments) {
+ std::cerr << "Pass Arguments: ";
+ PrintArgumentInformation(P);
+ std::cerr << "\n";
+
+ // Print the pass execution structure
+ if (PassDebugging >= Structure)
+ P->dumpPassStructure();
+ }
+ }
+
+ static void PrintArgumentInformation(const Pass *P);
static void PrintPassInformation(unsigned,const char*,Pass *, Annotable *);
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;
+
+ void print(const char *PassName, const TimeRecord &TotalTime) const;
+};
+
class TimingInfo {
- std::map<Pass*, double> TimingData;
+ 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
void passEnded(Pass *P);
};
-
-
//===----------------------------------------------------------------------===//
// Declare the PassManagerTraits which will be specialized...
//
friend typename Traits::SubPassClass;
friend class Traits;
- std::vector<PassClass*> Passes; // List of pass's to run
+ std::vector<PassClass*> Passes; // List of passes to run
// The parent of this pass manager...
ParentClass * const Parent;
PassManagerT(ParentClass *Par = 0) : Parent(Par), Batcher(0) {}
~PassManagerT() {
// Delete all of the contained passes...
- for (std::vector<PassClass*>::iterator I = Passes.begin(), E = Passes.end();
- I != E; ++I)
+ for (typename std::vector<PassClass*>::iterator
+ I = Passes.begin(), E = Passes.end(); I != E; ++I)
delete *I;
}
// Output debug information...
- if (Parent == 0) PMDebug::PrintPassStructure(this);
+ if (Parent == 0) PMDebug::PerformPassStartupStuff(this);
// Run all of the passes
for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
PMDebug::PrintAnalysisSetInfo(getDepth(), "Required", P,
AnUsage.getRequiredSet());
-#ifndef NDEBUG
- // All Required analyses should be available to the pass as it runs!
- for (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);
endPass(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::PrintAnalysisSetInfo(getDepth(), "Preserved", P,
AnUsage.getPreservedSet());
- PMDebug::PrintAnalysisSetInfo(getDepth(), "Provided", P,
- AnUsage.getProvidedSet());
// Erase all analyses not in the preserved set...
}
}
- // Add all analyses in the provided set...
- for (std::vector<AnalysisID>::const_iterator
- I = AnUsage.getProvidedSet().begin(),
- E = AnUsage.getProvidedSet().end(); I != E; ++I)
- CurrentAnalyses[*I] = P;
+ // 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()) {
+ 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];
virtual void dumpPassStructure(unsigned Offset = 0) {
std::cerr << std::string(Offset*2, ' ') << Traits::getPMName()
<< " Pass Manager\n";
- for (std::vector<PassClass*>::iterator I = Passes.begin(), E = Passes.end();
- I != E; ++I) {
+ for (typename std::vector<PassClass*>::iterator
+ I = Passes.begin(), E = Passes.end(); I != E; ++I) {
PassClass *P = *I;
P->dumpPassStructure(Offset+1);
for (std::map<Pass*, Pass*>::iterator I = LastUseOf.begin(),
E = LastUseOf.end(); I != E; ++I) {
if (P == I->second) {
- std::cerr << "Fr" << std::string(Offset*2, ' ');
+ std::cerr << "--" << std::string(Offset*2, ' ');
I->first->dumpPassStructure(0);
}
}
}
}
- Pass *getAnalysisOrNullDown(AnalysisID ID) const {
+ Pass *getAnalysisOrNullDown(const PassInfo *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;
- }
- return I->second;
+
+ if (I != CurrentAnalyses.end())
+ return I->second; // Found it.
+
+ if (Batcher)
+ return ((AnalysisResolver*)Batcher)->getAnalysisOrNullDown(ID);
+ return 0;
}
- Pass *getAnalysisOrNullUp(AnalysisID ID) const {
+ Pass *getAnalysisOrNullUp(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;
+ if (I != CurrentAnalyses.end())
+ return I->second; // Found it.
+
+ if (Parent) // Try scanning...
+ return Parent->getAnalysisOrNullUp(ID);
+ return 0;
}
// {start/end}Pass - Called when a pass is started, it just propogates
// 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
} else {
// 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?");
+ assert(Parent != 0 && "Pass available but not found!");
Parent->markPassUsed(P, this);
}
}
return 1 + Parent->getDepth();
}
- // add - Add a pass to the queue of passes to run. This passes ownership of
+ virtual unsigned getNumContainedPasses() const { return Passes.size(); }
+ virtual const Pass *getContainedPass(unsigned N) const {
+ assert(N < Passes.size() && "Pass number out of range!");
+ return Passes[N];
+ }
+
+ // 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.
for (std::vector<AnalysisID>::const_iterator I = Required.begin(),
E = Required.end(); I != E; ++I) {
if (getAnalysisOrNullDown(*I) == 0)
- add((PassClass*)I->createPass());
+ add((PassClass*)(*I)->createPass());
}
// Tell the pass to add itself to this PassManager... the way it does so
//
void addPass(PassClass *P, AnalysisUsage &AnUsage) {
const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
- const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
- // Providers are analysis classes which are forbidden to modify the module
- // they are operating on, so they are allowed to be reordered to before the
- // batcher...
+ // FIXME: If this pass being added isn't killed by any of the passes in the
+ // batcher class then we can reorder to pass to execute before the batcher
+ // does, which will potentially allow us to batch more passes!
//
- if (Batcher && ProvidedSet.empty())
+ //const std::vector<AnalysisID> &ProvidedSet = AnUsage.getProvidedSet();
+ if (Batcher /*&& ProvidedSet.empty()*/)
closeBatcher(); // This pass cannot be batched!
// Set the Resolver instance variable in the Pass so that it knows where to
}
}
- // Add all analyses in the provided set...
- for (std::vector<AnalysisID>::const_iterator I = ProvidedSet.begin(),
- E = ProvidedSet.end(); I != E; ++I)
- CurrentAnalyses[*I] = P;
+ // Add this pass to the currently available set...
+ 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;
void addPass(SubPassClass *MP, AnalysisUsage &AnUsage) {
if (Batcher == 0) // If we don't have a batcher yet, make one now.
Batcher = new BatcherClass(this);
- // The Batcher will queue them passes up
+ // The Batcher will queue the passes up
MP->addToPassManager(Batcher, AnUsage);
}
// runPass - Specify how the pass should be run on the UnitType
static bool runPass(PassClass *P, BasicBlock *M) {
// todo, init and finalize
- return P->runOnBasicBlock(M);
+ return P->runOnBasicBlock(*M);
}
// Dummy implementation of PassStarted/PassEnded
virtual const char *getPassName() const { return "BasicBlock Pass Manager"; }
// Implement the BasicBlockPass interface...
- virtual bool doInitialization(Module *M);
- virtual bool runOnBasicBlock(BasicBlock *BB);
- virtual bool doFinalization(Module *M);
+ virtual bool doInitialization(Module &M);
+ virtual bool runOnBasicBlock(BasicBlock &BB);
+ virtual bool doFinalization(Module &M);
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ }
};
// runPass - Specify how the pass should be run on the UnitType
static bool runPass(PassClass *P, Function *F) {
- return P->runOnFunction(F);
+ return P->runOnFunction(*F);
}
// Dummy implementation of PassStarted/PassEnded
virtual const char *getPassName() const { return "Function Pass Manager"; }
// Implement the FunctionPass interface...
- virtual bool doInitialization(Module *M);
- virtual bool runOnFunction(Function *F);
- virtual bool doFinalization(Module *M);
+ virtual bool doInitialization(Module &M);
+ virtual bool runOnFunction(Function &F);
+ virtual bool doFinalization(Module &M);
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ }
};
typedef AnalysisResolver ParentClass;
// runPass - Specify how the pass should be run on the UnitType
- static bool runPass(PassClass *P, Module *M) { return P->run(M); }
+ static bool runPass(PassClass *P, Module *M) { return P->run(*M); }
// getPMName() - Return the name of the unit the PassManager operates on for
// debugging.
}
// run - Implement the PassManager interface...
- bool run(Module *M) {
+ bool run(Module &M) {
TimeInfo = TimingInfo::create();
- bool Result = ((PassManagerT<Module>*)this)->runOnUnit(M);
+ bool Result = ((PassManagerT<Module>*)this)->runOnUnit(&M);
if (TimeInfo) {
delete TimeInfo;
TimeInfo = 0;
// PassManagerTraits<BasicBlock> Implementations
//
-inline bool PassManagerTraits<BasicBlock>::doInitialization(Module *M) {
+inline bool PassManagerTraits<BasicBlock>::doInitialization(Module &M) {
bool Changed = false;
for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
((PMType*)this)->Passes[i]->doInitialization(M);
return Changed;
}
-inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock *BB) {
- return ((PMType*)this)->runOnUnit(BB);
+inline bool PassManagerTraits<BasicBlock>::runOnBasicBlock(BasicBlock &BB) {
+ return ((PMType*)this)->runOnUnit(&BB);
}
-inline bool PassManagerTraits<BasicBlock>::doFinalization(Module *M) {
+inline bool PassManagerTraits<BasicBlock>::doFinalization(Module &M) {
bool Changed = false;
for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
((PMType*)this)->Passes[i]->doFinalization(M);
// PassManagerTraits<Function> Implementations
//
-inline bool PassManagerTraits<Function>::doInitialization(Module *M) {
+inline bool PassManagerTraits<Function>::doInitialization(Module &M) {
bool Changed = false;
for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
((PMType*)this)->Passes[i]->doInitialization(M);
return Changed;
}
-inline bool PassManagerTraits<Function>::runOnFunction(Function *F) {
- return ((PMType*)this)->runOnUnit(F);
+inline bool PassManagerTraits<Function>::runOnFunction(Function &F) {
+ return ((PMType*)this)->runOnUnit(&F);
}
-inline bool PassManagerTraits<Function>::doFinalization(Module *M) {
+inline bool PassManagerTraits<Function>::doFinalization(Module &M) {
bool Changed = false;
for (unsigned i = 0, e = ((PMType*)this)->Passes.size(); i != e; ++i)
((PMType*)this)->Passes[i]->doFinalization(M);
projects / oota-llvm.git / blobdiff