feat: support user-spcae pci rescan

[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 c86c6bc3aed5a27ecd7d8b6236a55fae40d5b9c6..d5990235253f2b06485b7f10d23d63ac2b5f84cd 100644 (file)
--- a/lunaix-os/includes/lunaix/fs.h
+++ b/lunaix-os/includes/lunaix/fs.h
@@ -6,25 +6,42 @@
 #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/ds/llist.h>
 #include <lunaix/ds/lru.h>
 #include <lunaix/ds/mutex.h>

-#include <lunaix/process.h>

 #include <lunaix/status.h>
 #include <lunaix/status.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_IFDIR F_DIR
+#define VFS_IFFILE F_FILE
+#define VFS_IFDEV (F_DEV | F_FILE)
+#define VFS_IFSEQDEV (F_SEQDEV | F_FILE)
+#define VFS_IFVOLDEV (F_VOLDEV | F_FILE)
+#define VFS_IFSYMLINK (F_SYMLINK | F_FILE)
+
+#define VFS_DEVFILE(type) ((type) & F_DEV)
+#define VFS_DEVTYPE(type) ((type) & ((F_SEQDEV | F_VOLDEV) ^ F_DEV))

 
 

+// 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


@@ -36,15 +53,15 @@
 
 #define FSTYPE_ROFS 0x1
 
 
 #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 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) == '_' ||         \

-     (chr) == '-')
+     (chr) == '-' || (chr) == ':')

 
 #define unlock_inode(inode) mutex_unlock(&inode->lock)
 #define lock_inode(inode)                                                      \
 
 #define unlock_inode(inode) mutex_unlock(&inode->lock)
 #define lock_inode(inode)                                                      \


@@ -60,7 +77,7 @@
         lru_use_one(dnode_lru, &dnode->lru);                                   \
     })
 
         lru_use_one(dnode_lru, &dnode->lru);                                   \
     })
 

-typedef uint32_t inode_t;
+typedef u32_t inode_t;

 
 struct v_dnode;
 struct v_inode;
 
 struct v_dnode;
 struct v_inode;


@@ -83,7 +100,7 @@ struct filesystem
 {
     struct hlist_node fs_list;
     struct hstr fs_name;
 {
     struct hlist_node fs_list;
     struct hstr fs_name;

-    uint32_t types;
+    u32_t types;

     int fs_id;
     int (*mount)(struct v_superblock* vsb, struct v_dnode* mount_point);
     int (*unmount)(struct v_superblock* vsb);
     int fs_id;
     int (*mount)(struct v_superblock* vsb, struct v_dnode* mount_point);
     int (*unmount)(struct v_superblock* vsb);


@@ -95,12 +112,13 @@ struct v_superblock
     struct device* dev;
     struct v_dnode* root;
     struct filesystem* fs;
     struct device* dev;
     struct v_dnode* root;
     struct filesystem* fs;

-    uint32_t iobuf_size;

     struct hbucket* i_cache;
     struct hbucket* i_cache;

+    void* data;
+    size_t blksize;

     struct
     {
     struct
     {

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

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


@@ -119,8 +137,18 @@ struct v_file_ops
 {
     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 (*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);

+
+    // for operatiosn {write|read}_page, following are true:
+    //  + `len` always equals to PG_SIZE
+    //  + `fpos` always PG_SIZE aligned.
+    // 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 (*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);
+    int (*seek)(struct v_inode* inode, size_t offset); // optional

     int (*close)(struct v_file* file);
     int (*sync)(struct v_file* file);
 };
     int (*close)(struct v_file* file);
     int (*sync)(struct v_file* file);
 };


@@ -140,9 +168,12 @@ struct v_inode_ops
     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);
-    int (*setxattr)(struct v_inode* this, struct v_xattr_entry* entry);
-    int (*delxattr)(struct v_inode* this, struct v_xattr_entry* entry);
+    int (*getxattr)(struct v_inode* this,
+                    struct v_xattr_entry* entry); // optional
+    int (*setxattr)(struct v_inode* this,
+                    struct v_xattr_entry* entry); // optional
+    int (*delxattr)(struct v_inode* this,
+                    struct v_xattr_entry* entry); // optional

 };
 
 struct v_xattr_entry
 };
 
 struct v_xattr_entry


@@ -158,7 +189,7 @@ struct v_file
     struct v_inode* inode;
     struct v_dnode* dnode;
     struct llist_header* f_list;
     struct v_inode* inode;
     struct v_dnode* dnode;
     struct llist_header* f_list;

-    uint32_t f_pos;
+    u32_t f_pos;

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


@@ -169,27 +200,43 @@ struct v_fd
     int flags;
 };
 
     int flags;
 };
 

+//  [v_inode::aka_nodes]
+//  how do we invalidate corresponding v_dnodes given the v_inode?
+/*
+    Consider taskfs, which is Lunaix's speak of Linux's procfs, that allow
+    info of every process being accessible via file system. Each process's
+    creation will result a creation of a directory under the root of task fs
+    with it's pid as name. But that dir must delete when process is killed, and
+    such deletion does not mediated by vfs itself, so there is a need of cache
+    syncing.
+    And this is also the case of all ramfs where argumentation to file tree is
+    performed by third party.
+*/
+

 struct v_inode
 {
     inode_t id;
     mutex_t lock;
 struct v_inode
 {
     inode_t id;
     mutex_t lock;

-    uint32_t itype;
+    u32_t itype;

     time_t ctime;
     time_t mtime;
     time_t atime;
     lba_t lb_addr;
     time_t ctime;
     time_t mtime;
     time_t atime;
     lba_t lb_addr;

-    uint32_t open_count;
-    uint32_t link_count;
-    uint32_t lb_usage;
-    uint32_t fsize;
+    u32_t open_count;
+    u32_t link_count;
+    u32_t lb_usage;
+    u32_t fsize;
+    void* data; // 允许底层FS绑定他的一些专有数据
+    struct llist_header aka_dnodes;

     struct llist_header xattrs;
     struct v_superblock* sb;
     struct hlist_node hash_list;
     struct lru_node lru;
     struct pcache* pg_cache;
     struct llist_header xattrs;
     struct v_superblock* sb;
     struct hlist_node hash_list;
     struct lru_node lru;
     struct pcache* pg_cache;

-    void* data; // 允许底层FS绑定他的一些专有数据

     struct v_inode_ops* ops;
     struct v_file_ops* default_fops;
     struct v_inode_ops* ops;
     struct v_file_ops* default_fops;

+
+    void (*destruct)(struct v_inode* inode);

 };
 
 struct v_mount
 };
 
 struct v_mount


@@ -201,7 +248,8 @@ struct v_mount
     struct v_mount* parent;
     struct v_dnode* mnt_point;
     struct v_superblock* super_block;
     struct v_mount* parent;
     struct v_dnode* mnt_point;
     struct v_superblock* super_block;

-    uint32_t busy_counter;
+    u32_t busy_counter;
+    int flags;

 };
 
 struct v_dnode
 };
 
 struct v_dnode


@@ -212,6 +260,7 @@ struct v_dnode
     struct v_inode* inode;
     struct v_dnode* parent;
     struct hlist_node hash_list;
     struct v_inode* inode;
     struct v_dnode* parent;
     struct hlist_node hash_list;

+    struct llist_header aka_list;

     struct llist_header children;
     struct llist_header siblings;
     struct v_superblock* super_block;
     struct llist_header children;
     struct llist_header siblings;
     struct v_superblock* super_block;


@@ -232,8 +281,8 @@ struct pcache
     struct btrie tree;
     struct llist_header pages;
     struct llist_header dirty;
     struct btrie tree;
     struct llist_header pages;
     struct llist_header dirty;

-    uint32_t n_dirty;
-    uint32_t n_pages;
+    u32_t n_dirty;
+    u32_t n_pages;

 };
 
 struct pcache_pg
 };
 
 struct pcache_pg


@@ -243,10 +292,11 @@ struct pcache_pg
     struct lru_node lru;
     struct pcache* holder;
     void* pg;
     struct lru_node lru;
     struct pcache* holder;
     void* pg;

-    uint32_t flags;
-    uint32_t fpos;
+    u32_t flags;
+    u32_t fpos;
+    u32_t len;

 };
 };

-/* --- file system manager --- */
+

 void
 fsm_init();
 
 void
 fsm_init();
 


@@ -265,6 +315,9 @@ fsm_get(const char* fs_name);
 void
 vfs_init();
 
 void
 vfs_init();
 

+void
+vfs_export_attributes();
+

 struct v_dnode*
 vfs_dcache_lookup(struct v_dnode* parent, struct hstr* str);
 
 struct v_dnode*
 vfs_dcache_lookup(struct v_dnode* parent, struct hstr* str);
 


@@ -291,7 +344,10 @@ vfs_walk_proc(const char* path,
               int options);
 
 int
               int options);
 
 int

-vfs_mount(const char* target, const char* fs_name, struct device* device);
+vfs_mount(const char* target,
+          const char* fs_name,
+          struct device* device,
+          int options);

 
 int
 vfs_unmount(const char* target);
 
 int
 vfs_unmount(const char* target);


@@ -299,7 +355,8 @@ vfs_unmount(const char* target);
 int
 vfs_mount_at(const char* fs_name,
              struct device* device,
 int
 vfs_mount_at(const char* fs_name,
              struct device* device,

-             struct v_dnode* mnt_point);
+             struct v_dnode* mnt_point,
+             int options);

 
 int
 vfs_unmount_at(struct v_dnode* mnt_point);
 
 int
 vfs_unmount_at(struct v_dnode* mnt_point);


@@ -310,9 +367,15 @@ vfs_mkdir(const char* path, struct v_dnode** dentry);
 int
 vfs_open(struct v_dnode* dnode, struct v_file** file);
 
 int
 vfs_open(struct v_dnode* dnode, struct v_file** file);
 

+int
+vfs_pclose(struct v_file* file, pid_t pid);
+

 int
 vfs_close(struct v_file* file);
 
 int
 vfs_close(struct v_file* file);
 

+void
+vfs_free_fd(struct v_fd* fd);
+

 int
 vfs_fsync(struct v_file* file);
 
 int
 vfs_fsync(struct v_file* file);
 


@@ -332,7 +395,7 @@ void
 vfs_d_free(struct v_dnode* dnode);
 
 struct v_inode*
 vfs_d_free(struct v_dnode* dnode);
 
 struct v_inode*

-vfs_i_find(struct v_superblock* sb, uint32_t i_id);
+vfs_i_find(struct v_superblock* sb, u32_t i_id);

 
 void
 vfs_i_addhash(struct v_inode* inode);
 
 void
 vfs_i_addhash(struct v_inode* inode);


@@ -349,6 +412,21 @@ vfs_dup_fd(struct v_fd* old, struct v_fd** new);
 int
 vfs_getfd(int fd, struct v_fd** fd_s);
 
 int
 vfs_getfd(int fd, struct v_fd** fd_s);
 

+int
+vfs_get_dtype(int itype);
+
+void
+vfs_ref_dnode(struct v_dnode* dnode);
+
+void
+vfs_ref_file(struct v_file* file);
+
+void
+vfs_unref_dnode(struct v_dnode* dnode);
+
+int
+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);
 


@@ -356,22 +434,22 @@ void
 pcache_release_page(struct pcache* pcache, struct pcache_pg* page);
 
 struct pcache_pg*
 pcache_release_page(struct pcache* pcache, struct pcache_pg* page);
 
 struct pcache_pg*

-pcache_new_page(struct pcache* pcache, uint32_t index);
+pcache_new_page(struct pcache* pcache, u32_t index);

 
 void
 pcache_set_dirty(struct pcache* pcache, struct pcache_pg* pg);
 
 
 void
 pcache_set_dirty(struct pcache* pcache, struct pcache_pg* pg);
 

-struct pcache_pg*
+int

 pcache_get_page(struct pcache* pcache,
 pcache_get_page(struct pcache* pcache,

-                uint32_t index,
-                uint32_t* offset,
+                u32_t index,
+                u32_t* offset,

                 struct pcache_pg** page);
 
 int
                 struct pcache_pg** page);
 
 int

-pcache_write(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
+pcache_write(struct v_inode* inode, void* data, u32_t len, u32_t fpos);

 
 int
 
 int

-pcache_read(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
+pcache_read(struct v_inode* inode, void* data, u32_t len, u32_t fpos);

 
 void
 pcache_release(struct pcache* pcache);
 
 void
 pcache_release(struct pcache* pcache);


@@ -407,6 +485,9 @@ 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);
 
 struct v_mount*
 vfs_create_mount(struct v_mount* parent, struct v_dnode* mnt_point);
 

+int
+vfs_check_writable(struct v_dnode* dnode);
+

 int
 default_file_read(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
 
 int
 default_file_read(struct v_inode* inode, void* buffer, size_t len, size_t fpos);