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

Class to record and manage LLVM IR flags. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPIRFlags:
[legend]

Classes

struct  DisjointFlagsTy
struct  NonNegFlagsTy
struct  TruncFlagsTy
struct  WrapFlagsTy

Public Member Functions

 VPIRFlags ()
 VPIRFlags (Instruction &I)
 VPIRFlags (CmpInst::Predicate Pred)
 VPIRFlags (CmpInst::Predicate Pred, FastMathFlags FMFs)
 VPIRFlags (WrapFlagsTy WrapFlags)
 VPIRFlags (TruncFlagsTy TruncFlags)
 VPIRFlags (FastMathFlags FMFs)
 VPIRFlags (DisjointFlagsTy DisjointFlags)
 VPIRFlags (NonNegFlagsTy NonNegFlags)
 VPIRFlags (ExactFlagsTy ExactFlags)
 VPIRFlags (GEPNoWrapFlags GEPFlags)
 VPIRFlags (RecurKind Kind, bool IsOrdered, bool IsInLoop, FastMathFlags FMFs)
void transferFlags (VPIRFlags &Other)
void intersectFlags (const VPIRFlags &Other)
 Only keep flags also present in Other.
void dropPoisonGeneratingFlags ()
 Drop all poison-generating flags.
void applyFlags (Instruction &I) const
 Apply the IR flags to I.
CmpInst::Predicate getPredicate () const
void setPredicate (CmpInst::Predicate Pred)
GEPNoWrapFlags getGEPNoWrapFlags () const
bool hasPredicate () const
 Returns true if the recipe has a comparison predicate.
bool hasFastMathFlags () const
 Returns true if the recipe has fast-math flags.
LLVM_ABI_FOR_TEST FastMathFlags getFastMathFlagsOrNone () const
bool hasNoUnsignedWrap () const
bool hasNoSignedWrap () const
WrapFlagsTy getNoWrapFlagsOrNone () const
WrapFlagsTy getNoWrapFlags () const
bool isDisjoint () const
RecurKind getRecurKind () const
bool isReductionOrdered () const
bool isReductionInLoop () const
LLVM_ABI_FOR_TEST bool flagsValidForOpcode (unsigned Opcode) const
 Returns true if the set flags are valid for Opcode.
LLVM_ABI_FOR_TEST bool hasRequiredFlagsForOpcode (unsigned Opcode, Type *ResultTy) const
 Returns true if Opcode with scalar result type ResultTy has its required flags set.
void printFlags (raw_ostream &O) const

Static Public Member Functions

static LLVM_ABI_FOR_TEST VPIRFlags getDefaultFlags (unsigned Opcode, Type *ResultTy=nullptr)
 Returns default flags for Opcode and scalar ResultTy for opcodes that support it, asserts otherwise.

Detailed Description

Class to record and manage LLVM IR flags.

Definition at line 696 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPIRFlags() [1/12]

llvm::VPIRFlags::VPIRFlags ( )
inline

Definition at line 795 of file VPlan.h.

References AllFlags.

Referenced by getDefaultFlags(), intersectFlags(), transferFlags(), VPIRFlags(), llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags(), llvm::VPRecipeWithIRFlags::VPRecipeWithIRFlags(), llvm::VPReductionPHIRecipe::VPReductionPHIRecipe(), llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe(), and llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe().

◆ VPIRFlags() [2/12]

llvm::VPIRFlags::VPIRFlags ( Instruction & I)
inline

Definition at line 797 of file VPlan.h.

References assert(), CmpPredStorage, DisjointFlags, llvm::dyn_cast(), ExactFlags, FCmpFlags, FMFs, GEP, GEPFlagsStorage, getGEPNoWrapFlags(), getPredicate(), I, NonNegFlags, llvm::Bitfield::set(), TruncFlags, VPIRFlags(), and WrapFlags.

◆ VPIRFlags() [3/12]

llvm::VPIRFlags::VPIRFlags ( CmpInst::Predicate Pred)
inline

Definition at line 835 of file VPlan.h.

References AllFlags, assert(), CmpPredStorage, getPredicate(), and llvm::Bitfield::set().

◆ VPIRFlags() [4/12]

llvm::VPIRFlags::VPIRFlags ( CmpInst::Predicate Pred,
FastMathFlags FMFs )
inline

Definition at line 840 of file VPlan.h.

References AllFlags, assert(), FCmpFlags, FMFs, getPredicate(), and llvm::Bitfield::set().

◆ VPIRFlags() [5/12]

llvm::VPIRFlags::VPIRFlags ( WrapFlagsTy WrapFlags)
inline

Definition at line 847 of file VPlan.h.

References AllFlags, and WrapFlags.

◆ VPIRFlags() [6/12]

llvm::VPIRFlags::VPIRFlags ( TruncFlagsTy TruncFlags)
inline

Definition at line 852 of file VPlan.h.

References AllFlags, and TruncFlags.

◆ VPIRFlags() [7/12]

llvm::VPIRFlags::VPIRFlags ( FastMathFlags FMFs)
inline

Definition at line 857 of file VPlan.h.

References AllFlags, and FMFs.

◆ VPIRFlags() [8/12]

llvm::VPIRFlags::VPIRFlags ( DisjointFlagsTy DisjointFlags)
inline

Definition at line 861 of file VPlan.h.

References AllFlags, and DisjointFlags.

◆ VPIRFlags() [9/12]

llvm::VPIRFlags::VPIRFlags ( NonNegFlagsTy NonNegFlags)
inline

Definition at line 866 of file VPlan.h.

References AllFlags, and NonNegFlags.

◆ VPIRFlags() [10/12]

llvm::VPIRFlags::VPIRFlags ( ExactFlagsTy ExactFlags)
inline

Definition at line 871 of file VPlan.h.

References AllFlags, and ExactFlags.

◆ VPIRFlags() [11/12]

llvm::VPIRFlags::VPIRFlags ( GEPNoWrapFlags GEPFlags)
inline

Definition at line 876 of file VPlan.h.

References AllFlags, GEPFlagsStorage, and llvm::GEPNoWrapFlags::getRaw().

◆ VPIRFlags() [12/12]

llvm::VPIRFlags::VPIRFlags ( RecurKind Kind,
bool IsOrdered,
bool IsInLoop,
FastMathFlags FMFs )
inline

Definition at line 881 of file VPlan.h.

References AllFlags, FMFs, and ReductionFlags.

Member Function Documentation

◆ applyFlags()

void llvm::VPIRFlags::applyFlags ( Instruction & I) const
inline

Apply the IR flags to I.

Definition at line 934 of file VPlan.h.

References llvm::cast(), DisjointFlags, ExactFlags, F, llvm::GEPNoWrapFlags::fromRaw(), GEPFlagsStorage, I, llvm_unreachable, NonNegFlags, TruncFlags, and WrapFlags.

Referenced by llvm::VPWidenIntrinsicRecipe::createVectorCall(), llvm::VPReplicateRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenCastRecipe::execute(), and llvm::VPWidenRecipe::execute().

◆ dropPoisonGeneratingFlags()

void llvm::VPIRFlags::dropPoisonGeneratingFlags ( )
inline

Drop all poison-generating flags.

Definition at line 897 of file VPlan.h.

References DisjointFlags, ExactFlags, GEPFlagsStorage, NonNegFlags, TruncFlags, and WrapFlags.

Referenced by llvm::VPlanTransforms::replaceWideCanonicalIVWithWideIV().

◆ flagsValidForOpcode()

bool VPIRFlags::flagsValidForOpcode ( unsigned Opcode) const

Returns true if the set flags are valid for Opcode.

Definition at line 2706 of file VPlanRecipes.cpp.

References llvm::VPInstruction::ComputeReductionResult, llvm_unreachable, llvm::VPInstruction::PtrAdd, llvm::VPInstruction::ReductionStartVector, llvm::VPInstruction::WideIVStep, and llvm::VPInstruction::WidePtrAdd.

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

◆ getDefaultFlags()

VPIRFlags VPIRFlags::getDefaultFlags ( unsigned Opcode,
Type * ResultTy = nullptr )
static

Returns default flags for Opcode and scalar ResultTy for opcodes that support it, asserts otherwise.

Opcodes not supporting default flags include compares and ComputeReductionResult.

Definition at line 2655 of file VPlanRecipes.cpp.

References llvm::VPInstruction::CanonicalIVIncrementForPart, llvm::VPInstruction::ComputeReductionResult, llvm::FPMathOperator::isSupportedFloatingPointType(), llvm_unreachable, llvm::GEPNoWrapFlags::none(), llvm::VPInstruction::PtrAdd, VPIRFlags(), and llvm::VPInstruction::WidePtrAdd.

Referenced by llvm::VPlanTransforms::convertToConcreteRecipes(), llvm::VPBuilderBase<>::createScalarPhi(), llvm::VPBuilderBase<>::createSelect(), llvm::VPBuilderBase<>::createWidenCast(), llvm::VPSCEVExpander::expand(), hasRequiredFlagsForOpcode(), narrowToSingleScalarRecipes(), optimizeMaskToEVL(), optimizeVectorInductionWidthForTCAndVFUF(), llvm::VPlanTransforms::sinkPredicatedStores(), and updatePartialReductionPhiAndResult().

◆ getFastMathFlagsOrNone()

FastMathFlags VPIRFlags::getFastMathFlagsOrNone ( ) const

Definition at line 409 of file VPlanRecipes.cpp.

References F, hasFastMathFlags(), llvm::FastMathFlags::setAllowContract(), llvm::FastMathFlags::setAllowReassoc(), llvm::FastMathFlags::setAllowReciprocal(), llvm::FastMathFlags::setApproxFunc(), llvm::FastMathFlags::setNoInfs(), llvm::FastMathFlags::setNoNaNs(), and llvm::FastMathFlags::setNoSignedZeros().

Referenced by llvm::VPReductionRecipe::clone(), llvm::VPScalarIVStepsRecipe::clone(), llvm::VPReductionRecipe::computeCost(), llvm::VPInstruction::execute(), llvm::VPReductionEVLRecipe::execute(), llvm::VPReductionRecipe::execute(), llvm::VPScalarIVStepsRecipe::execute(), intersectFlags(), printFlags(), and llvm::VPReductionEVLRecipe::VPReductionEVLRecipe().

◆ getGEPNoWrapFlags()

GEPNoWrapFlags llvm::VPIRFlags::getGEPNoWrapFlags ( ) const
inline

Definition at line 995 of file VPlan.h.

References llvm::GEPNoWrapFlags::fromRaw(), and GEPFlagsStorage.

Referenced by llvm::VPVectorEndPointerRecipe::clone(), llvm::VPVectorPointerRecipe::clone(), llvm::VPVectorEndPointerRecipe::execute(), llvm::VPVectorPointerRecipe::execute(), llvm::VPWidenGEPRecipe::execute(), printFlags(), and VPIRFlags().

◆ getNoWrapFlags()

WrapFlagsTy llvm::VPIRFlags::getNoWrapFlags ( ) const
inline

Definition at line 1044 of file VPlan.h.

References hasNoSignedWrap(), and hasNoUnsignedWrap().

Referenced by llvm::VPDerivedIVRecipe::clone(), and llvm::VPWidenCanonicalIVRecipe::clone().

◆ getNoWrapFlagsOrNone()

WrapFlagsTy llvm::VPIRFlags::getNoWrapFlagsOrNone ( ) const
inline

Definition at line 1034 of file VPlan.h.

References hasNoSignedWrap(), and hasNoUnsignedWrap().

◆ getPredicate()

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

Definition at line 977 of file VPlan.h.

References assert(), CmpPredStorage, FCmpFlags, and llvm::Bitfield::get().

Referenced by llvm::VPReplicateRecipe::execute(), llvm::VPWidenRecipe::execute(), llvm::VPRecipeWithIRFlags::getCostForRecipeWithOpcode(), printFlags(), setPredicate(), VPIRFlags(), VPIRFlags(), and VPIRFlags().

◆ getRecurKind()

RecurKind llvm::VPIRFlags::getRecurKind ( ) const
inline

Definition at line 1054 of file VPlan.h.

References assert(), and ReductionFlags.

Referenced by llvm::VPlanTransforms::handleMultiUseReductions(), and printFlags().

◆ hasFastMathFlags()

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

Returns true if the recipe has fast-math flags.

Definition at line 1005 of file VPlan.h.

Referenced by getFastMathFlagsOrNone().

◆ hasNoSignedWrap()

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

Definition at line 1023 of file VPlan.h.

References llvm_unreachable, TruncFlags, and WrapFlags.

Referenced by getNoWrapFlags(), and getNoWrapFlagsOrNone().

◆ hasNoUnsignedWrap()

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

Definition at line 1012 of file VPlan.h.

References llvm_unreachable, TruncFlags, and WrapFlags.

Referenced by getNoWrapFlags(), and getNoWrapFlagsOrNone().

◆ hasPredicate()

bool llvm::VPIRFlags::hasPredicate ( ) const
inline

Returns true if the recipe has a comparison predicate.

Definition at line 1000 of file VPlan.h.

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

◆ hasRequiredFlagsForOpcode()

bool VPIRFlags::hasRequiredFlagsForOpcode ( unsigned Opcode,
Type * ResultTy ) const

Returns true if Opcode with scalar result type ResultTy has its required flags set.

Definition at line 2747 of file VPlanRecipes.cpp.

References llvm::VPInstruction::ComputeReductionResult, and getDefaultFlags().

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

◆ intersectFlags()

void VPIRFlags::intersectFlags ( const VPIRFlags & Other)

Only keep flags also present in Other.

Other must have the same OpType as the current object.

Definition at line 361 of file VPlanRecipes.cpp.

References assert(), CmpPredStorage, DisjointFlags, ExactFlags, FCmpFlags, GEPFlagsStorage, getFastMathFlagsOrNone(), NonNegFlags, ReductionFlags, TruncFlags, VPIRFlags(), and WrapFlags.

◆ isDisjoint()

bool llvm::VPIRFlags::isDisjoint ( ) const
inline

Definition at line 1048 of file VPlan.h.

References assert(), and DisjointFlags.

◆ isReductionInLoop()

bool llvm::VPIRFlags::isReductionInLoop ( ) const
inline

Definition at line 1066 of file VPlan.h.

References assert(), and ReductionFlags.

Referenced by printFlags().

◆ isReductionOrdered()

bool llvm::VPIRFlags::isReductionOrdered ( ) const
inline

Definition at line 1060 of file VPlan.h.

References assert(), and ReductionFlags.

Referenced by printFlags().

◆ printFlags()

void VPIRFlags::printFlags ( raw_ostream & O) const

Definition at line 2852 of file VPlanRecipes.cpp.

References DisjointFlags, ExactFlags, getFastMathFlagsOrNone(), getGEPNoWrapFlags(), getPredicate(), llvm::CmpInst::getPredicateName(), getRecurKind(), isReductionInLoop(), isReductionOrdered(), NonNegFlags, llvm::FastMathFlags::print(), printRecurrenceKind(), TruncFlags, and WrapFlags.

Referenced by llvm::VPBlendRecipe::printRecipe(), llvm::VPDerivedIVRecipe::printRecipe(), llvm::VPInstruction::printRecipe(), llvm::VPPhi::printRecipe(), llvm::VPReductionEVLRecipe::printRecipe(), llvm::VPReductionPHIRecipe::printRecipe(), llvm::VPReductionRecipe::printRecipe(), llvm::VPReplicateRecipe::printRecipe(), llvm::VPVectorEndPointerRecipe::printRecipe(), llvm::VPVectorPointerRecipe::printRecipe(), llvm::VPWidenCallRecipe::printRecipe(), llvm::VPWidenCanonicalIVRecipe::printRecipe(), llvm::VPWidenCastRecipe::printRecipe(), llvm::VPWidenGEPRecipe::printRecipe(), llvm::VPWidenIntOrFpInductionRecipe::printRecipe(), llvm::VPWidenIntrinsicRecipe::printRecipe(), and llvm::VPWidenRecipe::printRecipe().

◆ setPredicate()

void llvm::VPIRFlags::setPredicate ( CmpInst::Predicate Pred)
inline

Definition at line 985 of file VPlan.h.

References assert(), CmpPredStorage, FCmpFlags, getPredicate(), and llvm::Bitfield::set().

◆ transferFlags()

void llvm::VPIRFlags::transferFlags ( VPIRFlags & Other)
inline

Definition at line 886 of file VPlan.h.

References AllFlags, and VPIRFlags().

Member Data Documentation

◆ AllFlags

uint8_t llvm::VPIRFlags::AllFlags[2]

Definition at line 791 of file VPlan.h.

Referenced by transferFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), and VPIRFlags().

◆ CmpPredStorage

uint8_t llvm::VPIRFlags::CmpPredStorage

Definition at line 781 of file VPlan.h.

Referenced by getPredicate(), intersectFlags(), setPredicate(), VPIRFlags(), and VPIRFlags().

◆ DisjointFlags

DisjointFlagsTy llvm::VPIRFlags::DisjointFlags

Definition at line 784 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), intersectFlags(), isDisjoint(), printFlags(), VPIRFlags(), and VPIRFlags().

◆ ExactFlags

ExactFlagsTy llvm::VPIRFlags::ExactFlags

Definition at line 785 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), intersectFlags(), printFlags(), VPIRFlags(), and VPIRFlags().

◆ FCmpFlags

FCmpFlagsTy llvm::VPIRFlags::FCmpFlags

Definition at line 789 of file VPlan.h.

Referenced by getPredicate(), intersectFlags(), setPredicate(), VPIRFlags(), and VPIRFlags().

◆ FMFs

FastMathFlagsTy llvm::VPIRFlags::FMFs

Definition at line 788 of file VPlan.h.

Referenced by llvm::VPReductionRecipe::computeCost(), VPIRFlags(), VPIRFlags(), VPIRFlags(), VPIRFlags(), llvm::VPReductionRecipe::VPReductionRecipe(), llvm::VPReductionRecipe::VPReductionRecipe(), llvm::VPReductionRecipe::VPReductionRecipe(), and llvm::VPScalarIVStepsRecipe::VPScalarIVStepsRecipe().

◆ GEPFlagsStorage

uint8_t llvm::VPIRFlags::GEPFlagsStorage

Definition at line 786 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), getGEPNoWrapFlags(), intersectFlags(), VPIRFlags(), and VPIRFlags().

◆ NonNegFlags

NonNegFlagsTy llvm::VPIRFlags::NonNegFlags

Definition at line 787 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), intersectFlags(), printFlags(), VPIRFlags(), and VPIRFlags().

◆ ReductionFlags

ReductionFlagsTy llvm::VPIRFlags::ReductionFlags

Definition at line 790 of file VPlan.h.

Referenced by getRecurKind(), intersectFlags(), isReductionInLoop(), isReductionOrdered(), and VPIRFlags().

◆ TruncFlags

TruncFlagsTy llvm::VPIRFlags::TruncFlags

Definition at line 783 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), hasNoSignedWrap(), hasNoUnsignedWrap(), intersectFlags(), printFlags(), VPIRFlags(), and VPIRFlags().

◆ WrapFlags

WrapFlagsTy llvm::VPIRFlags::WrapFlags

Definition at line 782 of file VPlan.h.

Referenced by applyFlags(), dropPoisonGeneratingFlags(), hasNoSignedWrap(), hasNoUnsignedWrap(), intersectFlags(), printFlags(), VPIRFlags(), and VPIRFlags().

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