|
| CFunction (const std::string &symbol, SignatureT *function) |
|
| ~CFunction () override=default |
|
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 * | call (const std::vector< llvm::Value * > &args, llvm::IRBuilder<> &B, const bool cast) const override |
| Uses the IRBuilder to create a call to this function with the given arguments, creating the function and inserting it into the IRBuilder's Module if necessary (through Function::create). Returns the result of the function call which can be a nullptr if the function is a non-sret void call. 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...
|
|
virtual SignatureMatch | match (const std::vector< llvm::Type * > &inputs, llvm::LLVMContext &C) const |
| The base implementation for determining how a vector of llvm arguments translates to this functions signature. Returns an enum which represents the available mapping. 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...
|
|
virtual void | print (llvm::LLVMContext &C, std::ostream &os, const char *name=nullptr, const bool axTypes=true) const |
| Print this function's signature to the provided ostream. 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) |
|
template<typename SignatureT>
struct openvdb::v12_0::ax::codegen::CFunction< SignatureT >
Represents a concrete C function binding.
- Note
- This struct is templated on the signature to allow for evaluation of the arguments to llvm types from any llvm context.
llvm::Value* call |
( |
const std::vector< llvm::Value * > & |
args, |
|
|
llvm::IRBuilder<> & |
B, |
|
|
const bool |
cast |
|
) |
| const |
|
inlineoverridevirtual |
Uses the IRBuilder to create a call to this function with the given arguments, creating the function and inserting it into the IRBuilder's Module if necessary (through Function::create). Returns the result of the function call which can be a nullptr if the function is a non-sret void call.
- Note
- The IRBuilder must have a valid llvm Module/Function/Block attached
-
If the number of provided arguments do not match the size of the current function, invalid IR will be generated.
-
If the provided argument types do not match the current function and cast is false, invalid IR will be generated. Additionally, invalid IR will be generated if cast is true but no valid cast exists for a given argument.
-
When casting arguments, the readonly flags of the function are not checked (unlike Function::match). Casting an argument will cause a new copy of the argument to be created and passed to the function. These new values do not propagate back any changes to the original argument. Separate functions for all writable argument types must be created.
- Parameters
-
args | The llvm Value arguments to call this function with |
B | The llvm IRBuilder |
cast | Whether to allow implicit casting of arguments |
Reimplemented from Function.
Reimplemented in SRetFunction< SignatureT, CFunction< SignatureT > >.
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.
virtual SignatureMatch match |
( |
const std::vector< llvm::Type * > & |
inputs, |
|
|
llvm::LLVMContext & |
C |
|
) |
| const |
|
virtualinherited |
The base implementation for determining how a vector of llvm arguments translates to this functions signature. Returns an enum which represents the available mapping.
This method calls types() to figure out the function signature, then compares each argument type to the type in the input vector. If the types match exactly, an Explicit match is found. If the sizes of the inputs and signature differ, no match is found and None is returned. If however, the sizes match and there exists a valid implicit cast from the input type to the signature type for every input, an Implicit match is returned. Finally, if the sizes match but there is no implicit cast mapping, Size is returned. i8 -> i32 : Implicit i32 -> i32 : Explicit str -> i32 : Size (i32,i32) -> i32 : None
- Note
- Due to the way CFunctionSRet is implemented, the LLVM Context must be provided in case we have a zero arg function signature with a SRET.
- Parameters
-
inputs | The input types |
C | The LLVM Context |
Reimplemented in SRetFunction< SignatureT, CFunction< SignatureT > >, and SRetFunction< SignatureT, IRFunction< SignatureT > >.