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:

[legend]

Public Types
enum	Property { HasZeroInit = 1U << 0 , CanBeGlobal = 1U << 1 , CanBeLocal = 1U << 2 , CanBeVectorElement = 1U << 3 , IsTokenLike = 1U << 4 }
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_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
TargetExtType &	operator= (const TargetExtType &)=delete
StringRef	getName () const
	Return the name for this target extension type.
ArrayRef< Type * >	type_params () const
	Return the type parameters for this particular target extension type.
type_param_iterator	type_param_begin () const
type_param_iterator	type_param_end () const
Type *	getTypeParameter (unsigned i) const
unsigned	getNumTypeParameters () const
ArrayRef< unsigned >	int_params () const
	Return the integer parameters for this particular target extension type.
unsigned	getIntParameter (unsigned i) const
unsigned	getNumIntParameters () const
LLVM_ABI bool	hasProperty (Property Prop) const
	Returns true if the target extension type contains the given property.
LLVM_ABI Type *	getLayoutType () const
	Returns an underlying layout type for the target extension type.
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.

Static Public Member Functions
static LLVM_ABI TargetExtType *	get (LLVMContext &Context, StringRef Name, ArrayRef< Type * > Types={}, ArrayRef< unsigned > Ints={})
	Return a target extension type having the specified name and optional type and integer parameters.
static LLVM_ABI Expected< TargetExtType * >	getOrError (LLVMContext &Context, StringRef Name, ArrayRef< Type * > Types={}, ArrayRef< unsigned > Ints={})
	Return a target extension type having the specified name and optional type and integer parameters, or an appropriate Error if it fails the parameters check.
static LLVM_ABI Expected< TargetExtType * >	checkParams (TargetExtType *TTy)
	Check that a newly created target extension type has the expected number of type parameters and integer parameters, returning the type itself if OK or an appropriate Error if not.
static bool	classof (const Type *T)
	Methods for support type inquiry through isa, cast, and dyn_cast.
Static Public Member Functions inherited from llvm::Type
static LLVM_ABI Type *	getPrimitiveType (LLVMContext &C, TypeID IDNumber)
	Return a type based on an identifier.
static LLVM_ABI Type *	getVoidTy (LLVMContext &C)
static LLVM_ABI Type *	getLabelTy (LLVMContext &C)
static LLVM_ABI Type *	getHalfTy (LLVMContext &C)
static LLVM_ABI Type *	getBFloatTy (LLVMContext &C)
static LLVM_ABI Type *	getFloatTy (LLVMContext &C)
static LLVM_ABI Type *	getDoubleTy (LLVMContext &C)
static LLVM_ABI Type *	getMetadataTy (LLVMContext &C)
static LLVM_ABI Type *	getX86_FP80Ty (LLVMContext &C)
static LLVM_ABI Type *	getFP128Ty (LLVMContext &C)
static LLVM_ABI Type *	getPPC_FP128Ty (LLVMContext &C)
static LLVM_ABI Type *	getX86_AMXTy (LLVMContext &C)
static LLVM_ABI Type *	getTokenTy (LLVMContext &C)
static LLVM_ABI IntegerType *	getIntNTy (LLVMContext &C, unsigned N)
static LLVM_ABI IntegerType *	getInt1Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt8Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt16Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt32Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt64Ty (LLVMContext &C)
static LLVM_ABI IntegerType *	getInt128Ty (LLVMContext &C)
template<typename ScalarTy>
static Type *	getScalarTy (LLVMContext &C)
static LLVM_ABI Type *	getFloatingPointTy (LLVMContext &C, const fltSemantics &S)
static LLVM_ABI Type *	getWasm_ExternrefTy (LLVMContext &C)
static LLVM_ABI Type *	getWasm_FuncrefTy (LLVMContext &C)

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 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 783 of file DerivedTypes.h.

Member Typedef Documentation

◆ type_param_iterator

using llvm::TargetExtType::type_param_iterator = Type::subtype_iterator

Definition at line 824 of file DerivedTypes.h.

Member Enumeration Documentation

◆ Property

enum llvm::TargetExtType::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.
CanBeLocal	This type may be allocated on the stack, either as the allocated type of an alloca instruction or as a byval function parameter.
CanBeVectorElement	This type may be used as an element in a vector.
IsTokenLike	In particular, it cannot be used in select and phi instructions.

Definition at line 842 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ TargetExtType()

llvm::TargetExtType::TargetExtType ( const TargetExtType & )

delete

Member Function Documentation

◆ checkParams()

Expected< TargetExtType * > TargetExtType::checkParams ( TargetExtType * TTy )

static

Check that a newly created target extension type has the expected number of type parameters and integer parameters, returning the type itself if OK or an appropriate Error if not.

Definition at line 942 of file Type.cpp.

◆ classof()

bool llvm::TargetExtType::classof ( const Type * T )

inlinestatic

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

Definition at line 867 of file DerivedTypes.h.

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

◆ get()

TargetExtType * TargetExtType::get	(	LLVMContext &	Context,
		StringRef	Name,
		ArrayRef< Type * >	Types = {},
		ArrayRef< unsigned >	Ints = {} )

static

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

Definition at line 908 of file Type.cpp.

Referenced by DecodeFixedType(), llvm::getTypedPointerWrapper(), llvm::EVT::getTypeForEVT(), LLVMTargetExtTypeInContext(), llvm::RISCVTargetLowering::lowerDeinterleaveIntrinsicToLoad(), llvm::RISCVTargetLowering::lowerInterleaveIntrinsicToStore(), llvm::SPIRV::parseBuiltinTypeNameToTargetExtType(), and validateGroupWaitEventsPtr().

◆ getIntParameter()

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

inline

Definition at line 839 of file DerivedTypes.h.

Referenced by llvm::getCoopMatrType(), llvm::dxil::FeedbackTextureExtType::getDimension(), llvm::dxil::MSTextureExtType::getDimension(), llvm::dxil::TextureExtType::getDimension(), llvm::dxil::FeedbackTextureExtType::getFeedbackType(), llvm::SPIRVGlobalRegistry::getImageType(), llvm::getInlineSpirvType(), llvm::dxil::LayoutExtType::getOffsetOfElement(), llvm::getPipeType(), llvm::dxil::MSTextureExtType::getSampleCount(), llvm::dxil::SamplerExtType::getSamplerType(), llvm::dxil::LayoutExtType::getSize(), llvm::MVT::getVT(), llvm::getVulkanBufferType(), llvm::dxil::RawBufferExtType::isROV(), llvm::dxil::TextureExtType::isROV(), llvm::dxil::TypedBufferExtType::isROV(), llvm::dxil::MSTextureExtType::isSigned(), llvm::dxil::TextureExtType::isSigned(), llvm::dxil::TypedBufferExtType::isSigned(), llvm::dxil::MSTextureExtType::isWriteable(), llvm::dxil::RawBufferExtType::isWriteable(), llvm::dxil::TextureExtType::isWriteable(), and llvm::dxil::TypedBufferExtType::isWriteable().

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

◆ 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 816 of file DerivedTypes.h.

Referenced by llvm::MVT::getVT(), llvm::AMDGPU::isNamedBarrier(), and llvm::isTypedPointerWrapper().

◆ getNumIntParameters()

unsigned llvm::TargetExtType::getNumIntParameters ( ) const

inline

Definition at line 840 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by llvm::getCoopMatrType(), llvm::SPIRVGlobalRegistry::getImageType(), llvm::getInlineSpirvType(), llvm::getPipeType(), llvm::getVulkanBufferType(), int_params(), and llvm::isTypedPointerWrapper().

◆ getNumTypeParameters()

unsigned llvm::TargetExtType::getNumTypeParameters ( ) const

inline

Definition at line 831 of file DerivedTypes.h.

References llvm::Type::getNumContainedTypes().

Referenced by llvm::getCoopMatrType(), llvm::SPIRVGlobalRegistry::getImageType(), llvm::getVulkanBufferType(), and llvm::isTypedPointerWrapper().

◆ getOrError()

Expected< TargetExtType * > TargetExtType::getOrError	(	LLVMContext &	Context,
		StringRef	Name,
		ArrayRef< Type * >	Types = {},
		ArrayRef< unsigned >	Ints = {} )

static

Return a target extension type having the specified name and optional type and integer parameters, or an appropriate Error if it fails the parameters check.

Definition at line 914 of file Type.cpp.

◆ getTypeParameter()

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

inline

Definition at line 830 of file DerivedTypes.h.

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

Referenced by calculateGEPOffset(), createTypedBufferLoad(), createTypedBufferStore(), llvm::getCoopMatrType(), llvm::SPIRVGlobalRegistry::getImageType(), llvm::dxil::CBufferExtType::getResourceType(), llvm::dxil::MSTextureExtType::getResourceType(), llvm::dxil::RawBufferExtType::getResourceType(), llvm::dxil::TextureExtType::getResourceType(), llvm::dxil::TypedBufferExtType::getResourceType(), llvm::MVT::getVT(), llvm::getVulkanBufferType(), llvm::dxil::LayoutExtType::getWrappedType(), and llvm::dxil::RawBufferExtType::isStructured().

◆ hasProperty()

bool TargetExtType::hasProperty ( Property Prop ) const

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

Definition at line 1070 of file Type.cpp.

◆ 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 835 of file DerivedTypes.h.

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

◆ operator=()

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

delete

References LLVM_ABI.

◆ type_param_begin()

type_param_iterator llvm::TargetExtType::type_param_begin ( ) const

inline

Definition at line 825 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 826 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 820 of file DerivedTypes.h.

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

Referenced by llvm::getInlineSpirvType().

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

include/llvm/IR/DerivedTypes.h
lib/SandboxIR/Type.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ type_param_iterator

Member Enumeration Documentation

◆ Property

Constructor & Destructor Documentation

◆ TargetExtType()

Member Function Documentation

◆ checkParams()

◆ classof()

◆ get()

◆ getIntParameter()

◆ getLayoutType()

◆ getName()

◆ getNumIntParameters()

◆ getNumTypeParameters()

◆ getOrError()

◆ getTypeParameter()

◆ hasProperty()

◆ int_params()

◆ operator=()

◆ type_param_begin()

◆ type_param_end()

◆ type_params()