glib: Add compat wrapper for g_poll on old glib
[qemu/pbrook.git] / savevm.c
bloba8a53efc9bcec800dcd4d4e266b2ecad41f99584
1 /*
2 * QEMU System Emulator
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
22 * THE SOFTWARE.
25 #include "config-host.h"
26 #include "qemu-common.h"
27 #include "hw/hw.h"
28 #include "hw/qdev.h"
29 #include "net/net.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"
40 #include "trace.h"
41 #include "qemu/bitops.h"
43 #define SELF_ANNOUNCE_ROUNDS 5
45 #ifndef ETH_P_RARP
46 #define ETH_P_RARP 0x8035
47 #endif
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,
53 uint8_t *mac_addr)
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 */
60 /* RARP header. */
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)
79 uint8_t buf[60];
80 int len;
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);
95 if (--count) {
96 /* delay 50ms, 150ms, 250ms, ... */
97 qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
98 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
99 } else {
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
117 struct QEMUFile {
118 const QEMUFileOps *ops;
119 void *opaque;
120 int is_write;
122 int64_t buf_offset; /* start of buffer when writing, end of buffer
123 when reading */
124 int buf_index;
125 int buf_size; /* 0 when writing */
126 uint8_t buf[IO_BUF_SIZE];
128 int last_error;
131 typedef struct QEMUFileStdio
133 FILE *stdio_file;
134 QEMUFile *file;
135 } QEMUFileStdio;
137 typedef struct QEMUFileSocket
139 int fd;
140 QEMUFile *file;
141 } QEMUFileSocket;
143 typedef struct {
144 Coroutine *co;
145 int fd;
146 } FDYieldUntilData;
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();
166 data.fd = fd;
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;
175 return s->fd;
178 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
180 QEMUFileSocket *s = opaque;
181 ssize_t len;
183 for (;;) {
184 len = qemu_recv(s->fd, buf, size, 0);
185 if (len != -1) {
186 break;
188 if (socket_error() == EAGAIN) {
189 yield_until_fd_readable(s->fd);
190 } else if (socket_error() != EINTR) {
191 break;
195 if (len == -1) {
196 len = -socket_error();
198 return len;
201 static int socket_close(void *opaque)
203 QEMUFileSocket *s = opaque;
204 closesocket(s->fd);
205 g_free(s);
206 return 0;
209 static int stdio_get_fd(void *opaque)
211 QEMUFileStdio *s = opaque;
213 return fileno(s->stdio_file);
216 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
218 QEMUFileStdio *s = opaque;
219 return fwrite(buf, 1, size, s->stdio_file);
222 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
224 QEMUFileStdio *s = opaque;
225 FILE *fp = s->stdio_file;
226 int bytes;
228 for (;;) {
229 clearerr(fp);
230 bytes = fread(buf, 1, size, fp);
231 if (bytes != 0 || !ferror(fp)) {
232 break;
234 if (errno == EAGAIN) {
235 yield_until_fd_readable(fileno(fp));
236 } else if (errno != EINTR) {
237 break;
240 return bytes;
243 static int stdio_pclose(void *opaque)
245 QEMUFileStdio *s = opaque;
246 int ret;
247 ret = pclose(s->stdio_file);
248 if (ret == -1) {
249 ret = -errno;
251 g_free(s);
252 return ret;
255 static int stdio_fclose(void *opaque)
257 QEMUFileStdio *s = opaque;
258 int ret = 0;
259 if (fclose(s->stdio_file) == EOF) {
260 ret = -errno;
262 g_free(s);
263 return ret;
266 static const QEMUFileOps stdio_pipe_read_ops = {
267 .get_fd = stdio_get_fd,
268 .get_buffer = stdio_get_buffer,
269 .close = stdio_pclose
272 static const QEMUFileOps stdio_pipe_write_ops = {
273 .get_fd = stdio_get_fd,
274 .put_buffer = stdio_put_buffer,
275 .close = stdio_pclose
278 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
280 QEMUFileStdio *s;
282 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
283 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
284 return NULL;
287 s = g_malloc0(sizeof(QEMUFileStdio));
289 s->stdio_file = stdio_file;
291 if(mode[0] == 'r') {
292 s->file = qemu_fopen_ops(s, &stdio_pipe_read_ops);
293 } else {
294 s->file = qemu_fopen_ops(s, &stdio_pipe_write_ops);
296 return s->file;
299 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
301 FILE *popen_file;
303 popen_file = popen(command, mode);
304 if(popen_file == NULL) {
305 return NULL;
308 return qemu_popen(popen_file, mode);
311 static const QEMUFileOps stdio_file_read_ops = {
312 .get_fd = stdio_get_fd,
313 .get_buffer = stdio_get_buffer,
314 .close = stdio_fclose
317 static const QEMUFileOps stdio_file_write_ops = {
318 .get_fd = stdio_get_fd,
319 .put_buffer = stdio_put_buffer,
320 .close = stdio_fclose
323 QEMUFile *qemu_fdopen(int fd, const char *mode)
325 QEMUFileStdio *s;
327 if (mode == NULL ||
328 (mode[0] != 'r' && mode[0] != 'w') ||
329 mode[1] != 'b' || mode[2] != 0) {
330 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
331 return NULL;
334 s = g_malloc0(sizeof(QEMUFileStdio));
335 s->stdio_file = fdopen(fd, mode);
336 if (!s->stdio_file)
337 goto fail;
339 if(mode[0] == 'r') {
340 s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
341 } else {
342 s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
344 return s->file;
346 fail:
347 g_free(s);
348 return NULL;
351 static const QEMUFileOps socket_read_ops = {
352 .get_fd = socket_get_fd,
353 .get_buffer = socket_get_buffer,
354 .close = socket_close
357 QEMUFile *qemu_fopen_socket(int fd)
359 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
361 s->fd = fd;
362 s->file = qemu_fopen_ops(s, &socket_read_ops);
363 return s->file;
366 QEMUFile *qemu_fopen(const char *filename, const char *mode)
368 QEMUFileStdio *s;
370 if (mode == NULL ||
371 (mode[0] != 'r' && mode[0] != 'w') ||
372 mode[1] != 'b' || mode[2] != 0) {
373 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
374 return NULL;
377 s = g_malloc0(sizeof(QEMUFileStdio));
379 s->stdio_file = fopen(filename, mode);
380 if (!s->stdio_file)
381 goto fail;
383 if(mode[0] == 'w') {
384 s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
385 } else {
386 s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
388 return s->file;
389 fail:
390 g_free(s);
391 return NULL;
394 static int block_put_buffer(void *opaque, const uint8_t *buf,
395 int64_t pos, int size)
397 bdrv_save_vmstate(opaque, buf, pos, size);
398 return size;
401 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
403 return bdrv_load_vmstate(opaque, buf, pos, size);
406 static int bdrv_fclose(void *opaque)
408 return bdrv_flush(opaque);
411 static const QEMUFileOps bdrv_read_ops = {
412 .get_buffer = block_get_buffer,
413 .close = bdrv_fclose
416 static const QEMUFileOps bdrv_write_ops = {
417 .put_buffer = block_put_buffer,
418 .close = bdrv_fclose
421 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
423 if (is_writable)
424 return qemu_fopen_ops(bs, &bdrv_write_ops);
425 return qemu_fopen_ops(bs, &bdrv_read_ops);
428 QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops)
430 QEMUFile *f;
432 f = g_malloc0(sizeof(QEMUFile));
434 f->opaque = opaque;
435 f->ops = ops;
436 f->is_write = 0;
438 return f;
441 int qemu_file_get_error(QEMUFile *f)
443 return f->last_error;
446 static void qemu_file_set_error(QEMUFile *f, int ret)
448 if (f->last_error == 0) {
449 f->last_error = ret;
453 /** Flushes QEMUFile buffer
456 static int qemu_fflush(QEMUFile *f)
458 int ret = 0;
460 if (!f->ops->put_buffer)
461 return 0;
463 if (f->is_write && f->buf_index > 0) {
464 ret = f->ops->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
465 if (ret >= 0) {
466 f->buf_offset += f->buf_index;
468 f->buf_index = 0;
470 return ret;
473 static void qemu_fill_buffer(QEMUFile *f)
475 int len;
476 int pending;
478 if (!f->ops->get_buffer)
479 return;
481 if (f->is_write)
482 abort();
484 pending = f->buf_size - f->buf_index;
485 if (pending > 0) {
486 memmove(f->buf, f->buf + f->buf_index, pending);
488 f->buf_index = 0;
489 f->buf_size = pending;
491 len = f->ops->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
492 IO_BUF_SIZE - pending);
493 if (len > 0) {
494 f->buf_size += len;
495 f->buf_offset += len;
496 } else if (len == 0) {
497 qemu_file_set_error(f, -EIO);
498 } else if (len != -EAGAIN)
499 qemu_file_set_error(f, len);
502 int qemu_get_fd(QEMUFile *f)
504 if (f->ops->get_fd) {
505 return f->ops->get_fd(f->opaque);
507 return -1;
510 /** Closes the file
512 * Returns negative error value if any error happened on previous operations or
513 * while closing the file. Returns 0 or positive number on success.
515 * The meaning of return value on success depends on the specific backend
516 * being used.
518 int qemu_fclose(QEMUFile *f)
520 int ret;
521 ret = qemu_fflush(f);
523 if (f->ops->close) {
524 int ret2 = f->ops->close(f->opaque);
525 if (ret >= 0) {
526 ret = ret2;
529 /* If any error was spotted before closing, we should report it
530 * instead of the close() return value.
532 if (f->last_error) {
533 ret = f->last_error;
535 g_free(f);
536 return ret;
539 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
541 int l;
543 if (f->last_error) {
544 return;
547 if (f->is_write == 0 && f->buf_index > 0) {
548 fprintf(stderr,
549 "Attempted to write to buffer while read buffer is not empty\n");
550 abort();
553 while (size > 0) {
554 l = IO_BUF_SIZE - f->buf_index;
555 if (l > size)
556 l = size;
557 memcpy(f->buf + f->buf_index, buf, l);
558 f->is_write = 1;
559 f->buf_index += l;
560 buf += l;
561 size -= l;
562 if (f->buf_index >= IO_BUF_SIZE) {
563 int ret = qemu_fflush(f);
564 if (ret < 0) {
565 qemu_file_set_error(f, ret);
566 break;
572 void qemu_put_byte(QEMUFile *f, int v)
574 if (f->last_error) {
575 return;
578 if (f->is_write == 0 && f->buf_index > 0) {
579 fprintf(stderr,
580 "Attempted to write to buffer while read buffer is not empty\n");
581 abort();
584 f->buf[f->buf_index++] = v;
585 f->is_write = 1;
586 if (f->buf_index >= IO_BUF_SIZE) {
587 int ret = qemu_fflush(f);
588 if (ret < 0) {
589 qemu_file_set_error(f, ret);
594 static void qemu_file_skip(QEMUFile *f, int size)
596 if (f->buf_index + size <= f->buf_size) {
597 f->buf_index += size;
601 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
603 int pending;
604 int index;
606 if (f->is_write) {
607 abort();
610 index = f->buf_index + offset;
611 pending = f->buf_size - index;
612 if (pending < size) {
613 qemu_fill_buffer(f);
614 index = f->buf_index + offset;
615 pending = f->buf_size - index;
618 if (pending <= 0) {
619 return 0;
621 if (size > pending) {
622 size = pending;
625 memcpy(buf, f->buf + index, size);
626 return size;
629 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
631 int pending = size;
632 int done = 0;
634 while (pending > 0) {
635 int res;
637 res = qemu_peek_buffer(f, buf, pending, 0);
638 if (res == 0) {
639 return done;
641 qemu_file_skip(f, res);
642 buf += res;
643 pending -= res;
644 done += res;
646 return done;
649 static int qemu_peek_byte(QEMUFile *f, int offset)
651 int index = f->buf_index + offset;
653 if (f->is_write) {
654 abort();
657 if (index >= f->buf_size) {
658 qemu_fill_buffer(f);
659 index = f->buf_index + offset;
660 if (index >= f->buf_size) {
661 return 0;
664 return f->buf[index];
667 int qemu_get_byte(QEMUFile *f)
669 int result;
671 result = qemu_peek_byte(f, 0);
672 qemu_file_skip(f, 1);
673 return result;
676 int64_t qemu_ftell(QEMUFile *f)
678 /* buf_offset excludes buffer for writing but includes it for reading */
679 if (f->is_write) {
680 return f->buf_offset + f->buf_index;
681 } else {
682 return f->buf_offset - f->buf_size + f->buf_index;
686 int qemu_file_rate_limit(QEMUFile *f)
688 if (f->ops->rate_limit)
689 return f->ops->rate_limit(f->opaque);
691 return 0;
694 int64_t qemu_file_get_rate_limit(QEMUFile *f)
696 if (f->ops->get_rate_limit)
697 return f->ops->get_rate_limit(f->opaque);
699 return 0;
702 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
704 /* any failed or completed migration keeps its state to allow probing of
705 * migration data, but has no associated file anymore */
706 if (f && f->ops->set_rate_limit)
707 return f->ops->set_rate_limit(f->opaque, new_rate);
709 return 0;
712 void qemu_put_be16(QEMUFile *f, unsigned int v)
714 qemu_put_byte(f, v >> 8);
715 qemu_put_byte(f, v);
718 void qemu_put_be32(QEMUFile *f, unsigned int v)
720 qemu_put_byte(f, v >> 24);
721 qemu_put_byte(f, v >> 16);
722 qemu_put_byte(f, v >> 8);
723 qemu_put_byte(f, v);
726 void qemu_put_be64(QEMUFile *f, uint64_t v)
728 qemu_put_be32(f, v >> 32);
729 qemu_put_be32(f, v);
732 unsigned int qemu_get_be16(QEMUFile *f)
734 unsigned int v;
735 v = qemu_get_byte(f) << 8;
736 v |= qemu_get_byte(f);
737 return v;
740 unsigned int qemu_get_be32(QEMUFile *f)
742 unsigned int v;
743 v = qemu_get_byte(f) << 24;
744 v |= qemu_get_byte(f) << 16;
745 v |= qemu_get_byte(f) << 8;
746 v |= qemu_get_byte(f);
747 return v;
750 uint64_t qemu_get_be64(QEMUFile *f)
752 uint64_t v;
753 v = (uint64_t)qemu_get_be32(f) << 32;
754 v |= qemu_get_be32(f);
755 return v;
759 /* timer */
761 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
763 uint64_t expire_time;
765 expire_time = qemu_timer_expire_time_ns(ts);
766 qemu_put_be64(f, expire_time);
769 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
771 uint64_t expire_time;
773 expire_time = qemu_get_be64(f);
774 if (expire_time != -1) {
775 qemu_mod_timer_ns(ts, expire_time);
776 } else {
777 qemu_del_timer(ts);
782 /* bool */
784 static int get_bool(QEMUFile *f, void *pv, size_t size)
786 bool *v = pv;
787 *v = qemu_get_byte(f);
788 return 0;
791 static void put_bool(QEMUFile *f, void *pv, size_t size)
793 bool *v = pv;
794 qemu_put_byte(f, *v);
797 const VMStateInfo vmstate_info_bool = {
798 .name = "bool",
799 .get = get_bool,
800 .put = put_bool,
803 /* 8 bit int */
805 static int get_int8(QEMUFile *f, void *pv, size_t size)
807 int8_t *v = pv;
808 qemu_get_s8s(f, v);
809 return 0;
812 static void put_int8(QEMUFile *f, void *pv, size_t size)
814 int8_t *v = pv;
815 qemu_put_s8s(f, v);
818 const VMStateInfo vmstate_info_int8 = {
819 .name = "int8",
820 .get = get_int8,
821 .put = put_int8,
824 /* 16 bit int */
826 static int get_int16(QEMUFile *f, void *pv, size_t size)
828 int16_t *v = pv;
829 qemu_get_sbe16s(f, v);
830 return 0;
833 static void put_int16(QEMUFile *f, void *pv, size_t size)
835 int16_t *v = pv;
836 qemu_put_sbe16s(f, v);
839 const VMStateInfo vmstate_info_int16 = {
840 .name = "int16",
841 .get = get_int16,
842 .put = put_int16,
845 /* 32 bit int */
847 static int get_int32(QEMUFile *f, void *pv, size_t size)
849 int32_t *v = pv;
850 qemu_get_sbe32s(f, v);
851 return 0;
854 static void put_int32(QEMUFile *f, void *pv, size_t size)
856 int32_t *v = pv;
857 qemu_put_sbe32s(f, v);
860 const VMStateInfo vmstate_info_int32 = {
861 .name = "int32",
862 .get = get_int32,
863 .put = put_int32,
866 /* 32 bit int. See that the received value is the same than the one
867 in the field */
869 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
871 int32_t *v = pv;
872 int32_t v2;
873 qemu_get_sbe32s(f, &v2);
875 if (*v == v2)
876 return 0;
877 return -EINVAL;
880 const VMStateInfo vmstate_info_int32_equal = {
881 .name = "int32 equal",
882 .get = get_int32_equal,
883 .put = put_int32,
886 /* 32 bit int. See that the received value is the less or the same
887 than the one in the field */
889 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
891 int32_t *old = pv;
892 int32_t new;
893 qemu_get_sbe32s(f, &new);
895 if (*old <= new)
896 return 0;
897 return -EINVAL;
900 const VMStateInfo vmstate_info_int32_le = {
901 .name = "int32 equal",
902 .get = get_int32_le,
903 .put = put_int32,
906 /* 64 bit int */
908 static int get_int64(QEMUFile *f, void *pv, size_t size)
910 int64_t *v = pv;
911 qemu_get_sbe64s(f, v);
912 return 0;
915 static void put_int64(QEMUFile *f, void *pv, size_t size)
917 int64_t *v = pv;
918 qemu_put_sbe64s(f, v);
921 const VMStateInfo vmstate_info_int64 = {
922 .name = "int64",
923 .get = get_int64,
924 .put = put_int64,
927 /* 8 bit unsigned int */
929 static int get_uint8(QEMUFile *f, void *pv, size_t size)
931 uint8_t *v = pv;
932 qemu_get_8s(f, v);
933 return 0;
936 static void put_uint8(QEMUFile *f, void *pv, size_t size)
938 uint8_t *v = pv;
939 qemu_put_8s(f, v);
942 const VMStateInfo vmstate_info_uint8 = {
943 .name = "uint8",
944 .get = get_uint8,
945 .put = put_uint8,
948 /* 16 bit unsigned int */
950 static int get_uint16(QEMUFile *f, void *pv, size_t size)
952 uint16_t *v = pv;
953 qemu_get_be16s(f, v);
954 return 0;
957 static void put_uint16(QEMUFile *f, void *pv, size_t size)
959 uint16_t *v = pv;
960 qemu_put_be16s(f, v);
963 const VMStateInfo vmstate_info_uint16 = {
964 .name = "uint16",
965 .get = get_uint16,
966 .put = put_uint16,
969 /* 32 bit unsigned int */
971 static int get_uint32(QEMUFile *f, void *pv, size_t size)
973 uint32_t *v = pv;
974 qemu_get_be32s(f, v);
975 return 0;
978 static void put_uint32(QEMUFile *f, void *pv, size_t size)
980 uint32_t *v = pv;
981 qemu_put_be32s(f, v);
984 const VMStateInfo vmstate_info_uint32 = {
985 .name = "uint32",
986 .get = get_uint32,
987 .put = put_uint32,
990 /* 32 bit uint. See that the received value is the same than the one
991 in the field */
993 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
995 uint32_t *v = pv;
996 uint32_t v2;
997 qemu_get_be32s(f, &v2);
999 if (*v == v2) {
1000 return 0;
1002 return -EINVAL;
1005 const VMStateInfo vmstate_info_uint32_equal = {
1006 .name = "uint32 equal",
1007 .get = get_uint32_equal,
1008 .put = put_uint32,
1011 /* 64 bit unsigned int */
1013 static int get_uint64(QEMUFile *f, void *pv, size_t size)
1015 uint64_t *v = pv;
1016 qemu_get_be64s(f, v);
1017 return 0;
1020 static void put_uint64(QEMUFile *f, void *pv, size_t size)
1022 uint64_t *v = pv;
1023 qemu_put_be64s(f, v);
1026 const VMStateInfo vmstate_info_uint64 = {
1027 .name = "uint64",
1028 .get = get_uint64,
1029 .put = put_uint64,
1032 /* 8 bit int. See that the received value is the same than the one
1033 in the field */
1035 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
1037 uint8_t *v = pv;
1038 uint8_t v2;
1039 qemu_get_8s(f, &v2);
1041 if (*v == v2)
1042 return 0;
1043 return -EINVAL;
1046 const VMStateInfo vmstate_info_uint8_equal = {
1047 .name = "uint8 equal",
1048 .get = get_uint8_equal,
1049 .put = put_uint8,
1052 /* 16 bit unsigned int int. See that the received value is the same than the one
1053 in the field */
1055 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1057 uint16_t *v = pv;
1058 uint16_t v2;
1059 qemu_get_be16s(f, &v2);
1061 if (*v == v2)
1062 return 0;
1063 return -EINVAL;
1066 const VMStateInfo vmstate_info_uint16_equal = {
1067 .name = "uint16 equal",
1068 .get = get_uint16_equal,
1069 .put = put_uint16,
1072 /* timers */
1074 static int get_timer(QEMUFile *f, void *pv, size_t size)
1076 QEMUTimer *v = pv;
1077 qemu_get_timer(f, v);
1078 return 0;
1081 static void put_timer(QEMUFile *f, void *pv, size_t size)
1083 QEMUTimer *v = pv;
1084 qemu_put_timer(f, v);
1087 const VMStateInfo vmstate_info_timer = {
1088 .name = "timer",
1089 .get = get_timer,
1090 .put = put_timer,
1093 /* uint8_t buffers */
1095 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1097 uint8_t *v = pv;
1098 qemu_get_buffer(f, v, size);
1099 return 0;
1102 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1104 uint8_t *v = pv;
1105 qemu_put_buffer(f, v, size);
1108 const VMStateInfo vmstate_info_buffer = {
1109 .name = "buffer",
1110 .get = get_buffer,
1111 .put = put_buffer,
1114 /* unused buffers: space that was used for some fields that are
1115 not useful anymore */
1117 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1119 uint8_t buf[1024];
1120 int block_len;
1122 while (size > 0) {
1123 block_len = MIN(sizeof(buf), size);
1124 size -= block_len;
1125 qemu_get_buffer(f, buf, block_len);
1127 return 0;
1130 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1132 static const uint8_t buf[1024];
1133 int block_len;
1135 while (size > 0) {
1136 block_len = MIN(sizeof(buf), size);
1137 size -= block_len;
1138 qemu_put_buffer(f, buf, block_len);
1142 const VMStateInfo vmstate_info_unused_buffer = {
1143 .name = "unused_buffer",
1144 .get = get_unused_buffer,
1145 .put = put_unused_buffer,
1148 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1149 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1150 * bit words with the bits in big endian order. The in-memory format
1151 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1153 /* This is the number of 64 bit words sent over the wire */
1154 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1155 static int get_bitmap(QEMUFile *f, void *pv, size_t size)
1157 unsigned long *bmp = pv;
1158 int i, idx = 0;
1159 for (i = 0; i < BITS_TO_U64S(size); i++) {
1160 uint64_t w = qemu_get_be64(f);
1161 bmp[idx++] = w;
1162 if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
1163 bmp[idx++] = w >> 32;
1166 return 0;
1169 static void put_bitmap(QEMUFile *f, void *pv, size_t size)
1171 unsigned long *bmp = pv;
1172 int i, idx = 0;
1173 for (i = 0; i < BITS_TO_U64S(size); i++) {
1174 uint64_t w = bmp[idx++];
1175 if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
1176 w |= ((uint64_t)bmp[idx++]) << 32;
1178 qemu_put_be64(f, w);
1182 const VMStateInfo vmstate_info_bitmap = {
1183 .name = "bitmap",
1184 .get = get_bitmap,
1185 .put = put_bitmap,
1188 typedef struct CompatEntry {
1189 char idstr[256];
1190 int instance_id;
1191 } CompatEntry;
1193 typedef struct SaveStateEntry {
1194 QTAILQ_ENTRY(SaveStateEntry) entry;
1195 char idstr[256];
1196 int instance_id;
1197 int alias_id;
1198 int version_id;
1199 int section_id;
1200 SaveVMHandlers *ops;
1201 const VMStateDescription *vmsd;
1202 void *opaque;
1203 CompatEntry *compat;
1204 int no_migrate;
1205 int is_ram;
1206 } SaveStateEntry;
1209 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1210 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1211 static int global_section_id;
1213 static int calculate_new_instance_id(const char *idstr)
1215 SaveStateEntry *se;
1216 int instance_id = 0;
1218 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1219 if (strcmp(idstr, se->idstr) == 0
1220 && instance_id <= se->instance_id) {
1221 instance_id = se->instance_id + 1;
1224 return instance_id;
1227 static int calculate_compat_instance_id(const char *idstr)
1229 SaveStateEntry *se;
1230 int instance_id = 0;
1232 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1233 if (!se->compat)
1234 continue;
1236 if (strcmp(idstr, se->compat->idstr) == 0
1237 && instance_id <= se->compat->instance_id) {
1238 instance_id = se->compat->instance_id + 1;
1241 return instance_id;
1244 /* TODO: Individual devices generally have very little idea about the rest
1245 of the system, so instance_id should be removed/replaced.
1246 Meanwhile pass -1 as instance_id if you do not already have a clearly
1247 distinguishing id for all instances of your device class. */
1248 int register_savevm_live(DeviceState *dev,
1249 const char *idstr,
1250 int instance_id,
1251 int version_id,
1252 SaveVMHandlers *ops,
1253 void *opaque)
1255 SaveStateEntry *se;
1257 se = g_malloc0(sizeof(SaveStateEntry));
1258 se->version_id = version_id;
1259 se->section_id = global_section_id++;
1260 se->ops = ops;
1261 se->opaque = opaque;
1262 se->vmsd = NULL;
1263 se->no_migrate = 0;
1264 /* if this is a live_savem then set is_ram */
1265 if (ops->save_live_setup != NULL) {
1266 se->is_ram = 1;
1269 if (dev) {
1270 char *id = qdev_get_dev_path(dev);
1271 if (id) {
1272 pstrcpy(se->idstr, sizeof(se->idstr), id);
1273 pstrcat(se->idstr, sizeof(se->idstr), "/");
1274 g_free(id);
1276 se->compat = g_malloc0(sizeof(CompatEntry));
1277 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1278 se->compat->instance_id = instance_id == -1 ?
1279 calculate_compat_instance_id(idstr) : instance_id;
1280 instance_id = -1;
1283 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1285 if (instance_id == -1) {
1286 se->instance_id = calculate_new_instance_id(se->idstr);
1287 } else {
1288 se->instance_id = instance_id;
1290 assert(!se->compat || se->instance_id == 0);
1291 /* add at the end of list */
1292 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1293 return 0;
1296 int register_savevm(DeviceState *dev,
1297 const char *idstr,
1298 int instance_id,
1299 int version_id,
1300 SaveStateHandler *save_state,
1301 LoadStateHandler *load_state,
1302 void *opaque)
1304 SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
1305 ops->save_state = save_state;
1306 ops->load_state = load_state;
1307 return register_savevm_live(dev, idstr, instance_id, version_id,
1308 ops, opaque);
1311 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1313 SaveStateEntry *se, *new_se;
1314 char id[256] = "";
1316 if (dev) {
1317 char *path = qdev_get_dev_path(dev);
1318 if (path) {
1319 pstrcpy(id, sizeof(id), path);
1320 pstrcat(id, sizeof(id), "/");
1321 g_free(path);
1324 pstrcat(id, sizeof(id), idstr);
1326 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1327 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1328 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1329 if (se->compat) {
1330 g_free(se->compat);
1332 g_free(se->ops);
1333 g_free(se);
1338 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1339 const VMStateDescription *vmsd,
1340 void *opaque, int alias_id,
1341 int required_for_version)
1343 SaveStateEntry *se;
1345 /* If this triggers, alias support can be dropped for the vmsd. */
1346 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1348 se = g_malloc0(sizeof(SaveStateEntry));
1349 se->version_id = vmsd->version_id;
1350 se->section_id = global_section_id++;
1351 se->opaque = opaque;
1352 se->vmsd = vmsd;
1353 se->alias_id = alias_id;
1354 se->no_migrate = vmsd->unmigratable;
1356 if (dev) {
1357 char *id = qdev_get_dev_path(dev);
1358 if (id) {
1359 pstrcpy(se->idstr, sizeof(se->idstr), id);
1360 pstrcat(se->idstr, sizeof(se->idstr), "/");
1361 g_free(id);
1363 se->compat = g_malloc0(sizeof(CompatEntry));
1364 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1365 se->compat->instance_id = instance_id == -1 ?
1366 calculate_compat_instance_id(vmsd->name) : instance_id;
1367 instance_id = -1;
1370 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1372 if (instance_id == -1) {
1373 se->instance_id = calculate_new_instance_id(se->idstr);
1374 } else {
1375 se->instance_id = instance_id;
1377 assert(!se->compat || se->instance_id == 0);
1378 /* add at the end of list */
1379 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1380 return 0;
1383 int vmstate_register(DeviceState *dev, int instance_id,
1384 const VMStateDescription *vmsd, void *opaque)
1386 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1387 opaque, -1, 0);
1390 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1391 void *opaque)
1393 SaveStateEntry *se, *new_se;
1395 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1396 if (se->vmsd == vmsd && se->opaque == opaque) {
1397 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1398 if (se->compat) {
1399 g_free(se->compat);
1401 g_free(se);
1406 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1407 void *opaque);
1408 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1409 void *opaque);
1411 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1412 void *opaque, int version_id)
1414 VMStateField *field = vmsd->fields;
1415 int ret;
1417 if (version_id > vmsd->version_id) {
1418 return -EINVAL;
1420 if (version_id < vmsd->minimum_version_id_old) {
1421 return -EINVAL;
1423 if (version_id < vmsd->minimum_version_id) {
1424 return vmsd->load_state_old(f, opaque, version_id);
1426 if (vmsd->pre_load) {
1427 int ret = vmsd->pre_load(opaque);
1428 if (ret)
1429 return ret;
1431 while(field->name) {
1432 if ((field->field_exists &&
1433 field->field_exists(opaque, version_id)) ||
1434 (!field->field_exists &&
1435 field->version_id <= version_id)) {
1436 void *base_addr = opaque + field->offset;
1437 int i, n_elems = 1;
1438 int size = field->size;
1440 if (field->flags & VMS_VBUFFER) {
1441 size = *(int32_t *)(opaque+field->size_offset);
1442 if (field->flags & VMS_MULTIPLY) {
1443 size *= field->size;
1446 if (field->flags & VMS_ARRAY) {
1447 n_elems = field->num;
1448 } else if (field->flags & VMS_VARRAY_INT32) {
1449 n_elems = *(int32_t *)(opaque+field->num_offset);
1450 } else if (field->flags & VMS_VARRAY_UINT32) {
1451 n_elems = *(uint32_t *)(opaque+field->num_offset);
1452 } else if (field->flags & VMS_VARRAY_UINT16) {
1453 n_elems = *(uint16_t *)(opaque+field->num_offset);
1454 } else if (field->flags & VMS_VARRAY_UINT8) {
1455 n_elems = *(uint8_t *)(opaque+field->num_offset);
1457 if (field->flags & VMS_POINTER) {
1458 base_addr = *(void **)base_addr + field->start;
1460 for (i = 0; i < n_elems; i++) {
1461 void *addr = base_addr + size * i;
1463 if (field->flags & VMS_ARRAY_OF_POINTER) {
1464 addr = *(void **)addr;
1466 if (field->flags & VMS_STRUCT) {
1467 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1468 } else {
1469 ret = field->info->get(f, addr, size);
1472 if (ret < 0) {
1473 return ret;
1477 field++;
1479 ret = vmstate_subsection_load(f, vmsd, opaque);
1480 if (ret != 0) {
1481 return ret;
1483 if (vmsd->post_load) {
1484 return vmsd->post_load(opaque, version_id);
1486 return 0;
1489 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1490 void *opaque)
1492 VMStateField *field = vmsd->fields;
1494 if (vmsd->pre_save) {
1495 vmsd->pre_save(opaque);
1497 while(field->name) {
1498 if (!field->field_exists ||
1499 field->field_exists(opaque, vmsd->version_id)) {
1500 void *base_addr = opaque + field->offset;
1501 int i, n_elems = 1;
1502 int size = field->size;
1504 if (field->flags & VMS_VBUFFER) {
1505 size = *(int32_t *)(opaque+field->size_offset);
1506 if (field->flags & VMS_MULTIPLY) {
1507 size *= field->size;
1510 if (field->flags & VMS_ARRAY) {
1511 n_elems = field->num;
1512 } else if (field->flags & VMS_VARRAY_INT32) {
1513 n_elems = *(int32_t *)(opaque+field->num_offset);
1514 } else if (field->flags & VMS_VARRAY_UINT32) {
1515 n_elems = *(uint32_t *)(opaque+field->num_offset);
1516 } else if (field->flags & VMS_VARRAY_UINT16) {
1517 n_elems = *(uint16_t *)(opaque+field->num_offset);
1518 } else if (field->flags & VMS_VARRAY_UINT8) {
1519 n_elems = *(uint8_t *)(opaque+field->num_offset);
1521 if (field->flags & VMS_POINTER) {
1522 base_addr = *(void **)base_addr + field->start;
1524 for (i = 0; i < n_elems; i++) {
1525 void *addr = base_addr + size * i;
1527 if (field->flags & VMS_ARRAY_OF_POINTER) {
1528 addr = *(void **)addr;
1530 if (field->flags & VMS_STRUCT) {
1531 vmstate_save_state(f, field->vmsd, addr);
1532 } else {
1533 field->info->put(f, addr, size);
1537 field++;
1539 vmstate_subsection_save(f, vmsd, opaque);
1542 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1544 if (!se->vmsd) { /* Old style */
1545 return se->ops->load_state(f, se->opaque, version_id);
1547 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1550 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1552 if (!se->vmsd) { /* Old style */
1553 se->ops->save_state(f, se->opaque);
1554 return;
1556 vmstate_save_state(f,se->vmsd, se->opaque);
1559 #define QEMU_VM_FILE_MAGIC 0x5145564d
1560 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1561 #define QEMU_VM_FILE_VERSION 0x00000003
1563 #define QEMU_VM_EOF 0x00
1564 #define QEMU_VM_SECTION_START 0x01
1565 #define QEMU_VM_SECTION_PART 0x02
1566 #define QEMU_VM_SECTION_END 0x03
1567 #define QEMU_VM_SECTION_FULL 0x04
1568 #define QEMU_VM_SUBSECTION 0x05
1570 bool qemu_savevm_state_blocked(Error **errp)
1572 SaveStateEntry *se;
1574 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1575 if (se->no_migrate) {
1576 error_set(errp, QERR_MIGRATION_NOT_SUPPORTED, se->idstr);
1577 return true;
1580 return false;
1583 int qemu_savevm_state_begin(QEMUFile *f,
1584 const MigrationParams *params)
1586 SaveStateEntry *se;
1587 int ret;
1589 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1590 if (!se->ops || !se->ops->set_params) {
1591 continue;
1593 se->ops->set_params(params, se->opaque);
1596 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1597 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1599 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1600 int len;
1602 if (!se->ops || !se->ops->save_live_setup) {
1603 continue;
1605 if (se->ops && se->ops->is_active) {
1606 if (!se->ops->is_active(se->opaque)) {
1607 continue;
1610 /* Section type */
1611 qemu_put_byte(f, QEMU_VM_SECTION_START);
1612 qemu_put_be32(f, se->section_id);
1614 /* ID string */
1615 len = strlen(se->idstr);
1616 qemu_put_byte(f, len);
1617 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1619 qemu_put_be32(f, se->instance_id);
1620 qemu_put_be32(f, se->version_id);
1622 ret = se->ops->save_live_setup(f, se->opaque);
1623 if (ret < 0) {
1624 qemu_savevm_state_cancel();
1625 return ret;
1628 ret = qemu_file_get_error(f);
1629 if (ret != 0) {
1630 qemu_savevm_state_cancel();
1633 return ret;
1638 * this function has three return values:
1639 * negative: there was one error, and we have -errno.
1640 * 0 : We haven't finished, caller have to go again
1641 * 1 : We have finished, we can go to complete phase
1643 int qemu_savevm_state_iterate(QEMUFile *f)
1645 SaveStateEntry *se;
1646 int ret = 1;
1648 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1649 if (!se->ops || !se->ops->save_live_iterate) {
1650 continue;
1652 if (se->ops && se->ops->is_active) {
1653 if (!se->ops->is_active(se->opaque)) {
1654 continue;
1657 if (qemu_file_rate_limit(f)) {
1658 return 0;
1660 trace_savevm_section_start();
1661 /* Section type */
1662 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1663 qemu_put_be32(f, se->section_id);
1665 ret = se->ops->save_live_iterate(f, se->opaque);
1666 trace_savevm_section_end(se->section_id);
1668 if (ret <= 0) {
1669 /* Do not proceed to the next vmstate before this one reported
1670 completion of the current stage. This serializes the migration
1671 and reduces the probability that a faster changing state is
1672 synchronized over and over again. */
1673 break;
1676 if (ret != 0) {
1677 return ret;
1679 ret = qemu_file_get_error(f);
1680 if (ret != 0) {
1681 qemu_savevm_state_cancel();
1683 return ret;
1686 int qemu_savevm_state_complete(QEMUFile *f)
1688 SaveStateEntry *se;
1689 int ret;
1691 cpu_synchronize_all_states();
1693 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1694 if (!se->ops || !se->ops->save_live_complete) {
1695 continue;
1697 if (se->ops && se->ops->is_active) {
1698 if (!se->ops->is_active(se->opaque)) {
1699 continue;
1702 trace_savevm_section_start();
1703 /* Section type */
1704 qemu_put_byte(f, QEMU_VM_SECTION_END);
1705 qemu_put_be32(f, se->section_id);
1707 ret = se->ops->save_live_complete(f, se->opaque);
1708 trace_savevm_section_end(se->section_id);
1709 if (ret < 0) {
1710 return ret;
1714 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1715 int len;
1717 if ((!se->ops || !se->ops->save_state) && !se->vmsd) {
1718 continue;
1720 trace_savevm_section_start();
1721 /* Section type */
1722 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1723 qemu_put_be32(f, se->section_id);
1725 /* ID string */
1726 len = strlen(se->idstr);
1727 qemu_put_byte(f, len);
1728 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1730 qemu_put_be32(f, se->instance_id);
1731 qemu_put_be32(f, se->version_id);
1733 vmstate_save(f, se);
1734 trace_savevm_section_end(se->section_id);
1737 qemu_put_byte(f, QEMU_VM_EOF);
1739 return qemu_file_get_error(f);
1742 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size)
1744 SaveStateEntry *se;
1745 uint64_t ret = 0;
1747 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1748 if (!se->ops || !se->ops->save_live_pending) {
1749 continue;
1751 if (se->ops && se->ops->is_active) {
1752 if (!se->ops->is_active(se->opaque)) {
1753 continue;
1756 ret += se->ops->save_live_pending(f, se->opaque, max_size);
1758 return ret;
1761 void qemu_savevm_state_cancel(void)
1763 SaveStateEntry *se;
1765 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1766 if (se->ops && se->ops->cancel) {
1767 se->ops->cancel(se->opaque);
1772 static int qemu_savevm_state(QEMUFile *f)
1774 int ret;
1775 MigrationParams params = {
1776 .blk = 0,
1777 .shared = 0
1780 if (qemu_savevm_state_blocked(NULL)) {
1781 ret = -EINVAL;
1782 goto out;
1785 ret = qemu_savevm_state_begin(f, &params);
1786 if (ret < 0)
1787 goto out;
1789 do {
1790 ret = qemu_savevm_state_iterate(f);
1791 if (ret < 0)
1792 goto out;
1793 } while (ret == 0);
1795 ret = qemu_savevm_state_complete(f);
1797 out:
1798 if (ret == 0) {
1799 ret = qemu_file_get_error(f);
1802 return ret;
1805 static int qemu_save_device_state(QEMUFile *f)
1807 SaveStateEntry *se;
1809 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1810 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1812 cpu_synchronize_all_states();
1814 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1815 int len;
1817 if (se->is_ram) {
1818 continue;
1820 if ((!se->ops || !se->ops->save_state) && !se->vmsd) {
1821 continue;
1824 /* Section type */
1825 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1826 qemu_put_be32(f, se->section_id);
1828 /* ID string */
1829 len = strlen(se->idstr);
1830 qemu_put_byte(f, len);
1831 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1833 qemu_put_be32(f, se->instance_id);
1834 qemu_put_be32(f, se->version_id);
1836 vmstate_save(f, se);
1839 qemu_put_byte(f, QEMU_VM_EOF);
1841 return qemu_file_get_error(f);
1844 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1846 SaveStateEntry *se;
1848 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1849 if (!strcmp(se->idstr, idstr) &&
1850 (instance_id == se->instance_id ||
1851 instance_id == se->alias_id))
1852 return se;
1853 /* Migrating from an older version? */
1854 if (strstr(se->idstr, idstr) && se->compat) {
1855 if (!strcmp(se->compat->idstr, idstr) &&
1856 (instance_id == se->compat->instance_id ||
1857 instance_id == se->alias_id))
1858 return se;
1861 return NULL;
1864 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1866 while(sub && sub->needed) {
1867 if (strcmp(idstr, sub->vmsd->name) == 0) {
1868 return sub->vmsd;
1870 sub++;
1872 return NULL;
1875 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1876 void *opaque)
1878 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1879 char idstr[256];
1880 int ret;
1881 uint8_t version_id, len, size;
1882 const VMStateDescription *sub_vmsd;
1884 len = qemu_peek_byte(f, 1);
1885 if (len < strlen(vmsd->name) + 1) {
1886 /* subsection name has be be "section_name/a" */
1887 return 0;
1889 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1890 if (size != len) {
1891 return 0;
1893 idstr[size] = 0;
1895 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1896 /* it don't have a valid subsection name */
1897 return 0;
1899 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1900 if (sub_vmsd == NULL) {
1901 return -ENOENT;
1903 qemu_file_skip(f, 1); /* subsection */
1904 qemu_file_skip(f, 1); /* len */
1905 qemu_file_skip(f, len); /* idstr */
1906 version_id = qemu_get_be32(f);
1908 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1909 if (ret) {
1910 return ret;
1913 return 0;
1916 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1917 void *opaque)
1919 const VMStateSubsection *sub = vmsd->subsections;
1921 while (sub && sub->needed) {
1922 if (sub->needed(opaque)) {
1923 const VMStateDescription *vmsd = sub->vmsd;
1924 uint8_t len;
1926 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1927 len = strlen(vmsd->name);
1928 qemu_put_byte(f, len);
1929 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1930 qemu_put_be32(f, vmsd->version_id);
1931 vmstate_save_state(f, vmsd, opaque);
1933 sub++;
1937 typedef struct LoadStateEntry {
1938 QLIST_ENTRY(LoadStateEntry) entry;
1939 SaveStateEntry *se;
1940 int section_id;
1941 int version_id;
1942 } LoadStateEntry;
1944 int qemu_loadvm_state(QEMUFile *f)
1946 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1947 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1948 LoadStateEntry *le, *new_le;
1949 uint8_t section_type;
1950 unsigned int v;
1951 int ret;
1953 if (qemu_savevm_state_blocked(NULL)) {
1954 return -EINVAL;
1957 v = qemu_get_be32(f);
1958 if (v != QEMU_VM_FILE_MAGIC)
1959 return -EINVAL;
1961 v = qemu_get_be32(f);
1962 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1963 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1964 return -ENOTSUP;
1966 if (v != QEMU_VM_FILE_VERSION)
1967 return -ENOTSUP;
1969 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1970 uint32_t instance_id, version_id, section_id;
1971 SaveStateEntry *se;
1972 char idstr[257];
1973 int len;
1975 switch (section_type) {
1976 case QEMU_VM_SECTION_START:
1977 case QEMU_VM_SECTION_FULL:
1978 /* Read section start */
1979 section_id = qemu_get_be32(f);
1980 len = qemu_get_byte(f);
1981 qemu_get_buffer(f, (uint8_t *)idstr, len);
1982 idstr[len] = 0;
1983 instance_id = qemu_get_be32(f);
1984 version_id = qemu_get_be32(f);
1986 /* Find savevm section */
1987 se = find_se(idstr, instance_id);
1988 if (se == NULL) {
1989 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1990 ret = -EINVAL;
1991 goto out;
1994 /* Validate version */
1995 if (version_id > se->version_id) {
1996 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1997 version_id, idstr, se->version_id);
1998 ret = -EINVAL;
1999 goto out;
2002 /* Add entry */
2003 le = g_malloc0(sizeof(*le));
2005 le->se = se;
2006 le->section_id = section_id;
2007 le->version_id = version_id;
2008 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
2010 ret = vmstate_load(f, le->se, le->version_id);
2011 if (ret < 0) {
2012 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
2013 instance_id, idstr);
2014 goto out;
2016 break;
2017 case QEMU_VM_SECTION_PART:
2018 case QEMU_VM_SECTION_END:
2019 section_id = qemu_get_be32(f);
2021 QLIST_FOREACH(le, &loadvm_handlers, entry) {
2022 if (le->section_id == section_id) {
2023 break;
2026 if (le == NULL) {
2027 fprintf(stderr, "Unknown savevm section %d\n", section_id);
2028 ret = -EINVAL;
2029 goto out;
2032 ret = vmstate_load(f, le->se, le->version_id);
2033 if (ret < 0) {
2034 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
2035 section_id);
2036 goto out;
2038 break;
2039 default:
2040 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
2041 ret = -EINVAL;
2042 goto out;
2046 cpu_synchronize_all_post_init();
2048 ret = 0;
2050 out:
2051 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
2052 QLIST_REMOVE(le, entry);
2053 g_free(le);
2056 if (ret == 0) {
2057 ret = qemu_file_get_error(f);
2060 return ret;
2063 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
2064 const char *name)
2066 QEMUSnapshotInfo *sn_tab, *sn;
2067 int nb_sns, i, ret;
2069 ret = -ENOENT;
2070 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2071 if (nb_sns < 0)
2072 return ret;
2073 for(i = 0; i < nb_sns; i++) {
2074 sn = &sn_tab[i];
2075 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
2076 *sn_info = *sn;
2077 ret = 0;
2078 break;
2081 g_free(sn_tab);
2082 return ret;
2086 * Deletes snapshots of a given name in all opened images.
2088 static int del_existing_snapshots(Monitor *mon, const char *name)
2090 BlockDriverState *bs;
2091 QEMUSnapshotInfo sn1, *snapshot = &sn1;
2092 int ret;
2094 bs = NULL;
2095 while ((bs = bdrv_next(bs))) {
2096 if (bdrv_can_snapshot(bs) &&
2097 bdrv_snapshot_find(bs, snapshot, name) >= 0)
2099 ret = bdrv_snapshot_delete(bs, name);
2100 if (ret < 0) {
2101 monitor_printf(mon,
2102 "Error while deleting snapshot on '%s'\n",
2103 bdrv_get_device_name(bs));
2104 return -1;
2109 return 0;
2112 void do_savevm(Monitor *mon, const QDict *qdict)
2114 BlockDriverState *bs, *bs1;
2115 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
2116 int ret;
2117 QEMUFile *f;
2118 int saved_vm_running;
2119 uint64_t vm_state_size;
2120 qemu_timeval tv;
2121 struct tm tm;
2122 const char *name = qdict_get_try_str(qdict, "name");
2124 /* Verify if there is a device that doesn't support snapshots and is writable */
2125 bs = NULL;
2126 while ((bs = bdrv_next(bs))) {
2128 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2129 continue;
2132 if (!bdrv_can_snapshot(bs)) {
2133 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
2134 bdrv_get_device_name(bs));
2135 return;
2139 bs = bdrv_snapshots();
2140 if (!bs) {
2141 monitor_printf(mon, "No block device can accept snapshots\n");
2142 return;
2145 saved_vm_running = runstate_is_running();
2146 vm_stop(RUN_STATE_SAVE_VM);
2148 memset(sn, 0, sizeof(*sn));
2150 /* fill auxiliary fields */
2151 qemu_gettimeofday(&tv);
2152 sn->date_sec = tv.tv_sec;
2153 sn->date_nsec = tv.tv_usec * 1000;
2154 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2156 if (name) {
2157 ret = bdrv_snapshot_find(bs, old_sn, name);
2158 if (ret >= 0) {
2159 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2160 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2161 } else {
2162 pstrcpy(sn->name, sizeof(sn->name), name);
2164 } else {
2165 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2166 localtime_r((const time_t *)&tv.tv_sec, &tm);
2167 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2170 /* Delete old snapshots of the same name */
2171 if (name && del_existing_snapshots(mon, name) < 0) {
2172 goto the_end;
2175 /* save the VM state */
2176 f = qemu_fopen_bdrv(bs, 1);
2177 if (!f) {
2178 monitor_printf(mon, "Could not open VM state file\n");
2179 goto the_end;
2181 ret = qemu_savevm_state(f);
2182 vm_state_size = qemu_ftell(f);
2183 qemu_fclose(f);
2184 if (ret < 0) {
2185 monitor_printf(mon, "Error %d while writing VM\n", ret);
2186 goto the_end;
2189 /* create the snapshots */
2191 bs1 = NULL;
2192 while ((bs1 = bdrv_next(bs1))) {
2193 if (bdrv_can_snapshot(bs1)) {
2194 /* Write VM state size only to the image that contains the state */
2195 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2196 ret = bdrv_snapshot_create(bs1, sn);
2197 if (ret < 0) {
2198 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2199 bdrv_get_device_name(bs1));
2204 the_end:
2205 if (saved_vm_running)
2206 vm_start();
2209 void qmp_xen_save_devices_state(const char *filename, Error **errp)
2211 QEMUFile *f;
2212 int saved_vm_running;
2213 int ret;
2215 saved_vm_running = runstate_is_running();
2216 vm_stop(RUN_STATE_SAVE_VM);
2218 f = qemu_fopen(filename, "wb");
2219 if (!f) {
2220 error_set(errp, QERR_OPEN_FILE_FAILED, filename);
2221 goto the_end;
2223 ret = qemu_save_device_state(f);
2224 qemu_fclose(f);
2225 if (ret < 0) {
2226 error_set(errp, QERR_IO_ERROR);
2229 the_end:
2230 if (saved_vm_running)
2231 vm_start();
2234 int load_vmstate(const char *name)
2236 BlockDriverState *bs, *bs_vm_state;
2237 QEMUSnapshotInfo sn;
2238 QEMUFile *f;
2239 int ret;
2241 bs_vm_state = bdrv_snapshots();
2242 if (!bs_vm_state) {
2243 error_report("No block device supports snapshots");
2244 return -ENOTSUP;
2247 /* Don't even try to load empty VM states */
2248 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2249 if (ret < 0) {
2250 return ret;
2251 } else if (sn.vm_state_size == 0) {
2252 error_report("This is a disk-only snapshot. Revert to it offline "
2253 "using qemu-img.");
2254 return -EINVAL;
2257 /* Verify if there is any device that doesn't support snapshots and is
2258 writable and check if the requested snapshot is available too. */
2259 bs = NULL;
2260 while ((bs = bdrv_next(bs))) {
2262 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2263 continue;
2266 if (!bdrv_can_snapshot(bs)) {
2267 error_report("Device '%s' is writable but does not support snapshots.",
2268 bdrv_get_device_name(bs));
2269 return -ENOTSUP;
2272 ret = bdrv_snapshot_find(bs, &sn, name);
2273 if (ret < 0) {
2274 error_report("Device '%s' does not have the requested snapshot '%s'",
2275 bdrv_get_device_name(bs), name);
2276 return ret;
2280 /* Flush all IO requests so they don't interfere with the new state. */
2281 bdrv_drain_all();
2283 bs = NULL;
2284 while ((bs = bdrv_next(bs))) {
2285 if (bdrv_can_snapshot(bs)) {
2286 ret = bdrv_snapshot_goto(bs, name);
2287 if (ret < 0) {
2288 error_report("Error %d while activating snapshot '%s' on '%s'",
2289 ret, name, bdrv_get_device_name(bs));
2290 return ret;
2295 /* restore the VM state */
2296 f = qemu_fopen_bdrv(bs_vm_state, 0);
2297 if (!f) {
2298 error_report("Could not open VM state file");
2299 return -EINVAL;
2302 qemu_system_reset(VMRESET_SILENT);
2303 ret = qemu_loadvm_state(f);
2305 qemu_fclose(f);
2306 if (ret < 0) {
2307 error_report("Error %d while loading VM state", ret);
2308 return ret;
2311 return 0;
2314 void do_delvm(Monitor *mon, const QDict *qdict)
2316 BlockDriverState *bs, *bs1;
2317 int ret;
2318 const char *name = qdict_get_str(qdict, "name");
2320 bs = bdrv_snapshots();
2321 if (!bs) {
2322 monitor_printf(mon, "No block device supports snapshots\n");
2323 return;
2326 bs1 = NULL;
2327 while ((bs1 = bdrv_next(bs1))) {
2328 if (bdrv_can_snapshot(bs1)) {
2329 ret = bdrv_snapshot_delete(bs1, name);
2330 if (ret < 0) {
2331 if (ret == -ENOTSUP)
2332 monitor_printf(mon,
2333 "Snapshots not supported on device '%s'\n",
2334 bdrv_get_device_name(bs1));
2335 else
2336 monitor_printf(mon, "Error %d while deleting snapshot on "
2337 "'%s'\n", ret, bdrv_get_device_name(bs1));
2343 void do_info_snapshots(Monitor *mon, const QDict *qdict)
2345 BlockDriverState *bs, *bs1;
2346 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2347 int nb_sns, i, ret, available;
2348 int total;
2349 int *available_snapshots;
2350 char buf[256];
2352 bs = bdrv_snapshots();
2353 if (!bs) {
2354 monitor_printf(mon, "No available block device supports snapshots\n");
2355 return;
2358 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2359 if (nb_sns < 0) {
2360 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2361 return;
2364 if (nb_sns == 0) {
2365 monitor_printf(mon, "There is no snapshot available.\n");
2366 return;
2369 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2370 total = 0;
2371 for (i = 0; i < nb_sns; i++) {
2372 sn = &sn_tab[i];
2373 available = 1;
2374 bs1 = NULL;
2376 while ((bs1 = bdrv_next(bs1))) {
2377 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2378 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2379 if (ret < 0) {
2380 available = 0;
2381 break;
2386 if (available) {
2387 available_snapshots[total] = i;
2388 total++;
2392 if (total > 0) {
2393 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2394 for (i = 0; i < total; i++) {
2395 sn = &sn_tab[available_snapshots[i]];
2396 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2398 } else {
2399 monitor_printf(mon, "There is no suitable snapshot available\n");
2402 g_free(sn_tab);
2403 g_free(available_snapshots);
2407 void vmstate_register_ram(MemoryRegion *mr, DeviceState *dev)
2409 qemu_ram_set_idstr(memory_region_get_ram_addr(mr) & TARGET_PAGE_MASK,
2410 memory_region_name(mr), dev);
2413 void vmstate_unregister_ram(MemoryRegion *mr, DeviceState *dev)
2415 /* Nothing do to while the implementation is in RAMBlock */
2418 void vmstate_register_ram_global(MemoryRegion *mr)
2420 vmstate_register_ram(mr, NULL);