4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
26 #include "exec/cpu-common.h"
29 /* This function writes a chunk of data to a file at the given position.
30 * The pos argument can be ignored if the file is only being used for
31 * streaming. The handler should try to write all of the data it can.
33 typedef ssize_t (QEMUFilePutBufferFunc
)(void *opaque
, const uint8_t *buf
,
34 int64_t pos
, size_t size
);
36 /* Read a chunk of data from a file at the given position. The pos argument
37 * can be ignored if the file is only be used for streaming. The number of
38 * bytes actually read should be returned.
40 typedef ssize_t (QEMUFileGetBufferFunc
)(void *opaque
, uint8_t *buf
,
41 int64_t pos
, size_t size
);
45 * Return negative error number on error, 0 or positive value on success.
47 * The meaning of return value on success depends on the specific back-end being
50 typedef int (QEMUFileCloseFunc
)(void *opaque
);
52 /* Called to return the OS file descriptor associated to the QEMUFile.
54 typedef int (QEMUFileGetFD
)(void *opaque
);
57 * This function writes an iovec to file.
59 typedef ssize_t (QEMUFileWritevBufferFunc
)(void *opaque
, struct iovec
*iov
,
60 int iovcnt
, int64_t pos
);
63 * This function provides hooks around different
64 * stages of RAM migration.
65 * 'opaque' is the backend specific data in QEMUFile
66 * 'data' is call specific data associated with the 'flags' value
68 typedef int (QEMURamHookFunc
)(QEMUFile
*f
, void *opaque
, uint64_t flags
,
72 * Constants used by ram_control_* hooks
74 #define RAM_CONTROL_SETUP 0
75 #define RAM_CONTROL_ROUND 1
76 #define RAM_CONTROL_HOOK 2
77 #define RAM_CONTROL_FINISH 3
78 #define RAM_CONTROL_BLOCK_REG 4
81 * This function allows override of where the RAM page
82 * is saved (such as RDMA, for example.)
84 typedef size_t (QEMURamSaveFunc
)(QEMUFile
*f
, void *opaque
,
85 ram_addr_t block_offset
,
88 uint64_t *bytes_sent
);
91 * Return a QEMUFile for comms in the opposite direction
93 typedef QEMUFile
*(QEMURetPathFunc
)(void *opaque
);
96 * Stop any read or write (depending on flags) on the underlying
97 * transport on the QEMUFile.
98 * Existing blocking reads/writes must be woken
99 * Returns 0 on success, -err on error
101 typedef int (QEMUFileShutdownFunc
)(void *opaque
, bool rd
, bool wr
);
103 typedef struct QEMUFileOps
{
104 QEMUFilePutBufferFunc
*put_buffer
;
105 QEMUFileGetBufferFunc
*get_buffer
;
106 QEMUFileCloseFunc
*close
;
107 QEMUFileGetFD
*get_fd
;
108 QEMUFileWritevBufferFunc
*writev_buffer
;
109 QEMURamHookFunc
*before_ram_iterate
;
110 QEMURamHookFunc
*after_ram_iterate
;
111 QEMURamHookFunc
*hook_ram_load
;
112 QEMURamSaveFunc
*save_page
;
113 QEMURetPathFunc
*get_return_path
;
114 QEMUFileShutdownFunc
*shut_down
;
117 struct QEMUSizedBuffer
{
120 size_t size
; /* total allocated size in all iov's */
121 size_t used
; /* number of used bytes */
124 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
);
125 QEMUFile
*qemu_fopen(const char *filename
, const char *mode
);
126 QEMUFile
*qemu_fdopen(int fd
, const char *mode
);
127 QEMUFile
*qemu_fopen_socket(int fd
, const char *mode
);
128 QEMUFile
*qemu_popen_cmd(const char *command
, const char *mode
);
129 QEMUFile
*qemu_bufopen(const char *mode
, QEMUSizedBuffer
*input
);
130 int qemu_get_fd(QEMUFile
*f
);
131 int qemu_fclose(QEMUFile
*f
);
132 int64_t qemu_ftell(QEMUFile
*f
);
133 int64_t qemu_ftell_fast(QEMUFile
*f
);
134 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, size_t size
);
135 void qemu_put_byte(QEMUFile
*f
, int v
);
137 * put_buffer without copying the buffer.
138 * The buffer should be available till it is sent asynchronously.
140 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, size_t size
);
141 bool qemu_file_mode_is_not_valid(const char *mode
);
142 bool qemu_file_is_writable(QEMUFile
*f
);
144 QEMUSizedBuffer
*qsb_create(const uint8_t *buffer
, size_t len
);
145 void qsb_free(QEMUSizedBuffer
*);
146 size_t qsb_set_length(QEMUSizedBuffer
*qsb
, size_t length
);
147 size_t qsb_get_length(const QEMUSizedBuffer
*qsb
);
148 ssize_t
qsb_get_buffer(const QEMUSizedBuffer
*, off_t start
, size_t count
,
150 ssize_t
qsb_write_at(QEMUSizedBuffer
*qsb
, const uint8_t *buf
,
151 off_t pos
, size_t count
);
155 * For use on files opened with qemu_bufopen
157 const QEMUSizedBuffer
*qemu_buf_get(QEMUFile
*f
);
159 static inline void qemu_put_ubyte(QEMUFile
*f
, unsigned int v
)
161 qemu_put_byte(f
, (int)v
);
164 #define qemu_put_sbyte qemu_put_byte
166 void qemu_put_be16(QEMUFile
*f
, unsigned int v
);
167 void qemu_put_be32(QEMUFile
*f
, unsigned int v
);
168 void qemu_put_be64(QEMUFile
*f
, uint64_t v
);
169 size_t qemu_peek_buffer(QEMUFile
*f
, uint8_t **buf
, size_t size
, size_t offset
);
170 size_t qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, size_t size
);
171 size_t qemu_get_buffer_in_place(QEMUFile
*f
, uint8_t **buf
, size_t size
);
172 ssize_t
qemu_put_compression_data(QEMUFile
*f
, const uint8_t *p
, size_t size
,
174 int qemu_put_qemu_file(QEMUFile
*f_des
, QEMUFile
*f_src
);
177 * Note that you can only peek continuous bytes from where the current pointer
178 * is; you aren't guaranteed to be able to peak to +n bytes unless you've
179 * previously peeked +n-1.
181 int qemu_peek_byte(QEMUFile
*f
, int offset
);
182 int qemu_get_byte(QEMUFile
*f
);
183 void qemu_file_skip(QEMUFile
*f
, int size
);
184 void qemu_update_position(QEMUFile
*f
, size_t size
);
186 static inline unsigned int qemu_get_ubyte(QEMUFile
*f
)
188 return (unsigned int)qemu_get_byte(f
);
191 #define qemu_get_sbyte qemu_get_byte
193 unsigned int qemu_get_be16(QEMUFile
*f
);
194 unsigned int qemu_get_be32(QEMUFile
*f
);
195 uint64_t qemu_get_be64(QEMUFile
*f
);
197 int qemu_file_rate_limit(QEMUFile
*f
);
198 void qemu_file_reset_rate_limit(QEMUFile
*f
);
199 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t new_rate
);
200 int64_t qemu_file_get_rate_limit(QEMUFile
*f
);
201 int qemu_file_get_error(QEMUFile
*f
);
202 void qemu_file_set_error(QEMUFile
*f
, int ret
);
203 int qemu_file_shutdown(QEMUFile
*f
);
204 QEMUFile
*qemu_file_get_return_path(QEMUFile
*f
);
205 void qemu_fflush(QEMUFile
*f
);
206 void qemu_file_set_blocking(QEMUFile
*f
, bool block
);
208 static inline void qemu_put_be64s(QEMUFile
*f
, const uint64_t *pv
)
210 qemu_put_be64(f
, *pv
);
213 static inline void qemu_put_be32s(QEMUFile
*f
, const uint32_t *pv
)
215 qemu_put_be32(f
, *pv
);
218 static inline void qemu_put_be16s(QEMUFile
*f
, const uint16_t *pv
)
220 qemu_put_be16(f
, *pv
);
223 static inline void qemu_put_8s(QEMUFile
*f
, const uint8_t *pv
)
225 qemu_put_byte(f
, *pv
);
228 static inline void qemu_get_be64s(QEMUFile
*f
, uint64_t *pv
)
230 *pv
= qemu_get_be64(f
);
233 static inline void qemu_get_be32s(QEMUFile
*f
, uint32_t *pv
)
235 *pv
= qemu_get_be32(f
);
238 static inline void qemu_get_be16s(QEMUFile
*f
, uint16_t *pv
)
240 *pv
= qemu_get_be16(f
);
243 static inline void qemu_get_8s(QEMUFile
*f
, uint8_t *pv
)
245 *pv
= qemu_get_byte(f
);
248 // Signed versions for type safety
249 static inline void qemu_put_sbuffer(QEMUFile
*f
, const int8_t *buf
, size_t size
)
251 qemu_put_buffer(f
, (const uint8_t *)buf
, size
);
254 static inline void qemu_put_sbe16(QEMUFile
*f
, int v
)
256 qemu_put_be16(f
, (unsigned int)v
);
259 static inline void qemu_put_sbe32(QEMUFile
*f
, int v
)
261 qemu_put_be32(f
, (unsigned int)v
);
264 static inline void qemu_put_sbe64(QEMUFile
*f
, int64_t v
)
266 qemu_put_be64(f
, (uint64_t)v
);
269 static inline size_t qemu_get_sbuffer(QEMUFile
*f
, int8_t *buf
, int size
)
271 return qemu_get_buffer(f
, (uint8_t *)buf
, size
);
274 static inline int qemu_get_sbe16(QEMUFile
*f
)
276 return (int)qemu_get_be16(f
);
279 static inline int qemu_get_sbe32(QEMUFile
*f
)
281 return (int)qemu_get_be32(f
);
284 static inline int64_t qemu_get_sbe64(QEMUFile
*f
)
286 return (int64_t)qemu_get_be64(f
);
289 static inline void qemu_put_s8s(QEMUFile
*f
, const int8_t *pv
)
291 qemu_put_8s(f
, (const uint8_t *)pv
);
294 static inline void qemu_put_sbe16s(QEMUFile
*f
, const int16_t *pv
)
296 qemu_put_be16s(f
, (const uint16_t *)pv
);
299 static inline void qemu_put_sbe32s(QEMUFile
*f
, const int32_t *pv
)
301 qemu_put_be32s(f
, (const uint32_t *)pv
);
304 static inline void qemu_put_sbe64s(QEMUFile
*f
, const int64_t *pv
)
306 qemu_put_be64s(f
, (const uint64_t *)pv
);
309 static inline void qemu_get_s8s(QEMUFile
*f
, int8_t *pv
)
311 qemu_get_8s(f
, (uint8_t *)pv
);
314 static inline void qemu_get_sbe16s(QEMUFile
*f
, int16_t *pv
)
316 qemu_get_be16s(f
, (uint16_t *)pv
);
319 static inline void qemu_get_sbe32s(QEMUFile
*f
, int32_t *pv
)
321 qemu_get_be32s(f
, (uint32_t *)pv
);
324 static inline void qemu_get_sbe64s(QEMUFile
*f
, int64_t *pv
)
326 qemu_get_be64s(f
, (uint64_t *)pv
);
329 size_t qemu_get_counted_string(QEMUFile
*f
, char buf
[256]);