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/Analysis/InlineCost.h"
  22 #include "llvm/Support/CallSite.h"
  23 #include "llvm/Target/TargetData.h"
  24 #include "llvm/Transforms/IPO/InlinerPass.h"
  25 #include "llvm/Transforms/Utils/Cloning.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/ADT/SmallPtrSet.h"
  30 #include "llvm/ADT/Statistic.h"
  31 #include <set>
  32 using namespace llvm;
  33
  34 STATISTIC(NumInlined, "Number of functions inlined");
  35 STATISTIC(NumCallsDeleted, "Number of call sites deleted, not inlined");
  36 STATISTIC(NumDeleted, "Number of functions deleted because all callers found");
  37 STATISTIC(NumMergedAllocas, "Number of allocas merged together");
  38
  39 static cl::opt<int>
  40 InlineLimit("inline-threshold", cl::Hidden, cl::init(200), cl::ZeroOrMore,
  41         cl::desc("Control the amount of inlining to perform (default = 200)"));
  42
  43 Inliner::Inliner(void *ID)
  44   : CallGraphSCCPass(ID), InlineThreshold(InlineLimit) {}
  45
  46 Inliner::Inliner(void *ID, int Threshold)
  47   : CallGraphSCCPass(ID), InlineThreshold(Threshold) {}
  48
  49 /// getAnalysisUsage - For this class, we declare that we require and preserve
  50 /// the call graph.  If the derived class implements this method, it should
  51 /// always explicitly call the implementation here.
  52 void Inliner::getAnalysisUsage(AnalysisUsage &Info) const {
  53   CallGraphSCCPass::getAnalysisUsage(Info);
  54 }
  55
  56
  57 typedef DenseMap<const ArrayType*, std::vector<AllocaInst*> >
  58 InlinedArrayAllocasTy;
  59
  60 /// InlineCallIfPossible - If it is possible to inline the specified call site,
  61 /// do so and update the CallGraph for this operation.
  62 ///
  63 /// This function also does some basic book-keeping to update the IR.  The
  64 /// InlinedArrayAllocas map keeps track of any allocas that are already
  65 /// available from other  functions inlined into the caller.  If we are able to
  66 /// inline this call site we attempt to reuse already available allocas or add
  67 /// any new allocas to the set if not possible.
  68 static bool InlineCallIfPossible(CallSite CS, CallGraph &CG,
  69                                  const TargetData *TD,
  70                                  InlinedArrayAllocasTy &InlinedArrayAllocas) {
  71   Function *Callee = CS.getCalledFunction();
  72   Function *Caller = CS.getCaller();
  73
  74   // Try to inline the function.  Get the list of static allocas that were
  75   // inlined.
  76   SmallVector<AllocaInst*, 16> StaticAllocas;
  77   if (!InlineFunction(CS, &CG, TD, &StaticAllocas))
  78     return false;
  79
  80   // If the inlined function had a higher stack protection level than the
  81   // calling function, then bump up the caller's stack protection level.
  82   if (Callee->hasFnAttr(Attribute::StackProtectReq))
  83     Caller->addFnAttr(Attribute::StackProtectReq);
  84   else if (Callee->hasFnAttr(Attribute::StackProtect) &&
  85            !Caller->hasFnAttr(Attribute::StackProtectReq))
  86     Caller->addFnAttr(Attribute::StackProtect);
  87
  88
  89   // Look at all of the allocas that we inlined through this call site.  If we
  90   // have already inlined other allocas through other calls into this function,
  91   // then we know that they have disjoint lifetimes and that we can merge them.
  92   //
  93   // There are many heuristics possible for merging these allocas, and the
  94   // different options have different tradeoffs.  One thing that we *really*
  95   // don't want to hurt is SRoA: once inlining happens, often allocas are no
  96   // longer address taken and so they can be promoted.
  97   //
  98   // Our "solution" for that is to only merge allocas whose outermost type is an
  99   // array type.  These are usually not promoted because someone is using a
 100   // variable index into them.  These are also often the most important ones to
 101   // merge.
 102   //
 103   // A better solution would be to have real memory lifetime markers in the IR
 104   // and not have the inliner do any merging of allocas at all.  This would
 105   // allow the backend to do proper stack slot coloring of all allocas that
 106   // *actually make it to the backend*, which is really what we want.
 107   //
 108   // Because we don't have this information, we do this simple and useful hack.
 109   //
 110   SmallPtrSet<AllocaInst*, 16> UsedAllocas;
 111
 112   // Loop over all the allocas we have so far and see if they can be merged with
 113   // a previously inlined alloca.  If not, remember that we had it.
 114   for (unsigned AllocaNo = 0, e = StaticAllocas.size();
 115        AllocaNo != e; ++AllocaNo) {
 116     AllocaInst *AI = StaticAllocas[AllocaNo];
 117
 118     // Don't bother trying to merge array allocations (they will usually be
 119     // canonicalized to be an allocation *of* an array), or allocations whose
 120     // type is not itself an array (because we're afraid of pessimizing SRoA).
 121     const ArrayType *ATy = dyn_cast<ArrayType>(AI->getAllocatedType());
 122     if (ATy == 0 || AI->isArrayAllocation())
 123       continue;
 124
 125     // Get the list of all available allocas for this array type.
 126     std::vector<AllocaInst*> &AllocasForType = InlinedArrayAllocas[ATy];
 127
 128     // Loop over the allocas in AllocasForType to see if we can reuse one.  Note
 129     // that we have to be careful not to reuse the same "available" alloca for
 130     // multiple different allocas that we just inlined, we use the 'UsedAllocas'
 131     // set to keep track of which "available" allocas are being used by this
 132     // function.  Also, AllocasForType can be empty of course!
 133     bool MergedAwayAlloca = false;
 134     for (unsigned i = 0, e = AllocasForType.size(); i != e; ++i) {
 135       AllocaInst *AvailableAlloca = AllocasForType[i];
 136
 137       // The available alloca has to be in the right function, not in some other
 138       // function in this SCC.
 139       if (AvailableAlloca->getParent() != AI->getParent())
 140         continue;
 141
 142       // If the inlined function already uses this alloca then we can't reuse
 143       // it.
 144       if (!UsedAllocas.insert(AvailableAlloca))
 145         continue;
 146
 147       // Otherwise, we *can* reuse it, RAUW AI into AvailableAlloca and declare
 148       // success!
 149       DEBUG(errs() << "    ***MERGED ALLOCA: " << *AI);
 150
 151       AI->replaceAllUsesWith(AvailableAlloca);
 152       AI->eraseFromParent();
 153       MergedAwayAlloca = true;
 154       ++NumMergedAllocas;
 155       break;
 156     }
 157
 158     // If we already nuked the alloca, we're done with it.
 159     if (MergedAwayAlloca)
 160       continue;
 161
 162     // If we were unable to merge away the alloca either because there are no
 163     // allocas of the right type available or because we reused them all
 164     // already, remember that this alloca came from an inlined function and mark
 165     // it used so we don't reuse it for other allocas from this inline
 166     // operation.
 167     AllocasForType.push_back(AI);
 168     UsedAllocas.insert(AI);
 169   }
 170
 171   return true;
 172 }
 173
 174 /// shouldInline - Return true if the inliner should attempt to inline
 175 /// at the given CallSite.
 176 bool Inliner::shouldInline(CallSite CS) {
 177   InlineCost IC = getInlineCost(CS);
 178
 179   if (IC.isAlways()) {
 180     DEBUG(errs() << "    Inlining: cost=always"
 181           << ", Call: " << *CS.getInstruction() << "\n");
 182     return true;
 183   }
 184
 185   if (IC.isNever()) {
 186     DEBUG(errs() << "    NOT Inlining: cost=never"
 187           << ", Call: " << *CS.getInstruction() << "\n");
 188     return false;
 189   }
 190
 191   int Cost = IC.getValue();
 192   int CurrentThreshold = InlineThreshold;
 193   Function *Caller = CS.getCaller();
 194   if (Caller && !Caller->isDeclaration() &&
 195       Caller->hasFnAttr(Attribute::OptimizeForSize) &&
 196       InlineLimit.getNumOccurrences() == 0 &&
 197       InlineThreshold != 50)
 198     CurrentThreshold = 50;
 199
 200   float FudgeFactor = getInlineFudgeFactor(CS);
 201   if (Cost >= (int)(CurrentThreshold * FudgeFactor)) {
 202     DEBUG(errs() << "    NOT Inlining: cost=" << Cost
 203           << ", Call: " << *CS.getInstruction() << "\n");
 204     return false;
 205   }
 206
 207   // Try to detect the case where the current inlining candidate caller
 208   // (call it B) is a static function and is an inlining candidate elsewhere,
 209   // and the current candidate callee (call it C) is large enough that
 210   // inlining it into B would make B too big to inline later.  In these
 211   // circumstances it may be best not to inline C into B, but to inline B
 212   // into its callers.
 213   if (Caller->hasLocalLinkage()) {
 214     int TotalSecondaryCost = 0;
 215     bool outerCallsFound = false;
 216     bool allOuterCallsWillBeInlined = true;
 217     bool someOuterCallWouldNotBeInlined = false;
 218     for (Value::use_iterator I = Caller->use_begin(), E =Caller->use_end();
 219          I != E; ++I) {
 220       CallSite CS2 = CallSite::get(*I);
 221
 222       // If this isn't a call to Caller (it could be some other sort
 223       // of reference) skip it.
 224       if (CS2.getInstruction() == 0 || CS2.getCalledFunction() != Caller)
 225         continue;
 226
 227       InlineCost IC2 = getInlineCost(CS2);
 228       if (IC2.isNever())
 229         allOuterCallsWillBeInlined = false;
 230       if (IC2.isAlways() || IC2.isNever())
 231         continue;
 232
 233       outerCallsFound = true;
 234       int Cost2 = IC2.getValue();
 235       int CurrentThreshold2 = InlineThreshold;
 236       Function *Caller2 = CS2.getCaller();
 237       if (Caller2 && !Caller2->isDeclaration() &&
 238           Caller2->hasFnAttr(Attribute::OptimizeForSize) &&
 239           InlineThreshold != 50)
 240         CurrentThreshold2 = 50;
 241
 242       float FudgeFactor2 = getInlineFudgeFactor(CS2);
 243
 244       if (Cost2 >= (int)(CurrentThreshold2 * FudgeFactor2))
 245         allOuterCallsWillBeInlined = false;
 246
 247       // See if we have this case.  We subtract off the penalty
 248       // for the call instruction, which we would be deleting.
 249       if (Cost2 < (int)(CurrentThreshold2 * FudgeFactor2) &&
 250           Cost2 + Cost - (InlineConstants::CallPenalty + 1) >=
 251                 (int)(CurrentThreshold2 * FudgeFactor2)) {
 252         someOuterCallWouldNotBeInlined = true;
 253         TotalSecondaryCost += Cost2;
 254       }
 255     }
 256     // If all outer calls to Caller would get inlined, the cost for the last
 257     // one is set very low by getInlineCost, in anticipation that Caller will
 258     // be removed entirely.  We did not account for this above unless there
 259     // is only one caller of Caller.
 260     if (allOuterCallsWillBeInlined && Caller->use_begin() != Caller->use_end())
 261       TotalSecondaryCost += InlineConstants::LastCallToStaticBonus;
 262
 263     if (outerCallsFound && someOuterCallWouldNotBeInlined &&
 264         TotalSecondaryCost < Cost) {
 265       DEBUG(errs() << "    NOT Inlining: " << *CS.getInstruction() <<
 266            " Cost = " << Cost <<
 267            ", outer Cost = " << TotalSecondaryCost << '\n');
 268       return false;
 269     }
 270   }
 271
 272   DEBUG(errs() << "    Inlining: cost=" << Cost
 273         << ", Call: " << *CS.getInstruction() << '\n');
 274   return true;
 275 }
 276
 277 bool Inliner::runOnSCC(std::vector<CallGraphNode*> &SCC) {
 278   CallGraph &CG = getAnalysis<CallGraph>();
 279   const TargetData *TD = getAnalysisIfAvailable<TargetData>();
 280
 281   SmallPtrSet<Function*, 8> SCCFunctions;
 282   DEBUG(errs() << "Inliner visiting SCC:");
 283   for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 284     Function *F = SCC[i]->getFunction();
 285     if (F) SCCFunctions.insert(F);
 286     DEBUG(errs() << " " << (F ? F->getName() : "INDIRECTNODE"));
 287   }
 288
 289   // Scan through and identify all call sites ahead of time so that we only
 290   // inline call sites in the original functions, not call sites that result
 291   // from inlining other functions.
 292   SmallVector<CallSite, 16> CallSites;
 293
 294   for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 295     Function *F = SCC[i]->getFunction();
 296     if (!F) continue;
 297
 298     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 299       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 300         CallSite CS = CallSite::get(I);
 301         // If this isn't a call, or it is a call to an intrinsic, it can
 302         // never be inlined.
 303         if (CS.getInstruction() == 0 || isa<IntrinsicInst>(I))
 304           continue;
 305
 306         // If this is a direct call to an external function, we can never inline
 307         // it.  If it is an indirect call, inlining may resolve it to be a
 308         // direct call, so we keep it.
 309         if (CS.getCalledFunction() && CS.getCalledFunction()->isDeclaration())
 310           continue;
 311
 312         CallSites.push_back(CS);
 313       }
 314   }
 315
 316   DEBUG(errs() << ": " << CallSites.size() << " call sites.\n");
 317
 318   // Now that we have all of the call sites, move the ones to functions in the
 319   // current SCC to the end of the list.
 320   unsigned FirstCallInSCC = CallSites.size();
 321   for (unsigned i = 0; i < FirstCallInSCC; ++i)
 322     if (Function *F = CallSites[i].getCalledFunction())
 323       if (SCCFunctions.count(F))
 324         std::swap(CallSites[i--], CallSites[--FirstCallInSCC]);
 325
 326
 327   InlinedArrayAllocasTy InlinedArrayAllocas;
 328
 329   // Now that we have all of the call sites, loop over them and inline them if
 330   // it looks profitable to do so.
 331   bool Changed = false;
 332   bool LocalChange;
 333   do {
 334     LocalChange = false;
 335     // Iterate over the outer loop because inlining functions can cause indirect
 336     // calls to become direct calls.
 337     for (unsigned CSi = 0; CSi != CallSites.size(); ++CSi) {
 338       CallSite CS = CallSites[CSi];
 339
 340       Function *Caller = CS.getCaller();
 341       Function *Callee = CS.getCalledFunction();
 342
 343       // If this call site is dead and it is to a readonly function, we should
 344       // just delete the call instead of trying to inline it, regardless of
 345       // size.  This happens because IPSCCP propagates the result out of the
 346       // call and then we're left with the dead call.
 347       if (CS.getInstruction()->use_empty() &&
 348           !CS.getInstruction()->mayHaveSideEffects()) {
 349         DEBUG(errs() << "    -> Deleting dead call: "
 350                      << *CS.getInstruction() << "\n");
 351         // Update the call graph by deleting the edge from Callee to Caller.
 352         CG[Caller]->removeCallEdgeFor(CS);
 353         CS.getInstruction()->eraseFromParent();
 354         ++NumCallsDeleted;
 355       } else {
 356         // We can only inline direct calls to non-declarations.
 357         if (Callee == 0 || Callee->isDeclaration()) continue;
 358
 359         // If the policy determines that we should inline this function,
 360         // try to do so.
 361         if (!shouldInline(CS))
 362           continue;
 363
 364         // Attempt to inline the function...
 365         if (!InlineCallIfPossible(CS, CG, TD, InlinedArrayAllocas))
 366           continue;
 367         ++NumInlined;
 368       }
 369
 370       // If we inlined or deleted the last possible call site to the function,
 371       // delete the function body now.
 372       if (Callee && Callee->use_empty() && Callee->hasLocalLinkage() &&
 373           // TODO: Can remove if in SCC now.
 374           !SCCFunctions.count(Callee) &&
 375
 376           // The function may be apparently dead, but if there are indirect
 377           // callgraph references to the node, we cannot delete it yet, this
 378           // could invalidate the CGSCC iterator.
 379           CG[Callee]->getNumReferences() == 0) {
 380         DEBUG(errs() << "    -> Deleting dead function: "
 381               << Callee->getName() << "\n");
 382         CallGraphNode *CalleeNode = CG[Callee];
 383
 384         // Remove any call graph edges from the callee to its callees.
 385         CalleeNode->removeAllCalledFunctions();
 386
 387         resetCachedCostInfo(Callee);
 388
 389         // Removing the node for callee from the call graph and delete it.
 390         delete CG.removeFunctionFromModule(CalleeNode);
 391         ++NumDeleted;
 392       }
 393
 394       // Remove any cached cost info for this caller, as inlining the
 395       // callee has increased the size of the caller (which may be the
 396       // same as the callee).
 397       resetCachedCostInfo(Caller);
 398
 399       // Remove this call site from the list.  If possible, use
 400       // swap/pop_back for efficiency, but do not use it if doing so would
 401       // move a call site to a function in this SCC before the
 402       // 'FirstCallInSCC' barrier.
 403       if (SCC.size() == 1) {
 404         std::swap(CallSites[CSi], CallSites.back());
 405         CallSites.pop_back();
 406       } else {
 407         CallSites.erase(CallSites.begin()+CSi);
 408       }
 409       --CSi;
 410
 411       Changed = true;
 412       LocalChange = true;
 413     }
 414   } while (LocalChange);
 415
 416   return Changed;
 417 }
 418
 419 // doFinalization - Remove now-dead linkonce functions at the end of
 420 // processing to avoid breaking the SCC traversal.
 421 bool Inliner::doFinalization(CallGraph &CG) {
 422   return removeDeadFunctions(CG);
 423 }
 424
 425 /// removeDeadFunctions - Remove dead functions that are not included in
 426 /// DNR (Do Not Remove) list.
 427 bool Inliner::removeDeadFunctions(CallGraph &CG,
 428                                   SmallPtrSet<const Function *, 16> *DNR) {
 429   SmallPtrSet<CallGraphNode*, 16> FunctionsToRemove;
 430
 431   // Scan for all of the functions, looking for ones that should now be removed
 432   // from the program.  Insert the dead ones in the FunctionsToRemove set.
 433   for (CallGraph::iterator I = CG.begin(), E = CG.end(); I != E; ++I) {
 434     CallGraphNode *CGN = I->second;
 435     if (CGN->getFunction() == 0)
 436       continue;
 437
 438     Function *F = CGN->getFunction();
 439
 440     // If the only remaining users of the function are dead constants, remove
 441     // them.
 442     F->removeDeadConstantUsers();
 443
 444     if (DNR && DNR->count(F))
 445       continue;
 446     if (!F->hasLinkOnceLinkage() && !F->hasLocalLinkage() &&
 447         !F->hasAvailableExternallyLinkage())
 448       continue;
 449     if (!F->use_empty())
 450       continue;
 451
 452     // Remove any call graph edges from the function to its callees.
 453     CGN->removeAllCalledFunctions();
 454
 455     // Remove any edges from the external node to the function's call graph
 456     // node.  These edges might have been made irrelegant due to
 457     // optimization of the program.
 458     CG.getExternalCallingNode()->removeAnyCallEdgeTo(CGN);
 459
 460     // Removing the node for callee from the call graph and delete it.
 461     FunctionsToRemove.insert(CGN);
 462   }
 463
 464   // Now that we know which functions to delete, do so.  We didn't want to do
 465   // this inline, because that would invalidate our CallGraph::iterator
 466   // objects. :(
 467   //
 468   // Note that it doesn't matter that we are iterating over a non-stable set
 469   // here to do this, it doesn't matter which order the functions are deleted
 470   // in.
 471   bool Changed = false;
 472   for (SmallPtrSet<CallGraphNode*, 16>::iterator I = FunctionsToRemove.begin(),
 473        E = FunctionsToRemove.end(); I != E; ++I) {
 474     resetCachedCostInfo((*I)->getFunction());
 475     delete CG.removeFunctionFromModule(*I);
 476     ++NumDeleted;
 477     Changed = true;
 478   }
 479
 480   return Changed;
 481 }