John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 1 | //===- Pass.cpp - LLVM Pass Infrastructure Implementation -----------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file implements the LLVM Pass infrastructure. It is primarily |
| 11 | // responsible with ensuring that passes are executed and batched together |
| 12 | // optimally. |
| 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
| 16 | #include "llvm/Pass.h" |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 17 | #include "llvm/PassRegistry.h" |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 18 | #include "llvm/Assembly/PrintModulePass.h" |
| 19 | #include "llvm/Support/Debug.h" |
| 20 | #include "llvm/Support/PassNameParser.h" |
| 21 | #include "llvm/Support/raw_ostream.h" |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 22 | using namespace llvm; |
| 23 | |
| 24 | //===----------------------------------------------------------------------===// |
| 25 | // Pass Implementation |
| 26 | // |
| 27 | |
| 28 | Pass::Pass(PassKind K, char &pid) : Resolver(0), PassID(&pid), Kind(K) { } |
| 29 | |
| 30 | // Force out-of-line virtual method. |
| 31 | Pass::~Pass() { |
| 32 | delete Resolver; |
| 33 | } |
| 34 | |
| 35 | // Force out-of-line virtual method. |
| 36 | ModulePass::~ModulePass() { } |
| 37 | |
| 38 | Pass *ModulePass::createPrinterPass(raw_ostream &O, |
| 39 | const std::string &Banner) const { |
| 40 | return createPrintModulePass(&O, false, Banner); |
| 41 | } |
| 42 | |
| 43 | PassManagerType ModulePass::getPotentialPassManagerType() const { |
| 44 | return PMT_ModulePassManager; |
| 45 | } |
| 46 | |
| 47 | bool Pass::mustPreserveAnalysisID(char &AID) const { |
| 48 | return Resolver->getAnalysisIfAvailable(&AID, true) != 0; |
| 49 | } |
| 50 | |
| 51 | // dumpPassStructure - Implement the -debug-passes=Structure option |
| 52 | void Pass::dumpPassStructure(unsigned Offset) { |
| 53 | dbgs().indent(Offset*2) << getPassName() << "\n"; |
| 54 | } |
| 55 | |
| 56 | /// getPassName - Return a nice clean name for a pass. This usually |
| 57 | /// implemented in terms of the name that is registered by one of the |
| 58 | /// Registration templates, but can be overloaded directly. |
| 59 | /// |
| 60 | const char *Pass::getPassName() const { |
| 61 | AnalysisID AID = getPassID(); |
| 62 | const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(AID); |
| 63 | if (PI) |
| 64 | return PI->getPassName(); |
| 65 | return "Unnamed pass: implement Pass::getPassName()"; |
| 66 | } |
| 67 | |
| 68 | void Pass::preparePassManager(PMStack &) { |
| 69 | // By default, don't do anything. |
| 70 | } |
| 71 | |
| 72 | PassManagerType Pass::getPotentialPassManagerType() const { |
| 73 | // Default implementation. |
| 74 | return PMT_Unknown; |
| 75 | } |
| 76 | |
| 77 | void Pass::getAnalysisUsage(AnalysisUsage &) const { |
| 78 | // By default, no analysis results are used, all are invalidated. |
| 79 | } |
| 80 | |
| 81 | void Pass::releaseMemory() { |
| 82 | // By default, don't do anything. |
| 83 | } |
| 84 | |
| 85 | void Pass::verifyAnalysis() const { |
| 86 | // By default, don't do anything. |
| 87 | } |
| 88 | |
| 89 | void *Pass::getAdjustedAnalysisPointer(AnalysisID AID) { |
| 90 | return this; |
| 91 | } |
| 92 | |
| 93 | ImmutablePass *Pass::getAsImmutablePass() { |
| 94 | return 0; |
| 95 | } |
| 96 | |
| 97 | PMDataManager *Pass::getAsPMDataManager() { |
| 98 | return 0; |
| 99 | } |
| 100 | |
| 101 | void Pass::setResolver(AnalysisResolver *AR) { |
| 102 | assert(!Resolver && "Resolver is already set"); |
| 103 | Resolver = AR; |
| 104 | } |
| 105 | |
| 106 | // print - Print out the internal state of the pass. This is called by Analyze |
| 107 | // to print out the contents of an analysis. Otherwise it is not necessary to |
| 108 | // implement this method. |
| 109 | // |
| 110 | void Pass::print(raw_ostream &O,const Module*) const { |
| 111 | O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n"; |
| 112 | } |
| 113 | |
| 114 | // dump - call print(cerr); |
| 115 | void Pass::dump() const { |
| 116 | print(dbgs(), 0); |
| 117 | } |
| 118 | |
| 119 | //===----------------------------------------------------------------------===// |
| 120 | // ImmutablePass Implementation |
| 121 | // |
| 122 | // Force out-of-line virtual method. |
| 123 | ImmutablePass::~ImmutablePass() { } |
| 124 | |
| 125 | void ImmutablePass::initializePass() { |
| 126 | // By default, don't do anything. |
| 127 | } |
| 128 | |
| 129 | //===----------------------------------------------------------------------===// |
| 130 | // FunctionPass Implementation |
| 131 | // |
| 132 | |
| 133 | Pass *FunctionPass::createPrinterPass(raw_ostream &O, |
| 134 | const std::string &Banner) const { |
| 135 | return createPrintFunctionPass(Banner, &O); |
| 136 | } |
| 137 | |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 138 | bool FunctionPass::doInitialization(Module &) { |
| 139 | // By default, don't do anything. |
| 140 | return false; |
| 141 | } |
| 142 | |
| 143 | bool FunctionPass::doFinalization(Module &) { |
| 144 | // By default, don't do anything. |
| 145 | return false; |
| 146 | } |
| 147 | |
| 148 | PassManagerType FunctionPass::getPotentialPassManagerType() const { |
| 149 | return PMT_FunctionPassManager; |
| 150 | } |
| 151 | |
| 152 | //===----------------------------------------------------------------------===// |
| 153 | // BasicBlockPass Implementation |
| 154 | // |
| 155 | |
| 156 | Pass *BasicBlockPass::createPrinterPass(raw_ostream &O, |
| 157 | const std::string &Banner) const { |
| 158 | |
| 159 | llvm_unreachable("BasicBlockPass printing unsupported."); |
| 160 | return 0; |
| 161 | } |
| 162 | |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 163 | bool BasicBlockPass::doInitialization(Module &) { |
| 164 | // By default, don't do anything. |
| 165 | return false; |
| 166 | } |
| 167 | |
| 168 | bool BasicBlockPass::doInitialization(Function &) { |
| 169 | // By default, don't do anything. |
| 170 | return false; |
| 171 | } |
| 172 | |
| 173 | bool BasicBlockPass::doFinalization(Function &) { |
| 174 | // By default, don't do anything. |
| 175 | return false; |
| 176 | } |
| 177 | |
| 178 | bool BasicBlockPass::doFinalization(Module &) { |
| 179 | // By default, don't do anything. |
| 180 | return false; |
| 181 | } |
| 182 | |
| 183 | PassManagerType BasicBlockPass::getPotentialPassManagerType() const { |
| 184 | return PMT_BasicBlockPassManager; |
| 185 | } |
| 186 | |
| 187 | const PassInfo *Pass::lookupPassInfo(const void *TI) { |
| 188 | return PassRegistry::getPassRegistry()->getPassInfo(TI); |
| 189 | } |
| 190 | |
| 191 | const PassInfo *Pass::lookupPassInfo(StringRef Arg) { |
| 192 | return PassRegistry::getPassRegistry()->getPassInfo(Arg); |
| 193 | } |
| 194 | |
| 195 | Pass *PassInfo::createPass() const { |
| 196 | assert((!isAnalysisGroup() || NormalCtor) && |
| 197 | "No default implementation found for analysis group!"); |
| 198 | assert(NormalCtor && |
| 199 | "Cannot call createPass on PassInfo without default ctor!"); |
| 200 | return NormalCtor(); |
| 201 | } |
| 202 | |
| 203 | //===----------------------------------------------------------------------===// |
| 204 | // Analysis Group Implementation Code |
| 205 | //===----------------------------------------------------------------------===// |
| 206 | |
| 207 | // RegisterAGBase implementation |
| 208 | // |
| 209 | RegisterAGBase::RegisterAGBase(const char *Name, const void *InterfaceID, |
| 210 | const void *PassID, bool isDefault) |
| 211 | : PassInfo(Name, InterfaceID) { |
| 212 | PassRegistry::getPassRegistry()->registerAnalysisGroup(InterfaceID, PassID, |
| 213 | *this, isDefault); |
| 214 | } |
| 215 | |
John Bauman | 8940182 | 2014-05-06 15:04:28 -0400 | [diff] [blame] | 216 | //===----------------------------------------------------------------------===// |
| 217 | // PassRegistrationListener implementation |
| 218 | // |
| 219 | |
| 220 | // PassRegistrationListener ctor - Add the current object to the list of |
| 221 | // PassRegistrationListeners... |
| 222 | PassRegistrationListener::PassRegistrationListener() { |
| 223 | PassRegistry::getPassRegistry()->addRegistrationListener(this); |
| 224 | } |
| 225 | |
| 226 | // dtor - Remove object from list of listeners... |
| 227 | PassRegistrationListener::~PassRegistrationListener() { |
| 228 | PassRegistry::getPassRegistry()->removeRegistrationListener(this); |
| 229 | } |
| 230 | |
| 231 | // enumeratePasses - Iterate over the registered passes, calling the |
| 232 | // passEnumerate callback on each PassInfo object. |
| 233 | // |
| 234 | void PassRegistrationListener::enumeratePasses() { |
| 235 | PassRegistry::getPassRegistry()->enumerateWith(this); |
| 236 | } |
| 237 | |
| 238 | PassNameParser::~PassNameParser() {} |
| 239 | |
| 240 | //===----------------------------------------------------------------------===// |
| 241 | // AnalysisUsage Class Implementation |
| 242 | // |
| 243 | |
| 244 | namespace { |
| 245 | struct GetCFGOnlyPasses : public PassRegistrationListener { |
| 246 | typedef AnalysisUsage::VectorType VectorType; |
| 247 | VectorType &CFGOnlyList; |
| 248 | GetCFGOnlyPasses(VectorType &L) : CFGOnlyList(L) {} |
| 249 | |
| 250 | void passEnumerate(const PassInfo *P) { |
| 251 | if (P->isCFGOnlyPass()) |
| 252 | CFGOnlyList.push_back(P->getTypeInfo()); |
| 253 | } |
| 254 | }; |
| 255 | } |
| 256 | |
| 257 | // setPreservesCFG - This function should be called to by the pass, iff they do |
| 258 | // not: |
| 259 | // |
| 260 | // 1. Add or remove basic blocks from the function |
| 261 | // 2. Modify terminator instructions in any way. |
| 262 | // |
| 263 | // This function annotates the AnalysisUsage info object to say that analyses |
| 264 | // that only depend on the CFG are preserved by this pass. |
| 265 | // |
| 266 | void AnalysisUsage::setPreservesCFG() { |
| 267 | // Since this transformation doesn't modify the CFG, it preserves all analyses |
| 268 | // that only depend on the CFG (like dominators, loop info, etc...) |
| 269 | GetCFGOnlyPasses(Preserved).enumeratePasses(); |
| 270 | } |
| 271 | |
| 272 | AnalysisUsage &AnalysisUsage::addPreserved(StringRef Arg) { |
| 273 | const PassInfo *PI = Pass::lookupPassInfo(Arg); |
| 274 | // If the pass exists, preserve it. Otherwise silently do nothing. |
| 275 | if (PI) Preserved.push_back(PI->getTypeInfo()); |
| 276 | return *this; |
| 277 | } |
| 278 | |
| 279 | AnalysisUsage &AnalysisUsage::addRequiredID(const void *ID) { |
| 280 | Required.push_back(ID); |
| 281 | return *this; |
| 282 | } |
| 283 | |
| 284 | AnalysisUsage &AnalysisUsage::addRequiredID(char &ID) { |
| 285 | Required.push_back(&ID); |
| 286 | return *this; |
| 287 | } |
| 288 | |
| 289 | AnalysisUsage &AnalysisUsage::addRequiredTransitiveID(char &ID) { |
| 290 | Required.push_back(&ID); |
| 291 | RequiredTransitive.push_back(&ID); |
| 292 | return *this; |
| 293 | } |