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
)
529 if (!f
->ops
->writev_buffer
&& !f
->ops
->put_buffer
) {
534 if (f
->ops
->writev_buffer
) {
536 ret
= f
->ops
->writev_buffer(f
->opaque
, f
->iov
, f
->iovcnt
);
539 if (f
->buf_index
> 0) {
540 ret
= f
->ops
->put_buffer(f
->opaque
, f
->buf
, f
->pos
, f
->buf_index
);
550 qemu_file_set_error(f
, ret
);
554 static void qemu_fill_buffer(QEMUFile
*f
)
559 if (!f
->ops
->get_buffer
)
565 pending
= f
->buf_size
- f
->buf_index
;
567 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
570 f
->buf_size
= pending
;
572 len
= f
->ops
->get_buffer(f
->opaque
, f
->buf
+ pending
, f
->pos
,
573 IO_BUF_SIZE
- pending
);
577 } else if (len
== 0) {
578 qemu_file_set_error(f
, -EIO
);
579 } else if (len
!= -EAGAIN
)
580 qemu_file_set_error(f
, len
);
583 int qemu_get_fd(QEMUFile
*f
)
585 if (f
->ops
->get_fd
) {
586 return f
->ops
->get_fd(f
->opaque
);
593 * Returns negative error value if any error happened on previous operations or
594 * while closing the file. Returns 0 or positive number on success.
596 * The meaning of return value on success depends on the specific backend
599 int qemu_fclose(QEMUFile
*f
)
603 ret
= qemu_file_get_error(f
);
606 int ret2
= f
->ops
->close(f
->opaque
);
611 /* If any error was spotted before closing, we should report it
612 * instead of the close() return value.
621 static void add_to_iovec(QEMUFile
*f
, const uint8_t *buf
, int size
)
623 /* check for adjacent buffer and coalesce them */
624 if (f
->iovcnt
> 0 && buf
== f
->iov
[f
->iovcnt
- 1].iov_base
+
625 f
->iov
[f
->iovcnt
- 1].iov_len
) {
626 f
->iov
[f
->iovcnt
- 1].iov_len
+= size
;
628 f
->iov
[f
->iovcnt
].iov_base
= (uint8_t *)buf
;
629 f
->iov
[f
->iovcnt
++].iov_len
= size
;
633 if (f
->buf_index
>= IO_BUF_SIZE
|| f
->iovcnt
>= MAX_IOV_SIZE
) {
638 void qemu_put_buffer_async(QEMUFile
*f
, const uint8_t *buf
, int size
)
640 if (!f
->ops
->writev_buffer
) {
641 qemu_put_buffer(f
, buf
, size
);
649 if (f
->is_write
== 0 && f
->buf_index
> 0) {
651 "Attempted to write to buffer while read buffer is not empty\n");
655 f
->bytes_xfer
+= size
;
656 add_to_iovec(f
, buf
, size
);
659 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
667 if (f
->is_write
== 0 && f
->buf_index
> 0) {
669 "Attempted to write to buffer while read buffer is not empty\n");
674 l
= IO_BUF_SIZE
- f
->buf_index
;
677 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
678 f
->bytes_xfer
+= size
;
679 if (f
->ops
->writev_buffer
) {
680 add_to_iovec(f
, f
->buf
+ f
->buf_index
, l
);
685 if (f
->buf_index
== IO_BUF_SIZE
) {
689 if (qemu_file_get_error(f
)) {
697 void qemu_put_byte(QEMUFile
*f
, int v
)
703 if (f
->is_write
== 0 && f
->buf_index
> 0) {
705 "Attempted to write to buffer while read buffer is not empty\n");
709 f
->buf
[f
->buf_index
] = v
;
711 if (f
->ops
->writev_buffer
) {
712 add_to_iovec(f
, f
->buf
+ f
->buf_index
, 1);
717 if (f
->buf_index
== IO_BUF_SIZE
) {
723 static void qemu_file_skip(QEMUFile
*f
, int size
)
725 if (f
->buf_index
+ size
<= f
->buf_size
) {
726 f
->buf_index
+= size
;
730 static int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
739 index
= f
->buf_index
+ offset
;
740 pending
= f
->buf_size
- index
;
741 if (pending
< size
) {
743 index
= f
->buf_index
+ offset
;
744 pending
= f
->buf_size
- index
;
750 if (size
> pending
) {
754 memcpy(buf
, f
->buf
+ index
, size
);
758 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
763 while (pending
> 0) {
766 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
770 qemu_file_skip(f
, res
);
778 static int qemu_peek_byte(QEMUFile
*f
, int offset
)
780 int index
= f
->buf_index
+ offset
;
786 if (index
>= f
->buf_size
) {
788 index
= f
->buf_index
+ offset
;
789 if (index
>= f
->buf_size
) {
793 return f
->buf
[index
];
796 int qemu_get_byte(QEMUFile
*f
)
800 result
= qemu_peek_byte(f
, 0);
801 qemu_file_skip(f
, 1);
805 int64_t qemu_ftell(QEMUFile
*f
)
811 int qemu_file_rate_limit(QEMUFile
*f
)
813 if (qemu_file_get_error(f
)) {
816 if (f
->xfer_limit
> 0 && f
->bytes_xfer
> f
->xfer_limit
) {
822 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
824 return f
->xfer_limit
;
827 void qemu_file_set_rate_limit(QEMUFile
*f
, int64_t limit
)
829 f
->xfer_limit
= limit
;
832 void qemu_file_reset_rate_limit(QEMUFile
*f
)
837 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
839 qemu_put_byte(f
, v
>> 8);
843 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
845 qemu_put_byte(f
, v
>> 24);
846 qemu_put_byte(f
, v
>> 16);
847 qemu_put_byte(f
, v
>> 8);
851 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
853 qemu_put_be32(f
, v
>> 32);
857 unsigned int qemu_get_be16(QEMUFile
*f
)
860 v
= qemu_get_byte(f
) << 8;
861 v
|= qemu_get_byte(f
);
865 unsigned int qemu_get_be32(QEMUFile
*f
)
868 v
= qemu_get_byte(f
) << 24;
869 v
|= qemu_get_byte(f
) << 16;
870 v
|= qemu_get_byte(f
) << 8;
871 v
|= qemu_get_byte(f
);
875 uint64_t qemu_get_be64(QEMUFile
*f
)
878 v
= (uint64_t)qemu_get_be32(f
) << 32;
879 v
|= qemu_get_be32(f
);
886 void qemu_put_timer(QEMUFile
*f
, QEMUTimer
*ts
)
888 uint64_t expire_time
;
890 expire_time
= qemu_timer_expire_time_ns(ts
);
891 qemu_put_be64(f
, expire_time
);
894 void qemu_get_timer(QEMUFile
*f
, QEMUTimer
*ts
)
896 uint64_t expire_time
;
898 expire_time
= qemu_get_be64(f
);
899 if (expire_time
!= -1) {
900 qemu_mod_timer_ns(ts
, expire_time
);
909 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
912 *v
= qemu_get_byte(f
);
916 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
919 qemu_put_byte(f
, *v
);
922 const VMStateInfo vmstate_info_bool
= {
930 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
937 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
943 const VMStateInfo vmstate_info_int8
= {
951 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
954 qemu_get_sbe16s(f
, v
);
958 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
961 qemu_put_sbe16s(f
, v
);
964 const VMStateInfo vmstate_info_int16
= {
972 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
975 qemu_get_sbe32s(f
, v
);
979 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
982 qemu_put_sbe32s(f
, v
);
985 const VMStateInfo vmstate_info_int32
= {
991 /* 32 bit int. See that the received value is the same than the one
994 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
998 qemu_get_sbe32s(f
, &v2
);
1005 const VMStateInfo vmstate_info_int32_equal
= {
1006 .name
= "int32 equal",
1007 .get
= get_int32_equal
,
1011 /* 32 bit int. See that the received value is the less or the same
1012 than the one in the field */
1014 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
1018 qemu_get_sbe32s(f
, &new);
1025 const VMStateInfo vmstate_info_int32_le
= {
1026 .name
= "int32 equal",
1027 .get
= get_int32_le
,
1033 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
1036 qemu_get_sbe64s(f
, v
);
1040 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
1043 qemu_put_sbe64s(f
, v
);
1046 const VMStateInfo vmstate_info_int64
= {
1052 /* 8 bit unsigned int */
1054 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1061 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
1067 const VMStateInfo vmstate_info_uint8
= {
1073 /* 16 bit unsigned int */
1075 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1078 qemu_get_be16s(f
, v
);
1082 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1085 qemu_put_be16s(f
, v
);
1088 const VMStateInfo vmstate_info_uint16
= {
1094 /* 32 bit unsigned int */
1096 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1099 qemu_get_be32s(f
, v
);
1103 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1106 qemu_put_be32s(f
, v
);
1109 const VMStateInfo vmstate_info_uint32
= {
1115 /* 32 bit uint. See that the received value is the same than the one
1118 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1122 qemu_get_be32s(f
, &v2
);
1130 const VMStateInfo vmstate_info_uint32_equal
= {
1131 .name
= "uint32 equal",
1132 .get
= get_uint32_equal
,
1136 /* 64 bit unsigned int */
1138 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1141 qemu_get_be64s(f
, v
);
1145 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1148 qemu_put_be64s(f
, v
);
1151 const VMStateInfo vmstate_info_uint64
= {
1157 /* 64 bit unsigned int. See that the received value is the same than the one
1160 static int get_uint64_equal(QEMUFile
*f
, void *pv
, size_t size
)
1164 qemu_get_be64s(f
, &v2
);
1172 const VMStateInfo vmstate_info_uint64_equal
= {
1173 .name
= "int64 equal",
1174 .get
= get_uint64_equal
,
1178 /* 8 bit int. See that the received value is the same than the one
1181 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1185 qemu_get_8s(f
, &v2
);
1192 const VMStateInfo vmstate_info_uint8_equal
= {
1193 .name
= "uint8 equal",
1194 .get
= get_uint8_equal
,
1198 /* 16 bit unsigned int int. See that the received value is the same than the one
1201 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1205 qemu_get_be16s(f
, &v2
);
1212 const VMStateInfo vmstate_info_uint16_equal
= {
1213 .name
= "uint16 equal",
1214 .get
= get_uint16_equal
,
1218 /* floating point */
1220 static int get_float64(QEMUFile
*f
, void *pv
, size_t size
)
1224 *v
= make_float64(qemu_get_be64(f
));
1228 static void put_float64(QEMUFile
*f
, void *pv
, size_t size
)
1232 qemu_put_be64(f
, float64_val(*v
));
1235 const VMStateInfo vmstate_info_float64
= {
1243 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1246 qemu_get_timer(f
, v
);
1250 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1253 qemu_put_timer(f
, v
);
1256 const VMStateInfo vmstate_info_timer
= {
1262 /* uint8_t buffers */
1264 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1267 qemu_get_buffer(f
, v
, size
);
1271 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1274 qemu_put_buffer(f
, v
, size
);
1277 const VMStateInfo vmstate_info_buffer
= {
1283 /* unused buffers: space that was used for some fields that are
1284 not useful anymore */
1286 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1292 block_len
= MIN(sizeof(buf
), size
);
1294 qemu_get_buffer(f
, buf
, block_len
);
1299 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1301 static const uint8_t buf
[1024];
1305 block_len
= MIN(sizeof(buf
), size
);
1307 qemu_put_buffer(f
, buf
, block_len
);
1311 const VMStateInfo vmstate_info_unused_buffer
= {
1312 .name
= "unused_buffer",
1313 .get
= get_unused_buffer
,
1314 .put
= put_unused_buffer
,
1317 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1318 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1319 * bit words with the bits in big endian order. The in-memory format
1320 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1322 /* This is the number of 64 bit words sent over the wire */
1323 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1324 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1326 unsigned long *bmp
= pv
;
1328 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1329 uint64_t w
= qemu_get_be64(f
);
1331 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1332 bmp
[idx
++] = w
>> 32;
1338 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1340 unsigned long *bmp
= pv
;
1342 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1343 uint64_t w
= bmp
[idx
++];
1344 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1345 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1347 qemu_put_be64(f
, w
);
1351 const VMStateInfo vmstate_info_bitmap
= {
1357 typedef struct CompatEntry
{
1362 typedef struct SaveStateEntry
{
1363 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1369 SaveVMHandlers
*ops
;
1370 const VMStateDescription
*vmsd
;
1372 CompatEntry
*compat
;
1378 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1379 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1380 static int global_section_id
;
1382 static int calculate_new_instance_id(const char *idstr
)
1385 int instance_id
= 0;
1387 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1388 if (strcmp(idstr
, se
->idstr
) == 0
1389 && instance_id
<= se
->instance_id
) {
1390 instance_id
= se
->instance_id
+ 1;
1396 static int calculate_compat_instance_id(const char *idstr
)
1399 int instance_id
= 0;
1401 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1405 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1406 && instance_id
<= se
->compat
->instance_id
) {
1407 instance_id
= se
->compat
->instance_id
+ 1;
1413 /* TODO: Individual devices generally have very little idea about the rest
1414 of the system, so instance_id should be removed/replaced.
1415 Meanwhile pass -1 as instance_id if you do not already have a clearly
1416 distinguishing id for all instances of your device class. */
1417 int register_savevm_live(DeviceState
*dev
,
1421 SaveVMHandlers
*ops
,
1426 se
= g_malloc0(sizeof(SaveStateEntry
));
1427 se
->version_id
= version_id
;
1428 se
->section_id
= global_section_id
++;
1430 se
->opaque
= opaque
;
1433 /* if this is a live_savem then set is_ram */
1434 if (ops
->save_live_setup
!= NULL
) {
1439 char *id
= qdev_get_dev_path(dev
);
1441 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1442 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1445 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1446 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1447 se
->compat
->instance_id
= instance_id
== -1 ?
1448 calculate_compat_instance_id(idstr
) : instance_id
;
1452 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1454 if (instance_id
== -1) {
1455 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1457 se
->instance_id
= instance_id
;
1459 assert(!se
->compat
|| se
->instance_id
== 0);
1460 /* add at the end of list */
1461 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1465 int register_savevm(DeviceState
*dev
,
1469 SaveStateHandler
*save_state
,
1470 LoadStateHandler
*load_state
,
1473 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1474 ops
->save_state
= save_state
;
1475 ops
->load_state
= load_state
;
1476 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1480 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1482 SaveStateEntry
*se
, *new_se
;
1486 char *path
= qdev_get_dev_path(dev
);
1488 pstrcpy(id
, sizeof(id
), path
);
1489 pstrcat(id
, sizeof(id
), "/");
1493 pstrcat(id
, sizeof(id
), idstr
);
1495 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1496 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1497 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1507 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1508 const VMStateDescription
*vmsd
,
1509 void *opaque
, int alias_id
,
1510 int required_for_version
)
1514 /* If this triggers, alias support can be dropped for the vmsd. */
1515 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1517 se
= g_malloc0(sizeof(SaveStateEntry
));
1518 se
->version_id
= vmsd
->version_id
;
1519 se
->section_id
= global_section_id
++;
1520 se
->opaque
= opaque
;
1522 se
->alias_id
= alias_id
;
1523 se
->no_migrate
= vmsd
->unmigratable
;
1526 char *id
= qdev_get_dev_path(dev
);
1528 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1529 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1532 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1533 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1534 se
->compat
->instance_id
= instance_id
== -1 ?
1535 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1539 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1541 if (instance_id
== -1) {
1542 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1544 se
->instance_id
= instance_id
;
1546 assert(!se
->compat
|| se
->instance_id
== 0);
1547 /* add at the end of list */
1548 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1552 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1555 SaveStateEntry
*se
, *new_se
;
1557 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1558 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1559 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1568 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1570 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1573 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1574 void *opaque
, int version_id
)
1576 VMStateField
*field
= vmsd
->fields
;
1579 if (version_id
> vmsd
->version_id
) {
1582 if (version_id
< vmsd
->minimum_version_id_old
) {
1585 if (version_id
< vmsd
->minimum_version_id
) {
1586 return vmsd
->load_state_old(f
, opaque
, version_id
);
1588 if (vmsd
->pre_load
) {
1589 int ret
= vmsd
->pre_load(opaque
);
1593 while(field
->name
) {
1594 if ((field
->field_exists
&&
1595 field
->field_exists(opaque
, version_id
)) ||
1596 (!field
->field_exists
&&
1597 field
->version_id
<= version_id
)) {
1598 void *base_addr
= opaque
+ field
->offset
;
1600 int size
= field
->size
;
1602 if (field
->flags
& VMS_VBUFFER
) {
1603 size
= *(int32_t *)(opaque
+field
->size_offset
);
1604 if (field
->flags
& VMS_MULTIPLY
) {
1605 size
*= field
->size
;
1608 if (field
->flags
& VMS_ARRAY
) {
1609 n_elems
= field
->num
;
1610 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1611 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1612 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1613 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1614 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1615 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1616 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1617 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1619 if (field
->flags
& VMS_POINTER
) {
1620 base_addr
= *(void **)base_addr
+ field
->start
;
1622 for (i
= 0; i
< n_elems
; i
++) {
1623 void *addr
= base_addr
+ size
* i
;
1625 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1626 addr
= *(void **)addr
;
1628 if (field
->flags
& VMS_STRUCT
) {
1629 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1631 ret
= field
->info
->get(f
, addr
, size
);
1641 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1645 if (vmsd
->post_load
) {
1646 return vmsd
->post_load(opaque
, version_id
);
1651 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1654 VMStateField
*field
= vmsd
->fields
;
1656 if (vmsd
->pre_save
) {
1657 vmsd
->pre_save(opaque
);
1659 while(field
->name
) {
1660 if (!field
->field_exists
||
1661 field
->field_exists(opaque
, vmsd
->version_id
)) {
1662 void *base_addr
= opaque
+ field
->offset
;
1664 int size
= field
->size
;
1666 if (field
->flags
& VMS_VBUFFER
) {
1667 size
= *(int32_t *)(opaque
+field
->size_offset
);
1668 if (field
->flags
& VMS_MULTIPLY
) {
1669 size
*= field
->size
;
1672 if (field
->flags
& VMS_ARRAY
) {
1673 n_elems
= field
->num
;
1674 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1675 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1676 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1677 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1678 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1679 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1680 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1681 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1683 if (field
->flags
& VMS_POINTER
) {
1684 base_addr
= *(void **)base_addr
+ field
->start
;
1686 for (i
= 0; i
< n_elems
; i
++) {
1687 void *addr
= base_addr
+ size
* i
;
1689 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1690 addr
= *(void **)addr
;
1692 if (field
->flags
& VMS_STRUCT
) {
1693 vmstate_save_state(f
, field
->vmsd
, addr
);
1695 field
->info
->put(f
, addr
, size
);
1701 vmstate_subsection_save(f
, vmsd
, opaque
);
1704 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1706 if (!se
->vmsd
) { /* Old style */
1707 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1709 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1712 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1714 if (!se
->vmsd
) { /* Old style */
1715 se
->ops
->save_state(f
, se
->opaque
);
1718 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1721 #define QEMU_VM_FILE_MAGIC 0x5145564d
1722 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1723 #define QEMU_VM_FILE_VERSION 0x00000003
1725 #define QEMU_VM_EOF 0x00
1726 #define QEMU_VM_SECTION_START 0x01
1727 #define QEMU_VM_SECTION_PART 0x02
1728 #define QEMU_VM_SECTION_END 0x03
1729 #define QEMU_VM_SECTION_FULL 0x04
1730 #define QEMU_VM_SUBSECTION 0x05
1732 bool qemu_savevm_state_blocked(Error
**errp
)
1736 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1737 if (se
->no_migrate
) {
1738 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1745 void qemu_savevm_state_begin(QEMUFile
*f
,
1746 const MigrationParams
*params
)
1751 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1752 if (!se
->ops
|| !se
->ops
->set_params
) {
1755 se
->ops
->set_params(params
, se
->opaque
);
1758 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1759 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1761 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1764 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1767 if (se
->ops
&& se
->ops
->is_active
) {
1768 if (!se
->ops
->is_active(se
->opaque
)) {
1773 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1774 qemu_put_be32(f
, se
->section_id
);
1777 len
= strlen(se
->idstr
);
1778 qemu_put_byte(f
, len
);
1779 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1781 qemu_put_be32(f
, se
->instance_id
);
1782 qemu_put_be32(f
, se
->version_id
);
1784 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1786 qemu_file_set_error(f
, ret
);
1793 * this function has three return values:
1794 * negative: there was one error, and we have -errno.
1795 * 0 : We haven't finished, caller have to go again
1796 * 1 : We have finished, we can go to complete phase
1798 int qemu_savevm_state_iterate(QEMUFile
*f
)
1803 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1804 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1807 if (se
->ops
&& se
->ops
->is_active
) {
1808 if (!se
->ops
->is_active(se
->opaque
)) {
1812 if (qemu_file_rate_limit(f
)) {
1815 trace_savevm_section_start();
1817 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1818 qemu_put_be32(f
, se
->section_id
);
1820 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1821 trace_savevm_section_end(se
->section_id
);
1824 qemu_file_set_error(f
, ret
);
1827 /* Do not proceed to the next vmstate before this one reported
1828 completion of the current stage. This serializes the migration
1829 and reduces the probability that a faster changing state is
1830 synchronized over and over again. */
1837 void qemu_savevm_state_complete(QEMUFile
*f
)
1842 cpu_synchronize_all_states();
1844 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1845 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1848 if (se
->ops
&& se
->ops
->is_active
) {
1849 if (!se
->ops
->is_active(se
->opaque
)) {
1853 trace_savevm_section_start();
1855 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1856 qemu_put_be32(f
, se
->section_id
);
1858 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1859 trace_savevm_section_end(se
->section_id
);
1861 qemu_file_set_error(f
, ret
);
1866 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1869 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1872 trace_savevm_section_start();
1874 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1875 qemu_put_be32(f
, se
->section_id
);
1878 len
= strlen(se
->idstr
);
1879 qemu_put_byte(f
, len
);
1880 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1882 qemu_put_be32(f
, se
->instance_id
);
1883 qemu_put_be32(f
, se
->version_id
);
1885 vmstate_save(f
, se
);
1886 trace_savevm_section_end(se
->section_id
);
1889 qemu_put_byte(f
, QEMU_VM_EOF
);
1893 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
1898 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1899 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
1902 if (se
->ops
&& se
->ops
->is_active
) {
1903 if (!se
->ops
->is_active(se
->opaque
)) {
1907 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
1912 void qemu_savevm_state_cancel(void)
1916 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1917 if (se
->ops
&& se
->ops
->cancel
) {
1918 se
->ops
->cancel(se
->opaque
);
1923 static int qemu_savevm_state(QEMUFile
*f
)
1926 MigrationParams params
= {
1931 if (qemu_savevm_state_blocked(NULL
)) {
1935 qemu_mutex_unlock_iothread();
1936 qemu_savevm_state_begin(f
, ¶ms
);
1937 qemu_mutex_lock_iothread();
1939 while (qemu_file_get_error(f
) == 0) {
1940 if (qemu_savevm_state_iterate(f
) > 0) {
1945 ret
= qemu_file_get_error(f
);
1947 qemu_savevm_state_complete(f
);
1948 ret
= qemu_file_get_error(f
);
1951 qemu_savevm_state_cancel();
1956 static int qemu_save_device_state(QEMUFile
*f
)
1960 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1961 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1963 cpu_synchronize_all_states();
1965 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1971 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1976 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1977 qemu_put_be32(f
, se
->section_id
);
1980 len
= strlen(se
->idstr
);
1981 qemu_put_byte(f
, len
);
1982 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1984 qemu_put_be32(f
, se
->instance_id
);
1985 qemu_put_be32(f
, se
->version_id
);
1987 vmstate_save(f
, se
);
1990 qemu_put_byte(f
, QEMU_VM_EOF
);
1992 return qemu_file_get_error(f
);
1995 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
1999 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
2000 if (!strcmp(se
->idstr
, idstr
) &&
2001 (instance_id
== se
->instance_id
||
2002 instance_id
== se
->alias_id
))
2004 /* Migrating from an older version? */
2005 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
2006 if (!strcmp(se
->compat
->idstr
, idstr
) &&
2007 (instance_id
== se
->compat
->instance_id
||
2008 instance_id
== se
->alias_id
))
2015 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
2017 while(sub
&& sub
->needed
) {
2018 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
2026 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2029 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
2032 uint8_t version_id
, len
, size
;
2033 const VMStateDescription
*sub_vmsd
;
2035 len
= qemu_peek_byte(f
, 1);
2036 if (len
< strlen(vmsd
->name
) + 1) {
2037 /* subsection name has be be "section_name/a" */
2040 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
2046 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
2047 /* it don't have a valid subsection name */
2050 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
2051 if (sub_vmsd
== NULL
) {
2054 qemu_file_skip(f
, 1); /* subsection */
2055 qemu_file_skip(f
, 1); /* len */
2056 qemu_file_skip(f
, len
); /* idstr */
2057 version_id
= qemu_get_be32(f
);
2059 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
2067 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
2070 const VMStateSubsection
*sub
= vmsd
->subsections
;
2072 while (sub
&& sub
->needed
) {
2073 if (sub
->needed(opaque
)) {
2074 const VMStateDescription
*vmsd
= sub
->vmsd
;
2077 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
2078 len
= strlen(vmsd
->name
);
2079 qemu_put_byte(f
, len
);
2080 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
2081 qemu_put_be32(f
, vmsd
->version_id
);
2082 vmstate_save_state(f
, vmsd
, opaque
);
2088 typedef struct LoadStateEntry
{
2089 QLIST_ENTRY(LoadStateEntry
) entry
;
2095 int qemu_loadvm_state(QEMUFile
*f
)
2097 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
2098 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
2099 LoadStateEntry
*le
, *new_le
;
2100 uint8_t section_type
;
2104 if (qemu_savevm_state_blocked(NULL
)) {
2108 v
= qemu_get_be32(f
);
2109 if (v
!= QEMU_VM_FILE_MAGIC
)
2112 v
= qemu_get_be32(f
);
2113 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
2114 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
2117 if (v
!= QEMU_VM_FILE_VERSION
)
2120 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
2121 uint32_t instance_id
, version_id
, section_id
;
2126 switch (section_type
) {
2127 case QEMU_VM_SECTION_START
:
2128 case QEMU_VM_SECTION_FULL
:
2129 /* Read section start */
2130 section_id
= qemu_get_be32(f
);
2131 len
= qemu_get_byte(f
);
2132 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
2134 instance_id
= qemu_get_be32(f
);
2135 version_id
= qemu_get_be32(f
);
2137 /* Find savevm section */
2138 se
= find_se(idstr
, instance_id
);
2140 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
2145 /* Validate version */
2146 if (version_id
> se
->version_id
) {
2147 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2148 version_id
, idstr
, se
->version_id
);
2154 le
= g_malloc0(sizeof(*le
));
2157 le
->section_id
= section_id
;
2158 le
->version_id
= version_id
;
2159 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2161 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2163 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2164 instance_id
, idstr
);
2168 case QEMU_VM_SECTION_PART
:
2169 case QEMU_VM_SECTION_END
:
2170 section_id
= qemu_get_be32(f
);
2172 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2173 if (le
->section_id
== section_id
) {
2178 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2183 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2185 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2191 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2197 cpu_synchronize_all_post_init();
2202 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2203 QLIST_REMOVE(le
, entry
);
2208 ret
= qemu_file_get_error(f
);
2214 static int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
2217 QEMUSnapshotInfo
*sn_tab
, *sn
;
2221 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2224 for(i
= 0; i
< nb_sns
; i
++) {
2226 if (!strcmp(sn
->id_str
, name
) || !strcmp(sn
->name
, name
)) {
2237 * Deletes snapshots of a given name in all opened images.
2239 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2241 BlockDriverState
*bs
;
2242 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2246 while ((bs
= bdrv_next(bs
))) {
2247 if (bdrv_can_snapshot(bs
) &&
2248 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2250 ret
= bdrv_snapshot_delete(bs
, name
);
2253 "Error while deleting snapshot on '%s'\n",
2254 bdrv_get_device_name(bs
));
2263 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2265 BlockDriverState
*bs
, *bs1
;
2266 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2269 int saved_vm_running
;
2270 uint64_t vm_state_size
;
2273 const char *name
= qdict_get_try_str(qdict
, "name");
2275 /* Verify if there is a device that doesn't support snapshots and is writable */
2277 while ((bs
= bdrv_next(bs
))) {
2279 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2283 if (!bdrv_can_snapshot(bs
)) {
2284 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2285 bdrv_get_device_name(bs
));
2290 bs
= bdrv_snapshots();
2292 monitor_printf(mon
, "No block device can accept snapshots\n");
2296 saved_vm_running
= runstate_is_running();
2297 vm_stop(RUN_STATE_SAVE_VM
);
2299 memset(sn
, 0, sizeof(*sn
));
2301 /* fill auxiliary fields */
2302 qemu_gettimeofday(&tv
);
2303 sn
->date_sec
= tv
.tv_sec
;
2304 sn
->date_nsec
= tv
.tv_usec
* 1000;
2305 sn
->vm_clock_nsec
= qemu_get_clock_ns(vm_clock
);
2308 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2310 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2311 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2313 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2316 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2317 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2318 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2321 /* Delete old snapshots of the same name */
2322 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2326 /* save the VM state */
2327 f
= qemu_fopen_bdrv(bs
, 1);
2329 monitor_printf(mon
, "Could not open VM state file\n");
2332 ret
= qemu_savevm_state(f
);
2333 vm_state_size
= qemu_ftell(f
);
2336 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2340 /* create the snapshots */
2343 while ((bs1
= bdrv_next(bs1
))) {
2344 if (bdrv_can_snapshot(bs1
)) {
2345 /* Write VM state size only to the image that contains the state */
2346 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2347 ret
= bdrv_snapshot_create(bs1
, sn
);
2349 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2350 bdrv_get_device_name(bs1
));
2356 if (saved_vm_running
)
2360 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2363 int saved_vm_running
;
2366 saved_vm_running
= runstate_is_running();
2367 vm_stop(RUN_STATE_SAVE_VM
);
2369 f
= qemu_fopen(filename
, "wb");
2371 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
2374 ret
= qemu_save_device_state(f
);
2377 error_set(errp
, QERR_IO_ERROR
);
2381 if (saved_vm_running
)
2385 int load_vmstate(const char *name
)
2387 BlockDriverState
*bs
, *bs_vm_state
;
2388 QEMUSnapshotInfo sn
;
2392 bs_vm_state
= bdrv_snapshots();
2394 error_report("No block device supports snapshots");
2398 /* Don't even try to load empty VM states */
2399 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2402 } else if (sn
.vm_state_size
== 0) {
2403 error_report("This is a disk-only snapshot. Revert to it offline "
2408 /* Verify if there is any device that doesn't support snapshots and is
2409 writable and check if the requested snapshot is available too. */
2411 while ((bs
= bdrv_next(bs
))) {
2413 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2417 if (!bdrv_can_snapshot(bs
)) {
2418 error_report("Device '%s' is writable but does not support snapshots.",
2419 bdrv_get_device_name(bs
));
2423 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2425 error_report("Device '%s' does not have the requested snapshot '%s'",
2426 bdrv_get_device_name(bs
), name
);
2431 /* Flush all IO requests so they don't interfere with the new state. */
2435 while ((bs
= bdrv_next(bs
))) {
2436 if (bdrv_can_snapshot(bs
)) {
2437 ret
= bdrv_snapshot_goto(bs
, name
);
2439 error_report("Error %d while activating snapshot '%s' on '%s'",
2440 ret
, name
, bdrv_get_device_name(bs
));
2446 /* restore the VM state */
2447 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2449 error_report("Could not open VM state file");
2453 qemu_system_reset(VMRESET_SILENT
);
2454 ret
= qemu_loadvm_state(f
);
2458 error_report("Error %d while loading VM state", ret
);
2465 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2467 BlockDriverState
*bs
, *bs1
;
2469 const char *name
= qdict_get_str(qdict
, "name");
2471 bs
= bdrv_snapshots();
2473 monitor_printf(mon
, "No block device supports snapshots\n");
2478 while ((bs1
= bdrv_next(bs1
))) {
2479 if (bdrv_can_snapshot(bs1
)) {
2480 ret
= bdrv_snapshot_delete(bs1
, name
);
2482 if (ret
== -ENOTSUP
)
2484 "Snapshots not supported on device '%s'\n",
2485 bdrv_get_device_name(bs1
));
2487 monitor_printf(mon
, "Error %d while deleting snapshot on "
2488 "'%s'\n", ret
, bdrv_get_device_name(bs1
));
2494 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2496 BlockDriverState
*bs
, *bs1
;
2497 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2498 int nb_sns
, i
, ret
, available
;
2500 int *available_snapshots
;
2503 bs
= bdrv_snapshots();
2505 monitor_printf(mon
, "No available block device supports snapshots\n");
2509 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2511 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2516 monitor_printf(mon
, "There is no snapshot available.\n");
2520 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2522 for (i
= 0; i
< nb_sns
; i
++) {
2527 while ((bs1
= bdrv_next(bs1
))) {
2528 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2529 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2538 available_snapshots
[total
] = i
;
2544 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
2545 for (i
= 0; i
< total
; i
++) {
2546 sn
= &sn_tab
[available_snapshots
[i
]];
2547 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
2550 monitor_printf(mon
, "There is no suitable snapshot available\n");
2554 g_free(available_snapshots
);
2558 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2560 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2561 memory_region_name(mr
), dev
);
2564 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2566 /* Nothing do to while the implementation is in RAMBlock */
2569 void vmstate_register_ram_global(MemoryRegion
*mr
)
2571 vmstate_register_ram(mr
, NULL
);