-//===- 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
#define LLVM_PASSMANAGER_T_H
#include "llvm/Pass.h"
-#include "Support/CommandLine.h"
-#include "Support/LeakDetector.h"
-#include "Support/Timer.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/LeakDetector.h"
+#include "llvm/Support/Timer.h"
#include <algorithm>
#include <iostream>
-class Annotable;
+
+namespace llvm {
//===----------------------------------------------------------------------===//
// Pass debugging information. Often it is useful to find out what pass is
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));
+ clEnumValEnd));
//===----------------------------------------------------------------------===//
// PMDebug class - a set of debugging functions, that are not to be
}
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> &);
};
// Private ctor, must use 'create' member
TimingInfo() : TG("... Pass execution timing report ...") {}
public:
- // Create method. If Timing is enabled, this creates and returns a new timing
- // object, otherwise it returns null.
- //
- static TimingInfo *create();
-
// TimingDtor - Print out information about timing information
~TimingInfo() {
// Delete all of the timers...
// TimerGroup is deleted next, printing the report.
}
+ // 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);
}
};
+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;
+#if defined(_MSC_VER) || defined(__INTEL_COMPILER) || defined(__HP_aCC)
+ friend PassClass;
+ friend SubPassClass;
+#else
+ friend class PassManagerTraits<UnitType>::PassClass;
+ friend class PassManagerTraits<UnitType>::SubPassClass;
+#endif
+ friend class PassManagerTraits<UnitType>;
friend class ImmutablePass;
std::vector<PassClass*> Passes; // List of passes to run
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];
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;
}
// 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...
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());
++I; // This analysis is preserved, leave it in the available set...
else {
if (!dynamic_cast<ImmutablePass*>(I->second)) {
-#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
+ std::map<AnalysisID, Pass*>::iterator J = I++;
+ CurrentAnalyses.erase(J); // Analysis not preserved!
} else {
++I;
}
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();
}
}
}
}
+
return MadeChanges;
}
}
}
+ 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 0;
+ }
+
Pass *getAnalysisOrNullDown(const PassInfo *ID) const {
std::map<AnalysisID, Pass*>::const_iterator I = CurrentAnalyses.find(ID);
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;
if (Parent) // Try scanning...
return Parent->getAnalysisOrNullUp(ID);
+ else if (!ImmutablePasses.empty())
+ return getImmutablePassOrNull(ID);
return 0;
}
- // {start/end}Pass - Called when a pass is started, it just propagates
- // 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);
- }
- void endPass(Pass *P) {
- if (Parent) Parent->endPass(P);
- else PassEnded(P);
- }
-
// markPassUsed - Inform higher level pass managers (and ourselves)
// that these analyses are being used by this pass. This is used to
// make sure that analyses are not free'd before we have to use
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, propagate to parent pass manager... We tell the
if (Parent) {
Parent->markPassUsed(P, this);
} else {
- assert(0 && "Pass available but not found! "
+ assert(getAnalysisOrNullUp(P) &&
+ dynamic_cast<ImmutablePass*>(getAnalysisOrNullUp(P)) &&
+ "Pass available but not found! "
"Perhaps this is a module pass requiring a function pass?");
}
}
// 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());
+ if (getAnalysisOrNullDown(*I) == 0) {
+ Pass *AP = (*I)->createPass();
+ if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (AP)) { add(IP); }
+ else if (PassClass *RP = dynamic_cast<PassClass *> (AP)) { add(RP); }
+ else { assert (0 && "Wrong kind of pass for this PassManager"); }
+ }
}
// Tell the pass to add itself to this PassManager... the way it does so
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) {
+ Pass *AP = (*I)->createPass();
+ if (ImmutablePass *IP = dynamic_cast<ImmutablePass *> (AP)) add(IP);
+ else if (PassClass *RP = dynamic_cast<PassClass *> (AP)) add(RP);
+ else assert (0 && "Wrong kind of pass for this PassManager");
+ }
+ }
+
+ // 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
//
setAnalysisResolver(IP, this);
ImmutablePasses.push_back(IP);
-
- // Add this pass to the currently available set...
- if (const PassInfo *PI = IP->getPassInfo()) {
- CurrentAnalyses[PI] = IP;
- // 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]] = 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();
}
};
// This pass manager is used to group together all of the BasicBlockPass's
// into a single unit.
//
-template<> struct PassManagerTraits<BasicBlock> : public BasicBlockPass {
+template<> class PassManagerTraits<BasicBlock> : public BasicBlockPass {
+public:
// PassClass - The type of passes tracked by this PassManager
typedef BasicBlockPass PassClass;
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"; }
// This pass manager is used to group together all of the FunctionPass's
// into a single unit.
//
-template<> struct PassManagerTraits<Function> : public FunctionPass {
+template<> class PassManagerTraits<Function> : public FunctionPass {
+public:
// PassClass - The type of passes tracked by this PassManager
typedef FunctionPass PassClass;
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"; }
//
// This is the top level PassManager implementation that holds generic passes.
//
-template<> struct PassManagerTraits<Module> : public Pass {
+template<> class PassManagerTraits<Module> : public ModulePass {
+public:
// PassClass - The type of passes tracked by this PassManager
- typedef Pass PassClass;
+ typedef ModulePass PassClass;
// SubPassClass - The types of classes that should be collated together
typedef FunctionPass SubPassClass;
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->runOnModule(*M); }
// getPMName() - Return the name of the unit the PassManager operates on for
// debugging.
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);
+ // runOnModule - Implement the PassManager interface.
+ bool runOnModule(Module &M) {
+ return ((PassManagerT<Module>*)this)->runOnUnit(&M);
}
-
- // 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;
- }
-
- // 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;
}
+} // End llvm namespace
+
#endif