koffi 1.0.5 → 1.1.0-beta.2

package/CMakeLists.txt

@@ -18,7 +18,11 @@ find_package(CNoke)
 
 set(CMAKE_CXX_STANDARD 17)
 if(MSVC)
+    add_compile_options(/W4 /wd4200 /wd4458 /wd4706 /wd4100 /wd4127 /wd4702)
     enable_language(ASM_MASM)
+else()
+    add_compile_options(-Wall -Wextra -Wno-missing-field-initializers
+                        -Wno-unused-parameter -Wno-class-memaccess)
 endif()
 
 # ---- Koffi ----

package/README.md

@@ -2,6 +2,11 @@
 
 - [Introduction](#introduction)
 - [Get started](#get-started)
+- [Extra features](#extra-features)
+  * [C arrays](#c-arrays)
+  * [Variadic functions](#variadic-functions)
+  * [Asynchronous calls](#asynchronous-calls)
+  * [Callbacks](#callbacks)
 - [Benchmarks](#benchmarks)
   * [atoi results](#atoi-results)
   * [Raylib results](#raylib-results)
@@ -16,31 +21,30 @@ Koffi is a fast and easy-to-use FFI module for Node.js, with support for primiti
 
 After the release of version 1.0, the following features are planned:
 
-* 1.1: Asynchronous calls
+* 1.1: Asynchronous calls and fixed-size array types
 * 1.2: C to JS callbacks
-* 1.3: Unions and (fixed size) array types
 
 The following platforms __are officially supported and tested__ at the moment:
 
-Platform  | Architecture                     | JS to C  | C to JS (callback) | Pre-built binary
---------- | -------------------------------- | -------- | ------------------ | ----------------
-Windows   | x86 (cdecl, stdcall, fastcall)   | 🟩 Yes   | 🟥 No              | 🟩 Yes
-Windows   | x86_64                           | 🟩 Yes   | 🟥 No              | 🟩 Yes
-Linux     | x86                              | 🟩 Yes   | 🟥 No              | 🟩 Yes
-Linux     | x86_64                           | 🟩 Yes   | 🟥 No              | 🟩 Yes
-Linux     | ARM32+VFP Little Endian          | 🟩 Yes   | 🟥 No              | 🟩 Yes
-Linux     | ARM64 Little Endian              | 🟩 Yes   | 🟥 No              | 🟩 Yes
-FreeBSD   | x86                              | 🟩 Yes   | 🟥 No              | 🟩 Yes
-FreeBSD   | x86_64                           | 🟩 Yes   | 🟥 No              | 🟩 Yes
-FreeBSD   | ARM64 Little Endian              | 🟩 Yes   | 🟥 No              | 🟩 Yes
-macOS     | x86_64                           | 🟩 Yes   | 🟥 No              | 🟩 Yes
-macOS     | ARM64 (M1) Little Endian         | 🟩 Yes   | 🟥 No              | 🟥 No
-OpenBSD   | x86_64                           | 🟧 Maybe | 🟥 No              | 🟥 No
-OpenBSD   | x86                              | 🟧 Maybe | 🟥 No              | 🟥 No
-OpenBSD   | ARM64 Little Endian              | 🟧 Maybe | 🟥 No              | 🟥 No
-NetBSD    | x86_64                           | 🟧 Maybe | 🟥 No              | 🟥 No
-NetBSD    | x86                              | 🟧 Maybe | 🟥 No              | 🟥 No
-NetBSD    | ARM64 Little Endian              | 🟧 Maybe | 🟥 No              | 🟥 No
+Platform  | Architecture                     | Sync calls | Async calls | Callbacks | Pre-built binary
+--------- | -------------------------------- | ---------- | ----------- | --------- | ----------------
+Windows   | x86 (cdecl, stdcall, fastcall)   | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+Windows   | x86_64                           | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+Linux     | x86                              | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+Linux     | x86_64                           | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+Linux     | ARM32+VFP Little Endian          | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+Linux     | ARM64 Little Endian              | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+FreeBSD   | x86                              | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+FreeBSD   | x86_64                           | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+FreeBSD   | ARM64 Little Endian              | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+macOS     | x86_64                           | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟩 Yes
+macOS     | ARM64 (M1) Little Endian         | 🟩 Yes      | 🟩 Yes       | 🟥 No      | 🟥 No
+OpenBSD   | x86_64                           | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
+OpenBSD   | x86                              | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
+OpenBSD   | ARM64 Little Endian              | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
+NetBSD    | x86_64                           | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
+NetBSD    | x86                              | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
+NetBSD    | ARM64 Little Endian              | 🟧 Maybe    | 🟧 Maybe     | 🟥 No      | 🟥 No
 
 🟩 Tested, fully operational
 🟧 May work, but not actively tested
@@ -214,12 +218,16 @@ while (!WindowShouldClose()) {
 
 # Extra features
 
+## C arrays
+
+Fixed-size arrays are declared with `koffi.array(type, length)`. Just like in C, they cannot be passed
+as functions parameters (they degenerate to pointers), or returned by value. You can however embed them in struct types.
+
 ## Variadic functions
 
 Variadic functions are declared with an ellipsis as the last argument.
 
-In order to call a variadic function, you must provide two Javascript arguments for each C parameter,
-the first one is the expected type and the second one is the value.
+In order to call a variadic function, you must provide two Javascript arguments for each C parameter, the first one is the expected type and the second one is the value.
 
 ```js
 const printf = lib.func('printf', 'int', ['string', '...']);
@@ -227,9 +235,31 @@ const printf = lib.func('printf', 'int', ['string', '...']);
 printf('Integer %d, double %g, string %s', 'int', 6, 'double', 8.5, 'string', 'THE END');
 ```
 
+## Asynchronous calls
+
+You can issue asynchronous calls by calling the function through its async member. In this case, you need to provide a callback function as the last argument, with `(err, res)` parameters.
+
+```js
+const koffi = require('koffi');
+const lib = koffi.load('libc.so.6');
+
+const atoi = lib.func('int atoi(const char *str)');
+
+atoi.async('1257', (err, res) => {
+    console.log('Result:', res);
+})
+console.log('Hello World!');
+
+// This program will print "Hello World!", and then "Result: 1257"
+```
+
+You can easily convert this callback-style async function to a promise-based version with `util.promisify()` from the Node.js standard library.
+
+Variadic functions do not support async.
+
 ## Callbacks
 
-Koffi does not yet support passing JS functions as callbacks. This is planned for version 1.1.
+Koffi does not yet support passing JS functions as callbacks. This is planned for version 1.2.
 
 # Benchmarks
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koffi",
-  "version": "1.0.5",
+  "version": "1.1.0-beta.2",
   "description": "Fast and simple FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",

package/qemu/qemu.js

@@ -275,6 +275,7 @@ async function pack() {
     let json = fs.readFileSync(root_dir + '/koffi/package.json', { encoding: 'utf-8' });
     let version = JSON.parse(json).version;
 
+    console.log('>> Version:', version);
     console.log('>> Checking build archives...');
     for (let machine of machines) {
         let needed = false;
@@ -430,16 +431,22 @@ async function copy(func) {
         let copied = true;
 
         for (let directory of func(machine)) {
-            try {
-                await machine.ssh.exec('rm', ['-rf', directory]);
-            } catch (err) {
-                // Fails often on Windows (busy directory or whatever), but rarely a problem
+            for (let i = 0; i < 10; i++) {
+                try {
+                    await machine.ssh.exec('rm', ['-rf', directory]);
+                    break;
+                } catch (err) {
+                    // Fails often on Windows (busy directory or whatever), but rarely a problem
+
+                    await wait(1000);
+                    continue;
+                }
             }
 
             try {
                 await machine.ssh.putDirectory(snapshot_dir, directory, {
                     recursive: true,
-                    concurrency: 4
+                    concurrency: (process.platform != 'win32') ? 4 : 1
                 });
             } catch (err) {
                 ignore.add(machine);

package/qemu/registry/machines.json

@@ -35,8 +35,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -79,8 +80,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -123,8 +125,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -167,8 +170,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -218,8 +222,9 @@
                     "Build": "C:\\Node32\\node32.cmd node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "C:\\Node32\\node32.cmd node test/sync.js",
+                    "Test Async": "C:\\Node32\\node32.cmd node test/async.js",
                     "Test Raylib": "seatsh C:\\Node32\\node32.cmd node test/raylib.js",
-                    "Test Misc": "C:\\Node32\\node32.cmd node test/misc.js",
                     "Test SQLite": "C:\\Node32\\node32.cmd node test/sqlite.js"
                 }
             },
@@ -230,8 +235,9 @@
                     "Build": "C:\\Node64\\node64.cmd node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "C:\\Node64\\node64.cmd node test/sync.js",
+                    "Test Async": "C:\\Node64\\node64.cmd node test/async.js",
                     "Test Raylib": "seatsh C:\\Node64\\node64.cmd node test/raylib.js",
-                    "Test Misc": "C:\\Node64\\node64.cmd node test/misc.js",
                     "Test SQLite": "C:\\Node64\\node64.cmd node test/sqlite.js"
                 }
             }
@@ -274,8 +280,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -318,8 +325,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -362,8 +370,9 @@
                     "Build": "node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
+                    "Test Sync": "node test/sync.js",
+                    "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test Misc": "node test/misc.js",
                     "Test SQLite": "node test/sqlite.js"
                 }
             }
@@ -406,7 +415,8 @@
                     "Build": "PATH=/usr/local/bin:/usr/bin:/bin SDKROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk node ../cnoke/cnoke.js -C test"
                 },
                 "commands": {
-                    "Test Misc": "PATH=/usr/local/bin:/usr/bin:/bin node test/misc.js",
+                    "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"
                 }
             }

package/src/abi_arm32.cc

@@ -37,28 +37,9 @@ extern "C" uint64_t ForwardCallXGG(const void *func, uint8_t *sp);
 extern "C" float ForwardCallXF(const void *func, uint8_t *sp);
 extern "C" HfaRet ForwardCallXDDDD(const void *func, uint8_t *sp);
 
-static bool IsHFA(const TypeInfo *type)
-{
-    if (type->primitive != PrimitiveKind::Record)
-        return false;
-
-    if (type->members.len < 1 || type->members.len > 4)
-        return false;
-    if (type->members[0].type->primitive != PrimitiveKind::Float32 &&
-            type->members[0].type->primitive != PrimitiveKind::Float64)
-        return false;
-
-    for (Size i = 1; i < type->members.len; i++) {
-        if (type->members[i].type != type->members[0].type)
-            return false;
-    }
-
-    return true;
-}
-
 bool AnalyseFunction(InstanceData *, FunctionInfo *func)
 {
-    if (IsHFA(func->ret.type)) {
+    if (IsHFA(func->ret.type, 1, 4)) {
         func->ret.vec_count = func->ret.type->members.len *
                               (func->ret.type->members[0].type->size / 4);
     } else if (func->ret.type->primitive != PrimitiveKind::Record ||
@@ -93,7 +74,6 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
                     started_stack = true;
                 }
             } break;
-
             case PrimitiveKind::Int64:
             case PrimitiveKind::UInt64: {
                 if (gpr_avail >= 2) {
@@ -103,31 +83,8 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
                     started_stack = true;
                 }
             } break;
-
-            case PrimitiveKind::Float32:
-            case PrimitiveKind::Float64: {
-                Size need = param.type->size / 4;
-                bool vfp = !param.variadic;
-
-                if (vfp) {
-                    if (need <= vec_avail) {
-                        param.vec_count = need;
-                        vec_avail -= need;
-                    } else {
-                        started_stack = true;
-                    }
-                } else {
-                    if (need <= gpr_avail) {
-                        param.gpr_count = need;
-                        gpr_avail -= need;
-                    } else {
-                        started_stack = true;
-                    }
-                }
-            } break;
-
             case PrimitiveKind::Record: {
-                if (IsHFA(param.type)) {
+                if (IsHFA(param.type, 1, 4)) {
                     int vec_count = (int)(param.type->members.len *
                                           param.type->members[0].type->size / 4);
 
@@ -152,6 +109,28 @@ bool AnalyseFunction(InstanceData *, FunctionInfo *func)
                     }
                 }
             } break;
+            case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
+            case PrimitiveKind::Float32:
+            case PrimitiveKind::Float64: {
+                Size need = param.type->size / 4;
+                bool vfp = !param.variadic;
+
+                if (vfp) {
+                    if (need <= vec_avail) {
+                        param.vec_count = need;
+                        vec_avail -= need;
+                    } else {
+                        started_stack = true;
+                    }
+                } else {
+                    if (need <= gpr_avail) {
+                        param.gpr_count = need;
+                        gpr_avail -= need;
+                    } else {
+                        started_stack = true;
+                    }
+                }
+            } break;
         }
 
         func->args_size += AlignLen(param.type->size, 16);
@@ -305,8 +284,11 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                         memset(ptr, 0, param.type->size);
                     }
                     if (param.directions & 2) {
-                        OutObject out = {obj, ptr, param.type->ref};
-                        out_objects.Append(out);
+                        OutObject *out = out_objects.AppendDefault();
+
+                        out->ref.Reset(obj, 1);
+                        out->ptr = ptr;
+                        out->type = param.type->ref;
                     }
                 } else if (IsNullOrUndefined(value)) {
                     ptr = nullptr;
@@ -351,6 +333,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                     args_ptr += AlignLen(param.type->size, 4);
                 }
             } break;
+            case PrimitiveKind::Array: { RG_UNREACHABLE(); } 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);
@@ -391,6 +374,9 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
         }
     }
 
+    stack = MakeSpan(mem->stack.end(), old_stack_mem.end() - mem->stack.end());
+    heap = MakeSpan(old_heap_mem.ptr, mem->heap.ptr - old_heap_mem.ptr);
+
     return true;
 }
 
@@ -398,8 +384,8 @@ void CallData::Execute()
 {
 #define PERFORM_CALL(Suffix) \
         ([&]() { \
-            auto ret = (func->forward_fp ? ForwardCallX ## Suffix(func->func, GetSP()) \
-                                         : ForwardCall ## Suffix(func->func, GetSP())); \
+            auto ret = (func->forward_fp ? ForwardCallX ## Suffix(func->func, stack.ptr) \
+                                         : ForwardCall ## Suffix(func->func, stack.ptr)); \
             return ret; \
         })()
 
@@ -426,6 +412,7 @@ void CallData::Execute()
                 result.u64 = PERFORM_CALL(GG);
             }
         } break;
+        case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
         case PrimitiveKind::Float32: { result.f = PERFORM_CALL(F); } break;
         case PrimitiveKind::Float64: { result.d = PERFORM_CALL(DDDD).d0; } break;
     }
@@ -435,8 +422,9 @@ void CallData::Execute()
 
 Napi::Value CallData::Complete()
 {
-    for (const OutObject &obj: out_objects) {
-        PopObject(obj.obj, obj.ptr, obj.type);
+    for (const OutObject &out: out_objects) {
+        Napi::Object obj = out.ref.Value().As<Napi::Object>();
+        PopObject(obj, out.ptr, out.type);
     }
 
     switch (func->ret.type->primitive) {
@@ -465,6 +453,7 @@ Napi::Value CallData::Complete()
             Napi::Object obj = PopObject(ptr, func->ret.type);
             return obj;
         } break;
+        case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
         case PrimitiveKind::Float32: return Napi::Number::New(env, (double)result.f);
         case PrimitiveKind::Float64: return Napi::Number::New(env, result.d);
     }