LLVM  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::StructType Class Reference

Class to represent struct types. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::StructType:
Inheritance graph
[legend]
Collaboration diagram for llvm::StructType:
Collaboration graph
[legend]

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_MMXTyID, X86_AMXTyID,
  TokenTyID, IntegerTyID, FunctionTyID, PointerTyID,
  StructTyID, ArrayTyID, FixedVectorTyID, ScalableVectorTyID
}
 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
 
StructTypeoperator= (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 containsScalableVectorType () const
 Returns true if this struct contains a scalable vector. 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_t< are_base_of< Type, Tys... >::value, void > setBody (Type *elt1, Tys *... elts)
 
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. More...
 
unsigned getNumElements () const
 Random access to the elements. More...
 
TypegetElementType (unsigned N) const
 
TypegetTypeAtIndex (const Value *V) const
 Given an index value into the type, return the type of the element. More...
 
TypegetTypeAtIndex (unsigned N) 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
 
LLVMContextgetContext () 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 isBFloatTy () const
 Return true if this is 'bfloat', a 16-bit bfloat 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 fltSemanticsgetFltSemantics () const
 
bool isX86_MMXTy () const
 Return true if this is X86 MMX. More...
 
bool isX86_AMXTy () const
 Return true if this is X86 AMX. 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 isOpaquePointerTy () const
 True if this is an instance of an opaque 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...
 
TypeSize 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...
 
bool isIEEE () const
 Return whether the type is IEEE compatible, as defined by the eponymous method in APFloat. More...
 
TypegetScalarType () 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
 
TypegetContainedType (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
 
TypegetFunctionParamType (unsigned i) const
 
unsigned getFunctionNumParams () const
 
bool isFunctionVarArg () const
 
StringRef getStructName () const
 
unsigned getStructNumElements () const
 
TypegetStructElementType (unsigned N) const
 
uint64_t getArrayNumElements () const
 
TypegetArrayElementType () const
 
TypegetPointerElementType () const
 
TypegetWithNewType (Type *EltTy) const
 Given vector type, change the element type, whilst keeping the old number of elements. More...
 
TypegetWithNewBitWidth (unsigned NewBitWidth) const
 Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes. More...
 
TypegetExtendedType () const
 Given scalar/vector integer type, returns a type with elements twice as wide as in the original type. More...
 
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
 
PointerTypegetPointerTo (unsigned AddrSpace=0) const
 Return a pointer to the current type. More...
 

Static Public Member Functions

static StructTypecreate (LLVMContext &Context, StringRef Name)
 This creates an identified struct. More...
 
static StructTypecreate (LLVMContext &Context)
 
static StructTypecreate (ArrayRef< Type * > Elements, StringRef Name, bool isPacked=false)
 
static StructTypecreate (ArrayRef< Type * > Elements)
 
static StructTypecreate (LLVMContext &Context, ArrayRef< Type * > Elements, StringRef Name, bool isPacked=false)
 
static StructTypecreate (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 StructTypeget (LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
 This static method is the primary way to create a literal StructType. More...
 
static StructTypeget (LLVMContext &Context, bool isPacked=false)
 Create an empty structure type. More...
 
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. More...
 
static StructTypegetTypeByName (LLVMContext &C, StringRef Name)
 Return the type with the specified name, or null if there is none by that name. More...
 
static bool isValidElementType (Type *ElemTy)
 Return true if the specified type is valid as a element type. More...
 
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::Type
static TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 Return a type based on an identifier. More...
 
static TypegetVoidTy (LLVMContext &C)
 
static TypegetLabelTy (LLVMContext &C)
 
static TypegetHalfTy (LLVMContext &C)
 
static TypegetBFloatTy (LLVMContext &C)
 
static TypegetFloatTy (LLVMContext &C)
 
static TypegetDoubleTy (LLVMContext &C)
 
static TypegetMetadataTy (LLVMContext &C)
 
static TypegetX86_FP80Ty (LLVMContext &C)
 
static TypegetFP128Ty (LLVMContext &C)
 
static TypegetPPC_FP128Ty (LLVMContext &C)
 
static TypegetX86_MMXTy (LLVMContext &C)
 
static TypegetX86_AMXTy (LLVMContext &C)
 
static TypegetTokenTy (LLVMContext &C)
 
static IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
 
static IntegerTypegetInt1Ty (LLVMContext &C)
 
static IntegerTypegetInt8Ty (LLVMContext &C)
 
static IntegerTypegetInt16Ty (LLVMContext &C)
 
static IntegerTypegetInt32Ty (LLVMContext &C)
 
static IntegerTypegetInt64Ty (LLVMContext &C)
 
static IntegerTypegetInt128Ty (LLVMContext &C)
 
template<typename ScalarTy >
static TypegetScalarTy (LLVMContext &C)
 
static TypegetFloatingPointTy (LLVMContext &C, const fltSemantics &S)
 
static PointerTypegetHalfPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetBFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetDoublePtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_AMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
 
static PointerTypegetInt1PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt8PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt16PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt32PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt64PtrTy (LLVMContext &C, unsigned AS=0)
 

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. More...
 
Type *constContainedTys = 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 213 of file DerivedTypes.h.

Member Typedef Documentation

◆ element_iterator

Definition at line 315 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ StructType()

llvm::StructType::StructType ( const StructType )
delete

Member Function Documentation

◆ classof()

static bool llvm::StructType::classof ( const Type T)
inlinestatic

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

Definition at line 339 of file DerivedTypes.h.

References llvm::Type::StructTyID, and T.

◆ containsScalableVectorType()

bool StructType::containsScalableVectorType ( ) const

Returns true if this struct contains a scalable vector.

Definition at line 435 of file Type.cpp.

References elements().

◆ create() [1/7]

StructType * StructType::create ( ArrayRef< Type * >  Elements)
static

Definition at line 548 of file Type.cpp.

References assert(), create(), llvm::ArrayRef< T >::empty(), and llvm::Type::getContext().

◆ create() [2/7]

StructType * StructType::create ( ArrayRef< Type * >  Elements,
StringRef  Name,
bool  isPacked = false 
)
static

◆ create() [3/7]

StructType * StructType::create ( LLVMContext Context)
static

Definition at line 537 of file Type.cpp.

References Context, and create().

◆ create() [4/7]

StructType * StructType::create ( LLVMContext Context,
ArrayRef< Type * >  Elements 
)
static

Definition at line 533 of file Type.cpp.

References Context, and create().

◆ create() [5/7]

StructType * StructType::create ( LLVMContext Context,
ArrayRef< Type * >  Elements,
StringRef  Name,
bool  isPacked = false 
)
static

Definition at line 526 of file Type.cpp.

References Context, create(), isPacked(), and llvm::ARM_MB::ST.

◆ create() [6/7]

StructType * StructType::create ( LLVMContext Context,
StringRef  Name 
)
static

◆ create() [7/7]

template<class... Tys>
static std::enable_if_t<are_base_of<Type, Tys...>::value, StructType *> llvm::StructType::create ( StringRef  Name,
Type elt1,
Tys *...  elts 
)
inlinestatic

Definition at line 246 of file DerivedTypes.h.

References assert(), and create().

◆ element_begin()

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

Definition at line 317 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by elements(), getTypePartition(), and isLeakCheckerRoot().

◆ element_end()

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

◆ elements()

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

◆ get() [1/3]

StructType * StructType::get ( LLVMContext Context,
ArrayRef< Type * >  Elements,
bool  isPacked = false 
)
static

◆ get() [2/3]

StructType * StructType::get ( LLVMContext Context,
bool  isPacked = false 
)
static

Create an empty structure type.

Definition at line 522 of file Type.cpp.

References Context, get(), isPacked(), and llvm::None.

◆ get() [3/3]

template<class... Tys>
static std::enable_if_t<are_base_of<Type, Tys...>::value, StructType *> llvm::StructType::get ( Type elt1,
Tys *...  elts 
)
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 263 of file DerivedTypes.h.

References assert(), get(), and llvm::Type::getContext().

◆ getElementType()

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

◆ 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 583 of file Type.cpp.

References assert(), and isLiteral().

Referenced by llvm::BTFDebug::endModule(), setName(), and StripTypeNames().

◆ getNumElements()

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

◆ getTypeAtIndex() [1/2]

Type * StructType::getTypeAtIndex ( const Value V) const

Given an index value into the type, return the type of the element.

Definition at line 605 of file Type.cpp.

References assert(), getElementType(), and indexValid().

Referenced by LLVMStructGetTypeAtIndex().

◆ getTypeAtIndex() [2/2]

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

Definition at line 334 of file DerivedTypes.h.

References getElementType(), and N.

◆ getTypeByName()

StructType * StructType::getTypeByName ( LLVMContext C,
StringRef  Name 
)
static

Return the type with the specified name, or null if there is none by that name.

Definition at line 625 of file Type.cpp.

Referenced by LLVMGetTypeByName(), and LLVMGetTypeByName2().

◆ hasName()

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

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

Definition at line 290 of file DerivedTypes.h.

◆ indexValid() [1/2]

bool StructType::indexValid ( const Value V) const

◆ indexValid() [2/2]

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

Definition at line 336 of file DerivedTypes.h.

References getNumElements().

◆ isLayoutIdentical()

bool StructType::isLayoutIdentical ( StructType Other) const

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

Definition at line 596 of file Type.cpp.

References elements(), isPacked(), and Other.

◆ isLiteral()

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

Return true if this type is uniqued by structural equivalence, false if it is a struct definition.

Definition at line 277 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by getName(), false::operator<<(), llvm::Type::print(), and StripTypeNames().

◆ isOpaque()

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

◆ isPacked()

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

◆ isSized()

bool StructType::isSized ( SmallPtrSetImpl< Type * > *  Visited = nullptr) const

isSized - Return true if this is a sized type.

Definition at line 554 of file Type.cpp.

References elements(), llvm::Type::getSubclassData(), llvm::SmallPtrSetImpl< PtrType >::insert(), isOpaque(), and llvm::Type::setSubclassData().

◆ isValidElementType()

bool StructType::isValidElementType ( Type ElemTy)
static

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

Definition at line 590 of file Type.cpp.

References llvm::Type::isFunctionTy(), llvm::Type::isLabelTy(), llvm::Type::isMetadataTy(), llvm::Type::isTokenTy(), and llvm::Type::isVoidTy().

◆ operator=()

StructType& llvm::StructType::operator= ( const StructType )
delete

◆ setBody() [1/2]

void StructType::setBody ( ArrayRef< Type * >  Elements,
bool  isPacked = false 
)

◆ setBody() [2/2]

template<typename... Tys>
std::enable_if_t<are_base_of<Type, Tys...>::value, void> llvm::StructType::setBody ( Type elt1,
Tys *...  elts 
)
inline

Definition at line 306 of file DerivedTypes.h.

References assert(), and setBody().

◆ setName()

void StructType::setName ( StringRef  Name)

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