virtio-net: track host/guest header length
[qemu/ar7.git] / savevm.c
blobb080d3725881e68560706e61ac875cfbcf2d01bf
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"
86 #include "memory.h"
87 #include "qmp-commands.h"
88 #include "trace.h"
90 #define SELF_ANNOUNCE_ROUNDS 5
92 #ifndef ETH_P_RARP
93 #define ETH_P_RARP 0x8035
94 #endif
95 #define ARP_HTYPE_ETH 0x0001
96 #define ARP_PTYPE_IP 0x0800
97 #define ARP_OP_REQUEST_REV 0x3
99 static int announce_self_create(uint8_t *buf,
100 uint8_t *mac_addr)
102 /* Ethernet header. */
103 memset(buf, 0xff, 6); /* destination MAC addr */
104 memcpy(buf + 6, mac_addr, 6); /* source MAC addr */
105 *(uint16_t *)(buf + 12) = htons(ETH_P_RARP); /* ethertype */
107 /* RARP header. */
108 *(uint16_t *)(buf + 14) = htons(ARP_HTYPE_ETH); /* hardware addr space */
109 *(uint16_t *)(buf + 16) = htons(ARP_PTYPE_IP); /* protocol addr space */
110 *(buf + 18) = 6; /* hardware addr length (ethernet) */
111 *(buf + 19) = 4; /* protocol addr length (IPv4) */
112 *(uint16_t *)(buf + 20) = htons(ARP_OP_REQUEST_REV); /* opcode */
113 memcpy(buf + 22, mac_addr, 6); /* source hw addr */
114 memset(buf + 28, 0x00, 4); /* source protocol addr */
115 memcpy(buf + 32, mac_addr, 6); /* target hw addr */
116 memset(buf + 38, 0x00, 4); /* target protocol addr */
118 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
119 memset(buf + 42, 0x00, 18);
121 return 60; /* len (FCS will be added by hardware) */
124 static void qemu_announce_self_iter(NICState *nic, void *opaque)
126 uint8_t buf[60];
127 int len;
129 len = announce_self_create(buf, nic->conf->macaddr.a);
131 qemu_send_packet_raw(&nic->nc, buf, len);
135 static void qemu_announce_self_once(void *opaque)
137 static int count = SELF_ANNOUNCE_ROUNDS;
138 QEMUTimer *timer = *(QEMUTimer **)opaque;
140 qemu_foreach_nic(qemu_announce_self_iter, NULL);
142 if (--count) {
143 /* delay 50ms, 150ms, 250ms, ... */
144 qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
145 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
146 } else {
147 qemu_del_timer(timer);
148 qemu_free_timer(timer);
152 void qemu_announce_self(void)
154 static QEMUTimer *timer;
155 timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
156 qemu_announce_self_once(&timer);
159 /***********************************************************/
160 /* savevm/loadvm support */
162 #define IO_BUF_SIZE 32768
164 struct QEMUFile {
165 QEMUFilePutBufferFunc *put_buffer;
166 QEMUFileGetBufferFunc *get_buffer;
167 QEMUFileCloseFunc *close;
168 QEMUFileRateLimit *rate_limit;
169 QEMUFileSetRateLimit *set_rate_limit;
170 QEMUFileGetRateLimit *get_rate_limit;
171 void *opaque;
172 int is_write;
174 int64_t buf_offset; /* start of buffer when writing, end of buffer
175 when reading */
176 int buf_index;
177 int buf_size; /* 0 when writing */
178 uint8_t buf[IO_BUF_SIZE];
180 int last_error;
183 typedef struct QEMUFileStdio
185 FILE *stdio_file;
186 QEMUFile *file;
187 } QEMUFileStdio;
189 typedef struct QEMUFileSocket
191 int fd;
192 QEMUFile *file;
193 } QEMUFileSocket;
195 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
197 QEMUFileSocket *s = opaque;
198 ssize_t len;
200 do {
201 len = qemu_recv(s->fd, buf, size, 0);
202 } while (len == -1 && socket_error() == EINTR);
204 if (len == -1)
205 len = -socket_error();
207 return len;
210 static int socket_close(void *opaque)
212 QEMUFileSocket *s = opaque;
213 g_free(s);
214 return 0;
217 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
219 QEMUFileStdio *s = opaque;
220 return fwrite(buf, 1, size, s->stdio_file);
223 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
225 QEMUFileStdio *s = opaque;
226 FILE *fp = s->stdio_file;
227 int bytes;
229 do {
230 clearerr(fp);
231 bytes = fread(buf, 1, size, fp);
232 } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
233 return bytes;
236 static int stdio_pclose(void *opaque)
238 QEMUFileStdio *s = opaque;
239 int ret;
240 ret = pclose(s->stdio_file);
241 if (ret == -1) {
242 ret = -errno;
244 g_free(s);
245 return ret;
248 static int stdio_fclose(void *opaque)
250 QEMUFileStdio *s = opaque;
251 int ret = 0;
252 if (fclose(s->stdio_file) == EOF) {
253 ret = -errno;
255 g_free(s);
256 return ret;
259 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
261 QEMUFileStdio *s;
263 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
264 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
265 return NULL;
268 s = g_malloc0(sizeof(QEMUFileStdio));
270 s->stdio_file = stdio_file;
272 if(mode[0] == 'r') {
273 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose,
274 NULL, NULL, NULL);
275 } else {
276 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose,
277 NULL, NULL, NULL);
279 return s->file;
282 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
284 FILE *popen_file;
286 popen_file = popen(command, mode);
287 if(popen_file == NULL) {
288 return NULL;
291 return qemu_popen(popen_file, mode);
294 int qemu_stdio_fd(QEMUFile *f)
296 QEMUFileStdio *p;
297 int fd;
299 p = (QEMUFileStdio *)f->opaque;
300 fd = fileno(p->stdio_file);
302 return fd;
305 QEMUFile *qemu_fdopen(int fd, const char *mode)
307 QEMUFileStdio *s;
309 if (mode == NULL ||
310 (mode[0] != 'r' && mode[0] != 'w') ||
311 mode[1] != 'b' || mode[2] != 0) {
312 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
313 return NULL;
316 s = g_malloc0(sizeof(QEMUFileStdio));
317 s->stdio_file = fdopen(fd, mode);
318 if (!s->stdio_file)
319 goto fail;
321 if(mode[0] == 'r') {
322 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose,
323 NULL, NULL, NULL);
324 } else {
325 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose,
326 NULL, NULL, NULL);
328 return s->file;
330 fail:
331 g_free(s);
332 return NULL;
335 QEMUFile *qemu_fopen_socket(int fd)
337 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
339 s->fd = fd;
340 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close,
341 NULL, NULL, NULL);
342 return s->file;
345 static int file_put_buffer(void *opaque, const uint8_t *buf,
346 int64_t pos, int size)
348 QEMUFileStdio *s = opaque;
349 fseek(s->stdio_file, pos, SEEK_SET);
350 return fwrite(buf, 1, size, s->stdio_file);
353 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
355 QEMUFileStdio *s = opaque;
356 fseek(s->stdio_file, pos, SEEK_SET);
357 return fread(buf, 1, size, s->stdio_file);
360 QEMUFile *qemu_fopen(const char *filename, const char *mode)
362 QEMUFileStdio *s;
364 if (mode == NULL ||
365 (mode[0] != 'r' && mode[0] != 'w') ||
366 mode[1] != 'b' || mode[2] != 0) {
367 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
368 return NULL;
371 s = g_malloc0(sizeof(QEMUFileStdio));
373 s->stdio_file = fopen(filename, mode);
374 if (!s->stdio_file)
375 goto fail;
377 if(mode[0] == 'w') {
378 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose,
379 NULL, NULL, NULL);
380 } else {
381 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose,
382 NULL, NULL, NULL);
384 return s->file;
385 fail:
386 g_free(s);
387 return NULL;
390 static int block_put_buffer(void *opaque, const uint8_t *buf,
391 int64_t pos, int size)
393 bdrv_save_vmstate(opaque, buf, pos, size);
394 return size;
397 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
399 return bdrv_load_vmstate(opaque, buf, pos, size);
402 static int bdrv_fclose(void *opaque)
404 return bdrv_flush(opaque);
407 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
409 if (is_writable)
410 return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose,
411 NULL, NULL, NULL);
412 return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL, NULL);
415 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
416 QEMUFileGetBufferFunc *get_buffer,
417 QEMUFileCloseFunc *close,
418 QEMUFileRateLimit *rate_limit,
419 QEMUFileSetRateLimit *set_rate_limit,
420 QEMUFileGetRateLimit *get_rate_limit)
422 QEMUFile *f;
424 f = g_malloc0(sizeof(QEMUFile));
426 f->opaque = opaque;
427 f->put_buffer = put_buffer;
428 f->get_buffer = get_buffer;
429 f->close = close;
430 f->rate_limit = rate_limit;
431 f->set_rate_limit = set_rate_limit;
432 f->get_rate_limit = get_rate_limit;
433 f->is_write = 0;
435 return f;
438 int qemu_file_get_error(QEMUFile *f)
440 return f->last_error;
443 static void qemu_file_set_error(QEMUFile *f, int ret)
445 f->last_error = ret;
448 /** Flushes QEMUFile buffer
451 static int qemu_fflush(QEMUFile *f)
453 int ret = 0;
455 if (!f->put_buffer)
456 return 0;
458 if (f->is_write && f->buf_index > 0) {
459 ret = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
460 if (ret >= 0) {
461 f->buf_offset += f->buf_index;
463 f->buf_index = 0;
465 return ret;
468 static void qemu_fill_buffer(QEMUFile *f)
470 int len;
471 int pending;
473 if (!f->get_buffer)
474 return;
476 if (f->is_write)
477 abort();
479 pending = f->buf_size - f->buf_index;
480 if (pending > 0) {
481 memmove(f->buf, f->buf + f->buf_index, pending);
483 f->buf_index = 0;
484 f->buf_size = pending;
486 len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
487 IO_BUF_SIZE - pending);
488 if (len > 0) {
489 f->buf_size += len;
490 f->buf_offset += len;
491 } else if (len == 0) {
492 qemu_file_set_error(f, -EIO);
493 } else if (len != -EAGAIN)
494 qemu_file_set_error(f, len);
497 /** Closes the file
499 * Returns negative error value if any error happened on previous operations or
500 * while closing the file. Returns 0 or positive number on success.
502 * The meaning of return value on success depends on the specific backend
503 * being used.
505 int qemu_fclose(QEMUFile *f)
507 int ret;
508 ret = qemu_fflush(f);
510 if (f->close) {
511 int ret2 = f->close(f->opaque);
512 if (ret >= 0) {
513 ret = ret2;
516 /* If any error was spotted before closing, we should report it
517 * instead of the close() return value.
519 if (f->last_error) {
520 ret = f->last_error;
522 g_free(f);
523 return ret;
526 int qemu_file_put_notify(QEMUFile *f)
528 return f->put_buffer(f->opaque, NULL, 0, 0);
531 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
533 int l;
535 if (f->last_error) {
536 return;
539 if (f->is_write == 0 && f->buf_index > 0) {
540 fprintf(stderr,
541 "Attempted to write to buffer while read buffer is not empty\n");
542 abort();
545 while (size > 0) {
546 l = IO_BUF_SIZE - f->buf_index;
547 if (l > size)
548 l = size;
549 memcpy(f->buf + f->buf_index, buf, l);
550 f->is_write = 1;
551 f->buf_index += l;
552 buf += l;
553 size -= l;
554 if (f->buf_index >= IO_BUF_SIZE) {
555 int ret = qemu_fflush(f);
556 if (ret < 0) {
557 qemu_file_set_error(f, ret);
558 break;
564 void qemu_put_byte(QEMUFile *f, int v)
566 if (f->last_error) {
567 return;
570 if (f->is_write == 0 && f->buf_index > 0) {
571 fprintf(stderr,
572 "Attempted to write to buffer while read buffer is not empty\n");
573 abort();
576 f->buf[f->buf_index++] = v;
577 f->is_write = 1;
578 if (f->buf_index >= IO_BUF_SIZE) {
579 int ret = qemu_fflush(f);
580 if (ret < 0) {
581 qemu_file_set_error(f, ret);
586 static void qemu_file_skip(QEMUFile *f, int size)
588 if (f->buf_index + size <= f->buf_size) {
589 f->buf_index += size;
593 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
595 int pending;
596 int index;
598 if (f->is_write) {
599 abort();
602 index = f->buf_index + offset;
603 pending = f->buf_size - index;
604 if (pending < size) {
605 qemu_fill_buffer(f);
606 index = f->buf_index + offset;
607 pending = f->buf_size - index;
610 if (pending <= 0) {
611 return 0;
613 if (size > pending) {
614 size = pending;
617 memcpy(buf, f->buf + index, size);
618 return size;
621 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
623 int pending = size;
624 int done = 0;
626 while (pending > 0) {
627 int res;
629 res = qemu_peek_buffer(f, buf, pending, 0);
630 if (res == 0) {
631 return done;
633 qemu_file_skip(f, res);
634 buf += res;
635 pending -= res;
636 done += res;
638 return done;
641 static int qemu_peek_byte(QEMUFile *f, int offset)
643 int index = f->buf_index + offset;
645 if (f->is_write) {
646 abort();
649 if (index >= f->buf_size) {
650 qemu_fill_buffer(f);
651 index = f->buf_index + offset;
652 if (index >= f->buf_size) {
653 return 0;
656 return f->buf[index];
659 int qemu_get_byte(QEMUFile *f)
661 int result;
663 result = qemu_peek_byte(f, 0);
664 qemu_file_skip(f, 1);
665 return result;
668 static int64_t qemu_ftell(QEMUFile *f)
670 return f->buf_offset - f->buf_size + f->buf_index;
673 int qemu_file_rate_limit(QEMUFile *f)
675 if (f->rate_limit)
676 return f->rate_limit(f->opaque);
678 return 0;
681 int64_t qemu_file_get_rate_limit(QEMUFile *f)
683 if (f->get_rate_limit)
684 return f->get_rate_limit(f->opaque);
686 return 0;
689 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
691 /* any failed or completed migration keeps its state to allow probing of
692 * migration data, but has no associated file anymore */
693 if (f && f->set_rate_limit)
694 return f->set_rate_limit(f->opaque, new_rate);
696 return 0;
699 void qemu_put_be16(QEMUFile *f, unsigned int v)
701 qemu_put_byte(f, v >> 8);
702 qemu_put_byte(f, v);
705 void qemu_put_be32(QEMUFile *f, unsigned int v)
707 qemu_put_byte(f, v >> 24);
708 qemu_put_byte(f, v >> 16);
709 qemu_put_byte(f, v >> 8);
710 qemu_put_byte(f, v);
713 void qemu_put_be64(QEMUFile *f, uint64_t v)
715 qemu_put_be32(f, v >> 32);
716 qemu_put_be32(f, v);
719 unsigned int qemu_get_be16(QEMUFile *f)
721 unsigned int v;
722 v = qemu_get_byte(f) << 8;
723 v |= qemu_get_byte(f);
724 return v;
727 unsigned int qemu_get_be32(QEMUFile *f)
729 unsigned int v;
730 v = qemu_get_byte(f) << 24;
731 v |= qemu_get_byte(f) << 16;
732 v |= qemu_get_byte(f) << 8;
733 v |= qemu_get_byte(f);
734 return v;
737 uint64_t qemu_get_be64(QEMUFile *f)
739 uint64_t v;
740 v = (uint64_t)qemu_get_be32(f) << 32;
741 v |= qemu_get_be32(f);
742 return v;
746 /* timer */
748 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
750 uint64_t expire_time;
752 expire_time = qemu_timer_expire_time_ns(ts);
753 qemu_put_be64(f, expire_time);
756 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
758 uint64_t expire_time;
760 expire_time = qemu_get_be64(f);
761 if (expire_time != -1) {
762 qemu_mod_timer_ns(ts, expire_time);
763 } else {
764 qemu_del_timer(ts);
769 /* bool */
771 static int get_bool(QEMUFile *f, void *pv, size_t size)
773 bool *v = pv;
774 *v = qemu_get_byte(f);
775 return 0;
778 static void put_bool(QEMUFile *f, void *pv, size_t size)
780 bool *v = pv;
781 qemu_put_byte(f, *v);
784 const VMStateInfo vmstate_info_bool = {
785 .name = "bool",
786 .get = get_bool,
787 .put = put_bool,
790 /* 8 bit int */
792 static int get_int8(QEMUFile *f, void *pv, size_t size)
794 int8_t *v = pv;
795 qemu_get_s8s(f, v);
796 return 0;
799 static void put_int8(QEMUFile *f, void *pv, size_t size)
801 int8_t *v = pv;
802 qemu_put_s8s(f, v);
805 const VMStateInfo vmstate_info_int8 = {
806 .name = "int8",
807 .get = get_int8,
808 .put = put_int8,
811 /* 16 bit int */
813 static int get_int16(QEMUFile *f, void *pv, size_t size)
815 int16_t *v = pv;
816 qemu_get_sbe16s(f, v);
817 return 0;
820 static void put_int16(QEMUFile *f, void *pv, size_t size)
822 int16_t *v = pv;
823 qemu_put_sbe16s(f, v);
826 const VMStateInfo vmstate_info_int16 = {
827 .name = "int16",
828 .get = get_int16,
829 .put = put_int16,
832 /* 32 bit int */
834 static int get_int32(QEMUFile *f, void *pv, size_t size)
836 int32_t *v = pv;
837 qemu_get_sbe32s(f, v);
838 return 0;
841 static void put_int32(QEMUFile *f, void *pv, size_t size)
843 int32_t *v = pv;
844 qemu_put_sbe32s(f, v);
847 const VMStateInfo vmstate_info_int32 = {
848 .name = "int32",
849 .get = get_int32,
850 .put = put_int32,
853 /* 32 bit int. See that the received value is the same than the one
854 in the field */
856 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
858 int32_t *v = pv;
859 int32_t v2;
860 qemu_get_sbe32s(f, &v2);
862 if (*v == v2)
863 return 0;
864 return -EINVAL;
867 const VMStateInfo vmstate_info_int32_equal = {
868 .name = "int32 equal",
869 .get = get_int32_equal,
870 .put = put_int32,
873 /* 32 bit int. See that the received value is the less or the same
874 than the one in the field */
876 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
878 int32_t *old = pv;
879 int32_t new;
880 qemu_get_sbe32s(f, &new);
882 if (*old <= new)
883 return 0;
884 return -EINVAL;
887 const VMStateInfo vmstate_info_int32_le = {
888 .name = "int32 equal",
889 .get = get_int32_le,
890 .put = put_int32,
893 /* 64 bit int */
895 static int get_int64(QEMUFile *f, void *pv, size_t size)
897 int64_t *v = pv;
898 qemu_get_sbe64s(f, v);
899 return 0;
902 static void put_int64(QEMUFile *f, void *pv, size_t size)
904 int64_t *v = pv;
905 qemu_put_sbe64s(f, v);
908 const VMStateInfo vmstate_info_int64 = {
909 .name = "int64",
910 .get = get_int64,
911 .put = put_int64,
914 /* 8 bit unsigned int */
916 static int get_uint8(QEMUFile *f, void *pv, size_t size)
918 uint8_t *v = pv;
919 qemu_get_8s(f, v);
920 return 0;
923 static void put_uint8(QEMUFile *f, void *pv, size_t size)
925 uint8_t *v = pv;
926 qemu_put_8s(f, v);
929 const VMStateInfo vmstate_info_uint8 = {
930 .name = "uint8",
931 .get = get_uint8,
932 .put = put_uint8,
935 /* 16 bit unsigned int */
937 static int get_uint16(QEMUFile *f, void *pv, size_t size)
939 uint16_t *v = pv;
940 qemu_get_be16s(f, v);
941 return 0;
944 static void put_uint16(QEMUFile *f, void *pv, size_t size)
946 uint16_t *v = pv;
947 qemu_put_be16s(f, v);
950 const VMStateInfo vmstate_info_uint16 = {
951 .name = "uint16",
952 .get = get_uint16,
953 .put = put_uint16,
956 /* 32 bit unsigned int */
958 static int get_uint32(QEMUFile *f, void *pv, size_t size)
960 uint32_t *v = pv;
961 qemu_get_be32s(f, v);
962 return 0;
965 static void put_uint32(QEMUFile *f, void *pv, size_t size)
967 uint32_t *v = pv;
968 qemu_put_be32s(f, v);
971 const VMStateInfo vmstate_info_uint32 = {
972 .name = "uint32",
973 .get = get_uint32,
974 .put = put_uint32,
977 /* 32 bit uint. See that the received value is the same than the one
978 in the field */
980 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
982 uint32_t *v = pv;
983 uint32_t v2;
984 qemu_get_be32s(f, &v2);
986 if (*v == v2) {
987 return 0;
989 return -EINVAL;
992 const VMStateInfo vmstate_info_uint32_equal = {
993 .name = "uint32 equal",
994 .get = get_uint32_equal,
995 .put = put_uint32,
998 /* 64 bit unsigned int */
1000 static int get_uint64(QEMUFile *f, void *pv, size_t size)
1002 uint64_t *v = pv;
1003 qemu_get_be64s(f, v);
1004 return 0;
1007 static void put_uint64(QEMUFile *f, void *pv, size_t size)
1009 uint64_t *v = pv;
1010 qemu_put_be64s(f, v);
1013 const VMStateInfo vmstate_info_uint64 = {
1014 .name = "uint64",
1015 .get = get_uint64,
1016 .put = put_uint64,
1019 /* 8 bit int. See that the received value is the same than the one
1020 in the field */
1022 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
1024 uint8_t *v = pv;
1025 uint8_t v2;
1026 qemu_get_8s(f, &v2);
1028 if (*v == v2)
1029 return 0;
1030 return -EINVAL;
1033 const VMStateInfo vmstate_info_uint8_equal = {
1034 .name = "uint8 equal",
1035 .get = get_uint8_equal,
1036 .put = put_uint8,
1039 /* 16 bit unsigned int int. See that the received value is the same than the one
1040 in the field */
1042 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1044 uint16_t *v = pv;
1045 uint16_t v2;
1046 qemu_get_be16s(f, &v2);
1048 if (*v == v2)
1049 return 0;
1050 return -EINVAL;
1053 const VMStateInfo vmstate_info_uint16_equal = {
1054 .name = "uint16 equal",
1055 .get = get_uint16_equal,
1056 .put = put_uint16,
1059 /* timers */
1061 static int get_timer(QEMUFile *f, void *pv, size_t size)
1063 QEMUTimer *v = pv;
1064 qemu_get_timer(f, v);
1065 return 0;
1068 static void put_timer(QEMUFile *f, void *pv, size_t size)
1070 QEMUTimer *v = pv;
1071 qemu_put_timer(f, v);
1074 const VMStateInfo vmstate_info_timer = {
1075 .name = "timer",
1076 .get = get_timer,
1077 .put = put_timer,
1080 /* uint8_t buffers */
1082 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1084 uint8_t *v = pv;
1085 qemu_get_buffer(f, v, size);
1086 return 0;
1089 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1091 uint8_t *v = pv;
1092 qemu_put_buffer(f, v, size);
1095 const VMStateInfo vmstate_info_buffer = {
1096 .name = "buffer",
1097 .get = get_buffer,
1098 .put = put_buffer,
1101 /* unused buffers: space that was used for some fields that are
1102 not useful anymore */
1104 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1106 uint8_t buf[1024];
1107 int block_len;
1109 while (size > 0) {
1110 block_len = MIN(sizeof(buf), size);
1111 size -= block_len;
1112 qemu_get_buffer(f, buf, block_len);
1114 return 0;
1117 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1119 static const uint8_t buf[1024];
1120 int block_len;
1122 while (size > 0) {
1123 block_len = MIN(sizeof(buf), size);
1124 size -= block_len;
1125 qemu_put_buffer(f, buf, block_len);
1129 const VMStateInfo vmstate_info_unused_buffer = {
1130 .name = "unused_buffer",
1131 .get = get_unused_buffer,
1132 .put = put_unused_buffer,
1135 typedef struct CompatEntry {
1136 char idstr[256];
1137 int instance_id;
1138 } CompatEntry;
1140 typedef struct SaveStateEntry {
1141 QTAILQ_ENTRY(SaveStateEntry) entry;
1142 char idstr[256];
1143 int instance_id;
1144 int alias_id;
1145 int version_id;
1146 int section_id;
1147 SaveVMHandlers *ops;
1148 const VMStateDescription *vmsd;
1149 void *opaque;
1150 CompatEntry *compat;
1151 int no_migrate;
1152 int is_ram;
1153 } SaveStateEntry;
1156 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1157 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1158 static int global_section_id;
1160 static int calculate_new_instance_id(const char *idstr)
1162 SaveStateEntry *se;
1163 int instance_id = 0;
1165 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1166 if (strcmp(idstr, se->idstr) == 0
1167 && instance_id <= se->instance_id) {
1168 instance_id = se->instance_id + 1;
1171 return instance_id;
1174 static int calculate_compat_instance_id(const char *idstr)
1176 SaveStateEntry *se;
1177 int instance_id = 0;
1179 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1180 if (!se->compat)
1181 continue;
1183 if (strcmp(idstr, se->compat->idstr) == 0
1184 && instance_id <= se->compat->instance_id) {
1185 instance_id = se->compat->instance_id + 1;
1188 return instance_id;
1191 /* TODO: Individual devices generally have very little idea about the rest
1192 of the system, so instance_id should be removed/replaced.
1193 Meanwhile pass -1 as instance_id if you do not already have a clearly
1194 distinguishing id for all instances of your device class. */
1195 int register_savevm_live(DeviceState *dev,
1196 const char *idstr,
1197 int instance_id,
1198 int version_id,
1199 SaveVMHandlers *ops,
1200 void *opaque)
1202 SaveStateEntry *se;
1204 se = g_malloc0(sizeof(SaveStateEntry));
1205 se->version_id = version_id;
1206 se->section_id = global_section_id++;
1207 se->ops = ops;
1208 se->opaque = opaque;
1209 se->vmsd = NULL;
1210 se->no_migrate = 0;
1211 /* if this is a live_savem then set is_ram */
1212 if (ops->save_live_setup != NULL) {
1213 se->is_ram = 1;
1216 if (dev) {
1217 char *id = qdev_get_dev_path(dev);
1218 if (id) {
1219 pstrcpy(se->idstr, sizeof(se->idstr), id);
1220 pstrcat(se->idstr, sizeof(se->idstr), "/");
1221 g_free(id);
1223 se->compat = g_malloc0(sizeof(CompatEntry));
1224 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1225 se->compat->instance_id = instance_id == -1 ?
1226 calculate_compat_instance_id(idstr) : instance_id;
1227 instance_id = -1;
1230 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1232 if (instance_id == -1) {
1233 se->instance_id = calculate_new_instance_id(se->idstr);
1234 } else {
1235 se->instance_id = instance_id;
1237 assert(!se->compat || se->instance_id == 0);
1238 /* add at the end of list */
1239 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1240 return 0;
1243 int register_savevm(DeviceState *dev,
1244 const char *idstr,
1245 int instance_id,
1246 int version_id,
1247 SaveStateHandler *save_state,
1248 LoadStateHandler *load_state,
1249 void *opaque)
1251 SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
1252 ops->save_state = save_state;
1253 ops->load_state = load_state;
1254 return register_savevm_live(dev, idstr, instance_id, version_id,
1255 ops, opaque);
1258 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1260 SaveStateEntry *se, *new_se;
1261 char id[256] = "";
1263 if (dev) {
1264 char *path = qdev_get_dev_path(dev);
1265 if (path) {
1266 pstrcpy(id, sizeof(id), path);
1267 pstrcat(id, sizeof(id), "/");
1268 g_free(path);
1271 pstrcat(id, sizeof(id), idstr);
1273 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1274 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1275 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1276 if (se->compat) {
1277 g_free(se->compat);
1279 g_free(se->ops);
1280 g_free(se);
1285 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1286 const VMStateDescription *vmsd,
1287 void *opaque, int alias_id,
1288 int required_for_version)
1290 SaveStateEntry *se;
1292 /* If this triggers, alias support can be dropped for the vmsd. */
1293 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1295 se = g_malloc0(sizeof(SaveStateEntry));
1296 se->version_id = vmsd->version_id;
1297 se->section_id = global_section_id++;
1298 se->opaque = opaque;
1299 se->vmsd = vmsd;
1300 se->alias_id = alias_id;
1301 se->no_migrate = vmsd->unmigratable;
1303 if (dev) {
1304 char *id = qdev_get_dev_path(dev);
1305 if (id) {
1306 pstrcpy(se->idstr, sizeof(se->idstr), id);
1307 pstrcat(se->idstr, sizeof(se->idstr), "/");
1308 g_free(id);
1310 se->compat = g_malloc0(sizeof(CompatEntry));
1311 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1312 se->compat->instance_id = instance_id == -1 ?
1313 calculate_compat_instance_id(vmsd->name) : instance_id;
1314 instance_id = -1;
1317 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1319 if (instance_id == -1) {
1320 se->instance_id = calculate_new_instance_id(se->idstr);
1321 } else {
1322 se->instance_id = instance_id;
1324 assert(!se->compat || se->instance_id == 0);
1325 /* add at the end of list */
1326 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1327 return 0;
1330 int vmstate_register(DeviceState *dev, int instance_id,
1331 const VMStateDescription *vmsd, void *opaque)
1333 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1334 opaque, -1, 0);
1337 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1338 void *opaque)
1340 SaveStateEntry *se, *new_se;
1342 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1343 if (se->vmsd == vmsd && se->opaque == opaque) {
1344 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1345 if (se->compat) {
1346 g_free(se->compat);
1348 g_free(se);
1353 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1354 void *opaque);
1355 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1356 void *opaque);
1358 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1359 void *opaque, int version_id)
1361 VMStateField *field = vmsd->fields;
1362 int ret;
1364 if (version_id > vmsd->version_id) {
1365 return -EINVAL;
1367 if (version_id < vmsd->minimum_version_id_old) {
1368 return -EINVAL;
1370 if (version_id < vmsd->minimum_version_id) {
1371 return vmsd->load_state_old(f, opaque, version_id);
1373 if (vmsd->pre_load) {
1374 int ret = vmsd->pre_load(opaque);
1375 if (ret)
1376 return ret;
1378 while(field->name) {
1379 if ((field->field_exists &&
1380 field->field_exists(opaque, version_id)) ||
1381 (!field->field_exists &&
1382 field->version_id <= version_id)) {
1383 void *base_addr = opaque + field->offset;
1384 int i, n_elems = 1;
1385 int size = field->size;
1387 if (field->flags & VMS_VBUFFER) {
1388 size = *(int32_t *)(opaque+field->size_offset);
1389 if (field->flags & VMS_MULTIPLY) {
1390 size *= field->size;
1393 if (field->flags & VMS_ARRAY) {
1394 n_elems = field->num;
1395 } else if (field->flags & VMS_VARRAY_INT32) {
1396 n_elems = *(int32_t *)(opaque+field->num_offset);
1397 } else if (field->flags & VMS_VARRAY_UINT32) {
1398 n_elems = *(uint32_t *)(opaque+field->num_offset);
1399 } else if (field->flags & VMS_VARRAY_UINT16) {
1400 n_elems = *(uint16_t *)(opaque+field->num_offset);
1401 } else if (field->flags & VMS_VARRAY_UINT8) {
1402 n_elems = *(uint8_t *)(opaque+field->num_offset);
1404 if (field->flags & VMS_POINTER) {
1405 base_addr = *(void **)base_addr + field->start;
1407 for (i = 0; i < n_elems; i++) {
1408 void *addr = base_addr + size * i;
1410 if (field->flags & VMS_ARRAY_OF_POINTER) {
1411 addr = *(void **)addr;
1413 if (field->flags & VMS_STRUCT) {
1414 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1415 } else {
1416 ret = field->info->get(f, addr, size);
1419 if (ret < 0) {
1420 return ret;
1424 field++;
1426 ret = vmstate_subsection_load(f, vmsd, opaque);
1427 if (ret != 0) {
1428 return ret;
1430 if (vmsd->post_load) {
1431 return vmsd->post_load(opaque, version_id);
1433 return 0;
1436 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1437 void *opaque)
1439 VMStateField *field = vmsd->fields;
1441 if (vmsd->pre_save) {
1442 vmsd->pre_save(opaque);
1444 while(field->name) {
1445 if (!field->field_exists ||
1446 field->field_exists(opaque, vmsd->version_id)) {
1447 void *base_addr = opaque + field->offset;
1448 int i, n_elems = 1;
1449 int size = field->size;
1451 if (field->flags & VMS_VBUFFER) {
1452 size = *(int32_t *)(opaque+field->size_offset);
1453 if (field->flags & VMS_MULTIPLY) {
1454 size *= field->size;
1457 if (field->flags & VMS_ARRAY) {
1458 n_elems = field->num;
1459 } else if (field->flags & VMS_VARRAY_INT32) {
1460 n_elems = *(int32_t *)(opaque+field->num_offset);
1461 } else if (field->flags & VMS_VARRAY_UINT32) {
1462 n_elems = *(uint32_t *)(opaque+field->num_offset);
1463 } else if (field->flags & VMS_VARRAY_UINT16) {
1464 n_elems = *(uint16_t *)(opaque+field->num_offset);
1465 } else if (field->flags & VMS_VARRAY_UINT8) {
1466 n_elems = *(uint8_t *)(opaque+field->num_offset);
1468 if (field->flags & VMS_POINTER) {
1469 base_addr = *(void **)base_addr + field->start;
1471 for (i = 0; i < n_elems; i++) {
1472 void *addr = base_addr + size * i;
1474 if (field->flags & VMS_ARRAY_OF_POINTER) {
1475 addr = *(void **)addr;
1477 if (field->flags & VMS_STRUCT) {
1478 vmstate_save_state(f, field->vmsd, addr);
1479 } else {
1480 field->info->put(f, addr, size);
1484 field++;
1486 vmstate_subsection_save(f, vmsd, opaque);
1489 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1491 if (!se->vmsd) { /* Old style */
1492 return se->ops->load_state(f, se->opaque, version_id);
1494 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1497 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1499 if (!se->vmsd) { /* Old style */
1500 se->ops->save_state(f, se->opaque);
1501 return;
1503 vmstate_save_state(f,se->vmsd, se->opaque);
1506 #define QEMU_VM_FILE_MAGIC 0x5145564d
1507 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1508 #define QEMU_VM_FILE_VERSION 0x00000003
1510 #define QEMU_VM_EOF 0x00
1511 #define QEMU_VM_SECTION_START 0x01
1512 #define QEMU_VM_SECTION_PART 0x02
1513 #define QEMU_VM_SECTION_END 0x03
1514 #define QEMU_VM_SECTION_FULL 0x04
1515 #define QEMU_VM_SUBSECTION 0x05
1517 bool qemu_savevm_state_blocked(Error **errp)
1519 SaveStateEntry *se;
1521 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1522 if (se->no_migrate) {
1523 error_set(errp, QERR_MIGRATION_NOT_SUPPORTED, se->idstr);
1524 return true;
1527 return false;
1530 int qemu_savevm_state_begin(QEMUFile *f,
1531 const MigrationParams *params)
1533 SaveStateEntry *se;
1534 int ret;
1536 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1537 if (!se->ops || !se->ops->set_params) {
1538 continue;
1540 se->ops->set_params(params, 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->ops || !se->ops->save_live_setup) {
1550 continue;
1552 if (se->ops && se->ops->is_active) {
1553 if (!se->ops->is_active(se->opaque)) {
1554 continue;
1557 /* Section type */
1558 qemu_put_byte(f, QEMU_VM_SECTION_START);
1559 qemu_put_be32(f, se->section_id);
1561 /* ID string */
1562 len = strlen(se->idstr);
1563 qemu_put_byte(f, len);
1564 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1566 qemu_put_be32(f, se->instance_id);
1567 qemu_put_be32(f, se->version_id);
1569 ret = se->ops->save_live_setup(f, se->opaque);
1570 if (ret < 0) {
1571 qemu_savevm_state_cancel(f);
1572 return ret;
1575 ret = qemu_file_get_error(f);
1576 if (ret != 0) {
1577 qemu_savevm_state_cancel(f);
1580 return ret;
1585 * this function has three return values:
1586 * negative: there was one error, and we have -errno.
1587 * 0 : We haven't finished, caller have to go again
1588 * 1 : We have finished, we can go to complete phase
1590 int qemu_savevm_state_iterate(QEMUFile *f)
1592 SaveStateEntry *se;
1593 int ret = 1;
1595 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1596 if (!se->ops || !se->ops->save_live_iterate) {
1597 continue;
1599 if (se->ops && se->ops->is_active) {
1600 if (!se->ops->is_active(se->opaque)) {
1601 continue;
1604 if (qemu_file_rate_limit(f)) {
1605 return 0;
1607 trace_savevm_section_start();
1608 /* Section type */
1609 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1610 qemu_put_be32(f, se->section_id);
1612 ret = se->ops->save_live_iterate(f, se->opaque);
1613 trace_savevm_section_end(se->section_id);
1615 if (ret <= 0) {
1616 /* Do not proceed to the next vmstate before this one reported
1617 completion of the current stage. This serializes the migration
1618 and reduces the probability that a faster changing state is
1619 synchronized over and over again. */
1620 break;
1623 if (ret != 0) {
1624 return ret;
1626 ret = qemu_file_get_error(f);
1627 if (ret != 0) {
1628 qemu_savevm_state_cancel(f);
1630 return ret;
1633 int qemu_savevm_state_complete(QEMUFile *f)
1635 SaveStateEntry *se;
1636 int ret;
1638 cpu_synchronize_all_states();
1640 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1641 if (!se->ops || !se->ops->save_live_complete) {
1642 continue;
1644 if (se->ops && se->ops->is_active) {
1645 if (!se->ops->is_active(se->opaque)) {
1646 continue;
1649 trace_savevm_section_start();
1650 /* Section type */
1651 qemu_put_byte(f, QEMU_VM_SECTION_END);
1652 qemu_put_be32(f, se->section_id);
1654 ret = se->ops->save_live_complete(f, se->opaque);
1655 trace_savevm_section_end(se->section_id);
1656 if (ret < 0) {
1657 return ret;
1661 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1662 int len;
1664 if ((!se->ops || !se->ops->save_state) && !se->vmsd) {
1665 continue;
1667 trace_savevm_section_start();
1668 /* Section type */
1669 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1670 qemu_put_be32(f, se->section_id);
1672 /* ID string */
1673 len = strlen(se->idstr);
1674 qemu_put_byte(f, len);
1675 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1677 qemu_put_be32(f, se->instance_id);
1678 qemu_put_be32(f, se->version_id);
1680 vmstate_save(f, se);
1681 trace_savevm_section_end(se->section_id);
1684 qemu_put_byte(f, QEMU_VM_EOF);
1686 return qemu_file_get_error(f);
1689 void qemu_savevm_state_cancel(QEMUFile *f)
1691 SaveStateEntry *se;
1693 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1694 if (se->ops && se->ops->cancel) {
1695 se->ops->cancel(se->opaque);
1700 static int qemu_savevm_state(QEMUFile *f)
1702 int ret;
1703 MigrationParams params = {
1704 .blk = 0,
1705 .shared = 0
1708 if (qemu_savevm_state_blocked(NULL)) {
1709 ret = -EINVAL;
1710 goto out;
1713 ret = qemu_savevm_state_begin(f, &params);
1714 if (ret < 0)
1715 goto out;
1717 do {
1718 ret = qemu_savevm_state_iterate(f);
1719 if (ret < 0)
1720 goto out;
1721 } while (ret == 0);
1723 ret = qemu_savevm_state_complete(f);
1725 out:
1726 if (ret == 0) {
1727 ret = qemu_file_get_error(f);
1730 return ret;
1733 static int qemu_save_device_state(QEMUFile *f)
1735 SaveStateEntry *se;
1737 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1738 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1740 cpu_synchronize_all_states();
1742 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1743 int len;
1745 if (se->is_ram) {
1746 continue;
1748 if ((!se->ops || !se->ops->save_state) && !se->vmsd) {
1749 continue;
1752 /* Section type */
1753 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1754 qemu_put_be32(f, se->section_id);
1756 /* ID string */
1757 len = strlen(se->idstr);
1758 qemu_put_byte(f, len);
1759 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1761 qemu_put_be32(f, se->instance_id);
1762 qemu_put_be32(f, se->version_id);
1764 vmstate_save(f, se);
1767 qemu_put_byte(f, QEMU_VM_EOF);
1769 return qemu_file_get_error(f);
1772 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1774 SaveStateEntry *se;
1776 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1777 if (!strcmp(se->idstr, idstr) &&
1778 (instance_id == se->instance_id ||
1779 instance_id == se->alias_id))
1780 return se;
1781 /* Migrating from an older version? */
1782 if (strstr(se->idstr, idstr) && se->compat) {
1783 if (!strcmp(se->compat->idstr, idstr) &&
1784 (instance_id == se->compat->instance_id ||
1785 instance_id == se->alias_id))
1786 return se;
1789 return NULL;
1792 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1794 while(sub && sub->needed) {
1795 if (strcmp(idstr, sub->vmsd->name) == 0) {
1796 return sub->vmsd;
1798 sub++;
1800 return NULL;
1803 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1804 void *opaque)
1806 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1807 char idstr[256];
1808 int ret;
1809 uint8_t version_id, len, size;
1810 const VMStateDescription *sub_vmsd;
1812 len = qemu_peek_byte(f, 1);
1813 if (len < strlen(vmsd->name) + 1) {
1814 /* subsection name has be be "section_name/a" */
1815 return 0;
1817 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1818 if (size != len) {
1819 return 0;
1821 idstr[size] = 0;
1823 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1824 /* it don't have a valid subsection name */
1825 return 0;
1827 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1828 if (sub_vmsd == NULL) {
1829 return -ENOENT;
1831 qemu_file_skip(f, 1); /* subsection */
1832 qemu_file_skip(f, 1); /* len */
1833 qemu_file_skip(f, len); /* idstr */
1834 version_id = qemu_get_be32(f);
1836 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1837 if (ret) {
1838 return ret;
1841 return 0;
1844 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1845 void *opaque)
1847 const VMStateSubsection *sub = vmsd->subsections;
1849 while (sub && sub->needed) {
1850 if (sub->needed(opaque)) {
1851 const VMStateDescription *vmsd = sub->vmsd;
1852 uint8_t len;
1854 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1855 len = strlen(vmsd->name);
1856 qemu_put_byte(f, len);
1857 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1858 qemu_put_be32(f, vmsd->version_id);
1859 vmstate_save_state(f, vmsd, opaque);
1861 sub++;
1865 typedef struct LoadStateEntry {
1866 QLIST_ENTRY(LoadStateEntry) entry;
1867 SaveStateEntry *se;
1868 int section_id;
1869 int version_id;
1870 } LoadStateEntry;
1872 int qemu_loadvm_state(QEMUFile *f)
1874 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1875 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1876 LoadStateEntry *le, *new_le;
1877 uint8_t section_type;
1878 unsigned int v;
1879 int ret;
1881 if (qemu_savevm_state_blocked(NULL)) {
1882 return -EINVAL;
1885 v = qemu_get_be32(f);
1886 if (v != QEMU_VM_FILE_MAGIC)
1887 return -EINVAL;
1889 v = qemu_get_be32(f);
1890 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1891 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1892 return -ENOTSUP;
1894 if (v != QEMU_VM_FILE_VERSION)
1895 return -ENOTSUP;
1897 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1898 uint32_t instance_id, version_id, section_id;
1899 SaveStateEntry *se;
1900 char idstr[257];
1901 int len;
1903 switch (section_type) {
1904 case QEMU_VM_SECTION_START:
1905 case QEMU_VM_SECTION_FULL:
1906 /* Read section start */
1907 section_id = qemu_get_be32(f);
1908 len = qemu_get_byte(f);
1909 qemu_get_buffer(f, (uint8_t *)idstr, len);
1910 idstr[len] = 0;
1911 instance_id = qemu_get_be32(f);
1912 version_id = qemu_get_be32(f);
1914 /* Find savevm section */
1915 se = find_se(idstr, instance_id);
1916 if (se == NULL) {
1917 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1918 ret = -EINVAL;
1919 goto out;
1922 /* Validate version */
1923 if (version_id > se->version_id) {
1924 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1925 version_id, idstr, se->version_id);
1926 ret = -EINVAL;
1927 goto out;
1930 /* Add entry */
1931 le = g_malloc0(sizeof(*le));
1933 le->se = se;
1934 le->section_id = section_id;
1935 le->version_id = version_id;
1936 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1938 ret = vmstate_load(f, le->se, le->version_id);
1939 if (ret < 0) {
1940 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1941 instance_id, idstr);
1942 goto out;
1944 break;
1945 case QEMU_VM_SECTION_PART:
1946 case QEMU_VM_SECTION_END:
1947 section_id = qemu_get_be32(f);
1949 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1950 if (le->section_id == section_id) {
1951 break;
1954 if (le == NULL) {
1955 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1956 ret = -EINVAL;
1957 goto out;
1960 ret = vmstate_load(f, le->se, le->version_id);
1961 if (ret < 0) {
1962 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1963 section_id);
1964 goto out;
1966 break;
1967 default:
1968 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1969 ret = -EINVAL;
1970 goto out;
1974 cpu_synchronize_all_post_init();
1976 ret = 0;
1978 out:
1979 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1980 QLIST_REMOVE(le, entry);
1981 g_free(le);
1984 if (ret == 0) {
1985 ret = qemu_file_get_error(f);
1988 return ret;
1991 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1992 const char *name)
1994 QEMUSnapshotInfo *sn_tab, *sn;
1995 int nb_sns, i, ret;
1997 ret = -ENOENT;
1998 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1999 if (nb_sns < 0)
2000 return ret;
2001 for(i = 0; i < nb_sns; i++) {
2002 sn = &sn_tab[i];
2003 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
2004 *sn_info = *sn;
2005 ret = 0;
2006 break;
2009 g_free(sn_tab);
2010 return ret;
2014 * Deletes snapshots of a given name in all opened images.
2016 static int del_existing_snapshots(Monitor *mon, const char *name)
2018 BlockDriverState *bs;
2019 QEMUSnapshotInfo sn1, *snapshot = &sn1;
2020 int ret;
2022 bs = NULL;
2023 while ((bs = bdrv_next(bs))) {
2024 if (bdrv_can_snapshot(bs) &&
2025 bdrv_snapshot_find(bs, snapshot, name) >= 0)
2027 ret = bdrv_snapshot_delete(bs, name);
2028 if (ret < 0) {
2029 monitor_printf(mon,
2030 "Error while deleting snapshot on '%s'\n",
2031 bdrv_get_device_name(bs));
2032 return -1;
2037 return 0;
2040 void do_savevm(Monitor *mon, const QDict *qdict)
2042 BlockDriverState *bs, *bs1;
2043 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
2044 int ret;
2045 QEMUFile *f;
2046 int saved_vm_running;
2047 uint64_t vm_state_size;
2048 #ifdef _WIN32
2049 struct _timeb tb;
2050 struct tm *ptm;
2051 #else
2052 struct timeval tv;
2053 struct tm tm;
2054 #endif
2055 const char *name = qdict_get_try_str(qdict, "name");
2057 /* Verify if there is a device that doesn't support snapshots and is writable */
2058 bs = NULL;
2059 while ((bs = bdrv_next(bs))) {
2061 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2062 continue;
2065 if (!bdrv_can_snapshot(bs)) {
2066 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
2067 bdrv_get_device_name(bs));
2068 return;
2072 bs = bdrv_snapshots();
2073 if (!bs) {
2074 monitor_printf(mon, "No block device can accept snapshots\n");
2075 return;
2078 saved_vm_running = runstate_is_running();
2079 vm_stop(RUN_STATE_SAVE_VM);
2081 memset(sn, 0, sizeof(*sn));
2083 /* fill auxiliary fields */
2084 #ifdef _WIN32
2085 _ftime(&tb);
2086 sn->date_sec = tb.time;
2087 sn->date_nsec = tb.millitm * 1000000;
2088 #else
2089 gettimeofday(&tv, NULL);
2090 sn->date_sec = tv.tv_sec;
2091 sn->date_nsec = tv.tv_usec * 1000;
2092 #endif
2093 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2095 if (name) {
2096 ret = bdrv_snapshot_find(bs, old_sn, name);
2097 if (ret >= 0) {
2098 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2099 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2100 } else {
2101 pstrcpy(sn->name, sizeof(sn->name), name);
2103 } else {
2104 #ifdef _WIN32
2105 time_t t = tb.time;
2106 ptm = localtime(&t);
2107 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
2108 #else
2109 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2110 localtime_r((const time_t *)&tv.tv_sec, &tm);
2111 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2112 #endif
2115 /* Delete old snapshots of the same name */
2116 if (name && del_existing_snapshots(mon, name) < 0) {
2117 goto the_end;
2120 /* save the VM state */
2121 f = qemu_fopen_bdrv(bs, 1);
2122 if (!f) {
2123 monitor_printf(mon, "Could not open VM state file\n");
2124 goto the_end;
2126 ret = qemu_savevm_state(f);
2127 vm_state_size = qemu_ftell(f);
2128 qemu_fclose(f);
2129 if (ret < 0) {
2130 monitor_printf(mon, "Error %d while writing VM\n", ret);
2131 goto the_end;
2134 /* create the snapshots */
2136 bs1 = NULL;
2137 while ((bs1 = bdrv_next(bs1))) {
2138 if (bdrv_can_snapshot(bs1)) {
2139 /* Write VM state size only to the image that contains the state */
2140 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2141 ret = bdrv_snapshot_create(bs1, sn);
2142 if (ret < 0) {
2143 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2144 bdrv_get_device_name(bs1));
2149 the_end:
2150 if (saved_vm_running)
2151 vm_start();
2154 void qmp_xen_save_devices_state(const char *filename, Error **errp)
2156 QEMUFile *f;
2157 int saved_vm_running;
2158 int ret;
2160 saved_vm_running = runstate_is_running();
2161 vm_stop(RUN_STATE_SAVE_VM);
2163 f = qemu_fopen(filename, "wb");
2164 if (!f) {
2165 error_set(errp, QERR_OPEN_FILE_FAILED, filename);
2166 goto the_end;
2168 ret = qemu_save_device_state(f);
2169 qemu_fclose(f);
2170 if (ret < 0) {
2171 error_set(errp, QERR_IO_ERROR);
2174 the_end:
2175 if (saved_vm_running)
2176 vm_start();
2179 int load_vmstate(const char *name)
2181 BlockDriverState *bs, *bs_vm_state;
2182 QEMUSnapshotInfo sn;
2183 QEMUFile *f;
2184 int ret;
2186 bs_vm_state = bdrv_snapshots();
2187 if (!bs_vm_state) {
2188 error_report("No block device supports snapshots");
2189 return -ENOTSUP;
2192 /* Don't even try to load empty VM states */
2193 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2194 if (ret < 0) {
2195 return ret;
2196 } else if (sn.vm_state_size == 0) {
2197 error_report("This is a disk-only snapshot. Revert to it offline "
2198 "using qemu-img.");
2199 return -EINVAL;
2202 /* Verify if there is any device that doesn't support snapshots and is
2203 writable and check if the requested snapshot is available too. */
2204 bs = NULL;
2205 while ((bs = bdrv_next(bs))) {
2207 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2208 continue;
2211 if (!bdrv_can_snapshot(bs)) {
2212 error_report("Device '%s' is writable but does not support snapshots.",
2213 bdrv_get_device_name(bs));
2214 return -ENOTSUP;
2217 ret = bdrv_snapshot_find(bs, &sn, name);
2218 if (ret < 0) {
2219 error_report("Device '%s' does not have the requested snapshot '%s'",
2220 bdrv_get_device_name(bs), name);
2221 return ret;
2225 /* Flush all IO requests so they don't interfere with the new state. */
2226 bdrv_drain_all();
2228 bs = NULL;
2229 while ((bs = bdrv_next(bs))) {
2230 if (bdrv_can_snapshot(bs)) {
2231 ret = bdrv_snapshot_goto(bs, name);
2232 if (ret < 0) {
2233 error_report("Error %d while activating snapshot '%s' on '%s'",
2234 ret, name, bdrv_get_device_name(bs));
2235 return ret;
2240 /* restore the VM state */
2241 f = qemu_fopen_bdrv(bs_vm_state, 0);
2242 if (!f) {
2243 error_report("Could not open VM state file");
2244 return -EINVAL;
2247 qemu_system_reset(VMRESET_SILENT);
2248 ret = qemu_loadvm_state(f);
2250 qemu_fclose(f);
2251 if (ret < 0) {
2252 error_report("Error %d while loading VM state", ret);
2253 return ret;
2256 return 0;
2259 void do_delvm(Monitor *mon, const QDict *qdict)
2261 BlockDriverState *bs, *bs1;
2262 int ret;
2263 const char *name = qdict_get_str(qdict, "name");
2265 bs = bdrv_snapshots();
2266 if (!bs) {
2267 monitor_printf(mon, "No block device supports snapshots\n");
2268 return;
2271 bs1 = NULL;
2272 while ((bs1 = bdrv_next(bs1))) {
2273 if (bdrv_can_snapshot(bs1)) {
2274 ret = bdrv_snapshot_delete(bs1, name);
2275 if (ret < 0) {
2276 if (ret == -ENOTSUP)
2277 monitor_printf(mon,
2278 "Snapshots not supported on device '%s'\n",
2279 bdrv_get_device_name(bs1));
2280 else
2281 monitor_printf(mon, "Error %d while deleting snapshot on "
2282 "'%s'\n", ret, bdrv_get_device_name(bs1));
2288 void do_info_snapshots(Monitor *mon)
2290 BlockDriverState *bs, *bs1;
2291 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2292 int nb_sns, i, ret, available;
2293 int total;
2294 int *available_snapshots;
2295 char buf[256];
2297 bs = bdrv_snapshots();
2298 if (!bs) {
2299 monitor_printf(mon, "No available block device supports snapshots\n");
2300 return;
2303 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2304 if (nb_sns < 0) {
2305 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2306 return;
2309 if (nb_sns == 0) {
2310 monitor_printf(mon, "There is no snapshot available.\n");
2311 return;
2314 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2315 total = 0;
2316 for (i = 0; i < nb_sns; i++) {
2317 sn = &sn_tab[i];
2318 available = 1;
2319 bs1 = NULL;
2321 while ((bs1 = bdrv_next(bs1))) {
2322 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2323 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2324 if (ret < 0) {
2325 available = 0;
2326 break;
2331 if (available) {
2332 available_snapshots[total] = i;
2333 total++;
2337 if (total > 0) {
2338 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2339 for (i = 0; i < total; i++) {
2340 sn = &sn_tab[available_snapshots[i]];
2341 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2343 } else {
2344 monitor_printf(mon, "There is no suitable snapshot available\n");
2347 g_free(sn_tab);
2348 g_free(available_snapshots);
2352 void vmstate_register_ram(MemoryRegion *mr, DeviceState *dev)
2354 qemu_ram_set_idstr(memory_region_get_ram_addr(mr) & TARGET_PAGE_MASK,
2355 memory_region_name(mr), dev);
2358 void vmstate_unregister_ram(MemoryRegion *mr, DeviceState *dev)
2360 /* Nothing do to while the implementation is in RAMBlock */
2363 void vmstate_register_ram_global(MemoryRegion *mr)
2365 vmstate_register_ram(mr, NULL);
2369 page = zrun nzrun
2370 | zrun nzrun page
2372 zrun = length
2374 nzrun = length byte...
2376 length = uleb128 encoded integer
2378 int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen,
2379 uint8_t *dst, int dlen)
2381 uint32_t zrun_len = 0, nzrun_len = 0;
2382 int d = 0, i = 0;
2383 long res, xor;
2384 uint8_t *nzrun_start = NULL;
2386 g_assert(!(((uintptr_t)old_buf | (uintptr_t)new_buf | slen) %
2387 sizeof(long)));
2389 while (i < slen) {
2390 /* overflow */
2391 if (d + 2 > dlen) {
2392 return -1;
2395 /* not aligned to sizeof(long) */
2396 res = (slen - i) % sizeof(long);
2397 while (res && old_buf[i] == new_buf[i]) {
2398 zrun_len++;
2399 i++;
2400 res--;
2403 /* word at a time for speed */
2404 if (!res) {
2405 while (i < slen &&
2406 (*(long *)(old_buf + i)) == (*(long *)(new_buf + i))) {
2407 i += sizeof(long);
2408 zrun_len += sizeof(long);
2411 /* go over the rest */
2412 while (i < slen && old_buf[i] == new_buf[i]) {
2413 zrun_len++;
2414 i++;
2418 /* buffer unchanged */
2419 if (zrun_len == slen) {
2420 return 0;
2423 /* skip last zero run */
2424 if (i == slen) {
2425 return d;
2428 d += uleb128_encode_small(dst + d, zrun_len);
2430 zrun_len = 0;
2431 nzrun_start = new_buf + i;
2433 /* overflow */
2434 if (d + 2 > dlen) {
2435 return -1;
2437 /* not aligned to sizeof(long) */
2438 res = (slen - i) % sizeof(long);
2439 while (res && old_buf[i] != new_buf[i]) {
2440 i++;
2441 nzrun_len++;
2442 res--;
2445 /* word at a time for speed, use of 32-bit long okay */
2446 if (!res) {
2447 /* truncation to 32-bit long okay */
2448 long mask = (long)0x0101010101010101ULL;
2449 while (i < slen) {
2450 xor = *(long *)(old_buf + i) ^ *(long *)(new_buf + i);
2451 if ((xor - mask) & ~xor & (mask << 7)) {
2452 /* found the end of an nzrun within the current long */
2453 while (old_buf[i] != new_buf[i]) {
2454 nzrun_len++;
2455 i++;
2457 break;
2458 } else {
2459 i += sizeof(long);
2460 nzrun_len += sizeof(long);
2465 d += uleb128_encode_small(dst + d, nzrun_len);
2466 /* overflow */
2467 if (d + nzrun_len > dlen) {
2468 return -1;
2470 memcpy(dst + d, nzrun_start, nzrun_len);
2471 d += nzrun_len;
2472 nzrun_len = 0;
2475 return d;
2478 int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen)
2480 int i = 0, d = 0;
2481 int ret;
2482 uint32_t count = 0;
2484 while (i < slen) {
2486 /* zrun */
2487 if ((slen - i) < 2) {
2488 return -1;
2491 ret = uleb128_decode_small(src + i, &count);
2492 if (ret < 0 || (i && !count)) {
2493 return -1;
2495 i += ret;
2496 d += count;
2498 /* overflow */
2499 if (d > dlen) {
2500 return -1;
2503 /* nzrun */
2504 if ((slen - i) < 2) {
2505 return -1;
2508 ret = uleb128_decode_small(src + i, &count);
2509 if (ret < 0 || !count) {
2510 return -1;
2512 i += ret;
2514 /* overflow */
2515 if (d + count > dlen || i + count > slen) {
2516 return -1;
2519 memcpy(dst + d, src + i, count);
2520 d += count;
2521 i += count;
2524 return d;