LLVM: llvm::StructType Class Reference (original) (raw)

Class to represent struct types. More...

#include "[llvm/IR/DerivedTypes.h](DerivedTypes%5F8h%5Fsource.html)"

Public Types
using	element_iterator = Type::subtype_iterator
Public Types inherited from llvm::Type
enum	TypeID { HalfTyID = 0 , BFloatTyID, FloatTyID, DoubleTyID, X86_FP80TyID, FP128TyID, PPC_FP128TyID, VoidTyID, LabelTyID, MetadataTyID, X86_AMXTyID, TokenTyID, IntegerTyID, FunctionTyID, PointerTyID, StructTyID, ArrayTyID, FixedVectorTyID, ScalableVectorTyID, TypedPointerTyID, TargetExtTyID }
	Definitions of all of the base types for the Type system. More...
using	subtype_iterator = Type * const *
using	subtype_reverse_iterator = std::reverse_iterator<subtype_iterator>

Public Member Functions
	StructType (const StructType &)=delete
StructType &	operator= (const StructType &)=delete
bool	isPacked () const
bool	isLiteral () const
	Return true if this type is uniqued by structural equivalence, false if it is a struct definition.
bool	isOpaque () const
	Return true if this is a type with an identity that has no body specified yet.
LLVM_ABI bool	isSized (SmallPtrSetImpl< Type * > *Visited=nullptr) const
	isSized - Return true if this is a sized type.
LLVM_ABI bool	isScalableTy (SmallPtrSetImpl< const Type * > &Visited) const
	Returns true if this struct contains a scalable vector.
LLVM_ABI bool	containsNonGlobalTargetExtType (SmallPtrSetImpl< const Type * > &Visited) const
	Return true if this type is or contains a target extension type that disallows being used as a global.
LLVM_ABI bool	containsNonLocalTargetExtType (SmallPtrSetImpl< const Type * > &Visited) const
	Return true if this type is or contains a target extension type that disallows being used as a local.
LLVM_ABI bool	containsHomogeneousScalableVectorTypes () const
	Returns true if this struct contains homogeneous scalable vector types.
LLVM_ABI bool	containsHomogeneousTypes () const
	Return true if this struct is non-empty and all element types are the same.
bool	hasName () const
	Return true if this is a named struct that has a non-empty name.
LLVM_ABI StringRef	getName () const
	Return the name for this struct type if it has an identity.
LLVM_ABI void	setName (StringRef Name)
	Change the name of this type to the specified name, or to a name with a suffix if there is a collision.
LLVM_ABI void	setBody (ArrayRef< Type * > Elements, bool isPacked=false)
	Specify a body for an opaque identified type, which must not make the type recursive.
LLVM_ABI Error	setBodyOrError (ArrayRef< Type * > Elements, bool isPacked=false)
	Specify a body for an opaque identified type or return an error if it would make the type recursive.
LLVM_ABI Error	checkBody (ArrayRef< Type * > Elements)
	Return an error if the body for an opaque identified type would make it recursive.
element_iterator	element_begin () const
element_iterator	element_end () const
ArrayRef< Type * >	elements () const
LLVM_ABI bool	isLayoutIdentical (StructType *Other) const
	Return true if this is layout identical to the specified struct.
unsigned	getNumElements () const
	Random access to the elements.
Type *	getElementType (unsigned N) const
LLVM_ABI Type *	getTypeAtIndex (const Value *V) const
	Given an index value into the type, return the type of the element.
Type *	getTypeAtIndex (unsigned N) const
LLVM_ABI bool	indexValid (const Value *V) const
bool	indexValid (unsigned Idx) const
LLVM_ABI bool	isScalableTy () const
LLVM_ABI bool	containsNonGlobalTargetExtType () const
LLVM_ABI bool	containsNonLocalTargetExtType () const
Public Member Functions inherited from llvm::Type
LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
	Print the current type.
LLVM_ABI void	dump () const
LLVMContext &	getContext () const
	Return the LLVMContext in which this type was uniqued.
TypeID	getTypeID () const
	Return the type id for the type.
bool	isVoidTy () const
	Return true if this is 'void'.
bool	isHalfTy () const
	Return true if this is 'half', a 16-bit IEEE fp type.
bool	isBFloatTy () const
	Return true if this is 'bfloat', a 16-bit bfloat type.
bool	is16bitFPTy () const
	Return true if this is a 16-bit float type.
bool	isFloatTy () const
	Return true if this is 'float', a 32-bit IEEE fp type.
bool	isDoubleTy () const
	Return true if this is 'double', a 64-bit IEEE fp type.
bool	isX86_FP80Ty () const
	Return true if this is x86 long double.
bool	isFP128Ty () const
	Return true if this is 'fp128'.
bool	isPPC_FP128Ty () const
	Return true if this is powerpc long double.
bool	isIEEELikeFPTy () const
	Return true if this is a well-behaved IEEE-like type, which has a IEEE compatible layout, and does not have non-IEEE values, such as x86_fp80's unnormal values.
bool	isFloatingPointTy () const
	Return true if this is one of the floating-point types.
bool	isMultiUnitFPType () const
	Returns true if this is a floating-point type that is an unevaluated sum of multiple floating-point units.
LLVM_ABI const fltSemantics &	getFltSemantics () const
bool	isX86_AMXTy () const
	Return true if this is X86 AMX.
bool	isTargetExtTy () const
	Return true if this is a target extension type.
LLVM_ABI bool	isScalableTargetExtTy () const
	Return true if this is a target extension type with a scalable layout.
LLVM_ABI bool	isScalableTy (SmallPtrSetImpl< const Type * > &Visited) const
	Return true if this is a type whose size is a known multiple of vscale.
LLVM_ABI bool	isScalableTy () const
LLVM_ABI bool	containsNonGlobalTargetExtType (SmallPtrSetImpl< const Type * > &Visited) const
	Return true if this type is or contains a target extension type that disallows being used as a global.
LLVM_ABI bool	containsNonGlobalTargetExtType () const
LLVM_ABI bool	containsNonLocalTargetExtType (SmallPtrSetImpl< const Type * > &Visited) const
	Return true if this type is or contains a target extension type that disallows being used as a local.
LLVM_ABI bool	containsNonLocalTargetExtType () const
bool	isFPOrFPVectorTy () const
	Return true if this is a FP type or a vector of FP.
bool	isLabelTy () const
	Return true if this is 'label'.
bool	isMetadataTy () const
	Return true if this is 'metadata'.
bool	isTokenTy () const
	Return true if this is 'token'.
bool	isTokenLikeTy () const
	Returns true if this is 'token' or a token-like target type.s.
bool	isIntegerTy () const
	True if this is an instance of IntegerType.
LLVM_ABI bool	isIntegerTy (unsigned Bitwidth) const
	Return true if this is an IntegerType of the given width.
bool	isIntOrIntVectorTy () const
	Return true if this is an integer type or a vector of integer types.
bool	isIntOrIntVectorTy (unsigned BitWidth) const
	Return true if this is an integer type or a vector of integer types of the given width.
bool	isIntOrPtrTy () const
	Return true if this is an integer type or a pointer type.
bool	isFunctionTy () const
	True if this is an instance of FunctionType.
bool	isStructTy () const
	True if this is an instance of StructType.
bool	isArrayTy () const
	True if this is an instance of ArrayType.
bool	isPointerTy () const
	True if this is an instance of PointerType.
bool	isPtrOrPtrVectorTy () const
	Return true if this is a pointer type or a vector of pointer types.
bool	isVectorTy () const
	True if this is an instance of VectorType.
LLVM_ABI bool	isRISCVVectorTupleTy () const
LLVM_ABI bool	canLosslesslyBitCastTo (Type *Ty) const
	Return true if this type could be converted with a lossless BitCast to type 'Ty'.
LLVM_ABI bool	isEmptyTy () const
	Return true if this type is empty, that is, it has no elements or all of its elements are empty.
LLVM_ABI bool	isFirstClassType () const
	Return true if the type is "first class", meaning it is a valid type for a Value.
bool	isSingleValueType () const
	Return true if the type is a valid type for a register in codegen.
bool	isAggregateType () const
	Return true if the type is an aggregate type.
bool	isSized (SmallPtrSetImpl< Type * > *Visited=nullptr) const
	Return true if it makes sense to take the size of this type.
LLVM_ABI TypeSize	getPrimitiveSizeInBits () const LLVM_READONLY
	Return the basic size of this type if it is a primitive type.
LLVM_ABI unsigned	getScalarSizeInBits () const LLVM_READONLY
	If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
LLVM_ABI int	getFPMantissaWidth () const
	Return the width of the mantissa of this type.
Type *	getScalarType () const
	If this is a vector type, return the element type, otherwise return 'this'.
subtype_iterator	subtype_begin () const
subtype_iterator	subtype_end () const
ArrayRef< Type * >	subtypes () const
subtype_reverse_iterator	subtype_rbegin () const
subtype_reverse_iterator	subtype_rend () const
Type *	getContainedType (unsigned i) const
	This method is used to implement the type iterator (defined at the end of the file).
unsigned	getNumContainedTypes () const
	Return the number of types in the derived type.
LLVM_ABI unsigned	getIntegerBitWidth () const
LLVM_ABI Type *	getFunctionParamType (unsigned i) const
LLVM_ABI unsigned	getFunctionNumParams () const
LLVM_ABI bool	isFunctionVarArg () const
LLVM_ABI StringRef	getStructName () const
LLVM_ABI unsigned	getStructNumElements () const
LLVM_ABI Type *	getStructElementType (unsigned N) const
LLVM_ABI uint64_t	getArrayNumElements () const
Type *	getArrayElementType () const
LLVM_ABI StringRef	getTargetExtName () const
LLVM_ABI Type *	getWithNewType (Type *EltTy) const
	Given vector type, change the element type, whilst keeping the old number of elements.
LLVM_ABI Type *	getWithNewBitWidth (unsigned NewBitWidth) const
	Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes.
LLVM_ABI Type *	getExtendedType () const
	Given scalar/vector integer type, returns a type with elements twice as wide as in the original type.
LLVM_ABI unsigned	getPointerAddressSpace () const
	Get the address space of this pointer or pointer vector type.
LLVM_ABI	LLVM_DEPRECATED ("Use PointerType::get instead", "PointerType::get") PointerType *getPointerTo(unsigned AddrSpace=0) const
	Return a pointer to the current type.

Static Public Member Functions
static LLVM_ABI StructType *	create (LLVMContext &Context, StringRef Name)
	This creates an identified struct.
static LLVM_ABI StructType *	create (LLVMContext &Context)
static LLVM_ABI StructType *	create (ArrayRef< Type * > Elements, StringRef Name, bool isPacked=false)
static LLVM_ABI StructType *	create (ArrayRef< Type * > Elements)
static LLVM_ABI StructType *	create (LLVMContext &Context, ArrayRef< Type * > Elements, StringRef Name, bool isPacked=false)
static LLVM_ABI StructType *	create (LLVMContext &Context, ArrayRef< Type * > Elements)
template<class... Tys>
static std::enable_if_t< are_base_of< Type, Tys... >::value, StructType * >	create (StringRef Name, Type elt1, Tys ... elts)
static LLVM_ABI StructType *	get (LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
	This static method is the primary way to create a literal StructType.
static LLVM_ABI StructType *	get (LLVMContext &Context, bool isPacked=false)
	Create an empty structure type.
template<class... Tys>
static std::enable_if_t< are_base_of< Type, Tys... >::value, StructType * >	get (Type elt1, Tys ... elts)
	This static method is a convenience method for creating structure types by specifying the elements as arguments.
static LLVM_ABI StructType *	getTypeByName (LLVMContext &C, StringRef Name)
	Return the type with the specified name, or null if there is none by that name.
static LLVM_ABI bool	isValidElementType (Type *ElemTy)
	Return true if the specified type is valid as a element type.
static bool	classof (const Type *T)
	Methods for support type inquiry through isa, cast, and dyn_cast.
Static Public Member Functions inherited from llvm::Type
static LLVM_ABI Type *	getPrimitiveType (LLVMContext &C, TypeID IDNumber)
	Return a type based on an identifier.
static LLVM_ABI Type *	getVoidTy (LLVMContext &C)
static LLVM_ABI Type *	getLabelTy (LLVMContext &C)
static LLVM_ABI Type *	getHalfTy (LLVMContext &C)
static LLVM_ABI Type *	getBFloatTy (LLVMContext &C)
static LLVM_ABI Type *	getFloatTy (LLVMContext &C)
static LLVM_ABI Type *	getDoubleTy (LLVMContext &C)
static LLVM_ABI Type *	getMetadataTy (LLVMContext &C)
static LLVM_ABI Type *	getX86_FP80Ty (LLVMContext &C)
static LLVM_ABI Type *	getFP128Ty (LLVMContext &C)
static LLVM_ABI Type *	getPPC_FP128Ty (LLVMContext &C)
static LLVM_ABI Type *	getX86_AMXTy (LLVMContext &C)
static LLVM_ABI Type *	getTokenTy (LLVMContext &C)
static LLVM_ABI IntegerType *	getIntNTy (LLVMContext &C, unsigned N)
static LLVM_ABI IntegerType *	getInt1Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt8Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt16Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt32Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt64Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt128Ty (LLVMContext &C)
template
static Type *	getScalarTy (LLVMContext &C)
static LLVM_ABI Type *	getFloatingPointTy (LLVMContext &C, const fltSemantics &S)
static LLVM_ABI Type *	getWasm_ExternrefTy (LLVMContext &C)
static LLVM_ABI Type *	getWasm_FuncrefTy (LLVMContext &C)

Additional Inherited Members
Protected Member Functions inherited from llvm::Type
	Type (LLVMContext &C, TypeID tid)
	~Type ()=default
unsigned	getSubclassData () const
void	setSubclassData (unsigned val)
Protected Attributes inherited from llvm::Type
unsigned	NumContainedTys = 0
	Keeps track of how many Type*'s there are in the ContainedTys list.
Type const	ContainedTys = nullptr
	A pointer to the array of Types contained by this Type.

Class to represent struct types.

There are two different kinds of struct types: Literal structs and Identified structs.

Literal struct types (e.g. { i32, i32 }) are uniqued structurally, and must always have a body when created. You can get one of these by using one of the StructType::get() forms.

Identified structs (e.g. foo or %42) may optionally have a name and are not uniqued. The names for identified structs are managed at the LLVMContext level, so there can only be a single identified struct with a given name in a particular LLVMContext. Identified structs may also optionally be opaque (have no body specified). You get one of these by using one of the StructType::create() forms.

Independent of what kind of struct you have, the body of a struct type are laid out in memory consecutively with the elements directly one after the other (if the struct is packed) or (if not packed) with padding between the elements as defined by DataLayout (which is required to match what the code generator for a target expects).

Definition at line 218 of file DerivedTypes.h.

◆ element_iterator

◆ checkBody()

Return an error if the body for an opaque identified type would make it recursive.

Definition at line 556 of file Type.cpp.

◆ classof()

◆ containsHomogeneousScalableVectorTypes()

bool StructType::containsHomogeneousScalableVectorTypes	(	)	const

Returns true if this struct contains homogeneous scalable vector types.

Note that the definition of homogeneous scalable vector type is not recursive here. That means the following structure will return false when calling this function. {{<vscale x 2 x i32>, <vscale x 4 x i64>}, {<vscale x 2 x i32>, <vscale x 4 x i64>}}

Definition at line 523 of file Type.cpp.

◆ containsHomogeneousTypes()

bool StructType::containsHomogeneousTypes	(	)	const

Return true if this struct is non-empty and all element types are the same.

Definition at line 529 of file Type.cpp.

◆ containsNonGlobalTargetExtType() [1/2]

bool Type::containsNonGlobalTargetExtType	(	)	const

◆ containsNonGlobalTargetExtType() [2/2]

Return true if this type is or contains a target extension type that disallows being used as a global.

Definition at line 467 of file Type.cpp.

◆ containsNonLocalTargetExtType() [1/2]

bool Type::containsNonLocalTargetExtType	(	)	const

◆ containsNonLocalTargetExtType() [2/2]

Return true if this type is or contains a target extension type that disallows being used as a local.

Definition at line 495 of file Type.cpp.

◆ create() [1/7]

◆ create() [2/7]

◆ create() [3/7]

◆ create() [4/7]

◆ create() [5/7]

◆ create() [6/7]

This creates an identified struct.

Definition at line 619 of file Type.cpp.

Referenced by addEmuTlsVar(), create(), llvm::dxil::ResourceTypeInfo::createElementStruct(), createTaskWithPrivatesTy(), llvm::orc::IRSpeculationLayer::emit(), getBinaryWithCarryType(), llvm::offloading::getEntryTy(), getOrCreateElementStruct(), getOrCreateStructType(), llvm::SPIRVGlobalRegistry::getOrCreateVulkanBufferType(), getResBindType(), getResPropsType(), getSplitDoubleType(), llvm::BasicTTIImplBase< BasicTTIImpl >::getTypeBasedIntrinsicInstrCost(), LLVMStructCreateNamed(), and llvm::reconstitutePeeledArrayType().

◆ create() [7/7]

◆ element_begin()

element_iterator llvm::StructType::element_begin ( ) const	inline

◆ element_end()

element_iterator llvm::StructType::element_end ( ) const	inline

◆ elements()

ArrayRef< Type * > llvm::StructType::elements ( ) const	inline

◆ get() [1/3]

This static method is the primary way to create a literal StructType.

Definition at line 413 of file Type.cpp.

Referenced by llvm::memtag::alignAndPadAlloca(), appendToGlobalArray(), classifyConstantWithOpaquePtr(), createAtomicLibcall(), createRawLoad(), createTypedBufferLoad(), createTypedBufferStore(), DecodeFixedType(), llvm::emitHotColdSizeReturningNew(), llvm::emitHotColdSizeReturningNewAligned(), expandBufferLoadIntrinsic(), expandBufferStoreIntrinsic(), llvm::sandboxir::StructType::get(), get(), llvm::ConstantExpr::getAlignOf(), llvm::RTLIB::RuntimeLibcallsInfo::getFunctionTy(), llvm::ConstantStruct::getTypeForElements(), getTypePartition(), getTypeWithoutPadding(), insertSinCosCall(), isValidProtoForSizeReturningNew(), llvm::ARMLegalizerInfo::legalizeCustom(), LLVMStructTypeInContext(), llvm::RISCVTargetLowering::lowerDeinterleaveIntrinsicToLoad(), lowerSubFn(), llvm::EscapeEnumerator::Next(), llvm::reconstitutePeeledArrayType(), llvm::WasmEHPreparePass::run(), llvm::toScalarizedStructTy(), llvm::toVectorizedStructTy(), and llvm::UpgradeGlobalVariable().

◆ get() [2/3]

Create an empty structure type.

Definition at line 626 of file Type.cpp.

◆ get() [3/3]

◆ getElementType()

Type * llvm::StructType::getElementType ( unsigned N) const	inline

Definition at line 369 of file DerivedTypes.h.

References assert(), llvm::Type::ContainedTys, N, llvm::Type::NumContainedTys, and llvm::Type::Type().

Referenced by buildFrameDebugInfo(), BuildSubAggregate(), llvm::FunctionComparator::cmpTypes(), getTypeAtIndex(), getTypePartition(), insertSpills(), isDenselyPacked(), and llvm::UpgradeGlobalVariable().

◆ getName()

Return the name for this struct type if it has an identity.

This may return an empty string for an unnamed struct type. Do not call this on an literal type.

Definition at line 696 of file Type.cpp.

Referenced by llvm::BTFDebug::endModule().

◆ getNumElements()

unsigned llvm::StructType::getNumElements ( ) const	inline

◆ getTypeAtIndex() [1/2]

◆ getTypeAtIndex() [2/2]

Type * llvm::StructType::getTypeAtIndex ( unsigned N) const	inline

◆ getTypeByName()

◆ hasName()

bool llvm::StructType::hasName ( ) const	inline

Return true if this is a named struct that has a non-empty name.

Definition at line 328 of file DerivedTypes.h.

◆ indexValid() [1/2]

◆ indexValid() [2/2]

bool llvm::StructType::indexValid ( unsigned Idx) const	inline

◆ isLayoutIdentical()

Return true if this is layout identical to the specified struct.

Definition at line 709 of file Type.cpp.

◆ isLiteral()

bool llvm::StructType::isLiteral ( ) const	inline

◆ isOpaque()

bool llvm::StructType::isOpaque ( ) const	inline

◆ isPacked()

bool llvm::StructType::isPacked ( ) const	inline

◆ isScalableTy() [1/2]

bool Type::isScalableTy	(	)	const

◆ isScalableTy() [2/2]

Returns true if this struct contains a scalable vector.

Definition at line 440 of file Type.cpp.

◆ isSized()

isSized - Return true if this is a sized type.

Definition at line 658 of file Type.cpp.

◆ isValidElementType()

bool StructType::isValidElementType ( Type * ElemTy)	static

Return true if the specified type is valid as a element type.

Definition at line 703 of file Type.cpp.

◆ operator=()

◆ setBody()

Specify a body for an opaque identified type, which must not make the type recursive.

Definition at line 534 of file Type.cpp.

◆ setBodyOrError()

Specify a body for an opaque identified type or return an error if it would make the type recursive.

Definition at line 538 of file Type.cpp.

◆ setName()

Change the name of this type to the specified name, or to a name with a suffix if there is a collision.

Do not call this on an literal type.

Definition at line 568 of file Type.cpp.

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

include/llvm/IR/DerivedTypes.h
lib/SandboxIR/Type.cpp