paul@31 | 1 | /* |
paul@31 | 2 | * File access convenience functions. |
paul@31 | 3 | * |
paul@31 | 4 | * Copyright (C) 2021 Paul Boddie <paul@boddie.org.uk> |
paul@31 | 5 | * |
paul@31 | 6 | * This program is free software; you can redistribute it and/or |
paul@31 | 7 | * modify it under the terms of the GNU General Public License as |
paul@31 | 8 | * published by the Free Software Foundation; either version 2 of |
paul@31 | 9 | * the License, or (at your option) any later version. |
paul@31 | 10 | * |
paul@31 | 11 | * This program is distributed in the hope that it will be useful, |
paul@31 | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
paul@31 | 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
paul@31 | 14 | * GNU General Public License for more details. |
paul@31 | 15 | * |
paul@31 | 16 | * You should have received a copy of the GNU General Public License |
paul@31 | 17 | * along with this program; if not, write to the Free Software |
paul@31 | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, |
paul@31 | 19 | * Boston, MA 02110-1301, USA |
paul@31 | 20 | */ |
paul@31 | 21 | |
paul@31 | 22 | #include <ipc/cap_alloc.h> |
paul@31 | 23 | #include <ipc/mem_ipc.h> |
paul@31 | 24 | |
paul@46 | 25 | #include <string.h> |
paul@46 | 26 | |
paul@31 | 27 | #include "dataspace_client.h" |
paul@55 | 28 | #include "file_client.h" |
paul@117 | 29 | #include "flush_client.h" |
paul@31 | 30 | #include "opener_client.h" |
paul@31 | 31 | #include "opener_context_client.h" |
paul@65 | 32 | #include "pipe_client.h" |
paul@65 | 33 | #include "pipe_opener_client.h" |
paul@31 | 34 | #include "mapped_file_client.h" |
paul@31 | 35 | |
paul@31 | 36 | #include "file.h" |
paul@124 | 37 | #include "notifier.h" |
paul@31 | 38 | |
paul@31 | 39 | |
paul@31 | 40 | |
paul@90 | 41 | /* Update the extent of the file in a region using the region start and end |
paul@90 | 42 | positions and the file size. */ |
paul@90 | 43 | |
paul@90 | 44 | static void _update_extent(file_t *file) |
paul@90 | 45 | { |
paul@90 | 46 | /* Handle files ending after or within the region. */ |
paul@90 | 47 | |
paul@90 | 48 | if (file->size > file->start_pos) |
paul@90 | 49 | { |
paul@90 | 50 | if (file->size > file->end_pos) |
paul@90 | 51 | file->data_end = file->end_pos - file->start_pos; |
paul@90 | 52 | else |
paul@90 | 53 | file->data_end = file->size - file->start_pos; |
paul@90 | 54 | } |
paul@90 | 55 | |
paul@90 | 56 | /* Handle files ending before the region. */ |
paul@90 | 57 | |
paul@90 | 58 | else |
paul@90 | 59 | file->data_end = 0; |
paul@90 | 60 | } |
paul@90 | 61 | |
paul@90 | 62 | |
paul@90 | 63 | |
paul@90 | 64 | /* Initialise the given file structure. */ |
paul@90 | 65 | |
paul@90 | 66 | void file_init(file_t *file) |
paul@90 | 67 | { |
paul@90 | 68 | file->memory = NULL; |
paul@90 | 69 | file->ref = L4_INVALID_CAP; |
paul@124 | 70 | file->notifier = L4_INVALID_CAP; |
paul@90 | 71 | file->start_pos = 0; |
paul@90 | 72 | file->end_pos = 0; |
paul@90 | 73 | file->data_end = 0; |
paul@90 | 74 | file->data_current = 0; |
paul@90 | 75 | file->can_mmap = 1; |
paul@108 | 76 | file->has_size = 1; |
paul@117 | 77 | file->can_block = 0; |
paul@124 | 78 | file->notifications = 0; |
paul@90 | 79 | } |
paul@90 | 80 | |
paul@90 | 81 | |
paul@90 | 82 | |
paul@33 | 83 | /* Release resources for the given file. */ |
paul@31 | 84 | |
paul@31 | 85 | void file_close(file_t *file) |
paul@31 | 86 | { |
paul@31 | 87 | if (l4_is_valid_cap(file->ref)) |
paul@31 | 88 | ipc_cap_free_um(file->ref); |
paul@31 | 89 | |
paul@124 | 90 | if (l4_is_valid_cap(file->notifier)) |
paul@124 | 91 | ipc_cap_free_um(file->notifier); |
paul@117 | 92 | |
paul@31 | 93 | if (file->memory != NULL) |
paul@31 | 94 | ipc_detach_dataspace(file->memory); |
paul@31 | 95 | |
paul@31 | 96 | file_init(file); |
paul@31 | 97 | } |
paul@31 | 98 | |
paul@90 | 99 | /* Open a file using the given structure, indicating the filename and |
paul@90 | 100 | filesystem server. The file_mmap function should be used to obtain access to |
paul@90 | 101 | memory providing file data. This is a convenience function invoking |
paul@90 | 102 | file_context and file_context_open. */ |
paul@90 | 103 | |
paul@90 | 104 | long file_open(file_t *file, const char *filename, flags_t flags, l4_cap_idx_t server) |
paul@90 | 105 | { |
paul@90 | 106 | file_t context; |
paul@90 | 107 | long err; |
paul@90 | 108 | |
paul@90 | 109 | err = file_context(&context, server); |
paul@90 | 110 | if (err) |
paul@90 | 111 | return err; |
paul@90 | 112 | |
paul@90 | 113 | if (!file_string_set(&context, filename, 0, NULL)) |
paul@90 | 114 | return -L4_ENOMEM; |
paul@90 | 115 | |
paul@90 | 116 | err = file_context_open(file, flags, &context); |
paul@90 | 117 | |
paul@90 | 118 | /* Close the context, although a separate mechanism could permit contexts to |
paul@90 | 119 | open several files. */ |
paul@90 | 120 | |
paul@90 | 121 | file_close(&context); |
paul@90 | 122 | return err; |
paul@90 | 123 | } |
paul@90 | 124 | |
paul@90 | 125 | |
paul@90 | 126 | |
paul@90 | 127 | /* Initialise a file structure for a context obtained from the given server |
paul@90 | 128 | attaching memory to communicate filename information. */ |
paul@31 | 129 | |
paul@33 | 130 | long file_context(file_t *file, l4_cap_idx_t server) |
paul@31 | 131 | { |
paul@85 | 132 | if (l4_is_invalid_cap(server)) |
paul@85 | 133 | return -L4_EINVAL; |
paul@85 | 134 | |
paul@31 | 135 | client_Opener opener(server); |
paul@92 | 136 | offset_t size; |
paul@92 | 137 | flags_t flags; |
paul@31 | 138 | long err; |
paul@31 | 139 | |
paul@31 | 140 | file_init(file); |
paul@47 | 141 | |
paul@31 | 142 | err = opener.context(&file->ref); |
paul@31 | 143 | if (err) |
paul@31 | 144 | return err; |
paul@31 | 145 | |
paul@31 | 146 | client_Dataspace context_ds(file->ref); |
paul@31 | 147 | |
paul@31 | 148 | err = context_ds.info(&size, &flags); |
paul@31 | 149 | if (err) |
paul@31 | 150 | return err; |
paul@31 | 151 | |
paul@47 | 152 | file->start_pos = 0; |
paul@47 | 153 | file->end_pos = size; |
paul@47 | 154 | |
paul@31 | 155 | return ipc_attach_dataspace(file->ref, size, (void **) &file->memory); |
paul@31 | 156 | } |
paul@31 | 157 | |
paul@47 | 158 | /* Open a file using the given structure and context. */ |
paul@47 | 159 | |
paul@85 | 160 | long file_context_open(file_t *file, flags_t flags, file_t *context) |
paul@47 | 161 | { |
paul@47 | 162 | client_OpenerContext openercontext(context->ref); |
paul@47 | 163 | file_init(file); |
paul@85 | 164 | return openercontext.open(flags, &file->size, &file->ref); |
paul@47 | 165 | } |
paul@47 | 166 | |
paul@46 | 167 | |
paul@46 | 168 | |
paul@90 | 169 | /* Flush populated data and obtain an updated file size and populated data |
paul@90 | 170 | details. */ |
paul@33 | 171 | |
paul@90 | 172 | long file_flush(file_t *file) |
paul@33 | 173 | { |
paul@117 | 174 | client_Flush _file(file->ref); |
paul@90 | 175 | long err = _file.flush(file->data_current, &file->size); |
paul@33 | 176 | |
paul@33 | 177 | if (err) |
paul@33 | 178 | return err; |
paul@33 | 179 | |
paul@90 | 180 | _update_extent(file); |
paul@90 | 181 | |
paul@90 | 182 | return L4_EOK; |
paul@33 | 183 | } |
paul@33 | 184 | |
paul@90 | 185 | /* Map a region of the given file to a memory region, obtaining an updated file |
paul@90 | 186 | size and populated data details. Unmap any previously mapped region. */ |
paul@90 | 187 | |
paul@90 | 188 | long file_mmap(file_t *file, offset_t position, offset_t length) |
paul@90 | 189 | { |
paul@90 | 190 | char *memory = file->memory; |
paul@90 | 191 | client_MappedFile mapped_file(file->ref); |
paul@90 | 192 | long err = mapped_file.mmap(position, length, &file->start_pos, |
paul@90 | 193 | &file->end_pos, &file->size); |
paul@90 | 194 | |
paul@90 | 195 | if (err) |
paul@90 | 196 | return err; |
paul@90 | 197 | |
paul@90 | 198 | _update_extent(file); |
paul@90 | 199 | |
paul@90 | 200 | err = ipc_attach_dataspace(file->ref, file_span(file), (void **) &file->memory); |
paul@90 | 201 | if (err) |
paul@90 | 202 | return err; |
paul@90 | 203 | |
paul@90 | 204 | if (memory != NULL) |
paul@90 | 205 | ipc_detach_dataspace(memory); |
paul@90 | 206 | |
paul@90 | 207 | return L4_EOK; |
paul@90 | 208 | } |
paul@90 | 209 | |
paul@90 | 210 | /* Resize a file, obtaining updated file size and populated data details. */ |
paul@55 | 211 | |
paul@55 | 212 | long file_resize(file_t *file, offset_t size) |
paul@55 | 213 | { |
paul@108 | 214 | if (!file->has_size) |
paul@108 | 215 | return -L4_EIO; |
paul@108 | 216 | |
paul@55 | 217 | client_File _file(file->ref); |
paul@55 | 218 | offset_t file_size = size; |
paul@55 | 219 | long err = _file.resize(&file_size); |
paul@55 | 220 | |
paul@90 | 221 | if (err) |
paul@90 | 222 | return err; |
paul@55 | 223 | |
paul@90 | 224 | file->size = file_size; |
paul@90 | 225 | _update_extent(file); |
paul@90 | 226 | return L4_EOK; |
paul@55 | 227 | } |
paul@55 | 228 | |
paul@55 | 229 | |
paul@55 | 230 | |
paul@33 | 231 | /* Return the amount of data in the mapped region for the given file. */ |
paul@33 | 232 | |
paul@45 | 233 | offset_t file_populated_span(file_t *file) |
paul@33 | 234 | { |
paul@45 | 235 | offset_t size = file_span(file); |
paul@33 | 236 | return (file->data_end < size) ? file->data_end : size; |
paul@33 | 237 | } |
paul@33 | 238 | |
paul@45 | 239 | /* Return the size of the mapped region for the given file. */ |
paul@45 | 240 | |
paul@45 | 241 | offset_t file_span(file_t *file) |
paul@45 | 242 | { |
paul@45 | 243 | return file->end_pos - file->start_pos; |
paul@45 | 244 | } |
paul@45 | 245 | |
paul@46 | 246 | |
paul@46 | 247 | |
paul@46 | 248 | /* Get a pointer to any terminated string at the given offset or NULL if the |
paul@46 | 249 | data from offset is not terminated. */ |
paul@46 | 250 | |
paul@46 | 251 | char *file_string_get(file_t *file, offset_t offset) |
paul@46 | 252 | { |
paul@46 | 253 | offset_t limit = file_span(file) - offset; |
paul@46 | 254 | |
paul@46 | 255 | if (strnlen(file->memory + offset, limit) < limit) |
paul@46 | 256 | return file->memory + offset; |
paul@46 | 257 | else |
paul@46 | 258 | return NULL; |
paul@46 | 259 | } |
paul@46 | 260 | |
paul@47 | 261 | /* Copy a string to the mapped region at the given offset, returning 1 (true) |
paul@47 | 262 | where all characters were copied, 0 (false) otherwise. The precise number of |
paul@47 | 263 | characters copied, excluding the zero terminator is provided via the written |
paul@47 | 264 | parameter if it is not specified as NULL. */ |
paul@46 | 265 | |
paul@47 | 266 | int file_string_set(file_t *file, const char *data, offset_t offset, |
paul@47 | 267 | offset_t *written) |
paul@46 | 268 | { |
paul@47 | 269 | offset_t i, pos, limit = file_span(file); |
paul@46 | 270 | |
paul@46 | 271 | /* Do not attempt to copy data with an invalid offset. */ |
paul@46 | 272 | |
paul@47 | 273 | if (offset >= limit) |
paul@47 | 274 | { |
paul@47 | 275 | if (written != NULL) |
paul@47 | 276 | *written = 0; |
paul@46 | 277 | return 0; |
paul@47 | 278 | } |
paul@46 | 279 | |
paul@47 | 280 | /* Copy the data to the given offset, stopping at the end of the region. */ |
paul@46 | 281 | |
paul@46 | 282 | for (i = 0, pos = offset; pos < limit; i++, pos++) |
paul@46 | 283 | { |
paul@46 | 284 | file->memory[pos] = data[i]; |
paul@46 | 285 | |
paul@46 | 286 | /* Terminator written, can return immediately. */ |
paul@46 | 287 | |
paul@46 | 288 | if (!data[i]) |
paul@47 | 289 | { |
paul@47 | 290 | if (written != NULL) |
paul@47 | 291 | *written = pos - offset; |
paul@47 | 292 | return 1; |
paul@47 | 293 | } |
paul@46 | 294 | } |
paul@46 | 295 | |
paul@46 | 296 | /* Terminate the incomplete string at the end of the region. */ |
paul@46 | 297 | |
paul@47 | 298 | file->memory[limit - 1] = '\0'; |
paul@47 | 299 | if (written != NULL) |
paul@47 | 300 | *written = limit - 1 - offset; |
paul@47 | 301 | return 0; |
paul@46 | 302 | } |
paul@46 | 303 | |
paul@65 | 304 | |
paul@65 | 305 | |
paul@90 | 306 | /* Return the number of remaining populated bytes in the region. */ |
paul@90 | 307 | |
paul@90 | 308 | offset_t file_data_available(file_t *file) |
paul@90 | 309 | { |
paul@90 | 310 | return file_populated_span(file) - file->data_current; |
paul@90 | 311 | } |
paul@90 | 312 | |
paul@90 | 313 | /* Return the current data offset in the region. */ |
paul@90 | 314 | |
paul@90 | 315 | char *file_data_current(file_t *file) |
paul@90 | 316 | { |
paul@90 | 317 | return file->memory + file->data_current; |
paul@90 | 318 | } |
paul@90 | 319 | |
paul@90 | 320 | /* Return the current access position in the file. */ |
paul@90 | 321 | |
paul@90 | 322 | offset_t file_data_current_position(file_t *file) |
paul@90 | 323 | { |
paul@90 | 324 | return file->start_pos + file->data_current; |
paul@90 | 325 | } |
paul@90 | 326 | |
paul@90 | 327 | /* Return the position of the end of the populated bytes in the region. */ |
paul@90 | 328 | |
paul@90 | 329 | offset_t file_data_end_position(file_t *file) |
paul@90 | 330 | { |
paul@90 | 331 | return file->start_pos + file->data_end; |
paul@90 | 332 | } |
paul@90 | 333 | |
paul@90 | 334 | /* Return the amount of remaining space in the region. */ |
paul@90 | 335 | |
paul@90 | 336 | offset_t file_data_space(file_t *file) |
paul@90 | 337 | { |
paul@90 | 338 | return file_span(file) - file->data_current; |
paul@90 | 339 | } |
paul@90 | 340 | |
paul@90 | 341 | |
paul@90 | 342 | |
paul@90 | 343 | /* Copy data to the given buffer from the current data position, updating the |
paul@90 | 344 | position. */ |
paul@90 | 345 | |
paul@98 | 346 | void file_data_read(file_t *file, char *buf, offset_t to_transfer) |
paul@90 | 347 | { |
paul@90 | 348 | memcpy(buf, file_data_current(file), to_transfer); |
paul@90 | 349 | |
paul@90 | 350 | /* Update position details. */ |
paul@90 | 351 | |
paul@90 | 352 | file->data_current += to_transfer; |
paul@90 | 353 | } |
paul@90 | 354 | |
paul@90 | 355 | /* Copy data from the given buffer to the current data position, updating the |
paul@90 | 356 | position and the extent of populated data if this was exceeded. */ |
paul@90 | 357 | |
paul@98 | 358 | void file_data_write(file_t *file, char *buf, offset_t to_transfer) |
paul@90 | 359 | { |
paul@90 | 360 | memcpy(file_data_current(file), buf, to_transfer); |
paul@90 | 361 | |
paul@90 | 362 | /* Update position details. */ |
paul@90 | 363 | |
paul@90 | 364 | file->data_current += to_transfer; |
paul@90 | 365 | |
paul@90 | 366 | if (file->data_current > file->data_end) |
paul@90 | 367 | file->data_end = file->data_current; |
paul@90 | 368 | } |
paul@90 | 369 | |
paul@90 | 370 | |
paul@90 | 371 | |
paul@117 | 372 | /* Subscribe to notification events on a file. */ |
paul@117 | 373 | |
paul@121 | 374 | long file_notify_subscribe(file_t *file, notify_flags_t flags) |
paul@117 | 375 | { |
paul@124 | 376 | FileNotifier *notifier = get_notifier(); |
paul@117 | 377 | |
paul@124 | 378 | return notifier->subscribe(file, flags); |
paul@117 | 379 | } |
paul@117 | 380 | |
paul@117 | 381 | /* Unsubscribe from notification events on a file. */ |
paul@117 | 382 | |
paul@117 | 383 | long file_notify_unsubscribe(file_t *file) |
paul@117 | 384 | { |
paul@124 | 385 | if (l4_is_invalid_cap(file->notifier)) |
paul@123 | 386 | return -L4_EINVAL; |
paul@123 | 387 | |
paul@124 | 388 | FileNotifier *notifier = get_notifier(); |
paul@117 | 389 | |
paul@124 | 390 | return notifier->unsubscribe(file); |
paul@123 | 391 | } |
paul@123 | 392 | |
paul@123 | 393 | /* Wait for a notification event on a file. */ |
paul@123 | 394 | |
paul@123 | 395 | long file_notify_wait_file(file_t *file) |
paul@117 | 396 | { |
paul@129 | 397 | FileNotifier *notifier = get_notifier(); |
paul@117 | 398 | |
paul@129 | 399 | return notifier->wait_file(file); |
paul@123 | 400 | } |
paul@123 | 401 | |
paul@123 | 402 | /* Wait for notification events on files. */ |
paul@117 | 403 | |
paul@123 | 404 | long file_notify_wait_files(file_t **file) |
paul@123 | 405 | { |
paul@124 | 406 | FileNotifier *notifier = get_notifier(); |
paul@123 | 407 | |
paul@124 | 408 | return notifier->wait(file); |
paul@117 | 409 | } |
paul@117 | 410 | |
paul@117 | 411 | |
paul@117 | 412 | |
paul@65 | 413 | /* Open two pipe endpoints using the given pipe server. */ |
paul@65 | 414 | |
paul@66 | 415 | long pipe_open(offset_t size, file_t *reader, file_t *writer, l4_cap_idx_t server) |
paul@65 | 416 | { |
paul@85 | 417 | if (l4_is_invalid_cap(server)) |
paul@85 | 418 | return -L4_EINVAL; |
paul@85 | 419 | |
paul@65 | 420 | client_PipeOpener opener(server); |
paul@65 | 421 | |
paul@65 | 422 | file_init(reader); |
paul@65 | 423 | file_init(writer); |
paul@65 | 424 | |
paul@90 | 425 | /* Pipes can usually only be accessed via region navigation. */ |
paul@90 | 426 | |
paul@90 | 427 | reader->can_mmap = 0; |
paul@108 | 428 | reader->has_size = 0; |
paul@90 | 429 | writer->can_mmap = 0; |
paul@108 | 430 | writer->has_size = 0; |
paul@90 | 431 | |
paul@66 | 432 | long err = opener.pipe(size, &reader->ref, &writer->ref); |
paul@65 | 433 | if (err) |
paul@65 | 434 | return err; |
paul@65 | 435 | |
paul@65 | 436 | err = pipe_next(writer) || pipe_next(reader); |
paul@65 | 437 | |
paul@65 | 438 | if (err) |
paul@65 | 439 | { |
paul@65 | 440 | file_close(reader); |
paul@65 | 441 | file_close(writer); |
paul@65 | 442 | } |
paul@65 | 443 | |
paul@65 | 444 | return err; |
paul@65 | 445 | } |
paul@65 | 446 | |
paul@65 | 447 | /* Access the current region for a pipe endpoint. */ |
paul@65 | 448 | |
paul@65 | 449 | long pipe_current(file_t *pipe) |
paul@65 | 450 | { |
paul@65 | 451 | client_Pipe _pipe(pipe->ref); |
paul@65 | 452 | long err = _pipe.current_region(&pipe->data_end, &pipe->size); |
paul@65 | 453 | |
paul@65 | 454 | if (err) |
paul@65 | 455 | return err; |
paul@65 | 456 | |
paul@65 | 457 | pipe->end_pos = pipe->size; |
paul@65 | 458 | |
paul@117 | 459 | /* Attach memory if necessary. */ |
paul@65 | 460 | |
paul@117 | 461 | if (pipe->memory == NULL) |
paul@117 | 462 | { |
paul@117 | 463 | err = ipc_attach_dataspace(pipe->ref, file_span(pipe), (void **) &pipe->memory); |
paul@117 | 464 | if (err) |
paul@117 | 465 | return err; |
paul@117 | 466 | } |
paul@65 | 467 | |
paul@65 | 468 | return L4_EOK; |
paul@65 | 469 | } |
paul@65 | 470 | |
paul@65 | 471 | /* Access the next region for a pipe endpoint, updating the eventual size of |
paul@65 | 472 | the current region. */ |
paul@65 | 473 | |
paul@65 | 474 | long pipe_next(file_t *pipe) |
paul@65 | 475 | { |
paul@65 | 476 | client_Pipe _pipe(pipe->ref); |
paul@65 | 477 | long err = _pipe.next_region(&pipe->data_end, &pipe->size); |
paul@65 | 478 | char *memory = pipe->memory; |
paul@65 | 479 | |
paul@65 | 480 | if (err) |
paul@65 | 481 | return err; |
paul@65 | 482 | |
paul@65 | 483 | pipe->end_pos = pipe->size; |
paul@65 | 484 | |
paul@65 | 485 | err = ipc_attach_dataspace(pipe->ref, file_span(pipe), (void **) &pipe->memory); |
paul@65 | 486 | if (err) |
paul@65 | 487 | return err; |
paul@65 | 488 | |
paul@65 | 489 | if (memory != NULL) |
paul@65 | 490 | ipc_detach_dataspace(memory); |
paul@65 | 491 | |
paul@65 | 492 | return L4_EOK; |
paul@65 | 493 | } |
paul@65 | 494 | |
paul@65 | 495 | /* Set the size of the written region. */ |
paul@65 | 496 | |
paul@65 | 497 | long pipe_written(file_t *pipe, offset_t size) |
paul@65 | 498 | { |
paul@65 | 499 | if (size <= pipe->size) |
paul@65 | 500 | { |
paul@65 | 501 | pipe->data_end = size; |
paul@65 | 502 | return L4_EOK; |
paul@65 | 503 | } |
paul@65 | 504 | else |
paul@65 | 505 | return -L4_EINVAL; |
paul@65 | 506 | } |
paul@65 | 507 | |
paul@31 | 508 | // vim: tabstop=2 expandtab shiftwidth=2 |