LLVM 20.0.0git
Public Member Functions | List of all members
llvm::VPWidenIntOrFpInductionRecipe Class Reference

A recipe for handling phi nodes of integer and floating-point inductions, producing their vector values. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenIntOrFpInductionRecipe:
Inheritance graph
[legend]

Public Member Functions

 VPWidenIntOrFpInductionRecipe (PHINode *IV, VPValue *Start, VPValue *Step, const InductionDescriptor &IndDesc)
 
 VPWidenIntOrFpInductionRecipe (PHINode *IV, VPValue *Start, VPValue *Step, const InductionDescriptor &IndDesc, TruncInst *Trunc)
 
 ~VPWidenIntOrFpInductionRecipe () override=default
 
VPWidenIntOrFpInductionRecipeclone () override
 Clone the current recipe.
 
void execute (VPTransformState &State) override
 Generate the vectorized and scalarized versions of the phi node as needed by their users.
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe.
 
VPValuegetBackedgeValue () override
 Returns the incoming value from the loop backedge.
 
VPRecipeBasegetBackedgeRecipe () override
 Returns the backedge value as a recipe.
 
VPValuegetStepValue ()
 Returns the step value of the induction.
 
const VPValuegetStepValue () const
 
TruncInstgetTruncInst ()
 Returns the first defined value as TruncInst, if it is one or nullptr otherwise.
 
const TruncInstgetTruncInst () const
 
PHINodegetPHINode ()
 
const InductionDescriptorgetInductionDescriptor () const
 Returns the induction descriptor for the recipe.
 
bool isCanonical () const
 Returns true if the induction is canonical, i.e.
 
TypegetScalarType () const
 Returns the scalar type of the induction.
 
- Public Member Functions inherited from llvm::VPHeaderPHIRecipe
 ~VPHeaderPHIRecipe () override=default
 
void execute (VPTransformState &State) override=0
 Generate the phi nodes.
 
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.
 
virtual VPValuegetBackedgeValue ()
 Returns the incoming value from the loop backedge.
 
virtual VPRecipeBasegetBackedgeRecipe ()
 Returns the backedge value as a recipe.
 
- Public Member Functions inherited from llvm::VPSingleDefRecipe
template<typename IterT >
 VPSingleDefRecipe (const unsigned char SC, IterT Operands, DebugLoc DL={})
 
 VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL={})
 
template<typename IterT >
 VPSingleDefRecipe (const unsigned char SC, IterT Operands, Value *UV, DebugLoc DL={})
 
virtual VPSingleDefRecipeclone () override=0
 Clone the current recipe.
 
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction.
 
const InstructiongetUnderlyingInstr () const
 
- Public Member Functions inherited from llvm::VPRecipeBase
 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL={})
 
template<typename IterT >
 VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands, DebugLoc DL={})
 
virtual ~VPRecipeBase ()=default
 
virtual VPRecipeBaseclone ()=0
 Clone the current recipe.
 
VPBasicBlockgetParent ()
 
const VPBasicBlockgetParent () const
 
virtual void execute (VPTransformState &State)=0
 The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
 
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.
 
- 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.
 
VPRecipeBasegetNextNode ()
 Get the next node, or nullptr for the list tail.
 
const VPRecipeBasegetNextNode () 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::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy * getParent () const
 
ParentTy * getParent ()
 
void setParent (ParentTy *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).
 
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
 
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)
 
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.
 
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 (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.
 
 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 ()
 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 ()
 Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.
 
const ValuegetLiveInIRValue () const
 
bool isDefinedOutsideVectorRegions () const
 Returns true if the VPValue is defined outside any vector regions, i.e.
 
void setUnderlyingValue (Value *Val)
 

Additional Inherited Members

- Public Types inherited from llvm::VPDef
using VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPInstructionSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, VPReplicateSC, VPScalarCastSC, VPScalarIVStepsSC, VPVectorPointerSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenLoadEVLSC, VPWidenLoadSC, VPWidenStoreEVLSC, VPWidenStoreSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPWidenPHISC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPEVLBasedIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPWidenPHISC, 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_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
 
- 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)
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type
 
using const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type
 
using reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type
 
using const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type
 
- Protected Member Functions inherited from llvm::VPHeaderPHIRecipe
 VPHeaderPHIRecipe (unsigned char VPDefID, Instruction *UnderlyingInstr, VPValue *Start=nullptr, DebugLoc DL={})
 
- Protected Member Functions inherited from llvm::VPRecipeBase
virtual InstructionCost computeCost (ElementCount VF, VPCostContext &Ctx) const
 Compute the cost of this recipe either using a recipe's specialized implementation or using the legacy cost model and the underlying instructions.
 
- 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)
 
- Protected Member Functions inherited from llvm::VPValue
 VPValue (const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
 
- Protected Attributes inherited from llvm::VPValue
ValueUnderlyingVal
 
VPDefDef
 Pointer to the VPDef that defines this VPValue.
 

Detailed Description

A recipe for handling phi nodes of integer and floating-point inductions, producing their vector values.

Definition at line 1784 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenIntOrFpInductionRecipe() [1/2]

llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe ( PHINode IV,
VPValue Start,
VPValue Step,
const InductionDescriptor IndDesc 
)
inline

Definition at line 1790 of file VPlan.h.

References addOperand().

◆ VPWidenIntOrFpInductionRecipe() [2/2]

llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe ( PHINode IV,
VPValue Start,
VPValue Step,
const InductionDescriptor IndDesc,
TruncInst Trunc 
)
inline

Definition at line 1797 of file VPlan.h.

References addOperand().

◆ ~VPWidenIntOrFpInductionRecipe()

llvm::VPWidenIntOrFpInductionRecipe::~VPWidenIntOrFpInductionRecipe ( )
overridedefault

Member Function Documentation

◆ clone()

VPWidenIntOrFpInductionRecipe * llvm::VPWidenIntOrFpInductionRecipe::clone ( )
inlineoverridevirtual

Clone the current recipe.

Implements llvm::VPSingleDefRecipe.

Definition at line 1807 of file VPlan.h.

References llvm::VPHeaderPHIRecipe::getStartValue(), and getStepValue().

◆ execute()

void VPWidenIntOrFpInductionRecipe::execute ( VPTransformState State)
overridevirtual

◆ getBackedgeRecipe()

VPRecipeBase & llvm::VPWidenIntOrFpInductionRecipe::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 1831 of file VPlan.h.

References llvm_unreachable.

◆ getBackedgeValue()

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

Returns the incoming value from the loop backedge.

Reimplemented from llvm::VPHeaderPHIRecipe.

Definition at line 1824 of file VPlan.h.

References llvm_unreachable.

◆ getInductionDescriptor()

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

Returns the induction descriptor for the recipe.

Definition at line 1850 of file VPlan.h.

Referenced by execute().

◆ getPHINode()

PHINode * llvm::VPWidenIntOrFpInductionRecipe::getPHINode ( )
inline

Definition at line 1847 of file VPlan.h.

◆ getScalarType()

Type * llvm::VPWidenIntOrFpInductionRecipe::getScalarType ( ) const
inline

Returns the scalar type of the induction.

Definition at line 1858 of file VPlan.h.

References llvm::Value::getType().

Referenced by isCanonical().

◆ getStepValue() [1/2]

VPValue * llvm::VPWidenIntOrFpInductionRecipe::getStepValue ( )
inline

Returns the step value of the induction.

Definition at line 1839 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by clone(), execute(), isCanonical(), and print().

◆ getStepValue() [2/2]

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

Definition at line 1840 of file VPlan.h.

References llvm::VPUser::getOperand().

◆ getTruncInst() [1/2]

TruncInst * llvm::VPWidenIntOrFpInductionRecipe::getTruncInst ( )
inline

Returns the first defined value as TruncInst, if it is one or nullptr otherwise.

Definition at line 1844 of file VPlan.h.

Referenced by execute(), and print().

◆ getTruncInst() [2/2]

const TruncInst * llvm::VPWidenIntOrFpInductionRecipe::getTruncInst ( ) const
inline

Definition at line 1845 of file VPlan.h.

◆ isCanonical()

bool VPWidenIntOrFpInductionRecipe::isCanonical ( ) const

Returns true if the induction is canonical, i.e.

starting at 0 and incremented by UF * VF (= the original IV is incremented by 1) and has the same type as the canonical induction.

Definition at line 1440 of file VPlanRecipes.cpp.

References llvm::VPValue::getDefiningRecipe(), llvm::VPValue::getLiveInIRValue(), llvm::VPRecipeBase::getParent(), llvm::Type::getScalarType(), getScalarType(), llvm::VPHeaderPHIRecipe::getStartValue(), and getStepValue().

◆ print()

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

Print the recipe.

Implements llvm::VPHeaderPHIRecipe.

Definition at line 1424 of file VPlanRecipes.cpp.

References getStepValue(), getTruncInst(), llvm::VPDef::getVPValue(), and llvm::VPValue::printAsOperand().


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