include/llvm/Analysis/CallGraph.h

   1 //===- CallGraph.h - Build a Module's call graph ----------------*- C++ -*-===//
   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 /// \file
  10 ///
  11 /// This file provides interfaces used to build and manipulate a call graph,
  12 /// which is a very useful tool for interprocedural optimization.
  13 ///
  14 /// Every function in a module is represented as a node in the call graph.  The
  15 /// callgraph node keeps track of which functions the are called by the
  16 /// function corresponding to the node.
  17 ///
  18 /// A call graph may contain nodes where the function that they correspond to
  19 /// is null.  These 'external' nodes are used to represent control flow that is
  20 /// not represented (or analyzable) in the module.  In particular, this
  21 /// analysis builds one external node such that:
  22 ///   1. All functions in the module without internal linkage will have edges
  23 ///      from this external node, indicating that they could be called by
  24 ///      functions outside of the module.
  25 ///   2. All functions whose address is used for something more than a direct
  26 ///      call, for example being stored into a memory location will also have
  27 ///      an edge from this external node.  Since they may be called by an
  28 ///      unknown caller later, they must be tracked as such.
  29 ///
  30 /// There is a second external node added for calls that leave this module.
  31 /// Functions have a call edge to the external node iff:
  32 ///   1. The function is external, reflecting the fact that they could call
  33 ///      anything without internal linkage or that has its address taken.
  34 ///   2. The function contains an indirect function call.
  35 ///
  36 /// As an extension in the future, there may be multiple nodes with a null
  37 /// function.  These will be used when we can prove (through pointer analysis)
  38 /// that an indirect call site can call only a specific set of functions.
  39 ///
  40 /// Because of these properties, the CallGraph captures a conservative superset
  41 /// of all of the caller-callee relationships, which is useful for
  42 /// transformations.
  43 ///
  44 /// The CallGraph class also attempts to figure out what the root of the
  45 /// CallGraph is, which it currently does by looking for a function named
  46 /// 'main'. If no function named 'main' is found, the external node is used as
  47 /// the entry node, reflecting the fact that any function without internal
  48 /// linkage could be called into (which is common for libraries).
  49 ///
  50 //===----------------------------------------------------------------------===//
  51
  52 #ifndef LLVM_ANALYSIS_CALLGRAPH_H
  53 #define LLVM_ANALYSIS_CALLGRAPH_H
  54
  55 #include "llvm/ADT/GraphTraits.h"
  56 #include "llvm/ADT/OwningPtr.h"
  57 #include "llvm/ADT/STLExtras.h"
  58 #include "llvm/IR/Function.h"
  59 #include "llvm/Pass.h"
  60 #include "llvm/Support/CallSite.h"
  61 #include "llvm/Support/IncludeFile.h"
  62 #include "llvm/Support/ValueHandle.h"
  63 #include <map>
  64
  65 namespace llvm {
  66
  67 class Function;
  68 class Module;
  69 class CallGraphNode;
  70
  71 /// \brief The basic data container for the call graph of a \c Module of IR.
  72 ///
  73 /// This class exposes both the interface to the call graph for a module of IR.
  74 ///
  75 /// The core call graph itself can also be updated to reflect changes to the IR.
  76 class CallGraph {
  77   Module &M;
  78
  79   typedef std::map<const Function *, CallGraphNode *> FunctionMapTy;
  80
  81   /// \brief A map from \c Function* to \c CallGraphNode*.
  82   FunctionMapTy FunctionMap;
  83
  84   /// \brief Root is root of the call graph, or the external node if a 'main'
  85   /// function couldn't be found.
  86   CallGraphNode *Root;
  87
  88   /// \brief This node has edges to all external functions and those internal
  89   /// functions that have their address taken.
  90   CallGraphNode *ExternalCallingNode;
  91
  92   /// \brief This node has edges to it from all functions making indirect calls
  93   /// or calling an external function.
  94   CallGraphNode *CallsExternalNode;
  95
  96   /// \brief Replace the function represented by this node by another.
  97   ///
  98   /// This does not rescan the body of the function, so it is suitable when
  99   /// splicing the body of one function to another while also updating all
 100   /// callers from the old function to the new.
 101   void spliceFunction(const Function *From, const Function *To);
 102
 103   /// \brief Add a function to the call graph, and link the node to all of the
 104   /// functions that it calls.
 105   void addToCallGraph(Function *F);
 106
 107 public:
 108   CallGraph(Module &M);
 109   ~CallGraph();
 110
 111   void print(raw_ostream &OS) const;
 112   void dump() const;
 113
 114   typedef FunctionMapTy::iterator iterator;
 115   typedef FunctionMapTy::const_iterator const_iterator;
 116
 117   /// \brief Returns the module the call graph corresponds to.
 118   Module &getModule() const { return M; }
 119
 120   inline iterator begin() { return FunctionMap.begin(); }
 121   inline iterator end() { return FunctionMap.end(); }
 122   inline const_iterator begin() const { return FunctionMap.begin(); }
 123   inline const_iterator end() const { return FunctionMap.end(); }
 124
 125   /// \brief Returns the call graph node for the provided function.
 126   inline const CallGraphNode *operator[](const Function *F) const {
 127     const_iterator I = FunctionMap.find(F);
 128     assert(I != FunctionMap.end() && "Function not in callgraph!");
 129     return I->second;
 130   }
 131
 132   /// \brief Returns the call graph node for the provided function.
 133   inline CallGraphNode *operator[](const Function *F) {
 134     const_iterator I = FunctionMap.find(F);
 135     assert(I != FunctionMap.end() && "Function not in callgraph!");
 136     return I->second;
 137   }
 138
 139   /// \brief Returns the \c CallGraphNode which is used to represent
 140   /// undetermined calls into the callgraph.
 141   CallGraphNode *getExternalCallingNode() const { return ExternalCallingNode; }
 142
 143   CallGraphNode *getCallsExternalNode() const { return CallsExternalNode; }
 144
 145   /// \brief Returns the root/main method in the module, or some other root
 146   /// node, such as the externalcallingnode.
 147   CallGraphNode *getRoot() { return Root; }
 148   const CallGraphNode *getRoot() const { return Root; }
 149
 150   //===---------------------------------------------------------------------
 151   // Functions to keep a call graph up to date with a function that has been
 152   // modified.
 153   //
 154
 155   /// \brief Unlink the function from this module, returning it.
 156   ///
 157   /// Because this removes the function from the module, the call graph node is
 158   /// destroyed.  This is only valid if the function does not call any other
 159   /// functions (ie, there are no edges in it's CGN).  The easiest way to do
 160   /// this is to dropAllReferences before calling this.
 161   Function *removeFunctionFromModule(CallGraphNode *CGN);
 162
 163   /// \brief Similar to operator[], but this will insert a new CallGraphNode for
 164   /// \c F if one does not already exist.
 165   CallGraphNode *getOrInsertFunction(const Function *F);
 166 };
 167
 168 /// \brief A node in the call graph for a module.
 169 ///
 170 /// Typically represents a function in the call graph. There are also special
 171 /// "null" nodes used to represent theoretical entries in the call graph.
 172 class CallGraphNode {
 173   friend class CallGraph;
 174
 175   AssertingVH<Function> F;
 176
 177 public:
 178   /// \brief A pair of the calling instruction (a call or invoke)
 179   /// and the call graph node being called.
 180   typedef std::pair<WeakVH, CallGraphNode *> CallRecord;
 181
 182 private:
 183   std::vector<CallRecord> CalledFunctions;
 184
 185   /// \brief The number of times that this CallGraphNode occurs in the
 186   /// CalledFunctions array of this or other CallGraphNodes.
 187   unsigned NumReferences;
 188
 189   CallGraphNode(const CallGraphNode &) LLVM_DELETED_FUNCTION;
 190   void operator=(const CallGraphNode &) LLVM_DELETED_FUNCTION;
 191
 192   void DropRef() { --NumReferences; }
 193   void AddRef() { ++NumReferences; }
 194
 195 public:
 196   typedef std::vector<CallRecord> CalledFunctionsVector;
 197
 198   /// \brief Creates a node for the specified function.
 199   inline CallGraphNode(Function *F) : F(F), NumReferences(0) {}
 200
 201   ~CallGraphNode() {
 202     assert(NumReferences == 0 && "Node deleted while references remain");
 203   }
 204
 205   typedef std::vector<CallRecord>::iterator iterator;
 206   typedef std::vector<CallRecord>::const_iterator const_iterator;
 207
 208   /// \brief Returns the function that this call graph node represents.
 209   Function *getFunction() const { return F; }
 210
 211   inline iterator begin() { return CalledFunctions.begin(); }
 212   inline iterator end() { return CalledFunctions.end(); }
 213   inline const_iterator begin() const { return CalledFunctions.begin(); }
 214   inline const_iterator end() const { return CalledFunctions.end(); }
 215   inline bool empty() const { return CalledFunctions.empty(); }
 216   inline unsigned size() const { return (unsigned)CalledFunctions.size(); }
 217
 218   /// \brief Returns the number of other CallGraphNodes in this CallGraph that
 219   /// reference this node in their callee list.
 220   unsigned getNumReferences() const { return NumReferences; }
 221
 222   /// \brief Returns the i'th called function.
 223   CallGraphNode *operator[](unsigned i) const {
 224     assert(i < CalledFunctions.size() && "Invalid index");
 225     return CalledFunctions[i].second;
 226   }
 227
 228   /// \brief Print out this call graph node.
 229   void dump() const;
 230   void print(raw_ostream &OS) const;
 231
 232   //===---------------------------------------------------------------------
 233   // Methods to keep a call graph up to date with a function that has been
 234   // modified
 235   //
 236
 237   /// \brief Removes all edges from this CallGraphNode to any functions it
 238   /// calls.
 239   void removeAllCalledFunctions() {
 240     while (!CalledFunctions.empty()) {
 241       CalledFunctions.back().second->DropRef();
 242       CalledFunctions.pop_back();
 243     }
 244   }
 245
 246   /// \brief Moves all the callee information from N to this node.
 247   void stealCalledFunctionsFrom(CallGraphNode *N) {
 248     assert(CalledFunctions.empty() &&
 249            "Cannot steal callsite information if I already have some");
 250     std::swap(CalledFunctions, N->CalledFunctions);
 251   }
 252
 253   /// \brief Adds a function to the list of functions called by this one.
 254   void addCalledFunction(CallSite CS, CallGraphNode *M) {
 255     assert(!CS.getInstruction() || !CS.getCalledFunction() ||
 256            !CS.getCalledFunction()->isIntrinsic());
 257     CalledFunctions.push_back(std::make_pair(CS.getInstruction(), M));
 258     M->AddRef();
 259   }
 260
 261   void removeCallEdge(iterator I) {
 262     I->second->DropRef();
 263     *I = CalledFunctions.back();
 264     CalledFunctions.pop_back();
 265   }
 266
 267   /// \brief Removes the edge in the node for the specified call site.
 268   ///
 269   /// Note that this method takes linear time, so it should be used sparingly.
 270   void removeCallEdgeFor(CallSite CS);
 271
 272   /// \brief Removes all call edges from this node to the specified callee
 273   /// function.
 274   ///
 275   /// This takes more time to execute than removeCallEdgeTo, so it should not
 276   /// be used unless necessary.
 277   void removeAnyCallEdgeTo(CallGraphNode *Callee);
 278
 279   /// \brief Removes one edge associated with a null callsite from this node to
 280   /// the specified callee function.
 281   void removeOneAbstractEdgeTo(CallGraphNode *Callee);
 282
 283   /// \brief Replaces the edge in the node for the specified call site with a
 284   /// new one.
 285   ///
 286   /// Note that this method takes linear time, so it should be used sparingly.
 287   void replaceCallEdge(CallSite CS, CallSite NewCS, CallGraphNode *NewNode);
 288
 289   /// \brief A special function that should only be used by the CallGraph class.
 290   //
 291   // FIXME: Make this private?
 292   void allReferencesDropped() { NumReferences = 0; }
 293 };
 294
 295 /// \brief The \c ModulePass which wraps up a \c CallGraph and the logic to
 296 /// build it.
 297 ///
 298 /// This class exposes both the interface to the call graph container and the
 299 /// module pass which runs over a module of IR and produces the call graph. The
 300 /// call graph interface is entirelly a wrapper around a \c CallGraph object
 301 /// which is stored internally for each module.
 302 class CallGraphWrapperPass : public ModulePass {
 303   OwningPtr<CallGraph> G;
 304
 305 public:
 306   static char ID; // Class identification, replacement for typeinfo
 307
 308   CallGraphWrapperPass();
 309   virtual ~CallGraphWrapperPass();
 310
 311   /// \brief The internal \c CallGraph around which the rest of this interface
 312   /// is wrapped.
 313   const CallGraph &getCallGraph() const { return *G; }
 314   CallGraph &getCallGraph() { return *G; }
 315
 316   typedef CallGraph::iterator iterator;
 317   typedef CallGraph::const_iterator const_iterator;
 318
 319   /// \brief Returns the module the call graph corresponds to.
 320   Module &getModule() const { return G->getModule(); }
 321
 322   inline iterator begin() { return G->begin(); }
 323   inline iterator end() { return G->end(); }
 324   inline const_iterator begin() const { return G->begin(); }
 325   inline const_iterator end() const { return G->end(); }
 326
 327   /// \brief Returns the call graph node for the provided function.
 328   inline const CallGraphNode *operator[](const Function *F) const {
 329     return (*G)[F];
 330   }
 331
 332   /// \brief Returns the call graph node for the provided function.
 333   inline CallGraphNode *operator[](const Function *F) { return (*G)[F]; }
 334
 335   /// \brief Returns the \c CallGraphNode which is used to represent
 336   /// undetermined calls into the callgraph.
 337   CallGraphNode *getExternalCallingNode() const {
 338     return G->getExternalCallingNode();
 339   }
 340
 341   CallGraphNode *getCallsExternalNode() const {
 342     return G->getCallsExternalNode();
 343   }
 344
 345   /// \brief Returns the root/main method in the module, or some other root
 346   /// node, such as the externalcallingnode.
 347   CallGraphNode *getRoot() { return G->getRoot(); }
 348   const CallGraphNode *getRoot() const { return G->getRoot(); }
 349
 350   //===---------------------------------------------------------------------
 351   // Functions to keep a call graph up to date with a function that has been
 352   // modified.
 353   //
 354
 355   /// \brief Unlink the function from this module, returning it.
 356   ///
 357   /// Because this removes the function from the module, the call graph node is
 358   /// destroyed.  This is only valid if the function does not call any other
 359   /// functions (ie, there are no edges in it's CGN).  The easiest way to do
 360   /// this is to dropAllReferences before calling this.
 361   Function *removeFunctionFromModule(CallGraphNode *CGN) {
 362     return G->removeFunctionFromModule(CGN);
 363   }
 364
 365   /// \brief Similar to operator[], but this will insert a new CallGraphNode for
 366   /// \c F if one does not already exist.
 367   CallGraphNode *getOrInsertFunction(const Function *F) {
 368     return G->getOrInsertFunction(F);
 369   }
 370
 371   //===---------------------------------------------------------------------
 372   // Implementation of the ModulePass interface needed here.
 373   //
 374
 375   virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 376   virtual bool runOnModule(Module &M);
 377   virtual void releaseMemory();
 378
 379   void print(raw_ostream &o, const Module *) const;
 380   void dump() const;
 381 };
 382
 383 //===----------------------------------------------------------------------===//
 384 // GraphTraits specializations for call graphs so that they can be treated as
 385 // graphs by the generic graph algorithms.
 386 //
 387
 388 // Provide graph traits for tranversing call graphs using standard graph
 389 // traversals.
 390 template <> struct GraphTraits<CallGraphNode *> {
 391   typedef CallGraphNode NodeType;
 392
 393   typedef CallGraphNode::CallRecord CGNPairTy;
 394   typedef std::pointer_to_unary_function<CGNPairTy, CallGraphNode *>
 395   CGNDerefFun;
 396
 397   static NodeType *getEntryNode(CallGraphNode *CGN) { return CGN; }
 398
 399   typedef mapped_iterator<NodeType::iterator, CGNDerefFun> ChildIteratorType;
 400
 401   static inline ChildIteratorType child_begin(NodeType *N) {
 402     return map_iterator(N->begin(), CGNDerefFun(CGNDeref));
 403   }
 404   static inline ChildIteratorType child_end(NodeType *N) {
 405     return map_iterator(N->end(), CGNDerefFun(CGNDeref));
 406   }
 407
 408   static CallGraphNode *CGNDeref(CGNPairTy P) { return P.second; }
 409 };
 410
 411 template <> struct GraphTraits<const CallGraphNode *> {
 412   typedef const CallGraphNode NodeType;
 413   typedef NodeType::const_iterator ChildIteratorType;
 414
 415   static NodeType *getEntryNode(const CallGraphNode *CGN) { return CGN; }
 416   static inline ChildIteratorType child_begin(NodeType *N) {
 417     return N->begin();
 418   }
 419   static inline ChildIteratorType child_end(NodeType *N) { return N->end(); }
 420 };
 421
 422 template <>
 423 struct GraphTraits<CallGraph *> : public GraphTraits<CallGraphNode *> {
 424   static NodeType *getEntryNode(CallGraph *CGN) {
 425     return CGN->getExternalCallingNode(); // Start at the external node!
 426   }
 427   typedef std::pair<const Function *, CallGraphNode *> PairTy;
 428   typedef std::pointer_to_unary_function<PairTy, CallGraphNode &> DerefFun;
 429
 430   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 431   typedef mapped_iterator<CallGraph::iterator, DerefFun> nodes_iterator;
 432   static nodes_iterator nodes_begin(CallGraph *CG) {
 433     return map_iterator(CG->begin(), DerefFun(CGdereference));
 434   }
 435   static nodes_iterator nodes_end(CallGraph *CG) {
 436     return map_iterator(CG->end(), DerefFun(CGdereference));
 437   }
 438
 439   static CallGraphNode &CGdereference(PairTy P) { return *P.second; }
 440 };
 441
 442 template <>
 443 struct GraphTraits<const CallGraph *> : public GraphTraits<
 444                                             const CallGraphNode *> {
 445   static NodeType *getEntryNode(const CallGraph *CGN) {
 446     return CGN->getExternalCallingNode();
 447   }
 448   // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
 449   typedef CallGraph::const_iterator nodes_iterator;
 450   static nodes_iterator nodes_begin(const CallGraph *CG) { return CG->begin(); }
 451   static nodes_iterator nodes_end(const CallGraph *CG) { return CG->end(); }
 452 };
 453
 454 } // End llvm namespace
 455
 456 // Make sure that any clients of this file link in CallGraph.cpp
 457 FORCE_DEFINING_FILE_TO_BE_LINKED(CallGraph)
 458
 459 #endif