1 //===- LazyCallGraph.cpp - Analysis of a Module's call graph --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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"
21 #define DEBUG_TYPE "lcg"
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();
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()
50 for (Value *Op : C->operand_values())
51 if (Visited.insert(cast<Constant>(Op)))
52 Worklist.push_back(cast<Constant>(Op));
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");
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);
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);
78 LazyCallGraph::LazyCallGraph(Module &M) : NextDFSNumber(0) {
79 DEBUG(dbgs() << "Building CG for module: " << M.getModuleIdentifier()
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);
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());
97 DEBUG(dbgs() << " Adding functions referenced by global initializers to the "
99 findCallees(Worklist, Visited, EntryNodes, EntryIndexMap);
101 for (auto &Entry : EntryNodes)
102 if (Function *F = Entry.dyn_cast<Function *>())
103 SCCEntryNodes.insert(F);
105 SCCEntryNodes.insert(&Entry.get<Node *>()->getFunction());
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) {
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;
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) ==
138 "Cannot have a leaf SCC caller with a different SCC callee.");
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;
149 if (&OtherCalleeC != this)
150 HasOtherCallOutsideSCC = true;
152 if (HasOtherCallToCalleeC)
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);
163 "Did not find the caller SCC in the callee SCC's parent list!");
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");
172 // It may make the Caller SCC a leaf SCC.
173 if (!HasOtherCallOutsideSCC)
174 G.LeafSCCs.push_back(this);
177 SmallVector<LazyCallGraph::SCC *, 1>
178 LazyCallGraph::SCC::removeInternalEdge(LazyCallGraph &G, Node &Caller,
180 // We return a list of the resulting SCCs, where 'this' is always the first
182 SmallVector<SCC *, 1> ResultSCCs;
183 ResultSCCs.push_back(this);
185 // We're going to do a full mini-Tarjan's walk using a local stack here.
187 SmallVector<std::pair<Node *, Node::iterator>, 4> DFSStack;
188 SmallVector<Node *, 4> PendingSCCStack;
190 // The worklist is every node in the original SCC.
191 SmallVector<Node *, 1> Worklist;
192 Worklist.swap(Nodes);
193 for (Node *N : Worklist) {
194 // The nodes formerly in this SCC are no longer in any SCC.
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
206 Nodes.push_back(&Callee);
207 G.SCCMap.insert(std::make_pair(&Callee, this));
208 Callee.DFSNumber = Callee.LowLink = -1;
211 if (DFSStack.empty()) {
212 // Clear off any nodes which have already been visited in the DFS.
213 while (!Worklist.empty() && Worklist.back()->DFSNumber != 0)
215 if (Worklist.empty())
217 Node *N = Worklist.pop_back_val();
218 N->LowLink = N->DFSNumber = 1;
220 DFSStack.push_back(std::make_pair(N, N->begin()));
221 assert(PendingSCCStack.empty() && "Cannot start a fresh DFS walk with "
222 "pending nodes from a prior walk.");
225 Node *N = DFSStack.back().first;
226 assert(N->DFSNumber != 0 && "We should always assign a DFS number "
227 "before placing a node onto the stack.");
229 // We simulate recursion by popping out of the nested loop and continuing.
230 bool Recurse = false;
231 for (auto I = DFSStack.back().second, E = N->end(); I != E; ++I) {
233 if (SCC *ChildSCC = G.SCCMap.lookup(&ChildN)) {
234 // Check if we have reached a node in the new (known connected) set of
235 // this SCC. If so, the entire stack is necessarily in that set and we
237 if (ChildSCC == this) {
238 while (!PendingSCCStack.empty()) {
239 Nodes.push_back(PendingSCCStack.pop_back_val());
240 G.SCCMap.insert(std::make_pair(Nodes.back(), this));
241 Nodes.back()->DFSNumber = Nodes.back()->LowLink = -1;
243 while (!DFSStack.empty()) {
244 Nodes.push_back(DFSStack.pop_back_val().first);
245 G.SCCMap.insert(std::make_pair(Nodes.back(), this));
246 Nodes.back()->DFSNumber = Nodes.back()->LowLink = -1;
252 // If this child isn't currently in this SCC, no need to process it.
253 // However, we do need to remove this SCC from its SCC's parent set.
254 ChildSCC->ParentSCCs.erase(this);
258 if (ChildN.DFSNumber == 0) {
259 // Mark that we should start at this child when next this node is the
260 // top of the stack. We don't start at the next child to ensure this
261 // child's lowlink is reflected.
262 DFSStack.back().second = I;
264 // Recurse onto this node via a tail call.
265 ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
266 DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
271 // Track the lowest link of the childen, if any are still in the stack.
272 // Any child not on the stack will have a LowLink of -1.
273 assert(ChildN.LowLink != 0 &&
274 "Low-link must not be zero with a non-zero DFS number.");
275 if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
276 N->LowLink = ChildN.LowLink;
281 // No more children to process, pop it off the core DFS stack.
284 if (N->LowLink == N->DFSNumber) {
285 ResultSCCs.push_back(G.formSCC(N, PendingSCCStack));
289 assert(!DFSStack.empty() && "We shouldn't have an empty stack!");
291 // At this point we know that N cannot ever be an SCC root. Its low-link
292 // is not its dfs-number, and we've processed all of its children. It is
293 // just sitting here waiting until some node further down the stack gets
294 // low-link == dfs-number and pops it off as well. Move it to the pending
295 // stack which is pulled into the next SCC to be formed.
296 PendingSCCStack.push_back(N);
299 // Now we need to reconnect the current SCC to the graph.
300 bool IsLeafSCC = true;
301 for (Node *N : Nodes) {
302 for (Node &ChildN : *N) {
303 SCC &ChildSCC = *G.SCCMap.lookup(&ChildN);
304 if (&ChildSCC == this)
306 ChildSCC.ParentSCCs.insert(this);
311 if (ResultSCCs.size() > 1)
312 assert(!IsLeafSCC && "This SCC cannot be a leaf as we have split out new "
313 "SCCs by removing this edge.");
314 if (!std::any_of(G.LeafSCCs.begin(), G.LeafSCCs.end(),
315 [&](SCC *C) { return C == this; }))
316 assert(!IsLeafSCC && "This SCC cannot be a leaf as it already had child "
317 "SCCs before we removed this edge.");
319 // If this SCC stopped being a leaf through this edge removal, remove it from
320 // the leaf SCC list.
321 if (!IsLeafSCC && ResultSCCs.size() > 1)
322 G.LeafSCCs.erase(std::remove(G.LeafSCCs.begin(), G.LeafSCCs.end(), this),
325 // Return the new list of SCCs.
329 void LazyCallGraph::removeEdge(Node &CallerN, Function &Callee) {
330 auto IndexMapI = CallerN.CalleeIndexMap.find(&Callee);
331 assert(IndexMapI != CallerN.CalleeIndexMap.end() &&
332 "Callee not in the callee set for the caller?");
334 Node *CalleeN = CallerN.Callees[IndexMapI->second].dyn_cast<Node *>();
335 CallerN.Callees.erase(CallerN.Callees.begin() + IndexMapI->second);
336 CallerN.CalleeIndexMap.erase(IndexMapI);
338 SCC *CallerC = SCCMap.lookup(&CallerN);
340 // We can only remove edges when the edge isn't actively participating in
341 // a DFS walk. Either it must have been popped into an SCC, or it must not
342 // yet have been reached by the DFS walk. Assert the latter here.
343 assert(std::all_of(DFSStack.begin(), DFSStack.end(),
344 [&](const std::pair<Node *, iterator> &StackEntry) {
345 return StackEntry.first != &CallerN;
347 "Found the caller on the DFSStack!");
351 assert(CalleeN && "If the caller is in an SCC, we have to have explored all "
352 "its transitively called functions.");
354 SCC *CalleeC = SCCMap.lookup(CalleeN);
356 "The caller has an SCC, and thus by necessity so does the callee.");
358 // The easy case is when they are different SCCs.
359 if (CallerC != CalleeC) {
360 CallerC->removeEdge(*this, CallerN.getFunction(), Callee, *CalleeC);
364 // The hard case is when we remove an edge within a SCC. This may cause new
365 // SCCs to need to be added to the graph.
366 CallerC->removeInternalEdge(*this, CallerN, *CalleeN);
369 LazyCallGraph::Node &LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
370 return *new (MappedN = BPA.Allocate()) Node(*this, F);
373 void LazyCallGraph::updateGraphPtrs() {
374 // Process all nodes updating the graph pointers.
375 SmallVector<Node *, 16> Worklist;
376 for (auto &Entry : EntryNodes)
377 if (Node *EntryN = Entry.dyn_cast<Node *>())
378 Worklist.push_back(EntryN);
380 while (!Worklist.empty()) {
381 Node *N = Worklist.pop_back_val();
383 for (auto &Callee : N->Callees)
384 if (Node *CalleeN = Callee.dyn_cast<Node *>())
385 Worklist.push_back(CalleeN);
389 LazyCallGraph::SCC *LazyCallGraph::formSCC(Node *RootN,
390 SmallVectorImpl<Node *> &NodeStack) {
391 // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
393 SCC *NewSCC = new (SCCBPA.Allocate()) SCC();
395 SCCMap[RootN] = NewSCC;
396 NewSCC->Nodes.push_back(RootN);
398 while (!NodeStack.empty() && NodeStack.back()->DFSNumber > RootN->DFSNumber) {
399 Node *SCCN = NodeStack.pop_back_val();
400 assert(SCCN->LowLink >= RootN->LowLink &&
401 "We cannot have a low link in an SCC lower than its root on the "
403 SCCN->DFSNumber = SCCN->LowLink = -1;
405 SCCMap[SCCN] = NewSCC;
406 NewSCC->Nodes.push_back(SCCN);
408 RootN->DFSNumber = RootN->LowLink = -1;
410 // A final pass over all edges in the SCC (this remains linear as we only
411 // do this once when we build the SCC) to connect it to the parent sets of
413 bool IsLeafSCC = true;
414 for (Node *SCCN : NewSCC->Nodes)
415 for (Node &SCCChildN : *SCCN) {
416 if (SCCMap.lookup(&SCCChildN) == NewSCC)
418 SCC &ChildSCC = *SCCMap.lookup(&SCCChildN);
419 ChildSCC.ParentSCCs.insert(NewSCC);
423 // For the SCCs where we fine no child SCCs, add them to the leaf list.
425 LeafSCCs.push_back(NewSCC);
430 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
431 // When the stack is empty, there are no more SCCs to walk in this graph.
432 if (DFSStack.empty()) {
433 // If we've handled all candidate entry nodes to the SCC forest, we're done.
434 if (SCCEntryNodes.empty())
437 Node &N = get(*SCCEntryNodes.pop_back_val());
438 N.LowLink = N.DFSNumber = 1;
440 DFSStack.push_back(std::make_pair(&N, N.begin()));
444 Node *N = DFSStack.back().first;
445 assert(N->DFSNumber != 0 && "We should always assign a DFS number "
446 "before placing a node onto the stack.");
448 bool Recurse = false; // Used to simulate recursing onto a child.
449 for (auto I = DFSStack.back().second, E = N->end(); I != E; ++I) {
451 if (ChildN.DFSNumber == 0) {
452 // Mark that we should start at this child when next this node is the
453 // top of the stack. We don't start at the next child to ensure this
454 // child's lowlink is reflected.
455 DFSStack.back().second = I;
457 // Recurse onto this node via a tail call.
458 assert(!SCCMap.count(&ChildN) &&
459 "Found a node with 0 DFS number but already in an SCC!");
460 ChildN.LowLink = ChildN.DFSNumber = NextDFSNumber++;
461 SCCEntryNodes.remove(&ChildN.getFunction());
462 DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
467 // Track the lowest link of the childen, if any are still in the stack.
468 assert(ChildN.LowLink != 0 &&
469 "Low-link must not be zero with a non-zero DFS number.");
470 if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
471 N->LowLink = ChildN.LowLink;
474 // Continue the outer loop when we exit the inner loop in order to
475 // recurse onto a child.
478 // No more children to process here, pop the node off the stack.
481 if (N->LowLink == N->DFSNumber)
482 // Form the new SCC out of the top of the DFS stack.
483 return formSCC(N, PendingSCCStack);
485 assert(!DFSStack.empty() && "We never found a viable root!");
487 // At this point we know that N cannot ever be an SCC root. Its low-link
488 // is not its dfs-number, and we've processed all of its children. It is
489 // just sitting here waiting until some node further down the stack gets
490 // low-link == dfs-number and pops it off as well. Move it to the pending
491 // stack which is pulled into the next SCC to be formed.
492 PendingSCCStack.push_back(N);
496 char LazyCallGraphAnalysis::PassID;
498 LazyCallGraphPrinterPass::LazyCallGraphPrinterPass(raw_ostream &OS) : OS(OS) {}
500 static void printNodes(raw_ostream &OS, LazyCallGraph::Node &N,
501 SmallPtrSetImpl<LazyCallGraph::Node *> &Printed) {
502 // Recurse depth first through the nodes.
503 for (LazyCallGraph::Node &ChildN : N)
504 if (Printed.insert(&ChildN))
505 printNodes(OS, ChildN, Printed);
507 OS << " Call edges in function: " << N.getFunction().getName() << "\n";
508 for (LazyCallGraph::iterator I = N.begin(), E = N.end(); I != E; ++I)
509 OS << " -> " << I->getFunction().getName() << "\n";
514 static void printSCC(raw_ostream &OS, LazyCallGraph::SCC &SCC) {
515 ptrdiff_t SCCSize = std::distance(SCC.begin(), SCC.end());
516 OS << " SCC with " << SCCSize << " functions:\n";
518 for (LazyCallGraph::Node *N : SCC)
519 OS << " " << N->getFunction().getName() << "\n";
524 PreservedAnalyses LazyCallGraphPrinterPass::run(Module *M,
525 ModuleAnalysisManager *AM) {
526 LazyCallGraph &G = AM->getResult<LazyCallGraphAnalysis>(M);
528 OS << "Printing the call graph for module: " << M->getModuleIdentifier()
531 SmallPtrSet<LazyCallGraph::Node *, 16> Printed;
532 for (LazyCallGraph::Node &N : G)
533 if (Printed.insert(&N))
534 printNodes(OS, N, Printed);
536 for (LazyCallGraph::SCC &SCC : G.postorder_sccs())
539 return PreservedAnalyses::all();