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/IntrinsicInst.h"
  20 #include "llvm/Analysis/CallGraph.h"
  21 #include "llvm/Support/CallSite.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Transforms/IPO/InlinerPass.h"
  24 #include "llvm/Transforms/Utils/Cloning.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include "llvm/ADT/Statistic.h"
  29 #include <set>
  30 using namespace llvm;
  31
  32 STATISTIC(NumInlined, "Number of functions inlined");
  33 STATISTIC(NumDeleted, "Number of functions deleted because all callers found");
  34
  35 static cl::opt<int>
  36 InlineLimit("inline-threshold", cl::Hidden, cl::init(200),
  37         cl::desc("Control the amount of inlining to perform (default = 200)"));
  38
  39 Inliner::Inliner(void *ID)
  40   : CallGraphSCCPass(ID), InlineThreshold(InlineLimit) {}
  41
  42 Inliner::Inliner(void *ID, int Threshold)
  43   : CallGraphSCCPass(ID), InlineThreshold(Threshold) {}
  44
  45 /// getAnalysisUsage - For this class, we declare that we require and preserve
  46 /// the call graph.  If the derived class implements this method, it should
  47 /// always explicitly call the implementation here.
  48 void Inliner::getAnalysisUsage(AnalysisUsage &Info) const {
  49   CallGraphSCCPass::getAnalysisUsage(Info);
  50 }
  51
  52 // InlineCallIfPossible - If it is possible to inline the specified call site,
  53 // do so and update the CallGraph for this operation.
  54 bool Inliner::InlineCallIfPossible(CallSite CS, CallGraph &CG,
  55                                  const SmallPtrSet<Function*, 8> &SCCFunctions,
  56                                  const TargetData *TD) {
  57   Function *Callee = CS.getCalledFunction();
  58   Function *Caller = CS.getCaller();
  59
  60   if (!InlineFunction(CS, &CG, TD)) return false;
  61
  62   // If the inlined function had a higher stack protection level than the
  63   // calling function, then bump up the caller's stack protection level.
  64   if (Callee->hasFnAttr(Attribute::StackProtectReq))
  65     Caller->addFnAttr(Attribute::StackProtectReq);
  66   else if (Callee->hasFnAttr(Attribute::StackProtect) &&
  67            !Caller->hasFnAttr(Attribute::StackProtectReq))
  68     Caller->addFnAttr(Attribute::StackProtect);
  69
  70   // If we inlined the last possible call site to the function, delete the
  71   // function body now.
  72   if (Callee->use_empty() && (Callee->hasLocalLinkage() ||
  73                               Callee->hasAvailableExternallyLinkage()) &&
  74       !SCCFunctions.count(Callee)) {
  75     DEBUG(errs() << "    -> Deleting dead function: "
  76           << Callee->getName() << "\n");
  77     CallGraphNode *CalleeNode = CG[Callee];
  78
  79     // Remove any call graph edges from the callee to its callees.
  80     CalleeNode->removeAllCalledFunctions();
  81
  82     resetCachedCostInfo(CalleeNode->getFunction());
  83
  84     // Removing the node for callee from the call graph and delete it.
  85     delete CG.removeFunctionFromModule(CalleeNode);
  86     ++NumDeleted;
  87   }
  88   return true;
  89 }
  90
  91 /// shouldInline - Return true if the inliner should attempt to inline
  92 /// at the given CallSite.
  93 bool Inliner::shouldInline(CallSite CS) {
  94   InlineCost IC = getInlineCost(CS);
  95   float FudgeFactor = getInlineFudgeFactor(CS);
  96
  97   if (IC.isAlways()) {
  98     DOUT << "    Inlining: cost=always"
  99          << ", Call: " << *CS.getInstruction() << "\n";
 100     return true;
 101   }
 102
 103   if (IC.isNever()) {
 104     DOUT << "    NOT Inlining: cost=never"
 105          << ", Call: " << *CS.getInstruction() << "\n";
 106     return false;
 107   }
 108
 109   int Cost = IC.getValue();
 110   int CurrentThreshold = InlineThreshold;
 111   Function *Fn = CS.getCaller();
 112   if (Fn && !Fn->isDeclaration()
 113       && Fn->hasFnAttr(Attribute::OptimizeForSize)
 114       && InlineThreshold != 50) {
 115     CurrentThreshold = 50;
 116   }
 117
 118   if (Cost >= (int)(CurrentThreshold * FudgeFactor)) {
 119     DOUT << "    NOT Inlining: cost=" << Cost
 120          << ", Call: " << *CS.getInstruction() << "\n";
 121     return false;
 122   } else {
 123     DOUT << "    Inlining: cost=" << Cost
 124          << ", Call: " << *CS.getInstruction() << "\n";
 125     return true;
 126   }
 127 }
 128
 129 bool Inliner::runOnSCC(const std::vector<CallGraphNode*> &SCC) {
 130   CallGraph &CG = getAnalysis<CallGraph>();
 131   const TargetData *TD = getAnalysisIfAvailable<TargetData>();
 132
 133   SmallPtrSet<Function*, 8> SCCFunctions;
 134   DOUT << "Inliner visiting SCC:";
 135   for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 136     Function *F = SCC[i]->getFunction();
 137     if (F) SCCFunctions.insert(F);
 138     DEBUG(errs() << " " << (F ? F->getName() : "INDIRECTNODE"));
 139   }
 140
 141   // Scan through and identify all call sites ahead of time so that we only
 142   // inline call sites in the original functions, not call sites that result
 143   // from inlining other functions.
 144   std::vector<CallSite> CallSites;
 145
 146   for (unsigned i = 0, e = SCC.size(); i != e; ++i)
 147     if (Function *F = SCC[i]->getFunction())
 148       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 149         for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
 150           CallSite CS = CallSite::get(I);
 151           if (CS.getInstruction() && !isa<DbgInfoIntrinsic>(I) &&
 152                                      (!CS.getCalledFunction() ||
 153                                       !CS.getCalledFunction()->isDeclaration()))
 154             CallSites.push_back(CS);
 155         }
 156
 157   DOUT << ": " << CallSites.size() << " call sites.\n";
 158
 159   // Now that we have all of the call sites, move the ones to functions in the
 160   // current SCC to the end of the list.
 161   unsigned FirstCallInSCC = CallSites.size();
 162   for (unsigned i = 0; i < FirstCallInSCC; ++i)
 163     if (Function *F = CallSites[i].getCalledFunction())
 164       if (SCCFunctions.count(F))
 165         std::swap(CallSites[i--], CallSites[--FirstCallInSCC]);
 166
 167   // Now that we have all of the call sites, loop over them and inline them if
 168   // it looks profitable to do so.
 169   bool Changed = false;
 170   bool LocalChange;
 171   do {
 172     LocalChange = false;
 173     // Iterate over the outer loop because inlining functions can cause indirect
 174     // calls to become direct calls.
 175     for (unsigned CSi = 0; CSi != CallSites.size(); ++CSi)
 176       if (Function *Callee = CallSites[CSi].getCalledFunction()) {
 177         // Calls to external functions are never inlinable.
 178         if (Callee->isDeclaration()) {
 179           if (SCC.size() == 1) {
 180             std::swap(CallSites[CSi], CallSites.back());
 181             CallSites.pop_back();
 182           } else {
 183             // Keep the 'in SCC / not in SCC' boundary correct.
 184             CallSites.erase(CallSites.begin()+CSi);
 185           }
 186           --CSi;
 187           continue;
 188         }
 189
 190         // If the policy determines that we should inline this function,
 191         // try to do so.
 192         CallSite CS = CallSites[CSi];
 193         if (shouldInline(CS)) {
 194           Function *Caller = CS.getCaller();
 195           // Attempt to inline the function...
 196           if (InlineCallIfPossible(CS, CG, SCCFunctions, TD)) {
 197             // Remove any cached cost info for this caller, as inlining the
 198             // callee has increased the size of the caller (which may be the
 199             // same as the callee).
 200             resetCachedCostInfo(Caller);
 201
 202             // Remove this call site from the list.  If possible, use
 203             // swap/pop_back for efficiency, but do not use it if doing so would
 204             // move a call site to a function in this SCC before the
 205             // 'FirstCallInSCC' barrier.
 206             if (SCC.size() == 1) {
 207               std::swap(CallSites[CSi], CallSites.back());
 208               CallSites.pop_back();
 209             } else {
 210               CallSites.erase(CallSites.begin()+CSi);
 211             }
 212             --CSi;
 213
 214             ++NumInlined;
 215             Changed = true;
 216             LocalChange = true;
 217           }
 218         }
 219       }
 220   } while (LocalChange);
 221
 222   return Changed;
 223 }
 224
 225 // doFinalization - Remove now-dead linkonce functions at the end of
 226 // processing to avoid breaking the SCC traversal.
 227 bool Inliner::doFinalization(CallGraph &CG) {
 228   return removeDeadFunctions(CG);
 229 }
 230
 231   /// removeDeadFunctions - Remove dead functions that are not included in
 232   /// DNR (Do Not Remove) list.
 233 bool Inliner::removeDeadFunctions(CallGraph &CG,
 234                                  SmallPtrSet<const Function *, 16> *DNR) {
 235   std::set<CallGraphNode*> FunctionsToRemove;
 236
 237   // Scan for all of the functions, looking for ones that should now be removed
 238   // from the program.  Insert the dead ones in the FunctionsToRemove set.
 239   for (CallGraph::iterator I = CG.begin(), E = CG.end(); I != E; ++I) {
 240     CallGraphNode *CGN = I->second;
 241     if (Function *F = CGN ? CGN->getFunction() : 0) {
 242       // If the only remaining users of the function are dead constants, remove
 243       // them.
 244       F->removeDeadConstantUsers();
 245
 246       if (DNR && DNR->count(F))
 247         continue;
 248
 249       if ((F->hasLinkOnceLinkage() || F->hasLocalLinkage()) &&
 250           F->use_empty()) {
 251
 252         // Remove any call graph edges from the function to its callees.
 253         CGN->removeAllCalledFunctions();
 254
 255         // Remove any edges from the external node to the function's call graph
 256         // node.  These edges might have been made irrelegant due to
 257         // optimization of the program.
 258         CG.getExternalCallingNode()->removeAnyCallEdgeTo(CGN);
 259
 260         // Removing the node for callee from the call graph and delete it.
 261         FunctionsToRemove.insert(CGN);
 262       }
 263     }
 264   }
 265
 266   // Now that we know which functions to delete, do so.  We didn't want to do
 267   // this inline, because that would invalidate our CallGraph::iterator
 268   // objects. :(
 269   bool Changed = false;
 270   for (std::set<CallGraphNode*>::iterator I = FunctionsToRemove.begin(),
 271          E = FunctionsToRemove.end(); I != E; ++I) {
 272     resetCachedCostInfo((*I)->getFunction());
 273     delete CG.removeFunctionFromModule(*I);
 274     ++NumDeleted;
 275     Changed = true;
 276   }
 277
 278   return Changed;
 279 }