1 //===- BasicTargetTransformInfo.cpp - Basic target-independent TTI impl ---===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// This file provides the implementation of a basic TargetTransformInfo pass
11 /// predicated on the target abstractions present in the target independent
12 /// code generator. It uses these (primarily TargetLowering) to model as much
13 /// of the TTI query interface as possible. It is included by most targets so
14 /// that they can specialize only a small subset of the query space.
16 //===----------------------------------------------------------------------===//
18 #include "llvm/CodeGen/Passes.h"
19 #include "llvm/Analysis/LoopInfo.h"
20 #include "llvm/Analysis/TargetTransformInfo.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Target/TargetLowering.h"
23 #include "llvm/Target/TargetSubtargetInfo.h"
27 static cl::opt<unsigned>
28 PartialUnrollingThreshold("partial-unrolling-threshold", cl::init(0),
29 cl::desc("Threshold for partial unrolling"), cl::Hidden);
31 #define DEBUG_TYPE "basictti"
35 class BasicTTI final : public ImmutablePass, public TargetTransformInfo {
36 const TargetMachine *TM;
38 /// Estimate the overhead of scalarizing an instruction. Insert and Extract
39 /// are set if the result needs to be inserted and/or extracted from vectors.
40 unsigned getScalarizationOverhead(Type *Ty, bool Insert, bool Extract) const;
42 /// Estimate the cost overhead of SK_Alternate shuffle.
43 unsigned getAltShuffleOverhead(Type *Ty) const;
45 const TargetLoweringBase *getTLI() const {
46 return TM->getSubtargetImpl()->getTargetLowering();
50 BasicTTI() : ImmutablePass(ID), TM(nullptr) {
51 llvm_unreachable("This pass cannot be directly constructed");
54 BasicTTI(const TargetMachine *TM) : ImmutablePass(ID), TM(TM) {
55 initializeBasicTTIPass(*PassRegistry::getPassRegistry());
58 void initializePass() override {
62 void getAnalysisUsage(AnalysisUsage &AU) const override {
63 TargetTransformInfo::getAnalysisUsage(AU);
66 /// Pass identification.
69 /// Provide necessary pointer adjustments for the two base classes.
70 void *getAdjustedAnalysisPointer(const void *ID) override {
71 if (ID == &TargetTransformInfo::ID)
72 return (TargetTransformInfo*)this;
76 bool hasBranchDivergence() const override;
78 /// \name Scalar TTI Implementations
81 bool isLegalAddImmediate(int64_t imm) const override;
82 bool isLegalICmpImmediate(int64_t imm) const override;
83 bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
84 int64_t BaseOffset, bool HasBaseReg,
85 int64_t Scale) const override;
86 int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
87 int64_t BaseOffset, bool HasBaseReg,
88 int64_t Scale) const override;
89 bool isTruncateFree(Type *Ty1, Type *Ty2) const override;
90 bool isTypeLegal(Type *Ty) const override;
91 unsigned getJumpBufAlignment() const override;
92 unsigned getJumpBufSize() const override;
93 bool shouldBuildLookupTables() const override;
94 bool haveFastSqrt(Type *Ty) const override;
95 void getUnrollingPreferences(Loop *L,
96 UnrollingPreferences &UP) const override;
100 /// \name Vector TTI Implementations
103 unsigned getNumberOfRegisters(bool Vector) const override;
104 unsigned getMaximumUnrollFactor() const override;
105 unsigned getRegisterBitWidth(bool Vector) const override;
106 unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
107 OperandValueKind) const override;
108 unsigned getShuffleCost(ShuffleKind Kind, Type *Tp,
109 int Index, Type *SubTp) const override;
110 unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
111 Type *Src) const override;
112 unsigned getCFInstrCost(unsigned Opcode) const override;
113 unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
114 Type *CondTy) const override;
115 unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
116 unsigned Index) const override;
117 unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
118 unsigned AddressSpace) const override;
119 unsigned getIntrinsicInstrCost(Intrinsic::ID, Type *RetTy,
120 ArrayRef<Type*> Tys) const override;
121 unsigned getNumberOfParts(Type *Tp) const override;
122 unsigned getAddressComputationCost( Type *Ty, bool IsComplex) const override;
123 unsigned getReductionCost(unsigned Opcode, Type *Ty,
124 bool IsPairwise) const override;
131 INITIALIZE_AG_PASS(BasicTTI, TargetTransformInfo, "basictti",
132 "Target independent code generator's TTI", true, true, false)
133 char BasicTTI::ID = 0;
136 llvm::createBasicTargetTransformInfoPass(const TargetMachine *TM) {
137 return new BasicTTI(TM);
140 bool BasicTTI::hasBranchDivergence() const { return false; }
142 bool BasicTTI::isLegalAddImmediate(int64_t imm) const {
143 return getTLI()->isLegalAddImmediate(imm);
146 bool BasicTTI::isLegalICmpImmediate(int64_t imm) const {
147 return getTLI()->isLegalICmpImmediate(imm);
150 bool BasicTTI::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
151 int64_t BaseOffset, bool HasBaseReg,
152 int64_t Scale) const {
153 TargetLoweringBase::AddrMode AM;
155 AM.BaseOffs = BaseOffset;
156 AM.HasBaseReg = HasBaseReg;
158 return getTLI()->isLegalAddressingMode(AM, Ty);
161 int BasicTTI::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
162 int64_t BaseOffset, bool HasBaseReg,
163 int64_t Scale) const {
164 TargetLoweringBase::AddrMode AM;
166 AM.BaseOffs = BaseOffset;
167 AM.HasBaseReg = HasBaseReg;
169 return getTLI()->getScalingFactorCost(AM, Ty);
172 bool BasicTTI::isTruncateFree(Type *Ty1, Type *Ty2) const {
173 return getTLI()->isTruncateFree(Ty1, Ty2);
176 bool BasicTTI::isTypeLegal(Type *Ty) const {
177 EVT T = getTLI()->getValueType(Ty);
178 return getTLI()->isTypeLegal(T);
181 unsigned BasicTTI::getJumpBufAlignment() const {
182 return getTLI()->getJumpBufAlignment();
185 unsigned BasicTTI::getJumpBufSize() const {
186 return getTLI()->getJumpBufSize();
189 bool BasicTTI::shouldBuildLookupTables() const {
190 const TargetLoweringBase *TLI = getTLI();
191 return TLI->isOperationLegalOrCustom(ISD::BR_JT, MVT::Other) ||
192 TLI->isOperationLegalOrCustom(ISD::BRIND, MVT::Other);
195 bool BasicTTI::haveFastSqrt(Type *Ty) const {
196 const TargetLoweringBase *TLI = getTLI();
197 EVT VT = TLI->getValueType(Ty);
198 return TLI->isTypeLegal(VT) && TLI->isOperationLegalOrCustom(ISD::FSQRT, VT);
201 void BasicTTI::getUnrollingPreferences(Loop *L,
202 UnrollingPreferences &UP) const {
203 // This unrolling functionality is target independent, but to provide some
204 // motivation for its intended use, for x86:
206 // According to the Intel 64 and IA-32 Architectures Optimization Reference
207 // Manual, Intel Core models and later have a loop stream detector
208 // (and associated uop queue) that can benefit from partial unrolling.
209 // The relevant requirements are:
210 // - The loop must have no more than 4 (8 for Nehalem and later) branches
211 // taken, and none of them may be calls.
212 // - The loop can have no more than 18 (28 for Nehalem and later) uops.
214 // According to the Software Optimization Guide for AMD Family 15h Processors,
215 // models 30h-4fh (Steamroller and later) have a loop predictor and loop
216 // buffer which can benefit from partial unrolling.
217 // The relevant requirements are:
218 // - The loop must have fewer than 16 branches
219 // - The loop must have less than 40 uops in all executed loop branches
221 // The number of taken branches in a loop is hard to estimate here, and
222 // benchmarking has revealed that it is better not to be conservative when
223 // estimating the branch count. As a result, we'll ignore the branch limits
224 // until someone finds a case where it matters in practice.
227 const TargetSubtargetInfo *ST = &TM->getSubtarget<TargetSubtargetInfo>();
228 if (PartialUnrollingThreshold.getNumOccurrences() > 0)
229 MaxOps = PartialUnrollingThreshold;
230 else if (ST->getSchedModel()->LoopMicroOpBufferSize > 0)
231 MaxOps = ST->getSchedModel()->LoopMicroOpBufferSize;
235 // Scan the loop: don't unroll loops with calls.
236 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
240 for (BasicBlock::iterator J = BB->begin(), JE = BB->end(); J != JE; ++J)
241 if (isa<CallInst>(J) || isa<InvokeInst>(J)) {
242 ImmutableCallSite CS(J);
243 if (const Function *F = CS.getCalledFunction()) {
244 if (!TopTTI->isLoweredToCall(F))
252 // Enable runtime and partial unrolling up to the specified size.
253 UP.Partial = UP.Runtime = true;
254 UP.PartialThreshold = UP.PartialOptSizeThreshold = MaxOps;
257 //===----------------------------------------------------------------------===//
259 // Calls used by the vectorizers.
261 //===----------------------------------------------------------------------===//
263 unsigned BasicTTI::getScalarizationOverhead(Type *Ty, bool Insert,
264 bool Extract) const {
265 assert (Ty->isVectorTy() && "Can only scalarize vectors");
268 for (int i = 0, e = Ty->getVectorNumElements(); i < e; ++i) {
270 Cost += TopTTI->getVectorInstrCost(Instruction::InsertElement, Ty, i);
272 Cost += TopTTI->getVectorInstrCost(Instruction::ExtractElement, Ty, i);
278 unsigned BasicTTI::getNumberOfRegisters(bool Vector) const {
282 unsigned BasicTTI::getRegisterBitWidth(bool Vector) const {
286 unsigned BasicTTI::getMaximumUnrollFactor() const {
290 unsigned BasicTTI::getArithmeticInstrCost(unsigned Opcode, Type *Ty,
292 OperandValueKind) const {
293 // Check if any of the operands are vector operands.
294 const TargetLoweringBase *TLI = getTLI();
295 int ISD = TLI->InstructionOpcodeToISD(Opcode);
296 assert(ISD && "Invalid opcode");
298 std::pair<unsigned, MVT> LT = TLI->getTypeLegalizationCost(Ty);
300 bool IsFloat = Ty->getScalarType()->isFloatingPointTy();
301 // Assume that floating point arithmetic operations cost twice as much as
302 // integer operations.
303 unsigned OpCost = (IsFloat ? 2 : 1);
305 if (TLI->isOperationLegalOrPromote(ISD, LT.second)) {
306 // The operation is legal. Assume it costs 1.
307 // If the type is split to multiple registers, assume that there is some
309 // TODO: Once we have extract/insert subvector cost we need to use them.
311 return LT.first * 2 * OpCost;
312 return LT.first * 1 * OpCost;
315 if (!TLI->isOperationExpand(ISD, LT.second)) {
316 // If the operation is custom lowered then assume
317 // thare the code is twice as expensive.
318 return LT.first * 2 * OpCost;
321 // Else, assume that we need to scalarize this op.
322 if (Ty->isVectorTy()) {
323 unsigned Num = Ty->getVectorNumElements();
324 unsigned Cost = TopTTI->getArithmeticInstrCost(Opcode, Ty->getScalarType());
325 // return the cost of multiple scalar invocation plus the cost of inserting
326 // and extracting the values.
327 return getScalarizationOverhead(Ty, true, true) + Num * Cost;
330 // We don't know anything about this scalar instruction.
334 unsigned BasicTTI::getAltShuffleOverhead(Type *Ty) const {
335 assert(Ty->isVectorTy() && "Can only shuffle vectors");
337 // Shuffle cost is equal to the cost of extracting element from its argument
338 // plus the cost of inserting them onto the result vector.
340 // e.g. <4 x float> has a mask of <0,5,2,7> i.e we need to extract from index
341 // 0 of first vector, index 1 of second vector,index 2 of first vector and
342 // finally index 3 of second vector and insert them at index <0,1,2,3> of
344 for (int i = 0, e = Ty->getVectorNumElements(); i < e; ++i) {
345 Cost += TopTTI->getVectorInstrCost(Instruction::InsertElement, Ty, i);
346 Cost += TopTTI->getVectorInstrCost(Instruction::ExtractElement, Ty, i);
351 unsigned BasicTTI::getShuffleCost(ShuffleKind Kind, Type *Tp, int Index,
353 if (Kind == SK_Alternate) {
354 return getAltShuffleOverhead(Tp);
359 unsigned BasicTTI::getCastInstrCost(unsigned Opcode, Type *Dst,
361 const TargetLoweringBase *TLI = getTLI();
362 int ISD = TLI->InstructionOpcodeToISD(Opcode);
363 assert(ISD && "Invalid opcode");
365 std::pair<unsigned, MVT> SrcLT = TLI->getTypeLegalizationCost(Src);
366 std::pair<unsigned, MVT> DstLT = TLI->getTypeLegalizationCost(Dst);
368 // Check for NOOP conversions.
369 if (SrcLT.first == DstLT.first &&
370 SrcLT.second.getSizeInBits() == DstLT.second.getSizeInBits()) {
372 // Bitcast between types that are legalized to the same type are free.
373 if (Opcode == Instruction::BitCast || Opcode == Instruction::Trunc)
377 if (Opcode == Instruction::Trunc &&
378 TLI->isTruncateFree(SrcLT.second, DstLT.second))
381 if (Opcode == Instruction::ZExt &&
382 TLI->isZExtFree(SrcLT.second, DstLT.second))
385 // If the cast is marked as legal (or promote) then assume low cost.
386 if (SrcLT.first == DstLT.first &&
387 TLI->isOperationLegalOrPromote(ISD, DstLT.second))
390 // Handle scalar conversions.
391 if (!Src->isVectorTy() && !Dst->isVectorTy()) {
393 // Scalar bitcasts are usually free.
394 if (Opcode == Instruction::BitCast)
397 // Just check the op cost. If the operation is legal then assume it costs 1.
398 if (!TLI->isOperationExpand(ISD, DstLT.second))
401 // Assume that illegal scalar instruction are expensive.
405 // Check vector-to-vector casts.
406 if (Dst->isVectorTy() && Src->isVectorTy()) {
408 // If the cast is between same-sized registers, then the check is simple.
409 if (SrcLT.first == DstLT.first &&
410 SrcLT.second.getSizeInBits() == DstLT.second.getSizeInBits()) {
412 // Assume that Zext is done using AND.
413 if (Opcode == Instruction::ZExt)
416 // Assume that sext is done using SHL and SRA.
417 if (Opcode == Instruction::SExt)
420 // Just check the op cost. If the operation is legal then assume it costs
421 // 1 and multiply by the type-legalization overhead.
422 if (!TLI->isOperationExpand(ISD, DstLT.second))
423 return SrcLT.first * 1;
426 // If we are converting vectors and the operation is illegal, or
427 // if the vectors are legalized to different types, estimate the
428 // scalarization costs.
429 unsigned Num = Dst->getVectorNumElements();
430 unsigned Cost = TopTTI->getCastInstrCost(Opcode, Dst->getScalarType(),
431 Src->getScalarType());
433 // Return the cost of multiple scalar invocation plus the cost of
434 // inserting and extracting the values.
435 return getScalarizationOverhead(Dst, true, true) + Num * Cost;
438 // We already handled vector-to-vector and scalar-to-scalar conversions. This
439 // is where we handle bitcast between vectors and scalars. We need to assume
440 // that the conversion is scalarized in one way or another.
441 if (Opcode == Instruction::BitCast)
442 // Illegal bitcasts are done by storing and loading from a stack slot.
443 return (Src->isVectorTy()? getScalarizationOverhead(Src, false, true):0) +
444 (Dst->isVectorTy()? getScalarizationOverhead(Dst, true, false):0);
446 llvm_unreachable("Unhandled cast");
449 unsigned BasicTTI::getCFInstrCost(unsigned Opcode) const {
450 // Branches are assumed to be predicted.
454 unsigned BasicTTI::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
455 Type *CondTy) const {
456 const TargetLoweringBase *TLI = getTLI();
457 int ISD = TLI->InstructionOpcodeToISD(Opcode);
458 assert(ISD && "Invalid opcode");
460 // Selects on vectors are actually vector selects.
461 if (ISD == ISD::SELECT) {
462 assert(CondTy && "CondTy must exist");
463 if (CondTy->isVectorTy())
467 std::pair<unsigned, MVT> LT = TLI->getTypeLegalizationCost(ValTy);
469 if (!TLI->isOperationExpand(ISD, LT.second)) {
470 // The operation is legal. Assume it costs 1. Multiply
471 // by the type-legalization overhead.
475 // Otherwise, assume that the cast is scalarized.
476 if (ValTy->isVectorTy()) {
477 unsigned Num = ValTy->getVectorNumElements();
479 CondTy = CondTy->getScalarType();
480 unsigned Cost = TopTTI->getCmpSelInstrCost(Opcode, ValTy->getScalarType(),
483 // Return the cost of multiple scalar invocation plus the cost of inserting
484 // and extracting the values.
485 return getScalarizationOverhead(ValTy, true, false) + Num * Cost;
488 // Unknown scalar opcode.
492 unsigned BasicTTI::getVectorInstrCost(unsigned Opcode, Type *Val,
493 unsigned Index) const {
494 std::pair<unsigned, MVT> LT = getTLI()->getTypeLegalizationCost(Val->getScalarType());
499 unsigned BasicTTI::getMemoryOpCost(unsigned Opcode, Type *Src,
501 unsigned AddressSpace) const {
502 assert(!Src->isVoidTy() && "Invalid type");
503 std::pair<unsigned, MVT> LT = getTLI()->getTypeLegalizationCost(Src);
505 // Assuming that all loads of legal types cost 1.
506 unsigned Cost = LT.first;
508 if (Src->isVectorTy() &&
509 Src->getPrimitiveSizeInBits() < LT.second.getSizeInBits()) {
510 // This is a vector load that legalizes to a larger type than the vector
511 // itself. Unless the corresponding extending load or truncating store is
512 // legal, then this will scalarize.
513 TargetLowering::LegalizeAction LA = TargetLowering::Expand;
514 EVT MemVT = getTLI()->getValueType(Src, true);
515 if (MemVT.isSimple() && MemVT != MVT::Other) {
516 if (Opcode == Instruction::Store)
517 LA = getTLI()->getTruncStoreAction(LT.second, MemVT.getSimpleVT());
519 LA = getTLI()->getLoadExtAction(ISD::EXTLOAD, MemVT.getSimpleVT());
522 if (LA != TargetLowering::Legal && LA != TargetLowering::Custom) {
523 // This is a vector load/store for some illegal type that is scalarized.
524 // We must account for the cost of building or decomposing the vector.
525 Cost += getScalarizationOverhead(Src, Opcode != Instruction::Store,
526 Opcode == Instruction::Store);
533 unsigned BasicTTI::getIntrinsicInstrCost(Intrinsic::ID IID, Type *RetTy,
534 ArrayRef<Type *> Tys) const {
538 // Assume that we need to scalarize this intrinsic.
539 unsigned ScalarizationCost = 0;
540 unsigned ScalarCalls = 1;
541 if (RetTy->isVectorTy()) {
542 ScalarizationCost = getScalarizationOverhead(RetTy, true, false);
543 ScalarCalls = std::max(ScalarCalls, RetTy->getVectorNumElements());
545 for (unsigned i = 0, ie = Tys.size(); i != ie; ++i) {
546 if (Tys[i]->isVectorTy()) {
547 ScalarizationCost += getScalarizationOverhead(Tys[i], false, true);
548 ScalarCalls = std::max(ScalarCalls, RetTy->getVectorNumElements());
552 return ScalarCalls + ScalarizationCost;
554 // Look for intrinsics that can be lowered directly or turned into a scalar
556 case Intrinsic::sqrt: ISD = ISD::FSQRT; break;
557 case Intrinsic::sin: ISD = ISD::FSIN; break;
558 case Intrinsic::cos: ISD = ISD::FCOS; break;
559 case Intrinsic::exp: ISD = ISD::FEXP; break;
560 case Intrinsic::exp2: ISD = ISD::FEXP2; break;
561 case Intrinsic::log: ISD = ISD::FLOG; break;
562 case Intrinsic::log10: ISD = ISD::FLOG10; break;
563 case Intrinsic::log2: ISD = ISD::FLOG2; break;
564 case Intrinsic::fabs: ISD = ISD::FABS; break;
565 case Intrinsic::copysign: ISD = ISD::FCOPYSIGN; break;
566 case Intrinsic::floor: ISD = ISD::FFLOOR; break;
567 case Intrinsic::ceil: ISD = ISD::FCEIL; break;
568 case Intrinsic::trunc: ISD = ISD::FTRUNC; break;
569 case Intrinsic::nearbyint:
570 ISD = ISD::FNEARBYINT; break;
571 case Intrinsic::rint: ISD = ISD::FRINT; break;
572 case Intrinsic::round: ISD = ISD::FROUND; break;
573 case Intrinsic::pow: ISD = ISD::FPOW; break;
574 case Intrinsic::fma: ISD = ISD::FMA; break;
575 case Intrinsic::fmuladd: ISD = ISD::FMA; break;
576 // FIXME: We should return 0 whenever getIntrinsicCost == TCC_Free.
577 case Intrinsic::lifetime_start:
578 case Intrinsic::lifetime_end:
582 const TargetLoweringBase *TLI = getTLI();
583 std::pair<unsigned, MVT> LT = TLI->getTypeLegalizationCost(RetTy);
585 if (TLI->isOperationLegalOrPromote(ISD, LT.second)) {
586 // The operation is legal. Assume it costs 1.
587 // If the type is split to multiple registers, assume that thre is some
589 // TODO: Once we have extract/insert subvector cost we need to use them.
595 if (!TLI->isOperationExpand(ISD, LT.second)) {
596 // If the operation is custom lowered then assume
597 // thare the code is twice as expensive.
601 // If we can't lower fmuladd into an FMA estimate the cost as a floating
602 // point mul followed by an add.
603 if (IID == Intrinsic::fmuladd)
604 return TopTTI->getArithmeticInstrCost(BinaryOperator::FMul, RetTy) +
605 TopTTI->getArithmeticInstrCost(BinaryOperator::FAdd, RetTy);
607 // Else, assume that we need to scalarize this intrinsic. For math builtins
608 // this will emit a costly libcall, adding call overhead and spills. Make it
610 if (RetTy->isVectorTy()) {
611 unsigned Num = RetTy->getVectorNumElements();
612 unsigned Cost = TopTTI->getIntrinsicInstrCost(IID, RetTy->getScalarType(),
614 return 10 * Cost * Num;
617 // This is going to be turned into a library call, make it expensive.
621 unsigned BasicTTI::getNumberOfParts(Type *Tp) const {
622 std::pair<unsigned, MVT> LT = getTLI()->getTypeLegalizationCost(Tp);
626 unsigned BasicTTI::getAddressComputationCost(Type *Ty, bool IsComplex) const {
630 unsigned BasicTTI::getReductionCost(unsigned Opcode, Type *Ty,
631 bool IsPairwise) const {
632 assert(Ty->isVectorTy() && "Expect a vector type");
633 unsigned NumVecElts = Ty->getVectorNumElements();
634 unsigned NumReduxLevels = Log2_32(NumVecElts);
635 unsigned ArithCost = NumReduxLevels *
636 TopTTI->getArithmeticInstrCost(Opcode, Ty);
637 // Assume the pairwise shuffles add a cost.
638 unsigned ShuffleCost =
639 NumReduxLevels * (IsPairwise + 1) *
640 TopTTI->getShuffleCost(SK_ExtractSubvector, Ty, NumVecElts / 2, Ty);
641 return ShuffleCost + ArithCost + getScalarizationOverhead(Ty, false, true);