koffi 2.8.4 → 2.8.6

package/CHANGELOG.md

@@ -4,6 +4,16 @@
 
 ### Koffi 2.8
 
+#### Koffi 2.8.6 (2024-04-12)
+
+- Support [loading library](functions.md#loading-options) with RTLD_DEEPBIND where supported
+
+#### Koffi 2.8.5 (2024-04-11)
+
+- Prevent obviously invalid type and member names
+- Fix possible infinite loop / UB for `koffi.load()` errors on POSIX systems
+- Fix null return value instead of exception for some errors in `koffi.load()` on Windows
+
 #### Koffi 2.8.4 (2024-04-09)
 
 - Use simpler workaround for Node 20.12+ and 21.6+ to avoid excessive memory use

package/README.md

@@ -29,6 +29,12 @@ You can consult the [changelog](https://koffi.dev/changelog) on the official web
 
 Major version increments can include breaking API changes, use the [migration guide](https://koffi.dev/changelog#migration-guide) for more information.
 
+# Build manually
+
+Koffi is built with a custom CMake-wrapper called CNoke, which also lives in this repository. Don't try to run CMake manually because it will fail.
+
+Follow the [documented build instructions](https://koffi.dev/contribute#build-from-source) to build Koffi from source.
+
 # License
 
 This program is free software: you can redistribute it and/or modify it under the terms of the **MIT License**.

package/doc/contribute.md

@@ -25,7 +25,7 @@ First, make sure the following dependencies are met:
 
 - The "Desktop development with C++" workload from [Visual Studio 2022 or 2019](https://visualstudio.microsoft.com/downloads/) or the "C++ build tools" workload from the [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022), with the default optional components.
 - [CMake meta build system](https://cmake.org/)
-- [Node.js](https://nodejs.org/) 12 or later
+- [Node.js](https://nodejs.org/) 16 or later
 
 Once this is done, run this command _from the test or the benchmark directory_ (depending on what you want to build):
 
@@ -41,7 +41,7 @@ Make sure the following dependencies are met:
 - `gcc` and `g++` >= 8.3 or newer
 - GNU Make 3.81 or newer
 - [CMake meta build system](https://cmake.org/)
-- [Node.js](https://nodejs.org/) 12 or later
+- [Node.js](https://nodejs.org/) 16 or later
 
 Once this is done, run this command _from the test or the benchmark directory_ (depending on what you want to build):
 
@@ -64,6 +64,7 @@ node sync.js # Run synchronous unit tests
 node async.js # Run asynchronous unit tests
 node callbacks.js # Run callback unit tests
 node union.js # Run union unit tests
+node posix.js # Run POSIX-specific unit tests (not for Windows)
 node win32.js # Run Windows-specific unit tests (only on Windows)
 
 node sqlite.js # Run SQLite integration tests

package/doc/functions.md

@@ -21,14 +21,15 @@ On some platforms (such as with the [musl C library on Linux](https://wiki.musl-
 
 ## Loading options
 
-*New in Koffi 2.6 and Koffi 2.8.2*
+*New in Koffi 2.6, changed in Koffi 2.8.2 and Koffi 2.8.6*
 
 The `load` function can take an optional object argument, with the following options:
 
 ```js
 const options = {
     lazy: true, // Use RTLD_LAZY (lazy-binding) on POSIX platforms (by default, use RTLD_NOW)
-    global: true // Use RTLD_GLOBAL on POSIX platforms (by default, use RTLD_LOCAL)
+    global: true, // Use RTLD_GLOBAL on POSIX platforms (by default, use RTLD_LOCAL)
+    deep: true // Use RTLD_DEEPBIND if supported (Linux, FreeBSD)
 };
 
 const lib = koffi.load('/path/to/shared/library.so', options);

package/doc/start.md

@@ -109,4 +109,12 @@ if (ret == IDYES)
 
 ## Bundling Koffi
 
-Please read the [dedicated page](packaging.md) for information about bundling and packaging applications using Koffi.
+Please read the [dedicated page](packaging.md) for information about bundling and packaging applications using Koffi.
+
+## Build manually
+
+Follow the [build instrutions](contribute.md#build-from-source) if you want to build the native Koffi code yourself.
+
+```{note}
+This is only needed if you want to hack on Koffi. The official NPM package provide prebuilt binaries and you don't need to compile anything if you only want to use Koffi in Node.js.
+```

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.8.4",
-      stable: "2.8.4",
+      version: "2.8.6",
+      stable: "2.8.6",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

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.8.4",
-      stable: "2.8.4",
+      version: "2.8.6",
+      stable: "2.8.6",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

package/package.json

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

package/src/core/libcc/libcc.cc

@@ -1935,7 +1935,7 @@ bool GetDebugFlag(const char *name)
 #ifndef NDEBUG
 const char *DebugLogContext(const char *filename, int line)
 {
-    static RG_THREAD_LOCAL LocalArray<char, 1024> buf;
+    static thread_local LocalArray<char, 1024> buf;
 
     buf.len = Fmt(buf.data, "  [%1:%2] ", filename, line).len;
 

package/src/koffi/CMakeLists.txt

@@ -21,8 +21,12 @@
 
 cmake_minimum_required(VERSION 3.6)
 cmake_policy(SET CMP0091 NEW)
-project(koffi C CXX ASM)
 
+if(NOT NODE_JS_INCLUDE_DIRS)
+    message(FATAL_ERROR "Please use CNoke to build Koffi, follow instructions here: https://koffi.dev/contribute#build-from-source")
+endif()
+
+project(koffi C CXX ASM)
 find_package(CNoke)
 
 include(CheckCXXCompilerFlag)

package/src/koffi/src/ffi.cc

@@ -200,6 +200,38 @@ static inline bool CheckAlignment(int64_t align)
     return valid;
 }
 
+// Prevent simple mistakes but don't be too strict, the world is bigger than the US!
+static bool IsNameValid(const char *name)
+{
+    if (!name[0] || IsAsciiWhite(name[0]) || IsAsciiDigit(name[0])) [[unlikely]]
+        return false;
+
+    for (Size i = 1; name[i]; i++) {
+        if (IsAsciiWhite(name[i])) [[unlikely]]
+            return false;
+    }
+
+    return true;
+}
+
+static bool MapType(Napi::Env env, InstanceData *instance, const TypeInfo *type, const char *name)
+{
+    if (!IsNameValid(name)) {
+        ThrowError<Napi::Error>(env, "Invalid type name '%1'", name);
+        return false;
+    }
+
+    bool inserted;
+    instance->types_map.TrySet(name, type, &inserted);
+
+    if (!inserted) {
+        ThrowError<Napi::Error>(env, "Duplicate type name '%1'", name);
+        return false;
+    }
+
+    return true;
+}
+
 static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
 {
     Napi::Env env = info.Env();
@@ -245,13 +277,8 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
     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);
+        if (!MapType(env, instance, type, type->name))
             return env.Null();
-        }
     } else {
         type->name = Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
     }
@@ -312,6 +339,11 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
             return env.Null();
         }
 
+        if (!IsNameValid(member.name)) {
+            ThrowError<Napi::Error>(env, "Invalid member name '%1'", member.name);
+            return env.Null();
+        }
+
         bool inserted;
         members.TrySet(member.name, &inserted);
 
@@ -391,13 +423,8 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
     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);
+        if (!MapType(env, instance, type, type->name))
             return env.Null();
-        }
     } else {
         type->name = Fmt(&instance->str_alloc, "<anonymous_%1>", instance->types.len).ptr;
     }
@@ -449,6 +476,11 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
         size = std::max(size, member.type->size);
         type->align = std::max(type->align, align);
 
+        if (!IsNameValid(member.name)) {
+            ThrowError<Napi::Error>(env, "Invalid member name '%1'", member.name);
+            return env.Null();
+        }
+
         bool inserted;
         members.TrySet(member.name, &inserted);
 
@@ -530,15 +562,8 @@ static Napi::Value CreateOpaqueType(const Napi::CallbackInfo &info)
     type->align = 0;
 
     // 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();
-        }
-    }
+    if (named && !MapType(env, instance, type, type->name))
+        return env.Null();
     err_guard.Disable();
 
     return WrapType(env, instance, type);
@@ -594,14 +619,9 @@ static Napi::Value CreatePointerType(const Napi::CallbackInfo &info)
         memcpy((void *)copy, type, RG_SIZE(*type));
         copy->name = DuplicateString(name.c_str(), &instance->str_alloc).ptr;
 
-        bool inserted;
-        instance->types_map.TrySet(copy->name, copy, &inserted);
-
         // If the insert succeeds, we cannot fail anymore
-        if (!inserted) {
-            ThrowError<Napi::Error>(env, "Duplicate type name '%1'", copy->name);
+        if (!MapType(env, instance, copy, copy->name))
             return env.Null();
-        }
         err_guard.Disable();
 
         type = copy;
@@ -1090,15 +1110,8 @@ static Napi::Value CreateTypeAlias(const Napi::CallbackInfo &info)
         return env.Null();
 
     // Alias the type
-    {
-        bool inserted;
-        instance->types_map.TrySet(alias, type, &inserted);
-
-        if (!inserted) {
-            ThrowError<Napi::Error>(env, "Type name '%1' already exists", alias);
-            return env.Null();
-        }
-    }
+    if (!MapType(env, instance, type, alias))
+        return env.Null();
 
     return WrapType(env, instance, type);
 }
@@ -1724,6 +1737,9 @@ static Napi::Value LoadSharedLibrary(const Napi::CallbackInfo &info)
 
         flags |= options.Get("lazy").ToBoolean() ? RTLD_LAZY : RTLD_NOW;
         flags |= options.Get("global").ToBoolean() ? RTLD_GLOBAL : RTLD_LOCAL;
+#ifdef RTLD_DEEPBIND
+        flags |= options.Get("deep").ToBoolean() ? RTLD_DEEPBIND : 0;
+#endif
     } else {
         flags = RTLD_NOW | RTLD_LOCAL;
     }
@@ -1757,9 +1773,10 @@ static Napi::Value LoadSharedLibrary(const Napi::CallbackInfo &info)
 
             if (StartsWith(msg, filename.c_str())) {
                 msg += filename.length();
-            }
-            while (strchr(": ", msg[0])) {
-                msg++;
+
+                while (strchr(": ", msg[0]) && msg[0]) {
+                    msg++;
+                }
             }
 
             ThrowError<Napi::Error>(env, "Failed to load shared library: %1", msg);

package/src/koffi/src/win32.cc

@@ -74,8 +74,10 @@ HANDLE LoadWindowsLibrary(Napi::Env env, Span<const char> path)
 
     Span<wchar_t> filename_w = AllocateSpan<wchar_t>(&temp_alloc, path.len + 1);
 
-    if (ConvertUtf8ToWin32Wide(path, filename_w) < 0)
+    if (ConvertUtf8ToWin32Wide(path, filename_w) < 0) {
+        ThrowError<Napi::Error>(env, "Invalid path string");
         return nullptr;
+    }
 
     HMODULE module = LoadLibraryW(filename_w.ptr);
 
@@ -85,8 +87,10 @@ HANDLE LoadWindowsLibrary(Napi::Env env, Span<const char> path)
         Span<const char> filename = NormalizePath(path, GetWorkingDirectory(), &temp_alloc);
         Span<wchar_t> filename_w = AllocateSpan<wchar_t>(&temp_alloc, filename.len + 1);
 
-        if (ConvertUtf8ToWin32Wide(filename, filename_w) < 0)
+        if (ConvertUtf8ToWin32Wide(filename, filename_w) < 0) {
+            ThrowError<Napi::Error>(env, "Invalid path string");
             return nullptr;
+        }
 
         module = LoadLibraryExW(filename_w.ptr, nullptr, flags);
     }