lib/Analysis/IPA/InlineCost.cpp

   1 //===- InlineCost.cpp - Cost analysis for inliner -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements inline cost analysis.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/InlineCost.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/ADT/SetVector.h"
  17 #include "llvm/ADT/SmallPtrSet.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/Analysis/AssumptionCache.h"
  21 #include "llvm/Analysis/CodeMetrics.h"
  22 #include "llvm/Analysis/ConstantFolding.h"
  23 #include "llvm/Analysis/InstructionSimplify.h"
  24 #include "llvm/Analysis/TargetTransformInfo.h"
  25 #include "llvm/IR/CallSite.h"
  26 #include "llvm/IR/CallingConv.h"
  27 #include "llvm/IR/DataLayout.h"
  28 #include "llvm/IR/GetElementPtrTypeIterator.h"
  29 #include "llvm/IR/GlobalAlias.h"
  30 #include "llvm/IR/InstVisitor.h"
  31 #include "llvm/IR/IntrinsicInst.h"
  32 #include "llvm/IR/Operator.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/raw_ostream.h"
  35
  36 using namespace llvm;
  37
  38 #define DEBUG_TYPE "inline-cost"
  39
  40 STATISTIC(NumCallsAnalyzed, "Number of call sites analyzed");
  41
  42 namespace {
  43
  44 class CallAnalyzer : public InstVisitor<CallAnalyzer, bool> {
  45   typedef InstVisitor<CallAnalyzer, bool> Base;
  46   friend class InstVisitor<CallAnalyzer, bool>;
  47
  48   // DataLayout if available, or null.
  49   const DataLayout *const DL;
  50
  51   /// The TargetTransformInfo available for this compilation.
  52   const TargetTransformInfo &TTI;
  53
  54   /// The cache of @llvm.assume intrinsics.
  55   AssumptionCacheTracker *ACT;
  56
  57   // The called function.
  58   Function &F;
  59
  60   int Threshold;
  61   int Cost;
  62
  63   bool IsCallerRecursive;
  64   bool IsRecursiveCall;
  65   bool ExposesReturnsTwice;
  66   bool HasDynamicAlloca;
  67   bool ContainsNoDuplicateCall;
  68   bool HasReturn;
  69   bool HasIndirectBr;
  70
  71   /// Number of bytes allocated statically by the callee.
  72   uint64_t AllocatedSize;
  73   unsigned NumInstructions, NumVectorInstructions;
  74   int FiftyPercentVectorBonus, TenPercentVectorBonus;
  75   int VectorBonus;
  76
  77   // While we walk the potentially-inlined instructions, we build up and
  78   // maintain a mapping of simplified values specific to this callsite. The
  79   // idea is to propagate any special information we have about arguments to
  80   // this call through the inlinable section of the function, and account for
  81   // likely simplifications post-inlining. The most important aspect we track
  82   // is CFG altering simplifications -- when we prove a basic block dead, that
  83   // can cause dramatic shifts in the cost of inlining a function.
  84   DenseMap<Value *, Constant *> SimplifiedValues;
  85
  86   // Keep track of the values which map back (through function arguments) to
  87   // allocas on the caller stack which could be simplified through SROA.
  88   DenseMap<Value *, Value *> SROAArgValues;
  89
  90   // The mapping of caller Alloca values to their accumulated cost savings. If
  91   // we have to disable SROA for one of the allocas, this tells us how much
  92   // cost must be added.
  93   DenseMap<Value *, int> SROAArgCosts;
  94
  95   // Keep track of values which map to a pointer base and constant offset.
  96   DenseMap<Value *, std::pair<Value *, APInt> > ConstantOffsetPtrs;
  97
  98   // Custom simplification helper routines.
  99   bool isAllocaDerivedArg(Value *V);
 100   bool lookupSROAArgAndCost(Value *V, Value *&Arg,
 101                             DenseMap<Value *, int>::iterator &CostIt);
 102   void disableSROA(DenseMap<Value *, int>::iterator CostIt);
 103   void disableSROA(Value *V);
 104   void accumulateSROACost(DenseMap<Value *, int>::iterator CostIt,
 105                           int InstructionCost);
 106   bool isGEPOffsetConstant(GetElementPtrInst &GEP);
 107   bool accumulateGEPOffset(GEPOperator &GEP, APInt &Offset);
 108   bool simplifyCallSite(Function *F, CallSite CS);
 109   ConstantInt *stripAndComputeInBoundsConstantOffsets(Value *&V);
 110
 111   // Custom analysis routines.
 112   bool analyzeBlock(BasicBlock *BB, SmallPtrSetImpl<const Value *> &EphValues);
 113
 114   // Disable several entry points to the visitor so we don't accidentally use
 115   // them by declaring but not defining them here.
 116   void visit(Module *);     void visit(Module &);
 117   void visit(Function *);   void visit(Function &);
 118   void visit(BasicBlock *); void visit(BasicBlock &);
 119
 120   // Provide base case for our instruction visit.
 121   bool visitInstruction(Instruction &I);
 122
 123   // Our visit overrides.
 124   bool visitAlloca(AllocaInst &I);
 125   bool visitPHI(PHINode &I);
 126   bool visitGetElementPtr(GetElementPtrInst &I);
 127   bool visitBitCast(BitCastInst &I);
 128   bool visitPtrToInt(PtrToIntInst &I);
 129   bool visitIntToPtr(IntToPtrInst &I);
 130   bool visitCastInst(CastInst &I);
 131   bool visitUnaryInstruction(UnaryInstruction &I);
 132   bool visitCmpInst(CmpInst &I);
 133   bool visitSub(BinaryOperator &I);
 134   bool visitBinaryOperator(BinaryOperator &I);
 135   bool visitLoad(LoadInst &I);
 136   bool visitStore(StoreInst &I);
 137   bool visitExtractValue(ExtractValueInst &I);
 138   bool visitInsertValue(InsertValueInst &I);
 139   bool visitCallSite(CallSite CS);
 140   bool visitReturnInst(ReturnInst &RI);
 141   bool visitBranchInst(BranchInst &BI);
 142   bool visitSwitchInst(SwitchInst &SI);
 143   bool visitIndirectBrInst(IndirectBrInst &IBI);
 144   bool visitResumeInst(ResumeInst &RI);
 145   bool visitUnreachableInst(UnreachableInst &I);
 146
 147 public:
 148   CallAnalyzer(const DataLayout *DL, const TargetTransformInfo &TTI,
 149                AssumptionCacheTracker *ACT, Function &Callee, int Threshold)
 150       : DL(DL), TTI(TTI), ACT(ACT), F(Callee), Threshold(Threshold), Cost(0),
 151         IsCallerRecursive(false), IsRecursiveCall(false),
 152         ExposesReturnsTwice(false), HasDynamicAlloca(false),
 153         ContainsNoDuplicateCall(false), HasReturn(false), HasIndirectBr(false),
 154         AllocatedSize(0), NumInstructions(0), NumVectorInstructions(0),
 155         FiftyPercentVectorBonus(0), TenPercentVectorBonus(0), VectorBonus(0),
 156         NumConstantArgs(0), NumConstantOffsetPtrArgs(0), NumAllocaArgs(0),
 157         NumConstantPtrCmps(0), NumConstantPtrDiffs(0),
 158         NumInstructionsSimplified(0), SROACostSavings(0),
 159         SROACostSavingsLost(0) {}
 160
 161   bool analyzeCall(CallSite CS);
 162
 163   int getThreshold() { return Threshold; }
 164   int getCost() { return Cost; }
 165
 166   // Keep a bunch of stats about the cost savings found so we can print them
 167   // out when debugging.
 168   unsigned NumConstantArgs;
 169   unsigned NumConstantOffsetPtrArgs;
 170   unsigned NumAllocaArgs;
 171   unsigned NumConstantPtrCmps;
 172   unsigned NumConstantPtrDiffs;
 173   unsigned NumInstructionsSimplified;
 174   unsigned SROACostSavings;
 175   unsigned SROACostSavingsLost;
 176
 177   void dump();
 178 };
 179
 180 } // namespace
 181
 182 /// \brief Test whether the given value is an Alloca-derived function argument.
 183 bool CallAnalyzer::isAllocaDerivedArg(Value *V) {
 184   return SROAArgValues.count(V);
 185 }
 186
 187 /// \brief Lookup the SROA-candidate argument and cost iterator which V maps to.
 188 /// Returns false if V does not map to a SROA-candidate.
 189 bool CallAnalyzer::lookupSROAArgAndCost(
 190     Value *V, Value *&Arg, DenseMap<Value *, int>::iterator &CostIt) {
 191   if (SROAArgValues.empty() || SROAArgCosts.empty())
 192     return false;
 193
 194   DenseMap<Value *, Value *>::iterator ArgIt = SROAArgValues.find(V);
 195   if (ArgIt == SROAArgValues.end())
 196     return false;
 197
 198   Arg = ArgIt->second;
 199   CostIt = SROAArgCosts.find(Arg);
 200   return CostIt != SROAArgCosts.end();
 201 }
 202
 203 /// \brief Disable SROA for the candidate marked by this cost iterator.
 204 ///
 205 /// This marks the candidate as no longer viable for SROA, and adds the cost
 206 /// savings associated with it back into the inline cost measurement.
 207 void CallAnalyzer::disableSROA(DenseMap<Value *, int>::iterator CostIt) {
 208   // If we're no longer able to perform SROA we need to undo its cost savings
 209   // and prevent subsequent analysis.
 210   Cost += CostIt->second;
 211   SROACostSavings -= CostIt->second;
 212   SROACostSavingsLost += CostIt->second;
 213   SROAArgCosts.erase(CostIt);
 214 }
 215
 216 /// \brief If 'V' maps to a SROA candidate, disable SROA for it.
 217 void CallAnalyzer::disableSROA(Value *V) {
 218   Value *SROAArg;
 219   DenseMap<Value *, int>::iterator CostIt;
 220   if (lookupSROAArgAndCost(V, SROAArg, CostIt))
 221     disableSROA(CostIt);
 222 }
 223
 224 /// \brief Accumulate the given cost for a particular SROA candidate.
 225 void CallAnalyzer::accumulateSROACost(DenseMap<Value *, int>::iterator CostIt,
 226                                       int InstructionCost) {
 227   CostIt->second += InstructionCost;
 228   SROACostSavings += InstructionCost;
 229 }
 230
 231 /// \brief Check whether a GEP's indices are all constant.
 232 ///
 233 /// Respects any simplified values known during the analysis of this callsite.
 234 bool CallAnalyzer::isGEPOffsetConstant(GetElementPtrInst &GEP) {
 235   for (User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end(); I != E; ++I)
 236     if (!isa<Constant>(*I) && !SimplifiedValues.lookup(*I))
 237       return false;
 238
 239   return true;
 240 }
 241
 242 /// \brief Accumulate a constant GEP offset into an APInt if possible.
 243 ///
 244 /// Returns false if unable to compute the offset for any reason. Respects any
 245 /// simplified values known during the analysis of this callsite.
 246 bool CallAnalyzer::accumulateGEPOffset(GEPOperator &GEP, APInt &Offset) {
 247   if (!DL)
 248     return false;
 249
 250   unsigned IntPtrWidth = DL->getPointerSizeInBits();
 251   assert(IntPtrWidth == Offset.getBitWidth());
 252
 253   for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
 254        GTI != GTE; ++GTI) {
 255     ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
 256     if (!OpC)
 257       if (Constant *SimpleOp = SimplifiedValues.lookup(GTI.getOperand()))
 258         OpC = dyn_cast<ConstantInt>(SimpleOp);
 259     if (!OpC)
 260       return false;
 261     if (OpC->isZero()) continue;
 262
 263     // Handle a struct index, which adds its field offset to the pointer.
 264     if (StructType *STy = dyn_cast<StructType>(*GTI)) {
 265       unsigned ElementIdx = OpC->getZExtValue();
 266       const StructLayout *SL = DL->getStructLayout(STy);
 267       Offset += APInt(IntPtrWidth, SL->getElementOffset(ElementIdx));
 268       continue;
 269     }
 270
 271     APInt TypeSize(IntPtrWidth, DL->getTypeAllocSize(GTI.getIndexedType()));
 272     Offset += OpC->getValue().sextOrTrunc(IntPtrWidth) * TypeSize;
 273   }
 274   return true;
 275 }
 276
 277 bool CallAnalyzer::visitAlloca(AllocaInst &I) {
 278   // Check whether inlining will turn a dynamic alloca into a static
 279   // alloca, and handle that case.
 280   if (I.isArrayAllocation()) {
 281     if (Constant *Size = SimplifiedValues.lookup(I.getArraySize())) {
 282       ConstantInt *AllocSize = dyn_cast<ConstantInt>(Size);
 283       assert(AllocSize && "Allocation size not a constant int?");
 284       Type *Ty = I.getAllocatedType();
 285       AllocatedSize += Ty->getPrimitiveSizeInBits() * AllocSize->getZExtValue();
 286       return Base::visitAlloca(I);
 287     }
 288   }
 289
 290   // Accumulate the allocated size.
 291   if (I.isStaticAlloca()) {
 292     Type *Ty = I.getAllocatedType();
 293     AllocatedSize += (DL ? DL->getTypeAllocSize(Ty) :
 294                       Ty->getPrimitiveSizeInBits());
 295   }
 296
 297   // We will happily inline static alloca instructions.
 298   if (I.isStaticAlloca())
 299     return Base::visitAlloca(I);
 300
 301   // FIXME: This is overly conservative. Dynamic allocas are inefficient for
 302   // a variety of reasons, and so we would like to not inline them into
 303   // functions which don't currently have a dynamic alloca. This simply
 304   // disables inlining altogether in the presence of a dynamic alloca.
 305   HasDynamicAlloca = true;
 306   return false;
 307 }
 308
 309 bool CallAnalyzer::visitPHI(PHINode &I) {
 310   // FIXME: We should potentially be tracking values through phi nodes,
 311   // especially when they collapse to a single value due to deleted CFG edges
 312   // during inlining.
 313
 314   // FIXME: We need to propagate SROA *disabling* through phi nodes, even
 315   // though we don't want to propagate it's bonuses. The idea is to disable
 316   // SROA if it *might* be used in an inappropriate manner.
 317
 318   // Phi nodes are always zero-cost.
 319   return true;
 320 }
 321
 322 bool CallAnalyzer::visitGetElementPtr(GetElementPtrInst &I) {
 323   Value *SROAArg;
 324   DenseMap<Value *, int>::iterator CostIt;
 325   bool SROACandidate = lookupSROAArgAndCost(I.getPointerOperand(),
 326                                             SROAArg, CostIt);
 327
 328   // Try to fold GEPs of constant-offset call site argument pointers. This
 329   // requires target data and inbounds GEPs.
 330   if (DL && I.isInBounds()) {
 331     // Check if we have a base + offset for the pointer.
 332     Value *Ptr = I.getPointerOperand();
 333     std::pair<Value *, APInt> BaseAndOffset = ConstantOffsetPtrs.lookup(Ptr);
 334     if (BaseAndOffset.first) {
 335       // Check if the offset of this GEP is constant, and if so accumulate it
 336       // into Offset.
 337       if (!accumulateGEPOffset(cast<GEPOperator>(I), BaseAndOffset.second)) {
 338         // Non-constant GEPs aren't folded, and disable SROA.
 339         if (SROACandidate)
 340           disableSROA(CostIt);
 341         return false;
 342       }
 343
 344       // Add the result as a new mapping to Base + Offset.
 345       ConstantOffsetPtrs[&I] = BaseAndOffset;
 346
 347       // Also handle SROA candidates here, we already know that the GEP is
 348       // all-constant indexed.
 349       if (SROACandidate)
 350         SROAArgValues[&I] = SROAArg;
 351
 352       return true;
 353     }
 354   }
 355
 356   if (isGEPOffsetConstant(I)) {
 357     if (SROACandidate)
 358       SROAArgValues[&I] = SROAArg;
 359
 360     // Constant GEPs are modeled as free.
 361     return true;
 362   }
 363
 364   // Variable GEPs will require math and will disable SROA.
 365   if (SROACandidate)
 366     disableSROA(CostIt);
 367   return false;
 368 }
 369
 370 bool CallAnalyzer::visitBitCast(BitCastInst &I) {
 371   // Propagate constants through bitcasts.
 372   Constant *COp = dyn_cast<Constant>(I.getOperand(0));
 373   if (!COp)
 374     COp = SimplifiedValues.lookup(I.getOperand(0));
 375   if (COp)
 376     if (Constant *C = ConstantExpr::getBitCast(COp, I.getType())) {
 377       SimplifiedValues[&I] = C;
 378       return true;
 379     }
 380
 381   // Track base/offsets through casts
 382   std::pair<Value *, APInt> BaseAndOffset
 383     = ConstantOffsetPtrs.lookup(I.getOperand(0));
 384   // Casts don't change the offset, just wrap it up.
 385   if (BaseAndOffset.first)
 386     ConstantOffsetPtrs[&I] = BaseAndOffset;
 387
 388   // Also look for SROA candidates here.
 389   Value *SROAArg;
 390   DenseMap<Value *, int>::iterator CostIt;
 391   if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt))
 392     SROAArgValues[&I] = SROAArg;
 393
 394   // Bitcasts are always zero cost.
 395   return true;
 396 }
 397
 398 bool CallAnalyzer::visitPtrToInt(PtrToIntInst &I) {
 399   // Propagate constants through ptrtoint.
 400   Constant *COp = dyn_cast<Constant>(I.getOperand(0));
 401   if (!COp)
 402     COp = SimplifiedValues.lookup(I.getOperand(0));
 403   if (COp)
 404     if (Constant *C = ConstantExpr::getPtrToInt(COp, I.getType())) {
 405       SimplifiedValues[&I] = C;
 406       return true;
 407     }
 408
 409   // Track base/offset pairs when converted to a plain integer provided the
 410   // integer is large enough to represent the pointer.
 411   unsigned IntegerSize = I.getType()->getScalarSizeInBits();
 412   const DataLayout &DL = I.getModule()->getDataLayout();
 413   if (IntegerSize >= DL.getPointerSizeInBits()) {
 414     std::pair<Value *, APInt> BaseAndOffset
 415       = ConstantOffsetPtrs.lookup(I.getOperand(0));
 416     if (BaseAndOffset.first)
 417       ConstantOffsetPtrs[&I] = BaseAndOffset;
 418   }
 419
 420   // This is really weird. Technically, ptrtoint will disable SROA. However,
 421   // unless that ptrtoint is *used* somewhere in the live basic blocks after
 422   // inlining, it will be nuked, and SROA should proceed. All of the uses which
 423   // would block SROA would also block SROA if applied directly to a pointer,
 424   // and so we can just add the integer in here. The only places where SROA is
 425   // preserved either cannot fire on an integer, or won't in-and-of themselves
 426   // disable SROA (ext) w/o some later use that we would see and disable.
 427   Value *SROAArg;
 428   DenseMap<Value *, int>::iterator CostIt;
 429   if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt))
 430     SROAArgValues[&I] = SROAArg;
 431
 432   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
 433 }
 434
 435 bool CallAnalyzer::visitIntToPtr(IntToPtrInst &I) {
 436   // Propagate constants through ptrtoint.
 437   Constant *COp = dyn_cast<Constant>(I.getOperand(0));
 438   if (!COp)
 439     COp = SimplifiedValues.lookup(I.getOperand(0));
 440   if (COp)
 441     if (Constant *C = ConstantExpr::getIntToPtr(COp, I.getType())) {
 442       SimplifiedValues[&I] = C;
 443       return true;
 444     }
 445
 446   // Track base/offset pairs when round-tripped through a pointer without
 447   // modifications provided the integer is not too large.
 448   Value *Op = I.getOperand(0);
 449   unsigned IntegerSize = Op->getType()->getScalarSizeInBits();
 450   const DataLayout &DL = I.getModule()->getDataLayout();
 451   if (IntegerSize <= DL.getPointerSizeInBits()) {
 452     std::pair<Value *, APInt> BaseAndOffset = ConstantOffsetPtrs.lookup(Op);
 453     if (BaseAndOffset.first)
 454       ConstantOffsetPtrs[&I] = BaseAndOffset;
 455   }
 456
 457   // "Propagate" SROA here in the same manner as we do for ptrtoint above.
 458   Value *SROAArg;
 459   DenseMap<Value *, int>::iterator CostIt;
 460   if (lookupSROAArgAndCost(Op, SROAArg, CostIt))
 461     SROAArgValues[&I] = SROAArg;
 462
 463   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
 464 }
 465
 466 bool CallAnalyzer::visitCastInst(CastInst &I) {
 467   // Propagate constants through ptrtoint.
 468   Constant *COp = dyn_cast<Constant>(I.getOperand(0));
 469   if (!COp)
 470     COp = SimplifiedValues.lookup(I.getOperand(0));
 471   if (COp)
 472     if (Constant *C = ConstantExpr::getCast(I.getOpcode(), COp, I.getType())) {
 473       SimplifiedValues[&I] = C;
 474       return true;
 475     }
 476
 477   // Disable SROA in the face of arbitrary casts we don't whitelist elsewhere.
 478   disableSROA(I.getOperand(0));
 479
 480   return TargetTransformInfo::TCC_Free == TTI.getUserCost(&I);
 481 }
 482
 483 bool CallAnalyzer::visitUnaryInstruction(UnaryInstruction &I) {
 484   Value *Operand = I.getOperand(0);
 485   Constant *COp = dyn_cast<Constant>(Operand);
 486   if (!COp)
 487     COp = SimplifiedValues.lookup(Operand);
 488   if (COp)
 489     if (Constant *C = ConstantFoldInstOperands(I.getOpcode(), I.getType(),
 490                                                COp, DL)) {
 491       SimplifiedValues[&I] = C;
 492       return true;
 493     }
 494
 495   // Disable any SROA on the argument to arbitrary unary operators.
 496   disableSROA(Operand);
 497
 498   return false;
 499 }
 500
 501 bool CallAnalyzer::visitCmpInst(CmpInst &I) {
 502   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 503   // First try to handle simplified comparisons.
 504   if (!isa<Constant>(LHS))
 505     if (Constant *SimpleLHS = SimplifiedValues.lookup(LHS))
 506       LHS = SimpleLHS;
 507   if (!isa<Constant>(RHS))
 508     if (Constant *SimpleRHS = SimplifiedValues.lookup(RHS))
 509       RHS = SimpleRHS;
 510   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
 511     if (Constant *CRHS = dyn_cast<Constant>(RHS))
 512       if (Constant *C = ConstantExpr::getCompare(I.getPredicate(), CLHS, CRHS)) {
 513         SimplifiedValues[&I] = C;
 514         return true;
 515       }
 516   }
 517
 518   if (I.getOpcode() == Instruction::FCmp)
 519     return false;
 520
 521   // Otherwise look for a comparison between constant offset pointers with
 522   // a common base.
 523   Value *LHSBase, *RHSBase;
 524   APInt LHSOffset, RHSOffset;
 525   std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS);
 526   if (LHSBase) {
 527     std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS);
 528     if (RHSBase && LHSBase == RHSBase) {
 529       // We have common bases, fold the icmp to a constant based on the
 530       // offsets.
 531       Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset);
 532       Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset);
 533       if (Constant *C = ConstantExpr::getICmp(I.getPredicate(), CLHS, CRHS)) {
 534         SimplifiedValues[&I] = C;
 535         ++NumConstantPtrCmps;
 536         return true;
 537       }
 538     }
 539   }
 540
 541   // If the comparison is an equality comparison with null, we can simplify it
 542   // for any alloca-derived argument.
 543   if (I.isEquality() && isa<ConstantPointerNull>(I.getOperand(1)))
 544     if (isAllocaDerivedArg(I.getOperand(0))) {
 545       // We can actually predict the result of comparisons between an
 546       // alloca-derived value and null. Note that this fires regardless of
 547       // SROA firing.
 548       bool IsNotEqual = I.getPredicate() == CmpInst::ICMP_NE;
 549       SimplifiedValues[&I] = IsNotEqual ? ConstantInt::getTrue(I.getType())
 550                                         : ConstantInt::getFalse(I.getType());
 551       return true;
 552     }
 553
 554   // Finally check for SROA candidates in comparisons.
 555   Value *SROAArg;
 556   DenseMap<Value *, int>::iterator CostIt;
 557   if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) {
 558     if (isa<ConstantPointerNull>(I.getOperand(1))) {
 559       accumulateSROACost(CostIt, InlineConstants::InstrCost);
 560       return true;
 561     }
 562
 563     disableSROA(CostIt);
 564   }
 565
 566   return false;
 567 }
 568
 569 bool CallAnalyzer::visitSub(BinaryOperator &I) {
 570   // Try to handle a special case: we can fold computing the difference of two
 571   // constant-related pointers.
 572   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 573   Value *LHSBase, *RHSBase;
 574   APInt LHSOffset, RHSOffset;
 575   std::tie(LHSBase, LHSOffset) = ConstantOffsetPtrs.lookup(LHS);
 576   if (LHSBase) {
 577     std::tie(RHSBase, RHSOffset) = ConstantOffsetPtrs.lookup(RHS);
 578     if (RHSBase && LHSBase == RHSBase) {
 579       // We have common bases, fold the subtract to a constant based on the
 580       // offsets.
 581       Constant *CLHS = ConstantInt::get(LHS->getContext(), LHSOffset);
 582       Constant *CRHS = ConstantInt::get(RHS->getContext(), RHSOffset);
 583       if (Constant *C = ConstantExpr::getSub(CLHS, CRHS)) {
 584         SimplifiedValues[&I] = C;
 585         ++NumConstantPtrDiffs;
 586         return true;
 587       }
 588     }
 589   }
 590
 591   // Otherwise, fall back to the generic logic for simplifying and handling
 592   // instructions.
 593   return Base::visitSub(I);
 594 }
 595
 596 bool CallAnalyzer::visitBinaryOperator(BinaryOperator &I) {
 597   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
 598   if (!isa<Constant>(LHS))
 599     if (Constant *SimpleLHS = SimplifiedValues.lookup(LHS))
 600       LHS = SimpleLHS;
 601   if (!isa<Constant>(RHS))
 602     if (Constant *SimpleRHS = SimplifiedValues.lookup(RHS))
 603       RHS = SimpleRHS;
 604   Value *SimpleV = nullptr;
 605   if (auto FI = dyn_cast<FPMathOperator>(&I))
 606     SimpleV =
 607         SimplifyFPBinOp(I.getOpcode(), LHS, RHS, FI->getFastMathFlags(), DL);
 608   else
 609     SimpleV = SimplifyBinOp(I.getOpcode(), LHS, RHS, DL);
 610
 611   if (Constant *C = dyn_cast_or_null<Constant>(SimpleV)) {
 612     SimplifiedValues[&I] = C;
 613     return true;
 614   }
 615
 616   // Disable any SROA on arguments to arbitrary, unsimplified binary operators.
 617   disableSROA(LHS);
 618   disableSROA(RHS);
 619
 620   return false;
 621 }
 622
 623 bool CallAnalyzer::visitLoad(LoadInst &I) {
 624   Value *SROAArg;
 625   DenseMap<Value *, int>::iterator CostIt;
 626   if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) {
 627     if (I.isSimple()) {
 628       accumulateSROACost(CostIt, InlineConstants::InstrCost);
 629       return true;
 630     }
 631
 632     disableSROA(CostIt);
 633   }
 634
 635   return false;
 636 }
 637
 638 bool CallAnalyzer::visitStore(StoreInst &I) {
 639   Value *SROAArg;
 640   DenseMap<Value *, int>::iterator CostIt;
 641   if (lookupSROAArgAndCost(I.getOperand(0), SROAArg, CostIt)) {
 642     if (I.isSimple()) {
 643       accumulateSROACost(CostIt, InlineConstants::InstrCost);
 644       return true;
 645     }
 646
 647     disableSROA(CostIt);
 648   }
 649
 650   return false;
 651 }
 652
 653 bool CallAnalyzer::visitExtractValue(ExtractValueInst &I) {
 654   // Constant folding for extract value is trivial.
 655   Constant *C = dyn_cast<Constant>(I.getAggregateOperand());
 656   if (!C)
 657     C = SimplifiedValues.lookup(I.getAggregateOperand());
 658   if (C) {
 659     SimplifiedValues[&I] = ConstantExpr::getExtractValue(C, I.getIndices());
 660     return true;
 661   }
 662
 663   // SROA can look through these but give them a cost.
 664   return false;
 665 }
 666
 667 bool CallAnalyzer::visitInsertValue(InsertValueInst &I) {
 668   // Constant folding for insert value is trivial.
 669   Constant *AggC = dyn_cast<Constant>(I.getAggregateOperand());
 670   if (!AggC)
 671     AggC = SimplifiedValues.lookup(I.getAggregateOperand());
 672   Constant *InsertedC = dyn_cast<Constant>(I.getInsertedValueOperand());
 673   if (!InsertedC)
 674     InsertedC = SimplifiedValues.lookup(I.getInsertedValueOperand());
 675   if (AggC && InsertedC) {
 676     SimplifiedValues[&I] = ConstantExpr::getInsertValue(AggC, InsertedC,
 677                                                         I.getIndices());
 678     return true;
 679   }
 680
 681   // SROA can look through these but give them a cost.
 682   return false;
 683 }
 684
 685 /// \brief Try to simplify a call site.
 686 ///
 687 /// Takes a concrete function and callsite and tries to actually simplify it by
 688 /// analyzing the arguments and call itself with instsimplify. Returns true if
 689 /// it has simplified the callsite to some other entity (a constant), making it
 690 /// free.
 691 bool CallAnalyzer::simplifyCallSite(Function *F, CallSite CS) {
 692   // FIXME: Using the instsimplify logic directly for this is inefficient
 693   // because we have to continually rebuild the argument list even when no
 694   // simplifications can be performed. Until that is fixed with remapping
 695   // inside of instsimplify, directly constant fold calls here.
 696   if (!canConstantFoldCallTo(F))
 697     return false;
 698
 699   // Try to re-map the arguments to constants.
 700   SmallVector<Constant *, 4> ConstantArgs;
 701   ConstantArgs.reserve(CS.arg_size());
 702   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
 703        I != E; ++I) {
 704     Constant *C = dyn_cast<Constant>(*I);
 705     if (!C)
 706       C = dyn_cast_or_null<Constant>(SimplifiedValues.lookup(*I));
 707     if (!C)
 708       return false; // This argument doesn't map to a constant.
 709
 710     ConstantArgs.push_back(C);
 711   }
 712   if (Constant *C = ConstantFoldCall(F, ConstantArgs)) {
 713     SimplifiedValues[CS.getInstruction()] = C;
 714     return true;
 715   }
 716
 717   return false;
 718 }
 719
 720 bool CallAnalyzer::visitCallSite(CallSite CS) {
 721   if (CS.hasFnAttr(Attribute::ReturnsTwice) &&
 722       !F.hasFnAttribute(Attribute::ReturnsTwice)) {
 723     // This aborts the entire analysis.
 724     ExposesReturnsTwice = true;
 725     return false;
 726   }
 727   if (CS.isCall() &&
 728       cast<CallInst>(CS.getInstruction())->cannotDuplicate())
 729     ContainsNoDuplicateCall = true;
 730
 731   if (Function *F = CS.getCalledFunction()) {
 732     // When we have a concrete function, first try to simplify it directly.
 733     if (simplifyCallSite(F, CS))
 734       return true;
 735
 736     // Next check if it is an intrinsic we know about.
 737     // FIXME: Lift this into part of the InstVisitor.
 738     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction())) {
 739       switch (II->getIntrinsicID()) {
 740       default:
 741         return Base::visitCallSite(CS);
 742
 743       case Intrinsic::memset:
 744       case Intrinsic::memcpy:
 745       case Intrinsic::memmove:
 746         // SROA can usually chew through these intrinsics, but they aren't free.
 747         return false;
 748       }
 749     }
 750
 751     if (F == CS.getInstruction()->getParent()->getParent()) {
 752       // This flag will fully abort the analysis, so don't bother with anything
 753       // else.
 754       IsRecursiveCall = true;
 755       return false;
 756     }
 757
 758     if (TTI.isLoweredToCall(F)) {
 759       // We account for the average 1 instruction per call argument setup
 760       // here.
 761       Cost += CS.arg_size() * InlineConstants::InstrCost;
 762
 763       // Everything other than inline ASM will also have a significant cost
 764       // merely from making the call.
 765       if (!isa<InlineAsm>(CS.getCalledValue()))
 766         Cost += InlineConstants::CallPenalty;
 767     }
 768
 769     return Base::visitCallSite(CS);
 770   }
 771
 772   // Otherwise we're in a very special case -- an indirect function call. See
 773   // if we can be particularly clever about this.
 774   Value *Callee = CS.getCalledValue();
 775
 776   // First, pay the price of the argument setup. We account for the average
 777   // 1 instruction per call argument setup here.
 778   Cost += CS.arg_size() * InlineConstants::InstrCost;
 779
 780   // Next, check if this happens to be an indirect function call to a known
 781   // function in this inline context. If not, we've done all we can.
 782   Function *F = dyn_cast_or_null<Function>(SimplifiedValues.lookup(Callee));
 783   if (!F)
 784     return Base::visitCallSite(CS);
 785
 786   // If we have a constant that we are calling as a function, we can peer
 787   // through it and see the function target. This happens not infrequently
 788   // during devirtualization and so we want to give it a hefty bonus for
 789   // inlining, but cap that bonus in the event that inlining wouldn't pan
 790   // out. Pretend to inline the function, with a custom threshold.
 791   CallAnalyzer CA(DL, TTI, ACT, *F, InlineConstants::IndirectCallThreshold);
 792   if (CA.analyzeCall(CS)) {
 793     // We were able to inline the indirect call! Subtract the cost from the
 794     // bonus we want to apply, but don't go below zero.
 795     Cost -= std::max(0, InlineConstants::IndirectCallThreshold - CA.getCost());
 796   }
 797
 798   return Base::visitCallSite(CS);
 799 }
 800
 801 bool CallAnalyzer::visitReturnInst(ReturnInst &RI) {
 802   // At least one return instruction will be free after inlining.
 803   bool Free = !HasReturn;
 804   HasReturn = true;
 805   return Free;
 806 }
 807
 808 bool CallAnalyzer::visitBranchInst(BranchInst &BI) {
 809   // We model unconditional branches as essentially free -- they really
 810   // shouldn't exist at all, but handling them makes the behavior of the
 811   // inliner more regular and predictable. Interestingly, conditional branches
 812   // which will fold away are also free.
 813   return BI.isUnconditional() || isa<ConstantInt>(BI.getCondition()) ||
 814          dyn_cast_or_null<ConstantInt>(
 815              SimplifiedValues.lookup(BI.getCondition()));
 816 }
 817
 818 bool CallAnalyzer::visitSwitchInst(SwitchInst &SI) {
 819   // We model unconditional switches as free, see the comments on handling
 820   // branches.
 821   if (isa<ConstantInt>(SI.getCondition()))
 822     return true;
 823   if (Value *V = SimplifiedValues.lookup(SI.getCondition()))
 824     if (isa<ConstantInt>(V))
 825       return true;
 826
 827   // Otherwise, we need to accumulate a cost proportional to the number of
 828   // distinct successor blocks. This fan-out in the CFG cannot be represented
 829   // for free even if we can represent the core switch as a jumptable that
 830   // takes a single instruction.
 831   //
 832   // NB: We convert large switches which are just used to initialize large phi
 833   // nodes to lookup tables instead in simplify-cfg, so this shouldn't prevent
 834   // inlining those. It will prevent inlining in cases where the optimization
 835   // does not (yet) fire.
 836   SmallPtrSet<BasicBlock *, 8> SuccessorBlocks;
 837   SuccessorBlocks.insert(SI.getDefaultDest());
 838   for (auto I = SI.case_begin(), E = SI.case_end(); I != E; ++I)
 839     SuccessorBlocks.insert(I.getCaseSuccessor());
 840   // Add cost corresponding to the number of distinct destinations. The first
 841   // we model as free because of fallthrough.
 842   Cost += (SuccessorBlocks.size() - 1) * InlineConstants::InstrCost;
 843   return false;
 844 }
 845
 846 bool CallAnalyzer::visitIndirectBrInst(IndirectBrInst &IBI) {
 847   // We never want to inline functions that contain an indirectbr.  This is
 848   // incorrect because all the blockaddress's (in static global initializers
 849   // for example) would be referring to the original function, and this
 850   // indirect jump would jump from the inlined copy of the function into the
 851   // original function which is extremely undefined behavior.
 852   // FIXME: This logic isn't really right; we can safely inline functions with
 853   // indirectbr's as long as no other function or global references the
 854   // blockaddress of a block within the current function.
 855   HasIndirectBr = true;
 856   return false;
 857 }
 858
 859 bool CallAnalyzer::visitResumeInst(ResumeInst &RI) {
 860   // FIXME: It's not clear that a single instruction is an accurate model for
 861   // the inline cost of a resume instruction.
 862   return false;
 863 }
 864
 865 bool CallAnalyzer::visitUnreachableInst(UnreachableInst &I) {
 866   // FIXME: It might be reasonably to discount the cost of instructions leading
 867   // to unreachable as they have the lowest possible impact on both runtime and
 868   // code size.
 869   return true; // No actual code is needed for unreachable.
 870 }
 871
 872 bool CallAnalyzer::visitInstruction(Instruction &I) {
 873   // Some instructions are free. All of the free intrinsics can also be
 874   // handled by SROA, etc.
 875   if (TargetTransformInfo::TCC_Free == TTI.getUserCost(&I))
 876     return true;
 877
 878   // We found something we don't understand or can't handle. Mark any SROA-able
 879   // values in the operand list as no longer viable.
 880   for (User::op_iterator OI = I.op_begin(), OE = I.op_end(); OI != OE; ++OI)
 881     disableSROA(*OI);
 882
 883   return false;
 884 }
 885
 886
 887 /// \brief Analyze a basic block for its contribution to the inline cost.
 888 ///
 889 /// This method walks the analyzer over every instruction in the given basic
 890 /// block and accounts for their cost during inlining at this callsite. It
 891 /// aborts early if the threshold has been exceeded or an impossible to inline
 892 /// construct has been detected. It returns false if inlining is no longer
 893 /// viable, and true if inlining remains viable.
 894 bool CallAnalyzer::analyzeBlock(BasicBlock *BB,
 895                                 SmallPtrSetImpl<const Value *> &EphValues) {
 896   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 897     // FIXME: Currently, the number of instructions in a function regardless of
 898     // our ability to simplify them during inline to constants or dead code,
 899     // are actually used by the vector bonus heuristic. As long as that's true,
 900     // we have to special case debug intrinsics here to prevent differences in
 901     // inlining due to debug symbols. Eventually, the number of unsimplified
 902     // instructions shouldn't factor into the cost computation, but until then,
 903     // hack around it here.
 904     if (isa<DbgInfoIntrinsic>(I))
 905       continue;
 906
 907     // Skip ephemeral values.
 908     if (EphValues.count(I))
 909       continue;
 910
 911     ++NumInstructions;
 912     if (isa<ExtractElementInst>(I) || I->getType()->isVectorTy())
 913       ++NumVectorInstructions;
 914
 915     // If the instruction is floating point, and the target says this operation is
 916     // expensive or the function has the "use-soft-float" attribute, this may
 917     // eventually become a library call.  Treat the cost as such.
 918     if (I->getType()->isFloatingPointTy()) {
 919       bool hasSoftFloatAttr = false;
 920
 921       // If the function has the "use-soft-float" attribute, mark it as expensive.
 922       if (F.hasFnAttribute("use-soft-float")) {
 923         Attribute Attr = F.getFnAttribute("use-soft-float");
 924         StringRef Val = Attr.getValueAsString();
 925         if (Val == "true")
 926           hasSoftFloatAttr = true;
 927       }
 928
 929       if (TTI.getFPOpCost(I->getType()) == TargetTransformInfo::TCC_Expensive ||
 930           hasSoftFloatAttr)
 931         Cost += InlineConstants::CallPenalty;
 932     }
 933
 934     // If the instruction simplified to a constant, there is no cost to this
 935     // instruction. Visit the instructions using our InstVisitor to account for
 936     // all of the per-instruction logic. The visit tree returns true if we
 937     // consumed the instruction in any way, and false if the instruction's base
 938     // cost should count against inlining.
 939     if (Base::visit(I))
 940       ++NumInstructionsSimplified;
 941     else
 942       Cost += InlineConstants::InstrCost;
 943
 944     // If the visit this instruction detected an uninlinable pattern, abort.
 945     if (IsRecursiveCall || ExposesReturnsTwice || HasDynamicAlloca ||
 946         HasIndirectBr)
 947       return false;
 948
 949     // If the caller is a recursive function then we don't want to inline
 950     // functions which allocate a lot of stack space because it would increase
 951     // the caller stack usage dramatically.
 952     if (IsCallerRecursive &&
 953         AllocatedSize > InlineConstants::TotalAllocaSizeRecursiveCaller)
 954       return false;
 955
 956     if (NumVectorInstructions > NumInstructions/2)
 957       VectorBonus = FiftyPercentVectorBonus;
 958     else if (NumVectorInstructions > NumInstructions/10)
 959       VectorBonus = TenPercentVectorBonus;
 960     else
 961       VectorBonus = 0;
 962
 963     // Check if we've past the threshold so we don't spin in huge basic
 964     // blocks that will never inline.
 965     if (Cost > (Threshold + VectorBonus))
 966       return false;
 967   }
 968
 969   return true;
 970 }
 971
 972 /// \brief Compute the base pointer and cumulative constant offsets for V.
 973 ///
 974 /// This strips all constant offsets off of V, leaving it the base pointer, and
 975 /// accumulates the total constant offset applied in the returned constant. It
 976 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
 977 /// no constant offsets applied.
 978 ConstantInt *CallAnalyzer::stripAndComputeInBoundsConstantOffsets(Value *&V) {
 979   if (!DL || !V->getType()->isPointerTy())
 980     return nullptr;
 981
 982   unsigned IntPtrWidth = DL->getPointerSizeInBits();
 983   APInt Offset = APInt::getNullValue(IntPtrWidth);
 984
 985   // Even though we don't look through PHI nodes, we could be called on an
 986   // instruction in an unreachable block, which may be on a cycle.
 987   SmallPtrSet<Value *, 4> Visited;
 988   Visited.insert(V);
 989   do {
 990     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 991       if (!GEP->isInBounds() || !accumulateGEPOffset(*GEP, Offset))
 992         return nullptr;
 993       V = GEP->getPointerOperand();
 994     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 995       V = cast<Operator>(V)->getOperand(0);
 996     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 997       if (GA->mayBeOverridden())
 998         break;
 999       V = GA->getAliasee();
1000     } else {
1001       break;
1002     }
1003     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
1004   } while (Visited.insert(V).second);
1005
1006   Type *IntPtrTy = DL->getIntPtrType(V->getContext());
1007   return cast<ConstantInt>(ConstantInt::get(IntPtrTy, Offset));
1008 }
1009
1010 /// \brief Analyze a call site for potential inlining.
1011 ///
1012 /// Returns true if inlining this call is viable, and false if it is not
1013 /// viable. It computes the cost and adjusts the threshold based on numerous
1014 /// factors and heuristics. If this method returns false but the computed cost
1015 /// is below the computed threshold, then inlining was forcibly disabled by
1016 /// some artifact of the routine.
1017 bool CallAnalyzer::analyzeCall(CallSite CS) {
1018   ++NumCallsAnalyzed;
1019
1020   // Track whether the post-inlining function would have more than one basic
1021   // block. A single basic block is often intended for inlining. Balloon the
1022   // threshold by 50% until we pass the single-BB phase.
1023   bool SingleBB = true;
1024   int SingleBBBonus = Threshold / 2;
1025   Threshold += SingleBBBonus;
1026
1027   // Perform some tweaks to the cost and threshold based on the direct
1028   // callsite information.
1029
1030   // We want to more aggressively inline vector-dense kernels, so up the
1031   // threshold, and we'll lower it if the % of vector instructions gets too
1032   // low.
1033   assert(NumInstructions == 0);
1034   assert(NumVectorInstructions == 0);
1035   FiftyPercentVectorBonus = Threshold;
1036   TenPercentVectorBonus = Threshold / 2;
1037
1038   // Give out bonuses per argument, as the instructions setting them up will
1039   // be gone after inlining.
1040   for (unsigned I = 0, E = CS.arg_size(); I != E; ++I) {
1041     if (DL && CS.isByValArgument(I)) {
1042       // We approximate the number of loads and stores needed by dividing the
1043       // size of the byval type by the target's pointer size.
1044       PointerType *PTy = cast<PointerType>(CS.getArgument(I)->getType());
1045       unsigned TypeSize = DL->getTypeSizeInBits(PTy->getElementType());
1046       unsigned PointerSize = DL->getPointerSizeInBits();
1047       // Ceiling division.
1048       unsigned NumStores = (TypeSize + PointerSize - 1) / PointerSize;
1049
1050       // If it generates more than 8 stores it is likely to be expanded as an
1051       // inline memcpy so we take that as an upper bound. Otherwise we assume
1052       // one load and one store per word copied.
1053       // FIXME: The maxStoresPerMemcpy setting from the target should be used
1054       // here instead of a magic number of 8, but it's not available via
1055       // DataLayout.
1056       NumStores = std::min(NumStores, 8U);
1057
1058       Cost -= 2 * NumStores * InlineConstants::InstrCost;
1059     } else {
1060       // For non-byval arguments subtract off one instruction per call
1061       // argument.
1062       Cost -= InlineConstants::InstrCost;
1063     }
1064   }
1065
1066   // If there is only one call of the function, and it has internal linkage,
1067   // the cost of inlining it drops dramatically.
1068   bool OnlyOneCallAndLocalLinkage = F.hasLocalLinkage() && F.hasOneUse() &&
1069     &F == CS.getCalledFunction();
1070   if (OnlyOneCallAndLocalLinkage)
1071     Cost += InlineConstants::LastCallToStaticBonus;
1072
1073   // If the instruction after the call, or if the normal destination of the
1074   // invoke is an unreachable instruction, the function is noreturn. As such,
1075   // there is little point in inlining this unless there is literally zero
1076   // cost.
1077   Instruction *Instr = CS.getInstruction();
1078   if (InvokeInst *II = dyn_cast<InvokeInst>(Instr)) {
1079     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
1080       Threshold = 1;
1081   } else if (isa<UnreachableInst>(++BasicBlock::iterator(Instr)))
1082     Threshold = 1;
1083
1084   // If this function uses the coldcc calling convention, prefer not to inline
1085   // it.
1086   if (F.getCallingConv() == CallingConv::Cold)
1087     Cost += InlineConstants::ColdccPenalty;
1088
1089   // Check if we're done. This can happen due to bonuses and penalties.
1090   if (Cost > Threshold)
1091     return false;
1092
1093   if (F.empty())
1094     return true;
1095
1096   Function *Caller = CS.getInstruction()->getParent()->getParent();
1097   // Check if the caller function is recursive itself.
1098   for (User *U : Caller->users()) {
1099     CallSite Site(U);
1100     if (!Site)
1101       continue;
1102     Instruction *I = Site.getInstruction();
1103     if (I->getParent()->getParent() == Caller) {
1104       IsCallerRecursive = true;
1105       break;
1106     }
1107   }
1108
1109   // Populate our simplified values by mapping from function arguments to call
1110   // arguments with known important simplifications.
1111   CallSite::arg_iterator CAI = CS.arg_begin();
1112   for (Function::arg_iterator FAI = F.arg_begin(), FAE = F.arg_end();
1113        FAI != FAE; ++FAI, ++CAI) {
1114     assert(CAI != CS.arg_end());
1115     if (Constant *C = dyn_cast<Constant>(CAI))
1116       SimplifiedValues[FAI] = C;
1117
1118     Value *PtrArg = *CAI;
1119     if (ConstantInt *C = stripAndComputeInBoundsConstantOffsets(PtrArg)) {
1120       ConstantOffsetPtrs[FAI] = std::make_pair(PtrArg, C->getValue());
1121
1122       // We can SROA any pointer arguments derived from alloca instructions.
1123       if (isa<AllocaInst>(PtrArg)) {
1124         SROAArgValues[FAI] = PtrArg;
1125         SROAArgCosts[PtrArg] = 0;
1126       }
1127     }
1128   }
1129   NumConstantArgs = SimplifiedValues.size();
1130   NumConstantOffsetPtrArgs = ConstantOffsetPtrs.size();
1131   NumAllocaArgs = SROAArgValues.size();
1132
1133   // FIXME: If a caller has multiple calls to a callee, we end up recomputing
1134   // the ephemeral values multiple times (and they're completely determined by
1135   // the callee, so this is purely duplicate work).
1136   SmallPtrSet<const Value *, 32> EphValues;
1137   CodeMetrics::collectEphemeralValues(&F, &ACT->getAssumptionCache(F), EphValues);
1138
1139   // The worklist of live basic blocks in the callee *after* inlining. We avoid
1140   // adding basic blocks of the callee which can be proven to be dead for this
1141   // particular call site in order to get more accurate cost estimates. This
1142   // requires a somewhat heavyweight iteration pattern: we need to walk the
1143   // basic blocks in a breadth-first order as we insert live successors. To
1144   // accomplish this, prioritizing for small iterations because we exit after
1145   // crossing our threshold, we use a small-size optimized SetVector.
1146   typedef SetVector<BasicBlock *, SmallVector<BasicBlock *, 16>,
1147                                   SmallPtrSet<BasicBlock *, 16> > BBSetVector;
1148   BBSetVector BBWorklist;
1149   BBWorklist.insert(&F.getEntryBlock());
1150   // Note that we *must not* cache the size, this loop grows the worklist.
1151   for (unsigned Idx = 0; Idx != BBWorklist.size(); ++Idx) {
1152     // Bail out the moment we cross the threshold. This means we'll under-count
1153     // the cost, but only when undercounting doesn't matter.
1154     if (Cost > (Threshold + VectorBonus))
1155       break;
1156
1157     BasicBlock *BB = BBWorklist[Idx];
1158     if (BB->empty())
1159       continue;
1160
1161     // Disallow inlining a blockaddress. A blockaddress only has defined
1162     // behavior for an indirect branch in the same function, and we do not
1163     // currently support inlining indirect branches. But, the inliner may not
1164     // see an indirect branch that ends up being dead code at a particular call
1165     // site. If the blockaddress escapes the function, e.g., via a global
1166     // variable, inlining may lead to an invalid cross-function reference.
1167     if (BB->hasAddressTaken())
1168       return false;
1169
1170     // Analyze the cost of this block. If we blow through the threshold, this
1171     // returns false, and we can bail on out.
1172     if (!analyzeBlock(BB, EphValues)) {
1173       if (IsRecursiveCall || ExposesReturnsTwice || HasDynamicAlloca ||
1174           HasIndirectBr)
1175         return false;
1176
1177       // If the caller is a recursive function then we don't want to inline
1178       // functions which allocate a lot of stack space because it would increase
1179       // the caller stack usage dramatically.
1180       if (IsCallerRecursive &&
1181           AllocatedSize > InlineConstants::TotalAllocaSizeRecursiveCaller)
1182         return false;
1183
1184       break;
1185     }
1186
1187     TerminatorInst *TI = BB->getTerminator();
1188
1189     // Add in the live successors by first checking whether we have terminator
1190     // that may be simplified based on the values simplified by this call.
1191     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1192       if (BI->isConditional()) {
1193         Value *Cond = BI->getCondition();
1194         if (ConstantInt *SimpleCond
1195               = dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) {
1196           BBWorklist.insert(BI->getSuccessor(SimpleCond->isZero() ? 1 : 0));
1197           continue;
1198         }
1199       }
1200     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1201       Value *Cond = SI->getCondition();
1202       if (ConstantInt *SimpleCond
1203             = dyn_cast_or_null<ConstantInt>(SimplifiedValues.lookup(Cond))) {
1204         BBWorklist.insert(SI->findCaseValue(SimpleCond).getCaseSuccessor());
1205         continue;
1206       }
1207     }
1208
1209     // If we're unable to select a particular successor, just count all of
1210     // them.
1211     for (unsigned TIdx = 0, TSize = TI->getNumSuccessors(); TIdx != TSize;
1212          ++TIdx)
1213       BBWorklist.insert(TI->getSuccessor(TIdx));
1214
1215     // If we had any successors at this point, than post-inlining is likely to
1216     // have them as well. Note that we assume any basic blocks which existed
1217     // due to branches or switches which folded above will also fold after
1218     // inlining.
1219     if (SingleBB && TI->getNumSuccessors() > 1) {
1220       // Take off the bonus we applied to the threshold.
1221       Threshold -= SingleBBBonus;
1222       SingleBB = false;
1223     }
1224   }
1225
1226   // If this is a noduplicate call, we can still inline as long as
1227   // inlining this would cause the removal of the caller (so the instruction
1228   // is not actually duplicated, just moved).
1229   if (!OnlyOneCallAndLocalLinkage && ContainsNoDuplicateCall)
1230     return false;
1231
1232   Threshold += VectorBonus;
1233
1234   return Cost < Threshold;
1235 }
1236
1237 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1238 /// \brief Dump stats about this call's analysis.
1239 void CallAnalyzer::dump() {
1240 #define DEBUG_PRINT_STAT(x) dbgs() << "      " #x ": " << x << "\n"
1241   DEBUG_PRINT_STAT(NumConstantArgs);
1242   DEBUG_PRINT_STAT(NumConstantOffsetPtrArgs);
1243   DEBUG_PRINT_STAT(NumAllocaArgs);
1244   DEBUG_PRINT_STAT(NumConstantPtrCmps);
1245   DEBUG_PRINT_STAT(NumConstantPtrDiffs);
1246   DEBUG_PRINT_STAT(NumInstructionsSimplified);
1247   DEBUG_PRINT_STAT(SROACostSavings);
1248   DEBUG_PRINT_STAT(SROACostSavingsLost);
1249   DEBUG_PRINT_STAT(ContainsNoDuplicateCall);
1250   DEBUG_PRINT_STAT(Cost);
1251   DEBUG_PRINT_STAT(Threshold);
1252   DEBUG_PRINT_STAT(VectorBonus);
1253 #undef DEBUG_PRINT_STAT
1254 }
1255 #endif
1256
1257 INITIALIZE_PASS_BEGIN(InlineCostAnalysis, "inline-cost", "Inline Cost Analysis",
1258                       true, true)
1259 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
1260 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
1261 INITIALIZE_PASS_END(InlineCostAnalysis, "inline-cost", "Inline Cost Analysis",
1262                     true, true)
1263
1264 char InlineCostAnalysis::ID = 0;
1265
1266 InlineCostAnalysis::InlineCostAnalysis() : CallGraphSCCPass(ID) {}
1267
1268 InlineCostAnalysis::~InlineCostAnalysis() {}
1269
1270 void InlineCostAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
1271   AU.setPreservesAll();
1272   AU.addRequired<AssumptionCacheTracker>();
1273   AU.addRequired<TargetTransformInfoWrapperPass>();
1274   CallGraphSCCPass::getAnalysisUsage(AU);
1275 }
1276
1277 bool InlineCostAnalysis::runOnSCC(CallGraphSCC &SCC) {
1278   TTIWP = &getAnalysis<TargetTransformInfoWrapperPass>();
1279   ACT = &getAnalysis<AssumptionCacheTracker>();
1280   return false;
1281 }
1282
1283 InlineCost InlineCostAnalysis::getInlineCost(CallSite CS, int Threshold) {
1284   return getInlineCost(CS, CS.getCalledFunction(), Threshold);
1285 }
1286
1287 /// \brief Test that two functions either have or have not the given attribute
1288 ///        at the same time.
1289 static bool attributeMatches(Function *F1, Function *F2,
1290                              Attribute::AttrKind Attr) {
1291   return F1->hasFnAttribute(Attr) == F2->hasFnAttribute(Attr);
1292 }
1293
1294 /// \brief Test that there are no attribute conflicts between Caller and Callee
1295 ///        that prevent inlining.
1296 static bool functionsHaveCompatibleAttributes(Function *Caller,
1297                                               Function *Callee) {
1298   return attributeMatches(Caller, Callee, Attribute::SanitizeAddress) &&
1299          attributeMatches(Caller, Callee, Attribute::SanitizeMemory) &&
1300          attributeMatches(Caller, Callee, Attribute::SanitizeThread);
1301 }
1302
1303 InlineCost InlineCostAnalysis::getInlineCost(CallSite CS, Function *Callee,
1304                                              int Threshold) {
1305   // Cannot inline indirect calls.
1306   if (!Callee)
1307     return llvm::InlineCost::getNever();
1308
1309   // Calls to functions with always-inline attributes should be inlined
1310   // whenever possible.
1311   if (CS.hasFnAttr(Attribute::AlwaysInline)) {
1312     if (isInlineViable(*Callee))
1313       return llvm::InlineCost::getAlways();
1314     return llvm::InlineCost::getNever();
1315   }
1316
1317   // Never inline functions with conflicting attributes (unless callee has
1318   // always-inline attribute).
1319   if (!functionsHaveCompatibleAttributes(CS.getCaller(), Callee))
1320     return llvm::InlineCost::getNever();
1321
1322   // Don't inline this call if the caller has the optnone attribute.
1323   if (CS.getCaller()->hasFnAttribute(Attribute::OptimizeNone))
1324     return llvm::InlineCost::getNever();
1325
1326   // Don't inline functions which can be redefined at link-time to mean
1327   // something else.  Don't inline functions marked noinline or call sites
1328   // marked noinline.
1329   if (Callee->mayBeOverridden() ||
1330       Callee->hasFnAttribute(Attribute::NoInline) || CS.isNoInline())
1331     return llvm::InlineCost::getNever();
1332
1333   DEBUG(llvm::dbgs() << "      Analyzing call of " << Callee->getName()
1334         << "...\n");
1335
1336   CallAnalyzer CA(&Callee->getParent()->getDataLayout(), TTIWP->getTTI(*Callee),
1337                   ACT, *Callee, Threshold);
1338   bool ShouldInline = CA.analyzeCall(CS);
1339
1340   DEBUG(CA.dump());
1341
1342   // Check if there was a reason to force inlining or no inlining.
1343   if (!ShouldInline && CA.getCost() < CA.getThreshold())
1344     return InlineCost::getNever();
1345   if (ShouldInline && CA.getCost() >= CA.getThreshold())
1346     return InlineCost::getAlways();
1347
1348   return llvm::InlineCost::get(CA.getCost(), CA.getThreshold());
1349 }
1350
1351 bool InlineCostAnalysis::isInlineViable(Function &F) {
1352   bool ReturnsTwice = F.hasFnAttribute(Attribute::ReturnsTwice);
1353   for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) {
1354     // Disallow inlining of functions which contain indirect branches or
1355     // blockaddresses.
1356     if (isa<IndirectBrInst>(BI->getTerminator()) || BI->hasAddressTaken())
1357       return false;
1358
1359     for (BasicBlock::iterator II = BI->begin(), IE = BI->end(); II != IE;
1360          ++II) {
1361       CallSite CS(II);
1362       if (!CS)
1363         continue;
1364
1365       // Disallow recursive calls.
1366       if (&F == CS.getCalledFunction())
1367         return false;
1368
1369       // Disallow calls which expose returns-twice to a function not previously
1370       // attributed as such.
1371       if (!ReturnsTwice && CS.isCall() &&
1372           cast<CallInst>(CS.getInstruction())->canReturnTwice())
1373         return false;
1374     }
1375   }
1376
1377   return true;
1378 }