This is the shared class of boolean and integer constants. More...

#include "llvm/IR/Constants.h"

Inheritance diagram for llvm::ConstantInt:

Public Member Functions
	ConstantInt (const ConstantInt &)=delete

const APInt &	getValue () const
	Return the constant as an APInt value reference.

unsigned	getBitWidth () const
	getBitWidth - Return the scalar bitwidth of this constant.

uint64_t	getZExtValue () const
	Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate for the type of this constant.

int64_t	getSExtValue () const
	Return the constant as a 64-bit integer value after it has been sign extended as appropriate for the type of this constant.

MaybeAlign	getMaybeAlignValue () const
	Return the constant as an llvm::MaybeAlign.

Align	getAlignValue () const
	Return the constant as an llvm::Align, interpreting `0` as `Align(1)`.

bool	equalsInt (uint64_t V) const
	A helper method that can be used to determine if the constant contained within is equal to a constant.

IntegerType *	getIntegerType () const
	Variant of the getType() method to always return an IntegerType, which reduces the amount of casting needed in parts of the compiler.

bool	isNegative () const

bool	isZero () const
	This is just a convenience method to make client code smaller for a common code.

bool	isOne () const
	This is just a convenience method to make client code smaller for a common case.

bool	isMinusOne () const
	This function will return true iff every bit in this constant is set to true.

bool	isMaxValue (bool IsSigned) const
	This function will return true iff this constant represents the largest value that may be represented by the constant's type.

bool	isMinValue (bool IsSigned) const
	This function will return true iff this constant represents the smallest value that may be represented by this constant's type.

bool	uge (uint64_t Num) const
	This function will return true iff this constant represents a value with active bits bigger than 64 bits or a value greater than the given uint64_t value.

uint64_t	getLimitedValue (uint64_t Limit=~0ULL) const
	getLimitedValue - If the value is smaller than the specified limit, return it, otherwise return the limit value.

Public Member Functions inherited from llvm::ConstantData
void	operator delete (void *Ptr)

	ConstantData (const ConstantData &)=delete

Public Member Functions inherited from llvm::Constant
void	operator= (const Constant &)=delete

	Constant (const Constant &)=delete

LLVM_ABI bool	isNullValue () const
	Return true if this is the value that would be returned by getNullValue.

LLVM_ABI bool	isOneValue () const
	Returns true if the value is one.

LLVM_ABI bool	isNotOneValue () const
	Return true if the value is not the one value, or, for vectors, does not contain one value elements.

LLVM_ABI bool	isAllOnesValue () const
	Return true if this is the value that would be returned by getAllOnesValue.

LLVM_ABI bool	isNegativeZeroValue () const
	Return true if the value is what would be returned by getZeroValueForNegation.

LLVM_ABI bool	isZeroValue () const
	Return true if the value is negative zero or null value.

LLVM_ABI bool	isNotMinSignedValue () const
	Return true if the value is not the smallest signed value, or, for vectors, does not contain smallest signed value elements.

LLVM_ABI bool	isMinSignedValue () const
	Return true if the value is the smallest signed value.

LLVM_ABI bool	isFiniteNonZeroFP () const
	Return true if this is a finite and non-zero floating-point scalar constant or a fixed width vector constant with all finite and non-zero elements.

LLVM_ABI bool	isNormalFP () const
	Return true if this is a normal (as opposed to denormal, infinity, nan, or zero) floating-point scalar constant or a vector constant with all normal elements.

LLVM_ABI 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.

LLVM_ABI bool	isNaN () const
	Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements.

LLVM_ABI bool	isElementWiseEqual (Value *Y) const
	Return true if this constant and a constant 'Y' are element-wise equal.

LLVM_ABI bool	containsUndefOrPoisonElement () const
	Return true if this is a vector constant that includes any undef or poison elements.

LLVM_ABI bool	containsPoisonElement () const
	Return true if this is a vector constant that includes any poison elements.

LLVM_ABI bool	containsUndefElement () const
	Return true if this is a vector constant that includes any strictly undef (not poison) elements.

LLVM_ABI bool	containsConstantExpression () const
	Return true if this is a fixed width vector constant that includes any constant expressions.

LLVM_ABI bool	isThreadDependent () const
	Return true if the value can vary between threads.

LLVM_ABI bool	isDLLImportDependent () const
	Return true if the value is dependent on a dllimport variable.

LLVM_ABI bool	isConstantUsed () const
	Return true if the constant has users other than constant expressions and other dangling things.

LLVM_ABI bool	needsRelocation () const
	This method classifies the entry according to whether or not it may generate a relocation entry (either static or dynamic).

LLVM_ABI bool	needsDynamicRelocation () const

LLVM_ABI Constant *	getAggregateElement (unsigned Elt) const
	For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not.

LLVM_ABI Constant *	getAggregateElement (Constant *Elt) const

LLVM_ABI Constant *	getSplatValue (bool AllowPoison=false) const
	If all elements of the vector constant have the same value, return that value.

LLVM_ABI const APInt &	getUniqueInteger () 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.

LLVM_ABI ConstantRange	toConstantRange () const
	Convert constant to an approximate constant range.

LLVM_ABI void	destroyConstant ()
	Called if some element of this constant is no longer valid.

LLVM_ABI void	handleOperandChange (Value , Value )
	This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants.

LLVM_ABI void	removeDeadConstantUsers () const
	If there are any dead constant users dangling off of this constant, remove them.

LLVM_ABI bool	hasOneLiveUse () const
	Return true if the constant has exactly one live use.

LLVM_ABI bool	hasZeroLiveUses () const
	Return true if the constant has no live uses.

const Constant *	stripPointerCasts () const

Constant *	stripPointerCasts ()

LLVM_ABI bool	isManifestConstant () const
	Return true if a constant is ConstantData or a ConstantAggregate or ConstantExpr that contain only ConstantData.

Public Member Functions inherited from llvm::User
	User (const User &)=delete

LLVM_ABI void	operator delete (void *Usr)
	Free memory allocated for User and Use objects.

void	operator delete (void *Usr, HungOffOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.

void	operator delete (void *Usr, IntrusiveOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.

void	operator delete (void *Usr, IntrusiveOperandsAndDescriptorAllocMarker)
	Placement delete - required by std, called if the ctor throws.

const Use *	getOperandList () const

Use *	getOperandList ()

Value *	getOperand (unsigned i) const

void	setOperand (unsigned i, Value *Val)

const Use &	getOperandUse (unsigned i) const

Use &	getOperandUse (unsigned i)

unsigned	getNumOperands () const

LLVM_ABI ArrayRef< const uint8_t >	getDescriptor () const
	Returns the descriptor co-allocated with this User instance.

LLVM_ABI MutableArrayRef< uint8_t >	getDescriptor ()
	Returns the descriptor co-allocated with this User instance.

void	setNumHungOffUseOperands (unsigned NumOps)
	Subclasses with hung off uses need to manage the operand count themselves.

LLVM_ABI bool	isDroppable () const
	A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening.

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_iterator >	operand_values ()

const_value_op_iterator	value_op_begin () const

const_value_op_iterator	value_op_end () const

iterator_range< const_value_op_iterator >	operand_values () const

void	dropAllReferences ()
	Drop all references to operands.

LLVM_ABI bool	replaceUsesOfWith (Value From, Value To)
	Replace uses of one Value with another.

Public Member Functions inherited from llvm::Value
	Value (const Value &)=delete

Value &	operator= (const Value &)=delete

LLVM_ABI void	deleteValue ()
	Delete a pointer to a generic Value.

LLVM_ABI void	dump () const
	Support for debugging, callable in GDB: V->dump()

Type *	getType () const
	All values are typed, get the type of this value.

LLVM_ABI LLVMContext &	getContext () const
	All values hold a context through their type.

bool	hasName () const

LLVM_ABI ValueName *	getValueName () const

LLVM_ABI void	setValueName (ValueName *VN)

LLVM_ABI StringRef	getName () const
	Return a constant reference to the value's name.

LLVM_ABI void	setName (const Twine &Name)
	Change the name of the value.

LLVM_ABI void	takeName (Value *V)
	Transfer the name from V to this value.

LLVM_ABI std::string	getNameOrAsOperand () const

LLVM_ABI void	replaceAllUsesWith (Value *V)
	Change all uses of this to point to a new Value.

LLVM_ABI void	replaceNonMetadataUsesWith (Value *V)
	Change non-metadata uses of this to point to a new Value.

LLVM_ABI void	replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
	Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use.

LLVM_ABI 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.

LLVM_ABI void	assertModuleIsMaterializedImpl () const

void	assertModuleIsMaterialized () const

bool	hasUseList () const
	Check if this Value has a use-list.

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_iterator >	materialized_uses ()

iterator_range< const_use_iterator >	materialized_uses () const

iterator_range< use_iterator >	uses ()

iterator_range< const_use_iterator >	uses () 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

User *	user_back ()

const User *	user_back () const

iterator_range< user_iterator >	materialized_users ()

iterator_range< const_user_iterator >	materialized_users () const

iterator_range< user_iterator >	users ()

iterator_range< const_user_iterator >	users () const

bool	hasOneUse () const
	Return true if there is exactly one use of this value.

LLVM_ABI bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N uses.

LLVM_ABI bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.

LLVM_ABI bool	hasOneUser () const
	Return true if there is exactly one user of this value.

LLVM_ABI Use *	getSingleUndroppableUse ()
	Return true if there is exactly one use of this value that cannot be dropped.

const Use *	getSingleUndroppableUse () const

LLVM_ABI User *	getUniqueUndroppableUser ()
	Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value).

const User *	getUniqueUndroppableUser () const

LLVM_ABI bool	hasNUndroppableUses (unsigned N) const
	Return true if there this value.

LLVM_ABI bool	hasNUndroppableUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.

LLVM_ABI void	dropDroppableUses (llvm::function_ref< bool(const Use )> ShouldDrop=[](const Use ) { return true;})
	Remove every uses that can safely be removed.

LLVM_ABI void	dropDroppableUsesIn (User &Usr)
	Remove every use of this value in `User` that can safely be removed.

LLVM_ABI bool	isUsedInBasicBlock (const BasicBlock *BB) const
	Check if this value is used in the specified basic block.

LLVM_ABI unsigned	getNumUses () const
	This method computes the number of uses of this Value.

void	addUse (Use &U)
	This method should only be used by the Use class.

unsigned	getValueID () const
	Return an ID for the concrete type of this object.

unsigned	getRawSubclassOptionalData () const
	Return the raw optional flags value contained in this value.

void	clearSubclassOptionalData ()
	Clear the optional flags contained in this value.

bool	hasSameSubclassOptionalData (const Value *V) const
	Check the optional flags for equality.

bool	hasValueHandle () const
	Return true if there is a value handle associated with this value.

bool	isUsedByMetadata () const
	Return true if there is metadata referencing this value.

LLVM_ABI bool	isSwiftError () const
	Return true if this value is a swifterror value.

LLVM_ABI const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs and address space casts.

Value *	stripPointerCasts ()

LLVM_ABI const Value *	stripPointerCastsAndAliases () const
	Strip off pointer casts, all-zero GEPs, address space casts, and aliases.

Value *	stripPointerCastsAndAliases ()

LLVM_ABI const Value *	stripPointerCastsSameRepresentation () const
	Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.

Value *	stripPointerCastsSameRepresentation ()

LLVM_ABI const Value *	stripPointerCastsForAliasAnalysis () const
	Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.

Value *	stripPointerCastsForAliasAnalysis ()

LLVM_ABI const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs.

Value *	stripInBoundsConstantOffsets ()

LLVM_ABI const Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
	Accumulate the constant offset this value has compared to a base pointer.

Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false)

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)

LLVM_ABI const Value *	stripInBoundsOffsets (function_ref< void(const Value )> Func=[](const Value ) {}) const
	Strip off pointer casts and inbounds GEPs.

Value *	stripInBoundsOffsets (function_ref< void(const Value )> Func=[](const Value ) {})

LLVM_ABI std::optional< int64_t >	getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
	If this ptr is provably equal to `Other` plus a constant offset, return that offset in bytes.

LLVM_ABI bool	canBeFreed () const
	Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined.

LLVM_ABI uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
	Returns the number of bytes known to be dereferenceable for the pointer value.

LLVM_ABI Align	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value.

LLVM_ABI const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block.

Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)

void	mutateType (Type *Ty)
	Mutate the type of this Value to be of the specified type.

template<class Compare >
void	sortUseList (Compare Cmp)
	Sort the use-list.

LLVM_ABI void	reverseUseList ()
	Reverse the use-list.

LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false) const
	Implement operator<< on Value.

LLVM_ABI void	print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const

LLVM_ABI 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.

LLVM_ABI void	printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const

Static Public Member Functions
static LLVM_ABI ConstantInt *	getTrue (LLVMContext &Context)

static LLVM_ABI ConstantInt *	getFalse (LLVMContext &Context)

static LLVM_ABI ConstantInt *	getBool (LLVMContext &Context, bool V)

static LLVM_ABI Constant *	getTrue (Type *Ty)

static LLVM_ABI Constant *	getFalse (Type *Ty)

static LLVM_ABI Constant *	getBool (Type *Ty, bool V)

static LLVM_ABI Constant *	get (Type *Ty, uint64_t V, bool IsSigned=false)
	If Ty is a vector type, return a Constant with a splat of the given value.

static LLVM_ABI ConstantInt *	get (IntegerType *Ty, uint64_t V, bool IsSigned=false)
	Return a ConstantInt with the specified integer value for the specified type.

static ConstantInt *	getSigned (IntegerType *Ty, int64_t V)
	Return a ConstantInt with the specified value for the specified type.

static Constant *	getSigned (Type *Ty, int64_t V)

static LLVM_ABI ConstantInt *	get (LLVMContext &Context, const APInt &V)
	Return a ConstantInt with the specified value and an implied Type.

static LLVM_ABI ConstantInt *	get (IntegerType *Ty, StringRef Str, uint8_t Radix)
	Return a ConstantInt constructed from the string strStart with the given radix.

static LLVM_ABI Constant *	get (Type *Ty, const APInt &V)
	If Ty is a vector type, return a Constant with a splat of the given value.

static LLVM_ABI bool	isValueValidForType (Type *Ty, uint64_t V)
	This static method returns true if the type Ty is big enough to represent the value V.

static LLVM_ABI bool	isValueValidForType (Type *Ty, int64_t V)

static bool	classof (const Value *V)
	Methods to support type inquiry through isa, cast, and dyn_cast.

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.

Static Public Member Functions inherited from llvm::Constant
static bool	classof (const Value *V)

static LLVM_ABI Constant *	getNullValue (Type *Ty)
	Constructor to create a '0' constant of arbitrary type.

static LLVM_ABI Constant *	getAllOnesValue (Type *Ty)

static LLVM_ABI Constant *	getIntegerValue (Type *Ty, const APInt &V)
	Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value.

static LLVM_ABI Constant *	replaceUndefsWith (Constant C, Constant Replacement)
	Try to replace undefined constant C or undefined elements in C with Replacement.

static LLVM_ABI Constant *	mergeUndefsWith (Constant C, Constant Other)
	Merges undefs of a Constant with another Constant, along with the undefs already present.

Static Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)

Static Public Member Functions inherited from llvm::Value
static LLVM_ABI void	dropDroppableUse (Use &U)
	Remove the droppable use `U`.

Friends
class	Constant

class	ConstantVector

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 constexpr unsigned	MaxAlignmentExponent = 32
	The maximum alignment for instructions.

static constexpr uint64_t	MaximumAlignment = 1ULL << MaxAlignmentExponent

Protected Types inherited from llvm::Value
enum	: unsigned { NumUserOperandsBits = 27 }
	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, AllocInfo AllocInfo)

	~Constant ()=default

Protected Member Functions inherited from llvm::User
void *	operator new (size_t Size)=delete

LLVM_ABI void *	operator new (size_t Size, HungOffOperandsAllocMarker)
	Allocate a User with an operand pointer co-allocated.

LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.

LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAndDescriptorAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.

	User (Type *ty, unsigned vty, AllocInfo AllocInfo)

LLVM_ABI void	allocHungoffUses (unsigned N, bool IsPhi=false)
	Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.

LLVM_ABI void	growHungoffUses (unsigned N, bool IsPhi=false)
	Grow the number of hung off uses.

	~User ()=default

template<int Idx>
Use &	Op ()

template<int Idx>
const Use &	Op () const

Protected Member Functions inherited from llvm::Value
LLVM_ABI	Value (Type *Ty, unsigned scid)

LLVM_ABI	~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.

LLVM_ABI void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	Appends all metadata attached to this value to `MDs`, sorting by KindID.

bool	hasMetadata () const
	Return true if this value has any metadata attached to it.

LLVM_ABI bool	eraseMetadata (unsigned KindID)
	Erase all metadata attachments with the given kind.

LLVM_ABI void	eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
	Erase all metadata attachments matching the given predicate.

LLVM_ABI void	clearMetadata ()
	Erase all metadata attached to this Value.

LLVM_ABI MDNode *	getMetadataImpl (unsigned KindID) const
	Get metadata for the given kind, if any.

unsigned short	getSubclassDataFromValue () const

void	setValueSubclassData (unsigned short D)

MDNode *	getMetadata (unsigned KindID) const
	Get the current metadata attachments for the given kind, if any.

LLVM_ABI MDNode *	getMetadata (StringRef Kind) const

LLVM_ABI void	getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
	Appends all attachments with the given ID to `MDs` in insertion order.

LLVM_ABI void	getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const

bool	hasMetadata (unsigned KindID) const
	Return true if this value has the given type of metadata attached.

bool	hasMetadata (StringRef Kind) const

LLVM_ABI void	setMetadata (unsigned KindID, MDNode *Node)
	Set a particular kind of metadata attachment.

LLVM_ABI void	setMetadata (StringRef Kind, MDNode *Node)

LLVM_ABI void	addMetadata (unsigned KindID, MDNode &MD)
	Add a metadata attachment.

LLVM_ABI void	addMetadata (StringRef Kind, MDNode &MD)

Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static Use &	OpFrom (const U *that)

Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7
	Hold subclass data that can be dropped.

unsigned	NumUserOperands: NumUserOperandsBits

unsigned	IsUsedByMD: 1

unsigned	HasName: 1

unsigned	HasMetadata: 1

unsigned	HasHungOffUses: 1

unsigned	HasDescriptor: 1

Detailed Description

This is the shared class of boolean and integer constants.

This class represents both boolean and integral constants. Class for constant integers.

Definition at line 87 of file Constants.h.

Constructor & Destructor Documentation

◆ ConstantInt()

llvm::ConstantInt::ConstantInt ( const ConstantInt & )

delete

Member Function Documentation

◆ classof()

static bool llvm::ConstantInt::classof ( const Value * V )

inlinestatic

Methods to support type inquiry through isa, cast, and dyn_cast.

Definition at line 269 of file Constants.h.

◆ equalsInt()

bool llvm::ConstantInt::equalsInt ( uint64_t V ) const

inline

A helper method that can be used to determine if the constant contained within is equal to a constant.

This only works for very small values, because this is all that can be represented with all types. Determine if this constant's value is same as an unsigned char.

Definition at line 189 of file Constants.h.

Referenced by llvm::GIMatchTableExecutor::executeMatchTable(), and llvm::AAMDNodes::extendToTBAA().

◆ get() [1/5]

ConstantInt * ConstantInt::get	(	IntegerType *	Ty,
		StringRef	Str,
		uint8_t	Radix
	)

static

Return a ConstantInt constructed from the string strStart with the given radix.

Definition at line 972 of file Constants.cpp.

References llvm::IntegerType::getBitWidth(), and llvm::Type::getContext().

◆ get() [2/5]

ConstantInt * ConstantInt::get	(	IntegerType *	Ty,
		uint64_t	V,
		bool	IsSigned = `false`
	)

static

Return a ConstantInt with the specified integer value for the specified type.

If the type is wider than 64 bits, the value will be zero-extended to fit the type, unless IsSigned is true, in which case the value will be interpreted as a 64-bit signed integer and sign-extended to fit the type. Get a ConstantInt for a specific value.

Definition at line 953 of file Constants.cpp.

References llvm::IntegerType::getBitWidth(), llvm::Type::getContext(), and isSigned().

◆ get() [3/5]

ConstantInt * ConstantInt::get	(	LLVMContext &	Context,
		const APInt &	V
	)

static

Return a ConstantInt with the specified value and an implied Type.

The type is the integer type that corresponds to the bit width of the value.

Definition at line 907 of file Constants.cpp.

References assert(), Context, llvm::IntegerType::get(), llvm::LLVMContextImpl::IntConstants, llvm::LLVMContextImpl::IntOneConstants, and llvm::LLVMContextImpl::IntZeroConstants.

◆ get() [4/5]

Constant * ConstantInt::get	(	Type *	Ty,
		const APInt &	V
	)

static

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

Otherwise return a ConstantInt for the given value.

Definition at line 960 of file Constants.cpp.

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

◆ get() [5/5]

Constant * ConstantInt::get	(	Type *	Ty,
		uint64_t	V,
		bool	IsSigned = `false`
	)

static

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

Otherwise return a ConstantInt for the given value.

Definition at line 943 of file Constants.cpp.

References llvm::CallingConv::C, llvm::Type::getScalarType(), llvm::ConstantVector::getSplat(), and isSigned().

◆ getAlignValue()

Align llvm::ConstantInt::getAlignValue ( ) const

inline

Return the constant as an llvm::Align, interpreting 0 as Align(1).

Note that this method can assert if the value does not fit in 64 bits or is not a power of two.

Definition at line 181 of file Constants.h.

References getMaybeAlignValue(), and llvm::MaybeAlign::valueOrOne().

◆ getBitWidth()

unsigned llvm::ConstantInt::getBitWidth ( ) const

inline

getBitWidth - Return the scalar bitwidth of this constant.

Definition at line 157 of file Constants.h.

References llvm::APInt::getBitWidth().

Referenced by llvm::MachineIRBuilder::buildConstant(), emitGlobalConstantLargeInt(), llvm::InstCombinerImpl::foldICmpEquality(), foldSwitchToSelect(), llvm::SelectionDAG::getConstant(), getPreferredVectorIndex(), handleBrSelExpect(), processUGT_ADDCST_ADD(), and widenCImmType().

◆ getBool() [1/2]

ConstantInt * ConstantInt::getBool	(	LLVMContext &	Context,
		bool	V
	)

static

◆ getBool() [2/2]

Constant * ConstantInt::getBool	(	Type *	Ty,
		bool	V
	)

static

Definition at line 902 of file Constants.cpp.

References getFalse(), and getTrue().

◆ getFalse() [1/2]

ConstantInt * ConstantInt::getFalse ( LLVMContext & Context )

static

Definition at line 875 of file Constants.cpp.

References Context, llvm::Type::getInt1Ty(), and llvm::LLVMContextImpl::TheFalseVal.

◆ getFalse() [2/2]

Constant * ConstantInt::getFalse ( Type * Ty )

static

Definition at line 894 of file Constants.cpp.

References assert(), llvm::Type::getContext(), getFalse(), llvm::ConstantVector::getSplat(), and llvm::Type::isIntOrIntVectorTy().

◆ getIntegerType()

IntegerType * llvm::ConstantInt::getIntegerType ( ) const

inline

Variant of the getType() method to always return an IntegerType, which reduces the amount of casting needed in parts of the compiler.

Definition at line 193 of file Constants.h.

References llvm::Value::getType().

Referenced by switchToLookupTable().

◆ getLimitedValue()

uint64_t llvm::ConstantInt::getLimitedValue ( uint64_t Limit = ~0ULL ) const

inline

getLimitedValue - If the value is smaller than the specified limit, return it, otherwise return the limit value.

This causes the value to saturate to the limit.

Returns: the min of the value of the constant and the specified value Get the constant's value with a saturation limit

Definition at line 264 of file Constants.h.

References llvm::APInt::getLimitedValue().

Referenced by canEvaluateShuffled(), llvm::InstCombinerImpl::foldICmpEquality(), getSortedConstantKeys(), llvm::AsmPrinter::preprocessXXStructorList(), shouldUseSwitchConditionAsTableIndex(), llvm::InstCombinerImpl::SimplifyAnyMemSet(), llvm::InstCombinerImpl::SimplifyAnyMemTransfer(), and switchToLookupTable().

◆ getMaybeAlignValue()

MaybeAlign llvm::ConstantInt::getMaybeAlignValue ( ) const

inline

Return the constant as an llvm::MaybeAlign.

Note that this method can assert if the value does not fit in 64 bits or is not a power of two.

Definition at line 174 of file Constants.h.

References getZExtValue().

Referenced by getAlignValue().

◆ getSExtValue()

int64_t llvm::ConstantInt::getSExtValue ( ) const

inline

Return the constant as a 64-bit integer value after it has been sign extended as appropriate for the type of this constant.

Note that this method can assert if the value does not fit in 64 bits. Return the sign extended value.

Definition at line 169 of file Constants.h.

References llvm::APInt::getSExtValue().

Referenced by llvm::addStringMetadataToLoop(), canFoldIVIncExpr(), checkOffsetSize(), decompose(), llvm::MDNodeKeyImpl< DISubrangeType >::getHashValue(), llvm::getOptionalIntLoopAttribute(), llvm::AMDGPUTTIImpl::getUnrollingPreferences(), llvm::IndexedReference::hasSpacialReuse(), llvm::IndexedReference::hasTemporalReuse(), llvm::MDNodeKeyImpl< DISubrange >::isKeyOf(), llvm::MDNodeKeyImpl< DISubrangeType >::isKeyOf(), isKnownNonNull(), isLoadInvariantInLoop(), and X86ChooseCmpImmediateOpcode().

◆ getSigned() [1/2]

static ConstantInt * llvm::ConstantInt::getSigned	(	IntegerType *	Ty,
		int64_t	V
	)

inlinestatic

Return a ConstantInt with the specified value for the specified type.

The value V will be canonicalized to a an unsigned APInt. Accessing it with either getSExtValue() or getZExtValue() will yield a correctly sized and signed value for the type Ty. Get a ConstantInt for a specific signed value.

Definition at line 131 of file Constants.h.

Referenced by checkAndReplaceCmp(), llvm::OpenMPIRBuilder::createTargetInit(), expandFPToI(), expandIToFP(), llvm::InstCombinerImpl::foldICmpUsingBoolRange(), generateUnsignedDivisionCode(), llvm::DIBuilder::getOrCreateSubrange(), llvm::sandboxir::ConstantInt::getSigned(), getSignedIntOrFpConstant(), processCmpIntrinsic(), llvm::simplifyBinaryIntrinsic(), transformRecipestoEVLRecipes(), llvm::InstCombinerImpl::visitAdd(), and llvm::InstCombinerImpl::visitLShr().

◆ getSigned() [2/2]

static Constant * llvm::ConstantInt::getSigned	(	Type *	Ty,
		int64_t	V
	)

inlinestatic

Definition at line 134 of file Constants.h.

◆ getTrue() [1/2]

ConstantInt * ConstantInt::getTrue ( LLVMContext & Context )

static

Definition at line 868 of file Constants.cpp.

References Context, llvm::Type::getInt1Ty(), and llvm::LLVMContextImpl::TheTrueVal.

◆ getTrue() [2/2]

Constant * ConstantInt::getTrue ( Type * Ty )

static

Definition at line 886 of file Constants.cpp.

References assert(), llvm::Type::getContext(), llvm::ConstantVector::getSplat(), getTrue(), and llvm::Type::isIntOrIntVectorTy().

◆ getValue()

const APInt & llvm::ConstantInt::getValue ( ) const

inline

Return the constant as an APInt value reference.

This allows clients to obtain a full-precision copy of the value. Return the constant's value.

Definition at line 154 of file Constants.h.

Referenced by llvm::DwarfUnit::addConstantValue(), canScalarizeAccess(), canUseSExt(), llvm::SwitchCG::SwitchLowering::caseClusterRank(), cheapToScalarize(), llvm::JumpThreadingPass::computeValueKnownInPredecessorsImpl(), llvm::DIExpression::constantFold(), decompose(), llvm::BitTracker::MachineEvaluator::eIMM(), emitGlobalConstantLargeInt(), findDemandedEltsBySingleUser(), llvm::InstCombinerImpl::foldICmpEquality(), llvm::InstCombinerImpl::foldICmpSelectConstant(), foldSwitchToSelect(), llvm::generateGroupUniformInst(), llvm::generateSpecConstantInst(), llvm::getAllocSize(), llvm::SCEVConstant::getAPInt(), llvm::SystemZTTIImpl::getArithmeticInstrCost(), getBoundsCheckCond(), llvm::SelectionDAG::getConstant(), getConstant(), getConstantTripCount(), llvm::getConstFromIntrinsic(), llvm::TargetTransformInfoImplCRTPBase< T >::getGEPCost(), llvm::CoroSubFnInst::getIndex(), llvm::MDNode::getMostGenericRange(), llvm::SCEVAddRecExpr::getNumIterationsInRange(), getPreferredVectorIndex(), llvm::GVScale::getSrc(), llvm::GStepVector::getStep(), handlePhiDef(), llvm::hasProcessableCondition(), llvm::GCNTTIImpl::instCombineIntrinsic(), instCombineSVESDIV(), llvm::isKnownToBeAPowerOfTwo(), isNonZeroModBitWidthOrUndef(), isObjectSizeLessThanOrEq(), isOperandOfVmullHighP64(), isSSATMinMaxPattern(), llvm::RISCVLegalizerInfo::legalizeCustom(), llvm::WebAssemblyMCInstLower::lower(), llvm::CombinerHelper::matchCombineUnmergeConstant(), matchShiftULTCondition(), matchStridedConstant(), llvm::LoopStructure::parseLoopStructure(), processSwitch(), processUGT_ADDCST_ADD(), processUMulZExtIdiom(), llvm::InstCombinerImpl::SimplifyAnyMemSet(), llvm::InstCombinerImpl::SimplifyDemandedUseBits(), simplifyX86extrq(), SolveQuadraticAddRecRange(), llvm::SwitchCG::sortAndRangeify(), llvm::stableHashValue(), switchToLookupTable(), tryUnmergingGEPsAcrossIndirectBr(), verifyTripCount(), llvm::InstCombinerImpl::visitXor(), widenCImmType(), and llvm::LegalizerHelper::widenScalar().

◆ getZExtValue()

uint64_t llvm::ConstantInt::getZExtValue ( ) const

inline

Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate for the type of this constant.

Note that this method can assert if the value does not fit in 64 bits. Return the zero extended value.

Definition at line 163 of file Constants.h.

References llvm::APInt::getZExtValue().

Referenced by llvm::AttrBuilder::addFromEquivalentMetadata(), llvm::VNCoercion::analyzeLoadFromClobberingMemInst(), llvm::MachineIRBuilder::buildConstantPtrAuth(), llvm::buildOpSpirvDecorations(), CheckAndCreateOffsetAdd(), collectInsertionElements(), llvm::VPHistogramRecipe::computeCost(), llvm::ConstantFoldInsertElementInstruction(), llvm::createMemCpyLoopKnownSize(), createMemMoveLoopKnownSize(), llvm::AsmPrinter::emitIndirectCalleeLabels(), emitMemsetExpansion(), findDemandedEltsBySingleUser(), foldCondBranchOnValueKnownInPredecessorImpl(), foldVecExtTruncToExtElt(), foldVecTruncToExtElt(), getConstantTripCount(), llvm::DOTGraphTraits< DOTFuncInfo * >::getEdgeAttributes(), llvm::TargetTransformInfoImplCRTPBase< T >::getGEPCost(), getHiPELiteral(), getImmedFromMO(), llvm::GEPOperator::getMaxPreservedAlignment(), getMaybeAlignValue(), llvm::MDNode::getMostGenericAlignmentOrDereferenceable(), llvm::slpvectorizer::BoUpSLP::LookAheadHeuristics::getShallowScore(), llvm::getValueProfDataFromInst(), getVarName(), handleBrSelExpect(), llvm::GCNTTIImpl::instCombineIntrinsic(), isGEPKnownNonNull(), llvm::ARMLegalizerInfo::legalizeCustom(), llvm::RISCVTargetLowering::LowerCall(), llvm::mayHaveValueProfileOfKind(), optimizeSection(), promoteAllocaUserToVector(), llvm::FunctionLoweringInfo::set(), llvm::AAMDNodes::shiftTBAAStruct(), simplifyAMDGCNMemoryIntrinsicDemanded(), simplifyShuffleVectorInst(), tryToRecognizeTableBasedCttz(), and upgradeAMDGCNIntrinsicCall().

◆ isMaxValue()

bool llvm::ConstantInt::isMaxValue ( bool IsSigned ) const

inline

This function will return true iff this constant represents the largest value that may be represented by the constant's type.

Returns: true iff this is the largest value that may be represented by this type. Determine if the value is maximal.

Definition at line 233 of file Constants.h.

References llvm::APInt::isMaxSignedValue(), and llvm::APInt::isMaxValue().

◆ isMinusOne()

bool llvm::ConstantInt::isMinusOne ( ) const

inline

This function will return true iff every bit in this constant is set to true.

Returns: true iff this constant's bits are all set to true. Determine if the value is all ones.

Definition at line 226 of file Constants.h.

References llvm::APInt::isAllOnes().

Referenced by detectPopcountIdiom(), detectShiftUntilLessThanIdiom(), detectShiftUntilZeroIdiom(), llvm::LoongArchTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::RISCVTargetLowering::emitMaskedAtomicRMWIntrinsic(), getBranchCondString(), llvm::LoopStructure::parseLoopStructure(), and llvm::InstCombinerImpl::simplifyRangeCheck().

◆ isMinValue()

bool llvm::ConstantInt::isMinValue ( bool IsSigned ) const

inline

This function will return true iff this constant represents the smallest value that may be represented by this constant's type.

Returns: true if this is the smallest value that may be represented by this type. Determine if the value is minimal.

Definition at line 245 of file Constants.h.

References llvm::APInt::isMinSignedValue(), and llvm::APInt::isMinValue().

◆ isNegative()

bool llvm::ConstantInt::isNegative ( ) const

inline

Definition at line 209 of file Constants.h.

References llvm::APInt::isNegative().

Referenced by decompose(), llvm::hasProcessableCondition(), isLoadInvariantInLoop(), llvm::LoopStructure::parseLoopStructure(), and shouldUseSwitchConditionAsTableIndex().

◆ isOne()

bool llvm::ConstantInt::isOne ( ) const

inline

This is just a convenience method to make client code smaller for a common case.

It also correctly performs the comparison without the potential for an assertion from getZExtValue(). Determine if the value is one.

Definition at line 220 of file Constants.h.

References llvm::APInt::isOne().

Referenced by buildMul(), detectPopcountIdiom(), detectShiftUntilLessThanIdiom(), detectShiftUntilZeroIdiom(), getBranchCondString(), llvm::Loop::isCanonical(), isConstantOne(), llvm::LoopStructure::parseLoopStructure(), and updatePredecessorProfileMetadata().

◆ isValueValidForType() [1/2]

bool ConstantInt::isValueValidForType	(	Type *	Ty,
		int64_t	V
	)

static

Definition at line 1609 of file Constants.cpp.

References llvm::Type::getIntegerBitWidth(), llvm::Type::isIntegerTy(), and llvm::isIntN().

◆ isValueValidForType() [2/2]

bool ConstantInt::isValueValidForType	(	Type *	Ty,
		uint64_t	V
	)

static

This static method returns true if the type Ty is big enough to represent the value V.

This can be used to avoid having the get method assert when V is larger than Ty can represent. Note that there are two versions of this method, one for unsigned and one for signed integers. Although ConstantInt canonicalizes everything to an unsigned integer, the signed version avoids callers having to convert a signed quantity to the appropriate unsigned type before calling the method.

Returns: true if V is a valid value for type Ty Determine if the value is in range for the given type.

Definition at line 1602 of file Constants.cpp.

References llvm::Type::getIntegerBitWidth(), llvm::Type::isIntegerTy(), and llvm::isUIntN().

Referenced by llvm::sandboxir::ConstantInt::isValueValidForType(), and llvm::X86TargetLowering::LowerAsmOperandForConstraint().

◆ isZero()

bool llvm::ConstantInt::isZero ( ) const

inline

This is just a convenience method to make client code smaller for a common code.

It also correctly performs the comparison without the potential for an assertion from getZExtValue().

Definition at line 214 of file Constants.h.

References llvm::APInt::isZero().

Referenced by addEmuTlsVar(), llvm::CodeViewDebug::beginModule(), llvm::SPIRVGlobalRegistry::createConstInt(), llvm::createMemCpyLoopKnownSize(), createMemMoveLoopKnownSize(), llvm::LoongArchTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::RISCVTargetLowering::emitMaskedAtomicRMWIntrinsic(), llvm::InstCombinerImpl::foldSelectICmp(), getBranchCondString(), llvm::AArch64TTIImpl::getIntrinsicInstrCost(), llvm::SITargetLowering::getTgtMemIntrinsic(), hasOnlyOneNonZeroIndex(), llvm::hasProcessableCondition(), llvm::IndexedReference::hasTemporalReuse(), llvm::AArch64TTIImpl::isProfitableToSinkOperands(), llvm::MemIntrinsic::isVolatile(), llvm::MemSetPatternInst::isVolatile(), llvm::LoopStructure::parseLoopStructure(), llvm::JumpThreadingPass::processBranchOnXOR(), llvm::InstCombinerImpl::simplifyRangeCheck(), and upgradeAMDGCNIntrinsicCall().

◆ uge()

bool llvm::ConstantInt::uge ( uint64_t Num ) const

inline

This function will return true iff this constant represents a value with active bits bigger than 64 bits or a value greater than the given uint64_t value.

Returns: true iff this constant is greater or equal to the given number. Determine if the value is greater or equal to the given number.

Definition at line 257 of file Constants.h.

References llvm::APInt::uge().

Referenced by llvm::ConstantFoldInsertElementInstruction().

Friends And Related Function Documentation

◆ Constant

friend class Constant

friend

Definition at line 88 of file Constants.h.

◆ ConstantVector

friend class ConstantVector

friend

Definition at line 89 of file Constants.h.

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

include/llvm/IR/Constants.h
lib/IR/Constants.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConstantInt()

Member Function Documentation

◆ classof()

◆ equalsInt()

◆ get() [1/5]

◆ get() [2/5]

◆ get() [3/5]

◆ get() [4/5]

◆ get() [5/5]

◆ getAlignValue()

◆ getBitWidth()

◆ getBool() [1/2]

◆ getBool() [2/2]

◆ getFalse() [1/2]

◆ getFalse() [2/2]

◆ getIntegerType()

◆ getLimitedValue()

◆ getMaybeAlignValue()

◆ getSExtValue()

◆ getSigned() [1/2]

◆ getSigned() [2/2]

◆ getTrue() [1/2]

◆ getTrue() [2/2]

◆ getValue()

◆ getZExtValue()

◆ isMaxValue()

◆ isMinusOne()

◆ isMinValue()

◆ isNegative()

◆ isOne()

◆ isValueValidForType() [1/2]

◆ isValueValidForType() [2/2]

◆ isZero()

◆ uge()

Friends And Related Function Documentation

◆ Constant

◆ ConstantVector