@zenfs/core 1.11.3 → 2.0.0

package/dist/vfs/ioctl.js

@@ -0,0 +1,304 @@
+/*
+    ioctl stuff. The majority of the code here is ported from Linux
+    See:
+    - include/uapi/asm-generic/ioctl.h
+    - include/uapi/linux/fs.h (`FS_IOC_*`)
+*/
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+import { _throw, struct, types as t } from 'utilium';
+import { Errno, ErrnoError } from '../internal/error.js';
+import { Inode, InodeFlags } from '../internal/inode.js';
+import { normalizePath } from '../utils.js';
+import { fixError, resolveMount } from './shared.js';
+/*
+ * Flags for the fsxattr.xflags field
+ */
+var XFlag;
+(function (XFlag) {
+    /** data in realtime volume */
+    XFlag[XFlag["RealTime"] = 1] = "RealTime";
+    /** preallocated file extents */
+    XFlag[XFlag["PreAlloc"] = 2] = "PreAlloc";
+    /** file cannot be modified */
+    XFlag[XFlag["Immutable"] = 8] = "Immutable";
+    /** all writes append */
+    XFlag[XFlag["Append"] = 16] = "Append";
+    /** all writes synchronous */
+    XFlag[XFlag["Sync"] = 32] = "Sync";
+    /** do not update access time */
+    XFlag[XFlag["NoAtime"] = 64] = "NoAtime";
+    /** do not include in backups */
+    XFlag[XFlag["NoDump"] = 128] = "NoDump";
+    /** create with rt bit set */
+    XFlag[XFlag["RtInherit"] = 256] = "RtInherit";
+    /** create with parents projid */
+    XFlag[XFlag["ProjInherit"] = 512] = "ProjInherit";
+    /** disallow symlink creation */
+    XFlag[XFlag["NoSymlinks"] = 1024] = "NoSymlinks";
+    /** extent size allocator hint */
+    XFlag[XFlag["ExtSize"] = 2048] = "ExtSize";
+    /** inherit inode extent size */
+    XFlag[XFlag["ExtSzInherit"] = 4096] = "ExtSzInherit";
+    /** do not defragment */
+    XFlag[XFlag["NoDefrag"] = 8192] = "NoDefrag";
+    /** use filestream allocator */
+    XFlag[XFlag["FileStream"] = 16384] = "FileStream";
+    /** use DAX for IO */
+    XFlag[XFlag["Dax"] = 32768] = "Dax";
+    /** CoW extent size allocator hint */
+    XFlag[XFlag["CowExtSize"] = 65536] = "CowExtSize";
+    /** no DIFLAG for this */
+    XFlag[XFlag["HasAttr"] = 2147483648] = "HasAttr";
+})(XFlag || (XFlag = {}));
+let fsxattr = (() => {
+    var _a, _b, _c, _d, _e;
+    let _classDecorators = [struct()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _xflags_decorators;
+    let _xflags_initializers = [];
+    let _xflags_extraInitializers = [];
+    let _extsize_decorators;
+    let _extsize_initializers = [];
+    let _extsize_extraInitializers = [];
+    let _nextents_decorators;
+    let _nextents_initializers = [];
+    let _nextents_extraInitializers = [];
+    let _projid_decorators;
+    let _projid_initializers = [];
+    let _projid_extraInitializers = [];
+    let _cowextsize_decorators;
+    let _cowextsize_initializers = [];
+    let _cowextsize_extraInitializers = [];
+    let _pad_decorators;
+    let _pad_initializers = [];
+    let _pad_extraInitializers = [];
+    var fsxattr = _classThis = class {
+        constructor(inode = _throw(new ErrnoError(Errno.EINVAL, 'fsxattr must be initialized with an inode'))) {
+            /** xflags field value */
+            this.xflags = __runInitializers(this, _xflags_initializers, 0);
+            /** extsize field value */
+            this.extsize = (__runInitializers(this, _xflags_extraInitializers), __runInitializers(this, _extsize_initializers, 0));
+            /** nextents field value */
+            this.nextents = (__runInitializers(this, _extsize_extraInitializers), __runInitializers(this, _nextents_initializers, 0));
+            /** project identifier */
+            this.projid = (__runInitializers(this, _nextents_extraInitializers), __runInitializers(this, _projid_initializers, 0));
+            /** CoW extsize field value */
+            this.cowextsize = (__runInitializers(this, _projid_extraInitializers), __runInitializers(this, _cowextsize_initializers, 0));
+            this.pad = (__runInitializers(this, _cowextsize_extraInitializers), __runInitializers(this, _pad_initializers, []));
+            __runInitializers(this, _pad_extraInitializers);
+            this.extsize = inode.size;
+            this.nextents = 1;
+            this.projid = inode.uid;
+            this.cowextsize = inode.size;
+            for (const name of Object.keys(InodeFlags)) {
+                if (!(inode.flags & InodeFlags[name]))
+                    continue;
+                if (name in XFlag)
+                    this.xflags |= XFlag[name];
+            }
+        }
+    };
+    __setFunctionName(_classThis, "fsxattr");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        _xflags_decorators = [(_a = t).uint32.bind(_a)];
+        _extsize_decorators = [(_b = t).uint32.bind(_b)];
+        _nextents_decorators = [(_c = t).uint32.bind(_c)];
+        _projid_decorators = [(_d = t).uint32.bind(_d)];
+        _cowextsize_decorators = [(_e = t).uint32.bind(_e)];
+        _pad_decorators = [t.char(8)];
+        __esDecorate(null, null, _xflags_decorators, { kind: "field", name: "xflags", static: false, private: false, access: { has: obj => "xflags" in obj, get: obj => obj.xflags, set: (obj, value) => { obj.xflags = value; } }, metadata: _metadata }, _xflags_initializers, _xflags_extraInitializers);
+        __esDecorate(null, null, _extsize_decorators, { kind: "field", name: "extsize", static: false, private: false, access: { has: obj => "extsize" in obj, get: obj => obj.extsize, set: (obj, value) => { obj.extsize = value; } }, metadata: _metadata }, _extsize_initializers, _extsize_extraInitializers);
+        __esDecorate(null, null, _nextents_decorators, { kind: "field", name: "nextents", static: false, private: false, access: { has: obj => "nextents" in obj, get: obj => obj.nextents, set: (obj, value) => { obj.nextents = value; } }, metadata: _metadata }, _nextents_initializers, _nextents_extraInitializers);
+        __esDecorate(null, null, _projid_decorators, { kind: "field", name: "projid", static: false, private: false, access: { has: obj => "projid" in obj, get: obj => obj.projid, set: (obj, value) => { obj.projid = value; } }, metadata: _metadata }, _projid_initializers, _projid_extraInitializers);
+        __esDecorate(null, null, _cowextsize_decorators, { kind: "field", name: "cowextsize", static: false, private: false, access: { has: obj => "cowextsize" in obj, get: obj => obj.cowextsize, set: (obj, value) => { obj.cowextsize = value; } }, metadata: _metadata }, _cowextsize_initializers, _cowextsize_extraInitializers);
+        __esDecorate(null, null, _pad_decorators, { kind: "field", name: "pad", static: false, private: false, access: { has: obj => "pad" in obj, get: obj => obj.pad, set: (obj, value) => { obj.pad = value; } }, metadata: _metadata }, _pad_initializers, _pad_extraInitializers);
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        fsxattr = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return fsxattr = _classThis;
+})();
+/**
+ * `FS_IOC_*` commands for {@link ioctl | `ioctl`}
+ * @remarks
+ * These are computed from a script since constant values are needed for enum member types
+ */
+export var IOC;
+(function (IOC) {
+    IOC[IOC["GetFlags"] = 2148034049] = "GetFlags";
+    IOC[IOC["SetFlags"] = 1074292226] = "SetFlags";
+    IOC[IOC["GetVersion"] = 2148038145] = "GetVersion";
+    IOC[IOC["SetVersion"] = 1074296322] = "SetVersion";
+    IOC[IOC["Fiemap"] = 3223348747] = "Fiemap";
+    IOC[IOC["GetXattr"] = 2149341215] = "GetXattr";
+    IOC[IOC["SetXattr"] = 1075599392] = "SetXattr";
+    IOC[IOC["GetLabel"] = 2164298801] = "GetLabel";
+    IOC[IOC["SetLabel"] = 1090556978] = "SetLabel";
+    IOC[IOC["GetUUID"] = 2148603136] = "GetUUID";
+    IOC[IOC["GetSysfsPath"] = 2155943169] = "GetSysfsPath";
+})(IOC || (IOC = {}));
+/**
+ * `FS_IOC32_*` commands for {@link ioctl | `ioctl`}
+ * @remarks
+ * These are computed from a script since constant values are needed for enum member types
+ */
+export var IOC32;
+(function (IOC32) {
+    IOC32[IOC32["GetFlags"] = 2147771905] = "GetFlags";
+    IOC32[IOC32["SetFlags"] = 1074030082] = "SetFlags";
+    IOC32[IOC32["GetVersion"] = 2147776001] = "GetVersion";
+    IOC32[IOC32["SetVersion"] = 1074034178] = "SetVersion";
+})(IOC32 || (IOC32 = {}));
+/** Perform an `ioctl` on a file or file system. */
+export async function ioctl(
+/** The path to the file or file system to perform the `ioctl` on */
+path, 
+/** The command to perform (uint32) */
+command, 
+/** The arguments to pass to the command */
+...args) {
+    path = normalizePath(path);
+    const { fs, path: resolved } = resolveMount(path, this);
+    try {
+        const inode = new Inode(await fs.stat(resolved));
+        switch (command) {
+            case IOC.GetFlags:
+            case IOC32.GetFlags:
+                return inode.flags;
+            case IOC.SetFlags:
+            case IOC32.SetFlags:
+                inode.flags = args[0];
+                await fs.touch(resolved, inode);
+                return undefined;
+            case IOC.GetVersion:
+            case IOC32.GetVersion:
+                return inode.version;
+            case IOC.SetVersion:
+            case IOC32.SetVersion:
+                inode.version = args[0];
+                await fs.touch(resolved, inode);
+                return undefined;
+            case IOC.Fiemap:
+                break;
+            case IOC.GetXattr:
+                return new fsxattr(inode);
+            case IOC.SetXattr:
+                break;
+            case IOC.GetLabel:
+                return fs.label;
+            case IOC.SetLabel:
+                fs.label = args[0];
+                return undefined;
+            case IOC.GetUUID:
+                return fs.uuid;
+            case IOC.GetSysfsPath:
+                /**
+                 * Returns the path component under /sys/fs/ that refers to this filesystem;
+                 * also /sys/kernel/debug/ for filesystems with debugfs exports
+                 * @todo Implement sysfs and have each FS implement the /sys/fs/<name> tree
+                 */
+                return `/sys/fs/${fs.name}/${fs.uuid}`;
+        }
+    }
+    catch (e) {
+        throw fixError(e, { [resolved]: path });
+    }
+    throw new ErrnoError(Errno.ENOTSUP, 'Unsupported command: ' + command, path, 'ioctl');
+}
+/** Perform an `ioctl` on a file or file system */
+export function ioctlSync(
+/** The path to the file or file system to perform the `ioctl` on */
+path, 
+/** The command to perform (uint32) */
+command, 
+/** The arguments to pass to the command */
+...args) {
+    path = normalizePath(path);
+    const { fs, path: resolved } = resolveMount(path, this);
+    try {
+        const inode = new Inode(fs.statSync(resolved));
+        switch (command) {
+            case IOC.GetFlags:
+            case IOC32.GetFlags:
+                return inode.flags;
+            case IOC.SetFlags:
+            case IOC32.SetFlags:
+                inode.flags = args[0];
+                fs.touchSync(resolved, inode);
+                return undefined;
+            case IOC.GetVersion:
+            case IOC32.GetVersion:
+                return inode.version;
+            case IOC.SetVersion:
+            case IOC32.SetVersion:
+                inode.version = args[0];
+                fs.touchSync(resolved, inode);
+                return undefined;
+            case IOC.Fiemap:
+                break;
+            case IOC.GetXattr:
+                return new fsxattr(inode);
+            case IOC.SetXattr:
+                break;
+            case IOC.GetLabel:
+                return fs.label;
+            case IOC.SetLabel:
+                fs.label = args[0];
+                return undefined;
+            case IOC.GetUUID:
+                return fs.uuid;
+            case IOC.GetSysfsPath:
+                /**
+                 * Returns the path component under /sys/fs/ that refers to this filesystem;
+                 * also /sys/kernel/debug/ for filesystems with debugfs exports
+                 * @todo Implement sysfs and have each FS implement the /sys/fs/<name> tree
+                 */
+                return `/sys/fs/${fs.name}/${fs.uuid}`;
+        }
+    }
+    catch (e) {
+        throw fixError(e, { [resolved]: path });
+    }
+    throw new ErrnoError(Errno.ENOTSUP, 'Unsupported command: ' + command, path, 'ioctl');
+}

package/dist/vfs/promises.d.ts

@@ -1,30 +1,57 @@
 import type * as fs from 'node:fs';
 import type * as promises from 'node:fs/promises';
-import type { Interface as ReadlineInterface } from 'node:readline';
 import type { Stream } from 'node:stream';
 import type { ReadableStream as NodeReadableStream } from 'node:stream/web';
 import type { V_Context } from '../context.js';
-import type { File } from '../internal/file.js';
-import type { Stats } from '../stats.js';
+import type { FileSystem, StreamOptions } from '../internal/filesystem.js';
+import type { InodeLike } from '../internal/inode.js';
+import type { Interface as ReadlineInterface } from '../readline.js';
 import type { FileContents, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
 import { Buffer } from 'buffer';
 import '../polyfills.js';
-import { BigIntStats } from '../stats.js';
 import { Dir, Dirent } from './dir.js';
+import { BigIntStats, Stats } from './stats.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
 export declare class FileHandle implements promises.FileHandle {
-    protected context?: V_Context | undefined;
+    protected context: V_Context;
+    readonly fd: number;
+    protected _buffer?: Uint8Array;
     /**
-     * The file descriptor for this file handle.
+     * Current position
      */
-    readonly fd: number;
+    protected _position: number;
     /**
-     * @internal
-     * The file for this file handle
+     * Get the current file position.
+     *
+     * We emulate the following bug mentioned in the Node documentation:
+     *
+     * On Linux, positional writes don't work when the file is opened in append mode.
+     * The kernel ignores the position argument and always appends the data to the end of the file.
+     * @returns The current file position.
+     */
+    get position(): number;
+    set position(value: number);
+    /**
+     * Whether the file has changes which have not been written to the FS
      */
-    readonly file: File;
-    constructor(fdOrFile: number | File, context?: V_Context | undefined);
+    protected dirty: boolean;
+    /**
+     * Whether the file is open or closed
+     */
+    protected closed: boolean;
+    /** The path relative to the context's root */
+    readonly path: string;
+    /** The internal FS associated with the handle */
+    protected readonly fs: FileSystem;
+    /** The path relative to the `FileSystem`'s root */
+    readonly internalPath: string;
+    /** The flag the handle was opened with */
+    readonly flag: number;
+    /** Stats for the handle */
+    readonly inode: InodeLike;
+    constructor(context: V_Context, fd: number);
+    private get _isSync();
     private _emitChange;
     /**
      * Asynchronous fchown(2) - Change ownership of a file.
@@ -47,7 +74,7 @@ export declare class FileHandle implements promises.FileHandle {
      * Asynchronous ftruncate(2) - Truncate a file to a specified length.
      * @param length If not specified, defaults to `0`.
      */
-    truncate(length?: number | null): Promise<void>;
+    truncate(length?: number): Promise<void>;
     /**
      * Asynchronously change file timestamps of the file.
      * @param atime The last access time. If a string is provided, it will be coerced to number.
@@ -64,6 +91,18 @@ export declare class FileHandle implements promises.FileHandle {
      * - `flag` defaults to `'a'`.
      */
     appendFile(data: string | Uint8Array, _options?: (fs.ObjectEncodingOptions & promises.FlagAndOpenMode) | BufferEncoding): Promise<void>;
+    /**
+     * Read data from the file.
+     * @param buffer The buffer that the data will be written to.
+     * @param offset The offset within the buffer where writing will start.
+     * @param length An integer specifying the number of bytes to read.
+     * @param position An integer specifying where to begin reading from in the file.
+     * If position is unset, data will be read from the current file position.
+     */
+    protected _read<TBuffer extends ArrayBufferView>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<{
+        bytesRead: number;
+        buffer: TBuffer;
+    }>;
     /**
      * Asynchronously reads data from the file.
      * The `FileHandle` must have been opened for reading.
@@ -89,9 +128,19 @@ export declare class FileHandle implements promises.FileHandle {
      * Read file data using a `ReadableStream`.
      * The handle will not be closed automatically.
      */
-    readableWebStream(options?: promises.ReadableWebStreamOptions): NodeReadableStream<Uint8Array>;
+    readableWebStream(options?: promises.ReadableWebStreamOptions & StreamOptions): NodeReadableStream<Uint8Array>;
+    /**
+     * Not part of the Node.js API!
+     *
+     * Write file data using a `WritableStream`.
+     * The handle will not be closed automatically.
+     * @internal
+     */
+    writableWebStream(options?: promises.ReadableWebStreamOptions & StreamOptions): WritableStream;
     /**
-     * @todo Implement
+     * Creates a readline Interface object that allows reading the file line by line
+     * @param options Options for creating a read stream
+     * @returns A readline interface for reading the file line by line
      */
     readLines(options?: promises.CreateReadStreamOptions): ReadlineInterface;
     [Symbol.asyncDispose](): Promise<void>;
@@ -102,6 +151,15 @@ export declare class FileHandle implements promises.FileHandle {
     stat(opts?: fs.StatOptions & {
         bigint?: false;
     }): Promise<Stats>;
+    /**
+     * Write buffer to the file.
+     * @param buffer Uint8Array containing the data to write to the file.
+     * @param offset Offset in the buffer to start reading data from.
+     * @param length The amount of bytes to write to the file.
+     * @param position Offset from the beginning of the file where this data should be written.
+     * If position is null, the data will be written at  the current position.
+     */
+    protected _write(buffer: Uint8Array, offset?: number, length?: number, position?: number): Promise<number>;
     /**
      * Asynchronously writes `string` to the file.
      * The `FileHandle` must have been opened for writing.
@@ -131,6 +189,10 @@ export declare class FileHandle implements promises.FileHandle {
      * Asynchronous close(2) - close a `FileHandle`.
      */
     close(): Promise<void>;
+    /**
+     * Cleans up. This will *not* sync the file data to the FS
+     */
+    protected dispose(force?: boolean): void;
     /**
      * Asynchronous `writev`. Writes from multiple buffers.
      * @param buffers An array of Uint8Array buffers.
@@ -181,8 +243,8 @@ export declare function truncate(this: V_Context, path: fs.PathLike, len?: numbe
 export declare function unlink(this: V_Context, path: fs.PathLike): Promise<void>;
 /**
  * Asynchronous file open.
- * @see http://www.manpagez.com/man/2/open/
- * @param flag Handles the complexity of the various file modes. See its API for more details.
+ * @see https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
+ * @param flag {@link https://nodejs.org/api/fs.html#file-system-flags}
  * @param mode Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.
  */
 export declare function open(this: V_Context, path: fs.PathLike, flag?: fs.OpenMode, mode?: fs.Mode): Promise<FileHandle>;