A common base class for interleaved memory operations. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPInterleaveBase:

Public Member Functions
VPInterleaveBase *	clone () override=0
	Clone the current recipe.

VPValue *	getAddr () const
	Return the address accessed by this recipe.

VPValue *	getMask () const
	Return the mask used by this recipe.

bool	needsMaskForGaps () const
	Return true if the access needs a mask because of the gaps.

const InterleaveGroup< Instruction > *	getInterleaveGroup () const

Instruction *	getInsertPos () const

void	execute (VPTransformState &State) override
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const override
	Return the cost of this recipe.

virtual bool	onlyFirstLaneUsed (const VPValue *Op) const override=0
	Returns true if the recipe only uses the first lane of operand `Op`.

virtual unsigned	getNumStoreOperands () const =0
	Returns the number of stored operands of this interleave group.

ArrayRef< VPValue * >	getStoredValues () const
	Return the VPValues stored by this interleave group.

Public Member Functions inherited from llvm::VPRecipeBase
	VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())

virtual	~VPRecipeBase ()=default

virtual VPRecipeBase *	clone ()=0
	Clone the current recipe.

VPBasicBlock *	getParent ()

const VPBasicBlock *	getParent () const

virtual void	execute (VPTransformState &State)=0
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

InstructionCost	cost (ElementCount VF, VPCostContext &Ctx)
	Return the cost of this recipe, taking into account if the cost computation should be skipped and the ForceTargetInstructionCost flag.

void	insertBefore (VPRecipeBase *InsertPos)
	Insert an unlinked recipe into a basic block immediately before the specified recipe.

void	insertBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator IP)
	Insert an unlinked recipe into `BB` immediately before the insertion point `IP`;.

void	insertAfter (VPRecipeBase *InsertPos)
	Insert an unlinked Recipe into a basic block immediately after the specified Recipe.

void	moveAfter (VPRecipeBase *MovePos)
	Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos.

void	moveBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
	Unlink this recipe and insert into BB before I.

void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it.

iplist< VPRecipeBase >::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it.

bool	mayHaveSideEffects () const
	Returns true if the recipe may have side-effects.

bool	isPhi () const
	Returns true for PHI-like recipes.

bool	mayReadFromMemory () const
	Returns true if the recipe may read from memory.

bool	mayWriteToMemory () const
	Returns true if the recipe may write to memory.

bool	mayReadOrWriteMemory () const
	Returns true if the recipe may read from or write to memory.

DebugLoc	getDebugLoc () const
	Returns the debug location of the recipe.

bool	isScalarCast () const
	Return true if the recipe is a scalar cast.

void	setDebugLoc (DebugLoc NewDL)
	Set the recipe's debug location to `NewDL`.

Public Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
VPRecipeBase *	getPrevNode ()

const VPRecipeBase *	getPrevNode () const
	Get the previous node, or `nullptr` for the list head.

VPRecipeBase *	getNextNode ()
	Get the next node, or `nullptr` for the list tail.

const VPRecipeBase *	getNextNode () const
	Get the next node, or `nullptr` for the list tail.

Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
self_iterator	getIterator ()

const_self_iterator	getIterator () const

reverse_self_iterator	getReverseIterator ()

const_reverse_self_iterator	getReverseIterator () const

std::enable_if_t< T::is_sentinel_tracking_explicit, bool >	isSentinel () const
	Check whether this is the sentinel node.

Public Member Functions inherited from llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy *	getParent () const

ParentTy *	getParent ()

void	setParent (ParentTy *Parent)

Public Member Functions inherited from llvm::VPDef
	VPDef (const unsigned char SC)

virtual	~VPDef ()

VPValue *	getVPSingleValue ()
	Returns the only VPValue defined by the VPDef.

const VPValue *	getVPSingleValue () const

VPValue *	getVPValue (unsigned I)
	Returns the VPValue with index `I` defined by the VPDef.

const VPValue *	getVPValue (unsigned I) const

ArrayRef< VPValue * >	definedValues ()
	Returns an ArrayRef of the values defined by the VPDef.

ArrayRef< VPValue * >	definedValues () const
	Returns an ArrayRef of the values defined by the VPDef.

unsigned	getNumDefinedValues () const
	Returns the number of values defined by the VPDef.

unsigned	getVPDefID () const

void	dump () const
	Dump the VPDef to stderr (for debugging).

virtual void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
	Each concrete VPDef prints itself.

Public Member Functions inherited from llvm::VPUser
	VPUser ()=delete

	VPUser (const VPUser &)=delete

VPUser &	operator= (const VPUser &)=delete

virtual	~VPUser ()

void	addOperand (VPValue *Operand)

unsigned	getNumOperands () const

VPValue *	getOperand (unsigned N) const

void	setOperand (unsigned I, VPValue *New)

void	swapOperands ()
	Swap operands of the VPUser. It must have exactly 2 operands.

void	replaceUsesOfWith (VPValue From, VPValue To)
	Replaces all uses of `From` in the VPUser with `To`.

operand_iterator	op_begin ()

const_operand_iterator	op_begin () const

operand_iterator	op_end ()

const_operand_iterator	op_end () const

operand_range	operands ()

const_operand_range	operands () const

virtual bool	usesScalars (const VPValue *Op) const
	Returns true if the VPUser uses scalars of operand `Op`.

virtual bool	onlyFirstLaneUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first lane of operand `Op`.

virtual bool	onlyFirstPartUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first part of operand `Op`.

Public Member Functions inherited from llvm::VPIRMetadata
	VPIRMetadata ()

	VPIRMetadata (Instruction &I)
	Adds metatadata that can be preserved from the original instruction `I`.

	VPIRMetadata (Instruction &I, LoopVersioning *LVer)
	Adds metatadata that can be preserved from the original instruction `I` and noalias metadata guaranteed by runtime checks using `LVer`.

	VPIRMetadata (const VPIRMetadata &Other)
	Copy constructor for cloning.

VPIRMetadata &	operator= (const VPIRMetadata &Other)

void	applyMetadata (Instruction &I) const
	Add all metadata to `I`.

void	addMetadata (unsigned Kind, MDNode *Node)
	Add metadata with kind `Kind` and `Node`.

void	intersect (const VPIRMetadata &MD)
	Intersect this VPIRMetada object with `MD`, keeping only metadata nodes that are common to both.

Static Public Member Functions
static bool	classof (const VPRecipeBase *R)

static bool	classof (const VPUser *U)

Static Public Member Functions inherited from llvm::VPRecipeBase
static bool	classof (const VPDef *D)
	Method to support type inquiry through isa, cast, and dyn_cast.

static bool	classof (const VPUser *U)

Protected Member Functions
	VPInterleaveBase (const unsigned char SC, const InterleaveGroup< Instruction > IG, ArrayRef< VPValue > Operands, ArrayRef< VPValue * > StoredValues, VPValue *Mask, bool NeedsMaskForGaps, const VPIRMetadata &MD, DebugLoc DL)

virtual InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const
	Compute the cost of this recipe either using a recipe's specialized implementation or using the legacy cost model and the underlying instructions.

Protected Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
	ilist_node_with_parent ()=default

Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
	ilist_node_impl ()=default

Protected Member Functions inherited from llvm::VPUser
void	printOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
	Print the operands to `O`.

	VPUser (ArrayRef< VPValue * > Operands)

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPExpressionSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveEVLSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, VPPartialReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPVectorPointerSC, VPVectorEndPointerSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenIntrinsicSC, VPWidenLoadEVLSC, VPWidenLoadSC, VPWidenStoreEVLSC, VPWidenStoreSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPHistogramSC, VPWidenPHISC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPEVLBasedIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPWidenPHISC, VPFirstHeaderPHISC=VPCanonicalIVPHISC, VPLastHeaderPHISC=VPReductionPHISC, VPLastPHISC=VPReductionPHISC, }
	An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.

Public Types inherited from llvm::VPUser
typedef SmallVectorImpl< VPValue * >::iterator	operand_iterator

typedef SmallVectorImpl< VPValue * >::const_iterator	const_operand_iterator

typedef iterator_range< operand_iterator >	operand_range

typedef iterator_range< const_operand_iterator >	const_operand_range

Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using	self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type

using	const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type

using	reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type

using	const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type

Detailed Description

A common base class for interleaved memory operations.

An Interleaved memory operation is a memory access method that combines multiple strided loads/stores into a single wide load/store with shuffles. The first operand is the start address. The optional operands are, in order, the stored values and the mask.

Definition at line 2459 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPInterleaveBase()

llvm::VPInterleaveBase::VPInterleaveBase	(	const unsigned char	SC,
		const InterleaveGroup< Instruction > *	IG,
		ArrayRef< VPValue * >	Operands,
		ArrayRef< VPValue * >	StoredValues,
		VPValue *	Mask,
		bool	NeedsMaskForGaps,
		const VPIRMetadata &	MD,
		DebugLoc	DL
	)

inlineprotected

Definition at line 2472 of file VPlan.h.

References addOperand(), assert(), llvm::InterleaveGroup< InstTy >::getFactor(), llvm::InterleaveGroup< InstTy >::getMember(), I, and llvm::InterleaveGroup< InstTy >::isReverse().

Member Function Documentation

◆ classof() [1/2]

static bool llvm::VPInterleaveBase::classof ( const VPRecipeBase * R )

inlinestatic

Definition at line 2500 of file VPlan.h.

◆ classof() [2/2]

static bool llvm::VPInterleaveBase::classof ( const VPUser * U )

inlinestatic

Definition at line 2505 of file VPlan.h.

◆ clone()

VPInterleaveBase * llvm::VPInterleaveBase::clone ( )

overridepure virtual

Clone the current recipe.

Implements llvm::VPRecipeBase.

Implemented in llvm::VPInterleaveRecipe, and llvm::VPInterleaveEVLRecipe.

◆ computeCost()

InstructionCost VPInterleaveBase::computeCost	(	ElementCount	VF,
		VPCostContext &	Ctx
	)		const

overridevirtual

◆ execute()

void llvm::VPInterleaveBase::execute ( VPTransformState & State )

inlineoverridevirtual

The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

Implements llvm::VPRecipeBase.

Reimplemented in llvm::VPInterleaveRecipe, and llvm::VPInterleaveEVLRecipe.

Definition at line 2529 of file VPlan.h.

References llvm_unreachable.

◆ getAddr()

VPValue * llvm::VPInterleaveBase::getAddr ( ) const

inline

Return the address accessed by this recipe.

Definition at line 2511 of file VPlan.h.

Referenced by llvm::VPInterleaveRecipe::execute(), llvm::VPInterleaveEVLRecipe::execute(), llvm::VPInterleaveRecipe::print(), and llvm::VPInterleaveEVLRecipe::print().

◆ getInsertPos()

Instruction * llvm::VPInterleaveBase::getInsertPos ( ) const

inline

Definition at line 2527 of file VPlan.h.

Referenced by computeCost().

◆ getInterleaveGroup()

const InterleaveGroup< Instruction > * llvm::VPInterleaveBase::getInterleaveGroup ( ) const

inline

Definition at line 2525 of file VPlan.h.

Referenced by llvm::VPInterleaveRecipe::execute(), llvm::VPInterleaveEVLRecipe::execute(), isConsecutiveInterleaveGroup(), llvm::VPInterleaveRecipe::print(), and llvm::VPInterleaveEVLRecipe::print().

◆ getMask()

VPValue * llvm::VPInterleaveBase::getMask ( ) const

inline

Return the mask used by this recipe.

Note that a full mask is represented by a nullptr.

Definition at line 2517 of file VPlan.h.

Referenced by computeCost(), llvm::VPInterleaveRecipe::execute(), llvm::VPInterleaveEVLRecipe::execute(), llvm::VPInterleaveRecipe::print(), and llvm::VPInterleaveEVLRecipe::print().

◆ getNumStoreOperands()

virtual unsigned llvm::VPInterleaveBase::getNumStoreOperands ( ) const

pure virtual

Returns the number of stored operands of this interleave group.

Returns 0 for load interleave groups.

Implemented in llvm::VPInterleaveRecipe, and llvm::VPInterleaveEVLRecipe.

◆ getStoredValues()

ArrayRef< VPValue * > llvm::VPInterleaveBase::getStoredValues ( ) const

inline

Return the VPValues stored by this interleave group.

If it is a load interleave group, return an empty ArrayRef.

Definition at line 2546 of file VPlan.h.

Referenced by computeCost(), llvm::VPInterleaveRecipe::execute(), llvm::VPInterleaveEVLRecipe::execute(), and isConsecutiveInterleaveGroup().

◆ needsMaskForGaps()

bool llvm::VPInterleaveBase::needsMaskForGaps ( ) const

inline

Return true if the access needs a mask because of the gaps.

Definition at line 2523 of file VPlan.h.

Referenced by llvm::VPInterleaveRecipe::execute(), and llvm::VPInterleaveEVLRecipe::execute().

◆ onlyFirstLaneUsed()

virtual bool llvm::VPInterleaveBase::onlyFirstLaneUsed ( const VPValue * Op ) const

overridepure virtual

Returns true if the recipe only uses the first lane of operand Op.

Reimplemented from llvm::VPUser.

Implemented in llvm::VPInterleaveRecipe, and llvm::VPInterleaveEVLRecipe.

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

lib/Transforms/Vectorize/VPlan.h
lib/Transforms/Vectorize/VPlanRecipes.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPInterleaveBase()

Member Function Documentation

◆ classof() [1/2]

◆ classof() [2/2]

◆ clone()

◆ computeCost()

◆ execute()

◆ getAddr()

◆ getInsertPos()

◆ getInterleaveGroup()

◆ getMask()

◆ getNumStoreOperands()

◆ getStoredValues()

◆ needsMaskForGaps()

◆ onlyFirstLaneUsed()