1 /* File System Interface Layer Definition 2 ** 3 ** Distributed under the terms of the Haiku License. 4 */ 5 #ifndef _FS_INTERFACE_H 6 #define _FS_INTERFACE_H 7 8 9 #include <OS.h> 10 #include <module.h> 11 #include <vfs_types.h> 12 13 14 struct dirent; 15 struct stat; 16 struct fs_info; 17 18 typedef dev_t mount_id; 19 typedef ino_t vnode_id; 20 21 /* the file system's private data structures */ 22 typedef void *fs_volume; 23 typedef void *fs_cookie; 24 typedef void *fs_vnode; 25 26 /* passed to write_stat() */ 27 enum write_stat_mask { 28 FS_WRITE_STAT_MODE = 0x0001, 29 FS_WRITE_STAT_UID = 0x0002, 30 FS_WRITE_STAT_GID = 0x0004, 31 FS_WRITE_STAT_SIZE = 0x0008, 32 FS_WRITE_STAT_ATIME = 0x0010, 33 FS_WRITE_STAT_MTIME = 0x0020, 34 FS_WRITE_STAT_CRTIME = 0x0040 35 }; 36 37 /* passed to write_fs_info() */ 38 #define FS_WRITE_FSINFO_NAME 0x0001 39 40 struct file_io_vec { 41 off_t offset; 42 off_t length; 43 }; 44 45 #define B_CURRENT_FS_API_VERSION "/v1" 46 47 #ifdef __cplusplus 48 extern "C" { 49 #endif 50 51 typedef struct file_system_info { 52 struct module_info module_info; 53 54 /* general operations */ 55 status_t (*mount)(mount_id id, const char *device, void *args, fs_volume *_fs, vnode_id *_rootVnodeID); 56 status_t (*unmount)(fs_volume fs); 57 58 status_t (*read_fs_info)(fs_volume fs, struct fs_info *info); 59 status_t (*write_fs_info)(fs_volume fs, const struct fs_info *info, uint32 mask); 60 status_t (*sync)(fs_volume fs); 61 62 /* vnode operations */ 63 status_t (*lookup)(fs_volume fs, fs_vnode dir, const char *name, vnode_id *_id, int *_type); 64 status_t (*get_vnode_name)(fs_volume fs, fs_vnode vnode, char *buffer, size_t bufferSize); 65 66 status_t (*get_vnode)(fs_volume fs, vnode_id id, fs_vnode *_vnode, bool reenter); 67 status_t (*put_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 68 status_t (*remove_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 69 70 /* VM file access */ 71 bool (*can_page)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 72 status_t (*read_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, const iovec *vecs, size_t count, size_t *_numBytes); 73 status_t (*write_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, const iovec *vecs, size_t count, size_t *_numBytes); 74 75 /* cache file access */ 76 status_t (*get_file_map)(fs_volume fs, fs_vnode vnode, off_t offset, size_t size, struct file_io_vec *vecs, size_t *_count); 77 78 /* common operations */ 79 status_t (*ioctl)(fs_volume fs, fs_vnode v, fs_cookie cookie, ulong op, void *buffer, size_t length); 80 status_t (*fsync)(fs_volume fs, fs_vnode v); 81 82 ssize_t (*read_link)(fs_volume fs, fs_vnode link, char *buffer, size_t bufferSize); 83 status_t (*write_link)(fs_volume fs, fs_vnode link, char *toPath); 84 status_t (*create_symlink)(fs_volume fs, fs_vnode dir, const char *name, const char *path, int mode); 85 86 status_t (*link)(fs_volume fs, fs_vnode dir, const char *name, fs_vnode vnode); 87 status_t (*unlink)(fs_volume fs, fs_vnode dir, const char *name); 88 status_t (*rename)(fs_volume fs, fs_vnode fromDir, const char *fromName, fs_vnode toDir, const char *toName); 89 90 status_t (*access)(fs_volume fs, fs_vnode vnode, int mode); 91 status_t (*read_stat)(fs_volume fs, fs_vnode vnode, struct stat *stat); 92 status_t (*write_stat)(fs_volume fs, fs_vnode vnode, const struct stat *stat, uint32 statMask); 93 94 /* file operations */ 95 status_t (*create)(fs_volume fs, fs_vnode dir, const char *name, int openMode, int perms, fs_cookie *_cookie, vnode_id *_newVnodeID); 96 status_t (*open)(fs_volume fs, fs_vnode v, int openMode, fs_cookie *_cookie); 97 status_t (*close)(fs_volume fs, fs_vnode v, fs_cookie cookie); 98 status_t (*free_cookie)(fs_volume fs, fs_vnode v, fs_cookie cookie); 99 status_t (*read)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, void *buffer, size_t *length); 100 status_t (*write)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); 101 102 /* directory operations */ 103 status_t (*create_dir)(fs_volume fs, fs_vnode parent, const char *name, int perms, vnode_id *_newVnodeID); 104 status_t (*remove_dir)(fs_volume fs, fs_vnode parent, const char *name); 105 status_t (*open_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 106 status_t (*close_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 107 status_t (*free_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 108 status_t (*read_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 109 status_t (*rewind_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 110 111 /* attribute directory operations */ 112 status_t (*open_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 113 status_t (*close_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 114 status_t (*free_attr_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 115 status_t (*read_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 116 status_t (*rewind_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 117 118 /* attribute operations */ 119 status_t (*create_attr)(fs_volume fs, fs_vnode file, const char *name, uint32 type, int openMode, fs_cookie *_cookie); 120 status_t (*open_attr)(fs_volume fs, fs_vnode file, const char *name, int openMode, fs_cookie *_cookie); 121 status_t (*close_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie); 122 status_t (*free_attr_cookie)(fs_volume fs, fs_vnode file, fs_cookie cookie); 123 status_t (*read_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, void *buffer, size_t *length); 124 status_t (*write_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); 125 126 status_t (*read_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, struct stat *stat); 127 status_t (*write_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, const struct stat *stat, int statMask); 128 status_t (*rename_attr)(fs_volume fs, fs_vnode fromFile, const char *fromName, fs_vnode toFile, const char *toName); 129 status_t (*remove_attr)(fs_volume fs, fs_vnode file, const char *name); 130 131 /* index directory & index operations */ 132 status_t (*open_index_dir)(fs_volume fs, fs_cookie *cookie); 133 status_t (*close_index_dir)(fs_volume fs, fs_cookie cookie); 134 status_t (*free_index_dir_cookie)(fs_volume fs, fs_cookie cookie); 135 status_t (*read_index_dir)(fs_volume fs, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 136 status_t (*rewind_index_dir)(fs_volume fs, fs_cookie cookie); 137 138 status_t (*create_index)(fs_volume fs, const char *name, uint32 type, uint32 flags); 139 status_t (*remove_index)(fs_volume fs, const char *name); 140 status_t (*read_index_stat)(fs_volume fs, const char *name, struct stat *stat); 141 142 /* query operations */ 143 status_t (*open_query)(fs_volume fs, const char *query, uint32 flags, port_id port, uint32 token, fs_cookie *_cookie); 144 status_t (*close_query)(fs_volume fs, fs_cookie cookie); 145 status_t (*free_query_cookie)(fs_volume fs, fs_cookie cookie); 146 status_t (*read_query)(fs_volume fs, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 147 status_t (*rewind_query)(fs_volume fs, fs_cookie cookie); 148 } file_system_info; 149 150 151 /* file system add-ons only prototypes */ 152 extern status_t new_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode privateNode); 153 extern status_t get_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode *_privateNode); 154 extern status_t put_vnode(mount_id mountID, vnode_id vnodeID); 155 extern status_t remove_vnode(mount_id mountID, vnode_id vnodeID); 156 extern status_t unremove_vnode(mount_id mountID, vnode_id vnodeID); 157 158 extern status_t notify_listener(int op, mount_id device, vnode_id parentNode, 159 vnode_id toParentNode, vnode_id node, const char *name); 160 extern status_t send_notification(port_id port, long token, ulong what, long op, 161 mount_id device, mount_id toDevice, vnode_id parentNode, 162 vnode_id toParentNode, vnode_id node, const char *name); 163 164 #ifdef __cplusplus 165 } 166 #endif 167 168 #endif /* _FS_INTERFACE_H */ 169