lunaix-os/includes/lunaix/fs.h

   1 #ifndef __LUNAIX_VFS_H
   2 #define __LUNAIX_VFS_H
   3
   4 #include <lunaix/clock.h>
   5 #include <lunaix/device.h>
   6 #include <lunaix/ds/btrie.h>
   7 #include <lunaix/ds/hashtable.h>
   8 #include <lunaix/ds/hstr.h>
   9 #include <lunaix/ds/llist.h>
  10 #include <lunaix/ds/lru.h>
  11 #include <lunaix/ds/mutex.h>
  12 #include <lunaix/status.h>
  13 #include <stdatomic.h>
  14
  15 #define VFS_NAME_MAXLEN 128
  16 #define VFS_MAX_FD 32
  17
  18 #define VFS_IFDIR 0x1
  19 #define VFS_IFFILE 0x2
  20 #define VFS_IFSEQDEV 0x4
  21 #define VFS_IFVOLDEV 0x8
  22 #define VFS_IFSYMLINK 0x16
  23
  24 #define VFS_WALK_MKPARENT 0x1
  25 #define VFS_WALK_FSRELATIVE 0x2
  26 #define VFS_WALK_PARENT 0x4
  27 #define VFS_WALK_NOFOLLOW 0x4
  28
  29 #define FSTYPE_ROFS 0x1
  30
  31 #define VFS_VALID_CHAR(chr)                                                    \
  32     (('A' <= (chr) && (chr) <= 'Z') || ('a' <= (chr) && (chr) <= 'z') ||       \
  33      ('0' <= (chr) && (chr) <= '9') || (chr) == '.' || (chr) == '_' ||         \
  34      (chr) == '-')
  35
  36 extern struct hstr vfs_ddot;
  37 extern struct hstr vfs_dot;
  38
  39 struct v_dnode;
  40 struct v_inode;
  41 struct v_superblock;
  42 struct v_file;
  43 struct v_fd;
  44 struct pcache;
  45
  46 struct filesystem
  47 {
  48     struct hlist_node fs_list;
  49     struct hstr fs_name;
  50     uint32_t types;
  51     int fs_id; // can be used to detect fs type on partition
  52     int (*mount)(struct v_superblock* vsb, struct v_dnode* mount_point);
  53     int (*unmount)(struct v_superblock* vsb);
  54 };
  55
  56 struct v_superblock
  57 {
  58     struct llist_header sb_list;
  59     int fs_id;
  60     struct device* dev;
  61     struct v_dnode* root;
  62     struct filesystem* fs;
  63     uint32_t iobuf_size;
  64     struct
  65     {
  66         uint32_t (*read_capacity)(struct v_superblock* vsb);
  67         uint32_t (*read_usage)(struct v_superblock* vsb);
  68     } ops;
  69 };
  70
  71 struct dir_context
  72 {
  73     int index;
  74     void* cb_data;
  75     void (*read_complete_callback)(struct dir_context* dctx,
  76                                    const char* name,
  77                                    const int len,
  78                                    const int dtype);
  79 };
  80
  81 struct v_file_ops
  82 {
  83     int (*write)(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
  84     int (*read)(struct v_inode* inode, void* buffer, size_t len, size_t fpos);
  85     int (*readdir)(struct v_inode* inode, struct dir_context* dctx);
  86     int (*seek)(struct v_inode* inode, size_t offset);
  87     int (*close)(struct v_file* file);
  88     int (*sync)(struct v_inode* inode);
  89 };
  90
  91 struct v_file
  92 {
  93     struct v_inode* inode;
  94     struct v_dnode* dnode;
  95     struct llist_header* f_list;
  96     uint32_t f_pos;
  97     atomic_ulong ref_count;
  98     struct v_file_ops ops;
  99 };
 100
 101 struct v_fd
 102 {
 103     struct v_file* file;
 104     int flags;
 105 };
 106
 107 struct v_inode
 108 {
 109     uint32_t id;
 110     mutex_t lock;
 111     uint32_t itype;
 112     time_t ctime;
 113     time_t mtime;
 114     time_t atime;
 115     lba_t lb_addr;
 116     uint32_t open_count;
 117     uint32_t link_count;
 118     uint32_t lb_usage;
 119     uint32_t fsize;
 120     struct hlist_node hash_list;
 121     struct pcache* pg_cache;
 122     void* data; // 允许底层FS绑定他的一些专有数据
 123     struct
 124     {
 125         int (*create)(struct v_inode* this, struct v_dnode* dnode);
 126         int (*open)(struct v_inode* this, struct v_file* file);
 127         int (*sync)(struct v_inode* this);
 128         int (*mkdir)(struct v_inode* this, struct v_dnode* dnode);
 129         int (*rmdir)(struct v_inode* this);
 130         int (*unlink)(struct v_inode* this);
 131         int (*link)(struct v_inode* this, struct v_dnode* new_name);
 132         int (*read_symlink)(struct v_inode* this, const char** path_out);
 133         int (*symlink)(struct v_inode* this, const char* target);
 134         int (*dir_lookup)(struct v_inode* this, struct v_dnode* dnode);
 135         int (*rename)(struct v_inode* from_inode,
 136                       struct v_dnode* from_dnode,
 137                       struct v_dnode* to_dnode);
 138     } ops;
 139     struct v_file_ops default_fops;
 140 };
 141
 142 struct v_dnode
 143 {
 144     mutex_t lock; // sync the path walking
 145     struct hstr name;
 146     struct v_inode* inode;
 147     struct v_dnode* parent;
 148     struct hlist_node hash_list;
 149     struct llist_header children;
 150     struct llist_header siblings;
 151     struct v_superblock* super_block;
 152     atomic_ulong ref_count;
 153 };
 154
 155 struct v_fdtable
 156 {
 157     struct v_fd* fds[VFS_MAX_FD];
 158 };
 159
 160 struct pcache_pg
 161 {
 162     struct llist_header pg_list;
 163     struct llist_header dirty_list;
 164     struct lru_node lru;
 165     void* pg;
 166     uint32_t flags;
 167     uint32_t fpos;
 168 };
 169
 170 struct pcache
 171 {
 172     struct v_inode* master;
 173     struct btrie tree;
 174     struct llist_header pages;
 175     struct llist_header dirty;
 176     uint32_t n_dirty;
 177     uint32_t n_pages;
 178 };
 179
 180 /* --- file system manager --- */
 181 void
 182 fsm_init();
 183
 184 void
 185 fsm_register(struct filesystem* fs);
 186
 187 struct filesystem*
 188 fsm_get(const char* fs_name);
 189
 190 void
 191 vfs_init();
 192
 193 struct v_dnode*
 194 vfs_dcache_lookup(struct v_dnode* parent, struct hstr* str);
 195
 196 void
 197 vfs_dcache_add(struct v_dnode* parent, struct v_dnode* dnode);
 198
 199 int
 200 vfs_walk(struct v_dnode* start,
 201          const char* path,
 202          struct v_dnode** dentry,
 203          struct hstr* component,
 204          int walk_options);
 205
 206 int
 207 vfs_mount(const char* target, const char* fs_name, struct device* device);
 208
 209 int
 210 vfs_unmount(const char* target);
 211
 212 int
 213 vfs_mount_at(const char* fs_name,
 214              struct device* device,
 215              struct v_dnode* mnt_point);
 216
 217 int
 218 vfs_unmount_at(struct v_dnode* mnt_point);
 219
 220 int
 221 vfs_mkdir(const char* path, struct v_dnode** dentry);
 222
 223 int
 224 vfs_open(struct v_dnode* dnode, struct v_file** file);
 225
 226 int
 227 vfs_close(struct v_file* file);
 228
 229 int
 230 vfs_fsync(struct v_file* file);
 231
 232 struct v_superblock*
 233 vfs_sb_alloc();
 234
 235 void
 236 vfs_sb_free(struct v_superblock* sb);
 237
 238 struct v_dnode*
 239 vfs_d_alloc();
 240
 241 void
 242 vfs_d_free(struct v_dnode* dnode);
 243
 244 struct v_inode*
 245 vfs_i_alloc(dev_t device_id, uint32_t inode_id);
 246
 247 void
 248 vfs_i_free(struct v_inode* inode);
 249
 250 int
 251 vfs_dup_fd(struct v_fd* old, struct v_fd** new);
 252
 253 void
 254 pcache_init(struct pcache* pcache);
 255
 256 void
 257 pcache_release_page(struct pcache* pcache, struct pcache_pg* page);
 258
 259 struct pcache_pg*
 260 pcache_new_page(struct pcache* pcache, uint32_t index);
 261
 262 void
 263 pcache_set_dirty(struct pcache* pcache, struct pcache_pg* pg);
 264
 265 struct pcache_pg*
 266 pcache_get_page(struct pcache* pcache,
 267                 uint32_t index,
 268                 uint32_t* offset,
 269                 struct pcache_pg** page);
 270
 271 int
 272 pcache_write(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
 273
 274 int
 275 pcache_read(struct v_inode* inode, void* data, uint32_t len, uint32_t fpos);
 276
 277 void
 278 pcache_release(struct pcache* pcache);
 279
 280 int
 281 pcache_commit(struct v_inode* inode, struct pcache_pg* page);
 282
 283 void
 284 pcache_commit_all(struct v_inode* inode);
 285
 286 void
 287 pcache_invalidate(struct pcache* pcache, struct pcache_pg* page);
 288 #endif /* __LUNAIX_VFS_H */