//
//===----------------------------------------------------------------------===//
-#include "llvm/Pass.h"
+#include "llvm/PassManager.h"
+#include "PassManagerT.h" // PassManagerT implementation
+#include "llvm/Module.h"
+#include "llvm/Function.h"
+#include "llvm/BasicBlock.h"
#include "Support/STLExtras.h"
-#include <algorithm>
-
-// 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.
-//
-#ifdef NDEBUG
-// If not debugging, remove the option
-inline static void PrintPassInformation(const char *, Pass *, Value *) { }
-#else
-
#include "Support/CommandLine.h"
#include <typeinfo>
#include <iostream>
+#include <sys/time.h>
+#include <stdio.h>
+
+// Source of unique analysis ID #'s.
+unsigned AnalysisID::NextID = 0;
+
+void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
+ assert(P->Resolver == 0 && "Pass already in a PassManager!");
+ P->Resolver = AR;
+}
-// The option is hidden from --help by default
-static cl::Flag PassDebugEnabled("debug-pass",
- "Print pass names as they are executed by the PassManager", cl::Hidden);
-static void PrintPassInformation(const char *Action, Pass *P, Value *V) {
- if (PassDebugEnabled)
- std::cerr << Action << " Pass '" << typeid(*P).name() << "' on "
- << typeid(*V).name() << " '" << V->getName() << "'...\n";
+// 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() {
+ // FIXME: implement preservesCFG
}
-#endif
+//===----------------------------------------------------------------------===//
+// PassManager implementation - The PassManager class is a simple Pimpl class
+// that wraps the PassManagerT template.
+//
+PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
+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::Flag EnableTiming("time-passes", "Time each pass, printing elapsed"
+ " time for each on exit");
-PassManager::~PassManager() {
- for_each(Passes.begin(), Passes.end(), deleter<Pass>);
+static double getTime() {
+ struct timeval T;
+ gettimeofday(&T, 0);
+ return T.tv_sec + T.tv_usec/1000000.0;
}
-class BasicBlockPassBatcher : public MethodPass {
- typedef std::vector<BasicBlockPass*> SubPassesType;
- SubPassesType SubPasses;
-public:
- ~BasicBlockPassBatcher() {
- for_each(SubPasses.begin(), SubPasses.end(), deleter<BasicBlockPass>);
- }
+// 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 add(BasicBlockPass *P) { SubPasses.push_back(P); }
+void TimingInfo::passStarted(Pass *P) { TimingData[P] -= getTime(); }
+void TimingInfo::passEnded(Pass *P) { TimingData[P] += getTime(); }
- virtual bool doInitialization(Module *M) {
- bool Changed = false;
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Initializing", *I, M);
- Changed |= (*I)->doInitialization(M);
+// 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<pair<double, Pass*> > Data;
+ double TotalTime = 0;
+ for (std::map<Pass*, double>::iterator I = TimingData.begin(),
+ E = TimingData.end(); I != E; ++I)
+ // Throw out results for "grouping" pass managers...
+ if (!dynamic_cast<AnalysisResolver*>(I->first)) {
+ Data.push_back(std::make_pair(I->second, I->first));
+ TotalTime += I->second;
}
- return Changed;
- }
+
+ // Sort the data by time as the primary key, in reverse order...
+ std::sort(Data.begin(), Data.end(), greater<pair<double, Pass*> >());
- virtual bool runOnMethod(Method *M) {
- bool Changed = false;
+ // Print out timing header...
+ 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";
- for (Method::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI)
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Executing", *I, *MI);
- Changed |= (*I)->runOnBasicBlock(*MI);
- }
- return Changed;
+ // 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());
}
+ cerr << " 100.00% " << TotalTime << "s\tTOTAL\n"
+ << std::string(79, '=') << "\n";
+}
- virtual bool doFinalization(Module *M) {
- bool Changed = false;
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Finalizing", *I, M);
- Changed |= (*I)->doFinalization(M);
- }
- return Changed;
- }
+
+//===----------------------------------------------------------------------===//
+// 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, PassStructure, PassExecutions, PassDetails
};
-class MethodPassBatcher : public Pass {
- typedef std::vector<MethodPass*> SubPassesType;
- SubPassesType SubPasses;
- BasicBlockPassBatcher *BBPBatcher;
-public:
- inline MethodPassBatcher() : BBPBatcher(0) {}
+static cl::Enum<enum PassDebugLevel> PassDebugging("debug-pass", cl::Hidden,
+ "Print PassManager debugging information",
+ clEnumVal(None , "disable debug output"),
+ clEnumVal(PassStructure , "print pass structure before run()"),
+ clEnumVal(PassExecutions, "print pass name before it is executed"),
+ clEnumVal(PassDetails , "print pass details when it is executed"), 0);
- inline ~MethodPassBatcher() {
- for_each(SubPasses.begin(), SubPasses.end(), deleter<MethodPass>);
- }
+void PMDebug::PrintPassStructure(Pass *P) {
+ if (PassDebugging >= PassStructure)
+ P->dumpPassStructure();
+}
- void add(BasicBlockPass *BBP) {
- if (BBPBatcher == 0) {
- BBPBatcher = new BasicBlockPassBatcher();
- SubPasses.push_back(BBPBatcher);
+void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
+ Pass *P, Annotable *V) {
+ if (PassDebugging >= PassExecutions) {
+ std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
+ << P->getPassName();
+ if (V) {
+ std::cerr << "' on ";
+
+ if (dynamic_cast<Module*>(V)) {
+ std::cerr << "Module\n"; return;
+ } else if (Function *F = dynamic_cast<Function*>(V))
+ std::cerr << "Function '" << F->getName();
+ else if (BasicBlock *BB = dynamic_cast<BasicBlock*>(V))
+ std::cerr << "BasicBlock '" << BB->getName();
+ else if (Value *Val = dynamic_cast<Value*>(V))
+ std::cerr << typeid(*Val).name() << " '" << Val->getName();
}
- BBPBatcher->add(BBP);
+ std::cerr << "'...\n";
}
+}
- void add(MethodPass *P) {
- if (BasicBlockPass *BBP = dynamic_cast<BasicBlockPass*>(P)) {
- add(BBP);
- } else {
- BBPBatcher = 0; // Ensure that passes don't get accidentally reordered
- SubPasses.push_back(P);
+void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
+ Pass *P, const std::vector<AnalysisID> &Set){
+ if (PassDebugging >= PassDetails && !Set.empty()) {
+ std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
+ for (unsigned i = 0; i != Set.size(); ++i) {
+ Pass *P = Set[i].createPass(); // Good thing this is just debug code...
+ std::cerr << " " << P->getPassName();
+ delete P;
}
+ std::cerr << "\n";
}
+}
- virtual bool run(Module *M) {
- bool Changed = false;
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Initializing", *I, M);
- Changed |= (*I)->doInitialization(M);
- }
+// dumpPassStructure - Implement the -debug-passes=PassStructure option
+void Pass::dumpPassStructure(unsigned Offset = 0) {
+ std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
+}
- for (Module::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI)
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Executing", *I, M);
- Changed |= (*I)->runOnMethod(*MI);
- }
-
- for (SubPassesType::iterator I = SubPasses.begin(), E = SubPasses.end();
- I != E; ++I) {
- PrintPassInformation("Finalizing", *I, M);
- Changed |= (*I)->doFinalization(M);
- }
- return Changed;
- }
-};
-// add(BasicBlockPass*) - If we know it's a BasicBlockPass, we don't have to do
-// any checking...
+//===----------------------------------------------------------------------===//
+// Pass Implementation
//
-void PassManager::add(BasicBlockPass *BBP) {
- if (Batcher == 0) // If we don't have a batcher yet, make one now.
- add((MethodPass*)BBP);
- else
- Batcher->add(BBP);
+
+void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
+ PM->addPass(this, AU);
}
-// add(MethodPass*) - MethodPass's must be batched together... make sure this
-// happens now.
+// getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
//
-void PassManager::add(MethodPass *MP) {
- if (Batcher == 0) { // If we don't have a batcher yet, make one now.
- Batcher = new MethodPassBatcher();
- Passes.push_back(Batcher);
- }
- Batcher->add(MP); // The Batcher will queue them passes up
+const char *Pass::getPassName() const { return typeid(*this).name(); }
+
+//===----------------------------------------------------------------------===//
+// FunctionPass Implementation
+//
+
+// 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 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!
+ Changed |= runOnFunction(*I);
+
+ return Changed | doFinalization(M);
}
-// add - Add a pass to the PassManager, batching it up as appropriate...
-void PassManager::add(Pass *P) {
- if (MethodPass *MP = dynamic_cast<MethodPass*>(P)) {
- add(MP); // Use the methodpass specific code to do the addition
- } else {
- Batcher = 0; // Ensure that passes don't get accidentally reordered
- Passes.push_back(P);
- }
+// 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!
+
+ return doInitialization(F->getParent()) | runOnFunction(F)
+ | doFinalization(F->getParent());
}
+void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
+ AnalysisUsage &AU) {
+ PM->addPass(this, AU);
+}
-bool PassManager::run(Module *M) {
- bool MadeChanges = false;
- // Run all of the pass initializers
- for (unsigned i = 0, e = Passes.size(); i < e; ++i) {
- PrintPassInformation("Executing", Passes[i], M);
- MadeChanges |= Passes[i]->run(M);
- }
- return MadeChanges;
+void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
+ AnalysisUsage &AU) {
+ PM->addPass(this, AU);
+}
+
+//===----------------------------------------------------------------------===//
+// BasicBlockPass Implementation
+//
+
+// To run this pass on a function, we simply call runOnBasicBlock once for each
+// function.
+//
+bool BasicBlockPass::runOnFunction(Function *F) {
+ bool Changed = false;
+ for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
+ Changed |= runOnBasicBlock(*I);
+ return Changed;
}
+
+// 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);
+}
+
+void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
+ AnalysisUsage &AU) {
+ PM->addPass(this, AU);
+}
+
+void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
+ AnalysisUsage &AU) {
+ PM->addPass(this, AU);
+}
+
projects / oota-llvm.git / blobdiff