LLVM 22.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::VPIRPhi Struct Reference

An overlay for VPIRInstructions wrapping PHI nodes enabling convenient use cast/dyn_cast/isa and execute() implementation. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPIRPhi:
[legend]

Public Member Functions

 VPIRPhi (PHINode &PN)
 
PHINodegetIRPhi ()
 
void execute (VPTransformState &State) override
 The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe.
 
- Public Member Functions inherited from llvm::VPIRInstruction
 ~VPIRInstruction () override=default
 
VPIRInstructionclone () override
 Clone the current recipe.
 
void execute (VPTransformState &State) override
 The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
 
LLVM_ABI_FOR_TEST InstructionCost computeCost (ElementCount VF, VPCostContext &Ctx) const override
 Return the cost of this VPIRInstruction.
 
InstructiongetInstruction () const
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe.
 
bool usesScalars (const VPValue *Op) const override
 Returns true if the VPUser uses scalars of operand Op.
 
bool onlyFirstPartUsed (const VPValue *Op) const override
 Returns true if the VPUser only uses the first part of operand Op.
 
bool onlyFirstLaneUsed (const VPValue *Op) const override
 Returns true if the VPUser only uses the first lane of operand Op.
 
void extractLastLaneOfFirstOperand (VPBuilder &Builder)
 Update the recipes first operand to the last lane of the operand using Builder.
 
- 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::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.
 
virtual unsigned getNumIncoming () const
 Returns the number of incoming values, also number of incoming blocks.
 
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 *U)
 
- Static Public Member Functions inherited from llvm::VPIRInstruction
static LLVM_ABI_FOR_TEST VPIRInstructioncreate (Instruction &I)
 Create a new VPIRPhi for \I , if it is a PHINode, otherwise create a VPIRInstruction.
 
- 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 Member Functions

const VPRecipeBasegetAsRecipe () const override
 Return a VPRecipeBase* to the current object.
 
- Protected Member Functions inherited from llvm::VPIRInstruction
 VPIRInstruction (Instruction &I)
 VPIRInstruction::create() should be used to create VPIRInstructions, as subclasses may need to be created, e.g.
 
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)
 
virtual const VPRecipeBasegetAsRecipe () const =0
 Return a VPRecipeBase* to the current object.
 

Additional Inherited Members

- Public Types inherited from llvm::VPDef
using VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPExpressionSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveEVLSC, 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::VPPhiAccessors
using const_incoming_blocks_range = iterator_range< mapped_iterator< detail::index_iterator, std::function< const VPBasicBlock *(size_t)> > >
 
- 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

An overlay for VPIRInstructions wrapping PHI nodes enabling convenient use cast/dyn_cast/isa and execute() implementation.

A single VPValue operand is allowed, and it is used to add a new incoming value for the single predecessor VPBB.

Definition at line 1409 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPIRPhi()

llvm::VPIRPhi::VPIRPhi ( PHINode PN)
inline

Definition at line 1411 of file VPlan.h.

Member Function Documentation

◆ classof()

static bool llvm::VPIRPhi::classof ( const VPRecipeBase U)
inlinestatic

Definition at line 1413 of file VPlan.h.

◆ execute()

void VPIRPhi::execute ( VPTransformState State)
overridevirtual

◆ getAsRecipe()

const VPRecipeBase * llvm::VPIRPhi::getAsRecipe ( ) const
inlineoverrideprotectedvirtual

Return a VPRecipeBase* to the current object.

Implements llvm::VPPhiAccessors.

Definition at line 1429 of file VPlan.h.

◆ getIRPhi()

PHINode & llvm::VPIRPhi::getIRPhi ( )
inline

Definition at line 1418 of file VPlan.h.

Referenced by execute().

◆ print()

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

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