migration: Pass MigrationState in migration notifiers
[qemu.git] / savevm.c
blob9e9c7835a079231b36207a12d9433894a14c6fc9
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 "cpus.h"
86 #define SELF_ANNOUNCE_ROUNDS 5
88 #ifndef ETH_P_RARP
89 #define ETH_P_RARP 0x8035
90 #endif
91 #define ARP_HTYPE_ETH 0x0001
92 #define ARP_PTYPE_IP 0x0800
93 #define ARP_OP_REQUEST_REV 0x3
95 static int announce_self_create(uint8_t *buf,
96 uint8_t *mac_addr)
98 /* Ethernet header. */
99 memset(buf, 0xff, 6); /* destination MAC addr */
100 memcpy(buf + 6, mac_addr, 6); /* source MAC addr */
101 *(uint16_t *)(buf + 12) = htons(ETH_P_RARP); /* ethertype */
103 /* RARP header. */
104 *(uint16_t *)(buf + 14) = htons(ARP_HTYPE_ETH); /* hardware addr space */
105 *(uint16_t *)(buf + 16) = htons(ARP_PTYPE_IP); /* protocol addr space */
106 *(buf + 18) = 6; /* hardware addr length (ethernet) */
107 *(buf + 19) = 4; /* protocol addr length (IPv4) */
108 *(uint16_t *)(buf + 20) = htons(ARP_OP_REQUEST_REV); /* opcode */
109 memcpy(buf + 22, mac_addr, 6); /* source hw addr */
110 memset(buf + 28, 0x00, 4); /* source protocol addr */
111 memcpy(buf + 32, mac_addr, 6); /* target hw addr */
112 memset(buf + 38, 0x00, 4); /* target protocol addr */
114 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
115 memset(buf + 42, 0x00, 18);
117 return 60; /* len (FCS will be added by hardware) */
120 static void qemu_announce_self_iter(NICState *nic, void *opaque)
122 uint8_t buf[60];
123 int len;
125 len = announce_self_create(buf, nic->conf->macaddr.a);
127 qemu_send_packet_raw(&nic->nc, buf, len);
131 static void qemu_announce_self_once(void *opaque)
133 static int count = SELF_ANNOUNCE_ROUNDS;
134 QEMUTimer *timer = *(QEMUTimer **)opaque;
136 qemu_foreach_nic(qemu_announce_self_iter, NULL);
138 if (--count) {
139 /* delay 50ms, 150ms, 250ms, ... */
140 qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
141 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
142 } else {
143 qemu_del_timer(timer);
144 qemu_free_timer(timer);
148 void qemu_announce_self(void)
150 static QEMUTimer *timer;
151 timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
152 qemu_announce_self_once(&timer);
155 /***********************************************************/
156 /* savevm/loadvm support */
158 #define IO_BUF_SIZE 32768
160 struct QEMUFile {
161 QEMUFilePutBufferFunc *put_buffer;
162 QEMUFileGetBufferFunc *get_buffer;
163 QEMUFileCloseFunc *close;
164 QEMUFileRateLimit *rate_limit;
165 QEMUFileSetRateLimit *set_rate_limit;
166 QEMUFileGetRateLimit *get_rate_limit;
167 void *opaque;
168 int is_write;
170 int64_t buf_offset; /* start of buffer when writing, end of buffer
171 when reading */
172 int buf_index;
173 int buf_size; /* 0 when writing */
174 uint8_t buf[IO_BUF_SIZE];
176 int last_error;
179 typedef struct QEMUFileStdio
181 FILE *stdio_file;
182 QEMUFile *file;
183 } QEMUFileStdio;
185 typedef struct QEMUFileSocket
187 int fd;
188 QEMUFile *file;
189 } QEMUFileSocket;
191 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
193 QEMUFileSocket *s = opaque;
194 ssize_t len;
196 do {
197 len = qemu_recv(s->fd, buf, size, 0);
198 } while (len == -1 && socket_error() == EINTR);
200 if (len == -1)
201 len = -socket_error();
203 return len;
206 static int socket_close(void *opaque)
208 QEMUFileSocket *s = opaque;
209 g_free(s);
210 return 0;
213 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
215 QEMUFileStdio *s = opaque;
216 return fwrite(buf, 1, size, s->stdio_file);
219 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
221 QEMUFileStdio *s = opaque;
222 FILE *fp = s->stdio_file;
223 int bytes;
225 do {
226 clearerr(fp);
227 bytes = fread(buf, 1, size, fp);
228 } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
229 return bytes;
232 static int stdio_pclose(void *opaque)
234 QEMUFileStdio *s = opaque;
235 int ret;
236 ret = pclose(s->stdio_file);
237 g_free(s);
238 return ret;
241 static int stdio_fclose(void *opaque)
243 QEMUFileStdio *s = opaque;
244 fclose(s->stdio_file);
245 g_free(s);
246 return 0;
249 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
251 QEMUFileStdio *s;
253 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
254 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
255 return NULL;
258 s = g_malloc0(sizeof(QEMUFileStdio));
260 s->stdio_file = stdio_file;
262 if(mode[0] == 'r') {
263 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose,
264 NULL, NULL, NULL);
265 } else {
266 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose,
267 NULL, NULL, NULL);
269 return s->file;
272 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
274 FILE *popen_file;
276 popen_file = popen(command, mode);
277 if(popen_file == NULL) {
278 return NULL;
281 return qemu_popen(popen_file, mode);
284 int qemu_stdio_fd(QEMUFile *f)
286 QEMUFileStdio *p;
287 int fd;
289 p = (QEMUFileStdio *)f->opaque;
290 fd = fileno(p->stdio_file);
292 return fd;
295 QEMUFile *qemu_fdopen(int fd, const char *mode)
297 QEMUFileStdio *s;
299 if (mode == NULL ||
300 (mode[0] != 'r' && mode[0] != 'w') ||
301 mode[1] != 'b' || mode[2] != 0) {
302 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
303 return NULL;
306 s = g_malloc0(sizeof(QEMUFileStdio));
307 s->stdio_file = fdopen(fd, mode);
308 if (!s->stdio_file)
309 goto fail;
311 if(mode[0] == 'r') {
312 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose,
313 NULL, NULL, NULL);
314 } else {
315 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose,
316 NULL, NULL, NULL);
318 return s->file;
320 fail:
321 g_free(s);
322 return NULL;
325 QEMUFile *qemu_fopen_socket(int fd)
327 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
329 s->fd = fd;
330 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close,
331 NULL, NULL, NULL);
332 return s->file;
335 static int file_put_buffer(void *opaque, const uint8_t *buf,
336 int64_t pos, int size)
338 QEMUFileStdio *s = opaque;
339 fseek(s->stdio_file, pos, SEEK_SET);
340 return fwrite(buf, 1, size, s->stdio_file);
343 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
345 QEMUFileStdio *s = opaque;
346 fseek(s->stdio_file, pos, SEEK_SET);
347 return fread(buf, 1, size, s->stdio_file);
350 QEMUFile *qemu_fopen(const char *filename, const char *mode)
352 QEMUFileStdio *s;
354 if (mode == NULL ||
355 (mode[0] != 'r' && mode[0] != 'w') ||
356 mode[1] != 'b' || mode[2] != 0) {
357 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
358 return NULL;
361 s = g_malloc0(sizeof(QEMUFileStdio));
363 s->stdio_file = fopen(filename, mode);
364 if (!s->stdio_file)
365 goto fail;
367 if(mode[0] == 'w') {
368 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose,
369 NULL, NULL, NULL);
370 } else {
371 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose,
372 NULL, NULL, NULL);
374 return s->file;
375 fail:
376 g_free(s);
377 return NULL;
380 static int block_put_buffer(void *opaque, const uint8_t *buf,
381 int64_t pos, int size)
383 bdrv_save_vmstate(opaque, buf, pos, size);
384 return size;
387 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
389 return bdrv_load_vmstate(opaque, buf, pos, size);
392 static int bdrv_fclose(void *opaque)
394 return 0;
397 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
399 if (is_writable)
400 return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose,
401 NULL, NULL, NULL);
402 return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL, NULL);
405 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
406 QEMUFileGetBufferFunc *get_buffer,
407 QEMUFileCloseFunc *close,
408 QEMUFileRateLimit *rate_limit,
409 QEMUFileSetRateLimit *set_rate_limit,
410 QEMUFileGetRateLimit *get_rate_limit)
412 QEMUFile *f;
414 f = g_malloc0(sizeof(QEMUFile));
416 f->opaque = opaque;
417 f->put_buffer = put_buffer;
418 f->get_buffer = get_buffer;
419 f->close = close;
420 f->rate_limit = rate_limit;
421 f->set_rate_limit = set_rate_limit;
422 f->get_rate_limit = get_rate_limit;
423 f->is_write = 0;
425 return f;
428 int qemu_file_get_error(QEMUFile *f)
430 return f->last_error;
433 void qemu_file_set_error(QEMUFile *f, int ret)
435 f->last_error = ret;
438 void qemu_fflush(QEMUFile *f)
440 if (!f->put_buffer)
441 return;
443 if (f->is_write && f->buf_index > 0) {
444 int len;
446 len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
447 if (len > 0)
448 f->buf_offset += f->buf_index;
449 else
450 f->last_error = -EINVAL;
451 f->buf_index = 0;
455 static void qemu_fill_buffer(QEMUFile *f)
457 int len;
458 int pending;
460 if (!f->get_buffer)
461 return;
463 if (f->is_write)
464 abort();
466 pending = f->buf_size - f->buf_index;
467 if (pending > 0) {
468 memmove(f->buf, f->buf + f->buf_index, pending);
470 f->buf_index = 0;
471 f->buf_size = pending;
473 len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
474 IO_BUF_SIZE - pending);
475 if (len > 0) {
476 f->buf_size += len;
477 f->buf_offset += len;
478 } else if (len != -EAGAIN)
479 f->last_error = len;
482 int qemu_fclose(QEMUFile *f)
484 int ret = 0;
485 qemu_fflush(f);
486 if (f->close)
487 ret = f->close(f->opaque);
488 g_free(f);
489 return ret;
492 void qemu_file_put_notify(QEMUFile *f)
494 f->put_buffer(f->opaque, NULL, 0, 0);
497 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
499 int l;
501 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
502 fprintf(stderr,
503 "Attempted to write to buffer while read buffer is not empty\n");
504 abort();
507 while (!f->last_error && size > 0) {
508 l = IO_BUF_SIZE - f->buf_index;
509 if (l > size)
510 l = size;
511 memcpy(f->buf + f->buf_index, buf, l);
512 f->is_write = 1;
513 f->buf_index += l;
514 buf += l;
515 size -= l;
516 if (f->buf_index >= IO_BUF_SIZE)
517 qemu_fflush(f);
521 void qemu_put_byte(QEMUFile *f, int v)
523 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
524 fprintf(stderr,
525 "Attempted to write to buffer while read buffer is not empty\n");
526 abort();
529 f->buf[f->buf_index++] = v;
530 f->is_write = 1;
531 if (f->buf_index >= IO_BUF_SIZE)
532 qemu_fflush(f);
535 static void qemu_file_skip(QEMUFile *f, int size)
537 if (f->buf_index + size <= f->buf_size) {
538 f->buf_index += size;
542 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
544 int pending;
545 int index;
547 if (f->is_write) {
548 abort();
551 index = f->buf_index + offset;
552 pending = f->buf_size - index;
553 if (pending < size) {
554 qemu_fill_buffer(f);
555 index = f->buf_index + offset;
556 pending = f->buf_size - index;
559 if (pending <= 0) {
560 return 0;
562 if (size > pending) {
563 size = pending;
566 memcpy(buf, f->buf + index, size);
567 return size;
570 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
572 int pending = size;
573 int done = 0;
575 while (pending > 0) {
576 int res;
578 res = qemu_peek_buffer(f, buf, pending, 0);
579 if (res == 0) {
580 return done;
582 qemu_file_skip(f, res);
583 buf += res;
584 pending -= res;
585 done += res;
587 return done;
590 static int qemu_peek_byte(QEMUFile *f, int offset)
592 int index = f->buf_index + offset;
594 if (f->is_write) {
595 abort();
598 if (index >= f->buf_size) {
599 qemu_fill_buffer(f);
600 index = f->buf_index + offset;
601 if (index >= f->buf_size) {
602 return 0;
605 return f->buf[index];
608 int qemu_get_byte(QEMUFile *f)
610 int result;
612 result = qemu_peek_byte(f, 0);
613 qemu_file_skip(f, 1);
614 return result;
617 int64_t qemu_ftell(QEMUFile *f)
619 return f->buf_offset - f->buf_size + f->buf_index;
622 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
624 if (whence == SEEK_SET) {
625 /* nothing to do */
626 } else if (whence == SEEK_CUR) {
627 pos += qemu_ftell(f);
628 } else {
629 /* SEEK_END not supported */
630 return -1;
632 if (f->put_buffer) {
633 qemu_fflush(f);
634 f->buf_offset = pos;
635 } else {
636 f->buf_offset = pos;
637 f->buf_index = 0;
638 f->buf_size = 0;
640 return pos;
643 int qemu_file_rate_limit(QEMUFile *f)
645 if (f->rate_limit)
646 return f->rate_limit(f->opaque);
648 return 0;
651 int64_t qemu_file_get_rate_limit(QEMUFile *f)
653 if (f->get_rate_limit)
654 return f->get_rate_limit(f->opaque);
656 return 0;
659 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
661 /* any failed or completed migration keeps its state to allow probing of
662 * migration data, but has no associated file anymore */
663 if (f && f->set_rate_limit)
664 return f->set_rate_limit(f->opaque, new_rate);
666 return 0;
669 void qemu_put_be16(QEMUFile *f, unsigned int v)
671 qemu_put_byte(f, v >> 8);
672 qemu_put_byte(f, v);
675 void qemu_put_be32(QEMUFile *f, unsigned int v)
677 qemu_put_byte(f, v >> 24);
678 qemu_put_byte(f, v >> 16);
679 qemu_put_byte(f, v >> 8);
680 qemu_put_byte(f, v);
683 void qemu_put_be64(QEMUFile *f, uint64_t v)
685 qemu_put_be32(f, v >> 32);
686 qemu_put_be32(f, v);
689 unsigned int qemu_get_be16(QEMUFile *f)
691 unsigned int v;
692 v = qemu_get_byte(f) << 8;
693 v |= qemu_get_byte(f);
694 return v;
697 unsigned int qemu_get_be32(QEMUFile *f)
699 unsigned int v;
700 v = qemu_get_byte(f) << 24;
701 v |= qemu_get_byte(f) << 16;
702 v |= qemu_get_byte(f) << 8;
703 v |= qemu_get_byte(f);
704 return v;
707 uint64_t qemu_get_be64(QEMUFile *f)
709 uint64_t v;
710 v = (uint64_t)qemu_get_be32(f) << 32;
711 v |= qemu_get_be32(f);
712 return v;
715 /* bool */
717 static int get_bool(QEMUFile *f, void *pv, size_t size)
719 bool *v = pv;
720 *v = qemu_get_byte(f);
721 return 0;
724 static void put_bool(QEMUFile *f, void *pv, size_t size)
726 bool *v = pv;
727 qemu_put_byte(f, *v);
730 const VMStateInfo vmstate_info_bool = {
731 .name = "bool",
732 .get = get_bool,
733 .put = put_bool,
736 /* 8 bit int */
738 static int get_int8(QEMUFile *f, void *pv, size_t size)
740 int8_t *v = pv;
741 qemu_get_s8s(f, v);
742 return 0;
745 static void put_int8(QEMUFile *f, void *pv, size_t size)
747 int8_t *v = pv;
748 qemu_put_s8s(f, v);
751 const VMStateInfo vmstate_info_int8 = {
752 .name = "int8",
753 .get = get_int8,
754 .put = put_int8,
757 /* 16 bit int */
759 static int get_int16(QEMUFile *f, void *pv, size_t size)
761 int16_t *v = pv;
762 qemu_get_sbe16s(f, v);
763 return 0;
766 static void put_int16(QEMUFile *f, void *pv, size_t size)
768 int16_t *v = pv;
769 qemu_put_sbe16s(f, v);
772 const VMStateInfo vmstate_info_int16 = {
773 .name = "int16",
774 .get = get_int16,
775 .put = put_int16,
778 /* 32 bit int */
780 static int get_int32(QEMUFile *f, void *pv, size_t size)
782 int32_t *v = pv;
783 qemu_get_sbe32s(f, v);
784 return 0;
787 static void put_int32(QEMUFile *f, void *pv, size_t size)
789 int32_t *v = pv;
790 qemu_put_sbe32s(f, v);
793 const VMStateInfo vmstate_info_int32 = {
794 .name = "int32",
795 .get = get_int32,
796 .put = put_int32,
799 /* 32 bit int. See that the received value is the same than the one
800 in the field */
802 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
804 int32_t *v = pv;
805 int32_t v2;
806 qemu_get_sbe32s(f, &v2);
808 if (*v == v2)
809 return 0;
810 return -EINVAL;
813 const VMStateInfo vmstate_info_int32_equal = {
814 .name = "int32 equal",
815 .get = get_int32_equal,
816 .put = put_int32,
819 /* 32 bit int. See that the received value is the less or the same
820 than the one in the field */
822 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
824 int32_t *old = pv;
825 int32_t new;
826 qemu_get_sbe32s(f, &new);
828 if (*old <= new)
829 return 0;
830 return -EINVAL;
833 const VMStateInfo vmstate_info_int32_le = {
834 .name = "int32 equal",
835 .get = get_int32_le,
836 .put = put_int32,
839 /* 64 bit int */
841 static int get_int64(QEMUFile *f, void *pv, size_t size)
843 int64_t *v = pv;
844 qemu_get_sbe64s(f, v);
845 return 0;
848 static void put_int64(QEMUFile *f, void *pv, size_t size)
850 int64_t *v = pv;
851 qemu_put_sbe64s(f, v);
854 const VMStateInfo vmstate_info_int64 = {
855 .name = "int64",
856 .get = get_int64,
857 .put = put_int64,
860 /* 8 bit unsigned int */
862 static int get_uint8(QEMUFile *f, void *pv, size_t size)
864 uint8_t *v = pv;
865 qemu_get_8s(f, v);
866 return 0;
869 static void put_uint8(QEMUFile *f, void *pv, size_t size)
871 uint8_t *v = pv;
872 qemu_put_8s(f, v);
875 const VMStateInfo vmstate_info_uint8 = {
876 .name = "uint8",
877 .get = get_uint8,
878 .put = put_uint8,
881 /* 16 bit unsigned int */
883 static int get_uint16(QEMUFile *f, void *pv, size_t size)
885 uint16_t *v = pv;
886 qemu_get_be16s(f, v);
887 return 0;
890 static void put_uint16(QEMUFile *f, void *pv, size_t size)
892 uint16_t *v = pv;
893 qemu_put_be16s(f, v);
896 const VMStateInfo vmstate_info_uint16 = {
897 .name = "uint16",
898 .get = get_uint16,
899 .put = put_uint16,
902 /* 32 bit unsigned int */
904 static int get_uint32(QEMUFile *f, void *pv, size_t size)
906 uint32_t *v = pv;
907 qemu_get_be32s(f, v);
908 return 0;
911 static void put_uint32(QEMUFile *f, void *pv, size_t size)
913 uint32_t *v = pv;
914 qemu_put_be32s(f, v);
917 const VMStateInfo vmstate_info_uint32 = {
918 .name = "uint32",
919 .get = get_uint32,
920 .put = put_uint32,
923 /* 32 bit uint. See that the received value is the same than the one
924 in the field */
926 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
928 uint32_t *v = pv;
929 uint32_t v2;
930 qemu_get_be32s(f, &v2);
932 if (*v == v2) {
933 return 0;
935 return -EINVAL;
938 const VMStateInfo vmstate_info_uint32_equal = {
939 .name = "uint32 equal",
940 .get = get_uint32_equal,
941 .put = put_uint32,
944 /* 64 bit unsigned int */
946 static int get_uint64(QEMUFile *f, void *pv, size_t size)
948 uint64_t *v = pv;
949 qemu_get_be64s(f, v);
950 return 0;
953 static void put_uint64(QEMUFile *f, void *pv, size_t size)
955 uint64_t *v = pv;
956 qemu_put_be64s(f, v);
959 const VMStateInfo vmstate_info_uint64 = {
960 .name = "uint64",
961 .get = get_uint64,
962 .put = put_uint64,
965 /* 8 bit int. See that the received value is the same than the one
966 in the field */
968 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
970 uint8_t *v = pv;
971 uint8_t v2;
972 qemu_get_8s(f, &v2);
974 if (*v == v2)
975 return 0;
976 return -EINVAL;
979 const VMStateInfo vmstate_info_uint8_equal = {
980 .name = "uint8 equal",
981 .get = get_uint8_equal,
982 .put = put_uint8,
985 /* 16 bit unsigned int int. See that the received value is the same than the one
986 in the field */
988 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
990 uint16_t *v = pv;
991 uint16_t v2;
992 qemu_get_be16s(f, &v2);
994 if (*v == v2)
995 return 0;
996 return -EINVAL;
999 const VMStateInfo vmstate_info_uint16_equal = {
1000 .name = "uint16 equal",
1001 .get = get_uint16_equal,
1002 .put = put_uint16,
1005 /* timers */
1007 static int get_timer(QEMUFile *f, void *pv, size_t size)
1009 QEMUTimer *v = pv;
1010 qemu_get_timer(f, v);
1011 return 0;
1014 static void put_timer(QEMUFile *f, void *pv, size_t size)
1016 QEMUTimer *v = pv;
1017 qemu_put_timer(f, v);
1020 const VMStateInfo vmstate_info_timer = {
1021 .name = "timer",
1022 .get = get_timer,
1023 .put = put_timer,
1026 /* uint8_t buffers */
1028 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1030 uint8_t *v = pv;
1031 qemu_get_buffer(f, v, size);
1032 return 0;
1035 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1037 uint8_t *v = pv;
1038 qemu_put_buffer(f, v, size);
1041 const VMStateInfo vmstate_info_buffer = {
1042 .name = "buffer",
1043 .get = get_buffer,
1044 .put = put_buffer,
1047 /* unused buffers: space that was used for some fields that are
1048 not useful anymore */
1050 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1052 uint8_t buf[1024];
1053 int block_len;
1055 while (size > 0) {
1056 block_len = MIN(sizeof(buf), size);
1057 size -= block_len;
1058 qemu_get_buffer(f, buf, block_len);
1060 return 0;
1063 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1065 static const uint8_t buf[1024];
1066 int block_len;
1068 while (size > 0) {
1069 block_len = MIN(sizeof(buf), size);
1070 size -= block_len;
1071 qemu_put_buffer(f, buf, block_len);
1075 const VMStateInfo vmstate_info_unused_buffer = {
1076 .name = "unused_buffer",
1077 .get = get_unused_buffer,
1078 .put = put_unused_buffer,
1081 typedef struct CompatEntry {
1082 char idstr[256];
1083 int instance_id;
1084 } CompatEntry;
1086 typedef struct SaveStateEntry {
1087 QTAILQ_ENTRY(SaveStateEntry) entry;
1088 char idstr[256];
1089 int instance_id;
1090 int alias_id;
1091 int version_id;
1092 int section_id;
1093 SaveSetParamsHandler *set_params;
1094 SaveLiveStateHandler *save_live_state;
1095 SaveStateHandler *save_state;
1096 LoadStateHandler *load_state;
1097 const VMStateDescription *vmsd;
1098 void *opaque;
1099 CompatEntry *compat;
1100 int no_migrate;
1101 } SaveStateEntry;
1104 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1105 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1106 static int global_section_id;
1108 static int calculate_new_instance_id(const char *idstr)
1110 SaveStateEntry *se;
1111 int instance_id = 0;
1113 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1114 if (strcmp(idstr, se->idstr) == 0
1115 && instance_id <= se->instance_id) {
1116 instance_id = se->instance_id + 1;
1119 return instance_id;
1122 static int calculate_compat_instance_id(const char *idstr)
1124 SaveStateEntry *se;
1125 int instance_id = 0;
1127 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1128 if (!se->compat)
1129 continue;
1131 if (strcmp(idstr, se->compat->idstr) == 0
1132 && instance_id <= se->compat->instance_id) {
1133 instance_id = se->compat->instance_id + 1;
1136 return instance_id;
1139 /* TODO: Individual devices generally have very little idea about the rest
1140 of the system, so instance_id should be removed/replaced.
1141 Meanwhile pass -1 as instance_id if you do not already have a clearly
1142 distinguishing id for all instances of your device class. */
1143 int register_savevm_live(DeviceState *dev,
1144 const char *idstr,
1145 int instance_id,
1146 int version_id,
1147 SaveSetParamsHandler *set_params,
1148 SaveLiveStateHandler *save_live_state,
1149 SaveStateHandler *save_state,
1150 LoadStateHandler *load_state,
1151 void *opaque)
1153 SaveStateEntry *se;
1155 se = g_malloc0(sizeof(SaveStateEntry));
1156 se->version_id = version_id;
1157 se->section_id = global_section_id++;
1158 se->set_params = set_params;
1159 se->save_live_state = save_live_state;
1160 se->save_state = save_state;
1161 se->load_state = load_state;
1162 se->opaque = opaque;
1163 se->vmsd = NULL;
1164 se->no_migrate = 0;
1166 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1167 char *id = dev->parent_bus->info->get_dev_path(dev);
1168 if (id) {
1169 pstrcpy(se->idstr, sizeof(se->idstr), id);
1170 pstrcat(se->idstr, sizeof(se->idstr), "/");
1171 g_free(id);
1173 se->compat = g_malloc0(sizeof(CompatEntry));
1174 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1175 se->compat->instance_id = instance_id == -1 ?
1176 calculate_compat_instance_id(idstr) : instance_id;
1177 instance_id = -1;
1180 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1182 if (instance_id == -1) {
1183 se->instance_id = calculate_new_instance_id(se->idstr);
1184 } else {
1185 se->instance_id = instance_id;
1187 assert(!se->compat || se->instance_id == 0);
1188 /* add at the end of list */
1189 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1190 return 0;
1193 int register_savevm(DeviceState *dev,
1194 const char *idstr,
1195 int instance_id,
1196 int version_id,
1197 SaveStateHandler *save_state,
1198 LoadStateHandler *load_state,
1199 void *opaque)
1201 return register_savevm_live(dev, idstr, instance_id, version_id,
1202 NULL, NULL, save_state, load_state, opaque);
1205 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1207 SaveStateEntry *se, *new_se;
1208 char id[256] = "";
1210 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1211 char *path = dev->parent_bus->info->get_dev_path(dev);
1212 if (path) {
1213 pstrcpy(id, sizeof(id), path);
1214 pstrcat(id, sizeof(id), "/");
1215 g_free(path);
1218 pstrcat(id, sizeof(id), idstr);
1220 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1221 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1222 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1223 if (se->compat) {
1224 g_free(se->compat);
1226 g_free(se);
1231 /* mark a device as not to be migrated, that is the device should be
1232 unplugged before migration */
1233 void register_device_unmigratable(DeviceState *dev, const char *idstr,
1234 void *opaque)
1236 SaveStateEntry *se;
1237 char id[256] = "";
1239 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1240 char *path = dev->parent_bus->info->get_dev_path(dev);
1241 if (path) {
1242 pstrcpy(id, sizeof(id), path);
1243 pstrcat(id, sizeof(id), "/");
1244 g_free(path);
1247 pstrcat(id, sizeof(id), idstr);
1249 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1250 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1251 se->no_migrate = 1;
1256 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1257 const VMStateDescription *vmsd,
1258 void *opaque, int alias_id,
1259 int required_for_version)
1261 SaveStateEntry *se;
1263 /* If this triggers, alias support can be dropped for the vmsd. */
1264 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1266 se = g_malloc0(sizeof(SaveStateEntry));
1267 se->version_id = vmsd->version_id;
1268 se->section_id = global_section_id++;
1269 se->save_live_state = NULL;
1270 se->save_state = NULL;
1271 se->load_state = NULL;
1272 se->opaque = opaque;
1273 se->vmsd = vmsd;
1274 se->alias_id = alias_id;
1275 se->no_migrate = vmsd->unmigratable;
1277 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1278 char *id = dev->parent_bus->info->get_dev_path(dev);
1279 if (id) {
1280 pstrcpy(se->idstr, sizeof(se->idstr), id);
1281 pstrcat(se->idstr, sizeof(se->idstr), "/");
1282 g_free(id);
1284 se->compat = g_malloc0(sizeof(CompatEntry));
1285 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1286 se->compat->instance_id = instance_id == -1 ?
1287 calculate_compat_instance_id(vmsd->name) : instance_id;
1288 instance_id = -1;
1291 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1293 if (instance_id == -1) {
1294 se->instance_id = calculate_new_instance_id(se->idstr);
1295 } else {
1296 se->instance_id = instance_id;
1298 assert(!se->compat || se->instance_id == 0);
1299 /* add at the end of list */
1300 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1301 return 0;
1304 int vmstate_register(DeviceState *dev, int instance_id,
1305 const VMStateDescription *vmsd, void *opaque)
1307 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1308 opaque, -1, 0);
1311 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1312 void *opaque)
1314 SaveStateEntry *se, *new_se;
1316 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1317 if (se->vmsd == vmsd && se->opaque == opaque) {
1318 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1319 if (se->compat) {
1320 g_free(se->compat);
1322 g_free(se);
1327 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1328 void *opaque);
1329 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1330 void *opaque);
1332 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1333 void *opaque, int version_id)
1335 VMStateField *field = vmsd->fields;
1336 int ret;
1338 if (version_id > vmsd->version_id) {
1339 return -EINVAL;
1341 if (version_id < vmsd->minimum_version_id_old) {
1342 return -EINVAL;
1344 if (version_id < vmsd->minimum_version_id) {
1345 return vmsd->load_state_old(f, opaque, version_id);
1347 if (vmsd->pre_load) {
1348 int ret = vmsd->pre_load(opaque);
1349 if (ret)
1350 return ret;
1352 while(field->name) {
1353 if ((field->field_exists &&
1354 field->field_exists(opaque, version_id)) ||
1355 (!field->field_exists &&
1356 field->version_id <= version_id)) {
1357 void *base_addr = opaque + field->offset;
1358 int i, n_elems = 1;
1359 int size = field->size;
1361 if (field->flags & VMS_VBUFFER) {
1362 size = *(int32_t *)(opaque+field->size_offset);
1363 if (field->flags & VMS_MULTIPLY) {
1364 size *= field->size;
1367 if (field->flags & VMS_ARRAY) {
1368 n_elems = field->num;
1369 } else if (field->flags & VMS_VARRAY_INT32) {
1370 n_elems = *(int32_t *)(opaque+field->num_offset);
1371 } else if (field->flags & VMS_VARRAY_UINT32) {
1372 n_elems = *(uint32_t *)(opaque+field->num_offset);
1373 } else if (field->flags & VMS_VARRAY_UINT16) {
1374 n_elems = *(uint16_t *)(opaque+field->num_offset);
1375 } else if (field->flags & VMS_VARRAY_UINT8) {
1376 n_elems = *(uint8_t *)(opaque+field->num_offset);
1378 if (field->flags & VMS_POINTER) {
1379 base_addr = *(void **)base_addr + field->start;
1381 for (i = 0; i < n_elems; i++) {
1382 void *addr = base_addr + size * i;
1384 if (field->flags & VMS_ARRAY_OF_POINTER) {
1385 addr = *(void **)addr;
1387 if (field->flags & VMS_STRUCT) {
1388 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1389 } else {
1390 ret = field->info->get(f, addr, size);
1393 if (ret < 0) {
1394 return ret;
1398 field++;
1400 ret = vmstate_subsection_load(f, vmsd, opaque);
1401 if (ret != 0) {
1402 return ret;
1404 if (vmsd->post_load) {
1405 return vmsd->post_load(opaque, version_id);
1407 return 0;
1410 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1411 void *opaque)
1413 VMStateField *field = vmsd->fields;
1415 if (vmsd->pre_save) {
1416 vmsd->pre_save(opaque);
1418 while(field->name) {
1419 if (!field->field_exists ||
1420 field->field_exists(opaque, vmsd->version_id)) {
1421 void *base_addr = opaque + field->offset;
1422 int i, n_elems = 1;
1423 int size = field->size;
1425 if (field->flags & VMS_VBUFFER) {
1426 size = *(int32_t *)(opaque+field->size_offset);
1427 if (field->flags & VMS_MULTIPLY) {
1428 size *= field->size;
1431 if (field->flags & VMS_ARRAY) {
1432 n_elems = field->num;
1433 } else if (field->flags & VMS_VARRAY_INT32) {
1434 n_elems = *(int32_t *)(opaque+field->num_offset);
1435 } else if (field->flags & VMS_VARRAY_UINT16) {
1436 n_elems = *(uint16_t *)(opaque+field->num_offset);
1437 } else if (field->flags & VMS_VARRAY_UINT8) {
1438 n_elems = *(uint8_t *)(opaque+field->num_offset);
1440 if (field->flags & VMS_POINTER) {
1441 base_addr = *(void **)base_addr + field->start;
1443 for (i = 0; i < n_elems; i++) {
1444 void *addr = base_addr + size * i;
1446 if (field->flags & VMS_ARRAY_OF_POINTER) {
1447 addr = *(void **)addr;
1449 if (field->flags & VMS_STRUCT) {
1450 vmstate_save_state(f, field->vmsd, addr);
1451 } else {
1452 field->info->put(f, addr, size);
1456 field++;
1458 vmstate_subsection_save(f, vmsd, opaque);
1461 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1463 if (!se->vmsd) { /* Old style */
1464 return se->load_state(f, se->opaque, version_id);
1466 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1469 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1471 if (!se->vmsd) { /* Old style */
1472 se->save_state(f, se->opaque);
1473 return;
1475 vmstate_save_state(f,se->vmsd, se->opaque);
1478 #define QEMU_VM_FILE_MAGIC 0x5145564d
1479 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1480 #define QEMU_VM_FILE_VERSION 0x00000003
1482 #define QEMU_VM_EOF 0x00
1483 #define QEMU_VM_SECTION_START 0x01
1484 #define QEMU_VM_SECTION_PART 0x02
1485 #define QEMU_VM_SECTION_END 0x03
1486 #define QEMU_VM_SECTION_FULL 0x04
1487 #define QEMU_VM_SUBSECTION 0x05
1489 bool qemu_savevm_state_blocked(Monitor *mon)
1491 SaveStateEntry *se;
1493 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1494 if (se->no_migrate) {
1495 monitor_printf(mon, "state blocked by non-migratable device '%s'\n",
1496 se->idstr);
1497 return true;
1500 return false;
1503 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1504 int shared)
1506 SaveStateEntry *se;
1507 int ret;
1509 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1510 if(se->set_params == NULL) {
1511 continue;
1513 se->set_params(blk_enable, shared, se->opaque);
1516 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1517 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1519 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1520 int len;
1522 if (se->save_live_state == NULL)
1523 continue;
1525 /* Section type */
1526 qemu_put_byte(f, QEMU_VM_SECTION_START);
1527 qemu_put_be32(f, se->section_id);
1529 /* ID string */
1530 len = strlen(se->idstr);
1531 qemu_put_byte(f, len);
1532 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1534 qemu_put_be32(f, se->instance_id);
1535 qemu_put_be32(f, se->version_id);
1537 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1538 if (ret < 0) {
1539 qemu_savevm_state_cancel(mon, f);
1540 return ret;
1543 ret = qemu_file_get_error(f);
1544 if (ret != 0) {
1545 qemu_savevm_state_cancel(mon, f);
1548 return ret;
1553 * this funtion has three return values:
1554 * negative: there was one error, and we have -errno.
1555 * 0 : We haven't finished, caller have to go again
1556 * 1 : We have finished, we can go to complete phase
1558 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1560 SaveStateEntry *se;
1561 int ret = 1;
1563 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1564 if (se->save_live_state == NULL)
1565 continue;
1567 /* Section type */
1568 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1569 qemu_put_be32(f, se->section_id);
1571 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1572 if (ret <= 0) {
1573 /* Do not proceed to the next vmstate before this one reported
1574 completion of the current stage. This serializes the migration
1575 and reduces the probability that a faster changing state is
1576 synchronized over and over again. */
1577 break;
1580 if (ret != 0) {
1581 return ret;
1583 ret = qemu_file_get_error(f);
1584 if (ret != 0) {
1585 qemu_savevm_state_cancel(mon, f);
1587 return ret;
1590 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1592 SaveStateEntry *se;
1593 int ret;
1595 cpu_synchronize_all_states();
1597 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1598 if (se->save_live_state == NULL)
1599 continue;
1601 /* Section type */
1602 qemu_put_byte(f, QEMU_VM_SECTION_END);
1603 qemu_put_be32(f, se->section_id);
1605 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1606 if (ret < 0) {
1607 return ret;
1611 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1612 int len;
1614 if (se->save_state == NULL && se->vmsd == NULL)
1615 continue;
1617 /* Section type */
1618 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1619 qemu_put_be32(f, se->section_id);
1621 /* ID string */
1622 len = strlen(se->idstr);
1623 qemu_put_byte(f, len);
1624 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1626 qemu_put_be32(f, se->instance_id);
1627 qemu_put_be32(f, se->version_id);
1629 vmstate_save(f, se);
1632 qemu_put_byte(f, QEMU_VM_EOF);
1634 return qemu_file_get_error(f);
1637 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1639 SaveStateEntry *se;
1641 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1642 if (se->save_live_state) {
1643 se->save_live_state(mon, f, -1, se->opaque);
1648 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
1650 int saved_vm_running;
1651 int ret;
1653 saved_vm_running = runstate_is_running();
1654 vm_stop(RUN_STATE_SAVE_VM);
1656 if (qemu_savevm_state_blocked(mon)) {
1657 ret = -EINVAL;
1658 goto out;
1661 ret = qemu_savevm_state_begin(mon, f, 0, 0);
1662 if (ret < 0)
1663 goto out;
1665 do {
1666 ret = qemu_savevm_state_iterate(mon, f);
1667 if (ret < 0)
1668 goto out;
1669 } while (ret == 0);
1671 ret = qemu_savevm_state_complete(mon, f);
1673 out:
1674 if (ret == 0) {
1675 ret = qemu_file_get_error(f);
1678 if (!ret && saved_vm_running)
1679 vm_start();
1681 return ret;
1684 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1686 SaveStateEntry *se;
1688 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1689 if (!strcmp(se->idstr, idstr) &&
1690 (instance_id == se->instance_id ||
1691 instance_id == se->alias_id))
1692 return se;
1693 /* Migrating from an older version? */
1694 if (strstr(se->idstr, idstr) && se->compat) {
1695 if (!strcmp(se->compat->idstr, idstr) &&
1696 (instance_id == se->compat->instance_id ||
1697 instance_id == se->alias_id))
1698 return se;
1701 return NULL;
1704 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1706 while(sub && sub->needed) {
1707 if (strcmp(idstr, sub->vmsd->name) == 0) {
1708 return sub->vmsd;
1710 sub++;
1712 return NULL;
1715 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1716 void *opaque)
1718 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1719 char idstr[256];
1720 int ret;
1721 uint8_t version_id, len, size;
1722 const VMStateDescription *sub_vmsd;
1724 len = qemu_peek_byte(f, 1);
1725 if (len < strlen(vmsd->name) + 1) {
1726 /* subsection name has be be "section_name/a" */
1727 return 0;
1729 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1730 if (size != len) {
1731 return 0;
1733 idstr[size] = 0;
1735 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1736 /* it don't have a valid subsection name */
1737 return 0;
1739 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1740 if (sub_vmsd == NULL) {
1741 return -ENOENT;
1743 qemu_file_skip(f, 1); /* subsection */
1744 qemu_file_skip(f, 1); /* len */
1745 qemu_file_skip(f, len); /* idstr */
1746 version_id = qemu_get_be32(f);
1748 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1749 if (ret) {
1750 return ret;
1753 return 0;
1756 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1757 void *opaque)
1759 const VMStateSubsection *sub = vmsd->subsections;
1761 while (sub && sub->needed) {
1762 if (sub->needed(opaque)) {
1763 const VMStateDescription *vmsd = sub->vmsd;
1764 uint8_t len;
1766 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1767 len = strlen(vmsd->name);
1768 qemu_put_byte(f, len);
1769 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1770 qemu_put_be32(f, vmsd->version_id);
1771 vmstate_save_state(f, vmsd, opaque);
1773 sub++;
1777 typedef struct LoadStateEntry {
1778 QLIST_ENTRY(LoadStateEntry) entry;
1779 SaveStateEntry *se;
1780 int section_id;
1781 int version_id;
1782 } LoadStateEntry;
1784 int qemu_loadvm_state(QEMUFile *f)
1786 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1787 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1788 LoadStateEntry *le, *new_le;
1789 uint8_t section_type;
1790 unsigned int v;
1791 int ret;
1793 if (qemu_savevm_state_blocked(default_mon)) {
1794 return -EINVAL;
1797 v = qemu_get_be32(f);
1798 if (v != QEMU_VM_FILE_MAGIC)
1799 return -EINVAL;
1801 v = qemu_get_be32(f);
1802 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1803 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1804 return -ENOTSUP;
1806 if (v != QEMU_VM_FILE_VERSION)
1807 return -ENOTSUP;
1809 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1810 uint32_t instance_id, version_id, section_id;
1811 SaveStateEntry *se;
1812 char idstr[257];
1813 int len;
1815 switch (section_type) {
1816 case QEMU_VM_SECTION_START:
1817 case QEMU_VM_SECTION_FULL:
1818 /* Read section start */
1819 section_id = qemu_get_be32(f);
1820 len = qemu_get_byte(f);
1821 qemu_get_buffer(f, (uint8_t *)idstr, len);
1822 idstr[len] = 0;
1823 instance_id = qemu_get_be32(f);
1824 version_id = qemu_get_be32(f);
1826 /* Find savevm section */
1827 se = find_se(idstr, instance_id);
1828 if (se == NULL) {
1829 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1830 ret = -EINVAL;
1831 goto out;
1834 /* Validate version */
1835 if (version_id > se->version_id) {
1836 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1837 version_id, idstr, se->version_id);
1838 ret = -EINVAL;
1839 goto out;
1842 /* Add entry */
1843 le = g_malloc0(sizeof(*le));
1845 le->se = se;
1846 le->section_id = section_id;
1847 le->version_id = version_id;
1848 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1850 ret = vmstate_load(f, le->se, le->version_id);
1851 if (ret < 0) {
1852 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1853 instance_id, idstr);
1854 goto out;
1856 break;
1857 case QEMU_VM_SECTION_PART:
1858 case QEMU_VM_SECTION_END:
1859 section_id = qemu_get_be32(f);
1861 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1862 if (le->section_id == section_id) {
1863 break;
1866 if (le == NULL) {
1867 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1868 ret = -EINVAL;
1869 goto out;
1872 ret = vmstate_load(f, le->se, le->version_id);
1873 if (ret < 0) {
1874 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1875 section_id);
1876 goto out;
1878 break;
1879 default:
1880 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1881 ret = -EINVAL;
1882 goto out;
1886 cpu_synchronize_all_post_init();
1888 ret = 0;
1890 out:
1891 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1892 QLIST_REMOVE(le, entry);
1893 g_free(le);
1896 if (ret == 0) {
1897 ret = qemu_file_get_error(f);
1900 return ret;
1903 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1904 const char *name)
1906 QEMUSnapshotInfo *sn_tab, *sn;
1907 int nb_sns, i, ret;
1909 ret = -ENOENT;
1910 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1911 if (nb_sns < 0)
1912 return ret;
1913 for(i = 0; i < nb_sns; i++) {
1914 sn = &sn_tab[i];
1915 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1916 *sn_info = *sn;
1917 ret = 0;
1918 break;
1921 g_free(sn_tab);
1922 return ret;
1926 * Deletes snapshots of a given name in all opened images.
1928 static int del_existing_snapshots(Monitor *mon, const char *name)
1930 BlockDriverState *bs;
1931 QEMUSnapshotInfo sn1, *snapshot = &sn1;
1932 int ret;
1934 bs = NULL;
1935 while ((bs = bdrv_next(bs))) {
1936 if (bdrv_can_snapshot(bs) &&
1937 bdrv_snapshot_find(bs, snapshot, name) >= 0)
1939 ret = bdrv_snapshot_delete(bs, name);
1940 if (ret < 0) {
1941 monitor_printf(mon,
1942 "Error while deleting snapshot on '%s'\n",
1943 bdrv_get_device_name(bs));
1944 return -1;
1949 return 0;
1952 void do_savevm(Monitor *mon, const QDict *qdict)
1954 BlockDriverState *bs, *bs1;
1955 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1956 int ret;
1957 QEMUFile *f;
1958 int saved_vm_running;
1959 uint32_t vm_state_size;
1960 #ifdef _WIN32
1961 struct _timeb tb;
1962 struct tm *ptm;
1963 #else
1964 struct timeval tv;
1965 struct tm tm;
1966 #endif
1967 const char *name = qdict_get_try_str(qdict, "name");
1969 /* Verify if there is a device that doesn't support snapshots and is writable */
1970 bs = NULL;
1971 while ((bs = bdrv_next(bs))) {
1973 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
1974 continue;
1977 if (!bdrv_can_snapshot(bs)) {
1978 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1979 bdrv_get_device_name(bs));
1980 return;
1984 bs = bdrv_snapshots();
1985 if (!bs) {
1986 monitor_printf(mon, "No block device can accept snapshots\n");
1987 return;
1990 saved_vm_running = runstate_is_running();
1991 vm_stop(RUN_STATE_SAVE_VM);
1993 memset(sn, 0, sizeof(*sn));
1995 /* fill auxiliary fields */
1996 #ifdef _WIN32
1997 _ftime(&tb);
1998 sn->date_sec = tb.time;
1999 sn->date_nsec = tb.millitm * 1000000;
2000 #else
2001 gettimeofday(&tv, NULL);
2002 sn->date_sec = tv.tv_sec;
2003 sn->date_nsec = tv.tv_usec * 1000;
2004 #endif
2005 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2007 if (name) {
2008 ret = bdrv_snapshot_find(bs, old_sn, name);
2009 if (ret >= 0) {
2010 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2011 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2012 } else {
2013 pstrcpy(sn->name, sizeof(sn->name), name);
2015 } else {
2016 #ifdef _WIN32
2017 ptm = localtime(&tb.time);
2018 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
2019 #else
2020 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2021 localtime_r((const time_t *)&tv.tv_sec, &tm);
2022 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2023 #endif
2026 /* Delete old snapshots of the same name */
2027 if (name && del_existing_snapshots(mon, name) < 0) {
2028 goto the_end;
2031 /* save the VM state */
2032 f = qemu_fopen_bdrv(bs, 1);
2033 if (!f) {
2034 monitor_printf(mon, "Could not open VM state file\n");
2035 goto the_end;
2037 ret = qemu_savevm_state(mon, f);
2038 vm_state_size = qemu_ftell(f);
2039 qemu_fclose(f);
2040 if (ret < 0) {
2041 monitor_printf(mon, "Error %d while writing VM\n", ret);
2042 goto the_end;
2045 /* create the snapshots */
2047 bs1 = NULL;
2048 while ((bs1 = bdrv_next(bs1))) {
2049 if (bdrv_can_snapshot(bs1)) {
2050 /* Write VM state size only to the image that contains the state */
2051 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2052 ret = bdrv_snapshot_create(bs1, sn);
2053 if (ret < 0) {
2054 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2055 bdrv_get_device_name(bs1));
2060 the_end:
2061 if (saved_vm_running)
2062 vm_start();
2065 int load_vmstate(const char *name)
2067 BlockDriverState *bs, *bs_vm_state;
2068 QEMUSnapshotInfo sn;
2069 QEMUFile *f;
2070 int ret;
2072 bs_vm_state = bdrv_snapshots();
2073 if (!bs_vm_state) {
2074 error_report("No block device supports snapshots");
2075 return -ENOTSUP;
2078 /* Don't even try to load empty VM states */
2079 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2080 if (ret < 0) {
2081 return ret;
2082 } else if (sn.vm_state_size == 0) {
2083 error_report("This is a disk-only snapshot. Revert to it offline "
2084 "using qemu-img.");
2085 return -EINVAL;
2088 /* Verify if there is any device that doesn't support snapshots and is
2089 writable and check if the requested snapshot is available too. */
2090 bs = NULL;
2091 while ((bs = bdrv_next(bs))) {
2093 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2094 continue;
2097 if (!bdrv_can_snapshot(bs)) {
2098 error_report("Device '%s' is writable but does not support snapshots.",
2099 bdrv_get_device_name(bs));
2100 return -ENOTSUP;
2103 ret = bdrv_snapshot_find(bs, &sn, name);
2104 if (ret < 0) {
2105 error_report("Device '%s' does not have the requested snapshot '%s'",
2106 bdrv_get_device_name(bs), name);
2107 return ret;
2111 /* Flush all IO requests so they don't interfere with the new state. */
2112 qemu_aio_flush();
2114 bs = NULL;
2115 while ((bs = bdrv_next(bs))) {
2116 if (bdrv_can_snapshot(bs)) {
2117 ret = bdrv_snapshot_goto(bs, name);
2118 if (ret < 0) {
2119 error_report("Error %d while activating snapshot '%s' on '%s'",
2120 ret, name, bdrv_get_device_name(bs));
2121 return ret;
2126 /* restore the VM state */
2127 f = qemu_fopen_bdrv(bs_vm_state, 0);
2128 if (!f) {
2129 error_report("Could not open VM state file");
2130 return -EINVAL;
2133 qemu_system_reset(VMRESET_SILENT);
2134 ret = qemu_loadvm_state(f);
2136 qemu_fclose(f);
2137 if (ret < 0) {
2138 error_report("Error %d while loading VM state", ret);
2139 return ret;
2142 return 0;
2145 void do_delvm(Monitor *mon, const QDict *qdict)
2147 BlockDriverState *bs, *bs1;
2148 int ret;
2149 const char *name = qdict_get_str(qdict, "name");
2151 bs = bdrv_snapshots();
2152 if (!bs) {
2153 monitor_printf(mon, "No block device supports snapshots\n");
2154 return;
2157 bs1 = NULL;
2158 while ((bs1 = bdrv_next(bs1))) {
2159 if (bdrv_can_snapshot(bs1)) {
2160 ret = bdrv_snapshot_delete(bs1, name);
2161 if (ret < 0) {
2162 if (ret == -ENOTSUP)
2163 monitor_printf(mon,
2164 "Snapshots not supported on device '%s'\n",
2165 bdrv_get_device_name(bs1));
2166 else
2167 monitor_printf(mon, "Error %d while deleting snapshot on "
2168 "'%s'\n", ret, bdrv_get_device_name(bs1));
2174 void do_info_snapshots(Monitor *mon)
2176 BlockDriverState *bs, *bs1;
2177 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2178 int nb_sns, i, ret, available;
2179 int total;
2180 int *available_snapshots;
2181 char buf[256];
2183 bs = bdrv_snapshots();
2184 if (!bs) {
2185 monitor_printf(mon, "No available block device supports snapshots\n");
2186 return;
2189 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2190 if (nb_sns < 0) {
2191 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2192 return;
2195 if (nb_sns == 0) {
2196 monitor_printf(mon, "There is no snapshot available.\n");
2197 return;
2200 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2201 total = 0;
2202 for (i = 0; i < nb_sns; i++) {
2203 sn = &sn_tab[i];
2204 available = 1;
2205 bs1 = NULL;
2207 while ((bs1 = bdrv_next(bs1))) {
2208 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2209 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2210 if (ret < 0) {
2211 available = 0;
2212 break;
2217 if (available) {
2218 available_snapshots[total] = i;
2219 total++;
2223 if (total > 0) {
2224 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2225 for (i = 0; i < total; i++) {
2226 sn = &sn_tab[available_snapshots[i]];
2227 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2229 } else {
2230 monitor_printf(mon, "There is no suitable snapshot available\n");
2233 g_free(sn_tab);
2234 g_free(available_snapshots);