lib/Analysis/IPA/CallGraphSCCPass.cpp

   1 //===- CallGraphSCCPass.cpp - Pass that operates BU on call graph ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the CallGraphSCCPass class, which is used for passes
  11 // which are implemented as bottom-up traversals on the call graph.  Because
  12 // there may be cycles in the call graph, passes of this type operate on the
  13 // call-graph in SCC order: that is, they process function bottom-up, except for
  14 // recursive functions, which they process all at once.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/CallGraphSCCPass.h"
  19 #include "llvm/Analysis/CallGraph.h"
  20 #include "llvm/ADT/SCCIterator.h"
  21 #include "llvm/PassManagers.h"
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 // CGPassManager
  26 //
  27 /// CGPassManager manages FPPassManagers and CalLGraphSCCPasses.
  28
  29 class CGPassManager : public ModulePass, public PMDataManager {
  30
  31 public:
  32   CGPassManager(int Depth) : PMDataManager(Depth) { }
  33
  34   /// run - Execute all of the passes scheduled for execution.  Keep track of
  35   /// whether any of the passes modifies the module, and if so, return true.
  36   bool runOnModule(Module &M);
  37
  38   bool doInitialization(CallGraph &CG);
  39   bool doFinalization(CallGraph &CG);
  40
  41   /// Pass Manager itself does not invalidate any analysis info.
  42   void getAnalysisUsage(AnalysisUsage &Info) const {
  43     // CGPassManager walks SCC and it needs CallGraph.
  44     Info.addRequired<CallGraph>();
  45     Info.setPreservesAll();
  46   }
  47
  48   // Print passes managed by this manager
  49   void dumpPassStructure(unsigned Offset) {
  50     llvm::cerr << std::string(Offset*2, ' ') << "Call Graph SCC Pass Manager\n";
  51     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  52       Pass *P = getContainedPass(Index);
  53       P->dumpPassStructure(Offset + 1);
  54       dumpLastUses(P, Offset+1);
  55     }
  56   }
  57
  58   Pass *getContainedPass(unsigned N) {
  59     assert ( N < PassVector.size() && "Pass number out of range!");
  60     Pass *FP = static_cast<Pass *>(PassVector[N]);
  61     return FP;
  62   }
  63
  64   virtual PassManagerType getPassManagerType() {
  65     return PMT_CallGraphPassManager;
  66   }
  67 };
  68
  69 /// run - Execute all of the passes scheduled for execution.  Keep track of
  70 /// whether any of the passes modifies the module, and if so, return true.
  71 bool CGPassManager::runOnModule(Module &M) {
  72   CallGraph &CG = getAnalysis<CallGraph>();
  73   bool Changed = doInitialization(CG);
  74
  75   std::string Msg1 = "Executing Pass '";
  76   std::string Msg3 = "' Made Modification '";
  77
  78   // Walk SCC
  79   for (scc_iterator<CallGraph*> I = scc_begin(&CG), E = scc_end(&CG);
  80        I != E; ++I) {
  81
  82     // Run all passes on current SCC
  83     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  84
  85       Pass *P = getContainedPass(Index);
  86       AnalysisUsage AnUsage;
  87       P->getAnalysisUsage(AnUsage);
  88
  89       std::string Msg2 = "' on Call Graph ...\n'";
  90       dumpPassInfo(P, Msg1, Msg2);
  91       dumpAnalysisSetInfo("Required", P, AnUsage.getRequiredSet());
  92
  93       initializeAnalysisImpl(P);
  94
  95       TimingInfo *TheTimeInfo = llvm::getTheTimeInfo();
  96       if (TheTimeInfo)  TheTimeInfo->passStarted(P);
  97       if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass *>(P))
  98         Changed |= CGSP->runOnSCC(*I);   // TODO : What if CG is changed ?
  99       else {
 100         FPPassManager *FPP = dynamic_cast<FPPassManager *>(P);
 101         assert (FPP && "Invalid CGPassManager member");
 102
 103         // Run pass P on all functions current SCC
 104         std::vector<CallGraphNode*> &SCC = *I;
 105         for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 106           Function *F = SCC[i]->getFunction();
 107           if (F)
 108             Changed |= FPP->runOnFunction(*F);
 109         }
 110       }
 111       if (TheTimeInfo) TheTimeInfo->passEnded(P);
 112
 113       if (Changed)
 114         dumpPassInfo(P, Msg3, Msg2);
 115       dumpAnalysisSetInfo("Preserved", P, AnUsage.getPreservedSet());
 116
 117       removeNotPreservedAnalysis(P);
 118       recordAvailableAnalysis(P);
 119       removeDeadPasses(P, Msg2);
 120     }
 121   }
 122   Changed |= doFinalization(CG);
 123   return Changed;
 124 }
 125
 126 /// Initialize CG
 127 bool CGPassManager::doInitialization(CallGraph &CG) {
 128   bool Changed = false;
 129   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 130     Pass *P = getContainedPass(Index);
 131     if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass *>(P))
 132       Changed |= CGSP->doInitialization(CG);
 133   }
 134   return Changed;
 135 }
 136
 137 /// Finalize CG
 138 bool CGPassManager::doFinalization(CallGraph &CG) {
 139   bool Changed = false;
 140   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 141     Pass *P = getContainedPass(Index);
 142     if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass *>(P))
 143       Changed |= CGSP->doFinalization(CG);
 144   }
 145   return Changed;
 146 }
 147
 148 /// Assign pass manager to manage this pass.
 149 void CallGraphSCCPass::assignPassManager(PMStack &PMS,
 150                                          PassManagerType PreferredType) {
 151   // Find CGPassManager
 152   while (!PMS.empty()) {
 153     if (PMS.top()->getPassManagerType() > PMT_CallGraphPassManager)
 154       PMS.pop();
 155     else;
 156     break;
 157   }
 158
 159   CGPassManager *CGP = dynamic_cast<CGPassManager *>(PMS.top());
 160
 161   // Create new Call Graph SCC Pass Manager if it does not exist.
 162   if (!CGP) {
 163
 164     assert (!PMS.empty() && "Unable to create Call Graph Pass Manager");
 165     PMDataManager *PMD = PMS.top();
 166
 167     // [1] Create new Call Graph Pass Manager
 168     CGP = new CGPassManager(PMD->getDepth() + 1);
 169
 170     // [2] Set up new manager's top level manager
 171     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 172     TPM->addIndirectPassManager(CGP);
 173
 174     // [3] Assign manager to manage this new manager. This may create
 175     // and push new managers into PMS
 176     Pass *P = dynamic_cast<Pass *>(CGP);
 177     P->assignPassManager(PMS);
 178
 179     // [4] Push new manager into PMS
 180     PMS.push(CGP);
 181   }
 182
 183   CGP->add(this);
 184 }
 185
 186 /// getAnalysisUsage - For this class, we declare that we require and preserve
 187 /// the call graph.  If the derived class implements this method, it should
 188 /// always explicitly call the implementation here.
 189 void CallGraphSCCPass::getAnalysisUsage(AnalysisUsage &AU) const {
 190   AU.addRequired<CallGraph>();
 191   AU.addPreserved<CallGraph>();
 192 }