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 AnalysisID CallGraph::ID = X;
  50
  51 // getNodeFor - Return the node for the specified function or create one if it
  52 // does not already exist.
  53 //
  54 CallGraphNode *CallGraph::getNodeFor(Function *F) {
  55   CallGraphNode *&CGN = FunctionMap[F];
  56   if (CGN) return CGN;
  57
  58   assert((!F || F->getParent() == Mod) && "Function not in current module!");
  59   return CGN = new CallGraphNode(F);
  60 }
  61
  62 // addToCallGraph - Add a function to the call graph, and link the node to all
  63 // of the functions that it calls.
  64 //
  65 void CallGraph::addToCallGraph(Function *M) {
  66   CallGraphNode *Node = getNodeFor(M);
  67
  68   // If this function has external linkage,
  69   if (!M->hasInternalLinkage()) {
  70     ExternalNode->addCalledFunction(Node);
  71
  72     // Found the entry point?
  73     if (M->getName() == "main") {
  74       if (Root)
  75         Root = ExternalNode;  // Found multiple external mains?  Don't pick one.
  76       else
  77         Root = Node;          // Found a main, keep track of it!
  78     }
  79   } else if (M->isExternal()) { // Not defined in this xlation unit?
  80     Node->addCalledFunction(ExternalNode);  // It could call anything...
  81   }
  82
  83   // Loop over all of the users of the function... looking for callers...
  84   //
  85   for (Value::use_iterator I = M->use_begin(), E = M->use_end(); I != E; ++I) {
  86     User *U = *I;
  87     if (CallInst *CI = dyn_cast<CallInst>(U))
  88       getNodeFor(CI->getParent()->getParent())->addCalledFunction(Node);
  89     else if (InvokeInst *II = dyn_cast<InvokeInst>(U))
  90       getNodeFor(II->getParent()->getParent())->addCalledFunction(Node);
  91     else                         // Can't classify the user!
  92       ExternalNode->addCalledFunction(Node);
  93   }
  94
  95   // Look for an indirect function call...
  96   for (Function::iterator BB = M->begin(), BBE = M->end(); BB != BBE; ++BB)
  97     for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE; ++II){
  98       Instruction &I = *II;
  99
 100       if (CallInst *CI = dyn_cast<CallInst>(&I)) {
 101         if (CI->getCalledFunction() == 0)
 102           Node->addCalledFunction(ExternalNode);
 103       } else if (InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 104         if (II->getCalledFunction() == 0)
 105           Node->addCalledFunction(ExternalNode);
 106       }
 107     }
 108 }
 109
 110 bool CallGraph::run(Module &M) {
 111   destroy();
 112
 113   Mod = &M;
 114   ExternalNode = getNodeFor(0);
 115   Root = 0;
 116
 117   // Add every function to the call graph...
 118   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 119     addToCallGraph(I);
 120
 121   // If we didn't find a main function, use the external call graph node
 122   if (Root == 0) Root = ExternalNode;
 123
 124   return false;
 125 }
 126
 127 void CallGraph::destroy() {
 128   for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
 129        I != E; ++I)
 130     delete I->second;
 131   FunctionMap.clear();
 132 }
 133
 134
 135 void WriteToOutput(const CallGraphNode *CGN, std::ostream &o) {
 136   if (CGN->getFunction())
 137     o << "Call graph node for function: '"
 138       << CGN->getFunction()->getName() <<"'\n";
 139   else
 140     o << "Call graph node null function:\n";
 141
 142   for (unsigned i = 0; i < CGN->size(); ++i)
 143     if ((*CGN)[i]->getFunction())
 144       o << "  Calls function '" << (*CGN)[i]->getFunction()->getName() << "'\n";
 145     else
 146       o << "  Calls external node\n";
 147   o << "\n";
 148 }
 149
 150 void WriteToOutput(const CallGraph &CG, std::ostream &o) {
 151   o << "CallGraph Root is:\n" << CG.getRoot();
 152
 153   for (CallGraph::const_iterator I = CG.begin(), E = CG.end(); I != E; ++I)
 154     o << I->second;
 155 }
 156
 157
 158 //===----------------------------------------------------------------------===//
 159 // Implementations of public modification methods
 160 //
 161
 162 // Functions to keep a call graph up to date with a function that has been
 163 // modified
 164 //
 165 void CallGraph::addFunctionToModule(Function *Meth) {
 166   assert(0 && "not implemented");
 167   abort();
 168 }
 169
 170 // removeFunctionFromModule - Unlink the function from this module, returning
 171 // it.  Because this removes the function from the module, the call graph node
 172 // is destroyed.  This is only valid if the function does not call any other
 173 // functions (ie, there are no edges in it's CGN).  The easiest way to do this
 174 // is to dropAllReferences before calling this.
 175 //
 176 Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
 177   assert(CGN->CalledFunctions.empty() && "Cannot remove function from call "
 178          "graph if it references other functions!");
 179   Function *M = CGN->getFunction(); // Get the function for the call graph node
 180   delete CGN;                       // Delete the call graph node for this func
 181   FunctionMap.erase(M);             // Remove the call graph node from the map
 182
 183   Mod->getFunctionList().remove(M);
 184   return M;
 185 }
 186