1 //===- Pass.cpp - LLVM Pass Infrastructure Implementation -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM Pass infrastructure. It is primarily
11 // responsible with ensuring that passes are executed and batched together
14 //===----------------------------------------------------------------------===//
16 #include "llvm/PassManager.h"
17 #include "PassManagerT.h" // PassManagerT implementation
18 #include "llvm/Module.h"
19 #include "llvm/ModuleProvider.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/Support/TypeInfo.h"
26 // IncludeFile - Stub function used to help linking out.
27 IncludeFile::IncludeFile(void*) {}
29 //===----------------------------------------------------------------------===//
30 // AnalysisID Class Implementation
33 // getCFGOnlyAnalyses - A wrapper around the CFGOnlyAnalyses which make it
34 // initializer order independent.
35 static std::vector<const PassInfo*> &getCFGOnlyAnalyses() {
36 static std::vector<const PassInfo*> CFGOnlyAnalyses;
37 return CFGOnlyAnalyses;
40 void RegisterPassBase::setOnlyUsesCFG() {
41 getCFGOnlyAnalyses().push_back(PIObj);
44 //===----------------------------------------------------------------------===//
45 // AnalysisResolver Class Implementation
48 AnalysisResolver::~AnalysisResolver() {
50 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
51 assert(P->Resolver == 0 && "Pass already in a PassManager!");
55 //===----------------------------------------------------------------------===//
56 // AnalysisUsage Class Implementation
59 // setPreservesCFG - This function should be called to by the pass, iff they do
62 // 1. Add or remove basic blocks from the function
63 // 2. Modify terminator instructions in any way.
65 // This function annotates the AnalysisUsage info object to say that analyses
66 // that only depend on the CFG are preserved by this pass.
68 void AnalysisUsage::setPreservesCFG() {
69 // Since this transformation doesn't modify the CFG, it preserves all analyses
70 // that only depend on the CFG (like dominators, loop info, etc...)
72 Preserved.insert(Preserved.end(),
73 getCFGOnlyAnalyses().begin(), getCFGOnlyAnalyses().end());
77 //===----------------------------------------------------------------------===//
78 // PassManager implementation - The PassManager class is a simple Pimpl class
79 // that wraps the PassManagerT template.
81 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
82 PassManager::~PassManager() { delete PM; }
83 void PassManager::add(Pass *P) {
84 ModulePass *MP = dynamic_cast<ModulePass*>(P);
85 assert(MP && "Not a modulepass?");
88 bool PassManager::run(Module &M) { return PM->runOnModule(M); }
90 //===----------------------------------------------------------------------===//
91 // FunctionPassManager implementation - The FunctionPassManager class
92 // is a simple Pimpl class that wraps the PassManagerT template. It
93 // is like PassManager, but only deals in FunctionPasses.
95 FunctionPassManager::FunctionPassManager(ModuleProvider *P) :
96 PM(new PassManagerT<Function>()), MP(P) {}
97 FunctionPassManager::~FunctionPassManager() { delete PM; }
98 void FunctionPassManager::add(FunctionPass *P) { PM->add(P); }
99 void FunctionPassManager::add(ImmutablePass *IP) { PM->add(IP); }
100 bool FunctionPassManager::run(Function &F) {
102 MP->materializeFunction(&F);
103 } catch (std::string& errstr) {
104 std::cerr << "Error reading bytecode file: " << errstr << "\n";
107 std::cerr << "Error reading bytecode file!\n";
114 //===----------------------------------------------------------------------===//
115 // TimingInfo Class - This class is used to calculate information about the
116 // amount of time each pass takes to execute. This only happens with
117 // -time-passes is enabled on the command line.
119 bool llvm::TimePassesIsEnabled = false;
120 static cl::opt<bool,true>
121 EnableTiming("time-passes", cl::location(TimePassesIsEnabled),
122 cl::desc("Time each pass, printing elapsed time for each on exit"));
124 // createTheTimeInfo - This method either initializes the TheTimeInfo pointer to
125 // a non null value (if the -time-passes option is enabled) or it leaves it
126 // null. It may be called multiple times.
127 void TimingInfo::createTheTimeInfo() {
128 if (!TimePassesIsEnabled || TheTimeInfo) return;
130 // Constructed the first time this is called, iff -time-passes is enabled.
131 // This guarantees that the object will be constructed before static globals,
132 // thus it will be destroyed before them.
133 static TimingInfo TTI;
137 void PMDebug::PrintArgumentInformation(const Pass *P) {
138 // Print out passes in pass manager...
139 if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
140 for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
141 PrintArgumentInformation(PM->getContainedPass(i));
143 } else { // Normal pass. Print argument information...
144 // Print out arguments for registered passes that are _optimizations_
145 if (const PassInfo *PI = P->getPassInfo())
146 if (PI->getPassType() & PassInfo::Optimization)
147 std::cerr << " -" << PI->getPassArgument();
151 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
152 Pass *P, Module *M) {
153 if (PassDebugging >= Executions) {
154 std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
156 if (M) std::cerr << "' on Module '" << M->getModuleIdentifier() << "'\n";
157 std::cerr << "'...\n";
161 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
162 Pass *P, Function *F) {
163 if (PassDebugging >= Executions) {
164 std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
166 if (F) std::cerr << "' on Function '" << F->getName();
167 std::cerr << "'...\n";
171 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
172 Pass *P, BasicBlock *BB) {
173 if (PassDebugging >= Executions) {
174 std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '"
176 if (BB) std::cerr << "' on BasicBlock '" << BB->getName();
177 std::cerr << "'...\n";
181 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
182 Pass *P, const std::vector<AnalysisID> &Set){
183 if (PassDebugging >= Details && !Set.empty()) {
184 std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
185 for (unsigned i = 0; i != Set.size(); ++i) {
186 if (i) std::cerr << ",";
187 std::cerr << " " << Set[i]->getPassName();
193 //===----------------------------------------------------------------------===//
194 // Pass Implementation
197 void ModulePass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
198 PM->addPass(this, AU);
201 bool Pass::mustPreserveAnalysisID(const PassInfo *AnalysisID) const {
202 return Resolver->getAnalysisToUpdate(AnalysisID) != 0;
205 // dumpPassStructure - Implement the -debug-passes=Structure option
206 void Pass::dumpPassStructure(unsigned Offset) {
207 std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
210 // getPassName - Use C++ RTTI to get a SOMEWHAT intelligible name for the pass.
212 const char *Pass::getPassName() const {
213 if (const PassInfo *PI = getPassInfo())
214 return PI->getPassName();
215 return typeid(*this).name();
218 // print - Print out the internal state of the pass. This is called by Analyze
219 // to print out the contents of an analysis. Otherwise it is not necessary to
220 // implement this method.
222 void Pass::print(std::ostream &O,const Module*) const {
223 O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
226 // dump - call print(std::cerr);
227 void Pass::dump() const {
231 //===----------------------------------------------------------------------===//
232 // ImmutablePass Implementation
234 void ImmutablePass::addToPassManager(PassManagerT<Module> *PM,
236 PM->addPass(this, AU);
240 //===----------------------------------------------------------------------===//
241 // FunctionPass Implementation
244 // run - On a module, we run this pass by initializing, runOnFunction'ing once
245 // for every function in the module, then by finalizing.
247 bool FunctionPass::runOnModule(Module &M) {
248 bool Changed = doInitialization(M);
250 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
251 if (!I->isExternal()) // Passes are not run on external functions!
252 Changed |= runOnFunction(*I);
254 return Changed | doFinalization(M);
257 // run - On a function, we simply initialize, run the function, then finalize.
259 bool FunctionPass::run(Function &F) {
260 if (F.isExternal()) return false;// Passes are not run on external functions!
262 bool Changed = doInitialization(*F.getParent());
263 Changed |= runOnFunction(F);
264 return Changed | doFinalization(*F.getParent());
267 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
269 PM->addPass(this, AU);
272 void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
274 PM->addPass(this, AU);
277 //===----------------------------------------------------------------------===//
278 // BasicBlockPass Implementation
281 // To run this pass on a function, we simply call runOnBasicBlock once for each
284 bool BasicBlockPass::runOnFunction(Function &F) {
285 bool Changed = doInitialization(F);
286 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
287 Changed |= runOnBasicBlock(*I);
288 return Changed | doFinalization(F);
291 // To run directly on the basic block, we initialize, runOnBasicBlock, then
294 bool BasicBlockPass::runPass(BasicBlock &BB) {
295 Function &F = *BB.getParent();
296 Module &M = *F.getParent();
297 bool Changed = doInitialization(M);
298 Changed |= doInitialization(F);
299 Changed |= runOnBasicBlock(BB);
300 Changed |= doFinalization(F);
301 Changed |= doFinalization(M);
305 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
307 PM->addPass(this, AU);
310 void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
312 PM->addPass(this, AU);
316 //===----------------------------------------------------------------------===//
317 // Pass Registration mechanism
319 static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
320 static std::vector<PassRegistrationListener*> *Listeners = 0;
322 // getPassInfo - Return the PassInfo data structure that corresponds to this
324 const PassInfo *Pass::getPassInfo() const {
325 if (PassInfoCache) return PassInfoCache;
326 return lookupPassInfo(typeid(*this));
329 const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
330 if (PassInfoMap == 0) return 0;
331 std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
332 return (I != PassInfoMap->end()) ? I->second : 0;
335 void RegisterPassBase::registerPass(PassInfo *PI) {
336 if (PassInfoMap == 0)
337 PassInfoMap = new std::map<TypeInfo, PassInfo*>();
339 assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
340 "Pass already registered!");
342 PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
344 // Notify any listeners...
346 for (std::vector<PassRegistrationListener*>::iterator
347 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
348 (*I)->passRegistered(PI);
351 void RegisterPassBase::unregisterPass(PassInfo *PI) {
352 assert(PassInfoMap && "Pass registered but not in map!");
353 std::map<TypeInfo, PassInfo*>::iterator I =
354 PassInfoMap->find(PI->getTypeInfo());
355 assert(I != PassInfoMap->end() && "Pass registered but not in map!");
357 // Remove pass from the map...
358 PassInfoMap->erase(I);
359 if (PassInfoMap->empty()) {
364 // Notify any listeners...
366 for (std::vector<PassRegistrationListener*>::iterator
367 I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
368 (*I)->passUnregistered(PI);
370 // Delete the PassInfo object itself...
374 //===----------------------------------------------------------------------===//
375 // Analysis Group Implementation Code
376 //===----------------------------------------------------------------------===//
378 struct AnalysisGroupInfo {
379 const PassInfo *DefaultImpl;
380 std::set<const PassInfo *> Implementations;
381 AnalysisGroupInfo() : DefaultImpl(0) {}
384 static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
386 // RegisterAGBase implementation
388 RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
389 const std::type_info *Pass, bool isDefault)
390 : ImplementationInfo(0), isDefaultImplementation(isDefault) {
392 InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
393 if (InterfaceInfo == 0) { // First reference to Interface, add it now.
394 InterfaceInfo = // Create the new PassInfo for the interface...
395 new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
396 registerPass(InterfaceInfo);
399 assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
400 "Trying to join an analysis group that is a normal pass!");
403 ImplementationInfo = Pass::lookupPassInfo(*Pass);
404 assert(ImplementationInfo &&
405 "Must register pass before adding to AnalysisGroup!");
407 // Make sure we keep track of the fact that the implementation implements
409 PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
410 IIPI->addInterfaceImplemented(InterfaceInfo);
412 // Lazily allocate to avoid nasty initialization order dependencies
413 if (AnalysisGroupInfoMap == 0)
414 AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
416 AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
417 assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
418 "Cannot add a pass to the same analysis group more than once!");
419 AGI.Implementations.insert(ImplementationInfo);
421 assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
422 "Default implementation for analysis group already specified!");
423 assert(ImplementationInfo->getNormalCtor() &&
424 "Cannot specify pass as default if it does not have a default ctor");
425 AGI.DefaultImpl = ImplementationInfo;
426 InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
431 void RegisterAGBase::setGroupName(const char *Name) {
432 assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
433 InterfaceInfo->setPassName(Name);
436 RegisterAGBase::~RegisterAGBase() {
437 if (ImplementationInfo) {
438 assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
439 AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
441 assert(AGI.Implementations.count(ImplementationInfo) &&
442 "Pass not a member of analysis group?");
444 if (AGI.DefaultImpl == ImplementationInfo)
447 AGI.Implementations.erase(ImplementationInfo);
449 // Last member of this analysis group? Unregister PassInfo, delete map entry
450 if (AGI.Implementations.empty()) {
451 assert(AGI.DefaultImpl == 0 &&
452 "Default implementation didn't unregister?");
453 AnalysisGroupInfoMap->erase(InterfaceInfo);
454 if (AnalysisGroupInfoMap->empty()) { // Delete map if empty
455 delete AnalysisGroupInfoMap;
456 AnalysisGroupInfoMap = 0;
459 unregisterPass(InterfaceInfo);
465 //===----------------------------------------------------------------------===//
466 // PassRegistrationListener implementation
469 // PassRegistrationListener ctor - Add the current object to the list of
470 // PassRegistrationListeners...
471 PassRegistrationListener::PassRegistrationListener() {
472 if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
473 Listeners->push_back(this);
476 // dtor - Remove object from list of listeners...
477 PassRegistrationListener::~PassRegistrationListener() {
478 std::vector<PassRegistrationListener*>::iterator I =
479 std::find(Listeners->begin(), Listeners->end(), this);
480 assert(Listeners && I != Listeners->end() &&
481 "PassRegistrationListener not registered!");
484 if (Listeners->empty()) {
490 // enumeratePasses - Iterate over the registered passes, calling the
491 // passEnumerate callback on each PassInfo object.
493 void PassRegistrationListener::enumeratePasses() {
495 for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
496 E = PassInfoMap->end(); I != E; ++I)
497 passEnumerate(I->second);