lib/Analysis/IPA/CallGraph.cpp

   1 //===- CallGraph.cpp - Build a Module's call graph ------------------------===//
   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 //
  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/IntrinsicInst.h"
  19 #include "llvm/Support/CallSite.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 using namespace llvm;
  23
  24 namespace {
  25
  26 //===----------------------------------------------------------------------===//
  27 // BasicCallGraph class definition
  28 //
  29 class BasicCallGraph : public ModulePass, public CallGraph {
  30   // Root is root of the call graph, or the external node if a 'main' function
  31   // couldn't be found.
  32   //
  33   CallGraphNode *Root;
  34
  35   // ExternalCallingNode - This node has edges to all external functions and
  36   // those internal functions that have their address taken.
  37   CallGraphNode *ExternalCallingNode;
  38
  39   // CallsExternalNode - This node has edges to it from all functions making
  40   // indirect calls or calling an external function.
  41   CallGraphNode *CallsExternalNode;
  42
  43 public:
  44   static char ID; // Class identification, replacement for typeinfo
  45   BasicCallGraph() : ModulePass(&ID), Root(0),
  46     ExternalCallingNode(0), CallsExternalNode(0) {}
  47
  48   // runOnModule - Compute the call graph for the specified module.
  49   virtual bool runOnModule(Module &M) {
  50     CallGraph::initialize(M);
  51
  52     ExternalCallingNode = getOrInsertFunction(0);
  53     CallsExternalNode = new CallGraphNode(0);
  54     Root = 0;
  55
  56     // Add every function to the call graph.
  57     for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  58       addToCallGraph(I);
  59
  60     // If we didn't find a main function, use the external call graph node
  61     if (Root == 0) Root = ExternalCallingNode;
  62
  63     return false;
  64   }
  65
  66   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  67     AU.setPreservesAll();
  68   }
  69
  70   virtual void print(raw_ostream &OS, const Module *) const {
  71     OS << "CallGraph Root is: ";
  72     if (Function *F = getRoot()->getFunction())
  73       OS << F->getName() << "\n";
  74     else {
  75       OS << "<<null function: 0x" << getRoot() << ">>\n";
  76     }
  77
  78     CallGraph::print(OS, 0);
  79   }
  80
  81   virtual void releaseMemory() {
  82     destroy();
  83   }
  84
  85   /// getAdjustedAnalysisPointer - This method is used when a pass implements
  86   /// an analysis interface through multiple inheritance.  If needed, it should
  87   /// override this to adjust the this pointer as needed for the specified pass
  88   /// info.
  89   virtual void *getAdjustedAnalysisPointer(const PassInfo *PI) {
  90     if (PI->isPassID(&CallGraph::ID))
  91       return (CallGraph*)this;
  92     return this;
  93   }
  94
  95   CallGraphNode* getExternalCallingNode() const { return ExternalCallingNode; }
  96   CallGraphNode* getCallsExternalNode()   const { return CallsExternalNode; }
  97
  98   // getRoot - Return the root of the call graph, which is either main, or if
  99   // main cannot be found, the external node.
 100   //
 101   CallGraphNode *getRoot()             { return Root; }
 102   const CallGraphNode *getRoot() const { return Root; }
 103
 104 private:
 105   //===---------------------------------------------------------------------
 106   // Implementation of CallGraph construction
 107   //
 108
 109   // addToCallGraph - Add a function to the call graph, and link the node to all
 110   // of the functions that it calls.
 111   //
 112   void addToCallGraph(Function *F) {
 113     CallGraphNode *Node = getOrInsertFunction(F);
 114
 115     // If this function has external linkage, anything could call it.
 116     if (!F->hasLocalLinkage()) {
 117       ExternalCallingNode->addCalledFunction(CallSite(), Node);
 118
 119       // Found the entry point?
 120       if (F->getName() == "main") {
 121         if (Root)    // Found multiple external mains?  Don't pick one.
 122           Root = ExternalCallingNode;
 123         else
 124           Root = Node;          // Found a main, keep track of it!
 125       }
 126     }
 127
 128     // Loop over all of the users of the function, looking for non-call uses.
 129     for (Value::use_iterator I = F->use_begin(), E = F->use_end(); I != E; ++I)
 130       if ((!isa<CallInst>(I) && !isa<InvokeInst>(I))
 131           || !CallSite(cast<Instruction>(I)).isCallee(I)) {
 132         // Not a call, or being used as a parameter rather than as the callee.
 133         ExternalCallingNode->addCalledFunction(CallSite(), Node);
 134         break;
 135       }
 136
 137     // If this function is not defined in this translation unit, it could call
 138     // anything.
 139     if (F->isDeclaration() && !F->isIntrinsic())
 140       Node->addCalledFunction(CallSite(), CallsExternalNode);
 141
 142     // Look for calls by this function.
 143     for (Function::iterator BB = F->begin(), BBE = F->end(); BB != BBE; ++BB)
 144       for (BasicBlock::iterator II = BB->begin(), IE = BB->end();
 145            II != IE; ++II) {
 146         CallSite CS = CallSite::get(II);
 147         if (CS.getInstruction() && !isa<DbgInfoIntrinsic>(II)) {
 148           const Function *Callee = CS.getCalledFunction();
 149           if (Callee)
 150             Node->addCalledFunction(CS, getOrInsertFunction(Callee));
 151           else
 152             Node->addCalledFunction(CS, CallsExternalNode);
 153         }
 154       }
 155   }
 156
 157   //
 158   // destroy - Release memory for the call graph
 159   virtual void destroy() {
 160     /// CallsExternalNode is not in the function map, delete it explicitly.
 161     if (CallsExternalNode) {
 162       CallsExternalNode->allReferencesDropped();
 163       delete CallsExternalNode;
 164       CallsExternalNode = 0;
 165     }
 166     CallGraph::destroy();
 167   }
 168 };
 169
 170 } //End anonymous namespace
 171
 172 static RegisterAnalysisGroup<CallGraph> X("Call Graph");
 173 static RegisterPass<BasicCallGraph>
 174 Y("basiccg", "Basic CallGraph Construction", false, true);
 175 static RegisterAnalysisGroup<CallGraph, true> Z(Y);
 176
 177 char CallGraph::ID = 0;
 178 char BasicCallGraph::ID = 0;
 179
 180 void CallGraph::initialize(Module &M) {
 181   Mod = &M;
 182 }
 183
 184 void CallGraph::destroy() {
 185   if (FunctionMap.empty()) return;
 186
 187   // Reset all node's use counts to zero before deleting them to prevent an
 188   // assertion from firing.
 189 #ifndef NDEBUG
 190   for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
 191        I != E; ++I)
 192     I->second->allReferencesDropped();
 193 #endif
 194
 195   for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
 196       I != E; ++I)
 197     delete I->second;
 198   FunctionMap.clear();
 199 }
 200
 201 void CallGraph::print(raw_ostream &OS, Module*) const {
 202   for (CallGraph::const_iterator I = begin(), E = end(); I != E; ++I)
 203     I->second->print(OS);
 204 }
 205 void CallGraph::dump() const {
 206   print(dbgs(), 0);
 207 }
 208
 209 //===----------------------------------------------------------------------===//
 210 // Implementations of public modification methods
 211 //
 212
 213 // removeFunctionFromModule - Unlink the function from this module, returning
 214 // it.  Because this removes the function from the module, the call graph node
 215 // is destroyed.  This is only valid if the function does not call any other
 216 // functions (ie, there are no edges in it's CGN).  The easiest way to do this
 217 // is to dropAllReferences before calling this.
 218 //
 219 Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
 220   assert(CGN->empty() && "Cannot remove function from call "
 221          "graph if it references other functions!");
 222   Function *F = CGN->getFunction(); // Get the function for the call graph node
 223   delete CGN;                       // Delete the call graph node for this func
 224   FunctionMap.erase(F);             // Remove the call graph node from the map
 225
 226   Mod->getFunctionList().remove(F);
 227   return F;
 228 }
 229
 230 // getOrInsertFunction - This method is identical to calling operator[], but
 231 // it will insert a new CallGraphNode for the specified function if one does
 232 // not already exist.
 233 CallGraphNode *CallGraph::getOrInsertFunction(const Function *F) {
 234   CallGraphNode *&CGN = FunctionMap[F];
 235   if (CGN) return CGN;
 236
 237   assert((!F || F->getParent() == Mod) && "Function not in current module!");
 238   return CGN = new CallGraphNode(const_cast<Function*>(F));
 239 }
 240
 241 void CallGraphNode::print(raw_ostream &OS) const {
 242   if (Function *F = getFunction())
 243     OS << "Call graph node for function: '" << F->getName() << "'";
 244   else
 245     OS << "Call graph node <<null function>>";
 246
 247   OS << "<<0x" << this << ">>  #uses=" << getNumReferences() << '\n';
 248
 249   for (const_iterator I = begin(), E = end(); I != E; ++I)
 250     if (Function *FI = I->second->getFunction())
 251       OS << "  Calls function '" << FI->getName() <<"'\n";
 252   else
 253     OS << "  Calls external node\n";
 254   OS << "\n";
 255 }
 256
 257 void CallGraphNode::dump() const { print(dbgs()); }
 258
 259 /// removeCallEdgeFor - This method removes the edge in the node for the
 260 /// specified call site.  Note that this method takes linear time, so it
 261 /// should be used sparingly.
 262 void CallGraphNode::removeCallEdgeFor(CallSite CS) {
 263   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 264     assert(I != CalledFunctions.end() && "Cannot find callsite to remove!");
 265     if (I->first == CS.getInstruction()) {
 266       I->second->DropRef();
 267       *I = CalledFunctions.back();
 268       CalledFunctions.pop_back();
 269       return;
 270     }
 271   }
 272 }
 273
 274
 275 // removeAnyCallEdgeTo - This method removes any call edges from this node to
 276 // the specified callee function.  This takes more time to execute than
 277 // removeCallEdgeTo, so it should not be used unless necessary.
 278 void CallGraphNode::removeAnyCallEdgeTo(CallGraphNode *Callee) {
 279   for (unsigned i = 0, e = CalledFunctions.size(); i != e; ++i)
 280     if (CalledFunctions[i].second == Callee) {
 281       Callee->DropRef();
 282       CalledFunctions[i] = CalledFunctions.back();
 283       CalledFunctions.pop_back();
 284       --i; --e;
 285     }
 286 }
 287
 288 /// removeOneAbstractEdgeTo - Remove one edge associated with a null callsite
 289 /// from this node to the specified callee function.
 290 void CallGraphNode::removeOneAbstractEdgeTo(CallGraphNode *Callee) {
 291   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 292     assert(I != CalledFunctions.end() && "Cannot find callee to remove!");
 293     CallRecord &CR = *I;
 294     if (CR.second == Callee && CR.first == 0) {
 295       Callee->DropRef();
 296       *I = CalledFunctions.back();
 297       CalledFunctions.pop_back();
 298       return;
 299     }
 300   }
 301 }
 302
 303 /// replaceCallEdge - This method replaces the edge in the node for the
 304 /// specified call site with a new one.  Note that this method takes linear
 305 /// time, so it should be used sparingly.
 306 void CallGraphNode::replaceCallEdge(CallSite CS,
 307                                     CallSite NewCS, CallGraphNode *NewNode){
 308   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 309     assert(I != CalledFunctions.end() && "Cannot find callsite to remove!");
 310     if (I->first == CS.getInstruction()) {
 311       I->second->DropRef();
 312       I->first = NewCS.getInstruction();
 313       I->second = NewNode;
 314       NewNode->AddRef();
 315       return;
 316     }
 317   }
 318 }
 319
 320 // Enuse that users of CallGraph.h also link with this file
 321 DEFINING_FILE_FOR(CallGraph)