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"
44 #define SELF_ANNOUNCE_ROUNDS 5
47 #define ETH_P_RARP 0x8035
49 #define ARP_HTYPE_ETH 0x0001
50 #define ARP_PTYPE_IP 0x0800
51 #define ARP_OP_REQUEST_REV 0x3
53 static int announce_self_create(uint8_t *buf
,
56 /* Ethernet header. */
57 memset(buf
, 0xff, 6); /* destination MAC addr */
58 memcpy(buf
+ 6, mac_addr
, 6); /* source MAC addr */
59 *(uint16_t *)(buf
+ 12) = htons(ETH_P_RARP
); /* ethertype */
62 *(uint16_t *)(buf
+ 14) = htons(ARP_HTYPE_ETH
); /* hardware addr space */
63 *(uint16_t *)(buf
+ 16) = htons(ARP_PTYPE_IP
); /* protocol addr space */
64 *(buf
+ 18) = 6; /* hardware addr length (ethernet) */
65 *(buf
+ 19) = 4; /* protocol addr length (IPv4) */
66 *(uint16_t *)(buf
+ 20) = htons(ARP_OP_REQUEST_REV
); /* opcode */
67 memcpy(buf
+ 22, mac_addr
, 6); /* source hw addr */
68 memset(buf
+ 28, 0x00, 4); /* source protocol addr */
69 memcpy(buf
+ 32, mac_addr
, 6); /* target hw addr */
70 memset(buf
+ 38, 0x00, 4); /* target protocol addr */
72 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
73 memset(buf
+ 42, 0x00, 18);
75 return 60; /* len (FCS will be added by hardware) */
78 static void qemu_announce_self_iter(NICState
*nic
, void *opaque
)
83 len
= announce_self_create(buf
, nic
->conf
->macaddr
.a
);
85 qemu_send_packet_raw(qemu_get_queue(nic
), buf
, len
);
89 static void qemu_announce_self_once(void *opaque
)
91 static int count
= SELF_ANNOUNCE_ROUNDS
;
92 QEMUTimer
*timer
= *(QEMUTimer
**)opaque
;
94 qemu_foreach_nic(qemu_announce_self_iter
, NULL
);
97 /* delay 50ms, 150ms, 250ms, ... */
98 qemu_mod_timer(timer
, qemu_get_clock_ms(rt_clock
) +
99 50 + (SELF_ANNOUNCE_ROUNDS
- count
- 1) * 100);
101 qemu_del_timer(timer
);
102 qemu_free_timer(timer
);
106 void qemu_announce_self(void)
108 static QEMUTimer
*timer
;
109 timer
= qemu_new_timer_ms(rt_clock
, qemu_announce_self_once
, &timer
);
110 qemu_announce_self_once(&timer
);
113 /***********************************************************/
114 /* savevm/loadvm support */
116 #define IO_BUF_SIZE 32768
117 #define MAX_IOV_SIZE MIN(IOV_MAX, 64)
120 const QEMUFileOps
*ops
;
127 int64_t pos
; /* start of buffer when writing, end of buffer
130 int buf_size
; /* 0 when writing */
131 uint8_t buf
[IO_BUF_SIZE
];
133 struct iovec iov
[MAX_IOV_SIZE
];
139 typedef struct QEMUFileStdio
145 typedef struct QEMUFileSocket
156 static void fd_coroutine_enter(void *opaque
)
158 FDYieldUntilData
*data
= opaque
;
159 qemu_set_fd_handler(data
->fd
, NULL
, NULL
, NULL
);
160 qemu_coroutine_enter(data
->co
, NULL
);
164 * Yield until a file descriptor becomes readable
166 * Note that this function clobbers the handlers for the file descriptor.
168 static void coroutine_fn
yield_until_fd_readable(int fd
)
170 FDYieldUntilData data
;
172 assert(qemu_in_coroutine());
173 data
.co
= qemu_coroutine_self();
175 qemu_set_fd_handler(fd
, fd_coroutine_enter
, NULL
, &data
);
176 qemu_coroutine_yield();
179 static ssize_t
socket_writev_buffer(void *opaque
, struct iovec
*iov
, int iovcnt
)
181 QEMUFileSocket
*s
= opaque
;
183 ssize_t size
= iov_size(iov
, iovcnt
);
185 len
= iov_send(s
->fd
, iov
, iovcnt
, 0, size
);
187 len
= -socket_error();
192 static int socket_get_fd(void *opaque
)
194 QEMUFileSocket
*s
= opaque
;
199 static int socket_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
201 QEMUFileSocket
*s
= opaque
;
205 len
= qemu_recv(s
->fd
, buf
, size
, 0);
209 if (socket_error() == EAGAIN
) {
210 yield_until_fd_readable(s
->fd
);
211 } else if (socket_error() != EINTR
) {
217 len
= -socket_error();
222 static int socket_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
224 QEMUFileSocket
*s
= opaque
;
227 len
= qemu_send_full(s
->fd
, buf
, size
, 0);
229 len
= -socket_error();
234 static int socket_close(void *opaque
)
236 QEMUFileSocket
*s
= opaque
;
242 static int stdio_get_fd(void *opaque
)
244 QEMUFileStdio
*s
= opaque
;
246 return fileno(s
->stdio_file
);
249 static int stdio_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
251 QEMUFileStdio
*s
= opaque
;
252 return fwrite(buf
, 1, size
, s
->stdio_file
);
255 static int stdio_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
257 QEMUFileStdio
*s
= opaque
;
258 FILE *fp
= s
->stdio_file
;
263 bytes
= fread(buf
, 1, size
, fp
);
264 if (bytes
!= 0 || !ferror(fp
)) {
267 if (errno
== EAGAIN
) {
268 yield_until_fd_readable(fileno(fp
));
269 } else if (errno
!= EINTR
) {
276 static int stdio_pclose(void *opaque
)
278 QEMUFileStdio
*s
= opaque
;
280 ret
= pclose(s
->stdio_file
);
283 } else if (!WIFEXITED(ret
) || WEXITSTATUS(ret
) != 0) {
284 /* close succeeded, but non-zero exit code: */
285 ret
= -EIO
; /* fake errno value */
291 static int stdio_fclose(void *opaque
)
293 QEMUFileStdio
*s
= opaque
;
296 if (s
->file
->ops
->put_buffer
|| s
->file
->ops
->writev_buffer
) {
297 int fd
= fileno(s
->stdio_file
);
300 ret
= fstat(fd
, &st
);
301 if (ret
== 0 && S_ISREG(st
.st_mode
)) {
303 * If the file handle is a regular file make sure the
304 * data is flushed to disk before signaling success.
313 if (fclose(s
->stdio_file
) == EOF
) {
320 static const QEMUFileOps stdio_pipe_read_ops
= {
321 .get_fd
= stdio_get_fd
,
322 .get_buffer
= stdio_get_buffer
,
323 .close
= stdio_pclose
326 static const QEMUFileOps stdio_pipe_write_ops
= {
327 .get_fd
= stdio_get_fd
,
328 .put_buffer
= stdio_put_buffer
,
329 .close
= stdio_pclose
332 QEMUFile
*qemu_popen_cmd(const char *command
, const char *mode
)
337 stdio_file
= popen(command
, mode
);
338 if (stdio_file
== NULL
) {
342 if (mode
== NULL
|| (mode
[0] != 'r' && mode
[0] != 'w') || mode
[1] != 0) {
343 fprintf(stderr
, "qemu_popen: Argument validity check failed\n");
347 s
= g_malloc0(sizeof(QEMUFileStdio
));
349 s
->stdio_file
= stdio_file
;
352 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_read_ops
);
354 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_write_ops
);
359 static const QEMUFileOps stdio_file_read_ops
= {
360 .get_fd
= stdio_get_fd
,
361 .get_buffer
= stdio_get_buffer
,
362 .close
= stdio_fclose
365 static const QEMUFileOps stdio_file_write_ops
= {
366 .get_fd
= stdio_get_fd
,
367 .put_buffer
= stdio_put_buffer
,
368 .close
= stdio_fclose
371 QEMUFile
*qemu_fdopen(int fd
, const char *mode
)
376 (mode
[0] != 'r' && mode
[0] != 'w') ||
377 mode
[1] != 'b' || mode
[2] != 0) {
378 fprintf(stderr
, "qemu_fdopen: Argument validity check failed\n");
382 s
= g_malloc0(sizeof(QEMUFileStdio
));
383 s
->stdio_file
= fdopen(fd
, mode
);
388 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
390 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
399 static const QEMUFileOps socket_read_ops
= {
400 .get_fd
= socket_get_fd
,
401 .get_buffer
= socket_get_buffer
,
402 .close
= socket_close
405 static const QEMUFileOps socket_write_ops
= {
406 .get_fd
= socket_get_fd
,
407 .put_buffer
= socket_put_buffer
,
408 .writev_buffer
= socket_writev_buffer
,
409 .close
= socket_close
412 QEMUFile
*qemu_fopen_socket(int fd
, const char *mode
)
414 QEMUFileSocket
*s
= g_malloc0(sizeof(QEMUFileSocket
));
417 (mode
[0] != 'r' && mode
[0] != 'w') ||
418 mode
[1] != 'b' || mode
[2] != 0) {
419 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
424 if (mode
[0] == 'w') {
425 socket_set_block(s
->fd
);
426 s
->file
= qemu_fopen_ops(s
, &socket_write_ops
);
428 s
->file
= qemu_fopen_ops(s
, &socket_read_ops
);
433 QEMUFile
*qemu_fopen(const char *filename
, const char *mode
)
438 (mode
[0] != 'r' && mode
[0] != 'w') ||
439 mode
[1] != 'b' || mode
[2] != 0) {
440 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
444 s
= g_malloc0(sizeof(QEMUFileStdio
));
446 s
->stdio_file
= fopen(filename
, mode
);
451 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
453 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
461 static int block_put_buffer(void *opaque
, const uint8_t *buf
,
462 int64_t pos
, int size
)
464 bdrv_save_vmstate(opaque
, buf
, pos
, size
);
468 static int block_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
470 return bdrv_load_vmstate(opaque
, buf
, pos
, size
);
473 static int bdrv_fclose(void *opaque
)
475 return bdrv_flush(opaque
);
478 static const QEMUFileOps bdrv_read_ops
= {
479 .get_buffer
= block_get_buffer
,
483 static const QEMUFileOps bdrv_write_ops
= {
484 .put_buffer
= block_put_buffer
,
488 static QEMUFile
*qemu_fopen_bdrv(BlockDriverState
*bs
, int is_writable
)
491 return qemu_fopen_ops(bs
, &bdrv_write_ops
);
492 return qemu_fopen_ops(bs
, &bdrv_read_ops
);
495 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
)
499 f
= g_malloc0(sizeof(QEMUFile
));
507 int qemu_file_get_error(QEMUFile
*f
)
509 return f
->last_error
;
512 static void qemu_file_set_error(QEMUFile
*f
, int ret
)
514 if (f
->last_error
== 0) {
520 * Flushes QEMUFile buffer
522 * If there is writev_buffer QEMUFileOps it uses it otherwise uses
525 static void qemu_fflush(QEMUFile
*f
)
530 if (!f
->ops
->writev_buffer
&& !f
->ops
->put_buffer
) {
534 if (f
->is_write
&& f
->iovcnt
> 0) {
535 if (f
->ops
->writev_buffer
) {
536 ret
= f
->ops
->writev_buffer(f
->opaque
, f
->iov
, f
->iovcnt
);
541 for (i
= 0; i
< f
->iovcnt
&& ret
>= 0; i
++) {
542 ret
= f
->ops
->put_buffer(f
->opaque
, f
->iov
[i
].iov_base
, f
->pos
,
553 qemu_file_set_error(f
, ret
);
557 static void qemu_fill_buffer(QEMUFile
*f
)
562 if (!f
->ops
->get_buffer
)
568 pending
= f
->buf_size
- f
->buf_index
;
570 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
573 f
->buf_size
= pending
;
575 len
= f
->ops
->get_buffer(f
->opaque
, f
->buf
+ pending
, f
->pos
,
576 IO_BUF_SIZE
- pending
);
580 } else if (len
== 0) {
581 qemu_file_set_error(f
, -EIO
);
582 } else if (len
!= -EAGAIN
)
583 qemu_file_set_error(f
, len
);
586 int qemu_get_fd(QEMUFile
*f
)
588 if (f
->ops
->get_fd
) {
589 return f
->ops
->get_fd(f
->opaque
);
596 * Returns negative error value if any error happened on previous operations or
597 * while closing the file. Returns 0 or positive number on success.
599 * The meaning of return value on success depends on the specific backend
602 int qemu_fclose(QEMUFile
*f
)
606 ret
= qemu_file_get_error(f
);
609 int ret2
= f
->ops
->close(f
->opaque
);
614 /* If any error was spotted before closing, we should report it
615 * instead of the close() return value.
624 static void add_to_iovec(QEMUFile
*f
, const uint8_t *buf
, int size
)
626 /* check for adjacent buffer and coalesce them */
627 if (f
->iovcnt
> 0 && buf
== f
->iov
[f
->iovcnt
- 1].iov_base
+
628 f
->iov
[f
->iovcnt
- 1].iov_len
) {
629 f
->iov
[f
->iovcnt
- 1].iov_len
+= size
;
631 f
->iov
[f
->iovcnt
].iov_base
= (uint8_t *)buf
;
632 f
->iov
[f
->iovcnt
++].iov_len
= size
;
636 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
644 if (f
->is_write
== 0 && f
->buf_index
> 0) {
646 "Attempted to write to buffer while read buffer is not empty\n");
651 l
= IO_BUF_SIZE
- f
->buf_index
;
654 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
655 add_to_iovec(f
, f
->buf
+ f
->buf_index
, l
);
661 if (f
->buf_index
>= IO_BUF_SIZE
|| f
->iovcnt
>= MAX_IOV_SIZE
) {
663 if (qemu_file_get_error(f
)) {
670 void qemu_put_byte(QEMUFile
*f
, int v
)
676 if (f
->is_write
== 0 && f
->buf_index
> 0) {
678 "Attempted to write to buffer while read buffer is not empty\n");
682 f
->buf
[f
->buf_index
++] = v
;
686 add_to_iovec(f
, f
->buf
+ (f
->buf_index
- 1), 1);
688 if (f
->buf_index
>= IO_BUF_SIZE
|| f
->iovcnt
>= MAX_IOV_SIZE
) {
693 static void qemu_file_skip(QEMUFile
*f
, int size
)
695 if (f
->buf_index
+ size
<= f
->buf_size
) {
696 f
->buf_index
+= size
;
700 static int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
709 index
= f
->buf_index
+ offset
;
710 pending
= f
->buf_size
- index
;
711 if (pending
< size
) {
713 index
= f
->buf_index
+ offset
;
714 pending
= f
->buf_size
- index
;
720 if (size
> pending
) {
724 memcpy(buf
, f
->buf
+ index
, size
);
728 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
733 while (pending
> 0) {
736 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
740 qemu_file_skip(f
, res
);
748 static int qemu_peek_byte(QEMUFile
*f
, int offset
)
750 int index
= f
->buf_index
+ offset
;
756 if (index
>= f
->buf_size
) {
758 index
= f
->buf_index
+ offset
;
759 if (index
>= f
->buf_size
) {
763 return f
->buf
[index
];
766 int qemu_get_byte(QEMUFile
*f
)
770 result
= qemu_peek_byte(f
, 0);
771 qemu_file_skip(f
, 1);
775 int64_t qemu_ftell(QEMUFile
*f
)
781 int qemu_file_rate_limit(QEMUFile
*f
)
783 if (qemu_file_get_error(f
)) {
786 if (f
->xfer_limit
> 0 && f
->bytes_xfer
> f
->xfer_limit
) {
792 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
794 return f
->xfer_limit
;
797 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t limit
)
799 f
->xfer_limit
= limit
;
802 void qemu_file_reset_rate_limit(QEMUFile
*f
)
807 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
809 qemu_put_byte(f
, v
>> 8);
813 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
815 qemu_put_byte(f
, v
>> 24);
816 qemu_put_byte(f
, v
>> 16);
817 qemu_put_byte(f
, v
>> 8);
821 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
823 qemu_put_be32(f
, v
>> 32);
827 unsigned int qemu_get_be16(QEMUFile
*f
)
830 v
= qemu_get_byte(f
) << 8;
831 v
|= qemu_get_byte(f
);
835 unsigned int qemu_get_be32(QEMUFile
*f
)
838 v
= qemu_get_byte(f
) << 24;
839 v
|= qemu_get_byte(f
) << 16;
840 v
|= qemu_get_byte(f
) << 8;
841 v
|= qemu_get_byte(f
);
845 uint64_t qemu_get_be64(QEMUFile
*f
)
848 v
= (uint64_t)qemu_get_be32(f
) << 32;
849 v
|= qemu_get_be32(f
);
856 void qemu_put_timer(QEMUFile
*f
, QEMUTimer
*ts
)
858 uint64_t expire_time
;
860 expire_time
= qemu_timer_expire_time_ns(ts
);
861 qemu_put_be64(f
, expire_time
);
864 void qemu_get_timer(QEMUFile
*f
, QEMUTimer
*ts
)
866 uint64_t expire_time
;
868 expire_time
= qemu_get_be64(f
);
869 if (expire_time
!= -1) {
870 qemu_mod_timer_ns(ts
, expire_time
);
879 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
882 *v
= qemu_get_byte(f
);
886 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
889 qemu_put_byte(f
, *v
);
892 const VMStateInfo vmstate_info_bool
= {
900 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
907 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
913 const VMStateInfo vmstate_info_int8
= {
921 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
924 qemu_get_sbe16s(f
, v
);
928 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
931 qemu_put_sbe16s(f
, v
);
934 const VMStateInfo vmstate_info_int16
= {
942 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
945 qemu_get_sbe32s(f
, v
);
949 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
952 qemu_put_sbe32s(f
, v
);
955 const VMStateInfo vmstate_info_int32
= {
961 /* 32 bit int. See that the received value is the same than the one
964 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
968 qemu_get_sbe32s(f
, &v2
);
975 const VMStateInfo vmstate_info_int32_equal
= {
976 .name
= "int32 equal",
977 .get
= get_int32_equal
,
981 /* 32 bit int. See that the received value is the less or the same
982 than the one in the field */
984 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
988 qemu_get_sbe32s(f
, &new);
995 const VMStateInfo vmstate_info_int32_le
= {
996 .name
= "int32 equal",
1003 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
1006 qemu_get_sbe64s(f
, v
);
1010 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
1013 qemu_put_sbe64s(f
, v
);
1016 const VMStateInfo vmstate_info_int64
= {
1022 /* 8 bit unsigned int */
1024 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1031 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1037 const VMStateInfo vmstate_info_uint8
= {
1043 /* 16 bit unsigned int */
1045 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1048 qemu_get_be16s(f
, v
);
1052 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1055 qemu_put_be16s(f
, v
);
1058 const VMStateInfo vmstate_info_uint16
= {
1064 /* 32 bit unsigned int */
1066 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1069 qemu_get_be32s(f
, v
);
1073 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1076 qemu_put_be32s(f
, v
);
1079 const VMStateInfo vmstate_info_uint32
= {
1085 /* 32 bit uint. See that the received value is the same than the one
1088 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1092 qemu_get_be32s(f
, &v2
);
1100 const VMStateInfo vmstate_info_uint32_equal
= {
1101 .name
= "uint32 equal",
1102 .get
= get_uint32_equal
,
1106 /* 64 bit unsigned int */
1108 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1111 qemu_get_be64s(f
, v
);
1115 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1118 qemu_put_be64s(f
, v
);
1121 const VMStateInfo vmstate_info_uint64
= {
1127 /* 64 bit unsigned int. See that the received value is the same than the one
1130 static int get_uint64_equal(QEMUFile
*f
, void *pv
, size_t size
)
1134 qemu_get_be64s(f
, &v2
);
1142 const VMStateInfo vmstate_info_uint64_equal
= {
1143 .name
= "int64 equal",
1144 .get
= get_uint64_equal
,
1148 /* 8 bit int. See that the received value is the same than the one
1151 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1155 qemu_get_8s(f
, &v2
);
1162 const VMStateInfo vmstate_info_uint8_equal
= {
1163 .name
= "uint8 equal",
1164 .get
= get_uint8_equal
,
1168 /* 16 bit unsigned int int. See that the received value is the same than the one
1171 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1175 qemu_get_be16s(f
, &v2
);
1182 const VMStateInfo vmstate_info_uint16_equal
= {
1183 .name
= "uint16 equal",
1184 .get
= get_uint16_equal
,
1188 /* floating point */
1190 static int get_float64(QEMUFile
*f
, void *pv
, size_t size
)
1194 *v
= make_float64(qemu_get_be64(f
));
1198 static void put_float64(QEMUFile
*f
, void *pv
, size_t size
)
1202 qemu_put_be64(f
, float64_val(*v
));
1205 const VMStateInfo vmstate_info_float64
= {
1213 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1216 qemu_get_timer(f
, v
);
1220 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1223 qemu_put_timer(f
, v
);
1226 const VMStateInfo vmstate_info_timer
= {
1232 /* uint8_t buffers */
1234 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1237 qemu_get_buffer(f
, v
, size
);
1241 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1244 qemu_put_buffer(f
, v
, size
);
1247 const VMStateInfo vmstate_info_buffer
= {
1253 /* unused buffers: space that was used for some fields that are
1254 not useful anymore */
1256 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1262 block_len
= MIN(sizeof(buf
), size
);
1264 qemu_get_buffer(f
, buf
, block_len
);
1269 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1271 static const uint8_t buf
[1024];
1275 block_len
= MIN(sizeof(buf
), size
);
1277 qemu_put_buffer(f
, buf
, block_len
);
1281 const VMStateInfo vmstate_info_unused_buffer
= {
1282 .name
= "unused_buffer",
1283 .get
= get_unused_buffer
,
1284 .put
= put_unused_buffer
,
1287 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1288 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1289 * bit words with the bits in big endian order. The in-memory format
1290 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1292 /* This is the number of 64 bit words sent over the wire */
1293 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1294 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1296 unsigned long *bmp
= pv
;
1298 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1299 uint64_t w
= qemu_get_be64(f
);
1301 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1302 bmp
[idx
++] = w
>> 32;
1308 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1310 unsigned long *bmp
= pv
;
1312 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1313 uint64_t w
= bmp
[idx
++];
1314 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1315 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1317 qemu_put_be64(f
, w
);
1321 const VMStateInfo vmstate_info_bitmap
= {
1327 typedef struct CompatEntry
{
1332 typedef struct SaveStateEntry
{
1333 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1339 SaveVMHandlers
*ops
;
1340 const VMStateDescription
*vmsd
;
1342 CompatEntry
*compat
;
1348 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1349 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1350 static int global_section_id
;
1352 static int calculate_new_instance_id(const char *idstr
)
1355 int instance_id
= 0;
1357 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1358 if (strcmp(idstr
, se
->idstr
) == 0
1359 && instance_id
<= se
->instance_id
) {
1360 instance_id
= se
->instance_id
+ 1;
1366 static int calculate_compat_instance_id(const char *idstr
)
1369 int instance_id
= 0;
1371 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1375 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1376 && instance_id
<= se
->compat
->instance_id
) {
1377 instance_id
= se
->compat
->instance_id
+ 1;
1383 /* TODO: Individual devices generally have very little idea about the rest
1384 of the system, so instance_id should be removed/replaced.
1385 Meanwhile pass -1 as instance_id if you do not already have a clearly
1386 distinguishing id for all instances of your device class. */
1387 int register_savevm_live(DeviceState
*dev
,
1391 SaveVMHandlers
*ops
,
1396 se
= g_malloc0(sizeof(SaveStateEntry
));
1397 se
->version_id
= version_id
;
1398 se
->section_id
= global_section_id
++;
1400 se
->opaque
= opaque
;
1403 /* if this is a live_savem then set is_ram */
1404 if (ops
->save_live_setup
!= NULL
) {
1409 char *id
= qdev_get_dev_path(dev
);
1411 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1412 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1415 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1416 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1417 se
->compat
->instance_id
= instance_id
== -1 ?
1418 calculate_compat_instance_id(idstr
) : instance_id
;
1422 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1424 if (instance_id
== -1) {
1425 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1427 se
->instance_id
= instance_id
;
1429 assert(!se
->compat
|| se
->instance_id
== 0);
1430 /* add at the end of list */
1431 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1435 int register_savevm(DeviceState
*dev
,
1439 SaveStateHandler
*save_state
,
1440 LoadStateHandler
*load_state
,
1443 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1444 ops
->save_state
= save_state
;
1445 ops
->load_state
= load_state
;
1446 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1450 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1452 SaveStateEntry
*se
, *new_se
;
1456 char *path
= qdev_get_dev_path(dev
);
1458 pstrcpy(id
, sizeof(id
), path
);
1459 pstrcat(id
, sizeof(id
), "/");
1463 pstrcat(id
, sizeof(id
), idstr
);
1465 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1466 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1467 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1477 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1478 const VMStateDescription
*vmsd
,
1479 void *opaque
, int alias_id
,
1480 int required_for_version
)
1484 /* If this triggers, alias support can be dropped for the vmsd. */
1485 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1487 se
= g_malloc0(sizeof(SaveStateEntry
));
1488 se
->version_id
= vmsd
->version_id
;
1489 se
->section_id
= global_section_id
++;
1490 se
->opaque
= opaque
;
1492 se
->alias_id
= alias_id
;
1493 se
->no_migrate
= vmsd
->unmigratable
;
1496 char *id
= qdev_get_dev_path(dev
);
1498 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1499 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1502 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1503 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1504 se
->compat
->instance_id
= instance_id
== -1 ?
1505 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1509 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1511 if (instance_id
== -1) {
1512 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1514 se
->instance_id
= instance_id
;
1516 assert(!se
->compat
|| se
->instance_id
== 0);
1517 /* add at the end of list */
1518 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1522 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1525 SaveStateEntry
*se
, *new_se
;
1527 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1528 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1529 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1538 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1540 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1543 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1544 void *opaque
, int version_id
)
1546 VMStateField
*field
= vmsd
->fields
;
1549 if (version_id
> vmsd
->version_id
) {
1552 if (version_id
< vmsd
->minimum_version_id_old
) {
1555 if (version_id
< vmsd
->minimum_version_id
) {
1556 return vmsd
->load_state_old(f
, opaque
, version_id
);
1558 if (vmsd
->pre_load
) {
1559 int ret
= vmsd
->pre_load(opaque
);
1563 while(field
->name
) {
1564 if ((field
->field_exists
&&
1565 field
->field_exists(opaque
, version_id
)) ||
1566 (!field
->field_exists
&&
1567 field
->version_id
<= version_id
)) {
1568 void *base_addr
= opaque
+ field
->offset
;
1570 int size
= field
->size
;
1572 if (field
->flags
& VMS_VBUFFER
) {
1573 size
= *(int32_t *)(opaque
+field
->size_offset
);
1574 if (field
->flags
& VMS_MULTIPLY
) {
1575 size
*= field
->size
;
1578 if (field
->flags
& VMS_ARRAY
) {
1579 n_elems
= field
->num
;
1580 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1581 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1582 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1583 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1584 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1585 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1586 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1587 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1589 if (field
->flags
& VMS_POINTER
) {
1590 base_addr
= *(void **)base_addr
+ field
->start
;
1592 for (i
= 0; i
< n_elems
; i
++) {
1593 void *addr
= base_addr
+ size
* i
;
1595 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1596 addr
= *(void **)addr
;
1598 if (field
->flags
& VMS_STRUCT
) {
1599 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1601 ret
= field
->info
->get(f
, addr
, size
);
1611 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1615 if (vmsd
->post_load
) {
1616 return vmsd
->post_load(opaque
, version_id
);
1621 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1624 VMStateField
*field
= vmsd
->fields
;
1626 if (vmsd
->pre_save
) {
1627 vmsd
->pre_save(opaque
);
1629 while(field
->name
) {
1630 if (!field
->field_exists
||
1631 field
->field_exists(opaque
, vmsd
->version_id
)) {
1632 void *base_addr
= opaque
+ field
->offset
;
1634 int size
= field
->size
;
1636 if (field
->flags
& VMS_VBUFFER
) {
1637 size
= *(int32_t *)(opaque
+field
->size_offset
);
1638 if (field
->flags
& VMS_MULTIPLY
) {
1639 size
*= field
->size
;
1642 if (field
->flags
& VMS_ARRAY
) {
1643 n_elems
= field
->num
;
1644 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1645 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1646 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1647 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1648 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1649 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1650 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1651 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1653 if (field
->flags
& VMS_POINTER
) {
1654 base_addr
= *(void **)base_addr
+ field
->start
;
1656 for (i
= 0; i
< n_elems
; i
++) {
1657 void *addr
= base_addr
+ size
* i
;
1659 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1660 addr
= *(void **)addr
;
1662 if (field
->flags
& VMS_STRUCT
) {
1663 vmstate_save_state(f
, field
->vmsd
, addr
);
1665 field
->info
->put(f
, addr
, size
);
1671 vmstate_subsection_save(f
, vmsd
, opaque
);
1674 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1676 if (!se
->vmsd
) { /* Old style */
1677 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1679 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1682 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1684 if (!se
->vmsd
) { /* Old style */
1685 se
->ops
->save_state(f
, se
->opaque
);
1688 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1691 #define QEMU_VM_FILE_MAGIC 0x5145564d
1692 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1693 #define QEMU_VM_FILE_VERSION 0x00000003
1695 #define QEMU_VM_EOF 0x00
1696 #define QEMU_VM_SECTION_START 0x01
1697 #define QEMU_VM_SECTION_PART 0x02
1698 #define QEMU_VM_SECTION_END 0x03
1699 #define QEMU_VM_SECTION_FULL 0x04
1700 #define QEMU_VM_SUBSECTION 0x05
1702 bool qemu_savevm_state_blocked(Error
**errp
)
1706 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1707 if (se
->no_migrate
) {
1708 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1715 void qemu_savevm_state_begin(QEMUFile
*f
,
1716 const MigrationParams
*params
)
1721 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1722 if (!se
->ops
|| !se
->ops
->set_params
) {
1725 se
->ops
->set_params(params
, se
->opaque
);
1728 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1729 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1731 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1734 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1737 if (se
->ops
&& se
->ops
->is_active
) {
1738 if (!se
->ops
->is_active(se
->opaque
)) {
1743 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1744 qemu_put_be32(f
, se
->section_id
);
1747 len
= strlen(se
->idstr
);
1748 qemu_put_byte(f
, len
);
1749 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1751 qemu_put_be32(f
, se
->instance_id
);
1752 qemu_put_be32(f
, se
->version_id
);
1754 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1756 qemu_file_set_error(f
, ret
);
1763 * this function has three return values:
1764 * negative: there was one error, and we have -errno.
1765 * 0 : We haven't finished, caller have to go again
1766 * 1 : We have finished, we can go to complete phase
1768 int qemu_savevm_state_iterate(QEMUFile
*f
)
1773 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1774 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1777 if (se
->ops
&& se
->ops
->is_active
) {
1778 if (!se
->ops
->is_active(se
->opaque
)) {
1782 if (qemu_file_rate_limit(f
)) {
1785 trace_savevm_section_start();
1787 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1788 qemu_put_be32(f
, se
->section_id
);
1790 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1791 trace_savevm_section_end(se
->section_id
);
1794 qemu_file_set_error(f
, ret
);
1797 /* Do not proceed to the next vmstate before this one reported
1798 completion of the current stage. This serializes the migration
1799 and reduces the probability that a faster changing state is
1800 synchronized over and over again. */
1807 void qemu_savevm_state_complete(QEMUFile
*f
)
1812 cpu_synchronize_all_states();
1814 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1815 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1818 if (se
->ops
&& se
->ops
->is_active
) {
1819 if (!se
->ops
->is_active(se
->opaque
)) {
1823 trace_savevm_section_start();
1825 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1826 qemu_put_be32(f
, se
->section_id
);
1828 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1829 trace_savevm_section_end(se
->section_id
);
1831 qemu_file_set_error(f
, ret
);
1836 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1839 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1842 trace_savevm_section_start();
1844 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1845 qemu_put_be32(f
, se
->section_id
);
1848 len
= strlen(se
->idstr
);
1849 qemu_put_byte(f
, len
);
1850 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1852 qemu_put_be32(f
, se
->instance_id
);
1853 qemu_put_be32(f
, se
->version_id
);
1855 vmstate_save(f
, se
);
1856 trace_savevm_section_end(se
->section_id
);
1859 qemu_put_byte(f
, QEMU_VM_EOF
);
1863 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
1868 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1869 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
1872 if (se
->ops
&& se
->ops
->is_active
) {
1873 if (!se
->ops
->is_active(se
->opaque
)) {
1877 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
1882 void qemu_savevm_state_cancel(void)
1886 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1887 if (se
->ops
&& se
->ops
->cancel
) {
1888 se
->ops
->cancel(se
->opaque
);
1893 static int qemu_savevm_state(QEMUFile
*f
)
1896 MigrationParams params
= {
1901 if (qemu_savevm_state_blocked(NULL
)) {
1905 qemu_mutex_unlock_iothread();
1906 qemu_savevm_state_begin(f
, ¶ms
);
1907 qemu_mutex_lock_iothread();
1909 while (qemu_file_get_error(f
) == 0) {
1910 if (qemu_savevm_state_iterate(f
) > 0) {
1915 ret
= qemu_file_get_error(f
);
1917 qemu_savevm_state_complete(f
);
1918 ret
= qemu_file_get_error(f
);
1921 qemu_savevm_state_cancel();
1926 static int qemu_save_device_state(QEMUFile
*f
)
1930 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1931 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1933 cpu_synchronize_all_states();
1935 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1941 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1946 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1947 qemu_put_be32(f
, se
->section_id
);
1950 len
= strlen(se
->idstr
);
1951 qemu_put_byte(f
, len
);
1952 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1954 qemu_put_be32(f
, se
->instance_id
);
1955 qemu_put_be32(f
, se
->version_id
);
1957 vmstate_save(f
, se
);
1960 qemu_put_byte(f
, QEMU_VM_EOF
);
1962 return qemu_file_get_error(f
);
1965 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
1969 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1970 if (!strcmp(se
->idstr
, idstr
) &&
1971 (instance_id
== se
->instance_id
||
1972 instance_id
== se
->alias_id
))
1974 /* Migrating from an older version? */
1975 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
1976 if (!strcmp(se
->compat
->idstr
, idstr
) &&
1977 (instance_id
== se
->compat
->instance_id
||
1978 instance_id
== se
->alias_id
))
1985 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
1987 while(sub
&& sub
->needed
) {
1988 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
1996 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1999 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
2002 uint8_t version_id
, len
, size
;
2003 const VMStateDescription
*sub_vmsd
;
2005 len
= qemu_peek_byte(f
, 1);
2006 if (len
< strlen(vmsd
->name
) + 1) {
2007 /* subsection name has be be "section_name/a" */
2010 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
2016 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
2017 /* it don't have a valid subsection name */
2020 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
2021 if (sub_vmsd
== NULL
) {
2024 qemu_file_skip(f
, 1); /* subsection */
2025 qemu_file_skip(f
, 1); /* len */
2026 qemu_file_skip(f
, len
); /* idstr */
2027 version_id
= qemu_get_be32(f
);
2029 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
2037 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2040 const VMStateSubsection
*sub
= vmsd
->subsections
;
2042 while (sub
&& sub
->needed
) {
2043 if (sub
->needed(opaque
)) {
2044 const VMStateDescription
*vmsd
= sub
->vmsd
;
2047 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
2048 len
= strlen(vmsd
->name
);
2049 qemu_put_byte(f
, len
);
2050 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
2051 qemu_put_be32(f
, vmsd
->version_id
);
2052 vmstate_save_state(f
, vmsd
, opaque
);
2058 typedef struct LoadStateEntry
{
2059 QLIST_ENTRY(LoadStateEntry
) entry
;
2065 int qemu_loadvm_state(QEMUFile
*f
)
2067 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
2068 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
2069 LoadStateEntry
*le
, *new_le
;
2070 uint8_t section_type
;
2074 if (qemu_savevm_state_blocked(NULL
)) {
2078 v
= qemu_get_be32(f
);
2079 if (v
!= QEMU_VM_FILE_MAGIC
)
2082 v
= qemu_get_be32(f
);
2083 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
2084 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
2087 if (v
!= QEMU_VM_FILE_VERSION
)
2090 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
2091 uint32_t instance_id
, version_id
, section_id
;
2096 switch (section_type
) {
2097 case QEMU_VM_SECTION_START
:
2098 case QEMU_VM_SECTION_FULL
:
2099 /* Read section start */
2100 section_id
= qemu_get_be32(f
);
2101 len
= qemu_get_byte(f
);
2102 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
2104 instance_id
= qemu_get_be32(f
);
2105 version_id
= qemu_get_be32(f
);
2107 /* Find savevm section */
2108 se
= find_se(idstr
, instance_id
);
2110 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
2115 /* Validate version */
2116 if (version_id
> se
->version_id
) {
2117 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2118 version_id
, idstr
, se
->version_id
);
2124 le
= g_malloc0(sizeof(*le
));
2127 le
->section_id
= section_id
;
2128 le
->version_id
= version_id
;
2129 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2131 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2133 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2134 instance_id
, idstr
);
2138 case QEMU_VM_SECTION_PART
:
2139 case QEMU_VM_SECTION_END
:
2140 section_id
= qemu_get_be32(f
);
2142 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2143 if (le
->section_id
== section_id
) {
2148 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2153 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2155 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2161 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2167 cpu_synchronize_all_post_init();
2172 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2173 QLIST_REMOVE(le
, entry
);
2178 ret
= qemu_file_get_error(f
);
2184 static int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
2187 QEMUSnapshotInfo
*sn_tab
, *sn
;
2191 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2194 for(i
= 0; i
< nb_sns
; i
++) {
2196 if (!strcmp(sn
->id_str
, name
) || !strcmp(sn
->name
, name
)) {
2207 * Deletes snapshots of a given name in all opened images.
2209 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2211 BlockDriverState
*bs
;
2212 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2216 while ((bs
= bdrv_next(bs
))) {
2217 if (bdrv_can_snapshot(bs
) &&
2218 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2220 ret
= bdrv_snapshot_delete(bs
, name
);
2223 "Error while deleting snapshot on '%s'\n",
2224 bdrv_get_device_name(bs
));
2233 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2235 BlockDriverState
*bs
, *bs1
;
2236 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2239 int saved_vm_running
;
2240 uint64_t vm_state_size
;
2243 const char *name
= qdict_get_try_str(qdict
, "name");
2245 /* Verify if there is a device that doesn't support snapshots and is writable */
2247 while ((bs
= bdrv_next(bs
))) {
2249 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2253 if (!bdrv_can_snapshot(bs
)) {
2254 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2255 bdrv_get_device_name(bs
));
2260 bs
= bdrv_snapshots();
2262 monitor_printf(mon
, "No block device can accept snapshots\n");
2266 saved_vm_running
= runstate_is_running();
2267 vm_stop(RUN_STATE_SAVE_VM
);
2269 memset(sn
, 0, sizeof(*sn
));
2271 /* fill auxiliary fields */
2272 qemu_gettimeofday(&tv
);
2273 sn
->date_sec
= tv
.tv_sec
;
2274 sn
->date_nsec
= tv
.tv_usec
* 1000;
2275 sn
->vm_clock_nsec
= qemu_get_clock_ns(vm_clock
);
2278 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2280 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2281 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2283 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2286 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2287 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2288 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2291 /* Delete old snapshots of the same name */
2292 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2296 /* save the VM state */
2297 f
= qemu_fopen_bdrv(bs
, 1);
2299 monitor_printf(mon
, "Could not open VM state file\n");
2302 ret
= qemu_savevm_state(f
);
2303 vm_state_size
= qemu_ftell(f
);
2306 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2310 /* create the snapshots */
2313 while ((bs1
= bdrv_next(bs1
))) {
2314 if (bdrv_can_snapshot(bs1
)) {
2315 /* Write VM state size only to the image that contains the state */
2316 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2317 ret
= bdrv_snapshot_create(bs1
, sn
);
2319 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2320 bdrv_get_device_name(bs1
));
2326 if (saved_vm_running
)
2330 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2333 int saved_vm_running
;
2336 saved_vm_running
= runstate_is_running();
2337 vm_stop(RUN_STATE_SAVE_VM
);
2339 f
= qemu_fopen(filename
, "wb");
2341 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
2344 ret
= qemu_save_device_state(f
);
2347 error_set(errp
, QERR_IO_ERROR
);
2351 if (saved_vm_running
)
2355 int load_vmstate(const char *name
)
2357 BlockDriverState
*bs
, *bs_vm_state
;
2358 QEMUSnapshotInfo sn
;
2362 bs_vm_state
= bdrv_snapshots();
2364 error_report("No block device supports snapshots");
2368 /* Don't even try to load empty VM states */
2369 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2372 } else if (sn
.vm_state_size
== 0) {
2373 error_report("This is a disk-only snapshot. Revert to it offline "
2378 /* Verify if there is any device that doesn't support snapshots and is
2379 writable and check if the requested snapshot is available too. */
2381 while ((bs
= bdrv_next(bs
))) {
2383 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2387 if (!bdrv_can_snapshot(bs
)) {
2388 error_report("Device '%s' is writable but does not support snapshots.",
2389 bdrv_get_device_name(bs
));
2393 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2395 error_report("Device '%s' does not have the requested snapshot '%s'",
2396 bdrv_get_device_name(bs
), name
);
2401 /* Flush all IO requests so they don't interfere with the new state. */
2405 while ((bs
= bdrv_next(bs
))) {
2406 if (bdrv_can_snapshot(bs
)) {
2407 ret
= bdrv_snapshot_goto(bs
, name
);
2409 error_report("Error %d while activating snapshot '%s' on '%s'",
2410 ret
, name
, bdrv_get_device_name(bs
));
2416 /* restore the VM state */
2417 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2419 error_report("Could not open VM state file");
2423 qemu_system_reset(VMRESET_SILENT
);
2424 ret
= qemu_loadvm_state(f
);
2428 error_report("Error %d while loading VM state", ret
);
2435 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2437 BlockDriverState
*bs
, *bs1
;
2439 const char *name
= qdict_get_str(qdict
, "name");
2441 bs
= bdrv_snapshots();
2443 monitor_printf(mon
, "No block device supports snapshots\n");
2448 while ((bs1
= bdrv_next(bs1
))) {
2449 if (bdrv_can_snapshot(bs1
)) {
2450 ret
= bdrv_snapshot_delete(bs1
, name
);
2452 if (ret
== -ENOTSUP
)
2454 "Snapshots not supported on device '%s'\n",
2455 bdrv_get_device_name(bs1
));
2457 monitor_printf(mon
, "Error %d while deleting snapshot on "
2458 "'%s'\n", ret
, bdrv_get_device_name(bs1
));
2464 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2466 BlockDriverState
*bs
, *bs1
;
2467 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2468 int nb_sns
, i
, ret
, available
;
2470 int *available_snapshots
;
2473 bs
= bdrv_snapshots();
2475 monitor_printf(mon
, "No available block device supports snapshots\n");
2479 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2481 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2486 monitor_printf(mon
, "There is no snapshot available.\n");
2490 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2492 for (i
= 0; i
< nb_sns
; i
++) {
2497 while ((bs1
= bdrv_next(bs1
))) {
2498 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2499 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2508 available_snapshots
[total
] = i
;
2514 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
2515 for (i
= 0; i
< total
; i
++) {
2516 sn
= &sn_tab
[available_snapshots
[i
]];
2517 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
2520 monitor_printf(mon
, "There is no suitable snapshot available\n");
2524 g_free(available_snapshots
);
2528 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2530 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2531 memory_region_name(mr
), dev
);
2534 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2536 /* Nothing do to while the implementation is in RAMBlock */
2539 void vmstate_register_ram_global(MemoryRegion
*mr
)
2541 vmstate_register_ram(mr
, NULL
);