koffi 2.6.3 → 2.6.5

package/CHANGELOG.md

@@ -4,6 +4,15 @@
 
 ### Koffi 2.6
 
+#### Koffi 2.6.5 (2023-10-28)
+
+- Allow self-referential structs and unions
+- Fix rare Node.js "FATAL ERROR" with some invalid types specifiers
+
+#### Koffi 2.6.4 (2023-10-26)
+
+- Fix build issue with recent Visual Studio versions
+
 #### Koffi 2.6.3 (2023-10-17)
 
 - Add indirect loading script to help some bundlers

package/doc/benchmarks.md

@@ -10,8 +10,8 @@ Here is a quick overview of the execution time of Koffi calls on three benchmark
 
 <table style="margin: 0 auto;">
     <tr>
-        <td><a href="_static/perf_linux_20220812.png" target="_blank"><img src="_static/perf_linux_20220812.png" alt="Linux x86_64 performance" style="width: 350px;"/></a></td>
-        <td><a href="_static/perf_windows_20220812.png" target="_blank"><img src="_static/perf_windows_20220812.png" alt="Windows x86_64 performance" style="width: 350px;"/></a></td>
+        <td><a href="_static/perf_linux_20231028.png" target="_blank"><img src="_static/perf_linux_20231028.png" alt="Linux x86_64 performance" style="width: 350px;"/></a></td>
+        <td><a href="_static/perf_windows_20231028.png" target="_blank"><img src="_static/perf_windows_20231028.png" alt="Windows x86_64 performance" style="width: 350px;"/></a></td>
     </tr>
 </table>
 
@@ -31,9 +31,9 @@ This test is based around repeated calls to a simple standard C function `rand`,
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-rand_napi     | 842 ns         | x1.00                | (ref)
-rand_koffi    | 1114 ns        | x0.76                | +32%
-rand_node_ffi | 44845 ns       | x0.02                | +5224%
+rand_napi     | 700 ns         | x1.00                | (ref)
+rand_koffi    | 1152 ns        | x0.61                | +64%
+rand_node_ffi | 32750 ns       | x0.02                | +4576%
 
 Because rand is a pretty small function, the FFI overhead is clearly visible.
 
@@ -43,9 +43,9 @@ This test is similar to the rand one, but it is based on `atoi`, which takes a s
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-atoi_napi     | 921 ns         | x1.00                | (ref)
-atoi_koffi    | 1357 ns        | x0.68                | +47%
-atoi_node_ffi | 152550 ns      | x0.006               | +16472%
+atoi_napi     | 1028 ns        | x1.00                | (ref)
+atoi_koffi    | 1730 ns        | x0.59                | +68%
+atoi_node_ffi | 121670 ns      | x0.008               | +11738%
 
 Because atoi is a pretty small function, the FFI overhead is clearly visible.
 
@@ -58,10 +58,10 @@ This benchmark uses the CPU-based image drawing functions in Raylib. The calls a
 
 Benchmark          | Iteration time | Relative performance | Overhead
 ------------------ | -------------- | -------------------- | --------
-raylib_cc          | 215.7 µs       | x1.20                | -17%
-raylib_node_raylib | 258.9 µs       | x1.00                | (ref)
-raylib_koffi       | 311.6 µs       | x0.83                | +20%
-raylib_node_ffi    | 928.4 µs       | x0.28                | +259%
+raylib_cc          | 18.5 µs        | x1.42                | -30%
+raylib_node_raylib | 26.3 µs        | x1.00                | (ref)
+raylib_koffi       | 28.0 µs        | x0.94                | +6%
+raylib_node_ffi    | 87.0 µs        | x0.30                | +230%
 
 ## Windows x86_64
 
@@ -77,9 +77,9 @@ This test is based around repeated calls to a simple standard C function `rand`,
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-rand_napi     | 964 ns         | x1.00                | (ref)
-rand_koffi    | 1274 ns        | x0.76                | +32%
-rand_node_ffi | 42300 ns       | x0.02                | +4289%
+rand_napi     | 859 ns         | x1.00                | (ref)
+rand_koffi    | 1352 ns        | x0.64                | +57%
+rand_node_ffi | 35640 ns       | x0.02                | +4048%
 
 Because rand is a pretty small function, the FFI overhead is clearly visible.
 
@@ -91,9 +91,9 @@ The results below were measured on my x86_64 Windows machine (Intel® Core™ i5
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-atoi_napi     | 1415 ns        | x1.00                | (ref)
-atoi_koffi    | 2193 ns        | x0.65                | +55%
-atoi_node_ffi | 168300 ns      | x0.008               | +11792%
+atoi_napi     | 1336 ns        | x1.00                | (ref)
+atoi_koffi    | 2440 ns        | x0.55                | +83%
+atoi_node_ffi | 136890 ns      | x0.010               | +10144%
 
 Because atoi is a pretty small function, the FFI overhead is clearly visible.
 
@@ -106,26 +106,19 @@ This benchmark uses the CPU-based image drawing functions in Raylib. The calls a
 
 Benchmark          | Iteration time | Relative performance | Overhead
 ------------------ | -------------- | -------------------- | --------
-raylib_cc          | 211.8 µs       | x1.25                | -20%
-raylib_node_raylib | 264.4 µs       | x1.00                | (ref)
-raylib_koffi       | 318.9 µs       | x0.83                | +21%
-raylib_node_ffi    | 1146.2 µs      | x0.23                | +334%
-
-Please note that in order to get fair numbers for raylib_node_raylib, it was recompiled with clang-cl before running the benchmark with the following commands:
-
-```batch
-cd node_modules\raylib
-rmdir /S /Q bin build
-npx cmake-js compile -t ClangCL
-```
+raylib_cc          | 18.2 µs        | x1.50                | -33%
+raylib_node_raylib | 27.3 µs        | x1.00                | (ref)
+raylib_koffi       | 29.8 µs        | x0.92                | +9%
+raylib_node_ffi    | 96.3 µs        | x0.28                | +253%
 
 ## Running benchmarks
 
-Open a console, go to `koffi/benchmark` and run `../../cnoke/cnoke.js` (or `node ..\..\cnoke\cnoke.js` on Windows) before doing anything else.
-
-Please note that all benchmark results are made with Clang-built binaries.
+Please note that all benchmark results on this page are made with Clang-built binaries.
 
 ```sh
+cd koffi
+node ../../cnoke/cnoke.js --prefer-clang
+
 cd koffi/benchmark
 node ../../cnoke/cnoke.js --prefer-clang
 ```

package/doc/contribute.md

@@ -139,7 +139,7 @@ Once this is done, you can publish a new release with the following commands:
 
 ```sh
 node tools/qemu.js test # If not done before
-node tools/qemu.js dist
+node tools/qemu.js build
 
 cd build/dist
 npm publish

package/doc/packaging.md

@@ -1,6 +1,8 @@
 # Bundlers and Koffi
 
-## Bundling and native modules
+## Bundling
+
+### Native modules
 
 *Simplified in Koffi 2.5.9*
 
@@ -36,7 +38,7 @@ resources/
 MyApp.exe
 ```
 
-## Indirect loader
+### Indirect loader
 
 *New in Koffi 2.6.2*
 

package/index.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.6.3",
-      stable: "2.6.3",
+      version: "2.6.5",
+      stable: "2.6.5",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",
@@ -413,10 +413,9 @@ var require_package = __commonJS({
         chalk: "^4.1.2",
         esbuild: "^0.19.2",
         "ffi-napi": "^4.0.3",
-        "ffi-rs": "^1.0.12",
         minimatch: "^5.0.1",
         "node-ssh": "^12.0.3",
-        raylib: "^0.9.2",
+        raylib: "^0.14.0",
         "ref-napi": "^3.0.3",
         "ref-struct-di": "^1.1.1",
         tar: "^6.1.11"

package/indirect.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.6.3",
-      stable: "2.6.3",
+      version: "2.6.5",
+      stable: "2.6.5",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",
@@ -413,10 +413,9 @@ var require_package = __commonJS({
         chalk: "^4.1.2",
         esbuild: "^0.19.2",
         "ffi-napi": "^4.0.3",
-        "ffi-rs": "^1.0.12",
         minimatch: "^5.0.1",
         "node-ssh": "^12.0.3",
-        raylib: "^0.9.2",
+        raylib: "^0.14.0",
         "ref-napi": "^3.0.3",
         "ref-struct-di": "^1.1.1",
         tar: "^6.1.11"

package/package.json

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

package/src/cnoke/src/builder.js

@@ -340,9 +340,9 @@ function Builder(config = {}) {
 
     function get_cache_directory() {
         if (process.platform == 'win32') {
-            let cache_dir = process.env['APPDATA'];
+            let cache_dir = process.env['LOCALAPPDATA'] || process.env['APPDATA'];
             if (cache_dir == null)
-                throw new Error('Missing APPDATA environment variable');
+                throw new Error('Missing LOCALAPPDATA and APPDATA environment variable');
 
             cache_dir = path.join(cache_dir, 'cnoke');
             return cache_dir;