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 qemu_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 if (f
->buf_index
>= IO_BUF_SIZE
|| f
->iovcnt
>= MAX_IOV_SIZE
) {
641 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, int size
)
647 if (f
->is_write
== 0 && f
->buf_index
> 0) {
649 "Attempted to write to buffer while read buffer is not empty\n");
653 f
->bytes_xfer
+= size
;
654 add_to_iovec(f
, buf
, size
);
657 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
665 if (f
->is_write
== 0 && f
->buf_index
> 0) {
667 "Attempted to write to buffer while read buffer is not empty\n");
672 l
= IO_BUF_SIZE
- f
->buf_index
;
675 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
677 qemu_put_buffer_async(f
, f
->buf
+ (f
->buf_index
- l
), l
);
678 if (qemu_file_get_error(f
)) {
686 void qemu_put_byte(QEMUFile
*f
, int v
)
692 if (f
->is_write
== 0 && f
->buf_index
> 0) {
694 "Attempted to write to buffer while read buffer is not empty\n");
698 f
->buf
[f
->buf_index
] = v
;
700 add_to_iovec(f
, f
->buf
+ f
->buf_index
, 1);
704 static void qemu_file_skip(QEMUFile
*f
, int size
)
706 if (f
->buf_index
+ size
<= f
->buf_size
) {
707 f
->buf_index
+= size
;
711 static int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
720 index
= f
->buf_index
+ offset
;
721 pending
= f
->buf_size
- index
;
722 if (pending
< size
) {
724 index
= f
->buf_index
+ offset
;
725 pending
= f
->buf_size
- index
;
731 if (size
> pending
) {
735 memcpy(buf
, f
->buf
+ index
, size
);
739 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
744 while (pending
> 0) {
747 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
751 qemu_file_skip(f
, res
);
759 static int qemu_peek_byte(QEMUFile
*f
, int offset
)
761 int index
= f
->buf_index
+ offset
;
767 if (index
>= f
->buf_size
) {
769 index
= f
->buf_index
+ offset
;
770 if (index
>= f
->buf_size
) {
774 return f
->buf
[index
];
777 int qemu_get_byte(QEMUFile
*f
)
781 result
= qemu_peek_byte(f
, 0);
782 qemu_file_skip(f
, 1);
786 int64_t qemu_ftell(QEMUFile
*f
)
792 int qemu_file_rate_limit(QEMUFile
*f
)
794 if (qemu_file_get_error(f
)) {
797 if (f
->xfer_limit
> 0 && f
->bytes_xfer
> f
->xfer_limit
) {
803 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
805 return f
->xfer_limit
;
808 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t limit
)
810 f
->xfer_limit
= limit
;
813 void qemu_file_reset_rate_limit(QEMUFile
*f
)
818 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
820 qemu_put_byte(f
, v
>> 8);
824 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
826 qemu_put_byte(f
, v
>> 24);
827 qemu_put_byte(f
, v
>> 16);
828 qemu_put_byte(f
, v
>> 8);
832 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
834 qemu_put_be32(f
, v
>> 32);
838 unsigned int qemu_get_be16(QEMUFile
*f
)
841 v
= qemu_get_byte(f
) << 8;
842 v
|= qemu_get_byte(f
);
846 unsigned int qemu_get_be32(QEMUFile
*f
)
849 v
= qemu_get_byte(f
) << 24;
850 v
|= qemu_get_byte(f
) << 16;
851 v
|= qemu_get_byte(f
) << 8;
852 v
|= qemu_get_byte(f
);
856 uint64_t qemu_get_be64(QEMUFile
*f
)
859 v
= (uint64_t)qemu_get_be32(f
) << 32;
860 v
|= qemu_get_be32(f
);
867 void qemu_put_timer(QEMUFile
*f
, QEMUTimer
*ts
)
869 uint64_t expire_time
;
871 expire_time
= qemu_timer_expire_time_ns(ts
);
872 qemu_put_be64(f
, expire_time
);
875 void qemu_get_timer(QEMUFile
*f
, QEMUTimer
*ts
)
877 uint64_t expire_time
;
879 expire_time
= qemu_get_be64(f
);
880 if (expire_time
!= -1) {
881 qemu_mod_timer_ns(ts
, expire_time
);
890 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
893 *v
= qemu_get_byte(f
);
897 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
900 qemu_put_byte(f
, *v
);
903 const VMStateInfo vmstate_info_bool
= {
911 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
918 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
924 const VMStateInfo vmstate_info_int8
= {
932 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
935 qemu_get_sbe16s(f
, v
);
939 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
942 qemu_put_sbe16s(f
, v
);
945 const VMStateInfo vmstate_info_int16
= {
953 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
956 qemu_get_sbe32s(f
, v
);
960 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
963 qemu_put_sbe32s(f
, v
);
966 const VMStateInfo vmstate_info_int32
= {
972 /* 32 bit int. See that the received value is the same than the one
975 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
979 qemu_get_sbe32s(f
, &v2
);
986 const VMStateInfo vmstate_info_int32_equal
= {
987 .name
= "int32 equal",
988 .get
= get_int32_equal
,
992 /* 32 bit int. See that the received value is the less or the same
993 than the one in the field */
995 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
999 qemu_get_sbe32s(f
, &new);
1006 const VMStateInfo vmstate_info_int32_le
= {
1007 .name
= "int32 equal",
1008 .get
= get_int32_le
,
1014 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
1017 qemu_get_sbe64s(f
, v
);
1021 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
1024 qemu_put_sbe64s(f
, v
);
1027 const VMStateInfo vmstate_info_int64
= {
1033 /* 8 bit unsigned int */
1035 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1042 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1048 const VMStateInfo vmstate_info_uint8
= {
1054 /* 16 bit unsigned int */
1056 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1059 qemu_get_be16s(f
, v
);
1063 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1066 qemu_put_be16s(f
, v
);
1069 const VMStateInfo vmstate_info_uint16
= {
1075 /* 32 bit unsigned int */
1077 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1080 qemu_get_be32s(f
, v
);
1084 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1087 qemu_put_be32s(f
, v
);
1090 const VMStateInfo vmstate_info_uint32
= {
1096 /* 32 bit uint. See that the received value is the same than the one
1099 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1103 qemu_get_be32s(f
, &v2
);
1111 const VMStateInfo vmstate_info_uint32_equal
= {
1112 .name
= "uint32 equal",
1113 .get
= get_uint32_equal
,
1117 /* 64 bit unsigned int */
1119 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1122 qemu_get_be64s(f
, v
);
1126 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1129 qemu_put_be64s(f
, v
);
1132 const VMStateInfo vmstate_info_uint64
= {
1138 /* 64 bit unsigned int. See that the received value is the same than the one
1141 static int get_uint64_equal(QEMUFile
*f
, void *pv
, size_t size
)
1145 qemu_get_be64s(f
, &v2
);
1153 const VMStateInfo vmstate_info_uint64_equal
= {
1154 .name
= "int64 equal",
1155 .get
= get_uint64_equal
,
1159 /* 8 bit int. See that the received value is the same than the one
1162 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1166 qemu_get_8s(f
, &v2
);
1173 const VMStateInfo vmstate_info_uint8_equal
= {
1174 .name
= "uint8 equal",
1175 .get
= get_uint8_equal
,
1179 /* 16 bit unsigned int int. See that the received value is the same than the one
1182 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1186 qemu_get_be16s(f
, &v2
);
1193 const VMStateInfo vmstate_info_uint16_equal
= {
1194 .name
= "uint16 equal",
1195 .get
= get_uint16_equal
,
1199 /* floating point */
1201 static int get_float64(QEMUFile
*f
, void *pv
, size_t size
)
1205 *v
= make_float64(qemu_get_be64(f
));
1209 static void put_float64(QEMUFile
*f
, void *pv
, size_t size
)
1213 qemu_put_be64(f
, float64_val(*v
));
1216 const VMStateInfo vmstate_info_float64
= {
1224 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1227 qemu_get_timer(f
, v
);
1231 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1234 qemu_put_timer(f
, v
);
1237 const VMStateInfo vmstate_info_timer
= {
1243 /* uint8_t buffers */
1245 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1248 qemu_get_buffer(f
, v
, size
);
1252 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1255 qemu_put_buffer(f
, v
, size
);
1258 const VMStateInfo vmstate_info_buffer
= {
1264 /* unused buffers: space that was used for some fields that are
1265 not useful anymore */
1267 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1273 block_len
= MIN(sizeof(buf
), size
);
1275 qemu_get_buffer(f
, buf
, block_len
);
1280 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1282 static const uint8_t buf
[1024];
1286 block_len
= MIN(sizeof(buf
), size
);
1288 qemu_put_buffer(f
, buf
, block_len
);
1292 const VMStateInfo vmstate_info_unused_buffer
= {
1293 .name
= "unused_buffer",
1294 .get
= get_unused_buffer
,
1295 .put
= put_unused_buffer
,
1298 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1299 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1300 * bit words with the bits in big endian order. The in-memory format
1301 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1303 /* This is the number of 64 bit words sent over the wire */
1304 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1305 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1307 unsigned long *bmp
= pv
;
1309 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1310 uint64_t w
= qemu_get_be64(f
);
1312 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1313 bmp
[idx
++] = w
>> 32;
1319 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1321 unsigned long *bmp
= pv
;
1323 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1324 uint64_t w
= bmp
[idx
++];
1325 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1326 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1328 qemu_put_be64(f
, w
);
1332 const VMStateInfo vmstate_info_bitmap
= {
1338 typedef struct CompatEntry
{
1343 typedef struct SaveStateEntry
{
1344 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1350 SaveVMHandlers
*ops
;
1351 const VMStateDescription
*vmsd
;
1353 CompatEntry
*compat
;
1359 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1360 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1361 static int global_section_id
;
1363 static int calculate_new_instance_id(const char *idstr
)
1366 int instance_id
= 0;
1368 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1369 if (strcmp(idstr
, se
->idstr
) == 0
1370 && instance_id
<= se
->instance_id
) {
1371 instance_id
= se
->instance_id
+ 1;
1377 static int calculate_compat_instance_id(const char *idstr
)
1380 int instance_id
= 0;
1382 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1386 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1387 && instance_id
<= se
->compat
->instance_id
) {
1388 instance_id
= se
->compat
->instance_id
+ 1;
1394 /* TODO: Individual devices generally have very little idea about the rest
1395 of the system, so instance_id should be removed/replaced.
1396 Meanwhile pass -1 as instance_id if you do not already have a clearly
1397 distinguishing id for all instances of your device class. */
1398 int register_savevm_live(DeviceState
*dev
,
1402 SaveVMHandlers
*ops
,
1407 se
= g_malloc0(sizeof(SaveStateEntry
));
1408 se
->version_id
= version_id
;
1409 se
->section_id
= global_section_id
++;
1411 se
->opaque
= opaque
;
1414 /* if this is a live_savem then set is_ram */
1415 if (ops
->save_live_setup
!= NULL
) {
1420 char *id
= qdev_get_dev_path(dev
);
1422 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1423 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1426 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1427 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1428 se
->compat
->instance_id
= instance_id
== -1 ?
1429 calculate_compat_instance_id(idstr
) : instance_id
;
1433 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1435 if (instance_id
== -1) {
1436 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1438 se
->instance_id
= instance_id
;
1440 assert(!se
->compat
|| se
->instance_id
== 0);
1441 /* add at the end of list */
1442 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1446 int register_savevm(DeviceState
*dev
,
1450 SaveStateHandler
*save_state
,
1451 LoadStateHandler
*load_state
,
1454 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1455 ops
->save_state
= save_state
;
1456 ops
->load_state
= load_state
;
1457 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1461 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1463 SaveStateEntry
*se
, *new_se
;
1467 char *path
= qdev_get_dev_path(dev
);
1469 pstrcpy(id
, sizeof(id
), path
);
1470 pstrcat(id
, sizeof(id
), "/");
1474 pstrcat(id
, sizeof(id
), idstr
);
1476 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1477 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1478 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1488 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1489 const VMStateDescription
*vmsd
,
1490 void *opaque
, int alias_id
,
1491 int required_for_version
)
1495 /* If this triggers, alias support can be dropped for the vmsd. */
1496 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1498 se
= g_malloc0(sizeof(SaveStateEntry
));
1499 se
->version_id
= vmsd
->version_id
;
1500 se
->section_id
= global_section_id
++;
1501 se
->opaque
= opaque
;
1503 se
->alias_id
= alias_id
;
1504 se
->no_migrate
= vmsd
->unmigratable
;
1507 char *id
= qdev_get_dev_path(dev
);
1509 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1510 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1513 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1514 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1515 se
->compat
->instance_id
= instance_id
== -1 ?
1516 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1520 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1522 if (instance_id
== -1) {
1523 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1525 se
->instance_id
= instance_id
;
1527 assert(!se
->compat
|| se
->instance_id
== 0);
1528 /* add at the end of list */
1529 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1533 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1536 SaveStateEntry
*se
, *new_se
;
1538 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1539 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1540 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1549 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1551 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1554 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1555 void *opaque
, int version_id
)
1557 VMStateField
*field
= vmsd
->fields
;
1560 if (version_id
> vmsd
->version_id
) {
1563 if (version_id
< vmsd
->minimum_version_id_old
) {
1566 if (version_id
< vmsd
->minimum_version_id
) {
1567 return vmsd
->load_state_old(f
, opaque
, version_id
);
1569 if (vmsd
->pre_load
) {
1570 int ret
= vmsd
->pre_load(opaque
);
1574 while(field
->name
) {
1575 if ((field
->field_exists
&&
1576 field
->field_exists(opaque
, version_id
)) ||
1577 (!field
->field_exists
&&
1578 field
->version_id
<= version_id
)) {
1579 void *base_addr
= opaque
+ field
->offset
;
1581 int size
= field
->size
;
1583 if (field
->flags
& VMS_VBUFFER
) {
1584 size
= *(int32_t *)(opaque
+field
->size_offset
);
1585 if (field
->flags
& VMS_MULTIPLY
) {
1586 size
*= field
->size
;
1589 if (field
->flags
& VMS_ARRAY
) {
1590 n_elems
= field
->num
;
1591 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1592 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1593 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1594 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1595 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1596 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1597 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1598 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1600 if (field
->flags
& VMS_POINTER
) {
1601 base_addr
= *(void **)base_addr
+ field
->start
;
1603 for (i
= 0; i
< n_elems
; i
++) {
1604 void *addr
= base_addr
+ size
* i
;
1606 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1607 addr
= *(void **)addr
;
1609 if (field
->flags
& VMS_STRUCT
) {
1610 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1612 ret
= field
->info
->get(f
, addr
, size
);
1622 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1626 if (vmsd
->post_load
) {
1627 return vmsd
->post_load(opaque
, version_id
);
1632 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1635 VMStateField
*field
= vmsd
->fields
;
1637 if (vmsd
->pre_save
) {
1638 vmsd
->pre_save(opaque
);
1640 while(field
->name
) {
1641 if (!field
->field_exists
||
1642 field
->field_exists(opaque
, vmsd
->version_id
)) {
1643 void *base_addr
= opaque
+ field
->offset
;
1645 int size
= field
->size
;
1647 if (field
->flags
& VMS_VBUFFER
) {
1648 size
= *(int32_t *)(opaque
+field
->size_offset
);
1649 if (field
->flags
& VMS_MULTIPLY
) {
1650 size
*= field
->size
;
1653 if (field
->flags
& VMS_ARRAY
) {
1654 n_elems
= field
->num
;
1655 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1656 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1657 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1658 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1659 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1660 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1661 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1662 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1664 if (field
->flags
& VMS_POINTER
) {
1665 base_addr
= *(void **)base_addr
+ field
->start
;
1667 for (i
= 0; i
< n_elems
; i
++) {
1668 void *addr
= base_addr
+ size
* i
;
1670 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1671 addr
= *(void **)addr
;
1673 if (field
->flags
& VMS_STRUCT
) {
1674 vmstate_save_state(f
, field
->vmsd
, addr
);
1676 field
->info
->put(f
, addr
, size
);
1682 vmstate_subsection_save(f
, vmsd
, opaque
);
1685 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1687 if (!se
->vmsd
) { /* Old style */
1688 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1690 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1693 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1695 if (!se
->vmsd
) { /* Old style */
1696 se
->ops
->save_state(f
, se
->opaque
);
1699 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1702 #define QEMU_VM_FILE_MAGIC 0x5145564d
1703 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1704 #define QEMU_VM_FILE_VERSION 0x00000003
1706 #define QEMU_VM_EOF 0x00
1707 #define QEMU_VM_SECTION_START 0x01
1708 #define QEMU_VM_SECTION_PART 0x02
1709 #define QEMU_VM_SECTION_END 0x03
1710 #define QEMU_VM_SECTION_FULL 0x04
1711 #define QEMU_VM_SUBSECTION 0x05
1713 bool qemu_savevm_state_blocked(Error
**errp
)
1717 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1718 if (se
->no_migrate
) {
1719 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1726 void qemu_savevm_state_begin(QEMUFile
*f
,
1727 const MigrationParams
*params
)
1732 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1733 if (!se
->ops
|| !se
->ops
->set_params
) {
1736 se
->ops
->set_params(params
, se
->opaque
);
1739 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1740 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1742 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1745 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1748 if (se
->ops
&& se
->ops
->is_active
) {
1749 if (!se
->ops
->is_active(se
->opaque
)) {
1754 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1755 qemu_put_be32(f
, se
->section_id
);
1758 len
= strlen(se
->idstr
);
1759 qemu_put_byte(f
, len
);
1760 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1762 qemu_put_be32(f
, se
->instance_id
);
1763 qemu_put_be32(f
, se
->version_id
);
1765 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1767 qemu_file_set_error(f
, ret
);
1774 * this function has three return values:
1775 * negative: there was one error, and we have -errno.
1776 * 0 : We haven't finished, caller have to go again
1777 * 1 : We have finished, we can go to complete phase
1779 int qemu_savevm_state_iterate(QEMUFile
*f
)
1784 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1785 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1788 if (se
->ops
&& se
->ops
->is_active
) {
1789 if (!se
->ops
->is_active(se
->opaque
)) {
1793 if (qemu_file_rate_limit(f
)) {
1796 trace_savevm_section_start();
1798 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1799 qemu_put_be32(f
, se
->section_id
);
1801 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1802 trace_savevm_section_end(se
->section_id
);
1805 qemu_file_set_error(f
, ret
);
1808 /* Do not proceed to the next vmstate before this one reported
1809 completion of the current stage. This serializes the migration
1810 and reduces the probability that a faster changing state is
1811 synchronized over and over again. */
1818 void qemu_savevm_state_complete(QEMUFile
*f
)
1823 cpu_synchronize_all_states();
1825 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1826 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1829 if (se
->ops
&& se
->ops
->is_active
) {
1830 if (!se
->ops
->is_active(se
->opaque
)) {
1834 trace_savevm_section_start();
1836 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1837 qemu_put_be32(f
, se
->section_id
);
1839 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1840 trace_savevm_section_end(se
->section_id
);
1842 qemu_file_set_error(f
, ret
);
1847 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1850 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1853 trace_savevm_section_start();
1855 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1856 qemu_put_be32(f
, se
->section_id
);
1859 len
= strlen(se
->idstr
);
1860 qemu_put_byte(f
, len
);
1861 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1863 qemu_put_be32(f
, se
->instance_id
);
1864 qemu_put_be32(f
, se
->version_id
);
1866 vmstate_save(f
, se
);
1867 trace_savevm_section_end(se
->section_id
);
1870 qemu_put_byte(f
, QEMU_VM_EOF
);
1874 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
1879 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1880 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
1883 if (se
->ops
&& se
->ops
->is_active
) {
1884 if (!se
->ops
->is_active(se
->opaque
)) {
1888 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
1893 void qemu_savevm_state_cancel(void)
1897 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1898 if (se
->ops
&& se
->ops
->cancel
) {
1899 se
->ops
->cancel(se
->opaque
);
1904 static int qemu_savevm_state(QEMUFile
*f
)
1907 MigrationParams params
= {
1912 if (qemu_savevm_state_blocked(NULL
)) {
1916 qemu_mutex_unlock_iothread();
1917 qemu_savevm_state_begin(f
, ¶ms
);
1918 qemu_mutex_lock_iothread();
1920 while (qemu_file_get_error(f
) == 0) {
1921 if (qemu_savevm_state_iterate(f
) > 0) {
1926 ret
= qemu_file_get_error(f
);
1928 qemu_savevm_state_complete(f
);
1929 ret
= qemu_file_get_error(f
);
1932 qemu_savevm_state_cancel();
1937 static int qemu_save_device_state(QEMUFile
*f
)
1941 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1942 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1944 cpu_synchronize_all_states();
1946 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1952 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1957 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1958 qemu_put_be32(f
, se
->section_id
);
1961 len
= strlen(se
->idstr
);
1962 qemu_put_byte(f
, len
);
1963 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1965 qemu_put_be32(f
, se
->instance_id
);
1966 qemu_put_be32(f
, se
->version_id
);
1968 vmstate_save(f
, se
);
1971 qemu_put_byte(f
, QEMU_VM_EOF
);
1973 return qemu_file_get_error(f
);
1976 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
1980 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1981 if (!strcmp(se
->idstr
, idstr
) &&
1982 (instance_id
== se
->instance_id
||
1983 instance_id
== se
->alias_id
))
1985 /* Migrating from an older version? */
1986 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
1987 if (!strcmp(se
->compat
->idstr
, idstr
) &&
1988 (instance_id
== se
->compat
->instance_id
||
1989 instance_id
== se
->alias_id
))
1996 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
1998 while(sub
&& sub
->needed
) {
1999 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
2007 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2010 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
2013 uint8_t version_id
, len
, size
;
2014 const VMStateDescription
*sub_vmsd
;
2016 len
= qemu_peek_byte(f
, 1);
2017 if (len
< strlen(vmsd
->name
) + 1) {
2018 /* subsection name has be be "section_name/a" */
2021 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
2027 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
2028 /* it don't have a valid subsection name */
2031 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
2032 if (sub_vmsd
== NULL
) {
2035 qemu_file_skip(f
, 1); /* subsection */
2036 qemu_file_skip(f
, 1); /* len */
2037 qemu_file_skip(f
, len
); /* idstr */
2038 version_id
= qemu_get_be32(f
);
2040 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
2048 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2051 const VMStateSubsection
*sub
= vmsd
->subsections
;
2053 while (sub
&& sub
->needed
) {
2054 if (sub
->needed(opaque
)) {
2055 const VMStateDescription
*vmsd
= sub
->vmsd
;
2058 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
2059 len
= strlen(vmsd
->name
);
2060 qemu_put_byte(f
, len
);
2061 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
2062 qemu_put_be32(f
, vmsd
->version_id
);
2063 vmstate_save_state(f
, vmsd
, opaque
);
2069 typedef struct LoadStateEntry
{
2070 QLIST_ENTRY(LoadStateEntry
) entry
;
2076 int qemu_loadvm_state(QEMUFile
*f
)
2078 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
2079 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
2080 LoadStateEntry
*le
, *new_le
;
2081 uint8_t section_type
;
2085 if (qemu_savevm_state_blocked(NULL
)) {
2089 v
= qemu_get_be32(f
);
2090 if (v
!= QEMU_VM_FILE_MAGIC
)
2093 v
= qemu_get_be32(f
);
2094 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
2095 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
2098 if (v
!= QEMU_VM_FILE_VERSION
)
2101 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
2102 uint32_t instance_id
, version_id
, section_id
;
2107 switch (section_type
) {
2108 case QEMU_VM_SECTION_START
:
2109 case QEMU_VM_SECTION_FULL
:
2110 /* Read section start */
2111 section_id
= qemu_get_be32(f
);
2112 len
= qemu_get_byte(f
);
2113 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
2115 instance_id
= qemu_get_be32(f
);
2116 version_id
= qemu_get_be32(f
);
2118 /* Find savevm section */
2119 se
= find_se(idstr
, instance_id
);
2121 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
2126 /* Validate version */
2127 if (version_id
> se
->version_id
) {
2128 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2129 version_id
, idstr
, se
->version_id
);
2135 le
= g_malloc0(sizeof(*le
));
2138 le
->section_id
= section_id
;
2139 le
->version_id
= version_id
;
2140 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2142 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2144 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2145 instance_id
, idstr
);
2149 case QEMU_VM_SECTION_PART
:
2150 case QEMU_VM_SECTION_END
:
2151 section_id
= qemu_get_be32(f
);
2153 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2154 if (le
->section_id
== section_id
) {
2159 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2164 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2166 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2172 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2178 cpu_synchronize_all_post_init();
2183 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2184 QLIST_REMOVE(le
, entry
);
2189 ret
= qemu_file_get_error(f
);
2195 static int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
2198 QEMUSnapshotInfo
*sn_tab
, *sn
;
2202 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2205 for(i
= 0; i
< nb_sns
; i
++) {
2207 if (!strcmp(sn
->id_str
, name
) || !strcmp(sn
->name
, name
)) {
2218 * Deletes snapshots of a given name in all opened images.
2220 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2222 BlockDriverState
*bs
;
2223 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2227 while ((bs
= bdrv_next(bs
))) {
2228 if (bdrv_can_snapshot(bs
) &&
2229 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2231 ret
= bdrv_snapshot_delete(bs
, name
);
2234 "Error while deleting snapshot on '%s'\n",
2235 bdrv_get_device_name(bs
));
2244 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2246 BlockDriverState
*bs
, *bs1
;
2247 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2250 int saved_vm_running
;
2251 uint64_t vm_state_size
;
2254 const char *name
= qdict_get_try_str(qdict
, "name");
2256 /* Verify if there is a device that doesn't support snapshots and is writable */
2258 while ((bs
= bdrv_next(bs
))) {
2260 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2264 if (!bdrv_can_snapshot(bs
)) {
2265 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2266 bdrv_get_device_name(bs
));
2271 bs
= bdrv_snapshots();
2273 monitor_printf(mon
, "No block device can accept snapshots\n");
2277 saved_vm_running
= runstate_is_running();
2278 vm_stop(RUN_STATE_SAVE_VM
);
2280 memset(sn
, 0, sizeof(*sn
));
2282 /* fill auxiliary fields */
2283 qemu_gettimeofday(&tv
);
2284 sn
->date_sec
= tv
.tv_sec
;
2285 sn
->date_nsec
= tv
.tv_usec
* 1000;
2286 sn
->vm_clock_nsec
= qemu_get_clock_ns(vm_clock
);
2289 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2291 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2292 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2294 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2297 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2298 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2299 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2302 /* Delete old snapshots of the same name */
2303 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2307 /* save the VM state */
2308 f
= qemu_fopen_bdrv(bs
, 1);
2310 monitor_printf(mon
, "Could not open VM state file\n");
2313 ret
= qemu_savevm_state(f
);
2314 vm_state_size
= qemu_ftell(f
);
2317 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2321 /* create the snapshots */
2324 while ((bs1
= bdrv_next(bs1
))) {
2325 if (bdrv_can_snapshot(bs1
)) {
2326 /* Write VM state size only to the image that contains the state */
2327 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2328 ret
= bdrv_snapshot_create(bs1
, sn
);
2330 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2331 bdrv_get_device_name(bs1
));
2337 if (saved_vm_running
)
2341 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2344 int saved_vm_running
;
2347 saved_vm_running
= runstate_is_running();
2348 vm_stop(RUN_STATE_SAVE_VM
);
2350 f
= qemu_fopen(filename
, "wb");
2352 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
2355 ret
= qemu_save_device_state(f
);
2358 error_set(errp
, QERR_IO_ERROR
);
2362 if (saved_vm_running
)
2366 int load_vmstate(const char *name
)
2368 BlockDriverState
*bs
, *bs_vm_state
;
2369 QEMUSnapshotInfo sn
;
2373 bs_vm_state
= bdrv_snapshots();
2375 error_report("No block device supports snapshots");
2379 /* Don't even try to load empty VM states */
2380 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2383 } else if (sn
.vm_state_size
== 0) {
2384 error_report("This is a disk-only snapshot. Revert to it offline "
2389 /* Verify if there is any device that doesn't support snapshots and is
2390 writable and check if the requested snapshot is available too. */
2392 while ((bs
= bdrv_next(bs
))) {
2394 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2398 if (!bdrv_can_snapshot(bs
)) {
2399 error_report("Device '%s' is writable but does not support snapshots.",
2400 bdrv_get_device_name(bs
));
2404 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2406 error_report("Device '%s' does not have the requested snapshot '%s'",
2407 bdrv_get_device_name(bs
), name
);
2412 /* Flush all IO requests so they don't interfere with the new state. */
2416 while ((bs
= bdrv_next(bs
))) {
2417 if (bdrv_can_snapshot(bs
)) {
2418 ret
= bdrv_snapshot_goto(bs
, name
);
2420 error_report("Error %d while activating snapshot '%s' on '%s'",
2421 ret
, name
, bdrv_get_device_name(bs
));
2427 /* restore the VM state */
2428 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2430 error_report("Could not open VM state file");
2434 qemu_system_reset(VMRESET_SILENT
);
2435 ret
= qemu_loadvm_state(f
);
2439 error_report("Error %d while loading VM state", ret
);
2446 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2448 BlockDriverState
*bs
, *bs1
;
2450 const char *name
= qdict_get_str(qdict
, "name");
2452 bs
= bdrv_snapshots();
2454 monitor_printf(mon
, "No block device supports snapshots\n");
2459 while ((bs1
= bdrv_next(bs1
))) {
2460 if (bdrv_can_snapshot(bs1
)) {
2461 ret
= bdrv_snapshot_delete(bs1
, name
);
2463 if (ret
== -ENOTSUP
)
2465 "Snapshots not supported on device '%s'\n",
2466 bdrv_get_device_name(bs1
));
2468 monitor_printf(mon
, "Error %d while deleting snapshot on "
2469 "'%s'\n", ret
, bdrv_get_device_name(bs1
));
2475 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2477 BlockDriverState
*bs
, *bs1
;
2478 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2479 int nb_sns
, i
, ret
, available
;
2481 int *available_snapshots
;
2484 bs
= bdrv_snapshots();
2486 monitor_printf(mon
, "No available block device supports snapshots\n");
2490 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2492 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2497 monitor_printf(mon
, "There is no snapshot available.\n");
2501 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2503 for (i
= 0; i
< nb_sns
; i
++) {
2508 while ((bs1
= bdrv_next(bs1
))) {
2509 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2510 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2519 available_snapshots
[total
] = i
;
2525 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
2526 for (i
= 0; i
< total
; i
++) {
2527 sn
= &sn_tab
[available_snapshots
[i
]];
2528 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
2531 monitor_printf(mon
, "There is no suitable snapshot available\n");
2535 g_free(available_snapshots
);
2539 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2541 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2542 memory_region_name(mr
), dev
);
2545 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2547 /* Nothing do to while the implementation is in RAMBlock */
2550 void vmstate_register_ram_global(MemoryRegion
*mr
)
2552 vmstate_register_ram(mr
, NULL
);