LLVM  13.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::VPReplicateRecipe Class Reference

VPReplicateRecipe replicates a given instruction producing multiple scalar copies of the original scalar type, one per lane, instead of producing a single copy of widened type for all lanes. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPReplicateRecipe:
Inheritance graph
[legend]
Collaboration diagram for llvm::VPReplicateRecipe:
Collaboration graph
[legend]

Public Member Functions

template<typename IterT >
 VPReplicateRecipe (Instruction *I, iterator_range< IterT > Operands, bool IsUniform, bool IsPredicated=false)
 
 ~VPReplicateRecipe () override=default
 
void execute (VPTransformState &State) override
 Generate replicas of the desired Ingredient. More...
 
void setAlsoPack (bool Pack)
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe. More...
 
bool isUniform () const
 
bool isPacked () const
 
bool isPredicated () const
 
- Public Member Functions inherited from llvm::VPRecipeBase
 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands)
 
template<typename IterT >
 VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands)
 
virtual ~VPRecipeBase ()=default
 
VPBasicBlockgetParent ()
 
const VPBasicBlockgetParent () const
 
void insertBefore (VPRecipeBase *InsertPos)
 Insert an unlinked recipe into a basic block immediately before the specified recipe. More...
 
void insertAfter (VPRecipeBase *InsertPos)
 Insert an unlinked Recipe into a basic block immediately after the specified Recipe. More...
 
void moveAfter (VPRecipeBase *MovePos)
 Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos. More...
 
void moveBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
 Unlink this recipe and insert into BB before I. More...
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it. More...
 
iplist< VPRecipeBase >::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it. More...
 
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise. More...
 
const InstructiongetUnderlyingInstr () const
 
bool mayHaveSideEffects () const
 Returns true if the recipe may have side-effects. More...
 
- 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. More...
 
VPRecipeBasegetNextNode ()
 Get the next node, or nullptr for the list tail. More...
 
const VPRecipeBasegetNextNode () const
 Get the next node, or nullptr for the list tail. More...
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, 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. More...
 
- Public Member Functions inherited from llvm::VPDef
 VPDef (const unsigned char SC)
 
virtual ~VPDef ()
 
VPValuegetVPValue (unsigned I=0)
 Returns the VPValue with index I defined by the VPDef. More...
 
const VPValuegetVPValue (unsigned I=0) const
 
ArrayRef< VPValue * > definedValues ()
 Returns an ArrayRef of the values defined by the VPDef. More...
 
ArrayRef< VPValue * > definedValues () const
 Returns an ArrayRef of the values defined by the VPDef. More...
 
unsigned getNumDefinedValues () const
 Returns the number of values defined by the VPDef. More...
 
unsigned getVPDefID () const
 
void dump () const
 Dump the VPDef to stderr (for debugging). More...
 
- Public Member Functions inherited from llvm::VPUser
 VPUser ()
 
 VPUser (ArrayRef< VPValue * > Operands)
 
 VPUser (std::initializer_list< VPValue * > Operands)
 
template<typename IterT >
 VPUser (iterator_range< IterT > Operands)
 
 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 removeLastOperand ()
 
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
 
- Public Member Functions inherited from llvm::VPValue
ValuegetUnderlyingValue ()
 Return the underlying Value attached to this VPValue. More...
 
const ValuegetUnderlyingValue () const
 
 VPValue (Value *UV=nullptr, VPDef *Def=nullptr)
 
 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). More...
 
unsigned getNumUsers () const
 
void addUser (VPUser &User)
 
void removeUser (VPUser &User)
 Remove a single User from the list of users. More...
 
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 ()
 Returns true if the value has more than one unique user. More...
 
void replaceAllUsesWith (VPValue *New)
 
VPDefgetDef ()
 
ValuegetLiveInIRValue ()
 Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan. More...
 

Static Public Member Functions

static bool classof (const VPDef *D)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 
static bool classof (const VPValue *V)
 
- 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. More...
 
- Static Public Member Functions inherited from llvm::VPUser
static bool classof (const VPDef *Recipe)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 

Additional Inherited Members

- Public Types inherited from llvm::VPDef
using VPRecipeTy = enum { VPBlendSC, VPBranchOnMaskSC, VPInstructionSC, VPInterleaveSC, VPPredInstPHISC, VPReductionSC, VPReplicateSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenGEPSC, VPWidenIntOrFpInductionSC, VPWidenMemoryInstructionSC, VPWidenPHISC, VPWidenSC, VPWidenSelectSC }
 An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated. More...
 
- 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, VPVBlendSC, VPVInstructionSC, VPVMemoryInstructionSC,
  VPVPredInstPHI, VPVReductionSC, VPVReplicateSC, VPVWidenSC,
  VPVWidenCallSC, VPVWidenGEPSC, VPVWidenIntOrFpIndcutionSC, VPVWidenPHISC,
  VPVWidenSelectSC
}
 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< VPRecipeBase, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, true, true >
 
- 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. More...
 
- Protected Member Functions inherited from llvm::VPValue
 VPValue (const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
 
void setUnderlyingValue (Value *Val)
 
- Protected Attributes inherited from llvm::VPValue
ValueUnderlyingVal
 
VPDefDef
 Pointer to the VPDef that defines this VPValue. More...
 

Detailed Description

VPReplicateRecipe replicates a given instruction producing multiple scalar copies of the original scalar type, one per lane, instead of producing a single copy of widened type for all lanes.

If the instruction is known to be uniform only one copy, per lane zero, will be generated.

Definition at line 1213 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPReplicateRecipe()

template<typename IterT >
llvm::VPReplicateRecipe::VPReplicateRecipe ( Instruction I,
iterator_range< IterT >  Operands,
bool  IsUniform,
bool  IsPredicated = false 
)
inline

Definition at line 1225 of file VPlan.h.

References I, and Operands.

◆ ~VPReplicateRecipe()

llvm::VPReplicateRecipe::~VPReplicateRecipe ( )
overridedefault

Member Function Documentation

◆ classof() [1/2]

static bool llvm::VPReplicateRecipe::classof ( const VPDef D)
inlinestatic

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

Definition at line 1240 of file VPlan.h.

References D.

◆ classof() [2/2]

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

Definition at line 1244 of file VPlan.h.

References llvm::VPValue::getVPValueID(), and llvm::VPValue::VPVReplicateSC.

◆ execute()

void VPReplicateRecipe::execute ( VPTransformState State)
overridevirtual

◆ isPacked()

bool llvm::VPReplicateRecipe::isPacked ( ) const
inline

Definition at line 1263 of file VPlan.h.

◆ isPredicated()

bool llvm::VPReplicateRecipe::isPredicated ( ) const
inline

Definition at line 1265 of file VPlan.h.

◆ isUniform()

bool llvm::VPReplicateRecipe::isUniform ( ) const
inline

Definition at line 1261 of file VPlan.h.

◆ print()

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

◆ setAlsoPack()

void llvm::VPReplicateRecipe::setAlsoPack ( bool  Pack)
inline

Definition at line 1253 of file VPlan.h.


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