LLVM 22.0.0git
Public Types | Public Member Functions | Friends | List of all members
llvm::VPDef Class Referenceabstract

This class augments a recipe with a set of VPValues defined by the recipe. More...

#include "Transforms/Vectorize/VPlanValue.h"

Inheritance diagram for llvm::VPDef:
[legend]

Public Types

using VPRecipeTy
 An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.

Public Member Functions

 VPDef (const unsigned char SC)
virtual ~VPDef ()
VPValue * getVPSingleValue ()
 Returns the only VPValue defined by the VPDef.
const VPValue * getVPSingleValue () const
VPValue * getVPValue (unsigned I)
 Returns the VPValue with index I defined by the VPDef.
const VPValue * getVPValue (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
LLVM_ABI_FOR_TEST 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.

Friends

class VPValue

Detailed Description

This class augments a recipe with a set of VPValues defined by the recipe.

It allows recipes to define zero, one or multiple VPValues. A VPDef owns the VPValues it defines and is responsible for deleting its defined values. Single-value VPDefs that also inherit from VPValue must make sure to inherit from VPDef before VPValue.

Definition at line 310 of file VPlanValue.h.

Member Typedef Documentation

◆ VPRecipeTy

using llvm::VPDef::VPRecipeTy

An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.

Values of this enumeration are kept in the SubclassID field of the VPRecipeBase objects. They are used for concrete type identification.

Definition at line 341 of file VPlanValue.h.

Constructor & Destructor Documentation

◆ VPDef()

llvm::VPDef::VPDef ( const unsigned char SC)
inline

Definition at line 389 of file VPlanValue.h.

Referenced by llvm::VPRecipeBase::classof(), and llvm::VPRecipeBase::VPRecipeBase().

◆ ~VPDef()

virtual llvm::VPDef::~VPDef ( )
inlinevirtual

Definition at line 391 of file VPlanValue.h.

References assert(), D(), llvm::make_early_inc_range(), and VPValue.

Member Function Documentation

◆ definedValues() [1/2]

ArrayRef< VPValue * > llvm::VPDef::definedValues ( )
inline

Returns an ArrayRef of the values defined by the VPDef.

Definition at line 426 of file VPlanValue.h.

Referenced by collectUsersRecursively(), llvm::VPInterleaveRecipe::execute(), and isConsecutiveInterleaveGroup().

◆ definedValues() [2/2]

ArrayRef< VPValue * > llvm::VPDef::definedValues ( ) const
inline

Returns an ArrayRef of the values defined by the VPDef.

Definition at line 428 of file VPlanValue.h.

◆ dump()

void VPDef::dump ( ) const

Dump the VPDef to stderr (for debugging).

Definition at line 122 of file VPlan.cpp.

References llvm::dbgs(), llvm::dyn_cast_or_null(), and print().

Referenced by llvm::VPRecipeBase::cost(), and llvm::VPSingleDefRecipe::dump().

◆ getNumDefinedValues()

unsigned llvm::VPDef::getNumDefinedValues ( ) const
inline

Returns the number of values defined by the VPDef.

Definition at line 431 of file VPlanValue.h.

Referenced by llvm::VPInterleaveBase::computeCost(), hoistPreviousBeforeFORUsers(), sinkRecurrenceUsersAfterPrevious(), transformRecipestoEVLRecipes(), and llvm::VPlanTransforms::tryToConvertVPInstructionsToVPRecipes().

◆ getVPDefID()

unsigned llvm::VPDef::getVPDefID ( ) const
inline
Returns
an ID for the concrete type of this object. This is used to implement the classof checks. This should not be used for any other purpose, as the values may change as LLVM evolves.

Definition at line 436 of file VPlanValue.h.

Referenced by llvm::VPRecipeBase::isPhi(), llvm::VPRecipeBase::mayHaveSideEffects(), llvm::VPRecipeBase::mayReadFromMemory(), and llvm::VPRecipeBase::mayWriteToMemory().

◆ getVPSingleValue() [1/2]

VPValue * llvm::VPDef::getVPSingleValue ( )
inline

Returns the only VPValue defined by the VPDef.

Can only be called for VPDefs with a single defined value.

Definition at line 404 of file VPlanValue.h.

References assert(), and VPValue.

Referenced by llvm::VPlanTransforms::createInterleaveGroups(), llvm::VPlanTransforms::dropPoisonGeneratingRecipes(), hoistPreviousBeforeFORUsers(), llvm::VPRecipeBase::mayHaveSideEffects(), llvm::VPRecipeBase::mayReadFromMemory(), llvm::VPRecipeBase::mayWriteToMemory(), optimizeMaskToEVL(), simplifyRecipe(), sinkRecurrenceUsersAfterPrevious(), and llvm::VPlanTransforms::tryToConvertVPInstructionsToVPRecipes().

◆ getVPSingleValue() [2/2]

const VPValue * llvm::VPDef::getVPSingleValue ( ) const
inline

Definition at line 409 of file VPlanValue.h.

References assert(), and VPValue.

◆ getVPValue() [1/2]

VPValue * llvm::VPDef::getVPValue ( unsigned I)
inline

Returns the VPValue with index I defined by the VPDef.

Definition at line 416 of file VPlanValue.h.

References assert(), I, and VPValue.

Referenced by llvm::VPInterleaveBase::computeCost(), llvm::VPInterleaveEVLRecipe::execute(), isConsecutiveInterleaveGroup(), llvm::VPInterleaveEVLRecipe::printRecipe(), llvm::VPInterleaveRecipe::printRecipe(), and transformRecipestoEVLRecipes().

◆ getVPValue() [2/2]

const VPValue * llvm::VPDef::getVPValue ( unsigned I) const
inline

Definition at line 420 of file VPlanValue.h.

References assert(), I, and VPValue.

◆ print()

virtual void llvm::VPDef::print ( raw_ostream & O,
const Twine & Indent,
VPSlotTracker & SlotTracker ) const
pure virtual

Each concrete VPDef prints itself.

Implemented in llvm::VPRecipeBase.

Referenced by dump().

◆ VPValue

friend class VPValue
friend

Definition at line 311 of file VPlanValue.h.

References VPValue.

Referenced by getVPSingleValue(), getVPSingleValue(), getVPValue(), getVPValue(), VPValue, and ~VPDef().

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0