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, uint32 mask); 78 status_t (*sync)(fs_volume fs); 79 80 /* vnode operations */ 81 status_t (*lookup)(fs_volume fs, fs_vnode dir, const char *name, vnode_id *_id, int *_type); 82 status_t (*get_vnode_name)(fs_volume fs, fs_vnode vnode, char *buffer, size_t bufferSize); 83 84 status_t (*get_vnode)(fs_volume fs, vnode_id id, fs_vnode *_vnode, bool reenter); 85 status_t (*put_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 86 status_t (*remove_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); 87 88 /* VM file access */ 89 bool (*can_page)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 90 status_t (*read_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, 91 const iovec *vecs, size_t count, size_t *_numBytes, bool reenter); 92 status_t (*write_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, 93 const iovec *vecs, size_t count, size_t *_numBytes, bool reenter); 94 95 /* cache file access */ 96 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); 97 98 /* common operations */ 99 status_t (*ioctl)(fs_volume fs, fs_vnode v, fs_cookie cookie, ulong op, void *buffer, size_t length); 100 status_t (*set_flags)(fs_volume fs, fs_vnode v, fs_cookie cookie, int flags); 101 status_t (*select)(fs_volume fs, fs_vnode v, fs_cookie cookie, uint8 event, 102 uint32 ref, selectsync *sync); 103 status_t (*deselect)(fs_volume fs, fs_vnode v, fs_cookie cookie, 104 uint8 event, selectsync *sync); 105 status_t (*fsync)(fs_volume fs, fs_vnode v); 106 107 status_t (*read_link)(fs_volume fs, fs_vnode link, char *buffer, size_t *_bufferSize); 108 status_t (*write_link)(fs_volume fs, fs_vnode link, char *toPath); 109 status_t (*create_symlink)(fs_volume fs, fs_vnode dir, const char *name, const char *path, int mode); 110 111 status_t (*link)(fs_volume fs, fs_vnode dir, const char *name, fs_vnode vnode); 112 status_t (*unlink)(fs_volume fs, fs_vnode dir, const char *name); 113 status_t (*rename)(fs_volume fs, fs_vnode fromDir, const char *fromName, fs_vnode toDir, const char *toName); 114 115 status_t (*access)(fs_volume fs, fs_vnode vnode, int mode); 116 status_t (*read_stat)(fs_volume fs, fs_vnode vnode, struct stat *stat); 117 status_t (*write_stat)(fs_volume fs, fs_vnode vnode, const struct stat *stat, uint32 statMask); 118 119 /* file operations */ 120 status_t (*create)(fs_volume fs, fs_vnode dir, const char *name, int openMode, int perms, fs_cookie *_cookie, vnode_id *_newVnodeID); 121 status_t (*open)(fs_volume fs, fs_vnode v, int openMode, fs_cookie *_cookie); 122 status_t (*close)(fs_volume fs, fs_vnode v, fs_cookie cookie); 123 status_t (*free_cookie)(fs_volume fs, fs_vnode v, fs_cookie cookie); 124 status_t (*read)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, void *buffer, size_t *length); 125 status_t (*write)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); 126 127 /* directory operations */ 128 status_t (*create_dir)(fs_volume fs, fs_vnode parent, const char *name, int perms, vnode_id *_newVnodeID); 129 status_t (*remove_dir)(fs_volume fs, fs_vnode parent, const char *name); 130 status_t (*open_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 131 status_t (*close_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 132 status_t (*free_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 133 status_t (*read_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 134 status_t (*rewind_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 135 136 /* attribute directory operations */ 137 status_t (*open_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); 138 status_t (*close_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 139 status_t (*free_attr_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 140 status_t (*read_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 141 status_t (*rewind_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); 142 143 /* attribute operations */ 144 status_t (*create_attr)(fs_volume fs, fs_vnode file, const char *name, uint32 type, int openMode, fs_cookie *_cookie); 145 status_t (*open_attr)(fs_volume fs, fs_vnode file, const char *name, int openMode, fs_cookie *_cookie); 146 status_t (*close_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie); 147 status_t (*free_attr_cookie)(fs_volume fs, fs_vnode file, fs_cookie cookie); 148 status_t (*read_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, void *buffer, size_t *length); 149 status_t (*write_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); 150 151 status_t (*read_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, struct stat *stat); 152 status_t (*write_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, const struct stat *stat, int statMask); 153 status_t (*rename_attr)(fs_volume fs, fs_vnode fromFile, const char *fromName, fs_vnode toFile, const char *toName); 154 status_t (*remove_attr)(fs_volume fs, fs_vnode file, const char *name); 155 156 /* index directory & index operations */ 157 status_t (*open_index_dir)(fs_volume fs, fs_cookie *cookie); 158 status_t (*close_index_dir)(fs_volume fs, fs_cookie cookie); 159 status_t (*free_index_dir_cookie)(fs_volume fs, fs_cookie cookie); 160 status_t (*read_index_dir)(fs_volume fs, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); 161 status_t (*rewind_index_dir)(fs_volume fs, fs_cookie cookie); 162 163 status_t (*create_index)(fs_volume fs, const char *name, uint32 type, uint32 flags); 164 status_t (*remove_index)(fs_volume fs, const char *name); 165 status_t (*read_index_stat)(fs_volume fs, const char *name, struct stat *stat); 166 167 /* query operations */ 168 status_t (*open_query)(fs_volume fs, const char *query, uint32 flags, port_id port, uint32 token, fs_cookie *_cookie); 169 status_t (*close_query)(fs_volume fs, fs_cookie cookie); 170 status_t (*free_query_cookie)(fs_volume fs, fs_cookie cookie); 171 status_t (*read_query)(fs_volume fs, fs_cookie cookie, 172 struct dirent *buffer, size_t bufferSize, uint32 *_num); 173 status_t (*rewind_query)(fs_volume fs, fs_cookie cookie); 174 175 /* capability querying (the device is read locked) */ 176 // ToDo: this will probably be combined to a single call 177 bool (*supports_defragmenting)(partition_data *partition, 178 bool *whileMounted); 179 bool (*supports_repairing)(partition_data *partition, 180 bool checkOnly, bool *whileMounted); 181 bool (*supports_resizing)(partition_data *partition, 182 bool *whileMounted); 183 bool (*supports_moving)(partition_data *partition, bool *isNoOp); 184 bool (*supports_setting_content_name)(partition_data *partition, 185 bool *whileMounted); 186 bool (*supports_setting_content_parameters)(partition_data *partition, 187 bool *whileMounted); 188 bool (*supports_initializing)(partition_data *partition); 189 190 bool (*validate_resize)(partition_data *partition, off_t *size); 191 bool (*validate_move)(partition_data *partition, off_t *start); 192 bool (*validate_set_content_name)(partition_data *partition, 193 char *name); 194 bool (*validate_set_content_parameters)(partition_data *partition, 195 const char *parameters); 196 bool (*validate_initialize)(partition_data *partition, char *name, 197 const char *parameters); 198 199 /* shadow partition modification (device is write locked) */ 200 status_t (*shadow_changed)(partition_data *partition, 201 uint32 operation); 202 203 /* writing (the device is NOT locked) */ 204 status_t (*defragment)(int fd, partition_id partition, 205 disk_job_id job); 206 status_t (*repair)(int fd, partition_id partition, bool checkOnly, 207 disk_job_id job); 208 status_t (*resize)(int fd, partition_id partition, off_t size, 209 disk_job_id job); 210 status_t (*move)(int fd, partition_id partition, off_t offset, 211 disk_job_id job); 212 status_t (*set_content_name)(int fd, partition_id partition, 213 const char *name, disk_job_id job); 214 status_t (*set_content_parameters)(int fd, partition_id partition, 215 const char *parameters, disk_job_id job); 216 status_t (*initialize)(const char *partition, const char *name, 217 const char *parameters, disk_job_id job); 218 // This is pretty close to how the hook in R5 looked. Save the job ID, of 219 // course and that the parameters were given as (void*, size_t) pair. 220 } file_system_module_info; 221 222 223 /* file system add-ons only prototypes */ 224 extern status_t new_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode privateNode); 225 extern status_t publish_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode privateNode); 226 extern status_t get_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode *_privateNode); 227 extern status_t put_vnode(mount_id mountID, vnode_id vnodeID); 228 extern status_t remove_vnode(mount_id mountID, vnode_id vnodeID); 229 extern status_t unremove_vnode(mount_id mountID, vnode_id vnodeID); 230 231 extern status_t notify_listener(int op, mount_id device, vnode_id parentNode, 232 vnode_id toParentNode, vnode_id node, const char *name); 233 extern status_t send_notification(port_id port, long token, ulong what, long op, 234 mount_id device, mount_id toDevice, vnode_id parentNode, 235 vnode_id toParentNode, vnode_id node, const char *name); 236 237 extern status_t notify_entry_created(mount_id device, vnode_id directory, 238 const char *name, vnode_id node); 239 extern status_t notify_entry_removed(mount_id device, vnode_id directory, 240 const char *name, vnode_id node); 241 extern status_t notify_entry_moved(mount_id device, vnode_id fromDirectory, 242 const char *fromName, vnode_id toDirectory, 243 const char *toName, vnode_id node); 244 extern status_t notify_stat_changed(mount_id device, vnode_id node, 245 uint32 statFields); 246 extern status_t notify_attribute_changed(mount_id device, vnode_id node, 247 const char *attribute, int32 cause); 248 249 extern status_t notify_query_entry_created(port_id port, int32 token, 250 mount_id device, vnode_id directory, const char *name, 251 vnode_id node); 252 extern status_t notify_query_entry_removed(port_id port, int32 token, 253 mount_id device, vnode_id directory, const char *name, 254 vnode_id node); 255 256 #ifdef __cplusplus 257 } 258 #endif 259 260 #endif /* _FS_INTERFACE_H */ 261