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 #include "llvm/Analysis/CallGraph.h"
  11 #include "llvm/IR/CallSite.h"
  12 #include "llvm/IR/Instructions.h"
  13 #include "llvm/IR/IntrinsicInst.h"
  14 #include "llvm/IR/Module.h"
  15 #include "llvm/Support/Debug.h"
  16 #include "llvm/Support/raw_ostream.h"
  17 using namespace llvm;
  18
  19 //===----------------------------------------------------------------------===//
  20 // Implementations of the CallGraph class methods.
  21 //
  22
  23 CallGraph::CallGraph(Module &M)
  24     : M(M), Root(nullptr), ExternalCallingNode(getOrInsertFunction(nullptr)),
  25       CallsExternalNode(new CallGraphNode(nullptr)) {
  26   // Add every function to the call graph.
  27   for (Function &F : M)
  28     addToCallGraph(&F);
  29
  30   // If we didn't find a main function, use the external call graph node
  31   if (!Root)
  32     Root = ExternalCallingNode;
  33 }
  34
  35 CallGraph::~CallGraph() {
  36   // CallsExternalNode is not in the function map, delete it explicitly.
  37   CallsExternalNode->allReferencesDropped();
  38   delete CallsExternalNode;
  39
  40 // Reset all node's use counts to zero before deleting them to prevent an
  41 // assertion from firing.
  42 #ifndef NDEBUG
  43   for (auto &I : FunctionMap)
  44     I.second->allReferencesDropped();
  45 #endif
  46   for (auto &I : FunctionMap)
  47     delete I.second;
  48 }
  49
  50 void CallGraph::addToCallGraph(Function *F) {
  51   CallGraphNode *Node = getOrInsertFunction(F);
  52
  53   // If this function has external linkage, anything could call it.
  54   if (!F->hasLocalLinkage()) {
  55     ExternalCallingNode->addCalledFunction(CallSite(), Node);
  56
  57     // Found the entry point?
  58     if (F->getName() == "main") {
  59       if (Root) // Found multiple external mains?  Don't pick one.
  60         Root = ExternalCallingNode;
  61       else
  62         Root = Node; // Found a main, keep track of it!
  63     }
  64   }
  65
  66   // If this function has its address taken, anything could call it.
  67   if (F->hasAddressTaken())
  68     ExternalCallingNode->addCalledFunction(CallSite(), Node);
  69
  70   // If this function is not defined in this translation unit, it could call
  71   // anything.
  72   if (F->isDeclaration() && !F->isIntrinsic())
  73     Node->addCalledFunction(CallSite(), CallsExternalNode);
  74
  75   // Look for calls by this function.
  76   for (Function::iterator BB = F->begin(), BBE = F->end(); BB != BBE; ++BB)
  77     for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE;
  78          ++II) {
  79       CallSite CS(cast<Value>(II));
  80       if (CS) {
  81         const Function *Callee = CS.getCalledFunction();
  82         if (!Callee || !Intrinsic::isLeaf(Callee->getIntrinsicID()))
  83           // Indirect calls of intrinsics are not allowed so no need to check.
  84           // We can be more precise here by using TargetArg returned by
  85           // Intrinsic::isLeaf.
  86           Node->addCalledFunction(CS, CallsExternalNode);
  87         else if (!Callee->isIntrinsic())
  88           Node->addCalledFunction(CS, getOrInsertFunction(Callee));
  89       }
  90     }
  91 }
  92
  93 void CallGraph::print(raw_ostream &OS) const {
  94   OS << "CallGraph Root is: ";
  95   if (Function *F = Root->getFunction())
  96     OS << F->getName() << "\n";
  97   else {
  98     OS << "<<null function: 0x" << Root << ">>\n";
  99   }
 100
 101   // Print in a deterministic order by sorting CallGraphNodes by name.  We do
 102   // this here to avoid slowing down the non-printing fast path.
 103
 104   SmallVector<CallGraphNode *, 16> Nodes;
 105   Nodes.reserve(FunctionMap.size());
 106
 107   for (auto I = begin(), E = end(); I != E; ++I)
 108     Nodes.push_back(I->second);
 109
 110   std::sort(Nodes.begin(), Nodes.end(),
 111             [](CallGraphNode *LHS, CallGraphNode *RHS) {
 112     if (Function *LF = LHS->getFunction())
 113       if (Function *RF = RHS->getFunction())
 114         return LF->getName() < RF->getName();
 115
 116     return RHS->getFunction() != nullptr;
 117   });
 118
 119   for (CallGraphNode *CN : Nodes)
 120     CN->print(OS);
 121 }
 122
 123 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 124 void CallGraph::dump() const { print(dbgs()); }
 125 #endif
 126
 127 // removeFunctionFromModule - Unlink the function from this module, returning
 128 // it.  Because this removes the function from the module, the call graph node
 129 // is destroyed.  This is only valid if the function does not call any other
 130 // functions (ie, there are no edges in it's CGN).  The easiest way to do this
 131 // is to dropAllReferences before calling this.
 132 //
 133 Function *CallGraph::removeFunctionFromModule(CallGraphNode *CGN) {
 134   assert(CGN->empty() && "Cannot remove function from call "
 135          "graph if it references other functions!");
 136   Function *F = CGN->getFunction(); // Get the function for the call graph node
 137   delete CGN;                       // Delete the call graph node for this func
 138   FunctionMap.erase(F);             // Remove the call graph node from the map
 139
 140   M.getFunctionList().remove(F);
 141   return F;
 142 }
 143
 144 /// spliceFunction - Replace the function represented by this node by another.
 145 /// This does not rescan the body of the function, so it is suitable when
 146 /// splicing the body of the old function to the new while also updating all
 147 /// callers from old to new.
 148 ///
 149 void CallGraph::spliceFunction(const Function *From, const Function *To) {
 150   assert(FunctionMap.count(From) && "No CallGraphNode for function!");
 151   assert(!FunctionMap.count(To) &&
 152          "Pointing CallGraphNode at a function that already exists");
 153   FunctionMapTy::iterator I = FunctionMap.find(From);
 154   I->second->F = const_cast<Function*>(To);
 155   FunctionMap[To] = I->second;
 156   FunctionMap.erase(I);
 157 }
 158
 159 // getOrInsertFunction - This method is identical to calling operator[], but
 160 // it will insert a new CallGraphNode for the specified function if one does
 161 // not already exist.
 162 CallGraphNode *CallGraph::getOrInsertFunction(const Function *F) {
 163   CallGraphNode *&CGN = FunctionMap[F];
 164   if (CGN)
 165     return CGN;
 166
 167   assert((!F || F->getParent() == &M) && "Function not in current module!");
 168   return CGN = new CallGraphNode(const_cast<Function*>(F));
 169 }
 170
 171 //===----------------------------------------------------------------------===//
 172 // Implementations of the CallGraphNode class methods.
 173 //
 174
 175 void CallGraphNode::print(raw_ostream &OS) const {
 176   if (Function *F = getFunction())
 177     OS << "Call graph node for function: '" << F->getName() << "'";
 178   else
 179     OS << "Call graph node <<null function>>";
 180
 181   OS << "<<" << this << ">>  #uses=" << getNumReferences() << '\n';
 182
 183   for (const_iterator I = begin(), E = end(); I != E; ++I) {
 184     OS << "  CS<" << I->first << "> calls ";
 185     if (Function *FI = I->second->getFunction())
 186       OS << "function '" << FI->getName() <<"'\n";
 187     else
 188       OS << "external node\n";
 189   }
 190   OS << '\n';
 191 }
 192
 193 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 194 void CallGraphNode::dump() const { print(dbgs()); }
 195 #endif
 196
 197 /// removeCallEdgeFor - This method removes the edge in the node for the
 198 /// specified call site.  Note that this method takes linear time, so it
 199 /// should be used sparingly.
 200 void CallGraphNode::removeCallEdgeFor(CallSite CS) {
 201   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 202     assert(I != CalledFunctions.end() && "Cannot find callsite to remove!");
 203     if (I->first == CS.getInstruction()) {
 204       I->second->DropRef();
 205       *I = CalledFunctions.back();
 206       CalledFunctions.pop_back();
 207       return;
 208     }
 209   }
 210 }
 211
 212 // removeAnyCallEdgeTo - This method removes any call edges from this node to
 213 // the specified callee function.  This takes more time to execute than
 214 // removeCallEdgeTo, so it should not be used unless necessary.
 215 void CallGraphNode::removeAnyCallEdgeTo(CallGraphNode *Callee) {
 216   for (unsigned i = 0, e = CalledFunctions.size(); i != e; ++i)
 217     if (CalledFunctions[i].second == Callee) {
 218       Callee->DropRef();
 219       CalledFunctions[i] = CalledFunctions.back();
 220       CalledFunctions.pop_back();
 221       --i; --e;
 222     }
 223 }
 224
 225 /// removeOneAbstractEdgeTo - Remove one edge associated with a null callsite
 226 /// from this node to the specified callee function.
 227 void CallGraphNode::removeOneAbstractEdgeTo(CallGraphNode *Callee) {
 228   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 229     assert(I != CalledFunctions.end() && "Cannot find callee to remove!");
 230     CallRecord &CR = *I;
 231     if (CR.second == Callee && CR.first == nullptr) {
 232       Callee->DropRef();
 233       *I = CalledFunctions.back();
 234       CalledFunctions.pop_back();
 235       return;
 236     }
 237   }
 238 }
 239
 240 /// replaceCallEdge - This method replaces the edge in the node for the
 241 /// specified call site with a new one.  Note that this method takes linear
 242 /// time, so it should be used sparingly.
 243 void CallGraphNode::replaceCallEdge(CallSite CS,
 244                                     CallSite NewCS, CallGraphNode *NewNode){
 245   for (CalledFunctionsVector::iterator I = CalledFunctions.begin(); ; ++I) {
 246     assert(I != CalledFunctions.end() && "Cannot find callsite to remove!");
 247     if (I->first == CS.getInstruction()) {
 248       I->second->DropRef();
 249       I->first = NewCS.getInstruction();
 250       I->second = NewNode;
 251       NewNode->AddRef();
 252       return;
 253     }
 254   }
 255 }
 256
 257 //===----------------------------------------------------------------------===//
 258 // Out-of-line definitions of CallGraphAnalysis class members.
 259 //
 260
 261 char CallGraphAnalysis::PassID;
 262
 263 //===----------------------------------------------------------------------===//
 264 // Implementations of the CallGraphWrapperPass class methods.
 265 //
 266
 267 CallGraphWrapperPass::CallGraphWrapperPass() : ModulePass(ID) {
 268   initializeCallGraphWrapperPassPass(*PassRegistry::getPassRegistry());
 269 }
 270
 271 CallGraphWrapperPass::~CallGraphWrapperPass() {}
 272
 273 void CallGraphWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
 274   AU.setPreservesAll();
 275 }
 276
 277 bool CallGraphWrapperPass::runOnModule(Module &M) {
 278   // All the real work is done in the constructor for the CallGraph.
 279   G.reset(new CallGraph(M));
 280   return false;
 281 }
 282
 283 INITIALIZE_PASS(CallGraphWrapperPass, "basiccg", "CallGraph Construction",
 284                 false, true)
 285
 286 char CallGraphWrapperPass::ID = 0;
 287
 288 void CallGraphWrapperPass::releaseMemory() { G.reset(); }
 289
 290 void CallGraphWrapperPass::print(raw_ostream &OS, const Module *) const {
 291   if (!G) {
 292     OS << "No call graph has been built!\n";
 293     return;
 294   }
 295
 296   // Just delegate.
 297   G->print(OS);
 298 }
 299
 300 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 301 void CallGraphWrapperPass::dump() const { print(dbgs(), nullptr); }
 302 #endif