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/TypeInfo.h"
15 #include <sys/resource.h>
17 #include <sys/unistd.h>
20 // IncludeFile - Stub function used to help linking out.
21 IncludeFile::IncludeFile(void*) {}
23 //===----------------------------------------------------------------------===//
24 // AnalysisID Class Implementation
27 static std::vector<const PassInfo*> CFGOnlyAnalyses;
29 void RegisterPassBase::setPreservesCFG() {
30 CFGOnlyAnalyses.push_back(PIObj);
33 //===----------------------------------------------------------------------===//
34 // AnalysisResolver Class Implementation
37 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
38 assert(P->Resolver == 0 && "Pass already in a PassManager!");
42 //===----------------------------------------------------------------------===//
43 // AnalysisUsage Class Implementation
46 // preservesCFG - This function should be called to by the pass, iff they do
49 // 1. Add or remove basic blocks from the function
50 // 2. Modify terminator instructions in any way.
52 // This function annotates the AnalysisUsage info object to say that analyses
53 // that only depend on the CFG are preserved by this pass.
55 void AnalysisUsage::preservesCFG() {
56 // Since this transformation doesn't modify the CFG, it preserves all analyses
57 // that only depend on the CFG (like dominators, loop info, etc...)
59 Preserved.insert(Preserved.end(),
60 CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end());
64 //===----------------------------------------------------------------------===//
65 // PassManager implementation - The PassManager class is a simple Pimpl class
66 // that wraps the PassManagerT template.
68 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
69 PassManager::~PassManager() { delete PM; }
70 void PassManager::add(Pass *P) { PM->add(P); }
71 bool PassManager::run(Module &M) { return PM->run(M); }
74 //===----------------------------------------------------------------------===//
75 // TimingInfo Class - This class is used to calculate information about the
76 // amount of time each pass takes to execute. This only happens with
77 // -time-passes is enabled on the command line.
80 EnableTiming("time-passes",
81 cl::desc("Time each pass, printing elapsed time for each on exit"));
83 static TimeRecord getTimeRecord() {
84 static unsigned long PageSize = 0;
88 PageSize = sysconf(_SC_PAGE_SIZE);
91 PageSize = sysconf(_SC_PAGESIZE);
93 PageSize = getpagesize();
101 if (getrusage(RUSAGE_SELF, &RU)) {
102 perror("getrusage call failed: -time-passes info incorrect!");
106 Result.Elapsed = T.tv_sec + T.tv_usec/1000000.0;
107 Result.UserTime = RU.ru_utime.tv_sec + RU.ru_utime.tv_usec/1000000.0;
108 Result.SystemTime = RU.ru_stime.tv_sec + RU.ru_stime.tv_usec/1000000.0;
109 Result.MaxRSS = RU.ru_maxrss*PageSize;
114 bool TimeRecord::operator<(const TimeRecord &TR) const {
115 // Primary sort key is User+System time
116 if (UserTime+SystemTime < TR.UserTime+TR.SystemTime)
118 if (UserTime+SystemTime > TR.UserTime+TR.SystemTime)
121 // Secondary sort key is Wall Time
122 return Elapsed < TR.Elapsed;
125 void TimeRecord::passStart(const TimeRecord &T) {
126 Elapsed -= T.Elapsed;
127 UserTime -= T.UserTime;
128 SystemTime -= T.SystemTime;
132 void TimeRecord::passEnd(const TimeRecord &T) {
133 Elapsed += T.Elapsed;
134 UserTime += T.UserTime;
135 SystemTime += T.SystemTime;
136 RSSTemp = T.MaxRSS - RSSTemp;
137 MaxRSS = std::max(MaxRSS, RSSTemp);
140 static void printVal(double Val, double Total) {
141 if (Total < 1e-7) // Avoid dividing by zero...
142 fprintf(stderr, " ----- ");
144 fprintf(stderr, " %7.4f (%5.1f%%)", Val, Val*100/Total);
147 void TimeRecord::print(const char *PassName, const TimeRecord &Total) const {
148 printVal(UserTime, Total.UserTime);
149 printVal(SystemTime, Total.SystemTime);
150 printVal(UserTime+SystemTime, Total.UserTime+Total.SystemTime);
151 printVal(Elapsed, Total.Elapsed);
153 fprintf(stderr, " ");
156 std::cerr << MaxRSS << "\t";
157 std::cerr << PassName << "\n";
161 // Create method. If Timing is enabled, this creates and returns a new timing
162 // object, otherwise it returns null.
164 TimingInfo *TimingInfo::create() {
165 return EnableTiming ? new TimingInfo() : 0;
168 void TimingInfo::passStarted(Pass *P) {
169 TimingData[P].passStart(getTimeRecord());
171 void TimingInfo::passEnded(Pass *P) {
172 TimingData[P].passEnd(getTimeRecord());
174 void TimeRecord::sum(const TimeRecord &TR) {
175 Elapsed += TR.Elapsed;
176 UserTime += TR.UserTime;
177 SystemTime += TR.SystemTime;
181 // TimingDtor - Print out information about timing information
182 TimingInfo::~TimingInfo() {
183 // Iterate over all of the data, converting it into the dual of the data map,
184 // so that the data is sorted by amount of time taken, instead of pointer.
186 std::vector<std::pair<TimeRecord, Pass*> > Data;
188 for (std::map<Pass*, TimeRecord>::iterator I = TimingData.begin(),
189 E = TimingData.end(); I != E; ++I)
190 // Throw out results for "grouping" pass managers...
191 if (!dynamic_cast<AnalysisResolver*>(I->first)) {
192 Data.push_back(std::make_pair(I->second, I->first));
193 Total.sum(I->second);
196 // Sort the data by time as the primary key, in reverse order...
197 std::sort(Data.begin(), Data.end(),
198 std::greater<std::pair<TimeRecord, Pass*> >());
200 // Print out timing header...
201 std::cerr << std::string(79, '=') << "\n"
202 << " ... Pass execution timing report ...\n"
203 << std::string(79, '=') << "\n Total Execution Time: "
204 << (Total.UserTime+Total.SystemTime) << " seconds ("
205 << Total.Elapsed << " wall clock)\n\n ---User Time--- "
206 << "--System Time-- --User+System-- ---Wall Time---";
209 std::cerr << " ---Mem---";
210 std::cerr << " --- Pass Name ---\n";
212 // Loop through all of the timing data, printing it out...
213 for (unsigned i = 0, e = Data.size(); i != e; ++i)
214 Data[i].first.print(Data[i].second->getPassName(), Total);
216 Total.print("TOTAL", Total);
220 void PMDebug::PrintArgumentInformation(const Pass *P) {
221 // Print out passes in pass manager...
222 if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
223 for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
224 PrintArgumentInformation(PM->getContainedPass(i));
226 } else { // Normal pass. Print argument information...
227 // Print out arguments for registered passes that are _optimizations_
228 if (const PassInfo *PI = P->getPassInfo())
229 if (PI->getPassType() & PassInfo::Optimization)
230 std::cerr << " -" << PI->getPassArgument();
234 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
235 Pass *P, Annotable *V) {
236 if (PassDebugging >= Executions) {
237 std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
240 std::cerr << "' on ";
242 if (dynamic_cast<Module*>(V)) {
243 std::cerr << "Module\n"; return;
244 } else if (Function *F = dynamic_cast<Function*>(V))
245 std::cerr << "Function '" << F->getName();
246 else if (BasicBlock *BB = dynamic_cast<BasicBlock*>(V))
247 std::cerr << "BasicBlock '" << BB->getName();
248 else if (Value *Val = dynamic_cast<Value*>(V))
249 std::cerr << typeid(*Val).name() << " '" << Val->getName();
251 std::cerr << "'...\n";
255 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
256 Pass *P, const std::vector<AnalysisID> &Set){
257 if (PassDebugging >= Details && !Set.empty()) {
258 std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
259 for (unsigned i = 0; i != Set.size(); ++i) {
260 if (i) std::cerr << ",";
261 std::cerr << " " << Set[i]->getPassName();
267 //===----------------------------------------------------------------------===//
268 // Pass Implementation
271 void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
272 PM->addPass(this, AU);
275 // dumpPassStructure - Implement the -debug-passes=Structure option
276 void Pass::dumpPassStructure(unsigned Offset) {
277 std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
280 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
282 const char *Pass::getPassName() const {
283 if (const PassInfo *PI = getPassInfo())
284 return PI->getPassName();
285 return typeid(*this).name();
288 // print - Print out the internal state of the pass. This is called by Analyse
289 // to print out the contents of an analysis. Otherwise it is not neccesary to
290 // implement this method.
292 void Pass::print(std::ostream &O) const {
293 O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
296 // dump - call print(std::cerr);
297 void Pass::dump() const {
301 //===----------------------------------------------------------------------===//
302 // FunctionPass Implementation
305 // run - On a module, we run this pass by initializing, runOnFunction'ing once
306 // for every function in the module, then by finalizing.
308 bool FunctionPass::run(Module &M) {
309 bool Changed = doInitialization(M);
311 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
312 if (!I->isExternal()) // Passes are not run on external functions!
313 Changed |= runOnFunction(*I);
315 return Changed | doFinalization(M);
318 // run - On a function, we simply initialize, run the function, then finalize.
320 bool FunctionPass::run(Function &F) {
321 if (F.isExternal()) return false;// Passes are not run on external functions!
323 return doInitialization(*F.getParent()) | runOnFunction(F)
324 | doFinalization(*F.getParent());
327 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
329 PM->addPass(this, AU);
332 void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
334 PM->addPass(this, AU);
337 //===----------------------------------------------------------------------===//
338 // BasicBlockPass Implementation
341 // To run this pass on a function, we simply call runOnBasicBlock once for each
344 bool BasicBlockPass::runOnFunction(Function &F) {
345 bool Changed = doInitialization(F);
346 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
347 Changed |= runOnBasicBlock(*I);
348 return Changed | doFinalization(F);
351 // To run directly on the basic block, we initialize, runOnBasicBlock, then
354 bool BasicBlockPass::run(BasicBlock &BB) {
355 Function &F = *BB.getParent();
356 Module &M = *F.getParent();
357 return doInitialization(M) | doInitialization(F) | runOnBasicBlock(BB) |
358 doFinalization(F) | doFinalization(M);
361 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
363 PM->addPass(this, AU);
366 void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
368 PM->addPass(this, AU);
372 //===----------------------------------------------------------------------===//
373 // Pass Registration mechanism
375 static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
376 static std::vector<PassRegistrationListener*> *Listeners = 0;
378 // getPassInfo - Return the PassInfo data structure that corresponds to this
380 const PassInfo *Pass::getPassInfo() const {
381 if (PassInfoCache) return PassInfoCache;
382 return lookupPassInfo(typeid(*this));
385 const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
386 if (PassInfoMap == 0) return 0;
387 std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
388 return (I != PassInfoMap->end()) ? I->second : 0;
391 void RegisterPassBase::registerPass(PassInfo *PI) {
392 if (PassInfoMap == 0)
393 PassInfoMap = new std::map<TypeInfo, PassInfo*>();
395 assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
396 "Pass already registered!");
398 PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
400 // Notify any listeners...
402 for (std::vector<PassRegistrationListener*>::iterator
403 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
404 (*I)->passRegistered(PI);
407 void RegisterPassBase::unregisterPass(PassInfo *PI) {
408 assert(PassInfoMap && "Pass registered but not in map!");
409 std::map<TypeInfo, PassInfo*>::iterator I =
410 PassInfoMap->find(PI->getTypeInfo());
411 assert(I != PassInfoMap->end() && "Pass registered but not in map!");
413 // Remove pass from the map...
414 PassInfoMap->erase(I);
415 if (PassInfoMap->empty()) {
420 // Notify any listeners...
422 for (std::vector<PassRegistrationListener*>::iterator
423 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
424 (*I)->passUnregistered(PI);
426 // Delete the PassInfo object itself...
430 //===----------------------------------------------------------------------===//
431 // Analysis Group Implementation Code
432 //===----------------------------------------------------------------------===//
434 struct AnalysisGroupInfo {
435 const PassInfo *DefaultImpl;
436 std::set<const PassInfo *> Implementations;
437 AnalysisGroupInfo() : DefaultImpl(0) {}
440 static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
442 // RegisterAGBase implementation
444 RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
445 const std::type_info *Pass, bool isDefault)
446 : ImplementationInfo(0), isDefaultImplementation(isDefault) {
448 InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
449 if (InterfaceInfo == 0) { // First reference to Interface, add it now.
450 InterfaceInfo = // Create the new PassInfo for the interface...
451 new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
452 registerPass(InterfaceInfo);
455 assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
456 "Trying to join an analysis group that is a normal pass!");
459 ImplementationInfo = Pass::lookupPassInfo(*Pass);
460 assert(ImplementationInfo &&
461 "Must register pass before adding to AnalysisGroup!");
463 // Make sure we keep track of the fact that the implementation implements
465 PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
466 IIPI->addInterfaceImplemented(InterfaceInfo);
468 // Lazily allocate to avoid nasty initialization order dependencies
469 if (AnalysisGroupInfoMap == 0)
470 AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
472 AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
473 assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
474 "Cannot add a pass to the same analysis group more than once!");
475 AGI.Implementations.insert(ImplementationInfo);
477 assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
478 "Default implementation for analysis group already specified!");
479 assert(ImplementationInfo->getNormalCtor() &&
480 "Cannot specify pass as default if it does not have a default ctor");
481 AGI.DefaultImpl = ImplementationInfo;
482 InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
487 void RegisterAGBase::setGroupName(const char *Name) {
488 assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
489 InterfaceInfo->setPassName(Name);
492 RegisterAGBase::~RegisterAGBase() {
493 if (ImplementationInfo) {
494 assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
495 AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
497 assert(AGI.Implementations.count(ImplementationInfo) &&
498 "Pass not a member of analysis group?");
500 if (AGI.DefaultImpl == ImplementationInfo)
503 AGI.Implementations.erase(ImplementationInfo);
505 // Last member of this analysis group? Unregister PassInfo, delete map entry
506 if (AGI.Implementations.empty()) {
507 assert(AGI.DefaultImpl == 0 &&
508 "Default implementation didn't unregister?");
509 AnalysisGroupInfoMap->erase(InterfaceInfo);
510 if (AnalysisGroupInfoMap->empty()) { // Delete map if empty
511 delete AnalysisGroupInfoMap;
512 AnalysisGroupInfoMap = 0;
515 unregisterPass(InterfaceInfo);
521 //===----------------------------------------------------------------------===//
522 // PassRegistrationListener implementation
525 // PassRegistrationListener ctor - Add the current object to the list of
526 // PassRegistrationListeners...
527 PassRegistrationListener::PassRegistrationListener() {
528 if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
529 Listeners->push_back(this);
532 // dtor - Remove object from list of listeners...
533 PassRegistrationListener::~PassRegistrationListener() {
534 std::vector<PassRegistrationListener*>::iterator I =
535 std::find(Listeners->begin(), Listeners->end(), this);
536 assert(Listeners && I != Listeners->end() &&
537 "PassRegistrationListener not registered!");
540 if (Listeners->empty()) {
546 // enumeratePasses - Iterate over the registered passes, calling the
547 // passEnumerate callback on each PassInfo object.
549 void PassRegistrationListener::enumeratePasses() {
551 for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
552 E = PassInfoMap->end(); I != E; ++I)
553 passEnumerate(I->second);