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 28 29 30 EXTERN_C_BEGIN 31 32 /* File access abstraction. */ 33 34 typedef struct 35 { 36 /* File object reference. */ 37 38 l4_cap_idx_t ref; 39 40 /* Notification endpoint reference. */ 41 42 l4_cap_idx_t notifier; 43 44 /* Mapped memory accessing a file region. */ 45 46 char *memory; 47 48 /* File region parameters. */ 49 50 offset_t start_pos, end_pos; /* start and end positions of region */ 51 offset_t data_end; /* amount/extent of data in the region */ 52 offset_t data_current; /* client access offset */ 53 54 /* Total size of file. */ 55 56 offset_t size; 57 58 /* Arbitrary memory mapping support. */ 59 60 int can_mmap; 61 62 /* Explicit size support. */ 63 64 int has_size; 65 66 /* Blocking accesses. */ 67 68 notify_flags_t can_block; 69 70 /* Saved notifications. */ 71 72 notify_flags_t notifications; 73 74 } file_t; 75 76 77 78 /* File operations. */ 79 80 void file_close(file_t *file); 81 long file_open(file_t *file, const char *filename, flags_t flags, l4_cap_idx_t server); 82 83 /* File lifecycle operations. */ 84 85 long file_context(file_t *file, l4_cap_idx_t server); 86 long file_context_open(file_t *file, flags_t flags, file_t *context); 87 void file_init(file_t *file); 88 89 /* File and region operations. */ 90 91 long file_flush(file_t *file); 92 long file_mmap(file_t *file, offset_t position, offset_t length); 93 long file_resize(file_t *file, offset_t size); 94 95 /* File and region properties. */ 96 97 offset_t file_populated_span(file_t *file); 98 offset_t file_span(file_t *file); 99 100 /* Convenience functions. */ 101 102 char *file_string_get(file_t *file, offset_t offset); 103 int file_string_set(file_t *file, const char *data, offset_t offset, offset_t *written); 104 105 /* Client data functions. */ 106 107 offset_t file_data_available(file_t *file); 108 char *file_data_current(file_t *file); 109 offset_t file_data_current_position(file_t *file); 110 offset_t file_data_end_position(file_t *file); 111 offset_t file_data_space(file_t *file); 112 113 /* Client data transfer functions. */ 114 115 void file_data_read(file_t *file, char *buf, offset_t to_transfer); 116 void file_data_write(file_t *file, char *buf, offset_t to_transfer); 117 118 /* Notification functions. */ 119 120 long file_notify_subscribe(file_t *file, notify_flags_t flags); 121 long file_notify_unsubscribe(file_t *file); 122 long file_notify_wait_file(file_t *file); 123 long file_notify_wait_files(file_t **file); 124 125 126 127 /* Pipe operations. */ 128 129 long pipe_open(offset_t size, file_t *reader, file_t *writer, l4_cap_idx_t server); 130 131 /* Pipe region operations. */ 132 133 long pipe_current(file_t *pipe); 134 long pipe_next(file_t *pipe); 135 long pipe_written(file_t *pipe, offset_t size); 136 137 138 139 EXTERN_C_END 140 141 // vim: tabstop=2 expandtab shiftwidth=2