koffi 1.1.4 → 1.1.5

package/CMakeLists.txt

@@ -18,11 +18,10 @@ find_package(CNoke)
 
 set(CMAKE_CXX_STANDARD 17)
 if(MSVC)
-    add_compile_options(/W4 /wd4200 /wd4458 /wd4706 /wd4100 /wd4127 /wd4702)
+    add_compile_options(/W4 /wd4200 /wd4458 /wd4706 /wd4100 /wd4127 /wd4702 /wd4201)
     enable_language(ASM_MASM)
 else()
-    add_compile_options(-Wall -Wextra -Wno-missing-field-initializers
-                        -Wno-unused-parameter -Wno-class-memaccess)
+    add_compile_options(-Wall -Wextra -Wno-missing-field-initializers -Wno-unused-parameter)
     if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
         add_compile_options(-Wno-unknown-warning-option)
     endif()
@@ -32,12 +31,6 @@ endif()
 
 set(KOFFI_SRC
     src/call.cc
-    src/abi_arm32.cc
-    src/abi_arm64.cc
-    src/abi_riscv64.cc
-    src/abi_x64_sysv.cc
-    src/abi_x64_win.cc
-    src/abi_x86.cc
     src/ffi.cc
     src/parser.cc
     src/util.cc
@@ -45,21 +38,29 @@ set(KOFFI_SRC
 )
 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
     if(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch|arm")
-        list(APPEND KOFFI_SRC src/abi_arm64_fwd.S)
+        if(WIN32)
+            list(APPEND KOFFI_SRC src/abi_arm64.cc src/abi_arm64_fwd.asm)
+        else()
+            list(APPEND KOFFI_SRC src/abi_arm64.cc src/abi_arm64_fwd.S)
+        endif()
     elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "riscv")
-        list(APPEND KOFFI_SRC src/abi_riscv64_fwd.S)
-    elseif(WIN32)
-        list(APPEND KOFFI_SRC src/abi_x64_win_fwd.asm)
+        list(APPEND KOFFI_SRC src/abi_riscv64.cc src/abi_riscv64_fwd.S)
     else()
-        list(APPEND KOFFI_SRC src/abi_x64_sysv_fwd.S)
+        if(WIN32)
+            list(APPEND KOFFI_SRC src/abi_x64_win.cc src/abi_x64_win_fwd.asm)
+        else()
+            list(APPEND KOFFI_SRC src/abi_x64_sysv.cc src/abi_x64_sysv_fwd.S)
+        endif()
     endif()
 elseif(CMAKE_SIZEOF_VOID_P EQUAL 4)
     if(CMAKE_SYSTEM_PROCESSOR MATCHES "arm")
-        list(APPEND KOFFI_SRC src/abi_arm32_fwd.S)
-    elseif(WIN32)
-        list(APPEND KOFFI_SRC src/abi_x86_fwd.asm)
+        list(APPEND KOFFI_SRC src/abi_arm32.cc src/abi_arm32_fwd.S)
     else()
-        list(APPEND KOFFI_SRC src/abi_x86_fwd.S)
+        if(WIN32)
+            list(APPEND KOFFI_SRC src/abi_x86.cc src/abi_x86_fwd.asm)
+        else()
+            list(APPEND KOFFI_SRC src/abi_x86.cc src/abi_x86_fwd.S)
+        endif()
     endif()
 endif()
 

package/README.md

@@ -18,7 +18,7 @@
 
 # Introduction
 
-Koffi is a fast and easy-to-use FFI module for Node.js, with support for primitive and aggregate data types (structs), both by reference (pointer) and by value.
+Koffi is a fast and easy-to-use C FFI module for Node.js, with support for primitive and aggregate data types (structs and fixed-size arrays), both by reference (pointer) and by value.
 
 The following features are planned in the near future:
 
@@ -38,7 +38,7 @@ RISC-V 64 [^4]     | ⬜️ *N/A*    | 🟩 Yes   | ⬜️ *N/A*    | 🟨 Proba
 [^1]: The following call conventions are supported: cdecl, stdcall, MS fastcall, thiscall.
 [^2]: The prebuilt binary uses the hard float ABI and expects a VFP coprocessor. Build from source to use Koffi with a different ABI (softfp, soft).
 [^3]: However, we don't provide prebuilt binaries for macOS on Apple M1.
-[^4]: Only the LP64D (double-precision float) gets tested. The LP64 ABI is supported in theory (untested), the LP64F ABI is not supported.
+[^4]: Only the LP64D (double-precision float) ABI gets tested. The LP64 ABI is supported in theory (untested), the LP64F ABI is not supported.
 
 This is still in development, bugs are to be expected. More tests will come in the near future.
 

package/benchmark/CMakeLists.txt

@@ -12,12 +12,10 @@
 # along with this program. If not, see https://www.gnu.org/licenses/.
 
 cmake_minimum_required(VERSION 3.12)
-project(koffi C CXX ASM)
+project(koffi_benchmark C CXX)
 
 find_package(CNoke)
 
-set(CMAKE_CXX_STANDARD 20)
-
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
 
@@ -26,6 +24,16 @@ if(NOT TARGET koffi)
 endif()
 add_subdirectory(../test test)
 
+set(CMAKE_CXX_STANDARD 17)
+if(MSVC)
+    add_compile_options(/W4 /wd4200 /wd4458 /wd4706 /wd4100 /wd4127 /wd4702 /wd4201)
+else()
+    add_compile_options(-Wall -Wextra -Wno-missing-field-initializers -Wno-unused-parameter)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+        add_compile_options(-Wno-unknown-warning-option)
+    endif()
+endif()
+
 # ---- atoi ----
 
 add_executable(atoi_cc atoi_cc.cc ../vendor/libcc/libcc.cc)

package/benchmark/raylib_cc.cc

@@ -31,28 +31,28 @@ int Main(int argc, char **argv)
     SetWindowState(FLAG_WINDOW_HIDDEN);
     InitWindow(640, 480, "Raylib Test");
 
-    Image img = GenImageColor(800, 600, Color { .r = 0, .g = 0, .b = 0, .a = 255 });
+    Image img = GenImageColor(800, 600, Color { 0, 0, 0, 255 });
     Font font = GetFontDefault();
 
     int64_t start = GetMonotonicTime();
 
     for (int i = 0; i < iterations; i++) {
-        ImageClearBackground(&img, Color { .r = 0, .g = 0, .b = 0, .a = 255 });
+        ImageClearBackground(&img, Color { 0, 0, 0, 255 });
 
         for (int j = 0; j < 3600; j++) {
             const char *text = "Hello World!";
-            int text_width = MeasureTextEx(font, text, 10, 1).x;
+            float text_width = MeasureTextEx(font, text, 10, 1).x;
 
             double angle = (j * 7) * PI / 180;
             Color color = {
-                .r = (unsigned char)(127.5 + 127.5 * sin(angle)),
-                .g = (unsigned char)(127.5 + 127.5 * sin(angle + PI / 2)),
-                .b = (unsigned char)(127.5 + 127.5 * sin(angle + PI)),
-                .a = 255
+                (unsigned char)(127.5 + 127.5 * sin(angle)),
+                (unsigned char)(127.5 + 127.5 * sin(angle + PI / 2)),
+                (unsigned char)(127.5 + 127.5 * sin(angle + PI)),
+                255
             };
             Vector2 pos = {
-                .x = (float)((img.width / 2 - text_width / 2) + j * 0.1 * cos(angle - PI / 2)),
-                .y = (float)((img.height / 2 - 16) + j * 0.1 * sin(angle - PI / 2))
+                (float)((img.width / 2 - text_width / 2) + j * 0.1 * cos(angle - PI / 2)),
+                (float)((img.height / 2 - 16) + j * 0.1 * sin(angle - PI / 2))
             };
 
             ImageDrawTextEx(&img, font, text, pos, 10, 1, color);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koffi",
-  "version": "1.1.4",
-  "description": "Fast and simple FFI (foreign function interface) for Node.js",
+  "version": "1.1.5",
+  "description": "Fast and simple C FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",
     "function",

package/qemu/qemu.js

@@ -303,6 +303,8 @@ async function pack() {
             ignore.add(machine);
     }
 
+    let ready = ignore.size;
+
     success &= await start(false);
     success &= await copy(machine => Object.values(machine.builds).map(build => build.directory));
 
@@ -405,6 +407,9 @@ async function pack() {
     if (machines.some(machine => machine.started))
         success &= await stop(false);
 
+    if (ignore.size > ready)
+        throw new Error('Some machines are missing, refusing to pack');
+
     return success;
 }
 

package/src/abi_arm32_fwd.S

@@ -7,7 +7,7 @@
 // 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/.
 

package/src/abi_arm64_fwd.S

@@ -7,7 +7,7 @@
 // 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/.
 

package/src/abi_arm64_fwd.asm

@@ -0,0 +1,107 @@
+; 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/.
+
+    AREA |.text|, CODE
+
+    ; Copy function pointer to r9, in order to save it through argument forwarding.
+    ; Save RSP in r29 (non-volatile), and use carefully assembled stack provided by caller.
+    MACRO
+    prologue
+
+    stp x29, x30, [sp, -16]!
+    mov x29, sp
+    mov x9, x0
+    add sp, x1, #136
+    MEND
+
+    ; Call native function.
+    ; Once done, restore normal stack pointer and return.
+    ; The return value is passed untouched through r0, r1, v0 and/or v1.
+    MACRO
+    epilogue
+
+    blr x9
+    mov sp, x29
+    ldp x29, x30, [sp], 16
+    ret
+    MEND
+
+    ; Prepare general purpose argument registers from array passed by caller.
+    MACRO
+    forward_int
+
+    ldr x8, [x1, 64]
+    ldr x7, [x1, 56]
+    ldr x6, [x1, 48]
+    ldr x5, [x1, 40]
+    ldr x4, [x1, 32]
+    ldr x3, [x1, 24]
+    ldr x2, [x1, 16]
+    ldr x0, [x1, 0]
+    ldr x1, [x1, 8]
+    MEND
+
+    ; Prepare vector argument registers from array passed by caller.
+    MACRO
+    forward_vec
+
+    ldr d7, [x1, 128]
+    ldr d6, [x1, 120]
+    ldr d5, [x1, 112]
+    ldr d4, [x1, 104]
+    ldr d3, [x1, 96]
+    ldr d2, [x1, 88]
+    ldr d1, [x1, 80]
+    ldr d0, [x1, 72]
+    MEND
+
+ForwardCallGG PROC
+    prologue
+    forward_int
+    epilogue
+    ENDP
+
+ForwardCallF PROC
+    prologue
+    forward_int
+    epilogue
+    ENDP
+
+ForwardCallDDDD PROC
+    prologue
+    forward_int
+    epilogue
+    ENDP
+
+ForwardCallXGG PROC
+    prologue
+    forward_vec
+    forward_int
+    epilogue
+    ENDP
+
+ForwardCallXF PROC
+    prologue
+    forward_vec
+    forward_int
+    epilogue
+    ENDP
+
+ForwardCallXDDDD PROC
+    prologue
+    forward_vec
+    forward_int
+    epilogue
+    ENDP
+
+    END

package/src/abi_riscv64_fwd.S

@@ -7,7 +7,7 @@
 // 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/.
 

package/src/abi_x64_sysv_fwd.S

@@ -7,7 +7,7 @@
 // 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/.
 
@@ -17,6 +17,8 @@
     #define SYMBOL(Symbol) Symbol
 #endif
 
+// Forward
+
 // 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 SYMBOL(ForwardCallGG)
@@ -144,3 +146,113 @@ SYMBOL(ForwardCallXDD):
     forward_int
     movb $8, %al
     epilogue
+
+// Callbacks
+
+.global SYMBOL(CallBack0)
+.global SYMBOL(CallBack1)
+.global SYMBOL(CallBack2)
+.global SYMBOL(CallBack3)
+.global SYMBOL(CallBack4)
+.global SYMBOL(CallBack5)
+.global SYMBOL(CallBack6)
+.global SYMBOL(CallBack7)
+.global SYMBOL(CallBackX0)
+.global SYMBOL(CallBackX1)
+.global SYMBOL(CallBackX2)
+.global SYMBOL(CallBackX3)
+.global SYMBOL(CallBackX4)
+.global SYMBOL(CallBackX5)
+.global SYMBOL(CallBackX6)
+.global SYMBOL(CallBackX7)
+.global SYMBOL(RelayCallBack)
+
+.macro jumper id
+    .cfi_startproc
+    .cfi_def_cfa rsp, 8
+    endbr64
+    subq $152, %rsp
+    .cfi_def_cfa rsp, 160
+    movq %rdi, 0(%rsp)
+    movq %rsi, 8(%rsp)
+    movq %rdx, 16(%rsp)
+    movq %rcx, 24(%rsp)
+    movq %r8, 32(%rsp)
+    movq %r9, 40(%rsp)
+    leaq 112(%rsp), %rdi
+    movq $\id, %rsi
+    movq %rsp, %rdx
+    call SYMBOL(RelayCallBack)
+    movq 8(%rax), %rdx
+    movq 0(%rax), %rax
+    addq $152, %rsp
+    ret
+    .cfi_endproc
+.endm
+
+.macro jumperx id
+    .cfi_startproc
+    .cfi_def_cfa rsp, 8
+    endbr64
+    subq $152, %rsp
+    .cfi_def_cfa rsp, 160
+    movq %rdi, 0(%rsp)
+    movq %rsi, 8(%rsp)
+    movq %rdx, 16(%rsp)
+    movq %rcx, 24(%rsp)
+    movq %r8, 32(%rsp)
+    movq %r9, 40(%rsp)
+    movsd %xmm0, 48(%rsp)
+    movsd %xmm1, 56(%rsp)
+    movsd %xmm2, 64(%rsp)
+    movsd %xmm3, 72(%rsp)
+    movsd %xmm4, 80(%rsp)
+    movsd %xmm5, 88(%rsp)
+    movsd %xmm6, 96(%rsp)
+    movsd %xmm7, 104(%rsp)
+    leaq 112(%rsp), %rdi
+    movq $\id, %rsi
+    movq %rsp, %rdx
+    call SYMBOL(RelayCallBack)
+    movsd 16(%rax), %xmm0
+    movsd 24(%rax), %xmm1
+    movq 8(%rax), %rdx
+    movq 0(%rax), %rax
+    addq $152, %rsp
+    ret
+    .cfi_endproc
+.endm
+
+SYMBOL(CallBack0):
+    jumper 0
+SYMBOL(CallBack1):
+    jumper 1
+SYMBOL(CallBack2):
+    jumper 2
+SYMBOL(CallBack3):
+    jumper 3
+SYMBOL(CallBack4):
+    jumper 4
+SYMBOL(CallBack5):
+    jumper 5
+SYMBOL(CallBack6):
+    jumper 6
+SYMBOL(CallBack7):
+    jumper 7
+
+SYMBOL(CallBackX0):
+    jumperx 0
+SYMBOL(CallBackX1):
+    jumperx 1
+SYMBOL(CallBackX2):
+    jumperx 2
+SYMBOL(CallBackX3):
+    jumperx 3
+SYMBOL(CallBackX4):
+    jumperx 4
+SYMBOL(CallBackX5):
+    jumperx 5
+SYMBOL(CallBackX6):
+    jumperx 6
+SYMBOL(CallBackX7):
+    jumperx 7

package/src/ffi.cc

@@ -449,7 +449,7 @@ static Napi::Value TranslateVariadicCall(const Napi::CallbackInfo &info)
     InstanceData *instance = env.GetInstanceData<InstanceData>();
 
     FunctionInfo func;
-    memcpy(&func, info.Data(), RG_SIZE(FunctionInfo));
+    memcpy((void *)&func, info.Data(), RG_SIZE(FunctionInfo));
     func.lib = nullptr;
 
     // This makes variadic calls non-reentrant
@@ -956,6 +956,25 @@ void FunctionInfo::Unref() const
     }
 }
 
+InstanceMemory::~InstanceMemory()
+{
+#ifdef _WIN32
+    if (stack.ptr) {
+        VirtualFree(stack.ptr, 0, MEM_RELEASE);
+    }
+    if (heap.ptr) {
+        VirtualFree(heap.ptr, 0, MEM_RELEASE);
+    }
+#else
+    if (stack.ptr) {
+        munmap(stack.ptr, stack.len);
+    }
+    if (heap.ptr) {
+        munmap(heap.ptr, heap.len);
+    }
+#endif
+}
+
 InstanceData::InstanceData()
 {
     InstanceMemory *mem = new InstanceMemory();

package/src/ffi.hh

@@ -181,6 +181,8 @@ struct FunctionInfo {
 };
 
 struct InstanceMemory {
+    ~InstanceMemory();
+
     Span<uint8_t> stack;
     Span<uint8_t> heap;
 

package/test/CMakeLists.txt

@@ -12,7 +12,7 @@
 # along with this program. If not, see https://www.gnu.org/licenses/.
 
 cmake_minimum_required(VERSION 3.12)
-project(koffi C CXX)
+project(koffi_test C CXX)
 
 if(NOT TARGET koffi)
     add_subdirectory(.. koffi)