knitting 0.1.46 → 0.1.51

package/src/runtime/process-worker.d.ts

@@ -0,0 +1,92 @@
+import { type LockControlCarpet } from "../memory/byte-carpet.js";
+import type { DebugOptions, LockBuffers, WorkerData, WorkerSettings } from "../types.js";
+import { RUNTIME_PROCESS_WORKER_BOOT_VERSION } from "../common/worker-runtime.js";
+import { type SharedBufferSource } from "../common/shared-buffer-region.js";
+import { FileDescriptor, type ProcessSharedBufferMetadata } from "../connections/index.js";
+import type { SharedMemoryBuffer, SharedMemoryMapping } from "../connections/types.js";
+export type SpawnedWorker = {
+    terminate: () => unknown;
+    unref?: () => unknown;
+    postMessage?: (message: unknown) => void;
+};
+export type NodeWorkerLike = {
+    on?: (event: "error" | "exit" | "message", listener: (...args: unknown[]) => void) => void;
+};
+type ProcessWorkerWireLockBuffers = Omit<LockBuffers, "headers" | "lockSector" | "payload" | "payloadSector"> & {
+    headers: ProcessSharedBufferMetadata;
+    lockSector: ProcessSharedBufferMetadata;
+    payload: ProcessSharedBufferMetadata;
+    payloadSector: ProcessSharedBufferMetadata;
+};
+type ProcessWorkerWireData = Omit<WorkerData, "sab" | "abortSignalSAB" | "lock" | "returnLock"> & {
+    sab: ProcessSharedBufferMetadata;
+    abortSignalSAB?: ProcessSharedBufferMetadata;
+    lock: ProcessWorkerWireLockBuffers;
+    returnLock: ProcessWorkerWireLockBuffers;
+};
+export type ProcessWorkerBootPayload = {
+    version: typeof RUNTIME_PROCESS_WORKER_BOOT_VERSION;
+    workerData: ProcessWorkerWireData;
+};
+export type ProcessWorkerMemoryLayout = {
+    mapping: SharedMemoryMapping<SharedMemoryBuffer>;
+    descriptor: FileDescriptor;
+    controlLayout: LockControlCarpet;
+    lockPayload: SharedBufferSource;
+    returnPayload: SharedBufferSource;
+    cleanup: () => void;
+};
+export type ProcessWorkerRuntime = NonNullable<WorkerSettings["processRuntime"]>;
+export type ProcessWorkerCommandPrefix = NonNullable<WorkerSettings["processCommandPrefix"]>;
+export type ResolvedProcessSharedMemorySettings = {
+    mode: "inherit" | "named";
+    namePrefix?: string;
+    unlinkOnShutdown: boolean;
+};
+type ProcessSharedMemoryNativeMapping = {
+    sab: SharedArrayBuffer;
+    fd: number;
+    name?: string;
+    size: number;
+    baseAddressMod64?: number;
+};
+export type ProcessSharedMemoryBacking = ProcessSharedMemoryNativeMapping & {
+    runtime: "node";
+    buffer: SharedArrayBuffer;
+    kind: "shared-array-buffer";
+    byteLength: number;
+};
+type ProcessSharedMemoryAllocator = {
+    createBuffer: (byteLength: number) => SharedArrayBuffer;
+    backings: ProcessSharedMemoryBacking[];
+};
+export declare const toWorkerSafeExecArgv: (flags: string[] | undefined) => string[] | undefined;
+export declare const toWorkerCompatExecArgv: (flags: string[] | undefined) => string[] | undefined;
+export declare const createProcessSharedMemoryAllocator: (debug: DebugOptions | undefined) => ProcessSharedMemoryAllocator | undefined;
+export declare const createProcessWorkerMemoryLayout: ({ signalBytes, abortBytes, payloadBytes, thread, sharedMemory, }: {
+    signalBytes: number;
+    abortBytes: number;
+    payloadBytes: number;
+    thread: number;
+    sharedMemory: ResolvedProcessSharedMemorySettings;
+}) => ProcessWorkerMemoryLayout;
+export declare const serializeWorkerBootstrapData: (options: WorkerSettings) => WorkerSettings;
+export declare const toProcessWorkerBootPayload: (workerData: WorkerData, memory: ProcessWorkerMemoryLayout) => ProcessWorkerBootPayload;
+export declare const readProcessWorkerRuntime: (options: WorkerSettings | undefined) => ProcessWorkerRuntime;
+export declare const readProcessWorkerCommandPrefix: (options: WorkerSettings | undefined) => ProcessWorkerCommandPrefix | undefined;
+export declare const readProcessSharedMemorySettings: (options: WorkerSettings | undefined) => ResolvedProcessSharedMemorySettings;
+export declare const createProcessWorkerNativeSignalNotifier: ({ processRuntime, signal, }: {
+    processRuntime: ProcessWorkerRuntime | undefined;
+    signal: Int32Array;
+}) => (() => void) | undefined;
+export declare const spawnProcessWorker: (options: {
+    workerUrl: string | URL;
+    bootPayload: ProcessWorkerBootPayload;
+    memory: ProcessWorkerMemoryLayout;
+    processRuntime: ProcessWorkerRuntime;
+    commandPrefix?: ProcessWorkerCommandPrefix;
+    permission?: WorkerData["permission"];
+}) => SpawnedWorker & NodeWorkerLike;
+export declare const terminateWorkerQuietly: (worker: SpawnedWorker) => void;
+export declare const cleanupProcessWorkerMemoryQuietly: (memory: ProcessWorkerMemoryLayout | undefined) => void;
+export {};