lib/Transforms/IPO/Inliner.cpp

   1 //===- Inliner.cpp - Code common to all inliners --------------------------===//
   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 mechanics required to implement inlining without
  11 // missing any calls and updating the call graph.  The decisions of which calls
  12 // are profitable to inline are implemented elsewhere.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "inline"
  17 #include "llvm/Module.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/Analysis/CallGraph.h"
  20 #include "llvm/Support/CallSite.h"
  21 #include "llvm/Target/TargetData.h"
  22 #include "llvm/Transforms/IPO/InlinerPass.h"
  23 #include "llvm/Transforms/Utils/Cloning.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include <set>
  28 using namespace llvm;
  29
  30 STATISTIC(NumInlined, "Number of functions inlined");
  31 STATISTIC(NumDeleted, "Number of functions deleted because all callers found");
  32
  33 namespace {
  34   cl::opt<unsigned>             // FIXME: 200 is VERY conservative
  35   InlineLimit("inline-threshold", cl::Hidden, cl::init(200),
  36         cl::desc("Control the amount of inlining to perform (default = 200)"));
  37 }
  38
  39 Inliner::Inliner(const void *ID)
  40   : CallGraphSCCPass((intptr_t)ID), InlineThreshold(InlineLimit) {}
  41
  42 /// getAnalysisUsage - For this class, we declare that we require and preserve
  43 /// the call graph.  If the derived class implements this method, it should
  44 /// always explicitly call the implementation here.
  45 void Inliner::getAnalysisUsage(AnalysisUsage &Info) const {
  46   Info.addRequired<TargetData>();
  47   CallGraphSCCPass::getAnalysisUsage(Info);
  48 }
  49
  50 // InlineCallIfPossible - If it is possible to inline the specified call site,
  51 // do so and update the CallGraph for this operation.
  52 static bool InlineCallIfPossible(CallSite CS, CallGraph &CG,
  53                                  const std::set<Function*> &SCCFunctions,
  54                                  const TargetData &TD) {
  55   Function *Callee = CS.getCalledFunction();
  56   if (!InlineFunction(CS, &CG, &TD)) return false;
  57
  58   // If we inlined the last possible call site to the function, delete the
  59   // function body now.
  60   if (Callee->use_empty() && Callee->hasInternalLinkage() &&
  61       !SCCFunctions.count(Callee)) {
  62     DOUT << "    -> Deleting dead function: " << Callee->getName() << "\n";
  63
  64     // Remove any call graph edges from the callee to its callees.
  65     CallGraphNode *CalleeNode = CG[Callee];
  66     while (!CalleeNode->empty())
  67       CalleeNode->removeCallEdgeTo((CalleeNode->end()-1)->second);
  68
  69     // Removing the node for callee from the call graph and delete it.
  70     delete CG.removeFunctionFromModule(CalleeNode);
  71     ++NumDeleted;
  72   }
  73   return true;
  74 }
  75
  76 bool Inliner::runOnSCC(const std::vector<CallGraphNode*> &SCC) {
  77   CallGraph &CG = getAnalysis<CallGraph>();
  78
  79   std::set<Function*> SCCFunctions;
  80   DOUT << "Inliner visiting SCC:";
  81   for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
  82     Function *F = SCC[i]->getFunction();
  83     if (F) SCCFunctions.insert(F);
  84     DOUT << " " << (F ? F->getName() : "INDIRECTNODE");
  85   }
  86
  87   // Scan through and identify all call sites ahead of time so that we only
  88   // inline call sites in the original functions, not call sites that result
  89   // from inlining other functions.
  90   std::vector<CallSite> CallSites;
  91
  92   for (unsigned i = 0, e = SCC.size(); i != e; ++i)
  93     if (Function *F = SCC[i]->getFunction())
  94       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
  95         for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
  96           CallSite CS = CallSite::get(I);
  97           if (CS.getInstruction() && (!CS.getCalledFunction() ||
  98                                       !CS.getCalledFunction()->isDeclaration()))
  99             CallSites.push_back(CS);
 100         }
 101
 102   DOUT << ": " << CallSites.size() << " call sites.\n";
 103
 104   // Now that we have all of the call sites, move the ones to functions in the
 105   // current SCC to the end of the list.
 106   unsigned FirstCallInSCC = CallSites.size();
 107   for (unsigned i = 0; i < FirstCallInSCC; ++i)
 108     if (Function *F = CallSites[i].getCalledFunction())
 109       if (SCCFunctions.count(F))
 110         std::swap(CallSites[i--], CallSites[--FirstCallInSCC]);
 111
 112   // Now that we have all of the call sites, loop over them and inline them if
 113   // it looks profitable to do so.
 114   bool Changed = false;
 115   bool LocalChange;
 116   do {
 117     LocalChange = false;
 118     // Iterate over the outer loop because inlining functions can cause indirect
 119     // calls to become direct calls.
 120     for (unsigned CSi = 0; CSi != CallSites.size(); ++CSi)
 121       if (Function *Callee = CallSites[CSi].getCalledFunction()) {
 122         // Calls to external functions are never inlinable.
 123         if (Callee->isDeclaration() ||
 124             CallSites[CSi].getInstruction()->getParent()->getParent() ==Callee){
 125           if (SCC.size() == 1) {
 126             std::swap(CallSites[CSi], CallSites.back());
 127             CallSites.pop_back();
 128           } else {
 129             // Keep the 'in SCC / not in SCC' boundary correct.
 130             CallSites.erase(CallSites.begin()+CSi);
 131           }
 132           --CSi;
 133           continue;
 134         }
 135
 136         // If the policy determines that we should inline this function,
 137         // try to do so.
 138         CallSite CS = CallSites[CSi];
 139         int InlineCost = getInlineCost(CS);
 140         if (InlineCost >= (int)InlineThreshold) {
 141           DOUT << "    NOT Inlining: cost=" << InlineCost
 142                << ", Call: " << *CS.getInstruction();
 143         } else {
 144           DOUT << "    Inlining: cost=" << InlineCost
 145                << ", Call: " << *CS.getInstruction();
 146
 147           // Attempt to inline the function...
 148           if (InlineCallIfPossible(CS, CG, SCCFunctions,
 149                                    getAnalysis<TargetData>())) {
 150             // Remove this call site from the list.  If possible, use
 151             // swap/pop_back for efficiency, but do not use it if doing so would
 152             // move a call site to a function in this SCC before the
 153             // 'FirstCallInSCC' barrier.
 154             if (SCC.size() == 1) {
 155               std::swap(CallSites[CSi], CallSites.back());
 156               CallSites.pop_back();
 157             } else {
 158               CallSites.erase(CallSites.begin()+CSi);
 159             }
 160             --CSi;
 161
 162             ++NumInlined;
 163             Changed = true;
 164             LocalChange = true;
 165           }
 166         }
 167       }
 168   } while (LocalChange);
 169
 170   return Changed;
 171 }
 172
 173 // doFinalization - Remove now-dead linkonce functions at the end of
 174 // processing to avoid breaking the SCC traversal.
 175 bool Inliner::doFinalization(CallGraph &CG) {
 176   std::set<CallGraphNode*> FunctionsToRemove;
 177
 178   // Scan for all of the functions, looking for ones that should now be removed
 179   // from the program.  Insert the dead ones in the FunctionsToRemove set.
 180   for (CallGraph::iterator I = CG.begin(), E = CG.end(); I != E; ++I) {
 181     CallGraphNode *CGN = I->second;
 182     if (Function *F = CGN ? CGN->getFunction() : 0) {
 183       // If the only remaining users of the function are dead constants, remove
 184       // them.
 185       F->removeDeadConstantUsers();
 186
 187       if ((F->hasLinkOnceLinkage() || F->hasInternalLinkage()) &&
 188           F->use_empty()) {
 189
 190         // Remove any call graph edges from the function to its callees.
 191         while (!CGN->empty())
 192           CGN->removeCallEdgeTo((CGN->end()-1)->second);
 193
 194         // Remove any edges from the external node to the function's call graph
 195         // node.  These edges might have been made irrelegant due to
 196         // optimization of the program.
 197         CG.getExternalCallingNode()->removeAnyCallEdgeTo(CGN);
 198
 199         // Removing the node for callee from the call graph and delete it.
 200         FunctionsToRemove.insert(CGN);
 201       }
 202     }
 203   }
 204
 205   // Now that we know which functions to delete, do so.  We didn't want to do
 206   // this inline, because that would invalidate our CallGraph::iterator
 207   // objects. :(
 208   bool Changed = false;
 209   for (std::set<CallGraphNode*>::iterator I = FunctionsToRemove.begin(),
 210          E = FunctionsToRemove.end(); I != E; ++I) {
 211     delete CG.removeFunctionFromModule(*I);
 212     ++NumDeleted;
 213     Changed = true;
 214   }
 215
 216   return Changed;
 217 }