LLVM 18.0.0git
Classes | Public Member Functions | Static Public Member Functions | List of all members
llvm::VPRecipeWithIRFlags Class Reference

Class to record LLVM IR flag for a recipe along with it. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPRecipeWithIRFlags:
Inheritance graph
[legend]

Classes

struct  WrapFlagsTy
 

Public Member Functions

template<typename IterT >
 VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, DebugLoc DL={})
 
template<typename IterT >
 VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, Instruction &I)
 
template<typename IterT >
 VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, CmpInst::Predicate Pred, DebugLoc DL={})
 
template<typename IterT >
 VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, WrapFlagsTy WrapFlags, DebugLoc DL={})
 
template<typename IterT >
 VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, FastMathFlags FMFs, DebugLoc DL={})
 
void dropPoisonGeneratingFlags ()
 Drop all poison-generating flags.
 
void setFlags (Instruction *I) const
 Set the IR flags for I.
 
CmpInst::Predicate getPredicate () const
 
bool isInBounds () const
 
bool hasFastMathFlags () const
 Returns true if the recipe has fast-math flags.
 
FastMathFlags getFastMathFlags () const
 
bool hasNoUnsignedWrap () const
 
bool hasNoSignedWrap () const
 
void printFlags (raw_ostream &O) const
 
- Public Member Functions inherited from llvm::VPRecipeBase
 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL={})
 
template<typename IterT >
 VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands, DebugLoc DL={})
 
virtual ~VPRecipeBase ()=default
 
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.
 
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.
 
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise.
 
const InstructiongetUnderlyingInstr () const
 
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.
 
- 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
 
bool isSentinel () const
 Check whether this is the sentinel node.
 
- 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 ()
 
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
 
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.
 

Static Public Member Functions

static bool classof (const VPRecipeBase *R)
 
- 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, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, 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
enum class  VPUserID { Recipe , LiveOut }
 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
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, 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< 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, VPUserID ID)
 
 VPUser (std::initializer_list< VPValue * > Operands, VPUserID ID)
 
template<typename IterT >
 VPUser (iterator_range< IterT > Operands, VPUserID ID)
 

Detailed Description

Class to record LLVM IR flag for a recipe along with it.

Definition at line 823 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPRecipeWithIRFlags() [1/5]

template<typename IterT >
llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
IterT  Operands,
DebugLoc  DL = {} 
)
inline

Definition at line 873 of file VPlan.h.

◆ VPRecipeWithIRFlags() [2/5]

template<typename IterT >
llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
IterT  Operands,
Instruction I 
)
inline

Definition at line 880 of file VPlan.h.

References CmpPredicate, ExactFlags, FMFs, GEP, GEPFlags, I, Operands, and WrapFlags.

◆ VPRecipeWithIRFlags() [3/5]

template<typename IterT >
llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
IterT  Operands,
CmpInst::Predicate  Pred,
DebugLoc  DL = {} 
)
inline

Definition at line 901 of file VPlan.h.

◆ VPRecipeWithIRFlags() [4/5]

template<typename IterT >
llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
IterT  Operands,
WrapFlagsTy  WrapFlags,
DebugLoc  DL = {} 
)
inline

Definition at line 907 of file VPlan.h.

◆ VPRecipeWithIRFlags() [5/5]

template<typename IterT >
llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags ( const unsigned char  SC,
IterT  Operands,
FastMathFlags  FMFs,
DebugLoc  DL = {} 
)
inline

Definition at line 913 of file VPlan.h.

Member Function Documentation

◆ classof()

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

Definition at line 918 of file VPlan.h.

◆ dropPoisonGeneratingFlags()

void llvm::VPRecipeWithIRFlags::dropPoisonGeneratingFlags ( )
inline

Drop all poison-generating flags.

Definition at line 926 of file VPlan.h.

References ExactFlags, FMFs, GEPFlags, llvm::VPRecipeWithIRFlags::WrapFlagsTy::HasNSW, llvm::VPRecipeWithIRFlags::WrapFlagsTy::HasNUW, and WrapFlags.

◆ getFastMathFlags()

FastMathFlags VPRecipeWithIRFlags::getFastMathFlags ( ) const

◆ getPredicate()

CmpInst::Predicate llvm::VPRecipeWithIRFlags::getPredicate ( ) const
inline

Definition at line 978 of file VPlan.h.

References assert(), and CmpPredicate.

Referenced by llvm::VPWidenRecipe::execute(), and printFlags().

◆ hasFastMathFlags()

bool llvm::VPRecipeWithIRFlags::hasFastMathFlags ( ) const
inline

Returns true if the recipe has fast-math flags.

Definition at line 991 of file VPlan.h.

Referenced by llvm::VPInstruction::execute(), and llvm::VPScalarIVStepsRecipe::execute().

◆ hasNoSignedWrap()

bool llvm::VPRecipeWithIRFlags::hasNoSignedWrap ( ) const
inline

Definition at line 1001 of file VPlan.h.

References assert(), llvm::VPRecipeWithIRFlags::WrapFlagsTy::HasNSW, and WrapFlags.

◆ hasNoUnsignedWrap()

bool llvm::VPRecipeWithIRFlags::hasNoUnsignedWrap ( ) const
inline

Definition at line 995 of file VPlan.h.

References assert(), llvm::VPRecipeWithIRFlags::WrapFlagsTy::HasNUW, and WrapFlags.

◆ isInBounds()

bool llvm::VPRecipeWithIRFlags::isInBounds ( ) const
inline

Definition at line 984 of file VPlan.h.

References assert(), and GEPFlags.

Referenced by llvm::VPWidenGEPRecipe::execute().

◆ printFlags()

void VPRecipeWithIRFlags::printFlags ( raw_ostream O) const

◆ setFlags()

void llvm::VPRecipeWithIRFlags::setFlags ( Instruction I) const
inline

Member Data Documentation

◆ AllFlags

unsigned llvm::VPRecipeWithIRFlags::AllFlags

Definition at line 868 of file VPlan.h.

◆ CmpPredicate

CmpInst::Predicate llvm::VPRecipeWithIRFlags::CmpPredicate

Definition at line 863 of file VPlan.h.

Referenced by getPredicate(), and VPRecipeWithIRFlags().

◆ ExactFlags

ExactFlagsTy llvm::VPRecipeWithIRFlags::ExactFlags

Definition at line 865 of file VPlan.h.

Referenced by dropPoisonGeneratingFlags(), printFlags(), setFlags(), and VPRecipeWithIRFlags().

◆ FMFs

FastMathFlagsTy llvm::VPRecipeWithIRFlags::FMFs

◆ GEPFlags

GEPFlagsTy llvm::VPRecipeWithIRFlags::GEPFlags

◆ WrapFlags

WrapFlagsTy llvm::VPRecipeWithIRFlags::WrapFlags

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