Class to represent function types. More...
#include "llvm/IR/DerivedTypes.h"
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_MMXTyID, X86_AMXTyID, TokenTyID, IntegerTyID, FunctionTyID, PointerTyID, StructTyID, ArrayTyID, FixedVectorTyID, ScalableVectorTyID, TypedPointerTyID } |
| 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. 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 |
| LLVMContext & | getContext () 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 | isFloatingPointTy () const |
| Return true if this is one of the six floating-point types. More... | |
| const fltSemantics & | getFltSemantics () 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 | 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... | |
| Type * | getScalarType () 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 |
| Type * | getContainedType (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 |
| 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 |
| Type * | getPointerElementType () const |
| This method is deprecated without replacement. More... | |
| 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. More... | |
| Type * | getWithNewType (Type *EltTy) const |
| Given vector type, change the element type, whilst keeping the old number of elements. More... | |
| Type * | getWithNewBitWidth (unsigned NewBitWidth) const |
| Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes. More... | |
| Type * | getExtendedType () 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... | |
| PointerType * | getPointerTo (unsigned AddrSpace=0) const |
| Return a pointer to the current type. More... | |
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 *const * | ContainedTys = nullptr |
| A pointer to the array of Types contained by this Type. More... | |
Detailed Description
Class to represent function types.
Definition at line 103 of file DerivedTypes.h.
Member Typedef Documentation
◆ param_iterator
Definition at line 126 of file DerivedTypes.h.
Constructor & Destructor Documentation
◆ FunctionType()
|
delete |
Member Function Documentation
◆ classof()
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition at line 142 of file DerivedTypes.h.
References llvm::Type::FunctionTyID, and T.
◆ get() [1/2]
|
static |
This static method is the primary way of constructing a FunctionType.
Definition at line 361 of file Type.cpp.
References llvm::LLVMContextImpl::Alloc, llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >::Allocate(), llvm::LLVMContextImpl::FunctionTypes, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert_as(), isVarArg(), and llvm::ArrayRef< T >::size().
Referenced by addVariantDeclaration(), appendToGlobalArray(), llvm::CloneFunction(), llvm::SanitizerStatReport::create(), llvm::MIRParserImpl::createDummyFunction(), createEmptyFunction(), createFrameHelperMachineFunction(), llvm::IRBuilderBase::CreateIntrinsic(), llvm::createSanitizerCtor(), llvm::createSanitizerCtorAndInitFunctions(), llvm::OpenMPIRBuilder::createTask(), llvm::ThunkInserter< Derived >::createThunkFunction(), llvm::declareSanitizerInitFunction(), doPromotion(), llvm::orc::IRSpeculationLayer::emit(), emitInlineAsm(), emitLibCall(), llvm::SanitizerStatReport::finish(), get(), getDefaultPersonalityFn(), getDXILOpFunctionType(), getFreshReductionFunc(), llvm::AMDGPUMangledLibFunc::getFunctionType(), getFunctionTypeFromAsyncSuspend(), getOrCreateFunction(), getOriginalFunctionType(), llvm::Module::getOrInsertFunction(), llvm::getOrInsertLibFunc(), getOrInsertValueProfilingCall(), llvm::GlobalIFunc::getResolverFunctionType(), llvm::coro::Shape::getResumeFunctionType(), llvm::Intrinsic::getType(), INITIALIZE_PASS(), insertCall(), InsertSafepointPoll(), insertUseHolderAfter(), LLVMFunctionType(), makeStatepointExplicitImpl(), ReplaceCallWith(), runImpl(), and UpgradeIntrinsicFunction1().
◆ get() [2/2]
|
static |
Create a FunctionType taking no parameters.
Definition at line 387 of file Type.cpp.
References get(), isVarArg(), and llvm::None.
◆ getNumParams()
|
inline |
Return the number of fixed parameters this function type requires.
This does not consider varargs.
Definition at line 139 of file DerivedTypes.h.
References llvm::Type::NumContainedTys.
Referenced by llvm::FunctionComparator::cmpTypes(), createWrapper(), getAllocationDataForFunction(), llvm::Mangler::getNameWithPrefix(), llvm::InlineFunction(), llvm::isLegalToPromote(), llvm::isLibFreeFunction(), llvm::HexagonTargetLowering::LowerCall(), llvm::CallLowering::lowerCall(), llvm::HexagonTargetLowering::LowerFormalArguments(), llvm::promoteCall(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::FastISel::CallLoweringInfo::setCallee(), llvm::TargetLowering::CallLoweringInfo::setCallee(), shouldBeMustTail(), shouldFixMainFunction(), llvm::InlineAsm::verify(), and llvm::SelectionDAGBuilder::visitSPDescriptorParent().
◆ getParamType()
|
inline |
Parameter type accessors.
Definition at line 135 of file DerivedTypes.h.
References llvm::Type::ContainedTys, and i.
Referenced by llvm::FunctionComparator::cmpTypes(), llvm::IRBuilderBase::CreateLaunderInvariantGroup(), llvm::IRBuilderBase::CreateStripInvariantGroup(), llvm::ARMTargetLowering::emitStoreConditional(), llvm::AArch64TargetLowering::emitStoreConditional(), getAllocationDataForFunction(), llvm::DXIL::DXILOpBuilder::getOverloadTy(), llvm::isLibFreeFunction(), llvm::SPIRVCallLowering::lowerFormalArguments(), llvm::SITargetLowering::LowerFormalArguments(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), shouldBeMustTail(), and llvm::UpgradeARCRuntime().
◆ getReturnType()
|
inline |
Definition at line 124 of file DerivedTypes.h.
References llvm::Type::ContainedTys.
Referenced by llvm::FunctionComparator::cmpTypes(), llvm::computeSignatureVTs(), createWrapper(), doPromotion(), getAllocationDataForFunction(), llvm::DXIL::DXILOpBuilder::getOverloadTy(), getSignature(), llvm::objcarc::hasAttachedCallOpBundle(), isCallingConvCCompatible(), llvm::isLibFreeFunction(), lookupFunction(), llvm::SPIRVCallLowering::lowerCall(), lowerFunnelShifts(), lowerUMulWithOverflow(), llvm::Intrinsic::matchIntrinsicSignature(), llvm::CallBase::mutateFunctionType(), needsFPReturnHelper(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::CallBase::setCalledFunction(), shouldBeMustTail(), shouldFixMainFunction(), llvm::UpgradeARCRuntime(), and llvm::InlineAsm::verify().
◆ isValidArgumentType()
|
static |
Return true if the specified type is valid as an argument type.
Definition at line 396 of file Type.cpp.
References llvm::Type::isFirstClassType().
◆ isValidReturnType()
|
static |
Return true if the specified type is valid as a return type.
Definition at line 391 of file Type.cpp.
References llvm::Type::isFunctionTy(), llvm::Type::isLabelTy(), and llvm::Type::isMetadataTy().
◆ isVarArg()
|
inline |
Definition at line 123 of file DerivedTypes.h.
References llvm::Type::getSubclassData().
Referenced by addVariantDeclaration(), llvm::FunctionComparator::cmpTypes(), llvm::computeSignatureVTs(), createWrapper(), doPromotion(), get(), llvm::Mangler::getNameWithPrefix(), getSignature(), llvm::CallLowering::lowerCall(), llvm::MCJIT::runFunction(), llvm::FastISel::CallLoweringInfo::setCallee(), llvm::TargetLowering::CallLoweringInfo::setCallee(), shouldFixMainFunction(), and llvm::InlineAsm::verify().
◆ operator=()
|
delete |
◆ param_begin()
|
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()
|
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()
Definition at line 130 of file DerivedTypes.h.
References llvm::makeArrayRef(), param_begin(), and param_end().
Referenced by coerceArguments(), llvm::computeSignatureVTs(), getSignature(), isCallingConvCCompatible(), LLVMGetParamTypes(), lookupFunction(), lowerFunnelShifts(), lowerUMulWithOverflow(), llvm::Intrinsic::matchIntrinsicSignature(), and llvm::IRSimilarity::IRInstructionData::setCalleeName().
The documentation for this class was generated from the following files:
- include/llvm/IR/DerivedTypes.h
- lib/IR/Type.cpp
