Update PassManagerImpl_New::analysisCurrentlyAvailable to check all
[oota-llvm.git] / lib / VMCore / PassManager.cpp
index de6ce20a1e9080fb4b6a79e4ce3c809d8e40a4d8..81753a11810c63127d4fe268fa7b0dc0c00801db 100644 (file)
@@ -2,7 +2,7 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
+// This file was developed by Devang Patel and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 
 #include "llvm/PassManager.h"
-#include "llvm/Function.h"
 #include "llvm/Module.h"
+#include <vector>
+#include <set>
 
 using namespace llvm;
 
-// PassManagerAnalysisHelper implementation
+namespace llvm {
 
-/// Return TRUE IFF pass P's required analysis set does not required new
+/// CommonPassManagerImpl helps pass manager analysis required by
+/// the managed passes. It provides methods to add/remove analysis
+/// available and query if certain analysis is available or not.
+class CommonPassManagerImpl : public Pass {
+
+public:
+
+  /// Return true IFF pass P's required analysis set does not required new
+  /// manager.
+  bool manageablePass(Pass *P);
+
+  /// Return true IFF AnalysisID AID is currently available.
+  bool isAnalysisAvailable(AnalysisID AID) {
+    return (AvailableAnalysis.count(AID) != 0);
+  }
+
+  /// Augment RequiredAnalysis by adding analysis required by pass P.
+  void noteDownRequiredAnalysis(Pass *P);
+
+  /// Augment AvailableAnalysis by adding analysis made available by pass P.
+  void noteDownAvailableAnalysis(Pass *P);
+
+  /// Remove Analysis that is not preserved by the pass
+  void removeNotPreservedAnalysis(Pass *P);
+  
+  /// Remove dead passes
+  void removeDeadPasses() { /* TODO : Implement */ }
+
+  /// Add pass P into the PassVector. Update RequiredAnalysis and
+  /// AvailableAnalysis appropriately if ProcessAnalysis is true.
+  void addPassToManager (Pass *P, bool ProcessAnalysis = true);
+
+  inline std::vector<Pass *>::iterator passVectorBegin() { 
+    return PassVector.begin(); 
+  }
+
+  inline std::vector<Pass *>::iterator passVectorEnd() { 
+    return PassVector.end();
+  }
+
+private:
+   // Analysis required by the passes managed by this manager
+  std::vector<AnalysisID> RequiredAnalysis;
+
+  // set of available Analysis
+  std::set<AnalysisID> AvailableAnalysis;
+
+  // Collection of pass that are managed by this manager
+  std::vector<Pass *> PassVector;
+};
+
+/// BasicBlockPassManager_New manages BasicBlockPass. It batches all the
+/// pass together and sequence them to process one basic block before
+/// processing next basic block.
+class BasicBlockPassManager_New : public CommonPassManagerImpl {
+
+public:
+  BasicBlockPassManager_New() { }
+
+  /// Add a pass into a passmanager queue. 
+  bool addPass(Pass *p);
+  
+  /// Execute all of the passes scheduled for execution.  Keep track of
+  /// whether any of the passes modifies the function, and if so, return true.
+  bool runOnFunction(Function &F);
+
+  /// Return true IFF AnalysisID AID is currently available.
+  bool analysisCurrentlyAvailable(AnalysisID AID);
+
+private:
+};
+
+/// FunctionPassManagerImpl_New manages FunctionPasses and BasicBlockPassManagers.
+/// It batches all function passes and basic block pass managers together and
+/// sequence them to process one function at a time before processing next
+/// function.
+class FunctionPassManagerImpl_New : public CommonPassManagerImpl {
+public:
+  FunctionPassManagerImpl_New(ModuleProvider *P) { /* TODO */ }
+  FunctionPassManagerImpl_New() { 
+    activeBBPassManager = NULL;
+  }
+  ~FunctionPassManagerImpl_New() { /* TODO */ };
+  /// add - Add a pass to the queue of passes to run.  This passes
+  /// ownership of the Pass to the PassManager.  When the
+  /// PassManager_X is destroyed, the pass will be destroyed as well, so
+  /// there is no need to delete the pass. (TODO delete passes.)
+  /// This implies that all passes MUST be allocated with 'new'.
+  void add(Pass *P) { /* TODO*/  }
+
+  /// Add pass into the pass manager queue.
+  bool addPass(Pass *P);
+
+  /// Execute all of the passes scheduled for execution.  Keep
+  /// track of whether any of the passes modifies the function, and if
+  /// so, return true.
+  bool runOnModule(Module &M);
+
+  /// Return true IFF AnalysisID AID is currently available.
+  bool analysisCurrentlyAvailable(AnalysisID AID);
+
+private:
+  // Active Pass Managers
+  BasicBlockPassManager_New *activeBBPassManager;
+};
+
+/// ModulePassManager_New manages ModulePasses and function pass managers.
+/// It batches all Module passes  passes and function pass managers together and
+/// sequence them to process one module.
+class ModulePassManager_New : public CommonPassManagerImpl {
+public:
+  ModulePassManager_New() { activeFunctionPassManager = NULL; }
+  
+  /// Add a pass into a passmanager queue. 
+  bool addPass(Pass *p);
+  
+  /// run - Execute all of the passes scheduled for execution.  Keep track of
+  /// whether any of the passes modifies the module, and if so, return true.
+  bool runOnModule(Module &M);
+
+  /// Return true IFF AnalysisID AID is currently available.
+  bool analysisCurrentlyAvailable(AnalysisID AID);
+  
+private:
+  // Active Pass Manager
+  FunctionPassManagerImpl_New *activeFunctionPassManager;
+};
+
+/// PassManager_New manages ModulePassManagers
+class PassManagerImpl_New : public CommonPassManagerImpl {
+
+public:
+
+  /// add - Add a pass to the queue of passes to run.  This passes ownership of
+  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
+  /// will be destroyed as well, so there is no need to delete the pass.  This
+  /// implies that all passes MUST be allocated with 'new'.
+  void add(Pass *P);
+  /// run - Execute all of the passes scheduled for execution.  Keep track of
+  /// whether any of the passes modifies the module, and if so, return true.
+  bool run(Module &M);
+
+  /// Return true IFF AnalysisID AID is currently available.
+  bool analysisCurrentlyAvailable(AnalysisID AID);
+
+private:
+
+  /// Add a pass into a passmanager queue. This is used by schedulePasses
+  bool addPass(Pass *p);
+
+  /// Schedule pass P for execution. Make sure that passes required by
+  /// P are run before P is run. Update analysis info maintained by
+  /// the manager. Remove dead passes. This is a recursive function.
+  void schedulePass(Pass *P);
+
+  /// Schedule all passes collected in pass queue using add(). Add all the
+  /// schedule passes into various manager's queue using addPass().
+  void schedulePasses();
+
+  // Collection of pass managers
+  std::vector<ModulePassManager_New *> PassManagers;
+
+  // Active Pass Manager
+  ModulePassManager_New *activeManager;
+};
+
+} // End of llvm namespace
+
+// CommonPassManagerImpl implementation
+
+/// Return true IFF pass P's required analysis set does not required new
 /// manager.
-bool PassManagerAnalysisHelper::manageablePass(Pass *P) {
+bool CommonPassManagerImpl::manageablePass(Pass *P) {
 
   AnalysisUsage AnUsage;
   P->getAnalysisUsage(AnUsage);
 
-  // If this pass is not preserving information that is required by the other passes
-  // managed by this manager then use new manager
-  // TODO
+  // If this pass is not preserving information that is required by the other
+  // passes managed by this manager then use new manager
+  if (!AnUsage.getPreservesAll()) {
+    const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
+    for (std::vector<AnalysisID>::iterator I = RequiredAnalysis.begin(),
+           E = RequiredAnalysis.end(); I != E; ++I) {
+      if (std::find(PreservedSet.begin(), PreservedSet.end(), *I) == 
+          PreservedSet.end())
+        // This analysis is not preserved. Need new manager.
+        return false;
+    }
+  }
   return true;
 }
 
-/// Return TRUE iff AnalysisID AID is currently available.
-bool PassManagerAnalysisHelper::analysisCurrentlyAvailable(AnalysisID AID) {
+/// Augment RequiredAnalysis by adding analysis required by pass P.
+void CommonPassManagerImpl::noteDownRequiredAnalysis(Pass *P) {
+  AnalysisUsage AnUsage;
+  P->getAnalysisUsage(AnUsage);
+  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
 
-  // TODO
-  return false;
+  // FIXME: What about duplicates ?
+  RequiredAnalysis.insert(RequiredAnalysis.end(), RequiredSet.begin(), 
+                          RequiredSet.end());
 }
 
-/// Augment RequiredSet by adding analysis required by pass P.
-void PassManagerAnalysisHelper::noteDownRequiredAnalysis(Pass *P) {
+/// Augement AvailableAnalysis by adding analysis made available by pass P.
+void CommonPassManagerImpl::noteDownAvailableAnalysis(Pass *P) {
+  
+  if (const PassInfo *PI = P->getPassInfo()) {
+    AvailableAnalysis.insert(PI);
+
+    //TODO This pass is the current implementation of all of the interfaces it
+    //TODO implements as well.
+    //TODO
+    //TODO const std::vector<const PassInfo*> &II = PI->getInterfacesImplemented();
+    //TODO for (unsigned i = 0, e = II.size(); i != e; ++i)
+    //TODO CurrentAnalyses[II[i]] = P;
+  }
+}
 
-  // TODO
+/// Remove Analyss not preserved by Pass P
+void CommonPassManagerImpl::removeNotPreservedAnalysis(Pass *P) {
+  AnalysisUsage AnUsage;
+  P->getAnalysisUsage(AnUsage);
+  const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
+
+  for (std::set<AnalysisID>::iterator I = AvailableAnalysis.begin(),
+         E = AvailableAnalysis.end(); I != E; ++I ) {
+    if (std::find(PreservedSet.begin(), PreservedSet.end(), *I) == 
+        PreservedSet.end()) {
+      // Remove this analysis
+      std::set<AnalysisID>::iterator J = I++;
+      AvailableAnalysis.erase(J);
+    }
+  }
 }
 
-/// Remove AnalysisID from the RequiredSet
-void PassManagerAnalysisHelper::removeAnalysis(AnalysisID AID) {
+/// Add pass P into the PassVector. Update RequiredAnalysis and
+/// AvailableAnalysis appropriately if ProcessAnalysis is true.
+void CommonPassManagerImpl::addPassToManager (Pass *P, 
+                                              bool ProcessAnalysis) {
 
-  // TODO
-}
+  if (ProcessAnalysis) {
+    // Take a note of analysis required and made available by this pass
+    noteDownRequiredAnalysis(P);
+    noteDownAvailableAnalysis(P);
 
-/// Remove Analyss not preserved by Pass P
-void PassManagerAnalysisHelper::removeNotPreservedAnalysis(Pass *P) {
+    // Remove the analysis not preserved by this pass
+    removeNotPreservedAnalysis(P);
+  }
 
-  // TODO
+  // Add pass
+  PassVector.push_back(P);
 }
 
 /// BasicBlockPassManager implementation
 
-/// Add pass P into PassVector and return TRUE. If this pass is not
-/// manageable by this manager then return FALSE.
+/// Add pass P into PassVector and return true. If this pass is not
+/// manageable by this manager then return false.
 bool
-BasicBlockPassManager_New::addPass (Pass *P) {
+BasicBlockPassManager_New::addPass(Pass *P) {
 
   BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
   if (!BP)
@@ -71,14 +290,11 @@ BasicBlockPassManager_New::addPass (Pass *P) {
 
   // If this pass does not preserve anlysis that is used by other passes
   // managed by this manager than it is not a suiable pass for this manager.
-  if (!manageablePass (P))
+  if (!manageablePass(P))
     return false;
 
-  // Take a note of analysis required by this pass.
-  noteDownRequiredAnalysis(P);
+  addPassToManager (BP);
 
-  // Add pass
-  PassVector.push_back(BP);
   return true;
 }
 
@@ -90,8 +306,8 @@ BasicBlockPassManager_New::runOnFunction(Function &F) {
 
   bool Changed = false;
   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
-    for (std::vector<Pass *>::iterator itr = PassVector.begin(),
-           e = PassVector.end(); itr != e; ++itr) {
+    for (std::vector<Pass *>::iterator itr = passVectorBegin(),
+           e = passVectorEnd(); itr != e; ++itr) {
       Pass *P = *itr;
       BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P);
       Changed |= BP->runOnBasicBlock(*I);
@@ -99,16 +315,44 @@ BasicBlockPassManager_New::runOnFunction(Function &F) {
   return Changed;
 }
 
+/// Return true IFF AnalysisID AID is currently available.
+bool BasicBlockPassManager_New::analysisCurrentlyAvailable(AnalysisID AID) {
+  return isAnalysisAvailable(AID);
+}
+
 // FunctionPassManager_New implementation
+/// Create new Function pass manager
+FunctionPassManager_New::FunctionPassManager_New() {
+  FPM = new FunctionPassManagerImpl_New();
+}
+
+/// add - Add a pass to the queue of passes to run.  This passes
+/// ownership of the Pass to the PassManager.  When the
+/// PassManager_X is destroyed, the pass will be destroyed as well, so
+/// there is no need to delete the pass. (TODO delete passes.)
+/// This implies that all passes MUST be allocated with 'new'.
+void 
+FunctionPassManager_New::add(Pass *P) { 
+  FPM->add(P);
+}
+
+/// Execute all of the passes scheduled for execution.  Keep
+/// track of whether any of the passes modifies the function, and if
+/// so, return true.
+bool 
+FunctionPassManager_New::runOnModule(Module &M) {
+  return FPM->runOnModule(M);
+}
+
+// FunctionPassManagerImpl_New implementation
 
-///////////////////////////////////////////////////////////////////////////////
 // FunctionPassManager
 
 /// Add pass P into the pass manager queue. If P is a BasicBlockPass then
 /// either use it into active basic block pass manager or create new basic
 /// block pass manager to handle pass P.
 bool
-FunctionPassManager_New::addPass (Pass *P) {
+FunctionPassManagerImpl_New::addPass(Pass *P) {
 
   // If P is a BasicBlockPass then use BasicBlockPassManager_New.
   if (BasicBlockPass *BP = dynamic_cast<BasicBlockPass*>(P)) {
@@ -117,10 +361,9 @@ FunctionPassManager_New::addPass (Pass *P) {
         || !activeBBPassManager->addPass(BP)) {
 
       activeBBPassManager = new BasicBlockPassManager_New();
-
-      PassVector.push_back(activeBBPassManager);
-      assert (!activeBBPassManager->addPass(BP) &&
-              "Unable to add Pass");
+      addPassToManager(activeBBPassManager, false);
+      if (!activeBBPassManager->addPass(BP))
+        assert(0 && "Unable to add Pass");
     }
     return true;
   }
@@ -131,13 +374,10 @@ FunctionPassManager_New::addPass (Pass *P) {
 
   // If this pass does not preserve anlysis that is used by other passes
   // managed by this manager than it is not a suiable pass for this manager.
-  if (!manageablePass (P))
+  if (!manageablePass(P))
     return false;
 
-  // Take a note of analysis required by this pass.
-  noteDownRequiredAnalysis(P);
-
-  PassVector.push_back(FP);
+  addPassToManager (FP);
   activeBBPassManager = NULL;
   return true;
 }
@@ -146,12 +386,12 @@ FunctionPassManager_New::addPass (Pass *P) {
 /// runOnFunction method.  Keep track of whether any of the passes modifies 
 /// the function, and if so, return true.
 bool
-FunctionPassManager_New::runOnModule(Module &M) {
+FunctionPassManagerImpl_New::runOnModule(Module &M) {
 
   bool Changed = false;
   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
-    for (std::vector<Pass *>::iterator itr = PassVector.begin(),
-           e = PassVector.end(); itr != e; ++itr) {
+    for (std::vector<Pass *>::iterator itr = passVectorBegin(),
+           e = passVectorEnd(); itr != e; ++itr) {
       Pass *P = *itr;
       FunctionPass *FP = dynamic_cast<FunctionPass*>(P);
       Changed |= FP->runOnFunction(*I);
@@ -159,14 +399,27 @@ FunctionPassManager_New::runOnModule(Module &M) {
   return Changed;
 }
 
+/// Return true IFF AnalysisID AID is currently available.
+bool FunctionPassManagerImpl_New::analysisCurrentlyAvailable(AnalysisID AID) {
+
+  if (isAnalysisAvailable(AID))
+    return true;
+
+  if (activeBBPassManager && 
+      activeBBPassManager->isAnalysisAvailable(AID))
+    return true;
+
+  // TODO : Check inactive managers
+  return false;
+}
 
 // ModulePassManager implementation
 
 /// Add P into pass vector if it is manageble. If P is a FunctionPass
-/// then use FunctionPassManager_New to manage it. Return FALSE if P
+/// then use FunctionPassManagerImpl_New to manage it. Return false if P
 /// is not manageable by this manager.
 bool
-ModulePassManager_New::addPass (Pass *P) {
+ModulePassManager_New::addPass(Pass *P) {
 
   // If P is FunctionPass then use function pass maanager.
   if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P)) {
@@ -176,11 +429,10 @@ ModulePassManager_New::addPass (Pass *P) {
     if (!activeFunctionPassManager
         || !activeFunctionPassManager->addPass(P)) {
 
-      activeFunctionPassManager = new FunctionPassManager_New();
-
-      PassVector.push_back(activeFunctionPassManager);
-      assert (!activeFunctionPassManager->addPass(FP) &&
-              "Unable to add Pass");
+      activeFunctionPassManager = new FunctionPassManagerImpl_New();
+      addPassToManager(activeFunctionPassManager, false);
+      if (!activeFunctionPassManager->addPass(FP))
+        assert(0 && "Unable to add pass");
     }
     return true;
   }
@@ -191,13 +443,10 @@ ModulePassManager_New::addPass (Pass *P) {
 
   // If this pass does not preserve anlysis that is used by other passes
   // managed by this manager than it is not a suiable pass for this manager.
-  if (!manageablePass (P))
+  if (!manageablePass(P))
     return false;
 
-  // Take a note of analysis required by this pass.
-  noteDownRequiredAnalysis(P);
-
-  PassVector.push_back(MP);
+  addPassToManager(MP);
   activeFunctionPassManager = NULL;
   return true;
 }
@@ -209,8 +458,8 @@ ModulePassManager_New::addPass (Pass *P) {
 bool
 ModulePassManager_New::runOnModule(Module &M) {
   bool Changed = false;
-  for (std::vector<Pass *>::iterator itr = PassVector.begin(),
-         e = PassVector.end(); itr != e; ++itr) {
+  for (std::vector<Pass *>::iterator itr = passVectorBegin(),
+         e = passVectorEnd(); itr != e; ++itr) {
     Pass *P = *itr;
     ModulePass *MP = dynamic_cast<ModulePass*>(P);
     Changed |= MP->runOnModule(M);
@@ -218,26 +467,75 @@ ModulePassManager_New::runOnModule(Module &M) {
   return Changed;
 }
 
+/// Return true IFF AnalysisID AID is currently available.
+bool ModulePassManager_New::analysisCurrentlyAvailable(AnalysisID AID) {
+
+  if (isAnalysisAvailable(AID))
+    return true;
+
+  if (activeFunctionPassManager && 
+      activeFunctionPassManager->isAnalysisAvailable(AID))
+    return true;
+
+  // TODO : Check inactive managers
+  return false;
+}
+
+/// Return true IFF AnalysisID AID is currently available.
+bool PassManagerImpl_New::analysisCurrentlyAvailable(AnalysisID AID) {
+
+  bool available = false;
+  for (std::vector<ModulePassManager_New *>::iterator itr = PassManagers.begin(),
+         e = PassManagers.end(); !available && itr != e; ++itr)
+    available  = (*itr)->analysisCurrentlyAvailable(AID);
+  return available;
+}
+
+/// Schedule pass P for execution. Make sure that passes required by
+/// P are run before P is run. Update analysis info maintained by
+/// the manager. Remove dead passes. This is a recursive function.
+void PassManagerImpl_New::schedulePass(Pass *P) {
+
+  AnalysisUsage AnUsage;
+  P->getAnalysisUsage(AnUsage);
+  const std::vector<AnalysisID> &RequiredSet = AnUsage.getRequiredSet();
+  for (std::vector<AnalysisID>::const_iterator I = RequiredSet.begin(),
+         E = RequiredSet.end(); I != E; ++I) {
+
+    if (!analysisCurrentlyAvailable(*I)) {
+      // Schedule this analysis run first.
+      Pass *AP = (*I)->createPass();
+      schedulePass(AP);
+    }
+  }
+    
+  addPass(P);
+
+  // TODO : Walk through all managers and remove not preserved analysis
+  // TODO : remove dead passes
+}
+
 /// Schedule all passes from the queue by adding them in their
 /// respective manager's queue. 
-void
-PassManager_New::schedulePasses() {
-  /* TODO */
+void PassManagerImpl_New::schedulePasses() {
+  for (std::vector<Pass *>::iterator I = passVectorBegin(),
+         E = passVectorEnd(); I != E; ++I)
+    schedulePass (*I);
 }
 
 /// Add pass P to the queue of passes to run.
-void
-PassManager_New::add(Pass *P) {
-  /* TODO */
+void PassManagerImpl_New::add(Pass *P) {
+  // Do not process Analysis now. Analysis is process while scheduling
+  // the pass vector.
+  addPassToManager(P, false);
 }
 
 // PassManager_New implementation
 /// Add P into active pass manager or use new module pass manager to
 /// manage it.
-bool
-PassManager_New::addPass (Pass *P) {
+bool PassManagerImpl_New::addPass(Pass *P) {
 
-  if (!activeManager) {
+  if (!activeManager || !activeManager->addPass(P)) {
     activeManager = new ModulePassManager_New();
     PassManagers.push_back(activeManager);
   }
@@ -247,8 +545,7 @@ PassManager_New::addPass (Pass *P) {
 
 /// run - Execute all of the passes scheduled for execution.  Keep track of
 /// whether any of the passes modifies the module, and if so, return true.
-bool
-PassManager_New::run(Module &M) {
+bool PassManagerImpl_New::run(Module &M) {
 
   schedulePasses();
   bool Changed = false;
@@ -259,3 +556,25 @@ PassManager_New::run(Module &M) {
   }
   return Changed;
 }
+
+/// Create new pass manager
+PassManager_New::PassManager_New() {
+  PM = new PassManagerImpl_New();
+}
+
+/// add - Add a pass to the queue of passes to run.  This passes ownership of
+/// the Pass to the PassManager.  When the PassManager is destroyed, the pass
+/// will be destroyed as well, so there is no need to delete the pass.  This
+/// implies that all passes MUST be allocated with 'new'.
+void 
+PassManager_New::add(Pass *P) {
+  PM->add(P);
+}
+
+/// run - Execute all of the passes scheduled for execution.  Keep track of
+/// whether any of the passes modifies the module, and if so, return true.
+bool
+PassManager_New::run(Module &M) {
+  return PM->run(M);
+}
+