refactor: add a simple ramfs for rootfs. Twifs should have more specific job in future.
[lunaix-os.git] / lunaix-os / includes / lunaix / fs.h
index 0764a61c26af42b9562d97d13b4252b5699b17d7..d43293be06075be91f99f368c1205480bb87f263 100644 (file)
@@ -1,14 +1,16 @@
 #ifndef __LUNAIX_VFS_H
 #define __LUNAIX_VFS_H
 
-#include <hal/ahci/hba.h>
-#include <lunaix/block.h>
 #include <lunaix/clock.h>
+#include <lunaix/device.h>
 #include <lunaix/ds/btrie.h>
 #include <lunaix/ds/hashtable.h>
 #include <lunaix/ds/hstr.h>
 #include <lunaix/ds/llist.h>
+#include <lunaix/ds/lru.h>
+#include <lunaix/ds/mutex.h>
 #include <lunaix/status.h>
+#include <stdatomic.h>
 
 #define VFS_NAME_MAXLEN 128
 #define VFS_MAX_FD 32
 #define VFS_WALK_MKPARENT 0x1
 #define VFS_WALK_FSRELATIVE 0x2
 #define VFS_WALK_PARENT 0x4
-#define VFS_WALK_NOFOLLOW 0x4
+#define VFS_WALK_NOFOLLOW 0x8
+
+#define VFS_HASHTABLE_BITS 10
+#define VFS_HASHTABLE_SIZE (1 << VFS_HASHTABLE_BITS)
+#define VFS_HASH_MASK (VFS_HASHTABLE_SIZE - 1)
+#define VFS_HASHBITS (32 - VFS_HASHTABLE_BITS)
 
 #define FSTYPE_ROFS 0x1
 
+#define DO_STATUS(errno) SYSCALL_ESTATUS(__current->k_status = errno)
+#define DO_STATUS_OR_RETURN(errno) ({ errno < 0 ? DO_STATUS(errno) : errno; })
+
+#define TEST_FD(fd) (fd >= 0 && fd < VFS_MAX_FD)
+
 #define VFS_VALID_CHAR(chr)                                                    \
-    ('A' <= (chr) && (chr) <= 'Z' || 'a' <= (chr) && (chr) <= 'z' ||           \
-     '0' <= (chr) && (chr) <= '9' || (chr) == '.' || (chr) == '_' ||           \
+    (('A' <= (chr) && (chr) <= 'Z') || ('a' <= (chr) && (chr) <= 'z') ||       \
+     ('0' <= (chr) && (chr) <= '9') || (chr) == '.' || (chr) == '_' ||         \
      (chr) == '-')
 
-extern struct hstr vfs_ddot;
-extern struct hstr vfs_dot;
+typedef uint32_t inode_t;
 
 struct v_dnode;
+struct v_inode;
+struct v_superblock;
+struct v_file;
+struct v_file_ops;
+struct v_inode_ops;
+struct v_fd;
 struct pcache;
 
+extern struct v_file_ops default_file_ops;
+extern struct v_inode_ops default_inode_ops;
+
+extern struct hstr vfs_ddot;
+extern struct hstr vfs_dot;
+extern struct v_dnode* vfs_sysroot;
+
 struct filesystem
 {
     struct hlist_node fs_list;
     struct hstr fs_name;
     uint32_t types;
+    int fs_id;
     int (*mount)(struct v_superblock* vsb, struct v_dnode* mount_point);
     int (*unmount)(struct v_superblock* vsb);
 };
@@ -49,15 +74,16 @@ struct filesystem
 struct v_superblock
 {
     struct llist_header sb_list;
-    int fs_id;
-    bdev_t dev;
+    struct device* dev;
     struct v_dnode* root;
     struct filesystem* fs;
     uint32_t iobuf_size;
+    struct hbucket* i_cache;
     struct
     {
         uint32_t (*read_capacity)(struct v_superblock* vsb);
         uint32_t (*read_usage)(struct v_superblock* vsb);
+        void (*init_inode)(struct v_superblock* vsb, struct v_inode* inode);
     } ops;
 };
 
@@ -73,24 +99,39 @@ struct dir_context
 
 struct v_file_ops
 {
-    int (*write)(struct v_file* file, void* buffer, size_t len, size_t fpos);
-    int (*read)(struct v_file* file, void* buffer, size_t len, size_t fpos);
+    int (*write)(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
+    int (*read)(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
     int (*readdir)(struct v_file* file, struct dir_context* dctx);
-    int (*seek)(struct v_file* file, size_t offset);
-    int (*rename)(struct v_file* file, char* new_name);
+    int (*seek)(struct v_inode* inode, size_t offset);
     int (*close)(struct v_file* file);
     int (*sync)(struct v_file* file);
 };
 
+struct v_inode_ops
+{
+    int (*create)(struct v_inode* this, struct v_dnode* dnode);
+    int (*open)(struct v_inode* this, struct v_file* file);
+    int (*sync)(struct v_inode* this);
+    int (*mkdir)(struct v_inode* this, struct v_dnode* dnode);
+    int (*rmdir)(struct v_inode* this, struct v_dnode* dir);
+    int (*unlink)(struct v_inode* this);
+    int (*link)(struct v_inode* this, struct v_dnode* new_name);
+    int (*read_symlink)(struct v_inode* this, const char** path_out);
+    int (*set_symlink)(struct v_inode* this, const char* target);
+    int (*dir_lookup)(struct v_inode* this, struct v_dnode* dnode);
+    int (*rename)(struct v_inode* from_inode,
+                  struct v_dnode* from_dnode,
+                  struct v_dnode* to_dnode);
+};
+
 struct v_file
 {
     struct v_inode* inode;
     struct v_dnode* dnode;
     struct llist_header* f_list;
     uint32_t f_pos;
-    uint32_t ref_count;
-    void* data; // 允许底层FS绑定他的一些专有数据
-    struct v_file_ops ops;
+    atomic_ulong ref_count;
+    struct v_file_ops* ops; // for caching
 };
 
 struct v_fd
@@ -101,6 +142,8 @@ struct v_fd
 
 struct v_inode
 {
+    inode_t id;
+    mutex_t lock;
     uint32_t itype;
     time_t ctime;
     time_t mtime;
@@ -110,26 +153,31 @@ struct v_inode
     uint32_t link_count;
     uint32_t lb_usage;
     uint32_t fsize;
+    struct v_superblock* sb;
+    struct hlist_node hash_list;
+    struct lru_node lru;
     struct pcache* pg_cache;
     void* data; // 允许底层FS绑定他的一些专有数据
-    struct
-    {
-        int (*create)(struct v_inode* this);
-        int (*open)(struct v_inode* this, struct v_file* file);
-        int (*sync)(struct v_inode* this);
-        int (*mkdir)(struct v_inode* this, struct v_dnode* dnode);
-        int (*rmdir)(struct v_inode* this);
-        int (*unlink)(struct v_inode* this);
-        int (*link)(struct v_inode* this, struct v_dnode* new_name);
-        int (*read_symlink)(struct v_inode* this, const char** path_out);
-        int (*symlink)(struct v_inode* this, const char* target);
-        int (*dir_lookup)(struct v_inode* this, struct v_dnode* dnode);
-    } ops;
-    struct v_file_ops default_fops;
+    struct v_inode_ops* ops;
+    struct v_file_ops* default_fops;
+};
+
+struct v_mount
+{
+    mutex_t lock;
+    struct llist_header list;
+    struct llist_header submnts;
+    struct llist_header sibmnts;
+    struct v_mount* parent;
+    struct v_dnode* mnt_point;
+    struct v_superblock* super_block;
+    uint32_t busy_counter;
 };
 
 struct v_dnode
 {
+    mutex_t lock; // sync the path walking
+    struct lru_node lru;
     struct hstr name;
     struct v_inode* inode;
     struct v_dnode* parent;
@@ -137,10 +185,10 @@ struct v_dnode
     struct llist_header children;
     struct llist_header siblings;
     struct v_superblock* super_block;
-    struct
-    {
-        void (*destruct)(struct v_dnode* dnode);
-    } ops;
+    struct v_mount* mnt;
+    atomic_ulong ref_count;
+
+    void* data;
 };
 
 struct v_fdtable
@@ -148,17 +196,9 @@ struct v_fdtable
     struct v_fd* fds[VFS_MAX_FD];
 };
 
-struct pcache_pg
-{
-    struct llist_header pg_list;
-    struct llist_header dirty_list;
-    void* pg;
-    uint32_t flags;
-    uint32_t fpos;
-};
-
 struct pcache
 {
+    struct v_inode* master;
     struct btrie tree;
     struct llist_header pages;
     struct llist_header dirty;
@@ -166,10 +206,26 @@ struct pcache
     uint32_t n_pages;
 };
 
+struct pcache_pg
+{
+    struct llist_header pg_list;
+    struct llist_header dirty_list;
+    struct lru_node lru;
+    struct pcache* holder;
+    void* pg;
+    uint32_t flags;
+    uint32_t fpos;
+};
 /* --- file system manager --- */
 void
 fsm_init();
 
+void
+fsm_register_all();
+
+struct filesystem*
+fsm_new_fs(char* name, size_t name_len);
+
 void
 fsm_register(struct filesystem* fs);
 
@@ -193,13 +249,15 @@ vfs_walk(struct v_dnode* start,
          int walk_options);
 
 int
-vfs_mount(const char* target, const char* fs_name, bdev_t device);
+vfs_mount(const char* target, const char* fs_name, struct device* device);
 
 int
 vfs_unmount(const char* target);
 
 int
-vfs_mount_at(const char* fs_name, bdev_t device, struct v_dnode* mnt_point);
+vfs_mount_at(const char* fs_name,
+             struct device* device,
+             struct v_dnode* mnt_point);
 
 int
 vfs_unmount_at(struct v_dnode* mnt_point);
@@ -216,6 +274,9 @@ vfs_close(struct v_file* file);
 int
 vfs_fsync(struct v_file* file);
 
+void
+vfs_assign_inode(struct v_dnode* assign_to, struct v_inode* inode);
+
 struct v_superblock*
 vfs_sb_alloc();
 
@@ -229,7 +290,13 @@ void
 vfs_d_free(struct v_dnode* dnode);
 
 struct v_inode*
-vfs_i_alloc();
+vfs_i_find(struct v_superblock* sb, uint32_t i_id);
+
+void
+vfs_i_addhash(struct v_inode* inode);
+
+struct v_inode*
+vfs_i_alloc(struct v_superblock* sb);
 
 void
 vfs_i_free(struct v_inode* inode);
@@ -256,20 +323,78 @@ pcache_get_page(struct pcache* pcache,
                 struct pcache_pg** page);
 
 int
-pcache_write(struct v_file* file, void* data, uint32_t len, uint32_t fpos);
+pcache_write(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
 
 int
-pcache_read(struct v_file* file, void* data, uint32_t len, uint32_t fpos);
+pcache_read(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
 
 void
 pcache_release(struct pcache* pcache);
 
 int
-pcache_commit(struct v_file* file, struct pcache_pg* page);
+pcache_commit(struct v_inode* inode, struct pcache_pg* page);
+
+void
+pcache_commit_all(struct v_inode* inode);
+
+void
+pcache_invalidate(struct pcache* pcache, struct pcache_pg* page);
 
+/**
+ * @brief 将挂载点标记为繁忙
+ *
+ * @param mnt
+ */
 void
-pcache_invalidate(struct v_file* file, struct pcache_pg* page);
+mnt_mkbusy(struct v_mount* mnt);
 
+/**
+ * @brief 将挂载点标记为清闲
+ *
+ * @param mnt
+ */
 void
-pcache_commit_all(struct v_file* file);
+mnt_chillax(struct v_mount* mnt);
+
+int
+vfs_mount_root(const char* fs_name, struct device* device);
+
+struct v_mount*
+vfs_create_mount(struct v_mount* parent, struct v_dnode* mnt_point);
+
+int
+default_file_read(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
+
+int
+default_file_write(struct v_inode* inode,
+                   void* buffer,
+                   size_t len,
+                   size_t fpos);
+
+int
+default_file_readdir(struct v_file* file, struct dir_context* dctx);
+
+int
+default_inode_dirlookup(struct v_inode* this, struct v_dnode* dnode);
+
+int
+default_inode_rename(struct v_inode* from_inode,
+                     struct v_dnode* from_dnode,
+                     struct v_dnode* to_dnode);
+
+int
+default_file_close(struct v_file* file);
+
+int
+default_file_seek(struct v_inode* inode, size_t offset);
+
+int
+default_inode_open(struct v_inode* this, struct v_file* file);
+
+int
+default_inode_rmdir(struct v_inode* this, struct v_dnode* dir);
+
+int
+default_inode_mkdir(struct v_inode* this, struct v_dnode* dir);
+
 #endif /* __LUNAIX_VFS_H */