Fix some spelling bugs in documentation and comments
[qemu/ar7.git] / savevm.c
blobbee16c0b7b5ad88d3784b019d4eb7e62df95d933
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 == 0) {
480 f->last_error = -EIO;
481 } else if (len != -EAGAIN)
482 f->last_error = len;
485 int qemu_fclose(QEMUFile *f)
487 int ret = 0;
488 qemu_fflush(f);
489 if (f->close)
490 ret = f->close(f->opaque);
491 g_free(f);
492 return ret;
495 void qemu_file_put_notify(QEMUFile *f)
497 f->put_buffer(f->opaque, NULL, 0, 0);
500 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
502 int l;
504 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
505 fprintf(stderr,
506 "Attempted to write to buffer while read buffer is not empty\n");
507 abort();
510 while (!f->last_error && size > 0) {
511 l = IO_BUF_SIZE - f->buf_index;
512 if (l > size)
513 l = size;
514 memcpy(f->buf + f->buf_index, buf, l);
515 f->is_write = 1;
516 f->buf_index += l;
517 buf += l;
518 size -= l;
519 if (f->buf_index >= IO_BUF_SIZE)
520 qemu_fflush(f);
524 void qemu_put_byte(QEMUFile *f, int v)
526 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
527 fprintf(stderr,
528 "Attempted to write to buffer while read buffer is not empty\n");
529 abort();
532 f->buf[f->buf_index++] = v;
533 f->is_write = 1;
534 if (f->buf_index >= IO_BUF_SIZE)
535 qemu_fflush(f);
538 static void qemu_file_skip(QEMUFile *f, int size)
540 if (f->buf_index + size <= f->buf_size) {
541 f->buf_index += size;
545 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
547 int pending;
548 int index;
550 if (f->is_write) {
551 abort();
554 index = f->buf_index + offset;
555 pending = f->buf_size - index;
556 if (pending < size) {
557 qemu_fill_buffer(f);
558 index = f->buf_index + offset;
559 pending = f->buf_size - index;
562 if (pending <= 0) {
563 return 0;
565 if (size > pending) {
566 size = pending;
569 memcpy(buf, f->buf + index, size);
570 return size;
573 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
575 int pending = size;
576 int done = 0;
578 while (pending > 0) {
579 int res;
581 res = qemu_peek_buffer(f, buf, pending, 0);
582 if (res == 0) {
583 return done;
585 qemu_file_skip(f, res);
586 buf += res;
587 pending -= res;
588 done += res;
590 return done;
593 static int qemu_peek_byte(QEMUFile *f, int offset)
595 int index = f->buf_index + offset;
597 if (f->is_write) {
598 abort();
601 if (index >= f->buf_size) {
602 qemu_fill_buffer(f);
603 index = f->buf_index + offset;
604 if (index >= f->buf_size) {
605 return 0;
608 return f->buf[index];
611 int qemu_get_byte(QEMUFile *f)
613 int result;
615 result = qemu_peek_byte(f, 0);
616 qemu_file_skip(f, 1);
617 return result;
620 int64_t qemu_ftell(QEMUFile *f)
622 return f->buf_offset - f->buf_size + f->buf_index;
625 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
627 if (whence == SEEK_SET) {
628 /* nothing to do */
629 } else if (whence == SEEK_CUR) {
630 pos += qemu_ftell(f);
631 } else {
632 /* SEEK_END not supported */
633 return -1;
635 if (f->put_buffer) {
636 qemu_fflush(f);
637 f->buf_offset = pos;
638 } else {
639 f->buf_offset = pos;
640 f->buf_index = 0;
641 f->buf_size = 0;
643 return pos;
646 int qemu_file_rate_limit(QEMUFile *f)
648 if (f->rate_limit)
649 return f->rate_limit(f->opaque);
651 return 0;
654 int64_t qemu_file_get_rate_limit(QEMUFile *f)
656 if (f->get_rate_limit)
657 return f->get_rate_limit(f->opaque);
659 return 0;
662 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
664 /* any failed or completed migration keeps its state to allow probing of
665 * migration data, but has no associated file anymore */
666 if (f && f->set_rate_limit)
667 return f->set_rate_limit(f->opaque, new_rate);
669 return 0;
672 void qemu_put_be16(QEMUFile *f, unsigned int v)
674 qemu_put_byte(f, v >> 8);
675 qemu_put_byte(f, v);
678 void qemu_put_be32(QEMUFile *f, unsigned int v)
680 qemu_put_byte(f, v >> 24);
681 qemu_put_byte(f, v >> 16);
682 qemu_put_byte(f, v >> 8);
683 qemu_put_byte(f, v);
686 void qemu_put_be64(QEMUFile *f, uint64_t v)
688 qemu_put_be32(f, v >> 32);
689 qemu_put_be32(f, v);
692 unsigned int qemu_get_be16(QEMUFile *f)
694 unsigned int v;
695 v = qemu_get_byte(f) << 8;
696 v |= qemu_get_byte(f);
697 return v;
700 unsigned int qemu_get_be32(QEMUFile *f)
702 unsigned int v;
703 v = qemu_get_byte(f) << 24;
704 v |= qemu_get_byte(f) << 16;
705 v |= qemu_get_byte(f) << 8;
706 v |= qemu_get_byte(f);
707 return v;
710 uint64_t qemu_get_be64(QEMUFile *f)
712 uint64_t v;
713 v = (uint64_t)qemu_get_be32(f) << 32;
714 v |= qemu_get_be32(f);
715 return v;
719 /* timer */
721 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
723 uint64_t expire_time;
725 expire_time = qemu_timer_expire_time_ns(ts);
726 qemu_put_be64(f, expire_time);
729 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
731 uint64_t expire_time;
733 expire_time = qemu_get_be64(f);
734 if (expire_time != -1) {
735 qemu_mod_timer_ns(ts, expire_time);
736 } else {
737 qemu_del_timer(ts);
742 /* bool */
744 static int get_bool(QEMUFile *f, void *pv, size_t size)
746 bool *v = pv;
747 *v = qemu_get_byte(f);
748 return 0;
751 static void put_bool(QEMUFile *f, void *pv, size_t size)
753 bool *v = pv;
754 qemu_put_byte(f, *v);
757 const VMStateInfo vmstate_info_bool = {
758 .name = "bool",
759 .get = get_bool,
760 .put = put_bool,
763 /* 8 bit int */
765 static int get_int8(QEMUFile *f, void *pv, size_t size)
767 int8_t *v = pv;
768 qemu_get_s8s(f, v);
769 return 0;
772 static void put_int8(QEMUFile *f, void *pv, size_t size)
774 int8_t *v = pv;
775 qemu_put_s8s(f, v);
778 const VMStateInfo vmstate_info_int8 = {
779 .name = "int8",
780 .get = get_int8,
781 .put = put_int8,
784 /* 16 bit int */
786 static int get_int16(QEMUFile *f, void *pv, size_t size)
788 int16_t *v = pv;
789 qemu_get_sbe16s(f, v);
790 return 0;
793 static void put_int16(QEMUFile *f, void *pv, size_t size)
795 int16_t *v = pv;
796 qemu_put_sbe16s(f, v);
799 const VMStateInfo vmstate_info_int16 = {
800 .name = "int16",
801 .get = get_int16,
802 .put = put_int16,
805 /* 32 bit int */
807 static int get_int32(QEMUFile *f, void *pv, size_t size)
809 int32_t *v = pv;
810 qemu_get_sbe32s(f, v);
811 return 0;
814 static void put_int32(QEMUFile *f, void *pv, size_t size)
816 int32_t *v = pv;
817 qemu_put_sbe32s(f, v);
820 const VMStateInfo vmstate_info_int32 = {
821 .name = "int32",
822 .get = get_int32,
823 .put = put_int32,
826 /* 32 bit int. See that the received value is the same than the one
827 in the field */
829 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
831 int32_t *v = pv;
832 int32_t v2;
833 qemu_get_sbe32s(f, &v2);
835 if (*v == v2)
836 return 0;
837 return -EINVAL;
840 const VMStateInfo vmstate_info_int32_equal = {
841 .name = "int32 equal",
842 .get = get_int32_equal,
843 .put = put_int32,
846 /* 32 bit int. See that the received value is the less or the same
847 than the one in the field */
849 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
851 int32_t *old = pv;
852 int32_t new;
853 qemu_get_sbe32s(f, &new);
855 if (*old <= new)
856 return 0;
857 return -EINVAL;
860 const VMStateInfo vmstate_info_int32_le = {
861 .name = "int32 equal",
862 .get = get_int32_le,
863 .put = put_int32,
866 /* 64 bit int */
868 static int get_int64(QEMUFile *f, void *pv, size_t size)
870 int64_t *v = pv;
871 qemu_get_sbe64s(f, v);
872 return 0;
875 static void put_int64(QEMUFile *f, void *pv, size_t size)
877 int64_t *v = pv;
878 qemu_put_sbe64s(f, v);
881 const VMStateInfo vmstate_info_int64 = {
882 .name = "int64",
883 .get = get_int64,
884 .put = put_int64,
887 /* 8 bit unsigned int */
889 static int get_uint8(QEMUFile *f, void *pv, size_t size)
891 uint8_t *v = pv;
892 qemu_get_8s(f, v);
893 return 0;
896 static void put_uint8(QEMUFile *f, void *pv, size_t size)
898 uint8_t *v = pv;
899 qemu_put_8s(f, v);
902 const VMStateInfo vmstate_info_uint8 = {
903 .name = "uint8",
904 .get = get_uint8,
905 .put = put_uint8,
908 /* 16 bit unsigned int */
910 static int get_uint16(QEMUFile *f, void *pv, size_t size)
912 uint16_t *v = pv;
913 qemu_get_be16s(f, v);
914 return 0;
917 static void put_uint16(QEMUFile *f, void *pv, size_t size)
919 uint16_t *v = pv;
920 qemu_put_be16s(f, v);
923 const VMStateInfo vmstate_info_uint16 = {
924 .name = "uint16",
925 .get = get_uint16,
926 .put = put_uint16,
929 /* 32 bit unsigned int */
931 static int get_uint32(QEMUFile *f, void *pv, size_t size)
933 uint32_t *v = pv;
934 qemu_get_be32s(f, v);
935 return 0;
938 static void put_uint32(QEMUFile *f, void *pv, size_t size)
940 uint32_t *v = pv;
941 qemu_put_be32s(f, v);
944 const VMStateInfo vmstate_info_uint32 = {
945 .name = "uint32",
946 .get = get_uint32,
947 .put = put_uint32,
950 /* 32 bit uint. See that the received value is the same than the one
951 in the field */
953 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
955 uint32_t *v = pv;
956 uint32_t v2;
957 qemu_get_be32s(f, &v2);
959 if (*v == v2) {
960 return 0;
962 return -EINVAL;
965 const VMStateInfo vmstate_info_uint32_equal = {
966 .name = "uint32 equal",
967 .get = get_uint32_equal,
968 .put = put_uint32,
971 /* 64 bit unsigned int */
973 static int get_uint64(QEMUFile *f, void *pv, size_t size)
975 uint64_t *v = pv;
976 qemu_get_be64s(f, v);
977 return 0;
980 static void put_uint64(QEMUFile *f, void *pv, size_t size)
982 uint64_t *v = pv;
983 qemu_put_be64s(f, v);
986 const VMStateInfo vmstate_info_uint64 = {
987 .name = "uint64",
988 .get = get_uint64,
989 .put = put_uint64,
992 /* 8 bit int. See that the received value is the same than the one
993 in the field */
995 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
997 uint8_t *v = pv;
998 uint8_t v2;
999 qemu_get_8s(f, &v2);
1001 if (*v == v2)
1002 return 0;
1003 return -EINVAL;
1006 const VMStateInfo vmstate_info_uint8_equal = {
1007 .name = "uint8 equal",
1008 .get = get_uint8_equal,
1009 .put = put_uint8,
1012 /* 16 bit unsigned int int. See that the received value is the same than the one
1013 in the field */
1015 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1017 uint16_t *v = pv;
1018 uint16_t v2;
1019 qemu_get_be16s(f, &v2);
1021 if (*v == v2)
1022 return 0;
1023 return -EINVAL;
1026 const VMStateInfo vmstate_info_uint16_equal = {
1027 .name = "uint16 equal",
1028 .get = get_uint16_equal,
1029 .put = put_uint16,
1032 /* timers */
1034 static int get_timer(QEMUFile *f, void *pv, size_t size)
1036 QEMUTimer *v = pv;
1037 qemu_get_timer(f, v);
1038 return 0;
1041 static void put_timer(QEMUFile *f, void *pv, size_t size)
1043 QEMUTimer *v = pv;
1044 qemu_put_timer(f, v);
1047 const VMStateInfo vmstate_info_timer = {
1048 .name = "timer",
1049 .get = get_timer,
1050 .put = put_timer,
1053 /* uint8_t buffers */
1055 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1057 uint8_t *v = pv;
1058 qemu_get_buffer(f, v, size);
1059 return 0;
1062 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1064 uint8_t *v = pv;
1065 qemu_put_buffer(f, v, size);
1068 const VMStateInfo vmstate_info_buffer = {
1069 .name = "buffer",
1070 .get = get_buffer,
1071 .put = put_buffer,
1074 /* unused buffers: space that was used for some fields that are
1075 not useful anymore */
1077 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1079 uint8_t buf[1024];
1080 int block_len;
1082 while (size > 0) {
1083 block_len = MIN(sizeof(buf), size);
1084 size -= block_len;
1085 qemu_get_buffer(f, buf, block_len);
1087 return 0;
1090 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1092 static const uint8_t buf[1024];
1093 int block_len;
1095 while (size > 0) {
1096 block_len = MIN(sizeof(buf), size);
1097 size -= block_len;
1098 qemu_put_buffer(f, buf, block_len);
1102 const VMStateInfo vmstate_info_unused_buffer = {
1103 .name = "unused_buffer",
1104 .get = get_unused_buffer,
1105 .put = put_unused_buffer,
1108 typedef struct CompatEntry {
1109 char idstr[256];
1110 int instance_id;
1111 } CompatEntry;
1113 typedef struct SaveStateEntry {
1114 QTAILQ_ENTRY(SaveStateEntry) entry;
1115 char idstr[256];
1116 int instance_id;
1117 int alias_id;
1118 int version_id;
1119 int section_id;
1120 SaveSetParamsHandler *set_params;
1121 SaveLiveStateHandler *save_live_state;
1122 SaveStateHandler *save_state;
1123 LoadStateHandler *load_state;
1124 const VMStateDescription *vmsd;
1125 void *opaque;
1126 CompatEntry *compat;
1127 int no_migrate;
1128 } SaveStateEntry;
1131 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1132 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1133 static int global_section_id;
1135 static int calculate_new_instance_id(const char *idstr)
1137 SaveStateEntry *se;
1138 int instance_id = 0;
1140 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1141 if (strcmp(idstr, se->idstr) == 0
1142 && instance_id <= se->instance_id) {
1143 instance_id = se->instance_id + 1;
1146 return instance_id;
1149 static int calculate_compat_instance_id(const char *idstr)
1151 SaveStateEntry *se;
1152 int instance_id = 0;
1154 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1155 if (!se->compat)
1156 continue;
1158 if (strcmp(idstr, se->compat->idstr) == 0
1159 && instance_id <= se->compat->instance_id) {
1160 instance_id = se->compat->instance_id + 1;
1163 return instance_id;
1166 /* TODO: Individual devices generally have very little idea about the rest
1167 of the system, so instance_id should be removed/replaced.
1168 Meanwhile pass -1 as instance_id if you do not already have a clearly
1169 distinguishing id for all instances of your device class. */
1170 int register_savevm_live(DeviceState *dev,
1171 const char *idstr,
1172 int instance_id,
1173 int version_id,
1174 SaveSetParamsHandler *set_params,
1175 SaveLiveStateHandler *save_live_state,
1176 SaveStateHandler *save_state,
1177 LoadStateHandler *load_state,
1178 void *opaque)
1180 SaveStateEntry *se;
1182 se = g_malloc0(sizeof(SaveStateEntry));
1183 se->version_id = version_id;
1184 se->section_id = global_section_id++;
1185 se->set_params = set_params;
1186 se->save_live_state = save_live_state;
1187 se->save_state = save_state;
1188 se->load_state = load_state;
1189 se->opaque = opaque;
1190 se->vmsd = NULL;
1191 se->no_migrate = 0;
1193 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1194 char *id = dev->parent_bus->info->get_dev_path(dev);
1195 if (id) {
1196 pstrcpy(se->idstr, sizeof(se->idstr), id);
1197 pstrcat(se->idstr, sizeof(se->idstr), "/");
1198 g_free(id);
1200 se->compat = g_malloc0(sizeof(CompatEntry));
1201 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1202 se->compat->instance_id = instance_id == -1 ?
1203 calculate_compat_instance_id(idstr) : instance_id;
1204 instance_id = -1;
1207 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1209 if (instance_id == -1) {
1210 se->instance_id = calculate_new_instance_id(se->idstr);
1211 } else {
1212 se->instance_id = instance_id;
1214 assert(!se->compat || se->instance_id == 0);
1215 /* add at the end of list */
1216 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1217 return 0;
1220 int register_savevm(DeviceState *dev,
1221 const char *idstr,
1222 int instance_id,
1223 int version_id,
1224 SaveStateHandler *save_state,
1225 LoadStateHandler *load_state,
1226 void *opaque)
1228 return register_savevm_live(dev, idstr, instance_id, version_id,
1229 NULL, NULL, save_state, load_state, opaque);
1232 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1234 SaveStateEntry *se, *new_se;
1235 char id[256] = "";
1237 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1238 char *path = dev->parent_bus->info->get_dev_path(dev);
1239 if (path) {
1240 pstrcpy(id, sizeof(id), path);
1241 pstrcat(id, sizeof(id), "/");
1242 g_free(path);
1245 pstrcat(id, sizeof(id), idstr);
1247 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1248 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1249 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1250 if (se->compat) {
1251 g_free(se->compat);
1253 g_free(se);
1258 /* mark a device as not to be migrated, that is the device should be
1259 unplugged before migration */
1260 void register_device_unmigratable(DeviceState *dev, const char *idstr,
1261 void *opaque)
1263 SaveStateEntry *se;
1264 char id[256] = "";
1266 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1267 char *path = dev->parent_bus->info->get_dev_path(dev);
1268 if (path) {
1269 pstrcpy(id, sizeof(id), path);
1270 pstrcat(id, sizeof(id), "/");
1271 g_free(path);
1274 pstrcat(id, sizeof(id), idstr);
1276 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1277 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1278 se->no_migrate = 1;
1283 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1284 const VMStateDescription *vmsd,
1285 void *opaque, int alias_id,
1286 int required_for_version)
1288 SaveStateEntry *se;
1290 /* If this triggers, alias support can be dropped for the vmsd. */
1291 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1293 se = g_malloc0(sizeof(SaveStateEntry));
1294 se->version_id = vmsd->version_id;
1295 se->section_id = global_section_id++;
1296 se->save_live_state = NULL;
1297 se->save_state = NULL;
1298 se->load_state = NULL;
1299 se->opaque = opaque;
1300 se->vmsd = vmsd;
1301 se->alias_id = alias_id;
1302 se->no_migrate = vmsd->unmigratable;
1304 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1305 char *id = dev->parent_bus->info->get_dev_path(dev);
1306 if (id) {
1307 pstrcpy(se->idstr, sizeof(se->idstr), id);
1308 pstrcat(se->idstr, sizeof(se->idstr), "/");
1309 g_free(id);
1311 se->compat = g_malloc0(sizeof(CompatEntry));
1312 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1313 se->compat->instance_id = instance_id == -1 ?
1314 calculate_compat_instance_id(vmsd->name) : instance_id;
1315 instance_id = -1;
1318 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1320 if (instance_id == -1) {
1321 se->instance_id = calculate_new_instance_id(se->idstr);
1322 } else {
1323 se->instance_id = instance_id;
1325 assert(!se->compat || se->instance_id == 0);
1326 /* add at the end of list */
1327 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1328 return 0;
1331 int vmstate_register(DeviceState *dev, int instance_id,
1332 const VMStateDescription *vmsd, void *opaque)
1334 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1335 opaque, -1, 0);
1338 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1339 void *opaque)
1341 SaveStateEntry *se, *new_se;
1343 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1344 if (se->vmsd == vmsd && se->opaque == opaque) {
1345 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1346 if (se->compat) {
1347 g_free(se->compat);
1349 g_free(se);
1354 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1355 void *opaque);
1356 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1357 void *opaque);
1359 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1360 void *opaque, int version_id)
1362 VMStateField *field = vmsd->fields;
1363 int ret;
1365 if (version_id > vmsd->version_id) {
1366 return -EINVAL;
1368 if (version_id < vmsd->minimum_version_id_old) {
1369 return -EINVAL;
1371 if (version_id < vmsd->minimum_version_id) {
1372 return vmsd->load_state_old(f, opaque, version_id);
1374 if (vmsd->pre_load) {
1375 int ret = vmsd->pre_load(opaque);
1376 if (ret)
1377 return ret;
1379 while(field->name) {
1380 if ((field->field_exists &&
1381 field->field_exists(opaque, version_id)) ||
1382 (!field->field_exists &&
1383 field->version_id <= version_id)) {
1384 void *base_addr = opaque + field->offset;
1385 int i, n_elems = 1;
1386 int size = field->size;
1388 if (field->flags & VMS_VBUFFER) {
1389 size = *(int32_t *)(opaque+field->size_offset);
1390 if (field->flags & VMS_MULTIPLY) {
1391 size *= field->size;
1394 if (field->flags & VMS_ARRAY) {
1395 n_elems = field->num;
1396 } else if (field->flags & VMS_VARRAY_INT32) {
1397 n_elems = *(int32_t *)(opaque+field->num_offset);
1398 } else if (field->flags & VMS_VARRAY_UINT32) {
1399 n_elems = *(uint32_t *)(opaque+field->num_offset);
1400 } else if (field->flags & VMS_VARRAY_UINT16) {
1401 n_elems = *(uint16_t *)(opaque+field->num_offset);
1402 } else if (field->flags & VMS_VARRAY_UINT8) {
1403 n_elems = *(uint8_t *)(opaque+field->num_offset);
1405 if (field->flags & VMS_POINTER) {
1406 base_addr = *(void **)base_addr + field->start;
1408 for (i = 0; i < n_elems; i++) {
1409 void *addr = base_addr + size * i;
1411 if (field->flags & VMS_ARRAY_OF_POINTER) {
1412 addr = *(void **)addr;
1414 if (field->flags & VMS_STRUCT) {
1415 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1416 } else {
1417 ret = field->info->get(f, addr, size);
1420 if (ret < 0) {
1421 return ret;
1425 field++;
1427 ret = vmstate_subsection_load(f, vmsd, opaque);
1428 if (ret != 0) {
1429 return ret;
1431 if (vmsd->post_load) {
1432 return vmsd->post_load(opaque, version_id);
1434 return 0;
1437 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1438 void *opaque)
1440 VMStateField *field = vmsd->fields;
1442 if (vmsd->pre_save) {
1443 vmsd->pre_save(opaque);
1445 while(field->name) {
1446 if (!field->field_exists ||
1447 field->field_exists(opaque, vmsd->version_id)) {
1448 void *base_addr = opaque + field->offset;
1449 int i, n_elems = 1;
1450 int size = field->size;
1452 if (field->flags & VMS_VBUFFER) {
1453 size = *(int32_t *)(opaque+field->size_offset);
1454 if (field->flags & VMS_MULTIPLY) {
1455 size *= field->size;
1458 if (field->flags & VMS_ARRAY) {
1459 n_elems = field->num;
1460 } else if (field->flags & VMS_VARRAY_INT32) {
1461 n_elems = *(int32_t *)(opaque+field->num_offset);
1462 } else if (field->flags & VMS_VARRAY_UINT16) {
1463 n_elems = *(uint16_t *)(opaque+field->num_offset);
1464 } else if (field->flags & VMS_VARRAY_UINT8) {
1465 n_elems = *(uint8_t *)(opaque+field->num_offset);
1467 if (field->flags & VMS_POINTER) {
1468 base_addr = *(void **)base_addr + field->start;
1470 for (i = 0; i < n_elems; i++) {
1471 void *addr = base_addr + size * i;
1473 if (field->flags & VMS_ARRAY_OF_POINTER) {
1474 addr = *(void **)addr;
1476 if (field->flags & VMS_STRUCT) {
1477 vmstate_save_state(f, field->vmsd, addr);
1478 } else {
1479 field->info->put(f, addr, size);
1483 field++;
1485 vmstate_subsection_save(f, vmsd, opaque);
1488 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1490 if (!se->vmsd) { /* Old style */
1491 return se->load_state(f, se->opaque, version_id);
1493 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1496 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1498 if (!se->vmsd) { /* Old style */
1499 se->save_state(f, se->opaque);
1500 return;
1502 vmstate_save_state(f,se->vmsd, se->opaque);
1505 #define QEMU_VM_FILE_MAGIC 0x5145564d
1506 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1507 #define QEMU_VM_FILE_VERSION 0x00000003
1509 #define QEMU_VM_EOF 0x00
1510 #define QEMU_VM_SECTION_START 0x01
1511 #define QEMU_VM_SECTION_PART 0x02
1512 #define QEMU_VM_SECTION_END 0x03
1513 #define QEMU_VM_SECTION_FULL 0x04
1514 #define QEMU_VM_SUBSECTION 0x05
1516 bool qemu_savevm_state_blocked(Monitor *mon)
1518 SaveStateEntry *se;
1520 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1521 if (se->no_migrate) {
1522 monitor_printf(mon, "state blocked by non-migratable device '%s'\n",
1523 se->idstr);
1524 return true;
1527 return false;
1530 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1531 int shared)
1533 SaveStateEntry *se;
1534 int ret;
1536 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1537 if(se->set_params == NULL) {
1538 continue;
1540 se->set_params(blk_enable, shared, se->opaque);
1543 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1544 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1546 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1547 int len;
1549 if (se->save_live_state == NULL)
1550 continue;
1552 /* Section type */
1553 qemu_put_byte(f, QEMU_VM_SECTION_START);
1554 qemu_put_be32(f, se->section_id);
1556 /* ID string */
1557 len = strlen(se->idstr);
1558 qemu_put_byte(f, len);
1559 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1561 qemu_put_be32(f, se->instance_id);
1562 qemu_put_be32(f, se->version_id);
1564 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1565 if (ret < 0) {
1566 qemu_savevm_state_cancel(mon, f);
1567 return ret;
1570 ret = qemu_file_get_error(f);
1571 if (ret != 0) {
1572 qemu_savevm_state_cancel(mon, f);
1575 return ret;
1580 * this funtion has three return values:
1581 * negative: there was one error, and we have -errno.
1582 * 0 : We haven't finished, caller have to go again
1583 * 1 : We have finished, we can go to complete phase
1585 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1587 SaveStateEntry *se;
1588 int ret = 1;
1590 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1591 if (se->save_live_state == NULL)
1592 continue;
1594 /* Section type */
1595 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1596 qemu_put_be32(f, se->section_id);
1598 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1599 if (ret <= 0) {
1600 /* Do not proceed to the next vmstate before this one reported
1601 completion of the current stage. This serializes the migration
1602 and reduces the probability that a faster changing state is
1603 synchronized over and over again. */
1604 break;
1607 if (ret != 0) {
1608 return ret;
1610 ret = qemu_file_get_error(f);
1611 if (ret != 0) {
1612 qemu_savevm_state_cancel(mon, f);
1614 return ret;
1617 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1619 SaveStateEntry *se;
1620 int ret;
1622 cpu_synchronize_all_states();
1624 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1625 if (se->save_live_state == NULL)
1626 continue;
1628 /* Section type */
1629 qemu_put_byte(f, QEMU_VM_SECTION_END);
1630 qemu_put_be32(f, se->section_id);
1632 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1633 if (ret < 0) {
1634 return ret;
1638 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1639 int len;
1641 if (se->save_state == NULL && se->vmsd == NULL)
1642 continue;
1644 /* Section type */
1645 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1646 qemu_put_be32(f, se->section_id);
1648 /* ID string */
1649 len = strlen(se->idstr);
1650 qemu_put_byte(f, len);
1651 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1653 qemu_put_be32(f, se->instance_id);
1654 qemu_put_be32(f, se->version_id);
1656 vmstate_save(f, se);
1659 qemu_put_byte(f, QEMU_VM_EOF);
1661 return qemu_file_get_error(f);
1664 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1666 SaveStateEntry *se;
1668 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1669 if (se->save_live_state) {
1670 se->save_live_state(mon, f, -1, se->opaque);
1675 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
1677 int ret;
1679 if (qemu_savevm_state_blocked(mon)) {
1680 ret = -EINVAL;
1681 goto out;
1684 ret = qemu_savevm_state_begin(mon, f, 0, 0);
1685 if (ret < 0)
1686 goto out;
1688 do {
1689 ret = qemu_savevm_state_iterate(mon, f);
1690 if (ret < 0)
1691 goto out;
1692 } while (ret == 0);
1694 ret = qemu_savevm_state_complete(mon, f);
1696 out:
1697 if (ret == 0) {
1698 ret = qemu_file_get_error(f);
1701 return ret;
1704 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1706 SaveStateEntry *se;
1708 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1709 if (!strcmp(se->idstr, idstr) &&
1710 (instance_id == se->instance_id ||
1711 instance_id == se->alias_id))
1712 return se;
1713 /* Migrating from an older version? */
1714 if (strstr(se->idstr, idstr) && se->compat) {
1715 if (!strcmp(se->compat->idstr, idstr) &&
1716 (instance_id == se->compat->instance_id ||
1717 instance_id == se->alias_id))
1718 return se;
1721 return NULL;
1724 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1726 while(sub && sub->needed) {
1727 if (strcmp(idstr, sub->vmsd->name) == 0) {
1728 return sub->vmsd;
1730 sub++;
1732 return NULL;
1735 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1736 void *opaque)
1738 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1739 char idstr[256];
1740 int ret;
1741 uint8_t version_id, len, size;
1742 const VMStateDescription *sub_vmsd;
1744 len = qemu_peek_byte(f, 1);
1745 if (len < strlen(vmsd->name) + 1) {
1746 /* subsection name has be be "section_name/a" */
1747 return 0;
1749 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1750 if (size != len) {
1751 return 0;
1753 idstr[size] = 0;
1755 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1756 /* it don't have a valid subsection name */
1757 return 0;
1759 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1760 if (sub_vmsd == NULL) {
1761 return -ENOENT;
1763 qemu_file_skip(f, 1); /* subsection */
1764 qemu_file_skip(f, 1); /* len */
1765 qemu_file_skip(f, len); /* idstr */
1766 version_id = qemu_get_be32(f);
1768 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1769 if (ret) {
1770 return ret;
1773 return 0;
1776 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1777 void *opaque)
1779 const VMStateSubsection *sub = vmsd->subsections;
1781 while (sub && sub->needed) {
1782 if (sub->needed(opaque)) {
1783 const VMStateDescription *vmsd = sub->vmsd;
1784 uint8_t len;
1786 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1787 len = strlen(vmsd->name);
1788 qemu_put_byte(f, len);
1789 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1790 qemu_put_be32(f, vmsd->version_id);
1791 vmstate_save_state(f, vmsd, opaque);
1793 sub++;
1797 typedef struct LoadStateEntry {
1798 QLIST_ENTRY(LoadStateEntry) entry;
1799 SaveStateEntry *se;
1800 int section_id;
1801 int version_id;
1802 } LoadStateEntry;
1804 int qemu_loadvm_state(QEMUFile *f)
1806 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1807 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1808 LoadStateEntry *le, *new_le;
1809 uint8_t section_type;
1810 unsigned int v;
1811 int ret;
1813 if (qemu_savevm_state_blocked(default_mon)) {
1814 return -EINVAL;
1817 v = qemu_get_be32(f);
1818 if (v != QEMU_VM_FILE_MAGIC)
1819 return -EINVAL;
1821 v = qemu_get_be32(f);
1822 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1823 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1824 return -ENOTSUP;
1826 if (v != QEMU_VM_FILE_VERSION)
1827 return -ENOTSUP;
1829 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1830 uint32_t instance_id, version_id, section_id;
1831 SaveStateEntry *se;
1832 char idstr[257];
1833 int len;
1835 switch (section_type) {
1836 case QEMU_VM_SECTION_START:
1837 case QEMU_VM_SECTION_FULL:
1838 /* Read section start */
1839 section_id = qemu_get_be32(f);
1840 len = qemu_get_byte(f);
1841 qemu_get_buffer(f, (uint8_t *)idstr, len);
1842 idstr[len] = 0;
1843 instance_id = qemu_get_be32(f);
1844 version_id = qemu_get_be32(f);
1846 /* Find savevm section */
1847 se = find_se(idstr, instance_id);
1848 if (se == NULL) {
1849 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1850 ret = -EINVAL;
1851 goto out;
1854 /* Validate version */
1855 if (version_id > se->version_id) {
1856 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1857 version_id, idstr, se->version_id);
1858 ret = -EINVAL;
1859 goto out;
1862 /* Add entry */
1863 le = g_malloc0(sizeof(*le));
1865 le->se = se;
1866 le->section_id = section_id;
1867 le->version_id = version_id;
1868 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1870 ret = vmstate_load(f, le->se, le->version_id);
1871 if (ret < 0) {
1872 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1873 instance_id, idstr);
1874 goto out;
1876 break;
1877 case QEMU_VM_SECTION_PART:
1878 case QEMU_VM_SECTION_END:
1879 section_id = qemu_get_be32(f);
1881 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1882 if (le->section_id == section_id) {
1883 break;
1886 if (le == NULL) {
1887 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1888 ret = -EINVAL;
1889 goto out;
1892 ret = vmstate_load(f, le->se, le->version_id);
1893 if (ret < 0) {
1894 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1895 section_id);
1896 goto out;
1898 break;
1899 default:
1900 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1901 ret = -EINVAL;
1902 goto out;
1906 cpu_synchronize_all_post_init();
1908 ret = 0;
1910 out:
1911 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1912 QLIST_REMOVE(le, entry);
1913 g_free(le);
1916 if (ret == 0) {
1917 ret = qemu_file_get_error(f);
1920 return ret;
1923 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1924 const char *name)
1926 QEMUSnapshotInfo *sn_tab, *sn;
1927 int nb_sns, i, ret;
1929 ret = -ENOENT;
1930 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1931 if (nb_sns < 0)
1932 return ret;
1933 for(i = 0; i < nb_sns; i++) {
1934 sn = &sn_tab[i];
1935 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1936 *sn_info = *sn;
1937 ret = 0;
1938 break;
1941 g_free(sn_tab);
1942 return ret;
1946 * Deletes snapshots of a given name in all opened images.
1948 static int del_existing_snapshots(Monitor *mon, const char *name)
1950 BlockDriverState *bs;
1951 QEMUSnapshotInfo sn1, *snapshot = &sn1;
1952 int ret;
1954 bs = NULL;
1955 while ((bs = bdrv_next(bs))) {
1956 if (bdrv_can_snapshot(bs) &&
1957 bdrv_snapshot_find(bs, snapshot, name) >= 0)
1959 ret = bdrv_snapshot_delete(bs, name);
1960 if (ret < 0) {
1961 monitor_printf(mon,
1962 "Error while deleting snapshot on '%s'\n",
1963 bdrv_get_device_name(bs));
1964 return -1;
1969 return 0;
1972 void do_savevm(Monitor *mon, const QDict *qdict)
1974 BlockDriverState *bs, *bs1;
1975 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1976 int ret;
1977 QEMUFile *f;
1978 int saved_vm_running;
1979 uint32_t vm_state_size;
1980 #ifdef _WIN32
1981 struct _timeb tb;
1982 struct tm *ptm;
1983 #else
1984 struct timeval tv;
1985 struct tm tm;
1986 #endif
1987 const char *name = qdict_get_try_str(qdict, "name");
1989 /* Verify if there is a device that doesn't support snapshots and is writable */
1990 bs = NULL;
1991 while ((bs = bdrv_next(bs))) {
1993 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
1994 continue;
1997 if (!bdrv_can_snapshot(bs)) {
1998 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1999 bdrv_get_device_name(bs));
2000 return;
2004 bs = bdrv_snapshots();
2005 if (!bs) {
2006 monitor_printf(mon, "No block device can accept snapshots\n");
2007 return;
2010 saved_vm_running = runstate_is_running();
2011 vm_stop(RUN_STATE_SAVE_VM);
2013 memset(sn, 0, sizeof(*sn));
2015 /* fill auxiliary fields */
2016 #ifdef _WIN32
2017 _ftime(&tb);
2018 sn->date_sec = tb.time;
2019 sn->date_nsec = tb.millitm * 1000000;
2020 #else
2021 gettimeofday(&tv, NULL);
2022 sn->date_sec = tv.tv_sec;
2023 sn->date_nsec = tv.tv_usec * 1000;
2024 #endif
2025 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2027 if (name) {
2028 ret = bdrv_snapshot_find(bs, old_sn, name);
2029 if (ret >= 0) {
2030 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2031 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2032 } else {
2033 pstrcpy(sn->name, sizeof(sn->name), name);
2035 } else {
2036 #ifdef _WIN32
2037 ptm = localtime(&tb.time);
2038 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
2039 #else
2040 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2041 localtime_r((const time_t *)&tv.tv_sec, &tm);
2042 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2043 #endif
2046 /* Delete old snapshots of the same name */
2047 if (name && del_existing_snapshots(mon, name) < 0) {
2048 goto the_end;
2051 /* save the VM state */
2052 f = qemu_fopen_bdrv(bs, 1);
2053 if (!f) {
2054 monitor_printf(mon, "Could not open VM state file\n");
2055 goto the_end;
2057 ret = qemu_savevm_state(mon, f);
2058 vm_state_size = qemu_ftell(f);
2059 qemu_fclose(f);
2060 if (ret < 0) {
2061 monitor_printf(mon, "Error %d while writing VM\n", ret);
2062 goto the_end;
2065 /* create the snapshots */
2067 bs1 = NULL;
2068 while ((bs1 = bdrv_next(bs1))) {
2069 if (bdrv_can_snapshot(bs1)) {
2070 /* Write VM state size only to the image that contains the state */
2071 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2072 ret = bdrv_snapshot_create(bs1, sn);
2073 if (ret < 0) {
2074 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2075 bdrv_get_device_name(bs1));
2080 the_end:
2081 if (saved_vm_running)
2082 vm_start();
2085 int load_vmstate(const char *name)
2087 BlockDriverState *bs, *bs_vm_state;
2088 QEMUSnapshotInfo sn;
2089 QEMUFile *f;
2090 int ret;
2092 bs_vm_state = bdrv_snapshots();
2093 if (!bs_vm_state) {
2094 error_report("No block device supports snapshots");
2095 return -ENOTSUP;
2098 /* Don't even try to load empty VM states */
2099 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2100 if (ret < 0) {
2101 return ret;
2102 } else if (sn.vm_state_size == 0) {
2103 error_report("This is a disk-only snapshot. Revert to it offline "
2104 "using qemu-img.");
2105 return -EINVAL;
2108 /* Verify if there is any device that doesn't support snapshots and is
2109 writable and check if the requested snapshot is available too. */
2110 bs = NULL;
2111 while ((bs = bdrv_next(bs))) {
2113 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2114 continue;
2117 if (!bdrv_can_snapshot(bs)) {
2118 error_report("Device '%s' is writable but does not support snapshots.",
2119 bdrv_get_device_name(bs));
2120 return -ENOTSUP;
2123 ret = bdrv_snapshot_find(bs, &sn, name);
2124 if (ret < 0) {
2125 error_report("Device '%s' does not have the requested snapshot '%s'",
2126 bdrv_get_device_name(bs), name);
2127 return ret;
2131 /* Flush all IO requests so they don't interfere with the new state. */
2132 qemu_aio_flush();
2134 bs = NULL;
2135 while ((bs = bdrv_next(bs))) {
2136 if (bdrv_can_snapshot(bs)) {
2137 ret = bdrv_snapshot_goto(bs, name);
2138 if (ret < 0) {
2139 error_report("Error %d while activating snapshot '%s' on '%s'",
2140 ret, name, bdrv_get_device_name(bs));
2141 return ret;
2146 /* restore the VM state */
2147 f = qemu_fopen_bdrv(bs_vm_state, 0);
2148 if (!f) {
2149 error_report("Could not open VM state file");
2150 return -EINVAL;
2153 qemu_system_reset(VMRESET_SILENT);
2154 ret = qemu_loadvm_state(f);
2156 qemu_fclose(f);
2157 if (ret < 0) {
2158 error_report("Error %d while loading VM state", ret);
2159 return ret;
2162 return 0;
2165 void do_delvm(Monitor *mon, const QDict *qdict)
2167 BlockDriverState *bs, *bs1;
2168 int ret;
2169 const char *name = qdict_get_str(qdict, "name");
2171 bs = bdrv_snapshots();
2172 if (!bs) {
2173 monitor_printf(mon, "No block device supports snapshots\n");
2174 return;
2177 bs1 = NULL;
2178 while ((bs1 = bdrv_next(bs1))) {
2179 if (bdrv_can_snapshot(bs1)) {
2180 ret = bdrv_snapshot_delete(bs1, name);
2181 if (ret < 0) {
2182 if (ret == -ENOTSUP)
2183 monitor_printf(mon,
2184 "Snapshots not supported on device '%s'\n",
2185 bdrv_get_device_name(bs1));
2186 else
2187 monitor_printf(mon, "Error %d while deleting snapshot on "
2188 "'%s'\n", ret, bdrv_get_device_name(bs1));
2194 void do_info_snapshots(Monitor *mon)
2196 BlockDriverState *bs, *bs1;
2197 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2198 int nb_sns, i, ret, available;
2199 int total;
2200 int *available_snapshots;
2201 char buf[256];
2203 bs = bdrv_snapshots();
2204 if (!bs) {
2205 monitor_printf(mon, "No available block device supports snapshots\n");
2206 return;
2209 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2210 if (nb_sns < 0) {
2211 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2212 return;
2215 if (nb_sns == 0) {
2216 monitor_printf(mon, "There is no snapshot available.\n");
2217 return;
2220 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2221 total = 0;
2222 for (i = 0; i < nb_sns; i++) {
2223 sn = &sn_tab[i];
2224 available = 1;
2225 bs1 = NULL;
2227 while ((bs1 = bdrv_next(bs1))) {
2228 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2229 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2230 if (ret < 0) {
2231 available = 0;
2232 break;
2237 if (available) {
2238 available_snapshots[total] = i;
2239 total++;
2243 if (total > 0) {
2244 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2245 for (i = 0; i < total; i++) {
2246 sn = &sn_tab[available_snapshots[i]];
2247 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2249 } else {
2250 monitor_printf(mon, "There is no suitable snapshot available\n");
2253 g_free(sn_tab);
2254 g_free(available_snapshots);