lib/Analysis/IPA/CallGraph.cpp

   1 //===- CallGraph.cpp - Build a Module's call graph ------------------------===//
   2 //
   3 // This interface is used to build and manipulate a call graph, which is a very
   4 // useful tool for interprocedural optimization.
   5 //
   6 // Every function in a module is represented as a node in the call graph.  The
   7 // callgraph node keeps track of which functions the are called by the function
   8 // corresponding to the node.
   9 //
  10 // A call graph will contain nodes where the function that they correspond to is
  11 // null.  This 'external' node is used to represent control flow that is not
  12 // represented (or analyzable) in the module.  As such, the external node will
  13 // have edges to functions with the following properties:
  14 //   1. All functions in the module without internal linkage, since they could
  15 //      be called by functions outside of the our analysis capability.
  16 //   2. All functions whose address is used for something more than a direct
  17 //      call, for example being stored into a memory location.  Since they may
  18 //      be called by an unknown caller later, they must be tracked as such.
  19 //
  20 // Similarly, functions have a call edge to the external node iff:
  21 //   1. The function is external, reflecting the fact that they could call
  22 //      anything without internal linkage or that has its address taken.
  23 //   2. The function contains an indirect function call.
  24 //
  25 // As an extension in the future, there may be multiple nodes with a null
  26 // function.  These will be used when we can prove (through pointer analysis)
  27 // that an indirect call site can call only a specific set of functions.
  28 //
  29 // Because of these properties, the CallGraph captures a conservative superset
  30 // of all of the caller-callee relationships, which is useful for
  31 // transformations.
  32 //
  33 // The CallGraph class also attempts to figure out what the root of the
  34 // CallGraph is, which is currently does by looking for a function named 'main'.
  35 // If no function named 'main' is found, the external node is used as the entry
  36 // node, reflecting the fact that any function without internal linkage could
  37 // be called into (which is common for libraries).
  38 //
  39 //===----------------------------------------------------------------------===//
  40
  41 #include "llvm/Analysis/CallGraph.h"
  42 #include "llvm/Module.h"
  43 #include "llvm/iOther.h"
  44 #include "llvm/iTerminators.h"
  45 #include "Support/STLExtras.h"
  46 #include <algorithm>
  47
  48 static RegisterAnalysis<CallGraph> X("callgraph", "Call Graph Construction");
  49
  50 // getNodeFor - Return the node for the specified function or create one if it
  51 // does not already exist.
  52 //
  53 CallGraphNode *CallGraph::getNodeFor(Function *F) {
  54   CallGraphNode *&CGN = FunctionMap[F];
  55   if (CGN) return CGN;
  56
  57   assert((!F || F->getParent() == Mod) && "Function not in current module!");
  58   return CGN = new CallGraphNode(F);
  59 }
  60
  61 // addToCallGraph - Add a function to the call graph, and link the node to all
  62 // of the functions that it calls.
  63 //
  64 void CallGraph::addToCallGraph(Function *F) {
  65   CallGraphNode *Node = getNodeFor(F);
  66
  67   // If this function has external linkage, anything could call it...
  68   if (!F->hasInternalLinkage()) {
  69     ExternalNode->addCalledFunction(Node);
  70
  71     // Found the entry point?
  72     if (F->getName() == "main") {
  73       if (Root)
  74         Root = ExternalNode;  // Found multiple external mains?  Don't pick one.
  75       else
  76         Root = Node;          // Found a main, keep track of it!
  77     }
  78   }
  79
  80   // If this function is not defined in this translation unit, it could call
  81   // anything.
  82   if (F->isExternal())
  83     Node->addCalledFunction(ExternalNode);
  84
  85   // Loop over all of the users of the function... looking for callers...
  86   //
  87   for (Value::use_iterator I = F->use_begin(), E = F->use_end(); I != E; ++I) {
  88     User *U = *I;
  89     if (CallInst *CI = dyn_cast<CallInst>(U))
  90       getNodeFor(CI->getParent()->getParent())->addCalledFunction(Node);
  91     else if (InvokeInst *II = dyn_cast<InvokeInst>(U))
  92       getNodeFor(II->getParent()->getParent())->addCalledFunction(Node);
  93     else                         // Can't classify the user!
  94       ExternalNode->addCalledFunction(Node);
  95   }
  96
  97   // Look for an indirect function call...
  98   for (Function::iterator BB = F->begin(), BBE = F->end(); BB != BBE; ++BB)
  99     for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE; ++II){
 100       Instruction &I = *II;
 101
 102       if (CallInst *CI = dyn_cast<CallInst>(&I)) {
 103         if (CI->getCalledFunction() == 0)
 104           Node->addCalledFunction(ExternalNode);
 105       } else if (InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 106         if (II->getCalledFunction() == 0)
 107           Node->addCalledFunction(ExternalNode);
 108       }
 109     }
 110 }
 111
 112 bool CallGraph::run(Module &M) {
 113   destroy();
 114
 115   Mod = &M;
 116   ExternalNode = getNodeFor(0);
 117   Root = 0;
 118
 119   // Add every function to the call graph...
 120   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 121     addToCallGraph(I);
 122
 123   // If we didn't find a main function, use the external call graph node
 124   if (Root == 0) Root = ExternalNode;
 125
 126   return false;
 127 }
 128
 129 void CallGraph::destroy() {
 130   for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
 131        I != E; ++I)
 132     delete I->second;
 133   FunctionMap.clear();
 134 }
 135
 136 static void WriteToOutput(const CallGraphNode *CGN, std::ostream &o) {
 137   if (CGN->getFunction())
 138     o << "Call graph node for function: '"
 139       << CGN->getFunction()->getName() <<"'\n";
 140   else
 141     o << "Call graph node <<null function: 0x" << CGN << ">>:\n";
 142
 143   for (unsigned i = 0; i < CGN->size(); ++i)
 144     if ((*CGN)[i]->getFunction())
 145       o << "  Calls function '" << (*CGN)[i]->getFunction()->getName() << "'\n";
 146     else
 147       o << "  Calls external node\n";
 148   o << "\n";
 149 }
 150
 151 void CallGraph::print(std::ostream &o, const Module *M) const {
 152   o << "CallGraph Root is: ";
 153   if (getRoot()->getFunction())
 154     o << getRoot()->getFunction()->getName() << "\n";
 155   else
 156     o << "<<null function: 0x" << getRoot() << ">>\n";
 157
 158   for (CallGraph::const_iterator I = begin(), E = end(); I != E; ++I)
 159     WriteToOutput(I->second, o);
 160 }
 161
 162
 163 //===----------------------------------------------------------------------===//
 164 // Implementations of public modification methods
 165 //
 166
 167 // Functions to keep a call graph up to date with a function that has been
 168 // modified
 169 //
 170 void CallGraph::addFunctionToModule(Function *Meth) {
 171   assert(0 && "not implemented");
 172   abort();
 173 }
 174
 175 // removeFunctionFromModule - Unlink the function from this module, returning
 176 // it.  Because this removes the function from the module, the call graph node
 177 // is destroyed.  This is only valid if the function does not call any other
 178 // functions (ie, there are no edges in it's CGN).  The easiest way to do this
 179 // is to dropAllReferences before calling this.
 180 //
 181 Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
 182   assert(CGN->CalledFunctions.empty() && "Cannot remove function from call "
 183          "graph if it references other functions!");
 184   Function *F = CGN->getFunction(); // Get the function for the call graph node
 185   delete CGN;                       // Delete the call graph node for this func
 186   FunctionMap.erase(F);             // Remove the call graph node from the map
 187
 188   Mod->getFunctionList().remove(F);
 189   return F;
 190 }
 191