LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::FunctionType Class Reference

#include <DerivedTypes.h>

Inheritance diagram for llvm::FunctionType:
Inheritance graph
[legend]
Collaboration diagram for llvm::FunctionType:
Collaboration graph
[legend]

Public Types

typedef Type::subtype_iterator param_iterator
 
- Public Types inherited from llvm::Type
enum  TypeID {
  VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID,
  MetadataTyID, X86_MMXTyID, IntegerTyID, FunctionTyID,
  StructTyID, ArrayTyID, PointerTyID, VectorTyID,
  NumTypeIDs, LastPrimitiveTyID = X86_MMXTyID, FirstDerivedTyID = IntegerTyID
}
 
typedef Type *const * subtype_iterator
 
typedef std::reverse_iterator
< subtype_iterator > 		subtype_reverse_iterator
 

Public Member Functions

bool isVarArg () const
 
Type * getReturnType () const
 
param_iterator param_begin () const
 
param_iterator param_end () const
 
Type * getParamType (unsigned i) const
 Parameter type accessors. More...
 
unsigned getNumParams () const
 
- Public Member Functions inherited from llvm::Type
void print (raw_ostream &O) const
 
void dump () const
 
LLVMContext & getContext () const
 getContext - Return the LLVMContext in which this type was uniqued. More...
 
TypeID getTypeID () const
 
bool isVoidTy () const
 isVoidTy - Return true if this is 'void'. More...
 
bool isHalfTy () const
 isHalfTy - Return true if this is 'half', a 16-bit IEEE fp type. More...
 
bool isFloatTy () const
 isFloatTy - Return true if this is 'float', a 32-bit IEEE fp type. More...
 
bool isDoubleTy () const
 isDoubleTy - Return true if this is 'double', a 64-bit IEEE fp type. More...
 
bool isX86_FP80Ty () const
 isX86_FP80Ty - Return true if this is x86 long double. More...
 
bool isFP128Ty () const
 isFP128Ty - Return true if this is 'fp128'. More...
 
bool isPPC_FP128Ty () const
 isPPC_FP128Ty - Return true if this is powerpc long double. More...
 
bool isFloatingPointTy () const
 
const fltSemantics & getFltSemantics () const
 
bool isX86_MMXTy () const
 isX86_MMXTy - Return true if this is X86 MMX. More...
 
bool isFPOrFPVectorTy () const
 
bool isLabelTy () const
 isLabelTy - Return true if this is 'label'. More...
 
bool isMetadataTy () const
 isMetadataTy - Return true if this is 'metadata'. More...
 
bool isIntegerTy () const
 
bool isIntegerTy (unsigned Bitwidth) const
 isIntegerTy - Return true if this is an IntegerType of the given width. More...
 
bool isIntOrIntVectorTy () const
 
bool isFunctionTy () const
 
bool isStructTy () const
 
bool isArrayTy () const
 
bool isPointerTy () const
 
bool isPtrOrPtrVectorTy () const
 
bool isVectorTy () const
 
bool canLosslesslyBitCastTo (Type *Ty) const
 Determine if this type could be losslessly bitcast to Ty. More...
 
bool isEmptyTy () const
 
bool isPrimitiveType () const
 
bool isDerivedType () const
 
bool isFirstClassType () const
 
bool isSingleValueType () const
 
bool isAggregateType () const
 
bool isSized () const
 
unsigned getPrimitiveSizeInBits () const
 
unsigned getScalarSizeInBits ()
 
int getFPMantissaWidth () const
 
const Type * getScalarType () const
 
Type * getScalarType ()
 
subtype_iterator subtype_begin () const
 
subtype_iterator subtype_end () const
 
subtype_reverse_iterator subtype_rbegin () const
 
subtype_reverse_iterator subtype_rend () const
 
Type * getContainedType (unsigned i) const
 
unsigned getNumContainedTypes () const
 
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
 
Type * getSequentialElementType () const
 
uint64_t getArrayNumElements () const
 
Type * getArrayElementType () const
 
unsigned getVectorNumElements () const
 
Type * getVectorElementType () const
 
Type * getPointerElementType () const
 
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
 
PointerType * getPointerTo (unsigned AddrSpace=0)
 

Static Public Member Functions

static FunctionType * get (Type *Result, ArrayRef< Type * > Params, bool isVarArg)
 
static FunctionType * get (Type *Result, bool isVarArg)
 
static bool isValidReturnType (Type *RetTy)
 
static bool isValidArgumentType (Type *ArgTy)
 
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 Type * getPrimitiveType (LLVMContext &C, TypeID IDNumber)
 getPrimitiveType - Return a type based on an identifier. More...
 
static Type * getVoidTy (LLVMContext &C)
 
static Type * getLabelTy (LLVMContext &C)
 
static Type * getHalfTy (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_MMXTy (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 PointerType * getHalfPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getDoublePtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getFP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
 
static PointerType * getInt1PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getInt8PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getInt16PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getInt32PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerType * getInt64PtrTy (LLVMContext &C, unsigned AS=0)
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::Type
 Type (LLVMContext &C, TypeID tid)
 
 ~Type ()
 
void setTypeID (TypeID ID)
 
unsigned getSubclassData () const
 
void setSubclassData (unsigned val)
 
- Protected Attributes inherited from llvm::Type
unsigned NumContainedTys
 
Type *const * ContainedTys
 

Detailed Description

FunctionType - Class to represent function types

Definition at line 96 of file DerivedTypes.h.

Member Typedef Documentation

typedef Type::subtype_iterator llvm::FunctionType::param_iterator

Definition at line 123 of file DerivedTypes.h.

Member Function Documentation

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

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

Definition at line 136 of file DerivedTypes.h.

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

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

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

Definition at line 361 of file Type.cpp.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT >::find_as(), llvm::LLVMContextImpl::FunctionTypes, llvm::Type::getContext(), I, llvm::LLVMContext::pImpl, llvm::ArrayRef< T >::size(), and llvm::LLVMContextImpl::TypeAllocator.

Referenced by appendToGlobalArray(), llvm::CloneFunction(), EnsureFunctionExists(), GenerateARCBBEntranceAnnotation(), GenerateARCBBTerminatorAnnotation(), llvm::TypeBuilder< R(), cross >::get(), llvm::TypeBuilder< R(A1), cross >::get(), llvm::TypeBuilder< R(A1, A2), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3, A4), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3, A4, A5), cross >::get(), llvm::TypeBuilder< R(...), cross >::get(), llvm::TypeBuilder< R(A1,...), cross >::get(), llvm::TypeBuilder< R(A1, A2,...), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3,...), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3, A4,...), cross >::get(), llvm::TypeBuilder< R(A1, A2, A3, A4, A5,...), cross >::get(), llvm::Module::getOrInsertFunction(), llvm::Intrinsic::getType(), inlineAsmOut(), InstallGlobalCtors(), LLVMFunctionType(), ReplaceCallWith(), llvm::JIT::runFunction(), and UpgradeIntrinsicFunction1().

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

FunctionType::get - Create a FunctionType taking no parameters.

Definition at line 382 of file Type.cpp.

References isVarArg(), and llvm::None.

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

getNumParams - Return the number of fixed parameters this function type requires. This does not consider varargs.

Definition at line 133 of file DerivedTypes.h.

References llvm::Type::NumContainedTys.

Referenced by llvm::Function::arg_empty(), llvm::Function::arg_size(), FindCXAAtExit(), llvm::SimplifyFortifiedLibCalls::fold(), getAllocationData(), llvm::Mangler::getNameWithPrefix(), llvm::isFreeCall(), llvm::HexagonTargetLowering::LowerCall(), llvm::TypePrinting::print(), llvm::AssemblyWriter::printFunction(), profileFunction(), llvm::Interpreter::runFunction(), llvm::JIT::runFunction(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::InlineAsm::Verify(), and WriteTypeTable().

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

Parameter type accessors.

Definition at line 128 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by FindCXAAtExit(), llvm::SimplifyFortifiedLibCalls::fold(), getAllocationData(), llvm::isFreeCall(), llvm::SITargetLowering::LowerFormalArguments(), needsFPStubFromParams(), llvm::AssemblyWriter::printFunction(), profileFunction(), llvm::JIT::runFunction(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), UpgradeSSE41Function(), whichFPParamVariantNeeded(), and WriteTypeTable().

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

Definition at line 121 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by llvm::CloneFunction(), FindCXAAtExit(), llvm::SimplifyFortifiedLibCalls::fold(), getAllocationData(), llvm::Function::getReturnType(), llvm::isFreeCall(), llvm::TypePrinting::print(), profileFunction(), llvm::JIT::runFunction(), llvm::MCJIT::runFunction(), llvm::ExecutionEngine::runFunctionAsMain(), SimplifyCall(), llvm::InlineAsm::Verify(), and WriteTypeTable().

bool FunctionType::isValidArgumentType ( Type *  ArgTy)
static

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

Definition at line 395 of file Type.cpp.

References llvm::Type::isFirstClassType().

bool FunctionType::isValidReturnType ( Type *  RetTy)
static

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

Definition at line 388 of file Type.cpp.

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

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

Definition at line 120 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by llvm::Interpreter::callFunction(), llvm::CloneFunction(), llvm::ComputeUsesVAFloatArgument(), get(), llvm::Mangler::getNameWithPrefix(), llvm::InlineFunction(), llvm::Function::isVarArg(), llvm::TypePrinting::print(), llvm::AssemblyWriter::printFunction(), profileFunction(), llvm::JIT::runFunction(), llvm::MCJIT::runFunction(), llvm::InlineAsm::Verify(), and WriteTypeTable().

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

Definition at line 124 of file DerivedTypes.h.

References llvm::Type::ContainedTys.

Referenced by LLVMGetParamTypes(), and llvm::TypePrinting::print().

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

Definition at line 125 of file DerivedTypes.h.

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

Referenced by LLVMGetParamTypes(), and llvm::TypePrinting::print().

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

Generated on Tue Mar 18 2014 10:40:39 for LLVM by Doxygen1.8.6
Copyright © 2003-2013 University of Illinois at Urbana-Champaign. All Rights Reserved.