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
25 #include "config-host.h"
26 #include "qemu-common.h"
30 #include "monitor/monitor.h"
31 #include "sysemu/sysemu.h"
32 #include "qemu/timer.h"
33 #include "audio/audio.h"
34 #include "migration/migration.h"
35 #include "qemu/sockets.h"
36 #include "qemu/queue.h"
37 #include "sysemu/cpus.h"
38 #include "exec/memory.h"
39 #include "qmp-commands.h"
41 #include "qemu/bitops.h"
43 #include "block/snapshot.h"
44 #include "block/qapi.h"
46 #define SELF_ANNOUNCE_ROUNDS 5
49 #define ETH_P_RARP 0x8035
51 #define ARP_HTYPE_ETH 0x0001
52 #define ARP_PTYPE_IP 0x0800
53 #define ARP_OP_REQUEST_REV 0x3
55 static int announce_self_create(uint8_t *buf
,
58 /* Ethernet header. */
59 memset(buf
, 0xff, 6); /* destination MAC addr */
60 memcpy(buf
+ 6, mac_addr
, 6); /* source MAC addr */
61 *(uint16_t *)(buf
+ 12) = htons(ETH_P_RARP
); /* ethertype */
64 *(uint16_t *)(buf
+ 14) = htons(ARP_HTYPE_ETH
); /* hardware addr space */
65 *(uint16_t *)(buf
+ 16) = htons(ARP_PTYPE_IP
); /* protocol addr space */
66 *(buf
+ 18) = 6; /* hardware addr length (ethernet) */
67 *(buf
+ 19) = 4; /* protocol addr length (IPv4) */
68 *(uint16_t *)(buf
+ 20) = htons(ARP_OP_REQUEST_REV
); /* opcode */
69 memcpy(buf
+ 22, mac_addr
, 6); /* source hw addr */
70 memset(buf
+ 28, 0x00, 4); /* source protocol addr */
71 memcpy(buf
+ 32, mac_addr
, 6); /* target hw addr */
72 memset(buf
+ 38, 0x00, 4); /* target protocol addr */
74 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
75 memset(buf
+ 42, 0x00, 18);
77 return 60; /* len (FCS will be added by hardware) */
80 static void qemu_announce_self_iter(NICState
*nic
, void *opaque
)
85 len
= announce_self_create(buf
, nic
->conf
->macaddr
.a
);
87 qemu_send_packet_raw(qemu_get_queue(nic
), buf
, len
);
91 static void qemu_announce_self_once(void *opaque
)
93 static int count
= SELF_ANNOUNCE_ROUNDS
;
94 QEMUTimer
*timer
= *(QEMUTimer
**)opaque
;
96 qemu_foreach_nic(qemu_announce_self_iter
, NULL
);
99 /* delay 50ms, 150ms, 250ms, ... */
100 timer_mod(timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) +
101 50 + (SELF_ANNOUNCE_ROUNDS
- count
- 1) * 100);
108 void qemu_announce_self(void)
110 static QEMUTimer
*timer
;
111 timer
= timer_new_ms(QEMU_CLOCK_REALTIME
, qemu_announce_self_once
, &timer
);
112 qemu_announce_self_once(&timer
);
115 /***********************************************************/
116 /* savevm/loadvm support */
118 #define IO_BUF_SIZE 32768
119 #define MAX_IOV_SIZE MIN(IOV_MAX, 64)
122 const QEMUFileOps
*ops
;
128 int64_t pos
; /* start of buffer when writing, end of buffer
131 int buf_size
; /* 0 when writing */
132 uint8_t buf
[IO_BUF_SIZE
];
134 struct iovec iov
[MAX_IOV_SIZE
];
140 typedef struct QEMUFileStdio
146 typedef struct QEMUFileSocket
152 static ssize_t
socket_writev_buffer(void *opaque
, struct iovec
*iov
, int iovcnt
,
155 QEMUFileSocket
*s
= opaque
;
157 ssize_t size
= iov_size(iov
, iovcnt
);
159 len
= iov_send(s
->fd
, iov
, iovcnt
, 0, size
);
161 len
= -socket_error();
166 static int socket_get_fd(void *opaque
)
168 QEMUFileSocket
*s
= opaque
;
173 static int socket_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
175 QEMUFileSocket
*s
= opaque
;
179 len
= qemu_recv(s
->fd
, buf
, size
, 0);
183 if (socket_error() == EAGAIN
) {
184 yield_until_fd_readable(s
->fd
);
185 } else if (socket_error() != EINTR
) {
191 len
= -socket_error();
196 static int socket_close(void *opaque
)
198 QEMUFileSocket
*s
= opaque
;
204 static int stdio_get_fd(void *opaque
)
206 QEMUFileStdio
*s
= opaque
;
208 return fileno(s
->stdio_file
);
211 static int stdio_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
213 QEMUFileStdio
*s
= opaque
;
214 return fwrite(buf
, 1, size
, s
->stdio_file
);
217 static int stdio_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
219 QEMUFileStdio
*s
= opaque
;
220 FILE *fp
= s
->stdio_file
;
225 bytes
= fread(buf
, 1, size
, fp
);
226 if (bytes
!= 0 || !ferror(fp
)) {
229 if (errno
== EAGAIN
) {
230 yield_until_fd_readable(fileno(fp
));
231 } else if (errno
!= EINTR
) {
238 static int stdio_pclose(void *opaque
)
240 QEMUFileStdio
*s
= opaque
;
242 ret
= pclose(s
->stdio_file
);
245 } else if (!WIFEXITED(ret
) || WEXITSTATUS(ret
) != 0) {
246 /* close succeeded, but non-zero exit code: */
247 ret
= -EIO
; /* fake errno value */
253 static int stdio_fclose(void *opaque
)
255 QEMUFileStdio
*s
= opaque
;
258 if (s
->file
->ops
->put_buffer
|| s
->file
->ops
->writev_buffer
) {
259 int fd
= fileno(s
->stdio_file
);
262 ret
= fstat(fd
, &st
);
263 if (ret
== 0 && S_ISREG(st
.st_mode
)) {
265 * If the file handle is a regular file make sure the
266 * data is flushed to disk before signaling success.
275 if (fclose(s
->stdio_file
) == EOF
) {
282 static const QEMUFileOps stdio_pipe_read_ops
= {
283 .get_fd
= stdio_get_fd
,
284 .get_buffer
= stdio_get_buffer
,
285 .close
= stdio_pclose
288 static const QEMUFileOps stdio_pipe_write_ops
= {
289 .get_fd
= stdio_get_fd
,
290 .put_buffer
= stdio_put_buffer
,
291 .close
= stdio_pclose
294 QEMUFile
*qemu_popen_cmd(const char *command
, const char *mode
)
299 if (mode
== NULL
|| (mode
[0] != 'r' && mode
[0] != 'w') || mode
[1] != 0) {
300 fprintf(stderr
, "qemu_popen: Argument validity check failed\n");
304 stdio_file
= popen(command
, mode
);
305 if (stdio_file
== NULL
) {
309 s
= g_malloc0(sizeof(QEMUFileStdio
));
311 s
->stdio_file
= stdio_file
;
314 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_read_ops
);
316 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_write_ops
);
321 static const QEMUFileOps stdio_file_read_ops
= {
322 .get_fd
= stdio_get_fd
,
323 .get_buffer
= stdio_get_buffer
,
324 .close
= stdio_fclose
327 static const QEMUFileOps stdio_file_write_ops
= {
328 .get_fd
= stdio_get_fd
,
329 .put_buffer
= stdio_put_buffer
,
330 .close
= stdio_fclose
333 static ssize_t
unix_writev_buffer(void *opaque
, struct iovec
*iov
, int iovcnt
,
336 QEMUFileSocket
*s
= opaque
;
338 ssize_t size
= iov_size(iov
, iovcnt
);
344 /* Find the next start position; skip all full-sized vector elements */
345 while (offset
>= iov
[0].iov_len
) {
346 offset
-= iov
[0].iov_len
;
350 /* skip `offset' bytes from the (now) first element, undo it on exit */
352 iov
[0].iov_base
+= offset
;
353 iov
[0].iov_len
-= offset
;
356 len
= writev(s
->fd
, iov
, iovcnt
);
357 } while (len
== -1 && errno
== EINTR
);
362 /* Undo the changes above */
363 iov
[0].iov_base
-= offset
;
364 iov
[0].iov_len
+= offset
;
366 /* Prepare for the next iteration */
375 static int unix_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
377 QEMUFileSocket
*s
= opaque
;
381 len
= read(s
->fd
, buf
, size
);
385 if (errno
== EAGAIN
) {
386 yield_until_fd_readable(s
->fd
);
387 } else if (errno
!= EINTR
) {
398 static int unix_close(void *opaque
)
400 QEMUFileSocket
*s
= opaque
;
406 static const QEMUFileOps unix_read_ops
= {
407 .get_fd
= socket_get_fd
,
408 .get_buffer
= unix_get_buffer
,
412 static const QEMUFileOps unix_write_ops
= {
413 .get_fd
= socket_get_fd
,
414 .writev_buffer
= unix_writev_buffer
,
418 QEMUFile
*qemu_fdopen(int fd
, const char *mode
)
423 (mode
[0] != 'r' && mode
[0] != 'w') ||
424 mode
[1] != 'b' || mode
[2] != 0) {
425 fprintf(stderr
, "qemu_fdopen: Argument validity check failed\n");
429 s
= g_malloc0(sizeof(QEMUFileSocket
));
433 s
->file
= qemu_fopen_ops(s
, &unix_read_ops
);
435 s
->file
= qemu_fopen_ops(s
, &unix_write_ops
);
440 static const QEMUFileOps socket_read_ops
= {
441 .get_fd
= socket_get_fd
,
442 .get_buffer
= socket_get_buffer
,
443 .close
= socket_close
446 static const QEMUFileOps socket_write_ops
= {
447 .get_fd
= socket_get_fd
,
448 .writev_buffer
= socket_writev_buffer
,
449 .close
= socket_close
452 bool qemu_file_mode_is_not_valid(const char *mode
)
455 (mode
[0] != 'r' && mode
[0] != 'w') ||
456 mode
[1] != 'b' || mode
[2] != 0) {
457 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
464 QEMUFile
*qemu_fopen_socket(int fd
, const char *mode
)
468 if (qemu_file_mode_is_not_valid(mode
)) {
472 s
= g_malloc0(sizeof(QEMUFileSocket
));
474 if (mode
[0] == 'w') {
475 qemu_set_block(s
->fd
);
476 s
->file
= qemu_fopen_ops(s
, &socket_write_ops
);
478 s
->file
= qemu_fopen_ops(s
, &socket_read_ops
);
483 QEMUFile
*qemu_fopen(const char *filename
, const char *mode
)
487 if (qemu_file_mode_is_not_valid(mode
)) {
491 s
= g_malloc0(sizeof(QEMUFileStdio
));
493 s
->stdio_file
= fopen(filename
, mode
);
498 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
500 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
508 static ssize_t
block_writev_buffer(void *opaque
, struct iovec
*iov
, int iovcnt
,
514 qemu_iovec_init_external(&qiov
, iov
, iovcnt
);
515 ret
= bdrv_writev_vmstate(opaque
, &qiov
, pos
);
523 static int block_put_buffer(void *opaque
, const uint8_t *buf
,
524 int64_t pos
, int size
)
526 bdrv_save_vmstate(opaque
, buf
, pos
, size
);
530 static int block_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
532 return bdrv_load_vmstate(opaque
, buf
, pos
, size
);
535 static int bdrv_fclose(void *opaque
)
537 return bdrv_flush(opaque
);
540 static const QEMUFileOps bdrv_read_ops
= {
541 .get_buffer
= block_get_buffer
,
545 static const QEMUFileOps bdrv_write_ops
= {
546 .put_buffer
= block_put_buffer
,
547 .writev_buffer
= block_writev_buffer
,
551 static QEMUFile
*qemu_fopen_bdrv(BlockDriverState
*bs
, int is_writable
)
554 return qemu_fopen_ops(bs
, &bdrv_write_ops
);
555 return qemu_fopen_ops(bs
, &bdrv_read_ops
);
558 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
)
562 f
= g_malloc0(sizeof(QEMUFile
));
570 * Get last error for stream f
572 * Return negative error value if there has been an error on previous
573 * operations, return 0 if no error happened.
576 int qemu_file_get_error(QEMUFile
*f
)
578 return f
->last_error
;
581 void qemu_file_set_error(QEMUFile
*f
, int ret
)
583 if (f
->last_error
== 0) {
588 static inline bool qemu_file_is_writable(QEMUFile
*f
)
590 return f
->ops
->writev_buffer
|| f
->ops
->put_buffer
;
594 * Flushes QEMUFile buffer
596 * If there is writev_buffer QEMUFileOps it uses it otherwise uses
599 void qemu_fflush(QEMUFile
*f
)
603 if (!qemu_file_is_writable(f
)) {
607 if (f
->ops
->writev_buffer
) {
609 ret
= f
->ops
->writev_buffer(f
->opaque
, f
->iov
, f
->iovcnt
, f
->pos
);
612 if (f
->buf_index
> 0) {
613 ret
= f
->ops
->put_buffer(f
->opaque
, f
->buf
, f
->pos
, f
->buf_index
);
622 qemu_file_set_error(f
, ret
);
626 void ram_control_before_iterate(QEMUFile
*f
, uint64_t flags
)
630 if (f
->ops
->before_ram_iterate
) {
631 ret
= f
->ops
->before_ram_iterate(f
, f
->opaque
, flags
);
633 qemu_file_set_error(f
, ret
);
638 void ram_control_after_iterate(QEMUFile
*f
, uint64_t flags
)
642 if (f
->ops
->after_ram_iterate
) {
643 ret
= f
->ops
->after_ram_iterate(f
, f
->opaque
, flags
);
645 qemu_file_set_error(f
, ret
);
650 void ram_control_load_hook(QEMUFile
*f
, uint64_t flags
)
654 if (f
->ops
->hook_ram_load
) {
655 ret
= f
->ops
->hook_ram_load(f
, f
->opaque
, flags
);
657 qemu_file_set_error(f
, ret
);
660 qemu_file_set_error(f
, ret
);
664 size_t ram_control_save_page(QEMUFile
*f
, ram_addr_t block_offset
,
665 ram_addr_t offset
, size_t size
, int *bytes_sent
)
667 if (f
->ops
->save_page
) {
668 int ret
= f
->ops
->save_page(f
, f
->opaque
, block_offset
,
669 offset
, size
, bytes_sent
);
671 if (ret
!= RAM_SAVE_CONTROL_DELAYED
) {
672 if (bytes_sent
&& *bytes_sent
> 0) {
673 qemu_update_position(f
, *bytes_sent
);
674 } else if (ret
< 0) {
675 qemu_file_set_error(f
, ret
);
682 return RAM_SAVE_CONTROL_NOT_SUPP
;
685 static void qemu_fill_buffer(QEMUFile
*f
)
690 assert(!qemu_file_is_writable(f
));
692 pending
= f
->buf_size
- f
->buf_index
;
694 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
697 f
->buf_size
= pending
;
699 len
= f
->ops
->get_buffer(f
->opaque
, f
->buf
+ pending
, f
->pos
,
700 IO_BUF_SIZE
- pending
);
704 } else if (len
== 0) {
705 qemu_file_set_error(f
, -EIO
);
706 } else if (len
!= -EAGAIN
)
707 qemu_file_set_error(f
, len
);
710 int qemu_get_fd(QEMUFile
*f
)
712 if (f
->ops
->get_fd
) {
713 return f
->ops
->get_fd(f
->opaque
);
718 void qemu_update_position(QEMUFile
*f
, size_t size
)
725 * Returns negative error value if any error happened on previous operations or
726 * while closing the file. Returns 0 or positive number on success.
728 * The meaning of return value on success depends on the specific backend
731 int qemu_fclose(QEMUFile
*f
)
735 ret
= qemu_file_get_error(f
);
738 int ret2
= f
->ops
->close(f
->opaque
);
743 /* If any error was spotted before closing, we should report it
744 * instead of the close() return value.
753 static void add_to_iovec(QEMUFile
*f
, const uint8_t *buf
, int size
)
755 /* check for adjacent buffer and coalesce them */
756 if (f
->iovcnt
> 0 && buf
== f
->iov
[f
->iovcnt
- 1].iov_base
+
757 f
->iov
[f
->iovcnt
- 1].iov_len
) {
758 f
->iov
[f
->iovcnt
- 1].iov_len
+= size
;
760 f
->iov
[f
->iovcnt
].iov_base
= (uint8_t *)buf
;
761 f
->iov
[f
->iovcnt
++].iov_len
= size
;
764 if (f
->iovcnt
>= MAX_IOV_SIZE
) {
769 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, int size
)
771 if (!f
->ops
->writev_buffer
) {
772 qemu_put_buffer(f
, buf
, size
);
780 f
->bytes_xfer
+= size
;
781 add_to_iovec(f
, buf
, size
);
784 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
793 l
= IO_BUF_SIZE
- f
->buf_index
;
796 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
798 if (f
->ops
->writev_buffer
) {
799 add_to_iovec(f
, f
->buf
+ f
->buf_index
, l
);
802 if (f
->buf_index
== IO_BUF_SIZE
) {
805 if (qemu_file_get_error(f
)) {
813 void qemu_put_byte(QEMUFile
*f
, int v
)
819 f
->buf
[f
->buf_index
] = v
;
821 if (f
->ops
->writev_buffer
) {
822 add_to_iovec(f
, f
->buf
+ f
->buf_index
, 1);
825 if (f
->buf_index
== IO_BUF_SIZE
) {
830 void qemu_file_skip(QEMUFile
*f
, int size
)
832 if (f
->buf_index
+ size
<= f
->buf_size
) {
833 f
->buf_index
+= size
;
837 int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
842 assert(!qemu_file_is_writable(f
));
844 index
= f
->buf_index
+ offset
;
845 pending
= f
->buf_size
- index
;
846 if (pending
< size
) {
848 index
= f
->buf_index
+ offset
;
849 pending
= f
->buf_size
- index
;
855 if (size
> pending
) {
859 memcpy(buf
, f
->buf
+ index
, size
);
863 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
868 while (pending
> 0) {
871 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
875 qemu_file_skip(f
, res
);
883 int qemu_peek_byte(QEMUFile
*f
, int offset
)
885 int index
= f
->buf_index
+ offset
;
887 assert(!qemu_file_is_writable(f
));
889 if (index
>= f
->buf_size
) {
891 index
= f
->buf_index
+ offset
;
892 if (index
>= f
->buf_size
) {
896 return f
->buf
[index
];
899 int qemu_get_byte(QEMUFile
*f
)
903 result
= qemu_peek_byte(f
, 0);
904 qemu_file_skip(f
, 1);
908 int64_t qemu_ftell(QEMUFile
*f
)
914 int qemu_file_rate_limit(QEMUFile
*f
)
916 if (qemu_file_get_error(f
)) {
919 if (f
->xfer_limit
> 0 && f
->bytes_xfer
> f
->xfer_limit
) {
925 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
927 return f
->xfer_limit
;
930 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t limit
)
932 f
->xfer_limit
= limit
;
935 void qemu_file_reset_rate_limit(QEMUFile
*f
)
940 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
942 qemu_put_byte(f
, v
>> 8);
946 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
948 qemu_put_byte(f
, v
>> 24);
949 qemu_put_byte(f
, v
>> 16);
950 qemu_put_byte(f
, v
>> 8);
954 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
956 qemu_put_be32(f
, v
>> 32);
960 unsigned int qemu_get_be16(QEMUFile
*f
)
963 v
= qemu_get_byte(f
) << 8;
964 v
|= qemu_get_byte(f
);
968 unsigned int qemu_get_be32(QEMUFile
*f
)
971 v
= qemu_get_byte(f
) << 24;
972 v
|= qemu_get_byte(f
) << 16;
973 v
|= qemu_get_byte(f
) << 8;
974 v
|= qemu_get_byte(f
);
978 uint64_t qemu_get_be64(QEMUFile
*f
)
981 v
= (uint64_t)qemu_get_be32(f
) << 32;
982 v
|= qemu_get_be32(f
);
989 void timer_put(QEMUFile
*f
, QEMUTimer
*ts
)
991 uint64_t expire_time
;
993 expire_time
= timer_expire_time_ns(ts
);
994 qemu_put_be64(f
, expire_time
);
997 void timer_get(QEMUFile
*f
, QEMUTimer
*ts
)
999 uint64_t expire_time
;
1001 expire_time
= qemu_get_be64(f
);
1002 if (expire_time
!= -1) {
1003 timer_mod_ns(ts
, expire_time
);
1012 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
1015 *v
= qemu_get_byte(f
);
1019 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
1022 qemu_put_byte(f
, *v
);
1025 const VMStateInfo vmstate_info_bool
= {
1033 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
1040 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
1046 const VMStateInfo vmstate_info_int8
= {
1054 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
1057 qemu_get_sbe16s(f
, v
);
1061 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
1064 qemu_put_sbe16s(f
, v
);
1067 const VMStateInfo vmstate_info_int16
= {
1075 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
1078 qemu_get_sbe32s(f
, v
);
1082 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
1085 qemu_put_sbe32s(f
, v
);
1088 const VMStateInfo vmstate_info_int32
= {
1094 /* 32 bit int. See that the received value is the same than the one
1097 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1101 qemu_get_sbe32s(f
, &v2
);
1108 const VMStateInfo vmstate_info_int32_equal
= {
1109 .name
= "int32 equal",
1110 .get
= get_int32_equal
,
1114 /* 32 bit int. See that the received value is the less or the same
1115 than the one in the field */
1117 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
1121 qemu_get_sbe32s(f
, &new);
1128 const VMStateInfo vmstate_info_int32_le
= {
1129 .name
= "int32 equal",
1130 .get
= get_int32_le
,
1136 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
1139 qemu_get_sbe64s(f
, v
);
1143 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
1146 qemu_put_sbe64s(f
, v
);
1149 const VMStateInfo vmstate_info_int64
= {
1155 /* 8 bit unsigned int */
1157 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1164 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1170 const VMStateInfo vmstate_info_uint8
= {
1176 /* 16 bit unsigned int */
1178 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1181 qemu_get_be16s(f
, v
);
1185 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1188 qemu_put_be16s(f
, v
);
1191 const VMStateInfo vmstate_info_uint16
= {
1197 /* 32 bit unsigned int */
1199 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1202 qemu_get_be32s(f
, v
);
1206 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1209 qemu_put_be32s(f
, v
);
1212 const VMStateInfo vmstate_info_uint32
= {
1218 /* 32 bit uint. See that the received value is the same than the one
1221 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1225 qemu_get_be32s(f
, &v2
);
1233 const VMStateInfo vmstate_info_uint32_equal
= {
1234 .name
= "uint32 equal",
1235 .get
= get_uint32_equal
,
1239 /* 64 bit unsigned int */
1241 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1244 qemu_get_be64s(f
, v
);
1248 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1251 qemu_put_be64s(f
, v
);
1254 const VMStateInfo vmstate_info_uint64
= {
1260 /* 64 bit unsigned int. See that the received value is the same than the one
1263 static int get_uint64_equal(QEMUFile
*f
, void *pv
, size_t size
)
1267 qemu_get_be64s(f
, &v2
);
1275 const VMStateInfo vmstate_info_uint64_equal
= {
1276 .name
= "int64 equal",
1277 .get
= get_uint64_equal
,
1281 /* 8 bit int. See that the received value is the same than the one
1284 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1288 qemu_get_8s(f
, &v2
);
1295 const VMStateInfo vmstate_info_uint8_equal
= {
1296 .name
= "uint8 equal",
1297 .get
= get_uint8_equal
,
1301 /* 16 bit unsigned int int. See that the received value is the same than the one
1304 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1308 qemu_get_be16s(f
, &v2
);
1315 const VMStateInfo vmstate_info_uint16_equal
= {
1316 .name
= "uint16 equal",
1317 .get
= get_uint16_equal
,
1321 /* floating point */
1323 static int get_float64(QEMUFile
*f
, void *pv
, size_t size
)
1327 *v
= make_float64(qemu_get_be64(f
));
1331 static void put_float64(QEMUFile
*f
, void *pv
, size_t size
)
1335 qemu_put_be64(f
, float64_val(*v
));
1338 const VMStateInfo vmstate_info_float64
= {
1346 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1353 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1359 const VMStateInfo vmstate_info_timer
= {
1365 /* uint8_t buffers */
1367 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1370 qemu_get_buffer(f
, v
, size
);
1374 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1377 qemu_put_buffer(f
, v
, size
);
1380 const VMStateInfo vmstate_info_buffer
= {
1386 /* unused buffers: space that was used for some fields that are
1387 not useful anymore */
1389 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1395 block_len
= MIN(sizeof(buf
), size
);
1397 qemu_get_buffer(f
, buf
, block_len
);
1402 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1404 static const uint8_t buf
[1024];
1408 block_len
= MIN(sizeof(buf
), size
);
1410 qemu_put_buffer(f
, buf
, block_len
);
1414 const VMStateInfo vmstate_info_unused_buffer
= {
1415 .name
= "unused_buffer",
1416 .get
= get_unused_buffer
,
1417 .put
= put_unused_buffer
,
1420 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1421 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1422 * bit words with the bits in big endian order. The in-memory format
1423 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1425 /* This is the number of 64 bit words sent over the wire */
1426 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1427 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1429 unsigned long *bmp
= pv
;
1431 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1432 uint64_t w
= qemu_get_be64(f
);
1434 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1435 bmp
[idx
++] = w
>> 32;
1441 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1443 unsigned long *bmp
= pv
;
1445 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1446 uint64_t w
= bmp
[idx
++];
1447 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1448 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1450 qemu_put_be64(f
, w
);
1454 const VMStateInfo vmstate_info_bitmap
= {
1460 typedef struct CompatEntry
{
1465 typedef struct SaveStateEntry
{
1466 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1472 SaveVMHandlers
*ops
;
1473 const VMStateDescription
*vmsd
;
1475 CompatEntry
*compat
;
1481 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1482 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1483 static int global_section_id
;
1485 static int calculate_new_instance_id(const char *idstr
)
1488 int instance_id
= 0;
1490 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1491 if (strcmp(idstr
, se
->idstr
) == 0
1492 && instance_id
<= se
->instance_id
) {
1493 instance_id
= se
->instance_id
+ 1;
1499 static int calculate_compat_instance_id(const char *idstr
)
1502 int instance_id
= 0;
1504 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1508 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1509 && instance_id
<= se
->compat
->instance_id
) {
1510 instance_id
= se
->compat
->instance_id
+ 1;
1516 /* TODO: Individual devices generally have very little idea about the rest
1517 of the system, so instance_id should be removed/replaced.
1518 Meanwhile pass -1 as instance_id if you do not already have a clearly
1519 distinguishing id for all instances of your device class. */
1520 int register_savevm_live(DeviceState
*dev
,
1524 SaveVMHandlers
*ops
,
1529 se
= g_malloc0(sizeof(SaveStateEntry
));
1530 se
->version_id
= version_id
;
1531 se
->section_id
= global_section_id
++;
1533 se
->opaque
= opaque
;
1536 /* if this is a live_savem then set is_ram */
1537 if (ops
->save_live_setup
!= NULL
) {
1542 char *id
= qdev_get_dev_path(dev
);
1544 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1545 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1548 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1549 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1550 se
->compat
->instance_id
= instance_id
== -1 ?
1551 calculate_compat_instance_id(idstr
) : instance_id
;
1555 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1557 if (instance_id
== -1) {
1558 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1560 se
->instance_id
= instance_id
;
1562 assert(!se
->compat
|| se
->instance_id
== 0);
1563 /* add at the end of list */
1564 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1568 int register_savevm(DeviceState
*dev
,
1572 SaveStateHandler
*save_state
,
1573 LoadStateHandler
*load_state
,
1576 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1577 ops
->save_state
= save_state
;
1578 ops
->load_state
= load_state
;
1579 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1583 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1585 SaveStateEntry
*se
, *new_se
;
1589 char *path
= qdev_get_dev_path(dev
);
1591 pstrcpy(id
, sizeof(id
), path
);
1592 pstrcat(id
, sizeof(id
), "/");
1596 pstrcat(id
, sizeof(id
), idstr
);
1598 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1599 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1600 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1610 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1611 const VMStateDescription
*vmsd
,
1612 void *opaque
, int alias_id
,
1613 int required_for_version
)
1617 /* If this triggers, alias support can be dropped for the vmsd. */
1618 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1620 se
= g_malloc0(sizeof(SaveStateEntry
));
1621 se
->version_id
= vmsd
->version_id
;
1622 se
->section_id
= global_section_id
++;
1623 se
->opaque
= opaque
;
1625 se
->alias_id
= alias_id
;
1626 se
->no_migrate
= vmsd
->unmigratable
;
1629 char *id
= qdev_get_dev_path(dev
);
1631 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1632 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1635 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1636 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1637 se
->compat
->instance_id
= instance_id
== -1 ?
1638 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1642 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1644 if (instance_id
== -1) {
1645 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1647 se
->instance_id
= instance_id
;
1649 assert(!se
->compat
|| se
->instance_id
== 0);
1650 /* add at the end of list */
1651 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1655 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1658 SaveStateEntry
*se
, *new_se
;
1660 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1661 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1662 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1671 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1673 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1676 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1677 void *opaque
, int version_id
)
1679 VMStateField
*field
= vmsd
->fields
;
1682 if (version_id
> vmsd
->version_id
) {
1685 if (version_id
< vmsd
->minimum_version_id_old
) {
1688 if (version_id
< vmsd
->minimum_version_id
) {
1689 return vmsd
->load_state_old(f
, opaque
, version_id
);
1691 if (vmsd
->pre_load
) {
1692 int ret
= vmsd
->pre_load(opaque
);
1696 while(field
->name
) {
1697 if ((field
->field_exists
&&
1698 field
->field_exists(opaque
, version_id
)) ||
1699 (!field
->field_exists
&&
1700 field
->version_id
<= version_id
)) {
1701 void *base_addr
= opaque
+ field
->offset
;
1703 int size
= field
->size
;
1705 if (field
->flags
& VMS_VBUFFER
) {
1706 size
= *(int32_t *)(opaque
+field
->size_offset
);
1707 if (field
->flags
& VMS_MULTIPLY
) {
1708 size
*= field
->size
;
1711 if (field
->flags
& VMS_ARRAY
) {
1712 n_elems
= field
->num
;
1713 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1714 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1715 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1716 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1717 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1718 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1719 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1720 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1722 if (field
->flags
& VMS_POINTER
) {
1723 base_addr
= *(void **)base_addr
+ field
->start
;
1725 for (i
= 0; i
< n_elems
; i
++) {
1726 void *addr
= base_addr
+ size
* i
;
1728 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1729 addr
= *(void **)addr
;
1731 if (field
->flags
& VMS_STRUCT
) {
1732 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1734 ret
= field
->info
->get(f
, addr
, size
);
1744 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1748 if (vmsd
->post_load
) {
1749 return vmsd
->post_load(opaque
, version_id
);
1754 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1757 VMStateField
*field
= vmsd
->fields
;
1759 if (vmsd
->pre_save
) {
1760 vmsd
->pre_save(opaque
);
1762 while(field
->name
) {
1763 if (!field
->field_exists
||
1764 field
->field_exists(opaque
, vmsd
->version_id
)) {
1765 void *base_addr
= opaque
+ field
->offset
;
1767 int size
= field
->size
;
1769 if (field
->flags
& VMS_VBUFFER
) {
1770 size
= *(int32_t *)(opaque
+field
->size_offset
);
1771 if (field
->flags
& VMS_MULTIPLY
) {
1772 size
*= field
->size
;
1775 if (field
->flags
& VMS_ARRAY
) {
1776 n_elems
= field
->num
;
1777 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1778 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1779 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1780 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1781 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1782 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1783 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1784 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1786 if (field
->flags
& VMS_POINTER
) {
1787 base_addr
= *(void **)base_addr
+ field
->start
;
1789 for (i
= 0; i
< n_elems
; i
++) {
1790 void *addr
= base_addr
+ size
* i
;
1792 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1793 addr
= *(void **)addr
;
1795 if (field
->flags
& VMS_STRUCT
) {
1796 vmstate_save_state(f
, field
->vmsd
, addr
);
1798 field
->info
->put(f
, addr
, size
);
1804 vmstate_subsection_save(f
, vmsd
, opaque
);
1807 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1809 if (!se
->vmsd
) { /* Old style */
1810 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1812 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1815 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1817 if (!se
->vmsd
) { /* Old style */
1818 se
->ops
->save_state(f
, se
->opaque
);
1821 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1824 #define QEMU_VM_FILE_MAGIC 0x5145564d
1825 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1826 #define QEMU_VM_FILE_VERSION 0x00000003
1828 #define QEMU_VM_EOF 0x00
1829 #define QEMU_VM_SECTION_START 0x01
1830 #define QEMU_VM_SECTION_PART 0x02
1831 #define QEMU_VM_SECTION_END 0x03
1832 #define QEMU_VM_SECTION_FULL 0x04
1833 #define QEMU_VM_SUBSECTION 0x05
1835 bool qemu_savevm_state_blocked(Error
**errp
)
1839 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1840 if (se
->no_migrate
) {
1841 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1848 void qemu_savevm_state_begin(QEMUFile
*f
,
1849 const MigrationParams
*params
)
1854 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1855 if (!se
->ops
|| !se
->ops
->set_params
) {
1858 se
->ops
->set_params(params
, se
->opaque
);
1861 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1862 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1864 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1867 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1870 if (se
->ops
&& se
->ops
->is_active
) {
1871 if (!se
->ops
->is_active(se
->opaque
)) {
1876 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1877 qemu_put_be32(f
, se
->section_id
);
1880 len
= strlen(se
->idstr
);
1881 qemu_put_byte(f
, len
);
1882 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1884 qemu_put_be32(f
, se
->instance_id
);
1885 qemu_put_be32(f
, se
->version_id
);
1887 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1889 qemu_file_set_error(f
, ret
);
1896 * this function has three return values:
1897 * negative: there was one error, and we have -errno.
1898 * 0 : We haven't finished, caller have to go again
1899 * 1 : We have finished, we can go to complete phase
1901 int qemu_savevm_state_iterate(QEMUFile
*f
)
1906 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1907 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1910 if (se
->ops
&& se
->ops
->is_active
) {
1911 if (!se
->ops
->is_active(se
->opaque
)) {
1915 if (qemu_file_rate_limit(f
)) {
1918 trace_savevm_section_start();
1920 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1921 qemu_put_be32(f
, se
->section_id
);
1923 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1924 trace_savevm_section_end(se
->section_id
);
1927 qemu_file_set_error(f
, ret
);
1930 /* Do not proceed to the next vmstate before this one reported
1931 completion of the current stage. This serializes the migration
1932 and reduces the probability that a faster changing state is
1933 synchronized over and over again. */
1940 void qemu_savevm_state_complete(QEMUFile
*f
)
1945 cpu_synchronize_all_states();
1947 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1948 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1951 if (se
->ops
&& se
->ops
->is_active
) {
1952 if (!se
->ops
->is_active(se
->opaque
)) {
1956 trace_savevm_section_start();
1958 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1959 qemu_put_be32(f
, se
->section_id
);
1961 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1962 trace_savevm_section_end(se
->section_id
);
1964 qemu_file_set_error(f
, ret
);
1969 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1972 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1975 trace_savevm_section_start();
1977 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1978 qemu_put_be32(f
, se
->section_id
);
1981 len
= strlen(se
->idstr
);
1982 qemu_put_byte(f
, len
);
1983 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1985 qemu_put_be32(f
, se
->instance_id
);
1986 qemu_put_be32(f
, se
->version_id
);
1988 vmstate_save(f
, se
);
1989 trace_savevm_section_end(se
->section_id
);
1992 qemu_put_byte(f
, QEMU_VM_EOF
);
1996 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
2001 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
2002 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
2005 if (se
->ops
&& se
->ops
->is_active
) {
2006 if (!se
->ops
->is_active(se
->opaque
)) {
2010 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
2015 void qemu_savevm_state_cancel(void)
2019 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
2020 if (se
->ops
&& se
->ops
->cancel
) {
2021 se
->ops
->cancel(se
->opaque
);
2026 static int qemu_savevm_state(QEMUFile
*f
)
2029 MigrationParams params
= {
2034 if (qemu_savevm_state_blocked(NULL
)) {
2038 qemu_mutex_unlock_iothread();
2039 qemu_savevm_state_begin(f
, ¶ms
);
2040 qemu_mutex_lock_iothread();
2042 while (qemu_file_get_error(f
) == 0) {
2043 if (qemu_savevm_state_iterate(f
) > 0) {
2048 ret
= qemu_file_get_error(f
);
2050 qemu_savevm_state_complete(f
);
2051 ret
= qemu_file_get_error(f
);
2054 qemu_savevm_state_cancel();
2059 static int qemu_save_device_state(QEMUFile
*f
)
2063 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
2064 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
2066 cpu_synchronize_all_states();
2068 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
2074 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
2079 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
2080 qemu_put_be32(f
, se
->section_id
);
2083 len
= strlen(se
->idstr
);
2084 qemu_put_byte(f
, len
);
2085 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
2087 qemu_put_be32(f
, se
->instance_id
);
2088 qemu_put_be32(f
, se
->version_id
);
2090 vmstate_save(f
, se
);
2093 qemu_put_byte(f
, QEMU_VM_EOF
);
2095 return qemu_file_get_error(f
);
2098 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
2102 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
2103 if (!strcmp(se
->idstr
, idstr
) &&
2104 (instance_id
== se
->instance_id
||
2105 instance_id
== se
->alias_id
))
2107 /* Migrating from an older version? */
2108 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
2109 if (!strcmp(se
->compat
->idstr
, idstr
) &&
2110 (instance_id
== se
->compat
->instance_id
||
2111 instance_id
== se
->alias_id
))
2118 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
2120 while(sub
&& sub
->needed
) {
2121 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
2129 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2132 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
2135 uint8_t version_id
, len
, size
;
2136 const VMStateDescription
*sub_vmsd
;
2138 len
= qemu_peek_byte(f
, 1);
2139 if (len
< strlen(vmsd
->name
) + 1) {
2140 /* subsection name has be be "section_name/a" */
2143 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
2149 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
2150 /* it don't have a valid subsection name */
2153 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
2154 if (sub_vmsd
== NULL
) {
2157 qemu_file_skip(f
, 1); /* subsection */
2158 qemu_file_skip(f
, 1); /* len */
2159 qemu_file_skip(f
, len
); /* idstr */
2160 version_id
= qemu_get_be32(f
);
2162 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
2170 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2173 const VMStateSubsection
*sub
= vmsd
->subsections
;
2175 while (sub
&& sub
->needed
) {
2176 if (sub
->needed(opaque
)) {
2177 const VMStateDescription
*vmsd
= sub
->vmsd
;
2180 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
2181 len
= strlen(vmsd
->name
);
2182 qemu_put_byte(f
, len
);
2183 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
2184 qemu_put_be32(f
, vmsd
->version_id
);
2185 vmstate_save_state(f
, vmsd
, opaque
);
2191 typedef struct LoadStateEntry
{
2192 QLIST_ENTRY(LoadStateEntry
) entry
;
2198 int qemu_loadvm_state(QEMUFile
*f
)
2200 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
2201 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
2202 LoadStateEntry
*le
, *new_le
;
2203 uint8_t section_type
;
2207 if (qemu_savevm_state_blocked(NULL
)) {
2211 v
= qemu_get_be32(f
);
2212 if (v
!= QEMU_VM_FILE_MAGIC
)
2215 v
= qemu_get_be32(f
);
2216 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
2217 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
2220 if (v
!= QEMU_VM_FILE_VERSION
)
2223 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
2224 uint32_t instance_id
, version_id
, section_id
;
2229 switch (section_type
) {
2230 case QEMU_VM_SECTION_START
:
2231 case QEMU_VM_SECTION_FULL
:
2232 /* Read section start */
2233 section_id
= qemu_get_be32(f
);
2234 len
= qemu_get_byte(f
);
2235 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
2237 instance_id
= qemu_get_be32(f
);
2238 version_id
= qemu_get_be32(f
);
2240 /* Find savevm section */
2241 se
= find_se(idstr
, instance_id
);
2243 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
2248 /* Validate version */
2249 if (version_id
> se
->version_id
) {
2250 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2251 version_id
, idstr
, se
->version_id
);
2257 le
= g_malloc0(sizeof(*le
));
2260 le
->section_id
= section_id
;
2261 le
->version_id
= version_id
;
2262 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2264 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2266 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2267 instance_id
, idstr
);
2271 case QEMU_VM_SECTION_PART
:
2272 case QEMU_VM_SECTION_END
:
2273 section_id
= qemu_get_be32(f
);
2275 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2276 if (le
->section_id
== section_id
) {
2281 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2286 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2288 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2294 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2300 cpu_synchronize_all_post_init();
2305 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2306 QLIST_REMOVE(le
, entry
);
2311 ret
= qemu_file_get_error(f
);
2317 static BlockDriverState
*find_vmstate_bs(void)
2319 BlockDriverState
*bs
= NULL
;
2320 while ((bs
= bdrv_next(bs
))) {
2321 if (bdrv_can_snapshot(bs
)) {
2329 * Deletes snapshots of a given name in all opened images.
2331 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2333 BlockDriverState
*bs
;
2334 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2338 while ((bs
= bdrv_next(bs
))) {
2339 if (bdrv_can_snapshot(bs
) &&
2340 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2342 bdrv_snapshot_delete_by_id_or_name(bs
, name
, &err
);
2343 if (error_is_set(&err
)) {
2345 "Error while deleting snapshot on device '%s':"
2347 bdrv_get_device_name(bs
),
2348 error_get_pretty(err
));
2358 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2360 BlockDriverState
*bs
, *bs1
;
2361 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2364 int saved_vm_running
;
2365 uint64_t vm_state_size
;
2368 const char *name
= qdict_get_try_str(qdict
, "name");
2370 /* Verify if there is a device that doesn't support snapshots and is writable */
2372 while ((bs
= bdrv_next(bs
))) {
2374 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2378 if (!bdrv_can_snapshot(bs
)) {
2379 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2380 bdrv_get_device_name(bs
));
2385 bs
= find_vmstate_bs();
2387 monitor_printf(mon
, "No block device can accept snapshots\n");
2391 saved_vm_running
= runstate_is_running();
2392 vm_stop(RUN_STATE_SAVE_VM
);
2394 memset(sn
, 0, sizeof(*sn
));
2396 /* fill auxiliary fields */
2397 qemu_gettimeofday(&tv
);
2398 sn
->date_sec
= tv
.tv_sec
;
2399 sn
->date_nsec
= tv
.tv_usec
* 1000;
2400 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
2403 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2405 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2406 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2408 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2411 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2412 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2413 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2416 /* Delete old snapshots of the same name */
2417 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2421 /* save the VM state */
2422 f
= qemu_fopen_bdrv(bs
, 1);
2424 monitor_printf(mon
, "Could not open VM state file\n");
2427 ret
= qemu_savevm_state(f
);
2428 vm_state_size
= qemu_ftell(f
);
2431 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2435 /* create the snapshots */
2438 while ((bs1
= bdrv_next(bs1
))) {
2439 if (bdrv_can_snapshot(bs1
)) {
2440 /* Write VM state size only to the image that contains the state */
2441 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2442 ret
= bdrv_snapshot_create(bs1
, sn
);
2444 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2445 bdrv_get_device_name(bs1
));
2451 if (saved_vm_running
)
2455 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2458 int saved_vm_running
;
2461 saved_vm_running
= runstate_is_running();
2462 vm_stop(RUN_STATE_SAVE_VM
);
2464 f
= qemu_fopen(filename
, "wb");
2466 error_setg_file_open(errp
, errno
, filename
);
2469 ret
= qemu_save_device_state(f
);
2472 error_set(errp
, QERR_IO_ERROR
);
2476 if (saved_vm_running
)
2480 int load_vmstate(const char *name
)
2482 BlockDriverState
*bs
, *bs_vm_state
;
2483 QEMUSnapshotInfo sn
;
2487 bs_vm_state
= find_vmstate_bs();
2489 error_report("No block device supports snapshots");
2493 /* Don't even try to load empty VM states */
2494 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2497 } else if (sn
.vm_state_size
== 0) {
2498 error_report("This is a disk-only snapshot. Revert to it offline "
2503 /* Verify if there is any device that doesn't support snapshots and is
2504 writable and check if the requested snapshot is available too. */
2506 while ((bs
= bdrv_next(bs
))) {
2508 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2512 if (!bdrv_can_snapshot(bs
)) {
2513 error_report("Device '%s' is writable but does not support snapshots.",
2514 bdrv_get_device_name(bs
));
2518 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2520 error_report("Device '%s' does not have the requested snapshot '%s'",
2521 bdrv_get_device_name(bs
), name
);
2526 /* Flush all IO requests so they don't interfere with the new state. */
2530 while ((bs
= bdrv_next(bs
))) {
2531 if (bdrv_can_snapshot(bs
)) {
2532 ret
= bdrv_snapshot_goto(bs
, name
);
2534 error_report("Error %d while activating snapshot '%s' on '%s'",
2535 ret
, name
, bdrv_get_device_name(bs
));
2541 /* restore the VM state */
2542 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2544 error_report("Could not open VM state file");
2548 qemu_system_reset(VMRESET_SILENT
);
2549 ret
= qemu_loadvm_state(f
);
2553 error_report("Error %d while loading VM state", ret
);
2560 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2562 BlockDriverState
*bs
, *bs1
;
2564 const char *name
= qdict_get_str(qdict
, "name");
2566 bs
= find_vmstate_bs();
2568 monitor_printf(mon
, "No block device supports snapshots\n");
2573 while ((bs1
= bdrv_next(bs1
))) {
2574 if (bdrv_can_snapshot(bs1
)) {
2575 bdrv_snapshot_delete_by_id_or_name(bs
, name
, &err
);
2576 if (error_is_set(&err
)) {
2578 "Error while deleting snapshot on device '%s':"
2580 bdrv_get_device_name(bs
),
2581 error_get_pretty(err
));
2588 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2590 BlockDriverState
*bs
, *bs1
;
2591 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2592 int nb_sns
, i
, ret
, available
;
2594 int *available_snapshots
;
2596 bs
= find_vmstate_bs();
2598 monitor_printf(mon
, "No available block device supports snapshots\n");
2602 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2604 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2609 monitor_printf(mon
, "There is no snapshot available.\n");
2613 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2615 for (i
= 0; i
< nb_sns
; i
++) {
2620 while ((bs1
= bdrv_next(bs1
))) {
2621 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2622 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2631 available_snapshots
[total
] = i
;
2637 bdrv_snapshot_dump((fprintf_function
)monitor_printf
, mon
, NULL
);
2638 monitor_printf(mon
, "\n");
2639 for (i
= 0; i
< total
; i
++) {
2640 sn
= &sn_tab
[available_snapshots
[i
]];
2641 bdrv_snapshot_dump((fprintf_function
)monitor_printf
, mon
, sn
);
2642 monitor_printf(mon
, "\n");
2645 monitor_printf(mon
, "There is no suitable snapshot available\n");
2649 g_free(available_snapshots
);
2653 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2655 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2656 memory_region_name(mr
), dev
);
2659 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2661 /* Nothing do to while the implementation is in RAMBlock */
2664 void vmstate_register_ram_global(MemoryRegion
*mr
)
2666 vmstate_register_ram(mr
, NULL
);