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