lib/Analysis/LazyCallGraph.cpp

   1 //===- LazyCallGraph.cpp - Analysis of a Module's 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 #include "llvm/Analysis/LazyCallGraph.h"
  11 #include "llvm/ADT/STLExtras.h"
  12 #include "llvm/IR/CallSite.h"
  13 #include "llvm/IR/InstVisitor.h"
  14 #include "llvm/IR/Instructions.h"
  15 #include "llvm/IR/PassManager.h"
  16 #include "llvm/Support/Debug.h"
  17 #include "llvm/Support/raw_ostream.h"
  18
  19 using namespace llvm;
  20
  21 #define DEBUG_TYPE "lcg"
  22
  23 static void findCallees(
  24     SmallVectorImpl<Constant *> &Worklist, SmallPtrSetImpl<Constant *> &Visited,
  25     SmallVectorImpl<PointerUnion<Function *, LazyCallGraph::Node *>> &Callees,
  26     DenseMap<Function *, size_t> &CalleeIndexMap) {
  27   while (!Worklist.empty()) {
  28     Constant *C = Worklist.pop_back_val();
  29
  30     if (Function *F = dyn_cast<Function>(C)) {
  31       // Note that we consider *any* function with a definition to be a viable
  32       // edge. Even if the function's definition is subject to replacement by
  33       // some other module (say, a weak definition) there may still be
  34       // optimizations which essentially speculate based on the definition and
  35       // a way to check that the specific definition is in fact the one being
  36       // used. For example, this could be done by moving the weak definition to
  37       // a strong (internal) definition and making the weak definition be an
  38       // alias. Then a test of the address of the weak function against the new
  39       // strong definition's address would be an effective way to determine the
  40       // safety of optimizing a direct call edge.
  41       if (!F->isDeclaration() &&
  42           CalleeIndexMap.insert(std::make_pair(F, Callees.size())).second) {
  43         DEBUG(dbgs() << "    Added callable function: " << F->getName()
  44                      << "\n");
  45         Callees.push_back(F);
  46       }
  47       continue;
  48     }
  49
  50     for (Value *Op : C->operand_values())
  51       if (Visited.insert(cast<Constant>(Op)))
  52         Worklist.push_back(cast<Constant>(Op));
  53   }
  54 }
  55
  56 LazyCallGraph::Node::Node(LazyCallGraph &G, Function &F)
  57     : G(&G), F(F), DFSNumber(0), LowLink(0) {
  58   DEBUG(dbgs() << "  Adding functions called by '" << F.getName()
  59                << "' to the graph.\n");
  60
  61   SmallVector<Constant *, 16> Worklist;
  62   SmallPtrSet<Constant *, 16> Visited;
  63   // Find all the potential callees in this function. First walk the
  64   // instructions and add every operand which is a constant to the worklist.
  65   for (BasicBlock &BB : F)
  66     for (Instruction &I : BB)
  67       for (Value *Op : I.operand_values())
  68         if (Constant *C = dyn_cast<Constant>(Op))
  69           if (Visited.insert(C))
  70             Worklist.push_back(C);
  71
  72   // We've collected all the constant (and thus potentially function or
  73   // function containing) operands to all of the instructions in the function.
  74   // Process them (recursively) collecting every function found.
  75   findCallees(Worklist, Visited, Callees, CalleeIndexMap);
  76 }
  77
  78 void LazyCallGraph::Node::removeEdgeInternal(Function &Callee) {
  79   auto IndexMapI = CalleeIndexMap.find(&Callee);
  80   assert(IndexMapI != CalleeIndexMap.end() &&
  81          "Callee not in the callee set for this caller?");
  82
  83   Callees.erase(Callees.begin() + IndexMapI->second);
  84   CalleeIndexMap.erase(IndexMapI);
  85 }
  86
  87 LazyCallGraph::LazyCallGraph(Module &M) : NextDFSNumber(0) {
  88   DEBUG(dbgs() << "Building CG for module: " << M.getModuleIdentifier()
  89                << "\n");
  90   for (Function &F : M)
  91     if (!F.isDeclaration() && !F.hasLocalLinkage())
  92       if (EntryIndexMap.insert(std::make_pair(&F, EntryNodes.size())).second) {
  93         DEBUG(dbgs() << "  Adding '" << F.getName()
  94                      << "' to entry set of the graph.\n");
  95         EntryNodes.push_back(&F);
  96       }
  97
  98   // Now add entry nodes for functions reachable via initializers to globals.
  99   SmallVector<Constant *, 16> Worklist;
 100   SmallPtrSet<Constant *, 16> Visited;
 101   for (GlobalVariable &GV : M.globals())
 102     if (GV.hasInitializer())
 103       if (Visited.insert(GV.getInitializer()))
 104         Worklist.push_back(GV.getInitializer());
 105
 106   DEBUG(dbgs() << "  Adding functions referenced by global initializers to the "
 107                   "entry set.\n");
 108   findCallees(Worklist, Visited, EntryNodes, EntryIndexMap);
 109
 110   for (auto &Entry : EntryNodes)
 111     if (Function *F = Entry.dyn_cast<Function *>())
 112       SCCEntryNodes.push_back(F);
 113     else
 114       SCCEntryNodes.push_back(&Entry.get<Node *>()->getFunction());
 115 }
 116
 117 LazyCallGraph::LazyCallGraph(LazyCallGraph &&G)
 118     : BPA(std::move(G.BPA)), NodeMap(std::move(G.NodeMap)),
 119       EntryNodes(std::move(G.EntryNodes)),
 120       EntryIndexMap(std::move(G.EntryIndexMap)), SCCBPA(std::move(G.SCCBPA)),
 121       SCCMap(std::move(G.SCCMap)), LeafSCCs(std::move(G.LeafSCCs)),
 122       DFSStack(std::move(G.DFSStack)),
 123       SCCEntryNodes(std::move(G.SCCEntryNodes)),
 124       NextDFSNumber(G.NextDFSNumber) {
 125   updateGraphPtrs();
 126 }
 127
 128 LazyCallGraph &LazyCallGraph::operator=(LazyCallGraph &&G) {
 129   BPA = std::move(G.BPA);
 130   NodeMap = std::move(G.NodeMap);
 131   EntryNodes = std::move(G.EntryNodes);
 132   EntryIndexMap = std::move(G.EntryIndexMap);
 133   SCCBPA = std::move(G.SCCBPA);
 134   SCCMap = std::move(G.SCCMap);
 135   LeafSCCs = std::move(G.LeafSCCs);
 136   DFSStack = std::move(G.DFSStack);
 137   SCCEntryNodes = std::move(G.SCCEntryNodes);
 138   NextDFSNumber = G.NextDFSNumber;
 139   updateGraphPtrs();
 140   return *this;
 141 }
 142
 143 void LazyCallGraph::SCC::insert(Node &N) {
 144   N.DFSNumber = N.LowLink = -1;
 145   Nodes.push_back(&N);
 146   G->SCCMap[&N] = this;
 147 }
 148
 149 void LazyCallGraph::SCC::removeInterSCCEdge(Node &CallerN, Node &CalleeN) {
 150   // First remove it from the node.
 151   CallerN.removeEdgeInternal(CalleeN.getFunction());
 152
 153   assert(G->SCCMap.lookup(&CallerN) == this &&
 154          "The caller must be a member of this SCC.");
 155
 156   SCC &CalleeC = *G->SCCMap.lookup(&CalleeN);
 157   assert(&CalleeC != this &&
 158          "This API only supports the rmoval of inter-SCC edges.");
 159
 160   assert(std::find(G->LeafSCCs.begin(), G->LeafSCCs.end(), this) ==
 161              G->LeafSCCs.end() &&
 162          "Cannot have a leaf SCC caller with a different SCC callee.");
 163
 164   bool HasOtherCallToCalleeC = false;
 165   bool HasOtherCallOutsideSCC = false;
 166   for (Node *N : *this) {
 167     for (Node &OtherCalleeN : *N) {
 168       SCC &OtherCalleeC = *G->SCCMap.lookup(&OtherCalleeN);
 169       if (&OtherCalleeC == &CalleeC) {
 170         HasOtherCallToCalleeC = true;
 171         break;
 172       }
 173       if (&OtherCalleeC != this)
 174         HasOtherCallOutsideSCC = true;
 175     }
 176     if (HasOtherCallToCalleeC)
 177       break;
 178   }
 179   // Because the SCCs form a DAG, deleting such an edge cannot change the set
 180   // of SCCs in the graph. However, it may cut an edge of the SCC DAG, making
 181   // the caller no longer a parent of the callee. Walk the other call edges
 182   // in the caller to tell.
 183   if (!HasOtherCallToCalleeC) {
 184     bool Removed = CalleeC.ParentSCCs.erase(this);
 185     (void)Removed;
 186     assert(Removed &&
 187            "Did not find the caller SCC in the callee SCC's parent list!");
 188
 189     // It may orphan an SCC if it is the last edge reaching it, but that does
 190     // not violate any invariants of the graph.
 191     if (CalleeC.ParentSCCs.empty())
 192       DEBUG(dbgs() << "LCG: Update removing " << CallerN.getFunction().getName()
 193                    << " -> " << CalleeN.getFunction().getName()
 194                    << " edge orphaned the callee's SCC!\n");
 195   }
 196
 197   // It may make the Caller SCC a leaf SCC.
 198   if (!HasOtherCallOutsideSCC)
 199     G->LeafSCCs.push_back(this);
 200 }
 201
 202 void LazyCallGraph::SCC::internalDFS(
 203     SmallVectorImpl<std::pair<Node *, Node::iterator>> &DFSStack,
 204     SmallVectorImpl<Node *> &PendingSCCStack, Node *N,
 205     SmallVectorImpl<SCC *> &ResultSCCs) {
 206   Node::iterator I = N->begin();
 207   N->LowLink = N->DFSNumber = 1;
 208   int NextDFSNumber = 2;
 209   for (;;) {
 210     assert(N->DFSNumber != 0 && "We should always assign a DFS number "
 211                                 "before processing a node.");
 212
 213     // We simulate recursion by popping out of the nested loop and continuing.
 214     Node::iterator E = N->end();
 215     while (I != E) {
 216       Node &ChildN = *I;
 217       if (SCC *ChildSCC = G->SCCMap.lookup(&ChildN)) {
 218         // Check if we have reached a node in the new (known connected) set of
 219         // this SCC. If so, the entire stack is necessarily in that set and we
 220         // can re-start.
 221         if (ChildSCC == this) {
 222           insert(*N);
 223           while (!PendingSCCStack.empty())
 224             insert(*PendingSCCStack.pop_back_val());
 225           while (!DFSStack.empty())
 226             insert(*DFSStack.pop_back_val().first);
 227           return;
 228         }
 229
 230         // If this child isn't currently in this SCC, no need to process it.
 231         // However, we do need to remove this SCC from its SCC's parent set.
 232         ChildSCC->ParentSCCs.erase(this);
 233         ++I;
 234         continue;
 235       }
 236
 237       if (ChildN.DFSNumber == 0) {
 238         // Mark that we should start at this child when next this node is the
 239         // top of the stack. We don't start at the next child to ensure this
 240         // child's lowlink is reflected.
 241         DFSStack.push_back(std::make_pair(N, I));
 242
 243         // Continue, resetting to the child node.
 244         ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
 245         N = &ChildN;
 246         I = ChildN.begin();
 247         E = ChildN.end();
 248         continue;
 249       }
 250
 251       // Track the lowest link of the childen, if any are still in the stack.
 252       // Any child not on the stack will have a LowLink of -1.
 253       assert(ChildN.LowLink != 0 &&
 254              "Low-link must not be zero with a non-zero DFS number.");
 255       if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
 256         N->LowLink = ChildN.LowLink;
 257       ++I;
 258     }
 259
 260     if (N->LowLink == N->DFSNumber) {
 261       ResultSCCs.push_back(G->formSCC(N, PendingSCCStack));
 262       if (DFSStack.empty())
 263         return;
 264     } else {
 265       // At this point we know that N cannot ever be an SCC root. Its low-link
 266       // is not its dfs-number, and we've processed all of its children. It is
 267       // just sitting here waiting until some node further down the stack gets
 268       // low-link == dfs-number and pops it off as well. Move it to the pending
 269       // stack which is pulled into the next SCC to be formed.
 270       PendingSCCStack.push_back(N);
 271
 272       assert(!DFSStack.empty() && "We shouldn't have an empty stack!");
 273     }
 274
 275     N = DFSStack.back().first;
 276     I = DFSStack.back().second;
 277     DFSStack.pop_back();
 278   }
 279 }
 280
 281 SmallVector<LazyCallGraph::SCC *, 1>
 282 LazyCallGraph::SCC::removeIntraSCCEdge(Node &CallerN,
 283                                        Node &CalleeN) {
 284   // First remove it from the node.
 285   CallerN.removeEdgeInternal(CalleeN.getFunction());
 286
 287   // We return a list of the resulting *new* SCCs in postorder.
 288   SmallVector<SCC *, 1> ResultSCCs;
 289
 290   // Direct recursion doesn't impact the SCC graph at all.
 291   if (&CallerN == &CalleeN)
 292     return ResultSCCs;
 293
 294   // The worklist is every node in the original SCC.
 295   SmallVector<Node *, 1> Worklist;
 296   Worklist.swap(Nodes);
 297   for (Node *N : Worklist) {
 298     // The nodes formerly in this SCC are no longer in any SCC.
 299     N->DFSNumber = 0;
 300     N->LowLink = 0;
 301     G->SCCMap.erase(N);
 302   }
 303   assert(Worklist.size() > 1 && "We have to have at least two nodes to have an "
 304                                 "edge between them that is within the SCC.");
 305
 306   // The callee can already reach every node in this SCC (by definition). It is
 307   // the only node we know will stay inside this SCC. Everything which
 308   // transitively reaches Callee will also remain in the SCC. To model this we
 309   // incrementally add any chain of nodes which reaches something in the new
 310   // node set to the new node set. This short circuits one side of the Tarjan's
 311   // walk.
 312   insert(CalleeN);
 313
 314   // We're going to do a full mini-Tarjan's walk using a local stack here.
 315   SmallVector<std::pair<Node *, Node::iterator>, 4> DFSStack;
 316   SmallVector<Node *, 4> PendingSCCStack;
 317   do {
 318     Node *N = Worklist.pop_back_val();
 319     if (N->DFSNumber == 0)
 320       internalDFS(DFSStack, PendingSCCStack, N, ResultSCCs);
 321
 322     assert(DFSStack.empty() && "Didn't flush the entire DFS stack!");
 323     assert(PendingSCCStack.empty() && "Didn't flush all pending SCC nodes!");
 324   } while (!Worklist.empty());
 325
 326   // Now we need to reconnect the current SCC to the graph.
 327   bool IsLeafSCC = true;
 328   for (Node *N : Nodes) {
 329     for (Node &ChildN : *N) {
 330       SCC &ChildSCC = *G->SCCMap.lookup(&ChildN);
 331       if (&ChildSCC == this)
 332         continue;
 333       ChildSCC.ParentSCCs.insert(this);
 334       IsLeafSCC = false;
 335     }
 336   }
 337 #ifndef NDEBUG
 338   if (!ResultSCCs.empty())
 339     assert(!IsLeafSCC && "This SCC cannot be a leaf as we have split out new "
 340                          "SCCs by removing this edge.");
 341   if (!std::any_of(G->LeafSCCs.begin(), G->LeafSCCs.end(),
 342                    [&](SCC *C) { return C == this; }))
 343     assert(!IsLeafSCC && "This SCC cannot be a leaf as it already had child "
 344                          "SCCs before we removed this edge.");
 345 #endif
 346   // If this SCC stopped being a leaf through this edge removal, remove it from
 347   // the leaf SCC list.
 348   if (!IsLeafSCC && !ResultSCCs.empty())
 349     G->LeafSCCs.erase(std::remove(G->LeafSCCs.begin(), G->LeafSCCs.end(), this),
 350                      G->LeafSCCs.end());
 351
 352   // Return the new list of SCCs.
 353   return ResultSCCs;
 354 }
 355
 356 void LazyCallGraph::removeEdge(Node &CallerN, Function &Callee) {
 357   assert(SCCMap.empty() && DFSStack.empty() &&
 358          "This method cannot be called after SCCs have been formed!");
 359
 360   return CallerN.removeEdgeInternal(Callee);
 361 }
 362
 363 LazyCallGraph::Node &LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
 364   return *new (MappedN = BPA.Allocate()) Node(*this, F);
 365 }
 366
 367 void LazyCallGraph::updateGraphPtrs() {
 368   // Process all nodes updating the graph pointers.
 369   {
 370     SmallVector<Node *, 16> Worklist;
 371     for (auto &Entry : EntryNodes)
 372       if (Node *EntryN = Entry.dyn_cast<Node *>())
 373         Worklist.push_back(EntryN);
 374
 375     while (!Worklist.empty()) {
 376       Node *N = Worklist.pop_back_val();
 377       N->G = this;
 378       for (auto &Callee : N->Callees)
 379         if (Node *CalleeN = Callee.dyn_cast<Node *>())
 380           Worklist.push_back(CalleeN);
 381     }
 382   }
 383
 384   // Process all SCCs updating the graph pointers.
 385   {
 386     SmallVector<SCC *, 16> Worklist(LeafSCCs.begin(), LeafSCCs.end());
 387
 388     while (!Worklist.empty()) {
 389       SCC *C = Worklist.pop_back_val();
 390       C->G = this;
 391       Worklist.insert(Worklist.end(), C->ParentSCCs.begin(),
 392                       C->ParentSCCs.end());
 393     }
 394   }
 395 }
 396
 397 LazyCallGraph::SCC *LazyCallGraph::formSCC(Node *RootN,
 398                                            SmallVectorImpl<Node *> &NodeStack) {
 399   // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
 400   // into it.
 401   SCC *NewSCC = new (SCCBPA.Allocate()) SCC(*this);
 402
 403   while (!NodeStack.empty() && NodeStack.back()->DFSNumber > RootN->DFSNumber) {
 404     assert(NodeStack.back()->LowLink >= RootN->LowLink &&
 405            "We cannot have a low link in an SCC lower than its root on the "
 406            "stack!");
 407     NewSCC->insert(*NodeStack.pop_back_val());
 408   }
 409   NewSCC->insert(*RootN);
 410
 411   // A final pass over all edges in the SCC (this remains linear as we only
 412   // do this once when we build the SCC) to connect it to the parent sets of
 413   // its children.
 414   bool IsLeafSCC = true;
 415   for (Node *SCCN : NewSCC->Nodes)
 416     for (Node &SCCChildN : *SCCN) {
 417       if (SCCMap.lookup(&SCCChildN) == NewSCC)
 418         continue;
 419       SCC &ChildSCC = *SCCMap.lookup(&SCCChildN);
 420       ChildSCC.ParentSCCs.insert(NewSCC);
 421       IsLeafSCC = false;
 422     }
 423
 424   // For the SCCs where we fine no child SCCs, add them to the leaf list.
 425   if (IsLeafSCC)
 426     LeafSCCs.push_back(NewSCC);
 427
 428   return NewSCC;
 429 }
 430
 431 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
 432   Node *N;
 433   Node::iterator I;
 434   if (!DFSStack.empty()) {
 435     N = DFSStack.back().first;
 436     I = DFSStack.back().second;
 437     DFSStack.pop_back();
 438   } else {
 439     // If we've handled all candidate entry nodes to the SCC forest, we're done.
 440     do {
 441       if (SCCEntryNodes.empty())
 442         return nullptr;
 443
 444       N = &get(*SCCEntryNodes.pop_back_val());
 445     } while (N->DFSNumber != 0);
 446     I = N->begin();
 447     N->LowLink = N->DFSNumber = 1;
 448     NextDFSNumber = 2;
 449   }
 450
 451   for (;;) {
 452     assert(N->DFSNumber != 0 && "We should always assign a DFS number "
 453                                 "before placing a node onto the stack.");
 454
 455     Node::iterator E = N->end();
 456     while (I != E) {
 457       Node &ChildN = *I;
 458       if (ChildN.DFSNumber == 0) {
 459         // Mark that we should start at this child when next this node is the
 460         // top of the stack. We don't start at the next child to ensure this
 461         // child's lowlink is reflected.
 462         DFSStack.push_back(std::make_pair(N, N->begin()));
 463
 464         // Recurse onto this node via a tail call.
 465         assert(!SCCMap.count(&ChildN) &&
 466                "Found a node with 0 DFS number but already in an SCC!");
 467         ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
 468         N = &ChildN;
 469         I = ChildN.begin();
 470         E = ChildN.end();
 471         continue;
 472       }
 473
 474       // Track the lowest link of the childen, if any are still in the stack.
 475       assert(ChildN.LowLink != 0 &&
 476              "Low-link must not be zero with a non-zero DFS number.");
 477       if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
 478         N->LowLink = ChildN.LowLink;
 479       ++I;
 480     }
 481
 482     if (N->LowLink == N->DFSNumber)
 483       // Form the new SCC out of the top of the DFS stack.
 484       return formSCC(N, PendingSCCStack);
 485
 486     // At this point we know that N cannot ever be an SCC root. Its low-link
 487     // is not its dfs-number, and we've processed all of its children. It is
 488     // just sitting here waiting until some node further down the stack gets
 489     // low-link == dfs-number and pops it off as well. Move it to the pending
 490     // stack which is pulled into the next SCC to be formed.
 491     PendingSCCStack.push_back(N);
 492
 493     assert(!DFSStack.empty() && "We never found a viable root!");
 494     N = DFSStack.back().first;
 495     I = DFSStack.back().second;
 496     DFSStack.pop_back();
 497   }
 498 }
 499
 500 char LazyCallGraphAnalysis::PassID;
 501
 502 LazyCallGraphPrinterPass::LazyCallGraphPrinterPass(raw_ostream &OS) : OS(OS) {}
 503
 504 static void printNodes(raw_ostream &OS, LazyCallGraph::Node &N,
 505                        SmallPtrSetImpl<LazyCallGraph::Node *> &Printed) {
 506   // Recurse depth first through the nodes.
 507   for (LazyCallGraph::Node &ChildN : N)
 508     if (Printed.insert(&ChildN))
 509       printNodes(OS, ChildN, Printed);
 510
 511   OS << "  Call edges in function: " << N.getFunction().getName() << "\n";
 512   for (LazyCallGraph::iterator I = N.begin(), E = N.end(); I != E; ++I)
 513     OS << "    -> " << I->getFunction().getName() << "\n";
 514
 515   OS << "\n";
 516 }
 517
 518 static void printSCC(raw_ostream &OS, LazyCallGraph::SCC &SCC) {
 519   ptrdiff_t SCCSize = std::distance(SCC.begin(), SCC.end());
 520   OS << "  SCC with " << SCCSize << " functions:\n";
 521
 522   for (LazyCallGraph::Node *N : SCC)
 523     OS << "    " << N->getFunction().getName() << "\n";
 524
 525   OS << "\n";
 526 }
 527
 528 PreservedAnalyses LazyCallGraphPrinterPass::run(Module *M,
 529                                                 ModuleAnalysisManager *AM) {
 530   LazyCallGraph &G = AM->getResult<LazyCallGraphAnalysis>(M);
 531
 532   OS << "Printing the call graph for module: " << M->getModuleIdentifier()
 533      << "\n\n";
 534
 535   SmallPtrSet<LazyCallGraph::Node *, 16> Printed;
 536   for (LazyCallGraph::Node &N : G)
 537     if (Printed.insert(&N))
 538       printNodes(OS, N, Printed);
 539
 540   for (LazyCallGraph::SCC &SCC : G.postorder_sccs())
 541     printSCC(OS, SCC);
 542
 543   return PreservedAnalyses::all();
 544
 545 }