koffi 0.9.24 → 0.9.25

package/README.md

@@ -7,6 +7,8 @@
 - [Get started](#get-started)
 - [Tests](#tests)
 - [Benchmarks](#benchmarks)
+  * [atoi results](#atoi-results)
+  * [Raylib results](#raylib-results)
 
 # Introduction
 
@@ -253,33 +255,90 @@ node test.js info debian_x64
 
 # Benchmarks
 
-A basic benchmark based around Raylib is available, in three implementations: with Koffi, with node-ffi and with C code using Raylib (as a shared library).
+At this stage, two benchmarks are implemented:
+* The first one is based around repeated calls to atoi, and has four implementations: one in C++, one calling atoi through an NAPI module, one using Koffi, and one with node-ffi-napi. This is a simple function, thus the JS and FFI overhead is clearly visible.
+* The second one is based around Raylib, and will execute much more heavier functions repeatdly. Also in three versions: Koffi, node-ffi-napi and C code.
 
-In order to run it, go to `koffi/benchmark` and run `build.sh` before doing anything else.
+In order to run it, go to `koffi/benchmark` and run `../../cnoke/cnoke.js` (or `node ..\..\cnoke\cnoke.js` on Windows) before doing anything else.
 
-Once this is done, you can execute each implementation with `time`, e.g. `time ./raylib_c 2000`.
+Once this is done, you can execute each implementation, e.g. `build/atoi_cc 20000000` or `./atoi_koffi.js 20000000`.
 
-Here are some results from 2022-04-15 on my machine (AMD Ryzen™ 7 5800H 16G):
+## atoi results
+
+Here are some results from 2022-04-24 on my Linux machine (AMD® Ryzen™ 7 5800H 16G):
+
+```sh
+$ build/atoi_cc 20000000
+Iterations: 20000000
+Time: 0.24s
+
+$ ./atoi_napi.js 20000000
+Iterations: 20000000
+Time: 1.56s
+
+$ ./atoi_koffi.js 20000000
+Iterations: 20000000
+Time: 2.41s
+
+# Note: the Node-FFI version does a few setTimeout calls to force the GC to run (around 20
+# for the example below), without which Node will consume all memory because the GC never appears
+# to run, or not enough. It's not ideal but on the other hand it counts as another limitation
+# to Node-FFI performance.
+$ ./atoi_node_ffi.js 20000000
+Iterations: 20000000
+Time: 640.49s
+```
+
+And on my Windows machine (Intel® Core™ i5-4460 16G):
+
+```sh
+$ build\atoi_cc.exe 20000000
+Iterations: 20000000
+Time: 0.66s
+
+$ node atoi_napi.js 20000000
+Iterations: 20000000
+Time: 3.52s
+
+$ node atoi_koffi.js 20000000
+Iterations: 20000000
+Time: 4.81s
+
+$ node atoi_node_ffi.js 20000000
+Iterations: 20000000
+Time: 491.99s
+```
+
+## Raylib results
+
+Here are some results from 2022-04-24 on my Linux machine (AMD® Ryzen™ 7 5800H 16G):
 
 ```sh
-$ time ./raylib_c 200
-Iterations: 200
+$ build/raylib_cc 100
+Iterations: 100
+Time: 4.14s
+
+$ ./raylib_koffi.js 100
+Iterations: 100
+Time: 6.25s
 
-real    0m8,871s
-user    0m8,792s
-sys     0m0,016s
+$ ./raylib_node_ffi.js 100
+Iterations: 100
+Time: 27.13s
+```
 
-$ time ./raylib_koffi.js 200
-Iterations: 200
+And on my Windows machine (Intel® Core™ i5-4460 16G):
 
-real    0m13,011s
-user    0m12,923s
-sys     0m0,032s
+```sh
+$ build\raylib_cc.exe 100
+Iterations: 100
+Time: 10.53s
 
-$ time ./raylib_node_ffi.js 200
-Iterations: 200
+$ node raylib_koffi.js 100
+Iterations: 100
+Time: 14.60s
 
-real    1m41,523s
-user    1m56,623s
-sys     0m3,731s
+$ node raylib_node_ffi.js 100
+Iterations: 100
+Time: 44.97s
 ```

package/benchmark/CMakeLists.txt

@@ -0,0 +1,51 @@
+# 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/.
+
+cmake_minimum_required(VERSION 3.12)
+project(koffi C CXX ASM)
+
+find_package(CNoke)
+
+set(CMAKE_CXX_STANDARD 17)
+
+add_subdirectory(.. koffi)
+add_subdirectory(../test test)
+
+# ---- atoi ----
+
+add_executable(atoi_cc atoi_cc.cc ../vendor/libcc/libcc.cc)
+target_include_directories(atoi_cc PRIVATE ..)
+
+if(WIN32)
+    target_compile_definitions(atoi_cc PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
+    target_link_libraries(atoi_cc PRIVATE ws2_32)
+endif()
+
+add_node_addon(NAME atoi_napi SOURCES atoi_napi.cc ../vendor/libcc/libcc.cc)
+target_include_directories(atoi_napi PRIVATE .. ../vendor/node-addon-api)
+
+if(WIN32)
+    target_compile_definitions(atoi_napi PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
+    target_link_libraries(atoi_napi PRIVATE ws2_32)
+endif()
+
+# ---- Raylib ----
+
+add_executable(raylib_cc atoi_cc.cc ../vendor/libcc/libcc.cc)
+target_include_directories(raylib_cc PRIVATE ..)
+add_dependencies(raylib_cc raylib)
+
+if(WIN32)
+    target_compile_definitions(raylib_cc PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
+    target_link_libraries(raylib_cc PRIVATE ws2_32)
+endif()

package/benchmark/atoi_cc.cc

@@ -0,0 +1,62 @@
+// 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 "../vendor/libcc/libcc.hh"
+
+namespace RG {
+
+static const char * strings[] = {
+    "424242",
+    "foobar",
+    "123456789",
+};
+
+volatile uint64_t sum = 0;
+
+int Main(int argc, char **argv)
+{
+    if (argc < 2) {
+        LogError("Missing number of iterations");
+        LogInfo("Usage: atoi_cc <iterations>");
+        return 1;
+    }
+
+    int iterations = 0;
+    if (!ParseInt(argv[1], &iterations))
+        return 1;
+    LogInfo("Iterations: %1", iterations);
+
+    int64_t start = GetMonotonicTime();
+
+    for (int i = 0; i < iterations; i++) {
+        sum += (uint64_t)atoi(strings[i % RG_LEN(strings)]);
+    }
+
+    // Help prevent optimisation of loop
+    {
+        PushLogFilter([](LogLevel, const char *, const char *, FunctionRef<LogFunc>) {});
+        RG_DEFER { PopLogFilter(); };
+
+        LogInfo("Sum = %1", sum);
+    }
+
+    int64_t time = GetMonotonicTime() - start;
+    LogInfo("Time: %1s", FmtDouble((double)time / 1000.0, 2));
+
+    return 0;
+}
+
+}
+
+// C++ namespaces are stupid
+int main(int argc, char **argv) { return RG::Main(argc, argv); }

package/benchmark/atoi_koffi.js

@@ -0,0 +1,51 @@
+#!/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');
+
+const strings = [
+    '424242',
+    'foobar',
+    '123456789'
+];
+
+let sum = 0;
+
+main();
+
+function main() {
+    if (process.argv.length < 3)
+        throw new Error('Missing number of iterations');
+
+    let iterations = parseInt(process.argv[2], 10);
+    if (Number.isNaN(iterations))
+        throw new Error('Not a valid number');
+    if (iterations < 1)
+        throw new Error('Value must be positive');
+    console.log('Iterations:', iterations);
+
+    let lib = koffi.load(process.platform == 'win32' ? 'msvcrt.dll' : null);
+
+    const atoi = lib.cdecl('atoi', 'int', ['string']);
+
+    let start = performance.now();
+
+    for (let i = 0; i < iterations; i++) {
+        sum += atoi(strings[i % strings.length]);
+    }
+
+    let time = performance.now()- start;
+    console.log('Time:', (time / 1000.0).toFixed(2) + 's');
+}

package/benchmark/atoi_napi.cc

@@ -0,0 +1,62 @@
+// 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 "vendor/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 RunAtoi(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    // We want maximum performance here, this is a benchmark
+#if 0
+    if (info.Length() < 1) {
+        ThrowError<Napi::TypeError>(env, "Expected 1 argument, got %1", info.Length());
+        return env.Null();
+    }
+    if (!info[0].IsString()) {
+        ThrowError<Napi::TypeError>(env, "Unexpected value for str, expected string");
+        return env.Null();
+    }
+#endif
+
+    std::string name = info[0].As<Napi::String>();
+    int value = atoi(name.c_str());
+
+    return Napi::Number::New(env, value);
+}
+
+}
+
+static Napi::Object InitModule(Napi::Env env, Napi::Object exports)
+{
+    using namespace RG;
+
+    exports.Set("atoi", Napi::Function::New(env, RunAtoi));
+
+    return exports;
+}
+
+NODE_API_MODULE(koffi, InitModule);

package/benchmark/atoi_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 atoi = require('./build/atoi_napi.node');
+
+const strings = [
+    '424242',
+    'foobar',
+    '123456789'
+];
+
+let sum = 0;
+
+main();
+
+function main() {
+    if (process.argv.length < 3)
+        throw new Error('Missing number of iterations');
+
+    let iterations = parseInt(process.argv[2], 10);
+    if (Number.isNaN(iterations))
+        throw new Error('Not a valid number');
+    if (iterations < 1)
+        throw new Error('Value must be positive');
+    console.log('Iterations:', iterations);
+
+    let start = performance.now();
+
+    for (let i = 0; i < iterations; i++) {
+        sum += atoi.atoi(strings[i % strings.length]);
+    }
+
+    let time = performance.now()- start;
+    console.log('Time:', (time / 1000.0).toFixed(2) + 's');
+}

package/benchmark/atoi_node_ffi.js

@@ -0,0 +1,57 @@
+#!/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);
+const path = require('path');
+
+const strings = [
+    '424242',
+    'foobar',
+    '123456789'
+];
+
+let sum = 0;
+
+main();
+
+async function main() {
+    if (process.argv.length < 3)
+        throw new Error('Missing number of iterations');
+
+    let iterations = parseInt(process.argv[2], 10);
+    if (Number.isNaN(iterations))
+        throw new Error('Not a valid number');
+    if (iterations < 1)
+        throw new Error('Value must be positive');
+    console.log('Iterations:', iterations);
+
+    const lib = ffi.Library(process.platform == 'win32' ? 'msvcrt.dll' : null, {
+        atoi: ['int', ['string']]
+    });
+
+    let start = performance.now();
+
+    for (let i = 0; i < iterations; i++) {
+        if (i % 1000000 == 0)
+            await new Promise(resolve => setTimeout(resolve, 0));
+
+        sum += lib.atoi(strings[i % strings.length]);
+    }
+
+    let time = performance.now()- start;
+    console.log('Time:', (time / 1000.0).toFixed(2) + 's');
+}