Add comment.
[oota-llvm.git] / lib / VMCore / PassManager.cpp
index ee9200c26af88408b1dcca1d9fd4eb95665a9794..5620d0f886cca8fbabcdab447a21a8c0bbfae3fe 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.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -22,6 +22,7 @@
 #include <algorithm>
 #include <vector>
 #include <map>
+using namespace llvm;
 
 // See PassManagers.h for Pass Manager infrastructure overview.
 
@@ -63,8 +64,8 @@ class VISIBILITY_HIDDEN BBPassManager : public PMDataManager,
                                         public FunctionPass {
 
 public:
-  static const char ID;
-  BBPassManager(int Depth) 
+  static char ID;
+  explicit BBPassManager(int Depth) 
     : PMDataManager(Depth), FunctionPass((intptr_t)&ID) {}
 
   /// Execute all of the passes scheduled for execution.  Keep track of
@@ -106,7 +107,7 @@ public:
   }
 };
 
-const char BBPassManager::ID = 0;
+char BBPassManager::ID = 0;
 }
 
 namespace llvm {
@@ -119,8 +120,8 @@ class FunctionPassManagerImpl : public Pass,
                                 public PMDataManager,
                                 public PMTopLevelManager {
 public:
-  static const char ID;
-  FunctionPassManagerImpl(int Depth) : 
+  static char ID;
+  explicit FunctionPassManagerImpl(int Depth) : 
     Pass((intptr_t)&ID), PMDataManager(Depth), 
     PMTopLevelManager(TLM_Function) { }
 
@@ -140,7 +141,7 @@ public:
   ///
   bool doInitialization(Module &M);
   
-  /// doFinalization - Run all of the initializers for the function passes.
+  /// doFinalization - Run all of the finalizers for the function passes.
   ///
   bool doFinalization(Module &M);
 
@@ -173,7 +174,7 @@ public:
   }
 };
 
-const char FunctionPassManagerImpl::ID = 0;
+char FunctionPassManagerImpl::ID = 0;
 //===----------------------------------------------------------------------===//
 // MPPassManager
 //
@@ -183,8 +184,9 @@ const char FunctionPassManagerImpl::ID = 0;
 class MPPassManager : public Pass, public PMDataManager {
  
 public:
-  static const char ID;
-  MPPassManager(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth) { }
+  static char ID;
+  explicit MPPassManager(int Depth) :
+    Pass((intptr_t)&ID), PMDataManager(Depth) { }
 
   // Delete on the fly managers.
   virtual ~MPPassManager() {
@@ -247,7 +249,7 @@ public:
   std::map<Pass *, FunctionPassManagerImpl *> OnTheFlyManagers;
 };
 
-const char MPPassManager::ID = 0;
+char MPPassManager::ID = 0;
 //===----------------------------------------------------------------------===//
 // PassManagerImpl
 //
@@ -258,9 +260,10 @@ class PassManagerImpl : public Pass,
                         public PMTopLevelManager {
 
 public:
-  static const char ID;
-  PassManagerImpl(int Depth) : Pass((intptr_t)&ID), PMDataManager(Depth),
-                               PMTopLevelManager(TLM_Pass) { }
+  static char ID;
+  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
@@ -304,7 +307,7 @@ public:
 
 };
 
-const char PassManagerImpl::ID = 0;
+char PassManagerImpl::ID = 0;
 } // End of llvm namespace
 
 namespace {
@@ -381,10 +384,10 @@ PMTopLevelManager::PMTopLevelManager (enum TopLevelManagerType t) {
 }
 
 /// Set pass P as the last user of the given analysis passes.
-void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses, 
+void PMTopLevelManager::setLastUser(SmallVector<Pass *, 12> &AnalysisPasses, 
                                     Pass *P) {
 
-  for (std::vector<Pass *>::iterator I = AnalysisPasses.begin(),
+  for (SmallVector<Pass *, 12>::iterator I = AnalysisPasses.begin(),
          E = AnalysisPasses.end(); I != E; ++I) {
     Pass *AP = *I;
     LastUser[AP] = P;
@@ -403,7 +406,7 @@ void PMTopLevelManager::setLastUser(std::vector<Pass *> &AnalysisPasses,
 }
 
 /// Collect passes whose last user is P
-void PMTopLevelManager::collectLastUses(std::vector<Pass *> &LastUses,
+void PMTopLevelManager::collectLastUses(SmallVector<Pass *, 12> &LastUses,
                                             Pass *P) {
    for (std::map<Pass *, Pass *>::iterator LUI = LastUser.begin(),
           LUE = LastUser.end(); LUI != LUE; ++LUI)
@@ -419,11 +422,6 @@ void PMTopLevelManager::schedulePass(Pass *P) {
   // TODO : Allocate function manager for this pass, other wise required set
   // may be inserted into previous function manager
 
-  // If this Analysis is already requested by one of the previous pass
-  // and it is still available then do not insert new pass in the queue again.
-  if (findAnalysisPass(P->getPassInfo()))
-      return;
-
   // Give pass a chance to prepare the stage.
   P->preparePassManager(activeStack);
 
@@ -477,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;
     }
@@ -590,8 +589,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;
   }
@@ -599,11 +599,26 @@ bool PMDataManager::preserveHigherLevelAnalysis(Pass *P) {
   return true;
 }
 
+/// verifyPreservedAnalysis -- Verify analysis presreved by pass P.
+void PMDataManager::verifyPreservedAnalysis(Pass *P) {
+  AnalysisUsage AnUsage;
+  P->getAnalysisUsage(AnUsage);
+  const std::vector<AnalysisID> &PreservedSet = AnUsage.getPreservedSet();
+
+  // Verify preserved analysis
+  for (std::vector<AnalysisID>::const_iterator I = PreservedSet.begin(),
+         E = PreservedSet.end(); I != E; ++I) {
+    AnalysisID AID = *I;
+    Pass *AP = findAnalysisPass(AID, true);
+    if (AP)
+      AP->verifyAnalysis();
+  }
+}
+
 /// Remove Analyss not preserved by Pass P
 void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
   AnalysisUsage AnUsage;
   P->getAnalysisUsage(AnUsage);
-
   if (AnUsage.getPreservesAll())
     return;
 
@@ -629,8 +644,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);
@@ -640,10 +655,10 @@ void PMDataManager::removeNotPreservedAnalysis(Pass *P) {
 }
 
 /// Remove analysis passes that are not used any longer
-void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
+void PMDataManager::removeDeadPasses(Pass *P, const char *Msg,
                                      enum PassDebuggingString DBG_STR) {
 
-  std::vector<Pass *> DeadPasses;
+  SmallVector<Pass *, 12> DeadPasses;
 
   // If this is a on the fly manager then it does not have TPM.
   if (!TPM)
@@ -651,7 +666,7 @@ void PMDataManager::removeDeadPasses(Pass *P, std::string Msg,
 
   TPM->collectLastUses(DeadPasses, P);
 
-  for (std::vector<Pass *>::iterator I = DeadPasses.begin(),
+  for (SmallVector<Pass *, 12>::iterator I = DeadPasses.begin(),
          E = DeadPasses.end(); I != E; ++I) {
 
     dumpPassInfo(*I, FREEING_MSG, DBG_STR, Msg);
@@ -681,12 +696,12 @@ void PMDataManager::add(Pass *P,
 
   // If a FunctionPass F is the last user of ModulePass info M
   // then the F's manager, not F, records itself as a last user of M.
-  std::vector<Pass *> TransferLastUses;
+  SmallVector<Pass *, 12> TransferLastUses;
 
   if (ProcessAnalysis) {
 
     // At the moment, this pass is the last user of all required passes.
-    std::vector<Pass *> LastUses;
+    SmallVector<Pass *, 12> LastUses;
     SmallVector<Pass *, 8> RequiredPasses;
     SmallVector<AnalysisID, 8> ReqAnalysisNotAvailable;
 
@@ -817,7 +832,7 @@ Pass *PMDataManager::findAnalysisPass(AnalysisID AID, bool SearchParent) {
 // Print list of passes that are last used by P.
 void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
 
-  std::vector<Pass *> LUses;
+  SmallVector<Pass *, 12> LUses;
 
   // If this is a on the fly manager then it does not have TPM.
   if (!TPM)
@@ -825,7 +840,7 @@ void PMDataManager::dumpLastUses(Pass *P, unsigned Offset) const{
 
   TPM->collectLastUses(LUses, P);
   
-  for (std::vector<Pass *>::iterator I = LUses.begin(),
+  for (SmallVector<Pass *, 12>::iterator I = LUses.begin(),
          E = LUses.end(); I != E; ++I) {
     llvm::cerr << "--" << std::string(Offset*2, ' ');
     (*I)->dumpPassStructure(0);
@@ -844,9 +859,9 @@ void PMDataManager::dumpPassArguments() const {
   }
 }
 
-void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
-                                  enum PassDebuggingString S2,
-                                  std::string Msg) {
+void PMDataManager::dumpPassInfo(Pass *P, enum PassDebuggingString S1,
+                                 enum PassDebuggingString S2,
+                                 const char *Msg) {
   if (PassDebugging < Executions)
     return;
   cerr << (void*)this << std::string(getDepth()*2+1, ' ');
@@ -855,7 +870,7 @@ void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
     cerr << "Executing Pass '" << P->getPassName();
     break;
   case MODIFICATION_MSG:
-    cerr << "Made Modification '" << P->getPassName();
+    cerr << "Made Modification '" << P->getPassName();
     break;
   case FREEING_MSG:
     cerr << " Freeing Pass '" << P->getPassName();
@@ -865,19 +880,19 @@ void PMDataManager:: dumpPassInfo(Pass *P, enum PassDebuggingString S1,
   }
   switch (S2) {
   case ON_BASICBLOCK_MSG:
-    cerr << "' on BasicBlock '" << Msg << "...\n";
+    cerr << "' on BasicBlock '" << Msg << "'...\n";
     break;
   case ON_FUNCTION_MSG:
-    cerr << "' on Function '" << Msg << "...\n";
+    cerr << "' on Function '" << Msg << "'...\n";
     break;
   case ON_MODULE_MSG:
-    cerr << "' on Module '"  << Msg << "...\n";
+    cerr << "' on Module '"  << Msg << "'...\n";
     break;
   case ON_LOOP_MSG:
-    cerr << "' on Loop " << Msg << "...\n";
+    cerr << "' on Loop " << Msg << "'...\n";
     break;
   case ON_CG_MSG:
-    cerr << "' on Call Graph " << Msg << "...\n";
+    cerr << "' on Call Graph " << Msg << "'...\n";
     break;
   default:
     break;
@@ -897,6 +912,28 @@ void PMDataManager::dumpAnalysisSetInfo(const char *Msg, Pass *P,
   }
 }
 
+/// Add RequiredPass into list of lower level passes required by pass P.
+/// RequiredPass is run on the fly by Pass Manager when P requests it
+/// through getAnalysis interface.
+/// This should be handled by specific pass manager.
+void PMDataManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
+  if (TPM) {
+    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");
+}
+
 // Destructor
 PMDataManager::~PMDataManager() {
   
@@ -939,7 +976,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);
@@ -949,14 +986,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);
 }
 
@@ -1042,7 +1081,7 @@ void FunctionPassManager::add(Pass *P) {
 bool FunctionPassManager::run(Function &F) {
   std::string errstr;
   if (MP->materializeFunction(&F, &errstr)) {
-    cerr << "Error reading bytecode file: " << errstr << "\n";
+    cerr << "Error reading bitcode file: " << errstr << "\n";
     abort();
   }
   return FPM->run(F);
@@ -1055,7 +1094,7 @@ bool FunctionPassManager::doInitialization() {
   return FPM->doInitialization(*MP->getModule());
 }
 
-/// doFinalization - Run all of the initializers for the function passes.
+/// doFinalization - Run all of the finalizers for the function passes.
 ///
 bool FunctionPassManager::doFinalization() {
   return FPM->doFinalization(*MP->getModule());
@@ -1108,7 +1147,7 @@ bool FunctionPassManagerImpl::run(Function &F) {
 //===----------------------------------------------------------------------===//
 // FPPassManager implementation
 
-const char FPPassManager::ID = 0;
+char FPPassManager::ID = 0;
 /// Print passes managed by this manager
 void FPPassManager::dumpPassStructure(unsigned Offset) {
   llvm::cerr << std::string(Offset*2, ' ') << "FunctionPass Manager\n";
@@ -1136,7 +1175,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);
@@ -1146,12 +1185,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;
 }
@@ -1204,7 +1244,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);
@@ -1215,12 +1256,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;
 }
@@ -1247,7 +1289,7 @@ void MPPassManager::addLowerLevelRequiredPass(Pass *P, Pass *RequiredPass) {
   FPP->add(RequiredPass);
 
   // Register P as the last user of RequiredPass.
-  std::vector<Pass *> LU; 
+  SmallVector<Pass *, 12> LU;
   LU.push_back(RequiredPass);
   FPP->setLastUser(LU,  P);
 }
@@ -1385,9 +1427,6 @@ void PMStack::push(Pass *P) {
     PM->setTopLevelManager(TPM);
   }
 
-  AnalysisResolver *AR = new AnalysisResolver(*Top);
-  P->setResolver(AR);
-
   S.push_back(PM);
 }
 
@@ -1396,10 +1435,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
@@ -1475,9 +1514,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.