ferrings 0.1.0 → 0.2.1

package/README.md

@@ -2,23 +2,21 @@
 
 [![CI](https://github.com/avifenesh/ferrings/actions/workflows/ci.yml/badge.svg)](https://github.com/avifenesh/ferrings/actions/workflows/ci.yml)
 [![Release](https://github.com/avifenesh/ferrings/actions/workflows/release.yml/badge.svg)](https://github.com/avifenesh/ferrings/actions/workflows/release.yml)
+[![npm](https://img.shields.io/npm/v/ferrings)](https://www.npmjs.com/package/ferrings)
 ![Node.js >=20](https://img.shields.io/badge/node-%3E%3D20-339933)
 ![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)
 
 Linux `io_uring` TCP transport for Node.js, built with Rust and napi-rs for high-concurrency server outside libuv's networking loop.
 
-ferrings exposes Node-friendly TCP and fixed-response HTTP APIs backed by a native `io_uring` worker: multishot accept/recv, provided buffer rings, recv-bundle, zero-copy send, and an optional ZCRX path for capable NICs. The project is at the 0.1.0 release stage; tag pushes build native artifacts and publish to npm through the repository `NPM_TOKEN` secret.
+ferrings exposes Node-friendly TCP and fixed-response HTTP APIs backed by a native `io_uring` worker: multishot accept/recv, provided buffer rings, recv-bundle, zero-copy send, and an optional ZCRX path for capable NICs. It is published on npm as a root package plus target-specific optional native packages, so users install `ferrings` and npm resolves the matching Linux binding for their machine.
 
 ```bash
-git clone https://github.com/avifenesh/ferrings.git
-cd ferrings
-npm install
-npm run build
+npm install ferrings
 ```
 
 ```js
 const net = require('node:net');
-const { createTcpServer } = require('./');
+const { createTcpServer } = require('ferrings');
 
 const server = createTcpServer((connection) => {
   connection.on('data', (data) => connection.end(`ferrings:${data}`));
@@ -33,14 +31,14 @@ server.listen(0, '127.0.0.1', (info) => {
 });
 ```
 
-Run the example from the repository root with `node quickstart.js`; it prints `ferrings:ping`. After npm publishing, replace `require('./')` with `require('ferrings')`.
+Save the example as `quickstart.js` and run it with `node quickstart.js`; it prints `ferrings:ping`.
 
 ## Quick proof signals
 
-- Linux-only native addon for Node.js `>=20`, written in Rust with napi-rs.
+- Published on npm as [`ferrings`](https://www.npmjs.com/package/ferrings) for Node.js `>=20` on Linux.
 - CI builds and tests Node 20, 22, and 24 on Linux.
-- Release workflow builds native packages for `linux-x64-gnu`, `linux-x64-musl`, `linux-arm64-gnu`, and `linux-arm64-musl`.
-- `npm run check:release-ready -- --full --strict` reports `ready-with-optional-blockers`; the optional blocker is ZCRX hardware proof.
+- Uses the napi-rs root-package + optional-native-package pattern: one JS API package for users, matrix-built native packages underneath.
+- `npm run check:release-ready -- --full --strict` verifies the local release gates; ZCRX hardware proof is optional unless `--require-zcrx` is set.
 - Package install smoke tests pack the tarball, install it in a temporary app, start a TCP server through `require('ferrings')`, and run the installed CLI.
 
 ## Why this project
@@ -53,33 +51,30 @@ Run the example from the repository root with `node quickstart.js`; it prints `f
 
 ## Installation
 
-The npm package family is prepared but not published yet. Use the source checkout path for now:
+Install the published package:
 
 ```bash
-git clone https://github.com/avifenesh/ferrings.git
-cd ferrings
-npm install
-npm run build
-npm test
+npm install ferrings
 ```
 
-When the npm packages are published, the intended install path is:
+The base package is Linux-only. It depends on target-specific optional native packages, but a normal install picks the one package that matches the current machine. The release build still produces all supported targets through CI matrix jobs. For source development:
 
 ```bash
-npm install ferrings
+git clone https://github.com/avifenesh/ferrings.git
+cd ferrings
+npm install
+npm test
 ```
 
-The base package is Linux-only and depends on optional native packages for glibc/musl and x64/arm64 targets.
-
 ## Quick start
 
-Create `quickstart.js` in the repository root:
+After `npm install ferrings`, create `quickstart.js`:
 
 ```js
 'use strict';
 
 const net = require('node:net');
-const { createTcpServer, capabilities } = require('./');
+const { createTcpServer, capabilities } = require('ferrings');
 
 console.log(capabilities());
 
@@ -161,7 +156,7 @@ The broad core path is multishot accept + multishot recv + provided buffers. ZCR
 ### Node-style TCP
 
 ```js
-const { createTcpServer } = require('./');
+const { createTcpServer } = require('ferrings');
 
 const server = createTcpServer((connection) => {
   connection.on('data', (data) => connection.end(data));
@@ -177,7 +172,7 @@ Use this path when you want a familiar Node server shape over the native transpo
 ### Raw TCP events
 
 ```js
-const { UringTcpServer } = require('./');
+const { UringTcpServer } = require('ferrings');
 
 const server = new UringTcpServer({
   host: '127.0.0.1',
@@ -200,7 +195,7 @@ Use this path when you want direct event objects and explicit connection IDs.
 ### Batched TCP events and sends
 
 ```js
-const { UringTcpServer } = require('./');
+const { UringTcpServer } = require('ferrings');
 
 const server = new UringTcpServer({ host: '127.0.0.1', port: 0 });
 
@@ -224,7 +219,7 @@ Use this path when JS callback overhead matters and events can be processed in b
 ### Fixed-response HTTP
 
 ```js
-const { UringHttpServer } = require('./');
+const { UringHttpServer } = require('ferrings');
 
 const server = new UringHttpServer({
   host: '127.0.0.1',
@@ -242,7 +237,7 @@ console.log(`http://${info.host}:${info.port}`);
 ### Native echo benchmark server
 
 ```js
-const { UringTcpEchoServer } = require('./');
+const { UringTcpEchoServer } = require('ferrings');
 
 const server = new UringTcpEchoServer({
   host: '127.0.0.1',
@@ -259,7 +254,7 @@ Use this to isolate the native TCP echo path from JavaScript event delivery.
 ### Capability and ZCRX probes
 
 ```js
-const { capabilities, zcrxProbe } = require('./');
+const { capabilities, zcrxProbe } = require('ferrings');
 
 console.log(capabilities());
 console.log(zcrxProbe({ interfaceName: 'eth0' }));
@@ -270,16 +265,14 @@ console.log(zcrxProbe({
 }));
 ```
 
-The CLI exposes the same diagnostics from a source checkout:
+The installed CLI exposes the same diagnostics:
 
 ```bash
-node bin/ferrings.js capabilities --json
-node bin/ferrings.js doctor --interface eth0 --rx-queue 0 --active --json
-node bin/ferrings.js zcrx-probe --interface eth0 --rx-queue 0 --active --json
+npx ferrings capabilities --json
+npx ferrings doctor --interface eth0 --rx-queue 0 --active --json
+npx ferrings zcrx-probe --interface eth0 --rx-queue 0 --active --json
 ```
 
-After npm publishing, the same commands can be run as `npx ferrings ...`.
-
 ## Configuration
 
 Common server options:
@@ -289,8 +282,8 @@ Common server options:
 | `host` | `127.0.0.1` | all servers | Bind address. |
 | `port` | `0` | all servers | Bind port; `0` asks the kernel for a free port. |
 | `backlog` | `1024` | all servers | Passed to `listen(2)`, subject to host `somaxconn`. |
-| `queueDepth` | `1024` | all servers | `io_uring` queue depth. |
-| `bufferCount` | `4096` | all servers | Receive buffer slots. |
+| `queueDepth` | `64` | all servers | `io_uring` queue depth. |
+| `bufferCount` | `512` | all servers | Receive buffer slots. |
 | `bufferSize` | `2048` | all servers | Size of each receive buffer. |
 | `maxConnections` | `0` | all servers | `0` means unlimited tracked active connections. |
 | `idleTimeoutMs` | `0` | all servers | `0` disables native idle eviction. |
@@ -319,7 +312,29 @@ All servers expose live counters through `ServerInfo`, including accepted/closed
 
 ## Performance and benchmarks
 
-The repository includes benchmark drivers, but the README does not publish benchmark numbers because results depend on kernel, CPU, NIC, limits, and benchmark shape.
+### Snapshot: loopback syscall benchmark
+
+Measured on 2026-06-28 on an Intel Core Ultra 9 275HX laptop, Linux `7.0.0-22-generic`, Node `v25.9.0`, npm `11.12.1`, Rust `1.96.0`, with the default 8 MiB locked-memory limit. This is loopback under `strace -f -c`, not a NIC or ZCRX benchmark, so use the ratios more than the absolute numbers.
+
+```bash
+REQUESTS=1000 CONCURRENCY=64 QUEUE_DEPTH=64 BUFFER_COUNT=512 BUFFER_SIZE=2048 \
+CASES=node-http,ferrings-http,node-tcp,ferrings-native-tcp,ferrings-tcp-facade,ferrings-tcp-facade-batch \
+REPORT_PATH=artifacts/benchmark-readme-2026-06-28.json \
+npm run bench:syscalls
+```
+
+| Case | req/s | p50 ms | p95 ms | p99 ms | server syscalls/conn | Fast path |
+| --- | ---: | ---: | ---: | ---: | ---: | --- |
+| Node `http` | 2,689 | 19.536 | 63.368 | 75.987 | 11.620 | libuv/epoll |
+| ferrings HTTP | 5,547 | 10.480 | 28.965 | 33.123 | 5.645 | multishot accept/recv + provided buffer ring |
+| Node `net` TCP echo | 4,086 | 14.881 | 19.244 | 26.649 | 10.987 | libuv/epoll |
+| ferrings native TCP echo | 8,128 | 6.353 | 16.562 | 20.422 | 5.842 | native echo worker + provided buffer ring |
+| ferrings TCP facade | 7,001 | 7.199 | 30.371 | 33.890 | 8.149 | JS facade + batched native events |
+| ferrings TCP facade batch send | 8,451 | 6.188 | 24.787 | 28.451 | 7.143 | JS facade + batched native events/sends |
+
+In this shape, ferrings HTTP uses about half the server syscalls per completed connection and roughly doubles request throughput versus Node `http`. The native TCP echo path does the same against Node `net`; the JS facade still crosses into JavaScript, but batching keeps syscall count and throughput ahead in this benchmark.
+
+### Running benchmarks
 
 ```bash
 npm run bench
@@ -337,7 +352,7 @@ Benchmark scripts:
 - `benchmark/syscalls.js` uses `strace -f -c` when installed to report server-side syscalls per completed connection.
 - `benchmark/first-slice.js` writes one compact validation report for the first useful slice across capabilities, HTTP, TCP, and syscall cases.
 
-Set `REPORT_PATH=artifacts/<name>.json` to keep machine-readable reports.
+Set `REPORT_PATH=artifacts/<name>.json` to keep machine-readable reports. Useful knobs include `DURATION_MS`, `REQUESTS`, `CONCURRENCY`, `QUEUE_DEPTH`, `BUFFER_COUNT`, `BUFFER_SIZE`, `CASES`, and `SYSCALL_CASES`. If you raise `BUFFER_COUNT`, `QUEUE_DEPTH`, or fixed send-buffer counts, raise `ulimit -l` / `RLIMIT_MEMLOCK` too.
 
 ## ZCRX
 
@@ -354,10 +369,10 @@ For a real NIC receive proof, avoid `127.0.0.1`; route packets through the selec
 
 ## Release and package layout
 
-The release flow follows napi-rs native package conventions:
+The release flow follows napi-rs native package conventions, the same shape used by projects such as Glide: CI builds every supported target in a matrix, publishes one small native package per target, and keeps `ferrings` as the single package users install.
 
 - Root package: `ferrings`
-- Optional native packages:
+- Published native packages:
   - `ferrings-linux-x64-gnu`
   - `ferrings-linux-x64-musl`
   - `ferrings-linux-arm64-gnu`
@@ -367,13 +382,13 @@ Useful release checks:
 
 ```bash
 npm run check:native-packages
-npm run check:npm-new-names
+npm run check:npm-names
 npm run check:release-repository
 npm run check:release-ready -- --full --strict
 npm run check:release-ready -- --full --require-zcrx
 ```
 
-Tag pushes that match the package version build all native artifacts, run package checks, and publish to npm with the repository `NPM_TOKEN` secret. Manual `workflow_dispatch` runs can also publish when `publish=true`.
+Tag pushes that match the package version build all native artifacts, run package checks, and publish to npm with the repository `NPM_TOKEN` secret. Manual `workflow_dispatch` runs can also publish when `publish=true`. For a new release, bump the package version first; npm versions are immutable after publication.
 
 ## Limitations and tradeoffs
 
@@ -385,7 +400,7 @@ Tag pushes that match the package version build all native artifacts, run packag
 - TLS is not implemented.
 - ZCRX requires specific NIC hardware, kernel support, queue setup, permissions, and routed traffic through the selected RX queue.
 - Registered-buffer send can be unavailable even when the kernel supports other modern `io_uring` networking features; ferrings reports that through `capabilities().registeredSendBuffer`.
-- APIs and packaging are still at the 0.1 release-candidate stage.
+- APIs are still early and may change between 0.x releases.
 
 ## Docs, examples, and project health
 
@@ -413,7 +428,7 @@ For changes that touch native packaging, also run:
 
 ```bash
 npm run check:native-packages
-npm run check:publish
+npm pack --dry-run --json
 ```
 
 For ZCRX changes, include `npm run test:zcrx` output when you have access to capable hardware. If you do not, include `node bin/ferrings.js zcrx-probe --all --active --json` output so reviewers can see the blocker.

package/benchmark/compare.js

@@ -10,6 +10,8 @@ const BODY = 'ok\n';
 const DURATION_MS = Number(process.env.DURATION_MS || 5000);
 const CONCURRENCY = Number(process.env.CONCURRENCY || 128);
 const QUEUE_DEPTH = Number(process.env.QUEUE_DEPTH || 256);
+const BUFFER_COUNT = Number(process.env.BUFFER_COUNT || 512);
+const BUFFER_SIZE = Number(process.env.BUFFER_SIZE || 2048);
 const REPORT_PATH = process.env.REPORT_PATH;
 
 function requestOnce(port) {
@@ -76,8 +78,8 @@ async function withUringServer() {
     port: 0,
     queueDepth: QUEUE_DEPTH,
     responseBody: BODY,
-    bufferCount: 4096,
-    bufferSize: 2048
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE
   });
 
   const info = server.start();
@@ -131,7 +133,9 @@ function baseReport() {
     config: {
       durationMs: DURATION_MS,
       concurrency: CONCURRENCY,
-      queueDepth: QUEUE_DEPTH
+      queueDepth: QUEUE_DEPTH,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE
     },
     results: [],
     error: null

package/benchmark/first-slice.js

@@ -9,6 +9,9 @@ const { capabilities } = require('../');
 const DURATION_MS = String(process.env.DURATION_MS || 1000);
 const CONCURRENCY = String(process.env.CONCURRENCY || 128);
 const QUEUE_DEPTH = String(process.env.QUEUE_DEPTH || 256);
+const BUFFER_COUNT = String(process.env.BUFFER_COUNT || 512);
+const BUFFER_SIZE = String(process.env.BUFFER_SIZE || 2048);
+const TCP_CASES = process.env.TCP_CASES || '';
 const SYSCALL_REQUESTS = String(process.env.SYSCALL_REQUESTS || 200);
 const SYSCALL_CONCURRENCY = String(process.env.SYSCALL_CONCURRENCY || 32);
 const SYSCALL_CASES =
@@ -25,6 +28,11 @@ const report = {
     durationMs: Number(DURATION_MS),
     concurrency: Number(CONCURRENCY),
     queueDepth: Number(QUEUE_DEPTH),
+    bufferCount: Number(BUFFER_COUNT),
+    bufferSize: Number(BUFFER_SIZE),
+    tcpCases: TCP_CASES
+      ? TCP_CASES.split(',').map((name) => name.trim()).filter(Boolean)
+      : null,
     syscallRequests: Number(SYSCALL_REQUESTS),
     syscallConcurrency: Number(SYSCALL_CONCURRENCY),
     syscallCases: SYSCALL_CASES.split(',').map((name) => name.trim()).filter(Boolean)
@@ -41,14 +49,19 @@ try {
     runBenchmark('HTTP fixed response latency', 'compare.js', {
       DURATION_MS,
       CONCURRENCY,
-      QUEUE_DEPTH
+      QUEUE_DEPTH,
+      BUFFER_COUNT,
+      BUFFER_SIZE
     })
   );
   report.results.push(
     runBenchmark('TCP echo latency matrix', 'tcp-echo.js', {
       DURATION_MS,
       CONCURRENCY,
-      QUEUE_DEPTH
+      QUEUE_DEPTH,
+      BUFFER_COUNT,
+      BUFFER_SIZE,
+      ...(TCP_CASES ? { CASES: TCP_CASES } : {})
     })
   );
   report.results.push(runSyscallBenchmark());
@@ -81,6 +94,8 @@ function runSyscallBenchmark() {
     REQUESTS: SYSCALL_REQUESTS,
     CONCURRENCY: SYSCALL_CONCURRENCY,
     QUEUE_DEPTH,
+    BUFFER_COUNT,
+    BUFFER_SIZE,
     CASES: SYSCALL_CASES
   });
 }

package/benchmark/high-concurrency.js

@@ -8,13 +8,17 @@ const path = require('node:path');
 const DEFAULT_DURATION_MS = '10000';
 const DEFAULT_CONCURRENCY = '512';
 const DEFAULT_QUEUE_DEPTH = '1024';
+const DEFAULT_BUFFER_COUNT = '512';
+const DEFAULT_BUFFER_SIZE = '2048';
 const REPORT_PATH = process.env.REPORT_PATH;
 
 const env = {
   ...process.env,
   DURATION_MS: process.env.DURATION_MS || DEFAULT_DURATION_MS,
   CONCURRENCY: process.env.CONCURRENCY || DEFAULT_CONCURRENCY,
-  QUEUE_DEPTH: process.env.QUEUE_DEPTH || DEFAULT_QUEUE_DEPTH
+  QUEUE_DEPTH: process.env.QUEUE_DEPTH || DEFAULT_QUEUE_DEPTH,
+  BUFFER_COUNT: process.env.BUFFER_COUNT || DEFAULT_BUFFER_COUNT,
+  BUFFER_SIZE: process.env.BUFFER_SIZE || DEFAULT_BUFFER_SIZE
 };
 
 const report = {
@@ -25,7 +29,9 @@ const report = {
   config: {
     durationMs: Number(env.DURATION_MS),
     concurrency: Number(env.CONCURRENCY),
-    queueDepth: Number(env.QUEUE_DEPTH)
+    queueDepth: Number(env.QUEUE_DEPTH),
+    bufferCount: Number(env.BUFFER_COUNT),
+    bufferSize: Number(env.BUFFER_SIZE)
   },
   results: [],
   error: null

package/benchmark/syscalls.js

@@ -22,10 +22,12 @@ const TCP_RESPONSE = Buffer.from('pong');
 const REQUESTS = Number(process.env.REQUESTS || 1000);
 const CONCURRENCY = Number(process.env.CONCURRENCY || 32);
 const QUEUE_DEPTH = Number(process.env.QUEUE_DEPTH || 256);
+const BUFFER_COUNT = Number(process.env.BUFFER_COUNT || 512);
+const BUFFER_SIZE = Number(process.env.BUFFER_SIZE || 2048);
 const BUNDLE_REQUEST_SIZE = Number(process.env.BUNDLE_REQUEST_SIZE || 4096);
 const BUNDLE_REQUEST = payload(BUNDLE_REQUEST_SIZE);
-const CAPS = capabilities();
-const DEFAULT_CASES = [
+let capsCache = null;
+const BASE_DEFAULT_CASES = [
   'node-http',
   'ferrings-http',
   'node-tcp',
@@ -34,22 +36,10 @@ const DEFAULT_CASES = [
   'ferrings-tcp-facade-batch',
   'ferrings-native-tcp'
 ];
-if (CAPS.sendZc) {
-  DEFAULT_CASES.push(
-    'ferrings-http-zc',
-    'ferrings-tcp-zc',
-    'ferrings-tcp-facade-zc',
-    'ferrings-tcp-facade-batch-zc',
-    'ferrings-native-tcp-zc'
-  );
-}
-if (CAPS.recvBundle) {
-  DEFAULT_CASES.push('ferrings-native-tcp-recv-bundle');
-  if (CAPS.sendZc) {
-    DEFAULT_CASES.push('ferrings-native-tcp-zc-recv-bundle');
-  }
-}
-const CASES = (process.env.CASES || DEFAULT_CASES.join(','))
+const CASE_SOURCE =
+  process.env.CASES ||
+  (process.argv[2] === '--serve' ? process.argv[3] : defaultCases().join(','));
+const CASES = CASE_SOURCE
   .split(',')
   .map((name) => name.trim())
   .filter(Boolean);
@@ -102,10 +92,12 @@ function baseReport() {
       requests: REQUESTS,
       concurrency: CONCURRENCY,
       queueDepth: QUEUE_DEPTH,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
       bundleRequestSize: BUNDLE_REQUEST_SIZE,
       cases: CASES
     },
-    capabilities: CAPS,
+    capabilities: caps(),
     results: [],
     error: null
   };
@@ -126,6 +118,34 @@ function errorForReport(error) {
   };
 }
 
+function caps() {
+  if (!capsCache) {
+    capsCache = capabilities();
+  }
+  return capsCache;
+}
+
+function defaultCases() {
+  const defaults = [...BASE_DEFAULT_CASES];
+  const currentCaps = caps();
+  if (currentCaps.sendZc) {
+    defaults.push(
+      'ferrings-http-zc',
+      'ferrings-tcp-zc',
+      'ferrings-tcp-facade-zc',
+      'ferrings-tcp-facade-batch-zc',
+      'ferrings-native-tcp-zc'
+    );
+  }
+  if (currentCaps.recvBundle) {
+    defaults.push('ferrings-native-tcp-recv-bundle');
+    if (currentCaps.sendZc) {
+      defaults.push('ferrings-native-tcp-zc-recv-bundle');
+    }
+  }
+  return defaults;
+}
+
 async function traceServerCase(caseName) {
   const summaryPath = path.join(
     os.tmpdir(),
@@ -228,8 +248,8 @@ async function startServer(caseName) {
       port: 0,
       queueDepth: QUEUE_DEPTH,
       responseBody: BODY,
-      bufferCount: 4096,
-      bufferSize: 2048,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
       useZeroCopySend: caseName === 'ferrings-http-zc'
     });
     const info = server.start();
@@ -260,8 +280,8 @@ async function startServer(caseName) {
       host: '127.0.0.1',
       port: 0,
       queueDepth: QUEUE_DEPTH,
-      bufferCount: 4096,
-      bufferSize: 2048,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
       useZeroCopySend: caseName === 'ferrings-tcp-zc',
       sendBufferCount: 512,
       sendBufferSize: 2048
@@ -287,8 +307,8 @@ async function startServer(caseName) {
       host: '127.0.0.1',
       port: 0,
       queueDepth: QUEUE_DEPTH,
-      bufferCount: 4096,
-      bufferSize: 2048,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
       useZeroCopySend,
       sendBufferCount: 512,
       sendBufferSize: 2048
@@ -320,7 +340,7 @@ async function startServer(caseName) {
     const useZeroCopySend =
       caseName === 'ferrings-native-tcp-zc' ||
       caseName === 'ferrings-native-tcp-zc-recv-bundle';
-    if (useRecvBundle && !CAPS.recvBundle) {
+    if (useRecvBundle && !caps().recvBundle) {
       throw new Error(
         `${caseName} requires IORING_FEAT_RECVSEND_BUNDLE but capabilities().recvBundle is false`
       );
@@ -329,8 +349,8 @@ async function startServer(caseName) {
       host: '127.0.0.1',
       port: 0,
       queueDepth: QUEUE_DEPTH,
-      bufferCount: 4096,
-      bufferSize: useRecvBundle ? 512 : 2048,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: useRecvBundle ? 512 : BUFFER_SIZE,
       useRecvBundle,
       useZeroCopySend,
       sendBufferCount: 512,

package/benchmark/tcp-echo.js

@@ -2,7 +2,9 @@
 
 const fs = require('node:fs');
 const net = require('node:net');
+const os = require('node:os');
 const path = require('node:path');
+const { spawnSync } = require('node:child_process');
 const { performance } = require('node:perf_hooks');
 const {
   UringTcpEchoServer,
@@ -16,11 +18,57 @@ const RESPONSE = Buffer.from('pong');
 const DURATION_MS = Number(process.env.DURATION_MS || 5000);
 const CONCURRENCY = Number(process.env.CONCURRENCY || 128);
 const QUEUE_DEPTH = Number(process.env.QUEUE_DEPTH || 256);
+const BUFFER_COUNT = Number(process.env.BUFFER_COUNT || 512);
+const BUFFER_SIZE = Number(process.env.BUFFER_SIZE || 2048);
 const BUNDLE_REQUEST_SIZE = Number(process.env.BUNDLE_REQUEST_SIZE || 4096);
 const BUNDLE_REQUEST = payload(BUNDLE_REQUEST_SIZE);
-const CAPS = capabilities();
+let capsCache = null;
+const DEFAULT_CASES = [
+  'node:net echo',
+  'ferrings native tcp echo',
+  'ferrings native tcp echo recv-bundle',
+  'ferrings tcp echo',
+  'ferrings tcp echo batch',
+  'ferrings tcp echo full batch',
+  'ferrings tcp facade echo',
+  'ferrings tcp facade batch echo',
+  'ferrings tcp echo zc',
+  'ferrings native tcp echo zc',
+  'ferrings native tcp echo zc recv-bundle',
+  'ferrings tcp echo batch zc',
+  'ferrings tcp echo full batch zc',
+  'ferrings tcp facade echo zc',
+  'ferrings tcp facade batch echo zc'
+];
+const CASES = (process.env.CASES || DEFAULT_CASES.join(','))
+  .split(',')
+  .map((name) => name.trim())
+  .filter(Boolean);
+const CASE_ISOLATION = process.env.CASE_ISOLATION !== '0';
+const CASE_REPORT_PATH = process.env.CASE_REPORT_PATH;
 const REPORT_PATH = process.env.REPORT_PATH;
 
+if (process.argv[2] === '--case') {
+  runCase(process.argv[3])
+    .then((result) => {
+      if (CASE_REPORT_PATH) {
+        fs.mkdirSync(path.dirname(CASE_REPORT_PATH), { recursive: true });
+        fs.writeFileSync(CASE_REPORT_PATH, `${JSON.stringify(result, null, 2)}\n`);
+      } else {
+        console.log(JSON.stringify(result));
+      }
+    })
+    .catch((error) => {
+      console.error(error);
+      process.exitCode = 1;
+    });
+} else {
+  main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+  });
+}
+
 function payload(size) {
   const data = Buffer.alloc(size);
   for (let index = 0; index < data.length; index += 1) {
@@ -29,6 +77,13 @@ function payload(size) {
   return data;
 }
 
+function caps() {
+  if (!capsCache) {
+    capsCache = capabilities();
+  }
+  return capsCache;
+}
+
 function echoOnce(port, request = REQUEST, expected = RESPONSE) {
   const startedAt = performance.now();
   return new Promise((resolve, reject) => {
@@ -101,8 +156,8 @@ async function withUringNativeEchoServer(options = {}, request = REQUEST) {
     host: '127.0.0.1',
     port: 0,
     queueDepth: QUEUE_DEPTH,
-    bufferCount: 4096,
-    bufferSize: 2048,
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE,
     ...options
   });
 
@@ -122,8 +177,8 @@ async function withUringServer(options = {}) {
     host: '127.0.0.1',
     port: 0,
     queueDepth: QUEUE_DEPTH,
-    bufferCount: 4096,
-    bufferSize: 2048,
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE,
     ...options
   });
 
@@ -148,8 +203,8 @@ async function withUringBatchServer(options = {}) {
     host: '127.0.0.1',
     port: 0,
     queueDepth: QUEUE_DEPTH,
-    bufferCount: 4096,
-    bufferSize: 2048,
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE,
     ...options
   });
 
@@ -176,8 +231,8 @@ async function withUringFullBatchServer(options = {}) {
     host: '127.0.0.1',
     port: 0,
     queueDepth: QUEUE_DEPTH,
-    bufferCount: 4096,
-    bufferSize: 2048,
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE,
     ...options
   });
 
@@ -209,8 +264,8 @@ async function withTcpFacadeServer(options = {}) {
       host: '127.0.0.1',
       port: 0,
       queueDepth: QUEUE_DEPTH,
-      bufferCount: 4096,
-      bufferSize: 2048,
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
       ...options
     },
     (connection) => {
@@ -237,8 +292,8 @@ async function withTcpFacadeBatchServer(options = {}) {
     host: '127.0.0.1',
     port: 0,
     queueDepth: QUEUE_DEPTH,
-    bufferCount: 4096,
-    bufferSize: 2048,
+    bufferCount: BUFFER_COUNT,
+    bufferSize: BUFFER_SIZE,
     ...options
   });
 
@@ -265,16 +320,27 @@ function percentile(values, quantile) {
 }
 
 async function maybeRecvBundle(label, runner) {
-  if (!CAPS.recvBundle) {
+  if (!caps().recvBundle) {
     const result = {
       skipped: 'kernel does not report IORING_FEAT_RECVSEND_BUNDLE'
     };
     console.log(label, result);
     return result;
   }
-  const result = await runner();
-  console.log(label, result);
-  return result;
+  try {
+    const result = await runner();
+    console.log(label, result);
+    return result;
+  } catch (error) {
+    if (/provided-buffer-ring setup was unavailable|Cannot allocate memory/i.test(error.message)) {
+      const result = {
+        skipped: error.message
+      };
+      console.log(label, result);
+      return result;
+    }
+    throw error;
+  }
 }
 
 function summarizeServerInfo(info) {
@@ -318,9 +384,12 @@ function baseReport() {
       durationMs: DURATION_MS,
       concurrency: CONCURRENCY,
       queueDepth: QUEUE_DEPTH,
-      bundleRequestSize: BUNDLE_REQUEST_SIZE
+      bufferCount: BUFFER_COUNT,
+      bufferSize: BUFFER_SIZE,
+      bundleRequestSize: BUNDLE_REQUEST_SIZE,
+      cases: CASES
     },
-    capabilities: CAPS,
+    capabilities: caps(),
     results: [],
     error: null
   };
@@ -341,21 +410,55 @@ function errorForReport(error) {
   };
 }
 
-async function record(report, caseName, runner) {
-  const result = await runner();
+async function record(report, caseName) {
+  const result = CASE_ISOLATION ? runIsolatedCase(caseName) : await runCase(caseName);
   report.results.push({ caseName, result });
   console.log(caseName, result);
 }
 
-(async () => {
-  const report = baseReport();
+function runIsolatedCase(caseName) {
+  const caseReportPath = path.join(
+    os.tmpdir(),
+    `ferrings-tcp-case-${process.pid}-${Date.now()}-${caseName.replace(/[^a-z0-9]+/gi, '-')}.json`
+  );
+  const result = spawnSync(process.execPath, [__filename, '--case', caseName], {
+    cwd: path.join(__dirname, '..'),
+    env: {
+      ...process.env,
+      CASE_ISOLATION: '0',
+      CASE_REPORT_PATH: caseReportPath,
+      REPORT_PATH: ''
+    },
+    stdio: 'inherit'
+  });
+  if (result.error) {
+    throw result.error;
+  }
+  if (result.status !== 0) {
+    const error = new Error(`${caseName} exited with status ${result.status ?? 1}`);
+    error.caseResult = readCaseReport(caseReportPath);
+    throw error;
+  }
+  return readCaseReport(caseReportPath);
+}
+
+function readCaseReport(caseReportPath) {
   try {
-    console.log(report.config);
-    await record(report, 'node:net echo', withNodeServer);
-    await record(report, 'ferrings native tcp echo', withUringNativeEchoServer);
-    report.results.push({
-      caseName: 'ferrings native tcp echo recv-bundle',
-      result: await maybeRecvBundle('ferrings native tcp echo recv-bundle', () =>
+    if (!fs.existsSync(caseReportPath)) return null;
+    return JSON.parse(fs.readFileSync(caseReportPath, 'utf8'));
+  } finally {
+    fs.rmSync(caseReportPath, { force: true });
+  }
+}
+
+async function runCase(caseName) {
+  switch (caseName) {
+    case 'node:net echo':
+      return withNodeServer();
+    case 'ferrings native tcp echo':
+      return withUringNativeEchoServer();
+    case 'ferrings native tcp echo recv-bundle':
+      return maybeRecvBundle(caseName, () =>
         withUringNativeEchoServer(
           {
             bufferSize: 512,
@@ -363,30 +466,31 @@ async function record(report, caseName, runner) {
           },
           BUNDLE_REQUEST
         )
-      )
-    });
-    await record(report, 'ferrings tcp echo', withUringServer);
-    await record(report, 'ferrings tcp echo batch', withUringBatchServer);
-    await record(report, 'ferrings tcp echo full batch', withUringFullBatchServer);
-    await record(report, 'ferrings tcp facade echo', withTcpFacadeServer);
-    await record(report, 'ferrings tcp facade batch echo', withTcpFacadeBatchServer);
-    await record(report, 'ferrings tcp echo zc', () =>
-      withUringServer({
+      );
+    case 'ferrings tcp echo':
+      return withUringServer();
+    case 'ferrings tcp echo batch':
+      return withUringBatchServer();
+    case 'ferrings tcp echo full batch':
+      return withUringFullBatchServer();
+    case 'ferrings tcp facade echo':
+      return withTcpFacadeServer();
+    case 'ferrings tcp facade batch echo':
+      return withTcpFacadeBatchServer();
+    case 'ferrings tcp echo zc':
+      return withUringServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
-    await record(report, 'ferrings native tcp echo zc', () =>
-      withUringNativeEchoServer({
+      });
+    case 'ferrings native tcp echo zc':
+      return withUringNativeEchoServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
-    report.results.push({
-      caseName: 'ferrings native tcp echo zc recv-bundle',
-      result: await maybeRecvBundle('ferrings native tcp echo zc recv-bundle', () =>
+      });
+    case 'ferrings native tcp echo zc recv-bundle':
+      return maybeRecvBundle(caseName, () =>
         withUringNativeEchoServer(
           {
             bufferSize: 512,
@@ -397,36 +501,43 @@ async function record(report, caseName, runner) {
           },
           BUNDLE_REQUEST
         )
-      )
-    });
-    await record(report, 'ferrings tcp echo batch zc', () =>
-      withUringBatchServer({
+      );
+    case 'ferrings tcp echo batch zc':
+      return withUringBatchServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
-    await record(report, 'ferrings tcp echo full batch zc', () =>
-      withUringFullBatchServer({
+      });
+    case 'ferrings tcp echo full batch zc':
+      return withUringFullBatchServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
-    await record(report, 'ferrings tcp facade echo zc', () =>
-      withTcpFacadeServer({
+      });
+    case 'ferrings tcp facade echo zc':
+      return withTcpFacadeServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
-    await record(report, 'ferrings tcp facade batch echo zc', () =>
-      withTcpFacadeBatchServer({
+      });
+    case 'ferrings tcp facade batch echo zc':
+      return withTcpFacadeBatchServer({
         useZeroCopySend: true,
         sendBufferCount: 512,
         sendBufferSize: 2048
-      })
-    );
+      });
+    default:
+      throw new Error(`unknown TCP benchmark case: ${caseName}`);
+  }
+}
+
+async function main() {
+  const report = baseReport();
+  try {
+    console.log(report.config);
+    for (const caseName of CASES) {
+      await record(report, caseName);
+    }
     report.status = 'passed';
   } catch (error) {
     report.status = 'failed';
@@ -436,7 +547,4 @@ async function record(report, caseName, runner) {
     report.finishedAt = new Date().toISOString();
     writeReport(report);
   }
-})().catch((error) => {
-  console.error(error);
-  process.exitCode = 1;
-});
+}

package/native.js

@@ -77,8 +77,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-android-arm64')
         const bindingPackageVersion = require('ferrings-android-arm64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-android-arm-eabi')
         const bindingPackageVersion = require('ferrings-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-win32-x64-gnu')
         const bindingPackageVersion = require('ferrings-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-win32-x64-msvc')
         const bindingPackageVersion = require('ferrings-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-win32-ia32-msvc')
         const bindingPackageVersion = require('ferrings-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-win32-arm64-msvc')
         const bindingPackageVersion = require('ferrings-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
     try {
       const binding = require('ferrings-darwin-universal')
       const bindingPackageVersion = require('ferrings-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-darwin-x64')
         const bindingPackageVersion = require('ferrings-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-darwin-arm64')
         const bindingPackageVersion = require('ferrings-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-freebsd-x64')
         const bindingPackageVersion = require('ferrings-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-freebsd-arm64')
         const bindingPackageVersion = require('ferrings-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-x64-musl')
           const bindingPackageVersion = require('ferrings-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-x64-gnu')
           const bindingPackageVersion = require('ferrings-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-arm64-musl')
           const bindingPackageVersion = require('ferrings-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-arm64-gnu')
           const bindingPackageVersion = require('ferrings-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-arm-musleabihf')
           const bindingPackageVersion = require('ferrings-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-arm-gnueabihf')
           const bindingPackageVersion = require('ferrings-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-loong64-musl')
           const bindingPackageVersion = require('ferrings-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-loong64-gnu')
           const bindingPackageVersion = require('ferrings-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-riscv64-musl')
           const bindingPackageVersion = require('ferrings-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
         try {
           const binding = require('ferrings-linux-riscv64-gnu')
           const bindingPackageVersion = require('ferrings-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-linux-ppc64-gnu')
         const bindingPackageVersion = require('ferrings-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-linux-s390x-gnu')
         const bindingPackageVersion = require('ferrings-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-openharmony-arm64')
         const bindingPackageVersion = require('ferrings-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-openharmony-x64')
         const bindingPackageVersion = require('ferrings-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
       try {
         const binding = require('ferrings-openharmony-arm')
         const bindingPackageVersion = require('ferrings-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.2.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.2.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ferrings",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Linux io_uring TCP transport experiments for Node.js",
   "main": "index.js",
   "types": "index.d.ts",
@@ -68,10 +68,10 @@
     "@napi-rs/cli": "^3.7.2"
   },
   "optionalDependencies": {
-    "ferrings-linux-arm64-gnu": "0.1.0",
-    "ferrings-linux-arm64-musl": "0.1.0",
-    "ferrings-linux-x64-gnu": "0.1.0",
-    "ferrings-linux-x64-musl": "0.1.0"
+    "ferrings-linux-arm64-gnu": "0.2.1",
+    "ferrings-linux-arm64-musl": "0.2.1",
+    "ferrings-linux-x64-gnu": "0.2.1",
+    "ferrings-linux-x64-musl": "0.2.1"
   },
   "napi": {
     "binaryName": "ferrings",