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 #include <l4/sys/types.h> 23 24 #include <systypes/base.h> 25 26 27 28 EXTERN_C_BEGIN 29 30 /* File access abstraction. */ 31 32 typedef struct 33 { 34 /* File object reference. */ 35 36 l4_cap_idx_t ref; 37 38 /* Mapped memory accessing a file region. */ 39 40 char *memory; 41 42 /* File region parameters. */ 43 44 offset_t start_pos, end_pos; /* start and end positions of region */ 45 offset_t data_end; /* amount of data in the region */ 46 47 /* Total size of file. */ 48 49 offset_t size; 50 51 } file_t; 52 53 54 55 /* File operations. */ 56 57 void file_close(file_t *file); 58 long file_open(file_t *file, const char *filename, l4_cap_idx_t server); 59 60 /* File lifecycle operations. */ 61 62 long file_context(file_t *file, l4_cap_idx_t server); 63 long file_context_open(file_t *file, file_t *context); 64 void file_init(file_t *file); 65 66 /* File and region operations. */ 67 68 long file_mmap(file_t *file, offset_t position, offset_t length); 69 long file_resize(file_t *file, offset_t size); 70 71 /* File and region properties. */ 72 73 offset_t file_populated_span(file_t *file); 74 offset_t file_span(file_t *file); 75 76 /* Convenience functions. */ 77 78 char *file_string_get(file_t *file, offset_t offset); 79 int file_string_set(file_t *file, const char *data, offset_t offset, offset_t *written); 80 81 82 83 /* Pipe operations. */ 84 85 long pipe_open(offset_t size, file_t *reader, file_t *writer, l4_cap_idx_t server); 86 87 /* Pipe region operations. */ 88 89 long pipe_current(file_t *pipe); 90 long pipe_next(file_t *pipe); 91 long pipe_written(file_t *pipe, offset_t size); 92 93 EXTERN_C_END 94 95 // vim: tabstop=2 expandtab shiftwidth=2