LLVM  8.0.1
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::ConstantFP Class Referencefinal

ConstantFP - Floating Point Values [float, double]. More...

#include "llvm/IR/Constants.h"

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

Public Member Functions

 ConstantFP (const ConstantFP &)=delete
 
const APFloatgetValueAPF () const
 
bool isZero () const
 Return true if the value is positive or negative zero. More...
 
bool isNegative () const
 Return true if the sign bit is set. More...
 
bool isInfinity () const
 Return true if the value is infinity. More...
 
bool isNaN () const
 Return true if the value is a NaN. More...
 
bool isExactlyValue (const APFloat &V) const
 We don't rely on operator== working on double values, as it returns true for things that are clearly not equal, like -0.0 and 0.0. More...
 
bool isExactlyValue (double V) const
 
- Public Member Functions inherited from llvm::ConstantData
 ConstantData (const ConstantData &)=delete
 
- Public Member Functions inherited from llvm::Constant
void operator= (const Constant &)=delete
 
 Constant (const Constant &)=delete
 
bool isNullValue () const
 Return true if this is the value that would be returned by getNullValue. More...
 
bool isOneValue () const
 Returns true if the value is one. More...
 
bool isAllOnesValue () const
 Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 Return true if the value is what would be returned by getZeroValueForNegation. More...
 
bool isZeroValue () const
 Return true if the value is negative zero or null value. More...
 
bool isNotMinSignedValue () const
 Return true if the value is not the smallest signed value. More...
 
bool isMinSignedValue () const
 Return true if the value is the smallest signed value. More...
 
bool isFiniteNonZeroFP () const
 Return true if this is a finite and non-zero floating-point scalar constant or a vector constant with all finite and non-zero elements. More...
 
bool isNormalFP () const
 Return true if this is a normal (as opposed to denormal) floating-point scalar constant or a vector constant with all normal elements. More...
 
bool hasExactInverseFP () const
 Return true if this scalar has an exact multiplicative inverse or this vector has an exact multiplicative inverse for each element in the vector. More...
 
bool isNaN () const
 Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements. More...
 
bool containsUndefElement () const
 Return true if this is a vector constant that includes any undefined elements. More...
 
bool canTrap () const
 Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 Return true if the value can vary between threads. More...
 
bool isDLLImportDependent () const
 Return true if the value is dependent on a dllimport variable. More...
 
bool isConstantUsed () const
 Return true if the constant has users other than constant expressions and other dangling things. More...
 
bool needsRelocation () const
 This method classifies the entry according to whether or not it may generate a relocation entry. More...
 
ConstantgetAggregateElement (unsigned Elt) const
 For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...
 
ConstantgetAggregateElement (Constant *Elt) const
 
ConstantgetSplatValue () const
 If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...
 
const APIntgetUniqueInteger () const
 If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned. More...
 
void destroyConstant ()
 Called if some element of this constant is no longer valid. More...
 
void handleOperandChange (Value *, Value *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 If there are any dead constant users dangling off of this constant, remove them. More...
 
const ConstantstripPointerCasts () const
 
ConstantstripPointerCasts ()
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, bool)
 Placement delete - required by std, called if the ctor throws. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndInvariantGroups () const
 Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...
 
ValuestripPointerCastsAndInvariantGroups ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static ConstantgetZeroValueForNegation (Type *Ty)
 Floating point negation must be implemented with f(x) = -0.0 - x. More...
 
static Constantget (Type *Ty, double V)
 This returns a ConstantFP, or a vector containing a splat of a ConstantFP, for the specified value in the specified type. More...
 
static Constantget (Type *Ty, const APFloat &V)
 If Ty is a vector type, return a Constant with a splat of the given value. More...
 
static Constantget (Type *Ty, StringRef Str)
 
static ConstantFPget (LLVMContext &Context, const APFloat &V)
 
static ConstantgetNaN (Type *Ty, bool Negative=false, uint64_t Payload=0)
 
static ConstantgetQNaN (Type *Ty, bool Negative=false, APInt *Payload=nullptr)
 
static ConstantgetSNaN (Type *Ty, bool Negative=false, APInt *Payload=nullptr)
 
static ConstantgetNegativeZero (Type *Ty)
 
static ConstantgetInfinity (Type *Ty, bool Negative=false)
 
static bool isValueValidForType (Type *Ty, const APFloat &V)
 Return true if Ty is big enough to represent V. More...
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
- Static Public Member Functions inherited from llvm::ConstantData
static bool classof (const Value *V)
 Methods to support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::Constant
static bool classof (const Value *V)
 
static ConstantgetNullValue (Type *Ty)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Friends

class Constant
 

Additional Inherited Members

- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Protected Member Functions inherited from llvm::ConstantData
 ConstantData (Type *Ty, ValueTy VT)
 
void * operator new (size_t s)
 
- Protected Member Functions inherited from llvm::Constant
 Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

ConstantFP - Floating Point Values [float, double].

Definition at line 264 of file Constants.h.

Constructor & Destructor Documentation

◆ ConstantFP()

llvm::ConstantFP::ConstantFP ( const ConstantFP )
delete

Member Function Documentation

◆ classof()

static bool llvm::ConstantFP::classof ( const Value V)
inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 333 of file Constants.h.

References llvm::Value::getValueID().

◆ get() [1/4]

Constant * ConstantFP::get ( Type Ty,
double  V 
)
static

This returns a ConstantFP, or a vector containing a splat of a ConstantFP, for the specified value in the specified type.

This should only be used for simple constant values like 2.0/1.0 etc, that are known-valid both as host double and as the target format.

Definition at line 685 of file Constants.cpp.

References C, Context, llvm::APFloat::convert(), llvm::Type::getContext(), llvm::Type::getScalarType(), llvm::ConstantVector::getSplat(), llvm::APFloatBase::rmNearestTiesToEven, and TypeToFloatSemantics().

Referenced by llvm::MachineIRBuilder::buildFConstant(), buildMultiplyTree(), llvm::canConstantFoldCallTo(), llvm::LoopVectorizationPlanner::collectTriviallyDeadInstructions(), llvm::ConstantFoldBinaryInstruction(), llvm::ConstantFoldCastInstruction(), createAndInstr(), llvm::MDBuilder::createFPMath(), llvm::AMDGPULibCalls::fold(), FoldBitCast(), foldFDivConstantDivisor(), FunctionNumber(), llvm::Constant::getAllOnesValue(), llvm::ConstantExpr::getBinOpIdentity(), llvm::SelectionDAG::getConstantFP(), getConstantVector(), llvm::ConstantDataSequential::getElementAsConstant(), getMulHu(), llvm::Constant::getNullValue(), getPow(), llvm::RecurrenceDescriptor::getRecurrenceIdentity(), llvm::getSafeVectorConstantForBinop(), getSignedIntOrFpConstant(), getSqrtCall(), llvm::InnerLoopVectorizer::getStepVector(), haveEfficientBuildVectorPattern(), llvm::hoistRegion(), isAlwaysFoldable(), LLVMConstReal(), LLVMConstRealOfString(), LLVMConstRealOfStringAndSize(), llvm::log2(), LowerBUILD_VECTORAsVariablePermute(), lowerBuildVectorAsBroadcast(), LowerFPToInt(), LowerNegateToMultiply(), LowerUINT_TO_FP_i64(), llvm::fuzzerop::makeConstantsWithType(), optimizeSQRT(), false::LibCallsShrinkWrap::perform(), readWideAPInt(), simplifyBinaryIntrinsic(), SimplifyFDivInst(), SimplifyNVVMIntrinsic(), valueHasFloatPrecision(), llvm::InstCombiner::visitCallInst(), llvm::InstCombiner::visitFCmpInst(), llvm::InstCombiner::visitFDiv(), llvm::InstCombiner::visitFSub(), and llvm::LegalizerHelper::widenScalar().

◆ get() [2/4]

Constant * ConstantFP::get ( Type Ty,
const APFloat V 
)
static

If Ty is a vector type, return a Constant with a splat of the given value.

Otherwise return a ConstantFP for the given value.

Definition at line 701 of file Constants.cpp.

References assert(), C, llvm::Type::getContext(), llvm::Type::getScalarType(), llvm::ConstantVector::getSplat(), and llvm::Value::getType().

◆ get() [3/4]

Constant * ConstantFP::get ( Type Ty,
StringRef  Str 
)
static

◆ get() [4/4]

ConstantFP * ConstantFP::get ( LLVMContext Context,
const APFloat V 
)
static

◆ getInfinity()

Constant * ConstantFP::getInfinity ( Type Ty,
bool  Negative = false 
)
static

◆ getNaN()

Constant * ConstantFP::getNaN ( Type Ty,
bool  Negative = false,
uint64_t  Payload = 0 
)
static

◆ getNegativeZero()

Constant * ConstantFP::getNegativeZero ( Type Ty)
static

◆ getQNaN()

Constant * ConstantFP::getQNaN ( Type Ty,
bool  Negative = false,
APInt Payload = nullptr 
)
static

◆ getSNaN()

Constant * ConstantFP::getSNaN ( Type Ty,
bool  Negative = false,
APInt Payload = nullptr 
)
static

◆ getValueAPF()

const APFloat& llvm::ConstantFP::getValueAPF ( ) const
inline

◆ getZeroValueForNegation()

Constant * ConstantFP::getZeroValueForNegation ( Type Ty)
static

Floating point negation must be implemented with f(x) = -0.0 - x.

This method returns the negative zero constant for floating point or vector floating point types; for all other types, it returns the null value.

Definition at line 771 of file Constants.cpp.

References llvm::Constant::getNullValue(), and llvm::Type::isFPOrFPVectorTy().

Referenced by computeValueLLTs(), llvm::BinaryOperator::CreateFNeg(), llvm::BinaryOperator::CreateNeg(), llvm::BinaryOperator::CreateNSWNeg(), llvm::BinaryOperator::CreateNUWNeg(), llvm::ConstantExpr::getFNeg(), llvm::ConstantExpr::getNeg(), llvm::LegalizerHelper::lower(), and llvm::SelectionDAGBuilder::UpdateSplitBlock().

◆ isExactlyValue() [1/2]

bool ConstantFP::isExactlyValue ( const APFloat V) const

We don't rely on operator== working on double values, as it returns true for things that are clearly not equal, like -0.0 and 0.0.

As such, this method can be used to do an exact bit-for-bit comparison of two floating point values. The version with a double operand is retained because it's so convenient to write isExactlyValue(2.0), but please use it only for simple constants.

Definition at line 824 of file Constants.cpp.

References llvm_unreachable.

Referenced by llvm::AMDGPULibCalls::fold(), llvm::log2(), and shouldKeepFDivF32().

◆ isExactlyValue() [2/2]

bool llvm::ConstantFP::isExactlyValue ( double  V) const
inline

◆ isInfinity()

bool llvm::ConstantFP::isInfinity ( ) const
inline

Return true if the value is infinity.

Definition at line 312 of file Constants.h.

References llvm::APFloat::isInfinity().

Referenced by llvm::ConstantFPSDNode::isInfinity().

◆ isNaN()

bool llvm::ConstantFP::isNaN ( ) const
inline

Return true if the value is a NaN.

Definition at line 315 of file Constants.h.

References llvm::APFloat::isNaN().

Referenced by llvm::ConstantFPSDNode::isNaN().

◆ isNegative()

bool llvm::ConstantFP::isNegative ( ) const
inline

Return true if the sign bit is set.

Definition at line 309 of file Constants.h.

References llvm::APFloat::isNegative().

Referenced by buildMultiplyTree(), isMulPowOf2(), llvm::ConstantFPSDNode::isNegative(), and llvm::log2().

◆ isValueValidForType()

bool ConstantFP::isValueValidForType ( Type Ty,
const APFloat V 
)
static

◆ isZero()

bool llvm::ConstantFP::isZero ( ) const
inline

Return true if the value is positive or negative zero.

Definition at line 306 of file Constants.h.

References llvm::APFloat::isZero().

Referenced by isMulPowOf2(), llvm::ConstantFPSDNode::isZero(), and llvm::log2().

Friends And Related Function Documentation

◆ Constant

friend class Constant
friend

Definition at line 265 of file Constants.h.


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