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

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenMemoryRecipe:

[legend]

Public Member Functions
VPWidenMemoryRecipe *	clone () override
	Clone the current recipe.

bool	isConsecutive () const
	Return whether the loaded-from / stored-to addresses are consecutive.

bool	isReverse () const
	Return whether the consecutive loaded/stored addresses are in reverse order.

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

bool	isMasked () const
	Returns true if the recipe is masked.

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

void	execute (VPTransformState &State) override
	Generate the wide load/store.

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

Instruction &	getIngredient () 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`.

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
void	setMask (VPValue *Mask)

	VPWidenMemoryRecipe (const char unsigned SC, Instruction &I, std::initializer_list< VPValue * > Operands, bool Consecutive, bool Reverse, 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)

	VPUser (std::initializer_list< VPValue * > Operands)

template<typename IterT >
	VPUser (iterator_range< IterT > Operands)

Protected Attributes
Instruction &	Ingredient

bool	Consecutive
	Whether the accessed addresses are consecutive.

bool	Reverse
	Whether the consecutive accessed addresses are in reverse order.

bool	IsMasked = false
	Whether the memory access is masked.

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, 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

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 widening memory operations.

An optional mask can be provided as the last operand.

Definition at line 2879 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenMemoryRecipe()

llvm::VPWidenMemoryRecipe::VPWidenMemoryRecipe	(	const char unsigned	SC,
		Instruction &	I,
		std::initializer_list< VPValue * >	Operands,
		bool	Consecutive,
		bool	Reverse,
		DebugLoc	DL
	)

inlineprotected

Definition at line 2900 of file VPlan.h.

References assert(), Consecutive, DL, Operands, and Reverse.

Member Function Documentation

◆ classof() [1/2]

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

inlinestatic

Definition at line 2913 of file VPlan.h.

Referenced by classof().

◆ classof() [2/2]

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

inlinestatic

Definition at line 2920 of file VPlan.h.

References classof().

◆ clone()

VPWidenMemoryRecipe * llvm::VPWidenMemoryRecipe::clone ( )

inlineoverridevirtual

Clone the current recipe.

Implements llvm::VPRecipeBase.

Reimplemented in llvm::VPWidenLoadRecipe, and llvm::VPWidenStoreRecipe.

Definition at line 2909 of file VPlan.h.

References llvm_unreachable.

◆ computeCost()

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

overridevirtual

Return the cost of this VPWidenMemoryRecipe.

Reimplemented from llvm::VPRecipeBase.

Reimplemented in llvm::VPWidenLoadEVLRecipe, and llvm::VPWidenStoreEVLRecipe.

Definition at line 2452 of file VPlanRecipes.cpp.

Referenced by llvm::VPWidenLoadEVLRecipe::computeCost(), and llvm::VPWidenStoreEVLRecipe::computeCost().

◆ execute()

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

inlineoverridevirtual

Generate the wide load/store.

Implements llvm::VPRecipeBase.

Reimplemented in llvm::VPWidenLoadRecipe, llvm::VPWidenLoadEVLRecipe, llvm::VPWidenStoreRecipe, and llvm::VPWidenStoreEVLRecipe.

Definition at line 2946 of file VPlan.h.

References llvm_unreachable.

◆ getAddr()

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

inline

Return the address accessed by this recipe.

Definition at line 2933 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), llvm::VPWidenLoadRecipe::onlyFirstLaneUsed(), llvm::VPWidenLoadEVLRecipe::onlyFirstLaneUsed(), llvm::VPWidenStoreRecipe::onlyFirstLaneUsed(), llvm::VPWidenStoreEVLRecipe::onlyFirstLaneUsed(), and llvm::VPWidenStoreEVLRecipe::VPWidenStoreEVLRecipe().

◆ getIngredient()

Instruction & llvm::VPWidenMemoryRecipe::getIngredient ( ) const

inline

Definition at line 2954 of file VPlan.h.

References Ingredient.

◆ getMask()

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

inline

Return the mask used by this recipe.

Note that a full mask is represented by a nullptr.

Definition at line 2940 of file VPlan.h.

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

Referenced by llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), and transformRecipestoEVLRecipes().

◆ isConsecutive()

bool llvm::VPWidenMemoryRecipe::isConsecutive ( ) const

inline

Return whether the loaded-from / stored-to addresses are consecutive.

Definition at line 2926 of file VPlan.h.

References Consecutive.

Referenced by llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), llvm::VPWidenLoadRecipe::onlyFirstLaneUsed(), llvm::VPWidenLoadEVLRecipe::onlyFirstLaneUsed(), llvm::VPWidenStoreRecipe::onlyFirstLaneUsed(), and llvm::VPWidenStoreEVLRecipe::onlyFirstLaneUsed().

◆ isMasked()

bool llvm::VPWidenMemoryRecipe::isMasked ( ) const

inline

Returns true if the recipe is masked.

Definition at line 2936 of file VPlan.h.

References IsMasked.

Referenced by getMask().

◆ isReverse()

bool llvm::VPWidenMemoryRecipe::isReverse ( ) const

inline

Return whether the consecutive loaded/stored addresses are in reverse order.

Definition at line 2930 of file VPlan.h.

References Reverse.

Referenced by llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), and llvm::VPWidenStoreEVLRecipe::execute().

◆ setMask()

void llvm::VPWidenMemoryRecipe::setMask ( VPValue * Mask )

inlineprotected

Definition at line 2892 of file VPlan.h.

References llvm::VPUser::addOperand(), assert(), and IsMasked.

Member Data Documentation

◆ Consecutive

bool llvm::VPWidenMemoryRecipe::Consecutive

protected

Whether the accessed addresses are consecutive.

Definition at line 2884 of file VPlan.h.

Referenced by llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), computeCost(), llvm::VPWidenLoadEVLRecipe::computeCost(), llvm::VPWidenStoreEVLRecipe::computeCost(), isConsecutive(), and VPWidenMemoryRecipe().

◆ Ingredient

Instruction& llvm::VPWidenMemoryRecipe::Ingredient

protected

Definition at line 2881 of file VPlan.h.

Referenced by llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), computeCost(), llvm::VPWidenLoadEVLRecipe::computeCost(), llvm::VPWidenStoreEVLRecipe::computeCost(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), and getIngredient().

◆ IsMasked

bool llvm::VPWidenMemoryRecipe::IsMasked = false

protected

Whether the memory access is masked.

Definition at line 2890 of file VPlan.h.

Referenced by computeCost(), llvm::VPWidenLoadEVLRecipe::computeCost(), llvm::VPWidenStoreEVLRecipe::computeCost(), isMasked(), and setMask().

◆ Reverse

bool llvm::VPWidenMemoryRecipe::Reverse

protected

Whether the consecutive accessed addresses are in reverse order.

Definition at line 2887 of file VPlan.h.

Referenced by llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), computeCost(), llvm::VPWidenLoadEVLRecipe::computeCost(), llvm::VPWidenStoreEVLRecipe::computeCost(), llvm::VPWidenLoadRecipe::execute(), isReverse(), and VPWidenMemoryRecipe().

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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPWidenMemoryRecipe()

Member Function Documentation

◆ classof() [1/2]

◆ classof() [2/2]

◆ clone()

◆ computeCost()

◆ execute()

◆ getAddr()

◆ getIngredient()

◆ getMask()

◆ isConsecutive()

◆ isMasked()

◆ isReverse()

◆ setMask()

Member Data Documentation

◆ Consecutive

◆ Ingredient

◆ IsMasked

◆ Reverse