[Modules] Move CallSite into the IR library where it belogs. It is
[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 #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"
19
20 using namespace llvm;
21
22 // Setup the analysis group to manage the TargetTransformInfo passes.
23 INITIALIZE_ANALYSIS_GROUP(TargetTransformInfo, "Target Information", NoTTI)
24 char TargetTransformInfo::ID = 0;
25
26 TargetTransformInfo::~TargetTransformInfo() {
27 }
28
29 void TargetTransformInfo::pushTTIStack(Pass *P) {
30   TopTTI = this;
31   PrevTTI = &P->getAnalysis<TargetTransformInfo>();
32
33   // Walk up the chain and update the top TTI pointer.
34   for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
35     PTTI->TopTTI = this;
36 }
37
38 void TargetTransformInfo::popTTIStack() {
39   TopTTI = 0;
40
41   // Walk up the chain and update the top TTI pointer.
42   for (TargetTransformInfo *PTTI = PrevTTI; PTTI; PTTI = PTTI->PrevTTI)
43     PTTI->TopTTI = PrevTTI;
44
45   PrevTTI = 0;
46 }
47
48 void TargetTransformInfo::getAnalysisUsage(AnalysisUsage &AU) const {
49   AU.addRequired<TargetTransformInfo>();
50 }
51
52 unsigned TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
53                                                Type *OpTy) const {
54   return PrevTTI->getOperationCost(Opcode, Ty, OpTy);
55 }
56
57 unsigned TargetTransformInfo::getGEPCost(
58     const Value *Ptr, ArrayRef<const Value *> Operands) const {
59   return PrevTTI->getGEPCost(Ptr, Operands);
60 }
61
62 unsigned TargetTransformInfo::getCallCost(FunctionType *FTy,
63                                           int NumArgs) const {
64   return PrevTTI->getCallCost(FTy, NumArgs);
65 }
66
67 unsigned TargetTransformInfo::getCallCost(const Function *F,
68                                           int NumArgs) const {
69   return PrevTTI->getCallCost(F, NumArgs);
70 }
71
72 unsigned TargetTransformInfo::getCallCost(
73     const Function *F, ArrayRef<const Value *> Arguments) const {
74   return PrevTTI->getCallCost(F, Arguments);
75 }
76
77 unsigned TargetTransformInfo::getIntrinsicCost(
78     Intrinsic::ID IID, Type *RetTy, ArrayRef<Type *> ParamTys) const {
79   return PrevTTI->getIntrinsicCost(IID, RetTy, ParamTys);
80 }
81
82 unsigned TargetTransformInfo::getIntrinsicCost(
83     Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
84   return PrevTTI->getIntrinsicCost(IID, RetTy, Arguments);
85 }
86
87 unsigned TargetTransformInfo::getUserCost(const User *U) const {
88   return PrevTTI->getUserCost(U);
89 }
90
91 bool TargetTransformInfo::hasBranchDivergence() const {
92   return PrevTTI->hasBranchDivergence();
93 }
94
95 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
96   return PrevTTI->isLoweredToCall(F);
97 }
98
99 void TargetTransformInfo::getUnrollingPreferences(Loop *L,
100                             UnrollingPreferences &UP) const {
101   PrevTTI->getUnrollingPreferences(L, UP);
102 }
103
104 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
105   return PrevTTI->isLegalAddImmediate(Imm);
106 }
107
108 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
109   return PrevTTI->isLegalICmpImmediate(Imm);
110 }
111
112 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
113                                                 int64_t BaseOffset,
114                                                 bool HasBaseReg,
115                                                 int64_t Scale) const {
116   return PrevTTI->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
117                                         Scale);
118 }
119
120 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
121                                               int64_t BaseOffset,
122                                               bool HasBaseReg,
123                                               int64_t Scale) const {
124   return PrevTTI->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
125                                        Scale);
126 }
127
128 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
129   return PrevTTI->isTruncateFree(Ty1, Ty2);
130 }
131
132 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
133   return PrevTTI->isTypeLegal(Ty);
134 }
135
136 unsigned TargetTransformInfo::getJumpBufAlignment() const {
137   return PrevTTI->getJumpBufAlignment();
138 }
139
140 unsigned TargetTransformInfo::getJumpBufSize() const {
141   return PrevTTI->getJumpBufSize();
142 }
143
144 bool TargetTransformInfo::shouldBuildLookupTables() const {
145   return PrevTTI->shouldBuildLookupTables();
146 }
147
148 TargetTransformInfo::PopcntSupportKind
149 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
150   return PrevTTI->getPopcntSupport(IntTyWidthInBit);
151 }
152
153 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
154   return PrevTTI->haveFastSqrt(Ty);
155 }
156
157 unsigned TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
158   return PrevTTI->getIntImmCost(Imm, Ty);
159 }
160
161 unsigned TargetTransformInfo::getIntImmCost(unsigned Opcode, const APInt &Imm,
162                                             Type *Ty) const {
163   return PrevTTI->getIntImmCost(Opcode, Imm, Ty);
164 }
165
166 unsigned TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, const APInt &Imm,
167                                             Type *Ty) const {
168   return PrevTTI->getIntImmCost(IID, Imm, Ty);
169 }
170
171 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
172   return PrevTTI->getNumberOfRegisters(Vector);
173 }
174
175 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
176   return PrevTTI->getRegisterBitWidth(Vector);
177 }
178
179 unsigned TargetTransformInfo::getMaximumUnrollFactor() const {
180   return PrevTTI->getMaximumUnrollFactor();
181 }
182
183 unsigned TargetTransformInfo::getArithmeticInstrCost(unsigned Opcode,
184                                                 Type *Ty,
185                                                 OperandValueKind Op1Info,
186                                                 OperandValueKind Op2Info) const {
187   return PrevTTI->getArithmeticInstrCost(Opcode, Ty, Op1Info, Op2Info);
188 }
189
190 unsigned TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Tp,
191                                              int Index, Type *SubTp) const {
192   return PrevTTI->getShuffleCost(Kind, Tp, Index, SubTp);
193 }
194
195 unsigned TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
196                                                Type *Src) const {
197   return PrevTTI->getCastInstrCost(Opcode, Dst, Src);
198 }
199
200 unsigned TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
201   return PrevTTI->getCFInstrCost(Opcode);
202 }
203
204 unsigned TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
205                                                  Type *CondTy) const {
206   return PrevTTI->getCmpSelInstrCost(Opcode, ValTy, CondTy);
207 }
208
209 unsigned TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
210                                                  unsigned Index) const {
211   return PrevTTI->getVectorInstrCost(Opcode, Val, Index);
212 }
213
214 unsigned TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
215                                               unsigned Alignment,
216                                               unsigned AddressSpace) const {
217   return PrevTTI->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
218   ;
219 }
220
221 unsigned
222 TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID,
223                                            Type *RetTy,
224                                            ArrayRef<Type *> Tys) const {
225   return PrevTTI->getIntrinsicInstrCost(ID, RetTy, Tys);
226 }
227
228 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
229   return PrevTTI->getNumberOfParts(Tp);
230 }
231
232 unsigned TargetTransformInfo::getAddressComputationCost(Type *Tp,
233                                                         bool IsComplex) const {
234   return PrevTTI->getAddressComputationCost(Tp, IsComplex);
235 }
236
237 unsigned TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
238                                                bool IsPairwise) const {
239   return PrevTTI->getReductionCost(Opcode, Ty, IsPairwise);
240 }
241
242 namespace {
243
244 struct NoTTI final : ImmutablePass, TargetTransformInfo {
245   const DataLayout *DL;
246
247   NoTTI() : ImmutablePass(ID), DL(0) {
248     initializeNoTTIPass(*PassRegistry::getPassRegistry());
249   }
250
251   virtual void initializePass() override {
252     // Note that this subclass is special, and must *not* call initializeTTI as
253     // it does not chain.
254     TopTTI = this;
255     PrevTTI = 0;
256     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
257     DL = DLP ? &DLP->getDataLayout() : 0;
258   }
259
260   virtual void getAnalysisUsage(AnalysisUsage &AU) const override {
261     // Note that this subclass is special, and must *not* call
262     // TTI::getAnalysisUsage as it breaks the recursion.
263   }
264
265   /// Pass identification.
266   static char ID;
267
268   /// Provide necessary pointer adjustments for the two base classes.
269   virtual void *getAdjustedAnalysisPointer(const void *ID) override {
270     if (ID == &TargetTransformInfo::ID)
271       return (TargetTransformInfo*)this;
272     return this;
273   }
274
275   unsigned getOperationCost(unsigned Opcode, Type *Ty,
276                             Type *OpTy) const override {
277     switch (Opcode) {
278     default:
279       // By default, just classify everything as 'basic'.
280       return TCC_Basic;
281
282     case Instruction::GetElementPtr:
283       llvm_unreachable("Use getGEPCost for GEP operations!");
284
285     case Instruction::BitCast:
286       assert(OpTy && "Cast instructions must provide the operand type");
287       if (Ty == OpTy || (Ty->isPointerTy() && OpTy->isPointerTy()))
288         // Identity and pointer-to-pointer casts are free.
289         return TCC_Free;
290
291       // Otherwise, the default basic cost is used.
292       return TCC_Basic;
293
294     case Instruction::IntToPtr: {
295       if (!DL)
296         return TCC_Basic;
297
298       // An inttoptr cast is free so long as the input is a legal integer type
299       // which doesn't contain values outside the range of a pointer.
300       unsigned OpSize = OpTy->getScalarSizeInBits();
301       if (DL->isLegalInteger(OpSize) &&
302           OpSize <= DL->getPointerTypeSizeInBits(Ty))
303         return TCC_Free;
304
305       // Otherwise it's not a no-op.
306       return TCC_Basic;
307     }
308     case Instruction::PtrToInt: {
309       if (!DL)
310         return TCC_Basic;
311
312       // A ptrtoint cast is free so long as the result is large enough to store
313       // the pointer, and a legal integer type.
314       unsigned DestSize = Ty->getScalarSizeInBits();
315       if (DL->isLegalInteger(DestSize) &&
316           DestSize >= DL->getPointerTypeSizeInBits(OpTy))
317         return TCC_Free;
318
319       // Otherwise it's not a no-op.
320       return TCC_Basic;
321     }
322     case Instruction::Trunc:
323       // trunc to a native type is free (assuming the target has compare and
324       // shift-right of the same width).
325       if (DL && DL->isLegalInteger(DL->getTypeSizeInBits(Ty)))
326         return TCC_Free;
327
328       return TCC_Basic;
329     }
330   }
331
332   unsigned getGEPCost(const Value *Ptr,
333                       ArrayRef<const Value *> Operands) const override {
334     // In the basic model, we just assume that all-constant GEPs will be folded
335     // into their uses via addressing modes.
336     for (unsigned Idx = 0, Size = Operands.size(); Idx != Size; ++Idx)
337       if (!isa<Constant>(Operands[Idx]))
338         return TCC_Basic;
339
340     return TCC_Free;
341   }
342
343   unsigned getCallCost(FunctionType *FTy, int NumArgs = -1) const override
344   {
345     assert(FTy && "FunctionType must be provided to this routine.");
346
347     // The target-independent implementation just measures the size of the
348     // function by approximating that each argument will take on average one
349     // instruction to prepare.
350
351     if (NumArgs < 0)
352       // Set the argument number to the number of explicit arguments in the
353       // function.
354       NumArgs = FTy->getNumParams();
355
356     return TCC_Basic * (NumArgs + 1);
357   }
358
359   unsigned getCallCost(const Function *F, int NumArgs = -1) const override
360   {
361     assert(F && "A concrete function must be provided to this routine.");
362
363     if (NumArgs < 0)
364       // Set the argument number to the number of explicit arguments in the
365       // function.
366       NumArgs = F->arg_size();
367
368     if (Intrinsic::ID IID = (Intrinsic::ID)F->getIntrinsicID()) {
369       FunctionType *FTy = F->getFunctionType();
370       SmallVector<Type *, 8> ParamTys(FTy->param_begin(), FTy->param_end());
371       return TopTTI->getIntrinsicCost(IID, FTy->getReturnType(), ParamTys);
372     }
373
374     if (!TopTTI->isLoweredToCall(F))
375       return TCC_Basic; // Give a basic cost if it will be lowered directly.
376
377     return TopTTI->getCallCost(F->getFunctionType(), NumArgs);
378   }
379
380   unsigned getCallCost(const Function *F,
381                        ArrayRef<const Value *> Arguments) const override {
382     // Simply delegate to generic handling of the call.
383     // FIXME: We should use instsimplify or something else to catch calls which
384     // will constant fold with these arguments.
385     return TopTTI->getCallCost(F, Arguments.size());
386   }
387
388   unsigned getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
389                             ArrayRef<Type *> ParamTys) const override {
390     switch (IID) {
391     default:
392       // Intrinsics rarely (if ever) have normal argument setup constraints.
393       // Model them as having a basic instruction cost.
394       // FIXME: This is wrong for libc intrinsics.
395       return TCC_Basic;
396
397     case Intrinsic::dbg_declare:
398     case Intrinsic::dbg_value:
399     case Intrinsic::invariant_start:
400     case Intrinsic::invariant_end:
401     case Intrinsic::lifetime_start:
402     case Intrinsic::lifetime_end:
403     case Intrinsic::objectsize:
404     case Intrinsic::ptr_annotation:
405     case Intrinsic::var_annotation:
406       // These intrinsics don't actually represent code after lowering.
407       return TCC_Free;
408     }
409   }
410
411   unsigned
412   getIntrinsicCost(Intrinsic::ID IID, Type *RetTy,
413                    ArrayRef<const Value *> Arguments) const override {
414     // Delegate to the generic intrinsic handling code. This mostly provides an
415     // opportunity for targets to (for example) special case the cost of
416     // certain intrinsics based on constants used as arguments.
417     SmallVector<Type *, 8> ParamTys;
418     ParamTys.reserve(Arguments.size());
419     for (unsigned Idx = 0, Size = Arguments.size(); Idx != Size; ++Idx)
420       ParamTys.push_back(Arguments[Idx]->getType());
421     return TopTTI->getIntrinsicCost(IID, RetTy, ParamTys);
422   }
423
424   unsigned getUserCost(const User *U) const override {
425     if (isa<PHINode>(U))
426       return TCC_Free; // Model all PHI nodes as free.
427
428     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U))
429       // In the basic model we just assume that all-constant GEPs will be
430       // folded into their uses via addressing modes.
431       return GEP->hasAllConstantIndices() ? TCC_Free : TCC_Basic;
432
433     if (ImmutableCallSite CS = U) {
434       const Function *F = CS.getCalledFunction();
435       if (!F) {
436         // Just use the called value type.
437         Type *FTy = CS.getCalledValue()->getType()->getPointerElementType();
438         return TopTTI->getCallCost(cast<FunctionType>(FTy), CS.arg_size());
439       }
440
441       SmallVector<const Value *, 8> Arguments(CS.arg_begin(), CS.arg_end());
442       return TopTTI->getCallCost(F, Arguments);
443     }
444
445     if (const CastInst *CI = dyn_cast<CastInst>(U)) {
446       // Result of a cmp instruction is often extended (to be used by other
447       // cmp instructions, logical or return instructions). These are usually
448       // nop on most sane targets.
449       if (isa<CmpInst>(CI->getOperand(0)))
450         return TCC_Free;
451     }
452
453     // Otherwise delegate to the fully generic implementations.
454     return getOperationCost(Operator::getOpcode(U), U->getType(),
455                             U->getNumOperands() == 1 ?
456                                 U->getOperand(0)->getType() : 0);
457   }
458
459   bool hasBranchDivergence() const override { return false; }
460
461   bool isLoweredToCall(const Function *F) const override {
462     // FIXME: These should almost certainly not be handled here, and instead
463     // handled with the help of TLI or the target itself. This was largely
464     // ported from existing analysis heuristics here so that such refactorings
465     // can take place in the future.
466
467     if (F->isIntrinsic())
468       return false;
469
470     if (F->hasLocalLinkage() || !F->hasName())
471       return true;
472
473     StringRef Name = F->getName();
474
475     // These will all likely lower to a single selection DAG node.
476     if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
477         Name == "fabs" || Name == "fabsf" || Name == "fabsl" || Name == "sin" ||
478         Name == "sinf" || Name == "sinl" || Name == "cos" || Name == "cosf" ||
479         Name == "cosl" || Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl")
480       return false;
481
482     // These are all likely to be optimized into something smaller.
483     if (Name == "pow" || Name == "powf" || Name == "powl" || Name == "exp2" ||
484         Name == "exp2l" || Name == "exp2f" || Name == "floor" || Name ==
485         "floorf" || Name == "ceil" || Name == "round" || Name == "ffs" ||
486         Name == "ffsl" || Name == "abs" || Name == "labs" || Name == "llabs")
487       return false;
488
489     return true;
490   }
491
492   void getUnrollingPreferences(Loop *, UnrollingPreferences &) const override {
493   }
494
495   bool isLegalAddImmediate(int64_t Imm) const override {
496     return false;
497   }
498
499   bool isLegalICmpImmediate(int64_t Imm) const override {
500     return false;
501   }
502
503   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
504                              bool HasBaseReg, int64_t Scale) const override
505   {
506     // Guess that reg+reg addressing is allowed. This heuristic is taken from
507     // the implementation of LSR.
508     return !BaseGV && BaseOffset == 0 && Scale <= 1;
509   }
510
511   int getScalingFactorCost(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
512                            bool HasBaseReg, int64_t Scale) const override {
513     // Guess that all legal addressing mode are free.
514     if(isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale))
515       return 0;
516     return -1;
517   }
518
519   bool isTruncateFree(Type *Ty1, Type *Ty2) const override {
520     return false;
521   }
522
523   bool isTypeLegal(Type *Ty) const override {
524     return false;
525   }
526
527   unsigned getJumpBufAlignment() const override {
528     return 0;
529   }
530
531   unsigned getJumpBufSize() const override {
532     return 0;
533   }
534
535   bool shouldBuildLookupTables() const override {
536     return true;
537   }
538
539   PopcntSupportKind
540   getPopcntSupport(unsigned IntTyWidthInBit) const override {
541     return PSK_Software;
542   }
543
544   bool haveFastSqrt(Type *Ty) const override {
545     return false;
546   }
547
548   unsigned getIntImmCost(const APInt &Imm, Type *Ty) const override {
549     return TCC_Basic;
550   }
551
552   unsigned getIntImmCost(unsigned Opcode, const APInt &Imm,
553                          Type *Ty) const override {
554     return TCC_Free;
555   }
556
557   unsigned getIntImmCost(Intrinsic::ID IID, const APInt &Imm,
558                          Type *Ty) const override {
559     return TCC_Free;
560   }
561
562   unsigned getNumberOfRegisters(bool Vector) const override {
563     return 8;
564   }
565
566   unsigned  getRegisterBitWidth(bool Vector) const override {
567     return 32;
568   }
569
570   unsigned getMaximumUnrollFactor() const override {
571     return 1;
572   }
573
574   unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty, OperandValueKind,
575                                   OperandValueKind) const override {
576     return 1;
577   }
578
579   unsigned getShuffleCost(ShuffleKind Kind, Type *Ty,
580                           int Index = 0, Type *SubTp = 0) const override {
581     return 1;
582   }
583
584   unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
585                             Type *Src) const override {
586     return 1;
587   }
588
589   unsigned getCFInstrCost(unsigned Opcode) const override {
590     return 1;
591   }
592
593   unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
594                               Type *CondTy = 0) const override {
595     return 1;
596   }
597
598   unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
599                               unsigned Index = -1) const override {
600     return 1;
601   }
602
603   unsigned getMemoryOpCost(unsigned Opcode, Type *Src, unsigned Alignment,
604                            unsigned AddressSpace) const override {
605     return 1;
606   }
607
608   unsigned getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
609                                  ArrayRef<Type*> Tys) const override {
610     return 1;
611   }
612
613   unsigned getNumberOfParts(Type *Tp) const override {
614     return 0;
615   }
616
617   unsigned getAddressComputationCost(Type *Tp, bool) const override {
618     return 0;
619   }
620
621   unsigned getReductionCost(unsigned, Type *, bool) const override {
622     return 1;
623   }
624 };
625
626 } // end anonymous namespace
627
628 INITIALIZE_AG_PASS(NoTTI, TargetTransformInfo, "notti",
629                    "No target information", true, true, true)
630 char NoTTI::ID = 0;
631
632 ImmutablePass *llvm::createNoTargetTransformInfoPass() {
633   return new NoTTI();
634 }