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 { VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID, X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID, MetadataTyID, X86_MMXTyID, TokenTyID, IntegerTyID, FunctionTyID, StructTyID, ArrayTyID, PointerTyID, VectorTyID } |
| 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. More... | |
| bool | isOpaque () const |
| Return true if this is a type with an identity that has no body specified yet. More... | |
| bool | isSized (SmallPtrSetImpl< Type *> *Visited=nullptr) const |
| isSized - Return true if this is a sized type. More... | |
| bool | hasName () const |
| Return true if this is a named struct that has a non-empty name. More... | |
| StringRef | getName () const |
| Return the name for this struct type if it has an identity. More... | |
| 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. More... | |
| void | setBody (ArrayRef< Type *> Elements, bool isPacked=false) |
| Specify a body for an opaque identified type. More... | |
| template<typename... Tys> | |
| std::enable_if< are_base_of< Type, Tys... >::value, void >::type | setBody (Type *elt1, Tys *... elts) |
| element_iterator | element_begin () const |
| element_iterator | element_end () const |
| ArrayRef< Type * > const | elements () const |
| bool | isLayoutIdentical (StructType *Other) const |
| Return true if this is layout identical to the specified struct. More... | |
| unsigned | getNumElements () const |
| Random access to the elements. More... | |
| Type * | getElementType (unsigned N) const |
| Public Member Functions inherited from llvm::CompositeType | |
| Type * | getTypeAtIndex (const Value *V) const |
| Given an index value into the type, return the type of the element. More... | |
| Type * | getTypeAtIndex (unsigned Idx) const |
| bool | indexValid (const Value *V) const |
| bool | indexValid (unsigned Idx) const |
| Public Member Functions inherited from llvm::Type | |
| void | print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const |
| Print the current type. More... | |
| void | dump () const |
| LLVMContext & | getContext () const |
| Return the LLVMContext in which this type was uniqued. More... | |
| TypeID | getTypeID () const |
| Return the type id for the type. More... | |
| bool | isVoidTy () const |
| Return true if this is 'void'. More... | |
| bool | isHalfTy () const |
| Return true if this is 'half', a 16-bit IEEE fp type. More... | |
| bool | isFloatTy () const |
| Return true if this is 'float', a 32-bit IEEE fp type. More... | |
| bool | isDoubleTy () const |
| Return true if this is 'double', a 64-bit IEEE fp type. More... | |
| bool | isX86_FP80Ty () const |
| Return true if this is x86 long double. More... | |
| bool | isFP128Ty () const |
| Return true if this is 'fp128'. More... | |
| bool | isPPC_FP128Ty () const |
| Return true if this is powerpc long double. More... | |
| bool | isFloatingPointTy () const |
| Return true if this is one of the six floating-point types. More... | |
| const fltSemantics & | getFltSemantics () const |
| bool | isX86_MMXTy () const |
| Return true if this is X86 MMX. More... | |
| bool | isFPOrFPVectorTy () const |
| Return true if this is a FP type or a vector of FP. More... | |
| bool | isLabelTy () const |
| Return true if this is 'label'. More... | |
| bool | isMetadataTy () const |
| Return true if this is 'metadata'. More... | |
| bool | isTokenTy () const |
| Return true if this is 'token'. More... | |
| bool | isIntegerTy () const |
| True if this is an instance of IntegerType. More... | |
| bool | isIntegerTy (unsigned Bitwidth) const |
| Return true if this is an IntegerType of the given width. More... | |
| bool | isIntOrIntVectorTy () const |
| Return true if this is an integer type or a vector of integer types. More... | |
| bool | isIntOrIntVectorTy (unsigned BitWidth) const |
| Return true if this is an integer type or a vector of integer types of the given width. More... | |
| bool | isIntOrPtrTy () const |
| Return true if this is an integer type or a pointer type. More... | |
| bool | isFunctionTy () const |
| True if this is an instance of FunctionType. More... | |
| bool | isStructTy () const |
| True if this is an instance of StructType. More... | |
| bool | isArrayTy () const |
| True if this is an instance of ArrayType. More... | |
| bool | isPointerTy () const |
| True if this is an instance of PointerType. More... | |
| bool | isPtrOrPtrVectorTy () const |
| Return true if this is a pointer type or a vector of pointer types. More... | |
| bool | isVectorTy () const |
| True if this is an instance of VectorType. More... | |
| bool | canLosslesslyBitCastTo (Type *Ty) const |
| Return true if this type could be converted with a lossless BitCast to type 'Ty'. More... | |
| bool | isEmptyTy () const |
| Return true if this type is empty, that is, it has no elements or all of its elements are empty. More... | |
| bool | isFirstClassType () const |
| Return true if the type is "first class", meaning it is a valid type for a Value. More... | |
| bool | isSingleValueType () const |
| Return true if the type is a valid type for a register in codegen. More... | |
| bool | isAggregateType () const |
| Return true if the type is an aggregate type. More... | |
| bool | isSized (SmallPtrSetImpl< Type *> *Visited=nullptr) const |
| Return true if it makes sense to take the size of this type. More... | |
| unsigned | getPrimitiveSizeInBits () const LLVM_READONLY |
| Return the basic size of this type if it is a primitive type. More... | |
| unsigned | getScalarSizeInBits () const LLVM_READONLY |
| If this is a vector type, return the getPrimitiveSizeInBits value for the element type. More... | |
| int | getFPMantissaWidth () const |
| Return the width of the mantissa of this type. More... | |
| Type * | getScalarType () const |
| If this is a vector type, return the element type, otherwise return 'this'. More... | |
| 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). More... | |
| unsigned | getNumContainedTypes () const |
| Return the number of types in the derived type. More... | |
| unsigned | getIntegerBitWidth () const |
| Type * | getFunctionParamType (unsigned i) const |
| unsigned | getFunctionNumParams () const |
| bool | isFunctionVarArg () const |
| StringRef | getStructName () const |
| unsigned | getStructNumElements () const |
| Type * | getStructElementType (unsigned N) const |
| Type * | getSequentialElementType () const |
| uint64_t | getArrayNumElements () const |
| Type * | getArrayElementType () const |
| unsigned | getVectorNumElements () const |
| Type * | getVectorElementType () const |
| Type * | getPointerElementType () const |
| unsigned | getPointerAddressSpace () const |
| Get the address space of this pointer or pointer vector type. More... | |
| PointerType * | getPointerTo (unsigned AddrSpace=0) const |
| Return a pointer to the current type. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from llvm::CompositeType | |
| CompositeType (LLVMContext &C, TypeID tid) | |
| Protected Member Functions inherited from llvm::Type | |
| Type (LLVMContext &C, TypeID tid) | |
| ~Type ()=default | |
| unsigned | getSubclassData () const |
| void | setSubclassData (unsigned val) |
| Static Protected Member Functions inherited from llvm::Type | |
| static bool | isSequentialType (TypeID TyID) |
| Protected Attributes inherited from llvm::Type | |
| unsigned | NumContainedTys = 0 |
| Keeps track of how many Type*'s there are in the ContainedTys list. More... | |
| Type *const * | ContainedTys = nullptr |
| A pointer to the array of Types contained by this Type. More... | |
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 201 of file DerivedTypes.h.
Member Typedef Documentation
◆ element_iterator
Definition at line 301 of file DerivedTypes.h.
Constructor & Destructor Documentation
◆ StructType()
|
delete |
Member Function Documentation
◆ classof()
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition at line 320 of file DerivedTypes.h.
References llvm::Type::getTypeID(), and llvm::Type::StructTyID.
◆ create() [1/7]
|
static |
This creates an identified struct.
Definition at line 437 of file Type.cpp.
References llvm::StringRef::empty(), llvm::LLVMContext::pImpl, setName(), llvm::ARM_MB::ST, and llvm::LLVMContextImpl::TypeAllocator.
Referenced by buildFrameType(), llvm::createShadowStackGCLoweringPass(), getIntrinsicParamType(), INITIALIZE_PASS(), LLVMStructCreateNamed(), parseOptionalLinkageAux(), shouldKeepInEntry(), and upgradeDLLImportExportLinkage().
◆ create() [2/7]
|
static |
◆ create() [3/7]
|
static |
Definition at line 463 of file Type.cpp.
References assert(), llvm::ArrayRef< T >::empty(), and llvm::Type::getContext().
◆ create() [4/7]
|
static |
Definition at line 470 of file Type.cpp.
References assert(), llvm::ArrayRef< T >::empty(), and llvm::Type::getContext().
◆ create() [5/7]
|
static |
Definition at line 448 of file Type.cpp.
References setBody(), and llvm::ARM_MB::ST.
◆ create() [6/7]
|
static |
◆ create() [7/7]
|
inlinestatic |
Definition at line 235 of file DerivedTypes.h.
References assert(), and llvm::Type::Type().
◆ element_begin()
|
inline |
Definition at line 303 of file DerivedTypes.h.
References llvm::Type::ContainedTys.
Referenced by doPromotion(), getAttrKindEncoding(), getTypePartition(), isLeakCheckerRoot(), LLVMGetStructElementTypes(), and llvm::StackProtector::runOnFunction().
◆ element_end()
|
inline |
Definition at line 304 of file DerivedTypes.h.
References llvm::Type::ContainedTys, and llvm::Type::NumContainedTys.
Referenced by doPromotion(), getAttrKindEncoding(), getTypePartition(), isLeakCheckerRoot(), LLVMGetStructElementTypes(), and llvm::StackProtector::runOnFunction().
◆ elements()
Definition at line 305 of file DerivedTypes.h.
References llvm::makeArrayRef(), and Other.
Referenced by isLayoutIdentical(), and llvm::HexagonTargetObjectFile::shouldPutJumpTableInFunctionSection().
◆ get() [1/3]
|
static |
This static method is the primary way to create a literal StructType.
Definition at line 342 of file Type.cpp.
References llvm::LLVMContextImpl::AnonStructTypes, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert_as(), llvm::LLVMContext::pImpl, setBody(), llvm::Type::setSubclassData(), llvm::ARM_MB::ST, and llvm::LLVMContextImpl::TypeAllocator.
Referenced by appendToGlobalArray(), llvm::createEfficiencySanitizerPass(), createPrivateNonConstGlobalForString(), DecodeFixedType(), llvm::CodeExtractor::findInputsOutputs(), get(), llvm::ConstantExpr::getAlignOf(), getArrayElements(), getDivRemArgList(), getRetComponentType(), llvm::AVRTargetLowering::getSetCCResultType(), llvm::ConstantStruct::getTypeForElements(), getTypePartition(), INITIALIZE_PASS(), insertSinCosCall(), instrumentMaskedLoadOrStore(), llvm::ARMLegalizerInfo::legalizeCustom(), LLVMStructTypeInContext(), LowerADDSUBCARRY(), LowerFSINCOS(), lowerSubFn(), LowerVectorINT_TO_FP(), needsRuntimeRegistrationOfSectionRange(), llvm::EscapeEnumerator::Next(), parseOptionalLinkageAux(), RetagMask(), llvm::SanitizerStatReport::SanitizerStatReport(), TypeSizeToSizeIndex(), and wrapConstantAsMetadata().
◆ 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 254 of file DerivedTypes.h.
References assert(), get(), and llvm::Type::getContext().
◆ getElementType()
Definition at line 314 of file DerivedTypes.h.
References assert(), llvm::Type::ContainedTys, N, and llvm::Type::NumContainedTys.
Referenced by BuildSubAggregate(), llvm::FunctionComparator::cmpTypes(), llvm::createEfficiencySanitizerPass(), llvm::coro::Shape::getIndexType(), getNaturalGEPRecursively(), llvm::AArch64TTIImpl::getOrCreateResultFromMemIntrinsic(), getTypePartition(), isDenselyPacked(), llvm::Intrinsic::matchIntrinsicType(), PerformHeapAllocSRoA(), PropagateConstantReturn(), and whichFPReturnVariant().
◆ 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 500 of file Type.cpp.
References assert().
Referenced by llvm::createEfficiencySanitizerPass(), doPromotion(), getAttrKindEncoding(), LLVMGetStructName(), PrintLLVMName(), and StripTypeNames().
◆ getNumElements()
|
inline |
Random access to the elements.
Definition at line 313 of file DerivedTypes.h.
References llvm::Type::NumContainedTys.
Referenced by appendToGlobalArray(), BuildSubAggregate(), llvm::FunctionComparator::cmpTypes(), llvm::createEfficiencySanitizerPass(), doPromotion(), llvm::AsmPrinter::EmitSpecialLLVMGlobal(), forEachUser(), llvm::ConstantStruct::get(), llvm::AArch64TTIImpl::getOrCreateResultFromMemIntrinsic(), llvm::DataLayout::getStructLayout(), llvm::ConstantStruct::getTypeForElements(), INITIALIZE_PASS(), isDenselyPacked(), llvm::Intrinsic::matchIntrinsicType(), PerformHeapAllocSRoA(), PropagateConstantReturn(), llvm::HexagonTargetObjectFile::shouldPutJumpTableInFunctionSection(), tryToOptimizeStoreOfMallocToGlobal(), llvm::InlineAsm::Verify(), and whichFPReturnVariant().
◆ hasName()
|
inline |
Return true if this is a named struct that has a non-empty name.
Definition at line 275 of file DerivedTypes.h.
References getName(), and llvm::Type::Type().
Referenced by llvm::createEfficiencySanitizerPass(), and LLVMGetStructName().
◆ isLayoutIdentical()
| bool StructType::isLayoutIdentical | ( | StructType * | Other | ) | const |
Return true if this is layout identical to the specified struct.
Definition at line 513 of file Type.cpp.
References elements(), and isPacked().
◆ isLiteral()
|
inline |
Return true if this type is uniqued by structural equivalence, false if it is a struct definition.
Definition at line 265 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by llvm::createEfficiencySanitizerPass(), getAttrKindEncoding(), false::operator<<(), PrintLLVMName(), and StripTypeNames().
◆ 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 269 of file DerivedTypes.h.
References llvm::Type::getSubclassData(), and llvm::Type::isSized().
Referenced by llvm::IRMover::IdentifiedStructTypeSet::addNonOpaque(), llvm::IRMover::IdentifiedStructTypeSet::addOpaque(), llvm::createEfficiencySanitizerPass(), llvm::ConstantStruct::get(), getAttrKindEncoding(), llvm::ConstantStruct::getTypeForElements(), llvm::IRMover::IdentifiedStructTypeSet::hasType(), isLeakCheckerRoot(), and llvm::IRMover::IdentifiedStructTypeSet::switchToNonOpaque().
◆ isPacked()
|
inline |
Definition at line 261 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by llvm::FunctionComparator::cmpTypes(), getAttrKindEncoding(), getTypePartition(), and isLayoutIdentical().
◆ isSized()
| bool StructType::isSized | ( | SmallPtrSetImpl< Type *> * | Visited = nullptr | ) | const |
isSized - Return true if this is a sized type.
Definition at line 476 of file Type.cpp.
References E, llvm::Type::getSubclassData(), I, llvm::SmallPtrSetImpl< PtrType >::insert(), and llvm::Type::setSubclassData().
◆ isValidElementType()
Return true if the specified type is valid as a element type.
Definition at line 507 of file Type.cpp.
References llvm::Type::isFunctionTy(), llvm::Type::isLabelTy(), llvm::Type::isMetadataTy(), llvm::Type::isTokenTy(), and llvm::Type::isVoidTy().
Referenced by parseOptionalLinkageAux().
◆ operator=()
|
delete |
◆ setBody() [1/2]
Specify a body for an opaque identified type.
Definition at line 369 of file Type.cpp.
References assert(), llvm::Type::ContainedTys, llvm::ArrayRef< T >::copy(), llvm::ArrayRef< T >::empty(), llvm::Type::getContext(), llvm::Type::getSubclassData(), llvm::Type::NumContainedTys, llvm::Type::setSubclassData(), and llvm::ArrayRef< T >::size().
Referenced by buildFrameType(), create(), llvm::createShadowStackGCLoweringPass(), get(), and parseOptionalLinkageAux().
◆ setBody() [2/2]
|
inline |
Definition at line 291 of file DerivedTypes.h.
References assert(), and isValidElementType().
◆ setName()
| void StructType::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.
Do not call this on an literal type.
Definition at line 386 of file Type.cpp.
References llvm::StringRef::empty(), llvm::StringMap< ValueTy, AllocatorTy >::getAllocator(), llvm::Type::getContext(), getName(), llvm::LLVMContextImpl::NamedStructTypes, llvm::LLVMContextImpl::NamedStructTypesUniqueID, llvm::COFF::NameSize, llvm::LLVMContext::pImpl, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::StringMap< ValueTy, AllocatorTy >::remove(), llvm::SmallVectorImpl< T >::resize(), llvm::StringRef::size(), and llvm::raw_svector_ostream::str().
Referenced by create(), and StripTypeNames().
The documentation for this class was generated from the following files:
- include/llvm/IR/DerivedTypes.h
- lib/IR/Type.cpp
