lib/Analysis/IPA/CallGraph.cpp

   1 //===- CallGraph.cpp - Build a Module's call graph ------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the CallGraph class and provides the BasicCallGraph
  11 // default implementation.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/CallGraph.h"
  16 #include "llvm/Module.h"
  17 #include "llvm/Instructions.h"
  18 #include "llvm/Support/CallSite.h"
  19 #include "llvm/Support/Streams.h"
  20 #include <ostream>
  21 using namespace llvm;
  22
  23 /// isOnlyADirectCall - Return true if this callsite is *just* a direct call to
  24 /// the specified function.  Specifically return false if the callsite also
  25 /// takes the address of the function.
  26 static bool isOnlyADirectCall(Function *F, CallSite CS) {
  27   if (!CS.getInstruction()) return false;
  28   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; ++I)
  29     if (*I == F) return false;
  30   return true;
  31 }
  32
  33 namespace {
  34
  35 //===----------------------------------------------------------------------===//
  36 // BasicCallGraph class definition
  37 //
  38 class BasicCallGraph : public CallGraph, public ModulePass {
  39   // Root is root of the call graph, or the external node if a 'main' function
  40   // couldn't be found.
  41   //
  42   CallGraphNode *Root;
  43
  44   // ExternalCallingNode - This node has edges to all external functions and
  45   // those internal functions that have their address taken.
  46   CallGraphNode *ExternalCallingNode;
  47
  48   // CallsExternalNode - This node has edges to it from all functions making
  49   // indirect calls or calling an external function.
  50   CallGraphNode *CallsExternalNode;
  51
  52 public:
  53   BasicCallGraph() : Root(0), ExternalCallingNode(0), CallsExternalNode(0) {}
  54
  55   // runOnModule - Compute the call graph for the specified module.
  56   virtual bool runOnModule(Module &M) {
  57     CallGraph::initialize(M);
  58
  59     ExternalCallingNode = getOrInsertFunction(0);
  60     CallsExternalNode = new CallGraphNode(0);
  61     Root = 0;
  62
  63     // Add every function to the call graph...
  64     for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  65       addToCallGraph(I);
  66
  67     // If we didn't find a main function, use the external call graph node
  68     if (Root == 0) Root = ExternalCallingNode;
  69
  70     return false;
  71   }
  72
  73   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  74     AU.setPreservesAll();
  75   }
  76
  77   void print(OStream &o, const Module *M) const {
  78     if (o.stream()) print(*o.stream(), M);
  79   }
  80
  81   virtual void print(std::ostream &o, const Module *M) const {
  82     o << "CallGraph Root is: ";
  83     if (Function *F = getRoot()->getFunction())
  84       o << F->getName() << "\n";
  85     else
  86       o << "<<null function: 0x" << getRoot() << ">>\n";
  87
  88     CallGraph::print(o, M);
  89   }
  90
  91   virtual void releaseMemory() {
  92     destroy();
  93   }
  94
  95   /// dump - Print out this call graph.
  96   ///
  97   inline void dump() const {
  98     print(cerr, Mod);
  99   }
 100
 101   CallGraphNode* getExternalCallingNode() const { return ExternalCallingNode; }
 102   CallGraphNode* getCallsExternalNode()   const { return CallsExternalNode; }
 103
 104   // getRoot - Return the root of the call graph, which is either main, or if
 105   // main cannot be found, the external node.
 106   //
 107   CallGraphNode *getRoot()             { return Root; }
 108   const CallGraphNode *getRoot() const { return Root; }
 109
 110 private:
 111   //===---------------------------------------------------------------------
 112   // Implementation of CallGraph construction
 113   //
 114
 115   // addToCallGraph - Add a function to the call graph, and link the node to all
 116   // of the functions that it calls.
 117   //
 118   void addToCallGraph(Function *F) {
 119     CallGraphNode *Node = getOrInsertFunction(F);
 120
 121     // If this function has external linkage, anything could call it.
 122     if (!F->hasInternalLinkage()) {
 123       ExternalCallingNode->addCalledFunction(CallSite(), Node);
 124
 125       // Found the entry point?
 126       if (F->getName() == "main") {
 127         if (Root)    // Found multiple external mains?  Don't pick one.
 128           Root = ExternalCallingNode;
 129         else
 130           Root = Node;          // Found a main, keep track of it!
 131       }
 132     }
 133
 134     // If this function is not defined in this translation unit, it could call
 135     // anything.
 136     if (F->isExternal() && !F->getIntrinsicID())
 137       Node->addCalledFunction(CallSite(), CallsExternalNode);
 138
 139     // Loop over all of the users of the function... looking for callers...
 140     //
 141     bool isUsedExternally = false;
 142     for (Value::use_iterator I = F->use_begin(), E = F->use_end(); I != E; ++I){
 143       if (Instruction *Inst = dyn_cast<Instruction>(*I)) {
 144         CallSite CS = CallSite::get(Inst);
 145         if (isOnlyADirectCall(F, CS))
 146           getOrInsertFunction(Inst->getParent()->getParent())
 147               ->addCalledFunction(CS, Node);
 148         else
 149           isUsedExternally = true;
 150       } else if (GlobalValue *GV = dyn_cast<GlobalValue>(*I)) {
 151         for (Value::use_iterator I = GV->use_begin(), E = GV->use_end();
 152              I != E; ++I)
 153           if (Instruction *Inst = dyn_cast<Instruction>(*I)) {
 154             CallSite CS = CallSite::get(Inst);
 155             if (isOnlyADirectCall(F, CS))
 156               getOrInsertFunction(Inst->getParent()->getParent())
 157                 ->addCalledFunction(CS, Node);
 158             else
 159               isUsedExternally = true;
 160           } else {
 161             isUsedExternally = true;
 162           }
 163       } else {                        // Can't classify the user!
 164         isUsedExternally = true;
 165       }
 166     }
 167     if (isUsedExternally)
 168       ExternalCallingNode->addCalledFunction(CallSite(), Node);
 169
 170     // Look for an indirect function call.
 171     for (Function::iterator BB = F->begin(), BBE = F->end(); BB != BBE; ++BB)
 172       for (BasicBlock::iterator II = BB->begin(), IE = BB->end();
 173            II != IE; ++II) {
 174       CallSite CS = CallSite::get(II);
 175       if (CS.getInstruction() && !CS.getCalledFunction())
 176         Node->addCalledFunction(CS, CallsExternalNode);
 177       }
 178   }
 179
 180   //
 181   // destroy - Release memory for the call graph
 182   virtual void destroy() {
 183     /// CallsExternalNode is not in the function map, delete it explicitly.
 184     delete CallsExternalNode;
 185     CallsExternalNode = 0;
 186     CallGraph::destroy();
 187   }
 188 };
 189
 190 RegisterAnalysisGroup<CallGraph> X("Call Graph");
 191 RegisterPass<BasicCallGraph> Y("basiccg", "Basic CallGraph Construction");
 192 RegisterAnalysisGroup<CallGraph, true> Z(Y);
 193
 194 } //End anonymous namespace
 195
 196 void CallGraph::initialize(Module &M) {
 197   Mod = &M;
 198 }
 199
 200 void CallGraph::destroy() {
 201   if (!FunctionMap.empty()) {
 202     for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
 203         I != E; ++I)
 204       delete I->second;
 205     FunctionMap.clear();
 206   }
 207 }
 208
 209 void CallGraph::print(std::ostream &OS, const Module *M) const {
 210   for (CallGraph::const_iterator I = begin(), E = end(); I != E; ++I)
 211     I->second->print(OS);
 212 }
 213
 214 void CallGraph::dump() const {
 215   print(cerr, 0);
 216 }
 217
 218 //===----------------------------------------------------------------------===//
 219 // Implementations of public modification methods
 220 //
 221
 222 // removeFunctionFromModule - Unlink the function from this module, returning
 223 // it.  Because this removes the function from the module, the call graph node
 224 // is destroyed.  This is only valid if the function does not call any other
 225 // functions (ie, there are no edges in it's CGN).  The easiest way to do this
 226 // is to dropAllReferences before calling this.
 227 //
 228 Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
 229   assert(CGN->CalledFunctions.empty() && "Cannot remove function from call "
 230          "graph if it references other functions!");
 231   Function *F = CGN->getFunction(); // Get the function for the call graph node
 232   delete CGN;                       // Delete the call graph node for this func
 233   FunctionMap.erase(F);             // Remove the call graph node from the map
 234
 235   Mod->getFunctionList().remove(F);
 236   return F;
 237 }
 238
 239 // changeFunction - This method changes the function associated with this
 240 // CallGraphNode, for use by transformations that need to change the prototype
 241 // of a Function (thus they must create a new Function and move the old code
 242 // over).
 243 void CallGraph::changeFunction(Function *OldF, Function *NewF) {
 244   iterator I = FunctionMap.find(OldF);
 245   CallGraphNode *&New = FunctionMap[NewF];
 246   assert(I != FunctionMap.end() && I->second && !New &&
 247          "OldF didn't exist in CG or NewF already does!");
 248   New = I->second;
 249   New->F = NewF;
 250   FunctionMap.erase(I);
 251 }
 252
 253 // getOrInsertFunction - This method is identical to calling operator[], but
 254 // it will insert a new CallGraphNode for the specified function if one does
 255 // not already exist.
 256 CallGraphNode *CallGraph::getOrInsertFunction(const Function *F) {
 257   CallGraphNode *&CGN = FunctionMap[F];
 258   if (CGN) return CGN;
 259
 260   assert((!F || F->getParent() == Mod) && "Function not in current module!");
 261   return CGN = new CallGraphNode(const_cast<Function*>(F));
 262 }
 263
 264 void CallGraphNode::print(std::ostream &OS) const {
 265   if (Function *F = getFunction())
 266     OS << "Call graph node for function: '" << F->getName() <<"'\n";
 267   else
 268     OS << "Call graph node <<null function: 0x" << this << ">>:\n";
 269
 270   for (const_iterator I = begin(), E = end(); I != E; ++I)
 271     if (I->second->getFunction())
 272       OS << "  Calls function '" << I->second->getFunction()->getName() <<"'\n";
 273   else
 274     OS << "  Calls external node\n";
 275   OS << "\n";
 276 }
 277
 278 void CallGraphNode::dump() const { print(cerr); }
 279
 280 void CallGraphNode::removeCallEdgeTo(CallGraphNode *Callee) {
 281   for (unsigned i = CalledFunctions.size(); ; --i) {
 282     assert(i && "Cannot find callee to remove!");
 283     if (CalledFunctions[i-1].second == Callee) {
 284       CalledFunctions.erase(CalledFunctions.begin()+i-1);
 285       return;
 286     }
 287   }
 288 }
 289
 290 // removeAnyCallEdgeTo - This method removes any call edges from this node to
 291 // the specified callee function.  This takes more time to execute than
 292 // removeCallEdgeTo, so it should not be used unless necessary.
 293 void CallGraphNode::removeAnyCallEdgeTo(CallGraphNode *Callee) {
 294   for (unsigned i = 0, e = CalledFunctions.size(); i != e; ++i)
 295     if (CalledFunctions[i].second == Callee) {
 296       CalledFunctions[i] = CalledFunctions.back();
 297       CalledFunctions.pop_back();
 298       --i; --e;
 299     }
 300 }
 301
 302 // Enuse that users of CallGraph.h also link with this file
 303 DEFINING_FILE_FOR(CallGraph)