LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::VPInterleaveRecipe Class Reference

VPInterleaveRecipe is a recipe for transforming an interleave group of load or stores into one wide load/store and shuffles. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPInterleaveRecipe:
Inheritance graph
[legend]
Collaboration diagram for llvm::VPInterleaveRecipe:
Collaboration graph
[legend]

Public Member Functions

 VPInterleaveRecipe (const InterleaveGroup< Instruction > *IG, VPValue *Addr, ArrayRef< VPValue * > StoredValues, VPValue *Mask)
 
 ~VPInterleaveRecipe () override=default
 
VPValuegetAddr () const
 Return the address accessed by this recipe. More...
 
VPValuegetMask () const
 Return the mask used by this recipe. More...
 
ArrayRef< VPValue * > getStoredValues () const
 Return the VPValues stored by this interleave group. More...
 
void execute (VPTransformState &State) override
 Generate the wide load or store, and shuffles. More...
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe. More...
 
const InterleaveGroup< Instruction > * getInterleaveGroup ()
 
unsigned getNumStoreOperands () const
 Returns the number of stored operands of this interleave group. 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
 
VPBasicBlockgetParent ()
 
const VPBasicBlockgetParent () const
 
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...
 
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise. More...
 
const InstructiongetUnderlyingInstr () 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 >
VPRecipeBasegetPrevNode ()
 
const VPRecipeBasegetPrevNode () const
 Get the previous node, or nullptr for the list head. More...
 
VPRecipeBasegetNextNode ()
 Get the next node, or nullptr for the list tail. More...
 
const VPRecipeBasegetNextNode () 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 ()
 
VPValuegetVPSingleValue ()
 Returns the only VPValue defined by the VPDef. More...
 
const VPValuegetVPSingleValue () const
 
VPValuegetVPValue (unsigned I)
 Returns the VPValue with index I defined by the VPDef. More...
 
const VPValuegetVPValue (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
 
VPUseroperator= (const VPUser &)=delete
 
virtual ~VPUser ()
 
VPUserID getVPUserID () const
 
void addOperand (VPValue *Operand)
 
unsigned getNumOperands () const
 
VPValuegetOperand (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 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, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPWidenCallSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenCanonicalIVSC, 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_iteratoroperand_range
 
typedef iterator_range< const_operand_iteratorconst_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

VPInterleaveRecipe is a recipe for transforming an interleave group of load or stores into one wide load/store and shuffles.

The first operand of a VPInterleave recipe is the address, followed by the stored values, followed by an optional mask.

Definition at line 1272 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPInterleaveRecipe()

llvm::VPInterleaveRecipe::VPInterleaveRecipe ( const InterleaveGroup< Instruction > *  IG,
VPValue Addr,
ArrayRef< VPValue * >  StoredValues,
VPValue Mask 
)
inline

Definition at line 1278 of file VPlan.h.

References Addr.

◆ ~VPInterleaveRecipe()

llvm::VPInterleaveRecipe::~VPInterleaveRecipe ( )
overridedefault

Member Function Documentation

◆ classof()

static bool llvm::VPInterleaveRecipe::classof ( const VPDef D)
inlinestatic

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

Definition at line 1298 of file VPlan.h.

References D.

◆ execute()

void VPInterleaveRecipe::execute ( VPTransformState State)
overridevirtual

Generate the wide load or store, and shuffles.

Implements llvm::VPRecipeBase.

Definition at line 9766 of file LoopVectorize.cpp.

References assert(), llvm::VPTransformState::ILV, llvm::VPTransformState::Instance, and llvm::InnerLoopVectorizer::vectorizeInterleaveGroup().

◆ getAddr()

VPValue* llvm::VPInterleaveRecipe::getAddr ( ) const
inline

Return the address accessed by this recipe.

Definition at line 1303 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getInterleaveGroup()

const InterleaveGroup<Instruction>* llvm::VPInterleaveRecipe::getInterleaveGroup ( )
inline

Definition at line 1332 of file VPlan.h.

◆ getMask()

VPValue* llvm::VPInterleaveRecipe::getMask ( ) const
inline

Return the mask used by this recipe.

Note that a full mask is represented by a nullptr.

Definition at line 1309 of file VPlan.h.

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

◆ getNumStoreOperands()

unsigned llvm::VPInterleaveRecipe::getNumStoreOperands ( ) const
inline

Returns the number of stored operands of this interleave group.

Returns 0 for load interleave groups.

Definition at line 1336 of file VPlan.h.

References llvm::VPUser::getNumOperands().

Referenced by getStoredValues().

◆ getStoredValues()

ArrayRef<VPValue *> llvm::VPInterleaveRecipe::getStoredValues ( ) const
inline

Return the VPValues stored by this interleave group.

If it is a load interleave group, return an empty ArrayRef.

Definition at line 1316 of file VPlan.h.

References llvm::VPUser::getNumOperands(), getNumStoreOperands(), llvm::VPUser::op_begin(), and llvm::ArrayRef< T >::slice().

◆ print()

void VPInterleaveRecipe::print ( raw_ostream O,
const Twine Indent,
VPSlotTracker SlotTracker 
) const
overridevirtual

Print the recipe.

Implements llvm::VPDef.

Definition at line 9465 of file LoopVectorize.cpp.

References i, llvm::BitmaskEnumDetail::Mask(), and llvm::RISCVFenceField::O.


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