3 * @author Lunaixsky (zelong56@gmail.com)
4 * @brief Lunaix virtual file system - an abstraction layer for all file system.
8 * @copyright Copyright (c) 2022
12 #include <klibc/string.h>
13 #include <lunaix/dirent.h>
14 #include <lunaix/foptions.h>
15 #include <lunaix/fs.h>
16 #include <lunaix/mm/cake.h>
17 #include <lunaix/mm/page.h>
18 #include <lunaix/mm/valloc.h>
19 #include <lunaix/process.h>
20 #include <lunaix/spike.h>
21 #include <lunaix/syscall.h>
23 #define PATH_DELIM '/'
24 #define DNODE_HASHTABLE_BITS 10
25 #define DNODE_HASHTABLE_SIZE (1 << DNODE_HASHTABLE_BITS)
26 #define DNODE_HASH_MASK (DNODE_HASHTABLE_SIZE - 1)
27 #define DNODE_HASHBITS (32 - DNODE_HASHTABLE_BITS)
29 static struct cake_pile* dnode_pile;
30 static struct cake_pile* inode_pile;
31 static struct cake_pile* file_pile;
32 static struct cake_pile* superblock_pile;
33 static struct cake_pile* fd_pile;
35 static struct v_superblock* root_sb;
36 static struct hbucket* dnode_cache;
40 struct hstr vfs_ddot = HSTR("..", 2);
41 struct hstr vfs_dot = HSTR(".", 1);
42 struct hstr vfs_empty = HSTR("", 0);
48 vfs_d_free(struct v_dnode* dnode);
54 vfs_sb_free(struct v_superblock* sb);
59 // 为他们专门创建一个蛋糕堆,而不使用valloc,这样我们可以最小化内碎片的产生
60 dnode_pile = cake_new_pile("dnode_cache", sizeof(struct v_dnode), 1, 0);
61 inode_pile = cake_new_pile("inode_cache", sizeof(struct v_inode), 1, 0);
62 file_pile = cake_new_pile("file_cache", sizeof(struct v_file), 1, 0);
63 fd_pile = cake_new_pile("fd_cache", sizeof(struct v_fd), 1, 0);
65 cake_new_pile("sb_cache", sizeof(struct v_superblock), 1, 0);
67 dnode_cache = vzalloc(DNODE_HASHTABLE_SIZE * sizeof(struct hbucket));
69 hstr_rehash(&vfs_ddot, HSTR_FULL_HASH);
70 hstr_rehash(&vfs_dot, HSTR_FULL_HASH);
72 // 创建一个根superblock,用来蕴含我们的根目录。
73 root_sb = vfs_sb_alloc();
74 root_sb->root = vfs_d_alloc();
75 root_sb->root->inode = vfs_i_alloc();
78 inline struct hbucket*
79 __dcache_get_bucket(struct v_dnode* parent, unsigned int hash)
81 // 与parent的指针值做加法,来减小碰撞的可能性。
82 hash += (uint32_t)parent;
84 hash = hash ^ (hash >> DNODE_HASHBITS);
85 return &dnode_cache[hash & DNODE_HASH_MASK];
89 vfs_dcache_lookup(struct v_dnode* parent, struct hstr* str)
91 if (!str->len || HSTR_EQ(str, &vfs_dot))
94 if (HSTR_EQ(str, &vfs_ddot)) {
95 return parent->parent ? parent->parent : parent;
98 struct hbucket* slot = __dcache_get_bucket(parent, str->hash);
100 struct v_dnode *pos, *n;
101 hashtable_bucket_foreach(slot, pos, n, hash_list)
103 if (pos->name.hash == str->hash) {
111 vfs_dcache_add(struct v_dnode* parent, struct v_dnode* dnode)
113 struct hbucket* bucket = __dcache_get_bucket(parent, dnode->name.hash);
114 hlist_add(&bucket->head, &dnode->hash_list);
118 __vfs_walk(struct v_dnode* start,
120 struct v_dnode** dentry,
121 struct hstr* component,
127 if (path[0] == PATH_DELIM || !start) {
128 if ((walk_options & VFS_WALK_FSRELATIVE) && start) {
129 start = start->super_block->root;
131 start = root_sb->root;
136 struct v_dnode* dnode;
137 struct v_dnode* current_level = start;
139 char name_content[VFS_NAME_MAXLEN];
140 struct hstr name = HSTR(name_content, 0);
142 char current = path[i++], lookahead;
144 lookahead = path[i++];
145 if (current != PATH_DELIM) {
146 if (j >= VFS_NAME_MAXLEN - 1) {
149 if (!VFS_VALID_CHAR(current)) {
152 name_content[j++] = current;
158 // handling cases like /^.*(\/+).*$/
159 if (lookahead == PATH_DELIM) {
165 hstr_rehash(&name, HSTR_FULL_HASH);
167 if (!lookahead && (walk_options & VFS_WALK_PARENT)) {
169 component->hash = name.hash;
171 strcpy(component->value, name_content);
176 dnode = vfs_dcache_lookup(current_level, &name);
179 dnode = vfs_d_alloc();
180 dnode->name = HHSTR(valloc(VFS_NAME_MAXLEN), j, name.hash);
182 strcpy(dnode->name.value, name_content);
185 current_level->inode->ops.dir_lookup(current_level->inode, dnode);
187 if (errno == ENOENT && (walk_options & VFS_WALK_MKPARENT)) {
188 if (!current_level->inode->ops.mkdir) {
191 errno = current_level->inode->ops.mkdir(
192 current_level->inode, dnode);
200 vfs_dcache_add(current_level, dnode);
202 dnode->parent = current_level;
203 llist_append(¤t_level->children, &dnode->siblings);
207 current_level = dnode;
212 *dentry = current_level;
216 vfree(dnode->name.value);
222 #define VFS_MAX_SYMLINK 16
225 vfs_walk(struct v_dnode* start,
227 struct v_dnode** dentry,
228 struct hstr* component,
231 struct v_dnode* interim;
232 char* pathname = path;
233 int errno = __vfs_walk(start, path, &interim, component, options);
237 if (counter >= VFS_MAX_SYMLINK) {
241 if ((interim->inode->itype & VFS_IFSYMLINK) &&
242 !(options & VFS_WALK_NOFOLLOW) &&
243 interim->inode->ops.read_symlink) {
244 errno = interim->inode->ops.read_symlink(interim->inode, &pathname);
251 errno = __vfs_walk(start, pathname, &interim, component, options);
255 *dentry = errno ? 0 : interim;
261 vfs_mount(const char* target, const char* fs_name, bdev_t device)
266 if (!(errno = vfs_walk(NULL, target, &mnt, NULL, 0))) {
267 errno = vfs_mount_at(fs_name, device, mnt);
274 vfs_unmount(const char* target)
279 if (!(errno = vfs_walk(NULL, target, &mnt, NULL, 0))) {
280 errno = vfs_unmount_at(mnt);
287 vfs_mount_at(const char* fs_name, bdev_t device, struct v_dnode* mnt_point)
289 struct filesystem* fs = fsm_get(fs_name);
292 struct v_superblock* sb = vfs_sb_alloc();
297 if (!(errno = fs->mount(sb, mnt_point))) {
299 sb->root = mnt_point;
300 mnt_point->super_block = sb;
301 llist_append(&root_sb->sb_list, &sb->sb_list);
308 vfs_unmount_at(struct v_dnode* mnt_point)
311 struct v_superblock* sb = mnt_point->super_block;
315 if (!(errno = sb->fs->unmount(sb))) {
316 struct v_dnode* fs_root = sb->root;
317 llist_delete(&fs_root->siblings);
318 llist_delete(&sb->sb_list);
325 vfs_open(struct v_dnode* dnode, struct v_file** file)
327 if (!dnode->inode || !dnode->inode->ops.open) {
331 struct v_inode* inode = dnode->inode;
332 struct v_file* vfile = cake_grab(file_pile);
333 memset(vfile, 0, sizeof(*vfile));
335 vfile->dnode = dnode;
336 vfile->inode = inode;
337 vfile->ref_count = 1;
338 vfile->ops = inode->default_fops;
341 if ((inode->itype & VFS_IFFILE) && !inode->pg_cache) {
342 struct pcache* pcache = vzalloc(sizeof(struct pcache));
344 inode->pg_cache = pcache;
347 int errno = inode->ops.open(inode, vfile);
349 cake_release(file_pile, vfile);
357 vfs_link(struct v_dnode* to_link, struct v_dnode* name)
360 if (to_link->super_block->root != name->super_block->root) {
362 } else if (!to_link->inode->ops.link) {
364 } else if (!(errno = to_link->inode->ops.link(to_link->inode, name))) {
365 name->inode = to_link->inode;
366 to_link->inode->link_count++;
373 vfs_close(struct v_file* file)
376 if (!file->ops.close || !(errno = file->ops.close(file))) {
377 if (file->inode->open_count) {
378 file->inode->open_count--;
380 pcache_commit_all(file);
381 cake_release(file_pile, file);
387 vfs_fsync(struct v_file* file)
390 pcache_commit_all(file);
391 if (file->ops.sync) {
392 errno = file->ops.sync(file);
394 if (!errno && file->inode->ops.sync) {
395 return file->inode->ops.sync(file->inode);
401 vfs_alloc_fdslot(int* fd)
403 for (size_t i = 0; i < VFS_MAX_FD; i++) {
404 if (!__current->fdtable->fds[i]) {
415 struct v_superblock* sb = cake_grab(superblock_pile);
416 memset(sb, 0, sizeof(*sb));
417 llist_init_head(&sb->sb_list);
422 vfs_sb_free(struct v_superblock* sb)
424 cake_release(superblock_pile, sb);
430 struct v_dnode* dnode = cake_grab(dnode_pile);
431 memset(dnode, 0, sizeof(*dnode));
432 llist_init_head(&dnode->children);
433 dnode->name = vfs_empty;
438 vfs_d_free(struct v_dnode* dnode)
440 if (dnode->ops.destruct) {
441 dnode->ops.destruct(dnode);
443 cake_release(dnode_pile, dnode);
449 struct v_inode* inode = cake_grab(inode_pile);
450 memset(inode, 0, sizeof(*inode));
455 vfs_i_free(struct v_inode* inode)
457 cake_release(inode_pile, inode);
460 /* ---- System call definition and support ---- */
462 #define FLOCATE_CREATE_EMPTY 1
464 #define DO_STATUS(errno) SYSCALL_ESTATUS(__current->k_status = errno)
465 #define DO_STATUS_OR_RETURN(errno) ({ errno < 0 ? DO_STATUS(errno) : errno; })
468 __vfs_try_locate_file(const char* path,
469 struct v_dnode** fdir,
470 struct v_dnode** file,
473 char name_str[VFS_NAME_MAXLEN];
474 struct hstr name = HSTR(name_str, 0);
476 if ((errno = vfs_walk(NULL, path, fdir, &name, VFS_WALK_PARENT))) {
480 errno = vfs_walk(*fdir, name.value, file, NULL, 0);
481 if (errno != ENOENT || !(options & FLOCATE_CREATE_EMPTY)) {
485 if (!(errno = (*fdir)->inode->ops.create((*fdir)->inode))) {
486 struct v_dnode* file_new;
487 file_new = vfs_d_alloc();
488 file_new->name = HHSTR(valloc(VFS_NAME_MAXLEN), name.len, name.hash);
489 strcpy(file_new->name.value, name_str);
492 llist_append(&(*fdir)->children, &file_new->siblings);
499 __file_cached_read(struct v_file* file, void* buf, size_t len, size_t fpos)
501 return pcache_read(file, buf, len, fpos);
505 vfs_do_open(const char* path, int options)
508 struct v_dnode *dentry, *file;
509 struct v_file* ofile = 0;
511 errno = __vfs_try_locate_file(path, &dentry, &file, 0);
513 if (errno != ENOENT && (options & FO_CREATE)) {
514 errno = dentry->inode->ops.create(dentry->inode);
517 if (!errno && (errno = vfs_open(file, &ofile))) {
521 struct v_inode* o_inode = ofile->inode;
522 if (!(o_inode->itype & VFS_IFSEQDEV) && !(options & FO_DIRECT)) {
523 // XXX Change here accordingly when signature of pcache_r/w changed.
524 ofile->ops.read = pcache_read;
525 ofile->ops.write = pcache_write;
528 if (!errno && !(errno = vfs_alloc_fdslot(&fd))) {
529 struct v_fd* fd_s = vzalloc(sizeof(*fd_s));
530 ofile->f_pos = ofile->inode->fsize & -((options & FO_APPEND) != 0);
532 fd_s->flags = options;
533 __current->fdtable->fds[fd] = fd_s;
540 __DEFINE_LXSYSCALL2(int, open, const char*, path, int, options)
542 int errno = vfs_do_open(path, options);
543 return DO_STATUS_OR_RETURN(errno);
546 #define TEST_FD(fd) (fd >= 0 && fd < VFS_MAX_FD)
547 #define GET_FD(fd, fd_s) (TEST_FD(fd) && (fd_s = __current->fdtable->fds[fd]))
549 __DEFINE_LXSYSCALL1(int, close, int, fd)
553 if (!GET_FD(fd, fd_s)) {
558 if (fd_s->file->ref_count > 1) {
559 fd_s->file->ref_count--;
560 } else if ((errno = vfs_close(fd_s->file))) {
565 __current->fdtable->fds[fd] = 0;
568 return DO_STATUS(errno);
572 __vfs_readdir_callback(struct dir_context* dctx,
577 struct dirent* dent = (struct dirent*)dctx->cb_data;
578 strncpy(dent->d_name, name, DIRENT_NAME_MAX_LEN);
580 dent->d_type = dtype;
583 __DEFINE_LXSYSCALL2(int, readdir, int, fd, struct dirent*, dent)
587 if (!GET_FD(fd, fd_s)) {
589 } else if (!(fd_s->file->inode->itype & VFS_IFDIR)) {
592 struct dir_context dctx =
593 (struct dir_context){ .cb_data = dent,
594 .index = dent->d_offset,
595 .read_complete_callback =
596 __vfs_readdir_callback };
597 if (dent->d_offset == 0) {
598 __vfs_readdir_callback(&dctx, vfs_dot.value, vfs_dot.len, 0);
599 } else if (dent->d_offset == 1) {
600 __vfs_readdir_callback(&dctx, vfs_ddot.value, vfs_ddot.len, 0);
603 if ((errno = fd_s->file->ops.readdir(fd_s->file, &dctx))) {
612 return DO_STATUS(errno);
615 __DEFINE_LXSYSCALL1(int, mkdir, const char*, path)
617 struct v_dnode *parent, *dir;
618 struct hstr component = HSTR(valloc(VFS_NAME_MAXLEN), 0);
619 int errno = vfs_walk(NULL, path, &parent, &component, VFS_WALK_PARENT);
624 if ((parent->super_block->fs->types & FSTYPE_ROFS)) {
626 } else if (!parent->inode->ops.mkdir) {
628 } else if (!(parent->inode->itype & VFS_IFDIR)) {
632 dir->name = component;
633 if (!(errno = parent->inode->ops.mkdir(parent->inode, dir))) {
634 llist_append(&parent->children, &dir->siblings);
637 vfree(component.value);
642 return DO_STATUS(errno);
645 __DEFINE_LXSYSCALL3(int, read, int, fd, void*, buf, size_t, count)
649 if (!GET_FD(fd, fd_s)) {
654 struct v_file* file = fd_s->file;
655 if ((file->inode->itype & VFS_IFDIR)) {
660 cpu_enable_interrupt();
661 errno = file->ops.read(file, buf, count, file->f_pos);
662 cpu_disable_interrupt();
665 file->f_pos += errno;
670 return DO_STATUS(errno);
673 __DEFINE_LXSYSCALL3(int, write, int, fd, void*, buf, size_t, count)
677 if (!GET_FD(fd, fd_s)) {
682 struct v_file* file = fd_s->file;
683 if ((file->inode->itype & VFS_IFDIR)) {
688 cpu_enable_interrupt();
689 errno = file->ops.write(file, buf, count, file->f_pos);
690 cpu_disable_interrupt();
693 file->f_pos += errno;
698 return DO_STATUS(errno);
701 __DEFINE_LXSYSCALL3(int, lseek, int, fd, int, offset, int, options)
705 if (!GET_FD(fd, fd_s)) {
708 struct v_file* file = fd_s->file;
709 size_t fpos = file->f_pos;
712 fpos = (size_t)((int)file->f_pos + offset);
715 fpos = (size_t)((int)file->inode->fsize + offset);
721 if (!file->ops.seek || !(errno = file->ops.seek(file, fpos))) {
726 return DO_STATUS(errno);
730 vfs_get_path(struct v_dnode* dnode, char* buf, size_t size, int depth)
740 size_t len = vfs_get_path(dnode->parent, buf, size, depth + 1);
746 size_t cpy_size = MIN(dnode->name.len, size - len);
747 strncpy(buf + len, dnode->name.value, cpy_size);
751 buf[len++] = PATH_DELIM;
758 vfs_readlink(struct v_dnode* dnode, char* buf, size_t size)
761 if (dnode->inode->ops.read_symlink) {
762 int errno = dnode->inode->ops.read_symlink(dnode->inode, &link);
763 strncpy(buf, link, size);
769 __DEFINE_LXSYSCALL3(int, realpathat, int, fd, char*, buf, size_t, size)
773 if (!GET_FD(fd, fd_s)) {
776 struct v_dnode* dnode;
777 errno = vfs_get_path(fd_s->file->dnode, buf, size, 0);
784 return DO_STATUS(errno);
787 __DEFINE_LXSYSCALL3(int, readlink, const char*, path, char*, buf, size_t, size)
790 struct v_dnode* dnode;
791 if (!(errno = vfs_walk(NULL, path, &dnode, NULL, VFS_WALK_NOFOLLOW))) {
792 errno = vfs_readlink(dnode, buf, size);
799 return DO_STATUS(errno);
802 __DEFINE_LXSYSCALL4(int,
815 if (!GET_FD(dirfd, fd_s)) {
818 struct v_dnode* dnode;
819 if (!(errno = vfs_walk(fd_s->file->dnode,
823 VFS_WALK_NOFOLLOW))) {
824 errno = vfs_readlink(fd_s->file->dnode, buf, size);
832 return DO_STATUS(errno);
835 __DEFINE_LXSYSCALL1(int, rmdir, const char*, pathname)
838 struct v_dnode* dnode;
839 if ((errno = vfs_walk(NULL, pathname, &dnode, NULL, 0))) {
842 if ((dnode->super_block->fs->types & FSTYPE_ROFS)) {
847 if (dnode->inode->open_count) {
852 if ((dnode->inode->itype & VFS_IFDIR)) {
853 errno = dnode->inode->ops.rmdir(dnode->inode);
859 return DO_STATUS(errno);
863 __vfs_do_unlink(struct v_inode* inode)
866 if (inode->open_count) {
868 } else if (!(inode->itype & VFS_IFDIR)) {
869 // TODO handle symbolic link and type other than regular file
870 errno = inode->ops.unlink(inode);
881 __DEFINE_LXSYSCALL1(int, unlink, const char*, pathname)
884 struct v_dnode* dnode;
885 if ((errno = vfs_walk(NULL, pathname, &dnode, NULL, 0))) {
888 if ((dnode->super_block->fs->types & FSTYPE_ROFS)) {
893 errno = __vfs_do_unlink(dnode->inode);
896 return DO_STATUS(errno);
899 __DEFINE_LXSYSCALL2(int, unlinkat, int, fd, const char*, pathname)
903 if (!GET_FD(fd, fd_s)) {
906 struct v_dnode* dnode;
907 if (!(errno = vfs_walk(fd_s->file->dnode, pathname, &dnode, NULL, 0))) {
908 errno = __vfs_do_unlink(dnode->inode);
913 return DO_STATUS(errno);
916 __DEFINE_LXSYSCALL2(int, link, const char*, oldpath, const char*, newpath)
919 struct v_dnode *dentry, *to_link, *name_dentry, *name_file;
921 errno = __vfs_try_locate_file(oldpath, &dentry, &to_link, 0);
923 errno = __vfs_try_locate_file(
924 newpath, &name_dentry, &name_file, FLOCATE_CREATE_EMPTY);
927 } else if (name_file) {
928 errno = vfs_link(to_link, name_file);
931 return DO_STATUS(errno);
934 __DEFINE_LXSYSCALL1(int, fsync, int, fildes)
938 if (!GET_FD(fildes, fd_s)) {
941 errno = vfs_fsync(fd_s->file);
944 return DO_STATUS(errno);
948 __vfs_dup_fd(struct v_fd* old, struct v_fd** new)
951 struct v_fd* copied = cake_grab(fd_pile);
953 memcpy(copied, old, sizeof(struct v_fd));
954 old->file->ref_count++;
959 __DEFINE_LXSYSCALL2(int, dup2, int, oldfd, int, newfd)
961 if (newfd == oldfd) {
966 struct v_fd *oldfd_s, *newfd_s;
967 if (!GET_FD(oldfd, oldfd_s) || TEST_FD(newfd)) {
971 newfd_s = __current->fdtable->fds[newfd];
972 if (newfd_s && (errno = vfs_close(newfd_s))) {
976 if (!(errno = __vfs_dup_fd(oldfd_s, &newfd_s))) {
977 __current->fdtable->fds[newfd] = newfd_s;
982 return DO_STATUS(errno);
985 __DEFINE_LXSYSCALL1(int, dup, int, oldfd)
988 struct v_fd *oldfd_s, *newfd_s;
989 if (!GET_FD(oldfd, oldfd_s)) {
991 } else if (!(errno = vfs_alloc_fdslot(&newfd)) &&
992 !(errno = __vfs_dup_fd(oldfd_s, &newfd_s))) {
993 __current->fdtable->fds[newfd] = newfd_s;
997 return DO_STATUS(errno);
1000 __DEFINE_LXSYSCALL2(int,
1008 struct v_dnode* dnode;
1009 if ((errno = vfs_walk(NULL, pathname, &dnode, NULL, 0))) {
1012 if ((dnode->super_block->fs->types & FSTYPE_ROFS)) {
1016 if (!dnode->inode->ops.symlink) {
1021 errno = dnode->inode->ops.symlink(dnode->inode, link_target);
1024 return DO_STATUS(errno);