koffi 1.2.0-alpha.3 → 1.2.0-alpha.4

package/README.md

@@ -18,13 +18,12 @@
 
 # Introduction
 
-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.
+Koffi is a fast and easy-to-use C FFI module for Node.js, featuring:
 
-The following features are planned in the near future:
-
-* 1.2: C to JS callbacks (⚠️ partially working in master branch)
-* 1.3: Real-world examples, optimize passing of structs and arrays
-* 1.4: Type parser, unions
+* Low-overhead and fast performance (see [benchmarks](#benchmarks))
+* Support for primitive and aggregate data types (structs and fixed-size arrays), both by reference (pointer) and by value
+* Javascript functions can be used as C callbacks (since 1.2.0)
+* Well-tested code base for popular OS/architecture combinations
 
 The following combinations of OS and architectures __are officially supported and tested__ at the moment:
 
@@ -41,7 +40,10 @@ RISC-V 64 [^4]     | ⬜️ *N/A*    | 🟩 Yes   | ⬜️ *N/A*    | 🟨 Proba
 [^3]: However, we don't provide prebuilt binaries for macOS on Apple M1.
 [^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.
+The following features are planned in the near future:
+
+* 1.3: Real-world examples, optimize passing of structs and arrays
+* 1.4: Type parser, unions
 
 # Get started
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koffi",
-  "version": "1.2.0-alpha.3",
+  "version": "1.2.0-alpha.4",
   "description": "Fast and simple C FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",
@@ -41,12 +41,14 @@
     "benchmark/raylib_*",
     "qemu/qemu.js",
     "qemu/registry",
+    "test/async.js",
+    "test/callbacks.js",
     "test/CMakeLists.txt",
     "test/misc.c",
     "test/misc.def",
-    "test/misc.js",
     "test/raylib.js",
     "test/sqlite.js",
+    "test/sync.js",
     "vendor",
     "LICENSE.txt",
     "README.md",

package/qemu/registry/machines.json

@@ -37,9 +37,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -83,9 +83,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -129,9 +129,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -175,9 +175,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -228,9 +228,9 @@
                 "commands": {
                     "Test Sync": "C:\\Node32\\node32.cmd node test/sync.js",
                     "Test Async": "C:\\Node32\\node32.cmd node test/async.js",
+                    "Test Callbacks": "C:\\Node32\\node32.cmd node test/callbacks.js",
                     "Test Raylib": "seatsh C:\\Node32\\node32.cmd node test/raylib.js",
-                    "Test SQLite": "C:\\Node32\\node32.cmd node test/sqlite.js",
-                    "Test Callbacks": "C:\\Node32\\node32.cmd node test/callbacks.js"
+                    "Test SQLite": "C:\\Node32\\node32.cmd node test/sqlite.js"
                 }
             },
 
@@ -242,9 +242,9 @@
                 "commands": {
                     "Test Sync": "C:\\Node64\\node64.cmd node test/sync.js",
                     "Test Async": "C:\\Node64\\node64.cmd node test/async.js",
+                    "Test Callbacks": "C:\\Node64\\node64.cmd node test/callbacks.js",
                     "Test Raylib": "seatsh C:\\Node64\\node64.cmd node test/raylib.js",
-                    "Test SQLite": "C:\\Node64\\node64.cmd node test/sqlite.js",
-                    "Test Callbacks": "C:\\Node64\\node64.cmd node test/callbacks.js"
+                    "Test SQLite": "C:\\Node64\\node64.cmd node test/sqlite.js"
                 }
             }
         }
@@ -288,9 +288,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -334,9 +334,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -380,9 +380,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -426,8 +426,8 @@
                 "commands": {
                     "Test Sync": "PATH=/usr/local/bin:/usr/bin:/bin node test/sync.js",
                     "Test Async": "PATH=/usr/local/bin:/usr/bin:/bin node test/async.js",
-                    "Test SQLite": "PATH=/usr/local/bin:/usr/bin:/bin node test/sqlite.js",
-                    "Test Callbacks": "PATH=/usr/local/bin:/usr/bin:/bin node test/callbacks.js"
+                    "Test Callbacks": "PATH=/usr/local/bin:/usr/bin:/bin node test/callbacks.js",
+                    "Test SQLite": "PATH=/usr/local/bin:/usr/bin:/bin node test/sqlite.js"
                 }
             }
         }
@@ -471,9 +471,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -517,9 +517,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }
@@ -563,9 +563,9 @@
                 "commands": {
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
+                    "Test Callbacks": "node test/callbacks.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js",
-                    "Test Callbacks": "node test/callbacks.js"
+                    "Test SQLite": "node test/sqlite.js"
                 }
             }
         }

package/src/abi_arm32.cc

@@ -139,10 +139,11 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
             } break;
             case PrimitiveKind::Int64:
             case PrimitiveKind::UInt64: {
-                int need = 2 + (gpr_avail % 2);
+                bool realign = gpr_avail % 2;
+                int need = 2 + realign;
 
                 if (gpr_avail >= need) {
-                    param.gpr_count = need;
+                    param.gpr_count = 2;
                     gpr_avail -= need;
                 } else {
                     started_stack = true;
@@ -160,13 +161,14 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
                         started_stack = true;
                     }
                 } else {
-                    int gpr_count = (param.type->size + 3) / 4;
+                    bool realign = (param.type->align == 8 && (gpr_avail % 2));
+                    int need = (param.type->size + 3) / 4 + realign;
 
-                    if (gpr_count <= gpr_avail) {
-                        param.gpr_count = gpr_count;
-                        gpr_avail -= gpr_count;
+                    if (need <= gpr_avail) {
+                        param.gpr_count = need - realign;
+                        gpr_avail -= need;
                     } else if (!started_stack) {
-                        param.gpr_count = gpr_avail;
+                        param.gpr_count = gpr_avail - realign;
                         gpr_avail = 0;
 
                         started_stack = true;
@@ -195,7 +197,7 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
                     need += (gpr_avail % 2);
 
                     if (need <= gpr_avail) {
-                        param.gpr_count = need;
+                        param.gpr_count = 2;
                         gpr_avail -= need;
                     } else {
                         started_stack = true;
@@ -214,7 +216,7 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
 
 bool CallData::Prepare(const Napi::CallbackInfo &info)
 {
-    uint8_t *args_ptr = nullptr;
+    uint32_t *args_ptr = nullptr;
     uint32_t *gpr_ptr = nullptr;
     uint32_t *vec_ptr = nullptr;
 
@@ -251,13 +253,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 }
 
                 bool b = value.As<Napi::Boolean>();
-
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = (uint32_t)b;
-                } else {
-                    *args_ptr = (uint8_t)b;
-                    args_ptr += 4;
-                }
+                *((param.gpr_count ? gpr_ptr : args_ptr)++) = (uint32_t)b;
             } break;
             case PrimitiveKind::Int8:
             case PrimitiveKind::UInt8:
@@ -270,13 +266,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 }
 
                 int32_t v = CopyNumber<int32_t>(value);
-
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(int32_t *)(gpr_ptr++) = v;
-                } else {
-                    *(int32_t *)args_ptr = v;
-                    args_ptr += 4;
-                }
+                *(int32_t *)((param.gpr_count ? gpr_ptr : args_ptr)++) = v;
             } break;
             case PrimitiveKind::UInt32: {
                 if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
@@ -285,13 +275,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 }
 
                 uint32_t v = CopyNumber<uint32_t>(value);
-
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = v;
-                } else {
-                    *(uint32_t *)args_ptr = v;
-                    args_ptr += 4;
-                }
+                *((param.gpr_count ? gpr_ptr : args_ptr)++) = v;
             } break;
             case PrimitiveKind::Int64: {
                 if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
@@ -302,13 +286,13 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 int64_t v = CopyNumber<int64_t>(value);
 
                 if (RG_LIKELY(param.gpr_count)) {
-                    gpr_ptr += param.gpr_count - 2;
+                    gpr_ptr = AlignUp(gpr_ptr, 8);
                     *(int64_t *)gpr_ptr = v;
                     gpr_ptr += param.gpr_count;
                 } else {
                     args_ptr = AlignUp(args_ptr, 8);
                     *(int64_t *)args_ptr = v;
-                    args_ptr += 8;
+                    args_ptr += 2;
                 }
             } break;
             case PrimitiveKind::UInt64: {
@@ -320,13 +304,13 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 uint64_t v = CopyNumber<uint64_t>(value);
 
                 if (RG_LIKELY(param.gpr_count)) {
-                    gpr_ptr += param.gpr_count - 2;
+                    gpr_ptr = AlignUp(gpr_ptr, 8);
                     *(uint64_t *)gpr_ptr = v;
                     gpr_ptr += param.gpr_count;
                 } else {
                     args_ptr = AlignUp(args_ptr, 8);
                     *(uint64_t *)args_ptr = v;
-                    args_ptr += 8;
+                    args_ptr += 2;
                 }
             } break;
             case PrimitiveKind::String: {
@@ -342,12 +326,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     return false;
                 }
 
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = (uint64_t)str;
-                } else {
-                    *(const char **)args_ptr = str;
-                    args_ptr += 4;
-                }
+                *(const char **)((param.gpr_count ? gpr_ptr : args_ptr)++) = str;
             } break;
             case PrimitiveKind::String16: {
                 const char16_t *str16;
@@ -362,12 +341,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     return false;
                 }
 
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = (uint64_t)str16;
-                } else {
-                    *(const char16_t **)args_ptr = str16;
-                    args_ptr += 4;
-                }
+                *(const char16_t **)((param.gpr_count ? gpr_ptr : args_ptr)++) = str16;
             } break;
             case PrimitiveKind::Pointer: {
                 uint8_t *ptr;
@@ -400,12 +374,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     return false;
                 }
 
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = (uint64_t)ptr;
-                } else {
-                    *(void **)args_ptr = ptr;
-                    args_ptr += 4;
-                }
+                *(void **)((param.gpr_count ? gpr_ptr : args_ptr)++) = ptr;
             } break;
             case PrimitiveKind::Record: {
                 if (RG_UNLIKELY(!IsObject(value))) {
@@ -422,18 +391,21 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 } else if (param.gpr_count) {
                     RG_ASSERT(param.type->align <= 8);
 
+                    int16_t align = (param.type->align <= 4) ? 4 : 8;
+                    gpr_ptr = AlignUp(gpr_ptr, align);
+
                     if (!PushObject(obj, param.type, (uint8_t *)gpr_ptr))
                         return false;
 
                     gpr_ptr += param.gpr_count;
-                    args_ptr += AlignLen(param.type->size - param.gpr_count * 4, 4);
+                    args_ptr += (param.type->size - param.gpr_count * 4 + 3) / 4;
                 } else if (param.type->size) {
                     int16_t align = (param.type->align <= 4) ? 4 : 8;
-
                     args_ptr = AlignUp(args_ptr, align);
-                    if (!PushObject(obj, param.type, args_ptr))
+
+                    if (!PushObject(obj, param.type, (uint8_t *)args_ptr))
                         return false;
-                    args_ptr += AlignLen(param.type->size, 4);
+                    args_ptr += (param.type->size + 3) / 4;
                 }
             } break;
             case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
@@ -450,8 +422,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 } else if (param.gpr_count) {
                     *(float *)(gpr_ptr++) = f;
                 } else {
-                    *(float *)args_ptr = f;
-                    args_ptr += 4;
+                    *(float *)(args_ptr++) = f;
                 }
             } break;
             case PrimitiveKind::Float64: {
@@ -466,13 +437,13 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     *(double *)vec_ptr = d;
                     vec_ptr += 2;
                 } else if (param.gpr_count) {
-                    gpr_ptr += (param.gpr_count - 2);
+                    gpr_ptr = AlignUp(gpr_ptr, 8);
                     *(double *)gpr_ptr = d;
                     gpr_ptr += 2;
                 } else {
                     args_ptr = AlignUp(args_ptr, 8);
                     *(double *)args_ptr = d;
-                    args_ptr += 8;
+                    args_ptr += 2;
                 }
             } break;
             case PrimitiveKind::Callback: {
@@ -495,12 +466,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     return false;
                 }
 
-                if (RG_LIKELY(param.gpr_count)) {
-                    *(gpr_ptr++) = (uint32_t)ptr;
-                } else {
-                    *(void **)args_ptr = ptr;
-                    args_ptr += 4;
-                }
+                *(void **)((param.gpr_count ? gpr_ptr : args_ptr)++) = ptr;
             } break;
         }
     }
@@ -668,7 +634,8 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
                 arguments.Append(arg);
             } break;
             case PrimitiveKind::Int64: {
-                gpr_ptr += param.gpr_count - 2;
+                gpr_ptr = AlignUp(gpr_ptr, 8);
+
                 int64_t v = *(int64_t *)(param.gpr_count ? gpr_ptr : args_ptr);
                 (param.gpr_count ? gpr_ptr : args_ptr) += 2;
 
@@ -676,7 +643,8 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
                 arguments.Append(arg);
             } break;
             case PrimitiveKind::UInt64: {
-                gpr_ptr += param.gpr_count - 2;
+                gpr_ptr = AlignUp(gpr_ptr, 8);
+
                 uint64_t v = *(uint64_t *)(param.gpr_count ? gpr_ptr : args_ptr);
                 (param.gpr_count ? gpr_ptr : args_ptr) += 2;
 
@@ -717,11 +685,32 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
                 } else if (param.gpr_count) {
                     RG_ASSERT(param.type->align <= 8);
 
-                    Napi::Object obj = PopObject((const uint8_t *)gpr_ptr, param.type);
-                    arguments.Append(obj);
+                    int16_t gpr_size = param.gpr_count * 4;
+                    int16_t align = (param.type->align <= 4) ? 4 : 8;
+                    gpr_ptr = AlignUp(gpr_ptr, align);
 
-                    gpr_ptr += param.gpr_count;
-                    args_ptr += (param.type->size - param.gpr_count * 4 + 3) / 4;
+                    if (param.type->size > gpr_size) {
+                        uint8_t *ptr;
+
+                        // XXX: Expensive, and error can't be managed by calling C code.
+                        // But the object is split between the GPRs and the caller stack.
+                        if (RG_UNLIKELY(!AllocHeap(param.type->size, 16, &ptr)))
+                            return;
+
+                        memcpy(ptr, gpr_ptr, gpr_size);
+                        memcpy(ptr + gpr_size, args_ptr, param.type->size - gpr_size);
+
+                        Napi::Object obj = PopObject(ptr, param.type);
+                        arguments.Append(obj);
+
+                        gpr_ptr += param.gpr_count;
+                        args_ptr += (param.type->size - gpr_size + 3) / 4;
+                    } else {
+                        Napi::Object obj = PopObject((const uint8_t *)gpr_ptr, param.type);
+                        arguments.Append(obj);
+
+                        gpr_ptr += param.gpr_count;
+                    }
                 } else if (param.type->size) {
                     int16_t align = (param.type->align <= 4) ? 4 : 8;
                     args_ptr = AlignUp(args_ptr, align);
@@ -752,10 +741,11 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
                     d = *(double *)vec_ptr;
                     vec_ptr += 2;
                 } else if (param.gpr_count) {
-                    gpr_ptr += param.gpr_count - 2;
+                    gpr_ptr = AlignUp(gpr_ptr, 8);
                     d = *(double *)gpr_ptr;
                     gpr_ptr += 2;
                 } else {
+                    args_ptr = AlignUp(args_ptr, 8);
                     d = *(double *)args_ptr;
                     args_ptr += 2;
                 }

package/src/abi_arm32_fwd.S

@@ -290,8 +290,8 @@ TrampolineX15:
     trampoline_vec 15
 
 # When a callback is relayed, Koffi will call into Node.js and V8 to execute Javascript.
-# The propblem is that we're still running on the separate Koffi stack, and V8 will
-# preobably misdetect this as a "stack overflow". We have to restore the old
+# 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 (r0, r1, r2) are passed through untouched.
 CallSwitchStack: