LLVM 20.0.0git |
Class to represent struct types.More...
#include "llvm/IR/DerivedTypes.h"
Public Types | |
using | element_iterator =Type::subtype_iterator |
![]() | |
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 theType system.More... | |
using | subtype_iterator =Type *const * |
using | subtype_reverse_iterator = std::reverse_iterator<subtype_iterator > |
Public Member Functions | |
StructType (constStructType &)=delete | |
StructType & | operator= (constStructType &)=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. | |
bool | isSized (SmallPtrSetImpl<Type * > *Visited=nullptr)const |
isSized - Return true if this is a sized type. | |
bool | isScalableTy (SmallPtrSetImpl<constType * > &Visited)const |
Returns true if this struct contains a scalable vector. | |
bool | containsNonGlobalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a global. | |
bool | containsNonLocalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a local. | |
bool | containsHomogeneousScalableVectorTypes ()const |
Returns true if this struct contains homogeneous scalable vector types. | |
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. | |
StringRef | getName ()const |
Return the name for this struct type if it has an identity. | |
void | setName (StringRefName) |
Change the name of this type to the specified name, or to a name with a suffix if there is a collision. | |
void | setBody (ArrayRef<Type * > Elements,boolisPacked=false) |
Specify a body for an opaque identified type, which must not make the type recursive. | |
Error | setBodyOrError (ArrayRef<Type * > Elements,boolisPacked=false) |
Specify a body for an opaque identified type or return an error if it would make the type recursive. | |
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 |
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 (unsignedN)const |
Type * | getTypeAtIndex (constValue *V)const |
Given an index value into the type, return the type of the element. | |
Type * | getTypeAtIndex (unsignedN)const |
bool | indexValid (constValue *V)const |
bool | indexValid (unsignedIdx)const |
bool | isScalableTy (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this is a type whose size is a known multiple of vscale. | |
bool | isScalableTy ()const |
bool | containsNonGlobalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a global. | |
bool | containsNonGlobalTargetExtType ()const |
bool | containsNonLocalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a local. | |
bool | containsNonLocalTargetExtType ()const |
![]() | |
void | print (raw_ostream &O,bool IsForDebug=false,bool NoDetails=false)const |
Print the current type. | |
void | dump ()const |
LLVMContext & | getContext ()const |
Return theLLVMContext 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 as defined byAPFloat::isIEEE(), 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. | |
constfltSemantics & | getFltSemantics ()const |
bool | isX86_AMXTy ()const |
Return true if this isX86 AMX. | |
bool | isTargetExtTy ()const |
Return true if this is a target extension type. | |
bool | isScalableTargetExtTy ()const |
Return true if this is a target extension type with a scalable layout. | |
bool | isScalableTy (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this is a type whose size is a known multiple of vscale. | |
bool | isScalableTy ()const |
bool | containsNonGlobalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a global. | |
bool | containsNonGlobalTargetExtType ()const |
bool | containsNonLocalTargetExtType (SmallPtrSetImpl<constType * > &Visited)const |
Return true if this type is or contains a target extension type that disallows being used as a local. | |
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 | isIntegerTy ()const |
True if this is an instance ofIntegerType. | |
bool | isIntegerTy (unsigned Bitwidth)const |
Return true if this is anIntegerType of the given width. | |
bool | isIntOrIntVectorTy ()const |
Return true if this is an integer type or a vector of integer types. | |
bool | isIntOrIntVectorTy (unsignedBitWidth)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 ofFunctionType. | |
bool | isStructTy ()const |
True if this is an instance ofStructType. | |
bool | isArrayTy ()const |
True if this is an instance ofArrayType. | |
bool | isPointerTy ()const |
True if this is an instance ofPointerType. | |
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 ofVectorType. | |
bool | isRISCVVectorTupleTy ()const |
bool | canLosslesslyBitCastTo (Type *Ty)const |
Return true if this type could be converted with a lossless BitCast to type 'Ty'. | |
bool | isEmptyTy ()const |
Return true if this type is empty, that is, it has no elements or all of its elements are empty. | |
bool | isFirstClassType ()const |
Return true if the type is "first class", meaning it is a valid type for aValue. | |
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. | |
TypeSize | getPrimitiveSizeInBits ()constLLVM_READONLY |
Return the basic size of this type if it is a primitive type. | |
unsigned | getScalarSizeInBits ()constLLVM_READONLY |
If this is a vector type, return the getPrimitiveSizeInBits value for the element type. | |
int | getFPMantissaWidth ()const |
Return the width of the mantissa of this type. | |
bool | isIEEE ()const |
Return whether the type is IEEE compatible, as defined by the eponymous method inAPFloat. | |
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. | |
unsigned | getIntegerBitWidth ()const |
Type * | getFunctionParamType (unsigned i)const |
unsigned | getFunctionNumParams ()const |
bool | isFunctionVarArg ()const |
StringRef | getStructName ()const |
unsigned | getStructNumElements ()const |
Type * | getStructElementType (unsignedN)const |
uint64_t | getArrayNumElements ()const |
Type * | getArrayElementType ()const |
StringRef | getTargetExtName ()const |
Type * | getWithNewType (Type *EltTy)const |
Given vector type, change the element type, whilst keeping the old number of elements. | |
Type * | getWithNewBitWidth (unsigned NewBitWidth)const |
Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes. | |
Type * | getExtendedType ()const |
Given scalar/vector integer type, returns a type with elements twice as wide as in the original type. | |
unsigned | getPointerAddressSpace ()const |
Get the address space of this pointer or pointer vector type. | |
PointerType * | getPointerTo (unsigned AddrSpace=0)const |
Return a pointer to the current type. | |
Static Public Member Functions | |
staticStructType * | create (LLVMContext &Context,StringRefName) |
This creates an identified struct. | |
staticStructType * | create (LLVMContext &Context) |
staticStructType * | create (ArrayRef<Type * > Elements,StringRefName,boolisPacked=false) |
staticStructType * | create (ArrayRef<Type * > Elements) |
staticStructType * | create (LLVMContext &Context,ArrayRef<Type * > Elements,StringRefName,boolisPacked=false) |
staticStructType * | create (LLVMContext &Context,ArrayRef<Type * > Elements) |
template<class... Tys> | |
static std::enable_if_t<are_base_of<Type, Tys... >::value,StructType * > | create (StringRefName,Type *elt1, Tys *... elts) |
staticStructType * | get (LLVMContext &Context,ArrayRef<Type * > Elements,boolisPacked=false) |
This static method is the primary way to create a literalStructType. | |
staticStructType * | get (LLVMContext &Context,boolisPacked=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. | |
staticStructType * | getTypeByName (LLVMContext &C,StringRefName) |
Return the type with the specified name, or null if there is none by that name. | |
staticbool | isValidElementType (Type *ElemTy) |
Return true if the specified type is valid as a element type. | |
staticbool | classof (constType *T) |
Methods for support type inquiry through isa, cast, and dyn_cast. | |
![]() | |
staticType * | getPrimitiveType (LLVMContext &C,TypeID IDNumber) |
Return a type based on an identifier. | |
staticType * | getVoidTy (LLVMContext &C) |
staticType * | getLabelTy (LLVMContext &C) |
staticType * | getHalfTy (LLVMContext &C) |
staticType * | getBFloatTy (LLVMContext &C) |
staticType * | getFloatTy (LLVMContext &C) |
staticType * | getDoubleTy (LLVMContext &C) |
staticType * | getMetadataTy (LLVMContext &C) |
staticType * | getX86_FP80Ty (LLVMContext &C) |
staticType * | getFP128Ty (LLVMContext &C) |
staticType * | getPPC_FP128Ty (LLVMContext &C) |
staticType * | getX86_AMXTy (LLVMContext &C) |
staticType * | getTokenTy (LLVMContext &C) |
staticIntegerType * | getIntNTy (LLVMContext &C,unsignedN) |
staticIntegerType * | getInt1Ty (LLVMContext &C) |
staticIntegerType * | getInt8Ty (LLVMContext &C) |
staticIntegerType * | getInt16Ty (LLVMContext &C) |
staticIntegerType * | getInt32Ty (LLVMContext &C) |
staticIntegerType * | getInt64Ty (LLVMContext &C) |
staticIntegerType * | getInt128Ty (LLVMContext &C) |
template<typename ScalarTy > | |
staticType * | getScalarTy (LLVMContext &C) |
staticType * | getFloatingPointTy (LLVMContext &C,constfltSemantics &S) |
staticType * | getWasm_ExternrefTy (LLVMContext &C) |
staticType * | getWasm_FuncrefTy (LLVMContext &C) |
Additional Inherited Members | |
![]() | |
Type (LLVMContext &C,TypeID tid) | |
~Type ()=default | |
unsigned | getSubclassData ()const |
void | setSubclassData (unsigned val) |
![]() | |
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 thisType. | |
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 theStructType::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 theLLVMContext level, so there can only be a single identified struct with a given name in a particularLLVMContext. Identified structs may also optionally be opaque (have no body specified). You get one of these by using one of theStructType::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 byDataLayout (which is required to match what the code generator for a target expects).
Definition at line218 of fileDerivedTypes.h.
Definition at line353 of fileDerivedTypes.h.
| delete |
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition at line377 of fileDerivedTypes.h.
Referencesllvm::Type::StructTyID.
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>}}
bool StructType::containsHomogeneousTypes | ( | ) | const |
bool llvm::Type::containsNonGlobalTargetExtType | ( | ) | const |
bool StructType::containsNonGlobalTargetExtType | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
bool llvm::Type::containsNonGlobalTargetExtType | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
Return true if this type is or contains a target extension type that disallows being used as a global.
bool llvm::Type::containsNonLocalTargetExtType | ( | ) | const |
bool StructType::containsNonLocalTargetExtType | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
bool llvm::Type::containsNonLocalTargetExtType | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
Return true if this type is or contains a target extension type that disallows being used as a local.
| static |
| static |
| static |
| static |
| static |
| static |
This creates an identified struct.
Definition at line612 of fileType.cpp.
Referenced byaddEmuTlsVar(),create(),llvm::dxil::ResourceTypeInfo::createElementStruct(),llvm::OpenMPIRBuilder::createReductionsGPU(),llvm::orc::IRSpeculationLayer::emit(),llvm::OpenMPIRBuilder::emitNonContiguousDescriptor(),llvm::offloading::getEntryTy(),getOrCreateStructType(),getResBindType(),getResPropsType(),getSplitDoubleType(),llvm::BasicTTIImplBase< T >::getTypeBasedIntrinsicInstrCost(), andLLVMStructCreateNamed().
| inlinestatic |
Definition at line257 of fileDerivedTypes.h.
| inline |
Definition at line355 of fileDerivedTypes.h.
Referencesllvm::Type::ContainedTys.
Referenced byelements(), andgetTypePartition().
| inline |
Definition at line356 of fileDerivedTypes.h.
Referencesllvm::Type::ContainedTys, andllvm::Type::NumContainedTys.
Referenced byelements(), andgetTypePartition().
Definition at line357 of fileDerivedTypes.h.
Referenceselement_begin(), andelement_end().
Referenced byllvm::canVectorizeStructTy(),findFuncPointers(),isLeakCheckerRoot(),llvm::isVectorizedStructTy(),LLVMGetStructElementTypes(),llvm::toScalarizedStructTy(), andllvm::toVectorizedStructTy().
| static |
This static method is the primary way to create a literalStructType.
Definition at line406 of fileType.cpp.
Referenced byllvm::memtag::alignAndPadAlloca(),appendToGlobalArray(),classifyConstantWithOpaquePtr(),createAtomicLibcall(),createRawLoad(),llvm::OpenMPIRBuilder::createTask(),createTypedBufferLoad(),createTypedBufferStore(),DecodeFixedType(),llvm::emitHotColdSizeReturningNew(),llvm::emitHotColdSizeReturningNewAligned(),llvm::sandboxir::StructType::get(),get(),llvm::ConstantExpr::getAlignOf(),llvm::ConstantStruct::getTypeForElements(),getTypePartition(),insertSinCosCall(),isValidProtoForSizeReturningNew(),llvm::ARMLegalizerInfo::legalizeCustom(),LLVMStructTypeInContext(),llvm::RISCVTargetLowering::lowerDeinterleaveIntrinsicToLoad(),LowerFSINCOS(),lowerSubFn(),llvm::EscapeEnumerator::Next(),llvm::WasmEHPreparePass::run(),llvm::toScalarizedStructTy(),llvm::toVectorizedStructTy(), andllvm::UpgradeGlobalVariable().
| static |
| inlinestatic |
This static method is a convenience method for creating structure types by specifying the elements as arguments.
Note that this method always returns a non-packed struct, and requires at least one element type.
Definition at line274 of fileDerivedTypes.h.
Referencesassert(),get(), andllvm::Type::getContext().
Definition at line366 of fileDerivedTypes.h.
Referencesassert(),llvm::Type::ContainedTys,N, andllvm::Type::NumContainedTys.
Referenced bybuildFrameDebugInfo(),BuildSubAggregate(),llvm::FunctionComparator::cmpTypes(),llvm::coro::Shape::getIndexType(),llvm::coro::Shape::getSwitchResumePointerType(),getTypeAtIndex(),getTypePartition(),insertSpills(),isDenselyPacked(), andllvm::UpgradeGlobalVariable().
StringRef StructType::getName | ( | ) | const |
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 line689 of fileType.cpp.
Referenced byllvm::BTFDebug::endModule().
| inline |
Random access to the elements.
Definition at line365 of fileDerivedTypes.h.
Referencesllvm::Type::NumContainedTys.
Referenced byappendToGlobalArray(),buildFrameDebugInfo(),BuildSubAggregate(),llvm::FunctionComparator::cmpTypes(),emitGlobalConstantImpl(),llvm::DataLayout::getStructLayout(),indexValid(),isDenselyPacked(),llvm::SCCPInstVisitor::isStructLatticeConstant(),llvm::UpgradeGlobalVariable(), andllvm::InlineAsm::verify().
Given an index value into the type, return the type of the element.
Definition at line711 of fileType.cpp.
Referenced byLLVMStructGetTypeAtIndex(), andmarkCoroutineAsDone().
Definition at line372 of fileDerivedTypes.h.
ReferencesgetElementType(), andN.
| static |
Return the type with the specified name, or null if there is none by that name.
Definition at line731 of fileType.cpp.
Referenced byllvm::offloading::getEntryTy(),getOrCreateStructType(),getResBindType(),getResPropsType(),getSplitDoubleType(),LLVMGetTypeByName(), andLLVMGetTypeByName2().
| inline |
Return true if this is a named struct that has a non-empty name.
Definition at line326 of fileDerivedTypes.h.
Definition at line374 of fileDerivedTypes.h.
ReferencesgetNumElements(), andIdx.
bool StructType::isLayoutIdentical | ( | StructType * | Other | ) | const |
| inline |
Return true if this type is uniqued by structural equivalence, false if it is a struct definition.
Definition at line288 of fileDerivedTypes.h.
Referencesllvm::Type::getSubclassData().
Referenced byllvm::isUnpackedStructLiteral().
| inline |
Return true if this is a type with an identity that has no body specified yet.
These prints as 'opaque' in .ll files.
Definition at line292 of fileDerivedTypes.h.
Referencesllvm::Type::getSubclassData().
Referenced byllvm::IRMover::IdentifiedStructTypeSet::addNonOpaque(),llvm::IRMover::IdentifiedStructTypeSet::addOpaque(),llvm::IRMover::IdentifiedStructTypeSet::hasType(),isLeakCheckerRoot(), andllvm::IRMover::IdentifiedStructTypeSet::switchToNonOpaque().
| inline |
Definition at line284 of fileDerivedTypes.h.
Referencesllvm::Type::getSubclassData().
Referenced byllvm::FunctionComparator::cmpTypes(),getTypePartition(), andllvm::isUnpackedStructLiteral().
bool llvm::Type::isScalableTy | ( | ) | const |
bool StructType::isScalableTy | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
bool llvm::Type::isScalableTy | ( | SmallPtrSetImpl<constType * > & | Visited | ) | const |
Return true if this is a type whose size is a known multiple of vscale.
bool StructType::isSized | ( | SmallPtrSetImpl<Type * > * | Visited =nullptr | ) | const |
| delete |
void StructType::setName | ( | StringRef | Name | ) |