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 LazyCallGraph::Node *LazyCallGraph::insertInto(Function &F, Node *&MappedN) {
135 return new (MappedN = BPA.Allocate()) Node(*this, F);
138 void LazyCallGraph::updateGraphPtrs() {
139 // Process all nodes updating the graph pointers.
140 SmallVector<Node *, 16> Worklist;
141 for (auto &Entry : EntryNodes)
142 if (Node *EntryN = Entry.dyn_cast<Node *>())
143 Worklist.push_back(EntryN);
145 while (!Worklist.empty()) {
146 Node *N = Worklist.pop_back_val();
148 for (auto &Callee : N->Callees)
149 if (Node *CalleeN = Callee.dyn_cast<Node *>())
150 Worklist.push_back(CalleeN);
154 LazyCallGraph::SCC *LazyCallGraph::formSCCFromDFSStack(
155 SmallVectorImpl<std::pair<Node *, Node::iterator>> &DFSStack,
156 SmallVectorImpl<std::pair<Node *, Node::iterator>>::iterator SCCBegin) {
157 // The tail of the stack is the new SCC. Allocate the SCC and pop the stack
159 SCC *NewSCC = new (SCCBPA.Allocate()) SCC();
161 for (auto I = SCCBegin, E = DFSStack.end(); I != E; ++I) {
162 Node *SCCN = I->first;
163 assert(SCCN->LowLink >= SCCBegin->first->LowLink &&
164 "We cannot have a low link in an SCC lower than its root on the "
167 SCCMap[&SCCN->getFunction()] = NewSCC;
168 NewSCC->Nodes.push_back(SCCN);
170 NewSCC->NodeSet.insert(&SCCN->getFunction());
172 assert(Inserted && "Cannot have duplicates in the DFSStack!");
174 DFSStack.erase(SCCBegin, DFSStack.end());
176 // A final pass over all edges in the SCC (this remains linear as we only
177 // do this once when we build the SCC) to connect it to the parent sets of
179 bool IsLeafSCC = true;
180 for (Node *SCCN : NewSCC->Nodes)
181 for (Node *SCCChildN : *SCCN) {
182 if (NewSCC->NodeSet.count(&SCCChildN->getFunction()))
184 SCC *ChildSCC = SCCMap.lookup(&SCCChildN->getFunction());
186 "Must have all child SCCs processed when building a new SCC!");
187 ChildSCC->ParentSCCs.insert(NewSCC);
191 // For the SCCs where we fine no child SCCs, add them to the leaf list.
193 LeafSCCs.push_back(NewSCC);
198 LazyCallGraph::SCC *LazyCallGraph::getNextSCCInPostOrder() {
199 // When the stack is empty, there are no more SCCs to walk in this graph.
200 if (DFSStack.empty()) {
201 // If we've handled all candidate entry nodes to the SCC forest, we're done.
202 if (SCCEntryNodes.empty())
205 // Reset the DFS numbering.
207 Node *N = get(*SCCEntryNodes.pop_back_val());
208 DFSStack.push_back(std::make_pair(N, N->begin()));
211 auto SI = DFSStack.rbegin();
212 if (SI->first->DFSNumber == 0) {
213 // This node hasn't been visited before, assign it a DFS number and remove
214 // it from the entry set.
215 SI->first->LowLink = SI->first->DFSNumber = NextDFSNumber++;
216 SCCEntryNodes.remove(&SI->first->getFunction());
221 for (auto I = SI->second, E = N->end(); I != E; ++I) {
223 if (ChildN->DFSNumber == 0) {
224 // Mark that we should start at this child when next this node is the
225 // top of the stack. We don't start at the next child to ensure this
226 // child's lowlink is reflected.
229 // Recurse onto this node via a tail call.
230 DFSStack.push_back(std::make_pair(ChildN, ChildN->begin()));
231 return LazyCallGraph::getNextSCCInPostOrder();
234 // Track the lowest link of the childen, if any are still in the stack.
235 if (ChildN->LowLink < N->LowLink && !SCCMap.count(&ChildN->getFunction()))
236 N->LowLink = ChildN->LowLink;
238 // No more children to process for this stack entry.
239 SI->second = N->end();
241 if (N->LowLink == N->DFSNumber)
242 // Form the new SCC out of the top of the DFS stack.
243 return formSCCFromDFSStack(DFSStack, std::prev(SI.base()));
246 } while (SI != DFSStack.rend());
249 "We cannot reach the bottom of the stack without popping an SCC.");
252 char LazyCallGraphAnalysis::PassID;
254 LazyCallGraphPrinterPass::LazyCallGraphPrinterPass(raw_ostream &OS) : OS(OS) {}
256 static void printNodes(raw_ostream &OS, LazyCallGraph::Node &N,
257 SmallPtrSetImpl<LazyCallGraph::Node *> &Printed) {
258 // Recurse depth first through the nodes.
259 for (LazyCallGraph::Node *ChildN : N)
260 if (Printed.insert(ChildN))
261 printNodes(OS, *ChildN, Printed);
263 OS << " Call edges in function: " << N.getFunction().getName() << "\n";
264 for (LazyCallGraph::iterator I = N.begin(), E = N.end(); I != E; ++I)
265 OS << " -> " << I->getFunction().getName() << "\n";
270 static void printSCC(raw_ostream &OS, LazyCallGraph::SCC &SCC) {
271 ptrdiff_t SCCSize = std::distance(SCC.begin(), SCC.end());
272 OS << " SCC with " << SCCSize << " functions:\n";
274 for (LazyCallGraph::Node *N : SCC)
275 OS << " " << N->getFunction().getName() << "\n";
280 PreservedAnalyses LazyCallGraphPrinterPass::run(Module *M,
281 ModuleAnalysisManager *AM) {
282 LazyCallGraph &G = AM->getResult<LazyCallGraphAnalysis>(M);
284 OS << "Printing the call graph for module: " << M->getModuleIdentifier()
287 SmallPtrSet<LazyCallGraph::Node *, 16> Printed;
288 for (LazyCallGraph::Node *N : G)
289 if (Printed.insert(N))
290 printNodes(OS, *N, Printed);
292 for (LazyCallGraph::SCC *SCC : G.postorder_sccs())
295 return PreservedAnalyses::all();