A recipe for handling reduction phis. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPReductionPHIRecipe:

Public Member Functions
	VPReductionPHIRecipe (PHINode *Phi, RecurKind Kind, VPValue &Start, bool IsInLoop=false, bool IsOrdered=false, unsigned VFScaleFactor=1)
	Create a new VPReductionPHIRecipe for the reduction `Phi`.
	~VPReductionPHIRecipe () override=default
VPReductionPHIRecipe *	clone () override
	Clone the current recipe.
void	execute (VPTransformState &State) override
	Generate the phi/select nodes.
unsigned	getVFScaleFactor () const
	Get the factor that the VF of this recipe's output should be scaled by.
void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the recipe.
unsigned	getNumIncoming () const override
	Returns the number of incoming values, also number of incoming blocks.
RecurKind	getRecurrenceKind () const
	Returns the recurrence kind of the reduction.
bool	isOrdered () const
	Returns true, if the phi is part of an ordered reduction.
bool	isInLoop () const
	Returns true, if the phi is part of an in-loop reduction.
bool	onlyFirstLaneUsed (const VPValue *Op) const override
	Returns true if the recipe only uses the first lane of operand `Op`.
Public Member Functions inherited from llvm::VPHeaderPHIRecipe
	~VPHeaderPHIRecipe () override=default
InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const override
	Return the cost of this header phi recipe.
VPValue *	getStartValue ()
	Returns the start value of the phi, if one is set.
VPValue *	getStartValue () const
void	setStartValue (VPValue *V)
	Update the start value of the recipe.
virtual VPValue *	getBackedgeValue ()
	Returns the incoming value from the loop backedge.
void	setBackedgeValue (VPValue *V)
	Update the incoming value from the loop backedge.
virtual VPRecipeBase &	getBackedgeRecipe ()
	Returns the backedge value as a recipe.
Public Member Functions inherited from llvm::VPSingleDefRecipe
	VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
	VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, Value *UV, DebugLoc DL=DebugLoc::getUnknown())
Instruction *	getUnderlyingInstr ()
	Returns the underlying instruction.
const Instruction *	getUnderlyingInstr () const
LLVM_DUMP_METHOD void	dump () const
	Print this VPSingleDefRecipe to dbgs() (for debugging).
Public Member Functions inherited from llvm::VPRecipeBase
	VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
virtual	~VPRecipeBase ()=default
VPBasicBlock *	getParent ()
const VPBasicBlock *	getParent () const
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 ()
VPRecipeBase *	getNextNode ()
	Get the next node, or `nullptr` for the list tail.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
self_iterator	getIterator ()
reverse_self_iterator	getReverseIterator ()
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< ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >, ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty *	getParent () const
void	setParent (ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty *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).
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	onlyFirstPartUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first part of operand `Op`.
Public Member Functions inherited from llvm::VPValue
Value *	getUnderlyingValue () const
	Return the underlying Value attached to this VPValue.
	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 () const
	Returns true if the value has more than one unique user.
void	replaceAllUsesWith (VPValue *New)
void	replaceUsesWithIf (VPValue *New, llvm::function_ref< bool(VPUser &U, unsigned Idx)> ShouldReplace)
	Go through the uses list for this VPValue and make each use point to `New` if the callback ShouldReplace returns true for the given use specified by a pair of (VPUser, the use index).
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.
bool	isLiveIn () const
	Returns true if this VPValue is a live-in, i.e. defined outside the VPlan.
Value *	getLiveInIRValue () const
	Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.
bool	isDefinedOutsideLoopRegions () const
	Returns true if the VPValue is defined outside any loop.
void	setUnderlyingValue (Value *Val)
Public Member Functions inherited from llvm::VPPhiAccessors
virtual	~VPPhiAccessors ()=default
VPValue *	getIncomingValue (unsigned Idx) const
	Returns the incoming VPValue with index `Idx`.
const VPBasicBlock *	getIncomingBlock (unsigned Idx) const
	Returns the incoming block with index `Idx`.
VPUser::const_operand_range	incoming_values () const
	Returns an interator range over the incoming values.
const_incoming_blocks_range	incoming_blocks () const
	Returns an iterator range over the incoming blocks.
detail::zippy< llvm::detail::zip_first, VPUser::const_operand_range, const_incoming_blocks_range >	incoming_values_and_blocks () const
	Returns an iterator range over pairs of incoming values and corresponding incoming blocks.
void	removeIncomingValueFor (VPBlockBase *IncomingBlock) const
	Removes the incoming value for `IncomingBlock`, which must be a predecessor.
void	printPhiOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
	Print the recipe.

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy
	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
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
Public Types inherited from llvm::VPPhiAccessors
using	const_incoming_blocks_range
Static Public Member Functions inherited from llvm::VPHeaderPHIRecipe
static bool	classof (const VPRecipeBase *B)
	Method to support type inquiry through isa, cast, and dyn_cast.
static bool	classof (const VPValue *V)
Static Public Member Functions inherited from llvm::VPSingleDefRecipe
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 Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
using	self_iterator
using	const_self_iterator
using	reverse_self_iterator
using	const_reverse_self_iterator
Protected Member Functions inherited from llvm::VPHeaderPHIRecipe
	VPHeaderPHIRecipe (unsigned char VPDefID, Instruction UnderlyingInstr, VPValue Start, DebugLoc DL=DebugLoc::getUnknown())
const VPRecipeBase *	getAsRecipe () const override
	Return a VPRecipeBase* to the current object.
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< VPRecipeBase, 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)
Protected Member Functions inherited from llvm::VPValue
	VPValue (const unsigned char SC, Value UV=nullptr, VPDef Def=nullptr)
	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.
Protected Member Functions inherited from llvm::VPUnrollPartAccessor< 2 >
VPValue *	getUnrollPartOperand (const VPUser &U) const
	Return the VPValue operand containing the unroll part or null if there is no such operand.
unsigned	getUnrollPart (const VPUser &U) const
	Return the unroll part.
Protected Attributes inherited from llvm::VPValue
Value *	UnderlyingVal
VPDef *	Def
	Pointer to the VPDef that defines this VPValue.

Detailed Description

A recipe for handling reduction phis.

The start value is the first operand of the recipe and the incoming value from the backedge is the second operand.

Definition at line 2320 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPReductionPHIRecipe()

llvm::VPReductionPHIRecipe::VPReductionPHIRecipe	(	PHINode *	Phi,
		RecurKind	Kind,
		VPValue &	Start,
		bool	IsInLoop = false,
		bool	IsOrdered = false,
		unsigned	VFScaleFactor = 1 )

inline

Create a new VPReductionPHIRecipe for the reduction Phi.

Definition at line 2337 of file VPlan.h.

References assert(), and llvm::VPHeaderPHIRecipe::VPHeaderPHIRecipe().

Referenced by clone().

◆ ~VPReductionPHIRecipe()

llvm::VPReductionPHIRecipe::~VPReductionPHIRecipe ( )

overridedefault

Member Function Documentation

◆ clone()

VPReductionPHIRecipe * llvm::VPReductionPHIRecipe::clone ( )

inlineoverridevirtual

Clone the current recipe.

Implements llvm::VPSingleDefRecipe.

Definition at line 2347 of file VPlan.h.

References llvm::dyn_cast_or_null(), llvm::VPHeaderPHIRecipe::getBackedgeValue(), llvm::VPUser::getOperand(), getRecurrenceKind(), llvm::VPValue::getUnderlyingValue(), and VPReductionPHIRecipe().

◆ execute()

void VPReductionPHIRecipe::execute ( VPTransformState & State )

overridevirtual

Generate the phi/select nodes.

Implements llvm::VPHeaderPHIRecipe.

Definition at line 4207 of file VPlanRecipes.cpp.

References assert(), llvm::PHINode::Create(), llvm::BasicBlock::getFirstInsertionPt(), llvm::VPRecipeBase::getParent(), llvm::VPHeaderPHIRecipe::getStartValue(), and llvm::Value::getType().

◆ getNumIncoming()

unsigned llvm::VPReductionPHIRecipe::getNumIncoming ( ) const

inlineoverridevirtual

Returns the number of incoming values, also number of incoming blocks.

Note that at the moment, VPWidenPointerInductionRecipe only has a single incoming value, its start value.

Reimplemented from llvm::VPPhiAccessors.

Definition at line 2372 of file VPlan.h.

◆ getRecurrenceKind()

RecurKind llvm::VPReductionPHIRecipe::getRecurrenceKind ( ) const

inline

Returns the recurrence kind of the reduction.

Definition at line 2375 of file VPlan.h.

Referenced by clone(), and llvm::VPlanTransforms::handleMaxMinNumReductions().

◆ getVFScaleFactor()

unsigned llvm::VPReductionPHIRecipe::getVFScaleFactor ( ) const

inline

Get the factor that the VF of this recipe's output should be scaled by.

Definition at line 2361 of file VPlan.h.

◆ isInLoop()

bool llvm::VPReductionPHIRecipe::isInLoop ( ) const

inline

Returns true, if the phi is part of an in-loop reduction.

Definition at line 2381 of file VPlan.h.

Referenced by onlyFirstLaneUsed().

◆ isOrdered()

bool llvm::VPReductionPHIRecipe::isOrdered ( ) const

inline

Returns true, if the phi is part of an ordered reduction.

Definition at line 2378 of file VPlan.h.

Referenced by onlyFirstLaneUsed().

◆ onlyFirstLaneUsed()

bool llvm::VPReductionPHIRecipe::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 2384 of file VPlan.h.

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

◆ print()

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

overridevirtual

Print the recipe.

Implements llvm::VPHeaderPHIRecipe.

Definition at line 4233 of file VPlanRecipes.cpp.

References llvm::VPValue::printAsOperand(), and llvm::VPUser::printOperands().

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPReductionPHIRecipe()

◆ ~VPReductionPHIRecipe()

Member Function Documentation

◆ clone()

◆ execute()

◆ getNumIncoming()

◆ getRecurrenceKind()

◆ getVFScaleFactor()

◆ isInLoop()

◆ isOrdered()

◆ onlyFirstLaneUsed()

◆ print()