[ValueTracking] Extend r251146 to catch a fairly common case
[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/Analysis/TargetTransformInfoImpl.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/Module.h"
18 #include "llvm/IR/Operator.h"
19 #include "llvm/Support/ErrorHandling.h"
20
21 using namespace llvm;
22
23 #define DEBUG_TYPE "tti"
24
25 namespace {
26 /// \brief No-op implementation of the TTI interface using the utility base
27 /// classes.
28 ///
29 /// This is used when no target specific information is available.
30 struct NoTTIImpl : TargetTransformInfoImplCRTPBase<NoTTIImpl> {
31   explicit NoTTIImpl(const DataLayout &DL)
32       : TargetTransformInfoImplCRTPBase<NoTTIImpl>(DL) {}
33 };
34 }
35
36 TargetTransformInfo::TargetTransformInfo(const DataLayout &DL)
37     : TTIImpl(new Model<NoTTIImpl>(NoTTIImpl(DL))) {}
38
39 TargetTransformInfo::~TargetTransformInfo() {}
40
41 TargetTransformInfo::TargetTransformInfo(TargetTransformInfo &&Arg)
42     : TTIImpl(std::move(Arg.TTIImpl)) {}
43
44 TargetTransformInfo &TargetTransformInfo::operator=(TargetTransformInfo &&RHS) {
45   TTIImpl = std::move(RHS.TTIImpl);
46   return *this;
47 }
48
49 int TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
50                                           Type *OpTy) const {
51   int Cost = TTIImpl->getOperationCost(Opcode, Ty, OpTy);
52   assert(Cost >= 0 && "TTI should not produce negative costs!");
53   return Cost;
54 }
55
56 int TargetTransformInfo::getCallCost(FunctionType *FTy, int NumArgs) const {
57   int Cost = TTIImpl->getCallCost(FTy, NumArgs);
58   assert(Cost >= 0 && "TTI should not produce negative costs!");
59   return Cost;
60 }
61
62 int TargetTransformInfo::getCallCost(const Function *F,
63                                      ArrayRef<const Value *> Arguments) const {
64   int Cost = TTIImpl->getCallCost(F, Arguments);
65   assert(Cost >= 0 && "TTI should not produce negative costs!");
66   return Cost;
67 }
68
69 int TargetTransformInfo::getIntrinsicCost(
70     Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
71   int Cost = TTIImpl->getIntrinsicCost(IID, RetTy, Arguments);
72   assert(Cost >= 0 && "TTI should not produce negative costs!");
73   return Cost;
74 }
75
76 int TargetTransformInfo::getUserCost(const User *U) const {
77   int Cost = TTIImpl->getUserCost(U);
78   assert(Cost >= 0 && "TTI should not produce negative costs!");
79   return Cost;
80 }
81
82 bool TargetTransformInfo::hasBranchDivergence() const {
83   return TTIImpl->hasBranchDivergence();
84 }
85
86 bool TargetTransformInfo::isSourceOfDivergence(const Value *V) const {
87   return TTIImpl->isSourceOfDivergence(V);
88 }
89
90 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
91   return TTIImpl->isLoweredToCall(F);
92 }
93
94 void TargetTransformInfo::getUnrollingPreferences(
95     Loop *L, UnrollingPreferences &UP) const {
96   return TTIImpl->getUnrollingPreferences(L, UP);
97 }
98
99 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
100   return TTIImpl->isLegalAddImmediate(Imm);
101 }
102
103 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
104   return TTIImpl->isLegalICmpImmediate(Imm);
105 }
106
107 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
108                                                 int64_t BaseOffset,
109                                                 bool HasBaseReg,
110                                                 int64_t Scale,
111                                                 unsigned AddrSpace) const {
112   return TTIImpl->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
113                                         Scale, AddrSpace);
114 }
115
116 bool TargetTransformInfo::isLegalMaskedStore(Type *DataType) const {
117   return TTIImpl->isLegalMaskedStore(DataType);
118 }
119
120 bool TargetTransformInfo::isLegalMaskedLoad(Type *DataType) const {
121   return TTIImpl->isLegalMaskedLoad(DataType);
122 }
123
124 bool TargetTransformInfo::isLegalMaskedGather(Type *DataType) const {
125   return TTIImpl->isLegalMaskedGather(DataType);
126 }
127
128 bool TargetTransformInfo::isLegalMaskedScatter(Type *DataType) const {
129   return TTIImpl->isLegalMaskedGather(DataType);
130 }
131
132 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
133                                               int64_t BaseOffset,
134                                               bool HasBaseReg,
135                                               int64_t Scale,
136                                               unsigned AddrSpace) const {
137   int Cost = TTIImpl->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
138                                            Scale, AddrSpace);
139   assert(Cost >= 0 && "TTI should not produce negative costs!");
140   return Cost;
141 }
142
143 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
144   return TTIImpl->isTruncateFree(Ty1, Ty2);
145 }
146
147 bool TargetTransformInfo::isZExtFree(Type *Ty1, Type *Ty2) const {
148   return TTIImpl->isZExtFree(Ty1, Ty2);
149 }
150
151 bool TargetTransformInfo::isProfitableToHoist(Instruction *I) const {
152   return TTIImpl->isProfitableToHoist(I);
153 }
154
155 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
156   return TTIImpl->isTypeLegal(Ty);
157 }
158
159 unsigned TargetTransformInfo::getJumpBufAlignment() const {
160   return TTIImpl->getJumpBufAlignment();
161 }
162
163 unsigned TargetTransformInfo::getJumpBufSize() const {
164   return TTIImpl->getJumpBufSize();
165 }
166
167 bool TargetTransformInfo::shouldBuildLookupTables() const {
168   return TTIImpl->shouldBuildLookupTables();
169 }
170
171 bool TargetTransformInfo::enableAggressiveInterleaving(bool LoopHasReductions) const {
172   return TTIImpl->enableAggressiveInterleaving(LoopHasReductions);
173 }
174
175 bool TargetTransformInfo::enableInterleavedAccessVectorization() const {
176   return TTIImpl->enableInterleavedAccessVectorization();
177 }
178
179 TargetTransformInfo::PopcntSupportKind
180 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
181   return TTIImpl->getPopcntSupport(IntTyWidthInBit);
182 }
183
184 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
185   return TTIImpl->haveFastSqrt(Ty);
186 }
187
188 int TargetTransformInfo::getFPOpCost(Type *Ty) const {
189   int Cost = TTIImpl->getFPOpCost(Ty);
190   assert(Cost >= 0 && "TTI should not produce negative costs!");
191   return Cost;
192 }
193
194 int TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
195   int Cost = TTIImpl->getIntImmCost(Imm, Ty);
196   assert(Cost >= 0 && "TTI should not produce negative costs!");
197   return Cost;
198 }
199
200 int TargetTransformInfo::getIntImmCost(unsigned Opcode, unsigned Idx,
201                                        const APInt &Imm, Type *Ty) const {
202   int Cost = TTIImpl->getIntImmCost(Opcode, Idx, Imm, Ty);
203   assert(Cost >= 0 && "TTI should not produce negative costs!");
204   return Cost;
205 }
206
207 int TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
208                                        const APInt &Imm, Type *Ty) const {
209   int Cost = TTIImpl->getIntImmCost(IID, Idx, Imm, Ty);
210   assert(Cost >= 0 && "TTI should not produce negative costs!");
211   return Cost;
212 }
213
214 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
215   return TTIImpl->getNumberOfRegisters(Vector);
216 }
217
218 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
219   return TTIImpl->getRegisterBitWidth(Vector);
220 }
221
222 unsigned TargetTransformInfo::getMaxInterleaveFactor(unsigned VF) const {
223   return TTIImpl->getMaxInterleaveFactor(VF);
224 }
225
226 int TargetTransformInfo::getArithmeticInstrCost(
227     unsigned Opcode, Type *Ty, OperandValueKind Opd1Info,
228     OperandValueKind Opd2Info, OperandValueProperties Opd1PropInfo,
229     OperandValueProperties Opd2PropInfo) const {
230   int Cost = TTIImpl->getArithmeticInstrCost(Opcode, Ty, Opd1Info, Opd2Info,
231                                              Opd1PropInfo, Opd2PropInfo);
232   assert(Cost >= 0 && "TTI should not produce negative costs!");
233   return Cost;
234 }
235
236 int TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Ty, int Index,
237                                         Type *SubTp) const {
238   int Cost = TTIImpl->getShuffleCost(Kind, Ty, Index, SubTp);
239   assert(Cost >= 0 && "TTI should not produce negative costs!");
240   return Cost;
241 }
242
243 int TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
244                                           Type *Src) const {
245   int Cost = TTIImpl->getCastInstrCost(Opcode, Dst, Src);
246   assert(Cost >= 0 && "TTI should not produce negative costs!");
247   return Cost;
248 }
249
250 int TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
251   int Cost = TTIImpl->getCFInstrCost(Opcode);
252   assert(Cost >= 0 && "TTI should not produce negative costs!");
253   return Cost;
254 }
255
256 int TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
257                                             Type *CondTy) const {
258   int Cost = TTIImpl->getCmpSelInstrCost(Opcode, ValTy, CondTy);
259   assert(Cost >= 0 && "TTI should not produce negative costs!");
260   return Cost;
261 }
262
263 int TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
264                                             unsigned Index) const {
265   int Cost = TTIImpl->getVectorInstrCost(Opcode, Val, Index);
266   assert(Cost >= 0 && "TTI should not produce negative costs!");
267   return Cost;
268 }
269
270 int TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
271                                          unsigned Alignment,
272                                          unsigned AddressSpace) const {
273   int Cost = TTIImpl->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
274   assert(Cost >= 0 && "TTI should not produce negative costs!");
275   return Cost;
276 }
277
278 int TargetTransformInfo::getMaskedMemoryOpCost(unsigned Opcode, Type *Src,
279                                                unsigned Alignment,
280                                                unsigned AddressSpace) const {
281   int Cost =
282       TTIImpl->getMaskedMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
283   assert(Cost >= 0 && "TTI should not produce negative costs!");
284   return Cost;
285 }
286
287 int TargetTransformInfo::getInterleavedMemoryOpCost(
288     unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
289     unsigned Alignment, unsigned AddressSpace) const {
290   int Cost = TTIImpl->getInterleavedMemoryOpCost(Opcode, VecTy, Factor, Indices,
291                                                  Alignment, AddressSpace);
292   assert(Cost >= 0 && "TTI should not produce negative costs!");
293   return Cost;
294 }
295
296 int TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
297                                                ArrayRef<Type *> Tys) const {
298   int Cost = TTIImpl->getIntrinsicInstrCost(ID, RetTy, Tys);
299   assert(Cost >= 0 && "TTI should not produce negative costs!");
300   return Cost;
301 }
302
303 int TargetTransformInfo::getCallInstrCost(Function *F, Type *RetTy,
304                                           ArrayRef<Type *> Tys) const {
305   int Cost = TTIImpl->getCallInstrCost(F, RetTy, Tys);
306   assert(Cost >= 0 && "TTI should not produce negative costs!");
307   return Cost;
308 }
309
310 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
311   return TTIImpl->getNumberOfParts(Tp);
312 }
313
314 int TargetTransformInfo::getAddressComputationCost(Type *Tp,
315                                                    bool IsComplex) const {
316   int Cost = TTIImpl->getAddressComputationCost(Tp, IsComplex);
317   assert(Cost >= 0 && "TTI should not produce negative costs!");
318   return Cost;
319 }
320
321 int TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
322                                           bool IsPairwiseForm) const {
323   int Cost = TTIImpl->getReductionCost(Opcode, Ty, IsPairwiseForm);
324   assert(Cost >= 0 && "TTI should not produce negative costs!");
325   return Cost;
326 }
327
328 unsigned
329 TargetTransformInfo::getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) const {
330   return TTIImpl->getCostOfKeepingLiveOverCall(Tys);
331 }
332
333 bool TargetTransformInfo::getTgtMemIntrinsic(IntrinsicInst *Inst,
334                                              MemIntrinsicInfo &Info) const {
335   return TTIImpl->getTgtMemIntrinsic(Inst, Info);
336 }
337
338 Value *TargetTransformInfo::getOrCreateResultFromMemIntrinsic(
339     IntrinsicInst *Inst, Type *ExpectedType) const {
340   return TTIImpl->getOrCreateResultFromMemIntrinsic(Inst, ExpectedType);
341 }
342
343 bool TargetTransformInfo::areInlineCompatible(const Function *Caller,
344                                               const Function *Callee) const {
345   return TTIImpl->areInlineCompatible(Caller, Callee);
346 }
347
348 TargetTransformInfo::Concept::~Concept() {}
349
350 TargetIRAnalysis::TargetIRAnalysis() : TTICallback(&getDefaultTTI) {}
351
352 TargetIRAnalysis::TargetIRAnalysis(
353     std::function<Result(const Function &)> TTICallback)
354     : TTICallback(TTICallback) {}
355
356 TargetIRAnalysis::Result TargetIRAnalysis::run(const Function &F) {
357   return TTICallback(F);
358 }
359
360 char TargetIRAnalysis::PassID;
361
362 TargetIRAnalysis::Result TargetIRAnalysis::getDefaultTTI(const Function &F) {
363   return Result(F.getParent()->getDataLayout());
364 }
365
366 // Register the basic pass.
367 INITIALIZE_PASS(TargetTransformInfoWrapperPass, "tti",
368                 "Target Transform Information", false, true)
369 char TargetTransformInfoWrapperPass::ID = 0;
370
371 void TargetTransformInfoWrapperPass::anchor() {}
372
373 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass()
374     : ImmutablePass(ID) {
375   initializeTargetTransformInfoWrapperPassPass(
376       *PassRegistry::getPassRegistry());
377 }
378
379 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass(
380     TargetIRAnalysis TIRA)
381     : ImmutablePass(ID), TIRA(std::move(TIRA)) {
382   initializeTargetTransformInfoWrapperPassPass(
383       *PassRegistry::getPassRegistry());
384 }
385
386 TargetTransformInfo &TargetTransformInfoWrapperPass::getTTI(const Function &F) {
387   TTI = TIRA.run(F);
388   return *TTI;
389 }
390
391 ImmutablePass *
392 llvm::createTargetTransformInfoWrapperPass(TargetIRAnalysis TIRA) {
393   return new TargetTransformInfoWrapperPass(std::move(TIRA));
394 }