LLVM  16.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::VPWidenMemoryInstructionRecipe Class Reference

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

#include "Transforms/Vectorize/VPlan.h"

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

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)
 
VPValuegetAddr () const
 Return the address accessed by this recipe. More...
 
VPValuegetMask () const
 Return the mask used by this recipe. More...
 
bool isStore () const
 Returns true if this recipe is a store. More...
 
VPValuegetStoredValue () const
 Return the address accessed by this recipe. More...
 
bool isConsecutive () const
 
bool isReverse () const
 
void execute (VPTransformState &State) override
 Generate the wide load/store. More...
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe. More...
 
bool onlyFirstLaneUsed (const VPValue *Op) const override
 Returns true if the recipe only uses the first lane of operand Op. More...
 
InstructiongetIngredient () 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
 
VPBasicBlockgetParent ()
 
const VPBasicBlockgetParent () 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...
 
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
 
virtual bool usesScalars (const VPValue *Op) const
 Returns true if the VPUser uses scalars of operand Op. More...
 

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, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, VPFirstHeaderPHISC=VPCanonicalIVPHISC, 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::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_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

A Recipe for widening load/store operations.

The recipe uses the following VPValues:

Definition at line 1702 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 1722 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 1731 of file VPlan.h.

References Addr.

Member Function Documentation

◆ classof()

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

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

Definition at line 1741 of file VPlan.h.

References D.

◆ execute()

void VPWidenMemoryInstructionRecipe::execute ( VPTransformState State)
overridevirtual

◆ getAddr()

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

Return the address accessed by this recipe.

Definition at line 1746 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by onlyFirstLaneUsed().

◆ getIngredient()

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

Definition at line 1794 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 1752 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 1761 of file VPlan.h.

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

Referenced by onlyFirstLaneUsed().

◆ isConsecutive()

bool llvm::VPWidenMemoryInstructionRecipe::isConsecutive ( ) const
inline

Definition at line 1767 of file VPlan.h.

Referenced by onlyFirstLaneUsed().

◆ isReverse()

bool llvm::VPWidenMemoryInstructionRecipe::isReverse ( ) const
inline

Definition at line 1771 of file VPlan.h.

◆ isStore()

bool llvm::VPWidenMemoryInstructionRecipe::isStore ( ) const
inline

Returns true if this recipe is a store.

Definition at line 1758 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 1783 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

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