koffi 2.16.0-beta.2 → 2.16.0

package/src/koffi/src/util.hh

@@ -98,76 +98,13 @@ static inline bool IsObject(Napi::Value value)
     return value.IsObject() && !IsNullOrUndefined(value) && !value.IsArray();
 }
 
-template <typename T>
-bool TryNumber(Napi::Value value, T *out_value)
+static inline bool IsRawBuffer(Napi::Value value)
 {
-    // Assume number first
-    {
-        T v;
-        napi_status status;
-
-        if constexpr (std::is_same_v<T, double>) {
-            status = napi_get_value_double(value.Env(), value, &v);
-        } else if constexpr (std::is_same_v<T, float>) {
-            double d;
-            status = napi_get_value_double(value.Env(), value, &d);
-            v = (float)d;
-        } else {
-            int64_t i64;
-            status = napi_get_value_int64(value.Env(), value, &i64);
-            v = (T)i64;
-        }
-
-        if (status == napi_ok) [[likely]] {
-            *out_value = v;
-            return true;
-        }
-    }
-
-    if (value.IsBigInt()) {
-        Napi::BigInt bigint = value.As<Napi::BigInt>();
-
-        bool lossless;
-        *out_value = (T)bigint.Uint64Value(&lossless);
-
-        return true;
-    }
-
-    return false;
+    return value.IsTypedArray() || value.IsArrayBuffer();
 }
 
-static inline bool TryPointer(Napi::Value value, void **out_ptr)
+static inline Span<uint8_t> GetRawBuffer(Napi::Value value)
 {
-    if (IsNullOrUndefined(value)) {
-        *out_ptr = nullptr;
-        return true;
-    } else if (uintptr_t ptr = 0; TryNumber(value, &ptr)) {
-        *out_ptr = (void *)ptr;
-        return true;
-    } else if (value.IsTypedArray()) {
-        napi_get_typedarray_info(value.Env(), value, nullptr, nullptr, out_ptr, nullptr, nullptr);
-        return true;
-    } else if (value.IsExternal()) {
-        Napi::External<void> external = value.As<Napi::External<void>>();
-
-        *out_ptr = (void *)external.Data();
-        return true;
-    } else if (value.IsArrayBuffer()) {
-        Napi::ArrayBuffer buffer = value.As<Napi::ArrayBuffer>();
-
-        *out_ptr = (void *)buffer.Data();
-        return true;
-    }
-
-    return false;
-}
-
-static inline bool TryBuffer(Napi::Value value, Span<uint8_t> *out_buffer)
-{
-    // Before somewhere around Node 20.12, napi_get_buffer_info() would assert/crash
-    // when used with something it did not support, instead of returning napi_invalid_arg.
-    // So we need to call napi_is_buffer(), at least for now.
-
     if (value.IsBuffer()) {
         void *ptr = nullptr;
         size_t length = 0;
@@ -175,20 +112,35 @@ static inline bool TryBuffer(Napi::Value value, Span<uint8_t> *out_buffer)
         // Assume it works
         napi_get_buffer_info(value.Env(), value, &ptr, &length);
 
-        *out_buffer = MakeSpan((uint8_t *)ptr, (Size)length);
-        return true;
+        return MakeSpan((uint8_t *)ptr, (Size)length);
     } else if (value.IsArrayBuffer()) {
         Napi::ArrayBuffer buffer = value.As<Napi::ArrayBuffer>();
 
-        *out_buffer = MakeSpan((uint8_t *)buffer.Data(), (Size)buffer.ByteLength());
-        return true;
+        return MakeSpan((uint8_t *)buffer.Data(), (Size)buffer.ByteLength());
     }
 
-    return false;
+    K_UNREACHABLE();
 }
 
 int GetTypedArrayType(const TypeInfo *type);
 
+template <typename T>
+T GetNumber(Napi::Value value)
+{
+    K_ASSERT(value.IsNumber() || value.IsBigInt());
+
+    if (value.IsNumber()) [[likely]] {
+        return (T)value.As<Napi::Number>().DoubleValue();
+    } else if (value.IsBigInt()) {
+        Napi::BigInt bigint = value.As<Napi::BigInt>();
+
+        bool lossless;
+        return (T)bigint.Uint64Value(&lossless);
+    }
+
+    K_UNREACHABLE();
+}
+
 template <typename T>
 Size NullTerminatedLength(const T *ptr)
 {
@@ -260,9 +212,6 @@ static inline Napi::Array GetOwnPropertyNames(Napi::Object obj)
 
 Napi::Function WrapFunction(Napi::Env env, const FunctionInfo *func);
 
-Napi::Value WrapPointer(Napi::Env env, const TypeInfo *ref, void *ptr);
-Napi::Value WrapCallback(Napi::Env env, const TypeInfo *ref, void *ptr);
-
 bool DetectCallConvention(Span<const char> name, CallConvention *out_convention);
 
 int AnalyseFlat(const TypeInfo *type, FunctionRef<void(const TypeInfo *type, int offset, int count)> func);

package/src/koffi/src/win32.cc

@@ -180,6 +180,19 @@ int GetDllMachine(const wchar_t *filename)
     return GetFileMachine(h, true);
 }
 
+extern "C" int __cdecl SehHandler(void *ptr, void *, void *ctx, void *)
+{
+    EXCEPTION_RECORD *rec = (EXCEPTION_RECORD *)ptr;
+
+    if (!(rec->ExceptionFlags & (EXCEPTION_UNWINDING | EXCEPTION_EXIT_UNWIND))) {
+        EXCEPTION_POINTERS ep = { rec, (CONTEXT *)ctx };
+        UnhandledExceptionFilter(&ep);
+        ExitProcess(rec->ExceptionCode);
+    }
+
+    return ExceptionContinueSearch;
+}
+
 }
 
 #endif

package/src/koffi/src/win32.hh

@@ -87,6 +87,11 @@ static_assert(offsetof(TEB, DeallocationStack) == 0xE0C);
 static_assert(offsetof(TEB, GuaranteedStackBytes) == 0x0F78);
 static_assert(offsetof(TEB, SameTebFlags) == 0xFCA);
 
+struct SehFrame {
+    void *Next;
+    void *Handler;
+};
+
 #endif
 
 static inline TEB *GetTEB()
@@ -109,4 +114,6 @@ void *LoadWindowsLibrary(Napi::Env env, Span<const char> path); // Returns HANDL
 int GetSelfMachine();
 int GetDllMachine(const wchar_t *filename);
 
+extern "C" int __cdecl SehHandler(void *ptr, void *, void *ctx, void *);
+
 }

package/src/koffi/tools/write_trampolines.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
+
+const fs = require('fs');
+const path = require('path');
+
+main();
+
+async function main() {
+    try {
+        await run();
+    } catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+}
+
+function run() {
+    let args = process.argv.slice(2);
+
+    if (args.length < 2)
+        throw new Error('Usage: write_trampolines.js DIRECTORY N');
+
+    let dest_dir = args[0]?.trim?.();
+    let n = parseInt(args[1], 10);
+
+    if (!dest_dir)
+        throw new Error('Destination directory is empty');
+    if (Number.isNaN(n))
+        throw new Error('N must be an integer');
+
+    if (!fs.existsSync(dest_dir))
+        fs.mkdirSync(dest_dir);
+
+    writeAsmTrampolines(path.join(dest_dir, 'gnu.inc'), n,
+        i => `.global SYMBOL(Trampoline${i})`,
+        i => `SYMBOL(Trampoline${i}):\n    trampoline ${i}`
+    );
+    writeAsmTrampolines(path.join(dest_dir, 'armasm.inc'), n,
+        i => `    EXPORT Trampoline${i}`,
+        i => `Trampoline${i} PROC\n    trampoline ${i}\n    ENDP`,
+        `    END`
+    );
+    writeAsmTrampolines(path.join(dest_dir, 'masm64.inc'), n,
+        i => `public Trampoline${i}`,
+        i => `Trampoline${i} proc frame\n    trampoline ${i}\nTrampoline${i} endp`
+    );
+    writeAsmTrampolines(path.join(dest_dir, 'masm32.inc'), n,
+        i => `public Trampoline${i}`,
+        i => `Trampoline${i} proc\n    trampoline ${i}\nTrampoline${i} endp`
+    );
+}
+
+function writeAsmTrampolines(filename, n, fmt_export, fmt_proc, end = null) {
+    let lines = [];
+
+    for (let i = 0; i < n; i++) {
+        let line = fmt_export(i);
+        lines.push(line);
+    }
+    lines.push('');
+
+    for (let i = 0; i < n; i++) {
+        let line = fmt_proc(i);
+        lines.push(line);
+    }
+    lines.push('');
+
+    if (end !== null) {
+        lines.push(end);
+        lines.push('');
+    }
+
+    let content = lines.join('\n');
+    fs.writeFileSync(filename, content);
+}

package/doc/README.md

@@ -1,27 +0,0 @@
-# Install required dependencies
-
-On Debian and Ubuntu use the following commands:
-
-```sh
-sudo apt update
-sudo apt install build-essential
-```
-
-On RPM-based distributions such as Fedora or Rocky Linux, use:
-
-```sh
-sudo dnf groupinstall "Development Tools"
-sudo dnf install clang
-```
-
-# Run the develop script
-
-Run the development script from the website directory:
-
-```sh
-./develop.sh
-```
-
-Open the proposed link at `http://localhost:8000/`.
-
-Change page content at will and builds will happen automatically. You just need to refresh the page.

package/doc/assets.ini

@@ -1,24 +0,0 @@
-EsbuildPath = ../../vendor/esbuild/native/node_modules/@esbuild
-EsbuildRoot = ../..
-
-[favicon.png]
-Type = Copy
-From = static/koffi.png
-
-[static]
-Type = Copy
-From = static
-Ignore = favicon.png *.js *.css
-
-[static/site.min.js]
-Type = Bundle
-Source = ../../lib/web/flat/static.js
-
-[static/highlight.min.js]
-Type = Bundle
-Source = static/highlight.js
-
-[static/site.min.css]
-Type = Bundle
-Source = static/koffi.css
-Options = --loader:.woff2=file --loader:.png=file --loader:.webp=file

package/doc/build.sh

@@ -1,9 +0,0 @@
-#!/bin/bash -e
-
-cd "$(dirname $0)"
-
-../../bootstrap.sh
-../../felix -pFast hodler
-
-mkdir -p ../../bin/Web/koffi.dev
-../../bin/Fast/hodler . -O ../../bin/Web/koffi.dev --gzip

package/doc/develop.sh

@@ -1,15 +0,0 @@
-#!/bin/bash -e
-
-cd "$(dirname $0)"
-
-../../bootstrap.sh
-../../felix -pFast nestor hodler
-
-trap 'kill $(jobs -p) 2>/dev/null' EXIT
-trap 'kill $(jobs -p) 2>/dev/null' SIGINT
-
-mkdir -p dist
-../../bin/Fast/nestor dist/ &
-../../bin/Fast/hodler . -O dist --loop --sourcemap &
-
-wait $(jobs -p)

package/doc/pages/404.md

@@ -1,17 +0,0 @@
-*The page you requested does not exist...*
-
-<div class="error">Error 404</div>
-
-<style>
-    main {
-        display: flex;
-        flex-direction: column;
-        align-items: center;
-        justify-content: center;
-    }
-    .error {
-        margin: 0.8em;
-        font-size: 4em;
-        font-weight: bold;
-    }
-</style>

package/doc/pages.ini

@@ -1,86 +0,0 @@
-[pages/index.md]
-Title = Koffi
-Menu = Overview
-Description = Koffi presentation and features
-Template = templates/page.html
-
-[pages/start.md]
-Title = Get started | Koffi
-Menu = Documentation / Get started
-Description = Install and start using Koffi in your Node.js project
-Template = templates/code.html
-
-[pages/functions.md]
-Title = Function calls | Koffi
-Menu = Documentation / Function calls
-Description = Call native functions
-Template = templates/code.html
-
-[pages/input.md]
-Title = Input parameters | Koffi
-Menu = Documentation / Input parameters
-Template = templates/code.html
-
-[pages/pointers.md]
-Title = Data pointers | Koffi
-Menu = Documentation / Data pointers
-Template = templates/code.html
-
-[pages/output.md]
-Title = Output parameters | Koffi
-Menu = Documentation / Output parameters
-Template = templates/code.html
-
-[pages/unions.md]
-Title = Union values | Koffi
-Menu = Documentation / Union values
-Template = templates/code.html
-
-[pages/variables.md]
-Title = Exported variables | Koffi
-Menu = Documentation / Exported variables
-Template = templates/code.html
-
-[pages/callbacks.md]
-Title = Callbacks | Koffi
-Menu = Documentation / Javascript callbacks
-Template = templates/code.html
-
-[pages/misc.md]
-Title = Miscellaneous | Koffi
-Menu = Documentation / Miscellaneous
-Template = templates/code.html
-
-[pages/packaging.md]
-Title = Packaging | Koffi
-Menu = Documentation / Bundlers and Koffi
-Template = templates/code.html
-
-[pages/migration.md]
-Title = Migration | Koffi
-Menu = Documentation / Migration guide
-Description = Migration between major Koffi versions
-Template = templates/code.html
-
-[pages/benchmarks.md]
-Title = Benchmarks | Koffi
-Menu = Benchmarks
-Description = Performance of Koffi compared to NAPI and node-ffi
-Template = templates/code.html
-
-[pages/contribute.md]
-Title = Contribute | Koffi
-Menu = Contribute
-Description = How to get, build and test Koffi code
-Template = templates/code.html
-
-[changelog]
-SourceFile = ../../src/koffi/CHANGELOG.md
-Title = Changelog | Koffi
-Menu = Changelog
-Description = List of Koffi versions
-Template = templates/page.html
-
-[pages/404.md]
-Title = Page not found
-Template = templates/page.html

package/doc/static/highlight.js

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: MIT
-// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
-
-import * as hljs from '../../../vendor/highlight.js/highlight.js';
-
-window.addEventListener('load', e => {
-    hljs.highlightAll();
-});

package/doc/static/koffi.css

@@ -1,11 +0,0 @@
-/* SPDX-License-Identifier: MIT */
-/* SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com> */
-
-@import url('../../../lib/web/flat/flat.css');
-@import url('../../../vendor/highlight.js/styles/base16/tomorrow.css');
-
-html {
-    --top_color: #ec7400;
-    --button_color: #ec7400;
-    --anchor_color: #ec7400;
-}

package/doc/static/print.css

@@ -1,10 +0,0 @@
-/* SPDX-License-Identifier: MIT */
-/* SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com> */
-
-@media print {
-    .schema { width: 90%; }
-
-    .columns { display: block; }
-    .columns > * { width: auto; }
-    .columns > * + * { margin-top: 3em; }
-}

package/doc/templates/code.html

@@ -1,48 +0,0 @@
-<!DOCTYPE html>
-<html lang="en" class="nojs">
-    <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-
-        <title>{{ TITLE }}</title>
-        <meta name="author" content="Niels Martignène">
-        <meta name="description" content="{{ DESCRIPTION }}">
-        <link rel="icon" href="{{ ASSET favicon.png }}">
-
-        <meta name="theme-color" content="#6aa051">
-        <link rel="stylesheet" href="{{ ASSET static/site.min.css }}">
-
-        <script type="text/javascript" src="{{ ASSET static/site.min.js }}"></script>
-        <script type="text/javascript" src="{{ ASSET static/highlight.min.js }}"></script>
-    </head>
-
-    <body>
-        <nav id="top">
-            <div class="deploy"></div>
-            <menu>
-                <a id="logo" href="/"><img src="{{ ASSET static/logo.webp }}" width="370" height="198" alt="" /></a>
-
-{{ LINKS }}
-
-                <div style="flex: 1;"></div>
-
-                <li><a href="https://www.npmjs.com/package/koffi" style="border-bottom-color: transparent; margin-top: 8px;"><img src="https://img.shields.io/npm/v/koffi?color=brightgreen&cacheSeconds=7200" alt="NPM"/></a></li>
-                <li><a href="https://github.com/Koromix/koffi" style="border-bottom-color: transparent; margin-top: 8px;"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a></li>
-            </menu>
-        </nav>
-
-        {{ TOC }}
-
-        <main>
-            {{ CONTENT }}
-        </main>
-
-        <footer>
-            <div>Koffi © 2025</div>
-            <div style="font-size: 0.8em;">
-                Niels Martignène (<a href="https://koromix.dev/" target="_blank">Koromix</a>)<br>
-                <a href="mailto:niels.martignene@protonmail.com" style="font-weight: bold; color: inherit;">niels.martignene@protonmail.com</a>
-            </div>
-        </footer>
-    </body>
-</html>

package/doc/templates/page.html

@@ -1,47 +0,0 @@
-<!DOCTYPE html>
-<html lang="en" class="nojs">
-    <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-
-        <title>{{ TITLE }}</title>
-        <meta name="author" content="Niels Martignène">
-        <meta name="description" content="{{ DESCRIPTION }}">
-        <link rel="icon" href="{{ ASSET favicon.png }}">
-
-        <meta name="theme-color" content="#6aa051">
-        <link rel="stylesheet" href="{{ ASSET static/site.min.css }}">
-
-        <script type="text/javascript" src="{{ ASSET static/site.min.js }}"></script>
-    </head>
-
-    <body>
-        <nav id="top">
-            <div class="deploy"></div>
-            <menu>
-                <a id="logo" href="/"><img src="{{ ASSET static/logo.webp }}" width="370" height="198" alt="" /></a>
-
-{{ LINKS }}
-
-                <div style="flex: 1;"></div>
-
-                <li><a href="https://www.npmjs.com/package/koffi" style="border-bottom-color: transparent; margin-top: 8px;"><img src="https://img.shields.io/npm/v/koffi?color=brightgreen&cacheSeconds=7200" alt="NPM"/></a></li>
-                <li><a href="https://github.com/Koromix/koffi" style="border-bottom-color: transparent; margin-top: 8px;"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a></li>
-            </menu>
-        </nav>
-
-        {{ TOC }}
-
-        <main>
-            {{ CONTENT }}
-        </main>
-
-        <footer>
-            <div>Koffi © 2025</div>
-            <div style="font-size: 0.8em;">
-                Niels Martignène (<a href="https://koromix.dev/" target="_blank">Koromix</a>)<br>
-                <a href="mailto:niels.martignene@protonmail.com" style="font-weight: bold; color: inherit;">niels.martignene@protonmail.com</a>
-            </div>
-        </footer>
-    </body>
-</html>

package/src/koffi/cmake/raylib.cmake

@@ -1,85 +0,0 @@
-# SPDX-License-Identifier: MIT
-# SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
-
-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 _GLFW_WIN32 _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
-    target_link_libraries(raylib PRIVATE winmm)
-endif()
-
-if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-    target_compile_definitions(raylib PRIVATE _GNU_SOURCE)
-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 _GLFW_COCOA 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_compile_definitions(raylib PRIVATE _GLFW_X11)
-    target_include_directories(raylib PRIVATE ${XLIB_INCLUDE_DIRS})
-endif()

package/src/koffi/cmake/sqlite3.cmake

@@ -1,9 +0,0 @@
-# SPDX-License-Identifier: MIT
-# SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
-
-add_library(sqlite3 SHARED ../../../vendor/sqlite3mc/sqlite3.c)
-set_target_properties(sqlite3 PROPERTIES PREFIX "")
-
-if(WIN32)
-    target_compile_definitions(sqlite3 PRIVATE SQLITE_API=__declspec\(dllexport\))
-endif()

package/src/koffi/examples/electron-builder/README.md

@@ -1,11 +0,0 @@
-This is a simple example shows:
-
-- How to communicate with Koffi from a renderer window
-- How to use electron-builder with an application that uses Koffi
-
-Use the following commands to package the app for your system:
-
-```sh
-npm install
-npm run dist
-```