planes is not spelled with an O
[oota-llvm.git] / lib / VMCore / Pass.cpp
index ff9ac928b9698283b64b8c65d2f93a8aa3d2cf19..96a4a3c02be9ef17bf98c98c15df4309e314da6f 100644 (file)
@@ -9,21 +9,58 @@
 #include "llvm/PassManager.h"
 #include "PassManagerT.h"         // PassManagerT implementation
 #include "llvm/Module.h"
-#include "llvm/Function.h"
-#include "llvm/BasicBlock.h"
 #include "Support/STLExtras.h"
-#include "Support/CommandLine.h"
-#include <typeinfo>
-#include <iostream>
+#include "Support/TypeInfo.h"
+#include <stdio.h>
+#include <sys/resource.h>
+#include <sys/time.h>
+#include <sys/unistd.h>
+#include <set>
 
-// Source of unique analysis ID #'s.
-unsigned AnalysisID::NextID = 0;
+// IncludeFile - Stub function used to help linking out.
+IncludeFile::IncludeFile(void*) {}
+
+//===----------------------------------------------------------------------===//
+//   AnalysisID Class Implementation
+//
+
+static std::vector<const PassInfo*> CFGOnlyAnalyses;
+
+void RegisterPassBase::setPreservesCFG() {
+  CFGOnlyAnalyses.push_back(PIObj);
+}
+
+//===----------------------------------------------------------------------===//
+//   AnalysisResolver Class Implementation
+//
 
 void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
   assert(P->Resolver == 0 && "Pass already in a PassManager!");
   P->Resolver = AR;
 }
 
+//===----------------------------------------------------------------------===//
+//   AnalysisUsage Class Implementation
+//
+
+// setPreservesCFG - This function should be called to by the pass, iff they do
+// not:
+//
+//  1. Add or remove basic blocks from the function
+//  2. Modify terminator instructions in any way.
+//
+// This function annotates the AnalysisUsage info object to say that analyses
+// that only depend on the CFG are preserved by this pass.
+//
+void AnalysisUsage::setPreservesCFG() {
+  // Since this transformation doesn't modify the CFG, it preserves all analyses
+  // that only depend on the CFG (like dominators, loop info, etc...)
+  //
+  Preserved.insert(Preserved.end(),
+                   CFGOnlyAnalyses.begin(), CFGOnlyAnalyses.end());
+}
+
+
 //===----------------------------------------------------------------------===//
 // PassManager implementation - The PassManager class is a simple Pimpl class
 // that wraps the PassManagerT template.
@@ -31,38 +68,44 @@ void AnalysisResolver::setAnalysisResolver(Pass *P, AnalysisResolver *AR) {
 PassManager::PassManager() : PM(new PassManagerT<Module>()) {}
 PassManager::~PassManager() { delete PM; }
 void PassManager::add(Pass *P) { PM->add(P); }
-bool PassManager::run(Module *M) { return PM->run(M); }
+bool PassManager::run(Module &M) { return PM->run(M); }
 
 
 //===----------------------------------------------------------------------===//
-// Pass debugging information.  Often it is useful to find out what pass is
-// running when a crash occurs in a utility.  When this library is compiled with
-// debugging on, a command line option (--debug-pass) is enabled that causes the
-// pass name to be printed before it executes.
+// TimingInfo Class - This class is used to calculate information about the
+// amount of time each pass takes to execute.  This only happens with
+// -time-passes is enabled on the command line.
 //
+static cl::opt<bool>
+EnableTiming("time-passes",
+            cl::desc("Time each pass, printing elapsed time for each on exit"));
 
-// Different debug levels that can be enabled...
-enum PassDebugLevel {
-  None, PassStructure, PassExecutions, PassDetails
-};
+// Create method.  If Timing is enabled, this creates and returns a new timing
+// object, otherwise it returns null.
+//
+TimingInfo *TimingInfo::create() {
+  return EnableTiming ? new TimingInfo() : 0;
+}
 
-static cl::Enum<enum PassDebugLevel> PassDebugging("debug-pass", cl::Hidden,
-  "Print PassManager debugging information",
-  clEnumVal(None          , "disable debug output"),
-  clEnumVal(PassStructure , "print pass structure before run()"),
-  clEnumVal(PassExecutions, "print pass name before it is executed"),
-  clEnumVal(PassDetails   , "print pass details when it is executed"), 0); 
+void PMDebug::PrintArgumentInformation(const Pass *P) {
+  // Print out passes in pass manager...
+  if (const AnalysisResolver *PM = dynamic_cast<const AnalysisResolver*>(P)) {
+    for (unsigned i = 0, e = PM->getNumContainedPasses(); i != e; ++i)
+      PrintArgumentInformation(PM->getContainedPass(i));
 
-void PMDebug::PrintPassStructure(Pass *P) {
-  if (PassDebugging >= PassStructure)
-    P->dumpPassStructure();
+  } else {  // Normal pass.  Print argument information...
+    // Print out arguments for registered passes that are _optimizations_
+    if (const PassInfo *PI = P->getPassInfo())
+      if (PI->getPassType() & PassInfo::Optimization)
+        std::cerr << " -" << PI->getPassArgument();
+  }
 }
 
 void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
                                    Pass *P, Annotable *V) {
-  if (PassDebugging >= PassExecutions) {
+  if (PassDebugging >= Executions) {
     std::cerr << (void*)P << std::string(Depth*2+1, ' ') << Action << " '" 
-              << typeid(*P).name();
+              << P->getPassName();
     if (V) {
       std::cerr << "' on ";
 
@@ -81,23 +124,16 @@ void PMDebug::PrintPassInformation(unsigned Depth, const char *Action,
 
 void PMDebug::PrintAnalysisSetInfo(unsigned Depth, const char *Msg,
                                    Pass *P, const std::vector<AnalysisID> &Set){
-  if (PassDebugging >= PassDetails && !Set.empty()) {
+  if (PassDebugging >= Details && !Set.empty()) {
     std::cerr << (void*)P << std::string(Depth*2+3, ' ') << Msg << " Analyses:";
     for (unsigned i = 0; i != Set.size(); ++i) {
-      Pass *P = Set[i].createPass();   // Good thing this is just debug code...
-      std::cerr << "  " << typeid(*P).name();
-      delete P;
+      if (i) std::cerr << ",";
+      std::cerr << " " << Set[i]->getPassName();
     }
     std::cerr << "\n";
   }
 }
 
-// dumpPassStructure - Implement the -debug-passes=PassStructure option
-void Pass::dumpPassStructure(unsigned Offset = 0) {
-  std::cerr << std::string(Offset*2, ' ') << typeid(*this).name() << "\n";
-}
-
-
 //===----------------------------------------------------------------------===//
 // Pass Implementation
 //
@@ -106,6 +142,41 @@ void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
   PM->addPass(this, AU);
 }
 
+// dumpPassStructure - Implement the -debug-passes=Structure option
+void Pass::dumpPassStructure(unsigned Offset) {
+  std::cerr << std::string(Offset*2, ' ') << getPassName() << "\n";
+}
+
+// getPassName - Use C++ RTTI to get a SOMEWHAT intelligable name for the pass.
+//
+const char *Pass::getPassName() const {
+  if (const PassInfo *PI = getPassInfo())
+    return PI->getPassName();
+  return typeid(*this).name();
+}
+
+// print - Print out the internal state of the pass.  This is called by Analyse
+// to print out the contents of an analysis.  Otherwise it is not neccesary to
+// implement this method.
+//
+void Pass::print(std::ostream &O) const {
+  O << "Pass::print not implemented for pass: '" << getPassName() << "'!\n";
+}
+
+// dump - call print(std::cerr);
+void Pass::dump() const {
+  print(std::cerr, 0);
+}
+
+//===----------------------------------------------------------------------===//
+// ImmutablePass Implementation
+//
+void ImmutablePass::addToPassManager(PassManagerT<Module> *PM,
+                                     AnalysisUsage &AU) {
+  PM->addPass(this, AU);
+}
+
+
 //===----------------------------------------------------------------------===//
 // FunctionPass Implementation
 //
@@ -113,11 +184,11 @@ void Pass::addToPassManager(PassManagerT<Module> *PM, AnalysisUsage &AU) {
 // run - On a module, we run this pass by initializing, runOnFunction'ing once
 // for every function in the module, then by finalizing.
 //
-bool FunctionPass::run(Module *M) {
+bool FunctionPass::run(Module &M) {
   bool Changed = doInitialization(M);
   
-  for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
-    if (!(*I)->isExternal())      // Passes are not run on external functions!
+  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
+    if (!I->isExternal())      // Passes are not run on external functions!
     Changed |= runOnFunction(*I);
   
   return Changed | doFinalization(M);
@@ -125,11 +196,11 @@ bool FunctionPass::run(Module *M) {
 
 // run - On a function, we simply initialize, run the function, then finalize.
 //
-bool FunctionPass::run(Function *F) {
-  if (F->isExternal()) return false;// Passes are not run on external functions!
+bool FunctionPass::run(Function &F) {
+  if (F.isExternal()) return false;// Passes are not run on external functions!
 
-  return doInitialization(F->getParent()) | runOnFunction(F)
-       | doFinalization(F->getParent());
+  return doInitialization(*F.getParent()) | runOnFunction(F)
+       | doFinalization(*F.getParent());
 }
 
 void FunctionPass::addToPassManager(PassManagerT<Module> *PM,
@@ -142,20 +213,6 @@ void FunctionPass::addToPassManager(PassManagerT<Function> *PM,
   PM->addPass(this, AU);
 }
 
-// doesNotModifyCFG - This function should be called by our subclasses to
-// implement the getAnalysisUsage virtual function, iff they do not:
-//
-//  1. Add or remove basic blocks from the function
-//  2. Modify terminator instructions in any way.
-//
-// This function annotates the AnalysisUsage info object to say that analyses
-// that only depend on the CFG are preserved by this pass.
-//
-void FunctionPass::doesNotModifyCFG(AnalysisUsage &Info) {
-
-}
-
-
 //===----------------------------------------------------------------------===//
 // BasicBlockPass Implementation
 //
@@ -163,19 +220,21 @@ void FunctionPass::doesNotModifyCFG(AnalysisUsage &Info) {
 // To run this pass on a function, we simply call runOnBasicBlock once for each
 // function.
 //
-bool BasicBlockPass::runOnFunction(Function *F) {
-  bool Changed = false;
-  for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
+bool BasicBlockPass::runOnFunction(Function &F) {
+  bool Changed = doInitialization(F);
+  for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
     Changed |= runOnBasicBlock(*I);
-  return Changed;
+  return Changed | doFinalization(F);
 }
 
 // To run directly on the basic block, we initialize, runOnBasicBlock, then
 // finalize.
 //
-bool BasicBlockPass::run(BasicBlock *BB) {
-  Module *M = BB->getParent()->getParent();
-  return doInitialization(M) | runOnBasicBlock(BB) | doFinalization(M);
+bool BasicBlockPass::run(BasicBlock &BB) {
+  Function &F = *BB.getParent();
+  Module &M = *F.getParent();
+  return doInitialization(M) | doInitialization(F) | runOnBasicBlock(BB) |
+         doFinalization(F) | doFinalization(M);
 }
 
 void BasicBlockPass::addToPassManager(PassManagerT<Function> *PM,
@@ -188,3 +247,187 @@ void BasicBlockPass::addToPassManager(PassManagerT<BasicBlock> *PM,
   PM->addPass(this, AU);
 }
 
+
+//===----------------------------------------------------------------------===//
+// Pass Registration mechanism
+//
+static std::map<TypeInfo, PassInfo*> *PassInfoMap = 0;
+static std::vector<PassRegistrationListener*> *Listeners = 0;
+
+// getPassInfo - Return the PassInfo data structure that corresponds to this
+// pass...
+const PassInfo *Pass::getPassInfo() const {
+  if (PassInfoCache) return PassInfoCache;
+  return lookupPassInfo(typeid(*this));
+}
+
+const PassInfo *Pass::lookupPassInfo(const std::type_info &TI) {
+  if (PassInfoMap == 0) return 0;
+  std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->find(TI);
+  return (I != PassInfoMap->end()) ? I->second : 0;
+}
+
+void RegisterPassBase::registerPass(PassInfo *PI) {
+  if (PassInfoMap == 0)
+    PassInfoMap = new std::map<TypeInfo, PassInfo*>();
+
+  assert(PassInfoMap->find(PI->getTypeInfo()) == PassInfoMap->end() &&
+         "Pass already registered!");
+  PIObj = PI;
+  PassInfoMap->insert(std::make_pair(TypeInfo(PI->getTypeInfo()), PI));
+
+  // Notify any listeners...
+  if (Listeners)
+    for (std::vector<PassRegistrationListener*>::iterator
+           I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
+      (*I)->passRegistered(PI);
+}
+
+void RegisterPassBase::unregisterPass(PassInfo *PI) {
+  assert(PassInfoMap && "Pass registered but not in map!");
+  std::map<TypeInfo, PassInfo*>::iterator I =
+    PassInfoMap->find(PI->getTypeInfo());
+  assert(I != PassInfoMap->end() && "Pass registered but not in map!");
+
+  // Remove pass from the map...
+  PassInfoMap->erase(I);
+  if (PassInfoMap->empty()) {
+    delete PassInfoMap;
+    PassInfoMap = 0;
+  }
+
+  // Notify any listeners...
+  if (Listeners)
+    for (std::vector<PassRegistrationListener*>::iterator
+           I = Listeners->begin(), E = Listeners->end(); I != E; ++I)
+      (*I)->passUnregistered(PI);
+
+  // Delete the PassInfo object itself...
+  delete PI;
+}
+
+//===----------------------------------------------------------------------===//
+//                  Analysis Group Implementation Code
+//===----------------------------------------------------------------------===//
+
+struct AnalysisGroupInfo {
+  const PassInfo *DefaultImpl;
+  std::set<const PassInfo *> Implementations;
+  AnalysisGroupInfo() : DefaultImpl(0) {}
+};
+
+static std::map<const PassInfo *, AnalysisGroupInfo> *AnalysisGroupInfoMap = 0;
+
+// RegisterAGBase implementation
+//
+RegisterAGBase::RegisterAGBase(const std::type_info &Interface,
+                               const std::type_info *Pass, bool isDefault)
+  : ImplementationInfo(0), isDefaultImplementation(isDefault) {
+
+  InterfaceInfo = const_cast<PassInfo*>(Pass::lookupPassInfo(Interface));
+  if (InterfaceInfo == 0) {   // First reference to Interface, add it now.
+    InterfaceInfo =   // Create the new PassInfo for the interface...
+      new PassInfo("", "", Interface, PassInfo::AnalysisGroup, 0, 0);
+    registerPass(InterfaceInfo);
+    PIObj = 0;
+  }
+  assert(InterfaceInfo->getPassType() == PassInfo::AnalysisGroup &&
+         "Trying to join an analysis group that is a normal pass!");
+
+  if (Pass) {
+    ImplementationInfo = Pass::lookupPassInfo(*Pass);
+    assert(ImplementationInfo &&
+           "Must register pass before adding to AnalysisGroup!");
+
+    // Make sure we keep track of the fact that the implementation implements
+    // the interface.
+    PassInfo *IIPI = const_cast<PassInfo*>(ImplementationInfo);
+    IIPI->addInterfaceImplemented(InterfaceInfo);
+
+    // Lazily allocate to avoid nasty initialization order dependencies
+    if (AnalysisGroupInfoMap == 0)
+      AnalysisGroupInfoMap = new std::map<const PassInfo *,AnalysisGroupInfo>();
+
+    AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
+    assert(AGI.Implementations.count(ImplementationInfo) == 0 &&
+           "Cannot add a pass to the same analysis group more than once!");
+    AGI.Implementations.insert(ImplementationInfo);
+    if (isDefault) {
+      assert(AGI.DefaultImpl == 0 && InterfaceInfo->getNormalCtor() == 0 &&
+             "Default implementation for analysis group already specified!");
+      assert(ImplementationInfo->getNormalCtor() &&
+           "Cannot specify pass as default if it does not have a default ctor");
+      AGI.DefaultImpl = ImplementationInfo;
+      InterfaceInfo->setNormalCtor(ImplementationInfo->getNormalCtor());
+    }
+  }
+}
+
+void RegisterAGBase::setGroupName(const char *Name) {
+  assert(InterfaceInfo->getPassName()[0] == 0 && "Interface Name already set!");
+  InterfaceInfo->setPassName(Name);
+}
+
+RegisterAGBase::~RegisterAGBase() {
+  if (ImplementationInfo) {
+    assert(AnalysisGroupInfoMap && "Inserted into map, but map doesn't exist?");
+    AnalysisGroupInfo &AGI = (*AnalysisGroupInfoMap)[InterfaceInfo];
+
+    assert(AGI.Implementations.count(ImplementationInfo) &&
+           "Pass not a member of analysis group?");
+
+    if (AGI.DefaultImpl == ImplementationInfo)
+      AGI.DefaultImpl = 0;
+    
+    AGI.Implementations.erase(ImplementationInfo);
+
+    // Last member of this analysis group? Unregister PassInfo, delete map entry
+    if (AGI.Implementations.empty()) {
+      assert(AGI.DefaultImpl == 0 &&
+             "Default implementation didn't unregister?");
+      AnalysisGroupInfoMap->erase(InterfaceInfo);
+      if (AnalysisGroupInfoMap->empty()) {  // Delete map if empty
+        delete AnalysisGroupInfoMap;
+        AnalysisGroupInfoMap = 0;
+      }
+
+      unregisterPass(InterfaceInfo);
+    }
+  }
+}
+
+
+//===----------------------------------------------------------------------===//
+// PassRegistrationListener implementation
+//
+
+// PassRegistrationListener ctor - Add the current object to the list of
+// PassRegistrationListeners...
+PassRegistrationListener::PassRegistrationListener() {
+  if (!Listeners) Listeners = new std::vector<PassRegistrationListener*>();
+  Listeners->push_back(this);
+}
+
+// dtor - Remove object from list of listeners...
+PassRegistrationListener::~PassRegistrationListener() {
+  std::vector<PassRegistrationListener*>::iterator I =
+    std::find(Listeners->begin(), Listeners->end(), this);
+  assert(Listeners && I != Listeners->end() &&
+         "PassRegistrationListener not registered!");
+  Listeners->erase(I);
+
+  if (Listeners->empty()) {
+    delete Listeners;
+    Listeners = 0;
+  }
+}
+
+// enumeratePasses - Iterate over the registered passes, calling the
+// passEnumerate callback on each PassInfo object.
+//
+void PassRegistrationListener::enumeratePasses() {
+  if (PassInfoMap)
+    for (std::map<TypeInfo, PassInfo*>::iterator I = PassInfoMap->begin(),
+           E = PassInfoMap->end(); I != E; ++I)
+      passEnumerate(I->second);
+}