koffi 1.0.3 → 1.1.0-beta.0

package/README.md

@@ -16,36 +16,37 @@ 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: C to JS callbacks
-* 1.2: Support fixed array types
+* 1.1: Asynchronous calls
+* 1.2: Fixed-size array types
+* 1.3: C to JS callbacks
 
 The following platforms __are officially supported and tested__ at the moment:
 
-Platoform | Architecture                     | JS to C | C to JS (callback) | Pre-built binary
---------- | -------------------------------- | ------- | ------------------ | ----------------
-Windows   | x86 (cdecl, stdcall, fastcall)   | 🟩      | 🟥                 | ✅ Yes
-Windows   | x86_64                           | 🟩      | 🟥                 | ✅ Yes
-Linux     | x86                              | 🟩      | 🟥                 | ✅ Yes
-Linux     | x86_64                           | 🟩      | 🟥                 | ✅ Yes
-Linux     | ARM32+VFP Little Endian          | 🟩      | 🟥                 | ✅ Yes
-Linux     | ARM64 Little Endian              | 🟩      | 🟥                 | ✅ Yes
-FreeBSD   | x86                              | 🟩      | 🟥                 | ✅ Yes
-FreeBSD   | x86_64                           | 🟩      | 🟥                 | ✅ Yes
-FreeBSD   | ARM64 Little Endian              | 🟩      | 🟥                 | ✅ Yes
-macOS     | x86_64                           | 🟩      | 🟥                 | ✅ Yes
-macOS     | ARM64 (M1) Little Endian         | 🟩      | 🟥                 | ❌ No
-OpenBSD   | x86_64                           | 🟧      | 🟥                 | ❌ No
-OpenBSD   | x86                              | 🟧      | 🟥                 | ❌ No
-OpenBSD   | ARM64 Little Endian              | 🟧      | 🟥                 | ❌ No
-NetBSD    | x86_64                           | 🟧      | 🟥                 | ❌ No
-NetBSD    | x86                              | 🟧      | 🟥                 | ❌ No
-NetBSD    | ARM64 Little Endian              | 🟧      | 🟥                 | ❌ 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
 🟥 Does not work yet
 
-This is still in development, bugs are to expected. More tests will come in the near future.
+This is still in development, bugs are to be expected. More tests will come in the near future.
 
 # Get started
 
@@ -226,6 +227,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 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.

package/package.json

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

package/qemu/qemu.js

@@ -430,16 +430,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"
                 }
             }