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