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 #define SELF_ANNOUNCE_ROUNDS 5
46 #define ETH_P_RARP 0x8035
48 #define ARP_HTYPE_ETH 0x0001
49 #define ARP_PTYPE_IP 0x0800
50 #define ARP_OP_REQUEST_REV 0x3
52 static int announce_self_create(uint8_t *buf
,
55 /* Ethernet header. */
56 memset(buf
, 0xff, 6); /* destination MAC addr */
57 memcpy(buf
+ 6, mac_addr
, 6); /* source MAC addr */
58 *(uint16_t *)(buf
+ 12) = htons(ETH_P_RARP
); /* ethertype */
61 *(uint16_t *)(buf
+ 14) = htons(ARP_HTYPE_ETH
); /* hardware addr space */
62 *(uint16_t *)(buf
+ 16) = htons(ARP_PTYPE_IP
); /* protocol addr space */
63 *(buf
+ 18) = 6; /* hardware addr length (ethernet) */
64 *(buf
+ 19) = 4; /* protocol addr length (IPv4) */
65 *(uint16_t *)(buf
+ 20) = htons(ARP_OP_REQUEST_REV
); /* opcode */
66 memcpy(buf
+ 22, mac_addr
, 6); /* source hw addr */
67 memset(buf
+ 28, 0x00, 4); /* source protocol addr */
68 memcpy(buf
+ 32, mac_addr
, 6); /* target hw addr */
69 memset(buf
+ 38, 0x00, 4); /* target protocol addr */
71 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
72 memset(buf
+ 42, 0x00, 18);
74 return 60; /* len (FCS will be added by hardware) */
77 static void qemu_announce_self_iter(NICState
*nic
, void *opaque
)
82 len
= announce_self_create(buf
, nic
->conf
->macaddr
.a
);
84 qemu_send_packet_raw(qemu_get_queue(nic
), buf
, len
);
88 static void qemu_announce_self_once(void *opaque
)
90 static int count
= SELF_ANNOUNCE_ROUNDS
;
91 QEMUTimer
*timer
= *(QEMUTimer
**)opaque
;
93 qemu_foreach_nic(qemu_announce_self_iter
, NULL
);
96 /* delay 50ms, 150ms, 250ms, ... */
97 qemu_mod_timer(timer
, qemu_get_clock_ms(rt_clock
) +
98 50 + (SELF_ANNOUNCE_ROUNDS
- count
- 1) * 100);
100 qemu_del_timer(timer
);
101 qemu_free_timer(timer
);
105 void qemu_announce_self(void)
107 static QEMUTimer
*timer
;
108 timer
= qemu_new_timer_ms(rt_clock
, qemu_announce_self_once
, &timer
);
109 qemu_announce_self_once(&timer
);
112 /***********************************************************/
113 /* savevm/loadvm support */
115 #define IO_BUF_SIZE 32768
118 const QEMUFileOps
*ops
;
122 int64_t buf_offset
; /* start of buffer when writing, end of buffer
125 int buf_size
; /* 0 when writing */
126 uint8_t buf
[IO_BUF_SIZE
];
131 typedef struct QEMUFileStdio
137 typedef struct QEMUFileSocket
148 static void fd_coroutine_enter(void *opaque
)
150 FDYieldUntilData
*data
= opaque
;
151 qemu_set_fd_handler(data
->fd
, NULL
, NULL
, NULL
);
152 qemu_coroutine_enter(data
->co
, NULL
);
156 * Yield until a file descriptor becomes readable
158 * Note that this function clobbers the handlers for the file descriptor.
160 static void coroutine_fn
yield_until_fd_readable(int fd
)
162 FDYieldUntilData data
;
164 assert(qemu_in_coroutine());
165 data
.co
= qemu_coroutine_self();
167 qemu_set_fd_handler(fd
, fd_coroutine_enter
, NULL
, &data
);
168 qemu_coroutine_yield();
171 static int socket_get_fd(void *opaque
)
173 QEMUFileSocket
*s
= opaque
;
178 static int socket_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
180 QEMUFileSocket
*s
= opaque
;
184 len
= qemu_recv(s
->fd
, buf
, size
, 0);
188 if (socket_error() == EAGAIN
) {
189 yield_until_fd_readable(s
->fd
);
190 } else if (socket_error() != EINTR
) {
196 len
= -socket_error();
201 static int socket_close(void *opaque
)
203 QEMUFileSocket
*s
= opaque
;
209 static int stdio_get_fd(void *opaque
)
211 QEMUFileStdio
*s
= opaque
;
213 return fileno(s
->stdio_file
);
216 static int stdio_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
218 QEMUFileStdio
*s
= opaque
;
219 return fwrite(buf
, 1, size
, s
->stdio_file
);
222 static int stdio_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
224 QEMUFileStdio
*s
= opaque
;
225 FILE *fp
= s
->stdio_file
;
230 bytes
= fread(buf
, 1, size
, fp
);
231 if (bytes
!= 0 || !ferror(fp
)) {
234 if (errno
== EAGAIN
) {
235 yield_until_fd_readable(fileno(fp
));
236 } else if (errno
!= EINTR
) {
243 static int stdio_pclose(void *opaque
)
245 QEMUFileStdio
*s
= opaque
;
247 ret
= pclose(s
->stdio_file
);
250 } else if (!WIFEXITED(ret
) || WEXITSTATUS(ret
) != 0) {
251 /* close succeeded, but non-zero exit code: */
252 ret
= -EIO
; /* fake errno value */
258 static int stdio_fclose(void *opaque
)
260 QEMUFileStdio
*s
= opaque
;
263 if (s
->file
->ops
->put_buffer
) {
264 int fd
= fileno(s
->stdio_file
);
267 ret
= fstat(fd
, &st
);
268 if (ret
== 0 && S_ISREG(st
.st_mode
)) {
270 * If the file handle is a regular file make sure the
271 * data is flushed to disk before signaling success.
280 if (fclose(s
->stdio_file
) == EOF
) {
287 static const QEMUFileOps stdio_pipe_read_ops
= {
288 .get_fd
= stdio_get_fd
,
289 .get_buffer
= stdio_get_buffer
,
290 .close
= stdio_pclose
293 static const QEMUFileOps stdio_pipe_write_ops
= {
294 .get_fd
= stdio_get_fd
,
295 .put_buffer
= stdio_put_buffer
,
296 .close
= stdio_pclose
299 QEMUFile
*qemu_popen_cmd(const char *command
, const char *mode
)
304 stdio_file
= popen(command
, mode
);
305 if (stdio_file
== NULL
) {
309 if (mode
== NULL
|| (mode
[0] != 'r' && mode
[0] != 'w') || mode
[1] != 0) {
310 fprintf(stderr
, "qemu_popen: Argument validity check failed\n");
314 s
= g_malloc0(sizeof(QEMUFileStdio
));
316 s
->stdio_file
= stdio_file
;
319 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_read_ops
);
321 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_write_ops
);
326 static const QEMUFileOps stdio_file_read_ops
= {
327 .get_fd
= stdio_get_fd
,
328 .get_buffer
= stdio_get_buffer
,
329 .close
= stdio_fclose
332 static const QEMUFileOps stdio_file_write_ops
= {
333 .get_fd
= stdio_get_fd
,
334 .put_buffer
= stdio_put_buffer
,
335 .close
= stdio_fclose
338 QEMUFile
*qemu_fdopen(int fd
, const char *mode
)
343 (mode
[0] != 'r' && mode
[0] != 'w') ||
344 mode
[1] != 'b' || mode
[2] != 0) {
345 fprintf(stderr
, "qemu_fdopen: Argument validity check failed\n");
349 s
= g_malloc0(sizeof(QEMUFileStdio
));
350 s
->stdio_file
= fdopen(fd
, mode
);
355 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
357 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
366 static const QEMUFileOps socket_read_ops
= {
367 .get_fd
= socket_get_fd
,
368 .get_buffer
= socket_get_buffer
,
369 .close
= socket_close
372 QEMUFile
*qemu_fopen_socket(int fd
)
374 QEMUFileSocket
*s
= g_malloc0(sizeof(QEMUFileSocket
));
377 s
->file
= qemu_fopen_ops(s
, &socket_read_ops
);
381 QEMUFile
*qemu_fopen(const char *filename
, const char *mode
)
386 (mode
[0] != 'r' && mode
[0] != 'w') ||
387 mode
[1] != 'b' || mode
[2] != 0) {
388 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
392 s
= g_malloc0(sizeof(QEMUFileStdio
));
394 s
->stdio_file
= fopen(filename
, mode
);
399 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
401 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
409 static int block_put_buffer(void *opaque
, const uint8_t *buf
,
410 int64_t pos
, int size
)
412 bdrv_save_vmstate(opaque
, buf
, pos
, size
);
416 static int block_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
418 return bdrv_load_vmstate(opaque
, buf
, pos
, size
);
421 static int bdrv_fclose(void *opaque
)
423 return bdrv_flush(opaque
);
426 static const QEMUFileOps bdrv_read_ops
= {
427 .get_buffer
= block_get_buffer
,
431 static const QEMUFileOps bdrv_write_ops
= {
432 .put_buffer
= block_put_buffer
,
436 static QEMUFile
*qemu_fopen_bdrv(BlockDriverState
*bs
, int is_writable
)
439 return qemu_fopen_ops(bs
, &bdrv_write_ops
);
440 return qemu_fopen_ops(bs
, &bdrv_read_ops
);
443 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
)
447 f
= g_malloc0(sizeof(QEMUFile
));
456 int qemu_file_get_error(QEMUFile
*f
)
458 return f
->last_error
;
461 static void qemu_file_set_error(QEMUFile
*f
, int ret
)
463 if (f
->last_error
== 0) {
468 /** Flushes QEMUFile buffer
471 static void qemu_fflush(QEMUFile
*f
)
475 if (!f
->ops
->put_buffer
) {
478 if (f
->is_write
&& f
->buf_index
> 0) {
479 ret
= f
->ops
->put_buffer(f
->opaque
, f
->buf
, f
->buf_offset
, f
->buf_index
);
481 f
->buf_offset
+= f
->buf_index
;
486 qemu_file_set_error(f
, ret
);
490 static void qemu_fill_buffer(QEMUFile
*f
)
495 if (!f
->ops
->get_buffer
)
501 pending
= f
->buf_size
- f
->buf_index
;
503 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
506 f
->buf_size
= pending
;
508 len
= f
->ops
->get_buffer(f
->opaque
, f
->buf
+ pending
, f
->buf_offset
,
509 IO_BUF_SIZE
- pending
);
512 f
->buf_offset
+= len
;
513 } else if (len
== 0) {
514 qemu_file_set_error(f
, -EIO
);
515 } else if (len
!= -EAGAIN
)
516 qemu_file_set_error(f
, len
);
519 int qemu_get_fd(QEMUFile
*f
)
521 if (f
->ops
->get_fd
) {
522 return f
->ops
->get_fd(f
->opaque
);
529 * Returns negative error value if any error happened on previous operations or
530 * while closing the file. Returns 0 or positive number on success.
532 * The meaning of return value on success depends on the specific backend
535 int qemu_fclose(QEMUFile
*f
)
539 ret
= qemu_file_get_error(f
);
542 int ret2
= f
->ops
->close(f
->opaque
);
547 /* If any error was spotted before closing, we should report it
548 * instead of the close() return value.
557 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
565 if (f
->is_write
== 0 && f
->buf_index
> 0) {
567 "Attempted to write to buffer while read buffer is not empty\n");
572 l
= IO_BUF_SIZE
- f
->buf_index
;
575 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
580 if (f
->buf_index
>= IO_BUF_SIZE
) {
582 if (qemu_file_get_error(f
)) {
589 void qemu_put_byte(QEMUFile
*f
, int v
)
595 if (f
->is_write
== 0 && f
->buf_index
> 0) {
597 "Attempted to write to buffer while read buffer is not empty\n");
601 f
->buf
[f
->buf_index
++] = v
;
603 if (f
->buf_index
>= IO_BUF_SIZE
) {
608 static void qemu_file_skip(QEMUFile
*f
, int size
)
610 if (f
->buf_index
+ size
<= f
->buf_size
) {
611 f
->buf_index
+= size
;
615 static int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
624 index
= f
->buf_index
+ offset
;
625 pending
= f
->buf_size
- index
;
626 if (pending
< size
) {
628 index
= f
->buf_index
+ offset
;
629 pending
= f
->buf_size
- index
;
635 if (size
> pending
) {
639 memcpy(buf
, f
->buf
+ index
, size
);
643 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
648 while (pending
> 0) {
651 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
655 qemu_file_skip(f
, res
);
663 static int qemu_peek_byte(QEMUFile
*f
, int offset
)
665 int index
= f
->buf_index
+ offset
;
671 if (index
>= f
->buf_size
) {
673 index
= f
->buf_index
+ offset
;
674 if (index
>= f
->buf_size
) {
678 return f
->buf
[index
];
681 int qemu_get_byte(QEMUFile
*f
)
685 result
= qemu_peek_byte(f
, 0);
686 qemu_file_skip(f
, 1);
690 int64_t qemu_ftell(QEMUFile
*f
)
692 /* buf_offset excludes buffer for writing but includes it for reading */
694 return f
->buf_offset
+ f
->buf_index
;
696 return f
->buf_offset
- f
->buf_size
+ f
->buf_index
;
700 int qemu_file_rate_limit(QEMUFile
*f
)
702 if (f
->ops
->rate_limit
)
703 return f
->ops
->rate_limit(f
->opaque
);
708 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
710 if (f
->ops
->get_rate_limit
)
711 return f
->ops
->get_rate_limit(f
->opaque
);
716 int64_t qemu_file_set_rate_limit(QEMUFile
*f
, int64_t new_rate
)
718 /* any failed or completed migration keeps its state to allow probing of
719 * migration data, but has no associated file anymore */
720 if (f
&& f
->ops
->set_rate_limit
)
721 return f
->ops
->set_rate_limit(f
->opaque
, new_rate
);
726 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
728 qemu_put_byte(f
, v
>> 8);
732 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
734 qemu_put_byte(f
, v
>> 24);
735 qemu_put_byte(f
, v
>> 16);
736 qemu_put_byte(f
, v
>> 8);
740 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
742 qemu_put_be32(f
, v
>> 32);
746 unsigned int qemu_get_be16(QEMUFile
*f
)
749 v
= qemu_get_byte(f
) << 8;
750 v
|= qemu_get_byte(f
);
754 unsigned int qemu_get_be32(QEMUFile
*f
)
757 v
= qemu_get_byte(f
) << 24;
758 v
|= qemu_get_byte(f
) << 16;
759 v
|= qemu_get_byte(f
) << 8;
760 v
|= qemu_get_byte(f
);
764 uint64_t qemu_get_be64(QEMUFile
*f
)
767 v
= (uint64_t)qemu_get_be32(f
) << 32;
768 v
|= qemu_get_be32(f
);
775 void qemu_put_timer(QEMUFile
*f
, QEMUTimer
*ts
)
777 uint64_t expire_time
;
779 expire_time
= qemu_timer_expire_time_ns(ts
);
780 qemu_put_be64(f
, expire_time
);
783 void qemu_get_timer(QEMUFile
*f
, QEMUTimer
*ts
)
785 uint64_t expire_time
;
787 expire_time
= qemu_get_be64(f
);
788 if (expire_time
!= -1) {
789 qemu_mod_timer_ns(ts
, expire_time
);
798 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
801 *v
= qemu_get_byte(f
);
805 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
808 qemu_put_byte(f
, *v
);
811 const VMStateInfo vmstate_info_bool
= {
819 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
826 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
832 const VMStateInfo vmstate_info_int8
= {
840 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
843 qemu_get_sbe16s(f
, v
);
847 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
850 qemu_put_sbe16s(f
, v
);
853 const VMStateInfo vmstate_info_int16
= {
861 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
864 qemu_get_sbe32s(f
, v
);
868 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
871 qemu_put_sbe32s(f
, v
);
874 const VMStateInfo vmstate_info_int32
= {
880 /* 32 bit int. See that the received value is the same than the one
883 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
887 qemu_get_sbe32s(f
, &v2
);
894 const VMStateInfo vmstate_info_int32_equal
= {
895 .name
= "int32 equal",
896 .get
= get_int32_equal
,
900 /* 32 bit int. See that the received value is the less or the same
901 than the one in the field */
903 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
907 qemu_get_sbe32s(f
, &new);
914 const VMStateInfo vmstate_info_int32_le
= {
915 .name
= "int32 equal",
922 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
925 qemu_get_sbe64s(f
, v
);
929 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
932 qemu_put_sbe64s(f
, v
);
935 const VMStateInfo vmstate_info_int64
= {
941 /* 8 bit unsigned int */
943 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
950 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
956 const VMStateInfo vmstate_info_uint8
= {
962 /* 16 bit unsigned int */
964 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
967 qemu_get_be16s(f
, v
);
971 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
974 qemu_put_be16s(f
, v
);
977 const VMStateInfo vmstate_info_uint16
= {
983 /* 32 bit unsigned int */
985 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
988 qemu_get_be32s(f
, v
);
992 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
995 qemu_put_be32s(f
, v
);
998 const VMStateInfo vmstate_info_uint32
= {
1004 /* 32 bit uint. See that the received value is the same than the one
1007 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1011 qemu_get_be32s(f
, &v2
);
1019 const VMStateInfo vmstate_info_uint32_equal
= {
1020 .name
= "uint32 equal",
1021 .get
= get_uint32_equal
,
1025 /* 64 bit unsigned int */
1027 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1030 qemu_get_be64s(f
, v
);
1034 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1037 qemu_put_be64s(f
, v
);
1040 const VMStateInfo vmstate_info_uint64
= {
1046 /* 8 bit int. See that the received value is the same than the one
1049 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1053 qemu_get_8s(f
, &v2
);
1060 const VMStateInfo vmstate_info_uint8_equal
= {
1061 .name
= "uint8 equal",
1062 .get
= get_uint8_equal
,
1066 /* 16 bit unsigned int int. See that the received value is the same than the one
1069 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1073 qemu_get_be16s(f
, &v2
);
1080 const VMStateInfo vmstate_info_uint16_equal
= {
1081 .name
= "uint16 equal",
1082 .get
= get_uint16_equal
,
1088 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1091 qemu_get_timer(f
, v
);
1095 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1098 qemu_put_timer(f
, v
);
1101 const VMStateInfo vmstate_info_timer
= {
1107 /* uint8_t buffers */
1109 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1112 qemu_get_buffer(f
, v
, size
);
1116 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1119 qemu_put_buffer(f
, v
, size
);
1122 const VMStateInfo vmstate_info_buffer
= {
1128 /* unused buffers: space that was used for some fields that are
1129 not useful anymore */
1131 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1137 block_len
= MIN(sizeof(buf
), size
);
1139 qemu_get_buffer(f
, buf
, block_len
);
1144 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1146 static const uint8_t buf
[1024];
1150 block_len
= MIN(sizeof(buf
), size
);
1152 qemu_put_buffer(f
, buf
, block_len
);
1156 const VMStateInfo vmstate_info_unused_buffer
= {
1157 .name
= "unused_buffer",
1158 .get
= get_unused_buffer
,
1159 .put
= put_unused_buffer
,
1162 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1163 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1164 * bit words with the bits in big endian order. The in-memory format
1165 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1167 /* This is the number of 64 bit words sent over the wire */
1168 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1169 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1171 unsigned long *bmp
= pv
;
1173 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1174 uint64_t w
= qemu_get_be64(f
);
1176 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1177 bmp
[idx
++] = w
>> 32;
1183 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1185 unsigned long *bmp
= pv
;
1187 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1188 uint64_t w
= bmp
[idx
++];
1189 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1190 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1192 qemu_put_be64(f
, w
);
1196 const VMStateInfo vmstate_info_bitmap
= {
1202 typedef struct CompatEntry
{
1207 typedef struct SaveStateEntry
{
1208 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1214 SaveVMHandlers
*ops
;
1215 const VMStateDescription
*vmsd
;
1217 CompatEntry
*compat
;
1223 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1224 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1225 static int global_section_id
;
1227 static int calculate_new_instance_id(const char *idstr
)
1230 int instance_id
= 0;
1232 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1233 if (strcmp(idstr
, se
->idstr
) == 0
1234 && instance_id
<= se
->instance_id
) {
1235 instance_id
= se
->instance_id
+ 1;
1241 static int calculate_compat_instance_id(const char *idstr
)
1244 int instance_id
= 0;
1246 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1250 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1251 && instance_id
<= se
->compat
->instance_id
) {
1252 instance_id
= se
->compat
->instance_id
+ 1;
1258 /* TODO: Individual devices generally have very little idea about the rest
1259 of the system, so instance_id should be removed/replaced.
1260 Meanwhile pass -1 as instance_id if you do not already have a clearly
1261 distinguishing id for all instances of your device class. */
1262 int register_savevm_live(DeviceState
*dev
,
1266 SaveVMHandlers
*ops
,
1271 se
= g_malloc0(sizeof(SaveStateEntry
));
1272 se
->version_id
= version_id
;
1273 se
->section_id
= global_section_id
++;
1275 se
->opaque
= opaque
;
1278 /* if this is a live_savem then set is_ram */
1279 if (ops
->save_live_setup
!= NULL
) {
1284 char *id
= qdev_get_dev_path(dev
);
1286 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1287 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1290 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1291 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1292 se
->compat
->instance_id
= instance_id
== -1 ?
1293 calculate_compat_instance_id(idstr
) : instance_id
;
1297 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1299 if (instance_id
== -1) {
1300 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1302 se
->instance_id
= instance_id
;
1304 assert(!se
->compat
|| se
->instance_id
== 0);
1305 /* add at the end of list */
1306 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1310 int register_savevm(DeviceState
*dev
,
1314 SaveStateHandler
*save_state
,
1315 LoadStateHandler
*load_state
,
1318 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1319 ops
->save_state
= save_state
;
1320 ops
->load_state
= load_state
;
1321 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1325 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1327 SaveStateEntry
*se
, *new_se
;
1331 char *path
= qdev_get_dev_path(dev
);
1333 pstrcpy(id
, sizeof(id
), path
);
1334 pstrcat(id
, sizeof(id
), "/");
1338 pstrcat(id
, sizeof(id
), idstr
);
1340 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1341 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1342 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1352 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1353 const VMStateDescription
*vmsd
,
1354 void *opaque
, int alias_id
,
1355 int required_for_version
)
1359 /* If this triggers, alias support can be dropped for the vmsd. */
1360 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1362 se
= g_malloc0(sizeof(SaveStateEntry
));
1363 se
->version_id
= vmsd
->version_id
;
1364 se
->section_id
= global_section_id
++;
1365 se
->opaque
= opaque
;
1367 se
->alias_id
= alias_id
;
1368 se
->no_migrate
= vmsd
->unmigratable
;
1371 char *id
= qdev_get_dev_path(dev
);
1373 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1374 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1377 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1378 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1379 se
->compat
->instance_id
= instance_id
== -1 ?
1380 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1384 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1386 if (instance_id
== -1) {
1387 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1389 se
->instance_id
= instance_id
;
1391 assert(!se
->compat
|| se
->instance_id
== 0);
1392 /* add at the end of list */
1393 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1397 int vmstate_register(DeviceState
*dev
, int instance_id
,
1398 const VMStateDescription
*vmsd
, void *opaque
)
1400 return vmstate_register_with_alias_id(dev
, instance_id
, vmsd
,
1404 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1407 SaveStateEntry
*se
, *new_se
;
1409 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1410 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1411 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1420 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1422 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1425 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1426 void *opaque
, int version_id
)
1428 VMStateField
*field
= vmsd
->fields
;
1431 if (version_id
> vmsd
->version_id
) {
1434 if (version_id
< vmsd
->minimum_version_id_old
) {
1437 if (version_id
< vmsd
->minimum_version_id
) {
1438 return vmsd
->load_state_old(f
, opaque
, version_id
);
1440 if (vmsd
->pre_load
) {
1441 int ret
= vmsd
->pre_load(opaque
);
1445 while(field
->name
) {
1446 if ((field
->field_exists
&&
1447 field
->field_exists(opaque
, version_id
)) ||
1448 (!field
->field_exists
&&
1449 field
->version_id
<= version_id
)) {
1450 void *base_addr
= opaque
+ field
->offset
;
1452 int size
= field
->size
;
1454 if (field
->flags
& VMS_VBUFFER
) {
1455 size
= *(int32_t *)(opaque
+field
->size_offset
);
1456 if (field
->flags
& VMS_MULTIPLY
) {
1457 size
*= field
->size
;
1460 if (field
->flags
& VMS_ARRAY
) {
1461 n_elems
= field
->num
;
1462 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1463 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1464 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1465 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1466 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1467 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1468 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1469 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1471 if (field
->flags
& VMS_POINTER
) {
1472 base_addr
= *(void **)base_addr
+ field
->start
;
1474 for (i
= 0; i
< n_elems
; i
++) {
1475 void *addr
= base_addr
+ size
* i
;
1477 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1478 addr
= *(void **)addr
;
1480 if (field
->flags
& VMS_STRUCT
) {
1481 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1483 ret
= field
->info
->get(f
, addr
, size
);
1493 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1497 if (vmsd
->post_load
) {
1498 return vmsd
->post_load(opaque
, version_id
);
1503 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1506 VMStateField
*field
= vmsd
->fields
;
1508 if (vmsd
->pre_save
) {
1509 vmsd
->pre_save(opaque
);
1511 while(field
->name
) {
1512 if (!field
->field_exists
||
1513 field
->field_exists(opaque
, vmsd
->version_id
)) {
1514 void *base_addr
= opaque
+ field
->offset
;
1516 int size
= field
->size
;
1518 if (field
->flags
& VMS_VBUFFER
) {
1519 size
= *(int32_t *)(opaque
+field
->size_offset
);
1520 if (field
->flags
& VMS_MULTIPLY
) {
1521 size
*= field
->size
;
1524 if (field
->flags
& VMS_ARRAY
) {
1525 n_elems
= field
->num
;
1526 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1527 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1528 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1529 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1530 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1531 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1532 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1533 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1535 if (field
->flags
& VMS_POINTER
) {
1536 base_addr
= *(void **)base_addr
+ field
->start
;
1538 for (i
= 0; i
< n_elems
; i
++) {
1539 void *addr
= base_addr
+ size
* i
;
1541 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1542 addr
= *(void **)addr
;
1544 if (field
->flags
& VMS_STRUCT
) {
1545 vmstate_save_state(f
, field
->vmsd
, addr
);
1547 field
->info
->put(f
, addr
, size
);
1553 vmstate_subsection_save(f
, vmsd
, opaque
);
1556 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1558 if (!se
->vmsd
) { /* Old style */
1559 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1561 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1564 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1566 if (!se
->vmsd
) { /* Old style */
1567 se
->ops
->save_state(f
, se
->opaque
);
1570 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1573 #define QEMU_VM_FILE_MAGIC 0x5145564d
1574 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1575 #define QEMU_VM_FILE_VERSION 0x00000003
1577 #define QEMU_VM_EOF 0x00
1578 #define QEMU_VM_SECTION_START 0x01
1579 #define QEMU_VM_SECTION_PART 0x02
1580 #define QEMU_VM_SECTION_END 0x03
1581 #define QEMU_VM_SECTION_FULL 0x04
1582 #define QEMU_VM_SUBSECTION 0x05
1584 bool qemu_savevm_state_blocked(Error
**errp
)
1588 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1589 if (se
->no_migrate
) {
1590 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1597 void qemu_savevm_state_begin(QEMUFile
*f
,
1598 const MigrationParams
*params
)
1603 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1604 if (!se
->ops
|| !se
->ops
->set_params
) {
1607 se
->ops
->set_params(params
, se
->opaque
);
1610 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1611 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1613 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1616 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1619 if (se
->ops
&& se
->ops
->is_active
) {
1620 if (!se
->ops
->is_active(se
->opaque
)) {
1625 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1626 qemu_put_be32(f
, se
->section_id
);
1629 len
= strlen(se
->idstr
);
1630 qemu_put_byte(f
, len
);
1631 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1633 qemu_put_be32(f
, se
->instance_id
);
1634 qemu_put_be32(f
, se
->version_id
);
1636 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1638 qemu_file_set_error(f
, ret
);
1645 * this function has three return values:
1646 * negative: there was one error, and we have -errno.
1647 * 0 : We haven't finished, caller have to go again
1648 * 1 : We have finished, we can go to complete phase
1650 int qemu_savevm_state_iterate(QEMUFile
*f
)
1655 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1656 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1659 if (se
->ops
&& se
->ops
->is_active
) {
1660 if (!se
->ops
->is_active(se
->opaque
)) {
1664 if (qemu_file_rate_limit(f
)) {
1667 trace_savevm_section_start();
1669 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1670 qemu_put_be32(f
, se
->section_id
);
1672 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1673 trace_savevm_section_end(se
->section_id
);
1676 qemu_file_set_error(f
, ret
);
1679 /* Do not proceed to the next vmstate before this one reported
1680 completion of the current stage. This serializes the migration
1681 and reduces the probability that a faster changing state is
1682 synchronized over and over again. */
1689 void qemu_savevm_state_complete(QEMUFile
*f
)
1694 cpu_synchronize_all_states();
1696 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1697 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1700 if (se
->ops
&& se
->ops
->is_active
) {
1701 if (!se
->ops
->is_active(se
->opaque
)) {
1705 trace_savevm_section_start();
1707 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1708 qemu_put_be32(f
, se
->section_id
);
1710 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1711 trace_savevm_section_end(se
->section_id
);
1713 qemu_file_set_error(f
, ret
);
1718 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1721 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1724 trace_savevm_section_start();
1726 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1727 qemu_put_be32(f
, se
->section_id
);
1730 len
= strlen(se
->idstr
);
1731 qemu_put_byte(f
, len
);
1732 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1734 qemu_put_be32(f
, se
->instance_id
);
1735 qemu_put_be32(f
, se
->version_id
);
1737 vmstate_save(f
, se
);
1738 trace_savevm_section_end(se
->section_id
);
1741 qemu_put_byte(f
, QEMU_VM_EOF
);
1745 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
1750 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1751 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
1754 if (se
->ops
&& se
->ops
->is_active
) {
1755 if (!se
->ops
->is_active(se
->opaque
)) {
1759 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
1764 void qemu_savevm_state_cancel(void)
1768 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1769 if (se
->ops
&& se
->ops
->cancel
) {
1770 se
->ops
->cancel(se
->opaque
);
1775 static int qemu_savevm_state(QEMUFile
*f
)
1778 MigrationParams params
= {
1783 if (qemu_savevm_state_blocked(NULL
)) {
1787 qemu_mutex_unlock_iothread();
1788 qemu_savevm_state_begin(f
, ¶ms
);
1789 qemu_mutex_lock_iothread();
1791 while (qemu_file_get_error(f
) == 0) {
1792 if (qemu_savevm_state_iterate(f
) > 0) {
1797 ret
= qemu_file_get_error(f
);
1799 qemu_savevm_state_complete(f
);
1800 ret
= qemu_file_get_error(f
);
1803 qemu_savevm_state_cancel();
1808 static int qemu_save_device_state(QEMUFile
*f
)
1812 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1813 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1815 cpu_synchronize_all_states();
1817 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1823 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1828 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1829 qemu_put_be32(f
, se
->section_id
);
1832 len
= strlen(se
->idstr
);
1833 qemu_put_byte(f
, len
);
1834 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1836 qemu_put_be32(f
, se
->instance_id
);
1837 qemu_put_be32(f
, se
->version_id
);
1839 vmstate_save(f
, se
);
1842 qemu_put_byte(f
, QEMU_VM_EOF
);
1844 return qemu_file_get_error(f
);
1847 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
1851 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1852 if (!strcmp(se
->idstr
, idstr
) &&
1853 (instance_id
== se
->instance_id
||
1854 instance_id
== se
->alias_id
))
1856 /* Migrating from an older version? */
1857 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
1858 if (!strcmp(se
->compat
->idstr
, idstr
) &&
1859 (instance_id
== se
->compat
->instance_id
||
1860 instance_id
== se
->alias_id
))
1867 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
1869 while(sub
&& sub
->needed
) {
1870 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
1878 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1881 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
1884 uint8_t version_id
, len
, size
;
1885 const VMStateDescription
*sub_vmsd
;
1887 len
= qemu_peek_byte(f
, 1);
1888 if (len
< strlen(vmsd
->name
) + 1) {
1889 /* subsection name has be be "section_name/a" */
1892 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
1898 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
1899 /* it don't have a valid subsection name */
1902 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
1903 if (sub_vmsd
== NULL
) {
1906 qemu_file_skip(f
, 1); /* subsection */
1907 qemu_file_skip(f
, 1); /* len */
1908 qemu_file_skip(f
, len
); /* idstr */
1909 version_id
= qemu_get_be32(f
);
1911 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
1919 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1922 const VMStateSubsection
*sub
= vmsd
->subsections
;
1924 while (sub
&& sub
->needed
) {
1925 if (sub
->needed(opaque
)) {
1926 const VMStateDescription
*vmsd
= sub
->vmsd
;
1929 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
1930 len
= strlen(vmsd
->name
);
1931 qemu_put_byte(f
, len
);
1932 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
1933 qemu_put_be32(f
, vmsd
->version_id
);
1934 vmstate_save_state(f
, vmsd
, opaque
);
1940 typedef struct LoadStateEntry
{
1941 QLIST_ENTRY(LoadStateEntry
) entry
;
1947 int qemu_loadvm_state(QEMUFile
*f
)
1949 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
1950 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
1951 LoadStateEntry
*le
, *new_le
;
1952 uint8_t section_type
;
1956 if (qemu_savevm_state_blocked(NULL
)) {
1960 v
= qemu_get_be32(f
);
1961 if (v
!= QEMU_VM_FILE_MAGIC
)
1964 v
= qemu_get_be32(f
);
1965 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
1966 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
1969 if (v
!= QEMU_VM_FILE_VERSION
)
1972 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
1973 uint32_t instance_id
, version_id
, section_id
;
1978 switch (section_type
) {
1979 case QEMU_VM_SECTION_START
:
1980 case QEMU_VM_SECTION_FULL
:
1981 /* Read section start */
1982 section_id
= qemu_get_be32(f
);
1983 len
= qemu_get_byte(f
);
1984 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
1986 instance_id
= qemu_get_be32(f
);
1987 version_id
= qemu_get_be32(f
);
1989 /* Find savevm section */
1990 se
= find_se(idstr
, instance_id
);
1992 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
1997 /* Validate version */
1998 if (version_id
> se
->version_id
) {
1999 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2000 version_id
, idstr
, se
->version_id
);
2006 le
= g_malloc0(sizeof(*le
));
2009 le
->section_id
= section_id
;
2010 le
->version_id
= version_id
;
2011 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2013 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2015 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2016 instance_id
, idstr
);
2020 case QEMU_VM_SECTION_PART
:
2021 case QEMU_VM_SECTION_END
:
2022 section_id
= qemu_get_be32(f
);
2024 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2025 if (le
->section_id
== section_id
) {
2030 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2035 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2037 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2043 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2049 cpu_synchronize_all_post_init();
2054 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2055 QLIST_REMOVE(le
, entry
);
2060 ret
= qemu_file_get_error(f
);
2066 static int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
2069 QEMUSnapshotInfo
*sn_tab
, *sn
;
2073 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2076 for(i
= 0; i
< nb_sns
; i
++) {
2078 if (!strcmp(sn
->id_str
, name
) || !strcmp(sn
->name
, name
)) {
2089 * Deletes snapshots of a given name in all opened images.
2091 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2093 BlockDriverState
*bs
;
2094 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2098 while ((bs
= bdrv_next(bs
))) {
2099 if (bdrv_can_snapshot(bs
) &&
2100 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2102 ret
= bdrv_snapshot_delete(bs
, name
);
2105 "Error while deleting snapshot on '%s'\n",
2106 bdrv_get_device_name(bs
));
2115 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2117 BlockDriverState
*bs
, *bs1
;
2118 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2121 int saved_vm_running
;
2122 uint64_t vm_state_size
;
2125 const char *name
= qdict_get_try_str(qdict
, "name");
2127 /* Verify if there is a device that doesn't support snapshots and is writable */
2129 while ((bs
= bdrv_next(bs
))) {
2131 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2135 if (!bdrv_can_snapshot(bs
)) {
2136 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2137 bdrv_get_device_name(bs
));
2142 bs
= bdrv_snapshots();
2144 monitor_printf(mon
, "No block device can accept snapshots\n");
2148 saved_vm_running
= runstate_is_running();
2149 vm_stop(RUN_STATE_SAVE_VM
);
2151 memset(sn
, 0, sizeof(*sn
));
2153 /* fill auxiliary fields */
2154 qemu_gettimeofday(&tv
);
2155 sn
->date_sec
= tv
.tv_sec
;
2156 sn
->date_nsec
= tv
.tv_usec
* 1000;
2157 sn
->vm_clock_nsec
= qemu_get_clock_ns(vm_clock
);
2160 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2162 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2163 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2165 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2168 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2169 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2170 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2173 /* Delete old snapshots of the same name */
2174 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2178 /* save the VM state */
2179 f
= qemu_fopen_bdrv(bs
, 1);
2181 monitor_printf(mon
, "Could not open VM state file\n");
2184 ret
= qemu_savevm_state(f
);
2185 vm_state_size
= qemu_ftell(f
);
2188 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2192 /* create the snapshots */
2195 while ((bs1
= bdrv_next(bs1
))) {
2196 if (bdrv_can_snapshot(bs1
)) {
2197 /* Write VM state size only to the image that contains the state */
2198 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2199 ret
= bdrv_snapshot_create(bs1
, sn
);
2201 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2202 bdrv_get_device_name(bs1
));
2208 if (saved_vm_running
)
2212 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2215 int saved_vm_running
;
2218 saved_vm_running
= runstate_is_running();
2219 vm_stop(RUN_STATE_SAVE_VM
);
2221 f
= qemu_fopen(filename
, "wb");
2223 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
2226 ret
= qemu_save_device_state(f
);
2229 error_set(errp
, QERR_IO_ERROR
);
2233 if (saved_vm_running
)
2237 int load_vmstate(const char *name
)
2239 BlockDriverState
*bs
, *bs_vm_state
;
2240 QEMUSnapshotInfo sn
;
2244 bs_vm_state
= bdrv_snapshots();
2246 error_report("No block device supports snapshots");
2250 /* Don't even try to load empty VM states */
2251 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2254 } else if (sn
.vm_state_size
== 0) {
2255 error_report("This is a disk-only snapshot. Revert to it offline "
2260 /* Verify if there is any device that doesn't support snapshots and is
2261 writable and check if the requested snapshot is available too. */
2263 while ((bs
= bdrv_next(bs
))) {
2265 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2269 if (!bdrv_can_snapshot(bs
)) {
2270 error_report("Device '%s' is writable but does not support snapshots.",
2271 bdrv_get_device_name(bs
));
2275 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2277 error_report("Device '%s' does not have the requested snapshot '%s'",
2278 bdrv_get_device_name(bs
), name
);
2283 /* Flush all IO requests so they don't interfere with the new state. */
2287 while ((bs
= bdrv_next(bs
))) {
2288 if (bdrv_can_snapshot(bs
)) {
2289 ret
= bdrv_snapshot_goto(bs
, name
);
2291 error_report("Error %d while activating snapshot '%s' on '%s'",
2292 ret
, name
, bdrv_get_device_name(bs
));
2298 /* restore the VM state */
2299 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2301 error_report("Could not open VM state file");
2305 qemu_system_reset(VMRESET_SILENT
);
2306 ret
= qemu_loadvm_state(f
);
2310 error_report("Error %d while loading VM state", ret
);
2317 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2319 BlockDriverState
*bs
, *bs1
;
2321 const char *name
= qdict_get_str(qdict
, "name");
2323 bs
= bdrv_snapshots();
2325 monitor_printf(mon
, "No block device supports snapshots\n");
2330 while ((bs1
= bdrv_next(bs1
))) {
2331 if (bdrv_can_snapshot(bs1
)) {
2332 ret
= bdrv_snapshot_delete(bs1
, name
);
2334 if (ret
== -ENOTSUP
)
2336 "Snapshots not supported on device '%s'\n",
2337 bdrv_get_device_name(bs1
));
2339 monitor_printf(mon
, "Error %d while deleting snapshot on "
2340 "'%s'\n", ret
, bdrv_get_device_name(bs1
));
2346 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2348 BlockDriverState
*bs
, *bs1
;
2349 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2350 int nb_sns
, i
, ret
, available
;
2352 int *available_snapshots
;
2355 bs
= bdrv_snapshots();
2357 monitor_printf(mon
, "No available block device supports snapshots\n");
2361 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2363 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2368 monitor_printf(mon
, "There is no snapshot available.\n");
2372 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2374 for (i
= 0; i
< nb_sns
; i
++) {
2379 while ((bs1
= bdrv_next(bs1
))) {
2380 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2381 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2390 available_snapshots
[total
] = i
;
2396 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
2397 for (i
= 0; i
< total
; i
++) {
2398 sn
= &sn_tab
[available_snapshots
[i
]];
2399 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
2402 monitor_printf(mon
, "There is no suitable snapshot available\n");
2406 g_free(available_snapshots
);
2410 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2412 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2413 memory_region_name(mr
), dev
);
2416 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2418 /* Nothing do to while the implementation is in RAMBlock */
2421 void vmstate_register_ram_global(MemoryRegion
*mr
)
2423 vmstate_register_ram(mr
, NULL
);