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/IntrinsicInst.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/PassManagers.h"
  23 #include "llvm/Analysis/CallGraph.h"
  24 #include "llvm/ADT/SCCIterator.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/Timer.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 using namespace llvm;
  29
  30 //===----------------------------------------------------------------------===//
  31 // CGPassManager
  32 //
  33 /// CGPassManager manages FPPassManagers and CallGraphSCCPasses.
  34
  35 namespace {
  36
  37 class CGPassManager : public ModulePass, public PMDataManager {
  38 public:
  39   static char ID;
  40   explicit CGPassManager(int Depth)
  41     : ModulePass(&ID), PMDataManager(Depth) { }
  42
  43   /// run - Execute all of the passes scheduled for execution.  Keep track of
  44   /// whether any of the passes modifies the module, and if so, return true.
  45   bool runOnModule(Module &M);
  46
  47   bool doInitialization(CallGraph &CG);
  48   bool doFinalization(CallGraph &CG);
  49
  50   /// Pass Manager itself does not invalidate any analysis info.
  51   void getAnalysisUsage(AnalysisUsage &Info) const {
  52     // CGPassManager walks SCC and it needs CallGraph.
  53     Info.addRequired<CallGraph>();
  54     Info.setPreservesAll();
  55   }
  56
  57   virtual const char *getPassName() const {
  58     return "CallGraph Pass Manager";
  59   }
  60
  61   virtual PMDataManager *getAsPMDataManager() { return this; }
  62   virtual Pass *getAsPass() { return this; }
  63
  64   // Print passes managed by this manager
  65   void dumpPassStructure(unsigned Offset) {
  66     errs().indent(Offset*2) << "Call Graph SCC Pass Manager\n";
  67     for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
  68       Pass *P = getContainedPass(Index);
  69       P->dumpPassStructure(Offset + 1);
  70       dumpLastUses(P, Offset+1);
  71     }
  72   }
  73
  74   Pass *getContainedPass(unsigned N) {
  75     assert(N < PassVector.size() && "Pass number out of range!");
  76     return static_cast<Pass *>(PassVector[N]);
  77   }
  78
  79   virtual PassManagerType getPassManagerType() const {
  80     return PMT_CallGraphPassManager;
  81   }
  82
  83 private:
  84   bool RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC,
  85                     CallGraph &CG, bool &CallGraphUpToDate);
  86   void RefreshCallGraph(CallGraphSCC &CurSCC, CallGraph &CG,
  87                         bool IsCheckingMode);
  88 };
  89
  90 } // end anonymous namespace.
  91
  92 char CGPassManager::ID = 0;
  93
  94
  95 bool CGPassManager::RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC,
  96                                  CallGraph &CG, bool &CallGraphUpToDate) {
  97   bool Changed = false;
  98   PMDataManager *PM = P->getAsPMDataManager();
  99
 100   if (PM == 0) {
 101     CallGraphSCCPass *CGSP = (CallGraphSCCPass*)P;
 102     if (!CallGraphUpToDate) {
 103       RefreshCallGraph(CurSCC, CG, false);
 104       CallGraphUpToDate = true;
 105     }
 106
 107     {
 108       TimeRegion PassTimer(getPassTimer(CGSP));
 109       Changed = CGSP->runOnSCC(CurSCC);
 110     }
 111
 112     // After the CGSCCPass is done, when assertions are enabled, use
 113     // RefreshCallGraph to verify that the callgraph was correctly updated.
 114 #ifndef NDEBUG
 115     if (Changed)
 116       RefreshCallGraph(CurSCC, CG, true);
 117 #endif
 118
 119     return Changed;
 120   }
 121
 122
 123   assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
 124          "Invalid CGPassManager member");
 125   FPPassManager *FPP = (FPPassManager*)P;
 126
 127   // Run pass P on all functions in the current SCC.
 128   for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end();
 129        I != E; ++I) {
 130     if (Function *F = (*I)->getFunction()) {
 131       dumpPassInfo(P, EXECUTION_MSG, ON_FUNCTION_MSG, F->getName());
 132       TimeRegion PassTimer(getPassTimer(FPP));
 133       Changed |= FPP->runOnFunction(*F);
 134     }
 135   }
 136
 137   // The function pass(es) modified the IR, they may have clobbered the
 138   // callgraph.
 139   if (Changed && CallGraphUpToDate) {
 140     DEBUG(dbgs() << "CGSCCPASSMGR: Pass Dirtied SCC: "
 141                  << P->getPassName() << '\n');
 142     CallGraphUpToDate = false;
 143   }
 144   return Changed;
 145 }
 146
 147
 148 /// RefreshCallGraph - Scan the functions in the specified CFG and resync the
 149 /// callgraph with the call sites found in it.  This is used after
 150 /// FunctionPasses have potentially munged the callgraph, and can be used after
 151 /// CallGraphSCC passes to verify that they correctly updated the callgraph.
 152 ///
 153 void CGPassManager::RefreshCallGraph(CallGraphSCC &CurSCC,
 154                                      CallGraph &CG, bool CheckingMode) {
 155   DenseMap<Value*, CallGraphNode*> CallSites;
 156
 157   DEBUG(dbgs() << "CGSCCPASSMGR: Refreshing SCC with " << CurSCC.size()
 158                << " nodes:\n";
 159         for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end();
 160              I != E; ++I)
 161           (*I)->dump();
 162         );
 163
 164   bool MadeChange = false;
 165
 166   // Scan all functions in the SCC.
 167   unsigned FunctionNo = 0;
 168   for (CallGraphSCC::iterator SCCIdx = CurSCC.begin(), E = CurSCC.end();
 169        SCCIdx != E; ++SCCIdx, ++FunctionNo) {
 170     CallGraphNode *CGN = *SCCIdx;
 171     Function *F = CGN->getFunction();
 172     if (F == 0 || F->isDeclaration()) continue;
 173
 174     // Walk the function body looking for call sites.  Sync up the call sites in
 175     // CGN with those actually in the function.
 176
 177     // Get the set of call sites currently in the function.
 178     for (CallGraphNode::iterator I = CGN->begin(), E = CGN->end(); I != E; ) {
 179       // If this call site is null, then the function pass deleted the call
 180       // entirely and the WeakVH nulled it out.
 181       if (I->first == 0 ||
 182           // If we've already seen this call site, then the FunctionPass RAUW'd
 183           // one call with another, which resulted in two "uses" in the edge
 184           // list of the same call.
 185           CallSites.count(I->first) ||
 186
 187           // If the call edge is not from a call or invoke, then the function
 188           // pass RAUW'd a call with another value.  This can happen when
 189           // constant folding happens of well known functions etc.
 190           CallSite::get(I->first).getInstruction() == 0) {
 191         assert(!CheckingMode &&
 192                "CallGraphSCCPass did not update the CallGraph correctly!");
 193
 194         // Just remove the edge from the set of callees, keep track of whether
 195         // I points to the last element of the vector.
 196         bool WasLast = I + 1 == E;
 197         CGN->removeCallEdge(I);
 198
 199         // If I pointed to the last element of the vector, we have to bail out:
 200         // iterator checking rejects comparisons of the resultant pointer with
 201         // end.
 202         if (WasLast)
 203           break;
 204         E = CGN->end();
 205         continue;
 206       }
 207
 208       assert(!CallSites.count(I->first) &&
 209              "Call site occurs in node multiple times");
 210       CallSites.insert(std::make_pair(I->first, I->second));
 211       ++I;
 212     }
 213
 214     // Loop over all of the instructions in the function, getting the callsites.
 215     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 216       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 217         CallSite CS = CallSite::get(I);
 218         if (!CS.getInstruction() || isa<DbgInfoIntrinsic>(I)) continue;
 219
 220         // If this call site already existed in the callgraph, just verify it
 221         // matches up to expectations and remove it from CallSites.
 222         DenseMap<Value*, CallGraphNode*>::iterator ExistingIt =
 223           CallSites.find(CS.getInstruction());
 224         if (ExistingIt != CallSites.end()) {
 225           CallGraphNode *ExistingNode = ExistingIt->second;
 226
 227           // Remove from CallSites since we have now seen it.
 228           CallSites.erase(ExistingIt);
 229
 230           // Verify that the callee is right.
 231           if (ExistingNode->getFunction() == CS.getCalledFunction())
 232             continue;
 233
 234           // If we are in checking mode, we are not allowed to actually mutate
 235           // the callgraph.  If this is a case where we can infer that the
 236           // callgraph is less precise than it could be (e.g. an indirect call
 237           // site could be turned direct), don't reject it in checking mode, and
 238           // don't tweak it to be more precise.
 239           if (CheckingMode && CS.getCalledFunction() &&
 240               ExistingNode->getFunction() == 0)
 241             continue;
 242
 243           assert(!CheckingMode &&
 244                  "CallGraphSCCPass did not update the CallGraph correctly!");
 245
 246           // If not, we either went from a direct call to indirect, indirect to
 247           // direct, or direct to different direct.
 248           CallGraphNode *CalleeNode;
 249           if (Function *Callee = CS.getCalledFunction())
 250             CalleeNode = CG.getOrInsertFunction(Callee);
 251           else
 252             CalleeNode = CG.getCallsExternalNode();
 253
 254           // Update the edge target in CGN.
 255           for (CallGraphNode::iterator I = CGN->begin(); ; ++I) {
 256             assert(I != CGN->end() && "Didn't find call entry");
 257             if (I->first == CS.getInstruction()) {
 258               I->second = CalleeNode;
 259               break;
 260             }
 261           }
 262           MadeChange = true;
 263           continue;
 264         }
 265
 266         assert(!CheckingMode &&
 267                "CallGraphSCCPass did not update the CallGraph correctly!");
 268
 269         // If the call site didn't exist in the CGN yet, add it.  We assume that
 270         // newly introduced call sites won't be indirect.  This could be fixed
 271         // in the future.
 272         CallGraphNode *CalleeNode;
 273         if (Function *Callee = CS.getCalledFunction())
 274           CalleeNode = CG.getOrInsertFunction(Callee);
 275         else
 276           CalleeNode = CG.getCallsExternalNode();
 277
 278         CGN->addCalledFunction(CS, CalleeNode);
 279         MadeChange = true;
 280       }
 281
 282     // After scanning this function, if we still have entries in callsites, then
 283     // they are dangling pointers.  WeakVH should save us for this, so abort if
 284     // this happens.
 285     assert(CallSites.empty() && "Dangling pointers found in call sites map");
 286
 287     // Periodically do an explicit clear to remove tombstones when processing
 288     // large scc's.
 289     if ((FunctionNo & 15) == 15)
 290       CallSites.clear();
 291   }
 292
 293   DEBUG(if (MadeChange) {
 294           dbgs() << "CGSCCPASSMGR: Refreshed SCC is now:\n";
 295           for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end();
 296             I != E; ++I)
 297               (*I)->dump();
 298          } else {
 299            dbgs() << "CGSCCPASSMGR: SCC Refresh didn't change call graph.\n";
 300          }
 301         );
 302 }
 303
 304 /// run - Execute all of the passes scheduled for execution.  Keep track of
 305 /// whether any of the passes modifies the module, and if so, return true.
 306 bool CGPassManager::runOnModule(Module &M) {
 307   CallGraph &CG = getAnalysis<CallGraph>();
 308   bool Changed = doInitialization(CG);
 309
 310   // Walk the callgraph in bottom-up SCC order.
 311   scc_iterator<CallGraph*> CGI = scc_begin(&CG);
 312
 313   CallGraphSCC CurSCC(&CGI);
 314   while (!CGI.isAtEnd()) {
 315     // Copy the current SCC and increment past it so that the pass can hack
 316     // on the SCC if it wants to without invalidating our iterator.
 317     std::vector<CallGraphNode*> &NodeVec = *CGI;
 318     CurSCC.initialize(&NodeVec[0], &NodeVec[0]+NodeVec.size());
 319     ++CGI;
 320
 321     // CallGraphUpToDate - Keep track of whether the callgraph is known to be
 322     // up-to-date or not.  The CGSSC pass manager runs two types of passes:
 323     // CallGraphSCC Passes and other random function passes.  Because other
 324     // random function passes are not CallGraph aware, they may clobber the
 325     // call graph by introducing new calls or deleting other ones.  This flag
 326     // is set to false when we run a function pass so that we know to clean up
 327     // the callgraph when we need to run a CGSCCPass again.
 328     bool CallGraphUpToDate = true;
 329
 330     // Run all passes on current SCC.
 331     for (unsigned PassNo = 0, e = getNumContainedPasses();
 332          PassNo != e; ++PassNo) {
 333       Pass *P = getContainedPass(PassNo);
 334
 335       // If we're in -debug-pass=Executions mode, construct the SCC node list,
 336       // otherwise avoid constructing this string as it is expensive.
 337       if (isPassDebuggingExecutionsOrMore()) {
 338         std::string Functions;
 339 #ifndef NDEBUG
 340         raw_string_ostream OS(Functions);
 341         for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end();
 342              I != E; ++I) {
 343           if (I != CurSCC.begin()) OS << ", ";
 344           (*I)->print(OS);
 345         }
 346         OS.flush();
 347 #endif
 348         dumpPassInfo(P, EXECUTION_MSG, ON_CG_MSG, Functions);
 349       }
 350       dumpRequiredSet(P);
 351
 352       initializeAnalysisImpl(P);
 353
 354       // Actually run this pass on the current SCC.
 355       Changed |= RunPassOnSCC(P, CurSCC, CG, CallGraphUpToDate);
 356
 357       if (Changed)
 358         dumpPassInfo(P, MODIFICATION_MSG, ON_CG_MSG, "");
 359       dumpPreservedSet(P);
 360
 361       verifyPreservedAnalysis(P);
 362       removeNotPreservedAnalysis(P);
 363       recordAvailableAnalysis(P);
 364       removeDeadPasses(P, "", ON_CG_MSG);
 365     }
 366
 367     // If the callgraph was left out of date (because the last pass run was a
 368     // functionpass), refresh it before we move on to the next SCC.
 369     if (!CallGraphUpToDate)
 370       RefreshCallGraph(CurSCC, CG, false);
 371   }
 372   Changed |= doFinalization(CG);
 373   return Changed;
 374 }
 375
 376 /// Initialize CG
 377 bool CGPassManager::doInitialization(CallGraph &CG) {
 378   bool Changed = false;
 379   for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) {
 380     if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) {
 381       assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
 382              "Invalid CGPassManager member");
 383       Changed |= ((FPPassManager*)PM)->doInitialization(CG.getModule());
 384     } else {
 385       Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doInitialization(CG);
 386     }
 387   }
 388   return Changed;
 389 }
 390
 391 /// Finalize CG
 392 bool CGPassManager::doFinalization(CallGraph &CG) {
 393   bool Changed = false;
 394   for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) {
 395     if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) {
 396       assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
 397              "Invalid CGPassManager member");
 398       Changed |= ((FPPassManager*)PM)->doFinalization(CG.getModule());
 399     } else {
 400       Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doFinalization(CG);
 401     }
 402   }
 403   return Changed;
 404 }
 405
 406 //===----------------------------------------------------------------------===//
 407 // CallGraphSCC Implementation
 408 //===----------------------------------------------------------------------===//
 409
 410 /// ReplaceNode - This informs the SCC and the pass manager that the specified
 411 /// Old node has been deleted, and New is to be used in its place.
 412 void CallGraphSCC::ReplaceNode(CallGraphNode *Old, CallGraphNode *New) {
 413   assert(Old != New && "Should not replace node with self");
 414   for (unsigned i = 0; ; ++i) {
 415     assert(i != Nodes.size() && "Node not in SCC");
 416     if (Nodes[i] != Old) continue;
 417     Nodes[i] = New;
 418     break;
 419   }
 420 }
 421
 422
 423 //===----------------------------------------------------------------------===//
 424 // CallGraphSCCPass Implementation
 425 //===----------------------------------------------------------------------===//
 426
 427 /// Assign pass manager to manage this pass.
 428 void CallGraphSCCPass::assignPassManager(PMStack &PMS,
 429                                          PassManagerType PreferredType) {
 430   // Find CGPassManager
 431   while (!PMS.empty() &&
 432          PMS.top()->getPassManagerType() > PMT_CallGraphPassManager)
 433     PMS.pop();
 434
 435   assert(!PMS.empty() && "Unable to handle Call Graph Pass");
 436   CGPassManager *CGP;
 437
 438   if (PMS.top()->getPassManagerType() == PMT_CallGraphPassManager)
 439     CGP = (CGPassManager*)PMS.top();
 440   else {
 441     // Create new Call Graph SCC Pass Manager if it does not exist.
 442     assert(!PMS.empty() && "Unable to create Call Graph Pass Manager");
 443     PMDataManager *PMD = PMS.top();
 444
 445     // [1] Create new Call Graph Pass Manager
 446     CGP = new CGPassManager(PMD->getDepth() + 1);
 447
 448     // [2] Set up new manager's top level manager
 449     PMTopLevelManager *TPM = PMD->getTopLevelManager();
 450     TPM->addIndirectPassManager(CGP);
 451
 452     // [3] Assign manager to manage this new manager. This may create
 453     // and push new managers into PMS
 454     Pass *P = CGP;
 455     TPM->schedulePass(P);
 456
 457     // [4] Push new manager into PMS
 458     PMS.push(CGP);
 459   }
 460
 461   CGP->add(this);
 462 }
 463
 464 /// getAnalysisUsage - For this class, we declare that we require and preserve
 465 /// the call graph.  If the derived class implements this method, it should
 466 /// always explicitly call the implementation here.
 467 void CallGraphSCCPass::getAnalysisUsage(AnalysisUsage &AU) const {
 468   AU.addRequired<CallGraph>();
 469   AU.addPreserved<CallGraph>();
 470 }
 471
 472
 473 //===----------------------------------------------------------------------===//
 474 // PrintCallGraphPass Implementation
 475 //===----------------------------------------------------------------------===//
 476
 477 namespace {
 478   /// PrintCallGraphPass - Print a Module corresponding to a call graph.
 479   ///
 480   class PrintCallGraphPass : public CallGraphSCCPass {
 481     std::string Banner;
 482     raw_ostream &Out;       // raw_ostream to print on.
 483
 484   public:
 485     static char ID;
 486     PrintCallGraphPass() : CallGraphSCCPass(&ID), Out(dbgs()) {}
 487     PrintCallGraphPass(const std::string &B, raw_ostream &o)
 488       : CallGraphSCCPass(&ID), Banner(B), Out(o) {}
 489
 490     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 491       AU.setPreservesAll();
 492     }
 493
 494     bool runOnSCC(CallGraphSCC &SCC) {
 495       Out << Banner;
 496       for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I)
 497         (*I)->getFunction()->print(Out);
 498       return false;
 499     }
 500   };
 501
 502 } // end anonymous namespace.
 503
 504 char PrintCallGraphPass::ID = 0;
 505
 506 Pass *CallGraphSCCPass::createPrinterPass(raw_ostream &O,
 507                                           const std::string &Banner) const {
 508   return new PrintCallGraphPass(Banner, O);
 509 }
 510