VPReplicateRecipe replicates a given instruction producing multiple scalar copies of the original scalar type, one per lane, instead of producing a single copy of widened type for all lanes. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPReplicateRecipe:

[legend]

Collaboration diagram for llvm::VPReplicateRecipe:

[legend]

Public Member Functions
template<typename IterT >
	VPReplicateRecipe (Instruction I, iterator_range< IterT > Operands, bool IsUniform, VPValue Mask=nullptr)

	~VPReplicateRecipe () override=default

void	execute (VPTransformState &State) override
	Generate replicas of the desired Ingredient.

void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the recipe.

bool	isUniform () const

bool	isPredicated () const

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

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

bool	shouldPack () const
	Returns true if the recipe is used by a widened recipe via an intervening VPPredInstPHIRecipe.

VPValue *	getMask ()
	Return the mask of a predicated VPReplicateRecipe.

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

template<typename IterT >
	VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands)

virtual	~VPRecipeBase ()=default

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.

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.

Instruction *	getUnderlyingInstr ()
	Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise.

const Instruction *	getUnderlyingInstr () const

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.

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::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 ()

VPUserID	getVPUserID () const

void	addOperand (VPValue *Operand)

unsigned	getNumOperands () const

VPValue *	getOperand (unsigned N) const

void	setOperand (unsigned I, VPValue *New)

void	removeLastOperand ()

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`.

Public Member Functions inherited from llvm::VPValue
Value *	getUnderlyingValue ()
	Return the underlying Value attached to this VPValue.

const Value *	getUnderlyingValue () const

	VPValue (Value *UV=nullptr)
	Create a live-in VPValue.

	VPValue (VPDef Def, Value UV=nullptr)
	Create a VPValue for a `Def` which is a subclass of VPValue.

	VPValue (Value UV, VPDef Def)
	Create a VPValue for a `Def` which defines multiple values.

	VPValue (const VPValue &)=delete

VPValue &	operator= (const VPValue &)=delete

virtual	~VPValue ()

unsigned	getVPValueID () const

void	printAsOperand (raw_ostream &OS, VPSlotTracker &Tracker) const

void	print (raw_ostream &OS, VPSlotTracker &Tracker) const

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

unsigned	getNumUsers () const

void	addUser (VPUser &User)

void	removeUser (VPUser &User)
	Remove a single `User` from the list of users.

user_iterator	user_begin ()

const_user_iterator	user_begin () const

user_iterator	user_end ()

const_user_iterator	user_end () const

user_range	users ()

const_user_range	users () const

bool	hasMoreThanOneUniqueUser ()
	Returns true if the value has more than one unique user.

void	replaceAllUsesWith (VPValue *New)

VPRecipeBase *	getDefiningRecipe ()
	Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe, i.e.

const VPRecipeBase *	getDefiningRecipe () const

bool	hasDefiningRecipe () const
	Returns true if this VPValue is defined by a recipe.

Value *	getLiveInIRValue ()
	Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.

const Value *	getLiveInIRValue () const

bool	isDefinedOutsideVectorRegions () const
	Returns true if the VPValue is defined outside any vector regions, i.e.

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, 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
enum class	VPUserID { Recipe , LiveOut }
	Subclass identifier (for isa/dyn_cast). More...

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

Public Types inherited from llvm::VPValue
enum	{ VPValueSC , VPVRecipeSC }
	An enumeration for keeping track of the concrete subclass of VPValue that are actually instantiated. More...

typedef SmallVectorImpl< VPUser * >::iterator	user_iterator

typedef SmallVectorImpl< VPUser * >::const_iterator	const_user_iterator

typedef iterator_range< user_iterator >	user_range

typedef iterator_range< const_user_iterator >	const_user_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 = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, false >

using	const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, true >

using	reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, true, false >

using	const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, true, true >

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, VPUserID ID)

	VPUser (std::initializer_list< VPValue * > Operands, VPUserID ID)

template<typename IterT >
	VPUser (iterator_range< IterT > Operands, VPUserID ID)

Protected Member Functions inherited from llvm::VPValue
	VPValue (const unsigned char SC, Value UV=nullptr, VPDef Def=nullptr)

void	setUnderlyingValue (Value *Val)

Protected Attributes inherited from llvm::VPValue
Value *	UnderlyingVal

VPDef *	Def
	Pointer to the VPDef that defines this VPValue.

Detailed Description

VPReplicateRecipe replicates a given instruction producing multiple scalar copies of the original scalar type, one per lane, instead of producing a single copy of widened type for all lanes.

If the instruction is known to be uniform only one copy, per lane zero, will be generated.

Definition at line 1510 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPReplicateRecipe()

template<typename IterT >

llvm::VPReplicateRecipe::VPReplicateRecipe	(	Instruction *	I,
		iterator_range< IterT >	Operands,
		bool	IsUniform,
		VPValue *	Mask = `nullptr`
	)

inline

Definition at line 1519 of file VPlan.h.

References llvm::VPUser::addOperand(), and Operands.

◆ ~VPReplicateRecipe()

llvm::VPReplicateRecipe::~VPReplicateRecipe ( )

overridedefault

Member Function Documentation

◆ execute()

void VPReplicateRecipe::execute ( VPTransformState & State )

overridevirtual

Generate replicas of the desired Ingredient.

Replicas will be generated for all parts and lanes unless a specific part and lane are specified in the State.

Implements llvm::VPRecipeBase.

Definition at line 9521 of file LoopVectorize.cpp.

References llvm::all_of(), assert(), llvm::VectorType::get(), llvm::PoisonValue::get(), llvm::VPTransformState::get(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::getKnownMinValue(), llvm::VPLane::getLastLaneForVF(), llvm::Value::getType(), llvm::VPTransformState::ILV, llvm::VPTransformState::Instance, llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::isScalable(), llvm::ElementCount::isVector(), llvm::InnerLoopVectorizer::packScalarIntoVectorValue(), llvm::InnerLoopVectorizer::scalarizeInstruction(), llvm::VPTransformState::set(), llvm::VPTransformState::UF, and llvm::VPTransformState::VF.

◆ getMask()

VPValue * llvm::VPReplicateRecipe::getMask ( )

inline

Return the mask of a predicated VPReplicateRecipe.

Definition at line 1566 of file VPlan.h.

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

Referenced by createReplicateRegion().

◆ isPredicated()

bool llvm::VPReplicateRecipe::isPredicated ( ) const

inline

Definition at line 1544 of file VPlan.h.

Referenced by getMask().

◆ isUniform()

bool llvm::VPReplicateRecipe::isUniform ( ) const

inline

Definition at line 1542 of file VPlan.h.

Referenced by createReplicateRegion(), and onlyFirstLaneUsed().

◆ onlyFirstLaneUsed()

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

inlineoverridevirtual

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

Reimplemented from llvm::VPUser.

Definition at line 1547 of file VPlan.h.

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

◆ print()

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

overridevirtual

Print the recipe.

Implements llvm::VPDef.

Definition at line 953 of file VPlanRecipes.cpp.

References llvm::VPUser::getNumOperands(), getOpcode(), llvm::Instruction::getOpcodeName(), llvm::Value::getType(), llvm::VPRecipeBase::getUnderlyingInstr(), llvm::interleaveComma(), llvm::Type::isVoidTy(), llvm::make_range(), llvm::VPUser::op_begin(), llvm::VPValue::printAsOperand(), llvm::VPUser::printOperands(), and shouldPack().

◆ shouldPack()

bool VPReplicateRecipe::shouldPack ( ) const

Returns true if the recipe is used by a widened recipe via an intervening VPPredInstPHIRecipe.

In this case, the scalar values should also be packed in a vector.

Definition at line 940 of file VPlanRecipes.cpp.

References llvm::any_of(), and llvm::VPValue::users().

Referenced by print().

◆ usesScalars()

bool llvm::VPReplicateRecipe::usesScalars ( const VPValue * Op ) const

inlineoverridevirtual

Returns true if the recipe uses scalars of operand Op.

Reimplemented from llvm::VPUser.

Definition at line 1554 of file VPlan.h.

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

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPReplicateRecipe()

◆ ~VPReplicateRecipe()

Member Function Documentation

◆ execute()

◆ getMask()

◆ isPredicated()

◆ isUniform()

◆ onlyFirstLaneUsed()

◆ print()

◆ shouldPack()

◆ usesScalars()