1 //===- llvm/Analysis/TargetTransformInfo.cpp ------------------------------===//
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 #include "llvm/Analysis/TargetTransformInfo.h"
11 #include "llvm/IR/CallSite.h"
12 #include "llvm/IR/DataLayout.h"
13 #include "llvm/IR/Instruction.h"
14 #include "llvm/IR/Instructions.h"
15 #include "llvm/IR/IntrinsicInst.h"
16 #include "llvm/IR/Operator.h"
17 #include "llvm/Support/ErrorHandling.h"
21 #define DEBUG_TYPE "tti"
23 // Setup the analysis group to manage the TargetTransformInfo passes.
24 INITIALIZE_ANALYSIS_GROUP(TargetTransformInfo, "Target Information", NoTTI)
25 char TargetTransformInfo::ID = 0;
27 TargetTransformInfo::~TargetTransformInfo() {
30 void TargetTransformInfo::pushTTIStack(Pass *P) {
32 PrevTTI = &P->getAnalysis<TargetTransformInfo>();
34 // Walk up the chain and update the top TTI pointer.
35 for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
39 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
40 AU.addRequired<TargetTransformInfo>();
43 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
45 return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
48 unsigned TargetTransformInfo::getGEPCost(
49 const Value *Ptr, ArrayRef<const Value *> Operands) const {
50 return PrevTTI->getGEPCost(Ptr, Operands);
53 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
55 return PrevTTI->getCallCost(FTy, NumArgs);
58 unsigned TargetTransformInfo::getCallCost(const Function *F,
60 return PrevTTI->getCallCost(F, NumArgs);
63 unsigned TargetTransformInfo::getCallCost(
64 const Function *F, ArrayRef<const Value *> Arguments) const {
65 return PrevTTI->getCallCost(F, Arguments);
68 unsigned TargetTransformInfo::getIntrinsicCost(
69 Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
70 return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
73 unsigned TargetTransformInfo::getIntrinsicCost(
74 Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
75 return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
78 unsigned TargetTransformInfo::getUserCost(const User *U) const {
79 return PrevTTI->getUserCost(U);
82 bool TargetTransformInfo::hasBranchDivergence() const {
83 return PrevTTI->hasBranchDivergence();
86 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
87 return PrevTTI->isLoweredToCall(F);
90 void TargetTransformInfo::getUnrollingPreferences(Loop *L,
91 UnrollingPreferences &UP) const {
92 PrevTTI->getUnrollingPreferences(L, UP);
95 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
96 return PrevTTI->isLegalAddImmediate(Imm);
99 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
100 return PrevTTI->isLegalICmpImmediate(Imm);
103 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
106 int64_t Scale) const {
107 return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
111 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
114 int64_t Scale) const {
115 return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
119 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
120 return PrevTTI->isTruncateFree(Ty1, Ty2);
123 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
124 return PrevTTI->isTypeLegal(Ty);
127 unsigned TargetTransformInfo::getJumpBufAlignment() const {
128 return PrevTTI->getJumpBufAlignment();
131 unsigned TargetTransformInfo::getJumpBufSize() const {
132 return PrevTTI->getJumpBufSize();
135 bool TargetTransformInfo::shouldBuildLookupTables() const {
136 return PrevTTI->shouldBuildLookupTables();
139 TargetTransformInfo::PopcntSupportKind
140 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
141 return PrevTTI->getPopcntSupport(IntTyWidthInBit);
144 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
145 return PrevTTI->haveFastSqrt(Ty);
148 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
149 return PrevTTI->getIntImmCost(Imm, Ty);
152 unsigned TargetTransformInfo::getIntImmCost(unsigned Opc, unsigned Idx,
153 const APInt &Imm, Type *Ty) const {
154 return PrevTTI->getIntImmCost(Opc, Idx, Imm, Ty);
157 unsigned TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
158 const APInt &Imm, Type *Ty) const {
159 return PrevTTI->getIntImmCost(IID, Idx, Imm, Ty);
162 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
163 return PrevTTI->getNumberOfRegisters(Vector);
166 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
167 return PrevTTI->getRegisterBitWidth(Vector);
170 unsigned TargetTransformInfo::getMaximumUnrollFactor() const {
171 return PrevTTI->getMaximumUnrollFactor();
174 unsigned TargetTransformInfo::getArithmeticInstrCost(
175 unsigned Opcode, Type *Ty, OperandValueKind Op1Info,
176 OperandValueKind Op2Info, OperandValueProperties Opd1PropInfo,
177 OperandValueProperties Opd2PropInfo) const {
178 return PrevTTI->getArithmeticInstrCost(Opcode, Ty, Op1Info, Op2Info,
179 Opd1PropInfo, Opd2PropInfo);
182 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
183 int Index, Type *SubTp) const {
184 return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
187 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
189 return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
192 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
193 return PrevTTI->getCFInstrCost(Opcode);
196 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
197 Type *CondTy) const {
198 return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
201 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
202 unsigned Index) const {
203 return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
206 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
208 unsigned AddressSpace) const {
209 return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
214 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
216 ArrayRef<Type *> Tys) const {
217 return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
220 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
221 return PrevTTI->getNumberOfParts(Tp);
224 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp,
225 bool IsComplex) const {
226 return PrevTTI->getAddressComputationCost(Tp, IsComplex);
229 unsigned TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
230 bool IsPairwise) const {
231 return PrevTTI->getReductionCost(Opcode, Ty, IsPairwise);
234 unsigned TargetTransformInfo::getCostOfKeepingLiveOverCall(ArrayRef<Type*> Tys)
236 return PrevTTI->getCostOfKeepingLiveOverCall(Tys);
241 struct NoTTI final : ImmutablePass, TargetTransformInfo {
242 const DataLayout *DL;
244 NoTTI() : ImmutablePass(ID), DL(nullptr) {
245 initializeNoTTIPass(*PassRegistry::getPassRegistry());
248 void initializePass() override {
249 // Note that this subclass is special, and must *not* call initializeTTI as
250 // it does not chain.
253 DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
254 DL = DLP ? &DLP->getDataLayout() : nullptr;
257 void getAnalysisUsage(AnalysisUsage &AU) const override {
258 // Note that this subclass is special, and must *not* call
259 // TTI::getAnalysisUsage as it breaks the recursion.
262 /// Pass identification.
265 /// Provide necessary pointer adjustments for the two base classes.
266 void *getAdjustedAnalysisPointer(const void *ID) override {
267 if (ID == &TargetTransformInfo::ID)
268 return (TargetTransformInfo*)this;
272 unsigned getOperationCost(unsigned Opcode, Type *Ty,
273 Type *OpTy) const override {
276 // By default, just classify everything as 'basic'.
279 case Instruction::GetElementPtr:
280 llvm_unreachable("Use getGEPCost for GEP operations!");
282 case Instruction::BitCast:
283 assert(OpTy && "Cast instructions must provide the operand type");
284 if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
285 // Identity and pointer-to-pointer casts are free.
288 // Otherwise, the default basic cost is used.
291 case Instruction::IntToPtr: {
295 // An inttoptr cast is free so long as the input is a legal integer type
296 // which doesn't contain values outside the range of a pointer.
297 unsigned OpSize = OpTy->getScalarSizeInBits();
298 if (DL->isLegalInteger(OpSize) &&
299 OpSize <= DL->getPointerTypeSizeInBits(Ty))
302 // Otherwise it's not a no-op.
305 case Instruction::PtrToInt: {
309 // A ptrtoint cast is free so long as the result is large enough to store
310 // the pointer, and a legal integer type.
311 unsigned DestSize = Ty->getScalarSizeInBits();
312 if (DL->isLegalInteger(DestSize) &&
313 DestSize >= DL->getPointerTypeSizeInBits(OpTy))
316 // Otherwise it's not a no-op.
319 case Instruction::Trunc:
320 // trunc to a native type is free (assuming the target has compare and
321 // shift-right of the same width).
322 if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
329 unsigned getGEPCost(const Value *Ptr,
330 ArrayRef<const Value *> Operands) const override {
331 // In the basic model, we just assume that all-constant GEPs will be folded
332 // into their uses via addressing modes.
333 for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
334 if (!isa<Constant>(Operands[Idx]))
340 unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const override
342 assert(FTy && "FunctionType must be provided to this routine.");
344 // The target-independent implementation just measures the size of the
345 // function by approximating that each argument will take on average one
346 // instruction to prepare.
349 // Set the argument number to the number of explicit arguments in the
351 NumArgs = FTy->getNumParams();
353 return TCC_Basic * (NumArgs + 1);
356 unsigned getCallCost(const Function *F, int NumArgs = -1) const override
358 assert(F && "A concrete function must be provided to this routine.");
361 // Set the argument number to the number of explicit arguments in the
363 NumArgs = F->arg_size();
365 if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
366 FunctionType *FTy = F->getFunctionType();
367 SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
368 return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
371 if (!TopTTI->isLoweredToCall(F))
372 return TCC_Basic; // Give a basic cost if it will be lowered directly.
374 return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
377 unsigned getCallCost(const Function *F,
378 ArrayRef<const Value *> Arguments) const override {
379 // Simply delegate to generic handling of the call.
380 // FIXME: We should use instsimplify or something else to catch calls which
381 // will constant fold with these arguments.
382 return TopTTI->getCallCost(F, Arguments.size());
385 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
386 ArrayRef<Type *> ParamTys) const override {
389 // Intrinsics rarely (if ever) have normal argument setup constraints.
390 // Model them as having a basic instruction cost.
391 // FIXME: This is wrong for libc intrinsics.
394 case Intrinsic::assume:
395 case Intrinsic::dbg_declare:
396 case Intrinsic::dbg_value:
397 case Intrinsic::invariant_start:
398 case Intrinsic::invariant_end:
399 case Intrinsic::lifetime_start:
400 case Intrinsic::lifetime_end:
401 case Intrinsic::objectsize:
402 case Intrinsic::ptr_annotation:
403 case Intrinsic::var_annotation:
404 // These intrinsics don't actually represent code after lowering.
410 getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
411 ArrayRef<const Value *> Arguments) const override {
412 // Delegate to the generic intrinsic handling code. This mostly provides an
413 // opportunity for targets to (for example) special case the cost of
414 // certain intrinsics based on constants used as arguments.
415 SmallVector<Type *, 8> ParamTys;
416 ParamTys.reserve(Arguments.size());
417 for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
418 ParamTys.push_back(Arguments[Idx]->getType());
419 return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
422 unsigned getUserCost(const User *U) const override {
424 return TCC_Free; // Model all PHI nodes as free.
426 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
427 SmallVector<const Value *, 4> Indices(GEP->idx_begin(), GEP->idx_end());
428 return TopTTI->getGEPCost(GEP->getPointerOperand(), Indices);
431 if (ImmutableCallSite CS = U) {
432 const Function *F = CS.getCalledFunction();
434 // Just use the called value type.
435 Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
436 return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
439 SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
440 return TopTTI->getCallCost(F, Arguments);
443 if (const CastInst *CI = dyn_cast<CastInst>(U)) {
444 // Result of a cmp instruction is often extended (to be used by other
445 // cmp instructions, logical or return instructions). These are usually
446 // nop on most sane targets.
447 if (isa<CmpInst>(CI->getOperand(0)))
451 // Otherwise delegate to the fully generic implementations.
452 return getOperationCost(Operator::getOpcode(U), U->getType(),
453 U->getNumOperands() == 1 ?
454 U->getOperand(0)->getType() : nullptr);
457 bool hasBranchDivergence() const override { return false; }
459 bool isLoweredToCall(const Function *F) const override {
460 // FIXME: These should almost certainly not be handled here, and instead
461 // handled with the help of TLI or the target itself. This was largely
462 // ported from existing analysis heuristics here so that such refactorings
463 // can take place in the future.
465 if (F->isIntrinsic())
468 if (F->hasLocalLinkage() || !F->hasName())
471 StringRef Name = F->getName();
473 // These will all likely lower to a single selection DAG node.
474 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
475 Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
476 Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
477 Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
480 // These are all likely to be optimized into something smaller.
481 if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
482 Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
483 "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
484 Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
490 void getUnrollingPreferences(Loop *, UnrollingPreferences &) const override {
493 bool isLegalAddImmediate(int64_t Imm) const override {
497 bool isLegalICmpImmediate(int64_t Imm) const override {
501 bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
502 bool HasBaseReg, int64_t Scale) const override
504 // Guess that reg+reg addressing is allowed. This heuristic is taken from
505 // the implementation of LSR.
506 return !BaseGV && BaseOffset == 0 && Scale <= 1;
509 int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
510 bool HasBaseReg, int64_t Scale) const override {
511 // Guess that all legal addressing mode are free.
512 if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
517 bool isTruncateFree(Type *Ty1, Type *Ty2) const override {
521 bool isTypeLegal(Type *Ty) const override {
525 unsigned getJumpBufAlignment() const override {
529 unsigned getJumpBufSize() const override {
533 bool shouldBuildLookupTables() const override {
538 getPopcntSupport(unsigned IntTyWidthInBit) const override {
542 bool haveFastSqrt(Type *Ty) const override {
546 unsigned getIntImmCost(const APInt &Imm, Type *Ty) const override {
550 unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
551 Type *Ty) const override {
555 unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm,
556 Type *Ty) const override {
560 unsigned getNumberOfRegisters(bool Vector) const override {
564 unsigned getRegisterBitWidth(bool Vector) const override {
568 unsigned getMaximumUnrollFactor() const override {
572 unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
573 OperandValueKind, OperandValueProperties,
574 OperandValueProperties) const override {
578 unsigned getShuffleCost(ShuffleKind Kind, Type *Ty,
579 int Index = 0, Type *SubTp = nullptr) const override {
583 unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
584 Type *Src) const override {
588 unsigned getCFInstrCost(unsigned Opcode) const override {
592 unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
593 Type *CondTy = nullptr) const override {
597 unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
598 unsigned Index = -1) const override {
602 unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
603 unsigned AddressSpace) const override {
607 unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
608 ArrayRef<Type*> Tys) const override {
612 unsigned getNumberOfParts(Type *Tp) const override {
616 unsigned getAddressComputationCost(Type *Tp, bool) const override {
620 unsigned getReductionCost(unsigned, Type *, bool) const override {
624 unsigned getCostOfKeepingLiveOverCall(ArrayRef<Type*> Tys) const override {
630 } // end anonymous namespace
632 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
633 "No target information", true, true, true)
636 ImmutablePass *llvm::createNoTargetTransformInfoPass() {