C and Objective Caml bindings for PassManagers.
[oota-llvm.git] / lib / VMCore / PassManager.cpp
index 16477d58324a39c79e941198f4ce4e01f6cb01d1..e7d7c5bc7288d171602b34d0ee7925ec400811fe 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Devang Patel and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 #include "llvm/ModuleProvider.h"
 #include "llvm/Support/Streams.h"
 #include "llvm/Support/ManagedStatic.h"
+#include "llvm-c/Core.h"
 #include <algorithm>
 #include <vector>
 #include <map>
+using namespace llvm;
 
 // See PassManagers.h for Pass Manager infrastructure overview.
 
@@ -64,7 +66,7 @@ class VISIBILITY_HIDDEN BBPassManager : public PMDataManager,
 
 public:
   static char ID;
-  BBPassManager(int Depth) 
+  explicit BBPassManager(int Depth) 
     : PMDataManager(Depth), FunctionPass((intptr_t)&ID) {}
 
   /// Execute all of the passes scheduled for execution.  Keep track of
@@ -82,7 +84,7 @@ public:
   bool doFinalization(Function &F);
 
   virtual const char *getPassName() const {
-    return "BasicBlock Pass  Manager";
+    return "BasicBlock Pass Manager";
   }
 
   // Print passes managed by this manager
@@ -120,7 +122,7 @@ class FunctionPassManagerImpl : public Pass,
                                 public PMTopLevelManager {
 public:
   static char ID;
-  FunctionPassManagerImpl(int Depth) : 
+  explicit FunctionPassManagerImpl(int Depth) : 
     Pass((intptr_t)&ID), PMDataManager(Depth), 
     PMTopLevelManager(TLM_Function) { }
 
@@ -178,13 +180,14 @@ char FunctionPassManagerImpl::ID = 0;
 // MPPassManager
 //
 /// MPPassManager manages ModulePasses and function pass managers.
-/// It batches all Module passes  passes and function pass managers together and
-/// sequence them to process one module.
+/// It batches all Module passes and function pass managers together and
+/// sequences them to process one module.
 class MPPassManager : public Pass, public PMDataManager {
  
 public:
   static char ID;
-  MPPassManager(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth) { }
+  explicit MPPassManager(int Depth) :
+    Pass((intptr_t)&ID), PMDataManager(Depth) { }
 
   // Delete on the fly managers.
   virtual ~MPPassManager() {
@@ -259,8 +262,9 @@ class PassManagerImpl : public Pass,
 
 public:
   static char ID;
-  PassManagerImpl(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth),
-                               PMTopLevelManager(TLM_Pass) { }
+  explicit PassManagerImpl(int Depth) :
+    Pass((intptr_t)&ID), PMDataManager(Depth),
+    PMTopLevelManager(TLM_Pass) { }
 
   /// 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
@@ -452,10 +456,9 @@ Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
 
   Pass *P = NULL;
   // Check pass managers
-  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+  for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
          E = PassManagers.end(); P == NULL && I != E; ++I) {
-    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
-    assert(PMD && "This is not a PassManager");
+    PMDataManager *PMD = *I;
     P = PMD->findAnalysisPass(AID, false);
   }
 
@@ -472,7 +475,8 @@ Pass *PMTopLevelManager::findAnalysisPass(AnalysisID AID) {
 
     // If Pass not found then check the interfaces implemented by Immutable Pass
     if (!P) {
-      const std::vector<const PassInfo*> &ImmPI = PI->getInterfacesImplemented();
+      const std::vector<const PassInfo*> &ImmPI =
+        PI->getInterfacesImplemented();
       if (std::find(ImmPI.begin(), ImmPI.end(), AID) != ImmPI.end())
         P = *I;
     }
@@ -492,9 +496,13 @@ void PMTopLevelManager::dumpPasses() const {
     ImmutablePasses[i]->dumpPassStructure(0);
   }
   
-  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
+  // Every class that derives from PMDataManager also derives from Pass
+  // (sometimes indirectly), but there's no inheritance relationship
+  // between PMDataManager and Pass, so we have to dynamic_cast to get
+  // from a PMDataManager* to a Pass*.
+  for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
          E = PassManagers.end(); I != E; ++I)
-    (*I)->dumpPassStructure(1);
+    dynamic_cast<Pass *>(*I)->dumpPassStructure(1);
 }
 
 void PMTopLevelManager::dumpArguments() const {
@@ -503,10 +511,9 @@ void PMTopLevelManager::dumpArguments() const {
     return;
 
   cerr << "Pass Arguments: ";
-  for (std::vector<Pass *>::const_iterator I = PassManagers.begin(),
+  for (std::vector<PMDataManager *>::const_iterator I = PassManagers.begin(),
          E = PassManagers.end(); I != E; ++I) {
-    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
-    assert(PMD && "This is not a PassManager");
+    PMDataManager *PMD = *I;
     PMD->dumpPassArguments();
   }
   cerr << "\n";
@@ -514,10 +521,9 @@ void PMTopLevelManager::dumpArguments() const {
 
 void PMTopLevelManager::initializeAllAnalysisInfo() {
   
-  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+  for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
          E = PassManagers.end(); I != E; ++I) {
-    PMDataManager *PMD = dynamic_cast<PMDataManager *>(*I);
-    assert(PMD && "This is not a PassManager");
+    PMDataManager *PMD = *I;
     PMD->initializeAnalysisInfo();
   }
   
@@ -529,34 +535,18 @@ void PMTopLevelManager::initializeAllAnalysisInfo() {
 
 /// Destructor
 PMTopLevelManager::~PMTopLevelManager() {
-  for (std::vector<Pass *>::iterator I = PassManagers.begin(),
+  for (std::vector<PMDataManager *>::iterator I = PassManagers.begin(),
          E = PassManagers.end(); I != E; ++I)
     delete *I;
   
   for (std::vector<ImmutablePass *>::iterator
          I = ImmutablePasses.begin(), E = ImmutablePasses.end(); I != E; ++I)
     delete *I;
-  
-  PassManagers.clear();
 }
 
 //===----------------------------------------------------------------------===//
 // PMDataManager implementation
 
-/// Return true IFF pass P's required analysis set does not required new
-/// manager.
-bool PMDataManager::manageablePass(Pass *P) {
-
-  // TODO 
-  // If this pass is not preserving information that is required by a
-  // pass maintained by higher level pass manager then do not insert
-  // this pass into current manager. Use new manager. For example,
-  // For example, If FunctionPass F is not preserving ModulePass Info M1
-  // that is used by another ModulePass M2 then do not insert F in
-  // current function pass manager.
-  return true;
-}
-
 /// Augement AvailableAnalysis by adding analysis made available by pass P.
 void PMDataManager::recordAvailableAnalysis(Pass *P) {
                                                 
@@ -585,8 +575,9 @@ bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
   for (std::vector<Pass *>::iterator I = HigherLevelAnalysis.begin(),
          E = HigherLevelAnalysis.end(); I  != E; ++I) {
     Pass *P1 = *I;
-    if (!dynamic_cast<ImmutablePass*>(P1) 
-        && std::find(PreservedSet.begin(), PreservedSet.end(), P1->getPassInfo()) == 
+    if (!dynamic_cast<ImmutablePass*>(P1) &&
+        std::find(PreservedSet.begin(), PreservedSet.end(),
+                  P1->getPassInfo()) == 
            PreservedSet.end())
       return false;
   }
@@ -639,8 +630,8 @@ void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
            I = InheritedAnalysis[Index]->begin(),
            E = InheritedAnalysis[Index]->end(); I != E; ) {
       std::map<AnalysisID, Pass *>::iterator Info = I++;
-      if (!dynamic_cast<ImmutablePass*>(Info->second)
-          && std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == 
+      if (!dynamic_cast<ImmutablePass*>(Info->second) &&
+          std::find(PreservedSet.begin(), PreservedSet.end(), Info->first) == 
              PreservedSet.end())
         // Remove this analysis
         InheritedAnalysis[Index]->erase(Info);
@@ -650,7 +641,7 @@ void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 }
 
 /// Remove analysis passes that are not used any longer
-void PMDataManager::removeDeadPasses(Pass *P, const std::string &Msg,
+void PMDataManager::removeDeadPasses(Pass *P, const char *Msg,
                                      enum PassDebuggingString DBG_STR) {
 
   SmallVector<Pass *, 12> DeadPasses;
@@ -856,7 +847,7 @@ void PMDataManager::dumpPassArguments() const {
 
 void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
                                  enum PassDebuggingString S2,
-                                 const std::string &Msg) {
+                                 const char *Msg) {
   if (PassDebugging < Executions)
     return;
   cerr << (void*)this << std::string(getDepth()*2+1, ' ');
@@ -916,6 +907,16 @@ void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
     TPM->dumpArguments();
     TPM->dumpPasses();
   }
+
+  // Module Level pass may required Function Level analysis info 
+  // (e.g. dominator info). Pass manager uses on the fly function pass manager 
+  // to provide this on demand. In that case, in Pass manager terminology, 
+  // module level pass is requiring lower level analysis info managed by
+  // lower level pass manager.
+
+  // When Pass manager is not able to order required analysis info, Pass manager
+  // checks whether any lower level manager will be able to provide this 
+  // analysis info on demand or not.
   assert (0 && "Unable to handle Pass that requires lower level Analysis pass");
 }
 
@@ -926,7 +927,6 @@ PMDataManager::~PMDataManager() {
          E = PassVector.end(); I != E; ++I)
     delete *I;
   
-  PassVector.clear();
 }
 
 //===----------------------------------------------------------------------===//
@@ -961,7 +961,7 @@ BBPassManager::runOnFunction(Function &F) {
       AnalysisUsage AnUsage;
       BP->getAnalysisUsage(AnUsage);
 
-      dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
+      dumpPassInfo(BP, EXECUTION_MSG, ON_BASICBLOCK_MSG, I->getNameStart());
       dumpAnalysisSetInfo("Required", BP, AnUsage.getRequiredSet());
 
       initializeAnalysisImpl(BP);
@@ -971,15 +971,16 @@ BBPassManager::runOnFunction(Function &F) {
       if (TheTimeInfo) TheTimeInfo->passEnded(BP);
 
       if (Changed) 
-        dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG, (*I).getName());
+        dumpPassInfo(BP, MODIFICATION_MSG, ON_BASICBLOCK_MSG,
+                     I->getNameStart());
       dumpAnalysisSetInfo("Preserved", BP, AnUsage.getPreservedSet());
 
       verifyPreservedAnalysis(BP);
       removeNotPreservedAnalysis(BP);
       recordAvailableAnalysis(BP);
-      removeDeadPasses(BP, (*I).getName(), ON_BASICBLOCK_MSG);
-                       
+      removeDeadPasses(BP, I->getNameStart(), ON_BASICBLOCK_MSG);
     }
+
   return Changed |= doFinalization(F);
 }
 
@@ -1038,8 +1039,7 @@ FunctionPassManager::FunctionPassManager(ModuleProvider *P) {
   // FPM is the top level manager.
   FPM->setTopLevelManager(FPM);
 
-  PMDataManager *PMD = dynamic_cast<PMDataManager *>(FPM);
-  AnalysisResolver *AR = new AnalysisResolver(*PMD);
+  AnalysisResolver *AR = new AnalysisResolver(*FPM);
   FPM->setResolver(AR);
   
   MP = P;
@@ -1159,7 +1159,7 @@ bool FPPassManager::runOnFunction(Function &F) {
     AnalysisUsage AnUsage;
     FP->getAnalysisUsage(AnUsage);
 
-    dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());
+    dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getNameStart());
     dumpAnalysisSetInfo("Required", FP, AnUsage.getRequiredSet());
 
     initializeAnalysisImpl(FP);
@@ -1169,13 +1169,13 @@ bool FPPassManager::runOnFunction(Function &F) {
     if (TheTimeInfo) TheTimeInfo->passEnded(FP);
 
     if (Changed) 
-      dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getName());
+      dumpPassInfo(FP, MODIFICATION_MSG, ON_FUNCTION_MSG, F.getNameStart());
     dumpAnalysisSetInfo("Preserved", FP, AnUsage.getPreservedSet());
 
     verifyPreservedAnalysis(FP);
     removeNotPreservedAnalysis(FP);
     recordAvailableAnalysis(FP);
-    removeDeadPasses(FP, F.getName(), ON_FUNCTION_MSG);
+    removeDeadPasses(FP, F.getNameStart(), ON_FUNCTION_MSG);
   }
   return Changed;
 }
@@ -1228,7 +1228,8 @@ MPPassManager::runOnModule(Module &M) {
     AnalysisUsage AnUsage;
     MP->getAnalysisUsage(AnUsage);
 
-    dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG, M.getModuleIdentifier());
+    dumpPassInfo(MP, EXECUTION_MSG, ON_MODULE_MSG,
+                 M.getModuleIdentifier().c_str());
     dumpAnalysisSetInfo("Required", MP, AnUsage.getRequiredSet());
 
     initializeAnalysisImpl(MP);
@@ -1239,13 +1240,13 @@ MPPassManager::runOnModule(Module &M) {
 
     if (Changed) 
       dumpPassInfo(MP, MODIFICATION_MSG, ON_MODULE_MSG,
-                   M.getModuleIdentifier());
+                   M.getModuleIdentifier().c_str());
     dumpAnalysisSetInfo("Preserved", MP, AnUsage.getPreservedSet());
       
     verifyPreservedAnalysis(MP);
     removeNotPreservedAnalysis(MP);
     recordAvailableAnalysis(MP);
-    removeDeadPasses(MP, M.getModuleIdentifier(), ON_MODULE_MSG);
+    removeDeadPasses(MP, M.getModuleIdentifier().c_str(), ON_MODULE_MSG);
   }
   return Changed;
 }
@@ -1392,10 +1393,9 @@ void PMStack::pop() {
 }
 
 // Push PM on the stack and set its top level manager.
-void PMStack::push(Pass *P) {
+void PMStack::push(PMDataManager *PM) {
 
   PMDataManager *Top = NULL;
-  PMDataManager *PM = dynamic_cast<PMDataManager *>(P);
   assert (PM && "Unable to push. Pass Manager expected");
 
   if (this->empty()) {
@@ -1418,10 +1418,10 @@ void PMStack::dump() {
   for(std::deque<PMDataManager *>::iterator I = S.begin(),
         E = S.end(); I != E; ++I) {
     Pass *P = dynamic_cast<Pass *>(*I);
-    printf ("%s ", P->getPassName());
+    printf("%s ", P->getPassName());
   }
   if (!S.empty())
-    printf ("\n");
+    printf("\n");
 }
 
 /// Find appropriate Module Pass Manager in the PM Stack and
@@ -1471,14 +1471,13 @@ void FunctionPass::assignPassManager(PMStack &PMS,
 
     // [3] Assign manager to manage this new manager. This may create
     // and push new managers into PMS
-    Pass *P = dynamic_cast<Pass *>(FPP);
 
     // If Call Graph Pass Manager is active then use it to manage
     // this new Function Pass manager.
     if (PMD->getPassManagerType() == PMT_CallGraphPassManager)
-      P->assignPassManager(PMS, PMT_CallGraphPassManager);
+      FPP->assignPassManager(PMS, PMT_CallGraphPassManager);
     else
-      P->assignPassManager(PMS);
+      FPP->assignPassManager(PMS);
 
     // [4] Push new manager into PMS
     PMS.push(FPP);
@@ -1497,9 +1496,8 @@ void BasicBlockPass::assignPassManager(PMStack &PMS,
 
   // Basic Pass Manager is a leaf pass manager. It does not handle
   // any other pass manager.
-  if (!PMS.empty()) {
+  if (!PMS.empty())
     BBP = dynamic_cast<BBPassManager *>(PMS.top());
-  }
 
   // If leaf manager is not Basic Block Pass manager then create new
   // basic Block Pass manager.
@@ -1518,8 +1516,7 @@ void BasicBlockPass::assignPassManager(PMStack &PMS,
 
     // [3] Assign manager to manage this new manager. This may create
     // and push new managers into PMS
-    Pass *P = dynamic_cast<Pass *>(BBP);
-    P->assignPassManager(PMS);
+    BBP->assignPassManager(PMS);
 
     // [4] Push new manager into PMS
     PMS.push(BBP);
@@ -1529,4 +1526,34 @@ void BasicBlockPass::assignPassManager(PMStack &PMS,
   BBP->add(this);
 }
 
+PassManagerBase::~PassManagerBase() {}
+  
+/*===-- C Bindings --------------------------------------------------------===*/
+
+LLVMPassManagerRef LLVMCreatePassManager() {
+  return wrap(new PassManager());
+}
+
+LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef P) {
+  return wrap(new FunctionPassManager(unwrap(P)));
+}
+
+int LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M) {
+  return unwrap<PassManager>(PM)->run(*unwrap(M));
+}
+
+int LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM) {
+  return unwrap<FunctionPassManager>(FPM)->doInitialization();
+}
 
+int LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F) {
+  return unwrap<FunctionPassManager>(FPM)->run(*unwrap<Function>(F));
+}
+
+int LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM) {
+  return unwrap<FunctionPassManager>(FPM)->doFinalization();
+}
+
+void LLVMDisposePassManager(LLVMPassManagerRef PM) {
+  delete unwrap(PM);
+}