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
28 #include "qemu-common.h"
29 #include "exec/cpu-common.h"
30 #include "io/channel.h"
33 /* Read a chunk of data from a file at the given position. The pos argument
34 * can be ignored if the file is only be used for streaming. The number of
35 * bytes actually read should be returned.
37 typedef ssize_t (QEMUFileGetBufferFunc
)(void *opaque
, uint8_t *buf
,
38 int64_t pos
, size_t size
);
42 * Return negative error number on error, 0 or positive value on success.
44 * The meaning of return value on success depends on the specific back-end being
47 typedef int (QEMUFileCloseFunc
)(void *opaque
);
49 /* Called to return the OS file descriptor associated to the QEMUFile.
51 typedef int (QEMUFileGetFD
)(void *opaque
);
53 /* Called to change the blocking mode of the file
55 typedef int (QEMUFileSetBlocking
)(void *opaque
, bool enabled
);
58 * This function writes an iovec to file. The handler must write all
59 * of the data or return a negative errno value.
61 typedef ssize_t (QEMUFileWritevBufferFunc
)(void *opaque
, struct iovec
*iov
,
62 int iovcnt
, int64_t pos
);
65 * This function provides hooks around different
66 * stages of RAM migration.
67 * 'opaque' is the backend specific data in QEMUFile
68 * 'data' is call specific data associated with the 'flags' value
70 typedef int (QEMURamHookFunc
)(QEMUFile
*f
, void *opaque
, uint64_t flags
,
74 * Constants used by ram_control_* hooks
76 #define RAM_CONTROL_SETUP 0
77 #define RAM_CONTROL_ROUND 1
78 #define RAM_CONTROL_HOOK 2
79 #define RAM_CONTROL_FINISH 3
80 #define RAM_CONTROL_BLOCK_REG 4
83 * This function allows override of where the RAM page
84 * is saved (such as RDMA, for example.)
86 typedef size_t (QEMURamSaveFunc
)(QEMUFile
*f
, void *opaque
,
87 ram_addr_t block_offset
,
90 uint64_t *bytes_sent
);
93 * Return a QEMUFile for comms in the opposite direction
95 typedef QEMUFile
*(QEMURetPathFunc
)(void *opaque
);
98 * Stop any read or write (depending on flags) on the underlying
99 * transport on the QEMUFile.
100 * Existing blocking reads/writes must be woken
101 * Returns 0 on success, -err on error
103 typedef int (QEMUFileShutdownFunc
)(void *opaque
, bool rd
, bool wr
);
105 typedef struct QEMUFileOps
{
106 QEMUFileGetBufferFunc
*get_buffer
;
107 QEMUFileCloseFunc
*close
;
108 QEMUFileSetBlocking
*set_blocking
;
109 QEMUFileWritevBufferFunc
*writev_buffer
;
110 QEMURetPathFunc
*get_return_path
;
111 QEMUFileShutdownFunc
*shut_down
;
114 typedef struct QEMUFileHooks
{
115 QEMURamHookFunc
*before_ram_iterate
;
116 QEMURamHookFunc
*after_ram_iterate
;
117 QEMURamHookFunc
*hook_ram_load
;
118 QEMURamSaveFunc
*save_page
;
121 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
);
122 QEMUFile
*qemu_fopen_channel_input(QIOChannel
*ioc
);
123 QEMUFile
*qemu_fopen_channel_output(QIOChannel
*ioc
);
124 void qemu_file_set_hooks(QEMUFile
*f
, const QEMUFileHooks
*hooks
);
125 int qemu_get_fd(QEMUFile
*f
);
126 int qemu_fclose(QEMUFile
*f
);
127 int64_t qemu_ftell(QEMUFile
*f
);
128 int64_t qemu_ftell_fast(QEMUFile
*f
);
129 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, size_t size
);
130 void qemu_put_byte(QEMUFile
*f
, int v
);
132 * put_buffer without copying the buffer.
133 * The buffer should be available till it is sent asynchronously.
135 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, size_t size
);
136 bool qemu_file_mode_is_not_valid(const char *mode
);
137 bool qemu_file_is_writable(QEMUFile
*f
);
140 static inline void qemu_put_ubyte(QEMUFile
*f
, unsigned int v
)
142 qemu_put_byte(f
, (int)v
);
145 #define qemu_put_sbyte qemu_put_byte
147 void qemu_put_be16(QEMUFile
*f
, unsigned int v
);
148 void qemu_put_be32(QEMUFile
*f
, unsigned int v
);
149 void qemu_put_be64(QEMUFile
*f
, uint64_t v
);
150 size_t qemu_peek_buffer(QEMUFile
*f
, uint8_t **buf
, size_t size
, size_t offset
);
151 size_t qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, size_t size
);
152 size_t qemu_get_buffer_in_place(QEMUFile
*f
, uint8_t **buf
, size_t size
);
153 ssize_t
qemu_put_compression_data(QEMUFile
*f
, const uint8_t *p
, size_t size
,
155 int qemu_put_qemu_file(QEMUFile
*f_des
, QEMUFile
*f_src
);
158 * Note that you can only peek continuous bytes from where the current pointer
159 * is; you aren't guaranteed to be able to peak to +n bytes unless you've
160 * previously peeked +n-1.
162 int qemu_peek_byte(QEMUFile
*f
, int offset
);
163 int qemu_get_byte(QEMUFile
*f
);
164 void qemu_file_skip(QEMUFile
*f
, int size
);
165 void qemu_update_position(QEMUFile
*f
, size_t size
);
167 static inline unsigned int qemu_get_ubyte(QEMUFile
*f
)
169 return (unsigned int)qemu_get_byte(f
);
172 #define qemu_get_sbyte qemu_get_byte
174 unsigned int qemu_get_be16(QEMUFile
*f
);
175 unsigned int qemu_get_be32(QEMUFile
*f
);
176 uint64_t qemu_get_be64(QEMUFile
*f
);
178 int qemu_file_rate_limit(QEMUFile
*f
);
179 void qemu_file_reset_rate_limit(QEMUFile
*f
);
180 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t new_rate
);
181 int64_t qemu_file_get_rate_limit(QEMUFile
*f
);
182 int qemu_file_get_error(QEMUFile
*f
);
183 void qemu_file_set_error(QEMUFile
*f
, int ret
);
184 int qemu_file_shutdown(QEMUFile
*f
);
185 QEMUFile
*qemu_file_get_return_path(QEMUFile
*f
);
186 void qemu_fflush(QEMUFile
*f
);
187 void qemu_file_set_blocking(QEMUFile
*f
, bool block
);
189 static inline void qemu_put_be64s(QEMUFile
*f
, const uint64_t *pv
)
191 qemu_put_be64(f
, *pv
);
194 static inline void qemu_put_be32s(QEMUFile
*f
, const uint32_t *pv
)
196 qemu_put_be32(f
, *pv
);
199 static inline void qemu_put_be16s(QEMUFile
*f
, const uint16_t *pv
)
201 qemu_put_be16(f
, *pv
);
204 static inline void qemu_put_8s(QEMUFile
*f
, const uint8_t *pv
)
206 qemu_put_byte(f
, *pv
);
209 static inline void qemu_get_be64s(QEMUFile
*f
, uint64_t *pv
)
211 *pv
= qemu_get_be64(f
);
214 static inline void qemu_get_be32s(QEMUFile
*f
, uint32_t *pv
)
216 *pv
= qemu_get_be32(f
);
219 static inline void qemu_get_be16s(QEMUFile
*f
, uint16_t *pv
)
221 *pv
= qemu_get_be16(f
);
224 static inline void qemu_get_8s(QEMUFile
*f
, uint8_t *pv
)
226 *pv
= qemu_get_byte(f
);
229 // Signed versions for type safety
230 static inline void qemu_put_sbuffer(QEMUFile
*f
, const int8_t *buf
, size_t size
)
232 qemu_put_buffer(f
, (const uint8_t *)buf
, size
);
235 static inline void qemu_put_sbe16(QEMUFile
*f
, int v
)
237 qemu_put_be16(f
, (unsigned int)v
);
240 static inline void qemu_put_sbe32(QEMUFile
*f
, int v
)
242 qemu_put_be32(f
, (unsigned int)v
);
245 static inline void qemu_put_sbe64(QEMUFile
*f
, int64_t v
)
247 qemu_put_be64(f
, (uint64_t)v
);
250 static inline size_t qemu_get_sbuffer(QEMUFile
*f
, int8_t *buf
, int size
)
252 return qemu_get_buffer(f
, (uint8_t *)buf
, size
);
255 static inline int qemu_get_sbe16(QEMUFile
*f
)
257 return (int)qemu_get_be16(f
);
260 static inline int qemu_get_sbe32(QEMUFile
*f
)
262 return (int)qemu_get_be32(f
);
265 static inline int64_t qemu_get_sbe64(QEMUFile
*f
)
267 return (int64_t)qemu_get_be64(f
);
270 static inline void qemu_put_s8s(QEMUFile
*f
, const int8_t *pv
)
272 qemu_put_8s(f
, (const uint8_t *)pv
);
275 static inline void qemu_put_sbe16s(QEMUFile
*f
, const int16_t *pv
)
277 qemu_put_be16s(f
, (const uint16_t *)pv
);
280 static inline void qemu_put_sbe32s(QEMUFile
*f
, const int32_t *pv
)
282 qemu_put_be32s(f
, (const uint32_t *)pv
);
285 static inline void qemu_put_sbe64s(QEMUFile
*f
, const int64_t *pv
)
287 qemu_put_be64s(f
, (const uint64_t *)pv
);
290 static inline void qemu_get_s8s(QEMUFile
*f
, int8_t *pv
)
292 qemu_get_8s(f
, (uint8_t *)pv
);
295 static inline void qemu_get_sbe16s(QEMUFile
*f
, int16_t *pv
)
297 qemu_get_be16s(f
, (uint16_t *)pv
);
300 static inline void qemu_get_sbe32s(QEMUFile
*f
, int32_t *pv
)
302 qemu_get_be32s(f
, (uint32_t *)pv
);
305 static inline void qemu_get_sbe64s(QEMUFile
*f
, int64_t *pv
)
307 qemu_get_be64s(f
, (uint64_t *)pv
);
310 size_t qemu_get_counted_string(QEMUFile
*f
, char buf
[256]);