@zenfs/core 1.3.6 → 1.4.0

package/src/backends/store/simple.ts

@@ -1,154 +0,0 @@
-import { SyncTransaction, type Store } from './store.js';
-
-/**
- * An interface for simple synchronous stores that don't have special support for transactions and such.
- */
-export interface SimpleSyncStore extends Store {
-	keys(): Iterable<bigint>;
-	get(id: bigint): Uint8Array | undefined;
-	set(id: bigint, data: Uint8Array): void;
-	delete(id: bigint): void;
-}
-
-/**
- * An interface for simple asynchronous stores that don't have special support for transactions and such.
- * This class adds caching at the store level.
- */
-export abstract class SimpleAsyncStore implements SimpleSyncStore {
-	public abstract name: string;
-
-	protected cache: Map<bigint, Uint8Array> = new Map();
-
-	protected queue: Set<Promise<unknown>> = new Set();
-
-	protected abstract entries(): Promise<Iterable<[bigint, Uint8Array]>>;
-
-	public keys(): Iterable<bigint> {
-		return this.cache.keys();
-	}
-
-	public get(id: bigint): Uint8Array | undefined {
-		return this.cache.get(id);
-	}
-
-	public set(id: bigint, data: Uint8Array): void {
-		this.cache.set(id, data);
-		this.queue.add(this._set(id, data));
-	}
-
-	protected abstract _set(ino: bigint, data: Uint8Array): Promise<void>;
-
-	public delete(id: bigint): void {
-		this.cache.delete(id);
-		this.queue.add(this._delete(id));
-	}
-
-	protected abstract _delete(ino: bigint): Promise<void>;
-
-	public clearSync(): void {
-		this.cache.clear();
-		this.queue.add(this.clear());
-	}
-
-	public abstract clear(): Promise<void>;
-
-	public async sync(): Promise<void> {
-		for (const [ino, data] of await this.entries()) {
-			if (!this.cache.has(ino)) {
-				this.cache.set(ino, data);
-			}
-		}
-		for (const promise of this.queue) {
-			await promise;
-		}
-	}
-
-	public transaction(): SimpleTransaction {
-		return new SimpleTransaction(this);
-	}
-}
-
-/**
- * Transaction for simple stores.
- * @see SimpleSyncStore
- * @see SimpleAsyncStore
- */
-export class SimpleTransaction extends SyncTransaction<SimpleSyncStore> {
-	/**
-	 * Stores data in the keys we modify prior to modifying them.
-	 * Allows us to roll back commits.
-	 */
-	protected originalData: Map<bigint, Uint8Array | void> = new Map();
-	/**
-	 * List of keys modified in this transaction, if any.
-	 */
-	protected modifiedKeys: Set<bigint> = new Set();
-
-	protected declare store: SimpleSyncStore;
-
-	public keysSync(): Iterable<bigint> {
-		return this.store.keys();
-	}
-
-	public getSync(id: bigint): Uint8Array {
-		const val = this.store.get(id);
-		this.stashOldValue(id, val);
-		return val!;
-	}
-
-	public setSync(id: bigint, data: Uint8Array): void {
-		this.markModified(id);
-		return this.store.set(id, data);
-	}
-
-	public removeSync(id: bigint): void {
-		this.markModified(id);
-		this.store.delete(id);
-	}
-
-	public commitSync(): void {
-		this.done = true;
-	}
-
-	public abortSync(): void {
-		if (!this.done) {
-			return;
-		}
-		// Rollback old values.
-		for (const key of this.modifiedKeys) {
-			const value = this.originalData.get(key);
-			if (!value) {
-				// Key didn't exist.
-				this.store.delete(key);
-			} else {
-				// Key existed. Store old value.
-				this.store.set(key, value);
-			}
-		}
-		this.done = true;
-	}
-
-	/**
-	 * Stashes given key value pair into `originalData` if it doesn't already
-	 * exist. Allows us to stash values the program is requesting anyway to
-	 * prevent needless `get` requests if the program modifies the data later
-	 * on during the transaction.
-	 */
-	protected stashOldValue(id: bigint, value?: Uint8Array): void {
-		// Keep only the earliest value in the transaction.
-		if (!this.originalData.has(id)) {
-			this.originalData.set(id, value);
-		}
-	}
-
-	/**
-	 * Marks `ino` as modified, and stashes its value if it has not been
-	 * stashed already.
-	 */
-	protected markModified(id: bigint): void {
-		this.modifiedKeys.add(id);
-		if (!this.originalData.has(id)) {
-			this.originalData.set(id, this.store.get(id));
-		}
-	}
-}

package/src/backends/store/store.ts

@@ -1,189 +0,0 @@
-import { ErrnoError } from '../../error.js';
-import '../../polyfills.js';
-
-/**
- * Represents a key-value store.
- */
-export interface Store {
-	/**
-	 * The name of the store.
-	 */
-	readonly name: string;
-
-	/**
-	 * Syncs the store
-	 */
-	sync(): Promise<void>;
-
-	/**
-	 * Empties the store completely.
-	 */
-	clear(): Promise<void> | void;
-
-	/**
-	 * Empties the store completely.
-	 */
-	clearSync(): void;
-
-	/**
-	 * Begins a new transaction.
-	 */
-	transaction(): Transaction;
-}
-
-/**
- * A transaction for a store.
- */
-export abstract class Transaction<T extends Store = Store> {
-	public constructor(protected store: T) {}
-
-	/**
-	 * Whether the transaction was committed or aborted
-	 */
-	protected done: boolean = false;
-
-	/**
-	 * Gets all of the keys
-	 */
-	public abstract keys(): Promise<Iterable<bigint>>;
-
-	/**
-	 * Gets all of the keys
-	 */
-	public abstract keysSync(): Iterable<bigint>;
-
-	/**
-	 * Retrieves data.
-	 * @param id The key to look under for data.
-	 */
-	public abstract get(id: bigint): Promise<Uint8Array>;
-
-	/**
-	 * Retrieves data.
-	 * Throws an error if an error occurs or if the key does not exist.
-	 * @param id The key to look under for data.
-	 * @return The data stored under the key, or undefined if not present.
-	 */
-	public abstract getSync(id: bigint): Uint8Array;
-
-	/**
-	 * Adds the data to the store under an id. Overwrites any existing data.
-	 * @param id The key to add the data under.
-	 * @param data The data to add to the store.
-	 */
-	public abstract set(id: bigint, data: Uint8Array): Promise<void>;
-
-	/**
-	 * Adds the data to the store under and id.
-	 * @param id The key to add the data under.
-	 * @param data The data to add to the store.
-	 */
-	public abstract setSync(id: bigint, data: Uint8Array): void;
-
-	/**
-	 * Deletes the data at `ino`.
-	 * @param id The key to delete from the store.
-	 */
-	public abstract remove(id: bigint): Promise<void>;
-
-	/**
-	 * Deletes the data at `ino`.
-	 * @param id The key to delete from the store.
-	 */
-	public abstract removeSync(id: bigint): void;
-
-	/**
-	 * Commits the transaction.
-	 */
-	public abstract commit(): Promise<void>;
-
-	public async [Symbol.asyncDispose]() {
-		if (this.done) {
-			return;
-		}
-
-		await this.abort();
-	}
-
-	/**
-	 * Commits the transaction.
-	 */
-	public abstract commitSync(): void;
-
-	public [Symbol.dispose]() {
-		if (this.done) {
-			return;
-		}
-
-		this.abortSync();
-	}
-
-	/**
-	 * Aborts and rolls back the transaction.
-	 */
-	public abstract abort(): Promise<void>;
-
-	/**
-	 * Aborts and rolls back the transaction.
-	 */
-	public abstract abortSync(): void;
-}
-
-/**
- * Transaction that implements asynchronous operations with synchronous ones
- */
-export abstract class SyncTransaction<T extends Store = Store> extends Transaction<T> {
-	/* eslint-disable @typescript-eslint/require-await */
-	public async keys(): Promise<Iterable<bigint>> {
-		return this.keysSync();
-	}
-	public async get(id: bigint): Promise<Uint8Array> {
-		return this.getSync(id);
-	}
-
-	public async set(id: bigint, data: Uint8Array): Promise<void> {
-		return this.setSync(id, data);
-	}
-
-	public async remove(id: bigint): Promise<void> {
-		return this.removeSync(id);
-	}
-
-	public async commit(): Promise<void> {
-		return this.commitSync();
-	}
-
-	public async abort(): Promise<void> {
-		return this.abortSync();
-	}
-	/* eslint-enable @typescript-eslint/require-await */
-}
-
-/**
- * Transaction that only supports asynchronous operations
- */
-export abstract class AsyncTransaction<T extends Store = Store> extends Transaction<T> {
-	public keysSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.keysSync');
-	}
-
-	public getSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.getSync');
-	}
-
-	public setSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.setSync');
-	}
-
-	public removeSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.removeSync');
-	}
-
-	public commitSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.commitSync');
-	}
-
-	public abortSync(): never {
-		throw ErrnoError.With('ENOSYS', undefined, 'AsyncTransaction.abortSync');
-	}
-}

package/src/config.ts

@@ -1,227 +0,0 @@
-import type { Backend, BackendConfiguration, FilesystemOf, SharedConfig } from './backends/backend.js';
-import { checkOptions, isBackend, isBackendConfig } from './backends/backend.js';
-import { useCredentials } from './credentials.js';
-import { DeviceFS } from './devices.js';
-import * as cache from './emulation/cache.js';
-import { config } from './emulation/config.js';
-import * as fs from './emulation/index.js';
-import { Errno, ErrnoError } from './error.js';
-import { FileSystem } from './filesystem.js';
-
-/**
- * Configuration for a specific mount point
- */
-export type MountConfiguration<T extends Backend> = FilesystemOf<T> | BackendConfiguration<T> | T;
-
-function isMountConfig<T extends Backend>(arg: unknown): arg is MountConfiguration<T> {
-	return isBackendConfig(arg) || isBackend(arg) || arg instanceof FileSystem;
-}
-
-/**
- * Retrieve a file system with `configuration`.
- * @see MountConfiguration
- */
-export async function resolveMountConfig<T extends Backend>(configuration: MountConfiguration<T>, _depth = 0): Promise<FilesystemOf<T>> {
-	if (typeof configuration !== 'object' || configuration == null) {
-		throw new ErrnoError(Errno.EINVAL, 'Invalid options on mount configuration');
-	}
-
-	if (!isMountConfig(configuration)) {
-		throw new ErrnoError(Errno.EINVAL, 'Invalid mount configuration');
-	}
-
-	if (configuration instanceof FileSystem) {
-		await configuration.ready();
-		return configuration;
-	}
-
-	if (isBackend(configuration)) {
-		configuration = { backend: configuration } as BackendConfiguration<T>;
-	}
-
-	for (const [key, value] of Object.entries(configuration)) {
-		if (key == 'backend') {
-			continue;
-		}
-
-		if (!isMountConfig(value)) {
-			continue;
-		}
-
-		if (_depth > 10) {
-			throw new ErrnoError(Errno.EINVAL, 'Invalid configuration, too deep and possibly infinite');
-		}
-
-		(configuration as Record<string, FileSystem>)[key] = await resolveMountConfig(value, ++_depth);
-	}
-
-	const { backend } = configuration;
-
-	if (!(await backend.isAvailable())) {
-		throw new ErrnoError(Errno.EPERM, 'Backend not available: ' + backend.name);
-	}
-	await checkOptions(backend, configuration);
-	const mount = (await backend.create(configuration)) as FilesystemOf<T>;
-	mount._disableSync = configuration.disableAsyncCache || false;
-	await mount.ready();
-	return mount;
-}
-
-/**
- * An object mapping mount points to backends
- */
-export interface ConfigMounts {
-	[K: string]: Backend;
-}
-
-/**
- * Configuration
- */
-export interface Configuration<T extends ConfigMounts> extends SharedConfig {
-	/**
-	 * An object mapping mount points to mount configuration
-	 */
-	mounts: { [K in keyof T]: MountConfiguration<T[K]> };
-
-	/**
-	 * The uid to use
-	 * @default 0
-	 */
-	uid: number;
-
-	/**
-	 * The gid to use
-	 * @default 0
-	 */
-	gid: number;
-
-	/**
-	 * Whether to automatically add normal Linux devices
-	 * @experimental
-	 * @default false
-	 */
-	addDevices: boolean;
-
-	/**
-	 * If true, enables caching stats for certain operations.
-	 * This should reduce the number of stat calls performed.
-	 * @experimental
-	 * @default false
-	 */
-	cacheStats: boolean;
-
-	/**
-	 * If true, enables caching realpath output
-	 *
-	 * This can increase performance.
-	 * @experimental
-	 * @default false
-	 */
-	cachePaths: boolean;
-
-	/**
-	 * If true, disables *all* permissions checking.
-	 *
-	 * This can increase performance.
-	 * @experimental
-	 * @default false
-	 */
-	disableAccessChecks: boolean;
-
-	/**
-	 * If true, disables `read` and `readSync` from updating the atime.
-	 *
-	 * This can increase performance.
-	 * @experimental
-	 * @default false
-	 */
-	disableUpdateOnRead: boolean;
-
-	/**
-	 * If true, files will only sync to the file system when closed.
-	 *
-	 * This can increase performance.
-	 * @experimental
-	 * @overrides `disableUpdateOnRead`
-	 * @default false
-	 */
-	onlySyncOnClose: boolean;
-}
-
-/**
- * Configures ZenFS with single mount point /
- */
-export async function configureSingle<T extends Backend>(configuration: MountConfiguration<T>): Promise<void> {
-	if (!isBackendConfig(configuration)) {
-		throw new TypeError('Invalid single mount point configuration');
-	}
-
-	const resolved = await resolveMountConfig(configuration);
-	fs.umount('/');
-	fs.mount('/', resolved);
-}
-
-/**
- * Like `fs.mount`, but it also creates missing directories.
- * @privateRemarks
- * This is implemented as a separate function to avoid a circular dependency between emulation/shared.ts and other emulation layer files.
- * @internal
- */
-async function mount(path: string, mount: FileSystem): Promise<void> {
-	if (path == '/') {
-		fs.mount(path, mount);
-		return;
-	}
-
-	const stats = await fs.promises.stat(path).catch(() => null);
-	if (!stats) {
-		await fs.promises.mkdir(path, { recursive: true });
-	} else if (!stats.isDirectory()) {
-		throw ErrnoError.With('ENOTDIR', path, 'configure');
-	}
-	fs.mount(path, mount);
-}
-
-/**
- * Configures ZenFS with `configuration`
- * @see Configuration
- */
-export async function configure<T extends ConfigMounts>(configuration: Partial<Configuration<T>>): Promise<void> {
-	const uid = 'uid' in configuration ? configuration.uid || 0 : 0;
-	const gid = 'gid' in configuration ? configuration.gid || 0 : 0;
-
-	useCredentials({ uid, gid });
-
-	cache.stats.isEnabled = configuration.cacheStats ?? false;
-	cache.paths.isEnabled = configuration.cachePaths ?? false;
-	config.checkAccess = !configuration.disableAccessChecks;
-	config.updateOnRead = !configuration.disableUpdateOnRead;
-	config.syncImmediately = !configuration.onlySyncOnClose;
-
-	if (configuration.mounts) {
-		const toMount: [string, FileSystem][] = [];
-		let unmountRoot = false;
-
-		for (const [_point, mountConfig] of Object.entries(configuration.mounts)) {
-			const point = _point.startsWith('/') ? _point : '/' + _point;
-
-			if (isBackendConfig(mountConfig)) {
-				mountConfig.disableAsyncCache ??= configuration.disableAsyncCache || false;
-			}
-
-			if (point == '/') unmountRoot = true;
-			toMount.push([point, await resolveMountConfig(mountConfig)]);
-		}
-
-		if (unmountRoot) fs.umount('/');
-
-		await Promise.all(toMount.map(([point, fs]) => mount(point, fs)));
-	}
-
-	if (configuration.addDevices) {
-		const devfs = new DeviceFS();
-		devfs.addDefaults();
-		await devfs.ready();
-		await mount('/dev', devfs);
-	}
-}

package/src/credentials.ts

@@ -1,49 +0,0 @@
-/**
- * Credentials used for various operations.
- * Similar to Linux's cred struct.
- * @see https://github.com/torvalds/linux/blob/master/include/linux/cred.h
- */
-export interface Credentials {
-	uid: number;
-	gid: number;
-	suid: number;
-	sgid: number;
-	euid: number;
-	egid: number;
-	/**
-	 * List of group IDs.
-	 */
-	groups: number[];
-}
-
-export const credentials: Credentials = {
-	uid: 0,
-	gid: 0,
-	suid: 0,
-	sgid: 0,
-	euid: 0,
-	egid: 0,
-	groups: [],
-};
-
-export interface CredentialInit {
-	uid: number;
-	gid: number;
-	suid?: number;
-	sgid?: number;
-	euid?: number;
-	egid?: number;
-}
-
-/**
- * Uses credentials from the provided uid and gid.
- */
-export function useCredentials(source: CredentialInit): void {
-	Object.assign(credentials, {
-		suid: source.uid,
-		sgid: source.gid,
-		euid: source.uid,
-		egid: source.gid,
-		...source,
-	});
-}