[PM/AA] Clean up and homogenize comments throughout basic-aa.
[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,
117                                              int Consecutive) const {
118   return TTIImpl->isLegalMaskedStore(DataType, Consecutive);
119 }
120
121 bool TargetTransformInfo::isLegalMaskedLoad(Type *DataType,
122                                             int Consecutive) const {
123   return TTIImpl->isLegalMaskedLoad(DataType, Consecutive);
124 }
125
126 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
127                                               int64_t BaseOffset,
128                                               bool HasBaseReg,
129                                               int64_t Scale,
130                                               unsigned AddrSpace) const {
131   int Cost = TTIImpl->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
132                                            Scale, AddrSpace);
133   assert(Cost >= 0 && "TTI should not produce negative costs!");
134   return Cost;
135 }
136
137 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
138   return TTIImpl->isTruncateFree(Ty1, Ty2);
139 }
140
141 bool TargetTransformInfo::isZExtFree(Type *Ty1, Type *Ty2) const {
142   return TTIImpl->isZExtFree(Ty1, Ty2);
143 }
144
145 bool TargetTransformInfo::isProfitableToHoist(Instruction *I) const {
146   return TTIImpl->isProfitableToHoist(I);
147 }
148
149 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
150   return TTIImpl->isTypeLegal(Ty);
151 }
152
153 unsigned TargetTransformInfo::getJumpBufAlignment() const {
154   return TTIImpl->getJumpBufAlignment();
155 }
156
157 unsigned TargetTransformInfo::getJumpBufSize() const {
158   return TTIImpl->getJumpBufSize();
159 }
160
161 bool TargetTransformInfo::shouldBuildLookupTables() const {
162   return TTIImpl->shouldBuildLookupTables();
163 }
164
165 bool TargetTransformInfo::enableAggressiveInterleaving(bool LoopHasReductions) const {
166   return TTIImpl->enableAggressiveInterleaving(LoopHasReductions);
167 }
168
169 TargetTransformInfo::PopcntSupportKind
170 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
171   return TTIImpl->getPopcntSupport(IntTyWidthInBit);
172 }
173
174 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
175   return TTIImpl->haveFastSqrt(Ty);
176 }
177
178 int TargetTransformInfo::getFPOpCost(Type *Ty) const {
179   int Cost = TTIImpl->getFPOpCost(Ty);
180   assert(Cost >= 0 && "TTI should not produce negative costs!");
181   return Cost;
182 }
183
184 int TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
185   int Cost = TTIImpl->getIntImmCost(Imm, Ty);
186   assert(Cost >= 0 && "TTI should not produce negative costs!");
187   return Cost;
188 }
189
190 int TargetTransformInfo::getIntImmCost(unsigned Opcode, unsigned Idx,
191                                        const APInt &Imm, Type *Ty) const {
192   int Cost = TTIImpl->getIntImmCost(Opcode, Idx, Imm, Ty);
193   assert(Cost >= 0 && "TTI should not produce negative costs!");
194   return Cost;
195 }
196
197 int TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
198                                        const APInt &Imm, Type *Ty) const {
199   int Cost = TTIImpl->getIntImmCost(IID, Idx, Imm, Ty);
200   assert(Cost >= 0 && "TTI should not produce negative costs!");
201   return Cost;
202 }
203
204 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
205   return TTIImpl->getNumberOfRegisters(Vector);
206 }
207
208 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
209   return TTIImpl->getRegisterBitWidth(Vector);
210 }
211
212 unsigned TargetTransformInfo::getMaxInterleaveFactor(unsigned VF) const {
213   return TTIImpl->getMaxInterleaveFactor(VF);
214 }
215
216 int TargetTransformInfo::getArithmeticInstrCost(
217     unsigned Opcode, Type *Ty, OperandValueKind Opd1Info,
218     OperandValueKind Opd2Info, OperandValueProperties Opd1PropInfo,
219     OperandValueProperties Opd2PropInfo) const {
220   int Cost = TTIImpl->getArithmeticInstrCost(Opcode, Ty, Opd1Info, Opd2Info,
221                                              Opd1PropInfo, Opd2PropInfo);
222   assert(Cost >= 0 && "TTI should not produce negative costs!");
223   return Cost;
224 }
225
226 int TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Ty, int Index,
227                                         Type *SubTp) const {
228   int Cost = TTIImpl->getShuffleCost(Kind, Ty, Index, SubTp);
229   assert(Cost >= 0 && "TTI should not produce negative costs!");
230   return Cost;
231 }
232
233 int TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
234                                           Type *Src) const {
235   int Cost = TTIImpl->getCastInstrCost(Opcode, Dst, Src);
236   assert(Cost >= 0 && "TTI should not produce negative costs!");
237   return Cost;
238 }
239
240 int TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
241   int Cost = TTIImpl->getCFInstrCost(Opcode);
242   assert(Cost >= 0 && "TTI should not produce negative costs!");
243   return Cost;
244 }
245
246 int TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
247                                             Type *CondTy) const {
248   int Cost = TTIImpl->getCmpSelInstrCost(Opcode, ValTy, CondTy);
249   assert(Cost >= 0 && "TTI should not produce negative costs!");
250   return Cost;
251 }
252
253 int TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
254                                             unsigned Index) const {
255   int Cost = TTIImpl->getVectorInstrCost(Opcode, Val, Index);
256   assert(Cost >= 0 && "TTI should not produce negative costs!");
257   return Cost;
258 }
259
260 int TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
261                                          unsigned Alignment,
262                                          unsigned AddressSpace) const {
263   int Cost = TTIImpl->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
264   assert(Cost >= 0 && "TTI should not produce negative costs!");
265   return Cost;
266 }
267
268 int TargetTransformInfo::getMaskedMemoryOpCost(unsigned Opcode, Type *Src,
269                                                unsigned Alignment,
270                                                unsigned AddressSpace) const {
271   int Cost =
272       TTIImpl->getMaskedMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
273   assert(Cost >= 0 && "TTI should not produce negative costs!");
274   return Cost;
275 }
276
277 int TargetTransformInfo::getInterleavedMemoryOpCost(
278     unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
279     unsigned Alignment, unsigned AddressSpace) const {
280   int Cost = TTIImpl->getInterleavedMemoryOpCost(Opcode, VecTy, Factor, Indices,
281                                                  Alignment, AddressSpace);
282   assert(Cost >= 0 && "TTI should not produce negative costs!");
283   return Cost;
284 }
285
286 int TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
287                                                ArrayRef<Type *> Tys) const {
288   int Cost = TTIImpl->getIntrinsicInstrCost(ID, RetTy, Tys);
289   assert(Cost >= 0 && "TTI should not produce negative costs!");
290   return Cost;
291 }
292
293 int TargetTransformInfo::getCallInstrCost(Function *F, Type *RetTy,
294                                           ArrayRef<Type *> Tys) const {
295   int Cost = TTIImpl->getCallInstrCost(F, RetTy, Tys);
296   assert(Cost >= 0 && "TTI should not produce negative costs!");
297   return Cost;
298 }
299
300 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
301   return TTIImpl->getNumberOfParts(Tp);
302 }
303
304 int TargetTransformInfo::getAddressComputationCost(Type *Tp,
305                                                    bool IsComplex) const {
306   int Cost = TTIImpl->getAddressComputationCost(Tp, IsComplex);
307   assert(Cost >= 0 && "TTI should not produce negative costs!");
308   return Cost;
309 }
310
311 int TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
312                                           bool IsPairwiseForm) const {
313   int Cost = TTIImpl->getReductionCost(Opcode, Ty, IsPairwiseForm);
314   assert(Cost >= 0 && "TTI should not produce negative costs!");
315   return Cost;
316 }
317
318 unsigned
319 TargetTransformInfo::getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) const {
320   return TTIImpl->getCostOfKeepingLiveOverCall(Tys);
321 }
322
323 bool TargetTransformInfo::getTgtMemIntrinsic(IntrinsicInst *Inst,
324                                              MemIntrinsicInfo &Info) const {
325   return TTIImpl->getTgtMemIntrinsic(Inst, Info);
326 }
327
328 Value *TargetTransformInfo::getOrCreateResultFromMemIntrinsic(
329     IntrinsicInst *Inst, Type *ExpectedType) const {
330   return TTIImpl->getOrCreateResultFromMemIntrinsic(Inst, ExpectedType);
331 }
332
333 bool TargetTransformInfo::areInlineCompatible(const Function *Caller,
334                                               const Function *Callee) const {
335   return TTIImpl->areInlineCompatible(Caller, Callee);
336 }
337
338 TargetTransformInfo::Concept::~Concept() {}
339
340 TargetIRAnalysis::TargetIRAnalysis() : TTICallback(&getDefaultTTI) {}
341
342 TargetIRAnalysis::TargetIRAnalysis(
343     std::function<Result(Function &)> TTICallback)
344     : TTICallback(TTICallback) {}
345
346 TargetIRAnalysis::Result TargetIRAnalysis::run(Function &F) {
347   return TTICallback(F);
348 }
349
350 char TargetIRAnalysis::PassID;
351
352 TargetIRAnalysis::Result TargetIRAnalysis::getDefaultTTI(Function &F) {
353   return Result(F.getParent()->getDataLayout());
354 }
355
356 // Register the basic pass.
357 INITIALIZE_PASS(TargetTransformInfoWrapperPass, "tti",
358                 "Target Transform Information", false, true)
359 char TargetTransformInfoWrapperPass::ID = 0;
360
361 void TargetTransformInfoWrapperPass::anchor() {}
362
363 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass()
364     : ImmutablePass(ID) {
365   initializeTargetTransformInfoWrapperPassPass(
366       *PassRegistry::getPassRegistry());
367 }
368
369 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass(
370     TargetIRAnalysis TIRA)
371     : ImmutablePass(ID), TIRA(std::move(TIRA)) {
372   initializeTargetTransformInfoWrapperPassPass(
373       *PassRegistry::getPassRegistry());
374 }
375
376 TargetTransformInfo &TargetTransformInfoWrapperPass::getTTI(Function &F) {
377   TTI = TIRA.run(F);
378   return *TTI;
379 }
380
381 ImmutablePass *
382 llvm::createTargetTransformInfoWrapperPass(TargetIRAnalysis TIRA) {
383   return new TargetTransformInfoWrapperPass(std::move(TIRA));
384 }