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::hasBranchDivergence() const {
92 return PrevTTI->hasBranchDivergence();
95 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
96 return PrevTTI->isLoweredToCall(F);
99 bool TargetTransformInfo::getUnrollingPreferences(
100 UnrollingPreferences &UP) const {
101 return PrevTTI->getUnrollingPreferences(UP);
104 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
105 return PrevTTI->isLegalAddImmediate(Imm);
108 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
109 return PrevTTI->isLegalICmpImmediate(Imm);
112 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
115 int64_t Scale) const {
116 return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
120 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
123 int64_t Scale) const {
124 return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
128 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
129 return PrevTTI->isTruncateFree(Ty1, Ty2);
132 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
133 return PrevTTI->isTypeLegal(Ty);
136 unsigned TargetTransformInfo::getJumpBufAlignment() const {
137 return PrevTTI->getJumpBufAlignment();
140 unsigned TargetTransformInfo::getJumpBufSize() const {
141 return PrevTTI->getJumpBufSize();
144 bool TargetTransformInfo::shouldBuildLookupTables() const {
145 return PrevTTI->shouldBuildLookupTables();
148 TargetTransformInfo::PopcntSupportKind
149 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
150 return PrevTTI->getPopcntSupport(IntTyWidthInBit);
153 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
154 return PrevTTI->haveFastSqrt(Ty);
157 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
158 return PrevTTI->getIntImmCost(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);
229 struct NoTTI : ImmutablePass, TargetTransformInfo {
230 const DataLayout *DL;
232 NoTTI() : ImmutablePass(ID), DL(0) {
233 initializeNoTTIPass(*PassRegistry::getPassRegistry());
236 virtual void initializePass() {
237 // Note that this subclass is special, and must *not* call initializeTTI as
238 // it does not chain.
241 DL = getAnalysisIfAvailable<DataLayout>();
244 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
245 // Note that this subclass is special, and must *not* call
246 // TTI::getAnalysisUsage as it breaks the recursion.
249 /// Pass identification.
252 /// Provide necessary pointer adjustments for the two base classes.
253 virtual void *getAdjustedAnalysisPointer(const void *ID) {
254 if (ID == &TargetTransformInfo::ID)
255 return (TargetTransformInfo*)this;
259 unsigned getOperationCost(unsigned Opcode, Type *Ty, Type *OpTy) const {
262 // By default, just classify everything as 'basic'.
265 case Instruction::GetElementPtr:
266 llvm_unreachable("Use getGEPCost for GEP operations!");
268 case Instruction::BitCast:
269 assert(OpTy && "Cast instructions must provide the operand type");
270 if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
271 // Identity and pointer-to-pointer casts are free.
274 // Otherwise, the default basic cost is used.
277 case Instruction::IntToPtr: {
281 // An inttoptr cast is free so long as the input is a legal integer type
282 // which doesn't contain values outside the range of a pointer.
283 unsigned OpSize = OpTy->getScalarSizeInBits();
284 if (DL->isLegalInteger(OpSize) &&
285 OpSize <= DL->getPointerTypeSizeInBits(Ty))
288 // Otherwise it's not a no-op.
291 case Instruction::PtrToInt: {
295 // A ptrtoint cast is free so long as the result is large enough to store
296 // the pointer, and a legal integer type.
297 unsigned DestSize = Ty->getScalarSizeInBits();
298 if (DL->isLegalInteger(DestSize) &&
299 DestSize >= DL->getPointerTypeSizeInBits(OpTy))
302 // Otherwise it's not a no-op.
305 case Instruction::Trunc:
306 // trunc to a native type is free (assuming the target has compare and
307 // shift-right of the same width).
308 if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
315 unsigned getGEPCost(const Value *Ptr,
316 ArrayRef<const Value *> Operands) const {
317 // In the basic model, we just assume that all-constant GEPs will be folded
318 // into their uses via addressing modes.
319 for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
320 if (!isa<Constant>(Operands[Idx]))
326 unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const {
327 assert(FTy && "FunctionType must be provided to this routine.");
329 // The target-independent implementation just measures the size of the
330 // function by approximating that each argument will take on average one
331 // instruction to prepare.
334 // Set the argument number to the number of explicit arguments in the
336 NumArgs = FTy->getNumParams();
338 return TCC_Basic * (NumArgs + 1);
341 unsigned getCallCost(const Function *F, int NumArgs = -1) const {
342 assert(F && "A concrete function must be provided to this routine.");
345 // Set the argument number to the number of explicit arguments in the
347 NumArgs = F->arg_size();
349 if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
350 FunctionType *FTy = F->getFunctionType();
351 SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
352 return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
355 if (!TopTTI->isLoweredToCall(F))
356 return TCC_Basic; // Give a basic cost if it will be lowered directly.
358 return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
361 unsigned getCallCost(const Function *F,
362 ArrayRef<const Value *> Arguments) const {
363 // Simply delegate to generic handling of the call.
364 // FIXME: We should use instsimplify or something else to catch calls which
365 // will constant fold with these arguments.
366 return TopTTI->getCallCost(F, Arguments.size());
369 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
370 ArrayRef<Type *> ParamTys) const {
373 // Intrinsics rarely (if ever) have normal argument setup constraints.
374 // Model them as having a basic instruction cost.
375 // FIXME: This is wrong for libc intrinsics.
378 case Intrinsic::dbg_declare:
379 case Intrinsic::dbg_value:
380 case Intrinsic::invariant_start:
381 case Intrinsic::invariant_end:
382 case Intrinsic::lifetime_start:
383 case Intrinsic::lifetime_end:
384 case Intrinsic::objectsize:
385 case Intrinsic::ptr_annotation:
386 case Intrinsic::var_annotation:
387 // These intrinsics don't actually represent code after lowering.
392 unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
393 ArrayRef<const Value *> Arguments) const {
394 // Delegate to the generic intrinsic handling code. This mostly provides an
395 // opportunity for targets to (for example) special case the cost of
396 // certain intrinsics based on constants used as arguments.
397 SmallVector<Type *, 8> ParamTys;
398 ParamTys.reserve(Arguments.size());
399 for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
400 ParamTys.push_back(Arguments[Idx]->getType());
401 return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
404 unsigned getUserCost(const User *U) const {
406 return TCC_Free; // Model all PHI nodes as free.
408 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U))
409 // In the basic model we just assume that all-constant GEPs will be
410 // folded into their uses via addressing modes.
411 return GEP->hasAllConstantIndices() ? TCC_Free : TCC_Basic;
413 if (ImmutableCallSite CS = U) {
414 const Function *F = CS.getCalledFunction();
416 // Just use the called value type.
417 Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
418 return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
421 SmallVector<const Value *, 8> Arguments;
422 for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(),
425 Arguments.push_back(*AI);
427 return TopTTI->getCallCost(F, Arguments);
430 if (const CastInst *CI = dyn_cast<CastInst>(U)) {
431 // Result of a cmp instruction is often extended (to be used by other
432 // cmp instructions, logical or return instructions). These are usually
433 // nop on most sane targets.
434 if (isa<CmpInst>(CI->getOperand(0)))
438 // Otherwise delegate to the fully generic implementations.
439 return getOperationCost(Operator::getOpcode(U), U->getType(),
440 U->getNumOperands() == 1 ?
441 U->getOperand(0)->getType() : 0);
444 bool hasBranchDivergence() const { return false; }
446 bool isLoweredToCall(const Function *F) const {
447 // FIXME: These should almost certainly not be handled here, and instead
448 // handled with the help of TLI or the target itself. This was largely
449 // ported from existing analysis heuristics here so that such refactorings
450 // can take place in the future.
452 if (F->isIntrinsic())
455 if (F->hasLocalLinkage() || !F->hasName())
458 StringRef Name = F->getName();
460 // These will all likely lower to a single selection DAG node.
461 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
462 Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
463 Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
464 Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
467 // These are all likely to be optimized into something smaller.
468 if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
469 Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
470 "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
471 Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
477 virtual bool getUnrollingPreferences(UnrollingPreferences &) const {
481 bool isLegalAddImmediate(int64_t Imm) const {
485 bool isLegalICmpImmediate(int64_t Imm) const {
489 bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
490 bool HasBaseReg, int64_t Scale) const {
491 // Guess that reg+reg addressing is allowed. This heuristic is taken from
492 // the implementation of LSR.
493 return !BaseGV && BaseOffset == 0 && Scale <= 1;
496 int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
497 bool HasBaseReg, int64_t Scale) const {
498 // Guess that all legal addressing mode are free.
499 if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
505 bool isTruncateFree(Type *Ty1, Type *Ty2) const {
509 bool isTypeLegal(Type *Ty) const {
513 unsigned getJumpBufAlignment() const {
517 unsigned getJumpBufSize() const {
521 bool shouldBuildLookupTables() const {
525 PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) const {
529 bool haveFastSqrt(Type *Ty) const {
533 unsigned getIntImmCost(const APInt &Imm, Type *Ty) const {
537 unsigned getNumberOfRegisters(bool Vector) const {
541 unsigned getRegisterBitWidth(bool Vector) const {
545 unsigned getMaximumUnrollFactor() const {
549 unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
550 OperandValueKind) const {
554 unsigned getShuffleCost(ShuffleKind Kind, Type *Tp,
555 int Index = 0, Type *SubTp = 0) const {
559 unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
564 unsigned getCFInstrCost(unsigned Opcode) const {
568 unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
569 Type *CondTy = 0) const {
573 unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
574 unsigned Index = -1) const {
578 unsigned getMemoryOpCost(unsigned Opcode, Type *Src,
580 unsigned AddressSpace) const {
584 unsigned getIntrinsicInstrCost(Intrinsic::ID ID,
586 ArrayRef<Type*> Tys) const {
590 unsigned getNumberOfParts(Type *Tp) const {
594 unsigned getAddressComputationCost(Type *Tp, bool) const {
599 } // end anonymous namespace
601 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
602 "No target information", true, true, true)
605 ImmutablePass *llvm::createNoTargetTransformInfoPass() {