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.
186 int NextDFSNumber = 1;
187 SmallVector<std::pair<Node *, Node::iterator>, 4> DFSStack;
189 // The worklist is every node in the original SCC. FIXME: switch the SCC to
190 // use a SmallSetVector and swap here.
191 SmallSetVector<Node *, 1> Worklist;
192 for (Node *N : Nodes) {
193 // Clear these to 0 while we re-run Tarjan's over the SCC.
199 // The callee can already reach every node in this SCC (by definition). It is
200 // the only node we know will stay inside this SCC. Everything which
201 // transitively reaches Callee will also remain in the SCC. To model this we
202 // incrementally add any chain of nodes which reaches something in the new
203 // node set to the new node set. This short circuits one side of the Tarjan's
205 SmallSetVector<Node *, 1> NewNodes;
206 NewNodes.insert(&Callee);
209 if (DFSStack.empty()) {
210 if (Worklist.empty())
212 Node *N = Worklist.pop_back_val();
213 DFSStack.push_back(std::make_pair(N, N->begin()));
216 Node *N = DFSStack.back().first;
218 // Check if we have reached a node in the new (known connected) set. If so,
219 // the entire stack is necessarily in that set and we can re-start.
220 if (NewNodes.count(N)) {
222 while (!DFSStack.empty())
223 NewNodes.insert(DFSStack.pop_back_val().first);
227 if (N->DFSNumber == 0) {
228 N->LowLink = N->DFSNumber = NextDFSNumber++;
232 auto SI = DFSStack.rbegin();
233 bool PushedChildNode = false;
236 for (auto I = SI->second, E = N->end(); I != E; ++I) {
238 // If this child isn't currently in this SCC, no need to process it.
239 // However, we do need to remove this SCC from its SCC's parent set.
240 SCC &ChildSCC = *G.SCCMap.lookup(&ChildN);
241 if (&ChildSCC != this) {
242 ChildSCC.ParentSCCs.erase(this);
246 if (ChildN.DFSNumber == 0) {
247 // Mark that we should start at this child when next this node is the
248 // top of the stack. We don't start at the next child to ensure this
249 // child's lowlink is reflected.
252 // Recurse onto this node via a tail call.
253 DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
254 PushedChildNode = true;
258 // Track the lowest link of the childen, if any are still in the stack.
259 // Any child not on the stack will have a LowLink of -1.
260 assert(ChildN.LowLink != 0 &&
261 "Low-link must not be zero with a non-zero DFS number.");
262 if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
263 N->LowLink = ChildN.LowLink;
265 if (!PushedChildNode)
266 // No more children to process for this stack entry.
267 SI->second = N->end();
270 // If nothing is new on the stack and this isn't the SCC root, walk
272 } while (!PushedChildNode && N->LowLink != N->DFSNumber &&
273 SI != DFSStack.rend());
278 // Form the new SCC out of the top of the DFS stack.
279 ResultSCCs.push_back(G.formSCCFromDFSStack(DFSStack, SI.base()));
282 // Replace this SCC with the NewNodes we collected above.
283 // FIXME: Simplify this when the SCC's datastructure is just a list.
286 // Now we need to reconnect the current SCC to the graph.
287 bool IsLeafSCC = true;
288 for (Node *N : NewNodes) {
292 for (Node &ChildN : *N) {
293 if (NewNodes.count(&ChildN))
295 SCC &ChildSCC = *G.SCCMap.lookup(&ChildN);
296 ChildSCC.ParentSCCs.insert(this);
301 if (ResultSCCs.size() > 1)
302 assert(!IsLeafSCC && "This SCC cannot be a leaf as we have split out new "
303 "SCCs by removing this edge.");
304 if (!std::any_of(G.LeafSCCs.begin(), G.LeafSCCs.end(),
305 [&](SCC *C) { return C == this; }))
306 assert(!IsLeafSCC && "This SCC cannot be a leaf as it already had child "
307 "SCCs before we removed this edge.");
309 // If this SCC stopped being a leaf through this edge removal, remove it from
310 // the leaf SCC list.
311 if (!IsLeafSCC && ResultSCCs.size() > 1)
312 G.LeafSCCs.erase(std::remove(G.LeafSCCs.begin(), G.LeafSCCs.end(), this),
315 // Return the new list of SCCs.
319 void LazyCallGraph::removeEdge(Node &CallerN, Function &Callee) {
320 auto IndexMapI = CallerN.CalleeIndexMap.find(&Callee);
321 assert(IndexMapI != CallerN.CalleeIndexMap.end() &&
322 "Callee not in the callee set for the caller?");
324 Node *CalleeN = CallerN.Callees[IndexMapI->second].dyn_cast<Node *>();
325 CallerN.Callees.erase(CallerN.Callees.begin() + IndexMapI->second);
326 CallerN.CalleeIndexMap.erase(IndexMapI);
328 SCC *CallerC = SCCMap.lookup(&CallerN);
330 // We can only remove edges when the edge isn't actively participating in
331 // a DFS walk. Either it must have been popped into an SCC, or it must not
332 // yet have been reached by the DFS walk. Assert the latter here.
333 assert(std::all_of(DFSStack.begin(), DFSStack.end(),
334 [&](const std::pair<Node *, iterator> &StackEntry) {
335 return StackEntry.first != &CallerN;
337 "Found the caller on the DFSStack!");
341 assert(CalleeN && "If the caller is in an SCC, we have to have explored all "
342 "its transitively called functions.");
344 SCC *CalleeC = SCCMap.lookup(CalleeN);
346 "The caller has an SCC, and thus by necessity so does the callee.");
348 // The easy case is when they are different SCCs.
349 if (CallerC != CalleeC) {
350 CallerC->removeEdge(*this, CallerN.getFunction(), Callee, *CalleeC);
354 // The hard case is when we remove an edge within a SCC. This may cause new
355 // SCCs to need to be added to the graph.
356 CallerC->removeInternalEdge(*this, CallerN, *CalleeN);
359 LazyCallGraph::Node &LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
360 return *new (MappedN = BPA.Allocate()) Node(*this, F);
363 void LazyCallGraph::updateGraphPtrs() {
364 // Process all nodes updating the graph pointers.
365 SmallVector<Node *, 16> Worklist;
366 for (auto &Entry : EntryNodes)
367 if (Node *EntryN = Entry.dyn_cast<Node *>())
368 Worklist.push_back(EntryN);
370 while (!Worklist.empty()) {
371 Node *N = Worklist.pop_back_val();
373 for (auto &Callee : N->Callees)
374 if (Node *CalleeN = Callee.dyn_cast<Node *>())
375 Worklist.push_back(CalleeN);
379 LazyCallGraph::SCC *LazyCallGraph::formSCCFromDFSStack(
380 SmallVectorImpl<std::pair<Node *, Node::iterator>> &DFSStack,
381 SmallVectorImpl<std::pair<Node *, Node::iterator>>::iterator SCCBegin) {
382 // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
384 SCC *NewSCC = new (SCCBPA.Allocate()) SCC();
386 for (auto I = SCCBegin, E = DFSStack.end(); I != E; ++I) {
387 Node *SCCN = I->first;
388 assert(SCCN->LowLink >= SCCBegin->first->LowLink &&
389 "We cannot have a low link in an SCC lower than its root on the "
392 SCCMap[SCCN] = NewSCC;
393 NewSCC->Nodes.push_back(SCCN);
395 DFSStack.erase(SCCBegin, DFSStack.end());
397 // A final pass over all edges in the SCC (this remains linear as we only
398 // do this once when we build the SCC) to connect it to the parent sets of
400 bool IsLeafSCC = true;
401 for (Node *SCCN : NewSCC->Nodes)
402 for (Node &SCCChildN : *SCCN) {
403 if (SCCMap.lookup(&SCCChildN) == NewSCC)
405 SCC &ChildSCC = *SCCMap.lookup(&SCCChildN);
406 ChildSCC.ParentSCCs.insert(NewSCC);
410 // For the SCCs where we fine no child SCCs, add them to the leaf list.
412 LeafSCCs.push_back(NewSCC);
417 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
418 // When the stack is empty, there are no more SCCs to walk in this graph.
419 if (DFSStack.empty()) {
420 // If we've handled all candidate entry nodes to the SCC forest, we're done.
421 if (SCCEntryNodes.empty())
424 // Reset the DFS numbering.
426 Node &N = get(*SCCEntryNodes.pop_back_val());
427 DFSStack.push_back(std::make_pair(&N, N.begin()));
430 auto SI = DFSStack.rbegin();
431 if (SI->first->DFSNumber == 0) {
432 // This node hasn't been visited before, assign it a DFS number and remove
433 // it from the entry set.
434 assert(!SCCMap.count(SI->first) &&
435 "Found a node with 0 DFS number but already in an SCC!");
436 SI->first->LowLink = SI->first->DFSNumber = NextDFSNumber++;
437 SCCEntryNodes.remove(&SI->first->getFunction());
442 for (auto I = SI->second, E = N->end(); I != E; ++I) {
444 if (ChildN.DFSNumber == 0) {
445 // Mark that we should start at this child when next this node is the
446 // top of the stack. We don't start at the next child to ensure this
447 // child's lowlink is reflected.
450 // Recurse onto this node via a tail call.
451 DFSStack.push_back(std::make_pair(&ChildN, ChildN.begin()));
452 return LazyCallGraph::getNextSCCInPostOrder();
455 // Track the lowest link of the childen, if any are still in the stack.
456 assert(ChildN.LowLink != 0 &&
457 "Low-link must not be zero with a non-zero DFS number.");
458 if (ChildN.LowLink >= 0 && ChildN.LowLink < N->LowLink)
459 N->LowLink = ChildN.LowLink;
461 // No more children to process for this stack entry.
462 SI->second = N->end();
464 if (N->LowLink == N->DFSNumber)
465 // Form the new SCC out of the top of the DFS stack.
466 return formSCCFromDFSStack(DFSStack, std::prev(SI.base()));
469 } while (SI != DFSStack.rend());
472 "We cannot reach the bottom of the stack without popping an SCC.");
475 char LazyCallGraphAnalysis::PassID;
477 LazyCallGraphPrinterPass::LazyCallGraphPrinterPass(raw_ostream &OS) : OS(OS) {}
479 static void printNodes(raw_ostream &OS, LazyCallGraph::Node &N,
480 SmallPtrSetImpl<LazyCallGraph::Node *> &Printed) {
481 // Recurse depth first through the nodes.
482 for (LazyCallGraph::Node &ChildN : N)
483 if (Printed.insert(&ChildN))
484 printNodes(OS, ChildN, Printed);
486 OS << " Call edges in function: " << N.getFunction().getName() << "\n";
487 for (LazyCallGraph::iterator I = N.begin(), E = N.end(); I != E; ++I)
488 OS << " -> " << I->getFunction().getName() << "\n";
493 static void printSCC(raw_ostream &OS, LazyCallGraph::SCC &SCC) {
494 ptrdiff_t SCCSize = std::distance(SCC.begin(), SCC.end());
495 OS << " SCC with " << SCCSize << " functions:\n";
497 for (LazyCallGraph::Node *N : SCC)
498 OS << " " << N->getFunction().getName() << "\n";
503 PreservedAnalyses LazyCallGraphPrinterPass::run(Module *M,
504 ModuleAnalysisManager *AM) {
505 LazyCallGraph &G = AM->getResult<LazyCallGraphAnalysis>(M);
507 OS << "Printing the call graph for module: " << M->getModuleIdentifier()
510 SmallPtrSet<LazyCallGraph::Node *, 16> Printed;
511 for (LazyCallGraph::Node &N : G)
512 if (Printed.insert(&N))
513 printNodes(OS, N, Printed);
515 for (LazyCallGraph::SCC &SCC : G.postorder_sccs())
518 return PreservedAnalyses::all();