koffi 2.8.5 → 2.8.6

package/CHANGELOG.md

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

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

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

@@ -1737,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;
     }