Remove SaveVM v2 support
[qemu/scottt.git] / savevm.c
blob0dcab79398d045d22dda30b034dc9b7d0c8f56d7
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 <signal.h>
27 #include <time.h>
28 #include <errno.h>
29 #include <sys/time.h>
30 #include <zlib.h>
32 /* Needed early for CONFIG_BSD etc. */
33 #include "config-host.h"
35 #ifndef _WIN32
36 #include <sys/times.h>
37 #include <sys/wait.h>
38 #include <termios.h>
39 #include <sys/mman.h>
40 #include <sys/ioctl.h>
41 #include <sys/resource.h>
42 #include <sys/socket.h>
43 #include <netinet/in.h>
44 #include <net/if.h>
45 #if defined(__NetBSD__)
46 #include <net/if_tap.h>
47 #endif
48 #ifdef __linux__
49 #include <linux/if_tun.h>
50 #endif
51 #include <arpa/inet.h>
52 #include <dirent.h>
53 #include <netdb.h>
54 #include <sys/select.h>
55 #ifdef CONFIG_BSD
56 #include <sys/stat.h>
57 #if defined(__FreeBSD__) || defined(__DragonFly__)
58 #include <libutil.h>
59 #else
60 #include <util.h>
61 #endif
62 #elif defined (__GLIBC__) && defined (__FreeBSD_kernel__)
63 #include <freebsd/stdlib.h>
64 #else
65 #ifdef __linux__
66 #include <pty.h>
67 #include <malloc.h>
68 #include <linux/rtc.h>
69 #endif
70 #endif
71 #endif
73 #ifdef _WIN32
74 #include <windows.h>
75 #include <malloc.h>
76 #include <sys/timeb.h>
77 #include <mmsystem.h>
78 #define getopt_long_only getopt_long
79 #define memalign(align, size) malloc(size)
80 #endif
82 #include "qemu-common.h"
83 #include "hw/hw.h"
84 #include "net.h"
85 #include "monitor.h"
86 #include "sysemu.h"
87 #include "qemu-timer.h"
88 #include "qemu-char.h"
89 #include "block.h"
90 #include "audio/audio.h"
91 #include "migration.h"
92 #include "qemu_socket.h"
94 /* point to the block driver where the snapshots are managed */
95 static BlockDriverState *bs_snapshots;
97 #define SELF_ANNOUNCE_ROUNDS 5
98 #define ETH_P_EXPERIMENTAL 0x01F1 /* just a number */
99 //#define ETH_P_EXPERIMENTAL 0x0012 /* make it the size of the packet */
100 #define EXPERIMENTAL_MAGIC 0xf1f23f4f
102 static int announce_self_create(uint8_t *buf,
103 uint8_t *mac_addr)
105 uint32_t magic = EXPERIMENTAL_MAGIC;
106 uint16_t proto = htons(ETH_P_EXPERIMENTAL);
108 /* FIXME: should we send a different packet (arp/rarp/ping)? */
110 memset(buf, 0, 64);
111 memset(buf, 0xff, 6); /* h_dst */
112 memcpy(buf + 6, mac_addr, 6); /* h_src */
113 memcpy(buf + 12, &proto, 2); /* h_proto */
114 memcpy(buf + 14, &magic, 4); /* magic */
116 return 64; /* len */
119 static void qemu_announce_self_once(void *opaque)
121 int i, len;
122 VLANState *vlan;
123 VLANClientState *vc;
124 uint8_t buf[256];
125 static int count = SELF_ANNOUNCE_ROUNDS;
126 QEMUTimer *timer = *(QEMUTimer **)opaque;
128 for (i = 0; i < MAX_NICS; i++) {
129 if (!nd_table[i].used)
130 continue;
131 len = announce_self_create(buf, nd_table[i].macaddr);
132 vlan = nd_table[i].vlan;
133 for(vc = vlan->first_client; vc != NULL; vc = vc->next) {
134 vc->receive(vc, buf, len);
137 if (count--) {
138 qemu_mod_timer(timer, qemu_get_clock(rt_clock) + 100);
139 } else {
140 qemu_del_timer(timer);
141 qemu_free_timer(timer);
145 void qemu_announce_self(void)
147 static QEMUTimer *timer;
148 timer = qemu_new_timer(rt_clock, qemu_announce_self_once, &timer);
149 qemu_announce_self_once(&timer);
152 /***********************************************************/
153 /* savevm/loadvm support */
155 #define IO_BUF_SIZE 32768
157 struct QEMUFile {
158 QEMUFilePutBufferFunc *put_buffer;
159 QEMUFileGetBufferFunc *get_buffer;
160 QEMUFileCloseFunc *close;
161 QEMUFileRateLimit *rate_limit;
162 QEMUFileSetRateLimit *set_rate_limit;
163 void *opaque;
164 int is_write;
166 int64_t buf_offset; /* start of buffer when writing, end of buffer
167 when reading */
168 int buf_index;
169 int buf_size; /* 0 when writing */
170 uint8_t buf[IO_BUF_SIZE];
172 int has_error;
175 typedef struct QEMUFileStdio
177 FILE *stdio_file;
178 QEMUFile *file;
179 } QEMUFileStdio;
181 typedef struct QEMUFileSocket
183 int fd;
184 QEMUFile *file;
185 } QEMUFileSocket;
187 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
189 QEMUFileSocket *s = opaque;
190 ssize_t len;
192 do {
193 len = recv(s->fd, (void *)buf, size, 0);
194 } while (len == -1 && socket_error() == EINTR);
196 if (len == -1)
197 len = -socket_error();
199 return len;
202 static int socket_close(void *opaque)
204 QEMUFileSocket *s = opaque;
205 qemu_free(s);
206 return 0;
209 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
211 QEMUFileStdio *s = opaque;
212 return fwrite(buf, 1, size, s->stdio_file);
215 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
217 QEMUFileStdio *s = opaque;
218 FILE *fp = s->stdio_file;
219 int bytes;
221 do {
222 clearerr(fp);
223 bytes = fread(buf, 1, size, fp);
224 } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
225 return bytes;
228 static int stdio_pclose(void *opaque)
230 QEMUFileStdio *s = opaque;
231 pclose(s->stdio_file);
232 qemu_free(s);
233 return 0;
236 static int stdio_fclose(void *opaque)
238 QEMUFileStdio *s = opaque;
239 fclose(s->stdio_file);
240 qemu_free(s);
241 return 0;
244 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
246 QEMUFileStdio *s;
248 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
249 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
250 return NULL;
253 s = qemu_mallocz(sizeof(QEMUFileStdio));
255 s->stdio_file = stdio_file;
257 if(mode[0] == 'r') {
258 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose, NULL, NULL);
259 } else {
260 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose, NULL, NULL);
262 return s->file;
265 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
267 FILE *popen_file;
269 popen_file = popen(command, mode);
270 if(popen_file == NULL) {
271 return NULL;
274 return qemu_popen(popen_file, mode);
277 int qemu_stdio_fd(QEMUFile *f)
279 QEMUFileStdio *p;
280 int fd;
282 p = (QEMUFileStdio *)f->opaque;
283 fd = fileno(p->stdio_file);
285 return fd;
288 QEMUFile *qemu_fdopen(int fd, const char *mode)
290 QEMUFileStdio *s;
292 if (mode == NULL ||
293 (mode[0] != 'r' && mode[0] != 'w') ||
294 mode[1] != 'b' || mode[2] != 0) {
295 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
296 return NULL;
299 s = qemu_mallocz(sizeof(QEMUFileStdio));
300 s->stdio_file = fdopen(fd, mode);
301 if (!s->stdio_file)
302 goto fail;
304 if(mode[0] == 'r') {
305 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose, NULL, NULL);
306 } else {
307 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose, NULL, NULL);
309 return s->file;
311 fail:
312 qemu_free(s);
313 return NULL;
316 QEMUFile *qemu_fopen_socket(int fd)
318 QEMUFileSocket *s = qemu_mallocz(sizeof(QEMUFileSocket));
320 s->fd = fd;
321 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close, NULL, NULL);
322 return s->file;
325 static int file_put_buffer(void *opaque, const uint8_t *buf,
326 int64_t pos, int size)
328 QEMUFileStdio *s = opaque;
329 fseek(s->stdio_file, pos, SEEK_SET);
330 fwrite(buf, 1, size, s->stdio_file);
331 return size;
334 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
336 QEMUFileStdio *s = opaque;
337 fseek(s->stdio_file, pos, SEEK_SET);
338 return fread(buf, 1, size, s->stdio_file);
341 QEMUFile *qemu_fopen(const char *filename, const char *mode)
343 QEMUFileStdio *s;
345 if (mode == NULL ||
346 (mode[0] != 'r' && mode[0] != 'w') ||
347 mode[1] != 'b' || mode[2] != 0) {
348 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
349 return NULL;
352 s = qemu_mallocz(sizeof(QEMUFileStdio));
354 s->stdio_file = fopen(filename, mode);
355 if (!s->stdio_file)
356 goto fail;
358 if(mode[0] == 'w') {
359 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose, NULL, NULL);
360 } else {
361 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose, NULL, NULL);
363 return s->file;
364 fail:
365 qemu_free(s);
366 return NULL;
369 static int block_put_buffer(void *opaque, const uint8_t *buf,
370 int64_t pos, int size)
372 bdrv_save_vmstate(opaque, buf, pos, size);
373 return size;
376 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
378 return bdrv_load_vmstate(opaque, buf, pos, size);
381 static int bdrv_fclose(void *opaque)
383 return 0;
386 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
388 if (is_writable)
389 return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose, NULL, NULL);
390 return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL);
393 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
394 QEMUFileGetBufferFunc *get_buffer,
395 QEMUFileCloseFunc *close,
396 QEMUFileRateLimit *rate_limit,
397 QEMUFileSetRateLimit *set_rate_limit)
399 QEMUFile *f;
401 f = qemu_mallocz(sizeof(QEMUFile));
403 f->opaque = opaque;
404 f->put_buffer = put_buffer;
405 f->get_buffer = get_buffer;
406 f->close = close;
407 f->rate_limit = rate_limit;
408 f->set_rate_limit = set_rate_limit;
409 f->is_write = 0;
411 return f;
414 int qemu_file_has_error(QEMUFile *f)
416 return f->has_error;
419 void qemu_file_set_error(QEMUFile *f)
421 f->has_error = 1;
424 void qemu_fflush(QEMUFile *f)
426 if (!f->put_buffer)
427 return;
429 if (f->is_write && f->buf_index > 0) {
430 int len;
432 len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
433 if (len > 0)
434 f->buf_offset += f->buf_index;
435 else
436 f->has_error = 1;
437 f->buf_index = 0;
441 static void qemu_fill_buffer(QEMUFile *f)
443 int len;
445 if (!f->get_buffer)
446 return;
448 if (f->is_write)
449 abort();
451 len = f->get_buffer(f->opaque, f->buf, f->buf_offset, IO_BUF_SIZE);
452 if (len > 0) {
453 f->buf_index = 0;
454 f->buf_size = len;
455 f->buf_offset += len;
456 } else if (len != -EAGAIN)
457 f->has_error = 1;
460 int qemu_fclose(QEMUFile *f)
462 int ret = 0;
463 qemu_fflush(f);
464 if (f->close)
465 ret = f->close(f->opaque);
466 qemu_free(f);
467 return ret;
470 void qemu_file_put_notify(QEMUFile *f)
472 f->put_buffer(f->opaque, NULL, 0, 0);
475 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
477 int l;
479 if (!f->has_error && f->is_write == 0 && f->buf_index > 0) {
480 fprintf(stderr,
481 "Attempted to write to buffer while read buffer is not empty\n");
482 abort();
485 while (!f->has_error && size > 0) {
486 l = IO_BUF_SIZE - f->buf_index;
487 if (l > size)
488 l = size;
489 memcpy(f->buf + f->buf_index, buf, l);
490 f->is_write = 1;
491 f->buf_index += l;
492 buf += l;
493 size -= l;
494 if (f->buf_index >= IO_BUF_SIZE)
495 qemu_fflush(f);
499 void qemu_put_byte(QEMUFile *f, int v)
501 if (!f->has_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 f->buf[f->buf_index++] = v;
508 f->is_write = 1;
509 if (f->buf_index >= IO_BUF_SIZE)
510 qemu_fflush(f);
513 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size1)
515 int size, l;
517 if (f->is_write)
518 abort();
520 size = size1;
521 while (size > 0) {
522 l = f->buf_size - f->buf_index;
523 if (l == 0) {
524 qemu_fill_buffer(f);
525 l = f->buf_size - f->buf_index;
526 if (l == 0)
527 break;
529 if (l > size)
530 l = size;
531 memcpy(buf, f->buf + f->buf_index, l);
532 f->buf_index += l;
533 buf += l;
534 size -= l;
536 return size1 - size;
539 int qemu_get_byte(QEMUFile *f)
541 if (f->is_write)
542 abort();
544 if (f->buf_index >= f->buf_size) {
545 qemu_fill_buffer(f);
546 if (f->buf_index >= f->buf_size)
547 return 0;
549 return f->buf[f->buf_index++];
552 int64_t qemu_ftell(QEMUFile *f)
554 return f->buf_offset - f->buf_size + f->buf_index;
557 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
559 if (whence == SEEK_SET) {
560 /* nothing to do */
561 } else if (whence == SEEK_CUR) {
562 pos += qemu_ftell(f);
563 } else {
564 /* SEEK_END not supported */
565 return -1;
567 if (f->put_buffer) {
568 qemu_fflush(f);
569 f->buf_offset = pos;
570 } else {
571 f->buf_offset = pos;
572 f->buf_index = 0;
573 f->buf_size = 0;
575 return pos;
578 int qemu_file_rate_limit(QEMUFile *f)
580 if (f->rate_limit)
581 return f->rate_limit(f->opaque);
583 return 0;
586 size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate)
588 /* any failed or completed migration keeps its state to allow probing of
589 * migration data, but has no associated file anymore */
590 if (f && f->set_rate_limit)
591 return f->set_rate_limit(f->opaque, new_rate);
593 return 0;
596 void qemu_put_be16(QEMUFile *f, unsigned int v)
598 qemu_put_byte(f, v >> 8);
599 qemu_put_byte(f, v);
602 void qemu_put_be32(QEMUFile *f, unsigned int v)
604 qemu_put_byte(f, v >> 24);
605 qemu_put_byte(f, v >> 16);
606 qemu_put_byte(f, v >> 8);
607 qemu_put_byte(f, v);
610 void qemu_put_be64(QEMUFile *f, uint64_t v)
612 qemu_put_be32(f, v >> 32);
613 qemu_put_be32(f, v);
616 unsigned int qemu_get_be16(QEMUFile *f)
618 unsigned int v;
619 v = qemu_get_byte(f) << 8;
620 v |= qemu_get_byte(f);
621 return v;
624 unsigned int qemu_get_be32(QEMUFile *f)
626 unsigned int v;
627 v = qemu_get_byte(f) << 24;
628 v |= qemu_get_byte(f) << 16;
629 v |= qemu_get_byte(f) << 8;
630 v |= qemu_get_byte(f);
631 return v;
634 uint64_t qemu_get_be64(QEMUFile *f)
636 uint64_t v;
637 v = (uint64_t)qemu_get_be32(f) << 32;
638 v |= qemu_get_be32(f);
639 return v;
642 /* 8 bit int */
644 static int get_int8(QEMUFile *f, void *pv, size_t size)
646 int8_t *v = pv;
647 qemu_get_s8s(f, v);
648 return 0;
651 static void put_int8(QEMUFile *f, const void *pv, size_t size)
653 const int8_t *v = pv;
654 qemu_put_s8s(f, v);
657 const VMStateInfo vmstate_info_int8 = {
658 .name = "int8",
659 .get = get_int8,
660 .put = put_int8,
663 /* 16 bit int */
665 static int get_int16(QEMUFile *f, void *pv, size_t size)
667 int16_t *v = pv;
668 qemu_get_sbe16s(f, v);
669 return 0;
672 static void put_int16(QEMUFile *f, const void *pv, size_t size)
674 const int16_t *v = pv;
675 qemu_put_sbe16s(f, v);
678 const VMStateInfo vmstate_info_int16 = {
679 .name = "int16",
680 .get = get_int16,
681 .put = put_int16,
684 /* 32 bit int */
686 static int get_int32(QEMUFile *f, void *pv, size_t size)
688 int32_t *v = pv;
689 qemu_get_sbe32s(f, v);
690 return 0;
693 static void put_int32(QEMUFile *f, const void *pv, size_t size)
695 const int32_t *v = pv;
696 qemu_put_sbe32s(f, v);
699 const VMStateInfo vmstate_info_int32 = {
700 .name = "int32",
701 .get = get_int32,
702 .put = put_int32,
705 /* 32 bit int. See that the received value is the same than the one
706 in the field */
708 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
710 int32_t *v = pv;
711 int32_t v2;
712 qemu_get_sbe32s(f, &v2);
714 if (*v == v2)
715 return 0;
716 return -EINVAL;
719 const VMStateInfo vmstate_info_int32_equal = {
720 .name = "int32 equal",
721 .get = get_int32_equal,
722 .put = put_int32,
725 /* 32 bit int. See that the received value is the less or the same
726 than the one in the field */
728 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
730 int32_t *old = pv;
731 int32_t new;
732 qemu_get_sbe32s(f, &new);
734 if (*old <= new)
735 return 0;
736 return -EINVAL;
739 const VMStateInfo vmstate_info_int32_le = {
740 .name = "int32 equal",
741 .get = get_int32_le,
742 .put = put_int32,
745 /* 64 bit int */
747 static int get_int64(QEMUFile *f, void *pv, size_t size)
749 int64_t *v = pv;
750 qemu_get_sbe64s(f, v);
751 return 0;
754 static void put_int64(QEMUFile *f, const void *pv, size_t size)
756 const int64_t *v = pv;
757 qemu_put_sbe64s(f, v);
760 const VMStateInfo vmstate_info_int64 = {
761 .name = "int64",
762 .get = get_int64,
763 .put = put_int64,
766 /* 8 bit unsigned int */
768 static int get_uint8(QEMUFile *f, void *pv, size_t size)
770 uint8_t *v = pv;
771 qemu_get_8s(f, v);
772 return 0;
775 static void put_uint8(QEMUFile *f, const void *pv, size_t size)
777 const uint8_t *v = pv;
778 qemu_put_8s(f, v);
781 const VMStateInfo vmstate_info_uint8 = {
782 .name = "uint8",
783 .get = get_uint8,
784 .put = put_uint8,
787 /* 16 bit unsigned int */
789 static int get_uint16(QEMUFile *f, void *pv, size_t size)
791 uint16_t *v = pv;
792 qemu_get_be16s(f, v);
793 return 0;
796 static void put_uint16(QEMUFile *f, const void *pv, size_t size)
798 const uint16_t *v = pv;
799 qemu_put_be16s(f, v);
802 const VMStateInfo vmstate_info_uint16 = {
803 .name = "uint16",
804 .get = get_uint16,
805 .put = put_uint16,
808 /* 32 bit unsigned int */
810 static int get_uint32(QEMUFile *f, void *pv, size_t size)
812 uint32_t *v = pv;
813 qemu_get_be32s(f, v);
814 return 0;
817 static void put_uint32(QEMUFile *f, const void *pv, size_t size)
819 const uint32_t *v = pv;
820 qemu_put_be32s(f, v);
823 const VMStateInfo vmstate_info_uint32 = {
824 .name = "uint32",
825 .get = get_uint32,
826 .put = put_uint32,
829 /* 64 bit unsigned int */
831 static int get_uint64(QEMUFile *f, void *pv, size_t size)
833 uint64_t *v = pv;
834 qemu_get_be64s(f, v);
835 return 0;
838 static void put_uint64(QEMUFile *f, const void *pv, size_t size)
840 const uint64_t *v = pv;
841 qemu_put_be64s(f, v);
844 const VMStateInfo vmstate_info_uint64 = {
845 .name = "uint64",
846 .get = get_uint64,
847 .put = put_uint64,
850 /* timers */
852 static int get_timer(QEMUFile *f, void *pv, size_t size)
854 QEMUTimer *v = pv;
855 qemu_get_timer(f, v);
856 return 0;
859 static void put_timer(QEMUFile *f, const void *pv, size_t size)
861 QEMUTimer *v = (void *)pv;
862 qemu_put_timer(f, v);
865 const VMStateInfo vmstate_info_timer = {
866 .name = "timer",
867 .get = get_timer,
868 .put = put_timer,
871 /* uint8_t buffers */
873 static int get_buffer(QEMUFile *f, void *pv, size_t size)
875 uint8_t *v = pv;
876 qemu_get_buffer(f, v, size);
877 return 0;
880 static void put_buffer(QEMUFile *f, const void *pv, size_t size)
882 uint8_t *v = (void *)pv;
883 qemu_put_buffer(f, v, size);
886 const VMStateInfo vmstate_info_buffer = {
887 .name = "buffer",
888 .get = get_buffer,
889 .put = put_buffer,
892 typedef struct SaveStateEntry {
893 TAILQ_ENTRY(SaveStateEntry) entry;
894 char idstr[256];
895 int instance_id;
896 int version_id;
897 int section_id;
898 SaveLiveStateHandler *save_live_state;
899 SaveStateHandler *save_state;
900 LoadStateHandler *load_state;
901 const VMStateDescription *vmsd;
902 void *opaque;
903 } SaveStateEntry;
905 static TAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
906 TAILQ_HEAD_INITIALIZER(savevm_handlers);
907 static int global_section_id;
909 static int calculate_new_instance_id(const char *idstr)
911 SaveStateEntry *se;
912 int instance_id = 0;
914 TAILQ_FOREACH(se, &savevm_handlers, entry) {
915 if (strcmp(idstr, se->idstr) == 0
916 && instance_id <= se->instance_id) {
917 instance_id = se->instance_id + 1;
920 return instance_id;
923 /* TODO: Individual devices generally have very little idea about the rest
924 of the system, so instance_id should be removed/replaced.
925 Meanwhile pass -1 as instance_id if you do not already have a clearly
926 distinguishing id for all instances of your device class. */
927 int register_savevm_live(const char *idstr,
928 int instance_id,
929 int version_id,
930 SaveLiveStateHandler *save_live_state,
931 SaveStateHandler *save_state,
932 LoadStateHandler *load_state,
933 void *opaque)
935 SaveStateEntry *se;
937 se = qemu_malloc(sizeof(SaveStateEntry));
938 pstrcpy(se->idstr, sizeof(se->idstr), idstr);
939 se->version_id = version_id;
940 se->section_id = global_section_id++;
941 se->save_live_state = save_live_state;
942 se->save_state = save_state;
943 se->load_state = load_state;
944 se->opaque = opaque;
945 se->vmsd = NULL;
947 if (instance_id == -1) {
948 se->instance_id = calculate_new_instance_id(idstr);
949 } else {
950 se->instance_id = instance_id;
952 /* add at the end of list */
953 TAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
954 return 0;
957 int register_savevm(const char *idstr,
958 int instance_id,
959 int version_id,
960 SaveStateHandler *save_state,
961 LoadStateHandler *load_state,
962 void *opaque)
964 return register_savevm_live(idstr, instance_id, version_id,
965 NULL, save_state, load_state, opaque);
968 void unregister_savevm(const char *idstr, void *opaque)
970 SaveStateEntry *se, *new_se;
972 TAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
973 if (strcmp(se->idstr, idstr) == 0 && se->opaque == opaque) {
974 TAILQ_REMOVE(&savevm_handlers, se, entry);
975 qemu_free(se);
980 int vmstate_register(int instance_id, const VMStateDescription *vmsd,
981 void *opaque)
983 SaveStateEntry *se;
985 se = qemu_malloc(sizeof(SaveStateEntry));
986 pstrcpy(se->idstr, sizeof(se->idstr), vmsd->name);
987 se->version_id = vmsd->version_id;
988 se->section_id = global_section_id++;
989 se->save_live_state = NULL;
990 se->save_state = NULL;
991 se->load_state = NULL;
992 se->opaque = opaque;
993 se->vmsd = vmsd;
995 if (instance_id == -1) {
996 se->instance_id = calculate_new_instance_id(vmsd->name);
997 } else {
998 se->instance_id = instance_id;
1000 /* add at the end of list */
1001 TAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1002 return 0;
1005 void vmstate_unregister(const char *idstr, void *opaque)
1007 unregister_savevm(idstr, opaque);
1010 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1011 void *opaque, int version_id)
1013 VMStateField *field = vmsd->fields;
1015 if (version_id > vmsd->version_id) {
1016 return -EINVAL;
1018 if (version_id < vmsd->minimum_version_id_old) {
1019 return -EINVAL;
1021 if (version_id < vmsd->minimum_version_id) {
1022 return vmsd->load_state_old(f, opaque, version_id);
1024 while(field->name) {
1025 if (field->version_id <= version_id) {
1026 void *base_addr = opaque + field->offset;
1027 int ret, i, n_elems = 1;
1029 if (field->flags & VMS_ARRAY) {
1030 n_elems = field->num;
1031 } else if (field->flags & VMS_VARRAY) {
1032 n_elems = *(size_t *)(opaque+field->num_offset);
1034 if (field->flags & VMS_POINTER) {
1035 base_addr = *(void **)base_addr;
1037 for (i = 0; i < n_elems; i++) {
1038 void *addr = base_addr + field->size * i;
1040 if (field->flags & VMS_STRUCT) {
1041 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1042 } else {
1043 ret = field->info->get(f, addr, field->size);
1046 if (ret < 0) {
1047 return ret;
1051 field++;
1053 if (vmsd->run_after_load)
1054 return vmsd->run_after_load(opaque);
1055 return 0;
1058 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1059 const void *opaque)
1061 VMStateField *field = vmsd->fields;
1063 while(field->name) {
1064 const void *base_addr = opaque + field->offset;
1065 int i, n_elems = 1;
1067 if (field->flags & VMS_ARRAY) {
1068 n_elems = field->num;
1069 } else if (field->flags & VMS_VARRAY) {
1070 n_elems = *(size_t *)(opaque+field->num_offset);
1072 if (field->flags & VMS_POINTER) {
1073 base_addr = *(void **)base_addr;
1075 for (i = 0; i < n_elems; i++) {
1076 const void *addr = base_addr + field->size * i;
1078 if (field->flags & VMS_STRUCT) {
1079 vmstate_save_state(f, field->vmsd, addr);
1080 } else {
1081 field->info->put(f, addr, field->size);
1084 field++;
1088 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1090 if (!se->vmsd) { /* Old style */
1091 return se->load_state(f, se->opaque, version_id);
1093 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1096 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1098 if (!se->vmsd) { /* Old style */
1099 se->save_state(f, se->opaque);
1100 return;
1102 vmstate_save_state(f,se->vmsd, se->opaque);
1105 #define QEMU_VM_FILE_MAGIC 0x5145564d
1106 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1107 #define QEMU_VM_FILE_VERSION 0x00000003
1109 #define QEMU_VM_EOF 0x00
1110 #define QEMU_VM_SECTION_START 0x01
1111 #define QEMU_VM_SECTION_PART 0x02
1112 #define QEMU_VM_SECTION_END 0x03
1113 #define QEMU_VM_SECTION_FULL 0x04
1115 int qemu_savevm_state_begin(QEMUFile *f)
1117 SaveStateEntry *se;
1119 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1120 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1122 TAILQ_FOREACH(se, &savevm_handlers, entry) {
1123 int len;
1125 if (se->save_live_state == NULL)
1126 continue;
1128 /* Section type */
1129 qemu_put_byte(f, QEMU_VM_SECTION_START);
1130 qemu_put_be32(f, se->section_id);
1132 /* ID string */
1133 len = strlen(se->idstr);
1134 qemu_put_byte(f, len);
1135 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1137 qemu_put_be32(f, se->instance_id);
1138 qemu_put_be32(f, se->version_id);
1140 se->save_live_state(f, QEMU_VM_SECTION_START, se->opaque);
1143 if (qemu_file_has_error(f))
1144 return -EIO;
1146 return 0;
1149 int qemu_savevm_state_iterate(QEMUFile *f)
1151 SaveStateEntry *se;
1152 int ret = 1;
1154 TAILQ_FOREACH(se, &savevm_handlers, entry) {
1155 if (se->save_live_state == NULL)
1156 continue;
1158 /* Section type */
1159 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1160 qemu_put_be32(f, se->section_id);
1162 ret &= !!se->save_live_state(f, QEMU_VM_SECTION_PART, se->opaque);
1165 if (ret)
1166 return 1;
1168 if (qemu_file_has_error(f))
1169 return -EIO;
1171 return 0;
1174 int qemu_savevm_state_complete(QEMUFile *f)
1176 SaveStateEntry *se;
1178 TAILQ_FOREACH(se, &savevm_handlers, entry) {
1179 if (se->save_live_state == NULL)
1180 continue;
1182 /* Section type */
1183 qemu_put_byte(f, QEMU_VM_SECTION_END);
1184 qemu_put_be32(f, se->section_id);
1186 se->save_live_state(f, QEMU_VM_SECTION_END, se->opaque);
1189 TAILQ_FOREACH(se, &savevm_handlers, entry) {
1190 int len;
1192 if (se->save_state == NULL && se->vmsd == NULL)
1193 continue;
1195 /* Section type */
1196 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1197 qemu_put_be32(f, se->section_id);
1199 /* ID string */
1200 len = strlen(se->idstr);
1201 qemu_put_byte(f, len);
1202 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1204 qemu_put_be32(f, se->instance_id);
1205 qemu_put_be32(f, se->version_id);
1207 vmstate_save(f, se);
1210 qemu_put_byte(f, QEMU_VM_EOF);
1212 if (qemu_file_has_error(f))
1213 return -EIO;
1215 return 0;
1218 int qemu_savevm_state(QEMUFile *f)
1220 int saved_vm_running;
1221 int ret;
1223 saved_vm_running = vm_running;
1224 vm_stop(0);
1226 bdrv_flush_all();
1228 ret = qemu_savevm_state_begin(f);
1229 if (ret < 0)
1230 goto out;
1232 do {
1233 ret = qemu_savevm_state_iterate(f);
1234 if (ret < 0)
1235 goto out;
1236 } while (ret == 0);
1238 ret = qemu_savevm_state_complete(f);
1240 out:
1241 if (qemu_file_has_error(f))
1242 ret = -EIO;
1244 if (!ret && saved_vm_running)
1245 vm_start();
1247 return ret;
1250 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1252 SaveStateEntry *se;
1254 TAILQ_FOREACH(se, &savevm_handlers, entry) {
1255 if (!strcmp(se->idstr, idstr) &&
1256 instance_id == se->instance_id)
1257 return se;
1259 return NULL;
1262 typedef struct LoadStateEntry {
1263 LIST_ENTRY(LoadStateEntry) entry;
1264 SaveStateEntry *se;
1265 int section_id;
1266 int version_id;
1267 } LoadStateEntry;
1269 int qemu_loadvm_state(QEMUFile *f)
1271 LIST_HEAD(, LoadStateEntry) loadvm_handlers =
1272 LIST_HEAD_INITIALIZER(loadvm_handlers);
1273 LoadStateEntry *le, *new_le;
1274 uint8_t section_type;
1275 unsigned int v;
1276 int ret;
1278 v = qemu_get_be32(f);
1279 if (v != QEMU_VM_FILE_MAGIC)
1280 return -EINVAL;
1282 v = qemu_get_be32(f);
1283 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1284 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1285 return -ENOTSUP;
1287 if (v != QEMU_VM_FILE_VERSION)
1288 return -ENOTSUP;
1290 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1291 uint32_t instance_id, version_id, section_id;
1292 SaveStateEntry *se;
1293 char idstr[257];
1294 int len;
1296 switch (section_type) {
1297 case QEMU_VM_SECTION_START:
1298 case QEMU_VM_SECTION_FULL:
1299 /* Read section start */
1300 section_id = qemu_get_be32(f);
1301 len = qemu_get_byte(f);
1302 qemu_get_buffer(f, (uint8_t *)idstr, len);
1303 idstr[len] = 0;
1304 instance_id = qemu_get_be32(f);
1305 version_id = qemu_get_be32(f);
1307 /* Find savevm section */
1308 se = find_se(idstr, instance_id);
1309 if (se == NULL) {
1310 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1311 ret = -EINVAL;
1312 goto out;
1315 /* Validate version */
1316 if (version_id > se->version_id) {
1317 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1318 version_id, idstr, se->version_id);
1319 ret = -EINVAL;
1320 goto out;
1323 /* Add entry */
1324 le = qemu_mallocz(sizeof(*le));
1326 le->se = se;
1327 le->section_id = section_id;
1328 le->version_id = version_id;
1329 LIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1331 ret = vmstate_load(f, le->se, le->version_id);
1332 if (ret < 0) {
1333 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1334 instance_id, idstr);
1335 goto out;
1337 break;
1338 case QEMU_VM_SECTION_PART:
1339 case QEMU_VM_SECTION_END:
1340 section_id = qemu_get_be32(f);
1342 LIST_FOREACH(le, &loadvm_handlers, entry) {
1343 if (le->section_id == section_id) {
1344 break;
1347 if (le == NULL) {
1348 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1349 ret = -EINVAL;
1350 goto out;
1353 ret = vmstate_load(f, le->se, le->version_id);
1354 if (ret < 0) {
1355 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1356 section_id);
1357 goto out;
1359 break;
1360 default:
1361 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1362 ret = -EINVAL;
1363 goto out;
1367 ret = 0;
1369 out:
1370 LIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1371 LIST_REMOVE(le, entry);
1372 qemu_free(le);
1375 if (qemu_file_has_error(f))
1376 ret = -EIO;
1378 return ret;
1381 /* device can contain snapshots */
1382 static int bdrv_can_snapshot(BlockDriverState *bs)
1384 return (bs &&
1385 !bdrv_is_removable(bs) &&
1386 !bdrv_is_read_only(bs));
1389 /* device must be snapshots in order to have a reliable snapshot */
1390 static int bdrv_has_snapshot(BlockDriverState *bs)
1392 return (bs &&
1393 !bdrv_is_removable(bs) &&
1394 !bdrv_is_read_only(bs));
1397 static BlockDriverState *get_bs_snapshots(void)
1399 BlockDriverState *bs;
1400 DriveInfo *dinfo;
1402 if (bs_snapshots)
1403 return bs_snapshots;
1404 TAILQ_FOREACH(dinfo, &drives, next) {
1405 bs = dinfo->bdrv;
1406 if (bdrv_can_snapshot(bs))
1407 goto ok;
1409 return NULL;
1411 bs_snapshots = bs;
1412 return bs;
1415 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1416 const char *name)
1418 QEMUSnapshotInfo *sn_tab, *sn;
1419 int nb_sns, i, ret;
1421 ret = -ENOENT;
1422 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1423 if (nb_sns < 0)
1424 return ret;
1425 for(i = 0; i < nb_sns; i++) {
1426 sn = &sn_tab[i];
1427 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1428 *sn_info = *sn;
1429 ret = 0;
1430 break;
1433 qemu_free(sn_tab);
1434 return ret;
1437 void do_savevm(Monitor *mon, const QDict *qdict)
1439 DriveInfo *dinfo;
1440 BlockDriverState *bs, *bs1;
1441 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1442 int must_delete, ret;
1443 QEMUFile *f;
1444 int saved_vm_running;
1445 uint32_t vm_state_size;
1446 #ifdef _WIN32
1447 struct _timeb tb;
1448 #else
1449 struct timeval tv;
1450 #endif
1451 const char *name = qdict_get_try_str(qdict, "name");
1453 bs = get_bs_snapshots();
1454 if (!bs) {
1455 monitor_printf(mon, "No block device can accept snapshots\n");
1456 return;
1459 /* ??? Should this occur after vm_stop? */
1460 qemu_aio_flush();
1462 saved_vm_running = vm_running;
1463 vm_stop(0);
1465 must_delete = 0;
1466 if (name) {
1467 ret = bdrv_snapshot_find(bs, old_sn, name);
1468 if (ret >= 0) {
1469 must_delete = 1;
1472 memset(sn, 0, sizeof(*sn));
1473 if (must_delete) {
1474 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
1475 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
1476 } else {
1477 if (name)
1478 pstrcpy(sn->name, sizeof(sn->name), name);
1481 /* fill auxiliary fields */
1482 #ifdef _WIN32
1483 _ftime(&tb);
1484 sn->date_sec = tb.time;
1485 sn->date_nsec = tb.millitm * 1000000;
1486 #else
1487 gettimeofday(&tv, NULL);
1488 sn->date_sec = tv.tv_sec;
1489 sn->date_nsec = tv.tv_usec * 1000;
1490 #endif
1491 sn->vm_clock_nsec = qemu_get_clock(vm_clock);
1493 /* save the VM state */
1494 f = qemu_fopen_bdrv(bs, 1);
1495 if (!f) {
1496 monitor_printf(mon, "Could not open VM state file\n");
1497 goto the_end;
1499 ret = qemu_savevm_state(f);
1500 vm_state_size = qemu_ftell(f);
1501 qemu_fclose(f);
1502 if (ret < 0) {
1503 monitor_printf(mon, "Error %d while writing VM\n", ret);
1504 goto the_end;
1507 /* create the snapshots */
1509 TAILQ_FOREACH(dinfo, &drives, next) {
1510 bs1 = dinfo->bdrv;
1511 if (bdrv_has_snapshot(bs1)) {
1512 if (must_delete) {
1513 ret = bdrv_snapshot_delete(bs1, old_sn->id_str);
1514 if (ret < 0) {
1515 monitor_printf(mon,
1516 "Error while deleting snapshot on '%s'\n",
1517 bdrv_get_device_name(bs1));
1520 /* Write VM state size only to the image that contains the state */
1521 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
1522 ret = bdrv_snapshot_create(bs1, sn);
1523 if (ret < 0) {
1524 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
1525 bdrv_get_device_name(bs1));
1530 the_end:
1531 if (saved_vm_running)
1532 vm_start();
1535 int load_vmstate(Monitor *mon, const char *name)
1537 DriveInfo *dinfo;
1538 BlockDriverState *bs, *bs1;
1539 QEMUSnapshotInfo sn;
1540 QEMUFile *f;
1541 int ret;
1543 bs = get_bs_snapshots();
1544 if (!bs) {
1545 monitor_printf(mon, "No block device supports snapshots\n");
1546 return -EINVAL;
1549 /* Flush all IO requests so they don't interfere with the new state. */
1550 qemu_aio_flush();
1552 TAILQ_FOREACH(dinfo, &drives, next) {
1553 bs1 = dinfo->bdrv;
1554 if (bdrv_has_snapshot(bs1)) {
1555 ret = bdrv_snapshot_goto(bs1, name);
1556 if (ret < 0) {
1557 if (bs != bs1)
1558 monitor_printf(mon, "Warning: ");
1559 switch(ret) {
1560 case -ENOTSUP:
1561 monitor_printf(mon,
1562 "Snapshots not supported on device '%s'\n",
1563 bdrv_get_device_name(bs1));
1564 break;
1565 case -ENOENT:
1566 monitor_printf(mon, "Could not find snapshot '%s' on "
1567 "device '%s'\n",
1568 name, bdrv_get_device_name(bs1));
1569 break;
1570 default:
1571 monitor_printf(mon, "Error %d while activating snapshot on"
1572 " '%s'\n", ret, bdrv_get_device_name(bs1));
1573 break;
1575 /* fatal on snapshot block device */
1576 if (bs == bs1)
1577 return 0;
1582 /* Don't even try to load empty VM states */
1583 ret = bdrv_snapshot_find(bs, &sn, name);
1584 if ((ret >= 0) && (sn.vm_state_size == 0))
1585 return -EINVAL;
1587 /* restore the VM state */
1588 f = qemu_fopen_bdrv(bs, 0);
1589 if (!f) {
1590 monitor_printf(mon, "Could not open VM state file\n");
1591 return -EINVAL;
1593 ret = qemu_loadvm_state(f);
1594 qemu_fclose(f);
1595 if (ret < 0) {
1596 monitor_printf(mon, "Error %d while loading VM state\n", ret);
1597 return ret;
1599 return 0;
1602 void do_delvm(Monitor *mon, const QDict *qdict)
1604 DriveInfo *dinfo;
1605 BlockDriverState *bs, *bs1;
1606 int ret;
1607 const char *name = qdict_get_str(qdict, "name");
1609 bs = get_bs_snapshots();
1610 if (!bs) {
1611 monitor_printf(mon, "No block device supports snapshots\n");
1612 return;
1615 TAILQ_FOREACH(dinfo, &drives, next) {
1616 bs1 = dinfo->bdrv;
1617 if (bdrv_has_snapshot(bs1)) {
1618 ret = bdrv_snapshot_delete(bs1, name);
1619 if (ret < 0) {
1620 if (ret == -ENOTSUP)
1621 monitor_printf(mon,
1622 "Snapshots not supported on device '%s'\n",
1623 bdrv_get_device_name(bs1));
1624 else
1625 monitor_printf(mon, "Error %d while deleting snapshot on "
1626 "'%s'\n", ret, bdrv_get_device_name(bs1));
1632 void do_info_snapshots(Monitor *mon)
1634 DriveInfo *dinfo;
1635 BlockDriverState *bs, *bs1;
1636 QEMUSnapshotInfo *sn_tab, *sn;
1637 int nb_sns, i;
1638 char buf[256];
1640 bs = get_bs_snapshots();
1641 if (!bs) {
1642 monitor_printf(mon, "No available block device supports snapshots\n");
1643 return;
1645 monitor_printf(mon, "Snapshot devices:");
1646 TAILQ_FOREACH(dinfo, &drives, next) {
1647 bs1 = dinfo->bdrv;
1648 if (bdrv_has_snapshot(bs1)) {
1649 if (bs == bs1)
1650 monitor_printf(mon, " %s", bdrv_get_device_name(bs1));
1653 monitor_printf(mon, "\n");
1655 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1656 if (nb_sns < 0) {
1657 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
1658 return;
1660 monitor_printf(mon, "Snapshot list (from %s):\n",
1661 bdrv_get_device_name(bs));
1662 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
1663 for(i = 0; i < nb_sns; i++) {
1664 sn = &sn_tab[i];
1665 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
1667 qemu_free(sn_tab);