LLVM 22.0.0git
llvm::VPWidenPHIRecipe Class Reference

A recipe for widened phis. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenPHIRecipe:
[legend]

Public Member Functions

 VPWidenPHIRecipe (PHINode *Phi, VPValue *Start=nullptr, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
 Create a new VPWidenPHIRecipe for Phi with start value Start and debug location DL.
VPWidenPHIRecipeclone () override
 Clone the current recipe.
 ~VPWidenPHIRecipe () override=default
void execute (VPTransformState &State) override
 Generate the phi/select nodes.
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe.
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())
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
VPBasicBlockgetParent ()
const VPBasicBlockgetParent () const
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 ()
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 (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).
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::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.

Protected Member Functions

const VPRecipeBasegetAsRecipe () const override
 Return a VPRecipeBase* to the current object.
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< 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)
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.

Additional Inherited Members

Public Types inherited from llvm::VPDef
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 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
Public Types inherited from llvm::VPPhiAccessors
using const_incoming_blocks_range
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< VPRecipeBase, Options... >::type >
using self_iterator
using const_self_iterator
using reverse_self_iterator
using const_reverse_self_iterator
Protected Attributes inherited from llvm::VPValue
ValueUnderlyingVal
VPDefDef
 Pointer to the VPDef that defines this VPValue.

Detailed Description

A recipe for widened phis.

Incoming values are operands of the recipe and their operand index corresponds to the incoming predecessor block. If the recipe is placed in an entry block to a (non-replicate) region, it must have exactly 2 incoming values, the first from the predecessor of the region and the second from the exiting block of the region.

Definition at line 2238 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenPHIRecipe()

llvm::VPWidenPHIRecipe::VPWidenPHIRecipe ( PHINode * Phi,
VPValue * Start = nullptr,
DebugLoc DL = DebugLoc::getUnknown(),
const Twine & Name = "" )
inline

Create a new VPWidenPHIRecipe for Phi with start value Start and debug location DL.

Definition at line 2249 of file VPlan.h.

References addOperand(), llvm::DebugLoc::getUnknown(), and llvm::VPSingleDefRecipe::VPSingleDefRecipe().

Referenced by clone().

◆ ~VPWidenPHIRecipe()

llvm::VPWidenPHIRecipe::~VPWidenPHIRecipe ( )
overridedefault

References execute().

Member Function Documentation

◆ clone()

VPWidenPHIRecipe * llvm::VPWidenPHIRecipe::clone ( )
inlineoverridevirtual

◆ execute()

void VPWidenPHIRecipe::execute ( VPTransformState & State)
overridevirtual

Generate the phi/select nodes.

Implements llvm::VPRecipeBase.

Definition at line 4209 of file VPlanRecipes.cpp.

References llvm::VPUser::getOperand(), and llvm::Value::getType().

Referenced by ~VPWidenPHIRecipe().

◆ getAsRecipe()

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

Return a VPRecipeBase* to the current object.

Implements llvm::VPPhiAccessors.

Definition at line 2244 of file VPlan.h.

◆ print()

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

Print the recipe.

Implements llvm::VPDef.

Definition at line 4217 of file VPlanRecipes.cpp.

References llvm::VPValue::printAsOperand(), and llvm::VPPhiAccessors::printPhiOperands().


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