xt_vfs.h

浏览该文件的文档.

 
#ifndef __XT_VFS_H__
#define __XT_VFS_H__
 
/* ==================== [Includes] ========================================== */
 
#include <stdint.h>
 
#include "xt_vfs_port.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */

 
/* ---- 文件打开模式 ---- */

#define XT_VFS_O_RDONLY            0x01
#define XT_VFS_O_WRONLY            0x02
#define XT_VFS_O_RDWR              0x04
#define XT_VFS_O_CREAT             0x08
#define XT_VFS_O_EXCL              0x10
#define XT_VFS_O_TRUNC             0x20
#define XT_VFS_O_APPEND            0x40
 
/* ---- 文件类型 ---- */

#define XT_VFS_TYPE_REG            0x01
#define XT_VFS_TYPE_DIR            0x02
#define XT_VFS_TYPE_UNKNOWN        0xFF
 
/* ---- access 模式 ---- */

#define XT_VFS_F_OK                0x00
#define XT_VFS_R_OK                0x04
#define XT_VFS_W_OK                0x02
#define XT_VFS_X_OK                0x01
 
/* ---- 文件类型掩码 ---- */

#define XT_VFS_S_IFMT              0xF000
#define XT_VFS_S_IFREG             0x1000
#define XT_VFS_S_IFDIR             0x2000
 
/* ---- 文件权限位 ---- */

#define XT_VFS_S_IRWXU             0x01C0
#define XT_VFS_S_IRUSR             0x0100
#define XT_VFS_S_IWUSR             0x0080
#define XT_VFS_S_IXUSR             0x0040
#define XT_VFS_S_IRWXG             0x0038
#define XT_VFS_S_IRGRP             0x0020
#define XT_VFS_S_IWGRP             0x0010
#define XT_VFS_S_IXGRP             0x0008
#define XT_VFS_S_IRWXO             0x0007
#define XT_VFS_S_IROTH             0x0004
#define XT_VFS_S_IWOTH             0x0002
#define XT_VFS_S_IXOTH             0x0001
 
/* ---- 默认权限 ---- */

#define XT_VFS_S_DEFAULT_FILE      (XT_VFS_S_IFREG | XT_VFS_S_IRUSR | XT_VFS_S_IWUSR | XT_VFS_S_IRGRP | XT_VFS_S_IROTH)
#define XT_VFS_S_DEFAULT_DIR       (XT_VFS_S_IFDIR | XT_VFS_S_IRWXU | XT_VFS_S_IRGRP | XT_VFS_S_IXGRP | XT_VFS_S_IROTH | XT_VFS_S_IXOTH)
 
/* ---- 寻址方式 ---- */

#define XT_VFS_SEEK_SET            0
#define XT_VFS_SEEK_CUR            1
#define XT_VFS_SEEK_END            2
 
/* ---- 错误码 ---- */

#define XT_VFS_ERR_OK              0
#define XT_VFS_ERR_EOF             -1
#define XT_VFS_ERR_NOTFOUND        -2
#define XT_VFS_ERR_EXIST           -3
#define XT_VFS_ERR_NOSPC           -4
#define XT_VFS_ERR_NOMEM           -5
#define XT_VFS_ERR_IO              -6
#define XT_VFS_ERR_INVAL           -7
#define XT_VFS_ERR_DENIED          -8
#define XT_VFS_ERR_NFILE           -9
#define XT_VFS_ERR_NOTDIR          -10
#define XT_VFS_ERR_ISDIR           -11
#define XT_VFS_ERR_NOTEMPTY        -12
#define XT_VFS_ERR_BUSY            -13
#define XT_VFS_ERR_NOSYS           -14

#define XT_VFS_INVALID_FD           ((xt_vfs_fd_t)(-1))
 
/* ==================== [Typedefs] ========================================== */

typedef int32_t  xt_vfs_err_t;
typedef int32_t  xt_vfs_fd_t;
typedef uint32_t xt_vfs_size_t;
typedef int32_t  xt_vfs_ssize_t;
typedef uint32_t xt_vfs_mode_t;
typedef uint32_t xt_vfs_time_t;
typedef int32_t  xt_vfs_off_t;
typedef int32_t  xt_vfs_whence_t;
typedef int32_t  xt_vfs_ino_t;
 
/* ---- 文件状态 ---- */

typedef struct xt_vfs_stat {
    xt_vfs_size_t st_size;                 
    xt_vfs_mode_t st_mode;                 
    xt_vfs_time_t st_atime;                
    xt_vfs_time_t st_mtime;                
    xt_vfs_time_t st_ctime;                
} xt_vfs_stat_t;
 
/* ---- 文件系统状态 ---- */

typedef struct xt_vfs_statfs {
    xt_vfs_size_t f_blocks;                 
    xt_vfs_size_t f_bfree;                  
    xt_vfs_size_t f_bsize;                  
    xt_vfs_size_t f_files;                  
    xt_vfs_size_t f_ffree;                  
} xt_vfs_statfs_t;
 
/* ---- 文件时间 ---- */

typedef struct xt_vfs_utimbuf {
    xt_vfs_time_t actime;                  
    xt_vfs_time_t modtime;                 
} xt_vfs_utimbuf_t;
 
/* ---- 目录句柄 ---- */

typedef struct xt_vfs_dir xt_vfs_dir_t;
 
/* ---- 目录项 ---- */

typedef struct xt_vfs_dirent {
    xt_vfs_ino_t d_ino;                    
    uint8_t      d_type;                   
    char         d_name[XT_VFS_FILENAME_MAX]; 
} xt_vfs_dirent_t;
 
/* ---- 前向声明 ---- */

typedef struct xt_vfs_ops xt_vfs_ops_t;
typedef struct xt_vfs     xt_vfs_t;
 
/* ---- 后端操作接口 ---- */

 
struct xt_vfs_ops {
    xt_vfs_err_t  (*mount)(void *ctx);

    xt_vfs_err_t  (*unmount)(void *ctx);

    xt_vfs_err_t   (*open)(void *ctx, const char *path, xt_vfs_mode_t flags, void **fh);

    xt_vfs_err_t   (*close)(void *ctx, void *fh);

    xt_vfs_ssize_t (*read)(void *ctx, void *fh, void *buf, xt_vfs_size_t size);

    xt_vfs_ssize_t (*write)(void *ctx, void *fh, const void *buf, xt_vfs_size_t size);

    xt_vfs_ssize_t (*seek)(void *ctx, void *fh, xt_vfs_off_t offset, xt_vfs_whence_t whence);

    xt_vfs_ssize_t (*tell)(void *ctx, void *fh);

    xt_vfs_err_t   (*fsync)(void *ctx, void *fh);

    xt_vfs_err_t   (*remove)(void *ctx, const char *path);

    xt_vfs_err_t   (*rename)(void *ctx, const char *old_path, const char *new_path);

    xt_vfs_err_t   (*stat)(void *ctx, const char *path, xt_vfs_stat_t *stat);

    xt_vfs_err_t   (*statfs)(void *ctx, xt_vfs_statfs_t *statfs);

    xt_vfs_err_t   (*mkdir)(void *ctx, const char *path);

    xt_vfs_err_t   (*rmdir)(void *ctx, const char *path);

    xt_vfs_err_t     (*opendir)(void *ctx, const char *path, void **dh);

    xt_vfs_err_t     (*closedir)(void *ctx, void *dh);

    xt_vfs_dirent_t *(*readdir)(void *ctx, void *dh);

    xt_vfs_off_t     (*telldir)(void *ctx, void *dh);

    xt_vfs_err_t     (*seekdir)(void *ctx, void *dh, xt_vfs_off_t loc);

    xt_vfs_err_t   (*fstat)(void *ctx, void *fh, xt_vfs_stat_t *stat);

    xt_vfs_err_t   (*truncate)(void *ctx, const char *path, xt_vfs_off_t length);

    xt_vfs_err_t   (*ftruncate)(void *ctx, void *fh, xt_vfs_off_t length);

    xt_vfs_err_t   (*access)(void *ctx, const char *path, xt_vfs_mode_t amode);

    xt_vfs_err_t   (*utime)(void *ctx, const char *path, const xt_vfs_utimbuf_t *buf);

    xt_vfs_err_t   (*sync_all)(void *ctx, const char *path);
};
  /* dev_xt_vfs */

 
/* ==================== [Global Prototypes] ================================= */


xt_vfs_err_t xt_vfs_init(const xt_vfs_config_t *config);

xt_vfs_err_t xt_vfs_deinit(void);
  /* 生命周期 */


xt_vfs_err_t xt_vfs_mount(const char *path, const xt_vfs_ops_t *ops, void *ctx);

xt_vfs_err_t xt_vfs_unmount(const char *path);
  /* 挂载管理 */


xt_vfs_fd_t xt_vfs_open(const char *path, xt_vfs_mode_t flags);

xt_vfs_err_t xt_vfs_close(xt_vfs_fd_t fd);

xt_vfs_ssize_t xt_vfs_read(xt_vfs_fd_t fd, void *buf, xt_vfs_size_t size);

xt_vfs_ssize_t xt_vfs_write(xt_vfs_fd_t fd, const void *buf, xt_vfs_size_t size);

xt_vfs_ssize_t xt_vfs_seek(xt_vfs_fd_t fd, xt_vfs_off_t offset, xt_vfs_whence_t whence);

xt_vfs_ssize_t xt_vfs_tell(xt_vfs_fd_t fd);

xt_vfs_err_t xt_vfs_fsync(xt_vfs_fd_t fd);
  /* 文件读写 */


xt_vfs_err_t xt_vfs_remove(const char *path);

xt_vfs_err_t xt_vfs_rename(const char *old_path, const char *new_path);

xt_vfs_err_t xt_vfs_stat(const char *path, xt_vfs_stat_t *stat);

xt_vfs_err_t xt_vfs_fstat(xt_vfs_fd_t fd, xt_vfs_stat_t *stat);

xt_vfs_err_t xt_vfs_statfs(const char *path, xt_vfs_statfs_t *statfs);

xt_vfs_err_t xt_vfs_truncate(const char *path, xt_vfs_off_t length);

xt_vfs_err_t xt_vfs_ftruncate(xt_vfs_fd_t fd, xt_vfs_off_t length);

xt_vfs_err_t xt_vfs_access(const char *path, xt_vfs_mode_t amode);

xt_vfs_err_t xt_vfs_utime(const char *path, const xt_vfs_utimbuf_t *buf);

xt_vfs_err_t xt_vfs_sync_all(const char *path);
  /* 文件信息与管理 */
 
#if XT_VFS_ENABLE_DIR


xt_vfs_err_t xt_vfs_mkdir(const char *path);

xt_vfs_err_t xt_vfs_rmdir(const char *path);

xt_vfs_dir_t *xt_vfs_opendir(const char *path);

xt_vfs_err_t xt_vfs_closedir(xt_vfs_dir_t *dir);

xt_vfs_dirent_t *xt_vfs_readdir(xt_vfs_dir_t *dir);

xt_vfs_err_t xt_vfs_rewinddir(xt_vfs_dir_t *dir);

xt_vfs_off_t xt_vfs_telldir(xt_vfs_dir_t *dir);

xt_vfs_err_t xt_vfs_seekdir(xt_vfs_dir_t *dir, xt_vfs_off_t loc);
  /* 目录操作 */
 
#endif /* XT_VFS_ENABLE_DIR */
 
#if XT_VFS_ENABLE_CWD


xt_vfs_err_t xt_vfs_chdir(const char *path);

char *xt_vfs_getcwd(char *buf, xt_vfs_size_t size);
  /* 工作目录 */
 
#endif /* XT_VFS_ENABLE_CWD */


xt_vfs_err_t xt_vfs_errno(void);

const char *xt_vfs_strerror(xt_vfs_err_t err);

bool xt_vfs_is_active(void);
  /* 错误与状态 */
 
/* ==================== [Macros] ============================================ */
  /* xt_vfs */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_VFS_H__ */