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 #include <utility>
21 
22 using namespace llvm;
23 
24 #define DEBUG_TYPE "tti"
25 
26 namespace {
27 /// \brief No-op implementation of the TTI interface using the utility base
28 /// classes.
29 ///
30 /// This is used when no target specific information is available.
31 struct NoTTIImpl : TargetTransformInfoImplCRTPBase<NoTTIImpl> {
32   explicit NoTTIImpl(const DataLayout &DL)
33       : TargetTransformInfoImplCRTPBase<NoTTIImpl>(DL) {}
34 };
35 }
36 
37 TargetTransformInfo::TargetTransformInfo(const DataLayout &DL)
38     : TTIImpl(new Model<NoTTIImpl>(NoTTIImpl(DL))) {}
39 
40 TargetTransformInfo::~TargetTransformInfo() {}
41 
42 TargetTransformInfo::TargetTransformInfo(TargetTransformInfo &&Arg)
43     : TTIImpl(std::move(Arg.TTIImpl)) {}
44 
45 TargetTransformInfo &TargetTransformInfo::operator=(TargetTransformInfo &&RHS) {
46   TTIImpl = std::move(RHS.TTIImpl);
47   return *this;
48 }
49 
50 int TargetTransformInfo::getOperationCost(unsigned Opcode, Type *Ty,
51                                           Type *OpTy) const {
52   int Cost = TTIImpl->getOperationCost(Opcode, Ty, OpTy);
53   assert(Cost >= 0 && "TTI should not produce negative costs!");
54   return Cost;
55 }
56 
57 int TargetTransformInfo::getCallCost(FunctionType *FTy, int NumArgs) const {
58   int Cost = TTIImpl->getCallCost(FTy, NumArgs);
59   assert(Cost >= 0 && "TTI should not produce negative costs!");
60   return Cost;
61 }
62 
63 int TargetTransformInfo::getCallCost(const Function *F,
64                                      ArrayRef<const Value *> Arguments) const {
65   int Cost = TTIImpl->getCallCost(F, Arguments);
66   assert(Cost >= 0 && "TTI should not produce negative costs!");
67   return Cost;
68 }
69 
70 unsigned TargetTransformInfo::getInliningThresholdMultiplier() const {
71   return TTIImpl->getInliningThresholdMultiplier();
72 }
73 
74 int TargetTransformInfo::getGEPCost(Type *PointeeType, const Value *Ptr,
75                                     ArrayRef<const Value *> Operands) const {
76   return TTIImpl->getGEPCost(PointeeType, Ptr, Operands);
77 }
78 
79 int TargetTransformInfo::getIntrinsicCost(
80     Intrinsic::ID IID, Type *RetTy, ArrayRef<const Value *> Arguments) const {
81   int Cost = TTIImpl->getIntrinsicCost(IID, RetTy, Arguments);
82   assert(Cost >= 0 && "TTI should not produce negative costs!");
83   return Cost;
84 }
85 
86 int TargetTransformInfo::getUserCost(const User *U) const {
87   int Cost = TTIImpl->getUserCost(U);
88   assert(Cost >= 0 && "TTI should not produce negative costs!");
89   return Cost;
90 }
91 
92 bool TargetTransformInfo::hasBranchDivergence() const {
93   return TTIImpl->hasBranchDivergence();
94 }
95 
96 bool TargetTransformInfo::isSourceOfDivergence(const Value *V) const {
97   return TTIImpl->isSourceOfDivergence(V);
98 }
99 
100 unsigned TargetTransformInfo::getFlatAddressSpace() const {
101   return TTIImpl->getFlatAddressSpace();
102 }
103 
104 bool TargetTransformInfo::isLoweredToCall(const Function *F) const {
105   return TTIImpl->isLoweredToCall(F);
106 }
107 
108 void TargetTransformInfo::getUnrollingPreferences(
109     Loop *L, UnrollingPreferences &UP) const {
110   return TTIImpl->getUnrollingPreferences(L, UP);
111 }
112 
113 bool TargetTransformInfo::isLegalAddImmediate(int64_t Imm) const {
114   return TTIImpl->isLegalAddImmediate(Imm);
115 }
116 
117 bool TargetTransformInfo::isLegalICmpImmediate(int64_t Imm) const {
118   return TTIImpl->isLegalICmpImmediate(Imm);
119 }
120 
121 bool TargetTransformInfo::isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
122                                                 int64_t BaseOffset,
123                                                 bool HasBaseReg,
124                                                 int64_t Scale,
125                                                 unsigned AddrSpace) const {
126   return TTIImpl->isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg,
127                                         Scale, AddrSpace);
128 }
129 
130 bool TargetTransformInfo::isLegalMaskedStore(Type *DataType) const {
131   return TTIImpl->isLegalMaskedStore(DataType);
132 }
133 
134 bool TargetTransformInfo::isLegalMaskedLoad(Type *DataType) const {
135   return TTIImpl->isLegalMaskedLoad(DataType);
136 }
137 
138 bool TargetTransformInfo::isLegalMaskedGather(Type *DataType) const {
139   return TTIImpl->isLegalMaskedGather(DataType);
140 }
141 
142 bool TargetTransformInfo::isLegalMaskedScatter(Type *DataType) const {
143   return TTIImpl->isLegalMaskedGather(DataType);
144 }
145 
146 int TargetTransformInfo::getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
147                                               int64_t BaseOffset,
148                                               bool HasBaseReg,
149                                               int64_t Scale,
150                                               unsigned AddrSpace) const {
151   int Cost = TTIImpl->getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg,
152                                            Scale, AddrSpace);
153   assert(Cost >= 0 && "TTI should not produce negative costs!");
154   return Cost;
155 }
156 
157 bool TargetTransformInfo::isFoldableMemAccessOffset(Instruction *I,
158                                                     int64_t Offset) const {
159   return TTIImpl->isFoldableMemAccessOffset(I, Offset);
160 }
161 
162 bool TargetTransformInfo::isTruncateFree(Type *Ty1, Type *Ty2) const {
163   return TTIImpl->isTruncateFree(Ty1, Ty2);
164 }
165 
166 bool TargetTransformInfo::isProfitableToHoist(Instruction *I) const {
167   return TTIImpl->isProfitableToHoist(I);
168 }
169 
170 bool TargetTransformInfo::isTypeLegal(Type *Ty) const {
171   return TTIImpl->isTypeLegal(Ty);
172 }
173 
174 unsigned TargetTransformInfo::getJumpBufAlignment() const {
175   return TTIImpl->getJumpBufAlignment();
176 }
177 
178 unsigned TargetTransformInfo::getJumpBufSize() const {
179   return TTIImpl->getJumpBufSize();
180 }
181 
182 bool TargetTransformInfo::shouldBuildLookupTables() const {
183   return TTIImpl->shouldBuildLookupTables();
184 }
185 bool TargetTransformInfo::shouldBuildLookupTablesForConstant(Constant *C) const {
186   return TTIImpl->shouldBuildLookupTablesForConstant(C);
187 }
188 
189 unsigned TargetTransformInfo::
190 getScalarizationOverhead(Type *Ty, bool Insert, bool Extract) const {
191   return TTIImpl->getScalarizationOverhead(Ty, Insert, Extract);
192 }
193 
194 unsigned TargetTransformInfo::
195 getOperandsScalarizationOverhead(ArrayRef<const Value *> Args,
196                                  unsigned VF) const {
197   return TTIImpl->getOperandsScalarizationOverhead(Args, VF);
198 }
199 
200 bool TargetTransformInfo::enableAggressiveInterleaving(bool LoopHasReductions) const {
201   return TTIImpl->enableAggressiveInterleaving(LoopHasReductions);
202 }
203 
204 bool TargetTransformInfo::enableInterleavedAccessVectorization() const {
205   return TTIImpl->enableInterleavedAccessVectorization();
206 }
207 
208 bool TargetTransformInfo::isFPVectorizationPotentiallyUnsafe() const {
209   return TTIImpl->isFPVectorizationPotentiallyUnsafe();
210 }
211 
212 bool TargetTransformInfo::allowsMisalignedMemoryAccesses(LLVMContext &Context,
213                                                          unsigned BitWidth,
214                                                          unsigned AddressSpace,
215                                                          unsigned Alignment,
216                                                          bool *Fast) const {
217   return TTIImpl->allowsMisalignedMemoryAccesses(Context, BitWidth, AddressSpace,
218                                                  Alignment, Fast);
219 }
220 
221 TargetTransformInfo::PopcntSupportKind
222 TargetTransformInfo::getPopcntSupport(unsigned IntTyWidthInBit) const {
223   return TTIImpl->getPopcntSupport(IntTyWidthInBit);
224 }
225 
226 bool TargetTransformInfo::haveFastSqrt(Type *Ty) const {
227   return TTIImpl->haveFastSqrt(Ty);
228 }
229 
230 int TargetTransformInfo::getFPOpCost(Type *Ty) const {
231   int Cost = TTIImpl->getFPOpCost(Ty);
232   assert(Cost >= 0 && "TTI should not produce negative costs!");
233   return Cost;
234 }
235 
236 int TargetTransformInfo::getIntImmCodeSizeCost(unsigned Opcode, unsigned Idx,
237                                                const APInt &Imm,
238                                                Type *Ty) const {
239   int Cost = TTIImpl->getIntImmCodeSizeCost(Opcode, Idx, Imm, Ty);
240   assert(Cost >= 0 && "TTI should not produce negative costs!");
241   return Cost;
242 }
243 
244 int TargetTransformInfo::getIntImmCost(const APInt &Imm, Type *Ty) const {
245   int Cost = TTIImpl->getIntImmCost(Imm, Ty);
246   assert(Cost >= 0 && "TTI should not produce negative costs!");
247   return Cost;
248 }
249 
250 int TargetTransformInfo::getIntImmCost(unsigned Opcode, unsigned Idx,
251                                        const APInt &Imm, Type *Ty) const {
252   int Cost = TTIImpl->getIntImmCost(Opcode, Idx, Imm, Ty);
253   assert(Cost >= 0 && "TTI should not produce negative costs!");
254   return Cost;
255 }
256 
257 int TargetTransformInfo::getIntImmCost(Intrinsic::ID IID, unsigned Idx,
258                                        const APInt &Imm, Type *Ty) const {
259   int Cost = TTIImpl->getIntImmCost(IID, Idx, Imm, Ty);
260   assert(Cost >= 0 && "TTI should not produce negative costs!");
261   return Cost;
262 }
263 
264 unsigned TargetTransformInfo::getNumberOfRegisters(bool Vector) const {
265   return TTIImpl->getNumberOfRegisters(Vector);
266 }
267 
268 unsigned TargetTransformInfo::getRegisterBitWidth(bool Vector) const {
269   return TTIImpl->getRegisterBitWidth(Vector);
270 }
271 
272 bool TargetTransformInfo::shouldConsiderAddressTypePromotion(
273     const Instruction &I, bool &AllowPromotionWithoutCommonHeader) const {
274   return TTIImpl->shouldConsiderAddressTypePromotion(
275       I, AllowPromotionWithoutCommonHeader);
276 }
277 
278 unsigned TargetTransformInfo::getCacheLineSize() const {
279   return TTIImpl->getCacheLineSize();
280 }
281 
282 unsigned TargetTransformInfo::getPrefetchDistance() const {
283   return TTIImpl->getPrefetchDistance();
284 }
285 
286 unsigned TargetTransformInfo::getMinPrefetchStride() const {
287   return TTIImpl->getMinPrefetchStride();
288 }
289 
290 unsigned TargetTransformInfo::getMaxPrefetchIterationsAhead() const {
291   return TTIImpl->getMaxPrefetchIterationsAhead();
292 }
293 
294 unsigned TargetTransformInfo::getMaxInterleaveFactor(unsigned VF) const {
295   return TTIImpl->getMaxInterleaveFactor(VF);
296 }
297 
298 int TargetTransformInfo::getArithmeticInstrCost(
299     unsigned Opcode, Type *Ty, OperandValueKind Opd1Info,
300     OperandValueKind Opd2Info, OperandValueProperties Opd1PropInfo,
301     OperandValueProperties Opd2PropInfo,
302     ArrayRef<const Value *> Args) const {
303   int Cost = TTIImpl->getArithmeticInstrCost(Opcode, Ty, Opd1Info, Opd2Info,
304                                              Opd1PropInfo, Opd2PropInfo, Args);
305   assert(Cost >= 0 && "TTI should not produce negative costs!");
306   return Cost;
307 }
308 
309 int TargetTransformInfo::getShuffleCost(ShuffleKind Kind, Type *Ty, int Index,
310                                         Type *SubTp) const {
311   int Cost = TTIImpl->getShuffleCost(Kind, Ty, Index, SubTp);
312   assert(Cost >= 0 && "TTI should not produce negative costs!");
313   return Cost;
314 }
315 
316 int TargetTransformInfo::getCastInstrCost(unsigned Opcode, Type *Dst,
317                                           Type *Src) const {
318   int Cost = TTIImpl->getCastInstrCost(Opcode, Dst, Src);
319   assert(Cost >= 0 && "TTI should not produce negative costs!");
320   return Cost;
321 }
322 
323 int TargetTransformInfo::getExtractWithExtendCost(unsigned Opcode, Type *Dst,
324                                                   VectorType *VecTy,
325                                                   unsigned Index) const {
326   int Cost = TTIImpl->getExtractWithExtendCost(Opcode, Dst, VecTy, Index);
327   assert(Cost >= 0 && "TTI should not produce negative costs!");
328   return Cost;
329 }
330 
331 int TargetTransformInfo::getCFInstrCost(unsigned Opcode) const {
332   int Cost = TTIImpl->getCFInstrCost(Opcode);
333   assert(Cost >= 0 && "TTI should not produce negative costs!");
334   return Cost;
335 }
336 
337 int TargetTransformInfo::getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
338                                             Type *CondTy) const {
339   int Cost = TTIImpl->getCmpSelInstrCost(Opcode, ValTy, CondTy);
340   assert(Cost >= 0 && "TTI should not produce negative costs!");
341   return Cost;
342 }
343 
344 int TargetTransformInfo::getVectorInstrCost(unsigned Opcode, Type *Val,
345                                             unsigned Index) const {
346   int Cost = TTIImpl->getVectorInstrCost(Opcode, Val, Index);
347   assert(Cost >= 0 && "TTI should not produce negative costs!");
348   return Cost;
349 }
350 
351 int TargetTransformInfo::getMemoryOpCost(unsigned Opcode, Type *Src,
352                                          unsigned Alignment,
353                                          unsigned AddressSpace) const {
354   int Cost = TTIImpl->getMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
355   assert(Cost >= 0 && "TTI should not produce negative costs!");
356   return Cost;
357 }
358 
359 int TargetTransformInfo::getMaskedMemoryOpCost(unsigned Opcode, Type *Src,
360                                                unsigned Alignment,
361                                                unsigned AddressSpace) const {
362   int Cost =
363       TTIImpl->getMaskedMemoryOpCost(Opcode, Src, Alignment, AddressSpace);
364   assert(Cost >= 0 && "TTI should not produce negative costs!");
365   return Cost;
366 }
367 
368 int TargetTransformInfo::getGatherScatterOpCost(unsigned Opcode, Type *DataTy,
369                                                 Value *Ptr, bool VariableMask,
370                                                 unsigned Alignment) const {
371   int Cost = TTIImpl->getGatherScatterOpCost(Opcode, DataTy, Ptr, VariableMask,
372                                              Alignment);
373   assert(Cost >= 0 && "TTI should not produce negative costs!");
374   return Cost;
375 }
376 
377 int TargetTransformInfo::getInterleavedMemoryOpCost(
378     unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
379     unsigned Alignment, unsigned AddressSpace) const {
380   int Cost = TTIImpl->getInterleavedMemoryOpCost(Opcode, VecTy, Factor, Indices,
381                                                  Alignment, AddressSpace);
382   assert(Cost >= 0 && "TTI should not produce negative costs!");
383   return Cost;
384 }
385 
386 int TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
387                                     ArrayRef<Type *> Tys, FastMathFlags FMF,
388                                     unsigned ScalarizationCostPassed) const {
389   int Cost = TTIImpl->getIntrinsicInstrCost(ID, RetTy, Tys, FMF,
390                                             ScalarizationCostPassed);
391   assert(Cost >= 0 && "TTI should not produce negative costs!");
392   return Cost;
393 }
394 
395 int TargetTransformInfo::getIntrinsicInstrCost(Intrinsic::ID ID, Type *RetTy,
396            ArrayRef<Value *> Args, FastMathFlags FMF, unsigned VF) const {
397   int Cost = TTIImpl->getIntrinsicInstrCost(ID, RetTy, Args, FMF, VF);
398   assert(Cost >= 0 && "TTI should not produce negative costs!");
399   return Cost;
400 }
401 
402 int TargetTransformInfo::getCallInstrCost(Function *F, Type *RetTy,
403                                           ArrayRef<Type *> Tys) const {
404   int Cost = TTIImpl->getCallInstrCost(F, RetTy, Tys);
405   assert(Cost >= 0 && "TTI should not produce negative costs!");
406   return Cost;
407 }
408 
409 unsigned TargetTransformInfo::getNumberOfParts(Type *Tp) const {
410   return TTIImpl->getNumberOfParts(Tp);
411 }
412 
413 int TargetTransformInfo::getAddressComputationCost(Type *Tp,
414                                                    ScalarEvolution *SE,
415                                                    const SCEV *Ptr) const {
416   int Cost = TTIImpl->getAddressComputationCost(Tp, SE, Ptr);
417   assert(Cost >= 0 && "TTI should not produce negative costs!");
418   return Cost;
419 }
420 
421 int TargetTransformInfo::getReductionCost(unsigned Opcode, Type *Ty,
422                                           bool IsPairwiseForm) const {
423   int Cost = TTIImpl->getReductionCost(Opcode, Ty, IsPairwiseForm);
424   assert(Cost >= 0 && "TTI should not produce negative costs!");
425   return Cost;
426 }
427 
428 unsigned
429 TargetTransformInfo::getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) const {
430   return TTIImpl->getCostOfKeepingLiveOverCall(Tys);
431 }
432 
433 bool TargetTransformInfo::getTgtMemIntrinsic(IntrinsicInst *Inst,
434                                              MemIntrinsicInfo &Info) const {
435   return TTIImpl->getTgtMemIntrinsic(Inst, Info);
436 }
437 
438 Value *TargetTransformInfo::getOrCreateResultFromMemIntrinsic(
439     IntrinsicInst *Inst, Type *ExpectedType) const {
440   return TTIImpl->getOrCreateResultFromMemIntrinsic(Inst, ExpectedType);
441 }
442 
443 bool TargetTransformInfo::areInlineCompatible(const Function *Caller,
444                                               const Function *Callee) const {
445   return TTIImpl->areInlineCompatible(Caller, Callee);
446 }
447 
448 unsigned TargetTransformInfo::getLoadStoreVecRegBitWidth(unsigned AS) const {
449   return TTIImpl->getLoadStoreVecRegBitWidth(AS);
450 }
451 
452 bool TargetTransformInfo::isLegalToVectorizeLoad(LoadInst *LI) const {
453   return TTIImpl->isLegalToVectorizeLoad(LI);
454 }
455 
456 bool TargetTransformInfo::isLegalToVectorizeStore(StoreInst *SI) const {
457   return TTIImpl->isLegalToVectorizeStore(SI);
458 }
459 
460 bool TargetTransformInfo::isLegalToVectorizeLoadChain(
461     unsigned ChainSizeInBytes, unsigned Alignment, unsigned AddrSpace) const {
462   return TTIImpl->isLegalToVectorizeLoadChain(ChainSizeInBytes, Alignment,
463                                               AddrSpace);
464 }
465 
466 bool TargetTransformInfo::isLegalToVectorizeStoreChain(
467     unsigned ChainSizeInBytes, unsigned Alignment, unsigned AddrSpace) const {
468   return TTIImpl->isLegalToVectorizeStoreChain(ChainSizeInBytes, Alignment,
469                                                AddrSpace);
470 }
471 
472 unsigned TargetTransformInfo::getLoadVectorFactor(unsigned VF,
473                                                   unsigned LoadSize,
474                                                   unsigned ChainSizeInBytes,
475                                                   VectorType *VecTy) const {
476   return TTIImpl->getLoadVectorFactor(VF, LoadSize, ChainSizeInBytes, VecTy);
477 }
478 
479 unsigned TargetTransformInfo::getStoreVectorFactor(unsigned VF,
480                                                    unsigned StoreSize,
481                                                    unsigned ChainSizeInBytes,
482                                                    VectorType *VecTy) const {
483   return TTIImpl->getStoreVectorFactor(VF, StoreSize, ChainSizeInBytes, VecTy);
484 }
485 
486 TargetTransformInfo::Concept::~Concept() {}
487 
488 TargetIRAnalysis::TargetIRAnalysis() : TTICallback(&getDefaultTTI) {}
489 
490 TargetIRAnalysis::TargetIRAnalysis(
491     std::function<Result(const Function &)> TTICallback)
492     : TTICallback(std::move(TTICallback)) {}
493 
494 TargetIRAnalysis::Result TargetIRAnalysis::run(const Function &F,
495                                                FunctionAnalysisManager &) {
496   return TTICallback(F);
497 }
498 
499 AnalysisKey TargetIRAnalysis::Key;
500 
501 TargetIRAnalysis::Result TargetIRAnalysis::getDefaultTTI(const Function &F) {
502   return Result(F.getParent()->getDataLayout());
503 }
504 
505 // Register the basic pass.
506 INITIALIZE_PASS(TargetTransformInfoWrapperPass, "tti",
507                 "Target Transform Information", false, true)
508 char TargetTransformInfoWrapperPass::ID = 0;
509 
510 void TargetTransformInfoWrapperPass::anchor() {}
511 
512 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass()
513     : ImmutablePass(ID) {
514   initializeTargetTransformInfoWrapperPassPass(
515       *PassRegistry::getPassRegistry());
516 }
517 
518 TargetTransformInfoWrapperPass::TargetTransformInfoWrapperPass(
519     TargetIRAnalysis TIRA)
520     : ImmutablePass(ID), TIRA(std::move(TIRA)) {
521   initializeTargetTransformInfoWrapperPassPass(
522       *PassRegistry::getPassRegistry());
523 }
524 
525 TargetTransformInfo &TargetTransformInfoWrapperPass::getTTI(const Function &F) {
526   FunctionAnalysisManager DummyFAM;
527   TTI = TIRA.run(F, DummyFAM);
528   return *TTI;
529 }
530 
531 ImmutablePass *
532 llvm::createTargetTransformInfoWrapperPass(TargetIRAnalysis TIRA) {
533   return new TargetTransformInfoWrapperPass(std::move(TIRA));
534 }
535