knitting 0.1.50 → 0.1.52

package/src/connections/buffer-reference.js

@@ -0,0 +1,459 @@
+import { RUNTIME } from "../common/runtime.js";
+import { getNodeProcess } from "../common/node-compat.js";
+import { RUNTIME_IS_MAIN_THREAD } from "../common/worker-runtime.js";
+import { loadNodeBufferPointerAddon } from "./node-buffer-pointer.js";
+import { getBufferReferenceCapabilities, } from "./buffer-reference-native.js";
+export const BUFFER_REFERENCE_KIND = "knitting.bufferReference";
+/** Named values for the `unsafe.BufferReferenceReturn` pool option. */
+export const BufferReferenceReturn = {
+    /** Safe default: Deno/Bun copy the returned bytes so they outlive the worker. */
+    Copy: "copy",
+    /** Zero-copy: borrow the worker's backing store until the reference is released. */
+    Borrow: "borrow",
+};
+export const BUFFER_REFERENCE_NUMERIC_TRANSFER = Symbol.for("knitting.bufferReference.numericTransfer");
+export const BUFFER_REFERENCE_RETURN_RELEASE_TOKEN = Symbol.for("knitting.bufferReference.returnReleaseToken");
+const EXTERNAL_PAYLOAD_BRAND = Symbol.for("knitting.payloadCodec");
+export const BUFFER_REFERENCE_CODEC_ID = BUFFER_REFERENCE_KIND;
+const BUFFER_REFERENCE_RETURN_RELEASE_MESSAGE_KEY = "__knittingBufferReferenceRelease";
+const getRuntime = () => {
+    if (RUNTIME === "deno" || RUNTIME === "bun" || RUNTIME === "node") {
+        return RUNTIME;
+    }
+    throw new Error(`BufferReference cannot run in runtime "${RUNTIME}"`);
+};
+const getProcessId = () => {
+    const proc = getNodeProcess();
+    if (proc !== undefined && typeof proc.pid === "number")
+        return proc.pid;
+    const deno = globalThis.Deno;
+    if (typeof deno?.pid === "number")
+        return deno.pid;
+    return 0;
+};
+const PROCESS_ORIGIN = `${RUNTIME}:${getProcessId()}`;
+const NUMERIC_WORD_MASK = 0xffffffffn;
+const RUNTIME_NODE = 1;
+const RUNTIME_DENO = 2;
+const RUNTIME_BUN = 3;
+const PAYLOAD_TRANSPORT_FINALIZER = Symbol.for("knitting.payloadCodec.transportFinalizer");
+let currentReturnReleaser;
+const encodeRuntime = (runtime) => {
+    switch (runtime) {
+        case "node":
+            return RUNTIME_NODE;
+        case "deno":
+            return RUNTIME_DENO;
+        case "bun":
+            return RUNTIME_BUN;
+    }
+};
+const decodeRuntime = (runtime) => {
+    switch (runtime) {
+        case RUNTIME_NODE:
+            return "node";
+        case RUNTIME_DENO:
+            return "deno";
+        case RUNTIME_BUN:
+            return "bun";
+        default:
+            return undefined;
+    }
+};
+const splitU64 = (value) => [
+    Number(value & NUMERIC_WORD_MASK) >>> 0,
+    Number((value >> 32n) & NUMERIC_WORD_MASK) >>> 0,
+];
+const joinU64 = (low, high) => (BigInt(high >>> 0) << 32n) | BigInt(low >>> 0);
+const readOriginPid = (origin) => {
+    const separator = origin.indexOf(":");
+    if (separator < 0)
+        return undefined;
+    const pid = Number(origin.slice(separator + 1));
+    return Number.isInteger(pid) && pid >= 0 && pid <= 0xffffffff
+        ? pid >>> 0
+        : undefined;
+};
+const numericMetadataToMetadata = (words) => {
+    const runtime = decodeRuntime(words[6] ?? 0);
+    if (runtime === undefined) {
+        throw new TypeError("Invalid BufferReference numeric runtime");
+    }
+    const originPid = words[7];
+    if (originPid === undefined ||
+        !Number.isInteger(originPid) ||
+        originPid < 0) {
+        throw new TypeError("Invalid BufferReference numeric origin");
+    }
+    return {
+        kind: BUFFER_REFERENCE_KIND,
+        origin: `${runtime}:${originPid >>> 0}`,
+        runtime,
+        pointer: joinU64(words[0] ?? 0, words[1] ?? 0).toString(),
+        token: joinU64(words[2] ?? 0, words[3] ?? 0).toString(),
+        byteOffset: words[4] ?? 0,
+        byteLength: words[5] ?? 0,
+    };
+};
+export const withBufferReferenceReturnReleaser = (releaser, run) => {
+    if (releaser === undefined)
+        return run();
+    const previous = currentReturnReleaser;
+    currentReturnReleaser = releaser;
+    try {
+        return run();
+    }
+    finally {
+        currentReturnReleaser = previous;
+    }
+};
+export const createBufferReferenceReturnReleaseMessage = (token) => ({
+    [BUFFER_REFERENCE_RETURN_RELEASE_MESSAGE_KEY]: token.toString(),
+});
+export const readBufferReferenceReturnReleaseMessage = (value) => {
+    if (value === null || typeof value !== "object")
+        return undefined;
+    const raw = value[BUFFER_REFERENCE_RETURN_RELEASE_MESSAGE_KEY];
+    if (typeof raw !== "string")
+        return undefined;
+    try {
+        const token = BigInt(raw);
+        return token > 0n ? token : undefined;
+    }
+    catch {
+        return undefined;
+    }
+};
+// Backstop for references that never flow through the transport.
+const producerFinalizer = typeof FinalizationRegistry === "function"
+    ? new FinalizationRegistry(({ token, release }) => {
+        try {
+            release(token);
+        }
+        catch {
+            // best effort
+        }
+    })
+    : undefined;
+const borrowedReturnFinalizer = typeof FinalizationRegistry === "function"
+    ? new FinalizationRegistry(({ token, release }) => {
+        try {
+            release(token);
+        }
+        catch {
+            // best effort
+        }
+    })
+    : undefined;
+const isSharedArrayBufferInstance = (value) => typeof SharedArrayBuffer === "function" && value instanceof SharedArrayBuffer;
+const assertMovableSource = (source) => {
+    if (isSharedArrayBufferInstance(source)) {
+        throw new TypeError("BufferReference expects ArrayBuffer memory; SharedArrayBuffer is already shared and cannot be detached");
+    }
+    if (ArrayBuffer.isView(source)) {
+        if (isSharedArrayBufferInstance(source.buffer)) {
+            throw new TypeError("BufferReference expects ArrayBuffer-backed views; SharedArrayBuffer is already shared and cannot be detached");
+        }
+        return;
+    }
+    if (!(source instanceof ArrayBuffer)) {
+        throw new TypeError("BufferReference expects an ArrayBuffer or typed-array view");
+    }
+};
+const isDetached = (buffer) => buffer.detached === true ||
+    buffer.byteLength === 0;
+const detachArrayBufferBestEffort = (runtime, buffer) => {
+    if (isDetached(buffer))
+        return true;
+    if (runtime === "node") {
+        try {
+            return loadNodeBufferPointerAddon().detachArrayBuffer(buffer);
+        }
+        catch {
+            // fall through to the JS detach paths
+        }
+    }
+    const transferable = buffer;
+    try {
+        if (typeof transferable.transferToFixedLength === "function") {
+            transferable.transferToFixedLength(0);
+            return isDetached(buffer);
+        }
+        if (typeof transferable.transfer === "function") {
+            transferable.transfer(0);
+            return isDetached(buffer);
+        }
+    }
+    catch {
+        // fall through
+    }
+    try {
+        if (typeof structuredClone === "function") {
+            structuredClone(buffer, { transfer: [buffer] });
+            return isDetached(buffer);
+        }
+    }
+    catch {
+        // give up
+    }
+    return false;
+};
+export const isBufferReferenceMetadata = (value) => {
+    if (value === null || typeof value !== "object")
+        return false;
+    const meta = value;
+    return (meta.kind === BUFFER_REFERENCE_KIND &&
+        typeof meta.origin === "string" &&
+        (meta.runtime === "node" || meta.runtime === "deno" ||
+            meta.runtime === "bun") &&
+        typeof meta.pointer === "string" &&
+        typeof meta.token === "string" &&
+        typeof meta.byteOffset === "number" &&
+        Number.isInteger(meta.byteOffset) &&
+        meta.byteOffset >= 0 &&
+        typeof meta.byteLength === "number" &&
+        Number.isInteger(meta.byteLength) &&
+        meta.byteLength >= 0);
+};
+/**
+ * Zero-copy handle for moving ArrayBuffer bytes to **thread** workers.
+ *
+ * Construction detaches the source. Consumers materialize the moved region in
+ * their isolate: owning on Node, alias/copy on Deno/Bun.
+ */
+export class BufferReference {
+    [EXTERNAL_PAYLOAD_BRAND] = BUFFER_REFERENCE_CODEC_ID;
+    runtime;
+    origin;
+    pointer;
+    byteOffset;
+    byteLength;
+    #token;
+    #isProducer;
+    #finalizerToken;
+    #materializedRegions;
+    #owned;
+    #borrowedReturnReleaser;
+    #borrowedReturnFinalizerToken;
+    #transportRefs = 0;
+    #released = false;
+    constructor(source, meta) {
+        if (meta !== undefined) {
+            // Consumer side: rebuilt from metadata, materializes via the pointer/token.
+            this.runtime = meta.runtime;
+            this.origin = meta.origin;
+            this.pointer = BigInt(meta.pointer);
+            this.byteOffset = meta.byteOffset;
+            this.byteLength = meta.byteLength;
+            this.#token = BigInt(meta.token);
+            this.#isProducer = false;
+            return;
+        }
+        if (source === undefined) {
+            throw new TypeError("BufferReference requires a buffer source");
+        }
+        assertMovableSource(source);
+        const caps = getBufferReferenceCapabilities();
+        const produced = caps.produce(source); // detaches the source
+        this.runtime = getRuntime();
+        this.origin = PROCESS_ORIGIN;
+        this.pointer = produced.pointer;
+        this.byteOffset = produced.byteOffset;
+        this.byteLength = produced.byteLength;
+        this.#token = produced.token;
+        this.#isProducer = true;
+        this.#finalizerToken = {};
+        producerFinalizer?.register(this, { token: this.#token, release: caps.release }, this.#finalizerToken);
+    }
+    static fromMetadata(meta) {
+        if (!isBufferReferenceMetadata(meta)) {
+            throw new TypeError("Invalid BufferReferenceMetadata");
+        }
+        return new BufferReference(undefined, meta);
+    }
+    toMetadata() {
+        this.#assertActive();
+        return {
+            kind: BUFFER_REFERENCE_KIND,
+            origin: this.origin,
+            runtime: this.runtime,
+            pointer: this.pointer.toString(),
+            token: this.#token.toString(),
+            byteOffset: this.byteOffset,
+            byteLength: this.byteLength,
+        };
+    }
+    [BUFFER_REFERENCE_NUMERIC_TRANSFER]() {
+        this.#assertActive();
+        const originPid = readOriginPid(this.origin);
+        if (originPid === undefined ||
+            this.byteOffset > 0xffffffff ||
+            this.byteLength > 0xffffffff) {
+            return undefined;
+        }
+        const [pointerLow, pointerHigh] = splitU64(this.pointer);
+        const [tokenLow, tokenHigh] = splitU64(this.#token);
+        return [
+            pointerLow,
+            pointerHigh,
+            tokenLow,
+            tokenHigh,
+            this.byteOffset >>> 0,
+            this.byteLength >>> 0,
+            encodeRuntime(this.runtime),
+            originPid,
+        ];
+    }
+    get isLocal() {
+        return this.origin === PROCESS_ORIGIN && this.runtime === RUNTIME;
+    }
+    #assertLocal() {
+        if (this.origin !== PROCESS_ORIGIN) {
+            throw new Error(`BufferReference cannot cross a process boundary (origin ${this.origin} ` +
+                `!= ${PROCESS_ORIGIN}). Use ProcessSharedBuffer for cross-process memory.`);
+        }
+        if (this.runtime !== RUNTIME) {
+            throw new Error(`BufferReference runtime mismatch: produced on ${this.runtime}, ` +
+                `materializing on ${RUNTIME}.`);
+        }
+    }
+    #assertActive() {
+        if (this.#released) {
+            throw new Error("BufferReference has been released");
+        }
+    }
+    /** Prepare a returned reference before the worker-side producer hold drains. */
+    claimOwnership(releaser = currentReturnReleaser) {
+        if (this.#owned !== undefined || this.#borrowedReturnReleaser !== undefined ||
+            this.#released)
+            return this;
+        this.#assertLocal();
+        const caps = getBufferReferenceCapabilities();
+        const input = {
+            token: this.#token,
+            pointer: this.pointer,
+            byteOffset: this.byteOffset,
+            byteLength: this.byteLength,
+        };
+        if (releaser !== undefined) {
+            this.#borrowedReturnReleaser = releaser;
+            this.#borrowedReturnFinalizerToken = {};
+            borrowedReturnFinalizer?.register(this, { token: this.#token, release: releaser }, this.#borrowedReturnFinalizerToken);
+            return this;
+        }
+        this.#owned = caps.adopt(input, caps.supportsOwningAdopt ? undefined : { copy: true });
+        return this;
+    }
+    #materialize() {
+        this.#assertActive();
+        if (this.#owned !== undefined)
+            return this.#owned;
+        this.#assertLocal();
+        const region = getBufferReferenceCapabilities().adopt({
+            token: this.#token,
+            pointer: this.pointer,
+            byteOffset: this.byteOffset,
+            byteLength: this.byteLength,
+        });
+        if (this.#borrowedReturnReleaser !== undefined) {
+            this.#owned = region;
+            return region;
+        }
+        (this.#materializedRegions ??= []).push(region);
+        return region;
+    }
+    toArrayBuffer() {
+        const region = this.#materialize();
+        if (region.byteOffset === 0 && region.buffer.byteLength === region.byteLength) {
+            return region.buffer;
+        }
+        return region.buffer.slice(region.byteOffset, region.byteOffset + region.byteLength);
+    }
+    toUint8Array() {
+        const region = this.#materialize();
+        return new Uint8Array(region.buffer, region.byteOffset, region.byteLength);
+    }
+    /** The source is moved on construction, so it is never retained here. */
+    get source() {
+        return undefined;
+    }
+    release() {
+        if (this.#released)
+            return;
+        this.#released = true;
+        const regions = this.#materializedRegions;
+        this.#materializedRegions = undefined;
+        if (regions !== undefined) {
+            for (let i = 0; i < regions.length; i++) {
+                detachArrayBufferBestEffort(this.runtime, regions[i].buffer);
+            }
+        }
+        if (this.#borrowedReturnFinalizerToken !== undefined) {
+            borrowedReturnFinalizer?.unregister(this.#borrowedReturnFinalizerToken);
+            this.#borrowedReturnFinalizerToken = undefined;
+        }
+        const borrowedReturnReleaser = this.#borrowedReturnReleaser;
+        this.#borrowedReturnReleaser = undefined;
+        if (borrowedReturnReleaser !== undefined) {
+            const owned = this.#owned;
+            this.#owned = undefined;
+            if (owned !== undefined) {
+                detachArrayBufferBestEffort(this.runtime, owned.buffer);
+            }
+            try {
+                borrowedReturnReleaser(this.#token);
+            }
+            catch {
+                // best effort
+            }
+        }
+        if (this.#finalizerToken !== undefined) {
+            producerFinalizer?.unregister(this.#finalizerToken);
+            this.#finalizerToken = undefined;
+        }
+        // Only the producer owns the registry hold; consumers must not drop it.
+        if (this.#isProducer) {
+            try {
+                getBufferReferenceCapabilities().release(this.#token);
+            }
+            catch {
+                // best effort
+            }
+        }
+    }
+    [Symbol.dispose]() {
+        this.release();
+    }
+    [PAYLOAD_TRANSPORT_FINALIZER]() {
+        if (this.#released)
+            return undefined;
+        this.#transportRefs++;
+        let finalized = false;
+        const finalizer = (() => {
+            if (finalized)
+                return;
+            finalized = true;
+            this.#transportRefs--;
+            if (this.#transportRefs <= 0)
+                this.release();
+        });
+        if (this.#isProducer) {
+            finalizer[BUFFER_REFERENCE_RETURN_RELEASE_TOKEN] = this.#token;
+        }
+        return finalizer;
+    }
+}
+const codecGlobal = globalThis;
+const codecs = codecGlobal.__KNITTING_PAYLOAD_CODECS__ ??= Object.create(null);
+codecs[BUFFER_REFERENCE_CODEC_ID] = {
+    decode: (metadata) => {
+        const ref = BufferReference.fromMetadata(metadata);
+        // Host decodes are return values; claim before the worker drains.
+        // Worker decodes are forward inputs and stay lazy for the call.
+        return RUNTIME_IS_MAIN_THREAD ? ref.claimOwnership() : ref;
+    },
+    decodeNumeric: (metadata) => {
+        const ref = BufferReference.fromMetadata(numericMetadataToMetadata(metadata));
+        return RUNTIME_IS_MAIN_THREAD ? ref.claimOwnership() : ref;
+    },
+};

package/src/connections/index.d.ts

@@ -1,3 +1,4 @@
 export { alignToCacheLine, CACHE_LINE_SIZE, type ConnectionRuntime, type CreateSharedMemoryOptions, expectFd, expectPositiveSize, type MapSharedMemoryOptions, requireSharedArrayBuffer, type SharedMemoryBuffer, type SharedMemoryBufferKind, type SharedMemoryConnectionPrimitives, type SharedMemoryMapping, } from "./types.js";
+export { BufferReference, BUFFER_REFERENCE_KIND, type BufferReferenceMetadata, type BufferReferenceRuntime, isBufferReferenceMetadata, } from "./buffer-reference.js";
 export { FileDescriptor, type FileDescriptorMetadata, parseFileDescriptorMetadata, } from "./file-descriptor.js";
 export { getDefaultProcessSharedBufferPrimitives, parseProcessSharedBufferMetadata, PROCESS_SHARED_BUFFER_BRAND, ProcessSharedBuffer, type ProcessSharedBufferCreator, type ProcessSharedBufferMapper, type ProcessSharedBufferMetadata, type ProcessSharedBufferPrimitives, type ProcessSharedBufferRange, type ProcessSharedBufferView, type ProcessSharedBufferViewConstructor, setDefaultProcessSharedBufferPrimitives, } from "./process-shared-buffer.js";

package/src/connections/index.js

@@ -1,3 +1,4 @@
 export { alignToCacheLine, CACHE_LINE_SIZE, expectFd, expectPositiveSize, requireSharedArrayBuffer, } from "./types.js";
+export { BufferReference, BUFFER_REFERENCE_KIND, isBufferReferenceMetadata, } from "./buffer-reference.js";
 export { FileDescriptor, parseFileDescriptorMetadata, } from "./file-descriptor.js";
 export { getDefaultProcessSharedBufferPrimitives, parseProcessSharedBufferMetadata, PROCESS_SHARED_BUFFER_BRAND, ProcessSharedBuffer, setDefaultProcessSharedBufferPrimitives, } from "./process-shared-buffer.js";

package/src/connections/node-addons.d.ts

@@ -1,5 +1,5 @@
 type NodeRequire = (specifier: string) => unknown;
-export type NodeNativeAddonName = "knitting_shared_memory" | "knitting_shm";
+export type NodeNativeAddonName = "knitting_shared_memory" | "knitting_shm" | "knitting_buffer_pointer";
 export declare const nodeNativeAddonSpecifiers: (name: NodeNativeAddonName) => readonly string[];
 export declare const loadNodeNativeAddon: <T>(require: NodeRequire, name: NodeNativeAddonName, specifier?: string) => T;
 export {};

package/src/connections/node-buffer-pointer.d.ts

@@ -0,0 +1,20 @@
+export type NodeBufferPointerAddon = {
+    getPointer: (buffer: ArrayBufferView | ArrayBuffer | SharedArrayBuffer) => bigint;
+    retainPointer: (buffer: ArrayBufferView | ArrayBuffer | SharedArrayBuffer) => {
+        pointer: bigint;
+        byteLength: number;
+        token: bigint;
+    };
+    releasePointer: (token: bigint) => boolean;
+    wrapPointer: (pointer: bigint, byteLength: number) => ArrayBuffer;
+    detachArrayBuffer: (buffer: ArrayBuffer) => boolean;
+    retainBackingStore?: (buffer: ArrayBufferView | ArrayBuffer) => {
+        pointer: bigint;
+        byteOffset: number;
+        byteLength: number;
+        token: bigint;
+    };
+    adoptBackingStore?: (token: bigint) => ArrayBuffer;
+    releaseBackingStore?: (token: bigint) => boolean;
+};
+export declare const loadNodeBufferPointerAddon: (specifier?: string) => NodeBufferPointerAddon;

package/src/connections/node-buffer-pointer.js

@@ -0,0 +1,16 @@
+import { getNodeBuiltinModule } from "../common/node-compat.js";
+import { loadNodeNativeAddon } from "./node-addons.js";
+let cached;
+export const loadNodeBufferPointerAddon = (specifier) => {
+    if (specifier === undefined && cached !== undefined)
+        return cached;
+    const nodeModule = getNodeBuiltinModule("node:module");
+    if (nodeModule === undefined) {
+        throw new Error("Node buffer-pointer addon can only be loaded in Node");
+    }
+    const require = nodeModule.createRequire(import.meta.url);
+    const addon = loadNodeNativeAddon(require, "knitting_buffer_pointer", specifier);
+    if (specifier === undefined)
+        cached = addon;
+    return addon;
+};

package/src/connections/process-shared-buffer.js

@@ -150,6 +150,8 @@ export class ProcessSharedBuffer {
     static parse(serialized) {
         return ProcessSharedBuffer.fromMetadata(serialized);
     }
+    // Rebuilds from the 8 raw words (no name -> no JSON):
+    // fd, size, descByteLength, byteOffset, byteLength, runtime, kind, baseAddressMod64
     static [PROCESS_SHARED_BUFFER_NUMERIC_TRANSFER](metadata) {
         const [fd, size, descriptorByteLength, byteOffset, byteLength, runtime, kind, baseAddressMod64,] = metadata;
         return new ProcessSharedBuffer(new FileDescriptor({

package/src/connections/shared-array-buffer-payload.d.ts

@@ -0,0 +1,36 @@
+export declare const SHARED_ARRAY_BUFFER_CODEC_ID: "knitting.sharedArrayBuffer";
+export declare const SHARED_ARRAY_BUFFER_NUMERIC_TRANSFER: unique symbol;
+export declare const SHARED_ARRAY_BUFFER_NUMERIC_WORDS = 8;
+declare const EXTERNAL_PAYLOAD_BRAND: unique symbol;
+type SharedArrayBufferMetadata = {
+    readonly kind: typeof SHARED_ARRAY_BUFFER_CODEC_ID;
+    readonly origin: string;
+    readonly runtime: string;
+    readonly pointer: string;
+    readonly token: string;
+    readonly byteLength: number;
+};
+type SharedArrayBufferNumericMetadata = readonly [
+    tokenLow: number,
+    tokenHigh: number,
+    pointerLow: number,
+    pointerHigh: number,
+    byteLength: number,
+    runtime: number,
+    originPid: number,
+    mode: number
+];
+type SharedArrayBufferTokenNumericMetadata = readonly [
+    tokenLow: number,
+    tokenHigh: number
+];
+type SharedArrayBufferPayload = {
+    readonly [EXTERNAL_PAYLOAD_BRAND]: typeof SHARED_ARRAY_BUFFER_CODEC_ID;
+    readonly toMetadata: () => SharedArrayBufferMetadata;
+    readonly [SHARED_ARRAY_BUFFER_NUMERIC_TRANSFER]: (transportKey?: object) => SharedArrayBufferNumericMetadata | SharedArrayBufferTokenNumericMetadata | undefined;
+};
+export declare const isSharedArrayBufferValue: (value: unknown) => value is SharedArrayBuffer;
+/** Wrap a SAB as external payload; GC-managed pins mean no settle finalizer. */
+export declare const wrapSharedArrayBufferPayload: (sab: SharedArrayBuffer) => SharedArrayBufferPayload;
+export declare const getSharedArrayBufferPayload: (value: object) => SharedArrayBufferPayload | undefined;
+export {};