Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-05-10 08:43:18

0001 //===- TargetTransformInfo.h ------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008 /// \file
0009 /// This pass exposes codegen information to IR-level passes. Every
0010 /// transformation that uses codegen information is broken into three parts:
0011 /// 1. The IR-level analysis pass.
0012 /// 2. The IR-level transformation interface which provides the needed
0013 ///    information.
0014 /// 3. Codegen-level implementation which uses target-specific hooks.
0015 ///
0016 /// This file defines #2, which is the interface that IR-level transformations
0017 /// use for querying the codegen.
0018 ///
0019 //===----------------------------------------------------------------------===//
0020 
0021 #ifndef LLVM_ANALYSIS_TARGETTRANSFORMINFO_H
0022 #define LLVM_ANALYSIS_TARGETTRANSFORMINFO_H
0023 
0024 #include "llvm/ADT/APInt.h"
0025 #include "llvm/ADT/ArrayRef.h"
0026 #include "llvm/IR/FMF.h"
0027 #include "llvm/IR/InstrTypes.h"
0028 #include "llvm/IR/PassManager.h"
0029 #include "llvm/Pass.h"
0030 #include "llvm/Support/AtomicOrdering.h"
0031 #include "llvm/Support/BranchProbability.h"
0032 #include "llvm/Support/InstructionCost.h"
0033 #include <functional>
0034 #include <optional>
0035 #include <utility>
0036 
0037 namespace llvm {
0038 
0039 namespace Intrinsic {
0040 typedef unsigned ID;
0041 }
0042 
0043 class AllocaInst;
0044 class AssumptionCache;
0045 class BlockFrequencyInfo;
0046 class DominatorTree;
0047 class BranchInst;
0048 class Function;
0049 class GlobalValue;
0050 class InstCombiner;
0051 class OptimizationRemarkEmitter;
0052 class InterleavedAccessInfo;
0053 class IntrinsicInst;
0054 class LoadInst;
0055 class Loop;
0056 class LoopInfo;
0057 class LoopVectorizationLegality;
0058 class ProfileSummaryInfo;
0059 class RecurrenceDescriptor;
0060 class SCEV;
0061 class ScalarEvolution;
0062 class SmallBitVector;
0063 class StoreInst;
0064 class SwitchInst;
0065 class TargetLibraryInfo;
0066 class Type;
0067 class VPIntrinsic;
0068 struct KnownBits;
0069 
0070 /// Information about a load/store intrinsic defined by the target.
0071 struct MemIntrinsicInfo {
0072   /// This is the pointer that the intrinsic is loading from or storing to.
0073   /// If this is non-null, then analysis/optimization passes can assume that
0074   /// this intrinsic is functionally equivalent to a load/store from this
0075   /// pointer.
0076   Value *PtrVal = nullptr;
0077 
0078   // Ordering for atomic operations.
0079   AtomicOrdering Ordering = AtomicOrdering::NotAtomic;
0080 
0081   // Same Id is set by the target for corresponding load/store intrinsics.
0082   unsigned short MatchingId = 0;
0083 
0084   bool ReadMem = false;
0085   bool WriteMem = false;
0086   bool IsVolatile = false;
0087 
0088   bool isUnordered() const {
0089     return (Ordering == AtomicOrdering::NotAtomic ||
0090             Ordering == AtomicOrdering::Unordered) &&
0091            !IsVolatile;
0092   }
0093 };
0094 
0095 /// Attributes of a target dependent hardware loop.
0096 struct HardwareLoopInfo {
0097   HardwareLoopInfo() = delete;
0098   HardwareLoopInfo(Loop *L);
0099   Loop *L = nullptr;
0100   BasicBlock *ExitBlock = nullptr;
0101   BranchInst *ExitBranch = nullptr;
0102   const SCEV *ExitCount = nullptr;
0103   IntegerType *CountType = nullptr;
0104   Value *LoopDecrement = nullptr; // Decrement the loop counter by this
0105                                   // value in every iteration.
0106   bool IsNestingLegal = false;    // Can a hardware loop be a parent to
0107                                   // another hardware loop?
0108   bool CounterInReg = false;      // Should loop counter be updated in
0109                                   // the loop via a phi?
0110   bool PerformEntryTest = false;  // Generate the intrinsic which also performs
0111                                   // icmp ne zero on the loop counter value and
0112                                   // produces an i1 to guard the loop entry.
0113   bool isHardwareLoopCandidate(ScalarEvolution &SE, LoopInfo &LI,
0114                                DominatorTree &DT, bool ForceNestedLoop = false,
0115                                bool ForceHardwareLoopPHI = false);
0116   bool canAnalyze(LoopInfo &LI);
0117 };
0118 
0119 class IntrinsicCostAttributes {
0120   const IntrinsicInst *II = nullptr;
0121   Type *RetTy = nullptr;
0122   Intrinsic::ID IID;
0123   SmallVector<Type *, 4> ParamTys;
0124   SmallVector<const Value *, 4> Arguments;
0125   FastMathFlags FMF;
0126   // If ScalarizationCost is UINT_MAX, the cost of scalarizing the
0127   // arguments and the return value will be computed based on types.
0128   InstructionCost ScalarizationCost = InstructionCost::getInvalid();
0129 
0130 public:
0131   IntrinsicCostAttributes(
0132       Intrinsic::ID Id, const CallBase &CI,
0133       InstructionCost ScalarCost = InstructionCost::getInvalid(),
0134       bool TypeBasedOnly = false);
0135 
0136   IntrinsicCostAttributes(
0137       Intrinsic::ID Id, Type *RTy, ArrayRef<Type *> Tys,
0138       FastMathFlags Flags = FastMathFlags(), const IntrinsicInst *I = nullptr,
0139       InstructionCost ScalarCost = InstructionCost::getInvalid());
0140 
0141   IntrinsicCostAttributes(Intrinsic::ID Id, Type *RTy,
0142                           ArrayRef<const Value *> Args);
0143 
0144   IntrinsicCostAttributes(
0145       Intrinsic::ID Id, Type *RTy, ArrayRef<const Value *> Args,
0146       ArrayRef<Type *> Tys, FastMathFlags Flags = FastMathFlags(),
0147       const IntrinsicInst *I = nullptr,
0148       InstructionCost ScalarCost = InstructionCost::getInvalid());
0149 
0150   Intrinsic::ID getID() const { return IID; }
0151   const IntrinsicInst *getInst() const { return II; }
0152   Type *getReturnType() const { return RetTy; }
0153   FastMathFlags getFlags() const { return FMF; }
0154   InstructionCost getScalarizationCost() const { return ScalarizationCost; }
0155   const SmallVectorImpl<const Value *> &getArgs() const { return Arguments; }
0156   const SmallVectorImpl<Type *> &getArgTypes() const { return ParamTys; }
0157 
0158   bool isTypeBasedOnly() const {
0159     return Arguments.empty();
0160   }
0161 
0162   bool skipScalarizationCost() const { return ScalarizationCost.isValid(); }
0163 };
0164 
0165 enum class TailFoldingStyle {
0166   /// Don't use tail folding
0167   None,
0168   /// Use predicate only to mask operations on data in the loop.
0169   /// When the VL is not known to be a power-of-2, this method requires a
0170   /// runtime overflow check for the i + VL in the loop because it compares the
0171   /// scalar induction variable against the tripcount rounded up by VL which may
0172   /// overflow. When the VL is a power-of-2, both the increment and uprounded
0173   /// tripcount will overflow to 0, which does not require a runtime check
0174   /// since the loop is exited when the loop induction variable equals the
0175   /// uprounded trip-count, which are both 0.
0176   Data,
0177   /// Same as Data, but avoids using the get.active.lane.mask intrinsic to
0178   /// calculate the mask and instead implements this with a
0179   /// splat/stepvector/cmp.
0180   /// FIXME: Can this kind be removed now that SelectionDAGBuilder expands the
0181   /// active.lane.mask intrinsic when it is not natively supported?
0182   DataWithoutLaneMask,
0183   /// Use predicate to control both data and control flow.
0184   /// This method always requires a runtime overflow check for the i + VL
0185   /// increment inside the loop, because it uses the result direclty in the
0186   /// active.lane.mask to calculate the mask for the next iteration. If the
0187   /// increment overflows, the mask is no longer correct.
0188   DataAndControlFlow,
0189   /// Use predicate to control both data and control flow, but modify
0190   /// the trip count so that a runtime overflow check can be avoided
0191   /// and such that the scalar epilogue loop can always be removed.
0192   DataAndControlFlowWithoutRuntimeCheck,
0193   /// Use predicated EVL instructions for tail-folding.
0194   /// Indicates that VP intrinsics should be used.
0195   DataWithEVL,
0196 };
0197 
0198 struct TailFoldingInfo {
0199   TargetLibraryInfo *TLI;
0200   LoopVectorizationLegality *LVL;
0201   InterleavedAccessInfo *IAI;
0202   TailFoldingInfo(TargetLibraryInfo *TLI, LoopVectorizationLegality *LVL,
0203                   InterleavedAccessInfo *IAI)
0204       : TLI(TLI), LVL(LVL), IAI(IAI) {}
0205 };
0206 
0207 class TargetTransformInfo;
0208 typedef TargetTransformInfo TTI;
0209 
0210 /// This pass provides access to the codegen interfaces that are needed
0211 /// for IR-level transformations.
0212 class TargetTransformInfo {
0213 public:
0214   enum PartialReductionExtendKind { PR_None, PR_SignExtend, PR_ZeroExtend };
0215 
0216   /// Get the kind of extension that an instruction represents.
0217   static PartialReductionExtendKind
0218   getPartialReductionExtendKind(Instruction *I);
0219 
0220   /// Construct a TTI object using a type implementing the \c Concept
0221   /// API below.
0222   ///
0223   /// This is used by targets to construct a TTI wrapping their target-specific
0224   /// implementation that encodes appropriate costs for their target.
0225   template <typename T> TargetTransformInfo(T Impl);
0226 
0227   /// Construct a baseline TTI object using a minimal implementation of
0228   /// the \c Concept API below.
0229   ///
0230   /// The TTI implementation will reflect the information in the DataLayout
0231   /// provided if non-null.
0232   explicit TargetTransformInfo(const DataLayout &DL);
0233 
0234   // Provide move semantics.
0235   TargetTransformInfo(TargetTransformInfo &&Arg);
0236   TargetTransformInfo &operator=(TargetTransformInfo &&RHS);
0237 
0238   // We need to define the destructor out-of-line to define our sub-classes
0239   // out-of-line.
0240   ~TargetTransformInfo();
0241 
0242   /// Handle the invalidation of this information.
0243   ///
0244   /// When used as a result of \c TargetIRAnalysis this method will be called
0245   /// when the function this was computed for changes. When it returns false,
0246   /// the information is preserved across those changes.
0247   bool invalidate(Function &, const PreservedAnalyses &,
0248                   FunctionAnalysisManager::Invalidator &) {
0249     // FIXME: We should probably in some way ensure that the subtarget
0250     // information for a function hasn't changed.
0251     return false;
0252   }
0253 
0254   /// \name Generic Target Information
0255   /// @{
0256 
0257   /// The kind of cost model.
0258   ///
0259   /// There are several different cost models that can be customized by the
0260   /// target. The normalization of each cost model may be target specific.
0261   /// e.g. TCK_SizeAndLatency should be comparable to target thresholds such as
0262   /// those derived from MCSchedModel::LoopMicroOpBufferSize etc.
0263   enum TargetCostKind {
0264     TCK_RecipThroughput, ///< Reciprocal throughput.
0265     TCK_Latency,         ///< The latency of instruction.
0266     TCK_CodeSize,        ///< Instruction code size.
0267     TCK_SizeAndLatency   ///< The weighted sum of size and latency.
0268   };
0269 
0270   /// Underlying constants for 'cost' values in this interface.
0271   ///
0272   /// Many APIs in this interface return a cost. This enum defines the
0273   /// fundamental values that should be used to interpret (and produce) those
0274   /// costs. The costs are returned as an int rather than a member of this
0275   /// enumeration because it is expected that the cost of one IR instruction
0276   /// may have a multiplicative factor to it or otherwise won't fit directly
0277   /// into the enum. Moreover, it is common to sum or average costs which works
0278   /// better as simple integral values. Thus this enum only provides constants.
0279   /// Also note that the returned costs are signed integers to make it natural
0280   /// to add, subtract, and test with zero (a common boundary condition). It is
0281   /// not expected that 2^32 is a realistic cost to be modeling at any point.
0282   ///
0283   /// Note that these costs should usually reflect the intersection of code-size
0284   /// cost and execution cost. A free instruction is typically one that folds
0285   /// into another instruction. For example, reg-to-reg moves can often be
0286   /// skipped by renaming the registers in the CPU, but they still are encoded
0287   /// and thus wouldn't be considered 'free' here.
0288   enum TargetCostConstants {
0289     TCC_Free = 0,     ///< Expected to fold away in lowering.
0290     TCC_Basic = 1,    ///< The cost of a typical 'add' instruction.
0291     TCC_Expensive = 4 ///< The cost of a 'div' instruction on x86.
0292   };
0293 
0294   /// Estimate the cost of a GEP operation when lowered.
0295   ///
0296   /// \p PointeeType is the source element type of the GEP.
0297   /// \p Ptr is the base pointer operand.
0298   /// \p Operands is the list of indices following the base pointer.
0299   ///
0300   /// \p AccessType is a hint as to what type of memory might be accessed by
0301   /// users of the GEP. getGEPCost will use it to determine if the GEP can be
0302   /// folded into the addressing mode of a load/store. If AccessType is null,
0303   /// then the resulting target type based off of PointeeType will be used as an
0304   /// approximation.
0305   InstructionCost
0306   getGEPCost(Type *PointeeType, const Value *Ptr,
0307              ArrayRef<const Value *> Operands, Type *AccessType = nullptr,
0308              TargetCostKind CostKind = TCK_SizeAndLatency) const;
0309 
0310   /// Describe known properties for a set of pointers.
0311   struct PointersChainInfo {
0312     /// All the GEPs in a set have same base address.
0313     unsigned IsSameBaseAddress : 1;
0314     /// These properties only valid if SameBaseAddress is set.
0315     /// True if all pointers are separated by a unit stride.
0316     unsigned IsUnitStride : 1;
0317     /// True if distance between any two neigbouring pointers is a known value.
0318     unsigned IsKnownStride : 1;
0319     unsigned Reserved : 29;
0320 
0321     bool isSameBase() const { return IsSameBaseAddress; }
0322     bool isUnitStride() const { return IsSameBaseAddress && IsUnitStride; }
0323     bool isKnownStride() const { return IsSameBaseAddress && IsKnownStride; }
0324 
0325     static PointersChainInfo getUnitStride() {
0326       return {/*IsSameBaseAddress=*/1, /*IsUnitStride=*/1,
0327               /*IsKnownStride=*/1, 0};
0328     }
0329     static PointersChainInfo getKnownStride() {
0330       return {/*IsSameBaseAddress=*/1, /*IsUnitStride=*/0,
0331               /*IsKnownStride=*/1, 0};
0332     }
0333     static PointersChainInfo getUnknownStride() {
0334       return {/*IsSameBaseAddress=*/1, /*IsUnitStride=*/0,
0335               /*IsKnownStride=*/0, 0};
0336     }
0337   };
0338   static_assert(sizeof(PointersChainInfo) == 4, "Was size increase justified?");
0339 
0340   /// Estimate the cost of a chain of pointers (typically pointer operands of a
0341   /// chain of loads or stores within same block) operations set when lowered.
0342   /// \p AccessTy is the type of the loads/stores that will ultimately use the
0343   /// \p Ptrs.
0344   InstructionCost getPointersChainCost(
0345       ArrayRef<const Value *> Ptrs, const Value *Base,
0346       const PointersChainInfo &Info, Type *AccessTy,
0347       TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
0348 
0349   /// \returns A value by which our inlining threshold should be multiplied.
0350   /// This is primarily used to bump up the inlining threshold wholesale on
0351   /// targets where calls are unusually expensive.
0352   ///
0353   /// TODO: This is a rather blunt instrument.  Perhaps altering the costs of
0354   /// individual classes of instructions would be better.
0355   unsigned getInliningThresholdMultiplier() const;
0356 
0357   unsigned getInliningCostBenefitAnalysisSavingsMultiplier() const;
0358   unsigned getInliningCostBenefitAnalysisProfitableMultiplier() const;
0359 
0360   /// \returns The bonus of inlining the last call to a static function.
0361   int getInliningLastCallToStaticBonus() const;
0362 
0363   /// \returns A value to be added to the inlining threshold.
0364   unsigned adjustInliningThreshold(const CallBase *CB) const;
0365 
0366   /// \returns The cost of having an Alloca in the caller if not inlined, to be
0367   /// added to the threshold
0368   unsigned getCallerAllocaCost(const CallBase *CB, const AllocaInst *AI) const;
0369 
0370   /// \returns Vector bonus in percent.
0371   ///
0372   /// Vector bonuses: We want to more aggressively inline vector-dense kernels
0373   /// and apply this bonus based on the percentage of vector instructions. A
0374   /// bonus is applied if the vector instructions exceed 50% and half that
0375   /// amount is applied if it exceeds 10%. Note that these bonuses are some what
0376   /// arbitrary and evolved over time by accident as much as because they are
0377   /// principled bonuses.
0378   /// FIXME: It would be nice to base the bonus values on something more
0379   /// scientific. A target may has no bonus on vector instructions.
0380   int getInlinerVectorBonusPercent() const;
0381 
0382   /// \return the expected cost of a memcpy, which could e.g. depend on the
0383   /// source/destination type and alignment and the number of bytes copied.
0384   InstructionCost getMemcpyCost(const Instruction *I) const;
0385 
0386   /// Returns the maximum memset / memcpy size in bytes that still makes it
0387   /// profitable to inline the call.
0388   uint64_t getMaxMemIntrinsicInlineSizeThreshold() const;
0389 
0390   /// \return The estimated number of case clusters when lowering \p 'SI'.
0391   /// \p JTSize Set a jump table size only when \p SI is suitable for a jump
0392   /// table.
0393   unsigned getEstimatedNumberOfCaseClusters(const SwitchInst &SI,
0394                                             unsigned &JTSize,
0395                                             ProfileSummaryInfo *PSI,
0396                                             BlockFrequencyInfo *BFI) const;
0397 
0398   /// Estimate the cost of a given IR user when lowered.
0399   ///
0400   /// This can estimate the cost of either a ConstantExpr or Instruction when
0401   /// lowered.
0402   ///
0403   /// \p Operands is a list of operands which can be a result of transformations
0404   /// of the current operands. The number of the operands on the list must equal
0405   /// to the number of the current operands the IR user has. Their order on the
0406   /// list must be the same as the order of the current operands the IR user
0407   /// has.
0408   ///
0409   /// The returned cost is defined in terms of \c TargetCostConstants, see its
0410   /// comments for a detailed explanation of the cost values.
0411   InstructionCost getInstructionCost(const User *U,
0412                                      ArrayRef<const Value *> Operands,
0413                                      TargetCostKind CostKind) const;
0414 
0415   /// This is a helper function which calls the three-argument
0416   /// getInstructionCost with \p Operands which are the current operands U has.
0417   InstructionCost getInstructionCost(const User *U,
0418                                      TargetCostKind CostKind) const {
0419     SmallVector<const Value *, 4> Operands(U->operand_values());
0420     return getInstructionCost(U, Operands, CostKind);
0421   }
0422 
0423   /// If a branch or a select condition is skewed in one direction by more than
0424   /// this factor, it is very likely to be predicted correctly.
0425   BranchProbability getPredictableBranchThreshold() const;
0426 
0427   /// Returns estimated penalty of a branch misprediction in latency. Indicates
0428   /// how aggressive the target wants for eliminating unpredictable branches. A
0429   /// zero return value means extra optimization applied to them should be
0430   /// minimal.
0431   InstructionCost getBranchMispredictPenalty() const;
0432 
0433   /// Return true if branch divergence exists.
0434   ///
0435   /// Branch divergence has a significantly negative impact on GPU performance
0436   /// when threads in the same wavefront take different paths due to conditional
0437   /// branches.
0438   ///
0439   /// If \p F is passed, provides a context function. If \p F is known to only
0440   /// execute in a single threaded environment, the target may choose to skip
0441   /// uniformity analysis and assume all values are uniform.
0442   bool hasBranchDivergence(const Function *F = nullptr) const;
0443 
0444   /// Returns whether V is a source of divergence.
0445   ///
0446   /// This function provides the target-dependent information for
0447   /// the target-independent UniformityAnalysis.
0448   bool isSourceOfDivergence(const Value *V) const;
0449 
0450   // Returns true for the target specific
0451   // set of operations which produce uniform result
0452   // even taking non-uniform arguments
0453   bool isAlwaysUniform(const Value *V) const;
0454 
0455   /// Query the target whether the specified address space cast from FromAS to
0456   /// ToAS is valid.
0457   bool isValidAddrSpaceCast(unsigned FromAS, unsigned ToAS) const;
0458 
0459   /// Return false if a \p AS0 address cannot possibly alias a \p AS1 address.
0460   bool addrspacesMayAlias(unsigned AS0, unsigned AS1) const;
0461 
0462   /// Returns the address space ID for a target's 'flat' address space. Note
0463   /// this is not necessarily the same as addrspace(0), which LLVM sometimes
0464   /// refers to as the generic address space. The flat address space is a
0465   /// generic address space that can be used access multiple segments of memory
0466   /// with different address spaces. Access of a memory location through a
0467   /// pointer with this address space is expected to be legal but slower
0468   /// compared to the same memory location accessed through a pointer with a
0469   /// different address space.
0470   //
0471   /// This is for targets with different pointer representations which can
0472   /// be converted with the addrspacecast instruction. If a pointer is converted
0473   /// to this address space, optimizations should attempt to replace the access
0474   /// with the source address space.
0475   ///
0476   /// \returns ~0u if the target does not have such a flat address space to
0477   /// optimize away.
0478   unsigned getFlatAddressSpace() const;
0479 
0480   /// Return any intrinsic address operand indexes which may be rewritten if
0481   /// they use a flat address space pointer.
0482   ///
0483   /// \returns true if the intrinsic was handled.
0484   bool collectFlatAddressOperands(SmallVectorImpl<int> &OpIndexes,
0485                                   Intrinsic::ID IID) const;
0486 
0487   bool isNoopAddrSpaceCast(unsigned FromAS, unsigned ToAS) const;
0488 
0489   /// Return true if globals in this address space can have initializers other
0490   /// than `undef`.
0491   bool canHaveNonUndefGlobalInitializerInAddressSpace(unsigned AS) const;
0492 
0493   unsigned getAssumedAddrSpace(const Value *V) const;
0494 
0495   bool isSingleThreaded() const;
0496 
0497   std::pair<const Value *, unsigned>
0498   getPredicatedAddrSpace(const Value *V) const;
0499 
0500   /// Rewrite intrinsic call \p II such that \p OldV will be replaced with \p
0501   /// NewV, which has a different address space. This should happen for every
0502   /// operand index that collectFlatAddressOperands returned for the intrinsic.
0503   /// \returns nullptr if the intrinsic was not handled. Otherwise, returns the
0504   /// new value (which may be the original \p II with modified operands).
0505   Value *rewriteIntrinsicWithAddressSpace(IntrinsicInst *II, Value *OldV,
0506                                           Value *NewV) const;
0507 
0508   /// Test whether calls to a function lower to actual program function
0509   /// calls.
0510   ///
0511   /// The idea is to test whether the program is likely to require a 'call'
0512   /// instruction or equivalent in order to call the given function.
0513   ///
0514   /// FIXME: It's not clear that this is a good or useful query API. Client's
0515   /// should probably move to simpler cost metrics using the above.
0516   /// Alternatively, we could split the cost interface into distinct code-size
0517   /// and execution-speed costs. This would allow modelling the core of this
0518   /// query more accurately as a call is a single small instruction, but
0519   /// incurs significant execution cost.
0520   bool isLoweredToCall(const Function *F) const;
0521 
0522   struct LSRCost {
0523     /// TODO: Some of these could be merged. Also, a lexical ordering
0524     /// isn't always optimal.
0525     unsigned Insns;
0526     unsigned NumRegs;
0527     unsigned AddRecCost;
0528     unsigned NumIVMuls;
0529     unsigned NumBaseAdds;
0530     unsigned ImmCost;
0531     unsigned SetupCost;
0532     unsigned ScaleCost;
0533   };
0534 
0535   /// Parameters that control the generic loop unrolling transformation.
0536   struct UnrollingPreferences {
0537     /// The cost threshold for the unrolled loop. Should be relative to the
0538     /// getInstructionCost values returned by this API, and the expectation is
0539     /// that the unrolled loop's instructions when run through that interface
0540     /// should not exceed this cost. However, this is only an estimate. Also,
0541     /// specific loops may be unrolled even with a cost above this threshold if
0542     /// deemed profitable. Set this to UINT_MAX to disable the loop body cost
0543     /// restriction.
0544     unsigned Threshold;
0545     /// If complete unrolling will reduce the cost of the loop, we will boost
0546     /// the Threshold by a certain percent to allow more aggressive complete
0547     /// unrolling. This value provides the maximum boost percentage that we
0548     /// can apply to Threshold (The value should be no less than 100).
0549     /// BoostedThreshold = Threshold * min(RolledCost / UnrolledCost,
0550     ///                                    MaxPercentThresholdBoost / 100)
0551     /// E.g. if complete unrolling reduces the loop execution time by 50%
0552     /// then we boost the threshold by the factor of 2x. If unrolling is not
0553     /// expected to reduce the running time, then we do not increase the
0554     /// threshold.
0555     unsigned MaxPercentThresholdBoost;
0556     /// The cost threshold for the unrolled loop when optimizing for size (set
0557     /// to UINT_MAX to disable).
0558     unsigned OptSizeThreshold;
0559     /// The cost threshold for the unrolled loop, like Threshold, but used
0560     /// for partial/runtime unrolling (set to UINT_MAX to disable).
0561     unsigned PartialThreshold;
0562     /// The cost threshold for the unrolled loop when optimizing for size, like
0563     /// OptSizeThreshold, but used for partial/runtime unrolling (set to
0564     /// UINT_MAX to disable).
0565     unsigned PartialOptSizeThreshold;
0566     /// A forced unrolling factor (the number of concatenated bodies of the
0567     /// original loop in the unrolled loop body). When set to 0, the unrolling
0568     /// transformation will select an unrolling factor based on the current cost
0569     /// threshold and other factors.
0570     unsigned Count;
0571     /// Default unroll count for loops with run-time trip count.
0572     unsigned DefaultUnrollRuntimeCount;
0573     // Set the maximum unrolling factor. The unrolling factor may be selected
0574     // using the appropriate cost threshold, but may not exceed this number
0575     // (set to UINT_MAX to disable). This does not apply in cases where the
0576     // loop is being fully unrolled.
0577     unsigned MaxCount;
0578     /// Set the maximum upper bound of trip count. Allowing the MaxUpperBound
0579     /// to be overrided by a target gives more flexiblity on certain cases.
0580     /// By default, MaxUpperBound uses UnrollMaxUpperBound which value is 8.
0581     unsigned MaxUpperBound;
0582     /// Set the maximum unrolling factor for full unrolling. Like MaxCount, but
0583     /// applies even if full unrolling is selected. This allows a target to fall
0584     /// back to Partial unrolling if full unrolling is above FullUnrollMaxCount.
0585     unsigned FullUnrollMaxCount;
0586     // Represents number of instructions optimized when "back edge"
0587     // becomes "fall through" in unrolled loop.
0588     // For now we count a conditional branch on a backedge and a comparison
0589     // feeding it.
0590     unsigned BEInsns;
0591     /// Allow partial unrolling (unrolling of loops to expand the size of the
0592     /// loop body, not only to eliminate small constant-trip-count loops).
0593     bool Partial;
0594     /// Allow runtime unrolling (unrolling of loops to expand the size of the
0595     /// loop body even when the number of loop iterations is not known at
0596     /// compile time).
0597     bool Runtime;
0598     /// Allow generation of a loop remainder (extra iterations after unroll).
0599     bool AllowRemainder;
0600     /// Allow emitting expensive instructions (such as divisions) when computing
0601     /// the trip count of a loop for runtime unrolling.
0602     bool AllowExpensiveTripCount;
0603     /// Apply loop unroll on any kind of loop
0604     /// (mainly to loops that fail runtime unrolling).
0605     bool Force;
0606     /// Allow using trip count upper bound to unroll loops.
0607     bool UpperBound;
0608     /// Allow unrolling of all the iterations of the runtime loop remainder.
0609     bool UnrollRemainder;
0610     /// Allow unroll and jam. Used to enable unroll and jam for the target.
0611     bool UnrollAndJam;
0612     /// Threshold for unroll and jam, for inner loop size. The 'Threshold'
0613     /// value above is used during unroll and jam for the outer loop size.
0614     /// This value is used in the same manner to limit the size of the inner
0615     /// loop.
0616     unsigned UnrollAndJamInnerLoopThreshold;
0617     /// Don't allow loop unrolling to simulate more than this number of
0618     /// iterations when checking full unroll profitability
0619     unsigned MaxIterationsCountToAnalyze;
0620     /// Don't disable runtime unroll for the loops which were vectorized.
0621     bool UnrollVectorizedLoop = false;
0622     /// Don't allow runtime unrolling if expanding the trip count takes more
0623     /// than SCEVExpansionBudget.
0624     unsigned SCEVExpansionBudget;
0625     /// Allow runtime unrolling multi-exit loops. Should only be set if the
0626     /// target determined that multi-exit unrolling is profitable for the loop.
0627     /// Fall back to the generic logic to determine whether multi-exit unrolling
0628     /// is profitable if set to false.
0629     bool RuntimeUnrollMultiExit;
0630   };
0631 
0632   /// Get target-customized preferences for the generic loop unrolling
0633   /// transformation. The caller will initialize UP with the current
0634   /// target-independent defaults.
0635   void getUnrollingPreferences(Loop *L, ScalarEvolution &,
0636                                UnrollingPreferences &UP,
0637                                OptimizationRemarkEmitter *ORE) const;
0638 
0639   /// Query the target whether it would be profitable to convert the given loop
0640   /// into a hardware loop.
0641   bool isHardwareLoopProfitable(Loop *L, ScalarEvolution &SE,
0642                                 AssumptionCache &AC, TargetLibraryInfo *LibInfo,
0643                                 HardwareLoopInfo &HWLoopInfo) const;
0644 
0645   // Query the target for which minimum vectorization factor epilogue
0646   // vectorization should be considered.
0647   unsigned getEpilogueVectorizationMinVF() const;
0648 
0649   /// Query the target whether it would be prefered to create a predicated
0650   /// vector loop, which can avoid the need to emit a scalar epilogue loop.
0651   bool preferPredicateOverEpilogue(TailFoldingInfo *TFI) const;
0652 
0653   /// Query the target what the preferred style of tail folding is.
0654   /// \param IVUpdateMayOverflow Tells whether it is known if the IV update
0655   /// may (or will never) overflow for the suggested VF/UF in the given loop.
0656   /// Targets can use this information to select a more optimal tail folding
0657   /// style. The value conservatively defaults to true, such that no assumptions
0658   /// are made on overflow.
0659   TailFoldingStyle
0660   getPreferredTailFoldingStyle(bool IVUpdateMayOverflow = true) const;
0661 
0662   // Parameters that control the loop peeling transformation
0663   struct PeelingPreferences {
0664     /// A forced peeling factor (the number of bodied of the original loop
0665     /// that should be peeled off before the loop body). When set to 0, the
0666     /// a peeling factor based on profile information and other factors.
0667     unsigned PeelCount;
0668     /// Allow peeling off loop iterations.
0669     bool AllowPeeling;
0670     /// Allow peeling off loop iterations for loop nests.
0671     bool AllowLoopNestsPeeling;
0672     /// Allow peeling basing on profile. Uses to enable peeling off all
0673     /// iterations basing on provided profile.
0674     /// If the value is true the peeling cost model can decide to peel only
0675     /// some iterations and in this case it will set this to false.
0676     bool PeelProfiledIterations;
0677   };
0678 
0679   /// Get target-customized preferences for the generic loop peeling
0680   /// transformation. The caller will initialize \p PP with the current
0681   /// target-independent defaults with information from \p L and \p SE.
0682   void getPeelingPreferences(Loop *L, ScalarEvolution &SE,
0683                              PeelingPreferences &PP) const;
0684 
0685   /// Targets can implement their own combinations for target-specific
0686   /// intrinsics. This function will be called from the InstCombine pass every
0687   /// time a target-specific intrinsic is encountered.
0688   ///
0689   /// \returns std::nullopt to not do anything target specific or a value that
0690   /// will be returned from the InstCombiner. It is possible to return null and
0691   /// stop further processing of the intrinsic by returning nullptr.
0692   std::optional<Instruction *> instCombineIntrinsic(InstCombiner & IC,
0693                                                     IntrinsicInst & II) const;
0694   /// Can be used to implement target-specific instruction combining.
0695   /// \see instCombineIntrinsic
0696   std::optional<Value *> simplifyDemandedUseBitsIntrinsic(
0697       InstCombiner & IC, IntrinsicInst & II, APInt DemandedMask,
0698       KnownBits & Known, bool &KnownBitsComputed) const;
0699   /// Can be used to implement target-specific instruction combining.
0700   /// \see instCombineIntrinsic
0701   std::optional<Value *> simplifyDemandedVectorEltsIntrinsic(
0702       InstCombiner & IC, IntrinsicInst & II, APInt DemandedElts,
0703       APInt & UndefElts, APInt & UndefElts2, APInt & UndefElts3,
0704       std::function<void(Instruction *, unsigned, APInt, APInt &)>
0705           SimplifyAndSetOp) const;
0706   /// @}
0707 
0708   /// \name Scalar Target Information
0709   /// @{
0710 
0711   /// Flags indicating the kind of support for population count.
0712   ///
0713   /// Compared to the SW implementation, HW support is supposed to
0714   /// significantly boost the performance when the population is dense, and it
0715   /// may or may not degrade performance if the population is sparse. A HW
0716   /// support is considered as "Fast" if it can outperform, or is on a par
0717   /// with, SW implementation when the population is sparse; otherwise, it is
0718   /// considered as "Slow".
0719   enum PopcntSupportKind { PSK_Software, PSK_SlowHardware, PSK_FastHardware };
0720 
0721   /// Return true if the specified immediate is legal add immediate, that
0722   /// is the target has add instructions which can add a register with the
0723   /// immediate without having to materialize the immediate into a register.
0724   bool isLegalAddImmediate(int64_t Imm) const;
0725 
0726   /// Return true if adding the specified scalable immediate is legal, that is
0727   /// the target has add instructions which can add a register with the
0728   /// immediate (multiplied by vscale) without having to materialize the
0729   /// immediate into a register.
0730   bool isLegalAddScalableImmediate(int64_t Imm) const;
0731 
0732   /// Return true if the specified immediate is legal icmp immediate,
0733   /// that is the target has icmp instructions which can compare a register
0734   /// against the immediate without having to materialize the immediate into a
0735   /// register.
0736   bool isLegalICmpImmediate(int64_t Imm) const;
0737 
0738   /// Return true if the addressing mode represented by AM is legal for
0739   /// this target, for a load/store of the specified type.
0740   /// The type may be VoidTy, in which case only return true if the addressing
0741   /// mode is legal for a load/store of any legal type.
0742   /// If target returns true in LSRWithInstrQueries(), I may be valid.
0743   /// \param ScalableOffset represents a quantity of bytes multiplied by vscale,
0744   /// an invariant value known only at runtime. Most targets should not accept
0745   /// a scalable offset.
0746   ///
0747   /// TODO: Handle pre/postinc as well.
0748   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
0749                              bool HasBaseReg, int64_t Scale,
0750                              unsigned AddrSpace = 0, Instruction *I = nullptr,
0751                              int64_t ScalableOffset = 0) const;
0752 
0753   /// Return true if LSR cost of C1 is lower than C2.
0754   bool isLSRCostLess(const TargetTransformInfo::LSRCost &C1,
0755                      const TargetTransformInfo::LSRCost &C2) const;
0756 
0757   /// Return true if LSR major cost is number of registers. Targets which
0758   /// implement their own isLSRCostLess and unset number of registers as major
0759   /// cost should return false, otherwise return true.
0760   bool isNumRegsMajorCostOfLSR() const;
0761 
0762   /// Return true if LSR should drop a found solution if it's calculated to be
0763   /// less profitable than the baseline.
0764   bool shouldDropLSRSolutionIfLessProfitable() const;
0765 
0766   /// \returns true if LSR should not optimize a chain that includes \p I.
0767   bool isProfitableLSRChainElement(Instruction *I) const;
0768 
0769   /// Return true if the target can fuse a compare and branch.
0770   /// Loop-strength-reduction (LSR) uses that knowledge to adjust its cost
0771   /// calculation for the instructions in a loop.
0772   bool canMacroFuseCmp() const;
0773 
0774   /// Return true if the target can save a compare for loop count, for example
0775   /// hardware loop saves a compare.
0776   bool canSaveCmp(Loop *L, BranchInst **BI, ScalarEvolution *SE, LoopInfo *LI,
0777                   DominatorTree *DT, AssumptionCache *AC,
0778                   TargetLibraryInfo *LibInfo) const;
0779 
0780   enum AddressingModeKind {
0781     AMK_PreIndexed,
0782     AMK_PostIndexed,
0783     AMK_None
0784   };
0785 
0786   /// Return the preferred addressing mode LSR should make efforts to generate.
0787   AddressingModeKind getPreferredAddressingMode(const Loop *L,
0788                                                 ScalarEvolution *SE) const;
0789 
0790   /// Return true if the target supports masked store.
0791   bool isLegalMaskedStore(Type *DataType, Align Alignment) const;
0792   /// Return true if the target supports masked load.
0793   bool isLegalMaskedLoad(Type *DataType, Align Alignment) const;
0794 
0795   /// Return true if the target supports nontemporal store.
0796   bool isLegalNTStore(Type *DataType, Align Alignment) const;
0797   /// Return true if the target supports nontemporal load.
0798   bool isLegalNTLoad(Type *DataType, Align Alignment) const;
0799 
0800   /// \Returns true if the target supports broadcasting a load to a vector of
0801   /// type <NumElements x ElementTy>.
0802   bool isLegalBroadcastLoad(Type *ElementTy, ElementCount NumElements) const;
0803 
0804   /// Return true if the target supports masked scatter.
0805   bool isLegalMaskedScatter(Type *DataType, Align Alignment) const;
0806   /// Return true if the target supports masked gather.
0807   bool isLegalMaskedGather(Type *DataType, Align Alignment) const;
0808   /// Return true if the target forces scalarizing of llvm.masked.gather
0809   /// intrinsics.
0810   bool forceScalarizeMaskedGather(VectorType *Type, Align Alignment) const;
0811   /// Return true if the target forces scalarizing of llvm.masked.scatter
0812   /// intrinsics.
0813   bool forceScalarizeMaskedScatter(VectorType *Type, Align Alignment) const;
0814 
0815   /// Return true if the target supports masked compress store.
0816   bool isLegalMaskedCompressStore(Type *DataType, Align Alignment) const;
0817   /// Return true if the target supports masked expand load.
0818   bool isLegalMaskedExpandLoad(Type *DataType, Align Alignment) const;
0819 
0820   /// Return true if the target supports strided load.
0821   bool isLegalStridedLoadStore(Type *DataType, Align Alignment) const;
0822 
0823   /// Return true is the target supports interleaved access for the given vector
0824   /// type \p VTy, interleave factor \p Factor, alignment \p Alignment and
0825   /// address space \p AddrSpace.
0826   bool isLegalInterleavedAccessType(VectorType *VTy, unsigned Factor,
0827                                     Align Alignment, unsigned AddrSpace) const;
0828 
0829   // Return true if the target supports masked vector histograms.
0830   bool isLegalMaskedVectorHistogram(Type *AddrType, Type *DataType) const;
0831 
0832   /// Return true if this is an alternating opcode pattern that can be lowered
0833   /// to a single instruction on the target. In X86 this is for the addsub
0834   /// instruction which corrsponds to a Shuffle + Fadd + FSub pattern in IR.
0835   /// This function expectes two opcodes: \p Opcode1 and \p Opcode2 being
0836   /// selected by \p OpcodeMask. The mask contains one bit per lane and is a `0`
0837   /// when \p Opcode0 is selected and `1` when Opcode1 is selected.
0838   /// \p VecTy is the vector type of the instruction to be generated.
0839   bool isLegalAltInstr(VectorType *VecTy, unsigned Opcode0, unsigned Opcode1,
0840                        const SmallBitVector &OpcodeMask) const;
0841 
0842   /// Return true if we should be enabling ordered reductions for the target.
0843   bool enableOrderedReductions() const;
0844 
0845   /// Return true if the target has a unified operation to calculate division
0846   /// and remainder. If so, the additional implicit multiplication and
0847   /// subtraction required to calculate a remainder from division are free. This
0848   /// can enable more aggressive transformations for division and remainder than
0849   /// would typically be allowed using throughput or size cost models.
0850   bool hasDivRemOp(Type *DataType, bool IsSigned) const;
0851 
0852   /// Return true if the given instruction (assumed to be a memory access
0853   /// instruction) has a volatile variant. If that's the case then we can avoid
0854   /// addrspacecast to generic AS for volatile loads/stores. Default
0855   /// implementation returns false, which prevents address space inference for
0856   /// volatile loads/stores.
0857   bool hasVolatileVariant(Instruction *I, unsigned AddrSpace) const;
0858 
0859   /// Return true if target doesn't mind addresses in vectors.
0860   bool prefersVectorizedAddressing() const;
0861 
0862   /// Return the cost of the scaling factor used in the addressing
0863   /// mode represented by AM for this target, for a load/store
0864   /// of the specified type.
0865   /// If the AM is supported, the return value must be >= 0.
0866   /// If the AM is not supported, it returns a negative value.
0867   /// TODO: Handle pre/postinc as well.
0868   InstructionCost getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
0869                                        StackOffset BaseOffset, bool HasBaseReg,
0870                                        int64_t Scale,
0871                                        unsigned AddrSpace = 0) const;
0872 
0873   /// Return true if the loop strength reduce pass should make
0874   /// Instruction* based TTI queries to isLegalAddressingMode(). This is
0875   /// needed on SystemZ, where e.g. a memcpy can only have a 12 bit unsigned
0876   /// immediate offset and no index register.
0877   bool LSRWithInstrQueries() const;
0878 
0879   /// Return true if it's free to truncate a value of type Ty1 to type
0880   /// Ty2. e.g. On x86 it's free to truncate a i32 value in register EAX to i16
0881   /// by referencing its sub-register AX.
0882   bool isTruncateFree(Type *Ty1, Type *Ty2) const;
0883 
0884   /// Return true if it is profitable to hoist instruction in the
0885   /// then/else to before if.
0886   bool isProfitableToHoist(Instruction *I) const;
0887 
0888   bool useAA() const;
0889 
0890   /// Return true if this type is legal.
0891   bool isTypeLegal(Type *Ty) const;
0892 
0893   /// Returns the estimated number of registers required to represent \p Ty.
0894   unsigned getRegUsageForType(Type *Ty) const;
0895 
0896   /// Return true if switches should be turned into lookup tables for the
0897   /// target.
0898   bool shouldBuildLookupTables() const;
0899 
0900   /// Return true if switches should be turned into lookup tables
0901   /// containing this constant value for the target.
0902   bool shouldBuildLookupTablesForConstant(Constant *C) const;
0903 
0904   /// Return true if lookup tables should be turned into relative lookup tables.
0905   bool shouldBuildRelLookupTables() const;
0906 
0907   /// Return true if the input function which is cold at all call sites,
0908   ///  should use coldcc calling convention.
0909   bool useColdCCForColdCall(Function &F) const;
0910 
0911   bool isTargetIntrinsicTriviallyScalarizable(Intrinsic::ID ID) const;
0912 
0913   /// Identifies if the vector form of the intrinsic has a scalar operand.
0914   bool isTargetIntrinsicWithScalarOpAtArg(Intrinsic::ID ID,
0915                                           unsigned ScalarOpdIdx) const;
0916 
0917   /// Identifies if the vector form of the intrinsic is overloaded on the type
0918   /// of the operand at index \p OpdIdx, or on the return type if \p OpdIdx is
0919   /// -1.
0920   bool isTargetIntrinsicWithOverloadTypeAtArg(Intrinsic::ID ID,
0921                                               int OpdIdx) const;
0922 
0923   /// Identifies if the vector form of the intrinsic that returns a struct is
0924   /// overloaded at the struct element index \p RetIdx.
0925   bool isTargetIntrinsicWithStructReturnOverloadAtField(Intrinsic::ID ID,
0926                                                         int RetIdx) const;
0927 
0928   /// Estimate the overhead of scalarizing an instruction. Insert and Extract
0929   /// are set if the demanded result elements need to be inserted and/or
0930   /// extracted from vectors.  The involved values may be passed in VL if
0931   /// Insert is true.
0932   InstructionCost getScalarizationOverhead(VectorType *Ty,
0933                                            const APInt &DemandedElts,
0934                                            bool Insert, bool Extract,
0935                                            TTI::TargetCostKind CostKind,
0936                                            ArrayRef<Value *> VL = {}) const;
0937 
0938   /// Estimate the overhead of scalarizing an instructions unique
0939   /// non-constant operands. The (potentially vector) types to use for each of
0940   /// argument are passes via Tys.
0941   InstructionCost
0942   getOperandsScalarizationOverhead(ArrayRef<const Value *> Args,
0943                                    ArrayRef<Type *> Tys,
0944                                    TTI::TargetCostKind CostKind) const;
0945 
0946   /// If target has efficient vector element load/store instructions, it can
0947   /// return true here so that insertion/extraction costs are not added to
0948   /// the scalarization cost of a load/store.
0949   bool supportsEfficientVectorElementLoadStore() const;
0950 
0951   /// If the target supports tail calls.
0952   bool supportsTailCalls() const;
0953 
0954   /// If target supports tail call on \p CB
0955   bool supportsTailCallFor(const CallBase *CB) const;
0956 
0957   /// Don't restrict interleaved unrolling to small loops.
0958   bool enableAggressiveInterleaving(bool LoopHasReductions) const;
0959 
0960   /// Returns options for expansion of memcmp. IsZeroCmp is
0961   // true if this is the expansion of memcmp(p1, p2, s) == 0.
0962   struct MemCmpExpansionOptions {
0963     // Return true if memcmp expansion is enabled.
0964     operator bool() const { return MaxNumLoads > 0; }
0965 
0966     // Maximum number of load operations.
0967     unsigned MaxNumLoads = 0;
0968 
0969     // The list of available load sizes (in bytes), sorted in decreasing order.
0970     SmallVector<unsigned, 8> LoadSizes;
0971 
0972     // For memcmp expansion when the memcmp result is only compared equal or
0973     // not-equal to 0, allow up to this number of load pairs per block. As an
0974     // example, this may allow 'memcmp(a, b, 3) == 0' in a single block:
0975     //   a0 = load2bytes &a[0]
0976     //   b0 = load2bytes &b[0]
0977     //   a2 = load1byte  &a[2]
0978     //   b2 = load1byte  &b[2]
0979     //   r  = cmp eq (a0 ^ b0 | a2 ^ b2), 0
0980     unsigned NumLoadsPerBlock = 1;
0981 
0982     // Set to true to allow overlapping loads. For example, 7-byte compares can
0983     // be done with two 4-byte compares instead of 4+2+1-byte compares. This
0984     // requires all loads in LoadSizes to be doable in an unaligned way.
0985     bool AllowOverlappingLoads = false;
0986 
0987     // Sometimes, the amount of data that needs to be compared is smaller than
0988     // the standard register size, but it cannot be loaded with just one load
0989     // instruction. For example, if the size of the memory comparison is 6
0990     // bytes, we can handle it more efficiently by loading all 6 bytes in a
0991     // single block and generating an 8-byte number, instead of generating two
0992     // separate blocks with conditional jumps for 4 and 2 byte loads. This
0993     // approach simplifies the process and produces the comparison result as
0994     // normal. This array lists the allowed sizes of memcmp tails that can be
0995     // merged into one block
0996     SmallVector<unsigned, 4> AllowedTailExpansions;
0997   };
0998   MemCmpExpansionOptions enableMemCmpExpansion(bool OptSize,
0999                                                bool IsZeroCmp) const;
1000 
1001   /// Should the Select Optimization pass be enabled and ran.
1002   bool enableSelectOptimize() const;
1003 
1004   /// Should the Select Optimization pass treat the given instruction like a
1005   /// select, potentially converting it to a conditional branch. This can
1006   /// include select-like instructions like or(zext(c), x) that can be converted
1007   /// to selects.
1008   bool shouldTreatInstructionLikeSelect(const Instruction *I) const;
1009 
1010   /// Enable matching of interleaved access groups.
1011   bool enableInterleavedAccessVectorization() const;
1012 
1013   /// Enable matching of interleaved access groups that contain predicated
1014   /// accesses or gaps and therefore vectorized using masked
1015   /// vector loads/stores.
1016   bool enableMaskedInterleavedAccessVectorization() const;
1017 
1018   /// Indicate that it is potentially unsafe to automatically vectorize
1019   /// floating-point operations because the semantics of vector and scalar
1020   /// floating-point semantics may differ. For example, ARM NEON v7 SIMD math
1021   /// does not support IEEE-754 denormal numbers, while depending on the
1022   /// platform, scalar floating-point math does.
1023   /// This applies to floating-point math operations and calls, not memory
1024   /// operations, shuffles, or casts.
1025   bool isFPVectorizationPotentiallyUnsafe() const;
1026 
1027   /// Determine if the target supports unaligned memory accesses.
1028   bool allowsMisalignedMemoryAccesses(LLVMContext &Context, unsigned BitWidth,
1029                                       unsigned AddressSpace = 0,
1030                                       Align Alignment = Align(1),
1031                                       unsigned *Fast = nullptr) const;
1032 
1033   /// Return hardware support for population count.
1034   PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) const;
1035 
1036   /// Return true if the hardware has a fast square-root instruction.
1037   bool haveFastSqrt(Type *Ty) const;
1038 
1039   /// Return true if the cost of the instruction is too high to speculatively
1040   /// execute and should be kept behind a branch.
1041   /// This normally just wraps around a getInstructionCost() call, but some
1042   /// targets might report a low TCK_SizeAndLatency value that is incompatible
1043   /// with the fixed TCC_Expensive value.
1044   /// NOTE: This assumes the instruction passes isSafeToSpeculativelyExecute().
1045   bool isExpensiveToSpeculativelyExecute(const Instruction *I) const;
1046 
1047   /// Return true if it is faster to check if a floating-point value is NaN
1048   /// (or not-NaN) versus a comparison against a constant FP zero value.
1049   /// Targets should override this if materializing a 0.0 for comparison is
1050   /// generally as cheap as checking for ordered/unordered.
1051   bool isFCmpOrdCheaperThanFCmpZero(Type *Ty) const;
1052 
1053   /// Return the expected cost of supporting the floating point operation
1054   /// of the specified type.
1055   InstructionCost getFPOpCost(Type *Ty) const;
1056 
1057   /// Return the expected cost of materializing for the given integer
1058   /// immediate of the specified type.
1059   InstructionCost getIntImmCost(const APInt &Imm, Type *Ty,
1060                                 TargetCostKind CostKind) const;
1061 
1062   /// Return the expected cost of materialization for the given integer
1063   /// immediate of the specified type for a given instruction. The cost can be
1064   /// zero if the immediate can be folded into the specified instruction.
1065   InstructionCost getIntImmCostInst(unsigned Opc, unsigned Idx,
1066                                     const APInt &Imm, Type *Ty,
1067                                     TargetCostKind CostKind,
1068                                     Instruction *Inst = nullptr) const;
1069   InstructionCost getIntImmCostIntrin(Intrinsic::ID IID, unsigned Idx,
1070                                       const APInt &Imm, Type *Ty,
1071                                       TargetCostKind CostKind) const;
1072 
1073   /// Return the expected cost for the given integer when optimising
1074   /// for size. This is different than the other integer immediate cost
1075   /// functions in that it is subtarget agnostic. This is useful when you e.g.
1076   /// target one ISA such as Aarch32 but smaller encodings could be possible
1077   /// with another such as Thumb. This return value is used as a penalty when
1078   /// the total costs for a constant is calculated (the bigger the cost, the
1079   /// more beneficial constant hoisting is).
1080   InstructionCost getIntImmCodeSizeCost(unsigned Opc, unsigned Idx,
1081                                         const APInt &Imm, Type *Ty) const;
1082 
1083   /// It can be advantageous to detach complex constants from their uses to make
1084   /// their generation cheaper. This hook allows targets to report when such
1085   /// transformations might negatively effect the code generation of the
1086   /// underlying operation. The motivating example is divides whereby hoisting
1087   /// constants prevents the code generator's ability to transform them into
1088   /// combinations of simpler operations.
1089   bool preferToKeepConstantsAttached(const Instruction &Inst,
1090                                      const Function &Fn) const;
1091 
1092   /// @}
1093 
1094   /// \name Vector Target Information
1095   /// @{
1096 
1097   /// The various kinds of shuffle patterns for vector queries.
1098   enum ShuffleKind {
1099     SK_Broadcast,        ///< Broadcast element 0 to all other elements.
1100     SK_Reverse,          ///< Reverse the order of the vector.
1101     SK_Select,           ///< Selects elements from the corresponding lane of
1102                          ///< either source operand. This is equivalent to a
1103                          ///< vector select with a constant condition operand.
1104     SK_Transpose,        ///< Transpose two vectors.
1105     SK_InsertSubvector,  ///< InsertSubvector. Index indicates start offset.
1106     SK_ExtractSubvector, ///< ExtractSubvector Index indicates start offset.
1107     SK_PermuteTwoSrc,    ///< Merge elements from two source vectors into one
1108                          ///< with any shuffle mask.
1109     SK_PermuteSingleSrc, ///< Shuffle elements of single source vector with any
1110                          ///< shuffle mask.
1111     SK_Splice            ///< Concatenates elements from the first input vector
1112                          ///< with elements of the second input vector. Returning
1113                          ///< a vector of the same type as the input vectors.
1114                          ///< Index indicates start offset in first input vector.
1115   };
1116 
1117   /// Additional information about an operand's possible values.
1118   enum OperandValueKind {
1119     OK_AnyValue,               // Operand can have any value.
1120     OK_UniformValue,           // Operand is uniform (splat of a value).
1121     OK_UniformConstantValue,   // Operand is uniform constant.
1122     OK_NonUniformConstantValue // Operand is a non uniform constant value.
1123   };
1124 
1125   /// Additional properties of an operand's values.
1126   enum OperandValueProperties {
1127     OP_None = 0,
1128     OP_PowerOf2 = 1,
1129     OP_NegatedPowerOf2 = 2,
1130   };
1131 
1132   // Describe the values an operand can take.  We're in the process
1133   // of migrating uses of OperandValueKind and OperandValueProperties
1134   // to use this class, and then will change the internal representation.
1135   struct OperandValueInfo {
1136     OperandValueKind Kind = OK_AnyValue;
1137     OperandValueProperties Properties = OP_None;
1138 
1139     bool isConstant() const {
1140       return Kind == OK_UniformConstantValue || Kind == OK_NonUniformConstantValue;
1141     }
1142     bool isUniform() const {
1143       return Kind == OK_UniformConstantValue || Kind == OK_UniformValue;
1144     }
1145     bool isPowerOf2() const {
1146       return Properties == OP_PowerOf2;
1147     }
1148     bool isNegatedPowerOf2() const {
1149       return Properties == OP_NegatedPowerOf2;
1150     }
1151 
1152     OperandValueInfo getNoProps() const {
1153       return {Kind, OP_None};
1154     }
1155   };
1156 
1157   /// \return the number of registers in the target-provided register class.
1158   unsigned getNumberOfRegisters(unsigned ClassID) const;
1159 
1160   /// \return true if the target supports load/store that enables fault
1161   /// suppression of memory operands when the source condition is false.
1162   bool hasConditionalLoadStoreForType(Type *Ty = nullptr) const;
1163 
1164   /// \return the target-provided register class ID for the provided type,
1165   /// accounting for type promotion and other type-legalization techniques that
1166   /// the target might apply. However, it specifically does not account for the
1167   /// scalarization or splitting of vector types. Should a vector type require
1168   /// scalarization or splitting into multiple underlying vector registers, that
1169   /// type should be mapped to a register class containing no registers.
1170   /// Specifically, this is designed to provide a simple, high-level view of the
1171   /// register allocation later performed by the backend. These register classes
1172   /// don't necessarily map onto the register classes used by the backend.
1173   /// FIXME: It's not currently possible to determine how many registers
1174   /// are used by the provided type.
1175   unsigned getRegisterClassForType(bool Vector, Type *Ty = nullptr) const;
1176 
1177   /// \return the target-provided register class name
1178   const char *getRegisterClassName(unsigned ClassID) const;
1179 
1180   enum RegisterKind { RGK_Scalar, RGK_FixedWidthVector, RGK_ScalableVector };
1181 
1182   /// \return The width of the largest scalar or vector register type.
1183   TypeSize getRegisterBitWidth(RegisterKind K) const;
1184 
1185   /// \return The width of the smallest vector register type.
1186   unsigned getMinVectorRegisterBitWidth() const;
1187 
1188   /// \return The maximum value of vscale if the target specifies an
1189   ///  architectural maximum vector length, and std::nullopt otherwise.
1190   std::optional<unsigned> getMaxVScale() const;
1191 
1192   /// \return the value of vscale to tune the cost model for.
1193   std::optional<unsigned> getVScaleForTuning() const;
1194 
1195   /// \return true if vscale is known to be a power of 2
1196   bool isVScaleKnownToBeAPowerOfTwo() const;
1197 
1198   /// \return True if the vectorization factor should be chosen to
1199   /// make the vector of the smallest element type match the size of a
1200   /// vector register. For wider element types, this could result in
1201   /// creating vectors that span multiple vector registers.
1202   /// If false, the vectorization factor will be chosen based on the
1203   /// size of the widest element type.
1204   /// \p K Register Kind for vectorization.
1205   bool shouldMaximizeVectorBandwidth(TargetTransformInfo::RegisterKind K) const;
1206 
1207   /// \return The minimum vectorization factor for types of given element
1208   /// bit width, or 0 if there is no minimum VF. The returned value only
1209   /// applies when shouldMaximizeVectorBandwidth returns true.
1210   /// If IsScalable is true, the returned ElementCount must be a scalable VF.
1211   ElementCount getMinimumVF(unsigned ElemWidth, bool IsScalable) const;
1212 
1213   /// \return The maximum vectorization factor for types of given element
1214   /// bit width and opcode, or 0 if there is no maximum VF.
1215   /// Currently only used by the SLP vectorizer.
1216   unsigned getMaximumVF(unsigned ElemWidth, unsigned Opcode) const;
1217 
1218   /// \return The minimum vectorization factor for the store instruction. Given
1219   /// the initial estimation of the minimum vector factor and store value type,
1220   /// it tries to find possible lowest VF, which still might be profitable for
1221   /// the vectorization.
1222   /// \param VF Initial estimation of the minimum vector factor.
1223   /// \param ScalarMemTy Scalar memory type of the store operation.
1224   /// \param ScalarValTy Scalar type of the stored value.
1225   /// Currently only used by the SLP vectorizer.
1226   unsigned getStoreMinimumVF(unsigned VF, Type *ScalarMemTy,
1227                              Type *ScalarValTy) const;
1228 
1229   /// \return True if it should be considered for address type promotion.
1230   /// \p AllowPromotionWithoutCommonHeader Set true if promoting \p I is
1231   /// profitable without finding other extensions fed by the same input.
1232   bool shouldConsiderAddressTypePromotion(
1233       const Instruction &I, bool &AllowPromotionWithoutCommonHeader) const;
1234 
1235   /// \return The size of a cache line in bytes.
1236   unsigned getCacheLineSize() const;
1237 
1238   /// The possible cache levels
1239   enum class CacheLevel {
1240     L1D, // The L1 data cache
1241     L2D, // The L2 data cache
1242 
1243     // We currently do not model L3 caches, as their sizes differ widely between
1244     // microarchitectures. Also, we currently do not have a use for L3 cache
1245     // size modeling yet.
1246   };
1247 
1248   /// \return The size of the cache level in bytes, if available.
1249   std::optional<unsigned> getCacheSize(CacheLevel Level) const;
1250 
1251   /// \return The associativity of the cache level, if available.
1252   std::optional<unsigned> getCacheAssociativity(CacheLevel Level) const;
1253 
1254   /// \return The minimum architectural page size for the target.
1255   std::optional<unsigned> getMinPageSize() const;
1256 
1257   /// \return How much before a load we should place the prefetch
1258   /// instruction.  This is currently measured in number of
1259   /// instructions.
1260   unsigned getPrefetchDistance() const;
1261 
1262   /// Some HW prefetchers can handle accesses up to a certain constant stride.
1263   /// Sometimes prefetching is beneficial even below the HW prefetcher limit,
1264   /// and the arguments provided are meant to serve as a basis for deciding this
1265   /// for a particular loop.
1266   ///
1267   /// \param NumMemAccesses        Number of memory accesses in the loop.
1268   /// \param NumStridedMemAccesses Number of the memory accesses that
1269   ///                              ScalarEvolution could find a known stride
1270   ///                              for.
1271   /// \param NumPrefetches         Number of software prefetches that will be
1272   ///                              emitted as determined by the addresses
1273   ///                              involved and the cache line size.
1274   /// \param HasCall               True if the loop contains a call.
1275   ///
1276   /// \return This is the minimum stride in bytes where it makes sense to start
1277   ///         adding SW prefetches. The default is 1, i.e. prefetch with any
1278   ///         stride.
1279   unsigned getMinPrefetchStride(unsigned NumMemAccesses,
1280                                 unsigned NumStridedMemAccesses,
1281                                 unsigned NumPrefetches, bool HasCall) const;
1282 
1283   /// \return The maximum number of iterations to prefetch ahead.  If
1284   /// the required number of iterations is more than this number, no
1285   /// prefetching is performed.
1286   unsigned getMaxPrefetchIterationsAhead() const;
1287 
1288   /// \return True if prefetching should also be done for writes.
1289   bool enableWritePrefetching() const;
1290 
1291   /// \return if target want to issue a prefetch in address space \p AS.
1292   bool shouldPrefetchAddressSpace(unsigned AS) const;
1293 
1294   /// \return The cost of a partial reduction, which is a reduction from a
1295   /// vector to another vector with fewer elements of larger size. They are
1296   /// represented by the llvm.experimental.partial.reduce.add intrinsic, which
1297   /// takes an accumulator and a binary operation operand that itself is fed by
1298   /// two extends. An example of an operation that uses a partial reduction is a
1299   /// dot product, which reduces two vectors to another of 4 times fewer and 4
1300   /// times larger elements.
1301   InstructionCost
1302   getPartialReductionCost(unsigned Opcode, Type *InputTypeA, Type *InputTypeB,
1303                           Type *AccumType, ElementCount VF,
1304                           PartialReductionExtendKind OpAExtend,
1305                           PartialReductionExtendKind OpBExtend,
1306                           std::optional<unsigned> BinOp = std::nullopt) const;
1307 
1308   /// \return The maximum interleave factor that any transform should try to
1309   /// perform for this target. This number depends on the level of parallelism
1310   /// and the number of execution units in the CPU.
1311   unsigned getMaxInterleaveFactor(ElementCount VF) const;
1312 
1313   /// Collect properties of V used in cost analysis, e.g. OP_PowerOf2.
1314   static OperandValueInfo getOperandInfo(const Value *V);
1315 
1316   /// This is an approximation of reciprocal throughput of a math/logic op.
1317   /// A higher cost indicates less expected throughput.
1318   /// From Agner Fog's guides, reciprocal throughput is "the average number of
1319   /// clock cycles per instruction when the instructions are not part of a
1320   /// limiting dependency chain."
1321   /// Therefore, costs should be scaled to account for multiple execution units
1322   /// on the target that can process this type of instruction. For example, if
1323   /// there are 5 scalar integer units and 2 vector integer units that can
1324   /// calculate an 'add' in a single cycle, this model should indicate that the
1325   /// cost of the vector add instruction is 2.5 times the cost of the scalar
1326   /// add instruction.
1327   /// \p Args is an optional argument which holds the instruction operands
1328   /// values so the TTI can analyze those values searching for special
1329   /// cases or optimizations based on those values.
1330   /// \p CxtI is the optional original context instruction, if one exists, to
1331   /// provide even more information.
1332   /// \p TLibInfo is used to search for platform specific vector library
1333   /// functions for instructions that might be converted to calls (e.g. frem).
1334   InstructionCost getArithmeticInstrCost(
1335       unsigned Opcode, Type *Ty,
1336       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1337       TTI::OperandValueInfo Opd1Info = {TTI::OK_AnyValue, TTI::OP_None},
1338       TTI::OperandValueInfo Opd2Info = {TTI::OK_AnyValue, TTI::OP_None},
1339       ArrayRef<const Value *> Args = {}, const Instruction *CxtI = nullptr,
1340       const TargetLibraryInfo *TLibInfo = nullptr) const;
1341 
1342   /// Returns the cost estimation for alternating opcode pattern that can be
1343   /// lowered to a single instruction on the target. In X86 this is for the
1344   /// addsub instruction which corrsponds to a Shuffle + Fadd + FSub pattern in
1345   /// IR. This function expects two opcodes: \p Opcode1 and \p Opcode2 being
1346   /// selected by \p OpcodeMask. The mask contains one bit per lane and is a `0`
1347   /// when \p Opcode0 is selected and `1` when Opcode1 is selected.
1348   /// \p VecTy is the vector type of the instruction to be generated.
1349   InstructionCost getAltInstrCost(
1350       VectorType *VecTy, unsigned Opcode0, unsigned Opcode1,
1351       const SmallBitVector &OpcodeMask,
1352       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1353 
1354   /// \return The cost of a shuffle instruction of kind Kind and of type Tp.
1355   /// The exact mask may be passed as Mask, or else the array will be empty.
1356   /// The index and subtype parameters are used by the subvector insertion and
1357   /// extraction shuffle kinds to show the insert/extract point and the type of
1358   /// the subvector being inserted/extracted. The operands of the shuffle can be
1359   /// passed through \p Args, which helps improve the cost estimation in some
1360   /// cases, like in broadcast loads.
1361   /// NOTE: For subvector extractions Tp represents the source type.
1362   InstructionCost
1363   getShuffleCost(ShuffleKind Kind, VectorType *Tp, ArrayRef<int> Mask = {},
1364                  TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1365                  int Index = 0, VectorType *SubTp = nullptr,
1366                  ArrayRef<const Value *> Args = {},
1367                  const Instruction *CxtI = nullptr) const;
1368 
1369   /// Represents a hint about the context in which a cast is used.
1370   ///
1371   /// For zext/sext, the context of the cast is the operand, which must be a
1372   /// load of some kind. For trunc, the context is of the cast is the single
1373   /// user of the instruction, which must be a store of some kind.
1374   ///
1375   /// This enum allows the vectorizer to give getCastInstrCost an idea of the
1376   /// type of cast it's dealing with, as not every cast is equal. For instance,
1377   /// the zext of a load may be free, but the zext of an interleaving load can
1378   //// be (very) expensive!
1379   ///
1380   /// See \c getCastContextHint to compute a CastContextHint from a cast
1381   /// Instruction*. Callers can use it if they don't need to override the
1382   /// context and just want it to be calculated from the instruction.
1383   ///
1384   /// FIXME: This handles the types of load/store that the vectorizer can
1385   /// produce, which are the cases where the context instruction is most
1386   /// likely to be incorrect. There are other situations where that can happen
1387   /// too, which might be handled here but in the long run a more general
1388   /// solution of costing multiple instructions at the same times may be better.
1389   enum class CastContextHint : uint8_t {
1390     None,          ///< The cast is not used with a load/store of any kind.
1391     Normal,        ///< The cast is used with a normal load/store.
1392     Masked,        ///< The cast is used with a masked load/store.
1393     GatherScatter, ///< The cast is used with a gather/scatter.
1394     Interleave,    ///< The cast is used with an interleaved load/store.
1395     Reversed,      ///< The cast is used with a reversed load/store.
1396   };
1397 
1398   /// Calculates a CastContextHint from \p I.
1399   /// This should be used by callers of getCastInstrCost if they wish to
1400   /// determine the context from some instruction.
1401   /// \returns the CastContextHint for ZExt/SExt/Trunc, None if \p I is nullptr,
1402   /// or if it's another type of cast.
1403   static CastContextHint getCastContextHint(const Instruction *I);
1404 
1405   /// \return The expected cost of cast instructions, such as bitcast, trunc,
1406   /// zext, etc. If there is an existing instruction that holds Opcode, it
1407   /// may be passed in the 'I' parameter.
1408   InstructionCost
1409   getCastInstrCost(unsigned Opcode, Type *Dst, Type *Src,
1410                    TTI::CastContextHint CCH,
1411                    TTI::TargetCostKind CostKind = TTI::TCK_SizeAndLatency,
1412                    const Instruction *I = nullptr) const;
1413 
1414   /// \return The expected cost of a sign- or zero-extended vector extract. Use
1415   /// Index = -1 to indicate that there is no information about the index value.
1416   InstructionCost getExtractWithExtendCost(unsigned Opcode, Type *Dst,
1417                                            VectorType *VecTy,
1418                                            unsigned Index) const;
1419 
1420   /// \return The expected cost of control-flow related instructions such as
1421   /// Phi, Ret, Br, Switch.
1422   InstructionCost
1423   getCFInstrCost(unsigned Opcode,
1424                  TTI::TargetCostKind CostKind = TTI::TCK_SizeAndLatency,
1425                  const Instruction *I = nullptr) const;
1426 
1427   /// \returns The expected cost of compare and select instructions. If there
1428   /// is an existing instruction that holds Opcode, it may be passed in the
1429   /// 'I' parameter. The \p VecPred parameter can be used to indicate the select
1430   /// is using a compare with the specified predicate as condition. When vector
1431   /// types are passed, \p VecPred must be used for all lanes.  For a
1432   /// comparison, the two operands are the natural values.  For a select, the
1433   /// two operands are the *value* operands, not the condition operand.
1434   InstructionCost
1435   getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy,
1436                      CmpInst::Predicate VecPred,
1437                      TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1438                      OperandValueInfo Op1Info = {OK_AnyValue, OP_None},
1439                      OperandValueInfo Op2Info = {OK_AnyValue, OP_None},
1440                      const Instruction *I = nullptr) const;
1441 
1442   /// \return The expected cost of vector Insert and Extract.
1443   /// Use -1 to indicate that there is no information on the index value.
1444   /// This is used when the instruction is not available; a typical use
1445   /// case is to provision the cost of vectorization/scalarization in
1446   /// vectorizer passes.
1447   InstructionCost getVectorInstrCost(unsigned Opcode, Type *Val,
1448                                      TTI::TargetCostKind CostKind,
1449                                      unsigned Index = -1, Value *Op0 = nullptr,
1450                                      Value *Op1 = nullptr) const;
1451 
1452   /// \return The expected cost of vector Insert and Extract.
1453   /// Use -1 to indicate that there is no information on the index value.
1454   /// This is used when the instruction is not available; a typical use
1455   /// case is to provision the cost of vectorization/scalarization in
1456   /// vectorizer passes.
1457   /// \param ScalarUserAndIdx encodes the information about extracts from a
1458   /// vector with 'Scalar' being the value being extracted,'User' being the user
1459   /// of the extract(nullptr if user is not known before vectorization) and
1460   /// 'Idx' being the extract lane.
1461   InstructionCost getVectorInstrCost(
1462       unsigned Opcode, Type *Val, TTI::TargetCostKind CostKind, unsigned Index,
1463       Value *Scalar,
1464       ArrayRef<std::tuple<Value *, User *, int>> ScalarUserAndIdx) const;
1465 
1466   /// \return The expected cost of vector Insert and Extract.
1467   /// This is used when instruction is available, and implementation
1468   /// asserts 'I' is not nullptr.
1469   ///
1470   /// A typical suitable use case is cost estimation when vector instruction
1471   /// exists (e.g., from basic blocks during transformation).
1472   InstructionCost getVectorInstrCost(const Instruction &I, Type *Val,
1473                                      TTI::TargetCostKind CostKind,
1474                                      unsigned Index = -1) const;
1475 
1476   /// \return The cost of replication shuffle of \p VF elements typed \p EltTy
1477   /// \p ReplicationFactor times.
1478   ///
1479   /// For example, the mask for \p ReplicationFactor=3 and \p VF=4 is:
1480   ///   <0,0,0,1,1,1,2,2,2,3,3,3>
1481   InstructionCost getReplicationShuffleCost(Type *EltTy, int ReplicationFactor,
1482                                             int VF,
1483                                             const APInt &DemandedDstElts,
1484                                             TTI::TargetCostKind CostKind) const;
1485 
1486   /// \return The cost of Load and Store instructions.
1487   InstructionCost
1488   getMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
1489                   unsigned AddressSpace,
1490                   TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1491                   OperandValueInfo OpdInfo = {OK_AnyValue, OP_None},
1492                   const Instruction *I = nullptr) const;
1493 
1494   /// \return The cost of VP Load and Store instructions.
1495   InstructionCost
1496   getVPMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
1497                     unsigned AddressSpace,
1498                     TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1499                     const Instruction *I = nullptr) const;
1500 
1501   /// \return The cost of masked Load and Store instructions.
1502   InstructionCost getMaskedMemoryOpCost(
1503       unsigned Opcode, Type *Src, Align Alignment, unsigned AddressSpace,
1504       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1505 
1506   /// \return The cost of Gather or Scatter operation
1507   /// \p Opcode - is a type of memory access Load or Store
1508   /// \p DataTy - a vector type of the data to be loaded or stored
1509   /// \p Ptr - pointer [or vector of pointers] - address[es] in memory
1510   /// \p VariableMask - true when the memory access is predicated with a mask
1511   ///                   that is not a compile-time constant
1512   /// \p Alignment - alignment of single element
1513   /// \p I - the optional original context instruction, if one exists, e.g. the
1514   ///        load/store to transform or the call to the gather/scatter intrinsic
1515   InstructionCost getGatherScatterOpCost(
1516       unsigned Opcode, Type *DataTy, const Value *Ptr, bool VariableMask,
1517       Align Alignment, TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1518       const Instruction *I = nullptr) const;
1519 
1520   /// \return The cost of strided memory operations.
1521   /// \p Opcode - is a type of memory access Load or Store
1522   /// \p DataTy - a vector type of the data to be loaded or stored
1523   /// \p Ptr - pointer [or vector of pointers] - address[es] in memory
1524   /// \p VariableMask - true when the memory access is predicated with a mask
1525   ///                   that is not a compile-time constant
1526   /// \p Alignment - alignment of single element
1527   /// \p I - the optional original context instruction, if one exists, e.g. the
1528   ///        load/store to transform or the call to the gather/scatter intrinsic
1529   InstructionCost getStridedMemoryOpCost(
1530       unsigned Opcode, Type *DataTy, const Value *Ptr, bool VariableMask,
1531       Align Alignment, TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1532       const Instruction *I = nullptr) const;
1533 
1534   /// \return The cost of the interleaved memory operation.
1535   /// \p Opcode is the memory operation code
1536   /// \p VecTy is the vector type of the interleaved access.
1537   /// \p Factor is the interleave factor
1538   /// \p Indices is the indices for interleaved load members (as interleaved
1539   ///    load allows gaps)
1540   /// \p Alignment is the alignment of the memory operation
1541   /// \p AddressSpace is address space of the pointer.
1542   /// \p UseMaskForCond indicates if the memory access is predicated.
1543   /// \p UseMaskForGaps indicates if gaps should be masked.
1544   InstructionCost getInterleavedMemoryOpCost(
1545       unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
1546       Align Alignment, unsigned AddressSpace,
1547       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput,
1548       bool UseMaskForCond = false, bool UseMaskForGaps = false) const;
1549 
1550   /// A helper function to determine the type of reduction algorithm used
1551   /// for a given \p Opcode and set of FastMathFlags \p FMF.
1552   static bool requiresOrderedReduction(std::optional<FastMathFlags> FMF) {
1553     return FMF && !(*FMF).allowReassoc();
1554   }
1555 
1556   /// Calculate the cost of vector reduction intrinsics.
1557   ///
1558   /// This is the cost of reducing the vector value of type \p Ty to a scalar
1559   /// value using the operation denoted by \p Opcode. The FastMathFlags
1560   /// parameter \p FMF indicates what type of reduction we are performing:
1561   ///   1. Tree-wise. This is the typical 'fast' reduction performed that
1562   ///   involves successively splitting a vector into half and doing the
1563   ///   operation on the pair of halves until you have a scalar value. For
1564   ///   example:
1565   ///     (v0, v1, v2, v3)
1566   ///     ((v0+v2), (v1+v3), undef, undef)
1567   ///     ((v0+v2+v1+v3), undef, undef, undef)
1568   ///   This is the default behaviour for integer operations, whereas for
1569   ///   floating point we only do this if \p FMF indicates that
1570   ///   reassociation is allowed.
1571   ///   2. Ordered. For a vector with N elements this involves performing N
1572   ///   operations in lane order, starting with an initial scalar value, i.e.
1573   ///     result = InitVal + v0
1574   ///     result = result + v1
1575   ///     result = result + v2
1576   ///     result = result + v3
1577   ///   This is only the case for FP operations and when reassociation is not
1578   ///   allowed.
1579   ///
1580   InstructionCost getArithmeticReductionCost(
1581       unsigned Opcode, VectorType *Ty, std::optional<FastMathFlags> FMF,
1582       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1583 
1584   InstructionCost getMinMaxReductionCost(
1585       Intrinsic::ID IID, VectorType *Ty, FastMathFlags FMF = FastMathFlags(),
1586       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1587 
1588   /// Calculate the cost of an extended reduction pattern, similar to
1589   /// getArithmeticReductionCost of an Add reduction with multiply and optional
1590   /// extensions. This is the cost of as:
1591   /// ResTy vecreduce.add(mul (A, B)).
1592   /// ResTy vecreduce.add(mul(ext(Ty A), ext(Ty B)).
1593   InstructionCost getMulAccReductionCost(
1594       bool IsUnsigned, Type *ResTy, VectorType *Ty,
1595       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1596 
1597   /// Calculate the cost of an extended reduction pattern, similar to
1598   /// getArithmeticReductionCost of a reduction with an extension.
1599   /// This is the cost of as:
1600   /// ResTy vecreduce.opcode(ext(Ty A)).
1601   InstructionCost getExtendedReductionCost(
1602       unsigned Opcode, bool IsUnsigned, Type *ResTy, VectorType *Ty,
1603       FastMathFlags FMF,
1604       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const;
1605 
1606   /// \returns The cost of Intrinsic instructions. Analyses the real arguments.
1607   /// Three cases are handled: 1. scalar instruction 2. vector instruction
1608   /// 3. scalar instruction which is to be vectorized.
1609   InstructionCost getIntrinsicInstrCost(const IntrinsicCostAttributes &ICA,
1610                                         TTI::TargetCostKind CostKind) const;
1611 
1612   /// \returns The cost of Call instructions.
1613   InstructionCost getCallInstrCost(
1614       Function *F, Type *RetTy, ArrayRef<Type *> Tys,
1615       TTI::TargetCostKind CostKind = TTI::TCK_SizeAndLatency) const;
1616 
1617   /// \returns The number of pieces into which the provided type must be
1618   /// split during legalization. Zero is returned when the answer is unknown.
1619   unsigned getNumberOfParts(Type *Tp) const;
1620 
1621   /// \returns The cost of the address computation. For most targets this can be
1622   /// merged into the instruction indexing mode. Some targets might want to
1623   /// distinguish between address computation for memory operations on vector
1624   /// types and scalar types. Such targets should override this function.
1625   /// The 'SE' parameter holds pointer for the scalar evolution object which
1626   /// is used in order to get the Ptr step value in case of constant stride.
1627   /// The 'Ptr' parameter holds SCEV of the access pointer.
1628   InstructionCost getAddressComputationCost(Type *Ty,
1629                                             ScalarEvolution *SE = nullptr,
1630                                             const SCEV *Ptr = nullptr) const;
1631 
1632   /// \returns The cost, if any, of keeping values of the given types alive
1633   /// over a callsite.
1634   ///
1635   /// Some types may require the use of register classes that do not have
1636   /// any callee-saved registers, so would require a spill and fill.
1637   InstructionCost getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) const;
1638 
1639   /// \returns True if the intrinsic is a supported memory intrinsic.  Info
1640   /// will contain additional information - whether the intrinsic may write
1641   /// or read to memory, volatility and the pointer.  Info is undefined
1642   /// if false is returned.
1643   bool getTgtMemIntrinsic(IntrinsicInst *Inst, MemIntrinsicInfo &Info) const;
1644 
1645   /// \returns The maximum element size, in bytes, for an element
1646   /// unordered-atomic memory intrinsic.
1647   unsigned getAtomicMemIntrinsicMaxElementSize() const;
1648 
1649   /// \returns A value which is the result of the given memory intrinsic.  New
1650   /// instructions may be created to extract the result from the given intrinsic
1651   /// memory operation.  Returns nullptr if the target cannot create a result
1652   /// from the given intrinsic.
1653   Value *getOrCreateResultFromMemIntrinsic(IntrinsicInst *Inst,
1654                                            Type *ExpectedType) const;
1655 
1656   /// \returns The type to use in a loop expansion of a memcpy call.
1657   Type *getMemcpyLoopLoweringType(
1658       LLVMContext &Context, Value *Length, unsigned SrcAddrSpace,
1659       unsigned DestAddrSpace, Align SrcAlign, Align DestAlign,
1660       std::optional<uint32_t> AtomicElementSize = std::nullopt) const;
1661 
1662   /// \param[out] OpsOut The operand types to copy RemainingBytes of memory.
1663   /// \param RemainingBytes The number of bytes to copy.
1664   ///
1665   /// Calculates the operand types to use when copying \p RemainingBytes of
1666   /// memory, where source and destination alignments are \p SrcAlign and
1667   /// \p DestAlign respectively.
1668   void getMemcpyLoopResidualLoweringType(
1669       SmallVectorImpl<Type *> &OpsOut, LLVMContext &Context,
1670       unsigned RemainingBytes, unsigned SrcAddrSpace, unsigned DestAddrSpace,
1671       Align SrcAlign, Align DestAlign,
1672       std::optional<uint32_t> AtomicCpySize = std::nullopt) const;
1673 
1674   /// \returns True if the two functions have compatible attributes for inlining
1675   /// purposes.
1676   bool areInlineCompatible(const Function *Caller,
1677                            const Function *Callee) const;
1678 
1679   /// Returns a penalty for invoking call \p Call in \p F.
1680   /// For example, if a function F calls a function G, which in turn calls
1681   /// function H, then getInlineCallPenalty(F, H()) would return the
1682   /// penalty of calling H from F, e.g. after inlining G into F.
1683   /// \p DefaultCallPenalty is passed to give a default penalty that
1684   /// the target can amend or override.
1685   unsigned getInlineCallPenalty(const Function *F, const CallBase &Call,
1686                                 unsigned DefaultCallPenalty) const;
1687 
1688   /// \returns True if the caller and callee agree on how \p Types will be
1689   /// passed to or returned from the callee.
1690   /// to the callee.
1691   /// \param Types List of types to check.
1692   bool areTypesABICompatible(const Function *Caller, const Function *Callee,
1693                              const ArrayRef<Type *> &Types) const;
1694 
1695   /// The type of load/store indexing.
1696   enum MemIndexedMode {
1697     MIM_Unindexed, ///< No indexing.
1698     MIM_PreInc,    ///< Pre-incrementing.
1699     MIM_PreDec,    ///< Pre-decrementing.
1700     MIM_PostInc,   ///< Post-incrementing.
1701     MIM_PostDec    ///< Post-decrementing.
1702   };
1703 
1704   /// \returns True if the specified indexed load for the given type is legal.
1705   bool isIndexedLoadLegal(enum MemIndexedMode Mode, Type *Ty) const;
1706 
1707   /// \returns True if the specified indexed store for the given type is legal.
1708   bool isIndexedStoreLegal(enum MemIndexedMode Mode, Type *Ty) const;
1709 
1710   /// \returns The bitwidth of the largest vector type that should be used to
1711   /// load/store in the given address space.
1712   unsigned getLoadStoreVecRegBitWidth(unsigned AddrSpace) const;
1713 
1714   /// \returns True if the load instruction is legal to vectorize.
1715   bool isLegalToVectorizeLoad(LoadInst *LI) const;
1716 
1717   /// \returns True if the store instruction is legal to vectorize.
1718   bool isLegalToVectorizeStore(StoreInst *SI) const;
1719 
1720   /// \returns True if it is legal to vectorize the given load chain.
1721   bool isLegalToVectorizeLoadChain(unsigned ChainSizeInBytes, Align Alignment,
1722                                    unsigned AddrSpace) const;
1723 
1724   /// \returns True if it is legal to vectorize the given store chain.
1725   bool isLegalToVectorizeStoreChain(unsigned ChainSizeInBytes, Align Alignment,
1726                                     unsigned AddrSpace) const;
1727 
1728   /// \returns True if it is legal to vectorize the given reduction kind.
1729   bool isLegalToVectorizeReduction(const RecurrenceDescriptor &RdxDesc,
1730                                    ElementCount VF) const;
1731 
1732   /// \returns True if the given type is supported for scalable vectors
1733   bool isElementTypeLegalForScalableVector(Type *Ty) const;
1734 
1735   /// \returns The new vector factor value if the target doesn't support \p
1736   /// SizeInBytes loads or has a better vector factor.
1737   unsigned getLoadVectorFactor(unsigned VF, unsigned LoadSize,
1738                                unsigned ChainSizeInBytes,
1739                                VectorType *VecTy) const;
1740 
1741   /// \returns The new vector factor value if the target doesn't support \p
1742   /// SizeInBytes stores or has a better vector factor.
1743   unsigned getStoreVectorFactor(unsigned VF, unsigned StoreSize,
1744                                 unsigned ChainSizeInBytes,
1745                                 VectorType *VecTy) const;
1746 
1747   /// Flags describing the kind of vector reduction.
1748   struct ReductionFlags {
1749     ReductionFlags() = default;
1750     bool IsMaxOp =
1751         false; ///< If the op a min/max kind, true if it's a max operation.
1752     bool IsSigned = false; ///< Whether the operation is a signed int reduction.
1753     bool NoNaN =
1754         false; ///< If op is an fp min/max, whether NaNs may be present.
1755   };
1756 
1757   /// \returns True if the targets prefers fixed width vectorization if the
1758   /// loop vectorizer's cost-model assigns an equal cost to the fixed and
1759   /// scalable version of the vectorized loop.
1760   bool preferFixedOverScalableIfEqualCost() const;
1761 
1762   /// \returns True if the target prefers reductions in loop.
1763   bool preferInLoopReduction(unsigned Opcode, Type *Ty,
1764                              ReductionFlags Flags) const;
1765 
1766   /// \returns True if the target prefers reductions select kept in the loop
1767   /// when tail folding. i.e.
1768   /// loop:
1769   ///   p = phi (0, s)
1770   ///   a = add (p, x)
1771   ///   s = select (mask, a, p)
1772   /// vecreduce.add(s)
1773   ///
1774   /// As opposed to the normal scheme of p = phi (0, a) which allows the select
1775   /// to be pulled out of the loop. If the select(.., add, ..) can be predicated
1776   /// by the target, this can lead to cleaner code generation.
1777   bool preferPredicatedReductionSelect(unsigned Opcode, Type *Ty,
1778                                        ReductionFlags Flags) const;
1779 
1780   /// Return true if the loop vectorizer should consider vectorizing an
1781   /// otherwise scalar epilogue loop.
1782   bool preferEpilogueVectorization() const;
1783 
1784   /// \returns True if the target wants to expand the given reduction intrinsic
1785   /// into a shuffle sequence.
1786   bool shouldExpandReduction(const IntrinsicInst *II) const;
1787 
1788   enum struct ReductionShuffle { SplitHalf, Pairwise };
1789 
1790   /// \returns The shuffle sequence pattern used to expand the given reduction
1791   /// intrinsic.
1792   ReductionShuffle
1793   getPreferredExpandedReductionShuffle(const IntrinsicInst *II) const;
1794 
1795   /// \returns the size cost of rematerializing a GlobalValue address relative
1796   /// to a stack reload.
1797   unsigned getGISelRematGlobalCost() const;
1798 
1799   /// \returns the lower bound of a trip count to decide on vectorization
1800   /// while tail-folding.
1801   unsigned getMinTripCountTailFoldingThreshold() const;
1802 
1803   /// \returns True if the target supports scalable vectors.
1804   bool supportsScalableVectors() const;
1805 
1806   /// \return true when scalable vectorization is preferred.
1807   bool enableScalableVectorization() const;
1808 
1809   /// \name Vector Predication Information
1810   /// @{
1811   /// Whether the target supports the %evl parameter of VP intrinsic efficiently
1812   /// in hardware, for the given opcode and type/alignment. (see LLVM Language
1813   /// Reference - "Vector Predication Intrinsics").
1814   /// Use of %evl is discouraged when that is not the case.
1815   bool hasActiveVectorLength(unsigned Opcode, Type *DataType,
1816                              Align Alignment) const;
1817 
1818   /// Return true if sinking I's operands to the same basic block as I is
1819   /// profitable, e.g. because the operands can be folded into a target
1820   /// instruction during instruction selection. After calling the function
1821   /// \p Ops contains the Uses to sink ordered by dominance (dominating users
1822   /// come first).
1823   bool isProfitableToSinkOperands(Instruction *I,
1824                                   SmallVectorImpl<Use *> &Ops) const;
1825 
1826   /// Return true if it's significantly cheaper to shift a vector by a uniform
1827   /// scalar than by an amount which will vary across each lane. On x86 before
1828   /// AVX2 for example, there is a "psllw" instruction for the former case, but
1829   /// no simple instruction for a general "a << b" operation on vectors.
1830   /// This should also apply to lowering for vector funnel shifts (rotates).
1831   bool isVectorShiftByScalarCheap(Type *Ty) const;
1832 
1833   struct VPLegalization {
1834     enum VPTransform {
1835       // keep the predicating parameter
1836       Legal = 0,
1837       // where legal, discard the predicate parameter
1838       Discard = 1,
1839       // transform into something else that is also predicating
1840       Convert = 2
1841     };
1842 
1843     // How to transform the EVL parameter.
1844     // Legal:   keep the EVL parameter as it is.
1845     // Discard: Ignore the EVL parameter where it is safe to do so.
1846     // Convert: Fold the EVL into the mask parameter.
1847     VPTransform EVLParamStrategy;
1848 
1849     // How to transform the operator.
1850     // Legal:   The target supports this operator.
1851     // Convert: Convert this to a non-VP operation.
1852     // The 'Discard' strategy is invalid.
1853     VPTransform OpStrategy;
1854 
1855     bool shouldDoNothing() const {
1856       return (EVLParamStrategy == Legal) && (OpStrategy == Legal);
1857     }
1858     VPLegalization(VPTransform EVLParamStrategy, VPTransform OpStrategy)
1859         : EVLParamStrategy(EVLParamStrategy), OpStrategy(OpStrategy) {}
1860   };
1861 
1862   /// \returns How the target needs this vector-predicated operation to be
1863   /// transformed.
1864   VPLegalization getVPLegalizationStrategy(const VPIntrinsic &PI) const;
1865   /// @}
1866 
1867   /// \returns Whether a 32-bit branch instruction is available in Arm or Thumb
1868   /// state.
1869   ///
1870   /// Used by the LowerTypeTests pass, which constructs an IR inline assembler
1871   /// node containing a jump table in a format suitable for the target, so it
1872   /// needs to know what format of jump table it can legally use.
1873   ///
1874   /// For non-Arm targets, this function isn't used. It defaults to returning
1875   /// false, but it shouldn't matter what it returns anyway.
1876   bool hasArmWideBranch(bool Thumb) const;
1877 
1878   /// Returns a bitmask constructed from the target-features or fmv-features
1879   /// metadata of a function.
1880   uint64_t getFeatureMask(const Function &F) const;
1881 
1882   /// Returns true if this is an instance of a function with multiple versions.
1883   bool isMultiversionedFunction(const Function &F) const;
1884 
1885   /// \return The maximum number of function arguments the target supports.
1886   unsigned getMaxNumArgs() const;
1887 
1888   /// \return For an array of given Size, return alignment boundary to
1889   /// pad to. Default is no padding.
1890   unsigned getNumBytesToPadGlobalArray(unsigned Size, Type *ArrayType) const;
1891 
1892   /// @}
1893 
1894 private:
1895   /// The abstract base class used to type erase specific TTI
1896   /// implementations.
1897   class Concept;
1898 
1899   /// The template model for the base class which wraps a concrete
1900   /// implementation in a type erased interface.
1901   template <typename T> class Model;
1902 
1903   std::unique_ptr<Concept> TTIImpl;
1904 };
1905 
1906 class TargetTransformInfo::Concept {
1907 public:
1908   virtual ~Concept() = 0;
1909   virtual const DataLayout &getDataLayout() const = 0;
1910   virtual InstructionCost getGEPCost(Type *PointeeType, const Value *Ptr,
1911                                      ArrayRef<const Value *> Operands,
1912                                      Type *AccessType,
1913                                      TTI::TargetCostKind CostKind) = 0;
1914   virtual InstructionCost
1915   getPointersChainCost(ArrayRef<const Value *> Ptrs, const Value *Base,
1916                        const TTI::PointersChainInfo &Info, Type *AccessTy,
1917                        TTI::TargetCostKind CostKind) = 0;
1918   virtual unsigned getInliningThresholdMultiplier() const = 0;
1919   virtual unsigned getInliningCostBenefitAnalysisSavingsMultiplier() const = 0;
1920   virtual unsigned
1921   getInliningCostBenefitAnalysisProfitableMultiplier() const = 0;
1922   virtual int getInliningLastCallToStaticBonus() const = 0;
1923   virtual unsigned adjustInliningThreshold(const CallBase *CB) = 0;
1924   virtual int getInlinerVectorBonusPercent() const = 0;
1925   virtual unsigned getCallerAllocaCost(const CallBase *CB,
1926                                        const AllocaInst *AI) const = 0;
1927   virtual InstructionCost getMemcpyCost(const Instruction *I) = 0;
1928   virtual uint64_t getMaxMemIntrinsicInlineSizeThreshold() const = 0;
1929   virtual unsigned
1930   getEstimatedNumberOfCaseClusters(const SwitchInst &SI, unsigned &JTSize,
1931                                    ProfileSummaryInfo *PSI,
1932                                    BlockFrequencyInfo *BFI) = 0;
1933   virtual InstructionCost getInstructionCost(const User *U,
1934                                              ArrayRef<const Value *> Operands,
1935                                              TargetCostKind CostKind) = 0;
1936   virtual BranchProbability getPredictableBranchThreshold() = 0;
1937   virtual InstructionCost getBranchMispredictPenalty() = 0;
1938   virtual bool hasBranchDivergence(const Function *F = nullptr) = 0;
1939   virtual bool isSourceOfDivergence(const Value *V) = 0;
1940   virtual bool isAlwaysUniform(const Value *V) = 0;
1941   virtual bool isValidAddrSpaceCast(unsigned FromAS, unsigned ToAS) const = 0;
1942   virtual bool addrspacesMayAlias(unsigned AS0, unsigned AS1) const = 0;
1943   virtual unsigned getFlatAddressSpace() = 0;
1944   virtual bool collectFlatAddressOperands(SmallVectorImpl<int> &OpIndexes,
1945                                           Intrinsic::ID IID) const = 0;
1946   virtual bool isNoopAddrSpaceCast(unsigned FromAS, unsigned ToAS) const = 0;
1947   virtual bool
1948   canHaveNonUndefGlobalInitializerInAddressSpace(unsigned AS) const = 0;
1949   virtual unsigned getAssumedAddrSpace(const Value *V) const = 0;
1950   virtual bool isSingleThreaded() const = 0;
1951   virtual std::pair<const Value *, unsigned>
1952   getPredicatedAddrSpace(const Value *V) const = 0;
1953   virtual Value *rewriteIntrinsicWithAddressSpace(IntrinsicInst *II,
1954                                                   Value *OldV,
1955                                                   Value *NewV) const = 0;
1956   virtual bool isLoweredToCall(const Function *F) = 0;
1957   virtual void getUnrollingPreferences(Loop *L, ScalarEvolution &,
1958                                        UnrollingPreferences &UP,
1959                                        OptimizationRemarkEmitter *ORE) = 0;
1960   virtual void getPeelingPreferences(Loop *L, ScalarEvolution &SE,
1961                                      PeelingPreferences &PP) = 0;
1962   virtual bool isHardwareLoopProfitable(Loop *L, ScalarEvolution &SE,
1963                                         AssumptionCache &AC,
1964                                         TargetLibraryInfo *LibInfo,
1965                                         HardwareLoopInfo &HWLoopInfo) = 0;
1966   virtual unsigned getEpilogueVectorizationMinVF() = 0;
1967   virtual bool preferPredicateOverEpilogue(TailFoldingInfo *TFI) = 0;
1968   virtual TailFoldingStyle
1969   getPreferredTailFoldingStyle(bool IVUpdateMayOverflow = true) = 0;
1970   virtual std::optional<Instruction *> instCombineIntrinsic(
1971       InstCombiner &IC, IntrinsicInst &II) = 0;
1972   virtual std::optional<Value *> simplifyDemandedUseBitsIntrinsic(
1973       InstCombiner &IC, IntrinsicInst &II, APInt DemandedMask,
1974       KnownBits & Known, bool &KnownBitsComputed) = 0;
1975   virtual std::optional<Value *> simplifyDemandedVectorEltsIntrinsic(
1976       InstCombiner &IC, IntrinsicInst &II, APInt DemandedElts,
1977       APInt &UndefElts, APInt &UndefElts2, APInt &UndefElts3,
1978       std::function<void(Instruction *, unsigned, APInt, APInt &)>
1979           SimplifyAndSetOp) = 0;
1980   virtual bool isLegalAddImmediate(int64_t Imm) = 0;
1981   virtual bool isLegalAddScalableImmediate(int64_t Imm) = 0;
1982   virtual bool isLegalICmpImmediate(int64_t Imm) = 0;
1983   virtual bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV,
1984                                      int64_t BaseOffset, bool HasBaseReg,
1985                                      int64_t Scale, unsigned AddrSpace,
1986                                      Instruction *I,
1987                                      int64_t ScalableOffset) = 0;
1988   virtual bool isLSRCostLess(const TargetTransformInfo::LSRCost &C1,
1989                              const TargetTransformInfo::LSRCost &C2) = 0;
1990   virtual bool isNumRegsMajorCostOfLSR() = 0;
1991   virtual bool shouldDropLSRSolutionIfLessProfitable() const = 0;
1992   virtual bool isProfitableLSRChainElement(Instruction *I) = 0;
1993   virtual bool canMacroFuseCmp() = 0;
1994   virtual bool canSaveCmp(Loop *L, BranchInst **BI, ScalarEvolution *SE,
1995                           LoopInfo *LI, DominatorTree *DT, AssumptionCache *AC,
1996                           TargetLibraryInfo *LibInfo) = 0;
1997   virtual AddressingModeKind
1998     getPreferredAddressingMode(const Loop *L, ScalarEvolution *SE) const = 0;
1999   virtual bool isLegalMaskedStore(Type *DataType, Align Alignment) = 0;
2000   virtual bool isLegalMaskedLoad(Type *DataType, Align Alignment) = 0;
2001   virtual bool isLegalNTStore(Type *DataType, Align Alignment) = 0;
2002   virtual bool isLegalNTLoad(Type *DataType, Align Alignment) = 0;
2003   virtual bool isLegalBroadcastLoad(Type *ElementTy,
2004                                     ElementCount NumElements) const = 0;
2005   virtual bool isLegalMaskedScatter(Type *DataType, Align Alignment) = 0;
2006   virtual bool isLegalMaskedGather(Type *DataType, Align Alignment) = 0;
2007   virtual bool forceScalarizeMaskedGather(VectorType *DataType,
2008                                           Align Alignment) = 0;
2009   virtual bool forceScalarizeMaskedScatter(VectorType *DataType,
2010                                            Align Alignment) = 0;
2011   virtual bool isLegalMaskedCompressStore(Type *DataType, Align Alignment) = 0;
2012   virtual bool isLegalMaskedExpandLoad(Type *DataType, Align Alignment) = 0;
2013   virtual bool isLegalStridedLoadStore(Type *DataType, Align Alignment) = 0;
2014   virtual bool isLegalInterleavedAccessType(VectorType *VTy, unsigned Factor,
2015                                             Align Alignment,
2016                                             unsigned AddrSpace) = 0;
2017 
2018   virtual bool isLegalMaskedVectorHistogram(Type *AddrType, Type *DataType) = 0;
2019   virtual bool isLegalAltInstr(VectorType *VecTy, unsigned Opcode0,
2020                                unsigned Opcode1,
2021                                const SmallBitVector &OpcodeMask) const = 0;
2022   virtual bool enableOrderedReductions() = 0;
2023   virtual bool hasDivRemOp(Type *DataType, bool IsSigned) = 0;
2024   virtual bool hasVolatileVariant(Instruction *I, unsigned AddrSpace) = 0;
2025   virtual bool prefersVectorizedAddressing() = 0;
2026   virtual InstructionCost getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
2027                                                StackOffset BaseOffset,
2028                                                bool HasBaseReg, int64_t Scale,
2029                                                unsigned AddrSpace) = 0;
2030   virtual bool LSRWithInstrQueries() = 0;
2031   virtual bool isTruncateFree(Type *Ty1, Type *Ty2) = 0;
2032   virtual bool isProfitableToHoist(Instruction *I) = 0;
2033   virtual bool useAA() = 0;
2034   virtual bool isTypeLegal(Type *Ty) = 0;
2035   virtual unsigned getRegUsageForType(Type *Ty) = 0;
2036   virtual bool shouldBuildLookupTables() = 0;
2037   virtual bool shouldBuildLookupTablesForConstant(Constant *C) = 0;
2038   virtual bool shouldBuildRelLookupTables() = 0;
2039   virtual bool useColdCCForColdCall(Function &F) = 0;
2040   virtual bool isTargetIntrinsicTriviallyScalarizable(Intrinsic::ID ID) = 0;
2041   virtual bool isTargetIntrinsicWithScalarOpAtArg(Intrinsic::ID ID,
2042                                                   unsigned ScalarOpdIdx) = 0;
2043   virtual bool isTargetIntrinsicWithOverloadTypeAtArg(Intrinsic::ID ID,
2044                                                       int OpdIdx) = 0;
2045   virtual bool
2046   isTargetIntrinsicWithStructReturnOverloadAtField(Intrinsic::ID ID,
2047                                                    int RetIdx) = 0;
2048   virtual InstructionCost
2049   getScalarizationOverhead(VectorType *Ty, const APInt &DemandedElts,
2050                            bool Insert, bool Extract, TargetCostKind CostKind,
2051                            ArrayRef<Value *> VL = {}) = 0;
2052   virtual InstructionCost
2053   getOperandsScalarizationOverhead(ArrayRef<const Value *> Args,
2054                                    ArrayRef<Type *> Tys,
2055                                    TargetCostKind CostKind) = 0;
2056   virtual bool supportsEfficientVectorElementLoadStore() = 0;
2057   virtual bool supportsTailCalls() = 0;
2058   virtual bool supportsTailCallFor(const CallBase *CB) = 0;
2059   virtual bool enableAggressiveInterleaving(bool LoopHasReductions) = 0;
2060   virtual MemCmpExpansionOptions
2061   enableMemCmpExpansion(bool OptSize, bool IsZeroCmp) const = 0;
2062   virtual bool enableSelectOptimize() = 0;
2063   virtual bool shouldTreatInstructionLikeSelect(const Instruction *I) = 0;
2064   virtual bool enableInterleavedAccessVectorization() = 0;
2065   virtual bool enableMaskedInterleavedAccessVectorization() = 0;
2066   virtual bool isFPVectorizationPotentiallyUnsafe() = 0;
2067   virtual bool allowsMisalignedMemoryAccesses(LLVMContext &Context,
2068                                               unsigned BitWidth,
2069                                               unsigned AddressSpace,
2070                                               Align Alignment,
2071                                               unsigned *Fast) = 0;
2072   virtual PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) = 0;
2073   virtual bool haveFastSqrt(Type *Ty) = 0;
2074   virtual bool isExpensiveToSpeculativelyExecute(const Instruction *I) = 0;
2075   virtual bool isFCmpOrdCheaperThanFCmpZero(Type *Ty) = 0;
2076   virtual InstructionCost getFPOpCost(Type *Ty) = 0;
2077   virtual InstructionCost getIntImmCodeSizeCost(unsigned Opc, unsigned Idx,
2078                                                 const APInt &Imm, Type *Ty) = 0;
2079   virtual InstructionCost getIntImmCost(const APInt &Imm, Type *Ty,
2080                                         TargetCostKind CostKind) = 0;
2081   virtual InstructionCost getIntImmCostInst(unsigned Opc, unsigned Idx,
2082                                             const APInt &Imm, Type *Ty,
2083                                             TargetCostKind CostKind,
2084                                             Instruction *Inst = nullptr) = 0;
2085   virtual InstructionCost getIntImmCostIntrin(Intrinsic::ID IID, unsigned Idx,
2086                                               const APInt &Imm, Type *Ty,
2087                                               TargetCostKind CostKind) = 0;
2088   virtual bool preferToKeepConstantsAttached(const Instruction &Inst,
2089                                              const Function &Fn) const = 0;
2090   virtual unsigned getNumberOfRegisters(unsigned ClassID) const = 0;
2091   virtual bool hasConditionalLoadStoreForType(Type *Ty = nullptr) const = 0;
2092   virtual unsigned getRegisterClassForType(bool Vector,
2093                                            Type *Ty = nullptr) const = 0;
2094   virtual const char *getRegisterClassName(unsigned ClassID) const = 0;
2095   virtual TypeSize getRegisterBitWidth(RegisterKind K) const = 0;
2096   virtual unsigned getMinVectorRegisterBitWidth() const = 0;
2097   virtual std::optional<unsigned> getMaxVScale() const = 0;
2098   virtual std::optional<unsigned> getVScaleForTuning() const = 0;
2099   virtual bool isVScaleKnownToBeAPowerOfTwo() const = 0;
2100   virtual bool
2101   shouldMaximizeVectorBandwidth(TargetTransformInfo::RegisterKind K) const = 0;
2102   virtual ElementCount getMinimumVF(unsigned ElemWidth,
2103                                     bool IsScalable) const = 0;
2104   virtual unsigned getMaximumVF(unsigned ElemWidth, unsigned Opcode) const = 0;
2105   virtual unsigned getStoreMinimumVF(unsigned VF, Type *ScalarMemTy,
2106                                      Type *ScalarValTy) const = 0;
2107   virtual bool shouldConsiderAddressTypePromotion(
2108       const Instruction &I, bool &AllowPromotionWithoutCommonHeader) = 0;
2109   virtual unsigned getCacheLineSize() const = 0;
2110   virtual std::optional<unsigned> getCacheSize(CacheLevel Level) const = 0;
2111   virtual std::optional<unsigned> getCacheAssociativity(CacheLevel Level)
2112       const = 0;
2113   virtual std::optional<unsigned> getMinPageSize() const = 0;
2114 
2115   /// \return How much before a load we should place the prefetch
2116   /// instruction.  This is currently measured in number of
2117   /// instructions.
2118   virtual unsigned getPrefetchDistance() const = 0;
2119 
2120   /// \return Some HW prefetchers can handle accesses up to a certain
2121   /// constant stride.  This is the minimum stride in bytes where it
2122   /// makes sense to start adding SW prefetches.  The default is 1,
2123   /// i.e. prefetch with any stride.  Sometimes prefetching is beneficial
2124   /// even below the HW prefetcher limit, and the arguments provided are
2125   /// meant to serve as a basis for deciding this for a particular loop.
2126   virtual unsigned getMinPrefetchStride(unsigned NumMemAccesses,
2127                                         unsigned NumStridedMemAccesses,
2128                                         unsigned NumPrefetches,
2129                                         bool HasCall) const = 0;
2130 
2131   /// \return The maximum number of iterations to prefetch ahead.  If
2132   /// the required number of iterations is more than this number, no
2133   /// prefetching is performed.
2134   virtual unsigned getMaxPrefetchIterationsAhead() const = 0;
2135 
2136   /// \return True if prefetching should also be done for writes.
2137   virtual bool enableWritePrefetching() const = 0;
2138 
2139   /// \return if target want to issue a prefetch in address space \p AS.
2140   virtual bool shouldPrefetchAddressSpace(unsigned AS) const = 0;
2141 
2142   /// \return The cost of a partial reduction, which is a reduction from a
2143   /// vector to another vector with fewer elements of larger size. They are
2144   /// represented by the llvm.experimental.partial.reduce.add intrinsic, which
2145   /// takes an accumulator and a binary operation operand that itself is fed by
2146   /// two extends. An example of an operation that uses a partial reduction is a
2147   /// dot product, which reduces two vectors to another of 4 times fewer and 4
2148   /// times larger elements.
2149   virtual InstructionCost
2150   getPartialReductionCost(unsigned Opcode, Type *InputTypeA, Type *InputTypeB,
2151                           Type *AccumType, ElementCount VF,
2152                           PartialReductionExtendKind OpAExtend,
2153                           PartialReductionExtendKind OpBExtend,
2154                           std::optional<unsigned> BinOp) const = 0;
2155 
2156   virtual unsigned getMaxInterleaveFactor(ElementCount VF) = 0;
2157   virtual InstructionCost getArithmeticInstrCost(
2158       unsigned Opcode, Type *Ty, TTI::TargetCostKind CostKind,
2159       OperandValueInfo Opd1Info, OperandValueInfo Opd2Info,
2160       ArrayRef<const Value *> Args, const Instruction *CxtI = nullptr) = 0;
2161   virtual InstructionCost getAltInstrCost(
2162       VectorType *VecTy, unsigned Opcode0, unsigned Opcode1,
2163       const SmallBitVector &OpcodeMask,
2164       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) const = 0;
2165 
2166   virtual InstructionCost
2167   getShuffleCost(ShuffleKind Kind, VectorType *Tp, ArrayRef<int> Mask,
2168                  TTI::TargetCostKind CostKind, int Index, VectorType *SubTp,
2169                  ArrayRef<const Value *> Args, const Instruction *CxtI) = 0;
2170   virtual InstructionCost getCastInstrCost(unsigned Opcode, Type *Dst,
2171                                            Type *Src, CastContextHint CCH,
2172                                            TTI::TargetCostKind CostKind,
2173                                            const Instruction *I) = 0;
2174   virtual InstructionCost getExtractWithExtendCost(unsigned Opcode, Type *Dst,
2175                                                    VectorType *VecTy,
2176                                                    unsigned Index) = 0;
2177   virtual InstructionCost getCFInstrCost(unsigned Opcode,
2178                                          TTI::TargetCostKind CostKind,
2179                                          const Instruction *I = nullptr) = 0;
2180   virtual InstructionCost
2181   getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy,
2182                      CmpInst::Predicate VecPred, TTI::TargetCostKind CostKind,
2183                      OperandValueInfo Op1Info, OperandValueInfo Op2Info,
2184                      const Instruction *I) = 0;
2185   virtual InstructionCost getVectorInstrCost(unsigned Opcode, Type *Val,
2186                                              TTI::TargetCostKind CostKind,
2187                                              unsigned Index, Value *Op0,
2188                                              Value *Op1) = 0;
2189 
2190   /// \param ScalarUserAndIdx encodes the information about extracts from a
2191   /// vector with 'Scalar' being the value being extracted,'User' being the user
2192   /// of the extract(nullptr if user is not known before vectorization) and
2193   /// 'Idx' being the extract lane.
2194   virtual InstructionCost getVectorInstrCost(
2195       unsigned Opcode, Type *Val, TTI::TargetCostKind CostKind, unsigned Index,
2196       Value *Scalar,
2197       ArrayRef<std::tuple<Value *, User *, int>> ScalarUserAndIdx) = 0;
2198 
2199   virtual InstructionCost getVectorInstrCost(const Instruction &I, Type *Val,
2200                                              TTI::TargetCostKind CostKind,
2201                                              unsigned Index) = 0;
2202 
2203   virtual InstructionCost
2204   getReplicationShuffleCost(Type *EltTy, int ReplicationFactor, int VF,
2205                             const APInt &DemandedDstElts,
2206                             TTI::TargetCostKind CostKind) = 0;
2207 
2208   virtual InstructionCost
2209   getMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
2210                   unsigned AddressSpace, TTI::TargetCostKind CostKind,
2211                   OperandValueInfo OpInfo, const Instruction *I) = 0;
2212   virtual InstructionCost getVPMemoryOpCost(unsigned Opcode, Type *Src,
2213                                             Align Alignment,
2214                                             unsigned AddressSpace,
2215                                             TTI::TargetCostKind CostKind,
2216                                             const Instruction *I) = 0;
2217   virtual InstructionCost
2218   getMaskedMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
2219                         unsigned AddressSpace,
2220                         TTI::TargetCostKind CostKind) = 0;
2221   virtual InstructionCost
2222   getGatherScatterOpCost(unsigned Opcode, Type *DataTy, const Value *Ptr,
2223                          bool VariableMask, Align Alignment,
2224                          TTI::TargetCostKind CostKind,
2225                          const Instruction *I = nullptr) = 0;
2226   virtual InstructionCost
2227   getStridedMemoryOpCost(unsigned Opcode, Type *DataTy, const Value *Ptr,
2228                          bool VariableMask, Align Alignment,
2229                          TTI::TargetCostKind CostKind,
2230                          const Instruction *I = nullptr) = 0;
2231 
2232   virtual InstructionCost getInterleavedMemoryOpCost(
2233       unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
2234       Align Alignment, unsigned AddressSpace, TTI::TargetCostKind CostKind,
2235       bool UseMaskForCond = false, bool UseMaskForGaps = false) = 0;
2236   virtual InstructionCost
2237   getArithmeticReductionCost(unsigned Opcode, VectorType *Ty,
2238                              std::optional<FastMathFlags> FMF,
2239                              TTI::TargetCostKind CostKind) = 0;
2240   virtual InstructionCost
2241   getMinMaxReductionCost(Intrinsic::ID IID, VectorType *Ty, FastMathFlags FMF,
2242                          TTI::TargetCostKind CostKind) = 0;
2243   virtual InstructionCost getExtendedReductionCost(
2244       unsigned Opcode, bool IsUnsigned, Type *ResTy, VectorType *Ty,
2245       FastMathFlags FMF,
2246       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) = 0;
2247   virtual InstructionCost getMulAccReductionCost(
2248       bool IsUnsigned, Type *ResTy, VectorType *Ty,
2249       TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput) = 0;
2250   virtual InstructionCost
2251   getIntrinsicInstrCost(const IntrinsicCostAttributes &ICA,
2252                         TTI::TargetCostKind CostKind) = 0;
2253   virtual InstructionCost getCallInstrCost(Function *F, Type *RetTy,
2254                                            ArrayRef<Type *> Tys,
2255                                            TTI::TargetCostKind CostKind) = 0;
2256   virtual unsigned getNumberOfParts(Type *Tp) = 0;
2257   virtual InstructionCost
2258   getAddressComputationCost(Type *Ty, ScalarEvolution *SE, const SCEV *Ptr) = 0;
2259   virtual InstructionCost
2260   getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) = 0;
2261   virtual bool getTgtMemIntrinsic(IntrinsicInst *Inst,
2262                                   MemIntrinsicInfo &Info) = 0;
2263   virtual unsigned getAtomicMemIntrinsicMaxElementSize() const = 0;
2264   virtual Value *getOrCreateResultFromMemIntrinsic(IntrinsicInst *Inst,
2265                                                    Type *ExpectedType) = 0;
2266   virtual Type *getMemcpyLoopLoweringType(
2267       LLVMContext &Context, Value *Length, unsigned SrcAddrSpace,
2268       unsigned DestAddrSpace, Align SrcAlign, Align DestAlign,
2269       std::optional<uint32_t> AtomicElementSize) const = 0;
2270 
2271   virtual void getMemcpyLoopResidualLoweringType(
2272       SmallVectorImpl<Type *> &OpsOut, LLVMContext &Context,
2273       unsigned RemainingBytes, unsigned SrcAddrSpace, unsigned DestAddrSpace,
2274       Align SrcAlign, Align DestAlign,
2275       std::optional<uint32_t> AtomicCpySize) const = 0;
2276   virtual bool areInlineCompatible(const Function *Caller,
2277                                    const Function *Callee) const = 0;
2278   virtual unsigned getInlineCallPenalty(const Function *F, const CallBase &Call,
2279                                         unsigned DefaultCallPenalty) const = 0;
2280   virtual bool areTypesABICompatible(const Function *Caller,
2281                                      const Function *Callee,
2282                                      const ArrayRef<Type *> &Types) const = 0;
2283   virtual bool isIndexedLoadLegal(MemIndexedMode Mode, Type *Ty) const = 0;
2284   virtual bool isIndexedStoreLegal(MemIndexedMode Mode, Type *Ty) const = 0;
2285   virtual unsigned getLoadStoreVecRegBitWidth(unsigned AddrSpace) const = 0;
2286   virtual bool isLegalToVectorizeLoad(LoadInst *LI) const = 0;
2287   virtual bool isLegalToVectorizeStore(StoreInst *SI) const = 0;
2288   virtual bool isLegalToVectorizeLoadChain(unsigned ChainSizeInBytes,
2289                                            Align Alignment,
2290                                            unsigned AddrSpace) const = 0;
2291   virtual bool isLegalToVectorizeStoreChain(unsigned ChainSizeInBytes,
2292                                             Align Alignment,
2293                                             unsigned AddrSpace) const = 0;
2294   virtual bool isLegalToVectorizeReduction(const RecurrenceDescriptor &RdxDesc,
2295                                            ElementCount VF) const = 0;
2296   virtual bool isElementTypeLegalForScalableVector(Type *Ty) const = 0;
2297   virtual unsigned getLoadVectorFactor(unsigned VF, unsigned LoadSize,
2298                                        unsigned ChainSizeInBytes,
2299                                        VectorType *VecTy) const = 0;
2300   virtual unsigned getStoreVectorFactor(unsigned VF, unsigned StoreSize,
2301                                         unsigned ChainSizeInBytes,
2302                                         VectorType *VecTy) const = 0;
2303   virtual bool preferFixedOverScalableIfEqualCost() const = 0;
2304   virtual bool preferInLoopReduction(unsigned Opcode, Type *Ty,
2305                                      ReductionFlags) const = 0;
2306   virtual bool preferPredicatedReductionSelect(unsigned Opcode, Type *Ty,
2307                                                ReductionFlags) const = 0;
2308   virtual bool preferEpilogueVectorization() const = 0;
2309 
2310   virtual bool shouldExpandReduction(const IntrinsicInst *II) const = 0;
2311   virtual ReductionShuffle
2312   getPreferredExpandedReductionShuffle(const IntrinsicInst *II) const = 0;
2313   virtual unsigned getGISelRematGlobalCost() const = 0;
2314   virtual unsigned getMinTripCountTailFoldingThreshold() const = 0;
2315   virtual bool enableScalableVectorization() const = 0;
2316   virtual bool supportsScalableVectors() const = 0;
2317   virtual bool hasActiveVectorLength(unsigned Opcode, Type *DataType,
2318                                      Align Alignment) const = 0;
2319   virtual bool
2320   isProfitableToSinkOperands(Instruction *I,
2321                              SmallVectorImpl<Use *> &OpsToSink) const = 0;
2322 
2323   virtual bool isVectorShiftByScalarCheap(Type *Ty) const = 0;
2324   virtual VPLegalization
2325   getVPLegalizationStrategy(const VPIntrinsic &PI) const = 0;
2326   virtual bool hasArmWideBranch(bool Thumb) const = 0;
2327   virtual uint64_t getFeatureMask(const Function &F) const = 0;
2328   virtual bool isMultiversionedFunction(const Function &F) const = 0;
2329   virtual unsigned getMaxNumArgs() const = 0;
2330   virtual unsigned getNumBytesToPadGlobalArray(unsigned Size,
2331                                                Type *ArrayType) const = 0;
2332 };
2333 
2334 template <typename T>
2335 class TargetTransformInfo::Model final : public TargetTransformInfo::Concept {
2336   T Impl;
2337 
2338 public:
2339   Model(T Impl) : Impl(std::move(Impl)) {}
2340   ~Model() override = default;
2341 
2342   const DataLayout &getDataLayout() const override {
2343     return Impl.getDataLayout();
2344   }
2345 
2346   InstructionCost
2347   getGEPCost(Type *PointeeType, const Value *Ptr,
2348              ArrayRef<const Value *> Operands, Type *AccessType,
2349              TargetTransformInfo::TargetCostKind CostKind) override {
2350     return Impl.getGEPCost(PointeeType, Ptr, Operands, AccessType, CostKind);
2351   }
2352   InstructionCost getPointersChainCost(ArrayRef<const Value *> Ptrs,
2353                                        const Value *Base,
2354                                        const PointersChainInfo &Info,
2355                                        Type *AccessTy,
2356                                        TargetCostKind CostKind) override {
2357     return Impl.getPointersChainCost(Ptrs, Base, Info, AccessTy, CostKind);
2358   }
2359   unsigned getInliningThresholdMultiplier() const override {
2360     return Impl.getInliningThresholdMultiplier();
2361   }
2362   unsigned adjustInliningThreshold(const CallBase *CB) override {
2363     return Impl.adjustInliningThreshold(CB);
2364   }
2365   unsigned getInliningCostBenefitAnalysisSavingsMultiplier() const override {
2366     return Impl.getInliningCostBenefitAnalysisSavingsMultiplier();
2367   }
2368   unsigned getInliningCostBenefitAnalysisProfitableMultiplier() const override {
2369     return Impl.getInliningCostBenefitAnalysisProfitableMultiplier();
2370   }
2371   int getInliningLastCallToStaticBonus() const override {
2372     return Impl.getInliningLastCallToStaticBonus();
2373   }
2374   int getInlinerVectorBonusPercent() const override {
2375     return Impl.getInlinerVectorBonusPercent();
2376   }
2377   unsigned getCallerAllocaCost(const CallBase *CB,
2378                                const AllocaInst *AI) const override {
2379     return Impl.getCallerAllocaCost(CB, AI);
2380   }
2381   InstructionCost getMemcpyCost(const Instruction *I) override {
2382     return Impl.getMemcpyCost(I);
2383   }
2384 
2385   uint64_t getMaxMemIntrinsicInlineSizeThreshold() const override {
2386     return Impl.getMaxMemIntrinsicInlineSizeThreshold();
2387   }
2388 
2389   InstructionCost getInstructionCost(const User *U,
2390                                      ArrayRef<const Value *> Operands,
2391                                      TargetCostKind CostKind) override {
2392     return Impl.getInstructionCost(U, Operands, CostKind);
2393   }
2394   BranchProbability getPredictableBranchThreshold() override {
2395     return Impl.getPredictableBranchThreshold();
2396   }
2397   InstructionCost getBranchMispredictPenalty() override {
2398     return Impl.getBranchMispredictPenalty();
2399   }
2400   bool hasBranchDivergence(const Function *F = nullptr) override {
2401     return Impl.hasBranchDivergence(F);
2402   }
2403   bool isSourceOfDivergence(const Value *V) override {
2404     return Impl.isSourceOfDivergence(V);
2405   }
2406 
2407   bool isAlwaysUniform(const Value *V) override {
2408     return Impl.isAlwaysUniform(V);
2409   }
2410 
2411   bool isValidAddrSpaceCast(unsigned FromAS, unsigned ToAS) const override {
2412     return Impl.isValidAddrSpaceCast(FromAS, ToAS);
2413   }
2414 
2415   bool addrspacesMayAlias(unsigned AS0, unsigned AS1) const override {
2416     return Impl.addrspacesMayAlias(AS0, AS1);
2417   }
2418 
2419   unsigned getFlatAddressSpace() override { return Impl.getFlatAddressSpace(); }
2420 
2421   bool collectFlatAddressOperands(SmallVectorImpl<int> &OpIndexes,
2422                                   Intrinsic::ID IID) const override {
2423     return Impl.collectFlatAddressOperands(OpIndexes, IID);
2424   }
2425 
2426   bool isNoopAddrSpaceCast(unsigned FromAS, unsigned ToAS) const override {
2427     return Impl.isNoopAddrSpaceCast(FromAS, ToAS);
2428   }
2429 
2430   bool
2431   canHaveNonUndefGlobalInitializerInAddressSpace(unsigned AS) const override {
2432     return Impl.canHaveNonUndefGlobalInitializerInAddressSpace(AS);
2433   }
2434 
2435   unsigned getAssumedAddrSpace(const Value *V) const override {
2436     return Impl.getAssumedAddrSpace(V);
2437   }
2438 
2439   bool isSingleThreaded() const override { return Impl.isSingleThreaded(); }
2440 
2441   std::pair<const Value *, unsigned>
2442   getPredicatedAddrSpace(const Value *V) const override {
2443     return Impl.getPredicatedAddrSpace(V);
2444   }
2445 
2446   Value *rewriteIntrinsicWithAddressSpace(IntrinsicInst *II, Value *OldV,
2447                                           Value *NewV) const override {
2448     return Impl.rewriteIntrinsicWithAddressSpace(II, OldV, NewV);
2449   }
2450 
2451   bool isLoweredToCall(const Function *F) override {
2452     return Impl.isLoweredToCall(F);
2453   }
2454   void getUnrollingPreferences(Loop *L, ScalarEvolution &SE,
2455                                UnrollingPreferences &UP,
2456                                OptimizationRemarkEmitter *ORE) override {
2457     return Impl.getUnrollingPreferences(L, SE, UP, ORE);
2458   }
2459   void getPeelingPreferences(Loop *L, ScalarEvolution &SE,
2460                              PeelingPreferences &PP) override {
2461     return Impl.getPeelingPreferences(L, SE, PP);
2462   }
2463   bool isHardwareLoopProfitable(Loop *L, ScalarEvolution &SE,
2464                                 AssumptionCache &AC, TargetLibraryInfo *LibInfo,
2465                                 HardwareLoopInfo &HWLoopInfo) override {
2466     return Impl.isHardwareLoopProfitable(L, SE, AC, LibInfo, HWLoopInfo);
2467   }
2468   unsigned getEpilogueVectorizationMinVF() override {
2469     return Impl.getEpilogueVectorizationMinVF();
2470   }
2471   bool preferPredicateOverEpilogue(TailFoldingInfo *TFI) override {
2472     return Impl.preferPredicateOverEpilogue(TFI);
2473   }
2474   TailFoldingStyle
2475   getPreferredTailFoldingStyle(bool IVUpdateMayOverflow = true) override {
2476     return Impl.getPreferredTailFoldingStyle(IVUpdateMayOverflow);
2477   }
2478   std::optional<Instruction *>
2479   instCombineIntrinsic(InstCombiner &IC, IntrinsicInst &II) override {
2480     return Impl.instCombineIntrinsic(IC, II);
2481   }
2482   std::optional<Value *>
2483   simplifyDemandedUseBitsIntrinsic(InstCombiner &IC, IntrinsicInst &II,
2484                                    APInt DemandedMask, KnownBits &Known,
2485                                    bool &KnownBitsComputed) override {
2486     return Impl.simplifyDemandedUseBitsIntrinsic(IC, II, DemandedMask, Known,
2487                                                  KnownBitsComputed);
2488   }
2489   std::optional<Value *> simplifyDemandedVectorEltsIntrinsic(
2490       InstCombiner &IC, IntrinsicInst &II, APInt DemandedElts, APInt &UndefElts,
2491       APInt &UndefElts2, APInt &UndefElts3,
2492       std::function<void(Instruction *, unsigned, APInt, APInt &)>
2493           SimplifyAndSetOp) override {
2494     return Impl.simplifyDemandedVectorEltsIntrinsic(
2495         IC, II, DemandedElts, UndefElts, UndefElts2, UndefElts3,
2496         SimplifyAndSetOp);
2497   }
2498   bool isLegalAddImmediate(int64_t Imm) override {
2499     return Impl.isLegalAddImmediate(Imm);
2500   }
2501   bool isLegalAddScalableImmediate(int64_t Imm) override {
2502     return Impl.isLegalAddScalableImmediate(Imm);
2503   }
2504   bool isLegalICmpImmediate(int64_t Imm) override {
2505     return Impl.isLegalICmpImmediate(Imm);
2506   }
2507   bool isLegalAddressingMode(Type *Ty, GlobalValue *BaseGV, int64_t BaseOffset,
2508                              bool HasBaseReg, int64_t Scale, unsigned AddrSpace,
2509                              Instruction *I, int64_t ScalableOffset) override {
2510     return Impl.isLegalAddressingMode(Ty, BaseGV, BaseOffset, HasBaseReg, Scale,
2511                                       AddrSpace, I, ScalableOffset);
2512   }
2513   bool isLSRCostLess(const TargetTransformInfo::LSRCost &C1,
2514                      const TargetTransformInfo::LSRCost &C2) override {
2515     return Impl.isLSRCostLess(C1, C2);
2516   }
2517   bool isNumRegsMajorCostOfLSR() override {
2518     return Impl.isNumRegsMajorCostOfLSR();
2519   }
2520   bool shouldDropLSRSolutionIfLessProfitable() const override {
2521     return Impl.shouldDropLSRSolutionIfLessProfitable();
2522   }
2523   bool isProfitableLSRChainElement(Instruction *I) override {
2524     return Impl.isProfitableLSRChainElement(I);
2525   }
2526   bool canMacroFuseCmp() override { return Impl.canMacroFuseCmp(); }
2527   bool canSaveCmp(Loop *L, BranchInst **BI, ScalarEvolution *SE, LoopInfo *LI,
2528                   DominatorTree *DT, AssumptionCache *AC,
2529                   TargetLibraryInfo *LibInfo) override {
2530     return Impl.canSaveCmp(L, BI, SE, LI, DT, AC, LibInfo);
2531   }
2532   AddressingModeKind
2533     getPreferredAddressingMode(const Loop *L,
2534                                ScalarEvolution *SE) const override {
2535     return Impl.getPreferredAddressingMode(L, SE);
2536   }
2537   bool isLegalMaskedStore(Type *DataType, Align Alignment) override {
2538     return Impl.isLegalMaskedStore(DataType, Alignment);
2539   }
2540   bool isLegalMaskedLoad(Type *DataType, Align Alignment) override {
2541     return Impl.isLegalMaskedLoad(DataType, Alignment);
2542   }
2543   bool isLegalNTStore(Type *DataType, Align Alignment) override {
2544     return Impl.isLegalNTStore(DataType, Alignment);
2545   }
2546   bool isLegalNTLoad(Type *DataType, Align Alignment) override {
2547     return Impl.isLegalNTLoad(DataType, Alignment);
2548   }
2549   bool isLegalBroadcastLoad(Type *ElementTy,
2550                             ElementCount NumElements) const override {
2551     return Impl.isLegalBroadcastLoad(ElementTy, NumElements);
2552   }
2553   bool isLegalMaskedScatter(Type *DataType, Align Alignment) override {
2554     return Impl.isLegalMaskedScatter(DataType, Alignment);
2555   }
2556   bool isLegalMaskedGather(Type *DataType, Align Alignment) override {
2557     return Impl.isLegalMaskedGather(DataType, Alignment);
2558   }
2559   bool forceScalarizeMaskedGather(VectorType *DataType,
2560                                   Align Alignment) override {
2561     return Impl.forceScalarizeMaskedGather(DataType, Alignment);
2562   }
2563   bool forceScalarizeMaskedScatter(VectorType *DataType,
2564                                    Align Alignment) override {
2565     return Impl.forceScalarizeMaskedScatter(DataType, Alignment);
2566   }
2567   bool isLegalMaskedCompressStore(Type *DataType, Align Alignment) override {
2568     return Impl.isLegalMaskedCompressStore(DataType, Alignment);
2569   }
2570   bool isLegalMaskedExpandLoad(Type *DataType, Align Alignment) override {
2571     return Impl.isLegalMaskedExpandLoad(DataType, Alignment);
2572   }
2573   bool isLegalStridedLoadStore(Type *DataType, Align Alignment) override {
2574     return Impl.isLegalStridedLoadStore(DataType, Alignment);
2575   }
2576   bool isLegalInterleavedAccessType(VectorType *VTy, unsigned Factor,
2577                                     Align Alignment,
2578                                     unsigned AddrSpace) override {
2579     return Impl.isLegalInterleavedAccessType(VTy, Factor, Alignment, AddrSpace);
2580   }
2581   bool isLegalMaskedVectorHistogram(Type *AddrType, Type *DataType) override {
2582     return Impl.isLegalMaskedVectorHistogram(AddrType, DataType);
2583   }
2584   bool isLegalAltInstr(VectorType *VecTy, unsigned Opcode0, unsigned Opcode1,
2585                        const SmallBitVector &OpcodeMask) const override {
2586     return Impl.isLegalAltInstr(VecTy, Opcode0, Opcode1, OpcodeMask);
2587   }
2588   bool enableOrderedReductions() override {
2589     return Impl.enableOrderedReductions();
2590   }
2591   bool hasDivRemOp(Type *DataType, bool IsSigned) override {
2592     return Impl.hasDivRemOp(DataType, IsSigned);
2593   }
2594   bool hasVolatileVariant(Instruction *I, unsigned AddrSpace) override {
2595     return Impl.hasVolatileVariant(I, AddrSpace);
2596   }
2597   bool prefersVectorizedAddressing() override {
2598     return Impl.prefersVectorizedAddressing();
2599   }
2600   InstructionCost getScalingFactorCost(Type *Ty, GlobalValue *BaseGV,
2601                                        StackOffset BaseOffset, bool HasBaseReg,
2602                                        int64_t Scale,
2603                                        unsigned AddrSpace) override {
2604     return Impl.getScalingFactorCost(Ty, BaseGV, BaseOffset, HasBaseReg, Scale,
2605                                      AddrSpace);
2606   }
2607   bool LSRWithInstrQueries() override { return Impl.LSRWithInstrQueries(); }
2608   bool isTruncateFree(Type *Ty1, Type *Ty2) override {
2609     return Impl.isTruncateFree(Ty1, Ty2);
2610   }
2611   bool isProfitableToHoist(Instruction *I) override {
2612     return Impl.isProfitableToHoist(I);
2613   }
2614   bool useAA() override { return Impl.useAA(); }
2615   bool isTypeLegal(Type *Ty) override { return Impl.isTypeLegal(Ty); }
2616   unsigned getRegUsageForType(Type *Ty) override {
2617     return Impl.getRegUsageForType(Ty);
2618   }
2619   bool shouldBuildLookupTables() override {
2620     return Impl.shouldBuildLookupTables();
2621   }
2622   bool shouldBuildLookupTablesForConstant(Constant *C) override {
2623     return Impl.shouldBuildLookupTablesForConstant(C);
2624   }
2625   bool shouldBuildRelLookupTables() override {
2626     return Impl.shouldBuildRelLookupTables();
2627   }
2628   bool useColdCCForColdCall(Function &F) override {
2629     return Impl.useColdCCForColdCall(F);
2630   }
2631   bool isTargetIntrinsicTriviallyScalarizable(Intrinsic::ID ID) override {
2632     return Impl.isTargetIntrinsicTriviallyScalarizable(ID);
2633   }
2634 
2635   bool isTargetIntrinsicWithScalarOpAtArg(Intrinsic::ID ID,
2636                                           unsigned ScalarOpdIdx) override {
2637     return Impl.isTargetIntrinsicWithScalarOpAtArg(ID, ScalarOpdIdx);
2638   }
2639 
2640   bool isTargetIntrinsicWithOverloadTypeAtArg(Intrinsic::ID ID,
2641                                               int OpdIdx) override {
2642     return Impl.isTargetIntrinsicWithOverloadTypeAtArg(ID, OpdIdx);
2643   }
2644 
2645   bool isTargetIntrinsicWithStructReturnOverloadAtField(Intrinsic::ID ID,
2646                                                         int RetIdx) override {
2647     return Impl.isTargetIntrinsicWithStructReturnOverloadAtField(ID, RetIdx);
2648   }
2649 
2650   InstructionCost getScalarizationOverhead(VectorType *Ty,
2651                                            const APInt &DemandedElts,
2652                                            bool Insert, bool Extract,
2653                                            TargetCostKind CostKind,
2654                                            ArrayRef<Value *> VL = {}) override {
2655     return Impl.getScalarizationOverhead(Ty, DemandedElts, Insert, Extract,
2656                                          CostKind, VL);
2657   }
2658   InstructionCost
2659   getOperandsScalarizationOverhead(ArrayRef<const Value *> Args,
2660                                    ArrayRef<Type *> Tys,
2661                                    TargetCostKind CostKind) override {
2662     return Impl.getOperandsScalarizationOverhead(Args, Tys, CostKind);
2663   }
2664 
2665   bool supportsEfficientVectorElementLoadStore() override {
2666     return Impl.supportsEfficientVectorElementLoadStore();
2667   }
2668 
2669   bool supportsTailCalls() override { return Impl.supportsTailCalls(); }
2670   bool supportsTailCallFor(const CallBase *CB) override {
2671     return Impl.supportsTailCallFor(CB);
2672   }
2673 
2674   bool enableAggressiveInterleaving(bool LoopHasReductions) override {
2675     return Impl.enableAggressiveInterleaving(LoopHasReductions);
2676   }
2677   MemCmpExpansionOptions enableMemCmpExpansion(bool OptSize,
2678                                                bool IsZeroCmp) const override {
2679     return Impl.enableMemCmpExpansion(OptSize, IsZeroCmp);
2680   }
2681   bool enableSelectOptimize() override {
2682     return Impl.enableSelectOptimize();
2683   }
2684   bool shouldTreatInstructionLikeSelect(const Instruction *I) override {
2685     return Impl.shouldTreatInstructionLikeSelect(I);
2686   }
2687   bool enableInterleavedAccessVectorization() override {
2688     return Impl.enableInterleavedAccessVectorization();
2689   }
2690   bool enableMaskedInterleavedAccessVectorization() override {
2691     return Impl.enableMaskedInterleavedAccessVectorization();
2692   }
2693   bool isFPVectorizationPotentiallyUnsafe() override {
2694     return Impl.isFPVectorizationPotentiallyUnsafe();
2695   }
2696   bool allowsMisalignedMemoryAccesses(LLVMContext &Context, unsigned BitWidth,
2697                                       unsigned AddressSpace, Align Alignment,
2698                                       unsigned *Fast) override {
2699     return Impl.allowsMisalignedMemoryAccesses(Context, BitWidth, AddressSpace,
2700                                                Alignment, Fast);
2701   }
2702   PopcntSupportKind getPopcntSupport(unsigned IntTyWidthInBit) override {
2703     return Impl.getPopcntSupport(IntTyWidthInBit);
2704   }
2705   bool haveFastSqrt(Type *Ty) override { return Impl.haveFastSqrt(Ty); }
2706 
2707   bool isExpensiveToSpeculativelyExecute(const Instruction* I) override {
2708     return Impl.isExpensiveToSpeculativelyExecute(I);
2709   }
2710 
2711   bool isFCmpOrdCheaperThanFCmpZero(Type *Ty) override {
2712     return Impl.isFCmpOrdCheaperThanFCmpZero(Ty);
2713   }
2714 
2715   InstructionCost getFPOpCost(Type *Ty) override {
2716     return Impl.getFPOpCost(Ty);
2717   }
2718 
2719   InstructionCost getIntImmCodeSizeCost(unsigned Opc, unsigned Idx,
2720                                         const APInt &Imm, Type *Ty) override {
2721     return Impl.getIntImmCodeSizeCost(Opc, Idx, Imm, Ty);
2722   }
2723   InstructionCost getIntImmCost(const APInt &Imm, Type *Ty,
2724                                 TargetCostKind CostKind) override {
2725     return Impl.getIntImmCost(Imm, Ty, CostKind);
2726   }
2727   InstructionCost getIntImmCostInst(unsigned Opc, unsigned Idx,
2728                                     const APInt &Imm, Type *Ty,
2729                                     TargetCostKind CostKind,
2730                                     Instruction *Inst = nullptr) override {
2731     return Impl.getIntImmCostInst(Opc, Idx, Imm, Ty, CostKind, Inst);
2732   }
2733   InstructionCost getIntImmCostIntrin(Intrinsic::ID IID, unsigned Idx,
2734                                       const APInt &Imm, Type *Ty,
2735                                       TargetCostKind CostKind) override {
2736     return Impl.getIntImmCostIntrin(IID, Idx, Imm, Ty, CostKind);
2737   }
2738   bool preferToKeepConstantsAttached(const Instruction &Inst,
2739                                      const Function &Fn) const override {
2740     return Impl.preferToKeepConstantsAttached(Inst, Fn);
2741   }
2742   unsigned getNumberOfRegisters(unsigned ClassID) const override {
2743     return Impl.getNumberOfRegisters(ClassID);
2744   }
2745   bool hasConditionalLoadStoreForType(Type *Ty = nullptr) const override {
2746     return Impl.hasConditionalLoadStoreForType(Ty);
2747   }
2748   unsigned getRegisterClassForType(bool Vector,
2749                                    Type *Ty = nullptr) const override {
2750     return Impl.getRegisterClassForType(Vector, Ty);
2751   }
2752   const char *getRegisterClassName(unsigned ClassID) const override {
2753     return Impl.getRegisterClassName(ClassID);
2754   }
2755   TypeSize getRegisterBitWidth(RegisterKind K) const override {
2756     return Impl.getRegisterBitWidth(K);
2757   }
2758   unsigned getMinVectorRegisterBitWidth() const override {
2759     return Impl.getMinVectorRegisterBitWidth();
2760   }
2761   std::optional<unsigned> getMaxVScale() const override {
2762     return Impl.getMaxVScale();
2763   }
2764   std::optional<unsigned> getVScaleForTuning() const override {
2765     return Impl.getVScaleForTuning();
2766   }
2767   bool isVScaleKnownToBeAPowerOfTwo() const override {
2768     return Impl.isVScaleKnownToBeAPowerOfTwo();
2769   }
2770   bool shouldMaximizeVectorBandwidth(
2771       TargetTransformInfo::RegisterKind K) const override {
2772     return Impl.shouldMaximizeVectorBandwidth(K);
2773   }
2774   ElementCount getMinimumVF(unsigned ElemWidth,
2775                             bool IsScalable) const override {
2776     return Impl.getMinimumVF(ElemWidth, IsScalable);
2777   }
2778   unsigned getMaximumVF(unsigned ElemWidth, unsigned Opcode) const override {
2779     return Impl.getMaximumVF(ElemWidth, Opcode);
2780   }
2781   unsigned getStoreMinimumVF(unsigned VF, Type *ScalarMemTy,
2782                              Type *ScalarValTy) const override {
2783     return Impl.getStoreMinimumVF(VF, ScalarMemTy, ScalarValTy);
2784   }
2785   bool shouldConsiderAddressTypePromotion(
2786       const Instruction &I, bool &AllowPromotionWithoutCommonHeader) override {
2787     return Impl.shouldConsiderAddressTypePromotion(
2788         I, AllowPromotionWithoutCommonHeader);
2789   }
2790   unsigned getCacheLineSize() const override { return Impl.getCacheLineSize(); }
2791   std::optional<unsigned> getCacheSize(CacheLevel Level) const override {
2792     return Impl.getCacheSize(Level);
2793   }
2794   std::optional<unsigned>
2795   getCacheAssociativity(CacheLevel Level) const override {
2796     return Impl.getCacheAssociativity(Level);
2797   }
2798 
2799   std::optional<unsigned> getMinPageSize() const override {
2800     return Impl.getMinPageSize();
2801   }
2802 
2803   /// Return the preferred prefetch distance in terms of instructions.
2804   ///
2805   unsigned getPrefetchDistance() const override {
2806     return Impl.getPrefetchDistance();
2807   }
2808 
2809   /// Return the minimum stride necessary to trigger software
2810   /// prefetching.
2811   ///
2812   unsigned getMinPrefetchStride(unsigned NumMemAccesses,
2813                                 unsigned NumStridedMemAccesses,
2814                                 unsigned NumPrefetches,
2815                                 bool HasCall) const override {
2816     return Impl.getMinPrefetchStride(NumMemAccesses, NumStridedMemAccesses,
2817                                      NumPrefetches, HasCall);
2818   }
2819 
2820   /// Return the maximum prefetch distance in terms of loop
2821   /// iterations.
2822   ///
2823   unsigned getMaxPrefetchIterationsAhead() const override {
2824     return Impl.getMaxPrefetchIterationsAhead();
2825   }
2826 
2827   /// \return True if prefetching should also be done for writes.
2828   bool enableWritePrefetching() const override {
2829     return Impl.enableWritePrefetching();
2830   }
2831 
2832   /// \return if target want to issue a prefetch in address space \p AS.
2833   bool shouldPrefetchAddressSpace(unsigned AS) const override {
2834     return Impl.shouldPrefetchAddressSpace(AS);
2835   }
2836 
2837   InstructionCost getPartialReductionCost(
2838       unsigned Opcode, Type *InputTypeA, Type *InputTypeB, Type *AccumType,
2839       ElementCount VF, PartialReductionExtendKind OpAExtend,
2840       PartialReductionExtendKind OpBExtend,
2841       std::optional<unsigned> BinOp = std::nullopt) const override {
2842     return Impl.getPartialReductionCost(Opcode, InputTypeA, InputTypeB,
2843                                         AccumType, VF, OpAExtend, OpBExtend,
2844                                         BinOp);
2845   }
2846 
2847   unsigned getMaxInterleaveFactor(ElementCount VF) override {
2848     return Impl.getMaxInterleaveFactor(VF);
2849   }
2850   unsigned getEstimatedNumberOfCaseClusters(const SwitchInst &SI,
2851                                             unsigned &JTSize,
2852                                             ProfileSummaryInfo *PSI,
2853                                             BlockFrequencyInfo *BFI) override {
2854     return Impl.getEstimatedNumberOfCaseClusters(SI, JTSize, PSI, BFI);
2855   }
2856   InstructionCost getArithmeticInstrCost(
2857       unsigned Opcode, Type *Ty, TTI::TargetCostKind CostKind,
2858       OperandValueInfo Opd1Info, OperandValueInfo Opd2Info,
2859       ArrayRef<const Value *> Args,
2860       const Instruction *CxtI = nullptr) override {
2861     return Impl.getArithmeticInstrCost(Opcode, Ty, CostKind, Opd1Info, Opd2Info,
2862                                        Args, CxtI);
2863   }
2864   InstructionCost getAltInstrCost(VectorType *VecTy, unsigned Opcode0,
2865                                   unsigned Opcode1,
2866                                   const SmallBitVector &OpcodeMask,
2867                                   TTI::TargetCostKind CostKind) const override {
2868     return Impl.getAltInstrCost(VecTy, Opcode0, Opcode1, OpcodeMask, CostKind);
2869   }
2870 
2871   InstructionCost getShuffleCost(ShuffleKind Kind, VectorType *Tp,
2872                                  ArrayRef<int> Mask,
2873                                  TTI::TargetCostKind CostKind, int Index,
2874                                  VectorType *SubTp,
2875                                  ArrayRef<const Value *> Args,
2876                                  const Instruction *CxtI) override {
2877     return Impl.getShuffleCost(Kind, Tp, Mask, CostKind, Index, SubTp, Args,
2878                                CxtI);
2879   }
2880   InstructionCost getCastInstrCost(unsigned Opcode, Type *Dst, Type *Src,
2881                                    CastContextHint CCH,
2882                                    TTI::TargetCostKind CostKind,
2883                                    const Instruction *I) override {
2884     return Impl.getCastInstrCost(Opcode, Dst, Src, CCH, CostKind, I);
2885   }
2886   InstructionCost getExtractWithExtendCost(unsigned Opcode, Type *Dst,
2887                                            VectorType *VecTy,
2888                                            unsigned Index) override {
2889     return Impl.getExtractWithExtendCost(Opcode, Dst, VecTy, Index);
2890   }
2891   InstructionCost getCFInstrCost(unsigned Opcode, TTI::TargetCostKind CostKind,
2892                                  const Instruction *I = nullptr) override {
2893     return Impl.getCFInstrCost(Opcode, CostKind, I);
2894   }
2895   InstructionCost getCmpSelInstrCost(unsigned Opcode, Type *ValTy, Type *CondTy,
2896                                      CmpInst::Predicate VecPred,
2897                                      TTI::TargetCostKind CostKind,
2898                                      OperandValueInfo Op1Info,
2899                                      OperandValueInfo Op2Info,
2900                                      const Instruction *I) override {
2901     return Impl.getCmpSelInstrCost(Opcode, ValTy, CondTy, VecPred, CostKind,
2902                                    Op1Info, Op2Info, I);
2903   }
2904   InstructionCost getVectorInstrCost(unsigned Opcode, Type *Val,
2905                                      TTI::TargetCostKind CostKind,
2906                                      unsigned Index, Value *Op0,
2907                                      Value *Op1) override {
2908     return Impl.getVectorInstrCost(Opcode, Val, CostKind, Index, Op0, Op1);
2909   }
2910   InstructionCost getVectorInstrCost(
2911       unsigned Opcode, Type *Val, TTI::TargetCostKind CostKind, unsigned Index,
2912       Value *Scalar,
2913       ArrayRef<std::tuple<Value *, User *, int>> ScalarUserAndIdx) override {
2914     return Impl.getVectorInstrCost(Opcode, Val, CostKind, Index, Scalar,
2915                                    ScalarUserAndIdx);
2916   }
2917   InstructionCost getVectorInstrCost(const Instruction &I, Type *Val,
2918                                      TTI::TargetCostKind CostKind,
2919                                      unsigned Index) override {
2920     return Impl.getVectorInstrCost(I, Val, CostKind, Index);
2921   }
2922   InstructionCost
2923   getReplicationShuffleCost(Type *EltTy, int ReplicationFactor, int VF,
2924                             const APInt &DemandedDstElts,
2925                             TTI::TargetCostKind CostKind) override {
2926     return Impl.getReplicationShuffleCost(EltTy, ReplicationFactor, VF,
2927                                           DemandedDstElts, CostKind);
2928   }
2929   InstructionCost getMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
2930                                   unsigned AddressSpace,
2931                                   TTI::TargetCostKind CostKind,
2932                                   OperandValueInfo OpInfo,
2933                                   const Instruction *I) override {
2934     return Impl.getMemoryOpCost(Opcode, Src, Alignment, AddressSpace, CostKind,
2935                                 OpInfo, I);
2936   }
2937   InstructionCost getVPMemoryOpCost(unsigned Opcode, Type *Src, Align Alignment,
2938                                     unsigned AddressSpace,
2939                                     TTI::TargetCostKind CostKind,
2940                                     const Instruction *I) override {
2941     return Impl.getVPMemoryOpCost(Opcode, Src, Alignment, AddressSpace,
2942                                   CostKind, I);
2943   }
2944   InstructionCost getMaskedMemoryOpCost(unsigned Opcode, Type *Src,
2945                                         Align Alignment, unsigned AddressSpace,
2946                                         TTI::TargetCostKind CostKind) override {
2947     return Impl.getMaskedMemoryOpCost(Opcode, Src, Alignment, AddressSpace,
2948                                       CostKind);
2949   }
2950   InstructionCost
2951   getGatherScatterOpCost(unsigned Opcode, Type *DataTy, const Value *Ptr,
2952                          bool VariableMask, Align Alignment,
2953                          TTI::TargetCostKind CostKind,
2954                          const Instruction *I = nullptr) override {
2955     return Impl.getGatherScatterOpCost(Opcode, DataTy, Ptr, VariableMask,
2956                                        Alignment, CostKind, I);
2957   }
2958   InstructionCost
2959   getStridedMemoryOpCost(unsigned Opcode, Type *DataTy, const Value *Ptr,
2960                          bool VariableMask, Align Alignment,
2961                          TTI::TargetCostKind CostKind,
2962                          const Instruction *I = nullptr) override {
2963     return Impl.getStridedMemoryOpCost(Opcode, DataTy, Ptr, VariableMask,
2964                                        Alignment, CostKind, I);
2965   }
2966   InstructionCost getInterleavedMemoryOpCost(
2967       unsigned Opcode, Type *VecTy, unsigned Factor, ArrayRef<unsigned> Indices,
2968       Align Alignment, unsigned AddressSpace, TTI::TargetCostKind CostKind,
2969       bool UseMaskForCond, bool UseMaskForGaps) override {
2970     return Impl.getInterleavedMemoryOpCost(Opcode, VecTy, Factor, Indices,
2971                                            Alignment, AddressSpace, CostKind,
2972                                            UseMaskForCond, UseMaskForGaps);
2973   }
2974   InstructionCost
2975   getArithmeticReductionCost(unsigned Opcode, VectorType *Ty,
2976                              std::optional<FastMathFlags> FMF,
2977                              TTI::TargetCostKind CostKind) override {
2978     return Impl.getArithmeticReductionCost(Opcode, Ty, FMF, CostKind);
2979   }
2980   InstructionCost
2981   getMinMaxReductionCost(Intrinsic::ID IID, VectorType *Ty, FastMathFlags FMF,
2982                          TTI::TargetCostKind CostKind) override {
2983     return Impl.getMinMaxReductionCost(IID, Ty, FMF, CostKind);
2984   }
2985   InstructionCost
2986   getExtendedReductionCost(unsigned Opcode, bool IsUnsigned, Type *ResTy,
2987                            VectorType *Ty, FastMathFlags FMF,
2988                            TTI::TargetCostKind CostKind) override {
2989     return Impl.getExtendedReductionCost(Opcode, IsUnsigned, ResTy, Ty, FMF,
2990                                          CostKind);
2991   }
2992   InstructionCost
2993   getMulAccReductionCost(bool IsUnsigned, Type *ResTy, VectorType *Ty,
2994                          TTI::TargetCostKind CostKind) override {
2995     return Impl.getMulAccReductionCost(IsUnsigned, ResTy, Ty, CostKind);
2996   }
2997   InstructionCost getIntrinsicInstrCost(const IntrinsicCostAttributes &ICA,
2998                                         TTI::TargetCostKind CostKind) override {
2999     return Impl.getIntrinsicInstrCost(ICA, CostKind);
3000   }
3001   InstructionCost getCallInstrCost(Function *F, Type *RetTy,
3002                                    ArrayRef<Type *> Tys,
3003                                    TTI::TargetCostKind CostKind) override {
3004     return Impl.getCallInstrCost(F, RetTy, Tys, CostKind);
3005   }
3006   unsigned getNumberOfParts(Type *Tp) override {
3007     return Impl.getNumberOfParts(Tp);
3008   }
3009   InstructionCost getAddressComputationCost(Type *Ty, ScalarEvolution *SE,
3010                                             const SCEV *Ptr) override {
3011     return Impl.getAddressComputationCost(Ty, SE, Ptr);
3012   }
3013   InstructionCost getCostOfKeepingLiveOverCall(ArrayRef<Type *> Tys) override {
3014     return Impl.getCostOfKeepingLiveOverCall(Tys);
3015   }
3016   bool getTgtMemIntrinsic(IntrinsicInst *Inst,
3017                           MemIntrinsicInfo &Info) override {
3018     return Impl.getTgtMemIntrinsic(Inst, Info);
3019   }
3020   unsigned getAtomicMemIntrinsicMaxElementSize() const override {
3021     return Impl.getAtomicMemIntrinsicMaxElementSize();
3022   }
3023   Value *getOrCreateResultFromMemIntrinsic(IntrinsicInst *Inst,
3024                                            Type *ExpectedType) override {
3025     return Impl.getOrCreateResultFromMemIntrinsic(Inst, ExpectedType);
3026   }
3027   Type *getMemcpyLoopLoweringType(
3028       LLVMContext &Context, Value *Length, unsigned SrcAddrSpace,
3029       unsigned DestAddrSpace, Align SrcAlign, Align DestAlign,
3030       std::optional<uint32_t> AtomicElementSize) const override {
3031     return Impl.getMemcpyLoopLoweringType(Context, Length, SrcAddrSpace,
3032                                           DestAddrSpace, SrcAlign, DestAlign,
3033                                           AtomicElementSize);
3034   }
3035   void getMemcpyLoopResidualLoweringType(
3036       SmallVectorImpl<Type *> &OpsOut, LLVMContext &Context,
3037       unsigned RemainingBytes, unsigned SrcAddrSpace, unsigned DestAddrSpace,
3038       Align SrcAlign, Align DestAlign,
3039       std::optional<uint32_t> AtomicCpySize) const override {
3040     Impl.getMemcpyLoopResidualLoweringType(OpsOut, Context, RemainingBytes,
3041                                            SrcAddrSpace, DestAddrSpace,
3042                                            SrcAlign, DestAlign, AtomicCpySize);
3043   }
3044   bool areInlineCompatible(const Function *Caller,
3045                            const Function *Callee) const override {
3046     return Impl.areInlineCompatible(Caller, Callee);
3047   }
3048   unsigned getInlineCallPenalty(const Function *F, const CallBase &Call,
3049                                 unsigned DefaultCallPenalty) const override {
3050     return Impl.getInlineCallPenalty(F, Call, DefaultCallPenalty);
3051   }
3052   bool areTypesABICompatible(const Function *Caller, const Function *Callee,
3053                              const ArrayRef<Type *> &Types) const override {
3054     return Impl.areTypesABICompatible(Caller, Callee, Types);
3055   }
3056   bool isIndexedLoadLegal(MemIndexedMode Mode, Type *Ty) const override {
3057     return Impl.isIndexedLoadLegal(Mode, Ty, getDataLayout());
3058   }
3059   bool isIndexedStoreLegal(MemIndexedMode Mode, Type *Ty) const override {
3060     return Impl.isIndexedStoreLegal(Mode, Ty, getDataLayout());
3061   }
3062   unsigned getLoadStoreVecRegBitWidth(unsigned AddrSpace) const override {
3063     return Impl.getLoadStoreVecRegBitWidth(AddrSpace);
3064   }
3065   bool isLegalToVectorizeLoad(LoadInst *LI) const override {
3066     return Impl.isLegalToVectorizeLoad(LI);
3067   }
3068   bool isLegalToVectorizeStore(StoreInst *SI) const override {
3069     return Impl.isLegalToVectorizeStore(SI);
3070   }
3071   bool isLegalToVectorizeLoadChain(unsigned ChainSizeInBytes, Align Alignment,
3072                                    unsigned AddrSpace) const override {
3073     return Impl.isLegalToVectorizeLoadChain(ChainSizeInBytes, Alignment,
3074                                             AddrSpace);
3075   }
3076   bool isLegalToVectorizeStoreChain(unsigned ChainSizeInBytes, Align Alignment,
3077                                     unsigned AddrSpace) const override {
3078     return Impl.isLegalToVectorizeStoreChain(ChainSizeInBytes, Alignment,
3079                                              AddrSpace);
3080   }
3081   bool isLegalToVectorizeReduction(const RecurrenceDescriptor &RdxDesc,
3082                                    ElementCount VF) const override {
3083     return Impl.isLegalToVectorizeReduction(RdxDesc, VF);
3084   }
3085   bool isElementTypeLegalForScalableVector(Type *Ty) const override {
3086     return Impl.isElementTypeLegalForScalableVector(Ty);
3087   }
3088   unsigned getLoadVectorFactor(unsigned VF, unsigned LoadSize,
3089                                unsigned ChainSizeInBytes,
3090                                VectorType *VecTy) const override {
3091     return Impl.getLoadVectorFactor(VF, LoadSize, ChainSizeInBytes, VecTy);
3092   }
3093   unsigned getStoreVectorFactor(unsigned VF, unsigned StoreSize,
3094                                 unsigned ChainSizeInBytes,
3095                                 VectorType *VecTy) const override {
3096     return Impl.getStoreVectorFactor(VF, StoreSize, ChainSizeInBytes, VecTy);
3097   }
3098   bool preferFixedOverScalableIfEqualCost() const override {
3099     return Impl.preferFixedOverScalableIfEqualCost();
3100   }
3101   bool preferInLoopReduction(unsigned Opcode, Type *Ty,
3102                              ReductionFlags Flags) const override {
3103     return Impl.preferInLoopReduction(Opcode, Ty, Flags);
3104   }
3105   bool preferPredicatedReductionSelect(unsigned Opcode, Type *Ty,
3106                                        ReductionFlags Flags) const override {
3107     return Impl.preferPredicatedReductionSelect(Opcode, Ty, Flags);
3108   }
3109   bool preferEpilogueVectorization() const override {
3110     return Impl.preferEpilogueVectorization();
3111   }
3112 
3113   bool shouldExpandReduction(const IntrinsicInst *II) const override {
3114     return Impl.shouldExpandReduction(II);
3115   }
3116 
3117   ReductionShuffle
3118   getPreferredExpandedReductionShuffle(const IntrinsicInst *II) const override {
3119     return Impl.getPreferredExpandedReductionShuffle(II);
3120   }
3121 
3122   unsigned getGISelRematGlobalCost() const override {
3123     return Impl.getGISelRematGlobalCost();
3124   }
3125 
3126   unsigned getMinTripCountTailFoldingThreshold() const override {
3127     return Impl.getMinTripCountTailFoldingThreshold();
3128   }
3129 
3130   bool supportsScalableVectors() const override {
3131     return Impl.supportsScalableVectors();
3132   }
3133 
3134   bool enableScalableVectorization() const override {
3135     return Impl.enableScalableVectorization();
3136   }
3137 
3138   bool hasActiveVectorLength(unsigned Opcode, Type *DataType,
3139                              Align Alignment) const override {
3140     return Impl.hasActiveVectorLength(Opcode, DataType, Alignment);
3141   }
3142 
3143   bool isProfitableToSinkOperands(Instruction *I,
3144                                   SmallVectorImpl<Use *> &Ops) const override {
3145     return Impl.isProfitableToSinkOperands(I, Ops);
3146   };
3147 
3148   bool isVectorShiftByScalarCheap(Type *Ty) const override {
3149     return Impl.isVectorShiftByScalarCheap(Ty);
3150   }
3151 
3152   VPLegalization
3153   getVPLegalizationStrategy(const VPIntrinsic &PI) const override {
3154     return Impl.getVPLegalizationStrategy(PI);
3155   }
3156 
3157   bool hasArmWideBranch(bool Thumb) const override {
3158     return Impl.hasArmWideBranch(Thumb);
3159   }
3160 
3161   uint64_t getFeatureMask(const Function &F) const override {
3162     return Impl.getFeatureMask(F);
3163   }
3164 
3165   bool isMultiversionedFunction(const Function &F) const override {
3166     return Impl.isMultiversionedFunction(F);
3167   }
3168 
3169   unsigned getMaxNumArgs() const override {
3170     return Impl.getMaxNumArgs();
3171   }
3172 
3173   unsigned getNumBytesToPadGlobalArray(unsigned Size,
3174                                        Type *ArrayType) const override {
3175     return Impl.getNumBytesToPadGlobalArray(Size, ArrayType);
3176   }
3177 };
3178 
3179 template <typename T>
3180 TargetTransformInfo::TargetTransformInfo(T Impl)
3181     : TTIImpl(new Model<T>(Impl)) {}
3182 
3183 /// Analysis pass providing the \c TargetTransformInfo.
3184 ///
3185 /// The core idea of the TargetIRAnalysis is to expose an interface through
3186 /// which LLVM targets can analyze and provide information about the middle
3187 /// end's target-independent IR. This supports use cases such as target-aware
3188 /// cost modeling of IR constructs.
3189 ///
3190 /// This is a function analysis because much of the cost modeling for targets
3191 /// is done in a subtarget specific way and LLVM supports compiling different
3192 /// functions targeting different subtargets in order to support runtime
3193 /// dispatch according to the observed subtarget.
3194 class TargetIRAnalysis : public AnalysisInfoMixin<TargetIRAnalysis> {
3195 public:
3196   typedef TargetTransformInfo Result;
3197 
3198   /// Default construct a target IR analysis.
3199   ///
3200   /// This will use the module's datalayout to construct a baseline
3201   /// conservative TTI result.
3202   TargetIRAnalysis();
3203 
3204   /// Construct an IR analysis pass around a target-provide callback.
3205   ///
3206   /// The callback will be called with a particular function for which the TTI
3207   /// is needed and must return a TTI object for that function.
3208   TargetIRAnalysis(std::function<Result(const Function &)> TTICallback);
3209 
3210   // Value semantics. We spell out the constructors for MSVC.
3211   TargetIRAnalysis(const TargetIRAnalysis &Arg)
3212       : TTICallback(Arg.TTICallback) {}
3213   TargetIRAnalysis(TargetIRAnalysis &&Arg)
3214       : TTICallback(std::move(Arg.TTICallback)) {}
3215   TargetIRAnalysis &operator=(const TargetIRAnalysis &RHS) {
3216     TTICallback = RHS.TTICallback;
3217     return *this;
3218   }
3219   TargetIRAnalysis &operator=(TargetIRAnalysis &&RHS) {
3220     TTICallback = std::move(RHS.TTICallback);
3221     return *this;
3222   }
3223 
3224   Result run(const Function &F, FunctionAnalysisManager &);
3225 
3226 private:
3227   friend AnalysisInfoMixin<TargetIRAnalysis>;
3228   static AnalysisKey Key;
3229 
3230   /// The callback used to produce a result.
3231   ///
3232   /// We use a completely opaque callback so that targets can provide whatever
3233   /// mechanism they desire for constructing the TTI for a given function.
3234   ///
3235   /// FIXME: Should we really use std::function? It's relatively inefficient.
3236   /// It might be possible to arrange for even stateful callbacks to outlive
3237   /// the analysis and thus use a function_ref which would be lighter weight.
3238   /// This may also be less error prone as the callback is likely to reference
3239   /// the external TargetMachine, and that reference needs to never dangle.
3240   std::function<Result(const Function &)> TTICallback;
3241 
3242   /// Helper function used as the callback in the default constructor.
3243   static Result getDefaultTTI(const Function &F);
3244 };
3245 
3246 /// Wrapper pass for TargetTransformInfo.
3247 ///
3248 /// This pass can be constructed from a TTI object which it stores internally
3249 /// and is queried by passes.
3250 class TargetTransformInfoWrapperPass : public ImmutablePass {
3251   TargetIRAnalysis TIRA;
3252   std::optional<TargetTransformInfo> TTI;
3253 
3254   virtual void anchor();
3255 
3256 public:
3257   static char ID;
3258 
3259   /// We must provide a default constructor for the pass but it should
3260   /// never be used.
3261   ///
3262   /// Use the constructor below or call one of the creation routines.
3263   TargetTransformInfoWrapperPass();
3264 
3265   explicit TargetTransformInfoWrapperPass(TargetIRAnalysis TIRA);
3266 
3267   TargetTransformInfo &getTTI(const Function &F);
3268 };
3269 
3270 /// Create an analysis pass wrapper around a TTI object.
3271 ///
3272 /// This analysis pass just holds the TTI instance and makes it available to
3273 /// clients.
3274 ImmutablePass *createTargetTransformInfoWrapperPass(TargetIRAnalysis TIRA);
3275 
3276 } // namespace llvm
3277 
3278 #endif