LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::VPRecipeBase Class Referenceabstract

VPRecipeBase is a base class modeling a sequence of one or more output IR instructions. More...

#include "Transforms/Vectorize/VPlan.h"

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

Public Member Functions

 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 VPRecipeBase * clone ()=0
 Clone the current recipe.
 
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.
 
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 >
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::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 ()
 
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)
 
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.
 

Static Public Member Functions

static bool classof (const VPDef *D)
 Method to support type inquiry through isa, cast, and dyn_cast.
 
static bool classof (const VPUser *U)
 

Protected Member Functions

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)
 

Friends

class VPBlockUtils
 

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_iterator > operand_range
 
typedef iterator_range< const_operand_iterator > const_operand_range
 
- 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
 

Detailed Description

VPRecipeBase is a base class modeling a sequence of one or more output IR instructions.

VPRecipeBase owns the VPValues it defines through VPDef and is responsible for deleting its defined values. Single-value recipes must inherit from VPSingleDef instead of inheriting from both VPRecipeBase and VPValue separately.

Definition at line 764 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPRecipeBase() [1/2]

llvm::VPRecipeBase::VPRecipeBase ( const unsigned char  SC,
ArrayRef< VPValue * >  Operands,
DebugLoc  DL = {} 
)
inline

Definition at line 777 of file VPlan.h.

◆ VPRecipeBase() [2/2]

template<typename IterT >
llvm::VPRecipeBase::VPRecipeBase ( const unsigned char  SC,
iterator_range< IterT >  Operands,
DebugLoc  DL = {} 
)
inline

Definition at line 782 of file VPlan.h.

◆ ~VPRecipeBase()

virtual llvm::VPRecipeBase::~VPRecipeBase ( )
virtualdefault

Member Function Documentation

◆ classof() [1/2]

static bool llvm::VPRecipeBase::classof ( const VPDef *  D)
inlinestatic

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

Definition at line 833 of file VPlan.h.

◆ classof() [2/2]

static bool llvm::VPRecipeBase::classof ( const VPUser *  U)
inlinestatic

Definition at line 838 of file VPlan.h.

References llvm::VPUser::Recipe.

◆ clone()

virtual VPRecipeBase * llvm::VPRecipeBase::clone ( )
pure virtual

Clone the current recipe.

Implemented in llvm::VPInstruction, llvm::VPWidenRecipe, llvm::VPWidenCastRecipe, llvm::VPScalarCastRecipe, llvm::VPWidenCallRecipe, llvm::VPWidenSelectRecipe, llvm::VPWidenGEPRecipe, llvm::VPVectorPointerRecipe, llvm::VPWidenIntOrFpInductionRecipe, llvm::VPWidenPointerInductionRecipe, llvm::VPWidenPHIRecipe, llvm::VPFirstOrderRecurrencePHIRecipe, llvm::VPReductionPHIRecipe, llvm::VPBlendRecipe, llvm::VPInterleaveRecipe, llvm::VPReductionRecipe, llvm::VPReductionEVLRecipe, llvm::VPReplicateRecipe, llvm::VPBranchOnMaskRecipe, llvm::VPPredInstPHIRecipe, llvm::VPWidenMemoryRecipe, llvm::VPWidenLoadRecipe, llvm::VPWidenStoreRecipe, llvm::VPExpandSCEVRecipe, llvm::VPCanonicalIVPHIRecipe, llvm::VPActiveLaneMaskPHIRecipe, llvm::VPEVLBasedIVPHIRecipe, llvm::VPWidenCanonicalIVRecipe, llvm::VPDerivedIVRecipe, llvm::VPScalarIVStepsRecipe, and llvm::VPSingleDefRecipe.

◆ computeCost()

InstructionCost VPRecipeBase::computeCost ( ElementCount  VF,
VPCostContext &  Ctx 
) const
protectedvirtual

Compute the cost of this recipe either using a recipe's specialized implementation or using the legacy cost model and the underlying instructions.

Reimplemented in llvm::VPWidenRecipe.

Definition at line 302 of file VPlanRecipes.cpp.

References getInstructionForCost(), llvm::VPCostContext::getLegacyCost(), and llvm::VPCostContext::SkipCostComputation.

Referenced by cost().

◆ cost()

InstructionCost VPRecipeBase::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.

Also takes care of printing the cost for debugging.

Definition at line 285 of file VPlanRecipes.cpp.

References computeCost(), llvm::dbgs(), llvm::VPDef::dump(), ForceTargetInstructionCost, getInstructionForCost(), llvm::InstructionCost::isValid(), llvm::ElementCount::isVector(), LLVM_DEBUG, and llvm::VPCostContext::skipCostComputation().

◆ eraseFromParent()

iplist< VPRecipeBase >::iterator VPRecipeBase::eraseFromParent ( )

This method unlinks 'this' from the containing basic block and deletes it.

Returns
an iterator pointing to the element after the erased one

Definition at line 257 of file VPlanRecipes.cpp.

References assert(), llvm::iplist_impl< IntrusiveListT, TraitsT >::erase(), llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >::getIterator(), getParent(), and llvm::VPBasicBlock::getRecipeList().

Referenced by addVPLaneMaskPhiAndUpdateExitBranch(), createReplicateRegion(), and removeRedundantCanonicalIVs().

◆ execute()

virtual void llvm::VPRecipeBase::execute ( VPTransformState &  State)
pure virtual

The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

Implemented in llvm::VPInstruction, llvm::VPWidenRecipe, llvm::VPWidenCastRecipe, llvm::VPScalarCastRecipe, llvm::VPWidenCallRecipe, llvm::VPWidenSelectRecipe, llvm::VPWidenGEPRecipe, llvm::VPVectorPointerRecipe, llvm::VPWidenIntOrFpInductionRecipe, llvm::VPWidenPointerInductionRecipe, llvm::VPWidenPHIRecipe, llvm::VPFirstOrderRecurrencePHIRecipe, llvm::VPReductionPHIRecipe, llvm::VPBlendRecipe, llvm::VPInterleaveRecipe, llvm::VPReductionRecipe, llvm::VPReductionEVLRecipe, llvm::VPReplicateRecipe, llvm::VPBranchOnMaskRecipe, llvm::VPPredInstPHIRecipe, llvm::VPWidenMemoryRecipe, llvm::VPWidenLoadRecipe, llvm::VPWidenLoadEVLRecipe, llvm::VPWidenStoreRecipe, llvm::VPWidenStoreEVLRecipe, llvm::VPExpandSCEVRecipe, llvm::VPCanonicalIVPHIRecipe, llvm::VPActiveLaneMaskPHIRecipe, llvm::VPEVLBasedIVPHIRecipe, llvm::VPWidenCanonicalIVRecipe, llvm::VPDerivedIVRecipe, llvm::VPScalarIVStepsRecipe, and llvm::VPHeaderPHIRecipe.

◆ getDebugLoc()

DebugLoc llvm::VPRecipeBase::getDebugLoc ( ) const
inline

Returns the debug location of the recipe.

Definition at line 862 of file VPlan.h.

References DL.

Referenced by llvm::VPInstruction::clone(), llvm::VPWidenCallRecipe::clone(), llvm::VPVectorPointerRecipe::clone(), llvm::VPWidenLoadRecipe::clone(), llvm::VPWidenStoreRecipe::clone(), llvm::VPCanonicalIVPHIRecipe::clone(), llvm::VPActiveLaneMaskPHIRecipe::clone(), llvm::VPInstruction::execute(), llvm::VPWidenRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPBlendRecipe::execute(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), llvm::VPCanonicalIVPHIRecipe::execute(), llvm::VPActiveLaneMaskPHIRecipe::execute(), llvm::VPEVLBasedIVPHIRecipe::execute(), legalizeAndOptimizeInductions(), llvm::VPInstruction::print(), and llvm::VPlanTransforms::tryAddExplicitVectorLength().

◆ getParent() [1/2]

VPBasicBlock * llvm::VPRecipeBase::getParent ( )
inline
Returns
the VPBasicBlock which this VPRecipe belongs to.

Definition at line 791 of file VPlan.h.

Referenced by llvm::VPlanTransforms::adjustFixedOrderRecurrences(), llvm::VPInstruction::dump(), eraseFromParent(), llvm::VPWidenPointerInductionRecipe::execute(), llvm::VPLiveOut::fixPhi(), llvm::VPSlotTracker::getOrCreateName(), insertAfter(), insertBefore(), llvm::VPWidenIntOrFpInductionRecipe::isCanonical(), removeFromParent(), llvm::InnerLoopVectorizer::scalarizeInstruction(), llvm::VPBuilder::setInsertPoint(), and sinkScalarOperands().

◆ getParent() [2/2]

const VPBasicBlock * llvm::VPRecipeBase::getParent ( ) const
inline

Definition at line 792 of file VPlan.h.

◆ insertAfter()

void VPRecipeBase::insertAfter ( VPRecipeBase *  InsertPos)

Insert an unlinked Recipe into a basic block immediately after the specified Recipe.

Definition at line 244 of file VPlanRecipes.cpp.

References assert(), llvm::ilist_node_impl< OptionsT >::getIterator(), getParent(), and llvm::VPBasicBlock::insert().

Referenced by moveAfter().

◆ insertBefore() [1/2]

void VPRecipeBase::insertBefore ( VPBasicBlock &  BB,
iplist< VPRecipeBase >::iterator  IP 
)

Insert an unlinked recipe into BB immediately before the insertion point IP;.

Definition at line 237 of file VPlanRecipes.cpp.

References assert(), llvm::VPBasicBlock::end(), I, and llvm::VPBasicBlock::insert().

◆ insertBefore() [2/2]

void VPRecipeBase::insertBefore ( VPRecipeBase *  InsertPos)

Insert an unlinked recipe into a basic block immediately before the specified recipe.

Definition at line 230 of file VPlanRecipes.cpp.

References assert(), llvm::ilist_node_impl< OptionsT >::getIterator(), getParent(), and llvm::VPBasicBlock::insert().

Referenced by moveBefore(), llvm::VPlanTransforms::truncateToMinimalBitwidths(), llvm::VPlanTransforms::tryAddExplicitVectorLength(), and llvm::VPlanTransforms::VPInstructionsToVPRecipes().

◆ isPhi()

bool llvm::VPRecipeBase::isPhi ( ) const
inline

Returns true for PHI-like recipes.

Definition at line 846 of file VPlan.h.

References llvm::VPDef::getVPDefID().

◆ mayHaveSideEffects()

bool VPRecipeBase::mayHaveSideEffects ( ) const

Returns true if the recipe may have side-effects.

Definition at line 129 of file VPlanRecipes.cpp.

References assert(), llvm::VPInstruction::CalculateTripCountMinusVF, llvm::VPInstruction::CanonicalIVIncrementForPart, llvm::Function::doesNotThrow(), llvm::VPInstruction::ExtractFromEnd, llvm::VPInstruction::FirstOrderRecurrenceSplice, getOpcode(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), I, llvm::VPInstruction::LogicalAnd, mayHaveSideEffects(), mayWriteToMemory(), llvm::VPInstruction::Not, llvm::VPInstruction::PtrAdd, and llvm::Function::willReturn().

Referenced by mayHaveSideEffects(), and sinkScalarOperands().

◆ mayReadFromMemory()

bool VPRecipeBase::mayReadFromMemory ( ) const

Returns true if the recipe may read from memory.

Definition at line 89 of file VPlanRecipes.cpp.

References assert(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), and I.

Referenced by mayReadOrWriteMemory().

◆ mayReadOrWriteMemory()

bool llvm::VPRecipeBase::mayReadOrWriteMemory ( ) const
inline

Returns true if the recipe may read from or write to memory.

Definition at line 857 of file VPlan.h.

References mayReadFromMemory(), and mayWriteToMemory().

Referenced by sinkScalarOperands().

◆ mayWriteToMemory()

bool VPRecipeBase::mayWriteToMemory ( ) const

Returns true if the recipe may write to memory.

Definition at line 47 of file VPlanRecipes.cpp.

References assert(), llvm::VPDef::getVPDefID(), llvm::VPDef::getVPSingleValue(), and I.

Referenced by mayHaveSideEffects(), and mayReadOrWriteMemory().

◆ moveAfter()

void VPRecipeBase::moveAfter ( VPRecipeBase *  MovePos)

Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos.

Definition at line 262 of file VPlanRecipes.cpp.

References insertAfter(), and removeFromParent().

◆ moveBefore()

void VPRecipeBase::moveBefore ( VPBasicBlock &  BB,
iplist< VPRecipeBase >::iterator  I 
)

Unlink this recipe and insert into BB before I.

Precondition
I is a valid iterator into BB.

Definition at line 267 of file VPlanRecipes.cpp.

References I, insertBefore(), and removeFromParent().

Referenced by sinkScalarOperands().

◆ removeFromParent()

void VPRecipeBase::removeFromParent ( )

This method unlinks 'this' from the containing basic block, but does not delete it.

Definition at line 251 of file VPlanRecipes.cpp.

References assert(), llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >::getIterator(), getParent(), llvm::VPBasicBlock::getRecipeList(), and llvm::iplist_impl< IntrusiveListT, TraitsT >::remove().

Referenced by moveAfter(), and moveBefore().

Friends And Related Function Documentation

◆ VPBlockUtils

friend class VPBlockUtils
friend

Definition at line 768 of file VPlan.h.

The documentation for this class was generated from the following files:
Generated on Wed Nov 13 2024 00:08:59 for LLVM by doxygen 1.9.6