4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "config-host.h"
26 #include "qemu-common.h"
30 #include "monitor/monitor.h"
31 #include "sysemu/sysemu.h"
32 #include "qemu/timer.h"
33 #include "audio/audio.h"
34 #include "migration/migration.h"
35 #include "qemu/sockets.h"
36 #include "qemu/queue.h"
37 #include "sysemu/cpus.h"
38 #include "exec/memory.h"
39 #include "qmp-commands.h"
41 #include "qemu/bitops.h"
43 #define SELF_ANNOUNCE_ROUNDS 5
46 #define ETH_P_RARP 0x8035
48 #define ARP_HTYPE_ETH 0x0001
49 #define ARP_PTYPE_IP 0x0800
50 #define ARP_OP_REQUEST_REV 0x3
52 static int announce_self_create(uint8_t *buf
,
55 /* Ethernet header. */
56 memset(buf
, 0xff, 6); /* destination MAC addr */
57 memcpy(buf
+ 6, mac_addr
, 6); /* source MAC addr */
58 *(uint16_t *)(buf
+ 12) = htons(ETH_P_RARP
); /* ethertype */
61 *(uint16_t *)(buf
+ 14) = htons(ARP_HTYPE_ETH
); /* hardware addr space */
62 *(uint16_t *)(buf
+ 16) = htons(ARP_PTYPE_IP
); /* protocol addr space */
63 *(buf
+ 18) = 6; /* hardware addr length (ethernet) */
64 *(buf
+ 19) = 4; /* protocol addr length (IPv4) */
65 *(uint16_t *)(buf
+ 20) = htons(ARP_OP_REQUEST_REV
); /* opcode */
66 memcpy(buf
+ 22, mac_addr
, 6); /* source hw addr */
67 memset(buf
+ 28, 0x00, 4); /* source protocol addr */
68 memcpy(buf
+ 32, mac_addr
, 6); /* target hw addr */
69 memset(buf
+ 38, 0x00, 4); /* target protocol addr */
71 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
72 memset(buf
+ 42, 0x00, 18);
74 return 60; /* len (FCS will be added by hardware) */
77 static void qemu_announce_self_iter(NICState
*nic
, void *opaque
)
82 len
= announce_self_create(buf
, nic
->conf
->macaddr
.a
);
84 qemu_send_packet_raw(qemu_get_queue(nic
), buf
, len
);
88 static void qemu_announce_self_once(void *opaque
)
90 static int count
= SELF_ANNOUNCE_ROUNDS
;
91 QEMUTimer
*timer
= *(QEMUTimer
**)opaque
;
93 qemu_foreach_nic(qemu_announce_self_iter
, NULL
);
96 /* delay 50ms, 150ms, 250ms, ... */
97 qemu_mod_timer(timer
, qemu_get_clock_ms(rt_clock
) +
98 50 + (SELF_ANNOUNCE_ROUNDS
- count
- 1) * 100);
100 qemu_del_timer(timer
);
101 qemu_free_timer(timer
);
105 void qemu_announce_self(void)
107 static QEMUTimer
*timer
;
108 timer
= qemu_new_timer_ms(rt_clock
, qemu_announce_self_once
, &timer
);
109 qemu_announce_self_once(&timer
);
112 /***********************************************************/
113 /* savevm/loadvm support */
115 #define IO_BUF_SIZE 32768
118 const QEMUFileOps
*ops
;
122 int64_t pos
; /* start of buffer when writing, end of buffer
125 int buf_size
; /* 0 when writing */
126 uint8_t buf
[IO_BUF_SIZE
];
131 typedef struct QEMUFileStdio
137 typedef struct QEMUFileSocket
148 static void fd_coroutine_enter(void *opaque
)
150 FDYieldUntilData
*data
= opaque
;
151 qemu_set_fd_handler(data
->fd
, NULL
, NULL
, NULL
);
152 qemu_coroutine_enter(data
->co
, NULL
);
156 * Yield until a file descriptor becomes readable
158 * Note that this function clobbers the handlers for the file descriptor.
160 static void coroutine_fn
yield_until_fd_readable(int fd
)
162 FDYieldUntilData data
;
164 assert(qemu_in_coroutine());
165 data
.co
= qemu_coroutine_self();
167 qemu_set_fd_handler(fd
, fd_coroutine_enter
, NULL
, &data
);
168 qemu_coroutine_yield();
171 static int socket_get_fd(void *opaque
)
173 QEMUFileSocket
*s
= opaque
;
178 static int socket_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
180 QEMUFileSocket
*s
= opaque
;
184 len
= qemu_recv(s
->fd
, buf
, size
, 0);
188 if (socket_error() == EAGAIN
) {
189 yield_until_fd_readable(s
->fd
);
190 } else if (socket_error() != EINTR
) {
196 len
= -socket_error();
201 static int socket_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
203 QEMUFileSocket
*s
= opaque
;
206 len
= qemu_send_full(s
->fd
, buf
, size
, 0);
208 len
= -socket_error();
213 static int socket_close(void *opaque
)
215 QEMUFileSocket
*s
= opaque
;
221 static int stdio_get_fd(void *opaque
)
223 QEMUFileStdio
*s
= opaque
;
225 return fileno(s
->stdio_file
);
228 static int stdio_put_buffer(void *opaque
, const uint8_t *buf
, int64_t pos
, int size
)
230 QEMUFileStdio
*s
= opaque
;
231 return fwrite(buf
, 1, size
, s
->stdio_file
);
234 static int stdio_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
236 QEMUFileStdio
*s
= opaque
;
237 FILE *fp
= s
->stdio_file
;
242 bytes
= fread(buf
, 1, size
, fp
);
243 if (bytes
!= 0 || !ferror(fp
)) {
246 if (errno
== EAGAIN
) {
247 yield_until_fd_readable(fileno(fp
));
248 } else if (errno
!= EINTR
) {
255 static int stdio_pclose(void *opaque
)
257 QEMUFileStdio
*s
= opaque
;
259 ret
= pclose(s
->stdio_file
);
262 } else if (!WIFEXITED(ret
) || WEXITSTATUS(ret
) != 0) {
263 /* close succeeded, but non-zero exit code: */
264 ret
= -EIO
; /* fake errno value */
270 static int stdio_fclose(void *opaque
)
272 QEMUFileStdio
*s
= opaque
;
275 if (s
->file
->ops
->put_buffer
) {
276 int fd
= fileno(s
->stdio_file
);
279 ret
= fstat(fd
, &st
);
280 if (ret
== 0 && S_ISREG(st
.st_mode
)) {
282 * If the file handle is a regular file make sure the
283 * data is flushed to disk before signaling success.
292 if (fclose(s
->stdio_file
) == EOF
) {
299 static const QEMUFileOps stdio_pipe_read_ops
= {
300 .get_fd
= stdio_get_fd
,
301 .get_buffer
= stdio_get_buffer
,
302 .close
= stdio_pclose
305 static const QEMUFileOps stdio_pipe_write_ops
= {
306 .get_fd
= stdio_get_fd
,
307 .put_buffer
= stdio_put_buffer
,
308 .close
= stdio_pclose
311 QEMUFile
*qemu_popen_cmd(const char *command
, const char *mode
)
316 stdio_file
= popen(command
, mode
);
317 if (stdio_file
== NULL
) {
321 if (mode
== NULL
|| (mode
[0] != 'r' && mode
[0] != 'w') || mode
[1] != 0) {
322 fprintf(stderr
, "qemu_popen: Argument validity check failed\n");
326 s
= g_malloc0(sizeof(QEMUFileStdio
));
328 s
->stdio_file
= stdio_file
;
331 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_read_ops
);
333 s
->file
= qemu_fopen_ops(s
, &stdio_pipe_write_ops
);
338 static const QEMUFileOps stdio_file_read_ops
= {
339 .get_fd
= stdio_get_fd
,
340 .get_buffer
= stdio_get_buffer
,
341 .close
= stdio_fclose
344 static const QEMUFileOps stdio_file_write_ops
= {
345 .get_fd
= stdio_get_fd
,
346 .put_buffer
= stdio_put_buffer
,
347 .close
= stdio_fclose
350 QEMUFile
*qemu_fdopen(int fd
, const char *mode
)
355 (mode
[0] != 'r' && mode
[0] != 'w') ||
356 mode
[1] != 'b' || mode
[2] != 0) {
357 fprintf(stderr
, "qemu_fdopen: Argument validity check failed\n");
361 s
= g_malloc0(sizeof(QEMUFileStdio
));
362 s
->stdio_file
= fdopen(fd
, mode
);
367 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
369 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
378 static const QEMUFileOps socket_read_ops
= {
379 .get_fd
= socket_get_fd
,
380 .get_buffer
= socket_get_buffer
,
381 .close
= socket_close
384 static const QEMUFileOps socket_write_ops
= {
385 .get_fd
= socket_get_fd
,
386 .put_buffer
= socket_put_buffer
,
387 .close
= socket_close
390 QEMUFile
*qemu_fopen_socket(int fd
, const char *mode
)
392 QEMUFileSocket
*s
= g_malloc0(sizeof(QEMUFileSocket
));
395 (mode
[0] != 'r' && mode
[0] != 'w') ||
396 mode
[1] != 'b' || mode
[2] != 0) {
397 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
402 if (mode
[0] == 'w') {
403 socket_set_block(s
->fd
);
404 s
->file
= qemu_fopen_ops(s
, &socket_write_ops
);
406 s
->file
= qemu_fopen_ops(s
, &socket_read_ops
);
411 QEMUFile
*qemu_fopen(const char *filename
, const char *mode
)
416 (mode
[0] != 'r' && mode
[0] != 'w') ||
417 mode
[1] != 'b' || mode
[2] != 0) {
418 fprintf(stderr
, "qemu_fopen: Argument validity check failed\n");
422 s
= g_malloc0(sizeof(QEMUFileStdio
));
424 s
->stdio_file
= fopen(filename
, mode
);
429 s
->file
= qemu_fopen_ops(s
, &stdio_file_write_ops
);
431 s
->file
= qemu_fopen_ops(s
, &stdio_file_read_ops
);
439 static int block_put_buffer(void *opaque
, const uint8_t *buf
,
440 int64_t pos
, int size
)
442 bdrv_save_vmstate(opaque
, buf
, pos
, size
);
446 static int block_get_buffer(void *opaque
, uint8_t *buf
, int64_t pos
, int size
)
448 return bdrv_load_vmstate(opaque
, buf
, pos
, size
);
451 static int bdrv_fclose(void *opaque
)
453 return bdrv_flush(opaque
);
456 static const QEMUFileOps bdrv_read_ops
= {
457 .get_buffer
= block_get_buffer
,
461 static const QEMUFileOps bdrv_write_ops
= {
462 .put_buffer
= block_put_buffer
,
466 static QEMUFile
*qemu_fopen_bdrv(BlockDriverState
*bs
, int is_writable
)
469 return qemu_fopen_ops(bs
, &bdrv_write_ops
);
470 return qemu_fopen_ops(bs
, &bdrv_read_ops
);
473 QEMUFile
*qemu_fopen_ops(void *opaque
, const QEMUFileOps
*ops
)
477 f
= g_malloc0(sizeof(QEMUFile
));
486 int qemu_file_get_error(QEMUFile
*f
)
488 return f
->last_error
;
491 static void qemu_file_set_error(QEMUFile
*f
, int ret
)
493 if (f
->last_error
== 0) {
498 /** Flushes QEMUFile buffer
501 static void qemu_fflush(QEMUFile
*f
)
505 if (!f
->ops
->put_buffer
) {
508 if (f
->is_write
&& f
->buf_index
> 0) {
509 ret
= f
->ops
->put_buffer(f
->opaque
, f
->buf
, f
->pos
, f
->buf_index
);
511 f
->pos
+= f
->buf_index
;
516 qemu_file_set_error(f
, ret
);
520 static void qemu_fill_buffer(QEMUFile
*f
)
525 if (!f
->ops
->get_buffer
)
531 pending
= f
->buf_size
- f
->buf_index
;
533 memmove(f
->buf
, f
->buf
+ f
->buf_index
, pending
);
536 f
->buf_size
= pending
;
538 len
= f
->ops
->get_buffer(f
->opaque
, f
->buf
+ pending
, f
->pos
,
539 IO_BUF_SIZE
- pending
);
543 } else if (len
== 0) {
544 qemu_file_set_error(f
, -EIO
);
545 } else if (len
!= -EAGAIN
)
546 qemu_file_set_error(f
, len
);
549 int qemu_get_fd(QEMUFile
*f
)
551 if (f
->ops
->get_fd
) {
552 return f
->ops
->get_fd(f
->opaque
);
559 * Returns negative error value if any error happened on previous operations or
560 * while closing the file. Returns 0 or positive number on success.
562 * The meaning of return value on success depends on the specific backend
565 int qemu_fclose(QEMUFile
*f
)
569 ret
= qemu_file_get_error(f
);
572 int ret2
= f
->ops
->close(f
->opaque
);
577 /* If any error was spotted before closing, we should report it
578 * instead of the close() return value.
587 void qemu_put_buffer(QEMUFile
*f
, const uint8_t *buf
, int size
)
595 if (f
->is_write
== 0 && f
->buf_index
> 0) {
597 "Attempted to write to buffer while read buffer is not empty\n");
602 l
= IO_BUF_SIZE
- f
->buf_index
;
605 memcpy(f
->buf
+ f
->buf_index
, buf
, l
);
610 if (f
->buf_index
>= IO_BUF_SIZE
) {
612 if (qemu_file_get_error(f
)) {
619 void qemu_put_byte(QEMUFile
*f
, int v
)
625 if (f
->is_write
== 0 && f
->buf_index
> 0) {
627 "Attempted to write to buffer while read buffer is not empty\n");
631 f
->buf
[f
->buf_index
++] = v
;
633 if (f
->buf_index
>= IO_BUF_SIZE
) {
638 static void qemu_file_skip(QEMUFile
*f
, int size
)
640 if (f
->buf_index
+ size
<= f
->buf_size
) {
641 f
->buf_index
+= size
;
645 static int qemu_peek_buffer(QEMUFile
*f
, uint8_t *buf
, int size
, size_t offset
)
654 index
= f
->buf_index
+ offset
;
655 pending
= f
->buf_size
- index
;
656 if (pending
< size
) {
658 index
= f
->buf_index
+ offset
;
659 pending
= f
->buf_size
- index
;
665 if (size
> pending
) {
669 memcpy(buf
, f
->buf
+ index
, size
);
673 int qemu_get_buffer(QEMUFile
*f
, uint8_t *buf
, int size
)
678 while (pending
> 0) {
681 res
= qemu_peek_buffer(f
, buf
, pending
, 0);
685 qemu_file_skip(f
, res
);
693 static int qemu_peek_byte(QEMUFile
*f
, int offset
)
695 int index
= f
->buf_index
+ offset
;
701 if (index
>= f
->buf_size
) {
703 index
= f
->buf_index
+ offset
;
704 if (index
>= f
->buf_size
) {
708 return f
->buf
[index
];
711 int qemu_get_byte(QEMUFile
*f
)
715 result
= qemu_peek_byte(f
, 0);
716 qemu_file_skip(f
, 1);
720 int64_t qemu_ftell(QEMUFile
*f
)
726 int qemu_file_rate_limit(QEMUFile
*f
)
728 if (f
->ops
->rate_limit
)
729 return f
->ops
->rate_limit(f
->opaque
);
734 int64_t qemu_file_get_rate_limit(QEMUFile
*f
)
736 if (f
->ops
->get_rate_limit
)
737 return f
->ops
->get_rate_limit(f
->opaque
);
742 int64_t qemu_file_set_rate_limit(QEMUFile
*f
, int64_t new_rate
)
744 /* any failed or completed migration keeps its state to allow probing of
745 * migration data, but has no associated file anymore */
746 if (f
&& f
->ops
->set_rate_limit
)
747 return f
->ops
->set_rate_limit(f
->opaque
, new_rate
);
752 void qemu_put_be16(QEMUFile
*f
, unsigned int v
)
754 qemu_put_byte(f
, v
>> 8);
758 void qemu_put_be32(QEMUFile
*f
, unsigned int v
)
760 qemu_put_byte(f
, v
>> 24);
761 qemu_put_byte(f
, v
>> 16);
762 qemu_put_byte(f
, v
>> 8);
766 void qemu_put_be64(QEMUFile
*f
, uint64_t v
)
768 qemu_put_be32(f
, v
>> 32);
772 unsigned int qemu_get_be16(QEMUFile
*f
)
775 v
= qemu_get_byte(f
) << 8;
776 v
|= qemu_get_byte(f
);
780 unsigned int qemu_get_be32(QEMUFile
*f
)
783 v
= qemu_get_byte(f
) << 24;
784 v
|= qemu_get_byte(f
) << 16;
785 v
|= qemu_get_byte(f
) << 8;
786 v
|= qemu_get_byte(f
);
790 uint64_t qemu_get_be64(QEMUFile
*f
)
793 v
= (uint64_t)qemu_get_be32(f
) << 32;
794 v
|= qemu_get_be32(f
);
801 void qemu_put_timer(QEMUFile
*f
, QEMUTimer
*ts
)
803 uint64_t expire_time
;
805 expire_time
= qemu_timer_expire_time_ns(ts
);
806 qemu_put_be64(f
, expire_time
);
809 void qemu_get_timer(QEMUFile
*f
, QEMUTimer
*ts
)
811 uint64_t expire_time
;
813 expire_time
= qemu_get_be64(f
);
814 if (expire_time
!= -1) {
815 qemu_mod_timer_ns(ts
, expire_time
);
824 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
827 *v
= qemu_get_byte(f
);
831 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
834 qemu_put_byte(f
, *v
);
837 const VMStateInfo vmstate_info_bool
= {
845 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
852 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
858 const VMStateInfo vmstate_info_int8
= {
866 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
869 qemu_get_sbe16s(f
, v
);
873 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
876 qemu_put_sbe16s(f
, v
);
879 const VMStateInfo vmstate_info_int16
= {
887 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
890 qemu_get_sbe32s(f
, v
);
894 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
897 qemu_put_sbe32s(f
, v
);
900 const VMStateInfo vmstate_info_int32
= {
906 /* 32 bit int. See that the received value is the same than the one
909 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
913 qemu_get_sbe32s(f
, &v2
);
920 const VMStateInfo vmstate_info_int32_equal
= {
921 .name
= "int32 equal",
922 .get
= get_int32_equal
,
926 /* 32 bit int. See that the received value is the less or the same
927 than the one in the field */
929 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
933 qemu_get_sbe32s(f
, &new);
940 const VMStateInfo vmstate_info_int32_le
= {
941 .name
= "int32 equal",
948 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
951 qemu_get_sbe64s(f
, v
);
955 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
958 qemu_put_sbe64s(f
, v
);
961 const VMStateInfo vmstate_info_int64
= {
967 /* 8 bit unsigned int */
969 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
976 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
982 const VMStateInfo vmstate_info_uint8
= {
988 /* 16 bit unsigned int */
990 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
993 qemu_get_be16s(f
, v
);
997 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
1000 qemu_put_be16s(f
, v
);
1003 const VMStateInfo vmstate_info_uint16
= {
1009 /* 32 bit unsigned int */
1011 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1014 qemu_get_be32s(f
, v
);
1018 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
1021 qemu_put_be32s(f
, v
);
1024 const VMStateInfo vmstate_info_uint32
= {
1030 /* 32 bit uint. See that the received value is the same than the one
1033 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
1037 qemu_get_be32s(f
, &v2
);
1045 const VMStateInfo vmstate_info_uint32_equal
= {
1046 .name
= "uint32 equal",
1047 .get
= get_uint32_equal
,
1051 /* 64 bit unsigned int */
1053 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1056 qemu_get_be64s(f
, v
);
1060 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
1063 qemu_put_be64s(f
, v
);
1066 const VMStateInfo vmstate_info_uint64
= {
1072 /* 8 bit int. See that the received value is the same than the one
1075 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
1079 qemu_get_8s(f
, &v2
);
1086 const VMStateInfo vmstate_info_uint8_equal
= {
1087 .name
= "uint8 equal",
1088 .get
= get_uint8_equal
,
1092 /* 16 bit unsigned int int. See that the received value is the same than the one
1095 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
1099 qemu_get_be16s(f
, &v2
);
1106 const VMStateInfo vmstate_info_uint16_equal
= {
1107 .name
= "uint16 equal",
1108 .get
= get_uint16_equal
,
1114 static int get_timer(QEMUFile
*f
, void *pv
, size_t size
)
1117 qemu_get_timer(f
, v
);
1121 static void put_timer(QEMUFile
*f
, void *pv
, size_t size
)
1124 qemu_put_timer(f
, v
);
1127 const VMStateInfo vmstate_info_timer
= {
1133 /* uint8_t buffers */
1135 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1138 qemu_get_buffer(f
, v
, size
);
1142 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1145 qemu_put_buffer(f
, v
, size
);
1148 const VMStateInfo vmstate_info_buffer
= {
1154 /* unused buffers: space that was used for some fields that are
1155 not useful anymore */
1157 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1163 block_len
= MIN(sizeof(buf
), size
);
1165 qemu_get_buffer(f
, buf
, block_len
);
1170 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
1172 static const uint8_t buf
[1024];
1176 block_len
= MIN(sizeof(buf
), size
);
1178 qemu_put_buffer(f
, buf
, block_len
);
1182 const VMStateInfo vmstate_info_unused_buffer
= {
1183 .name
= "unused_buffer",
1184 .get
= get_unused_buffer
,
1185 .put
= put_unused_buffer
,
1188 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1189 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1190 * bit words with the bits in big endian order. The in-memory format
1191 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1193 /* This is the number of 64 bit words sent over the wire */
1194 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1195 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1197 unsigned long *bmp
= pv
;
1199 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1200 uint64_t w
= qemu_get_be64(f
);
1202 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1203 bmp
[idx
++] = w
>> 32;
1209 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
1211 unsigned long *bmp
= pv
;
1213 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
1214 uint64_t w
= bmp
[idx
++];
1215 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
1216 w
|= ((uint64_t)bmp
[idx
++]) << 32;
1218 qemu_put_be64(f
, w
);
1222 const VMStateInfo vmstate_info_bitmap
= {
1228 typedef struct CompatEntry
{
1233 typedef struct SaveStateEntry
{
1234 QTAILQ_ENTRY(SaveStateEntry
) entry
;
1240 SaveVMHandlers
*ops
;
1241 const VMStateDescription
*vmsd
;
1243 CompatEntry
*compat
;
1249 static QTAILQ_HEAD(savevm_handlers
, SaveStateEntry
) savevm_handlers
=
1250 QTAILQ_HEAD_INITIALIZER(savevm_handlers
);
1251 static int global_section_id
;
1253 static int calculate_new_instance_id(const char *idstr
)
1256 int instance_id
= 0;
1258 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1259 if (strcmp(idstr
, se
->idstr
) == 0
1260 && instance_id
<= se
->instance_id
) {
1261 instance_id
= se
->instance_id
+ 1;
1267 static int calculate_compat_instance_id(const char *idstr
)
1270 int instance_id
= 0;
1272 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1276 if (strcmp(idstr
, se
->compat
->idstr
) == 0
1277 && instance_id
<= se
->compat
->instance_id
) {
1278 instance_id
= se
->compat
->instance_id
+ 1;
1284 /* TODO: Individual devices generally have very little idea about the rest
1285 of the system, so instance_id should be removed/replaced.
1286 Meanwhile pass -1 as instance_id if you do not already have a clearly
1287 distinguishing id for all instances of your device class. */
1288 int register_savevm_live(DeviceState
*dev
,
1292 SaveVMHandlers
*ops
,
1297 se
= g_malloc0(sizeof(SaveStateEntry
));
1298 se
->version_id
= version_id
;
1299 se
->section_id
= global_section_id
++;
1301 se
->opaque
= opaque
;
1304 /* if this is a live_savem then set is_ram */
1305 if (ops
->save_live_setup
!= NULL
) {
1310 char *id
= qdev_get_dev_path(dev
);
1312 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1313 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1316 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1317 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), idstr
);
1318 se
->compat
->instance_id
= instance_id
== -1 ?
1319 calculate_compat_instance_id(idstr
) : instance_id
;
1323 pstrcat(se
->idstr
, sizeof(se
->idstr
), idstr
);
1325 if (instance_id
== -1) {
1326 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1328 se
->instance_id
= instance_id
;
1330 assert(!se
->compat
|| se
->instance_id
== 0);
1331 /* add at the end of list */
1332 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1336 int register_savevm(DeviceState
*dev
,
1340 SaveStateHandler
*save_state
,
1341 LoadStateHandler
*load_state
,
1344 SaveVMHandlers
*ops
= g_malloc0(sizeof(SaveVMHandlers
));
1345 ops
->save_state
= save_state
;
1346 ops
->load_state
= load_state
;
1347 return register_savevm_live(dev
, idstr
, instance_id
, version_id
,
1351 void unregister_savevm(DeviceState
*dev
, const char *idstr
, void *opaque
)
1353 SaveStateEntry
*se
, *new_se
;
1357 char *path
= qdev_get_dev_path(dev
);
1359 pstrcpy(id
, sizeof(id
), path
);
1360 pstrcat(id
, sizeof(id
), "/");
1364 pstrcat(id
, sizeof(id
), idstr
);
1366 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1367 if (strcmp(se
->idstr
, id
) == 0 && se
->opaque
== opaque
) {
1368 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1378 int vmstate_register_with_alias_id(DeviceState
*dev
, int instance_id
,
1379 const VMStateDescription
*vmsd
,
1380 void *opaque
, int alias_id
,
1381 int required_for_version
)
1385 /* If this triggers, alias support can be dropped for the vmsd. */
1386 assert(alias_id
== -1 || required_for_version
>= vmsd
->minimum_version_id
);
1388 se
= g_malloc0(sizeof(SaveStateEntry
));
1389 se
->version_id
= vmsd
->version_id
;
1390 se
->section_id
= global_section_id
++;
1391 se
->opaque
= opaque
;
1393 se
->alias_id
= alias_id
;
1394 se
->no_migrate
= vmsd
->unmigratable
;
1397 char *id
= qdev_get_dev_path(dev
);
1399 pstrcpy(se
->idstr
, sizeof(se
->idstr
), id
);
1400 pstrcat(se
->idstr
, sizeof(se
->idstr
), "/");
1403 se
->compat
= g_malloc0(sizeof(CompatEntry
));
1404 pstrcpy(se
->compat
->idstr
, sizeof(se
->compat
->idstr
), vmsd
->name
);
1405 se
->compat
->instance_id
= instance_id
== -1 ?
1406 calculate_compat_instance_id(vmsd
->name
) : instance_id
;
1410 pstrcat(se
->idstr
, sizeof(se
->idstr
), vmsd
->name
);
1412 if (instance_id
== -1) {
1413 se
->instance_id
= calculate_new_instance_id(se
->idstr
);
1415 se
->instance_id
= instance_id
;
1417 assert(!se
->compat
|| se
->instance_id
== 0);
1418 /* add at the end of list */
1419 QTAILQ_INSERT_TAIL(&savevm_handlers
, se
, entry
);
1423 int vmstate_register(DeviceState
*dev
, int instance_id
,
1424 const VMStateDescription
*vmsd
, void *opaque
)
1426 return vmstate_register_with_alias_id(dev
, instance_id
, vmsd
,
1430 void vmstate_unregister(DeviceState
*dev
, const VMStateDescription
*vmsd
,
1433 SaveStateEntry
*se
, *new_se
;
1435 QTAILQ_FOREACH_SAFE(se
, &savevm_handlers
, entry
, new_se
) {
1436 if (se
->vmsd
== vmsd
&& se
->opaque
== opaque
) {
1437 QTAILQ_REMOVE(&savevm_handlers
, se
, entry
);
1446 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1448 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1451 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1452 void *opaque
, int version_id
)
1454 VMStateField
*field
= vmsd
->fields
;
1457 if (version_id
> vmsd
->version_id
) {
1460 if (version_id
< vmsd
->minimum_version_id_old
) {
1463 if (version_id
< vmsd
->minimum_version_id
) {
1464 return vmsd
->load_state_old(f
, opaque
, version_id
);
1466 if (vmsd
->pre_load
) {
1467 int ret
= vmsd
->pre_load(opaque
);
1471 while(field
->name
) {
1472 if ((field
->field_exists
&&
1473 field
->field_exists(opaque
, version_id
)) ||
1474 (!field
->field_exists
&&
1475 field
->version_id
<= version_id
)) {
1476 void *base_addr
= opaque
+ field
->offset
;
1478 int size
= field
->size
;
1480 if (field
->flags
& VMS_VBUFFER
) {
1481 size
= *(int32_t *)(opaque
+field
->size_offset
);
1482 if (field
->flags
& VMS_MULTIPLY
) {
1483 size
*= field
->size
;
1486 if (field
->flags
& VMS_ARRAY
) {
1487 n_elems
= field
->num
;
1488 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1489 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1490 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1491 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1492 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1493 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1494 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1495 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1497 if (field
->flags
& VMS_POINTER
) {
1498 base_addr
= *(void **)base_addr
+ field
->start
;
1500 for (i
= 0; i
< n_elems
; i
++) {
1501 void *addr
= base_addr
+ size
* i
;
1503 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1504 addr
= *(void **)addr
;
1506 if (field
->flags
& VMS_STRUCT
) {
1507 ret
= vmstate_load_state(f
, field
->vmsd
, addr
, field
->vmsd
->version_id
);
1509 ret
= field
->info
->get(f
, addr
, size
);
1519 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
1523 if (vmsd
->post_load
) {
1524 return vmsd
->post_load(opaque
, version_id
);
1529 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1532 VMStateField
*field
= vmsd
->fields
;
1534 if (vmsd
->pre_save
) {
1535 vmsd
->pre_save(opaque
);
1537 while(field
->name
) {
1538 if (!field
->field_exists
||
1539 field
->field_exists(opaque
, vmsd
->version_id
)) {
1540 void *base_addr
= opaque
+ field
->offset
;
1542 int size
= field
->size
;
1544 if (field
->flags
& VMS_VBUFFER
) {
1545 size
= *(int32_t *)(opaque
+field
->size_offset
);
1546 if (field
->flags
& VMS_MULTIPLY
) {
1547 size
*= field
->size
;
1550 if (field
->flags
& VMS_ARRAY
) {
1551 n_elems
= field
->num
;
1552 } else if (field
->flags
& VMS_VARRAY_INT32
) {
1553 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
1554 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
1555 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
1556 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
1557 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
1558 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
1559 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
1561 if (field
->flags
& VMS_POINTER
) {
1562 base_addr
= *(void **)base_addr
+ field
->start
;
1564 for (i
= 0; i
< n_elems
; i
++) {
1565 void *addr
= base_addr
+ size
* i
;
1567 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
1568 addr
= *(void **)addr
;
1570 if (field
->flags
& VMS_STRUCT
) {
1571 vmstate_save_state(f
, field
->vmsd
, addr
);
1573 field
->info
->put(f
, addr
, size
);
1579 vmstate_subsection_save(f
, vmsd
, opaque
);
1582 static int vmstate_load(QEMUFile
*f
, SaveStateEntry
*se
, int version_id
)
1584 if (!se
->vmsd
) { /* Old style */
1585 return se
->ops
->load_state(f
, se
->opaque
, version_id
);
1587 return vmstate_load_state(f
, se
->vmsd
, se
->opaque
, version_id
);
1590 static void vmstate_save(QEMUFile
*f
, SaveStateEntry
*se
)
1592 if (!se
->vmsd
) { /* Old style */
1593 se
->ops
->save_state(f
, se
->opaque
);
1596 vmstate_save_state(f
,se
->vmsd
, se
->opaque
);
1599 #define QEMU_VM_FILE_MAGIC 0x5145564d
1600 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1601 #define QEMU_VM_FILE_VERSION 0x00000003
1603 #define QEMU_VM_EOF 0x00
1604 #define QEMU_VM_SECTION_START 0x01
1605 #define QEMU_VM_SECTION_PART 0x02
1606 #define QEMU_VM_SECTION_END 0x03
1607 #define QEMU_VM_SECTION_FULL 0x04
1608 #define QEMU_VM_SUBSECTION 0x05
1610 bool qemu_savevm_state_blocked(Error
**errp
)
1614 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1615 if (se
->no_migrate
) {
1616 error_set(errp
, QERR_MIGRATION_NOT_SUPPORTED
, se
->idstr
);
1623 void qemu_savevm_state_begin(QEMUFile
*f
,
1624 const MigrationParams
*params
)
1629 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1630 if (!se
->ops
|| !se
->ops
->set_params
) {
1633 se
->ops
->set_params(params
, se
->opaque
);
1636 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1637 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1639 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1642 if (!se
->ops
|| !se
->ops
->save_live_setup
) {
1645 if (se
->ops
&& se
->ops
->is_active
) {
1646 if (!se
->ops
->is_active(se
->opaque
)) {
1651 qemu_put_byte(f
, QEMU_VM_SECTION_START
);
1652 qemu_put_be32(f
, se
->section_id
);
1655 len
= strlen(se
->idstr
);
1656 qemu_put_byte(f
, len
);
1657 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1659 qemu_put_be32(f
, se
->instance_id
);
1660 qemu_put_be32(f
, se
->version_id
);
1662 ret
= se
->ops
->save_live_setup(f
, se
->opaque
);
1664 qemu_file_set_error(f
, ret
);
1671 * this function has three return values:
1672 * negative: there was one error, and we have -errno.
1673 * 0 : We haven't finished, caller have to go again
1674 * 1 : We have finished, we can go to complete phase
1676 int qemu_savevm_state_iterate(QEMUFile
*f
)
1681 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1682 if (!se
->ops
|| !se
->ops
->save_live_iterate
) {
1685 if (se
->ops
&& se
->ops
->is_active
) {
1686 if (!se
->ops
->is_active(se
->opaque
)) {
1690 if (qemu_file_rate_limit(f
)) {
1693 trace_savevm_section_start();
1695 qemu_put_byte(f
, QEMU_VM_SECTION_PART
);
1696 qemu_put_be32(f
, se
->section_id
);
1698 ret
= se
->ops
->save_live_iterate(f
, se
->opaque
);
1699 trace_savevm_section_end(se
->section_id
);
1702 qemu_file_set_error(f
, ret
);
1705 /* Do not proceed to the next vmstate before this one reported
1706 completion of the current stage. This serializes the migration
1707 and reduces the probability that a faster changing state is
1708 synchronized over and over again. */
1715 void qemu_savevm_state_complete(QEMUFile
*f
)
1720 cpu_synchronize_all_states();
1722 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1723 if (!se
->ops
|| !se
->ops
->save_live_complete
) {
1726 if (se
->ops
&& se
->ops
->is_active
) {
1727 if (!se
->ops
->is_active(se
->opaque
)) {
1731 trace_savevm_section_start();
1733 qemu_put_byte(f
, QEMU_VM_SECTION_END
);
1734 qemu_put_be32(f
, se
->section_id
);
1736 ret
= se
->ops
->save_live_complete(f
, se
->opaque
);
1737 trace_savevm_section_end(se
->section_id
);
1739 qemu_file_set_error(f
, ret
);
1744 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1747 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1750 trace_savevm_section_start();
1752 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1753 qemu_put_be32(f
, se
->section_id
);
1756 len
= strlen(se
->idstr
);
1757 qemu_put_byte(f
, len
);
1758 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1760 qemu_put_be32(f
, se
->instance_id
);
1761 qemu_put_be32(f
, se
->version_id
);
1763 vmstate_save(f
, se
);
1764 trace_savevm_section_end(se
->section_id
);
1767 qemu_put_byte(f
, QEMU_VM_EOF
);
1771 uint64_t qemu_savevm_state_pending(QEMUFile
*f
, uint64_t max_size
)
1776 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1777 if (!se
->ops
|| !se
->ops
->save_live_pending
) {
1780 if (se
->ops
&& se
->ops
->is_active
) {
1781 if (!se
->ops
->is_active(se
->opaque
)) {
1785 ret
+= se
->ops
->save_live_pending(f
, se
->opaque
, max_size
);
1790 void qemu_savevm_state_cancel(void)
1794 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1795 if (se
->ops
&& se
->ops
->cancel
) {
1796 se
->ops
->cancel(se
->opaque
);
1801 static int qemu_savevm_state(QEMUFile
*f
)
1804 MigrationParams params
= {
1809 if (qemu_savevm_state_blocked(NULL
)) {
1813 qemu_mutex_unlock_iothread();
1814 qemu_savevm_state_begin(f
, ¶ms
);
1815 qemu_mutex_lock_iothread();
1817 while (qemu_file_get_error(f
) == 0) {
1818 if (qemu_savevm_state_iterate(f
) > 0) {
1823 ret
= qemu_file_get_error(f
);
1825 qemu_savevm_state_complete(f
);
1826 ret
= qemu_file_get_error(f
);
1829 qemu_savevm_state_cancel();
1834 static int qemu_save_device_state(QEMUFile
*f
)
1838 qemu_put_be32(f
, QEMU_VM_FILE_MAGIC
);
1839 qemu_put_be32(f
, QEMU_VM_FILE_VERSION
);
1841 cpu_synchronize_all_states();
1843 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1849 if ((!se
->ops
|| !se
->ops
->save_state
) && !se
->vmsd
) {
1854 qemu_put_byte(f
, QEMU_VM_SECTION_FULL
);
1855 qemu_put_be32(f
, se
->section_id
);
1858 len
= strlen(se
->idstr
);
1859 qemu_put_byte(f
, len
);
1860 qemu_put_buffer(f
, (uint8_t *)se
->idstr
, len
);
1862 qemu_put_be32(f
, se
->instance_id
);
1863 qemu_put_be32(f
, se
->version_id
);
1865 vmstate_save(f
, se
);
1868 qemu_put_byte(f
, QEMU_VM_EOF
);
1870 return qemu_file_get_error(f
);
1873 static SaveStateEntry
*find_se(const char *idstr
, int instance_id
)
1877 QTAILQ_FOREACH(se
, &savevm_handlers
, entry
) {
1878 if (!strcmp(se
->idstr
, idstr
) &&
1879 (instance_id
== se
->instance_id
||
1880 instance_id
== se
->alias_id
))
1882 /* Migrating from an older version? */
1883 if (strstr(se
->idstr
, idstr
) && se
->compat
) {
1884 if (!strcmp(se
->compat
->idstr
, idstr
) &&
1885 (instance_id
== se
->compat
->instance_id
||
1886 instance_id
== se
->alias_id
))
1893 static const VMStateDescription
*vmstate_get_subsection(const VMStateSubsection
*sub
, char *idstr
)
1895 while(sub
&& sub
->needed
) {
1896 if (strcmp(idstr
, sub
->vmsd
->name
) == 0) {
1904 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1907 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
1910 uint8_t version_id
, len
, size
;
1911 const VMStateDescription
*sub_vmsd
;
1913 len
= qemu_peek_byte(f
, 1);
1914 if (len
< strlen(vmsd
->name
) + 1) {
1915 /* subsection name has be be "section_name/a" */
1918 size
= qemu_peek_buffer(f
, (uint8_t *)idstr
, len
, 2);
1924 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
1925 /* it don't have a valid subsection name */
1928 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
1929 if (sub_vmsd
== NULL
) {
1932 qemu_file_skip(f
, 1); /* subsection */
1933 qemu_file_skip(f
, 1); /* len */
1934 qemu_file_skip(f
, len
); /* idstr */
1935 version_id
= qemu_get_be32(f
);
1937 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
1945 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
1948 const VMStateSubsection
*sub
= vmsd
->subsections
;
1950 while (sub
&& sub
->needed
) {
1951 if (sub
->needed(opaque
)) {
1952 const VMStateDescription
*vmsd
= sub
->vmsd
;
1955 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
1956 len
= strlen(vmsd
->name
);
1957 qemu_put_byte(f
, len
);
1958 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
1959 qemu_put_be32(f
, vmsd
->version_id
);
1960 vmstate_save_state(f
, vmsd
, opaque
);
1966 typedef struct LoadStateEntry
{
1967 QLIST_ENTRY(LoadStateEntry
) entry
;
1973 int qemu_loadvm_state(QEMUFile
*f
)
1975 QLIST_HEAD(, LoadStateEntry
) loadvm_handlers
=
1976 QLIST_HEAD_INITIALIZER(loadvm_handlers
);
1977 LoadStateEntry
*le
, *new_le
;
1978 uint8_t section_type
;
1982 if (qemu_savevm_state_blocked(NULL
)) {
1986 v
= qemu_get_be32(f
);
1987 if (v
!= QEMU_VM_FILE_MAGIC
)
1990 v
= qemu_get_be32(f
);
1991 if (v
== QEMU_VM_FILE_VERSION_COMPAT
) {
1992 fprintf(stderr
, "SaveVM v2 format is obsolete and don't work anymore\n");
1995 if (v
!= QEMU_VM_FILE_VERSION
)
1998 while ((section_type
= qemu_get_byte(f
)) != QEMU_VM_EOF
) {
1999 uint32_t instance_id
, version_id
, section_id
;
2004 switch (section_type
) {
2005 case QEMU_VM_SECTION_START
:
2006 case QEMU_VM_SECTION_FULL
:
2007 /* Read section start */
2008 section_id
= qemu_get_be32(f
);
2009 len
= qemu_get_byte(f
);
2010 qemu_get_buffer(f
, (uint8_t *)idstr
, len
);
2012 instance_id
= qemu_get_be32(f
);
2013 version_id
= qemu_get_be32(f
);
2015 /* Find savevm section */
2016 se
= find_se(idstr
, instance_id
);
2018 fprintf(stderr
, "Unknown savevm section or instance '%s' %d\n", idstr
, instance_id
);
2023 /* Validate version */
2024 if (version_id
> se
->version_id
) {
2025 fprintf(stderr
, "savevm: unsupported version %d for '%s' v%d\n",
2026 version_id
, idstr
, se
->version_id
);
2032 le
= g_malloc0(sizeof(*le
));
2035 le
->section_id
= section_id
;
2036 le
->version_id
= version_id
;
2037 QLIST_INSERT_HEAD(&loadvm_handlers
, le
, entry
);
2039 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2041 fprintf(stderr
, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2042 instance_id
, idstr
);
2046 case QEMU_VM_SECTION_PART
:
2047 case QEMU_VM_SECTION_END
:
2048 section_id
= qemu_get_be32(f
);
2050 QLIST_FOREACH(le
, &loadvm_handlers
, entry
) {
2051 if (le
->section_id
== section_id
) {
2056 fprintf(stderr
, "Unknown savevm section %d\n", section_id
);
2061 ret
= vmstate_load(f
, le
->se
, le
->version_id
);
2063 fprintf(stderr
, "qemu: warning: error while loading state section id %d\n",
2069 fprintf(stderr
, "Unknown savevm section type %d\n", section_type
);
2075 cpu_synchronize_all_post_init();
2080 QLIST_FOREACH_SAFE(le
, &loadvm_handlers
, entry
, new_le
) {
2081 QLIST_REMOVE(le
, entry
);
2086 ret
= qemu_file_get_error(f
);
2092 static int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
2095 QEMUSnapshotInfo
*sn_tab
, *sn
;
2099 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2102 for(i
= 0; i
< nb_sns
; i
++) {
2104 if (!strcmp(sn
->id_str
, name
) || !strcmp(sn
->name
, name
)) {
2115 * Deletes snapshots of a given name in all opened images.
2117 static int del_existing_snapshots(Monitor
*mon
, const char *name
)
2119 BlockDriverState
*bs
;
2120 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
2124 while ((bs
= bdrv_next(bs
))) {
2125 if (bdrv_can_snapshot(bs
) &&
2126 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
2128 ret
= bdrv_snapshot_delete(bs
, name
);
2131 "Error while deleting snapshot on '%s'\n",
2132 bdrv_get_device_name(bs
));
2141 void do_savevm(Monitor
*mon
, const QDict
*qdict
)
2143 BlockDriverState
*bs
, *bs1
;
2144 QEMUSnapshotInfo sn1
, *sn
= &sn1
, old_sn1
, *old_sn
= &old_sn1
;
2147 int saved_vm_running
;
2148 uint64_t vm_state_size
;
2151 const char *name
= qdict_get_try_str(qdict
, "name");
2153 /* Verify if there is a device that doesn't support snapshots and is writable */
2155 while ((bs
= bdrv_next(bs
))) {
2157 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2161 if (!bdrv_can_snapshot(bs
)) {
2162 monitor_printf(mon
, "Device '%s' is writable but does not support snapshots.\n",
2163 bdrv_get_device_name(bs
));
2168 bs
= bdrv_snapshots();
2170 monitor_printf(mon
, "No block device can accept snapshots\n");
2174 saved_vm_running
= runstate_is_running();
2175 vm_stop(RUN_STATE_SAVE_VM
);
2177 memset(sn
, 0, sizeof(*sn
));
2179 /* fill auxiliary fields */
2180 qemu_gettimeofday(&tv
);
2181 sn
->date_sec
= tv
.tv_sec
;
2182 sn
->date_nsec
= tv
.tv_usec
* 1000;
2183 sn
->vm_clock_nsec
= qemu_get_clock_ns(vm_clock
);
2186 ret
= bdrv_snapshot_find(bs
, old_sn
, name
);
2188 pstrcpy(sn
->name
, sizeof(sn
->name
), old_sn
->name
);
2189 pstrcpy(sn
->id_str
, sizeof(sn
->id_str
), old_sn
->id_str
);
2191 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
2194 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2195 localtime_r((const time_t *)&tv
.tv_sec
, &tm
);
2196 strftime(sn
->name
, sizeof(sn
->name
), "vm-%Y%m%d%H%M%S", &tm
);
2199 /* Delete old snapshots of the same name */
2200 if (name
&& del_existing_snapshots(mon
, name
) < 0) {
2204 /* save the VM state */
2205 f
= qemu_fopen_bdrv(bs
, 1);
2207 monitor_printf(mon
, "Could not open VM state file\n");
2210 ret
= qemu_savevm_state(f
);
2211 vm_state_size
= qemu_ftell(f
);
2214 monitor_printf(mon
, "Error %d while writing VM\n", ret
);
2218 /* create the snapshots */
2221 while ((bs1
= bdrv_next(bs1
))) {
2222 if (bdrv_can_snapshot(bs1
)) {
2223 /* Write VM state size only to the image that contains the state */
2224 sn
->vm_state_size
= (bs
== bs1
? vm_state_size
: 0);
2225 ret
= bdrv_snapshot_create(bs1
, sn
);
2227 monitor_printf(mon
, "Error while creating snapshot on '%s'\n",
2228 bdrv_get_device_name(bs1
));
2234 if (saved_vm_running
)
2238 void qmp_xen_save_devices_state(const char *filename
, Error
**errp
)
2241 int saved_vm_running
;
2244 saved_vm_running
= runstate_is_running();
2245 vm_stop(RUN_STATE_SAVE_VM
);
2247 f
= qemu_fopen(filename
, "wb");
2249 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
2252 ret
= qemu_save_device_state(f
);
2255 error_set(errp
, QERR_IO_ERROR
);
2259 if (saved_vm_running
)
2263 int load_vmstate(const char *name
)
2265 BlockDriverState
*bs
, *bs_vm_state
;
2266 QEMUSnapshotInfo sn
;
2270 bs_vm_state
= bdrv_snapshots();
2272 error_report("No block device supports snapshots");
2276 /* Don't even try to load empty VM states */
2277 ret
= bdrv_snapshot_find(bs_vm_state
, &sn
, name
);
2280 } else if (sn
.vm_state_size
== 0) {
2281 error_report("This is a disk-only snapshot. Revert to it offline "
2286 /* Verify if there is any device that doesn't support snapshots and is
2287 writable and check if the requested snapshot is available too. */
2289 while ((bs
= bdrv_next(bs
))) {
2291 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2295 if (!bdrv_can_snapshot(bs
)) {
2296 error_report("Device '%s' is writable but does not support snapshots.",
2297 bdrv_get_device_name(bs
));
2301 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
2303 error_report("Device '%s' does not have the requested snapshot '%s'",
2304 bdrv_get_device_name(bs
), name
);
2309 /* Flush all IO requests so they don't interfere with the new state. */
2313 while ((bs
= bdrv_next(bs
))) {
2314 if (bdrv_can_snapshot(bs
)) {
2315 ret
= bdrv_snapshot_goto(bs
, name
);
2317 error_report("Error %d while activating snapshot '%s' on '%s'",
2318 ret
, name
, bdrv_get_device_name(bs
));
2324 /* restore the VM state */
2325 f
= qemu_fopen_bdrv(bs_vm_state
, 0);
2327 error_report("Could not open VM state file");
2331 qemu_system_reset(VMRESET_SILENT
);
2332 ret
= qemu_loadvm_state(f
);
2336 error_report("Error %d while loading VM state", ret
);
2343 void do_delvm(Monitor
*mon
, const QDict
*qdict
)
2345 BlockDriverState
*bs
, *bs1
;
2347 const char *name
= qdict_get_str(qdict
, "name");
2349 bs
= bdrv_snapshots();
2351 monitor_printf(mon
, "No block device supports snapshots\n");
2356 while ((bs1
= bdrv_next(bs1
))) {
2357 if (bdrv_can_snapshot(bs1
)) {
2358 ret
= bdrv_snapshot_delete(bs1
, name
);
2360 if (ret
== -ENOTSUP
)
2362 "Snapshots not supported on device '%s'\n",
2363 bdrv_get_device_name(bs1
));
2365 monitor_printf(mon
, "Error %d while deleting snapshot on "
2366 "'%s'\n", ret
, bdrv_get_device_name(bs1
));
2372 void do_info_snapshots(Monitor
*mon
, const QDict
*qdict
)
2374 BlockDriverState
*bs
, *bs1
;
2375 QEMUSnapshotInfo
*sn_tab
, *sn
, s
, *sn_info
= &s
;
2376 int nb_sns
, i
, ret
, available
;
2378 int *available_snapshots
;
2381 bs
= bdrv_snapshots();
2383 monitor_printf(mon
, "No available block device supports snapshots\n");
2387 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2389 monitor_printf(mon
, "bdrv_snapshot_list: error %d\n", nb_sns
);
2394 monitor_printf(mon
, "There is no snapshot available.\n");
2398 available_snapshots
= g_malloc0(sizeof(int) * nb_sns
);
2400 for (i
= 0; i
< nb_sns
; i
++) {
2405 while ((bs1
= bdrv_next(bs1
))) {
2406 if (bdrv_can_snapshot(bs1
) && bs1
!= bs
) {
2407 ret
= bdrv_snapshot_find(bs1
, sn_info
, sn
->id_str
);
2416 available_snapshots
[total
] = i
;
2422 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
2423 for (i
= 0; i
< total
; i
++) {
2424 sn
= &sn_tab
[available_snapshots
[i
]];
2425 monitor_printf(mon
, "%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
2428 monitor_printf(mon
, "There is no suitable snapshot available\n");
2432 g_free(available_snapshots
);
2436 void vmstate_register_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2438 qemu_ram_set_idstr(memory_region_get_ram_addr(mr
) & TARGET_PAGE_MASK
,
2439 memory_region_name(mr
), dev
);
2442 void vmstate_unregister_ram(MemoryRegion
*mr
, DeviceState
*dev
)
2444 /* Nothing do to while the implementation is in RAMBlock */
2447 void vmstate_register_ram_global(MemoryRegion
*mr
)
2449 vmstate_register_ram(mr
, NULL
);