LLVM 22.0.0git
llvm::VPWidenInductionRecipe Class Referenceabstract

Base class for widened induction (VPWidenIntOrFpInductionRecipe and VPWidenPointerInductionRecipe), providing shared functionality, including retrieving the step value, induction descriptor and original phi node. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenInductionRecipe:
[legend]

Public Member Functions

 VPWidenInductionRecipe (unsigned char Kind, PHINode *IV, VPValue *Start, VPValue *Step, const InductionDescriptor &IndDesc, DebugLoc DL)
virtual void execute (VPTransformState &State) override=0
 Generate the phi nodes.
VPValuegetStepValue ()
 Returns the step value of the induction.
const VPValuegetStepValue () const
void setStepValue (VPValue *V)
 Update the step value of the recipe.
VPValuegetVFValue ()
const VPValuegetVFValue () const
unsigned getNumIncoming () const override
 Returns the number of incoming values, also number of incoming blocks.
PHINodegetPHINode () const
const InductionDescriptorgetInductionDescriptor () const
 Returns the induction descriptor for the recipe.
VPValuegetBackedgeValue () override
 Returns the incoming value from the loop backedge.
VPRecipeBasegetBackedgeRecipe () override
 Returns the backedge value as a recipe.
bool onlyFirstLaneUsed (const VPValue *Op) const override
 Returns true if the recipe only uses the first lane of operand Op.
Public Member Functions inherited from llvm::VPHeaderPHIRecipe
 ~VPHeaderPHIRecipe () override=default
InstructionCost computeCost (ElementCount VF, VPCostContext &Ctx) const override
 Return the cost of this header phi recipe.
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override=0
 Print the recipe.
VPValuegetStartValue ()
 Returns the start value of the phi, if one is set.
VPValuegetStartValue () const
void setStartValue (VPValue *V)
 Update the start value of the recipe.
void setBackedgeValue (VPValue *V)
 Update the incoming value from the loop backedge.
Public Member Functions inherited from llvm::VPSingleDefRecipe
 VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
 VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, Value *UV, DebugLoc DL=DebugLoc::getUnknown())
virtual VPSingleDefRecipeclone () override=0
 Clone the current recipe.
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction.
const InstructiongetUnderlyingInstr () const
LLVM_DUMP_METHOD void dump () const
 Print this VPSingleDefRecipe to dbgs() (for debugging).
Public Member Functions inherited from llvm::VPRecipeBase
 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
virtual ~VPRecipeBase ()=default
VPBasicBlockgetParent ()
const VPBasicBlockgetParent () const
InstructionCost cost (ElementCount VF, VPCostContext &Ctx)
 Return the cost of this recipe, taking into account if the cost computation should be skipped and the ForceTargetInstructionCost flag.
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.
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.
DebugLoc getDebugLoc () const
 Returns the debug location of the recipe.
bool isScalarCast () const
 Return true if the recipe is a scalar cast.
void setDebugLoc (DebugLoc NewDL)
 Set the recipe's debug location to NewDL.
Public Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
VPRecipeBasegetPrevNode ()
VPRecipeBasegetNextNode ()
 Get the next node, or nullptr for the list tail.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
self_iterator getIterator ()
reverse_self_iterator getReverseIterator ()
std::enable_if_t< T::is_sentinel_tracking_explicit, boolisSentinel () const
 Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >, ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty * getParent () const
void setParent (ilist_detail::compute_node_options< VPRecipeBase, Options... >::type::parent_ty *Parent)
Public Member Functions inherited from llvm::VPDef
 VPDef (const unsigned char SC)
virtual ~VPDef ()
VPValuegetVPSingleValue ()
 Returns the only VPValue defined by the VPDef.
const VPValuegetVPSingleValue () const
VPValuegetVPValue (unsigned I)
 Returns the VPValue with index I defined by the VPDef.
const VPValuegetVPValue (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).
Public Member Functions inherited from llvm::VPUser
 VPUser ()=delete
 VPUser (const VPUser &)=delete
VPUseroperator= (const VPUser &)=delete
virtual ~VPUser ()
void addOperand (VPValue *Operand)
unsigned getNumOperands () const
VPValuegetOperand (unsigned N) const
void setOperand (unsigned I, VPValue *New)
void swapOperands ()
 Swap operands of the VPUser. It must have exactly 2 operands.
void replaceUsesOfWith (VPValue *From, VPValue *To)
 Replaces all uses of From in the VPUser with To.
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 onlyFirstPartUsed (const VPValue *Op) const
 Returns true if the VPUser only uses the first part of operand Op.
Public Member Functions inherited from llvm::VPValue
ValuegetUnderlyingValue () const
 Return the underlying Value attached to this VPValue.
 VPValue (const VPValue &)=delete
VPValueoperator= (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).
unsigned getNumUsers () const
void addUser (VPUser &User)
void removeUser (VPUser &User)
 Remove a single User from the list of users.
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 () const
 Returns true if the value has more than one unique user.
void replaceAllUsesWith (VPValue *New)
void replaceUsesWithIf (VPValue *New, llvm::function_ref< bool(VPUser &U, unsigned Idx)> ShouldReplace)
 Go through the uses list for this VPValue and make each use point to New if the callback ShouldReplace returns true for the given use specified by a pair of (VPUser, the use index).
VPRecipeBasegetDefiningRecipe ()
 Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe, i.e.
const VPRecipeBasegetDefiningRecipe () const
bool hasDefiningRecipe () const
 Returns true if this VPValue is defined by a recipe.
bool isLiveIn () const
 Returns true if this VPValue is a live-in, i.e. defined outside the VPlan.
ValuegetLiveInIRValue () const
 Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.
bool isDefinedOutsideLoopRegions () const
 Returns true if the VPValue is defined outside any loop.
void setUnderlyingValue (Value *Val)
Public Member Functions inherited from llvm::VPPhiAccessors
virtual ~VPPhiAccessors ()=default
VPValuegetIncomingValue (unsigned Idx) const
 Returns the incoming VPValue with index Idx.
const VPBasicBlockgetIncomingBlock (unsigned Idx) const
 Returns the incoming block with index Idx.
VPUser::const_operand_range incoming_values () const
 Returns an interator range over the incoming values.
const_incoming_blocks_range incoming_blocks () const
 Returns an iterator range over the incoming blocks.
detail::zippy< llvm::detail::zip_first, VPUser::const_operand_range, const_incoming_blocks_rangeincoming_values_and_blocks () const
 Returns an iterator range over pairs of incoming values and corresponding incoming blocks.
void removeIncomingValueFor (VPBlockBase *IncomingBlock) const
 Removes the incoming value for IncomingBlock, which must be a predecessor.
void printPhiOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
 Print the recipe.

Static Public Member Functions

static bool classof (const VPRecipeBase *R)
static bool classof (const VPValue *V)
static bool classof (const VPHeaderPHIRecipe *R)
Static Public Member Functions inherited from llvm::VPHeaderPHIRecipe
static bool classof (const VPRecipeBase *B)
 Method to support type inquiry through isa, cast, and dyn_cast.
static bool classof (const VPValue *V)
Static Public Member Functions inherited from llvm::VPSingleDefRecipe
static bool classof (const VPRecipeBase *R)
static bool classof (const VPUser *U)
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)

Additional Inherited Members

Public Types inherited from llvm::VPDef
using VPRecipeTy
 An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.
Public Types inherited from llvm::VPUser
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
Public Types inherited from llvm::VPValue
enum  { VPValueSC , VPVRecipeSC }
 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_iteratoruser_range
typedef iterator_range< const_user_iteratorconst_user_range
Public Types inherited from llvm::VPPhiAccessors
using const_incoming_blocks_range
Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
using self_iterator
using const_self_iterator
using reverse_self_iterator
using const_reverse_self_iterator
Protected Member Functions inherited from llvm::VPHeaderPHIRecipe
 VPHeaderPHIRecipe (unsigned char VPDefID, Instruction *UnderlyingInstr, VPValue *Start, DebugLoc DL=DebugLoc::getUnknown())
const VPRecipeBasegetAsRecipe () const override
 Return a VPRecipeBase* to the current object.
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.
 VPUser (ArrayRef< VPValue * > Operands)
Protected Member Functions inherited from llvm::VPValue
 VPValue (const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
 VPValue (Value *UV=nullptr)
 Create a live-in VPValue.
 VPValue (VPDef *Def, Value *UV=nullptr)
 Create a VPValue for a Def which is a subclass of VPValue.
 VPValue (Value *UV, VPDef *Def)
 Create a VPValue for a Def which defines multiple values.
Protected Attributes inherited from llvm::VPValue
ValueUnderlyingVal
VPDefDef
 Pointer to the VPDef that defines this VPValue.

Detailed Description

Base class for widened induction (VPWidenIntOrFpInductionRecipe and VPWidenPointerInductionRecipe), providing shared functionality, including retrieving the step value, induction descriptor and original phi node.

Definition at line 2028 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenInductionRecipe()

Member Function Documentation

◆ classof() [1/3]

bool llvm::VPWidenInductionRecipe::classof ( const VPHeaderPHIRecipe * R)
inlinestatic

Definition at line 2049 of file VPlan.h.

References classof(), and llvm::VPHeaderPHIRecipe::VPHeaderPHIRecipe().

◆ classof() [2/3]

bool llvm::VPWidenInductionRecipe::classof ( const VPRecipeBase * R)
inlinestatic

Definition at line 2039 of file VPlan.h.

Referenced by classof(), and classof().

◆ classof() [3/3]

bool llvm::VPWidenInductionRecipe::classof ( const VPValue * V)
inlinestatic

Definition at line 2044 of file VPlan.h.

References classof().

◆ execute()

virtual void llvm::VPWidenInductionRecipe::execute ( VPTransformState & State)
overridepure virtual

◆ getBackedgeRecipe()

VPRecipeBase & llvm::VPWidenInductionRecipe::getBackedgeRecipe ( )
inlineoverridevirtual

Returns the backedge value as a recipe.

The backedge value is guaranteed to be a recipe.

Reimplemented from llvm::VPHeaderPHIRecipe.

Definition at line 2082 of file VPlan.h.

References llvm_unreachable.

◆ getBackedgeValue()

VPValue * llvm::VPWidenInductionRecipe::getBackedgeValue ( )
inlineoverridevirtual

Returns the incoming value from the loop backedge.

Reimplemented from llvm::VPHeaderPHIRecipe.

Definition at line 2075 of file VPlan.h.

References llvm_unreachable.

◆ getInductionDescriptor()

const InductionDescriptor & llvm::VPWidenInductionRecipe::getInductionDescriptor ( ) const
inline

◆ getNumIncoming()

unsigned llvm::VPWidenInductionRecipe::getNumIncoming ( ) const
inlineoverridevirtual

Returns the number of incoming values, also number of incoming blocks.

Note that at the moment, VPWidenPointerInductionRecipe only has a single incoming value, its start value.

Reimplemented from llvm::VPPhiAccessors.

Reimplemented in llvm::VPWidenIntOrFpInductionRecipe.

Definition at line 2068 of file VPlan.h.

◆ getPHINode()

PHINode * llvm::VPWidenInductionRecipe::getPHINode ( ) const
inline

◆ getStepValue() [1/2]

◆ getStepValue() [2/2]

const VPValue * llvm::VPWidenInductionRecipe::getStepValue ( ) const
inline

Definition at line 2057 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getVFValue() [1/2]

VPValue * llvm::VPWidenInductionRecipe::getVFValue ( )
inline

◆ getVFValue() [2/2]

const VPValue * llvm::VPWidenInductionRecipe::getVFValue ( ) const
inline

Definition at line 2063 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ onlyFirstLaneUsed()

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

References assert(), llvm::VPHeaderPHIRecipe::getStartValue(), getStepValue(), llvm::is_contained(), and llvm::VPUser::operands().

◆ setStepValue()

void llvm::VPWidenInductionRecipe::setStepValue ( VPValue * V)
inline

Update the step value of the recipe.

Definition at line 2060 of file VPlan.h.

References llvm::VPUser::setOperand().


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