1 /* 2 * Copyright 2002-2009, Axel Dörfler, axeld@pinc-software.de. 3 * Distributed under the terms of the MIT License. 4 * 5 * Copyright 2001-2002, Travis Geiselbrecht. All rights reserved. 6 * Distributed under the terms of the NewOS License. 7 */ 8 #ifndef _KERNEL_VFS_H 9 #define _KERNEL_VFS_H 10 11 12 #include <kernel.h> 13 #include <lock.h> 14 #include <util/list.h> 15 16 #include <fs_interface.h> 17 18 #include <dirent.h> 19 #include <signal.h> 20 #include <sys/socket.h> 21 #include <sys/stat.h> 22 #include <sys/select.h> 23 24 #include <vfs_defs.h> 25 26 27 #define DEFAULT_FD_TABLE_SIZE 256 28 #define MAX_FD_TABLE_SIZE 8192 29 #define DEFAULT_NODE_MONITORS 4096 30 #define MAX_NODE_MONITORS 65536 31 32 #define B_UNMOUNT_BUSY_PARTITION 0x80000000 33 34 struct attr_info; 35 struct file_descriptor; 36 struct kernel_args; 37 struct net_stat; 38 struct pollfd; 39 struct rlimit; 40 struct selectsync; 41 struct select_info; 42 struct VMCache; 43 struct vnode; 44 45 46 /** The I/O context of a process/team, holds the fd array among others */ 47 typedef struct io_context { 48 struct vnode *root; 49 struct vnode *cwd; 50 mutex io_mutex; 51 int32 ref_count; 52 uint32 table_size; 53 uint32 num_used_fds; 54 struct file_descriptor **fds; 55 struct select_info **select_infos; 56 uint8 *fds_close_on_exec; 57 struct list node_monitors; 58 uint32 num_monitors; 59 uint32 max_monitors; 60 } io_context; 61 62 /* macro to allocate a iovec array on the stack */ 63 #define IOVECS(name, size) \ 64 uint8 _##name[sizeof(iovecs) + (size)*sizeof(iovec)]; \ 65 iovecs *name = (iovecs *)_##name 66 67 68 #ifdef __cplusplus 69 extern "C" { 70 #endif 71 72 status_t vfs_init(struct kernel_args *args); 73 status_t vfs_bootstrap_file_systems(void); 74 void vfs_mount_boot_file_system(struct kernel_args *args); 75 void vfs_exec_io_context(io_context *context); 76 io_context *vfs_new_io_context(io_context *parentContext); 77 void vfs_get_io_context(io_context *context); 78 void vfs_put_io_context(io_context *context); 79 80 int vfs_getrlimit(int resource, struct rlimit *rlp); 81 int vfs_setrlimit(int resource, const struct rlimit *rlp); 82 83 /* calls needed by the VM for paging and by the file cache */ 84 int vfs_get_vnode_from_fd(int fd, bool kernel, struct vnode **_vnode); 85 status_t vfs_get_vnode_from_path(const char *path, bool kernel, 86 struct vnode **_vnode); 87 status_t vfs_get_vnode(dev_t mountID, ino_t vnodeID, bool canWait, 88 struct vnode **_vnode); 89 status_t vfs_entry_ref_to_vnode(dev_t mountID, ino_t directoryID, 90 const char *name, struct vnode **_vnode); 91 void vfs_vnode_to_node_ref(struct vnode *vnode, dev_t *_mountID, 92 ino_t *_vnodeID); 93 94 status_t vfs_lookup_vnode(dev_t mountID, ino_t vnodeID, 95 struct vnode **_vnode); 96 void vfs_put_vnode(struct vnode *vnode); 97 void vfs_acquire_vnode(struct vnode *vnode); 98 status_t vfs_get_cookie_from_fd(int fd, void **_cookie); 99 bool vfs_can_page(struct vnode *vnode, void *cookie); 100 status_t vfs_read_pages(struct vnode *vnode, void *cookie, off_t pos, 101 const iovec *vecs, size_t count, uint32 flags, 102 size_t *_numBytes); 103 status_t vfs_write_pages(struct vnode *vnode, void *cookie, off_t pos, 104 const iovec *vecs, size_t count, uint32 flags, 105 size_t *_numBytes); 106 status_t vfs_vnode_io(struct vnode* vnode, void* cookie, 107 io_request* request); 108 status_t vfs_synchronous_io(io_request* request, 109 status_t (*doIO)(void* cookie, off_t offset, void* buffer, 110 size_t* length), 111 void* cookie); 112 status_t vfs_get_vnode_cache(struct vnode *vnode, struct VMCache **_cache, 113 bool allocate); 114 status_t vfs_get_file_map(struct vnode *vnode, off_t offset, size_t size, 115 struct file_io_vec *vecs, size_t *_count); 116 status_t vfs_get_fs_node_from_path(fs_volume *volume, const char *path, 117 bool kernel, void **_node); 118 status_t vfs_stat_vnode(struct vnode *vnode, struct stat *stat); 119 status_t vfs_stat_node_ref(dev_t device, ino_t inode, struct stat *stat); 120 status_t vfs_get_vnode_name(struct vnode *vnode, char *name, 121 size_t nameSize); 122 status_t vfs_entry_ref_to_path(dev_t device, ino_t inode, const char *leaf, 123 char *path, size_t pathLength); 124 status_t vfs_get_cwd(dev_t *_mountID, ino_t *_vnodeID); 125 void vfs_unlock_vnode_if_locked(struct file_descriptor *descriptor); 126 status_t vfs_unmount(dev_t mountID, uint32 flags); 127 status_t vfs_disconnect_vnode(dev_t mountID, ino_t vnodeID); 128 void vfs_free_unused_vnodes(int32 level); 129 130 status_t vfs_read_stat(int fd, const char *path, bool traverseLeafLink, 131 struct stat *stat, bool kernel); 132 133 /* special module convenience call */ 134 status_t vfs_get_module_path(const char *basePath, const char *moduleName, 135 char *pathBuffer, size_t bufferSize); 136 137 /* service call for whoever needs a normalized path */ 138 status_t vfs_normalize_path(const char *path, char *buffer, 139 size_t bufferSize, bool traverseLink, bool kernel); 140 141 /* service call for whoever wants to create a special node */ 142 status_t vfs_create_special_node(const char *path, fs_vnode *subVnode, 143 mode_t mode, uint32 flags, bool kernel, fs_vnode *_superVnode, 144 struct vnode **_createdVnode); 145 146 /* service call for the node monitor */ 147 status_t resolve_mount_point_to_volume_root(dev_t mountID, ino_t nodeID, 148 dev_t *resolvedMountID, ino_t *resolvedNodeID); 149 150 /* calls the syscall dispatcher should use for user file I/O */ 151 dev_t _user_mount(const char *path, const char *device, 152 const char *fs_name, uint32 flags, const char *args, 153 size_t argsLength); 154 status_t _user_unmount(const char *path, uint32 flags); 155 status_t _user_read_fs_info(dev_t device, struct fs_info *info); 156 status_t _user_write_fs_info(dev_t device, const struct fs_info *info, 157 int mask); 158 dev_t _user_next_device(int32 *_cookie); 159 status_t _user_sync(void); 160 status_t _user_get_next_fd_info(team_id team, uint32 *cookie, 161 struct fd_info *info, size_t infoSize); 162 status_t _user_entry_ref_to_path(dev_t device, ino_t inode, const char *leaf, 163 char *userPath, size_t pathLength); 164 status_t _user_normalize_path(const char* userPath, bool traverseLink, 165 char* buffer); 166 int _user_open_entry_ref(dev_t device, ino_t inode, const char *name, 167 int openMode, int perms); 168 int _user_open(int fd, const char *path, int openMode, int perms); 169 int _user_open_dir_node_ref(dev_t device, ino_t inode); 170 int _user_open_dir_entry_ref(dev_t device, ino_t inode, 171 const char *name); 172 int _user_open_dir(int fd, const char *path); 173 int _user_open_parent_dir(int fd, char *name, size_t nameLength); 174 status_t _user_fcntl(int fd, int op, uint32 argument); 175 status_t _user_fsync(int fd); 176 status_t _user_flock(int fd, int op); 177 status_t _user_read_stat(int fd, const char *path, bool traverseLink, 178 struct stat *stat, size_t statSize); 179 status_t _user_write_stat(int fd, const char *path, bool traverseLink, 180 const struct stat *stat, size_t statSize, int statMask); 181 off_t _user_seek(int fd, off_t pos, int seekType); 182 status_t _user_create_dir_entry_ref(dev_t device, ino_t inode, 183 const char *name, int perms); 184 status_t _user_create_dir(int fd, const char *path, int perms); 185 status_t _user_remove_dir(int fd, const char *path); 186 status_t _user_read_link(int fd, const char *path, char *buffer, 187 size_t *_bufferSize); 188 status_t _user_write_link(const char *path, const char *toPath); 189 status_t _user_create_symlink(int fd, const char *path, const char *toPath, 190 int mode); 191 status_t _user_create_link(const char *path, const char *toPath); 192 status_t _user_unlink(int fd, const char *path); 193 status_t _user_rename(int oldFD, const char *oldpath, int newFD, 194 const char *newpath); 195 status_t _user_create_fifo(const char *path, mode_t perms); 196 status_t _user_create_pipe(int *fds); 197 status_t _user_access(const char *path, int mode); 198 ssize_t _user_select(int numfds, fd_set *readSet, fd_set *writeSet, 199 fd_set *errorSet, bigtime_t timeout, const sigset_t *sigMask); 200 ssize_t _user_poll(struct pollfd *fds, int numfds, bigtime_t timeout); 201 int _user_open_attr_dir(int fd, const char *path); 202 ssize_t _user_read_attr(int fd, const char *attribute, off_t pos, 203 void *buffer, size_t readBytes); 204 ssize_t _user_write_attr(int fd, const char *attribute, uint32 type, 205 off_t pos, const void *buffer, size_t readBytes); 206 status_t _user_stat_attr(int fd, const char *attribute, 207 struct attr_info *attrInfo); 208 int _user_open_attr(int fd, const char* path, const char *name, 209 uint32 type, int openMode); 210 status_t _user_remove_attr(int fd, const char *name); 211 status_t _user_rename_attr(int fromFile, const char *fromName, int toFile, 212 const char *toName); 213 int _user_open_index_dir(dev_t device); 214 status_t _user_create_index(dev_t device, const char *name, uint32 type, 215 uint32 flags); 216 status_t _user_read_index_stat(dev_t device, const char *name, 217 struct stat *stat); 218 status_t _user_remove_index(dev_t device, const char *name); 219 status_t _user_getcwd(char *buffer, size_t size); 220 status_t _user_setcwd(int fd, const char *path); 221 status_t _user_change_root(const char *path); 222 int _user_open_query(dev_t device, const char *query, 223 size_t queryLength, uint32 flags, port_id port, int32 token); 224 225 /* fd user prototypes (implementation located in fd.cpp) */ 226 ssize_t _user_read(int fd, off_t pos, void *buffer, size_t bufferSize); 227 ssize_t _user_readv(int fd, off_t pos, const iovec *vecs, size_t count); 228 ssize_t _user_write(int fd, off_t pos, const void *buffer, 229 size_t bufferSize); 230 ssize_t _user_writev(int fd, off_t pos, const iovec *vecs, size_t count); 231 status_t _user_ioctl(int fd, ulong cmd, void *data, size_t length); 232 ssize_t _user_read_dir(int fd, struct dirent *buffer, size_t bufferSize, 233 uint32 maxCount); 234 status_t _user_rewind_dir(int fd); 235 status_t _user_close(int fd); 236 int _user_dup(int fd); 237 int _user_dup2(int ofd, int nfd); 238 status_t _user_lock_node(int fd); 239 status_t _user_unlock_node(int fd); 240 241 /* socket user prototypes (implementation in socket.cpp) */ 242 int _user_socket(int family, int type, int protocol); 243 status_t _user_bind(int socket, const struct sockaddr *address, 244 socklen_t addressLength); 245 status_t _user_shutdown_socket(int socket, int how); 246 status_t _user_connect(int socket, const struct sockaddr *address, 247 socklen_t addressLength); 248 status_t _user_listen(int socket, int backlog); 249 int _user_accept(int socket, struct sockaddr *address, 250 socklen_t *_addressLength); 251 ssize_t _user_recv(int socket, void *data, size_t length, int flags); 252 ssize_t _user_recvfrom(int socket, void *data, size_t length, int flags, 253 struct sockaddr *address, socklen_t *_addressLength); 254 ssize_t _user_recvmsg(int socket, struct msghdr *message, int flags); 255 ssize_t _user_send(int socket, const void *data, size_t length, int flags); 256 ssize_t _user_sendto(int socket, const void *data, size_t length, int flags, 257 const struct sockaddr *address, socklen_t addressLength); 258 ssize_t _user_sendmsg(int socket, const struct msghdr *message, int flags); 259 status_t _user_getsockopt(int socket, int level, int option, void *value, 260 socklen_t *_length); 261 status_t _user_setsockopt(int socket, int level, int option, 262 const void *value, socklen_t length); 263 status_t _user_getpeername(int socket, struct sockaddr *address, 264 socklen_t *_addressLength); 265 status_t _user_getsockname(int socket, struct sockaddr *address, 266 socklen_t *_addressLength); 267 int _user_sockatmark(int socket); 268 status_t _user_socketpair(int family, int type, int protocol, 269 int *socketVector); 270 status_t _user_get_next_socket_stat(int family, uint32 *cookie, 271 struct net_stat *stat); 272 273 #ifdef __cplusplus 274 } 275 #endif 276 277 278 #ifdef __cplusplus 279 280 class AsyncIOCallback { 281 public: 282 virtual ~AsyncIOCallback(); 283 284 virtual void IOFinished(status_t status, 285 bool partialTransfer, 286 size_t bytesTransferred) = 0; 287 288 void operator delete(void* address, size_t size); 289 290 static status_t IORequestCallback(void* data, 291 io_request* request, status_t status, 292 bool partialTransfer, 293 size_t transferEndOffset); 294 }; 295 296 297 class StackableAsyncIOCallback : public AsyncIOCallback { 298 public: 299 StackableAsyncIOCallback(AsyncIOCallback* next); 300 301 protected: 302 AsyncIOCallback* fNextCallback; 303 }; 304 305 306 status_t vfs_asynchronous_read_pages(struct vnode* vnode, void* cookie, 307 off_t pos, const iovec* vecs, size_t count, size_t numBytes, 308 uint32 flags, AsyncIOCallback* callback); 309 310 status_t vfs_asynchronous_write_pages(struct vnode* vnode, void* cookie, 311 off_t pos, const iovec* vecs, size_t count, size_t numBytes, 312 uint32 flags, AsyncIOCallback* callback); 313 314 #endif // __cplusplus 315 316 #endif /* _KERNEL_VFS_H */ 317