1 /* File System Interface Layer Definition 2 * 3 * Copyright 2004-2006, Haiku Inc. All Rights Reserved. 4 * Distributed under the terms of the MIT License. 5 */ 6 #ifndef _FS_INTERFACE_H 7 #define _FS_INTERFACE_H 8 9 10 #include <OS.h> 11 #include <Select.h> 12 #include <module.h> 13 #include <disk_device_manager.h> 14 15 #include <sys/uio.h> 16 17 18 struct dirent; 19 struct stat; 20 struct fs_info; 21 struct select_sync; 22 23 typedef dev_t mount_id; 24 typedef ino_t vnode_id; 25 26 /* the file system's private data structures */ 27 typedef void *fs_volume; 28 typedef void *fs_cookie; 29 typedef void *fs_vnode; 30 31 /* passed to write_stat() */ 32 enum write_stat_mask { 33 FS_WRITE_STAT_MODE = 0x0001, 34 FS_WRITE_STAT_UID = 0x0002, 35 FS_WRITE_STAT_GID = 0x0004, 36 FS_WRITE_STAT_SIZE = 0x0008, 37 FS_WRITE_STAT_ATIME = 0x0010, 38 FS_WRITE_STAT_MTIME = 0x0020, 39 FS_WRITE_STAT_CRTIME = 0x0040 40 // NOTE: Changing these constants will break 41 // src/kits/storage/LibBeAdapter.cpp:_kern_write_stat(). 42 }; 43 44 /* passed to write_fs_info() */ 45 #define FS_WRITE_FSINFO_NAME 0x0001 46 47 struct file_io_vec { 48 off_t offset; 49 off_t length; 50 }; 51 52 #define B_CURRENT_FS_API_VERSION "/v1" 53 54 #ifdef __cplusplus 55 extern "C" { 56 #endif 57 58 typedef struct file_system_module_info { 59 struct module_info info; 60 const char *pretty_name; 61 62 /* scanning (the device is write locked) */ 63 float (*identify_partition)(int fd, partition_data *partition, 64 void **cookie); 65 status_t (*scan_partition)(int fd, partition_data *partition, 66 void *cookie); 67 void (*free_identify_partition_cookie)(partition_data *partition, 68 void *cookie); 69 void (*free_partition_content_cookie)(partition_data *partition); 70 71 /* general operations */ 72 status_t (*mount)(mount_id id, const char *device, uint32 flags, 73 const char *args, fs_volume *_fs, vnode_id *_rootVnodeID); 74 status_t (*unmount)(fs_volume fs); 75 76 status_t (*read_fs_info)(fs_volume fs, struct fs_info *info); 77 status_t (*write_fs_info)(fs_volume fs, const struct fs_info *info, 78 uint32 mask); 79 status_t (*sync)(fs_volume fs); 80 81 /* vnode operations */ 82 status_t (*lookup)(fs_volume fs, fs_vnode dir, const char *name, 83 vnode_id *_id, int *_type); 84 status_t (*get_vnode_name)(fs_volume fs, fs_vnode vnode, char *buffer, 85 size_t bufferSize); 86 87 status_t (*get_vnode)(fs_volume fs, vnode_id id, fs_vnode *_vnode, 88 bool reenter); 89 status_t (*put_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 90 status_t (*remove_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 91 92 /* VM file access */ 93 bool (*can_page)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 94 status_t (*read_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 95 off_t pos, const iovec *vecs, size_t count, size_t *_numBytes, 96 bool reenter); 97 status_t (*write_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 98 off_t pos, const iovec *vecs, size_t count, size_t *_numBytes, 99 bool reenter); 100 101 /* cache file access */ 102 status_t (*get_file_map)(fs_volume fs, fs_vnode vnode, off_t offset, 103 size_t size, struct file_io_vec *vecs, size_t *_count); 104 105 /* common operations */ 106 status_t (*ioctl)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, ulong op, 107 void *buffer, size_t length); 108 status_t (*set_flags)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 109 int flags); 110 status_t (*select)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 111 uint8 event, uint32 ref, selectsync *sync); 112 status_t (*deselect)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 113 uint8 event, selectsync *sync); 114 status_t (*fsync)(fs_volume fs, fs_vnode vnode); 115 116 status_t (*read_link)(fs_volume fs, fs_vnode link, char *buffer, 117 size_t *_bufferSize); 118 status_t (*write_link)(fs_volume fs, fs_vnode link, char *toPath); 119 status_t (*create_symlink)(fs_volume fs, fs_vnode dir, const char *name, 120 const char *path, int mode); 121 122 status_t (*link)(fs_volume fs, fs_vnode dir, const char *name, 123 fs_vnode vnode); 124 status_t (*unlink)(fs_volume fs, fs_vnode dir, const char *name); 125 status_t (*rename)(fs_volume fs, fs_vnode fromDir, const char *fromName, 126 fs_vnode toDir, const char *toName); 127 128 status_t (*access)(fs_volume fs, fs_vnode vnode, int mode); 129 status_t (*read_stat)(fs_volume fs, fs_vnode vnode, struct stat *stat); 130 status_t (*write_stat)(fs_volume fs, fs_vnode vnode, 131 const struct stat *stat, uint32 statMask); 132 133 /* file operations */ 134 status_t (*create)(fs_volume fs, fs_vnode dir, const char *name, 135 int openMode, int perms, fs_cookie *_cookie, 136 vnode_id *_newVnodeID); 137 status_t (*open)(fs_volume fs, fs_vnode vnode, int openMode, 138 fs_cookie *_cookie); 139 status_t (*close)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 140 status_t (*free_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 141 status_t (*read)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, 142 void *buffer, size_t *length); 143 status_t (*write)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, 144 const void *buffer, size_t *length); 145 146 /* directory operations */ 147 status_t (*create_dir)(fs_volume fs, fs_vnode parent, const char *name, 148 int perms, vnode_id *_newVnodeID); 149 status_t (*remove_dir)(fs_volume fs, fs_vnode parent, const char *name); 150 status_t (*open_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 151 status_t (*close_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 152 status_t (*free_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 153 status_t (*read_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 154 struct dirent *buffer, size_t bufferSize, uint32 *_num); 155 status_t (*rewind_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 156 157 /* attribute directory operations */ 158 status_t (*open_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 159 status_t (*close_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 160 status_t (*free_attr_dir_cookie)(fs_volume fs, fs_vnode vnode, 161 fs_cookie cookie); 162 status_t (*read_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 163 struct dirent *buffer, size_t bufferSize, uint32 *_num); 164 status_t (*rewind_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 165 166 /* attribute operations */ 167 status_t (*create_attr)(fs_volume fs, fs_vnode vnode, const char *name, 168 uint32 type, int openMode, fs_cookie *_cookie); 169 status_t (*open_attr)(fs_volume fs, fs_vnode vnode, const char *name, 170 int openMode, fs_cookie *_cookie); 171 status_t (*close_attr)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 172 status_t (*free_attr_cookie)(fs_volume fs, fs_vnode vnode, 173 fs_cookie cookie); 174 status_t (*read_attr)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 175 off_t pos, void *buffer, size_t *length); 176 status_t (*write_attr)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 177 off_t pos, const void *buffer, size_t *length); 178 179 status_t (*read_attr_stat)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 180 struct stat *stat); 181 status_t (*write_attr_stat)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, 182 const struct stat *stat, int statMask); 183 status_t (*rename_attr)(fs_volume fs, fs_vnode fromVnode, 184 const char *fromName, fs_vnode toVnode, const char *toName); 185 status_t (*remove_attr)(fs_volume fs, fs_vnode vnode, const char *name); 186 187 /* index directory & index operations */ 188 status_t (*open_index_dir)(fs_volume fs, fs_cookie *cookie); 189 status_t (*close_index_dir)(fs_volume fs, fs_cookie cookie); 190 status_t (*free_index_dir_cookie)(fs_volume fs, fs_cookie cookie); 191 status_t (*read_index_dir)(fs_volume fs, fs_cookie cookie, 192 struct dirent *buffer, size_t bufferSize, uint32 *_num); 193 status_t (*rewind_index_dir)(fs_volume fs, fs_cookie cookie); 194 195 status_t (*create_index)(fs_volume fs, const char *name, uint32 type, 196 uint32 flags); 197 status_t (*remove_index)(fs_volume fs, const char *name); 198 status_t (*read_index_stat)(fs_volume fs, const char *name, 199 struct stat *stat); 200 201 /* query operations */ 202 status_t (*open_query)(fs_volume fs, const char *query, uint32 flags, 203 port_id port, uint32 token, fs_cookie *_cookie); 204 status_t (*close_query)(fs_volume fs, fs_cookie cookie); 205 status_t (*free_query_cookie)(fs_volume fs, fs_cookie cookie); 206 status_t (*read_query)(fs_volume fs, fs_cookie cookie, 207 struct dirent *buffer, size_t bufferSize, uint32 *_num); 208 status_t (*rewind_query)(fs_volume fs, fs_cookie cookie); 209 210 /* capability querying (the device is read locked) */ 211 // ToDo: this will probably be combined to a single call 212 bool (*supports_defragmenting)(partition_data *partition, 213 bool *whileMounted); 214 bool (*supports_repairing)(partition_data *partition, 215 bool checkOnly, bool *whileMounted); 216 bool (*supports_resizing)(partition_data *partition, 217 bool *whileMounted); 218 bool (*supports_moving)(partition_data *partition, bool *isNoOp); 219 bool (*supports_setting_content_name)(partition_data *partition, 220 bool *whileMounted); 221 bool (*supports_setting_content_parameters)(partition_data *partition, 222 bool *whileMounted); 223 bool (*supports_initializing)(partition_data *partition); 224 225 bool (*validate_resize)(partition_data *partition, off_t *size); 226 bool (*validate_move)(partition_data *partition, off_t *start); 227 bool (*validate_set_content_name)(partition_data *partition, 228 char *name); 229 bool (*validate_set_content_parameters)(partition_data *partition, 230 const char *parameters); 231 bool (*validate_initialize)(partition_data *partition, char *name, 232 const char *parameters); 233 234 /* shadow partition modification (device is write locked) */ 235 status_t (*shadow_changed)(partition_data *partition, 236 uint32 operation); 237 238 /* writing (the device is NOT locked) */ 239 status_t (*defragment)(int fd, partition_id partition, 240 disk_job_id job); 241 status_t (*repair)(int fd, partition_id partition, bool checkOnly, 242 disk_job_id job); 243 status_t (*resize)(int fd, partition_id partition, off_t size, 244 disk_job_id job); 245 status_t (*move)(int fd, partition_id partition, off_t offset, 246 disk_job_id job); 247 status_t (*set_content_name)(int fd, partition_id partition, 248 const char *name, disk_job_id job); 249 status_t (*set_content_parameters)(int fd, partition_id partition, 250 const char *parameters, disk_job_id job); 251 status_t (*initialize)(const char *partition, const char *name, 252 const char *parameters, disk_job_id job); 253 // This is pretty close to how the hook in R5 looked. Save the job ID, 254 // of course and that the parameters were given as (void*, size_t) pair. 255 } file_system_module_info; 256 257 258 /* file system add-ons only prototypes */ 259 extern status_t new_vnode(mount_id mountID, vnode_id vnodeID, 260 fs_vnode privateNode); 261 extern status_t publish_vnode(mount_id mountID, vnode_id vnodeID, 262 fs_vnode privateNode); 263 extern status_t get_vnode(mount_id mountID, vnode_id vnodeID, 264 fs_vnode *_privateNode); 265 extern status_t put_vnode(mount_id mountID, vnode_id vnodeID); 266 extern status_t remove_vnode(mount_id mountID, vnode_id vnodeID); 267 extern status_t unremove_vnode(mount_id mountID, vnode_id vnodeID); 268 extern status_t unremove_vnode(mount_id mountID, vnode_id vnodeID); 269 extern status_t is_vnode_removed(mount_id mountID, vnode_id vnodeID); 270 271 extern status_t notify_listener(int op, mount_id device, vnode_id parentNode, 272 vnode_id toParentNode, vnode_id node, const char *name); 273 extern status_t send_notification(port_id port, long token, ulong what, long op, 274 mount_id device, mount_id toDevice, vnode_id parentNode, 275 vnode_id toParentNode, vnode_id node, const char *name); 276 277 extern status_t notify_entry_created(mount_id device, vnode_id directory, 278 const char *name, vnode_id node); 279 extern status_t notify_entry_removed(mount_id device, vnode_id directory, 280 const char *name, vnode_id node); 281 extern status_t notify_entry_moved(mount_id device, vnode_id fromDirectory, 282 const char *fromName, vnode_id toDirectory, 283 const char *toName, vnode_id node); 284 extern status_t notify_stat_changed(mount_id device, vnode_id node, 285 uint32 statFields); 286 extern status_t notify_attribute_changed(mount_id device, vnode_id node, 287 const char *attribute, int32 cause); 288 289 extern status_t notify_query_entry_created(port_id port, int32 token, 290 mount_id device, vnode_id directory, const char *name, 291 vnode_id node); 292 extern status_t notify_query_entry_removed(port_id port, int32 token, 293 mount_id device, vnode_id directory, const char *name, 294 vnode_id node); 295 296 #ifdef __cplusplus 297 } 298 #endif 299 300 #endif /* _FS_INTERFACE_H */ 301