LLVM 23.0.0git
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:
[legend]

Public Types

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 Member Functions

 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
 ~VPRecipeBase () override=default
virtual VPRecipeBaseclone ()=0
 Clone the current recipe.
VPBasicBlockgetParent ()
const VPBasicBlockgetParent () const
VPRegionBlockgetRegion ()
const VPRegionBlockgetRegion () 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.
unsigned getVPRecipeID () const
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.
LLVM_ABI_FOR_TEST void dump () const
 Dump the recipe to stderr (for debugging).
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const
 Print the recipe, delegating to printRecipe().
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 ()
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< VPRecipeValue * > definedValues ()
 Returns an ArrayRef of the values defined by the VPDef.
ArrayRef< VPRecipeValue * > definedValues () const
 Returns an ArrayRef of the values defined by the VPDef.
unsigned getNumDefinedValues () const
 Returns the number of values defined by the VPDef.
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 usesFirstLaneOnly (const VPValue *Op) const
 Returns true if the VPUser only uses the first lane of operand Op.
virtual bool usesFirstPartOnly (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.
virtual void printRecipe (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
 Each concrete VPRecipe prints itself, without printing common information, like debug info or metadata.
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)

Friends

class VPBlockUtils

Additional Inherited Members

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

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 384 of file VPlan.h.

Member Typedef Documentation

◆ VPRecipeTy

An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.

Values of this enumeration are kept in the SubclassID field of the VPRecipeBase objects. They are used for concrete type identification.

Definition at line 405 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPRecipeBase()

◆ ~VPRecipeBase()

llvm::VPRecipeBase::~VPRecipeBase ( )
overridedefault

Member Function Documentation

◆ classof() [1/2]

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

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

Definition at line 511 of file VPlan.h.

References D(), and llvm::VPDef::VPDef().

◆ classof() [2/2]

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

Definition at line 516 of file VPlan.h.

References llvm::VPUser::VPUser().

◆ clone()

◆ computeCost()

◆ 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 269 of file VPlanRecipes.cpp.

References computeCost(), llvm::dbgs(), dump(), llvm::dyn_cast(), llvm::dyn_cast_or_null(), llvm::ForceTargetInstructionCost, InstructionCost, llvm::InstructionCost::isValid(), llvm::ElementCount::isVector(), and LLVM_DEBUG.

Referenced by execute().

◆ dump()

void VPRecipeBase::dump ( ) const

Dump the recipe to stderr (for debugging).

Definition at line 114 of file VPlan.cpp.

References llvm::dbgs(), getParent(), and print().

Referenced by cost(), and llvm::VPSingleDefRecipe::dump().

◆ eraseFromParent()

◆ execute()

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

◆ getDebugLoc()

◆ getParent() [1/2]

◆ getParent() [2/2]

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

Definition at line 463 of file VPlan.h.

◆ getRegion() [1/2]

VPRegionBlock * llvm::VPRecipeBase::getRegion ( )
inline

◆ getRegion() [2/2]

const VPRegionBlock * llvm::VPRecipeBase::getRegion ( ) const
inline

Definition at line 4390 of file VPlan.h.

References llvm::VPBlockBase::getParent(), and getParent().

◆ getVPRecipeID()

unsigned llvm::VPRecipeBase::getVPRecipeID ( ) const
inline
Returns
an ID for the concrete type of this object.

Definition at line 508 of file VPlan.h.

Referenced by isPhi(), mayHaveSideEffects(), mayReadFromMemory(), and mayWriteToMemory().

◆ insertAfter()

void VPRecipeBase::insertAfter ( VPRecipeBase * InsertPos)

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

Definition at line 240 of file VPlanRecipes.cpp.

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

Referenced by execute(), llvm::VPlanTransforms::materializePacksAndUnpacks(), moveAfter(), and tryToReplaceALMWithWideALM().

◆ 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 233 of file VPlanRecipes.cpp.

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

◆ insertBefore() [2/2]

◆ isPhi()

bool VPRecipeBase::isPhi ( ) const

Returns true for PHI-like recipes.

Definition at line 308 of file VPlanRecipes.cpp.

References getVPRecipeID(), and llvm::isa().

◆ isScalarCast()

bool VPRecipeBase::isScalarCast ( ) const

◆ mayHaveSideEffects()

◆ mayReadFromMemory()

bool VPRecipeBase::mayReadFromMemory ( ) const

Returns true if the recipe may read from memory.

Definition at line 110 of file VPlanRecipes.cpp.

References assert(), llvm::cast(), llvm::dyn_cast_or_null(), getVPRecipeID(), 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 531 of file VPlan.h.

References mayReadFromMemory(), and mayWriteToMemory().

◆ mayWriteToMemory()

bool VPRecipeBase::mayWriteToMemory ( ) const

Returns true if the recipe may write to memory.

Definition at line 50 of file VPlanRecipes.cpp.

References assert(), llvm::cast(), llvm::dyn_cast_or_null(), getVPRecipeID(), 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 258 of file VPlanRecipes.cpp.

References insertAfter(), removeFromParent(), and VPRecipeBase().

Referenced by execute(), and llvm::VPlanTransforms::handleMaxMinNumReductions().

◆ 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 263 of file VPlanRecipes.cpp.

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

Referenced by execute(), llvm::VPlanTransforms::handleMultiUseReductions(), preparePlanForMainVectorLoop(), and sinkScalarOperands().

◆ print()

void VPRecipeBase::print ( raw_ostream & O,
const Twine & Indent,
VPSlotTracker & SlotTracker ) const

Print the recipe, delegating to printRecipe().

Definition at line 387 of file VPlanRecipes.cpp.

References llvm::dyn_cast(), getDebugLoc(), llvm::Metadata::print(), and printRecipe().

Referenced by dump(), and llvm::VPBasicBlock::print().

◆ printRecipe()

◆ removeFromParent()

void VPRecipeBase::removeFromParent ( )

◆ setDebugLoc()

void llvm::VPRecipeBase::setDebugLoc ( DebugLoc NewDL)
inline

Set the recipe's debug location to NewDL.

Definition at line 542 of file VPlan.h.

◆ VPBlockUtils

friend class VPBlockUtils
friend

Definition at line 389 of file VPlan.h.

References VPBlockUtils.

Referenced by VPBlockUtils.


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