paul@90 | 1 | /* |
paul@90 | 2 | * Filesystem client functions. |
paul@90 | 3 | * |
paul@634 | 4 | * Copyright (C) 2018-2024 Paul Boddie <paul@boddie.org.uk> |
paul@90 | 5 | * |
paul@90 | 6 | * This program is free software; you can redistribute it and/or |
paul@90 | 7 | * modify it under the terms of the GNU General Public License as |
paul@90 | 8 | * published by the Free Software Foundation; either version 2 of |
paul@90 | 9 | * the License, or (at your option) any later version. |
paul@90 | 10 | * |
paul@90 | 11 | * This program is distributed in the hope that it will be useful, |
paul@90 | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
paul@90 | 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
paul@90 | 14 | * GNU General Public License for more details. |
paul@90 | 15 | * |
paul@90 | 16 | * You should have received a copy of the GNU General Public License |
paul@90 | 17 | * along with this program; if not, write to the Free Software |
paul@90 | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, |
paul@90 | 19 | * Boston, MA 02110-1301, USA |
paul@90 | 20 | */ |
paul@90 | 21 | |
paul@90 | 22 | #pragma once |
paul@90 | 23 | |
paul@174 | 24 | #include <dirent.h> |
paul@99 | 25 | #include <fsclient/file.h> |
paul@99 | 26 | |
paul@99 | 27 | |
paul@90 | 28 | |
paul@90 | 29 | EXTERN_C_BEGIN |
paul@90 | 30 | |
paul@144 | 31 | /* Filesystem access operations. */ |
paul@144 | 32 | |
paul@150 | 33 | l4_cap_idx_t client_open_for_user(user_t user); |
paul@150 | 34 | l4_cap_idx_t client_open_for_user_using(user_t user, l4_cap_idx_t server); |
paul@144 | 35 | |
paul@584 | 36 | /* Stream access operations. */ |
paul@584 | 37 | |
paul@584 | 38 | file_t *client_get_stream(const char *name, flags_t flags); |
paul@663 | 39 | long client_sync_stream(file_t *file); |
paul@584 | 40 | |
paul@117 | 41 | /* Opening and closing operations. */ |
paul@90 | 42 | |
paul@90 | 43 | void client_close(file_t *file); |
paul@90 | 44 | file_t *client_open(const char *name, flags_t flags); |
paul@144 | 45 | file_t *client_open_using(const char *name, flags_t flags, l4_cap_idx_t server); |
paul@144 | 46 | |
paul@204 | 47 | file_t *client_opendir(const char *name); |
paul@204 | 48 | file_t *client_opendir_using(const char *name, l4_cap_idx_t server); |
paul@204 | 49 | |
paul@658 | 50 | file_t *client_opendir_reader(file_t *file); |
paul@475 | 51 | file_t *client_reopen(file_t *file, flags_t flags); |
paul@175 | 52 | |
paul@178 | 53 | long client_pipe(file_t **reader, file_t **writer, flags_t flags); |
paul@178 | 54 | long client_pipe_using(file_t **reader, file_t **writer, flags_t flags, l4_cap_idx_t server); |
paul@90 | 55 | |
paul@402 | 56 | /* File status testing. */ |
paul@402 | 57 | |
paul@402 | 58 | int client_opened(file_t *file); |
paul@402 | 59 | |
paul@232 | 60 | /* Other file operations. */ |
paul@232 | 61 | |
paul@271 | 62 | long client_mkdir(const char *path, mode_t mode); |
paul@271 | 63 | long client_mkdir_using(const char *path, mode_t mode, l4_cap_idx_t server); |
paul@271 | 64 | |
paul@266 | 65 | long client_remove(const char *path); |
paul@266 | 66 | long client_remove_using(const char *path, l4_cap_idx_t server); |
paul@232 | 67 | |
paul@236 | 68 | long client_rename(const char *source, const char *target); |
paul@236 | 69 | long client_rename_using(const char *source, const char *target, l4_cap_idx_t server); |
paul@236 | 70 | |
paul@266 | 71 | long client_stat(const char *path, struct stat *st); |
paul@266 | 72 | long client_stat_using(const char *path, struct stat *st, l4_cap_idx_t server); |
paul@266 | 73 | |
paul@90 | 74 | /* File and region operations. */ |
paul@90 | 75 | |
paul@90 | 76 | long client_flush(file_t *file); |
paul@339 | 77 | void *client_mmap(file_t *file, offset_t position, offset_t length, |
paul@339 | 78 | offset_t start_visible, offset_t end_visible, |
paul@634 | 79 | rm_flags_t region_flags); |
paul@634 | 80 | rm_flags_t client_region_flags(prot_t prot, flags_t flags); |
paul@90 | 81 | |
paul@90 | 82 | /* Pipe region operations. */ |
paul@90 | 83 | |
paul@116 | 84 | long client_current_region(file_t *file); |
paul@116 | 85 | long client_next_region(file_t *file); |
paul@90 | 86 | |
paul@90 | 87 | /* File data operations. */ |
paul@90 | 88 | |
paul@90 | 89 | offset_t client_read(file_t *file, void *buf, offset_t count); |
paul@90 | 90 | offset_t client_write(file_t *file, const void *buf, offset_t count); |
paul@90 | 91 | |
paul@90 | 92 | /* File navigation operations. */ |
paul@90 | 93 | |
paul@90 | 94 | offset_t client_seek(file_t *file, offset_t offset, int whence); |
paul@411 | 95 | offset_t client_tell(file_t *file); |
paul@90 | 96 | |
paul@174 | 97 | /* Directory reading operations. */ |
paul@174 | 98 | |
paul@174 | 99 | struct dirent *client_readdir(file_t *file); |
paul@658 | 100 | void client_rewinddir(file_t *file); |
paul@174 | 101 | |
paul@117 | 102 | /* Notification operations. */ |
paul@117 | 103 | |
paul@122 | 104 | long client_set_blocking(file_t *file, notify_flags_t flags); |
paul@180 | 105 | |
paul@180 | 106 | /* More advanced notification operations. */ |
paul@180 | 107 | |
paul@575 | 108 | void client_notifier_close(notifier_t *notifier); |
paul@575 | 109 | notifier_t *client_notifier_local(void); |
paul@575 | 110 | notifier_t *client_notifier_task(void); |
paul@180 | 111 | |
paul@575 | 112 | long client_subscribe(file_t *file, notify_flags_t flags, notifier_t *notifier); |
paul@575 | 113 | long client_unsubscribe(file_t *file, notifier_t *notifier); |
paul@575 | 114 | |
paul@575 | 115 | long client_wait_file(file_t *file, notifier_t *notifier); |
paul@575 | 116 | long client_wait_files(file_t **file, notifier_t *notifier); |
paul@117 | 117 | |
paul@90 | 118 | EXTERN_C_END |
paul@90 | 119 | |
paul@90 | 120 | // vim: tabstop=2 expandtab shiftwidth=2 |