Documentation: Add syntax for using sheepdog devices
[qemu.git] / savevm.c
blobf01838fb2dda0101fbd9169667253b9a057727e8
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.
24 #include <unistd.h>
25 #include <fcntl.h>
26 #include <time.h>
27 #include <errno.h>
28 #include <sys/time.h>
29 #include <zlib.h>
31 /* Needed early for CONFIG_BSD etc. */
32 #include "config-host.h"
34 #ifndef _WIN32
35 #include <sys/times.h>
36 #include <sys/wait.h>
37 #include <termios.h>
38 #include <sys/mman.h>
39 #include <sys/ioctl.h>
40 #include <sys/resource.h>
41 #include <sys/socket.h>
42 #include <netinet/in.h>
43 #include <net/if.h>
44 #include <arpa/inet.h>
45 #include <dirent.h>
46 #include <netdb.h>
47 #include <sys/select.h>
48 #ifdef CONFIG_BSD
49 #include <sys/stat.h>
50 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
51 #include <libutil.h>
52 #else
53 #include <util.h>
54 #endif
55 #ifdef __linux__
56 #include <pty.h>
57 #include <malloc.h>
58 #include <linux/rtc.h>
59 #endif
60 #endif
61 #endif
63 #ifdef _WIN32
64 #include <windows.h>
65 #include <malloc.h>
66 #include <sys/timeb.h>
67 #include <mmsystem.h>
68 #define getopt_long_only getopt_long
69 #define memalign(align, size) malloc(size)
70 #endif
72 #include "qemu-common.h"
73 #include "hw/hw.h"
74 #include "hw/qdev.h"
75 #include "net.h"
76 #include "monitor.h"
77 #include "sysemu.h"
78 #include "qemu-timer.h"
79 #include "qemu-char.h"
80 #include "audio/audio.h"
81 #include "migration.h"
82 #include "qemu_socket.h"
83 #include "qemu-queue.h"
84 #include "qemu-timer.h"
85 #include "cpus.h"
87 #define SELF_ANNOUNCE_ROUNDS 5
89 #ifndef ETH_P_RARP
90 #define ETH_P_RARP 0x8035
91 #endif
92 #define ARP_HTYPE_ETH 0x0001
93 #define ARP_PTYPE_IP 0x0800
94 #define ARP_OP_REQUEST_REV 0x3
96 static int announce_self_create(uint8_t *buf,
97 uint8_t *mac_addr)
99 /* Ethernet header. */
100 memset(buf, 0xff, 6); /* destination MAC addr */
101 memcpy(buf + 6, mac_addr, 6); /* source MAC addr */
102 *(uint16_t *)(buf + 12) = htons(ETH_P_RARP); /* ethertype */
104 /* RARP header. */
105 *(uint16_t *)(buf + 14) = htons(ARP_HTYPE_ETH); /* hardware addr space */
106 *(uint16_t *)(buf + 16) = htons(ARP_PTYPE_IP); /* protocol addr space */
107 *(buf + 18) = 6; /* hardware addr length (ethernet) */
108 *(buf + 19) = 4; /* protocol addr length (IPv4) */
109 *(uint16_t *)(buf + 20) = htons(ARP_OP_REQUEST_REV); /* opcode */
110 memcpy(buf + 22, mac_addr, 6); /* source hw addr */
111 memset(buf + 28, 0x00, 4); /* source protocol addr */
112 memcpy(buf + 32, mac_addr, 6); /* target hw addr */
113 memset(buf + 38, 0x00, 4); /* target protocol addr */
115 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
116 memset(buf + 42, 0x00, 18);
118 return 60; /* len (FCS will be added by hardware) */
121 static void qemu_announce_self_iter(NICState *nic, void *opaque)
123 uint8_t buf[60];
124 int len;
126 len = announce_self_create(buf, nic->conf->macaddr.a);
128 qemu_send_packet_raw(&nic->nc, buf, len);
132 static void qemu_announce_self_once(void *opaque)
134 static int count = SELF_ANNOUNCE_ROUNDS;
135 QEMUTimer *timer = *(QEMUTimer **)opaque;
137 qemu_foreach_nic(qemu_announce_self_iter, NULL);
139 if (--count) {
140 /* delay 50ms, 150ms, 250ms, ... */
141 qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
142 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
143 } else {
144 qemu_del_timer(timer);
145 qemu_free_timer(timer);
149 void qemu_announce_self(void)
151 static QEMUTimer *timer;
152 timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
153 qemu_announce_self_once(&timer);
156 /***********************************************************/
157 /* savevm/loadvm support */
159 #define IO_BUF_SIZE 32768
161 struct QEMUFile {
162 QEMUFilePutBufferFunc *put_buffer;
163 QEMUFileGetBufferFunc *get_buffer;
164 QEMUFileCloseFunc *close;
165 QEMUFileRateLimit *rate_limit;
166 QEMUFileSetRateLimit *set_rate_limit;
167 QEMUFileGetRateLimit *get_rate_limit;
168 void *opaque;
169 int is_write;
171 int64_t buf_offset; /* start of buffer when writing, end of buffer
172 when reading */
173 int buf_index;
174 int buf_size; /* 0 when writing */
175 uint8_t buf[IO_BUF_SIZE];
177 int last_error;
180 typedef struct QEMUFileStdio
182 FILE *stdio_file;
183 QEMUFile *file;
184 } QEMUFileStdio;
186 typedef struct QEMUFileSocket
188 int fd;
189 QEMUFile *file;
190 } QEMUFileSocket;
192 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
194 QEMUFileSocket *s = opaque;
195 ssize_t len;
197 do {
198 len = qemu_recv(s->fd, buf, size, 0);
199 } while (len == -1 && socket_error() == EINTR);
201 if (len == -1)
202 len = -socket_error();
204 return len;
207 static int socket_close(void *opaque)
209 QEMUFileSocket *s = opaque;
210 g_free(s);
211 return 0;
214 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
216 QEMUFileStdio *s = opaque;
217 return fwrite(buf, 1, size, s->stdio_file);
220 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
222 QEMUFileStdio *s = opaque;
223 FILE *fp = s->stdio_file;
224 int bytes;
226 do {
227 clearerr(fp);
228 bytes = fread(buf, 1, size, fp);
229 } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
230 return bytes;
233 static int stdio_pclose(void *opaque)
235 QEMUFileStdio *s = opaque;
236 int ret;
237 ret = pclose(s->stdio_file);
238 g_free(s);
239 return ret;
242 static int stdio_fclose(void *opaque)
244 QEMUFileStdio *s = opaque;
245 fclose(s->stdio_file);
246 g_free(s);
247 return 0;
250 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
252 QEMUFileStdio *s;
254 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
255 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
256 return NULL;
259 s = g_malloc0(sizeof(QEMUFileStdio));
261 s->stdio_file = stdio_file;
263 if(mode[0] == 'r') {
264 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose,
265 NULL, NULL, NULL);
266 } else {
267 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose,
268 NULL, NULL, NULL);
270 return s->file;
273 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
275 FILE *popen_file;
277 popen_file = popen(command, mode);
278 if(popen_file == NULL) {
279 return NULL;
282 return qemu_popen(popen_file, mode);
285 int qemu_stdio_fd(QEMUFile *f)
287 QEMUFileStdio *p;
288 int fd;
290 p = (QEMUFileStdio *)f->opaque;
291 fd = fileno(p->stdio_file);
293 return fd;
296 QEMUFile *qemu_fdopen(int fd, const char *mode)
298 QEMUFileStdio *s;
300 if (mode == NULL ||
301 (mode[0] != 'r' && mode[0] != 'w') ||
302 mode[1] != 'b' || mode[2] != 0) {
303 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
304 return NULL;
307 s = g_malloc0(sizeof(QEMUFileStdio));
308 s->stdio_file = fdopen(fd, mode);
309 if (!s->stdio_file)
310 goto fail;
312 if(mode[0] == 'r') {
313 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose,
314 NULL, NULL, NULL);
315 } else {
316 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose,
317 NULL, NULL, NULL);
319 return s->file;
321 fail:
322 g_free(s);
323 return NULL;
326 QEMUFile *qemu_fopen_socket(int fd)
328 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
330 s->fd = fd;
331 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close,
332 NULL, NULL, NULL);
333 return s->file;
336 static int file_put_buffer(void *opaque, const uint8_t *buf,
337 int64_t pos, int size)
339 QEMUFileStdio *s = opaque;
340 fseek(s->stdio_file, pos, SEEK_SET);
341 return fwrite(buf, 1, size, s->stdio_file);
344 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
346 QEMUFileStdio *s = opaque;
347 fseek(s->stdio_file, pos, SEEK_SET);
348 return fread(buf, 1, size, s->stdio_file);
351 QEMUFile *qemu_fopen(const char *filename, const char *mode)
353 QEMUFileStdio *s;
355 if (mode == NULL ||
356 (mode[0] != 'r' && mode[0] != 'w') ||
357 mode[1] != 'b' || mode[2] != 0) {
358 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
359 return NULL;
362 s = g_malloc0(sizeof(QEMUFileStdio));
364 s->stdio_file = fopen(filename, mode);
365 if (!s->stdio_file)
366 goto fail;
368 if(mode[0] == 'w') {
369 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose,
370 NULL, NULL, NULL);
371 } else {
372 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose,
373 NULL, NULL, NULL);
375 return s->file;
376 fail:
377 g_free(s);
378 return NULL;
381 static int block_put_buffer(void *opaque, const uint8_t *buf,
382 int64_t pos, int size)
384 bdrv_save_vmstate(opaque, buf, pos, size);
385 return size;
388 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
390 return bdrv_load_vmstate(opaque, buf, pos, size);
393 static int bdrv_fclose(void *opaque)
395 return 0;
398 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
400 if (is_writable)
401 return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose,
402 NULL, NULL, NULL);
403 return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL, NULL);
406 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
407 QEMUFileGetBufferFunc *get_buffer,
408 QEMUFileCloseFunc *close,
409 QEMUFileRateLimit *rate_limit,
410 QEMUFileSetRateLimit *set_rate_limit,
411 QEMUFileGetRateLimit *get_rate_limit)
413 QEMUFile *f;
415 f = g_malloc0(sizeof(QEMUFile));
417 f->opaque = opaque;
418 f->put_buffer = put_buffer;
419 f->get_buffer = get_buffer;
420 f->close = close;
421 f->rate_limit = rate_limit;
422 f->set_rate_limit = set_rate_limit;
423 f->get_rate_limit = get_rate_limit;
424 f->is_write = 0;
426 return f;
429 int qemu_file_get_error(QEMUFile *f)
431 return f->last_error;
434 void qemu_file_set_error(QEMUFile *f, int ret)
436 f->last_error = ret;
439 void qemu_fflush(QEMUFile *f)
441 if (!f->put_buffer)
442 return;
444 if (f->is_write && f->buf_index > 0) {
445 int len;
447 len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
448 if (len > 0)
449 f->buf_offset += f->buf_index;
450 else
451 f->last_error = -EINVAL;
452 f->buf_index = 0;
456 static void qemu_fill_buffer(QEMUFile *f)
458 int len;
459 int pending;
461 if (!f->get_buffer)
462 return;
464 if (f->is_write)
465 abort();
467 pending = f->buf_size - f->buf_index;
468 if (pending > 0) {
469 memmove(f->buf, f->buf + f->buf_index, pending);
471 f->buf_index = 0;
472 f->buf_size = pending;
474 len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
475 IO_BUF_SIZE - pending);
476 if (len > 0) {
477 f->buf_size += len;
478 f->buf_offset += len;
479 } else if (len != -EAGAIN)
480 f->last_error = len;
483 int qemu_fclose(QEMUFile *f)
485 int ret = 0;
486 qemu_fflush(f);
487 if (f->close)
488 ret = f->close(f->opaque);
489 g_free(f);
490 return ret;
493 void qemu_file_put_notify(QEMUFile *f)
495 f->put_buffer(f->opaque, NULL, 0, 0);
498 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
500 int l;
502 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
503 fprintf(stderr,
504 "Attempted to write to buffer while read buffer is not empty\n");
505 abort();
508 while (!f->last_error && size > 0) {
509 l = IO_BUF_SIZE - f->buf_index;
510 if (l > size)
511 l = size;
512 memcpy(f->buf + f->buf_index, buf, l);
513 f->is_write = 1;
514 f->buf_index += l;
515 buf += l;
516 size -= l;
517 if (f->buf_index >= IO_BUF_SIZE)
518 qemu_fflush(f);
522 void qemu_put_byte(QEMUFile *f, int v)
524 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
525 fprintf(stderr,
526 "Attempted to write to buffer while read buffer is not empty\n");
527 abort();
530 f->buf[f->buf_index++] = v;
531 f->is_write = 1;
532 if (f->buf_index >= IO_BUF_SIZE)
533 qemu_fflush(f);
536 static void qemu_file_skip(QEMUFile *f, int size)
538 if (f->buf_index + size <= f->buf_size) {
539 f->buf_index += size;
543 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
545 int pending;
546 int index;
548 if (f->is_write) {
549 abort();
552 index = f->buf_index + offset;
553 pending = f->buf_size - index;
554 if (pending < size) {
555 qemu_fill_buffer(f);
556 index = f->buf_index + offset;
557 pending = f->buf_size - index;
560 if (pending <= 0) {
561 return 0;
563 if (size > pending) {
564 size = pending;
567 memcpy(buf, f->buf + index, size);
568 return size;
571 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
573 int pending = size;
574 int done = 0;
576 while (pending > 0) {
577 int res;
579 res = qemu_peek_buffer(f, buf, pending, 0);
580 if (res == 0) {
581 return done;
583 qemu_file_skip(f, res);
584 buf += res;
585 pending -= res;
586 done += res;
588 return done;
591 static int qemu_peek_byte(QEMUFile *f, int offset)
593 int index = f->buf_index + offset;
595 if (f->is_write) {
596 abort();
599 if (index >= f->buf_size) {
600 qemu_fill_buffer(f);
601 index = f->buf_index + offset;
602 if (index >= f->buf_size) {
603 return 0;
606 return f->buf[index];
609 int qemu_get_byte(QEMUFile *f)
611 int result;
613 result = qemu_peek_byte(f, 0);
614 qemu_file_skip(f, 1);
615 return result;
618 int64_t qemu_ftell(QEMUFile *f)
620 return f->buf_offset - f->buf_size + f->buf_index;
623 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
625 if (whence == SEEK_SET) {
626 /* nothing to do */
627 } else if (whence == SEEK_CUR) {
628 pos += qemu_ftell(f);
629 } else {
630 /* SEEK_END not supported */
631 return -1;
633 if (f->put_buffer) {
634 qemu_fflush(f);
635 f->buf_offset = pos;
636 } else {
637 f->buf_offset = pos;
638 f->buf_index = 0;
639 f->buf_size = 0;
641 return pos;
644 int qemu_file_rate_limit(QEMUFile *f)
646 if (f->rate_limit)
647 return f->rate_limit(f->opaque);
649 return 0;
652 int64_t qemu_file_get_rate_limit(QEMUFile *f)
654 if (f->get_rate_limit)
655 return f->get_rate_limit(f->opaque);
657 return 0;
660 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
662 /* any failed or completed migration keeps its state to allow probing of
663 * migration data, but has no associated file anymore */
664 if (f && f->set_rate_limit)
665 return f->set_rate_limit(f->opaque, new_rate);
667 return 0;
670 void qemu_put_be16(QEMUFile *f, unsigned int v)
672 qemu_put_byte(f, v >> 8);
673 qemu_put_byte(f, v);
676 void qemu_put_be32(QEMUFile *f, unsigned int v)
678 qemu_put_byte(f, v >> 24);
679 qemu_put_byte(f, v >> 16);
680 qemu_put_byte(f, v >> 8);
681 qemu_put_byte(f, v);
684 void qemu_put_be64(QEMUFile *f, uint64_t v)
686 qemu_put_be32(f, v >> 32);
687 qemu_put_be32(f, v);
690 unsigned int qemu_get_be16(QEMUFile *f)
692 unsigned int v;
693 v = qemu_get_byte(f) << 8;
694 v |= qemu_get_byte(f);
695 return v;
698 unsigned int qemu_get_be32(QEMUFile *f)
700 unsigned int v;
701 v = qemu_get_byte(f) << 24;
702 v |= qemu_get_byte(f) << 16;
703 v |= qemu_get_byte(f) << 8;
704 v |= qemu_get_byte(f);
705 return v;
708 uint64_t qemu_get_be64(QEMUFile *f)
710 uint64_t v;
711 v = (uint64_t)qemu_get_be32(f) << 32;
712 v |= qemu_get_be32(f);
713 return v;
717 /* timer */
719 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
721 uint64_t expire_time;
723 expire_time = qemu_timer_expire_time_ns(ts);
724 qemu_put_be64(f, expire_time);
727 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
729 uint64_t expire_time;
731 expire_time = qemu_get_be64(f);
732 if (expire_time != -1) {
733 qemu_mod_timer_ns(ts, expire_time);
734 } else {
735 qemu_del_timer(ts);
740 /* bool */
742 static int get_bool(QEMUFile *f, void *pv, size_t size)
744 bool *v = pv;
745 *v = qemu_get_byte(f);
746 return 0;
749 static void put_bool(QEMUFile *f, void *pv, size_t size)
751 bool *v = pv;
752 qemu_put_byte(f, *v);
755 const VMStateInfo vmstate_info_bool = {
756 .name = "bool",
757 .get = get_bool,
758 .put = put_bool,
761 /* 8 bit int */
763 static int get_int8(QEMUFile *f, void *pv, size_t size)
765 int8_t *v = pv;
766 qemu_get_s8s(f, v);
767 return 0;
770 static void put_int8(QEMUFile *f, void *pv, size_t size)
772 int8_t *v = pv;
773 qemu_put_s8s(f, v);
776 const VMStateInfo vmstate_info_int8 = {
777 .name = "int8",
778 .get = get_int8,
779 .put = put_int8,
782 /* 16 bit int */
784 static int get_int16(QEMUFile *f, void *pv, size_t size)
786 int16_t *v = pv;
787 qemu_get_sbe16s(f, v);
788 return 0;
791 static void put_int16(QEMUFile *f, void *pv, size_t size)
793 int16_t *v = pv;
794 qemu_put_sbe16s(f, v);
797 const VMStateInfo vmstate_info_int16 = {
798 .name = "int16",
799 .get = get_int16,
800 .put = put_int16,
803 /* 32 bit int */
805 static int get_int32(QEMUFile *f, void *pv, size_t size)
807 int32_t *v = pv;
808 qemu_get_sbe32s(f, v);
809 return 0;
812 static void put_int32(QEMUFile *f, void *pv, size_t size)
814 int32_t *v = pv;
815 qemu_put_sbe32s(f, v);
818 const VMStateInfo vmstate_info_int32 = {
819 .name = "int32",
820 .get = get_int32,
821 .put = put_int32,
824 /* 32 bit int. See that the received value is the same than the one
825 in the field */
827 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
829 int32_t *v = pv;
830 int32_t v2;
831 qemu_get_sbe32s(f, &v2);
833 if (*v == v2)
834 return 0;
835 return -EINVAL;
838 const VMStateInfo vmstate_info_int32_equal = {
839 .name = "int32 equal",
840 .get = get_int32_equal,
841 .put = put_int32,
844 /* 32 bit int. See that the received value is the less or the same
845 than the one in the field */
847 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
849 int32_t *old = pv;
850 int32_t new;
851 qemu_get_sbe32s(f, &new);
853 if (*old <= new)
854 return 0;
855 return -EINVAL;
858 const VMStateInfo vmstate_info_int32_le = {
859 .name = "int32 equal",
860 .get = get_int32_le,
861 .put = put_int32,
864 /* 64 bit int */
866 static int get_int64(QEMUFile *f, void *pv, size_t size)
868 int64_t *v = pv;
869 qemu_get_sbe64s(f, v);
870 return 0;
873 static void put_int64(QEMUFile *f, void *pv, size_t size)
875 int64_t *v = pv;
876 qemu_put_sbe64s(f, v);
879 const VMStateInfo vmstate_info_int64 = {
880 .name = "int64",
881 .get = get_int64,
882 .put = put_int64,
885 /* 8 bit unsigned int */
887 static int get_uint8(QEMUFile *f, void *pv, size_t size)
889 uint8_t *v = pv;
890 qemu_get_8s(f, v);
891 return 0;
894 static void put_uint8(QEMUFile *f, void *pv, size_t size)
896 uint8_t *v = pv;
897 qemu_put_8s(f, v);
900 const VMStateInfo vmstate_info_uint8 = {
901 .name = "uint8",
902 .get = get_uint8,
903 .put = put_uint8,
906 /* 16 bit unsigned int */
908 static int get_uint16(QEMUFile *f, void *pv, size_t size)
910 uint16_t *v = pv;
911 qemu_get_be16s(f, v);
912 return 0;
915 static void put_uint16(QEMUFile *f, void *pv, size_t size)
917 uint16_t *v = pv;
918 qemu_put_be16s(f, v);
921 const VMStateInfo vmstate_info_uint16 = {
922 .name = "uint16",
923 .get = get_uint16,
924 .put = put_uint16,
927 /* 32 bit unsigned int */
929 static int get_uint32(QEMUFile *f, void *pv, size_t size)
931 uint32_t *v = pv;
932 qemu_get_be32s(f, v);
933 return 0;
936 static void put_uint32(QEMUFile *f, void *pv, size_t size)
938 uint32_t *v = pv;
939 qemu_put_be32s(f, v);
942 const VMStateInfo vmstate_info_uint32 = {
943 .name = "uint32",
944 .get = get_uint32,
945 .put = put_uint32,
948 /* 32 bit uint. See that the received value is the same than the one
949 in the field */
951 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
953 uint32_t *v = pv;
954 uint32_t v2;
955 qemu_get_be32s(f, &v2);
957 if (*v == v2) {
958 return 0;
960 return -EINVAL;
963 const VMStateInfo vmstate_info_uint32_equal = {
964 .name = "uint32 equal",
965 .get = get_uint32_equal,
966 .put = put_uint32,
969 /* 64 bit unsigned int */
971 static int get_uint64(QEMUFile *f, void *pv, size_t size)
973 uint64_t *v = pv;
974 qemu_get_be64s(f, v);
975 return 0;
978 static void put_uint64(QEMUFile *f, void *pv, size_t size)
980 uint64_t *v = pv;
981 qemu_put_be64s(f, v);
984 const VMStateInfo vmstate_info_uint64 = {
985 .name = "uint64",
986 .get = get_uint64,
987 .put = put_uint64,
990 /* 8 bit int. See that the received value is the same than the one
991 in the field */
993 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
995 uint8_t *v = pv;
996 uint8_t v2;
997 qemu_get_8s(f, &v2);
999 if (*v == v2)
1000 return 0;
1001 return -EINVAL;
1004 const VMStateInfo vmstate_info_uint8_equal = {
1005 .name = "uint8 equal",
1006 .get = get_uint8_equal,
1007 .put = put_uint8,
1010 /* 16 bit unsigned int int. See that the received value is the same than the one
1011 in the field */
1013 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1015 uint16_t *v = pv;
1016 uint16_t v2;
1017 qemu_get_be16s(f, &v2);
1019 if (*v == v2)
1020 return 0;
1021 return -EINVAL;
1024 const VMStateInfo vmstate_info_uint16_equal = {
1025 .name = "uint16 equal",
1026 .get = get_uint16_equal,
1027 .put = put_uint16,
1030 /* timers */
1032 static int get_timer(QEMUFile *f, void *pv, size_t size)
1034 QEMUTimer *v = pv;
1035 qemu_get_timer(f, v);
1036 return 0;
1039 static void put_timer(QEMUFile *f, void *pv, size_t size)
1041 QEMUTimer *v = pv;
1042 qemu_put_timer(f, v);
1045 const VMStateInfo vmstate_info_timer = {
1046 .name = "timer",
1047 .get = get_timer,
1048 .put = put_timer,
1051 /* uint8_t buffers */
1053 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1055 uint8_t *v = pv;
1056 qemu_get_buffer(f, v, size);
1057 return 0;
1060 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1062 uint8_t *v = pv;
1063 qemu_put_buffer(f, v, size);
1066 const VMStateInfo vmstate_info_buffer = {
1067 .name = "buffer",
1068 .get = get_buffer,
1069 .put = put_buffer,
1072 /* unused buffers: space that was used for some fields that are
1073 not useful anymore */
1075 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1077 uint8_t buf[1024];
1078 int block_len;
1080 while (size > 0) {
1081 block_len = MIN(sizeof(buf), size);
1082 size -= block_len;
1083 qemu_get_buffer(f, buf, block_len);
1085 return 0;
1088 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1090 static const uint8_t buf[1024];
1091 int block_len;
1093 while (size > 0) {
1094 block_len = MIN(sizeof(buf), size);
1095 size -= block_len;
1096 qemu_put_buffer(f, buf, block_len);
1100 const VMStateInfo vmstate_info_unused_buffer = {
1101 .name = "unused_buffer",
1102 .get = get_unused_buffer,
1103 .put = put_unused_buffer,
1106 typedef struct CompatEntry {
1107 char idstr[256];
1108 int instance_id;
1109 } CompatEntry;
1111 typedef struct SaveStateEntry {
1112 QTAILQ_ENTRY(SaveStateEntry) entry;
1113 char idstr[256];
1114 int instance_id;
1115 int alias_id;
1116 int version_id;
1117 int section_id;
1118 SaveSetParamsHandler *set_params;
1119 SaveLiveStateHandler *save_live_state;
1120 SaveStateHandler *save_state;
1121 LoadStateHandler *load_state;
1122 const VMStateDescription *vmsd;
1123 void *opaque;
1124 CompatEntry *compat;
1125 int no_migrate;
1126 } SaveStateEntry;
1129 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1130 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1131 static int global_section_id;
1133 static int calculate_new_instance_id(const char *idstr)
1135 SaveStateEntry *se;
1136 int instance_id = 0;
1138 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1139 if (strcmp(idstr, se->idstr) == 0
1140 && instance_id <= se->instance_id) {
1141 instance_id = se->instance_id + 1;
1144 return instance_id;
1147 static int calculate_compat_instance_id(const char *idstr)
1149 SaveStateEntry *se;
1150 int instance_id = 0;
1152 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1153 if (!se->compat)
1154 continue;
1156 if (strcmp(idstr, se->compat->idstr) == 0
1157 && instance_id <= se->compat->instance_id) {
1158 instance_id = se->compat->instance_id + 1;
1161 return instance_id;
1164 /* TODO: Individual devices generally have very little idea about the rest
1165 of the system, so instance_id should be removed/replaced.
1166 Meanwhile pass -1 as instance_id if you do not already have a clearly
1167 distinguishing id for all instances of your device class. */
1168 int register_savevm_live(DeviceState *dev,
1169 const char *idstr,
1170 int instance_id,
1171 int version_id,
1172 SaveSetParamsHandler *set_params,
1173 SaveLiveStateHandler *save_live_state,
1174 SaveStateHandler *save_state,
1175 LoadStateHandler *load_state,
1176 void *opaque)
1178 SaveStateEntry *se;
1180 se = g_malloc0(sizeof(SaveStateEntry));
1181 se->version_id = version_id;
1182 se->section_id = global_section_id++;
1183 se->set_params = set_params;
1184 se->save_live_state = save_live_state;
1185 se->save_state = save_state;
1186 se->load_state = load_state;
1187 se->opaque = opaque;
1188 se->vmsd = NULL;
1189 se->no_migrate = 0;
1191 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1192 char *id = dev->parent_bus->info->get_dev_path(dev);
1193 if (id) {
1194 pstrcpy(se->idstr, sizeof(se->idstr), id);
1195 pstrcat(se->idstr, sizeof(se->idstr), "/");
1196 g_free(id);
1198 se->compat = g_malloc0(sizeof(CompatEntry));
1199 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1200 se->compat->instance_id = instance_id == -1 ?
1201 calculate_compat_instance_id(idstr) : instance_id;
1202 instance_id = -1;
1205 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1207 if (instance_id == -1) {
1208 se->instance_id = calculate_new_instance_id(se->idstr);
1209 } else {
1210 se->instance_id = instance_id;
1212 assert(!se->compat || se->instance_id == 0);
1213 /* add at the end of list */
1214 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1215 return 0;
1218 int register_savevm(DeviceState *dev,
1219 const char *idstr,
1220 int instance_id,
1221 int version_id,
1222 SaveStateHandler *save_state,
1223 LoadStateHandler *load_state,
1224 void *opaque)
1226 return register_savevm_live(dev, idstr, instance_id, version_id,
1227 NULL, NULL, save_state, load_state, opaque);
1230 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1232 SaveStateEntry *se, *new_se;
1233 char id[256] = "";
1235 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1236 char *path = dev->parent_bus->info->get_dev_path(dev);
1237 if (path) {
1238 pstrcpy(id, sizeof(id), path);
1239 pstrcat(id, sizeof(id), "/");
1240 g_free(path);
1243 pstrcat(id, sizeof(id), idstr);
1245 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1246 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1247 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1248 if (se->compat) {
1249 g_free(se->compat);
1251 g_free(se);
1256 /* mark a device as not to be migrated, that is the device should be
1257 unplugged before migration */
1258 void register_device_unmigratable(DeviceState *dev, const char *idstr,
1259 void *opaque)
1261 SaveStateEntry *se;
1262 char id[256] = "";
1264 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1265 char *path = dev->parent_bus->info->get_dev_path(dev);
1266 if (path) {
1267 pstrcpy(id, sizeof(id), path);
1268 pstrcat(id, sizeof(id), "/");
1269 g_free(path);
1272 pstrcat(id, sizeof(id), idstr);
1274 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1275 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1276 se->no_migrate = 1;
1281 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1282 const VMStateDescription *vmsd,
1283 void *opaque, int alias_id,
1284 int required_for_version)
1286 SaveStateEntry *se;
1288 /* If this triggers, alias support can be dropped for the vmsd. */
1289 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1291 se = g_malloc0(sizeof(SaveStateEntry));
1292 se->version_id = vmsd->version_id;
1293 se->section_id = global_section_id++;
1294 se->save_live_state = NULL;
1295 se->save_state = NULL;
1296 se->load_state = NULL;
1297 se->opaque = opaque;
1298 se->vmsd = vmsd;
1299 se->alias_id = alias_id;
1300 se->no_migrate = vmsd->unmigratable;
1302 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1303 char *id = dev->parent_bus->info->get_dev_path(dev);
1304 if (id) {
1305 pstrcpy(se->idstr, sizeof(se->idstr), id);
1306 pstrcat(se->idstr, sizeof(se->idstr), "/");
1307 g_free(id);
1309 se->compat = g_malloc0(sizeof(CompatEntry));
1310 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1311 se->compat->instance_id = instance_id == -1 ?
1312 calculate_compat_instance_id(vmsd->name) : instance_id;
1313 instance_id = -1;
1316 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1318 if (instance_id == -1) {
1319 se->instance_id = calculate_new_instance_id(se->idstr);
1320 } else {
1321 se->instance_id = instance_id;
1323 assert(!se->compat || se->instance_id == 0);
1324 /* add at the end of list */
1325 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1326 return 0;
1329 int vmstate_register(DeviceState *dev, int instance_id,
1330 const VMStateDescription *vmsd, void *opaque)
1332 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1333 opaque, -1, 0);
1336 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1337 void *opaque)
1339 SaveStateEntry *se, *new_se;
1341 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1342 if (se->vmsd == vmsd && se->opaque == opaque) {
1343 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1344 if (se->compat) {
1345 g_free(se->compat);
1347 g_free(se);
1352 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1353 void *opaque);
1354 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1355 void *opaque);
1357 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1358 void *opaque, int version_id)
1360 VMStateField *field = vmsd->fields;
1361 int ret;
1363 if (version_id > vmsd->version_id) {
1364 return -EINVAL;
1366 if (version_id < vmsd->minimum_version_id_old) {
1367 return -EINVAL;
1369 if (version_id < vmsd->minimum_version_id) {
1370 return vmsd->load_state_old(f, opaque, version_id);
1372 if (vmsd->pre_load) {
1373 int ret = vmsd->pre_load(opaque);
1374 if (ret)
1375 return ret;
1377 while(field->name) {
1378 if ((field->field_exists &&
1379 field->field_exists(opaque, version_id)) ||
1380 (!field->field_exists &&
1381 field->version_id <= version_id)) {
1382 void *base_addr = opaque + field->offset;
1383 int i, n_elems = 1;
1384 int size = field->size;
1386 if (field->flags & VMS_VBUFFER) {
1387 size = *(int32_t *)(opaque+field->size_offset);
1388 if (field->flags & VMS_MULTIPLY) {
1389 size *= field->size;
1392 if (field->flags & VMS_ARRAY) {
1393 n_elems = field->num;
1394 } else if (field->flags & VMS_VARRAY_INT32) {
1395 n_elems = *(int32_t *)(opaque+field->num_offset);
1396 } else if (field->flags & VMS_VARRAY_UINT32) {
1397 n_elems = *(uint32_t *)(opaque+field->num_offset);
1398 } else if (field->flags & VMS_VARRAY_UINT16) {
1399 n_elems = *(uint16_t *)(opaque+field->num_offset);
1400 } else if (field->flags & VMS_VARRAY_UINT8) {
1401 n_elems = *(uint8_t *)(opaque+field->num_offset);
1403 if (field->flags & VMS_POINTER) {
1404 base_addr = *(void **)base_addr + field->start;
1406 for (i = 0; i < n_elems; i++) {
1407 void *addr = base_addr + size * i;
1409 if (field->flags & VMS_ARRAY_OF_POINTER) {
1410 addr = *(void **)addr;
1412 if (field->flags & VMS_STRUCT) {
1413 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1414 } else {
1415 ret = field->info->get(f, addr, size);
1418 if (ret < 0) {
1419 return ret;
1423 field++;
1425 ret = vmstate_subsection_load(f, vmsd, opaque);
1426 if (ret != 0) {
1427 return ret;
1429 if (vmsd->post_load) {
1430 return vmsd->post_load(opaque, version_id);
1432 return 0;
1435 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1436 void *opaque)
1438 VMStateField *field = vmsd->fields;
1440 if (vmsd->pre_save) {
1441 vmsd->pre_save(opaque);
1443 while(field->name) {
1444 if (!field->field_exists ||
1445 field->field_exists(opaque, vmsd->version_id)) {
1446 void *base_addr = opaque + field->offset;
1447 int i, n_elems = 1;
1448 int size = field->size;
1450 if (field->flags & VMS_VBUFFER) {
1451 size = *(int32_t *)(opaque+field->size_offset);
1452 if (field->flags & VMS_MULTIPLY) {
1453 size *= field->size;
1456 if (field->flags & VMS_ARRAY) {
1457 n_elems = field->num;
1458 } else if (field->flags & VMS_VARRAY_INT32) {
1459 n_elems = *(int32_t *)(opaque+field->num_offset);
1460 } else if (field->flags & VMS_VARRAY_UINT16) {
1461 n_elems = *(uint16_t *)(opaque+field->num_offset);
1462 } else if (field->flags & VMS_VARRAY_UINT8) {
1463 n_elems = *(uint8_t *)(opaque+field->num_offset);
1465 if (field->flags & VMS_POINTER) {
1466 base_addr = *(void **)base_addr + field->start;
1468 for (i = 0; i < n_elems; i++) {
1469 void *addr = base_addr + size * i;
1471 if (field->flags & VMS_ARRAY_OF_POINTER) {
1472 addr = *(void **)addr;
1474 if (field->flags & VMS_STRUCT) {
1475 vmstate_save_state(f, field->vmsd, addr);
1476 } else {
1477 field->info->put(f, addr, size);
1481 field++;
1483 vmstate_subsection_save(f, vmsd, opaque);
1486 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1488 if (!se->vmsd) { /* Old style */
1489 return se->load_state(f, se->opaque, version_id);
1491 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1494 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1496 if (!se->vmsd) { /* Old style */
1497 se->save_state(f, se->opaque);
1498 return;
1500 vmstate_save_state(f,se->vmsd, se->opaque);
1503 #define QEMU_VM_FILE_MAGIC 0x5145564d
1504 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1505 #define QEMU_VM_FILE_VERSION 0x00000003
1507 #define QEMU_VM_EOF 0x00
1508 #define QEMU_VM_SECTION_START 0x01
1509 #define QEMU_VM_SECTION_PART 0x02
1510 #define QEMU_VM_SECTION_END 0x03
1511 #define QEMU_VM_SECTION_FULL 0x04
1512 #define QEMU_VM_SUBSECTION 0x05
1514 bool qemu_savevm_state_blocked(Monitor *mon)
1516 SaveStateEntry *se;
1518 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1519 if (se->no_migrate) {
1520 monitor_printf(mon, "state blocked by non-migratable device '%s'\n",
1521 se->idstr);
1522 return true;
1525 return false;
1528 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1529 int shared)
1531 SaveStateEntry *se;
1532 int ret;
1534 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1535 if(se->set_params == NULL) {
1536 continue;
1538 se->set_params(blk_enable, shared, se->opaque);
1541 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1542 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1544 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1545 int len;
1547 if (se->save_live_state == NULL)
1548 continue;
1550 /* Section type */
1551 qemu_put_byte(f, QEMU_VM_SECTION_START);
1552 qemu_put_be32(f, se->section_id);
1554 /* ID string */
1555 len = strlen(se->idstr);
1556 qemu_put_byte(f, len);
1557 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1559 qemu_put_be32(f, se->instance_id);
1560 qemu_put_be32(f, se->version_id);
1562 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1563 if (ret < 0) {
1564 qemu_savevm_state_cancel(mon, f);
1565 return ret;
1568 ret = qemu_file_get_error(f);
1569 if (ret != 0) {
1570 qemu_savevm_state_cancel(mon, f);
1573 return ret;
1578 * this funtion has three return values:
1579 * negative: there was one error, and we have -errno.
1580 * 0 : We haven't finished, caller have to go again
1581 * 1 : We have finished, we can go to complete phase
1583 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1585 SaveStateEntry *se;
1586 int ret = 1;
1588 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1589 if (se->save_live_state == NULL)
1590 continue;
1592 /* Section type */
1593 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1594 qemu_put_be32(f, se->section_id);
1596 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1597 if (ret <= 0) {
1598 /* Do not proceed to the next vmstate before this one reported
1599 completion of the current stage. This serializes the migration
1600 and reduces the probability that a faster changing state is
1601 synchronized over and over again. */
1602 break;
1605 if (ret != 0) {
1606 return ret;
1608 ret = qemu_file_get_error(f);
1609 if (ret != 0) {
1610 qemu_savevm_state_cancel(mon, f);
1612 return ret;
1615 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1617 SaveStateEntry *se;
1618 int ret;
1620 cpu_synchronize_all_states();
1622 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1623 if (se->save_live_state == NULL)
1624 continue;
1626 /* Section type */
1627 qemu_put_byte(f, QEMU_VM_SECTION_END);
1628 qemu_put_be32(f, se->section_id);
1630 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1631 if (ret < 0) {
1632 return ret;
1636 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1637 int len;
1639 if (se->save_state == NULL && se->vmsd == NULL)
1640 continue;
1642 /* Section type */
1643 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1644 qemu_put_be32(f, se->section_id);
1646 /* ID string */
1647 len = strlen(se->idstr);
1648 qemu_put_byte(f, len);
1649 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1651 qemu_put_be32(f, se->instance_id);
1652 qemu_put_be32(f, se->version_id);
1654 vmstate_save(f, se);
1657 qemu_put_byte(f, QEMU_VM_EOF);
1659 return qemu_file_get_error(f);
1662 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1664 SaveStateEntry *se;
1666 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1667 if (se->save_live_state) {
1668 se->save_live_state(mon, f, -1, se->opaque);
1673 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
1675 int ret;
1677 if (qemu_savevm_state_blocked(mon)) {
1678 ret = -EINVAL;
1679 goto out;
1682 ret = qemu_savevm_state_begin(mon, f, 0, 0);
1683 if (ret < 0)
1684 goto out;
1686 do {
1687 ret = qemu_savevm_state_iterate(mon, f);
1688 if (ret < 0)
1689 goto out;
1690 } while (ret == 0);
1692 ret = qemu_savevm_state_complete(mon, f);
1694 out:
1695 if (ret == 0) {
1696 ret = qemu_file_get_error(f);
1699 return ret;
1702 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1704 SaveStateEntry *se;
1706 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1707 if (!strcmp(se->idstr, idstr) &&
1708 (instance_id == se->instance_id ||
1709 instance_id == se->alias_id))
1710 return se;
1711 /* Migrating from an older version? */
1712 if (strstr(se->idstr, idstr) && se->compat) {
1713 if (!strcmp(se->compat->idstr, idstr) &&
1714 (instance_id == se->compat->instance_id ||
1715 instance_id == se->alias_id))
1716 return se;
1719 return NULL;
1722 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1724 while(sub && sub->needed) {
1725 if (strcmp(idstr, sub->vmsd->name) == 0) {
1726 return sub->vmsd;
1728 sub++;
1730 return NULL;
1733 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1734 void *opaque)
1736 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1737 char idstr[256];
1738 int ret;
1739 uint8_t version_id, len, size;
1740 const VMStateDescription *sub_vmsd;
1742 len = qemu_peek_byte(f, 1);
1743 if (len < strlen(vmsd->name) + 1) {
1744 /* subsection name has be be "section_name/a" */
1745 return 0;
1747 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1748 if (size != len) {
1749 return 0;
1751 idstr[size] = 0;
1753 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1754 /* it don't have a valid subsection name */
1755 return 0;
1757 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1758 if (sub_vmsd == NULL) {
1759 return -ENOENT;
1761 qemu_file_skip(f, 1); /* subsection */
1762 qemu_file_skip(f, 1); /* len */
1763 qemu_file_skip(f, len); /* idstr */
1764 version_id = qemu_get_be32(f);
1766 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1767 if (ret) {
1768 return ret;
1771 return 0;
1774 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1775 void *opaque)
1777 const VMStateSubsection *sub = vmsd->subsections;
1779 while (sub && sub->needed) {
1780 if (sub->needed(opaque)) {
1781 const VMStateDescription *vmsd = sub->vmsd;
1782 uint8_t len;
1784 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1785 len = strlen(vmsd->name);
1786 qemu_put_byte(f, len);
1787 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1788 qemu_put_be32(f, vmsd->version_id);
1789 vmstate_save_state(f, vmsd, opaque);
1791 sub++;
1795 typedef struct LoadStateEntry {
1796 QLIST_ENTRY(LoadStateEntry) entry;
1797 SaveStateEntry *se;
1798 int section_id;
1799 int version_id;
1800 } LoadStateEntry;
1802 int qemu_loadvm_state(QEMUFile *f)
1804 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1805 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1806 LoadStateEntry *le, *new_le;
1807 uint8_t section_type;
1808 unsigned int v;
1809 int ret;
1811 if (qemu_savevm_state_blocked(default_mon)) {
1812 return -EINVAL;
1815 v = qemu_get_be32(f);
1816 if (v != QEMU_VM_FILE_MAGIC)
1817 return -EINVAL;
1819 v = qemu_get_be32(f);
1820 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1821 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1822 return -ENOTSUP;
1824 if (v != QEMU_VM_FILE_VERSION)
1825 return -ENOTSUP;
1827 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1828 uint32_t instance_id, version_id, section_id;
1829 SaveStateEntry *se;
1830 char idstr[257];
1831 int len;
1833 switch (section_type) {
1834 case QEMU_VM_SECTION_START:
1835 case QEMU_VM_SECTION_FULL:
1836 /* Read section start */
1837 section_id = qemu_get_be32(f);
1838 len = qemu_get_byte(f);
1839 qemu_get_buffer(f, (uint8_t *)idstr, len);
1840 idstr[len] = 0;
1841 instance_id = qemu_get_be32(f);
1842 version_id = qemu_get_be32(f);
1844 /* Find savevm section */
1845 se = find_se(idstr, instance_id);
1846 if (se == NULL) {
1847 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1848 ret = -EINVAL;
1849 goto out;
1852 /* Validate version */
1853 if (version_id > se->version_id) {
1854 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1855 version_id, idstr, se->version_id);
1856 ret = -EINVAL;
1857 goto out;
1860 /* Add entry */
1861 le = g_malloc0(sizeof(*le));
1863 le->se = se;
1864 le->section_id = section_id;
1865 le->version_id = version_id;
1866 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1868 ret = vmstate_load(f, le->se, le->version_id);
1869 if (ret < 0) {
1870 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1871 instance_id, idstr);
1872 goto out;
1874 break;
1875 case QEMU_VM_SECTION_PART:
1876 case QEMU_VM_SECTION_END:
1877 section_id = qemu_get_be32(f);
1879 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1880 if (le->section_id == section_id) {
1881 break;
1884 if (le == NULL) {
1885 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1886 ret = -EINVAL;
1887 goto out;
1890 ret = vmstate_load(f, le->se, le->version_id);
1891 if (ret < 0) {
1892 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1893 section_id);
1894 goto out;
1896 break;
1897 default:
1898 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1899 ret = -EINVAL;
1900 goto out;
1904 cpu_synchronize_all_post_init();
1906 ret = 0;
1908 out:
1909 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1910 QLIST_REMOVE(le, entry);
1911 g_free(le);
1914 if (ret == 0) {
1915 ret = qemu_file_get_error(f);
1918 return ret;
1921 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1922 const char *name)
1924 QEMUSnapshotInfo *sn_tab, *sn;
1925 int nb_sns, i, ret;
1927 ret = -ENOENT;
1928 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1929 if (nb_sns < 0)
1930 return ret;
1931 for(i = 0; i < nb_sns; i++) {
1932 sn = &sn_tab[i];
1933 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1934 *sn_info = *sn;
1935 ret = 0;
1936 break;
1939 g_free(sn_tab);
1940 return ret;
1944 * Deletes snapshots of a given name in all opened images.
1946 static int del_existing_snapshots(Monitor *mon, const char *name)
1948 BlockDriverState *bs;
1949 QEMUSnapshotInfo sn1, *snapshot = &sn1;
1950 int ret;
1952 bs = NULL;
1953 while ((bs = bdrv_next(bs))) {
1954 if (bdrv_can_snapshot(bs) &&
1955 bdrv_snapshot_find(bs, snapshot, name) >= 0)
1957 ret = bdrv_snapshot_delete(bs, name);
1958 if (ret < 0) {
1959 monitor_printf(mon,
1960 "Error while deleting snapshot on '%s'\n",
1961 bdrv_get_device_name(bs));
1962 return -1;
1967 return 0;
1970 void do_savevm(Monitor *mon, const QDict *qdict)
1972 BlockDriverState *bs, *bs1;
1973 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1974 int ret;
1975 QEMUFile *f;
1976 int saved_vm_running;
1977 uint32_t vm_state_size;
1978 #ifdef _WIN32
1979 struct _timeb tb;
1980 struct tm *ptm;
1981 #else
1982 struct timeval tv;
1983 struct tm tm;
1984 #endif
1985 const char *name = qdict_get_try_str(qdict, "name");
1987 /* Verify if there is a device that doesn't support snapshots and is writable */
1988 bs = NULL;
1989 while ((bs = bdrv_next(bs))) {
1991 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
1992 continue;
1995 if (!bdrv_can_snapshot(bs)) {
1996 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1997 bdrv_get_device_name(bs));
1998 return;
2002 bs = bdrv_snapshots();
2003 if (!bs) {
2004 monitor_printf(mon, "No block device can accept snapshots\n");
2005 return;
2008 saved_vm_running = runstate_is_running();
2009 vm_stop(RUN_STATE_SAVE_VM);
2011 memset(sn, 0, sizeof(*sn));
2013 /* fill auxiliary fields */
2014 #ifdef _WIN32
2015 _ftime(&tb);
2016 sn->date_sec = tb.time;
2017 sn->date_nsec = tb.millitm * 1000000;
2018 #else
2019 gettimeofday(&tv, NULL);
2020 sn->date_sec = tv.tv_sec;
2021 sn->date_nsec = tv.tv_usec * 1000;
2022 #endif
2023 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2025 if (name) {
2026 ret = bdrv_snapshot_find(bs, old_sn, name);
2027 if (ret >= 0) {
2028 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2029 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2030 } else {
2031 pstrcpy(sn->name, sizeof(sn->name), name);
2033 } else {
2034 #ifdef _WIN32
2035 ptm = localtime(&tb.time);
2036 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
2037 #else
2038 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2039 localtime_r((const time_t *)&tv.tv_sec, &tm);
2040 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2041 #endif
2044 /* Delete old snapshots of the same name */
2045 if (name && del_existing_snapshots(mon, name) < 0) {
2046 goto the_end;
2049 /* save the VM state */
2050 f = qemu_fopen_bdrv(bs, 1);
2051 if (!f) {
2052 monitor_printf(mon, "Could not open VM state file\n");
2053 goto the_end;
2055 ret = qemu_savevm_state(mon, f);
2056 vm_state_size = qemu_ftell(f);
2057 qemu_fclose(f);
2058 if (ret < 0) {
2059 monitor_printf(mon, "Error %d while writing VM\n", ret);
2060 goto the_end;
2063 /* create the snapshots */
2065 bs1 = NULL;
2066 while ((bs1 = bdrv_next(bs1))) {
2067 if (bdrv_can_snapshot(bs1)) {
2068 /* Write VM state size only to the image that contains the state */
2069 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2070 ret = bdrv_snapshot_create(bs1, sn);
2071 if (ret < 0) {
2072 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2073 bdrv_get_device_name(bs1));
2078 the_end:
2079 if (saved_vm_running)
2080 vm_start();
2083 int load_vmstate(const char *name)
2085 BlockDriverState *bs, *bs_vm_state;
2086 QEMUSnapshotInfo sn;
2087 QEMUFile *f;
2088 int ret;
2090 bs_vm_state = bdrv_snapshots();
2091 if (!bs_vm_state) {
2092 error_report("No block device supports snapshots");
2093 return -ENOTSUP;
2096 /* Don't even try to load empty VM states */
2097 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2098 if (ret < 0) {
2099 return ret;
2100 } else if (sn.vm_state_size == 0) {
2101 error_report("This is a disk-only snapshot. Revert to it offline "
2102 "using qemu-img.");
2103 return -EINVAL;
2106 /* Verify if there is any device that doesn't support snapshots and is
2107 writable and check if the requested snapshot is available too. */
2108 bs = NULL;
2109 while ((bs = bdrv_next(bs))) {
2111 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2112 continue;
2115 if (!bdrv_can_snapshot(bs)) {
2116 error_report("Device '%s' is writable but does not support snapshots.",
2117 bdrv_get_device_name(bs));
2118 return -ENOTSUP;
2121 ret = bdrv_snapshot_find(bs, &sn, name);
2122 if (ret < 0) {
2123 error_report("Device '%s' does not have the requested snapshot '%s'",
2124 bdrv_get_device_name(bs), name);
2125 return ret;
2129 /* Flush all IO requests so they don't interfere with the new state. */
2130 qemu_aio_flush();
2132 bs = NULL;
2133 while ((bs = bdrv_next(bs))) {
2134 if (bdrv_can_snapshot(bs)) {
2135 ret = bdrv_snapshot_goto(bs, name);
2136 if (ret < 0) {
2137 error_report("Error %d while activating snapshot '%s' on '%s'",
2138 ret, name, bdrv_get_device_name(bs));
2139 return ret;
2144 /* restore the VM state */
2145 f = qemu_fopen_bdrv(bs_vm_state, 0);
2146 if (!f) {
2147 error_report("Could not open VM state file");
2148 return -EINVAL;
2151 qemu_system_reset(VMRESET_SILENT);
2152 ret = qemu_loadvm_state(f);
2154 qemu_fclose(f);
2155 if (ret < 0) {
2156 error_report("Error %d while loading VM state", ret);
2157 return ret;
2160 return 0;
2163 void do_delvm(Monitor *mon, const QDict *qdict)
2165 BlockDriverState *bs, *bs1;
2166 int ret;
2167 const char *name = qdict_get_str(qdict, "name");
2169 bs = bdrv_snapshots();
2170 if (!bs) {
2171 monitor_printf(mon, "No block device supports snapshots\n");
2172 return;
2175 bs1 = NULL;
2176 while ((bs1 = bdrv_next(bs1))) {
2177 if (bdrv_can_snapshot(bs1)) {
2178 ret = bdrv_snapshot_delete(bs1, name);
2179 if (ret < 0) {
2180 if (ret == -ENOTSUP)
2181 monitor_printf(mon,
2182 "Snapshots not supported on device '%s'\n",
2183 bdrv_get_device_name(bs1));
2184 else
2185 monitor_printf(mon, "Error %d while deleting snapshot on "
2186 "'%s'\n", ret, bdrv_get_device_name(bs1));
2192 void do_info_snapshots(Monitor *mon)
2194 BlockDriverState *bs, *bs1;
2195 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2196 int nb_sns, i, ret, available;
2197 int total;
2198 int *available_snapshots;
2199 char buf[256];
2201 bs = bdrv_snapshots();
2202 if (!bs) {
2203 monitor_printf(mon, "No available block device supports snapshots\n");
2204 return;
2207 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2208 if (nb_sns < 0) {
2209 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2210 return;
2213 if (nb_sns == 0) {
2214 monitor_printf(mon, "There is no snapshot available.\n");
2215 return;
2218 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2219 total = 0;
2220 for (i = 0; i < nb_sns; i++) {
2221 sn = &sn_tab[i];
2222 available = 1;
2223 bs1 = NULL;
2225 while ((bs1 = bdrv_next(bs1))) {
2226 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2227 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2228 if (ret < 0) {
2229 available = 0;
2230 break;
2235 if (available) {
2236 available_snapshots[total] = i;
2237 total++;
2241 if (total > 0) {
2242 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2243 for (i = 0; i < total; i++) {
2244 sn = &sn_tab[available_snapshots[i]];
2245 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2247 } else {
2248 monitor_printf(mon, "There is no suitable snapshot available\n");
2251 g_free(sn_tab);
2252 g_free(available_snapshots);