1 //===- CallGraph.h - Build a Module's call graph ----------------*- C++ -*-===//
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 // This interface is used to build and manipulate a call graph, which is a very
11 // useful tool for interprocedural optimization.
13 // Every function in a module is represented as a node in the call graph. The
14 // callgraph node keeps track of which functions the are called by the function
15 // corresponding to the node.
17 // A call graph may contain nodes where the function that they correspond to is
18 // null. These 'external' nodes are used to represent control flow that is not
19 // represented (or analyzable) in the module. In particular, this analysis
20 // builds one external node such that:
21 // 1. All functions in the module without internal linkage will have edges
22 // from this external node, indicating that they could be called by
23 // functions outside of the module.
24 // 2. All functions whose address is used for something more than a direct
25 // call, for example being stored into a memory location will also have an
26 // edge from this external node. Since they may be called by an unknown
27 // caller later, they must be tracked as such.
29 // There is a second external node added for calls that leave this module.
30 // Functions have a call edge to the external node iff:
31 // 1. The function is external, reflecting the fact that they could call
32 // anything without internal linkage or that has its address taken.
33 // 2. The function contains an indirect function call.
35 // As an extension in the future, there may be multiple nodes with a null
36 // function. These will be used when we can prove (through pointer analysis)
37 // that an indirect call site can call only a specific set of functions.
39 // Because of these properties, the CallGraph captures a conservative superset
40 // of all of the caller-callee relationships, which is useful for
43 // The CallGraph class also attempts to figure out what the root of the
44 // CallGraph is, which it currently does by looking for a function named 'main'.
45 // If no function named 'main' is found, the external node is used as the entry
46 // node, reflecting the fact that any function without internal linkage could
47 // be called into (which is common for libraries).
49 //===----------------------------------------------------------------------===//
51 #ifndef LLVM_ANALYSIS_CALLGRAPH_H
52 #define LLVM_ANALYSIS_CALLGRAPH_H
54 #include "llvm/ADT/GraphTraits.h"
55 #include "llvm/ADT/STLExtras.h"
56 #include "llvm/Pass.h"
57 #include "llvm/Support/CallSite.h"
58 #include "llvm/System/IncludeFile.h"
67 //===----------------------------------------------------------------------===//
68 // CallGraph class definition
72 Module *Mod; // The module this call graph represents
74 typedef std::map<const Function *, CallGraphNode *> FunctionMapTy;
75 FunctionMapTy FunctionMap; // Map from a function to its node
78 static char ID; // Class identification, replacement for typeinfo
79 //===---------------------------------------------------------------------
82 typedef FunctionMapTy::iterator iterator;
83 typedef FunctionMapTy::const_iterator const_iterator;
85 /// getModule - Return the module the call graph corresponds to.
87 Module &getModule() const { return *Mod; }
89 inline iterator begin() { return FunctionMap.begin(); }
90 inline iterator end() { return FunctionMap.end(); }
91 inline const_iterator begin() const { return FunctionMap.begin(); }
92 inline const_iterator end() const { return FunctionMap.end(); }
94 // Subscripting operators, return the call graph node for the provided
96 inline const CallGraphNode *operator[](const Function *F) const {
97 const_iterator I = FunctionMap.find(F);
98 assert(I != FunctionMap.end() && "Function not in callgraph!");
101 inline CallGraphNode *operator[](const Function *F) {
102 const_iterator I = FunctionMap.find(F);
103 assert(I != FunctionMap.end() && "Function not in callgraph!");
107 /// Returns the CallGraphNode which is used to represent undetermined calls
108 /// into the callgraph. Override this if you want behavioral inheritance.
109 virtual CallGraphNode* getExternalCallingNode() const { return 0; }
110 virtual CallGraphNode* getCallsExternalNode() const { return 0; }
112 /// Return the root/main method in the module, or some other root node, such
113 /// as the externalcallingnode. Overload these if you behavioral
115 virtual CallGraphNode* getRoot() { return 0; }
116 virtual const CallGraphNode* getRoot() const { return 0; }
118 //===---------------------------------------------------------------------
119 // Functions to keep a call graph up to date with a function that has been
123 /// removeFunctionFromModule - Unlink the function from this module, returning
124 /// it. Because this removes the function from the module, the call graph
125 /// node is destroyed. This is only valid if the function does not call any
126 /// other functions (ie, there are no edges in it's CGN). The easiest way to
127 /// do this is to dropAllReferences before calling this.
129 Function *removeFunctionFromModule(CallGraphNode *CGN);
130 Function *removeFunctionFromModule(Function *F) {
131 return removeFunctionFromModule((*this)[F]);
134 /// getOrInsertFunction - This method is identical to calling operator[], but
135 /// it will insert a new CallGraphNode for the specified function if one does
136 /// not already exist.
137 CallGraphNode *getOrInsertFunction(const Function *F);
139 //===---------------------------------------------------------------------
140 // Pass infrastructure interface glue code.
146 virtual ~CallGraph() { destroy(); }
148 /// initialize - Call this method before calling other methods,
149 /// re/initializes the state of the CallGraph.
151 void initialize(Module &M);
153 void print(raw_ostream &o, Module *) const;
156 // destroy - Release memory for the call graph
157 virtual void destroy();
160 //===----------------------------------------------------------------------===//
161 // CallGraphNode class definition
163 class CallGraphNode {
165 typedef std::pair<CallSite,CallGraphNode*> CallRecord;
166 std::vector<CallRecord> CalledFunctions;
168 /// NumReferences - This is the number of times that this CallGraphNode occurs
169 /// in the CalledFunctions array of this or other CallGraphNodes.
170 unsigned NumReferences;
172 CallGraphNode(const CallGraphNode &); // DO NOT IMPLEMENT
173 void operator=(const CallGraphNode &); // DO NOT IMPLEMENT
175 void DropRef() { --NumReferences; }
176 void AddRef() { ++NumReferences; }
178 typedef std::vector<CallRecord> CalledFunctionsVector;
181 // CallGraphNode ctor - Create a node for the specified function.
182 inline CallGraphNode(Function *f) : F(f), NumReferences(0) {}
184 //===---------------------------------------------------------------------
188 typedef std::vector<CallRecord>::iterator iterator;
189 typedef std::vector<CallRecord>::const_iterator const_iterator;
191 // getFunction - Return the function that this call graph node represents.
192 Function *getFunction() const { return F; }
194 inline iterator begin() { return CalledFunctions.begin(); }
195 inline iterator end() { return CalledFunctions.end(); }
196 inline const_iterator begin() const { return CalledFunctions.begin(); }
197 inline const_iterator end() const { return CalledFunctions.end(); }
198 inline bool empty() const { return CalledFunctions.empty(); }
199 inline unsigned size() const { return (unsigned)CalledFunctions.size(); }
201 /// getNumReferences - Return the number of other CallGraphNodes in this
202 /// CallGraph that reference this node in their callee list.
203 unsigned getNumReferences() const { return NumReferences; }
205 // Subscripting operator - Return the i'th called function.
207 CallGraphNode *operator[](unsigned i) const {
208 assert(i < CalledFunctions.size() && "Invalid index");
209 return CalledFunctions[i].second;
212 /// dump - Print out this call graph node.
215 void print(raw_ostream &OS) const;
217 //===---------------------------------------------------------------------
218 // Methods to keep a call graph up to date with a function that has been
222 /// removeAllCalledFunctions - As the name implies, this removes all edges
223 /// from this CallGraphNode to any functions it calls.
224 void removeAllCalledFunctions() {
225 while (!CalledFunctions.empty()) {
226 CalledFunctions.back().second->DropRef();
227 CalledFunctions.pop_back();
231 /// stealCalledFunctionsFrom - Move all the callee information from N to this
233 void stealCalledFunctionsFrom(CallGraphNode *N) {
234 assert(CalledFunctions.empty() &&
235 "Cannot steal callsite information if I already have some");
236 std::swap(CalledFunctions, N->CalledFunctions);
240 /// addCalledFunction - Add a function to the list of functions called by this
242 void addCalledFunction(CallSite CS, CallGraphNode *M) {
243 CalledFunctions.push_back(std::make_pair(CS, M));
247 /// removeCallEdgeFor - This method removes the edge in the node for the
248 /// specified call site. Note that this method takes linear time, so it
249 /// should be used sparingly.
250 void removeCallEdgeFor(CallSite CS);
252 // FIXME: REMOVE THIS WHEN HACK IS REMOVED FROM CGSCCPASSMGR.
253 void removeCallEdgeFor(Instruction *CS);
256 /// removeAnyCallEdgeTo - This method removes all call edges from this node
257 /// to the specified callee function. This takes more time to execute than
258 /// removeCallEdgeTo, so it should not be used unless necessary.
259 void removeAnyCallEdgeTo(CallGraphNode *Callee);
261 /// removeOneAbstractEdgeTo - Remove one edge associated with a null callsite
262 /// from this node to the specified callee function.
263 void removeOneAbstractEdgeTo(CallGraphNode *Callee);
265 /// replaceCallSite - Make the edge in the node for Old CallSite be for
266 /// New CallSite instead. Note that this method takes linear time, so it
267 /// should be used sparingly.
268 void replaceCallSite(CallSite Old, CallSite New, CallGraphNode *NewCallee);
271 //===----------------------------------------------------------------------===//
272 // GraphTraits specializations for call graphs so that they can be treated as
273 // graphs by the generic graph algorithms.
276 // Provide graph traits for tranversing call graphs using standard graph
278 template <> struct GraphTraits<CallGraphNode*> {
279 typedef CallGraphNode NodeType;
281 typedef std::pair<CallSite, CallGraphNode*> CGNPairTy;
282 typedef std::pointer_to_unary_function<CGNPairTy, CallGraphNode*> CGNDerefFun;
284 static NodeType *getEntryNode(CallGraphNode *CGN) { return CGN; }
286 typedef mapped_iterator<NodeType::iterator, CGNDerefFun> ChildIteratorType;
288 static inline ChildIteratorType child_begin(NodeType *N) {
289 return map_iterator(N->begin(), CGNDerefFun(CGNDeref));
291 static inline ChildIteratorType child_end (NodeType *N) {
292 return map_iterator(N->end(), CGNDerefFun(CGNDeref));
295 static CallGraphNode *CGNDeref(CGNPairTy P) {
301 template <> struct GraphTraits<const CallGraphNode*> {
302 typedef const CallGraphNode NodeType;
303 typedef NodeType::const_iterator ChildIteratorType;
305 static NodeType *getEntryNode(const CallGraphNode *CGN) { return CGN; }
306 static inline ChildIteratorType child_begin(NodeType *N) { return N->begin();}
307 static inline ChildIteratorType child_end (NodeType *N) { return N->end(); }
310 template<> struct GraphTraits<CallGraph*> : public GraphTraits<CallGraphNode*> {
311 static NodeType *getEntryNode(CallGraph *CGN) {
312 return CGN->getExternalCallingNode(); // Start at the external node!
314 typedef std::pair<const Function*, CallGraphNode*> PairTy;
315 typedef std::pointer_to_unary_function<PairTy, CallGraphNode&> DerefFun;
317 // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
318 typedef mapped_iterator<CallGraph::iterator, DerefFun> nodes_iterator;
319 static nodes_iterator nodes_begin(CallGraph *CG) {
320 return map_iterator(CG->begin(), DerefFun(CGdereference));
322 static nodes_iterator nodes_end (CallGraph *CG) {
323 return map_iterator(CG->end(), DerefFun(CGdereference));
326 static CallGraphNode &CGdereference(PairTy P) {
331 template<> struct GraphTraits<const CallGraph*> :
332 public GraphTraits<const CallGraphNode*> {
333 static NodeType *getEntryNode(const CallGraph *CGN) {
334 return CGN->getExternalCallingNode();
336 // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
337 typedef CallGraph::const_iterator nodes_iterator;
338 static nodes_iterator nodes_begin(const CallGraph *CG) { return CG->begin(); }
339 static nodes_iterator nodes_end (const CallGraph *CG) { return CG->end(); }
342 } // End llvm namespace
344 // Make sure that any clients of this file link in CallGraph.cpp
345 FORCE_DEFINING_FILE_TO_BE_LINKED(CallGraph)