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 #define DEBUG_TYPE "tti"
11 #include "llvm/Analysis/TargetTransformInfo.h"
12 #include "llvm/IR/CallSite.h"
13 #include "llvm/IR/DataLayout.h"
14 #include "llvm/IR/Instruction.h"
15 #include "llvm/IR/Instructions.h"
16 #include "llvm/IR/IntrinsicInst.h"
17 #include "llvm/IR/Operator.h"
18 #include "llvm/Support/ErrorHandling.h"
22 // Setup the analysis group to manage the TargetTransformInfo passes.
23 INITIALIZE_ANALYSIS_GROUP(TargetTransformInfo, "Target Information", NoTTI)
24 char TargetTransformInfo::ID = 0;
26 TargetTransformInfo::~TargetTransformInfo() {
29 void TargetTransformInfo::pushTTIStack(Pass *P) {
31 PrevTTI = &P->getAnalysis<TargetTransformInfo>();
33 // Walk up the chain and update the top TTI pointer.
34 for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
38 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
39 AU.addRequired<TargetTransformInfo>();
42 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
44 return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
47 unsigned TargetTransformInfo::getGEPCost(
48 const Value *Ptr, ArrayRef<const Value *> Operands) const {
49 return PrevTTI->getGEPCost(Ptr, Operands);
52 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
54 return PrevTTI->getCallCost(FTy, NumArgs);
57 unsigned TargetTransformInfo::getCallCost(const Function *F,
59 return PrevTTI->getCallCost(F, NumArgs);
62 unsigned TargetTransformInfo::getCallCost(
63 const Function *F, ArrayRef<const Value *> Arguments) const {
64 return PrevTTI->getCallCost(F, Arguments);
67 unsigned TargetTransformInfo::getIntrinsicCost(
68 Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
69 return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
72 unsigned TargetTransformInfo::getIntrinsicCost(
73 Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
74 return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
77 unsigned TargetTransformInfo::getUserCost(const User *U) const {
78 return PrevTTI->getUserCost(U);
81 bool TargetTransformInfo::hasBranchDivergence() const {
82 return PrevTTI->hasBranchDivergence();
85 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
86 return PrevTTI->isLoweredToCall(F);
89 void TargetTransformInfo::getUnrollingPreferences(Loop *L,
90 UnrollingPreferences &UP) const {
91 PrevTTI->getUnrollingPreferences(L, UP);
94 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
95 return PrevTTI->isLegalAddImmediate(Imm);
98 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
99 return PrevTTI->isLegalICmpImmediate(Imm);
102 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
105 int64_t Scale) const {
106 return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
110 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
113 int64_t Scale) const {
114 return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
118 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
119 return PrevTTI->isTruncateFree(Ty1, Ty2);
122 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
123 return PrevTTI->isTypeLegal(Ty);
126 unsigned TargetTransformInfo::getJumpBufAlignment() const {
127 return PrevTTI->getJumpBufAlignment();
130 unsigned TargetTransformInfo::getJumpBufSize() const {
131 return PrevTTI->getJumpBufSize();
134 bool TargetTransformInfo::shouldBuildLookupTables() const {
135 return PrevTTI->shouldBuildLookupTables();
138 TargetTransformInfo::PopcntSupportKind
139 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
140 return PrevTTI->getPopcntSupport(IntTyWidthInBit);
143 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
144 return PrevTTI->haveFastSqrt(Ty);
147 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
148 return PrevTTI->getIntImmCost(Imm, Ty);
151 unsigned TargetTransformInfo::getIntImmCost(unsigned Opc, unsigned Idx,
152 const APInt &Imm, Type *Ty) const {
153 return PrevTTI->getIntImmCost(Opc, Idx, Imm, Ty);
156 unsigned TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
157 const APInt &Imm, Type *Ty) const {
158 return PrevTTI->getIntImmCost(IID, Idx, Imm, Ty);
161 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
162 return PrevTTI->getNumberOfRegisters(Vector);
165 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
166 return PrevTTI->getRegisterBitWidth(Vector);
169 unsigned TargetTransformInfo::getMaximumUnrollFactor() const {
170 return PrevTTI->getMaximumUnrollFactor();
173 unsigned TargetTransformInfo::getArithmeticInstrCost(unsigned Opcode,
175 OperandValueKind Op1Info,
176 OperandValueKind Op2Info) const {
177 return PrevTTI->getArithmeticInstrCost(Opcode, Ty, Op1Info, Op2Info);
180 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
181 int Index, Type *SubTp) const {
182 return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
185 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
187 return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
190 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
191 return PrevTTI->getCFInstrCost(Opcode);
194 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
195 Type *CondTy) const {
196 return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
199 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
200 unsigned Index) const {
201 return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
204 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
206 unsigned AddressSpace) const {
207 return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
212 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
214 ArrayRef<Type *> Tys) const {
215 return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
218 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
219 return PrevTTI->getNumberOfParts(Tp);
222 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp,
223 bool IsComplex) const {
224 return PrevTTI->getAddressComputationCost(Tp, IsComplex);
227 unsigned TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
228 bool IsPairwise) const {
229 return PrevTTI->getReductionCost(Opcode, Ty, IsPairwise);
234 struct NoTTI final : ImmutablePass, TargetTransformInfo {
235 const DataLayout *DL;
237 NoTTI() : ImmutablePass(ID), DL(0) {
238 initializeNoTTIPass(*PassRegistry::getPassRegistry());
241 virtual void initializePass() override {
242 // Note that this subclass is special, and must *not* call initializeTTI as
243 // it does not chain.
246 DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
247 DL = DLP ? &DLP->getDataLayout() : 0;
250 virtual void getAnalysisUsage(AnalysisUsage &AU) const override {
251 // Note that this subclass is special, and must *not* call
252 // TTI::getAnalysisUsage as it breaks the recursion.
255 /// Pass identification.
258 /// Provide necessary pointer adjustments for the two base classes.
259 virtual void *getAdjustedAnalysisPointer(const void *ID) override {
260 if (ID == &TargetTransformInfo::ID)
261 return (TargetTransformInfo*)this;
265 unsigned getOperationCost(unsigned Opcode, Type *Ty,
266 Type *OpTy) const override {
269 // By default, just classify everything as 'basic'.
272 case Instruction::GetElementPtr:
273 llvm_unreachable("Use getGEPCost for GEP operations!");
275 case Instruction::BitCast:
276 assert(OpTy && "Cast instructions must provide the operand type");
277 if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
278 // Identity and pointer-to-pointer casts are free.
281 // Otherwise, the default basic cost is used.
284 case Instruction::IntToPtr: {
288 // An inttoptr cast is free so long as the input is a legal integer type
289 // which doesn't contain values outside the range of a pointer.
290 unsigned OpSize = OpTy->getScalarSizeInBits();
291 if (DL->isLegalInteger(OpSize) &&
292 OpSize <= DL->getPointerTypeSizeInBits(Ty))
295 // Otherwise it's not a no-op.
298 case Instruction::PtrToInt: {
302 // A ptrtoint cast is free so long as the result is large enough to store
303 // the pointer, and a legal integer type.
304 unsigned DestSize = Ty->getScalarSizeInBits();
305 if (DL->isLegalInteger(DestSize) &&
306 DestSize >= DL->getPointerTypeSizeInBits(OpTy))
309 // Otherwise it's not a no-op.
312 case Instruction::Trunc:
313 // trunc to a native type is free (assuming the target has compare and
314 // shift-right of the same width).
315 if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
322 unsigned getGEPCost(const Value *Ptr,
323 ArrayRef<const Value *> Operands) const override {
324 // In the basic model, we just assume that all-constant GEPs will be folded
325 // into their uses via addressing modes.
326 for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
327 if (!isa<Constant>(Operands[Idx]))
333 unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const override
335 assert(FTy && "FunctionType must be provided to this routine.");
337 // The target-independent implementation just measures the size of the
338 // function by approximating that each argument will take on average one
339 // instruction to prepare.
342 // Set the argument number to the number of explicit arguments in the
344 NumArgs = FTy->getNumParams();
346 return TCC_Basic * (NumArgs + 1);
349 unsigned getCallCost(const Function *F, int NumArgs = -1) const override
351 assert(F && "A concrete function must be provided to this routine.");
354 // Set the argument number to the number of explicit arguments in the
356 NumArgs = F->arg_size();
358 if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
359 FunctionType *FTy = F->getFunctionType();
360 SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
361 return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
364 if (!TopTTI->isLoweredToCall(F))
365 return TCC_Basic; // Give a basic cost if it will be lowered directly.
367 return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
370 unsigned getCallCost(const Function *F,
371 ArrayRef<const Value *> Arguments) const override {
372 // Simply delegate to generic handling of the call.
373 // FIXME: We should use instsimplify or something else to catch calls which
374 // will constant fold with these arguments.
375 return TopTTI->getCallCost(F, Arguments.size());
378 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
379 ArrayRef<Type *> ParamTys) const override {
382 // Intrinsics rarely (if ever) have normal argument setup constraints.
383 // Model them as having a basic instruction cost.
384 // FIXME: This is wrong for libc intrinsics.
387 case Intrinsic::dbg_declare:
388 case Intrinsic::dbg_value:
389 case Intrinsic::invariant_start:
390 case Intrinsic::invariant_end:
391 case Intrinsic::lifetime_start:
392 case Intrinsic::lifetime_end:
393 case Intrinsic::objectsize:
394 case Intrinsic::ptr_annotation:
395 case Intrinsic::var_annotation:
396 // These intrinsics don't actually represent code after lowering.
402 getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
403 ArrayRef<const Value *> Arguments) const override {
404 // Delegate to the generic intrinsic handling code. This mostly provides an
405 // opportunity for targets to (for example) special case the cost of
406 // certain intrinsics based on constants used as arguments.
407 SmallVector<Type *, 8> ParamTys;
408 ParamTys.reserve(Arguments.size());
409 for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
410 ParamTys.push_back(Arguments[Idx]->getType());
411 return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
414 unsigned getUserCost(const User *U) const override {
416 return TCC_Free; // Model all PHI nodes as free.
418 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U))
419 // In the basic model we just assume that all-constant GEPs will be
420 // folded into their uses via addressing modes.
421 return GEP->hasAllConstantIndices() ? TCC_Free : TCC_Basic;
423 if (ImmutableCallSite CS = U) {
424 const Function *F = CS.getCalledFunction();
426 // Just use the called value type.
427 Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
428 return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
431 SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
432 return TopTTI->getCallCost(F, Arguments);
435 if (const CastInst *CI = dyn_cast<CastInst>(U)) {
436 // Result of a cmp instruction is often extended (to be used by other
437 // cmp instructions, logical or return instructions). These are usually
438 // nop on most sane targets.
439 if (isa<CmpInst>(CI->getOperand(0)))
443 // Otherwise delegate to the fully generic implementations.
444 return getOperationCost(Operator::getOpcode(U), U->getType(),
445 U->getNumOperands() == 1 ?
446 U->getOperand(0)->getType() : 0);
449 bool hasBranchDivergence() const override { return false; }
451 bool isLoweredToCall(const Function *F) const override {
452 // FIXME: These should almost certainly not be handled here, and instead
453 // handled with the help of TLI or the target itself. This was largely
454 // ported from existing analysis heuristics here so that such refactorings
455 // can take place in the future.
457 if (F->isIntrinsic())
460 if (F->hasLocalLinkage() || !F->hasName())
463 StringRef Name = F->getName();
465 // These will all likely lower to a single selection DAG node.
466 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
467 Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
468 Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
469 Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
472 // These are all likely to be optimized into something smaller.
473 if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
474 Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
475 "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
476 Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
482 void getUnrollingPreferences(Loop *, UnrollingPreferences &) const override {
485 bool isLegalAddImmediate(int64_t Imm) const override {
489 bool isLegalICmpImmediate(int64_t Imm) const override {
493 bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
494 bool HasBaseReg, int64_t Scale) const override
496 // Guess that reg+reg addressing is allowed. This heuristic is taken from
497 // the implementation of LSR.
498 return !BaseGV && BaseOffset == 0 && Scale <= 1;
501 int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
502 bool HasBaseReg, int64_t Scale) const override {
503 // Guess that all legal addressing mode are free.
504 if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
509 bool isTruncateFree(Type *Ty1, Type *Ty2) const override {
513 bool isTypeLegal(Type *Ty) const override {
517 unsigned getJumpBufAlignment() const override {
521 unsigned getJumpBufSize() const override {
525 bool shouldBuildLookupTables() const override {
530 getPopcntSupport(unsigned IntTyWidthInBit) const override {
534 bool haveFastSqrt(Type *Ty) const override {
538 unsigned getIntImmCost(const APInt &Imm, Type *Ty) const override {
542 unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
543 Type *Ty) const override {
547 unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm,
548 Type *Ty) const override {
552 unsigned getNumberOfRegisters(bool Vector) const override {
556 unsigned getRegisterBitWidth(bool Vector) const override {
560 unsigned getMaximumUnrollFactor() const override {
564 unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
565 OperandValueKind) const override {
569 unsigned getShuffleCost(ShuffleKind Kind, Type *Ty,
570 int Index = 0, Type *SubTp = 0) const override {
574 unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
575 Type *Src) const override {
579 unsigned getCFInstrCost(unsigned Opcode) const override {
583 unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
584 Type *CondTy = 0) const override {
588 unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
589 unsigned Index = -1) const override {
593 unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
594 unsigned AddressSpace) const override {
598 unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
599 ArrayRef<Type*> Tys) const override {
603 unsigned getNumberOfParts(Type *Tp) const override {
607 unsigned getAddressComputationCost(Type *Tp, bool) const override {
611 unsigned getReductionCost(unsigned, Type *, bool) const override {
616 } // end anonymous namespace
618 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
619 "No target information", true, true, true)
622 ImmutablePass *llvm::createNoTargetTransformInfoPass() {