xref: /openbmc/qemu/migration/qemu-file.h (revision 2b74dd91)
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 <zlib.h>
29 #include "exec/cpu-common.h"
30 #include "io/channel.h"
31 
32 QEMUFile *qemu_file_new_input(QIOChannel *ioc);
33 QEMUFile *qemu_file_new_output(QIOChannel *ioc);
34 int qemu_fclose(QEMUFile *f);
35 
36 /*
37  * qemu_file_transferred:
38  *
39  * No flush is performed and the reported amount will include the size
40  * of any queued buffers, on top of the amount actually transferred.
41  *
42  * Returns: the total bytes transferred and queued
43  */
44 uint64_t qemu_file_transferred(QEMUFile *f);
45 
46 /*
47  * put_buffer without copying the buffer.
48  * The buffer should be available till it is sent asynchronously.
49  */
50 void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size,
51                            bool may_free);
52 
53 #include "migration/qemu-file-types.h"
54 
55 size_t coroutine_mixed_fn qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset);
56 size_t coroutine_mixed_fn qemu_get_buffer_in_place(QEMUFile *f, uint8_t **buf, size_t size);
57 
58 /*
59  * Note that you can only peek continuous bytes from where the current pointer
60  * is; you aren't guaranteed to be able to peak to +n bytes unless you've
61  * previously peeked +n-1.
62  */
63 int coroutine_mixed_fn qemu_peek_byte(QEMUFile *f, int offset);
64 void qemu_file_skip(QEMUFile *f, int size);
65 int qemu_file_get_error_obj_any(QEMUFile *f1, QEMUFile *f2, Error **errp);
66 void qemu_file_set_error_obj(QEMUFile *f, int ret, Error *err);
67 int qemu_file_get_error_obj(QEMUFile *f, Error **errp);
68 void qemu_file_set_error(QEMUFile *f, int ret);
69 int qemu_file_shutdown(QEMUFile *f);
70 QEMUFile *qemu_file_get_return_path(QEMUFile *f);
71 int qemu_fflush(QEMUFile *f);
72 void qemu_file_set_blocking(QEMUFile *f, bool block);
73 int qemu_file_get_to_fd(QEMUFile *f, int fd, size_t size);
74 void qemu_set_offset(QEMUFile *f, off_t off, int whence);
75 off_t qemu_get_offset(QEMUFile *f);
76 void qemu_put_buffer_at(QEMUFile *f, const uint8_t *buf, size_t buflen,
77                         off_t pos);
78 size_t qemu_get_buffer_at(QEMUFile *f, const uint8_t *buf, size_t buflen,
79                           off_t pos);
80 
81 QIOChannel *qemu_file_get_ioc(QEMUFile *file);
82 
83 #endif
84