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/DataLayout.h"
13 #include "llvm/IR/Operator.h"
14 #include "llvm/IR/Instruction.h"
15 #include "llvm/IR/IntrinsicInst.h"
16 #include "llvm/IR/Instructions.h"
17 #include "llvm/Support/CallSite.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::popTTIStack() {
41 // Walk up the chain and update the top TTI pointer.
42 for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
43 PTTI->TopTTI = PrevTTI;
48 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
49 AU.addRequired<TargetTransformInfo>();
52 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
54 return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
57 unsigned TargetTransformInfo::getGEPCost(
58 const Value *Ptr, ArrayRef<const Value *> Operands) const {
59 return PrevTTI->getGEPCost(Ptr, Operands);
62 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
64 return PrevTTI->getCallCost(FTy, NumArgs);
67 unsigned TargetTransformInfo::getCallCost(const Function *F,
69 return PrevTTI->getCallCost(F, NumArgs);
72 unsigned TargetTransformInfo::getCallCost(
73 const Function *F, ArrayRef<const Value *> Arguments) const {
74 return PrevTTI->getCallCost(F, Arguments);
77 unsigned TargetTransformInfo::getIntrinsicCost(
78 Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
79 return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
82 unsigned TargetTransformInfo::getIntrinsicCost(
83 Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
84 return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
87 unsigned TargetTransformInfo::getUserCost(const User *U) const {
88 return PrevTTI->getUserCost(U);
91 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
92 return PrevTTI->isLoweredToCall(F);
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 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
145 return PrevTTI->getIntImmCost(Imm, Ty);
148 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
149 return PrevTTI->getNumberOfRegisters(Vector);
152 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
153 return PrevTTI->getRegisterBitWidth(Vector);
156 unsigned TargetTransformInfo::getMaximumUnrollFactor() const {
157 return PrevTTI->getMaximumUnrollFactor();
160 unsigned TargetTransformInfo::getArithmeticInstrCost(unsigned Opcode,
162 OperandValueKind Op1Info,
163 OperandValueKind Op2Info) const {
164 return PrevTTI->getArithmeticInstrCost(Opcode, Ty, Op1Info, Op2Info);
167 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
168 int Index, Type *SubTp) const {
169 return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
172 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
174 return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
177 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
178 return PrevTTI->getCFInstrCost(Opcode);
181 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
182 Type *CondTy) const {
183 return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
186 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
187 unsigned Index) const {
188 return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
191 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
193 unsigned AddressSpace) const {
194 return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
199 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
201 ArrayRef<Type *> Tys) const {
202 return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
205 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
206 return PrevTTI->getNumberOfParts(Tp);
209 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp) const {
210 return PrevTTI->getAddressComputationCost(Tp);
215 struct NoTTI : ImmutablePass, TargetTransformInfo {
216 const DataLayout *DL;
218 NoTTI() : ImmutablePass(ID), DL(0) {
219 initializeNoTTIPass(*PassRegistry::getPassRegistry());
222 virtual void initializePass() {
223 // Note that this subclass is special, and must *not* call initializeTTI as
224 // it does not chain.
227 DL = getAnalysisIfAvailable<DataLayout>();
230 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
231 // Note that this subclass is special, and must *not* call
232 // TTI::getAnalysisUsage as it breaks the recursion.
235 /// Pass identification.
238 /// Provide necessary pointer adjustments for the two base classes.
239 virtual void *getAdjustedAnalysisPointer(const void *ID) {
240 if (ID == &TargetTransformInfo::ID)
241 return (TargetTransformInfo*)this;
245 unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy) const {
248 // By default, just classify everything as 'basic'.
251 case Instruction::GetElementPtr:
252 llvm_unreachable("Use getGEPCost for GEP operations!");
254 case Instruction::BitCast:
255 assert(OpTy && "Cast instructions must provide the operand type");
256 if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
257 // Identity and pointer-to-pointer casts are free.
260 // Otherwise, the default basic cost is used.
263 case Instruction::IntToPtr:
264 // An inttoptr cast is free so long as the input is a legal integer type
265 // which doesn't contain values outside the range of a pointer.
266 if (DL && DL->isLegalInteger(OpTy->getScalarSizeInBits()) &&
267 OpTy->getScalarSizeInBits() <= DL->getPointerSizeInBits())
270 // Otherwise it's not a no-op.
273 case Instruction::PtrToInt:
274 // A ptrtoint cast is free so long as the result is large enough to store
275 // the pointer, and a legal integer type.
276 if (DL && DL->isLegalInteger(Ty->getScalarSizeInBits()) &&
277 Ty->getScalarSizeInBits() >= DL->getPointerSizeInBits())
280 // Otherwise it's not a no-op.
283 case Instruction::Trunc:
284 // trunc to a native type is free (assuming the target has compare and
285 // shift-right of the same width).
286 if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
293 unsigned getGEPCost(const Value *Ptr,
294 ArrayRef<const Value *> Operands) const {
295 // In the basic model, we just assume that all-constant GEPs will be folded
296 // into their uses via addressing modes.
297 for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
298 if (!isa<Constant>(Operands[Idx]))
304 unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const {
305 assert(FTy && "FunctionType must be provided to this routine.");
307 // The target-independent implementation just measures the size of the
308 // function by approximating that each argument will take on average one
309 // instruction to prepare.
312 // Set the argument number to the number of explicit arguments in the
314 NumArgs = FTy->getNumParams();
316 return TCC_Basic * (NumArgs + 1);
319 unsigned getCallCost(const Function *F, int NumArgs = -1) const {
320 assert(F && "A concrete function must be provided to this routine.");
323 // Set the argument number to the number of explicit arguments in the
325 NumArgs = F->arg_size();
327 if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
328 FunctionType *FTy = F->getFunctionType();
329 SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
330 return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
333 if (!TopTTI->isLoweredToCall(F))
334 return TCC_Basic; // Give a basic cost if it will be lowered directly.
336 return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
339 unsigned getCallCost(const Function *F,
340 ArrayRef<const Value *> Arguments) const {
341 // Simply delegate to generic handling of the call.
342 // FIXME: We should use instsimplify or something else to catch calls which
343 // will constant fold with these arguments.
344 return TopTTI->getCallCost(F, Arguments.size());
347 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
348 ArrayRef<Type *> ParamTys) const {
351 // Intrinsics rarely (if ever) have normal argument setup constraints.
352 // Model them as having a basic instruction cost.
353 // FIXME: This is wrong for libc intrinsics.
356 case Intrinsic::dbg_declare:
357 case Intrinsic::dbg_value:
358 case Intrinsic::invariant_start:
359 case Intrinsic::invariant_end:
360 case Intrinsic::lifetime_start:
361 case Intrinsic::lifetime_end:
362 case Intrinsic::objectsize:
363 case Intrinsic::ptr_annotation:
364 case Intrinsic::var_annotation:
365 // These intrinsics don't actually represent code after lowering.
370 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
371 ArrayRef<const Value *> Arguments) const {
372 // Delegate to the generic intrinsic handling code. This mostly provides an
373 // opportunity for targets to (for example) special case the cost of
374 // certain intrinsics based on constants used as arguments.
375 SmallVector<Type *, 8> ParamTys;
376 ParamTys.reserve(Arguments.size());
377 for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
378 ParamTys.push_back(Arguments[Idx]->getType());
379 return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
382 unsigned getUserCost(const User *U) const {
384 return TCC_Free; // Model all PHI nodes as free.
386 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U))
387 // In the basic model we just assume that all-constant GEPs will be
388 // folded into their uses via addressing modes.
389 return GEP->hasAllConstantIndices() ? TCC_Free : TCC_Basic;
391 if (ImmutableCallSite CS = U) {
392 const Function *F = CS.getCalledFunction();
394 // Just use the called value type.
395 Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
396 return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
399 SmallVector<const Value *, 8> Arguments;
400 for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(),
403 Arguments.push_back(*AI);
405 return TopTTI->getCallCost(F, Arguments);
408 if (const CastInst *CI = dyn_cast<CastInst>(U)) {
409 // Result of a cmp instruction is often extended (to be used by other
410 // cmp instructions, logical or return instructions). These are usually
411 // nop on most sane targets.
412 if (isa<CmpInst>(CI->getOperand(0)))
416 // Otherwise delegate to the fully generic implementations.
417 return getOperationCost(Operator::getOpcode(U), U->getType(),
418 U->getNumOperands() == 1 ?
419 U->getOperand(0)->getType() : 0);
422 bool isLoweredToCall(const Function *F) const {
423 // FIXME: These should almost certainly not be handled here, and instead
424 // handled with the help of TLI or the target itself. This was largely
425 // ported from existing analysis heuristics here so that such refactorings
426 // can take place in the future.
428 if (F->isIntrinsic())
431 if (F->hasLocalLinkage() || !F->hasName())
434 StringRef Name = F->getName();
436 // These will all likely lower to a single selection DAG node.
437 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
438 Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
439 Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
440 Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
443 // These are all likely to be optimized into something smaller.
444 if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
445 Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
446 "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
447 Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
453 bool isLegalAddImmediate(int64_t Imm) const {
457 bool isLegalICmpImmediate(int64_t Imm) const {
461 bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
462 bool HasBaseReg, int64_t Scale) const {
463 // Guess that reg+reg addressing is allowed. This heuristic is taken from
464 // the implementation of LSR.
465 return !BaseGV && BaseOffset == 0 && Scale <= 1;
468 int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
469 bool HasBaseReg, int64_t Scale) const {
470 // Guess that all legal addressing mode are free.
471 if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
477 bool isTruncateFree(Type *Ty1, Type *Ty2) const {
481 bool isTypeLegal(Type *Ty) const {
485 unsigned getJumpBufAlignment() const {
489 unsigned getJumpBufSize() const {
493 bool shouldBuildLookupTables() const {
497 PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) const {
501 unsigned getIntImmCost(const APInt &Imm, Type *Ty) const {
505 unsigned getNumberOfRegisters(bool Vector) const {
509 unsigned getRegisterBitWidth(bool Vector) const {
513 unsigned getMaximumUnrollFactor() const {
517 unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
518 OperandValueKind) const {
522 unsigned getShuffleCost(ShuffleKind Kind, Type *Tp,
523 int Index = 0, Type *SubTp = 0) const {
527 unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
532 unsigned getCFInstrCost(unsigned Opcode) const {
536 unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
537 Type *CondTy = 0) const {
541 unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
542 unsigned Index = -1) const {
546 unsigned getMemoryOpCost(unsigned Opcode, Type *Src,
548 unsigned AddressSpace) const {
552 unsigned getIntrinsicInstrCost(Intrinsic::ID ID,
554 ArrayRef<Type*> Tys) const {
558 unsigned getNumberOfParts(Type *Tp) const {
562 unsigned getAddressComputationCost(Type *Tp) const {
567 } // end anonymous namespace
569 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
570 "No target information", true, true, true)
573 ImmutablePass *llvm::createNoTargetTransformInfoPass() {