Class to represent function types. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::FunctionType:

Public Types
using	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
	FunctionType (const FunctionType &)=delete

FunctionType &	operator= (const FunctionType &)=delete

bool	isVarArg () const

Type *	getReturnType () const

param_iterator	param_begin () const

param_iterator	param_end () const

ArrayRef< Type * >	params () const

Type *	getParamType (unsigned i) const
	Parameter type accessors.

unsigned	getNumParams () const
	Return the number of fixed parameters this function type requires.

Public Member Functions inherited from llvm::Type
void	print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
	Print the current type.

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 as defined by APFloat::isIEEE(), 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.

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.

bool	isScalableTargetExtTy () const
	Return true if this is a target extension type with a scalable layout.

bool	isScalableTy () const
	Return true if this is a type whose size is a known multiple of vscale.

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	isIntegerTy () const
	True if this is an instance of IntegerType.

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	isOpaquePointerTy () const
	True if this is an instance of an opaque 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.

bool	canLosslesslyBitCastTo (Type *Ty) const
	Return true if this type could be converted with a lossless BitCast to type 'Ty'.

bool	isEmptyTy () const
	Return true if this type is empty, that is, it has no elements or all of its elements are empty.

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.

TypeSize	getPrimitiveSizeInBits () const LLVM_READONLY
	Return the basic size of this type if it is a primitive type.

unsigned	getScalarSizeInBits () const LLVM_READONLY
	If this is a vector type, return the getPrimitiveSizeInBits value for the element type.

int	getFPMantissaWidth () const
	Return the width of the mantissa of this type.

bool	isIEEE () const
	Return whether the type is IEEE compatible, as defined by the eponymous method in APFloat.

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.

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

uint64_t	getArrayNumElements () const

Type *	getArrayElementType () const

StringRef	getTargetExtName () const

Type *	getNonOpaquePointerElementType () 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.

Type *	getWithNewType (Type *EltTy) const
	Given vector type, change the element type, whilst keeping the old number of elements.

Type *	getWithNewBitWidth (unsigned NewBitWidth) const
	Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes.

Type *	getExtendedType () const
	Given scalar/vector integer type, returns a type with elements twice as wide as in the original type.

unsigned	getPointerAddressSpace () const
	Get the address space of this pointer or pointer vector type.

PointerType *	getPointerTo (unsigned AddrSpace=0) const
	Return a pointer to the current type.

Static Public Member Functions
static FunctionType *	get (Type Result, ArrayRef< Type > Params, bool isVarArg)
	This static method is the primary way of constructing a FunctionType.

static FunctionType *	get (Type *Result, bool isVarArg)
	Create a FunctionType taking no parameters.

static bool	isValidReturnType (Type *RetTy)
	Return true if the specified type is valid as a return type.

static bool	isValidArgumentType (Type *ArgTy)
	Return true if the specified type is valid as an argument type.

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 Type *	getPrimitiveType (LLVMContext &C, TypeID IDNumber)
	Return a type based on an identifier.

static Type *	getVoidTy (LLVMContext &C)

static Type *	getLabelTy (LLVMContext &C)

static Type *	getHalfTy (LLVMContext &C)

static Type *	getBFloatTy (LLVMContext &C)

static Type *	getFloatTy (LLVMContext &C)

static Type *	getDoubleTy (LLVMContext &C)

static Type *	getMetadataTy (LLVMContext &C)

static Type *	getX86_FP80Ty (LLVMContext &C)

static Type *	getFP128Ty (LLVMContext &C)

static Type *	getPPC_FP128Ty (LLVMContext &C)

static Type *	getX86_AMXTy (LLVMContext &C)

static Type *	getTokenTy (LLVMContext &C)

static IntegerType *	getIntNTy (LLVMContext &C, unsigned N)

static IntegerType *	getInt1Ty (LLVMContext &C)

static IntegerType *	getInt8Ty (LLVMContext &C)

static IntegerType *	getInt16Ty (LLVMContext &C)

static IntegerType *	getInt32Ty (LLVMContext &C)

static IntegerType *	getInt64Ty (LLVMContext &C)

static IntegerType *	getInt128Ty (LLVMContext &C)

template<typename ScalarTy >
static Type *	getScalarTy (LLVMContext &C)

static Type *	getFloatingPointTy (LLVMContext &C, const fltSemantics &S)

static Type *	getWasm_ExternrefTy (LLVMContext &C)

static 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 function types.

Definition at line 103 of file DerivedTypes.h.

Member Typedef Documentation

◆ param_iterator

using llvm::FunctionType::param_iterator = Type::subtype_iterator

Definition at line 126 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ FunctionType()

llvm::FunctionType::FunctionType ( const FunctionType & )

delete

Member Function Documentation

◆ classof()

static bool llvm::FunctionType::classof ( const Type * T )

inlinestatic

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

Definition at line 145 of file DerivedTypes.h.

References llvm::Type::FunctionTyID.

◆ get() [1/2]

static FunctionType * llvm::FunctionType::get	(	Type *	Result,
		ArrayRef< Type * >	Params,
		bool	isVarArg
	)

static

This static method is the primary way of constructing a FunctionType.

Referenced by llvm::SanitizerStatReport::create(), llvm::MIRParserImpl::createDummyFunction(), llvm::RandomIRBuilder::createFunctionDeclaration(), llvm::IRBuilderBase::CreateIntrinsic(), createOutlinedFunction(), llvm::ThunkInserter< Derived, InsertedThunksTy >::createThunkFunction(), llvm::orc::IRSpeculationLayer::emit(), emitTargetTaskProxyFunction(), llvm::SanitizerStatReport::finish(), fixFunctionTypeIfPtrArgs(), llvm::AMDGPU::generateCrashCode(), get(), getFreshReductionFunc(), llvm::AMDGPUMangledLibFunc::getFunctionType(), getOriginalFunctionType(), llvm::getOrInsertLibFunc(), getOrInsertValueProfilingCall(), llvm::Intrinsic::getType(), InsertSafepointPoll(), insertUseHolderAfter(), makeStatepointExplicitImpl(), llvm::reconstructFunctionType(), runImpl(), and llvm::toTypedFunPointer().

◆ get() [2/2]

FunctionType * FunctionType::get	(	Type *	Result,
		bool	isVarArg
	)

static

Create a FunctionType taking no parameters.

Definition at line 342 of file Type.cpp.

References get(), and isVarArg().

◆ getNumParams()

unsigned llvm::FunctionType::getNumParams ( ) const

inline

Return the number of fixed parameters this function type requires.

This does not consider varargs.

Definition at line 142 of file DerivedTypes.h.

References llvm::Type::NumContainedTys.

Referenced by llvm::AMDGPUMangledLibFunc::AMDGPUMangledLibFunc(), llvm::FunctionComparator::cmpTypes(), llvm::VFShape::get(), llvm::Mangler::getNameWithPrefix(), getParamType(), llvm::InlineFunction(), llvm::AMDGPULibFunc::isCompatibleSignature(), llvm::isLibFreeFunction(), llvm::CallLowering::lowerCall(), llvm::HexagonTargetLowering::LowerCall(), llvm::HexagonTargetLowering::LowerFormalArguments(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::FastISel::CallLoweringInfo::setCallee(), llvm::TargetLowering::CallLoweringInfo::setCallee(), llvm::VFABI::tryDemangleForVFABI(), llvm::InlineAsm::verify(), and llvm::SelectionDAGBuilder::visitSPDescriptorParent().

◆ getParamType()

Type * llvm::FunctionType::getParamType ( unsigned i ) const

inline

◆ getReturnType()

Type * llvm::FunctionType::getReturnType ( ) const

inline

Definition at line 124 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by llvm::FunctionComparator::cmpTypes(), llvm::computeSignatureVTs(), llvm::VFABI::createFunctionType(), llvm::objcarc::hasAttachedCallOpBundle(), llvm::isLibFreeFunction(), llvm::SPIRVCallLowering::lowerFormalArguments(), llvm::Intrinsic::matchIntrinsicSignature(), llvm::CallBase::mutateFunctionType(), replaceFallthroughCoroEnd(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::CallBase::setCalledFunction(), llvm::toTypedFunPointer(), llvm::UpgradeARCRuntime(), llvm::InlineAsm::verify(), and llvm::SelectionDAGBuilder::visitSPDescriptorParent().

◆ isValidArgumentType()

bool FunctionType::isValidArgumentType ( Type * ArgTy )

static

Return true if the specified type is valid as an argument type.

Definition at line 351 of file Type.cpp.

References llvm::Type::isFirstClassType().

◆ isValidReturnType()

bool FunctionType::isValidReturnType ( Type * RetTy )

static

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

Definition at line 346 of file Type.cpp.

References RetTy.

◆ isVarArg()

bool llvm::FunctionType::isVarArg ( ) const

inline

Definition at line 123 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by llvm::FunctionComparator::cmpTypes(), llvm::computeSignatureVTs(), get(), llvm::Intrinsic::getIntrinsicSignature(), llvm::Mangler::getNameWithPrefix(), llvm::AMDGPULibFunc::isCompatibleSignature(), llvm::CallLowering::lowerCall(), llvm::MCJIT::runFunction(), llvm::FastISel::CallLoweringInfo::setCallee(), llvm::TargetLowering::CallLoweringInfo::setCallee(), llvm::toTypedFunPointer(), and llvm::InlineAsm::verify().

◆ operator=()

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

delete

◆ param_begin()

param_iterator llvm::FunctionType::param_begin ( ) const

inline

Definition at line 128 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by llvm::AMDGPULibFunc::getOrInsertFunction(), llvm::LoopVectorizationCostModel::getVectorIntrinsicCost(), llvm::IntrinsicCostAttributes::IntrinsicCostAttributes(), and params().

◆ param_end()

param_iterator llvm::FunctionType::param_end ( ) const

inline

Definition at line 129 of file DerivedTypes.h.

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

Referenced by llvm::AMDGPULibFunc::getOrInsertFunction(), llvm::LoopVectorizationCostModel::getVectorIntrinsicCost(), llvm::IntrinsicCostAttributes::IntrinsicCostAttributes(), and params().

◆ params()

ArrayRef< Type * > llvm::FunctionType::params ( ) const

inline

Definition at line 130 of file DerivedTypes.h.

References param_begin(), and param_end().

Referenced by llvm::computeSignatureVTs(), llvm::lowerGlobalIFuncUsersAsGlobalCtor(), llvm::Intrinsic::matchIntrinsicSignature(), llvm::InsertFunctionStrategy::mutate(), llvm::IRSimilarity::IRInstructionData::setCalleeName(), and llvm::toTypedFunPointer().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ param_iterator

Constructor & Destructor Documentation

◆ FunctionType()

Member Function Documentation

◆ classof()

◆ get() [1/2]

◆ get() [2/2]

◆ getNumParams()

◆ getParamType()

◆ getReturnType()

◆ isValidArgumentType()

◆ isValidReturnType()

◆ isVarArg()

◆ operator=()

◆ param_begin()

◆ param_end()

◆ params()