LLVM 22.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::VPRecipeWithIRFlags Struct Referenceabstract

A pure-virtual common base class for recipes defining a single VPValue and using IR flags. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPRecipeWithIRFlags:
[legend]

Public Member Functions

 VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
 
 VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, Instruction &I)
 
 VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, const VPIRFlags &Flags, DebugLoc DL=DebugLoc::getUnknown())
 
void execute (VPTransformState &State) override=0
 The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
 
std::optional< InstructionCostgetCostForRecipeWithOpcode (unsigned Opcode, ElementCount VF, VPCostContext &Ctx) const
 Compute the cost for this recipe for VF, using Opcode and Ctx.
 
- 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
 
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.
 
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 ()
 
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
 
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< 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 ()
 
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 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 (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::VPIRFlags
 VPIRFlags ()
 
 VPIRFlags (Instruction &I)
 
 VPIRFlags (CmpInst::Predicate Pred)
 
 VPIRFlags (WrapFlagsTy WrapFlags)
 
 VPIRFlags (FastMathFlags FMFs)
 
 VPIRFlags (DisjointFlagsTy DisjointFlags)
 
 VPIRFlags (NonNegFlagsTy NonNegFlags)
 
 VPIRFlags (GEPNoWrapFlags GEPFlags)
 
void transferFlags (VPIRFlags &Other)
 
void dropPoisonGeneratingFlags ()
 Drop all poison-generating flags.
 
void applyFlags (Instruction &I) const
 Apply the IR flags to I.
 
CmpInst::Predicate getPredicate () const
 
void setPredicate (CmpInst::Predicate Pred)
 
GEPNoWrapFlags getGEPNoWrapFlags () const
 
bool hasPredicate () const
 Returns true if the recipe has a comparison predicate.
 
bool hasFastMathFlags () const
 Returns true if the recipe has fast-math flags.
 
LLVM_ABI_FOR_TEST FastMathFlags getFastMathFlags () const
 
bool hasNonNegFlag () const
 Returns true if the recipe has non-negative flag.
 
bool isNonNeg () const
 
bool hasNoUnsignedWrap () const
 
bool hasNoSignedWrap () const
 
bool isDisjoint () const
 
bool flagsValidForOpcode (unsigned Opcode) const
 Returns true if the set flags are valid for Opcode.
 
void printFlags (raw_ostream &O) const
 

Static Public Member Functions

static bool classof (const VPRecipeBase *R)
 
static bool classof (const VPUser *U)
 
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 = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPExpressionSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, VPPartialReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPVectorPointerSC, VPVectorEndPointerSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenIntrinsicSC, VPWidenLoadEVLSC, VPWidenLoadSC, VPWidenStoreEVLSC, VPWidenStoreSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPHistogramSC, 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
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
 
- 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::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)
 
- 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

A pure-virtual common base class for recipes defining a single VPValue and using IR flags.

Definition at line 865 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPRecipeWithIRFlags() [1/3]

llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
ArrayRef< VPValue * >  Operands,
DebugLoc  DL = DebugLoc::getUnknown() 
)
inline

Definition at line 866 of file VPlan.h.

References DL, and Operands.

◆ VPRecipeWithIRFlags() [2/3]

llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
ArrayRef< VPValue * >  Operands,
Instruction I 
)
inline

Definition at line 870 of file VPlan.h.

References Operands.

◆ VPRecipeWithIRFlags() [3/3]

llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
ArrayRef< VPValue * >  Operands,
const VPIRFlags Flags,
DebugLoc  DL = DebugLoc::getUnknown() 
)
inline

Definition at line 874 of file VPlan.h.

References DL, and Operands.

Member Function Documentation

◆ classof() [1/3]

static bool llvm::VPRecipeWithIRFlags::classof ( const VPRecipeBase R)
inlinestatic

Definition at line 879 of file VPlan.h.

Referenced by classof().

◆ classof() [2/3]

static bool llvm::VPRecipeWithIRFlags::classof ( const VPUser U)
inlinestatic

Definition at line 894 of file VPlan.h.

References classof().

◆ classof() [3/3]

static bool llvm::VPRecipeWithIRFlags::classof ( const VPValue V)
inlinestatic

Definition at line 899 of file VPlan.h.

References classof().

◆ execute()

void llvm::VPRecipeWithIRFlags::execute ( VPTransformState State)
overridepure virtual

◆ getCostForRecipeWithOpcode()

std::optional< InstructionCost > VPRecipeWithIRFlags::getCostForRecipeWithOpcode ( unsigned  Opcode,
ElementCount  VF,
VPCostContext Ctx 
) const

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