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