1 //===- llvm/CodeGen/TargetLowering.h - Target Lowering Info -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// This file describes how to lower LLVM code to machine code. This has two
14 /// 1. Which ValueTypes are natively supported by the target.
15 /// 2. Which operations are supported for supported ValueTypes.
16 /// 3. Cost thresholds for alternative implementations of certain operations.
18 /// In addition it has a few other components, like information about FP
21 //===----------------------------------------------------------------------===//
23 #ifndef LLVM_CODEGEN_TARGETLOWERING_H
24 #define LLVM_CODEGEN_TARGETLOWERING_H
26 #include "llvm/ADT/APInt.h"
27 #include "llvm/ADT/ArrayRef.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/STLExtras.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/ADT/StringRef.h"
32 #include "llvm/CodeGen/DAGCombine.h"
33 #include "llvm/CodeGen/ISDOpcodes.h"
34 #include "llvm/CodeGen/MachineValueType.h"
35 #include "llvm/CodeGen/RuntimeLibcalls.h"
36 #include "llvm/CodeGen/SelectionDAG.h"
37 #include "llvm/CodeGen/SelectionDAGNodes.h"
38 #include "llvm/CodeGen/TargetCallingConv.h"
39 #include "llvm/CodeGen/ValueTypes.h"
40 #include "llvm/IR/Attributes.h"
41 #include "llvm/IR/CallSite.h"
42 #include "llvm/IR/CallingConv.h"
43 #include "llvm/IR/DataLayout.h"
44 #include "llvm/IR/DerivedTypes.h"
45 #include "llvm/IR/Function.h"
46 #include "llvm/IR/IRBuilder.h"
47 #include "llvm/IR/InlineAsm.h"
48 #include "llvm/IR/Instruction.h"
49 #include "llvm/IR/Instructions.h"
50 #include "llvm/IR/Type.h"
51 #include "llvm/MC/MCRegisterInfo.h"
52 #include "llvm/Support/AtomicOrdering.h"
53 #include "llvm/Support/Casting.h"
54 #include "llvm/Support/ErrorHandling.h"
55 #include "llvm/Target/TargetMachine.h"
68 class BranchProbability;
73 class FunctionLoweringInfo;
78 class MachineBasicBlock;
79 class MachineFunction;
81 class MachineJumpTableInfo;
83 class MachineRegisterInfo;
87 class TargetRegisterClass;
88 class TargetLibraryInfo;
89 class TargetRegisterInfo;
95 None, // No preference
96 Source, // Follow source order.
97 RegPressure, // Scheduling for lowest register pressure.
98 Hybrid, // Scheduling for both latency and register pressure.
99 ILP, // Scheduling for ILP in low register pressure mode.
100 VLIW // Scheduling for VLIW targets.
103 } // end namespace Sched
105 /// This base class for TargetLowering contains the SelectionDAG-independent
106 /// parts that can be used from the rest of CodeGen.
107 class TargetLoweringBase {
109 /// This enum indicates whether operations are valid for a target, and if not,
110 /// what action should be used to make them valid.
111 enum LegalizeAction : uint8_t {
112 Legal, // The target natively supports this operation.
113 Promote, // This operation should be executed in a larger type.
114 Expand, // Try to expand this to other ops, otherwise use a libcall.
115 LibCall, // Don't try to expand this to other ops, always use a libcall.
116 Custom // Use the LowerOperation hook to implement custom lowering.
119 /// This enum indicates whether a types are legal for a target, and if not,
120 /// what action should be used to make them valid.
121 enum LegalizeTypeAction : uint8_t {
122 TypeLegal, // The target natively supports this type.
123 TypePromoteInteger, // Replace this integer with a larger one.
124 TypeExpandInteger, // Split this integer into two of half the size.
125 TypeSoftenFloat, // Convert this float to a same size integer type,
126 // if an operation is not supported in target HW.
127 TypeExpandFloat, // Split this float into two of half the size.
128 TypeScalarizeVector, // Replace this one-element vector with its element.
129 TypeSplitVector, // Split this vector into two of half the size.
130 TypeWidenVector, // This vector should be widened into a larger vector.
131 TypePromoteFloat // Replace this float with a larger one.
134 /// LegalizeKind holds the legalization kind that needs to happen to EVT
135 /// in order to type-legalize it.
136 using LegalizeKind = std::pair<LegalizeTypeAction, EVT>;
138 /// Enum that describes how the target represents true/false values.
139 enum BooleanContent {
140 UndefinedBooleanContent, // Only bit 0 counts, the rest can hold garbage.
141 ZeroOrOneBooleanContent, // All bits zero except for bit 0.
142 ZeroOrNegativeOneBooleanContent // All bits equal to bit 0.
145 /// Enum that describes what type of support for selects the target has.
146 enum SelectSupportKind {
147 ScalarValSelect, // The target supports scalar selects (ex: cmov).
148 ScalarCondVectorVal, // The target supports selects with a scalar condition
149 // and vector values (ex: cmov).
150 VectorMaskSelect // The target supports vector selects with a vector
151 // mask (ex: x86 blends).
154 /// Enum that specifies what an atomic load/AtomicRMWInst is expanded
155 /// to, if at all. Exists because different targets have different levels of
156 /// support for these atomic instructions, and also have different options
157 /// w.r.t. what they should expand to.
158 enum class AtomicExpansionKind {
159 None, // Don't expand the instruction.
160 LLSC, // Expand the instruction into loadlinked/storeconditional; used
162 LLOnly, // Expand the (load) instruction into just a load-linked, which has
163 // greater atomic guarantees than a normal load.
164 CmpXChg, // Expand the instruction into cmpxchg; used by at least X86.
167 /// Enum that specifies when a multiplication should be expanded.
168 enum class MulExpansionKind {
169 Always, // Always expand the instruction.
170 OnlyLegalOrCustom, // Only expand when the resulting instructions are legal
176 Value *Val = nullptr;
177 SDValue Node = SDValue();
187 bool IsSwiftSelf : 1;
188 bool IsSwiftError : 1;
189 uint16_t Alignment = 0;
192 : IsSExt(false), IsZExt(false), IsInReg(false), IsSRet(false),
193 IsNest(false), IsByVal(false), IsInAlloca(false), IsReturned(false),
194 IsSwiftSelf(false), IsSwiftError(false) {}
196 void setAttributes(ImmutableCallSite *CS, unsigned ArgIdx);
198 using ArgListTy = std::vector<ArgListEntry>;
200 virtual void markLibCallAttributes(MachineFunction *MF, unsigned CC,
201 ArgListTy &Args) const {};
203 static ISD::NodeType getExtendForContent(BooleanContent Content) {
205 case UndefinedBooleanContent:
206 // Extend by adding rubbish bits.
207 return ISD::ANY_EXTEND;
208 case ZeroOrOneBooleanContent:
209 // Extend by adding zero bits.
210 return ISD::ZERO_EXTEND;
211 case ZeroOrNegativeOneBooleanContent:
212 // Extend by copying the sign bit.
213 return ISD::SIGN_EXTEND;
215 llvm_unreachable("Invalid content kind");
218 /// NOTE: The TargetMachine owns TLOF.
219 explicit TargetLoweringBase(const TargetMachine &TM);
220 TargetLoweringBase(const TargetLoweringBase &) = delete;
221 TargetLoweringBase &operator=(const TargetLoweringBase &) = delete;
222 virtual ~TargetLoweringBase() = default;
225 /// \brief Initialize all of the actions to default values.
229 const TargetMachine &getTargetMachine() const { return TM; }
231 virtual bool useSoftFloat() const { return false; }
233 /// Return the pointer type for the given address space, defaults to
234 /// the pointer type from the data layout.
235 /// FIXME: The default needs to be removed once all the code is updated.
236 MVT getPointerTy(const DataLayout &DL, uint32_t AS = 0) const {
237 return MVT::getIntegerVT(DL.getPointerSizeInBits(AS));
240 /// Return the type for frame index, which is determined by
241 /// the alloca address space specified through the data layout.
242 MVT getFrameIndexTy(const DataLayout &DL) const {
243 return getPointerTy(DL, DL.getAllocaAddrSpace());
246 /// Return the type for operands of fence.
247 /// TODO: Let fence operands be of i32 type and remove this.
248 virtual MVT getFenceOperandTy(const DataLayout &DL) const {
249 return getPointerTy(DL);
252 /// EVT is not used in-tree, but is used by out-of-tree target.
253 /// A documentation for this function would be nice...
254 virtual MVT getScalarShiftAmountTy(const DataLayout &, EVT) const;
256 EVT getShiftAmountTy(EVT LHSTy, const DataLayout &DL) const;
258 /// Returns the type to be used for the index operand of:
259 /// ISD::INSERT_VECTOR_ELT, ISD::EXTRACT_VECTOR_ELT,
260 /// ISD::INSERT_SUBVECTOR, and ISD::EXTRACT_SUBVECTOR
261 virtual MVT getVectorIdxTy(const DataLayout &DL) const {
262 return getPointerTy(DL);
265 virtual bool isSelectSupported(SelectSupportKind /*kind*/) const {
269 /// Return true if multiple condition registers are available.
270 bool hasMultipleConditionRegisters() const {
271 return HasMultipleConditionRegisters;
274 /// Return true if the target has BitExtract instructions.
275 bool hasExtractBitsInsn() const { return HasExtractBitsInsn; }
277 /// Return the preferred vector type legalization action.
278 virtual TargetLoweringBase::LegalizeTypeAction
279 getPreferredVectorAction(EVT VT) const {
280 // The default action for one element vectors is to scalarize
281 if (VT.getVectorNumElements() == 1)
282 return TypeScalarizeVector;
283 // The default action for other vectors is to promote
284 return TypePromoteInteger;
287 // There are two general methods for expanding a BUILD_VECTOR node:
288 // 1. Use SCALAR_TO_VECTOR on the defined scalar values and then shuffle
290 // 2. Build the vector on the stack and then load it.
291 // If this function returns true, then method (1) will be used, subject to
292 // the constraint that all of the necessary shuffles are legal (as determined
293 // by isShuffleMaskLegal). If this function returns false, then method (2) is
294 // always used. The vector type, and the number of defined values, are
297 shouldExpandBuildVectorWithShuffles(EVT /* VT */,
298 unsigned DefinedValues) const {
299 return DefinedValues < 3;
302 /// Return true if integer divide is usually cheaper than a sequence of
303 /// several shifts, adds, and multiplies for this target.
304 /// The definition of "cheaper" may depend on whether we're optimizing
305 /// for speed or for size.
306 virtual bool isIntDivCheap(EVT VT, AttributeList Attr) const { return false; }
308 /// Return true if the target can handle a standalone remainder operation.
309 virtual bool hasStandaloneRem(EVT VT) const {
313 /// Return true if SQRT(X) shouldn't be replaced with X*RSQRT(X).
314 virtual bool isFsqrtCheap(SDValue X, SelectionDAG &DAG) const {
315 // Default behavior is to replace SQRT(X) with X*RSQRT(X).
319 /// Reciprocal estimate status values used by the functions below.
320 enum ReciprocalEstimate : int {
326 /// Return a ReciprocalEstimate enum value for a square root of the given type
327 /// based on the function's attributes. If the operation is not overridden by
328 /// the function's attributes, "Unspecified" is returned and target defaults
329 /// are expected to be used for instruction selection.
330 int getRecipEstimateSqrtEnabled(EVT VT, MachineFunction &MF) const;
332 /// Return a ReciprocalEstimate enum value for a division of the given type
333 /// based on the function's attributes. If the operation is not overridden by
334 /// the function's attributes, "Unspecified" is returned and target defaults
335 /// are expected to be used for instruction selection.
336 int getRecipEstimateDivEnabled(EVT VT, MachineFunction &MF) const;
338 /// Return the refinement step count for a square root of the given type based
339 /// on the function's attributes. If the operation is not overridden by
340 /// the function's attributes, "Unspecified" is returned and target defaults
341 /// are expected to be used for instruction selection.
342 int getSqrtRefinementSteps(EVT VT, MachineFunction &MF) const;
344 /// Return the refinement step count for a division of the given type based
345 /// on the function's attributes. If the operation is not overridden by
346 /// the function's attributes, "Unspecified" is returned and target defaults
347 /// are expected to be used for instruction selection.
348 int getDivRefinementSteps(EVT VT, MachineFunction &MF) const;
350 /// Returns true if target has indicated at least one type should be bypassed.
351 bool isSlowDivBypassed() const { return !BypassSlowDivWidths.empty(); }
353 /// Returns map of slow types for division or remainder with corresponding
355 const DenseMap<unsigned int, unsigned int> &getBypassSlowDivWidths() const {
356 return BypassSlowDivWidths;
359 /// Return true if Flow Control is an expensive operation that should be
361 bool isJumpExpensive() const { return JumpIsExpensive; }
363 /// Return true if selects are only cheaper than branches if the branch is
364 /// unlikely to be predicted right.
365 bool isPredictableSelectExpensive() const {
366 return PredictableSelectIsExpensive;
369 /// If a branch or a select condition is skewed in one direction by more than
370 /// this factor, it is very likely to be predicted correctly.
371 virtual BranchProbability getPredictableBranchThreshold() const;
373 /// Return true if the following transform is beneficial:
374 /// fold (conv (load x)) -> (load (conv*)x)
375 /// On architectures that don't natively support some vector loads
376 /// efficiently, casting the load to a smaller vector of larger types and
377 /// loading is more efficient, however, this can be undone by optimizations in
379 virtual bool isLoadBitCastBeneficial(EVT LoadVT,
380 EVT BitcastVT) const {
381 // Don't do if we could do an indexed load on the original type, but not on
383 if (!LoadVT.isSimple() || !BitcastVT.isSimple())
386 MVT LoadMVT = LoadVT.getSimpleVT();
388 // Don't bother doing this if it's just going to be promoted again later, as
389 // doing so might interfere with other combines.
390 if (getOperationAction(ISD::LOAD, LoadMVT) == Promote &&
391 getTypeToPromoteTo(ISD::LOAD, LoadMVT) == BitcastVT.getSimpleVT())
397 /// Return true if the following transform is beneficial:
398 /// (store (y (conv x)), y*)) -> (store x, (x*))
399 virtual bool isStoreBitCastBeneficial(EVT StoreVT, EVT BitcastVT) const {
400 // Default to the same logic as loads.
401 return isLoadBitCastBeneficial(StoreVT, BitcastVT);
404 /// Return true if it is expected to be cheaper to do a store of a non-zero
405 /// vector constant with the given size and type for the address space than to
406 /// store the individual scalar element constants.
407 virtual bool storeOfVectorConstantIsCheap(EVT MemVT,
409 unsigned AddrSpace) const {
413 /// Allow store merging after legalization in addition to before legalization.
414 /// This may catch stores that do not exist earlier (eg, stores created from
416 virtual bool mergeStoresAfterLegalization() const { return true; }
418 /// Returns if it's reasonable to merge stores to MemVT size.
419 virtual bool canMergeStoresTo(unsigned AS, EVT MemVT,
420 const SelectionDAG &DAG) const {
424 /// \brief Return true if it is cheap to speculate a call to intrinsic cttz.
425 virtual bool isCheapToSpeculateCttz() const {
429 /// \brief Return true if it is cheap to speculate a call to intrinsic ctlz.
430 virtual bool isCheapToSpeculateCtlz() const {
434 /// \brief Return true if ctlz instruction is fast.
435 virtual bool isCtlzFast() const {
439 /// Return true if it is safe to transform an integer-domain bitwise operation
440 /// into the equivalent floating-point operation. This should be set to true
441 /// if the target has IEEE-754-compliant fabs/fneg operations for the input
443 virtual bool hasBitPreservingFPLogic(EVT VT) const {
447 /// \brief Return true if it is cheaper to split the store of a merged int val
448 /// from a pair of smaller values into multiple stores.
449 virtual bool isMultiStoresCheaperThanBitsMerge(EVT LTy, EVT HTy) const {
453 /// \brief Return if the target supports combining a
456 /// %andResult = and %val1, #mask
457 /// %icmpResult = icmp %andResult, 0
459 /// into a single machine instruction of a form like:
461 /// cc = test %register, #mask
463 virtual bool isMaskAndCmp0FoldingBeneficial(const Instruction &AndI) const {
467 /// Use bitwise logic to make pairs of compares more efficient. For example:
468 /// and (seteq A, B), (seteq C, D) --> seteq (or (xor A, B), (xor C, D)), 0
469 /// This should be true when it takes more than one instruction to lower
470 /// setcc (cmp+set on x86 scalar), when bitwise ops are faster than logic on
471 /// condition bits (crand on PowerPC), and/or when reducing cmp+br is a win.
472 virtual bool convertSetCCLogicToBitwiseLogic(EVT VT) const {
476 /// Return the preferred operand type if the target has a quick way to compare
477 /// integer values of the given size. Assume that any legal integer type can
478 /// be compared efficiently. Targets may override this to allow illegal wide
479 /// types to return a vector type if there is support to compare that type.
480 virtual MVT hasFastEqualityCompare(unsigned NumBits) const {
481 MVT VT = MVT::getIntegerVT(NumBits);
482 return isTypeLegal(VT) ? VT : MVT::INVALID_SIMPLE_VALUE_TYPE;
485 /// Return true if the target should transform:
486 /// (X & Y) == Y ---> (~X & Y) == 0
487 /// (X & Y) != Y ---> (~X & Y) != 0
489 /// This may be profitable if the target has a bitwise and-not operation that
490 /// sets comparison flags. A target may want to limit the transformation based
491 /// on the type of Y or if Y is a constant.
493 /// Note that the transform will not occur if Y is known to be a power-of-2
494 /// because a mask and compare of a single bit can be handled by inverting the
495 /// predicate, for example:
496 /// (X & 8) == 8 ---> (X & 8) != 0
497 virtual bool hasAndNotCompare(SDValue Y) const {
501 /// Return true if the target has a bitwise and-not operation:
503 /// This can be used to simplify select or other instructions.
504 virtual bool hasAndNot(SDValue X) const {
505 // If the target has the more complex version of this operation, assume that
506 // it has this operation too.
507 return hasAndNotCompare(X);
510 /// \brief Return true if the target wants to use the optimization that
511 /// turns ext(promotableInst1(...(promotableInstN(load)))) into
512 /// promotedInst1(...(promotedInstN(ext(load)))).
513 bool enableExtLdPromotion() const { return EnableExtLdPromotion; }
515 /// Return true if the target can combine store(extractelement VectorTy,
517 /// \p Cost[out] gives the cost of that transformation when this is true.
518 virtual bool canCombineStoreAndExtract(Type *VectorTy, Value *Idx,
519 unsigned &Cost) const {
523 /// Return true if target supports floating point exceptions.
524 bool hasFloatingPointExceptions() const {
525 return HasFloatingPointExceptions;
528 /// Return true if target always beneficiates from combining into FMA for a
529 /// given value type. This must typically return false on targets where FMA
530 /// takes more cycles to execute than FADD.
531 virtual bool enableAggressiveFMAFusion(EVT VT) const {
535 /// Return the ValueType of the result of SETCC operations.
536 virtual EVT getSetCCResultType(const DataLayout &DL, LLVMContext &Context,
539 /// Return the ValueType for comparison libcalls. Comparions libcalls include
540 /// floating point comparion calls, and Ordered/Unordered check calls on
541 /// floating point numbers.
543 MVT::SimpleValueType getCmpLibcallReturnType() const;
545 /// For targets without i1 registers, this gives the nature of the high-bits
546 /// of boolean values held in types wider than i1.
548 /// "Boolean values" are special true/false values produced by nodes like
549 /// SETCC and consumed (as the condition) by nodes like SELECT and BRCOND.
550 /// Not to be confused with general values promoted from i1. Some cpus
551 /// distinguish between vectors of boolean and scalars; the isVec parameter
552 /// selects between the two kinds. For example on X86 a scalar boolean should
553 /// be zero extended from i1, while the elements of a vector of booleans
554 /// should be sign extended from i1.
556 /// Some cpus also treat floating point types the same way as they treat
557 /// vectors instead of the way they treat scalars.
558 BooleanContent getBooleanContents(bool isVec, bool isFloat) const {
560 return BooleanVectorContents;
561 return isFloat ? BooleanFloatContents : BooleanContents;
564 BooleanContent getBooleanContents(EVT Type) const {
565 return getBooleanContents(Type.isVector(), Type.isFloatingPoint());
568 /// Return target scheduling preference.
569 Sched::Preference getSchedulingPreference() const {
570 return SchedPreferenceInfo;
573 /// Some scheduler, e.g. hybrid, can switch to different scheduling heuristics
574 /// for different nodes. This function returns the preference (or none) for
576 virtual Sched::Preference getSchedulingPreference(SDNode *) const {
580 /// Return the register class that should be used for the specified value
582 virtual const TargetRegisterClass *getRegClassFor(MVT VT) const {
583 const TargetRegisterClass *RC = RegClassForVT[VT.SimpleTy];
584 assert(RC && "This value type is not natively supported!");
588 /// Return the 'representative' register class for the specified value
591 /// The 'representative' register class is the largest legal super-reg
592 /// register class for the register class of the value type. For example, on
593 /// i386 the rep register class for i8, i16, and i32 are GR32; while the rep
594 /// register class is GR64 on x86_64.
595 virtual const TargetRegisterClass *getRepRegClassFor(MVT VT) const {
596 const TargetRegisterClass *RC = RepRegClassForVT[VT.SimpleTy];
600 /// Return the cost of the 'representative' register class for the specified
602 virtual uint8_t getRepRegClassCostFor(MVT VT) const {
603 return RepRegClassCostForVT[VT.SimpleTy];
606 /// Return true if the target has native support for the specified value type.
607 /// This means that it has a register that directly holds it without
608 /// promotions or expansions.
609 bool isTypeLegal(EVT VT) const {
610 assert(!VT.isSimple() ||
611 (unsigned)VT.getSimpleVT().SimpleTy < array_lengthof(RegClassForVT));
612 return VT.isSimple() && RegClassForVT[VT.getSimpleVT().SimpleTy] != nullptr;
615 class ValueTypeActionImpl {
616 /// ValueTypeActions - For each value type, keep a LegalizeTypeAction enum
617 /// that indicates how instruction selection should deal with the type.
618 LegalizeTypeAction ValueTypeActions[MVT::LAST_VALUETYPE];
621 ValueTypeActionImpl() {
622 std::fill(std::begin(ValueTypeActions), std::end(ValueTypeActions),
626 LegalizeTypeAction getTypeAction(MVT VT) const {
627 return ValueTypeActions[VT.SimpleTy];
630 void setTypeAction(MVT VT, LegalizeTypeAction Action) {
631 ValueTypeActions[VT.SimpleTy] = Action;
635 const ValueTypeActionImpl &getValueTypeActions() const {
636 return ValueTypeActions;
639 /// Return how we should legalize values of this type, either it is already
640 /// legal (return 'Legal') or we need to promote it to a larger type (return
641 /// 'Promote'), or we need to expand it into multiple registers of smaller
642 /// integer type (return 'Expand'). 'Custom' is not an option.
643 LegalizeTypeAction getTypeAction(LLVMContext &Context, EVT VT) const {
644 return getTypeConversion(Context, VT).first;
646 LegalizeTypeAction getTypeAction(MVT VT) const {
647 return ValueTypeActions.getTypeAction(VT);
650 /// For types supported by the target, this is an identity function. For
651 /// types that must be promoted to larger types, this returns the larger type
652 /// to promote to. For integer types that are larger than the largest integer
653 /// register, this contains one step in the expansion to get to the smaller
654 /// register. For illegal floating point types, this returns the integer type
656 EVT getTypeToTransformTo(LLVMContext &Context, EVT VT) const {
657 return getTypeConversion(Context, VT).second;
660 /// For types supported by the target, this is an identity function. For
661 /// types that must be expanded (i.e. integer types that are larger than the
662 /// largest integer register or illegal floating point types), this returns
663 /// the largest legal type it will be expanded to.
664 EVT getTypeToExpandTo(LLVMContext &Context, EVT VT) const {
665 assert(!VT.isVector());
667 switch (getTypeAction(Context, VT)) {
670 case TypeExpandInteger:
671 VT = getTypeToTransformTo(Context, VT);
674 llvm_unreachable("Type is not legal nor is it to be expanded!");
679 /// Vector types are broken down into some number of legal first class types.
680 /// For example, EVT::v8f32 maps to 2 EVT::v4f32 with Altivec or SSE1, or 8
681 /// promoted EVT::f64 values with the X86 FP stack. Similarly, EVT::v2i64
682 /// turns into 4 EVT::i32 values with both PPC and X86.
684 /// This method returns the number of registers needed, and the VT for each
685 /// register. It also returns the VT and quantity of the intermediate values
686 /// before they are promoted/expanded.
687 unsigned getVectorTypeBreakdown(LLVMContext &Context, EVT VT,
689 unsigned &NumIntermediates,
690 MVT &RegisterVT) const;
692 /// Certain targets such as MIPS require that some types such as vectors are
693 /// always broken down into scalars in some contexts. This occurs even if the
694 /// vector type is legal.
695 virtual unsigned getVectorTypeBreakdownForCallingConv(
696 LLVMContext &Context, EVT VT, EVT &IntermediateVT,
697 unsigned &NumIntermediates, MVT &RegisterVT) const {
698 return getVectorTypeBreakdown(Context, VT, IntermediateVT, NumIntermediates,
702 struct IntrinsicInfo {
703 unsigned opc = 0; // target opcode
704 EVT memVT; // memory VT
705 const Value* ptrVal = nullptr; // value representing memory location
706 int offset = 0; // offset off of ptrVal
707 unsigned size = 0; // the size of the memory location
708 // (taken from memVT if zero)
709 unsigned align = 1; // alignment
710 bool vol = false; // is volatile?
711 bool readMem = false; // reads memory?
712 bool writeMem = false; // writes memory?
714 IntrinsicInfo() = default;
717 /// Given an intrinsic, checks if on the target the intrinsic will need to map
718 /// to a MemIntrinsicNode (touches memory). If this is the case, it returns
719 /// true and store the intrinsic information into the IntrinsicInfo that was
720 /// passed to the function.
721 virtual bool getTgtMemIntrinsic(IntrinsicInfo &, const CallInst &,
722 unsigned /*Intrinsic*/) const {
726 /// Returns true if the target can instruction select the specified FP
727 /// immediate natively. If false, the legalizer will materialize the FP
728 /// immediate as a load from a constant pool.
729 virtual bool isFPImmLegal(const APFloat &/*Imm*/, EVT /*VT*/) const {
733 /// Targets can use this to indicate that they only support *some*
734 /// VECTOR_SHUFFLE operations, those with specific masks. By default, if a
735 /// target supports the VECTOR_SHUFFLE node, all mask values are assumed to be
737 virtual bool isShuffleMaskLegal(ArrayRef<int> /*Mask*/, EVT /*VT*/) const {
741 /// Returns true if the operation can trap for the value type.
743 /// VT must be a legal type. By default, we optimistically assume most
744 /// operations don't trap except for integer divide and remainder.
745 virtual bool canOpTrap(unsigned Op, EVT VT) const;
747 /// Similar to isShuffleMaskLegal. This is used by Targets can use this to
748 /// indicate if there is a suitable VECTOR_SHUFFLE that can be used to replace
749 /// a VAND with a constant pool entry.
750 virtual bool isVectorClearMaskLegal(const SmallVectorImpl<int> &/*Mask*/,
755 /// Return how this operation should be treated: either it is legal, needs to
756 /// be promoted to a larger size, needs to be expanded to some other code
757 /// sequence, or the target has a custom expander for it.
758 LegalizeAction getOperationAction(unsigned Op, EVT VT) const {
759 if (VT.isExtended()) return Expand;
760 // If a target-specific SDNode requires legalization, require the target
761 // to provide custom legalization for it.
762 if (Op >= array_lengthof(OpActions[0])) return Custom;
763 return OpActions[(unsigned)VT.getSimpleVT().SimpleTy][Op];
766 /// Return true if the specified operation is legal on this target or can be
767 /// made legal with custom lowering. This is used to help guide high-level
768 /// lowering decisions.
769 bool isOperationLegalOrCustom(unsigned Op, EVT VT) const {
770 return (VT == MVT::Other || isTypeLegal(VT)) &&
771 (getOperationAction(Op, VT) == Legal ||
772 getOperationAction(Op, VT) == Custom);
775 /// Return true if the specified operation is legal on this target or can be
776 /// made legal using promotion. This is used to help guide high-level lowering
778 bool isOperationLegalOrPromote(unsigned Op, EVT VT) const {
779 return (VT == MVT::Other || isTypeLegal(VT)) &&
780 (getOperationAction(Op, VT) == Legal ||
781 getOperationAction(Op, VT) == Promote);
784 /// Return true if the specified operation is legal on this target or can be
785 /// made legal with custom lowering or using promotion. This is used to help
786 /// guide high-level lowering decisions.
787 bool isOperationLegalOrCustomOrPromote(unsigned Op, EVT VT) const {
788 return (VT == MVT::Other || isTypeLegal(VT)) &&
789 (getOperationAction(Op, VT) == Legal ||
790 getOperationAction(Op, VT) == Custom ||
791 getOperationAction(Op, VT) == Promote);
794 /// Return true if the operation uses custom lowering, regardless of whether
795 /// the type is legal or not.
796 bool isOperationCustom(unsigned Op, EVT VT) const {
797 return getOperationAction(Op, VT) == Custom;
800 /// Return true if lowering to a jump table is allowed.
801 bool areJTsAllowed(const Function *Fn) const {
802 if (Fn->getFnAttribute("no-jump-tables").getValueAsString() == "true")
805 return isOperationLegalOrCustom(ISD::BR_JT, MVT::Other) ||
806 isOperationLegalOrCustom(ISD::BRIND, MVT::Other);
809 /// Check whether the range [Low,High] fits in a machine word.
810 bool rangeFitsInWord(const APInt &Low, const APInt &High,
811 const DataLayout &DL) const {
812 // FIXME: Using the pointer type doesn't seem ideal.
813 uint64_t BW = DL.getPointerSizeInBits();
814 uint64_t Range = (High - Low).getLimitedValue(UINT64_MAX - 1) + 1;
818 /// Return true if lowering to a jump table is suitable for a set of case
819 /// clusters which may contain \p NumCases cases, \p Range range of values.
820 /// FIXME: This function check the maximum table size and density, but the
821 /// minimum size is not checked. It would be nice if the the minimum size is
822 /// also combined within this function. Currently, the minimum size check is
823 /// performed in findJumpTable() in SelectionDAGBuiler and
824 /// getEstimatedNumberOfCaseClusters() in BasicTTIImpl.
825 bool isSuitableForJumpTable(const SwitchInst *SI, uint64_t NumCases,
826 uint64_t Range) const {
827 const bool OptForSize = SI->getParent()->getParent()->optForSize();
828 const unsigned MinDensity = getMinimumJumpTableDensity(OptForSize);
829 const unsigned MaxJumpTableSize =
830 OptForSize || getMaximumJumpTableSize() == 0
832 : getMaximumJumpTableSize();
833 // Check whether a range of clusters is dense enough for a jump table.
834 if (Range <= MaxJumpTableSize &&
835 (NumCases * 100 >= Range * MinDensity)) {
841 /// Return true if lowering to a bit test is suitable for a set of case
842 /// clusters which contains \p NumDests unique destinations, \p Low and
843 /// \p High as its lowest and highest case values, and expects \p NumCmps
844 /// case value comparisons. Check if the number of destinations, comparison
845 /// metric, and range are all suitable.
846 bool isSuitableForBitTests(unsigned NumDests, unsigned NumCmps,
847 const APInt &Low, const APInt &High,
848 const DataLayout &DL) const {
849 // FIXME: I don't think NumCmps is the correct metric: a single case and a
850 // range of cases both require only one branch to lower. Just looking at the
851 // number of clusters and destinations should be enough to decide whether to
854 // To lower a range with bit tests, the range must fit the bitwidth of a
856 if (!rangeFitsInWord(Low, High, DL))
859 // Decide whether it's profitable to lower this range with bit tests. Each
860 // destination requires a bit test and branch, and there is an overall range
861 // check branch. For a small number of clusters, separate comparisons might
862 // be cheaper, and for many destinations, splitting the range might be
864 return (NumDests == 1 && NumCmps >= 3) || (NumDests == 2 && NumCmps >= 5) ||
865 (NumDests == 3 && NumCmps >= 6);
868 /// Return true if the specified operation is illegal on this target or
869 /// unlikely to be made legal with custom lowering. This is used to help guide
870 /// high-level lowering decisions.
871 bool isOperationExpand(unsigned Op, EVT VT) const {
872 return (!isTypeLegal(VT) || getOperationAction(Op, VT) == Expand);
875 /// Return true if the specified operation is legal on this target.
876 bool isOperationLegal(unsigned Op, EVT VT) const {
877 return (VT == MVT::Other || isTypeLegal(VT)) &&
878 getOperationAction(Op, VT) == Legal;
881 /// Return how this load with extension should be treated: either it is legal,
882 /// needs to be promoted to a larger size, needs to be expanded to some other
883 /// code sequence, or the target has a custom expander for it.
884 LegalizeAction getLoadExtAction(unsigned ExtType, EVT ValVT,
886 if (ValVT.isExtended() || MemVT.isExtended()) return Expand;
887 unsigned ValI = (unsigned) ValVT.getSimpleVT().SimpleTy;
888 unsigned MemI = (unsigned) MemVT.getSimpleVT().SimpleTy;
889 assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValI < MVT::LAST_VALUETYPE &&
890 MemI < MVT::LAST_VALUETYPE && "Table isn't big enough!");
891 unsigned Shift = 4 * ExtType;
892 return (LegalizeAction)((LoadExtActions[ValI][MemI] >> Shift) & 0xf);
895 /// Return true if the specified load with extension is legal on this target.
896 bool isLoadExtLegal(unsigned ExtType, EVT ValVT, EVT MemVT) const {
897 return getLoadExtAction(ExtType, ValVT, MemVT) == Legal;
900 /// Return true if the specified load with extension is legal or custom
902 bool isLoadExtLegalOrCustom(unsigned ExtType, EVT ValVT, EVT MemVT) const {
903 return getLoadExtAction(ExtType, ValVT, MemVT) == Legal ||
904 getLoadExtAction(ExtType, ValVT, MemVT) == Custom;
907 /// Return how this store with truncation should be treated: either it is
908 /// legal, needs to be promoted to a larger size, needs to be expanded to some
909 /// other code sequence, or the target has a custom expander for it.
910 LegalizeAction getTruncStoreAction(EVT ValVT, EVT MemVT) const {
911 if (ValVT.isExtended() || MemVT.isExtended()) return Expand;
912 unsigned ValI = (unsigned) ValVT.getSimpleVT().SimpleTy;
913 unsigned MemI = (unsigned) MemVT.getSimpleVT().SimpleTy;
914 assert(ValI < MVT::LAST_VALUETYPE && MemI < MVT::LAST_VALUETYPE &&
915 "Table isn't big enough!");
916 return TruncStoreActions[ValI][MemI];
919 /// Return true if the specified store with truncation is legal on this
921 bool isTruncStoreLegal(EVT ValVT, EVT MemVT) const {
922 return isTypeLegal(ValVT) && getTruncStoreAction(ValVT, MemVT) == Legal;
925 /// Return true if the specified store with truncation has solution on this
927 bool isTruncStoreLegalOrCustom(EVT ValVT, EVT MemVT) const {
928 return isTypeLegal(ValVT) &&
929 (getTruncStoreAction(ValVT, MemVT) == Legal ||
930 getTruncStoreAction(ValVT, MemVT) == Custom);
933 /// Return how the indexed load should be treated: either it is legal, needs
934 /// to be promoted to a larger size, needs to be expanded to some other code
935 /// sequence, or the target has a custom expander for it.
937 getIndexedLoadAction(unsigned IdxMode, MVT VT) const {
938 assert(IdxMode < ISD::LAST_INDEXED_MODE && VT.isValid() &&
939 "Table isn't big enough!");
940 unsigned Ty = (unsigned)VT.SimpleTy;
941 return (LegalizeAction)((IndexedModeActions[Ty][IdxMode] & 0xf0) >> 4);
944 /// Return true if the specified indexed load is legal on this target.
945 bool isIndexedLoadLegal(unsigned IdxMode, EVT VT) const {
946 return VT.isSimple() &&
947 (getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Legal ||
948 getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Custom);
951 /// Return how the indexed store should be treated: either it is legal, needs
952 /// to be promoted to a larger size, needs to be expanded to some other code
953 /// sequence, or the target has a custom expander for it.
955 getIndexedStoreAction(unsigned IdxMode, MVT VT) const {
956 assert(IdxMode < ISD::LAST_INDEXED_MODE && VT.isValid() &&
957 "Table isn't big enough!");
958 unsigned Ty = (unsigned)VT.SimpleTy;
959 return (LegalizeAction)(IndexedModeActions[Ty][IdxMode] & 0x0f);
962 /// Return true if the specified indexed load is legal on this target.
963 bool isIndexedStoreLegal(unsigned IdxMode, EVT VT) const {
964 return VT.isSimple() &&
965 (getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Legal ||
966 getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Custom);
969 /// Return how the condition code should be treated: either it is legal, needs
970 /// to be expanded to some other code sequence, or the target has a custom
973 getCondCodeAction(ISD::CondCode CC, MVT VT) const {
974 assert((unsigned)CC < array_lengthof(CondCodeActions) &&
975 ((unsigned)VT.SimpleTy >> 3) < array_lengthof(CondCodeActions[0]) &&
976 "Table isn't big enough!");
977 // See setCondCodeAction for how this is encoded.
978 uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
979 uint32_t Value = CondCodeActions[CC][VT.SimpleTy >> 3];
980 LegalizeAction Action = (LegalizeAction) ((Value >> Shift) & 0xF);
981 assert(Action != Promote && "Can't promote condition code!");
985 /// Return true if the specified condition code is legal on this target.
986 bool isCondCodeLegal(ISD::CondCode CC, MVT VT) const {
988 getCondCodeAction(CC, VT) == Legal ||
989 getCondCodeAction(CC, VT) == Custom;
992 /// If the action for this operation is to promote, this method returns the
993 /// ValueType to promote to.
994 MVT getTypeToPromoteTo(unsigned Op, MVT VT) const {
995 assert(getOperationAction(Op, VT) == Promote &&
996 "This operation isn't promoted!");
998 // See if this has an explicit type specified.
999 std::map<std::pair<unsigned, MVT::SimpleValueType>,
1000 MVT::SimpleValueType>::const_iterator PTTI =
1001 PromoteToType.find(std::make_pair(Op, VT.SimpleTy));
1002 if (PTTI != PromoteToType.end()) return PTTI->second;
1004 assert((VT.isInteger() || VT.isFloatingPoint()) &&
1005 "Cannot autopromote this type, add it with AddPromotedToType.");
1009 NVT = (MVT::SimpleValueType)(NVT.SimpleTy+1);
1010 assert(NVT.isInteger() == VT.isInteger() && NVT != MVT::isVoid &&
1011 "Didn't find type to promote to!");
1012 } while (!isTypeLegal(NVT) ||
1013 getOperationAction(Op, NVT) == Promote);
1017 /// Return the EVT corresponding to this LLVM type. This is fixed by the LLVM
1018 /// operations except for the pointer size. If AllowUnknown is true, this
1019 /// will return MVT::Other for types with no EVT counterpart (e.g. structs),
1020 /// otherwise it will assert.
1021 EVT getValueType(const DataLayout &DL, Type *Ty,
1022 bool AllowUnknown = false) const {
1023 // Lower scalar pointers to native pointer types.
1024 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
1025 return getPointerTy(DL, PTy->getAddressSpace());
1027 if (Ty->isVectorTy()) {
1028 VectorType *VTy = cast<VectorType>(Ty);
1029 Type *Elm = VTy->getElementType();
1030 // Lower vectors of pointers to native pointer types.
1031 if (PointerType *PT = dyn_cast<PointerType>(Elm)) {
1032 EVT PointerTy(getPointerTy(DL, PT->getAddressSpace()));
1033 Elm = PointerTy.getTypeForEVT(Ty->getContext());
1036 return EVT::getVectorVT(Ty->getContext(), EVT::getEVT(Elm, false),
1037 VTy->getNumElements());
1039 return EVT::getEVT(Ty, AllowUnknown);
1042 /// Return the MVT corresponding to this LLVM type. See getValueType.
1043 MVT getSimpleValueType(const DataLayout &DL, Type *Ty,
1044 bool AllowUnknown = false) const {
1045 return getValueType(DL, Ty, AllowUnknown).getSimpleVT();
1048 /// Return the desired alignment for ByVal or InAlloca aggregate function
1049 /// arguments in the caller parameter area. This is the actual alignment, not
1051 virtual unsigned getByValTypeAlignment(Type *Ty, const DataLayout &DL) const;
1053 /// Return the type of registers that this ValueType will eventually require.
1054 MVT getRegisterType(MVT VT) const {
1055 assert((unsigned)VT.SimpleTy < array_lengthof(RegisterTypeForVT));
1056 return RegisterTypeForVT[VT.SimpleTy];
1059 /// Return the type of registers that this ValueType will eventually require.
1060 MVT getRegisterType(LLVMContext &Context, EVT VT) const {
1061 if (VT.isSimple()) {
1062 assert((unsigned)VT.getSimpleVT().SimpleTy <
1063 array_lengthof(RegisterTypeForVT));
1064 return RegisterTypeForVT[VT.getSimpleVT().SimpleTy];
1066 if (VT.isVector()) {
1069 unsigned NumIntermediates;
1070 (void)getVectorTypeBreakdown(Context, VT, VT1,
1071 NumIntermediates, RegisterVT);
1074 if (VT.isInteger()) {
1075 return getRegisterType(Context, getTypeToTransformTo(Context, VT));
1077 llvm_unreachable("Unsupported extended type!");
1080 /// Return the number of registers that this ValueType will eventually
1083 /// This is one for any types promoted to live in larger registers, but may be
1084 /// more than one for types (like i64) that are split into pieces. For types
1085 /// like i140, which are first promoted then expanded, it is the number of
1086 /// registers needed to hold all the bits of the original type. For an i140
1087 /// on a 32 bit machine this means 5 registers.
1088 unsigned getNumRegisters(LLVMContext &Context, EVT VT) const {
1089 if (VT.isSimple()) {
1090 assert((unsigned)VT.getSimpleVT().SimpleTy <
1091 array_lengthof(NumRegistersForVT));
1092 return NumRegistersForVT[VT.getSimpleVT().SimpleTy];
1094 if (VT.isVector()) {
1097 unsigned NumIntermediates;
1098 return getVectorTypeBreakdown(Context, VT, VT1, NumIntermediates, VT2);
1100 if (VT.isInteger()) {
1101 unsigned BitWidth = VT.getSizeInBits();
1102 unsigned RegWidth = getRegisterType(Context, VT).getSizeInBits();
1103 return (BitWidth + RegWidth - 1) / RegWidth;
1105 llvm_unreachable("Unsupported extended type!");
1108 /// Certain combinations of ABIs, Targets and features require that types
1109 /// are legal for some operations and not for other operations.
1110 /// For MIPS all vector types must be passed through the integer register set.
1111 virtual MVT getRegisterTypeForCallingConv(MVT VT) const {
1112 return getRegisterType(VT);
1115 virtual MVT getRegisterTypeForCallingConv(LLVMContext &Context,
1117 return getRegisterType(Context, VT);
1120 /// Certain targets require unusual breakdowns of certain types. For MIPS,
1121 /// this occurs when a vector type is used, as vector are passed through the
1122 /// integer register set.
1123 virtual unsigned getNumRegistersForCallingConv(LLVMContext &Context,
1125 return getNumRegisters(Context, VT);
1128 /// Certain targets have context senstive alignment requirements, where one
1129 /// type has the alignment requirement of another type.
1130 virtual unsigned getABIAlignmentForCallingConv(Type *ArgTy,
1131 DataLayout DL) const {
1132 return DL.getABITypeAlignment(ArgTy);
1135 /// If true, then instruction selection should seek to shrink the FP constant
1136 /// of the specified type to a smaller type in order to save space and / or
1138 virtual bool ShouldShrinkFPConstant(EVT) const { return true; }
1140 // Return true if it is profitable to reduce the given load node to a smaller
1143 // e.g. (i16 (trunc (i32 (load x))) -> i16 load x should be performed
1144 virtual bool shouldReduceLoadWidth(SDNode *Load,
1145 ISD::LoadExtType ExtTy,
1150 /// When splitting a value of the specified type into parts, does the Lo
1151 /// or Hi part come first? This usually follows the endianness, except
1152 /// for ppcf128, where the Hi part always comes first.
1153 bool hasBigEndianPartOrdering(EVT VT, const DataLayout &DL) const {
1154 return DL.isBigEndian() || VT == MVT::ppcf128;
1157 /// If true, the target has custom DAG combine transformations that it can
1158 /// perform for the specified node.
1159 bool hasTargetDAGCombine(ISD::NodeType NT) const {
1160 assert(unsigned(NT >> 3) < array_lengthof(TargetDAGCombineArray));
1161 return TargetDAGCombineArray[NT >> 3] & (1 << (NT&7));
1164 unsigned getGatherAllAliasesMaxDepth() const {
1165 return GatherAllAliasesMaxDepth;
1168 /// Returns the size of the platform's va_list object.
1169 virtual unsigned getVaListSizeInBits(const DataLayout &DL) const {
1170 return getPointerTy(DL).getSizeInBits();
1173 /// \brief Get maximum # of store operations permitted for llvm.memset
1175 /// This function returns the maximum number of store operations permitted
1176 /// to replace a call to llvm.memset. The value is set by the target at the
1177 /// performance threshold for such a replacement. If OptSize is true,
1178 /// return the limit for functions that have OptSize attribute.
1179 unsigned getMaxStoresPerMemset(bool OptSize) const {
1180 return OptSize ? MaxStoresPerMemsetOptSize : MaxStoresPerMemset;
1183 /// \brief Get maximum # of store operations permitted for llvm.memcpy
1185 /// This function returns the maximum number of store operations permitted
1186 /// to replace a call to llvm.memcpy. The value is set by the target at the
1187 /// performance threshold for such a replacement. If OptSize is true,
1188 /// return the limit for functions that have OptSize attribute.
1189 unsigned getMaxStoresPerMemcpy(bool OptSize) const {
1190 return OptSize ? MaxStoresPerMemcpyOptSize : MaxStoresPerMemcpy;
1193 /// Get maximum # of load operations permitted for memcmp
1195 /// This function returns the maximum number of load operations permitted
1196 /// to replace a call to memcmp. The value is set by the target at the
1197 /// performance threshold for such a replacement. If OptSize is true,
1198 /// return the limit for functions that have OptSize attribute.
1199 unsigned getMaxExpandSizeMemcmp(bool OptSize) const {
1200 return OptSize ? MaxLoadsPerMemcmpOptSize : MaxLoadsPerMemcmp;
1203 /// \brief Get maximum # of store operations permitted for llvm.memmove
1205 /// This function returns the maximum number of store operations permitted
1206 /// to replace a call to llvm.memmove. The value is set by the target at the
1207 /// performance threshold for such a replacement. If OptSize is true,
1208 /// return the limit for functions that have OptSize attribute.
1209 unsigned getMaxStoresPerMemmove(bool OptSize) const {
1210 return OptSize ? MaxStoresPerMemmoveOptSize : MaxStoresPerMemmove;
1213 /// \brief Determine if the target supports unaligned memory accesses.
1215 /// This function returns true if the target allows unaligned memory accesses
1216 /// of the specified type in the given address space. If true, it also returns
1217 /// whether the unaligned memory access is "fast" in the last argument by
1218 /// reference. This is used, for example, in situations where an array
1219 /// copy/move/set is converted to a sequence of store operations. Its use
1220 /// helps to ensure that such replacements don't generate code that causes an
1221 /// alignment error (trap) on the target machine.
1222 virtual bool allowsMisalignedMemoryAccesses(EVT,
1223 unsigned AddrSpace = 0,
1225 bool * /*Fast*/ = nullptr) const {
1229 /// Return true if the target supports a memory access of this type for the
1230 /// given address space and alignment. If the access is allowed, the optional
1231 /// final parameter returns if the access is also fast (as defined by the
1233 bool allowsMemoryAccess(LLVMContext &Context, const DataLayout &DL, EVT VT,
1234 unsigned AddrSpace = 0, unsigned Alignment = 1,
1235 bool *Fast = nullptr) const;
1237 /// Returns the target specific optimal type for load and store operations as
1238 /// a result of memset, memcpy, and memmove lowering.
1240 /// If DstAlign is zero that means it's safe to destination alignment can
1241 /// satisfy any constraint. Similarly if SrcAlign is zero it means there isn't
1242 /// a need to check it against alignment requirement, probably because the
1243 /// source does not need to be loaded. If 'IsMemset' is true, that means it's
1244 /// expanding a memset. If 'ZeroMemset' is true, that means it's a memset of
1245 /// zero. 'MemcpyStrSrc' indicates whether the memcpy source is constant so it
1246 /// does not need to be loaded. It returns EVT::Other if the type should be
1247 /// determined using generic target-independent logic.
1248 virtual EVT getOptimalMemOpType(uint64_t /*Size*/,
1249 unsigned /*DstAlign*/, unsigned /*SrcAlign*/,
1251 bool /*ZeroMemset*/,
1252 bool /*MemcpyStrSrc*/,
1253 MachineFunction &/*MF*/) const {
1257 /// Returns true if it's safe to use load / store of the specified type to
1258 /// expand memcpy / memset inline.
1260 /// This is mostly true for all types except for some special cases. For
1261 /// example, on X86 targets without SSE2 f64 load / store are done with fldl /
1262 /// fstpl which also does type conversion. Note the specified type doesn't
1263 /// have to be legal as the hook is used before type legalization.
1264 virtual bool isSafeMemOpType(MVT /*VT*/) const { return true; }
1266 /// Determine if we should use _setjmp or setjmp to implement llvm.setjmp.
1267 bool usesUnderscoreSetJmp() const {
1268 return UseUnderscoreSetJmp;
1271 /// Determine if we should use _longjmp or longjmp to implement llvm.longjmp.
1272 bool usesUnderscoreLongJmp() const {
1273 return UseUnderscoreLongJmp;
1276 /// Return lower limit for number of blocks in a jump table.
1277 unsigned getMinimumJumpTableEntries() const;
1279 /// Return lower limit of the density in a jump table.
1280 unsigned getMinimumJumpTableDensity(bool OptForSize) const;
1282 /// Return upper limit for number of entries in a jump table.
1283 /// Zero if no limit.
1284 unsigned getMaximumJumpTableSize() const;
1286 virtual bool isJumpTableRelative() const {
1287 return TM.isPositionIndependent();
1290 /// If a physical register, this specifies the register that
1291 /// llvm.savestack/llvm.restorestack should save and restore.
1292 unsigned getStackPointerRegisterToSaveRestore() const {
1293 return StackPointerRegisterToSaveRestore;
1296 /// If a physical register, this returns the register that receives the
1297 /// exception address on entry to an EH pad.
1299 getExceptionPointerRegister(const Constant *PersonalityFn) const {
1300 // 0 is guaranteed to be the NoRegister value on all targets
1304 /// If a physical register, this returns the register that receives the
1305 /// exception typeid on entry to a landing pad.
1307 getExceptionSelectorRegister(const Constant *PersonalityFn) const {
1308 // 0 is guaranteed to be the NoRegister value on all targets
1312 virtual bool needsFixedCatchObjects() const {
1313 report_fatal_error("Funclet EH is not implemented for this target");
1316 /// Returns the target's jmp_buf size in bytes (if never set, the default is
1318 unsigned getJumpBufSize() const {
1322 /// Returns the target's jmp_buf alignment in bytes (if never set, the default
1324 unsigned getJumpBufAlignment() const {
1325 return JumpBufAlignment;
1328 /// Return the minimum stack alignment of an argument.
1329 unsigned getMinStackArgumentAlignment() const {
1330 return MinStackArgumentAlignment;
1333 /// Return the minimum function alignment.
1334 unsigned getMinFunctionAlignment() const {
1335 return MinFunctionAlignment;
1338 /// Return the preferred function alignment.
1339 unsigned getPrefFunctionAlignment() const {
1340 return PrefFunctionAlignment;
1343 /// Return the preferred loop alignment.
1344 virtual unsigned getPrefLoopAlignment(MachineLoop *ML = nullptr) const {
1345 return PrefLoopAlignment;
1348 /// If the target has a standard location for the stack protector guard,
1349 /// returns the address of that location. Otherwise, returns nullptr.
1350 /// DEPRECATED: please override useLoadStackGuardNode and customize
1351 /// LOAD_STACK_GUARD, or customize @llvm.stackguard().
1352 virtual Value *getIRStackGuard(IRBuilder<> &IRB) const;
1354 /// Inserts necessary declarations for SSP (stack protection) purpose.
1355 /// Should be used only when getIRStackGuard returns nullptr.
1356 virtual void insertSSPDeclarations(Module &M) const;
1358 /// Return the variable that's previously inserted by insertSSPDeclarations,
1359 /// if any, otherwise return nullptr. Should be used only when
1360 /// getIRStackGuard returns nullptr.
1361 virtual Value *getSDagStackGuard(const Module &M) const;
1363 /// If this function returns true, stack protection checks should XOR the
1364 /// frame pointer (or whichever pointer is used to address locals) into the
1365 /// stack guard value before checking it. getIRStackGuard must return nullptr
1366 /// if this returns true.
1367 virtual bool useStackGuardXorFP() const { return false; }
1369 /// If the target has a standard stack protection check function that
1370 /// performs validation and error handling, returns the function. Otherwise,
1371 /// returns nullptr. Must be previously inserted by insertSSPDeclarations.
1372 /// Should be used only when getIRStackGuard returns nullptr.
1373 virtual Value *getSSPStackGuardCheck(const Module &M) const;
1376 Value *getDefaultSafeStackPointerLocation(IRBuilder<> &IRB,
1380 /// Returns the target-specific address of the unsafe stack pointer.
1381 virtual Value *getSafeStackPointerLocation(IRBuilder<> &IRB) const;
1383 /// Returns the name of the symbol used to emit stack probes or the empty
1384 /// string if not applicable.
1385 virtual StringRef getStackProbeSymbolName(MachineFunction &MF) const {
1389 /// Returns true if a cast between SrcAS and DestAS is a noop.
1390 virtual bool isNoopAddrSpaceCast(unsigned SrcAS, unsigned DestAS) const {
1394 /// Returns true if a cast from SrcAS to DestAS is "cheap", such that e.g. we
1395 /// are happy to sink it into basic blocks.
1396 virtual bool isCheapAddrSpaceCast(unsigned SrcAS, unsigned DestAS) const {
1397 return isNoopAddrSpaceCast(SrcAS, DestAS);
1400 /// Return true if the pointer arguments to CI should be aligned by aligning
1401 /// the object whose address is being passed. If so then MinSize is set to the
1402 /// minimum size the object must be to be aligned and PrefAlign is set to the
1403 /// preferred alignment.
1404 virtual bool shouldAlignPointerArgs(CallInst * /*CI*/, unsigned & /*MinSize*/,
1405 unsigned & /*PrefAlign*/) const {
1409 //===--------------------------------------------------------------------===//
1410 /// \name Helpers for TargetTransformInfo implementations
1413 /// Get the ISD node that corresponds to the Instruction class opcode.
1414 int InstructionOpcodeToISD(unsigned Opcode) const;
1416 /// Estimate the cost of type-legalization and the legalized type.
1417 std::pair<int, MVT> getTypeLegalizationCost(const DataLayout &DL,
1422 //===--------------------------------------------------------------------===//
1423 /// \name Helpers for atomic expansion.
1426 /// Returns the maximum atomic operation size (in bits) supported by
1427 /// the backend. Atomic operations greater than this size (as well
1428 /// as ones that are not naturally aligned), will be expanded by
1429 /// AtomicExpandPass into an __atomic_* library call.
1430 unsigned getMaxAtomicSizeInBitsSupported() const {
1431 return MaxAtomicSizeInBitsSupported;
1434 /// Returns the size of the smallest cmpxchg or ll/sc instruction
1435 /// the backend supports. Any smaller operations are widened in
1436 /// AtomicExpandPass.
1438 /// Note that *unlike* operations above the maximum size, atomic ops
1439 /// are still natively supported below the minimum; they just
1440 /// require a more complex expansion.
1441 unsigned getMinCmpXchgSizeInBits() const { return MinCmpXchgSizeInBits; }
1443 /// Whether AtomicExpandPass should automatically insert fences and reduce
1444 /// ordering for this atomic. This should be true for most architectures with
1445 /// weak memory ordering. Defaults to false.
1446 virtual bool shouldInsertFencesForAtomic(const Instruction *I) const {
1450 /// Perform a load-linked operation on Addr, returning a "Value *" with the
1451 /// corresponding pointee type. This may entail some non-trivial operations to
1452 /// truncate or reconstruct types that will be illegal in the backend. See
1453 /// ARMISelLowering for an example implementation.
1454 virtual Value *emitLoadLinked(IRBuilder<> &Builder, Value *Addr,
1455 AtomicOrdering Ord) const {
1456 llvm_unreachable("Load linked unimplemented on this target");
1459 /// Perform a store-conditional operation to Addr. Return the status of the
1460 /// store. This should be 0 if the store succeeded, non-zero otherwise.
1461 virtual Value *emitStoreConditional(IRBuilder<> &Builder, Value *Val,
1462 Value *Addr, AtomicOrdering Ord) const {
1463 llvm_unreachable("Store conditional unimplemented on this target");
1466 /// Inserts in the IR a target-specific intrinsic specifying a fence.
1467 /// It is called by AtomicExpandPass before expanding an
1468 /// AtomicRMW/AtomicCmpXchg/AtomicStore/AtomicLoad
1469 /// if shouldInsertFencesForAtomic returns true.
1471 /// Inst is the original atomic instruction, prior to other expansions that
1472 /// may be performed.
1474 /// This function should either return a nullptr, or a pointer to an IR-level
1475 /// Instruction*. Even complex fence sequences can be represented by a
1476 /// single Instruction* through an intrinsic to be lowered later.
1477 /// Backends should override this method to produce target-specific intrinsic
1478 /// for their fences.
1479 /// FIXME: Please note that the default implementation here in terms of
1480 /// IR-level fences exists for historical/compatibility reasons and is
1481 /// *unsound* ! Fences cannot, in general, be used to restore sequential
1482 /// consistency. For example, consider the following example:
1483 /// atomic<int> x = y = 0;
1484 /// int r1, r2, r3, r4;
1495 /// r1 = r3 = 1 and r2 = r4 = 0 is impossible as long as the accesses are all
1496 /// seq_cst. But if they are lowered to monotonic accesses, no amount of
1497 /// IR-level fences can prevent it.
1499 virtual Instruction *emitLeadingFence(IRBuilder<> &Builder, Instruction *Inst,
1500 AtomicOrdering Ord) const {
1501 if (isReleaseOrStronger(Ord) && Inst->hasAtomicStore())
1502 return Builder.CreateFence(Ord);
1507 virtual Instruction *emitTrailingFence(IRBuilder<> &Builder,
1509 AtomicOrdering Ord) const {
1510 if (isAcquireOrStronger(Ord))
1511 return Builder.CreateFence(Ord);
1517 // Emits code that executes when the comparison result in the ll/sc
1518 // expansion of a cmpxchg instruction is such that the store-conditional will
1519 // not execute. This makes it possible to balance out the load-linked with
1520 // a dedicated instruction, if desired.
1521 // E.g., on ARM, if ldrex isn't followed by strex, the exclusive monitor would
1522 // be unnecessarily held, except if clrex, inserted by this hook, is executed.
1523 virtual void emitAtomicCmpXchgNoStoreLLBalance(IRBuilder<> &Builder) const {}
1525 /// Returns true if the given (atomic) store should be expanded by the
1526 /// IR-level AtomicExpand pass into an "atomic xchg" which ignores its input.
1527 virtual bool shouldExpandAtomicStoreInIR(StoreInst *SI) const {
1531 /// Returns true if arguments should be sign-extended in lib calls.
1532 virtual bool shouldSignExtendTypeInLibCall(EVT Type, bool IsSigned) const {
1536 /// Returns how the given (atomic) load should be expanded by the
1537 /// IR-level AtomicExpand pass.
1538 virtual AtomicExpansionKind shouldExpandAtomicLoadInIR(LoadInst *LI) const {
1539 return AtomicExpansionKind::None;
1542 /// Returns true if the given atomic cmpxchg should be expanded by the
1543 /// IR-level AtomicExpand pass into a load-linked/store-conditional sequence
1544 /// (through emitLoadLinked() and emitStoreConditional()).
1545 virtual bool shouldExpandAtomicCmpXchgInIR(AtomicCmpXchgInst *AI) const {
1549 /// Returns how the IR-level AtomicExpand pass should expand the given
1550 /// AtomicRMW, if at all. Default is to never expand.
1551 virtual AtomicExpansionKind shouldExpandAtomicRMWInIR(AtomicRMWInst *) const {
1552 return AtomicExpansionKind::None;
1555 /// On some platforms, an AtomicRMW that never actually modifies the value
1556 /// (such as fetch_add of 0) can be turned into a fence followed by an
1557 /// atomic load. This may sound useless, but it makes it possible for the
1558 /// processor to keep the cacheline shared, dramatically improving
1559 /// performance. And such idempotent RMWs are useful for implementing some
1560 /// kinds of locks, see for example (justification + benchmarks):
1561 /// http://www.hpl.hp.com/techreports/2012/HPL-2012-68.pdf
1562 /// This method tries doing that transformation, returning the atomic load if
1563 /// it succeeds, and nullptr otherwise.
1564 /// If shouldExpandAtomicLoadInIR returns true on that load, it will undergo
1565 /// another round of expansion.
1567 lowerIdempotentRMWIntoFencedLoad(AtomicRMWInst *RMWI) const {
1571 /// Returns how the platform's atomic operations are extended (ZERO_EXTEND,
1572 /// SIGN_EXTEND, or ANY_EXTEND).
1573 virtual ISD::NodeType getExtendForAtomicOps() const {
1574 return ISD::ZERO_EXTEND;
1579 /// Returns true if we should normalize
1580 /// select(N0&N1, X, Y) => select(N0, select(N1, X, Y), Y) and
1581 /// select(N0|N1, X, Y) => select(N0, select(N1, X, Y, Y)) if it is likely
1582 /// that it saves us from materializing N0 and N1 in an integer register.
1583 /// Targets that are able to perform and/or on flags should return false here.
1584 virtual bool shouldNormalizeToSelectSequence(LLVMContext &Context,
1586 // If a target has multiple condition registers, then it likely has logical
1587 // operations on those registers.
1588 if (hasMultipleConditionRegisters())
1590 // Only do the transform if the value won't be split into multiple
1592 LegalizeTypeAction Action = getTypeAction(Context, VT);
1593 return Action != TypeExpandInteger && Action != TypeExpandFloat &&
1594 Action != TypeSplitVector;
1597 /// Return true if a select of constants (select Cond, C1, C2) should be
1598 /// transformed into simple math ops with the condition value. For example:
1599 /// select Cond, C1, C1-1 --> add (zext Cond), C1-1
1600 virtual bool convertSelectOfConstantsToMath(EVT VT) const {
1604 //===--------------------------------------------------------------------===//
1605 // TargetLowering Configuration Methods - These methods should be invoked by
1606 // the derived class constructor to configure this object for the target.
1609 /// Specify how the target extends the result of integer and floating point
1610 /// boolean values from i1 to a wider type. See getBooleanContents.
1611 void setBooleanContents(BooleanContent Ty) {
1612 BooleanContents = Ty;
1613 BooleanFloatContents = Ty;
1616 /// Specify how the target extends the result of integer and floating point
1617 /// boolean values from i1 to a wider type. See getBooleanContents.
1618 void setBooleanContents(BooleanContent IntTy, BooleanContent FloatTy) {
1619 BooleanContents = IntTy;
1620 BooleanFloatContents = FloatTy;
1623 /// Specify how the target extends the result of a vector boolean value from a
1624 /// vector of i1 to a wider type. See getBooleanContents.
1625 void setBooleanVectorContents(BooleanContent Ty) {
1626 BooleanVectorContents = Ty;
1629 /// Specify the target scheduling preference.
1630 void setSchedulingPreference(Sched::Preference Pref) {
1631 SchedPreferenceInfo = Pref;
1634 /// Indicate whether this target prefers to use _setjmp to implement
1635 /// llvm.setjmp or the version without _. Defaults to false.
1636 void setUseUnderscoreSetJmp(bool Val) {
1637 UseUnderscoreSetJmp = Val;
1640 /// Indicate whether this target prefers to use _longjmp to implement
1641 /// llvm.longjmp or the version without _. Defaults to false.
1642 void setUseUnderscoreLongJmp(bool Val) {
1643 UseUnderscoreLongJmp = Val;
1646 /// Indicate the minimum number of blocks to generate jump tables.
1647 void setMinimumJumpTableEntries(unsigned Val);
1649 /// Indicate the maximum number of entries in jump tables.
1650 /// Set to zero to generate unlimited jump tables.
1651 void setMaximumJumpTableSize(unsigned);
1653 /// If set to a physical register, this specifies the register that
1654 /// llvm.savestack/llvm.restorestack should save and restore.
1655 void setStackPointerRegisterToSaveRestore(unsigned R) {
1656 StackPointerRegisterToSaveRestore = R;
1659 /// Tells the code generator that the target has multiple (allocatable)
1660 /// condition registers that can be used to store the results of comparisons
1661 /// for use by selects and conditional branches. With multiple condition
1662 /// registers, the code generator will not aggressively sink comparisons into
1663 /// the blocks of their users.
1664 void setHasMultipleConditionRegisters(bool hasManyRegs = true) {
1665 HasMultipleConditionRegisters = hasManyRegs;
1668 /// Tells the code generator that the target has BitExtract instructions.
1669 /// The code generator will aggressively sink "shift"s into the blocks of
1670 /// their users if the users will generate "and" instructions which can be
1671 /// combined with "shift" to BitExtract instructions.
1672 void setHasExtractBitsInsn(bool hasExtractInsn = true) {
1673 HasExtractBitsInsn = hasExtractInsn;
1676 /// Tells the code generator not to expand logic operations on comparison
1677 /// predicates into separate sequences that increase the amount of flow
1679 void setJumpIsExpensive(bool isExpensive = true);
1681 /// Tells the code generator that this target supports floating point
1682 /// exceptions and cares about preserving floating point exception behavior.
1683 void setHasFloatingPointExceptions(bool FPExceptions = true) {
1684 HasFloatingPointExceptions = FPExceptions;
1687 /// Tells the code generator which bitwidths to bypass.
1688 void addBypassSlowDiv(unsigned int SlowBitWidth, unsigned int FastBitWidth) {
1689 BypassSlowDivWidths[SlowBitWidth] = FastBitWidth;
1692 /// Add the specified register class as an available regclass for the
1693 /// specified value type. This indicates the selector can handle values of
1694 /// that class natively.
1695 void addRegisterClass(MVT VT, const TargetRegisterClass *RC) {
1696 assert((unsigned)VT.SimpleTy < array_lengthof(RegClassForVT));
1697 RegClassForVT[VT.SimpleTy] = RC;
1700 /// Return the largest legal super-reg register class of the register class
1701 /// for the specified type and its associated "cost".
1702 virtual std::pair<const TargetRegisterClass *, uint8_t>
1703 findRepresentativeClass(const TargetRegisterInfo *TRI, MVT VT) const;
1705 /// Once all of the register classes are added, this allows us to compute
1706 /// derived properties we expose.
1707 void computeRegisterProperties(const TargetRegisterInfo *TRI);
1709 /// Indicate that the specified operation does not work with the specified
1710 /// type and indicate what to do about it. Note that VT may refer to either
1711 /// the type of a result or that of an operand of Op.
1712 void setOperationAction(unsigned Op, MVT VT,
1713 LegalizeAction Action) {
1714 assert(Op < array_lengthof(OpActions[0]) && "Table isn't big enough!");
1715 OpActions[(unsigned)VT.SimpleTy][Op] = Action;
1718 /// Indicate that the specified load with extension does not work with the
1719 /// specified type and indicate what to do about it.
1720 void setLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT,
1721 LegalizeAction Action) {
1722 assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValVT.isValid() &&
1723 MemVT.isValid() && "Table isn't big enough!");
1724 assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
1725 unsigned Shift = 4 * ExtType;
1726 LoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] &= ~((uint16_t)0xF << Shift);
1727 LoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] |= (uint16_t)Action << Shift;
1730 /// Indicate that the specified truncating store does not work with the
1731 /// specified type and indicate what to do about it.
1732 void setTruncStoreAction(MVT ValVT, MVT MemVT,
1733 LegalizeAction Action) {
1734 assert(ValVT.isValid() && MemVT.isValid() && "Table isn't big enough!");
1735 TruncStoreActions[(unsigned)ValVT.SimpleTy][MemVT.SimpleTy] = Action;
1738 /// Indicate that the specified indexed load does or does not work with the
1739 /// specified type and indicate what to do abort it.
1741 /// NOTE: All indexed mode loads are initialized to Expand in
1742 /// TargetLowering.cpp
1743 void setIndexedLoadAction(unsigned IdxMode, MVT VT,
1744 LegalizeAction Action) {
1745 assert(VT.isValid() && IdxMode < ISD::LAST_INDEXED_MODE &&
1746 (unsigned)Action < 0xf && "Table isn't big enough!");
1747 // Load action are kept in the upper half.
1748 IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] &= ~0xf0;
1749 IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] |= ((uint8_t)Action) <<4;
1752 /// Indicate that the specified indexed store does or does not work with the
1753 /// specified type and indicate what to do about it.
1755 /// NOTE: All indexed mode stores are initialized to Expand in
1756 /// TargetLowering.cpp
1757 void setIndexedStoreAction(unsigned IdxMode, MVT VT,
1758 LegalizeAction Action) {
1759 assert(VT.isValid() && IdxMode < ISD::LAST_INDEXED_MODE &&
1760 (unsigned)Action < 0xf && "Table isn't big enough!");
1761 // Store action are kept in the lower half.
1762 IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] &= ~0x0f;
1763 IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] |= ((uint8_t)Action);
1766 /// Indicate that the specified condition code is or isn't supported on the
1767 /// target and indicate what to do about it.
1768 void setCondCodeAction(ISD::CondCode CC, MVT VT,
1769 LegalizeAction Action) {
1770 assert(VT.isValid() && (unsigned)CC < array_lengthof(CondCodeActions) &&
1771 "Table isn't big enough!");
1772 assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
1773 /// The lower 3 bits of the SimpleTy index into Nth 4bit set from the 32-bit
1774 /// value and the upper 29 bits index into the second dimension of the array
1775 /// to select what 32-bit value to use.
1776 uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
1777 CondCodeActions[CC][VT.SimpleTy >> 3] &= ~((uint32_t)0xF << Shift);
1778 CondCodeActions[CC][VT.SimpleTy >> 3] |= (uint32_t)Action << Shift;
1781 /// If Opc/OrigVT is specified as being promoted, the promotion code defaults
1782 /// to trying a larger integer/fp until it can find one that works. If that
1783 /// default is insufficient, this method can be used by the target to override
1785 void AddPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT) {
1786 PromoteToType[std::make_pair(Opc, OrigVT.SimpleTy)] = DestVT.SimpleTy;
1789 /// Convenience method to set an operation to Promote and specify the type
1790 /// in a single call.
1791 void setOperationPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT) {
1792 setOperationAction(Opc, OrigVT, Promote);
1793 AddPromotedToType(Opc, OrigVT, DestVT);
1796 /// Targets should invoke this method for each target independent node that
1797 /// they want to provide a custom DAG combiner for by implementing the
1798 /// PerformDAGCombine virtual method.
1799 void setTargetDAGCombine(ISD::NodeType NT) {
1800 assert(unsigned(NT >> 3) < array_lengthof(TargetDAGCombineArray));
1801 TargetDAGCombineArray[NT >> 3] |= 1 << (NT&7);
1804 /// Set the target's required jmp_buf buffer size (in bytes); default is 200
1805 void setJumpBufSize(unsigned Size) {
1809 /// Set the target's required jmp_buf buffer alignment (in bytes); default is
1811 void setJumpBufAlignment(unsigned Align) {
1812 JumpBufAlignment = Align;
1815 /// Set the target's minimum function alignment (in log2(bytes))
1816 void setMinFunctionAlignment(unsigned Align) {
1817 MinFunctionAlignment = Align;
1820 /// Set the target's preferred function alignment. This should be set if
1821 /// there is a performance benefit to higher-than-minimum alignment (in
1823 void setPrefFunctionAlignment(unsigned Align) {
1824 PrefFunctionAlignment = Align;
1827 /// Set the target's preferred loop alignment. Default alignment is zero, it
1828 /// means the target does not care about loop alignment. The alignment is
1829 /// specified in log2(bytes). The target may also override
1830 /// getPrefLoopAlignment to provide per-loop values.
1831 void setPrefLoopAlignment(unsigned Align) {
1832 PrefLoopAlignment = Align;
1835 /// Set the minimum stack alignment of an argument (in log2(bytes)).
1836 void setMinStackArgumentAlignment(unsigned Align) {
1837 MinStackArgumentAlignment = Align;
1840 /// Set the maximum atomic operation size supported by the
1841 /// backend. Atomic operations greater than this size (as well as
1842 /// ones that are not naturally aligned), will be expanded by
1843 /// AtomicExpandPass into an __atomic_* library call.
1844 void setMaxAtomicSizeInBitsSupported(unsigned SizeInBits) {
1845 MaxAtomicSizeInBitsSupported = SizeInBits;
1848 // Sets the minimum cmpxchg or ll/sc size supported by the backend.
1849 void setMinCmpXchgSizeInBits(unsigned SizeInBits) {
1850 MinCmpXchgSizeInBits = SizeInBits;
1854 //===--------------------------------------------------------------------===//
1855 // Addressing mode description hooks (used by LSR etc).
1858 /// CodeGenPrepare sinks address calculations into the same BB as Load/Store
1859 /// instructions reading the address. This allows as much computation as
1860 /// possible to be done in the address mode for that operand. This hook lets
1861 /// targets also pass back when this should be done on intrinsics which
1863 virtual bool getAddrModeArguments(IntrinsicInst * /*I*/,
1864 SmallVectorImpl<Value*> &/*Ops*/,
1865 Type *&/*AccessTy*/) const {
1869 /// This represents an addressing mode of:
1870 /// BaseGV + BaseOffs + BaseReg + Scale*ScaleReg
1871 /// If BaseGV is null, there is no BaseGV.
1872 /// If BaseOffs is zero, there is no base offset.
1873 /// If HasBaseReg is false, there is no base register.
1874 /// If Scale is zero, there is no ScaleReg. Scale of 1 indicates a reg with
1877 GlobalValue *BaseGV = nullptr;
1878 int64_t BaseOffs = 0;
1879 bool HasBaseReg = false;
1881 AddrMode() = default;
1884 /// Return true if the addressing mode represented by AM is legal for this
1885 /// target, for a load/store of the specified type.
1887 /// The type may be VoidTy, in which case only return true if the addressing
1888 /// mode is legal for a load/store of any legal type. TODO: Handle
1889 /// pre/postinc as well.
1891 /// If the address space cannot be determined, it will be -1.
1893 /// TODO: Remove default argument
1894 virtual bool isLegalAddressingMode(const DataLayout &DL, const AddrMode &AM,
1895 Type *Ty, unsigned AddrSpace,
1896 Instruction *I = nullptr) const;
1898 /// \brief Return the cost of the scaling factor used in the addressing mode
1899 /// represented by AM for this target, for a load/store of the specified type.
1901 /// If the AM is supported, the return value must be >= 0.
1902 /// If the AM is not supported, it returns a negative value.
1903 /// TODO: Handle pre/postinc as well.
1904 /// TODO: Remove default argument
1905 virtual int getScalingFactorCost(const DataLayout &DL, const AddrMode &AM,
1906 Type *Ty, unsigned AS = 0) const {
1907 // Default: assume that any scaling factor used in a legal AM is free.
1908 if (isLegalAddressingMode(DL, AM, Ty, AS))
1913 /// Return true if the specified immediate is legal icmp immediate, that is
1914 /// the target has icmp instructions which can compare a register against the
1915 /// immediate without having to materialize the immediate into a register.
1916 virtual bool isLegalICmpImmediate(int64_t) const {
1920 /// Return true if the specified immediate is legal add immediate, that is the
1921 /// target has add instructions which can add a register with the immediate
1922 /// without having to materialize the immediate into a register.
1923 virtual bool isLegalAddImmediate(int64_t) const {
1927 /// Return true if it's significantly cheaper to shift a vector by a uniform
1928 /// scalar than by an amount which will vary across each lane. On x86, for
1929 /// example, there is a "psllw" instruction for the former case, but no simple
1930 /// instruction for a general "a << b" operation on vectors.
1931 virtual bool isVectorShiftByScalarCheap(Type *Ty) const {
1935 /// Returns true if the opcode is a commutative binary operation.
1936 virtual bool isCommutativeBinOp(unsigned Opcode) const {
1937 // FIXME: This should get its info from the td file.
1947 case ISD::SMUL_LOHI:
1948 case ISD::UMUL_LOHI:
1963 default: return false;
1967 /// Return true if it's free to truncate a value of type FromTy to type
1968 /// ToTy. e.g. On x86 it's free to truncate a i32 value in register EAX to i16
1969 /// by referencing its sub-register AX.
1970 /// Targets must return false when FromTy <= ToTy.
1971 virtual bool isTruncateFree(Type *FromTy, Type *ToTy) const {
1975 /// Return true if a truncation from FromTy to ToTy is permitted when deciding
1976 /// whether a call is in tail position. Typically this means that both results
1977 /// would be assigned to the same register or stack slot, but it could mean
1978 /// the target performs adequate checks of its own before proceeding with the
1979 /// tail call. Targets must return false when FromTy <= ToTy.
1980 virtual bool allowTruncateForTailCall(Type *FromTy, Type *ToTy) const {
1984 virtual bool isTruncateFree(EVT FromVT, EVT ToVT) const {
1988 virtual bool isProfitableToHoist(Instruction *I) const { return true; }
1990 /// Return true if the extension represented by \p I is free.
1991 /// Unlikely the is[Z|FP]ExtFree family which is based on types,
1992 /// this method can use the context provided by \p I to decide
1993 /// whether or not \p I is free.
1994 /// This method extends the behavior of the is[Z|FP]ExtFree family.
1995 /// In other words, if is[Z|FP]Free returns true, then this method
1996 /// returns true as well. The converse is not true.
1997 /// The target can perform the adequate checks by overriding isExtFreeImpl.
1998 /// \pre \p I must be a sign, zero, or fp extension.
1999 bool isExtFree(const Instruction *I) const {
2000 switch (I->getOpcode()) {
2001 case Instruction::FPExt:
2002 if (isFPExtFree(EVT::getEVT(I->getType()),
2003 EVT::getEVT(I->getOperand(0)->getType())))
2006 case Instruction::ZExt:
2007 if (isZExtFree(I->getOperand(0)->getType(), I->getType()))
2010 case Instruction::SExt:
2013 llvm_unreachable("Instruction is not an extension");
2015 return isExtFreeImpl(I);
2018 /// Return true if \p Load and \p Ext can form an ExtLoad.
2019 /// For example, in AArch64
2020 /// %L = load i8, i8* %ptr
2021 /// %E = zext i8 %L to i32
2022 /// can be lowered into one load instruction
2024 bool isExtLoad(const LoadInst *Load, const Instruction *Ext,
2025 const DataLayout &DL) const {
2026 EVT VT = getValueType(DL, Ext->getType());
2027 EVT LoadVT = getValueType(DL, Load->getType());
2029 // If the load has other users and the truncate is not free, the ext
2030 // probably isn't free.
2031 if (!Load->hasOneUse() && (isTypeLegal(LoadVT) || !isTypeLegal(VT)) &&
2032 !isTruncateFree(Ext->getType(), Load->getType()))
2035 // Check whether the target supports casts folded into loads.
2037 if (isa<ZExtInst>(Ext))
2038 LType = ISD::ZEXTLOAD;
2040 assert(isa<SExtInst>(Ext) && "Unexpected ext type!");
2041 LType = ISD::SEXTLOAD;
2044 return isLoadExtLegal(LType, VT, LoadVT);
2047 /// Return true if any actual instruction that defines a value of type FromTy
2048 /// implicitly zero-extends the value to ToTy in the result register.
2050 /// The function should return true when it is likely that the truncate can
2051 /// be freely folded with an instruction defining a value of FromTy. If
2052 /// the defining instruction is unknown (because you're looking at a
2053 /// function argument, PHI, etc.) then the target may require an
2054 /// explicit truncate, which is not necessarily free, but this function
2055 /// does not deal with those cases.
2056 /// Targets must return false when FromTy >= ToTy.
2057 virtual bool isZExtFree(Type *FromTy, Type *ToTy) const {
2061 virtual bool isZExtFree(EVT FromTy, EVT ToTy) const {
2065 /// Return true if the target supplies and combines to a paired load
2066 /// two loaded values of type LoadedType next to each other in memory.
2067 /// RequiredAlignment gives the minimal alignment constraints that must be met
2068 /// to be able to select this paired load.
2070 /// This information is *not* used to generate actual paired loads, but it is
2071 /// used to generate a sequence of loads that is easier to combine into a
2073 /// For instance, something like this:
2074 /// a = load i64* addr
2075 /// b = trunc i64 a to i32
2076 /// c = lshr i64 a, 32
2077 /// d = trunc i64 c to i32
2078 /// will be optimized into:
2079 /// b = load i32* addr1
2080 /// d = load i32* addr2
2081 /// Where addr1 = addr2 +/- sizeof(i32).
2083 /// In other words, unless the target performs a post-isel load combining,
2084 /// this information should not be provided because it will generate more
2086 virtual bool hasPairedLoad(EVT /*LoadedType*/,
2087 unsigned & /*RequiredAlignment*/) const {
2091 /// \brief Get the maximum supported factor for interleaved memory accesses.
2092 /// Default to be the minimum interleave factor: 2.
2093 virtual unsigned getMaxSupportedInterleaveFactor() const { return 2; }
2095 /// \brief Lower an interleaved load to target specific intrinsics. Return
2096 /// true on success.
2098 /// \p LI is the vector load instruction.
2099 /// \p Shuffles is the shufflevector list to DE-interleave the loaded vector.
2100 /// \p Indices is the corresponding indices for each shufflevector.
2101 /// \p Factor is the interleave factor.
2102 virtual bool lowerInterleavedLoad(LoadInst *LI,
2103 ArrayRef<ShuffleVectorInst *> Shuffles,
2104 ArrayRef<unsigned> Indices,
2105 unsigned Factor) const {
2109 /// \brief Lower an interleaved store to target specific intrinsics. Return
2110 /// true on success.
2112 /// \p SI is the vector store instruction.
2113 /// \p SVI is the shufflevector to RE-interleave the stored vector.
2114 /// \p Factor is the interleave factor.
2115 virtual bool lowerInterleavedStore(StoreInst *SI, ShuffleVectorInst *SVI,
2116 unsigned Factor) const {
2120 /// Return true if zero-extending the specific node Val to type VT2 is free
2121 /// (either because it's implicitly zero-extended such as ARM ldrb / ldrh or
2122 /// because it's folded such as X86 zero-extending loads).
2123 virtual bool isZExtFree(SDValue Val, EVT VT2) const {
2124 return isZExtFree(Val.getValueType(), VT2);
2127 /// Return true if an fpext operation is free (for instance, because
2128 /// single-precision floating-point numbers are implicitly extended to
2129 /// double-precision).
2130 virtual bool isFPExtFree(EVT DestVT, EVT SrcVT) const {
2131 assert(SrcVT.isFloatingPoint() && DestVT.isFloatingPoint() &&
2132 "invalid fpext types");
2136 /// Return true if an fpext operation input to an \p Opcode operation is free
2137 /// (for instance, because half-precision floating-point numbers are
2138 /// implicitly extended to float-precision) for an FMA instruction.
2139 virtual bool isFPExtFoldable(unsigned Opcode, EVT DestVT, EVT SrcVT) const {
2140 assert(DestVT.isFloatingPoint() && SrcVT.isFloatingPoint() &&
2141 "invalid fpext types");
2142 return isFPExtFree(DestVT, SrcVT);
2145 /// Return true if folding a vector load into ExtVal (a sign, zero, or any
2146 /// extend node) is profitable.
2147 virtual bool isVectorLoadExtDesirable(SDValue ExtVal) const { return false; }
2149 /// Return true if an fneg operation is free to the point where it is never
2150 /// worthwhile to replace it with a bitwise operation.
2151 virtual bool isFNegFree(EVT VT) const {
2152 assert(VT.isFloatingPoint());
2156 /// Return true if an fabs operation is free to the point where it is never
2157 /// worthwhile to replace it with a bitwise operation.
2158 virtual bool isFAbsFree(EVT VT) const {
2159 assert(VT.isFloatingPoint());
2163 /// Return true if an FMA operation is faster than a pair of fmul and fadd
2164 /// instructions. fmuladd intrinsics will be expanded to FMAs when this method
2165 /// returns true, otherwise fmuladd is expanded to fmul + fadd.
2167 /// NOTE: This may be called before legalization on types for which FMAs are
2168 /// not legal, but should return true if those types will eventually legalize
2169 /// to types that support FMAs. After legalization, it will only be called on
2170 /// types that support FMAs (via Legal or Custom actions)
2171 virtual bool isFMAFasterThanFMulAndFAdd(EVT) const {
2175 /// Return true if it's profitable to narrow operations of type VT1 to
2176 /// VT2. e.g. on x86, it's profitable to narrow from i32 to i8 but not from
2178 virtual bool isNarrowingProfitable(EVT /*VT1*/, EVT /*VT2*/) const {
2182 /// \brief Return true if it is beneficial to convert a load of a constant to
2183 /// just the constant itself.
2184 /// On some targets it might be more efficient to use a combination of
2185 /// arithmetic instructions to materialize the constant instead of loading it
2186 /// from a constant pool.
2187 virtual bool shouldConvertConstantLoadToIntImm(const APInt &Imm,
2192 /// Return true if EXTRACT_SUBVECTOR is cheap for extracting this result type
2193 /// from this source type with this index. This is needed because
2194 /// EXTRACT_SUBVECTOR usually has custom lowering that depends on the index of
2195 /// the first element, and only the target knows which lowering is cheap.
2196 virtual bool isExtractSubvectorCheap(EVT ResVT, EVT SrcVT,
2197 unsigned Index) const {
2201 // Return true if it is profitable to use a scalar input to a BUILD_VECTOR
2202 // even if the vector itself has multiple uses.
2203 virtual bool aggressivelyPreferBuildVectorSources(EVT VecVT) const {
2207 //===--------------------------------------------------------------------===//
2208 // Runtime Library hooks
2211 /// Rename the default libcall routine name for the specified libcall.
2212 void setLibcallName(RTLIB::Libcall Call, const char *Name) {
2213 LibcallRoutineNames[Call] = Name;
2216 /// Get the libcall routine name for the specified libcall.
2217 const char *getLibcallName(RTLIB::Libcall Call) const {
2218 return LibcallRoutineNames[Call];
2221 /// Override the default CondCode to be used to test the result of the
2222 /// comparison libcall against zero.
2223 void setCmpLibcallCC(RTLIB::Libcall Call, ISD::CondCode CC) {
2224 CmpLibcallCCs[Call] = CC;
2227 /// Get the CondCode that's to be used to test the result of the comparison
2228 /// libcall against zero.
2229 ISD::CondCode getCmpLibcallCC(RTLIB::Libcall Call) const {
2230 return CmpLibcallCCs[Call];
2233 /// Set the CallingConv that should be used for the specified libcall.
2234 void setLibcallCallingConv(RTLIB::Libcall Call, CallingConv::ID CC) {
2235 LibcallCallingConvs[Call] = CC;
2238 /// Get the CallingConv that should be used for the specified libcall.
2239 CallingConv::ID getLibcallCallingConv(RTLIB::Libcall Call) const {
2240 return LibcallCallingConvs[Call];
2243 /// Execute target specific actions to finalize target lowering.
2244 /// This is used to set extra flags in MachineFrameInformation and freezing
2245 /// the set of reserved registers.
2246 /// The default implementation just freezes the set of reserved registers.
2247 virtual void finalizeLowering(MachineFunction &MF) const;
2250 const TargetMachine &TM;
2252 /// Tells the code generator that the target has multiple (allocatable)
2253 /// condition registers that can be used to store the results of comparisons
2254 /// for use by selects and conditional branches. With multiple condition
2255 /// registers, the code generator will not aggressively sink comparisons into
2256 /// the blocks of their users.
2257 bool HasMultipleConditionRegisters;
2259 /// Tells the code generator that the target has BitExtract instructions.
2260 /// The code generator will aggressively sink "shift"s into the blocks of
2261 /// their users if the users will generate "and" instructions which can be
2262 /// combined with "shift" to BitExtract instructions.
2263 bool HasExtractBitsInsn;
2265 /// Tells the code generator to bypass slow divide or remainder
2266 /// instructions. For example, BypassSlowDivWidths[32,8] tells the code
2267 /// generator to bypass 32-bit integer div/rem with an 8-bit unsigned integer
2268 /// div/rem when the operands are positive and less than 256.
2269 DenseMap <unsigned int, unsigned int> BypassSlowDivWidths;
2271 /// Tells the code generator that it shouldn't generate extra flow control
2272 /// instructions and should attempt to combine flow control instructions via
2274 bool JumpIsExpensive;
2276 /// Whether the target supports or cares about preserving floating point
2277 /// exception behavior.
2278 bool HasFloatingPointExceptions;
2280 /// This target prefers to use _setjmp to implement llvm.setjmp.
2282 /// Defaults to false.
2283 bool UseUnderscoreSetJmp;
2285 /// This target prefers to use _longjmp to implement llvm.longjmp.
2287 /// Defaults to false.
2288 bool UseUnderscoreLongJmp;
2290 /// Information about the contents of the high-bits in boolean values held in
2291 /// a type wider than i1. See getBooleanContents.
2292 BooleanContent BooleanContents;
2294 /// Information about the contents of the high-bits in boolean values held in
2295 /// a type wider than i1. See getBooleanContents.
2296 BooleanContent BooleanFloatContents;
2298 /// Information about the contents of the high-bits in boolean vector values
2299 /// when the element type is wider than i1. See getBooleanContents.
2300 BooleanContent BooleanVectorContents;
2302 /// The target scheduling preference: shortest possible total cycles or lowest
2304 Sched::Preference SchedPreferenceInfo;
2306 /// The size, in bytes, of the target's jmp_buf buffers
2307 unsigned JumpBufSize;
2309 /// The alignment, in bytes, of the target's jmp_buf buffers
2310 unsigned JumpBufAlignment;
2312 /// The minimum alignment that any argument on the stack needs to have.
2313 unsigned MinStackArgumentAlignment;
2315 /// The minimum function alignment (used when optimizing for size, and to
2316 /// prevent explicitly provided alignment from leading to incorrect code).
2317 unsigned MinFunctionAlignment;
2319 /// The preferred function alignment (used when alignment unspecified and
2320 /// optimizing for speed).
2321 unsigned PrefFunctionAlignment;
2323 /// The preferred loop alignment.
2324 unsigned PrefLoopAlignment;
2326 /// Size in bits of the maximum atomics size the backend supports.
2327 /// Accesses larger than this will be expanded by AtomicExpandPass.
2328 unsigned MaxAtomicSizeInBitsSupported;
2330 /// Size in bits of the minimum cmpxchg or ll/sc operation the
2331 /// backend supports.
2332 unsigned MinCmpXchgSizeInBits;
2334 /// If set to a physical register, this specifies the register that
2335 /// llvm.savestack/llvm.restorestack should save and restore.
2336 unsigned StackPointerRegisterToSaveRestore;
2338 /// This indicates the default register class to use for each ValueType the
2339 /// target supports natively.
2340 const TargetRegisterClass *RegClassForVT[MVT::LAST_VALUETYPE];
2341 unsigned char NumRegistersForVT[MVT::LAST_VALUETYPE];
2342 MVT RegisterTypeForVT[MVT::LAST_VALUETYPE];
2344 /// This indicates the "representative" register class to use for each
2345 /// ValueType the target supports natively. This information is used by the
2346 /// scheduler to track register pressure. By default, the representative
2347 /// register class is the largest legal super-reg register class of the
2348 /// register class of the specified type. e.g. On x86, i8, i16, and i32's
2349 /// representative class would be GR32.
2350 const TargetRegisterClass *RepRegClassForVT[MVT::LAST_VALUETYPE];
2352 /// This indicates the "cost" of the "representative" register class for each
2353 /// ValueType. The cost is used by the scheduler to approximate register
2355 uint8_t RepRegClassCostForVT[MVT::LAST_VALUETYPE];
2357 /// For any value types we are promoting or expanding, this contains the value
2358 /// type that we are changing to. For Expanded types, this contains one step
2359 /// of the expand (e.g. i64 -> i32), even if there are multiple steps required
2360 /// (e.g. i64 -> i16). For types natively supported by the system, this holds
2361 /// the same type (e.g. i32 -> i32).
2362 MVT TransformToType[MVT::LAST_VALUETYPE];
2364 /// For each operation and each value type, keep a LegalizeAction that
2365 /// indicates how instruction selection should deal with the operation. Most
2366 /// operations are Legal (aka, supported natively by the target), but
2367 /// operations that are not should be described. Note that operations on
2368 /// non-legal value types are not described here.
2369 LegalizeAction OpActions[MVT::LAST_VALUETYPE][ISD::BUILTIN_OP_END];
2371 /// For each load extension type and each value type, keep a LegalizeAction
2372 /// that indicates how instruction selection should deal with a load of a
2373 /// specific value type and extension type. Uses 4-bits to store the action
2374 /// for each of the 4 load ext types.
2375 uint16_t LoadExtActions[MVT::LAST_VALUETYPE][MVT::LAST_VALUETYPE];
2377 /// For each value type pair keep a LegalizeAction that indicates whether a
2378 /// truncating store of a specific value type and truncating type is legal.
2379 LegalizeAction TruncStoreActions[MVT::LAST_VALUETYPE][MVT::LAST_VALUETYPE];
2381 /// For each indexed mode and each value type, keep a pair of LegalizeAction
2382 /// that indicates how instruction selection should deal with the load /
2385 /// The first dimension is the value_type for the reference. The second
2386 /// dimension represents the various modes for load store.
2387 uint8_t IndexedModeActions[MVT::LAST_VALUETYPE][ISD::LAST_INDEXED_MODE];
2389 /// For each condition code (ISD::CondCode) keep a LegalizeAction that
2390 /// indicates how instruction selection should deal with the condition code.
2392 /// Because each CC action takes up 4 bits, we need to have the array size be
2393 /// large enough to fit all of the value types. This can be done by rounding
2394 /// up the MVT::LAST_VALUETYPE value to the next multiple of 8.
2395 uint32_t CondCodeActions[ISD::SETCC_INVALID][(MVT::LAST_VALUETYPE + 7) / 8];
2398 ValueTypeActionImpl ValueTypeActions;
2401 LegalizeKind getTypeConversion(LLVMContext &Context, EVT VT) const;
2403 /// Targets can specify ISD nodes that they would like PerformDAGCombine
2404 /// callbacks for by calling setTargetDAGCombine(), which sets a bit in this
2407 TargetDAGCombineArray[(ISD::BUILTIN_OP_END+CHAR_BIT-1)/CHAR_BIT];
2409 /// For operations that must be promoted to a specific type, this holds the
2410 /// destination type. This map should be sparse, so don't hold it as an
2413 /// Targets add entries to this map with AddPromotedToType(..), clients access
2414 /// this with getTypeToPromoteTo(..).
2415 std::map<std::pair<unsigned, MVT::SimpleValueType>, MVT::SimpleValueType>
2418 /// Stores the name each libcall.
2419 const char *LibcallRoutineNames[RTLIB::UNKNOWN_LIBCALL];
2421 /// The ISD::CondCode that should be used to test the result of each of the
2422 /// comparison libcall against zero.
2423 ISD::CondCode CmpLibcallCCs[RTLIB::UNKNOWN_LIBCALL];
2425 /// Stores the CallingConv that should be used for each libcall.
2426 CallingConv::ID LibcallCallingConvs[RTLIB::UNKNOWN_LIBCALL];
2429 /// Return true if the extension represented by \p I is free.
2430 /// \pre \p I is a sign, zero, or fp extension and
2431 /// is[Z|FP]ExtFree of the related types is not true.
2432 virtual bool isExtFreeImpl(const Instruction *I) const { return false; }
2434 /// Depth that GatherAllAliases should should continue looking for chain
2435 /// dependencies when trying to find a more preferable chain. As an
2436 /// approximation, this should be more than the number of consecutive stores
2437 /// expected to be merged.
2438 unsigned GatherAllAliasesMaxDepth;
2440 /// \brief Specify maximum number of store instructions per memset call.
2442 /// When lowering \@llvm.memset this field specifies the maximum number of
2443 /// store operations that may be substituted for the call to memset. Targets
2444 /// must set this value based on the cost threshold for that target. Targets
2445 /// should assume that the memset will be done using as many of the largest
2446 /// store operations first, followed by smaller ones, if necessary, per
2447 /// alignment restrictions. For example, storing 9 bytes on a 32-bit machine
2448 /// with 16-bit alignment would result in four 2-byte stores and one 1-byte
2449 /// store. This only applies to setting a constant array of a constant size.
2450 unsigned MaxStoresPerMemset;
2452 /// Maximum number of stores operations that may be substituted for the call
2453 /// to memset, used for functions with OptSize attribute.
2454 unsigned MaxStoresPerMemsetOptSize;
2456 /// \brief Specify maximum bytes of store instructions per memcpy call.
2458 /// When lowering \@llvm.memcpy this field specifies the maximum number of
2459 /// store operations that may be substituted for a call to memcpy. Targets
2460 /// must set this value based on the cost threshold for that target. Targets
2461 /// should assume that the memcpy will be done using as many of the largest
2462 /// store operations first, followed by smaller ones, if necessary, per
2463 /// alignment restrictions. For example, storing 7 bytes on a 32-bit machine
2464 /// with 32-bit alignment would result in one 4-byte store, a one 2-byte store
2465 /// and one 1-byte store. This only applies to copying a constant array of
2467 unsigned MaxStoresPerMemcpy;
2469 /// Maximum number of store operations that may be substituted for a call to
2470 /// memcpy, used for functions with OptSize attribute.
2471 unsigned MaxStoresPerMemcpyOptSize;
2472 unsigned MaxLoadsPerMemcmp;
2473 unsigned MaxLoadsPerMemcmpOptSize;
2475 /// \brief Specify maximum bytes of store instructions per memmove call.
2477 /// When lowering \@llvm.memmove this field specifies the maximum number of
2478 /// store instructions that may be substituted for a call to memmove. Targets
2479 /// must set this value based on the cost threshold for that target. Targets
2480 /// should assume that the memmove will be done using as many of the largest
2481 /// store operations first, followed by smaller ones, if necessary, per
2482 /// alignment restrictions. For example, moving 9 bytes on a 32-bit machine
2483 /// with 8-bit alignment would result in nine 1-byte stores. This only
2484 /// applies to copying a constant array of constant size.
2485 unsigned MaxStoresPerMemmove;
2487 /// Maximum number of store instructions that may be substituted for a call to
2488 /// memmove, used for functions with OptSize attribute.
2489 unsigned MaxStoresPerMemmoveOptSize;
2491 /// Tells the code generator that select is more expensive than a branch if
2492 /// the branch is usually predicted right.
2493 bool PredictableSelectIsExpensive;
2495 /// \see enableExtLdPromotion.
2496 bool EnableExtLdPromotion;
2498 /// Return true if the value types that can be represented by the specified
2499 /// register class are all legal.
2500 bool isLegalRC(const TargetRegisterInfo &TRI,
2501 const TargetRegisterClass &RC) const;
2503 /// Replace/modify any TargetFrameIndex operands with a targte-dependent
2504 /// sequence of memory operands that is recognized by PrologEpilogInserter.
2505 MachineBasicBlock *emitPatchPoint(MachineInstr &MI,
2506 MachineBasicBlock *MBB) const;
2509 /// This class defines information used to lower LLVM code to legal SelectionDAG
2510 /// operators that the target instruction selector can accept natively.
2512 /// This class also defines callbacks that targets must implement to lower
2513 /// target-specific constructs to SelectionDAG operators.
2514 class TargetLowering : public TargetLoweringBase {
2516 struct DAGCombinerInfo;
2518 TargetLowering(const TargetLowering &) = delete;
2519 TargetLowering &operator=(const TargetLowering &) = delete;
2521 /// NOTE: The TargetMachine owns TLOF.
2522 explicit TargetLowering(const TargetMachine &TM);
2524 bool isPositionIndependent() const;
2526 /// Returns true by value, base pointer and offset pointer and addressing mode
2527 /// by reference if the node's address can be legally represented as
2528 /// pre-indexed load / store address.
2529 virtual bool getPreIndexedAddressParts(SDNode * /*N*/, SDValue &/*Base*/,
2530 SDValue &/*Offset*/,
2531 ISD::MemIndexedMode &/*AM*/,
2532 SelectionDAG &/*DAG*/) const {
2536 /// Returns true by value, base pointer and offset pointer and addressing mode
2537 /// by reference if this node can be combined with a load / store to form a
2538 /// post-indexed load / store.
2539 virtual bool getPostIndexedAddressParts(SDNode * /*N*/, SDNode * /*Op*/,
2541 SDValue &/*Offset*/,
2542 ISD::MemIndexedMode &/*AM*/,
2543 SelectionDAG &/*DAG*/) const {
2547 /// Return the entry encoding for a jump table in the current function. The
2548 /// returned value is a member of the MachineJumpTableInfo::JTEntryKind enum.
2549 virtual unsigned getJumpTableEncoding() const;
2551 virtual const MCExpr *
2552 LowerCustomJumpTableEntry(const MachineJumpTableInfo * /*MJTI*/,
2553 const MachineBasicBlock * /*MBB*/, unsigned /*uid*/,
2554 MCContext &/*Ctx*/) const {
2555 llvm_unreachable("Need to implement this hook if target has custom JTIs");
2558 /// Returns relocation base for the given PIC jumptable.
2559 virtual SDValue getPICJumpTableRelocBase(SDValue Table,
2560 SelectionDAG &DAG) const;
2562 /// This returns the relocation base for the given PIC jumptable, the same as
2563 /// getPICJumpTableRelocBase, but as an MCExpr.
2564 virtual const MCExpr *
2565 getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
2566 unsigned JTI, MCContext &Ctx) const;
2568 /// Return true if folding a constant offset with the given GlobalAddress is
2569 /// legal. It is frequently not legal in PIC relocation models.
2570 virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
2572 bool isInTailCallPosition(SelectionDAG &DAG, SDNode *Node,
2573 SDValue &Chain) const;
2575 void softenSetCCOperands(SelectionDAG &DAG, EVT VT, SDValue &NewLHS,
2576 SDValue &NewRHS, ISD::CondCode &CCCode,
2577 const SDLoc &DL) const;
2579 /// Returns a pair of (return value, chain).
2580 /// It is an error to pass RTLIB::UNKNOWN_LIBCALL as \p LC.
2581 std::pair<SDValue, SDValue> makeLibCall(SelectionDAG &DAG, RTLIB::Libcall LC,
2582 EVT RetVT, ArrayRef<SDValue> Ops,
2583 bool isSigned, const SDLoc &dl,
2584 bool doesNotReturn = false,
2585 bool isReturnValueUsed = true) const;
2587 /// Check whether parameters to a call that are passed in callee saved
2588 /// registers are the same as from the calling function. This needs to be
2589 /// checked for tail call eligibility.
2590 bool parametersInCSRMatch(const MachineRegisterInfo &MRI,
2591 const uint32_t *CallerPreservedMask,
2592 const SmallVectorImpl<CCValAssign> &ArgLocs,
2593 const SmallVectorImpl<SDValue> &OutVals) const;
2595 //===--------------------------------------------------------------------===//
2596 // TargetLowering Optimization Methods
2599 /// A convenience struct that encapsulates a DAG, and two SDValues for
2600 /// returning information from TargetLowering to its clients that want to
2602 struct TargetLoweringOpt {
2609 explicit TargetLoweringOpt(SelectionDAG &InDAG,
2611 DAG(InDAG), LegalTys(LT), LegalOps(LO) {}
2613 bool LegalTypes() const { return LegalTys; }
2614 bool LegalOperations() const { return LegalOps; }
2616 bool CombineTo(SDValue O, SDValue N) {
2623 /// Check to see if the specified operand of the specified instruction is a
2624 /// constant integer. If so, check to see if there are any bits set in the
2625 /// constant that are not demanded. If so, shrink the constant and return
2627 bool ShrinkDemandedConstant(SDValue Op, const APInt &Demanded,
2628 TargetLoweringOpt &TLO) const;
2630 // Target hook to do target-specific const optimization, which is called by
2631 // ShrinkDemandedConstant. This function should return true if the target
2632 // doesn't want ShrinkDemandedConstant to further optimize the constant.
2633 virtual bool targetShrinkDemandedConstant(SDValue Op, const APInt &Demanded,
2634 TargetLoweringOpt &TLO) const {
2638 /// Convert x+y to (VT)((SmallVT)x+(SmallVT)y) if the casts are free. This
2639 /// uses isZExtFree and ZERO_EXTEND for the widening cast, but it could be
2640 /// generalized for targets with other types of implicit widening casts.
2641 bool ShrinkDemandedOp(SDValue Op, unsigned BitWidth, const APInt &Demanded,
2642 TargetLoweringOpt &TLO) const;
2644 /// Helper for SimplifyDemandedBits that can simplify an operation with
2645 /// multiple uses. This function simplifies operand \p OpIdx of \p User and
2646 /// then updates \p User with the simplified version. No other uses of
2647 /// \p OpIdx are updated. If \p User is the only user of \p OpIdx, this
2648 /// function behaves exactly like function SimplifyDemandedBits declared
2649 /// below except that it also updates the DAG by calling
2650 /// DCI.CommitTargetLoweringOpt.
2651 bool SimplifyDemandedBits(SDNode *User, unsigned OpIdx, const APInt &Demanded,
2652 DAGCombinerInfo &DCI, TargetLoweringOpt &TLO) const;
2654 /// Look at Op. At this point, we know that only the DemandedMask bits of the
2655 /// result of Op are ever used downstream. If we can use this information to
2656 /// simplify Op, create a new simplified DAG node and return true, returning
2657 /// the original and new nodes in Old and New. Otherwise, analyze the
2658 /// expression and return a mask of KnownOne and KnownZero bits for the
2659 /// expression (used to simplify the caller). The KnownZero/One bits may only
2660 /// be accurate for those bits in the DemandedMask.
2661 /// \p AssumeSingleUse When this parameter is true, this function will
2662 /// attempt to simplify \p Op even if there are multiple uses.
2663 /// Callers are responsible for correctly updating the DAG based on the
2664 /// results of this function, because simply replacing replacing TLO.Old
2665 /// with TLO.New will be incorrect when this parameter is true and TLO.Old
2666 /// has multiple uses.
2667 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedMask,
2669 TargetLoweringOpt &TLO,
2671 bool AssumeSingleUse = false) const;
2673 /// Helper wrapper around SimplifyDemandedBits
2674 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedMask,
2675 DAGCombinerInfo &DCI) const;
2677 /// Determine which of the bits specified in Mask are known to be either zero
2678 /// or one and return them in the KnownZero/KnownOne bitsets. The DemandedElts
2679 /// argument allows us to only collect the known bits that are shared by the
2680 /// requested vector elements.
2681 virtual void computeKnownBitsForTargetNode(const SDValue Op,
2683 const APInt &DemandedElts,
2684 const SelectionDAG &DAG,
2685 unsigned Depth = 0) const;
2687 /// Determine which of the bits of FrameIndex \p FIOp are known to be 0.
2688 /// Default implementation computes low bits based on alignment
2689 /// information. This should preserve known bits passed into it.
2690 virtual void computeKnownBitsForFrameIndex(const SDValue FIOp,
2692 const APInt &DemandedElts,
2693 const SelectionDAG &DAG,
2694 unsigned Depth = 0) const;
2696 /// This method can be implemented by targets that want to expose additional
2697 /// information about sign bits to the DAG Combiner. The DemandedElts
2698 /// argument allows us to only collect the minimum sign bits that are shared
2699 /// by the requested vector elements.
2700 virtual unsigned ComputeNumSignBitsForTargetNode(SDValue Op,
2701 const APInt &DemandedElts,
2702 const SelectionDAG &DAG,
2703 unsigned Depth = 0) const;
2705 struct DAGCombinerInfo {
2706 void *DC; // The DAG Combiner object.
2708 bool CalledByLegalizer;
2713 DAGCombinerInfo(SelectionDAG &dag, CombineLevel level, bool cl, void *dc)
2714 : DC(dc), Level(level), CalledByLegalizer(cl), DAG(dag) {}
2716 bool isBeforeLegalize() const { return Level == BeforeLegalizeTypes; }
2717 bool isBeforeLegalizeOps() const { return Level < AfterLegalizeVectorOps; }
2718 bool isAfterLegalizeVectorOps() const {
2719 return Level == AfterLegalizeDAG;
2721 CombineLevel getDAGCombineLevel() { return Level; }
2722 bool isCalledByLegalizer() const { return CalledByLegalizer; }
2724 void AddToWorklist(SDNode *N);
2725 SDValue CombineTo(SDNode *N, ArrayRef<SDValue> To, bool AddTo = true);
2726 SDValue CombineTo(SDNode *N, SDValue Res, bool AddTo = true);
2727 SDValue CombineTo(SDNode *N, SDValue Res0, SDValue Res1, bool AddTo = true);
2729 void CommitTargetLoweringOpt(const TargetLoweringOpt &TLO);
2732 /// Return if the N is a constant or constant vector equal to the true value
2733 /// from getBooleanContents().
2734 bool isConstTrueVal(const SDNode *N) const;
2736 /// Return if the N is a constant or constant vector equal to the false value
2737 /// from getBooleanContents().
2738 bool isConstFalseVal(const SDNode *N) const;
2740 /// Return a constant of type VT that contains a true value that respects
2741 /// getBooleanContents()
2742 SDValue getConstTrueVal(SelectionDAG &DAG, EVT VT, const SDLoc &DL) const;
2744 /// Return if \p N is a True value when extended to \p VT.
2745 bool isExtendedTrueVal(const ConstantSDNode *N, EVT VT, bool Signed) const;
2747 /// Try to simplify a setcc built with the specified operands and cc. If it is
2748 /// unable to simplify it, return a null SDValue.
2749 SDValue SimplifySetCC(EVT VT, SDValue N0, SDValue N1, ISD::CondCode Cond,
2750 bool foldBooleans, DAGCombinerInfo &DCI,
2751 const SDLoc &dl) const;
2753 // For targets which wrap address, unwrap for analysis.
2754 virtual SDValue unwrapAddress(SDValue N) const { return N; }
2756 /// Returns true (and the GlobalValue and the offset) if the node is a
2757 /// GlobalAddress + offset.
2759 isGAPlusOffset(SDNode *N, const GlobalValue* &GA, int64_t &Offset) const;
2761 /// This method will be invoked for all target nodes and for any
2762 /// target-independent nodes that the target has registered with invoke it
2765 /// The semantics are as follows:
2767 /// SDValue.Val == 0 - No change was made
2768 /// SDValue.Val == N - N was replaced, is dead, and is already handled.
2769 /// otherwise - N should be replaced by the returned Operand.
2771 /// In addition, methods provided by DAGCombinerInfo may be used to perform
2772 /// more complex transformations.
2774 virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
2776 /// Return true if it is profitable to move a following shift through this
2777 // node, adjusting any immediate operands as necessary to preserve semantics.
2778 // This transformation may not be desirable if it disrupts a particularly
2779 // auspicious target-specific tree (e.g. bitfield extraction in AArch64).
2780 // By default, it returns true.
2781 virtual bool isDesirableToCommuteWithShift(const SDNode *N) const {
2785 // Return true if it is profitable to combine a BUILD_VECTOR with a stride-pattern
2786 // to a shuffle and a truncate.
2787 // Example of such a combine:
2788 // v4i32 build_vector((extract_elt V, 1),
2789 // (extract_elt V, 3),
2790 // (extract_elt V, 5),
2791 // (extract_elt V, 7))
2793 // v4i32 truncate (bitcast (shuffle<1,u,3,u,5,u,7,u> V, u) to v4i64)
2794 virtual bool isDesirableToCombineBuildVectorToShuffleTruncate(
2795 ArrayRef<int> ShuffleMask, EVT SrcVT, EVT TruncVT) const {
2799 /// Return true if the target has native support for the specified value type
2800 /// and it is 'desirable' to use the type for the given node type. e.g. On x86
2801 /// i16 is legal, but undesirable since i16 instruction encodings are longer
2802 /// and some i16 instructions are slow.
2803 virtual bool isTypeDesirableForOp(unsigned /*Opc*/, EVT VT) const {
2804 // By default, assume all legal types are desirable.
2805 return isTypeLegal(VT);
2808 /// Return true if it is profitable for dag combiner to transform a floating
2809 /// point op of specified opcode to a equivalent op of an integer
2810 /// type. e.g. f32 load -> i32 load can be profitable on ARM.
2811 virtual bool isDesirableToTransformToIntegerOp(unsigned /*Opc*/,
2816 /// This method query the target whether it is beneficial for dag combiner to
2817 /// promote the specified node. If true, it should return the desired
2818 /// promotion type by reference.
2819 virtual bool IsDesirableToPromoteOp(SDValue /*Op*/, EVT &/*PVT*/) const {
2823 /// Return true if the target supports swifterror attribute. It optimizes
2824 /// loads and stores to reading and writing a specific register.
2825 virtual bool supportSwiftError() const {
2829 /// Return true if the target supports that a subset of CSRs for the given
2830 /// machine function is handled explicitly via copies.
2831 virtual bool supportSplitCSR(MachineFunction *MF) const {
2835 /// Perform necessary initialization to handle a subset of CSRs explicitly
2836 /// via copies. This function is called at the beginning of instruction
2838 virtual void initializeSplitCSR(MachineBasicBlock *Entry) const {
2839 llvm_unreachable("Not Implemented");
2842 /// Insert explicit copies in entry and exit blocks. We copy a subset of
2843 /// CSRs to virtual registers in the entry block, and copy them back to
2844 /// physical registers in the exit blocks. This function is called at the end
2845 /// of instruction selection.
2846 virtual void insertCopiesSplitCSR(
2847 MachineBasicBlock *Entry,
2848 const SmallVectorImpl<MachineBasicBlock *> &Exits) const {
2849 llvm_unreachable("Not Implemented");
2852 //===--------------------------------------------------------------------===//
2853 // Lowering methods - These methods must be implemented by targets so that
2854 // the SelectionDAGBuilder code knows how to lower these.
2857 /// This hook must be implemented to lower the incoming (formal) arguments,
2858 /// described by the Ins array, into the specified DAG. The implementation
2859 /// should fill in the InVals array with legal-type argument values, and
2860 /// return the resulting token chain value.
2861 virtual SDValue LowerFormalArguments(
2862 SDValue /*Chain*/, CallingConv::ID /*CallConv*/, bool /*isVarArg*/,
2863 const SmallVectorImpl<ISD::InputArg> & /*Ins*/, const SDLoc & /*dl*/,
2864 SelectionDAG & /*DAG*/, SmallVectorImpl<SDValue> & /*InVals*/) const {
2865 llvm_unreachable("Not Implemented");
2868 /// This structure contains all information that is necessary for lowering
2869 /// calls. It is passed to TLI::LowerCallTo when the SelectionDAG builder
2870 /// needs to lower a call, and targets will see this struct in their LowerCall
2872 struct CallLoweringInfo {
2874 Type *RetTy = nullptr;
2879 bool DoesNotReturn : 1;
2880 bool IsReturnValueUsed : 1;
2881 bool IsConvergent : 1;
2882 bool IsPatchPoint : 1;
2884 // IsTailCall should be modified by implementations of
2885 // TargetLowering::LowerCall that perform tail call conversions.
2886 bool IsTailCall = false;
2888 // Is Call lowering done post SelectionDAG type legalization.
2889 bool IsPostTypeLegalization = false;
2891 unsigned NumFixedArgs = -1;
2892 CallingConv::ID CallConv = CallingConv::C;
2897 ImmutableCallSite CS;
2898 SmallVector<ISD::OutputArg, 32> Outs;
2899 SmallVector<SDValue, 32> OutVals;
2900 SmallVector<ISD::InputArg, 32> Ins;
2901 SmallVector<SDValue, 4> InVals;
2903 CallLoweringInfo(SelectionDAG &DAG)
2904 : RetSExt(false), RetZExt(false), IsVarArg(false), IsInReg(false),
2905 DoesNotReturn(false), IsReturnValueUsed(true), IsConvergent(false),
2906 IsPatchPoint(false), DAG(DAG) {}
2908 CallLoweringInfo &setDebugLoc(const SDLoc &dl) {
2913 CallLoweringInfo &setChain(SDValue InChain) {
2918 // setCallee with target/module-specific attributes
2919 CallLoweringInfo &setLibCallee(CallingConv::ID CC, Type *ResultType,
2920 SDValue Target, ArgListTy &&ArgsList) {
2924 NumFixedArgs = ArgsList.size();
2925 Args = std::move(ArgsList);
2927 DAG.getTargetLoweringInfo().markLibCallAttributes(
2928 &(DAG.getMachineFunction()), CC, Args);
2932 CallLoweringInfo &setCallee(CallingConv::ID CC, Type *ResultType,
2933 SDValue Target, ArgListTy &&ArgsList) {
2937 NumFixedArgs = ArgsList.size();
2938 Args = std::move(ArgsList);
2942 CallLoweringInfo &setCallee(Type *ResultType, FunctionType *FTy,
2943 SDValue Target, ArgListTy &&ArgsList,
2944 ImmutableCallSite Call) {
2947 IsInReg = Call.hasRetAttr(Attribute::InReg);
2949 Call.doesNotReturn() ||
2950 (!Call.isInvoke() &&
2951 isa<UnreachableInst>(Call.getInstruction()->getNextNode()));
2952 IsVarArg = FTy->isVarArg();
2953 IsReturnValueUsed = !Call.getInstruction()->use_empty();
2954 RetSExt = Call.hasRetAttr(Attribute::SExt);
2955 RetZExt = Call.hasRetAttr(Attribute::ZExt);
2959 CallConv = Call.getCallingConv();
2960 NumFixedArgs = FTy->getNumParams();
2961 Args = std::move(ArgsList);
2968 CallLoweringInfo &setInRegister(bool Value = true) {
2973 CallLoweringInfo &setNoReturn(bool Value = true) {
2974 DoesNotReturn = Value;
2978 CallLoweringInfo &setVarArg(bool Value = true) {
2983 CallLoweringInfo &setTailCall(bool Value = true) {
2988 CallLoweringInfo &setDiscardResult(bool Value = true) {
2989 IsReturnValueUsed = !Value;
2993 CallLoweringInfo &setConvergent(bool Value = true) {
2994 IsConvergent = Value;
2998 CallLoweringInfo &setSExtResult(bool Value = true) {
3003 CallLoweringInfo &setZExtResult(bool Value = true) {
3008 CallLoweringInfo &setIsPatchPoint(bool Value = true) {
3009 IsPatchPoint = Value;
3013 CallLoweringInfo &setIsPostTypeLegalization(bool Value=true) {
3014 IsPostTypeLegalization = Value;
3018 ArgListTy &getArgs() {
3023 /// This function lowers an abstract call to a function into an actual call.
3024 /// This returns a pair of operands. The first element is the return value
3025 /// for the function (if RetTy is not VoidTy). The second element is the
3026 /// outgoing token chain. It calls LowerCall to do the actual lowering.
3027 std::pair<SDValue, SDValue> LowerCallTo(CallLoweringInfo &CLI) const;
3029 /// This hook must be implemented to lower calls into the specified
3030 /// DAG. The outgoing arguments to the call are described by the Outs array,
3031 /// and the values to be returned by the call are described by the Ins
3032 /// array. The implementation should fill in the InVals array with legal-type
3033 /// return values from the call, and return the resulting token chain value.
3035 LowerCall(CallLoweringInfo &/*CLI*/,
3036 SmallVectorImpl<SDValue> &/*InVals*/) const {
3037 llvm_unreachable("Not Implemented");
3040 /// Target-specific cleanup for formal ByVal parameters.
3041 virtual void HandleByVal(CCState *, unsigned &, unsigned) const {}
3043 /// This hook should be implemented to check whether the return values
3044 /// described by the Outs array can fit into the return registers. If false
3045 /// is returned, an sret-demotion is performed.
3046 virtual bool CanLowerReturn(CallingConv::ID /*CallConv*/,
3047 MachineFunction &/*MF*/, bool /*isVarArg*/,
3048 const SmallVectorImpl<ISD::OutputArg> &/*Outs*/,
3049 LLVMContext &/*Context*/) const
3051 // Return true by default to get preexisting behavior.
3055 /// This hook must be implemented to lower outgoing return values, described
3056 /// by the Outs array, into the specified DAG. The implementation should
3057 /// return the resulting token chain value.
3058 virtual SDValue LowerReturn(SDValue /*Chain*/, CallingConv::ID /*CallConv*/,
3060 const SmallVectorImpl<ISD::OutputArg> & /*Outs*/,
3061 const SmallVectorImpl<SDValue> & /*OutVals*/,
3062 const SDLoc & /*dl*/,
3063 SelectionDAG & /*DAG*/) const {
3064 llvm_unreachable("Not Implemented");
3067 /// Return true if result of the specified node is used by a return node
3068 /// only. It also compute and return the input chain for the tail call.
3070 /// This is used to determine whether it is possible to codegen a libcall as
3071 /// tail call at legalization time.
3072 virtual bool isUsedByReturnOnly(SDNode *, SDValue &/*Chain*/) const {
3076 /// Return true if the target may be able emit the call instruction as a tail
3077 /// call. This is used by optimization passes to determine if it's profitable
3078 /// to duplicate return instructions to enable tailcall optimization.
3079 virtual bool mayBeEmittedAsTailCall(const CallInst *) const {
3083 /// Return the builtin name for the __builtin___clear_cache intrinsic
3084 /// Default is to invoke the clear cache library call
3085 virtual const char * getClearCacheBuiltinName() const {
3086 return "__clear_cache";
3089 /// Return the register ID of the name passed in. Used by named register
3090 /// global variables extension. There is no target-independent behaviour
3091 /// so the default action is to bail.
3092 virtual unsigned getRegisterByName(const char* RegName, EVT VT,
3093 SelectionDAG &DAG) const {
3094 report_fatal_error("Named registers not implemented for this target");
3097 /// Return the type that should be used to zero or sign extend a
3098 /// zeroext/signext integer return value. FIXME: Some C calling conventions
3099 /// require the return type to be promoted, but this is not true all the time,
3100 /// e.g. i1/i8/i16 on x86/x86_64. It is also not necessary for non-C calling
3101 /// conventions. The frontend should handle this and include all of the
3102 /// necessary information.
3103 virtual EVT getTypeForExtReturn(LLVMContext &Context, EVT VT,
3104 ISD::NodeType /*ExtendKind*/) const {
3105 EVT MinVT = getRegisterType(Context, MVT::i32);
3106 return VT.bitsLT(MinVT) ? MinVT : VT;
3109 /// For some targets, an LLVM struct type must be broken down into multiple
3110 /// simple types, but the calling convention specifies that the entire struct
3111 /// must be passed in a block of consecutive registers.
3113 functionArgumentNeedsConsecutiveRegisters(Type *Ty, CallingConv::ID CallConv,
3114 bool isVarArg) const {
3118 /// Returns a 0 terminated array of registers that can be safely used as
3119 /// scratch registers.
3120 virtual const MCPhysReg *getScratchRegisters(CallingConv::ID CC) const {
3124 /// This callback is used to prepare for a volatile or atomic load.
3125 /// It takes a chain node as input and returns the chain for the load itself.
3127 /// Having a callback like this is necessary for targets like SystemZ,
3128 /// which allows a CPU to reuse the result of a previous load indefinitely,
3129 /// even if a cache-coherent store is performed by another CPU. The default
3130 /// implementation does nothing.
3131 virtual SDValue prepareVolatileOrAtomicLoad(SDValue Chain, const SDLoc &DL,
3132 SelectionDAG &DAG) const {
3136 /// This callback is used to inspect load/store instructions and add
3137 /// target-specific MachineMemOperand flags to them. The default
3138 /// implementation does nothing.
3139 virtual MachineMemOperand::Flags getMMOFlags(const Instruction &I) const {
3140 return MachineMemOperand::MONone;
3143 /// This callback is invoked by the type legalizer to legalize nodes with an
3144 /// illegal operand type but legal result types. It replaces the
3145 /// LowerOperation callback in the type Legalizer. The reason we can not do
3146 /// away with LowerOperation entirely is that LegalizeDAG isn't yet ready to
3147 /// use this callback.
3149 /// TODO: Consider merging with ReplaceNodeResults.
3151 /// The target places new result values for the node in Results (their number
3152 /// and types must exactly match those of the original return values of
3153 /// the node), or leaves Results empty, which indicates that the node is not
3154 /// to be custom lowered after all.
3155 /// The default implementation calls LowerOperation.
3156 virtual void LowerOperationWrapper(SDNode *N,
3157 SmallVectorImpl<SDValue> &Results,
3158 SelectionDAG &DAG) const;
3160 /// This callback is invoked for operations that are unsupported by the
3161 /// target, which are registered to use 'custom' lowering, and whose defined
3162 /// values are all legal. If the target has no operations that require custom
3163 /// lowering, it need not implement this. The default implementation of this
3165 virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
3167 /// This callback is invoked when a node result type is illegal for the
3168 /// target, and the operation was registered to use 'custom' lowering for that
3169 /// result type. The target places new result values for the node in Results
3170 /// (their number and types must exactly match those of the original return
3171 /// values of the node), or leaves Results empty, which indicates that the
3172 /// node is not to be custom lowered after all.
3174 /// If the target has no operations that require custom lowering, it need not
3175 /// implement this. The default implementation aborts.
3176 virtual void ReplaceNodeResults(SDNode * /*N*/,
3177 SmallVectorImpl<SDValue> &/*Results*/,
3178 SelectionDAG &/*DAG*/) const {
3179 llvm_unreachable("ReplaceNodeResults not implemented for this target!");
3182 /// This method returns the name of a target specific DAG node.
3183 virtual const char *getTargetNodeName(unsigned Opcode) const;
3185 /// This method returns a target specific FastISel object, or null if the
3186 /// target does not support "fast" ISel.
3187 virtual FastISel *createFastISel(FunctionLoweringInfo &,
3188 const TargetLibraryInfo *) const {
3192 bool verifyReturnAddressArgumentIsConstant(SDValue Op,
3193 SelectionDAG &DAG) const;
3195 //===--------------------------------------------------------------------===//
3196 // Inline Asm Support hooks
3199 /// This hook allows the target to expand an inline asm call to be explicit
3200 /// llvm code if it wants to. This is useful for turning simple inline asms
3201 /// into LLVM intrinsics, which gives the compiler more information about the
3202 /// behavior of the code.
3203 virtual bool ExpandInlineAsm(CallInst *) const {
3207 enum ConstraintType {
3208 C_Register, // Constraint represents specific register(s).
3209 C_RegisterClass, // Constraint represents any of register(s) in class.
3210 C_Memory, // Memory constraint.
3211 C_Other, // Something else.
3212 C_Unknown // Unsupported constraint.
3215 enum ConstraintWeight {
3217 CW_Invalid = -1, // No match.
3218 CW_Okay = 0, // Acceptable.
3219 CW_Good = 1, // Good weight.
3220 CW_Better = 2, // Better weight.
3221 CW_Best = 3, // Best weight.
3223 // Well-known weights.
3224 CW_SpecificReg = CW_Okay, // Specific register operands.
3225 CW_Register = CW_Good, // Register operands.
3226 CW_Memory = CW_Better, // Memory operands.
3227 CW_Constant = CW_Best, // Constant operand.
3228 CW_Default = CW_Okay // Default or don't know type.
3231 /// This contains information for each constraint that we are lowering.
3232 struct AsmOperandInfo : public InlineAsm::ConstraintInfo {
3233 /// This contains the actual string for the code, like "m". TargetLowering
3234 /// picks the 'best' code from ConstraintInfo::Codes that most closely
3235 /// matches the operand.
3236 std::string ConstraintCode;
3238 /// Information about the constraint code, e.g. Register, RegisterClass,
3239 /// Memory, Other, Unknown.
3240 TargetLowering::ConstraintType ConstraintType = TargetLowering::C_Unknown;
3242 /// If this is the result output operand or a clobber, this is null,
3243 /// otherwise it is the incoming operand to the CallInst. This gets
3244 /// modified as the asm is processed.
3245 Value *CallOperandVal = nullptr;
3247 /// The ValueType for the operand value.
3248 MVT ConstraintVT = MVT::Other;
3250 /// Copy constructor for copying from a ConstraintInfo.
3251 AsmOperandInfo(InlineAsm::ConstraintInfo Info)
3252 : InlineAsm::ConstraintInfo(std::move(Info)) {}
3254 /// Return true of this is an input operand that is a matching constraint
3256 bool isMatchingInputConstraint() const;
3258 /// If this is an input matching constraint, this method returns the output
3259 /// operand it matches.
3260 unsigned getMatchedOperand() const;
3263 using AsmOperandInfoVector = std::vector<AsmOperandInfo>;
3265 /// Split up the constraint string from the inline assembly value into the
3266 /// specific constraints and their prefixes, and also tie in the associated
3267 /// operand values. If this returns an empty vector, and if the constraint
3268 /// string itself isn't empty, there was an error parsing.
3269 virtual AsmOperandInfoVector ParseConstraints(const DataLayout &DL,
3270 const TargetRegisterInfo *TRI,
3271 ImmutableCallSite CS) const;
3273 /// Examine constraint type and operand type and determine a weight value.
3274 /// The operand object must already have been set up with the operand type.
3275 virtual ConstraintWeight getMultipleConstraintMatchWeight(
3276 AsmOperandInfo &info, int maIndex) const;
3278 /// Examine constraint string and operand type and determine a weight value.
3279 /// The operand object must already have been set up with the operand type.
3280 virtual ConstraintWeight getSingleConstraintMatchWeight(
3281 AsmOperandInfo &info, const char *constraint) const;
3283 /// Determines the constraint code and constraint type to use for the specific
3284 /// AsmOperandInfo, setting OpInfo.ConstraintCode and OpInfo.ConstraintType.
3285 /// If the actual operand being passed in is available, it can be passed in as
3286 /// Op, otherwise an empty SDValue can be passed.
3287 virtual void ComputeConstraintToUse(AsmOperandInfo &OpInfo,
3289 SelectionDAG *DAG = nullptr) const;
3291 /// Given a constraint, return the type of constraint it is for this target.
3292 virtual ConstraintType getConstraintType(StringRef Constraint) const;
3294 /// Given a physical register constraint (e.g. {edx}), return the register
3295 /// number and the register class for the register.
3297 /// Given a register class constraint, like 'r', if this corresponds directly
3298 /// to an LLVM register class, return a register of 0 and the register class
3301 /// This should only be used for C_Register constraints. On error, this
3302 /// returns a register number of 0 and a null register class pointer.
3303 virtual std::pair<unsigned, const TargetRegisterClass *>
3304 getRegForInlineAsmConstraint(const TargetRegisterInfo *TRI,
3305 StringRef Constraint, MVT VT) const;
3307 virtual unsigned getInlineAsmMemConstraint(StringRef ConstraintCode) const {
3308 if (ConstraintCode == "i")
3309 return InlineAsm::Constraint_i;
3310 else if (ConstraintCode == "m")
3311 return InlineAsm::Constraint_m;
3312 return InlineAsm::Constraint_Unknown;
3315 /// Try to replace an X constraint, which matches anything, with another that
3316 /// has more specific requirements based on the type of the corresponding
3317 /// operand. This returns null if there is no replacement to make.
3318 virtual const char *LowerXConstraint(EVT ConstraintVT) const;
3320 /// Lower the specified operand into the Ops vector. If it is invalid, don't
3321 /// add anything to Ops.
3322 virtual void LowerAsmOperandForConstraint(SDValue Op, std::string &Constraint,
3323 std::vector<SDValue> &Ops,
3324 SelectionDAG &DAG) const;
3326 //===--------------------------------------------------------------------===//
3327 // Div utility functions
3329 SDValue BuildSDIV(SDNode *N, const APInt &Divisor, SelectionDAG &DAG,
3330 bool IsAfterLegalization,
3331 std::vector<SDNode *> *Created) const;
3332 SDValue BuildUDIV(SDNode *N, const APInt &Divisor, SelectionDAG &DAG,
3333 bool IsAfterLegalization,
3334 std::vector<SDNode *> *Created) const;
3336 /// Targets may override this function to provide custom SDIV lowering for
3337 /// power-of-2 denominators. If the target returns an empty SDValue, LLVM
3338 /// assumes SDIV is expensive and replaces it with a series of other integer
3340 virtual SDValue BuildSDIVPow2(SDNode *N, const APInt &Divisor,
3342 std::vector<SDNode *> *Created) const;
3344 /// Indicate whether this target prefers to combine FDIVs with the same
3345 /// divisor. If the transform should never be done, return zero. If the
3346 /// transform should be done, return the minimum number of divisor uses
3347 /// that must exist.
3348 virtual unsigned combineRepeatedFPDivisors() const {
3352 /// Hooks for building estimates in place of slower divisions and square
3355 /// Return either a square root or its reciprocal estimate value for the input
3357 /// \p Enabled is a ReciprocalEstimate enum with value either 'Unspecified' or
3358 /// 'Enabled' as set by a potential default override attribute.
3359 /// If \p RefinementSteps is 'Unspecified', the number of Newton-Raphson
3360 /// refinement iterations required to generate a sufficient (though not
3361 /// necessarily IEEE-754 compliant) estimate is returned in that parameter.
3362 /// The boolean UseOneConstNR output is used to select a Newton-Raphson
3363 /// algorithm implementation that uses either one or two constants.
3364 /// The boolean Reciprocal is used to select whether the estimate is for the
3365 /// square root of the input operand or the reciprocal of its square root.
3366 /// A target may choose to implement its own refinement within this function.
3367 /// If that's true, then return '0' as the number of RefinementSteps to avoid
3368 /// any further refinement of the estimate.
3369 /// An empty SDValue return means no estimate sequence can be created.
3370 virtual SDValue getSqrtEstimate(SDValue Operand, SelectionDAG &DAG,
3371 int Enabled, int &RefinementSteps,
3372 bool &UseOneConstNR, bool Reciprocal) const {
3376 /// Return a reciprocal estimate value for the input operand.
3377 /// \p Enabled is a ReciprocalEstimate enum with value either 'Unspecified' or
3378 /// 'Enabled' as set by a potential default override attribute.
3379 /// If \p RefinementSteps is 'Unspecified', the number of Newton-Raphson
3380 /// refinement iterations required to generate a sufficient (though not
3381 /// necessarily IEEE-754 compliant) estimate is returned in that parameter.
3382 /// A target may choose to implement its own refinement within this function.
3383 /// If that's true, then return '0' as the number of RefinementSteps to avoid
3384 /// any further refinement of the estimate.
3385 /// An empty SDValue return means no estimate sequence can be created.
3386 virtual SDValue getRecipEstimate(SDValue Operand, SelectionDAG &DAG,
3387 int Enabled, int &RefinementSteps) const {
3391 //===--------------------------------------------------------------------===//
3392 // Legalization utility functions
3395 /// Expand a MUL or [US]MUL_LOHI of n-bit values into two or four nodes,
3396 /// respectively, each computing an n/2-bit part of the result.
3397 /// \param Result A vector that will be filled with the parts of the result
3398 /// in little-endian order.
3399 /// \param LL Low bits of the LHS of the MUL. You can use this parameter
3400 /// if you want to control how low bits are extracted from the LHS.
3401 /// \param LH High bits of the LHS of the MUL. See LL for meaning.
3402 /// \param RL Low bits of the RHS of the MUL. See LL for meaning
3403 /// \param RH High bits of the RHS of the MUL. See LL for meaning.
3404 /// \returns true if the node has been expanded, false if it has not
3405 bool expandMUL_LOHI(unsigned Opcode, EVT VT, SDLoc dl, SDValue LHS,
3406 SDValue RHS, SmallVectorImpl<SDValue> &Result, EVT HiLoVT,
3407 SelectionDAG &DAG, MulExpansionKind Kind,
3408 SDValue LL = SDValue(), SDValue LH = SDValue(),
3409 SDValue RL = SDValue(), SDValue RH = SDValue()) const;
3411 /// Expand a MUL into two nodes. One that computes the high bits of
3412 /// the result and one that computes the low bits.
3413 /// \param HiLoVT The value type to use for the Lo and Hi nodes.
3414 /// \param LL Low bits of the LHS of the MUL. You can use this parameter
3415 /// if you want to control how low bits are extracted from the LHS.
3416 /// \param LH High bits of the LHS of the MUL. See LL for meaning.
3417 /// \param RL Low bits of the RHS of the MUL. See LL for meaning
3418 /// \param RH High bits of the RHS of the MUL. See LL for meaning.
3419 /// \returns true if the node has been expanded. false if it has not
3420 bool expandMUL(SDNode *N, SDValue &Lo, SDValue &Hi, EVT HiLoVT,
3421 SelectionDAG &DAG, MulExpansionKind Kind,
3422 SDValue LL = SDValue(), SDValue LH = SDValue(),
3423 SDValue RL = SDValue(), SDValue RH = SDValue()) const;
3425 /// Expand float(f32) to SINT(i64) conversion
3426 /// \param N Node to expand
3427 /// \param Result output after conversion
3428 /// \returns True, if the expansion was successful, false otherwise
3429 bool expandFP_TO_SINT(SDNode *N, SDValue &Result, SelectionDAG &DAG) const;
3431 /// Turn load of vector type into a load of the individual elements.
3432 /// \param LD load to expand
3433 /// \returns MERGE_VALUEs of the scalar loads with their chains.
3434 SDValue scalarizeVectorLoad(LoadSDNode *LD, SelectionDAG &DAG) const;
3436 // Turn a store of a vector type into stores of the individual elements.
3437 /// \param ST Store with a vector value type
3438 /// \returns MERGE_VALUs of the individual store chains.
3439 SDValue scalarizeVectorStore(StoreSDNode *ST, SelectionDAG &DAG) const;
3441 /// Expands an unaligned load to 2 half-size loads for an integer, and
3442 /// possibly more for vectors.
3443 std::pair<SDValue, SDValue> expandUnalignedLoad(LoadSDNode *LD,
3444 SelectionDAG &DAG) const;
3446 /// Expands an unaligned store to 2 half-size stores for integer values, and
3447 /// possibly more for vectors.
3448 SDValue expandUnalignedStore(StoreSDNode *ST, SelectionDAG &DAG) const;
3450 /// Increments memory address \p Addr according to the type of the value
3451 /// \p DataVT that should be stored. If the data is stored in compressed
3452 /// form, the memory address should be incremented according to the number of
3453 /// the stored elements. This number is equal to the number of '1's bits
3455 /// \p DataVT is a vector type. \p Mask is a vector value.
3456 /// \p DataVT and \p Mask have the same number of vector elements.
3457 SDValue IncrementMemoryAddress(SDValue Addr, SDValue Mask, const SDLoc &DL,
3458 EVT DataVT, SelectionDAG &DAG,
3459 bool IsCompressedMemory) const;
3461 /// Get a pointer to vector element \p Idx located in memory for a vector of
3462 /// type \p VecVT starting at a base address of \p VecPtr. If \p Idx is out of
3463 /// bounds the returned pointer is unspecified, but will be within the vector
3465 SDValue getVectorElementPointer(SelectionDAG &DAG, SDValue VecPtr, EVT VecVT,
3468 //===--------------------------------------------------------------------===//
3469 // Instruction Emitting Hooks
3472 /// This method should be implemented by targets that mark instructions with
3473 /// the 'usesCustomInserter' flag. These instructions are special in various
3474 /// ways, which require special support to insert. The specified MachineInstr
3475 /// is created but not inserted into any basic blocks, and this method is
3476 /// called to expand it into a sequence of instructions, potentially also
3477 /// creating new basic blocks and control flow.
3478 /// As long as the returned basic block is different (i.e., we created a new
3479 /// one), the custom inserter is free to modify the rest of \p MBB.
3480 virtual MachineBasicBlock *
3481 EmitInstrWithCustomInserter(MachineInstr &MI, MachineBasicBlock *MBB) const;
3483 /// This method should be implemented by targets that mark instructions with
3484 /// the 'hasPostISelHook' flag. These instructions must be adjusted after
3485 /// instruction selection by target hooks. e.g. To fill in optional defs for
3486 /// ARM 's' setting instructions.
3487 virtual void AdjustInstrPostInstrSelection(MachineInstr &MI,
3488 SDNode *Node) const;
3490 /// If this function returns true, SelectionDAGBuilder emits a
3491 /// LOAD_STACK_GUARD node when it is lowering Intrinsic::stackprotector.
3492 virtual bool useLoadStackGuardNode() const {
3496 virtual SDValue emitStackGuardXorFP(SelectionDAG &DAG, SDValue Val,
3497 const SDLoc &DL) const {
3498 llvm_unreachable("not implemented for this target");
3501 /// Lower TLS global address SDNode for target independent emulated TLS model.
3502 virtual SDValue LowerToTLSEmulatedModel(const GlobalAddressSDNode *GA,
3503 SelectionDAG &DAG) const;
3505 // seteq(x, 0) -> truncate(srl(ctlz(zext(x)), log2(#bits)))
3506 // If we're comparing for equality to zero and isCtlzFast is true, expose the
3507 // fact that this can be implemented as a ctlz/srl pair, so that the dag
3508 // combiner can fold the new nodes.
3509 SDValue lowerCmpEqZeroToCtlzSrl(SDValue Op, SelectionDAG &DAG) const;
3512 SDValue simplifySetCCWithAnd(EVT VT, SDValue N0, SDValue N1,
3513 ISD::CondCode Cond, DAGCombinerInfo &DCI,
3514 const SDLoc &DL) const;
3517 /// Given an LLVM IR type and return type attributes, compute the return value
3518 /// EVTs and flags, and optionally also the offsets, if the return value is
3519 /// being lowered to memory.
3520 void GetReturnInfo(Type *ReturnType, AttributeList attr,
3521 SmallVectorImpl<ISD::OutputArg> &Outs,
3522 const TargetLowering &TLI, const DataLayout &DL);
3524 } // end namespace llvm
3526 #endif // LLVM_CODEGEN_TARGETLOWERING_H