LLVM 19.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::BuildVectorSDNode Class Reference

A "pseudo-class" with methods for operating on BUILD_VECTORs. More...

#include "llvm/CodeGen/SelectionDAGNodes.h"

Inheritance diagram for llvm::BuildVectorSDNode:
Inheritance graph
[legend]

Public Member Functions

 BuildVectorSDNode ()=delete
 
bool isConstantSplat (APInt &SplatValue, APInt &SplatUndef, unsigned &SplatBitSize, bool &HasAnyUndefs, unsigned MinSplatBits=0, bool isBigEndian=false) const
 Check if this is a constant splat, and if so, find the smallest element size that splats the vector.
 
SDValue getSplatValue (const APInt &DemandedElts, BitVector *UndefElements=nullptr) const
 Returns the demanded splatted value or a null value if this is not a splat.
 
SDValue getSplatValue (BitVector *UndefElements=nullptr) const
 Returns the splatted value or a null value if this is not a splat.
 
bool getRepeatedSequence (const APInt &DemandedElts, SmallVectorImpl< SDValue > &Sequence, BitVector *UndefElements=nullptr) const
 Find the shortest repeating sequence of values in the build vector.
 
bool getRepeatedSequence (SmallVectorImpl< SDValue > &Sequence, BitVector *UndefElements=nullptr) const
 Find the shortest repeating sequence of values in the build vector.
 
ConstantSDNodegetConstantSplatNode (const APInt &DemandedElts, BitVector *UndefElements=nullptr) const
 Returns the demanded splatted constant or null if this is not a constant splat.
 
ConstantSDNodegetConstantSplatNode (BitVector *UndefElements=nullptr) const
 Returns the splatted constant or null if this is not a constant splat.
 
ConstantFPSDNodegetConstantFPSplatNode (const APInt &DemandedElts, BitVector *UndefElements=nullptr) const
 Returns the demanded splatted constant FP or null if this is not a constant FP splat.
 
ConstantFPSDNodegetConstantFPSplatNode (BitVector *UndefElements=nullptr) const
 Returns the splatted constant FP or null if this is not a constant FP splat.
 
int32_t getConstantFPSplatPow2ToLog2Int (BitVector *UndefElements, uint32_t BitWidth) const
 If this is a constant FP splat and the splatted constant FP is an exact power or 2, return the log base 2 integer value.
 
bool getConstantRawBits (bool IsLittleEndian, unsigned DstEltSizeInBits, SmallVectorImpl< APInt > &RawBitElements, BitVector &UndefElements) const
 Extract the raw bit data from a build vector of Undef, Constant or ConstantFP node elements.
 
bool isConstant () const
 
std::optional< std::pair< APInt, APInt > > isConstantSequence () const
 If this BuildVector is constant and represents the numerical series "<a, a+n, a+2n, a+3n, ...>" where a is integer and n is a non-zero integer, the value "<a,n>" is returned.
 
- Public Member Functions inherited from llvm::SDNode
unsigned getOpcode () const
 Return the SelectionDAG opcode value for this node.
 
bool isTargetOpcode () const
 Test if this node has a target-specific opcode (in the <target>ISD namespace).
 
bool isTargetStrictFPOpcode () const
 Test if this node has a target-specific opcode that may raise FP exceptions (in the <target>ISD namespace and greater than FIRST_TARGET_STRICTFP_OPCODE).
 
bool isTargetMemoryOpcode () const
 Test if this node has a target-specific memory-referencing opcode (in the <target>ISD namespace and greater than FIRST_TARGET_MEMORY_OPCODE).
 
bool isUndef () const
 Return true if the type of the node type undefined.
 
bool isMemIntrinsic () const
 Test if this node is a memory intrinsic (with valid pointer information).
 
bool isStrictFPOpcode ()
 Test if this node is a strict floating point pseudo-op.
 
bool isVPOpcode () const
 Test if this node is a vector predication operation.
 
bool isMachineOpcode () const
 Test if this node has a post-isel opcode, directly corresponding to a MachineInstr opcode.
 
unsigned getMachineOpcode () const
 This may only be called if isMachineOpcode returns true.
 
bool getHasDebugValue () const
 
void setHasDebugValue (bool b)
 
bool isDivergent () const
 
bool use_empty () const
 Return true if there are no uses of this node.
 
bool hasOneUse () const
 Return true if there is exactly one use of this node.
 
size_t use_size () const
 Return the number of uses of this node.
 
int getNodeId () const
 Return the unique node id.
 
void setNodeId (int Id)
 Set unique node id.
 
unsigned getIROrder () const
 Return the node ordering.
 
void setIROrder (unsigned Order)
 Set the node ordering.
 
const DebugLocgetDebugLoc () const
 Return the source location info.
 
void setDebugLoc (DebugLoc dl)
 Set source location info.
 
use_iterator use_begin () const
 Provide iteration support to walk over all uses of an SDNode.
 
iterator_range< use_iteratoruses ()
 
iterator_range< use_iteratoruses () const
 
bool hasNUsesOfValue (unsigned NUses, unsigned Value) const
 Return true if there are exactly NUSES uses of the indicated value.
 
bool hasAnyUseOfValue (unsigned Value) const
 Return true if there are any use of the indicated value.
 
bool isOnlyUserOf (const SDNode *N) const
 Return true if this node is the only use of N.
 
bool isOperandOf (const SDNode *N) const
 Return true if this node is an operand of N.
 
bool isPredecessorOf (const SDNode *N) const
 Return true if this node is a predecessor of N.
 
bool hasPredecessor (const SDNode *N) const
 Return true if N is a predecessor of this node.
 
unsigned getNumOperands () const
 Return the number of values used by this operation.
 
uint64_t getConstantOperandVal (unsigned Num) const
 Helper method returns the integer value of a ConstantSDNode operand.
 
uint64_t getAsZExtVal () const
 Helper method returns the zero-extended integer value of a ConstantSDNode.
 
const APIntgetConstantOperandAPInt (unsigned Num) const
 Helper method returns the APInt of a ConstantSDNode operand.
 
const APIntgetAsAPIntVal () const
 Helper method returns the APInt value of a ConstantSDNode.
 
const SDValuegetOperand (unsigned Num) const
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
ArrayRef< SDUseops () const
 
iterator_range< value_op_iteratorop_values () const
 
SDVTList getVTList () const
 
SDNodegetGluedNode () const
 If this node has a glue operand, return the node to which the glue operand points.
 
SDNodegetGluedUser () const
 If this node has a glue value with a user, return the user (there is at most one).
 
SDNodeFlags getFlags () const
 
void setFlags (SDNodeFlags NewFlags)
 
void intersectFlagsWith (const SDNodeFlags Flags)
 Clear any flags in this node that aren't also set in Flags.
 
void setCFIType (uint32_t Type)
 
uint32_t getCFIType () const
 
unsigned getNumValues () const
 Return the number of values defined/returned by this operator.
 
EVT getValueType (unsigned ResNo) const
 Return the type of a specified result.
 
MVT getSimpleValueType (unsigned ResNo) const
 Return the type of a specified result as a simple type.
 
TypeSize getValueSizeInBits (unsigned ResNo) const
 Returns MVT::getSizeInBits(getValueType(ResNo)).
 
value_iterator value_begin () const
 
value_iterator value_end () const
 
iterator_range< value_iteratorvalues () const
 
std::string getOperationName (const SelectionDAG *G=nullptr) const
 Return the opcode of this operation for printing.
 
void print_types (raw_ostream &OS, const SelectionDAG *G) const
 
void print_details (raw_ostream &OS, const SelectionDAG *G) const
 
void print (raw_ostream &OS, const SelectionDAG *G=nullptr) const
 
void printr (raw_ostream &OS, const SelectionDAG *G=nullptr) const
 
void printrFull (raw_ostream &O, const SelectionDAG *G=nullptr) const
 Print a SelectionDAG node and all children down to the leaves.
 
void printrWithDepth (raw_ostream &O, const SelectionDAG *G=nullptr, unsigned depth=100) const
 Print a SelectionDAG node and children up to depth "depth." The given SelectionDAG allows target-specific nodes to be printed in human-readable form.
 
void dump () const
 Dump this node, for debugging.
 
void dumpr () const
 Dump (recursively) this node and its use-def subgraph.
 
void dump (const SelectionDAG *G) const
 Dump this node, for debugging.
 
void dumpr (const SelectionDAG *G) const
 Dump (recursively) this node and its use-def subgraph.
 
void dumprFull (const SelectionDAG *G=nullptr) const
 printrFull to dbgs().
 
void dumprWithDepth (const SelectionDAG *G=nullptr, unsigned depth=100) const
 printrWithDepth to dbgs().
 
void Profile (FoldingSetNodeID &ID) const
 Gather unique data for the node.
 
void addUse (SDUse &U)
 This method should only be used by the SDUse class.
 
- Public Member Functions inherited from llvm::FoldingSetBase::Node
 Node ()=default
 
void * getNextInBucket () const
 
void SetNextInBucket (void *N)
 
- Public Member Functions inherited from llvm::ilist_node_impl< OptionsT >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node.
 

Static Public Member Functions

static void recastRawBits (bool IsLittleEndian, unsigned DstEltSizeInBits, SmallVectorImpl< APInt > &DstBitElements, ArrayRef< APInt > SrcBitElements, BitVector &DstUndefElements, const BitVector &SrcUndefElements)
 Recast bit data SrcBitElements to DstEltSizeInBits wide elements.
 
static bool classof (const SDNode *N)
 
- Static Public Member Functions inherited from llvm::SDNode
static use_iterator use_end ()
 
static bool hasPredecessorHelper (const SDNode *N, SmallPtrSetImpl< const SDNode * > &Visited, SmallVectorImpl< const SDNode * > &Worklist, unsigned int MaxSteps=0, bool TopologicalPrune=false)
 Returns true if N is a predecessor of any node in Worklist.
 
static bool areOnlyUsersOf (ArrayRef< const SDNode * > Nodes, const SDNode *N)
 Return true if all the users of N are contained in Nodes.
 
static constexpr size_t getMaxNumOperands ()
 Return the maximum number of operands that a SDNode can hold.
 
static const chargetIndexedModeName (ISD::MemIndexedMode AM)
 

Additional Inherited Members

- Public Types inherited from llvm::SDNode
using op_iterator = SDUse *
 
using value_iterator = const EVT *
 
- Public Attributes inherited from llvm::SDNode
uint16_t PersistentId = 0xffff
 Unique and persistent id per SDNode in the DAG.
 
- Protected Types inherited from llvm::SDNode
enum  { NumSDNodeBits = 3 }
 
enum  { NumMemSDNodeBits = NumSDNodeBits + 4 }
 
enum  { NumLSBaseSDNodeBits = NumMemSDNodeBits + 3 }
 
- Protected Types inherited from llvm::ilist_node_impl< OptionsT >
using self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, false, false >::type
 
using const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, false, true >::type
 
using reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, true, false >::type
 
using const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, true, true >::type
 
- Protected Member Functions inherited from llvm::SDNode
 SDNode (unsigned Opc, unsigned Order, DebugLoc dl, SDVTList VTs)
 Create an SDNode.
 
void DropOperands ()
 Release the operands and set this node to have zero operands.
 
- Protected Member Functions inherited from llvm::ilist_node_impl< OptionsT >
 ilist_node_impl ()=default
 
- Static Protected Member Functions inherited from llvm::SDNode
static SDVTList getSDVTList (EVT VT)
 
- Protected Attributes inherited from llvm::SDNode
union {
   char   RawSDNodeBits [sizeof(uint16_t)]
 
   SDNodeBitfields   SDNodeBits
 
   ConstantSDNodeBitfields   ConstantSDNodeBits
 
   MemSDNodeBitfields   MemSDNodeBits
 
   LSBaseSDNodeBitfields   LSBaseSDNodeBits
 
   LoadSDNodeBitfields   LoadSDNodeBits
 
   StoreSDNodeBitfields   StoreSDNodeBits
 
}; 
 

Detailed Description

A "pseudo-class" with methods for operating on BUILD_VECTORs.

Definition at line 2029 of file SelectionDAGNodes.h.

Constructor & Destructor Documentation

◆ BuildVectorSDNode()

llvm::BuildVectorSDNode::BuildVectorSDNode ( )
explicitdelete

Member Function Documentation

◆ classof()

static bool llvm::BuildVectorSDNode::classof ( const SDNode N)
inlinestatic

Definition at line 2158 of file SelectionDAGNodes.h.

References llvm::ISD::BUILD_VECTOR, and N.

◆ getConstantFPSplatNode() [1/2]

ConstantFPSDNode * BuildVectorSDNode::getConstantFPSplatNode ( BitVector UndefElements = nullptr) const

Returns the splatted constant FP or null if this is not a constant FP splat.

If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12539 of file SelectionDAG.cpp.

References getSplatValue().

◆ getConstantFPSplatNode() [2/2]

ConstantFPSDNode * BuildVectorSDNode::getConstantFPSplatNode ( const APInt DemandedElts,
BitVector UndefElements = nullptr 
) const

Returns the demanded splatted constant FP or null if this is not a constant FP splat.

The DemandedElts mask indicates the elements that must be in the splat. If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12532 of file SelectionDAG.cpp.

References getSplatValue().

◆ getConstantFPSplatPow2ToLog2Int()

int32_t BuildVectorSDNode::getConstantFPSplatPow2ToLog2Int ( BitVector UndefElements,
uint32_t  BitWidth 
) const

If this is a constant FP splat and the splatted constant FP is an exact power or 2, return the log base 2 integer value.

Otherwise, return -1.

The BitWidth specifies the necessary bit precision.

Definition at line 12544 of file SelectionDAG.cpp.

References llvm::BitWidth, llvm::APFloat::convertToInteger(), getSplatValue(), llvm::APFloatBase::opOK, and llvm::APFloatBase::rmTowardZero.

Referenced by performFDivCombine(), performFpToIntCombine(), PerformVCVTCombine(), and PerformVDIVCombine().

◆ getConstantRawBits()

bool BuildVectorSDNode::getConstantRawBits ( bool  IsLittleEndian,
unsigned  DstEltSizeInBits,
SmallVectorImpl< APInt > &  RawBitElements,
BitVector UndefElements 
) const

Extract the raw bit data from a build vector of Undef, Constant or ConstantFP node elements.

Each raw bit element will be DstEltSizeInBits wide, undef elements are treated as zero, and entirely undefined elements are flagged in UndefElements.

Definition at line 12561 of file SelectionDAG.cpp.

References assert(), llvm::SDNode::getNumOperands(), llvm::SDNode::getOperand(), llvm::EVT::getScalarSizeInBits(), llvm::SDNode::getValueType(), llvm::APInt::getZero(), I, isConstant(), recastRawBits(), and llvm::BitVector::set().

◆ getConstantSplatNode() [1/2]

ConstantSDNode * BuildVectorSDNode::getConstantSplatNode ( BitVector UndefElements = nullptr) const

Returns the splatted constant or null if this is not a constant splat.

If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12527 of file SelectionDAG.cpp.

References getSplatValue().

◆ getConstantSplatNode() [2/2]

ConstantSDNode * BuildVectorSDNode::getConstantSplatNode ( const APInt DemandedElts,
BitVector UndefElements = nullptr 
) const

Returns the demanded splatted constant or null if this is not a constant splat.

The DemandedElts mask indicates the elements that must be in the splat. If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12520 of file SelectionDAG.cpp.

References getSplatValue().

Referenced by combineGatherScatter(), and llvm::TargetLowering::isConstFalseVal().

◆ getRepeatedSequence() [1/2]

bool BuildVectorSDNode::getRepeatedSequence ( const APInt DemandedElts,
SmallVectorImpl< SDValue > &  Sequence,
BitVector UndefElements = nullptr 
) const

Find the shortest repeating sequence of values in the build vector.

e.g. { u, X, u, X, u, u, X, u } -> { X } { X, Y, u, Y, u, u, X, u } -> { X, Y }

Currently this must be a power-of-2 build vector. The DemandedElts mask indicates the elements that must be present, undemanded elements in Sequence may be null (SDValue()). If passed a non-null UndefElements bitvector, it will resize it to match the original vector width and set the bits where elements are undef. If result is false, Sequence will be empty.

Definition at line 12467 of file SelectionDAG.cpp.

References assert(), llvm::BitVector::clear(), llvm::APInt::getBitWidth(), llvm::SDNode::getNumOperands(), llvm::SDNode::getOperand(), I, llvm::isPowerOf2_32(), llvm::SDValue::isUndef(), llvm::SDNode::isUndef(), and llvm::BitVector::resize().

Referenced by getRepeatedSequence(), and lowerBuildVectorAsBroadcast().

◆ getRepeatedSequence() [2/2]

bool BuildVectorSDNode::getRepeatedSequence ( SmallVectorImpl< SDValue > &  Sequence,
BitVector UndefElements = nullptr 
) const

Find the shortest repeating sequence of values in the build vector.

e.g. { u, X, u, X, u, u, X, u } -> { X } { X, Y, u, Y, u, u, X, u } -> { X, Y }

Currently this must be a power-of-2 build vector. If passed a non-null UndefElements bitvector, it will resize it to match the original vector width and set the bits where elements are undef. If result is false, Sequence will be empty.

Definition at line 12513 of file SelectionDAG.cpp.

References llvm::APInt::getAllOnes(), llvm::SDNode::getNumOperands(), and getRepeatedSequence().

◆ getSplatValue() [1/2]

SDValue BuildVectorSDNode::getSplatValue ( BitVector UndefElements = nullptr) const

Returns the splatted value or a null value if this is not a splat.

If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12462 of file SelectionDAG.cpp.

References llvm::APInt::getAllOnes(), llvm::SDNode::getNumOperands(), and getSplatValue().

◆ getSplatValue() [2/2]

SDValue BuildVectorSDNode::getSplatValue ( const APInt DemandedElts,
BitVector UndefElements = nullptr 
) const

Returns the demanded splatted value or a null value if this is not a splat.

The DemandedElts mask indicates the elements that must be in the splat. If passed a non-null UndefElements bitvector, it will resize it to match the vector width and set the bits where elements are undef.

Definition at line 12427 of file SelectionDAG.cpp.

References assert(), llvm::BitVector::clear(), llvm::APInt::countr_zero(), llvm::APInt::getBitWidth(), llvm::SDNode::getNumOperands(), llvm::SDNode::getOperand(), llvm::SDNode::isUndef(), and llvm::BitVector::resize().

Referenced by createMMXBuildVector(), getConstantFPSplatNode(), getConstantFPSplatPow2ToLog2Int(), getConstantSplatNode(), getSplatValue(), and llvm::SelectionDAG::getVectorShuffle().

◆ isConstant()

bool BuildVectorSDNode::isConstant ( ) const

◆ isConstantSequence()

std::optional< std::pair< APInt, APInt > > BuildVectorSDNode::isConstantSequence ( ) const

If this BuildVector is constant and represents the numerical series "<a, a+n, a+2n, a+3n, ...>" where a is integer and n is a non-zero integer, the value "<a,n>" is returned.

Definition at line 12661 of file SelectionDAG.cpp.

References llvm::SDNode::getConstantOperandAPInt(), llvm::SDNode::getNumOperands(), llvm::SDNode::getOperand(), llvm::EVT::getScalarSizeInBits(), llvm::SDNode::getValueType(), llvm::APInt::isZero(), and llvm::APInt::trunc().

◆ isConstantSplat()

bool BuildVectorSDNode::isConstantSplat ( APInt SplatValue,
APInt SplatUndef,
unsigned SplatBitSize,
bool HasAnyUndefs,
unsigned  MinSplatBits = 0,
bool  isBigEndian = false 
) const

Check if this is a constant splat, and if so, find the smallest element size that splats the vector.

If MinSplatBits is nonzero, the element size must be at least that large. Note that the splat element may be the entire vector (i.e., a one element vector). Returns the splat element value in SplatValue. Any undefined bits in that value are zero, and the corresponding bits in the SplatUndef mask are set. The SplatBitSize value is set to the splat element size in bits. HasAnyUndefs is set to true if any bits in the vector are undefined. isBigEndian describes the endianness of the target.

Definition at line 12351 of file SelectionDAG.cpp.

References assert(), llvm::APInt::extractBits(), llvm::SDNode::getNumOperands(), llvm::SDNode::getOperand(), llvm::EVT::getScalarSizeInBits(), llvm::EVT::getSizeInBits(), llvm::SDNode::getValueType(), llvm::APInt::insertBits(), llvm::SDValue::isUndef(), llvm::EVT::isVector(), and llvm::APInt::setBits().

Referenced by EmitVectorComparison(), getVShiftImm(), isVectorAllOnes(), lowerBuildVectorAsBroadcast(), PerformANDCombine(), llvm::PPCTargetLowering::PerformDAGCombine(), performDSPShiftCombine(), PerformORCombine(), resolveBuildVector(), llvm::LoongArchDAGToDAGISel::Select(), llvm::SystemZVectorConstantInfo::SystemZVectorConstantInfo(), and tryCombineShiftImm().

◆ recastRawBits()

void BuildVectorSDNode::recastRawBits ( bool  IsLittleEndian,
unsigned  DstEltSizeInBits,
SmallVectorImpl< APInt > &  DstBitElements,
ArrayRef< APInt SrcBitElements,
BitVector DstUndefElements,
const BitVector SrcUndefElements 
)
static

Recast bit data SrcBitElements to DstEltSizeInBits wide elements.

Undef elements are treated as zero, and entirely undefined elements are flagged in DstUndefElements.

Definition at line 12597 of file SelectionDAG.cpp.

References assert(), llvm::SmallVectorImpl< T >::assign(), llvm::BitVector::clear(), llvm::APInt::extractBits(), llvm::APInt::getBitWidth(), llvm::APInt::getZero(), I, Idx, llvm::APInt::insertBits(), llvm::BitVector::reset(), llvm::BitVector::resize(), llvm::BitVector::set(), llvm::ArrayRef< T >::size(), and llvm::BitVector::size().

Referenced by llvm::SelectionDAG::FoldConstantArithmetic(), and getConstantRawBits().


The documentation for this class was generated from the following files: