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

Class to represent target extensions types, which are generally unintrospectable from target-independent optimizations. More...

#include "llvm/IR/DerivedTypes.h"

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

Public Types

enum  Property { HasZeroInit = 1U << 0, CanBeGlobal = 1U << 1 }
 
using type_param_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,
  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

 TargetExtType (const TargetExtType &)=delete
 
TargetExtTypeoperator= (const TargetExtType &)=delete
 
StringRef getName () const
 Return the name for this target extension type. More...
 
ArrayRef< Type * > type_params () const
 Return the type parameters for this particular target extension type. More...
 
type_param_iterator type_param_begin () const
 
type_param_iterator type_param_end () const
 
TypegetTypeParameter (unsigned i) const
 
unsigned getNumTypeParameters () const
 
ArrayRef< unsigned > int_params () const
 Return the integer parameters for this particular target extension type. More...
 
unsigned getIntParameter (unsigned i) const
 
unsigned getNumIntParameters () const
 
bool hasProperty (Property Prop) const
 Returns true if the target extension type contains the given property. More...
 
TypegetLayoutType () const
 Returns an underlying layout type for the target extension type. More...
 
- 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 is16bitFPTy () const
 Return true if this is a 16-bit float 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 isIEEELikeFPTy () const
 Return true if this is a well-behaved IEEE-like type, which has a IEEE compatible layout as defined by isIEEE(), and does not have unnormal values. More...
 
bool isFloatingPointTy () const
 Return true if this is one of the floating-point types. More...
 
bool isMultiUnitFPType () const
 Returns true if this is a floating-point type that is an unevaluated sum of multiple floating-point units. 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 isTargetExtTy () const
 Return true if this is a target extension type. 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
 
StringRef getTargetExtName () const
 
TypegetPointerElementType () const
 This method is deprecated without replacement. More...
 
TypegetNonOpaquePointerElementType () const
 Only use this method in code that is not reachable with opaque pointers, or part of deprecated methods that will be removed as part of the opaque pointers transition. More...
 
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 TargetExtTypeget (LLVMContext &Context, StringRef Name, ArrayRef< Type * > Types=std::nullopt, ArrayRef< unsigned > Ints=std::nullopt)
 Return a target extension type having the specified name and optional type and integer parameters. 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 target extensions types, which are generally unintrospectable from target-independent optimizations.

Target extension types have a string name, and optionally have type and/or integer parameters. The exact meaning of any parameters is dependent on the target.

Definition at line 739 of file DerivedTypes.h.

Member Typedef Documentation

◆ type_param_iterator

Definition at line 768 of file DerivedTypes.h.

Member Enumeration Documentation

◆ Property

Enumerator
HasZeroInit 

zeroinitializer is valid for this target extension type.

CanBeGlobal 

This type may be used as the value type of a global variable.

Definition at line 786 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ TargetExtType()

llvm::TargetExtType::TargetExtType ( const TargetExtType )
delete

Member Function Documentation

◆ classof()

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

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

Definition at line 803 of file DerivedTypes.h.

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

◆ get()

TargetExtType * TargetExtType::get ( LLVMContext Context,
StringRef  Name,
ArrayRef< Type * >  Types = std::nullopt,
ArrayRef< unsigned >  Ints = std::nullopt 
)
static

Return a target extension type having the specified name and optional type and integer parameters.

Definition at line 812 of file Type.cpp.

References llvm::ArrayRef< T >::size().

Referenced by LLVMTargetExtTypeInContext().

◆ getIntParameter()

unsigned llvm::TargetExtType::getIntParameter ( unsigned  i) const
inline

Definition at line 783 of file DerivedTypes.h.

References i.

◆ getLayoutType()

Type * TargetExtType::getLayoutType ( ) const

Returns an underlying layout type for the target extension type.

This type can be used to query size and alignment information, if it is appropriate (although note that the layout type may also be void). It is not legal to bitcast between this type and the layout type, however.

Definition at line 860 of file Type.cpp.

References getTargetTypeInfo().

◆ getName()

StringRef llvm::TargetExtType::getName ( ) const
inline

Return the name for this target extension type.

Two distinct target extension types may have the same name if their type or integer parameters differ.

Definition at line 760 of file DerivedTypes.h.

Referenced by getTargetTypeInfo().

◆ getNumIntParameters()

unsigned llvm::TargetExtType::getNumIntParameters ( ) const
inline

Definition at line 784 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by int_params().

◆ getNumTypeParameters()

unsigned llvm::TargetExtType::getNumTypeParameters ( ) const
inline

Definition at line 775 of file DerivedTypes.h.

References llvm::Type::getNumContainedTypes().

◆ getTypeParameter()

Type* llvm::TargetExtType::getTypeParameter ( unsigned  i) const
inline

Definition at line 774 of file DerivedTypes.h.

References llvm::Type::getContainedType(), and i.

◆ hasProperty()

bool TargetExtType::hasProperty ( Property  Prop) const

Returns true if the target extension type contains the given property.

Definition at line 864 of file Type.cpp.

References getTargetTypeInfo().

Referenced by llvm::ConstantTargetNone::get().

◆ int_params()

ArrayRef<unsigned> llvm::TargetExtType::int_params ( ) const
inline

Return the integer parameters for this particular target extension type.

If there are no parameters, an empty array is returned.

Definition at line 779 of file DerivedTypes.h.

References llvm::ArrayRef(), and getNumIntParameters().

◆ operator=()

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

◆ type_param_begin()

type_param_iterator llvm::TargetExtType::type_param_begin ( ) const
inline

Definition at line 769 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by type_params().

◆ type_param_end()

type_param_iterator llvm::TargetExtType::type_param_end ( ) const
inline

Definition at line 770 of file DerivedTypes.h.

References llvm::Type::ContainedTys, and llvm::Type::NumContainedTys.

Referenced by type_params().

◆ type_params()

ArrayRef<Type *> llvm::TargetExtType::type_params ( ) const
inline

Return the type parameters for this particular target extension type.

If there are no parameters, an empty array is returned.

Definition at line 764 of file DerivedTypes.h.

References llvm::ArrayRef(), type_param_begin(), and type_param_end().


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