Chris Lattner | 7d30a6c | 2004-06-20 04:11:48 +0000 | [diff] [blame] | 1 | //===- Inliner.cpp - Code common to all inliners --------------------------===// |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | f3ebc3f | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 9 | // |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 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. |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 16 | #include "llvm/Transforms/IPO/Inliner.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 17 | #include "llvm/ADT/DenseMap.h" |
| 18 | #include "llvm/ADT/None.h" |
| 19 | #include "llvm/ADT/Optional.h" |
| 20 | #include "llvm/ADT/STLExtras.h" |
| 21 | #include "llvm/ADT/SetVector.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 22 | #include "llvm/ADT/SmallPtrSet.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/SmallVector.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 24 | #include "llvm/ADT/Statistic.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 25 | #include "llvm/ADT/StringRef.h" |
Hal Finkel | 0c08302 | 2014-09-01 09:01:39 +0000 | [diff] [blame] | 26 | #include "llvm/Analysis/AliasAnalysis.h" |
Daniel Jasper | aec2fa3 | 2016-12-19 08:22:17 +0000 | [diff] [blame] | 27 | #include "llvm/Analysis/AssumptionCache.h" |
Chandler Carruth | 7b560d4 | 2015-09-09 17:55:00 +0000 | [diff] [blame] | 28 | #include "llvm/Analysis/BasicAliasAnalysis.h" |
Easwaran Raman | 12585b0 | 2017-01-20 22:44:04 +0000 | [diff] [blame] | 29 | #include "llvm/Analysis/BlockFrequencyInfo.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 30 | #include "llvm/Analysis/CGSCCPassManager.h" |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 31 | #include "llvm/Analysis/CallGraph.h" |
Dan Gohman | 4552e3c | 2009-10-13 18:30:07 +0000 | [diff] [blame] | 32 | #include "llvm/Analysis/InlineCost.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 33 | #include "llvm/Analysis/LazyCallGraph.h" |
Adam Nemet | 0965da2 | 2017-10-09 23:19:02 +0000 | [diff] [blame] | 34 | #include "llvm/Analysis/OptimizationRemarkEmitter.h" |
Easwaran Raman | 71069cf | 2016-06-09 22:23:21 +0000 | [diff] [blame] | 35 | #include "llvm/Analysis/ProfileSummaryInfo.h" |
Benjamin Kramer | 799003b | 2015-03-23 19:32:43 +0000 | [diff] [blame] | 36 | #include "llvm/Analysis/TargetLibraryInfo.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 37 | #include "llvm/Analysis/TargetTransformInfo.h" |
David Blaikie | 31b98d2 | 2018-06-04 21:23:21 +0000 | [diff] [blame] | 38 | #include "llvm/Transforms/Utils/Local.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 39 | #include "llvm/IR/Attributes.h" |
| 40 | #include "llvm/IR/BasicBlock.h" |
Chandler Carruth | 219b89b | 2014-03-04 11:01:28 +0000 | [diff] [blame] | 41 | #include "llvm/IR/CallSite.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 42 | #include "llvm/IR/DataLayout.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 43 | #include "llvm/IR/DebugLoc.h" |
| 44 | #include "llvm/IR/DerivedTypes.h" |
Diego Novillo | a9298b2 | 2014-04-08 16:42:34 +0000 | [diff] [blame] | 45 | #include "llvm/IR/DiagnosticInfo.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 46 | #include "llvm/IR/Function.h" |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 47 | #include "llvm/IR/InstIterator.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 48 | #include "llvm/IR/Instruction.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 49 | #include "llvm/IR/Instructions.h" |
| 50 | #include "llvm/IR/IntrinsicInst.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 51 | #include "llvm/IR/Metadata.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 52 | #include "llvm/IR/Module.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 53 | #include "llvm/IR/PassManager.h" |
| 54 | #include "llvm/IR/User.h" |
| 55 | #include "llvm/IR/Value.h" |
| 56 | #include "llvm/Pass.h" |
| 57 | #include "llvm/Support/Casting.h" |
| 58 | #include "llvm/Support/CommandLine.h" |
Reid Spencer | 7c16caa | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 59 | #include "llvm/Support/Debug.h" |
Daniel Dunbar | 0dd5e1e | 2009-07-25 00:23:56 +0000 | [diff] [blame] | 60 | #include "llvm/Support/raw_ostream.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 61 | #include "llvm/Transforms/Utils/Cloning.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 62 | #include "llvm/Transforms/Utils/ImportedFunctionsInliningStatistics.h" |
Chandler Carruth | 6e9bb7e | 2016-12-26 23:43:27 +0000 | [diff] [blame] | 63 | #include "llvm/Transforms/Utils/ModuleUtils.h" |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 64 | #include <algorithm> |
| 65 | #include <cassert> |
| 66 | #include <functional> |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 67 | #include <sstream> |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 68 | #include <tuple> |
| 69 | #include <utility> |
| 70 | #include <vector> |
| 71 | |
Chris Lattner | a82f131 | 2003-11-21 21:45:31 +0000 | [diff] [blame] | 72 | using namespace llvm; |
Brian Gaeke | 960707c | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 73 | |
Chandler Carruth | 964daaa | 2014-04-22 02:55:47 +0000 | [diff] [blame] | 74 | #define DEBUG_TYPE "inline" |
| 75 | |
Chris Lattner | 1631bcb | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 76 | STATISTIC(NumInlined, "Number of functions inlined"); |
Chris Lattner | b49a622 | 2010-05-01 17:19:38 +0000 | [diff] [blame] | 77 | STATISTIC(NumCallsDeleted, "Number of call sites deleted, not inlined"); |
Chris Lattner | 1631bcb | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 78 | STATISTIC(NumDeleted, "Number of functions deleted because all callers found"); |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 79 | STATISTIC(NumMergedAllocas, "Number of allocas merged together"); |
Chris Lattner | 1631bcb | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 80 | |
Benjamin Kramer | bde9176 | 2012-06-02 10:20:22 +0000 | [diff] [blame] | 81 | // This weirdly named statistic tracks the number of times that, when attempting |
Chandler Carruth | 7ae90d4 | 2012-04-11 10:15:10 +0000 | [diff] [blame] | 82 | // to inline a function A into B, we analyze the callers of B in order to see |
| 83 | // if those would be more profitable and blocked inline steps. |
| 84 | STATISTIC(NumCallerCallersAnalyzed, "Number of caller-callers analyzed"); |
| 85 | |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 86 | /// Flag to disable manual alloca merging. |
| 87 | /// |
| 88 | /// Merging of allocas was originally done as a stack-size saving technique |
| 89 | /// prior to LLVM's code generator having support for stack coloring based on |
| 90 | /// lifetime markers. It is now in the process of being removed. To experiment |
| 91 | /// with disabling it and relying fully on lifetime marker based stack |
| 92 | /// coloring, you can pass this flag to LLVM. |
| 93 | static cl::opt<bool> |
| 94 | DisableInlinedAllocaMerging("disable-inlined-alloca-merging", |
| 95 | cl::init(false), cl::Hidden); |
| 96 | |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 97 | namespace { |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 98 | |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 99 | enum class InlinerFunctionImportStatsOpts { |
| 100 | No = 0, |
| 101 | Basic = 1, |
| 102 | Verbose = 2, |
| 103 | }; |
| 104 | |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 105 | } // end anonymous namespace |
| 106 | |
| 107 | static cl::opt<InlinerFunctionImportStatsOpts> InlinerFunctionImportStats( |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 108 | "inliner-function-import-stats", |
| 109 | cl::init(InlinerFunctionImportStatsOpts::No), |
| 110 | cl::values(clEnumValN(InlinerFunctionImportStatsOpts::Basic, "basic", |
| 111 | "basic statistics"), |
| 112 | clEnumValN(InlinerFunctionImportStatsOpts::Verbose, "verbose", |
Mehdi Amini | 732afdd | 2016-10-08 19:41:06 +0000 | [diff] [blame] | 113 | "printing of statistics for each inlined function")), |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 114 | cl::Hidden, cl::desc("Enable inliner stats for imported functions")); |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 115 | |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 116 | /// Flag to add inline messages as callsite attributes 'inline-remark'. |
| 117 | static cl::opt<bool> |
| 118 | InlineRemarkAttribute("inline-remark-attribute", cl::init(false), |
| 119 | cl::Hidden, |
| 120 | cl::desc("Enable adding inline-remark attribute to" |
| 121 | " callsites processed by inliner but decided" |
| 122 | " to be not inlined")); |
| 123 | |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 124 | LegacyInlinerBase::LegacyInlinerBase(char &ID) : CallGraphSCCPass(ID) {} |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 125 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 126 | LegacyInlinerBase::LegacyInlinerBase(char &ID, bool InsertLifetime) |
Easwaran Raman | b1bd398 | 2016-03-08 00:36:35 +0000 | [diff] [blame] | 127 | : CallGraphSCCPass(ID), InsertLifetime(InsertLifetime) {} |
Chris Lattner | 22ad7ab | 2008-01-12 06:49:13 +0000 | [diff] [blame] | 128 | |
Sanjay Patel | f1b0db1 | 2015-03-10 16:42:24 +0000 | [diff] [blame] | 129 | /// For this class, we declare that we require and preserve the call graph. |
| 130 | /// If the derived class implements this method, it should |
Chris Lattner | f94bed3 | 2007-01-30 23:28:39 +0000 | [diff] [blame] | 131 | /// always explicitly call the implementation here. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 132 | void LegacyInlinerBase::getAnalysisUsage(AnalysisUsage &AU) const { |
Daniel Jasper | aec2fa3 | 2016-12-19 08:22:17 +0000 | [diff] [blame] | 133 | AU.addRequired<AssumptionCacheTracker>(); |
Easwaran Raman | 71069cf | 2016-06-09 22:23:21 +0000 | [diff] [blame] | 134 | AU.addRequired<ProfileSummaryInfoWrapperPass>(); |
Chandler Carruth | 7b560d4 | 2015-09-09 17:55:00 +0000 | [diff] [blame] | 135 | AU.addRequired<TargetLibraryInfoWrapperPass>(); |
Chandler Carruth | 12884f7 | 2016-03-02 15:56:53 +0000 | [diff] [blame] | 136 | getAAResultsAnalysisUsage(AU); |
Chandler Carruth | e40e60e | 2012-12-27 11:17:15 +0000 | [diff] [blame] | 137 | CallGraphSCCPass::getAnalysisUsage(AU); |
Chris Lattner | f94bed3 | 2007-01-30 23:28:39 +0000 | [diff] [blame] | 138 | } |
| 139 | |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 140 | using InlinedArrayAllocasTy = DenseMap<ArrayType *, std::vector<AllocaInst *>>; |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 141 | |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 142 | /// Look at all of the allocas that we inlined through this call site. If we |
| 143 | /// have already inlined other allocas through other calls into this function, |
| 144 | /// then we know that they have disjoint lifetimes and that we can merge them. |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 145 | /// |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 146 | /// There are many heuristics possible for merging these allocas, and the |
| 147 | /// different options have different tradeoffs. One thing that we *really* |
| 148 | /// don't want to hurt is SRoA: once inlining happens, often allocas are no |
| 149 | /// longer address taken and so they can be promoted. |
| 150 | /// |
| 151 | /// Our "solution" for that is to only merge allocas whose outermost type is an |
| 152 | /// array type. These are usually not promoted because someone is using a |
| 153 | /// variable index into them. These are also often the most important ones to |
| 154 | /// merge. |
| 155 | /// |
| 156 | /// A better solution would be to have real memory lifetime markers in the IR |
| 157 | /// and not have the inliner do any merging of allocas at all. This would |
| 158 | /// allow the backend to do proper stack slot coloring of all allocas that |
| 159 | /// *actually make it to the backend*, which is really what we want. |
| 160 | /// |
| 161 | /// Because we don't have this information, we do this simple and useful hack. |
| 162 | static void mergeInlinedArrayAllocas( |
| 163 | Function *Caller, InlineFunctionInfo &IFI, |
| 164 | InlinedArrayAllocasTy &InlinedArrayAllocas, int InlineHistory) { |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 165 | SmallPtrSet<AllocaInst *, 16> UsedAllocas; |
| 166 | |
Chris Lattner | fb212de | 2010-12-06 07:52:42 +0000 | [diff] [blame] | 167 | // When processing our SCC, check to see if CS was inlined from some other |
| 168 | // call site. For example, if we're processing "A" in this code: |
| 169 | // A() { B() } |
| 170 | // B() { x = alloca ... C() } |
| 171 | // C() { y = alloca ... } |
| 172 | // Assume that C was not inlined into B initially, and so we're processing A |
| 173 | // and decide to inline B into A. Doing this makes an alloca available for |
| 174 | // reuse and makes a callsite (C) available for inlining. When we process |
| 175 | // the C call site we don't want to do any alloca merging between X and Y |
| 176 | // because their scopes are not disjoint. We could make this smarter by |
| 177 | // keeping track of the inline history for each alloca in the |
| 178 | // InlinedArrayAllocas but this isn't likely to be a significant win. |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 179 | if (InlineHistory != -1) // Only do merging for top-level call sites in SCC. |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 180 | return; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 181 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 182 | // Loop over all the allocas we have so far and see if they can be merged with |
| 183 | // a previously inlined alloca. If not, remember that we had it. |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 184 | for (unsigned AllocaNo = 0, e = IFI.StaticAllocas.size(); AllocaNo != e; |
| 185 | ++AllocaNo) { |
Chris Lattner | 4ba01ec | 2010-04-22 23:07:58 +0000 | [diff] [blame] | 186 | AllocaInst *AI = IFI.StaticAllocas[AllocaNo]; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 187 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 188 | // Don't bother trying to merge array allocations (they will usually be |
| 189 | // canonicalized to be an allocation *of* an array), or allocations whose |
| 190 | // type is not itself an array (because we're afraid of pessimizing SRoA). |
Chris Lattner | 229907c | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 191 | ArrayType *ATy = dyn_cast<ArrayType>(AI->getAllocatedType()); |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 192 | if (!ATy || AI->isArrayAllocation()) |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 193 | continue; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 194 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 195 | // Get the list of all available allocas for this array type. |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 196 | std::vector<AllocaInst *> &AllocasForType = InlinedArrayAllocas[ATy]; |
| 197 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 198 | // Loop over the allocas in AllocasForType to see if we can reuse one. Note |
| 199 | // that we have to be careful not to reuse the same "available" alloca for |
| 200 | // multiple different allocas that we just inlined, we use the 'UsedAllocas' |
| 201 | // set to keep track of which "available" allocas are being used by this |
| 202 | // function. Also, AllocasForType can be empty of course! |
| 203 | bool MergedAwayAlloca = false; |
Yaron Keren | 62064d6 | 2015-06-25 19:28:24 +0000 | [diff] [blame] | 204 | for (AllocaInst *AvailableAlloca : AllocasForType) { |
Hal Finkel | 9caa8f7 | 2013-07-16 17:10:55 +0000 | [diff] [blame] | 205 | unsigned Align1 = AI->getAlignment(), |
| 206 | Align2 = AvailableAlloca->getAlignment(); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 207 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 208 | // The available alloca has to be in the right function, not in some other |
| 209 | // function in this SCC. |
| 210 | if (AvailableAlloca->getParent() != AI->getParent()) |
| 211 | continue; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 212 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 213 | // If the inlined function already uses this alloca then we can't reuse |
| 214 | // it. |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 215 | if (!UsedAllocas.insert(AvailableAlloca).second) |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 216 | continue; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 217 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 218 | // Otherwise, we *can* reuse it, RAUW AI into AvailableAlloca and declare |
| 219 | // success! |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 220 | LLVM_DEBUG(dbgs() << " ***MERGED ALLOCA: " << *AI |
| 221 | << "\n\t\tINTO: " << *AvailableAlloca << '\n'); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 222 | |
Evgeniy Stepanov | d8b86f7 | 2015-09-29 00:30:19 +0000 | [diff] [blame] | 223 | // Move affected dbg.declare calls immediately after the new alloca to |
Simon Pilgrim | 7d18a70 | 2016-11-20 13:19:49 +0000 | [diff] [blame] | 224 | // avoid the situation when a dbg.declare precedes its alloca. |
Evgeniy Stepanov | d8b86f7 | 2015-09-29 00:30:19 +0000 | [diff] [blame] | 225 | if (auto *L = LocalAsMetadata::getIfExists(AI)) |
| 226 | if (auto *MDV = MetadataAsValue::getIfExists(AI->getContext(), L)) |
| 227 | for (User *U : MDV->users()) |
| 228 | if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(U)) |
| 229 | DDI->moveBefore(AvailableAlloca->getNextNode()); |
| 230 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 231 | AI->replaceAllUsesWith(AvailableAlloca); |
Hal Finkel | 9caa8f7 | 2013-07-16 17:10:55 +0000 | [diff] [blame] | 232 | |
Hal Finkel | ec7cd26 | 2013-07-17 14:32:41 +0000 | [diff] [blame] | 233 | if (Align1 != Align2) { |
| 234 | if (!Align1 || !Align2) { |
Mehdi Amini | 46a4355 | 2015-03-04 18:43:29 +0000 | [diff] [blame] | 235 | const DataLayout &DL = Caller->getParent()->getDataLayout(); |
| 236 | unsigned TypeAlign = DL.getABITypeAlignment(AI->getAllocatedType()); |
Hal Finkel | ec7cd26 | 2013-07-17 14:32:41 +0000 | [diff] [blame] | 237 | |
| 238 | Align1 = Align1 ? Align1 : TypeAlign; |
| 239 | Align2 = Align2 ? Align2 : TypeAlign; |
| 240 | } |
| 241 | |
| 242 | if (Align1 > Align2) |
| 243 | AvailableAlloca->setAlignment(AI->getAlignment()); |
| 244 | } |
Hal Finkel | 9caa8f7 | 2013-07-16 17:10:55 +0000 | [diff] [blame] | 245 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 246 | AI->eraseFromParent(); |
| 247 | MergedAwayAlloca = true; |
| 248 | ++NumMergedAllocas; |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 249 | IFI.StaticAllocas[AllocaNo] = nullptr; |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 250 | break; |
| 251 | } |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 252 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 253 | // If we already nuked the alloca, we're done with it. |
| 254 | if (MergedAwayAlloca) |
| 255 | continue; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 256 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 257 | // If we were unable to merge away the alloca either because there are no |
| 258 | // allocas of the right type available or because we reused them all |
| 259 | // already, remember that this alloca came from an inlined function and mark |
| 260 | // it used so we don't reuse it for other allocas from this inline |
| 261 | // operation. |
| 262 | AllocasForType.push_back(AI); |
| 263 | UsedAllocas.insert(AI); |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 264 | } |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 265 | } |
| 266 | |
| 267 | /// If it is possible to inline the specified call site, |
| 268 | /// do so and update the CallGraph for this operation. |
| 269 | /// |
| 270 | /// This function also does some basic book-keeping to update the IR. The |
| 271 | /// InlinedArrayAllocas map keeps track of any allocas that are already |
| 272 | /// available from other functions inlined into the caller. If we are able to |
| 273 | /// inline this call site we attempt to reuse already available allocas or add |
| 274 | /// any new allocas to the set if not possible. |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 275 | static InlineResult InlineCallIfPossible( |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 276 | CallSite CS, InlineFunctionInfo &IFI, |
| 277 | InlinedArrayAllocasTy &InlinedArrayAllocas, int InlineHistory, |
| 278 | bool InsertLifetime, function_ref<AAResults &(Function &)> &AARGetter, |
| 279 | ImportedFunctionsInliningStatistics &ImportedFunctionsStats) { |
| 280 | Function *Callee = CS.getCalledFunction(); |
| 281 | Function *Caller = CS.getCaller(); |
| 282 | |
| 283 | AAResults &AAR = AARGetter(*Callee); |
| 284 | |
| 285 | // Try to inline the function. Get the list of static allocas that were |
| 286 | // inlined. |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 287 | InlineResult IR = InlineFunction(CS, IFI, &AAR, InsertLifetime); |
| 288 | if (!IR) |
| 289 | return IR; |
Chandler Carruth | f702d8e | 2016-08-17 02:40:23 +0000 | [diff] [blame] | 290 | |
| 291 | if (InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No) |
| 292 | ImportedFunctionsStats.recordInline(*Caller, *Callee); |
| 293 | |
| 294 | AttributeFuncs::mergeAttributesForInlining(*Caller, *Callee); |
| 295 | |
| 296 | if (!DisableInlinedAllocaMerging) |
| 297 | mergeInlinedArrayAllocas(Caller, IFI, InlinedArrayAllocas, InlineHistory); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 298 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 299 | return IR; // success |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 300 | } |
Jakob Stoklund Olesen | 8a19d3c | 2010-01-20 17:51:28 +0000 | [diff] [blame] | 301 | |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 302 | /// Return true if inlining of CS can block the caller from being |
| 303 | /// inlined which is proved to be more beneficial. \p IC is the |
| 304 | /// estimated inline cost associated with callsite \p CS. |
Haicheng Wu | f8dc2d8 | 2017-01-30 16:15:14 +0000 | [diff] [blame] | 305 | /// \p TotalSecondaryCost will be set to the estimated cost of inlining the |
| 306 | /// caller if \p CS is suppressed for inlining. |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 307 | static bool |
| 308 | shouldBeDeferred(Function *Caller, CallSite CS, InlineCost IC, |
| 309 | int &TotalSecondaryCost, |
Benjamin Kramer | 41e66da | 2016-08-06 12:33:46 +0000 | [diff] [blame] | 310 | function_ref<InlineCost(CallSite CS)> GetInlineCost) { |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 311 | // For now we only handle local or inline functions. |
| 312 | if (!Caller->hasLocalLinkage() && !Caller->hasLinkOnceODRLinkage()) |
| 313 | return false; |
| 314 | // Try to detect the case where the current inlining candidate caller (call |
| 315 | // it B) is a static or linkonce-ODR function and is an inlining candidate |
| 316 | // elsewhere, and the current candidate callee (call it C) is large enough |
| 317 | // that inlining it into B would make B too big to inline later. In these |
| 318 | // circumstances it may be best not to inline C into B, but to inline B into |
| 319 | // its callers. |
| 320 | // |
| 321 | // This only applies to static and linkonce-ODR functions because those are |
| 322 | // expected to be available for inlining in the translation units where they |
| 323 | // are used. Thus we will always have the opportunity to make local inlining |
| 324 | // decisions. Importantly the linkonce-ODR linkage covers inline functions |
| 325 | // and templates in C++. |
| 326 | // |
| 327 | // FIXME: All of this logic should be sunk into getInlineCost. It relies on |
| 328 | // the internal implementation of the inline cost metrics rather than |
| 329 | // treating them as truly abstract units etc. |
| 330 | TotalSecondaryCost = 0; |
| 331 | // The candidate cost to be imposed upon the current function. |
Evgeny Astigeevich | 7823c66 | 2017-03-22 12:01:57 +0000 | [diff] [blame] | 332 | int CandidateCost = IC.getCost() - 1; |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 333 | // This bool tracks what happens if we do NOT inline C into B. |
| 334 | bool callerWillBeRemoved = Caller->hasLocalLinkage(); |
| 335 | // This bool tracks what happens if we DO inline C into B. |
| 336 | bool inliningPreventsSomeOuterInline = false; |
| 337 | for (User *U : Caller->users()) { |
| 338 | CallSite CS2(U); |
| 339 | |
| 340 | // If this isn't a call to Caller (it could be some other sort |
| 341 | // of reference) skip it. Such references will prevent the caller |
| 342 | // from being removed. |
| 343 | if (!CS2 || CS2.getCalledFunction() != Caller) { |
| 344 | callerWillBeRemoved = false; |
| 345 | continue; |
| 346 | } |
| 347 | |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 348 | InlineCost IC2 = GetInlineCost(CS2); |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 349 | ++NumCallerCallersAnalyzed; |
| 350 | if (!IC2) { |
| 351 | callerWillBeRemoved = false; |
| 352 | continue; |
| 353 | } |
| 354 | if (IC2.isAlways()) |
| 355 | continue; |
| 356 | |
Xinliang David Li | f450b88 | 2016-11-04 03:00:52 +0000 | [diff] [blame] | 357 | // See if inlining of the original callsite would erase the cost delta of |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 358 | // this callsite. We subtract off the penalty for the call instruction, |
| 359 | // which we would be deleting. |
| 360 | if (IC2.getCostDelta() <= CandidateCost) { |
| 361 | inliningPreventsSomeOuterInline = true; |
| 362 | TotalSecondaryCost += IC2.getCost(); |
| 363 | } |
| 364 | } |
| 365 | // If all outer calls to Caller would get inlined, the cost for the last |
| 366 | // one is set very low by getInlineCost, in anticipation that Caller will |
| 367 | // be removed entirely. We did not account for this above unless there |
| 368 | // is only one caller of Caller. |
Taewook Oh | f22fa72 | 2017-02-14 17:30:05 +0000 | [diff] [blame] | 369 | if (callerWillBeRemoved && !Caller->hasOneUse()) |
Piotr Padlewski | d89875c | 2016-08-10 21:15:22 +0000 | [diff] [blame] | 370 | TotalSecondaryCost -= InlineConstants::LastCallToStaticBonus; |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 371 | |
| 372 | if (inliningPreventsSomeOuterInline && TotalSecondaryCost < IC.getCost()) |
| 373 | return true; |
| 374 | |
| 375 | return false; |
| 376 | } |
| 377 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 378 | static std::basic_ostream<char> &operator<<(std::basic_ostream<char> &R, |
| 379 | const ore::NV &Arg) { |
| 380 | return R << Arg.Val; |
| 381 | } |
| 382 | |
| 383 | template <class RemarkT> |
| 384 | RemarkT &operator<<(RemarkT &&R, const InlineCost &IC) { |
| 385 | using namespace ore; |
| 386 | if (IC.isAlways()) { |
| 387 | R << "(cost=always)"; |
| 388 | } else if (IC.isNever()) { |
| 389 | R << "(cost=never)"; |
| 390 | } else { |
| 391 | R << "(cost=" << ore::NV("Cost", IC.getCost()) |
| 392 | << ", threshold=" << ore::NV("Threshold", IC.getThreshold()) << ")"; |
| 393 | } |
| 394 | if (const char *Reason = IC.getReason()) |
| 395 | R << ": " << ore::NV("Reason", Reason); |
| 396 | return R; |
| 397 | } |
| 398 | |
| 399 | static std::string inlineCostStr(const InlineCost &IC) { |
| 400 | std::stringstream Remark; |
| 401 | Remark << IC; |
| 402 | return Remark.str(); |
| 403 | } |
| 404 | |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 405 | /// Return the cost only if the inliner should attempt to inline at the given |
| 406 | /// CallSite. If we return the cost, we will emit an optimisation remark later |
| 407 | /// using that cost, so we won't do so from this function. |
| 408 | static Optional<InlineCost> |
| 409 | shouldInline(CallSite CS, function_ref<InlineCost(CallSite CS)> GetInlineCost, |
| 410 | OptimizationRemarkEmitter &ORE) { |
Adam Nemet | c507ac9 | 2016-09-27 23:47:03 +0000 | [diff] [blame] | 411 | using namespace ore; |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 412 | |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 413 | InlineCost IC = GetInlineCost(CS); |
Adam Nemet | c507ac9 | 2016-09-27 23:47:03 +0000 | [diff] [blame] | 414 | Instruction *Call = CS.getInstruction(); |
| 415 | Function *Callee = CS.getCalledFunction(); |
Adam Nemet | e7bdf22 | 2017-01-30 16:22:45 +0000 | [diff] [blame] | 416 | Function *Caller = CS.getCaller(); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 417 | |
Daniel Dunbar | 3933e66 | 2008-10-30 19:26:59 +0000 | [diff] [blame] | 418 | if (IC.isAlways()) { |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 419 | LLVM_DEBUG(dbgs() << " Inlining " << inlineCostStr(IC) |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 420 | << ", Call: " << *CS.getInstruction() << "\n"); |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 421 | return IC; |
Daniel Dunbar | 3933e66 | 2008-10-30 19:26:59 +0000 | [diff] [blame] | 422 | } |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 423 | |
Daniel Dunbar | 3933e66 | 2008-10-30 19:26:59 +0000 | [diff] [blame] | 424 | if (IC.isNever()) { |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 425 | LLVM_DEBUG(dbgs() << " NOT Inlining " << inlineCostStr(IC) |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 426 | << ", Call: " << *CS.getInstruction() << "\n"); |
Adam Nemet | 15fccf0 | 2017-09-19 23:00:55 +0000 | [diff] [blame] | 427 | ORE.emit([&]() { |
| 428 | return OptimizationRemarkMissed(DEBUG_TYPE, "NeverInline", Call) |
Adam Nemet | e7bdf22 | 2017-01-30 16:22:45 +0000 | [diff] [blame] | 429 | << NV("Callee", Callee) << " not inlined into " |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 430 | << NV("Caller", Caller) << " because it should never be inlined " |
| 431 | << IC; |
Adam Nemet | 15fccf0 | 2017-09-19 23:00:55 +0000 | [diff] [blame] | 432 | }); |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 433 | return IC; |
Daniel Dunbar | 3933e66 | 2008-10-30 19:26:59 +0000 | [diff] [blame] | 434 | } |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 435 | |
Chandler Carruth | 0539c07 | 2012-03-31 12:42:41 +0000 | [diff] [blame] | 436 | if (!IC) { |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 437 | LLVM_DEBUG(dbgs() << " NOT Inlining " << inlineCostStr(IC) |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 438 | << ", Call: " << *CS.getInstruction() << "\n"); |
Adam Nemet | 15fccf0 | 2017-09-19 23:00:55 +0000 | [diff] [blame] | 439 | ORE.emit([&]() { |
| 440 | return OptimizationRemarkMissed(DEBUG_TYPE, "TooCostly", Call) |
Adam Nemet | e7bdf22 | 2017-01-30 16:22:45 +0000 | [diff] [blame] | 441 | << NV("Callee", Callee) << " not inlined into " |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 442 | << NV("Caller", Caller) << " because too costly to inline " << IC; |
Adam Nemet | 15fccf0 | 2017-09-19 23:00:55 +0000 | [diff] [blame] | 443 | }); |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 444 | return IC; |
Daniel Dunbar | e7fbf9f4 | 2008-10-29 01:02:02 +0000 | [diff] [blame] | 445 | } |
Dale Johannesen | 3059924 | 2009-10-09 00:11:32 +0000 | [diff] [blame] | 446 | |
Xinliang David Li | 4b2fdcc | 2016-04-29 22:59:36 +0000 | [diff] [blame] | 447 | int TotalSecondaryCost = 0; |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 448 | if (shouldBeDeferred(Caller, CS, IC, TotalSecondaryCost, GetInlineCost)) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 449 | LLVM_DEBUG(dbgs() << " NOT Inlining: " << *CS.getInstruction() |
| 450 | << " Cost = " << IC.getCost() |
| 451 | << ", outer Cost = " << TotalSecondaryCost << '\n'); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 452 | ORE.emit([&]() { |
| 453 | return OptimizationRemarkMissed(DEBUG_TYPE, "IncreaseCostInOtherContexts", |
Adam Nemet | e7bdf22 | 2017-01-30 16:22:45 +0000 | [diff] [blame] | 454 | Call) |
Adam Nemet | c507ac9 | 2016-09-27 23:47:03 +0000 | [diff] [blame] | 455 | << "Not inlining. Cost of inlining " << NV("Callee", Callee) |
| 456 | << " increases the cost of inlining " << NV("Caller", Caller) |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 457 | << " in other contexts"; |
| 458 | }); |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 459 | |
| 460 | // IC does not bool() to false, so get an InlineCost that will. |
| 461 | // This will not be inspected to make an error message. |
| 462 | return None; |
Dale Johannesen | 3059924 | 2009-10-09 00:11:32 +0000 | [diff] [blame] | 463 | } |
| 464 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 465 | LLVM_DEBUG(dbgs() << " Inlining " << inlineCostStr(IC) |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 466 | << ", Call: " << *CS.getInstruction() << '\n'); |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 467 | return IC; |
Daniel Dunbar | e7fbf9f4 | 2008-10-29 01:02:02 +0000 | [diff] [blame] | 468 | } |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 469 | |
Sanjay Patel | f1b0db1 | 2015-03-10 16:42:24 +0000 | [diff] [blame] | 470 | /// Return true if the specified inline history ID |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 471 | /// indicates an inline history that includes the specified function. |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 472 | static bool InlineHistoryIncludes( |
| 473 | Function *F, int InlineHistoryID, |
| 474 | const SmallVectorImpl<std::pair<Function *, int>> &InlineHistory) { |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 475 | while (InlineHistoryID != -1) { |
| 476 | assert(unsigned(InlineHistoryID) < InlineHistory.size() && |
| 477 | "Invalid inline history ID"); |
| 478 | if (InlineHistory[InlineHistoryID].first == F) |
| 479 | return true; |
| 480 | InlineHistoryID = InlineHistory[InlineHistoryID].second; |
| 481 | } |
| 482 | return false; |
| 483 | } |
| 484 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 485 | bool LegacyInlinerBase::doInitialization(CallGraph &CG) { |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 486 | if (InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No) |
| 487 | ImportedFunctionsStats.setModuleInfo(CG.getModule()); |
| 488 | return false; // No changes to CallGraph. |
| 489 | } |
| 490 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 491 | bool LegacyInlinerBase::runOnSCC(CallGraphSCC &SCC) { |
Andrew Kaylor | aa641a5 | 2016-04-22 22:06:11 +0000 | [diff] [blame] | 492 | if (skipSCC(SCC)) |
| 493 | return false; |
Andrew Kaylor | 9c81d0f | 2016-05-23 21:57:54 +0000 | [diff] [blame] | 494 | return inlineCalls(SCC); |
| 495 | } |
Andrew Kaylor | aa641a5 | 2016-04-22 22:06:11 +0000 | [diff] [blame] | 496 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 497 | static void emit_inlined_into(OptimizationRemarkEmitter &ORE, DebugLoc &DLoc, |
| 498 | const BasicBlock *Block, const Function &Callee, |
| 499 | const Function &Caller, const InlineCost &IC) { |
| 500 | ORE.emit([&]() { |
| 501 | bool AlwaysInline = IC.isAlways(); |
| 502 | StringRef RemarkName = AlwaysInline ? "AlwaysInline" : "Inlined"; |
| 503 | return OptimizationRemark(DEBUG_TYPE, RemarkName, DLoc, Block) |
| 504 | << ore::NV("Callee", &Callee) << " inlined into " |
| 505 | << ore::NV("Caller", &Caller) << " with " << IC; |
| 506 | }); |
| 507 | } |
| 508 | |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 509 | static void setInlineRemark(CallSite &CS, StringRef message) { |
| 510 | if (!InlineRemarkAttribute) |
| 511 | return; |
| 512 | |
| 513 | Attribute attr = Attribute::get(CS->getContext(), "inline-remark", message); |
| 514 | CS.addAttribute(AttributeList::FunctionIndex, attr); |
| 515 | } |
| 516 | |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 517 | static bool |
| 518 | inlineCallsImpl(CallGraphSCC &SCC, CallGraph &CG, |
Daniel Jasper | aec2fa3 | 2016-12-19 08:22:17 +0000 | [diff] [blame] | 519 | std::function<AssumptionCache &(Function &)> GetAssumptionCache, |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 520 | ProfileSummaryInfo *PSI, TargetLibraryInfo &TLI, |
| 521 | bool InsertLifetime, |
Benjamin Kramer | 41e66da | 2016-08-06 12:33:46 +0000 | [diff] [blame] | 522 | function_ref<InlineCost(CallSite CS)> GetInlineCost, |
| 523 | function_ref<AAResults &(Function &)> AARGetter, |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 524 | ImportedFunctionsInliningStatistics &ImportedFunctionsStats) { |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 525 | SmallPtrSet<Function *, 8> SCCFunctions; |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 526 | LLVM_DEBUG(dbgs() << "Inliner visiting SCC:"); |
Yaron Keren | 4c548f2 | 2015-06-20 07:12:33 +0000 | [diff] [blame] | 527 | for (CallGraphNode *Node : SCC) { |
| 528 | Function *F = Node->getFunction(); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 529 | if (F) |
| 530 | SCCFunctions.insert(F); |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 531 | LLVM_DEBUG(dbgs() << " " << (F ? F->getName() : "INDIRECTNODE")); |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 532 | } |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 533 | |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 534 | // Scan through and identify all call sites ahead of time so that we only |
| 535 | // inline call sites in the original functions, not call sites that result |
| 536 | // from inlining other functions. |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 537 | SmallVector<std::pair<CallSite, int>, 16> CallSites; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 538 | |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 539 | // When inlining a callee produces new call sites, we want to keep track of |
| 540 | // the fact that they were inlined from the callee. This allows us to avoid |
| 541 | // infinite inlining in some obscure cases. To represent this, we use an |
| 542 | // index into the InlineHistory vector. |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 543 | SmallVector<std::pair<Function *, int>, 8> InlineHistory; |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 544 | |
Yaron Keren | 4c548f2 | 2015-06-20 07:12:33 +0000 | [diff] [blame] | 545 | for (CallGraphNode *Node : SCC) { |
| 546 | Function *F = Node->getFunction(); |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 547 | if (!F || F->isDeclaration()) |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 548 | continue; |
| 549 | |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 550 | OptimizationRemarkEmitter ORE(F); |
Yaron Keren | 4c548f2 | 2015-06-20 07:12:33 +0000 | [diff] [blame] | 551 | for (BasicBlock &BB : *F) |
| 552 | for (Instruction &I : BB) { |
| 553 | CallSite CS(cast<Value>(&I)); |
Dale Johannesen | 3059924 | 2009-10-09 00:11:32 +0000 | [diff] [blame] | 554 | // If this isn't a call, or it is a call to an intrinsic, it can |
Chris Lattner | 9e50747 | 2009-08-31 05:34:32 +0000 | [diff] [blame] | 555 | // never be inlined. |
Gabor Greif | 62f0aac | 2010-07-28 22:50:26 +0000 | [diff] [blame] | 556 | if (!CS || isa<IntrinsicInst>(I)) |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 557 | continue; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 558 | |
Chris Lattner | 9e50747 | 2009-08-31 05:34:32 +0000 | [diff] [blame] | 559 | // If this is a direct call to an external function, we can never inline |
| 560 | // it. If it is an indirect call, inlining may resolve it to be a |
| 561 | // direct call, so we keep it. |
Yaron Keren | c66c06b | 2015-07-19 15:48:07 +0000 | [diff] [blame] | 562 | if (Function *Callee = CS.getCalledFunction()) |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 563 | if (Callee->isDeclaration()) { |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 564 | using namespace ore; |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 565 | |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 566 | setInlineRemark(CS, "unavailable definition"); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 567 | ORE.emit([&]() { |
| 568 | return OptimizationRemarkMissed(DEBUG_TYPE, "NoDefinition", &I) |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 569 | << NV("Callee", Callee) << " will not be inlined into " |
Adam Nemet | 1142147 | 2016-09-27 21:58:17 +0000 | [diff] [blame] | 570 | << NV("Caller", CS.getCaller()) |
| 571 | << " because its definition is unavailable" |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 572 | << setIsVerbose(); |
| 573 | }); |
Yaron Keren | c66c06b | 2015-07-19 15:48:07 +0000 | [diff] [blame] | 574 | continue; |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 575 | } |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 576 | |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 577 | CallSites.push_back(std::make_pair(CS, -1)); |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 578 | } |
| 579 | } |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 580 | |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 581 | LLVM_DEBUG(dbgs() << ": " << CallSites.size() << " call sites.\n"); |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 582 | |
Chris Lattner | a5cdd5e | 2010-04-20 00:47:08 +0000 | [diff] [blame] | 583 | // If there are no calls in this function, exit early. |
| 584 | if (CallSites.empty()) |
| 585 | return false; |
Yaron Keren | 6967cbb | 2015-07-02 14:25:09 +0000 | [diff] [blame] | 586 | |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 587 | // Now that we have all of the call sites, move the ones to functions in the |
| 588 | // current SCC to the end of the list. |
| 589 | unsigned FirstCallInSCC = CallSites.size(); |
| 590 | for (unsigned i = 0; i < FirstCallInSCC; ++i) |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 591 | if (Function *F = CallSites[i].first.getCalledFunction()) |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 592 | if (SCCFunctions.count(F)) |
| 593 | std::swap(CallSites[i--], CallSites[--FirstCallInSCC]); |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 594 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 595 | InlinedArrayAllocasTy InlinedArrayAllocas; |
Easwaran Raman | f5f9160 | 2017-05-09 23:21:10 +0000 | [diff] [blame] | 596 | InlineFunctionInfo InlineInfo(&CG, &GetAssumptionCache, PSI); |
Chandler Carruth | 66b3130 | 2015-01-04 12:03:27 +0000 | [diff] [blame] | 597 | |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 598 | // Now that we have all of the call sites, loop over them and inline them if |
| 599 | // it looks profitable to do so. |
| 600 | bool Changed = false; |
| 601 | bool LocalChange; |
| 602 | do { |
| 603 | LocalChange = false; |
| 604 | // Iterate over the outer loop because inlining functions can cause indirect |
| 605 | // calls to become direct calls. |
Yaron Keren | 4c548f2 | 2015-06-20 07:12:33 +0000 | [diff] [blame] | 606 | // CallSites may be modified inside so ranged for loop can not be used. |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 607 | for (unsigned CSi = 0; CSi != CallSites.size(); ++CSi) { |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 608 | CallSite CS = CallSites[CSi].first; |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 609 | |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 610 | Function *Caller = CS.getCaller(); |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 611 | Function *Callee = CS.getCalledFunction(); |
| 612 | |
David Blaikie | cb9327b | 2017-06-09 03:29:20 +0000 | [diff] [blame] | 613 | // We can only inline direct calls to non-declarations. |
| 614 | if (!Callee || Callee->isDeclaration()) |
| 615 | continue; |
| 616 | |
David Blaikie | 6d0f394 | 2017-06-13 02:24:09 +0000 | [diff] [blame] | 617 | Instruction *Instr = CS.getInstruction(); |
| 618 | |
| 619 | bool IsTriviallyDead = isInstructionTriviallyDead(Instr, &TLI); |
| 620 | |
| 621 | int InlineHistoryID; |
| 622 | if (!IsTriviallyDead) { |
| 623 | // If this call site was obtained by inlining another function, verify |
| 624 | // that the include path for the function did not include the callee |
| 625 | // itself. If so, we'd be recursively inlining the same function, |
| 626 | // which would provide the same callsites, which would cause us to |
| 627 | // infinitely inline. |
| 628 | InlineHistoryID = CallSites[CSi].second; |
| 629 | if (InlineHistoryID != -1 && |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 630 | InlineHistoryIncludes(Callee, InlineHistoryID, InlineHistory)) { |
| 631 | setInlineRemark(CS, "recursive"); |
David Blaikie | 6d0f394 | 2017-06-13 02:24:09 +0000 | [diff] [blame] | 632 | continue; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 633 | } |
David Blaikie | 6d0f394 | 2017-06-13 02:24:09 +0000 | [diff] [blame] | 634 | } |
| 635 | |
David Blaikie | ae8c4af | 2017-06-12 23:01:17 +0000 | [diff] [blame] | 636 | // FIXME for new PM: because of the old PM we currently generate ORE and |
| 637 | // in turn BFI on demand. With the new PM, the ORE dependency should |
| 638 | // just become a regular analysis dependency. |
| 639 | OptimizationRemarkEmitter ORE(Caller); |
| 640 | |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 641 | Optional<InlineCost> OIC = shouldInline(CS, GetInlineCost, ORE); |
David Blaikie | ae8c4af | 2017-06-12 23:01:17 +0000 | [diff] [blame] | 642 | // If the policy determines that we should inline this function, |
| 643 | // delete the call instead. |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 644 | if (!OIC.hasValue()) { |
| 645 | setInlineRemark(CS, "deferred"); |
| 646 | continue; |
| 647 | } |
| 648 | |
| 649 | if (!OIC.getValue()) { |
| 650 | // shouldInline() call returned a negative inline cost that explains |
| 651 | // why this callsite should not be inlined. |
| 652 | setInlineRemark(CS, inlineCostStr(*OIC)); |
David Blaikie | ae8c4af | 2017-06-12 23:01:17 +0000 | [diff] [blame] | 653 | continue; |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 654 | } |
David Blaikie | ae8c4af | 2017-06-12 23:01:17 +0000 | [diff] [blame] | 655 | |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 656 | // If this call site is dead and it is to a readonly function, we should |
| 657 | // just delete the call instead of trying to inline it, regardless of |
| 658 | // size. This happens because IPSCCP propagates the result out of the |
| 659 | // call and then we're left with the dead call. |
David Blaikie | 6d0f394 | 2017-06-13 02:24:09 +0000 | [diff] [blame] | 660 | if (IsTriviallyDead) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 661 | LLVM_DEBUG(dbgs() << " -> Deleting dead call: " << *Instr << "\n"); |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 662 | // Update the call graph by deleting the edge from Callee to Caller. |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 663 | setInlineRemark(CS, "trivially dead"); |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 664 | CG[Caller]->removeCallEdgeFor(CS); |
David Blaikie | 6d0f394 | 2017-06-13 02:24:09 +0000 | [diff] [blame] | 665 | Instr->eraseFromParent(); |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 666 | ++NumCallsDeleted; |
| 667 | } else { |
NAKAMURA Takumi | cd1fc4b | 2014-04-17 12:22:14 +0000 | [diff] [blame] | 668 | // Get DebugLoc to report. CS will be invalid after Inliner. |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 669 | DebugLoc DLoc = CS->getDebugLoc(); |
Adam Nemet | 896c09b | 2016-08-10 00:44:44 +0000 | [diff] [blame] | 670 | BasicBlock *Block = CS.getParent(); |
Diego Novillo | 7f8af8b | 2014-05-22 14:19:46 +0000 | [diff] [blame] | 671 | |
Chris Lattner | 2eee5d3 | 2010-04-22 23:37:35 +0000 | [diff] [blame] | 672 | // Attempt to inline the function. |
Adam Nemet | e7bdf22 | 2017-01-30 16:22:45 +0000 | [diff] [blame] | 673 | using namespace ore; |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 674 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 675 | InlineResult IR = InlineCallIfPossible( |
| 676 | CS, InlineInfo, InlinedArrayAllocas, InlineHistoryID, |
| 677 | InsertLifetime, AARGetter, ImportedFunctionsStats); |
| 678 | if (!IR) { |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 679 | setInlineRemark(CS, std::string(IR) + "; " + inlineCostStr(*OIC)); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 680 | ORE.emit([&]() { |
| 681 | return OptimizationRemarkMissed(DEBUG_TYPE, "NotInlined", DLoc, |
| 682 | Block) |
| 683 | << NV("Callee", Callee) << " will not be inlined into " |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 684 | << NV("Caller", Caller) << ": " << NV("Reason", IR.message); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 685 | }); |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 686 | continue; |
Diego Novillo | 7f8af8b | 2014-05-22 14:19:46 +0000 | [diff] [blame] | 687 | } |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 688 | ++NumInlined; |
Diego Novillo | a9298b2 | 2014-04-08 16:42:34 +0000 | [diff] [blame] | 689 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 690 | emit_inlined_into(ORE, DLoc, Block, *Callee, *Caller, *OIC); |
Diego Novillo | a9298b2 | 2014-04-08 16:42:34 +0000 | [diff] [blame] | 691 | |
Chris Lattner | c2432b9 | 2010-05-01 01:26:13 +0000 | [diff] [blame] | 692 | // If inlining this function gave us any new call sites, throw them |
Chris Lattner | 2eee5d3 | 2010-04-22 23:37:35 +0000 | [diff] [blame] | 693 | // onto our worklist to process. They are useful inline candidates. |
Chris Lattner | c2432b9 | 2010-05-01 01:26:13 +0000 | [diff] [blame] | 694 | if (!InlineInfo.InlinedCalls.empty()) { |
Chris Lattner | e826267 | 2010-05-01 01:05:10 +0000 | [diff] [blame] | 695 | // Create a new inline history entry for this, so that we remember |
| 696 | // that these new callsites came about due to inlining Callee. |
| 697 | int NewHistoryID = InlineHistory.size(); |
| 698 | InlineHistory.push_back(std::make_pair(Callee, InlineHistoryID)); |
| 699 | |
Yaron Keren | 4c548f2 | 2015-06-20 07:12:33 +0000 | [diff] [blame] | 700 | for (Value *Ptr : InlineInfo.InlinedCalls) |
Chandler Carruth | 2121199 | 2012-03-25 04:03:40 +0000 | [diff] [blame] | 701 | CallSites.push_back(std::make_pair(CallSite(Ptr), NewHistoryID)); |
Chris Lattner | c691de3 | 2010-04-23 18:37:01 +0000 | [diff] [blame] | 702 | } |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 703 | } |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 704 | |
Chris Lattner | eb9acbf | 2009-11-12 07:56:08 +0000 | [diff] [blame] | 705 | // If we inlined or deleted the last possible call site to the function, |
| 706 | // delete the function body now. |
| 707 | if (Callee && Callee->use_empty() && Callee->hasLocalLinkage() && |
Chris Lattner | 9e50747 | 2009-08-31 05:34:32 +0000 | [diff] [blame] | 708 | // TODO: Can remove if in SCC now. |
Chris Lattner | 081375b | 2009-08-31 03:15:49 +0000 | [diff] [blame] | 709 | !SCCFunctions.count(Callee) && |
| 710 | // The function may be apparently dead, but if there are indirect |
| 711 | // callgraph references to the node, we cannot delete it yet, this |
| 712 | // could invalidate the CGSCC iterator. |
| 713 | CG[Callee]->getNumReferences() == 0) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 714 | LLVM_DEBUG(dbgs() << " -> Deleting dead function: " |
| 715 | << Callee->getName() << "\n"); |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 716 | CallGraphNode *CalleeNode = CG[Callee]; |
Yaron Keren | 6967cbb | 2015-07-02 14:25:09 +0000 | [diff] [blame] | 717 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 718 | // Remove any call graph edges from the callee to its callees. |
| 719 | CalleeNode->removeAllCalledFunctions(); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 720 | |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 721 | // Removing the node for callee from the call graph and delete it. |
Easwaran Raman | b1bd398 | 2016-03-08 00:36:35 +0000 | [diff] [blame] | 722 | delete CG.removeFunctionFromModule(CalleeNode); |
Chris Lattner | d3374e8 | 2009-08-27 06:29:33 +0000 | [diff] [blame] | 723 | ++NumDeleted; |
| 724 | } |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 725 | |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 726 | // Remove this call site from the list. If possible, use |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 727 | // swap/pop_back for efficiency, but do not use it if doing so would |
| 728 | // move a call site to a function in this SCC before the |
| 729 | // 'FirstCallInSCC' barrier. |
Chris Lattner | 4422d31 | 2010-04-16 22:42:17 +0000 | [diff] [blame] | 730 | if (SCC.isSingular()) { |
Benjamin Kramer | 5ac57e3 | 2010-05-31 12:50:41 +0000 | [diff] [blame] | 731 | CallSites[CSi] = CallSites.back(); |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 732 | CallSites.pop_back(); |
| 733 | } else { |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 734 | CallSites.erase(CallSites.begin() + CSi); |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 735 | } |
| 736 | --CSi; |
| 737 | |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 738 | Changed = true; |
| 739 | LocalChange = true; |
| 740 | } |
Chris Lattner | 6754b82 | 2004-05-23 21:22:17 +0000 | [diff] [blame] | 741 | } while (LocalChange); |
Chris Lattner | 4d25c86 | 2004-04-08 06:34:31 +0000 | [diff] [blame] | 742 | |
Chris Lattner | d075cc2 | 2003-08-31 19:10:30 +0000 | [diff] [blame] | 743 | return Changed; |
| 744 | } |
| 745 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 746 | bool LegacyInlinerBase::inlineCalls(CallGraphSCC &SCC) { |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 747 | CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph(); |
Daniel Jasper | aec2fa3 | 2016-12-19 08:22:17 +0000 | [diff] [blame] | 748 | ACT = &getAnalysis<AssumptionCacheTracker>(); |
Dehao Chen | 5461d8b | 2016-09-28 21:00:58 +0000 | [diff] [blame] | 749 | PSI = getAnalysis<ProfileSummaryInfoWrapperPass>().getPSI(); |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 750 | auto &TLI = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(); |
Daniel Jasper | aec2fa3 | 2016-12-19 08:22:17 +0000 | [diff] [blame] | 751 | auto GetAssumptionCache = [&](Function &F) -> AssumptionCache & { |
| 752 | return ACT->getAssumptionCache(F); |
| 753 | }; |
| 754 | return inlineCallsImpl(SCC, CG, GetAssumptionCache, PSI, TLI, InsertLifetime, |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 755 | [this](CallSite CS) { return getInlineCost(CS); }, |
Peter Collingbourne | cea1e4e | 2017-02-09 23:11:52 +0000 | [diff] [blame] | 756 | LegacyAARGetter(*this), ImportedFunctionsStats); |
Sean Silva | ab6a683 | 2016-07-23 04:22:50 +0000 | [diff] [blame] | 757 | } |
| 758 | |
Sanjay Patel | f1b0db1 | 2015-03-10 16:42:24 +0000 | [diff] [blame] | 759 | /// Remove now-dead linkonce functions at the end of |
| 760 | /// processing to avoid breaking the SCC traversal. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 761 | bool LegacyInlinerBase::doFinalization(CallGraph &CG) { |
Piotr Padlewski | 84abc74 | 2016-07-29 00:27:16 +0000 | [diff] [blame] | 762 | if (InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No) |
| 763 | ImportedFunctionsStats.dump(InlinerFunctionImportStats == |
| 764 | InlinerFunctionImportStatsOpts::Verbose); |
Devang Patel | f0ef357 | 2008-11-05 01:39:16 +0000 | [diff] [blame] | 765 | return removeDeadFunctions(CG); |
| 766 | } |
| 767 | |
Sanjay Patel | f1b0db1 | 2015-03-10 16:42:24 +0000 | [diff] [blame] | 768 | /// Remove dead functions that are not included in DNR (Do Not Remove) list. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 769 | bool LegacyInlinerBase::removeDeadFunctions(CallGraph &CG, |
| 770 | bool AlwaysInlineOnly) { |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 771 | SmallVector<CallGraphNode *, 16> FunctionsToRemove; |
Chandler Carruth | 6e9bb7e | 2016-12-26 23:43:27 +0000 | [diff] [blame] | 772 | SmallVector<Function *, 16> DeadFunctionsInComdats; |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 773 | |
| 774 | auto RemoveCGN = [&](CallGraphNode *CGN) { |
| 775 | // Remove any call graph edges from the function to its callees. |
| 776 | CGN->removeAllCalledFunctions(); |
| 777 | |
| 778 | // Remove any edges from the external node to the function's call graph |
| 779 | // node. These edges might have been made irrelegant due to |
| 780 | // optimization of the program. |
| 781 | CG.getExternalCallingNode()->removeAnyCallEdgeTo(CGN); |
| 782 | |
| 783 | // Removing the node for callee from the call graph and delete it. |
| 784 | FunctionsToRemove.push_back(CGN); |
| 785 | }; |
Chris Lattner | be8bb80 | 2004-04-21 20:44:33 +0000 | [diff] [blame] | 786 | |
| 787 | // Scan for all of the functions, looking for ones that should now be removed |
| 788 | // from the program. Insert the dead ones in the FunctionsToRemove set. |
David Blaikie | a5d7de9 | 2015-08-05 20:55:50 +0000 | [diff] [blame] | 789 | for (const auto &I : CG) { |
| 790 | CallGraphNode *CGN = I.second.get(); |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 791 | Function *F = CGN->getFunction(); |
Chandler Carruth | d7a5f2a | 2012-03-16 06:10:13 +0000 | [diff] [blame] | 792 | if (!F || F->isDeclaration()) |
| 793 | continue; |
| 794 | |
| 795 | // Handle the case when this function is called and we only want to care |
| 796 | // about always-inline functions. This is a bit of a hack to share code |
| 797 | // between here and the InlineAlways pass. |
Duncan P. N. Exon Smith | 2c79ad9 | 2015-02-14 01:11:29 +0000 | [diff] [blame] | 798 | if (AlwaysInlineOnly && !F->hasFnAttribute(Attribute::AlwaysInline)) |
Chandler Carruth | d7a5f2a | 2012-03-16 06:10:13 +0000 | [diff] [blame] | 799 | continue; |
| 800 | |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 801 | // If the only remaining users of the function are dead constants, remove |
| 802 | // them. |
| 803 | F->removeDeadConstantUsers(); |
Chris Lattner | be8bb80 | 2004-04-21 20:44:33 +0000 | [diff] [blame] | 804 | |
Eli Friedman | 1923a33 | 2011-10-20 05:23:42 +0000 | [diff] [blame] | 805 | if (!F->isDefTriviallyDead()) |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 806 | continue; |
David Majnemer | ac07703 | 2014-10-08 19:32:32 +0000 | [diff] [blame] | 807 | |
| 808 | // It is unsafe to drop a function with discardable linkage from a COMDAT |
| 809 | // without also dropping the other members of the COMDAT. |
| 810 | // The inliner doesn't visit non-function entities which are in COMDAT |
| 811 | // groups so it is unsafe to do so *unless* the linkage is local. |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 812 | if (!F->hasLocalLinkage()) { |
Chandler Carruth | 6e9bb7e | 2016-12-26 23:43:27 +0000 | [diff] [blame] | 813 | if (F->hasComdat()) { |
| 814 | DeadFunctionsInComdats.push_back(F); |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 815 | continue; |
| 816 | } |
| 817 | } |
Devang Patel | f0ef357 | 2008-11-05 01:39:16 +0000 | [diff] [blame] | 818 | |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 819 | RemoveCGN(CGN); |
Chris Lattner | c87784f | 2004-04-20 22:06:53 +0000 | [diff] [blame] | 820 | } |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 821 | if (!DeadFunctionsInComdats.empty()) { |
Chandler Carruth | 6e9bb7e | 2016-12-26 23:43:27 +0000 | [diff] [blame] | 822 | // Filter out the functions whose comdats remain alive. |
| 823 | filterDeadComdatFunctions(CG.getModule(), DeadFunctionsInComdats); |
| 824 | // Remove the rest. |
| 825 | for (Function *F : DeadFunctionsInComdats) |
| 826 | RemoveCGN(CG[F]); |
David Majnemer | ac256cf | 2015-05-05 20:14:22 +0000 | [diff] [blame] | 827 | } |
| 828 | |
Chandler Carruth | d7a5f2a | 2012-03-16 06:10:13 +0000 | [diff] [blame] | 829 | if (FunctionsToRemove.empty()) |
| 830 | return false; |
Chris Lattner | be8bb80 | 2004-04-21 20:44:33 +0000 | [diff] [blame] | 831 | |
| 832 | // Now that we know which functions to delete, do so. We didn't want to do |
| 833 | // this inline, because that would invalidate our CallGraph::iterator |
| 834 | // objects. :( |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 835 | // |
Chandler Carruth | d7a5f2a | 2012-03-16 06:10:13 +0000 | [diff] [blame] | 836 | // Note that it doesn't matter that we are iterating over a non-stable order |
Chris Lattner | 5eef6ad | 2009-08-27 03:51:50 +0000 | [diff] [blame] | 837 | // here to do this, it doesn't matter which order the functions are deleted |
| 838 | // in. |
Chandler Carruth | 45ae88f | 2012-04-01 10:41:24 +0000 | [diff] [blame] | 839 | array_pod_sort(FunctionsToRemove.begin(), FunctionsToRemove.end()); |
Chandler Carruth | 8562d3a | 2016-08-03 01:02:31 +0000 | [diff] [blame] | 840 | FunctionsToRemove.erase( |
| 841 | std::unique(FunctionsToRemove.begin(), FunctionsToRemove.end()), |
| 842 | FunctionsToRemove.end()); |
Yaron Keren | 62064d6 | 2015-06-25 19:28:24 +0000 | [diff] [blame] | 843 | for (CallGraphNode *CGN : FunctionsToRemove) { |
Easwaran Raman | b1bd398 | 2016-03-08 00:36:35 +0000 | [diff] [blame] | 844 | delete CG.removeFunctionFromModule(CGN); |
Chris Lattner | be8bb80 | 2004-04-21 20:44:33 +0000 | [diff] [blame] | 845 | ++NumDeleted; |
Chris Lattner | be8bb80 | 2004-04-21 20:44:33 +0000 | [diff] [blame] | 846 | } |
Chandler Carruth | d7a5f2a | 2012-03-16 06:10:13 +0000 | [diff] [blame] | 847 | return true; |
Chris Lattner | c87784f | 2004-04-20 22:06:53 +0000 | [diff] [blame] | 848 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 849 | |
Teresa Johnson | e87868b | 2018-06-28 20:07:47 +0000 | [diff] [blame] | 850 | InlinerPass::~InlinerPass() { |
| 851 | if (ImportedFunctionsStats) { |
| 852 | assert(InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No); |
| 853 | ImportedFunctionsStats->dump(InlinerFunctionImportStats == |
| 854 | InlinerFunctionImportStatsOpts::Verbose); |
| 855 | } |
| 856 | } |
| 857 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 858 | PreservedAnalyses InlinerPass::run(LazyCallGraph::SCC &InitialC, |
| 859 | CGSCCAnalysisManager &AM, LazyCallGraph &CG, |
| 860 | CGSCCUpdateResult &UR) { |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 861 | const ModuleAnalysisManager &MAM = |
| 862 | AM.getResult<ModuleAnalysisManagerCGSCCProxy>(InitialC, CG).getManager(); |
| 863 | bool Changed = false; |
| 864 | |
| 865 | assert(InitialC.size() > 0 && "Cannot handle an empty SCC!"); |
| 866 | Module &M = *InitialC.begin()->getFunction().getParent(); |
| 867 | ProfileSummaryInfo *PSI = MAM.getCachedResult<ProfileSummaryAnalysis>(M); |
| 868 | |
Teresa Johnson | e87868b | 2018-06-28 20:07:47 +0000 | [diff] [blame] | 869 | if (!ImportedFunctionsStats && |
| 870 | InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No) { |
| 871 | ImportedFunctionsStats = |
| 872 | llvm::make_unique<ImportedFunctionsInliningStatistics>(); |
| 873 | ImportedFunctionsStats->setModuleInfo(M); |
| 874 | } |
| 875 | |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 876 | // We use a single common worklist for calls across the entire SCC. We |
| 877 | // process these in-order and append new calls introduced during inlining to |
| 878 | // the end. |
| 879 | // |
| 880 | // Note that this particular order of processing is actually critical to |
| 881 | // avoid very bad behaviors. Consider *highly connected* call graphs where |
| 882 | // each function contains a small amonut of code and a couple of calls to |
| 883 | // other functions. Because the LLVM inliner is fundamentally a bottom-up |
| 884 | // inliner, it can handle gracefully the fact that these all appear to be |
| 885 | // reasonable inlining candidates as it will flatten things until they become |
| 886 | // too big to inline, and then move on and flatten another batch. |
| 887 | // |
| 888 | // However, when processing call edges *within* an SCC we cannot rely on this |
| 889 | // bottom-up behavior. As a consequence, with heavily connected *SCCs* of |
| 890 | // functions we can end up incrementally inlining N calls into each of |
| 891 | // N functions because each incremental inlining decision looks good and we |
| 892 | // don't have a topological ordering to prevent explosions. |
| 893 | // |
| 894 | // To compensate for this, we don't process transitive edges made immediate |
| 895 | // by inlining until we've done one pass of inlining across the entire SCC. |
| 896 | // Large, highly connected SCCs still lead to some amount of code bloat in |
| 897 | // this model, but it is uniformly spread across all the functions in the SCC |
| 898 | // and eventually they all become too large to inline, rather than |
| 899 | // incrementally maknig a single function grow in a super linear fashion. |
| 900 | SmallVector<std::pair<CallSite, int>, 16> Calls; |
| 901 | |
Teresa Johnson | 59da890 | 2018-05-08 01:45:46 +0000 | [diff] [blame] | 902 | FunctionAnalysisManager &FAM = |
| 903 | AM.getResult<FunctionAnalysisManagerCGSCCProxy>(InitialC, CG) |
| 904 | .getManager(); |
| 905 | |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 906 | // Populate the initial list of calls in this SCC. |
| 907 | for (auto &N : InitialC) { |
Teresa Johnson | 59da890 | 2018-05-08 01:45:46 +0000 | [diff] [blame] | 908 | auto &ORE = |
| 909 | FAM.getResult<OptimizationRemarkEmitterAnalysis>(N.getFunction()); |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 910 | // We want to generally process call sites top-down in order for |
| 911 | // simplifications stemming from replacing the call with the returned value |
| 912 | // after inlining to be visible to subsequent inlining decisions. |
| 913 | // FIXME: Using instructions sequence is a really bad way to do this. |
| 914 | // Instead we should do an actual RPO walk of the function body. |
| 915 | for (Instruction &I : instructions(N.getFunction())) |
| 916 | if (auto CS = CallSite(&I)) |
Teresa Johnson | 59da890 | 2018-05-08 01:45:46 +0000 | [diff] [blame] | 917 | if (Function *Callee = CS.getCalledFunction()) { |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 918 | if (!Callee->isDeclaration()) |
| 919 | Calls.push_back({CS, -1}); |
Teresa Johnson | 59da890 | 2018-05-08 01:45:46 +0000 | [diff] [blame] | 920 | else if (!isa<IntrinsicInst>(I)) { |
| 921 | using namespace ore; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 922 | setInlineRemark(CS, "unavailable definition"); |
Teresa Johnson | 59da890 | 2018-05-08 01:45:46 +0000 | [diff] [blame] | 923 | ORE.emit([&]() { |
| 924 | return OptimizationRemarkMissed(DEBUG_TYPE, "NoDefinition", &I) |
| 925 | << NV("Callee", Callee) << " will not be inlined into " |
| 926 | << NV("Caller", CS.getCaller()) |
| 927 | << " because its definition is unavailable" |
| 928 | << setIsVerbose(); |
| 929 | }); |
| 930 | } |
| 931 | } |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 932 | } |
| 933 | if (Calls.empty()) |
| 934 | return PreservedAnalyses::all(); |
| 935 | |
| 936 | // Capture updatable variables for the current SCC and RefSCC. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 937 | auto *C = &InitialC; |
| 938 | auto *RC = &C->getOuterRefSCC(); |
| 939 | |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 940 | // When inlining a callee produces new call sites, we want to keep track of |
| 941 | // the fact that they were inlined from the callee. This allows us to avoid |
| 942 | // infinite inlining in some obscure cases. To represent this, we use an |
| 943 | // index into the InlineHistory vector. |
| 944 | SmallVector<std::pair<Function *, int>, 16> InlineHistory; |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 945 | |
| 946 | // Track a set vector of inlined callees so that we can augment the caller |
| 947 | // with all of their edges in the call graph before pruning out the ones that |
| 948 | // got simplified away. |
| 949 | SmallSetVector<Function *, 4> InlinedCallees; |
| 950 | |
| 951 | // Track the dead functions to delete once finished with inlining calls. We |
| 952 | // defer deleting these to make it easier to handle the call graph updates. |
| 953 | SmallVector<Function *, 4> DeadFunctions; |
| 954 | |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 955 | // Loop forward over all of the calls. Note that we cannot cache the size as |
| 956 | // inlining can introduce new calls that need to be processed. |
| 957 | for (int i = 0; i < (int)Calls.size(); ++i) { |
| 958 | // We expect the calls to typically be batched with sequences of calls that |
| 959 | // have the same caller, so we first set up some shared infrastructure for |
| 960 | // this caller. We also do any pruning we can at this layer on the caller |
| 961 | // alone. |
| 962 | Function &F = *Calls[i].first.getCaller(); |
| 963 | LazyCallGraph::Node &N = *CG.lookup(F); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 964 | if (CG.lookupSCC(N) != C) |
| 965 | continue; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 966 | if (F.hasFnAttribute(Attribute::OptimizeNone)) { |
| 967 | setInlineRemark(Calls[i].first, "optnone attribute"); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 968 | continue; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 969 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 970 | |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 971 | LLVM_DEBUG(dbgs() << "Inlining calls in: " << F.getName() << "\n"); |
Chandler Carruth | d4be9f4 | 2017-01-22 10:33:58 +0000 | [diff] [blame] | 972 | |
Chandler Carruth | b698d59 | 2017-01-22 10:34:01 +0000 | [diff] [blame] | 973 | // Get a FunctionAnalysisManager via a proxy for this particular node. We |
| 974 | // do this each time we visit a node as the SCC may have changed and as |
| 975 | // we're going to mutate this particular function we want to make sure the |
| 976 | // proxy is in place to forward any invalidation events. We can use the |
| 977 | // manager we get here for looking up results for functions other than this |
| 978 | // node however because those functions aren't going to be mutated by this |
| 979 | // pass. |
| 980 | FunctionAnalysisManager &FAM = |
| 981 | AM.getResult<FunctionAnalysisManagerCGSCCProxy>(*C, CG) |
| 982 | .getManager(); |
Haicheng Wu | 0812c5b | 2017-08-21 20:00:09 +0000 | [diff] [blame] | 983 | |
| 984 | // Get the remarks emission analysis for the caller. |
| 985 | auto &ORE = FAM.getResult<OptimizationRemarkEmitterAnalysis>(F); |
| 986 | |
Chandler Carruth | b698d59 | 2017-01-22 10:34:01 +0000 | [diff] [blame] | 987 | std::function<AssumptionCache &(Function &)> GetAssumptionCache = |
| 988 | [&](Function &F) -> AssumptionCache & { |
| 989 | return FAM.getResult<AssumptionAnalysis>(F); |
| 990 | }; |
| 991 | auto GetBFI = [&](Function &F) -> BlockFrequencyInfo & { |
| 992 | return FAM.getResult<BlockFrequencyAnalysis>(F); |
| 993 | }; |
| 994 | |
| 995 | auto GetInlineCost = [&](CallSite CS) { |
| 996 | Function &Callee = *CS.getCalledFunction(); |
| 997 | auto &CalleeTTI = FAM.getResult<TargetIRAnalysis>(Callee); |
| 998 | return getInlineCost(CS, Params, CalleeTTI, GetAssumptionCache, {GetBFI}, |
Haicheng Wu | 0812c5b | 2017-08-21 20:00:09 +0000 | [diff] [blame] | 999 | PSI, &ORE); |
Chandler Carruth | b698d59 | 2017-01-22 10:34:01 +0000 | [diff] [blame] | 1000 | }; |
| 1001 | |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 1002 | // Now process as many calls as we have within this caller in the sequnece. |
| 1003 | // We bail out as soon as the caller has to change so we can update the |
| 1004 | // call graph and prepare the context of that new caller. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1005 | bool DidInline = false; |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 1006 | for (; i < (int)Calls.size() && Calls[i].first.getCaller() == &F; ++i) { |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 1007 | int InlineHistoryID; |
| 1008 | CallSite CS; |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 1009 | std::tie(CS, InlineHistoryID) = Calls[i]; |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1010 | Function &Callee = *CS.getCalledFunction(); |
| 1011 | |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 1012 | if (InlineHistoryID != -1 && |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1013 | InlineHistoryIncludes(&Callee, InlineHistoryID, InlineHistory)) { |
| 1014 | setInlineRemark(CS, "recursive"); |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 1015 | continue; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1016 | } |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 1017 | |
Chandler Carruth | 95055d8 | 2017-08-02 02:09:22 +0000 | [diff] [blame] | 1018 | // Check if this inlining may repeat breaking an SCC apart that has |
| 1019 | // already been split once before. In that case, inlining here may |
| 1020 | // trigger infinite inlining, much like is prevented within the inliner |
| 1021 | // itself by the InlineHistory above, but spread across CGSCC iterations |
| 1022 | // and thus hidden from the full inline history. |
| 1023 | if (CG.lookupSCC(*CG.lookup(Callee)) == C && |
| 1024 | UR.InlinedInternalEdges.count({&N, C})) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1025 | LLVM_DEBUG(dbgs() << "Skipping inlining internal SCC edge from a node " |
| 1026 | "previously split out of this SCC by inlining: " |
| 1027 | << F.getName() << " -> " << Callee.getName() << "\n"); |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1028 | setInlineRemark(CS, "recursive SCC split"); |
Chandler Carruth | 95055d8 | 2017-08-02 02:09:22 +0000 | [diff] [blame] | 1029 | continue; |
| 1030 | } |
| 1031 | |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 1032 | Optional<InlineCost> OIC = shouldInline(CS, GetInlineCost, ORE); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1033 | // Check whether we want to inline this callsite. |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1034 | if (!OIC.hasValue()) { |
| 1035 | setInlineRemark(CS, "deferred"); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1036 | continue; |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1037 | } |
| 1038 | |
| 1039 | if (!OIC.getValue()) { |
| 1040 | // shouldInline() call returned a negative inline cost that explains |
| 1041 | // why this callsite should not be inlined. |
| 1042 | setInlineRemark(CS, inlineCostStr(*OIC)); |
| 1043 | continue; |
| 1044 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1045 | |
Easwaran Raman | 12585b0 | 2017-01-20 22:44:04 +0000 | [diff] [blame] | 1046 | // Setup the data structure used to plumb customization into the |
| 1047 | // `InlineFunction` routine. |
| 1048 | InlineFunctionInfo IFI( |
Easwaran Raman | f5f9160 | 2017-05-09 23:21:10 +0000 | [diff] [blame] | 1049 | /*cg=*/nullptr, &GetAssumptionCache, PSI, |
Easwaran Raman | 12585b0 | 2017-01-20 22:44:04 +0000 | [diff] [blame] | 1050 | &FAM.getResult<BlockFrequencyAnalysis>(*(CS.getCaller())), |
| 1051 | &FAM.getResult<BlockFrequencyAnalysis>(Callee)); |
| 1052 | |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 1053 | // Get DebugLoc to report. CS will be invalid after Inliner. |
| 1054 | DebugLoc DLoc = CS->getDebugLoc(); |
| 1055 | BasicBlock *Block = CS.getParent(); |
| 1056 | |
| 1057 | using namespace ore; |
Eugene Zelenko | f27d161 | 2017-10-19 21:21:30 +0000 | [diff] [blame] | 1058 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 1059 | InlineResult IR = InlineFunction(CS, IFI); |
| 1060 | if (!IR) { |
David Bolvansky | c1b27b5 | 2018-08-28 15:27:25 +0000 | [diff] [blame] | 1061 | setInlineRemark(CS, std::string(IR) + "; " + inlineCostStr(*OIC)); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 1062 | ORE.emit([&]() { |
| 1063 | return OptimizationRemarkMissed(DEBUG_TYPE, "NotInlined", DLoc, Block) |
| 1064 | << NV("Callee", &Callee) << " will not be inlined into " |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 1065 | << NV("Caller", &F) << ": " << NV("Reason", IR.message); |
Vivek Pandya | 9590658 | 2017-10-11 17:12:59 +0000 | [diff] [blame] | 1066 | }); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1067 | continue; |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 1068 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1069 | DidInline = true; |
| 1070 | InlinedCallees.insert(&Callee); |
| 1071 | |
Fedor Sergeev | b55705f | 2018-08-14 15:19:14 +0000 | [diff] [blame] | 1072 | ++NumInlined; |
| 1073 | |
David Bolvansky | c0aa4b7 | 2018-08-05 14:53:08 +0000 | [diff] [blame] | 1074 | emit_inlined_into(ORE, DLoc, Block, Callee, F, *OIC); |
Sam Elliott | e604b56 | 2017-08-21 16:45:47 +0000 | [diff] [blame] | 1075 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1076 | // Add any new callsites to defined functions to the worklist. |
Chandler Carruth | 141bf5d | 2016-12-27 06:46:20 +0000 | [diff] [blame] | 1077 | if (!IFI.InlinedCallSites.empty()) { |
| 1078 | int NewHistoryID = InlineHistory.size(); |
| 1079 | InlineHistory.push_back({&Callee, InlineHistoryID}); |
| 1080 | for (CallSite &CS : reverse(IFI.InlinedCallSites)) |
| 1081 | if (Function *NewCallee = CS.getCalledFunction()) |
| 1082 | if (!NewCallee->isDeclaration()) |
| 1083 | Calls.push_back({CS, NewHistoryID}); |
| 1084 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1085 | |
Teresa Johnson | e87868b | 2018-06-28 20:07:47 +0000 | [diff] [blame] | 1086 | if (InlinerFunctionImportStats != InlinerFunctionImportStatsOpts::No) |
| 1087 | ImportedFunctionsStats->recordInline(F, Callee); |
| 1088 | |
Chandler Carruth | 03130d9 | 2016-12-27 03:39:54 +0000 | [diff] [blame] | 1089 | // Merge the attributes based on the inlining. |
| 1090 | AttributeFuncs::mergeAttributesForInlining(F, Callee); |
| 1091 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1092 | // For local functions, check whether this makes the callee trivially |
| 1093 | // dead. In that case, we can drop the body of the function eagerly |
| 1094 | // which may reduce the number of callers of other functions to one, |
| 1095 | // changing inline cost thresholds. |
| 1096 | if (Callee.hasLocalLinkage()) { |
| 1097 | // To check this we also need to nuke any dead constant uses (perhaps |
| 1098 | // made dead by this operation on other functions). |
| 1099 | Callee.removeDeadConstantUsers(); |
Chandler Carruth | 06a8630 | 2017-07-19 04:12:25 +0000 | [diff] [blame] | 1100 | if (Callee.use_empty() && !CG.isLibFunction(Callee)) { |
Chandler Carruth | 814e0df | 2017-03-16 10:45:42 +0000 | [diff] [blame] | 1101 | Calls.erase( |
| 1102 | std::remove_if(Calls.begin() + i + 1, Calls.end(), |
| 1103 | [&Callee](const std::pair<CallSite, int> &Call) { |
| 1104 | return Call.first.getCaller() == &Callee; |
| 1105 | }), |
| 1106 | Calls.end()); |
Chandler Carruth | 6acdca7 | 2017-01-24 12:55:57 +0000 | [diff] [blame] | 1107 | // Clear the body and queue the function itself for deletion when we |
| 1108 | // finish inlining and call graph updates. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1109 | // Note that after this point, it is an error to do anything other |
| 1110 | // than use the callee's address or delete it. |
| 1111 | Callee.dropAllReferences(); |
| 1112 | assert(find(DeadFunctions, &Callee) == DeadFunctions.end() && |
| 1113 | "Cannot put cause a function to become dead twice!"); |
| 1114 | DeadFunctions.push_back(&Callee); |
| 1115 | } |
| 1116 | } |
| 1117 | } |
| 1118 | |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 1119 | // Back the call index up by one to put us in a good position to go around |
| 1120 | // the outer loop. |
| 1121 | --i; |
| 1122 | |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1123 | if (!DidInline) |
| 1124 | continue; |
| 1125 | Changed = true; |
| 1126 | |
Chandler Carruth | 9900d18 | 2016-12-28 03:13:12 +0000 | [diff] [blame] | 1127 | // Add all the inlined callees' edges as ref edges to the caller. These are |
| 1128 | // by definition trivial edges as we always have *some* transitive ref edge |
| 1129 | // chain. While in some cases these edges are direct calls inside the |
| 1130 | // callee, they have to be modeled in the inliner as reference edges as |
| 1131 | // there may be a reference edge anywhere along the chain from the current |
| 1132 | // caller to the callee that causes the whole thing to appear like |
| 1133 | // a (transitive) reference edge that will require promotion to a call edge |
| 1134 | // below. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1135 | for (Function *InlinedCallee : InlinedCallees) { |
| 1136 | LazyCallGraph::Node &CalleeN = *CG.lookup(*InlinedCallee); |
Chandler Carruth | aaad9f8 | 2017-02-09 23:24:13 +0000 | [diff] [blame] | 1137 | for (LazyCallGraph::Edge &E : *CalleeN) |
| 1138 | RC->insertTrivialRefEdge(N, E.getNode()); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1139 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1140 | |
| 1141 | // At this point, since we have made changes we have at least removed |
| 1142 | // a call instruction. However, in the process we do some incremental |
| 1143 | // simplification of the surrounding code. This simplification can |
| 1144 | // essentially do all of the same things as a function pass and we can |
| 1145 | // re-use the exact same logic for updating the call graph to reflect the |
Chandler Carruth | 95055d8 | 2017-08-02 02:09:22 +0000 | [diff] [blame] | 1146 | // change. |
| 1147 | LazyCallGraph::SCC *OldC = C; |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1148 | C = &updateCGAndAnalysisManagerForFunctionPass(CG, *C, N, AM, UR); |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1149 | LLVM_DEBUG(dbgs() << "Updated inlining SCC: " << *C << "\n"); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1150 | RC = &C->getOuterRefSCC(); |
Chandler Carruth | 95055d8 | 2017-08-02 02:09:22 +0000 | [diff] [blame] | 1151 | |
| 1152 | // If this causes an SCC to split apart into multiple smaller SCCs, there |
| 1153 | // is a subtle risk we need to prepare for. Other transformations may |
| 1154 | // expose an "infinite inlining" opportunity later, and because of the SCC |
| 1155 | // mutation, we will revisit this function and potentially re-inline. If we |
| 1156 | // do, and that re-inlining also has the potentially to mutate the SCC |
| 1157 | // structure, the infinite inlining problem can manifest through infinite |
| 1158 | // SCC splits and merges. To avoid this, we capture the originating caller |
| 1159 | // node and the SCC containing the call edge. This is a slight over |
| 1160 | // approximation of the possible inlining decisions that must be avoided, |
| 1161 | // but is relatively efficient to store. |
| 1162 | // FIXME: This seems like a very heavyweight way of retaining the inline |
| 1163 | // history, we should look for a more efficient way of tracking it. |
| 1164 | if (C != OldC && llvm::any_of(InlinedCallees, [&](Function *Callee) { |
| 1165 | return CG.lookupSCC(*CG.lookup(*Callee)) == OldC; |
| 1166 | })) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1167 | LLVM_DEBUG(dbgs() << "Inlined an internal call edge and split an SCC, " |
| 1168 | "retaining this to avoid infinite inlining.\n"); |
Chandler Carruth | 95055d8 | 2017-08-02 02:09:22 +0000 | [diff] [blame] | 1169 | UR.InlinedInternalEdges.insert({&N, OldC}); |
| 1170 | } |
| 1171 | InlinedCallees.clear(); |
Chandler Carruth | 20e588e | 2017-03-09 11:35:40 +0000 | [diff] [blame] | 1172 | } |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1173 | |
| 1174 | // Now that we've finished inlining all of the calls across this SCC, delete |
| 1175 | // all of the trivially dead functions, updating the call graph and the CGSCC |
| 1176 | // pass manager in the process. |
| 1177 | // |
| 1178 | // Note that this walks a pointer set which has non-deterministic order but |
| 1179 | // that is OK as all we do is delete things and add pointers to unordered |
| 1180 | // sets. |
| 1181 | for (Function *DeadF : DeadFunctions) { |
| 1182 | // Get the necessary information out of the call graph and nuke the |
Chandler Carruth | 6acdca7 | 2017-01-24 12:55:57 +0000 | [diff] [blame] | 1183 | // function there. Also, cclear out any cached analyses. |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1184 | auto &DeadC = *CG.lookupSCC(*CG.lookup(*DeadF)); |
Chandler Carruth | 6acdca7 | 2017-01-24 12:55:57 +0000 | [diff] [blame] | 1185 | FunctionAnalysisManager &FAM = |
| 1186 | AM.getResult<FunctionAnalysisManagerCGSCCProxy>(DeadC, CG) |
| 1187 | .getManager(); |
Sanjoy Das | def1729 | 2017-09-28 02:45:42 +0000 | [diff] [blame] | 1188 | FAM.clear(*DeadF, DeadF->getName()); |
| 1189 | AM.clear(DeadC, DeadC.getName()); |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1190 | auto &DeadRC = DeadC.getOuterRefSCC(); |
| 1191 | CG.removeDeadFunction(*DeadF); |
| 1192 | |
| 1193 | // Mark the relevant parts of the call graph as invalid so we don't visit |
| 1194 | // them. |
| 1195 | UR.InvalidatedSCCs.insert(&DeadC); |
| 1196 | UR.InvalidatedRefSCCs.insert(&DeadRC); |
| 1197 | |
| 1198 | // And delete the actual function from the module. |
| 1199 | M.getFunctionList().erase(DeadF); |
Fedor Sergeev | b55705f | 2018-08-14 15:19:14 +0000 | [diff] [blame] | 1200 | ++NumDeleted; |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1201 | } |
Chandler Carruth | bd9c290 | 2017-07-09 03:59:31 +0000 | [diff] [blame] | 1202 | |
| 1203 | if (!Changed) |
| 1204 | return PreservedAnalyses::all(); |
| 1205 | |
| 1206 | // Even if we change the IR, we update the core CGSCC data structures and so |
| 1207 | // can preserve the proxy to the function analysis manager. |
| 1208 | PreservedAnalyses PA; |
| 1209 | PA.preserve<FunctionAnalysisManagerCGSCCProxy>(); |
| 1210 | return PA; |
Chandler Carruth | 1d96311 | 2016-12-20 03:15:32 +0000 | [diff] [blame] | 1211 | } |