koffi 2.14.1 → 2.15.1

package/src/koffi/src/abi_x64_win_asm.S

@@ -0,0 +1,162 @@
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
+
+#define SYMBOL(Symbol) Symbol
+
+# Forward
+# ----------------------------
+
+.global ForwardCallG
+.global ForwardCallF
+.global ForwardCallD
+.global ForwardCallXG
+.global ForwardCallXF
+.global ForwardCallXD
+
+# Copy function pointer to RAX, in order to save it through argument forwarding.
+# Also make a copy of the SP to CallData::old_sp because the callback system might need it.
+# Save RSP in RBX (non-volatile), and use carefully assembled stack provided by caller.
+.macro prologue
+    endbr64
+    movq %rcx, %rax
+    push %rbp
+    movq %rsp, %rbp
+    movq %rsp, (%r8)
+    movq %rdx, %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 %rbp, %rsp
+    pop %rbp
+    ret
+.endm
+
+# Prepare integer argument registers from array passed by caller.
+.macro forward_gpr
+    movq 24(%rdx), %r9
+    movq 16(%rdx), %r8
+    movq 0(%rdx), %rcx
+    movq 8(%rdx), %rdx
+.endm
+
+# Prepare XMM argument registers from array passed by caller.
+.macro forward_xmm
+    movsd 24(%rdx), %xmm3
+    movsd 16(%rdx), %xmm2
+    movsd 8(%rdx), %xmm1
+    movsd 0(%rdx), %xmm0
+.endm
+
+ForwardCallG:
+    prologue
+    forward_gpr
+    epilogue
+
+ForwardCallF:
+    prologue
+    forward_gpr
+    epilogue
+
+ForwardCallD:
+    prologue
+    forward_gpr
+    epilogue
+
+ForwardCallXG:
+    prologue
+    forward_xmm
+    forward_gpr
+    epilogue
+
+ForwardCallXF:
+    prologue
+    forward_xmm
+    forward_gpr
+    epilogue
+
+ForwardCallXD:
+    prologue
+    forward_xmm
+    forward_gpr
+    epilogue
+
+# Callbacks
+# ----------------------------
+
+.global RelayCallback
+.global CallSwitchStack
+
+# First, make a copy of the GPR argument registers (rcx, rdx, r8, r9).
+# Then call the C function RelayCallback with the following arguments:
+# static trampoline ID, a pointer to the saved GPR array, a pointer to the stack
+# arguments of this call, and a pointer to a struct that will contain the result registers.
+# After the call, simply load these registers from the output struct.
+.macro trampoline id
+    endbr64
+    subq $120, %rsp
+    movq %rcx, 32(%rsp)
+    movq %rdx, 40(%rsp)
+    movq %r8, 48(%rsp)
+    movq %r9, 56(%rsp)
+    movq $\id, %rcx
+    leaq 32(%rsp), %rdx
+    leaq 160(%rsp), %r8
+    leaq 96(%rsp), %r9
+    call RelayCallback
+    movq 96(%rsp), %rax
+    addq $120, %rsp
+    ret
+.endm
+
+# Same thing, but also forward the XMM argument registers and load the XMM result registers.
+.macro trampoline_vec id
+    endbr64
+    subq $120, %rsp
+    movq %rcx, 32(%rsp)
+    movq %rdx, 40(%rsp)
+    movq %r8, 48(%rsp)
+    movq %r9, 56(%rsp)
+    movsd %xmm0, 64(%rsp)
+    movsd %xmm1, 72(%rsp)
+    movsd %xmm2, 80(%rsp)
+    movsd %xmm3, 88(%rsp)
+    movq $\id, %rcx
+    leaq 32(%rsp), %rdx
+    leaq 160(%rsp), %r8
+    leaq 96(%rsp), %r9
+    call RelayCallback
+    movq 96(%rsp), %rax
+    movsd 104(%rsp), %xmm0
+    addq $120, %rsp
+    ret
+.endm
+
+# When a callback is relayed, Koffi will call into Node.js and V8 to execute Javascript.
+# The problem is that we're still running on the separate Koffi stack, and V8 will
+# probably misdetect this as a "stack overflow". We have to restore the old
+# stack pointer, call Node.js/V8 and go back to ours.
+# The first three parameters (rcx, rdx, r8) are passed through untouched.
+CallSwitchStack:
+    endbr64
+    push %rbp
+    movq %rsp, %rbp
+    movq 56(%rsp), %rax
+    movq %rsp, %r10
+    movq 48(%rsp), %r11
+    subq 0(%r11), %r10
+    andq $-16, %r10
+    movq %r10, 8(%r11)
+    leaq -32(%r9), %rsp
+    call *%rax
+    movq %rbp, %rsp
+    pop %rbp
+    ret
+
+# Trampolines
+# ----------------------------
+
+#include "trampolines/gnu.inc"

package/src/koffi/src/abi_x64_win_asm.asm

@@ -1,23 +1,5 @@
-; Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-;
-; Permission is hereby granted, free of charge, to any person obtaining a copy of
-; this software and associated documentation files (the “Software”), to deal in
-; the Software without restriction, including without limitation the rights to use,
-; copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-; Software, and to permit persons to whom the Software is furnished to do so,
-; subject to the following conditions:
-;
-; The above copyright notice and this permission notice shall be included in all
-; copies or substantial portions of the Software.
-;
-; THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-; OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-; HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-; WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-; OTHER DEALINGS IN THE SOFTWARE.
+; SPDX-License-Identifier: MIT
+; SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 ; Forward
 ; ----------------------------

package/src/koffi/src/abi_x86.cc

@@ -1,27 +1,9 @@
-// Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of
-// this software and associated documentation files (the “Software”), to deal in
-// the Software without restriction, including without limitation the rights to use,
-// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-// Software, and to permit persons to whom the Software is furnished to do so,
-// subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 #if defined(__i386__) || defined(_M_IX86)
 
-#include "src/core/base/base.hh"
+#include "lib/native/base/base.hh"
 #include "ffi.hh"
 #include "call.hh"
 #include "util.hh"
@@ -438,7 +420,7 @@ Napi::Value CallData::Complete(const FunctionInfo *func)
         case PrimitiveKind::Callback: {
             if (result.ptr) {
                 Napi::External<void> external = Napi::External<void>::New(env, result.ptr);
-                SetValueTag(instance, external, func->ret.type->ref.marker);
+                SetValueTag(external, func->ret.type->ref.marker);
 
                 return external;
             } else {
@@ -660,7 +642,7 @@ void CallData::Relay(Size idx, uint8_t *, uint8_t *caller_sp, bool switch_stack,
 
                 if (ptr2) {
                     Napi::External<void> external = Napi::External<void>::New(env, ptr2);
-                    SetValueTag(instance, external, param.type->ref.marker);
+                    SetValueTag(external, param.type->ref.marker);
 
                     arguments.Append(external);
                 } else {
@@ -810,7 +792,7 @@ void CallData::Relay(Size idx, uint8_t *, uint8_t *caller_sp, bool switch_stack,
         case PrimitiveKind::Pointer: {
             uint8_t *ptr;
 
-            if (CheckValueTag(instance, value, type->ref.marker)) {
+            if (CheckValueTag(value, type->ref.marker)) {
                 ptr = value.As<Napi::External<uint8_t>>().Data();
             } else if (IsObject(value) && (type->ref.type->primitive == PrimitiveKind::Record ||
                                            type->ref.type->primitive == PrimitiveKind::Union)) {
@@ -874,7 +856,7 @@ void CallData::Relay(Size idx, uint8_t *, uint8_t *caller_sp, bool switch_stack,
                 ptr = ReserveTrampoline(type->ref.proto, func2);
                 if (!ptr) [[unlikely]]
                     return;
-            } else if (CheckValueTag(instance, value, type->ref.marker)) {
+            } else if (CheckValueTag(value, type->ref.marker)) {
                 ptr = value.As<Napi::External<void>>().Data();
             } else if (IsNullOrUndefined(value)) {
                 ptr = nullptr;

package/src/koffi/src/abi_x86_asm.S

@@ -1,23 +1,5 @@
-# Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy of
-# this software and associated documentation files (the “Software”), to deal in
-# the Software without restriction, including without limitation the rights to use,
-# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-# Software, and to permit persons to whom the Software is furnished to do so,
-# subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-# OTHER DEALINGS IN THE SOFTWARE.
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 #define SYMBOL(Symbol) Symbol
 

package/src/koffi/src/abi_x86_asm.asm

@@ -1,23 +1,5 @@
-; Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-;
-; Permission is hereby granted, free of charge, to any person obtaining a copy of
-; this software and associated documentation files (the “Software”), to deal in
-; the Software without restriction, including without limitation the rights to use,
-; copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-; Software, and to permit persons to whom the Software is furnished to do so,
-; subject to the following conditions:
-;
-; The above copyright notice and this permission notice shall be included in all
-; copies or substantial portions of the Software.
-;
-; THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-; OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-; HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-; WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-; OTHER DEALINGS IN THE SOFTWARE.
+; SPDX-License-Identifier: MIT
+; SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 ; Forward
 ; ----------------------------

package/src/koffi/src/call.cc

@@ -1,25 +1,7 @@
-// Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of
-// this software and associated documentation files (the “Software”), to deal in
-// the Software without restriction, including without limitation the rights to use,
-// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-// Software, and to permit persons to whom the Software is furnished to do so,
-// subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
-
-#include "src/core/base/base.hh"
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
+
+#include "lib/native/base/base.hh"
 #include "call.hh"
 #include "ffi.hh"
 #include "util.hh"
@@ -88,15 +70,7 @@ void CallData::Dispose()
         }
     }
 
-    instance->temporaries -= mem->temporary;
-
-    if (!--mem->depth) {
-        mem->busy = false;
-
-        if (mem->temporary) {
-            delete mem;
-        }
-    }
+    ReleaseMemory(instance, mem);
 
     instance = nullptr;
 }
@@ -264,6 +238,8 @@ Size CallData::PushString16Value(Napi::Value value, const char16_t **out_str16)
 
 Size CallData::PushString32Value(Napi::Value value, const char32_t **out_str32)
 {
+    static const char32_t ReplacementChar = 0x0000FFFD;
+
     Span<char32_t> buf;
 
     Span<const char16_t> buf16;
@@ -287,15 +263,19 @@ Size CallData::PushString32Value(Napi::Value value, const char32_t **out_str32)
         char32_t uc = buf16[i];
 
         if (uc >= 0xD800 && uc <= 0xDBFF) {
-            char16_t uc2 = buf16.ptr[++i];
+            if (++i < buf16.len) {
+                char16_t uc2 = buf16.ptr[i];
 
-            if (uc2 >= 0xDC00 && uc2 <= 0xDFFF) {
-                uc = ((uc - 0xD800) << 10) + (uc2 - 0xDC00) + 0x10000u;
+                if (uc2 >= 0xDC00 && uc2 <= 0xDFFF) [[likely]] {
+                    uc = ((uc - 0xD800) << 10) + (uc2 - 0xDC00) + 0x10000u;
+                } else {
+                    uc = ReplacementChar;
+                }
             } else {
-                uc = '?';
+                uc = ReplacementChar;
             }
-        } else if (uc >= 0xDC00 && uc <= 0xDFFF) {
-            uc = '?';
+        } else if (uc >= 0xDC00 && uc <= 0xDFFF) [[unlikely]] {
+            uc = ReplacementChar;
         }
 
         buf[j++] = uc;
@@ -316,7 +296,7 @@ bool CallData::PushObject(Napi::Object obj, const TypeInfo *type, uint8_t *origi
     if (type->primitive == PrimitiveKind::Record) {
         members = type->members;
     } else if (type->primitive == PrimitiveKind::Union) {
-        if (CheckValueTag(instance, obj, &MagicUnionMarker)) {
+        if (CheckValueTag(obj, &MagicUnionMarker)) {
             MagicUnion *u = MagicUnion::Unwrap(obj);
             const uint8_t *raw = u->GetRaw();
 
@@ -909,7 +889,7 @@ bool CallData::PushStringArray(Napi::Value obj, const TypeInfo *type, uint8_t *o
 
 bool CallData::PushPointer(Napi::Value value, const TypeInfo *type, int directions, void **out_ptr)
 {
-    if (CheckValueTag(instance, value, &CastMarker)) {
+    if (CheckValueTag(value, &CastMarker)) {
         Napi::External<ValueCast> external = value.As<Napi::External<ValueCast>>();
         ValueCast *cast = external.Data();
 
@@ -932,8 +912,8 @@ bool CallData::PushPointer(Napi::Value value, const TypeInfo *type, int directio
                       type->primitive == PrimitiveKind::String16 ||
                       type->primitive == PrimitiveKind::String32);
 
-            if (!CheckValueTag(instance, value, type->ref.marker) &&
-                    !CheckValueTag(instance, value, instance->void_type) &&
+            if (!CheckValueTag(value, type->ref.marker) &&
+                    !CheckValueTag(value, instance->void_type) &&
                     ref != instance->void_type) [[unlikely]]
                 goto unexpected;
 
@@ -1000,7 +980,7 @@ bool CallData::PushPointer(Napi::Value value, const TypeInfo *type, int directio
                 ptr = AllocHeap(ref->size, 16);
 
                 if (ref->primitive == PrimitiveKind::Union &&
-                        (directions & 2) && !CheckValueTag(instance, obj, &MagicUnionMarker)) [[unlikely]] {
+                        (directions & 2) && !CheckValueTag(obj, &MagicUnionMarker)) [[unlikely]] {
                     ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected union value", GetValueType(instance, obj));
                     return false;
                 }
@@ -1108,9 +1088,9 @@ bool CallData::PushCallback(Napi::Value value, const TypeInfo *type, void **out_
             return false;
 
         *out_ptr = ptr;
-    } else if (CheckValueTag(instance, value, type->ref.marker)) {
+    } else if (CheckValueTag(value, type->ref.marker)) {
         *out_ptr = value.As<Napi::External<void>>().Data();
-    } else if (CheckValueTag(instance, value, &CastMarker)) {
+    } else if (CheckValueTag(value, &CastMarker)) {
         Napi::External<ValueCast> external = value.As<Napi::External<ValueCast>>();
         ValueCast *cast = external.Data();
 
@@ -1324,7 +1304,7 @@ void CallData::PopOutArguments()
             case OutArgument::Kind::Object: {
                 Napi::Object obj = value.As<Napi::Object>();
 
-                if (CheckValueTag(instance, value, &MagicUnionMarker)) {
+                if (CheckValueTag(value, &MagicUnionMarker)) {
                     MagicUnion *u = MagicUnion::Unwrap(obj);
                     u->SetRaw(out.ptr);
                 } else {

package/src/koffi/src/call.hh

@@ -1,27 +1,9 @@
-// Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of
-// this software and associated documentation files (the “Software”), to deal in
-// the Software without restriction, including without limitation the rights to use,
-// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-// Software, and to permit persons to whom the Software is furnished to do so,
-// subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 #pragma once
 
-#include "src/core/base/base.hh"
+#include "lib/native/base/base.hh"
 #include "ffi.hh"
 #include "util.hh"
 

package/src/koffi/src/errno.inc

@@ -1,23 +1,5 @@
-// Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy of
-// this software and associated documentation files (the “Software”), to deal in
-// the Software without restriction, including without limitation the rights to use,
-// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-// Software, and to permit persons to whom the Software is furnished to do so,
-// subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 #include <errno.h>