AsmJit
Low-Latency Machine Code Generation
Docs
Interactive Parser
Support
GitHub
Index ⭢ X86 Backend ⭢ asmjit::x86::Compiler

asmjit::x86::Compiler Class Reference [¶]

Inheritance diagram for asmjit::x86::Compiler:
asmjit::BaseCompiler asmjit::x86::EmitterExplicitT< This > asmjit::BaseBuilder asmjit::BaseEmitter

X86/X64 compiler implementation.

Compiler Basics

The first x86::Compiler example shows how to generate a function that simply returns an integer value. It's an analogy to the first Assembler example:

#include <asmjit/x86.h>
#include <stdio.h>
using namespace asmjit;
int main() {
using Func = int (*)(void); // Signature of the generated function.
JitRuntime rt; // Runtime specialized for JIT code execution.
CodeHolder code; // Holds code and relocation information.
code.init(rt.environment(), // Initialize code to match the JIT environment.
rt.cpuFeatures());
x86::Compiler cc(&code); // Create and attach x86::Compiler to code.
cc.addFunc(FuncSignature::build<int>()); // Begin a function of `int fn(void)` signature.
x86::Gp vReg = cc.newGp32(); // Create a 32-bit general purpose register.
cc.mov(vReg, 1); // Move one to our virtual register `vReg`.
cc.ret(vReg); // Return `vReg` from the function.
cc.endFunc(); // End of the function body.
cc.finalize(); // Translate and assemble the whole 'cc' content.
// ----> x86::Compiler is no longer needed from here and can be destroyed <----
Func fn;
Error err = rt.add(&fn, &code); // Add the generated code to the runtime.
if (err) return 1; // Handle a possible error returned by AsmJit.
// ----> CodeHolder is no longer needed from here and can be destroyed <----
int result = fn(); // Execute the generated code.
printf("%d\n", result); // Print the resulting "1".
rt.release(fn); // Explicitly remove the function from the runtime.
return 0;
}

The BaseCompiler::addFunc() and BaseCompiler::endFunc() functions are used to define the function and its end. Both must be called per function, but the body doesn't have to be generated in sequence. An example of generating two functions will be shown later. The next example shows more complicated code that contain a loop and generates a simple memory copy function that uses uint32_t items:

#include <asmjit/x86.h>
#include <stdio.h>
using namespace asmjit;
int main() {
// Signature of the generated function.
using MemCpy32 = void (*)(uint32_t* dst, const uint32_t* src, size_t count);
JitRuntime rt; // Runtime specialized for JIT code execution.
CodeHolder code; // Holds code and relocation information.
code.init(rt.environment(), // Initialize code to match the JIT environment.
rt.cpuFeatures());
x86::Compiler cc(&code); // Create and attach x86::Compiler to code.
FuncNode* funcNode = cc.addFunc ( // Begin the function of the following signature:
FuncSignature::build<void, // Return value - void (no return value).
uint32_t*, // 1st argument - uint32_t* (machine reg-size).
const uint32_t*, // 2nd argument - uint32_t* (machine reg-size).
size_t>()); // 3rd argument - size_t (machine reg-size).
Label L_Loop = cc.newLabel(); // Start of the loop.
Label L_Exit = cc.newLabel(); // Used to exit early.
x86::Gp dst = cc.newIntPtr("dst"); // Create `dst` register (destination pointer).
x86::Gp src = cc.newIntPtr("src"); // Create `src` register (source pointer).
x86::Gp i = cc.newUIntPtr("i"); // Create `i` register (loop counter).
funcNode->setArg(0, dst); // Assign `dst` argument.
funcNode->setArg(1, src); // Assign `src` argument.
funcNode->setArg(2, i); // Assign `i` argument.
cc.test(i, i); // Early exit if length is zero.
cc.jz(L_Exit);
cc.bind(L_Loop); // Bind the beginning of the loop here.
x86::Gp tmp = cc.newInt32("tmp"); // Copy a single dword (4 bytes).
cc.mov(tmp, x86::dword_ptr(src)); // Load DWORD from [src] address.
cc.mov(x86::dword_ptr(dst), tmp); // Store DWORD to [dst] address.
cc.add(src, 4); // Increment `src`.
cc.add(dst, 4); // Increment `dst`.
cc.dec(i); // Loop until `i` is non-zero.
cc.jnz(L_Loop);
cc.bind(L_Exit); // Label used by early exit.
cc.endFunc(); // End of the function body.
cc.finalize(); // Translate and assemble the whole 'cc' content.
// ----> x86::Compiler is no longer needed from here and can be destroyed <----
// Add the generated code to the runtime.
MemCpy32 memcpy32;
Error err = rt.add(&memcpy32, &code);
// Handle a possible error returned by AsmJit.
if (err) {
return 1;
}
// ----> CodeHolder is no longer needed from here and can be destroyed <----
// Test the generated code.
uint32_t input[6] = { 1, 2, 3, 5, 8, 13 };
uint32_t output[6];
memcpy32(output, input, 6);
for (uint32_t i = 0; i < 6; i++) {
printf("%d\n", output[i]);
}
rt.release(memcpy32);
return 0;
}

AVX and AVX-512

AVX and AVX-512 code generation must be explicitly enabled via FuncFrame to work properly. If it's not setup correctly then Prolog & Epilog would use SSE instead of AVX instructions to work with SIMD registers. In addition, Compiler requires explicitly enable AVX-512 via FuncFrame in order to use all 32 SIMD registers.

#include <asmjit/x86.h>
#include <stdio.h>
using namespace asmjit;
int main() {
using Func = void (*)(void*); // Signature of the generated function.
JitRuntime rt; // Runtime specialized for JIT code execution.
CodeHolder code; // Holds code and relocation information.
code.init(rt.environment(), // Initialize code to match the JIT environment.
rt.cpuFeatures());
x86::Compiler cc(&code); // Create and attach x86::Compiler to code.
FuncNode* funcNode = cc.addFunc(FuncSignature::build<void, void*>());
// Use the following to enable AVX and/or AVX-512.
funcNode->frame().setAvxEnabled();
funcNode->frame().setAvx512Enabled();
// Do something with the input pointer.
x86::Gp addr = cc.newIntPtr("addr");
x86::Vec vreg = cc.newZmm("vreg");
funcNode->setArg(0, addr);
cc.vmovdqu32(vreg, x86::ptr(addr));
cc.vpaddq(vreg, vreg, vreg);
cc.vmovdqu32(x86::ptr(addr), vreg);
cc.endFunc(); // End of the function body.
cc.finalize(); // Translate and assemble the whole 'cc' content.
// ----> x86::Compiler is no longer needed from here and can be destroyed <----
Func fn;
Error err = rt.add(&fn, &code); // Add the generated code to the runtime.
if (err) return 1; // Handle a possible error returned by AsmJit.
// ----> CodeHolder is no longer needed from here and can be destroyed <----
// Execute the generated code and print some output.
uint64_t data[] = { 1, 2, 3, 4, 5, 6, 7, 8 };
fn(data);
printf("%llu\n", (unsigned long long)data[0]);
rt.release(fn); // Explicitly remove the function from the runtime.
return 0;
}

Recursive Functions

It's possible to create more functions by using the same x86::Compiler instance and make links between them. In such case it's important to keep the pointer to FuncNode.

The example below creates a simple Fibonacci function that calls itself recursively:

#include <asmjit/x86.h>
#include <stdio.h>
using namespace asmjit;
int main() {
using FibFn = uint32_t (*)(uint32_t x); // Signature of the generated function.
JitRuntime rt; // Runtime specialized for JIT code execution.
CodeHolder code; // Holds code and relocation information.
code.init(rt.environment(), // Initialize code to match the JIT environment.
rt.cpuFeatures());
x86::Compiler cc(&code); // Create and attach x86::Compiler to code.
FuncNode* funcNode = cc.addFunc( // Begin of the Fibonacci function, addFunc()
FuncSignature::build<int, int>()); // Returns a pointer to the FuncNode node.
Label L_Exit = cc.newLabel(); // Exit label.
x86::Gp x = cc.newUInt32(); // Function x argument.
x86::Gp y = cc.newUInt32(); // Temporary.
funcNode->setArg(0, x);
cc.cmp(x, 3); // Return x if less than 3.
cc.jb(L_Exit);
cc.mov(y, x); // Make copy of the original x.
cc.dec(x); // Decrease x.
InvokeNode* invokeNode; // Function invocation:
cc.invoke(&invokeNode, // - InvokeNode (output).
funcNode->label(), // - Function address or Label.
FuncSignature::build<int, int>()); // - Function signature.
invokeNode->setArg(0, x); // Assign x as the first argument.
invokeNode->setRet(0, x); // Assign x as a return value as well.
cc.add(x, y); // Combine the return value with y.
cc.bind(L_Exit);
cc.ret(x); // Return x.
cc.endFunc(); // End of the function body.
cc.finalize(); // Translate and assemble the whole 'cc' content.
// ----> x86::Compiler is no longer needed from here and can be destroyed <----
FibFn fib;
Error err = rt.add(&fib, &code); // Add the generated code to the runtime.
if (err) return 1; // Handle a possible error returned by AsmJit.
// ----> CodeHolder is no longer needed from here and can be destroyed <----
// Test the generated code.
printf("Fib(%u) -> %u\n", 8, fib(8));
rt.release(fib);
return 0;
}

Stack Management

Function's stack-frame is managed automatically, which is used by the register allocator to spill virtual registers. It also provides an interface to allocate user-defined block of the stack, which can be used as a temporary storage by the generated function. In the following example a stack of 256 bytes size is allocated, filled by bytes starting from 0 to 255 and then iterated again to sum all the values.

#include <asmjit/x86.h>
#include <stdio.h>
using namespace asmjit;
int main() {
using Func = int (*)(void); // Signature of the generated function.
JitRuntime rt; // Runtime specialized for JIT code execution.
CodeHolder code; // Holds code and relocation information.
code.init(rt.environment(), // Initialize code to match the JIT environment.
rt.cpuFeatures());
x86::Compiler cc(&code); // Create and attach x86::Compiler to code.
cc.addFunc(FuncSignature::build<int>()); // Create a function that returns int.
x86::Gp p = cc.newIntPtr("p");
x86::Gp i = cc.newIntPtr("i");
// Allocate 256 bytes on the stack aligned to 4 bytes.
x86::Mem stack = cc.newStack(256, 4);
x86::Mem stackIdx(stack); // Copy of stack with i added.
stackIdx.setIndex(i); // stackIdx <- stack[i].
stackIdx.setSize(1); // stackIdx <- byte ptr stack[i].
// Load a stack address to `p`. This step is purely optional and shows
// that `lea` is useful to load a memory operands address (even absolute)
// to a general purpose register.
cc.lea(p, stack);
// Clear i (xor is a C++ keyword, hence 'xor_' is used instead).
cc.xor_(i, i);
Label L1 = cc.newLabel();
Label L2 = cc.newLabel();
cc.bind(L1); // First loop, fill the stack.
cc.mov(stackIdx, i.r8()); // stack[i] = uint8_t(i).
cc.inc(i); // i++;
cc.cmp(i, 256); // if (i < 256)
cc.jb(L1); // goto L1;
// Second loop, sum all bytes stored in `stack`.
x86::Gp sum = cc.newInt32("sum");
x86::Gp val = cc.newInt32("val");
cc.xor_(i, i);
cc.xor_(sum, sum);
cc.bind(L2);
cc.movzx(val, stackIdx); // val = uint32_t(stack[i]);
cc.add(sum, val); // sum += val;
cc.inc(i); // i++;
cc.cmp(i, 256); // if (i < 256)
cc.jb(L2); // goto L2;
cc.ret(sum); // Return the `sum` of all values.
cc.endFunc(); // End of the function body.
cc.finalize(); // Translate and assemble the whole 'cc' content.
// ----> x86::Compiler is no longer needed from here and can be destroyed <----
Func func;
Error err = rt.add(&func, &code); // Add the generated code to the runtime.
if (err) return 1; // Handle a possible error returned by AsmJit.
// ----> CodeHolder is no longer needed from here and can be destroyed <----
printf("Func() -> %d\n", func()); // Test the generated code.
rt.release(func);
return 0;
}

Constant Pool

Compiler provides two constant pools for a general purpose code generation:

  • Local constant pool - Part of FuncNode, can be only used by a single function and added after the function epilog sequence (after ret instruction).
  • Global constant pool - Part of BaseCompiler, flushed at the end of the generated code by BaseEmitter::finalize().

The example below illustrates how a built-in constant pool can be used:

#include <asmjit/x86.h>
using namespace asmjit;
static void exampleUseOfConstPool(x86::Compiler& cc) {
cc.addFunc(FuncSignature::build<int>());
x86::Gp v0 = cc.newGp32("v0");
x86::Gp v1 = cc.newGp32("v1");
x86::Mem c0 = cc.newInt32Const(ConstPoolScope::kLocal, 200);
x86::Mem c1 = cc.newInt32Const(ConstPoolScope::kLocal, 33);
cc.mov(v0, c0);
cc.mov(v1, c1);
cc.add(v0, v1);
cc.ret(v0);
cc.endFunc();
}

Jump Tables

x86::Compiler supports jmp instruction with reg/mem operand, which is a commonly used pattern to implement indirect jumps within a function, for example to implement switch() statement in a programming languages. By default AsmJit assumes that every basic block can be a possible jump target as it's unable to deduce targets from instruction's operands. This is a very pessimistic default that should be avoided if possible as it's costly and very unfriendly to liveness analysis and register allocation.

Instead of relying on such pessimistic default behavior, let's use JumpAnnotation to annotate a jump where all targets are known:

#include <asmjit/x86.h>
using namespace asmjit;
static void exampleUseOfIndirectJump(x86::Compiler& cc) {
FuncNode* funcNode = cc.addFunc(FuncSignature::build<float, float, float, uint32_t>());
// Function arguments
x86::Vec a = cc.newXmmSs("a");
x86::Vec b = cc.newXmmSs("b");
x86::Gp op = cc.newUInt32("op");
x86::Gp target = cc.newIntPtr("target");
x86::Gp offset = cc.newIntPtr("offset");
Label L_Table = cc.newLabel();
Label L_Add = cc.newLabel();
Label L_Sub = cc.newLabel();
Label L_Mul = cc.newLabel();
Label L_Div = cc.newLabel();
Label L_End = cc.newLabel();
funcNode->setArg(0, a);
funcNode->setArg(1, b);
funcNode->setArg(2, op);
// Jump annotation is a building block that allows to annotate all possible targets where `jmp()` can
// jump. It then drives the CFG construction and liveness analysis, which impacts register allocation.
JumpAnnotation* annotation = cc.newJumpAnnotation();
annotation->addLabel(L_Add);
annotation->addLabel(L_Sub);
annotation->addLabel(L_Mul);
annotation->addLabel(L_Div);
// Most likely not the common indirect jump approach, but it
// doesn't really matter how final address is calculated. The
// most important path using JumpAnnotation with `jmp()`.
cc.lea(offset, x86::ptr(L_Table));
if (cc.is64Bit())
cc.movsxd(target, x86::dword_ptr(offset, op.cloneAs(offset), 2));
else
cc.mov(target, x86::dword_ptr(offset, op.cloneAs(offset), 2));
cc.add(target, offset);
cc.jmp(target, annotation);
// Acts like a switch() statement in C.
cc.bind(L_Add);
cc.addss(a, b);
cc.jmp(L_End);
cc.bind(L_Sub);
cc.subss(a, b);
cc.jmp(L_End);
cc.bind(L_Mul);
cc.mulss(a, b);
cc.jmp(L_End);
cc.bind(L_Div);
cc.divss(a, b);
cc.bind(L_End);
cc.ret(a);
cc.endFunc();
// Relative int32_t offsets of `L_XXX - L_Table`.
cc.bind(L_Table);
cc.embedLabelDelta(L_Add, L_Table, 4);
cc.embedLabelDelta(L_Sub, L_Table, 4);
cc.embedLabelDelta(L_Mul, L_Table, 4);
cc.embedLabelDelta(L_Div, L_Table, 4);
}

Public Types

using Base = BaseCompiler
- Public Types inherited from asmjit::BaseCompiler
- Public Types inherited from asmjit::BaseBuilder

Member Functions

Compiler(const Compiler& other) = delete
Compiler& operator=(const Compiler& other) = delete
Construction & Destruction
Compiler(CodeHolder* code = nullptr) noexcept
~Compiler() noexcept override
Virtual Registers
template<typename RegT>
RegT newSimilarReg(const RegT& ref)
template<typename RegT, typename... Args>
RegT newSimilarReg(const RegT& ref, const char* fmt, Args&&... args)
Reg newReg(TypeId typeId)
template<typename... Args>
Reg newReg(TypeId typeId, const char* fmt, Args&&... args)
Gp newGp(TypeId typeId)
template<typename... Args>
Gp newGp(TypeId typeId, const char* fmt, Args&&... args)
Vec newVec(TypeId typeId)
template<typename... Args>
Vec newVec(TypeId typeId, const char* fmt, Args&&... args)
KReg newK(TypeId typeId)
template<typename... Args>
KReg newK(TypeId typeId, const char* fmt, Args&&... args)
Gp newInt8()
template<typename... Args>
Gp newInt8(const char* fmt, Args&&... args)
Gp newUInt8()
template<typename... Args>
Gp newUInt8(const char* fmt, Args&&... args)
Gp newInt16()
template<typename... Args>
Gp newInt16(const char* fmt, Args&&... args)
Gp newUInt16()
template<typename... Args>
Gp newUInt16(const char* fmt, Args&&... args)
Gp newInt32()
template<typename... Args>
Gp newInt32(const char* fmt, Args&&... args)
Gp newUInt32()
template<typename... Args>
Gp newUInt32(const char* fmt, Args&&... args)
Gp newInt64()
template<typename... Args>
Gp newInt64(const char* fmt, Args&&... args)
Gp newUInt64()
template<typename... Args>
Gp newUInt64(const char* fmt, Args&&... args)
Gp newIntPtr()
template<typename... Args>
Gp newIntPtr(const char* fmt, Args&&... args)
Gp newUIntPtr()
template<typename... Args>
Gp newUIntPtr(const char* fmt, Args&&... args)
Gp newGp8()
template<typename... Args>
Gp newGp8(const char* fmt, Args&&... args)
Gp newGp16()
template<typename... Args>
Gp newGp16(const char* fmt, Args&&... args)
Gp newGp32()
template<typename... Args>
Gp newGp32(const char* fmt, Args&&... args)
Gp newGp64()
template<typename... Args>
Gp newGp64(const char* fmt, Args&&... args)
Gp newGpb()
template<typename... Args>
Gp newGpb(const char* fmt, Args&&... args)
Gp newGpw()
template<typename... Args>
Gp newGpw(const char* fmt, Args&&... args)
Gp newGpd()
template<typename... Args>
Gp newGpd(const char* fmt, Args&&... args)
Gp newGpq()
template<typename... Args>
Gp newGpq(const char* fmt, Args&&... args)
Gp newGpz()
template<typename... Args>
Gp newGpz(const char* fmt, Args&&... args)
Vec newXmm()
template<typename... Args>
Vec newXmm(const char* fmt, Args&&... args)
Vec newXmmSs()
template<typename... Args>
Vec newXmmSs(const char* fmt, Args&&... args)
Vec newXmmSd()
template<typename... Args>
Vec newXmmSd(const char* fmt, Args&&... args)
Vec newXmmPs()
template<typename... Args>
Vec newXmmPs(const char* fmt, Args&&... args)
Vec newXmmPd()
template<typename... Args>
Vec newXmmPd(const char* fmt, Args&&... args)
Vec newYmm()
template<typename... Args>
Vec newYmm(const char* fmt, Args&&... args)
Vec newYmmPs()
template<typename... Args>
Vec newYmmPs(const char* fmt, Args&&... args)
Vec newYmmPd()
template<typename... Args>
Vec newYmmPd(const char* fmt, Args&&... args)
Vec newZmm()
template<typename... Args>
Vec newZmm(const char* fmt, Args&&... args)
Vec newZmmPs()
template<typename... Args>
Vec newZmmPs(const char* fmt, Args&&... args)
Vec newZmmPd()
template<typename... Args>
Vec newZmmPd(const char* fmt, Args&&... args)
Mm newMm()
template<typename... Args>
Mm newMm(const char* fmt, Args&&... args)
KReg newKb()
template<typename... Args>
KReg newKb(const char* fmt, Args&&... args)
KReg newKw()
template<typename... Args>
KReg newKw(const char* fmt, Args&&... args)
KReg newKd()
template<typename... Args>
KReg newKd(const char* fmt, Args&&... args)
KReg newKq()
template<typename... Args>
KReg newKq(const char* fmt, Args&&... args)
Stack
Mem newStack(uint32_t size, uint32_t alignment, const char* name = nullptr)
Constants
Mem newConst(ConstPoolScope scope, const void* data, size_t size)
Mem newByteConst(ConstPoolScope scope, uint8_t val) noexcept
Mem newWordConst(ConstPoolScope scope, uint16_t val) noexcept
Mem newDWordConst(ConstPoolScope scope, uint32_t val) noexcept
Mem newQWordConst(ConstPoolScope scope, uint64_t val) noexcept
Mem newInt16Const(ConstPoolScope scope, int16_t val) noexcept
Mem newUInt16Const(ConstPoolScope scope, uint16_t val) noexcept
Mem newInt32Const(ConstPoolScope scope, int32_t val) noexcept
Mem newUInt32Const(ConstPoolScope scope, uint32_t val) noexcept
Mem newInt64Const(ConstPoolScope scope, int64_t val) noexcept
Mem newUInt64Const(ConstPoolScope scope, uint64_t val) noexcept
Mem newFloatConst(ConstPoolScope scope, float val) noexcept
Mem newDoubleConst(ConstPoolScope scope, double val) noexcept
Instruction Options
Compiler& unfollow() noexcept
Compiler& overwrite() noexcept
Function Call & Ret Intrinsics
Error invoke_(InvokeNode** out, const Operand_& target, const FuncSignature& signature)
Error invoke(InvokeNode** out, const Gp& target, const FuncSignature& signature)
Error invoke(InvokeNode** out, const Mem& target, const FuncSignature& signature)
Error invoke(InvokeNode** out, const Label& target, const FuncSignature& signature)
Error invoke(InvokeNode** out, const Imm& target, const FuncSignature& signature)
Error invoke(InvokeNode** out, uint64_t target, const FuncSignature& signature)
Error ret()
Error ret(const Reg& o0)
Error ret(const Reg& o0, const Reg& o1)
Jump Tables Support
Error jmp(const Reg& target, JumpAnnotation* annotation)
Error jmp(const BaseMem& target, JumpAnnotation* annotation)
Events
Error onAttach(CodeHolder& code) noexcept override
Error onDetach(CodeHolder& code) noexcept override
Error onReinit(CodeHolder& code) noexcept override
Finalize
Error finalize() override
- Public Member Functions inherited from asmjit::BaseCompiler
- Public Member Functions inherited from asmjit::BaseBuilder
- Public Member Functions inherited from asmjit::BaseEmitter
- Public Member Functions inherited from asmjit::x86::EmitterExplicitT< This >

Mem x86::Compiler::newStack(
uint32_t size,
uint32_t alignment,
const char* name = nullptr
)[¶]

Creates a new memory chunk allocated on the current function's stack.

Mem x86::Compiler::newConst(
ConstPoolScope scope,
const void* data,
size_t size
)[¶]

Put data to a constant-pool and get a memory reference to it.

Mem x86::Compiler::newByteConst(
ConstPoolScope scope,
uint8_t val
)noexcept[¶]

Put a BYTE val to a constant-pool.

Mem x86::Compiler::newWordConst(
ConstPoolScope scope,
uint16_t val
)noexcept[¶]

Put a WORD val to a constant-pool.

Mem x86::Compiler::newDWordConst(
ConstPoolScope scope,
uint32_t val
)noexcept[¶]

Put a DWORD val to a constant-pool.

Mem x86::Compiler::newQWordConst(
ConstPoolScope scope,
uint64_t val
)noexcept[¶]

Put a QWORD val to a constant-pool.

Mem x86::Compiler::newInt16Const(
ConstPoolScope scope,
int16_t val
)noexcept[¶]

Put a WORD val to a constant-pool.

Mem x86::Compiler::newUInt16Const(
ConstPoolScope scope,
uint16_t val
)noexcept[¶]

Put a WORD val to a constant-pool.

Mem x86::Compiler::newInt32Const(
ConstPoolScope scope,
int32_t val
)noexcept[¶]

Put a DWORD val to a constant-pool.

Mem x86::Compiler::newUInt32Const(
ConstPoolScope scope,
uint32_t val
)noexcept[¶]

Put a DWORD val to a constant-pool.

Mem x86::Compiler::newInt64Const(
ConstPoolScope scope,
int64_t val
)noexcept[¶]

Put a QWORD val to a constant-pool.

Mem x86::Compiler::newUInt64Const(
ConstPoolScope scope,
uint64_t val
)noexcept[¶]

Put a QWORD val to a constant-pool.

Mem x86::Compiler::newFloatConst(
ConstPoolScope scope,
float val
)noexcept[¶]

Put a SP-FP val to a constant-pool.

Mem x86::Compiler::newDoubleConst(
ConstPoolScope scope,
double val
)noexcept[¶]

Put a DP-FP val to a constant-pool.

Compiler& x86::Compiler::unfollow()noexcept[¶]

Force the compiler to not follow the conditional or unconditional jump.

Compiler& x86::Compiler::overwrite()noexcept[¶]

Tell the compiler that the destination variable will be overwritten.

Error x86::Compiler::invoke_(
InvokeNode** out,
const Operand_& target,
const FuncSignature& signature
)[¶]

Invoke a function call without target type enforcement.

Error x86::Compiler::invoke(
InvokeNode** out,
const Gp& target,
const FuncSignature& signature
)[1/5][¶]

Invoke a function call of the given target and signature and store the added node to out.

Creates a new InvokeNode, initializes all the necessary members to match the given function signature, adds the node to the compiler, and stores its pointer to out. The operation is atomic, if anything fails nullptr is stored in out and error code is returned.

Error x86::Compiler::invoke(
InvokeNode** out,
const Mem& target,
const FuncSignature& signature
)[2/5][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::invoke(
InvokeNode** out,
const Label& target,
const FuncSignature& signature
)[3/5][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::invoke(
InvokeNode** out,
const Imm& target,
const FuncSignature& signature
)[4/5][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::invoke(
InvokeNode** out,
uint64_t target,
const FuncSignature& signature
)[5/5][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::ret()[1/3][¶]

Return from function.

Error x86::Compiler::ret(
const Reg& o0
)[2/3][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::ret(
const Reg& o0,
const Reg& o1
)[3/3][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::jmp(
const Reg& target,
JumpAnnotation* annotation
)[1/2][¶]

Adds a jump to the given target with the provided jump annotation.

Error x86::Compiler::jmp(
const BaseMem& target,
JumpAnnotation* annotation
)[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Error x86::Compiler::onAttach(
CodeHolder& code
)overridenoexcept[¶]

Called after the emitter was attached to CodeHolder.

Reimplemented from asmjit::BaseCompiler.

Error x86::Compiler::onDetach(
CodeHolder& code
)overridenoexcept[¶]

Called after the emitter was detached from CodeHolder.

Reimplemented from asmjit::BaseCompiler.

Error x86::Compiler::onReinit(
CodeHolder& code
)overridenoexcept[¶]

Called when CodeHolder is reinitialized when the emitter is attached.

Reimplemented from asmjit::BaseCompiler.

Error x86::Compiler::finalize()override[¶]

Finalizes this emitter.

Materializes the content of the emitter by serializing it to the attached CodeHolder through an architecture specific BaseAssembler. This function won't do anything if the emitter inherits from BaseAssembler as assemblers emit directly to a CodeBuffer held by CodeHolder. However, if this is an emitter that inherits from BaseBuilder or BaseCompiler then these emitters need the materialization phase as they store their content in a representation not visible to CodeHolder.

Reimplemented from asmjit::BaseEmitter.

© 2018-2024 AsmJit Authors | GitHub | Chat | Blog

AsmJit and AsmTK libraries are open source software released under the Zlib license and can be used safely in any open-source or commercial product, statically or dynamically linked, and without having to advertise the use of the libraries. Code snippets and examples are released into public domain, see Unlicense for more details.