VPRecipeBase is a base class modeling a sequence of one or more output IR instructions. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPRecipeBase:

[legend]

Collaboration diagram for llvm::VPRecipeBase:

[legend]

Public Member Functions
	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 (struct VPTransformState &State)=0
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan. More...

void	insertBefore (VPRecipeBase *InsertPos)
	Insert an unlinked recipe into a basic block immediately before the specified recipe. 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...

virtual void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
	Each concrete VPDef prints itself. 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

Static Public Member Functions
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...

Friends
class	VPBlockUtils

Additional Inherited Members
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPCanonicalIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, 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

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)

Detailed Description

VPRecipeBase is a base class modeling a sequence of one or more output IR instructions.

VPRecipeBase owns the the VPValues it defines through VPDef and is responsible for deleting its defined values. Single-value VPRecipeBases that also inherit from VPValue must make sure to inherit from VPRecipeBase before VPValue.

Definition at line 673 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPRecipeBase() [1/2]

llvm::VPRecipeBase::VPRecipeBase	(	const unsigned char	SC,
		ArrayRef< VPValue * >	Operands
	)

inline

Definition at line 683 of file VPlan.h.

◆ VPRecipeBase() [2/2]

template<typename IterT >

llvm::VPRecipeBase::VPRecipeBase	(	const unsigned char	SC,
		iterator_range< IterT >	Operands
	)

inline

Definition at line 687 of file VPlan.h.

◆ ~VPRecipeBase()

virtual llvm::VPRecipeBase::~VPRecipeBase ( )

virtualdefault

Member Function Documentation

◆ classof() [1/2]

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

inlinestatic

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

Definition at line 735 of file VPlan.h.

◆ classof() [2/2]

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

inlinestatic

Definition at line 740 of file VPlan.h.

References llvm::VPUser::getVPUserID(), and llvm::VPUser::Recipe.

◆ eraseFromParent()

iplist< VPRecipeBase >::iterator VPRecipeBase::eraseFromParent ( )

This method unlinks 'this' from the containing basic block and deletes it.

Returns: an iterator pointing to the element after the erased one

Definition at line 623 of file VPlan.cpp.

References assert(), llvm::iplist_impl< IntrusiveListT, TraitsT >::erase(), llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >::getIterator(), getParent(), and llvm::VPBasicBlock::getRecipeList().

◆ execute()

virtual void llvm::VPRecipeBase::execute ( struct VPTransformState & State )

pure virtual

The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

Implemented in llvm::VPHeaderPHIRecipe, llvm::VPWidenCanonicalIVRecipe, llvm::VPCanonicalIVPHIRecipe, llvm::VPWidenMemoryInstructionRecipe, llvm::VPPredInstPHIRecipe, llvm::VPBranchOnMaskRecipe, llvm::VPReplicateRecipe, llvm::VPReductionRecipe, llvm::VPInterleaveRecipe, llvm::VPBlendRecipe, llvm::VPReductionPHIRecipe, llvm::VPFirstOrderRecurrencePHIRecipe, llvm::VPWidenPHIRecipe, llvm::VPWidenIntOrFpInductionRecipe, llvm::VPWidenGEPRecipe, llvm::VPWidenSelectRecipe, llvm::VPWidenCallRecipe, llvm::VPWidenRecipe, and llvm::VPInstruction.

◆ getParent() [1/2]

VPBasicBlock* llvm::VPRecipeBase::getParent ( )

inline

Returns: the VPBasicBlock which this VPRecipe belongs to.

Definition at line 692 of file VPlan.h.

Referenced by llvm::VPValue::dump(), llvm::VPDef::dump(), llvm::VPInstruction::dump(), eraseFromParent(), insertAfter(), insertBefore(), llvm::operator<<(), removeFromParent(), and llvm::InnerLoopVectorizer::widenPHIInstruction().

◆ getParent() [2/2]

const VPBasicBlock* llvm::VPRecipeBase::getParent ( ) const

inline

Definition at line 693 of file VPlan.h.

◆ getUnderlyingInstr() [1/2]

Instruction* llvm::VPRecipeBase::getUnderlyingInstr ( )

inline

Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise.

Definition at line 727 of file VPlan.h.

References llvm::VPDef::getVPSingleValue().

Referenced by llvm::VPWidenRecipe::print(), llvm::VPWidenCallRecipe::print(), llvm::VPReductionRecipe::print(), and llvm::VPReplicateRecipe::print().

◆ getUnderlyingInstr() [2/2]

const Instruction* llvm::VPRecipeBase::getUnderlyingInstr ( ) const

inline

Definition at line 730 of file VPlan.h.

References llvm::VPDef::getVPSingleValue().

◆ insertAfter()

void VPRecipeBase::insertAfter ( VPRecipeBase * InsertPos )

Insert an unlinked Recipe into a basic block immediately after the specified Recipe.

Definition at line 609 of file VPlan.cpp.

References assert(), llvm::ilist_node_impl< OptionsT >::getIterator(), getParent(), llvm::VPBasicBlock::getRecipeList(), and llvm::iplist_impl< IntrusiveListT, TraitsT >::insertAfter().

Referenced by moveAfter().

◆ insertBefore()

void VPRecipeBase::insertBefore ( VPRecipeBase * InsertPos )

Insert an unlinked recipe into a basic block immediately before the specified recipe.

Definition at line 601 of file VPlan.cpp.

References assert(), llvm::ilist_node_impl< OptionsT >::getIterator(), getParent(), llvm::VPBasicBlock::getRecipeList(), and llvm::iplist_impl< IntrusiveListT, TraitsT >::insert().

◆ isPhi()

bool llvm::VPRecipeBase::isPhi ( ) const

inline

Returns true for PHI-like recipes.

Definition at line 748 of file VPlan.h.

References llvm::VPDef::getVPDefID().

◆ mayHaveSideEffects()

bool VPRecipeBase::mayHaveSideEffects ( ) const

Returns true if the recipe may have side-effects.

Definition at line 573 of file VPlan.cpp.

References assert(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), and I.

◆ mayReadFromMemory()

bool VPRecipeBase::mayReadFromMemory ( ) const

Returns true if the recipe may read from memory.

Definition at line 542 of file VPlan.cpp.

References assert(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), and I.

Referenced by mayReadOrWriteMemory().

◆ mayReadOrWriteMemory()

bool llvm::VPRecipeBase::mayReadOrWriteMemory ( ) const

inline

Returns true if the recipe may read from or write to memory.

Definition at line 759 of file VPlan.h.

References mayReadFromMemory(), and mayWriteToMemory().

◆ mayWriteToMemory()

bool VPRecipeBase::mayWriteToMemory ( ) const

Returns true if the recipe may write to memory.

Definition at line 511 of file VPlan.cpp.

References assert(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), and I.

Referenced by mayReadOrWriteMemory().

◆ moveAfter()

void VPRecipeBase::moveAfter ( VPRecipeBase * MovePos )

Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos.

Definition at line 628 of file VPlan.cpp.

References insertAfter(), and removeFromParent().

◆ moveBefore()

void VPRecipeBase::moveBefore	(	VPBasicBlock &	BB,
		iplist< VPRecipeBase >::iterator	I
	)

Unlink this recipe and insert into BB before I.

Precondition: I is a valid iterator into BB.

Definition at line 633 of file VPlan.cpp.

References assert(), BB, I, and removeFromParent().

◆ removeFromParent()

void VPRecipeBase::removeFromParent ( )

This method unlinks 'this' from the containing basic block, but does not delete it.

Definition at line 617 of file VPlan.cpp.

References assert(), llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >::getIterator(), getParent(), llvm::VPBasicBlock::getRecipeList(), and llvm::iplist_impl< IntrusiveListT, TraitsT >::remove().

Referenced by moveAfter(), and moveBefore().

Friends And Related Function Documentation

◆ VPBlockUtils

friend class VPBlockUtils

friend

Definition at line 677 of file VPlan.h.

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VPRecipeBase() [1/2]

◆ VPRecipeBase() [2/2]

◆ ~VPRecipeBase()

Member Function Documentation

◆ classof() [1/2]

◆ classof() [2/2]

◆ eraseFromParent()

◆ execute()

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ getUnderlyingInstr() [1/2]

◆ getUnderlyingInstr() [2/2]

◆ insertAfter()

◆ insertBefore()

◆ isPhi()

◆ mayHaveSideEffects()

◆ mayReadFromMemory()

◆ mayReadOrWriteMemory()

◆ mayWriteToMemory()

◆ moveAfter()

◆ moveBefore()

◆ removeFromParent()

Friends And Related Function Documentation

◆ VPBlockUtils