llvm::VPInterleaveRecipe Class Reference

VPInterleaveRecipe is a recipe for transforming an interleave group of load or stores into one wide load/store and shuffles. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPInterleaveRecipe:

Public Member Functions
	VPInterleaveRecipe (const InterleaveGroup< Instruction > *IG, VPValue *Addr, ArrayRef< VPValue * > StoredValues, VPValue *Mask, bool NeedsMaskForGaps)
	~VPInterleaveRecipe () override=default
VPInterleaveRecipe *	clone () override
	Clone the current recipe.
VPValue *	getAddr () const
	Return the address accessed by this recipe.
VPValue *	getMask () const
	Return the mask used by this recipe.
ArrayRef< VPValue * >	getStoredValues () const
	Return the VPValues stored by this interleave group.
void	execute (VPTransformState &State) override
	Generate the wide load or store, and shuffles.
InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const override
	Return the cost of this VPInterleaveRecipe.
void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the recipe.
const InterleaveGroup< Instruction > *	getInterleaveGroup ()
unsigned	getNumStoreOperands () const
	Returns the number of stored operands of this interleave group.
bool	onlyFirstLaneUsed (const VPValue *Op) const override
	The recipe only uses the first lane of the address.
Instruction *	getInsertPos () const
Public Member Functions inherited from llvm::VPRecipeBase
	VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL={})
template<typename IterT >
	VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands, DebugLoc DL={})
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.
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
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)
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.

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, VPPartialReductionSC, VPReplicateSC, VPScalarCastSC, VPScalarIVStepsSC, VPVectorPointerSC, VPReverseVectorPointerSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenIntrinsicSC, VPWidenLoadEVLSC, VPWidenLoadSC, VPWidenStoreEVLSC, VPWidenStoreSC, VPWidenSC, VPWidenEVLSC, VPWidenSelectSC, VPBlendSC, VPHistogramSC, VPWidenPHISC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPEVLBasedIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPScalarPHISC, 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
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 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
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)
	VPUser (std::initializer_list< VPValue * > Operands)
template<typename IterT >
	VPUser (iterator_range< IterT > Operands)

Detailed Description

VPInterleaveRecipe is a recipe for transforming an interleave group of load or stores into one wide load/store and shuffles.

The first operand of a VPInterleave recipe is the address, followed by the stored values, followed by an optional mask.

Definition at line 2561 of file VPlan.h.

Constructor & Destructor Documentation

VPInterleaveRecipe()

llvm::VPInterleaveRecipe::VPInterleaveRecipe ( const InterleaveGroup< Instruction > *  IG, VPValue *  Addr, ArrayRef< VPValue * >  StoredValues, VPValue *  Mask, bool  NeedsMaskForGaps  )

inline

Definition at line 2573 of file VPlan.h.

References Addr.

~VPInterleaveRecipe()

llvm::VPInterleaveRecipe::~VPInterleaveRecipe ( )

overridedefault

Member Function Documentation

clone()

VPInterleaveRecipe * llvm::VPInterleaveRecipe::clone ( )

inlineoverridevirtual

Clone the current recipe.

Implements llvm::VPRecipeBase.

Definition at line 2594 of file VPlan.h.

References getAddr(), getMask(), and getStoredValues().

computeCost()

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

overridevirtual

Return the cost of this VPInterleaveRecipe.

Reimplemented from llvm::VPRecipeBase.

Definition at line 3176 of file VPlanRecipes.cpp.

References llvm::VPCostContext::CostKind, llvm::VectorType::get(), getInsertPos(), llvm::TargetTransformInfo::getInterleavedMemoryOpCost(), llvm::getLoadStoreAddressSpace(), getMask(), llvm::VPDef::getNumDefinedValues(), llvm::Instruction::getOpcode(), llvm::TargetTransformInfo::getShuffleCost(), getStoredValues(), llvm::VPDef::getVPValue(), Idx, llvm::VPTypeAnalysis::inferScalarType(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::TargetTransformInfo::SK_Reverse, llvm::toVectorTy(), llvm::VPCostContext::TTI, and llvm::VPCostContext::Types.

execute()

void VPInterleaveRecipe::execute ( VPTransformState &  State )

overridevirtual

Generate the wide load or store, and shuffles.

Implements llvm::VPRecipeBase.

Definition at line 2912 of file VPlanRecipes.cpp.

References llvm::InterleaveGroup< InstTy >::addMetadata(), Addr, assert(), llvm::VPTransformState::Builder, llvm::VPTransformState::CFG, llvm::IRBuilderBase::CreateAlignedLoad(), llvm::IRBuilderBase::CreateAlignedStore(), llvm::IRBuilderBase::CreateBinOp(), llvm::createBitMaskForGaps(), createBitOrPointerCast(), llvm::IRBuilderBase::CreateExtractValue(), llvm::IRBuilderBase::CreateGEP(), llvm::IRBuilderBase::CreateIntrinsic(), llvm::IRBuilderBase::CreateMaskedLoad(), llvm::IRBuilderBase::CreateMaskedStore(), llvm::IRBuilderBase::CreateMul(), llvm::IRBuilderBase::CreateNeg(), llvm::createReplicatedMask(), llvm::IRBuilderBase::CreateShuffleVector(), llvm::createStrideMask(), llvm::IRBuilderBase::CreateSub(), llvm::IRBuilderBase::CreateVectorReverse(), llvm::VPDef::definedValues(), DL, llvm::VectorType::get(), llvm::PoisonValue::get(), llvm::VPTransformState::get(), getAddr(), llvm::InterleaveGroup< InstTy >::getAlign(), llvm::BasicBlock::getDataLayout(), llvm::InterleaveGroup< InstTy >::getFactor(), llvm::InterleaveGroup< InstTy >::getInsertPos(), llvm::IRBuilderBase::getInt32(), llvm::IRBuilderBase::getInt32Ty(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::getKnownMinValue(), llvm::getLoadStoreType(), getMask(), llvm::InterleaveGroup< InstTy >::getMember(), llvm::getRuntimeVF(), getStoredValues(), llvm::Value::getType(), I, interleaveVectors(), llvm::isPowerOf2_32(), llvm::InterleaveGroup< InstTy >::isReverse(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::isScalable(), llvm::VPTransformState::Lane, llvm::VPTransformState::CFGState::PrevBB, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::VPTransformState::set(), llvm::VPTransformState::setDebugLocFrom(), llvm::Value::stripPointerCasts(), and llvm::VPTransformState::VF.

getAddr()

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

inline

Return the address accessed by this recipe.

Definition at line 2602 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by clone(), execute(), onlyFirstLaneUsed(), and print().

getInsertPos()

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

inline

Definition at line 2650 of file VPlan.h.

References llvm::InterleaveGroup< InstTy >::getInsertPos().

Referenced by computeCost().

getInterleaveGroup()

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

inline

Definition at line 2635 of file VPlan.h.

getMask()

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

inline

Return the mask used by this recipe.

Note that a full mask is represented by a nullptr.

Definition at line 2608 of file VPlan.h.

References llvm::VPUser::getNumOperands(), and llvm::VPUser::getOperand().

Referenced by clone(), computeCost(), execute(), and print().

getNumStoreOperands()

unsigned llvm::VPInterleaveRecipe::getNumStoreOperands ( ) const

inline

Returns the number of stored operands of this interleave group.

Returns 0 for load interleave groups.

Definition at line 2639 of file VPlan.h.

References llvm::VPUser::getNumOperands().

Referenced by getStoredValues(), and print().

getStoredValues()

ArrayRef< VPValue * > llvm::VPInterleaveRecipe::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 2615 of file VPlan.h.

References llvm::VPUser::getNumOperands(), getNumStoreOperands(), llvm::VPUser::op_begin(), and llvm::ArrayRef< T >::slice().

Referenced by clone(), computeCost(), execute(), and onlyFirstLaneUsed().

onlyFirstLaneUsed()

bool llvm::VPInterleaveRecipe::onlyFirstLaneUsed ( const VPValue *  Op ) const

inlineoverridevirtual

The recipe only uses the first lane of the address.

Reimplemented from llvm::VPUser.

Definition at line 2644 of file VPlan.h.

References assert(), getAddr(), getStoredValues(), llvm::is_contained(), and llvm::VPUser::operands().

print()

void VPInterleaveRecipe::print ( raw_ostream &  O, const Twine &  Indent, VPSlotTracker &  SlotTracker  ) const

overridevirtual

Print the recipe.

Implements llvm::VPDef.

Definition at line 3146 of file VPlanRecipes.cpp.

References getAddr(), getMask(), getNumStoreOperands(), llvm::VPUser::getOperand(), llvm::VPDef::getVPValue(), and llvm::VPValue::printAsOperand().

---

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

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