llvm::VPWidenMemoryInstructionRecipe Class Reference

A Recipe for widening load/store operations. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenMemoryInstructionRecipe:

Collaboration diagram for llvm::VPWidenMemoryInstructionRecipe:

Public Member Functions
	VPWidenMemoryInstructionRecipe (LoadInst &Load, VPValue *Addr, VPValue *Mask, bool Consecutive, bool Reverse)
	VPWidenMemoryInstructionRecipe (StoreInst &Store, VPValue *Addr, VPValue *StoredValue, VPValue *Mask, bool Consecutive, bool Reverse)
VPValue *	getAddr () const
	Return the address accessed by this recipe.
VPValue *	getMask () const
	Return the mask used by this recipe.
bool	isStore () const
	Returns true if this recipe is a store.
VPValue *	getStoredValue () const
	Return the address accessed by this recipe.
bool	isConsecutive () const
bool	isReverse () const
void	execute (VPTransformState &State) override
	Generate the wide load/store.
void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the recipe.
bool	onlyFirstLaneUsed (const VPValue *Op) const override
	Returns true if the recipe only uses the first lane of operand Op.
Instruction &	getIngredient () const
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.

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

Detailed Description

A Recipe for widening load/store operations.

The recipe uses the following VPValues:

• For load: Address, optional mask
• For store: Address, stored value, optional mask TODO: We currently execute only per-part unless a specific instance is provided.

Definition at line 1653 of file VPlan.h.

Constructor & Destructor Documentation

VPWidenMemoryInstructionRecipe() [1/2]

llvm::VPWidenMemoryInstructionRecipe::VPWidenMemoryInstructionRecipe ( LoadInst &  Load, VPValue *  Addr, VPValue *  Mask, bool  Consecutive, bool  Reverse  )

inline

Definition at line 1673 of file VPlan.h.

References Addr.

VPWidenMemoryInstructionRecipe() [2/2]

llvm::VPWidenMemoryInstructionRecipe::VPWidenMemoryInstructionRecipe ( StoreInst &  Store, VPValue *  Addr, VPValue *  StoredValue, VPValue *  Mask, bool  Consecutive, bool  Reverse  )

inline

Definition at line 1682 of file VPlan.h.

References Addr.

Member Function Documentation

execute()

void VPWidenMemoryInstructionRecipe::execute ( VPTransformState &  State )

overridevirtual

Generate the wide load/store.

Implements llvm::VPRecipeBase.

Definition at line 9590 of file LoopVectorize.cpp.

References llvm::VPTransformState::addMetadata(), assert(), llvm::InnerLoopVectorizer::Builder, llvm::VPTransformState::Builder, llvm::IRBuilderBase::CreateAlignedLoad(), llvm::IRBuilderBase::CreateAlignedStore(), llvm::IRBuilderBase::CreateBitCast(), llvm::IRBuilderBase::CreateGEP(), llvm::IRBuilderBase::CreateMaskedGather(), llvm::IRBuilderBase::CreateMaskedLoad(), llvm::IRBuilderBase::CreateMaskedScatter(), llvm::IRBuilderBase::CreateMaskedStore(), llvm::IRBuilderBase::CreateMul(), llvm::createStepForVF(), llvm::IRBuilderBase::CreateSub(), llvm::IRBuilderBase::CreateVectorReverse(), DL, gep, llvm::VectorType::get(), llvm::PoisonValue::get(), llvm::ConstantInt::get(), llvm::VPTransformState::get(), llvm::Module::getDataLayout(), llvm::IRBuilderBase::GetInsertBlock(), llvm::IRBuilderBase::getInt32Ty(), llvm::getLoadStoreAlignment(), llvm::getLoadStoreType(), llvm::BasicBlock::getModule(), llvm::Type::getPointerTo(), llvm::getRuntimeVF(), llvm::getStoredValue(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::isScalable(), isStore(), llvm::InnerLoopVectorizer::LI, Ptr, llvm::VPTransformState::set(), llvm::VPTransformState::setDebugLocFromInst(), SI, llvm::VPTransformState::UF, and llvm::VPTransformState::VF.

getAddr()

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

inline

Return the address accessed by this recipe.

Definition at line 1694 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by onlyFirstLaneUsed().

getIngredient()

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

inline

Definition at line 1742 of file VPlan.h.

getMask()

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

inline

Return the mask used by this recipe.

Note that a full mask is represented by a nullptr.

Definition at line 1700 of file VPlan.h.

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

getStoredValue()

VPValue * llvm::VPWidenMemoryInstructionRecipe::getStoredValue ( ) const

inline

Return the address accessed by this recipe.

Definition at line 1709 of file VPlan.h.

References assert(), llvm::VPUser::getOperand(), and isStore().

Referenced by onlyFirstLaneUsed().

isConsecutive()

bool llvm::VPWidenMemoryInstructionRecipe::isConsecutive ( ) const

inline

Definition at line 1715 of file VPlan.h.

Referenced by onlyFirstLaneUsed().

isReverse()

bool llvm::VPWidenMemoryInstructionRecipe::isReverse ( ) const

inline

Definition at line 1719 of file VPlan.h.

isStore()

bool llvm::VPWidenMemoryInstructionRecipe::isStore ( ) const

inline

Returns true if this recipe is a store.

Definition at line 1706 of file VPlan.h.

Referenced by getStoredValue(), onlyFirstLaneUsed(), and print().

onlyFirstLaneUsed()

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

References assert(), getAddr(), getStoredValue(), llvm::is_contained(), isConsecutive(), isStore(), and llvm::VPUser::operands().

print()

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

overridevirtual

Print the recipe.

Implements llvm::VPDef.

Definition at line 1059 of file VPlanRecipes.cpp.

References llvm::Instruction::getOpcode(), llvm::Instruction::getOpcodeName(), llvm::VPDef::getVPSingleValue(), isStore(), 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/LoopVectorize.cpp
• lib/Transforms/Vectorize/VPlanRecipes.cpp