lib/Transforms/IPO/Inliner.cpp

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