LLVM  10.0.0svn
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:
Inheritance graph
Collaboration diagram for llvm::FunctionType:
Collaboration graph

Public Types

using param_iterator = Type::subtype_iterator
- Public Types inherited from llvm::Type
enum  TypeID {
  VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID,
  MetadataTyID, X86_MMXTyID, TokenTyID, IntegerTyID,
  FunctionTyID, StructTyID, ArrayTyID, PointerTyID,
 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. More...
unsigned getNumParams () const
 Return the number of fixed parameters this function type requires. 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 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 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 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...
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
TypegetSequentialElementType () const
uint64_t getArrayNumElements () const
TypegetArrayElementType () const
bool getVectorIsScalable () const
unsigned getVectorNumElements () const
ElementCount getVectorElementCount () const
TypegetVectorElementType () const
TypegetPointerElementType () const
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 FunctionTypeget (Type *Result, ArrayRef< Type *> Params, bool isVarArg)
 This static method is the primary way of constructing a FunctionType. More...
static FunctionTypeget (Type *Result, bool isVarArg)
 Create a FunctionType taking no parameters. More...
static bool isValidReturnType (Type *RetTy)
 Return true if the specified type is valid as a return type. More...
static bool isValidArgumentType (Type *ArgTy)
 Return true if the specified type is valid as an argument 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 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 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 PointerTypegetHalfPtrTy (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 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)
- Static Protected Member Functions inherited from llvm::Type
static bool isSequentialType (TypeID TyID)
- 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 function types.

Definition at line 108 of file DerivedTypes.h.

Member Typedef Documentation

◆ param_iterator

Definition at line 131 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ FunctionType()

llvm::FunctionType::FunctionType ( const FunctionType )

Member Function Documentation

◆ classof()

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

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

Definition at line 147 of file DerivedTypes.h.

References llvm::Type::FunctionTyID, and llvm::Type::getTypeID().

◆ get() [1/2]

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

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

Definition at line 301 of file Type.cpp.

References llvm::LLVMContextImpl::Alloc, llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold >::Allocate(), llvm::LLVMContextImpl::FunctionTypes, llvm::Type::getContext(), llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert_as(), llvm::LLVMContext::pImpl, and llvm::ArrayRef< T >::size().

Referenced by AddCalls(), annotateAnyAllocSite(), appendToGlobalArray(), buildFrameType(), llvm::CloneFunction(), llvm::SanitizerStatReport::create(), llvm::createAMDGPUPrintfRuntimeBinding(), createCallInst(), llvm::createDeadArgHackingPass(), createDevirtTriggerFunc(), createDummyFunction(), llvm::createDwarfEHPass(), createEmptyFunction(), llvm::createSanitizerCtorAndInitFunctions(), llvm::createX86RetpolineThunksPass(), llvm::declareSanitizerInitFunction(), doPromotion(), llvm::orc::IRSpeculationLayer::emit(), emitGetSwiftErrorValue(), EmitInlineAsm(), emitLibCall(), emitSetSwiftErrorValue(), llvm::CodeExtractor::findInputsOutputs(), llvm::SanitizerStatReport::finish(), forEachUser(), FunctionNumber(), getDefaultPersonalityFn(), llvm::AMDGPUMangledLibFunc::getFunctionType(), llvm::Module::getOrInsertFunction(), getOrInsertGlobal(), getOrInsertValueProfilingCall(), getRetComponentType(), GetRMWLibcall(), getSignature(), llvm::Intrinsic::getType(), INITIALIZE_PASS(), insertCall(), InsertSafepointPoll(), insertUseHolderAfter(), instrumentMaskedLoadOrStore(), LLVMFunctionType(), makeStatepointExplicitImpl(), needsRuntimeRegistrationOfSectionRange(), parseOptionalLinkageAux(), prepareForSplit(), PushArgMD(), ReplaceCallWith(), llvm::HWAddressSanitizerPass::run(), llvm::ModuleSanitizerCoveragePass::run(), selectJumpTableArmEncoding(), shouldFixMainFunction(), shouldKeepInEntry(), TypeSizeToSizeIndex(), UpgradeIntrinsicFunction1(), llvm::AMDGPULibCalls::useNative(), and wrapConstantAsMetadata().

◆ get() [2/2]

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

Create a FunctionType taking no parameters.

Definition at line 327 of file Type.cpp.

References llvm::None.

◆ getNumParams()

unsigned llvm::FunctionType::getNumParams ( ) const

◆ getParamType()

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

◆ getReturnType()

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

◆ isValidArgumentType()

bool FunctionType::isValidArgumentType ( Type ArgTy)

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

Definition at line 336 of file Type.cpp.

References llvm::Type::isFirstClassType().

Referenced by parseOptionalLinkageAux().

◆ isValidReturnType()

bool FunctionType::isValidReturnType ( Type RetTy)

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

Definition at line 331 of file Type.cpp.

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

Referenced by computeAddrSpace(), FunctionNumber(), and parseOptionalLinkageAux().

◆ isVarArg()

bool llvm::FunctionType::isVarArg ( ) const

◆ operator=()

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

◆ param_begin()

param_iterator llvm::FunctionType::param_begin ( ) const

◆ param_end()

param_iterator llvm::FunctionType::param_end ( ) const

◆ params()

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

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