[LCG] Now that the loop structure of the core SCC finding routine is
[oota-llvm.git] / 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 LazyCallGraph::LazyCallGraph(Module &M) : NextDFSNumber(0) {
79   DEBUG(dbgs() << "Building CG for module: " << M.getModuleIdentifier()
80                << "\n");
81   for (Function &F : M)
82     if (!F.isDeclaration() && !F.hasLocalLinkage())
83       if (EntryIndexMap.insert(std::make_pair(&F, EntryNodes.size())).second) {
84         DEBUG(dbgs() << "  Adding '" << F.getName()
85                      << "' to entry set of the graph.\n");
86         EntryNodes.push_back(&F);
87       }
88
89   // Now add entry nodes for functions reachable via initializers to globals.
90   SmallVector<Constant *, 16> Worklist;
91   SmallPtrSet<Constant *, 16> Visited;
92   for (GlobalVariable &GV : M.globals())
93     if (GV.hasInitializer())
94       if (Visited.insert(GV.getInitializer()))
95         Worklist.push_back(GV.getInitializer());
96
97   DEBUG(dbgs() << "  Adding functions referenced by global initializers to the "
98                   "entry set.\n");
99   findCallees(Worklist, Visited, EntryNodes, EntryIndexMap);
100
101   for (auto &Entry : EntryNodes)
102     if (Function *F = Entry.dyn_cast<Function *>())
103       SCCEntryNodes.insert(F);
104     else
105       SCCEntryNodes.insert(&Entry.get<Node *>()->getFunction());
106 }
107
108 LazyCallGraph::LazyCallGraph(LazyCallGraph &&G)
109     : BPA(std::move(G.BPA)), NodeMap(std::move(G.NodeMap)),
110       EntryNodes(std::move(G.EntryNodes)),
111       EntryIndexMap(std::move(G.EntryIndexMap)), SCCBPA(std::move(G.SCCBPA)),
112       SCCMap(std::move(G.SCCMap)), LeafSCCs(std::move(G.LeafSCCs)),
113       DFSStack(std::move(G.DFSStack)),
114       SCCEntryNodes(std::move(G.SCCEntryNodes)),
115       NextDFSNumber(G.NextDFSNumber) {
116   updateGraphPtrs();
117 }
118
119 LazyCallGraph &LazyCallGraph::operator=(LazyCallGraph &&G) {
120   BPA = std::move(G.BPA);
121   NodeMap = std::move(G.NodeMap);
122   EntryNodes = std::move(G.EntryNodes);
123   EntryIndexMap = std::move(G.EntryIndexMap);
124   SCCBPA = std::move(G.SCCBPA);
125   SCCMap = std::move(G.SCCMap);
126   LeafSCCs = std::move(G.LeafSCCs);
127   DFSStack = std::move(G.DFSStack);
128   SCCEntryNodes = std::move(G.SCCEntryNodes);
129   NextDFSNumber = G.NextDFSNumber;
130   updateGraphPtrs();
131   return *this;
132 }
133
134 void LazyCallGraph::SCC::removeEdge(LazyCallGraph &G, Function &Caller,
135                                     Function &Callee, SCC &CalleeC) {
136   assert(std::find(G.LeafSCCs.begin(), G.LeafSCCs.end(), this) ==
137              G.LeafSCCs.end() &&
138          "Cannot have a leaf SCC caller with a different SCC callee.");
139
140   bool HasOtherCallToCalleeC = false;
141   bool HasOtherCallOutsideSCC = false;
142   for (Node *N : *this) {
143     for (Node &Callee : *N) {
144       SCC &OtherCalleeC = *G.SCCMap.lookup(&Callee);
145       if (&OtherCalleeC == &CalleeC) {
146         HasOtherCallToCalleeC = true;
147         break;
148       }
149       if (&OtherCalleeC != this)
150         HasOtherCallOutsideSCC = true;
151     }
152     if (HasOtherCallToCalleeC)
153       break;
154   }
155   // Because the SCCs form a DAG, deleting such an edge cannot change the set
156   // of SCCs in the graph. However, it may cut an edge of the SCC DAG, making
157   // the caller no longer a parent of the callee. Walk the other call edges
158   // in the caller to tell.
159   if (!HasOtherCallToCalleeC) {
160     bool Removed = CalleeC.ParentSCCs.erase(this);
161     (void)Removed;
162     assert(Removed &&
163            "Did not find the caller SCC in the callee SCC's parent list!");
164
165     // It may orphan an SCC if it is the last edge reaching it, but that does
166     // not violate any invariants of the graph.
167     if (CalleeC.ParentSCCs.empty())
168       DEBUG(dbgs() << "LCG: Update removing " << Caller.getName() << " -> "
169                    << Callee.getName() << " edge orphaned the callee's SCC!\n");
170   }
171
172   // It may make the Caller SCC a leaf SCC.
173   if (!HasOtherCallOutsideSCC)
174     G.LeafSCCs.push_back(this);
175 }
176
177 SmallVector<LazyCallGraph::SCC *, 1>
178 LazyCallGraph::SCC::removeInternalEdge(LazyCallGraph &G, Node &Caller,
179                                        Node &Callee) {
180   // We return a list of the resulting SCCs, where 'this' is always the first
181   // element.
182   SmallVector<SCC *, 1> ResultSCCs;
183   ResultSCCs.push_back(this);
184
185   // We're going to do a full mini-Tarjan's walk using a local stack here.
186   int NextDFSNumber;
187   SmallVector<std::pair<Node *, Node::iterator>, 4> DFSStack;
188   SmallVector<Node *, 4> PendingSCCStack;
189
190   // The worklist is every node in the original SCC. FIXME: switch the SCC to
191   // use a SmallSetVector and swap here.
192   SmallSetVector<Node *, 1> Worklist;
193   for (Node *N : Nodes) {
194     // Clear these to 0 while we re-run Tarjan's over the SCC.
195     N->DFSNumber = 0;
196     N->LowLink = 0;
197     Worklist.insert(N);
198   }
199
200   // The callee can already reach every node in this SCC (by definition). It is
201   // the only node we know will stay inside this SCC. Everything which
202   // transitively reaches Callee will also remain in the SCC. To model this we
203   // incrementally add any chain of nodes which reaches something in the new
204   // node set to the new node set. This short circuits one side of the Tarjan's
205   // walk.
206   SmallSetVector<Node *, 1> NewNodes;
207   NewNodes.insert(&Callee);
208
209   for (;;) {
210     if (DFSStack.empty()) {
211       if (Worklist.empty())
212         break;
213       Node *N = Worklist.pop_back_val();
214       N->LowLink = N->DFSNumber = 1;
215       NextDFSNumber = 2;
216       DFSStack.push_back(std::make_pair(N, N->begin()));
217       assert(PendingSCCStack.empty() && "Cannot start a fresh DFS walk with "
218                                         "pending nodes from a prior walk.");
219     }
220
221     // We simulate recursion by popping out of all the nested loops and
222     // continuing.
223     bool Recurse = false;
224
225     do {
226     Node *N = DFSStack.back().first;
227     assert(N->DFSNumber != 0 && "We should always assign a DFS number "
228                                 "before placing a node onto the stack.");
229
230       for (auto I = DFSStack.back().second, E = N->end(); I != E; ++I) {
231         Node &ChildN = *I;
232         // If this child isn't currently in this SCC, no need to process it.
233         // However, we do need to remove this SCC from its SCC's parent set.
234         SCC &ChildSCC = *G.SCCMap.lookup(&ChildN);
235         if (&ChildSCC != this) {
236           ChildSCC.ParentSCCs.erase(this);
237           continue;
238         }
239
240         // Check if we have reached a node in the new (known connected) set. If
241         // so, the entire stack is necessarily in that set and we can re-start.
242         if (NewNodes.count(&ChildN)) {
243           while (!PendingSCCStack.empty())
244             NewNodes.insert(PendingSCCStack.pop_back_val());
245           while (!DFSStack.empty())
246             NewNodes.insert(DFSStack.pop_back_val().first);
247           Recurse = true;
248           break;
249         }
250
251         if (ChildN.DFSNumber == 0) {
252           // Mark that we should start at this child when next this node is the
253           // top of the stack. We don't start at the next child to ensure this
254           // child's lowlink is reflected.
255           DFSStack.back().second = I;
256
257           // Recurse onto this node via a tail call.
258           ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
259           Worklist.remove(&ChildN);
260           DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
261           Recurse = true;
262           break;
263         }
264
265         // Track the lowest link of the childen, if any are still in the stack.
266         // Any child not on the stack will have a LowLink of -1.
267         assert(ChildN.LowLink != 0 &&
268                "Low-link must not be zero with a non-zero DFS number.");
269         if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
270           N->LowLink = ChildN.LowLink;
271       }
272       if (Recurse)
273         break;
274
275       // No more children to process, pop it off the core DFS stack.
276       DFSStack.pop_back();
277
278       if (N->LowLink == N->DFSNumber) {
279         ResultSCCs.push_back(G.formSCC(N, PendingSCCStack));
280         break;
281       }
282
283       assert(!DFSStack.empty() && "We shouldn't have an empty stack!");
284
285       // At this point we know that N cannot ever be an SCC root. Its low-link
286       // is not its dfs-number, and we've processed all of its children. It is
287       // just sitting here waiting until some node further down the stack gets
288       // low-link == dfs-number and pops it off as well. Move it to the pending
289       // stack which is pulled into the next SCC to be formed.
290       PendingSCCStack.push_back(N);
291     } while (!DFSStack.empty());
292
293     // We reach here when we're going to "recurse".
294   }
295
296   // Replace this SCC with the NewNodes we collected above.
297   // FIXME: Simplify this when the SCC's datastructure is just a list.
298   Nodes.clear();
299
300   // Now we need to reconnect the current SCC to the graph.
301   bool IsLeafSCC = true;
302   for (Node *N : NewNodes) {
303     N->DFSNumber = -1;
304     N->LowLink = -1;
305     Nodes.push_back(N);
306     for (Node &ChildN : *N) {
307       if (NewNodes.count(&ChildN))
308         continue;
309       SCC &ChildSCC = *G.SCCMap.lookup(&ChildN);
310       ChildSCC.ParentSCCs.insert(this);
311       IsLeafSCC = false;
312     }
313   }
314 #ifndef NDEBUG
315   if (ResultSCCs.size() > 1)
316     assert(!IsLeafSCC && "This SCC cannot be a leaf as we have split out new "
317                          "SCCs by removing this edge.");
318   if (!std::any_of(G.LeafSCCs.begin(), G.LeafSCCs.end(),
319                    [&](SCC *C) { return C == this; }))
320     assert(!IsLeafSCC && "This SCC cannot be a leaf as it already had child "
321                          "SCCs before we removed this edge.");
322 #endif
323   // If this SCC stopped being a leaf through this edge removal, remove it from
324   // the leaf SCC list.
325   if (!IsLeafSCC && ResultSCCs.size() > 1)
326     G.LeafSCCs.erase(std::remove(G.LeafSCCs.begin(), G.LeafSCCs.end(), this),
327                      G.LeafSCCs.end());
328
329   // Return the new list of SCCs.
330   return ResultSCCs;
331 }
332
333 void LazyCallGraph::removeEdge(Node &CallerN, Function &Callee) {
334   auto IndexMapI = CallerN.CalleeIndexMap.find(&Callee);
335   assert(IndexMapI != CallerN.CalleeIndexMap.end() &&
336          "Callee not in the callee set for the caller?");
337
338   Node *CalleeN = CallerN.Callees[IndexMapI->second].dyn_cast<Node *>();
339   CallerN.Callees.erase(CallerN.Callees.begin() + IndexMapI->second);
340   CallerN.CalleeIndexMap.erase(IndexMapI);
341
342   SCC *CallerC = SCCMap.lookup(&CallerN);
343   if (!CallerC) {
344     // We can only remove edges when the edge isn't actively participating in
345     // a DFS walk. Either it must have been popped into an SCC, or it must not
346     // yet have been reached by the DFS walk. Assert the latter here.
347     assert(std::all_of(DFSStack.begin(), DFSStack.end(),
348                        [&](const std::pair<Node *, iterator> &StackEntry) {
349              return StackEntry.first != &CallerN;
350            }) &&
351            "Found the caller on the DFSStack!");
352     return;
353   }
354
355   assert(CalleeN && "If the caller is in an SCC, we have to have explored all "
356                     "its transitively called functions.");
357
358   SCC *CalleeC = SCCMap.lookup(CalleeN);
359   assert(CalleeC &&
360          "The caller has an SCC, and thus by necessity so does the callee.");
361
362   // The easy case is when they are different SCCs.
363   if (CallerC != CalleeC) {
364     CallerC->removeEdge(*this, CallerN.getFunction(), Callee, *CalleeC);
365     return;
366   }
367
368   // The hard case is when we remove an edge within a SCC. This may cause new
369   // SCCs to need to be added to the graph.
370   CallerC->removeInternalEdge(*this, CallerN, *CalleeN);
371 }
372
373 LazyCallGraph::Node &LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
374   return *new (MappedN = BPA.Allocate()) Node(*this, F);
375 }
376
377 void LazyCallGraph::updateGraphPtrs() {
378   // Process all nodes updating the graph pointers.
379   SmallVector<Node *, 16> Worklist;
380   for (auto &Entry : EntryNodes)
381     if (Node *EntryN = Entry.dyn_cast<Node *>())
382       Worklist.push_back(EntryN);
383
384   while (!Worklist.empty()) {
385     Node *N = Worklist.pop_back_val();
386     N->G = this;
387     for (auto &Callee : N->Callees)
388       if (Node *CalleeN = Callee.dyn_cast<Node *>())
389         Worklist.push_back(CalleeN);
390   }
391 }
392
393 LazyCallGraph::SCC *LazyCallGraph::formSCC(Node *RootN,
394                                            SmallVectorImpl<Node *> &NodeStack) {
395   // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
396   // into it.
397   SCC *NewSCC = new (SCCBPA.Allocate()) SCC();
398
399   SCCMap[RootN] = NewSCC;
400   NewSCC->Nodes.push_back(RootN);
401
402   while (!NodeStack.empty() && NodeStack.back()->DFSNumber > RootN->DFSNumber) {
403     Node *SCCN = NodeStack.pop_back_val();
404     assert(SCCN->LowLink >= RootN->LowLink &&
405            "We cannot have a low link in an SCC lower than its root on the "
406            "stack!");
407     SCCN->DFSNumber = SCCN->LowLink = -1;
408
409     SCCMap[SCCN] = NewSCC;
410     NewSCC->Nodes.push_back(SCCN);
411   }
412   RootN->DFSNumber = RootN->LowLink = -1;
413
414   // A final pass over all edges in the SCC (this remains linear as we only
415   // do this once when we build the SCC) to connect it to the parent sets of
416   // its children.
417   bool IsLeafSCC = true;
418   for (Node *SCCN : NewSCC->Nodes)
419     for (Node &SCCChildN : *SCCN) {
420       if (SCCMap.lookup(&SCCChildN) == NewSCC)
421         continue;
422       SCC &ChildSCC = *SCCMap.lookup(&SCCChildN);
423       ChildSCC.ParentSCCs.insert(NewSCC);
424       IsLeafSCC = false;
425     }
426
427   // For the SCCs where we fine no child SCCs, add them to the leaf list.
428   if (IsLeafSCC)
429     LeafSCCs.push_back(NewSCC);
430
431   return NewSCC;
432 }
433
434 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
435   // When the stack is empty, there are no more SCCs to walk in this graph.
436   if (DFSStack.empty()) {
437     // If we've handled all candidate entry nodes to the SCC forest, we're done.
438     if (SCCEntryNodes.empty())
439       return nullptr;
440
441     Node &N = get(*SCCEntryNodes.pop_back_val());
442     N.LowLink = N.DFSNumber = 1;
443     NextDFSNumber = 2;
444     DFSStack.push_back(std::make_pair(&N, N.begin()));
445   }
446
447   for (;;) {
448     Node *N = DFSStack.back().first;
449     assert(N->DFSNumber != 0 && "We should always assign a DFS number "
450                                 "before placing a node onto the stack.");
451
452     bool Recurse = false; // Used to simulate recursing onto a child.
453     for (auto I = DFSStack.back().second, E = N->end(); I != E; ++I) {
454       Node &ChildN = *I;
455       if (ChildN.DFSNumber == 0) {
456         // Mark that we should start at this child when next this node is the
457         // top of the stack. We don't start at the next child to ensure this
458         // child's lowlink is reflected.
459         DFSStack.back().second = I;
460
461         // Recurse onto this node via a tail call.
462         assert(!SCCMap.count(&ChildN) &&
463                "Found a node with 0 DFS number but already in an SCC!");
464         ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
465         SCCEntryNodes.remove(&ChildN.getFunction());
466         DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
467         Recurse = true;
468         break;
469       }
470
471       // Track the lowest link of the childen, if any are still in the stack.
472       assert(ChildN.LowLink != 0 &&
473              "Low-link must not be zero with a non-zero DFS number.");
474       if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
475         N->LowLink = ChildN.LowLink;
476     }
477     if (Recurse)
478       // Continue the outer loop when we exit the inner loop in order to
479       // recurse onto a child.
480       continue;
481
482     // No more children to process here, pop the node off the stack.
483     DFSStack.pop_back();
484
485     if (N->LowLink == N->DFSNumber)
486       // Form the new SCC out of the top of the DFS stack.
487       return formSCC(N, PendingSCCStack);
488
489     assert(!DFSStack.empty() && "We never found a viable root!");
490
491     // At this point we know that N cannot ever be an SCC root. Its low-link
492     // is not its dfs-number, and we've processed all of its children. It is
493     // just sitting here waiting until some node further down the stack gets
494     // low-link == dfs-number and pops it off as well. Move it to the pending
495     // stack which is pulled into the next SCC to be formed.
496     PendingSCCStack.push_back(N);
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 }