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 is distributed under the University of Illinois Open Source
   6 // 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 #define DEBUG_TYPE "cgscc-passmgr"
  19 #include "llvm/CallGraphSCCPass.h"
  20 #include "llvm/Analysis/CallGraph.h"
  21 #include "llvm/ADT/SCCIterator.h"
  22 #include "llvm/PassManagers.h"
  23 #include "llvm/Function.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 using namespace llvm;
  27
  28 //===----------------------------------------------------------------------===//
  29 // CGPassManager
  30 //
  31 /// CGPassManager manages FPPassManagers and CalLGraphSCCPasses.
  32
  33 namespace {
  34
  35 class CGPassManager : public ModulePass, public PMDataManager {
  36 public:
  37   static char ID;
  38   explicit CGPassManager(int Depth)
  39     : ModulePass(&ID), PMDataManager(Depth) { }
  40
  41   /// run - Execute all of the passes scheduled for execution.  Keep track of
  42   /// whether any of the passes modifies the module, and if so, return true.
  43   bool runOnModule(Module &M);
  44
  45   bool doInitialization(CallGraph &CG);
  46   bool doFinalization(CallGraph &CG);
  47
  48   /// Pass Manager itself does not invalidate any analysis info.
  49   void getAnalysisUsage(AnalysisUsage &Info) const {
  50     // CGPassManager walks SCC and it needs CallGraph.
  51     Info.addRequired<CallGraph>();
  52     Info.setPreservesAll();
  53   }
  54
  55   virtual const char *getPassName() const {
  56     return "CallGraph Pass Manager";
  57   }
  58
  59   // Print passes managed by this manager
  60   void dumpPassStructure(unsigned Offset) {
  61     errs().indent(Offset*2) << "Call Graph SCC Pass Manager\n";
  62     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  63       Pass *P = getContainedPass(Index);
  64       P->dumpPassStructure(Offset + 1);
  65       dumpLastUses(P, Offset+1);
  66     }
  67   }
  68
  69   Pass *getContainedPass(unsigned N) {
  70     assert(N < PassVector.size() && "Pass number out of range!");
  71     return static_cast<Pass *>(PassVector[N]);
  72   }
  73
  74   virtual PassManagerType getPassManagerType() const {
  75     return PMT_CallGraphPassManager;
  76   }
  77
  78 private:
  79   bool RunPassOnSCC(Pass *P, std::vector<CallGraphNode*> &CurSCC,
  80                     CallGraph &CG, bool &CallGraphUpToDate);
  81   void RefreshCallGraph(std::vector<CallGraphNode*> &CurSCC, CallGraph &CG);
  82 };
  83
  84 } // end anonymous namespace.
  85
  86 char CGPassManager::ID = 0;
  87
  88 bool CGPassManager::RunPassOnSCC(Pass *P, std::vector<CallGraphNode*> &CurSCC,
  89                                  CallGraph &CG, bool &CallGraphUpToDate) {
  90   bool Changed = false;
  91   if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass*>(P)) {
  92     if (!CallGraphUpToDate) {
  93       RefreshCallGraph(CurSCC, CG);
  94       CallGraphUpToDate = true;
  95     }
  96
  97     StartPassTimer(P);
  98     Changed = CGSP->runOnSCC(CurSCC);
  99     StopPassTimer(P);
 100     return Changed;
 101   }
 102
 103   StartPassTimer(P);
 104   FPPassManager *FPP = dynamic_cast<FPPassManager *>(P);
 105   assert(FPP && "Invalid CGPassManager member");
 106
 107   // Run pass P on all functions in the current SCC.
 108   for (unsigned i = 0, e = CurSCC.size(); i != e; ++i) {
 109     if (Function *F = CurSCC[i]->getFunction()) {
 110       dumpPassInfo(P, EXECUTION_MSG, ON_FUNCTION_MSG, F->getName());
 111       Changed |= FPP->runOnFunction(*F);
 112     }
 113   }
 114   StopPassTimer(P);
 115
 116   // The function pass(es) modified the IR, they may have clobbered the
 117   // callgraph.
 118   if (Changed && CallGraphUpToDate) {
 119     DEBUG(errs() << "CGSCCPASSMGR: Pass Dirtied SCC: "
 120                  << P->getPassName() << '\n');
 121     CallGraphUpToDate = false;
 122   }
 123   return Changed;
 124 }
 125
 126 void CGPassManager::RefreshCallGraph(std::vector<CallGraphNode*> &CurSCC,
 127                                      CallGraph &CG) {
 128   DenseMap<Value*, CallGraphNode*> CallSites;
 129
 130   DEBUG(errs() << "CGSCCPASSMGR: Refreshing SCC with " << CurSCC.size()
 131                << " nodes:\n";
 132         for (unsigned i = 0, e = CurSCC.size(); i != e; ++i)
 133           CurSCC[i]->dump();
 134         );
 135
 136   bool MadeChange = false;
 137
 138   // Scan all functions in the SCC.
 139   for (unsigned sccidx = 0, e = CurSCC.size(); sccidx != e; ++sccidx) {
 140     CallGraphNode *CGN = CurSCC[sccidx];
 141     Function *F = CGN->getFunction();
 142     if (F == 0 || F->isDeclaration()) continue;
 143
 144     // Walk the function body looking for call sites.  Sync up the call sites in
 145     // CGN with those actually in the function.
 146
 147     // Get the set of call sites currently in the function.
 148     bool isLast = CGN->empty();
 149     for (CallGraphNode::iterator I = CGN->begin(), E = CGN->end(), N; !isLast;){
 150       // Take care not to use singular iterators.
 151       N = I + 1;
 152       isLast = N == E;
 153
 154       // If this call site is null, then the function pass deleted the call
 155       // entirely and the WeakVH nulled it out.
 156       if (I->first == 0 ||
 157           // If we've already seen this call site, then the FunctionPass RAUW'd
 158           // one call with another, which resulted in two "uses" in the edge
 159           // list of the same call.
 160           CallSites.count(I->first) ||
 161
 162           // If the call edge is not from a call or invoke, then the function
 163           // pass RAUW'd a call with another value.  This can happen when
 164           // constant folding happens of well known functions etc.
 165           CallSite::get(I->first).getInstruction() == 0) {
 166         // Just remove the edge from the set of callees.
 167         CGN->removeCallEdge(I);
 168         E = CGN->end();
 169         continue;
 170       }
 171
 172       assert(!CallSites.count(I->first) &&
 173              "Call site occurs in node multiple times");
 174       CallSites.insert(std::make_pair(I->first, I->second));
 175       I = N;
 176     }
 177
 178     // Loop over all of the instructions in the function, getting the callsites.
 179     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 180       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 181         CallSite CS = CallSite::get(I);
 182         if (!CS.getInstruction()) continue;
 183
 184         // If this call site already existed in the callgraph, just verify it
 185         // matches up to expectations and remove it from CallSites.
 186         DenseMap<Value*, CallGraphNode*>::iterator ExistingIt =
 187           CallSites.find(CS.getInstruction());
 188         if (ExistingIt != CallSites.end()) {
 189           CallGraphNode *ExistingNode = ExistingIt->second;
 190
 191           // Remove from CallSites since we have now seen it.
 192           CallSites.erase(ExistingIt);
 193
 194           // Verify that the callee is right.
 195           if (ExistingNode->getFunction() == CS.getCalledFunction())
 196             continue;
 197
 198           // If not, we either went from a direct call to indirect, indirect to
 199           // direct, or direct to different direct.
 200           CallGraphNode *CalleeNode;
 201           if (Function *Callee = CS.getCalledFunction())
 202             CalleeNode = CG.getOrInsertFunction(Callee);
 203           else
 204             CalleeNode = CG.getCallsExternalNode();
 205
 206           CGN->replaceCallSite(CS, CS, CalleeNode);
 207           MadeChange = true;
 208           continue;
 209         }
 210
 211         // If the call site didn't exist in the CGN yet, add it.  We assume that
 212         // newly introduced call sites won't be indirect.  This could be fixed
 213         // in the future.
 214         CallGraphNode *CalleeNode;
 215         if (Function *Callee = CS.getCalledFunction())
 216           CalleeNode = CG.getOrInsertFunction(Callee);
 217         else
 218           CalleeNode = CG.getCallsExternalNode();
 219
 220         CGN->addCalledFunction(CS, CalleeNode);
 221         MadeChange = true;
 222       }
 223
 224     // After scanning this function, if we still have entries in callsites, then
 225     // they are dangling pointers.  WeakVH should save us for this, so abort if
 226     // this happens.
 227     assert(CallSites.empty() && "Dangling pointers found in call sites map");
 228
 229     // Periodically do an explicit clear to remove tombstones when processing
 230     // large scc's.
 231     if ((sccidx & 15) == 0)
 232       CallSites.clear();
 233   }
 234
 235   DEBUG(if (MadeChange) {
 236           errs() << "CGSCCPASSMGR: Refreshed SCC is now:\n";
 237           for (unsigned i = 0, e = CurSCC.size(); i != e; ++i)
 238             CurSCC[i]->dump();
 239          } else {
 240            errs() << "CGSCCPASSMGR: SCC Refresh didn't change call graph.\n";
 241          }
 242         );
 243 }
 244
 245 /// run - Execute all of the passes scheduled for execution.  Keep track of
 246 /// whether any of the passes modifies the module, and if so, return true.
 247 bool CGPassManager::runOnModule(Module &M) {
 248   CallGraph &CG = getAnalysis<CallGraph>();
 249   bool Changed = doInitialization(CG);
 250
 251   std::vector<CallGraphNode*> CurSCC;
 252
 253   // Walk the callgraph in bottom-up SCC order.
 254   for (scc_iterator<CallGraph*> CGI = scc_begin(&CG), E = scc_end(&CG);
 255        CGI != E;) {
 256     // Copy the current SCC and increment past it so that the pass can hack
 257     // on the SCC if it wants to without invalidating our iterator.
 258     CurSCC = *CGI;
 259     ++CGI;
 260
 261
 262     // CallGraphUpToDate - Keep track of whether the callgraph is known to be
 263     // up-to-date or not.  The CGSSC pass manager runs two types of passes:
 264     // CallGraphSCC Passes and other random function passes.  Because other
 265     // random function passes are not CallGraph aware, they may clobber the
 266     // call graph by introducing new calls or deleting other ones.  This flag
 267     // is set to false when we run a function pass so that we know to clean up
 268     // the callgraph when we need to run a CGSCCPass again.
 269     bool CallGraphUpToDate = true;
 270
 271     // Run all passes on current SCC.
 272     for (unsigned PassNo = 0, e = getNumContainedPasses();
 273          PassNo != e; ++PassNo) {
 274       Pass *P = getContainedPass(PassNo);
 275
 276       dumpPassInfo(P, EXECUTION_MSG, ON_CG_MSG, "");
 277       dumpRequiredSet(P);
 278
 279       initializeAnalysisImpl(P);
 280
 281       // Actually run this pass on the current SCC.
 282       Changed |= RunPassOnSCC(P, CurSCC, CG, CallGraphUpToDate);
 283
 284       if (Changed)
 285         dumpPassInfo(P, MODIFICATION_MSG, ON_CG_MSG, "");
 286       dumpPreservedSet(P);
 287
 288       verifyPreservedAnalysis(P);
 289       removeNotPreservedAnalysis(P);
 290       recordAvailableAnalysis(P);
 291       removeDeadPasses(P, "", ON_CG_MSG);
 292     }
 293
 294     // If the callgraph was left out of date (because the last pass run was a
 295     // functionpass), refresh it before we move on to the next SCC.
 296     if (!CallGraphUpToDate)
 297       RefreshCallGraph(CurSCC, CG);
 298   }
 299   Changed |= doFinalization(CG);
 300   return Changed;
 301 }
 302
 303 /// Initialize CG
 304 bool CGPassManager::doInitialization(CallGraph &CG) {
 305   bool Changed = false;
 306   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 307     Pass *P = getContainedPass(Index);
 308     if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass *>(P)) {
 309       Changed |= CGSP->doInitialization(CG);
 310     } else {
 311       FPPassManager *FP = dynamic_cast<FPPassManager *>(P);
 312       assert (FP && "Invalid CGPassManager member");
 313       Changed |= FP->doInitialization(CG.getModule());
 314     }
 315   }
 316   return Changed;
 317 }
 318
 319 /// Finalize CG
 320 bool CGPassManager::doFinalization(CallGraph &CG) {
 321   bool Changed = false;
 322   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
 323     Pass *P = getContainedPass(Index);
 324     if (CallGraphSCCPass *CGSP = dynamic_cast<CallGraphSCCPass *>(P)) {
 325       Changed |= CGSP->doFinalization(CG);
 326     } else {
 327       FPPassManager *FP = dynamic_cast<FPPassManager *>(P);
 328       assert (FP && "Invalid CGPassManager member");
 329       Changed |= FP->doFinalization(CG.getModule());
 330     }
 331   }
 332   return Changed;
 333 }
 334
 335 /// Assign pass manager to manage this pass.
 336 void CallGraphSCCPass::assignPassManager(PMStack &PMS,
 337                                          PassManagerType PreferredType) {
 338   // Find CGPassManager
 339   while (!PMS.empty() &&
 340          PMS.top()->getPassManagerType() > PMT_CallGraphPassManager)
 341     PMS.pop();
 342
 343   assert (!PMS.empty() && "Unable to handle Call Graph Pass");
 344   CGPassManager *CGP = dynamic_cast<CGPassManager *>(PMS.top());
 345
 346   // Create new Call Graph SCC Pass Manager if it does not exist.
 347   if (!CGP) {
 348
 349     assert (!PMS.empty() && "Unable to create Call Graph Pass Manager");
 350     PMDataManager *PMD = PMS.top();
 351
 352     // [1] Create new Call Graph Pass Manager
 353     CGP = new CGPassManager(PMD->getDepth() + 1);
 354
 355     // [2] Set up new manager's top level manager
 356     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 357     TPM->addIndirectPassManager(CGP);
 358
 359     // [3] Assign manager to manage this new manager. This may create
 360     // and push new managers into PMS
 361     Pass *P = dynamic_cast<Pass *>(CGP);
 362     TPM->schedulePass(P);
 363
 364     // [4] Push new manager into PMS
 365     PMS.push(CGP);
 366   }
 367
 368   CGP->add(this);
 369 }
 370
 371 /// getAnalysisUsage - For this class, we declare that we require and preserve
 372 /// the call graph.  If the derived class implements this method, it should
 373 /// always explicitly call the implementation here.
 374 void CallGraphSCCPass::getAnalysisUsage(AnalysisUsage &AU) const {
 375   AU.addRequired<CallGraph>();
 376   AU.addPreserved<CallGraph>();
 377 }