ConstantDataSequential - A vector or array constant whose element type is a simple 1/2/4/8-byte integer or float/double, and whose elements are just simple data values (i.e. More...

#include "llvm/IR/Constants.h"

Inheritance diagram for llvm::ConstantDataSequential:

[legend]

Collaboration diagram for llvm::ConstantDataSequential:

[legend]

Public Member Functions
	ConstantDataSequential (const ConstantDataSequential &)=delete

uint64_t	getElementAsInteger (unsigned i) const
	If this is a sequential container of integers (of any size), return the specified element in the low bits of a uint64_t. More...

APInt	getElementAsAPInt (unsigned i) const
	If this is a sequential container of integers (of any size), return the specified element as an APInt. More...

APFloat	getElementAsAPFloat (unsigned i) const
	If this is a sequential container of floating point type, return the specified element as an APFloat. More...

float	getElementAsFloat (unsigned i) const
	If this is an sequential container of floats, return the specified element as a float. More...

double	getElementAsDouble (unsigned i) const
	If this is an sequential container of doubles, return the specified element as a double. More...

Constant *	getElementAsConstant (unsigned i) const
	Return a Constant for a specified index's element. More...

SequentialType *	getType () const
	Specialize the getType() method to always return a SequentialType, which reduces the amount of casting needed in parts of the compiler. More...

Type *	getElementType () const
	Return the element type of the array/vector. More...

unsigned	getNumElements () const
	Return the number of elements in the array or vector. More...

uint64_t	getElementByteSize () const
	Return the size (in bytes) of each element in the array/vector. More...

bool	isString (unsigned CharSize=8) const
	This method returns true if this is an array of `CharSize` integers. More...

bool	isCString () const
	This method returns true if the array "isString", ends with a null byte, and does not contains any other null bytes. More...

StringRef	getAsString () const
	If this array is isString(), then this method returns the array as a StringRef. More...

StringRef	getAsCString () const
	If this array is isCString(), then this method returns the array (without the trailing null byte) as a StringRef. More...

StringRef	getRawDataValues () const
	Return the raw, underlying, bytes of this data. More...

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

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

Constant *	getAggregateElement (Constant *Elt) const

Constant *	getSplatValue () const
	If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...

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. 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 Constant *	stripPointerCasts () const

Constant *	stripPointerCasts ()

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

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

Value &	operator= (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...

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

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

bool	hasName () const

ValueName *	getValueName () 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_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 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 Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs, and aliases. More...

Value *	stripPointerCasts ()

const Value *	stripPointerCastsAndInvariantGroups () const
	Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...

Value *	stripPointerCastsAndInvariantGroups ()

const Value *	stripPointerCastsNoFollowAliases () const
	Strip off pointer casts and all-zero GEPs. More...

Value *	stripPointerCastsNoFollowAliases ()

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

Value *	stripInBoundsConstantOffsets ()

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	Accumulate offsets from stripInBoundsConstantOffsets(). More...

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

const Value *	stripInBoundsOffsets () const
	Strip off pointer casts and inbounds GEPs. More...

Value *	stripInBoundsOffsets ()

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 Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block. More...

Value *	DoPHITranslation (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 bool	isElementTypeCompatible (Type *Ty)
	Return true if a ConstantDataSequential can be formed with a vector or array of the specified element type. 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 Constant *	getNullValue (Type *Ty)
	Constructor to create a '0' constant of arbitrary type. More...

static Constant *	getAllOnesValue (Type *Ty)

static 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. More...

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

Protected Member Functions
	ConstantDataSequential (Type ty, ValueTy VT, const char Data)

	~ConstantDataSequential ()

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>
Use &	Op ()

template<int Idx>
const Use &	Op () 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
static Constant *	getImpl (StringRef Bytes, Type *Ty)
	This is the underlying implementation of all of the ConstantDataSequential::get methods. More...

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

Friends
class	LLVMContextImpl

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

ConstantDataSequential - A vector or array constant whose element type is a simple 1/2/4/8-byte integer or float/double, and whose elements are just simple data values (i.e.

ConstantInt/ConstantFP). This Constant node has no operands because it stores all of the elements of the constant as densely packed data, instead of as Value*'s.

This is the common base class of ConstantDataArray and ConstantDataVector.

Definition at line 574 of file Constants.h.

Constructor & Destructor Documentation

◆ ConstantDataSequential() [1/2]

llvm::ConstantDataSequential::ConstantDataSequential	(	Type *	ty,
		ValueTy	VT,
		const char *	Data
	)

inlineexplicitprotected

Definition at line 591 of file Constants.h.

◆ ~ConstantDataSequential()

llvm::ConstantDataSequential::~ConstantDataSequential ( )

inlineprotected

Definition at line 593 of file Constants.h.

References getImpl().

◆ ConstantDataSequential() [2/2]

llvm::ConstantDataSequential::ConstantDataSequential ( const ConstantDataSequential & )

delete

Member Function Documentation

◆ classof()

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

inlinestatic

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

Definition at line 675 of file Constants.h.

References llvm::Value::getValueID().

◆ getAsCString()

StringRef llvm::ConstantDataSequential::getAsCString ( ) const

inline

If this array is isCString(), then this method returns the array (without the trailing null byte) as a StringRef.

Otherwise, it asserts out.

Definition at line 663 of file Constants.h.

References assert(), llvm::StringRef::size(), and llvm::StringRef::substr().

◆ getAsString()

StringRef llvm::ConstantDataSequential::getAsString ( ) const

inline

If this array is isString(), then this method returns the array as a StringRef.

Otherwise, it asserts out.

Definition at line 656 of file Constants.h.

References assert().

Referenced by emitGlobalConstantDataSequential(), and llvm::getConstantStringInfo().

◆ getElementAsAPFloat()

APFloat ConstantDataSequential::getElementAsAPFloat ( unsigned i ) const

If this is a sequential container of floating point type, return the specified element as an APFloat.

Definition at line 2728 of file Constants.cpp.

References llvm::lltok::APFloat, llvm::Type::DoubleTyID, llvm::Type::FloatTyID, getTypeID(), llvm::Type::HalfTyID, llvm::APFloatBase::IEEEdouble(), llvm::APFloatBase::IEEEhalf(), llvm::APFloatBase::IEEEsingle(), and llvm_unreachable.

Referenced by emitGlobalConstantDataSequential().

◆ getElementAsAPInt()

APInt ConstantDataSequential::getElementAsAPInt ( unsigned i ) const

If this is a sequential container of integers (of any size), return the specified element as an APInt.

Definition at line 2700 of file Constants.cpp.

References assert(), and llvm_unreachable.

◆ getElementAsConstant()

Constant * ConstantDataSequential::getElementAsConstant ( unsigned i ) const

Return a Constant for a specified index's element.

Note that this has to compute a new constant to return, so it isn't as efficient as getElementAsInteger/Float/Double.

Definition at line 2761 of file Constants.cpp.

References llvm::ConstantInt::get(), llvm::ConstantFP::get(), and llvm::Value::getContext().

Referenced by getNegativeIsTrueBoolVec().

◆ getElementAsDouble()

double ConstantDataSequential::getElementAsDouble ( unsigned i ) const

If this is an sequential container of doubles, return the specified element as a double.

Definition at line 2755 of file Constants.cpp.

References assert().

Referenced by llvm::ExecutionEngine::getConstantValue(), and llvm::log2().

◆ getElementAsFloat()

float ConstantDataSequential::getElementAsFloat ( unsigned i ) const

If this is an sequential container of floats, return the specified element as a float.

Definition at line 2749 of file Constants.cpp.

References assert().

Referenced by llvm::ExecutionEngine::getConstantValue(), and llvm::log2().

◆ getElementAsInteger()

uint64_t ConstantDataSequential::getElementAsInteger ( unsigned i ) const

If this is a sequential container of integers (of any size), return the specified element in the low bits of a uint64_t.

Definition at line 2680 of file Constants.cpp.

References assert(), and llvm_unreachable.

Referenced by canTransformToMemCmp(), emitGlobalConstantDataSequential(), emitSignedInt64(), llvm::ExecutionEngine::getConstantValue(), GetStringLengthH(), and llvm::ConstantDataArraySlice::operator[]().

◆ getElementByteSize()

uint64_t ConstantDataSequential::getElementByteSize ( ) const

Return the size (in bytes) of each element in the array/vector.

The size of the elements is known to be a multiple of one byte.

Definition at line 2451 of file Constants.cpp.

References assert().

Referenced by emitGlobalConstantDataSequential().

◆ getElementType()

Type * ConstantDataSequential::getElementType ( ) const

Return the element type of the array/vector.

Definition at line 2421 of file Constants.cpp.

References llvm::Value::getType().

Referenced by emitGlobalConstantDataSequential(), llvm::ExecutionEngine::getConstantValue(), and getNegativeIsTrueBoolVec().

◆ getImpl()

Constant * ConstantDataSequential::getImpl	(	StringRef	Elements,
		Type *	Ty
	)

staticprotected

This is the underlying implementation of all of the ConstantDataSequential::get methods.

They all thunk down to here, providing the correct element type. We take the bytes in as a StringRef because we want an underlying "char*" to avoid TBAA type punning violations.

StringMap bucket, linked up by their Next pointers. Walk the list.

Definition at line 2474 of file Constants.cpp.

References assert(), llvm::LLVMContextImpl::CDSConstants, llvm::ConstantAggregateZero::get(), llvm::Type::getContext(), llvm::Type::getSequentialElementType(), isAllZeros(), and llvm::LLVMContext::pImpl.