| 1 | /* |
| 2 | * QEMU System Emulator |
| 3 | * |
| 4 | * Copyright (c) 2003-2008 Fabrice Bellard |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to deal |
| 8 | * in the Software without restriction, including without limitation the rights |
| 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | * copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in |
| 14 | * all copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | * THE SOFTWARE. |
| 23 | */ |
| 24 | |
| 25 | #ifndef MIGRATION_QEMU_FILE_H |
| 26 | #define MIGRATION_QEMU_FILE_H |
| 27 | |
| 28 | #include "exec/cpu-common.h" |
| 29 | #include "io/channel.h" |
| 30 | |
| 31 | QEMUFile *qemu_file_new_input(QIOChannel *ioc); |
| 32 | QEMUFile *qemu_file_new_output(QIOChannel *ioc); |
| 33 | int qemu_fclose(QEMUFile *f); |
| 34 | |
| 35 | G_DEFINE_AUTOPTR_CLEANUP_FUNC(QEMUFile, qemu_fclose) |
| 36 | |
| 37 | /* |
| 38 | * qemu_file_transferred: |
| 39 | * |
| 40 | * No flush is performed and the reported amount will include the size |
| 41 | * of any queued buffers, on top of the amount actually transferred. |
| 42 | * |
| 43 | * Returns: the total bytes transferred and queued |
| 44 | */ |
| 45 | uint64_t qemu_file_transferred(QEMUFile *f); |
| 46 | |
| 47 | /* |
| 48 | * put_buffer without copying the buffer. |
| 49 | * The buffer should be available till it is sent asynchronously. |
| 50 | */ |
| 51 | void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size, |
| 52 | bool may_free); |
| 53 | |
| 54 | #include "migration/qemu-file-types.h" |
| 55 | |
| 56 | size_t coroutine_mixed_fn qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset); |
| 57 | size_t coroutine_mixed_fn qemu_get_buffer_in_place(QEMUFile *f, uint8_t **buf, size_t size); |
| 58 | |
| 59 | /* |
| 60 | * Note that you can only peek continuous bytes from where the current pointer |
| 61 | * is; you aren't guaranteed to be able to peak to +n bytes unless you've |
| 62 | * previously peeked +n-1. |
| 63 | */ |
| 64 | int coroutine_mixed_fn qemu_peek_byte(QEMUFile *f, int offset); |
| 65 | void qemu_file_skip(QEMUFile *f, int size); |
| 66 | int qemu_file_get_error_obj_any(QEMUFile *f1, QEMUFile *f2, Error **errp); |
| 67 | void qemu_file_set_error_obj(QEMUFile *f, int ret, Error *err); |
| 68 | int qemu_file_get_error_obj(QEMUFile *f, Error **errp); |
| 69 | void qemu_file_set_error(QEMUFile *f, int ret); |
| 70 | int qemu_file_shutdown(QEMUFile *f); |
| 71 | QEMUFile *qemu_file_get_return_path(QEMUFile *f); |
| 72 | int qemu_fflush(QEMUFile *f); |
| 73 | bool qemu_file_set_blocking(QEMUFile *f, bool block, Error **errp); |
| 74 | int qemu_file_get_to_fd(QEMUFile *f, int fd, size_t size); |
| 75 | void qemu_set_offset(QEMUFile *f, off_t off, int whence); |
| 76 | off_t qemu_get_offset(QEMUFile *f); |
| 77 | void qemu_put_buffer_at(QEMUFile *f, const uint8_t *buf, size_t buflen, |
| 78 | off_t pos); |
| 79 | size_t qemu_get_buffer_at(QEMUFile *f, uint8_t *buf, size_t buflen, off_t pos, |
| 80 | Error **errp); |
| 81 | |
| 82 | QIOChannel *qemu_file_get_ioc(QEMUFile *file); |
| 83 | int qemu_file_put_fd(QEMUFile *f, int fd); |
| 84 | int qemu_file_get_fd(QEMUFile *f, int *fd); |
| 85 | |
| 86 | #endif |