lib/Analysis/TargetTransformInfo.cpp

   1 //===- llvm/Analysis/TargetTransformInfo.cpp ------------------------------===//
   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 #define DEBUG_TYPE "tti"
  11 #include "llvm/Analysis/TargetTransformInfo.h"
  12 #include "llvm/IR/DataLayout.h"
  13 #include "llvm/IR/Operator.h"
  14 #include "llvm/IR/Instruction.h"
  15 #include "llvm/IR/IntrinsicInst.h"
  16 #include "llvm/IR/Instructions.h"
  17 #include "llvm/Support/CallSite.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19
  20 using namespace llvm;
  21
  22 // Setup the analysis group to manage the TargetTransformInfo passes.
  23 INITIALIZE_ANALYSIS_GROUP(TargetTransformInfo, "Target Information", NoTTI)
  24 char TargetTransformInfo::ID = 0;
  25
  26 TargetTransformInfo::~TargetTransformInfo() {
  27 }
  28
  29 void TargetTransformInfo::pushTTIStack(Pass *P) {
  30   TopTTI = this;
  31   PrevTTI = &P->getAnalysis<TargetTransformInfo>();
  32
  33   // Walk up the chain and update the top TTI pointer.
  34   for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
  35     PTTI->TopTTI = this;
  36 }
  37
  38 void TargetTransformInfo::popTTIStack() {
  39   TopTTI = 0;
  40
  41   // Walk up the chain and update the top TTI pointer.
  42   for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
  43     PTTI->TopTTI = PrevTTI;
  44
  45   PrevTTI = 0;
  46 }
  47
  48 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
  49   AU.addRequired<TargetTransformInfo>();
  50 }
  51
  52 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
  53                                                Type *OpTy) const {
  54   return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
  55 }
  56
  57 unsigned TargetTransformInfo::getGEPCost(
  58     const Value *Ptr, ArrayRef<const Value *> Operands) const {
  59   return PrevTTI->getGEPCost(Ptr, Operands);
  60 }
  61
  62 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
  63                                           int NumArgs) const {
  64   return PrevTTI->getCallCost(FTy, NumArgs);
  65 }
  66
  67 unsigned TargetTransformInfo::getCallCost(const Function *F,
  68                                           int NumArgs) const {
  69   return PrevTTI->getCallCost(F, NumArgs);
  70 }
  71
  72 unsigned TargetTransformInfo::getCallCost(
  73     const Function *F, ArrayRef<const Value *> Arguments) const {
  74   return PrevTTI->getCallCost(F, Arguments);
  75 }
  76
  77 unsigned TargetTransformInfo::getIntrinsicCost(
  78     Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
  79   return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
  80 }
  81
  82 unsigned TargetTransformInfo::getIntrinsicCost(
  83     Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
  84   return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
  85 }
  86
  87 unsigned TargetTransformInfo::getUserCost(const User *U) const {
  88   return PrevTTI->getUserCost(U);
  89 }
  90
  91 bool TargetTransformInfo::hasBranchDivergence() const {
  92   return PrevTTI->hasBranchDivergence();
  93 }
  94
  95 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
  96   return PrevTTI->isLoweredToCall(F);
  97 }
  98
  99 bool TargetTransformInfo::getUnrollingPreferences(
 100                             UnrollingPreferences &UP) const {
 101   return PrevTTI->getUnrollingPreferences(UP);
 102 }
 103
 104 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
 105   return PrevTTI->isLegalAddImmediate(Imm);
 106 }
 107
 108 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
 109   return PrevTTI->isLegalICmpImmediate(Imm);
 110 }
 111
 112 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
 113                                                 int64_t BaseOffset,
 114                                                 bool HasBaseReg,
 115                                                 int64_t Scale) const {
 116   return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
 117                                         Scale);
 118 }
 119
 120 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
 121                                               int64_t BaseOffset,
 122                                               bool HasBaseReg,
 123                                               int64_t Scale) const {
 124   return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
 125                                        Scale);
 126 }
 127
 128 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
 129   return PrevTTI->isTruncateFree(Ty1, Ty2);
 130 }
 131
 132 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
 133   return PrevTTI->isTypeLegal(Ty);
 134 }
 135
 136 unsigned TargetTransformInfo::getJumpBufAlignment() const {
 137   return PrevTTI->getJumpBufAlignment();
 138 }
 139
 140 unsigned TargetTransformInfo::getJumpBufSize() const {
 141   return PrevTTI->getJumpBufSize();
 142 }
 143
 144 bool TargetTransformInfo::shouldBuildLookupTables() const {
 145   return PrevTTI->shouldBuildLookupTables();
 146 }
 147
 148 TargetTransformInfo::PopcntSupportKind
 149 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
 150   return PrevTTI->getPopcntSupport(IntTyWidthInBit);
 151 }
 152
 153 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
 154   return PrevTTI->haveFastSqrt(Ty);
 155 }
 156
 157 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
 158   return PrevTTI->getIntImmCost(Imm, Ty);
 159 }
 160
 161 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
 162   return PrevTTI->getNumberOfRegisters(Vector);
 163 }
 164
 165 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
 166   return PrevTTI->getRegisterBitWidth(Vector);
 167 }
 168
 169 unsigned TargetTransformInfo::getMaximumUnrollFactor() const {
 170   return PrevTTI->getMaximumUnrollFactor();
 171 }
 172
 173 unsigned TargetTransformInfo::getArithmeticInstrCost(unsigned Opcode,
 174                                                 Type *Ty,
 175                                                 OperandValueKind Op1Info,
 176                                                 OperandValueKind Op2Info) const {
 177   return PrevTTI->getArithmeticInstrCost(Opcode, Ty, Op1Info, Op2Info);
 178 }
 179
 180 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
 181                                              int Index, Type *SubTp) const {
 182   return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
 183 }
 184
 185 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
 186                                                Type *Src) const {
 187   return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
 188 }
 189
 190 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
 191   return PrevTTI->getCFInstrCost(Opcode);
 192 }
 193
 194 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
 195                                                  Type *CondTy) const {
 196   return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
 197 }
 198
 199 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
 200                                                  unsigned Index) const {
 201   return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
 202 }
 203
 204 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
 205                                               unsigned Alignment,
 206                                               unsigned AddressSpace) const {
 207   return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
 208   ;
 209 }
 210
 211 unsigned
 212 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
 213                                            Type *RetTy,
 214                                            ArrayRef<Type *> Tys) const {
 215   return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
 216 }
 217
 218 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
 219   return PrevTTI->getNumberOfParts(Tp);
 220 }
 221
 222 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp,
 223                                                         bool IsComplex) const {
 224   return PrevTTI->getAddressComputationCost(Tp, IsComplex);
 225 }
 226
 227 namespace {
 228
 229 struct NoTTI : ImmutablePass, TargetTransformInfo {
 230   const DataLayout *DL;
 231
 232   NoTTI() : ImmutablePass(ID), DL(0) {
 233     initializeNoTTIPass(*PassRegistry::getPassRegistry());
 234   }
 235
 236   virtual void initializePass() {
 237     // Note that this subclass is special, and must *not* call initializeTTI as
 238     // it does not chain.
 239     TopTTI = this;
 240     PrevTTI = 0;
 241     DL = getAnalysisIfAvailable<DataLayout>();
 242   }
 243
 244   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 245     // Note that this subclass is special, and must *not* call
 246     // TTI::getAnalysisUsage as it breaks the recursion.
 247   }
 248
 249   /// Pass identification.
 250   static char ID;
 251
 252   /// Provide necessary pointer adjustments for the two base classes.
 253   virtual void *getAdjustedAnalysisPointer(const void *ID) {
 254     if (ID == &TargetTransformInfo::ID)
 255       return (TargetTransformInfo*)this;
 256     return this;
 257   }
 258
 259   unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy) const {
 260     switch (Opcode) {
 261     default:
 262       // By default, just classify everything as 'basic'.
 263       return TCC_Basic;
 264
 265     case Instruction::GetElementPtr:
 266       llvm_unreachable("Use getGEPCost for GEP operations!");
 267
 268     case Instruction::BitCast:
 269       assert(OpTy && "Cast instructions must provide the operand type");
 270       if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
 271         // Identity and pointer-to-pointer casts are free.
 272         return TCC_Free;
 273
 274       // Otherwise, the default basic cost is used.
 275       return TCC_Basic;
 276
 277     case Instruction::IntToPtr: {
 278       if (!DL)
 279         return TCC_Basic;
 280
 281       // An inttoptr cast is free so long as the input is a legal integer type
 282       // which doesn't contain values outside the range of a pointer.
 283       unsigned OpSize = OpTy->getScalarSizeInBits();
 284       if (DL->isLegalInteger(OpSize) &&
 285           OpSize <= DL->getPointerTypeSizeInBits(Ty))
 286         return TCC_Free;
 287
 288       // Otherwise it's not a no-op.
 289       return TCC_Basic;
 290     }
 291     case Instruction::PtrToInt: {
 292       if (!DL)
 293         return TCC_Basic;
 294
 295       // A ptrtoint cast is free so long as the result is large enough to store
 296       // the pointer, and a legal integer type.
 297       unsigned DestSize = Ty->getScalarSizeInBits();
 298       if (DL->isLegalInteger(DestSize) &&
 299           DestSize >= DL->getPointerTypeSizeInBits(OpTy))
 300         return TCC_Free;
 301
 302       // Otherwise it's not a no-op.
 303       return TCC_Basic;
 304     }
 305     case Instruction::Trunc:
 306       // trunc to a native type is free (assuming the target has compare and
 307       // shift-right of the same width).
 308       if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
 309         return TCC_Free;
 310
 311       return TCC_Basic;
 312     }
 313   }
 314
 315   unsigned getGEPCost(const Value *Ptr,
 316                       ArrayRef<const Value *> Operands) const {
 317     // In the basic model, we just assume that all-constant GEPs will be folded
 318     // into their uses via addressing modes.
 319     for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
 320       if (!isa<Constant>(Operands[Idx]))
 321         return TCC_Basic;
 322
 323     return TCC_Free;
 324   }
 325
 326   unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const {
 327     assert(FTy && "FunctionType must be provided to this routine.");
 328
 329     // The target-independent implementation just measures the size of the
 330     // function by approximating that each argument will take on average one
 331     // instruction to prepare.
 332
 333     if (NumArgs < 0)
 334       // Set the argument number to the number of explicit arguments in the
 335       // function.
 336       NumArgs = FTy->getNumParams();
 337
 338     return TCC_Basic * (NumArgs + 1);
 339   }
 340
 341   unsigned getCallCost(const Function *F, int NumArgs = -1) const {
 342     assert(F && "A concrete function must be provided to this routine.");
 343
 344     if (NumArgs < 0)
 345       // Set the argument number to the number of explicit arguments in the
 346       // function.
 347       NumArgs = F->arg_size();
 348
 349     if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
 350       FunctionType *FTy = F->getFunctionType();
 351       SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
 352       return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
 353     }
 354
 355     if (!TopTTI->isLoweredToCall(F))
 356       return TCC_Basic; // Give a basic cost if it will be lowered directly.
 357
 358     return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
 359   }
 360
 361   unsigned getCallCost(const Function *F,
 362                        ArrayRef<const Value *> Arguments) const {
 363     // Simply delegate to generic handling of the call.
 364     // FIXME: We should use instsimplify or something else to catch calls which
 365     // will constant fold with these arguments.
 366     return TopTTI->getCallCost(F, Arguments.size());
 367   }
 368
 369   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
 370                             ArrayRef<Type *> ParamTys) const {
 371     switch (IID) {
 372     default:
 373       // Intrinsics rarely (if ever) have normal argument setup constraints.
 374       // Model them as having a basic instruction cost.
 375       // FIXME: This is wrong for libc intrinsics.
 376       return TCC_Basic;
 377
 378     case Intrinsic::dbg_declare:
 379     case Intrinsic::dbg_value:
 380     case Intrinsic::invariant_start:
 381     case Intrinsic::invariant_end:
 382     case Intrinsic::lifetime_start:
 383     case Intrinsic::lifetime_end:
 384     case Intrinsic::objectsize:
 385     case Intrinsic::ptr_annotation:
 386     case Intrinsic::var_annotation:
 387       // These intrinsics don't actually represent code after lowering.
 388       return TCC_Free;
 389     }
 390   }
 391
 392   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
 393                             ArrayRef<const Value *> Arguments) const {
 394     // Delegate to the generic intrinsic handling code. This mostly provides an
 395     // opportunity for targets to (for example) special case the cost of
 396     // certain intrinsics based on constants used as arguments.
 397     SmallVector<Type *, 8> ParamTys;
 398     ParamTys.reserve(Arguments.size());
 399     for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
 400       ParamTys.push_back(Arguments[Idx]->getType());
 401     return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
 402   }
 403
 404   unsigned getUserCost(const User *U) const {
 405     if (isa<PHINode>(U))
 406       return TCC_Free; // Model all PHI nodes as free.
 407
 408     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U))
 409       // In the basic model we just assume that all-constant GEPs will be
 410       // folded into their uses via addressing modes.
 411       return GEP->hasAllConstantIndices() ? TCC_Free : TCC_Basic;
 412
 413     if (ImmutableCallSite CS = U) {
 414       const Function *F = CS.getCalledFunction();
 415       if (!F) {
 416         // Just use the called value type.
 417         Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
 418         return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
 419       }
 420
 421       SmallVector<const Value *, 8> Arguments;
 422       for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(),
 423                                            AE = CS.arg_end();
 424            AI != AE; ++AI)
 425         Arguments.push_back(*AI);
 426
 427       return TopTTI->getCallCost(F, Arguments);
 428     }
 429
 430     if (const CastInst *CI = dyn_cast<CastInst>(U)) {
 431       // Result of a cmp instruction is often extended (to be used by other
 432       // cmp instructions, logical or return instructions). These are usually
 433       // nop on most sane targets.
 434       if (isa<CmpInst>(CI->getOperand(0)))
 435         return TCC_Free;
 436     }
 437
 438     // Otherwise delegate to the fully generic implementations.
 439     return getOperationCost(Operator::getOpcode(U), U->getType(),
 440                             U->getNumOperands() == 1 ?
 441                                 U->getOperand(0)->getType() : 0);
 442   }
 443
 444   bool hasBranchDivergence() const { return false; }
 445
 446   bool isLoweredToCall(const Function *F) const {
 447     // FIXME: These should almost certainly not be handled here, and instead
 448     // handled with the help of TLI or the target itself. This was largely
 449     // ported from existing analysis heuristics here so that such refactorings
 450     // can take place in the future.
 451
 452     if (F->isIntrinsic())
 453       return false;
 454
 455     if (F->hasLocalLinkage() || !F->hasName())
 456       return true;
 457
 458     StringRef Name = F->getName();
 459
 460     // These will all likely lower to a single selection DAG node.
 461     if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
 462         Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
 463         Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
 464         Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
 465       return false;
 466
 467     // These are all likely to be optimized into something smaller.
 468     if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
 469         Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
 470         "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
 471         Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
 472       return false;
 473
 474     return true;
 475   }
 476
 477   virtual bool getUnrollingPreferences(UnrollingPreferences &) const {
 478     return false;
 479   }
 480
 481   bool isLegalAddImmediate(int64_t Imm) const {
 482     return false;
 483   }
 484
 485   bool isLegalICmpImmediate(int64_t Imm) const {
 486     return false;
 487   }
 488
 489   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
 490                              bool HasBaseReg, int64_t Scale) const {
 491     // Guess that reg+reg addressing is allowed. This heuristic is taken from
 492     // the implementation of LSR.
 493     return !BaseGV && BaseOffset == 0 && Scale <= 1;
 494   }
 495
 496   int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
 497                            bool HasBaseReg, int64_t Scale) const {
 498     // Guess that all legal addressing mode are free.
 499     if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
 500       return 0;
 501     return -1;
 502   }
 503
 504
 505   bool isTruncateFree(Type *Ty1, Type *Ty2) const {
 506     return false;
 507   }
 508
 509   bool isTypeLegal(Type *Ty) const {
 510     return false;
 511   }
 512
 513   unsigned getJumpBufAlignment() const {
 514     return 0;
 515   }
 516
 517   unsigned getJumpBufSize() const {
 518     return 0;
 519   }
 520
 521   bool shouldBuildLookupTables() const {
 522     return true;
 523   }
 524
 525   PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) const {
 526     return PSK_Software;
 527   }
 528
 529   bool haveFastSqrt(Type *Ty) const {
 530     return false;
 531   }
 532
 533   unsigned getIntImmCost(const APInt &Imm, Type *Ty) const {
 534     return 1;
 535   }
 536
 537   unsigned getNumberOfRegisters(bool Vector) const {
 538     return 8;
 539   }
 540
 541   unsigned  getRegisterBitWidth(bool Vector) const {
 542     return 32;
 543   }
 544
 545   unsigned getMaximumUnrollFactor() const {
 546     return 1;
 547   }
 548
 549   unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
 550                                   OperandValueKind) const {
 551     return 1;
 552   }
 553
 554   unsigned getShuffleCost(ShuffleKind Kind, Type *Tp,
 555                           int Index = 0, Type *SubTp = 0) const {
 556     return 1;
 557   }
 558
 559   unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
 560                             Type *Src) const {
 561     return 1;
 562   }
 563
 564   unsigned getCFInstrCost(unsigned Opcode) const {
 565     return 1;
 566   }
 567
 568   unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
 569                               Type *CondTy = 0) const {
 570     return 1;
 571   }
 572
 573   unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
 574                               unsigned Index = -1) const {
 575     return 1;
 576   }
 577
 578   unsigned getMemoryOpCost(unsigned Opcode, Type *Src,
 579                            unsigned Alignment,
 580                            unsigned AddressSpace) const {
 581     return 1;
 582   }
 583
 584   unsigned getIntrinsicInstrCost(Intrinsic::ID ID,
 585                                  Type *RetTy,
 586                                  ArrayRef<Type*> Tys) const {
 587     return 1;
 588   }
 589
 590   unsigned getNumberOfParts(Type *Tp) const {
 591     return 0;
 592   }
 593
 594   unsigned getAddressComputationCost(Type *Tp, bool) const {
 595     return 0;
 596   }
 597 };
 598
 599 } // end anonymous namespace
 600
 601 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
 602                    "No target information", true, true, true)
 603 char NoTTI::ID = 0;
 604
 605 ImmutablePass *llvm::createNoTargetTransformInfoPass() {
 606   return new NoTTI();
 607 }