include/llvm/Analysis/TargetTransformInfoImpl.h

   1 //===- TargetTransformInfoImpl.h --------------------------------*- C++ -*-===//
   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 /// \file
  10 /// This file provides helpers for the implementation of
  11 /// a TargetTransformInfo-conforming class.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_TARGETTRANSFORMINFOIMPL_H
  16 #define LLVM_ANALYSIS_TARGETTRANSFORMINFOIMPL_H
  17
  18 #include "llvm/Analysis/TargetTransformInfo.h"
  19 #include "llvm/IR/CallSite.h"
  20 #include "llvm/IR/DataLayout.h"
  21 #include "llvm/IR/Function.h"
  22 #include "llvm/IR/GetElementPtrTypeIterator.h"
  23 #include "llvm/IR/Operator.h"
  24 #include "llvm/IR/Type.h"
  25
  26 namespace llvm {
  27
  28 /// \brief Base class for use as a mix-in that aids implementing
  29 /// a TargetTransformInfo-compatible class.
  30 class TargetTransformInfoImplBase {
  31 protected:
  32   typedef TargetTransformInfo TTI;
  33
  34   const DataLayout &DL;
  35
  36   explicit TargetTransformInfoImplBase(const DataLayout &DL) : DL(DL) {}
  37
  38 public:
  39   // Provide value semantics. MSVC requires that we spell all of these out.
  40   TargetTransformInfoImplBase(const TargetTransformInfoImplBase &Arg)
  41       : DL(Arg.DL) {}
  42   TargetTransformInfoImplBase(TargetTransformInfoImplBase &&Arg) : DL(Arg.DL) {}
  43
  44   const DataLayout &getDataLayout() const { return DL; }
  45
  46   unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy) {
  47     switch (Opcode) {
  48     default:
  49       // By default, just classify everything as 'basic'.
  50       return TTI::TCC_Basic;
  51
  52     case Instruction::GetElementPtr:
  53       llvm_unreachable("Use getGEPCost for GEP operations!");
  54
  55     case Instruction::BitCast:
  56       assert(OpTy && "Cast instructions must provide the operand type");
  57       if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
  58         // Identity and pointer-to-pointer casts are free.
  59         return TTI::TCC_Free;
  60
  61       // Otherwise, the default basic cost is used.
  62       return TTI::TCC_Basic;
  63
  64     case Instruction::FDiv:
  65     case Instruction::FRem:
  66     case Instruction::SDiv:
  67     case Instruction::SRem:
  68     case Instruction::UDiv:
  69     case Instruction::URem:
  70       return TTI::TCC_Expensive;
  71
  72     case Instruction::IntToPtr: {
  73       // An inttoptr cast is free so long as the input is a legal integer type
  74       // which doesn't contain values outside the range of a pointer.
  75       unsigned OpSize = OpTy->getScalarSizeInBits();
  76       if (DL.isLegalInteger(OpSize) &&
  77           OpSize <= DL.getPointerTypeSizeInBits(Ty))
  78         return TTI::TCC_Free;
  79
  80       // Otherwise it's not a no-op.
  81       return TTI::TCC_Basic;
  82     }
  83     case Instruction::PtrToInt: {
  84       // A ptrtoint cast is free so long as the result is large enough to store
  85       // the pointer, and a legal integer type.
  86       unsigned DestSize = Ty->getScalarSizeInBits();
  87       if (DL.isLegalInteger(DestSize) &&
  88           DestSize >= DL.getPointerTypeSizeInBits(OpTy))
  89         return TTI::TCC_Free;
  90
  91       // Otherwise it's not a no-op.
  92       return TTI::TCC_Basic;
  93     }
  94     case Instruction::Trunc:
  95       // trunc to a native type is free (assuming the target has compare and
  96       // shift-right of the same width).
  97       if (DL.isLegalInteger(DL.getTypeSizeInBits(Ty)))
  98         return TTI::TCC_Free;
  99
 100       return TTI::TCC_Basic;
 101     }
 102   }
 103
 104   unsigned getGEPCost(Type *PointeeType, const Value *Ptr,
 105                       ArrayRef<const Value *> Operands) {
 106     // In the basic model, we just assume that all-constant GEPs will be folded
 107     // into their uses via addressing modes.
 108     for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
 109       if (!isa<Constant>(Operands[Idx]))
 110         return TTI::TCC_Basic;
 111
 112     return TTI::TCC_Free;
 113   }
 114
 115   unsigned getCallCost(FunctionType *FTy, int NumArgs) {
 116     assert(FTy && "FunctionType must be provided to this routine.");
 117
 118     // The target-independent implementation just measures the size of the
 119     // function by approximating that each argument will take on average one
 120     // instruction to prepare.
 121
 122     if (NumArgs < 0)
 123       // Set the argument number to the number of explicit arguments in the
 124       // function.
 125       NumArgs = FTy->getNumParams();
 126
 127     return TTI::TCC_Basic * (NumArgs + 1);
 128   }
 129
 130   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
 131                             ArrayRef<Type *> ParamTys) {
 132     switch (IID) {
 133     default:
 134       // Intrinsics rarely (if ever) have normal argument setup constraints.
 135       // Model them as having a basic instruction cost.
 136       // FIXME: This is wrong for libc intrinsics.
 137       return TTI::TCC_Basic;
 138
 139     case Intrinsic::annotation:
 140     case Intrinsic::assume:
 141     case Intrinsic::dbg_declare:
 142     case Intrinsic::dbg_value:
 143     case Intrinsic::invariant_start:
 144     case Intrinsic::invariant_end:
 145     case Intrinsic::lifetime_start:
 146     case Intrinsic::lifetime_end:
 147     case Intrinsic::objectsize:
 148     case Intrinsic::ptr_annotation:
 149     case Intrinsic::var_annotation:
 150     case Intrinsic::experimental_gc_result_int:
 151     case Intrinsic::experimental_gc_result_float:
 152     case Intrinsic::experimental_gc_result_ptr:
 153     case Intrinsic::experimental_gc_result:
 154     case Intrinsic::experimental_gc_relocate:
 155       // These intrinsics don't actually represent code after lowering.
 156       return TTI::TCC_Free;
 157     }
 158   }
 159
 160   bool hasBranchDivergence() { return false; }
 161
 162   bool isSourceOfDivergence(const Value *V) { return false; }
 163
 164   bool isLoweredToCall(const Function *F) {
 165     // FIXME: These should almost certainly not be handled here, and instead
 166     // handled with the help of TLI or the target itself. This was largely
 167     // ported from existing analysis heuristics here so that such refactorings
 168     // can take place in the future.
 169
 170     if (F->isIntrinsic())
 171       return false;
 172
 173     if (F->hasLocalLinkage() || !F->hasName())
 174       return true;
 175
 176     StringRef Name = F->getName();
 177
 178     // These will all likely lower to a single selection DAG node.
 179     if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
 180         Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
 181         Name == "fmin" || Name == "fminf" || Name == "fminl" ||
 182         Name == "fmax" || Name == "fmaxf" || Name == "fmaxl" ||
 183         Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
 184         Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
 185       return false;
 186
 187     // These are all likely to be optimized into something smaller.
 188     if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
 189         Name == "exp2l" || Name == "exp2f" || Name == "floor" ||
 190         Name == "floorf" || Name == "ceil" || Name == "round" ||
 191         Name == "ffs" || Name == "ffsl" || Name == "abs" || Name == "labs" ||
 192         Name == "llabs")
 193       return false;
 194
 195     return true;
 196   }
 197
 198   void getUnrollingPreferences(Loop *, TTI::UnrollingPreferences &) {}
 199
 200   bool isLegalAddImmediate(int64_t Imm) { return false; }
 201
 202   bool isLegalICmpImmediate(int64_t Imm) { return false; }
 203
 204   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
 205                              bool HasBaseReg, int64_t Scale,
 206                              unsigned AddrSpace) {
 207     // Guess that only reg and reg+reg addressing is allowed. This heuristic is
 208     // taken from the implementation of LSR.
 209     return !BaseGV && BaseOffset == 0 && (Scale == 0 || Scale == 1);
 210   }
 211
 212   bool isLegalMaskedStore(Type *DataType) { return false; }
 213
 214   bool isLegalMaskedLoad(Type *DataType) { return false; }
 215
 216   bool isLegalMaskedScatter(Type *DataType) { return false; }
 217
 218   bool isLegalMaskedGather(Type *DataType) { return false; }
 219
 220   int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
 221                            bool HasBaseReg, int64_t Scale, unsigned AddrSpace) {
 222     // Guess that all legal addressing mode are free.
 223     if (isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
 224                               Scale, AddrSpace))
 225       return 0;
 226     return -1;
 227   }
 228
 229   bool isTruncateFree(Type *Ty1, Type *Ty2) { return false; }
 230
 231   bool isZExtFree(Type *Ty1, Type *Ty2) { return false; }
 232
 233   bool isProfitableToHoist(Instruction *I) { return true; }
 234
 235   bool isTypeLegal(Type *Ty) { return false; }
 236
 237   unsigned getJumpBufAlignment() { return 0; }
 238
 239   unsigned getJumpBufSize() { return 0; }
 240
 241   bool shouldBuildLookupTables() { return true; }
 242
 243   bool enableAggressiveInterleaving(bool LoopHasReductions) { return false; }
 244
 245   bool enableInterleavedAccessVectorization() { return false; }
 246
 247   TTI::PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) {
 248     return TTI::PSK_Software;
 249   }
 250
 251   bool haveFastSqrt(Type *Ty) { return false; }
 252
 253   unsigned getFPOpCost(Type *Ty) { return TargetTransformInfo::TCC_Basic; }
 254
 255   unsigned getIntImmCost(const APInt &Imm, Type *Ty) { return TTI::TCC_Basic; }
 256
 257   unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
 258                          Type *Ty) {
 259     return TTI::TCC_Free;
 260   }
 261
 262   unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm,
 263                          Type *Ty) {
 264     return TTI::TCC_Free;
 265   }
 266
 267   unsigned getNumberOfRegisters(bool Vector) { return 8; }
 268
 269   unsigned getRegisterBitWidth(bool Vector) { return 32; }
 270
 271   unsigned getMaxInterleaveFactor(unsigned VF) { return 1; }
 272
 273   unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty,
 274                                   TTI::OperandValueKind Opd1Info,
 275                                   TTI::OperandValueKind Opd2Info,
 276                                   TTI::OperandValueProperties Opd1PropInfo,
 277                                   TTI::OperandValueProperties Opd2PropInfo) {
 278     return 1;
 279   }
 280
 281   unsigned getShuffleCost(TTI::ShuffleKind Kind, Type *Ty, int Index,
 282                           Type *SubTp) {
 283     return 1;
 284   }
 285
 286   unsigned getCastInstrCost(unsigned Opcode, Type *Dst, Type *Src) { return 1; }
 287
 288   unsigned getCFInstrCost(unsigned Opcode) { return 1; }
 289
 290   unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy) {
 291     return 1;
 292   }
 293
 294   unsigned getVectorInstrCost(unsigned Opcode, Type *Val, unsigned Index) {
 295     return 1;
 296   }
 297
 298   unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
 299                            unsigned AddressSpace) {
 300     return 1;
 301   }
 302
 303   unsigned getMaskedMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
 304                                  unsigned AddressSpace) {
 305     return 1;
 306   }
 307
 308   unsigned getInterleavedMemoryOpCost(unsigned Opcode, Type *VecTy,
 309                                       unsigned Factor,
 310                                       ArrayRef<unsigned> Indices,
 311                                       unsigned Alignment,
 312                                       unsigned AddressSpace) {
 313     return 1;
 314   }
 315
 316   unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
 317                                  ArrayRef<Type *> Tys) {
 318     return 1;
 319   }
 320
 321   unsigned getCallInstrCost(Function *F, Type *RetTy, ArrayRef<Type *> Tys) {
 322     return 1;
 323   }
 324
 325   unsigned getNumberOfParts(Type *Tp) { return 0; }
 326
 327   unsigned getAddressComputationCost(Type *Tp, bool) { return 0; }
 328
 329   unsigned getReductionCost(unsigned, Type *, bool) { return 1; }
 330
 331   unsigned getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) { return 0; }
 332
 333   bool getTgtMemIntrinsic(IntrinsicInst *Inst, MemIntrinsicInfo &Info) {
 334     return false;
 335   }
 336
 337   Value *getOrCreateResultFromMemIntrinsic(IntrinsicInst *Inst,
 338                                            Type *ExpectedType) {
 339     return nullptr;
 340   }
 341
 342   bool areInlineCompatible(const Function *Caller,
 343                            const Function *Callee) const {
 344     return (Caller->getFnAttribute("target-cpu") ==
 345             Callee->getFnAttribute("target-cpu")) &&
 346            (Caller->getFnAttribute("target-features") ==
 347             Callee->getFnAttribute("target-features"));
 348   }
 349 };
 350
 351 /// \brief CRTP base class for use as a mix-in that aids implementing
 352 /// a TargetTransformInfo-compatible class.
 353 template <typename T>
 354 class TargetTransformInfoImplCRTPBase : public TargetTransformInfoImplBase {
 355 private:
 356   typedef TargetTransformInfoImplBase BaseT;
 357
 358 protected:
 359   explicit TargetTransformInfoImplCRTPBase(const DataLayout &DL) : BaseT(DL) {}
 360
 361 public:
 362   // Provide value semantics. MSVC requires that we spell all of these out.
 363   TargetTransformInfoImplCRTPBase(const TargetTransformInfoImplCRTPBase &Arg)
 364       : BaseT(static_cast<const BaseT &>(Arg)) {}
 365   TargetTransformInfoImplCRTPBase(TargetTransformInfoImplCRTPBase &&Arg)
 366       : BaseT(std::move(static_cast<BaseT &>(Arg))) {}
 367
 368   using BaseT::getCallCost;
 369
 370   unsigned getCallCost(const Function *F, int NumArgs) {
 371     assert(F && "A concrete function must be provided to this routine.");
 372
 373     if (NumArgs < 0)
 374       // Set the argument number to the number of explicit arguments in the
 375       // function.
 376       NumArgs = F->arg_size();
 377
 378     if (Intrinsic::ID IID = F->getIntrinsicID()) {
 379       FunctionType *FTy = F->getFunctionType();
 380       SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
 381       return static_cast<T *>(this)
 382           ->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
 383     }
 384
 385     if (!static_cast<T *>(this)->isLoweredToCall(F))
 386       return TTI::TCC_Basic; // Give a basic cost if it will be lowered
 387                              // directly.
 388
 389     return static_cast<T *>(this)->getCallCost(F->getFunctionType(), NumArgs);
 390   }
 391
 392   unsigned getCallCost(const Function *F, ArrayRef<const Value *> Arguments) {
 393     // Simply delegate to generic handling of the call.
 394     // FIXME: We should use instsimplify or something else to catch calls which
 395     // will constant fold with these arguments.
 396     return static_cast<T *>(this)->getCallCost(F, Arguments.size());
 397   }
 398
 399   using BaseT::getGEPCost;
 400
 401   unsigned getGEPCost(Type *PointeeType, const Value *Ptr,
 402                       ArrayRef<const Value *> Operands) {
 403     const GlobalValue *BaseGV = nullptr;
 404     if (Ptr != nullptr) {
 405       // TODO: will remove this when pointers have an opaque type.
 406       assert(Ptr->getType()->getScalarType()->getPointerElementType() ==
 407                  PointeeType &&
 408              "explicit pointee type doesn't match operand's pointee type");
 409       BaseGV = dyn_cast<GlobalValue>(Ptr->stripPointerCasts());
 410     }
 411     bool HasBaseReg = (BaseGV == nullptr);
 412     int64_t BaseOffset = 0;
 413     int64_t Scale = 0;
 414
 415     // Assumes the address space is 0 when Ptr is nullptr.
 416     unsigned AS =
 417         (Ptr == nullptr ? 0 : Ptr->getType()->getPointerAddressSpace());
 418     auto GTI = gep_type_begin(PointerType::get(PointeeType, AS), Operands);
 419     for (auto I = Operands.begin(); I != Operands.end(); ++I, ++GTI) {
 420       if (isa<SequentialType>(*GTI)) {
 421         int64_t ElementSize = DL.getTypeAllocSize(GTI.getIndexedType());
 422         if (const ConstantInt *ConstIdx = dyn_cast<ConstantInt>(*I)) {
 423           BaseOffset += ConstIdx->getSExtValue() * ElementSize;
 424         } else {
 425           // Needs scale register.
 426           if (Scale != 0) {
 427             // No addressing mode takes two scale registers.
 428             return TTI::TCC_Basic;
 429           }
 430           Scale = ElementSize;
 431         }
 432       } else {
 433         StructType *STy = cast<StructType>(*GTI);
 434         uint64_t Field = cast<ConstantInt>(*I)->getZExtValue();
 435         BaseOffset += DL.getStructLayout(STy)->getElementOffset(Field);
 436       }
 437     }
 438
 439     if (static_cast<T *>(this)->isLegalAddressingMode(
 440             PointerType::get(*GTI, AS), const_cast<GlobalValue *>(BaseGV),
 441             BaseOffset, HasBaseReg, Scale, AS)) {
 442       return TTI::TCC_Free;
 443     }
 444     return TTI::TCC_Basic;
 445   }
 446
 447   using BaseT::getIntrinsicCost;
 448
 449   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
 450                             ArrayRef<const Value *> Arguments) {
 451     // Delegate to the generic intrinsic handling code. This mostly provides an
 452     // opportunity for targets to (for example) special case the cost of
 453     // certain intrinsics based on constants used as arguments.
 454     SmallVector<Type *, 8> ParamTys;
 455     ParamTys.reserve(Arguments.size());
 456     for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
 457       ParamTys.push_back(Arguments[Idx]->getType());
 458     return static_cast<T *>(this)->getIntrinsicCost(IID, RetTy, ParamTys);
 459   }
 460
 461   unsigned getUserCost(const User *U) {
 462     if (isa<PHINode>(U))
 463       return TTI::TCC_Free; // Model all PHI nodes as free.
 464
 465     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
 466       SmallVector<Value *, 4> Indices(GEP->idx_begin(), GEP->idx_end());
 467       return static_cast<T *>(this)->getGEPCost(
 468           GEP->getSourceElementType(), GEP->getPointerOperand(), Indices);
 469     }
 470
 471     if (auto CS = ImmutableCallSite(U)) {
 472       const Function *F = CS.getCalledFunction();
 473       if (!F) {
 474         // Just use the called value type.
 475         Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
 476         return static_cast<T *>(this)
 477             ->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
 478       }
 479
 480       SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
 481       return static_cast<T *>(this)->getCallCost(F, Arguments);
 482     }
 483
 484     if (const CastInst *CI = dyn_cast<CastInst>(U)) {
 485       // Result of a cmp instruction is often extended (to be used by other
 486       // cmp instructions, logical or return instructions). These are usually
 487       // nop on most sane targets.
 488       if (isa<CmpInst>(CI->getOperand(0)))
 489         return TTI::TCC_Free;
 490     }
 491
 492     return static_cast<T *>(this)->getOperationCost(
 493         Operator::getOpcode(U), U->getType(),
 494         U->getNumOperands() == 1 ? U->getOperand(0)->getType() : nullptr);
 495   }
 496 };
 497 }
 498
 499 #endif