Add standard print/dump methods to CallGraph classes.
[oota-llvm.git] / lib / Analysis / IPA / CallGraph.cpp
index 51072e77abd9b6dcb2122ece0b1a137189f6072b..8025ab2d9acdeab812b796fabe766ad1ccffc2cd 100644 (file)
-//===- CallGraph.cpp - Build a Module's call graph --------------------------=//
+//===- CallGraph.cpp - Build a Module's call graph ------------------------===//
+// 
+//                     The LLVM Compiler Infrastructure
 //
-// This file implements call graph construction (from a module), and will
-// eventually implement call graph serialization and deserialization for
-// annotation support.
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
-// This call graph represents a dynamic method invocation as a null method node.
-// A call graph may only have up to one null method node that represents all of
-// the dynamic method invocations.
+//  This file implements the CallGraph class.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Analysis/CallGraph.h"
-#include "llvm/Analysis/Writer.h"
-#include "llvm/Support/STLExtras.h"
+#include "llvm/Constants.h"     // Remove when ConstantPointerRefs are gone
 #include "llvm/Module.h"
-#include "llvm/Method.h"
-#include "llvm/iOther.h"
-#include "llvm/iTerminators.h"
-#include <algorithm>
+#include "llvm/Instructions.h"
+#include "llvm/Support/CallSite.h"
+#include "Support/STLExtras.h"
+#include <iostream>
+using namespace llvm;
 
-using namespace cfg;
+static RegisterAnalysis<CallGraph> X("callgraph", "Call Graph Construction");
 
-// getNodeFor - Return the node for the specified method or create one if it
+// getNodeFor - Return the node for the specified function or create one if it
 // does not already exist.
 //
-CallGraphNode *CallGraph::getNodeFor(Method *M) {
-  iterator I = MethodMap.find(M);
-  if (I != MethodMap.end()) return I->second;
+CallGraphNode *CallGraph::getNodeFor(Function *F) {
+  CallGraphNode *&CGN = FunctionMap[F];
+  if (CGN) return CGN;
 
-  assert(M->getParent() == Mod && "Method not in current module!");
-  CallGraphNode *New = new CallGraphNode(M);
+  assert((!F || F->getParent() == Mod) && "Function not in current module!");
+  return CGN = new CallGraphNode(F);
+}
 
-  MethodMap.insert(pair<const Method*, CallGraphNode*>(M, New));
-  return New;
+static bool isOnlyADirectCall(Function *F, CallSite CS) {
+  if (!CS.getInstruction()) return false;
+  for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; ++I)
+    if (*I == F) return false;
+  return true;
 }
 
-// addToCallGraph - Add a method to the call graph, and link the node to all of
-// the methods that it calls.
+// addToCallGraph - Add a function to the call graph, and link the node to all
+// of the functions that it calls.
 //
-void CallGraph::addToCallGraph(Method *M) {
-  CallGraphNode *Node = getNodeFor(M);
-
-  for (Method::inst_iterator I = M->inst_begin(), E = M->inst_end();
-       I != E; ++I) {
-    // Dynamic calls will cause Null nodes to be created
-    if (CallInst *CI = dyn_cast<CallInst>(*I))
-      Node->addCalledMethod(getNodeFor(CI->getCalledMethod()));
-    else if (InvokeInst *II = dyn_cast<InvokeInst>(*I))
-      Node->addCalledMethod(getNodeFor(II->getCalledMethod()));
+void CallGraph::addToCallGraph(Function *F) {
+  CallGraphNode *Node = getNodeFor(F);
+
+  // If this function has external linkage, anything could call it...
+  if (!F->hasInternalLinkage()) {
+    ExternalCallingNode->addCalledFunction(Node);
+
+    // Found the entry point?
+    if (F->getName() == "main") {
+      if (Root)    // Found multiple external mains?  Don't pick one.
+        Root = ExternalCallingNode;
+      else
+        Root = Node;          // Found a main, keep track of it!
+    }
+  }
+  
+  // If this function is not defined in this translation unit, it could call
+  // anything.
+  if (F->isExternal() && !F->getIntrinsicID())
+    Node->addCalledFunction(CallsExternalNode);
+
+  // Loop over all of the users of the function... looking for callers...
+  //
+  bool isUsedExternally = false;
+  for (Value::use_iterator I = F->use_begin(), E = F->use_end(); I != E; ++I) {
+    if (Instruction *Inst = dyn_cast<Instruction>(*I)) {
+      if (isOnlyADirectCall(F, CallSite::get(Inst)))
+        getNodeFor(Inst->getParent()->getParent())->addCalledFunction(Node);
+      else
+        isUsedExternally = true;
+    } else if (GlobalValue *GV = dyn_cast<GlobalValue>(*I)) {
+      for (Value::use_iterator I = GV->use_begin(), E = GV->use_end();
+           I != E; ++I)
+        if (Instruction *Inst = dyn_cast<Instruction>(*I)) {
+          if (isOnlyADirectCall(F, CallSite::get(Inst)))
+            getNodeFor(Inst->getParent()->getParent())->addCalledFunction(Node);
+          else
+            isUsedExternally = true;
+        } else {
+          isUsedExternally = true;
+        }
+    } else {                        // Can't classify the user!
+      isUsedExternally = true;
+    }
   }
+  if (isUsedExternally)
+    ExternalCallingNode->addCalledFunction(Node);
+
+  // Look for an indirect function call...
+  for (Function::iterator BB = F->begin(), BBE = F->end(); BB != BBE; ++BB)
+    for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE; ++II){
+      CallSite CS = CallSite::get(II);
+      if (CS.getInstruction() && !CS.getCalledFunction())
+        Node->addCalledFunction(CallsExternalNode);
+    }
 }
 
-CallGraph::CallGraph(Module *TheModule) {
-  Mod = TheModule;
+bool CallGraph::run(Module &M) {
+  destroy();
+
+  Mod = &M;
+  ExternalCallingNode = getNodeFor(0);
+  CallsExternalNode = new CallGraphNode(0);
+  Root = 0;
 
-  // Add every method to the call graph...
-  for_each(Mod->begin(), Mod->end(), bind_obj(this,&CallGraph::addToCallGraph));
+  // Add every function to the call graph...
+  for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
+    addToCallGraph(I);
+
+  // If we didn't find a main function, use the external call graph node
+  if (Root == 0) Root = ExternalCallingNode;
+  
+  return false;
 }
 
+void CallGraph::destroy() {
+  for (FunctionMapTy::iterator I = FunctionMap.begin(), E = FunctionMap.end();
+       I != E; ++I)
+    delete I->second;
+  FunctionMap.clear();
+  delete CallsExternalNode;
+  CallsExternalNode = 0;
+}
 
-void cfg::WriteToOutput(const CallGraphNode *CGN, ostream &o) {
-  o << "Call graph node for method: '" << CGN->getMethod()->getName() << "'\n";
-  for (unsigned i = 0; i < CGN->size(); ++i)
-    o << "  Calls method '" << (*CGN)[i]->getMethod()->getName() << "'\n";
-  o << endl;
+void CallGraphNode::print(std::ostream &OS) const {
+  if (Function *F = getFunction())
+    OS << "Call graph node for function: '" << F->getName() <<"'\n";
+  else
+    OS << "Call graph node <<null function: 0x" << this << ">>:\n";
+
+  for (const_iterator I = begin(), E = end(); I != E; ++I)
+    if ((*I)->getFunction())
+      OS << "  Calls function '" << (*I)->getFunction()->getName() << "'\n";
+    else
+      OS << "  Calls external node\n";
+  OS << "\n";
 }
 
-void cfg::WriteToOutput(const CallGraph &CG, ostream &o) {
-  for (CallGraph::const_iterator I = CG.begin(), E = CG.end(); I != E; ++I)
-    o << I->second;
+void CallGraphNode::dump() const { print(std::cerr); }
+
+void CallGraph::print(std::ostream &OS, const Module *M) const {
+  OS << "CallGraph Root is: ";
+  if (Function *F = getRoot()->getFunction())
+    OS << F->getName() << "\n";
+  else
+    OS << "<<null function: 0x" << getRoot() << ">>\n";
+  
+  for (CallGraph::const_iterator I = begin(), E = end(); I != E; ++I)
+    I->second->print(OS);
 }
 
+void CallGraph::dump() const {
+  print(std::cerr, 0);
+}
 
 
-// 
-// Checks if a method contains any call instructions.
-// Note that this uses the call graph only if one is provided.
-// It does not build the call graph.
-// 
-bool IsLeafMethod(const Method* M, const cfg::CallGraph* CG) {
-  if (CG) {
-    const cfg::CallGraphNode *cgn = (*CG)[M];
-    return (cgn->begin() == cgn->end());
-  }
-  else {
-    for (Method::inst_const_iterator I = M->inst_begin(), E = M->inst_end();
-         I != E; ++I)
-      if ((*I)->getOpcode() == Instruction::Call)
-        return false;
-    return true;
-  }
+//===----------------------------------------------------------------------===//
+// Implementations of public modification methods
+//
+
+// Functions to keep a call graph up to date with a function that has been
+// modified
+//
+void CallGraph::addFunctionToModule(Function *F) {
+  assert(0 && "not implemented");
+  abort();
 }
 
+// removeFunctionFromModule - Unlink the function from this module, returning
+// it.  Because this removes the function from the module, the call graph node
+// is destroyed.  This is only valid if the function does not call any other
+// functions (ie, there are no edges in it's CGN).  The easiest way to do this
+// is to dropAllReferences before calling this.
+//
+Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
+  assert(CGN->CalledFunctions.empty() && "Cannot remove function from call "
+         "graph if it references other functions!");
+  Function *F = CGN->getFunction(); // Get the function for the call graph node
+  delete CGN;                       // Delete the call graph node for this func
+  FunctionMap.erase(F);             // Remove the call graph node from the map
+
+  Mod->getFunctionList().remove(F);
+  return F;
+}
+
+void CallGraph::stub() {}
 
+void CallGraphNode::removeCallEdgeTo(CallGraphNode *Callee) {
+  for (unsigned i = CalledFunctions.size(); ; --i) {
+    assert(i && "Cannot find callee to remove!");
+    if (CalledFunctions[i-1] == Callee) {
+      CalledFunctions.erase(CalledFunctions.begin()+i-1);
+      return;
+    }
+  }
+}