LLVM  7.0.0svn
TargetTransformInfoImpl.h
Go to the documentation of this file.
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 
21 #include "llvm/IR/CallSite.h"
22 #include "llvm/IR/DataLayout.h"
23 #include "llvm/IR/Function.h"
25 #include "llvm/IR/Operator.h"
26 #include "llvm/IR/Type.h"
27 
28 namespace llvm {
29 
30 /// \brief Base class for use as a mix-in that aids implementing
31 /// a TargetTransformInfo-compatible class.
33 protected:
35 
36  const DataLayout &DL;
37 
38  explicit TargetTransformInfoImplBase(const DataLayout &DL) : DL(DL) {}
39 
40 public:
41  // Provide value semantics. MSVC requires that we spell all of these out.
43  : DL(Arg.DL) {}
45 
46  const DataLayout &getDataLayout() const { return DL; }
47 
48  unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy) {
49  switch (Opcode) {
50  default:
51  // By default, just classify everything as 'basic'.
52  return TTI::TCC_Basic;
53 
54  case Instruction::GetElementPtr:
55  llvm_unreachable("Use getGEPCost for GEP operations!");
56 
57  case Instruction::BitCast:
58  assert(OpTy && "Cast instructions must provide the operand type");
59  if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
60  // Identity and pointer-to-pointer casts are free.
61  return TTI::TCC_Free;
62 
63  // Otherwise, the default basic cost is used.
64  return TTI::TCC_Basic;
65 
66  case Instruction::FDiv:
67  case Instruction::FRem:
68  case Instruction::SDiv:
69  case Instruction::SRem:
70  case Instruction::UDiv:
71  case Instruction::URem:
72  return TTI::TCC_Expensive;
73 
74  case Instruction::IntToPtr: {
75  // An inttoptr cast is free so long as the input is a legal integer type
76  // which doesn't contain values outside the range of a pointer.
77  unsigned OpSize = OpTy->getScalarSizeInBits();
78  if (DL.isLegalInteger(OpSize) &&
79  OpSize <= DL.getPointerTypeSizeInBits(Ty))
80  return TTI::TCC_Free;
81 
82  // Otherwise it's not a no-op.
83  return TTI::TCC_Basic;
84  }
85  case Instruction::PtrToInt: {
86  // A ptrtoint cast is free so long as the result is large enough to store
87  // the pointer, and a legal integer type.
88  unsigned DestSize = Ty->getScalarSizeInBits();
89  if (DL.isLegalInteger(DestSize) &&
90  DestSize >= DL.getPointerTypeSizeInBits(OpTy))
91  return TTI::TCC_Free;
92 
93  // Otherwise it's not a no-op.
94  return TTI::TCC_Basic;
95  }
96  case Instruction::Trunc:
97  // trunc to a native type is free (assuming the target has compare and
98  // shift-right of the same width).
99  if (DL.isLegalInteger(DL.getTypeSizeInBits(Ty)))
100  return TTI::TCC_Free;
101 
102  return TTI::TCC_Basic;
103  }
104  }
105 
106  int getGEPCost(Type *PointeeType, const Value *Ptr,
107  ArrayRef<const Value *> Operands) {
108  // In the basic model, we just assume that all-constant GEPs will be folded
109  // into their uses via addressing modes.
110  for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
111  if (!isa<Constant>(Operands[Idx]))
112  return TTI::TCC_Basic;
113 
114  return TTI::TCC_Free;
115  }
116 
118  unsigned &JTSize) {
119  JTSize = 0;
120  return SI.getNumCases();
121  }
122 
123  int getExtCost(const Instruction *I, const Value *Src) {
124  return TTI::TCC_Basic;
125  }
126 
127  unsigned getCallCost(FunctionType *FTy, int NumArgs) {
128  assert(FTy && "FunctionType must be provided to this routine.");
129 
130  // The target-independent implementation just measures the size of the
131  // function by approximating that each argument will take on average one
132  // instruction to prepare.
133 
134  if (NumArgs < 0)
135  // Set the argument number to the number of explicit arguments in the
136  // function.
137  NumArgs = FTy->getNumParams();
138 
139  return TTI::TCC_Basic * (NumArgs + 1);
140  }
141 
142  unsigned getInliningThresholdMultiplier() { return 1; }
143 
144  unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
145  ArrayRef<Type *> ParamTys) {
146  switch (IID) {
147  default:
148  // Intrinsics rarely (if ever) have normal argument setup constraints.
149  // Model them as having a basic instruction cost.
150  // FIXME: This is wrong for libc intrinsics.
151  return TTI::TCC_Basic;
152 
153  case Intrinsic::annotation:
154  case Intrinsic::assume:
155  case Intrinsic::sideeffect:
156  case Intrinsic::dbg_declare:
157  case Intrinsic::dbg_value:
158  case Intrinsic::invariant_start:
159  case Intrinsic::invariant_end:
160  case Intrinsic::lifetime_start:
161  case Intrinsic::lifetime_end:
162  case Intrinsic::objectsize:
163  case Intrinsic::ptr_annotation:
164  case Intrinsic::var_annotation:
165  case Intrinsic::experimental_gc_result:
166  case Intrinsic::experimental_gc_relocate:
167  case Intrinsic::coro_alloc:
168  case Intrinsic::coro_begin:
169  case Intrinsic::coro_free:
170  case Intrinsic::coro_end:
171  case Intrinsic::coro_frame:
172  case Intrinsic::coro_size:
173  case Intrinsic::coro_suspend:
174  case Intrinsic::coro_param:
175  case Intrinsic::coro_subfn_addr:
176  // These intrinsics don't actually represent code after lowering.
177  return TTI::TCC_Free;
178  }
179  }
180 
181  bool hasBranchDivergence() { return false; }
182 
183  bool isSourceOfDivergence(const Value *V) { return false; }
184 
185  bool isAlwaysUniform(const Value *V) { return false; }
186 
187  unsigned getFlatAddressSpace () {
188  return -1;
189  }
190 
191  bool isLoweredToCall(const Function *F) {
192  assert(F && "A concrete function must be provided to this routine.");
193 
194  // FIXME: These should almost certainly not be handled here, and instead
195  // handled with the help of TLI or the target itself. This was largely
196  // ported from existing analysis heuristics here so that such refactorings
197  // can take place in the future.
198 
199  if (F->isIntrinsic())
200  return false;
201 
202  if (F->hasLocalLinkage() || !F->hasName())
203  return true;
204 
205  StringRef Name = F->getName();
206 
207  // These will all likely lower to a single selection DAG node.
208  if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
209  Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
210  Name == "fmin" || Name == "fminf" || Name == "fminl" ||
211  Name == "fmax" || Name == "fmaxf" || Name == "fmaxl" ||
212  Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
213  Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
214  return false;
215 
216  // These are all likely to be optimized into something smaller.
217  if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
218  Name == "exp2l" || Name == "exp2f" || Name == "floor" ||
219  Name == "floorf" || Name == "ceil" || Name == "round" ||
220  Name == "ffs" || Name == "ffsl" || Name == "abs" || Name == "labs" ||
221  Name == "llabs")
222  return false;
223 
224  return true;
225  }
226 
229 
230  bool isLegalAddImmediate(int64_t Imm) { return false; }
231 
232  bool isLegalICmpImmediate(int64_t Imm) { return false; }
233 
234  bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
235  bool HasBaseReg, int64_t Scale,
236  unsigned AddrSpace, Instruction *I = nullptr) {
237  // Guess that only reg and reg+reg addressing is allowed. This heuristic is
238  // taken from the implementation of LSR.
239  return !BaseGV && BaseOffset == 0 && (Scale == 0 || Scale == 1);
240  }
241 
243  return std::tie(C1.NumRegs, C1.AddRecCost, C1.NumIVMuls, C1.NumBaseAdds,
244  C1.ScaleCost, C1.ImmCost, C1.SetupCost) <
245  std::tie(C2.NumRegs, C2.AddRecCost, C2.NumIVMuls, C2.NumBaseAdds,
246  C2.ScaleCost, C2.ImmCost, C2.SetupCost);
247  }
248 
249  bool canMacroFuseCmp() { return false; }
250 
251  bool shouldFavorPostInc() const { return false; }
252 
253  bool isLegalMaskedStore(Type *DataType) { return false; }
254 
255  bool isLegalMaskedLoad(Type *DataType) { return false; }
256 
257  bool isLegalMaskedScatter(Type *DataType) { return false; }
258 
259  bool isLegalMaskedGather(Type *DataType) { return false; }
260 
261  bool hasDivRemOp(Type *DataType, bool IsSigned) { return false; }
262 
263  bool hasVolatileVariant(Instruction *I, unsigned AddrSpace) { return false; }
264 
265  bool prefersVectorizedAddressing() { return true; }
266 
267  int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
268  bool HasBaseReg, int64_t Scale, unsigned AddrSpace) {
269  // Guess that all legal addressing mode are free.
270  if (isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
271  Scale, AddrSpace))
272  return 0;
273  return -1;
274  }
275 
276  bool LSRWithInstrQueries() { return false; }
277 
278  bool isTruncateFree(Type *Ty1, Type *Ty2) { return false; }
279 
280  bool isProfitableToHoist(Instruction *I) { return true; }
281 
282  bool useAA() { return false; }
283 
284  bool isTypeLegal(Type *Ty) { return false; }
285 
286  unsigned getJumpBufAlignment() { return 0; }
287 
288  unsigned getJumpBufSize() { return 0; }
289 
290  bool shouldBuildLookupTables() { return true; }
292 
293  bool useColdCCForColdCall(Function &F) { return false; }
294 
295  unsigned getScalarizationOverhead(Type *Ty, bool Insert, bool Extract) {
296  return 0;
297  }
298 
300  unsigned VF) { return 0; }
301 
303 
304  bool enableAggressiveInterleaving(bool LoopHasReductions) { return false; }
305 
307  bool IsZeroCmp) const {
308  return nullptr;
309  }
310 
311  bool enableInterleavedAccessVectorization() { return false; }
312 
313  bool isFPVectorizationPotentiallyUnsafe() { return false; }
314 
316  unsigned BitWidth,
317  unsigned AddressSpace,
318  unsigned Alignment,
319  bool *Fast) { return false; }
320 
321  TTI::PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) {
322  return TTI::PSK_Software;
323  }
324 
325  bool haveFastSqrt(Type *Ty) { return false; }
326 
327  bool isFCmpOrdCheaperThanFCmpZero(Type *Ty) { return true; }
328 
330 
331  int getIntImmCodeSizeCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
332  Type *Ty) {
333  return 0;
334  }
335 
336  unsigned getIntImmCost(const APInt &Imm, Type *Ty) { return TTI::TCC_Basic; }
337 
338  unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
339  Type *Ty) {
340  return TTI::TCC_Free;
341  }
342 
343  unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm,
344  Type *Ty) {
345  return TTI::TCC_Free;
346  }
347 
348  unsigned getNumberOfRegisters(bool Vector) { return 8; }
349 
350  unsigned getRegisterBitWidth(bool Vector) const { return 32; }
351 
352  unsigned getMinVectorRegisterBitWidth() { return 128; }
353 
354  bool shouldMaximizeVectorBandwidth(bool OptSize) const { return false; }
355 
356  unsigned getMinimumVF(unsigned ElemWidth) const { return 0; }
357 
358  bool
360  bool &AllowPromotionWithoutCommonHeader) {
361  AllowPromotionWithoutCommonHeader = false;
362  return false;
363  }
364 
365  unsigned getCacheLineSize() { return 0; }
366 
368  switch (Level) {
372  return llvm::Optional<unsigned>();
373  }
374 
375  llvm_unreachable("Unknown TargetTransformInfo::CacheLevel");
376  }
377 
380  switch (Level) {
384  return llvm::Optional<unsigned>();
385  }
386 
387  llvm_unreachable("Unknown TargetTransformInfo::CacheLevel");
388  }
389 
390  unsigned getPrefetchDistance() { return 0; }
391 
392  unsigned getMinPrefetchStride() { return 1; }
393 
394  unsigned getMaxPrefetchIterationsAhead() { return UINT_MAX; }
395 
396  unsigned getMaxInterleaveFactor(unsigned VF) { return 1; }
397 
398  unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty,
399  TTI::OperandValueKind Opd1Info,
400  TTI::OperandValueKind Opd2Info,
401  TTI::OperandValueProperties Opd1PropInfo,
402  TTI::OperandValueProperties Opd2PropInfo,
404  return 1;
405  }
406 
408  Type *SubTp) {
409  return 1;
410  }
411 
412  unsigned getCastInstrCost(unsigned Opcode, Type *Dst, Type *Src,
413  const Instruction *I) { return 1; }
414 
415  unsigned getExtractWithExtendCost(unsigned Opcode, Type *Dst,
416  VectorType *VecTy, unsigned Index) {
417  return 1;
418  }
419 
420  unsigned getCFInstrCost(unsigned Opcode) { return 1; }
421 
422  unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy,
423  const Instruction *I) {
424  return 1;
425  }
426 
427  unsigned getVectorInstrCost(unsigned Opcode, Type *Val, unsigned Index) {
428  return 1;
429  }
430 
431  unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
432  unsigned AddressSpace, const Instruction *I) {
433  return 1;
434  }
435 
436  unsigned getMaskedMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
437  unsigned AddressSpace) {
438  return 1;
439  }
440 
441  unsigned getGatherScatterOpCost(unsigned Opcode, Type *DataTy, Value *Ptr,
442  bool VariableMask,
443  unsigned Alignment) {
444  return 1;
445  }
446 
447  unsigned getInterleavedMemoryOpCost(unsigned Opcode, Type *VecTy,
448  unsigned Factor,
449  ArrayRef<unsigned> Indices,
450  unsigned Alignment,
451  unsigned AddressSpace) {
452  return 1;
453  }
454 
457  unsigned ScalarizationCostPassed) {
458  return 1;
459  }
461  ArrayRef<Value *> Args, FastMathFlags FMF, unsigned VF) {
462  return 1;
463  }
464 
465  unsigned getCallInstrCost(Function *F, Type *RetTy, ArrayRef<Type *> Tys) {
466  return 1;
467  }
468 
469  unsigned getNumberOfParts(Type *Tp) { return 0; }
470 
472  const SCEV *) {
473  return 0;
474  }
475 
476  unsigned getArithmeticReductionCost(unsigned, Type *, bool) { return 1; }
477 
478  unsigned getMinMaxReductionCost(Type *, Type *, bool, bool) { return 1; }
479 
480  unsigned getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) { return 0; }
481 
483  return false;
484  }
485 
487  // Note for overrides: You must ensure for all element unordered-atomic
488  // memory intrinsics that all power-of-2 element sizes up to, and
489  // including, the return value of this method have a corresponding
490  // runtime lib call. These runtime lib call definitions can be found
491  // in RuntimeLibcalls.h
492  return 0;
493  }
494 
496  Type *ExpectedType) {
497  return nullptr;
498  }
499 
501  unsigned SrcAlign, unsigned DestAlign) const {
502  return Type::getInt8Ty(Context);
503  }
504 
507  unsigned RemainingBytes,
508  unsigned SrcAlign,
509  unsigned DestAlign) const {
510  for (unsigned i = 0; i != RemainingBytes; ++i)
511  OpsOut.push_back(Type::getInt8Ty(Context));
512  }
513 
514  bool areInlineCompatible(const Function *Caller,
515  const Function *Callee) const {
516  return (Caller->getFnAttribute("target-cpu") ==
517  Callee->getFnAttribute("target-cpu")) &&
518  (Caller->getFnAttribute("target-features") ==
519  Callee->getFnAttribute("target-features"));
520  }
521 
523  const DataLayout &DL) const {
524  return false;
525  }
526 
528  const DataLayout &DL) const {
529  return false;
530  }
531 
532  unsigned getLoadStoreVecRegBitWidth(unsigned AddrSpace) const { return 128; }
533 
534  bool isLegalToVectorizeLoad(LoadInst *LI) const { return true; }
535 
536  bool isLegalToVectorizeStore(StoreInst *SI) const { return true; }
537 
538  bool isLegalToVectorizeLoadChain(unsigned ChainSizeInBytes,
539  unsigned Alignment,
540  unsigned AddrSpace) const {
541  return true;
542  }
543 
544  bool isLegalToVectorizeStoreChain(unsigned ChainSizeInBytes,
545  unsigned Alignment,
546  unsigned AddrSpace) const {
547  return true;
548  }
549 
550  unsigned getLoadVectorFactor(unsigned VF, unsigned LoadSize,
551  unsigned ChainSizeInBytes,
552  VectorType *VecTy) const {
553  return VF;
554  }
555 
556  unsigned getStoreVectorFactor(unsigned VF, unsigned StoreSize,
557  unsigned ChainSizeInBytes,
558  VectorType *VecTy) const {
559  return VF;
560  }
561 
562  bool useReductionIntrinsic(unsigned Opcode, Type *Ty,
563  TTI::ReductionFlags Flags) const {
564  return false;
565  }
566 
567  bool shouldExpandReduction(const IntrinsicInst *II) const {
568  return true;
569  }
570 
571 protected:
572  // Obtain the minimum required size to hold the value (without the sign)
573  // In case of a vector it returns the min required size for one element.
574  unsigned minRequiredElementSize(const Value* Val, bool &isSigned) {
575  if (isa<ConstantDataVector>(Val) || isa<ConstantVector>(Val)) {
576  const auto* VectorValue = cast<Constant>(Val);
577 
578  // In case of a vector need to pick the max between the min
579  // required size for each element
580  auto *VT = cast<VectorType>(Val->getType());
581 
582  // Assume unsigned elements
583  isSigned = false;
584 
585  // The max required size is the total vector width divided by num
586  // of elements in the vector
587  unsigned MaxRequiredSize = VT->getBitWidth() / VT->getNumElements();
588 
589  unsigned MinRequiredSize = 0;
590  for(unsigned i = 0, e = VT->getNumElements(); i < e; ++i) {
591  if (auto* IntElement =
592  dyn_cast<ConstantInt>(VectorValue->getAggregateElement(i))) {
593  bool signedElement = IntElement->getValue().isNegative();
594  // Get the element min required size.
595  unsigned ElementMinRequiredSize =
596  IntElement->getValue().getMinSignedBits() - 1;
597  // In case one element is signed then all the vector is signed.
598  isSigned |= signedElement;
599  // Save the max required bit size between all the elements.
600  MinRequiredSize = std::max(MinRequiredSize, ElementMinRequiredSize);
601  }
602  else {
603  // not an int constant element
604  return MaxRequiredSize;
605  }
606  }
607  return MinRequiredSize;
608  }
609 
610  if (const auto* CI = dyn_cast<ConstantInt>(Val)) {
611  isSigned = CI->getValue().isNegative();
612  return CI->getValue().getMinSignedBits() - 1;
613  }
614 
615  if (const auto* Cast = dyn_cast<SExtInst>(Val)) {
616  isSigned = true;
617  return Cast->getSrcTy()->getScalarSizeInBits() - 1;
618  }
619 
620  if (const auto* Cast = dyn_cast<ZExtInst>(Val)) {
621  isSigned = false;
622  return Cast->getSrcTy()->getScalarSizeInBits();
623  }
624 
625  isSigned = false;
626  return Val->getType()->getScalarSizeInBits();
627  }
628 
629  bool isStridedAccess(const SCEV *Ptr) {
630  return Ptr && isa<SCEVAddRecExpr>(Ptr);
631  }
632 
634  const SCEV *Ptr) {
635  if (!isStridedAccess(Ptr))
636  return nullptr;
637  const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ptr);
638  return dyn_cast<SCEVConstant>(AddRec->getStepRecurrence(*SE));
639  }
640 
642  int64_t MergeDistance) {
643  const SCEVConstant *Step = getConstantStrideStep(SE, Ptr);
644  if (!Step)
645  return false;
646  APInt StrideVal = Step->getAPInt();
647  if (StrideVal.getBitWidth() > 64)
648  return false;
649  // FIXME: Need to take absolute value for negative stride case.
650  return StrideVal.getSExtValue() < MergeDistance;
651  }
652 };
653 
654 /// \brief CRTP base class for use as a mix-in that aids implementing
655 /// a TargetTransformInfo-compatible class.
656 template <typename T>
658 private:
660 
661 protected:
662  explicit TargetTransformInfoImplCRTPBase(const DataLayout &DL) : BaseT(DL) {}
663 
664 public:
665  using BaseT::getCallCost;
666 
667  unsigned getCallCost(const Function *F, int NumArgs) {
668  assert(F && "A concrete function must be provided to this routine.");
669 
670  if (NumArgs < 0)
671  // Set the argument number to the number of explicit arguments in the
672  // function.
673  NumArgs = F->arg_size();
674 
675  if (Intrinsic::ID IID = F->getIntrinsicID()) {
676  FunctionType *FTy = F->getFunctionType();
677  SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
678  return static_cast<T *>(this)
679  ->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
680  }
681 
682  if (!static_cast<T *>(this)->isLoweredToCall(F))
683  return TTI::TCC_Basic; // Give a basic cost if it will be lowered
684  // directly.
685 
686  return static_cast<T *>(this)->getCallCost(F->getFunctionType(), NumArgs);
687  }
688 
690  // Simply delegate to generic handling of the call.
691  // FIXME: We should use instsimplify or something else to catch calls which
692  // will constant fold with these arguments.
693  return static_cast<T *>(this)->getCallCost(F, Arguments.size());
694  }
695 
696  using BaseT::getGEPCost;
697 
698  int getGEPCost(Type *PointeeType, const Value *Ptr,
699  ArrayRef<const Value *> Operands) {
700  const GlobalValue *BaseGV = nullptr;
701  if (Ptr != nullptr) {
702  // TODO: will remove this when pointers have an opaque type.
704  PointeeType &&
705  "explicit pointee type doesn't match operand's pointee type");
706  BaseGV = dyn_cast<GlobalValue>(Ptr->stripPointerCasts());
707  }
708  bool HasBaseReg = (BaseGV == nullptr);
709 
710  auto PtrSizeBits = DL.getPointerTypeSizeInBits(Ptr->getType());
711  APInt BaseOffset(PtrSizeBits, 0);
712  int64_t Scale = 0;
713 
714  auto GTI = gep_type_begin(PointeeType, Operands);
715  Type *TargetType = nullptr;
716 
717  // Handle the case where the GEP instruction has a single operand,
718  // the basis, therefore TargetType is a nullptr.
719  if (Operands.empty())
720  return !BaseGV ? TTI::TCC_Free : TTI::TCC_Basic;
721 
722  for (auto I = Operands.begin(); I != Operands.end(); ++I, ++GTI) {
723  TargetType = GTI.getIndexedType();
724  // We assume that the cost of Scalar GEP with constant index and the
725  // cost of Vector GEP with splat constant index are the same.
726  const ConstantInt *ConstIdx = dyn_cast<ConstantInt>(*I);
727  if (!ConstIdx)
728  if (auto Splat = getSplatValue(*I))
729  ConstIdx = dyn_cast<ConstantInt>(Splat);
730  if (StructType *STy = GTI.getStructTypeOrNull()) {
731  // For structures the index is always splat or scalar constant
732  assert(ConstIdx && "Unexpected GEP index");
733  uint64_t Field = ConstIdx->getZExtValue();
734  BaseOffset += DL.getStructLayout(STy)->getElementOffset(Field);
735  } else {
736  int64_t ElementSize = DL.getTypeAllocSize(GTI.getIndexedType());
737  if (ConstIdx) {
738  BaseOffset +=
739  ConstIdx->getValue().sextOrTrunc(PtrSizeBits) * ElementSize;
740  } else {
741  // Needs scale register.
742  if (Scale != 0)
743  // No addressing mode takes two scale registers.
744  return TTI::TCC_Basic;
745  Scale = ElementSize;
746  }
747  }
748  }
749 
750  // Assumes the address space is 0 when Ptr is nullptr.
751  unsigned AS =
752  (Ptr == nullptr ? 0 : Ptr->getType()->getPointerAddressSpace());
753 
754  if (static_cast<T *>(this)->isLegalAddressingMode(
755  TargetType, const_cast<GlobalValue *>(BaseGV),
756  BaseOffset.sextOrTrunc(64).getSExtValue(), HasBaseReg, Scale, AS))
757  return TTI::TCC_Free;
758  return TTI::TCC_Basic;
759  }
760 
761  using BaseT::getIntrinsicCost;
762 
763  unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
765  // Delegate to the generic intrinsic handling code. This mostly provides an
766  // opportunity for targets to (for example) special case the cost of
767  // certain intrinsics based on constants used as arguments.
768  SmallVector<Type *, 8> ParamTys;
769  ParamTys.reserve(Arguments.size());
770  for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
771  ParamTys.push_back(Arguments[Idx]->getType());
772  return static_cast<T *>(this)->getIntrinsicCost(IID, RetTy, ParamTys);
773  }
774 
775  unsigned getUserCost(const User *U, ArrayRef<const Value *> Operands) {
776  if (isa<PHINode>(U))
777  return TTI::TCC_Free; // Model all PHI nodes as free.
778 
779  // Static alloca doesn't generate target instructions.
780  if (auto *A = dyn_cast<AllocaInst>(U))
781  if (A->isStaticAlloca())
782  return TTI::TCC_Free;
783 
784  if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
785  return static_cast<T *>(this)->getGEPCost(GEP->getSourceElementType(),
786  GEP->getPointerOperand(),
787  Operands.drop_front());
788  }
789 
790  if (auto CS = ImmutableCallSite(U)) {
791  const Function *F = CS.getCalledFunction();
792  if (!F) {
793  // Just use the called value type.
794  Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
795  return static_cast<T *>(this)
796  ->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
797  }
798 
799  SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
800  return static_cast<T *>(this)->getCallCost(F, Arguments);
801  }
802 
803  if (const CastInst *CI = dyn_cast<CastInst>(U)) {
804  // Result of a cmp instruction is often extended (to be used by other
805  // cmp instructions, logical or return instructions). These are usually
806  // nop on most sane targets.
807  if (isa<CmpInst>(CI->getOperand(0)))
808  return TTI::TCC_Free;
809  if (isa<SExtInst>(CI) || isa<ZExtInst>(CI) || isa<FPExtInst>(CI))
810  return static_cast<T *>(this)->getExtCost(CI, Operands.back());
811  }
812 
813  return static_cast<T *>(this)->getOperationCost(
814  Operator::getOpcode(U), U->getType(),
815  U->getNumOperands() == 1 ? U->getOperand(0)->getType() : nullptr);
816  }
817 
820  I->value_op_end());
821  if (getUserCost(I, Operands) == TTI::TCC_Free)
822  return 0;
823 
824  if (isa<LoadInst>(I))
825  return 4;
826 
827  Type *DstTy = I->getType();
828 
829  // Usually an intrinsic is a simple instruction.
830  // A real function call is much slower.
831  if (auto *CI = dyn_cast<CallInst>(I)) {
832  const Function *F = CI->getCalledFunction();
833  if (!F || static_cast<T *>(this)->isLoweredToCall(F))
834  return 40;
835  // Some intrinsics return a value and a flag, we use the value type
836  // to decide its latency.
837  if (StructType* StructTy = dyn_cast<StructType>(DstTy))
838  DstTy = StructTy->getElementType(0);
839  // Fall through to simple instructions.
840  }
841 
842  if (VectorType *VectorTy = dyn_cast<VectorType>(DstTy))
843  DstTy = VectorTy->getElementType();
844  if (DstTy->isFloatingPointTy())
845  return 3;
846 
847  return 1;
848  }
849 };
850 }
851 
852 #endif
uint64_t CallInst * C
unsigned getNumCases() const
Return the number of &#39;cases&#39; in this switch instruction, excluding the default case.
bool isIntrinsic() const
isIntrinsic - Returns true if the function&#39;s name starts with "llvm.".
Definition: Function.h:180
Base class for use as a mix-in that aids implementing a TargetTransformInfo-compatible class...
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:111
bool isConstantStridedAccessLessThan(ScalarEvolution *SE, const SCEV *Ptr, int64_t MergeDistance)
bool hasLocalLinkage() const
Definition: GlobalValue.h:435
unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy, ArrayRef< Type *> Tys, FastMathFlags FMF, unsigned ScalarizationCostPassed)
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
LLVMContext & Context
const T & back() const
back - Get the last element.
Definition: ArrayRef.h:158
SI Whole Quad Mode
unsigned getGatherScatterOpCost(unsigned Opcode, Type *DataTy, Value *Ptr, bool VariableMask, unsigned Alignment)
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
unsigned minRequiredElementSize(const Value *Val, bool &isSigned)
void getUnrollingPreferences(Loop *, ScalarEvolution &, TTI::UnrollingPreferences &)
unsigned getVectorInstrCost(unsigned Opcode, Type *Val, unsigned Index)
iterator begin() const
Definition: ArrayRef.h:137
#define LLVM_FALLTHROUGH
LLVM_FALLTHROUGH - Mark fallthrough cases in switch statements.
Definition: Compiler.h:235
unsigned getCostOfKeepingLiveOverCall(ArrayRef< Type *> Tys)
const Value * getSplatValue(const Value *V)
Get splat value if the input is a splat vector or return nullptr.
AMDGPU Rewrite Out Arguments
const StructLayout * getStructLayout(StructType *Ty) const
Returns a StructLayout object, indicating the alignment of the struct, its size, and the offsets of i...
Definition: DataLayout.cpp:588
value_op_iterator value_op_begin()
Definition: User.h:256
The main scalar evolution driver.
MemIndexedMode
The type of load/store indexing.
unsigned getCallCost(const Function *F, int NumArgs)
unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, TTI::OperandValueKind Opd1Info, TTI::OperandValueKind Opd2Info, TTI::OperandValueProperties Opd1PropInfo, TTI::OperandValueProperties Opd2PropInfo, ArrayRef< const Value *> Args)
unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy)
value_op_iterator value_op_end()
Definition: User.h:259
F(f)
unsigned getCastInstrCost(unsigned Opcode, Type *Dst, Type *Src, const Instruction *I)
unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
Definition: DerivedTypes.h:503
param_iterator param_end() const
Definition: DerivedTypes.h:129
An instruction for reading from memory.
Definition: Instructions.h:164
Hexagon Common GEP
unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment, unsigned AddressSpace, const Instruction *I)
void reserve(size_type N)
Definition: SmallVector.h:378
unsigned getIntImmCost(const APInt &Imm, Type *Ty)
int getExtCost(const Instruction *I, const Value *Src)
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition: APInt.h:1488
bool isLegalToVectorizeStoreChain(unsigned ChainSizeInBytes, unsigned Alignment, unsigned AddrSpace) const
bool isIndexedLoadLegal(TTI::MemIndexedMode Mode, Type *Ty, const DataLayout &DL) const
CRTP base class for use as a mix-in that aids implementing a TargetTransformInfo-compatible class...
bool getTgtMemIntrinsic(IntrinsicInst *Inst, MemIntrinsicInfo &Info)
unsigned getLoadVectorFactor(unsigned VF, unsigned LoadSize, unsigned ChainSizeInBytes, VectorType *VecTy) const
Type * getPointerElementType() const
Definition: Type.h:373
This is the base class for all instructions that perform data casts.
Definition: InstrTypes.h:592
unsigned getPointerTypeSizeInBits(Type *) const
Layout pointer size, in bits, based on the type.
Definition: DataLayout.cpp:640
bool isFloatingPointTy() const
Return true if this is one of the six floating-point types.
Definition: Type.h:162
Class to represent struct types.
Definition: DerivedTypes.h:201
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:42
unsigned getArithmeticReductionCost(unsigned, Type *, bool)
const APInt & getAPInt() const
bool isLegalToVectorizeLoad(LoadInst *LI) const
Type * getMemcpyLoopLoweringType(LLVMContext &Context, Value *Length, unsigned SrcAlign, unsigned DestAlign) const
bool isTruncateFree(Type *Ty1, Type *Ty2)
bool enableAggressiveInterleaving(bool LoopHasReductions)
Class to represent function types.
Definition: DerivedTypes.h:103
int64_t getSExtValue() const
Get sign extended value.
Definition: APInt.h:1554
llvm::Optional< unsigned > getCacheSize(TargetTransformInfo::CacheLevel Level)
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:245
This node represents a polynomial recurrence on the trip count of the specified loop.
void getMemcpyLoopResidualLoweringType(SmallVectorImpl< Type *> &OpsOut, LLVMContext &Context, unsigned RemainingBytes, unsigned SrcAlign, unsigned DestAlign) const
PopcntSupportKind
Flags indicating the kind of support for population count.
APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
Definition: APInt.cpp:889
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:33
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition: Constants.h:138
An instruction for storing to memory.
Definition: Instructions.h:306
const SCEV * getStepRecurrence(ScalarEvolution &SE) const
Constructs and returns the recurrence indicating how much this expression steps by.
unsigned getExtractWithExtendCost(unsigned Opcode, Type *Dst, VectorType *VecTy, unsigned Index)
amdgpu Simplify well known AMD library false Value * Callee
Value * getOperand(unsigned i) const
Definition: User.h:170
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return &#39;this&#39;.
Definition: Type.h:301
bool isLegalToVectorizeStore(StoreInst *SI) const
unsigned getMinimumVF(unsigned ElemWidth) const
If not nullptr, enable inline expansion of memcmp.
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition: Constants.h:149
unsigned getShuffleCost(TTI::ShuffleKind Kind, Type *Ty, int Index, Type *SubTp)
unsigned getCallInstrCost(Function *F, Type *RetTy, ArrayRef< Type *> Tys)
bool hasName() const
Definition: Value.h:251
Flags describing the kind of vector reduction.
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:69
unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy, const Instruction *I)
unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy, ArrayRef< const Value *> Arguments)
TargetTransformInfoImplBase(const TargetTransformInfoImplBase &Arg)
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:149
This is an important base class in LLVM.
Definition: Constant.h:42
bool isPointerTy() const
True if this is an instance of PointerType.
Definition: Type.h:221
bool isLegalToVectorizeLoadChain(unsigned ChainSizeInBytes, unsigned Alignment, unsigned AddrSpace) const
unsigned getNumParams() const
Return the number of fixed parameters this function type requires.
Definition: DerivedTypes.h:139
unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm, Type *Ty)
bool hasVolatileVariant(Instruction *I, unsigned AddrSpace)
Expected to fold away in lowering.
unsigned getUserCost(const User *U, ArrayRef< const Value *> Operands)
bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset, bool HasBaseReg, int64_t Scale, unsigned AddrSpace, Instruction *I=nullptr)
param_iterator param_begin() const
Definition: DerivedTypes.h:128
const TTI::MemCmpExpansionOptions * enableMemCmpExpansion(bool IsZeroCmp) const
unsigned getEstimatedNumberOfCaseClusters(const SwitchInst &SI, unsigned &JTSize)
size_t arg_size() const
Definition: Function.h:679
const AMDGPUAS & AS
const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs, and aliases.
Definition: Value.cpp:567
unsigned getCallCost(FunctionType *FTy, int NumArgs)
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
const SCEVConstant * getConstantStrideStep(ScalarEvolution *SE, const SCEV *Ptr)
OperandValueProperties
Additional properties of an operand&#39;s values.
int getIntImmCodeSizeCost(unsigned Opcode, unsigned Idx, const APInt &Imm, Type *Ty)
unsigned getNumOperands() const
Definition: User.h:192
This is the shared class of boolean and integer constants.
Definition: Constants.h:84
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
unsigned getStoreVectorFactor(unsigned VF, unsigned StoreSize, unsigned ChainSizeInBytes, VectorType *VecTy) const
unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type...
Definition: Type.cpp:130
unsigned getScalarizationOverhead(Type *Ty, bool Insert, bool Extract)
TargetTransformInfoImplBase(const DataLayout &DL)
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:862
AddressSpace
Definition: NVPTXBaseInfo.h:22
iterator end() const
Definition: ArrayRef.h:138
bool isLegalInteger(uint64_t Width) const
Returns true if the specified type is known to be a native integer type supported by the CPU...
Definition: DataLayout.h:243
Type * getReturnType() const
Definition: DerivedTypes.h:124
bool useReductionIntrinsic(unsigned Opcode, Type *Ty, TTI::ReductionFlags Flags) const
bool allowsMisalignedMemoryAccesses(LLVMContext &Context, unsigned BitWidth, unsigned AddressSpace, unsigned Alignment, bool *Fast)
Fast - This calling convention attempts to make calls as fast as possible (e.g.
Definition: CallingConv.h:43
Intrinsic::ID getIntrinsicID() const LLVM_READONLY
getIntrinsicID - This method returns the ID number of the specified function, or Intrinsic::not_intri...
Definition: Function.h:175
bool shouldConsiderAddressTypePromotion(const Instruction &I, bool &AllowPromotionWithoutCommonHeader)
FunctionType * getFunctionType() const
Returns the FunctionType for me.
Definition: Function.h:145
int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset, bool HasBaseReg, int64_t Scale, unsigned AddrSpace)
Class to represent vector types.
Definition: DerivedTypes.h:393
Class for arbitrary precision integers.
Definition: APInt.h:69
unsigned getLoadStoreVecRegBitWidth(unsigned AddrSpace) const
unsigned getMinMaxReductionCost(Type *, Type *, bool, bool)
amdgpu Simplify well known AMD library false Value Value * Arg
uint64_t getTypeSizeInBits(Type *Ty) const
Size examples:
Definition: DataLayout.h:560
bool isLSRCostLess(TTI::LSRCost &C1, TTI::LSRCost &C2)
uint64_t getTypeAllocSize(Type *Ty) const
Returns the offset in bytes between successive objects of the specified type, including alignment pad...
Definition: DataLayout.h:428
unsigned getMaskedMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment, unsigned AddressSpace)
unsigned getCFInstrCost(unsigned Opcode)
uint64_t getElementOffset(unsigned Idx) const
Definition: DataLayout.h:543
This class represents an analyzed expression in the program.
Represents a single loop in the control flow graph.
Definition: LoopInfo.h:439
ArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
Definition: ArrayRef.h:188
Parameters that control the generic loop unrolling transformation.
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:224
Establish a view to a call site for examination.
Definition: CallSite.h:713
#define I(x, y, z)
Definition: MD5.cpp:58
unsigned getOperandsScalarizationOverhead(ArrayRef< const Value *> Args, unsigned VF)
int getGEPCost(Type *PointeeType, const Value *Ptr, ArrayRef< const Value *> Operands)
bool isIndexedStoreLegal(TTI::MemIndexedMode Mode, Type *Ty, const DataLayout &DL) const
bool areInlineCompatible(const Function *Caller, const Function *Callee) const
LLVM_NODISCARD std::enable_if<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >::type dyn_cast(const Y &Val)
Definition: Casting.h:323
unsigned getAddressComputationCost(Type *Tp, ScalarEvolution *, const SCEV *)
unsigned getInterleavedMemoryOpCost(unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef< unsigned > Indices, unsigned Alignment, unsigned AddressSpace)
const unsigned Kind
Multiway switch.
TargetTransformInfoImplBase(TargetTransformInfoImplBase &&Arg)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
The cost of a typical &#39;add&#39; instruction.
LLVM Value Representation.
Definition: Value.h:73
unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm, Type *Ty)
constexpr char Size[]
Key for Kernel::Arg::Metadata::mSize.
unsigned getOpcode() const
Return the opcode for this Instruction or ConstantExpr.
Definition: Operator.h:41
bool shouldExpandReduction(const IntrinsicInst *II) const
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition: Function.h:312
bool shouldMaximizeVectorBandwidth(bool OptSize) const
const DataLayout & getDataLayout() const
Convenience struct for specifying and reasoning about fast-math flags.
Definition: Operator.h:160
OperandValueKind
Additional information about an operand&#39;s possible values.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
This pass exposes codegen information to IR-level passes.
llvm::Optional< unsigned > getCacheAssociativity(TargetTransformInfo::CacheLevel Level)
CacheLevel
The possible cache levels.
unsigned getRegisterBitWidth(bool Vector) const
Information about a load/store intrinsic defined by the target.
unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy, ArrayRef< Type *> ParamTys)
The cost of a &#39;div&#39; instruction on x86.
static IntegerType * getInt8Ty(LLVMContext &C)
Definition: Type.cpp:174
int getGEPCost(Type *PointeeType, const Value *Ptr, ArrayRef< const Value *> Operands)
unsigned getCallCost(const Function *F, ArrayRef< const Value *> Arguments)
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
bool hasDivRemOp(Type *DataType, bool IsSigned)
TTI::PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit)
Value * getOrCreateResultFromMemIntrinsic(IntrinsicInst *Inst, Type *ExpectedType)
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:144
A wrapper class for inspecting calls to intrinsic functions.
Definition: IntrinsicInst.h:44
This class represents a constant integer value.
unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy, ArrayRef< Value *> Args, FastMathFlags FMF, unsigned VF)
ShuffleKind
The various kinds of shuffle patterns for vector queries.
gep_type_iterator gep_type_begin(const User *GEP)