1 /* 2 * File access convenience functions and types. 3 * 4 * Copyright (C) 2021 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 * Boston, MA 02110-1301, USA 20 */ 21 22 #pragma once 23 24 #include <l4/sys/types.h> 25 26 #include <systypes/base.h> 27 #include <systypes/user.h> 28 29 30 31 EXTERN_C_BEGIN 32 33 /* File access abstraction. */ 34 35 typedef struct 36 { 37 /* File object reference. */ 38 39 l4_cap_idx_t ref; 40 41 /* Mapped memory accessing a file region. */ 42 43 char *memory; 44 45 /* File region parameters. */ 46 47 offset_t start_pos, end_pos; /* start and end positions of region */ 48 offset_t data_end; /* amount/extent of data in the region */ 49 offset_t data_current; /* client access offset */ 50 51 /* Total size of file. */ 52 53 offset_t size; 54 55 /* Support for arbitrary memory mapping and explicit object size. */ 56 57 object_flags_t object_flags; 58 59 /* Blocking accesses. */ 60 61 notify_flags_t can_block; 62 63 /* Saved notifications. */ 64 65 notify_flags_t notifications; 66 67 } file_t; 68 69 70 71 /* Notifier types. */ 72 73 typedef enum 74 { 75 NOTIFIER_TASK = 0, 76 NOTIFIER_THREAD = 1, 77 78 } notifier_t; 79 80 81 82 /* Filesystem operations. */ 83 84 long file_open_for_user(user_t user, l4_cap_idx_t server, l4_cap_idx_t *opener); 85 86 /* File operations. */ 87 88 void file_close(file_t *file); 89 long file_open(file_t *file, const char *filename, flags_t flags, l4_cap_idx_t server); 90 91 /* File lifecycle operations. */ 92 93 long file_context(file_t *file, l4_cap_idx_t server); 94 long file_context_open(file_t *file, flags_t flags, file_t *context); 95 void file_init(file_t *file); 96 97 /* File and region operations. */ 98 99 long file_flush(file_t *file); 100 long file_mmap(file_t *file, offset_t position, offset_t length); 101 long file_resize(file_t *file, offset_t size); 102 103 /* File and region properties. */ 104 105 offset_t file_populated_span(file_t *file); 106 offset_t file_span(file_t *file); 107 108 /* Convenience functions. */ 109 110 char *file_string_get(file_t *file, offset_t offset); 111 int file_string_set(file_t *file, const char *data, offset_t offset, offset_t *written); 112 113 /* Client data functions. */ 114 115 offset_t file_data_available(file_t *file); 116 char *file_data_current(file_t *file); 117 offset_t file_data_current_position(file_t *file); 118 offset_t file_data_end_position(file_t *file); 119 offset_t file_data_space(file_t *file); 120 121 /* Client data transfer functions. */ 122 123 void file_data_read(file_t *file, char *buf, offset_t to_transfer); 124 void file_data_write(file_t *file, char *buf, offset_t to_transfer); 125 126 /* Notification functions. */ 127 128 long file_notify_subscribe(file_t *file, notify_flags_t flags, notifier_t notifier_type); 129 long file_notify_unsubscribe(file_t *file, notifier_t notifier_type); 130 long file_notify_wait_file(file_t *file); 131 long file_notify_wait_files(file_t **file); 132 133 134 135 /* Pipe operations. */ 136 137 long pipe_open(offset_t size, file_t *reader, file_t *writer, l4_cap_idx_t server); 138 139 /* Pipe region operations. */ 140 141 long pipe_current(file_t *pipe); 142 long pipe_next(file_t *pipe); 143 long pipe_written(file_t *pipe, offset_t size); 144 145 146 147 EXTERN_C_END 148 149 // vim: tabstop=2 expandtab shiftwidth=2