blob: 2dea81f21e2fe8e0413a83d0e76543933d1551c6 [file] [log] [blame]
Paolo Bonzini701a8f72012-01-13 17:07:20 +01001/*
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#ifndef QEMU_FILE_H
25#define QEMU_FILE_H 1
Michael R. Hines43487c62013-06-25 21:35:35 -040026#include "exec/cpu-common.h"
Paolo Bonzini701a8f72012-01-13 17:07:20 +010027
Dr. David Alan Gilbertdeb22f92014-10-10 12:39:04 +010028
Paolo Bonzini701a8f72012-01-13 17:07:20 +010029/* 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
Daniel P. Berrangebaf51e72016-04-27 11:04:54 +010031 * streaming. The handler must write all of the data or return a negative
32 * errno value.
Paolo Bonzini701a8f72012-01-13 17:07:20 +010033 */
Dr. David Alan Gilberta202a4c2015-08-13 11:51:33 +010034typedef ssize_t (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf,
35 int64_t pos, size_t size);
Paolo Bonzini701a8f72012-01-13 17:07:20 +010036
37/* Read a chunk of data from a file at the given position. The pos argument
38 * can be ignored if the file is only be used for streaming. The number of
39 * bytes actually read should be returned.
40 */
Dr. David Alan Gilberta202a4c2015-08-13 11:51:33 +010041typedef ssize_t (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf,
42 int64_t pos, size_t size);
Paolo Bonzini701a8f72012-01-13 17:07:20 +010043
44/* Close a file
45 *
46 * Return negative error number on error, 0 or positive value on success.
47 *
48 * The meaning of return value on success depends on the specific back-end being
49 * used.
50 */
51typedef int (QEMUFileCloseFunc)(void *opaque);
52
Paolo Bonzini70eb6332012-08-08 10:20:18 +020053/* Called to return the OS file descriptor associated to the QEMUFile.
54 */
55typedef int (QEMUFileGetFD)(void *opaque);
56
Daniel P. Berrange06ad5132016-04-27 11:04:56 +010057/* Called to change the blocking mode of the file
58 */
59typedef int (QEMUFileSetBlocking)(void *opaque, bool enabled);
60
Orit Wassermand9138292013-03-22 16:47:57 +020061/*
Daniel P. Berrangebaf51e72016-04-27 11:04:54 +010062 * This function writes an iovec to file. The handler must write all
63 * of the data or return a negative errno value.
Orit Wassermand9138292013-03-22 16:47:57 +020064 */
65typedef ssize_t (QEMUFileWritevBufferFunc)(void *opaque, struct iovec *iov,
Kevin Wolf05fcc842013-04-05 21:27:54 +020066 int iovcnt, int64_t pos);
Orit Wassermand9138292013-03-22 16:47:57 +020067
Michael R. Hines43487c62013-06-25 21:35:35 -040068/*
69 * This function provides hooks around different
70 * stages of RAM migration.
Dr. David Alan Gilbert632e3a52015-06-11 18:17:23 +010071 * 'opaque' is the backend specific data in QEMUFile
72 * 'data' is call specific data associated with the 'flags' value
Michael R. Hines43487c62013-06-25 21:35:35 -040073 */
Dr. David Alan Gilbert632e3a52015-06-11 18:17:23 +010074typedef int (QEMURamHookFunc)(QEMUFile *f, void *opaque, uint64_t flags,
75 void *data);
Michael R. Hines43487c62013-06-25 21:35:35 -040076
77/*
78 * Constants used by ram_control_* hooks
79 */
Dr. David Alan Gilbert632e3a52015-06-11 18:17:23 +010080#define RAM_CONTROL_SETUP 0
81#define RAM_CONTROL_ROUND 1
82#define RAM_CONTROL_HOOK 2
83#define RAM_CONTROL_FINISH 3
84#define RAM_CONTROL_BLOCK_REG 4
Michael R. Hines43487c62013-06-25 21:35:35 -040085
86/*
87 * This function allows override of where the RAM page
88 * is saved (such as RDMA, for example.)
89 */
90typedef size_t (QEMURamSaveFunc)(QEMUFile *f, void *opaque,
91 ram_addr_t block_offset,
92 ram_addr_t offset,
93 size_t size,
Juan Quintela6e1dea42015-02-12 19:02:42 +010094 uint64_t *bytes_sent);
Michael R. Hines43487c62013-06-25 21:35:35 -040095
Dr. David Alan Gilberte1a8c9b2015-01-08 11:11:30 +000096/*
Dr. David Alan Gilbertadc468e2015-11-05 18:10:43 +000097 * Return a QEMUFile for comms in the opposite direction
98 */
99typedef QEMUFile *(QEMURetPathFunc)(void *opaque);
100
101/*
Dr. David Alan Gilberte1a8c9b2015-01-08 11:11:30 +0000102 * Stop any read or write (depending on flags) on the underlying
103 * transport on the QEMUFile.
104 * Existing blocking reads/writes must be woken
105 * Returns 0 on success, -err on error
106 */
107typedef int (QEMUFileShutdownFunc)(void *opaque, bool rd, bool wr);
108
Paolo Bonzini9229bf32012-08-08 10:15:15 +0200109typedef struct QEMUFileOps {
110 QEMUFilePutBufferFunc *put_buffer;
111 QEMUFileGetBufferFunc *get_buffer;
112 QEMUFileCloseFunc *close;
Paolo Bonzini70eb6332012-08-08 10:20:18 +0200113 QEMUFileGetFD *get_fd;
Daniel P. Berrange06ad5132016-04-27 11:04:56 +0100114 QEMUFileSetBlocking *set_blocking;
Orit Wassermand9138292013-03-22 16:47:57 +0200115 QEMUFileWritevBufferFunc *writev_buffer;
Daniel P. Berrange0436e092016-04-27 11:04:55 +0100116 QEMURetPathFunc *get_return_path;
117 QEMUFileShutdownFunc *shut_down;
118} QEMUFileOps;
119
120typedef struct QEMUFileHooks {
Michael R. Hines43487c62013-06-25 21:35:35 -0400121 QEMURamHookFunc *before_ram_iterate;
122 QEMURamHookFunc *after_ram_iterate;
123 QEMURamHookFunc *hook_ram_load;
124 QEMURamSaveFunc *save_page;
Daniel P. Berrange0436e092016-04-27 11:04:55 +0100125} QEMUFileHooks;
Paolo Bonzini9229bf32012-08-08 10:15:15 +0200126
Dr. David Alan Gilbertdeb22f92014-10-10 12:39:04 +0100127struct QEMUSizedBuffer {
128 struct iovec *iov;
129 size_t n_iov;
130 size_t size; /* total allocated size in all iov's */
131 size_t used; /* number of used bytes */
132};
133
Paolo Bonzini9229bf32012-08-08 10:15:15 +0200134QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100135QEMUFile *qemu_fopen(const char *filename, const char *mode);
136QEMUFile *qemu_fdopen(int fd, const char *mode);
Paolo Bonzini0cc3f3c2013-02-22 17:36:39 +0100137QEMUFile *qemu_fopen_socket(int fd, const char *mode);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100138QEMUFile *qemu_popen_cmd(const char *command, const char *mode);
Dr. David Alan Gilbertdeb22f92014-10-10 12:39:04 +0100139QEMUFile *qemu_bufopen(const char *mode, QEMUSizedBuffer *input);
Daniel P. Berrange0436e092016-04-27 11:04:55 +0100140void qemu_file_set_hooks(QEMUFile *f, const QEMUFileHooks *hooks);
Paolo Bonzini70eb6332012-08-08 10:20:18 +0200141int qemu_get_fd(QEMUFile *f);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100142int qemu_fclose(QEMUFile *f);
Stefan Hajnocziad55ab42013-02-12 10:37:14 +0100143int64_t qemu_ftell(QEMUFile *f);
Alexander Graf97221402015-01-22 15:01:38 +0100144int64_t qemu_ftell_fast(QEMUFile *f);
Dr. David Alan Gilbert56f38352015-08-13 11:51:34 +0100145void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, size_t size);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100146void qemu_put_byte(QEMUFile *f, int v);
Orit Wasserman6181ec22013-03-22 16:48:02 +0200147/*
148 * put_buffer without copying the buffer.
149 * The buffer should be available till it is sent asynchronously.
150 */
Dr. David Alan Gilbert56f38352015-08-13 11:51:34 +0100151void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size);
Michael R. Hinesbc1256f2013-06-25 21:35:31 -0400152bool qemu_file_mode_is_not_valid(const char *mode);
Eduardo Habkoste68dd362014-10-01 17:34:34 -0300153bool qemu_file_is_writable(QEMUFile *f);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100154
Dr. David Alan Gilbertdeb22f92014-10-10 12:39:04 +0100155QEMUSizedBuffer *qsb_create(const uint8_t *buffer, size_t len);
Dr. David Alan Gilbertdeb22f92014-10-10 12:39:04 +0100156void qsb_free(QEMUSizedBuffer *);
157size_t qsb_set_length(QEMUSizedBuffer *qsb, size_t length);
158size_t qsb_get_length(const QEMUSizedBuffer *qsb);
159ssize_t qsb_get_buffer(const QEMUSizedBuffer *, off_t start, size_t count,
160 uint8_t *buf);
161ssize_t qsb_write_at(QEMUSizedBuffer *qsb, const uint8_t *buf,
162 off_t pos, size_t count);
163
164
165/*
166 * For use on files opened with qemu_bufopen
167 */
168const QEMUSizedBuffer *qemu_buf_get(QEMUFile *f);
169
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100170static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v)
171{
172 qemu_put_byte(f, (int)v);
173}
174
175#define qemu_put_sbyte qemu_put_byte
176
177void qemu_put_be16(QEMUFile *f, unsigned int v);
178void qemu_put_be32(QEMUFile *f, unsigned int v);
179void qemu_put_be64(QEMUFile *f, uint64_t v);
Dr. David Alan Gilbert56f38352015-08-13 11:51:34 +0100180size_t qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset);
181size_t qemu_get_buffer(QEMUFile *f, uint8_t *buf, size_t size);
Dr. David Alan Gilbert9504fb52015-11-05 18:10:35 +0000182size_t qemu_get_buffer_in_place(QEMUFile *f, uint8_t **buf, size_t size);
Liang Li44f0ead2015-03-23 16:32:19 +0800183ssize_t qemu_put_compression_data(QEMUFile *f, const uint8_t *p, size_t size,
184 int level);
185int qemu_put_qemu_file(QEMUFile *f_des, QEMUFile *f_src);
Dr. David Alan Gilbert9504fb52015-11-05 18:10:35 +0000186
Dr. David Alan Gilbert548f52e2014-04-08 15:29:37 +0100187/*
188 * Note that you can only peek continuous bytes from where the current pointer
189 * is; you aren't guaranteed to be able to peak to +n bytes unless you've
190 * previously peeked +n-1.
191 */
Eduardo Habkostc9615142013-11-28 12:01:10 -0200192int qemu_peek_byte(QEMUFile *f, int offset);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100193int qemu_get_byte(QEMUFile *f);
Eduardo Habkostc9615142013-11-28 12:01:10 -0200194void qemu_file_skip(QEMUFile *f, int size);
Michael R. Hines2b0ce072013-06-25 21:35:28 -0400195void qemu_update_position(QEMUFile *f, size_t size);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100196
197static inline unsigned int qemu_get_ubyte(QEMUFile *f)
198{
199 return (unsigned int)qemu_get_byte(f);
200}
201
202#define qemu_get_sbyte qemu_get_byte
203
204unsigned int qemu_get_be16(QEMUFile *f);
205unsigned int qemu_get_be32(QEMUFile *f);
206uint64_t qemu_get_be64(QEMUFile *f);
207
208int qemu_file_rate_limit(QEMUFile *f);
Paolo Bonzini1964a392013-02-22 17:36:45 +0100209void qemu_file_reset_rate_limit(QEMUFile *f);
210void qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100211int64_t qemu_file_get_rate_limit(QEMUFile *f);
212int qemu_file_get_error(QEMUFile *f);
Eduardo Habkostc9615142013-11-28 12:01:10 -0200213void qemu_file_set_error(QEMUFile *f, int ret);
Dr. David Alan Gilberte1a8c9b2015-01-08 11:11:30 +0000214int qemu_file_shutdown(QEMUFile *f);
Dr. David Alan Gilbertadc468e2015-11-05 18:10:43 +0000215QEMUFile *qemu_file_get_return_path(QEMUFile *f);
Michael R. Hinesbe903b22013-06-25 21:35:32 -0400216void qemu_fflush(QEMUFile *f);
Dr. David Alan Gilberta800cd52015-11-05 18:10:36 +0000217void qemu_file_set_blocking(QEMUFile *f, bool block);
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100218
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100219static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
220{
221 qemu_put_be64(f, *pv);
222}
223
224static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
225{
226 qemu_put_be32(f, *pv);
227}
228
229static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
230{
231 qemu_put_be16(f, *pv);
232}
233
234static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
235{
236 qemu_put_byte(f, *pv);
237}
238
239static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
240{
241 *pv = qemu_get_be64(f);
242}
243
244static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
245{
246 *pv = qemu_get_be32(f);
247}
248
249static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
250{
251 *pv = qemu_get_be16(f);
252}
253
254static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
255{
256 *pv = qemu_get_byte(f);
257}
258
259// Signed versions for type safety
Dr. David Alan Gilbert56f38352015-08-13 11:51:34 +0100260static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, size_t size)
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100261{
262 qemu_put_buffer(f, (const uint8_t *)buf, size);
263}
264
265static inline void qemu_put_sbe16(QEMUFile *f, int v)
266{
267 qemu_put_be16(f, (unsigned int)v);
268}
269
270static inline void qemu_put_sbe32(QEMUFile *f, int v)
271{
272 qemu_put_be32(f, (unsigned int)v);
273}
274
275static inline void qemu_put_sbe64(QEMUFile *f, int64_t v)
276{
277 qemu_put_be64(f, (uint64_t)v);
278}
279
280static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size)
281{
282 return qemu_get_buffer(f, (uint8_t *)buf, size);
283}
284
285static inline int qemu_get_sbe16(QEMUFile *f)
286{
287 return (int)qemu_get_be16(f);
288}
289
290static inline int qemu_get_sbe32(QEMUFile *f)
291{
292 return (int)qemu_get_be32(f);
293}
294
295static inline int64_t qemu_get_sbe64(QEMUFile *f)
296{
297 return (int64_t)qemu_get_be64(f);
298}
299
300static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv)
301{
302 qemu_put_8s(f, (const uint8_t *)pv);
303}
304
305static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv)
306{
307 qemu_put_be16s(f, (const uint16_t *)pv);
308}
309
310static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv)
311{
312 qemu_put_be32s(f, (const uint32_t *)pv);
313}
314
315static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv)
316{
317 qemu_put_be64s(f, (const uint64_t *)pv);
318}
319
320static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv)
321{
322 qemu_get_8s(f, (uint8_t *)pv);
323}
324
325static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv)
326{
327 qemu_get_be16s(f, (uint16_t *)pv);
328}
329
330static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv)
331{
332 qemu_get_be32s(f, (uint32_t *)pv);
333}
334
335static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv)
336{
337 qemu_get_be64s(f, (uint64_t *)pv);
338}
Dr. David Alan Gilbertb3af1bc2015-05-21 13:24:11 +0100339
340size_t qemu_get_counted_string(QEMUFile *f, char buf[256]);
341
Paolo Bonzini701a8f72012-01-13 17:07:20 +0100342#endif