L4Re/departure

Annotated libfsclient/include/fsclient/client.h

330:12b7393c13dc
2022-05-19 Paul Boddie Introduced a region flags parameter to mmap operations to potentially control the attributes of allocated memory, this being necessary when memory must be marked as executable. mmap-region-flags
paul@90 1
/*
paul@90 2
 * Filesystem client functions.
paul@90 3
 *
paul@236 4
 * Copyright (C) 2018, 2019, 2020, 2021, 2022 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@117 36
/* Opening and closing operations. */
paul@90 37
paul@90 38
void client_close(file_t *file);
paul@90 39
file_t *client_open(const char *name, flags_t flags);
paul@144 40
file_t *client_open_using(const char *name, flags_t flags, l4_cap_idx_t server);
paul@144 41
paul@204 42
file_t *client_opendir(const char *name);
paul@204 43
file_t *client_opendir_using(const char *name, l4_cap_idx_t server);
paul@204 44
paul@204 45
file_t *client_opendir_at(file_t *file);
paul@175 46
paul@178 47
long client_pipe(file_t **reader, file_t **writer, flags_t flags);
paul@178 48
long client_pipe_using(file_t **reader, file_t **writer, flags_t flags, l4_cap_idx_t server);
paul@90 49
paul@232 50
/* Other file operations. */
paul@232 51
paul@271 52
long client_mkdir(const char *path, mode_t mode);
paul@271 53
long client_mkdir_using(const char *path, mode_t mode, l4_cap_idx_t server);
paul@271 54
paul@266 55
long client_remove(const char *path);
paul@266 56
long client_remove_using(const char *path, l4_cap_idx_t server);
paul@232 57
paul@236 58
long client_rename(const char *source, const char *target);
paul@236 59
long client_rename_using(const char *source, const char *target, l4_cap_idx_t server);
paul@236 60
paul@266 61
long client_stat(const char *path, struct stat *st);
paul@266 62
long client_stat_using(const char *path, struct stat *st, l4_cap_idx_t server);
paul@266 63
paul@90 64
/* File and region operations. */
paul@90 65
paul@90 66
long client_flush(file_t *file);
paul@330 67
void *client_mmap(file_t *file, offset_t position, offset_t length, l4re_rm_flags_t region_flags);
paul@330 68
l4re_rm_flags_t client_region_flags(prot_t prot, flags_t flags);
paul@90 69
paul@90 70
/* Pipe region operations. */
paul@90 71
paul@116 72
long client_current_region(file_t *file);
paul@116 73
long client_next_region(file_t *file);
paul@90 74
paul@90 75
/* File data operations. */
paul@90 76
paul@90 77
offset_t client_read(file_t *file, void *buf, offset_t count);
paul@90 78
offset_t client_write(file_t *file, const void *buf, offset_t count);
paul@90 79
paul@90 80
/* File navigation operations. */
paul@90 81
paul@90 82
offset_t client_seek(file_t *file, offset_t offset, int whence);
paul@90 83
long client_tell(file_t *file);
paul@90 84
paul@174 85
/* Directory reading operations. */
paul@174 86
paul@174 87
struct dirent *client_readdir(file_t *file);
paul@174 88
paul@117 89
/* Notification operations. */
paul@117 90
paul@122 91
long client_set_blocking(file_t *file, notify_flags_t flags);
paul@180 92
paul@180 93
/* More advanced notification operations. */
paul@180 94
paul@180 95
void client_notifier_close(file_notifier_t *notifier);
paul@180 96
file_notifier_t *client_notifier_local(void);
paul@180 97
file_notifier_t *client_notifier_task(void);
paul@180 98
paul@180 99
long client_subscribe(file_t *file, notify_flags_t flags, file_notifier_t *notifier);
paul@180 100
long client_unsubscribe(file_t *file, file_notifier_t *notifier);
paul@180 101
long client_wait_file(file_t *file, file_notifier_t *notifier);
paul@180 102
long client_wait_files(file_t **file, file_notifier_t *notifier);
paul@117 103
paul@90 104
EXTERN_C_END
paul@90 105
paul@90 106
// vim: tabstop=2 expandtab shiftwidth=2