1 //===- Pass.cpp - LLVM Pass Infrastructure Implementation -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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/Pass.h"
17 #include "llvm/IR/Function.h"
18 #include "llvm/IR/IRPrintingPasses.h"
19 #include "llvm/IR/LegacyPassNameParser.h"
20 #include "llvm/PassRegistry.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Support/raw_ostream.h"
25 #define DEBUG_TYPE "ir"
27 //===----------------------------------------------------------------------===//
28 // Pass Implementation
31 // Force out-of-line virtual method.
36 // Force out-of-line virtual method.
37 ModulePass::~ModulePass() { }
39 Pass *ModulePass::createPrinterPass(raw_ostream &O,
40 const std::string &Banner) const {
41 return createPrintModulePass(O, Banner);
44 PassManagerType ModulePass::getPotentialPassManagerType() const {
45 return PMT_ModulePassManager;
48 bool Pass::mustPreserveAnalysisID(char &AID) const {
49 return Resolver->getAnalysisIfAvailable(&AID, true) != nullptr;
52 // dumpPassStructure - Implement the -debug-pass=Structure option
53 void Pass::dumpPassStructure(unsigned Offset) {
54 dbgs().indent(Offset*2) << getPassName() << "\n";
57 /// getPassName - Return a nice clean name for a pass. This usually
58 /// implemented in terms of the name that is registered by one of the
59 /// Registration templates, but can be overloaded directly.
61 const char *Pass::getPassName() const {
62 AnalysisID AID = getPassID();
63 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(AID);
65 return PI->getPassName();
66 return "Unnamed pass: implement Pass::getPassName()";
69 void Pass::preparePassManager(PMStack &) {
70 // By default, don't do anything.
73 PassManagerType Pass::getPotentialPassManagerType() const {
74 // Default implementation.
78 void Pass::getAnalysisUsage(AnalysisUsage &) const {
79 // By default, no analysis results are used, all are invalidated.
82 void Pass::releaseMemory() {
83 // By default, don't do anything.
86 void Pass::verifyAnalysis() const {
87 // By default, don't do anything.
90 void *Pass::getAdjustedAnalysisPointer(AnalysisID AID) {
94 ImmutablePass *Pass::getAsImmutablePass() {
98 PMDataManager *Pass::getAsPMDataManager() {
102 void Pass::setResolver(AnalysisResolver *AR) {
103 assert(!Resolver && "Resolver is already set");
107 // print - Print out the internal state of the pass. This is called by Analyze
108 // to print out the contents of an analysis. Otherwise it is not necessary to
109 // implement this method.
111 void Pass::print(raw_ostream &O,const Module*) const {
112 O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
115 // dump - call print(cerr);
116 void Pass::dump() const {
117 print(dbgs(), nullptr);
120 //===----------------------------------------------------------------------===//
121 // ImmutablePass Implementation
123 // Force out-of-line virtual method.
124 ImmutablePass::~ImmutablePass() { }
126 void ImmutablePass::initializePass() {
127 // By default, don't do anything.
130 //===----------------------------------------------------------------------===//
131 // FunctionPass Implementation
134 Pass *FunctionPass::createPrinterPass(raw_ostream &O,
135 const std::string &Banner) const {
136 return createPrintFunctionPass(O, Banner);
139 PassManagerType FunctionPass::getPotentialPassManagerType() const {
140 return PMT_FunctionPassManager;
143 bool FunctionPass::skipOptnoneFunction(const Function &F) const {
144 if (F.hasFnAttribute(Attribute::OptimizeNone)) {
145 DEBUG(dbgs() << "Skipping pass '" << getPassName()
146 << "' on function " << F.getName() << "\n");
152 //===----------------------------------------------------------------------===//
153 // BasicBlockPass Implementation
156 Pass *BasicBlockPass::createPrinterPass(raw_ostream &O,
157 const std::string &Banner) const {
158 return createPrintBasicBlockPass(O, Banner);
161 bool BasicBlockPass::doInitialization(Function &) {
162 // By default, don't do anything.
166 bool BasicBlockPass::doFinalization(Function &) {
167 // By default, don't do anything.
171 bool BasicBlockPass::skipOptnoneFunction(const BasicBlock &BB) const {
172 const Function *F = BB.getParent();
173 if (F && F->hasFnAttribute(Attribute::OptimizeNone)) {
174 // Report this only once per function.
175 if (&BB == &F->getEntryBlock())
176 DEBUG(dbgs() << "Skipping pass '" << getPassName()
177 << "' on function " << F->getName() << "\n");
183 PassManagerType BasicBlockPass::getPotentialPassManagerType() const {
184 return PMT_BasicBlockPassManager;
187 const PassInfo *Pass::lookupPassInfo(const void *TI) {
188 return PassRegistry::getPassRegistry()->getPassInfo(TI);
191 const PassInfo *Pass::lookupPassInfo(StringRef Arg) {
192 return PassRegistry::getPassRegistry()->getPassInfo(Arg);
195 Pass *Pass::createPass(AnalysisID ID) {
196 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(ID);
199 return PI->createPass();
202 Pass *PassInfo::createPass() const {
203 assert((!isAnalysisGroup() || NormalCtor) &&
204 "No default implementation found for analysis group!");
206 "Cannot call createPass on PassInfo without default ctor!");
210 //===----------------------------------------------------------------------===//
211 // Analysis Group Implementation Code
212 //===----------------------------------------------------------------------===//
214 // RegisterAGBase implementation
216 RegisterAGBase::RegisterAGBase(const char *Name, const void *InterfaceID,
217 const void *PassID, bool isDefault)
218 : PassInfo(Name, InterfaceID) {
219 PassRegistry::getPassRegistry()->registerAnalysisGroup(InterfaceID, PassID,
223 //===----------------------------------------------------------------------===//
224 // PassRegistrationListener implementation
227 // PassRegistrationListener ctor - Add the current object to the list of
228 // PassRegistrationListeners...
229 PassRegistrationListener::PassRegistrationListener() {
230 PassRegistry::getPassRegistry()->addRegistrationListener(this);
233 // dtor - Remove object from list of listeners...
234 PassRegistrationListener::~PassRegistrationListener() {
235 PassRegistry::getPassRegistry()->removeRegistrationListener(this);
238 // enumeratePasses - Iterate over the registered passes, calling the
239 // passEnumerate callback on each PassInfo object.
241 void PassRegistrationListener::enumeratePasses() {
242 PassRegistry::getPassRegistry()->enumerateWith(this);
245 PassNameParser::~PassNameParser() {}
247 //===----------------------------------------------------------------------===//
248 // AnalysisUsage Class Implementation
252 struct GetCFGOnlyPasses : public PassRegistrationListener {
253 typedef AnalysisUsage::VectorType VectorType;
254 VectorType &CFGOnlyList;
255 GetCFGOnlyPasses(VectorType &L) : CFGOnlyList(L) {}
257 void passEnumerate(const PassInfo *P) override {
258 if (P->isCFGOnlyPass())
259 CFGOnlyList.push_back(P->getTypeInfo());
264 // setPreservesCFG - This function should be called to by the pass, iff they do
267 // 1. Add or remove basic blocks from the function
268 // 2. Modify terminator instructions in any way.
270 // This function annotates the AnalysisUsage info object to say that analyses
271 // that only depend on the CFG are preserved by this pass.
273 void AnalysisUsage::setPreservesCFG() {
274 // Since this transformation doesn't modify the CFG, it preserves all analyses
275 // that only depend on the CFG (like dominators, loop info, etc...)
276 GetCFGOnlyPasses(Preserved).enumeratePasses();
279 AnalysisUsage &AnalysisUsage::addPreserved(StringRef Arg) {
280 const PassInfo *PI = Pass::lookupPassInfo(Arg);
281 // If the pass exists, preserve it. Otherwise silently do nothing.
282 if (PI) Preserved.push_back(PI->getTypeInfo());
286 AnalysisUsage &AnalysisUsage::addRequiredID(const void *ID) {
287 Required.push_back(ID);
291 AnalysisUsage &AnalysisUsage::addRequiredID(char &ID) {
292 Required.push_back(&ID);
296 AnalysisUsage &AnalysisUsage::addRequiredTransitiveID(char &ID) {
297 Required.push_back(&ID);
298 RequiredTransitive.push_back(&ID);