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 #include "llvm/Transforms/IPO/InlinerPass.h"
  17 #include "llvm/ADT/SmallPtrSet.h"
  18 #include "llvm/ADT/Statistic.h"
  19 #include "llvm/Analysis/AliasAnalysis.h"
  20 #include "llvm/Analysis/AssumptionCache.h"
  21 #include "llvm/Analysis/CallGraph.h"
  22 #include "llvm/Analysis/InlineCost.h"
  23 #include "llvm/IR/CallSite.h"
  24 #include "llvm/IR/DataLayout.h"
  25 #include "llvm/IR/DiagnosticInfo.h"
  26 #include "llvm/IR/Instructions.h"
  27 #include "llvm/IR/IntrinsicInst.h"
  28 #include "llvm/IR/Module.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Analysis/TargetLibraryInfo.h"
  33 #include "llvm/Transforms/Utils/Cloning.h"
  34 #include "llvm/Transforms/Utils/Local.h"
  35 using namespace llvm;
  36
  37 #define DEBUG_TYPE "inline"
  38
  39 STATISTIC(NumInlined, "Number of functions inlined");
  40 STATISTIC(NumCallsDeleted, "Number of call sites deleted, not inlined");
  41 STATISTIC(NumDeleted, "Number of functions deleted because all callers found");
  42 STATISTIC(NumMergedAllocas, "Number of allocas merged together");
  43
  44 // This weirdly named statistic tracks the number of times that, when attempting
  45 // to inline a function A into B, we analyze the callers of B in order to see
  46 // if those would be more profitable and blocked inline steps.
  47 STATISTIC(NumCallerCallersAnalyzed, "Number of caller-callers analyzed");
  48
  49 static cl::opt<int>
  50 InlineLimit("inline-threshold", cl::Hidden, cl::init(225), cl::ZeroOrMore,
  51         cl::desc("Control the amount of inlining to perform (default = 225)"));
  52
  53 static cl::opt<int>
  54 HintThreshold("inlinehint-threshold", cl::Hidden, cl::init(325),
  55               cl::desc("Threshold for inlining functions with inline hint"));
  56
  57 // We instroduce this threshold to help performance of instrumentation based
  58 // PGO before we actually hook up inliner with analysis passes such as BPI and
  59 // BFI.
  60 static cl::opt<int>
  61 ColdThreshold("inlinecold-threshold", cl::Hidden, cl::init(225),
  62               cl::desc("Threshold for inlining functions with cold attribute"));
  63
  64 // Threshold to use when optsize is specified (and there is no -inline-limit).
  65 const int OptSizeThreshold = 75;
  66
  67 Inliner::Inliner(char &ID)
  68   : CallGraphSCCPass(ID), InlineThreshold(InlineLimit), InsertLifetime(true) {}
  69
  70 Inliner::Inliner(char &ID, int Threshold, bool InsertLifetime)
  71   : CallGraphSCCPass(ID), InlineThreshold(InlineLimit.getNumOccurrences() > 0 ?
  72                                           InlineLimit : Threshold),
  73     InsertLifetime(InsertLifetime) {}
  74
  75 /// getAnalysisUsage - For this class, we declare that we require and preserve
  76 /// the call graph.  If the derived class implements this method, it should
  77 /// always explicitly call the implementation here.
  78 void Inliner::getAnalysisUsage(AnalysisUsage &AU) const {
  79   AU.addRequired<AliasAnalysis>();
  80   AU.addRequired<AssumptionCacheTracker>();
  81   CallGraphSCCPass::getAnalysisUsage(AU);
  82 }
  83
  84
  85 typedef DenseMap<ArrayType*, std::vector<AllocaInst*> >
  86 InlinedArrayAllocasTy;
  87
  88 /// \brief If the inlined function had a higher stack protection level than the
  89 /// calling function, then bump up the caller's stack protection level.
  90 static void AdjustCallerSSPLevel(Function *Caller, Function *Callee) {
  91   // If upgrading the SSP attribute, clear out the old SSP Attributes first.
  92   // Having multiple SSP attributes doesn't actually hurt, but it adds useless
  93   // clutter to the IR.
  94   AttrBuilder B;
  95   B.addAttribute(Attribute::StackProtect)
  96     .addAttribute(Attribute::StackProtectStrong);
  97   AttributeSet OldSSPAttr = AttributeSet::get(Caller->getContext(),
  98                                               AttributeSet::FunctionIndex,
  99                                               B);
 100
 101   if (Callee->hasFnAttribute(Attribute::StackProtectReq)) {
 102     Caller->removeAttributes(AttributeSet::FunctionIndex, OldSSPAttr);
 103     Caller->addFnAttr(Attribute::StackProtectReq);
 104   } else if (Callee->hasFnAttribute(Attribute::StackProtectStrong) &&
 105              !Caller->hasFnAttribute(Attribute::StackProtectReq)) {
 106     Caller->removeAttributes(AttributeSet::FunctionIndex, OldSSPAttr);
 107     Caller->addFnAttr(Attribute::StackProtectStrong);
 108   } else if (Callee->hasFnAttribute(Attribute::StackProtect) &&
 109              !Caller->hasFnAttribute(Attribute::StackProtectReq) &&
 110              !Caller->hasFnAttribute(Attribute::StackProtectStrong))
 111     Caller->addFnAttr(Attribute::StackProtect);
 112 }
 113
 114 /// InlineCallIfPossible - If it is possible to inline the specified call site,
 115 /// do so and update the CallGraph for this operation.
 116 ///
 117 /// This function also does some basic book-keeping to update the IR.  The
 118 /// InlinedArrayAllocas map keeps track of any allocas that are already
 119 /// available from other  functions inlined into the caller.  If we are able to
 120 /// inline this call site we attempt to reuse already available allocas or add
 121 /// any new allocas to the set if not possible.
 122 static bool InlineCallIfPossible(CallSite CS, InlineFunctionInfo &IFI,
 123                                  InlinedArrayAllocasTy &InlinedArrayAllocas,
 124                                  int InlineHistory, bool InsertLifetime) {
 125   Function *Callee = CS.getCalledFunction();
 126   Function *Caller = CS.getCaller();
 127
 128   // Try to inline the function.  Get the list of static allocas that were
 129   // inlined.
 130   if (!InlineFunction(CS, IFI, InsertLifetime))
 131     return false;
 132
 133   AdjustCallerSSPLevel(Caller, Callee);
 134
 135   // Look at all of the allocas that we inlined through this call site.  If we
 136   // have already inlined other allocas through other calls into this function,
 137   // then we know that they have disjoint lifetimes and that we can merge them.
 138   //
 139   // There are many heuristics possible for merging these allocas, and the
 140   // different options have different tradeoffs.  One thing that we *really*
 141   // don't want to hurt is SRoA: once inlining happens, often allocas are no
 142   // longer address taken and so they can be promoted.
 143   //
 144   // Our "solution" for that is to only merge allocas whose outermost type is an
 145   // array type.  These are usually not promoted because someone is using a
 146   // variable index into them.  These are also often the most important ones to
 147   // merge.
 148   //
 149   // A better solution would be to have real memory lifetime markers in the IR
 150   // and not have the inliner do any merging of allocas at all.  This would
 151   // allow the backend to do proper stack slot coloring of all allocas that
 152   // *actually make it to the backend*, which is really what we want.
 153   //
 154   // Because we don't have this information, we do this simple and useful hack.
 155   //
 156   SmallPtrSet<AllocaInst*, 16> UsedAllocas;
 157
 158   // When processing our SCC, check to see if CS was inlined from some other
 159   // call site.  For example, if we're processing "A" in this code:
 160   //   A() { B() }
 161   //   B() { x = alloca ... C() }
 162   //   C() { y = alloca ... }
 163   // Assume that C was not inlined into B initially, and so we're processing A
 164   // and decide to inline B into A.  Doing this makes an alloca available for
 165   // reuse and makes a callsite (C) available for inlining.  When we process
 166   // the C call site we don't want to do any alloca merging between X and Y
 167   // because their scopes are not disjoint.  We could make this smarter by
 168   // keeping track of the inline history for each alloca in the
 169   // InlinedArrayAllocas but this isn't likely to be a significant win.
 170   if (InlineHistory != -1)  // Only do merging for top-level call sites in SCC.
 171     return true;
 172
 173   // Loop over all the allocas we have so far and see if they can be merged with
 174   // a previously inlined alloca.  If not, remember that we had it.
 175   for (unsigned AllocaNo = 0, e = IFI.StaticAllocas.size();
 176        AllocaNo != e; ++AllocaNo) {
 177     AllocaInst *AI = IFI.StaticAllocas[AllocaNo];
 178
 179     // Don't bother trying to merge array allocations (they will usually be
 180     // canonicalized to be an allocation *of* an array), or allocations whose
 181     // type is not itself an array (because we're afraid of pessimizing SRoA).
 182     ArrayType *ATy = dyn_cast<ArrayType>(AI->getAllocatedType());
 183     if (!ATy || AI->isArrayAllocation())
 184       continue;
 185
 186     // Get the list of all available allocas for this array type.
 187     std::vector<AllocaInst*> &AllocasForType = InlinedArrayAllocas[ATy];
 188
 189     // Loop over the allocas in AllocasForType to see if we can reuse one.  Note
 190     // that we have to be careful not to reuse the same "available" alloca for
 191     // multiple different allocas that we just inlined, we use the 'UsedAllocas'
 192     // set to keep track of which "available" allocas are being used by this
 193     // function.  Also, AllocasForType can be empty of course!
 194     bool MergedAwayAlloca = false;
 195     for (unsigned i = 0, e = AllocasForType.size(); i != e; ++i) {
 196       AllocaInst *AvailableAlloca = AllocasForType[i];
 197
 198       unsigned Align1 = AI->getAlignment(),
 199                Align2 = AvailableAlloca->getAlignment();
 200
 201       // The available alloca has to be in the right function, not in some other
 202       // function in this SCC.
 203       if (AvailableAlloca->getParent() != AI->getParent())
 204         continue;
 205
 206       // If the inlined function already uses this alloca then we can't reuse
 207       // it.
 208       if (!UsedAllocas.insert(AvailableAlloca).second)
 209         continue;
 210
 211       // Otherwise, we *can* reuse it, RAUW AI into AvailableAlloca and declare
 212       // success!
 213       DEBUG(dbgs() << "    ***MERGED ALLOCA: " << *AI << "\n\t\tINTO: "
 214                    << *AvailableAlloca << '\n');
 215
 216       AI->replaceAllUsesWith(AvailableAlloca);
 217
 218       if (Align1 != Align2) {
 219         if (!Align1 || !Align2) {
 220           const DataLayout &DL = Caller->getParent()->getDataLayout();
 221           unsigned TypeAlign = DL.getABITypeAlignment(AI->getAllocatedType());
 222
 223           Align1 = Align1 ? Align1 : TypeAlign;
 224           Align2 = Align2 ? Align2 : TypeAlign;
 225         }
 226
 227         if (Align1 > Align2)
 228           AvailableAlloca->setAlignment(AI->getAlignment());
 229       }
 230
 231       AI->eraseFromParent();
 232       MergedAwayAlloca = true;
 233       ++NumMergedAllocas;
 234       IFI.StaticAllocas[AllocaNo] = nullptr;
 235       break;
 236     }
 237
 238     // If we already nuked the alloca, we're done with it.
 239     if (MergedAwayAlloca)
 240       continue;
 241
 242     // If we were unable to merge away the alloca either because there are no
 243     // allocas of the right type available or because we reused them all
 244     // already, remember that this alloca came from an inlined function and mark
 245     // it used so we don't reuse it for other allocas from this inline
 246     // operation.
 247     AllocasForType.push_back(AI);
 248     UsedAllocas.insert(AI);
 249   }
 250
 251   return true;
 252 }
 253
 254 unsigned Inliner::getInlineThreshold(CallSite CS) const {
 255   int thres = InlineThreshold; // -inline-threshold or else selected by
 256                                // overall opt level
 257
 258   // If -inline-threshold is not given, listen to the optsize attribute when it
 259   // would decrease the threshold.
 260   Function *Caller = CS.getCaller();
 261   bool OptSize = Caller && !Caller->isDeclaration() &&
 262                  Caller->hasFnAttribute(Attribute::OptimizeForSize);
 263   if (!(InlineLimit.getNumOccurrences() > 0) && OptSize &&
 264       OptSizeThreshold < thres)
 265     thres = OptSizeThreshold;
 266
 267   // Listen to the inlinehint attribute when it would increase the threshold
 268   // and the caller does not need to minimize its size.
 269   Function *Callee = CS.getCalledFunction();
 270   bool InlineHint = Callee && !Callee->isDeclaration() &&
 271                     Callee->hasFnAttribute(Attribute::InlineHint);
 272   if (InlineHint && HintThreshold > thres &&
 273       !Caller->hasFnAttribute(Attribute::MinSize))
 274     thres = HintThreshold;
 275
 276   // Listen to the cold attribute when it would decrease the threshold.
 277   bool ColdCallee = Callee && !Callee->isDeclaration() &&
 278                     Callee->hasFnAttribute(Attribute::Cold);
 279   // Command line argument for InlineLimit will override the default
 280   // ColdThreshold. If we have -inline-threshold but no -inlinecold-threshold,
 281   // do not use the default cold threshold even if it is smaller.
 282   if ((InlineLimit.getNumOccurrences() == 0 ||
 283        ColdThreshold.getNumOccurrences() > 0) && ColdCallee &&
 284       ColdThreshold < thres)
 285     thres = ColdThreshold;
 286
 287   return thres;
 288 }
 289
 290 static void emitAnalysis(CallSite CS, const Twine &Msg) {
 291   Function *Caller = CS.getCaller();
 292   LLVMContext &Ctx = Caller->getContext();
 293   DebugLoc DLoc = CS.getInstruction()->getDebugLoc();
 294   emitOptimizationRemarkAnalysis(Ctx, DEBUG_TYPE, *Caller, DLoc, Msg);
 295 }
 296
 297 /// shouldInline - Return true if the inliner should attempt to inline
 298 /// at the given CallSite.
 299 bool Inliner::shouldInline(CallSite CS) {
 300   InlineCost IC = getInlineCost(CS);
 301
 302   if (IC.isAlways()) {
 303     DEBUG(dbgs() << "    Inlining: cost=always"
 304           << ", Call: " << *CS.getInstruction() << "\n");
 305     emitAnalysis(CS, Twine(CS.getCalledFunction()->getName()) +
 306                          " should always be inlined (cost=always)");
 307     return true;
 308   }
 309
 310   if (IC.isNever()) {
 311     DEBUG(dbgs() << "    NOT Inlining: cost=never"
 312           << ", Call: " << *CS.getInstruction() << "\n");
 313     emitAnalysis(CS, Twine(CS.getCalledFunction()->getName() +
 314                            " should never be inlined (cost=never)"));
 315     return false;
 316   }
 317
 318   Function *Caller = CS.getCaller();
 319   if (!IC) {
 320     DEBUG(dbgs() << "    NOT Inlining: cost=" << IC.getCost()
 321           << ", thres=" << (IC.getCostDelta() + IC.getCost())
 322           << ", Call: " << *CS.getInstruction() << "\n");
 323     emitAnalysis(CS, Twine(CS.getCalledFunction()->getName() +
 324                            " too costly to inline (cost=") +
 325                          Twine(IC.getCost()) + ", threshold=" +
 326                          Twine(IC.getCostDelta() + IC.getCost()) + ")");
 327     return false;
 328   }
 329
 330   // Try to detect the case where the current inlining candidate caller (call
 331   // it B) is a static or linkonce-ODR function and is an inlining candidate
 332   // elsewhere, and the current candidate callee (call it C) is large enough
 333   // that inlining it into B would make B too big to inline later. In these
 334   // circumstances it may be best not to inline C into B, but to inline B into
 335   // its callers.
 336   //
 337   // This only applies to static and linkonce-ODR functions because those are
 338   // expected to be available for inlining in the translation units where they
 339   // are used. Thus we will always have the opportunity to make local inlining
 340   // decisions. Importantly the linkonce-ODR linkage covers inline functions
 341   // and templates in C++.
 342   //
 343   // FIXME: All of this logic should be sunk into getInlineCost. It relies on
 344   // the internal implementation of the inline cost metrics rather than
 345   // treating them as truly abstract units etc.
 346   if (Caller->hasLocalLinkage() || Caller->hasLinkOnceODRLinkage()) {
 347     int TotalSecondaryCost = 0;
 348     // The candidate cost to be imposed upon the current function.
 349     int CandidateCost = IC.getCost() - (InlineConstants::CallPenalty + 1);
 350     // This bool tracks what happens if we do NOT inline C into B.
 351     bool callerWillBeRemoved = Caller->hasLocalLinkage();
 352     // This bool tracks what happens if we DO inline C into B.
 353     bool inliningPreventsSomeOuterInline = false;
 354     for (User *U : Caller->users()) {
 355       CallSite CS2(U);
 356
 357       // If this isn't a call to Caller (it could be some other sort
 358       // of reference) skip it.  Such references will prevent the caller
 359       // from being removed.
 360       if (!CS2 || CS2.getCalledFunction() != Caller) {
 361         callerWillBeRemoved = false;
 362         continue;
 363       }
 364
 365       InlineCost IC2 = getInlineCost(CS2);
 366       ++NumCallerCallersAnalyzed;
 367       if (!IC2) {
 368         callerWillBeRemoved = false;
 369         continue;
 370       }
 371       if (IC2.isAlways())
 372         continue;
 373
 374       // See if inlining or original callsite would erase the cost delta of
 375       // this callsite. We subtract off the penalty for the call instruction,
 376       // which we would be deleting.
 377       if (IC2.getCostDelta() <= CandidateCost) {
 378         inliningPreventsSomeOuterInline = true;
 379         TotalSecondaryCost += IC2.getCost();
 380       }
 381     }
 382     // If all outer calls to Caller would get inlined, the cost for the last
 383     // one is set very low by getInlineCost, in anticipation that Caller will
 384     // be removed entirely.  We did not account for this above unless there
 385     // is only one caller of Caller.
 386     if (callerWillBeRemoved && !Caller->use_empty())
 387       TotalSecondaryCost += InlineConstants::LastCallToStaticBonus;
 388
 389     if (inliningPreventsSomeOuterInline && TotalSecondaryCost < IC.getCost()) {
 390       DEBUG(dbgs() << "    NOT Inlining: " << *CS.getInstruction() <<
 391            " Cost = " << IC.getCost() <<
 392            ", outer Cost = " << TotalSecondaryCost << '\n');
 393       emitAnalysis(
 394           CS, Twine("Not inlining. Cost of inlining " +
 395                     CS.getCalledFunction()->getName() +
 396                     " increases the cost of inlining " +
 397                     CS.getCaller()->getName() + " in other contexts"));
 398       return false;
 399     }
 400   }
 401
 402   DEBUG(dbgs() << "    Inlining: cost=" << IC.getCost()
 403         << ", thres=" << (IC.getCostDelta() + IC.getCost())
 404         << ", Call: " << *CS.getInstruction() << '\n');
 405   emitAnalysis(
 406       CS, CS.getCalledFunction()->getName() + Twine(" can be inlined into ") +
 407               CS.getCaller()->getName() + " with cost=" + Twine(IC.getCost()) +
 408               " (threshold=" + Twine(IC.getCostDelta() + IC.getCost()) + ")");
 409   return true;
 410 }
 411
 412 /// InlineHistoryIncludes - Return true if the specified inline history ID
 413 /// indicates an inline history that includes the specified function.
 414 static bool InlineHistoryIncludes(Function *F, int InlineHistoryID,
 415             const SmallVectorImpl<std::pair<Function*, int> > &InlineHistory) {
 416   while (InlineHistoryID != -1) {
 417     assert(unsigned(InlineHistoryID) < InlineHistory.size() &&
 418            "Invalid inline history ID");
 419     if (InlineHistory[InlineHistoryID].first == F)
 420       return true;
 421     InlineHistoryID = InlineHistory[InlineHistoryID].second;
 422   }
 423   return false;
 424 }
 425
 426 bool Inliner::runOnSCC(CallGraphSCC &SCC) {
 427   CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph();
 428   AssumptionCacheTracker *ACT = &getAnalysis<AssumptionCacheTracker>();
 429   auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
 430   const TargetLibraryInfo *TLI = TLIP ? &TLIP->getTLI() : nullptr;
 431   AliasAnalysis *AA = &getAnalysis<AliasAnalysis>();
 432
 433   SmallPtrSet<Function*, 8> SCCFunctions;
 434   DEBUG(dbgs() << "Inliner visiting SCC:");
 435   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 436     Function *F = (*I)->getFunction();
 437     if (F) SCCFunctions.insert(F);
 438     DEBUG(dbgs() << " " << (F ? F->getName() : "INDIRECTNODE"));
 439   }
 440
 441   // Scan through and identify all call sites ahead of time so that we only
 442   // inline call sites in the original functions, not call sites that result
 443   // from inlining other functions.
 444   SmallVector<std::pair<CallSite, int>, 16> CallSites;
 445
 446   // When inlining a callee produces new call sites, we want to keep track of
 447   // the fact that they were inlined from the callee.  This allows us to avoid
 448   // infinite inlining in some obscure cases.  To represent this, we use an
 449   // index into the InlineHistory vector.
 450   SmallVector<std::pair<Function*, int>, 8> InlineHistory;
 451
 452   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 453     Function *F = (*I)->getFunction();
 454     if (!F) continue;
 455
 456     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 457       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 458         CallSite CS(cast<Value>(I));
 459         // If this isn't a call, or it is a call to an intrinsic, it can
 460         // never be inlined.
 461         if (!CS || isa<IntrinsicInst>(I))
 462           continue;
 463
 464         // If this is a direct call to an external function, we can never inline
 465         // it.  If it is an indirect call, inlining may resolve it to be a
 466         // direct call, so we keep it.
 467         if (CS.getCalledFunction() && CS.getCalledFunction()->isDeclaration())
 468           continue;
 469
 470         CallSites.push_back(std::make_pair(CS, -1));
 471       }
 472   }
 473
 474   DEBUG(dbgs() << ": " << CallSites.size() << " call sites.\n");
 475
 476   // If there are no calls in this function, exit early.
 477   if (CallSites.empty())
 478     return false;
 479
 480   // Now that we have all of the call sites, move the ones to functions in the
 481   // current SCC to the end of the list.
 482   unsigned FirstCallInSCC = CallSites.size();
 483   for (unsigned i = 0; i < FirstCallInSCC; ++i)
 484     if (Function *F = CallSites[i].first.getCalledFunction())
 485       if (SCCFunctions.count(F))
 486         std::swap(CallSites[i--], CallSites[--FirstCallInSCC]);
 487
 488
 489   InlinedArrayAllocasTy InlinedArrayAllocas;
 490   InlineFunctionInfo InlineInfo(&CG, AA, ACT);
 491
 492   // Now that we have all of the call sites, loop over them and inline them if
 493   // it looks profitable to do so.
 494   bool Changed = false;
 495   bool LocalChange;
 496   do {
 497     LocalChange = false;
 498     // Iterate over the outer loop because inlining functions can cause indirect
 499     // calls to become direct calls.
 500     for (unsigned CSi = 0; CSi != CallSites.size(); ++CSi) {
 501       CallSite CS = CallSites[CSi].first;
 502
 503       Function *Caller = CS.getCaller();
 504       Function *Callee = CS.getCalledFunction();
 505
 506       // If this call site is dead and it is to a readonly function, we should
 507       // just delete the call instead of trying to inline it, regardless of
 508       // size.  This happens because IPSCCP propagates the result out of the
 509       // call and then we're left with the dead call.
 510       if (isInstructionTriviallyDead(CS.getInstruction(), TLI)) {
 511         DEBUG(dbgs() << "    -> Deleting dead call: "
 512                      << *CS.getInstruction() << "\n");
 513         // Update the call graph by deleting the edge from Callee to Caller.
 514         CG[Caller]->removeCallEdgeFor(CS);
 515         CS.getInstruction()->eraseFromParent();
 516         ++NumCallsDeleted;
 517       } else {
 518         // We can only inline direct calls to non-declarations.
 519         if (!Callee || Callee->isDeclaration()) continue;
 520
 521         // If this call site was obtained by inlining another function, verify
 522         // that the include path for the function did not include the callee
 523         // itself.  If so, we'd be recursively inlining the same function,
 524         // which would provide the same callsites, which would cause us to
 525         // infinitely inline.
 526         int InlineHistoryID = CallSites[CSi].second;
 527         if (InlineHistoryID != -1 &&
 528             InlineHistoryIncludes(Callee, InlineHistoryID, InlineHistory))
 529           continue;
 530
 531         LLVMContext &CallerCtx = Caller->getContext();
 532
 533         // Get DebugLoc to report. CS will be invalid after Inliner.
 534         DebugLoc DLoc = CS.getInstruction()->getDebugLoc();
 535
 536         // If the policy determines that we should inline this function,
 537         // try to do so.
 538         if (!shouldInline(CS)) {
 539           emitOptimizationRemarkMissed(CallerCtx, DEBUG_TYPE, *Caller, DLoc,
 540                                        Twine(Callee->getName() +
 541                                              " will not be inlined into " +
 542                                              Caller->getName()));
 543           continue;
 544         }
 545
 546         // Attempt to inline the function.
 547         if (!InlineCallIfPossible(CS, InlineInfo, InlinedArrayAllocas,
 548                                   InlineHistoryID, InsertLifetime)) {
 549           emitOptimizationRemarkMissed(CallerCtx, DEBUG_TYPE, *Caller, DLoc,
 550                                        Twine(Callee->getName() +
 551                                              " will not be inlined into " +
 552                                              Caller->getName()));
 553           continue;
 554         }
 555         ++NumInlined;
 556
 557         // Report the inline decision.
 558         emitOptimizationRemark(
 559             CallerCtx, DEBUG_TYPE, *Caller, DLoc,
 560             Twine(Callee->getName() + " inlined into " + Caller->getName()));
 561
 562         // If inlining this function gave us any new call sites, throw them
 563         // onto our worklist to process.  They are useful inline candidates.
 564         if (!InlineInfo.InlinedCalls.empty()) {
 565           // Create a new inline history entry for this, so that we remember
 566           // that these new callsites came about due to inlining Callee.
 567           int NewHistoryID = InlineHistory.size();
 568           InlineHistory.push_back(std::make_pair(Callee, InlineHistoryID));
 569
 570           for (unsigned i = 0, e = InlineInfo.InlinedCalls.size();
 571                i != e; ++i) {
 572             Value *Ptr = InlineInfo.InlinedCalls[i];
 573             CallSites.push_back(std::make_pair(CallSite(Ptr), NewHistoryID));
 574           }
 575         }
 576       }
 577
 578       // If we inlined or deleted the last possible call site to the function,
 579       // delete the function body now.
 580       if (Callee && Callee->use_empty() && Callee->hasLocalLinkage() &&
 581           // TODO: Can remove if in SCC now.
 582           !SCCFunctions.count(Callee) &&
 583
 584           // The function may be apparently dead, but if there are indirect
 585           // callgraph references to the node, we cannot delete it yet, this
 586           // could invalidate the CGSCC iterator.
 587           CG[Callee]->getNumReferences() == 0) {
 588         DEBUG(dbgs() << "    -> Deleting dead function: "
 589               << Callee->getName() << "\n");
 590         CallGraphNode *CalleeNode = CG[Callee];
 591
 592         // Remove any call graph edges from the callee to its callees.
 593         CalleeNode->removeAllCalledFunctions();
 594
 595         // Removing the node for callee from the call graph and delete it.
 596         delete CG.removeFunctionFromModule(CalleeNode);
 597         ++NumDeleted;
 598       }
 599
 600       // Remove this call site from the list.  If possible, use
 601       // swap/pop_back for efficiency, but do not use it if doing so would
 602       // move a call site to a function in this SCC before the
 603       // 'FirstCallInSCC' barrier.
 604       if (SCC.isSingular()) {
 605         CallSites[CSi] = CallSites.back();
 606         CallSites.pop_back();
 607       } else {
 608         CallSites.erase(CallSites.begin()+CSi);
 609       }
 610       --CSi;
 611
 612       Changed = true;
 613       LocalChange = true;
 614     }
 615   } while (LocalChange);
 616
 617   return Changed;
 618 }
 619
 620 // doFinalization - Remove now-dead linkonce functions at the end of
 621 // processing to avoid breaking the SCC traversal.
 622 bool Inliner::doFinalization(CallGraph &CG) {
 623   return removeDeadFunctions(CG);
 624 }
 625
 626 /// removeDeadFunctions - Remove dead functions that are not included in
 627 /// DNR (Do Not Remove) list.
 628 bool Inliner::removeDeadFunctions(CallGraph &CG, bool AlwaysInlineOnly) {
 629   SmallVector<CallGraphNode*, 16> FunctionsToRemove;
 630
 631   // Scan for all of the functions, looking for ones that should now be removed
 632   // from the program.  Insert the dead ones in the FunctionsToRemove set.
 633   for (CallGraph::iterator I = CG.begin(), E = CG.end(); I != E; ++I) {
 634     CallGraphNode *CGN = I->second;
 635     Function *F = CGN->getFunction();
 636     if (!F || F->isDeclaration())
 637       continue;
 638
 639     // Handle the case when this function is called and we only want to care
 640     // about always-inline functions. This is a bit of a hack to share code
 641     // between here and the InlineAlways pass.
 642     if (AlwaysInlineOnly && !F->hasFnAttribute(Attribute::AlwaysInline))
 643       continue;
 644
 645     // If the only remaining users of the function are dead constants, remove
 646     // them.
 647     F->removeDeadConstantUsers();
 648
 649     if (!F->isDefTriviallyDead())
 650       continue;
 651
 652     // It is unsafe to drop a function with discardable linkage from a COMDAT
 653     // without also dropping the other members of the COMDAT.
 654     // The inliner doesn't visit non-function entities which are in COMDAT
 655     // groups so it is unsafe to do so *unless* the linkage is local.
 656     if (!F->hasLocalLinkage() && F->hasComdat())
 657       continue;
 658
 659     // Remove any call graph edges from the function to its callees.
 660     CGN->removeAllCalledFunctions();
 661
 662     // Remove any edges from the external node to the function's call graph
 663     // node.  These edges might have been made irrelegant due to
 664     // optimization of the program.
 665     CG.getExternalCallingNode()->removeAnyCallEdgeTo(CGN);
 666
 667     // Removing the node for callee from the call graph and delete it.
 668     FunctionsToRemove.push_back(CGN);
 669   }
 670   if (FunctionsToRemove.empty())
 671     return false;
 672
 673   // Now that we know which functions to delete, do so.  We didn't want to do
 674   // this inline, because that would invalidate our CallGraph::iterator
 675   // objects. :(
 676   //
 677   // Note that it doesn't matter that we are iterating over a non-stable order
 678   // here to do this, it doesn't matter which order the functions are deleted
 679   // in.
 680   array_pod_sort(FunctionsToRemove.begin(), FunctionsToRemove.end());
 681   FunctionsToRemove.erase(std::unique(FunctionsToRemove.begin(),
 682                                       FunctionsToRemove.end()),
 683                           FunctionsToRemove.end());
 684   for (SmallVectorImpl<CallGraphNode *>::iterator I = FunctionsToRemove.begin(),
 685                                                   E = FunctionsToRemove.end();
 686        I != E; ++I) {
 687     delete CG.removeFunctionFromModule(*I);
 688     ++NumDeleted;
 689   }
 690   return true;
 691 }