AsmJit
Low-Latency Machine Code Generation
Function
Function definitions.
Overview
AsmJit provides functionality that can be used to define function signatures and to calculate automatically optimal function frame that can be used directly by a prolog and epilog insertion. This feature was exclusive to AsmJit's Compiler for a very long time, but was abstracted out and is now available for all users regardless of the emitter they use. The following use cases are possible:
- Calculate function frame before the function is generated - this is the only way available to BaseAssembler users and it will be described in this section.
- Calculate function frame after the function is generated - this way is generally used by BaseBuilder and BaseCompiler emitters and this way is generally described in Compiler section.
The following concepts are used to describe and create functions in AsmJit:
- TypeId - Type-id is an 8-bit value that describes a platform independent type as we know from C/C++. It provides abstractions for most common types like
int8_t,uint32_t,uintptr_t,float,double, and all possible vector types to match ISAs up to AVX512. TypeId was introduced originally for Compiler, but it's now used by FuncSignature as well. - CallConv - Describes a calling convention - this class contains instructions to assign registers and stack addresses to function arguments and return value(s), but doesn't specify any function signature itself. Calling conventions are architecture and OS dependent.
- FuncSignature - Describes a function signature, for example
int func(int, int). FuncSignature contains a function calling convention id, return value type, and function arguments. The signature itself is platform independent and uses TypeId to describe types of function arguments and function return value(s). - FuncDetail - Architecture and ABI dependent information that describes CallConv and expanded FuncSignature. Each function argument and return value is represented as FuncValue that contains the original TypeId enriched with additional information that specifies whether the value is passed or returned by register (and which register) or by stack. Each value also contains some other metadata that provide additional information required to handle it properly (for example whether a vector is passed indirectly by a pointer as required by WIN64 calling convention).
- FuncFrame - Contains information about the function frame that can be used by prolog/epilog inserter (PEI). Holds call stack size size and alignment, local stack size and alignment, and various attributes that describe how prolog and epilog should be constructed.
FuncFramedoesn't know anything about function's arguments or return values, it hold only information necessary to create a valid and ABI conforming function prologs and epilogs. - FuncArgsAssignment - A helper class that can be used to reassign function arguments into user specified registers. It's architecture and ABI dependent mapping from function arguments described by CallConv and FuncDetail into registers specified by the user.
It's a lot of concepts where each represents one step in a function frame calculation. It can be used to create function prologs, epilogs, and also to calculate information necessary to perform function calls.
Classes
struct CallConv
union CallConv::RegOrder
struct FuncSignature
struct FuncValue
struct FuncValuePack
class FuncDetail
class FuncFrame
class FuncArgsAssignment
Enumerations
enum class CallConvId : uint8_t
enum class CallConvStrategy : uint8_t
enum class CallConvFlags : uint32_t
enum class FuncAttributes : uint32_t
class CallConvId : uint8_tenumstrong[¶]
Calling convention id.
Calling conventions can be divided into the following groups:
- Universal - calling conventions are applicable to any target. They will be converted to a target dependent calling convention at runtime by CallConv::init() with some help from Environment. The purpose of these calling conventions is to make using functions less target dependent and closer to C and C++.
- Target specific - calling conventions that are used by a particular architecture and ABI. For example Windows 64-bit calling convention and AMD64 SystemV calling convention.
| Constant | Description |
|---|---|
| kCDecl | Standard function call or explicit This is a universal calling convention, which is used to initialize specific calling conventions based on architecture, platform, and its ABI. |
| kStdCall |
|
| kFastCall |
|
| kVectorCall |
|
| kThisCall |
|
| kRegParm1 |
|
| kRegParm2 |
|
| kRegParm3 |
|
| kLightCall2 | AsmJit specific calling convention designed for calling functions inside a multimedia code that don't use many registers internally, but are long enough to be called and not inlined. These functions are usually used to calculate trigonometric functions, logarithms, etc... |
| kSoftFloat | Soft-float calling convention (AArch32). Floating point arguments are passed via general purpose registers. |
| kHardFloat | Hard-float calling convention (AArch32). Floating point arguments are passed via SIMD registers. |
| kX64SystemV | X64 System-V calling convention. |
| kX64Windows | X64 Windows calling convention. |
| kMaxValue | Maximum value of |
class CallConvStrategy : uint8_tenumstrong[¶]
Strategy used by calling conventions to assign registers to function arguments.
Calling convention strategy describes how AsmJit should convert function arguments used by FuncSignature into register identifiers and stack offsets. The CallConvStrategy::kDefault strategy assigns registers and then stack whereas CallConvStrategy::kX64Windows strategy does register shadowing as defined by WIN64 calling convention, which is only used by 64-bit Windows.
class CallConvFlags : uint32_tenumstrong[¶]
Calling convention flags.
class FuncAttributes : uint32_tenumstrong[¶]
Attributes are designed in a way that all are initially false, and user or FuncFrame finalizer adds them when necessary.