Boot framework rework (#45)

[lunaix-os.git] / lunaix-os / includes / lunaix / fs.h

diff --git a/lunaix-os/includes/lunaix/fs.h b/lunaix-os/includes/lunaix/fs.h
index 4b2888157d59003569801d30fbcf6d13c32565f6..a33b1d0fed3c9f0c0123d2723d1dcb2b228b9ccc 100644 (file)
--- a/lunaix-os/includes/lunaix/fs.h
+++ b/lunaix-os/includes/lunaix/fs.h
@@ -6,24 +6,41 @@
 #include <lunaix/ds/btrie.h>
 #include <lunaix/ds/hashtable.h>
 #include <lunaix/ds/hstr.h>
 #include <lunaix/ds/btrie.h>
 #include <lunaix/ds/hashtable.h>
 #include <lunaix/ds/hstr.h>

+#include <lunaix/ds/ldga.h>

 #include <lunaix/ds/llist.h>
 #include <lunaix/ds/lru.h>
 #include <lunaix/ds/mutex.h>
 #include <lunaix/status.h>
 #include <lunaix/ds/llist.h>
 #include <lunaix/ds/lru.h>
 #include <lunaix/ds/mutex.h>
 #include <lunaix/status.h>

+#include <lunaix/spike.h>
+#include <lunaix/bcache.h>
+

 #include <stdatomic.h>
 
 #include <stdatomic.h>
 

+#include <usr/lunaix/fstypes.h>
+

 #define VFS_NAME_MAXLEN 128
 #define VFS_MAX_FD 32
 
 #define VFS_NAME_MAXLEN 128
 #define VFS_MAX_FD 32
 

-#define VFS_IFDIR 0x1
-#define VFS_IFFILE 0x2
-#define VFS_IFSEQDEV 0x4
-#define VFS_IFVOLDEV 0x8
-#define VFS_IFSYMLINK 0x16
+#define VFS_IFFILE       F_FILE
+#define VFS_IFDIR       (F_FILE | F_DIR    )
+#define VFS_IFDEV       (F_FILE | F_DEV    )
+#define VFS_IFSYMLINK   (F_FILE | F_SYMLINK)
+#define VFS_IFVOLDEV    (F_FILE | F_SVDEV  )
+#define VFS_IFSEQDEV    VFS_IFDEV

 
 

+// Walk, mkdir if component encountered is non-exists.

 #define VFS_WALK_MKPARENT 0x1
 #define VFS_WALK_MKPARENT 0x1

+
+// Walk, relative to current FS.

 #define VFS_WALK_FSRELATIVE 0x2
 #define VFS_WALK_FSRELATIVE 0x2

+
+/*
+    Terminate the walk on the immediate parent,
+    name of child (last component) is returned through `component`
+*/

 #define VFS_WALK_PARENT 0x4
 #define VFS_WALK_PARENT 0x4

+
+// Do not follow the symbolic link

 #define VFS_WALK_NOFOLLOW 0x8
 
 #define VFS_HASHTABLE_BITS 10
 #define VFS_WALK_NOFOLLOW 0x8
 
 #define VFS_HASHTABLE_BITS 10


@@ -33,10 +50,14 @@
 
 #define VFS_PATH_DELIM '/'
 
 
 #define VFS_PATH_DELIM '/'
 

-#define FSTYPE_ROFS 0x1
+#define FSTYPE_ROFS     0b00000001
+#define FSTYPE_PSEUDO   0x00000010

 
 #define TEST_FD(fd) (fd >= 0 && fd < VFS_MAX_FD)
 
 
 #define TEST_FD(fd) (fd >= 0 && fd < VFS_MAX_FD)
 

+#define EXPORT_FILE_SYSTEM(fs_id, init_fn)                                     \
+    export_ldga_el(fs, fs_id, ptr_t, init_fn)
+

 #define VFS_VALID_CHAR(chr)                                                    \
     (('A' <= (chr) && (chr) <= 'Z') || ('a' <= (chr) && (chr) <= 'z') ||       \
      ('0' <= (chr) && (chr) <= '9') || (chr) == '.' || (chr) == '_' ||         \
 #define VFS_VALID_CHAR(chr)                                                    \
     (('A' <= (chr) && (chr) <= 'Z') || ('a' <= (chr) && (chr) <= 'z') ||       \
      ('0' <= (chr) && (chr) <= '9') || (chr) == '.' || (chr) == '_' ||         \


@@ -56,6 +77,9 @@
         lru_use_one(dnode_lru, &dnode->lru);                                   \
     })
 
         lru_use_one(dnode_lru, &dnode->lru);                                   \
     })
 

+#define assert_fs(cond) assert_p(cond, "FS")
+#define fail_fs(msg) fail_p(msg, "FS")
+

 typedef u32_t inode_t;
 
 struct v_dnode;
 typedef u32_t inode_t;
 
 struct v_dnode;


@@ -75,14 +99,23 @@ extern struct hstr vfs_ddot;
 extern struct hstr vfs_dot;
 extern struct v_dnode* vfs_sysroot;
 
 extern struct hstr vfs_dot;
 extern struct v_dnode* vfs_sysroot;
 

+typedef int (*mntops_mnt)(struct v_superblock* vsb, struct v_dnode* mount_point);
+typedef int (*mntops_umnt)(struct v_superblock* vsb);
+

 struct filesystem
 {
 struct filesystem
 {

+    struct llist_header fs_flat;

     struct hlist_node fs_list;
     struct hstr fs_name;
     u32_t types;
     int fs_id;
     struct hlist_node fs_list;
     struct hstr fs_name;
     u32_t types;
     int fs_id;

-    int (*mount)(struct v_superblock* vsb, struct v_dnode* mount_point);
-    int (*unmount)(struct v_superblock* vsb);
+    mntops_mnt mount;
+    mntops_umnt unmount;
+};
+
+struct fs_iter
+{
+    struct filesystem* fs;

 };
 
 struct v_superblock
 };
 
 struct v_superblock


@@ -91,19 +124,22 @@ struct v_superblock
     struct device* dev;
     struct v_dnode* root;
     struct filesystem* fs;
     struct device* dev;
     struct v_dnode* root;
     struct filesystem* fs;

+    struct blkbuf_cache* blks;

     struct hbucket* i_cache;
     void* data;
     struct hbucket* i_cache;
     void* data;

+    unsigned int ref_count;
+    size_t blksize;

     struct
     {
     struct
     {

-        u32_t (*read_capacity)(struct v_superblock* vsb);
-        u32_t (*read_usage)(struct v_superblock* vsb);
+        size_t (*read_capacity)(struct v_superblock* vsb);
+        size_t (*read_usage)(struct v_superblock* vsb);

         void (*init_inode)(struct v_superblock* vsb, struct v_inode* inode);
         void (*init_inode)(struct v_superblock* vsb, struct v_inode* inode);

+        void (*release)(struct v_superblock* vsb);

     } ops;
 };
 
 struct dir_context
 {
     } ops;
 };
 
 struct dir_context
 {

-    int index;

     void* cb_data;
     void (*read_complete_callback)(struct dir_context* dctx,
                                    const char* name,
     void* cb_data;
     void (*read_complete_callback)(struct dir_context* dctx,
                                    const char* name,


@@ -122,30 +158,37 @@ struct v_file_ops
     // These additional operations allow underlying fs to use more specialized
     // and optimized code.
 
     // These additional operations allow underlying fs to use more specialized
     // and optimized code.
 

-    int (*write_page)(struct v_inode* inode, void* pg, size_t len, size_t fpos);
-    int (*read_page)(struct v_inode* inode, void* pg, size_t len, size_t fpos);
+    int (*write_page)(struct v_inode* inode, void* pg, size_t fpos);
+    int (*read_page)(struct v_inode* inode, void* pg, size_t fpos);

 
     int (*readdir)(struct v_file* file, struct dir_context* dctx);
 
     int (*readdir)(struct v_file* file, struct dir_context* dctx);

-    int (*seek)(struct v_inode* inode, size_t offset); // optional
+    int (*seek)(struct v_file* file, size_t offset);

     int (*close)(struct v_file* file);
     int (*sync)(struct v_file* file);
 };
 
 struct v_inode_ops
 {
     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 (*create)(struct v_inode* this, struct v_dnode* dnode, 
+                  unsigned int itype);
+    

     int (*open)(struct v_inode* this, struct v_file* file);
     int (*sync)(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 (*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 (*rmdir)(struct v_inode* this, struct v_dnode* dnode);
+    int (*unlink)(struct v_inode* this, struct v_dnode* name);

     int (*link)(struct v_inode* this, struct v_dnode* new_name);
     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 (*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 (*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);
     int (*rename)(struct v_inode* from_inode,
                   struct v_dnode* from_dnode,
                   struct v_dnode* to_dnode);

+

     int (*getxattr)(struct v_inode* this,
                     struct v_xattr_entry* entry); // optional
     int (*setxattr)(struct v_inode* this,
     int (*getxattr)(struct v_inode* this,
                     struct v_xattr_entry* entry); // optional
     int (*setxattr)(struct v_inode* this,


@@ -169,6 +212,7 @@ struct v_file
     struct llist_header* f_list;
     u32_t f_pos;
     atomic_ulong ref_count;
     struct llist_header* f_list;
     u32_t f_pos;
     atomic_ulong ref_count;

+    void* data;

     struct v_file_ops* ops; // for caching
 };
 
     struct v_file_ops* ops; // for caching
 };
 


@@ -246,6 +290,8 @@ struct v_dnode
     atomic_ulong ref_count;
 
     void* data;
     atomic_ulong ref_count;
 
     void* data;

+
+    void (*destruct)(struct v_dnode* dnode);

 };
 
 struct v_fdtable
 };
 
 struct v_fdtable


@@ -256,8 +302,7 @@ struct v_fdtable
 struct pcache
 {
     struct v_inode* master;
 struct pcache
 {
     struct v_inode* master;

-    struct btrie tree;
-    struct llist_header pages;
+    struct bcache cache;

     struct llist_header dirty;
     u32_t n_dirty;
     u32_t n_pages;
     struct llist_header dirty;
     u32_t n_dirty;
     u32_t n_pages;


@@ -265,16 +310,25 @@ struct pcache
 
 struct pcache_pg
 {
 
 struct pcache_pg
 {

-    struct llist_header pg_list;

     struct llist_header dirty_list;
     struct llist_header dirty_list;

-    struct lru_node lru;
-    struct pcache* holder;
-    void* pg;
-    u32_t flags;
-    u32_t fpos;
-    u32_t len;
+
+    union {
+        struct {
+            bool dirty:1;
+        };
+        u32_t flags;
+    };
+
+    void* data;
+    unsigned int index;

 };
 
 };
 

+static inline bool
+check_itype_any(struct v_inode* inode, unsigned int type_mask)
+{
+    return !!(inode->itype & type_mask) || !type_mask;
+}
+

 void
 fsm_init();
 
 void
 fsm_init();
 


@@ -290,6 +344,18 @@ fsm_register(struct filesystem* fs);
 struct filesystem*
 fsm_get(const char* fs_name);
 
 struct filesystem*
 fsm_get(const char* fs_name);
 

+void
+fsm_itbegin(struct fs_iter* iterator);
+
+bool
+fsm_itnext(struct fs_iter* iterator);
+
+static inline void
+fsm_itend(struct fs_iter* iterator)
+{
+    iterator->fs = NULL;
+}
+

 void
 vfs_init();
 
 void
 vfs_init();
 


@@ -366,6 +432,35 @@ vfs_sb_alloc();
 void
 vfs_sb_free(struct v_superblock* sb);
 
 void
 vfs_sb_free(struct v_superblock* sb);
 

+void
+vfs_sb_ref(struct v_superblock* sb);
+
+#define vfs_assign_sb(sb_accessor, sb)      \
+    ({                                      \
+        if (sb_accessor) {                \
+            vfs_sb_free(sb_accessor);       \
+        }                                   \
+        vfs_sb_ref(((sb_accessor) = (sb))); \
+    })
+
+static inline void
+vfs_i_assign_sb(struct v_inode* inode, struct v_superblock* sb)
+{
+    vfs_assign_sb(inode->sb, sb);
+}
+
+static inline void
+vfs_d_assign_sb(struct v_dnode* dnode, struct v_superblock* sb)
+{
+    vfs_assign_sb(dnode->super_block, sb);
+}
+
+static inline void
+vfs_vmnt_assign_sb(struct v_mount* vmnt, struct v_superblock* sb)
+{
+    vfs_assign_sb(vmnt->super_block, sb);
+}
+

 struct v_dnode*
 vfs_d_alloc();
 
 struct v_dnode*
 vfs_d_alloc();
 


@@ -408,21 +503,6 @@ vfs_get_path(struct v_dnode* dnode, char* buf, size_t size, int depth);
 void
 pcache_init(struct pcache* pcache);
 
 void
 pcache_init(struct pcache* pcache);
 

-void
-pcache_release_page(struct pcache* pcache, struct pcache_pg* page);
-
-struct pcache_pg*
-pcache_new_page(struct pcache* pcache, u32_t index);
-
-void
-pcache_set_dirty(struct pcache* pcache, struct pcache_pg* pg);
-
-int
-pcache_get_page(struct pcache* pcache,
-                u32_t index,
-                u32_t* offset,
-                struct pcache_pg** page);
-

 int
 pcache_write(struct v_inode* inode, void* data, u32_t len, u32_t fpos);
 
 int
 pcache_write(struct v_inode* inode, void* data, u32_t len, u32_t fpos);
 


@@ -475,6 +555,12 @@ default_file_write(struct v_inode* inode,
                    size_t len,
                    size_t fpos);
 
                    size_t len,
                    size_t fpos);
 

+int
+default_file_read_page(struct v_inode* inode, void* buffer, size_t fpos);
+
+int
+default_file_write_page(struct v_inode* inode, void* buffer, size_t fpos);
+

 int
 default_file_readdir(struct v_file* file, struct dir_context* dctx);
 
 int
 default_file_readdir(struct v_file* file, struct dir_context* dctx);
 


@@ -490,7 +576,7 @@ int
 default_file_close(struct v_file* file);
 
 int
 default_file_close(struct v_file* file);
 
 int

-default_file_seek(struct v_inode* inode, size_t offset);
+default_file_seek(struct v_file* file, size_t offset);

 
 int
 default_inode_open(struct v_inode* this, struct v_file* file);
 
 int
 default_inode_open(struct v_inode* this, struct v_file* file);


@@ -510,4 +596,67 @@ xattr_getcache(struct v_inode* inode, struct hstr* name);
 void
 xattr_addcache(struct v_inode* inode, struct v_xattr_entry* xattr);
 
 void
 xattr_addcache(struct v_inode* inode, struct v_xattr_entry* xattr);
 

+
+/* --- misc stuff --- */
+
+#define check_itype(to_check, itype)    \
+    (((to_check) & (itype)) == (itype))
+
+/**
+ * @brief Check if node represent a regular file (nothing but a file)
+ * 
+ * @param inode 
+ * @return true 
+ * @return false 
+ */
+static inline bool
+check_regfile_node(struct v_inode* inode)
+{
+    return inode->itype == VFS_IFFILE;
+}
+
+/**
+ * @brief Check if node represent a file.
+ *        This is basically everything within file system (dir, dev, etc.)
+ * 
+ * @param inode 
+ * @return true 
+ * @return false 
+ */
+static inline bool
+check_file_node(struct v_inode* inode)
+{
+    return check_itype(inode->itype, VFS_IFFILE);
+}
+
+static inline bool
+check_directory_node(struct v_inode* inode)
+{
+    return check_itype(inode->itype, VFS_IFDIR);
+}
+
+static inline bool
+check_device_node(struct v_inode* inode)
+{
+    return check_itype(inode->itype, VFS_IFDEV);
+}
+
+static inline bool
+check_seqdev_node(struct v_inode* inode)
+{
+    return check_device_node(inode);
+}
+
+static inline bool
+check_voldev_node(struct v_inode* inode)
+{
+    return check_itype(inode->itype, VFS_IFVOLDEV);
+}
+
+static inline bool
+check_symlink_node(struct v_inode* inode)
+{
+    return check_itype(inode->itype, VFS_IFSYMLINK);
+}
+

 #endif /* __LUNAIX_VFS_H */
 #endif /* __LUNAIX_VFS_H */