Class to represent struct types. More...
#include "llvm/IR/DerivedTypes.h"
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 (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 |
| 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. | |
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. | |
Detailed Description
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.
Member Typedef Documentation
◆ element_iterator
Definition at line 356 of file DerivedTypes.h.
Constructor & Destructor Documentation
◆ StructType()
|
delete |
Member Function Documentation
◆ checkBody()
◆ classof()
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition at line 380 of file DerivedTypes.h.
References llvm::Type::StructTyID.
◆ 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>}}
◆ containsHomogeneousTypes()
| bool StructType::containsHomogeneousTypes | ( | ) | const |
◆ containsNonGlobalTargetExtType() [1/3]
◆ containsNonGlobalTargetExtType() [2/3]
| bool StructType::containsNonGlobalTargetExtType | ( | SmallPtrSetImpl< const Type * > & | Visited | ) | const |
◆ containsNonGlobalTargetExtType() [3/3]
| LLVM_ABI bool llvm::Type::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.
◆ containsNonLocalTargetExtType() [1/3]
◆ containsNonLocalTargetExtType() [2/3]
| bool StructType::containsNonLocalTargetExtType | ( | SmallPtrSetImpl< const Type * > & | Visited | ) | const |
◆ containsNonLocalTargetExtType() [3/3]
| LLVM_ABI bool llvm::Type::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.
◆ create() [1/7]
|
static |
◆ create() [2/7]
|
static |
◆ create() [3/7]
|
static |
◆ create() [4/7]
|
static |
◆ create() [5/7]
|
static |
◆ create() [6/7]
|
static |
This creates an identified struct.
Definition at line 620 of file Type.cpp.
Referenced by addEmuTlsVar(), create(), llvm::dxil::ResourceTypeInfo::createElementStruct(), llvm::OpenMPIRBuilder::createReductionsGPU(), createTaskWithPrivatesTy(), llvm::orc::IRSpeculationLayer::emit(), llvm::OpenMPIRBuilder::emitNonContiguousDescriptor(), getBinaryWithCarryType(), llvm::offloading::getEntryTy(), getOrCreateElementStruct(), getOrCreateStructType(), llvm::SPIRVGlobalRegistry::getOrCreateVulkanBufferType(), getResBindType(), getResPropsType(), getSplitDoubleType(), llvm::BasicTTIImplBase< T >::getTypeBasedIntrinsicInstrCost(), and LLVMStructCreateNamed().
◆ create() [7/7]
|
inlinestatic |
Definition at line 259 of file DerivedTypes.h.
◆ element_begin()
|
inline |
Definition at line 358 of file DerivedTypes.h.
References llvm::Type::ContainedTys.
Referenced by elements(), and getTypePartition().
◆ element_end()
|
inline |
Definition at line 359 of file DerivedTypes.h.
References llvm::Type::ContainedTys, and llvm::Type::NumContainedTys.
Referenced by elements(), and getTypePartition().
◆ elements()
Definition at line 360 of file DerivedTypes.h.
References element_begin(), and element_end().
Referenced by llvm::canVectorizeStructTy(), llvm::dxil::ResourceTypeInfo::createElementStruct(), findFuncPointers(), isLeakCheckerRoot(), llvm::isVectorizedStructTy(), LLVMGetStructElementTypes(), llvm::toScalarizedStructTy(), and llvm::toVectorizedStructTy().
◆ get() [1/3]
|
static |
This static method is the primary way to create a literal StructType.
Definition at line 414 of file Type.cpp.
Referenced by llvm::memtag::alignAndPadAlloca(), appendToGlobalArray(), classifyConstantWithOpaquePtr(), createAtomicLibcall(), createRawLoad(), llvm::OpenMPIRBuilder::createTask(), createTypedBufferLoad(), createTypedBufferStore(), DecodeFixedType(), llvm::emitHotColdSizeReturningNew(), llvm::emitHotColdSizeReturningNewAligned(), expandBufferLoadIntrinsic(), expandBufferStoreIntrinsic(), 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(), and llvm::UpgradeGlobalVariable().
◆ get() [2/3]
|
static |
◆ get() [3/3]
|
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 line 276 of file DerivedTypes.h.
References assert(), get(), and llvm::Type::getContext().
◆ getElementType()
Definition at line 369 of file DerivedTypes.h.
References assert(), llvm::Type::ContainedTys, N, and llvm::Type::NumContainedTys.
Referenced by buildFrameDebugInfo(), BuildSubAggregate(), llvm::FunctionComparator::cmpTypes(), llvm::OpenMPIRBuilder::emitTargetTask(), llvm::coro::Shape::getIndexType(), getOrCreateElementStruct(), llvm::coro::Shape::getSwitchResumePointerType(), getTypeAtIndex(), getTypePartition(), insertSpills(), isDenselyPacked(), and llvm::UpgradeGlobalVariable().
◆ getName()
| 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 line 697 of file Type.cpp.
Referenced by llvm::BTFDebug::endModule().
◆ getNumElements()
|
inline |
Random access to the elements.
Definition at line 368 of file DerivedTypes.h.
References llvm::Type::NumContainedTys.
Referenced by appendToGlobalArray(), buildFrameDebugInfo(), BuildSubAggregate(), llvm::FunctionComparator::cmpTypes(), emitGlobalConstantImpl(), getOrCreateElementStruct(), llvm::DataLayout::getStructLayout(), indexValid(), isDenselyPacked(), llvm::SCCPInstVisitor::isStructLatticeConstant(), llvm::UpgradeGlobalVariable(), and llvm::InlineAsm::verify().
◆ getTypeAtIndex() [1/2]
Given an index value into the type, return the type of the element.
Definition at line 719 of file Type.cpp.
Referenced by LLVMStructGetTypeAtIndex(), and markCoroutineAsDone().
◆ getTypeAtIndex() [2/2]
Definition at line 375 of file DerivedTypes.h.
References getElementType(), and N.
◆ getTypeByName()
|
static |
Return the type with the specified name, or null if there is none by that name.
Definition at line 739 of file Type.cpp.
Referenced by getBinaryWithCarryType(), llvm::offloading::getEntryTy(), getOrCreateElementStruct(), getOrCreateStructType(), getResBindType(), getResPropsType(), getSplitDoubleType(), LLVMGetTypeByName(), and LLVMGetTypeByName2().
◆ hasName()
|
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]
Definition at line 377 of file DerivedTypes.h.
References getNumElements(), and Idx.
◆ isLayoutIdentical()
| bool StructType::isLayoutIdentical | ( | StructType * | Other | ) | const |
◆ isLiteral()
|
inline |
Return true if this type is uniqued by structural equivalence, false if it is a struct definition.
Definition at line 290 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by llvm::isUnpackedStructLiteral().
◆ isOpaque()
|
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 line 294 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by llvm::IRMover::IdentifiedStructTypeSet::addNonOpaque(), llvm::IRMover::IdentifiedStructTypeSet::addOpaque(), llvm::IRMover::IdentifiedStructTypeSet::hasType(), isLeakCheckerRoot(), and llvm::IRMover::IdentifiedStructTypeSet::switchToNonOpaque().
◆ isPacked()
|
inline |
Definition at line 286 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by llvm::FunctionComparator::cmpTypes(), getTypePartition(), and llvm::isUnpackedStructLiteral().
◆ isScalableTy() [1/3]
◆ isScalableTy() [2/3]
| bool StructType::isScalableTy | ( | SmallPtrSetImpl< const Type * > & | Visited | ) | const |
◆ isScalableTy() [3/3]
| LLVM_ABI bool llvm::Type::isScalableTy | ( | SmallPtrSetImpl< const Type * > & | Visited | ) | const |
Return true if this is a type whose size is a known multiple of vscale.
◆ isSized()
| bool StructType::isSized | ( | SmallPtrSetImpl< Type * > * | Visited = nullptr | ) | const |
◆ isValidElementType()
◆ operator=()
|
delete |
◆ setBody()
◆ setBodyOrError()
◆ setName()
| void StructType::setName | ( | StringRef | Name | ) |
The documentation for this class was generated from the following files:
- include/llvm/IR/DerivedTypes.h
- lib/SandboxIR/Type.cpp
