@k13engineering/linux-fuse 0.0.1 → 0.0.2

package/dist/lib/protocol.d.ts

@@ -0,0 +1,756 @@
+import type { TParsedMessageFromKernel, TParsedMessageToKernel } from "./message.js";
+type TRequesterInfo = {
+    uid: bigint;
+    gid: bigint;
+    pid: bigint;
+};
+type TOpenFlagsToKernel = {
+    directIo: boolean;
+    keepCache: boolean;
+    nonSeekable: boolean;
+};
+type TFuseAttr = {
+    ino: bigint;
+    mode: bigint;
+    nlink: bigint;
+    uid: bigint;
+    gid: bigint;
+    rdev: bigint;
+    size: bigint;
+    blksize: bigint;
+    blocks: bigint;
+    atimeNsec: bigint;
+    mtimeNsec: bigint;
+    ctimeNsec: bigint;
+};
+type TFuseEntry = {
+    nodeId: bigint;
+    generation: bigint;
+    entryValidNsec: bigint;
+    attrValidNsec: bigint;
+    attr: TFuseAttr;
+};
+type TFuseXAttrResult = {
+    data: Uint8Array;
+} | {
+    size: bigint;
+};
+type TFuseRequest = {
+    unique: bigint;
+    requester: TRequesterInfo;
+} & ({
+    opcode: "INIT";
+    major: bigint;
+    minor: bigint;
+} | {
+    opcode: "FORGET";
+    nodeId: bigint;
+    lookupCount: bigint;
+} | {
+    opcode: "BATCH_FORGET";
+    forgets: Array<{
+        nodeId: bigint;
+        lookupCount: bigint;
+    }>;
+} | {
+    opcode: "GETATTR";
+    getattrMode: "node";
+    nodeId: bigint;
+} | {
+    opcode: "GETATTR";
+    getattrMode: "fileHandle";
+    fh: bigint;
+} | {
+    opcode: "LISTXATTR";
+    nodeId: bigint;
+    size: bigint;
+} | {
+    opcode: "GETXATTR";
+    nodeId: bigint;
+    size: bigint;
+    name: string;
+} | {
+    opcode: "SETATTR";
+    nodeId: bigint;
+    valid: bigint;
+    fh: bigint;
+    size: bigint;
+    lockOwner: bigint;
+    atimeNsec: bigint;
+    mtimeNsec: bigint;
+    ctimeNsec: bigint;
+    mode: bigint;
+    uid: bigint;
+    gid: bigint;
+} | {
+    opcode: "READLINK";
+    nodeId: bigint;
+} | {
+    opcode: "SYMLINK";
+    parentNodeId: bigint;
+    name: string;
+    target: string;
+} | {
+    opcode: "MKNOD";
+    parentNodeId: bigint;
+    name: string;
+    mode: bigint;
+    rdev: bigint;
+    umask: bigint;
+} | {
+    opcode: "MKDIR";
+    parentNodeId: bigint;
+    name: string;
+    mode: bigint;
+    umask: bigint;
+} | {
+    opcode: "UNLINK";
+    parentNodeId: bigint;
+    name: string;
+} | {
+    opcode: "RMDIR";
+    parentNodeId: bigint;
+    name: string;
+} | {
+    opcode: "RENAME";
+    parentNodeId: bigint;
+    newParentNodeId: bigint;
+    oldName: string;
+    newName: string;
+    flags: bigint;
+} | {
+    opcode: "LINK";
+    oldNodeId: bigint;
+    newParentNodeId: bigint;
+    name: string;
+} | {
+    opcode: "OPENDIR";
+    nodeId: bigint;
+    flags: bigint;
+} | {
+    opcode: "READDIR";
+    nodeId: bigint;
+    fh: bigint;
+    offset: bigint;
+    size: bigint;
+    readFlags: bigint;
+    lockOwner: bigint;
+    flags: bigint;
+} | {
+    opcode: "RELEASE";
+    nodeId: bigint;
+    fh: bigint;
+    flags: bigint;
+    releaseFlags: bigint;
+    lockOwner: bigint;
+} | {
+    opcode: "RELEASEDIR";
+    nodeId: bigint;
+    fh: bigint;
+    flags: bigint;
+    releaseFlags: bigint;
+    lockOwner: bigint;
+} | {
+    opcode: "FSYNCDIR";
+    nodeId: bigint;
+    fh: bigint;
+    fsyncFlags: bigint;
+} | {
+    opcode: "STATFS";
+} | {
+    opcode: "LOOKUP";
+    parentNodeId: bigint;
+    name: string;
+} | {
+    opcode: "OPEN";
+    nodeId: bigint;
+    flags: bigint;
+} | {
+    opcode: "READ";
+    nodeId: bigint;
+    fh: bigint;
+    offset: bigint;
+    size: bigint;
+    readFlags: bigint;
+    lockOwner: bigint;
+} | {
+    opcode: "WRITE";
+    nodeId: bigint;
+    fh: bigint;
+    offset: bigint;
+    data: Uint8Array;
+    writeFlags: bigint;
+    lockOwner: bigint;
+} | {
+    opcode: "FLUSH";
+    nodeId: bigint;
+    fh: bigint;
+    lockOwner: bigint;
+} | {
+    opcode: "FSYNC";
+    nodeId: bigint;
+    fh: bigint;
+    fsyncFlags: bigint;
+} | {
+    opcode: "ACCESS";
+    nodeId: bigint;
+    mask: bigint;
+} | {
+    opcode: "SETXATTR";
+    nodeId: bigint;
+    name: string;
+    data: Uint8Array;
+    flags: bigint;
+    setxattrFlags: bigint;
+} | {
+    opcode: "REMOVEXATTR";
+    nodeId: bigint;
+    name: string;
+} | {
+    opcode: "CREATE";
+    parentNodeId: bigint;
+    name: string;
+    flags: bigint;
+    mode: bigint;
+    umask: bigint;
+} | {
+    opcode: "DESTROY";
+} | {
+    opcode: "GETLK";
+    nodeId: bigint;
+    fh: bigint;
+    owner: bigint;
+    lockStart: bigint;
+    lockEnd: bigint;
+    lockType: bigint;
+    lockPid: bigint;
+    lkFlags: bigint;
+} | {
+    opcode: "SETLK";
+    nodeId: bigint;
+    fh: bigint;
+    owner: bigint;
+    lockStart: bigint;
+    lockEnd: bigint;
+    lockType: bigint;
+    lockPid: bigint;
+    lkFlags: bigint;
+} | {
+    opcode: "SETLKW";
+    nodeId: bigint;
+    fh: bigint;
+    owner: bigint;
+    lockStart: bigint;
+    lockEnd: bigint;
+    lockType: bigint;
+    lockPid: bigint;
+    lkFlags: bigint;
+} | {
+    opcode: "INTERRUPT";
+    targetUnique: bigint;
+} | {
+    opcode: "BMAP";
+    nodeId: bigint;
+    block: bigint;
+    blocksize: bigint;
+} | {
+    opcode: "IOCTL";
+    nodeId: bigint;
+    fh: bigint;
+    flags: bigint;
+    cmd: bigint;
+    arg: bigint;
+    inData: Uint8Array;
+    outSize: bigint;
+} | {
+    opcode: "POLL";
+    nodeId: bigint;
+    fh: bigint;
+    kh: bigint;
+    flags: bigint;
+    events: bigint;
+} | {
+    opcode: "NOTIFY_REPLY";
+    data: Uint8Array;
+} | {
+    opcode: "FALLOCATE";
+    nodeId: bigint;
+    fh: bigint;
+    offset: bigint;
+    length: bigint;
+    mode: bigint;
+} | {
+    opcode: "READDIRPLUS";
+    nodeId: bigint;
+    fh: bigint;
+    offset: bigint;
+    size: bigint;
+    readFlags: bigint;
+    lockOwner: bigint;
+    flags: bigint;
+});
+type TFuseResponse = {
+    forOpcode: "INIT";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "INIT";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        major: bigint;
+        minor: bigint;
+        maxReadahead: bigint;
+        flags: bigint;
+        maxBackground: bigint;
+        congestionThreshold: bigint;
+        maxWrite: bigint;
+        timeGran: bigint;
+        maxPages: bigint;
+        mapAlignment: bigint;
+        flags2: bigint;
+        maxStackDepth: bigint;
+        requestTimeout: bigint;
+    };
+} | {
+    forOpcode: "GETATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "GETATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        attrValidNsec: bigint;
+        attr: TFuseAttr;
+    };
+} | {
+    forOpcode: "SETATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "SETATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        attrValidNsec: bigint;
+        attr: TFuseAttr;
+    };
+} | {
+    forOpcode: "LISTXATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "LISTXATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseXAttrResult;
+} | {
+    forOpcode: "GETXATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "GETXATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseXAttrResult;
+} | {
+    forOpcode: "READLINK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "READLINK";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        target: string;
+    };
+} | {
+    forOpcode: "MKNOD";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "MKNOD";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry;
+} | {
+    forOpcode: "OPENDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "OPENDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        fh: bigint;
+        openFlagsToKernel: TOpenFlagsToKernel;
+    };
+} | {
+    forOpcode: "READDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "READDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        data: Uint8Array;
+    };
+} | {
+    forOpcode: "RELEASEDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "RELEASEDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "FSYNCDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "FSYNCDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "RELEASE";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "RELEASE";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "STATFS";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "STATFS";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        blocks: bigint;
+        bfree: bigint;
+        bavail: bigint;
+        files: bigint;
+        ffree: bigint;
+        bsize: bigint;
+        namelen: bigint;
+        frsize: bigint;
+    };
+} | {
+    forOpcode: "LOOKUP";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "LOOKUP";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry;
+} | {
+    forOpcode: "SYMLINK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "SYMLINK";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry;
+} | {
+    forOpcode: "MKDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "MKDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry;
+} | {
+    forOpcode: "LINK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "LINK";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry;
+} | {
+    forOpcode: "UNLINK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "UNLINK";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "RMDIR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "RMDIR";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "RENAME";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "RENAME";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "OPEN";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "OPEN";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        fh: bigint;
+        openFlagsToKernel: TOpenFlagsToKernel;
+    };
+} | {
+    forOpcode: "READ";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "READ";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        data: Uint8Array;
+    };
+} | {
+    forOpcode: "WRITE";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "WRITE";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        bytesWritten: bigint;
+    };
+} | {
+    forOpcode: "FLUSH";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "FLUSH";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "FSYNC";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "FSYNC";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "ACCESS";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "ACCESS";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "SETXATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "SETXATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "REMOVEXATTR";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "REMOVEXATTR";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "CREATE";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "CREATE";
+    unique: bigint;
+    errorCode: undefined;
+    result: TFuseEntry & {
+        fh: bigint;
+        openFlagsToKernel: TOpenFlagsToKernel;
+    };
+} | {
+    forOpcode: "DESTROY";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "DESTROY";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "GETLK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "GETLK";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        lockStart: bigint;
+        lockEnd: bigint;
+        lockType: bigint;
+        lockPid: bigint;
+    };
+} | {
+    forOpcode: "SETLK";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "SETLK";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "SETLKW";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "SETLKW";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "BMAP";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "BMAP";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        block: bigint;
+    };
+} | {
+    forOpcode: "IOCTL";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "IOCTL";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        ioctlResult: bigint;
+        flags: bigint;
+        data: Uint8Array;
+    };
+} | {
+    forOpcode: "POLL";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "POLL";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        revents: bigint;
+    };
+} | {
+    forOpcode: "FALLOCATE";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "FALLOCATE";
+    unique: bigint;
+    errorCode: undefined;
+    result: Record<string, never>;
+} | {
+    forOpcode: "READDIRPLUS";
+    unique: bigint;
+    errorCode: number;
+    result: undefined;
+} | {
+    forOpcode: "READDIRPLUS";
+    unique: bigint;
+    errorCode: undefined;
+    result: {
+        data: Uint8Array;
+    };
+};
+type TGenericInterpretResult<T> = {
+    error: Error;
+    interpreted: undefined;
+} | {
+    error: undefined;
+    interpreted: T;
+};
+declare const createMessageFromKernelInterpreter: () => {
+    interpretMessageFromKernel: ({ parsedMessageFromKernel }: {
+        parsedMessageFromKernel: TParsedMessageFromKernel;
+    }) => TGenericInterpretResult<TFuseRequest>;
+};
+declare const createMessageToKernelInterpreter: () => {
+    encodeMessageToKernel: ({ response }: {
+        response: TFuseResponse;
+    }) => TParsedMessageToKernel;
+    interpretMessageToKernel: ({ request, parsedMessageToKernel }: {
+        request: TFuseRequest;
+        parsedMessageToKernel: TParsedMessageToKernel;
+    }) => TGenericInterpretResult<TFuseResponse>;
+};
+export { createMessageFromKernelInterpreter, createMessageToKernelInterpreter, };
+export type { TFuseRequest, TFuseResponse, };