koffi 2.1.3 → 2.1.4

package/{benchmark → src/koffi/benchmark}/CMakeLists.txt

@@ -36,8 +36,9 @@ endif()
 
 # ---- atoi ----
 
-add_node_addon(NAME atoi_napi SOURCES atoi_napi.cc ../vendor/libcc/libcc.cc)
-target_include_directories(atoi_napi PRIVATE .. ../vendor/node-addon-api)
+add_node_addon(NAME atoi_napi SOURCES atoi_napi.cc ../../../src/core/libcc/libcc.cc)
+target_compile_definitions(atoi_napi PRIVATE LIBCC_NO_BROTLI LIBCC_NO_MINIZ)
+target_include_directories(atoi_napi PRIVATE ../../.. ../../../vendor/node-addon-api)
 target_link_libraries(atoi_napi PRIVATE Threads::Threads)
 
 if(WIN32)
@@ -49,8 +50,9 @@ endif()
 
 # ---- rand ----
 
-add_node_addon(NAME rand_napi SOURCES rand_napi.cc ../vendor/libcc/libcc.cc)
-target_include_directories(rand_napi PRIVATE .. ../vendor/node-addon-api)
+add_node_addon(NAME rand_napi SOURCES rand_napi.cc ../../../src/core/libcc/libcc.cc)
+target_compile_definitions(rand_napi PRIVATE LIBCC_NO_BROTLI LIBCC_NO_MINIZ)
+target_include_directories(rand_napi PRIVATE ../../.. ../../../vendor/node-addon-api)
 target_link_libraries(rand_napi PRIVATE Threads::Threads)
 
 if(WIN32)
@@ -62,8 +64,9 @@ endif()
 
 # ---- Raylib ----
 
-add_executable(raylib_cc raylib_cc.cc ../vendor/libcc/libcc.cc)
-target_include_directories(raylib_cc PRIVATE ..)
+add_executable(raylib_cc raylib_cc.cc  ../../../src/core/libcc/libcc.cc)
+target_compile_definitions(raylib_cc PRIVATE LIBCC_NO_BROTLI LIBCC_NO_MINIZ)
+target_include_directories(raylib_cc PRIVATE ../../..)
 target_link_libraries(raylib_cc PRIVATE Threads::Threads raylib)
 
 if(WIN32)

package/{benchmark → src/koffi/benchmark}/atoi_napi.cc

@@ -11,7 +11,7 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see https://www.gnu.org/licenses/.
 
-#include "vendor/libcc/libcc.hh"
+#include "src/core/libcc/libcc.hh"
 #include <napi.h>
 
 namespace RG {

package/src/koffi/benchmark/benchmark.js

@@ -0,0 +1,118 @@
+#!/usr/bin/env node
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+const { spawnSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const minimatch = require('minimatch');
+
+main();
+
+function main() {
+    try {
+        let select = process.argv.slice(2);
+        benchmark(select);
+    } catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+}
+
+function benchmark(select) {
+    if (!select.length || select.includes('rand'))
+        format(run('rand', 'rand_napi'), 'ns');
+    if (!select.length || select.includes('atoi'))
+        format(run('atoi', 'atoi_napi'), 'ns');
+    if (!select.length || select.includes('raylib'))
+        format(run('raylib', 'raylib_node_raylib'), 'us');
+}
+
+function run(name, ref) {
+    let tests = [];
+    {
+        let entries = fs.readdirSync(__dirname);
+
+        let pattern = name + '_*.js';
+        let re = minimatch.makeRe(pattern);
+
+        for (let entry of entries) {
+            if (entry.match(re)) {
+                let test = {
+                    name: path.basename(entry, '.js'),
+                    filename: path.join(__dirname, entry)
+                };
+
+                if (test.name == ref)
+                    ref = test;
+                tests.push(test);
+            }
+        }
+    }
+
+    if (typeof ref == 'string')
+        throw new Error('Failed to find reference test');
+
+    for (let test of tests) {
+        let proc = spawnSync(process.execPath, [test.filename]);
+
+        if (proc.status == null)
+            throw new Error(proc.error);
+        if (proc.status !== 0)
+            throw new Error(proc.stderr);
+
+        let perf = JSON.parse(proc.stdout);
+
+        test.iterations = perf.iterations;
+        test.time = perf.time;
+    }
+
+    for (let test of tests) {
+        test.ratio = (ref.time / ref.iterations) / (test.time / test.iterations);
+
+        if (test != ref) {
+            test.overhead = Math.round((1 / test.ratio - 1) * 100);
+        } else {
+            test.overhead = '(ref)';
+        }
+    }
+
+    tests.sort((test1, test2) => test2.ratio - test1.ratio);
+
+    return tests;
+}
+
+function format(tests, unit) {
+    let len0 = tests.reduce((acc, test) => Math.max(acc, test.name.length), 0);
+
+    console.log(`${'Benchmark'.padEnd(len0, ' ')} | Iteration time | Relative performance | Overhead`);
+    console.log(`${'-'.padEnd(len0, '-')} | -------------- | -------------------- | --------`);
+    for (let test of tests) {
+        let time = format_time(test.time / test.iterations, unit);
+        let ratio = test.ratio.toFixed(test.ratio < 0.01 ? 3 : 2);
+        let overhead = (typeof test.overhead == 'number') ? `${test.overhead >= 0 ? '+' : ''}${test.overhead}%` : test.overhead;
+
+        console.log(`${test.name.padEnd(len0, ' ')} | ${('' + time).padEnd(14, ' ')} | x${('' + ratio).padEnd(19, ' ')} | ${overhead}`);
+    }
+
+    console.log('');
+}
+
+function format_time(time, unit) {
+    switch (unit) {
+        case 'ms': { return (time * 1).toFixed(1) + ' ms'; } break;
+        case 'us': { return (time * 1000).toFixed(1) + ' µs'; } break;
+        case 'ns': { return (time * 10000000).toFixed(0) + ' ns'; } break;
+    }
+}

package/src/koffi/benchmark/rand_koffi.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+const koffi = require('./build/koffi.node');
+
+let sum = 0;
+
+main();
+
+function main() {
+    let time = 5000;
+
+    if (process.argv.length >= 3) {
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
+            throw new Error('Not a valid number');
+        if (time < 0)
+            throw new Error('Time must be positive');
+    }
+
+    let lib = koffi.load(process.platform == 'win32' ? 'msvcrt.dll' : null);
+
+    const srand = lib.cdecl('srand', 'void', ['uint']);
+    const rand = lib.cdecl('rand', 'int', []);
+
+    srand(42);
+
+    let start = performance.now();
+    let iterations = 0;
+
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += rand();
+
+        iterations += 1000000;
+    }
+
+    time = performance.now() - start;
+    console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
+}

package/src/koffi/benchmark/rand_napi.cc

@@ -0,0 +1,69 @@
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+#include "src/core/libcc/libcc.hh"
+#include <napi.h>
+
+namespace RG {
+
+template <typename T, typename... Args>
+void ThrowError(Napi::Env env, const char *msg, Args... args)
+{
+    char buf[1024];
+    Fmt(buf, msg, args...);
+
+    auto err = T::New(env, buf);
+    err.ThrowAsJavaScriptException();
+}
+
+static Napi::Value RunSrand(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    if (RG_UNLIKELY(info.Length() < 1)) {
+        ThrowError<Napi::TypeError>(env, "Expected 1 argument, got %1", info.Length());
+        return env.Null();
+    }
+    if (RG_UNLIKELY(!info[0].IsNumber())) {
+        ThrowError<Napi::TypeError>(env, "Unexpected type for seed, expected number");
+        return env.Null();
+    }
+
+    unsigned int seed = (info[0].As<Napi::Number>()).Uint32Value();
+    srand(seed);
+
+    return env.Null();
+}
+
+static Napi::Value RunRand(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    int rnd = rand();
+
+    return Napi::Number::New(env, rnd);
+}
+
+}
+
+static Napi::Object InitModule(Napi::Env env, Napi::Object exports)
+{
+    using namespace RG;
+
+    exports.Set("srand", Napi::Function::New(env, RunSrand));
+    exports.Set("rand", Napi::Function::New(env, RunRand));
+
+    return exports;
+}
+
+NODE_API_MODULE(koffi, InitModule);

package/src/koffi/benchmark/rand_napi.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+const rand = require('./build/rand_napi.node');
+
+let sum = 0;
+
+main();
+
+function main() {
+    let time = 5000;
+
+    if (process.argv.length >= 3) {
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
+            throw new Error('Not a valid number');
+        if (time < 0)
+            throw new Error('Time must be positive');
+    }
+
+    rand.srand(42);
+
+    let start = performance.now();
+    let iterations = 0;
+
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += rand.rand();
+
+        iterations += 1000000;
+    }
+
+    time = performance.now() - start;
+    console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
+}

package/src/koffi/benchmark/rand_node_ffi.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+const ref = require('ref-napi');
+const ffi = require('ffi-napi');
+const struct = require('ref-struct-di')(ref);
+
+let sum = 0;
+
+main();
+
+async function main() {
+    let time = 5000;
+
+    if (process.argv.length >= 3) {
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
+            throw new Error('Not a valid number');
+        if (time < 0)
+            throw new Error('Time must be positive');
+    }
+
+    const lib = ffi.Library(process.platform == 'win32' ? 'msvcrt.dll' : null, {
+        srand: ['void', ['uint']],
+        rand: ['int', []]
+    });
+
+    lib.srand(42);
+
+    let start = performance.now();
+    let iterations = 0;
+
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += lib.rand();
+
+        iterations += 1000000;
+    }
+
+    time = performance.now() - start;
+    console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
+}
+

package/{benchmark → src/koffi/benchmark}/raylib_cc.cc

@@ -11,8 +11,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see https://www.gnu.org/licenses/.
 
-#include "../vendor/libcc/libcc.hh"
-#include "../vendor/raylib/src/raylib.h"
+#include "src/core/libcc/libcc.hh"
+#include "vendor/raylib/src/raylib.h"
 
 namespace RG {
 

package/{doc → src/koffi/doc}/contribute.md

@@ -2,9 +2,9 @@
 
 ## Bugs and feature requests
 
-Use the official repository (named Luigi, because this is a monorepo containing multiple projects) for bugs, ideas and features requests.
+Use the official repository (named Rygel, because this is a monorepo containing multiple projects) for bugs, ideas and features requests.
 
-Go here: https://github.com/Koromix/luigi/
+Go here: https://github.com/Koromix/rygel/
 
 ## Build from source
 
@@ -13,8 +13,8 @@ We provide prebuilt binaries, packaged in the NPM archive, so in most cases it s
 Start by cloning the repository with [Git](https://git-scm.com/):
 
 ```sh
-git clone https://github.com/Koromix/luigi
-cd luigi/koffi
+git clone https://github.com/Koromix/rygel
+cd rygel/src/koffi
 ```
 
 As said before, this is a monorepository containg multiple projects, hence the name.
@@ -59,7 +59,7 @@ These machines are not included directly in this repository (for license and siz
 For example, if you want to run the tests on Debian ARM64, run the following commands:
 
 ```sh
-cd luigi/koffi/qemu/
+cd rygel/src/koffi/qemu/
 wget -q -O- https://koromix.dev/files/machines/qemu_debian_arm64.tar.zst | zstd -d | tar xv
 sha256sum -c --ignore-missing registry/sha256sum.txt
 ```

package/{doc → src/koffi/doc}/index.rst

@@ -14,7 +14,7 @@ Koffi is a **fast and easy-to-use C FFI module for Node.js**, featuring:
 
 Koffi requires a recent `Node.js <https://nodejs.org/>`_ version with N-API version 8 support, see :ref:`this page<Node.js>` for more information.
 
-The source code is available here: https://github.com/Koromix/luigi/ (in the *koffi* subdirectory).
+The source code is available here: https://github.com/Koromix/rygel/ (in the *src/koffi* subdirectory).
 
 Table of contents
 -----------------

package/{doc → src/koffi/doc}/memory.md

@@ -30,3 +30,4 @@ async_stack_size     | 256 kiB | Stack size for asynchronous calls
 async_heap_size      | 512 kiB | Heap size for asynchronous calls
 resident_async_pools | 2       | Number of resident pools for asynchronous calls
 max_async_calls      | 64      | Maximum number of ongoing asynchronous calls
+max_type_size        | 64 MiB  | Maximum size of Koffi types (for arrays and structs)

package/{doc → src/koffi/doc}/templates/badges.html

@@ -1,6 +1,6 @@
 <div style="text-align: center; margin-top: 2em;">
     <a href="https://www.npmjs.com/package/koffi"><img src="https://img.shields.io/badge/NPM-{{ stable }}-brightgreen" alt="NPM"/></a>
-    <a href="https://github.com/Koromix/luigi/tree/master/koffi"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a>
+    <a href="https://github.com/Koromix/rygel/tree/master/src/koffi"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a>
 
     <br><br>
     <iframe src="https://github.com/sponsors/Koromix/button" title="Sponsor Koromix" height="35" width="116" style="border: 0;"></iframe>