LLVM 17.0.0git
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
llvm::KnownFPClass Struct Reference

#include "llvm/Analysis/ValueTracking.h"

Public Member Functions

bool isKnownNever (FPClassTest Mask) const
 Return true if it's known this can never be one of the mask entries.
 
bool isUnknown () const
 
bool isKnownNeverNaN () const
 Return true if it's known this can never be a nan.
 
bool isKnownNeverInfinity () const
 Return true if it's known this can never be an infinity.
 
bool isKnownNeverPosInfinity () const
 Return true if it's known this can never be +infinity.
 
bool isKnownNeverNegInfinity () const
 Return true if it's known this can never be -infinity.
 
bool isKnownNeverSubnormal () const
 Return true if it's known this can never be a subnormal.
 
bool isKnownNeverPosSubnormal () const
 Return true if it's known this can never be a positive subnormal.
 
bool isKnownNeverNegSubnormal () const
 Return true if it's known this can never be a negative subnormal.
 
bool isKnownNeverZero () const
 Return true if it's known this can never be a zero.
 
bool isKnownNeverPosZero () const
 Return true if it's known this can never be a literal positive zero.
 
bool isKnownNeverNegZero () const
 Return true if it's known this can never be a literal negative zero.
 
bool isKnownNeverLogicalZero (const Function &F, Type *Ty) const
 Return true if it's know this can never be interpreted as a zero.
 
bool isKnownNeverLogicalNegZero (const Function &F, Type *Ty) const
 Return true if it's know this can never be interpreted as a negative zero.
 
bool isKnownNeverLogicalPosZero (const Function &F, Type *Ty) const
 Return true if it's know this can never be interpreted as a positive zero.
 
bool cannotBeOrderedLessThanZero () const
 Return true if we can prove that the analyzed floating-point value is either NaN or never less than -0.0.
 
bool cannotBeOrderedGreaterThanZero () const
 Return true if we can prove that the analyzed floating-point value is either NaN or never greater than -0.0.
 
KnownFPClassoperator|= (const KnownFPClass &RHS)
 
void knownNot (FPClassTest RuleOut)
 
void fneg ()
 
void fabs ()
 
bool signBitIsZeroOrNaN () const
 Return true if the sign bit must be 0, ignoring the sign of nans.
 
void signBitMustBeZero ()
 Assume the sign bit is zero.
 
void copysign (const KnownFPClass &Sign)
 
void propagateNaN (const KnownFPClass &Src, bool PreserveSign=false)
 
void resetAll ()
 

Public Attributes

FPClassTest KnownFPClasses = fcAllFlags
 Floating-point classes the value could be one of.
 
std::optional< boolSignBit
 std::nullopt if the sign bit is unknown, true if the sign bit is definitely set or false if the sign bit is definitely unset.
 

Static Public Attributes

static constexpr FPClassTest OrderedLessThanZeroMask
 
static constexpr FPClassTest OrderedGreaterThanZeroMask
 

Detailed Description

Definition at line 233 of file ValueTracking.h.

Member Function Documentation

◆ cannotBeOrderedGreaterThanZero()

bool llvm::KnownFPClass::cannotBeOrderedGreaterThanZero ( ) const
inline

Return true if we can prove that the analyzed floating-point value is either NaN or never greater than -0.0.

NaN --> true +0 --> true -0 --> true x > +0 --> false x < -0 --> true

Definition at line 336 of file ValueTracking.h.

References isKnownNever(), and OrderedGreaterThanZeroMask.

Referenced by computeKnownFPClass().

◆ cannotBeOrderedLessThanZero()

bool llvm::KnownFPClass::cannotBeOrderedLessThanZero ( ) const
inline

Return true if we can prove that the analyzed floating-point value is either NaN or never less than -0.0.

 NaN --> true
  +0 --> true
  -0 --> true

x > +0 --> true x < -0 --> false

Definition at line 325 of file ValueTracking.h.

References isKnownNever(), and OrderedLessThanZeroMask.

Referenced by computeKnownFPClass(), and computeKnownFPClassForFPTrunc().

◆ copysign()

void llvm::KnownFPClass::copysign ( const KnownFPClass Sign)
inline

◆ fabs()

void llvm::KnownFPClass::fabs ( )
inline

◆ fneg()

void llvm::KnownFPClass::fneg ( )
inline

Definition at line 352 of file ValueTracking.h.

References llvm::fneg(), KnownFPClasses, and SignBit.

Referenced by computeKnownFPClass().

◆ isKnownNever()

bool llvm::KnownFPClass::isKnownNever ( FPClassTest  Mask) const
inline

◆ isKnownNeverInfinity()

bool llvm::KnownFPClass::isKnownNeverInfinity ( ) const
inline

Return true if it's known this can never be an infinity.

Definition at line 256 of file ValueTracking.h.

References llvm::fcInf, and isKnownNever().

Referenced by computeKnownFPClass(), llvm::isKnownNeverInfinity(), and llvm::isKnownNeverInfOrNaN().

◆ isKnownNeverLogicalNegZero()

bool KnownFPClass::isKnownNeverLogicalNegZero ( const Function F,
Type Ty 
) const

Return true if it's know this can never be interpreted as a negative zero.

Definition at line 4070 of file ValueTracking.cpp.

References F, inputDenormalIsIEEEOrPosZero(), isKnownNeverNegSubnormal(), and isKnownNeverNegZero().

Referenced by computeKnownFPClass().

◆ isKnownNeverLogicalPosZero()

bool KnownFPClass::isKnownNeverLogicalPosZero ( const Function F,
Type Ty 
) const

◆ isKnownNeverLogicalZero()

bool KnownFPClass::isKnownNeverLogicalZero ( const Function F,
Type Ty 
) const

Return true if it's know this can never be interpreted as a zero.

This extends isKnownNeverZero to cover the case where the assumed floating-point mode for the function interprets denormals as zero.

Definition at line 4065 of file ValueTracking.cpp.

References F, inputDenormalIsIEEE(), isKnownNeverSubnormal(), and isKnownNeverZero().

Referenced by computeKnownFPClass().

◆ isKnownNeverNaN()

bool llvm::KnownFPClass::isKnownNeverNaN ( ) const
inline

Return true if it's known this can never be a nan.

Definition at line 251 of file ValueTracking.h.

References llvm::fcNan, and isKnownNever().

Referenced by computeKnownFPClass(), llvm::isKnownNeverInfOrNaN(), and llvm::isKnownNeverNaN().

◆ isKnownNeverNegInfinity()

bool llvm::KnownFPClass::isKnownNeverNegInfinity ( ) const
inline

Return true if it's known this can never be -infinity.

Definition at line 266 of file ValueTracking.h.

References llvm::fcNegInf, and isKnownNever().

Referenced by computeKnownFPClass().

◆ isKnownNeverNegSubnormal()

bool llvm::KnownFPClass::isKnownNeverNegSubnormal ( ) const
inline

Return true if it's known this can never be a negative subnormal.

Definition at line 281 of file ValueTracking.h.

References llvm::fcNegSubnormal, and isKnownNever().

Referenced by isKnownNeverLogicalNegZero().

◆ isKnownNeverNegZero()

bool llvm::KnownFPClass::isKnownNeverNegZero ( ) const
inline

Return true if it's known this can never be a literal negative zero.

Definition at line 297 of file ValueTracking.h.

References llvm::fcNegZero, and isKnownNever().

Referenced by computeKnownFPClass(), and isKnownNeverLogicalNegZero().

◆ isKnownNeverPosInfinity()

bool llvm::KnownFPClass::isKnownNeverPosInfinity ( ) const
inline

Return true if it's known this can never be +infinity.

Definition at line 261 of file ValueTracking.h.

References llvm::fcPosInf, and isKnownNever().

Referenced by computeKnownFPClass().

◆ isKnownNeverPosSubnormal()

bool llvm::KnownFPClass::isKnownNeverPosSubnormal ( ) const
inline

Return true if it's known this can never be a positive subnormal.

Definition at line 276 of file ValueTracking.h.

References llvm::fcPosSubnormal, and isKnownNever().

Referenced by isKnownNeverLogicalPosZero().

◆ isKnownNeverPosZero()

bool llvm::KnownFPClass::isKnownNeverPosZero ( ) const
inline

Return true if it's known this can never be a literal positive zero.

Definition at line 292 of file ValueTracking.h.

References llvm::fcPosZero, and isKnownNever().

Referenced by computeKnownFPClass(), and isKnownNeverLogicalPosZero().

◆ isKnownNeverSubnormal()

bool llvm::KnownFPClass::isKnownNeverSubnormal ( ) const
inline

Return true if it's known this can never be a subnormal.

Definition at line 271 of file ValueTracking.h.

References llvm::fcSubnormal, and isKnownNever().

Referenced by computeKnownFPClass(), isKnownNeverLogicalPosZero(), and isKnownNeverLogicalZero().

◆ isKnownNeverZero()

bool llvm::KnownFPClass::isKnownNeverZero ( ) const
inline

Return true if it's known this can never be a zero.

This means a literal [+-]0, and does not include denormal inputs implicitly treated as [+-]0.

Definition at line 287 of file ValueTracking.h.

References llvm::fcZero, and isKnownNever().

Referenced by computeKnownFPClass(), and isKnownNeverLogicalZero().

◆ isUnknown()

bool llvm::KnownFPClass::isUnknown ( ) const
inline

Definition at line 246 of file ValueTracking.h.

References llvm::fcAllFlags, KnownFPClasses, and SignBit.

Referenced by computeKnownFPClass().

◆ knownNot()

void llvm::KnownFPClass::knownNot ( FPClassTest  RuleOut)
inline

Definition at line 348 of file ValueTracking.h.

References KnownFPClasses.

Referenced by computeKnownFPClass(), computeKnownFPClassForFPTrunc(), and propagateNaN().

◆ operator|=()

KnownFPClass & llvm::KnownFPClass::operator|= ( const KnownFPClass RHS)
inline

Definition at line 340 of file ValueTracking.h.

References KnownFPClasses, RHS, and SignBit.

◆ propagateNaN()

void llvm::KnownFPClass::propagateNaN ( const KnownFPClass Src,
bool  PreserveSign = false 
)
inline

Definition at line 410 of file ValueTracking.h.

References llvm::fcNan, llvm::fcSNan, knownNot(), and SignBit.

Referenced by computeKnownFPClass(), and computeKnownFPClassForFPTrunc().

◆ resetAll()

void llvm::KnownFPClass::resetAll ( )
inline

Definition at line 419 of file ValueTracking.h.

Referenced by computeKnownFPClass().

◆ signBitIsZeroOrNaN()

bool llvm::KnownFPClass::signBitIsZeroOrNaN ( ) const
inline

Return true if the sign bit must be 0, ignoring the sign of nans.

Definition at line 375 of file ValueTracking.h.

References llvm::fcNegative, and isKnownNever().

◆ signBitMustBeZero()

void llvm::KnownFPClass::signBitMustBeZero ( )
inline

Assume the sign bit is zero.

Definition at line 380 of file ValueTracking.h.

References llvm::fcNan, llvm::fcPositive, KnownFPClasses, and SignBit.

Referenced by computeKnownFPClass(), and fabs().

Member Data Documentation

◆ KnownFPClasses

FPClassTest llvm::KnownFPClass::KnownFPClasses = fcAllFlags

Floating-point classes the value could be one of.

Definition at line 235 of file ValueTracking.h.

Referenced by computeKnownFPClass(), copysign(), fabs(), fneg(), isKnownNever(), isUnknown(), knownNot(), operator|=(), and signBitMustBeZero().

◆ OrderedGreaterThanZeroMask

constexpr FPClassTest llvm::KnownFPClass::OrderedGreaterThanZeroMask
staticconstexpr
Initial value:

Definition at line 314 of file ValueTracking.h.

Referenced by cannotBeOrderedGreaterThanZero(), and computeKnownFPClass().

◆ OrderedLessThanZeroMask

constexpr FPClassTest llvm::KnownFPClass::OrderedLessThanZeroMask
staticconstexpr

◆ SignBit

std::optional<bool> llvm::KnownFPClass::SignBit

std::nullopt if the sign bit is unknown, true if the sign bit is definitely set or false if the sign bit is definitely unset.

Definition at line 239 of file ValueTracking.h.

Referenced by computeKnownFPClass(), copysign(), fneg(), isUnknown(), operator|=(), propagateNaN(), and signBitMustBeZero().


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