1 //===- Pass.cpp - LLVM Pass Infrastructure Impementation ------------------===//
3 // This file implements the LLVM Pass infrastructure. It is primarily
4 // responsible with ensuring that passes are executed and batched together
7 //===----------------------------------------------------------------------===//
9 #include "llvm/PassManager.h"
10 #include "PassManagerT.h" // PassManagerT implementation
11 #include "llvm/Module.h"
12 #include "Support/STLExtras.h"
13 #include "Support/CommandLine.h"
14 #include "Support/TypeInfo.h"
20 //===----------------------------------------------------------------------===//
21 // AnalysisID Class Implementation
24 static std::vector<AnalysisID> CFGOnlyAnalyses;
26 // Source of unique analysis ID #'s.
27 unsigned AnalysisID::NextID = 0;
29 AnalysisID::AnalysisID(const AnalysisID &AID, bool DependsOnlyOnCFG) {
30 ID = AID.ID; // Implement the copy ctor part...
31 Constructor = AID.Constructor;
33 // If this analysis only depends on the CFG of the function, add it to the CFG
36 CFGOnlyAnalyses.push_back(AID);
39 //===----------------------------------------------------------------------===//
40 // AnalysisResolver Class Implementation
43 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
44 assert(P->Resolver == 0 && "Pass already in a PassManager!");
48 //===----------------------------------------------------------------------===//
49 // AnalysisUsage Class Implementation
52 // preservesCFG - This function should be called to by the pass, iff they do
55 // 1. Add or remove basic blocks from the function
56 // 2. Modify terminator instructions in any way.
58 // This function annotates the AnalysisUsage info object to say that analyses
59 // that only depend on the CFG are preserved by this pass.
61 void AnalysisUsage::preservesCFG() {
62 // Since this transformation doesn't modify the CFG, it preserves all analyses
63 // that only depend on the CFG (like dominators, loop info, etc...)
65 Preserved.insert(Preserved.end(),
66 CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end());
70 //===----------------------------------------------------------------------===//
71 // PassManager implementation - The PassManager class is a simple Pimpl class
72 // that wraps the PassManagerT template.
74 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
75 PassManager::~PassManager() { delete PM; }
76 void PassManager::add(Pass *P) { PM->add(P); }
77 bool PassManager::run(Module &M) { return PM->run(M); }
80 //===----------------------------------------------------------------------===//
81 // TimingInfo Class - This class is used to calculate information about the
82 // amount of time each pass takes to execute. This only happens with
83 // -time-passes is enabled on the command line.
86 EnableTiming("time-passes",
87 cl::desc("Time each pass, printing elapsed time for each on exit"));
89 static double getTime() {
92 return T.tv_sec + T.tv_usec/1000000.0;
95 // Create method. If Timing is enabled, this creates and returns a new timing
96 // object, otherwise it returns null.
98 TimingInfo *TimingInfo::create() {
99 return EnableTiming ? new TimingInfo() : 0;
102 void TimingInfo::passStarted(Pass *P) { TimingData[P] -= getTime(); }
103 void TimingInfo::passEnded(Pass *P) { TimingData[P] += getTime(); }
105 // TimingDtor - Print out information about timing information
106 TimingInfo::~TimingInfo() {
107 // Iterate over all of the data, converting it into the dual of the data map,
108 // so that the data is sorted by amount of time taken, instead of pointer.
110 std::vector<std::pair<double, Pass*> > Data;
111 double TotalTime = 0;
112 for (std::map<Pass*, double>::iterator I = TimingData.begin(),
113 E = TimingData.end(); I != E; ++I)
114 // Throw out results for "grouping" pass managers...
115 if (!dynamic_cast<AnalysisResolver*>(I->first)) {
116 Data.push_back(std::make_pair(I->second, I->first));
117 TotalTime += I->second;
120 // Sort the data by time as the primary key, in reverse order...
121 std::sort(Data.begin(), Data.end(), std::greater<std::pair<double, Pass*> >());
123 // Print out timing header...
124 std::cerr << std::string(79, '=') << "\n"
125 << " ... Pass execution timing report ...\n"
126 << std::string(79, '=') << "\n Total Execution Time: " << TotalTime
127 << " seconds\n\n % Time: Seconds:\tPass Name:\n";
129 // Loop through all of the timing data, printing it out...
130 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
131 fprintf(stderr, " %6.2f%% %fs\t%s\n", Data[i].first*100 / TotalTime,
132 Data[i].first, Data[i].second->getPassName());
134 std::cerr << " 100.00% " << TotalTime << "s\tTOTAL\n"
135 << std::string(79, '=') << "\n";
139 //===----------------------------------------------------------------------===//
140 // Pass debugging information. Often it is useful to find out what pass is
141 // running when a crash occurs in a utility. When this library is compiled with
142 // debugging on, a command line option (--debug-pass) is enabled that causes the
143 // pass name to be printed before it executes.
146 // Different debug levels that can be enabled...
147 enum PassDebugLevel {
148 None, Structure, Executions, Details
151 static cl::opt<enum PassDebugLevel>
152 PassDebugging("debug-pass", cl::Hidden,
153 cl::desc("Print PassManager debugging information"),
155 clEnumVal(None , "disable debug output"),
156 // TODO: add option to print out pass names "PassOptions"
157 clEnumVal(Structure , "print pass structure before run()"),
158 clEnumVal(Executions, "print pass name before it is executed"),
159 clEnumVal(Details , "print pass details when it is executed"),
162 void PMDebug::PrintPassStructure(Pass *P) {
163 if (PassDebugging >= Structure)
164 P->dumpPassStructure();
167 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
168 Pass *P, Annotable *V) {
169 if (PassDebugging >= Executions) {
170 std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
173 std::cerr << "' on ";
175 if (dynamic_cast<Module*>(V)) {
176 std::cerr << "Module\n"; return;
177 } else if (Function *F = dynamic_cast<Function*>(V))
178 std::cerr << "Function '" << F->getName();
179 else if (BasicBlock *BB = dynamic_cast<BasicBlock*>(V))
180 std::cerr << "BasicBlock '" << BB->getName();
181 else if (Value *Val = dynamic_cast<Value*>(V))
182 std::cerr << typeid(*Val).name() << " '" << Val->getName();
184 std::cerr << "'...\n";
188 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
189 Pass *P, const std::vector<AnalysisID> &Set){
190 if (PassDebugging >= Details && !Set.empty()) {
191 std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
192 for (unsigned i = 0; i != Set.size(); ++i) {
193 Pass *P = Set[i].createPass(); // Good thing this is just debug code...
194 std::cerr << " " << P->getPassName();
201 // dumpPassStructure - Implement the -debug-passes=Structure option
202 void Pass::dumpPassStructure(unsigned Offset) {
203 std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
207 //===----------------------------------------------------------------------===//
208 // Pass Implementation
211 void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
212 PM->addPass(this, AU);
216 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
218 const char *Pass::getPassName() const { return typeid(*this).name(); }
220 //===----------------------------------------------------------------------===//
221 // FunctionPass Implementation
224 // run - On a module, we run this pass by initializing, runOnFunction'ing once
225 // for every function in the module, then by finalizing.
227 bool FunctionPass::run(Module &M) {
228 bool Changed = doInitialization(M);
230 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
231 if (!I->isExternal()) // Passes are not run on external functions!
232 Changed |= runOnFunction(*I);
234 return Changed | doFinalization(M);
237 // run - On a function, we simply initialize, run the function, then finalize.
239 bool FunctionPass::run(Function &F) {
240 if (F.isExternal()) return false;// Passes are not run on external functions!
242 return doInitialization(*F.getParent()) | runOnFunction(F)
243 | doFinalization(*F.getParent());
246 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
248 PM->addPass(this, AU);
251 void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
253 PM->addPass(this, AU);
256 //===----------------------------------------------------------------------===//
257 // BasicBlockPass Implementation
260 // To run this pass on a function, we simply call runOnBasicBlock once for each
263 bool BasicBlockPass::runOnFunction(Function &F) {
264 bool Changed = false;
265 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
266 Changed |= runOnBasicBlock(*I);
270 // To run directly on the basic block, we initialize, runOnBasicBlock, then
273 bool BasicBlockPass::run(BasicBlock &BB) {
274 Module &M = *BB.getParent()->getParent();
275 return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M);
278 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
280 PM->addPass(this, AU);
283 void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
285 PM->addPass(this, AU);
289 //===----------------------------------------------------------------------===//
290 // Pass Registration mechanism
292 static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
293 static std::vector<PassRegistrationListener*> *Listeners = 0;
295 // getPassInfo - Return the PassInfo data structure that corresponds to this
297 const PassInfo *Pass::getPassInfo() const {
298 assert(PassInfoMap && "PassInfoMap not constructed yet??");
299 std::map<TypeInfo, PassInfo*>::iterator I =
300 PassInfoMap->find(typeid(*this));
301 assert(I != PassInfoMap->end() && "Pass has not been registered!");
305 void RegisterPassBase::registerPass(PassInfo *PI) {
306 if (PassInfoMap == 0)
307 PassInfoMap = new std::map<TypeInfo, PassInfo*>();
309 assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
310 "Pass already registered!");
312 PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
314 // Notify any listeners...
316 for (std::vector<PassRegistrationListener*>::iterator
317 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
318 (*I)->passRegistered(PI);
321 RegisterPassBase::~RegisterPassBase() {
322 assert(PassInfoMap && "Pass registered but not in map!");
323 std::map<TypeInfo, PassInfo*>::iterator I =
324 PassInfoMap->find(PIObj->getTypeInfo());
325 assert(I != PassInfoMap->end() && "Pass registered but not in map!");
327 // Remove pass from the map...
328 PassInfoMap->erase(I);
329 if (PassInfoMap->empty()) {
334 // Notify any listeners...
336 for (std::vector<PassRegistrationListener*>::iterator
337 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
338 (*I)->passUnregistered(PIObj);
340 // Delete the PassInfo object itself...
346 //===----------------------------------------------------------------------===//
347 // PassRegistrationListener implementation
350 // PassRegistrationListener ctor - Add the current object to the list of
351 // PassRegistrationListeners...
352 PassRegistrationListener::PassRegistrationListener() {
353 if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
354 Listeners->push_back(this);
357 // dtor - Remove object from list of listeners...
358 PassRegistrationListener::~PassRegistrationListener() {
359 std::vector<PassRegistrationListener*>::iterator I =
360 std::find(Listeners->begin(), Listeners->end(), this);
361 assert(Listeners && I != Listeners->end() &&
362 "PassRegistrationListener not registered!");
365 if (Listeners->empty()) {
371 // enumeratePasses - Iterate over the registered passes, calling the
372 // passEnumerate callback on each PassInfo object.
374 void PassRegistrationListener::enumeratePasses() {
376 for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
377 E = PassInfoMap->end(); I != E; ++I)
378 passEnumerate(I->second);