| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- /* Virtual filesystem: filesystems mounted under `/`. Two implementations:
- * FAT on block devices (probed by vfs_mount_all) and the read-only ramfs
- * backed by the command pack (ramfs.c, mounted at /ramfs). */
- #ifndef VFS_H
- #define VFS_H
- #include "blkdev.h"
- #include "fat.h"
- /* Largest file the shell will load from a filesystem into a kernel buffer.
- * The buffer is allocated from the kernel heap (not a static BSS array), so a
- * large ELF on a FAT mount can be spawned without moving the low-memory wall. */
- #define VFS_FILE_MAX (2u * 1024u * 1024u)
- struct vfs_mount;
- struct fs_ops;
- struct vfs_file {
- const void *data;
- unsigned int size;
- };
- /* One directory entry. `name` is the raw 8.3 field for FAT (space padded,
- * `raw_83` set) or the plain file name for the name-string filesystems. */
- struct vfs_dirent {
- char name[64];
- unsigned int size;
- unsigned int is_dir;
- unsigned int raw_83;
- };
- /* Per-filesystem error codes (0 = success; the read/list calls additionally
- * return positive byte/entry counts). Mapped to SYS_E* by sys_fs.c. */
- #define VFS_EIO (-1)
- #define VFS_ENOENT (-2)
- #define VFS_EINVAL (-3)
- #define VFS_EROFS (-4)
- #define VFS_ENOSPC (-5)
- /* Per-filesystem operations. Paths are relative to the mount (no leading
- * '/'); "" is the mount root. Implementations never print; list_dir returns
- * 1 (entry filled), 0 (end) or a negative VFS_E*. */
- struct fs_ops {
- int raw_83; /* dirent names are raw 8.3 (FAT) and need display fixing */
- int (*read_file)(struct vfs_mount *m, const char *path,
- void *buf, unsigned int max);
- int (*load_file)(struct vfs_mount *m, const char *path,
- struct vfs_file *out);
- void (*release_file)(struct vfs_mount *m, struct vfs_file *f);
- int (*stat)(struct vfs_mount *m, const char *path,
- unsigned int *size, int *is_dir);
- int (*write_file)(struct vfs_mount *m, const char *path,
- const void *buf, unsigned int len);
- int (*unlink)(struct vfs_mount *m, const char *path);
- int (*mkdir)(struct vfs_mount *m, const char *path);
- int (*rmdir)(struct vfs_mount *m, const char *path);
- int (*list_dir)(struct vfs_mount *m, const char *path,
- unsigned int index, struct vfs_dirent *out);
- };
- typedef struct vfs_mount {
- char name[16];
- const struct fs_ops *ops;
- int mounted;
- int ro;
- fat_fs_t fs; /* FAT mounts only */
- unsigned int total_sectors; /* for the mount listing */
- char type[8]; /* "FAT12"/"FAT16"/"FAT32"/"ramfs" */
- char label[12];
- } vfs_mount_t;
- #define VFS_MAX_MOUNTS 24
- #define VFS_PATH_MAX 64
- extern vfs_mount_t vfs_mounts[VFS_MAX_MOUNTS];
- extern unsigned int vfs_mount_count;
- /* Scan devices and mount all detected FAT filesystems. The ramfs/share
- * mounts are kept available throughout the scan; file syscalls that run on
- * another CPU wait until it completes (see vfs_scan_busy). */
- void vfs_mount_all(void);
- /* Re-mount only one block device after it was formatted. */
- void vfs_remount_device(blk_dev_t *d);
- /* Set while vfs_mount_all() owns the mount table and the FAT sector buffer.
- * sys_fs.c waits for it; the owner (the calling `storage` syscall) is exempt. */
- extern volatile int vfs_scan_busy;
- extern volatile unsigned int vfs_scan_owner_pid;
- /* Mount the command pack (ramfs) at /ramfs; no-op when no pack is loaded. */
- void vfs_mount_ramfs(void);
- /* Mount the writable in-memory /share store (no-op if it cannot be set up). */
- void vfs_mount_share(void);
- /* Update the ramfs mount's reported size after ramfs_replace(). */
- void vfs_refresh_ramfs(void);
- /* Find a mount by name (NULL if not found). */
- vfs_mount_t *vfs_find(const char *name);
- /* Print the mount list (for `ls /`). */
- void vfs_list_root(void);
- /* Resolve an absolute path "/<mount>/<path>" into the mount and a normalized
- * path relative to it ("" for the mount root) in the caller's buffer. `.`
- * components are dropped, repeated slashes collapsed and a trailing slash
- * removed, so directory paths from Tab completion ("/ramfs/bin/") work.
- * Returns 0 or -1 (bad path / unknown mount). */
- int vfs_resolve(const char *path, struct vfs_mount **m,
- char *rel_path, unsigned int rel_size);
- /* Load a whole file (borrowed pointer for ramfs, the static buffer for FAT);
- * release it with vfs_release_file() after use. */
- int vfs_load_file(const char *path, struct vfs_file *out,
- struct vfs_mount **m_out);
- void vfs_release_file(struct vfs_mount *m, struct vfs_file *f);
- /* Convenience wrappers for the shell and completion. */
- int vfs_stat(const char *path, unsigned int *size, int *is_dir);
- int vfs_list_dir(const char *path, unsigned int index, struct vfs_dirent *out);
- /* Join `arg` onto `cwd` (arg may be absolute or relative) and normalize the
- * result into `out` as an absolute VFS path. "." and duplicate slashes are
- * dropped; ".." pops the previous component (popping the mount name yields
- * "/", and ".." at "/" stays "/"). Returns 0 on success, -1 if it doesn't fit. */
- int vfs_join_path(const char *cwd, const char *arg, char *out, unsigned int out_size);
- /* After a failed vfs_resolve, returns 1 if the path's first component names a
- * known block device (i.e. it exists but has no mounted filesystem). */
- int vfs_device_known(const char *path);
- /* 1 when the mount is backed by a block device (the FAT driver), 0 for the
- * RAM-backed ramfs/share mounts. The file service uses this to block only
- * disk filesystems while a destructive format is running. */
- int vfs_mount_is_disk(const vfs_mount_t *m);
- #endif
|