koffi 2.6.4 → 2.6.5

package/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ### 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

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/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.4",
-      stable: "2.6.4",
+      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.4",
-      stable: "2.6.4",
+      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.4",
-    "stable": "2.6.4",
+    "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;

package/src/core/libcc/libcc.cc

@@ -2428,11 +2428,15 @@ StatResult StatFile(const char *filename, unsigned int flags, FileInfo *out_info
                       (int64_t)sb.st_mtim.tv_nsec / 1000000;
     out_info->btime = (int64_t)sb.__st_birthtim.tv_sec * 1000 +
                       (int64_t)sb.__st_birthtim.tv_nsec / 1000000;
-#else
+#elif defined(__FreeBSD__)
     out_info->mtime = (int64_t)sb.st_mtim.tv_sec * 1000 +
                       (int64_t)sb.st_mtim.tv_nsec / 1000000;
     out_info->btime = (int64_t)sb.st_birthtim.tv_sec * 1000 +
                       (int64_t)sb.st_birthtim.tv_nsec / 1000000;
+#else
+    out_info->mtime = (int64_t)sb.st_mtim.tv_sec * 1000 +
+                      (int64_t)sb.st_mtim.tv_nsec / 1000000;
+    out_info->btime = out_info->mtime;
 #endif
     out_info->mode = (unsigned int)sb.st_mode;
     out_info->uid = (uint32_t)sb.st_uid;

package/src/koffi/cmake/raylib.cmake

@@ -0,0 +1,98 @@
+# Copyright 2023 Niels Martignène <niels.martignene@protonmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the “Software”), to deal in 
+# the Software without restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+add_library(raylib SHARED
+    ../../../vendor/raylib/src/rcore.c
+    ../../../vendor/raylib/src/rshapes.c
+    ../../../vendor/raylib/src/rtextures.c
+    ../../../vendor/raylib/src/rtext.c
+    ../../../vendor/raylib/src/rmodels.c
+    ../../../vendor/raylib/src/utils.c
+    ../../../vendor/raylib/src/rglfw.c
+    ../../../vendor/raylib/src/raudio.c
+)
+set_target_properties(raylib PROPERTIES PREFIX "")
+target_include_directories(raylib PRIVATE ../../../vendor/raylib/src/external/glfw/include)
+target_compile_definitions(raylib PRIVATE PLATFORM_DESKTOP GRAPHICS_API_OPENGL_21 BUILD_LIBTYPE_SHARED NDEBUG)
+
+if(MSVC)
+    target_compile_options(raylib PRIVATE /wd4244 /wd4305)
+else()
+    target_compile_options(raylib PRIVATE -Wno-sign-compare -Wno-old-style-declaration
+                                          -Wno-unused-function -Wno-missing-field-initializers
+                                          -Wno-unused-value -Wno-implicit-fallthrough -Wno-stringop-overflow
+                                          -Wno-unused-result)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+        target_compile_options(raylib PRIVATE -Wno-unknown-warning-option)
+    endif()
+endif()
+
+if(WIN32)
+    target_compile_definitions(raylib PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
+    target_link_libraries(raylib PRIVATE winmm)
+endif()
+
+if(CMAKE_SYSTEM_NAME MATCHES "BSD")
+    target_include_directories(raylib PRIVATE /usr/local/include)
+endif()
+
+if(APPLE)
+    target_compile_options(raylib PRIVATE -Wno-unknown-warning-option -Wno-macro-redefined)
+    target_compile_definitions(raylib PRIVATE GL_SILENCE_DEPRECATION)
+    set_source_files_properties(../../../vendor/raylib/src/rglfw.c PROPERTIES COMPILE_FLAGS "-x objective-c")
+    target_link_libraries(raylib PRIVATE "-framework Cocoa" "-framework IOKit" "-framework CoreFoundation" "-framework OpenGL")
+endif()
+
+if(UNIX AND NOT APPLE)
+    set(missing_xlib "")
+
+    find_path(XLIB_INCLUDE_DIRS X11/Xlib.h)
+    if(NOT XLIB_INCLUDE_DIRS)
+        list(APPEND missing_xlib Xlib)
+    endif()
+    find_path(XCURSOR_INCLUDE_DIRS X11/Xcursor/Xcursor.h)
+    if(NOT XCURSOR_INCLUDE_DIRS)
+        list(APPEND missing_xlib Xcursor)
+    endif()
+    find_path(XRANDR_INCLUDE_DIRS X11/extensions/Xrandr.h)
+    if(NOT XRANDR_INCLUDE_DIRS)
+        list(APPEND missing_xlib Xrandr)
+    endif()
+    find_path(XKB_INCLUDE_DIRS X11/XKBlib.h)
+    if(NOT XKB_INCLUDE_DIRS)
+        list(APPEND missing_xlib Xkbcommon)
+    endif()
+    find_path(XINERAMA_INCLUDE_DIRS X11/extensions/Xinerama.h)
+    if(NOT XINERAMA_INCLUDE_DIRS)
+        list(APPEND missing_xlib Xinerama)
+    endif()
+    find_path(XINPUT_INCLUDE_DIRS X11/extensions/XInput2.h)
+    if(NOT XINPUT_INCLUDE_DIRS)
+        list(APPEND missing_xlib XInput2)
+    endif()
+
+    if(missing_xlib)
+        list(JOIN missing_xlib ", " missing_xlib_str)
+        message(FATAL_ERROR "Missing X11 development files: ${missing_xlib_str}")
+    endif()
+
+    target_include_directories(raylib PRIVATE ${XLIB_INCLUDE_DIRS})
+endif()

package/src/koffi/cmake/sqlite.cmake

@@ -0,0 +1,27 @@
+# Copyright 2023 Niels Martignène <niels.martignene@protonmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the “Software”), to deal in 
+# the Software without restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+add_library(sqlite3 SHARED ../../../vendor/sqlite3/sqlite3.c)
+set_target_properties(sqlite3 PROPERTIES PREFIX "")
+
+if(WIN32)
+    target_compile_definitions(sqlite3 PRIVATE SQLITE_API=__declspec\(dllexport\))
+endif()

package/src/koffi/src/ffi.cc

@@ -225,18 +225,38 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
         return env.Null();
     }
 
+    RG_DEFER_NC(err_guard, len = instance->types.len) {
+        for (Size i = len + 1; i < instance->types.len; i++) {
+            const TypeInfo &type = instance->types[i];
+            instance->types_map.Remove(type.name);
+        }
+
+        instance->types.RemoveFrom(len);
+    };
+
     TypeInfo *type = instance->types.AppendDefault();
-    RG_DEFER_N(err_guard) { instance->types.RemoveLast(1); };
 
     Napi::String name = info[0].As<Napi::String>();
     Napi::Object obj = info[named].As<Napi::Object>();
     Napi::Array keys = obj.GetPropertyNames();
 
-    type->name = named ? DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr
-                       : Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
+    if (named) {
+        type->name = DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr;
+
+        bool inserted;
+        instance->types_map.TrySet(type->name, type, &inserted);
+
+        if (!inserted) {
+            ThrowError<Napi::Error>(env, "Duplicate type name '%1'", type->name);
+            return env.Null();
+        }
+    } else {
+        type->name = Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
+    }
 
     type->primitive = PrimitiveKind::Record;
     type->align = 1;
+    type->flags = (int)TypeFlag::IsIncomplete;
 
     HashSet<const char *> members;
     int64_t size = 0;
@@ -308,16 +328,7 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
     }
     type->size = (int32_t)size;
 
-    // If the insert succeeds, we cannot fail anymore
-    if (named) {
-        bool inserted;
-        instance->types_map.TrySet(type->name, type, &inserted);
-
-        if (!inserted) {
-            ThrowError<Napi::Error>(env, "Duplicate type name '%1'", type->name);
-            return env.Null();
-        }
-    }
+    type->flags &= ~(int)TypeFlag::IsIncomplete;
     err_guard.Disable();
 
     return WrapType(env, instance, type);
@@ -354,18 +365,38 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
         return env.Null();
     }
 
+    RG_DEFER_NC(err_guard, len = instance->types.len) {
+        for (Size i = len + 1; i < instance->types.len; i++) {
+            const TypeInfo &type = instance->types[i];
+            instance->types_map.Remove(type.name);
+        }
+
+        instance->types.RemoveFrom(len);
+    };
+
     TypeInfo *type = instance->types.AppendDefault();
-    RG_DEFER_N(err_guard) { instance->types.RemoveLast(1); };
 
     Napi::String name = info[0].As<Napi::String>();
     Napi::Object obj = info[named].As<Napi::Object>();
     Napi::Array keys = obj.GetPropertyNames();
 
-    type->name = named ? DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr
-                       : Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
+    if (named) {
+        type->name = DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr;
+
+        bool inserted;
+        instance->types_map.TrySet(type->name, type, &inserted);
+
+        if (!inserted) {
+            ThrowError<Napi::Error>(env, "Duplicate type name '%1'", type->name);
+            return env.Null();
+        }
+    } else {
+        type->name = Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
+    }
 
     type->primitive = PrimitiveKind::Union;
     type->align = 1;
+    type->flags = (int)TypeFlag::IsIncomplete;
 
     HashSet<const char *> members;
     int32_t size = 0;
@@ -428,16 +459,7 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
     }
     type->size = (int32_t)size;
 
-    // If the insert succeeds, we cannot fail anymore
-    if (named) {
-        bool inserted;
-        instance->types_map.TrySet(type->name, type, &inserted);
-
-        if (!inserted) {
-            ThrowError<Napi::Error>(env, "Duplicate type name '%1'", type->name);
-            return env.Null();
-        }
-    }
+    type->flags &= ~(int)TypeFlag::IsIncomplete;
     err_guard.Disable();
 
     // Union constructor

package/src/koffi/src/ffi.hh

@@ -104,8 +104,9 @@ class CallData;
 typedef void DisposeFunc (Napi::Env env, const TypeInfo *type, const void *ptr);
 
 enum class TypeFlag {
-    HasTypedArray = 1 << 0,
-    IsCharLike = 1 << 1
+    IsIncomplete = 1 << 0,
+    HasTypedArray = 1 << 1,
+    IsCharLike = 1 << 2
 };
 
 enum class ArrayHint {

package/src/koffi/src/util.cc

@@ -120,7 +120,9 @@ const TypeInfo *ResolveType(Napi::Value value, int *out_directions)
         const TypeInfo *type = ResolveType(env, str.c_str(), out_directions);
 
         if (!type) {
-            ThrowError<Napi::TypeError>(env, "Unknown or invalid type name '%1'", str.c_str());
+            if (!env.IsExceptionPending()) {
+                ThrowError<Napi::TypeError>(env, "Unknown or invalid type name '%1'", str.c_str());
+            }
             return nullptr;
         }
 
@@ -299,6 +301,11 @@ const TypeInfo *ResolveType(Napi::Env env, Span<const char> str, int *out_direct
         RG_ASSERT(type);
     }
 
+    if (type->flags & (int)TypeFlag::IsIncomplete) [[unlikely]] {
+        ThrowError<Napi::TypeError>(env, "Cannot directly use incomplete type");
+        return nullptr;
+    }
+
     return type;
 }