X-Git-Url: https://scm.lunaixsky.com/lunaix-os.git/blobdiff_plain/a9cfeffd21239290ab1da46a952fe5789ae3f6de..refs/heads/eme/usr-header-gen:/lunaix-os/includes/lunaix/fs.h diff --git a/lunaix-os/includes/lunaix/fs.h b/lunaix-os/includes/lunaix/fs.h index 3ec85f5..003f410 100644 --- a/lunaix-os/includes/lunaix/fs.h +++ b/lunaix-os/includes/lunaix/fs.h @@ -1,30 +1,47 @@ #ifndef __LUNAIX_VFS_H #define __LUNAIX_VFS_H -#include -#include #include #include #include +#include #include #include #include -#include +#include + +#include +#include #include -#include +#include +#include +#include + +#include #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 + +// Walk, relative to current FS. #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 + +// Do not follow the symbolic link #define VFS_WALK_NOFOLLOW 0x8 #define VFS_HASHTABLE_BITS 10 @@ -34,32 +51,41 @@ #define VFS_PATH_DELIM '/' -#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 FSTYPE_ROFS 0b00000001 +#define FSTYPE_PSEUDO 0x00000010 #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) == '_' || \ (chr) == '-' || (chr) == ':') -#define unlock_inode(inode) mutex_unlock(&inode->lock) +#define unlock_inode(inode) mutex_unlock_nested(&inode->lock) #define lock_inode(inode) \ ({ \ - mutex_lock(&inode->lock); \ + mutex_lock_nested(&inode->lock); \ lru_use_one(inode_lru, &inode->lru); \ }) -#define unlock_dnode(dnode) mutex_unlock(&dnode->lock) +#define unlock_dnode(dnode) mutex_unlock_nested(&dnode->lock) #define lock_dnode(dnode) \ ({ \ - mutex_lock(&dnode->lock); \ + mutex_lock_nested(&dnode->lock); \ lru_use_one(dnode_lru, &dnode->lru); \ }) +#define dnode_atomic(dnode, ops) \ + do { lock_dnode(dnode); ops; unlock_dnode(dnode); } while(0) + +#define locked_node(node) mutex_on_hold(&(node)->lock) + +#define assert_fs(cond) assert_p(cond, "FS") +#define fail_fs(msg) fail_p(msg, "FS") + typedef u32_t inode_t; struct v_dnode; @@ -79,15 +105,46 @@ extern struct hstr vfs_ddot; 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 llist_header fs_flat; 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 vncache +{ + struct hbucket* pool; + rwlock_t lock; }; +#define cache_atomic_read(cache, ops) \ + do { \ + rwlock_begin_read(&(cache)->lock); \ + ops; \ + rwlock_end_read(&(cache)->lock); \ + } while (0) + +#define cache_atomic_write(cache, ops) \ + do { \ + rwlock_begin_write(&(cache)->lock); \ + ops; \ + rwlock_end_write(&(cache)->lock); \ + } while (0) + +#define dnode_cache(dnode) (&(dnode)->super_block->d_cache) +#define inode_cache(inode) (&(inode)->sb->i_cache) struct v_superblock { @@ -95,19 +152,24 @@ struct v_superblock struct device* dev; struct v_dnode* root; struct filesystem* fs; - struct hbucket* i_cache; + struct blkbuf_cache* blks; + struct vncache i_cache; + struct vncache d_cache; + void* data; + unsigned int ref_count; + size_t blksize; 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 (*release)(struct v_superblock* vsb); } ops; }; struct dir_context { - int index; void* cb_data; void (*read_complete_callback)(struct dir_context* dctx, const char* name, @@ -126,30 +188,37 @@ struct v_file_ops // 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 (*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 (*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 (*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 (*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); + int (*getxattr)(struct v_inode* this, struct v_xattr_entry* entry); // optional int (*setxattr)(struct v_inode* this, @@ -172,7 +241,8 @@ struct v_file struct v_dnode* dnode; struct llist_header* f_list; u32_t f_pos; - atomic_ulong ref_count; + unsigned long ref_count; + void* data; struct v_file_ops* ops; // for caching }; @@ -208,6 +278,11 @@ struct v_inode u32_t link_count; u32_t lb_usage; u32_t fsize; + + u32_t acl; + uid_t uid; + gid_t gid; + void* data; // 允许底层FS绑定他的一些专有数据 struct llist_header aka_dnodes; struct llist_header xattrs; @@ -245,23 +320,29 @@ struct v_dnode struct llist_header aka_list; struct llist_header children; struct llist_header siblings; + struct v_superblock* super_block; struct v_mount* mnt; - atomic_ulong ref_count; + + unsigned long ref_count; void* data; + + void (*destruct)(struct v_dnode* dnode); }; struct v_fdtable { struct v_fd* fds[VFS_MAX_FD]; + mutex_t lock; // inter-threads contention }; +#define lock_fdtable(fdtab) mutex_lock(&(fdtab)->lock) +#define unlock_fdtable(fdtab) mutex_unlock(&(fdtab)->lock) 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; @@ -269,16 +350,25 @@ struct pcache struct pcache_pg { - struct llist_header pg_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(); @@ -294,6 +384,33 @@ fsm_register(struct filesystem* fs); 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_vncache_init(struct vncache* cache); + +void +vfs_vncache_free(struct vncache* cache); + +void +vfs_vncache_add(struct vncache* cache, size_t key, struct hlist_node* node); + +#define vncache_lock_read(cache) rwlock_begin_read(&(cache)->lock); +#define vncache_unlock_read(cache) rwlock_end_read(&(cache)->lock); + +#define vncache_lock_write(cache) rwlock_begin_write(&(cache)->lock); +#define vncache_unlock_write(cache) rwlock_end_write(&(cache)->lock); + void vfs_init(); @@ -325,6 +442,10 @@ vfs_walk_proc(const char* path, struct hstr* component, int options); +int +vfs_walkat(int fd, const char* path, int at_opts, + struct v_dnode** dnode_out); + int vfs_mount(const char* target, const char* fs_name, @@ -368,10 +489,53 @@ struct v_superblock* vfs_sb_alloc(); void -vfs_sb_free(struct v_superblock* sb); +vfs_sb_unref(struct v_superblock* sb); + +void +vfs_sb_ref(struct v_superblock* sb); + +#define vfs_assign_sb(sb_accessor, sb) \ + ({ \ + if (likely(sb_accessor)) { \ + vfs_sb_unref(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_d_assign_vmnt(struct v_dnode* dnode, struct v_mount* vmnt) +{ + if (dnode->mnt) { + assert_msg(dnode->mnt->mnt_point != dnode, + "vmnt must be detached first"); + } + + dnode->mnt = vmnt; + + if (likely(vmnt)) + vfs_d_assign_sb(dnode, vmnt->super_block); +} + +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(); +vfs_d_alloc(struct v_dnode* parent, struct hstr* name); void vfs_d_free(struct v_dnode* dnode); @@ -397,33 +561,12 @@ 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_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_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); @@ -461,8 +604,49 @@ 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); +static inline bool +mnt_check_busy(struct v_mount* mnt) +{ + return mnt->busy_counter > 1; +} + +static inline void +vfs_ref_dnode(struct v_dnode* dnode) +{ + dnode->ref_count++; + + if (likely(dnode->mnt)) { + mnt_mkbusy(dnode->mnt); + } +} + +static inline void +vfs_unref_dnode(struct v_dnode* dnode) +{ + dnode->ref_count--; + + if (likely(dnode->mnt)) { + mnt_chillax(dnode->mnt); + } +} + +static inline void +vfs_ref_file(struct v_file* file) +{ + file->ref_count++; +} + +static inline void +vfs_unref_file(struct v_file* file) +{ + file->ref_count--; +} + +static inline bool +vfs_check_duped_file(struct v_file* file) +{ + return file->ref_count > 1; +} int vfs_check_writable(struct v_dnode* dnode); @@ -476,6 +660,12 @@ default_file_write(struct v_inode* inode, 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); @@ -491,7 +681,7 @@ 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); @@ -511,4 +701,103 @@ xattr_getcache(struct v_inode* inode, struct hstr* name); void xattr_addcache(struct v_inode* inode, struct v_xattr_entry* xattr); + +/* --- fdtable --- */ + +struct v_fdtable* +fdtable_create(); + +void +fdtable_copy(struct v_fdtable* dest, struct v_fdtable* src); + +void +fdtable_free(struct v_fdtable* table); + + +/* --- 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); +} + +static inline bool +check_allow_ops(struct v_inode* inode, unsigned int perm) +{ + return fsacl_allow_ops(perm, inode->acl, inode->uid, inode->gid); +} + +static inline bool +check_allow_read(struct v_inode* inode) +{ + return check_allow_ops(inode, FSACL_aR); +} + +static inline bool +check_allow_write(struct v_inode* inode) +{ + return check_allow_ops(inode, FSACL_aW); +} + +static inline bool +check_allow_execute(struct v_inode* inode) +{ + return check_allow_ops(inode, FSACL_aX); +} + #endif /* __LUNAIX_VFS_H */