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
24 #include "qemu/osdep.h"
26 #include "qemu/madvise.h"
27 #include "qemu/error-report.h"
29 #include "migration.h"
30 #include "migration-stats.h"
31 #include "qemu-file.h"
34 #include "qapi/error.h"
36 #define IO_BUF_SIZE 32768
37 #define MAX_IOV_SIZE MIN_CONST(IOV_MAX, 64)
40 const QEMUFileHooks
*hooks
;
44 /* The sum of bytes transferred on the wire */
45 uint64_t total_transferred
;
48 int buf_size
; /* 0 when writing */
49 uint8_t buf
[IO_BUF_SIZE
];
51 DECLARE_BITMAP(may_free
, MAX_IOV_SIZE
);
52 struct iovec iov
[MAX_IOV_SIZE
];
56 Error
*last_error_obj
;
60 * Stop a file from being read/written - not all backing files can do this
61 * typically only sockets can.
63 * TODO: convert to propagate Error objects instead of squashing
64 * to a fixed errno value
66 int qemu_file_shutdown(QEMUFile
*f
)
69 * We must set qemufile error before the real shutdown(), otherwise
70 * there can be a race window where we thought IO all went though
71 * (because last_error==NULL) but actually IO has already stopped.
73 * If without correct ordering, the race can happen like this:
75 * page receiver other thread
76 * ------------- ------------
79 * returns 0 (buffer all zero)
80 * (we didn't check this retcode)
81 * try to detect IO error
82 * last_error==NULL, IO okay
83 * install ALL-ZERO page
88 qemu_file_set_error(f
, -EIO
);
91 if (!qio_channel_has_feature(f
->ioc
,
92 QIO_CHANNEL_FEATURE_SHUTDOWN
)) {
96 if (qio_channel_shutdown(f
->ioc
, QIO_CHANNEL_SHUTDOWN_BOTH
, NULL
) < 0) {
103 static QEMUFile
*qemu_file_new_impl(QIOChannel
*ioc
, bool is_writable
)
107 f
= g_new0(QEMUFile
, 1);
111 f
->is_writable
= is_writable
;
117 * Result: QEMUFile* for a 'return path' for comms in the opposite direction
118 * NULL if not available
120 QEMUFile
*qemu_file_get_return_path(QEMUFile
*f
)
122 return qemu_file_new_impl(f
->ioc
, !f
->is_writable
);
125 QEMUFile
*qemu_file_new_output(QIOChannel
*ioc
)
127 return qemu_file_new_impl(ioc
, true);
130 QEMUFile
*qemu_file_new_input(QIOChannel
*ioc
)
132 return qemu_file_new_impl(ioc
, false);
135 void qemu_file_set_hooks(QEMUFile
*f
, const QEMUFileHooks
*hooks
)
141 * Get last error for stream f with optional Error*
143 * Return negative error value if there has been an error on previous
144 * operations, return 0 if no error happened.
146 * If errp is specified, a verbose error message will be copied over.
148 static int qemu_file_get_error_obj(QEMUFile
*f
, Error
**errp
)
150 if (!f
->last_error
) {
154 /* There is an error */
156 if (f
->last_error_obj
) {
157 *errp
= error_copy(f
->last_error_obj
);
159 error_setg_errno(errp
, -f
->last_error
, "Channel error");
163 return f
->last_error
;
167 * Get last error for either stream f1 or f2 with optional Error*.
168 * The error returned (non-zero) can be either from f1 or f2.
170 * If any of the qemufile* is NULL, then skip the check on that file.
172 * When there is no error on both qemufile, zero is returned.
174 int qemu_file_get_error_obj_any(QEMUFile
*f1
, QEMUFile
*f2
, Error
**errp
)
179 ret
= qemu_file_get_error_obj(f1
, errp
);
180 /* If there's already error detected, return */
187 ret
= qemu_file_get_error_obj(f2
, errp
);
194 * Set the last error for stream f with optional Error*
196 void qemu_file_set_error_obj(QEMUFile
*f
, int ret
, Error
*err
)
198 if (f
->last_error
== 0 && ret
) {
200 error_propagate(&f
->last_error_obj
, err
);
202 error_report_err(err
);
207 * Get last error for stream f
209 * Return negative error value if there has been an error on previous
210 * operations, return 0 if no error happened.
213 int qemu_file_get_error(QEMUFile
*f
)
215 return qemu_file_get_error_obj(f
, NULL
);
219 * Set the last error for stream f
221 void qemu_file_set_error(QEMUFile
*f
, int ret
)
223 qemu_file_set_error_obj(f
, ret
, NULL
);
226 static bool qemu_file_is_writable(QEMUFile
*f
)
228 return f
->is_writable
;
231 static void qemu_iovec_release_ram(QEMUFile
*f
)
236 /* Find and release all the contiguous memory ranges marked as may_free. */
237 idx
= find_next_bit(f
->may_free
, f
->iovcnt
, 0);
238 if (idx
>= f
->iovcnt
) {
243 /* The madvise() in the loop is called for iov within a continuous range and
244 * then reinitialize the iov. And in the end, madvise() is called for the
247 while ((idx
= find_next_bit(f
->may_free
, f
->iovcnt
, idx
+ 1)) < f
->iovcnt
) {
248 /* check for adjacent buffer and coalesce them */
249 if (iov
.iov_base
+ iov
.iov_len
== f
->iov
[idx
].iov_base
) {
250 iov
.iov_len
+= f
->iov
[idx
].iov_len
;
253 if (qemu_madvise(iov
.iov_base
, iov
.iov_len
, QEMU_MADV_DONTNEED
) < 0) {
254 error_report("migrate: madvise DONTNEED failed %p %zd: %s",
255 iov
.iov_base
, iov
.iov_len
, strerror(errno
));
259 if (qemu_madvise(iov
.iov_base
, iov
.iov_len
, QEMU_MADV_DONTNEED
) < 0) {
260 error_report("migrate: madvise DONTNEED failed %p %zd: %s",
261 iov
.iov_base
, iov
.iov_len
, strerror(errno
));
263 memset(f
->may_free
, 0, sizeof(f
->may_free
));
268 * Flushes QEMUFile buffer
270 * This will flush all pending data. If data was only partially flushed, it
271 * will set an error state.
273 void qemu_fflush(QEMUFile
*f
)
275 if (!qemu_file_is_writable(f
)) {
279 if (qemu_file_get_error(f
)) {
283 Error
*local_error
= NULL
;
284 if (qio_channel_writev_all(f
->ioc
,
287 qemu_file_set_error_obj(f
, -EIO
, local_error
);
289 uint64_t size
= iov_size(f
->iov
, f
->iovcnt
);
290 f
->total_transferred
+= size
;
293 qemu_iovec_release_ram(f
);
300 void ram_control_before_iterate(QEMUFile
*f
, uint64_t flags
)
304 if (f
->hooks
&& f
->hooks
->before_ram_iterate
) {
305 ret
= f
->hooks
->before_ram_iterate(f
, flags
, NULL
);
307 qemu_file_set_error(f
, ret
);
312 void ram_control_after_iterate(QEMUFile
*f
, uint64_t flags
)
316 if (f
->hooks
&& f
->hooks
->after_ram_iterate
) {
317 ret
= f
->hooks
->after_ram_iterate(f
, flags
, NULL
);
319 qemu_file_set_error(f
, ret
);
324 void ram_control_load_hook(QEMUFile
*f
, uint64_t flags
, void *data
)
326 if (f
->hooks
&& f
->hooks
->hook_ram_load
) {
327 int ret
= f
->hooks
->hook_ram_load(f
, flags
, data
);
329 qemu_file_set_error(f
, ret
);
334 int ram_control_save_page(QEMUFile
*f
, ram_addr_t block_offset
,
335 ram_addr_t offset
, size_t size
)
337 if (f
->hooks
&& f
->hooks
->save_page
) {
338 int ret
= f
->hooks
->save_page(f
, block_offset
, offset
, size
);
340 * RAM_SAVE_CONTROL_* are negative values
342 if (ret
!= RAM_SAVE_CONTROL_DELAYED
&&
343 ret
!= RAM_SAVE_CONTROL_NOT_SUPP
) {
345 qemu_file_set_error(f
, ret
);
351 return RAM_SAVE_CONTROL_NOT_SUPP
;
355 * Attempt to fill the buffer from the underlying file
356 * Returns the number of bytes read, or negative value for an error.
358 * Note that it can return a partially full buffer even in a not error/not EOF
359 * case if the underlying file descriptor gives a short read, and that can
360 * happen even on a blocking fd.
362 static ssize_t coroutine_mixed_fn
qemu_fill_buffer(QEMUFile
*f
)
366 Error
*local_error
= NULL
;
368 assert(!qemu_file_is_writable(f
));
370 pending
= f
->buf_size
- f
->buf_index
;
372 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
375 f
->buf_size
= pending
;
377 if (qemu_file_get_error(f
)) {
382 len
= qio_channel_read(f
->ioc
,
383 (char *)f
->buf
+ pending
,
384 IO_BUF_SIZE
- pending
,
386 if (len
== QIO_CHANNEL_ERR_BLOCK
) {
387 if (qemu_in_coroutine()) {
388 qio_channel_yield(f
->ioc
, G_IO_IN
);
390 qio_channel_wait(f
->ioc
, G_IO_IN
);
392 } else if (len
< 0) {
395 } while (len
== QIO_CHANNEL_ERR_BLOCK
);
399 f
->total_transferred
+= len
;
400 } else if (len
== 0) {
401 qemu_file_set_error_obj(f
, -EIO
, local_error
);
403 qemu_file_set_error_obj(f
, len
, local_error
);
411 * Returns negative error value if any error happened on previous operations or
412 * while closing the file. Returns 0 or positive number on success.
414 * The meaning of return value on success depends on the specific backend
417 int qemu_fclose(QEMUFile
*f
)
421 ret
= qemu_file_get_error(f
);
423 ret2
= qio_channel_close(f
->ioc
, NULL
);
427 g_clear_pointer(&f
->ioc
, object_unref
);
429 /* If any error was spotted before closing, we should report it
430 * instead of the close() return value.
435 error_free(f
->last_error_obj
);
437 trace_qemu_file_fclose();
442 * Add buf to iovec. Do flush if iovec is full.
445 * 1 iovec is full and flushed
446 * 0 iovec is not flushed
449 static int add_to_iovec(QEMUFile
*f
, const uint8_t *buf
, size_t size
,
452 /* check for adjacent buffer and coalesce them */
453 if (f
->iovcnt
> 0 && buf
== f
->iov
[f
->iovcnt
- 1].iov_base
+
454 f
->iov
[f
->iovcnt
- 1].iov_len
&&
455 may_free
== test_bit(f
->iovcnt
- 1, f
->may_free
))
457 f
->iov
[f
->iovcnt
- 1].iov_len
+= size
;
459 if (f
->iovcnt
>= MAX_IOV_SIZE
) {
460 /* Should only happen if a previous fflush failed */
461 assert(qemu_file_get_error(f
) || !qemu_file_is_writable(f
));
465 set_bit(f
->iovcnt
, f
->may_free
);
467 f
->iov
[f
->iovcnt
].iov_base
= (uint8_t *)buf
;
468 f
->iov
[f
->iovcnt
++].iov_len
= size
;
471 if (f
->iovcnt
>= MAX_IOV_SIZE
) {
479 static void add_buf_to_iovec(QEMUFile
*f
, size_t len
)
481 if (!add_to_iovec(f
, f
->buf
+ f
->buf_index
, len
, false)) {
483 if (f
->buf_index
== IO_BUF_SIZE
) {
489 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, size_t size
,
496 add_to_iovec(f
, buf
, size
, may_free
);
499 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, size_t size
)
508 l
= IO_BUF_SIZE
- f
->buf_index
;
512 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
513 add_buf_to_iovec(f
, l
);
514 if (qemu_file_get_error(f
)) {
522 void qemu_put_byte(QEMUFile
*f
, int v
)
528 f
->buf
[f
->buf_index
] = v
;
529 add_buf_to_iovec(f
, 1);
532 void qemu_file_skip(QEMUFile
*f
, int size
)
534 if (f
->buf_index
+ size
<= f
->buf_size
) {
535 f
->buf_index
+= size
;
540 * Read 'size' bytes from file (at 'offset') without moving the
541 * pointer and set 'buf' to point to that data.
543 * It will return size bytes unless there was an error, in which case it will
544 * return as many as it managed to read (assuming blocking fd's which
545 * all current QEMUFile are)
547 size_t coroutine_mixed_fn
qemu_peek_buffer(QEMUFile
*f
, uint8_t **buf
, size_t size
, size_t offset
)
552 assert(!qemu_file_is_writable(f
));
553 assert(offset
< IO_BUF_SIZE
);
554 assert(size
<= IO_BUF_SIZE
- offset
);
556 /* The 1st byte to read from */
557 index
= f
->buf_index
+ offset
;
558 /* The number of available bytes starting at index */
559 pending
= f
->buf_size
- index
;
562 * qemu_fill_buffer might return just a few bytes, even when there isn't
563 * an error, so loop collecting them until we get enough.
565 while (pending
< size
) {
566 int received
= qemu_fill_buffer(f
);
572 index
= f
->buf_index
+ offset
;
573 pending
= f
->buf_size
- index
;
579 if (size
> pending
) {
583 *buf
= f
->buf
+ index
;
588 * Read 'size' bytes of data from the file into buf.
589 * 'size' can be larger than the internal buffer.
591 * It will return size bytes unless there was an error, in which case it will
592 * return as many as it managed to read (assuming blocking fd's which
593 * all current QEMUFile are)
595 size_t coroutine_mixed_fn
qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, size_t size
)
597 size_t pending
= size
;
600 while (pending
> 0) {
604 res
= qemu_peek_buffer(f
, &src
, MIN(pending
, IO_BUF_SIZE
), 0);
608 memcpy(buf
, src
, res
);
609 qemu_file_skip(f
, res
);
618 * Read 'size' bytes of data from the file.
619 * 'size' can be larger than the internal buffer.
622 * may be held on an internal buffer (in which case *buf is updated
623 * to point to it) that is valid until the next qemu_file operation.
625 * will be copied to the *buf that was passed in.
627 * The code tries to avoid the copy if possible.
629 * It will return size bytes unless there was an error, in which case it will
630 * return as many as it managed to read (assuming blocking fd's which
631 * all current QEMUFile are)
633 * Note: Since **buf may get changed, the caller should take care to
634 * keep a pointer to the original buffer if it needs to deallocate it.
636 size_t coroutine_mixed_fn
qemu_get_buffer_in_place(QEMUFile
*f
, uint8_t **buf
, size_t size
)
638 if (size
< IO_BUF_SIZE
) {
642 res
= qemu_peek_buffer(f
, &src
, size
, 0);
645 qemu_file_skip(f
, res
);
651 return qemu_get_buffer(f
, *buf
, size
);
655 * Peeks a single byte from the buffer; this isn't guaranteed to work if
656 * offset leaves a gap after the previous read/peeked data.
658 int coroutine_mixed_fn
qemu_peek_byte(QEMUFile
*f
, int offset
)
660 int index
= f
->buf_index
+ offset
;
662 assert(!qemu_file_is_writable(f
));
663 assert(offset
< IO_BUF_SIZE
);
665 if (index
>= f
->buf_size
) {
667 index
= f
->buf_index
+ offset
;
668 if (index
>= f
->buf_size
) {
672 return f
->buf
[index
];
675 int coroutine_mixed_fn
qemu_get_byte(QEMUFile
*f
)
679 result
= qemu_peek_byte(f
, 0);
680 qemu_file_skip(f
, 1);
684 uint64_t qemu_file_transferred_noflush(QEMUFile
*f
)
686 uint64_t ret
= f
->total_transferred
;
689 for (i
= 0; i
< f
->iovcnt
; i
++) {
690 ret
+= f
->iov
[i
].iov_len
;
696 uint64_t qemu_file_transferred(QEMUFile
*f
)
699 return f
->total_transferred
;
702 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
704 qemu_put_byte(f
, v
>> 8);
708 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
710 qemu_put_byte(f
, v
>> 24);
711 qemu_put_byte(f
, v
>> 16);
712 qemu_put_byte(f
, v
>> 8);
716 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
718 qemu_put_be32(f
, v
>> 32);
722 unsigned int qemu_get_be16(QEMUFile
*f
)
725 v
= qemu_get_byte(f
) << 8;
726 v
|= qemu_get_byte(f
);
730 unsigned int qemu_get_be32(QEMUFile
*f
)
733 v
= (unsigned int)qemu_get_byte(f
) << 24;
734 v
|= qemu_get_byte(f
) << 16;
735 v
|= qemu_get_byte(f
) << 8;
736 v
|= qemu_get_byte(f
);
740 uint64_t qemu_get_be64(QEMUFile
*f
)
743 v
= (uint64_t)qemu_get_be32(f
) << 32;
744 v
|= qemu_get_be32(f
);
748 /* return the size after compression, or negative value on error */
749 static int qemu_compress_data(z_stream
*stream
, uint8_t *dest
, size_t dest_len
,
750 const uint8_t *source
, size_t source_len
)
754 err
= deflateReset(stream
);
759 stream
->avail_in
= source_len
;
760 stream
->next_in
= (uint8_t *)source
;
761 stream
->avail_out
= dest_len
;
762 stream
->next_out
= dest
;
764 err
= deflate(stream
, Z_FINISH
);
765 if (err
!= Z_STREAM_END
) {
769 return stream
->next_out
- dest
;
772 /* Compress size bytes of data start at p and store the compressed
773 * data to the buffer of f.
775 * Since the file is dummy file with empty_ops, return -1 if f has no space to
776 * save the compressed data.
778 ssize_t
qemu_put_compression_data(QEMUFile
*f
, z_stream
*stream
,
779 const uint8_t *p
, size_t size
)
781 ssize_t blen
= IO_BUF_SIZE
- f
->buf_index
- sizeof(int32_t);
783 if (blen
< compressBound(size
)) {
787 blen
= qemu_compress_data(stream
, f
->buf
+ f
->buf_index
+ sizeof(int32_t),
793 qemu_put_be32(f
, blen
);
794 add_buf_to_iovec(f
, blen
);
795 return blen
+ sizeof(int32_t);
798 /* Put the data in the buffer of f_src to the buffer of f_des, and
799 * then reset the buf_index of f_src to 0.
802 int qemu_put_qemu_file(QEMUFile
*f_des
, QEMUFile
*f_src
)
806 if (f_src
->buf_index
> 0) {
807 len
= f_src
->buf_index
;
808 qemu_put_buffer(f_des
, f_src
->buf
, f_src
->buf_index
);
809 f_src
->buf_index
= 0;
816 * Check if the writable buffer is empty
819 bool qemu_file_buffer_empty(QEMUFile
*file
)
821 assert(qemu_file_is_writable(file
));
823 return !file
->iovcnt
;
827 * Get a string whose length is determined by a single preceding byte
828 * A preallocated 256 byte buffer must be passed in.
829 * Returns: len on success and a 0 terminated string in the buffer
831 * (Note a 0 length string will return 0 either way)
833 size_t coroutine_fn
qemu_get_counted_string(QEMUFile
*f
, char buf
[256])
835 size_t len
= qemu_get_byte(f
);
836 size_t res
= qemu_get_buffer(f
, (uint8_t *)buf
, len
);
840 return res
== len
? res
: 0;
844 * Put a string with one preceding byte containing its length. The length of
845 * the string should be less than 256.
847 void qemu_put_counted_string(QEMUFile
*f
, const char *str
)
849 size_t len
= strlen(str
);
852 qemu_put_byte(f
, len
);
853 qemu_put_buffer(f
, (const uint8_t *)str
, len
);
857 * Set the blocking state of the QEMUFile.
858 * Note: On some transports the OS only keeps a single blocking state for
859 * both directions, and thus changing the blocking on the main
860 * QEMUFile can also affect the return path.
862 void qemu_file_set_blocking(QEMUFile
*f
, bool block
)
864 qio_channel_set_blocking(f
->ioc
, block
, NULL
);
870 * Get the ioc object for the file, without incrementing
871 * the reference count.
873 * Returns: the ioc object
875 QIOChannel
*qemu_file_get_ioc(QEMUFile
*file
)
881 * Read size bytes from QEMUFile f and write them to fd.
883 int qemu_file_get_to_fd(QEMUFile
*f
, int fd
, size_t size
)
886 size_t pending
= f
->buf_size
- f
->buf_index
;
890 rc
= qemu_fill_buffer(f
);
900 rc
= write(fd
, f
->buf
+ f
->buf_index
, MIN(pending
, size
));