17adc3a2bSChandler Carruth //===- InlineCost.cpp - Cost analysis for inliner -------------------------===//
27adc3a2bSChandler Carruth //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
67adc3a2bSChandler Carruth //
77adc3a2bSChandler Carruth //===----------------------------------------------------------------------===//
87adc3a2bSChandler Carruth //
97adc3a2bSChandler Carruth // This file implements inline cost analysis.
107adc3a2bSChandler Carruth //
117adc3a2bSChandler Carruth //===----------------------------------------------------------------------===//
127adc3a2bSChandler Carruth 
137adc3a2bSChandler Carruth #include "llvm/Analysis/InlineCost.h"
147adc3a2bSChandler Carruth #include "llvm/ADT/STLExtras.h"
157adc3a2bSChandler Carruth #include "llvm/ADT/SetVector.h"
167adc3a2bSChandler Carruth #include "llvm/ADT/SmallPtrSet.h"
177adc3a2bSChandler Carruth #include "llvm/ADT/SmallVector.h"
187adc3a2bSChandler Carruth #include "llvm/ADT/Statistic.h"
19aec2fa35SDaniel Jasper #include "llvm/Analysis/AssumptionCache.h"
2012585b01SEaswaran Raman #include "llvm/Analysis/BlockFrequencyInfo.h"
214c1a1d3cSReid Kleckner #include "llvm/Analysis/CFG.h"
227adc3a2bSChandler Carruth #include "llvm/Analysis/CodeMetrics.h"
237adc3a2bSChandler Carruth #include "llvm/Analysis/ConstantFolding.h"
247adc3a2bSChandler Carruth #include "llvm/Analysis/InstructionSimplify.h"
25ba9f245bSDavid Green #include "llvm/Analysis/LoopInfo.h"
2671069cf6SEaswaran Raman #include "llvm/Analysis/ProfileSummaryInfo.h"
27f9ca75f1STeresa Johnson #include "llvm/Analysis/TargetLibraryInfo.h"
287adc3a2bSChandler Carruth #include "llvm/Analysis/TargetTransformInfo.h"
29a4461515SHaicheng Wu #include "llvm/Analysis/ValueTracking.h"
30432a3883SNico Weber #include "llvm/Config/llvm-config.h"
31c965fd94SKirill Naumov #include "llvm/IR/AssemblyAnnotationWriter.h"
327adc3a2bSChandler Carruth #include "llvm/IR/CallingConv.h"
337adc3a2bSChandler Carruth #include "llvm/IR/DataLayout.h"
34ba9f245bSDavid Green #include "llvm/IR/Dominators.h"
357adc3a2bSChandler Carruth #include "llvm/IR/GetElementPtrTypeIterator.h"
367adc3a2bSChandler Carruth #include "llvm/IR/GlobalAlias.h"
377adc3a2bSChandler Carruth #include "llvm/IR/InstVisitor.h"
387adc3a2bSChandler Carruth #include "llvm/IR/IntrinsicInst.h"
397adc3a2bSChandler Carruth #include "llvm/IR/Operator.h"
407cebf0afSCraig Topper #include "llvm/IR/PatternMatch.h"
414c1a1d3cSReid Kleckner #include "llvm/Support/CommandLine.h"
427adc3a2bSChandler Carruth #include "llvm/Support/Debug.h"
43c965fd94SKirill Naumov #include "llvm/Support/FormattedStream.h"
447adc3a2bSChandler Carruth #include "llvm/Support/raw_ostream.h"
457adc3a2bSChandler Carruth 
467adc3a2bSChandler Carruth using namespace llvm;
477adc3a2bSChandler Carruth 
487adc3a2bSChandler Carruth #define DEBUG_TYPE "inline-cost"
497adc3a2bSChandler Carruth 
507adc3a2bSChandler Carruth STATISTIC(NumCallsAnalyzed, "Number of call sites analyzed");
517adc3a2bSChandler Carruth 
527f37a802STeresa Johnson static cl::opt<int>
537f37a802STeresa Johnson     DefaultThreshold("inlinedefault-threshold", cl::Hidden, cl::init(225),
547f37a802STeresa Johnson                      cl::ZeroOrMore,
557f37a802STeresa Johnson                      cl::desc("Default amount of inlining to perform"));
567f37a802STeresa Johnson 
57c965fd94SKirill Naumov static cl::opt<bool> PrintDebugInstructionDeltas("print-instruction-deltas",
58c965fd94SKirill Naumov     cl::Hidden, cl::init(false),
59c965fd94SKirill Naumov     cl::desc("Prints deltas of cost and threshold per instruction"));
60c965fd94SKirill Naumov 
611c57cc2bSEaswaran Raman static cl::opt<int> InlineThreshold(
62f4bb2f0dSEaswaran Raman     "inline-threshold", cl::Hidden, cl::init(225), cl::ZeroOrMore,
63f4bb2f0dSEaswaran Raman     cl::desc("Control the amount of inlining to perform (default = 225)"));
64f4bb2f0dSEaswaran Raman 
65f4bb2f0dSEaswaran Raman static cl::opt<int> HintThreshold(
66fd3e7a93SDavid Callahan     "inlinehint-threshold", cl::Hidden, cl::init(325), cl::ZeroOrMore,
67f4bb2f0dSEaswaran Raman     cl::desc("Threshold for inlining functions with inline hint"));
68f4bb2f0dSEaswaran Raman 
6912585b01SEaswaran Raman static cl::opt<int>
7012585b01SEaswaran Raman     ColdCallSiteThreshold("inline-cold-callsite-threshold", cl::Hidden,
71fd3e7a93SDavid Callahan                           cl::init(45), cl::ZeroOrMore,
7212585b01SEaswaran Raman                           cl::desc("Threshold for inlining cold callsites"));
7312585b01SEaswaran Raman 
74f4bb2f0dSEaswaran Raman // We introduce this threshold to help performance of instrumentation based
75f4bb2f0dSEaswaran Raman // PGO before we actually hook up inliner with analysis passes such as BPI and
76f4bb2f0dSEaswaran Raman // BFI.
77f4bb2f0dSEaswaran Raman static cl::opt<int> ColdThreshold(
78fd3e7a93SDavid Callahan     "inlinecold-threshold", cl::Hidden, cl::init(45), cl::ZeroOrMore,
79f4bb2f0dSEaswaran Raman     cl::desc("Threshold for inlining functions with cold attribute"));
80f4bb2f0dSEaswaran Raman 
81de39cb93SDehao Chen static cl::opt<int>
82de39cb93SDehao Chen     HotCallSiteThreshold("hot-callsite-threshold", cl::Hidden, cl::init(3000),
83de39cb93SDehao Chen                          cl::ZeroOrMore,
84de39cb93SDehao Chen                          cl::desc("Threshold for hot callsites "));
85de39cb93SDehao Chen 
86974d4eeaSEaswaran Raman static cl::opt<int> LocallyHotCallSiteThreshold(
87974d4eeaSEaswaran Raman     "locally-hot-callsite-threshold", cl::Hidden, cl::init(525), cl::ZeroOrMore,
88974d4eeaSEaswaran Raman     cl::desc("Threshold for locally hot callsites "));
89974d4eeaSEaswaran Raman 
90c5fa6358SEaswaran Raman static cl::opt<int> ColdCallSiteRelFreq(
91c5fa6358SEaswaran Raman     "cold-callsite-rel-freq", cl::Hidden, cl::init(2), cl::ZeroOrMore,
9202a2bb2fSHiroshi Inoue     cl::desc("Maximum block frequency, expressed as a percentage of caller's "
93c5fa6358SEaswaran Raman              "entry frequency, for a callsite to be cold in the absence of "
94c5fa6358SEaswaran Raman              "profile information."));
95c5fa6358SEaswaran Raman 
96974d4eeaSEaswaran Raman static cl::opt<int> HotCallSiteRelFreq(
97974d4eeaSEaswaran Raman     "hot-callsite-rel-freq", cl::Hidden, cl::init(60), cl::ZeroOrMore,
98ff77cc75SEaswaran Raman     cl::desc("Minimum block frequency, expressed as a multiple of caller's "
99974d4eeaSEaswaran Raman              "entry frequency, for a callsite to be hot in the absence of "
100974d4eeaSEaswaran Raman              "profile information."));
101974d4eeaSEaswaran Raman 
1024924bb00SEaswaran Raman static cl::opt<bool> OptComputeFullInlineCost(
103fd3e7a93SDavid Callahan     "inline-cost-full", cl::Hidden, cl::init(false), cl::ZeroOrMore,
1040812c5beSHaicheng Wu     cl::desc("Compute the full inline cost of a call site even when the cost "
1050812c5beSHaicheng Wu              "exceeds the threshold."));
1060812c5beSHaicheng Wu 
107ed03d948SMehdi Amini static cl::opt<bool> InlineCallerSupersetNoBuiltin(
108ed03d948SMehdi Amini     "inline-caller-superset-nobuiltin", cl::Hidden, cl::init(true),
109ed03d948SMehdi Amini     cl::ZeroOrMore,
110ed03d948SMehdi Amini     cl::desc("Allow inlining when caller has a superset of callee's nobuiltin "
111f9ca75f1STeresa Johnson              "attributes."));
112f9ca75f1STeresa Johnson 
1137adc3a2bSChandler Carruth namespace {
11406408758SMircea Trofin class InlineCostCallAnalyzer;
115c965fd94SKirill Naumov 
116c965fd94SKirill Naumov // This struct is used to store information about inline cost of a
117c965fd94SKirill Naumov // particular instruction
118c965fd94SKirill Naumov struct InstructionCostDetail {
119b4924f01SMircea Trofin   int CostBefore = 0;
120b4924f01SMircea Trofin   int CostAfter = 0;
121b4924f01SMircea Trofin   int ThresholdBefore = 0;
122b4924f01SMircea Trofin   int ThresholdAfter = 0;
123b4924f01SMircea Trofin 
124b4924f01SMircea Trofin   int getThresholdDelta() const { return ThresholdAfter - ThresholdBefore; }
125b4924f01SMircea Trofin 
126b4924f01SMircea Trofin   int getCostDelta() const { return CostAfter - CostBefore; }
127b4924f01SMircea Trofin 
128b4924f01SMircea Trofin   bool hasThresholdChanged() const { return ThresholdAfter != ThresholdBefore; }
129c965fd94SKirill Naumov };
130c965fd94SKirill Naumov 
131c965fd94SKirill Naumov class CostAnnotationWriter : public AssemblyAnnotationWriter {
132c965fd94SKirill Naumov public:
133c965fd94SKirill Naumov   // This DenseMap stores the delta change in cost and threshold after
134c965fd94SKirill Naumov   // accounting for the given instruction.
135c965fd94SKirill Naumov   DenseMap <const Instruction *, InstructionCostDetail> CostThresholdMap;
136c965fd94SKirill Naumov 
137c965fd94SKirill Naumov   virtual void emitInstructionAnnot(const Instruction *I,
138c965fd94SKirill Naumov                                         formatted_raw_ostream &OS);
139c965fd94SKirill Naumov };
140c965fd94SKirill Naumov 
1417adc3a2bSChandler Carruth class CallAnalyzer : public InstVisitor<CallAnalyzer, bool> {
1427adc3a2bSChandler Carruth   typedef InstVisitor<CallAnalyzer, bool> Base;
1437adc3a2bSChandler Carruth   friend class InstVisitor<CallAnalyzer, bool>;
1447adc3a2bSChandler Carruth 
14506408758SMircea Trofin protected:
14606408758SMircea Trofin   virtual ~CallAnalyzer() {}
1477adc3a2bSChandler Carruth   /// The TargetTransformInfo available for this compilation.
1487adc3a2bSChandler Carruth   const TargetTransformInfo &TTI;
1497adc3a2bSChandler Carruth 
150aec2fa35SDaniel Jasper   /// Getter for the cache of @llvm.assume intrinsics.
151aec2fa35SDaniel Jasper   std::function<AssumptionCache &(Function &)> &GetAssumptionCache;
152aec2fa35SDaniel Jasper 
15312585b01SEaswaran Raman   /// Getter for BlockFrequencyInfo
15412585b01SEaswaran Raman   Optional<function_ref<BlockFrequencyInfo &(Function &)>> &GetBFI;
15512585b01SEaswaran Raman 
15671069cf6SEaswaran Raman   /// Profile summary information.
15771069cf6SEaswaran Raman   ProfileSummaryInfo *PSI;
15871069cf6SEaswaran Raman 
159f3d122cdSPiotr Padlewski   /// The called function.
1607adc3a2bSChandler Carruth   Function &F;
1617adc3a2bSChandler Carruth 
16285be8ca8SEric Christopher   // Cache the DataLayout since we use it a lot.
16385be8ca8SEric Christopher   const DataLayout &DL;
16485be8ca8SEric Christopher 
1650812c5beSHaicheng Wu   /// The OptimizationRemarkEmitter available for this compilation.
1660812c5beSHaicheng Wu   OptimizationRemarkEmitter *ORE;
1670812c5beSHaicheng Wu 
168f3d122cdSPiotr Padlewski   /// The candidate callsite being analyzed. Please do not use this to do
169f3d122cdSPiotr Padlewski   /// analysis in the caller function; we want the inline cost query to be
170f3d122cdSPiotr Padlewski   /// easily cacheable. Instead, use the cover function paramHasAttr.
171652168a9SFedor Sergeev   CallBase &CandidateCall;
1727adc3a2bSChandler Carruth 
17306408758SMircea Trofin   /// Extension points for handling callsite features.
17406408758SMircea Trofin   /// Called after a basic block was analyzed.
17506408758SMircea Trofin   virtual void onBlockAnalyzed(const BasicBlock *BB) {}
1761c57cc2bSEaswaran Raman 
177c965fd94SKirill Naumov   /// Called before an instruction was analyzed
178c965fd94SKirill Naumov   virtual void onInstructionAnalysisStart(const Instruction *I) {}
179c965fd94SKirill Naumov 
180c965fd94SKirill Naumov   /// Called after an instruction was analyzed
181c965fd94SKirill Naumov   virtual void onInstructionAnalysisFinish(const Instruction *I) {}
182c965fd94SKirill Naumov 
18306408758SMircea Trofin   /// Called at the end of the analysis of the callsite. Return the outcome of
18406408758SMircea Trofin   /// the analysis, i.e. 'InlineResult(true)' if the inlining may happen, or
18506408758SMircea Trofin   /// the reason it can't.
1865466597fSMircea Trofin   virtual InlineResult finalizeAnalysis() { return InlineResult::success(); }
18706408758SMircea Trofin   /// Called when we're about to start processing a basic block, and every time
18806408758SMircea Trofin   /// we are done processing an instruction. Return true if there is no point in
18906408758SMircea Trofin   /// continuing the analysis (e.g. we've determined already the call site is
19006408758SMircea Trofin   /// too expensive to inline)
19106408758SMircea Trofin   virtual bool shouldStop() { return false; }
192eeae45dcSFedor Sergeev 
19306408758SMircea Trofin   /// Called before the analysis of the callee body starts (with callsite
19406408758SMircea Trofin   /// contexts propagated).  It checks callsite-specific information. Return a
19506408758SMircea Trofin   /// reason analysis can't continue if that's the case, or 'true' if it may
19606408758SMircea Trofin   /// continue.
1975466597fSMircea Trofin   virtual InlineResult onAnalysisStart() { return InlineResult::success(); }
19806408758SMircea Trofin   /// Called if the analysis engine decides SROA cannot be done for the given
19906408758SMircea Trofin   /// alloca.
20006408758SMircea Trofin   virtual void onDisableSROA(AllocaInst *Arg) {}
20106408758SMircea Trofin 
20206408758SMircea Trofin   /// Called the analysis engine determines load elimination won't happen.
20306408758SMircea Trofin   virtual void onDisableLoadElimination() {}
20406408758SMircea Trofin 
20506408758SMircea Trofin   /// Called to account for a call.
20606408758SMircea Trofin   virtual void onCallPenalty() {}
20706408758SMircea Trofin 
20806408758SMircea Trofin   /// Called to account for the expectation the inlining would result in a load
20906408758SMircea Trofin   /// elimination.
21006408758SMircea Trofin   virtual void onLoadEliminationOpportunity() {}
21106408758SMircea Trofin 
21206408758SMircea Trofin   /// Called to account for the cost of argument setup for the Call in the
21306408758SMircea Trofin   /// callee's body (not the callsite currently under analysis).
21406408758SMircea Trofin   virtual void onCallArgumentSetup(const CallBase &Call) {}
21506408758SMircea Trofin 
21606408758SMircea Trofin   /// Called to account for a load relative intrinsic.
21706408758SMircea Trofin   virtual void onLoadRelativeIntrinsic() {}
21806408758SMircea Trofin 
21906408758SMircea Trofin   /// Called to account for a lowered call.
22006408758SMircea Trofin   virtual void onLoweredCall(Function *F, CallBase &Call, bool IsIndirectCall) {
22106408758SMircea Trofin   }
22206408758SMircea Trofin 
22306408758SMircea Trofin   /// Account for a jump table of given size. Return false to stop further
22406408758SMircea Trofin   /// processing the switch instruction
22506408758SMircea Trofin   virtual bool onJumpTable(unsigned JumpTableSize) { return true; }
22606408758SMircea Trofin 
22706408758SMircea Trofin   /// Account for a case cluster of given size. Return false to stop further
22806408758SMircea Trofin   /// processing of the instruction.
22906408758SMircea Trofin   virtual bool onCaseCluster(unsigned NumCaseCluster) { return true; }
23006408758SMircea Trofin 
23106408758SMircea Trofin   /// Called at the end of processing a switch instruction, with the given
23206408758SMircea Trofin   /// number of case clusters.
23306408758SMircea Trofin   virtual void onFinalizeSwitch(unsigned JumpTableSize,
23406408758SMircea Trofin                                 unsigned NumCaseCluster) {}
23506408758SMircea Trofin 
23606408758SMircea Trofin   /// Called to account for any other instruction not specifically accounted
23706408758SMircea Trofin   /// for.
23814a16faeSMircea Trofin   virtual void onMissedSimplification() {}
23906408758SMircea Trofin 
24006408758SMircea Trofin   /// Start accounting potential benefits due to SROA for the given alloca.
24106408758SMircea Trofin   virtual void onInitializeSROAArg(AllocaInst *Arg) {}
24206408758SMircea Trofin 
24306408758SMircea Trofin   /// Account SROA savings for the AllocaInst value.
24406408758SMircea Trofin   virtual void onAggregateSROAUse(AllocaInst *V) {}
24506408758SMircea Trofin 
24606408758SMircea Trofin   bool handleSROA(Value *V, bool DoNotDisable) {
24706408758SMircea Trofin     // Check for SROA candidates in comparisons.
24806408758SMircea Trofin     if (auto *SROAArg = getSROAArgForValueOrNull(V)) {
24906408758SMircea Trofin       if (DoNotDisable) {
25006408758SMircea Trofin         onAggregateSROAUse(SROAArg);
25106408758SMircea Trofin         return true;
25206408758SMircea Trofin       }
25306408758SMircea Trofin       disableSROAForArg(SROAArg);
25406408758SMircea Trofin     }
25506408758SMircea Trofin     return false;
25606408758SMircea Trofin   }
2577adc3a2bSChandler Carruth 
258eeae45dcSFedor Sergeev   bool IsCallerRecursive = false;
259eeae45dcSFedor Sergeev   bool IsRecursiveCall = false;
260eeae45dcSFedor Sergeev   bool ExposesReturnsTwice = false;
261eeae45dcSFedor Sergeev   bool HasDynamicAlloca = false;
262eeae45dcSFedor Sergeev   bool ContainsNoDuplicateCall = false;
263eeae45dcSFedor Sergeev   bool HasReturn = false;
264eeae45dcSFedor Sergeev   bool HasIndirectBr = false;
265eeae45dcSFedor Sergeev   bool HasUninlineableIntrinsic = false;
266eeae45dcSFedor Sergeev   bool InitsVargArgs = false;
2677adc3a2bSChandler Carruth 
2687adc3a2bSChandler Carruth   /// Number of bytes allocated statically by the callee.
269eeae45dcSFedor Sergeev   uint64_t AllocatedSize = 0;
270eeae45dcSFedor Sergeev   unsigned NumInstructions = 0;
271eeae45dcSFedor Sergeev   unsigned NumVectorInstructions = 0;
272eeae45dcSFedor Sergeev 
273f3d122cdSPiotr Padlewski   /// While we walk the potentially-inlined instructions, we build up and
274f3d122cdSPiotr Padlewski   /// maintain a mapping of simplified values specific to this callsite. The
275f3d122cdSPiotr Padlewski   /// idea is to propagate any special information we have about arguments to
276f3d122cdSPiotr Padlewski   /// this call through the inlinable section of the function, and account for
277f3d122cdSPiotr Padlewski   /// likely simplifications post-inlining. The most important aspect we track
278f3d122cdSPiotr Padlewski   /// is CFG altering simplifications -- when we prove a basic block dead, that
279f3d122cdSPiotr Padlewski   /// can cause dramatic shifts in the cost of inlining a function.
2807adc3a2bSChandler Carruth   DenseMap<Value *, Constant *> SimplifiedValues;
2817adc3a2bSChandler Carruth 
282f3d122cdSPiotr Padlewski   /// Keep track of the values which map back (through function arguments) to
283f3d122cdSPiotr Padlewski   /// allocas on the caller stack which could be simplified through SROA.
28406408758SMircea Trofin   DenseMap<Value *, AllocaInst *> SROAArgValues;
285338a6016SMircea Trofin 
28606408758SMircea Trofin   /// Keep track of Allocas for which we believe we may get SROA optimization.
2872e42cc7aSMircea Trofin   DenseSet<AllocaInst *> EnabledSROAAllocas;
2887adc3a2bSChandler Carruth 
289f3d122cdSPiotr Padlewski   /// Keep track of values which map to a pointer base and constant offset.
2907adc3a2bSChandler Carruth   DenseMap<Value *, std::pair<Value *, APInt>> ConstantOffsetPtrs;
2917adc3a2bSChandler Carruth 
2923739e14aSHaicheng Wu   /// Keep track of dead blocks due to the constant arguments.
2933739e14aSHaicheng Wu   SetVector<BasicBlock *> DeadBlocks;
2943739e14aSHaicheng Wu 
2953739e14aSHaicheng Wu   /// The mapping of the blocks to their known unique successors due to the
2963739e14aSHaicheng Wu   /// constant arguments.
2973739e14aSHaicheng Wu   DenseMap<BasicBlock *, BasicBlock *> KnownSuccessors;
2983739e14aSHaicheng Wu 
299a4461515SHaicheng Wu   /// Model the elimination of repeated loads that is expected to happen
300a4461515SHaicheng Wu   /// whenever we simplify away the stores that would otherwise cause them to be
301a4461515SHaicheng Wu   /// loads.
302a4461515SHaicheng Wu   bool EnableLoadElimination;
303a4461515SHaicheng Wu   SmallPtrSet<Value *, 16> LoadAddrSet;
30406408758SMircea Trofin 
30506408758SMircea Trofin   AllocaInst *getSROAArgForValueOrNull(Value *V) const {
30606408758SMircea Trofin     auto It = SROAArgValues.find(V);
3072e42cc7aSMircea Trofin     if (It == SROAArgValues.end() || EnabledSROAAllocas.count(It->second) == 0)
30806408758SMircea Trofin       return nullptr;
30906408758SMircea Trofin     return It->second;
31006408758SMircea Trofin   }
311a4461515SHaicheng Wu 
3127adc3a2bSChandler Carruth   // Custom simplification helper routines.
3137adc3a2bSChandler Carruth   bool isAllocaDerivedArg(Value *V);
31406408758SMircea Trofin   void disableSROAForArg(AllocaInst *SROAArg);
3157adc3a2bSChandler Carruth   void disableSROA(Value *V);
3163739e14aSHaicheng Wu   void findDeadBlocks(BasicBlock *CurrBB, BasicBlock *NextBB);
317a4461515SHaicheng Wu   void disableLoadElimination();
318201b191bSHaicheng Wu   bool isGEPFree(GetElementPtrInst &GEP);
319d3558b5dSEvgeny Astigeevich   bool canFoldInboundsGEP(GetElementPtrInst &I);
3207adc3a2bSChandler Carruth   bool accumulateGEPOffset(GEPOperator &GEP, APInt &Offset);
321652168a9SFedor Sergeev   bool simplifyCallSite(Function *F, CallBase &Call);
322617f6364SEaswaran Raman   template <typename Callable>
323617f6364SEaswaran Raman   bool simplifyInstruction(Instruction &I, Callable Evaluate);
3247adc3a2bSChandler Carruth   ConstantInt *stripAndComputeInBoundsConstantOffsets(Value *&V);
3257adc3a2bSChandler Carruth 
3267adc3a2bSChandler Carruth   /// Return true if the given argument to the function being considered for
3277adc3a2bSChandler Carruth   /// inlining has the given attribute set either at the call site or the
3287adc3a2bSChandler Carruth   /// function declaration.  Primarily used to inspect call site specific
3297adc3a2bSChandler Carruth   /// attributes since these can be more precise than the ones on the callee
3307adc3a2bSChandler Carruth   /// itself.
3317adc3a2bSChandler Carruth   bool paramHasAttr(Argument *A, Attribute::AttrKind Attr);
3327adc3a2bSChandler Carruth 
3337adc3a2bSChandler Carruth   /// Return true if the given value is known non null within the callee if
3347adc3a2bSChandler Carruth   /// inlined through this particular callsite.
3357adc3a2bSChandler Carruth   bool isKnownNonNullInCallee(Value *V);
3367adc3a2bSChandler Carruth 
337652168a9SFedor Sergeev   /// Return true if size growth is allowed when inlining the callee at \p Call.
338652168a9SFedor Sergeev   bool allowSizeGrowth(CallBase &Call);
3399a3fc17aSEaswaran Raman 
3407adc3a2bSChandler Carruth   // Custom analysis routines.
341c0aa4b75SDavid Bolvansky   InlineResult analyzeBlock(BasicBlock *BB,
342c0aa4b75SDavid Bolvansky                             SmallPtrSetImpl<const Value *> &EphValues);
3437adc3a2bSChandler Carruth 
3447adc3a2bSChandler Carruth   // Disable several entry points to the visitor so we don't accidentally use
3457adc3a2bSChandler Carruth   // them by declaring but not defining them here.
346567556aaSChad Rosier   void visit(Module *);
347567556aaSChad Rosier   void visit(Module &);
348567556aaSChad Rosier   void visit(Function *);
349567556aaSChad Rosier   void visit(Function &);
350567556aaSChad Rosier   void visit(BasicBlock *);
351567556aaSChad Rosier   void visit(BasicBlock &);
3527adc3a2bSChandler Carruth 
3537adc3a2bSChandler Carruth   // Provide base case for our instruction visit.
3547adc3a2bSChandler Carruth   bool visitInstruction(Instruction &I);
3557adc3a2bSChandler Carruth 
3567adc3a2bSChandler Carruth   // Our visit overrides.
3577adc3a2bSChandler Carruth   bool visitAlloca(AllocaInst &I);
3587adc3a2bSChandler Carruth   bool visitPHI(PHINode &I);
3597adc3a2bSChandler Carruth   bool visitGetElementPtr(GetElementPtrInst &I);
3607adc3a2bSChandler Carruth   bool visitBitCast(BitCastInst &I);
3617adc3a2bSChandler Carruth   bool visitPtrToInt(PtrToIntInst &I);
3627adc3a2bSChandler Carruth   bool visitIntToPtr(IntToPtrInst &I);
3637adc3a2bSChandler Carruth   bool visitCastInst(CastInst &I);
3647adc3a2bSChandler Carruth   bool visitUnaryInstruction(UnaryInstruction &I);
3657adc3a2bSChandler Carruth   bool visitCmpInst(CmpInst &I);
3667adc3a2bSChandler Carruth   bool visitSub(BinaryOperator &I);
3677adc3a2bSChandler Carruth   bool visitBinaryOperator(BinaryOperator &I);
3686cda33baSCraig Topper   bool visitFNeg(UnaryOperator &I);
3697adc3a2bSChandler Carruth   bool visitLoad(LoadInst &I);
3707adc3a2bSChandler Carruth   bool visitStore(StoreInst &I);
3717adc3a2bSChandler Carruth   bool visitExtractValue(ExtractValueInst &I);
3727adc3a2bSChandler Carruth   bool visitInsertValue(InsertValueInst &I);
373652168a9SFedor Sergeev   bool visitCallBase(CallBase &Call);
3747adc3a2bSChandler Carruth   bool visitReturnInst(ReturnInst &RI);
3757adc3a2bSChandler Carruth   bool visitBranchInst(BranchInst &BI);
3763ec848bcSHaicheng Wu   bool visitSelectInst(SelectInst &SI);
3777adc3a2bSChandler Carruth   bool visitSwitchInst(SwitchInst &SI);
3787adc3a2bSChandler Carruth   bool visitIndirectBrInst(IndirectBrInst &IBI);
3797adc3a2bSChandler Carruth   bool visitResumeInst(ResumeInst &RI);
3807adc3a2bSChandler Carruth   bool visitCleanupReturnInst(CleanupReturnInst &RI);
3817adc3a2bSChandler Carruth   bool visitCatchReturnInst(CatchReturnInst &RI);
3827adc3a2bSChandler Carruth   bool visitUnreachableInst(UnreachableInst &I);
3837adc3a2bSChandler Carruth 
3847adc3a2bSChandler Carruth public:
385ab6a6837SSean Silva   CallAnalyzer(const TargetTransformInfo &TTI,
386aec2fa35SDaniel Jasper                std::function<AssumptionCache &(Function &)> &GetAssumptionCache,
38712585b01SEaswaran Raman                Optional<function_ref<BlockFrequencyInfo &(Function &)>> &GetBFI,
3880812c5beSHaicheng Wu                ProfileSummaryInfo *PSI, OptimizationRemarkEmitter *ORE,
38906408758SMircea Trofin                Function &Callee, CallBase &Call)
39012585b01SEaswaran Raman       : TTI(TTI), GetAssumptionCache(GetAssumptionCache), GetBFI(GetBFI),
3910812c5beSHaicheng Wu         PSI(PSI), F(Callee), DL(F.getParent()->getDataLayout()), ORE(ORE),
39206408758SMircea Trofin         CandidateCall(Call), EnableLoadElimination(true) {}
3937adc3a2bSChandler Carruth 
39493ac81ccSMircea Trofin   InlineResult analyze();
3957adc3a2bSChandler Carruth 
3967adc3a2bSChandler Carruth   // Keep a bunch of stats about the cost savings found so we can print them
3977adc3a2bSChandler Carruth   // out when debugging.
398eeae45dcSFedor Sergeev   unsigned NumConstantArgs = 0;
399eeae45dcSFedor Sergeev   unsigned NumConstantOffsetPtrArgs = 0;
400eeae45dcSFedor Sergeev   unsigned NumAllocaArgs = 0;
401eeae45dcSFedor Sergeev   unsigned NumConstantPtrCmps = 0;
402eeae45dcSFedor Sergeev   unsigned NumConstantPtrDiffs = 0;
403eeae45dcSFedor Sergeev   unsigned NumInstructionsSimplified = 0;
40476aab66dSMircea Trofin 
40576aab66dSMircea Trofin   void dump();
40676aab66dSMircea Trofin };
407338a6016SMircea Trofin 
40806408758SMircea Trofin /// FIXME: if it is necessary to derive from InlineCostCallAnalyzer, note
40906408758SMircea Trofin /// the FIXME in onLoweredCall, when instantiating an InlineCostCallAnalyzer
41006408758SMircea Trofin class InlineCostCallAnalyzer final : public CallAnalyzer {
41106408758SMircea Trofin   const int CostUpperBound = INT_MAX - InlineConstants::InstrCost - 1;
41206408758SMircea Trofin   const bool ComputeFullInlineCost;
41306408758SMircea Trofin   int LoadEliminationCost = 0;
41406408758SMircea Trofin   /// Bonus to be applied when percentage of vector instructions in callee is
41506408758SMircea Trofin   /// high (see more details in updateThreshold).
41606408758SMircea Trofin   int VectorBonus = 0;
41706408758SMircea Trofin   /// Bonus to be applied when the callee has only one reachable basic block.
41806408758SMircea Trofin   int SingleBBBonus = 0;
41906408758SMircea Trofin 
42006408758SMircea Trofin   /// Tunable parameters that control the analysis.
42106408758SMircea Trofin   const InlineParams &Params;
42206408758SMircea Trofin 
42306408758SMircea Trofin   /// Upper bound for the inlining cost. Bonuses are being applied to account
42406408758SMircea Trofin   /// for speculative "expected profit" of the inlining decision.
42506408758SMircea Trofin   int Threshold = 0;
42606408758SMircea Trofin 
42706408758SMircea Trofin   /// Attempt to evaluate indirect calls to boost its inline cost.
42806408758SMircea Trofin   const bool BoostIndirectCalls;
42906408758SMircea Trofin 
43006408758SMircea Trofin   /// Inlining cost measured in abstract units, accounts for all the
43106408758SMircea Trofin   /// instructions expected to be executed for a given function invocation.
43206408758SMircea Trofin   /// Instructions that are statically proven to be dead based on call-site
43306408758SMircea Trofin   /// arguments are not counted here.
43406408758SMircea Trofin   int Cost = 0;
43506408758SMircea Trofin 
43606408758SMircea Trofin   bool SingleBB = true;
43706408758SMircea Trofin 
43806408758SMircea Trofin   unsigned SROACostSavings = 0;
43906408758SMircea Trofin   unsigned SROACostSavingsLost = 0;
44006408758SMircea Trofin 
44106408758SMircea Trofin   /// The mapping of caller Alloca values to their accumulated cost savings. If
44206408758SMircea Trofin   /// we have to disable SROA for one of the allocas, this tells us how much
44306408758SMircea Trofin   /// cost must be added.
44406408758SMircea Trofin   DenseMap<AllocaInst *, int> SROAArgCosts;
44506408758SMircea Trofin 
44606408758SMircea Trofin   /// Return true if \p Call is a cold callsite.
44706408758SMircea Trofin   bool isColdCallSite(CallBase &Call, BlockFrequencyInfo *CallerBFI);
44806408758SMircea Trofin 
44906408758SMircea Trofin   /// Update Threshold based on callsite properties such as callee
45006408758SMircea Trofin   /// attributes and callee hotness for PGO builds. The Callee is explicitly
45106408758SMircea Trofin   /// passed to support analyzing indirect calls whose target is inferred by
45206408758SMircea Trofin   /// analysis.
45306408758SMircea Trofin   void updateThreshold(CallBase &Call, Function &Callee);
45406408758SMircea Trofin   /// Return a higher threshold if \p Call is a hot callsite.
45506408758SMircea Trofin   Optional<int> getHotCallSiteThreshold(CallBase &Call,
45606408758SMircea Trofin                                         BlockFrequencyInfo *CallerBFI);
45706408758SMircea Trofin 
45806408758SMircea Trofin   /// Handle a capped 'int' increment for Cost.
45906408758SMircea Trofin   void addCost(int64_t Inc, int64_t UpperBound = INT_MAX) {
46006408758SMircea Trofin     assert(UpperBound > 0 && UpperBound <= INT_MAX && "invalid upper bound");
46106408758SMircea Trofin     Cost = (int)std::min(UpperBound, Cost + Inc);
46206408758SMircea Trofin   }
46306408758SMircea Trofin 
46406408758SMircea Trofin   void onDisableSROA(AllocaInst *Arg) override {
46506408758SMircea Trofin     auto CostIt = SROAArgCosts.find(Arg);
46606408758SMircea Trofin     if (CostIt == SROAArgCosts.end())
46706408758SMircea Trofin       return;
46806408758SMircea Trofin     addCost(CostIt->second);
46906408758SMircea Trofin     SROACostSavings -= CostIt->second;
47006408758SMircea Trofin     SROACostSavingsLost += CostIt->second;
47106408758SMircea Trofin     SROAArgCosts.erase(CostIt);
47206408758SMircea Trofin   }
47306408758SMircea Trofin 
47406408758SMircea Trofin   void onDisableLoadElimination() override {
47506408758SMircea Trofin     addCost(LoadEliminationCost);
47606408758SMircea Trofin     LoadEliminationCost = 0;
47706408758SMircea Trofin   }
47806408758SMircea Trofin   void onCallPenalty() override { addCost(InlineConstants::CallPenalty); }
47906408758SMircea Trofin   void onCallArgumentSetup(const CallBase &Call) override {
48006408758SMircea Trofin     // Pay the price of the argument setup. We account for the average 1
48106408758SMircea Trofin     // instruction per call argument setup here.
48206408758SMircea Trofin     addCost(Call.arg_size() * InlineConstants::InstrCost);
48306408758SMircea Trofin   }
48406408758SMircea Trofin   void onLoadRelativeIntrinsic() override {
48506408758SMircea Trofin     // This is normally lowered to 4 LLVM instructions.
48606408758SMircea Trofin     addCost(3 * InlineConstants::InstrCost);
48706408758SMircea Trofin   }
48806408758SMircea Trofin   void onLoweredCall(Function *F, CallBase &Call,
48906408758SMircea Trofin                      bool IsIndirectCall) override {
49006408758SMircea Trofin     // We account for the average 1 instruction per call argument setup here.
49106408758SMircea Trofin     addCost(Call.arg_size() * InlineConstants::InstrCost);
49206408758SMircea Trofin 
49306408758SMircea Trofin     // If we have a constant that we are calling as a function, we can peer
49406408758SMircea Trofin     // through it and see the function target. This happens not infrequently
49506408758SMircea Trofin     // during devirtualization and so we want to give it a hefty bonus for
49606408758SMircea Trofin     // inlining, but cap that bonus in the event that inlining wouldn't pan out.
49706408758SMircea Trofin     // Pretend to inline the function, with a custom threshold.
49806408758SMircea Trofin     if (IsIndirectCall && BoostIndirectCalls) {
49906408758SMircea Trofin       auto IndirectCallParams = Params;
50006408758SMircea Trofin       IndirectCallParams.DefaultThreshold =
50106408758SMircea Trofin           InlineConstants::IndirectCallThreshold;
50206408758SMircea Trofin       /// FIXME: if InlineCostCallAnalyzer is derived from, this may need
50306408758SMircea Trofin       /// to instantiate the derived class.
50406408758SMircea Trofin       InlineCostCallAnalyzer CA(TTI, GetAssumptionCache, GetBFI, PSI, ORE, *F,
50506408758SMircea Trofin                                 Call, IndirectCallParams, false);
5065466597fSMircea Trofin       if (CA.analyze().isSuccess()) {
50706408758SMircea Trofin         // We were able to inline the indirect call! Subtract the cost from the
50806408758SMircea Trofin         // threshold to get the bonus we want to apply, but don't go below zero.
50906408758SMircea Trofin         Cost -= std::max(0, CA.getThreshold() - CA.getCost());
51006408758SMircea Trofin       }
51106408758SMircea Trofin     } else
51206408758SMircea Trofin       // Otherwise simply add the cost for merely making the call.
51306408758SMircea Trofin       addCost(InlineConstants::CallPenalty);
51406408758SMircea Trofin   }
51506408758SMircea Trofin 
51606408758SMircea Trofin   void onFinalizeSwitch(unsigned JumpTableSize,
51706408758SMircea Trofin                         unsigned NumCaseCluster) override {
51806408758SMircea Trofin     // If suitable for a jump table, consider the cost for the table size and
51906408758SMircea Trofin     // branch to destination.
52006408758SMircea Trofin     // Maximum valid cost increased in this function.
52106408758SMircea Trofin     if (JumpTableSize) {
52206408758SMircea Trofin       int64_t JTCost = (int64_t)JumpTableSize * InlineConstants::InstrCost +
52306408758SMircea Trofin                        4 * InlineConstants::InstrCost;
52406408758SMircea Trofin 
52506408758SMircea Trofin       addCost(JTCost, (int64_t)CostUpperBound);
52606408758SMircea Trofin       return;
52706408758SMircea Trofin     }
52806408758SMircea Trofin     // Considering forming a binary search, we should find the number of nodes
52906408758SMircea Trofin     // which is same as the number of comparisons when lowered. For a given
53006408758SMircea Trofin     // number of clusters, n, we can define a recursive function, f(n), to find
53106408758SMircea Trofin     // the number of nodes in the tree. The recursion is :
53206408758SMircea Trofin     // f(n) = 1 + f(n/2) + f (n - n/2), when n > 3,
53306408758SMircea Trofin     // and f(n) = n, when n <= 3.
53406408758SMircea Trofin     // This will lead a binary tree where the leaf should be either f(2) or f(3)
53506408758SMircea Trofin     // when n > 3.  So, the number of comparisons from leaves should be n, while
53606408758SMircea Trofin     // the number of non-leaf should be :
53706408758SMircea Trofin     //   2^(log2(n) - 1) - 1
53806408758SMircea Trofin     //   = 2^log2(n) * 2^-1 - 1
53906408758SMircea Trofin     //   = n / 2 - 1.
54006408758SMircea Trofin     // Considering comparisons from leaf and non-leaf nodes, we can estimate the
54106408758SMircea Trofin     // number of comparisons in a simple closed form :
54206408758SMircea Trofin     //   n + n / 2 - 1 = n * 3 / 2 - 1
54306408758SMircea Trofin     if (NumCaseCluster <= 3) {
54406408758SMircea Trofin       // Suppose a comparison includes one compare and one conditional branch.
54506408758SMircea Trofin       addCost(NumCaseCluster * 2 * InlineConstants::InstrCost);
54606408758SMircea Trofin       return;
54706408758SMircea Trofin     }
54806408758SMircea Trofin 
54906408758SMircea Trofin     int64_t ExpectedNumberOfCompare = 3 * (int64_t)NumCaseCluster / 2 - 1;
55006408758SMircea Trofin     int64_t SwitchCost =
55106408758SMircea Trofin         ExpectedNumberOfCompare * 2 * InlineConstants::InstrCost;
55206408758SMircea Trofin 
55306408758SMircea Trofin     addCost(SwitchCost, (int64_t)CostUpperBound);
55406408758SMircea Trofin   }
55514a16faeSMircea Trofin   void onMissedSimplification() override {
55606408758SMircea Trofin     addCost(InlineConstants::InstrCost);
55706408758SMircea Trofin   }
55806408758SMircea Trofin 
55906408758SMircea Trofin   void onInitializeSROAArg(AllocaInst *Arg) override {
56006408758SMircea Trofin     assert(Arg != nullptr &&
56106408758SMircea Trofin            "Should not initialize SROA costs for null value.");
56206408758SMircea Trofin     SROAArgCosts[Arg] = 0;
56306408758SMircea Trofin   }
56406408758SMircea Trofin 
56506408758SMircea Trofin   void onAggregateSROAUse(AllocaInst *SROAArg) override {
56606408758SMircea Trofin     auto CostIt = SROAArgCosts.find(SROAArg);
56706408758SMircea Trofin     assert(CostIt != SROAArgCosts.end() &&
56806408758SMircea Trofin            "expected this argument to have a cost");
56906408758SMircea Trofin     CostIt->second += InlineConstants::InstrCost;
57006408758SMircea Trofin     SROACostSavings += InlineConstants::InstrCost;
57106408758SMircea Trofin   }
57206408758SMircea Trofin 
57306408758SMircea Trofin   void onBlockAnalyzed(const BasicBlock *BB) override {
57406408758SMircea Trofin     auto *TI = BB->getTerminator();
57506408758SMircea Trofin     // If we had any successors at this point, than post-inlining is likely to
57606408758SMircea Trofin     // have them as well. Note that we assume any basic blocks which existed
57706408758SMircea Trofin     // due to branches or switches which folded above will also fold after
57806408758SMircea Trofin     // inlining.
57906408758SMircea Trofin     if (SingleBB && TI->getNumSuccessors() > 1) {
58006408758SMircea Trofin       // Take off the bonus we applied to the threshold.
58106408758SMircea Trofin       Threshold -= SingleBBBonus;
58206408758SMircea Trofin       SingleBB = false;
58306408758SMircea Trofin     }
58406408758SMircea Trofin   }
5855466597fSMircea Trofin 
586c965fd94SKirill Naumov   void onInstructionAnalysisStart(const Instruction *I) override {
587c965fd94SKirill Naumov     // This function is called to store the initial cost of inlining before
588c965fd94SKirill Naumov     // the given instruction was assessed.
589c965fd94SKirill Naumov     if (!PrintDebugInstructionDeltas)
590c965fd94SKirill Naumov         return ;
591c965fd94SKirill Naumov     Writer.CostThresholdMap[I].CostBefore = Cost;
592c965fd94SKirill Naumov     Writer.CostThresholdMap[I].ThresholdBefore = Threshold;
593c965fd94SKirill Naumov   }
594c965fd94SKirill Naumov 
595c965fd94SKirill Naumov   void onInstructionAnalysisFinish(const Instruction *I) override {
596c965fd94SKirill Naumov     // This function is called to find new values of cost and threshold after
597c965fd94SKirill Naumov     // the instruction has been assessed.
598c965fd94SKirill Naumov     if (!PrintDebugInstructionDeltas)
599c965fd94SKirill Naumov         return ;
600c965fd94SKirill Naumov     Writer.CostThresholdMap[I].CostAfter = Cost;
601c965fd94SKirill Naumov     Writer.CostThresholdMap[I].ThresholdAfter = Threshold;
602c965fd94SKirill Naumov   }
603c965fd94SKirill Naumov 
60406408758SMircea Trofin   InlineResult finalizeAnalysis() override {
60506408758SMircea Trofin     // Loops generally act a lot like calls in that they act like barriers to
60606408758SMircea Trofin     // movement, require a certain amount of setup, etc. So when optimising for
60706408758SMircea Trofin     // size, we penalise any call sites that perform loops. We do this after all
60806408758SMircea Trofin     // other costs here, so will likely only be dealing with relatively small
60906408758SMircea Trofin     // functions (and hence DT and LI will hopefully be cheap).
61006408758SMircea Trofin     auto *Caller = CandidateCall.getFunction();
61106408758SMircea Trofin     if (Caller->hasMinSize()) {
61206408758SMircea Trofin       DominatorTree DT(F);
61306408758SMircea Trofin       LoopInfo LI(DT);
61406408758SMircea Trofin       int NumLoops = 0;
61506408758SMircea Trofin       for (Loop *L : LI) {
61606408758SMircea Trofin         // Ignore loops that will not be executed
61706408758SMircea Trofin         if (DeadBlocks.count(L->getHeader()))
61806408758SMircea Trofin           continue;
61906408758SMircea Trofin         NumLoops++;
62006408758SMircea Trofin       }
62106408758SMircea Trofin       addCost(NumLoops * InlineConstants::CallPenalty);
62206408758SMircea Trofin     }
62306408758SMircea Trofin 
62406408758SMircea Trofin     // We applied the maximum possible vector bonus at the beginning. Now,
62506408758SMircea Trofin     // subtract the excess bonus, if any, from the Threshold before
62606408758SMircea Trofin     // comparing against Cost.
62706408758SMircea Trofin     if (NumVectorInstructions <= NumInstructions / 10)
62806408758SMircea Trofin       Threshold -= VectorBonus;
62906408758SMircea Trofin     else if (NumVectorInstructions <= NumInstructions / 2)
63006408758SMircea Trofin       Threshold -= VectorBonus / 2;
63106408758SMircea Trofin 
6325466597fSMircea Trofin     if (Cost < std::max(1, Threshold))
6335466597fSMircea Trofin       return InlineResult::success();
6345466597fSMircea Trofin     return InlineResult::failure("Cost over threshold.");
63506408758SMircea Trofin   }
63606408758SMircea Trofin   bool shouldStop() override {
63706408758SMircea Trofin     // Bail out the moment we cross the threshold. This means we'll under-count
63806408758SMircea Trofin     // the cost, but only when undercounting doesn't matter.
63906408758SMircea Trofin     return Cost >= Threshold && !ComputeFullInlineCost;
64006408758SMircea Trofin   }
64106408758SMircea Trofin 
64206408758SMircea Trofin   void onLoadEliminationOpportunity() override {
64306408758SMircea Trofin     LoadEliminationCost += InlineConstants::InstrCost;
64406408758SMircea Trofin   }
64506408758SMircea Trofin 
64606408758SMircea Trofin   InlineResult onAnalysisStart() override {
64706408758SMircea Trofin     // Perform some tweaks to the cost and threshold based on the direct
64806408758SMircea Trofin     // callsite information.
64906408758SMircea Trofin 
65006408758SMircea Trofin     // We want to more aggressively inline vector-dense kernels, so up the
65106408758SMircea Trofin     // threshold, and we'll lower it if the % of vector instructions gets too
65206408758SMircea Trofin     // low. Note that these bonuses are some what arbitrary and evolved over
65306408758SMircea Trofin     // time by accident as much as because they are principled bonuses.
65406408758SMircea Trofin     //
65506408758SMircea Trofin     // FIXME: It would be nice to remove all such bonuses. At least it would be
65606408758SMircea Trofin     // nice to base the bonus values on something more scientific.
65706408758SMircea Trofin     assert(NumInstructions == 0);
65806408758SMircea Trofin     assert(NumVectorInstructions == 0);
65906408758SMircea Trofin 
66006408758SMircea Trofin     // Update the threshold based on callsite properties
66106408758SMircea Trofin     updateThreshold(CandidateCall, F);
66206408758SMircea Trofin 
66306408758SMircea Trofin     // While Threshold depends on commandline options that can take negative
66406408758SMircea Trofin     // values, we want to enforce the invariant that the computed threshold and
66506408758SMircea Trofin     // bonuses are non-negative.
66606408758SMircea Trofin     assert(Threshold >= 0);
66706408758SMircea Trofin     assert(SingleBBBonus >= 0);
66806408758SMircea Trofin     assert(VectorBonus >= 0);
66906408758SMircea Trofin 
67006408758SMircea Trofin     // Speculatively apply all possible bonuses to Threshold. If cost exceeds
67106408758SMircea Trofin     // this Threshold any time, and cost cannot decrease, we can stop processing
67206408758SMircea Trofin     // the rest of the function body.
67306408758SMircea Trofin     Threshold += (SingleBBBonus + VectorBonus);
67406408758SMircea Trofin 
67506408758SMircea Trofin     // Give out bonuses for the callsite, as the instructions setting them up
67606408758SMircea Trofin     // will be gone after inlining.
67706408758SMircea Trofin     addCost(-getCallsiteCost(this->CandidateCall, DL));
67806408758SMircea Trofin 
67906408758SMircea Trofin     // If this function uses the coldcc calling convention, prefer not to inline
68006408758SMircea Trofin     // it.
68106408758SMircea Trofin     if (F.getCallingConv() == CallingConv::Cold)
68206408758SMircea Trofin       Cost += InlineConstants::ColdccPenalty;
68306408758SMircea Trofin 
68406408758SMircea Trofin     // Check if we're done. This can happen due to bonuses and penalties.
68506408758SMircea Trofin     if (Cost >= Threshold && !ComputeFullInlineCost)
6865466597fSMircea Trofin       return InlineResult::failure("high cost");
68706408758SMircea Trofin 
6885466597fSMircea Trofin     return InlineResult::success();
68906408758SMircea Trofin   }
69006408758SMircea Trofin 
69106408758SMircea Trofin public:
69206408758SMircea Trofin   InlineCostCallAnalyzer(
69306408758SMircea Trofin       const TargetTransformInfo &TTI,
69406408758SMircea Trofin       std::function<AssumptionCache &(Function &)> &GetAssumptionCache,
69506408758SMircea Trofin       Optional<function_ref<BlockFrequencyInfo &(Function &)>> &GetBFI,
69606408758SMircea Trofin       ProfileSummaryInfo *PSI, OptimizationRemarkEmitter *ORE, Function &Callee,
69706408758SMircea Trofin       CallBase &Call, const InlineParams &Params, bool BoostIndirect = true)
69806408758SMircea Trofin       : CallAnalyzer(TTI, GetAssumptionCache, GetBFI, PSI, ORE, Callee, Call),
69906408758SMircea Trofin         ComputeFullInlineCost(OptComputeFullInlineCost ||
70006408758SMircea Trofin                               Params.ComputeFullInlineCost || ORE),
70106408758SMircea Trofin         Params(Params), Threshold(Params.DefaultThreshold),
70206408758SMircea Trofin         BoostIndirectCalls(BoostIndirect) {}
703c965fd94SKirill Naumov 
704c965fd94SKirill Naumov   /// Annotation Writer for cost annotation
705c965fd94SKirill Naumov   CostAnnotationWriter Writer;
706c965fd94SKirill Naumov 
70706408758SMircea Trofin   void dump();
70806408758SMircea Trofin 
70906408758SMircea Trofin   virtual ~InlineCostCallAnalyzer() {}
71006408758SMircea Trofin   int getThreshold() { return Threshold; }
71106408758SMircea Trofin   int getCost() { return Cost; }
71206408758SMircea Trofin };
7137adc3a2bSChandler Carruth } // namespace
7147adc3a2bSChandler Carruth 
7155f8f34e4SAdrian Prantl /// Test whether the given value is an Alloca-derived function argument.
7167adc3a2bSChandler Carruth bool CallAnalyzer::isAllocaDerivedArg(Value *V) {
7177adc3a2bSChandler Carruth   return SROAArgValues.count(V);
7187adc3a2bSChandler Carruth }
7197adc3a2bSChandler Carruth 
72006408758SMircea Trofin void CallAnalyzer::disableSROAForArg(AllocaInst *SROAArg) {
72106408758SMircea Trofin   onDisableSROA(SROAArg);
7222e42cc7aSMircea Trofin   EnabledSROAAllocas.erase(SROAArg);
723338a6016SMircea Trofin   disableLoadElimination();
724338a6016SMircea Trofin }
725c965fd94SKirill Naumov 
726c965fd94SKirill Naumov void CostAnnotationWriter::emitInstructionAnnot(
727c965fd94SKirill Naumov     const Instruction *I, formatted_raw_ostream &OS) {
728c965fd94SKirill Naumov     // The cost of inlining of the given instruction is printed always.
729c965fd94SKirill Naumov     // The threshold delta is printed only when it is non-zero. It happens
730c965fd94SKirill Naumov     // when we decided to give a bonus at a particular instruction.
731b4924f01SMircea Trofin     assert(CostThresholdMap.count(I) > 0 &&
732b4924f01SMircea Trofin            "Expected each instruction to have an instruction annotation");
733b4924f01SMircea Trofin     const auto &Record = CostThresholdMap[I];
734b4924f01SMircea Trofin     OS << "; cost before = " << Record.CostBefore
735b4924f01SMircea Trofin        << ", cost after = " << Record.CostAfter
736b4924f01SMircea Trofin        << ", threshold before = " << Record.ThresholdBefore
737b4924f01SMircea Trofin        << ", threshold after = " << Record.ThresholdAfter << ", ";
738b4924f01SMircea Trofin     OS << "cost delta = " << Record.getCostDelta();
739b4924f01SMircea Trofin     if (Record.hasThresholdChanged())
740b4924f01SMircea Trofin       OS << ", threshold delta = " << Record.getThresholdDelta();
741c965fd94SKirill Naumov     OS << "\n";
742c965fd94SKirill Naumov }
743c965fd94SKirill Naumov 
7445f8f34e4SAdrian Prantl /// If 'V' maps to a SROA candidate, disable SROA for it.
7457adc3a2bSChandler Carruth void CallAnalyzer::disableSROA(Value *V) {
74606408758SMircea Trofin   if (auto *SROAArg = getSROAArgForValueOrNull(V)) {
74706408758SMircea Trofin     disableSROAForArg(SROAArg);
748338a6016SMircea Trofin   }
7497adc3a2bSChandler Carruth }
7507adc3a2bSChandler Carruth 
751a4461515SHaicheng Wu void CallAnalyzer::disableLoadElimination() {
752a4461515SHaicheng Wu   if (EnableLoadElimination) {
75306408758SMircea Trofin     onDisableLoadElimination();
754a4461515SHaicheng Wu     EnableLoadElimination = false;
755a4461515SHaicheng Wu   }
756a4461515SHaicheng Wu }
757a4461515SHaicheng Wu 
7585f8f34e4SAdrian Prantl /// Accumulate a constant GEP offset into an APInt if possible.
7597adc3a2bSChandler Carruth ///
7607adc3a2bSChandler Carruth /// Returns false if unable to compute the offset for any reason. Respects any
7617adc3a2bSChandler Carruth /// simplified values known during the analysis of this callsite.
7627adc3a2bSChandler Carruth bool CallAnalyzer::accumulateGEPOffset(GEPOperator &GEP, APInt &Offset) {
763945b7e5aSElena Demikhovsky   unsigned IntPtrWidth = DL.getIndexTypeSizeInBits(GEP.getType());
7647adc3a2bSChandler Carruth   assert(IntPtrWidth == Offset.getBitWidth());
7657adc3a2bSChandler Carruth 
7667adc3a2bSChandler Carruth   for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
7677adc3a2bSChandler Carruth        GTI != GTE; ++GTI) {
7687adc3a2bSChandler Carruth     ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
7697adc3a2bSChandler Carruth     if (!OpC)
7707adc3a2bSChandler Carruth       if (Constant *SimpleOp = SimplifiedValues.lookup(GTI.getOperand()))
7717adc3a2bSChandler Carruth         OpC = dyn_cast<ConstantInt>(SimpleOp);
7727adc3a2bSChandler Carruth     if (!OpC)
7737adc3a2bSChandler Carruth       return false;
774567556aaSChad Rosier     if (OpC->isZero())
775567556aaSChad Rosier       continue;
7767adc3a2bSChandler Carruth 
7777adc3a2bSChandler Carruth     // Handle a struct index, which adds its field offset to the pointer.
778ab85225bSPeter Collingbourne     if (StructType *STy = GTI.getStructTypeOrNull()) {
7797adc3a2bSChandler Carruth       unsigned ElementIdx = OpC->getZExtValue();
7807adc3a2bSChandler Carruth       const StructLayout *SL = DL.getStructLayout(STy);
7817adc3a2bSChandler Carruth       Offset += APInt(IntPtrWidth, SL->getElementOffset(ElementIdx));
7827adc3a2bSChandler Carruth       continue;
7837adc3a2bSChandler Carruth     }
7847adc3a2bSChandler Carruth 
7857adc3a2bSChandler Carruth     APInt TypeSize(IntPtrWidth, DL.getTypeAllocSize(GTI.getIndexedType()));
7867adc3a2bSChandler Carruth     Offset += OpC->getValue().sextOrTrunc(IntPtrWidth) * TypeSize;
7877adc3a2bSChandler Carruth   }
7887adc3a2bSChandler Carruth   return true;
7897adc3a2bSChandler Carruth }
7907adc3a2bSChandler Carruth 
7915f8f34e4SAdrian Prantl /// Use TTI to check whether a GEP is free.
792201b191bSHaicheng Wu ///
793201b191bSHaicheng Wu /// Respects any simplified values known during the analysis of this callsite.
794201b191bSHaicheng Wu bool CallAnalyzer::isGEPFree(GetElementPtrInst &GEP) {
79561c1bd5aSEvgeny Astigeevich   SmallVector<Value *, 4> Operands;
79661c1bd5aSEvgeny Astigeevich   Operands.push_back(GEP.getOperand(0));
797201b191bSHaicheng Wu   for (User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end(); I != E; ++I)
798201b191bSHaicheng Wu     if (Constant *SimpleOp = SimplifiedValues.lookup(*I))
79961c1bd5aSEvgeny Astigeevich       Operands.push_back(SimpleOp);
800201b191bSHaicheng Wu     else
80161c1bd5aSEvgeny Astigeevich       Operands.push_back(*I);
80261c1bd5aSEvgeny Astigeevich   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&GEP, Operands);
803201b191bSHaicheng Wu }
804201b191bSHaicheng Wu 
8057adc3a2bSChandler Carruth bool CallAnalyzer::visitAlloca(AllocaInst &I) {
8067adc3a2bSChandler Carruth   // Check whether inlining will turn a dynamic alloca into a static
8070f153424SSanjay Patel   // alloca and handle that case.
8087adc3a2bSChandler Carruth   if (I.isArrayAllocation()) {
8090f153424SSanjay Patel     Constant *Size = SimplifiedValues.lookup(I.getArraySize());
8100f153424SSanjay Patel     if (auto *AllocSize = dyn_cast_or_null<ConstantInt>(Size)) {
8117adc3a2bSChandler Carruth       Type *Ty = I.getAllocatedType();
81222eb80a1SEaswaran Raman       AllocatedSize = SaturatingMultiplyAdd(
813b302561bSGraham Hunter           AllocSize->getLimitedValue(), DL.getTypeAllocSize(Ty).getFixedSize(),
814b302561bSGraham Hunter           AllocatedSize);
8157adc3a2bSChandler Carruth       return Base::visitAlloca(I);
8167adc3a2bSChandler Carruth     }
8177adc3a2bSChandler Carruth   }
8187adc3a2bSChandler Carruth 
8197adc3a2bSChandler Carruth   // Accumulate the allocated size.
8207adc3a2bSChandler Carruth   if (I.isStaticAlloca()) {
8217adc3a2bSChandler Carruth     Type *Ty = I.getAllocatedType();
8225a956c85SMircea Trofin     AllocatedSize =
8235a956c85SMircea Trofin         SaturatingAdd(DL.getTypeAllocSize(Ty).getFixedSize(), AllocatedSize);
8247adc3a2bSChandler Carruth   }
8257adc3a2bSChandler Carruth 
8267adc3a2bSChandler Carruth   // We will happily inline static alloca instructions.
8277adc3a2bSChandler Carruth   if (I.isStaticAlloca())
8287adc3a2bSChandler Carruth     return Base::visitAlloca(I);
8297adc3a2bSChandler Carruth 
8307adc3a2bSChandler Carruth   // FIXME: This is overly conservative. Dynamic allocas are inefficient for
8317adc3a2bSChandler Carruth   // a variety of reasons, and so we would like to not inline them into
8327adc3a2bSChandler Carruth   // functions which don't currently have a dynamic alloca. This simply
8337adc3a2bSChandler Carruth   // disables inlining altogether in the presence of a dynamic alloca.
8347adc3a2bSChandler Carruth   HasDynamicAlloca = true;
8357adc3a2bSChandler Carruth   return false;
8367adc3a2bSChandler Carruth }
8377adc3a2bSChandler Carruth 
8387adc3a2bSChandler Carruth bool CallAnalyzer::visitPHI(PHINode &I) {
8397adc3a2bSChandler Carruth   // FIXME: We need to propagate SROA *disabling* through phi nodes, even
8407adc3a2bSChandler Carruth   // though we don't want to propagate it's bonuses. The idea is to disable
8417adc3a2bSChandler Carruth   // SROA if it *might* be used in an inappropriate manner.
8427adc3a2bSChandler Carruth 
8437adc3a2bSChandler Carruth   // Phi nodes are always zero-cost.
84477f32994SBjorn Pettersson   // FIXME: Pointer sizes may differ between different address spaces, so do we
84577f32994SBjorn Pettersson   // need to use correct address space in the call to getPointerSizeInBits here?
84677f32994SBjorn Pettersson   // Or could we skip the getPointerSizeInBits call completely? As far as I can
84777f32994SBjorn Pettersson   // see the ZeroOffset is used as a dummy value, so we can probably use any
84877f32994SBjorn Pettersson   // bit width for the ZeroOffset?
84977f32994SBjorn Pettersson   APInt ZeroOffset = APInt::getNullValue(DL.getPointerSizeInBits(0));
8503739e14aSHaicheng Wu   bool CheckSROA = I.getType()->isPointerTy();
8513739e14aSHaicheng Wu 
8523739e14aSHaicheng Wu   // Track the constant or pointer with constant offset we've seen so far.
8533739e14aSHaicheng Wu   Constant *FirstC = nullptr;
8543739e14aSHaicheng Wu   std::pair<Value *, APInt> FirstBaseAndOffset = {nullptr, ZeroOffset};
8553739e14aSHaicheng Wu   Value *FirstV = nullptr;
8563739e14aSHaicheng Wu 
8573739e14aSHaicheng Wu   for (unsigned i = 0, e = I.getNumIncomingValues(); i != e; ++i) {
8583739e14aSHaicheng Wu     BasicBlock *Pred = I.getIncomingBlock(i);
8593739e14aSHaicheng Wu     // If the incoming block is dead, skip the incoming block.
8603739e14aSHaicheng Wu     if (DeadBlocks.count(Pred))
8613739e14aSHaicheng Wu       continue;
8623739e14aSHaicheng Wu     // If the parent block of phi is not the known successor of the incoming
8633739e14aSHaicheng Wu     // block, skip the incoming block.
8643739e14aSHaicheng Wu     BasicBlock *KnownSuccessor = KnownSuccessors[Pred];
8653739e14aSHaicheng Wu     if (KnownSuccessor && KnownSuccessor != I.getParent())
8663739e14aSHaicheng Wu       continue;
8673739e14aSHaicheng Wu 
8683739e14aSHaicheng Wu     Value *V = I.getIncomingValue(i);
8693739e14aSHaicheng Wu     // If the incoming value is this phi itself, skip the incoming value.
8703739e14aSHaicheng Wu     if (&I == V)
8713739e14aSHaicheng Wu       continue;
8723739e14aSHaicheng Wu 
8733739e14aSHaicheng Wu     Constant *C = dyn_cast<Constant>(V);
8743739e14aSHaicheng Wu     if (!C)
8753739e14aSHaicheng Wu       C = SimplifiedValues.lookup(V);
8763739e14aSHaicheng Wu 
8773739e14aSHaicheng Wu     std::pair<Value *, APInt> BaseAndOffset = {nullptr, ZeroOffset};
8783739e14aSHaicheng Wu     if (!C && CheckSROA)
8793739e14aSHaicheng Wu       BaseAndOffset = ConstantOffsetPtrs.lookup(V);
8803739e14aSHaicheng Wu 
8813739e14aSHaicheng Wu     if (!C && !BaseAndOffset.first)
8823739e14aSHaicheng Wu       // The incoming value is neither a constant nor a pointer with constant
8833739e14aSHaicheng Wu       // offset, exit early.
8843739e14aSHaicheng Wu       return true;
8853739e14aSHaicheng Wu 
8863739e14aSHaicheng Wu     if (FirstC) {
8873739e14aSHaicheng Wu       if (FirstC == C)
8883739e14aSHaicheng Wu         // If we've seen a constant incoming value before and it is the same
8893739e14aSHaicheng Wu         // constant we see this time, continue checking the next incoming value.
8903739e14aSHaicheng Wu         continue;
8913739e14aSHaicheng Wu       // Otherwise early exit because we either see a different constant or saw
8923739e14aSHaicheng Wu       // a constant before but we have a pointer with constant offset this time.
8933739e14aSHaicheng Wu       return true;
8943739e14aSHaicheng Wu     }
8953739e14aSHaicheng Wu 
8963739e14aSHaicheng Wu     if (FirstV) {
8973739e14aSHaicheng Wu       // The same logic as above, but check pointer with constant offset here.
8983739e14aSHaicheng Wu       if (FirstBaseAndOffset == BaseAndOffset)
8993739e14aSHaicheng Wu         continue;
9003739e14aSHaicheng Wu       return true;
9013739e14aSHaicheng Wu     }
9023739e14aSHaicheng Wu 
9033739e14aSHaicheng Wu     if (C) {
9043739e14aSHaicheng Wu       // This is the 1st time we've seen a constant, record it.
9053739e14aSHaicheng Wu       FirstC = C;
9063739e14aSHaicheng Wu       continue;
9073739e14aSHaicheng Wu     }
9083739e14aSHaicheng Wu 
9093739e14aSHaicheng Wu     // The remaining case is that this is the 1st time we've seen a pointer with
9103739e14aSHaicheng Wu     // constant offset, record it.
9113739e14aSHaicheng Wu     FirstV = V;
9123739e14aSHaicheng Wu     FirstBaseAndOffset = BaseAndOffset;
9133739e14aSHaicheng Wu   }
9143739e14aSHaicheng Wu 
9153739e14aSHaicheng Wu   // Check if we can map phi to a constant.
9163739e14aSHaicheng Wu   if (FirstC) {
9173739e14aSHaicheng Wu     SimplifiedValues[&I] = FirstC;
9183739e14aSHaicheng Wu     return true;
9193739e14aSHaicheng Wu   }
9203739e14aSHaicheng Wu 
9213739e14aSHaicheng Wu   // Check if we can map phi to a pointer with constant offset.
9223739e14aSHaicheng Wu   if (FirstBaseAndOffset.first) {
9233739e14aSHaicheng Wu     ConstantOffsetPtrs[&I] = FirstBaseAndOffset;
9243739e14aSHaicheng Wu 
92506408758SMircea Trofin     if (auto *SROAArg = getSROAArgForValueOrNull(FirstV))
9263739e14aSHaicheng Wu       SROAArgValues[&I] = SROAArg;
9273739e14aSHaicheng Wu   }
9283739e14aSHaicheng Wu 
9297adc3a2bSChandler Carruth   return true;
9307adc3a2bSChandler Carruth }
9317adc3a2bSChandler Carruth 
9325f8f34e4SAdrian Prantl /// Check we can fold GEPs of constant-offset call site argument pointers.
933d3558b5dSEvgeny Astigeevich /// This requires target data and inbounds GEPs.
934d3558b5dSEvgeny Astigeevich ///
935d3558b5dSEvgeny Astigeevich /// \return true if the specified GEP can be folded.
936d3558b5dSEvgeny Astigeevich bool CallAnalyzer::canFoldInboundsGEP(GetElementPtrInst &I) {
937d3558b5dSEvgeny Astigeevich   // Check if we have a base + offset for the pointer.
938d3558b5dSEvgeny Astigeevich   std::pair<Value *, APInt> BaseAndOffset =
939d3558b5dSEvgeny Astigeevich       ConstantOffsetPtrs.lookup(I.getPointerOperand());
940d3558b5dSEvgeny Astigeevich   if (!BaseAndOffset.first)
941d3558b5dSEvgeny Astigeevich     return false;
942d3558b5dSEvgeny Astigeevich 
943d3558b5dSEvgeny Astigeevich   // Check if the offset of this GEP is constant, and if so accumulate it
944d3558b5dSEvgeny Astigeevich   // into Offset.
945d3558b5dSEvgeny Astigeevich   if (!accumulateGEPOffset(cast<GEPOperator>(I), BaseAndOffset.second))
946d3558b5dSEvgeny Astigeevich     return false;
947d3558b5dSEvgeny Astigeevich 
948d3558b5dSEvgeny Astigeevich   // Add the result as a new mapping to Base + Offset.
949d3558b5dSEvgeny Astigeevich   ConstantOffsetPtrs[&I] = BaseAndOffset;
950d3558b5dSEvgeny Astigeevich 
951d3558b5dSEvgeny Astigeevich   return true;
952d3558b5dSEvgeny Astigeevich }
953d3558b5dSEvgeny Astigeevich 
9547adc3a2bSChandler Carruth bool CallAnalyzer::visitGetElementPtr(GetElementPtrInst &I) {
95506408758SMircea Trofin   auto *SROAArg = getSROAArgForValueOrNull(I.getPointerOperand());
9567adc3a2bSChandler Carruth 
957a8b9cdc9SEaswaran Raman   // Lambda to check whether a GEP's indices are all constant.
958a8b9cdc9SEaswaran Raman   auto IsGEPOffsetConstant = [&](GetElementPtrInst &GEP) {
959a8b9cdc9SEaswaran Raman     for (User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end(); I != E; ++I)
960a8b9cdc9SEaswaran Raman       if (!isa<Constant>(*I) && !SimplifiedValues.lookup(*I))
961a8b9cdc9SEaswaran Raman         return false;
962a8b9cdc9SEaswaran Raman     return true;
963a8b9cdc9SEaswaran Raman   };
964a8b9cdc9SEaswaran Raman 
965d3558b5dSEvgeny Astigeevich   if ((I.isInBounds() && canFoldInboundsGEP(I)) || IsGEPOffsetConstant(I)) {
96606408758SMircea Trofin     if (SROAArg)
9677adc3a2bSChandler Carruth       SROAArgValues[&I] = SROAArg;
9687adc3a2bSChandler Carruth 
9697adc3a2bSChandler Carruth     // Constant GEPs are modeled as free.
9707adc3a2bSChandler Carruth     return true;
9717adc3a2bSChandler Carruth   }
9727adc3a2bSChandler Carruth 
9737adc3a2bSChandler Carruth   // Variable GEPs will require math and will disable SROA.
97406408758SMircea Trofin   if (SROAArg)
97506408758SMircea Trofin     disableSROAForArg(SROAArg);
976201b191bSHaicheng Wu   return isGEPFree(I);
9777adc3a2bSChandler Carruth }
9787adc3a2bSChandler Carruth 
979617f6364SEaswaran Raman /// Simplify \p I if its operands are constants and update SimplifiedValues.
980617f6364SEaswaran Raman /// \p Evaluate is a callable specific to instruction type that evaluates the
981617f6364SEaswaran Raman /// instruction when all the operands are constants.
982617f6364SEaswaran Raman template <typename Callable>
983617f6364SEaswaran Raman bool CallAnalyzer::simplifyInstruction(Instruction &I, Callable Evaluate) {
984617f6364SEaswaran Raman   SmallVector<Constant *, 2> COps;
985617f6364SEaswaran Raman   for (Value *Op : I.operands()) {
986617f6364SEaswaran Raman     Constant *COp = dyn_cast<Constant>(Op);
9877adc3a2bSChandler Carruth     if (!COp)
988617f6364SEaswaran Raman       COp = SimplifiedValues.lookup(Op);
989617f6364SEaswaran Raman     if (!COp)
990617f6364SEaswaran Raman       return false;
991617f6364SEaswaran Raman     COps.push_back(COp);
992617f6364SEaswaran Raman   }
993617f6364SEaswaran Raman   auto *C = Evaluate(COps);
994617f6364SEaswaran Raman   if (!C)
995617f6364SEaswaran Raman     return false;
9967adc3a2bSChandler Carruth   SimplifiedValues[&I] = C;
9977adc3a2bSChandler Carruth   return true;
9987adc3a2bSChandler Carruth }
9997adc3a2bSChandler Carruth 
1000617f6364SEaswaran Raman bool CallAnalyzer::visitBitCast(BitCastInst &I) {
1001617f6364SEaswaran Raman   // Propagate constants through bitcasts.
1002617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1003617f6364SEaswaran Raman         return ConstantExpr::getBitCast(COps[0], I.getType());
1004617f6364SEaswaran Raman       }))
1005617f6364SEaswaran Raman     return true;
1006617f6364SEaswaran Raman 
10077adc3a2bSChandler Carruth   // Track base/offsets through casts
1008567556aaSChad Rosier   std::pair<Value *, APInt> BaseAndOffset =
1009567556aaSChad Rosier       ConstantOffsetPtrs.lookup(I.getOperand(0));
10107adc3a2bSChandler Carruth   // Casts don't change the offset, just wrap it up.
10117adc3a2bSChandler Carruth   if (BaseAndOffset.first)
10127adc3a2bSChandler Carruth     ConstantOffsetPtrs[&I] = BaseAndOffset;
10137adc3a2bSChandler Carruth 
10147adc3a2bSChandler Carruth   // Also look for SROA candidates here.
101506408758SMircea Trofin   if (auto *SROAArg = getSROAArgForValueOrNull(I.getOperand(0)))
10167adc3a2bSChandler Carruth     SROAArgValues[&I] = SROAArg;
10177adc3a2bSChandler Carruth 
10187adc3a2bSChandler Carruth   // Bitcasts are always zero cost.
10197adc3a2bSChandler Carruth   return true;
10207adc3a2bSChandler Carruth }
10217adc3a2bSChandler Carruth 
10227adc3a2bSChandler Carruth bool CallAnalyzer::visitPtrToInt(PtrToIntInst &I) {
10237adc3a2bSChandler Carruth   // Propagate constants through ptrtoint.
1024617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1025617f6364SEaswaran Raman         return ConstantExpr::getPtrToInt(COps[0], I.getType());
1026617f6364SEaswaran Raman       }))
10277adc3a2bSChandler Carruth     return true;
10287adc3a2bSChandler Carruth 
10297adc3a2bSChandler Carruth   // Track base/offset pairs when converted to a plain integer provided the
10307adc3a2bSChandler Carruth   // integer is large enough to represent the pointer.
10317adc3a2bSChandler Carruth   unsigned IntegerSize = I.getType()->getScalarSizeInBits();
103277f32994SBjorn Pettersson   unsigned AS = I.getOperand(0)->getType()->getPointerAddressSpace();
103377f32994SBjorn Pettersson   if (IntegerSize >= DL.getPointerSizeInBits(AS)) {
1034567556aaSChad Rosier     std::pair<Value *, APInt> BaseAndOffset =
1035567556aaSChad Rosier         ConstantOffsetPtrs.lookup(I.getOperand(0));
10367adc3a2bSChandler Carruth     if (BaseAndOffset.first)
10377adc3a2bSChandler Carruth       ConstantOffsetPtrs[&I] = BaseAndOffset;
10387adc3a2bSChandler Carruth   }
10397adc3a2bSChandler Carruth 
10407adc3a2bSChandler Carruth   // This is really weird. Technically, ptrtoint will disable SROA. However,
10417adc3a2bSChandler Carruth   // unless that ptrtoint is *used* somewhere in the live basic blocks after
10427adc3a2bSChandler Carruth   // inlining, it will be nuked, and SROA should proceed. All of the uses which
10437adc3a2bSChandler Carruth   // would block SROA would also block SROA if applied directly to a pointer,
10447adc3a2bSChandler Carruth   // and so we can just add the integer in here. The only places where SROA is
10457adc3a2bSChandler Carruth   // preserved either cannot fire on an integer, or won't in-and-of themselves
10467adc3a2bSChandler Carruth   // disable SROA (ext) w/o some later use that we would see and disable.
104706408758SMircea Trofin   if (auto *SROAArg = getSROAArgForValueOrNull(I.getOperand(0)))
10487adc3a2bSChandler Carruth     SROAArgValues[&I] = SROAArg;
10497adc3a2bSChandler Carruth 
10507adc3a2bSChandler Carruth   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
10517adc3a2bSChandler Carruth }
10527adc3a2bSChandler Carruth 
10537adc3a2bSChandler Carruth bool CallAnalyzer::visitIntToPtr(IntToPtrInst &I) {
10547adc3a2bSChandler Carruth   // Propagate constants through ptrtoint.
1055617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1056617f6364SEaswaran Raman         return ConstantExpr::getIntToPtr(COps[0], I.getType());
1057617f6364SEaswaran Raman       }))
10587adc3a2bSChandler Carruth     return true;
10597adc3a2bSChandler Carruth 
10607adc3a2bSChandler Carruth   // Track base/offset pairs when round-tripped through a pointer without
10617adc3a2bSChandler Carruth   // modifications provided the integer is not too large.
10627adc3a2bSChandler Carruth   Value *Op = I.getOperand(0);
10637adc3a2bSChandler Carruth   unsigned IntegerSize = Op->getType()->getScalarSizeInBits();
106477f32994SBjorn Pettersson   if (IntegerSize <= DL.getPointerTypeSizeInBits(I.getType())) {
10657adc3a2bSChandler Carruth     std::pair<Value *, APInt> BaseAndOffset = ConstantOffsetPtrs.lookup(Op);
10667adc3a2bSChandler Carruth     if (BaseAndOffset.first)
10677adc3a2bSChandler Carruth       ConstantOffsetPtrs[&I] = BaseAndOffset;
10687adc3a2bSChandler Carruth   }
10697adc3a2bSChandler Carruth 
10707adc3a2bSChandler Carruth   // "Propagate" SROA here in the same manner as we do for ptrtoint above.
107106408758SMircea Trofin   if (auto *SROAArg = getSROAArgForValueOrNull(Op))
10727adc3a2bSChandler Carruth     SROAArgValues[&I] = SROAArg;
10737adc3a2bSChandler Carruth 
10747adc3a2bSChandler Carruth   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
10757adc3a2bSChandler Carruth }
10767adc3a2bSChandler Carruth 
10777adc3a2bSChandler Carruth bool CallAnalyzer::visitCastInst(CastInst &I) {
1078ab53c5e5SCraig Topper   // Propagate constants through casts.
1079617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1080617f6364SEaswaran Raman         return ConstantExpr::getCast(I.getOpcode(), COps[0], I.getType());
1081617f6364SEaswaran Raman       }))
10827adc3a2bSChandler Carruth     return true;
10837adc3a2bSChandler Carruth 
10847adc3a2bSChandler Carruth   // Disable SROA in the face of arbitrary casts we don't whitelist elsewhere.
10857adc3a2bSChandler Carruth   disableSROA(I.getOperand(0));
10867adc3a2bSChandler Carruth 
108739ed9a60SEli Friedman   // If this is a floating-point cast, and the target says this operation
108839ed9a60SEli Friedman   // is expensive, this may eventually become a library call. Treat the cost
108939ed9a60SEli Friedman   // as such.
109039ed9a60SEli Friedman   switch (I.getOpcode()) {
109139ed9a60SEli Friedman   case Instruction::FPTrunc:
109239ed9a60SEli Friedman   case Instruction::FPExt:
109339ed9a60SEli Friedman   case Instruction::UIToFP:
109439ed9a60SEli Friedman   case Instruction::SIToFP:
109539ed9a60SEli Friedman   case Instruction::FPToUI:
109639ed9a60SEli Friedman   case Instruction::FPToSI:
109739ed9a60SEli Friedman     if (TTI.getFPOpCost(I.getType()) == TargetTransformInfo::TCC_Expensive)
109806408758SMircea Trofin       onCallPenalty();
10994dc0b1acSReid Kleckner     break;
110039ed9a60SEli Friedman   default:
110139ed9a60SEli Friedman     break;
110239ed9a60SEli Friedman   }
110339ed9a60SEli Friedman 
11047adc3a2bSChandler Carruth   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
11057adc3a2bSChandler Carruth }
11067adc3a2bSChandler Carruth 
11077adc3a2bSChandler Carruth bool CallAnalyzer::visitUnaryInstruction(UnaryInstruction &I) {
11087adc3a2bSChandler Carruth   Value *Operand = I.getOperand(0);
1109617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1110617f6364SEaswaran Raman         return ConstantFoldInstOperands(&I, COps[0], DL);
1111617f6364SEaswaran Raman       }))
11127adc3a2bSChandler Carruth     return true;
11137adc3a2bSChandler Carruth 
1114ab53c5e5SCraig Topper   // Disable any SROA on the argument to arbitrary unary instructions.
11157adc3a2bSChandler Carruth   disableSROA(Operand);
11167adc3a2bSChandler Carruth 
11177adc3a2bSChandler Carruth   return false;
11187adc3a2bSChandler Carruth }
11197adc3a2bSChandler Carruth 
11207adc3a2bSChandler Carruth bool CallAnalyzer::paramHasAttr(Argument *A, Attribute::AttrKind Attr) {
1121652168a9SFedor Sergeev   return CandidateCall.paramHasAttr(A->getArgNo(), Attr);
11227adc3a2bSChandler Carruth }
11237adc3a2bSChandler Carruth 
11247adc3a2bSChandler Carruth bool CallAnalyzer::isKnownNonNullInCallee(Value *V) {
11257adc3a2bSChandler Carruth   // Does the *call site* have the NonNull attribute set on an argument?  We
11267adc3a2bSChandler Carruth   // use the attribute on the call site to memoize any analysis done in the
11277adc3a2bSChandler Carruth   // caller. This will also trip if the callee function has a non-null
11287adc3a2bSChandler Carruth   // parameter attribute, but that's a less interesting case because hopefully
11297adc3a2bSChandler Carruth   // the callee would already have been simplified based on that.
11307adc3a2bSChandler Carruth   if (Argument *A = dyn_cast<Argument>(V))
11317adc3a2bSChandler Carruth     if (paramHasAttr(A, Attribute::NonNull))
11327adc3a2bSChandler Carruth       return true;
11337adc3a2bSChandler Carruth 
11347adc3a2bSChandler Carruth   // Is this an alloca in the caller?  This is distinct from the attribute case
11357adc3a2bSChandler Carruth   // above because attributes aren't updated within the inliner itself and we
11367adc3a2bSChandler Carruth   // always want to catch the alloca derived case.
11377adc3a2bSChandler Carruth   if (isAllocaDerivedArg(V))
11387adc3a2bSChandler Carruth     // We can actually predict the result of comparisons between an
11397adc3a2bSChandler Carruth     // alloca-derived value and null. Note that this fires regardless of
11407adc3a2bSChandler Carruth     // SROA firing.
11417adc3a2bSChandler Carruth     return true;
11427adc3a2bSChandler Carruth 
11437adc3a2bSChandler Carruth   return false;
11447adc3a2bSChandler Carruth }
11457adc3a2bSChandler Carruth 
1146652168a9SFedor Sergeev bool CallAnalyzer::allowSizeGrowth(CallBase &Call) {
11479a3fc17aSEaswaran Raman   // If the normal destination of the invoke or the parent block of the call
11489a3fc17aSEaswaran Raman   // site is unreachable-terminated, there is little point in inlining this
11499a3fc17aSEaswaran Raman   // unless there is literally zero cost.
11509a3fc17aSEaswaran Raman   // FIXME: Note that it is possible that an unreachable-terminated block has a
11519a3fc17aSEaswaran Raman   // hot entry. For example, in below scenario inlining hot_call_X() may be
11529a3fc17aSEaswaran Raman   // beneficial :
11539a3fc17aSEaswaran Raman   // main() {
11549a3fc17aSEaswaran Raman   //   hot_call_1();
11559a3fc17aSEaswaran Raman   //   ...
11569a3fc17aSEaswaran Raman   //   hot_call_N()
11579a3fc17aSEaswaran Raman   //   exit(0);
11589a3fc17aSEaswaran Raman   // }
11599a3fc17aSEaswaran Raman   // For now, we are not handling this corner case here as it is rare in real
11609a3fc17aSEaswaran Raman   // code. In future, we should elaborate this based on BPI and BFI in more
11619a3fc17aSEaswaran Raman   // general threshold adjusting heuristics in updateThreshold().
1162652168a9SFedor Sergeev   if (InvokeInst *II = dyn_cast<InvokeInst>(&Call)) {
11639a3fc17aSEaswaran Raman     if (isa<UnreachableInst>(II->getNormalDest()->getTerminator()))
11649a3fc17aSEaswaran Raman       return false;
1165652168a9SFedor Sergeev   } else if (isa<UnreachableInst>(Call.getParent()->getTerminator()))
11669a3fc17aSEaswaran Raman     return false;
11679a3fc17aSEaswaran Raman 
11689a3fc17aSEaswaran Raman   return true;
11699a3fc17aSEaswaran Raman }
11709a3fc17aSEaswaran Raman 
117106408758SMircea Trofin bool InlineCostCallAnalyzer::isColdCallSite(CallBase &Call,
1172652168a9SFedor Sergeev                                             BlockFrequencyInfo *CallerBFI) {
1173c5fa6358SEaswaran Raman   // If global profile summary is available, then callsite's coldness is
1174c5fa6358SEaswaran Raman   // determined based on that.
1175bba762a1SChandler Carruth   if (PSI && PSI->hasProfileSummary())
1176ec73ae11SMircea Trofin     return PSI->isColdCallSite(Call, CallerBFI);
1177bba762a1SChandler Carruth 
1178bba762a1SChandler Carruth   // Otherwise we need BFI to be available.
1179c5fa6358SEaswaran Raman   if (!CallerBFI)
1180c5fa6358SEaswaran Raman     return false;
1181c5fa6358SEaswaran Raman 
1182bba762a1SChandler Carruth   // Determine if the callsite is cold relative to caller's entry. We could
1183bba762a1SChandler Carruth   // potentially cache the computation of scaled entry frequency, but the added
1184bba762a1SChandler Carruth   // complexity is not worth it unless this scaling shows up high in the
1185bba762a1SChandler Carruth   // profiles.
1186c5fa6358SEaswaran Raman   const BranchProbability ColdProb(ColdCallSiteRelFreq, 100);
1187652168a9SFedor Sergeev   auto CallSiteBB = Call.getParent();
1188c5fa6358SEaswaran Raman   auto CallSiteFreq = CallerBFI->getBlockFreq(CallSiteBB);
1189c5fa6358SEaswaran Raman   auto CallerEntryFreq =
1190652168a9SFedor Sergeev       CallerBFI->getBlockFreq(&(Call.getCaller()->getEntryBlock()));
1191c5fa6358SEaswaran Raman   return CallSiteFreq < CallerEntryFreq * ColdProb;
1192c5fa6358SEaswaran Raman }
1193c5fa6358SEaswaran Raman 
1194974d4eeaSEaswaran Raman Optional<int>
119506408758SMircea Trofin InlineCostCallAnalyzer::getHotCallSiteThreshold(CallBase &Call,
1196974d4eeaSEaswaran Raman                                                 BlockFrequencyInfo *CallerBFI) {
1197bba762a1SChandler Carruth 
1198974d4eeaSEaswaran Raman   // If global profile summary is available, then callsite's hotness is
1199974d4eeaSEaswaran Raman   // determined based on that.
1200ec73ae11SMircea Trofin   if (PSI && PSI->hasProfileSummary() && PSI->isHotCallSite(Call, CallerBFI))
1201bba762a1SChandler Carruth     return Params.HotCallSiteThreshold;
1202974d4eeaSEaswaran Raman 
1203bba762a1SChandler Carruth   // Otherwise we need BFI to be available and to have a locally hot callsite
1204bba762a1SChandler Carruth   // threshold.
1205bba762a1SChandler Carruth   if (!CallerBFI || !Params.LocallyHotCallSiteThreshold)
1206974d4eeaSEaswaran Raman     return None;
1207974d4eeaSEaswaran Raman 
1208bba762a1SChandler Carruth   // Determine if the callsite is hot relative to caller's entry. We could
1209bba762a1SChandler Carruth   // potentially cache the computation of scaled entry frequency, but the added
1210bba762a1SChandler Carruth   // complexity is not worth it unless this scaling shows up high in the
1211bba762a1SChandler Carruth   // profiles.
1212652168a9SFedor Sergeev   auto CallSiteBB = Call.getParent();
1213974d4eeaSEaswaran Raman   auto CallSiteFreq = CallerBFI->getBlockFreq(CallSiteBB).getFrequency();
1214974d4eeaSEaswaran Raman   auto CallerEntryFreq = CallerBFI->getEntryFreq();
1215974d4eeaSEaswaran Raman   if (CallSiteFreq >= CallerEntryFreq * HotCallSiteRelFreq)
1216bba762a1SChandler Carruth     return Params.LocallyHotCallSiteThreshold;
1217bba762a1SChandler Carruth 
1218bba762a1SChandler Carruth   // Otherwise treat it normally.
1219974d4eeaSEaswaran Raman   return None;
1220974d4eeaSEaswaran Raman }
1221974d4eeaSEaswaran Raman 
122206408758SMircea Trofin void InlineCostCallAnalyzer::updateThreshold(CallBase &Call, Function &Callee) {
12239a3fc17aSEaswaran Raman   // If no size growth is allowed for this inlining, set Threshold to 0.
1224652168a9SFedor Sergeev   if (!allowSizeGrowth(Call)) {
12259a3fc17aSEaswaran Raman     Threshold = 0;
12269a3fc17aSEaswaran Raman     return;
12279a3fc17aSEaswaran Raman   }
12289a3fc17aSEaswaran Raman 
1229652168a9SFedor Sergeev   Function *Caller = Call.getCaller();
12301c57cc2bSEaswaran Raman 
12311c57cc2bSEaswaran Raman   // return min(A, B) if B is valid.
12321c57cc2bSEaswaran Raman   auto MinIfValid = [](int A, Optional<int> B) {
12331c57cc2bSEaswaran Raman     return B ? std::min(A, B.getValue()) : A;
12341c57cc2bSEaswaran Raman   };
12351c57cc2bSEaswaran Raman 
12360d58fcacSEaswaran Raman   // return max(A, B) if B is valid.
12370d58fcacSEaswaran Raman   auto MaxIfValid = [](int A, Optional<int> B) {
12380d58fcacSEaswaran Raman     return B ? std::max(A, B.getValue()) : A;
12390d58fcacSEaswaran Raman   };
12400d58fcacSEaswaran Raman 
124151b809bfSEaswaran Raman   // Various bonus percentages. These are multiplied by Threshold to get the
124251b809bfSEaswaran Raman   // bonus values.
124351b809bfSEaswaran Raman   // SingleBBBonus: This bonus is applied if the callee has a single reachable
124451b809bfSEaswaran Raman   // basic block at the given callsite context. This is speculatively applied
124551b809bfSEaswaran Raman   // and withdrawn if more than one basic block is seen.
124651b809bfSEaswaran Raman   //
124751b809bfSEaswaran Raman   // LstCallToStaticBonus: This large bonus is applied to ensure the inlining
124851b809bfSEaswaran Raman   // of the last call to a static function as inlining such functions is
124951b809bfSEaswaran Raman   // guaranteed to reduce code size.
125051b809bfSEaswaran Raman   //
125151b809bfSEaswaran Raman   // These bonus percentages may be set to 0 based on properties of the caller
125251b809bfSEaswaran Raman   // and the callsite.
125351b809bfSEaswaran Raman   int SingleBBBonusPercent = 50;
1254d912a9baSDaniil Fukalov   int VectorBonusPercent = TTI.getInlinerVectorBonusPercent();
125502647f73SJordan Rupprecht   int LastCallToStaticBonus = InlineConstants::LastCallToStaticBonus;
125651b809bfSEaswaran Raman 
125751b809bfSEaswaran Raman   // Lambda to set all the above bonus and bonus percentages to 0.
125851b809bfSEaswaran Raman   auto DisallowAllBonuses = [&]() {
125951b809bfSEaswaran Raman     SingleBBBonusPercent = 0;
126051b809bfSEaswaran Raman     VectorBonusPercent = 0;
126151b809bfSEaswaran Raman     LastCallToStaticBonus = 0;
126251b809bfSEaswaran Raman   };
126351b809bfSEaswaran Raman 
12641c57cc2bSEaswaran Raman   // Use the OptMinSizeThreshold or OptSizeThreshold knob if they are available
12651c57cc2bSEaswaran Raman   // and reduce the threshold if the caller has the necessary attribute.
126685bd3978SEvandro Menezes   if (Caller->hasMinSize()) {
12671c57cc2bSEaswaran Raman     Threshold = MinIfValid(Threshold, Params.OptMinSizeThreshold);
126851b809bfSEaswaran Raman     // For minsize, we want to disable the single BB bonus and the vector
126951b809bfSEaswaran Raman     // bonuses, but not the last-call-to-static bonus. Inlining the last call to
127051b809bfSEaswaran Raman     // a static function will, at the minimum, eliminate the parameter setup and
127151b809bfSEaswaran Raman     // call/return instructions.
127251b809bfSEaswaran Raman     SingleBBBonusPercent = 0;
127351b809bfSEaswaran Raman     VectorBonusPercent = 0;
127485bd3978SEvandro Menezes   } else if (Caller->hasOptSize())
12751c57cc2bSEaswaran Raman     Threshold = MinIfValid(Threshold, Params.OptSizeThreshold);
1276f4bb2f0dSEaswaran Raman 
1277e08b139dSEaswaran Raman   // Adjust the threshold based on inlinehint attribute and profile based
1278e08b139dSEaswaran Raman   // hotness information if the caller does not have MinSize attribute.
127985bd3978SEvandro Menezes   if (!Caller->hasMinSize()) {
1280e08b139dSEaswaran Raman     if (Callee.hasFnAttribute(Attribute::InlineHint))
12810d58fcacSEaswaran Raman       Threshold = MaxIfValid(Threshold, Params.HintThreshold);
1282bba762a1SChandler Carruth 
12833cd1479cSEaswaran Raman     // FIXME: After switching to the new passmanager, simplify the logic below
1284bba762a1SChandler Carruth     // by checking only the callsite hotness/coldness as we will reliably
1285bba762a1SChandler Carruth     // have local profile information.
12863cd1479cSEaswaran Raman     //
1287bba762a1SChandler Carruth     // Callsite hotness and coldness can be determined if sample profile is
1288bba762a1SChandler Carruth     // used (which adds hotness metadata to calls) or if caller's
1289bba762a1SChandler Carruth     // BlockFrequencyInfo is available.
1290bba762a1SChandler Carruth     BlockFrequencyInfo *CallerBFI = GetBFI ? &((*GetBFI)(*Caller)) : nullptr;
1291652168a9SFedor Sergeev     auto HotCallSiteThreshold = getHotCallSiteThreshold(Call, CallerBFI);
129285bd3978SEvandro Menezes     if (!Caller->hasOptSize() && HotCallSiteThreshold) {
1293d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "Hot callsite.\n");
1294974d4eeaSEaswaran Raman       // FIXME: This should update the threshold only if it exceeds the
1295974d4eeaSEaswaran Raman       // current threshold, but AutoFDO + ThinLTO currently relies on this
1296974d4eeaSEaswaran Raman       // behavior to prevent inlining of hot callsites during ThinLTO
1297974d4eeaSEaswaran Raman       // compile phase.
1298974d4eeaSEaswaran Raman       Threshold = HotCallSiteThreshold.getValue();
1299652168a9SFedor Sergeev     } else if (isColdCallSite(Call, CallerBFI)) {
1300d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "Cold callsite.\n");
130151b809bfSEaswaran Raman       // Do not apply bonuses for a cold callsite including the
130251b809bfSEaswaran Raman       // LastCallToStatic bonus. While this bonus might result in code size
130351b809bfSEaswaran Raman       // reduction, it can cause the size of a non-cold caller to increase
130451b809bfSEaswaran Raman       // preventing it from being inlined.
130551b809bfSEaswaran Raman       DisallowAllBonuses();
13063cd1479cSEaswaran Raman       Threshold = MinIfValid(Threshold, Params.ColdCallSiteThreshold);
1307bba762a1SChandler Carruth     } else if (PSI) {
1308bba762a1SChandler Carruth       // Use callee's global profile information only if we have no way of
1309bba762a1SChandler Carruth       // determining this via callsite information.
13103cd1479cSEaswaran Raman       if (PSI->isFunctionEntryHot(&Callee)) {
1311d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "Hot callee.\n");
1312e08b139dSEaswaran Raman         // If callsite hotness can not be determined, we may still know
1313e08b139dSEaswaran Raman         // that the callee is hot and treat it as a weaker hint for threshold
1314e08b139dSEaswaran Raman         // increase.
1315e08b139dSEaswaran Raman         Threshold = MaxIfValid(Threshold, Params.HintThreshold);
1316e08b139dSEaswaran Raman       } else if (PSI->isFunctionEntryCold(&Callee)) {
1317d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "Cold callee.\n");
131851b809bfSEaswaran Raman         // Do not apply bonuses for a cold callee including the
131951b809bfSEaswaran Raman         // LastCallToStatic bonus. While this bonus might result in code size
132051b809bfSEaswaran Raman         // reduction, it can cause the size of a non-cold caller to increase
132151b809bfSEaswaran Raman         // preventing it from being inlined.
132251b809bfSEaswaran Raman         DisallowAllBonuses();
13231c57cc2bSEaswaran Raman         Threshold = MinIfValid(Threshold, Params.ColdThreshold);
1324e08b139dSEaswaran Raman       }
1325e08b139dSEaswaran Raman     }
1326e08b139dSEaswaran Raman   }
13278650a4daSJustin Lebar 
132802647f73SJordan Rupprecht   // Finally, take the target-specific inlining threshold multiplier into
132902647f73SJordan Rupprecht   // account.
13308650a4daSJustin Lebar   Threshold *= TTI.getInliningThresholdMultiplier();
133151b809bfSEaswaran Raman 
133251b809bfSEaswaran Raman   SingleBBBonus = Threshold * SingleBBBonusPercent / 100;
133351b809bfSEaswaran Raman   VectorBonus = Threshold * VectorBonusPercent / 100;
133451b809bfSEaswaran Raman 
133502647f73SJordan Rupprecht   bool OnlyOneCallAndLocalLinkage =
133602647f73SJordan Rupprecht       F.hasLocalLinkage() && F.hasOneUse() && &F == Call.getCalledFunction();
133702647f73SJordan Rupprecht   // If there is only one call of the function, and it has internal linkage,
133802647f73SJordan Rupprecht   // the cost of inlining it drops dramatically. It may seem odd to update
133902647f73SJordan Rupprecht   // Cost in updateThreshold, but the bonus depends on the logic in this method.
134002647f73SJordan Rupprecht   if (OnlyOneCallAndLocalLinkage)
134102647f73SJordan Rupprecht     Cost -= LastCallToStaticBonus;
1342f4bb2f0dSEaswaran Raman }
1343f4bb2f0dSEaswaran Raman 
13447adc3a2bSChandler Carruth bool CallAnalyzer::visitCmpInst(CmpInst &I) {
13457adc3a2bSChandler Carruth   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
13467adc3a2bSChandler Carruth   // First try to handle simplified comparisons.
1347617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1348617f6364SEaswaran Raman         return ConstantExpr::getCompare(I.getPredicate(), COps[0], COps[1]);
1349617f6364SEaswaran Raman       }))
13507adc3a2bSChandler Carruth     return true;
13517adc3a2bSChandler Carruth 
13527adc3a2bSChandler Carruth   if (I.getOpcode() == Instruction::FCmp)
13537adc3a2bSChandler Carruth     return false;
13547adc3a2bSChandler Carruth 
13557adc3a2bSChandler Carruth   // Otherwise look for a comparison between constant offset pointers with
13567adc3a2bSChandler Carruth   // a common base.
13577adc3a2bSChandler Carruth   Value *LHSBase, *RHSBase;
13587adc3a2bSChandler Carruth   APInt LHSOffset, RHSOffset;
13597adc3a2bSChandler Carruth   std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS);
13607adc3a2bSChandler Carruth   if (LHSBase) {
13617adc3a2bSChandler Carruth     std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS);
13627adc3a2bSChandler Carruth     if (RHSBase && LHSBase == RHSBase) {
13637adc3a2bSChandler Carruth       // We have common bases, fold the icmp to a constant based on the
13647adc3a2bSChandler Carruth       // offsets.
13657adc3a2bSChandler Carruth       Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset);
13667adc3a2bSChandler Carruth       Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset);
13677adc3a2bSChandler Carruth       if (Constant *C = ConstantExpr::getICmp(I.getPredicate(), CLHS, CRHS)) {
13687adc3a2bSChandler Carruth         SimplifiedValues[&I] = C;
13697adc3a2bSChandler Carruth         ++NumConstantPtrCmps;
13707adc3a2bSChandler Carruth         return true;
13717adc3a2bSChandler Carruth       }
13727adc3a2bSChandler Carruth     }
13737adc3a2bSChandler Carruth   }
13747adc3a2bSChandler Carruth 
13757adc3a2bSChandler Carruth   // If the comparison is an equality comparison with null, we can simplify it
13767adc3a2bSChandler Carruth   // if we know the value (argument) can't be null
13777adc3a2bSChandler Carruth   if (I.isEquality() && isa<ConstantPointerNull>(I.getOperand(1)) &&
13787adc3a2bSChandler Carruth       isKnownNonNullInCallee(I.getOperand(0))) {
13797adc3a2bSChandler Carruth     bool IsNotEqual = I.getPredicate() == CmpInst::ICMP_NE;
13807adc3a2bSChandler Carruth     SimplifiedValues[&I] = IsNotEqual ? ConstantInt::getTrue(I.getType())
13817adc3a2bSChandler Carruth                                       : ConstantInt::getFalse(I.getType());
13827adc3a2bSChandler Carruth     return true;
13837adc3a2bSChandler Carruth   }
138406408758SMircea Trofin   return handleSROA(I.getOperand(0), isa<ConstantPointerNull>(I.getOperand(1)));
13857adc3a2bSChandler Carruth }
13867adc3a2bSChandler Carruth 
13877adc3a2bSChandler Carruth bool CallAnalyzer::visitSub(BinaryOperator &I) {
13887adc3a2bSChandler Carruth   // Try to handle a special case: we can fold computing the difference of two
13897adc3a2bSChandler Carruth   // constant-related pointers.
13907adc3a2bSChandler Carruth   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
13917adc3a2bSChandler Carruth   Value *LHSBase, *RHSBase;
13927adc3a2bSChandler Carruth   APInt LHSOffset, RHSOffset;
13937adc3a2bSChandler Carruth   std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS);
13947adc3a2bSChandler Carruth   if (LHSBase) {
13957adc3a2bSChandler Carruth     std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS);
13967adc3a2bSChandler Carruth     if (RHSBase && LHSBase == RHSBase) {
13977adc3a2bSChandler Carruth       // We have common bases, fold the subtract to a constant based on the
13987adc3a2bSChandler Carruth       // offsets.
13997adc3a2bSChandler Carruth       Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset);
14007adc3a2bSChandler Carruth       Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset);
14017adc3a2bSChandler Carruth       if (Constant *C = ConstantExpr::getSub(CLHS, CRHS)) {
14027adc3a2bSChandler Carruth         SimplifiedValues[&I] = C;
14037adc3a2bSChandler Carruth         ++NumConstantPtrDiffs;
14047adc3a2bSChandler Carruth         return true;
14057adc3a2bSChandler Carruth       }
14067adc3a2bSChandler Carruth     }
14077adc3a2bSChandler Carruth   }
14087adc3a2bSChandler Carruth 
14097adc3a2bSChandler Carruth   // Otherwise, fall back to the generic logic for simplifying and handling
14107adc3a2bSChandler Carruth   // instructions.
14117adc3a2bSChandler Carruth   return Base::visitSub(I);
14127adc3a2bSChandler Carruth }
14137adc3a2bSChandler Carruth 
14147adc3a2bSChandler Carruth bool CallAnalyzer::visitBinaryOperator(BinaryOperator &I) {
14157adc3a2bSChandler Carruth   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
14166d14dfe8SHaicheng Wu   Constant *CLHS = dyn_cast<Constant>(LHS);
14176d14dfe8SHaicheng Wu   if (!CLHS)
14186d14dfe8SHaicheng Wu     CLHS = SimplifiedValues.lookup(LHS);
14196d14dfe8SHaicheng Wu   Constant *CRHS = dyn_cast<Constant>(RHS);
14206d14dfe8SHaicheng Wu   if (!CRHS)
14216d14dfe8SHaicheng Wu     CRHS = SimplifiedValues.lookup(RHS);
14226d14dfe8SHaicheng Wu 
14237adc3a2bSChandler Carruth   Value *SimpleV = nullptr;
14247adc3a2bSChandler Carruth   if (auto FI = dyn_cast<FPMathOperator>(&I))
14255a956c85SMircea Trofin     SimpleV = SimplifyBinOp(I.getOpcode(), CLHS ? CLHS : LHS, CRHS ? CRHS : RHS,
14265a956c85SMircea Trofin                             FI->getFastMathFlags(), DL);
14277adc3a2bSChandler Carruth   else
14286d14dfe8SHaicheng Wu     SimpleV =
14296d14dfe8SHaicheng Wu         SimplifyBinOp(I.getOpcode(), CLHS ? CLHS : LHS, CRHS ? CRHS : RHS, DL);
14307adc3a2bSChandler Carruth 
14316d14dfe8SHaicheng Wu   if (Constant *C = dyn_cast_or_null<Constant>(SimpleV))
14326d14dfe8SHaicheng Wu     SimplifiedValues[&I] = C;
14336d14dfe8SHaicheng Wu 
14346d14dfe8SHaicheng Wu   if (SimpleV)
14357adc3a2bSChandler Carruth     return true;
14367adc3a2bSChandler Carruth 
14377adc3a2bSChandler Carruth   // Disable any SROA on arguments to arbitrary, unsimplified binary operators.
14387adc3a2bSChandler Carruth   disableSROA(LHS);
14397adc3a2bSChandler Carruth   disableSROA(RHS);
14407adc3a2bSChandler Carruth 
144139ed9a60SEli Friedman   // If the instruction is floating point, and the target says this operation
144239ed9a60SEli Friedman   // is expensive, this may eventually become a library call. Treat the cost
14437cebf0afSCraig Topper   // as such. Unless it's fneg which can be implemented with an xor.
14447cebf0afSCraig Topper   using namespace llvm::PatternMatch;
144539ed9a60SEli Friedman   if (I.getType()->isFloatingPointTy() &&
14467cebf0afSCraig Topper       TTI.getFPOpCost(I.getType()) == TargetTransformInfo::TCC_Expensive &&
14477cebf0afSCraig Topper       !match(&I, m_FNeg(m_Value())))
144806408758SMircea Trofin     onCallPenalty();
144939ed9a60SEli Friedman 
14507adc3a2bSChandler Carruth   return false;
14517adc3a2bSChandler Carruth }
14527adc3a2bSChandler Carruth 
14536cda33baSCraig Topper bool CallAnalyzer::visitFNeg(UnaryOperator &I) {
14546cda33baSCraig Topper   Value *Op = I.getOperand(0);
14556cda33baSCraig Topper   Constant *COp = dyn_cast<Constant>(Op);
14566cda33baSCraig Topper   if (!COp)
14576cda33baSCraig Topper     COp = SimplifiedValues.lookup(Op);
14586cda33baSCraig Topper 
14595a956c85SMircea Trofin   Value *SimpleV = SimplifyFNegInst(
14605a956c85SMircea Trofin       COp ? COp : Op, cast<FPMathOperator>(I).getFastMathFlags(), DL);
14616cda33baSCraig Topper 
14626cda33baSCraig Topper   if (Constant *C = dyn_cast_or_null<Constant>(SimpleV))
14636cda33baSCraig Topper     SimplifiedValues[&I] = C;
14646cda33baSCraig Topper 
14656cda33baSCraig Topper   if (SimpleV)
14666cda33baSCraig Topper     return true;
14676cda33baSCraig Topper 
14686cda33baSCraig Topper   // Disable any SROA on arguments to arbitrary, unsimplified fneg.
14696cda33baSCraig Topper   disableSROA(Op);
14706cda33baSCraig Topper 
14716cda33baSCraig Topper   return false;
14726cda33baSCraig Topper }
14736cda33baSCraig Topper 
14747adc3a2bSChandler Carruth bool CallAnalyzer::visitLoad(LoadInst &I) {
147506408758SMircea Trofin   if (handleSROA(I.getPointerOperand(), I.isSimple()))
14767adc3a2bSChandler Carruth     return true;
14777adc3a2bSChandler Carruth 
1478a4461515SHaicheng Wu   // If the data is already loaded from this address and hasn't been clobbered
1479a4461515SHaicheng Wu   // by any stores or calls, this load is likely to be redundant and can be
1480a4461515SHaicheng Wu   // eliminated.
1481a4461515SHaicheng Wu   if (EnableLoadElimination &&
1482b3689cabSHaicheng Wu       !LoadAddrSet.insert(I.getPointerOperand()).second && I.isUnordered()) {
148306408758SMircea Trofin     onLoadEliminationOpportunity();
1484a4461515SHaicheng Wu     return true;
1485a4461515SHaicheng Wu   }
1486a4461515SHaicheng Wu 
14877adc3a2bSChandler Carruth   return false;
14887adc3a2bSChandler Carruth }
14897adc3a2bSChandler Carruth 
14907adc3a2bSChandler Carruth bool CallAnalyzer::visitStore(StoreInst &I) {
149106408758SMircea Trofin   if (handleSROA(I.getPointerOperand(), I.isSimple()))
14927adc3a2bSChandler Carruth     return true;
14937adc3a2bSChandler Carruth 
1494a4461515SHaicheng Wu   // The store can potentially clobber loads and prevent repeated loads from
1495a4461515SHaicheng Wu   // being eliminated.
1496a4461515SHaicheng Wu   // FIXME:
1497a4461515SHaicheng Wu   // 1. We can probably keep an initial set of eliminatable loads substracted
1498a4461515SHaicheng Wu   // from the cost even when we finally see a store. We just need to disable
1499a4461515SHaicheng Wu   // *further* accumulation of elimination savings.
1500a4461515SHaicheng Wu   // 2. We should probably at some point thread MemorySSA for the callee into
1501a4461515SHaicheng Wu   // this and then use that to actually compute *really* precise savings.
1502a4461515SHaicheng Wu   disableLoadElimination();
15037adc3a2bSChandler Carruth   return false;
15047adc3a2bSChandler Carruth }
15057adc3a2bSChandler Carruth 
15067adc3a2bSChandler Carruth bool CallAnalyzer::visitExtractValue(ExtractValueInst &I) {
15077adc3a2bSChandler Carruth   // Constant folding for extract value is trivial.
1508617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1509617f6364SEaswaran Raman         return ConstantExpr::getExtractValue(COps[0], I.getIndices());
1510617f6364SEaswaran Raman       }))
15117adc3a2bSChandler Carruth     return true;
15127adc3a2bSChandler Carruth 
15137adc3a2bSChandler Carruth   // SROA can look through these but give them a cost.
15147adc3a2bSChandler Carruth   return false;
15157adc3a2bSChandler Carruth }
15167adc3a2bSChandler Carruth 
15177adc3a2bSChandler Carruth bool CallAnalyzer::visitInsertValue(InsertValueInst &I) {
15187adc3a2bSChandler Carruth   // Constant folding for insert value is trivial.
1519617f6364SEaswaran Raman   if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) {
1520617f6364SEaswaran Raman         return ConstantExpr::getInsertValue(/*AggregateOperand*/ COps[0],
1521617f6364SEaswaran Raman                                             /*InsertedValueOperand*/ COps[1],
1522617f6364SEaswaran Raman                                             I.getIndices());
1523617f6364SEaswaran Raman       }))
15247adc3a2bSChandler Carruth     return true;
15257adc3a2bSChandler Carruth 
15267adc3a2bSChandler Carruth   // SROA can look through these but give them a cost.
15277adc3a2bSChandler Carruth   return false;
15287adc3a2bSChandler Carruth }
15297adc3a2bSChandler Carruth 
15305f8f34e4SAdrian Prantl /// Try to simplify a call site.
15317adc3a2bSChandler Carruth ///
15327adc3a2bSChandler Carruth /// Takes a concrete function and callsite and tries to actually simplify it by
15337adc3a2bSChandler Carruth /// analyzing the arguments and call itself with instsimplify. Returns true if
15347adc3a2bSChandler Carruth /// it has simplified the callsite to some other entity (a constant), making it
15357adc3a2bSChandler Carruth /// free.
1536652168a9SFedor Sergeev bool CallAnalyzer::simplifyCallSite(Function *F, CallBase &Call) {
15377adc3a2bSChandler Carruth   // FIXME: Using the instsimplify logic directly for this is inefficient
15387adc3a2bSChandler Carruth   // because we have to continually rebuild the argument list even when no
15397adc3a2bSChandler Carruth   // simplifications can be performed. Until that is fixed with remapping
15407adc3a2bSChandler Carruth   // inside of instsimplify, directly constant fold calls here.
1541652168a9SFedor Sergeev   if (!canConstantFoldCallTo(&Call, F))
15427adc3a2bSChandler Carruth     return false;
15437adc3a2bSChandler Carruth 
15447adc3a2bSChandler Carruth   // Try to re-map the arguments to constants.
15457adc3a2bSChandler Carruth   SmallVector<Constant *, 4> ConstantArgs;
1546652168a9SFedor Sergeev   ConstantArgs.reserve(Call.arg_size());
1547652168a9SFedor Sergeev   for (Value *I : Call.args()) {
1548652168a9SFedor Sergeev     Constant *C = dyn_cast<Constant>(I);
15497adc3a2bSChandler Carruth     if (!C)
1550652168a9SFedor Sergeev       C = dyn_cast_or_null<Constant>(SimplifiedValues.lookup(I));
15517adc3a2bSChandler Carruth     if (!C)
15527adc3a2bSChandler Carruth       return false; // This argument doesn't map to a constant.
15537adc3a2bSChandler Carruth 
15547adc3a2bSChandler Carruth     ConstantArgs.push_back(C);
15557adc3a2bSChandler Carruth   }
1556652168a9SFedor Sergeev   if (Constant *C = ConstantFoldCall(&Call, F, ConstantArgs)) {
1557652168a9SFedor Sergeev     SimplifiedValues[&Call] = C;
15587adc3a2bSChandler Carruth     return true;
15597adc3a2bSChandler Carruth   }
15607adc3a2bSChandler Carruth 
15617adc3a2bSChandler Carruth   return false;
15627adc3a2bSChandler Carruth }
15637adc3a2bSChandler Carruth 
1564652168a9SFedor Sergeev bool CallAnalyzer::visitCallBase(CallBase &Call) {
1565652168a9SFedor Sergeev   if (Call.hasFnAttr(Attribute::ReturnsTwice) &&
15667adc3a2bSChandler Carruth       !F.hasFnAttribute(Attribute::ReturnsTwice)) {
15677adc3a2bSChandler Carruth     // This aborts the entire analysis.
15687adc3a2bSChandler Carruth     ExposesReturnsTwice = true;
15697adc3a2bSChandler Carruth     return false;
15707adc3a2bSChandler Carruth   }
1571652168a9SFedor Sergeev   if (isa<CallInst>(Call) && cast<CallInst>(Call).cannotDuplicate())
15727adc3a2bSChandler Carruth     ContainsNoDuplicateCall = true;
15737adc3a2bSChandler Carruth 
1574825debe8SEhud Katz   Value *Callee = Call.getCalledOperand();
1575825debe8SEhud Katz   Function *F = dyn_cast_or_null<Function>(Callee);
1576825debe8SEhud Katz   bool IsIndirectCall = !F;
1577825debe8SEhud Katz   if (IsIndirectCall) {
1578825debe8SEhud Katz     // Check if this happens to be an indirect function call to a known function
1579825debe8SEhud Katz     // in this inline context. If not, we've done all we can.
1580825debe8SEhud Katz     F = dyn_cast_or_null<Function>(SimplifiedValues.lookup(Callee));
1581825debe8SEhud Katz     if (!F) {
158206408758SMircea Trofin       onCallArgumentSetup(Call);
1583825debe8SEhud Katz 
1584825debe8SEhud Katz       if (!Call.onlyReadsMemory())
1585825debe8SEhud Katz         disableLoadElimination();
1586825debe8SEhud Katz       return Base::visitCallBase(Call);
1587825debe8SEhud Katz     }
1588825debe8SEhud Katz   }
1589825debe8SEhud Katz 
1590825debe8SEhud Katz   assert(F && "Expected a call to a known function");
1591825debe8SEhud Katz 
15927adc3a2bSChandler Carruth   // When we have a concrete function, first try to simplify it directly.
1593652168a9SFedor Sergeev   if (simplifyCallSite(F, Call))
15947adc3a2bSChandler Carruth     return true;
15957adc3a2bSChandler Carruth 
15967adc3a2bSChandler Carruth   // Next check if it is an intrinsic we know about.
15977adc3a2bSChandler Carruth   // FIXME: Lift this into part of the InstVisitor.
1598652168a9SFedor Sergeev   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&Call)) {
15997adc3a2bSChandler Carruth     switch (II->getIntrinsicID()) {
16007adc3a2bSChandler Carruth     default:
1601652168a9SFedor Sergeev       if (!Call.onlyReadsMemory() && !isAssumeLikeIntrinsic(II))
1602a4461515SHaicheng Wu         disableLoadElimination();
1603652168a9SFedor Sergeev       return Base::visitCallBase(Call);
16047adc3a2bSChandler Carruth 
16057dd8dbf4SPeter Collingbourne     case Intrinsic::load_relative:
160606408758SMircea Trofin       onLoadRelativeIntrinsic();
16077dd8dbf4SPeter Collingbourne       return false;
16087dd8dbf4SPeter Collingbourne 
16097adc3a2bSChandler Carruth     case Intrinsic::memset:
16107adc3a2bSChandler Carruth     case Intrinsic::memcpy:
16117adc3a2bSChandler Carruth     case Intrinsic::memmove:
1612a4461515SHaicheng Wu       disableLoadElimination();
16137adc3a2bSChandler Carruth       // SROA can usually chew through these intrinsics, but they aren't free.
16147adc3a2bSChandler Carruth       return false;
16154296ea72SVitaly Buka     case Intrinsic::icall_branch_funnel:
16167adc3a2bSChandler Carruth     case Intrinsic::localescape:
16174296ea72SVitaly Buka       HasUninlineableIntrinsic = true;
16187adc3a2bSChandler Carruth       return false;
161980788d80SFlorian Hahn     case Intrinsic::vastart:
162077beee41SSameer AbuAsal       InitsVargArgs = true;
162180788d80SFlorian Hahn       return false;
16227adc3a2bSChandler Carruth     }
16237adc3a2bSChandler Carruth   }
16247adc3a2bSChandler Carruth 
1625652168a9SFedor Sergeev   if (F == Call.getFunction()) {
16267adc3a2bSChandler Carruth     // This flag will fully abort the analysis, so don't bother with anything
16277adc3a2bSChandler Carruth     // else.
16287adc3a2bSChandler Carruth     IsRecursiveCall = true;
16297adc3a2bSChandler Carruth     return false;
16307adc3a2bSChandler Carruth   }
16317adc3a2bSChandler Carruth 
16327adc3a2bSChandler Carruth   if (TTI.isLoweredToCall(F)) {
163306408758SMircea Trofin     onLoweredCall(F, Call, IsIndirectCall);
1634825debe8SEhud Katz   }
16357adc3a2bSChandler Carruth 
1636825debe8SEhud Katz   if (!(Call.onlyReadsMemory() || (IsIndirectCall && F->onlyReadsMemory())))
1637a4461515SHaicheng Wu     disableLoadElimination();
1638652168a9SFedor Sergeev   return Base::visitCallBase(Call);
16397adc3a2bSChandler Carruth }
16407adc3a2bSChandler Carruth 
16417adc3a2bSChandler Carruth bool CallAnalyzer::visitReturnInst(ReturnInst &RI) {
16427adc3a2bSChandler Carruth   // At least one return instruction will be free after inlining.
16437adc3a2bSChandler Carruth   bool Free = !HasReturn;
16447adc3a2bSChandler Carruth   HasReturn = true;
16457adc3a2bSChandler Carruth   return Free;
16467adc3a2bSChandler Carruth }
16477adc3a2bSChandler Carruth 
16487adc3a2bSChandler Carruth bool CallAnalyzer::visitBranchInst(BranchInst &BI) {
16497adc3a2bSChandler Carruth   // We model unconditional branches as essentially free -- they really
16507adc3a2bSChandler Carruth   // shouldn't exist at all, but handling them makes the behavior of the
16517adc3a2bSChandler Carruth   // inliner more regular and predictable. Interestingly, conditional branches
16527adc3a2bSChandler Carruth   // which will fold away are also free.
16537adc3a2bSChandler Carruth   return BI.isUnconditional() || isa<ConstantInt>(BI.getCondition()) ||
16547adc3a2bSChandler Carruth          dyn_cast_or_null<ConstantInt>(
16557adc3a2bSChandler Carruth              SimplifiedValues.lookup(BI.getCondition()));
16567adc3a2bSChandler Carruth }
16577adc3a2bSChandler Carruth 
16583ec848bcSHaicheng Wu bool CallAnalyzer::visitSelectInst(SelectInst &SI) {
16593ec848bcSHaicheng Wu   bool CheckSROA = SI.getType()->isPointerTy();
16603ec848bcSHaicheng Wu   Value *TrueVal = SI.getTrueValue();
16613ec848bcSHaicheng Wu   Value *FalseVal = SI.getFalseValue();
16623ec848bcSHaicheng Wu 
16633ec848bcSHaicheng Wu   Constant *TrueC = dyn_cast<Constant>(TrueVal);
16643ec848bcSHaicheng Wu   if (!TrueC)
16653ec848bcSHaicheng Wu     TrueC = SimplifiedValues.lookup(TrueVal);
16663ec848bcSHaicheng Wu   Constant *FalseC = dyn_cast<Constant>(FalseVal);
16673ec848bcSHaicheng Wu   if (!FalseC)
16683ec848bcSHaicheng Wu     FalseC = SimplifiedValues.lookup(FalseVal);
16693ec848bcSHaicheng Wu   Constant *CondC =
16703ec848bcSHaicheng Wu       dyn_cast_or_null<Constant>(SimplifiedValues.lookup(SI.getCondition()));
16713ec848bcSHaicheng Wu 
16723ec848bcSHaicheng Wu   if (!CondC) {
16733ec848bcSHaicheng Wu     // Select C, X, X => X
16743ec848bcSHaicheng Wu     if (TrueC == FalseC && TrueC) {
16753ec848bcSHaicheng Wu       SimplifiedValues[&SI] = TrueC;
16763ec848bcSHaicheng Wu       return true;
16773ec848bcSHaicheng Wu     }
16783ec848bcSHaicheng Wu 
16793ec848bcSHaicheng Wu     if (!CheckSROA)
16803ec848bcSHaicheng Wu       return Base::visitSelectInst(SI);
16813ec848bcSHaicheng Wu 
16823ec848bcSHaicheng Wu     std::pair<Value *, APInt> TrueBaseAndOffset =
16833ec848bcSHaicheng Wu         ConstantOffsetPtrs.lookup(TrueVal);
16843ec848bcSHaicheng Wu     std::pair<Value *, APInt> FalseBaseAndOffset =
16853ec848bcSHaicheng Wu         ConstantOffsetPtrs.lookup(FalseVal);
16863ec848bcSHaicheng Wu     if (TrueBaseAndOffset == FalseBaseAndOffset && TrueBaseAndOffset.first) {
16873ec848bcSHaicheng Wu       ConstantOffsetPtrs[&SI] = TrueBaseAndOffset;
16883ec848bcSHaicheng Wu 
168906408758SMircea Trofin       if (auto *SROAArg = getSROAArgForValueOrNull(TrueVal))
16903ec848bcSHaicheng Wu         SROAArgValues[&SI] = SROAArg;
16913ec848bcSHaicheng Wu       return true;
16923ec848bcSHaicheng Wu     }
16933ec848bcSHaicheng Wu 
16943ec848bcSHaicheng Wu     return Base::visitSelectInst(SI);
16953ec848bcSHaicheng Wu   }
16963ec848bcSHaicheng Wu 
16973ec848bcSHaicheng Wu   // Select condition is a constant.
16983ec848bcSHaicheng Wu   Value *SelectedV = CondC->isAllOnesValue()
16993ec848bcSHaicheng Wu                          ? TrueVal
17003ec848bcSHaicheng Wu                          : (CondC->isNullValue()) ? FalseVal : nullptr;
17013ec848bcSHaicheng Wu   if (!SelectedV) {
17023ec848bcSHaicheng Wu     // Condition is a vector constant that is not all 1s or all 0s.  If all
17033ec848bcSHaicheng Wu     // operands are constants, ConstantExpr::getSelect() can handle the cases
17043ec848bcSHaicheng Wu     // such as select vectors.
17053ec848bcSHaicheng Wu     if (TrueC && FalseC) {
17063ec848bcSHaicheng Wu       if (auto *C = ConstantExpr::getSelect(CondC, TrueC, FalseC)) {
17073ec848bcSHaicheng Wu         SimplifiedValues[&SI] = C;
17083ec848bcSHaicheng Wu         return true;
17093ec848bcSHaicheng Wu       }
17103ec848bcSHaicheng Wu     }
17113ec848bcSHaicheng Wu     return Base::visitSelectInst(SI);
17123ec848bcSHaicheng Wu   }
17133ec848bcSHaicheng Wu 
17143ec848bcSHaicheng Wu   // Condition is either all 1s or all 0s. SI can be simplified.
17153ec848bcSHaicheng Wu   if (Constant *SelectedC = dyn_cast<Constant>(SelectedV)) {
17163ec848bcSHaicheng Wu     SimplifiedValues[&SI] = SelectedC;
17173ec848bcSHaicheng Wu     return true;
17183ec848bcSHaicheng Wu   }
17193ec848bcSHaicheng Wu 
17203ec848bcSHaicheng Wu   if (!CheckSROA)
17213ec848bcSHaicheng Wu     return true;
17223ec848bcSHaicheng Wu 
17233ec848bcSHaicheng Wu   std::pair<Value *, APInt> BaseAndOffset =
17243ec848bcSHaicheng Wu       ConstantOffsetPtrs.lookup(SelectedV);
17253ec848bcSHaicheng Wu   if (BaseAndOffset.first) {
17263ec848bcSHaicheng Wu     ConstantOffsetPtrs[&SI] = BaseAndOffset;
17273ec848bcSHaicheng Wu 
172806408758SMircea Trofin     if (auto *SROAArg = getSROAArgForValueOrNull(SelectedV))
17293ec848bcSHaicheng Wu       SROAArgValues[&SI] = SROAArg;
17303ec848bcSHaicheng Wu   }
17313ec848bcSHaicheng Wu 
17323ec848bcSHaicheng Wu   return true;
17333ec848bcSHaicheng Wu }
17343ec848bcSHaicheng Wu 
17357adc3a2bSChandler Carruth bool CallAnalyzer::visitSwitchInst(SwitchInst &SI) {
17367adc3a2bSChandler Carruth   // We model unconditional switches as free, see the comments on handling
17377adc3a2bSChandler Carruth   // branches.
17387adc3a2bSChandler Carruth   if (isa<ConstantInt>(SI.getCondition()))
17397adc3a2bSChandler Carruth     return true;
17407adc3a2bSChandler Carruth   if (Value *V = SimplifiedValues.lookup(SI.getCondition()))
17417adc3a2bSChandler Carruth     if (isa<ConstantInt>(V))
17427adc3a2bSChandler Carruth       return true;
17437adc3a2bSChandler Carruth 
17447ad02eeeSEric Christopher   // Assume the most general case where the switch is lowered into
1745919f9e8dSJun Bum Lim   // either a jump table, bit test, or a balanced binary tree consisting of
1746919f9e8dSJun Bum Lim   // case clusters without merging adjacent clusters with the same
1747919f9e8dSJun Bum Lim   // destination. We do not consider the switches that are lowered with a mix
1748919f9e8dSJun Bum Lim   // of jump table/bit test/binary search tree. The cost of the switch is
1749919f9e8dSJun Bum Lim   // proportional to the size of the tree or the size of jump table range.
17502960d41eSJun Bum Lim   //
17512960d41eSJun Bum Lim   // NB: We convert large switches which are just used to initialize large phi
17522960d41eSJun Bum Lim   // nodes to lookup tables instead in simplify-cfg, so this shouldn't prevent
17532960d41eSJun Bum Lim   // inlining those. It will prevent inlining in cases where the optimization
17542960d41eSJun Bum Lim   // does not (yet) fire.
1755919f9e8dSJun Bum Lim 
1756919f9e8dSJun Bum Lim   unsigned JumpTableSize = 0;
17570d987e41SHiroshi Yamauchi   BlockFrequencyInfo *BFI = GetBFI ? &((*GetBFI)(F)) : nullptr;
1758919f9e8dSJun Bum Lim   unsigned NumCaseCluster =
17590d987e41SHiroshi Yamauchi       TTI.getEstimatedNumberOfCaseClusters(SI, JumpTableSize, PSI, BFI);
1760919f9e8dSJun Bum Lim 
176106408758SMircea Trofin   onFinalizeSwitch(JumpTableSize, NumCaseCluster);
1762919f9e8dSJun Bum Lim   return false;
1763919f9e8dSJun Bum Lim }
1764919f9e8dSJun Bum Lim 
17657adc3a2bSChandler Carruth bool CallAnalyzer::visitIndirectBrInst(IndirectBrInst &IBI) {
17667adc3a2bSChandler Carruth   // We never want to inline functions that contain an indirectbr.  This is
17677adc3a2bSChandler Carruth   // incorrect because all the blockaddress's (in static global initializers
17687adc3a2bSChandler Carruth   // for example) would be referring to the original function, and this
17697adc3a2bSChandler Carruth   // indirect jump would jump from the inlined copy of the function into the
17707adc3a2bSChandler Carruth   // original function which is extremely undefined behavior.
17717adc3a2bSChandler Carruth   // FIXME: This logic isn't really right; we can safely inline functions with
17727adc3a2bSChandler Carruth   // indirectbr's as long as no other function or global references the
17737adc3a2bSChandler Carruth   // blockaddress of a block within the current function.
17747adc3a2bSChandler Carruth   HasIndirectBr = true;
17757adc3a2bSChandler Carruth   return false;
17767adc3a2bSChandler Carruth }
17777adc3a2bSChandler Carruth 
17787adc3a2bSChandler Carruth bool CallAnalyzer::visitResumeInst(ResumeInst &RI) {
17797adc3a2bSChandler Carruth   // FIXME: It's not clear that a single instruction is an accurate model for
17807adc3a2bSChandler Carruth   // the inline cost of a resume instruction.
17817adc3a2bSChandler Carruth   return false;
17827adc3a2bSChandler Carruth }
17837adc3a2bSChandler Carruth 
17847adc3a2bSChandler Carruth bool CallAnalyzer::visitCleanupReturnInst(CleanupReturnInst &CRI) {
17857adc3a2bSChandler Carruth   // FIXME: It's not clear that a single instruction is an accurate model for
17867adc3a2bSChandler Carruth   // the inline cost of a cleanupret instruction.
17877adc3a2bSChandler Carruth   return false;
17887adc3a2bSChandler Carruth }
17897adc3a2bSChandler Carruth 
17907adc3a2bSChandler Carruth bool CallAnalyzer::visitCatchReturnInst(CatchReturnInst &CRI) {
17917adc3a2bSChandler Carruth   // FIXME: It's not clear that a single instruction is an accurate model for
17928220bcc5SJoseph Tremoulet   // the inline cost of a catchret instruction.
17937adc3a2bSChandler Carruth   return false;
17947adc3a2bSChandler Carruth }
17957adc3a2bSChandler Carruth 
17967adc3a2bSChandler Carruth bool CallAnalyzer::visitUnreachableInst(UnreachableInst &I) {
17977adc3a2bSChandler Carruth   // FIXME: It might be reasonably to discount the cost of instructions leading
17987adc3a2bSChandler Carruth   // to unreachable as they have the lowest possible impact on both runtime and
17997adc3a2bSChandler Carruth   // code size.
18007adc3a2bSChandler Carruth   return true; // No actual code is needed for unreachable.
18017adc3a2bSChandler Carruth }
18027adc3a2bSChandler Carruth 
18037adc3a2bSChandler Carruth bool CallAnalyzer::visitInstruction(Instruction &I) {
18047adc3a2bSChandler Carruth   // Some instructions are free. All of the free intrinsics can also be
18057adc3a2bSChandler Carruth   // handled by SROA, etc.
18067adc3a2bSChandler Carruth   if (TargetTransformInfo::TCC_Free == TTI.getUserCost(&I))
18077adc3a2bSChandler Carruth     return true;
18087adc3a2bSChandler Carruth 
18097adc3a2bSChandler Carruth   // We found something we don't understand or can't handle. Mark any SROA-able
18107adc3a2bSChandler Carruth   // values in the operand list as no longer viable.
18117adc3a2bSChandler Carruth   for (User::op_iterator OI = I.op_begin(), OE = I.op_end(); OI != OE; ++OI)
18127adc3a2bSChandler Carruth     disableSROA(*OI);
18137adc3a2bSChandler Carruth 
18147adc3a2bSChandler Carruth   return false;
18157adc3a2bSChandler Carruth }
18167adc3a2bSChandler Carruth 
18175f8f34e4SAdrian Prantl /// Analyze a basic block for its contribution to the inline cost.
18187adc3a2bSChandler Carruth ///
18197adc3a2bSChandler Carruth /// This method walks the analyzer over every instruction in the given basic
18207adc3a2bSChandler Carruth /// block and accounts for their cost during inlining at this callsite. It
18217adc3a2bSChandler Carruth /// aborts early if the threshold has been exceeded or an impossible to inline
18227adc3a2bSChandler Carruth /// construct has been detected. It returns false if inlining is no longer
18237adc3a2bSChandler Carruth /// viable, and true if inlining remains viable.
1824c0aa4b75SDavid Bolvansky InlineResult
1825c0aa4b75SDavid Bolvansky CallAnalyzer::analyzeBlock(BasicBlock *BB,
18267adc3a2bSChandler Carruth                            SmallPtrSetImpl<const Value *> &EphValues) {
18277adc3a2bSChandler Carruth   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
18287adc3a2bSChandler Carruth     // FIXME: Currently, the number of instructions in a function regardless of
18297adc3a2bSChandler Carruth     // our ability to simplify them during inline to constants or dead code,
18307adc3a2bSChandler Carruth     // are actually used by the vector bonus heuristic. As long as that's true,
18317adc3a2bSChandler Carruth     // we have to special case debug intrinsics here to prevent differences in
18327adc3a2bSChandler Carruth     // inlining due to debug symbols. Eventually, the number of unsimplified
18337adc3a2bSChandler Carruth     // instructions shouldn't factor into the cost computation, but until then,
18347adc3a2bSChandler Carruth     // hack around it here.
18357adc3a2bSChandler Carruth     if (isa<DbgInfoIntrinsic>(I))
18367adc3a2bSChandler Carruth       continue;
18377adc3a2bSChandler Carruth 
18387adc3a2bSChandler Carruth     // Skip ephemeral values.
18395a82c916SDuncan P. N. Exon Smith     if (EphValues.count(&*I))
18407adc3a2bSChandler Carruth       continue;
18417adc3a2bSChandler Carruth 
18427adc3a2bSChandler Carruth     ++NumInstructions;
18437adc3a2bSChandler Carruth     if (isa<ExtractElementInst>(I) || I->getType()->isVectorTy())
18447adc3a2bSChandler Carruth       ++NumVectorInstructions;
18457adc3a2bSChandler Carruth 
18467adc3a2bSChandler Carruth     // If the instruction simplified to a constant, there is no cost to this
18477adc3a2bSChandler Carruth     // instruction. Visit the instructions using our InstVisitor to account for
18487adc3a2bSChandler Carruth     // all of the per-instruction logic. The visit tree returns true if we
18497adc3a2bSChandler Carruth     // consumed the instruction in any way, and false if the instruction's base
18507adc3a2bSChandler Carruth     // cost should count against inlining.
1851c965fd94SKirill Naumov     onInstructionAnalysisStart(&*I);
1852c965fd94SKirill Naumov 
18535a82c916SDuncan P. N. Exon Smith     if (Base::visit(&*I))
18547adc3a2bSChandler Carruth       ++NumInstructionsSimplified;
18557adc3a2bSChandler Carruth     else
185614a16faeSMircea Trofin       onMissedSimplification();
18577adc3a2bSChandler Carruth 
1858c965fd94SKirill Naumov     onInstructionAnalysisFinish(&*I);
18590812c5beSHaicheng Wu     using namespace ore;
18607adc3a2bSChandler Carruth     // If the visit this instruction detected an uninlinable pattern, abort.
18615466597fSMircea Trofin     InlineResult IR = InlineResult::success();
1862c0aa4b75SDavid Bolvansky     if (IsRecursiveCall)
18635466597fSMircea Trofin       IR = InlineResult::failure("recursive");
1864c0aa4b75SDavid Bolvansky     else if (ExposesReturnsTwice)
18655466597fSMircea Trofin       IR = InlineResult::failure("exposes returns twice");
1866c0aa4b75SDavid Bolvansky     else if (HasDynamicAlloca)
18675466597fSMircea Trofin       IR = InlineResult::failure("dynamic alloca");
1868c0aa4b75SDavid Bolvansky     else if (HasIndirectBr)
18695466597fSMircea Trofin       IR = InlineResult::failure("indirect branch");
1870c0aa4b75SDavid Bolvansky     else if (HasUninlineableIntrinsic)
18715466597fSMircea Trofin       IR = InlineResult::failure("uninlinable intrinsic");
187277beee41SSameer AbuAsal     else if (InitsVargArgs)
18735466597fSMircea Trofin       IR = InlineResult::failure("varargs");
18745466597fSMircea Trofin     if (!IR.isSuccess()) {
18750812c5beSHaicheng Wu       if (ORE)
18769590658fSVivek Pandya         ORE->emit([&]() {
18779590658fSVivek Pandya           return OptimizationRemarkMissed(DEBUG_TYPE, "NeverInline",
1878652168a9SFedor Sergeev                                           &CandidateCall)
1879c0aa4b75SDavid Bolvansky                  << NV("Callee", &F) << " has uninlinable pattern ("
18805466597fSMircea Trofin                  << NV("InlineResult", IR.getFailureReason())
1881c0aa4b75SDavid Bolvansky                  << ") and cost is not fully computed";
18829590658fSVivek Pandya         });
1883c0aa4b75SDavid Bolvansky       return IR;
18840812c5beSHaicheng Wu     }
18857adc3a2bSChandler Carruth 
18867adc3a2bSChandler Carruth     // If the caller is a recursive function then we don't want to inline
18877adc3a2bSChandler Carruth     // functions which allocate a lot of stack space because it would increase
18887adc3a2bSChandler Carruth     // the caller stack usage dramatically.
18897adc3a2bSChandler Carruth     if (IsCallerRecursive &&
18900812c5beSHaicheng Wu         AllocatedSize > InlineConstants::TotalAllocaSizeRecursiveCaller) {
18915466597fSMircea Trofin       auto IR =
18925466597fSMircea Trofin           InlineResult::failure("recursive and allocates too much stack space");
18930812c5beSHaicheng Wu       if (ORE)
18949590658fSVivek Pandya         ORE->emit([&]() {
18959590658fSVivek Pandya           return OptimizationRemarkMissed(DEBUG_TYPE, "NeverInline",
1896652168a9SFedor Sergeev                                           &CandidateCall)
18975466597fSMircea Trofin                  << NV("Callee", &F) << " is "
18985466597fSMircea Trofin                  << NV("InlineResult", IR.getFailureReason())
1899c0aa4b75SDavid Bolvansky                  << ". Cost is not fully computed";
19009590658fSVivek Pandya         });
1901c0aa4b75SDavid Bolvansky       return IR;
19020812c5beSHaicheng Wu     }
19037adc3a2bSChandler Carruth 
190406408758SMircea Trofin     if (shouldStop())
19055466597fSMircea Trofin       return InlineResult::failure(
19065466597fSMircea Trofin           "Call site analysis is not favorable to inlining.");
19077adc3a2bSChandler Carruth   }
19087adc3a2bSChandler Carruth 
19095466597fSMircea Trofin   return InlineResult::success();
19107adc3a2bSChandler Carruth }
19117adc3a2bSChandler Carruth 
19125f8f34e4SAdrian Prantl /// Compute the base pointer and cumulative constant offsets for V.
19137adc3a2bSChandler Carruth ///
19147adc3a2bSChandler Carruth /// This strips all constant offsets off of V, leaving it the base pointer, and
19157adc3a2bSChandler Carruth /// accumulates the total constant offset applied in the returned constant. It
19167adc3a2bSChandler Carruth /// returns 0 if V is not a pointer, and returns the constant '0' if there are
19177adc3a2bSChandler Carruth /// no constant offsets applied.
19187adc3a2bSChandler Carruth ConstantInt *CallAnalyzer::stripAndComputeInBoundsConstantOffsets(Value *&V) {
19197adc3a2bSChandler Carruth   if (!V->getType()->isPointerTy())
19207adc3a2bSChandler Carruth     return nullptr;
19217adc3a2bSChandler Carruth 
192277f32994SBjorn Pettersson   unsigned AS = V->getType()->getPointerAddressSpace();
1923945b7e5aSElena Demikhovsky   unsigned IntPtrWidth = DL.getIndexSizeInBits(AS);
19247adc3a2bSChandler Carruth   APInt Offset = APInt::getNullValue(IntPtrWidth);
19257adc3a2bSChandler Carruth 
19267adc3a2bSChandler Carruth   // Even though we don't look through PHI nodes, we could be called on an
19277adc3a2bSChandler Carruth   // instruction in an unreachable block, which may be on a cycle.
19287adc3a2bSChandler Carruth   SmallPtrSet<Value *, 4> Visited;
19297adc3a2bSChandler Carruth   Visited.insert(V);
19307adc3a2bSChandler Carruth   do {
19317adc3a2bSChandler Carruth     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
19327adc3a2bSChandler Carruth       if (!GEP->isInBounds() || !accumulateGEPOffset(*GEP, Offset))
19337adc3a2bSChandler Carruth         return nullptr;
19347adc3a2bSChandler Carruth       V = GEP->getPointerOperand();
19357adc3a2bSChandler Carruth     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
19367adc3a2bSChandler Carruth       V = cast<Operator>(V)->getOperand(0);
19377adc3a2bSChandler Carruth     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
19385ce32728SSanjoy Das       if (GA->isInterposable())
19397adc3a2bSChandler Carruth         break;
19407adc3a2bSChandler Carruth       V = GA->getAliasee();
19417adc3a2bSChandler Carruth     } else {
19427adc3a2bSChandler Carruth       break;
19437adc3a2bSChandler Carruth     }
19447adc3a2bSChandler Carruth     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
19457adc3a2bSChandler Carruth   } while (Visited.insert(V).second);
19467adc3a2bSChandler Carruth 
194797572775SNicola Zaghen   Type *IdxPtrTy = DL.getIndexType(V->getType());
194897572775SNicola Zaghen   return cast<ConstantInt>(ConstantInt::get(IdxPtrTy, Offset));
19497adc3a2bSChandler Carruth }
19507adc3a2bSChandler Carruth 
19515f8f34e4SAdrian Prantl /// Find dead blocks due to deleted CFG edges during inlining.
19523739e14aSHaicheng Wu ///
19533739e14aSHaicheng Wu /// If we know the successor of the current block, \p CurrBB, has to be \p
19543739e14aSHaicheng Wu /// NextBB, the other successors of \p CurrBB are dead if these successors have
19553739e14aSHaicheng Wu /// no live incoming CFG edges.  If one block is found to be dead, we can
19563739e14aSHaicheng Wu /// continue growing the dead block list by checking the successors of the dead
19573739e14aSHaicheng Wu /// blocks to see if all their incoming edges are dead or not.
19583739e14aSHaicheng Wu void CallAnalyzer::findDeadBlocks(BasicBlock *CurrBB, BasicBlock *NextBB) {
19593739e14aSHaicheng Wu   auto IsEdgeDead = [&](BasicBlock *Pred, BasicBlock *Succ) {
196002a2bb2fSHiroshi Inoue     // A CFG edge is dead if the predecessor is dead or the predecessor has a
19613739e14aSHaicheng Wu     // known successor which is not the one under exam.
19623739e14aSHaicheng Wu     return (DeadBlocks.count(Pred) ||
19633739e14aSHaicheng Wu             (KnownSuccessors[Pred] && KnownSuccessors[Pred] != Succ));
19643739e14aSHaicheng Wu   };
19653739e14aSHaicheng Wu 
19663739e14aSHaicheng Wu   auto IsNewlyDead = [&](BasicBlock *BB) {
19673739e14aSHaicheng Wu     // If all the edges to a block are dead, the block is also dead.
19683739e14aSHaicheng Wu     return (!DeadBlocks.count(BB) &&
19693739e14aSHaicheng Wu             llvm::all_of(predecessors(BB),
19703739e14aSHaicheng Wu                          [&](BasicBlock *P) { return IsEdgeDead(P, BB); }));
19713739e14aSHaicheng Wu   };
19723739e14aSHaicheng Wu 
19733739e14aSHaicheng Wu   for (BasicBlock *Succ : successors(CurrBB)) {
19743739e14aSHaicheng Wu     if (Succ == NextBB || !IsNewlyDead(Succ))
19753739e14aSHaicheng Wu       continue;
19763739e14aSHaicheng Wu     SmallVector<BasicBlock *, 4> NewDead;
19773739e14aSHaicheng Wu     NewDead.push_back(Succ);
19783739e14aSHaicheng Wu     while (!NewDead.empty()) {
19793739e14aSHaicheng Wu       BasicBlock *Dead = NewDead.pop_back_val();
19803739e14aSHaicheng Wu       if (DeadBlocks.insert(Dead))
19813739e14aSHaicheng Wu         // Continue growing the dead block lists.
19823739e14aSHaicheng Wu         for (BasicBlock *S : successors(Dead))
19833739e14aSHaicheng Wu           if (IsNewlyDead(S))
19843739e14aSHaicheng Wu             NewDead.push_back(S);
19853739e14aSHaicheng Wu     }
19863739e14aSHaicheng Wu   }
19873739e14aSHaicheng Wu }
19883739e14aSHaicheng Wu 
19895f8f34e4SAdrian Prantl /// Analyze a call site for potential inlining.
19907adc3a2bSChandler Carruth ///
19917adc3a2bSChandler Carruth /// Returns true if inlining this call is viable, and false if it is not
19927adc3a2bSChandler Carruth /// viable. It computes the cost and adjusts the threshold based on numerous
19937adc3a2bSChandler Carruth /// factors and heuristics. If this method returns false but the computed cost
19947adc3a2bSChandler Carruth /// is below the computed threshold, then inlining was forcibly disabled by
19957adc3a2bSChandler Carruth /// some artifact of the routine.
199693ac81ccSMircea Trofin InlineResult CallAnalyzer::analyze() {
19977adc3a2bSChandler Carruth   ++NumCallsAnalyzed;
19987adc3a2bSChandler Carruth 
199906408758SMircea Trofin   auto Result = onAnalysisStart();
20005466597fSMircea Trofin   if (!Result.isSuccess())
200106408758SMircea Trofin     return Result;
20027adc3a2bSChandler Carruth 
20037adc3a2bSChandler Carruth   if (F.empty())
20045466597fSMircea Trofin     return InlineResult::success();
20057adc3a2bSChandler Carruth 
200693ac81ccSMircea Trofin   Function *Caller = CandidateCall.getFunction();
20077adc3a2bSChandler Carruth   // Check if the caller function is recursive itself.
20087adc3a2bSChandler Carruth   for (User *U : Caller->users()) {
2009652168a9SFedor Sergeev     CallBase *Call = dyn_cast<CallBase>(U);
2010652168a9SFedor Sergeev     if (Call && Call->getFunction() == Caller) {
20117adc3a2bSChandler Carruth       IsCallerRecursive = true;
20127adc3a2bSChandler Carruth       break;
20137adc3a2bSChandler Carruth     }
20147adc3a2bSChandler Carruth   }
20157adc3a2bSChandler Carruth 
20167adc3a2bSChandler Carruth   // Populate our simplified values by mapping from function arguments to call
20177adc3a2bSChandler Carruth   // arguments with known important simplifications.
201893ac81ccSMircea Trofin   auto CAI = CandidateCall.arg_begin();
20197adc3a2bSChandler Carruth   for (Function::arg_iterator FAI = F.arg_begin(), FAE = F.arg_end();
20207adc3a2bSChandler Carruth        FAI != FAE; ++FAI, ++CAI) {
202193ac81ccSMircea Trofin     assert(CAI != CandidateCall.arg_end());
20227adc3a2bSChandler Carruth     if (Constant *C = dyn_cast<Constant>(CAI))
20235a82c916SDuncan P. N. Exon Smith       SimplifiedValues[&*FAI] = C;
20247adc3a2bSChandler Carruth 
20257adc3a2bSChandler Carruth     Value *PtrArg = *CAI;
20267adc3a2bSChandler Carruth     if (ConstantInt *C = stripAndComputeInBoundsConstantOffsets(PtrArg)) {
20275a82c916SDuncan P. N. Exon Smith       ConstantOffsetPtrs[&*FAI] = std::make_pair(PtrArg, C->getValue());
20287adc3a2bSChandler Carruth 
20297adc3a2bSChandler Carruth       // We can SROA any pointer arguments derived from alloca instructions.
203006408758SMircea Trofin       if (auto *SROAArg = dyn_cast<AllocaInst>(PtrArg)) {
203106408758SMircea Trofin         SROAArgValues[&*FAI] = SROAArg;
203206408758SMircea Trofin         onInitializeSROAArg(SROAArg);
20332e42cc7aSMircea Trofin         EnabledSROAAllocas.insert(SROAArg);
20347adc3a2bSChandler Carruth       }
20357adc3a2bSChandler Carruth     }
20367adc3a2bSChandler Carruth   }
20377adc3a2bSChandler Carruth   NumConstantArgs = SimplifiedValues.size();
20387adc3a2bSChandler Carruth   NumConstantOffsetPtrArgs = ConstantOffsetPtrs.size();
20397adc3a2bSChandler Carruth   NumAllocaArgs = SROAArgValues.size();
20407adc3a2bSChandler Carruth 
20417adc3a2bSChandler Carruth   // FIXME: If a caller has multiple calls to a callee, we end up recomputing
20427adc3a2bSChandler Carruth   // the ephemeral values multiple times (and they're completely determined by
20437adc3a2bSChandler Carruth   // the callee, so this is purely duplicate work).
20447adc3a2bSChandler Carruth   SmallPtrSet<const Value *, 32> EphValues;
2045aec2fa35SDaniel Jasper   CodeMetrics::collectEphemeralValues(&F, &GetAssumptionCache(F), EphValues);
20467adc3a2bSChandler Carruth 
20477adc3a2bSChandler Carruth   // The worklist of live basic blocks in the callee *after* inlining. We avoid
20487adc3a2bSChandler Carruth   // adding basic blocks of the callee which can be proven to be dead for this
20497adc3a2bSChandler Carruth   // particular call site in order to get more accurate cost estimates. This
20507adc3a2bSChandler Carruth   // requires a somewhat heavyweight iteration pattern: we need to walk the
20517adc3a2bSChandler Carruth   // basic blocks in a breadth-first order as we insert live successors. To
20527adc3a2bSChandler Carruth   // accomplish this, prioritizing for small iterations because we exit after
20537adc3a2bSChandler Carruth   // crossing our threshold, we use a small-size optimized SetVector.
20547adc3a2bSChandler Carruth   typedef SetVector<BasicBlock *, SmallVector<BasicBlock *, 16>,
2055567556aaSChad Rosier                     SmallPtrSet<BasicBlock *, 16>>
2056567556aaSChad Rosier       BBSetVector;
20577adc3a2bSChandler Carruth   BBSetVector BBWorklist;
20587adc3a2bSChandler Carruth   BBWorklist.insert(&F.getEntryBlock());
205906408758SMircea Trofin 
20607adc3a2bSChandler Carruth   // Note that we *must not* cache the size, this loop grows the worklist.
20617adc3a2bSChandler Carruth   for (unsigned Idx = 0; Idx != BBWorklist.size(); ++Idx) {
206206408758SMircea Trofin     if (shouldStop())
20637adc3a2bSChandler Carruth       break;
20647adc3a2bSChandler Carruth 
20657adc3a2bSChandler Carruth     BasicBlock *BB = BBWorklist[Idx];
20667adc3a2bSChandler Carruth     if (BB->empty())
20677adc3a2bSChandler Carruth       continue;
20687adc3a2bSChandler Carruth 
2069639b29b1SNick Desaulniers     // Disallow inlining a blockaddress with uses other than strictly callbr.
2070639b29b1SNick Desaulniers     // A blockaddress only has defined behavior for an indirect branch in the
2071639b29b1SNick Desaulniers     // same function, and we do not currently support inlining indirect
2072639b29b1SNick Desaulniers     // branches.  But, the inliner may not see an indirect branch that ends up
2073639b29b1SNick Desaulniers     // being dead code at a particular call site. If the blockaddress escapes
2074639b29b1SNick Desaulniers     // the function, e.g., via a global variable, inlining may lead to an
2075639b29b1SNick Desaulniers     // invalid cross-function reference.
2076639b29b1SNick Desaulniers     // FIXME: pr/39560: continue relaxing this overt restriction.
20776a84cd3bSNick Desaulniers     if (BB->hasAddressTaken())
2078639b29b1SNick Desaulniers       for (User *U : BlockAddress::get(&*BB)->users())
2079639b29b1SNick Desaulniers         if (!isa<CallBrInst>(*U))
20805466597fSMircea Trofin           return InlineResult::failure("blockaddress used outside of callbr");
20817adc3a2bSChandler Carruth 
20827adc3a2bSChandler Carruth     // Analyze the cost of this block. If we blow through the threshold, this
20837adc3a2bSChandler Carruth     // returns false, and we can bail on out.
2084c0aa4b75SDavid Bolvansky     InlineResult IR = analyzeBlock(BB, EphValues);
20855466597fSMircea Trofin     if (!IR.isSuccess())
2086c0aa4b75SDavid Bolvansky       return IR;
20877adc3a2bSChandler Carruth 
2088edb12a83SChandler Carruth     Instruction *TI = BB->getTerminator();
20897adc3a2bSChandler Carruth 
20907adc3a2bSChandler Carruth     // Add in the live successors by first checking whether we have terminator
20917adc3a2bSChandler Carruth     // that may be simplified based on the values simplified by this call.
20927adc3a2bSChandler Carruth     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
20937adc3a2bSChandler Carruth       if (BI->isConditional()) {
20947adc3a2bSChandler Carruth         Value *Cond = BI->getCondition();
2095567556aaSChad Rosier         if (ConstantInt *SimpleCond =
2096567556aaSChad Rosier                 dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) {
20973739e14aSHaicheng Wu           BasicBlock *NextBB = BI->getSuccessor(SimpleCond->isZero() ? 1 : 0);
20983739e14aSHaicheng Wu           BBWorklist.insert(NextBB);
20993739e14aSHaicheng Wu           KnownSuccessors[BB] = NextBB;
21003739e14aSHaicheng Wu           findDeadBlocks(BB, NextBB);
21017adc3a2bSChandler Carruth           continue;
21027adc3a2bSChandler Carruth         }
21037adc3a2bSChandler Carruth       }
21047adc3a2bSChandler Carruth     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
21057adc3a2bSChandler Carruth       Value *Cond = SI->getCondition();
2106567556aaSChad Rosier       if (ConstantInt *SimpleCond =
2107567556aaSChad Rosier               dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) {
21083739e14aSHaicheng Wu         BasicBlock *NextBB = SI->findCaseValue(SimpleCond)->getCaseSuccessor();
21093739e14aSHaicheng Wu         BBWorklist.insert(NextBB);
21103739e14aSHaicheng Wu         KnownSuccessors[BB] = NextBB;
21113739e14aSHaicheng Wu         findDeadBlocks(BB, NextBB);
21127adc3a2bSChandler Carruth         continue;
21137adc3a2bSChandler Carruth       }
21147adc3a2bSChandler Carruth     }
21157adc3a2bSChandler Carruth 
21167adc3a2bSChandler Carruth     // If we're unable to select a particular successor, just count all of
21177adc3a2bSChandler Carruth     // them.
21187adc3a2bSChandler Carruth     for (unsigned TIdx = 0, TSize = TI->getNumSuccessors(); TIdx != TSize;
21197adc3a2bSChandler Carruth          ++TIdx)
21207adc3a2bSChandler Carruth       BBWorklist.insert(TI->getSuccessor(TIdx));
21217adc3a2bSChandler Carruth 
212206408758SMircea Trofin     onBlockAnalyzed(BB);
21237adc3a2bSChandler Carruth   }
21247adc3a2bSChandler Carruth 
212593ac81ccSMircea Trofin   bool OnlyOneCallAndLocalLinkage = F.hasLocalLinkage() && F.hasOneUse() &&
212693ac81ccSMircea Trofin                                     &F == CandidateCall.getCalledFunction();
21277adc3a2bSChandler Carruth   // If this is a noduplicate call, we can still inline as long as
21287adc3a2bSChandler Carruth   // inlining this would cause the removal of the caller (so the instruction
21297adc3a2bSChandler Carruth   // is not actually duplicated, just moved).
21307adc3a2bSChandler Carruth   if (!OnlyOneCallAndLocalLinkage && ContainsNoDuplicateCall)
21315466597fSMircea Trofin     return InlineResult::failure("noduplicate");
21327adc3a2bSChandler Carruth 
213306408758SMircea Trofin   return finalizeAnalysis();
21347adc3a2bSChandler Carruth }
21357adc3a2bSChandler Carruth 
2136615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
21375f8f34e4SAdrian Prantl /// Dump stats about this call's analysis.
213806408758SMircea Trofin LLVM_DUMP_METHOD void InlineCostCallAnalyzer::dump() {
21397adc3a2bSChandler Carruth #define DEBUG_PRINT_STAT(x) dbgs() << "      " #x ": " << x << "\n"
2140c965fd94SKirill Naumov   if (PrintDebugInstructionDeltas)
2141c965fd94SKirill Naumov     F.print(dbgs(), &Writer);
21427adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumConstantArgs);
21437adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumConstantOffsetPtrArgs);
21447adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumAllocaArgs);
21457adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumConstantPtrCmps);
21467adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumConstantPtrDiffs);
21477adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumInstructionsSimplified);
21487adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(NumInstructions);
21497adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(SROACostSavings);
21507adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(SROACostSavingsLost);
2151a4461515SHaicheng Wu   DEBUG_PRINT_STAT(LoadEliminationCost);
21527adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(ContainsNoDuplicateCall);
21537adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(Cost);
21547adc3a2bSChandler Carruth   DEBUG_PRINT_STAT(Threshold);
21557adc3a2bSChandler Carruth #undef DEBUG_PRINT_STAT
21567adc3a2bSChandler Carruth }
21577adc3a2bSChandler Carruth #endif
21587adc3a2bSChandler Carruth 
21595f8f34e4SAdrian Prantl /// Test that there are no attribute conflicts between Caller and Callee
21607adc3a2bSChandler Carruth ///        that prevent inlining.
2161f9ca75f1STeresa Johnson static bool functionsHaveCompatibleAttributes(
2162f9ca75f1STeresa Johnson     Function *Caller, Function *Callee, TargetTransformInfo &TTI,
2163f9ca75f1STeresa Johnson     function_ref<const TargetLibraryInfo &(Function &)> &GetTLI) {
2164f9ca75f1STeresa Johnson   // Note that CalleeTLI must be a copy not a reference. The legacy pass manager
2165f9ca75f1STeresa Johnson   // caches the most recently created TLI in the TargetLibraryInfoWrapperPass
2166f9ca75f1STeresa Johnson   // object, and always returns the same object (which is overwritten on each
2167f9ca75f1STeresa Johnson   // GetTLI call). Therefore we copy the first result.
2168f9ca75f1STeresa Johnson   auto CalleeTLI = GetTLI(*Callee);
21697adc3a2bSChandler Carruth   return TTI.areInlineCompatible(Caller, Callee) &&
2170f9ca75f1STeresa Johnson          GetTLI(*Caller).areInlineCompatible(CalleeTLI,
2171ed03d948SMehdi Amini                                              InlineCallerSupersetNoBuiltin) &&
21721cb242ebSAkira Hatanaka          AttributeFuncs::areInlineCompatible(*Caller, *Callee);
21737adc3a2bSChandler Carruth }
21747adc3a2bSChandler Carruth 
2175652168a9SFedor Sergeev int llvm::getCallsiteCost(CallBase &Call, const DataLayout &DL) {
2176351d9b01SXinliang David Li   int Cost = 0;
2177652168a9SFedor Sergeev   for (unsigned I = 0, E = Call.arg_size(); I != E; ++I) {
2178652168a9SFedor Sergeev     if (Call.isByValArgument(I)) {
2179351d9b01SXinliang David Li       // We approximate the number of loads and stores needed by dividing the
2180351d9b01SXinliang David Li       // size of the byval type by the target's pointer size.
2181652168a9SFedor Sergeev       PointerType *PTy = cast<PointerType>(Call.getArgOperand(I)->getType());
2182351d9b01SXinliang David Li       unsigned TypeSize = DL.getTypeSizeInBits(PTy->getElementType());
218377f32994SBjorn Pettersson       unsigned AS = PTy->getAddressSpace();
218477f32994SBjorn Pettersson       unsigned PointerSize = DL.getPointerSizeInBits(AS);
2185351d9b01SXinliang David Li       // Ceiling division.
2186351d9b01SXinliang David Li       unsigned NumStores = (TypeSize + PointerSize - 1) / PointerSize;
2187351d9b01SXinliang David Li 
2188351d9b01SXinliang David Li       // If it generates more than 8 stores it is likely to be expanded as an
2189351d9b01SXinliang David Li       // inline memcpy so we take that as an upper bound. Otherwise we assume
2190351d9b01SXinliang David Li       // one load and one store per word copied.
2191351d9b01SXinliang David Li       // FIXME: The maxStoresPerMemcpy setting from the target should be used
2192351d9b01SXinliang David Li       // here instead of a magic number of 8, but it's not available via
2193351d9b01SXinliang David Li       // DataLayout.
2194351d9b01SXinliang David Li       NumStores = std::min(NumStores, 8U);
2195351d9b01SXinliang David Li 
2196351d9b01SXinliang David Li       Cost += 2 * NumStores * InlineConstants::InstrCost;
2197351d9b01SXinliang David Li     } else {
2198351d9b01SXinliang David Li       // For non-byval arguments subtract off one instruction per call
2199351d9b01SXinliang David Li       // argument.
2200351d9b01SXinliang David Li       Cost += InlineConstants::InstrCost;
2201351d9b01SXinliang David Li     }
2202351d9b01SXinliang David Li   }
2203351d9b01SXinliang David Li   // The call instruction also disappears after inlining.
2204351d9b01SXinliang David Li   Cost += InlineConstants::InstrCost + InlineConstants::CallPenalty;
2205351d9b01SXinliang David Li   return Cost;
2206351d9b01SXinliang David Li }
2207351d9b01SXinliang David Li 
2208ab6a6837SSean Silva InlineCost llvm::getInlineCost(
2209652168a9SFedor Sergeev     CallBase &Call, const InlineParams &Params, TargetTransformInfo &CalleeTTI,
2210aec2fa35SDaniel Jasper     std::function<AssumptionCache &(Function &)> &GetAssumptionCache,
221112585b01SEaswaran Raman     Optional<function_ref<BlockFrequencyInfo &(Function &)>> GetBFI,
2212f9ca75f1STeresa Johnson     function_ref<const TargetLibraryInfo &(Function &)> GetTLI,
22130812c5beSHaicheng Wu     ProfileSummaryInfo *PSI, OptimizationRemarkEmitter *ORE) {
2214652168a9SFedor Sergeev   return getInlineCost(Call, Call.getCalledFunction(), Params, CalleeTTI,
2215f9ca75f1STeresa Johnson                        GetAssumptionCache, GetBFI, GetTLI, PSI, ORE);
2216b9f7120eSEaswaran Raman }
2217b9f7120eSEaswaran Raman 
2218*201498c6SMircea Trofin Optional<InlineResult> llvm::getAttributeBasedInliningDecision(
2219*201498c6SMircea Trofin     CallBase &Call, Function *Callee, TargetTransformInfo &CalleeTTI,
2220*201498c6SMircea Trofin     function_ref<const TargetLibraryInfo &(Function &)> GetTLI) {
2221f4bb2f0dSEaswaran Raman 
22227adc3a2bSChandler Carruth   // Cannot inline indirect calls.
22237adc3a2bSChandler Carruth   if (!Callee)
2224*201498c6SMircea Trofin     return InlineResult::failure("indirect call");
22257adc3a2bSChandler Carruth 
22263851496eSBjorn Pettersson   // Never inline calls with byval arguments that does not have the alloca
22273851496eSBjorn Pettersson   // address space. Since byval arguments can be replaced with a copy to an
22283851496eSBjorn Pettersson   // alloca, the inlined code would need to be adjusted to handle that the
22293851496eSBjorn Pettersson   // argument is in the alloca address space (so it is a little bit complicated
22303851496eSBjorn Pettersson   // to solve).
22313851496eSBjorn Pettersson   unsigned AllocaAS = Callee->getParent()->getDataLayout().getAllocaAddrSpace();
2232652168a9SFedor Sergeev   for (unsigned I = 0, E = Call.arg_size(); I != E; ++I)
2233652168a9SFedor Sergeev     if (Call.isByValArgument(I)) {
2234652168a9SFedor Sergeev       PointerType *PTy = cast<PointerType>(Call.getArgOperand(I)->getType());
22353851496eSBjorn Pettersson       if (PTy->getAddressSpace() != AllocaAS)
2236*201498c6SMircea Trofin         return InlineResult::failure("byval arguments without alloca"
2237c0aa4b75SDavid Bolvansky                                      " address space");
22383851496eSBjorn Pettersson     }
22393851496eSBjorn Pettersson 
22407adc3a2bSChandler Carruth   // Calls to functions with always-inline attributes should be inlined
22417adc3a2bSChandler Carruth   // whenever possible.
2242652168a9SFedor Sergeev   if (Call.hasFnAttr(Attribute::AlwaysInline)) {
224315b17d0aSYevgeny Rouban     auto IsViable = isInlineViable(*Callee);
22445466597fSMircea Trofin     if (IsViable.isSuccess())
2245*201498c6SMircea Trofin       return InlineResult::success();
2246*201498c6SMircea Trofin     return InlineResult::failure(IsViable.getFailureReason());
22477adc3a2bSChandler Carruth   }
22487adc3a2bSChandler Carruth 
22497adc3a2bSChandler Carruth   // Never inline functions with conflicting attributes (unless callee has
22507adc3a2bSChandler Carruth   // always-inline attribute).
2251652168a9SFedor Sergeev   Function *Caller = Call.getCaller();
2252f9ca75f1STeresa Johnson   if (!functionsHaveCompatibleAttributes(Caller, Callee, CalleeTTI, GetTLI))
2253*201498c6SMircea Trofin     return InlineResult::failure("conflicting attributes");
22547adc3a2bSChandler Carruth 
22557adc3a2bSChandler Carruth   // Don't inline this call if the caller has the optnone attribute.
225685bd3978SEvandro Menezes   if (Caller->hasOptNone())
2257*201498c6SMircea Trofin     return InlineResult::failure("optnone attribute");
22587adc3a2bSChandler Carruth 
225977eeac3dSManoj Gupta   // Don't inline a function that treats null pointer as valid into a caller
226077eeac3dSManoj Gupta   // that does not have this attribute.
226177eeac3dSManoj Gupta   if (!Caller->nullPointerIsDefined() && Callee->nullPointerIsDefined())
2262*201498c6SMircea Trofin     return InlineResult::failure("nullptr definitions incompatible");
226377eeac3dSManoj Gupta 
2264c0aa4b75SDavid Bolvansky   // Don't inline functions which can be interposed at link-time.
2265c0aa4b75SDavid Bolvansky   if (Callee->isInterposable())
2266*201498c6SMircea Trofin     return InlineResult::failure("interposable");
2267c0aa4b75SDavid Bolvansky 
2268c0aa4b75SDavid Bolvansky   // Don't inline functions marked noinline.
2269c0aa4b75SDavid Bolvansky   if (Callee->hasFnAttribute(Attribute::NoInline))
2270*201498c6SMircea Trofin     return InlineResult::failure("noinline function attribute");
2271c0aa4b75SDavid Bolvansky 
2272c0aa4b75SDavid Bolvansky   // Don't inline call sites marked noinline.
2273652168a9SFedor Sergeev   if (Call.isNoInline())
2274*201498c6SMircea Trofin     return InlineResult::failure("noinline call site attribute");
2275*201498c6SMircea Trofin 
2276*201498c6SMircea Trofin   return None;
2277*201498c6SMircea Trofin }
2278*201498c6SMircea Trofin 
2279*201498c6SMircea Trofin InlineCost llvm::getInlineCost(
2280*201498c6SMircea Trofin     CallBase &Call, Function *Callee, const InlineParams &Params,
2281*201498c6SMircea Trofin     TargetTransformInfo &CalleeTTI,
2282*201498c6SMircea Trofin     std::function<AssumptionCache &(Function &)> &GetAssumptionCache,
2283*201498c6SMircea Trofin     Optional<function_ref<BlockFrequencyInfo &(Function &)>> GetBFI,
2284*201498c6SMircea Trofin     function_ref<const TargetLibraryInfo &(Function &)> GetTLI,
2285*201498c6SMircea Trofin     ProfileSummaryInfo *PSI, OptimizationRemarkEmitter *ORE) {
2286*201498c6SMircea Trofin 
2287*201498c6SMircea Trofin   auto UserDecision =
2288*201498c6SMircea Trofin       llvm::getAttributeBasedInliningDecision(Call, Callee, CalleeTTI, GetTLI);
2289*201498c6SMircea Trofin 
2290*201498c6SMircea Trofin   if (UserDecision.hasValue()) {
2291*201498c6SMircea Trofin     if (UserDecision->isSuccess())
2292*201498c6SMircea Trofin       return llvm::InlineCost::getAlways("always inline attribute");
2293*201498c6SMircea Trofin     return llvm::InlineCost::getNever(UserDecision->getFailureReason());
2294*201498c6SMircea Trofin   }
22957adc3a2bSChandler Carruth 
2296d34e60caSNicola Zaghen   LLVM_DEBUG(llvm::dbgs() << "      Analyzing call of " << Callee->getName()
2297*201498c6SMircea Trofin                           << "... (caller:" << Call.getCaller()->getName()
2298*201498c6SMircea Trofin                           << ")\n");
22997adc3a2bSChandler Carruth 
230006408758SMircea Trofin   InlineCostCallAnalyzer CA(CalleeTTI, GetAssumptionCache, GetBFI, PSI, ORE,
230106408758SMircea Trofin                             *Callee, Call, Params);
230293ac81ccSMircea Trofin   InlineResult ShouldInline = CA.analyze();
23037adc3a2bSChandler Carruth 
2304d34e60caSNicola Zaghen   LLVM_DEBUG(CA.dump());
23057adc3a2bSChandler Carruth 
23067adc3a2bSChandler Carruth   // Check if there was a reason to force inlining or no inlining.
23075466597fSMircea Trofin   if (!ShouldInline.isSuccess() && CA.getCost() < CA.getThreshold())
23085466597fSMircea Trofin     return InlineCost::getNever(ShouldInline.getFailureReason());
23095466597fSMircea Trofin   if (ShouldInline.isSuccess() && CA.getCost() >= CA.getThreshold())
2310c0aa4b75SDavid Bolvansky     return InlineCost::getAlways("empty function");
23117adc3a2bSChandler Carruth 
23127adc3a2bSChandler Carruth   return llvm::InlineCost::get(CA.getCost(), CA.getThreshold());
23137adc3a2bSChandler Carruth }
23147adc3a2bSChandler Carruth 
231515b17d0aSYevgeny Rouban InlineResult llvm::isInlineViable(Function &F) {
23167adc3a2bSChandler Carruth   bool ReturnsTwice = F.hasFnAttribute(Attribute::ReturnsTwice);
23177adc3a2bSChandler Carruth   for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) {
2318639b29b1SNick Desaulniers     // Disallow inlining of functions which contain indirect branches.
231915b17d0aSYevgeny Rouban     if (isa<IndirectBrInst>(BI->getTerminator()))
23205466597fSMircea Trofin       return InlineResult::failure("contains indirect branches");
232115b17d0aSYevgeny Rouban 
2322639b29b1SNick Desaulniers     // Disallow inlining of blockaddresses which are used by non-callbr
2323639b29b1SNick Desaulniers     // instructions.
23246a84cd3bSNick Desaulniers     if (BI->hasAddressTaken())
2325639b29b1SNick Desaulniers       for (User *U : BlockAddress::get(&*BI)->users())
2326639b29b1SNick Desaulniers         if (!isa<CallBrInst>(*U))
23275466597fSMircea Trofin           return InlineResult::failure("blockaddress used outside of callbr");
23287adc3a2bSChandler Carruth 
23295a82c916SDuncan P. N. Exon Smith     for (auto &II : *BI) {
2330652168a9SFedor Sergeev       CallBase *Call = dyn_cast<CallBase>(&II);
2331652168a9SFedor Sergeev       if (!Call)
23327adc3a2bSChandler Carruth         continue;
23337adc3a2bSChandler Carruth 
23347adc3a2bSChandler Carruth       // Disallow recursive calls.
2335652168a9SFedor Sergeev       if (&F == Call->getCalledFunction())
23365466597fSMircea Trofin         return InlineResult::failure("recursive call");
23377adc3a2bSChandler Carruth 
23387adc3a2bSChandler Carruth       // Disallow calls which expose returns-twice to a function not previously
23397adc3a2bSChandler Carruth       // attributed as such.
2340652168a9SFedor Sergeev       if (!ReturnsTwice && isa<CallInst>(Call) &&
2341652168a9SFedor Sergeev           cast<CallInst>(Call)->canReturnTwice())
23425466597fSMircea Trofin         return InlineResult::failure("exposes returns-twice attribute");
23437adc3a2bSChandler Carruth 
2344652168a9SFedor Sergeev       if (Call->getCalledFunction())
2345652168a9SFedor Sergeev         switch (Call->getCalledFunction()->getIntrinsicID()) {
23461636651eSFlorian Hahn         default:
23471636651eSFlorian Hahn           break;
234806408758SMircea Trofin         case llvm::Intrinsic::icall_branch_funnel:
23494296ea72SVitaly Buka           // Disallow inlining of @llvm.icall.branch.funnel because current
23504296ea72SVitaly Buka           // backend can't separate call targets from call arguments.
23515466597fSMircea Trofin           return InlineResult::failure(
23525466597fSMircea Trofin               "disallowed inlining of @llvm.icall.branch.funnel");
235306408758SMircea Trofin         case llvm::Intrinsic::localescape:
23547adc3a2bSChandler Carruth           // Disallow inlining functions that call @llvm.localescape. Doing this
23557adc3a2bSChandler Carruth           // correctly would require major changes to the inliner.
23565466597fSMircea Trofin           return InlineResult::failure(
23575466597fSMircea Trofin               "disallowed inlining of @llvm.localescape");
23581636651eSFlorian Hahn         case llvm::Intrinsic::vastart:
235906408758SMircea Trofin           // Disallow inlining of functions that initialize VarArgs with
236006408758SMircea Trofin           // va_start.
23615466597fSMircea Trofin           return InlineResult::failure(
23625466597fSMircea Trofin               "contains VarArgs initialized with va_start");
23637adc3a2bSChandler Carruth         }
23647adc3a2bSChandler Carruth     }
23651636651eSFlorian Hahn   }
23667adc3a2bSChandler Carruth 
23675466597fSMircea Trofin   return InlineResult::success();
23687adc3a2bSChandler Carruth }
23691c57cc2bSEaswaran Raman 
23701c57cc2bSEaswaran Raman // APIs to create InlineParams based on command line flags and/or other
23711c57cc2bSEaswaran Raman // parameters.
23721c57cc2bSEaswaran Raman 
23731c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams(int Threshold) {
23741c57cc2bSEaswaran Raman   InlineParams Params;
23751c57cc2bSEaswaran Raman 
23761c57cc2bSEaswaran Raman   // This field is the threshold to use for a callee by default. This is
23771c57cc2bSEaswaran Raman   // derived from one or more of:
23781c57cc2bSEaswaran Raman   //  * optimization or size-optimization levels,
23791c57cc2bSEaswaran Raman   //  * a value passed to createFunctionInliningPass function, or
23801c57cc2bSEaswaran Raman   //  * the -inline-threshold flag.
23811c57cc2bSEaswaran Raman   //  If the -inline-threshold flag is explicitly specified, that is used
23821c57cc2bSEaswaran Raman   //  irrespective of anything else.
23831c57cc2bSEaswaran Raman   if (InlineThreshold.getNumOccurrences() > 0)
23841c57cc2bSEaswaran Raman     Params.DefaultThreshold = InlineThreshold;
23851c57cc2bSEaswaran Raman   else
23861c57cc2bSEaswaran Raman     Params.DefaultThreshold = Threshold;
23871c57cc2bSEaswaran Raman 
23881c57cc2bSEaswaran Raman   // Set the HintThreshold knob from the -inlinehint-threshold.
23891c57cc2bSEaswaran Raman   Params.HintThreshold = HintThreshold;
23901c57cc2bSEaswaran Raman 
23911c57cc2bSEaswaran Raman   // Set the HotCallSiteThreshold knob from the -hot-callsite-threshold.
23921c57cc2bSEaswaran Raman   Params.HotCallSiteThreshold = HotCallSiteThreshold;
23931c57cc2bSEaswaran Raman 
2394974d4eeaSEaswaran Raman   // If the -locally-hot-callsite-threshold is explicitly specified, use it to
2395974d4eeaSEaswaran Raman   // populate LocallyHotCallSiteThreshold. Later, we populate
2396974d4eeaSEaswaran Raman   // Params.LocallyHotCallSiteThreshold from -locally-hot-callsite-threshold if
2397974d4eeaSEaswaran Raman   // we know that optimization level is O3 (in the getInlineParams variant that
2398974d4eeaSEaswaran Raman   // takes the opt and size levels).
2399974d4eeaSEaswaran Raman   // FIXME: Remove this check (and make the assignment unconditional) after
2400974d4eeaSEaswaran Raman   // addressing size regression issues at O2.
2401974d4eeaSEaswaran Raman   if (LocallyHotCallSiteThreshold.getNumOccurrences() > 0)
2402974d4eeaSEaswaran Raman     Params.LocallyHotCallSiteThreshold = LocallyHotCallSiteThreshold;
2403974d4eeaSEaswaran Raman 
24045a956c85SMircea Trofin   // Set the ColdCallSiteThreshold knob from the
24055a956c85SMircea Trofin   // -inline-cold-callsite-threshold.
240612585b01SEaswaran Raman   Params.ColdCallSiteThreshold = ColdCallSiteThreshold;
240712585b01SEaswaran Raman 
24081c57cc2bSEaswaran Raman   // Set the OptMinSizeThreshold and OptSizeThreshold params only if the
24091c57cc2bSEaswaran Raman   // -inlinehint-threshold commandline option is not explicitly given. If that
24101c57cc2bSEaswaran Raman   // option is present, then its value applies even for callees with size and
24111c57cc2bSEaswaran Raman   // minsize attributes.
24121c57cc2bSEaswaran Raman   // If the -inline-threshold is not specified, set the ColdThreshold from the
24131c57cc2bSEaswaran Raman   // -inlinecold-threshold even if it is not explicitly passed. If
24141c57cc2bSEaswaran Raman   // -inline-threshold is specified, then -inlinecold-threshold needs to be
24151c57cc2bSEaswaran Raman   // explicitly specified to set the ColdThreshold knob
24161c57cc2bSEaswaran Raman   if (InlineThreshold.getNumOccurrences() == 0) {
24171c57cc2bSEaswaran Raman     Params.OptMinSizeThreshold = InlineConstants::OptMinSizeThreshold;
24181c57cc2bSEaswaran Raman     Params.OptSizeThreshold = InlineConstants::OptSizeThreshold;
24191c57cc2bSEaswaran Raman     Params.ColdThreshold = ColdThreshold;
24201c57cc2bSEaswaran Raman   } else if (ColdThreshold.getNumOccurrences() > 0) {
24211c57cc2bSEaswaran Raman     Params.ColdThreshold = ColdThreshold;
24221c57cc2bSEaswaran Raman   }
24231c57cc2bSEaswaran Raman   return Params;
24241c57cc2bSEaswaran Raman }
24251c57cc2bSEaswaran Raman 
24261c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams() {
24277f37a802STeresa Johnson   return getInlineParams(DefaultThreshold);
24281c57cc2bSEaswaran Raman }
24291c57cc2bSEaswaran Raman 
24301c57cc2bSEaswaran Raman // Compute the default threshold for inlining based on the opt level and the
24311c57cc2bSEaswaran Raman // size opt level.
24321c57cc2bSEaswaran Raman static int computeThresholdFromOptLevels(unsigned OptLevel,
24331c57cc2bSEaswaran Raman                                          unsigned SizeOptLevel) {
24341c57cc2bSEaswaran Raman   if (OptLevel > 2)
24351c57cc2bSEaswaran Raman     return InlineConstants::OptAggressiveThreshold;
24361c57cc2bSEaswaran Raman   if (SizeOptLevel == 1) // -Os
24371c57cc2bSEaswaran Raman     return InlineConstants::OptSizeThreshold;
24381c57cc2bSEaswaran Raman   if (SizeOptLevel == 2) // -Oz
24391c57cc2bSEaswaran Raman     return InlineConstants::OptMinSizeThreshold;
24407f37a802STeresa Johnson   return DefaultThreshold;
24411c57cc2bSEaswaran Raman }
24421c57cc2bSEaswaran Raman 
24431c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams(unsigned OptLevel, unsigned SizeOptLevel) {
2444974d4eeaSEaswaran Raman   auto Params =
2445974d4eeaSEaswaran Raman       getInlineParams(computeThresholdFromOptLevels(OptLevel, SizeOptLevel));
2446974d4eeaSEaswaran Raman   // At O3, use the value of -locally-hot-callsite-threshold option to populate
2447974d4eeaSEaswaran Raman   // Params.LocallyHotCallSiteThreshold. Below O3, this flag has effect only
2448974d4eeaSEaswaran Raman   // when it is specified explicitly.
2449974d4eeaSEaswaran Raman   if (OptLevel > 2)
2450974d4eeaSEaswaran Raman     Params.LocallyHotCallSiteThreshold = LocallyHotCallSiteThreshold;
2451974d4eeaSEaswaran Raman   return Params;
24521c57cc2bSEaswaran Raman }
2453