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

Class to represent function types. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::FunctionType:
[legend]

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
 
FunctionTypeoperator= (const FunctionType &)=delete
 
bool isVarArg () const
 
TypegetReturnType () const
 
param_iterator param_begin () const
 
param_iterator param_end () const
 
ArrayRef< Type * > params () const
 
TypegetParamType (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
LLVM_ABI void print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
 Print the current type.
 
LLVM_ABI void dump () const
 
LLVMContextgetContext () 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 fltSemanticsgetFltSemantics () 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.
 
TypegetScalarType () 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
 
TypegetContainedType (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 TypegetFunctionParamType (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 TypegetStructElementType (unsigned N) const
 
LLVM_ABI uint64_t getArrayNumElements () const
 
TypegetArrayElementType () const
 
LLVM_ABI StringRef getTargetExtName () const
 
LLVM_ABI TypegetWithNewType (Type *EltTy) const
 Given vector type, change the element type, whilst keeping the old number of elements.
 
LLVM_ABI TypegetWithNewBitWidth (unsigned NewBitWidth) const
 Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes.
 
LLVM_ABI TypegetExtendedType () 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 FunctionTypeget (Type *Result, ArrayRef< Type * > Params, bool isVarArg)
 This static method is the primary way of constructing a FunctionType.
 
static LLVM_ABI FunctionTypeget (Type *Result, bool isVarArg)
 Create a FunctionType taking no parameters.
 
static LLVM_ABI bool isValidReturnType (Type *RetTy)
 Return true if the specified type is valid as a return type.
 
static LLVM_ABI 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 LLVM_ABI TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 Return a type based on an identifier.
 
static LLVM_ABI TypegetVoidTy (LLVMContext &C)
 
static LLVM_ABI TypegetLabelTy (LLVMContext &C)
 
static LLVM_ABI TypegetHalfTy (LLVMContext &C)
 
static LLVM_ABI TypegetBFloatTy (LLVMContext &C)
 
static LLVM_ABI TypegetFloatTy (LLVMContext &C)
 
static LLVM_ABI TypegetDoubleTy (LLVMContext &C)
 
static LLVM_ABI TypegetMetadataTy (LLVMContext &C)
 
static LLVM_ABI TypegetX86_FP80Ty (LLVMContext &C)
 
static LLVM_ABI TypegetFP128Ty (LLVMContext &C)
 
static LLVM_ABI TypegetPPC_FP128Ty (LLVMContext &C)
 
static LLVM_ABI TypegetX86_AMXTy (LLVMContext &C)
 
static LLVM_ABI TypegetTokenTy (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
 
static LLVM_ABI IntegerTypegetInt1Ty (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetInt8Ty (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetInt16Ty (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetInt32Ty (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetInt64Ty (LLVMContext &C)
 
static LLVM_ABI IntegerTypegetInt128Ty (LLVMContext &C)
 
template<typename ScalarTy >
static TypegetScalarTy (LLVMContext &C)
 
static LLVM_ABI TypegetFloatingPointTy (LLVMContext &C, const fltSemantics &S)
 
static LLVM_ABI TypegetWasm_ExternrefTy (LLVMContext &C)
 
static LLVM_ABI TypegetWasm_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 *constContainedTys = nullptr
 A pointer to the array of Types contained by this Type.
 

Detailed Description

Class to represent function types.

Definition at line 105 of file DerivedTypes.h.

Member Typedef Documentation

◆ param_iterator

Definition at line 128 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 147 of file DerivedTypes.h.

References llvm::Type::FunctionTyID.

◆ get() [1/2]

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

◆ get() [2/2]

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

Create a FunctionType taking no parameters.

Definition at line 395 of file Type.cpp.

◆ getNumParams()

unsigned llvm::FunctionType::getNumParams ( ) const
inline

◆ getParamType()

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

◆ getReturnType()

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

◆ isValidArgumentType()

bool FunctionType::isValidArgumentType ( Type ArgTy)
static

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

Definition at line 404 of file Type.cpp.

◆ isValidReturnType()

bool FunctionType::isValidReturnType ( Type RetTy)
static

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

Definition at line 399 of file Type.cpp.

◆ isVarArg()

bool llvm::FunctionType::isVarArg ( ) const
inline

◆ operator=()

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

◆ param_begin()

param_iterator llvm::FunctionType::param_begin ( ) const
inline

◆ param_end()

param_iterator llvm::FunctionType::param_end ( ) const
inline

◆ params()

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

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