89713cef993fa31f1092a03f47438e70605025a5
[oota-llvm.git] / lib / Analysis / TargetTransformInfo.cpp
1 //===- llvm/Analysis/TargetTransformInfo.cpp ------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
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"
18
19 using namespace llvm;
20
21 #define DEBUG_TYPE "tti"
22
23 // Setup the analysis group to manage the TargetTransformInfo passes.
24 INITIALIZE_ANALYSIS_GROUP(TargetTransformInfo, "Target Information", NoTTI)
25 char TargetTransformInfo::ID = 0;
26
27 TargetTransformInfo::~TargetTransformInfo() {
28 }
29
30 void TargetTransformInfo::pushTTIStack(Pass *P) {
31   TopTTI = this;
32   PrevTTI = &P->getAnalysis<TargetTransformInfo>();
33
34   // Walk up the chain and update the top TTI pointer.
35   for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
36     PTTI->TopTTI = this;
37 }
38
39 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
40   AU.addRequired<TargetTransformInfo>();
41 }
42
43 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
44                                                Type *OpTy) const {
45   return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
46 }
47
48 unsigned TargetTransformInfo::getGEPCost(
49     const Value *Ptr, ArrayRef<const Value *> Operands) const {
50   return PrevTTI->getGEPCost(Ptr, Operands);
51 }
52
53 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
54                                           int NumArgs) const {
55   return PrevTTI->getCallCost(FTy, NumArgs);
56 }
57
58 unsigned TargetTransformInfo::getCallCost(const Function *F,
59                                           int NumArgs) const {
60   return PrevTTI->getCallCost(F, NumArgs);
61 }
62
63 unsigned TargetTransformInfo::getCallCost(
64     const Function *F, ArrayRef<const Value *> Arguments) const {
65   return PrevTTI->getCallCost(F, Arguments);
66 }
67
68 unsigned TargetTransformInfo::getIntrinsicCost(
69     Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
70   return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
71 }
72
73 unsigned TargetTransformInfo::getIntrinsicCost(
74     Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
75   return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
76 }
77
78 unsigned TargetTransformInfo::getUserCost(const User *U) const {
79   return PrevTTI->getUserCost(U);
80 }
81
82 bool TargetTransformInfo::hasBranchDivergence() const {
83   return PrevTTI->hasBranchDivergence();
84 }
85
86 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
87   return PrevTTI->isLoweredToCall(F);
88 }
89
90 void TargetTransformInfo::getUnrollingPreferences(Loop *L,
91                             UnrollingPreferences &UP) const {
92   PrevTTI->getUnrollingPreferences(L, UP);
93 }
94
95 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
96   return PrevTTI->isLegalAddImmediate(Imm);
97 }
98
99 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
100   return PrevTTI->isLegalICmpImmediate(Imm);
101 }
102
103 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
104                                                 int64_t BaseOffset,
105                                                 bool HasBaseReg,
106                                                 int64_t Scale) const {
107   return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
108                                         Scale);
109 }
110
111 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
112                                               int64_t BaseOffset,
113                                               bool HasBaseReg,
114                                               int64_t Scale) const {
115   return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
116                                        Scale);
117 }
118
119 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
120   return PrevTTI->isTruncateFree(Ty1, Ty2);
121 }
122
123 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
124   return PrevTTI->isTypeLegal(Ty);
125 }
126
127 unsigned TargetTransformInfo::getJumpBufAlignment() const {
128   return PrevTTI->getJumpBufAlignment();
129 }
130
131 unsigned TargetTransformInfo::getJumpBufSize() const {
132   return PrevTTI->getJumpBufSize();
133 }
134
135 bool TargetTransformInfo::shouldBuildLookupTables() const {
136   return PrevTTI->shouldBuildLookupTables();
137 }
138
139 TargetTransformInfo::PopcntSupportKind
140 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
141   return PrevTTI->getPopcntSupport(IntTyWidthInBit);
142 }
143
144 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
145   return PrevTTI->haveFastSqrt(Ty);
146 }
147
148 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
149   return PrevTTI->getIntImmCost(Imm, Ty);
150 }
151
152 unsigned TargetTransformInfo::getIntImmCost(unsigned Opc, unsigned Idx,
153                                             const APInt &Imm, Type *Ty) const {
154   return PrevTTI->getIntImmCost(Opc, Idx, Imm, Ty);
155 }
156
157 unsigned TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
158                                             const APInt &Imm, Type *Ty) const {
159   return PrevTTI->getIntImmCost(IID, Idx, Imm, Ty);
160 }
161
162 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
163   return PrevTTI->getNumberOfRegisters(Vector);
164 }
165
166 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
167   return PrevTTI->getRegisterBitWidth(Vector);
168 }
169
170 unsigned TargetTransformInfo::getMaxInterleaveFactor() const {
171   return PrevTTI->getMaxInterleaveFactor();
172 }
173
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);
180 }
181
182 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
183                                              int Index, Type *SubTp) const {
184   return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
185 }
186
187 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
188                                                Type *Src) const {
189   return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
190 }
191
192 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
193   return PrevTTI->getCFInstrCost(Opcode);
194 }
195
196 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
197                                                  Type *CondTy) const {
198   return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
199 }
200
201 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
202                                                  unsigned Index) const {
203   return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
204 }
205
206 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
207                                               unsigned Alignment,
208                                               unsigned AddressSpace) const {
209   return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
210   ;
211 }
212
213 unsigned
214 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
215                                            Type *RetTy,
216                                            ArrayRef<Type *> Tys) const {
217   return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
218 }
219
220 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
221   return PrevTTI->getNumberOfParts(Tp);
222 }
223
224 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp,
225                                                         bool IsComplex) const {
226   return PrevTTI->getAddressComputationCost(Tp, IsComplex);
227 }
228
229 unsigned TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
230                                                bool IsPairwise) const {
231   return PrevTTI->getReductionCost(Opcode, Ty, IsPairwise);
232 }
233
234 unsigned TargetTransformInfo::getCostOfKeepingLiveOverCall(ArrayRef<Type*> Tys)
235   const {
236   return PrevTTI->getCostOfKeepingLiveOverCall(Tys);
237 }
238
239 namespace {
240
241 struct NoTTI final : ImmutablePass, TargetTransformInfo {
242   const DataLayout *DL;
243
244   NoTTI() : ImmutablePass(ID), DL(nullptr) {
245     initializeNoTTIPass(*PassRegistry::getPassRegistry());
246   }
247
248   void initializePass() override {
249     // Note that this subclass is special, and must *not* call initializeTTI as
250     // it does not chain.
251     TopTTI = this;
252     PrevTTI = nullptr;
253     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
254     DL = DLP ? &DLP->getDataLayout() : nullptr;
255   }
256
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.
260   }
261
262   /// Pass identification.
263   static char ID;
264
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;
269     return this;
270   }
271
272   unsigned getOperationCost(unsigned Opcode, Type *Ty,
273                             Type *OpTy) const override {
274     switch (Opcode) {
275     default:
276       // By default, just classify everything as 'basic'.
277       return TCC_Basic;
278
279     case Instruction::GetElementPtr:
280       llvm_unreachable("Use getGEPCost for GEP operations!");
281
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.
286         return TCC_Free;
287
288       // Otherwise, the default basic cost is used.
289       return TCC_Basic;
290
291     case Instruction::IntToPtr: {
292       if (!DL)
293         return TCC_Basic;
294
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))
300         return TCC_Free;
301
302       // Otherwise it's not a no-op.
303       return TCC_Basic;
304     }
305     case Instruction::PtrToInt: {
306       if (!DL)
307         return TCC_Basic;
308
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))
314         return TCC_Free;
315
316       // Otherwise it's not a no-op.
317       return TCC_Basic;
318     }
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)))
323         return TCC_Free;
324
325       return TCC_Basic;
326     }
327   }
328
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]))
335         return TCC_Basic;
336
337     return TCC_Free;
338   }
339
340   unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const override
341   {
342     assert(FTy && "FunctionType must be provided to this routine.");
343
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.
347
348     if (NumArgs < 0)
349       // Set the argument number to the number of explicit arguments in the
350       // function.
351       NumArgs = FTy->getNumParams();
352
353     return TCC_Basic * (NumArgs + 1);
354   }
355
356   unsigned getCallCost(const Function *F, int NumArgs = -1) const override
357   {
358     assert(F && "A concrete function must be provided to this routine.");
359
360     if (NumArgs < 0)
361       // Set the argument number to the number of explicit arguments in the
362       // function.
363       NumArgs = F->arg_size();
364
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);
369     }
370
371     if (!TopTTI->isLoweredToCall(F))
372       return TCC_Basic; // Give a basic cost if it will be lowered directly.
373
374     return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
375   }
376
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());
383   }
384
385   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
386                             ArrayRef<Type *> ParamTys) const override {
387     switch (IID) {
388     default:
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.
392       return TCC_Basic;
393
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.
405       return TCC_Free;
406     }
407   }
408
409   unsigned
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);
420   }
421
422   unsigned getUserCost(const User *U) const override {
423     if (isa<PHINode>(U))
424       return TCC_Free; // Model all PHI nodes as free.
425
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);
429     }
430
431     if (ImmutableCallSite CS = U) {
432       const Function *F = CS.getCalledFunction();
433       if (!F) {
434         // Just use the called value type.
435         Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
436         return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
437       }
438
439       SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
440       return TopTTI->getCallCost(F, Arguments);
441     }
442
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)))
448         return TCC_Free;
449     }
450
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);
455   }
456
457   bool hasBranchDivergence() const override { return false; }
458
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.
464
465     if (F->isIntrinsic())
466       return false;
467
468     if (F->hasLocalLinkage() || !F->hasName())
469       return true;
470
471     StringRef Name = F->getName();
472
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")
478       return false;
479
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")
485       return false;
486
487     return true;
488   }
489
490   void getUnrollingPreferences(Loop *, UnrollingPreferences &) const override {
491   }
492
493   bool isLegalAddImmediate(int64_t Imm) const override {
494     return false;
495   }
496
497   bool isLegalICmpImmediate(int64_t Imm) const override {
498     return false;
499   }
500
501   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
502                              bool HasBaseReg, int64_t Scale) const override
503   {
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;
507   }
508
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))
513       return 0;
514     return -1;
515   }
516
517   bool isTruncateFree(Type *Ty1, Type *Ty2) const override {
518     return false;
519   }
520
521   bool isTypeLegal(Type *Ty) const override {
522     return false;
523   }
524
525   unsigned getJumpBufAlignment() const override {
526     return 0;
527   }
528
529   unsigned getJumpBufSize() const override {
530     return 0;
531   }
532
533   bool shouldBuildLookupTables() const override {
534     return true;
535   }
536
537   PopcntSupportKind
538   getPopcntSupport(unsigned IntTyWidthInBit) const override {
539     return PSK_Software;
540   }
541
542   bool haveFastSqrt(Type *Ty) const override {
543     return false;
544   }
545
546   unsigned getIntImmCost(const APInt &Imm, Type *Ty) const override {
547     return TCC_Basic;
548   }
549
550   unsigned getIntImmCost(unsigned Opcode, unsigned Idx, const APInt &Imm,
551                          Type *Ty) const override {
552     return TCC_Free;
553   }
554
555   unsigned getIntImmCost(Intrinsic::ID IID, unsigned Idx, const APInt &Imm,
556                          Type *Ty) const override {
557     return TCC_Free;
558   }
559
560   unsigned getNumberOfRegisters(bool Vector) const override {
561     return 8;
562   }
563
564   unsigned  getRegisterBitWidth(bool Vector) const override {
565     return 32;
566   }
567
568   unsigned getMaxInterleaveFactor() const override {
569     return 1;
570   }
571
572   unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
573                                   OperandValueKind, OperandValueProperties,
574                                   OperandValueProperties) const override {
575     return 1;
576   }
577
578   unsigned getShuffleCost(ShuffleKind Kind, Type *Ty,
579                           int Index = 0, Type *SubTp = nullptr) const override {
580     return 1;
581   }
582
583   unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
584                             Type *Src) const override {
585     return 1;
586   }
587
588   unsigned getCFInstrCost(unsigned Opcode) const override {
589     return 1;
590   }
591
592   unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
593                               Type *CondTy = nullptr) const override {
594     return 1;
595   }
596
597   unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
598                               unsigned Index = -1) const override {
599     return 1;
600   }
601
602   unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
603                            unsigned AddressSpace) const override {
604     return 1;
605   }
606
607   unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
608                                  ArrayRef<Type*> Tys) const override {
609     return 1;
610   }
611
612   unsigned getNumberOfParts(Type *Tp) const override {
613     return 0;
614   }
615
616   unsigned getAddressComputationCost(Type *Tp, bool) const override {
617     return 0;
618   }
619
620   unsigned getReductionCost(unsigned, Type *, bool) const override {
621     return 1;
622   }
623
624   unsigned getCostOfKeepingLiveOverCall(ArrayRef<Type*> Tys) const override {
625     return 0;
626   }
627
628 };
629
630 } // end anonymous namespace
631
632 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
633                    "No target information", true, true, true)
634 char NoTTI::ID = 0;
635
636 ImmutablePass *llvm::createNoTargetTransformInfoPass() {
637   return new NoTTI();
638 }