knitting 0.1.55 → 0.1.56

package/src/connections/deno.d.ts

@@ -0,0 +1,22 @@
+import { type CreateSharedMemoryOptions, type MapSharedMemoryOptions, type SharedMemoryConnectionPrimitives, type SharedMemoryMapping } from "./types.js";
+type DenoLibc = {
+    symbols: {
+        memfd_create?: (name: Uint8Array, flags: number) => number;
+        shm_open?: (name: Uint8Array, flags: number, mode: number) => number;
+        shm_unlink?: (name: Uint8Array) => number;
+        ftruncate: (fd: number, length: bigint) => number;
+        dup: (fd: number) => number;
+        fcntl: (fd: number, cmd: number, arg: number) => number;
+        mmap: (address: null, length: number, protection: number, flags: number, fd: number, offset: bigint) => unknown;
+        munmap: (address: unknown, length: number) => number;
+        close: (fd: number) => number;
+    };
+    close: () => void;
+};
+export declare const openDenoLibc: () => DenoLibc;
+export declare const mapDenoSharedMemory: (options: MapSharedMemoryOptions, libc?: DenoLibc) => SharedMemoryMapping<ArrayBuffer>;
+export declare const createDenoSharedMemory: (options: number | CreateSharedMemoryOptions, libc?: DenoLibc) => SharedMemoryMapping<ArrayBuffer>;
+export declare const unlinkDenoSharedMemory: (name: string, libc?: DenoLibc) => boolean;
+export declare const createDenoPosixConnectionPrimitives: (libc?: DenoLibc) => SharedMemoryConnectionPrimitives<SharedMemoryMapping<ArrayBuffer>>;
+export declare const createDenoConnectionPrimitives: (libc?: DenoLibc) => SharedMemoryConnectionPrimitives<SharedMemoryMapping<ArrayBuffer>>;
+export {};

package/src/connections/deno.js

@@ -0,0 +1,205 @@
+import { DARWIN_O_CREAT, DARWIN_O_EXCL, DARWIN_SHM_MODE, LINUX_O_CREAT, LINUX_O_EXCL, setCloseOnExec, detectPosixPlatform, encodeCString, getPosixLibcPath, makeDarwinSharedMemoryName, MAP_SHARED, O_RDWR, POSIX_SHM_MODE, PROT_READ, PROT_WRITE, toPosixSharedMemoryName, } from "./posix.js";
+import { expectFd, expectPositiveSize, readCreateName, readCreateMode, readRequiredCreateName, readCreateSize, } from "./types.js";
+import { createDenoWindowsConnectionPrimitives, isWindowsRuntime, } from "./windows.js";
+const getDeno = () => {
+    const deno = globalThis.Deno;
+    if (deno === undefined) {
+        throw new Error("Deno shared memory primitives can only run in Deno");
+    }
+    return deno;
+};
+export const openDenoLibc = () => getDeno().dlopen(getPosixLibcPath(), {
+    ...getDenoCreateSymbols(),
+    ftruncate: {
+        parameters: ["i32", "i64"],
+        result: "i32",
+    },
+    dup: {
+        parameters: ["i32"],
+        result: "i32",
+    },
+    fcntl: {
+        parameters: ["i32", "i32", "i32"],
+        result: "i32",
+    },
+    mmap: {
+        parameters: ["pointer", "usize", "i32", "i32", "i32", "i64"],
+        result: "pointer",
+    },
+    munmap: {
+        parameters: ["pointer", "usize"],
+        result: "i32",
+    },
+    close: {
+        parameters: ["i32"],
+        result: "i32",
+    },
+});
+const getDenoCreateSymbols = (platform = detectPosixPlatform()) => platform === "darwin"
+    ? {
+        shm_open: {
+            parameters: ["buffer", "i32", "u32"],
+            result: "i32",
+        },
+        shm_unlink: {
+            parameters: ["buffer"],
+            result: "i32",
+        },
+    }
+    : {
+        memfd_create: {
+            parameters: ["buffer", "u32"],
+            result: "i32",
+        },
+        shm_open: {
+            parameters: ["buffer", "i32", "u32"],
+            result: "i32",
+        },
+        shm_unlink: {
+            parameters: ["buffer"],
+            result: "i32",
+        },
+    };
+const checkResult = (result, message) => {
+    if (result < 0)
+        throw new Error(message);
+    return result;
+};
+const isDenoMmapFailed = (pointer) => {
+    if (pointer === null)
+        return true;
+    const value = getDeno().UnsafePointer?.value(pointer);
+    return value === -1n || value === BigInt.asUintN(64, -1n);
+};
+const createDenoSharedMemoryFd = (name, platform, libc) => {
+    if (platform === "darwin") {
+        const shmOpen = libc.symbols.shm_open;
+        const shmUnlink = libc.symbols.shm_unlink;
+        if (shmOpen === undefined || shmUnlink === undefined) {
+            throw new Error("shm_open symbols are not available");
+        }
+        const shmName = encodeCString(makeDarwinSharedMemoryName(name, "deno"));
+        const fd = checkResult(shmOpen(shmName, O_RDWR | DARWIN_O_CREAT | DARWIN_O_EXCL, DARWIN_SHM_MODE), "shm_open failed");
+        shmUnlink(shmName);
+        try {
+            return setCloseOnExec(libc, fd);
+        }
+        catch (error) {
+            libc.symbols.close(fd);
+            throw error;
+        }
+    }
+    const memfdCreate = libc.symbols.memfd_create;
+    if (memfdCreate === undefined) {
+        throw new Error("memfd_create symbol is not available");
+    }
+    const fd = checkResult(memfdCreate(encodeCString(name), 0), "memfd_create failed");
+    try {
+        return setCloseOnExec(libc, fd);
+    }
+    catch (error) {
+        libc.symbols.close(fd);
+        throw error;
+    }
+};
+const createNamedDenoSharedMemoryFd = (name, mode, platform, libc) => {
+    const shmOpen = libc.symbols.shm_open;
+    if (shmOpen === undefined) {
+        throw new Error("shm_open symbol is not available");
+    }
+    const createFlags = platform === "darwin" ? DARWIN_O_CREAT : LINUX_O_CREAT;
+    const exclusiveFlags = platform === "darwin" ? DARWIN_O_EXCL : LINUX_O_EXCL;
+    const flags = mode === "create"
+        ? O_RDWR | createFlags | exclusiveFlags
+        : O_RDWR;
+    const fd = checkResult(shmOpen(encodeCString(toPosixSharedMemoryName(name)), flags, platform === "darwin" ? DARWIN_SHM_MODE : POSIX_SHM_MODE), "shm_open failed");
+    try {
+        return setCloseOnExec(libc, fd);
+    }
+    catch (error) {
+        libc.symbols.close(fd);
+        throw error;
+    }
+};
+export const mapDenoSharedMemory = (options, libc = openDenoLibc()) => {
+    const sourceFd = options.name === undefined ? expectFd(options.fd) : -1;
+    const size = expectPositiveSize(options.size);
+    let fd = sourceFd;
+    if (options.name !== undefined) {
+        fd = createNamedDenoSharedMemoryFd(options.name, "open", detectPosixPlatform(), libc);
+    }
+    else if (options.duplicateFd !== false) {
+        fd = checkResult(libc.symbols.dup(sourceFd), "dup(fd) failed");
+        try {
+            setCloseOnExec(libc, fd);
+        }
+        catch (error) {
+            libc.symbols.close(fd);
+            throw error;
+        }
+    }
+    const pointer = libc.symbols.mmap(null, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0n);
+    if (isDenoMmapFailed(pointer)) {
+        if (options.duplicateFd !== false)
+            libc.symbols.close(fd);
+        throw new Error("mmap failed");
+    }
+    const arrayBuffer = new (getDeno().UnsafePointerView)(pointer)
+        .getArrayBuffer(size);
+    return {
+        runtime: "deno",
+        fd,
+        name: options.name,
+        size,
+        byteLength: arrayBuffer.byteLength,
+        buffer: arrayBuffer,
+        kind: "external-array-buffer",
+        arrayBuffer,
+        unsafePointer: pointer,
+        close: () => {
+            libc.symbols.munmap(pointer, size);
+            libc.symbols.close(fd);
+        },
+    };
+};
+export const createDenoSharedMemory = (options, libc = openDenoLibc()) => {
+    const size = expectPositiveSize(readCreateSize(options));
+    const mode = readCreateMode(options);
+    const name = mode === "anonymous"
+        ? readCreateName(options, "knitting_shared_memory")
+        : readRequiredCreateName(options);
+    const platform = detectPosixPlatform();
+    const fd = mode === "anonymous"
+        ? createDenoSharedMemoryFd(name, platform, libc)
+        : createNamedDenoSharedMemoryFd(name, mode, platform, libc);
+    try {
+        if (mode !== "open") {
+            checkResult(libc.symbols.ftruncate(fd, BigInt(size)), "ftruncate failed");
+        }
+        const mapping = mapDenoSharedMemory({ fd, size, duplicateFd: false }, libc);
+        if (mode !== "anonymous") {
+            return { ...mapping, name };
+        }
+        return mapping;
+    }
+    catch (error) {
+        libc.symbols.close(fd);
+        throw error;
+    }
+};
+export const unlinkDenoSharedMemory = (name, libc = openDenoLibc()) => {
+    const shmUnlink = libc.symbols.shm_unlink;
+    if (shmUnlink === undefined) {
+        throw new Error("shm_unlink symbol is not available");
+    }
+    return shmUnlink(encodeCString(toPosixSharedMemoryName(name))) === 0;
+};
+export const createDenoPosixConnectionPrimitives = (libc = openDenoLibc()) => ({
+    runtime: "deno",
+    createSharedMemory: (options) => createDenoSharedMemory(options, libc),
+    mapSharedMemory: (options) => mapDenoSharedMemory(options, libc),
+    unlinkSharedMemory: (name) => unlinkDenoSharedMemory(name, libc),
+});
+export const createDenoConnectionPrimitives = (libc) => isWindowsRuntime()
+    ? createDenoWindowsConnectionPrimitives()
+    : createDenoPosixConnectionPrimitives(libc);

package/src/connections/file-descriptor.d.ts

@@ -0,0 +1,39 @@
+import { type ConnectionRuntime, type SharedMemoryBuffer, type SharedMemoryConnectionPrimitives, type SharedMemoryMapping } from "./types.js";
+export type FileDescriptorMetadata = {
+    version: 1;
+    fd: number;
+    name?: string;
+    size: number;
+    byteLength: number;
+    runtime?: ConnectionRuntime;
+    kind?: SharedMemoryMapping["kind"];
+    baseAddressMod64?: number;
+};
+type FileDescriptorMapper = Pick<SharedMemoryConnectionPrimitives, "mapSharedMemory">;
+export declare class FileDescriptor {
+    #private;
+    readonly fd: number;
+    readonly name?: string;
+    readonly size: number;
+    readonly byteLength: number;
+    readonly runtime?: ConnectionRuntime;
+    readonly kind?: SharedMemoryMapping["kind"];
+    readonly baseAddressMod64?: number;
+    constructor(metadata: FileDescriptorMetadata, mapping?: SharedMemoryMapping);
+    static fromMapping(mapping: SharedMemoryMapping): FileDescriptor;
+    static fromMetadata(metadata: unknown): FileDescriptor;
+    static parse(serialized: string): FileDescriptor;
+    toMetadata(): FileDescriptorMetadata;
+    toJSON(): FileDescriptorMetadata;
+    stringify(): string;
+    stringifyMetadata(): string;
+    toString(): string;
+    attach(mapping: SharedMemoryMapping): this;
+    get mapping(): SharedMemoryMapping | undefined;
+    map(mapper: FileDescriptorMapper): SharedMemoryMapping;
+    getBuffer(mapper?: FileDescriptorMapper): SharedMemoryBuffer;
+    getSharedArrayBuffer(mapper?: FileDescriptorMapper): SharedArrayBuffer;
+    getSAB(mapper?: FileDescriptorMapper): SharedArrayBuffer;
+}
+export declare const parseFileDescriptorMetadata: (input: unknown) => FileDescriptorMetadata;
+export {};

package/src/connections/file-descriptor.js

@@ -0,0 +1,161 @@
+import { expectFd, expectPositiveSize, requireSharedArrayBuffer, } from "./types.js";
+const isRecord = (value) => typeof value === "object" && value !== null;
+const readOptionalRuntime = (value) => {
+    if (value === undefined)
+        return undefined;
+    if (value === "node" || value === "deno" || value === "bun")
+        return value;
+    throw new TypeError("file descriptor runtime is invalid");
+};
+const readOptionalKind = (value) => {
+    if (value === undefined)
+        return undefined;
+    if (value === "shared-array-buffer" ||
+        value === "external-array-buffer") {
+        return value;
+    }
+    throw new TypeError("file descriptor buffer kind is invalid");
+};
+const readOptionalNumber = (value, label) => {
+    if (value === undefined)
+        return undefined;
+    if (typeof value !== "number" || !Number.isFinite(value)) {
+        throw new TypeError(`file descriptor ${label} must be a finite number`);
+    }
+    return Math.trunc(value);
+};
+const readOptionalName = (value) => {
+    if (value === undefined)
+        return undefined;
+    if (typeof value !== "string" || value.length === 0) {
+        throw new TypeError("file descriptor name must be a non-empty string when provided");
+    }
+    if (value.includes("\0")) {
+        throw new TypeError("file descriptor name must not contain NUL bytes");
+    }
+    return value;
+};
+export class FileDescriptor {
+    fd;
+    name;
+    size;
+    byteLength;
+    runtime;
+    kind;
+    baseAddressMod64;
+    #mapping;
+    constructor(metadata, mapping) {
+        this.fd = expectFd(metadata.fd);
+        this.name = metadata.name;
+        this.size = expectPositiveSize(metadata.size);
+        this.byteLength = expectPositiveSize(metadata.byteLength);
+        this.runtime = metadata.runtime;
+        this.kind = metadata.kind;
+        this.baseAddressMod64 = metadata.baseAddressMod64;
+        this.#mapping = mapping;
+    }
+    static fromMapping(mapping) {
+        return new FileDescriptor({
+            version: 1,
+            fd: mapping.fd,
+            name: mapping.name,
+            size: mapping.size,
+            byteLength: mapping.byteLength,
+            runtime: mapping.runtime,
+            kind: mapping.kind,
+            baseAddressMod64: mapping.baseAddressMod64,
+        }, mapping);
+    }
+    static fromMetadata(metadata) {
+        return new FileDescriptor(parseFileDescriptorMetadata(metadata));
+    }
+    static parse(serialized) {
+        return FileDescriptor.fromMetadata(serialized);
+    }
+    toMetadata() {
+        const metadata = {
+            version: 1,
+            fd: this.fd,
+            size: this.size,
+            byteLength: this.byteLength,
+            runtime: this.runtime,
+            kind: this.kind,
+            baseAddressMod64: this.baseAddressMod64,
+        };
+        if (this.name !== undefined)
+            metadata.name = this.name;
+        return metadata;
+    }
+    toJSON() {
+        return this.toMetadata();
+    }
+    stringify() {
+        return JSON.stringify(this.toMetadata());
+    }
+    stringifyMetadata() {
+        // This describes an fd; it does not transfer fd ownership to another process.
+        return this.stringify();
+    }
+    toString() {
+        return this.stringify();
+    }
+    attach(mapping) {
+        this.#mapping = mapping;
+        return this;
+    }
+    get mapping() {
+        return this.#mapping;
+    }
+    map(mapper) {
+        const options = {
+            fd: this.fd,
+            name: this.name,
+            size: this.size,
+        };
+        this.#mapping = mapper.mapSharedMemory(options);
+        return this.#mapping;
+    }
+    getBuffer(mapper) {
+        if (this.#mapping?.buffer !== undefined)
+            return this.#mapping.buffer;
+        if (mapper === undefined) {
+            throw new TypeError("file descriptor is not attached to a shared memory mapping");
+        }
+        return this.map(mapper).buffer;
+    }
+    getSharedArrayBuffer(mapper) {
+        if (this.#mapping?.sab !== undefined)
+            return this.#mapping.sab;
+        if (mapper === undefined) {
+            throw new TypeError("file descriptor is not attached to a SharedArrayBuffer mapping");
+        }
+        return requireSharedArrayBuffer(this.map(mapper));
+    }
+    getSAB(mapper) {
+        return this.getSharedArrayBuffer(mapper);
+    }
+}
+export const parseFileDescriptorMetadata = (input) => {
+    const value = typeof input === "string" ? JSON.parse(input) : input;
+    if (!isRecord(value)) {
+        throw new TypeError("file descriptor metadata must be an object");
+    }
+    if (value.version !== 1) {
+        throw new TypeError("unsupported file descriptor metadata version");
+    }
+    const parsed = {
+        version: 1,
+        fd: expectFd(readOptionalNumber(value.fd, "fd") ?? -1),
+        size: expectPositiveSize(readOptionalNumber(value.size, "size") ?? 0),
+        byteLength: expectPositiveSize(readOptionalNumber(value.byteLength, "byteLength") ??
+            readOptionalNumber(value.size, "size") ??
+            0),
+        runtime: readOptionalRuntime(value.runtime),
+        kind: readOptionalKind(value.kind),
+        baseAddressMod64: readOptionalNumber(value.baseAddressMod64, "baseAddressMod64"),
+    };
+    const name = readOptionalName(value.name);
+    if (name !== undefined)
+        parsed.name = name;
+    return parsed;
+};

package/src/connections/index.d.ts

@@ -0,0 +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

@@ -0,0 +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

@@ -0,0 +1,5 @@
+type NodeRequire = (specifier: string) => unknown;
+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-addons.js

@@ -0,0 +1,44 @@
+import { resolveKnittingPackageAsset } from "./package-assets.js";
+const readNodePlatformInfo = () => {
+    const processLike = globalThis.process;
+    if (typeof processLike?.platform !== "string" ||
+        typeof processLike.arch !== "string") {
+        return undefined;
+    }
+    return {
+        arch: processLike.arch,
+        modules: processLike.versions?.modules,
+        platform: processLike.platform,
+    };
+};
+export const nodeNativeAddonSpecifiers = (name) => {
+    const platformInfo = readNodePlatformInfo();
+    const fallback = resolveKnittingPackageAsset("build", "Release", `${name}.node`);
+    if (platformInfo === undefined)
+        return [fallback];
+    const nodeModuleAbi = platformInfo.modules;
+    if (typeof nodeModuleAbi === "string" && nodeModuleAbi.length > 0) {
+        return [
+            resolveKnittingPackageAsset("prebuilds", `${platformInfo.platform}-${platformInfo.arch}-node-${nodeModuleAbi}`, `${name}.node`),
+            fallback,
+        ];
+    }
+    return [
+        resolveKnittingPackageAsset("prebuilds", `${platformInfo.platform}-${platformInfo.arch}`, `${name}.node`),
+        fallback,
+    ];
+};
+export const loadNodeNativeAddon = (require, name, specifier) => {
+    if (specifier !== undefined)
+        return require(specifier);
+    const errors = [];
+    for (const candidate of nodeNativeAddonSpecifiers(name)) {
+        try {
+            return require(candidate);
+        }
+        catch (error) {
+            errors.push(`${candidate}: ${String(error)}`);
+        }
+    }
+    throw new Error(`Could not load native addon ${name}. Tried:\n${errors.join("\n")}`);
+};

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/node.d.ts

@@ -0,0 +1,30 @@
+import { type CreateSharedMemoryOptions, type MapSharedMemoryOptions, type SharedMemoryConnectionPrimitives, type SharedMemoryMapping } from "./types.js";
+export type NodeSharedMemoryNativeMapping = {
+    sab: SharedArrayBuffer;
+    fd: number;
+    name?: string;
+    size: number;
+    baseAddressMod64?: number;
+};
+export type NodeSharedMemoryAddon = {
+    createSharedMemory: (size: number, name?: string, mode?: CreateSharedMemoryOptions["mode"]) => NodeSharedMemoryNativeMapping;
+    mapSharedMemory: (fd: number, size: number, name?: string) => NodeSharedMemoryNativeMapping;
+    unlinkSharedMemory?: (name: string) => boolean;
+};
+export type NodeFutexWaitResult = "woken" | "changed" | "interrupted" | "timed-out";
+export type NodeFutexAddon = {
+    waitU32: (buffer: ArrayBuffer | SharedArrayBuffer, byteOffset: number, expected: number, timeoutMs?: number) => NodeFutexWaitResult;
+    wakeU32: (buffer: ArrayBuffer | SharedArrayBuffer, byteOffset: number, count?: number) => number;
+    notifyU32?: (buffer: ArrayBuffer | SharedArrayBuffer, byteOffset: number, count?: number) => number;
+    sleep?: (milliseconds?: number) => void;
+    yield?: () => void;
+};
+export declare const DEFAULT_NODE_SHARED_MEMORY_ADDON = "../../build/Release/knitting_shared_memory.node";
+export declare const DEFAULT_NODE_FUTEX_ADDON = "../../build/Release/knitting_shm.node";
+export declare const loadNodeSharedMemoryAddon: (specifier?: string) => NodeSharedMemoryAddon;
+export declare const loadNodeFutexAddon: (specifier?: string) => NodeFutexAddon;
+export declare const fromNodeNativeMapping: (mapped: NodeSharedMemoryNativeMapping) => SharedMemoryMapping<SharedArrayBuffer>;
+export declare const createNodeSharedMemory: (options: number | CreateSharedMemoryOptions, addon?: NodeSharedMemoryAddon) => SharedMemoryMapping<SharedArrayBuffer>;
+export declare const mapNodeSharedMemory: (options: MapSharedMemoryOptions, addon?: NodeSharedMemoryAddon) => SharedMemoryMapping<SharedArrayBuffer>;
+export declare const createNodeConnectionPrimitives: (addon?: NodeSharedMemoryAddon) => SharedMemoryConnectionPrimitives<SharedMemoryMapping<SharedArrayBuffer>>;
+export declare const unlinkNodeSharedMemory: (name: string, addon?: NodeSharedMemoryAddon) => boolean;

package/src/connections/node.js

@@ -0,0 +1,62 @@
+import { getNodeBuiltinModule } from "../common/node-compat.js";
+import { loadNodeNativeAddon } from "./node-addons.js";
+import { expectFd, expectPositiveSize, readCreateMode, readCreateName, readRequiredCreateName, readCreateSize, } from "./types.js";
+export const DEFAULT_NODE_SHARED_MEMORY_ADDON = "../../build/Release/knitting_shared_memory.node";
+export const DEFAULT_NODE_FUTEX_ADDON = "../../build/Release/knitting_shm.node";
+export const loadNodeSharedMemoryAddon = (specifier) => {
+    const nodeModule = getNodeBuiltinModule("node:module");
+    if (nodeModule === undefined) {
+        throw new Error("Node shared memory addon can only be loaded in Node");
+    }
+    const require = nodeModule.createRequire(import.meta.url);
+    return loadNodeNativeAddon(require, "knitting_shared_memory", specifier);
+};
+export const loadNodeFutexAddon = (specifier) => {
+    const nodeModule = getNodeBuiltinModule("node:module");
+    if (nodeModule === undefined) {
+        throw new Error("Node futex addon can only be loaded in Node");
+    }
+    const require = nodeModule.createRequire(import.meta.url);
+    return loadNodeNativeAddon(require, "knitting_shm", specifier);
+};
+export const fromNodeNativeMapping = (mapped) => {
+    const mapping = {
+        runtime: "node",
+        fd: mapped.fd,
+        size: mapped.size,
+        byteLength: mapped.sab.byteLength,
+        buffer: mapped.sab,
+        kind: "shared-array-buffer",
+        sab: mapped.sab,
+        baseAddressMod64: mapped.baseAddressMod64,
+    };
+    if (mapped.name !== undefined && mapped.name.length > 0) {
+        mapping.name = mapped.name;
+    }
+    return mapping;
+};
+export const createNodeSharedMemory = (options, addon = loadNodeSharedMemoryAddon()) => {
+    const size = expectPositiveSize(readCreateSize(options));
+    const mode = readCreateMode(options);
+    const name = mode === "anonymous"
+        ? readCreateName(options, "knitting_shared_memory")
+        : readRequiredCreateName(options);
+    return fromNodeNativeMapping(addon.createSharedMemory(size, name, mode));
+};
+export const mapNodeSharedMemory = (options, addon = loadNodeSharedMemoryAddon()) => {
+    const fd = expectFd(options.fd);
+    const size = expectPositiveSize(options.size);
+    return fromNodeNativeMapping(addon.mapSharedMemory(fd, size, options.name));
+};
+export const createNodeConnectionPrimitives = (addon = loadNodeSharedMemoryAddon()) => ({
+    runtime: "node",
+    createSharedMemory: (options) => createNodeSharedMemory(options, addon),
+    mapSharedMemory: (options) => mapNodeSharedMemory(options, addon),
+    unlinkSharedMemory: (name) => unlinkNodeSharedMemory(name, addon),
+});
+export const unlinkNodeSharedMemory = (name, addon = loadNodeSharedMemoryAddon()) => {
+    if (typeof addon.unlinkSharedMemory !== "function") {
+        throw new Error("Node shared memory addon cannot unlink named mappings");
+    }
+    return addon.unlinkSharedMemory(name);
+};

package/src/connections/numeric-array.d.ts

@@ -0,0 +1,5 @@
+export declare const NUMERIC_ARRAY_BRAND: unique symbol;
+export declare class NumericArray extends Array<number> {
+}
+export declare const isNumericArray: (value: object) => value is NumericArray;
+export declare const numericArrayFromFloat64: (view: Float64Array) => NumericArray;

package/src/connections/numeric-array.js

@@ -0,0 +1,17 @@
+export const NUMERIC_ARRAY_BRAND = Symbol.for("knitting.numericArray");
+export class NumericArray extends Array {
+}
+Object.defineProperty(NumericArray.prototype, NUMERIC_ARRAY_BRAND, {
+    value: true,
+    enumerable: false,
+    writable: false,
+    configurable: false,
+});
+export const isNumericArray = (value) => value[NUMERIC_ARRAY_BRAND] === true;
+export const numericArrayFromFloat64 = (view) => {
+    const length = view.length;
+    const out = new NumericArray(length);
+    for (let i = 0; i < length; i++)
+        out[i] = view[i];
+    return out;
+};

package/src/connections/package-assets.d.ts

@@ -0,0 +1,2 @@
+export declare const findKnittingPackageRoot: (moduleUrl?: string) => string;
+export declare const resolveKnittingPackageAsset: (...segments: string[]) => string;