qemu-file: fsync a writable stdio QEMUFile
[qemu/ar7.git] / savevm.c
blob1d49fde68b484abd74d4c12d7cc570ad949ba5fa
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;
260 if (s->file->ops->put_buffer) {
261 int fd = fileno(s->stdio_file);
262 struct stat st;
264 ret = fstat(fd, &st);
265 if (ret == 0 && S_ISREG(st.st_mode)) {
267 * If the file handle is a regular file make sure the
268 * data is flushed to disk before signaling success.
270 ret = fsync(fd);
271 if (ret != 0) {
272 ret = -errno;
273 return ret;
277 if (fclose(s->stdio_file) == EOF) {
278 ret = -errno;
280 g_free(s);
281 return ret;
284 static const QEMUFileOps stdio_pipe_read_ops = {
285 .get_fd = stdio_get_fd,
286 .get_buffer = stdio_get_buffer,
287 .close = stdio_pclose
290 static const QEMUFileOps stdio_pipe_write_ops = {
291 .get_fd = stdio_get_fd,
292 .put_buffer = stdio_put_buffer,
293 .close = stdio_pclose
296 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
298 FILE *stdio_file;
299 QEMUFileStdio *s;
301 stdio_file = popen(command, mode);
302 if (stdio_file == NULL) {
303 return NULL;
306 if (mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
307 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
308 return NULL;
311 s = g_malloc0(sizeof(QEMUFileStdio));
313 s->stdio_file = stdio_file;
315 if(mode[0] == 'r') {
316 s->file = qemu_fopen_ops(s, &stdio_pipe_read_ops);
317 } else {
318 s->file = qemu_fopen_ops(s, &stdio_pipe_write_ops);
320 return s->file;
323 static const QEMUFileOps stdio_file_read_ops = {
324 .get_fd = stdio_get_fd,
325 .get_buffer = stdio_get_buffer,
326 .close = stdio_fclose
329 static const QEMUFileOps stdio_file_write_ops = {
330 .get_fd = stdio_get_fd,
331 .put_buffer = stdio_put_buffer,
332 .close = stdio_fclose
335 QEMUFile *qemu_fdopen(int fd, const char *mode)
337 QEMUFileStdio *s;
339 if (mode == NULL ||
340 (mode[0] != 'r' && mode[0] != 'w') ||
341 mode[1] != 'b' || mode[2] != 0) {
342 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
343 return NULL;
346 s = g_malloc0(sizeof(QEMUFileStdio));
347 s->stdio_file = fdopen(fd, mode);
348 if (!s->stdio_file)
349 goto fail;
351 if(mode[0] == 'r') {
352 s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
353 } else {
354 s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
356 return s->file;
358 fail:
359 g_free(s);
360 return NULL;
363 static const QEMUFileOps socket_read_ops = {
364 .get_fd = socket_get_fd,
365 .get_buffer = socket_get_buffer,
366 .close = socket_close
369 QEMUFile *qemu_fopen_socket(int fd)
371 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
373 s->fd = fd;
374 s->file = qemu_fopen_ops(s, &socket_read_ops);
375 return s->file;
378 QEMUFile *qemu_fopen(const char *filename, const char *mode)
380 QEMUFileStdio *s;
382 if (mode == NULL ||
383 (mode[0] != 'r' && mode[0] != 'w') ||
384 mode[1] != 'b' || mode[2] != 0) {
385 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
386 return NULL;
389 s = g_malloc0(sizeof(QEMUFileStdio));
391 s->stdio_file = fopen(filename, mode);
392 if (!s->stdio_file)
393 goto fail;
395 if(mode[0] == 'w') {
396 s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
397 } else {
398 s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
400 return s->file;
401 fail:
402 g_free(s);
403 return NULL;
406 static int block_put_buffer(void *opaque, const uint8_t *buf,
407 int64_t pos, int size)
409 bdrv_save_vmstate(opaque, buf, pos, size);
410 return size;
413 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
415 return bdrv_load_vmstate(opaque, buf, pos, size);
418 static int bdrv_fclose(void *opaque)
420 return bdrv_flush(opaque);
423 static const QEMUFileOps bdrv_read_ops = {
424 .get_buffer = block_get_buffer,
425 .close = bdrv_fclose
428 static const QEMUFileOps bdrv_write_ops = {
429 .put_buffer = block_put_buffer,
430 .close = bdrv_fclose
433 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
435 if (is_writable)
436 return qemu_fopen_ops(bs, &bdrv_write_ops);
437 return qemu_fopen_ops(bs, &bdrv_read_ops);
440 QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops)
442 QEMUFile *f;
444 f = g_malloc0(sizeof(QEMUFile));
446 f->opaque = opaque;
447 f->ops = ops;
448 f->is_write = 0;
450 return f;
453 int qemu_file_get_error(QEMUFile *f)
455 return f->last_error;
458 static void qemu_file_set_error(QEMUFile *f, int ret)
460 if (f->last_error == 0) {
461 f->last_error = ret;
465 /** Flushes QEMUFile buffer
468 static void qemu_fflush(QEMUFile *f)
470 int ret = 0;
472 if (!f->ops->put_buffer) {
473 return;
475 if (f->is_write && f->buf_index > 0) {
476 ret = f->ops->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
477 if (ret >= 0) {
478 f->buf_offset += f->buf_index;
480 f->buf_index = 0;
482 if (ret < 0) {
483 qemu_file_set_error(f, ret);
487 static void qemu_fill_buffer(QEMUFile *f)
489 int len;
490 int pending;
492 if (!f->ops->get_buffer)
493 return;
495 if (f->is_write)
496 abort();
498 pending = f->buf_size - f->buf_index;
499 if (pending > 0) {
500 memmove(f->buf, f->buf + f->buf_index, pending);
502 f->buf_index = 0;
503 f->buf_size = pending;
505 len = f->ops->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
506 IO_BUF_SIZE - pending);
507 if (len > 0) {
508 f->buf_size += len;
509 f->buf_offset += len;
510 } else if (len == 0) {
511 qemu_file_set_error(f, -EIO);
512 } else if (len != -EAGAIN)
513 qemu_file_set_error(f, len);
516 int qemu_get_fd(QEMUFile *f)
518 if (f->ops->get_fd) {
519 return f->ops->get_fd(f->opaque);
521 return -1;
524 /** Closes the file
526 * Returns negative error value if any error happened on previous operations or
527 * while closing the file. Returns 0 or positive number on success.
529 * The meaning of return value on success depends on the specific backend
530 * being used.
532 int qemu_fclose(QEMUFile *f)
534 int ret;
535 qemu_fflush(f);
536 ret = qemu_file_get_error(f);
538 if (f->ops->close) {
539 int ret2 = f->ops->close(f->opaque);
540 if (ret >= 0) {
541 ret = ret2;
544 /* If any error was spotted before closing, we should report it
545 * instead of the close() return value.
547 if (f->last_error) {
548 ret = f->last_error;
550 g_free(f);
551 return ret;
554 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
556 int l;
558 if (f->last_error) {
559 return;
562 if (f->is_write == 0 && f->buf_index > 0) {
563 fprintf(stderr,
564 "Attempted to write to buffer while read buffer is not empty\n");
565 abort();
568 while (size > 0) {
569 l = IO_BUF_SIZE - f->buf_index;
570 if (l > size)
571 l = size;
572 memcpy(f->buf + f->buf_index, buf, l);
573 f->is_write = 1;
574 f->buf_index += l;
575 buf += l;
576 size -= l;
577 if (f->buf_index >= IO_BUF_SIZE) {
578 qemu_fflush(f);
579 if (qemu_file_get_error(f)) {
580 break;
586 void qemu_put_byte(QEMUFile *f, int v)
588 if (f->last_error) {
589 return;
592 if (f->is_write == 0 && f->buf_index > 0) {
593 fprintf(stderr,
594 "Attempted to write to buffer while read buffer is not empty\n");
595 abort();
598 f->buf[f->buf_index++] = v;
599 f->is_write = 1;
600 if (f->buf_index >= IO_BUF_SIZE) {
601 qemu_fflush(f);
605 static void qemu_file_skip(QEMUFile *f, int size)
607 if (f->buf_index + size <= f->buf_size) {
608 f->buf_index += size;
612 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
614 int pending;
615 int index;
617 if (f->is_write) {
618 abort();
621 index = f->buf_index + offset;
622 pending = f->buf_size - index;
623 if (pending < size) {
624 qemu_fill_buffer(f);
625 index = f->buf_index + offset;
626 pending = f->buf_size - index;
629 if (pending <= 0) {
630 return 0;
632 if (size > pending) {
633 size = pending;
636 memcpy(buf, f->buf + index, size);
637 return size;
640 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
642 int pending = size;
643 int done = 0;
645 while (pending > 0) {
646 int res;
648 res = qemu_peek_buffer(f, buf, pending, 0);
649 if (res == 0) {
650 return done;
652 qemu_file_skip(f, res);
653 buf += res;
654 pending -= res;
655 done += res;
657 return done;
660 static int qemu_peek_byte(QEMUFile *f, int offset)
662 int index = f->buf_index + offset;
664 if (f->is_write) {
665 abort();
668 if (index >= f->buf_size) {
669 qemu_fill_buffer(f);
670 index = f->buf_index + offset;
671 if (index >= f->buf_size) {
672 return 0;
675 return f->buf[index];
678 int qemu_get_byte(QEMUFile *f)
680 int result;
682 result = qemu_peek_byte(f, 0);
683 qemu_file_skip(f, 1);
684 return result;
687 int64_t qemu_ftell(QEMUFile *f)
689 /* buf_offset excludes buffer for writing but includes it for reading */
690 if (f->is_write) {
691 return f->buf_offset + f->buf_index;
692 } else {
693 return f->buf_offset - f->buf_size + f->buf_index;
697 int qemu_file_rate_limit(QEMUFile *f)
699 if (f->ops->rate_limit)
700 return f->ops->rate_limit(f->opaque);
702 return 0;
705 int64_t qemu_file_get_rate_limit(QEMUFile *f)
707 if (f->ops->get_rate_limit)
708 return f->ops->get_rate_limit(f->opaque);
710 return 0;
713 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
715 /* any failed or completed migration keeps its state to allow probing of
716 * migration data, but has no associated file anymore */
717 if (f && f->ops->set_rate_limit)
718 return f->ops->set_rate_limit(f->opaque, new_rate);
720 return 0;
723 void qemu_put_be16(QEMUFile *f, unsigned int v)
725 qemu_put_byte(f, v >> 8);
726 qemu_put_byte(f, v);
729 void qemu_put_be32(QEMUFile *f, unsigned int v)
731 qemu_put_byte(f, v >> 24);
732 qemu_put_byte(f, v >> 16);
733 qemu_put_byte(f, v >> 8);
734 qemu_put_byte(f, v);
737 void qemu_put_be64(QEMUFile *f, uint64_t v)
739 qemu_put_be32(f, v >> 32);
740 qemu_put_be32(f, v);
743 unsigned int qemu_get_be16(QEMUFile *f)
745 unsigned int v;
746 v = qemu_get_byte(f) << 8;
747 v |= qemu_get_byte(f);
748 return v;
751 unsigned int qemu_get_be32(QEMUFile *f)
753 unsigned int v;
754 v = qemu_get_byte(f) << 24;
755 v |= qemu_get_byte(f) << 16;
756 v |= qemu_get_byte(f) << 8;
757 v |= qemu_get_byte(f);
758 return v;
761 uint64_t qemu_get_be64(QEMUFile *f)
763 uint64_t v;
764 v = (uint64_t)qemu_get_be32(f) << 32;
765 v |= qemu_get_be32(f);
766 return v;
770 /* timer */
772 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
774 uint64_t expire_time;
776 expire_time = qemu_timer_expire_time_ns(ts);
777 qemu_put_be64(f, expire_time);
780 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
782 uint64_t expire_time;
784 expire_time = qemu_get_be64(f);
785 if (expire_time != -1) {
786 qemu_mod_timer_ns(ts, expire_time);
787 } else {
788 qemu_del_timer(ts);
793 /* bool */
795 static int get_bool(QEMUFile *f, void *pv, size_t size)
797 bool *v = pv;
798 *v = qemu_get_byte(f);
799 return 0;
802 static void put_bool(QEMUFile *f, void *pv, size_t size)
804 bool *v = pv;
805 qemu_put_byte(f, *v);
808 const VMStateInfo vmstate_info_bool = {
809 .name = "bool",
810 .get = get_bool,
811 .put = put_bool,
814 /* 8 bit int */
816 static int get_int8(QEMUFile *f, void *pv, size_t size)
818 int8_t *v = pv;
819 qemu_get_s8s(f, v);
820 return 0;
823 static void put_int8(QEMUFile *f, void *pv, size_t size)
825 int8_t *v = pv;
826 qemu_put_s8s(f, v);
829 const VMStateInfo vmstate_info_int8 = {
830 .name = "int8",
831 .get = get_int8,
832 .put = put_int8,
835 /* 16 bit int */
837 static int get_int16(QEMUFile *f, void *pv, size_t size)
839 int16_t *v = pv;
840 qemu_get_sbe16s(f, v);
841 return 0;
844 static void put_int16(QEMUFile *f, void *pv, size_t size)
846 int16_t *v = pv;
847 qemu_put_sbe16s(f, v);
850 const VMStateInfo vmstate_info_int16 = {
851 .name = "int16",
852 .get = get_int16,
853 .put = put_int16,
856 /* 32 bit int */
858 static int get_int32(QEMUFile *f, void *pv, size_t size)
860 int32_t *v = pv;
861 qemu_get_sbe32s(f, v);
862 return 0;
865 static void put_int32(QEMUFile *f, void *pv, size_t size)
867 int32_t *v = pv;
868 qemu_put_sbe32s(f, v);
871 const VMStateInfo vmstate_info_int32 = {
872 .name = "int32",
873 .get = get_int32,
874 .put = put_int32,
877 /* 32 bit int. See that the received value is the same than the one
878 in the field */
880 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
882 int32_t *v = pv;
883 int32_t v2;
884 qemu_get_sbe32s(f, &v2);
886 if (*v == v2)
887 return 0;
888 return -EINVAL;
891 const VMStateInfo vmstate_info_int32_equal = {
892 .name = "int32 equal",
893 .get = get_int32_equal,
894 .put = put_int32,
897 /* 32 bit int. See that the received value is the less or the same
898 than the one in the field */
900 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
902 int32_t *old = pv;
903 int32_t new;
904 qemu_get_sbe32s(f, &new);
906 if (*old <= new)
907 return 0;
908 return -EINVAL;
911 const VMStateInfo vmstate_info_int32_le = {
912 .name = "int32 equal",
913 .get = get_int32_le,
914 .put = put_int32,
917 /* 64 bit int */
919 static int get_int64(QEMUFile *f, void *pv, size_t size)
921 int64_t *v = pv;
922 qemu_get_sbe64s(f, v);
923 return 0;
926 static void put_int64(QEMUFile *f, void *pv, size_t size)
928 int64_t *v = pv;
929 qemu_put_sbe64s(f, v);
932 const VMStateInfo vmstate_info_int64 = {
933 .name = "int64",
934 .get = get_int64,
935 .put = put_int64,
938 /* 8 bit unsigned int */
940 static int get_uint8(QEMUFile *f, void *pv, size_t size)
942 uint8_t *v = pv;
943 qemu_get_8s(f, v);
944 return 0;
947 static void put_uint8(QEMUFile *f, void *pv, size_t size)
949 uint8_t *v = pv;
950 qemu_put_8s(f, v);
953 const VMStateInfo vmstate_info_uint8 = {
954 .name = "uint8",
955 .get = get_uint8,
956 .put = put_uint8,
959 /* 16 bit unsigned int */
961 static int get_uint16(QEMUFile *f, void *pv, size_t size)
963 uint16_t *v = pv;
964 qemu_get_be16s(f, v);
965 return 0;
968 static void put_uint16(QEMUFile *f, void *pv, size_t size)
970 uint16_t *v = pv;
971 qemu_put_be16s(f, v);
974 const VMStateInfo vmstate_info_uint16 = {
975 .name = "uint16",
976 .get = get_uint16,
977 .put = put_uint16,
980 /* 32 bit unsigned int */
982 static int get_uint32(QEMUFile *f, void *pv, size_t size)
984 uint32_t *v = pv;
985 qemu_get_be32s(f, v);
986 return 0;
989 static void put_uint32(QEMUFile *f, void *pv, size_t size)
991 uint32_t *v = pv;
992 qemu_put_be32s(f, v);
995 const VMStateInfo vmstate_info_uint32 = {
996 .name = "uint32",
997 .get = get_uint32,
998 .put = put_uint32,
1001 /* 32 bit uint. See that the received value is the same than the one
1002 in the field */
1004 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
1006 uint32_t *v = pv;
1007 uint32_t v2;
1008 qemu_get_be32s(f, &v2);
1010 if (*v == v2) {
1011 return 0;
1013 return -EINVAL;
1016 const VMStateInfo vmstate_info_uint32_equal = {
1017 .name = "uint32 equal",
1018 .get = get_uint32_equal,
1019 .put = put_uint32,
1022 /* 64 bit unsigned int */
1024 static int get_uint64(QEMUFile *f, void *pv, size_t size)
1026 uint64_t *v = pv;
1027 qemu_get_be64s(f, v);
1028 return 0;
1031 static void put_uint64(QEMUFile *f, void *pv, size_t size)
1033 uint64_t *v = pv;
1034 qemu_put_be64s(f, v);
1037 const VMStateInfo vmstate_info_uint64 = {
1038 .name = "uint64",
1039 .get = get_uint64,
1040 .put = put_uint64,
1043 /* 8 bit int. See that the received value is the same than the one
1044 in the field */
1046 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
1048 uint8_t *v = pv;
1049 uint8_t v2;
1050 qemu_get_8s(f, &v2);
1052 if (*v == v2)
1053 return 0;
1054 return -EINVAL;
1057 const VMStateInfo vmstate_info_uint8_equal = {
1058 .name = "uint8 equal",
1059 .get = get_uint8_equal,
1060 .put = put_uint8,
1063 /* 16 bit unsigned int int. See that the received value is the same than the one
1064 in the field */
1066 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1068 uint16_t *v = pv;
1069 uint16_t v2;
1070 qemu_get_be16s(f, &v2);
1072 if (*v == v2)
1073 return 0;
1074 return -EINVAL;
1077 const VMStateInfo vmstate_info_uint16_equal = {
1078 .name = "uint16 equal",
1079 .get = get_uint16_equal,
1080 .put = put_uint16,
1083 /* timers */
1085 static int get_timer(QEMUFile *f, void *pv, size_t size)
1087 QEMUTimer *v = pv;
1088 qemu_get_timer(f, v);
1089 return 0;
1092 static void put_timer(QEMUFile *f, void *pv, size_t size)
1094 QEMUTimer *v = pv;
1095 qemu_put_timer(f, v);
1098 const VMStateInfo vmstate_info_timer = {
1099 .name = "timer",
1100 .get = get_timer,
1101 .put = put_timer,
1104 /* uint8_t buffers */
1106 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1108 uint8_t *v = pv;
1109 qemu_get_buffer(f, v, size);
1110 return 0;
1113 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1115 uint8_t *v = pv;
1116 qemu_put_buffer(f, v, size);
1119 const VMStateInfo vmstate_info_buffer = {
1120 .name = "buffer",
1121 .get = get_buffer,
1122 .put = put_buffer,
1125 /* unused buffers: space that was used for some fields that are
1126 not useful anymore */
1128 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1130 uint8_t buf[1024];
1131 int block_len;
1133 while (size > 0) {
1134 block_len = MIN(sizeof(buf), size);
1135 size -= block_len;
1136 qemu_get_buffer(f, buf, block_len);
1138 return 0;
1141 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1143 static const uint8_t buf[1024];
1144 int block_len;
1146 while (size > 0) {
1147 block_len = MIN(sizeof(buf), size);
1148 size -= block_len;
1149 qemu_put_buffer(f, buf, block_len);
1153 const VMStateInfo vmstate_info_unused_buffer = {
1154 .name = "unused_buffer",
1155 .get = get_unused_buffer,
1156 .put = put_unused_buffer,
1159 /* bitmaps (as defined by bitmap.h). Note that size here is the size
1160 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
1161 * bit words with the bits in big endian order. The in-memory format
1162 * is an array of 'unsigned long', which may be either 32 or 64 bits.
1164 /* This is the number of 64 bit words sent over the wire */
1165 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
1166 static int get_bitmap(QEMUFile *f, void *pv, size_t size)
1168 unsigned long *bmp = pv;
1169 int i, idx = 0;
1170 for (i = 0; i < BITS_TO_U64S(size); i++) {
1171 uint64_t w = qemu_get_be64(f);
1172 bmp[idx++] = w;
1173 if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
1174 bmp[idx++] = w >> 32;
1177 return 0;
1180 static void put_bitmap(QEMUFile *f, void *pv, size_t size)
1182 unsigned long *bmp = pv;
1183 int i, idx = 0;
1184 for (i = 0; i < BITS_TO_U64S(size); i++) {
1185 uint64_t w = bmp[idx++];
1186 if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
1187 w |= ((uint64_t)bmp[idx++]) << 32;
1189 qemu_put_be64(f, w);
1193 const VMStateInfo vmstate_info_bitmap = {
1194 .name = "bitmap",
1195 .get = get_bitmap,
1196 .put = put_bitmap,
1199 typedef struct CompatEntry {
1200 char idstr[256];
1201 int instance_id;
1202 } CompatEntry;
1204 typedef struct SaveStateEntry {
1205 QTAILQ_ENTRY(SaveStateEntry) entry;
1206 char idstr[256];
1207 int instance_id;
1208 int alias_id;
1209 int version_id;
1210 int section_id;
1211 SaveVMHandlers *ops;
1212 const VMStateDescription *vmsd;
1213 void *opaque;
1214 CompatEntry *compat;
1215 int no_migrate;
1216 int is_ram;
1217 } SaveStateEntry;
1220 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1221 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1222 static int global_section_id;
1224 static int calculate_new_instance_id(const char *idstr)
1226 SaveStateEntry *se;
1227 int instance_id = 0;
1229 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1230 if (strcmp(idstr, se->idstr) == 0
1231 && instance_id <= se->instance_id) {
1232 instance_id = se->instance_id + 1;
1235 return instance_id;
1238 static int calculate_compat_instance_id(const char *idstr)
1240 SaveStateEntry *se;
1241 int instance_id = 0;
1243 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1244 if (!se->compat)
1245 continue;
1247 if (strcmp(idstr, se->compat->idstr) == 0
1248 && instance_id <= se->compat->instance_id) {
1249 instance_id = se->compat->instance_id + 1;
1252 return instance_id;
1255 /* TODO: Individual devices generally have very little idea about the rest
1256 of the system, so instance_id should be removed/replaced.
1257 Meanwhile pass -1 as instance_id if you do not already have a clearly
1258 distinguishing id for all instances of your device class. */
1259 int register_savevm_live(DeviceState *dev,
1260 const char *idstr,
1261 int instance_id,
1262 int version_id,
1263 SaveVMHandlers *ops,
1264 void *opaque)
1266 SaveStateEntry *se;
1268 se = g_malloc0(sizeof(SaveStateEntry));
1269 se->version_id = version_id;
1270 se->section_id = global_section_id++;
1271 se->ops = ops;
1272 se->opaque = opaque;
1273 se->vmsd = NULL;
1274 se->no_migrate = 0;
1275 /* if this is a live_savem then set is_ram */
1276 if (ops->save_live_setup != NULL) {
1277 se->is_ram = 1;
1280 if (dev) {
1281 char *id = qdev_get_dev_path(dev);
1282 if (id) {
1283 pstrcpy(se->idstr, sizeof(se->idstr), id);
1284 pstrcat(se->idstr, sizeof(se->idstr), "/");
1285 g_free(id);
1287 se->compat = g_malloc0(sizeof(CompatEntry));
1288 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1289 se->compat->instance_id = instance_id == -1 ?
1290 calculate_compat_instance_id(idstr) : instance_id;
1291 instance_id = -1;
1294 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1296 if (instance_id == -1) {
1297 se->instance_id = calculate_new_instance_id(se->idstr);
1298 } else {
1299 se->instance_id = instance_id;
1301 assert(!se->compat || se->instance_id == 0);
1302 /* add at the end of list */
1303 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1304 return 0;
1307 int register_savevm(DeviceState *dev,
1308 const char *idstr,
1309 int instance_id,
1310 int version_id,
1311 SaveStateHandler *save_state,
1312 LoadStateHandler *load_state,
1313 void *opaque)
1315 SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
1316 ops->save_state = save_state;
1317 ops->load_state = load_state;
1318 return register_savevm_live(dev, idstr, instance_id, version_id,
1319 ops, opaque);
1322 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1324 SaveStateEntry *se, *new_se;
1325 char id[256] = "";
1327 if (dev) {
1328 char *path = qdev_get_dev_path(dev);
1329 if (path) {
1330 pstrcpy(id, sizeof(id), path);
1331 pstrcat(id, sizeof(id), "/");
1332 g_free(path);
1335 pstrcat(id, sizeof(id), idstr);
1337 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1338 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1339 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1340 if (se->compat) {
1341 g_free(se->compat);
1343 g_free(se->ops);
1344 g_free(se);
1349 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1350 const VMStateDescription *vmsd,
1351 void *opaque, int alias_id,
1352 int required_for_version)
1354 SaveStateEntry *se;
1356 /* If this triggers, alias support can be dropped for the vmsd. */
1357 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1359 se = g_malloc0(sizeof(SaveStateEntry));
1360 se->version_id = vmsd->version_id;
1361 se->section_id = global_section_id++;
1362 se->opaque = opaque;
1363 se->vmsd = vmsd;
1364 se->alias_id = alias_id;
1365 se->no_migrate = vmsd->unmigratable;
1367 if (dev) {
1368 char *id = qdev_get_dev_path(dev);
1369 if (id) {
1370 pstrcpy(se->idstr, sizeof(se->idstr), id);
1371 pstrcat(se->idstr, sizeof(se->idstr), "/");
1372 g_free(id);
1374 se->compat = g_malloc0(sizeof(CompatEntry));
1375 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1376 se->compat->instance_id = instance_id == -1 ?
1377 calculate_compat_instance_id(vmsd->name) : instance_id;
1378 instance_id = -1;
1381 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1383 if (instance_id == -1) {
1384 se->instance_id = calculate_new_instance_id(se->idstr);
1385 } else {
1386 se->instance_id = instance_id;
1388 assert(!se->compat || se->instance_id == 0);
1389 /* add at the end of list */
1390 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1391 return 0;
1394 int vmstate_register(DeviceState *dev, int instance_id,
1395 const VMStateDescription *vmsd, void *opaque)
1397 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1398 opaque, -1, 0);
1401 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1402 void *opaque)
1404 SaveStateEntry *se, *new_se;
1406 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1407 if (se->vmsd == vmsd && se->opaque == opaque) {
1408 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1409 if (se->compat) {
1410 g_free(se->compat);
1412 g_free(se);
1417 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1418 void *opaque);
1419 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1420 void *opaque);
1422 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1423 void *opaque, int version_id)
1425 VMStateField *field = vmsd->fields;
1426 int ret;
1428 if (version_id > vmsd->version_id) {
1429 return -EINVAL;
1431 if (version_id < vmsd->minimum_version_id_old) {
1432 return -EINVAL;
1434 if (version_id < vmsd->minimum_version_id) {
1435 return vmsd->load_state_old(f, opaque, version_id);
1437 if (vmsd->pre_load) {
1438 int ret = vmsd->pre_load(opaque);
1439 if (ret)
1440 return ret;
1442 while(field->name) {
1443 if ((field->field_exists &&
1444 field->field_exists(opaque, version_id)) ||
1445 (!field->field_exists &&
1446 field->version_id <= version_id)) {
1447 void *base_addr = opaque + field->offset;
1448 int i, n_elems = 1;
1449 int size = field->size;
1451 if (field->flags & VMS_VBUFFER) {
1452 size = *(int32_t *)(opaque+field->size_offset);
1453 if (field->flags & VMS_MULTIPLY) {
1454 size *= field->size;
1457 if (field->flags & VMS_ARRAY) {
1458 n_elems = field->num;
1459 } else if (field->flags & VMS_VARRAY_INT32) {
1460 n_elems = *(int32_t *)(opaque+field->num_offset);
1461 } else if (field->flags & VMS_VARRAY_UINT32) {
1462 n_elems = *(uint32_t *)(opaque+field->num_offset);
1463 } else if (field->flags & VMS_VARRAY_UINT16) {
1464 n_elems = *(uint16_t *)(opaque+field->num_offset);
1465 } else if (field->flags & VMS_VARRAY_UINT8) {
1466 n_elems = *(uint8_t *)(opaque+field->num_offset);
1468 if (field->flags & VMS_POINTER) {
1469 base_addr = *(void **)base_addr + field->start;
1471 for (i = 0; i < n_elems; i++) {
1472 void *addr = base_addr + size * i;
1474 if (field->flags & VMS_ARRAY_OF_POINTER) {
1475 addr = *(void **)addr;
1477 if (field->flags & VMS_STRUCT) {
1478 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1479 } else {
1480 ret = field->info->get(f, addr, size);
1483 if (ret < 0) {
1484 return ret;
1488 field++;
1490 ret = vmstate_subsection_load(f, vmsd, opaque);
1491 if (ret != 0) {
1492 return ret;
1494 if (vmsd->post_load) {
1495 return vmsd->post_load(opaque, version_id);
1497 return 0;
1500 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1501 void *opaque)
1503 VMStateField *field = vmsd->fields;
1505 if (vmsd->pre_save) {
1506 vmsd->pre_save(opaque);
1508 while(field->name) {
1509 if (!field->field_exists ||
1510 field->field_exists(opaque, vmsd->version_id)) {
1511 void *base_addr = opaque + field->offset;
1512 int i, n_elems = 1;
1513 int size = field->size;
1515 if (field->flags & VMS_VBUFFER) {
1516 size = *(int32_t *)(opaque+field->size_offset);
1517 if (field->flags & VMS_MULTIPLY) {
1518 size *= field->size;
1521 if (field->flags & VMS_ARRAY) {
1522 n_elems = field->num;
1523 } else if (field->flags & VMS_VARRAY_INT32) {
1524 n_elems = *(int32_t *)(opaque+field->num_offset);
1525 } else if (field->flags & VMS_VARRAY_UINT32) {
1526 n_elems = *(uint32_t *)(opaque+field->num_offset);
1527 } else if (field->flags & VMS_VARRAY_UINT16) {
1528 n_elems = *(uint16_t *)(opaque+field->num_offset);
1529 } else if (field->flags & VMS_VARRAY_UINT8) {
1530 n_elems = *(uint8_t *)(opaque+field->num_offset);
1532 if (field->flags & VMS_POINTER) {
1533 base_addr = *(void **)base_addr + field->start;
1535 for (i = 0; i < n_elems; i++) {
1536 void *addr = base_addr + size * i;
1538 if (field->flags & VMS_ARRAY_OF_POINTER) {
1539 addr = *(void **)addr;
1541 if (field->flags & VMS_STRUCT) {
1542 vmstate_save_state(f, field->vmsd, addr);
1543 } else {
1544 field->info->put(f, addr, size);
1548 field++;
1550 vmstate_subsection_save(f, vmsd, opaque);
1553 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1555 if (!se->vmsd) { /* Old style */
1556 return se->ops->load_state(f, se->opaque, version_id);
1558 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1561 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1563 if (!se->vmsd) { /* Old style */
1564 se->ops->save_state(f, se->opaque);
1565 return;
1567 vmstate_save_state(f,se->vmsd, se->opaque);
1570 #define QEMU_VM_FILE_MAGIC 0x5145564d
1571 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1572 #define QEMU_VM_FILE_VERSION 0x00000003
1574 #define QEMU_VM_EOF 0x00
1575 #define QEMU_VM_SECTION_START 0x01
1576 #define QEMU_VM_SECTION_PART 0x02
1577 #define QEMU_VM_SECTION_END 0x03
1578 #define QEMU_VM_SECTION_FULL 0x04
1579 #define QEMU_VM_SUBSECTION 0x05
1581 bool qemu_savevm_state_blocked(Error **errp)
1583 SaveStateEntry *se;
1585 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1586 if (se->no_migrate) {
1587 error_set(errp, QERR_MIGRATION_NOT_SUPPORTED, se->idstr);
1588 return true;
1591 return false;
1594 void qemu_savevm_state_begin(QEMUFile *f,
1595 const MigrationParams *params)
1597 SaveStateEntry *se;
1598 int ret;
1600 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1601 if (!se->ops || !se->ops->set_params) {
1602 continue;
1604 se->ops->set_params(params, se->opaque);
1607 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1608 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1610 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1611 int len;
1613 if (!se->ops || !se->ops->save_live_setup) {
1614 continue;
1616 if (se->ops && se->ops->is_active) {
1617 if (!se->ops->is_active(se->opaque)) {
1618 continue;
1621 /* Section type */
1622 qemu_put_byte(f, QEMU_VM_SECTION_START);
1623 qemu_put_be32(f, se->section_id);
1625 /* ID string */
1626 len = strlen(se->idstr);
1627 qemu_put_byte(f, len);
1628 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1630 qemu_put_be32(f, se->instance_id);
1631 qemu_put_be32(f, se->version_id);
1633 ret = se->ops->save_live_setup(f, se->opaque);
1634 if (ret < 0) {
1635 qemu_file_set_error(f, ret);
1636 break;
1642 * this function has three return values:
1643 * negative: there was one error, and we have -errno.
1644 * 0 : We haven't finished, caller have to go again
1645 * 1 : We have finished, we can go to complete phase
1647 int qemu_savevm_state_iterate(QEMUFile *f)
1649 SaveStateEntry *se;
1650 int ret = 1;
1652 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1653 if (!se->ops || !se->ops->save_live_iterate) {
1654 continue;
1656 if (se->ops && se->ops->is_active) {
1657 if (!se->ops->is_active(se->opaque)) {
1658 continue;
1661 if (qemu_file_rate_limit(f)) {
1662 return 0;
1664 trace_savevm_section_start();
1665 /* Section type */
1666 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1667 qemu_put_be32(f, se->section_id);
1669 ret = se->ops->save_live_iterate(f, se->opaque);
1670 trace_savevm_section_end(se->section_id);
1672 if (ret < 0) {
1673 qemu_file_set_error(f, ret);
1675 if (ret <= 0) {
1676 /* Do not proceed to the next vmstate before this one reported
1677 completion of the current stage. This serializes the migration
1678 and reduces the probability that a faster changing state is
1679 synchronized over and over again. */
1680 break;
1683 return ret;
1686 void 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 qemu_file_set_error(f, ret);
1711 return;
1715 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1716 int len;
1718 if ((!se->ops || !se->ops->save_state) && !se->vmsd) {
1719 continue;
1721 trace_savevm_section_start();
1722 /* Section type */
1723 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1724 qemu_put_be32(f, se->section_id);
1726 /* ID string */
1727 len = strlen(se->idstr);
1728 qemu_put_byte(f, len);
1729 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1731 qemu_put_be32(f, se->instance_id);
1732 qemu_put_be32(f, se->version_id);
1734 vmstate_save(f, se);
1735 trace_savevm_section_end(se->section_id);
1738 qemu_put_byte(f, QEMU_VM_EOF);
1739 qemu_fflush(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 return -EINVAL;
1784 qemu_mutex_unlock_iothread();
1785 qemu_savevm_state_begin(f, &params);
1786 qemu_mutex_lock_iothread();
1788 while (qemu_file_get_error(f) == 0) {
1789 if (qemu_savevm_state_iterate(f) > 0) {
1790 break;
1794 ret = qemu_file_get_error(f);
1795 if (ret == 0) {
1796 qemu_savevm_state_complete(f);
1797 ret = qemu_file_get_error(f);
1799 if (ret != 0) {
1800 qemu_savevm_state_cancel();
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);