koffi 0.9.0

package/src/call_x64_sysv.cc

@@ -0,0 +1,477 @@
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+#if defined(__x86_64__) && !defined(_WIN64)
+
+#include "vendor/libcc/libcc.hh"
+#include "ffi.hh"
+#include "call.hh"
+#include "util.hh"
+
+#include <napi.h>
+
+namespace RG {
+
+enum class RegisterClass {
+    NoClass = 0, // Explicitly 0
+    Integer,
+    SSE,
+    Memory
+};
+
+struct RaxRdxRet {
+    uint64_t rax;
+    uint64_t rdx;
+};
+struct RaxXmm0Ret {
+    uint64_t rax;
+    double xmm0;
+};
+struct Xmm0RaxRet {
+    double xmm0;
+    uint64_t rax;
+};
+struct Xmm0Xmm1Ret {
+    double xmm0;
+    double xmm1;
+};
+
+extern "C" RaxRdxRet ForwardCallGG(const void *func, uint8_t *sp);
+extern "C" float ForwardCallF(const void *func, uint8_t *sp);
+extern "C" Xmm0RaxRet ForwardCallDG(const void *func, uint8_t *sp);
+extern "C" RaxXmm0Ret ForwardCallGD(const void *func, uint8_t *sp);
+extern "C" Xmm0Xmm1Ret ForwardCallDD(const void *func, uint8_t *sp);
+
+extern "C" RaxRdxRet ForwardCallXGG(const void *func, uint8_t *sp);
+extern "C" float ForwardCallXF(const void *func, uint8_t *sp);
+extern "C" Xmm0RaxRet ForwardCallXDG(const void *func, uint8_t *sp);
+extern "C" RaxXmm0Ret ForwardCallXGD(const void *func, uint8_t *sp);
+extern "C" Xmm0Xmm1Ret ForwardCallXDD(const void *func, uint8_t *sp);
+
+static inline RegisterClass MergeClasses(RegisterClass cls1, RegisterClass cls2)
+{
+    if (cls1 == cls2)
+        return cls1;
+
+    if (cls1 == RegisterClass::NoClass)
+        return cls2;
+    if (cls2 == RegisterClass::NoClass)
+        return cls1;
+
+    if (cls1 == RegisterClass::Memory || cls2 == RegisterClass::Memory)
+        return RegisterClass::Memory;
+    if (cls1 == RegisterClass::Integer || cls2 == RegisterClass::Integer)
+        return RegisterClass::Integer;
+
+    return RegisterClass::SSE;
+}
+
+static Size ClassifyType(const TypeInfo *type, Size offset, Span<RegisterClass> classes)
+{
+    RG_ASSERT(classes.len > 0);
+
+    switch (type->primitive) {
+        case PrimitiveKind::Void: { return 0; } break;
+
+        case PrimitiveKind::Bool:
+        case PrimitiveKind::Int8:
+        case PrimitiveKind::UInt8:
+        case PrimitiveKind::Int16:
+        case PrimitiveKind::UInt16:
+        case PrimitiveKind::Int32:
+        case PrimitiveKind::UInt32:
+        case PrimitiveKind::Int64:
+        case PrimitiveKind::UInt64:
+        case PrimitiveKind::String:
+        case PrimitiveKind::Pointer: {
+            classes[0] = MergeClasses(classes[0], RegisterClass::Integer);
+            return 1;
+        } break;
+
+        case PrimitiveKind::Float32:
+        case PrimitiveKind::Float64: {
+            classes[0] = MergeClasses(classes[0], RegisterClass::SSE);
+            return 1;
+        } break;
+
+        case PrimitiveKind::Record: {
+            if (type->size > 64) {
+                classes[0] = MergeClasses(classes[0], RegisterClass::Memory);
+                return 1;
+            }
+
+            for (const RecordMember &member: type->members) {
+                Size start = offset / 8;
+                ClassifyType(member.type, offset % 8, classes.Take(start, classes.len - start));
+                offset += member.type->size;
+            }
+
+            return (offset + 7) / 8;
+        } break;
+    }
+
+    RG_UNREACHABLE();
+}
+
+static void AnalyseParameter(ParameterInfo *param, int gpr_avail, int xmm_avail)
+{
+    LocalArray<RegisterClass, 8> classes = {};
+    classes.len = ClassifyType(param->type, 0, classes.data);
+
+    if (!classes.len)
+        return;
+    if (classes.len > 2) {
+        param->use_memory = true;
+        return;
+    }
+
+    int gpr_count = 0;
+    int xmm_count = 0;
+
+    for (RegisterClass cls: classes) {
+        RG_ASSERT(cls != RegisterClass::NoClass);
+
+        if (cls == RegisterClass::Memory) {
+            param->use_memory = true;
+            return;
+        }
+
+        gpr_count += (cls == RegisterClass::Integer);
+        xmm_count += (cls == RegisterClass::SSE);
+    }
+
+    if (gpr_count <= gpr_avail && xmm_count <= xmm_avail){
+        param->gpr_count = (int8_t)gpr_count;
+        param->xmm_count = (int8_t)xmm_count;
+        param->gpr_first = (classes[0] == RegisterClass::Integer);
+    } else {
+        param->use_memory = true;
+    }
+}
+
+bool AnalyseFunction(FunctionInfo *func)
+{
+    AnalyseParameter(&func->ret, 2, 2);
+
+    int gpr_avail = 6 - func->ret.use_memory;
+    int xmm_avail = 8;
+
+    for (ParameterInfo &param: func->parameters) {
+        AnalyseParameter(&param, gpr_avail, xmm_avail);
+
+        gpr_avail -= param.gpr_count;
+        xmm_avail -= param.xmm_count;
+    }
+
+    func->forward_fp = (xmm_avail < 8);
+
+    return true;
+}
+
+Napi::Value TranslateCall(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+    InstanceData *instance = env.GetInstanceData<InstanceData>();
+
+    FunctionInfo *func = (FunctionInfo *)info.Data();
+    LibraryData *lib = func->lib.get();
+
+    RG_DEFER { lib->tmp_alloc.ReleaseAll(); };
+
+    // Sanity checks
+    if (info.Length() < (uint32_t)func->parameters.len) {
+        ThrowError<Napi::TypeError>(env, "Expected %1 arguments, got %2", func->parameters.len, info.Length());
+        return env.Null();
+    }
+
+    // Stack pointer and register
+    uint8_t *top_ptr = lib->stack.end();
+    uint8_t *return_ptr = nullptr;
+    uint8_t *args_ptr = nullptr;
+    uint64_t *gpr_ptr = nullptr, *xmm_ptr = nullptr;
+    uint8_t *sp_ptr = nullptr;
+
+    // Return through registers unless it's too big
+    if (!func->ret.use_memory) {
+        args_ptr = top_ptr - func->scratch_size;
+        xmm_ptr = (uint64_t *)args_ptr - 8;
+        gpr_ptr = xmm_ptr - 6;
+        sp_ptr = (uint8_t *)gpr_ptr;
+
+#ifdef RG_DEBUG
+        memset(sp_ptr, 0, top_ptr - sp_ptr);
+#endif
+    } else {
+        return_ptr = top_ptr - AlignLen(func->ret.type->size, 16);
+
+        args_ptr = return_ptr - func->scratch_size;
+        xmm_ptr = (uint64_t *)args_ptr - 8;
+        gpr_ptr = xmm_ptr - 6;
+        sp_ptr = (uint8_t *)gpr_ptr;
+
+#ifdef RG_DEBUG
+        memset(sp_ptr, 0, top_ptr - sp_ptr);
+#endif
+
+        *(gpr_ptr++) = (uint64_t)return_ptr;
+    }
+
+    RG_ASSERT(AlignUp(lib->stack.ptr, 16) == lib->stack.ptr);
+    RG_ASSERT(AlignUp(lib->stack.end(), 16) == lib->stack.end());
+    RG_ASSERT(AlignUp(args_ptr, 16) == args_ptr);
+
+    // Push arguments
+    for (Size i = 0; i < func->parameters.len; i++) {
+        const ParameterInfo &param = func->parameters[i];
+        Napi::Value value = info[i];
+
+        switch (param.type->primitive) {
+            case PrimitiveKind::Void: { RG_UNREACHABLE(); } break;
+
+            case PrimitiveKind::Bool: {
+                if (RG_UNLIKELY(!value.IsBoolean())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argmument %2, expected boolean", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                bool b = value.As<Napi::Boolean>();
+
+                if (RG_LIKELY(param.gpr_count)) {
+                    *(gpr_ptr++) = (uint64_t)b;
+                } else {
+                    *(args_ptr++) = (uint8_t)b;
+                }
+            } break;
+            case PrimitiveKind::Int8:
+            case PrimitiveKind::UInt8:
+            case PrimitiveKind::Int16:
+            case PrimitiveKind::UInt16:
+            case PrimitiveKind::Int32:
+            case PrimitiveKind::UInt32:
+            case PrimitiveKind::Int64:
+            case PrimitiveKind::UInt64: {
+                if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                int64_t v = CopyNodeNumber<int64_t>(value);
+
+                if (RG_LIKELY(param.gpr_count)) {
+                    *(gpr_ptr++) = (uint64_t)v;
+                } else {
+                    args_ptr = AlignUp(args_ptr, param.type->align);
+                    memcpy(args_ptr, &v, param.type->size); // Little Endian
+                    args_ptr += param.type->size;
+                }
+            } break;
+            case PrimitiveKind::Float32: {
+                if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                float f = CopyNodeNumber<float>(value);
+
+                if (RG_LIKELY(param.xmm_count)) {
+                    memcpy(xmm_ptr++, &f, 4);
+                } else {
+                    args_ptr = AlignUp(args_ptr, 4);
+                    memcpy(args_ptr, &f, 4);
+                    args_ptr += 4;
+                }
+            } break;
+            case PrimitiveKind::Float64: {
+                if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                double d = CopyNodeNumber<double>(value);
+
+                if (RG_LIKELY(param.xmm_count)) {
+                    memcpy(xmm_ptr++, &d, 8);
+                } else {
+                    args_ptr = AlignUp(args_ptr, 8);
+                    memcpy(args_ptr, &d, 8);
+                    args_ptr += 8;
+                }
+            } break;
+            case PrimitiveKind::String: {
+                if (RG_UNLIKELY(!value.IsString())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected string", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                const char *str = CopyNodeString(value, &lib->tmp_alloc);
+
+                if (RG_LIKELY(param.gpr_count)) {
+                    *(gpr_ptr++) = (uint64_t)str;
+                } else {
+                    args_ptr = AlignUp(args_ptr, 8);
+                    *(uint64_t *)args_ptr = (uint64_t)str;
+                    args_ptr += 8;
+                }
+            } break;
+            case PrimitiveKind::Pointer: {
+                if (RG_UNLIKELY(!CheckValueTag(instance, value, param.type))) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected %3", GetValueType(instance, value), i + 1, param.type->name);
+                    return env.Null();
+                }
+
+                void *ptr = value.As<Napi::External<void>>();
+
+                if (RG_LIKELY(param.gpr_count)) {
+                    *(gpr_ptr++) = (uint64_t)ptr;
+                } else {
+                    args_ptr = AlignUp(args_ptr, 8);
+                    *(uint64_t *)args_ptr = (uint64_t)ptr;
+                    args_ptr += 8;
+                }
+            } break;
+
+            case PrimitiveKind::Record: {
+                if (RG_UNLIKELY(!value.IsObject())) {
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected object", GetValueType(instance, value), i + 1);
+                    return env.Null();
+                }
+
+                Napi::Object obj = value.As<Napi::Object>();
+
+                if (param.gpr_count || param.xmm_count) {
+                    RG_ASSERT(param.type->size <= 16);
+
+                    uint64_t buf[2] = {};
+                    if (!PushObject(obj, param.type, &lib->tmp_alloc, (uint8_t *)buf))
+                        return env.Null();
+
+                    if (param.gpr_first) {
+                        uint64_t *ptr = buf;
+
+                        *(gpr_ptr++) = *(ptr++);
+                        if (param.gpr_count == 2) {
+                            *(gpr_ptr++) = *(ptr++);
+                        } else if (param.xmm_count == 1) {
+                            *(xmm_ptr++) = *(ptr++);
+                        }
+                    } else {
+                        uint64_t *ptr = buf;
+
+                        *(xmm_ptr++) = *(ptr++);
+                        if (param.xmm_count == 2) {
+                            *(xmm_ptr++) = *(ptr++);
+                        } else if (param.gpr_count == 1) {
+                            *(gpr_ptr++) = *(ptr++);
+                        }
+                    }
+                } else if (param.use_memory) {
+                    args_ptr = AlignUp(args_ptr, param.type->align);
+                    if (!PushObject(obj, param.type, &lib->tmp_alloc, args_ptr))
+                        return env.Null();
+                    args_ptr += param.type->size;
+                }
+            } break;
+        }
+    }
+
+    // DumpStack(func, MakeSpan(sp_ptr, top_ptr - sp_ptr));
+
+#define PERFORM_CALL(Suffix) \
+        (func->forward_fp ? ForwardCallX ## Suffix(func->func, sp_ptr) \
+                          : ForwardCall ## Suffix(func->func, sp_ptr))
+
+    // Execute and convert return value
+    switch (func->ret.type->primitive) {
+        case PrimitiveKind::Float32: {
+            float f = PERFORM_CALL(F);
+
+            return Napi::Number::New(env, (double)f);
+        } break;
+
+        case PrimitiveKind::Float64: {
+            Xmm0RaxRet ret = PERFORM_CALL(DG);
+
+            return Napi::Number::New(env, ret.xmm0);
+        } break;
+
+        case PrimitiveKind::Record: {
+            if (func->ret.gpr_first && !func->ret.xmm_count) {
+                RaxRdxRet ret = PERFORM_CALL(GG);
+
+                Napi::Object obj = PopObject(env, (const uint8_t *)&ret, func->ret.type);
+                return obj;
+            } else if (func->ret.gpr_first) {
+                RaxXmm0Ret ret = PERFORM_CALL(GD);
+
+                Napi::Object obj = PopObject(env, (const uint8_t *)&ret, func->ret.type);
+                return obj;
+            } else if (func->ret.xmm_count) {
+                Xmm0RaxRet ret = PERFORM_CALL(DG);
+
+                Napi::Object obj = PopObject(env, (const uint8_t *)&ret, func->ret.type);
+                return obj;
+            } else if (func->ret.type->size) {
+                RG_ASSERT(return_ptr);
+
+                RaxRdxRet ret = PERFORM_CALL(GG);
+                RG_ASSERT(ret.rax == (uint64_t)return_ptr);
+
+                Napi::Object obj = PopObject(env, return_ptr, func->ret.type);
+                return obj;
+            } else {
+                PERFORM_CALL(GG);
+
+                Napi::Object obj = Napi::Object::New(env);
+                return obj;
+            }
+        } break;
+
+        default: {
+            RaxRdxRet ret = PERFORM_CALL(GG);
+
+            switch (func->ret.type->primitive) {
+                case PrimitiveKind::Void: return env.Null();
+                case PrimitiveKind::Bool: return Napi::Boolean::New(env, ret.rax);
+                case PrimitiveKind::Int8: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::UInt8: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::Int16: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::UInt16: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::Int32: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::UInt32: return Napi::Number::New(env, (double)ret.rax);
+                case PrimitiveKind::Int64: return Napi::BigInt::New(env, (int64_t)ret.rax);
+                case PrimitiveKind::UInt64: return Napi::BigInt::New(env, ret.rax);
+                case PrimitiveKind::Float32: { RG_UNREACHABLE(); } break;
+                case PrimitiveKind::Float64: { RG_UNREACHABLE(); } break;
+                case PrimitiveKind::String: return Napi::String::New(env, (const char *)ret.rax);
+                case PrimitiveKind::Pointer: {
+                    void *ptr = (void *)ret.rax;
+
+                    Napi::External<void> external = Napi::External<void>::New(env, ptr);
+                    SetValueTag(instance, external, func->ret.type);
+
+                    return external;
+                } break;
+
+                case PrimitiveKind::Record: { RG_UNREACHABLE(); } break;
+            }
+        } break;
+    }
+
+#undef PERFORM_CALL
+
+    RG_UNREACHABLE();
+}
+
+}
+
+#endif

package/src/call_x64_sysv_fwd.S

@@ -0,0 +1,131 @@
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+// These five are the same, but they differ (in the C side) by their return type.
+// Unlike the five next functions, these ones don't forward XMM argument registers.
+.global ForwardCallGG
+.global ForwardCallF
+.global ForwardCallDG
+.global ForwardCallGD
+.global ForwardCallDD
+
+// The X variants are slightly slower, and are used when XMM arguments must be forwarded.
+.global ForwardCallXGG
+.global ForwardCallXF
+.global ForwardCallXDG
+.global ForwardCallXGD
+.global ForwardCallXDD
+
+// Copy function pointer to RAX, in order to save it through argument forwarding.
+// Save RSP in RBX (non-volatile), and use carefully assembled stack provided by caller.
+.macro prologue
+    .cfi_startproc
+    .cfi_def_cfa rsp, 8
+    endbr64
+    movq %rdi, %rax
+    pushq %rbx
+    .cfi_def_cfa rsp, 16
+    movq %rsp, %rbx
+    .cfi_def_cfa rbx, 16
+    movq %rsi, %rsp
+    addq $112, %rsp
+.endm
+
+// Call native function.
+// Once done, restore normal stack pointer and return.
+// The return value is passed untouched through RAX or XMM0.
+.macro epilogue
+    call *%rax
+    movq %rbx, %rsp
+    popq %rbx
+    .cfi_def_cfa rsp, 8
+    ret
+    .cfi_endproc
+.endm
+
+// Prepare integer argument registers from array passed by caller.
+.macro forward_int
+    movq 40(%rsi), %r9
+    movq 32(%rsi), %r8
+    movq 24(%rsi), %rcx
+    movq 16(%rsi), %rdx
+    movq 0(%rsi), %rdi
+    movq 8(%rsi), %rsi
+.endm
+
+// Prepare XMM argument registers from array passed by caller.
+.macro forward_xmm
+    movsd 104(%rsi), %xmm7
+    movsd 96(%rsi), %xmm6
+    movsd 88(%rsi), %xmm5
+    movsd 80(%rsi), %xmm4
+    movsd 72(%rsi), %xmm3
+    movsd 64(%rsi), %xmm2
+    movsd 56(%rsi), %xmm1
+    movsd 48(%rsi), %xmm0
+.endm
+
+ForwardCallGG:
+    prologue
+    forward_int
+    epilogue
+
+ForwardCallF:
+    prologue
+    forward_int
+    epilogue
+
+ForwardCallDG:
+    prologue
+    forward_int
+    epilogue
+
+ForwardCallGD:
+    prologue
+    forward_int
+    epilogue
+
+ForwardCallDD:
+    prologue
+    forward_int
+    epilogue
+
+ForwardCallXGG:
+    prologue
+    forward_xmm
+    forward_int
+    epilogue
+
+ForwardCallXF:
+    prologue
+    forward_xmm
+    forward_int
+    epilogue
+
+ForwardCallXDG:
+    prologue
+    forward_xmm
+    forward_int
+    epilogue
+
+ForwardCallXGD:
+    prologue
+    forward_xmm
+    forward_int
+    epilogue
+
+ForwardCallXDD:
+    prologue
+    forward_xmm
+    forward_int
+    epilogue