Represents a concrete C function binding with the first argument as its return type. More...

#include <openvdb_ax/codegen/FunctionTypes.h>

Inherits SRetFunction< SignatureT, CFunction< SignatureT > >.

Public Types
using	BaseT = SRetFunction< SignatureT, CFunction< SignatureT >>

using	Ptr = std::shared_ptr< SRetFunction< SignatureT, CFunction< SignatureT > >>

using	Traits = FunctionTraits< SignatureT >

using	CFunctionT = CFunction< SignatureT >

enum	SignatureMatch { None = 0, Size, Implicit, Explicit }
	The result type from calls to Function::match. More...

Public Member Functions
	CFunctionSRet (const std::string &symbol, const SignatureT function)

	~CFunctionSRet () override=default

Function::SignatureMatch	match (const std::vector< llvm::Type * > &args, llvm::LLVMContext &C) const override
	Override of match which inserts the SRET type such that the base class methods ignore it. More...

llvm::Value *	call (const std::vector< llvm::Value * > &args, llvm::IRBuilder<> &B, const bool cast) const override
	Override of call which allocates the required SRET llvm::Value for this function. More...

void	print (llvm::LLVMContext &C, std::ostream &os, const char *name=nullptr, const bool axTypes=true) const override
	Override of print to avoid printing out the SRET type. More...

llvm::Type *	types (std::vector< llvm::Type * > &types, llvm::LLVMContext &C) const override
	Populate a vector of llvm::Types which describe this function signature. This method is used by Function::create, Function::print and Function::match. More...

uint64_t	address () const override final
	Returns the global address of this function. More...

llvm::Value *	fold (const std::vector< llvm::Value * > &args, llvm::LLVMContext &C) const override final

void	setConstantFold (bool on)

bool	hasConstantFold () const

virtual llvm::Function *	create (llvm::LLVMContext &C, llvm::Module *M=nullptr) const
	Converts and creates this AX function into a llvm Function. More...

llvm::Function *	create (llvm::Module &M) const
	Convenience method which always uses the provided module to find the function or insert it if necessary. More...

llvm::Function *	get (const llvm::Module &M) const
	Convenience method for calling M.getFunction(symbol). Returns a nullptr if the function has not yet been created or if it is embedded IR. More...

size_t	size () const
	The number of arguments that this function has. More...

const char *	symbol () const
	The function symbol name. More...

const char *	argName (const size_t idx) const
	Returns the descriptive name of the given argument index. More...

bool	hasParamAttribute (const size_t i, const llvm::Attribute::AttrKind &kind) const
	Builder methods. More...

void	setArgumentNames (std::vector< const char * > names)

const std::vector< const char * > &	dependencies () const

void	setDependencies (std::vector< const char * > deps)

void	setFnAttributes (const std::vector< llvm::Attribute::AttrKind > &in)

void	setRetAttributes (const std::vector< llvm::Attribute::AttrKind > &in)

void	setParamAttributes (const size_t i, const std::vector< llvm::Attribute::AttrKind > &in)

Static Protected Member Functions
static void	cast (std::vector< llvm::Value * > &args, const std::vector< llvm::Type * > &types, llvm::IRBuilder<> &B)
	Cast the provided arguments to the given type as supported by implicit casting of function types. If the types already match OR if a cast cannot be performed, nothing is done to the argument. More...

Detailed Description

template<typename SignatureT>
struct openvdb::v12_0::ax::codegen::CFunctionSRet< SignatureT >

Represents a concrete C function binding with the first argument as its return type.

Member Typedef Documentation

using BaseT = SRetFunction<SignatureT, CFunction<SignatureT>>

using CFunctionT = CFunction<SignatureT>

inherited

using Ptr = std::shared_ptr<SRetFunction<SignatureT, CFunction< SignatureT > >>

inherited

using Traits = FunctionTraits<SignatureT>

inherited

Member Enumeration Documentation

enum SignatureMatch

inherited

The result type from calls to Function::match.

Enumerator
None
Size
Implicit
Explicit

Constructor & Destructor Documentation

CFunctionSRet	(	const std::string &	symbol,
		const SignatureT	function
	)

inline

~CFunctionSRet ( )

overridedefault

Member Function Documentation

uint64_t address ( ) const

inlinefinaloverridevirtualinherited

Returns the global address of this function.

Note: This is only required for C bindings.

Implements CFunctionBase.

const char* argName ( const size_t idx ) const

inlineinherited

Returns the descriptive name of the given argument index.

If the index is greater than the number of arguments, an empty string is returned.

Parameters

idx	The index of the argument

llvm::Value* call	(	const std::vector< llvm::Value * > &	args,
		llvm::IRBuilder<> &	B,
		const bool	cast
	)		const

inlineoverridevirtualinherited

Override of call which allocates the required SRET llvm::Value for this function.

Note: Unlike other function where the returned llvm::Value* is a llvm::CallInst (which also represents the return value), SRET functions return the allocated 1st argument i.e. not a llvm::CallInst

Reimplemented from CFunction< SignatureT >.

static void cast	(	std::vector< llvm::Value * > &	args,
		const std::vector< llvm::Type * > &	types,
		llvm::IRBuilder<> &	B
	)

staticprotectedinherited

Cast the provided arguments to the given type as supported by implicit casting of function types. If the types already match OR if a cast cannot be performed, nothing is done to the argument.

virtual llvm::Function* create	(	llvm::LLVMContext &	C,
		llvm::Module *	M = `nullptr`
	)		const

virtualinherited

Converts and creates this AX function into a llvm Function.

This method uses the result from Function::types() to construct a llvm::FunctionType and a subsequent a llvm::Function. Any parameter, return or function attributes are also added to the function. If a module is provided, the module if first checked to see if the function already exists. If it does, it is immediately returned. If the function doesn't exist in the module, its prototype is created and also inserted into the end of the modules function list. If no module is provided, the function is left detached and must be added to a valid Module to be callable.

Warning: If a module is not provided, the caller takes ownership of the returned function and is responsible for deallocating it.

Note: The body of the function is left to derived classes to implement. As you need a Module to generate the prototype/body, this function serves two purposes. The first is to return the detached function signature if only a context is provided. The second is to ensure the function prototype and body (if required) is inserted into the module prior to returning.; It is possible to end up with function symbol collisions if you do not have unique function symbols in your module

Parameters

C	The LLVM Context
M	The Module to write the function to

Reimplemented in IRFunctionBase.

llvm::Function* create ( llvm::Module & M ) const

inlineinherited

Convenience method which always uses the provided module to find the function or insert it if necessary.

Parameters

M	The llvm::Module to use

const std::vector<const char*>& dependencies ( ) const

inlineinherited

llvm::Value* fold	(	const std::vector< llvm::Value * > &	args,
		llvm::LLVMContext &	C
	)		const

inlinefinaloverridevirtualinherited

Reimplemented from CFunctionBase.

llvm::Function* get ( const llvm::Module & M ) const

inherited

Convenience method for calling M.getFunction(symbol). Returns a nullptr if the function has not yet been created or if it is embedded IR.

Parameters

M	The llvm::Module to use

bool hasConstantFold ( ) const

inlineinherited

bool hasParamAttribute	(	const size_t	i,
		const llvm::Attribute::AttrKind &	kind
	)		const

inlineinherited

Builder methods.

Function::SignatureMatch match	(	const std::vector< llvm::Type * > &	args,
		llvm::LLVMContext &	C
	)		const

inlineoverridevirtualinherited

Override of match which inserts the SRET type such that the base class methods ignore it.

Reimplemented from Function.

void print	(	llvm::LLVMContext &	C,
		std::ostream &	os,
		const char *	name = `nullptr`,
		const bool	axTypes = `true`
	)		const

inlineoverridevirtualinherited

Override of print to avoid printing out the SRET type.

Reimplemented from Function.

void setArgumentNames ( std::vector< const char * > names )

inlineinherited

void setConstantFold ( bool on )

inlineinherited

void setDependencies ( std::vector< const char * > deps )

inlineinherited

void setFnAttributes ( const std::vector< llvm::Attribute::AttrKind > & in )

inlineinherited

void setParamAttributes	(	const size_t	i,
		const std::vector< llvm::Attribute::AttrKind > &	in
	)

inlineinherited

void setRetAttributes ( const std::vector< llvm::Attribute::AttrKind > & in )

inlineinherited

size_t size ( ) const

inlineinherited

The number of arguments that this function has.

const char* symbol ( ) const

inlineinherited

The function symbol name.

This will be used as its identifier in IR and must be unique.

llvm::Type* types	(	std::vector< llvm::Type * > &	,
		llvm::LLVMContext &
	)		const

inlineoverridevirtualinherited

Populate a vector of llvm::Types which describe this function signature. This method is used by Function::create, Function::print and Function::match.

Implements Function.

Public Types

Public Member Functions

Static Protected Member Functions

Detailed Description

template<typename SignatureT> struct openvdb::v12_0::ax::codegen::CFunctionSRet< SignatureT >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename SignatureT>
struct openvdb::v12_0::ax::codegen::CFunctionSRet< SignatureT >