lib/VMCore/Pass.cpp

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