LLVM 24.0.0git
TargetLowering.h
Go to the documentation of this file.
1//===- llvm/CodeGen/TargetLowering.h - Target Lowering Info -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// This file describes how to lower LLVM code to machine code. This has two
11/// main components:
12///
13/// 1. Which ValueTypes are natively supported by the target.
14/// 2. Which operations are supported for supported ValueTypes.
15/// 3. Cost thresholds for alternative implementations of certain operations.
16///
17/// In addition it has a few other components, like information about FP
18/// immediates.
19///
20//===----------------------------------------------------------------------===//
21
22#ifndef LLVM_CODEGEN_TARGETLOWERING_H
23#define LLVM_CODEGEN_TARGETLOWERING_H
24
25#include "llvm/ADT/APInt.h"
26#include "llvm/ADT/ArrayRef.h"
27#include "llvm/ADT/DenseMap.h"
29#include "llvm/ADT/StringRef.h"
42#include "llvm/IR/Attributes.h"
43#include "llvm/IR/CallingConv.h"
44#include "llvm/IR/DataLayout.h"
46#include "llvm/IR/Function.h"
47#include "llvm/IR/InlineAsm.h"
48#include "llvm/IR/Instruction.h"
51#include "llvm/IR/Type.h"
58#include <algorithm>
59#include <cassert>
60#include <climits>
61#include <cstdint>
62#include <map>
63#include <string>
64#include <utility>
65#include <vector>
66
67namespace llvm {
68
69class AssumptionCache;
70class CCState;
71class CCValAssign;
74class Constant;
75enum class ExceptionHandling : int;
76class FastISel;
78class GlobalValue;
79class Loop;
81class IntrinsicInst;
82class IRBuilderBase;
83struct KnownBits;
84class LLVMContext;
86class MachineFunction;
87class MachineInstr;
89class MachineLoop;
91class MCContext;
92class MCExpr;
93class Module;
96class TargetMachine;
97class MCRegisterClass;
101class Value;
102class VPIntrinsic;
103
104namespace Sched {
105
107 None, // No preference
108 Source, // Follow source order.
109 RegPressure, // Scheduling for lowest register pressure.
110 Hybrid, // Scheduling for both latency and register pressure.
111 ILP, // Scheduling for ILP in low register pressure mode.
112 VLIW, // Scheduling for VLIW targets.
113 Fast, // Fast suboptimal list scheduling
114 Linearize, // Linearize DAG, no scheduling
115 Last = Linearize // Marker for the last Sched::Preference
116};
117
118} // end namespace Sched
119
120// MemOp models a memory operation, either memset or memcpy/memmove.
121struct MemOp {
122private:
123 enum class MemOpKind {
124 Memset,
125 MemsetWithZero, // memset the memory with zeros
126 Memcpy, // copy memory from source to destination, source and destination do
127 // not overlap
128 MemcpyStrSrc, // memcpy source is an in-register constant, so it does not
129 // need to be loaded
130 Memmove, // memmove: like memcpy, but source and destination regions may
131 // overlap
132 };
133
134 // Shared
135 uint64_t Size;
136 bool DstAlignCanChange; // true if destination alignment can satisfy any
137 // constraint.
138 Align DstAlign; // Specified alignment of the memory operation.
139
140 bool IsVolatile;
141 MemOpKind Kind;
142 Align SrcAlign; // Inferred alignment of the source or default value if the
143 // memory operation does not need to load the value.
144public:
145 static MemOp Copy(uint64_t Size, bool DstAlignCanChange, Align DstAlign,
146 Align SrcAlign, bool IsVolatile,
147 bool MemcpyStrSrc = false) {
148 MemOp Op;
149 Op.Size = Size;
150 Op.DstAlignCanChange = DstAlignCanChange;
151 Op.DstAlign = DstAlign;
152 Op.IsVolatile = IsVolatile;
153 Op.Kind = MemcpyStrSrc ? MemOpKind::MemcpyStrSrc : MemOpKind::Memcpy;
154 Op.SrcAlign = SrcAlign;
155 return Op;
156 }
157
158 static MemOp Move(uint64_t Size, bool DstAlignCanChange, Align DstAlign,
159 Align SrcAlign, bool IsVolatile) {
160 MemOp Op;
161 Op.Size = Size;
162 Op.DstAlignCanChange = DstAlignCanChange;
163 Op.DstAlign = DstAlign;
164 Op.IsVolatile = IsVolatile;
165 Op.Kind = MemOpKind::Memmove;
166 Op.SrcAlign = SrcAlign;
167 return Op;
168 }
169
170 static MemOp Set(uint64_t Size, bool DstAlignCanChange, Align DstAlign,
171 bool IsZeroMemset, bool IsVolatile) {
172 MemOp Op;
173 Op.Size = Size;
174 Op.DstAlignCanChange = DstAlignCanChange;
175 Op.DstAlign = DstAlign;
176 Op.IsVolatile = IsVolatile;
177 Op.Kind = IsZeroMemset ? MemOpKind::MemsetWithZero : MemOpKind::Memset;
178 return Op;
179 }
180
181 uint64_t size() const { return Size; }
183 assert(!DstAlignCanChange);
184 return DstAlign;
185 }
186 bool isFixedDstAlign() const { return !DstAlignCanChange; }
187 bool isVolatile() const { return IsVolatile; }
188 bool isMemset() const {
189 return Kind == MemOpKind::Memset || Kind == MemOpKind::MemsetWithZero;
190 }
191 bool isMemcpy() const {
192 return Kind == MemOpKind::Memcpy || Kind == MemOpKind::MemcpyStrSrc;
193 }
194 bool isMemmove() const { return Kind == MemOpKind::Memmove; }
195 bool isMemcpyOrMemmove() const { return isMemcpy() || isMemmove(); }
197 return isMemcpyOrMemmove() && !DstAlignCanChange;
198 }
199 bool isZeroMemset() const { return Kind == MemOpKind::MemsetWithZero; }
200 bool isMemcpyStrSrc() const { return Kind == MemOpKind::MemcpyStrSrc; }
202 assert(isMemcpyOrMemmove() && "Must be a memcpy or memmove");
203 return SrcAlign;
204 }
205 bool isSrcAligned(Align AlignCheck) const {
206 return isMemset() || llvm::isAligned(AlignCheck, SrcAlign.value());
207 }
208 bool isDstAligned(Align AlignCheck) const {
209 return DstAlignCanChange || llvm::isAligned(AlignCheck, DstAlign.value());
210 }
211 bool isAligned(Align AlignCheck) const {
212 return isSrcAligned(AlignCheck) && isDstAligned(AlignCheck);
213 }
214};
215
216/// This base class for TargetLowering contains the SelectionDAG-independent
217/// parts that can be used from the rest of CodeGen.
219public:
220 /// This enum indicates whether operations are valid for a target, and if not,
221 /// what action should be used to make them valid.
223 Legal, // The target natively supports this operation.
224 Promote, // This operation should be executed in a larger type.
225 Expand, // Try to expand this to other ops, otherwise use a libcall.
226 LibCall, // Don't try to expand this to other ops, always use a libcall.
227 Custom // Use the LowerOperation hook to implement custom lowering.
228 };
229
230 /// This enum indicates whether a types are legal for a target, and if not,
231 /// what action should be used to make them valid.
233 TypeLegal, // The target natively supports this type.
234 TypePromoteInteger, // Replace this integer with a larger one.
235 TypeExpandInteger, // Split this integer into two of half the size.
236 TypeSoftenFloat, // Convert this float to a same size integer type.
237 TypeExpandFloat, // Split this float into two of half the size.
238 TypeScalarizeVector, // Replace this one-element vector with its element.
239 TypeSplitVector, // Split this vector into two of half the size.
240 TypeWidenVector, // This vector should be widened into a larger vector.
241 TypeSoftPromoteHalf, // Soften half to i16 and use float to do arithmetic.
242 TypeScalarizeScalableVector, // This action is explicitly left
243 // unimplemented. While it is theoretically
244 // possible to legalize operations on scalable
245 // types with a loop that handles the vscale *
246 // #lanes of the vector, this is non-trivial at
247 // SelectionDAG level and these types are
248 // better to be widened or promoted.
249 };
250
251 /// LegalizeKind holds the legalization kind that needs to happen to EVT
252 /// in order to type-legalize it.
253 using LegalizeKind = std::pair<LegalizeTypeAction, EVT>;
254
255 /// Enum that describes how the target represents true/false values.
257 UndefinedBooleanContent, // Only bit 0 counts, the rest can hold garbage.
258 ZeroOrOneBooleanContent, // All bits zero except for bit 0.
259 ZeroOrNegativeOneBooleanContent // All bits equal to bit 0.
260 };
261
262 /// Enum that describes what type of support for selects the target has.
264 ScalarValSelect, // The target supports scalar selects (ex: cmov).
265 ScalarCondVectorVal, // The target supports selects with a scalar condition
266 // and vector values (ex: cmov).
267 VectorMaskSelect // The target supports vector selects with a vector
268 // mask (ex: x86 blends).
269 };
270
271 /// Enum that specifies what an atomic load/AtomicRMWInst is expanded
272 /// to, if at all. Exists because different targets have different levels of
273 /// support for these atomic instructions, and also have different options
274 /// w.r.t. what they should expand to.
276 None, // Don't expand the instruction.
277 CastToInteger, // Cast the atomic instruction to another type, e.g. from
278 // floating-point to integer type.
279 LLSC, // Expand the instruction into loadlinked/storeconditional; used
280 // by ARM/AArch64/PowerPC.
281 LLOnly, // Expand the (load) instruction into just a load-linked, which has
282 // greater atomic guarantees than a normal load.
283 CmpXChg, // Expand the instruction into cmpxchg; used by at least X86.
284 MaskedIntrinsic, // Use a target-specific intrinsic for the LL/SC loop.
285 BitTestIntrinsic, // Use a target-specific intrinsic for special bit
286 // operations; used by X86.
287 CmpArithIntrinsic, // Use a target-specific intrinsic for special compare
288 // operations; used by X86.
289 Expand, // Generic expansion in terms of other atomic operations.
290 CustomExpand, // Custom target-specific expansion using TLI hooks.
291
292 // Rewrite to a non-atomic form for use in a known non-preemptible
293 // environment.
295 };
296
297 /// Enum that specifies when a multiplication should be expanded.
298 enum class MulExpansionKind {
299 Always, // Always expand the instruction.
300 OnlyLegalOrCustom, // Only expand when the resulting instructions are legal
301 // or custom.
302 };
303
304 /// Enum that specifies when a float negation is beneficial.
305 enum class NegatibleCost {
306 Cheaper = 0, // Negated expression is cheaper.
307 Neutral = 1, // Negated expression has the same cost.
308 Expensive = 2 // Negated expression is more expensive.
309 };
310
311 /// Enum that specifies how expensive lowering an EXTRACT_SUBVECTOR is.
313 Free = 0, // Lowers to no instruction at all, e.g. a subregister copy.
314 Cheap = 1, // Lowers to at most one instruction, and may still be free if
315 // the target can fold the extract into the instruction
316 // consuming it (e.g. a widening op that reads the high half of
317 // a register).
318 Expensive = 2 // Needs a shuffle sequence that cannot be folded away.
319 };
320
321 /// Enum of different potentially desirable ways to fold (and/or (setcc ...),
322 /// (setcc ...)).
324 None = 0, // No fold is preferable.
325 AddAnd = 1, // Fold with `Add` op and `And` op is preferable.
326 NotAnd = 2, // Fold with `Not` op and `And` op is preferable.
327 ABS = 4, // Fold with `llvm.abs` op is preferable.
328 };
329
331 public:
334 /// Original unlegalized argument type.
336 /// Same as OrigTy, or partially legalized for soft float libcalls.
338 bool IsSExt : 1;
339 bool IsZExt : 1;
340 bool IsNoExt : 1;
341 bool IsInReg : 1;
342 bool IsSRet : 1;
343 bool IsNest : 1;
344 bool IsByVal : 1;
345 bool IsByRef : 1;
346 bool IsInAlloca : 1;
348 bool IsReturned : 1;
349 bool IsSwiftSelf : 1;
350 bool IsSwiftAsync : 1;
351 bool IsSwiftError : 1;
353 MaybeAlign Alignment = std::nullopt;
354 Type *IndirectType = nullptr;
355
362
366 setExtAttribute(ExtAttr);
367 }
368
371 : ArgListEntry(nullptr, Node, Ty) {
372 setExtAttribute(ExtAttr);
373 }
374
375 LLVM_ABI void setAttributes(const CallBase *Call, unsigned ArgIdx);
376 LLVM_ABI void setAttributes(const AttributeList &Attrs, unsigned ArgIdx);
377 LLVM_ABI void setExtAttribute(Attribute::AttrKind Attr);
378 };
379 using ArgListTy = std::vector<ArgListEntry>;
380
382 switch (Content) {
384 // Extend by adding rubbish bits.
385 return ISD::ANY_EXTEND;
387 // Extend by adding zero bits.
388 return ISD::ZERO_EXTEND;
390 // Extend by copying the sign bit.
391 return ISD::SIGN_EXTEND;
392 }
393 llvm_unreachable("Invalid content kind");
394 }
395
396 explicit TargetLoweringBase(const TargetMachine &TM,
397 const TargetSubtargetInfo &STI);
401
402 /// Return true if the target support strict float operation
403 bool isStrictFPEnabled() const {
404 return IsStrictFPEnabled;
405 }
406
407protected:
408 /// Initialize all of the actions to default values.
409 void initActions();
410
411public:
412 const TargetMachine &getTargetMachine() const { return TM; }
413
414 virtual bool useSoftFloat() const { return false; }
415
416 /// Return the pointer type for the given address space, defaults to
417 /// the pointer type from the data layout.
418 /// FIXME: The default needs to be removed once all the code is updated.
419 virtual MVT getPointerTy(const DataLayout &DL, uint32_t AS = 0) const {
420 return MVT::getIntegerVT(DL.getPointerSizeInBits(AS));
421 }
422
423 /// Return the in-memory pointer type for the given address space, defaults to
424 /// the pointer type from the data layout.
425 /// FIXME: The default needs to be removed once all the code is updated.
426 virtual MVT getPointerMemTy(const DataLayout &DL, uint32_t AS = 0) const {
427 return MVT::getIntegerVT(DL.getPointerSizeInBits(AS));
428 }
429
430 /// Return the type for frame index, which is determined by
431 /// the alloca address space specified through the data layout.
433 return getPointerTy(DL, DL.getAllocaAddrSpace());
434 }
435
436 /// Return the type for code pointers, which is determined by the program
437 /// address space specified through the data layout.
439 return getPointerTy(DL, DL.getProgramAddressSpace());
440 }
441
442 /// Return the type for operands of fence.
443 /// TODO: Let fence operands be of i32 type and remove this.
444 virtual MVT getFenceOperandTy(const DataLayout &DL) const {
445 return getPointerTy(DL);
446 }
447
448 /// Return the type to use for a scalar shift opcode, given the shifted amount
449 /// type. Targets should return a legal type if the input type is legal.
450 /// Targets can return a type that is too small if the input type is illegal.
451 virtual MVT getScalarShiftAmountTy(const DataLayout &, EVT) const;
452
453 /// Returns the type for the shift amount of a shift opcode. For vectors,
454 /// returns the input type. For scalars, calls getScalarShiftAmountTy.
455 /// If getScalarShiftAmountTy type cannot represent all possible shift
456 /// amounts, returns MVT::i32.
457 EVT getShiftAmountTy(EVT LHSTy, const DataLayout &DL) const;
458
459 /// Return the preferred type to use for a shift opcode, given the shifted
460 /// amount type is \p ShiftValueTy.
462 virtual LLT getPreferredShiftAmountTy(LLT ShiftValueTy) const {
463 return ShiftValueTy;
464 }
465
466 /// Returns the type to be used for the index operand vector operations. By
467 /// default we assume it will have the same size as an address space 0
468 /// pointer.
469 virtual unsigned getVectorIdxWidth(const DataLayout &DL) const {
470 return DL.getPointerSizeInBits(0);
471 }
472
473 /// Returns the type to be used for the index operand of:
474 /// ISD::INSERT_VECTOR_ELT, ISD::EXTRACT_VECTOR_ELT,
475 /// ISD::INSERT_SUBVECTOR, and ISD::EXTRACT_SUBVECTOR
479
480 /// Returns the type to be used for the index operand of:
481 /// G_INSERT_VECTOR_ELT, G_EXTRACT_VECTOR_ELT,
482 /// G_INSERT_SUBVECTOR, and G_EXTRACT_SUBVECTOR
485 }
486
487 /// Returns the type to be used for the EVL/AVL operand of VP nodes:
488 /// ISD::VP_UDIV, ISD::VP_SDIV, etc. It must be a legal scalar integer type,
489 /// and must be at least as large as i32. The EVL is implicitly zero-extended
490 /// to any larger type.
491 virtual MVT getVPExplicitVectorLengthTy() const { return MVT::i32; }
492
493 /// This callback is used to inspect load/store instructions and add
494 /// target-specific MachineMemOperand flags to them. The default
495 /// implementation does nothing.
499
500 /// This callback is used to inspect load/store SDNode.
501 /// The default implementation does nothing.
506
507 MachineMemOperand::Flags getLoadMemOperandFlags(
508 const LoadInst &LI, const DataLayout &DL, AssumptionCache *AC = nullptr,
509 const TargetLibraryInfo *LibInfo = nullptr,
511 MachineMemOperand::Flags getStoreMemOperandFlags(const StoreInst &SI,
512 const DataLayout &DL) const;
513 MachineMemOperand::Flags getAtomicMemOperandFlags(const Instruction &AI,
514 const DataLayout &DL) const;
516 getVPIntrinsicMemOperandFlags(const VPIntrinsic &VPIntrin) const;
517
518 virtual bool isSelectSupported(SelectSupportKind /*kind*/) const {
519 return true;
520 }
521
522 /// Return true if the @llvm.get.active.lane.mask intrinsic should be expanded
523 /// using generic code in SelectionDAGBuilder.
524 virtual bool shouldExpandGetActiveLaneMask(EVT VT, EVT OpVT) const {
525 return true;
526 }
527
528 virtual bool shouldExpandGetVectorLength(EVT CountVT, unsigned VF,
529 bool IsScalable) const {
530 return true;
531 }
532
533 /// Return the minimum number of bits required to hold the maximum possible
534 /// number of trailing zero vector elements.
535 unsigned getBitWidthForCttzElements(EVT RetVT, ElementCount EC,
536 bool ZeroIsPoison,
537 const ConstantRange *VScaleRange) const;
538
539 // Return true if op(vecreduce(x), vecreduce(y)) should be reassociated to
540 // vecreduce(op(x, y)) for the reduction opcode RedOpc.
541 virtual bool shouldReassociateReduction(unsigned RedOpc, EVT VT) const {
542 return true;
543 }
544
545 /// Return true if it is profitable to convert a select of FP constants into
546 /// a constant pool load whose address depends on the select condition. The
547 /// parameter may be used to differentiate a select with FP compare from
548 /// integer compare.
549 virtual bool reduceSelectOfFPConstantLoads(EVT CmpOpVT) const {
550 return true;
551 }
552
553 /// Does the target have multiple (allocatable) condition registers that
554 /// can be used to store the results of comparisons for use by selects
555 /// and conditional branches. With multiple condition registers, the code
556 /// generator will not aggressively sink comparisons into the blocks of their
557 /// users. \p VT is the type of the condition value, e.g. the type of the
558 /// result of a comparison.
559 virtual bool hasMultipleConditionRegisters(EVT VT) const { return false; }
560
561 /// Return true if the target has BitExtract instructions.
562 bool hasExtractBitsInsn() const { return HasExtractBitsInsn; }
563
564 /// Return the preferred vector type legalization action.
567 // The default action for one element vectors is to scalarize
569 return TypeScalarizeVector;
570 // The default action for an odd-width vector is to widen.
571 if (!VT.isPow2VectorType())
572 return TypeWidenVector;
573 // The default action for other vectors is to promote
574 return TypePromoteInteger;
575 }
576
577 // Return true if, for soft-promoted half, the half type should be passed to
578 // and returned from functions as f32. The default behavior is to pass as
579 // i16. If soft-promoted half is not used, this function is ignored and
580 // values are always passed and returned as f32.
581 virtual bool useFPRegsForHalfType() const { return false; }
582
583 // There are two general methods for expanding a BUILD_VECTOR node:
584 // 1. Use SCALAR_TO_VECTOR on the defined scalar values and then shuffle
585 // them together.
586 // 2. Build the vector on the stack and then load it.
587 // If this function returns true, then method (1) will be used, subject to
588 // the constraint that all of the necessary shuffles are legal (as determined
589 // by isShuffleMaskLegal). If this function returns false, then method (2) is
590 // always used. The vector type, and the number of defined values, are
591 // provided.
592 virtual bool
594 unsigned DefinedValues) const {
595 return DefinedValues < 3;
596 }
597
598 /// Return true if integer divide is usually cheaper than a sequence of
599 /// several shifts, adds, and multiplies for this target.
600 /// The definition of "cheaper" may depend on whether we're optimizing
601 /// for speed or for size.
602 virtual bool isIntDivCheap(EVT VT, AttributeList Attr) const { return false; }
603
604 /// Return true if the target can handle a standalone remainder operation.
605 virtual bool hasStandaloneRem(EVT VT) const {
606 return true;
607 }
608
609 /// Return true if SQRT(X) shouldn't be replaced with X*RSQRT(X).
610 virtual bool isFsqrtCheap(SDValue X, SelectionDAG &DAG) const {
611 // Default behavior is to replace SQRT(X) with X*RSQRT(X).
612 return false;
613 }
614
615 /// Reciprocal estimate status values used by the functions below.
620 };
621
622 /// Return a ReciprocalEstimate enum value for a square root of the given type
623 /// based on the function's attributes. If the operation is not overridden by
624 /// the function's attributes, "Unspecified" is returned and target defaults
625 /// are expected to be used for instruction selection.
626 int getRecipEstimateSqrtEnabled(EVT VT, const Function &F) const;
627
628 /// Return a ReciprocalEstimate enum value for a division of the given type
629 /// based on the function's attributes. If the operation is not overridden by
630 /// the function's attributes, "Unspecified" is returned and target defaults
631 /// are expected to be used for instruction selection.
632 int getRecipEstimateDivEnabled(EVT VT, const Function &MF) const;
633
634 /// Return the refinement step count for a square root of the given type based
635 /// on the function's attributes. If the operation is not overridden by
636 /// the function's attributes, "Unspecified" is returned and target defaults
637 /// are expected to be used for instruction selection.
638 int getSqrtRefinementSteps(EVT VT, const Function &MF) const;
639
640 /// Return the refinement step count for a division of the given type based
641 /// on the function's attributes. If the operation is not overridden by
642 /// the function's attributes, "Unspecified" is returned and target defaults
643 /// are expected to be used for instruction selection.
644 int getDivRefinementSteps(EVT VT, const Function &MF) const;
645
646 /// Returns true if target has indicated at least one type should be bypassed.
647 bool isSlowDivBypassed() const { return !BypassSlowDivWidths.empty(); }
648
649 /// Returns map of slow types for division or remainder with corresponding
650 /// fast types
652 return BypassSlowDivWidths;
653 }
654
655 /// Return true if Flow Control is an expensive operation that should be
656 /// avoided.
657 bool isJumpExpensive() const { return JumpIsExpensive; }
658
659 // Costs parameters used by
660 // SelectionDAGBuilder::shouldKeepJumpConditionsTogether.
661 // shouldKeepJumpConditionsTogether will use these parameter value to
662 // determine if two conditions in the form `br (and/or cond1, cond2)` should
663 // be split into two branches or left as one.
664 //
665 // BaseCost is the cost threshold (in latency). If the estimated latency of
666 // computing both `cond1` and `cond2` is below the cost of just computing
667 // `cond1` + BaseCost, the two conditions will be kept together. Otherwise
668 // they will be split.
669 //
670 // LikelyBias increases BaseCost if branch probability info indicates that it
671 // is likely that both `cond1` and `cond2` will be computed.
672 //
673 // UnlikelyBias decreases BaseCost if branch probability info indicates that
674 // it is likely that both `cond1` and `cond2` will be computed.
675 //
676 // Set any field to -1 to make it ignored (setting BaseCost to -1 results in
677 // `shouldKeepJumpConditionsTogether` always returning false).
683 // Return params for deciding if we should keep two branch conditions merged
684 // or split them into two separate branches.
685 // Arg0: The binary op joining the two conditions (and/or).
686 // Arg1: The first condition (cond1)
687 // Arg2: The second condition (cond2)
688 // Arg3: The containing function.
689 virtual CondMergingParams
691 const Value *, const Function *) const {
692 // -1 will always result in splitting.
693 return {-1, -1, -1};
694 }
695
696 /// Return true if selects are only cheaper than branches if the branch is
697 /// unlikely to be predicted right.
701
702 virtual bool fallBackToDAGISel(const Instruction &Inst) const {
703 return false;
704 }
705
706 /// Return true if the following transform is beneficial:
707 /// fold (conv (load x)) -> (load (conv*)x)
708 /// On architectures that don't natively support some vector loads
709 /// efficiently, casting the load to a smaller vector of larger types and
710 /// loading is more efficient, however, this can be undone by optimizations in
711 /// dag combiner.
712 virtual bool isLoadBitCastBeneficial(EVT LoadVT, EVT BitcastVT,
713 const SelectionDAG &DAG,
714 const MachineMemOperand &MMO) const;
715
716 /// Return true if the following transform is beneficial:
717 /// (store (y (conv x)), y*)) -> (store x, (x*))
718 virtual bool isStoreBitCastBeneficial(EVT StoreVT, EVT BitcastVT,
719 const SelectionDAG &DAG,
720 const MachineMemOperand &MMO) const {
721 // Default to the same logic as loads.
722 return isLoadBitCastBeneficial(StoreVT, BitcastVT, DAG, MMO);
723 }
724
725 /// Return true if it is expected to be cheaper to do a store of vector
726 /// constant with the given size and type for the address space than to
727 /// store the individual scalar element constants.
728 virtual bool storeOfVectorConstantIsCheap(bool IsZero, EVT MemVT,
729 unsigned NumElem,
730 unsigned AddrSpace) const {
731 return IsZero;
732 }
733
734 /// Allow store merging for the specified type after legalization in addition
735 /// to before legalization. This may transform stores that do not exist
736 /// earlier (for example, stores created from intrinsics).
737 virtual bool mergeStoresAfterLegalization(EVT MemVT) const {
738 return true;
739 }
740
741 /// Returns if it's reasonable to merge stores to MemVT size.
742 virtual bool canMergeStoresTo(unsigned AS, EVT MemVT,
743 const MachineFunction &MF) const {
744 return true;
745 }
746
747 /// Return true if it is cheap to speculate a call to intrinsic cttz.
748 virtual bool isCheapToSpeculateCttz(Type *Ty) const {
749 return false;
750 }
751
752 /// Return true if it is cheap to speculate a call to intrinsic ctlz.
753 virtual bool isCheapToSpeculateCtlz(Type *Ty) const {
754 return false;
755 }
756
757 /// Return true if ctlz instruction is fast.
758 virtual bool isCtlzFast() const {
759 return false;
760 }
761
762 /// Return true if ctpop instruction is fast.
763 virtual bool isCtpopFast(EVT VT) const {
764 return isOperationLegal(ISD::CTPOP, VT);
765 }
766
767 /// Return the maximum number of "x & (x - 1)" operations that can be done
768 /// instead of deferring to a custom CTPOP.
769 virtual unsigned getCustomCtpopCost(EVT VT, ISD::CondCode Cond) const {
770 return 1;
771 }
772
773 /// Return true if instruction generated for equality comparison is folded
774 /// with instruction generated for signed comparison.
775 virtual bool isEqualityCmpFoldedWithSignedCmp() const { return true; }
776
777 /// Return true if the heuristic to prefer icmp eq zero should be used in code
778 /// gen prepare.
779 virtual bool preferZeroCompareBranch() const { return false; }
780
781 /// Return true if it is cheaper to split the store of a merged int val
782 /// from a pair of smaller values into multiple stores.
783 virtual bool isMultiStoresCheaperThanBitsMerge(EVT LTy, EVT HTy) const {
784 return false;
785 }
786
787 /// Return if the target supports combining a
788 /// chain like:
789 /// \code
790 /// %andResult = and %val1, #mask
791 /// %icmpResult = icmp %andResult, 0
792 /// \endcode
793 /// into a single machine instruction of a form like:
794 /// \code
795 /// cc = test %register, #mask
796 /// \endcode
797 virtual bool isMaskAndCmp0FoldingBeneficial(const Instruction &AndI) const {
798 return false;
799 }
800
801 /// Return true if it is valid to merge the TargetMMOFlags in two SDNodes.
802 virtual bool
804 const MemSDNode &NodeY) const {
805 return true;
806 }
807
808 /// Use bitwise logic to make pairs of compares more efficient. For example:
809 /// and (seteq A, B), (seteq C, D) --> seteq (or (xor A, B), (xor C, D)), 0
810 /// This should be true when it takes more than one instruction to lower
811 /// setcc (cmp+set on x86 scalar), when bitwise ops are faster than logic on
812 /// condition bits (crand on PowerPC), and/or when reducing cmp+br is a win.
813 virtual bool convertSetCCLogicToBitwiseLogic(EVT VT) const {
814 return false;
815 }
816
817 /// Return the preferred operand type if the target has a quick way to compare
818 /// integer values of the given size. Assume that any legal integer type can
819 /// be compared efficiently. Targets may override this to allow illegal wide
820 /// types to return a vector type if there is support to compare that type.
821 virtual MVT hasFastEqualityCompare(unsigned NumBits) const {
822 MVT VT = MVT::getIntegerVT(NumBits);
824 }
825
826 /// Return true if the target should transform:
827 /// (X & Y) == Y ---> (~X & Y) == 0
828 /// (X & Y) != Y ---> (~X & Y) != 0
829 ///
830 /// This may be profitable if the target has a bitwise and-not operation that
831 /// sets comparison flags. A target may want to limit the transformation based
832 /// on the type of Y or if Y is a constant.
833 ///
834 /// Note that the transform will not occur if Y is known to be a power-of-2
835 /// because a mask and compare of a single bit can be handled by inverting the
836 /// predicate, for example:
837 /// (X & 8) == 8 ---> (X & 8) != 0
838 virtual bool hasAndNotCompare(SDValue Y) const {
839 return false;
840 }
841
842 /// Return true if the target has a bitwise and-not operation:
843 /// X = ~A & B
844 /// This can be used to simplify select or other instructions.
845 virtual bool hasAndNot(SDValue X) const {
846 // If the target has the more complex version of this operation, assume that
847 // it has this operation too.
848 return hasAndNotCompare(X);
849 }
850
851 /// Return true if the target has a bit-test instruction:
852 /// (X & (1 << Y)) ==/!= 0
853 /// This knowledge can be used to prevent breaking the pattern,
854 /// or creating it if it could be recognized.
855 virtual bool hasBitTest(SDValue X, SDValue Y) const { return false; }
856
857 /// There are two ways to clear extreme bits (either low or high):
858 /// Mask: x & (-1 << y) (the instcombine canonical form)
859 /// Shifts: x >> y << y
860 /// Return true if the variant with 2 variable shifts is preferred.
861 /// Return false if there is no preference.
863 // By default, let's assume that no one prefers shifts.
864 return false;
865 }
866
867 /// Return true if it is profitable to fold a pair of shifts into a mask.
868 /// This is usually true on most targets. But some targets, like Thumb1,
869 /// have immediate shift instructions, but no immediate "and" instruction;
870 /// this makes the fold unprofitable.
871 virtual bool shouldFoldConstantShiftPairToMask(const SDNode *N) const {
872 return true;
873 }
874
875 /// Should we tranform the IR-optimal check for whether given truncation
876 /// down into KeptBits would be truncating or not:
877 /// (add %x, (1 << (KeptBits-1))) srccond (1 << KeptBits)
878 /// Into it's more traditional form:
879 /// ((%x << C) a>> C) dstcond %x
880 /// Return true if we should transform.
881 /// Return false if there is no preference.
883 unsigned KeptBits) const {
884 // By default, let's assume that no one prefers shifts.
885 return false;
886 }
887
888 /// Given the pattern
889 /// (X & (C l>>/<< Y)) ==/!= 0
890 /// return true if it should be transformed into:
891 /// ((X <</l>> Y) & C) ==/!= 0
892 /// WARNING: if 'X' is a constant, the fold may deadlock!
893 /// FIXME: we could avoid passing XC, but we can't use isConstOrConstSplat()
894 /// here because it can end up being not linked in.
897 unsigned OldShiftOpcode, unsigned NewShiftOpcode,
898 SelectionDAG &DAG) const {
899 if (hasBitTest(X, Y)) {
900 // One interesting pattern that we'd want to form is 'bit test':
901 // ((1 << Y) & C) ==/!= 0
902 // But we also need to be careful not to try to reverse that fold.
903
904 // Is this '1 << Y' ?
905 if (OldShiftOpcode == ISD::SHL && CC->isOne())
906 return false; // Keep the 'bit test' pattern.
907
908 // Will it be '1 << Y' after the transform ?
909 if (XC && NewShiftOpcode == ISD::SHL && XC->isOne())
910 return true; // Do form the 'bit test' pattern.
911 }
912
913 // If 'X' is a constant, and we transform, then we will immediately
914 // try to undo the fold, thus causing endless combine loop.
915 // So by default, let's assume everyone prefers the fold
916 // iff 'X' is not a constant.
917 return !XC;
918 }
919
920 // Return true if its desirable to perform the following transform:
921 // (fmul C, (uitofp Pow2))
922 // -> (bitcast_to_FP (add (bitcast_to_INT C), Log2(Pow2) << mantissa))
923 // (fdiv C, (uitofp Pow2))
924 // -> (bitcast_to_FP (sub (bitcast_to_INT C), Log2(Pow2) << mantissa))
925 //
926 // This is only queried after we have verified the transform will be bitwise
927 // equals.
928 //
929 // SDNode *N : The FDiv/FMul node we want to transform.
930 // SDValue FPConst: The Float constant operand in `N`.
931 // SDValue IntPow2: The Integer power of 2 operand in `N`.
933 SDValue IntPow2) const {
934 // Default to avoiding fdiv which is often very expensive.
935 return N->getOpcode() == ISD::FDIV;
936 }
937
938 // Given:
939 // (icmp eq/ne (and X, C0), (shift X, C1))
940 // or
941 // (icmp eq/ne X, (rotate X, C1))
942
943 // If C0 is a mask or shifted mask and the shift amt (C1) isolates the
944 // remaining bits (i.e something like `(x64 & UINT32_MAX) == (x64 >> 32)`)
945 // Do we prefer the shift to be shift-right, shift-left, or rotate.
946 // Note: It's only valid to convert between the rotate and shift versions iff
947 // the shift-amt (`C1`) divides the bit width.
948 // If ShiftOpc (current Opcode) is returned, do nothing.
950 EVT VT, unsigned ShiftOpc, bool MayTransformRotate,
951 const APInt &ShiftOrRotateAmt,
952 const std::optional<APInt> &AndMask) const {
953 return ShiftOpc;
954 }
955
956 /// These two forms are equivalent:
957 /// sub %y, (xor %x, -1)
958 /// add (add %x, 1), %y
959 /// The variant with two add's is IR-canonical.
960 /// Some targets may prefer one to the other.
961 virtual bool preferIncOfAddToSubOfNot(EVT VT) const {
962 // By default, let's assume that everyone prefers the form with two add's.
963 return true;
964 }
965
966 // By default prefer folding (abs (sub nsw x, y)) -> abds(x, y). Some targets
967 // may want to avoid this to prevent loss of sub_nsw pattern.
968 virtual bool preferABDSToABSWithNSW(EVT VT) const {
969 return true;
970 }
971
972 // Return true if the target wants to transform Op(Splat(X)) -> Splat(Op(X))
973 virtual bool preferScalarizeSplat(SDNode *N) const { return true; }
974
975 // Return true if the target wants to transform:
976 // (TruncVT truncate(sext_in_reg(VT X, ExtVT))
977 // -> (TruncVT sext_in_reg(truncate(VT X), ExtVT))
978 // Some targets might prefer pre-sextinreg to improve truncation/saturation.
979 virtual bool preferSextInRegOfTruncate(EVT TruncVT, EVT VT, EVT ExtVT) const {
980 return true;
981 }
982
983 /// Return true if the target wants to use the optimization that
984 /// turns ext(promotableInst1(...(promotableInstN(load)))) into
985 /// promotedInst1(...(promotedInstN(ext(load)))).
987
988 /// Return true if the target can combine store(extractelement VectorTy,
989 /// Idx).
990 /// \p Cost[out] gives the cost of that transformation when this is true.
991 virtual bool canCombineStoreAndExtract(Type *VectorTy, Value *Idx,
992 unsigned &Cost) const {
993 return false;
994 }
995
996 /// Return true if the target shall perform extract vector element and store
997 /// given that the vector is known to be splat of constant.
998 /// \p Index[out] gives the index of the vector element to be extracted when
999 /// this is true.
1001 Type *VectorTy, unsigned ElemSizeInBits, unsigned &Index) const {
1002 return false;
1003 }
1004
1005 /// Return true if inserting a scalar into a variable element of an undef
1006 /// vector is more efficiently handled by splatting the scalar instead.
1007 virtual bool shouldSplatInsEltVarIndex(EVT) const {
1008 return false;
1009 }
1010
1011 /// Return true if target always benefits from combining into FMA for a
1012 /// given value type. This must typically return false on targets where FMA
1013 /// takes more cycles to execute than FADD.
1014 virtual bool enableAggressiveFMAFusion(EVT VT) const { return false; }
1015
1016 /// Return true if target always benefits from combining into FMA for a
1017 /// given value type. This must typically return false on targets where FMA
1018 /// takes more cycles to execute than FADD.
1019 virtual bool enableAggressiveFMAFusion(LLT Ty) const { return false; }
1020
1021 /// Return the ValueType of the result of SETCC operations.
1022 virtual EVT getSetCCResultType(const DataLayout &DL, LLVMContext &Context,
1023 EVT VT) const;
1024
1025 /// Return the integer type returned by comparison libcalls. Comparison
1026 /// libcalls include floating point comparison calls, and Ordered/Unordered
1027 /// check calls on floating point numbers.
1029 return Type::getInt32Ty(Ctx);
1030 }
1031
1032 /// For targets without i1 registers, this gives the nature of the high-bits
1033 /// of boolean values held in types wider than i1.
1034 ///
1035 /// "Boolean values" are special true/false values produced by nodes like
1036 /// SETCC and consumed (as the condition) by nodes like SELECT and BRCOND.
1037 /// Not to be confused with general values promoted from i1. Some cpus
1038 /// distinguish between vectors of boolean and scalars; the isVec parameter
1039 /// selects between the two kinds. For example on X86 a scalar boolean should
1040 /// be zero extended from i1, while the elements of a vector of booleans
1041 /// should be sign extended from i1.
1042 ///
1043 /// Some cpus also treat floating point types the same way as they treat
1044 /// vectors instead of the way they treat scalars.
1045 BooleanContent getBooleanContents(bool isVec, bool isFloat) const {
1046 if (isVec)
1047 return BooleanVectorContents;
1048 return isFloat ? BooleanFloatContents : BooleanContents;
1049 }
1050
1052 return getBooleanContents(Type.isVector(), Type.isFloatingPoint());
1053 }
1054
1055 /// Promote the given target boolean to a target boolean of the given type.
1056 /// A target boolean is an integer value, not necessarily of type i1, the bits
1057 /// of which conform to getBooleanContents.
1058 ///
1059 /// ValVT is the type of values that produced the boolean.
1061 EVT ValVT) const {
1062 SDLoc dl(Bool);
1063 EVT BoolVT =
1064 getSetCCResultType(DAG.getDataLayout(), *DAG.getContext(), ValVT);
1066 return DAG.getNode(ExtendCode, dl, BoolVT, Bool);
1067 }
1068
1069 /// Return target scheduling preference.
1071 return SchedPreferenceInfo;
1072 }
1073
1074 /// Some scheduler, e.g. hybrid, can switch to different scheduling heuristics
1075 /// for different nodes. This function returns the preference (or none) for
1076 /// the given node.
1078 return Sched::None;
1079 }
1080
1081 /// Return the register class that should be used for the specified value
1082 /// type.
1083 virtual const TargetRegisterClass *getRegClassFor(MVT VT, bool isDivergent = false) const {
1084 (void)isDivergent;
1085 const TargetRegisterClass *RC = RegClassForVT[VT.SimpleTy];
1086 assert(RC && "This value type is not natively supported!");
1087 return RC;
1088 }
1089
1090 /// Allows target to decide about the register class of the
1091 /// specific value that is live outside the defining block.
1092 /// Returns true if the value needs uniform register class.
1094 const Value *) const {
1095 return false;
1096 }
1097
1098 /// Return the 'representative' register class for the specified value
1099 /// type.
1100 ///
1101 /// The 'representative' register class is the largest legal super-reg
1102 /// register class for the register class of the value type. For example, on
1103 /// i386 the rep register class for i8, i16, and i32 are GR32; while the rep
1104 /// register class is GR64 on x86_64.
1105 virtual const TargetRegisterClass *getRepRegClassFor(MVT VT) const {
1106 const TargetRegisterClass *RC = RepRegClassForVT[VT.SimpleTy];
1107 return RC;
1108 }
1109
1110 /// Return the cost of the 'representative' register class for the specified
1111 /// value type.
1113 return RepRegClassCostForVT[VT.SimpleTy];
1114 }
1115
1116 /// Return the preferred strategy to legalize tihs SHIFT instruction, with
1117 /// \p ExpansionFactor being the recursion depth - how many expansion needed.
1123 virtual ShiftLegalizationStrategy
1125 unsigned ExpansionFactor) const {
1126 if (ExpansionFactor == 1)
1129 }
1130
1131 /// Return true if the target has native support for the specified value type.
1132 /// This means that it has a register that directly holds it without
1133 /// promotions or expansions.
1134 bool isTypeLegal(EVT VT) const {
1135 assert(!VT.isSimple() ||
1136 (unsigned)VT.getSimpleVT().SimpleTy < std::size(RegClassForVT));
1137 return VT.isSimple() && RegClassForVT[VT.getSimpleVT().SimpleTy] != nullptr;
1138 }
1139
1141 /// ValueTypeActions - For each value type, keep a LegalizeTypeAction enum
1142 /// that indicates how instruction selection should deal with the type.
1143 LegalizeTypeAction ValueTypeActions[MVT::VALUETYPE_SIZE];
1144
1145 public:
1146 ValueTypeActionImpl() { llvm::fill(ValueTypeActions, TypeLegal); }
1147
1149 return ValueTypeActions[VT.SimpleTy];
1150 }
1151
1153 ValueTypeActions[VT.SimpleTy] = Action;
1154 }
1155 };
1156
1158 return ValueTypeActions;
1159 }
1160
1161 /// Return pair that represents the legalization kind (first) that needs to
1162 /// happen to EVT (second) in order to type-legalize it.
1163 ///
1164 /// First: how we should legalize values of this type, either it is already
1165 /// legal (return 'Legal') or we need to promote it to a larger type (return
1166 /// 'Promote'), or we need to expand it into multiple registers of smaller
1167 /// integer type (return 'Expand'). 'Custom' is not an option.
1168 ///
1169 /// Second: for types supported by the target, this is an identity function.
1170 /// For types that must be promoted to larger types, this returns the larger
1171 /// type to promote to. For integer types that are larger than the largest
1172 /// integer register, this contains one step in the expansion to get to the
1173 /// smaller register. For illegal floating point types, this returns the
1174 /// integer type to transform to.
1175 LegalizeKind getTypeConversion(LLVMContext &Context, EVT VT) const;
1176
1177 /// Return how we should legalize values of this type, either it is already
1178 /// legal (return 'Legal') or we need to promote it to a larger type (return
1179 /// 'Promote'), or we need to expand it into multiple registers of smaller
1180 /// integer type (return 'Expand'). 'Custom' is not an option.
1182 return getTypeConversion(Context, VT).first;
1183 }
1185 return ValueTypeActions.getTypeAction(VT);
1186 }
1187
1188 /// For types supported by the target, this is an identity function. For
1189 /// types that must be promoted to larger types, this returns the larger type
1190 /// to promote to. For integer types that are larger than the largest integer
1191 /// register, this contains one step in the expansion to get to the smaller
1192 /// register. For illegal floating point types, this returns the integer type
1193 /// to transform to.
1194 virtual EVT getTypeToTransformTo(LLVMContext &Context, EVT VT) const {
1195 return getTypeConversion(Context, VT).second;
1196 }
1197
1198 /// Perform getTypeToTransformTo repeatedly until a legal type is obtained.
1199 /// Useful for vector operations that might take multiple steps to legalize.
1201 EVT LegalVT = getTypeToTransformTo(Context, VT);
1202 while (LegalVT != VT) {
1203 VT = LegalVT;
1204 LegalVT = getTypeToTransformTo(Context, VT);
1205 }
1206 return LegalVT;
1207 }
1208
1209 /// For types supported by the target, this is an identity function. For
1210 /// types that must be expanded (i.e. integer types that are larger than the
1211 /// largest integer register or illegal floating point types), this returns
1212 /// the largest legal type it will be expanded to.
1213 EVT getTypeToExpandTo(LLVMContext &Context, EVT VT) const {
1214 assert(!VT.isVector());
1215 while (true) {
1216 switch (getTypeAction(Context, VT)) {
1217 case TypeLegal:
1218 return VT;
1219 case TypeExpandInteger:
1220 VT = getTypeToTransformTo(Context, VT);
1221 break;
1222 default:
1223 llvm_unreachable("Type is not legal nor is it to be expanded!");
1224 }
1225 }
1226 }
1227
1228 /// For vector types that are widened, this returns the type reached by
1229 /// widening repeatedly, i.e. the first type whose action is not
1230 /// TypeWidenVector. Unlike getLegalTypeToTransformTo, this does not follow
1231 /// other actions, so the result may still be illegal (e.g. if it is split).
1232 /// For vector types that are not widened, this is an identity function.
1233 EVT getTypeToWidenTo(LLVMContext &Context, EVT VT) const {
1234 assert(VT.isVector());
1235 while (getTypeAction(Context, VT) == TypeWidenVector)
1236 VT = getTypeToTransformTo(Context, VT);
1237 return VT;
1238 }
1239
1240 /// Vector types are broken down into some number of legal first class types.
1241 /// For example, EVT::v8f32 maps to 2 EVT::v4f32 with Altivec or SSE1, or 8
1242 /// promoted EVT::f64 values with the X86 FP stack. Similarly, EVT::v2i64
1243 /// turns into 4 EVT::i32 values with both PPC and X86.
1244 ///
1245 /// This method returns the number of registers needed, and the VT for each
1246 /// register. It also returns the VT and quantity of the intermediate values
1247 /// before they are promoted/expanded.
1249 EVT &IntermediateVT,
1250 unsigned &NumIntermediates,
1251 MVT &RegisterVT) const {
1252 return getVectorTypeBreakdownImpl(Context, VT, IntermediateVT,
1253 NumIntermediates, RegisterVT,
1254 /*ForCallingConv=*/false);
1255 }
1256
1257 /// Return true if fixed-length, non-power-of-two vectors should be broken
1258 /// down into legal vector parts instead of scalars for internal values.
1260 return false;
1261 }
1262
1263 bool shouldUseDynamicVectorTypeBreakdown(EVT VT, bool ForCallingConv) const {
1264 return preferVectorizedNonPowerOfTwoTypeBreakdown() && !ForCallingConv &&
1265 VT.isFixedLengthVector() &&
1267 }
1268
1269 /// Certain targets such as MIPS require that some types such as vectors are
1270 /// always broken down into scalars in some contexts. This occurs even if the
1271 /// vector type is legal.
1273 LLVMContext &Context, CallingConv::ID CC, EVT VT, EVT &IntermediateVT,
1274 unsigned &NumIntermediates, MVT &RegisterVT) const {
1275 return getVectorTypeBreakdownImpl(Context, VT, IntermediateVT,
1276 NumIntermediates, RegisterVT,
1277 /*ForCallingConv=*/true);
1278 }
1279
1281 unsigned opc = 0; // target opcode
1282 EVT memVT; // memory VT
1283
1284 // value representing memory location
1286
1287 // Fallback address space for use if ptrVal is nullptr. std::nullopt means
1288 // unknown address space.
1289 std::optional<unsigned> fallbackAddressSpace;
1290
1291 int offset = 0; // offset off of ptrVal
1292 uint64_t size = 0; // the size of the memory location
1293 // (taken from memVT if zero)
1294 MaybeAlign align = Align(1); // alignment
1295
1300 IntrinsicInfo() = default;
1301 };
1302
1303 /// Given an intrinsic, checks if on the target the intrinsic will need to map
1304 /// to a MemIntrinsicNode (touches memory). If this is the case, it stores
1305 /// the intrinsic information into the IntrinsicInfo vector passed to the
1306 /// function. The vector may contain multiple entries for intrinsics that
1307 /// access multiple memory locations.
1309 const CallBase &I, MachineFunction &MF,
1310 unsigned Intrinsic) const {}
1311
1312 /// How the legalizer should materialize a floating-point immediate.
1313 enum class FPImmAction {
1314 /// The target can instruction select the immediate natively.
1316 /// Build the immediate as a bitcast of an integer constant with the same
1317 /// bits.
1319 /// Load the immediate from the constant pool.
1321 };
1322
1323 /// Returns how the legalizer should materialize the specified FP immediate.
1324 virtual FPImmAction getFPImmAction(const APFloat & /*Imm*/, EVT /*VT*/,
1325 bool ForCodeSize = false) const {
1327 }
1328
1329 /// \copydoc getFPImmAction(const APFloat&,EVT,bool) const
1330 virtual FPImmAction getFPImmAction(const APFloat & /*Imm*/, LLT /*Ty*/,
1331 bool ForCodeSize = false) const {
1333 }
1334
1335 /// Returns true if the specified FP immediate can be materialized without a
1336 /// load from the constant pool.
1337 bool isFPImmLegal(const APFloat &Imm, EVT VT,
1338 bool ForCodeSize = false) const {
1339 return getFPImmAction(Imm, VT, ForCodeSize) != FPImmAction::ConstantPool;
1340 }
1341
1342 /// Targets can use this to indicate that they only support *some*
1343 /// VECTOR_SHUFFLE operations, those with specific masks. By default, if a
1344 /// target supports the VECTOR_SHUFFLE node, all mask values are assumed to be
1345 /// legal.
1346 virtual bool isShuffleMaskLegal(ArrayRef<int> /*Mask*/, EVT /*VT*/) const {
1347 return true;
1348 }
1349
1350 /// Returns true if the operation can trap for the value type.
1351 ///
1352 /// VT must be a legal type. By default, we optimistically assume most
1353 /// operations don't trap except for integer divide and remainder.
1354 virtual bool canOpTrap(unsigned Op, EVT VT) const;
1355
1356 /// Similar to isShuffleMaskLegal. Targets can use this to indicate if there
1357 /// is a suitable VECTOR_SHUFFLE that can be used to replace a VAND with a
1358 /// constant pool entry.
1360 EVT /*VT*/) const {
1361 return false;
1362 }
1363
1364 /// How to legalize this custom operation?
1366 return Legal;
1367 }
1368
1369 /// Return how this operation should be treated: either it is legal, needs to
1370 /// be promoted to a larger size, needs to be expanded to some other code
1371 /// sequence, or the target has a custom expander for it.
1373 // If a target-specific SDNode requires legalization, require the target
1374 // to provide custom legalization for it.
1375 if (Op >= std::size(OpActions[0]))
1376 return Custom;
1377 if (VT.isExtended())
1378 return Expand;
1379 return OpActions[(unsigned)VT.getSimpleVT().SimpleTy][Op];
1380 }
1381
1382 /// Custom method defined by each target to indicate if an operation which
1383 /// may require a scale is supported natively by the target.
1384 /// If not, the operation is illegal.
1385 virtual bool isSupportedFixedPointOperation(unsigned Op, EVT VT,
1386 unsigned Scale) const {
1387 return false;
1388 }
1389
1390 /// Some fixed point operations may be natively supported by the target but
1391 /// only for specific scales. This method allows for checking
1392 /// if the width is supported by the target for a given operation that may
1393 /// depend on scale.
1395 unsigned Scale) const {
1396 auto Action = getOperationAction(Op, VT);
1397 if (Action != Legal)
1398 return Action;
1399
1400 // This operation is supported in this type but may only work on specific
1401 // scales.
1402 bool Supported;
1403 switch (Op) {
1404 default:
1405 llvm_unreachable("Unexpected fixed point operation.");
1406 case ISD::SMULFIX:
1407 case ISD::SMULFIXSAT:
1408 case ISD::UMULFIX:
1409 case ISD::UMULFIXSAT:
1410 case ISD::SDIVFIX:
1411 case ISD::SDIVFIXSAT:
1412 case ISD::UDIVFIX:
1413 case ISD::UDIVFIXSAT:
1414 Supported = isSupportedFixedPointOperation(Op, VT, Scale);
1415 break;
1416 }
1417
1418 return Supported ? Action : Expand;
1419 }
1420
1421 // If Op is a strict floating-point operation, return the result
1422 // of getOperationAction for the equivalent non-strict operation.
1424 unsigned EqOpc;
1425 switch (Op) {
1426 default: llvm_unreachable("Unexpected FP pseudo-opcode");
1427#define DAG_INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC, DAGN) \
1428 case ISD::STRICT_##DAGN: EqOpc = ISD::DAGN; break;
1429#define CMP_INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC, DAGN) \
1430 case ISD::STRICT_##DAGN: EqOpc = ISD::SETCC; break;
1431#include "llvm/IR/ConstrainedOps.def"
1432 }
1433
1434 return getOperationAction(EqOpc, VT);
1435 }
1436
1437 /// Return true if the specified operation is legal on this target or can be
1438 /// made legal with custom lowering. This is used to help guide high-level
1439 /// lowering decisions. LegalOnly is an optional convenience for code paths
1440 /// traversed pre and post legalisation.
1442 bool LegalOnly = false) const {
1443 if (LegalOnly)
1444 return isOperationLegal(Op, VT);
1445
1446 return (VT == MVT::Other || isTypeLegal(VT)) &&
1447 (getOperationAction(Op, VT) == Legal ||
1448 getOperationAction(Op, VT) == Custom);
1449 }
1450
1451 /// Return true if the specified operation is legal on this target or can be
1452 /// made legal using promotion. This is used to help guide high-level lowering
1453 /// decisions. LegalOnly is an optional convenience for code paths traversed
1454 /// pre and post legalisation.
1456 bool LegalOnly = false) const {
1457 if (LegalOnly)
1458 return isOperationLegal(Op, VT);
1459
1460 return (VT == MVT::Other || isTypeLegal(VT)) &&
1461 (getOperationAction(Op, VT) == Legal ||
1462 getOperationAction(Op, VT) == Promote);
1463 }
1464
1465 /// Return true if the specified operation is legal on this target or can be
1466 /// made legal with custom lowering or using promotion. This is used to help
1467 /// guide high-level lowering decisions. LegalOnly is an optional convenience
1468 /// for code paths traversed pre and post legalisation.
1470 bool LegalOnly = false) const {
1471 if (LegalOnly)
1472 return isOperationLegal(Op, VT);
1473
1474 return (VT == MVT::Other || isTypeLegal(VT)) &&
1475 (getOperationAction(Op, VT) == Legal ||
1476 getOperationAction(Op, VT) == Custom ||
1477 getOperationAction(Op, VT) == Promote);
1478 }
1479
1480 /// Return true if the operation uses custom lowering, regardless of whether
1481 /// the type is legal or not.
1482 bool isOperationCustom(unsigned Op, EVT VT) const {
1483 return getOperationAction(Op, VT) == Custom;
1484 }
1485
1486 /// Return true if lowering to a jump table is allowed.
1487 virtual bool areJTsAllowed(const Function *Fn) const {
1488 if (Fn->getFnAttribute("no-jump-tables").getValueAsBool())
1489 return false;
1490
1491 return isOperationLegalOrCustom(ISD::BR_JT, MVT::Other) ||
1493 }
1494
1495 /// Check whether the range [Low,High] fits in a machine word.
1496 bool rangeFitsInWord(const APInt &Low, const APInt &High,
1497 const DataLayout &DL) const {
1498 // FIXME: Using the pointer type doesn't seem ideal.
1499 uint64_t BW = DL.getIndexSizeInBits(0u);
1500 uint64_t Range = (High - Low).getLimitedValue(UINT64_MAX - 1) + 1;
1501 return Range <= BW;
1502 }
1503
1504 /// Return true if lowering to a jump table is suitable for a set of case
1505 /// clusters which may contain \p NumCases cases, \p Range range of values.
1506 virtual bool isSuitableForJumpTable(const SwitchInst *SI, uint64_t NumCases,
1508 BlockFrequencyInfo *BFI) const;
1509
1510 /// Returns preferred type for switch condition.
1511 virtual MVT getPreferredSwitchConditionType(LLVMContext &Context,
1512 EVT ConditionVT) const;
1513
1514 /// Return true if lowering to a bit test is suitable for a set of case
1515 /// clusters which contains \p NumDests unique destinations, \p Low and
1516 /// \p High as its lowest and highest case values, and expects \p NumCmps
1517 /// case value comparisons. Check if the number of destinations, comparison
1518 /// metric, and range are all suitable.
1521 const APInt &Low, const APInt &High, const DataLayout &DL) const {
1522 // FIXME: I don't think NumCmps is the correct metric: a single case and a
1523 // range of cases both require only one branch to lower. Just looking at the
1524 // number of clusters and destinations should be enough to decide whether to
1525 // build bit tests.
1526
1527 // To lower a range with bit tests, the range must fit the bitwidth of a
1528 // machine word.
1529 if (!rangeFitsInWord(Low, High, DL))
1530 return false;
1531
1532 unsigned NumDests = DestCmps.size();
1533 unsigned NumCmps = 0;
1534 unsigned int MaxBitTestEntry = 0;
1535 for (auto &DestCmp : DestCmps) {
1536 NumCmps += DestCmp.second;
1537 if (DestCmp.second > MaxBitTestEntry)
1538 MaxBitTestEntry = DestCmp.second;
1539 }
1540
1541 // Comparisons might be cheaper for small number of comparisons, which can
1542 // be Arch Target specific.
1543 if (MaxBitTestEntry < getMinimumBitTestCmps())
1544 return false;
1545
1546 // Decide whether it's profitable to lower this range with bit tests. Each
1547 // destination requires a bit test and branch, and there is an overall range
1548 // check branch. For a small number of clusters, separate comparisons might
1549 // be cheaper, and for many destinations, splitting the range might be
1550 // better.
1551 return (NumDests == 1 && NumCmps >= 3) || (NumDests == 2 && NumCmps >= 5) ||
1552 (NumDests == 3 && NumCmps >= 6);
1553 }
1554
1555 /// Return true if the specified operation is illegal on this target or
1556 /// unlikely to be made legal with custom lowering. This is used to help guide
1557 /// high-level lowering decisions.
1558 bool isOperationExpand(unsigned Op, EVT VT) const {
1559 return (!isTypeLegal(VT) || getOperationAction(Op, VT) == Expand);
1560 }
1561
1562 /// Return true if the specified operation is legal on this target.
1563 bool isOperationLegal(unsigned Op, EVT VT) const {
1564 return (VT == MVT::Other || isTypeLegal(VT)) &&
1565 getOperationAction(Op, VT) == Legal;
1566 }
1567
1568 bool isOperationExpandOrLibCall(unsigned Op, EVT VT) const {
1569 return isOperationExpand(Op, VT) || getOperationAction(Op, VT) == LibCall;
1570 }
1571
1572 /// Returns an alternative action to use when the coarser lookups (configured
1573 /// through `setLoadExtAction` and `setAtomicLoadExtAction`) yield
1574 /// `LegalizeAction::Custom`. Allows targets to use builtin behaviors (e.g.
1575 /// Legal, Promote) specialized by Alignment and AddrSpace, rather than just
1576 /// types.
1577 virtual LegalizeAction
1578 getCustomLoadAction(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace,
1579 unsigned ExtType, bool Atomic) const {
1581 }
1582
1583 /// Return how this load with extension should be treated: either it is legal,
1584 /// needs to be promoted to a larger size, needs to be expanded to some other
1585 /// code sequence, or the target has a custom expander for it.
1586 LegalizeAction getLoadAction(EVT ValVT, EVT MemVT, Align Alignment,
1587 unsigned AddrSpace, unsigned ExtType,
1588 bool Atomic) const {
1589 if (ValVT.isExtended() || MemVT.isExtended())
1590 return Expand;
1591 unsigned ValI = (unsigned)ValVT.getSimpleVT().SimpleTy;
1592 unsigned MemI = (unsigned)MemVT.getSimpleVT().SimpleTy;
1594 MemI < MVT::VALUETYPE_SIZE && "Table isn't big enough!");
1595 unsigned Shift = 4 * ExtType;
1596
1597 LegalizeAction Action;
1598 if (Atomic) {
1599 Action =
1600 (LegalizeAction)((AtomicLoadExtActions[ValI][MemI] >> Shift) & 0xf);
1601 assert((Action == Legal || Action == Expand) &&
1602 "Unsupported atomic load extension action.");
1603 } else {
1604 Action = (LegalizeAction)((LoadExtActions[ValI][MemI] >> Shift) & 0xf);
1605 }
1606
1607 if (Action == LegalizeAction::Custom) {
1608 return getCustomLoadAction(ValVT, MemVT, Alignment, AddrSpace, ExtType,
1609 Atomic);
1610 }
1611
1612 return Action;
1613 }
1614
1615 /// Return true if the specified load with extension is legal on this target.
1616 bool isLoadLegal(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace,
1617 unsigned ExtType, bool Atomic) const {
1618 return getLoadAction(ValVT, MemVT, Alignment, AddrSpace, ExtType, Atomic) ==
1619 Legal;
1620 }
1621
1622 /// Return true if the specified load with extension is legal or custom
1623 /// on this target.
1624 bool isLoadLegalOrCustom(EVT ValVT, EVT MemVT, Align Alignment,
1625 unsigned AddrSpace, unsigned ExtType,
1626 bool Atomic) const {
1627 LegalizeAction Action =
1628 getLoadAction(ValVT, MemVT, Alignment, AddrSpace, ExtType, Atomic);
1629 return Action == Legal || Action == Custom;
1630 }
1631
1632 /// Returns an alternative action to use when the coarser lookups (configured
1633 /// through `setTruncStoreAction` yield
1634 /// `LegalizeAction::Custom`. Allows targets to use builtin behaviors (e.g.
1635 /// Legal, Promote) specialized by Alignment and AddrSpace, rather than just
1636 /// types.
1638 Align Alignment,
1639 unsigned AddrSpace) const {
1641 }
1642
1643 /// Return how this store with truncation should be treated: either it is
1644 /// legal, needs to be promoted to a larger size, needs to be expanded to some
1645 /// other code sequence, or the target has a custom expander for it.
1647 unsigned AddrSpace) const {
1648 if (ValVT.isExtended() || MemVT.isExtended())
1649 return Expand;
1650 unsigned ValI = (unsigned)ValVT.getSimpleVT().SimpleTy;
1651 unsigned MemI = (unsigned)MemVT.getSimpleVT().SimpleTy;
1653 "Table isn't big enough!");
1654
1655 LegalizeAction Action = TruncStoreActions[ValI][MemI];
1656
1657 if (Action == LegalizeAction::Custom) {
1658 return getCustomTruncStoreAction(ValVT, MemVT, Alignment, AddrSpace);
1659 }
1660
1661 return Action;
1662 }
1663
1664 /// Return true if the specified store with truncation is legal on this
1665 /// target.
1666 bool isTruncStoreLegal(EVT ValVT, EVT MemVT, Align Alignment,
1667 unsigned AddrSpace) const {
1668 return isTypeLegal(ValVT) &&
1669 getTruncStoreAction(ValVT, MemVT, Alignment, AddrSpace) == Legal;
1670 }
1671
1672 /// Return true if the specified store with truncation has solution on this
1673 /// target.
1674 bool isTruncStoreLegalOrCustom(EVT ValVT, EVT MemVT, Align Alignment,
1675 unsigned AddrSpace) const {
1676 if (!isTypeLegal(ValVT))
1677 return false;
1678
1679 LegalizeAction Action =
1680 getTruncStoreAction(ValVT, MemVT, Alignment, AddrSpace);
1681 return (Action == Legal || Action == Custom);
1682 }
1683
1684 virtual bool canCombineTruncStore(EVT ValVT, EVT MemVT, Align Alignment,
1685 unsigned AddrSpace, bool LegalOnly) const {
1686 if (LegalOnly)
1687 return isTruncStoreLegal(ValVT, MemVT, Alignment, AddrSpace);
1688
1689 return isTruncStoreLegalOrCustom(ValVT, MemVT, Alignment, AddrSpace);
1690 }
1691
1692 /// Return how the indexed load should be treated: either it is legal, needs
1693 /// to be promoted to a larger size, needs to be expanded to some other code
1694 /// sequence, or the target has a custom expander for it.
1695 LegalizeAction getIndexedLoadAction(unsigned IdxMode, MVT VT) const {
1696 return getIndexedModeAction(IdxMode, VT, IMAB_Load);
1697 }
1698
1699 /// Return true if the specified indexed load is legal on this target.
1700 bool isIndexedLoadLegal(unsigned IdxMode, EVT VT) const {
1701 return VT.isSimple() &&
1702 (getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Legal ||
1703 getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Custom);
1704 }
1705
1706 /// Return how the indexed store should be treated: either it is legal, needs
1707 /// to be promoted to a larger size, needs to be expanded to some other code
1708 /// sequence, or the target has a custom expander for it.
1709 LegalizeAction getIndexedStoreAction(unsigned IdxMode, MVT VT) const {
1710 return getIndexedModeAction(IdxMode, VT, IMAB_Store);
1711 }
1712
1713 /// Return true if the specified indexed load is legal on this target.
1714 bool isIndexedStoreLegal(unsigned IdxMode, EVT VT) const {
1715 return VT.isSimple() &&
1716 (getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Legal ||
1717 getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Custom);
1718 }
1719
1720 /// Return how the indexed load should be treated: either it is legal, needs
1721 /// to be promoted to a larger size, needs to be expanded to some other code
1722 /// sequence, or the target has a custom expander for it.
1723 LegalizeAction getIndexedMaskedLoadAction(unsigned IdxMode, MVT VT) const {
1724 return getIndexedModeAction(IdxMode, VT, IMAB_MaskedLoad);
1725 }
1726
1727 /// Return true if the specified indexed load is legal on this target.
1728 bool isIndexedMaskedLoadLegal(unsigned IdxMode, EVT VT) const {
1729 return VT.isSimple() &&
1730 (getIndexedMaskedLoadAction(IdxMode, VT.getSimpleVT()) == Legal ||
1732 }
1733
1734 /// Return how the indexed store should be treated: either it is legal, needs
1735 /// to be promoted to a larger size, needs to be expanded to some other code
1736 /// sequence, or the target has a custom expander for it.
1737 LegalizeAction getIndexedMaskedStoreAction(unsigned IdxMode, MVT VT) const {
1738 return getIndexedModeAction(IdxMode, VT, IMAB_MaskedStore);
1739 }
1740
1741 /// Return true if the specified indexed load is legal on this target.
1742 bool isIndexedMaskedStoreLegal(unsigned IdxMode, EVT VT) const {
1743 return VT.isSimple() &&
1744 (getIndexedMaskedStoreAction(IdxMode, VT.getSimpleVT()) == Legal ||
1746 }
1747
1748 /// Returns true if the index type for a masked gather/scatter requires
1749 /// extending
1750 virtual bool shouldExtendGSIndex(EVT VT, EVT &EltTy) const { return false; }
1751
1752 // Returns true if Extend can be folded into the index of a masked gathers/scatters
1753 // on this target.
1754 virtual bool shouldRemoveExtendFromGSIndex(SDValue Extend, EVT DataVT) const {
1755 return false;
1756 }
1757
1758 // Return true if the target supports a scatter/gather instruction with
1759 // indices which are scaled by the particular value. Note that all targets
1760 // must by definition support scale of 1.
1762 uint64_t ElemSize) const {
1763 // MGATHER/MSCATTER are only required to support scaling by one or by the
1764 // element size.
1765 if (Scale != ElemSize && Scale != 1)
1766 return false;
1767 return true;
1768 }
1769
1770 /// Return how the condition code should be treated: either it is legal, needs
1771 /// to be expanded to some other code sequence, or the target has a custom
1772 /// expander for it.
1775 assert((unsigned)CC < std::size(CondCodeActions) &&
1776 ((unsigned)VT.SimpleTy >> 3) < std::size(CondCodeActions[0]) &&
1777 "Table isn't big enough!");
1778 // See setCondCodeAction for how this is encoded.
1779 uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
1780 uint32_t Value = CondCodeActions[CC][VT.SimpleTy >> 3];
1781 LegalizeAction Action = (LegalizeAction) ((Value >> Shift) & 0xF);
1782 assert(Action != Promote && "Can't promote condition code!");
1783 return Action;
1784 }
1785
1786 /// Return true if the specified condition code is legal for a comparison of
1787 /// the specified types on this target.
1789 return getCondCodeAction(CC, VT) == Legal;
1790 }
1791
1792 /// Return true if the specified condition code is legal or custom for a
1793 /// comparison of the specified types on this target.
1795 return getCondCodeAction(CC, VT) == Legal ||
1796 getCondCodeAction(CC, VT) == Custom;
1797 }
1798
1799 /// Return how a PARTIAL_REDUCE_U/SMLA node with Acc type AccVT and Input type
1800 /// InputVT should be treated. Either it's legal, needs to be promoted to a
1801 /// larger size, needs to be expanded to some other code sequence, or the
1802 /// target has a custom expander for it.
1804 EVT InputVT) const {
1807 // If the inputs aren't simple (e.g. non-power-of-two element type), just
1808 // expand.
1809 if (!AccVT.isSimple() || !InputVT.isSimple())
1810 return Expand;
1811 PartialReduceActionTypes Key = {Opc, AccVT.getSimpleVT().SimpleTy,
1812 InputVT.getSimpleVT().SimpleTy};
1813 auto It = PartialReduceMLAActions.find(Key);
1814 return It != PartialReduceMLAActions.end() ? It->second : Expand;
1815 }
1816
1817 /// Return true if a PARTIAL_REDUCE_U/SMLA node with the specified types is
1818 /// legal or custom for this target.
1820 EVT InputVT) const {
1821 LegalizeAction Action = getPartialReduceMLAAction(Opc, AccVT, InputVT);
1822 return Action == Legal || Action == Custom;
1823 }
1824
1825 /// Return how a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the
1826 /// given interleave factor and VT should be handled.
1828 EVT VT) const {
1830 VectorInterleaveActionKey Key = {Opc, Factor, VT.getSimpleVT().SimpleTy};
1831 auto It = VectorInterleaveActions.find(Key);
1832 return It != VectorInterleaveActions.end() ? It->second : Expand;
1833 }
1834
1835 /// Return true if a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the
1836 /// given interleave factor and fragment type is legal or custom.
1837 bool isVectorInterleaveLegalOrCustom(unsigned Opc, unsigned Factor,
1838 EVT VT) const {
1839 LegalizeAction Action = getVectorInterleaveAction(Opc, Factor, VT);
1840 return Action == Legal || Action == Custom;
1841 }
1842
1843 /// If the action for this operation is to promote, this method returns the
1844 /// ValueType to promote to.
1845 MVT getTypeToPromoteTo(unsigned Op, MVT VT) const {
1847 "This operation isn't promoted!");
1848
1849 // See if this has an explicit type specified.
1850 std::map<std::pair<unsigned, MVT::SimpleValueType>,
1852 PromoteToType.find(std::make_pair(Op, VT.SimpleTy));
1853 if (PTTI != PromoteToType.end()) return PTTI->second;
1854
1855 assert((VT.isInteger() || VT.isFloatingPoint()) &&
1856 "Cannot autopromote this type, add it with AddPromotedToType.");
1857
1858 uint64_t VTBits = VT.getScalarSizeInBits();
1859 MVT NVT = VT;
1860 do {
1861 NVT = (MVT::SimpleValueType)(NVT.SimpleTy+1);
1862 assert(NVT.isInteger() == VT.isInteger() &&
1863 NVT.isFloatingPoint() == VT.isFloatingPoint() &&
1864 "Didn't find type to promote to!");
1865 } while (VTBits >= NVT.getScalarSizeInBits() || !isTypeLegal(NVT) ||
1866 getOperationAction(Op, NVT) == Promote);
1867 return NVT;
1868 }
1869
1871 bool AllowUnknown = false) const {
1872 return getValueType(DL, Ty, AllowUnknown);
1873 }
1874
1875 /// Return the EVT corresponding to this LLVM type. This is fixed by the LLVM
1876 /// operations except for the pointer size. If AllowUnknown is true, this
1877 /// will return MVT::Other for types with no EVT counterpart (e.g. structs),
1878 /// otherwise it will assert.
1880 bool AllowUnknown = false) const {
1881 // Lower scalar pointers to native pointer types.
1882 if (auto *PTy = dyn_cast<PointerType>(Ty))
1883 return getPointerTy(DL, PTy->getAddressSpace());
1884
1885 if (auto *VTy = dyn_cast<VectorType>(Ty)) {
1886 Type *EltTy = VTy->getElementType();
1887 // Lower vectors of pointers to native pointer types.
1888 EVT EltVT;
1889 if (auto *PTy = dyn_cast<PointerType>(EltTy))
1890 EltVT = getPointerTy(DL, PTy->getAddressSpace());
1891 else
1892 EltVT = EVT::getEVT(EltTy, false);
1893 return EVT::getVectorVT(Ty->getContext(), EltVT, VTy->getElementCount());
1894 }
1895
1896 return EVT::getEVT(Ty, AllowUnknown);
1897 }
1898
1900 bool AllowUnknown = false) const {
1901 // Lower scalar pointers to native pointer types.
1902 if (auto *PTy = dyn_cast<PointerType>(Ty))
1903 return getPointerMemTy(DL, PTy->getAddressSpace());
1904
1905 if (auto *VTy = dyn_cast<VectorType>(Ty)) {
1906 Type *EltTy = VTy->getElementType();
1907 EVT EltVT;
1908 if (auto *PTy = dyn_cast<PointerType>(EltTy))
1909 EltVT = getPointerMemTy(DL, PTy->getAddressSpace());
1910 else
1911 EltVT = EVT::getEVT(EltTy, false);
1912 return EVT::getVectorVT(Ty->getContext(), EltVT, VTy->getElementCount());
1913 }
1914
1915 return getValueType(DL, Ty, AllowUnknown);
1916 }
1917
1918
1919 /// Return the MVT corresponding to this LLVM type. See getValueType.
1921 bool AllowUnknown = false) const {
1922 return getValueType(DL, Ty, AllowUnknown).getSimpleVT();
1923 }
1924
1925 /// Returns the desired alignment for ByVal or InAlloca aggregate function
1926 /// arguments in the caller parameter area.
1927 virtual Align getByValTypeAlignment(Type *Ty, const DataLayout &DL) const;
1928
1929 /// Return the type of registers that this ValueType will eventually require.
1930 MVT getRegisterType(LLVMContext &Context, EVT VT) const {
1931 return getRegisterTypeImpl(Context, VT, /*ForCallingConv=*/false);
1932 }
1933
1934 /// Return the number of registers that this ValueType will eventually
1935 /// require.
1936 ///
1937 /// This is one for any types promoted to live in larger registers, but may be
1938 /// more than one for types (like i64) that are split into pieces. For types
1939 /// like i140, which are first promoted then expanded, it is the number of
1940 /// registers needed to hold all the bits of the original type. For an i140
1941 /// on a 32 bit machine this means 5 registers.
1942 ///
1943 /// RegisterVT may be passed as a way to override the default settings, for
1944 /// instance with i128 inline assembly operands on SystemZ.
1945 virtual unsigned
1947 std::optional<MVT> RegisterVT = std::nullopt) const {
1948 return getNumRegistersImpl(Context, VT, /*ForCallingConv=*/false);
1949 }
1950
1951 /// Certain combinations of ABIs, Targets and features require that types
1952 /// are legal for some operations and not for other operations.
1953 /// For MIPS all vector types must be passed through the integer register set.
1955 CallingConv::ID CC, EVT VT) const {
1956 return getRegisterTypeImpl(Context, VT, /*ForCallingConv=*/true);
1957 }
1958
1959 /// Certain targets require unusual breakdowns of certain types. For MIPS,
1960 /// this occurs when a vector type is used, as vector are passed through the
1961 /// integer register set.
1964 EVT VT) const {
1965 return getNumRegistersImpl(Context, VT, /*ForCallingConv=*/true);
1966 }
1967
1968 /// Certain targets have context sensitive alignment requirements, where one
1969 /// type has the alignment requirement of another type.
1971 const DataLayout &DL) const {
1972 return DL.getABITypeAlign(ArgTy);
1973 }
1974
1975 /// If true, then instruction selection should seek to shrink the FP constant
1976 /// of the specified type to a smaller type in order to save space and / or
1977 /// reduce runtime.
1978 virtual bool ShouldShrinkFPConstant(EVT) const { return true; }
1979
1980 /// Return true if it is profitable to reduce a load to a smaller type.
1981 /// \p ByteOffset is only set if we know the pointer offset at compile time
1982 /// otherwise we should assume that additional pointer math is required.
1983 /// Example: (i16 (trunc (i32 (load x))) -> i16 load x
1984 /// Example: (i16 (trunc (srl (i32 (load x)), 16)) -> i16 load x+2
1986 SDNode *Load, ISD::LoadExtType ExtTy, EVT NewVT,
1987 std::optional<unsigned> ByteOffset = std::nullopt) const {
1988 // By default, assume that it is cheaper to extract a subvector from a wide
1989 // vector load rather than creating multiple narrow vector loads.
1990 if (NewVT.isVector() && !SDValue(Load, 0).hasOneUse())
1991 return false;
1992
1993 return true;
1994 }
1995
1996 /// Return true (the default) if it is profitable to remove a sext_inreg(x)
1997 /// where the sext is redundant, and use x directly.
1998 virtual bool shouldRemoveRedundantExtend(SDValue Op) const { return true; }
1999
2000 /// Indicates if any padding is guaranteed to go at the most significant bits
2001 /// when storing the type to memory and the type size isn't equal to the store
2002 /// size.
2004 return VT.isScalarInteger() && !VT.isByteSized();
2005 }
2006
2007 /// When splitting a value of the specified type into parts, does the Lo
2008 /// or Hi part come first? This usually follows the endianness, except
2009 /// for ppcf128, where the Hi part always comes first.
2011 return DL.isBigEndian() || VT == MVT::ppcf128;
2012 }
2013
2014 /// If true, the target has custom DAG combine transformations that it can
2015 /// perform for the specified node.
2017 assert(unsigned(NT >> 3) < std::size(TargetDAGCombineArray));
2018 return TargetDAGCombineArray[NT >> 3] & (1 << (NT&7));
2019 }
2020
2023 }
2024
2025 /// Returns the size of the platform's va_list object.
2026 virtual unsigned getVaListSizeInBits(const DataLayout &DL) const {
2027 return getPointerTy(DL).getSizeInBits();
2028 }
2029
2030 /// Get maximum # of store operations permitted for llvm.memset
2031 ///
2032 /// This function returns the maximum number of store operations permitted
2033 /// to replace a call to llvm.memset. The value is set by the target at the
2034 /// performance threshold for such a replacement. If OptSize is true,
2035 /// return the limit for functions that have OptSize attribute.
2036 unsigned getMaxStoresPerMemset(bool OptSize) const;
2037
2038 /// Get maximum # of store operations permitted for llvm.memcpy
2039 ///
2040 /// This function returns the maximum number of store operations permitted
2041 /// to replace a call to llvm.memcpy. The value is set by the target at the
2042 /// performance threshold for such a replacement. If OptSize is true,
2043 /// return the limit for functions that have OptSize attribute.
2044 unsigned getMaxStoresPerMemcpy(bool OptSize) const;
2045
2046 /// \brief Get maximum # of store operations to be glued together
2047 ///
2048 /// This function returns the maximum number of store operations permitted
2049 /// to glue together during lowering of llvm.memcpy. The value is set by
2050 // the target at the performance threshold for such a replacement.
2051 virtual unsigned getMaxGluedStoresPerMemcpy() const {
2053 }
2054
2055 /// Get maximum # of load operations permitted for memcmp
2056 ///
2057 /// This function returns the maximum number of load operations permitted
2058 /// to replace a call to memcmp. The value is set by the target at the
2059 /// performance threshold for such a replacement. If OptSize is true,
2060 /// return the limit for functions that have OptSize attribute.
2061 unsigned getMaxExpandSizeMemcmp(bool OptSize) const {
2063 }
2064
2065 /// Get maximum # of store operations permitted for llvm.memmove
2066 ///
2067 /// This function returns the maximum number of store operations permitted
2068 /// to replace a call to llvm.memmove. The value is set by the target at the
2069 /// performance threshold for such a replacement. If OptSize is true,
2070 /// return the limit for functions that have OptSize attribute.
2071 unsigned getMaxStoresPerMemmove(bool OptSize) const;
2072
2073 /// Determine if the target supports unaligned memory accesses.
2074 ///
2075 /// This function returns true if the target allows unaligned memory accesses
2076 /// of the specified type in the given address space. If true, it also returns
2077 /// a relative speed of the unaligned memory access in the last argument by
2078 /// reference. The higher the speed number the faster the operation comparing
2079 /// to a number returned by another such call. This is used, for example, in
2080 /// situations where an array copy/move/set is converted to a sequence of
2081 /// store operations. Its use helps to ensure that such replacements don't
2082 /// generate code that causes an alignment error (trap) on the target machine.
2084 EVT, unsigned AddrSpace = 0, Align Alignment = Align(1),
2086 unsigned * /*Fast*/ = nullptr) const {
2087 return false;
2088 }
2089
2090 /// LLT handling variant.
2092 LLT, unsigned AddrSpace = 0, Align Alignment = Align(1),
2094 unsigned * /*Fast*/ = nullptr) const {
2095 return false;
2096 }
2097
2098 /// This function returns true if the memory access is aligned or if the
2099 /// target allows this specific unaligned memory access. If the access is
2100 /// allowed, the optional final parameter returns a relative speed of the
2101 /// access (as defined by the target).
2102 bool allowsMemoryAccessForAlignment(
2103 LLVMContext &Context, const DataLayout &DL, EVT VT,
2104 unsigned AddrSpace = 0, Align Alignment = Align(1),
2106 unsigned *Fast = nullptr) const;
2107
2108 /// Return true if the memory access of this type is aligned or if the target
2109 /// allows this specific unaligned access for the given MachineMemOperand.
2110 /// If the access is allowed, the optional final parameter returns a relative
2111 /// speed of the access (as defined by the target).
2112 bool allowsMemoryAccessForAlignment(LLVMContext &Context,
2113 const DataLayout &DL, EVT VT,
2114 const MachineMemOperand &MMO,
2115 unsigned *Fast = nullptr) const;
2116
2117 /// Return true if the target supports a memory access of this type for the
2118 /// given address space and alignment. If the access is allowed, the optional
2119 /// final parameter returns the relative speed of the access (as defined by
2120 /// the target).
2121 virtual bool
2122 allowsMemoryAccess(LLVMContext &Context, const DataLayout &DL, EVT VT,
2123 unsigned AddrSpace = 0, Align Alignment = Align(1),
2125 unsigned *Fast = nullptr) const;
2126
2127 /// Return true if the target supports a memory access of this type for the
2128 /// given MachineMemOperand. If the access is allowed, the optional
2129 /// final parameter returns the relative access speed (as defined by the
2130 /// target).
2131 bool allowsMemoryAccess(LLVMContext &Context, const DataLayout &DL, EVT VT,
2132 const MachineMemOperand &MMO,
2133 unsigned *Fast = nullptr) const;
2134
2135 /// LLT handling variant.
2136 bool allowsMemoryAccess(LLVMContext &Context, const DataLayout &DL, LLT Ty,
2137 const MachineMemOperand &MMO,
2138 unsigned *Fast = nullptr) const;
2139
2140 /// Returns the target specific optimal type for load and store operations as
2141 /// a result of memset, memcpy, and memmove lowering.
2142 /// It returns EVT::Other if the type should be determined using generic
2143 /// target-independent logic.
2144 virtual EVT
2146 const AttributeList & /*FuncAttributes*/) const {
2147 return MVT::Other;
2148 }
2149
2150 /// LLT returning variant.
2151 virtual LLT
2153 const AttributeList & /*FuncAttributes*/) const {
2154 return LLT();
2155 }
2156
2157 /// Returns true if it's safe to use load / store of the specified type to
2158 /// expand memcpy / memset inline.
2159 ///
2160 /// This is mostly true for all types except for some special cases. For
2161 /// example, on X86 targets without SSE2 f64 load / store are done with fldl /
2162 /// fstpl which also does type conversion. Note the specified type doesn't
2163 /// have to be legal as the hook is used before type legalization.
2164 virtual bool isSafeMemOpType(MVT /*VT*/) const { return true; }
2165
2166 /// Return lower limit for number of blocks in a jump table.
2167 virtual unsigned getMinimumJumpTableEntries() const;
2168
2169 /// Return lower limit of the density in a jump table.
2170 unsigned getMinimumJumpTableDensity(bool OptForSize) const;
2171
2172 /// Return upper limit for number of entries in a jump table.
2173 /// Zero if no limit.
2174 unsigned getMaximumJumpTableSize() const;
2175
2176 virtual bool isJumpTableRelative() const;
2177
2178 /// Retuen the minimum of largest number of comparisons in BitTest.
2179 unsigned getMinimumBitTestCmps() const;
2180
2181 /// Return maximum known-legal store size, which can be guaranteed for
2182 /// scalable vectors.
2184 return MaximumLegalStoreInBits;
2185 }
2186
2187 /// If a physical register, this specifies the register that
2188 /// llvm.savestack/llvm.restorestack should save and restore.
2190 return StackPointerRegisterToSaveRestore;
2191 }
2192
2193 /// If a physical register, this returns the register that receives the
2194 /// exception address on entry to an EH pad.
2195 virtual Register
2197 const Constant *PersonalityFn) const {
2198 return Register();
2199 }
2200
2201 /// If a physical register, this returns the register that receives the
2202 /// exception typeid on entry to a landing pad.
2203 virtual Register
2205 const Constant *PersonalityFn) const {
2206 return Register();
2207 }
2208
2209 virtual bool needsFixedCatchObjects() const {
2210 reportFatalUsageError("Funclet EH is not implemented for this target");
2211 }
2212
2213 /// Return the minimum stack alignment of an argument.
2215 return MinStackArgumentAlignment;
2216 }
2217
2218 /// Return the minimum function alignment.
2219 Align getMinFunctionAlignment() const { return MinFunctionAlignment; }
2220
2221 /// Return the preferred function alignment.
2222 Align getPrefFunctionAlignment() const { return PrefFunctionAlignment; }
2223
2224 /// Return the preferred loop alignment. \p BlockToAlign, when non-null, is
2225 /// the block that will actually be aligned; after loop rotation this need not
2226 /// be the LoopInfo header. Targets whose alignment depends on the block
2227 /// contents should use it. Callers that are not aligning a particular block,
2228 /// such as llvm-exegesis and ARM constant islands, leave it null.
2229 virtual Align
2230 getPrefLoopAlignment(MachineLoop *ML = nullptr,
2231 const MachineBasicBlock *BlockToAlign = nullptr) const;
2232
2233 /// Return the maximum amount of bytes allowed to be emitted when padding for
2234 /// alignment
2235 virtual unsigned
2236 getMaxPermittedBytesForAlignment(MachineBasicBlock *MBB) const;
2237
2238 /// Should loops be aligned even when the function is marked OptSize (but not
2239 /// MinSize).
2240 virtual bool alignLoopsWithOptSize() const { return false; }
2241
2242 /// If the target has a standard location for the stack protector guard,
2243 /// returns the address of that location. Otherwise, returns nullptr.
2244 /// DEPRECATED: please override useLoadStackGuardNode and customize
2245 /// LOAD_STACK_GUARD, or customize \@llvm.stackguard().
2246 virtual Value *getIRStackGuard(IRBuilderBase &IRB,
2247 const LibcallLoweringInfo &Libcalls) const;
2248
2249 /// Inserts necessary declarations for SSP (stack protection) purpose.
2250 /// Should be used only when getIRStackGuard returns nullptr.
2251 virtual void insertSSPDeclarations(Module &M,
2252 const LibcallLoweringInfo &Libcalls) const;
2253
2254 /// Return the variable that's previously inserted by insertSSPDeclarations,
2255 /// if any, otherwise return nullptr. Should be used only when
2256 /// getIRStackGuard returns nullptr.
2257 virtual Value *getSDagStackGuard(const Module &M,
2258 const LibcallLoweringInfo &Libcalls) const;
2259
2260 /// If this function returns true, stack protection checks should mix the
2261 /// frame pointer (or whichever pointer is used to address locals) into the
2262 /// stack guard value before checking it. getIRStackGuard must return nullptr
2263 /// if this returns true.
2264 virtual bool useStackGuardMixFP() const { return false; }
2265
2266 /// If the target has a standard stack protection check function that
2267 /// performs validation and error handling, returns the function. Otherwise,
2268 /// returns nullptr. Must be previously inserted by insertSSPDeclarations.
2269 /// Should be used only when getIRStackGuard returns nullptr.
2270 Function *getSSPStackGuardCheck(const Module &M,
2271 const LibcallLoweringInfo &Libcalls) const;
2272
2273protected:
2274 Value *getDefaultSafeStackPointerLocation(IRBuilderBase &IRB,
2275 bool UseTLS) const;
2276
2277public:
2278 /// Returns the target-specific address of the unsafe stack pointer.
2279 virtual Value *
2280 getSafeStackPointerLocation(IRBuilderBase &IRB,
2281 const LibcallLoweringInfo &Libcalls) const;
2282
2283 /// Returns the name of the symbol used to emit stack probes or the empty
2284 /// string if not applicable.
2285 virtual bool hasStackProbeSymbol(const MachineFunction &MF) const { return false; }
2286
2287 virtual bool hasInlineStackProbe(const MachineFunction &MF) const { return false; }
2288
2290 return "";
2291 }
2292
2293 /// Returns true if a cast from SrcAS to DestAS is "cheap", such that e.g. we
2294 /// are happy to sink it into basic blocks. A cast may be free, but not
2295 /// necessarily a no-op. e.g. a free truncate from a 64-bit to 32-bit pointer.
2296 virtual bool isFreeAddrSpaceCast(const DataLayout &DL, unsigned SrcAS,
2297 unsigned DestAS) const;
2298
2299 /// Return true if the pointer arguments to CI should be aligned by aligning
2300 /// the object whose address is being passed. If so then MinSize is set to the
2301 /// minimum size the object must be to be aligned and PrefAlign is set to the
2302 /// preferred alignment.
2303 virtual bool shouldAlignPointerArgs(CallInst * /*CI*/, unsigned & /*MinSize*/,
2304 Align & /*PrefAlign*/) const {
2305 return false;
2306 }
2307
2308 //===--------------------------------------------------------------------===//
2309 /// \name Helpers for TargetTransformInfo implementations
2310 /// @{
2311
2312 /// Get the ISD node that corresponds to the Instruction class opcode.
2313 int InstructionOpcodeToISD(unsigned Opcode) const;
2314
2315 /// Get the ISD node that corresponds to the Intrinsic ID. Returns
2316 /// ISD::DELETED_NODE by default for an unsupported Intrinsic ID.
2317 int IntrinsicIDToISD(Intrinsic::ID ID) const;
2318
2319 /// @}
2320
2321 //===--------------------------------------------------------------------===//
2322 /// \name Helpers for atomic expansion.
2323 /// @{
2324
2325 /// Returns the maximum atomic operation size (in bits) supported by
2326 /// the backend. Atomic operations greater than this size (as well
2327 /// as ones that are not naturally aligned), will be expanded by
2328 /// AtomicExpandPass into an __atomic_* library call.
2330 return MaxAtomicSizeInBitsSupported;
2331 }
2332
2333 /// Returns the size in bits of the maximum div/rem the backend supports.
2334 /// Larger operations will be expanded by ExpandIRInsts.
2336 return MaxDivRemBitWidthSupported;
2337 }
2338
2339 /// Returns the size in bits of the maximum fp to/from int conversion the
2340 /// backend supports. Larger operations will be expanded by ExpandIRInsts.
2342 return MaxLargeFPConvertBitWidthSupported;
2343 }
2344
2345 /// Returns the size of the smallest cmpxchg or ll/sc instruction
2346 /// the backend supports. Any smaller operations are widened in
2347 /// AtomicExpandPass.
2348 ///
2349 /// Note that *unlike* operations above the maximum size, atomic ops
2350 /// are still natively supported below the minimum; they just
2351 /// require a more complex expansion.
2352 unsigned getMinCmpXchgSizeInBits() const { return MinCmpXchgSizeInBits; }
2353
2354 /// Return true if the target supports an atomic access of \p SizeInBytes
2355 /// bytes at the given \p Alignment. The default implementation only allows
2356 /// naturally aligned atomics, unless setSupportsUnalignedAtomics(true) was
2357 /// called.
2358 virtual bool isAtomicAlignmentSupported(Align Alignment,
2359 uint64_t SizeInBytes) const {
2360 return SupportsUnalignedAtomics || Alignment.value() >= SizeInBytes;
2361 }
2362
2363 /// Whether AtomicExpandPass should automatically insert fences and reduce
2364 /// ordering for this atomic. This should be true for most architectures with
2365 /// weak memory ordering. Defaults to false.
2366 virtual bool shouldInsertFencesForAtomic(const Instruction *I) const {
2367 return false;
2368 }
2369
2370 /// Whether a fence between the load-linked and the store-conditional can
2371 /// clear the reservation. If true, AtomicExpandPass places the release fence
2372 /// of a weak cmpxchg before the load-linked. Defaults to false.
2373 virtual bool fenceClearsLoadLinkedReservation() const { return false; }
2374
2375 /// Whether AtomicExpandPass should automatically insert a seq_cst trailing
2376 /// fence without reducing the ordering for this atomic store. Defaults to
2377 /// false.
2378 virtual bool
2380 return false;
2381 }
2382
2383 // The memory ordering that AtomicExpandPass should assign to a atomic
2384 // instruction that it has lowered by adding fences. This can be used
2385 // to "fold" one of the fences into the atomic instruction.
2386 virtual AtomicOrdering
2390
2391 // Whether to issue an atomic load for the initial word value before the
2392 // atomicrmw/cmpxchg emulation loop.
2393 // TODO: For correctness, an atomic load should be issued for all targets.
2394 // Remove this API once this is achieved
2396 return true;
2397 }
2398
2399 /// Perform a load-linked operation on Addr, returning a "Value *" with the
2400 /// corresponding pointee type. This may entail some non-trivial operations to
2401 /// truncate or reconstruct types that will be illegal in the backend. See
2402 /// ARMISelLowering for an example implementation.
2403 virtual Value *emitLoadLinked(IRBuilderBase &Builder, Type *ValueTy,
2404 Value *Addr, AtomicOrdering Ord) const {
2405 llvm_unreachable("Load linked unimplemented on this target");
2406 }
2407
2408 /// Perform a store-conditional operation to Addr. Return the status of the
2409 /// store. This should be 0 if the store succeeded, non-zero otherwise.
2411 Value *Addr, AtomicOrdering Ord) const {
2412 llvm_unreachable("Store conditional unimplemented on this target");
2413 }
2414
2415 /// Perform a masked atomicrmw using a target-specific intrinsic. This
2416 /// represents the core LL/SC loop which will be lowered at a late stage by
2417 /// the backend. The target-specific intrinsic returns the loaded value and
2418 /// is not responsible for masking and shifting the result.
2420 AtomicRMWInst *AI,
2421 Value *AlignedAddr, Value *Incr,
2422 Value *Mask, Value *ShiftAmt,
2423 AtomicOrdering Ord) const {
2424 llvm_unreachable("Masked atomicrmw expansion unimplemented on this target");
2425 }
2426
2427 /// Perform a atomicrmw expansion using a target-specific way. This is
2428 /// expected to be called when masked atomicrmw and bit test atomicrmw don't
2429 /// work, and the target supports another way to lower atomicrmw.
2430 virtual void emitExpandAtomicRMW(AtomicRMWInst *AI) const {
2432 "Generic atomicrmw expansion unimplemented on this target");
2433 }
2434
2435 /// Perform a atomic store using a target-specific way.
2436 virtual void emitExpandAtomicStore(StoreInst *SI) const {
2438 "Generic atomic store expansion unimplemented on this target");
2439 }
2440
2441 /// Perform a atomic load using a target-specific way.
2442 virtual void emitExpandAtomicLoad(LoadInst *LI) const {
2444 "Generic atomic load expansion unimplemented on this target");
2445 }
2446
2447 /// Perform a cmpxchg expansion using a target-specific method.
2449 llvm_unreachable("Generic cmpxchg expansion unimplemented on this target");
2450 }
2451
2452 /// Perform a bit test atomicrmw using a target-specific intrinsic. This
2453 /// represents the combined bit test intrinsic which will be lowered at a late
2454 /// stage by the backend.
2457 "Bit test atomicrmw expansion unimplemented on this target");
2458 }
2459
2460 /// Perform a atomicrmw which the result is only used by comparison, using a
2461 /// target-specific intrinsic. This represents the combined atomic and compare
2462 /// intrinsic which will be lowered at a late stage by the backend.
2465 "Compare arith atomicrmw expansion unimplemented on this target");
2466 }
2467
2468 /// Perform a masked cmpxchg using a target-specific intrinsic. This
2469 /// represents the core LL/SC loop which will be lowered at a late stage by
2470 /// the backend. The target-specific intrinsic returns the loaded value and
2471 /// is not responsible for masking and shifting the result.
2473 IRBuilderBase &Builder, AtomicCmpXchgInst *CI, Value *AlignedAddr,
2474 Value *CmpVal, Value *NewVal, Value *Mask, AtomicOrdering Ord) const {
2475 llvm_unreachable("Masked cmpxchg expansion unimplemented on this target");
2476 }
2477
2478 //===--------------------------------------------------------------------===//
2479 /// \name KCFI check lowering.
2480 /// @{
2481
2484 const TargetInstrInfo *TII) const {
2485 llvm_unreachable("KCFI is not supported on this target");
2486 }
2487
2488 /// @}
2489
2490 //===--------------------------------------------------------------------===//
2491 /// \name Speculative load lowering.
2492 /// @{
2493
2494 /// Emit code to check if a speculative load of the given size from Ptr is
2495 /// safe. Returns a Value* representing the check result (i1), or nullptr
2496 /// to use the default lowering (which returns false). Targets can override
2497 /// to provide their own safety check (e.g., alignment-based page boundary
2498 /// check).
2499 /// \param Builder IRBuilder positioned at the intrinsic call site
2500 /// \param Ptr the pointer operand
2501 /// \param Size the size in bytes (constant or runtime value for scalable)
2503 Value *Size) const {
2504 return nullptr;
2505 }
2506
2507 /// @}
2508
2509 /// Inserts in the IR a target-specific intrinsic specifying a fence.
2510 /// It is called by AtomicExpandPass before expanding an
2511 /// AtomicRMW/AtomicCmpXchg/AtomicStore/AtomicLoad
2512 /// if shouldInsertFencesForAtomic returns true.
2513 ///
2514 /// Inst is the original atomic instruction, prior to other expansions that
2515 /// may be performed.
2516 ///
2517 /// This function should either return a nullptr, or a pointer to an IR-level
2518 /// Instruction*. Even complex fence sequences can be represented by a
2519 /// single Instruction* through an intrinsic to be lowered later.
2520 ///
2521 /// The default implementation emits an IR fence before any release (or
2522 /// stronger) operation that stores, and after any acquire (or stronger)
2523 /// operation. This is generally a correct implementation, but backends may
2524 /// override if they wish to use alternative schemes (e.g. the PowerPC
2525 /// standard ABI uses a fence before a seq_cst load instead of after a
2526 /// seq_cst store).
2527 /// @{
2528 virtual Instruction *emitLeadingFence(IRBuilderBase &Builder,
2529 Instruction *Inst,
2530 AtomicOrdering Ord) const;
2531
2532 virtual Instruction *emitTrailingFence(IRBuilderBase &Builder,
2533 Instruction *Inst,
2534 AtomicOrdering Ord) const;
2535 /// @}
2536
2537 // Emits code that executes when the comparison result in the ll/sc
2538 // expansion of a cmpxchg instruction is such that the store-conditional will
2539 // not execute. This makes it possible to balance out the load-linked with
2540 // a dedicated instruction, if desired.
2541 // E.g., on ARM, if ldrex isn't followed by strex, the exclusive monitor would
2542 // be unnecessarily held, except if clrex, inserted by this hook, is executed.
2543 virtual void emitAtomicCmpXchgNoStoreLLBalance(IRBuilderBase &Builder) const {}
2544
2545 /// Returns true if arguments should be sign-extended in lib calls.
2546 virtual bool shouldSignExtendTypeInLibCall(Type *Ty, bool IsSigned) const {
2547 return IsSigned;
2548 }
2549
2550 /// Returns true if arguments should be extended in lib calls.
2551 virtual bool shouldExtendTypeInLibCall(EVT Type) const {
2552 return true;
2553 }
2554
2555 /// Returns how the given (atomic) load should be expanded by the
2556 /// IR-level AtomicExpand pass.
2560
2561 /// Returns how the given (atomic) load should be cast by the IR-level
2562 /// AtomicExpand pass.
2568
2569 /// Returns how the given (atomic) store should be expanded by the IR-level
2570 /// AtomicExpand pass into. For instance AtomicExpansionKind::CustomExpand
2571 /// will try to use an atomicrmw xchg.
2575
2576 /// Returns how the given (atomic) store should be cast by the IR-level
2577 /// AtomicExpand pass into. For instance AtomicExpansionKind::CastToInteger
2578 /// will try to cast the operands to integer values.
2580 if (SI->getValueOperand()->getType()->isFloatingPointTy())
2583 }
2584
2585 /// Returns how the given atomic cmpxchg should be expanded by the IR-level
2586 /// AtomicExpand pass.
2587 virtual AtomicExpansionKind
2591
2592 /// Returns how the IR-level AtomicExpand pass should expand the given
2593 /// AtomicRMW, if at all. By default, elementwise operations are expanded and
2594 /// floating-point operations use are expanded to a compare-exchange loop.
2595 virtual AtomicExpansionKind
2597 if (RMW->isElementwise())
2599 if (RMW->isFloatingPointOperation())
2601 if (RMW->getType()->isVectorTy())
2604 }
2605
2606 /// Returns how the given atomic atomicrmw should be cast by the IR-level
2607 /// AtomicExpand pass.
2608 virtual AtomicExpansionKind
2610 Type *ValTy = RMWI->getValOperand()->getType();
2611 if (RMWI->getOperation() == AtomicRMWInst::Xchg &&
2612 (ValTy->isFloatingPointTy() || ValTy->isPointerTy() ||
2613 ValTy->isVectorTy()))
2615
2617 }
2618
2619 /// On some platforms, an AtomicRMW that never actually modifies the value
2620 /// (such as fetch_add of 0) can be turned into a fence followed by an
2621 /// atomic load. This may sound useless, but it makes it possible for the
2622 /// processor to keep the cacheline shared, dramatically improving
2623 /// performance. And such idempotent RMWs are useful for implementing some
2624 /// kinds of locks, see for example (justification + benchmarks):
2625 /// http://www.hpl.hp.com/techreports/2012/HPL-2012-68.pdf
2626 /// This method tries doing that transformation, returning the atomic load if
2627 /// it succeeds, and nullptr otherwise.
2628 /// If shouldExpandAtomicLoadInIR returns true on that load, it will undergo
2629 /// another round of expansion.
2630 virtual LoadInst *
2632 return nullptr;
2633 }
2634
2635 /// Returns how the platform's atomic operations are extended (ZERO_EXTEND,
2636 /// SIGN_EXTEND, or ANY_EXTEND).
2638 return ISD::ZERO_EXTEND;
2639 }
2640
2641 /// Returns how the platform's atomic compare and swap expects its comparison
2642 /// value to be extended (ZERO_EXTEND, SIGN_EXTEND, or ANY_EXTEND). This is
2643 /// separate from getExtendForAtomicOps, which is concerned with the
2644 /// sign-extension of the instruction's output, whereas here we are concerned
2645 /// with the sign-extension of the input. For targets with compare-and-swap
2646 /// instructions (or sub-word comparisons in their LL/SC loop expansions),
2647 /// the input can be ANY_EXTEND, but the output will still have a specific
2648 /// extension.
2650 return ISD::ANY_EXTEND;
2651 }
2652
2653 /// Returns how the platform's atomic rmw operations expect their input
2654 /// argument to be extended (ZERO_EXTEND, SIGN_EXTEND, or ANY_EXTEND).
2656 return ISD::ANY_EXTEND;
2657 }
2658
2659 /// @}
2660
2661 /// Returns true if we should normalize
2662 /// select(N0&N1, X, Y) => select(N0, select(N1, X, Y), Y) and
2663 /// select(N0|N1, X, Y) => select(N0, select(N1, X, Y, Y)) if it is likely
2664 /// that it saves us from materializing N0 and N1 in an integer register.
2665 /// Targets that are able to perform and/or on flags should return false here.
2666 /// \p VT is the type of the select (and X and Y). \p CCVT is the type of its
2667 /// condition (N0 and N1).
2669 EVT CCVT) const {
2670 // If a target has multiple condition registers, then it likely has logical
2671 // operations on those registers.
2673 return false;
2674 // Only do the transform if the value won't be split into multiple
2675 // registers.
2676 LegalizeTypeAction Action = getTypeAction(Context, VT);
2677 return Action != TypeExpandInteger && Action != TypeExpandFloat &&
2678 Action != TypeSplitVector;
2679 }
2680
2681 virtual bool isProfitableToCombineMinNumMaxNum(EVT VT) const { return true; }
2682
2683 /// Return true if a select of constants (select Cond, C1, C2) should be
2684 /// transformed into simple math ops with the condition value. For example:
2685 /// select Cond, C1, C1-1 --> add (zext Cond), C1-1
2686 virtual bool convertSelectOfConstantsToMath(EVT VT) const {
2687 return false;
2688 }
2689
2690 /// Return true if it is profitable to transform an integer
2691 /// multiplication-by-constant into simpler operations like shifts and adds.
2692 /// This may be true if the target does not directly support the
2693 /// multiplication operation for the specified type or the sequence of simpler
2694 /// ops is faster than the multiply.
2696 EVT VT, SDValue C) const {
2697 return false;
2698 }
2699
2700 /// Return true if it may be profitable to transform
2701 /// (mul (add x, c1), c2) -> (add (mul x, c2), c1*c2).
2702 /// This may not be true if c1 and c2 can be represented as immediates but
2703 /// c1*c2 cannot, for example.
2704 /// The target should check if c1, c2 and c1*c2 can be represented as
2705 /// immediates, or have to be materialized into registers. If it is not sure
2706 /// about some cases, a default true can be returned to let the DAGCombiner
2707 /// decide.
2708 /// AddNode is (add x, c1), and ConstNode is c2.
2710 SDValue ConstNode) const {
2711 return true;
2712 }
2713
2714 /// Return true if it is more correct/profitable to use strict FP_TO_INT
2715 /// conversion operations - canonicalizing the FP source value instead of
2716 /// converting all cases and then selecting based on value.
2717 /// This may be true if the target throws exceptions for out of bounds
2718 /// conversions or has fast FP CMOV.
2719 virtual bool shouldUseStrictFP_TO_INT(EVT FpVT, EVT IntVT,
2720 bool IsSigned) const {
2721 return false;
2722 }
2723
2724 /// Return true if it is beneficial to expand an @llvm.powi.* intrinsic.
2725 /// If not optimizing for size, expanding @llvm.powi.* intrinsics is always
2726 /// considered beneficial.
2727 /// If optimizing for size, expansion is only considered beneficial for upto
2728 /// 5 multiplies and a divide (if the exponent is negative).
2729 bool isBeneficialToExpandPowI(int64_t Exponent, bool OptForSize) const {
2730 if (Exponent < 0)
2731 Exponent = -Exponent;
2732 uint64_t E = static_cast<uint64_t>(Exponent);
2733 return !OptForSize || (llvm::popcount(E) + Log2_64(E) < 7);
2734 }
2735
2736 //===--------------------------------------------------------------------===//
2737 // TargetLowering Configuration Methods - These methods should be invoked by
2738 // the derived class constructor to configure this object for the target.
2739 //
2740protected:
2741 /// Specify how the target extends the result of integer and floating point
2742 /// boolean values from i1 to a wider type. See getBooleanContents.
2744 BooleanContents = Ty;
2745 BooleanFloatContents = Ty;
2746 }
2747
2748 /// Specify how the target extends the result of integer and floating point
2749 /// boolean values from i1 to a wider type. See getBooleanContents.
2751 BooleanContents = IntTy;
2752 BooleanFloatContents = FloatTy;
2753 }
2754
2755 /// Specify how the target extends the result of a vector boolean value from a
2756 /// vector of i1 to a wider type. See getBooleanContents.
2758 BooleanVectorContents = Ty;
2759 }
2760
2761 /// Specify the target scheduling preference.
2763 SchedPreferenceInfo = Pref;
2764 }
2765
2766 /// Indicate the minimum number of blocks to generate jump tables.
2767 void setMinimumJumpTableEntries(unsigned Val);
2768
2769 /// Indicate the maximum number of entries in jump tables.
2770 /// Set to zero to generate unlimited jump tables.
2771 void setMaximumJumpTableSize(unsigned);
2772
2773 /// Set the minimum of largest of number of comparisons to generate BitTest.
2774 void setMinimumBitTestCmps(unsigned Val);
2775
2776 /// If set to a physical register, this specifies the register that
2777 /// llvm.savestack/llvm.restorestack should save and restore.
2779 StackPointerRegisterToSaveRestore = R;
2780 }
2781
2782 /// Tells the code generator that the target has BitExtract instructions.
2783 /// The code generator will aggressively sink "shift"s into the blocks of
2784 /// their users if the users will generate "and" instructions which can be
2785 /// combined with "shift" to BitExtract instructions.
2786 void setHasExtractBitsInsn(bool hasExtractInsn = true) {
2787 HasExtractBitsInsn = hasExtractInsn;
2788 }
2789
2790 /// Tells the code generator not to expand logic operations on comparison
2791 /// predicates into separate sequences that increase the amount of flow
2792 /// control.
2793 void setJumpIsExpensive(bool isExpensive = true);
2794
2795 /// Tells the code generator which bitwidths to bypass.
2796 void addBypassSlowDiv(unsigned int SlowBitWidth, unsigned int FastBitWidth) {
2797 BypassSlowDivWidths[SlowBitWidth] = FastBitWidth;
2798 }
2799
2800 /// Add the specified register class as an available regclass for the
2801 /// specified value type. This indicates the selector can handle values of
2802 /// that class natively.
2804 assert((unsigned)VT.SimpleTy < std::size(RegClassForVT));
2805 RegClassForVT[VT.SimpleTy] = RC;
2806 }
2807
2808 /// Return the largest legal super-reg register class of the register class
2809 /// for the specified type and its associated "cost".
2810 virtual std::pair<const TargetRegisterClass *, uint8_t>
2811 findRepresentativeClass(const TargetRegisterInfo *TRI, MVT VT) const;
2812
2813 /// Once all of the register classes are added, this allows us to compute
2814 /// derived properties we expose.
2815 void computeRegisterProperties(const TargetRegisterInfo *TRI);
2816
2817 /// Indicate that the specified operation does not work with the specified
2818 /// type and indicate what to do about it. Note that VT may refer to either
2819 /// the type of a result or that of an operand of Op.
2820 void setOperationAction(unsigned Op, MVT VT, LegalizeAction Action) {
2821 assert(Op < std::size(OpActions[0]) && "Table isn't big enough!");
2822 OpActions[(unsigned)VT.SimpleTy][Op] = Action;
2823 }
2825 LegalizeAction Action) {
2826 for (auto Op : Ops)
2827 setOperationAction(Op, VT, Action);
2828 }
2830 LegalizeAction Action) {
2831 for (auto VT : VTs)
2832 setOperationAction(Ops, VT, Action);
2833 }
2834
2835 /// Indicate that the specified load with extension does not work with the
2836 /// specified type and indicate what to do about it.
2837 void setLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT,
2838 LegalizeAction Action) {
2839 assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValVT.isValid() &&
2840 MemVT.isValid() && "Table isn't big enough!");
2841 assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
2842 unsigned Shift = 4 * ExtType;
2843 LoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] &= ~((uint16_t)0xF << Shift);
2844 LoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] |= (uint16_t)Action << Shift;
2845 }
2846 void setLoadExtAction(ArrayRef<unsigned> ExtTypes, MVT ValVT, MVT MemVT,
2847 LegalizeAction Action) {
2848 for (auto ExtType : ExtTypes)
2849 setLoadExtAction(ExtType, ValVT, MemVT, Action);
2850 }
2852 ArrayRef<MVT> MemVTs, LegalizeAction Action) {
2853 for (auto MemVT : MemVTs)
2854 setLoadExtAction(ExtTypes, ValVT, MemVT, Action);
2855 }
2856
2857 /// Let target indicate that an extending atomic load of the specified type
2858 /// is legal.
2859 void setAtomicLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT,
2860 LegalizeAction Action) {
2861 assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValVT.isValid() &&
2862 MemVT.isValid() && "Table isn't big enough!");
2863 assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
2864 unsigned Shift = 4 * ExtType;
2865 AtomicLoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] &=
2866 ~((uint16_t)0xF << Shift);
2867 AtomicLoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy] |=
2868 ((uint16_t)Action << Shift);
2869 }
2871 LegalizeAction Action) {
2872 for (auto ExtType : ExtTypes)
2873 setAtomicLoadExtAction(ExtType, ValVT, MemVT, Action);
2874 }
2876 ArrayRef<MVT> MemVTs, LegalizeAction Action) {
2877 for (auto MemVT : MemVTs)
2878 setAtomicLoadExtAction(ExtTypes, ValVT, MemVT, Action);
2879 }
2880
2881 /// Indicate that the specified truncating store does not work with the
2882 /// specified type and indicate what to do about it.
2883 void setTruncStoreAction(MVT ValVT, MVT MemVT, LegalizeAction Action) {
2884 assert(ValVT.isValid() && MemVT.isValid() && "Table isn't big enough!");
2885 TruncStoreActions[(unsigned)ValVT.SimpleTy][MemVT.SimpleTy] = Action;
2886 }
2887
2888 /// Indicate that the specified indexed load does or does not work with the
2889 /// specified type and indicate what to do abort it.
2890 ///
2891 /// NOTE: All indexed mode loads are initialized to Expand in
2892 /// TargetLowering.cpp
2894 LegalizeAction Action) {
2895 for (auto IdxMode : IdxModes)
2896 setIndexedModeAction(IdxMode, VT, IMAB_Load, Action);
2897 }
2898
2900 LegalizeAction Action) {
2901 for (auto VT : VTs)
2902 setIndexedLoadAction(IdxModes, VT, Action);
2903 }
2904
2905 /// Indicate that the specified indexed store does or does not work with the
2906 /// specified type and indicate what to do about it.
2907 ///
2908 /// NOTE: All indexed mode stores are initialized to Expand in
2909 /// TargetLowering.cpp
2911 LegalizeAction Action) {
2912 for (auto IdxMode : IdxModes)
2913 setIndexedModeAction(IdxMode, VT, IMAB_Store, Action);
2914 }
2915
2917 LegalizeAction Action) {
2918 for (auto VT : VTs)
2919 setIndexedStoreAction(IdxModes, VT, Action);
2920 }
2921
2922 /// Indicate that the specified indexed masked load does or does not work with
2923 /// the specified type and indicate what to do about it.
2924 ///
2925 /// NOTE: All indexed mode masked loads are initialized to Expand in
2926 /// TargetLowering.cpp
2927 void setIndexedMaskedLoadAction(unsigned IdxMode, MVT VT,
2928 LegalizeAction Action) {
2929 setIndexedModeAction(IdxMode, VT, IMAB_MaskedLoad, Action);
2930 }
2931
2932 /// Indicate that the specified indexed masked store does or does not work
2933 /// with the specified type and indicate what to do about it.
2934 ///
2935 /// NOTE: All indexed mode masked stores are initialized to Expand in
2936 /// TargetLowering.cpp
2937 void setIndexedMaskedStoreAction(unsigned IdxMode, MVT VT,
2938 LegalizeAction Action) {
2939 setIndexedModeAction(IdxMode, VT, IMAB_MaskedStore, Action);
2940 }
2941
2942 /// Indicate that the specified condition code is or isn't supported on the
2943 /// target and indicate what to do about it.
2945 LegalizeAction Action) {
2946 for (auto CC : CCs) {
2947 assert(VT.isValid() && (unsigned)CC < std::size(CondCodeActions) &&
2948 "Table isn't big enough!");
2949 assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
2950 /// The lower 3 bits of the SimpleTy index into Nth 4bit set from the
2951 /// 32-bit value and the upper 29 bits index into the second dimension of
2952 /// the array to select what 32-bit value to use.
2953 uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
2954 CondCodeActions[CC][VT.SimpleTy >> 3] &= ~((uint32_t)0xF << Shift);
2955 CondCodeActions[CC][VT.SimpleTy >> 3] |= (uint32_t)Action << Shift;
2956 }
2957 }
2959 LegalizeAction Action) {
2960 for (auto VT : VTs)
2961 setCondCodeAction(CCs, VT, Action);
2962 }
2963
2964 /// Indicate how a PARTIAL_REDUCE_U/SMLA node with Acc type AccVT and Input
2965 /// type InputVT should be treated by the target. Either it's legal, needs to
2966 /// be promoted to a larger size, needs to be expanded to some other code
2967 /// sequence, or the target has a custom expander for it.
2968 void setPartialReduceMLAAction(unsigned Opc, MVT AccVT, MVT InputVT,
2969 LegalizeAction Action) {
2972 assert(AccVT.isValid() && InputVT.isValid() &&
2973 "setPartialReduceMLAAction types aren't valid");
2974 PartialReduceActionTypes Key = {Opc, AccVT.SimpleTy, InputVT.SimpleTy};
2975 PartialReduceMLAActions[Key] = Action;
2976 }
2978 MVT InputVT, LegalizeAction Action) {
2979 for (unsigned Opc : Opcodes)
2980 setPartialReduceMLAAction(Opc, AccVT, InputVT, Action);
2981 }
2982
2983 /// Indicate how a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the
2984 /// given interleave factor Factor and type VT should be treated.
2985 void setVectorInterleaveAction(unsigned Opc, unsigned Factor, MVT VT,
2986 LegalizeAction Action) {
2988 VectorInterleaveActionKey Key = {Opc, Factor, VT.SimpleTy};
2989 VectorInterleaveActions[Key] = Action;
2990 }
2991
2993 ArrayRef<unsigned> Factors, MVT VT,
2994 LegalizeAction Action) {
2995 for (unsigned Opc : Opcodes)
2996 for (unsigned Factor : Factors)
2997 setVectorInterleaveAction(Opc, Factor, VT, Action);
2998 }
2999
3000 /// If Opc/OrigVT is specified as being promoted, the promotion code defaults
3001 /// to trying a larger integer/fp until it can find one that works. If that
3002 /// default is insufficient, this method can be used by the target to override
3003 /// the default.
3004 void AddPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT) {
3005 PromoteToType[std::make_pair(Opc, OrigVT.SimpleTy)] = DestVT.SimpleTy;
3006 }
3007
3008 /// Convenience method to set an operation to Promote and specify the type
3009 /// in a single call.
3010 void setOperationPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT) {
3011 setOperationAction(Opc, OrigVT, Promote);
3012 AddPromotedToType(Opc, OrigVT, DestVT);
3013 }
3015 MVT DestVT) {
3016 for (auto Op : Ops) {
3017 setOperationAction(Op, OrigVT, Promote);
3018 AddPromotedToType(Op, OrigVT, DestVT);
3019 }
3020 }
3021
3022 /// Targets should invoke this method for each target independent node that
3023 /// they want to provide a custom DAG combiner for by implementing the
3024 /// PerformDAGCombine virtual method.
3026 for (auto NT : NTs) {
3027 assert(unsigned(NT >> 3) < std::size(TargetDAGCombineArray));
3028 TargetDAGCombineArray[NT >> 3] |= 1 << (NT & 7);
3029 }
3030 }
3031
3032 /// Set the target's minimum function alignment.
3034 MinFunctionAlignment = Alignment;
3035 }
3036
3037 /// Set the target's preferred function alignment. This should be set if
3038 /// there is a performance benefit to higher-than-minimum alignment
3040 PrefFunctionAlignment = Alignment;
3041 }
3042
3043 /// Set the target's preferred loop alignment. Default alignment is one, it
3044 /// means the target does not care about loop alignment. The target may also
3045 /// override getPrefLoopAlignment to provide per-loop values.
3046 void setPrefLoopAlignment(Align Alignment) { PrefLoopAlignment = Alignment; }
3047 void setMaxBytesForAlignment(unsigned MaxBytes) {
3048 MaxBytesForAlignment = MaxBytes;
3049 }
3050
3051 /// Set the minimum stack alignment of an argument.
3053 MinStackArgumentAlignment = Alignment;
3054 }
3055
3056 /// Set the maximum atomic operation size supported by the
3057 /// backend. Atomic operations greater than this size (as well as
3058 /// ones that are not naturally aligned), will be expanded by
3059 /// AtomicExpandPass into an __atomic_* library call.
3060 void setMaxAtomicSizeInBitsSupported(unsigned SizeInBits) {
3061 MaxAtomicSizeInBitsSupported = SizeInBits;
3062 }
3063
3064 /// Set the size in bits of the maximum div/rem the backend supports.
3065 /// Larger operations will be expanded by ExpandIRInsts.
3066 void setMaxDivRemBitWidthSupported(unsigned SizeInBits) {
3067 MaxDivRemBitWidthSupported = SizeInBits;
3068 }
3069
3070 /// Set the size in bits of the maximum fp to/from int conversion the backend
3071 /// supports. Larger operations will be expanded by ExpandIRInsts.
3072 void setMaxLargeFPConvertBitWidthSupported(unsigned SizeInBits) {
3073 MaxLargeFPConvertBitWidthSupported = SizeInBits;
3074 }
3075
3076 /// Sets the minimum cmpxchg or ll/sc size supported by the backend.
3077 void setMinCmpXchgSizeInBits(unsigned SizeInBits) {
3078 MinCmpXchgSizeInBits = SizeInBits;
3079 }
3080
3081 /// Sets whether unaligned atomic operations are supported.
3082 void setSupportsUnalignedAtomics(bool UnalignedSupported) {
3083 SupportsUnalignedAtomics = UnalignedSupported;
3084 }
3085
3086public:
3087 //===--------------------------------------------------------------------===//
3088 // Addressing mode description hooks (used by LSR etc).
3089 //
3090
3091 /// CodeGenPrepare sinks address calculations into the same BB as Load/Store
3092 /// instructions reading the address. This allows as much computation as
3093 /// possible to be done in the address mode for that operand. This hook lets
3094 /// targets also pass back when this should be done on intrinsics which
3095 /// load/store.
3096 virtual bool getAddrModeArguments(const IntrinsicInst * /*I*/,
3097 SmallVectorImpl<Value *> & /*Ops*/,
3098 Type *& /*AccessTy*/) const {
3099 return false;
3100 }
3101
3102 /// This represents an addressing mode of:
3103 /// BaseGV + BaseOffs + BaseReg + Scale*ScaleReg + ScalableOffset*vscale
3104 /// If BaseGV is null, there is no BaseGV.
3105 /// If BaseOffs is zero, there is no base offset.
3106 /// If HasBaseReg is false, there is no base register.
3107 /// If Scale is zero, there is no ScaleReg. Scale of 1 indicates a reg with
3108 /// no scale.
3109 /// If ScalableOffset is zero, there is no scalable offset.
3110 struct AddrMode {
3112 int64_t BaseOffs = 0;
3113 bool HasBaseReg = false;
3114 int64_t Scale = 0;
3115 int64_t ScalableOffset = 0;
3116 AddrMode() = default;
3117 };
3118
3119 /// Return true if the addressing mode represented by AM is legal for this
3120 /// target, for a load/store of the specified type.
3121 ///
3122 /// The type may be VoidTy, in which case only return true if the addressing
3123 /// mode is legal for a load/store of any legal type. TODO: Handle
3124 /// pre/postinc as well.
3125 ///
3126 /// If the address space cannot be determined, it will be -1.
3127 ///
3128 /// TODO: Remove default argument
3129 virtual bool isLegalAddressingMode(const DataLayout &DL, const AddrMode &AM,
3130 Type *Ty, unsigned AddrSpace,
3131 Instruction *I = nullptr) const;
3132
3133 /// Returns true if the targets addressing mode can target thread local
3134 /// storage (TLS).
3135 virtual bool addressingModeSupportsTLS(const GlobalValue &) const {
3136 return false;
3137 }
3138
3139 /// Return the prefered common base offset.
3140 virtual int64_t getPreferredLargeGEPBaseOffset(int64_t MinOffset,
3141 int64_t MaxOffset) const {
3142 return 0;
3143 }
3144
3145 /// Return true if the specified immediate is legal icmp immediate, that is
3146 /// the target has icmp instructions which can compare a register against the
3147 /// immediate without having to materialize the immediate into a register.
3148 virtual bool isLegalICmpImmediate(int64_t) const {
3149 return true;
3150 }
3151
3152 /// Return true if the specified immediate is legal add immediate, that is the
3153 /// target has add instructions which can add a register with the immediate
3154 /// without having to materialize the immediate into a register.
3155 virtual bool isLegalAddImmediate(int64_t) const {
3156 return true;
3157 }
3158
3159 /// Return true if adding the specified scalable immediate is legal, that is
3160 /// the target has add instructions which can add a register with the
3161 /// immediate (multiplied by vscale) without having to materialize the
3162 /// immediate into a register.
3163 virtual bool isLegalAddScalableImmediate(int64_t) const { return false; }
3164
3165 /// Return true if the specified immediate is legal for the value input of a
3166 /// store instruction.
3167 virtual bool isLegalStoreImmediate(int64_t Value) const {
3168 // Default implementation assumes that at least 0 works since it is likely
3169 // that a zero register exists or a zero immediate is allowed.
3170 return Value == 0;
3171 }
3172
3173 /// Given a shuffle vector SVI representing a vector splat, return a new
3174 /// scalar type of size equal to SVI's scalar type if the new type is more
3175 /// profitable. Returns nullptr otherwise. For example under MVE float splats
3176 /// are converted to integer to prevent the need to move from SPR to GPR
3177 /// registers.
3179 return nullptr;
3180 }
3181
3182 /// Given a set in interconnected phis of type 'From' that are loaded/stored
3183 /// or bitcast to type 'To', return true if the set should be converted to
3184 /// 'To'.
3185 virtual bool shouldConvertPhiType(Type *From, Type *To) const {
3186 return (From->isIntegerTy() || From->isFloatingPointTy()) &&
3187 (To->isIntegerTy() || To->isFloatingPointTy());
3188 }
3189
3190 /// Returns true if the opcode is a commutative binary operation.
3191 virtual bool isCommutativeBinOp(unsigned Opcode) const {
3192 // FIXME: This should get its info from the td file.
3193 switch (Opcode) {
3194 case ISD::ADD:
3195 case ISD::SMIN:
3196 case ISD::SMAX:
3197 case ISD::UMIN:
3198 case ISD::UMAX:
3199 case ISD::MUL:
3200 case ISD::CLMUL:
3201 case ISD::CLMULH:
3202 case ISD::CLMULR:
3203 case ISD::MULHU:
3204 case ISD::MULHS:
3205 case ISD::SMUL_LOHI:
3206 case ISD::UMUL_LOHI:
3207 case ISD::FADD:
3208 case ISD::FMUL:
3209 case ISD::AND:
3210 case ISD::OR:
3211 case ISD::XOR:
3212 case ISD::SADDO:
3213 case ISD::UADDO:
3214 case ISD::ADDC:
3215 case ISD::ADDE:
3216 case ISD::SADDSAT:
3217 case ISD::UADDSAT:
3218 case ISD::FMINNUM:
3219 case ISD::FMAXNUM:
3220 case ISD::FMINNUM_IEEE:
3221 case ISD::FMAXNUM_IEEE:
3222 case ISD::FMINIMUM:
3223 case ISD::FMAXIMUM:
3224 case ISD::FMINIMUMNUM:
3225 case ISD::FMAXIMUMNUM:
3226 case ISD::AVGFLOORS:
3227 case ISD::AVGFLOORU:
3228 case ISD::AVGCEILS:
3229 case ISD::AVGCEILU:
3230 case ISD::ABDS:
3231 case ISD::ABDU:
3232 return true;
3233 default: return false;
3234 }
3235 }
3236
3237 /// Return true if the node is a math/logic binary operator.
3238 virtual bool isBinOp(unsigned Opcode) const {
3239 // A commutative binop must be a binop.
3240 if (isCommutativeBinOp(Opcode))
3241 return true;
3242 // These are non-commutative binops.
3243 switch (Opcode) {
3244 case ISD::SUB:
3245 case ISD::SHL:
3246 case ISD::SRL:
3247 case ISD::SRA:
3248 case ISD::ROTL:
3249 case ISD::ROTR:
3250 case ISD::SDIV:
3251 case ISD::UDIV:
3252 case ISD::SREM:
3253 case ISD::UREM:
3254 case ISD::SSUBSAT:
3255 case ISD::USUBSAT:
3256 case ISD::AVGSUBFLOORS:
3257 case ISD::AVGSUBFLOORU:
3258 case ISD::FSUB:
3259 case ISD::FDIV:
3260 case ISD::FREM:
3261 case ISD::PSEUDO_FMIN:
3262 case ISD::PSEUDO_FMAX:
3263 return true;
3264 default:
3265 return false;
3266 }
3267 }
3268
3269 /// Return true if it's free to truncate a value of type FromTy to type
3270 /// ToTy. e.g. On x86 it's free to truncate a i32 value in register EAX to i16
3271 /// by referencing its sub-register AX.
3272 /// Targets must return false when FromTy <= ToTy.
3273 virtual bool isTruncateFree(Type *FromTy, Type *ToTy) const {
3274 return false;
3275 }
3276
3277 /// Return true if a truncation from FromTy to ToTy is permitted when deciding
3278 /// whether a call is in tail position. Typically this means that both results
3279 /// would be assigned to the same register or stack slot, but it could mean
3280 /// the target performs adequate checks of its own before proceeding with the
3281 /// tail call. Targets must return false when FromTy <= ToTy.
3282 virtual bool allowTruncateForTailCall(Type *FromTy, Type *ToTy) const {
3283 return false;
3284 }
3285
3286 virtual bool isTruncateFree(EVT FromVT, EVT ToVT) const { return false; }
3287 virtual bool isTruncateFree(LLT FromTy, LLT ToTy, LLVMContext &Ctx) const {
3288 return isTruncateFree(getApproximateEVTForLLT(FromTy, Ctx),
3289 getApproximateEVTForLLT(ToTy, Ctx));
3290 }
3291
3292 /// Return true if truncating the specific node Val to type VT2 is free.
3293 virtual bool isTruncateFree(SDValue Val, EVT VT2) const {
3294 // Fallback to type matching.
3295 return isTruncateFree(Val.getValueType(), VT2);
3296 }
3297
3298 virtual bool isProfitableToHoist(Instruction *I) const { return true; }
3299
3300 /// Return true if the extension represented by \p I is free.
3301 /// Unlikely the is[Z|FP]ExtFree family which is based on types,
3302 /// this method can use the context provided by \p I to decide
3303 /// whether or not \p I is free.
3304 /// This method extends the behavior of the is[Z|FP]ExtFree family.
3305 /// In other words, if is[Z|FP]Free returns true, then this method
3306 /// returns true as well. The converse is not true.
3307 /// The target can perform the adequate checks by overriding isExtFreeImpl.
3308 /// \pre \p I must be a sign, zero, or fp extension.
3309 bool isExtFree(const Instruction *I) const {
3310 switch (I->getOpcode()) {
3311 case Instruction::FPExt:
3312 if (isFPExtFree(EVT::getEVT(I->getType()),
3313 EVT::getEVT(I->getOperand(0)->getType())))
3314 return true;
3315 break;
3316 case Instruction::ZExt:
3317 if (isZExtFree(I->getOperand(0)->getType(), I->getType()))
3318 return true;
3319 break;
3320 case Instruction::SExt:
3321 break;
3322 default:
3323 llvm_unreachable("Instruction is not an extension");
3324 }
3325 return isExtFreeImpl(I);
3326 }
3327
3328 /// Return true if \p Load and \p Ext can form an ExtLoad.
3329 /// For example, in AArch64
3330 /// %L = load i8, i8* %ptr
3331 /// %E = zext i8 %L to i32
3332 /// can be lowered into one load instruction
3333 /// ldrb w0, [x0]
3334 bool isExtLoad(const LoadInst *Load, const Instruction *Ext,
3335 const DataLayout &DL) const {
3336 EVT VT = getValueType(DL, Ext->getType());
3337 EVT LoadVT = getValueType(DL, Load->getType());
3338
3339 // If the load has other users and the truncate is not free, the ext
3340 // probably isn't free.
3341 if (!Load->hasOneUse() && (isTypeLegal(LoadVT) || !isTypeLegal(VT)) &&
3342 !isTruncateFree(Ext->getType(), Load->getType()))
3343 return false;
3344
3345 // Check whether the target supports casts folded into loads.
3346 unsigned LType;
3347 if (isa<ZExtInst>(Ext))
3348 LType = ISD::ZEXTLOAD;
3349 else {
3350 assert(isa<SExtInst>(Ext) && "Unexpected ext type!");
3351 LType = ISD::SEXTLOAD;
3352 }
3353
3354 return isLoadLegal(VT, LoadVT, Load->getAlign(),
3355 Load->getPointerAddressSpace(), LType, false);
3356 }
3357
3358 /// Return true if any actual instruction that defines a value of type FromTy
3359 /// implicitly zero-extends the value to ToTy in the result register.
3360 ///
3361 /// The function should return true when it is likely that the truncate can
3362 /// be freely folded with an instruction defining a value of FromTy. If
3363 /// the defining instruction is unknown (because you're looking at a
3364 /// function argument, PHI, etc.) then the target may require an
3365 /// explicit truncate, which is not necessarily free, but this function
3366 /// does not deal with those cases.
3367 /// Targets must return false when FromTy >= ToTy.
3368 virtual bool isZExtFree(Type *FromTy, Type *ToTy) const {
3369 return false;
3370 }
3371
3372 virtual bool isZExtFree(EVT FromTy, EVT ToTy) const { return false; }
3373 virtual bool isZExtFree(LLT FromTy, LLT ToTy, LLVMContext &Ctx) const {
3374 return isZExtFree(getApproximateEVTForLLT(FromTy, Ctx),
3375 getApproximateEVTForLLT(ToTy, Ctx));
3376 }
3377
3378 /// Return true if zero-extending the specific node Val to type VT2 is free
3379 /// (either because it's implicitly zero-extended such as ARM ldrb / ldrh or
3380 /// because it's folded such as X86 zero-extending loads).
3381 virtual bool isZExtFree(SDValue Val, EVT VT2) const {
3382 return isZExtFree(Val.getValueType(), VT2);
3383 }
3384
3385 /// Return true is an anyext is free from FromTy to ToTy. Usually true for
3386 /// scalar types when not trying to pack elements into vector lanes.
3387 virtual bool isAnyExtFree(EVT FromTy, EVT ToTy) const {
3388 return !FromTy.isVector();
3389 }
3390
3391 /// Return true if sign-extension from FromTy to ToTy is cheaper than
3392 /// zero-extension.
3393 virtual bool isSExtCheaperThanZExt(EVT FromTy, EVT ToTy) const {
3394 return false;
3395 }
3396
3397 /// Return true if this constant should be sign extended when promoting to
3398 /// a larger type.
3399 virtual bool signExtendConstant(const ConstantInt *C) const { return false; }
3400
3401 /// Try to optimize extending or truncating conversion instructions (like
3402 /// zext, trunc, fptoui, uitofp) for the target.
3403 virtual bool
3405 const TargetTransformInfo &TTI) const {
3406 return false;
3407 }
3408
3410 return false;
3411 }
3412
3413 /// Return true if the target supplies and combines to a paired load
3414 /// two loaded values of type LoadedType next to each other in memory.
3415 /// RequiredAlignment gives the minimal alignment constraints that must be met
3416 /// to be able to select this paired load.
3417 ///
3418 /// This information is *not* used to generate actual paired loads, but it is
3419 /// used to generate a sequence of loads that is easier to combine into a
3420 /// paired load.
3421 /// For instance, something like this:
3422 /// a = load i64* addr
3423 /// b = trunc i64 a to i32
3424 /// c = lshr i64 a, 32
3425 /// d = trunc i64 c to i32
3426 /// will be optimized into:
3427 /// b = load i32* addr1
3428 /// d = load i32* addr2
3429 /// Where addr1 = addr2 +/- sizeof(i32).
3430 ///
3431 /// In other words, unless the target performs a post-isel load combining,
3432 /// this information should not be provided because it will generate more
3433 /// loads.
3434 virtual bool hasPairedLoad(EVT /*LoadedType*/,
3435 Align & /*RequiredAlignment*/) const {
3436 return false;
3437 }
3438
3439 /// Return true if the target has a vector blend instruction.
3440 virtual bool hasVectorBlend() const { return false; }
3441
3442 /// Get the maximum supported factor for interleaved memory accesses.
3443 /// Default to be the minimum interleave factor: 2.
3444 virtual unsigned getMaxSupportedInterleaveFactor() const { return 2; }
3445
3446 /// Lower an interleaved load to target specific intrinsics. Return
3447 /// true on success.
3448 ///
3449 /// \p Load is the vector load instruction. Can be either a plain load
3450 /// instruction or a vp.load intrinsic.
3451 /// \p Mask is a per-segment (i.e. number of lanes equal to that of one
3452 /// component being interwoven) mask. Can be nullptr, in which case the
3453 /// result is uncondiitional.
3454 /// \p Shuffles is the shufflevector list to DE-interleave the loaded vector.
3455 /// \p Indices is the corresponding indices for each shufflevector.
3456 /// \p Factor is the interleave factor.
3457 /// \p GapMask is a mask with zeros for components / fields that may not be
3458 /// accessed.
3461 ArrayRef<unsigned> Indices, unsigned Factor,
3462 const APInt &GapMask) const {
3463 return false;
3464 }
3465
3466 /// Lower an interleaved store to target specific intrinsics. Return
3467 /// true on success.
3468 ///
3469 /// \p SI is the vector store instruction. Can be either a plain store
3470 /// or a vp.store.
3471 /// \p Mask is a per-segment (i.e. number of lanes equal to that of one
3472 /// component being interwoven) mask. Can be nullptr, in which case the
3473 /// result is unconditional.
3474 /// \p SVI is the shufflevector to RE-interleave the stored vector.
3475 /// \p Factor is the interleave factor.
3476 /// \p GapMask is a mask with zeros for components / fields that may not be
3477 /// accessed.
3479 ShuffleVectorInst *SVI, unsigned Factor,
3480 const APInt &GapMask) const {
3481 return false;
3482 }
3483
3484 /// Lower a deinterleave intrinsic to a target specific load intrinsic.
3485 /// Return true on success. Currently only supports
3486 /// llvm.vector.deinterleave{2,3,5,7}
3487 ///
3488 /// \p Load is the accompanying load instruction. Can be either a plain load
3489 /// instruction or a vp.load intrinsic.
3490 /// \p DI represents the deinterleaveN intrinsic.
3491 /// \p GapMask is a mask with zeros for components / fields that may not be
3492 /// accessed.
3494 IntrinsicInst *DI,
3495 const APInt &GapMask) const {
3496 return false;
3497 }
3498
3499 /// Lower an interleave intrinsic to a target specific store intrinsic.
3500 /// Return true on success. Currently only supports
3501 /// llvm.vector.interleave{2,3,5,7}
3502 ///
3503 /// \p Store is the accompanying store instruction. Can be either a plain
3504 /// store or a vp.store intrinsic.
3505 /// \p Mask is a per-segment (i.e. number of lanes equal to that of one
3506 /// component being interwoven) mask. Can be nullptr, in which case the
3507 /// result is uncondiitional.
3508 /// \p InterleaveValues contains the interleaved values.
3509 virtual bool
3511 ArrayRef<Value *> InterleaveValues) const {
3512 return false;
3513 }
3514
3515 /// Return true if an fpext operation is free (for instance, because
3516 /// single-precision floating-point numbers are implicitly extended to
3517 /// double-precision).
3518 virtual bool isFPExtFree(EVT DestVT, EVT SrcVT) const {
3519 assert(SrcVT.isFloatingPoint() && DestVT.isFloatingPoint() &&
3520 "invalid fpext types");
3521 return false;
3522 }
3523
3524 /// Return true if an fpext operation input to an \p Opcode operation is free
3525 /// (for instance, because half-precision floating-point numbers are
3526 /// implicitly extended to float-precision) for an FMA instruction.
3527 virtual bool isFPExtFoldable(const MachineInstr &MI, unsigned Opcode,
3528 LLT DestTy, LLT SrcTy) const {
3529 return false;
3530 }
3531
3532 /// Return true if an fpext operation input to an \p Opcode operation is free
3533 /// (for instance, because half-precision floating-point numbers are
3534 /// implicitly extended to float-precision) for an FMA instruction.
3535 virtual bool isFPExtFoldable(const SelectionDAG &DAG, unsigned Opcode,
3536 EVT DestVT, EVT SrcVT) const {
3537 assert(DestVT.isFloatingPoint() && SrcVT.isFloatingPoint() &&
3538 "invalid fpext types");
3539 return isFPExtFree(DestVT, SrcVT);
3540 }
3541
3542 /// Return true if folding a vector load into ExtVal (a sign, zero, or any
3543 /// extend node) is profitable.
3544 virtual bool isVectorLoadExtDesirable(SDValue ExtVal) const { return false; }
3545
3546 /// Return true if an fneg operation is free to the point where it is never
3547 /// worthwhile to replace it with a bitwise operation.
3548 virtual bool isFNegFree(EVT VT) const {
3549 assert(VT.isFloatingPoint());
3550 return false;
3551 }
3552
3553 /// Return true if an fabs operation is free to the point where it is never
3554 /// worthwhile to replace it with a bitwise operation.
3555 virtual bool isFAbsFree(EVT VT) const {
3556 assert(VT.isFloatingPoint());
3557 return false;
3558 }
3559
3560 /// Return true if an FMA operation is faster than a pair of fmul and fadd
3561 /// instructions. fmuladd intrinsics will be expanded to FMAs when this method
3562 /// returns true, otherwise fmuladd is expanded to fmul + fadd.
3563 ///
3564 /// NOTE: This may be called before legalization on types for which FMAs are
3565 /// not legal, but should return true if those types will eventually legalize
3566 /// to types that support FMAs. After legalization, it will only be called on
3567 /// types that support FMAs (via Legal or Custom actions)
3568 ///
3569 /// Targets that care about soft float support should return false when soft
3570 /// float code is being generated (i.e. use-soft-float).
3572 EVT) const {
3573 return false;
3574 }
3575
3576 /// Return true if an FMA operation is faster than a pair of fmul and fadd
3577 /// instructions. fmuladd intrinsics will be expanded to FMAs when this method
3578 /// returns true, otherwise fmuladd is expanded to fmul + fadd.
3579 ///
3580 /// NOTE: This may be called before legalization on types for which FMAs are
3581 /// not legal, but should return true if those types will eventually legalize
3582 /// to types that support FMAs. After legalization, it will only be called on
3583 /// types that support FMAs (via Legal or Custom actions)
3585 LLT) const {
3586 return false;
3587 }
3588
3589 /// IR version
3590 virtual bool isFMAFasterThanFMulAndFAdd(const Function &F, Type *) const {
3591 return false;
3592 }
3593
3594 /// Returns true if \p MI can be combined with another instruction to
3595 /// form TargetOpcode::G_FMAD. \p N may be an TargetOpcode::G_FADD,
3596 /// TargetOpcode::G_FSUB, or an TargetOpcode::G_FMUL which will be
3597 /// distributed into an fadd/fsub.
3598 virtual bool isFMADLegal(const MachineInstr &MI, LLT Ty) const {
3599 assert((MI.getOpcode() == TargetOpcode::G_FADD ||
3600 MI.getOpcode() == TargetOpcode::G_FSUB ||
3601 MI.getOpcode() == TargetOpcode::G_FMUL) &&
3602 "unexpected node in FMAD forming combine");
3603 switch (Ty.getScalarSizeInBits()) {
3604 case 16:
3605 return isOperationLegal(TargetOpcode::G_FMAD, MVT::f16);
3606 case 32:
3607 return isOperationLegal(TargetOpcode::G_FMAD, MVT::f32);
3608 case 64:
3609 return isOperationLegal(TargetOpcode::G_FMAD, MVT::f64);
3610 default:
3611 break;
3612 }
3613
3614 return false;
3615 }
3616
3617 /// Returns true if be combined with to form an ISD::FMAD. \p N may be an
3618 /// ISD::FADD, ISD::FSUB, or an ISD::FMUL which will be distributed into an
3619 /// fadd/fsub.
3620 virtual bool isFMADLegal(const SelectionDAG &DAG, const SDNode *N) const {
3621 assert((N->getOpcode() == ISD::FADD || N->getOpcode() == ISD::FSUB ||
3622 N->getOpcode() == ISD::FMUL) &&
3623 "unexpected node in FMAD forming combine");
3624 return isOperationLegal(ISD::FMAD, N->getValueType(0));
3625 }
3626
3627 // Return true when the decision to generate FMA's (or FMS, FMLA etc) rather
3628 // than FMUL and ADD is delegated to the machine combiner.
3630 CodeGenOptLevel OptLevel) const {
3631 return false;
3632 }
3633
3634 /// Return true if it's profitable to narrow operations of type SrcVT to
3635 /// DestVT. e.g. on x86, it's profitable to narrow from i32 to i8 but not from
3636 /// i32 to i16.
3637 virtual bool isNarrowingProfitable(SDNode *N, EVT SrcVT, EVT DestVT) const {
3638 return false;
3639 }
3640
3641 /// Return true if pulling a binary operation into a select with an identity
3642 /// constant is profitable. This is the inverse of an IR transform.
3643 /// Example: X + (Cond ? Y : 0) --> Cond ? (X + Y) : X
3644 virtual bool shouldFoldSelectWithIdentityConstant(unsigned BinOpcode, EVT VT,
3645 unsigned SelectOpcode,
3646 SDValue X,
3647 SDValue Y) const {
3648 return false;
3649 }
3650
3651 /// Return true if it is beneficial to convert a load of a constant to
3652 /// just the constant itself.
3653 /// On some targets it might be more efficient to use a combination of
3654 /// arithmetic instructions to materialize the constant instead of loading it
3655 /// from a constant pool.
3657 Type *Ty) const {
3658 return false;
3659 }
3660
3661 /// Return the cost of extracting a subvector of type \p ResVT from a vector
3662 /// of type \p SrcVT, starting at element \p Index.
3663 ///
3664 /// Most callers only create a new EXTRACT_SUBVECTOR when the cost is at most
3665 /// ExtractSubvectorCost::Cheap. This hook exists because EXTRACT_SUBVECTOR
3666 /// usually has custom lowering that depends on the index of the first
3667 /// element, so only the target knows which lowering is cheap.
3669 unsigned Index) const {
3671 }
3672
3673 /// Try to convert an extract element of a vector binary operation into an
3674 /// extract element followed by a scalar operation.
3675 virtual bool shouldScalarizeBinop(SDValue VecOp) const {
3676 return false;
3677 }
3678
3679 /// Return true if extraction of a scalar element from the given vector type
3680 /// at the given index is cheap. For example, if scalar operations occur on
3681 /// the same register file as vector operations, then an extract element may
3682 /// be a sub-register rename rather than an actual instruction.
3683 virtual bool isExtractVecEltCheap(EVT VT, unsigned Index) const {
3684 return false;
3685 }
3686
3687 /// Try to convert math with an overflow comparison into the corresponding DAG
3688 /// node operation. Targets may want to override this independently of whether
3689 /// the operation is legal/custom for the given type because it may obscure
3690 /// matching of other patterns.
3691 virtual bool shouldFormOverflowOp(unsigned Opcode, EVT VT,
3692 bool MathUsed) const {
3693 // Form it if it is legal.
3694 if (isOperationLegal(Opcode, VT))
3695 return true;
3696
3697 // TODO: The default logic is inherited from code in CodeGenPrepare.
3698 // The opcode should not make a difference by default?
3699 if (Opcode != ISD::UADDO)
3700 return false;
3701
3702 // Allow the transform as long as we have an integer type that is not
3703 // obviously illegal and unsupported and if the math result is used
3704 // besides the overflow check. On some targets (e.g. SPARC), it is
3705 // not profitable to form on overflow op if the math result has no
3706 // concrete users.
3707 if (VT.isVector())
3708 return false;
3709 return MathUsed && (VT.isSimple() || !isOperationExpand(Opcode, VT));
3710 }
3711
3712 // Return true if the target wants to optimize the mul overflow intrinsic
3713 // for the given \p VT.
3715 EVT VT) const {
3716 return false;
3717 }
3718
3719 // Return true if it is profitable to use a scalar input to a BUILD_VECTOR
3720 // even if the vector itself has multiple uses.
3721 virtual bool aggressivelyPreferBuildVectorSources(EVT VecVT) const {
3722 return false;
3723 }
3724
3725 // Return true if CodeGenPrepare should consider splitting large offset of a
3726 // GEP to make the GEP fit into the addressing mode and can be sunk into the
3727 // same blocks of its users.
3728 virtual bool shouldConsiderGEPOffsetSplit() const { return false; }
3729
3730 /// Return true if creating a shift of the type by the given
3731 /// amount is not profitable.
3732 virtual bool shouldAvoidTransformToShift(EVT VT, unsigned Amount) const {
3733 return false;
3734 }
3735
3736 // Should we fold (select_cc seteq (and x, y), 0, 0, A) -> (and (sra (shl x))
3737 // A) where y has a single bit set?
3739 const APInt &AndMask) const {
3740 unsigned ShCt = AndMask.getBitWidth() - 1;
3741 return !shouldAvoidTransformToShift(VT, ShCt);
3742 }
3743
3744 /// Does this target require the clearing of high-order bits in a register
3745 /// passed to the fp16 to fp conversion library function.
3746 virtual bool shouldKeepZExtForFP16Conv() const { return false; }
3747
3748 /// Should we generate fp_to_si_sat and fp_to_ui_sat from type FPVT to type
3749 /// VT. Used when folding idioms into a saturating fp-to-int conversion, such
3750 /// as min(max(fptoi)) clamps or NaN-guarded selects.
3751 virtual bool shouldConvertFpToSat(unsigned Op, EVT FPVT, EVT VT) const {
3752 return isOperationLegalOrCustom(Op, VT);
3753 }
3754
3755 /// Should we prefer selects to doing arithmetic on boolean types
3757 return false;
3758 }
3759
3760 /// True if target has some particular form of dealing with pointer arithmetic
3761 /// semantics for pointers with the given value type. False if pointer
3762 /// arithmetic should not be preserved for passes such as instruction
3763 /// selection, and can fallback to regular arithmetic.
3764 /// This should be removed when PTRADD nodes are widely supported by backends.
3765 virtual bool shouldPreservePtrArith(const Function &F, EVT PtrVT) const {
3766 return false;
3767 }
3768
3769 /// True if the target allows transformations of in-bounds pointer
3770 /// arithmetic that cause out-of-bounds intermediate results.
3772 EVT PtrVT) const {
3773 return false;
3774 }
3775
3776 /// Does this target support complex deinterleaving
3777 virtual bool isComplexDeinterleavingSupported() const { return false; }
3778
3779 /// Does this target support complex deinterleaving with the given operation
3780 /// and type
3783 return false;
3784 }
3785
3786 // Get the preferred opcode for FP_TO_XINT nodes.
3787 // By default, this checks if the provded operation is an illegal FP_TO_UINT
3788 // and if so, checks if FP_TO_SINT is legal or custom for use as a
3789 // replacement. If both UINT and SINT conversions are Custom, we choose SINT
3790 // by default because that's the right thing on PPC.
3791 virtual unsigned getPreferredFPToIntOpcode(unsigned Op, EVT FromVT,
3792 EVT ToVT) const {
3793 if (isOperationLegal(Op, ToVT))
3794 return Op;
3795 switch (Op) {
3796 case ISD::FP_TO_UINT:
3798 return ISD::FP_TO_SINT;
3799 break;
3803 break;
3804 default:
3805 break;
3806 }
3807 return Op;
3808 }
3809
3810 /// Create the IR node for the given complex deinterleaving operation.
3811 /// If one cannot be created using all the given inputs, nullptr should be
3812 /// returned.
3815 ComplexDeinterleavingRotation Rotation, Value *InputA, Value *InputB,
3816 Value *Accumulator = nullptr) const {
3817 return nullptr;
3818 }
3819
3821 return RuntimeLibcallInfo;
3822 }
3823
3824 const LibcallLoweringInfo &getLibcallLoweringInfo() const { return Libcalls; }
3825
3826 void setLibcallImpl(RTLIB::Libcall Call, RTLIB::LibcallImpl Impl) {
3827 Libcalls.setLibcallImpl(Call, Impl);
3828 }
3829
3830 /// Get the libcall impl routine name for the specified libcall.
3831 RTLIB::LibcallImpl getLibcallImpl(RTLIB::Libcall Call) const {
3832 return Libcalls.getLibcallImpl(Call);
3833 }
3834
3835 /// Get the libcall routine name for the specified libcall.
3836 // FIXME: This should be removed. Only LibcallImpl should have a name.
3837 const char *getLibcallName(RTLIB::Libcall Call) const {
3838 return Libcalls.getLibcallName(Call);
3839 }
3840
3841 /// Get the libcall routine name for the specified libcall implementation
3845
3846 RTLIB::LibcallImpl getMemcpyImpl() const { return Libcalls.getMemcpyImpl(); }
3847
3848 /// Get the CallingConv that should be used for the specified libcall
3849 /// implementation.
3851 return Libcalls.getLibcallImplCallingConv(Call);
3852 }
3853
3854 /// Get the CallingConv that should be used for the specified libcall.
3855 // FIXME: Remove this wrapper and directly use the used LibcallImpl
3857 return Libcalls.getLibcallCallingConv(Call);
3858 }
3859
3860 /// Execute target specific actions to finalize target lowering.
3861 /// This is used to set extra flags in MachineFrameInformation and freezing
3862 /// the set of reserved registers.
3863 /// The default implementation just freezes the set of reserved registers.
3864 virtual void finalizeLowering(MachineFunction &MF) const;
3865
3866 /// Returns true if it's profitable to allow merging store of loads when there
3867 /// are functions calls between the load and the store.
3868 virtual bool shouldMergeStoreOfLoadsOverCall(EVT, EVT) const { return true; }
3869
3870 //===----------------------------------------------------------------------===//
3871 // GlobalISel Hooks
3872 //===----------------------------------------------------------------------===//
3873 /// Check whether or not \p MI needs to be moved close to its uses.
3874 virtual bool shouldLocalize(const MachineInstr &MI, const TargetTransformInfo *TTI) const;
3875
3876
3877private:
3878 const TargetMachine &TM;
3879
3880 /// Tells the code generator that the target has BitExtract instructions.
3881 /// The code generator will aggressively sink "shift"s into the blocks of
3882 /// their users if the users will generate "and" instructions which can be
3883 /// combined with "shift" to BitExtract instructions.
3884 bool HasExtractBitsInsn;
3885
3886 /// Tells the code generator to bypass slow divide or remainder
3887 /// instructions. For example, BypassSlowDivWidths[32,8] tells the code
3888 /// generator to bypass 32-bit integer div/rem with an 8-bit unsigned integer
3889 /// div/rem when the operands are positive and less than 256.
3890 DenseMap <unsigned int, unsigned int> BypassSlowDivWidths;
3891
3892 /// Tells the code generator that it shouldn't generate extra flow control
3893 /// instructions and should attempt to combine flow control instructions via
3894 /// predication.
3895 bool JumpIsExpensive;
3896
3897 /// Information about the contents of the high-bits in boolean values held in
3898 /// a type wider than i1. See getBooleanContents.
3899 BooleanContent BooleanContents;
3900
3901 /// Information about the contents of the high-bits in boolean values held in
3902 /// a type wider than i1. See getBooleanContents.
3903 BooleanContent BooleanFloatContents;
3904
3905 /// Information about the contents of the high-bits in boolean vector values
3906 /// when the element type is wider than i1. See getBooleanContents.
3907 BooleanContent BooleanVectorContents;
3908
3909 /// The target scheduling preference: shortest possible total cycles or lowest
3910 /// register usage.
3911 Sched::Preference SchedPreferenceInfo;
3912
3913 /// The minimum alignment that any argument on the stack needs to have.
3914 Align MinStackArgumentAlignment;
3915
3916 /// The minimum function alignment (used when optimizing for size, and to
3917 /// prevent explicitly provided alignment from leading to incorrect code).
3918 Align MinFunctionAlignment;
3919
3920 /// The preferred function alignment (used when alignment unspecified and
3921 /// optimizing for speed).
3922 Align PrefFunctionAlignment;
3923
3924 /// The preferred loop alignment (in log2 bot in bytes).
3925 Align PrefLoopAlignment;
3926 /// The maximum amount of bytes permitted to be emitted for alignment.
3927 unsigned MaxBytesForAlignment;
3928
3929 /// Size in bits of the maximum atomics size the backend supports.
3930 /// Accesses larger than this will be expanded by AtomicExpandPass.
3931 unsigned MaxAtomicSizeInBitsSupported;
3932
3933 /// Size in bits of the maximum div/rem size the backend supports.
3934 /// Larger operations will be expanded by ExpandIRInsts.
3935 unsigned MaxDivRemBitWidthSupported;
3936
3937 /// Size in bits of the maximum fp to/from int conversion size the
3938 /// backend supports. Larger operations will be expanded by
3939 /// ExpandIRInsts.
3940 unsigned MaxLargeFPConvertBitWidthSupported;
3941
3942 /// Size in bits of the minimum cmpxchg or ll/sc operation the
3943 /// backend supports.
3944 unsigned MinCmpXchgSizeInBits;
3945
3946 /// The minimum of largest number of comparisons to use bit test for switch.
3947 unsigned MinimumBitTestCmps;
3948
3949 /// Maximum known-legal store size, which can be guaranteed for scalable
3950 /// vectors.
3951 unsigned MaximumLegalStoreInBits;
3952
3953 /// This indicates if the target supports unaligned atomic operations.
3954 bool SupportsUnalignedAtomics;
3955
3956 /// If set to a physical register, this specifies the register that
3957 /// llvm.savestack/llvm.restorestack should save and restore.
3958 Register StackPointerRegisterToSaveRestore;
3959
3960 /// This indicates the default register class to use for each ValueType the
3961 /// target supports natively.
3962 const TargetRegisterClass *RegClassForVT[MVT::VALUETYPE_SIZE];
3963 uint16_t NumRegistersForVT[MVT::VALUETYPE_SIZE];
3964 MVT RegisterTypeForVT[MVT::VALUETYPE_SIZE];
3965
3966 /// This indicates the "representative" register class to use for each
3967 /// ValueType the target supports natively. This information is used by the
3968 /// scheduler to track register pressure. By default, the representative
3969 /// register class is the largest legal super-reg register class of the
3970 /// register class of the specified type. e.g. On x86, i8, i16, and i32's
3971 /// representative class would be GR32.
3972 const TargetRegisterClass *RepRegClassForVT[MVT::VALUETYPE_SIZE] = {nullptr};
3973
3974 /// This indicates the "cost" of the "representative" register class for each
3975 /// ValueType. The cost is used by the scheduler to approximate register
3976 /// pressure.
3977 uint8_t RepRegClassCostForVT[MVT::VALUETYPE_SIZE];
3978
3979 /// For any value types we are promoting or expanding, this contains the value
3980 /// type that we are changing to. For Expanded types, this contains one step
3981 /// of the expand (e.g. i64 -> i32), even if there are multiple steps required
3982 /// (e.g. i64 -> i16). For types natively supported by the system, this holds
3983 /// the same type (e.g. i32 -> i32).
3984 MVT TransformToType[MVT::VALUETYPE_SIZE];
3985
3986 /// For each operation and each value type, keep a LegalizeAction that
3987 /// indicates how instruction selection should deal with the operation. Most
3988 /// operations are Legal (aka, supported natively by the target), but
3989 /// operations that are not should be described. Note that operations on
3990 /// non-legal value types are not described here.
3991 LegalizeAction OpActions[MVT::VALUETYPE_SIZE][ISD::BUILTIN_OP_END];
3992
3993 /// For each load extension type and each value type, keep a LegalizeAction
3994 /// that indicates how instruction selection should deal with a load of a
3995 /// specific value type and extension type. Uses 4-bits to store the action
3996 /// for each of the 4 load ext types.
3997 uint16_t LoadExtActions[MVT::VALUETYPE_SIZE][MVT::VALUETYPE_SIZE];
3998
3999 /// Similar to LoadExtActions, but for atomic loads. Only Legal or Expand
4000 /// (default) values are supported.
4001 uint16_t AtomicLoadExtActions[MVT::VALUETYPE_SIZE][MVT::VALUETYPE_SIZE];
4002
4003 /// For each value type pair keep a LegalizeAction that indicates whether a
4004 /// truncating store of a specific value type and truncating type is legal.
4005 LegalizeAction TruncStoreActions[MVT::VALUETYPE_SIZE][MVT::VALUETYPE_SIZE];
4006
4007 /// For each indexed mode and each value type, keep a quad of LegalizeAction
4008 /// that indicates how instruction selection should deal with the load /
4009 /// store / maskedload / maskedstore.
4010 ///
4011 /// The first dimension is the value_type for the reference. The second
4012 /// dimension represents the various modes for load store.
4013 uint16_t IndexedModeActions[MVT::VALUETYPE_SIZE][ISD::LAST_INDEXED_MODE];
4014
4015 /// For each condition code (ISD::CondCode) keep a LegalizeAction that
4016 /// indicates how instruction selection should deal with the condition code.
4017 ///
4018 /// Because each CC action takes up 4 bits, we need to have the array size be
4019 /// large enough to fit all of the value types. This can be done by rounding
4020 /// up the MVT::VALUETYPE_SIZE value to the next multiple of 8.
4021 uint32_t CondCodeActions[ISD::SETCC_INVALID][(MVT::VALUETYPE_SIZE + 7) / 8];
4022
4024 std::tuple<unsigned, MVT::SimpleValueType, MVT::SimpleValueType>;
4025 /// For each partial reduce opcode, result type and input type combination,
4026 /// keep a LegalizeAction which indicates how instruction selection should
4027 /// deal with this operation.
4028 DenseMap<PartialReduceActionTypes, LegalizeAction> PartialReduceMLAActions;
4029
4031 std::tuple<unsigned, unsigned, MVT::SimpleValueType>;
4032 /// For each vector (de)interleave opcode, interleave factor and fragment
4033 /// type combination, keep the corresponding LegalizeAction.
4034 DenseMap<VectorInterleaveActionKey, LegalizeAction> VectorInterleaveActions;
4035
4036 ValueTypeActionImpl ValueTypeActions;
4037
4038private:
4039 /// Targets can specify ISD nodes that they would like PerformDAGCombine
4040 /// callbacks for by calling setTargetDAGCombine(), which sets a bit in this
4041 /// array.
4042 unsigned char
4043 TargetDAGCombineArray[(ISD::BUILTIN_OP_END+CHAR_BIT-1)/CHAR_BIT];
4044
4045 /// For operations that must be promoted to a specific type, this holds the
4046 /// destination type. This map should be sparse, so don't hold it as an
4047 /// array.
4048 ///
4049 /// Targets add entries to this map with AddPromotedToType(..), clients access
4050 /// this with getTypeToPromoteTo(..).
4051 std::map<std::pair<unsigned, MVT::SimpleValueType>, MVT::SimpleValueType>
4052 PromoteToType;
4053
4054 /// FIXME: This should not live here; it should come from an analysis.
4055 const RTLIB::RuntimeLibcallsInfo RuntimeLibcallInfo;
4056
4057 /// The list of libcalls that the target will use.
4058 /// FIXME: This should not live here; it should come from an analysis.
4059 LibcallLoweringInfo Libcalls;
4060
4061 /// The bits of IndexedModeActions used to store the legalisation actions
4062 /// We store the data as | ML | MS | L | S | each taking 4 bits.
4063 enum IndexedModeActionsBits {
4064 IMAB_Store = 0,
4065 IMAB_Load = 4,
4066 IMAB_MaskedStore = 8,
4067 IMAB_MaskedLoad = 12
4068 };
4069
4070 void setIndexedModeAction(unsigned IdxMode, MVT VT, unsigned Shift,
4071 LegalizeAction Action) {
4072 assert(VT.isValid() && IdxMode < ISD::LAST_INDEXED_MODE &&
4073 (unsigned)Action < 0xf && "Table isn't big enough!");
4074 unsigned Ty = (unsigned)VT.SimpleTy;
4075 IndexedModeActions[Ty][IdxMode] &= ~(0xf << Shift);
4076 IndexedModeActions[Ty][IdxMode] |= ((uint16_t)Action) << Shift;
4077 }
4078
4079 LegalizeAction getIndexedModeAction(unsigned IdxMode, MVT VT,
4080 unsigned Shift) const {
4081 assert(IdxMode < ISD::LAST_INDEXED_MODE && VT.isValid() &&
4082 "Table isn't big enough!");
4083 unsigned Ty = (unsigned)VT.SimpleTy;
4084 return (LegalizeAction)((IndexedModeActions[Ty][IdxMode] >> Shift) & 0xf);
4085 }
4086
4087 unsigned getVectorTypeBreakdownImpl(LLVMContext &Context, EVT VT,
4088 EVT &IntermediateVT,
4089 unsigned &NumIntermediates,
4090 MVT &RegisterVT,
4091 bool ForCallingConv) const;
4092
4093 unsigned getVectorTypeBreakdownMVT(MVT VT, MVT &IntermediateVT,
4094 unsigned &NumIntermediates,
4095 MVT &RegisterVT);
4096
4097 /// Return the type of registers that this ValueType will eventually require.
4098 MVT getCachedRegisterType(MVT VT) const {
4099 assert((unsigned)VT.SimpleTy < std::size(RegisterTypeForVT));
4100 return RegisterTypeForVT[VT.SimpleTy];
4101 }
4102
4103 MVT getRegisterTypeImpl(LLVMContext &Context, EVT VT,
4104 bool ForCallingConv) const {
4105 if (VT.isSimple() &&
4106 !shouldUseDynamicVectorTypeBreakdown(VT, ForCallingConv))
4107 return getCachedRegisterType(VT.getSimpleVT());
4108 if (VT.isVector()) {
4109 EVT VT1;
4110 MVT RegisterVT;
4111 unsigned NumIntermediates;
4112 (void)getVectorTypeBreakdownImpl(Context, VT, VT1, NumIntermediates,
4113 RegisterVT, ForCallingConv);
4114 return RegisterVT;
4115 }
4116 if (VT.isInteger()) {
4117 return getRegisterTypeImpl(Context, getTypeToTransformTo(Context, VT),
4118 ForCallingConv);
4119 }
4120 llvm_unreachable("Unsupported extended type!");
4121 }
4122
4123 unsigned getNumRegistersImpl(LLVMContext &Context, EVT VT,
4124 bool ForCallingConv) const {
4125 if (VT.isSimple() &&
4126 !shouldUseDynamicVectorTypeBreakdown(VT, ForCallingConv)) {
4127 assert((unsigned)VT.getSimpleVT().SimpleTy <
4128 std::size(NumRegistersForVT));
4129 return NumRegistersForVT[VT.getSimpleVT().SimpleTy];
4130 }
4131 if (VT.isVector()) {
4132 EVT VT1;
4133 MVT VT2;
4134 unsigned NumIntermediates;
4135 return getVectorTypeBreakdownImpl(Context, VT, VT1, NumIntermediates, VT2,
4136 ForCallingConv);
4137 }
4138 if (VT.isInteger()) {
4139 unsigned BitWidth = VT.getSizeInBits();
4140 unsigned RegWidth =
4141 getRegisterTypeImpl(Context, VT, ForCallingConv).getSizeInBits();
4142 return (BitWidth + RegWidth - 1) / RegWidth;
4143 }
4144 llvm_unreachable("Unsupported extended type!");
4145 }
4146
4147protected:
4148 /// Return true if the extension represented by \p I is free.
4149 /// \pre \p I is a sign, zero, or fp extension and
4150 /// is[Z|FP]ExtFree of the related types is not true.
4151 virtual bool isExtFreeImpl(const Instruction *I) const { return false; }
4152
4153 /// Depth that GatherAllAliases should continue looking for chain
4154 /// dependencies when trying to find a more preferable chain. As an
4155 /// approximation, this should be more than the number of consecutive stores
4156 /// expected to be merged.
4158
4159 /// \brief Specify maximum number of store instructions per memset call.
4160 ///
4161 /// When lowering \@llvm.memset this field specifies the maximum number of
4162 /// store operations that may be substituted for the call to memset. Targets
4163 /// must set this value based on the cost threshold for that target. Targets
4164 /// should assume that the memset will be done using as many of the largest
4165 /// store operations first, followed by smaller ones, if necessary, per
4166 /// alignment restrictions. For example, storing 9 bytes on a 32-bit machine
4167 /// with 16-bit alignment would result in four 2-byte stores and one 1-byte
4168 /// store. This only applies to setting a constant array of a constant size.
4170 /// Likewise for functions with the OptSize attribute.
4172
4173 /// \brief Specify maximum number of store instructions per memcpy call.
4174 ///
4175 /// When lowering \@llvm.memcpy this field specifies the maximum number of
4176 /// store operations that may be substituted for a call to memcpy. Targets
4177 /// must set this value based on the cost threshold for that target. Targets
4178 /// should assume that the memcpy will be done using as many of the largest
4179 /// store operations first, followed by smaller ones, if necessary, per
4180 /// alignment restrictions. For example, storing 7 bytes on a 32-bit machine
4181 /// with 32-bit alignment would result in one 4-byte store, a one 2-byte store
4182 /// and one 1-byte store. This only applies to copying a constant array of
4183 /// constant size.
4185 /// Likewise for functions with the OptSize attribute.
4187 /// \brief Specify max number of store instructions to glue in inlined memcpy.
4188 ///
4189 /// When memcpy is inlined based on MaxStoresPerMemcpy, specify maximum number
4190 /// of store instructions to keep together. This helps in pairing and
4191 // vectorization later on.
4193
4194 /// \brief Specify maximum number of load instructions per memcmp call.
4195 ///
4196 /// When lowering \@llvm.memcmp this field specifies the maximum number of
4197 /// pairs of load operations that may be substituted for a call to memcmp.
4198 /// Targets must set this value based on the cost threshold for that target.
4199 /// Targets should assume that the memcmp will be done using as many of the
4200 /// largest load operations first, followed by smaller ones, if necessary, per
4201 /// alignment restrictions. For example, loading 7 bytes on a 32-bit machine
4202 /// with 32-bit alignment would result in one 4-byte load, a one 2-byte load
4203 /// and one 1-byte load. This only applies to copying a constant array of
4204 /// constant size.
4206 /// Likewise for functions with the OptSize attribute.
4208
4209 /// \brief Specify maximum number of store instructions per memmove call.
4210 ///
4211 /// When lowering \@llvm.memmove this field specifies the maximum number of
4212 /// store instructions that may be substituted for a call to memmove. Targets
4213 /// must set this value based on the cost threshold for that target. Targets
4214 /// should assume that the memmove will be done using as many of the largest
4215 /// store operations first, followed by smaller ones, if necessary, per
4216 /// alignment restrictions. For example, moving 9 bytes on a 32-bit machine
4217 /// with 8-bit alignment would result in nine 1-byte stores. This only
4218 /// applies to copying a constant array of constant size.
4220 /// Likewise for functions with the OptSize attribute.
4222
4223 /// Tells the code generator that select is more expensive than a branch if
4224 /// the branch is usually predicted right.
4226
4227 /// \see enableExtLdPromotion.
4229
4230 /// Return true if the value types that can be represented by the specified
4231 /// register class are all legal.
4232 bool isLegalRC(const TargetRegisterInfo &TRI,
4233 const TargetRegisterClass &RC) const;
4234
4235 /// Replace/modify any TargetFrameIndex operands with a targte-dependent
4236 /// sequence of memory operands that is recognized by PrologEpilogInserter.
4238 MachineBasicBlock *MBB) const;
4239
4241};
4242
4243/// This class defines information used to lower LLVM code to legal SelectionDAG
4244/// operators that the target instruction selector can accept natively.
4245///
4246/// This class also defines callbacks that targets must implement to lower
4247/// target-specific constructs to SelectionDAG operators.
4249public:
4250 struct DAGCombinerInfo;
4251 struct MakeLibCallOptions;
4252
4255
4256 explicit TargetLowering(const TargetMachine &TM,
4257 const TargetSubtargetInfo &STI);
4259
4260 bool isPositionIndependent() const;
4261
4262 // If set to true, SelectionDAG nodes will be consistently processed in
4263 // topological order. This is a temporary hook until sorting can be
4264 // enabled globally.
4265 virtual bool useTopologicalSorting() const { return false; }
4266
4269 UniformityInfo *UA) const {
4270 return false;
4271 }
4272
4273 // Lets target to control the following reassociation of operands: (op (op x,
4274 // c1), y) -> (op (op x, y), c1) where N0 is (op x, c1) and N1 is y. By
4275 // default consider profitable any case where N0 has single use. This
4276 // behavior reflects the condition replaced by this target hook call in the
4277 // DAGCombiner. Any particular target can implement its own heuristic to
4278 // restrict common combiner.
4280 SDValue N1) const {
4281 return N0.hasOneUse();
4282 }
4283
4284 // Lets target to control the following reassociation of operands: (op (op x,
4285 // c1), y) -> (op (op x, y), c1) where N0 is (op x, c1) and N1 is y. By
4286 // default consider profitable any case where N0 has single use. This
4287 // behavior reflects the condition replaced by this target hook call in the
4288 // combiner. Any particular target can implement its own heuristic to
4289 // restrict common combiner.
4291 Register N1) const {
4292 return MRI.hasOneNonDBGUse(N0);
4293 }
4294
4295 virtual bool isSDNodeAlwaysUniform(const SDNode * N) const {
4296 return false;
4297 }
4298
4299 /// Returns true by value, base pointer and offset pointer and addressing mode
4300 /// by reference if the node's address can be legally represented as
4301 /// pre-indexed load / store address.
4302 virtual bool getPreIndexedAddressParts(SDNode * /*N*/, SDValue &/*Base*/,
4303 SDValue &/*Offset*/,
4304 ISD::MemIndexedMode &/*AM*/,
4305 SelectionDAG &/*DAG*/) const {
4306 return false;
4307 }
4308
4309 /// Returns true by value, base pointer and offset pointer and addressing mode
4310 /// by reference if this node can be combined with a load / store to form a
4311 /// post-indexed load / store.
4312 virtual bool getPostIndexedAddressParts(SDNode * /*N*/, SDNode * /*Op*/,
4313 SDValue &/*Base*/,
4314 SDValue &/*Offset*/,
4315 ISD::MemIndexedMode &/*AM*/,
4316 SelectionDAG &/*DAG*/) const {
4317 return false;
4318 }
4319
4320 /// Returns true if the specified base+offset is a legal indexed addressing
4321 /// mode for this target. \p MI is the load or store instruction that is being
4322 /// considered for transformation.
4324 bool IsPre, MachineRegisterInfo &MRI) const {
4325 return false;
4326 }
4327
4328 /// Return the entry encoding for a jump table in the current function. The
4329 /// returned value is a member of the MachineJumpTableInfo::JTEntryKind enum.
4330 virtual unsigned getJumpTableEncoding() const;
4331
4332 virtual MVT getJumpTableRegTy(const DataLayout &DL) const {
4333 return getPointerTy(DL);
4334 }
4335
4336 virtual const MCExpr *
4338 const MachineBasicBlock * /*MBB*/, unsigned /*uid*/,
4339 MCContext &/*Ctx*/) const {
4340 llvm_unreachable("Need to implement this hook if target has custom JTIs");
4341 }
4342
4343 /// Returns relocation base for the given PIC jumptable.
4344 virtual SDValue getPICJumpTableRelocBase(SDValue Table,
4345 SelectionDAG &DAG) const;
4346
4347 /// This returns the relocation base for the given PIC jumptable, the same as
4348 /// getPICJumpTableRelocBase, but as an MCExpr.
4349 virtual const MCExpr *
4350 getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
4351 unsigned JTI, MCContext &Ctx) const;
4352
4353 /// Return true if folding a constant offset with the given GlobalAddress is
4354 /// legal. It is frequently not legal in PIC relocation models.
4355 virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
4356
4357 /// On x86, return true if the operand with index OpNo is a CALL or JUMP
4358 /// instruction, which can use either a memory constraint or an address
4359 /// constraint. -fasm-blocks "__asm call foo" lowers to
4360 /// call void asm sideeffect inteldialect "call ${0:P}", "*m..."
4361 ///
4362 /// This function is used by a hack to choose the address constraint,
4363 /// lowering to a direct call.
4364 virtual bool
4366 unsigned OpNo) const {
4367 return false;
4368 }
4369
4371 SDValue &Chain) const;
4372
4373 void softenSetCCOperands(SelectionDAG &DAG, EVT VT, SDValue &NewLHS,
4374 SDValue &NewRHS, ISD::CondCode &CCCode,
4375 const SDLoc &DL, const SDValue OldLHS,
4376 const SDValue OldRHS) const;
4377
4378 void softenSetCCOperands(SelectionDAG &DAG, EVT VT, SDValue &NewLHS,
4379 SDValue &NewRHS, ISD::CondCode &CCCode,
4380 const SDLoc &DL, const SDValue OldLHS,
4381 const SDValue OldRHS, SDValue &Chain,
4382 bool IsSignaling = false) const;
4383
4385 SDValue Chain, MachineMemOperand *MMO,
4386 SDValue &NewLoad, SDValue Ptr,
4387 SDValue PassThru, SDValue Mask) const {
4388 llvm_unreachable("Not Implemented");
4389 }
4390
4392 SDValue Chain, MachineMemOperand *MMO,
4393 SDValue Ptr, SDValue Val,
4394 SDValue Mask) const {
4395 llvm_unreachable("Not Implemented");
4396 }
4397
4398 /// Returns a pair of (return value, chain).
4399 /// It is an error to pass RTLIB::Unsupported as \p LibcallImpl
4400 std::pair<SDValue, SDValue>
4401 makeLibCall(SelectionDAG &DAG, RTLIB::LibcallImpl LibcallImpl, EVT RetVT,
4402 ArrayRef<SDValue> Ops, MakeLibCallOptions CallOptions,
4403 const SDLoc &dl, SDValue Chain = SDValue()) const;
4404
4405 /// It is an error to pass RTLIB::UNKNOWN_LIBCALL as \p LC.
4406 std::pair<SDValue, SDValue> makeLibCall(SelectionDAG &DAG, RTLIB::Libcall LC,
4407 EVT RetVT, ArrayRef<SDValue> Ops,
4408 MakeLibCallOptions CallOptions,
4409 const SDLoc &dl,
4410 SDValue Chain = SDValue()) const {
4411 return makeLibCall(DAG, getLibcallImpl(LC), RetVT, Ops, CallOptions, dl,
4412 Chain);
4413 }
4414
4415 /// Build a call argument list for \p FuncTy, taking the argument node values
4416 /// from \p Ops and the parameter types and ABI attributes from \p FuncTy and
4417 /// \p FuncAttrs. \p Ops must have one entry per parameter of \p FuncTy.
4418 static ArgListTy getArgListForFunctionType(FunctionType *FuncTy,
4419 const AttributeList &FuncAttrs,
4421
4422 /// Check whether parameters to a call that are passed in callee saved
4423 /// registers are the same as from the calling function. This needs to be
4424 /// checked for tail call eligibility.
4425 bool parametersInCSRMatch(const MachineRegisterInfo &MRI,
4426 const uint32_t *CallerPreservedMask,
4427 const SmallVectorImpl<CCValAssign> &ArgLocs,
4428 const SmallVectorImpl<SDValue> &OutVals) const;
4429
4430 //===--------------------------------------------------------------------===//
4431 // TargetLowering Optimization Methods
4432 //
4433
4434 /// A convenience struct that encapsulates a DAG, and two SDValues for
4435 /// returning information from TargetLowering to its clients that want to
4436 /// combine.
4443
4445 bool LT, bool LO) :
4446 DAG(InDAG), LegalTys(LT), LegalOps(LO) {}
4447
4448 bool LegalTypes() const { return LegalTys; }
4449 bool LegalOperations() const { return LegalOps; }
4450
4452 Old = O;
4453 New = N;
4454 return true;
4455 }
4456 };
4457
4458 /// Determines the optimal series of memory ops to replace the memset /
4459 /// memcpy. Return true if the number of memory ops is below the threshold
4460 /// (Limit). Note that this is always the case when Limit is ~0. It returns
4461 /// the types of the sequence of memory ops to perform memset / memcpy by
4462 /// reference. If LargestVT is non-null, the target may set it to the largest
4463 /// EVT that should be used for generating the memset value (e.g., for vector
4464 /// splats). If LargestVT is null or left unchanged, the caller will compute
4465 /// it from MemOps.
4466 virtual bool findOptimalMemOpLowering(LLVMContext &Context,
4467 std::vector<EVT> &MemOps,
4468 unsigned Limit, const MemOp &Op,
4469 unsigned DstAS, unsigned SrcAS,
4470 const AttributeList &FuncAttributes,
4471 EVT *LargestVT = nullptr) const;
4472
4473 /// Check to see if the specified operand of the specified instruction is a
4474 /// constant integer. If so, check to see if there are any bits set in the
4475 /// constant that are not demanded. If so, shrink the constant and return
4476 /// true.
4478 const APInt &DemandedElts,
4479 TargetLoweringOpt &TLO) const;
4480
4481 /// Helper wrapper around ShrinkDemandedConstant, demanding all elements.
4483 TargetLoweringOpt &TLO) const;
4484
4485 // Target hook to do target-specific const optimization, which is called by
4486 // ShrinkDemandedConstant. This function should return true if the target
4487 // doesn't want ShrinkDemandedConstant to further optimize the constant.
4489 const APInt &DemandedBits,
4490 const APInt &DemandedElts,
4491 TargetLoweringOpt &TLO) const {
4492 return false;
4493 }
4494
4495 /// Convert x+y to (VT)((SmallVT)x+(SmallVT)y) if the casts are free.
4496 /// This uses isTruncateFree/isZExtFree and ANY_EXTEND for the widening cast,
4497 /// but it could be generalized for targets with other types of implicit
4498 /// widening casts.
4499 bool ShrinkDemandedOp(SDValue Op, unsigned BitWidth,
4500 const APInt &DemandedBits,
4501 TargetLoweringOpt &TLO) const;
4502
4503 /// Look at Op. At this point, we know that only the DemandedBits bits of the
4504 /// result of Op are ever used downstream. If we can use this information to
4505 /// simplify Op, create a new simplified DAG node and return true, returning
4506 /// the original and new nodes in Old and New. Otherwise, analyze the
4507 /// expression and return a mask of KnownOne and KnownZero bits for the
4508 /// expression (used to simplify the caller). The KnownZero/One bits may only
4509 /// be accurate for those bits in the Demanded masks.
4510 /// \p AssumeSingleUse When this parameter is true, this function will
4511 /// attempt to simplify \p Op even if there are multiple uses.
4512 /// Callers are responsible for correctly updating the DAG based on the
4513 /// results of this function, because simply replacing TLO.Old
4514 /// with TLO.New will be incorrect when this parameter is true and TLO.Old
4515 /// has multiple uses.
4516 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedBits,
4517 const APInt &DemandedElts, KnownBits &Known,
4518 TargetLoweringOpt &TLO, unsigned Depth = 0,
4519 bool AssumeSingleUse = false) const;
4520
4521 /// Helper wrapper around SimplifyDemandedBits, demanding all elements.
4522 /// Adds Op back to the worklist upon success.
4523 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedBits,
4524 KnownBits &Known, TargetLoweringOpt &TLO,
4525 unsigned Depth = 0,
4526 bool AssumeSingleUse = false) const;
4527
4528 /// Helper wrapper around SimplifyDemandedBits.
4529 /// Adds Op back to the worklist upon success.
4530 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedBits,
4531 DAGCombinerInfo &DCI) const;
4532
4533 /// Helper wrapper around SimplifyDemandedBits.
4534 /// Adds Op back to the worklist upon success.
4535 bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedBits,
4536 const APInt &DemandedElts,
4537 DAGCombinerInfo &DCI) const;
4538
4539 /// More limited version of SimplifyDemandedBits that can be used to "look
4540 /// through" ops that don't contribute to the DemandedBits/DemandedElts -
4541 /// bitwise ops etc.
4542 SDValue SimplifyMultipleUseDemandedBits(SDValue Op, const APInt &DemandedBits,
4543 const APInt &DemandedElts,
4544 SelectionDAG &DAG,
4545 unsigned Depth = 0) const;
4546
4547 /// Helper wrapper around SimplifyMultipleUseDemandedBits, demanding all
4548 /// elements.
4549 SDValue SimplifyMultipleUseDemandedBits(SDValue Op, const APInt &DemandedBits,
4550 SelectionDAG &DAG,
4551 unsigned Depth = 0) const;
4552
4553 /// Helper wrapper around SimplifyMultipleUseDemandedBits, demanding all
4554 /// bits from only some vector elements.
4555 SDValue SimplifyMultipleUseDemandedVectorElts(SDValue Op,
4556 const APInt &DemandedElts,
4557 SelectionDAG &DAG,
4558 unsigned Depth = 0) const;
4559
4560 /// Look at Vector Op. At this point, we know that only the DemandedElts
4561 /// elements of the result of Op are ever used downstream. If we can use
4562 /// this information to simplify Op, create a new simplified DAG node and
4563 /// return true, storing the original and new nodes in TLO.
4564 /// Otherwise, analyze the expression and return a mask of KnownUndef and
4565 /// KnownZero elements for the expression (used to simplify the caller).
4566 /// The KnownUndef/Zero elements may only be accurate for those bits
4567 /// in the DemandedMask.
4568 /// \p AssumeSingleUse When this parameter is true, this function will
4569 /// attempt to simplify \p Op even if there are multiple uses.
4570 /// Callers are responsible for correctly updating the DAG based on the
4571 /// results of this function, because simply replacing TLO.Old
4572 /// with TLO.New will be incorrect when this parameter is true and TLO.Old
4573 /// has multiple uses.
4574 bool SimplifyDemandedVectorElts(SDValue Op, const APInt &DemandedEltMask,
4575 APInt &KnownUndef, APInt &KnownZero,
4576 TargetLoweringOpt &TLO, unsigned Depth = 0,
4577 bool AssumeSingleUse = false) const;
4578
4579 /// Helper wrapper around SimplifyDemandedVectorElts.
4580 /// Adds Op back to the worklist upon success.
4581 bool SimplifyDemandedVectorElts(SDValue Op, const APInt &DemandedElts,
4582 DAGCombinerInfo &DCI) const;
4583
4584 /// Return true if the target supports simplifying demanded vector elements by
4585 /// converting them to undefs.
4586 virtual bool
4588 const TargetLoweringOpt &TLO) const {
4589 return true;
4590 }
4591
4592 /// If only low elements of a vector are demanded, shrink the operation to the
4593 /// returned size in bits by converting
4594 /// (op x) to insert_subvector (op (extract_subvector x)).
4595 ///
4596 /// The returned size must be a multiple of the element size, greater than or
4597 /// equal to the demanded part of the vector and less than the original
4598 /// vector size. Return 0 to disable shrinking.
4599 virtual unsigned
4601 const APInt &DemandedElts) const {
4602 return 0;
4603 }
4604
4605 /// Determine which of the bits specified in Mask are known to be either zero
4606 /// or one and return them in the KnownZero/KnownOne bitsets. The DemandedElts
4607 /// argument allows us to only collect the known bits that are shared by the
4608 /// requested vector elements.
4609 virtual void computeKnownBitsForTargetNode(const SDValue Op,
4611 const APInt &DemandedElts,
4612 const SelectionDAG &DAG,
4613 unsigned Depth = 0) const;
4614
4615 /// Determine which of the bits specified in Mask are known to be either zero
4616 /// or one and return them in the KnownZero/KnownOne bitsets. The DemandedElts
4617 /// argument allows us to only collect the known bits that are shared by the
4618 /// requested vector elements. This is for GISel.
4619 virtual void computeKnownBitsForTargetInstr(GISelValueTracking &Analysis,
4621 const APInt &DemandedElts,
4622 const MachineRegisterInfo &MRI,
4623 unsigned Depth = 0) const;
4624
4625 virtual void computeKnownFPClassForTargetInstr(GISelValueTracking &Analysis,
4626 Register R,
4628 const APInt &DemandedElts,
4629 const MachineRegisterInfo &MRI,
4630 unsigned Depth = 0) const;
4631
4632 /// Determine the known alignment for the pointer value \p R. This is can
4633 /// typically be inferred from the number of low known 0 bits. However, for a
4634 /// pointer with a non-integral address space, the alignment value may be
4635 /// independent from the known low bits.
4636 virtual Align computeKnownAlignForTargetInstr(GISelValueTracking &Analysis,
4637 Register R,
4638 const MachineRegisterInfo &MRI,
4639 unsigned Depth = 0) const;
4640
4641 /// Determine known bits of a pointer to a known valid stack object.
4642 /// The default implementation computes low bits based on alignment.
4643 virtual void computeKnownBitsForStackObjectPointer(KnownBits &Known,
4644 const MachineFunction &MF,
4645 Align Alignment) const;
4646
4647 /// This method can be implemented by targets that want to expose additional
4648 /// information about sign bits to the DAG Combiner. The DemandedElts
4649 /// argument allows us to only collect the minimum sign bits that are shared
4650 /// by the requested vector elements.
4651 virtual unsigned ComputeNumSignBitsForTargetNode(SDValue Op,
4652 const APInt &DemandedElts,
4653 const SelectionDAG &DAG,
4654 unsigned Depth = 0) const;
4655
4656 /// This method can be implemented by targets that want to expose additional
4657 /// information about sign bits to GlobalISel combiners. The DemandedElts
4658 /// argument allows us to only collect the minimum sign bits that are shared
4659 /// by the requested vector elements.
4660 virtual unsigned computeNumSignBitsForTargetInstr(
4661 GISelValueTracking &Analysis, Register R, const APInt &DemandedElts,
4662 const MachineRegisterInfo &MRI, unsigned Depth = 0) const;
4663
4664 /// Attempt to simplify any target nodes based on the demanded vector
4665 /// elements, returning true on success. Otherwise, analyze the expression and
4666 /// return a mask of KnownUndef and KnownZero elements for the expression
4667 /// (used to simplify the caller). The KnownUndef/Zero elements may only be
4668 /// accurate for those bits in the DemandedMask.
4669 virtual bool SimplifyDemandedVectorEltsForTargetNode(
4670 SDValue Op, const APInt &DemandedElts, APInt &KnownUndef,
4671 APInt &KnownZero, TargetLoweringOpt &TLO, unsigned Depth = 0) const;
4672
4673 /// Attempt to simplify any target nodes based on the demanded bits/elts,
4674 /// returning true on success. Otherwise, analyze the
4675 /// expression and return a mask of KnownOne and KnownZero bits for the
4676 /// expression (used to simplify the caller). The KnownZero/One bits may only
4677 /// be accurate for those bits in the Demanded masks.
4678 virtual bool SimplifyDemandedBitsForTargetNode(SDValue Op,
4679 const APInt &DemandedBits,
4680 const APInt &DemandedElts,
4682 TargetLoweringOpt &TLO,
4683 unsigned Depth = 0) const;
4684
4685 /// More limited version of SimplifyDemandedBits that can be used to "look
4686 /// through" ops that don't contribute to the DemandedBits/DemandedElts -
4687 /// bitwise ops etc.
4688 virtual SDValue SimplifyMultipleUseDemandedBitsForTargetNode(
4689 SDValue Op, const APInt &DemandedBits, const APInt &DemandedElts,
4690 SelectionDAG &DAG, unsigned Depth) const;
4691
4692 /// Return true if this function can prove that \p Op is never poison
4693 /// and, \p Kind can be used to track poison and/or undef bits. The
4694 /// DemandedElts argument limits the check to the requested vector elements.
4695 virtual bool isGuaranteedNotToBeUndefOrPoisonForTargetNode(
4696 SDValue Op, const APInt &DemandedElts, const SelectionDAG &DAG,
4697 UndefPoisonKind Kind, unsigned Depth) const;
4698
4699 /// Return true if Op can create undef or poison from non-undef & non-poison
4700 /// operands. The DemandedElts argument limits the check to the requested
4701 /// vector elements.
4702 virtual bool canCreateUndefOrPoisonForTargetNode(
4703 SDValue Op, const APInt &DemandedElts, const SelectionDAG &DAG,
4704 UndefPoisonKind Kind, bool ConsiderFlags, unsigned Depth) const;
4705
4706 /// Tries to build a legal vector shuffle using the provided parameters
4707 /// or equivalent variations. The Mask argument maybe be modified as the
4708 /// function tries different variations.
4709 /// Returns an empty SDValue if the operation fails.
4710 SDValue buildLegalVectorShuffle(EVT VT, const SDLoc &DL, SDValue N0,
4712 SelectionDAG &DAG) const;
4713
4714 /// This method returns the constant pool value that will be loaded by LD.
4715 /// NOTE: You must check for implicit extensions of the constant by LD.
4716 virtual const Constant *getTargetConstantFromLoad(LoadSDNode *LD) const;
4717
4718 /// Determine floating-point class information for a target node. The
4719 /// DemandedElts argument allows us to only collect the known FP classes
4720 /// that are shared by the requested vector elements.
4721 virtual void computeKnownFPClassForTargetNode(const SDValue Op,
4723 const APInt &DemandedElts,
4724 const SelectionDAG &DAG,
4725 unsigned Depth = 0) const;
4726
4727 /// If \p SNaN is false, \returns true if \p Op is known to never be any
4728 /// NaN. If \p sNaN is true, returns if \p Op is known to never be a signaling
4729 /// NaN.
4730 virtual bool isKnownNeverNaNForTargetNode(SDValue Op,
4731 const APInt &DemandedElts,
4732 const SelectionDAG &DAG,
4733 bool SNaN = false,
4734 unsigned Depth = 0) const;
4735
4736 /// Return true if vector \p Op has the same value across all \p DemandedElts,
4737 /// indicating any elements which may be undef in the output \p UndefElts.
4738 virtual bool isSplatValueForTargetNode(SDValue Op, const APInt &DemandedElts,
4739 APInt &UndefElts,
4740 const SelectionDAG &DAG,
4741 unsigned Depth = 0) const;
4742
4743 /// Returns true if the given Opc is considered a canonical constant for the
4744 /// target, which should not be transformed back into a BUILD_VECTOR.
4746 return Op.getOpcode() == ISD::SPLAT_VECTOR ||
4747 Op.getOpcode() == ISD::SPLAT_VECTOR_PARTS;
4748 }
4749
4750 /// Return true if the given select/vselect should be considered canonical and
4751 /// not be transformed. Currently only used for "vselect (not Cond), N1, N2 ->
4752 /// vselect Cond, N2, N1".
4753 virtual bool isTargetCanonicalSelect(SDNode *N) const { return false; }
4754
4756 void *DC; // The DAG Combiner object.
4759
4760 public:
4762
4763 DAGCombinerInfo(SelectionDAG &dag, CombineLevel level, bool cl, void *dc)
4764 : DC(dc), Level(level), CalledByLegalizer(cl), DAG(dag) {}
4765
4766 bool isBeforeLegalize() const { return Level == BeforeLegalizeTypes; }
4768 bool isAfterLegalizeDAG() const { return Level >= AfterLegalizeDAG; }
4771
4772 LLVM_ABI void AddToWorklist(SDNode *N);
4773 LLVM_ABI SDValue CombineTo(SDNode *N, ArrayRef<SDValue> To,
4774 bool AddTo = true);
4775 LLVM_ABI SDValue CombineTo(SDNode *N, SDValue Res, bool AddTo = true);
4776 LLVM_ABI SDValue CombineTo(SDNode *N, SDValue Res0, SDValue Res1,
4777 bool AddTo = true);
4778
4779 LLVM_ABI bool recursivelyDeleteUnusedNodes(SDNode *N);
4780
4781 LLVM_ABI void CommitTargetLoweringOpt(const TargetLoweringOpt &TLO);
4782 };
4783
4784 /// Return if the N is a constant or constant vector equal to the true value
4785 /// from getBooleanContents().
4786 bool isConstTrueVal(SDValue N) const;
4787
4788 /// Return if the N is a constant or constant vector equal to the false value
4789 /// from getBooleanContents().
4790 bool isConstFalseVal(SDValue N) const;
4791
4792 /// Return if \p N is a True value when extended to \p VT.
4793 bool isExtendedTrueVal(const ConstantSDNode *N, EVT VT, bool SExt) const;
4794
4795 /// Try to simplify a setcc built with the specified operands and cc. If it is
4796 /// unable to simplify it, return a null SDValue.
4797 SDValue SimplifySetCC(EVT VT, SDValue N0, SDValue N1, ISD::CondCode Cond,
4798 bool foldBooleans, DAGCombinerInfo &DCI,
4799 const SDLoc &dl) const;
4800
4801 // For targets which wrap address, unwrap for analysis.
4802 virtual SDValue unwrapAddress(SDValue N) const { return N; }
4803
4804 /// Returns true (and the GlobalValue and the offset) if the node is a
4805 /// GlobalAddress + offset.
4806 virtual bool
4807 isGAPlusOffset(SDNode *N, const GlobalValue* &GA, int64_t &Offset) const;
4808
4809 /// This method will be invoked for all target nodes and for any
4810 /// target-independent nodes that the target has registered with invoke it
4811 /// for.
4812 ///
4813 /// The semantics are as follows:
4814 /// Return Value:
4815 /// SDValue.Val == 0 - No change was made
4816 /// SDValue.Val == N - N was replaced, is dead, and is already handled.
4817 /// otherwise - N should be replaced by the returned Operand.
4818 ///
4819 /// In addition, methods provided by DAGCombinerInfo may be used to perform
4820 /// more complex transformations.
4821 ///
4822 virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
4823
4824 /// Return true if it is profitable to move this shift by a constant amount
4825 /// through its operand, adjusting any immediate operands as necessary to
4826 /// preserve semantics. This transformation may not be desirable if it
4827 /// disrupts a particularly auspicious target-specific tree (e.g. bitfield
4828 /// extraction in AArch64). By default, it returns true.
4829 ///
4830 /// @param N the shift node
4831 /// @param Level the current DAGCombine legalization level.
4833 CombineLevel Level) const {
4834 SDValue ShiftLHS = N->getOperand(0);
4835 if (!ShiftLHS->hasOneUse())
4836 return false;
4837 if (ShiftLHS.getOpcode() == ISD::SIGN_EXTEND &&
4838 !ShiftLHS.getOperand(0)->hasOneUse())
4839 return false;
4840 return true;
4841 }
4842
4843 /// fold (A + vscale(C1)) + vscale(C2) -> A + vscale(C1+C2)
4844 /// If (A + vscale(C1)) is used multiple times, the fold results in a
4845 /// redundant addition instruction on the RISC-V architecture, whereas it
4846 /// does not have this effect on other architectures (e.g. AArch64).
4847 /// By default, it returns true.
4848 virtual bool isProfitableToFoldVScaleAdd(SDValue N) const { return true; }
4849
4850 /// GlobalISel - return true if it is profitable to move this shift by a
4851 /// constant amount through its operand, adjusting any immediate operands as
4852 /// necessary to preserve semantics. This transformation may not be desirable
4853 /// if it disrupts a particularly auspicious target-specific tree (e.g.
4854 /// bitfield extraction in AArch64). By default, it returns true.
4855 ///
4856 /// @param MI the shift instruction
4857 /// @param IsAfterLegal true if running after legalization.
4859 bool IsAfterLegal) const {
4860 return true;
4861 }
4862
4863 /// GlobalISel - return true if it's profitable to perform the combine:
4864 /// shl ([sza]ext x), y => zext (shl x, y)
4865 virtual bool isDesirableToPullExtFromShl(const MachineInstr &MI) const {
4866 return true;
4867 }
4868
4869 // Return AndOrSETCCFoldKind::{AddAnd, ABS} if its desirable to try and
4870 // optimize LogicOp(SETCC0, SETCC1). An example (what is implemented as of
4871 // writing this) is:
4872 // With C as a power of 2 and C != 0 and C != INT_MIN:
4873 // AddAnd:
4874 // (icmp eq A, C) | (icmp eq A, -C)
4875 // -> (icmp eq and(add(A, C), ~(C + C)), 0)
4876 // (icmp ne A, C) & (icmp ne A, -C)w
4877 // -> (icmp ne and(add(A, C), ~(C + C)), 0)
4878 // ABS:
4879 // (icmp eq A, C) | (icmp eq A, -C)
4880 // -> (icmp eq Abs(A), C)
4881 // (icmp ne A, C) & (icmp ne A, -C)w
4882 // -> (icmp ne Abs(A), C)
4883 //
4884 // @param LogicOp the logic op
4885 // @param SETCC0 the first of the SETCC nodes
4886 // @param SETCC0 the second of the SETCC nodes
4888 const SDNode *LogicOp, const SDNode *SETCC0, const SDNode *SETCC1) const {
4890 }
4891
4892 /// Return true if it is profitable to combine an XOR of a logical shift
4893 /// to create a logical shift of NOT. This transformation may not be desirable
4894 /// if it disrupts a particularly auspicious target-specific tree (e.g.
4895 /// BIC on ARM/AArch64). By default, it returns true.
4896 virtual bool isDesirableToCommuteXorWithShift(const SDNode *N) const {
4897 return true;
4898 }
4899
4900 /// Return true if the target has native support for the specified value type
4901 /// and it is 'desirable' to use the type for the given node type. e.g. On x86
4902 /// i16 is legal, but undesirable since i16 instruction encodings are longer
4903 /// and some i16 instructions are slow.
4904 virtual bool isTypeDesirableForOp(unsigned /*Opc*/, EVT VT) const {
4905 // By default, assume all legal types are desirable.
4906 return isTypeLegal(VT);
4907 }
4908
4909 /// Overload that takes the specific node being optimized.
4910 virtual bool isTypeDesirableForOp(SDNode *N, EVT VT) const {
4911 return isTypeDesirableForOp(N->getOpcode(), VT);
4912 }
4913
4914 /// Return true if it is profitable for dag combiner to transform a floating
4915 /// point op of specified opcode to a equivalent op of an integer
4916 /// type. e.g. f32 load -> i32 load can be profitable on ARM.
4917 virtual bool isDesirableToTransformToIntegerOp(unsigned /*Opc*/,
4918 EVT /*VT*/) const {
4919 return false;
4920 }
4921
4922 /// This method query the target whether it is beneficial for dag combiner to
4923 /// promote the specified node. If true, it should return the desired
4924 /// promotion type by reference.
4925 virtual bool IsDesirableToPromoteOp(SDValue /*Op*/, EVT &/*PVT*/) const {
4926 return false;
4927 }
4928
4929 /// Return true if the target supports swifterror attribute. It optimizes
4930 /// loads and stores to reading and writing a specific register.
4931 virtual bool supportSwiftError() const {
4932 return false;
4933 }
4934
4935 /// Return true if the target supports that a subset of CSRs for the given
4936 /// machine function is handled explicitly via copies.
4937 virtual bool supportSplitCSR(MachineFunction *MF) const {
4938 return false;
4939 }
4940
4941 /// Return true if the target supports kcfi operand bundles.
4942 virtual bool supportKCFIBundles() const { return false; }
4943
4944 /// Return true if the target supports ptrauth operand bundles.
4945 virtual bool supportPtrAuthBundles() const { return false; }
4946
4947 /// Perform necessary initialization to handle a subset of CSRs explicitly
4948 /// via copies. This function is called at the beginning of instruction
4949 /// selection.
4950 virtual void initializeSplitCSR(MachineBasicBlock *Entry) const {
4951 llvm_unreachable("Not Implemented");
4952 }
4953
4954 /// Insert explicit copies in entry and exit blocks. We copy a subset of
4955 /// CSRs to virtual registers in the entry block, and copy them back to
4956 /// physical registers in the exit blocks. This function is called at the end
4957 /// of instruction selection.
4959 MachineBasicBlock *Entry,
4960 const SmallVectorImpl<MachineBasicBlock *> &Exits) const {
4961 llvm_unreachable("Not Implemented");
4962 }
4963
4964 /// Return the newly negated expression if the cost is not expensive and
4965 /// set the cost in \p Cost to indicate that if it is cheaper or neutral to
4966 /// do the negation.
4967 virtual SDValue getNegatedExpression(SDValue Op, SelectionDAG &DAG,
4968 bool LegalOps, bool OptForSize,
4969 NegatibleCost &Cost,
4970 unsigned Depth = 0) const;
4971
4973 SDValue Op, SelectionDAG &DAG, bool LegalOps, bool OptForSize,
4974 const NegatibleCost CostThreshold = NegatibleCost::Neutral,
4975 unsigned Depth = 0) const {
4977 SDValue Neg =
4978 getNegatedExpression(Op, DAG, LegalOps, OptForSize, Cost, Depth);
4979 if (!Neg)
4980 return SDValue();
4981
4982 if (Cost <= CostThreshold)
4983 return Neg;
4984
4985 // Remove the new created node to avoid the side effect to the DAG.
4986 if (Neg->use_empty())
4987 DAG.RemoveDeadNode(Neg.getNode());
4988 return SDValue();
4989 }
4990
4991 /// This is the helper function to return the newly negated expression only
4992 /// when the cost is cheaper.
4994 bool LegalOps, bool OptForSize,
4995 unsigned Depth = 0) const {
4996 return getCheaperOrNeutralNegatedExpression(Op, DAG, LegalOps, OptForSize,
4998 }
4999
5000 /// This is the helper function to return the newly negated expression if
5001 /// the cost is not expensive.
5003 bool OptForSize, unsigned Depth = 0) const {
5005 return getNegatedExpression(Op, DAG, LegalOps, OptForSize, Cost, Depth);
5006 }
5007
5008 //===--------------------------------------------------------------------===//
5009 // Lowering methods - These methods must be implemented by targets so that
5010 // the SelectionDAGBuilder code knows how to lower these.
5011 //
5012
5013 /// Target-specific splitting of values into parts that fit a register
5014 /// storing a legal type
5016 SelectionDAG & DAG, const SDLoc &DL, SDValue Val, SDValue *Parts,
5017 unsigned NumParts, MVT PartVT, std::optional<CallingConv::ID> CC) const {
5018 return false;
5019 }
5020
5021 /// Target-specific combining of register parts into its original value
5022 virtual SDValue
5024 const SDValue *Parts, unsigned NumParts,
5025 MVT PartVT, EVT ValueVT,
5026 std::optional<CallingConv::ID> CC) const {
5027 return SDValue();
5028 }
5029
5030 /// This hook must be implemented to lower the incoming (formal) arguments,
5031 /// described by the Ins array, into the specified DAG. The implementation
5032 /// should fill in the InVals array with legal-type argument values, and
5033 /// return the resulting token chain value.
5035 SDValue /*Chain*/, CallingConv::ID /*CallConv*/, bool /*isVarArg*/,
5036 const SmallVectorImpl<ISD::InputArg> & /*Ins*/, const SDLoc & /*dl*/,
5037 SelectionDAG & /*DAG*/, SmallVectorImpl<SDValue> & /*InVals*/) const {
5038 llvm_unreachable("Not Implemented");
5039 }
5040
5041 /// Optional target hook to add target-specific actions when entering EH pad
5042 /// blocks. The implementation should return the resulting token chain value.
5043 virtual SDValue lowerEHPadEntry(SDValue Chain, const SDLoc &DL,
5044 SelectionDAG &DAG) const {
5045 return SDValue();
5046 }
5047
5048 virtual void markLibCallAttributes(MachineFunction *MF, unsigned CC,
5049 ArgListTy &Args) const {}
5050
5051 /// This structure contains the information necessary for lowering
5052 /// pointer-authenticating indirect calls. It is equivalent to the "ptrauth"
5053 /// operand bundle found on the call instruction, if any.
5058
5059 /// This structure contains all information that is necessary for lowering
5060 /// calls. It is passed to TLI::LowerCallTo when the SelectionDAG builder
5061 /// needs to lower a call, and targets will see this struct in their LowerCall
5062 /// implementation.
5065 /// Original unlegalized return type.
5066 Type *OrigRetTy = nullptr;
5067 /// Same as OrigRetTy, or partially legalized for soft float libcalls.
5068 Type *RetTy = nullptr;
5069 bool RetSExt : 1;
5070 bool RetZExt : 1;
5071 bool IsVarArg : 1;
5072 bool IsInReg : 1;
5078 bool NoMerge : 1;
5079
5080 // IsTailCall should be modified by implementations of
5081 // TargetLowering::LowerCall that perform tail call conversions.
5082 bool IsTailCall = false;
5083
5084 // Is Call lowering done post SelectionDAG type legalization.
5086
5087 unsigned NumFixedArgs = -1;
5093 const CallBase *CB = nullptr;
5098 const ConstantInt *CFIType = nullptr;
5101
5102 std::optional<PtrAuthInfo> PAI;
5103
5109
5111 DL = dl;
5112 return *this;
5113 }
5114
5116 Chain = InChain;
5117 return *this;
5118 }
5119
5120 // setCallee with target/module-specific attributes
5122 SDValue Target, ArgListTy &&ArgsList) {
5123 return setLibCallee(CC, ResultType, ResultType, Target,
5124 std::move(ArgsList));
5125 }
5126
5128 Type *OrigResultType, SDValue Target,
5129 ArgListTy &&ArgsList) {
5130 OrigRetTy = OrigResultType;
5131 RetTy = ResultType;
5132 Callee = Target;
5133 CallConv = CC;
5134 NumFixedArgs = ArgsList.size();
5135 Args = std::move(ArgsList);
5136
5137 DAG.getTargetLoweringInfo().markLibCallAttributes(
5138 &(DAG.getMachineFunction()), CC, Args);
5139 return *this;
5140 }
5141
5143 SDValue Target, ArgListTy &&ArgsList,
5144 AttributeSet ResultAttrs = {}) {
5145 RetTy = OrigRetTy = ResultType;
5146 IsInReg = ResultAttrs.hasAttribute(Attribute::InReg);
5147 RetSExt = ResultAttrs.hasAttribute(Attribute::SExt);
5148 RetZExt = ResultAttrs.hasAttribute(Attribute::ZExt);
5149 NoMerge = ResultAttrs.hasAttribute(Attribute::NoMerge);
5150
5151 Callee = Target;
5152 CallConv = CC;
5153 NumFixedArgs = ArgsList.size();
5154 Args = std::move(ArgsList);
5155 return *this;
5156 }
5157
5159 SDValue Target, ArgListTy &&ArgsList,
5160 const CallBase &Call) {
5161 RetTy = OrigRetTy = ResultType;
5162
5163 IsInReg = Call.hasRetAttr(Attribute::InReg);
5165 Call.doesNotReturn() ||
5166 (!isa<InvokeInst>(Call) && isa<UnreachableInst>(Call.getNextNode()));
5167 IsVarArg = FTy->isVarArg();
5168 IsReturnValueUsed = !Call.use_empty();
5169 RetSExt = Call.hasRetAttr(Attribute::SExt);
5170 RetZExt = Call.hasRetAttr(Attribute::ZExt);
5171 NoMerge = Call.hasFnAttr(Attribute::NoMerge);
5172
5173 Callee = Target;
5174
5175 CallConv = Call.getCallingConv();
5176 NumFixedArgs = FTy->getNumParams();
5177 Args = std::move(ArgsList);
5178
5179 CB = &Call;
5180
5181 return *this;
5182 }
5183
5185 IsInReg = Value;
5186 return *this;
5187 }
5188
5191 return *this;
5192 }
5193
5195 IsVarArg = Value;
5196 return *this;
5197 }
5198
5200 IsTailCall = Value;
5201 return *this;
5202 }
5203
5206 return *this;
5207 }
5208
5211 return *this;
5212 }
5213
5215 RetSExt = Value;
5216 return *this;
5217 }
5218
5220 RetZExt = Value;
5221 return *this;
5222 }
5223
5226 return *this;
5227 }
5228
5231 return *this;
5232 }
5233
5235 PAI = Value;
5236 return *this;
5237 }
5238
5241 return *this;
5242 }
5243
5245 CFIType = Type;
5246 return *this;
5247 }
5248
5251 return *this;
5252 }
5253
5255 DeactivationSymbol = Sym;
5256 return *this;
5257 }
5258
5260 return Args;
5261 }
5262 };
5263
5264 /// This structure is used to pass arguments to makeLibCall function.
5266 // By passing type list before soften to makeLibCall, the target hook
5267 // shouldExtendTypeInLibCall can get the original type before soften.
5271
5272 bool IsSigned : 1;
5276 bool IsSoften : 1;
5277
5281
5283 IsSigned = Value;
5284 return *this;
5285 }
5286
5289 return *this;
5290 }
5291
5294 return *this;
5295 }
5296
5299 return *this;
5300 }
5301
5303 OpsVTBeforeSoften = OpsVT;
5304 RetVTBeforeSoften = RetVT;
5305 IsSoften = true;
5306 return *this;
5307 }
5308
5309 /// Override the argument type for an operand. Leave the type as null to use
5310 /// the type from the operand's node.
5312 OpsTypeOverrides = OpsTypes;
5313 return *this;
5314 }
5315 };
5316
5317 /// This function lowers an abstract call to a function into an actual call.
5318 /// This returns a pair of operands. The first element is the return value
5319 /// for the function (if RetTy is not VoidTy). The second element is the
5320 /// outgoing token chain. It calls LowerCall to do the actual lowering.
5321 std::pair<SDValue, SDValue> LowerCallTo(CallLoweringInfo &CLI) const;
5322
5323 /// This hook must be implemented to lower calls into the specified
5324 /// DAG. The outgoing arguments to the call are described by the Outs array,
5325 /// and the values to be returned by the call are described by the Ins
5326 /// array. The implementation should fill in the InVals array with legal-type
5327 /// return values from the call, and return the resulting token chain value.
5328 virtual SDValue
5330 SmallVectorImpl<SDValue> &/*InVals*/) const {
5331 llvm_unreachable("Not Implemented");
5332 }
5333
5334 /// Target-specific cleanup for formal ByVal parameters.
5335 virtual void HandleByVal(CCState *, unsigned &, Align) const {}
5336
5337 /// This hook should be implemented to check whether the return values
5338 /// described by the Outs array can fit into the return registers. If false
5339 /// is returned, an sret-demotion is performed.
5340 virtual bool CanLowerReturn(CallingConv::ID /*CallConv*/,
5341 MachineFunction &/*MF*/, bool /*isVarArg*/,
5342 const SmallVectorImpl<ISD::OutputArg> &/*Outs*/,
5343 LLVMContext &/*Context*/, const Type *RetTy) const
5344 {
5345 // Return true by default to get preexisting behavior.
5346 return true;
5347 }
5348
5349 /// Annotate a stack object pointer with known-bits assertions.
5350 SDValue annotateStackObjectPointer(SDValue Ptr, SelectionDAG &DAG,
5351 const SDLoc &DL, Align Alignment) const;
5352
5353 /// This hook must be implemented to lower outgoing return values, described
5354 /// by the Outs array, into the specified DAG. The implementation should
5355 /// return the resulting token chain value.
5356 virtual SDValue LowerReturn(SDValue /*Chain*/, CallingConv::ID /*CallConv*/,
5357 bool /*isVarArg*/,
5358 const SmallVectorImpl<ISD::OutputArg> & /*Outs*/,
5359 const SmallVectorImpl<SDValue> & /*OutVals*/,
5360 const SDLoc & /*dl*/,
5361 SelectionDAG & /*DAG*/) const {
5362 llvm_unreachable("Not Implemented");
5363 }
5364
5365 /// Return true if result of the specified node is used by a return node
5366 /// only. It also compute and return the input chain for the tail call.
5367 ///
5368 /// This is used to determine whether it is possible to codegen a libcall as
5369 /// tail call at legalization time.
5370 virtual bool isUsedByReturnOnly(SDNode *, SDValue &/*Chain*/) const {
5371 return false;
5372 }
5373
5374 /// Return true if the target may be able emit the call instruction as a tail
5375 /// call. This is used by optimization passes to determine if it's profitable
5376 /// to duplicate return instructions to enable tailcall optimization.
5377 virtual bool mayBeEmittedAsTailCall(const CallInst *) const {
5378 return false;
5379 }
5380
5381 /// Return the register ID of the name passed in. Used by named register
5382 /// global variables extension. There is no target-independent behaviour
5383 /// so the default action is to bail.
5384 virtual Register getRegisterByName(const char* RegName, LLT Ty,
5385 const MachineFunction &MF) const {
5386 reportFatalUsageError("Named registers not implemented for this target");
5387 }
5388
5389 /// Return the type that should be used to zero or sign extend a
5390 /// zeroext/signext integer return value. FIXME: Some C calling conventions
5391 /// require the return type to be promoted, but this is not true all the time,
5392 /// e.g. i1/i8/i16 on x86/x86_64. It is also not necessary for non-C calling
5393 /// conventions. The frontend should handle this and include all of the
5394 /// necessary information.
5396 ISD::NodeType /*ExtendKind*/) const {
5397 EVT MinVT = getRegisterType(Context, MVT::i32);
5398 return VT.bitsLT(MinVT) ? MinVT : VT;
5399 }
5400
5401 /// For some targets, an LLVM struct type must be broken down into multiple
5402 /// simple types, but the calling convention specifies that the entire struct
5403 /// must be passed in a block of consecutive registers.
5404 virtual bool
5406 bool isVarArg,
5407 const DataLayout &DL) const {
5408 return false;
5409 }
5410
5411 /// For most targets, an LLVM type must be broken down into multiple
5412 /// smaller types. Usually the halves are ordered according to the endianness
5413 /// but for some platform that would break. So this method will default to
5414 /// matching the endianness but can be overridden.
5415 virtual bool
5417 return DL.isLittleEndian();
5418 }
5419
5420 /// Returns a 0 terminated array of registers that can be safely used as
5421 /// scratch registers.
5423 return nullptr;
5424 }
5425
5426 /// Returns a 0 terminated array of rounding control registers that can be
5427 /// attached into strict FP call.
5431
5432 /// This callback is used to prepare for a volatile or atomic load.
5433 /// It takes a chain node as input and returns the chain for the load itself.
5434 ///
5435 /// Having a callback like this is necessary for targets like SystemZ,
5436 /// which allows a CPU to reuse the result of a previous load indefinitely,
5437 /// even if a cache-coherent store is performed by another CPU. The default
5438 /// implementation does nothing.
5440 SelectionDAG &DAG) const {
5441 return Chain;
5442 }
5443
5444 /// This callback is invoked by the type legalizer to legalize nodes with an
5445 /// illegal operand type but legal result types. It replaces the
5446 /// LowerOperation callback in the type Legalizer. The reason we can not do
5447 /// away with LowerOperation entirely is that LegalizeDAG isn't yet ready to
5448 /// use this callback.
5449 ///
5450 /// TODO: Consider merging with ReplaceNodeResults.
5451 ///
5452 /// The target places new result values for the node in Results (their number
5453 /// and types must exactly match those of the original return values of
5454 /// the node), or leaves Results empty, which indicates that the node is not
5455 /// to be custom lowered after all.
5456 /// The default implementation calls LowerOperation.
5457 virtual void LowerOperationWrapper(SDNode *N,
5459 SelectionDAG &DAG) const;
5460
5461 /// This callback is invoked for operations that are unsupported by the
5462 /// target, which are registered to use 'custom' lowering, and whose defined
5463 /// values are all legal. If the target has no operations that require custom
5464 /// lowering, it need not implement this. The default implementation of this
5465 /// aborts.
5466 virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
5467
5468 /// This callback is invoked when a node result type is illegal for the
5469 /// target, and the operation was registered to use 'custom' lowering for that
5470 /// result type. The target places new result values for the node in Results
5471 /// (their number and types must exactly match those of the original return
5472 /// values of the node), or leaves Results empty, which indicates that the
5473 /// node is not to be custom lowered after all.
5474 ///
5475 /// If the target has no operations that require custom lowering, it need not
5476 /// implement this. The default implementation aborts.
5477 virtual void ReplaceNodeResults(SDNode * /*N*/,
5478 SmallVectorImpl<SDValue> &/*Results*/,
5479 SelectionDAG &/*DAG*/) const {
5480 llvm_unreachable("ReplaceNodeResults not implemented for this target!");
5481 }
5482
5483 /// This method returns the name of a target specific DAG node.
5484 virtual const char *getTargetNodeName(unsigned Opcode) const;
5485
5486 /// This method returns a target specific FastISel object, or null if the
5487 /// target does not support "fast" ISel.
5489 const TargetLibraryInfo *,
5490 const LibcallLoweringInfo *) const {
5491 return nullptr;
5492 }
5493
5494 //===--------------------------------------------------------------------===//
5495 // Inline Asm Support hooks
5496 //
5497
5499 C_Register, // Constraint represents specific register(s).
5500 C_RegisterClass, // Constraint represents any of register(s) in class.
5501 C_Memory, // Memory constraint.
5502 C_Address, // Address constraint.
5503 C_Immediate, // Requires an immediate.
5504 C_Other, // Something else.
5505 C_Unknown // Unsupported constraint.
5506 };
5507
5509 // Generic weights.
5510 CW_Invalid = -1, // No match.
5511 CW_Okay = 0, // Acceptable.
5512 CW_Good = 1, // Good weight.
5513 CW_Better = 2, // Better weight.
5514 CW_Best = 3, // Best weight.
5515
5516 // Well-known weights.
5517 CW_SpecificReg = CW_Okay, // Specific register operands.
5518 CW_Register = CW_Good, // Register operands.
5519 CW_Memory = CW_Better, // Memory operands.
5520 CW_Constant = CW_Best, // Constant operand.
5521 CW_Default = CW_Okay // Default or don't know type.
5522 };
5523
5524 /// This contains information for each constraint that we are lowering.
5526 /// This contains the actual string for the code, like "m". TargetLowering
5527 /// picks the 'best' code from ConstraintInfo::Codes that most closely
5528 /// matches the operand.
5529 std::string ConstraintCode;
5530
5531 /// Information about the constraint code, e.g. Register, RegisterClass,
5532 /// Memory, Other, Unknown.
5534
5535 /// If this is the result output operand or a clobber, this is null,
5536 /// otherwise it is the incoming operand to the CallInst. This gets
5537 /// modified as the asm is processed.
5539
5540 /// The ValueType for the operand value.
5541 MVT ConstraintVT = MVT::Other;
5542
5543 /// Copy constructor for copying from a ConstraintInfo.
5546
5547 /// Return true of this is an input operand that is a matching constraint
5548 /// like "4".
5549 LLVM_ABI bool isMatchingInputConstraint() const;
5550
5551 /// If this is an input matching constraint, this method returns the output
5552 /// operand it matches.
5553 LLVM_ABI unsigned getMatchedOperand() const;
5554 };
5555
5556 using AsmOperandInfoVector = std::vector<AsmOperandInfo>;
5557
5558 /// Split up the constraint string from the inline assembly value into the
5559 /// specific constraints and their prefixes, and also tie in the associated
5560 /// operand values. If this returns an empty vector, and if the constraint
5561 /// string itself isn't empty, there was an error parsing.
5563 const TargetRegisterInfo *TRI,
5564 const CallBase &Call) const;
5565
5566 /// Examine constraint type and operand type and determine a weight value.
5567 /// The operand object must already have been set up with the operand type.
5569 AsmOperandInfo &info, int maIndex) const;
5570
5571 /// Examine constraint string and operand type and determine a weight value.
5572 /// The operand object must already have been set up with the operand type.
5574 AsmOperandInfo &info, const char *constraint) const;
5575
5576 /// Determines the constraint code and constraint type to use for the specific
5577 /// AsmOperandInfo, setting OpInfo.ConstraintCode and OpInfo.ConstraintType.
5578 /// If the actual operand being passed in is available, it can be passed in as
5579 /// Op, otherwise an empty SDValue can be passed.
5580 virtual void ComputeConstraintToUse(AsmOperandInfo &OpInfo,
5581 SDValue Op,
5582 SelectionDAG *DAG = nullptr) const;
5583
5584 /// Given a constraint, return the type of constraint it is for this target.
5585 virtual ConstraintType getConstraintType(StringRef Constraint) const;
5586
5587 using ConstraintPair = std::pair<StringRef, TargetLowering::ConstraintType>;
5589 /// Given an OpInfo with list of constraints codes as strings, return a
5590 /// sorted Vector of pairs of constraint codes and their types in priority of
5591 /// what we'd prefer to lower them as. This may contain immediates that
5592 /// cannot be lowered, but it is meant to be a machine agnostic order of
5593 /// preferences.
5595
5596 /// Given a physical register constraint (e.g. {edx}), return the register
5597 /// number and the register class for the register.
5598 ///
5599 /// Given a register class constraint, like 'r', if this corresponds directly
5600 /// to an LLVM register class, return a register of 0 and the register class
5601 /// pointer.
5602 ///
5603 /// This should only be used for C_Register constraints. On error, this
5604 /// returns a register number of 0 and a null register class pointer.
5605 virtual std::pair<unsigned, const TargetRegisterClass *>
5607 StringRef Constraint, MVT VT) const;
5608
5610 getInlineAsmMemConstraint(StringRef ConstraintCode) const {
5611 if (ConstraintCode == "m")
5613 if (ConstraintCode == "o")
5615 if (ConstraintCode == "X")
5617 if (ConstraintCode == "p")
5620 }
5621
5622 /// Try to replace an X constraint, which matches anything, with another that
5623 /// has more specific requirements based on the type of the corresponding
5624 /// operand. This returns null if there is no replacement to make.
5625 virtual const char *LowerXConstraint(EVT ConstraintVT) const;
5626
5627 /// Lower the specified operand into the Ops vector. If it is invalid, don't
5628 /// add anything to Ops.
5629 virtual void LowerAsmOperandForConstraint(SDValue Op, StringRef Constraint,
5630 std::vector<SDValue> &Ops,
5631 SelectionDAG &DAG) const;
5632
5633 // Lower custom output constraints. If invalid, return SDValue().
5634 virtual SDValue LowerAsmOutputForConstraint(SDValue &Chain, SDValue &Glue,
5635 const SDLoc &DL,
5636 const AsmOperandInfo &OpInfo,
5637 SelectionDAG &DAG) const;
5638
5639 // Targets may override this function to collect operands from the CallInst
5640 // and for example, lower them into the SelectionDAG operands.
5641 virtual void CollectTargetIntrinsicOperands(const CallInst &I,
5643 SelectionDAG &DAG) const;
5644
5645 //===--------------------------------------------------------------------===//
5646 // Div utility functions
5647 //
5648
5649 SDValue BuildSDIV(SDNode *N, SelectionDAG &DAG, bool IsAfterLegalization,
5650 bool IsAfterLegalTypes,
5651 SmallVectorImpl<SDNode *> &Created) const;
5652 SDValue BuildUDIV(SDNode *N, SelectionDAG &DAG, bool IsAfterLegalization,
5653 bool IsAfterLegalTypes,
5654 SmallVectorImpl<SDNode *> &Created) const;
5655 // Build sdiv by power-of-2 with conditional move instructions
5656 SDValue buildSDIVPow2WithCMov(SDNode *N, const APInt &Divisor,
5657 SelectionDAG &DAG,
5658 SmallVectorImpl<SDNode *> &Created) const;
5659
5660 /// Targets may override this function to provide custom SDIV lowering for
5661 /// power-of-2 denominators. If the target returns an empty SDValue, LLVM
5662 /// assumes SDIV is expensive and replaces it with a series of other integer
5663 /// operations.
5664 virtual SDValue BuildSDIVPow2(SDNode *N, const APInt &Divisor,
5665 SelectionDAG &DAG,
5666 SmallVectorImpl<SDNode *> &Created) const;
5667
5668 /// Targets may override this function to provide custom SREM lowering for
5669 /// power-of-2 denominators. If the target returns an empty SDValue, LLVM
5670 /// assumes SREM is expensive and replaces it with a series of other integer
5671 /// operations.
5672 virtual SDValue BuildSREMPow2(SDNode *N, const APInt &Divisor,
5673 SelectionDAG &DAG,
5674 SmallVectorImpl<SDNode *> &Created) const;
5675
5676 /// Indicate whether this target prefers to combine FDIVs with the same
5677 /// divisor. If the transform should never be done, return zero. If the
5678 /// transform should be done, return the minimum number of divisor uses
5679 /// that must exist.
5680 virtual unsigned combineRepeatedFPDivisors() const {
5681 return 0;
5682 }
5683
5684 /// Hooks for building estimates in place of slower divisions and square
5685 /// roots.
5686
5687 /// Return either a square root or its reciprocal estimate value for the input
5688 /// operand.
5689 /// \p Enabled is a ReciprocalEstimate enum with value either 'Unspecified' or
5690 /// 'Enabled' as set by a potential default override attribute.
5691 /// If \p RefinementSteps is 'Unspecified', the number of Newton-Raphson
5692 /// refinement iterations required to generate a sufficient (though not
5693 /// necessarily IEEE-754 compliant) estimate is returned in that parameter.
5694 /// The boolean UseOneConstNR output is used to select a Newton-Raphson
5695 /// algorithm implementation that uses either one or two constants.
5696 /// The boolean Reciprocal is used to select whether the estimate is for the
5697 /// square root of the input operand or the reciprocal of its square root.
5698 /// A target may choose to implement its own refinement within this function.
5699 /// If that's true, then return '0' as the number of RefinementSteps to avoid
5700 /// any further refinement of the estimate.
5701 /// An empty SDValue return means no estimate sequence can be created.
5703 int Enabled, int &RefinementSteps,
5704 bool &UseOneConstNR, bool Reciprocal) const {
5705 return SDValue();
5706 }
5707
5708 /// Try to convert the fminnum/fmaxnum to a compare/select sequence. This is
5709 /// required for correctness since InstCombine might have canonicalized a
5710 /// fcmp+select sequence to a FMINNUM/FMAXNUM intrinsic. If we were to fall
5711 /// through to the default expansion/soften to libcall, we might introduce a
5712 /// link-time dependency on libm into a file that originally did not have one.
5713 SDValue createSelectForFMINNUM_FMAXNUM(SDNode *Node, SelectionDAG &DAG) const;
5714
5715 /// Return a reciprocal estimate value for the input operand.
5716 /// \p Enabled is a ReciprocalEstimate enum with value either 'Unspecified' or
5717 /// 'Enabled' as set by a potential default override attribute.
5718 /// If \p RefinementSteps is 'Unspecified', the number of Newton-Raphson
5719 /// refinement iterations required to generate a sufficient (though not
5720 /// necessarily IEEE-754 compliant) estimate is returned in that parameter.
5721 /// A target may choose to implement its own refinement within this function.
5722 /// If that's true, then return '0' as the number of RefinementSteps to avoid
5723 /// any further refinement of the estimate.
5724 /// An empty SDValue return means no estimate sequence can be created.
5726 int Enabled, int &RefinementSteps) const {
5727 return SDValue();
5728 }
5729
5730 /// Return a target-dependent comparison result if the input operand is
5731 /// suitable for use with a square root estimate calculation. For example, the
5732 /// comparison may check if the operand is NAN, INF, zero, normal, etc. The
5733 /// result should be used as the condition operand for a select or branch.
5734 virtual SDValue getSqrtInputTest(SDValue Operand, SelectionDAG &DAG,
5735 const DenormalMode &Mode,
5736 SDNodeFlags Flags = {}) const;
5737
5738 /// Return a target-dependent result if the input operand is not suitable for
5739 /// use with a square root estimate calculation.
5741 SelectionDAG &DAG) const {
5742 return DAG.getConstantFP(0.0, SDLoc(Operand), Operand.getValueType());
5743 }
5744
5745 //===--------------------------------------------------------------------===//
5746 // Legalization utility functions
5747 //
5748
5749 /// Expand a MUL or [US]MUL_LOHI of n-bit values into two or four nodes,
5750 /// respectively, each computing an n/2-bit part of the result.
5751 /// \param Result A vector that will be filled with the parts of the result
5752 /// in little-endian order.
5753 /// \param LL Low bits of the LHS of the MUL. You can use this parameter
5754 /// if you want to control how low bits are extracted from the LHS.
5755 /// \param LH High bits of the LHS of the MUL. See LL for meaning.
5756 /// \param RL Low bits of the RHS of the MUL. See LL for meaning
5757 /// \param RH High bits of the RHS of the MUL. See LL for meaning.
5758 /// \returns true if the node has been expanded, false if it has not
5759 bool expandMUL_LOHI(unsigned Opcode, EVT VT, const SDLoc &dl, SDValue LHS,
5760 SDValue RHS, SmallVectorImpl<SDValue> &Result, EVT HiLoVT,
5761 SelectionDAG &DAG, MulExpansionKind Kind,
5762 SDValue LL = SDValue(), SDValue LH = SDValue(),
5763 SDValue RL = SDValue(), SDValue RH = SDValue()) const;
5764
5765 /// Expand a MUL into two nodes. One that computes the high bits of
5766 /// the result and one that computes the low bits.
5767 /// \param HiLoVT The value type to use for the Lo and Hi nodes.
5768 /// \param LL Low bits of the LHS of the MUL. You can use this parameter
5769 /// if you want to control how low bits are extracted from the LHS.
5770 /// \param LH High bits of the LHS of the MUL. See LL for meaning.
5771 /// \param RL Low bits of the RHS of the MUL. See LL for meaning
5772 /// \param RH High bits of the RHS of the MUL. See LL for meaning.
5773 /// \returns true if the node has been expanded. false if it has not
5774 bool expandMUL(SDNode *N, SDValue &Lo, SDValue &Hi, EVT HiLoVT,
5775 SelectionDAG &DAG, MulExpansionKind Kind,
5776 SDValue LL = SDValue(), SDValue LH = SDValue(),
5777 SDValue RL = SDValue(), SDValue RH = SDValue()) const;
5778
5779 /// Attempt to expand an n-bit div/rem/divrem by constant using an n/2-bit
5780 /// algorithm. First, attempt to expand the division using a n/2-bit urem by
5781 /// constant and other arithmetic ops. The n/2-bit urem by constant will be
5782 /// expanded by DAGCombiner. As this is not possible for all constant
5783 /// divisors, this method falls back to an implementation of the magic
5784 /// algorithm using n/2-bit operations.
5785 /// \param N Node to expand
5786 /// \param Result A vector that will be filled with the lo and high parts of
5787 /// the results. For *DIVREM, this will be the quotient parts followed
5788 /// by the remainder parts.
5789 /// \param HiLoVT The value type to use for the Lo and Hi parts. Should be
5790 /// half of VT.
5791 /// \param LL Low bits of the LHS of the operation. You can use this
5792 /// parameter if you want to control how low bits are extracted from
5793 /// the LHS.
5794 /// \param LH High bits of the LHS of the operation. See LL for meaning.
5795 /// \returns true if the node has been expanded, false if it has not.
5796 bool expandDIVREMByConstant(SDNode *N, SmallVectorImpl<SDValue> &Result,
5797 EVT HiLoVT, SelectionDAG &DAG,
5798 SDValue LL = SDValue(),
5799 SDValue LH = SDValue()) const;
5800
5801 /// Expand funnel shift.
5802 /// \param N Node to expand
5803 /// \returns The expansion if successful, SDValue() otherwise
5804 SDValue expandFunnelShift(SDNode *N, SelectionDAG &DAG) const;
5805
5806 /// Expand carryless multiply.
5807 /// \param N Node to expand
5808 /// \returns The expansion if successful, SDValue() otherwise
5809 SDValue expandCLMUL(SDNode *N, SelectionDAG &DAG) const;
5810
5811 /// Expand MODF node into fractional and integer parts.
5812 /// \param N Node to expand
5813 /// \param Results Vector to store the resulting fractional and integer parts
5814 /// \returns true if the node has been expanded, false if it has not
5815 bool expandMODF(SDNode *N, SelectionDAG &DAG,
5817
5818 /// Expand parallel bit extract (compress).
5819 /// \param N Node to expand
5820 /// \returns The expansion if successful, SDValue() otherwise
5821 SDValue expandPEXT(SDNode *N, SelectionDAG &DAG) const;
5822
5823 /// Expand parallel bit deposit (expand).
5824 /// \param N Node to expand
5825 /// \returns The expansion if successful, SDValue() otherwise
5826 SDValue expandPDEP(SDNode *N, SelectionDAG &DAG) const;
5827
5828 /// Expand rotations.
5829 /// \param N Node to expand
5830 /// \param AllowVectorOps expand vector rotate, this should only be performed
5831 /// if the legalization is happening outside of LegalizeVectorOps
5832 /// \returns The expansion if successful, SDValue() otherwise
5833 SDValue expandROT(SDNode *N, bool AllowVectorOps, SelectionDAG &DAG) const;
5834
5835 /// Expand shift-by-parts.
5836 /// \param N Node to expand
5837 /// \param Lo lower-output-part after conversion
5838 /// \param Hi upper-output-part after conversion
5839 void expandShiftParts(SDNode *N, SDValue &Lo, SDValue &Hi,
5840 SelectionDAG &DAG) const;
5841
5842 /// Expand float(f32) to SINT(i64) conversion
5843 /// \param N Node to expand
5844 /// \param Result output after conversion
5845 /// \returns True, if the expansion was successful, false otherwise
5846 bool expandFP_TO_SINT(SDNode *N, SDValue &Result, SelectionDAG &DAG) const;
5847
5848 /// Expand float to UINT conversion
5849 /// \param N Node to expand
5850 /// \param Result output after conversion
5851 /// \param Chain output chain after conversion
5852 /// \returns True, if the expansion was successful, false otherwise
5853 bool expandFP_TO_UINT(SDNode *N, SDValue &Result, SDValue &Chain,
5854 SelectionDAG &DAG) const;
5855
5856 /// Expand UINT(i64) to double(f64) conversion
5857 /// \param N Node to expand
5858 /// \param Result output after conversion
5859 /// \param Chain output chain after conversion
5860 /// \returns True, if the expansion was successful, false otherwise
5861 bool expandUINT_TO_FP(SDNode *N, SDValue &Result, SDValue &Chain,
5862 SelectionDAG &DAG) const;
5863
5864 /// Expand fminnum/fmaxnum into fminnum_ieee/fmaxnum_ieee with quieted inputs.
5865 SDValue expandFMINNUM_FMAXNUM(SDNode *N, SelectionDAG &DAG) const;
5866
5867 /// Expand fminimum/fmaximum into multiple comparison with selects.
5868 SDValue expandFMINIMUM_FMAXIMUM(SDNode *N, SelectionDAG &DAG) const;
5869
5870 /// Expand fminimumnum/fmaximumnum into multiple comparison with selects.
5871 SDValue expandFMINIMUMNUM_FMAXIMUMNUM(SDNode *N, SelectionDAG &DAG) const;
5872
5873 /// Expand FP_TO_[US]INT_SAT into FP_TO_[US]INT and selects or min/max.
5874 /// \param N Node to expand
5875 /// \returns The expansion result
5876 SDValue expandFP_TO_INT_SAT(SDNode *N, SelectionDAG &DAG) const;
5877
5878 /// Truncate Op to ResultVT. If the result is exact, leave it alone. If it is
5879 /// not exact, force the result to be odd.
5880 /// \param ResultVT The type of result.
5881 /// \param Op The value to round.
5882 /// \returns The expansion result
5883 SDValue expandRoundInexactToOdd(EVT ResultVT, SDValue Op, const SDLoc &DL,
5884 SelectionDAG &DAG) const;
5885
5886 /// Expand round(fp) to fp conversion
5887 /// \param N Node to expand
5888 /// \returns The expansion result
5889 SDValue expandFP_ROUND(SDNode *Node, SelectionDAG &DAG) const;
5890
5891 /// Expand check for floating point class.
5892 /// \param ResultVT The type of intrinsic call result.
5893 /// \param Op The tested value.
5894 /// \param Test The test to perform.
5895 /// \param Flags The optimization flags.
5896 /// \returns The expansion result or SDValue() if it fails.
5897 SDValue expandIS_FPCLASS(EVT ResultVT, SDValue Op, FPClassTest Test,
5898 SDNodeFlags Flags, const SDLoc &DL,
5899 SelectionDAG &DAG) const;
5900
5901 /// Expand FCANONICALIZE to FMUL with 1.
5902 /// \param NodeNode to expand
5903 /// \returns The expansion result
5904 SDValue expandFCANONICALIZE(SDNode *Node, SelectionDAG &DAG) const;
5905
5906 /// Expand CONVERT_TO_ARBITRARY_FP using bit manipulation.
5907 /// \param Node Node to expand.
5908 /// \returns The expansion result, or SDValue() if fails.
5909 SDValue expandCONVERT_TO_ARBITRARY_FP(SDNode *Node, SelectionDAG &DAG) const;
5910
5911 /// Expand CONVERT_FROM_ARBITRARY_FP using bit manipulation.
5912 /// \param Node Node to expand.
5913 /// \returns The expansion result, or SDValue() if fails.
5914 SDValue expandCONVERT_FROM_ARBITRARY_FP(SDNode *Node,
5915 SelectionDAG &DAG) const;
5916
5917 /// Expand CTPOP nodes. Expands vector/scalar CTPOP nodes,
5918 /// vector nodes can only succeed if all operations are legal/custom.
5919 /// \param N Node to expand
5920 /// \returns The expansion result or SDValue() if it fails.
5921 SDValue expandCTPOP(SDNode *N, SelectionDAG &DAG) const;
5922
5923 /// Expand CTLZ/CTLZ_ZERO_POISON nodes. Expands vector/scalar CTLZ nodes,
5924 /// vector nodes can only succeed if all operations are legal/custom.
5925 /// \param N Node to expand
5926 /// \returns The expansion result or SDValue() if it fails.
5927 SDValue expandCTLZ(SDNode *N, SelectionDAG &DAG) const;
5928
5929 /// Expand CTLS (count leading sign bits) nodes.
5930 /// CTLS(x) = CTLZ(OR(SHL(XOR(x, SRA(x, BW-1)), 1), 1))
5931 /// \param N Node to expand
5932 /// \returns The expansion result or SDValue() if it fails.
5933 SDValue expandCTLS(SDNode *N, SelectionDAG &DAG) const;
5934
5935 /// Expand CTTZ via Table Lookup.
5936 /// \param N Node to expand
5937 /// \returns The expansion result or SDValue() if it fails.
5938 SDValue CTTZTableLookup(SDNode *N, SelectionDAG &DAG, const SDLoc &DL, EVT VT,
5939 SDValue Op, unsigned NumBitsPerElt) const;
5940
5941 /// Expand CTTZ/CTTZ_ZERO_POISON nodes. Expands vector/scalar CTTZ nodes,
5942 /// vector nodes can only succeed if all operations are legal/custom.
5943 /// \param N Node to expand
5944 /// \returns The expansion result or SDValue() if it fails.
5945 SDValue expandCTTZ(SDNode *N, SelectionDAG &DAG) const;
5946
5947 /// Expand VP_CTTZ_ELTS/VP_CTTZ_ELTS_ZERO_POISON nodes.
5948 /// \param N Node to expand
5949 /// \returns The expansion result or SDValue() if it fails.
5950 SDValue expandVPCTTZElements(SDNode *N, SelectionDAG &DAG) const;
5951
5952 /// Expand VECTOR_MATCH nodes.
5953 /// \param N Node to expand
5954 /// \returns The expansion result or SDValue() if it fails.
5955 SDValue expandVectorMatch(SDNode *N, SelectionDAG &DAG) const;
5956
5957 /// Expand VECTOR_FIND_LAST_ACTIVE nodes
5958 /// \param N Node to expand
5959 /// \returns The expansion result or SDValue() if it fails.
5960 SDValue expandVectorFindLastActive(SDNode *N, SelectionDAG &DAG) const;
5961
5962 /// Expand GET_ACTIVE_LANE_MASK nodes
5963 /// \param N Node to expand
5964 /// \returns The expansion result or SDValue() if it fails.
5965 SDValue expandGetActiveLaneMask(SDNode *N, SelectionDAG &DAG) const;
5966
5967 /// Expand LOOP_DEPENDENCE_MASK nodes
5968 /// \param N Node to expand
5969 /// \returns The expansion result or SDValue() if it fails.
5970 SDValue expandLoopDependenceMask(SDNode *N, SelectionDAG &DAG) const;
5971
5972 /// Expand ABS nodes. Expands vector/scalar ABS nodes,
5973 /// vector nodes can only succeed if all operations are legal/custom.
5974 /// (ABS x) -> (XOR (ADD x, (SRA x, type_size)), (SRA x, type_size))
5975 /// \param N Node to expand
5976 /// \param IsNegative indicate negated abs
5977 /// \returns The expansion result or SDValue() if it fails.
5978 SDValue expandABS(SDNode *N, SelectionDAG &DAG,
5979 bool IsNegative = false) const;
5980
5981 /// Expand ABDS/ABDU nodes. Expands vector/scalar ABDS/ABDU nodes.
5982 /// \param N Node to expand
5983 /// \returns The expansion result or SDValue() if it fails.
5984 SDValue expandABD(SDNode *N, SelectionDAG &DAG) const;
5985
5986 /// Expand vector/scalar AVGCEILS/AVGCEILU/AVGFLOORS/AVGFLOORU nodes.
5987 /// \param N Node to expand
5988 /// \returns The expansion result or SDValue() if it fails.
5989 SDValue expandAVG(SDNode *N, SelectionDAG &DAG) const;
5990
5991 /// Expand BSWAP nodes. Expands scalar/vector BSWAP nodes with i16/i32/i64
5992 /// scalar types. Returns SDValue() if expand fails.
5993 /// \param N Node to expand
5994 /// \returns The expansion result or SDValue() if it fails.
5995 SDValue expandBSWAP(SDNode *N, SelectionDAG &DAG) const;
5996
5997 /// Expand BITREVERSE nodes. Expands scalar/vector BITREVERSE nodes.
5998 /// Returns SDValue() if expand fails.
5999 /// \param N Node to expand
6000 /// \returns The expansion result or SDValue() if it fails.
6001 SDValue expandBITREVERSE(SDNode *N, SelectionDAG &DAG) const;
6002
6003 /// Turn load of vector type into a load of the individual elements.
6004 /// \param LD load to expand
6005 /// \returns BUILD_VECTOR and TokenFactor nodes.
6006 std::pair<SDValue, SDValue> scalarizeVectorLoad(LoadSDNode *LD,
6007 SelectionDAG &DAG) const;
6008
6009 // Turn a store of a vector type into stores of the individual elements.
6010 /// \param ST Store with a vector value type
6011 /// \returns TokenFactor of the individual store chains.
6013
6014 /// Expands an unaligned load to 2 half-size loads for an integer, and
6015 /// possibly more for vectors.
6016 std::pair<SDValue, SDValue> expandUnalignedLoad(LoadSDNode *LD,
6017 SelectionDAG &DAG) const;
6018
6019 /// Expands an unaligned store to 2 half-size stores for integer values, and
6020 /// possibly more for vectors.
6021 SDValue expandUnalignedStore(StoreSDNode *ST, SelectionDAG &DAG) const;
6022
6023 /// Increments memory address \p Addr according to the type of the value
6024 /// \p DataVT that should be stored. If the data is stored in compressed
6025 /// form, the memory address should be incremented according to the number of
6026 /// the stored elements. This number is equal to the number of '1's bits
6027 /// in the \p Mask.
6028 /// \p DataVT is a vector type. \p Mask is a vector value.
6029 /// \p DataVT and \p Mask have the same number of vector elements.
6030 SDValue IncrementMemoryAddress(SDValue Addr, SDValue Mask, const SDLoc &DL,
6031 EVT DataVT, SelectionDAG &DAG,
6032 bool IsCompressedMemory) const;
6033
6034 /// Get a pointer to vector element \p Idx located in memory for a vector of
6035 /// type \p VecVT starting at a base address of \p VecPtr. If \p Idx is out of
6036 /// bounds the returned pointer is unspecified, but will be within the vector
6037 /// bounds. \p PtrArithFlags can be used to mark that arithmetic within the
6038 /// vector in memory is known to not wrap or to be inbounds.
6039 SDValue getVectorElementPointer(
6040 SelectionDAG &DAG, SDValue VecPtr, EVT VecVT, SDValue Index,
6041 const SDNodeFlags PtrArithFlags = SDNodeFlags()) const;
6042
6043 /// Get a pointer to vector element \p Idx located in memory for a vector of
6044 /// type \p VecVT starting at a base address of \p VecPtr. If \p Idx is out of
6045 /// bounds the returned pointer is unspecified, but will be within the vector
6046 /// bounds. \p VecPtr is guaranteed to point to the beginning of a memory
6047 /// location large enough for the vector.
6049 EVT VecVT, SDValue Index) const {
6050 return getVectorElementPointer(DAG, VecPtr, VecVT, Index,
6053 }
6054
6055 /// Get a pointer to a sub-vector of type \p SubVecVT at index \p Idx located
6056 /// in memory for a vector of type \p VecVT starting at a base address of
6057 /// \p VecPtr. If \p Idx plus the size of \p SubVecVT is out of bounds the
6058 /// returned pointer is unspecified, but the value returned will be such that
6059 /// the entire subvector would be within the vector bounds. \p PtrArithFlags
6060 /// can be used to mark that arithmetic within the vector in memory is known
6061 /// to not wrap or to be inbounds.
6062 SDValue
6063 getVectorSubVecPointer(SelectionDAG &DAG, SDValue VecPtr, EVT VecVT,
6064 EVT SubVecVT, SDValue Index,
6065 const SDNodeFlags PtrArithFlags = SDNodeFlags()) const;
6066
6067 /// Method for building the DAG expansion of ISD::[US][MIN|MAX]. This
6068 /// method accepts integers as its arguments.
6069 SDValue expandIntMINMAX(SDNode *Node, SelectionDAG &DAG) const;
6070
6071 /// Method for building the DAG expansion of ISD::[US][ADD|SUB]SAT. This
6072 /// method accepts integers as its arguments.
6073 SDValue expandAddSubSat(SDNode *Node, SelectionDAG &DAG) const;
6074
6075 /// Method for building the DAG expansion of ISD::[US]CMP. This
6076 /// method accepts integers as its arguments
6077 SDValue expandCMP(SDNode *Node, SelectionDAG &DAG) const;
6078
6079 /// Method for building the DAG expansion of ISD::[US]SHLSAT. This
6080 /// method accepts integers as its arguments.
6081 SDValue expandShlSat(SDNode *Node, SelectionDAG &DAG) const;
6082
6083 /// Method for building the DAG expansion of ISD::[U|S]MULFIX[SAT]. This
6084 /// method accepts integers as its arguments.
6085 SDValue expandFixedPointMul(SDNode *Node, SelectionDAG &DAG) const;
6086
6087 /// Method for building the DAG expansion of ISD::[US]DIVFIX[SAT]. This
6088 /// method accepts integers as its arguments.
6089 /// Note: This method may fail if the division could not be performed
6090 /// within the type. Clients must retry with a wider type if this happens.
6091 SDValue expandFixedPointDiv(unsigned Opcode, const SDLoc &dl,
6093 unsigned Scale, SelectionDAG &DAG) const;
6094
6095 /// Method for building the DAG expansion of ISD::U(ADD|SUB)O. Expansion
6096 /// always suceeds and populates the Result and Overflow arguments.
6097 void expandUADDSUBO(SDNode *Node, SDValue &Result, SDValue &Overflow,
6098 SelectionDAG &DAG) const;
6099
6100 /// Method for building the DAG expansion of ISD::S(ADD|SUB)O. Expansion
6101 /// always suceeds and populates the Result and Overflow arguments.
6102 void expandSADDSUBO(SDNode *Node, SDValue &Result, SDValue &Overflow,
6103 SelectionDAG &DAG) const;
6104
6105 /// Method for building the DAG expansion of ISD::[US]MULO. Returns whether
6106 /// expansion was successful and populates the Result and Overflow arguments.
6107 bool expandMULO(SDNode *Node, SDValue &Result, SDValue &Overflow,
6108 SelectionDAG &DAG) const;
6109
6110 // Expand ISD::MULH[SU]. Can expand to MUL_LOHI or wide MUL if available.
6111 SDValue expandMULH(SDNode *Node, SelectionDAG &DAG) const;
6112
6113 /// Calculate the product twice the width of LHS and RHS. If HiLHS/HiRHS are
6114 /// non-null they will be included in the multiplication. The expansion works
6115 /// by splitting the 2 inputs into 4 pieces that we can multiply and add
6116 /// together without neding MULH or MUL_LOHI.
6117 void forceExpandMultiply(SelectionDAG &DAG, const SDLoc &dl, bool Signed,
6119 SDValue HiLHS = SDValue(),
6120 SDValue HiRHS = SDValue()) const;
6121
6122 /// Calculate full product of LHS and RHS either via a libcall or through
6123 /// brute force expansion of the multiplication. The expansion works by
6124 /// splitting the 2 inputs into 4 pieces that we can multiply and add together
6125 /// without needing MULH or MUL_LOHI.
6126 void forceExpandWideMUL(SelectionDAG &DAG, const SDLoc &dl, bool Signed,
6127 const SDValue LHS, const SDValue RHS, SDValue &Lo,
6128 SDValue &Hi) const;
6129
6130 /// Expand a VECREDUCE_* into an explicit calculation. If Count is specified,
6131 /// only the first Count elements of the vector are used.
6132 SDValue expandVecReduce(SDNode *Node, SelectionDAG &DAG) const;
6133
6134 /// Expand a VECREDUCE_SEQ_* into an explicit ordered calculation.
6135 SDValue expandVecReduceSeq(SDNode *Node, SelectionDAG &DAG) const;
6136
6137 /// Expand an SREM or UREM using SDIV/UDIV or SDIVREM/UDIVREM, if legal.
6138 /// Returns true if the expansion was successful.
6139 bool expandREM(SDNode *Node, SDValue &Result, SelectionDAG &DAG) const;
6140
6141 /// Method for building the DAG expansion of ISD::VECTOR_SPLICE. This
6142 /// method accepts vectors as its arguments.
6143 SDValue expandVectorSplice(SDNode *Node, SelectionDAG &DAG) const;
6144
6145 /// Expand a VECTOR_INTERLEAVE without introducing wider vector types.
6146 void expandVectorInterleave(SDNode *Node, SmallVectorImpl<SDValue> &Results,
6147 SelectionDAG &DAG) const;
6148
6149 /// Expand a VECTOR_DEINTERLEAVE without introducing wider vector types.
6150 void expandVectorDeinterleave(SDNode *Node, SmallVectorImpl<SDValue> &Results,
6151 SelectionDAG &DAG) const;
6152
6153 /// Expand a vector VECTOR_COMPRESS into a sequence of extract element, store
6154 /// temporarily, advance store position, before re-loading the final vector.
6155 SDValue expandVECTOR_COMPRESS(SDNode *Node, SelectionDAG &DAG) const;
6156
6157 /// Expand a CTTZ_ELTS or CTTZ_ELTS_ZERO_POISON by calculating (VL - i) for
6158 /// each active lane (i), getting the maximum and subtracting it from VL.
6159 SDValue expandCttzElts(SDNode *Node, SelectionDAG &DAG) const;
6160
6161 /// Expands PARTIAL_REDUCE_S/UMLA nodes to a series of simpler operations,
6162 /// consisting of zext/sext, extract_subvector, mul and add operations.
6163 SDValue expandPartialReduceMLA(SDNode *Node, SelectionDAG &DAG) const;
6164
6165 /// Expands a node with multiple results to an FP or vector libcall. The
6166 /// libcall is expected to take all the operands of the \p Node followed by
6167 /// output pointers for each of the results. \p CallRetResNo can be optionally
6168 /// set to indicate that one of the results comes from the libcall's return
6169 /// value.
6170 bool expandMultipleResultFPLibCall(
6171 SelectionDAG &DAG, RTLIB::Libcall LC, SDNode *Node,
6173 std::optional<unsigned> CallRetResNo = {}) const;
6174
6175 /// Legalize a SETCC with given LHS and RHS and condition code CC on the
6176 /// current target.
6177 ///
6178 /// If the SETCC has been legalized using AND / OR, then the legalized node
6179 /// will be stored in LHS. RHS and CC will be set to SDValue(). NeedInvert
6180 /// will be set to false.
6181 ///
6182 /// If the SETCC has been legalized by using getSetCCSwappedOperands(), then
6183 /// the values of LHS and RHS will be swapped, CC will be set to the new
6184 /// condition, and NeedInvert will be set to false.
6185 ///
6186 /// If the SETCC has been legalized using the inverse condcode, then LHS and
6187 /// RHS will be unchanged, CC will set to the inverted condcode, and
6188 /// NeedInvert will be set to true. The caller must invert the result of the
6189 /// SETCC with SelectionDAG::getLogicalNOT() or take equivalent action to swap
6190 /// the effect of a true/false result.
6191 ///
6192 /// \returns true if the SETCC has been legalized, false if it hasn't.
6193 bool LegalizeSetCCCondCode(SelectionDAG &DAG, EVT VT, SDValue &LHS,
6194 SDValue &RHS, SDValue &CC, bool &NeedInvert,
6195 const SDLoc &dl, SDValue &Chain,
6196 bool IsSignaling = false) const;
6197
6198 //===--------------------------------------------------------------------===//
6199 // Instruction Emitting Hooks
6200 //
6201
6202 /// This method should be implemented by targets that mark instructions with
6203 /// the 'usesCustomInserter' flag. These instructions are special in various
6204 /// ways, which require special support to insert. The specified MachineInstr
6205 /// is created but not inserted into any basic blocks, and this method is
6206 /// called to expand it into a sequence of instructions, potentially also
6207 /// creating new basic blocks and control flow.
6208 /// As long as the returned basic block is different (i.e., we created a new
6209 /// one), the custom inserter is free to modify the rest of \p MBB.
6210 virtual MachineBasicBlock *
6211 EmitInstrWithCustomInserter(MachineInstr &MI, MachineBasicBlock *MBB) const;
6212
6213 /// This method should be implemented by targets that mark instructions with
6214 /// the 'hasPostISelHook' flag. These instructions must be adjusted after
6215 /// instruction selection by target hooks. e.g. To fill in optional defs for
6216 /// ARM 's' setting instructions.
6217 virtual void AdjustInstrPostInstrSelection(MachineInstr &MI,
6218 SDNode *Node) const;
6219
6220 /// If this function returns true, SelectionDAGBuilder emits a
6221 /// LOAD_STACK_GUARD node when it is lowering Intrinsic::stackprotector.
6222 virtual bool useLoadStackGuardNode(const Module &M) const { return false; }
6223
6225 const SDLoc &DL) const {
6226 llvm_unreachable("not implemented for this target");
6227 }
6228
6229 /// Lower TLS global address SDNode for target independent emulated TLS model.
6230 virtual SDValue LowerToTLSEmulatedModel(const GlobalAddressSDNode *GA,
6231 SelectionDAG &DAG) const;
6232
6233 /// Expands target specific indirect branch for the case of JumpTable
6234 /// expansion.
6235 virtual SDValue expandIndirectJTBranch(const SDLoc &dl, SDValue Value,
6236 SDValue Addr, int JTI,
6237 SelectionDAG &DAG) const;
6238
6239 // seteq(x, 0) -> truncate(srl(ctlz(zext(x)), log2(#bits)))
6240 // If we're comparing for equality to zero and isCtlzFast is true, expose the
6241 // fact that this can be implemented as a ctlz/srl pair, so that the dag
6242 // combiner can fold the new nodes.
6243 SDValue lowerCmpEqZeroToCtlzSrl(SDValue Op, SelectionDAG &DAG) const;
6244
6245 // Return true if `X & Y eq/ne 0` is preferable to `X & Y ne/eq Y`
6247 return true;
6248 }
6249
6250 // Expand vector operation by dividing it into smaller length operations and
6251 // joining their results. SDValue() is returned when expansion did not happen.
6252 SDValue expandVectorNaryOpBySplitting(SDNode *Node, SelectionDAG &DAG) const;
6253
6254 /// Replace an extraction of a load with a narrowed load.
6255 ///
6256 /// \param ResultVT type of the result extraction.
6257 /// \param InVecVT type of the input vector to with bitcasts resolved.
6258 /// \param EltNo index of the vector element to load.
6259 /// \param OriginalLoad vector load that to be replaced.
6260 /// \returns \p ResultVT Load on success SDValue() on failure.
6261 SDValue scalarizeExtractedVectorLoad(EVT ResultVT, const SDLoc &DL,
6262 EVT InVecVT, SDValue EltNo,
6263 LoadSDNode *OriginalLoad,
6264 SelectionDAG &DAG) const;
6265
6266protected:
6267 void setTypeIdForCallsiteInfo(const CallBase *CB, MachineFunction &MF,
6268 MachineFunction::CallSiteInfo &CSInfo) const;
6269
6270private:
6271 SDValue foldSetCCWithAnd(EVT VT, SDValue N0, SDValue N1, ISD::CondCode Cond,
6272 const SDLoc &DL, DAGCombinerInfo &DCI) const;
6273 SDValue foldSetCCWithOr(EVT VT, SDValue N0, SDValue N1, ISD::CondCode Cond,
6274 const SDLoc &DL, DAGCombinerInfo &DCI) const;
6275 SDValue foldSetCCWithBinOp(EVT VT, SDValue N0, SDValue N1, ISD::CondCode Cond,
6276 const SDLoc &DL, DAGCombinerInfo &DCI) const;
6277
6278 SDValue optimizeSetCCOfSignedTruncationCheck(EVT SCCVT, SDValue N0,
6280 DAGCombinerInfo &DCI,
6281 const SDLoc &DL) const;
6282
6283 // (X & (C l>>/<< Y)) ==/!= 0 --> ((X <</l>> Y) & C) ==/!= 0
6284 SDValue optimizeSetCCByHoistingAndByConstFromLogicalShift(
6285 EVT SCCVT, SDValue N0, SDValue N1C, ISD::CondCode Cond,
6286 DAGCombinerInfo &DCI, const SDLoc &DL) const;
6287
6288 SDValue prepareUREMEqFold(EVT SETCCVT, SDValue REMNode,
6289 SDValue CompTargetNode, ISD::CondCode Cond,
6290 DAGCombinerInfo &DCI, const SDLoc &DL,
6291 SmallVectorImpl<SDNode *> &Created) const;
6292 SDValue buildUREMEqFold(EVT SETCCVT, SDValue REMNode, SDValue CompTargetNode,
6293 ISD::CondCode Cond, DAGCombinerInfo &DCI,
6294 const SDLoc &DL) const;
6295
6296 SDValue prepareSREMEqFold(EVT SETCCVT, SDValue REMNode,
6297 SDValue CompTargetNode, ISD::CondCode Cond,
6298 DAGCombinerInfo &DCI, const SDLoc &DL,
6299 SmallVectorImpl<SDNode *> &Created) const;
6300 SDValue buildSREMEqFold(EVT SETCCVT, SDValue REMNode, SDValue CompTargetNode,
6301 ISD::CondCode Cond, DAGCombinerInfo &DCI,
6302 const SDLoc &DL) const;
6303
6304 bool expandUDIVREMByConstantViaUREMDecomposition(
6305 SDNode *N, APInt Divisor, SmallVectorImpl<SDValue> &Result, EVT HiLoVT,
6306 SelectionDAG &DAG, SDValue LL, SDValue LH) const;
6307
6308 bool expandUDIVREMByConstantViaUMulHiMagic(SDNode *N, const APInt &Divisor,
6310 EVT HiLoVT, SelectionDAG &DAG,
6311 SDValue LL, SDValue LH) const;
6312};
6313
6314/// Given an LLVM IR type and return type attributes, compute the return value
6315/// EVTs and flags, and optionally also the offsets, if the return value is
6316/// being lowered to memory.
6317LLVM_ABI void GetReturnInfo(CallingConv::ID CC, Type *ReturnType,
6318 AttributeList attr,
6319 SmallVectorImpl<ISD::OutputArg> &Outs,
6320 const TargetLowering &TLI, const DataLayout &DL);
6321
6322} // end namespace llvm
6323
6324#endif // LLVM_CODEGEN_TARGETLOWERING_H
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
uint64_t uint64_t
uint64_t Imm
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock & MBB
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
MachineBasicBlock MachineBasicBlock::iterator MBBI
Function Alias Analysis Results
Atomic ordering constants.
This file contains the simple types necessary to represent the attributes associated with functions a...
#define X(NUM, ENUM, NAME)
Definition ELF.h:665
block Block Frequency Analysis
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define LLVM_ABI
Definition Compiler.h:211
#define LLVM_READONLY
Definition Compiler.h:334
This file defines the DenseMap class.
const HexagonInstrInfo * TII
IRTranslator LLVM IR MI
static bool ShrinkDemandedConstant(Instruction *I, unsigned OpNo, const APInt &Demanded)
Check to see if the specified operand of the specified instruction is a constant integer.
const AbstractManglingParser< Derived, Alloc >::OperatorInfo AbstractManglingParser< Derived, Alloc >::Ops[]
#define RegName(no)
lazy value info
Implement a low-level type suitable for MachineInstr level instruction selection.
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Register const TargetRegisterInfo * TRI
Promote Memory to Register
Definition Mem2Reg.cpp:110
const uint64_t BitWidth
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
uint64_t High
PowerPC Reduce CR logical Operation
SmallVector< MachineOperand, 4 > Cond
RISCVCC::CondCode CC
MachineRegisterInfo & MRI
static cl::opt< RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode > Mode("regalloc-enable-advisor", cl::Hidden, cl::init(RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode::Default), cl::desc("Enable regalloc advisor mode"), cl::values(clEnumValN(RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode::Default, "default", "Default"), clEnumValN(RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode::Release, "release", "precompiled"), clEnumValN(RegAllocEvictionAdvisorAnalysisLegacy::AdvisorMode::Development, "development", "for training")))
This file defines the SmallVector class.
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
static SDValue scalarizeVectorStore(StoreSDNode *Store, MVT StoreVT, SelectionDAG &DAG)
Scalarize a vector store, bitcasting to TargetVT to determine the scalar type.
Value * RHS
Value * LHS
Class for arbitrary precision integers.
Definition APInt.h:78
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition APInt.h:1508
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
A cache of @llvm.assume calls within a function.
An instruction that atomically checks whether a specified value is in a memory location,...
an instruction that atomically reads a memory location, combines it with another value,...
bool isElementwise() const
Return true if this RMW has elementwise vector semantics.
bool isFloatingPointOperation() const
BinOp getOperation() const
This class holds the attributes for a particular argument, parameter, function, or return value.
Definition Attributes.h:406
LLVM_ABI bool getValueAsBool() const
Return the attribute's value as a boolean.
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
Definition Attributes.h:125
@ None
No attributes have been set.
Definition Attributes.h:127
BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequen...
CCState - This class holds information needed while lowering arguments and return values.
CCValAssign - Represent assignment of one arg/retval to a location.
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
This class represents a function call, abstracting a target machine's calling convention.
This is the shared class of boolean and integer constants.
Definition Constants.h:87
This class represents a range of values.
This is an important base class in LLVM.
Definition Constant.h:44
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
unsigned size() const
Definition DenseMap.h:717
constexpr bool isScalar() const
Exactly one element.
Definition TypeSize.h:317
This is a fast-path instruction selection class that generates poor code and doesn't support illegal ...
Definition FastISel.h:67
FunctionLoweringInfo - This contains information that is global to a function that is used when lower...
Class to represent function types.
unsigned getNumParams() const
Return the number of fixed parameters this function type requires.
bool isVarArg() const
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition Function.cpp:766
Common base class shared among various IRBuilders.
Definition IRBuilder.h:111
Class to represent integer types.
A wrapper class for inspecting calls to intrinsic functions.
static LLT integer(unsigned SizeInBits)
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:76
Tracks which library functions to use for a particular subtarget or function.
An instruction for reading from memory.
This class is used to represent ISD::LOAD nodes.
Represents a single loop in the control flow graph.
Definition LoopInfo.h:40
Context object for machine code objects.
Definition MCContext.h:83
Base class for the full range of assembler expressions which are needed for parsing.
Definition MCExpr.h:34
MCRegisterClass - Base class of TargetRegisterClass.
Machine Value Type.
@ INVALID_SIMPLE_VALUE_TYPE
SimpleValueType SimpleTy
uint64_t getScalarSizeInBits() const
bool isInteger() const
Return true if this is an integer or a vector integer type.
bool isPow2VectorType() const
Returns true if the given vector is a power of 2.
ElementCount getVectorElementCount() const
bool isFloatingPoint() const
Return true if this is a FP or a vector FP type.
bool isValid() const
Return true if this is a valid simple valuetype.
static MVT getIntegerVT(unsigned BitWidth)
Instructions::iterator instr_iterator
Representation of each machine instruction.
A description of a memory reference used in the backend.
Flags
Flags values. These may be or'd together.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
This is an abstract virtual class for memory operations.
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:68
Represent a mutable reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:294
A discriminated union of two or more pointer types, with the discriminator in the low bits of the poi...
Analysis providing profile information.
Wrapper class representing virtual and physical registers.
Definition Register.h:20
Wrapper class for IR location info (IR ordering and DebugLoc) to be passed into SDNode creation funct...
Represents one node in the SelectionDAG.
bool hasOneUse() const
Return true if there is exactly one use of this node.
bool use_empty() const
Return true if there are no uses of this node.
Unlike LLVM values, Selection DAG nodes may return multiple values as the result of a computation.
SDNode * getNode() const
get the SDNode which holds the desired result
bool hasOneUse() const
Return true if there is exactly one node using value ResNo of Node, in exactly one operand.
EVT getValueType() const
Return the ValueType of the referenced return value.
const SDValue & getOperand(unsigned i) const
unsigned getOpcode() const
This is used to represent a portion of an LLVM function in a low-level Data Dependence DAG representa...
LLVM_ABI SDValue getConstantFP(double Val, const SDLoc &DL, EVT VT, bool isTarget=false)
Create a ConstantFPSDNode wrapping a constant value.
const DataLayout & getDataLayout() const
LLVM_ABI void RemoveDeadNode(SDNode *N)
Remove the specified node from the system.
LLVM_ABI SDValue getNode(unsigned Opcode, const SDLoc &DL, EVT VT, ArrayRef< SDUse > Ops)
Gets or creates the specified node.
LLVMContext * getContext() const
This instruction constructs a fixed permutation of two input vectors.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
An instruction for storing to memory.
This class is used to represent ISD::STORE nodes.
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
Multiway switch.
TargetInstrInfo - Interface to description of machine instruction set.
Provides information about what library functions are available for the current target.
LLVM_ABI void setExtAttribute(Attribute::AttrKind Attr)
ArgListEntry(Value *Val, SDValue Node, Type *Ty)
Type * Ty
Same as OrigTy, or partially legalized for soft float libcalls.
ArgListEntry(Value *Val, SDValue Node=SDValue(), Attribute::AttrKind ExtAttr=Attribute::None)
ArgListEntry(SDValue Node, Type *Ty, Attribute::AttrKind ExtAttr=Attribute::None)
Type * OrigTy
Original unlegalized argument type.
LegalizeTypeAction getTypeAction(MVT VT) const
void setTypeAction(MVT VT, LegalizeTypeAction Action)
This base class for TargetLowering contains the SelectionDAG-independent parts that can be used from ...
virtual Value * emitStoreConditional(IRBuilderBase &Builder, Value *Val, Value *Addr, AtomicOrdering Ord) const
Perform a store-conditional operation to Addr.
virtual bool isFMAFasterThanFMulAndFAdd(const MachineFunction &MF, EVT) const
Return true if an FMA operation is faster than a pair of fmul and fadd instructions.
bool isOperationExpand(unsigned Op, EVT VT) const
Return true if the specified operation is illegal on this target or unlikely to be made legal with cu...
EVT getMemValueType(const DataLayout &DL, Type *Ty, bool AllowUnknown=false) const
virtual IntegerType * getCmpLibcallReturnType(LLVMContext &Ctx) const
Return the integer type returned by comparison libcalls.
virtual bool enableAggressiveFMAFusion(LLT Ty) const
Return true if target always benefits from combining into FMA for a given value type.
virtual void emitBitTestAtomicRMWIntrinsic(AtomicRMWInst *AI) const
Perform a bit test atomicrmw using a target-specific intrinsic.
void setOperationAction(ArrayRef< unsigned > Ops, ArrayRef< MVT > VTs, LegalizeAction Action)
virtual bool requiresUniformRegister(MachineFunction &MF, const Value *) const
Allows target to decide about the register class of the specific value that is live outside the defin...
void setBooleanVectorContents(BooleanContent Ty)
Specify how the target extends the result of a vector boolean value from a vector of i1 to a wider ty...
virtual unsigned getVaListSizeInBits(const DataLayout &DL) const
Returns the size of the platform's va_list object.
virtual bool lowerDeinterleaveIntrinsicToLoad(Instruction *Load, Value *Mask, IntrinsicInst *DI, const APInt &GapMask) const
Lower a deinterleave intrinsic to a target specific load intrinsic.
void setOperationAction(unsigned Op, MVT VT, LegalizeAction Action)
Indicate that the specified operation does not work with the specified type and indicate what to do a...
virtual bool preferSextInRegOfTruncate(EVT TruncVT, EVT VT, EVT ExtVT) const
virtual bool decomposeMulByConstant(LLVMContext &Context, EVT VT, SDValue C) const
Return true if it is profitable to transform an integer multiplication-by-constant into simpler opera...
void setMaxDivRemBitWidthSupported(unsigned SizeInBits)
Set the size in bits of the maximum div/rem the backend supports.
virtual bool hasAndNot(SDValue X) const
Return true if the target has a bitwise and-not operation: X = ~A & B This can be used to simplify se...
ReciprocalEstimate
Reciprocal estimate status values used by the functions below.
bool PredictableSelectIsExpensive
Tells the code generator that select is more expensive than a branch if the branch is usually predict...
virtual bool isShuffleMaskLegal(ArrayRef< int >, EVT) const
Targets can use this to indicate that they only support some VECTOR_SHUFFLE operations,...
virtual bool isAtomicAlignmentSupported(Align Alignment, uint64_t SizeInBytes) const
Return true if the target supports an atomic access of SizeInBytes bytes at the given Alignment.
virtual bool enableAggressiveFMAFusion(EVT VT) const
Return true if target always benefits from combining into FMA for a given value type.
virtual bool isComplexDeinterleavingOperationSupported(ComplexDeinterleavingOperation Operation, Type *Ty) const
Does this target support complex deinterleaving with the given operation and type.
virtual bool shouldRemoveRedundantExtend(SDValue Op) const
Return true (the default) if it is profitable to remove a sext_inreg(x) where the sext is redundant,...
bool isIndexedStoreLegal(unsigned IdxMode, EVT VT) const
Return true if the specified indexed load is legal on this target.
SDValue promoteTargetBoolean(SelectionDAG &DAG, SDValue Bool, EVT ValVT) const
Promote the given target boolean to a target boolean of the given type.
virtual bool isFMADLegal(const SelectionDAG &DAG, const SDNode *N) const
Returns true if be combined with to form an ISD::FMAD.
virtual bool shouldReduceLoadWidth(SDNode *Load, ISD::LoadExtType ExtTy, EVT NewVT, std::optional< unsigned > ByteOffset=std::nullopt) const
Return true if it is profitable to reduce a load to a smaller type.
virtual bool hasStandaloneRem(EVT VT) const
Return true if the target can handle a standalone remainder operation.
virtual bool isExtFreeImpl(const Instruction *I) const
Return true if the extension represented by I is free.
EVT getValueType(const DataLayout &DL, Type *Ty, bool AllowUnknown=false) const
Return the EVT corresponding to this LLVM type.
LegalizeAction
This enum indicates whether operations are valid for a target, and if not, what action should be used...
virtual bool shouldExpandBuildVectorWithShuffles(EVT, unsigned DefinedValues) const
LegalizeAction getIndexedMaskedStoreAction(unsigned IdxMode, MVT VT) const
Return how the indexed store should be treated: either it is legal, needs to be promoted to a larger ...
virtual bool isSelectSupported(SelectSupportKind) const
CallingConv::ID getLibcallCallingConv(RTLIB::Libcall Call) const
Get the CallingConv that should be used for the specified libcall.
unsigned MaxStoresPerMemcpyOptSize
Likewise for functions with the OptSize attribute.
MachineBasicBlock * emitPatchPoint(MachineInstr &MI, MachineBasicBlock *MBB) const
Replace/modify any TargetFrameIndex operands with a targte-dependent sequence of memory operands that...
virtual bool isEqualityCmpFoldedWithSignedCmp() const
Return true if instruction generated for equality comparison is folded with instruction generated for...
virtual bool preferSelectsOverBooleanArithmetic(EVT VT) const
Should we prefer selects to doing arithmetic on boolean types.
virtual bool isLegalICmpImmediate(int64_t) const
Return true if the specified immediate is legal icmp immediate, that is the target has icmp instructi...
virtual bool convertSetCCLogicToBitwiseLogic(EVT VT) const
Use bitwise logic to make pairs of compares more efficient.
void setAtomicLoadExtAction(ArrayRef< unsigned > ExtTypes, MVT ValVT, ArrayRef< MVT > MemVTs, LegalizeAction Action)
virtual const TargetRegisterClass * getRegClassFor(MVT VT, bool isDivergent=false) const
Return the register class that should be used for the specified value type.
virtual bool shouldFormOverflowOp(unsigned Opcode, EVT VT, bool MathUsed) const
Try to convert math with an overflow comparison into the corresponding DAG node operation.
ShiftLegalizationStrategy
Return the preferred strategy to legalize tihs SHIFT instruction, with ExpansionFactor being the recu...
virtual bool isVectorLoadExtDesirable(SDValue ExtVal) const
Return true if folding a vector load into ExtVal (a sign, zero, or any extend node) is profitable.
virtual bool isMaskAndCmp0FoldingBeneficial(const Instruction &AndI) const
Return if the target supports combining a chain like:
virtual Value * createComplexDeinterleavingIR(IRBuilderBase &B, ComplexDeinterleavingOperation OperationType, ComplexDeinterleavingRotation Rotation, Value *InputA, Value *InputB, Value *Accumulator=nullptr) const
Create the IR node for the given complex deinterleaving operation.
virtual bool shouldConvertConstantLoadToIntImm(const APInt &Imm, Type *Ty) const
Return true if it is beneficial to convert a load of a constant to just the constant itself.
virtual bool isSupportedFixedPointOperation(unsigned Op, EVT VT, unsigned Scale) const
Custom method defined by each target to indicate if an operation which may require a scale is support...
void setLoadExtAction(ArrayRef< unsigned > ExtTypes, MVT ValVT, MVT MemVT, LegalizeAction Action)
unsigned getMaximumLegalStoreInBits() const
Return maximum known-legal store size, which can be guaranteed for scalable vectors.
virtual bool shouldOptimizeMulOverflowWithZeroHighBits(LLVMContext &Context, EVT VT) const
virtual AtomicExpansionKind shouldExpandAtomicRMWInIR(const AtomicRMWInst *RMW) const
Returns how the IR-level AtomicExpand pass should expand the given AtomicRMW, if at all.
virtual Sched::Preference getSchedulingPreference(SDNode *) const
Some scheduler, e.g.
virtual MachineInstr * EmitKCFICheck(MachineBasicBlock &MBB, MachineBasicBlock::instr_iterator &MBBI, const TargetInstrInfo *TII) const
void setMinStackArgumentAlignment(Align Alignment)
Set the minimum stack alignment of an argument.
bool isExtLoad(const LoadInst *Load, const Instruction *Ext, const DataLayout &DL) const
Return true if Load and Ext can form an ExtLoad.
LegalizeTypeAction getTypeAction(MVT VT) const
virtual bool isLegalScaleForGatherScatter(uint64_t Scale, uint64_t ElemSize) const
EVT getTypeToExpandTo(LLVMContext &Context, EVT VT) const
For types supported by the target, this is an identity function.
virtual bool isSExtCheaperThanZExt(EVT FromTy, EVT ToTy) const
Return true if sign-extension from FromTy to ToTy is cheaper than zero-extension.
virtual bool shouldInsertFencesForAtomic(const Instruction *I) const
Whether AtomicExpandPass should automatically insert fences and reduce ordering for this atomic.
virtual AtomicOrdering atomicOperationOrderAfterFenceSplit(const Instruction *I) const
MVT getVectorIdxTy(const DataLayout &DL) const
Returns the type to be used for the index operand of: ISD::INSERT_VECTOR_ELT, ISD::EXTRACT_VECTOR_ELT...
bool isOperationExpandOrLibCall(unsigned Op, EVT VT) const
virtual bool allowsMisalignedMemoryAccesses(LLT, unsigned AddrSpace=0, Align Alignment=Align(1), MachineMemOperand::Flags Flags=MachineMemOperand::MONone, unsigned *=nullptr) const
LLT handling variant.
virtual bool isSafeMemOpType(MVT) const
Returns true if it's safe to use load / store of the specified type to expand memcpy / memset inline.
virtual void emitExpandAtomicCmpXchg(AtomicCmpXchgInst *CI) const
Perform a cmpxchg expansion using a target-specific method.
virtual ISD::NodeType getExtendForAtomicRMWArg(unsigned Op) const
Returns how the platform's atomic rmw operations expect their input argument to be extended (ZERO_EXT...
const TargetMachine & getTargetMachine() const
unsigned MaxLoadsPerMemcmp
Specify maximum number of load instructions per memcmp call.
virtual unsigned getNumRegistersForCallingConv(LLVMContext &Context, CallingConv::ID CC, EVT VT) const
Certain targets require unusual breakdowns of certain types.
bool rangeFitsInWord(const APInt &Low, const APInt &High, const DataLayout &DL) const
Check whether the range [Low,High] fits in a machine word.
virtual bool isCtpopFast(EVT VT) const
Return true if ctpop instruction is fast.
virtual MachineMemOperand::Flags getTargetMMOFlags(const Instruction &I) const
This callback is used to inspect load/store instructions and add target-specific MachineMemOperand fl...
virtual Register getExceptionSelectorRegister(ExceptionHandling EH, const Constant *PersonalityFn) const
If a physical register, this returns the register that receives the exception typeid on entry to a la...
unsigned MaxGluedStoresPerMemcpy
Specify max number of store instructions to glue in inlined memcpy.
virtual bool isZExtFree(Type *FromTy, Type *ToTy) const
Return true if any actual instruction that defines a value of type FromTy implicitly zero-extends the...
bool isPaddedAtMostSignificantBitsWhenStored(EVT VT) const
Indicates if any padding is guaranteed to go at the most significant bits when storing the type to me...
virtual MVT getRegisterTypeForCallingConv(LLVMContext &Context, CallingConv::ID CC, EVT VT) const
Certain combinations of ABIs, Targets and features require that types are legal for some operations a...
void setOperationPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT)
Convenience method to set an operation to Promote and specify the type in a single call.
LegalizeTypeAction
This enum indicates whether a types are legal for a target, and if not, what action should be used to...
virtual bool useStackGuardMixFP() const
If this function returns true, stack protection checks should mix the frame pointer (or whichever poi...
unsigned getMinCmpXchgSizeInBits() const
Returns the size of the smallest cmpxchg or ll/sc instruction the backend supports.
virtual Value * emitMaskedAtomicRMWIntrinsic(IRBuilderBase &Builder, AtomicRMWInst *AI, Value *AlignedAddr, Value *Incr, Value *Mask, Value *ShiftAmt, AtomicOrdering Ord) const
Perform a masked atomicrmw using a target-specific intrinsic.
virtual bool areJTsAllowed(const Function *Fn) const
Return true if lowering to a jump table is allowed.
virtual LegalizeAction getCustomTruncStoreAction(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace) const
Returns an alternative action to use when the coarser lookups (configured through setTruncStoreAction...
bool enableExtLdPromotion() const
Return true if the target wants to use the optimization that turns ext(promotableInst1(....
virtual bool isFPExtFoldable(const MachineInstr &MI, unsigned Opcode, LLT DestTy, LLT SrcTy) const
Return true if an fpext operation input to an Opcode operation is free (for instance,...
bool isFPImmLegal(const APFloat &Imm, EVT VT, bool ForCodeSize=false) const
Returns true if the specified FP immediate can be materialized without a load from the constant pool.
void setIndexedMaskedLoadAction(unsigned IdxMode, MVT VT, LegalizeAction Action)
Indicate that the specified indexed masked load does or does not work with the specified type and ind...
void setMaxBytesForAlignment(unsigned MaxBytes)
bool isOperationLegalOrPromote(unsigned Op, EVT VT, bool LegalOnly=false) const
Return true if the specified operation is legal on this target or can be made legal using promotion.
void setHasExtractBitsInsn(bool hasExtractInsn=true)
Tells the code generator that the target has BitExtract instructions.
void addBypassSlowDiv(unsigned int SlowBitWidth, unsigned int FastBitWidth)
Tells the code generator which bitwidths to bypass.
virtual bool hasBitTest(SDValue X, SDValue Y) const
Return true if the target has a bit-test instruction: (X & (1 << Y)) ==/!= 0 This knowledge can be us...
MVT getRegisterType(LLVMContext &Context, EVT VT) const
Return the type of registers that this ValueType will eventually require.
virtual AtomicExpansionKind shouldExpandAtomicCmpXchgInIR(const AtomicCmpXchgInst *AI) const
Returns how the given atomic cmpxchg should be expanded by the IR-level AtomicExpand pass.
virtual bool needsFixedCatchObjects() const
virtual bool isAnyExtFree(EVT FromTy, EVT ToTy) const
Return true is an anyext is free from FromTy to ToTy.
EVT getLegalTypeToTransformTo(LLVMContext &Context, EVT VT) const
Perform getTypeToTransformTo repeatedly until a legal type is obtained.
virtual Value * emitLoadLinked(IRBuilderBase &Builder, Type *ValueTy, Value *Addr, AtomicOrdering Ord) const
Perform a load-linked operation on Addr, returning a "Value *" with the corresponding pointee type.
void setMaxLargeFPConvertBitWidthSupported(unsigned SizeInBits)
Set the size in bits of the maximum fp to/from int conversion the backend supports.
const LibcallLoweringInfo & getLibcallLoweringInfo() const
virtual unsigned getNumRegisters(LLVMContext &Context, EVT VT, std::optional< MVT > RegisterVT=std::nullopt) const
Return the number of registers that this ValueType will eventually require.
virtual bool isCheapToSpeculateCttz(Type *Ty) const
Return true if it is cheap to speculate a call to intrinsic cttz.
unsigned getMinimumBitTestCmps() const
Retuen the minimum of largest number of comparisons in BitTest.
bool isJumpExpensive() const
Return true if Flow Control is an expensive operation that should be avoided.
virtual bool useFPRegsForHalfType() const
LegalizeAction getCondCodeAction(ISD::CondCode CC, MVT VT) const
Return how the condition code should be treated: either it is legal, needs to be expanded to some oth...
bool hasExtractBitsInsn() const
Return true if the target has BitExtract instructions.
virtual bool isLoadBitCastBeneficial(EVT LoadVT, EVT BitcastVT, const SelectionDAG &DAG, const MachineMemOperand &MMO) const
Return true if the following transform is beneficial: fold (conv (load x)) -> (load (conv*)x) On arch...
LegalizeAction getIndexedStoreAction(unsigned IdxMode, MVT VT) const
Return how the indexed store should be treated: either it is legal, needs to be promoted to a larger ...
void setIndexedLoadAction(ArrayRef< unsigned > IdxModes, MVT VT, LegalizeAction Action)
Indicate that the specified indexed load does or does not work with the specified type and indicate w...
CallingConv::ID getLibcallImplCallingConv(RTLIB::LibcallImpl Call) const
Get the CallingConv that should be used for the specified libcall implementation.
void setPrefLoopAlignment(Align Alignment)
Set the target's preferred loop alignment.
virtual bool areTwoSDNodeTargetMMOFlagsMergeable(const MemSDNode &NodeX, const MemSDNode &NodeY) const
Return true if it is valid to merge the TargetMMOFlags in two SDNodes.
virtual bool isCommutativeBinOp(unsigned Opcode) const
Returns true if the opcode is a commutative binary operation.
void setMaxAtomicSizeInBitsSupported(unsigned SizeInBits)
Set the maximum atomic operation size supported by the backend.
LegalizeAction getTruncStoreAction(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace) const
Return how this store with truncation should be treated: either it is legal, needs to be promoted to ...
virtual unsigned getPreferredFPToIntOpcode(unsigned Op, EVT FromVT, EVT ToVT) const
virtual bool isExtractVecEltCheap(EVT VT, unsigned Index) const
Return true if extraction of a scalar element from the given vector type at the given index is cheap.
virtual Value * emitCanLoadSpeculatively(IRBuilderBase &Builder, Value *Ptr, Value *Size) const
Emit code to check if a speculative load of the given size from Ptr is safe.
void setOperationAction(ArrayRef< unsigned > Ops, MVT VT, LegalizeAction Action)
virtual bool optimizeFMulOrFDivAsShiftAddBitcast(SDNode *N, SDValue FPConst, SDValue IntPow2) const
SelectSupportKind
Enum that describes what type of support for selects the target has.
RTLIB::LibcallImpl getMemcpyImpl() const
LegalizeAction getIndexedLoadAction(unsigned IdxMode, MVT VT) const
Return how the indexed load should be treated: either it is legal, needs to be promoted to a larger s...
virtual bool shouldTransformSignedTruncationCheck(EVT XVT, unsigned KeptBits) const
Should we tranform the IR-optimal check for whether given truncation down into KeptBits would be trun...
virtual bool isFPExtFoldable(const SelectionDAG &DAG, unsigned Opcode, EVT DestVT, EVT SrcVT) const
Return true if an fpext operation input to an Opcode operation is free (for instance,...
bool isLegalRC(const TargetRegisterInfo &TRI, const TargetRegisterClass &RC) const
Return true if the value types that can be represented by the specified register class are all legal.
virtual TargetLoweringBase::LegalizeTypeAction getPreferredVectorAction(MVT VT) const
Return the preferred vector type legalization action.
virtual bool allowTruncateForTailCall(Type *FromTy, Type *ToTy) const
Return true if a truncation from FromTy to ToTy is permitted when deciding whether a call is in tail ...
void setAtomicLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT, LegalizeAction Action)
Let target indicate that an extending atomic load of the specified type is legal.
virtual bool shouldExtendGSIndex(EVT VT, EVT &EltTy) const
Returns true if the index type for a masked gather/scatter requires extending.
virtual unsigned getVectorTypeBreakdownForCallingConv(LLVMContext &Context, CallingConv::ID CC, EVT VT, EVT &IntermediateVT, unsigned &NumIntermediates, MVT &RegisterVT) const
Certain targets such as MIPS require that some types such as vectors are always broken down into scal...
Register getStackPointerRegisterToSaveRestore() const
If a physical register, this specifies the register that llvm.savestack/llvm.restorestack should save...
virtual StringRef getStackProbeSymbolName(const MachineFunction &MF) const
LegalizeAction getFixedPointOperationAction(unsigned Op, EVT VT, unsigned Scale) const
Some fixed point operations may be natively supported by the target but only for specific scales.
virtual bool preferScalarizeSplat(SDNode *N) const
void setVectorInterleaveAction(unsigned Opc, unsigned Factor, MVT VT, LegalizeAction Action)
Indicate how a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the given interleave factor Factor ...
bool isIndexedMaskedLoadLegal(unsigned IdxMode, EVT VT) const
Return true if the specified indexed load is legal on this target.
virtual ISD::NodeType getExtendForAtomicOps() const
Returns how the platform's atomic operations are extended (ZERO_EXTEND, SIGN_EXTEND,...
Sched::Preference getSchedulingPreference() const
Return target scheduling preference.
virtual bool allowsMisalignedMemoryAccesses(EVT, unsigned AddrSpace=0, Align Alignment=Align(1), MachineMemOperand::Flags Flags=MachineMemOperand::MONone, unsigned *=nullptr) const
Determine if the target supports unaligned memory accesses.
virtual LLT getOptimalMemOpLLT(const MemOp &Op, const AttributeList &) const
LLT returning variant.
void setMinFunctionAlignment(Align Alignment)
Set the target's minimum function alignment.
bool isOperationCustom(unsigned Op, EVT VT) const
Return true if the operation uses custom lowering, regardless of whether the type is legal or not.
virtual ExtractSubvectorCost getExtractSubvectorCost(EVT ResVT, EVT SrcVT, unsigned Index) const
Return the cost of extracting a subvector of type ResVT from a vector of type SrcVT,...
virtual void emitExpandAtomicRMW(AtomicRMWInst *AI) const
Perform a atomicrmw expansion using a target-specific way.
unsigned MaxStoresPerMemsetOptSize
Likewise for functions with the OptSize attribute.
virtual bool reduceSelectOfFPConstantLoads(EVT CmpOpVT) const
Return true if it is profitable to convert a select of FP constants into a constant pool load whose a...
bool hasBigEndianPartOrdering(EVT VT, const DataLayout &DL) const
When splitting a value of the specified type into parts, does the Lo or Hi part come first?
virtual bool hasStackProbeSymbol(const MachineFunction &MF) const
Returns the name of the symbol used to emit stack probes or the empty string if not applicable.
bool isSlowDivBypassed() const
Returns true if target has indicated at least one type should be bypassed.
virtual Align getABIAlignmentForCallingConv(Type *ArgTy, const DataLayout &DL) const
Certain targets have context sensitive alignment requirements, where one type has the alignment requi...
virtual bool isMulAddWithConstProfitable(SDValue AddNode, SDValue ConstNode) const
Return true if it may be profitable to transform (mul (add x, c1), c2) -> (add (mul x,...
virtual bool shouldExtendTypeInLibCall(EVT Type) const
Returns true if arguments should be extended in lib calls.
void setBooleanContents(BooleanContent Ty)
Specify how the target extends the result of integer and floating point boolean values from i1 to a w...
void setVectorInterleaveAction(ArrayRef< unsigned > Opcodes, ArrayRef< unsigned > Factors, MVT VT, LegalizeAction Action)
bool isPartialReduceMLALegalOrCustom(unsigned Opc, EVT AccVT, EVT InputVT) const
Return true if a PARTIAL_REDUCE_U/SMLA node with the specified types is legal or custom for this targ...
virtual bool isFsqrtCheap(SDValue X, SelectionDAG &DAG) const
Return true if SQRT(X) shouldn't be replaced with X*RSQRT(X).
unsigned MaxStoresPerMemmove
Specify maximum number of store instructions per memmove call.
virtual bool shouldNormalizeToSelectSequence(LLVMContext &Context, EVT VT, EVT CCVT) const
Returns true if we should normalize select(N0&N1, X, Y) => select(N0, select(N1, X,...
bool isSuitableForBitTests(const DenseMap< const BasicBlock *, unsigned int > &DestCmps, const APInt &Low, const APInt &High, const DataLayout &DL) const
Return true if lowering to a bit test is suitable for a set of case clusters which contains NumDests ...
virtual bool shouldExpandGetActiveLaneMask(EVT VT, EVT OpVT) const
Return true if the @llvm.get.active.lane.mask intrinsic should be expanded using generic code in Sele...
virtual bool shallExtractConstSplatVectorElementToStore(Type *VectorTy, unsigned ElemSizeInBits, unsigned &Index) const
Return true if the target shall perform extract vector element and store given that the vector is kno...
virtual bool isTruncateFree(Type *FromTy, Type *ToTy) const
Return true if it's free to truncate a value of type FromTy to type ToTy.
virtual bool hasMultipleConditionRegisters(EVT VT) const
Does the target have multiple (allocatable) condition registers that can be used to store the results...
unsigned getMaxExpandSizeMemcmp(bool OptSize) const
Get maximum # of load operations permitted for memcmp.
bool isStrictFPEnabled() const
Return true if the target support strict float operation.
virtual bool shouldAvoidTransformToShift(EVT VT, unsigned Amount) const
Return true if creating a shift of the type by the given amount is not profitable.
virtual bool shouldPreservePtrArith(const Function &F, EVT PtrVT) const
True if target has some particular form of dealing with pointer arithmetic semantics for pointers wit...
virtual bool isFPExtFree(EVT DestVT, EVT SrcVT) const
Return true if an fpext operation is free (for instance, because single-precision floating-point numb...
virtual EVT getSetCCResultType(const DataLayout &DL, LLVMContext &Context, EVT VT) const
Return the ValueType of the result of SETCC operations.
virtual bool lowerInterleavedStore(Instruction *Store, Value *Mask, ShuffleVectorInst *SVI, unsigned Factor, const APInt &GapMask) const
Lower an interleaved store to target specific intrinsics.
virtual EVT getTypeToTransformTo(LLVMContext &Context, EVT VT) const
For types supported by the target, this is an identity function.
unsigned MaxStoresPerMemmoveOptSize
Likewise for functions with the OptSize attribute.
virtual bool shouldFoldSelectWithSingleBitTest(EVT VT, const APInt &AndMask) const
MVT getSimpleValueType(const DataLayout &DL, Type *Ty, bool AllowUnknown=false) const
Return the MVT corresponding to this LLVM type. See getValueType.
BooleanContent getBooleanContents(bool isVec, bool isFloat) const
For targets without i1 registers, this gives the nature of the high-bits of boolean values held in ty...
bool isVectorInterleaveLegalOrCustom(unsigned Opc, unsigned Factor, EVT VT) const
Return true if a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the given interleave factor and f...
LegalizeAction getVectorInterleaveAction(unsigned Opc, unsigned Factor, EVT VT) const
Return how a VECTOR_INTERLEAVE or VECTOR_DEINTERLEAVE node with the given interleave factor and VT sh...
virtual bool shouldReassociateReduction(unsigned RedOpc, EVT VT) const
void addRegisterClass(MVT VT, const TargetRegisterClass *RC)
Add the specified register class as an available regclass for the specified value type.
virtual CondMergingParams getJumpConditionMergingParams(Instruction::BinaryOps, const Value *, const Value *, const Function *) const
bool isCondCodeLegal(ISD::CondCode CC, MVT VT) const
Return true if the specified condition code is legal for a comparison of the specified types on this ...
virtual bool canCombineStoreAndExtract(Type *VectorTy, Value *Idx, unsigned &Cost) const
Return true if the target can combine store(extractelement VectorTy,Idx).
bool isTypeLegal(EVT VT) const
Return true if the target has native support for the specified value type.
virtual bool shouldFoldConstantShiftPairToMask(const SDNode *N) const
Return true if it is profitable to fold a pair of shifts into a mask.
MVT getProgramPointerTy(const DataLayout &DL) const
Return the type for code pointers, which is determined by the program address space specified through...
void setIndexedStoreAction(ArrayRef< unsigned > IdxModes, MVT VT, LegalizeAction Action)
Indicate that the specified indexed store does or does not work with the specified type and indicate ...
ExtractSubvectorCost
Enum that specifies how expensive lowering an EXTRACT_SUBVECTOR is.
virtual void emitAtomicCmpXchgNoStoreLLBalance(IRBuilderBase &Builder) const
void setSupportsUnalignedAtomics(bool UnalignedSupported)
Sets whether unaligned atomic operations are supported.
void setLoadExtAction(ArrayRef< unsigned > ExtTypes, MVT ValVT, ArrayRef< MVT > MemVTs, LegalizeAction Action)
virtual void emitExpandAtomicStore(StoreInst *SI) const
Perform a atomic store using a target-specific way.
virtual bool preferIncOfAddToSubOfNot(EVT VT) const
These two forms are equivalent: sub y, (xor x, -1) add (add x, 1), y The variant with two add's is IR...
virtual bool ShouldShrinkFPConstant(EVT) const
If true, then instruction selection should seek to shrink the FP constant of the specified type to a ...
virtual MVT getPointerTy(const DataLayout &DL, uint32_t AS=0) const
Return the pointer type for the given address space, defaults to the pointer type from the data layou...
void setPrefFunctionAlignment(Align Alignment)
Set the target's preferred function alignment.
unsigned getMaxDivRemBitWidthSupported() const
Returns the size in bits of the maximum div/rem the backend supports.
virtual bool isLegalAddImmediate(int64_t) const
Return true if the specified immediate is legal add immediate, that is the target has add instruction...
virtual unsigned getMaxSupportedInterleaveFactor() const
Get the maximum supported factor for interleaved memory accesses.
virtual FPImmAction getFPImmAction(const APFloat &, LLT, bool ForCodeSize=false) const
Returns how the legalizer should materialize the specified FP immediate.
bool isOperationLegal(unsigned Op, EVT VT) const
Return true if the specified operation is legal on this target.
virtual bool shouldKeepZExtForFP16Conv() const
Does this target require the clearing of high-order bits in a register passed to the fp16 to fp conve...
virtual AtomicExpansionKind shouldCastAtomicRMWIInIR(AtomicRMWInst *RMWI) const
Returns how the given atomic atomicrmw should be cast by the IR-level AtomicExpand pass.
void setIndexedMaskedStoreAction(unsigned IdxMode, MVT VT, LegalizeAction Action)
Indicate that the specified indexed masked store does or does not work with the specified type and in...
virtual bool canTransformPtrArithOutOfBounds(const Function &F, EVT PtrVT) const
True if the target allows transformations of in-bounds pointer arithmetic that cause out-of-bounds in...
virtual bool shouldConsiderGEPOffsetSplit() const
const ValueTypeActionImpl & getValueTypeActions() const
virtual bool canCombineTruncStore(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace, bool LegalOnly) const
TargetLoweringBase(const TargetMachine &TM, const TargetSubtargetInfo &STI)
NOTE: The TargetMachine owns TLOF.
unsigned MaxStoresPerMemset
Specify maximum number of store instructions per memset call.
virtual bool isTruncateFree(SDValue Val, EVT VT2) const
Return true if truncating the specific node Val to type VT2 is free.
virtual bool isProfitableToCombineMinNumMaxNum(EVT VT) const
virtual unsigned getCustomCtpopCost(EVT VT, ISD::CondCode Cond) const
Return the maximum number of "x & (x - 1)" operations that can be done instead of deferring to a cust...
virtual bool shouldProduceAndByConstByHoistingConstFromShiftsLHSOfAnd(SDValue X, ConstantSDNode *XC, ConstantSDNode *CC, SDValue Y, unsigned OldShiftOpcode, unsigned NewShiftOpcode, SelectionDAG &DAG) const
Given the pattern (X & (C l>>/<< Y)) ==/!= 0 return true if it should be transformed into: ((X <</l>>...
virtual bool shouldInsertTrailingSeqCstFenceForAtomicStore(const Instruction *I) const
Whether AtomicExpandPass should automatically insert a seq_cst trailing fence without reducing the or...
virtual bool isFNegFree(EVT VT) const
Return true if an fneg operation is free to the point where it is never worthwhile to replace it with...
void setPartialReduceMLAAction(unsigned Opc, MVT AccVT, MVT InputVT, LegalizeAction Action)
Indicate how a PARTIAL_REDUCE_U/SMLA node with Acc type AccVT and Input type InputVT should be treate...
virtual AtomicExpansionKind shouldExpandAtomicLoadInIR(LoadInst *LI) const
Returns how the given (atomic) load should be expanded by the IR-level AtomicExpand pass.
FPImmAction
How the legalizer should materialize a floating-point immediate.
@ ConstantPool
Load the immediate from the constant pool.
@ Bitcast
Build the immediate as a bitcast of an integer constant with the same bits.
void setTruncStoreAction(MVT ValVT, MVT MemVT, LegalizeAction Action)
Indicate that the specified truncating store does not work with the specified type and indicate what ...
bool isExtFree(const Instruction *I) const
Return true if the extension represented by I is free.
virtual MVT getFenceOperandTy(const DataLayout &DL) const
Return the type for operands of fence.
virtual Value * emitMaskedAtomicCmpXchgIntrinsic(IRBuilderBase &Builder, AtomicCmpXchgInst *CI, Value *AlignedAddr, Value *CmpVal, Value *NewVal, Value *Mask, AtomicOrdering Ord) const
Perform a masked cmpxchg using a target-specific intrinsic.
virtual bool isZExtFree(EVT FromTy, EVT ToTy) const
virtual ISD::NodeType getExtendForAtomicCmpSwapArg() const
Returns how the platform's atomic compare and swap expects its comparison value to be extended (ZERO_...
virtual bool shouldFoldSelectWithIdentityConstant(unsigned BinOpcode, EVT VT, unsigned SelectOpcode, SDValue X, SDValue Y) const
Return true if pulling a binary operation into a select with an identity constant is profitable.
BooleanContent
Enum that describes how the target represents true/false values.
virtual bool shouldExpandGetVectorLength(EVT CountVT, unsigned VF, bool IsScalable) const
virtual bool isIntDivCheap(EVT VT, AttributeList Attr) const
Return true if integer divide is usually cheaper than a sequence of several shifts,...
virtual ShiftLegalizationStrategy preferredShiftLegalizationStrategy(SelectionDAG &DAG, SDNode *N, unsigned ExpansionFactor) const
virtual uint8_t getRepRegClassCostFor(MVT VT) const
Return the cost of the 'representative' register class for the specified value type.
virtual bool isZExtFree(LLT FromTy, LLT ToTy, LLVMContext &Ctx) const
bool isOperationLegalOrCustom(unsigned Op, EVT VT, bool LegalOnly=false) const
Return true if the specified operation is legal on this target or can be made legal with custom lower...
LegalizeAction getPartialReduceMLAAction(unsigned Opc, EVT AccVT, EVT InputVT) const
Return how a PARTIAL_REDUCE_U/SMLA node with Acc type AccVT and Input type InputVT should be treated.
bool isPredictableSelectExpensive() const
Return true if selects are only cheaper than branches if the branch is unlikely to be predicted right...
virtual bool mergeStoresAfterLegalization(EVT MemVT) const
Allow store merging for the specified type after legalization in addition to before legalization.
unsigned getVectorTypeBreakdown(LLVMContext &Context, EVT VT, EVT &IntermediateVT, unsigned &NumIntermediates, MVT &RegisterVT) const
Vector types are broken down into some number of legal first class types.
virtual bool shouldIssueAtomicLoadForAtomicEmulationLoop(void) const
virtual bool shouldMergeStoreOfLoadsOverCall(EVT, EVT) const
Returns true if it's profitable to allow merging store of loads when there are functions calls betwee...
virtual bool isProfitableToHoist(Instruction *I) const
unsigned getGatherAllAliasesMaxDepth() const
virtual LegalizeAction getCustomOperationAction(SDNode &Op) const
How to legalize this custom operation?
virtual bool isFMAFasterThanFMulAndFAdd(const Function &F, Type *) const
IR version.
virtual bool hasAndNotCompare(SDValue Y) const
Return true if the target should transform: (X & Y) == Y ---> (~X & Y) == 0 (X & Y) !...
virtual bool storeOfVectorConstantIsCheap(bool IsZero, EVT MemVT, unsigned NumElem, unsigned AddrSpace) const
Return true if it is expected to be cheaper to do a store of vector constant with the given size and ...
unsigned MaxLoadsPerMemcmpOptSize
Likewise for functions with the OptSize attribute.
virtual MVT hasFastEqualityCompare(unsigned NumBits) const
Return the preferred operand type if the target has a quick way to compare integer values of the give...
virtual const TargetRegisterClass * getRepRegClassFor(MVT VT) const
Return the 'representative' register class for the specified value type.
virtual bool isNarrowingProfitable(SDNode *N, EVT SrcVT, EVT DestVT) const
Return true if it's profitable to narrow operations of type SrcVT to DestVT.
LegalizeAction getLoadAction(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace, unsigned ExtType, bool Atomic) const
Return how this load with extension should be treated: either it is legal, needs to be promoted to a ...
virtual bool isMultiStoresCheaperThanBitsMerge(EVT LTy, EVT HTy) const
Return true if it is cheaper to split the store of a merged int val from a pair of smaller values int...
bool shouldUseDynamicVectorTypeBreakdown(EVT VT, bool ForCallingConv) const
TargetLoweringBase(const TargetLoweringBase &)=delete
EVT getTypeToWidenTo(LLVMContext &Context, EVT VT) const
For vector types that are widened, this returns the type reached by widening repeatedly,...
virtual unsigned getMaxGluedStoresPerMemcpy() const
Get maximum # of store operations to be glued together.
virtual bool isBinOp(unsigned Opcode) const
Return true if the node is a math/logic binary operator.
virtual bool shouldFoldMaskToVariableShiftPair(SDValue X) const
There are two ways to clear extreme bits (either low or high): Mask: x & (-1 << y) (the instcombine c...
virtual bool alignLoopsWithOptSize() const
Should loops be aligned even when the function is marked OptSize (but not MinSize).
unsigned getMaxAtomicSizeInBitsSupported() const
Returns the maximum atomic operation size (in bits) supported by the backend.
virtual FPImmAction getFPImmAction(const APFloat &, EVT, bool ForCodeSize=false) const
Returns how the legalizer should materialize the specified FP immediate.
bool isIndexedLoadLegal(unsigned IdxMode, EVT VT) const
Return true if the specified indexed load is legal on this target.
void setMinCmpXchgSizeInBits(unsigned SizeInBits)
Sets the minimum cmpxchg or ll/sc size supported by the backend.
virtual bool canMergeStoresTo(unsigned AS, EVT MemVT, const MachineFunction &MF) const
Returns if it's reasonable to merge stores to MemVT size.
void setPartialReduceMLAAction(ArrayRef< unsigned > Opcodes, MVT AccVT, MVT InputVT, LegalizeAction Action)
LegalizeAction getStrictFPOperationAction(unsigned Op, EVT VT) const
void setStackPointerRegisterToSaveRestore(Register R)
If set to a physical register, this specifies the register that llvm.savestack/llvm....
virtual bool preferABDSToABSWithNSW(EVT VT) const
void AddPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT)
If Opc/OrigVT is specified as being promoted, the promotion code defaults to trying a larger integer/...
virtual bool getAddrModeArguments(const IntrinsicInst *, SmallVectorImpl< Value * > &, Type *&) const
CodeGenPrepare sinks address calculations into the same BB as Load/Store instructions reading the add...
virtual bool hasInlineStackProbe(const MachineFunction &MF) const
AtomicExpansionKind
Enum that specifies what an atomic load/AtomicRMWInst is expanded to, if at all.
void setCondCodeAction(ArrayRef< ISD::CondCode > CCs, MVT VT, LegalizeAction Action)
Indicate that the specified condition code is or isn't supported on the target and indicate what to d...
void setBooleanContents(BooleanContent IntTy, BooleanContent FloatTy)
Specify how the target extends the result of integer and floating point boolean values from i1 to a w...
const DenseMap< unsigned int, unsigned int > & getBypassSlowDivWidths() const
Returns map of slow types for division or remainder with corresponding fast types.
void setOperationPromotedToType(ArrayRef< unsigned > Ops, MVT OrigVT, MVT DestVT)
unsigned getMaxLargeFPConvertBitWidthSupported() const
Returns the size in bits of the maximum fp to/from int conversion the backend supports.
virtual bool isFMAFasterThanFMulAndFAdd(const MachineFunction &MF, LLT) const
Return true if an FMA operation is faster than a pair of fmul and fadd instructions.
virtual bool isTruncateFree(EVT FromVT, EVT ToVT) const
bool isTruncStoreLegal(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace) const
Return true if the specified store with truncation is legal on this target.
virtual bool isCheapToSpeculateCtlz(Type *Ty) const
Return true if it is cheap to speculate a call to intrinsic ctlz.
virtual void getTgtMemIntrinsic(SmallVectorImpl< IntrinsicInfo > &Infos, const CallBase &I, MachineFunction &MF, unsigned Intrinsic) const
Given an intrinsic, checks if on the target the intrinsic will need to map to a MemIntrinsicNode (tou...
virtual bool signExtendConstant(const ConstantInt *C) const
Return true if this constant should be sign extended when promoting to a larger type.
virtual bool lowerInterleaveIntrinsicToStore(Instruction *Store, Value *Mask, ArrayRef< Value * > InterleaveValues) const
Lower an interleave intrinsic to a target specific store intrinsic.
virtual bool isTruncateFree(LLT FromTy, LLT ToTy, LLVMContext &Ctx) const
AndOrSETCCFoldKind
Enum of different potentially desirable ways to fold (and/or (setcc ...), (setcc ....
virtual bool shouldScalarizeBinop(SDValue VecOp) const
Try to convert an extract element of a vector binary operation into an extract element followed by a ...
Align getPrefFunctionAlignment() const
Return the preferred function alignment.
RTLIB::LibcallImpl getLibcallImpl(RTLIB::Libcall Call) const
Get the libcall impl routine name for the specified libcall.
virtual void emitExpandAtomicLoad(LoadInst *LI) const
Perform a atomic load using a target-specific way.
Align getMinFunctionAlignment() const
Return the minimum function alignment.
virtual AtomicExpansionKind shouldExpandAtomicStoreInIR(StoreInst *SI) const
Returns how the given (atomic) store should be expanded by the IR-level AtomicExpand pass into.
virtual bool preferVectorizedNonPowerOfTwoTypeBreakdown() const
Return true if fixed-length, non-power-of-two vectors should be broken down into legal vector parts i...
static StringRef getLibcallImplName(RTLIB::LibcallImpl Call)
Get the libcall routine name for the specified libcall implementation.
void setTargetDAGCombine(ArrayRef< ISD::NodeType > NTs)
Targets should invoke this method for each target independent node that they want to provide a custom...
virtual bool isCtlzFast() const
Return true if ctlz instruction is fast.
virtual bool useSoftFloat() const
virtual bool isStoreBitCastBeneficial(EVT StoreVT, EVT BitcastVT, const SelectionDAG &DAG, const MachineMemOperand &MMO) const
Return true if the following transform is beneficial: (store (y (conv x)), y*)) -> (store x,...
BooleanContent getBooleanContents(EVT Type) const
virtual LegalizeAction getCustomLoadAction(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace, unsigned ExtType, bool Atomic) const
Returns an alternative action to use when the coarser lookups (configured through setLoadExtAction an...
bool isIndexedMaskedStoreLegal(unsigned IdxMode, EVT VT) const
Return true if the specified indexed load is legal on this target.
virtual int64_t getPreferredLargeGEPBaseOffset(int64_t MinOffset, int64_t MaxOffset) const
Return the prefered common base offset.
virtual bool isVectorClearMaskLegal(ArrayRef< int >, EVT) const
Similar to isShuffleMaskLegal.
LegalizeKind getTypeConversion(LLVMContext &Context, EVT VT) const
Return pair that represents the legalization kind (first) that needs to happen to EVT (second) in ord...
Align getMinStackArgumentAlignment() const
Return the minimum stack alignment of an argument.
virtual bool shouldUseStrictFP_TO_INT(EVT FpVT, EVT IntVT, bool IsSigned) const
Return true if it is more correct/profitable to use strict FP_TO_INT conversion operations - canonica...
void setLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT, LegalizeAction Action)
Indicate that the specified load with extension does not work with the specified type and indicate wh...
bool hasTargetDAGCombine(ISD::NodeType NT) const
If true, the target has custom DAG combine transformations that it can perform for the specified node...
void setLibcallImpl(RTLIB::Libcall Call, RTLIB::LibcallImpl Impl)
virtual bool fallBackToDAGISel(const Instruction &Inst) const
unsigned GatherAllAliasesMaxDepth
Depth that GatherAllAliases should continue looking for chain dependencies when trying to find a more...
virtual bool shouldSplatInsEltVarIndex(EVT) const
Return true if inserting a scalar into a variable element of an undef vector is more efficiently hand...
LegalizeAction getIndexedMaskedLoadAction(unsigned IdxMode, MVT VT) const
Return how the indexed load should be treated: either it is legal, needs to be promoted to a larger s...
NegatibleCost
Enum that specifies when a float negation is beneficial.
LegalizeTypeAction getTypeAction(LLVMContext &Context, EVT VT) const
Return how we should legalize values of this type, either it is already legal (return 'Legal') or we ...
virtual unsigned preferedOpcodeForCmpEqPiecesOfOperand(EVT VT, unsigned ShiftOpc, bool MayTransformRotate, const APInt &ShiftOrRotateAmt, const std::optional< APInt > &AndMask) const
virtual bool fenceClearsLoadLinkedReservation() const
Whether a fence between the load-linked and the store-conditional can clear the reservation.
virtual void emitCmpArithAtomicRMWIntrinsic(AtomicRMWInst *AI) const
Perform a atomicrmw which the result is only used by comparison, using a target-specific intrinsic.
virtual bool shouldSignExtendTypeInLibCall(Type *Ty, bool IsSigned) const
Returns true if arguments should be sign-extended in lib calls.
virtual bool optimizeVectorCrossLaneOperation(Instruction *I, Loop *L) const
virtual bool isFMADLegal(const MachineInstr &MI, LLT Ty) const
Returns true if MI can be combined with another instruction to form TargetOpcode::G_FMAD.
void setCondCodeAction(ArrayRef< ISD::CondCode > CCs, ArrayRef< MVT > VTs, LegalizeAction Action)
const char * getLibcallName(RTLIB::Libcall Call) const
Get the libcall routine name for the specified libcall.
virtual bool isLegalAddScalableImmediate(int64_t) const
Return true if adding the specified scalable immediate is legal, that is the target has add instructi...
std::vector< ArgListEntry > ArgListTy
virtual bool shouldAlignPointerArgs(CallInst *, unsigned &, Align &) const
Return true if the pointer arguments to CI should be aligned by aligning the object whose address is ...
virtual bool hasVectorBlend() const
Return true if the target has a vector blend instruction.
virtual AtomicExpansionKind shouldCastAtomicStoreInIR(StoreInst *SI) const
Returns how the given (atomic) store should be cast by the IR-level AtomicExpand pass into.
bool isTruncStoreLegalOrCustom(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace) const
Return true if the specified store with truncation has solution on this target.
void setIndexedStoreAction(ArrayRef< unsigned > IdxModes, ArrayRef< MVT > VTs, LegalizeAction Action)
virtual bool aggressivelyPreferBuildVectorSources(EVT VecVT) const
virtual Register getExceptionPointerRegister(ExceptionHandling EH, const Constant *PersonalityFn) const
If a physical register, this returns the register that receives the exception address on entry to an ...
virtual MachineMemOperand::Flags getTargetMMOFlags(const MemSDNode &Node) const
This callback is used to inspect load/store SDNode.
virtual EVT getOptimalMemOpType(LLVMContext &Context, const MemOp &Op, const AttributeList &) const
Returns the target specific optimal type for load and store operations as a result of memset,...
virtual Type * shouldConvertSplatType(ShuffleVectorInst *SVI) const
Given a shuffle vector SVI representing a vector splat, return a new scalar type of size equal to SVI...
virtual bool isZExtFree(SDValue Val, EVT VT2) const
Return true if zero-extending the specific node Val to type VT2 is free (either because it's implicit...
void setAtomicLoadExtAction(ArrayRef< unsigned > ExtTypes, MVT ValVT, MVT MemVT, LegalizeAction Action)
virtual bool shouldRemoveExtendFromGSIndex(SDValue Extend, EVT DataVT) const
virtual LLVM_READONLY LLT getPreferredShiftAmountTy(LLT ShiftValueTy) const
Return the preferred type to use for a shift opcode, given the shifted amount type is ShiftValueTy.
bool isBeneficialToExpandPowI(int64_t Exponent, bool OptForSize) const
Return true if it is beneficial to expand an @llvm.powi.
LLT getVectorIdxLLT(const DataLayout &DL) const
Returns the type to be used for the index operand of: G_INSERT_VECTOR_ELT, G_EXTRACT_VECTOR_ELT,...
virtual EVT getAsmOperandValueType(const DataLayout &DL, Type *Ty, bool AllowUnknown=false) const
void setIndexedLoadAction(ArrayRef< unsigned > IdxModes, ArrayRef< MVT > VTs, LegalizeAction Action)
virtual AtomicExpansionKind shouldCastAtomicLoadInIR(LoadInst *LI) const
Returns how the given (atomic) load should be cast by the IR-level AtomicExpand pass.
bool isCondCodeLegalOrCustom(ISD::CondCode CC, MVT VT) const
Return true if the specified condition code is legal or custom for a comparison of the specified type...
virtual bool isComplexDeinterleavingSupported() const
Does this target support complex deinterleaving.
unsigned MaxStoresPerMemcpy
Specify maximum number of store instructions per memcpy call.
MVT getFrameIndexTy(const DataLayout &DL) const
Return the type for frame index, which is determined by the alloca address space specified through th...
virtual MVT getPointerMemTy(const DataLayout &DL, uint32_t AS=0) const
Return the in-memory pointer type for the given address space, defaults to the pointer type from the ...
bool isLoadLegal(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace, unsigned ExtType, bool Atomic) const
Return true if the specified load with extension is legal on this target.
void setSchedulingPreference(Sched::Preference Pref)
Specify the target scheduling preference.
virtual bool addressingModeSupportsTLS(const GlobalValue &) const
Returns true if the targets addressing mode can target thread local storage (TLS).
bool isLoadLegalOrCustom(EVT ValVT, EVT MemVT, Align Alignment, unsigned AddrSpace, unsigned ExtType, bool Atomic) const
Return true if the specified load with extension is legal or custom on this target.
virtual bool shouldConvertPhiType(Type *From, Type *To) const
Given a set in interconnected phis of type 'From' that are loaded/stored or bitcast to type 'To',...
virtual bool isFAbsFree(EVT VT) const
Return true if an fabs operation is free to the point where it is never worthwhile to replace it with...
virtual bool isLegalStoreImmediate(int64_t Value) const
Return true if the specified immediate is legal for the value input of a store instruction.
virtual bool preferZeroCompareBranch() const
Return true if the heuristic to prefer icmp eq zero should be used in code gen prepare.
LegalizeAction getOperationAction(unsigned Op, EVT VT) const
Return how this operation should be treated: either it is legal, needs to be promoted to a larger siz...
virtual bool lowerInterleavedLoad(Instruction *Load, Value *Mask, ArrayRef< ShuffleVectorInst * > Shuffles, ArrayRef< unsigned > Indices, unsigned Factor, const APInt &GapMask) const
Lower an interleaved load to target specific intrinsics.
virtual unsigned getVectorIdxWidth(const DataLayout &DL) const
Returns the type to be used for the index operand vector operations.
MVT getTypeToPromoteTo(unsigned Op, MVT VT) const
If the action for this operation is to promote, this method returns the ValueType to promote to.
virtual bool generateFMAsInMachineCombiner(EVT VT, CodeGenOptLevel OptLevel) const
virtual LoadInst * lowerIdempotentRMWIntoFencedLoad(AtomicRMWInst *RMWI) const
On some platforms, an AtomicRMW that never actually modifies the value (such as fetch_add of 0) can b...
virtual bool isLegalAddressingMode(const DataLayout &DL, const AddrMode &AM, Type *Ty, unsigned AddrSpace, Instruction *I=nullptr) const
Return true if the addressing mode represented by AM is legal for this target, for a load/store of th...
virtual bool hasPairedLoad(EVT, Align &) const
Return true if the target supplies and combines to a paired load two loaded values of type LoadedType...
virtual bool convertSelectOfConstantsToMath(EVT VT) const
Return true if a select of constants (select Cond, C1, C2) should be transformed into simple math ops...
bool isOperationLegalOrCustomOrPromote(unsigned Op, EVT VT, bool LegalOnly=false) const
Return true if the specified operation is legal on this target or can be made legal with custom lower...
virtual bool optimizeExtendOrTruncateConversion(Instruction *I, Loop *L, const TargetTransformInfo &TTI) const
Try to optimize extending or truncating conversion instructions (like zext, trunc,...
virtual MVT getVPExplicitVectorLengthTy() const
Returns the type to be used for the EVL/AVL operand of VP nodes: ISD::VP_UDIV, ISD::VP_SDIV,...
std::pair< LegalizeTypeAction, EVT > LegalizeKind
LegalizeKind holds the legalization kind that needs to happen to EVT in order to type-legalize it.
TargetLoweringBase & operator=(const TargetLoweringBase &)=delete
MulExpansionKind
Enum that specifies when a multiplication should be expanded.
static ISD::NodeType getExtendForContent(BooleanContent Content)
const RTLIB::RuntimeLibcallsInfo & getRuntimeLibcallsInfo() const
virtual bool shouldConvertFpToSat(unsigned Op, EVT FPVT, EVT VT) const
Should we generate fp_to_si_sat and fp_to_ui_sat from type FPVT to type VT.
virtual bool supportKCFIBundles() const
Return true if the target supports kcfi operand bundles.
virtual ConstraintWeight getMultipleConstraintMatchWeight(AsmOperandInfo &info, int maIndex) const
Examine constraint type and operand type and determine a weight value.
SmallVector< ConstraintPair > ConstraintGroup
virtual SDValue getSqrtEstimate(SDValue Operand, SelectionDAG &DAG, int Enabled, int &RefinementSteps, bool &UseOneConstNR, bool Reciprocal) const
Hooks for building estimates in place of slower divisions and square roots.
virtual bool isDesirableToCommuteWithShift(const MachineInstr &MI, bool IsAfterLegal) const
GlobalISel - return true if it is profitable to move this shift by a constant amount through its oper...
virtual bool supportPtrAuthBundles() const
Return true if the target supports ptrauth operand bundles.
virtual void ReplaceNodeResults(SDNode *, SmallVectorImpl< SDValue > &, SelectionDAG &) const
This callback is invoked when a node result type is illegal for the target, and the operation was reg...
virtual bool isUsedByReturnOnly(SDNode *, SDValue &) const
Return true if result of the specified node is used by a return node only.
virtual bool supportSwiftError() const
Return true if the target supports swifterror attribute.
virtual SDValue visitMaskedLoad(SelectionDAG &DAG, const SDLoc &DL, SDValue Chain, MachineMemOperand *MMO, SDValue &NewLoad, SDValue Ptr, SDValue PassThru, SDValue Mask) const
virtual unsigned getPreferredShrunkVectorSizeInBits(SDValue Op, const APInt &DemandedElts) const
If only low elements of a vector are demanded, shrink the operation to the returned size in bits by c...
SDValue getNegatedExpression(SDValue Op, SelectionDAG &DAG, bool LegalOps, bool OptForSize, unsigned Depth=0) const
This is the helper function to return the newly negated expression if the cost is not expensive.
virtual bool isProfitableToFoldVScaleAdd(SDValue N) const
fold (A + vscale(C1)) + vscale(C2) -> A + vscale(C1+C2) If (A + vscale(C1)) is used multiple times,...
virtual bool isReassocProfitable(SelectionDAG &DAG, SDValue N0, SDValue N1) const
virtual bool isTypeDesirableForOp(SDNode *N, EVT VT) const
Overload that takes the specific node being optimized.
virtual EVT getTypeForExtReturn(LLVMContext &Context, EVT VT, ISD::NodeType) const
Return the type that should be used to zero or sign extend a zeroext/signext integer return value.
SDValue getCheaperOrNeutralNegatedExpression(SDValue Op, SelectionDAG &DAG, bool LegalOps, bool OptForSize, const NegatibleCost CostThreshold=NegatibleCost::Neutral, unsigned Depth=0) const
virtual Register getRegisterByName(const char *RegName, LLT Ty, const MachineFunction &MF) const
Return the register ID of the name passed in.
virtual InlineAsm::ConstraintCode getInlineAsmMemConstraint(StringRef ConstraintCode) const
virtual bool targetShrinkDemandedConstant(SDValue Op, const APInt &DemandedBits, const APInt &DemandedElts, TargetLoweringOpt &TLO) const
std::vector< AsmOperandInfo > AsmOperandInfoVector
virtual bool isTargetCanonicalConstantNode(SDValue Op) const
Returns true if the given Opc is considered a canonical constant for the target, which should not be ...
virtual bool isTargetCanonicalSelect(SDNode *N) const
Return true if the given select/vselect should be considered canonical and not be transformed.
SDValue getCheaperNegatedExpression(SDValue Op, SelectionDAG &DAG, bool LegalOps, bool OptForSize, unsigned Depth=0) const
This is the helper function to return the newly negated expression only when the cost is cheaper.
virtual SDValue prepareVolatileOrAtomicLoad(SDValue Chain, const SDLoc &DL, SelectionDAG &DAG) const
This callback is used to prepare for a volatile or atomic load.
virtual SDValue emitStackGuardMixFP(SelectionDAG &DAG, SDValue Val, const SDLoc &DL) const
virtual SDValue lowerEHPadEntry(SDValue Chain, const SDLoc &DL, SelectionDAG &DAG) const
Optional target hook to add target-specific actions when entering EH pad blocks.
virtual ConstraintType getConstraintType(StringRef Constraint) const
Given a constraint, return the type of constraint it is for this target.
virtual SDValue unwrapAddress(SDValue N) const
virtual bool splitValueIntoRegisterParts(SelectionDAG &DAG, const SDLoc &DL, SDValue Val, SDValue *Parts, unsigned NumParts, MVT PartVT, std::optional< CallingConv::ID > CC) const
Target-specific splitting of values into parts that fit a register storing a legal type.
virtual bool IsDesirableToPromoteOp(SDValue, EVT &) const
This method query the target whether it is beneficial for dag combiner to promote the specified node.
virtual SDValue joinRegisterPartsIntoValue(SelectionDAG &DAG, const SDLoc &DL, const SDValue *Parts, unsigned NumParts, MVT PartVT, EVT ValueVT, std::optional< CallingConv::ID > CC) const
Target-specific combining of register parts into its original value.
virtual void insertCopiesSplitCSR(MachineBasicBlock *Entry, const SmallVectorImpl< MachineBasicBlock * > &Exits) const
Insert explicit copies in entry and exit blocks.
virtual SDValue LowerCall(CallLoweringInfo &, SmallVectorImpl< SDValue > &) const
This hook must be implemented to lower calls into the specified DAG.
virtual bool isTypeDesirableForOp(unsigned, EVT VT) const
Return true if the target has native support for the specified value type and it is 'desirable' to us...
~TargetLowering() override
TargetLowering & operator=(const TargetLowering &)=delete
virtual bool isDesirableToPullExtFromShl(const MachineInstr &MI) const
GlobalISel - return true if it's profitable to perform the combine: shl ([sza]ext x),...
bool isPositionIndependent() const
std::pair< StringRef, TargetLowering::ConstraintType > ConstraintPair
virtual SDValue getNegatedExpression(SDValue Op, SelectionDAG &DAG, bool LegalOps, bool OptForSize, NegatibleCost &Cost, unsigned Depth=0) const
Return the newly negated expression if the cost is not expensive and set the cost in Cost to indicate...
virtual ConstraintWeight getSingleConstraintMatchWeight(AsmOperandInfo &info, const char *constraint) const
Examine constraint string and operand type and determine a weight value.
virtual bool isIndexingLegal(MachineInstr &MI, Register Base, Register Offset, bool IsPre, MachineRegisterInfo &MRI) const
Returns true if the specified base+offset is a legal indexed addressing mode for this target.
ConstraintGroup getConstraintPreferences(AsmOperandInfo &OpInfo) const
Given an OpInfo with list of constraints codes as strings, return a sorted Vector of pairs of constra...
virtual void initializeSplitCSR(MachineBasicBlock *Entry) const
Perform necessary initialization to handle a subset of CSRs explicitly via copies.
virtual bool isSDNodeSourceOfDivergence(const SDNode *N, FunctionLoweringInfo *FLI, UniformityInfo *UA) const
virtual SDValue getRecipEstimate(SDValue Operand, SelectionDAG &DAG, int Enabled, int &RefinementSteps) const
Return a reciprocal estimate value for the input operand.
virtual std::pair< unsigned, const TargetRegisterClass * > getRegForInlineAsmConstraint(const TargetRegisterInfo *TRI, StringRef Constraint, MVT VT) const
Given a physical register constraint (e.g.
virtual bool isSDNodeAlwaysUniform(const SDNode *N) const
virtual bool isDesirableToCommuteXorWithShift(const SDNode *N) const
Return true if it is profitable to combine an XOR of a logical shift to create a logical shift of NOT...
TargetLowering(const TargetLowering &)=delete
virtual bool shouldSimplifyDemandedVectorElts(SDValue Op, const TargetLoweringOpt &TLO) const
Return true if the target supports simplifying demanded vector elements by converting them to undefs.
virtual SDValue LowerFormalArguments(SDValue, CallingConv::ID, bool, const SmallVectorImpl< ISD::InputArg > &, const SDLoc &, SelectionDAG &, SmallVectorImpl< SDValue > &) const
This hook must be implemented to lower the incoming (formal) arguments, described by the Ins array,...
virtual AsmOperandInfoVector ParseConstraints(const DataLayout &DL, const TargetRegisterInfo *TRI, const CallBase &Call) const
Split up the constraint string from the inline assembly value into the specific constraints and their...
virtual SDValue getSqrtResultForDenormInput(SDValue Operand, SelectionDAG &DAG) const
Return a target-dependent result if the input operand is not suitable for use with a square root esti...
virtual bool getPostIndexedAddressParts(SDNode *, SDNode *, SDValue &, SDValue &, ISD::MemIndexedMode &, SelectionDAG &) const
Returns true by value, base pointer and offset pointer and addressing mode by reference if this node ...
virtual bool shouldSplitFunctionArgumentsAsLittleEndian(const DataLayout &DL) const
For most targets, an LLVM type must be broken down into multiple smaller types.
virtual ArrayRef< MCPhysReg > getRoundingControlRegisters() const
Returns a 0 terminated array of rounding control registers that can be attached into strict FP call.
virtual SDValue LowerReturn(SDValue, CallingConv::ID, bool, const SmallVectorImpl< ISD::OutputArg > &, const SmallVectorImpl< SDValue > &, const SDLoc &, SelectionDAG &) const
This hook must be implemented to lower outgoing return values, described by the Outs array,...
virtual bool functionArgumentNeedsConsecutiveRegisters(Type *Ty, CallingConv::ID CallConv, bool isVarArg, const DataLayout &DL) const
For some targets, an LLVM struct type must be broken down into multiple simple types,...
virtual bool isDesirableToCommuteWithShift(const SDNode *N, CombineLevel Level) const
Return true if it is profitable to move this shift by a constant amount through its operand,...
virtual void ComputeConstraintToUse(AsmOperandInfo &OpInfo, SDValue Op, SelectionDAG *DAG=nullptr) const
Determines the constraint code and constraint type to use for the specific AsmOperandInfo,...
virtual SDValue visitMaskedStore(SelectionDAG &DAG, const SDLoc &DL, SDValue Chain, MachineMemOperand *MMO, SDValue Ptr, SDValue Val, SDValue Mask) const
virtual const MCExpr * LowerCustomJumpTableEntry(const MachineJumpTableInfo *, const MachineBasicBlock *, unsigned, MCContext &) const
virtual bool useTopologicalSorting() const
virtual bool useLoadStackGuardNode(const Module &M) const
If this function returns true, SelectionDAGBuilder emits a LOAD_STACK_GUARD node when it is lowering ...
std::pair< SDValue, SDValue > makeLibCall(SelectionDAG &DAG, RTLIB::Libcall LC, EVT RetVT, ArrayRef< SDValue > Ops, MakeLibCallOptions CallOptions, const SDLoc &dl, SDValue Chain=SDValue()) const
It is an error to pass RTLIB::UNKNOWN_LIBCALL as LC.
virtual FastISel * createFastISel(FunctionLoweringInfo &, const TargetLibraryInfo *, const LibcallLoweringInfo *) const
This method returns a target specific FastISel object, or null if the target does not support "fast" ...
virtual unsigned combineRepeatedFPDivisors() const
Indicate whether this target prefers to combine FDIVs with the same divisor.
virtual AndOrSETCCFoldKind isDesirableToCombineLogicOpOfSETCC(const SDNode *LogicOp, const SDNode *SETCC0, const SDNode *SETCC1) const
virtual void HandleByVal(CCState *, unsigned &, Align) const
Target-specific cleanup for formal ByVal parameters.
virtual const MCPhysReg * getScratchRegisters(CallingConv::ID CC) const
Returns a 0 terminated array of registers that can be safely used as scratch registers.
virtual bool getPreIndexedAddressParts(SDNode *, SDValue &, SDValue &, ISD::MemIndexedMode &, SelectionDAG &) const
Returns true by value, base pointer and offset pointer and addressing mode by reference if the node's...
SDValue getVectorElementPointer(SelectionDAG &DAG, SDValue VecPtr, EVT VecVT, SDValue Index, const SDNodeFlags PtrArithFlags=SDNodeFlags()) const
Get a pointer to vector element Idx located in memory for a vector of type VecVT starting at a base a...
std::pair< SDValue, SDValue > makeLibCall(SelectionDAG &DAG, RTLIB::LibcallImpl LibcallImpl, EVT RetVT, ArrayRef< SDValue > Ops, MakeLibCallOptions CallOptions, const SDLoc &dl, SDValue Chain=SDValue()) const
Returns a pair of (return value, chain).
virtual bool supportSplitCSR(MachineFunction *MF) const
Return true if the target supports that a subset of CSRs for the given machine function is handled ex...
virtual bool isReassocProfitable(MachineRegisterInfo &MRI, Register N0, Register N1) const
virtual bool mayBeEmittedAsTailCall(const CallInst *) const
Return true if the target may be able emit the call instruction as a tail call.
virtual bool isInlineAsmTargetBranch(const SmallVectorImpl< StringRef > &AsmStrs, unsigned OpNo) const
On x86, return true if the operand with index OpNo is a CALL or JUMP instruction, which can use eithe...
SDValue getInboundsVectorElementPointer(SelectionDAG &DAG, SDValue VecPtr, EVT VecVT, SDValue Index) const
Get a pointer to vector element Idx located in memory for a vector of type VecVT starting at a base a...
virtual MVT getJumpTableRegTy(const DataLayout &DL) const
virtual void markLibCallAttributes(MachineFunction *MF, unsigned CC, ArgListTy &Args) const
virtual bool CanLowerReturn(CallingConv::ID, MachineFunction &, bool, const SmallVectorImpl< ISD::OutputArg > &, LLVMContext &, const Type *RetTy) const
This hook should be implemented to check whether the return values described by the Outs array can fi...
virtual bool isXAndYEqZeroPreferableToXAndYEqY(ISD::CondCode, EVT) const
virtual bool isDesirableToTransformToIntegerOp(unsigned, EVT) const
Return true if it is profitable for dag combiner to transform a floating point op of specified opcode...
Primary interface to the complete machine description for the target machine.
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
TargetSubtargetInfo - Generic base class for all target subtargets.
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
Target - Wrapper for Target specific information.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:283
static LLVM_ABI IntegerType * getInt32Ty(LLVMContext &C)
Definition Type.cpp:299
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:277
bool isFloatingPointTy() const
Return true if this is one of the floating-point types.
Definition Type.h:186
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition Type.h:252
This is the common base class for vector predication intrinsics.
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:257
CallInst * Call
#define UINT64_MAX
Definition DataTypes.h:77
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
NodeType
ISD::NodeType enum - This enum defines the target-independent operators for a SelectionDAG.
Definition ISDOpcodes.h:43
@ PARTIAL_REDUCE_SMLA
PARTIAL_REDUCE_[U|S]MLA(Accumulator, Input1, Input2) The partial reduction nodes sign or zero extend ...
@ SMUL_LOHI
SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing a signed/unsigned value of type i[2...
Definition ISDOpcodes.h:277
@ AVGSUBFLOORS
AVGSUBFLOORS/AVGSUBFLOORU - Averaging subtract - Subtract two integers using an integer of type i[N+1...
Definition ISDOpcodes.h:733
@ SMULFIX
RESULT = [US]MULFIX(LHS, RHS, SCALE) - Perform fixed point multiplication on 2 integers with the same...
Definition ISDOpcodes.h:397
@ ADDC
Carry-setting nodes for multiple precision addition and subtraction.
Definition ISDOpcodes.h:296
@ FMAD
FMAD - Perform a * b + c, while getting the same result as the separately rounded operations.
Definition ISDOpcodes.h:527
@ ADD
Simple integer binary arithmetic operators.
Definition ISDOpcodes.h:266
@ SMULFIXSAT
Same as the corresponding unsaturated fixed point instructions, but the result is clamped between the...
Definition ISDOpcodes.h:403
@ ANY_EXTEND
ANY_EXTEND - Used for integer types. The high bits are undefined.
Definition ISDOpcodes.h:879
@ PSEUDO_FMIN
PSEUDO_FMIN is strictly equivalent to op0 olt op1 ?
@ FADD
Simple binary floating point operators.
Definition ISDOpcodes.h:420
@ CLMUL
Carry-less multiplication operations.
Definition ISDOpcodes.h:796
@ SDIVFIX
RESULT = [US]DIVFIX(LHS, RHS, SCALE) - Perform fixed point division on 2 integers with the same width...
Definition ISDOpcodes.h:410
@ PARTIAL_REDUCE_UMLA
@ SIGN_EXTEND
Conversion operators.
Definition ISDOpcodes.h:870
@ AVGCEILS
AVGCEILS/AVGCEILU - Rounding averaging add - Add two integers using an integer of type i[N+2],...
Definition ISDOpcodes.h:725
@ PARTIAL_REDUCE_FMLA
@ BRIND
BRIND - Indirect branch.
@ BR_JT
BR_JT - Jumptable branch.
@ VECTOR_INTERLEAVE
VECTOR_INTERLEAVE(VEC1, VEC2, ...) - Returns N vectors from N input vectors, where N is the factor to...
Definition ISDOpcodes.h:640
@ SSUBSAT
RESULT = [US]SUBSAT(LHS, RHS) - Perform saturation subtraction on 2 integers with the same bit width ...
Definition ISDOpcodes.h:377
@ SPLAT_VECTOR
SPLAT_VECTOR(VAL) - Returns a vector with the scalar value VAL duplicated in all lanes.
Definition ISDOpcodes.h:682
@ SADDO
RESULT, BOOL = [SU]ADDO(LHS, RHS) - Overflow-aware nodes for addition.
Definition ISDOpcodes.h:351
@ MULHU
MULHU/MULHS - Multiply high - Multiply two integers of type iN, producing an unsigned/signed value of...
Definition ISDOpcodes.h:714
@ SHL
Shift and rotation operations.
Definition ISDOpcodes.h:787
@ FMINNUM_IEEE
FMINNUM_IEEE/FMAXNUM_IEEE - Same as FMINNUM/FMAXNUM, except that a signaling NaN operand deterministi...
@ ZERO_EXTEND
ZERO_EXTEND - Used for integer types, zeroing the new bits.
Definition ISDOpcodes.h:876
@ FMINNUM
FMINNUM/FMAXNUM - Same semantics as the llvm.minnum/maxnum intrinsics.
@ SMIN
[US]{MIN/MAX} - Binary minimum or maximum of signed or unsigned integers.
Definition ISDOpcodes.h:745
@ SDIVFIXSAT
Same as the corresponding unsaturated fixed point instructions, but the result is clamped between the...
Definition ISDOpcodes.h:416
@ STRICT_FP_TO_UINT
Definition ISDOpcodes.h:483
@ STRICT_FP_TO_SINT
STRICT_FP_TO_[US]INT - Convert a floating point value to a signed or unsigned integer.
Definition ISDOpcodes.h:482
@ FMINIMUM
FMINIMUM/FMAXIMUM - Same semantics as the llvm.minimum/maximum intrinsics.
@ FP_TO_SINT
FP_TO_[US]INT - Convert a floating point value to a signed or unsigned integer.
Definition ISDOpcodes.h:952
@ AND
Bitwise operators - logical and, logical or, logical xor.
Definition ISDOpcodes.h:757
@ AVGFLOORS
AVGFLOORS/AVGFLOORU - Averaging add - Add two integers using an integer of type i[N+1],...
Definition ISDOpcodes.h:720
@ ADDE
Carry-using nodes for multiple precision addition and subtraction.
Definition ISDOpcodes.h:306
@ SPLAT_VECTOR_PARTS
SPLAT_VECTOR_PARTS(SCALAR1, SCALAR2, ...) - Returns a vector with the scalar values joined together a...
Definition ISDOpcodes.h:691
@ PARTIAL_REDUCE_SUMLA
@ SADDSAT
RESULT = [US]ADDSAT(LHS, RHS) - Perform saturation addition on 2 integers with the same bit width (W)...
Definition ISDOpcodes.h:368
@ VECTOR_DEINTERLEAVE
VECTOR_DEINTERLEAVE(VEC1, VEC2, ...) - Returns N vectors from N input vectors, where N is the factor ...
Definition ISDOpcodes.h:629
@ FMINIMUMNUM
FMINIMUMNUM/FMAXIMUMNUM - Same semantics as the llvm.minimumnum/maximumnum intrinsics.
@ ABDS
ABDS/ABDU - Absolute difference - Return the absolute difference between two numbers interpreted as s...
Definition ISDOpcodes.h:740
static const int LAST_LOADEXT_TYPE
MemIndexedMode
MemIndexedMode enum - This enum defines the load / store indexed addressing modes.
CondCode
ISD::CondCode enum - These are ordered carefully to make the bitfields below work out,...
LoadExtType
LoadExtType enum - This enum defines the three variants of LOADEXT (load with extension).
This namespace contains an enum with a value for every intrinsic/builtin function known by LLVM.
@ System
Synchronized with respect to all concurrently executing threads.
Definition LLVMContext.h:66
This namespace contains all of the command line option processing machinery.
This is an optimization pass for GlobalISel generic memory operations.
GenericUniformityInfo< SSAContext > UniformityInfo
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
Definition Threading.h:280
@ Offset
Definition DWP.cpp:577
void fill(R &&Range, T &&Value)
Provide wrappers to std::fill which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1775
LLVM_ABI void GetReturnInfo(CallingConv::ID CC, Type *ReturnType, AttributeList attr, SmallVectorImpl< ISD::OutputArg > &Outs, const TargetLowering &TLI, const DataLayout &DL)
Given an LLVM IR type and return type attributes, compute the return value EVTs and flags,...
InstructionCost Cost
@ Known
Known to have no common set bits.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
bool isAligned(Align Lhs, uint64_t SizeInBytes)
Checks that SizeInBytes is a multiple of the alignment.
Definition Alignment.h:139
@ Load
The value being inserted comes from a load (InsertElement only).
@ Store
The extracted value is stored (ExtractElement only).
constexpr int popcount(T Value) noexcept
Count the number of set bits in a value.
Definition bit.h:156
unsigned Log2_64(uint64_t Value)
Return the floor log base 2 of the specified value, -1 if the value is zero.
Definition MathExtras.h:332
LLVM_ABI bool isConstTrueVal(const TargetLowering &TLI, int64_t Val, bool IsVector, bool IsFP)
Returns true if given the TargetLowering's boolean contents information, the value Val contains a tru...
Definition Utils.cpp:1606
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:280
FPClassTest
Floating-point class tests, supported by 'is_fpclass' intrinsic.
CodeGenOptLevel
Code generation optimization level.
Definition CodeGen.h:280
@ Default
-O2, -Os, -Oz
Definition CodeGen.h:283
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
AtomicOrdering
Atomic ordering for LLVM's memory model.
LLVM_ABI EVT getApproximateEVTForLLT(LLT Ty, LLVMContext &Ctx)
TargetTransformInfo TTI
CombineLevel
Definition DAGCombine.h:15
@ AfterLegalizeDAG
Definition DAGCombine.h:19
@ AfterLegalizeVectorOps
Definition DAGCombine.h:18
@ BeforeLegalizeTypes
Definition DAGCombine.h:16
uint16_t MCPhysReg
An unsigned integer type large enough to represent all physical registers, but not necessarily virtua...
Definition MCRegister.h:21
@ Fast
Assign the register banks as fast as possible (default).
LLVM_ABI bool isInTailCallPosition(const CallBase &Call, const TargetMachine &TM, bool ReturnsFirstArg=false)
Test if the given instruction is in a position to be optimized with a tail-call.
Definition Analysis.cpp:656
DWARFExpression::Operation Op
LLVM_ABI bool isConstFalseVal(const TargetLowering &TLI, int64_t Val, bool IsVector, bool IsFP)
Definition Utils.cpp:1619
constexpr unsigned BitWidth
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1933
ExceptionHandling
Definition CodeGen.h:54
UndefPoisonKind
Enumeration to track whether we are interested in Undef, Poison, or both.
Definition UndefPoison.h:20
MCRegisterClass TargetRegisterClass
Definition FastISel.h:58
LLVM_ABI void reportFatalUsageError(Error Err)
Report a fatal error that does not indicate a bug in LLVM.
Definition Error.cpp:177
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:878
#define N
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
constexpr uint64_t value() const
This is a hole in the type system and should not be abused.
Definition Alignment.h:82
Represent subnormal handling kind for floating point instruction inputs and outputs.
Extended Value Type.
Definition ValueTypes.h:35
bool isSimple() const
Test if the given EVT is simple (as opposed to being extended).
Definition ValueTypes.h:145
static EVT getVectorVT(LLVMContext &Context, EVT VT, unsigned NumElements, bool IsScalable=false)
Returns the EVT that represents a vector NumElements in length, where each element is of type VT.
Definition ValueTypes.h:70
bool bitsLT(EVT VT) const
Return true if this has less bits than VT.
Definition ValueTypes.h:323
bool isFloatingPoint() const
Return true if this is a FP or a vector FP type.
Definition ValueTypes.h:155
bool isByteSized() const
Return true if the bit size is a multiple of 8.
Definition ValueTypes.h:266
static LLVM_ABI EVT getEVT(Type *Ty, bool HandleUnknown=false)
Return the value type corresponding to the specified type.
MVT getSimpleVT() const
Return the SimpleValueType held in the specified simple EVT.
Definition ValueTypes.h:339
bool isFixedLengthVector() const
Definition ValueTypes.h:199
bool isVector() const
Return true if this is a vector value type.
Definition ValueTypes.h:176
bool isExtended() const
Test if the given EVT is extended (as opposed to being simple).
Definition ValueTypes.h:150
bool isScalarInteger() const
Return true if this is an integer, but not a vector.
Definition ValueTypes.h:165
unsigned getVectorNumElements() const
Given a vector type, return the number of elements it contains.
Definition ValueTypes.h:359
ConstraintInfo()=default
Default constructor.
This struct is a compact representation of a valid (power of two) or undefined (0) alignment.
Definition Alignment.h:111
bool isDstAligned(Align AlignCheck) const
bool isFixedDstAlign() const
uint64_t size() const
static MemOp Set(uint64_t Size, bool DstAlignCanChange, Align DstAlign, bool IsZeroMemset, bool IsVolatile)
Align getDstAlign() const
bool isMemcpyStrSrc() const
bool isAligned(Align AlignCheck) const
static MemOp Copy(uint64_t Size, bool DstAlignCanChange, Align DstAlign, Align SrcAlign, bool IsVolatile, bool MemcpyStrSrc=false)
bool isSrcAligned(Align AlignCheck) const
bool isMemcpyOrMemmoveWithFixedDstAlign() const
bool isMemcpyOrMemmove() const
bool isMemmove() const
bool isMemset() const
bool isMemcpy() const
static MemOp Move(uint64_t Size, bool DstAlignCanChange, Align DstAlign, Align SrcAlign, bool IsVolatile)
bool isZeroMemset() const
bool isVolatile() const
Align getSrcAlign() const
A simple container for information about the supported runtime calls.
static StringRef getLibcallImplName(RTLIB::LibcallImpl CallImpl)
Get the libcall routine name for the specified libcall implementation.
These are IR-level optimization flags that may be propagated to SDNodes.
This represents an addressing mode of: BaseGV + BaseOffs + BaseReg + Scale*ScaleReg + ScalableOffset*...
std::optional< unsigned > fallbackAddressSpace
PointerUnion< const Value *, const PseudoSourceValue * > ptrVal
This contains information for each constraint that we are lowering.
AsmOperandInfo(InlineAsm::ConstraintInfo Info)
Copy constructor for copying from a ConstraintInfo.
MVT ConstraintVT
The ValueType for the operand value.
TargetLowering::ConstraintType ConstraintType
Information about the constraint code, e.g.
std::string ConstraintCode
This contains the actual string for the code, like "m".
Value * CallOperandVal
If this is the result output operand or a clobber, this is null, otherwise it is the incoming operand...
This structure contains all information that is necessary for lowering calls.
CallLoweringInfo & setConvergent(bool Value=true)
CallLoweringInfo & setIsPostTypeLegalization(bool Value=true)
CallLoweringInfo & setDeactivationSymbol(GlobalValue *Sym)
CallLoweringInfo & setCallee(Type *ResultType, FunctionType *FTy, SDValue Target, ArgListTy &&ArgsList, const CallBase &Call)
CallLoweringInfo & setCFIType(const ConstantInt *Type)
CallLoweringInfo & setInRegister(bool Value=true)
CallLoweringInfo & setLibCallee(CallingConv::ID CC, Type *ResultType, SDValue Target, ArgListTy &&ArgsList)
SmallVector< ISD::InputArg, 32 > Ins
CallLoweringInfo & setVarArg(bool Value=true)
Type * OrigRetTy
Original unlegalized return type.
std::optional< PtrAuthInfo > PAI
CallLoweringInfo & setDiscardResult(bool Value=true)
CallLoweringInfo & setZExtResult(bool Value=true)
CallLoweringInfo & setIsPatchPoint(bool Value=true)
CallLoweringInfo & setDebugLoc(const SDLoc &dl)
CallLoweringInfo & setLibCallee(CallingConv::ID CC, Type *ResultType, Type *OrigResultType, SDValue Target, ArgListTy &&ArgsList)
CallLoweringInfo & setTailCall(bool Value=true)
CallLoweringInfo & setIsPreallocated(bool Value=true)
CallLoweringInfo & setSExtResult(bool Value=true)
CallLoweringInfo & setNoReturn(bool Value=true)
CallLoweringInfo & setConvergenceControlToken(SDValue Token)
SmallVector< ISD::OutputArg, 32 > Outs
Type * RetTy
Same as OrigRetTy, or partially legalized for soft float libcalls.
CallLoweringInfo & setChain(SDValue InChain)
CallLoweringInfo & setPtrAuth(PtrAuthInfo Value)
CallLoweringInfo & setCallee(CallingConv::ID CC, Type *ResultType, SDValue Target, ArgListTy &&ArgsList, AttributeSet ResultAttrs={})
DAGCombinerInfo(SelectionDAG &dag, CombineLevel level, bool cl, void *dc)
This structure is used to pass arguments to makeLibCall function.
MakeLibCallOptions & setIsPostTypeLegalization(bool Value=true)
MakeLibCallOptions & setDiscardResult(bool Value=true)
MakeLibCallOptions & setTypeListBeforeSoften(ArrayRef< EVT > OpsVT, EVT RetVT)
MakeLibCallOptions & setIsSigned(bool Value=true)
MakeLibCallOptions & setNoReturn(bool Value=true)
MakeLibCallOptions & setOpsTypeOverrides(ArrayRef< Type * > OpsTypes)
Override the argument type for an operand.
This structure contains the information necessary for lowering pointer-authenticating indirect calls.
A convenience struct that encapsulates a DAG, and two SDValues for returning information from TargetL...
TargetLoweringOpt(SelectionDAG &InDAG, bool LT, bool LO)