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