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