17adc3a2bSChandler Carruth //===- InlineCost.cpp - Cost analysis for inliner -------------------------===// 27adc3a2bSChandler Carruth // 37adc3a2bSChandler Carruth // The LLVM Compiler Infrastructure 47adc3a2bSChandler Carruth // 57adc3a2bSChandler Carruth // This file is distributed under the University of Illinois Open Source 67adc3a2bSChandler Carruth // License. See LICENSE.TXT for details. 77adc3a2bSChandler Carruth // 87adc3a2bSChandler Carruth //===----------------------------------------------------------------------===// 97adc3a2bSChandler Carruth // 107adc3a2bSChandler Carruth // This file implements inline cost analysis. 117adc3a2bSChandler Carruth // 127adc3a2bSChandler Carruth //===----------------------------------------------------------------------===// 137adc3a2bSChandler Carruth 147adc3a2bSChandler Carruth #include "llvm/Analysis/InlineCost.h" 157adc3a2bSChandler Carruth #include "llvm/ADT/STLExtras.h" 167adc3a2bSChandler Carruth #include "llvm/ADT/SetVector.h" 177adc3a2bSChandler Carruth #include "llvm/ADT/SmallPtrSet.h" 187adc3a2bSChandler Carruth #include "llvm/ADT/SmallVector.h" 197adc3a2bSChandler Carruth #include "llvm/ADT/Statistic.h" 20aec2fa35SDaniel Jasper #include "llvm/Analysis/AssumptionCache.h" 2112585b01SEaswaran Raman #include "llvm/Analysis/BlockFrequencyInfo.h" 227adc3a2bSChandler Carruth #include "llvm/Analysis/CodeMetrics.h" 237adc3a2bSChandler Carruth #include "llvm/Analysis/ConstantFolding.h" 247adc3a2bSChandler Carruth #include "llvm/Analysis/InstructionSimplify.h" 2571069cf6SEaswaran Raman #include "llvm/Analysis/ProfileSummaryInfo.h" 267adc3a2bSChandler Carruth #include "llvm/Analysis/TargetTransformInfo.h" 277adc3a2bSChandler Carruth #include "llvm/IR/CallSite.h" 287adc3a2bSChandler Carruth #include "llvm/IR/CallingConv.h" 297adc3a2bSChandler Carruth #include "llvm/IR/DataLayout.h" 307adc3a2bSChandler Carruth #include "llvm/IR/GetElementPtrTypeIterator.h" 317adc3a2bSChandler Carruth #include "llvm/IR/GlobalAlias.h" 327adc3a2bSChandler Carruth #include "llvm/IR/InstVisitor.h" 337adc3a2bSChandler Carruth #include "llvm/IR/IntrinsicInst.h" 347adc3a2bSChandler Carruth #include "llvm/IR/Operator.h" 357adc3a2bSChandler Carruth #include "llvm/Support/Debug.h" 367adc3a2bSChandler Carruth #include "llvm/Support/raw_ostream.h" 377adc3a2bSChandler Carruth 387adc3a2bSChandler Carruth using namespace llvm; 397adc3a2bSChandler Carruth 407adc3a2bSChandler Carruth #define DEBUG_TYPE "inline-cost" 417adc3a2bSChandler Carruth 427adc3a2bSChandler Carruth STATISTIC(NumCallsAnalyzed, "Number of call sites analyzed"); 437adc3a2bSChandler Carruth 441c57cc2bSEaswaran Raman static cl::opt<int> InlineThreshold( 45f4bb2f0dSEaswaran Raman "inline-threshold", cl::Hidden, cl::init(225), cl::ZeroOrMore, 46f4bb2f0dSEaswaran Raman cl::desc("Control the amount of inlining to perform (default = 225)")); 47f4bb2f0dSEaswaran Raman 48f4bb2f0dSEaswaran Raman static cl::opt<int> HintThreshold( 49f4bb2f0dSEaswaran Raman "inlinehint-threshold", cl::Hidden, cl::init(325), 50f4bb2f0dSEaswaran Raman cl::desc("Threshold for inlining functions with inline hint")); 51f4bb2f0dSEaswaran Raman 5212585b01SEaswaran Raman static cl::opt<int> 5312585b01SEaswaran Raman ColdCallSiteThreshold("inline-cold-callsite-threshold", cl::Hidden, 5412585b01SEaswaran Raman cl::init(45), 5512585b01SEaswaran Raman cl::desc("Threshold for inlining cold callsites")); 5612585b01SEaswaran Raman 57f4bb2f0dSEaswaran Raman // We introduce this threshold to help performance of instrumentation based 58f4bb2f0dSEaswaran Raman // PGO before we actually hook up inliner with analysis passes such as BPI and 59f4bb2f0dSEaswaran Raman // BFI. 60f4bb2f0dSEaswaran Raman static cl::opt<int> ColdThreshold( 61c103ef89SEaswaran Raman "inlinecold-threshold", cl::Hidden, cl::init(45), 62f4bb2f0dSEaswaran Raman cl::desc("Threshold for inlining functions with cold attribute")); 63f4bb2f0dSEaswaran Raman 64de39cb93SDehao Chen static cl::opt<int> 65de39cb93SDehao Chen HotCallSiteThreshold("hot-callsite-threshold", cl::Hidden, cl::init(3000), 66de39cb93SDehao Chen cl::ZeroOrMore, 67de39cb93SDehao Chen cl::desc("Threshold for hot callsites ")); 68de39cb93SDehao Chen 69974d4eeaSEaswaran Raman static cl::opt<int> LocallyHotCallSiteThreshold( 70974d4eeaSEaswaran Raman "locally-hot-callsite-threshold", cl::Hidden, cl::init(525), cl::ZeroOrMore, 71974d4eeaSEaswaran Raman cl::desc("Threshold for locally hot callsites ")); 72974d4eeaSEaswaran Raman 73c5fa6358SEaswaran Raman static cl::opt<int> ColdCallSiteRelFreq( 74c5fa6358SEaswaran Raman "cold-callsite-rel-freq", cl::Hidden, cl::init(2), cl::ZeroOrMore, 75c5fa6358SEaswaran Raman cl::desc("Maxmimum block frequency, expressed as a percentage of caller's " 76c5fa6358SEaswaran Raman "entry frequency, for a callsite to be cold in the absence of " 77c5fa6358SEaswaran Raman "profile information.")); 78c5fa6358SEaswaran Raman 79974d4eeaSEaswaran Raman static cl::opt<int> HotCallSiteRelFreq( 80974d4eeaSEaswaran Raman "hot-callsite-rel-freq", cl::Hidden, cl::init(60), cl::ZeroOrMore, 81ff77cc75SEaswaran Raman cl::desc("Minimum block frequency, expressed as a multiple of caller's " 82974d4eeaSEaswaran Raman "entry frequency, for a callsite to be hot in the absence of " 83974d4eeaSEaswaran Raman "profile information.")); 84974d4eeaSEaswaran Raman 857adc3a2bSChandler Carruth namespace { 867adc3a2bSChandler Carruth 877adc3a2bSChandler Carruth class CallAnalyzer : public InstVisitor<CallAnalyzer, bool> { 887adc3a2bSChandler Carruth typedef InstVisitor<CallAnalyzer, bool> Base; 897adc3a2bSChandler Carruth friend class InstVisitor<CallAnalyzer, bool>; 907adc3a2bSChandler Carruth 917adc3a2bSChandler Carruth /// The TargetTransformInfo available for this compilation. 927adc3a2bSChandler Carruth const TargetTransformInfo &TTI; 937adc3a2bSChandler Carruth 94aec2fa35SDaniel Jasper /// Getter for the cache of @llvm.assume intrinsics. 95aec2fa35SDaniel Jasper std::function<AssumptionCache &(Function &)> &GetAssumptionCache; 96aec2fa35SDaniel Jasper 9712585b01SEaswaran Raman /// Getter for BlockFrequencyInfo 9812585b01SEaswaran Raman Optional<function_ref<BlockFrequencyInfo &(Function &)>> &GetBFI; 9912585b01SEaswaran Raman 10071069cf6SEaswaran Raman /// Profile summary information. 10171069cf6SEaswaran Raman ProfileSummaryInfo *PSI; 10271069cf6SEaswaran Raman 103f3d122cdSPiotr Padlewski /// The called function. 1047adc3a2bSChandler Carruth Function &F; 1057adc3a2bSChandler Carruth 10685be8ca8SEric Christopher // Cache the DataLayout since we use it a lot. 10785be8ca8SEric Christopher const DataLayout &DL; 10885be8ca8SEric Christopher 109f3d122cdSPiotr Padlewski /// The candidate callsite being analyzed. Please do not use this to do 110f3d122cdSPiotr Padlewski /// analysis in the caller function; we want the inline cost query to be 111f3d122cdSPiotr Padlewski /// easily cacheable. Instead, use the cover function paramHasAttr. 1127adc3a2bSChandler Carruth CallSite CandidateCS; 1137adc3a2bSChandler Carruth 114f3d122cdSPiotr Padlewski /// Tunable parameters that control the analysis. 1151c57cc2bSEaswaran Raman const InlineParams &Params; 1161c57cc2bSEaswaran Raman 1177adc3a2bSChandler Carruth int Threshold; 1187adc3a2bSChandler Carruth int Cost; 1197adc3a2bSChandler Carruth 1207adc3a2bSChandler Carruth bool IsCallerRecursive; 1217adc3a2bSChandler Carruth bool IsRecursiveCall; 1227adc3a2bSChandler Carruth bool ExposesReturnsTwice; 1237adc3a2bSChandler Carruth bool HasDynamicAlloca; 1247adc3a2bSChandler Carruth bool ContainsNoDuplicateCall; 1257adc3a2bSChandler Carruth bool HasReturn; 1267adc3a2bSChandler Carruth bool HasIndirectBr; 1277adc3a2bSChandler Carruth bool HasFrameEscape; 1287adc3a2bSChandler Carruth 1297adc3a2bSChandler Carruth /// Number of bytes allocated statically by the callee. 1307adc3a2bSChandler Carruth uint64_t AllocatedSize; 1317adc3a2bSChandler Carruth unsigned NumInstructions, NumVectorInstructions; 13251b809bfSEaswaran Raman int VectorBonus, TenPercentVectorBonus; 13351b809bfSEaswaran Raman // Bonus to be applied when the callee has only one reachable basic block. 13451b809bfSEaswaran Raman int SingleBBBonus; 1357adc3a2bSChandler Carruth 136f3d122cdSPiotr Padlewski /// While we walk the potentially-inlined instructions, we build up and 137f3d122cdSPiotr Padlewski /// maintain a mapping of simplified values specific to this callsite. The 138f3d122cdSPiotr Padlewski /// idea is to propagate any special information we have about arguments to 139f3d122cdSPiotr Padlewski /// this call through the inlinable section of the function, and account for 140f3d122cdSPiotr Padlewski /// likely simplifications post-inlining. The most important aspect we track 141f3d122cdSPiotr Padlewski /// is CFG altering simplifications -- when we prove a basic block dead, that 142f3d122cdSPiotr Padlewski /// can cause dramatic shifts in the cost of inlining a function. 1437adc3a2bSChandler Carruth DenseMap<Value *, Constant *> SimplifiedValues; 1447adc3a2bSChandler Carruth 145f3d122cdSPiotr Padlewski /// Keep track of the values which map back (through function arguments) to 146f3d122cdSPiotr Padlewski /// allocas on the caller stack which could be simplified through SROA. 1477adc3a2bSChandler Carruth DenseMap<Value *, Value *> SROAArgValues; 1487adc3a2bSChandler Carruth 149f3d122cdSPiotr Padlewski /// The mapping of caller Alloca values to their accumulated cost savings. If 150f3d122cdSPiotr Padlewski /// we have to disable SROA for one of the allocas, this tells us how much 151f3d122cdSPiotr Padlewski /// cost must be added. 1527adc3a2bSChandler Carruth DenseMap<Value *, int> SROAArgCosts; 1537adc3a2bSChandler Carruth 154f3d122cdSPiotr Padlewski /// Keep track of values which map to a pointer base and constant offset. 1557adc3a2bSChandler Carruth DenseMap<Value *, std::pair<Value *, APInt>> ConstantOffsetPtrs; 1567adc3a2bSChandler Carruth 1577adc3a2bSChandler Carruth // Custom simplification helper routines. 1587adc3a2bSChandler Carruth bool isAllocaDerivedArg(Value *V); 1597adc3a2bSChandler Carruth bool lookupSROAArgAndCost(Value *V, Value *&Arg, 1607adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator &CostIt); 1617adc3a2bSChandler Carruth void disableSROA(DenseMap<Value *, int>::iterator CostIt); 1627adc3a2bSChandler Carruth void disableSROA(Value *V); 1637adc3a2bSChandler Carruth void accumulateSROACost(DenseMap<Value *, int>::iterator CostIt, 1647adc3a2bSChandler Carruth int InstructionCost); 165201b191bSHaicheng Wu bool isGEPFree(GetElementPtrInst &GEP); 1667adc3a2bSChandler Carruth bool accumulateGEPOffset(GEPOperator &GEP, APInt &Offset); 1677adc3a2bSChandler Carruth bool simplifyCallSite(Function *F, CallSite CS); 168617f6364SEaswaran Raman template <typename Callable> 169617f6364SEaswaran Raman bool simplifyInstruction(Instruction &I, Callable Evaluate); 1707adc3a2bSChandler Carruth ConstantInt *stripAndComputeInBoundsConstantOffsets(Value *&V); 1717adc3a2bSChandler Carruth 1727adc3a2bSChandler Carruth /// Return true if the given argument to the function being considered for 1737adc3a2bSChandler Carruth /// inlining has the given attribute set either at the call site or the 1747adc3a2bSChandler Carruth /// function declaration. Primarily used to inspect call site specific 1757adc3a2bSChandler Carruth /// attributes since these can be more precise than the ones on the callee 1767adc3a2bSChandler Carruth /// itself. 1777adc3a2bSChandler Carruth bool paramHasAttr(Argument *A, Attribute::AttrKind Attr); 1787adc3a2bSChandler Carruth 1797adc3a2bSChandler Carruth /// Return true if the given value is known non null within the callee if 1807adc3a2bSChandler Carruth /// inlined through this particular callsite. 1817adc3a2bSChandler Carruth bool isKnownNonNullInCallee(Value *V); 1827adc3a2bSChandler Carruth 183f4bb2f0dSEaswaran Raman /// Update Threshold based on callsite properties such as callee 184f4bb2f0dSEaswaran Raman /// attributes and callee hotness for PGO builds. The Callee is explicitly 185f4bb2f0dSEaswaran Raman /// passed to support analyzing indirect calls whose target is inferred by 186f4bb2f0dSEaswaran Raman /// analysis. 187f4bb2f0dSEaswaran Raman void updateThreshold(CallSite CS, Function &Callee); 188f4bb2f0dSEaswaran Raman 1899a3fc17aSEaswaran Raman /// Return true if size growth is allowed when inlining the callee at CS. 1909a3fc17aSEaswaran Raman bool allowSizeGrowth(CallSite CS); 1919a3fc17aSEaswaran Raman 192c5fa6358SEaswaran Raman /// Return true if \p CS is a cold callsite. 193c5fa6358SEaswaran Raman bool isColdCallSite(CallSite CS, BlockFrequencyInfo *CallerBFI); 194c5fa6358SEaswaran Raman 195974d4eeaSEaswaran Raman /// Return a higher threshold if \p CS is a hot callsite. 196974d4eeaSEaswaran Raman Optional<int> getHotCallSiteThreshold(CallSite CS, 197974d4eeaSEaswaran Raman BlockFrequencyInfo *CallerBFI); 198974d4eeaSEaswaran Raman 1997adc3a2bSChandler Carruth // Custom analysis routines. 2007adc3a2bSChandler Carruth bool analyzeBlock(BasicBlock *BB, SmallPtrSetImpl<const Value *> &EphValues); 2017adc3a2bSChandler Carruth 2027adc3a2bSChandler Carruth // Disable several entry points to the visitor so we don't accidentally use 2037adc3a2bSChandler Carruth // them by declaring but not defining them here. 204567556aaSChad Rosier void visit(Module *); 205567556aaSChad Rosier void visit(Module &); 206567556aaSChad Rosier void visit(Function *); 207567556aaSChad Rosier void visit(Function &); 208567556aaSChad Rosier void visit(BasicBlock *); 209567556aaSChad Rosier void visit(BasicBlock &); 2107adc3a2bSChandler Carruth 2117adc3a2bSChandler Carruth // Provide base case for our instruction visit. 2127adc3a2bSChandler Carruth bool visitInstruction(Instruction &I); 2137adc3a2bSChandler Carruth 2147adc3a2bSChandler Carruth // Our visit overrides. 2157adc3a2bSChandler Carruth bool visitAlloca(AllocaInst &I); 2167adc3a2bSChandler Carruth bool visitPHI(PHINode &I); 2177adc3a2bSChandler Carruth bool visitGetElementPtr(GetElementPtrInst &I); 2187adc3a2bSChandler Carruth bool visitBitCast(BitCastInst &I); 2197adc3a2bSChandler Carruth bool visitPtrToInt(PtrToIntInst &I); 2207adc3a2bSChandler Carruth bool visitIntToPtr(IntToPtrInst &I); 2217adc3a2bSChandler Carruth bool visitCastInst(CastInst &I); 2227adc3a2bSChandler Carruth bool visitUnaryInstruction(UnaryInstruction &I); 2237adc3a2bSChandler Carruth bool visitCmpInst(CmpInst &I); 2242e1c050eSChad Rosier bool visitAnd(BinaryOperator &I); 2252e1c050eSChad Rosier bool visitOr(BinaryOperator &I); 2267adc3a2bSChandler Carruth bool visitSub(BinaryOperator &I); 2277adc3a2bSChandler Carruth bool visitBinaryOperator(BinaryOperator &I); 2287adc3a2bSChandler Carruth bool visitLoad(LoadInst &I); 2297adc3a2bSChandler Carruth bool visitStore(StoreInst &I); 2307adc3a2bSChandler Carruth bool visitExtractValue(ExtractValueInst &I); 2317adc3a2bSChandler Carruth bool visitInsertValue(InsertValueInst &I); 2327adc3a2bSChandler Carruth bool visitCallSite(CallSite CS); 2337adc3a2bSChandler Carruth bool visitReturnInst(ReturnInst &RI); 2347adc3a2bSChandler Carruth bool visitBranchInst(BranchInst &BI); 2357adc3a2bSChandler Carruth bool visitSwitchInst(SwitchInst &SI); 2367adc3a2bSChandler Carruth bool visitIndirectBrInst(IndirectBrInst &IBI); 2377adc3a2bSChandler Carruth bool visitResumeInst(ResumeInst &RI); 2387adc3a2bSChandler Carruth bool visitCleanupReturnInst(CleanupReturnInst &RI); 2397adc3a2bSChandler Carruth bool visitCatchReturnInst(CatchReturnInst &RI); 2407adc3a2bSChandler Carruth bool visitUnreachableInst(UnreachableInst &I); 2417adc3a2bSChandler Carruth 2427adc3a2bSChandler Carruth public: 243ab6a6837SSean Silva CallAnalyzer(const TargetTransformInfo &TTI, 244aec2fa35SDaniel Jasper std::function<AssumptionCache &(Function &)> &GetAssumptionCache, 24512585b01SEaswaran Raman Optional<function_ref<BlockFrequencyInfo &(Function &)>> &GetBFI, 2461c57cc2bSEaswaran Raman ProfileSummaryInfo *PSI, Function &Callee, CallSite CSArg, 2471c57cc2bSEaswaran Raman const InlineParams &Params) 24812585b01SEaswaran Raman : TTI(TTI), GetAssumptionCache(GetAssumptionCache), GetBFI(GetBFI), 24985be8ca8SEric Christopher PSI(PSI), F(Callee), DL(F.getParent()->getDataLayout()), 25085be8ca8SEric Christopher CandidateCS(CSArg), Params(Params), Threshold(Params.DefaultThreshold), 25185be8ca8SEric Christopher Cost(0), IsCallerRecursive(false), IsRecursiveCall(false), 25285be8ca8SEric Christopher ExposesReturnsTwice(false), HasDynamicAlloca(false), 25385be8ca8SEric Christopher ContainsNoDuplicateCall(false), HasReturn(false), HasIndirectBr(false), 25485be8ca8SEric Christopher HasFrameEscape(false), AllocatedSize(0), NumInstructions(0), 25551b809bfSEaswaran Raman NumVectorInstructions(0), VectorBonus(0), SingleBBBonus(0), 25651b809bfSEaswaran Raman NumConstantArgs(0), NumConstantOffsetPtrArgs(0), NumAllocaArgs(0), 25751b809bfSEaswaran Raman NumConstantPtrCmps(0), NumConstantPtrDiffs(0), 25851b809bfSEaswaran Raman NumInstructionsSimplified(0), SROACostSavings(0), 25951b809bfSEaswaran Raman SROACostSavingsLost(0) {} 2607adc3a2bSChandler Carruth 2617adc3a2bSChandler Carruth bool analyzeCall(CallSite CS); 2627adc3a2bSChandler Carruth 2637adc3a2bSChandler Carruth int getThreshold() { return Threshold; } 2647adc3a2bSChandler Carruth int getCost() { return Cost; } 2657adc3a2bSChandler Carruth 2667adc3a2bSChandler Carruth // Keep a bunch of stats about the cost savings found so we can print them 2677adc3a2bSChandler Carruth // out when debugging. 2687adc3a2bSChandler Carruth unsigned NumConstantArgs; 2697adc3a2bSChandler Carruth unsigned NumConstantOffsetPtrArgs; 2707adc3a2bSChandler Carruth unsigned NumAllocaArgs; 2717adc3a2bSChandler Carruth unsigned NumConstantPtrCmps; 2727adc3a2bSChandler Carruth unsigned NumConstantPtrDiffs; 2737adc3a2bSChandler Carruth unsigned NumInstructionsSimplified; 2747adc3a2bSChandler Carruth unsigned SROACostSavings; 2757adc3a2bSChandler Carruth unsigned SROACostSavingsLost; 2767adc3a2bSChandler Carruth 2777adc3a2bSChandler Carruth void dump(); 2787adc3a2bSChandler Carruth }; 2797adc3a2bSChandler Carruth 2807adc3a2bSChandler Carruth } // namespace 2817adc3a2bSChandler Carruth 2827adc3a2bSChandler Carruth /// \brief Test whether the given value is an Alloca-derived function argument. 2837adc3a2bSChandler Carruth bool CallAnalyzer::isAllocaDerivedArg(Value *V) { 2847adc3a2bSChandler Carruth return SROAArgValues.count(V); 2857adc3a2bSChandler Carruth } 2867adc3a2bSChandler Carruth 2877adc3a2bSChandler Carruth /// \brief Lookup the SROA-candidate argument and cost iterator which V maps to. 2887adc3a2bSChandler Carruth /// Returns false if V does not map to a SROA-candidate. 2897adc3a2bSChandler Carruth bool CallAnalyzer::lookupSROAArgAndCost( 2907adc3a2bSChandler Carruth Value *V, Value *&Arg, DenseMap<Value *, int>::iterator &CostIt) { 2917adc3a2bSChandler Carruth if (SROAArgValues.empty() || SROAArgCosts.empty()) 2927adc3a2bSChandler Carruth return false; 2937adc3a2bSChandler Carruth 2947adc3a2bSChandler Carruth DenseMap<Value *, Value *>::iterator ArgIt = SROAArgValues.find(V); 2957adc3a2bSChandler Carruth if (ArgIt == SROAArgValues.end()) 2967adc3a2bSChandler Carruth return false; 2977adc3a2bSChandler Carruth 2987adc3a2bSChandler Carruth Arg = ArgIt->second; 2997adc3a2bSChandler Carruth CostIt = SROAArgCosts.find(Arg); 3007adc3a2bSChandler Carruth return CostIt != SROAArgCosts.end(); 3017adc3a2bSChandler Carruth } 3027adc3a2bSChandler Carruth 3037adc3a2bSChandler Carruth /// \brief Disable SROA for the candidate marked by this cost iterator. 3047adc3a2bSChandler Carruth /// 3057adc3a2bSChandler Carruth /// This marks the candidate as no longer viable for SROA, and adds the cost 3067adc3a2bSChandler Carruth /// savings associated with it back into the inline cost measurement. 3077adc3a2bSChandler Carruth void CallAnalyzer::disableSROA(DenseMap<Value *, int>::iterator CostIt) { 3087adc3a2bSChandler Carruth // If we're no longer able to perform SROA we need to undo its cost savings 3097adc3a2bSChandler Carruth // and prevent subsequent analysis. 3107adc3a2bSChandler Carruth Cost += CostIt->second; 3117adc3a2bSChandler Carruth SROACostSavings -= CostIt->second; 3127adc3a2bSChandler Carruth SROACostSavingsLost += CostIt->second; 3137adc3a2bSChandler Carruth SROAArgCosts.erase(CostIt); 3147adc3a2bSChandler Carruth } 3157adc3a2bSChandler Carruth 3167adc3a2bSChandler Carruth /// \brief If 'V' maps to a SROA candidate, disable SROA for it. 3177adc3a2bSChandler Carruth void CallAnalyzer::disableSROA(Value *V) { 3187adc3a2bSChandler Carruth Value *SROAArg; 3197adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 3207adc3a2bSChandler Carruth if (lookupSROAArgAndCost(V, SROAArg, CostIt)) 3217adc3a2bSChandler Carruth disableSROA(CostIt); 3227adc3a2bSChandler Carruth } 3237adc3a2bSChandler Carruth 3247adc3a2bSChandler Carruth /// \brief Accumulate the given cost for a particular SROA candidate. 3257adc3a2bSChandler Carruth void CallAnalyzer::accumulateSROACost(DenseMap<Value *, int>::iterator CostIt, 3267adc3a2bSChandler Carruth int InstructionCost) { 3277adc3a2bSChandler Carruth CostIt->second += InstructionCost; 3287adc3a2bSChandler Carruth SROACostSavings += InstructionCost; 3297adc3a2bSChandler Carruth } 3307adc3a2bSChandler Carruth 3317adc3a2bSChandler Carruth /// \brief Accumulate a constant GEP offset into an APInt if possible. 3327adc3a2bSChandler Carruth /// 3337adc3a2bSChandler Carruth /// Returns false if unable to compute the offset for any reason. Respects any 3347adc3a2bSChandler Carruth /// simplified values known during the analysis of this callsite. 3357adc3a2bSChandler Carruth bool CallAnalyzer::accumulateGEPOffset(GEPOperator &GEP, APInt &Offset) { 3367adc3a2bSChandler Carruth unsigned IntPtrWidth = DL.getPointerSizeInBits(); 3377adc3a2bSChandler Carruth assert(IntPtrWidth == Offset.getBitWidth()); 3387adc3a2bSChandler Carruth 3397adc3a2bSChandler Carruth for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP); 3407adc3a2bSChandler Carruth GTI != GTE; ++GTI) { 3417adc3a2bSChandler Carruth ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand()); 3427adc3a2bSChandler Carruth if (!OpC) 3437adc3a2bSChandler Carruth if (Constant *SimpleOp = SimplifiedValues.lookup(GTI.getOperand())) 3447adc3a2bSChandler Carruth OpC = dyn_cast<ConstantInt>(SimpleOp); 3457adc3a2bSChandler Carruth if (!OpC) 3467adc3a2bSChandler Carruth return false; 347567556aaSChad Rosier if (OpC->isZero()) 348567556aaSChad Rosier continue; 3497adc3a2bSChandler Carruth 3507adc3a2bSChandler Carruth // Handle a struct index, which adds its field offset to the pointer. 351ab85225bSPeter Collingbourne if (StructType *STy = GTI.getStructTypeOrNull()) { 3527adc3a2bSChandler Carruth unsigned ElementIdx = OpC->getZExtValue(); 3537adc3a2bSChandler Carruth const StructLayout *SL = DL.getStructLayout(STy); 3547adc3a2bSChandler Carruth Offset += APInt(IntPtrWidth, SL->getElementOffset(ElementIdx)); 3557adc3a2bSChandler Carruth continue; 3567adc3a2bSChandler Carruth } 3577adc3a2bSChandler Carruth 3587adc3a2bSChandler Carruth APInt TypeSize(IntPtrWidth, DL.getTypeAllocSize(GTI.getIndexedType())); 3597adc3a2bSChandler Carruth Offset += OpC->getValue().sextOrTrunc(IntPtrWidth) * TypeSize; 3607adc3a2bSChandler Carruth } 3617adc3a2bSChandler Carruth return true; 3627adc3a2bSChandler Carruth } 3637adc3a2bSChandler Carruth 364201b191bSHaicheng Wu /// \brief Use TTI to check whether a GEP is free. 365201b191bSHaicheng Wu /// 366201b191bSHaicheng Wu /// Respects any simplified values known during the analysis of this callsite. 367201b191bSHaicheng Wu bool CallAnalyzer::isGEPFree(GetElementPtrInst &GEP) { 36861c1bd5aSEvgeny Astigeevich SmallVector<Value *, 4> Operands; 36961c1bd5aSEvgeny Astigeevich Operands.push_back(GEP.getOperand(0)); 370201b191bSHaicheng Wu for (User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end(); I != E; ++I) 371201b191bSHaicheng Wu if (Constant *SimpleOp = SimplifiedValues.lookup(*I)) 37261c1bd5aSEvgeny Astigeevich Operands.push_back(SimpleOp); 373201b191bSHaicheng Wu else 37461c1bd5aSEvgeny Astigeevich Operands.push_back(*I); 37561c1bd5aSEvgeny Astigeevich return TargetTransformInfo::TCC_Free == TTI.getUserCost(&GEP, Operands); 376201b191bSHaicheng Wu } 377201b191bSHaicheng Wu 3787adc3a2bSChandler Carruth bool CallAnalyzer::visitAlloca(AllocaInst &I) { 3797adc3a2bSChandler Carruth // Check whether inlining will turn a dynamic alloca into a static 3800f153424SSanjay Patel // alloca and handle that case. 3817adc3a2bSChandler Carruth if (I.isArrayAllocation()) { 3820f153424SSanjay Patel Constant *Size = SimplifiedValues.lookup(I.getArraySize()); 3830f153424SSanjay Patel if (auto *AllocSize = dyn_cast_or_null<ConstantInt>(Size)) { 3847adc3a2bSChandler Carruth Type *Ty = I.getAllocatedType(); 38522eb80a1SEaswaran Raman AllocatedSize = SaturatingMultiplyAdd( 38622eb80a1SEaswaran Raman AllocSize->getLimitedValue(), DL.getTypeAllocSize(Ty), AllocatedSize); 3877adc3a2bSChandler Carruth return Base::visitAlloca(I); 3887adc3a2bSChandler Carruth } 3897adc3a2bSChandler Carruth } 3907adc3a2bSChandler Carruth 3917adc3a2bSChandler Carruth // Accumulate the allocated size. 3927adc3a2bSChandler Carruth if (I.isStaticAlloca()) { 3937adc3a2bSChandler Carruth Type *Ty = I.getAllocatedType(); 39422eb80a1SEaswaran Raman AllocatedSize = SaturatingAdd(DL.getTypeAllocSize(Ty), AllocatedSize); 3957adc3a2bSChandler Carruth } 3967adc3a2bSChandler Carruth 3977adc3a2bSChandler Carruth // We will happily inline static alloca instructions. 3987adc3a2bSChandler Carruth if (I.isStaticAlloca()) 3997adc3a2bSChandler Carruth return Base::visitAlloca(I); 4007adc3a2bSChandler Carruth 4017adc3a2bSChandler Carruth // FIXME: This is overly conservative. Dynamic allocas are inefficient for 4027adc3a2bSChandler Carruth // a variety of reasons, and so we would like to not inline them into 4037adc3a2bSChandler Carruth // functions which don't currently have a dynamic alloca. This simply 4047adc3a2bSChandler Carruth // disables inlining altogether in the presence of a dynamic alloca. 4057adc3a2bSChandler Carruth HasDynamicAlloca = true; 4067adc3a2bSChandler Carruth return false; 4077adc3a2bSChandler Carruth } 4087adc3a2bSChandler Carruth 4097adc3a2bSChandler Carruth bool CallAnalyzer::visitPHI(PHINode &I) { 4107adc3a2bSChandler Carruth // FIXME: We should potentially be tracking values through phi nodes, 4117adc3a2bSChandler Carruth // especially when they collapse to a single value due to deleted CFG edges 4127adc3a2bSChandler Carruth // during inlining. 4137adc3a2bSChandler Carruth 4147adc3a2bSChandler Carruth // FIXME: We need to propagate SROA *disabling* through phi nodes, even 4157adc3a2bSChandler Carruth // though we don't want to propagate it's bonuses. The idea is to disable 4167adc3a2bSChandler Carruth // SROA if it *might* be used in an inappropriate manner. 4177adc3a2bSChandler Carruth 4187adc3a2bSChandler Carruth // Phi nodes are always zero-cost. 4197adc3a2bSChandler Carruth return true; 4207adc3a2bSChandler Carruth } 4217adc3a2bSChandler Carruth 4227adc3a2bSChandler Carruth bool CallAnalyzer::visitGetElementPtr(GetElementPtrInst &I) { 4237adc3a2bSChandler Carruth Value *SROAArg; 4247adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 425567556aaSChad Rosier bool SROACandidate = 426567556aaSChad Rosier lookupSROAArgAndCost(I.getPointerOperand(), SROAArg, CostIt); 4277adc3a2bSChandler Carruth 4287adc3a2bSChandler Carruth // Try to fold GEPs of constant-offset call site argument pointers. This 4297adc3a2bSChandler Carruth // requires target data and inbounds GEPs. 4307adc3a2bSChandler Carruth if (I.isInBounds()) { 4317adc3a2bSChandler Carruth // Check if we have a base + offset for the pointer. 4327adc3a2bSChandler Carruth Value *Ptr = I.getPointerOperand(); 4337adc3a2bSChandler Carruth std::pair<Value *, APInt> BaseAndOffset = ConstantOffsetPtrs.lookup(Ptr); 4347adc3a2bSChandler Carruth if (BaseAndOffset.first) { 4357adc3a2bSChandler Carruth // Check if the offset of this GEP is constant, and if so accumulate it 4367adc3a2bSChandler Carruth // into Offset. 4377adc3a2bSChandler Carruth if (!accumulateGEPOffset(cast<GEPOperator>(I), BaseAndOffset.second)) { 4387adc3a2bSChandler Carruth // Non-constant GEPs aren't folded, and disable SROA. 4397adc3a2bSChandler Carruth if (SROACandidate) 4407adc3a2bSChandler Carruth disableSROA(CostIt); 441201b191bSHaicheng Wu return isGEPFree(I); 4427adc3a2bSChandler Carruth } 4437adc3a2bSChandler Carruth 4447adc3a2bSChandler Carruth // Add the result as a new mapping to Base + Offset. 4457adc3a2bSChandler Carruth ConstantOffsetPtrs[&I] = BaseAndOffset; 4467adc3a2bSChandler Carruth 4477adc3a2bSChandler Carruth // Also handle SROA candidates here, we already know that the GEP is 4487adc3a2bSChandler Carruth // all-constant indexed. 4497adc3a2bSChandler Carruth if (SROACandidate) 4507adc3a2bSChandler Carruth SROAArgValues[&I] = SROAArg; 4517adc3a2bSChandler Carruth 4527adc3a2bSChandler Carruth return true; 4537adc3a2bSChandler Carruth } 4547adc3a2bSChandler Carruth } 4557adc3a2bSChandler Carruth 456a8b9cdc9SEaswaran Raman // Lambda to check whether a GEP's indices are all constant. 457a8b9cdc9SEaswaran Raman auto IsGEPOffsetConstant = [&](GetElementPtrInst &GEP) { 458a8b9cdc9SEaswaran Raman for (User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end(); I != E; ++I) 459a8b9cdc9SEaswaran Raman if (!isa<Constant>(*I) && !SimplifiedValues.lookup(*I)) 460a8b9cdc9SEaswaran Raman return false; 461a8b9cdc9SEaswaran Raman return true; 462a8b9cdc9SEaswaran Raman }; 463a8b9cdc9SEaswaran Raman 464a8b9cdc9SEaswaran Raman if (IsGEPOffsetConstant(I)) { 4657adc3a2bSChandler Carruth if (SROACandidate) 4667adc3a2bSChandler Carruth SROAArgValues[&I] = SROAArg; 4677adc3a2bSChandler Carruth 4687adc3a2bSChandler Carruth // Constant GEPs are modeled as free. 4697adc3a2bSChandler Carruth return true; 4707adc3a2bSChandler Carruth } 4717adc3a2bSChandler Carruth 4727adc3a2bSChandler Carruth // Variable GEPs will require math and will disable SROA. 4737adc3a2bSChandler Carruth if (SROACandidate) 4747adc3a2bSChandler Carruth disableSROA(CostIt); 475201b191bSHaicheng Wu return isGEPFree(I); 4767adc3a2bSChandler Carruth } 4777adc3a2bSChandler Carruth 478617f6364SEaswaran Raman /// Simplify \p I if its operands are constants and update SimplifiedValues. 479617f6364SEaswaran Raman /// \p Evaluate is a callable specific to instruction type that evaluates the 480617f6364SEaswaran Raman /// instruction when all the operands are constants. 481617f6364SEaswaran Raman template <typename Callable> 482617f6364SEaswaran Raman bool CallAnalyzer::simplifyInstruction(Instruction &I, Callable Evaluate) { 483617f6364SEaswaran Raman SmallVector<Constant *, 2> COps; 484617f6364SEaswaran Raman for (Value *Op : I.operands()) { 485617f6364SEaswaran Raman Constant *COp = dyn_cast<Constant>(Op); 4867adc3a2bSChandler Carruth if (!COp) 487617f6364SEaswaran Raman COp = SimplifiedValues.lookup(Op); 488617f6364SEaswaran Raman if (!COp) 489617f6364SEaswaran Raman return false; 490617f6364SEaswaran Raman COps.push_back(COp); 491617f6364SEaswaran Raman } 492617f6364SEaswaran Raman auto *C = Evaluate(COps); 493617f6364SEaswaran Raman if (!C) 494617f6364SEaswaran Raman return false; 4957adc3a2bSChandler Carruth SimplifiedValues[&I] = C; 4967adc3a2bSChandler Carruth return true; 4977adc3a2bSChandler Carruth } 4987adc3a2bSChandler Carruth 499617f6364SEaswaran Raman bool CallAnalyzer::visitBitCast(BitCastInst &I) { 500617f6364SEaswaran Raman // Propagate constants through bitcasts. 501617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 502617f6364SEaswaran Raman return ConstantExpr::getBitCast(COps[0], I.getType()); 503617f6364SEaswaran Raman })) 504617f6364SEaswaran Raman return true; 505617f6364SEaswaran Raman 5067adc3a2bSChandler Carruth // Track base/offsets through casts 507567556aaSChad Rosier std::pair<Value *, APInt> BaseAndOffset = 508567556aaSChad Rosier ConstantOffsetPtrs.lookup(I.getOperand(0)); 5097adc3a2bSChandler Carruth // Casts don't change the offset, just wrap it up. 5107adc3a2bSChandler Carruth if (BaseAndOffset.first) 5117adc3a2bSChandler Carruth ConstantOffsetPtrs[&I] = BaseAndOffset; 5127adc3a2bSChandler Carruth 5137adc3a2bSChandler Carruth // Also look for SROA candidates here. 5147adc3a2bSChandler Carruth Value *SROAArg; 5157adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 5167adc3a2bSChandler Carruth if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) 5177adc3a2bSChandler Carruth SROAArgValues[&I] = SROAArg; 5187adc3a2bSChandler Carruth 5197adc3a2bSChandler Carruth // Bitcasts are always zero cost. 5207adc3a2bSChandler Carruth return true; 5217adc3a2bSChandler Carruth } 5227adc3a2bSChandler Carruth 5237adc3a2bSChandler Carruth bool CallAnalyzer::visitPtrToInt(PtrToIntInst &I) { 5247adc3a2bSChandler Carruth // Propagate constants through ptrtoint. 525617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 526617f6364SEaswaran Raman return ConstantExpr::getPtrToInt(COps[0], I.getType()); 527617f6364SEaswaran Raman })) 5287adc3a2bSChandler Carruth return true; 5297adc3a2bSChandler Carruth 5307adc3a2bSChandler Carruth // Track base/offset pairs when converted to a plain integer provided the 5317adc3a2bSChandler Carruth // integer is large enough to represent the pointer. 5327adc3a2bSChandler Carruth unsigned IntegerSize = I.getType()->getScalarSizeInBits(); 5337adc3a2bSChandler Carruth if (IntegerSize >= DL.getPointerSizeInBits()) { 534567556aaSChad Rosier std::pair<Value *, APInt> BaseAndOffset = 535567556aaSChad Rosier ConstantOffsetPtrs.lookup(I.getOperand(0)); 5367adc3a2bSChandler Carruth if (BaseAndOffset.first) 5377adc3a2bSChandler Carruth ConstantOffsetPtrs[&I] = BaseAndOffset; 5387adc3a2bSChandler Carruth } 5397adc3a2bSChandler Carruth 5407adc3a2bSChandler Carruth // This is really weird. Technically, ptrtoint will disable SROA. However, 5417adc3a2bSChandler Carruth // unless that ptrtoint is *used* somewhere in the live basic blocks after 5427adc3a2bSChandler Carruth // inlining, it will be nuked, and SROA should proceed. All of the uses which 5437adc3a2bSChandler Carruth // would block SROA would also block SROA if applied directly to a pointer, 5447adc3a2bSChandler Carruth // and so we can just add the integer in here. The only places where SROA is 5457adc3a2bSChandler Carruth // preserved either cannot fire on an integer, or won't in-and-of themselves 5467adc3a2bSChandler Carruth // disable SROA (ext) w/o some later use that we would see and disable. 5477adc3a2bSChandler Carruth Value *SROAArg; 5487adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 5497adc3a2bSChandler Carruth if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) 5507adc3a2bSChandler Carruth SROAArgValues[&I] = SROAArg; 5517adc3a2bSChandler Carruth 5527adc3a2bSChandler Carruth return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I); 5537adc3a2bSChandler Carruth } 5547adc3a2bSChandler Carruth 5557adc3a2bSChandler Carruth bool CallAnalyzer::visitIntToPtr(IntToPtrInst &I) { 5567adc3a2bSChandler Carruth // Propagate constants through ptrtoint. 557617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 558617f6364SEaswaran Raman return ConstantExpr::getIntToPtr(COps[0], I.getType()); 559617f6364SEaswaran Raman })) 5607adc3a2bSChandler Carruth return true; 5617adc3a2bSChandler Carruth 5627adc3a2bSChandler Carruth // Track base/offset pairs when round-tripped through a pointer without 5637adc3a2bSChandler Carruth // modifications provided the integer is not too large. 5647adc3a2bSChandler Carruth Value *Op = I.getOperand(0); 5657adc3a2bSChandler Carruth unsigned IntegerSize = Op->getType()->getScalarSizeInBits(); 5667adc3a2bSChandler Carruth if (IntegerSize <= DL.getPointerSizeInBits()) { 5677adc3a2bSChandler Carruth std::pair<Value *, APInt> BaseAndOffset = ConstantOffsetPtrs.lookup(Op); 5687adc3a2bSChandler Carruth if (BaseAndOffset.first) 5697adc3a2bSChandler Carruth ConstantOffsetPtrs[&I] = BaseAndOffset; 5707adc3a2bSChandler Carruth } 5717adc3a2bSChandler Carruth 5727adc3a2bSChandler Carruth // "Propagate" SROA here in the same manner as we do for ptrtoint above. 5737adc3a2bSChandler Carruth Value *SROAArg; 5747adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 5757adc3a2bSChandler Carruth if (lookupSROAArgAndCost(Op, SROAArg, CostIt)) 5767adc3a2bSChandler Carruth SROAArgValues[&I] = SROAArg; 5777adc3a2bSChandler Carruth 5787adc3a2bSChandler Carruth return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I); 5797adc3a2bSChandler Carruth } 5807adc3a2bSChandler Carruth 5817adc3a2bSChandler Carruth bool CallAnalyzer::visitCastInst(CastInst &I) { 5827adc3a2bSChandler Carruth // Propagate constants through ptrtoint. 583617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 584617f6364SEaswaran Raman return ConstantExpr::getCast(I.getOpcode(), COps[0], I.getType()); 585617f6364SEaswaran Raman })) 5867adc3a2bSChandler Carruth return true; 5877adc3a2bSChandler Carruth 5887adc3a2bSChandler Carruth // Disable SROA in the face of arbitrary casts we don't whitelist elsewhere. 5897adc3a2bSChandler Carruth disableSROA(I.getOperand(0)); 5907adc3a2bSChandler Carruth 5917adc3a2bSChandler Carruth return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I); 5927adc3a2bSChandler Carruth } 5937adc3a2bSChandler Carruth 5947adc3a2bSChandler Carruth bool CallAnalyzer::visitUnaryInstruction(UnaryInstruction &I) { 5957adc3a2bSChandler Carruth Value *Operand = I.getOperand(0); 596617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 597617f6364SEaswaran Raman return ConstantFoldInstOperands(&I, COps[0], DL); 598617f6364SEaswaran Raman })) 5997adc3a2bSChandler Carruth return true; 6007adc3a2bSChandler Carruth 6017adc3a2bSChandler Carruth // Disable any SROA on the argument to arbitrary unary operators. 6027adc3a2bSChandler Carruth disableSROA(Operand); 6037adc3a2bSChandler Carruth 6047adc3a2bSChandler Carruth return false; 6057adc3a2bSChandler Carruth } 6067adc3a2bSChandler Carruth 6077adc3a2bSChandler Carruth bool CallAnalyzer::paramHasAttr(Argument *A, Attribute::AttrKind Attr) { 608fb502d2fSReid Kleckner return CandidateCS.paramHasAttr(A->getArgNo(), Attr); 6097adc3a2bSChandler Carruth } 6107adc3a2bSChandler Carruth 6117adc3a2bSChandler Carruth bool CallAnalyzer::isKnownNonNullInCallee(Value *V) { 6127adc3a2bSChandler Carruth // Does the *call site* have the NonNull attribute set on an argument? We 6137adc3a2bSChandler Carruth // use the attribute on the call site to memoize any analysis done in the 6147adc3a2bSChandler Carruth // caller. This will also trip if the callee function has a non-null 6157adc3a2bSChandler Carruth // parameter attribute, but that's a less interesting case because hopefully 6167adc3a2bSChandler Carruth // the callee would already have been simplified based on that. 6177adc3a2bSChandler Carruth if (Argument *A = dyn_cast<Argument>(V)) 6187adc3a2bSChandler Carruth if (paramHasAttr(A, Attribute::NonNull)) 6197adc3a2bSChandler Carruth return true; 6207adc3a2bSChandler Carruth 6217adc3a2bSChandler Carruth // Is this an alloca in the caller? This is distinct from the attribute case 6227adc3a2bSChandler Carruth // above because attributes aren't updated within the inliner itself and we 6237adc3a2bSChandler Carruth // always want to catch the alloca derived case. 6247adc3a2bSChandler Carruth if (isAllocaDerivedArg(V)) 6257adc3a2bSChandler Carruth // We can actually predict the result of comparisons between an 6267adc3a2bSChandler Carruth // alloca-derived value and null. Note that this fires regardless of 6277adc3a2bSChandler Carruth // SROA firing. 6287adc3a2bSChandler Carruth return true; 6297adc3a2bSChandler Carruth 6307adc3a2bSChandler Carruth return false; 6317adc3a2bSChandler Carruth } 6327adc3a2bSChandler Carruth 6339a3fc17aSEaswaran Raman bool CallAnalyzer::allowSizeGrowth(CallSite CS) { 6349a3fc17aSEaswaran Raman // If the normal destination of the invoke or the parent block of the call 6359a3fc17aSEaswaran Raman // site is unreachable-terminated, there is little point in inlining this 6369a3fc17aSEaswaran Raman // unless there is literally zero cost. 6379a3fc17aSEaswaran Raman // FIXME: Note that it is possible that an unreachable-terminated block has a 6389a3fc17aSEaswaran Raman // hot entry. For example, in below scenario inlining hot_call_X() may be 6399a3fc17aSEaswaran Raman // beneficial : 6409a3fc17aSEaswaran Raman // main() { 6419a3fc17aSEaswaran Raman // hot_call_1(); 6429a3fc17aSEaswaran Raman // ... 6439a3fc17aSEaswaran Raman // hot_call_N() 6449a3fc17aSEaswaran Raman // exit(0); 6459a3fc17aSEaswaran Raman // } 6469a3fc17aSEaswaran Raman // For now, we are not handling this corner case here as it is rare in real 6479a3fc17aSEaswaran Raman // code. In future, we should elaborate this based on BPI and BFI in more 6489a3fc17aSEaswaran Raman // general threshold adjusting heuristics in updateThreshold(). 6499a3fc17aSEaswaran Raman Instruction *Instr = CS.getInstruction(); 6509a3fc17aSEaswaran Raman if (InvokeInst *II = dyn_cast<InvokeInst>(Instr)) { 6519a3fc17aSEaswaran Raman if (isa<UnreachableInst>(II->getNormalDest()->getTerminator())) 6529a3fc17aSEaswaran Raman return false; 6539a3fc17aSEaswaran Raman } else if (isa<UnreachableInst>(Instr->getParent()->getTerminator())) 6549a3fc17aSEaswaran Raman return false; 6559a3fc17aSEaswaran Raman 6569a3fc17aSEaswaran Raman return true; 6579a3fc17aSEaswaran Raman } 6589a3fc17aSEaswaran Raman 659c5fa6358SEaswaran Raman bool CallAnalyzer::isColdCallSite(CallSite CS, BlockFrequencyInfo *CallerBFI) { 660c5fa6358SEaswaran Raman // If global profile summary is available, then callsite's coldness is 661c5fa6358SEaswaran Raman // determined based on that. 662*bba762a1SChandler Carruth if (PSI && PSI->hasProfileSummary()) 663c5fa6358SEaswaran Raman return PSI->isColdCallSite(CS, CallerBFI); 664*bba762a1SChandler Carruth 665*bba762a1SChandler Carruth // Otherwise we need BFI to be available. 666c5fa6358SEaswaran Raman if (!CallerBFI) 667c5fa6358SEaswaran Raman return false; 668c5fa6358SEaswaran Raman 669*bba762a1SChandler Carruth // Determine if the callsite is cold relative to caller's entry. We could 670*bba762a1SChandler Carruth // potentially cache the computation of scaled entry frequency, but the added 671*bba762a1SChandler Carruth // complexity is not worth it unless this scaling shows up high in the 672*bba762a1SChandler Carruth // profiles. 673c5fa6358SEaswaran Raman const BranchProbability ColdProb(ColdCallSiteRelFreq, 100); 674c5fa6358SEaswaran Raman auto CallSiteBB = CS.getInstruction()->getParent(); 675c5fa6358SEaswaran Raman auto CallSiteFreq = CallerBFI->getBlockFreq(CallSiteBB); 676c5fa6358SEaswaran Raman auto CallerEntryFreq = 677c5fa6358SEaswaran Raman CallerBFI->getBlockFreq(&(CS.getCaller()->getEntryBlock())); 678c5fa6358SEaswaran Raman return CallSiteFreq < CallerEntryFreq * ColdProb; 679c5fa6358SEaswaran Raman } 680c5fa6358SEaswaran Raman 681974d4eeaSEaswaran Raman Optional<int> 682974d4eeaSEaswaran Raman CallAnalyzer::getHotCallSiteThreshold(CallSite CS, 683974d4eeaSEaswaran Raman BlockFrequencyInfo *CallerBFI) { 684*bba762a1SChandler Carruth 685974d4eeaSEaswaran Raman // If global profile summary is available, then callsite's hotness is 686974d4eeaSEaswaran Raman // determined based on that. 687*bba762a1SChandler Carruth if (PSI && PSI->hasProfileSummary() && PSI->isHotCallSite(CS, CallerBFI)) 688*bba762a1SChandler Carruth return Params.HotCallSiteThreshold; 689974d4eeaSEaswaran Raman 690*bba762a1SChandler Carruth // Otherwise we need BFI to be available and to have a locally hot callsite 691*bba762a1SChandler Carruth // threshold. 692*bba762a1SChandler Carruth if (!CallerBFI || !Params.LocallyHotCallSiteThreshold) 693974d4eeaSEaswaran Raman return None; 694974d4eeaSEaswaran Raman 695*bba762a1SChandler Carruth // Determine if the callsite is hot relative to caller's entry. We could 696*bba762a1SChandler Carruth // potentially cache the computation of scaled entry frequency, but the added 697*bba762a1SChandler Carruth // complexity is not worth it unless this scaling shows up high in the 698*bba762a1SChandler Carruth // profiles. 699974d4eeaSEaswaran Raman auto CallSiteBB = CS.getInstruction()->getParent(); 700974d4eeaSEaswaran Raman auto CallSiteFreq = CallerBFI->getBlockFreq(CallSiteBB).getFrequency(); 701974d4eeaSEaswaran Raman auto CallerEntryFreq = CallerBFI->getEntryFreq(); 702974d4eeaSEaswaran Raman if (CallSiteFreq >= CallerEntryFreq * HotCallSiteRelFreq) 703*bba762a1SChandler Carruth return Params.LocallyHotCallSiteThreshold; 704*bba762a1SChandler Carruth 705*bba762a1SChandler Carruth // Otherwise treat it normally. 706974d4eeaSEaswaran Raman return None; 707974d4eeaSEaswaran Raman } 708974d4eeaSEaswaran Raman 709f4bb2f0dSEaswaran Raman void CallAnalyzer::updateThreshold(CallSite CS, Function &Callee) { 7109a3fc17aSEaswaran Raman // If no size growth is allowed for this inlining, set Threshold to 0. 7119a3fc17aSEaswaran Raman if (!allowSizeGrowth(CS)) { 7129a3fc17aSEaswaran Raman Threshold = 0; 7139a3fc17aSEaswaran Raman return; 7149a3fc17aSEaswaran Raman } 7159a3fc17aSEaswaran Raman 716bb578ef0SEaswaran Raman Function *Caller = CS.getCaller(); 7171c57cc2bSEaswaran Raman 7181c57cc2bSEaswaran Raman // return min(A, B) if B is valid. 7191c57cc2bSEaswaran Raman auto MinIfValid = [](int A, Optional<int> B) { 7201c57cc2bSEaswaran Raman return B ? std::min(A, B.getValue()) : A; 7211c57cc2bSEaswaran Raman }; 7221c57cc2bSEaswaran Raman 7230d58fcacSEaswaran Raman // return max(A, B) if B is valid. 7240d58fcacSEaswaran Raman auto MaxIfValid = [](int A, Optional<int> B) { 7250d58fcacSEaswaran Raman return B ? std::max(A, B.getValue()) : A; 7260d58fcacSEaswaran Raman }; 7270d58fcacSEaswaran Raman 72851b809bfSEaswaran Raman // Various bonus percentages. These are multiplied by Threshold to get the 72951b809bfSEaswaran Raman // bonus values. 73051b809bfSEaswaran Raman // SingleBBBonus: This bonus is applied if the callee has a single reachable 73151b809bfSEaswaran Raman // basic block at the given callsite context. This is speculatively applied 73251b809bfSEaswaran Raman // and withdrawn if more than one basic block is seen. 73351b809bfSEaswaran Raman // 73451b809bfSEaswaran Raman // Vector bonuses: We want to more aggressively inline vector-dense kernels 73551b809bfSEaswaran Raman // and apply this bonus based on the percentage of vector instructions. A 73651b809bfSEaswaran Raman // bonus is applied if the vector instructions exceed 50% and half that amount 73751b809bfSEaswaran Raman // is applied if it exceeds 10%. Note that these bonuses are some what 73851b809bfSEaswaran Raman // arbitrary and evolved over time by accident as much as because they are 73951b809bfSEaswaran Raman // principled bonuses. 74051b809bfSEaswaran Raman // FIXME: It would be nice to base the bonus values on something more 74151b809bfSEaswaran Raman // scientific. 74251b809bfSEaswaran Raman // 74351b809bfSEaswaran Raman // LstCallToStaticBonus: This large bonus is applied to ensure the inlining 74451b809bfSEaswaran Raman // of the last call to a static function as inlining such functions is 74551b809bfSEaswaran Raman // guaranteed to reduce code size. 74651b809bfSEaswaran Raman // 74751b809bfSEaswaran Raman // These bonus percentages may be set to 0 based on properties of the caller 74851b809bfSEaswaran Raman // and the callsite. 74951b809bfSEaswaran Raman int SingleBBBonusPercent = 50; 75051b809bfSEaswaran Raman int VectorBonusPercent = 150; 75151b809bfSEaswaran Raman int LastCallToStaticBonus = InlineConstants::LastCallToStaticBonus; 75251b809bfSEaswaran Raman 75351b809bfSEaswaran Raman // Lambda to set all the above bonus and bonus percentages to 0. 75451b809bfSEaswaran Raman auto DisallowAllBonuses = [&]() { 75551b809bfSEaswaran Raman SingleBBBonusPercent = 0; 75651b809bfSEaswaran Raman VectorBonusPercent = 0; 75751b809bfSEaswaran Raman LastCallToStaticBonus = 0; 75851b809bfSEaswaran Raman }; 75951b809bfSEaswaran Raman 7601c57cc2bSEaswaran Raman // Use the OptMinSizeThreshold or OptSizeThreshold knob if they are available 7611c57cc2bSEaswaran Raman // and reduce the threshold if the caller has the necessary attribute. 76251b809bfSEaswaran Raman if (Caller->optForMinSize()) { 7631c57cc2bSEaswaran Raman Threshold = MinIfValid(Threshold, Params.OptMinSizeThreshold); 76451b809bfSEaswaran Raman // For minsize, we want to disable the single BB bonus and the vector 76551b809bfSEaswaran Raman // bonuses, but not the last-call-to-static bonus. Inlining the last call to 76651b809bfSEaswaran Raman // a static function will, at the minimum, eliminate the parameter setup and 76751b809bfSEaswaran Raman // call/return instructions. 76851b809bfSEaswaran Raman SingleBBBonusPercent = 0; 76951b809bfSEaswaran Raman VectorBonusPercent = 0; 77051b809bfSEaswaran Raman } else if (Caller->optForSize()) 7711c57cc2bSEaswaran Raman Threshold = MinIfValid(Threshold, Params.OptSizeThreshold); 772f4bb2f0dSEaswaran Raman 773e08b139dSEaswaran Raman // Adjust the threshold based on inlinehint attribute and profile based 774e08b139dSEaswaran Raman // hotness information if the caller does not have MinSize attribute. 775e08b139dSEaswaran Raman if (!Caller->optForMinSize()) { 776e08b139dSEaswaran Raman if (Callee.hasFnAttribute(Attribute::InlineHint)) 7770d58fcacSEaswaran Raman Threshold = MaxIfValid(Threshold, Params.HintThreshold); 778*bba762a1SChandler Carruth 7793cd1479cSEaswaran Raman // FIXME: After switching to the new passmanager, simplify the logic below 780*bba762a1SChandler Carruth // by checking only the callsite hotness/coldness as we will reliably 781*bba762a1SChandler Carruth // have local profile information. 7823cd1479cSEaswaran Raman // 783*bba762a1SChandler Carruth // Callsite hotness and coldness can be determined if sample profile is 784*bba762a1SChandler Carruth // used (which adds hotness metadata to calls) or if caller's 785*bba762a1SChandler Carruth // BlockFrequencyInfo is available. 786*bba762a1SChandler Carruth BlockFrequencyInfo *CallerBFI = GetBFI ? &((*GetBFI)(*Caller)) : nullptr; 787974d4eeaSEaswaran Raman auto HotCallSiteThreshold = getHotCallSiteThreshold(CS, CallerBFI); 788974d4eeaSEaswaran Raman if (!Caller->optForSize() && HotCallSiteThreshold) { 78912585b01SEaswaran Raman DEBUG(dbgs() << "Hot callsite.\n"); 790974d4eeaSEaswaran Raman // FIXME: This should update the threshold only if it exceeds the 791974d4eeaSEaswaran Raman // current threshold, but AutoFDO + ThinLTO currently relies on this 792974d4eeaSEaswaran Raman // behavior to prevent inlining of hot callsites during ThinLTO 793974d4eeaSEaswaran Raman // compile phase. 794974d4eeaSEaswaran Raman Threshold = HotCallSiteThreshold.getValue(); 795c5fa6358SEaswaran Raman } else if (isColdCallSite(CS, CallerBFI)) { 7963cd1479cSEaswaran Raman DEBUG(dbgs() << "Cold callsite.\n"); 79751b809bfSEaswaran Raman // Do not apply bonuses for a cold callsite including the 79851b809bfSEaswaran Raman // LastCallToStatic bonus. While this bonus might result in code size 79951b809bfSEaswaran Raman // reduction, it can cause the size of a non-cold caller to increase 80051b809bfSEaswaran Raman // preventing it from being inlined. 80151b809bfSEaswaran Raman DisallowAllBonuses(); 8023cd1479cSEaswaran Raman Threshold = MinIfValid(Threshold, Params.ColdCallSiteThreshold); 803*bba762a1SChandler Carruth } else if (PSI) { 804*bba762a1SChandler Carruth // Use callee's global profile information only if we have no way of 805*bba762a1SChandler Carruth // determining this via callsite information. 8063cd1479cSEaswaran Raman if (PSI->isFunctionEntryHot(&Callee)) { 80712585b01SEaswaran Raman DEBUG(dbgs() << "Hot callee.\n"); 808e08b139dSEaswaran Raman // If callsite hotness can not be determined, we may still know 809e08b139dSEaswaran Raman // that the callee is hot and treat it as a weaker hint for threshold 810e08b139dSEaswaran Raman // increase. 811e08b139dSEaswaran Raman Threshold = MaxIfValid(Threshold, Params.HintThreshold); 812e08b139dSEaswaran Raman } else if (PSI->isFunctionEntryCold(&Callee)) { 81312585b01SEaswaran Raman DEBUG(dbgs() << "Cold callee.\n"); 81451b809bfSEaswaran Raman // Do not apply bonuses for a cold callee including the 81551b809bfSEaswaran Raman // LastCallToStatic bonus. While this bonus might result in code size 81651b809bfSEaswaran Raman // reduction, it can cause the size of a non-cold caller to increase 81751b809bfSEaswaran Raman // preventing it from being inlined. 81851b809bfSEaswaran Raman DisallowAllBonuses(); 8191c57cc2bSEaswaran Raman Threshold = MinIfValid(Threshold, Params.ColdThreshold); 820e08b139dSEaswaran Raman } 821e08b139dSEaswaran Raman } 822e08b139dSEaswaran Raman } 8238650a4daSJustin Lebar 8248650a4daSJustin Lebar // Finally, take the target-specific inlining threshold multiplier into 8258650a4daSJustin Lebar // account. 8268650a4daSJustin Lebar Threshold *= TTI.getInliningThresholdMultiplier(); 82751b809bfSEaswaran Raman 82851b809bfSEaswaran Raman SingleBBBonus = Threshold * SingleBBBonusPercent / 100; 82951b809bfSEaswaran Raman VectorBonus = Threshold * VectorBonusPercent / 100; 83051b809bfSEaswaran Raman 83151b809bfSEaswaran Raman bool OnlyOneCallAndLocalLinkage = 83251b809bfSEaswaran Raman F.hasLocalLinkage() && F.hasOneUse() && &F == CS.getCalledFunction(); 83351b809bfSEaswaran Raman // If there is only one call of the function, and it has internal linkage, 83451b809bfSEaswaran Raman // the cost of inlining it drops dramatically. It may seem odd to update 83551b809bfSEaswaran Raman // Cost in updateThreshold, but the bonus depends on the logic in this method. 83651b809bfSEaswaran Raman if (OnlyOneCallAndLocalLinkage) 83751b809bfSEaswaran Raman Cost -= LastCallToStaticBonus; 838f4bb2f0dSEaswaran Raman } 839f4bb2f0dSEaswaran Raman 8407adc3a2bSChandler Carruth bool CallAnalyzer::visitCmpInst(CmpInst &I) { 8417adc3a2bSChandler Carruth Value *LHS = I.getOperand(0), *RHS = I.getOperand(1); 8427adc3a2bSChandler Carruth // First try to handle simplified comparisons. 843617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 844617f6364SEaswaran Raman return ConstantExpr::getCompare(I.getPredicate(), COps[0], COps[1]); 845617f6364SEaswaran Raman })) 8467adc3a2bSChandler Carruth return true; 8477adc3a2bSChandler Carruth 8487adc3a2bSChandler Carruth if (I.getOpcode() == Instruction::FCmp) 8497adc3a2bSChandler Carruth return false; 8507adc3a2bSChandler Carruth 8517adc3a2bSChandler Carruth // Otherwise look for a comparison between constant offset pointers with 8527adc3a2bSChandler Carruth // a common base. 8537adc3a2bSChandler Carruth Value *LHSBase, *RHSBase; 8547adc3a2bSChandler Carruth APInt LHSOffset, RHSOffset; 8557adc3a2bSChandler Carruth std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS); 8567adc3a2bSChandler Carruth if (LHSBase) { 8577adc3a2bSChandler Carruth std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS); 8587adc3a2bSChandler Carruth if (RHSBase && LHSBase == RHSBase) { 8597adc3a2bSChandler Carruth // We have common bases, fold the icmp to a constant based on the 8607adc3a2bSChandler Carruth // offsets. 8617adc3a2bSChandler Carruth Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset); 8627adc3a2bSChandler Carruth Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset); 8637adc3a2bSChandler Carruth if (Constant *C = ConstantExpr::getICmp(I.getPredicate(), CLHS, CRHS)) { 8647adc3a2bSChandler Carruth SimplifiedValues[&I] = C; 8657adc3a2bSChandler Carruth ++NumConstantPtrCmps; 8667adc3a2bSChandler Carruth return true; 8677adc3a2bSChandler Carruth } 8687adc3a2bSChandler Carruth } 8697adc3a2bSChandler Carruth } 8707adc3a2bSChandler Carruth 8717adc3a2bSChandler Carruth // If the comparison is an equality comparison with null, we can simplify it 8727adc3a2bSChandler Carruth // if we know the value (argument) can't be null 8737adc3a2bSChandler Carruth if (I.isEquality() && isa<ConstantPointerNull>(I.getOperand(1)) && 8747adc3a2bSChandler Carruth isKnownNonNullInCallee(I.getOperand(0))) { 8757adc3a2bSChandler Carruth bool IsNotEqual = I.getPredicate() == CmpInst::ICMP_NE; 8767adc3a2bSChandler Carruth SimplifiedValues[&I] = IsNotEqual ? ConstantInt::getTrue(I.getType()) 8777adc3a2bSChandler Carruth : ConstantInt::getFalse(I.getType()); 8787adc3a2bSChandler Carruth return true; 8797adc3a2bSChandler Carruth } 8807adc3a2bSChandler Carruth // Finally check for SROA candidates in comparisons. 8817adc3a2bSChandler Carruth Value *SROAArg; 8827adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 8837adc3a2bSChandler Carruth if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) { 8847adc3a2bSChandler Carruth if (isa<ConstantPointerNull>(I.getOperand(1))) { 8857adc3a2bSChandler Carruth accumulateSROACost(CostIt, InlineConstants::InstrCost); 8867adc3a2bSChandler Carruth return true; 8877adc3a2bSChandler Carruth } 8887adc3a2bSChandler Carruth 8897adc3a2bSChandler Carruth disableSROA(CostIt); 8907adc3a2bSChandler Carruth } 8917adc3a2bSChandler Carruth 8927adc3a2bSChandler Carruth return false; 8937adc3a2bSChandler Carruth } 8947adc3a2bSChandler Carruth 8952e1c050eSChad Rosier bool CallAnalyzer::visitOr(BinaryOperator &I) { 8962e1c050eSChad Rosier // This is necessary because the generic simplify instruction only works if 8972e1c050eSChad Rosier // both operands are constants. 8982e1c050eSChad Rosier for (unsigned i = 0; i < 2; ++i) { 8992e1c050eSChad Rosier if (ConstantInt *C = dyn_cast_or_null<ConstantInt>( 9002e1c050eSChad Rosier SimplifiedValues.lookup(I.getOperand(i)))) 9012e1c050eSChad Rosier if (C->isAllOnesValue()) { 9022e1c050eSChad Rosier SimplifiedValues[&I] = C; 9032e1c050eSChad Rosier return true; 9042e1c050eSChad Rosier } 9052e1c050eSChad Rosier } 9062e1c050eSChad Rosier return Base::visitOr(I); 9072e1c050eSChad Rosier } 9082e1c050eSChad Rosier 9092e1c050eSChad Rosier bool CallAnalyzer::visitAnd(BinaryOperator &I) { 9102e1c050eSChad Rosier // This is necessary because the generic simplify instruction only works if 9112e1c050eSChad Rosier // both operands are constants. 9122e1c050eSChad Rosier for (unsigned i = 0; i < 2; ++i) { 9132e1c050eSChad Rosier if (ConstantInt *C = dyn_cast_or_null<ConstantInt>( 9142e1c050eSChad Rosier SimplifiedValues.lookup(I.getOperand(i)))) 9152e1c050eSChad Rosier if (C->isZero()) { 9162e1c050eSChad Rosier SimplifiedValues[&I] = C; 9172e1c050eSChad Rosier return true; 9182e1c050eSChad Rosier } 9192e1c050eSChad Rosier } 9202e1c050eSChad Rosier return Base::visitAnd(I); 9212e1c050eSChad Rosier } 9222e1c050eSChad Rosier 9237adc3a2bSChandler Carruth bool CallAnalyzer::visitSub(BinaryOperator &I) { 9247adc3a2bSChandler Carruth // Try to handle a special case: we can fold computing the difference of two 9257adc3a2bSChandler Carruth // constant-related pointers. 9267adc3a2bSChandler Carruth Value *LHS = I.getOperand(0), *RHS = I.getOperand(1); 9277adc3a2bSChandler Carruth Value *LHSBase, *RHSBase; 9287adc3a2bSChandler Carruth APInt LHSOffset, RHSOffset; 9297adc3a2bSChandler Carruth std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS); 9307adc3a2bSChandler Carruth if (LHSBase) { 9317adc3a2bSChandler Carruth std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS); 9327adc3a2bSChandler Carruth if (RHSBase && LHSBase == RHSBase) { 9337adc3a2bSChandler Carruth // We have common bases, fold the subtract to a constant based on the 9347adc3a2bSChandler Carruth // offsets. 9357adc3a2bSChandler Carruth Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset); 9367adc3a2bSChandler Carruth Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset); 9377adc3a2bSChandler Carruth if (Constant *C = ConstantExpr::getSub(CLHS, CRHS)) { 9387adc3a2bSChandler Carruth SimplifiedValues[&I] = C; 9397adc3a2bSChandler Carruth ++NumConstantPtrDiffs; 9407adc3a2bSChandler Carruth return true; 9417adc3a2bSChandler Carruth } 9427adc3a2bSChandler Carruth } 9437adc3a2bSChandler Carruth } 9447adc3a2bSChandler Carruth 9457adc3a2bSChandler Carruth // Otherwise, fall back to the generic logic for simplifying and handling 9467adc3a2bSChandler Carruth // instructions. 9477adc3a2bSChandler Carruth return Base::visitSub(I); 9487adc3a2bSChandler Carruth } 9497adc3a2bSChandler Carruth 9507adc3a2bSChandler Carruth bool CallAnalyzer::visitBinaryOperator(BinaryOperator &I) { 9517adc3a2bSChandler Carruth Value *LHS = I.getOperand(0), *RHS = I.getOperand(1); 952617f6364SEaswaran Raman auto Evaluate = [&](SmallVectorImpl<Constant *> &COps) { 9537adc3a2bSChandler Carruth Value *SimpleV = nullptr; 9547adc3a2bSChandler Carruth if (auto FI = dyn_cast<FPMathOperator>(&I)) 955617f6364SEaswaran Raman SimpleV = SimplifyFPBinOp(I.getOpcode(), COps[0], COps[1], 956617f6364SEaswaran Raman FI->getFastMathFlags(), DL); 9577adc3a2bSChandler Carruth else 958617f6364SEaswaran Raman SimpleV = SimplifyBinOp(I.getOpcode(), COps[0], COps[1], DL); 959617f6364SEaswaran Raman return dyn_cast_or_null<Constant>(SimpleV); 960617f6364SEaswaran Raman }; 9617adc3a2bSChandler Carruth 962617f6364SEaswaran Raman if (simplifyInstruction(I, Evaluate)) 9637adc3a2bSChandler Carruth return true; 9647adc3a2bSChandler Carruth 9657adc3a2bSChandler Carruth // Disable any SROA on arguments to arbitrary, unsimplified binary operators. 9667adc3a2bSChandler Carruth disableSROA(LHS); 9677adc3a2bSChandler Carruth disableSROA(RHS); 9687adc3a2bSChandler Carruth 9697adc3a2bSChandler Carruth return false; 9707adc3a2bSChandler Carruth } 9717adc3a2bSChandler Carruth 9727adc3a2bSChandler Carruth bool CallAnalyzer::visitLoad(LoadInst &I) { 9737adc3a2bSChandler Carruth Value *SROAArg; 9747adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 9757adc3a2bSChandler Carruth if (lookupSROAArgAndCost(I.getPointerOperand(), SROAArg, CostIt)) { 9767adc3a2bSChandler Carruth if (I.isSimple()) { 9777adc3a2bSChandler Carruth accumulateSROACost(CostIt, InlineConstants::InstrCost); 9787adc3a2bSChandler Carruth return true; 9797adc3a2bSChandler Carruth } 9807adc3a2bSChandler Carruth 9817adc3a2bSChandler Carruth disableSROA(CostIt); 9827adc3a2bSChandler Carruth } 9837adc3a2bSChandler Carruth 9847adc3a2bSChandler Carruth return false; 9857adc3a2bSChandler Carruth } 9867adc3a2bSChandler Carruth 9877adc3a2bSChandler Carruth bool CallAnalyzer::visitStore(StoreInst &I) { 9887adc3a2bSChandler Carruth Value *SROAArg; 9897adc3a2bSChandler Carruth DenseMap<Value *, int>::iterator CostIt; 9907adc3a2bSChandler Carruth if (lookupSROAArgAndCost(I.getPointerOperand(), SROAArg, CostIt)) { 9917adc3a2bSChandler Carruth if (I.isSimple()) { 9927adc3a2bSChandler Carruth accumulateSROACost(CostIt, InlineConstants::InstrCost); 9937adc3a2bSChandler Carruth return true; 9947adc3a2bSChandler Carruth } 9957adc3a2bSChandler Carruth 9967adc3a2bSChandler Carruth disableSROA(CostIt); 9977adc3a2bSChandler Carruth } 9987adc3a2bSChandler Carruth 9997adc3a2bSChandler Carruth return false; 10007adc3a2bSChandler Carruth } 10017adc3a2bSChandler Carruth 10027adc3a2bSChandler Carruth bool CallAnalyzer::visitExtractValue(ExtractValueInst &I) { 10037adc3a2bSChandler Carruth // Constant folding for extract value is trivial. 1004617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 1005617f6364SEaswaran Raman return ConstantExpr::getExtractValue(COps[0], I.getIndices()); 1006617f6364SEaswaran Raman })) 10077adc3a2bSChandler Carruth return true; 10087adc3a2bSChandler Carruth 10097adc3a2bSChandler Carruth // SROA can look through these but give them a cost. 10107adc3a2bSChandler Carruth return false; 10117adc3a2bSChandler Carruth } 10127adc3a2bSChandler Carruth 10137adc3a2bSChandler Carruth bool CallAnalyzer::visitInsertValue(InsertValueInst &I) { 10147adc3a2bSChandler Carruth // Constant folding for insert value is trivial. 1015617f6364SEaswaran Raman if (simplifyInstruction(I, [&](SmallVectorImpl<Constant *> &COps) { 1016617f6364SEaswaran Raman return ConstantExpr::getInsertValue(/*AggregateOperand*/ COps[0], 1017617f6364SEaswaran Raman /*InsertedValueOperand*/ COps[1], 1018617f6364SEaswaran Raman I.getIndices()); 1019617f6364SEaswaran Raman })) 10207adc3a2bSChandler Carruth return true; 10217adc3a2bSChandler Carruth 10227adc3a2bSChandler Carruth // SROA can look through these but give them a cost. 10237adc3a2bSChandler Carruth return false; 10247adc3a2bSChandler Carruth } 10257adc3a2bSChandler Carruth 10267adc3a2bSChandler Carruth /// \brief Try to simplify a call site. 10277adc3a2bSChandler Carruth /// 10287adc3a2bSChandler Carruth /// Takes a concrete function and callsite and tries to actually simplify it by 10297adc3a2bSChandler Carruth /// analyzing the arguments and call itself with instsimplify. Returns true if 10307adc3a2bSChandler Carruth /// it has simplified the callsite to some other entity (a constant), making it 10317adc3a2bSChandler Carruth /// free. 10327adc3a2bSChandler Carruth bool CallAnalyzer::simplifyCallSite(Function *F, CallSite CS) { 10337adc3a2bSChandler Carruth // FIXME: Using the instsimplify logic directly for this is inefficient 10347adc3a2bSChandler Carruth // because we have to continually rebuild the argument list even when no 10357adc3a2bSChandler Carruth // simplifications can be performed. Until that is fixed with remapping 10367adc3a2bSChandler Carruth // inside of instsimplify, directly constant fold calls here. 1037647025f9SAndrew Kaylor if (!canConstantFoldCallTo(CS, F)) 10387adc3a2bSChandler Carruth return false; 10397adc3a2bSChandler Carruth 10407adc3a2bSChandler Carruth // Try to re-map the arguments to constants. 10417adc3a2bSChandler Carruth SmallVector<Constant *, 4> ConstantArgs; 10427adc3a2bSChandler Carruth ConstantArgs.reserve(CS.arg_size()); 1043567556aaSChad Rosier for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); I != E; 1044567556aaSChad Rosier ++I) { 10457adc3a2bSChandler Carruth Constant *C = dyn_cast<Constant>(*I); 10467adc3a2bSChandler Carruth if (!C) 10477adc3a2bSChandler Carruth C = dyn_cast_or_null<Constant>(SimplifiedValues.lookup(*I)); 10487adc3a2bSChandler Carruth if (!C) 10497adc3a2bSChandler Carruth return false; // This argument doesn't map to a constant. 10507adc3a2bSChandler Carruth 10517adc3a2bSChandler Carruth ConstantArgs.push_back(C); 10527adc3a2bSChandler Carruth } 1053647025f9SAndrew Kaylor if (Constant *C = ConstantFoldCall(CS, F, ConstantArgs)) { 10547adc3a2bSChandler Carruth SimplifiedValues[CS.getInstruction()] = C; 10557adc3a2bSChandler Carruth return true; 10567adc3a2bSChandler Carruth } 10577adc3a2bSChandler Carruth 10587adc3a2bSChandler Carruth return false; 10597adc3a2bSChandler Carruth } 10607adc3a2bSChandler Carruth 10617adc3a2bSChandler Carruth bool CallAnalyzer::visitCallSite(CallSite CS) { 10627adc3a2bSChandler Carruth if (CS.hasFnAttr(Attribute::ReturnsTwice) && 10637adc3a2bSChandler Carruth !F.hasFnAttribute(Attribute::ReturnsTwice)) { 10647adc3a2bSChandler Carruth // This aborts the entire analysis. 10657adc3a2bSChandler Carruth ExposesReturnsTwice = true; 10667adc3a2bSChandler Carruth return false; 10677adc3a2bSChandler Carruth } 1068567556aaSChad Rosier if (CS.isCall() && cast<CallInst>(CS.getInstruction())->cannotDuplicate()) 10697adc3a2bSChandler Carruth ContainsNoDuplicateCall = true; 10707adc3a2bSChandler Carruth 10717adc3a2bSChandler Carruth if (Function *F = CS.getCalledFunction()) { 10727adc3a2bSChandler Carruth // When we have a concrete function, first try to simplify it directly. 10737adc3a2bSChandler Carruth if (simplifyCallSite(F, CS)) 10747adc3a2bSChandler Carruth return true; 10757adc3a2bSChandler Carruth 10767adc3a2bSChandler Carruth // Next check if it is an intrinsic we know about. 10777adc3a2bSChandler Carruth // FIXME: Lift this into part of the InstVisitor. 10787adc3a2bSChandler Carruth if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) { 10797adc3a2bSChandler Carruth switch (II->getIntrinsicID()) { 10807adc3a2bSChandler Carruth default: 10817adc3a2bSChandler Carruth return Base::visitCallSite(CS); 10827adc3a2bSChandler Carruth 10837dd8dbf4SPeter Collingbourne case Intrinsic::load_relative: 10847dd8dbf4SPeter Collingbourne // This is normally lowered to 4 LLVM instructions. 10857dd8dbf4SPeter Collingbourne Cost += 3 * InlineConstants::InstrCost; 10867dd8dbf4SPeter Collingbourne return false; 10877dd8dbf4SPeter Collingbourne 10887adc3a2bSChandler Carruth case Intrinsic::memset: 10897adc3a2bSChandler Carruth case Intrinsic::memcpy: 10907adc3a2bSChandler Carruth case Intrinsic::memmove: 10917adc3a2bSChandler Carruth // SROA can usually chew through these intrinsics, but they aren't free. 10927adc3a2bSChandler Carruth return false; 10937adc3a2bSChandler Carruth case Intrinsic::localescape: 10947adc3a2bSChandler Carruth HasFrameEscape = true; 10957adc3a2bSChandler Carruth return false; 10967adc3a2bSChandler Carruth } 10977adc3a2bSChandler Carruth } 10987adc3a2bSChandler Carruth 10997adc3a2bSChandler Carruth if (F == CS.getInstruction()->getParent()->getParent()) { 11007adc3a2bSChandler Carruth // This flag will fully abort the analysis, so don't bother with anything 11017adc3a2bSChandler Carruth // else. 11027adc3a2bSChandler Carruth IsRecursiveCall = true; 11037adc3a2bSChandler Carruth return false; 11047adc3a2bSChandler Carruth } 11057adc3a2bSChandler Carruth 11067adc3a2bSChandler Carruth if (TTI.isLoweredToCall(F)) { 11077adc3a2bSChandler Carruth // We account for the average 1 instruction per call argument setup 11087adc3a2bSChandler Carruth // here. 11097adc3a2bSChandler Carruth Cost += CS.arg_size() * InlineConstants::InstrCost; 11107adc3a2bSChandler Carruth 11117adc3a2bSChandler Carruth // Everything other than inline ASM will also have a significant cost 11127adc3a2bSChandler Carruth // merely from making the call. 11137adc3a2bSChandler Carruth if (!isa<InlineAsm>(CS.getCalledValue())) 11147adc3a2bSChandler Carruth Cost += InlineConstants::CallPenalty; 11157adc3a2bSChandler Carruth } 11167adc3a2bSChandler Carruth 11177adc3a2bSChandler Carruth return Base::visitCallSite(CS); 11187adc3a2bSChandler Carruth } 11197adc3a2bSChandler Carruth 11207adc3a2bSChandler Carruth // Otherwise we're in a very special case -- an indirect function call. See 11217adc3a2bSChandler Carruth // if we can be particularly clever about this. 11227adc3a2bSChandler Carruth Value *Callee = CS.getCalledValue(); 11237adc3a2bSChandler Carruth 11247adc3a2bSChandler Carruth // First, pay the price of the argument setup. We account for the average 11257adc3a2bSChandler Carruth // 1 instruction per call argument setup here. 11267adc3a2bSChandler Carruth Cost += CS.arg_size() * InlineConstants::InstrCost; 11277adc3a2bSChandler Carruth 11287adc3a2bSChandler Carruth // Next, check if this happens to be an indirect function call to a known 11297adc3a2bSChandler Carruth // function in this inline context. If not, we've done all we can. 11307adc3a2bSChandler Carruth Function *F = dyn_cast_or_null<Function>(SimplifiedValues.lookup(Callee)); 11317adc3a2bSChandler Carruth if (!F) 11327adc3a2bSChandler Carruth return Base::visitCallSite(CS); 11337adc3a2bSChandler Carruth 11347adc3a2bSChandler Carruth // If we have a constant that we are calling as a function, we can peer 11357adc3a2bSChandler Carruth // through it and see the function target. This happens not infrequently 11367adc3a2bSChandler Carruth // during devirtualization and so we want to give it a hefty bonus for 11377adc3a2bSChandler Carruth // inlining, but cap that bonus in the event that inlining wouldn't pan 11387adc3a2bSChandler Carruth // out. Pretend to inline the function, with a custom threshold. 11391c57cc2bSEaswaran Raman auto IndirectCallParams = Params; 11401c57cc2bSEaswaran Raman IndirectCallParams.DefaultThreshold = InlineConstants::IndirectCallThreshold; 114112585b01SEaswaran Raman CallAnalyzer CA(TTI, GetAssumptionCache, GetBFI, PSI, *F, CS, 114212585b01SEaswaran Raman IndirectCallParams); 11437adc3a2bSChandler Carruth if (CA.analyzeCall(CS)) { 11447adc3a2bSChandler Carruth // We were able to inline the indirect call! Subtract the cost from the 11456d90d9f1SEaswaran Raman // threshold to get the bonus we want to apply, but don't go below zero. 11466d90d9f1SEaswaran Raman Cost -= std::max(0, CA.getThreshold() - CA.getCost()); 11477adc3a2bSChandler Carruth } 11487adc3a2bSChandler Carruth 11497adc3a2bSChandler Carruth return Base::visitCallSite(CS); 11507adc3a2bSChandler Carruth } 11517adc3a2bSChandler Carruth 11527adc3a2bSChandler Carruth bool CallAnalyzer::visitReturnInst(ReturnInst &RI) { 11537adc3a2bSChandler Carruth // At least one return instruction will be free after inlining. 11547adc3a2bSChandler Carruth bool Free = !HasReturn; 11557adc3a2bSChandler Carruth HasReturn = true; 11567adc3a2bSChandler Carruth return Free; 11577adc3a2bSChandler Carruth } 11587adc3a2bSChandler Carruth 11597adc3a2bSChandler Carruth bool CallAnalyzer::visitBranchInst(BranchInst &BI) { 11607adc3a2bSChandler Carruth // We model unconditional branches as essentially free -- they really 11617adc3a2bSChandler Carruth // shouldn't exist at all, but handling them makes the behavior of the 11627adc3a2bSChandler Carruth // inliner more regular and predictable. Interestingly, conditional branches 11637adc3a2bSChandler Carruth // which will fold away are also free. 11647adc3a2bSChandler Carruth return BI.isUnconditional() || isa<ConstantInt>(BI.getCondition()) || 11657adc3a2bSChandler Carruth dyn_cast_or_null<ConstantInt>( 11667adc3a2bSChandler Carruth SimplifiedValues.lookup(BI.getCondition())); 11677adc3a2bSChandler Carruth } 11687adc3a2bSChandler Carruth 11697adc3a2bSChandler Carruth bool CallAnalyzer::visitSwitchInst(SwitchInst &SI) { 11707adc3a2bSChandler Carruth // We model unconditional switches as free, see the comments on handling 11717adc3a2bSChandler Carruth // branches. 11727adc3a2bSChandler Carruth if (isa<ConstantInt>(SI.getCondition())) 11737adc3a2bSChandler Carruth return true; 11747adc3a2bSChandler Carruth if (Value *V = SimplifiedValues.lookup(SI.getCondition())) 11757adc3a2bSChandler Carruth if (isa<ConstantInt>(V)) 11767adc3a2bSChandler Carruth return true; 11777adc3a2bSChandler Carruth 11787ad02eeeSEric Christopher // Assume the most general case where the switch is lowered into 1179919f9e8dSJun Bum Lim // either a jump table, bit test, or a balanced binary tree consisting of 1180919f9e8dSJun Bum Lim // case clusters without merging adjacent clusters with the same 1181919f9e8dSJun Bum Lim // destination. We do not consider the switches that are lowered with a mix 1182919f9e8dSJun Bum Lim // of jump table/bit test/binary search tree. The cost of the switch is 1183919f9e8dSJun Bum Lim // proportional to the size of the tree or the size of jump table range. 11842960d41eSJun Bum Lim // 11852960d41eSJun Bum Lim // NB: We convert large switches which are just used to initialize large phi 11862960d41eSJun Bum Lim // nodes to lookup tables instead in simplify-cfg, so this shouldn't prevent 11872960d41eSJun Bum Lim // inlining those. It will prevent inlining in cases where the optimization 11882960d41eSJun Bum Lim // does not (yet) fire. 1189919f9e8dSJun Bum Lim 1190506cfb7aSJun Bum Lim // Maximum valid cost increased in this function. 1191506cfb7aSJun Bum Lim int CostUpperBound = INT_MAX - InlineConstants::InstrCost - 1; 1192506cfb7aSJun Bum Lim 1193919f9e8dSJun Bum Lim // Exit early for a large switch, assuming one case needs at least one 1194919f9e8dSJun Bum Lim // instruction. 1195919f9e8dSJun Bum Lim // FIXME: This is not true for a bit test, but ignore such case for now to 1196919f9e8dSJun Bum Lim // save compile-time. 1197919f9e8dSJun Bum Lim int64_t CostLowerBound = 1198506cfb7aSJun Bum Lim std::min((int64_t)CostUpperBound, 1199919f9e8dSJun Bum Lim (int64_t)SI.getNumCases() * InlineConstants::InstrCost + Cost); 1200919f9e8dSJun Bum Lim 1201919f9e8dSJun Bum Lim if (CostLowerBound > Threshold) { 1202919f9e8dSJun Bum Lim Cost = CostLowerBound; 1203919f9e8dSJun Bum Lim return false; 1204919f9e8dSJun Bum Lim } 1205919f9e8dSJun Bum Lim 1206919f9e8dSJun Bum Lim unsigned JumpTableSize = 0; 1207919f9e8dSJun Bum Lim unsigned NumCaseCluster = 1208919f9e8dSJun Bum Lim TTI.getEstimatedNumberOfCaseClusters(SI, JumpTableSize); 1209919f9e8dSJun Bum Lim 1210919f9e8dSJun Bum Lim // If suitable for a jump table, consider the cost for the table size and 1211919f9e8dSJun Bum Lim // branch to destination. 1212919f9e8dSJun Bum Lim if (JumpTableSize) { 1213919f9e8dSJun Bum Lim int64_t JTCost = (int64_t)JumpTableSize * InlineConstants::InstrCost + 1214919f9e8dSJun Bum Lim 4 * InlineConstants::InstrCost; 1215506cfb7aSJun Bum Lim 1216506cfb7aSJun Bum Lim Cost = std::min((int64_t)CostUpperBound, JTCost + Cost); 1217919f9e8dSJun Bum Lim return false; 1218919f9e8dSJun Bum Lim } 1219919f9e8dSJun Bum Lim 1220919f9e8dSJun Bum Lim // Considering forming a binary search, we should find the number of nodes 1221919f9e8dSJun Bum Lim // which is same as the number of comparisons when lowered. For a given 1222919f9e8dSJun Bum Lim // number of clusters, n, we can define a recursive function, f(n), to find 1223919f9e8dSJun Bum Lim // the number of nodes in the tree. The recursion is : 1224919f9e8dSJun Bum Lim // f(n) = 1 + f(n/2) + f (n - n/2), when n > 3, 1225919f9e8dSJun Bum Lim // and f(n) = n, when n <= 3. 1226919f9e8dSJun Bum Lim // This will lead a binary tree where the leaf should be either f(2) or f(3) 1227919f9e8dSJun Bum Lim // when n > 3. So, the number of comparisons from leaves should be n, while 1228919f9e8dSJun Bum Lim // the number of non-leaf should be : 1229919f9e8dSJun Bum Lim // 2^(log2(n) - 1) - 1 1230919f9e8dSJun Bum Lim // = 2^log2(n) * 2^-1 - 1 1231919f9e8dSJun Bum Lim // = n / 2 - 1. 1232919f9e8dSJun Bum Lim // Considering comparisons from leaf and non-leaf nodes, we can estimate the 1233919f9e8dSJun Bum Lim // number of comparisons in a simple closed form : 1234919f9e8dSJun Bum Lim // n + n / 2 - 1 = n * 3 / 2 - 1 1235919f9e8dSJun Bum Lim if (NumCaseCluster <= 3) { 1236919f9e8dSJun Bum Lim // Suppose a comparison includes one compare and one conditional branch. 1237919f9e8dSJun Bum Lim Cost += NumCaseCluster * 2 * InlineConstants::InstrCost; 1238919f9e8dSJun Bum Lim return false; 1239919f9e8dSJun Bum Lim } 1240506cfb7aSJun Bum Lim 1241506cfb7aSJun Bum Lim int64_t ExpectedNumberOfCompare = 3 * (int64_t)NumCaseCluster / 2 - 1; 1242506cfb7aSJun Bum Lim int64_t SwitchCost = 1243919f9e8dSJun Bum Lim ExpectedNumberOfCompare * 2 * InlineConstants::InstrCost; 1244506cfb7aSJun Bum Lim 1245506cfb7aSJun Bum Lim Cost = std::min((int64_t)CostUpperBound, SwitchCost + Cost); 1246919f9e8dSJun Bum Lim return false; 1247919f9e8dSJun Bum Lim } 1248919f9e8dSJun Bum Lim 12497adc3a2bSChandler Carruth bool CallAnalyzer::visitIndirectBrInst(IndirectBrInst &IBI) { 12507adc3a2bSChandler Carruth // We never want to inline functions that contain an indirectbr. This is 12517adc3a2bSChandler Carruth // incorrect because all the blockaddress's (in static global initializers 12527adc3a2bSChandler Carruth // for example) would be referring to the original function, and this 12537adc3a2bSChandler Carruth // indirect jump would jump from the inlined copy of the function into the 12547adc3a2bSChandler Carruth // original function which is extremely undefined behavior. 12557adc3a2bSChandler Carruth // FIXME: This logic isn't really right; we can safely inline functions with 12567adc3a2bSChandler Carruth // indirectbr's as long as no other function or global references the 12577adc3a2bSChandler Carruth // blockaddress of a block within the current function. 12587adc3a2bSChandler Carruth HasIndirectBr = true; 12597adc3a2bSChandler Carruth return false; 12607adc3a2bSChandler Carruth } 12617adc3a2bSChandler Carruth 12627adc3a2bSChandler Carruth bool CallAnalyzer::visitResumeInst(ResumeInst &RI) { 12637adc3a2bSChandler Carruth // FIXME: It's not clear that a single instruction is an accurate model for 12647adc3a2bSChandler Carruth // the inline cost of a resume instruction. 12657adc3a2bSChandler Carruth return false; 12667adc3a2bSChandler Carruth } 12677adc3a2bSChandler Carruth 12687adc3a2bSChandler Carruth bool CallAnalyzer::visitCleanupReturnInst(CleanupReturnInst &CRI) { 12697adc3a2bSChandler Carruth // FIXME: It's not clear that a single instruction is an accurate model for 12707adc3a2bSChandler Carruth // the inline cost of a cleanupret instruction. 12717adc3a2bSChandler Carruth return false; 12727adc3a2bSChandler Carruth } 12737adc3a2bSChandler Carruth 12747adc3a2bSChandler Carruth bool CallAnalyzer::visitCatchReturnInst(CatchReturnInst &CRI) { 12757adc3a2bSChandler Carruth // FIXME: It's not clear that a single instruction is an accurate model for 12768220bcc5SJoseph Tremoulet // the inline cost of a catchret instruction. 12777adc3a2bSChandler Carruth return false; 12787adc3a2bSChandler Carruth } 12797adc3a2bSChandler Carruth 12807adc3a2bSChandler Carruth bool CallAnalyzer::visitUnreachableInst(UnreachableInst &I) { 12817adc3a2bSChandler Carruth // FIXME: It might be reasonably to discount the cost of instructions leading 12827adc3a2bSChandler Carruth // to unreachable as they have the lowest possible impact on both runtime and 12837adc3a2bSChandler Carruth // code size. 12847adc3a2bSChandler Carruth return true; // No actual code is needed for unreachable. 12857adc3a2bSChandler Carruth } 12867adc3a2bSChandler Carruth 12877adc3a2bSChandler Carruth bool CallAnalyzer::visitInstruction(Instruction &I) { 12887adc3a2bSChandler Carruth // Some instructions are free. All of the free intrinsics can also be 12897adc3a2bSChandler Carruth // handled by SROA, etc. 12907adc3a2bSChandler Carruth if (TargetTransformInfo::TCC_Free == TTI.getUserCost(&I)) 12917adc3a2bSChandler Carruth return true; 12927adc3a2bSChandler Carruth 12937adc3a2bSChandler Carruth // We found something we don't understand or can't handle. Mark any SROA-able 12947adc3a2bSChandler Carruth // values in the operand list as no longer viable. 12957adc3a2bSChandler Carruth for (User::op_iterator OI = I.op_begin(), OE = I.op_end(); OI != OE; ++OI) 12967adc3a2bSChandler Carruth disableSROA(*OI); 12977adc3a2bSChandler Carruth 12987adc3a2bSChandler Carruth return false; 12997adc3a2bSChandler Carruth } 13007adc3a2bSChandler Carruth 13017adc3a2bSChandler Carruth /// \brief Analyze a basic block for its contribution to the inline cost. 13027adc3a2bSChandler Carruth /// 13037adc3a2bSChandler Carruth /// This method walks the analyzer over every instruction in the given basic 13047adc3a2bSChandler Carruth /// block and accounts for their cost during inlining at this callsite. It 13057adc3a2bSChandler Carruth /// aborts early if the threshold has been exceeded or an impossible to inline 13067adc3a2bSChandler Carruth /// construct has been detected. It returns false if inlining is no longer 13077adc3a2bSChandler Carruth /// viable, and true if inlining remains viable. 13087adc3a2bSChandler Carruth bool CallAnalyzer::analyzeBlock(BasicBlock *BB, 13097adc3a2bSChandler Carruth SmallPtrSetImpl<const Value *> &EphValues) { 13107adc3a2bSChandler Carruth for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) { 13117adc3a2bSChandler Carruth // FIXME: Currently, the number of instructions in a function regardless of 13127adc3a2bSChandler Carruth // our ability to simplify them during inline to constants or dead code, 13137adc3a2bSChandler Carruth // are actually used by the vector bonus heuristic. As long as that's true, 13147adc3a2bSChandler Carruth // we have to special case debug intrinsics here to prevent differences in 13157adc3a2bSChandler Carruth // inlining due to debug symbols. Eventually, the number of unsimplified 13167adc3a2bSChandler Carruth // instructions shouldn't factor into the cost computation, but until then, 13177adc3a2bSChandler Carruth // hack around it here. 13187adc3a2bSChandler Carruth if (isa<DbgInfoIntrinsic>(I)) 13197adc3a2bSChandler Carruth continue; 13207adc3a2bSChandler Carruth 13217adc3a2bSChandler Carruth // Skip ephemeral values. 13225a82c916SDuncan P. N. Exon Smith if (EphValues.count(&*I)) 13237adc3a2bSChandler Carruth continue; 13247adc3a2bSChandler Carruth 13257adc3a2bSChandler Carruth ++NumInstructions; 13267adc3a2bSChandler Carruth if (isa<ExtractElementInst>(I) || I->getType()->isVectorTy()) 13277adc3a2bSChandler Carruth ++NumVectorInstructions; 13287adc3a2bSChandler Carruth 1329e9434e80SSanjay Patel // If the instruction is floating point, and the target says this operation 1330e9434e80SSanjay Patel // is expensive or the function has the "use-soft-float" attribute, this may 13317adc3a2bSChandler Carruth // eventually become a library call. Treat the cost as such. 13327adc3a2bSChandler Carruth if (I->getType()->isFloatingPointTy()) { 1333e9434e80SSanjay Patel // If the function has the "use-soft-float" attribute, mark it as 1334e9434e80SSanjay Patel // expensive. 13357adc3a2bSChandler Carruth if (TTI.getFPOpCost(I->getType()) == TargetTransformInfo::TCC_Expensive || 1336908ed7f2SEric Christopher (F.getFnAttribute("use-soft-float").getValueAsString() == "true")) 13377adc3a2bSChandler Carruth Cost += InlineConstants::CallPenalty; 13387adc3a2bSChandler Carruth } 13397adc3a2bSChandler Carruth 13407adc3a2bSChandler Carruth // If the instruction simplified to a constant, there is no cost to this 13417adc3a2bSChandler Carruth // instruction. Visit the instructions using our InstVisitor to account for 13427adc3a2bSChandler Carruth // all of the per-instruction logic. The visit tree returns true if we 13437adc3a2bSChandler Carruth // consumed the instruction in any way, and false if the instruction's base 13447adc3a2bSChandler Carruth // cost should count against inlining. 13455a82c916SDuncan P. N. Exon Smith if (Base::visit(&*I)) 13467adc3a2bSChandler Carruth ++NumInstructionsSimplified; 13477adc3a2bSChandler Carruth else 13487adc3a2bSChandler Carruth Cost += InlineConstants::InstrCost; 13497adc3a2bSChandler Carruth 13507adc3a2bSChandler Carruth // If the visit this instruction detected an uninlinable pattern, abort. 13517adc3a2bSChandler Carruth if (IsRecursiveCall || ExposesReturnsTwice || HasDynamicAlloca || 13527adc3a2bSChandler Carruth HasIndirectBr || HasFrameEscape) 13537adc3a2bSChandler Carruth return false; 13547adc3a2bSChandler Carruth 13557adc3a2bSChandler Carruth // If the caller is a recursive function then we don't want to inline 13567adc3a2bSChandler Carruth // functions which allocate a lot of stack space because it would increase 13577adc3a2bSChandler Carruth // the caller stack usage dramatically. 13587adc3a2bSChandler Carruth if (IsCallerRecursive && 13597adc3a2bSChandler Carruth AllocatedSize > InlineConstants::TotalAllocaSizeRecursiveCaller) 13607adc3a2bSChandler Carruth return false; 13617adc3a2bSChandler Carruth 13627adc3a2bSChandler Carruth // Check if we've past the maximum possible threshold so we don't spin in 13637adc3a2bSChandler Carruth // huge basic blocks that will never inline. 13647adc3a2bSChandler Carruth if (Cost > Threshold) 13657adc3a2bSChandler Carruth return false; 13667adc3a2bSChandler Carruth } 13677adc3a2bSChandler Carruth 13687adc3a2bSChandler Carruth return true; 13697adc3a2bSChandler Carruth } 13707adc3a2bSChandler Carruth 13717adc3a2bSChandler Carruth /// \brief Compute the base pointer and cumulative constant offsets for V. 13727adc3a2bSChandler Carruth /// 13737adc3a2bSChandler Carruth /// This strips all constant offsets off of V, leaving it the base pointer, and 13747adc3a2bSChandler Carruth /// accumulates the total constant offset applied in the returned constant. It 13757adc3a2bSChandler Carruth /// returns 0 if V is not a pointer, and returns the constant '0' if there are 13767adc3a2bSChandler Carruth /// no constant offsets applied. 13777adc3a2bSChandler Carruth ConstantInt *CallAnalyzer::stripAndComputeInBoundsConstantOffsets(Value *&V) { 13787adc3a2bSChandler Carruth if (!V->getType()->isPointerTy()) 13797adc3a2bSChandler Carruth return nullptr; 13807adc3a2bSChandler Carruth 13817adc3a2bSChandler Carruth unsigned IntPtrWidth = DL.getPointerSizeInBits(); 13827adc3a2bSChandler Carruth APInt Offset = APInt::getNullValue(IntPtrWidth); 13837adc3a2bSChandler Carruth 13847adc3a2bSChandler Carruth // Even though we don't look through PHI nodes, we could be called on an 13857adc3a2bSChandler Carruth // instruction in an unreachable block, which may be on a cycle. 13867adc3a2bSChandler Carruth SmallPtrSet<Value *, 4> Visited; 13877adc3a2bSChandler Carruth Visited.insert(V); 13887adc3a2bSChandler Carruth do { 13897adc3a2bSChandler Carruth if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) { 13907adc3a2bSChandler Carruth if (!GEP->isInBounds() || !accumulateGEPOffset(*GEP, Offset)) 13917adc3a2bSChandler Carruth return nullptr; 13927adc3a2bSChandler Carruth V = GEP->getPointerOperand(); 13937adc3a2bSChandler Carruth } else if (Operator::getOpcode(V) == Instruction::BitCast) { 13947adc3a2bSChandler Carruth V = cast<Operator>(V)->getOperand(0); 13957adc3a2bSChandler Carruth } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) { 13965ce32728SSanjoy Das if (GA->isInterposable()) 13977adc3a2bSChandler Carruth break; 13987adc3a2bSChandler Carruth V = GA->getAliasee(); 13997adc3a2bSChandler Carruth } else { 14007adc3a2bSChandler Carruth break; 14017adc3a2bSChandler Carruth } 14027adc3a2bSChandler Carruth assert(V->getType()->isPointerTy() && "Unexpected operand type!"); 14037adc3a2bSChandler Carruth } while (Visited.insert(V).second); 14047adc3a2bSChandler Carruth 14057adc3a2bSChandler Carruth Type *IntPtrTy = DL.getIntPtrType(V->getContext()); 14067adc3a2bSChandler Carruth return cast<ConstantInt>(ConstantInt::get(IntPtrTy, Offset)); 14077adc3a2bSChandler Carruth } 14087adc3a2bSChandler Carruth 14097adc3a2bSChandler Carruth /// \brief Analyze a call site for potential inlining. 14107adc3a2bSChandler Carruth /// 14117adc3a2bSChandler Carruth /// Returns true if inlining this call is viable, and false if it is not 14127adc3a2bSChandler Carruth /// viable. It computes the cost and adjusts the threshold based on numerous 14137adc3a2bSChandler Carruth /// factors and heuristics. If this method returns false but the computed cost 14147adc3a2bSChandler Carruth /// is below the computed threshold, then inlining was forcibly disabled by 14157adc3a2bSChandler Carruth /// some artifact of the routine. 14167adc3a2bSChandler Carruth bool CallAnalyzer::analyzeCall(CallSite CS) { 14177adc3a2bSChandler Carruth ++NumCallsAnalyzed; 14187adc3a2bSChandler Carruth 14197adc3a2bSChandler Carruth // Perform some tweaks to the cost and threshold based on the direct 14207adc3a2bSChandler Carruth // callsite information. 14217adc3a2bSChandler Carruth 14227adc3a2bSChandler Carruth // We want to more aggressively inline vector-dense kernels, so up the 14237adc3a2bSChandler Carruth // threshold, and we'll lower it if the % of vector instructions gets too 14247adc3a2bSChandler Carruth // low. Note that these bonuses are some what arbitrary and evolved over time 14257adc3a2bSChandler Carruth // by accident as much as because they are principled bonuses. 14267adc3a2bSChandler Carruth // 14277adc3a2bSChandler Carruth // FIXME: It would be nice to remove all such bonuses. At least it would be 14287adc3a2bSChandler Carruth // nice to base the bonus values on something more scientific. 14297adc3a2bSChandler Carruth assert(NumInstructions == 0); 14307adc3a2bSChandler Carruth assert(NumVectorInstructions == 0); 1431f4bb2f0dSEaswaran Raman 1432f4bb2f0dSEaswaran Raman // Update the threshold based on callsite properties 1433f4bb2f0dSEaswaran Raman updateThreshold(CS, F); 1434f4bb2f0dSEaswaran Raman 14357adc3a2bSChandler Carruth // Speculatively apply all possible bonuses to Threshold. If cost exceeds 14367adc3a2bSChandler Carruth // this Threshold any time, and cost cannot decrease, we can stop processing 14377adc3a2bSChandler Carruth // the rest of the function body. 143851b809bfSEaswaran Raman Threshold += (SingleBBBonus + VectorBonus); 14397adc3a2bSChandler Carruth 1440351d9b01SXinliang David Li // Give out bonuses for the callsite, as the instructions setting them up 1441351d9b01SXinliang David Li // will be gone after inlining. 1442351d9b01SXinliang David Li Cost -= getCallsiteCost(CS, DL); 14437adc3a2bSChandler Carruth 14447adc3a2bSChandler Carruth // If this function uses the coldcc calling convention, prefer not to inline 14457adc3a2bSChandler Carruth // it. 14467adc3a2bSChandler Carruth if (F.getCallingConv() == CallingConv::Cold) 14477adc3a2bSChandler Carruth Cost += InlineConstants::ColdccPenalty; 14487adc3a2bSChandler Carruth 14497adc3a2bSChandler Carruth // Check if we're done. This can happen due to bonuses and penalties. 14507adc3a2bSChandler Carruth if (Cost > Threshold) 14517adc3a2bSChandler Carruth return false; 14527adc3a2bSChandler Carruth 14537adc3a2bSChandler Carruth if (F.empty()) 14547adc3a2bSChandler Carruth return true; 14557adc3a2bSChandler Carruth 14567adc3a2bSChandler Carruth Function *Caller = CS.getInstruction()->getParent()->getParent(); 14577adc3a2bSChandler Carruth // Check if the caller function is recursive itself. 14587adc3a2bSChandler Carruth for (User *U : Caller->users()) { 14597adc3a2bSChandler Carruth CallSite Site(U); 14607adc3a2bSChandler Carruth if (!Site) 14617adc3a2bSChandler Carruth continue; 14627adc3a2bSChandler Carruth Instruction *I = Site.getInstruction(); 14637adc3a2bSChandler Carruth if (I->getParent()->getParent() == Caller) { 14647adc3a2bSChandler Carruth IsCallerRecursive = true; 14657adc3a2bSChandler Carruth break; 14667adc3a2bSChandler Carruth } 14677adc3a2bSChandler Carruth } 14687adc3a2bSChandler Carruth 14697adc3a2bSChandler Carruth // Populate our simplified values by mapping from function arguments to call 14707adc3a2bSChandler Carruth // arguments with known important simplifications. 14717adc3a2bSChandler Carruth CallSite::arg_iterator CAI = CS.arg_begin(); 14727adc3a2bSChandler Carruth for (Function::arg_iterator FAI = F.arg_begin(), FAE = F.arg_end(); 14737adc3a2bSChandler Carruth FAI != FAE; ++FAI, ++CAI) { 14747adc3a2bSChandler Carruth assert(CAI != CS.arg_end()); 14757adc3a2bSChandler Carruth if (Constant *C = dyn_cast<Constant>(CAI)) 14765a82c916SDuncan P. N. Exon Smith SimplifiedValues[&*FAI] = C; 14777adc3a2bSChandler Carruth 14787adc3a2bSChandler Carruth Value *PtrArg = *CAI; 14797adc3a2bSChandler Carruth if (ConstantInt *C = stripAndComputeInBoundsConstantOffsets(PtrArg)) { 14805a82c916SDuncan P. N. Exon Smith ConstantOffsetPtrs[&*FAI] = std::make_pair(PtrArg, C->getValue()); 14817adc3a2bSChandler Carruth 14827adc3a2bSChandler Carruth // We can SROA any pointer arguments derived from alloca instructions. 14837adc3a2bSChandler Carruth if (isa<AllocaInst>(PtrArg)) { 14845a82c916SDuncan P. N. Exon Smith SROAArgValues[&*FAI] = PtrArg; 14857adc3a2bSChandler Carruth SROAArgCosts[PtrArg] = 0; 14867adc3a2bSChandler Carruth } 14877adc3a2bSChandler Carruth } 14887adc3a2bSChandler Carruth } 14897adc3a2bSChandler Carruth NumConstantArgs = SimplifiedValues.size(); 14907adc3a2bSChandler Carruth NumConstantOffsetPtrArgs = ConstantOffsetPtrs.size(); 14917adc3a2bSChandler Carruth NumAllocaArgs = SROAArgValues.size(); 14927adc3a2bSChandler Carruth 14937adc3a2bSChandler Carruth // FIXME: If a caller has multiple calls to a callee, we end up recomputing 14947adc3a2bSChandler Carruth // the ephemeral values multiple times (and they're completely determined by 14957adc3a2bSChandler Carruth // the callee, so this is purely duplicate work). 14967adc3a2bSChandler Carruth SmallPtrSet<const Value *, 32> EphValues; 1497aec2fa35SDaniel Jasper CodeMetrics::collectEphemeralValues(&F, &GetAssumptionCache(F), EphValues); 14987adc3a2bSChandler Carruth 14997adc3a2bSChandler Carruth // The worklist of live basic blocks in the callee *after* inlining. We avoid 15007adc3a2bSChandler Carruth // adding basic blocks of the callee which can be proven to be dead for this 15017adc3a2bSChandler Carruth // particular call site in order to get more accurate cost estimates. This 15027adc3a2bSChandler Carruth // requires a somewhat heavyweight iteration pattern: we need to walk the 15037adc3a2bSChandler Carruth // basic blocks in a breadth-first order as we insert live successors. To 15047adc3a2bSChandler Carruth // accomplish this, prioritizing for small iterations because we exit after 15057adc3a2bSChandler Carruth // crossing our threshold, we use a small-size optimized SetVector. 15067adc3a2bSChandler Carruth typedef SetVector<BasicBlock *, SmallVector<BasicBlock *, 16>, 1507567556aaSChad Rosier SmallPtrSet<BasicBlock *, 16>> 1508567556aaSChad Rosier BBSetVector; 15097adc3a2bSChandler Carruth BBSetVector BBWorklist; 15107adc3a2bSChandler Carruth BBWorklist.insert(&F.getEntryBlock()); 151151b809bfSEaswaran Raman bool SingleBB = true; 15127adc3a2bSChandler Carruth // Note that we *must not* cache the size, this loop grows the worklist. 15137adc3a2bSChandler Carruth for (unsigned Idx = 0; Idx != BBWorklist.size(); ++Idx) { 15147adc3a2bSChandler Carruth // Bail out the moment we cross the threshold. This means we'll under-count 15157adc3a2bSChandler Carruth // the cost, but only when undercounting doesn't matter. 15167adc3a2bSChandler Carruth if (Cost > Threshold) 15177adc3a2bSChandler Carruth break; 15187adc3a2bSChandler Carruth 15197adc3a2bSChandler Carruth BasicBlock *BB = BBWorklist[Idx]; 15207adc3a2bSChandler Carruth if (BB->empty()) 15217adc3a2bSChandler Carruth continue; 15227adc3a2bSChandler Carruth 15237adc3a2bSChandler Carruth // Disallow inlining a blockaddress. A blockaddress only has defined 15247adc3a2bSChandler Carruth // behavior for an indirect branch in the same function, and we do not 15257adc3a2bSChandler Carruth // currently support inlining indirect branches. But, the inliner may not 15267adc3a2bSChandler Carruth // see an indirect branch that ends up being dead code at a particular call 15277adc3a2bSChandler Carruth // site. If the blockaddress escapes the function, e.g., via a global 15287adc3a2bSChandler Carruth // variable, inlining may lead to an invalid cross-function reference. 15297adc3a2bSChandler Carruth if (BB->hasAddressTaken()) 15307adc3a2bSChandler Carruth return false; 15317adc3a2bSChandler Carruth 15327adc3a2bSChandler Carruth // Analyze the cost of this block. If we blow through the threshold, this 15337adc3a2bSChandler Carruth // returns false, and we can bail on out. 1534d295b00aSEaswaran Raman if (!analyzeBlock(BB, EphValues)) 15357adc3a2bSChandler Carruth return false; 15367adc3a2bSChandler Carruth 15377adc3a2bSChandler Carruth TerminatorInst *TI = BB->getTerminator(); 15387adc3a2bSChandler Carruth 15397adc3a2bSChandler Carruth // Add in the live successors by first checking whether we have terminator 15407adc3a2bSChandler Carruth // that may be simplified based on the values simplified by this call. 15417adc3a2bSChandler Carruth if (BranchInst *BI = dyn_cast<BranchInst>(TI)) { 15427adc3a2bSChandler Carruth if (BI->isConditional()) { 15437adc3a2bSChandler Carruth Value *Cond = BI->getCondition(); 1544567556aaSChad Rosier if (ConstantInt *SimpleCond = 1545567556aaSChad Rosier dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) { 15467adc3a2bSChandler Carruth BBWorklist.insert(BI->getSuccessor(SimpleCond->isZero() ? 1 : 0)); 15477adc3a2bSChandler Carruth continue; 15487adc3a2bSChandler Carruth } 15497adc3a2bSChandler Carruth } 15507adc3a2bSChandler Carruth } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) { 15517adc3a2bSChandler Carruth Value *Cond = SI->getCondition(); 1552567556aaSChad Rosier if (ConstantInt *SimpleCond = 1553567556aaSChad Rosier dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) { 1554927d8e61SChandler Carruth BBWorklist.insert(SI->findCaseValue(SimpleCond)->getCaseSuccessor()); 15557adc3a2bSChandler Carruth continue; 15567adc3a2bSChandler Carruth } 15577adc3a2bSChandler Carruth } 15587adc3a2bSChandler Carruth 15597adc3a2bSChandler Carruth // If we're unable to select a particular successor, just count all of 15607adc3a2bSChandler Carruth // them. 15617adc3a2bSChandler Carruth for (unsigned TIdx = 0, TSize = TI->getNumSuccessors(); TIdx != TSize; 15627adc3a2bSChandler Carruth ++TIdx) 15637adc3a2bSChandler Carruth BBWorklist.insert(TI->getSuccessor(TIdx)); 15647adc3a2bSChandler Carruth 15657adc3a2bSChandler Carruth // If we had any successors at this point, than post-inlining is likely to 15667adc3a2bSChandler Carruth // have them as well. Note that we assume any basic blocks which existed 15677adc3a2bSChandler Carruth // due to branches or switches which folded above will also fold after 15687adc3a2bSChandler Carruth // inlining. 15697adc3a2bSChandler Carruth if (SingleBB && TI->getNumSuccessors() > 1) { 15707adc3a2bSChandler Carruth // Take off the bonus we applied to the threshold. 15717adc3a2bSChandler Carruth Threshold -= SingleBBBonus; 15727adc3a2bSChandler Carruth SingleBB = false; 15737adc3a2bSChandler Carruth } 15747adc3a2bSChandler Carruth } 15757adc3a2bSChandler Carruth 157651b809bfSEaswaran Raman bool OnlyOneCallAndLocalLinkage = 157751b809bfSEaswaran Raman F.hasLocalLinkage() && F.hasOneUse() && &F == CS.getCalledFunction(); 15787adc3a2bSChandler Carruth // If this is a noduplicate call, we can still inline as long as 15797adc3a2bSChandler Carruth // inlining this would cause the removal of the caller (so the instruction 15807adc3a2bSChandler Carruth // is not actually duplicated, just moved). 15817adc3a2bSChandler Carruth if (!OnlyOneCallAndLocalLinkage && ContainsNoDuplicateCall) 15827adc3a2bSChandler Carruth return false; 15837adc3a2bSChandler Carruth 15847adc3a2bSChandler Carruth // We applied the maximum possible vector bonus at the beginning. Now, 15857adc3a2bSChandler Carruth // subtract the excess bonus, if any, from the Threshold before 15867adc3a2bSChandler Carruth // comparing against Cost. 15877adc3a2bSChandler Carruth if (NumVectorInstructions <= NumInstructions / 10) 158851b809bfSEaswaran Raman Threshold -= VectorBonus; 15897adc3a2bSChandler Carruth else if (NumVectorInstructions <= NumInstructions / 2) 159051b809bfSEaswaran Raman Threshold -= VectorBonus/2; 15917adc3a2bSChandler Carruth 159200ab73dcSHans Wennborg return Cost < std::max(1, Threshold); 15937adc3a2bSChandler Carruth } 15947adc3a2bSChandler Carruth 15957adc3a2bSChandler Carruth #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 15967adc3a2bSChandler Carruth /// \brief Dump stats about this call's analysis. 1597eb2a2546SYaron Keren LLVM_DUMP_METHOD void CallAnalyzer::dump() { 15987adc3a2bSChandler Carruth #define DEBUG_PRINT_STAT(x) dbgs() << " " #x ": " << x << "\n" 15997adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumConstantArgs); 16007adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumConstantOffsetPtrArgs); 16017adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumAllocaArgs); 16027adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumConstantPtrCmps); 16037adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumConstantPtrDiffs); 16047adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumInstructionsSimplified); 16057adc3a2bSChandler Carruth DEBUG_PRINT_STAT(NumInstructions); 16067adc3a2bSChandler Carruth DEBUG_PRINT_STAT(SROACostSavings); 16077adc3a2bSChandler Carruth DEBUG_PRINT_STAT(SROACostSavingsLost); 16087adc3a2bSChandler Carruth DEBUG_PRINT_STAT(ContainsNoDuplicateCall); 16097adc3a2bSChandler Carruth DEBUG_PRINT_STAT(Cost); 16107adc3a2bSChandler Carruth DEBUG_PRINT_STAT(Threshold); 16117adc3a2bSChandler Carruth #undef DEBUG_PRINT_STAT 16127adc3a2bSChandler Carruth } 16137adc3a2bSChandler Carruth #endif 16147adc3a2bSChandler Carruth 16157adc3a2bSChandler Carruth /// \brief Test that there are no attribute conflicts between Caller and Callee 16167adc3a2bSChandler Carruth /// that prevent inlining. 16177adc3a2bSChandler Carruth static bool functionsHaveCompatibleAttributes(Function *Caller, 16187adc3a2bSChandler Carruth Function *Callee, 16197adc3a2bSChandler Carruth TargetTransformInfo &TTI) { 16207adc3a2bSChandler Carruth return TTI.areInlineCompatible(Caller, Callee) && 16211cb242ebSAkira Hatanaka AttributeFuncs::areInlineCompatible(*Caller, *Callee); 16227adc3a2bSChandler Carruth } 16237adc3a2bSChandler Carruth 1624351d9b01SXinliang David Li int llvm::getCallsiteCost(CallSite CS, const DataLayout &DL) { 1625351d9b01SXinliang David Li int Cost = 0; 1626351d9b01SXinliang David Li for (unsigned I = 0, E = CS.arg_size(); I != E; ++I) { 1627351d9b01SXinliang David Li if (CS.isByValArgument(I)) { 1628351d9b01SXinliang David Li // We approximate the number of loads and stores needed by dividing the 1629351d9b01SXinliang David Li // size of the byval type by the target's pointer size. 1630351d9b01SXinliang David Li PointerType *PTy = cast<PointerType>(CS.getArgument(I)->getType()); 1631351d9b01SXinliang David Li unsigned TypeSize = DL.getTypeSizeInBits(PTy->getElementType()); 1632351d9b01SXinliang David Li unsigned PointerSize = DL.getPointerSizeInBits(); 1633351d9b01SXinliang David Li // Ceiling division. 1634351d9b01SXinliang David Li unsigned NumStores = (TypeSize + PointerSize - 1) / PointerSize; 1635351d9b01SXinliang David Li 1636351d9b01SXinliang David Li // If it generates more than 8 stores it is likely to be expanded as an 1637351d9b01SXinliang David Li // inline memcpy so we take that as an upper bound. Otherwise we assume 1638351d9b01SXinliang David Li // one load and one store per word copied. 1639351d9b01SXinliang David Li // FIXME: The maxStoresPerMemcpy setting from the target should be used 1640351d9b01SXinliang David Li // here instead of a magic number of 8, but it's not available via 1641351d9b01SXinliang David Li // DataLayout. 1642351d9b01SXinliang David Li NumStores = std::min(NumStores, 8U); 1643351d9b01SXinliang David Li 1644351d9b01SXinliang David Li Cost += 2 * NumStores * InlineConstants::InstrCost; 1645351d9b01SXinliang David Li } else { 1646351d9b01SXinliang David Li // For non-byval arguments subtract off one instruction per call 1647351d9b01SXinliang David Li // argument. 1648351d9b01SXinliang David Li Cost += InlineConstants::InstrCost; 1649351d9b01SXinliang David Li } 1650351d9b01SXinliang David Li } 1651351d9b01SXinliang David Li // The call instruction also disappears after inlining. 1652351d9b01SXinliang David Li Cost += InlineConstants::InstrCost + InlineConstants::CallPenalty; 1653351d9b01SXinliang David Li return Cost; 1654351d9b01SXinliang David Li } 1655351d9b01SXinliang David Li 1656ab6a6837SSean Silva InlineCost llvm::getInlineCost( 16571c57cc2bSEaswaran Raman CallSite CS, const InlineParams &Params, TargetTransformInfo &CalleeTTI, 1658aec2fa35SDaniel Jasper std::function<AssumptionCache &(Function &)> &GetAssumptionCache, 165912585b01SEaswaran Raman Optional<function_ref<BlockFrequencyInfo &(Function &)>> GetBFI, 166071069cf6SEaswaran Raman ProfileSummaryInfo *PSI) { 1661aec2fa35SDaniel Jasper return getInlineCost(CS, CS.getCalledFunction(), Params, CalleeTTI, 166212585b01SEaswaran Raman GetAssumptionCache, GetBFI, PSI); 1663b9f7120eSEaswaran Raman } 1664b9f7120eSEaswaran Raman 1665ab6a6837SSean Silva InlineCost llvm::getInlineCost( 16661c57cc2bSEaswaran Raman CallSite CS, Function *Callee, const InlineParams &Params, 1667aec2fa35SDaniel Jasper TargetTransformInfo &CalleeTTI, 1668aec2fa35SDaniel Jasper std::function<AssumptionCache &(Function &)> &GetAssumptionCache, 166912585b01SEaswaran Raman Optional<function_ref<BlockFrequencyInfo &(Function &)>> GetBFI, 1670aec2fa35SDaniel Jasper ProfileSummaryInfo *PSI) { 1671f4bb2f0dSEaswaran Raman 16727adc3a2bSChandler Carruth // Cannot inline indirect calls. 16737adc3a2bSChandler Carruth if (!Callee) 16747adc3a2bSChandler Carruth return llvm::InlineCost::getNever(); 16757adc3a2bSChandler Carruth 16767adc3a2bSChandler Carruth // Calls to functions with always-inline attributes should be inlined 16777adc3a2bSChandler Carruth // whenever possible. 16787adc3a2bSChandler Carruth if (CS.hasFnAttr(Attribute::AlwaysInline)) { 16797adc3a2bSChandler Carruth if (isInlineViable(*Callee)) 16807adc3a2bSChandler Carruth return llvm::InlineCost::getAlways(); 16817adc3a2bSChandler Carruth return llvm::InlineCost::getNever(); 16827adc3a2bSChandler Carruth } 16837adc3a2bSChandler Carruth 16847adc3a2bSChandler Carruth // Never inline functions with conflicting attributes (unless callee has 16857adc3a2bSChandler Carruth // always-inline attribute). 16865ce28f4fSChad Rosier Function *Caller = CS.getCaller(); 16875ce28f4fSChad Rosier if (!functionsHaveCompatibleAttributes(Caller, Callee, CalleeTTI)) 16887adc3a2bSChandler Carruth return llvm::InlineCost::getNever(); 16897adc3a2bSChandler Carruth 16907adc3a2bSChandler Carruth // Don't inline this call if the caller has the optnone attribute. 16915ce28f4fSChad Rosier if (Caller->hasFnAttribute(Attribute::OptimizeNone)) 16927adc3a2bSChandler Carruth return llvm::InlineCost::getNever(); 16937adc3a2bSChandler Carruth 16945ce32728SSanjoy Das // Don't inline functions which can be interposed at link-time. Don't inline 16955ce32728SSanjoy Das // functions marked noinline or call sites marked noinline. 1696107b187dSCraig Topper // Note: inlining non-exact non-interposable functions is fine, since we know 16975ce32728SSanjoy Das // we have *a* correct implementation of the source level function. 1698567556aaSChad Rosier if (Callee->isInterposable() || Callee->hasFnAttribute(Attribute::NoInline) || 1699567556aaSChad Rosier CS.isNoInline()) 17007adc3a2bSChandler Carruth return llvm::InlineCost::getNever(); 17017adc3a2bSChandler Carruth 17027adc3a2bSChandler Carruth DEBUG(llvm::dbgs() << " Analyzing call of " << Callee->getName() 17037adc3a2bSChandler Carruth << "...\n"); 17047adc3a2bSChandler Carruth 170512585b01SEaswaran Raman CallAnalyzer CA(CalleeTTI, GetAssumptionCache, GetBFI, PSI, *Callee, CS, 170612585b01SEaswaran Raman Params); 17077adc3a2bSChandler Carruth bool ShouldInline = CA.analyzeCall(CS); 17087adc3a2bSChandler Carruth 17097adc3a2bSChandler Carruth DEBUG(CA.dump()); 17107adc3a2bSChandler Carruth 17117adc3a2bSChandler Carruth // Check if there was a reason to force inlining or no inlining. 17127adc3a2bSChandler Carruth if (!ShouldInline && CA.getCost() < CA.getThreshold()) 17137adc3a2bSChandler Carruth return InlineCost::getNever(); 17147adc3a2bSChandler Carruth if (ShouldInline && CA.getCost() >= CA.getThreshold()) 17157adc3a2bSChandler Carruth return InlineCost::getAlways(); 17167adc3a2bSChandler Carruth 17177adc3a2bSChandler Carruth return llvm::InlineCost::get(CA.getCost(), CA.getThreshold()); 17187adc3a2bSChandler Carruth } 17197adc3a2bSChandler Carruth 1720b9f7120eSEaswaran Raman bool llvm::isInlineViable(Function &F) { 17217adc3a2bSChandler Carruth bool ReturnsTwice = F.hasFnAttribute(Attribute::ReturnsTwice); 17227adc3a2bSChandler Carruth for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) { 17237adc3a2bSChandler Carruth // Disallow inlining of functions which contain indirect branches or 17247adc3a2bSChandler Carruth // blockaddresses. 17257adc3a2bSChandler Carruth if (isa<IndirectBrInst>(BI->getTerminator()) || BI->hasAddressTaken()) 17267adc3a2bSChandler Carruth return false; 17277adc3a2bSChandler Carruth 17285a82c916SDuncan P. N. Exon Smith for (auto &II : *BI) { 17295a82c916SDuncan P. N. Exon Smith CallSite CS(&II); 17307adc3a2bSChandler Carruth if (!CS) 17317adc3a2bSChandler Carruth continue; 17327adc3a2bSChandler Carruth 17337adc3a2bSChandler Carruth // Disallow recursive calls. 17347adc3a2bSChandler Carruth if (&F == CS.getCalledFunction()) 17357adc3a2bSChandler Carruth return false; 17367adc3a2bSChandler Carruth 17377adc3a2bSChandler Carruth // Disallow calls which expose returns-twice to a function not previously 17387adc3a2bSChandler Carruth // attributed as such. 17397adc3a2bSChandler Carruth if (!ReturnsTwice && CS.isCall() && 17407adc3a2bSChandler Carruth cast<CallInst>(CS.getInstruction())->canReturnTwice()) 17417adc3a2bSChandler Carruth return false; 17427adc3a2bSChandler Carruth 17437adc3a2bSChandler Carruth // Disallow inlining functions that call @llvm.localescape. Doing this 17447adc3a2bSChandler Carruth // correctly would require major changes to the inliner. 17457adc3a2bSChandler Carruth if (CS.getCalledFunction() && 17467adc3a2bSChandler Carruth CS.getCalledFunction()->getIntrinsicID() == 17477adc3a2bSChandler Carruth llvm::Intrinsic::localescape) 17487adc3a2bSChandler Carruth return false; 17497adc3a2bSChandler Carruth } 17507adc3a2bSChandler Carruth } 17517adc3a2bSChandler Carruth 17527adc3a2bSChandler Carruth return true; 17537adc3a2bSChandler Carruth } 17541c57cc2bSEaswaran Raman 17551c57cc2bSEaswaran Raman // APIs to create InlineParams based on command line flags and/or other 17561c57cc2bSEaswaran Raman // parameters. 17571c57cc2bSEaswaran Raman 17581c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams(int Threshold) { 17591c57cc2bSEaswaran Raman InlineParams Params; 17601c57cc2bSEaswaran Raman 17611c57cc2bSEaswaran Raman // This field is the threshold to use for a callee by default. This is 17621c57cc2bSEaswaran Raman // derived from one or more of: 17631c57cc2bSEaswaran Raman // * optimization or size-optimization levels, 17641c57cc2bSEaswaran Raman // * a value passed to createFunctionInliningPass function, or 17651c57cc2bSEaswaran Raman // * the -inline-threshold flag. 17661c57cc2bSEaswaran Raman // If the -inline-threshold flag is explicitly specified, that is used 17671c57cc2bSEaswaran Raman // irrespective of anything else. 17681c57cc2bSEaswaran Raman if (InlineThreshold.getNumOccurrences() > 0) 17691c57cc2bSEaswaran Raman Params.DefaultThreshold = InlineThreshold; 17701c57cc2bSEaswaran Raman else 17711c57cc2bSEaswaran Raman Params.DefaultThreshold = Threshold; 17721c57cc2bSEaswaran Raman 17731c57cc2bSEaswaran Raman // Set the HintThreshold knob from the -inlinehint-threshold. 17741c57cc2bSEaswaran Raman Params.HintThreshold = HintThreshold; 17751c57cc2bSEaswaran Raman 17761c57cc2bSEaswaran Raman // Set the HotCallSiteThreshold knob from the -hot-callsite-threshold. 17771c57cc2bSEaswaran Raman Params.HotCallSiteThreshold = HotCallSiteThreshold; 17781c57cc2bSEaswaran Raman 1779974d4eeaSEaswaran Raman // If the -locally-hot-callsite-threshold is explicitly specified, use it to 1780974d4eeaSEaswaran Raman // populate LocallyHotCallSiteThreshold. Later, we populate 1781974d4eeaSEaswaran Raman // Params.LocallyHotCallSiteThreshold from -locally-hot-callsite-threshold if 1782974d4eeaSEaswaran Raman // we know that optimization level is O3 (in the getInlineParams variant that 1783974d4eeaSEaswaran Raman // takes the opt and size levels). 1784974d4eeaSEaswaran Raman // FIXME: Remove this check (and make the assignment unconditional) after 1785974d4eeaSEaswaran Raman // addressing size regression issues at O2. 1786974d4eeaSEaswaran Raman if (LocallyHotCallSiteThreshold.getNumOccurrences() > 0) 1787974d4eeaSEaswaran Raman Params.LocallyHotCallSiteThreshold = LocallyHotCallSiteThreshold; 1788974d4eeaSEaswaran Raman 178912585b01SEaswaran Raman // Set the ColdCallSiteThreshold knob from the -inline-cold-callsite-threshold. 179012585b01SEaswaran Raman Params.ColdCallSiteThreshold = ColdCallSiteThreshold; 179112585b01SEaswaran Raman 17921c57cc2bSEaswaran Raman // Set the OptMinSizeThreshold and OptSizeThreshold params only if the 17931c57cc2bSEaswaran Raman // -inlinehint-threshold commandline option is not explicitly given. If that 17941c57cc2bSEaswaran Raman // option is present, then its value applies even for callees with size and 17951c57cc2bSEaswaran Raman // minsize attributes. 17961c57cc2bSEaswaran Raman // If the -inline-threshold is not specified, set the ColdThreshold from the 17971c57cc2bSEaswaran Raman // -inlinecold-threshold even if it is not explicitly passed. If 17981c57cc2bSEaswaran Raman // -inline-threshold is specified, then -inlinecold-threshold needs to be 17991c57cc2bSEaswaran Raman // explicitly specified to set the ColdThreshold knob 18001c57cc2bSEaswaran Raman if (InlineThreshold.getNumOccurrences() == 0) { 18011c57cc2bSEaswaran Raman Params.OptMinSizeThreshold = InlineConstants::OptMinSizeThreshold; 18021c57cc2bSEaswaran Raman Params.OptSizeThreshold = InlineConstants::OptSizeThreshold; 18031c57cc2bSEaswaran Raman Params.ColdThreshold = ColdThreshold; 18041c57cc2bSEaswaran Raman } else if (ColdThreshold.getNumOccurrences() > 0) { 18051c57cc2bSEaswaran Raman Params.ColdThreshold = ColdThreshold; 18061c57cc2bSEaswaran Raman } 18071c57cc2bSEaswaran Raman return Params; 18081c57cc2bSEaswaran Raman } 18091c57cc2bSEaswaran Raman 18101c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams() { 18111c57cc2bSEaswaran Raman return getInlineParams(InlineThreshold); 18121c57cc2bSEaswaran Raman } 18131c57cc2bSEaswaran Raman 18141c57cc2bSEaswaran Raman // Compute the default threshold for inlining based on the opt level and the 18151c57cc2bSEaswaran Raman // size opt level. 18161c57cc2bSEaswaran Raman static int computeThresholdFromOptLevels(unsigned OptLevel, 18171c57cc2bSEaswaran Raman unsigned SizeOptLevel) { 18181c57cc2bSEaswaran Raman if (OptLevel > 2) 18191c57cc2bSEaswaran Raman return InlineConstants::OptAggressiveThreshold; 18201c57cc2bSEaswaran Raman if (SizeOptLevel == 1) // -Os 18211c57cc2bSEaswaran Raman return InlineConstants::OptSizeThreshold; 18221c57cc2bSEaswaran Raman if (SizeOptLevel == 2) // -Oz 18231c57cc2bSEaswaran Raman return InlineConstants::OptMinSizeThreshold; 18241c57cc2bSEaswaran Raman return InlineThreshold; 18251c57cc2bSEaswaran Raman } 18261c57cc2bSEaswaran Raman 18271c57cc2bSEaswaran Raman InlineParams llvm::getInlineParams(unsigned OptLevel, unsigned SizeOptLevel) { 1828974d4eeaSEaswaran Raman auto Params = 1829974d4eeaSEaswaran Raman getInlineParams(computeThresholdFromOptLevels(OptLevel, SizeOptLevel)); 1830974d4eeaSEaswaran Raman // At O3, use the value of -locally-hot-callsite-threshold option to populate 1831974d4eeaSEaswaran Raman // Params.LocallyHotCallSiteThreshold. Below O3, this flag has effect only 1832974d4eeaSEaswaran Raman // when it is specified explicitly. 1833974d4eeaSEaswaran Raman if (OptLevel > 2) 1834974d4eeaSEaswaran Raman Params.LocallyHotCallSiteThreshold = LocallyHotCallSiteThreshold; 1835974d4eeaSEaswaran Raman return Params; 18361c57cc2bSEaswaran Raman } 1837