A recipe for handling phi nodes of integer and floating-point inductions, producing their vector values. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenIntOrFpInductionRecipe:

[legend]

Collaboration diagram for llvm::VPWidenIntOrFpInductionRecipe:

[legend]

Public Member Functions
	VPWidenIntOrFpInductionRecipe (PHINode IV, VPValue Start, VPValue *Step, const InductionDescriptor &IndDesc, bool NeedsScalarIV, bool NeedsVectorIV)

	VPWidenIntOrFpInductionRecipe (PHINode IV, VPValue Start, VPValue Step, const InductionDescriptor &IndDesc, TruncInst Trunc, bool NeedsScalarIV, bool NeedsVectorIV)

	~VPWidenIntOrFpInductionRecipe () override=default

void	execute (VPTransformState &State) override
	Generate the vectorized and scalarized versions of the phi node as needed by their users. More...

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

VPValue *	getStartValue ()
	Returns the start value of the induction. More...

const VPValue *	getStartValue () const

VPValue *	getStepValue ()
	Returns the step value of the induction. More...

const VPValue *	getStepValue () const

TruncInst *	getTruncInst ()
	Returns the first defined value as TruncInst, if it is one or nullptr otherwise. More...

const TruncInst *	getTruncInst () const

PHINode *	getPHINode ()

const InductionDescriptor &	getInductionDescriptor () const
	Returns the induction descriptor for the recipe. More...

bool	isCanonical () const
	Returns true if the induction is canonical, i.e. More...

const Type *	getScalarType () const
	Returns the scalar type of the induction. More...

bool	needsScalarIV () const
	Returns true if a scalar phi needs to be created for the induction. More...

bool	needsVectorIV () const
	Returns true if a vector phi needs to be created for the induction. More...

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

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

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

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

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

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

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

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

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

const Instruction *	getUnderlyingInstr () const

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

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

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

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

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

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

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

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

Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, 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. More...

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

virtual	~VPDef ()

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

const VPValue *	getVPSingleValue () const

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

const VPValue *	getVPValue (unsigned I) const

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

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

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

unsigned	getVPDefID () const

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

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

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

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

const Value *	getUnderlyingValue () const

	VPValue (Value UV=nullptr, VPDef Def=nullptr)

	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). More...

unsigned	getNumUsers () const

void	addUser (VPUser &User)

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

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

void	replaceAllUsesWith (VPValue *New)

VPDef *	getDef ()

const VPDef *	getDef () const

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

const Value *	getLiveInIRValue () const

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

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

static bool	classof (const VPUser *U)

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

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPExpandSCEVSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPCanonicalIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPPredInstPHISC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, VPLastPHISC=VPReductionPHISC, }
	An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated. More...

Public Types inherited from llvm::VPUser
enum	VPUserID { VPUserID::Recipe, VPUserID::Block }
	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, VPVInstructionSC, VPVMemoryInstructionSC, VPVReductionSC, VPVReplicateSC, VPVWidenSC, VPVWidenCallSC, VPVWidenCanonicalIVSC, VPVWidenGEPSC, VPVWidenSelectSC, VPVBlendSC, VPVCanonicalIVPHISC, VPVFirstOrderRecurrencePHISC, VPVWidenPHISC, VPVWidenIntOrFpInductionSC, VPVWidenPointerInductionSC, VPVPredInstPHI, VPVReductionPHISC }
	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

Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
using	self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, false, false >

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

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

using	const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, 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< 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`. More...

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

Detailed Description

A recipe for handling phi nodes of integer and floating-point inductions, producing their vector values.

Definition at line 1047 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenIntOrFpInductionRecipe() [1/2]

llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe	(	PHINode *	IV,
		VPValue *	Start,
		VPValue *	Step,
		const InductionDescriptor &	IndDesc,
		bool	NeedsScalarIV,
		bool	NeedsVectorIV
	)

inline

Definition at line 1054 of file VPlan.h.

◆ VPWidenIntOrFpInductionRecipe() [2/2]

llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe	(	PHINode *	IV,
		VPValue *	Start,
		VPValue *	Step,
		const InductionDescriptor &	IndDesc,
		TruncInst *	Trunc,
		bool	NeedsScalarIV,
		bool	NeedsVectorIV
	)

inline

Definition at line 1061 of file VPlan.h.

◆ ~VPWidenIntOrFpInductionRecipe()

llvm::VPWidenIntOrFpInductionRecipe::~VPWidenIntOrFpInductionRecipe ( )

overridedefault

Member Function Documentation

◆ classof()

static bool llvm::VPWidenIntOrFpInductionRecipe::classof ( const VPDef * D )

inlinestatic

Method to support type inquiry through isa, cast, and dyn_cast.

Definition at line 1072 of file VPlan.h.

References D.

◆ execute()

void VPWidenIntOrFpInductionRecipe::execute ( VPTransformState & State )

overridevirtual

Generate the vectorized and scalarized versions of the phi node as needed by their users.

Implements llvm::VPRecipeBase.

Definition at line 9515 of file LoopVectorize.cpp.

References llvm::MCID::Add, llvm::PHINode::addIncoming(), llvm::InnerLoopVectorizer::addMetadata(), assert(), llvm::VPTransformState::Builder, llvm::InnerLoopVectorizer::Builder, llvm::VPTransformState::CFG, llvm::PHINode::Create(), llvm::IRBuilderBase::CreateBinOp(), llvm::IRBuilderBase::CreateCast(), llvm::IRBuilderBase::CreateTrunc(), llvm::IRBuilderBase::CreateVectorSplat(), llvm::VPTransformState::get(), llvm::Instruction::getDebugLoc(), llvm::BasicBlock::getFirstInsertionPt(), llvm::VPTransformState::CFGState::getPreheaderBBFor(), llvm::getRuntimeVF(), llvm::getRuntimeVFAsFloat(), getSignedIntOrFpConstant(), llvm::ConstantVector::getSplat(), getStepVector(), llvm::BasicBlock::getTerminator(), llvm::Value::getType(), llvm::VPTransformState::ILV, llvm::VPTransformState::Instance, llvm::Type::isFloatingPointTy(), llvm::Type::isIntegerTy(), llvm::ElementCount::isVector(), IV, Mul, llvm::VPTransformState::CFGState::PrevBB, llvm::IRBuilderBase::restoreIP(), llvm::IRBuilderBase::saveIP(), llvm::VPTransformState::set(), llvm::Instruction::setDebugLoc(), llvm::IRBuilderBase::setFastMathFlags(), llvm::IRBuilderBase::SetInsertPoint(), llvm::Value::setName(), llvm::VPTransformState::UF, and llvm::VPTransformState::VF.

◆ getInductionDescriptor()

const InductionDescriptor& llvm::VPWidenIntOrFpInductionRecipe::getInductionDescriptor ( ) const

inline

Returns the induction descriptor for the recipe.

Definition at line 1106 of file VPlan.h.

◆ getPHINode()

PHINode* llvm::VPWidenIntOrFpInductionRecipe::getPHINode ( )

inline

Definition at line 1103 of file VPlan.h.

◆ getScalarType()

const Type* llvm::VPWidenIntOrFpInductionRecipe::getScalarType ( ) const

inline

Returns the scalar type of the induction.

Definition at line 1113 of file VPlan.h.

References getTruncInst(), and llvm::Value::getType().

◆ getStartValue() [1/2]

VPValue* llvm::VPWidenIntOrFpInductionRecipe::getStartValue ( )

inline

Returns the start value of the induction.

Definition at line 1087 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getStartValue() [2/2]

const VPValue* llvm::VPWidenIntOrFpInductionRecipe::getStartValue ( ) const

inline

Definition at line 1088 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getStepValue() [1/2]

VPValue* llvm::VPWidenIntOrFpInductionRecipe::getStepValue ( )

inline

Returns the step value of the induction.

Definition at line 1091 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getStepValue() [2/2]

const VPValue* llvm::VPWidenIntOrFpInductionRecipe::getStepValue ( ) const

inline

Definition at line 1092 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getTruncInst() [1/2]

TruncInst* llvm::VPWidenIntOrFpInductionRecipe::getTruncInst ( )

inline

Returns the first defined value as TruncInst, if it is one or nullptr otherwise.

Definition at line 1096 of file VPlan.h.

References llvm::VPValue::getUnderlyingValue(), and llvm::VPDef::getVPValue().

Referenced by getScalarType().

◆ getTruncInst() [2/2]

const TruncInst* llvm::VPWidenIntOrFpInductionRecipe::getTruncInst ( ) const

inline

Definition at line 1099 of file VPlan.h.

References llvm::VPValue::getUnderlyingValue(), and llvm::VPDef::getVPValue().

◆ isCanonical()

bool VPWidenIntOrFpInductionRecipe::isCanonical ( ) const

Returns true if the induction is canonical, i.e.

starting at 0 and incremented by UF * VF (= the original IV is incremented by 1).

Definition at line 1322 of file VPlan.cpp.

◆ needsScalarIV()

bool llvm::VPWidenIntOrFpInductionRecipe::needsScalarIV ( ) const

inline

Returns true if a scalar phi needs to be created for the induction.

Definition at line 1119 of file VPlan.h.

◆ needsVectorIV()

bool llvm::VPWidenIntOrFpInductionRecipe::needsVectorIV ( ) const

inline

Returns true if a vector phi needs to be created for the induction.

Definition at line 1122 of file VPlan.h.

◆ print()

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

overridevirtual

Print the recipe.

Implements llvm::VPDef.

Definition at line 1296 of file VPlan.cpp.

References IV, and llvm::RISCVFenceField::O.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPWidenIntOrFpInductionRecipe() [1/2]

◆ VPWidenIntOrFpInductionRecipe() [2/2]

◆ ~VPWidenIntOrFpInductionRecipe()

Member Function Documentation

◆ classof()

◆ execute()

◆ getInductionDescriptor()

◆ getPHINode()

◆ getScalarType()

◆ getStartValue() [1/2]

◆ getStartValue() [2/2]

◆ getStepValue() [1/2]

◆ getStepValue() [2/2]

◆ getTruncInst() [1/2]

◆ getTruncInst() [2/2]

◆ isCanonical()

◆ needsScalarIV()

◆ needsVectorIV()

◆ print()