LLVM  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::VPInstruction Class Reference

This is a concrete Recipe that models a single VPlan-level instruction. More...

#include "Transforms/Vectorize/VPlan.h"

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

Public Types

enum  {
  FirstOrderRecurrenceSplice, Not, ICmpULE, SLPLoad,
  SLPStore, ActiveLaneMask
}
 VPlan opcodes, extending LLVM IR with idiomatics instructions. More...
 
- Public Types inherited from llvm::VPDef
using VPRecipeTy = enum { VPBranchOnMaskSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPWidenCallSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenCanonicalIVSC, VPWidenIntOrFpInductionSC, VPPredInstPHISC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, VPLastPHISC=VPReductionPHISC, }
 An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated. More...
 
- Public Types inherited from llvm::VPUser
enum  VPUserID { VPUserID::Recipe, VPUserID::Block }
 Subclass identifier (for isa/dyn_cast). More...
 
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, VPVInstructionSC, VPVMemoryInstructionSC, VPVReductionSC,
  VPVReplicateSC, VPVWidenSC, VPVWidenCallSC, VPVWidenGEPSC,
  VPVWidenSelectSC, VPVBlendSC, VPVFirstOrderRecurrencePHISC, VPVWidenPHISC,
  VPVWidenCanonicalIVSC, VPVWidenIntOrFpInductionSC, VPVPredInstPHI, VPVReductionPHISC
}
 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 Member Functions

 VPInstruction (unsigned Opcode, ArrayRef< VPValue * > Operands)
 
 VPInstruction (unsigned Opcode, std::initializer_list< VPValue * > Operands)
 
VPInstructionclone () const
 
unsigned getOpcode () const
 
void execute (VPTransformState &State) override
 Generate the instruction. More...
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the VPInstruction to O. More...
 
LLVM_DUMP_METHOD void dump () const
 Print the VPInstruction to dbgs() (for debugging). More...
 
bool mayWriteToMemory () const
 Return true if this instruction may modify memory. More...
 
bool hasResult () const
 
void setFastMathFlags (FastMathFlags FMFNew)
 Set the fast-math flags. More...
 
- 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...
 
bool isPhi () const
 Returns true for PHI-like recipes. More...
 
bool mayReadFromMemory () const
 Returns true if the recipe may read from memory. More...
 
bool mayWriteToMemory () const
 Returns true if the recipe may write to memory. More...
 
bool mayReadOrWriteMemory () const
 Returns true if the recipe may read from or write to memory. 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 ()
 
VPValuegetVPSingleValue ()
 Returns the only VPValue defined by the VPDef. More...
 
const VPValuegetVPSingleValue () const
 
VPValuegetVPValue (unsigned I)
 Returns the VPValue with index I defined by the VPDef. More...
 
const VPValuegetVPValue (unsigned I) 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 ()=delete
 
 VPUser (const VPUser &)=delete
 
VPUseroperator= (const VPUser &)=delete
 
virtual ~VPUser ()
 
VPUserID getVPUserID () const
 
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 VPValue *V)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 
static bool classof (const VPDef *R)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 
- 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 bool classof (const VPUser *U)
 
- 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...
 

Protected Member Functions

void setUnderlyingInstr (Instruction *I)
 
- 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...
 
 VPUser (ArrayRef< VPValue * > Operands, VPUserID ID)
 
 VPUser (std::initializer_list< VPValue * > Operands, VPUserID ID)
 
template<typename IterT >
 VPUser (iterator_range< IterT > Operands, VPUserID ID)
 
- Protected Member Functions inherited from llvm::VPValue
 VPValue (const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
 
void setUnderlyingValue (Value *Val)
 

Friends

class VPlanSlp
 

Additional Inherited Members

- 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 Attributes inherited from llvm::VPValue
ValueUnderlyingVal
 
VPDefDef
 Pointer to the VPDef that defines this VPValue. More...
 

Detailed Description

This is a concrete Recipe that models a single VPlan-level instruction.

While as any Recipe it may generate a sequence of IR instructions when executed, these instructions would always form a single-def expression as the VPInstruction is also a single def-use vertex.

Definition at line 778 of file VPlan.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

VPlan opcodes, extending LLVM IR with idiomatics instructions.

Enumerator
FirstOrderRecurrenceSplice 
Not 
ICmpULE 
SLPLoad 
SLPStore 
ActiveLaneMask 

Definition at line 783 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPInstruction() [1/2]

llvm::VPInstruction::VPInstruction ( unsigned  Opcode,
ArrayRef< VPValue * >  Operands 
)
inline

Definition at line 807 of file VPlan.h.

◆ VPInstruction() [2/2]

llvm::VPInstruction::VPInstruction ( unsigned  Opcode,
std::initializer_list< VPValue * >  Operands 
)
inline

Definition at line 811 of file VPlan.h.

Member Function Documentation

◆ classof() [1/2]

static bool llvm::VPInstruction::classof ( const VPDef R)
inlinestatic

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

Definition at line 825 of file VPlan.h.

References llvm::RISCVFenceField::R.

◆ classof() [2/2]

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

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

Definition at line 815 of file VPlan.h.

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

◆ clone()

VPInstruction* llvm::VPInstruction::clone ( ) const
inline

Definition at line 819 of file VPlan.h.

References Operands, llvm::VPUser::operands(), and llvm::VPValue::VPInstruction.

◆ dump()

void VPInstruction::dump ( ) const

Print the VPInstruction to dbgs() (for debugging).

Definition at line 728 of file VPlan.cpp.

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

◆ execute()

void VPInstruction::execute ( VPTransformState State)
overridevirtual

Generate the instruction.

TODO: We currently execute only per-part unless a specific instance is provided.

Implements llvm::VPRecipeBase.

Definition at line 719 of file VPlan.cpp.

References assert(), llvm::VPTransformState::Builder, llvm::VPTransformState::Instance, llvm::IRBuilderBase::setFastMathFlags(), and llvm::VPTransformState::UF.

◆ getOpcode()

unsigned llvm::VPInstruction::getOpcode ( ) const
inline

Definition at line 829 of file VPlan.h.

Referenced by hasResult(), and print().

◆ hasResult()

bool llvm::VPInstruction::hasResult ( ) const
inline

Definition at line 853 of file VPlan.h.

References getOpcode(), llvm::MipsISD::Ret, and llvm::SPII::Store.

Referenced by print().

◆ mayWriteToMemory()

bool llvm::VPInstruction::mayWriteToMemory ( ) const
inline

Return true if this instruction may modify memory.

Definition at line 846 of file VPlan.h.

References llvm::MCID::Call, SLPStore, and llvm::SPII::Store.

◆ print()

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

◆ setFastMathFlags()

void VPInstruction::setFastMathFlags ( FastMathFlags  FMFNew)

Set the fast-math flags.

Definition at line 774 of file VPlan.cpp.

References assert().

◆ setUnderlyingInstr()

void llvm::VPInstruction::setUnderlyingInstr ( Instruction I)
inlineprotected

Definition at line 804 of file VPlan.h.

References I, and llvm::VPValue::setUnderlyingValue().

Friends And Related Function Documentation

◆ VPlanSlp

friend class VPlanSlp
friend

Definition at line 779 of file VPlan.h.


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