Merge remote-tracking branch 'stefanha/trivial-patches' into staging
[qemu.git] / savevm.c
bloba15c163b6eac385051417378931a8906b4bd0994
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 void qemu_file_set_error(QEMUFile *f, int ret)
445 f->last_error = ret;
448 /** Sets last_error conditionally
450 * Sets last_error only if ret is negative _and_ no error
451 * was set before.
453 static void qemu_file_set_if_error(QEMUFile *f, int ret)
455 if (ret < 0 && !f->last_error) {
456 qemu_file_set_error(f, ret);
460 /** Flushes QEMUFile buffer
462 * In case of error, last_error is set.
464 void qemu_fflush(QEMUFile *f)
466 if (!f->put_buffer)
467 return;
469 if (f->is_write && f->buf_index > 0) {
470 int len;
472 len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
473 if (len > 0)
474 f->buf_offset += f->buf_index;
475 else
476 qemu_file_set_error(f, -EINVAL);
477 f->buf_index = 0;
481 static void qemu_fill_buffer(QEMUFile *f)
483 int len;
484 int pending;
486 if (!f->get_buffer)
487 return;
489 if (f->is_write)
490 abort();
492 pending = f->buf_size - f->buf_index;
493 if (pending > 0) {
494 memmove(f->buf, f->buf + f->buf_index, pending);
496 f->buf_index = 0;
497 f->buf_size = pending;
499 len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
500 IO_BUF_SIZE - pending);
501 if (len > 0) {
502 f->buf_size += len;
503 f->buf_offset += len;
504 } else if (len == 0) {
505 f->last_error = -EIO;
506 } else if (len != -EAGAIN)
507 qemu_file_set_error(f, len);
510 /** Calls close function and set last_error if needed
512 * Internal function. qemu_fflush() must be called before this.
514 * Returns f->close() return value, or 0 if close function is not set.
516 static int qemu_close(QEMUFile *f)
518 int ret = 0;
519 if (f->close) {
520 ret = f->close(f->opaque);
521 qemu_file_set_if_error(f, ret);
523 return ret;
526 /** Closes the file
528 * Returns negative error value if any error happened on previous operations or
529 * while closing the file. Returns 0 or positive number on success.
531 * The meaning of return value on success depends on the specific backend
532 * being used.
534 int qemu_fclose(QEMUFile *f)
536 int ret;
537 qemu_fflush(f);
538 ret = qemu_close(f);
539 /* If any error was spotted before closing, we should report it
540 * instead of the close() return value.
542 if (f->last_error) {
543 ret = f->last_error;
545 g_free(f);
546 return ret;
549 void qemu_file_put_notify(QEMUFile *f)
551 f->put_buffer(f->opaque, NULL, 0, 0);
554 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
556 int l;
558 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
559 fprintf(stderr,
560 "Attempted to write to buffer while read buffer is not empty\n");
561 abort();
564 while (!f->last_error && size > 0) {
565 l = IO_BUF_SIZE - f->buf_index;
566 if (l > size)
567 l = size;
568 memcpy(f->buf + f->buf_index, buf, l);
569 f->is_write = 1;
570 f->buf_index += l;
571 buf += l;
572 size -= l;
573 if (f->buf_index >= IO_BUF_SIZE)
574 qemu_fflush(f);
578 void qemu_put_byte(QEMUFile *f, int v)
580 if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
581 fprintf(stderr,
582 "Attempted to write to buffer while read buffer is not empty\n");
583 abort();
586 f->buf[f->buf_index++] = v;
587 f->is_write = 1;
588 if (f->buf_index >= IO_BUF_SIZE)
589 qemu_fflush(f);
592 static void qemu_file_skip(QEMUFile *f, int size)
594 if (f->buf_index + size <= f->buf_size) {
595 f->buf_index += size;
599 static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
601 int pending;
602 int index;
604 if (f->is_write) {
605 abort();
608 index = f->buf_index + offset;
609 pending = f->buf_size - index;
610 if (pending < size) {
611 qemu_fill_buffer(f);
612 index = f->buf_index + offset;
613 pending = f->buf_size - index;
616 if (pending <= 0) {
617 return 0;
619 if (size > pending) {
620 size = pending;
623 memcpy(buf, f->buf + index, size);
624 return size;
627 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
629 int pending = size;
630 int done = 0;
632 while (pending > 0) {
633 int res;
635 res = qemu_peek_buffer(f, buf, pending, 0);
636 if (res == 0) {
637 return done;
639 qemu_file_skip(f, res);
640 buf += res;
641 pending -= res;
642 done += res;
644 return done;
647 static int qemu_peek_byte(QEMUFile *f, int offset)
649 int index = f->buf_index + offset;
651 if (f->is_write) {
652 abort();
655 if (index >= f->buf_size) {
656 qemu_fill_buffer(f);
657 index = f->buf_index + offset;
658 if (index >= f->buf_size) {
659 return 0;
662 return f->buf[index];
665 int qemu_get_byte(QEMUFile *f)
667 int result;
669 result = qemu_peek_byte(f, 0);
670 qemu_file_skip(f, 1);
671 return result;
674 int64_t qemu_ftell(QEMUFile *f)
676 return f->buf_offset - f->buf_size + f->buf_index;
679 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
681 if (whence == SEEK_SET) {
682 /* nothing to do */
683 } else if (whence == SEEK_CUR) {
684 pos += qemu_ftell(f);
685 } else {
686 /* SEEK_END not supported */
687 return -1;
689 if (f->put_buffer) {
690 qemu_fflush(f);
691 f->buf_offset = pos;
692 } else {
693 f->buf_offset = pos;
694 f->buf_index = 0;
695 f->buf_size = 0;
697 return pos;
700 int qemu_file_rate_limit(QEMUFile *f)
702 if (f->rate_limit)
703 return f->rate_limit(f->opaque);
705 return 0;
708 int64_t qemu_file_get_rate_limit(QEMUFile *f)
710 if (f->get_rate_limit)
711 return f->get_rate_limit(f->opaque);
713 return 0;
716 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
718 /* any failed or completed migration keeps its state to allow probing of
719 * migration data, but has no associated file anymore */
720 if (f && f->set_rate_limit)
721 return f->set_rate_limit(f->opaque, new_rate);
723 return 0;
726 void qemu_put_be16(QEMUFile *f, unsigned int v)
728 qemu_put_byte(f, v >> 8);
729 qemu_put_byte(f, v);
732 void qemu_put_be32(QEMUFile *f, unsigned int v)
734 qemu_put_byte(f, v >> 24);
735 qemu_put_byte(f, v >> 16);
736 qemu_put_byte(f, v >> 8);
737 qemu_put_byte(f, v);
740 void qemu_put_be64(QEMUFile *f, uint64_t v)
742 qemu_put_be32(f, v >> 32);
743 qemu_put_be32(f, v);
746 unsigned int qemu_get_be16(QEMUFile *f)
748 unsigned int v;
749 v = qemu_get_byte(f) << 8;
750 v |= qemu_get_byte(f);
751 return v;
754 unsigned int qemu_get_be32(QEMUFile *f)
756 unsigned int v;
757 v = qemu_get_byte(f) << 24;
758 v |= qemu_get_byte(f) << 16;
759 v |= qemu_get_byte(f) << 8;
760 v |= qemu_get_byte(f);
761 return v;
764 uint64_t qemu_get_be64(QEMUFile *f)
766 uint64_t v;
767 v = (uint64_t)qemu_get_be32(f) << 32;
768 v |= qemu_get_be32(f);
769 return v;
773 /* timer */
775 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
777 uint64_t expire_time;
779 expire_time = qemu_timer_expire_time_ns(ts);
780 qemu_put_be64(f, expire_time);
783 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
785 uint64_t expire_time;
787 expire_time = qemu_get_be64(f);
788 if (expire_time != -1) {
789 qemu_mod_timer_ns(ts, expire_time);
790 } else {
791 qemu_del_timer(ts);
796 /* bool */
798 static int get_bool(QEMUFile *f, void *pv, size_t size)
800 bool *v = pv;
801 *v = qemu_get_byte(f);
802 return 0;
805 static void put_bool(QEMUFile *f, void *pv, size_t size)
807 bool *v = pv;
808 qemu_put_byte(f, *v);
811 const VMStateInfo vmstate_info_bool = {
812 .name = "bool",
813 .get = get_bool,
814 .put = put_bool,
817 /* 8 bit int */
819 static int get_int8(QEMUFile *f, void *pv, size_t size)
821 int8_t *v = pv;
822 qemu_get_s8s(f, v);
823 return 0;
826 static void put_int8(QEMUFile *f, void *pv, size_t size)
828 int8_t *v = pv;
829 qemu_put_s8s(f, v);
832 const VMStateInfo vmstate_info_int8 = {
833 .name = "int8",
834 .get = get_int8,
835 .put = put_int8,
838 /* 16 bit int */
840 static int get_int16(QEMUFile *f, void *pv, size_t size)
842 int16_t *v = pv;
843 qemu_get_sbe16s(f, v);
844 return 0;
847 static void put_int16(QEMUFile *f, void *pv, size_t size)
849 int16_t *v = pv;
850 qemu_put_sbe16s(f, v);
853 const VMStateInfo vmstate_info_int16 = {
854 .name = "int16",
855 .get = get_int16,
856 .put = put_int16,
859 /* 32 bit int */
861 static int get_int32(QEMUFile *f, void *pv, size_t size)
863 int32_t *v = pv;
864 qemu_get_sbe32s(f, v);
865 return 0;
868 static void put_int32(QEMUFile *f, void *pv, size_t size)
870 int32_t *v = pv;
871 qemu_put_sbe32s(f, v);
874 const VMStateInfo vmstate_info_int32 = {
875 .name = "int32",
876 .get = get_int32,
877 .put = put_int32,
880 /* 32 bit int. See that the received value is the same than the one
881 in the field */
883 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
885 int32_t *v = pv;
886 int32_t v2;
887 qemu_get_sbe32s(f, &v2);
889 if (*v == v2)
890 return 0;
891 return -EINVAL;
894 const VMStateInfo vmstate_info_int32_equal = {
895 .name = "int32 equal",
896 .get = get_int32_equal,
897 .put = put_int32,
900 /* 32 bit int. See that the received value is the less or the same
901 than the one in the field */
903 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
905 int32_t *old = pv;
906 int32_t new;
907 qemu_get_sbe32s(f, &new);
909 if (*old <= new)
910 return 0;
911 return -EINVAL;
914 const VMStateInfo vmstate_info_int32_le = {
915 .name = "int32 equal",
916 .get = get_int32_le,
917 .put = put_int32,
920 /* 64 bit int */
922 static int get_int64(QEMUFile *f, void *pv, size_t size)
924 int64_t *v = pv;
925 qemu_get_sbe64s(f, v);
926 return 0;
929 static void put_int64(QEMUFile *f, void *pv, size_t size)
931 int64_t *v = pv;
932 qemu_put_sbe64s(f, v);
935 const VMStateInfo vmstate_info_int64 = {
936 .name = "int64",
937 .get = get_int64,
938 .put = put_int64,
941 /* 8 bit unsigned int */
943 static int get_uint8(QEMUFile *f, void *pv, size_t size)
945 uint8_t *v = pv;
946 qemu_get_8s(f, v);
947 return 0;
950 static void put_uint8(QEMUFile *f, void *pv, size_t size)
952 uint8_t *v = pv;
953 qemu_put_8s(f, v);
956 const VMStateInfo vmstate_info_uint8 = {
957 .name = "uint8",
958 .get = get_uint8,
959 .put = put_uint8,
962 /* 16 bit unsigned int */
964 static int get_uint16(QEMUFile *f, void *pv, size_t size)
966 uint16_t *v = pv;
967 qemu_get_be16s(f, v);
968 return 0;
971 static void put_uint16(QEMUFile *f, void *pv, size_t size)
973 uint16_t *v = pv;
974 qemu_put_be16s(f, v);
977 const VMStateInfo vmstate_info_uint16 = {
978 .name = "uint16",
979 .get = get_uint16,
980 .put = put_uint16,
983 /* 32 bit unsigned int */
985 static int get_uint32(QEMUFile *f, void *pv, size_t size)
987 uint32_t *v = pv;
988 qemu_get_be32s(f, v);
989 return 0;
992 static void put_uint32(QEMUFile *f, void *pv, size_t size)
994 uint32_t *v = pv;
995 qemu_put_be32s(f, v);
998 const VMStateInfo vmstate_info_uint32 = {
999 .name = "uint32",
1000 .get = get_uint32,
1001 .put = put_uint32,
1004 /* 32 bit uint. See that the received value is the same than the one
1005 in the field */
1007 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
1009 uint32_t *v = pv;
1010 uint32_t v2;
1011 qemu_get_be32s(f, &v2);
1013 if (*v == v2) {
1014 return 0;
1016 return -EINVAL;
1019 const VMStateInfo vmstate_info_uint32_equal = {
1020 .name = "uint32 equal",
1021 .get = get_uint32_equal,
1022 .put = put_uint32,
1025 /* 64 bit unsigned int */
1027 static int get_uint64(QEMUFile *f, void *pv, size_t size)
1029 uint64_t *v = pv;
1030 qemu_get_be64s(f, v);
1031 return 0;
1034 static void put_uint64(QEMUFile *f, void *pv, size_t size)
1036 uint64_t *v = pv;
1037 qemu_put_be64s(f, v);
1040 const VMStateInfo vmstate_info_uint64 = {
1041 .name = "uint64",
1042 .get = get_uint64,
1043 .put = put_uint64,
1046 /* 8 bit int. See that the received value is the same than the one
1047 in the field */
1049 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
1051 uint8_t *v = pv;
1052 uint8_t v2;
1053 qemu_get_8s(f, &v2);
1055 if (*v == v2)
1056 return 0;
1057 return -EINVAL;
1060 const VMStateInfo vmstate_info_uint8_equal = {
1061 .name = "uint8 equal",
1062 .get = get_uint8_equal,
1063 .put = put_uint8,
1066 /* 16 bit unsigned int int. See that the received value is the same than the one
1067 in the field */
1069 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
1071 uint16_t *v = pv;
1072 uint16_t v2;
1073 qemu_get_be16s(f, &v2);
1075 if (*v == v2)
1076 return 0;
1077 return -EINVAL;
1080 const VMStateInfo vmstate_info_uint16_equal = {
1081 .name = "uint16 equal",
1082 .get = get_uint16_equal,
1083 .put = put_uint16,
1086 /* timers */
1088 static int get_timer(QEMUFile *f, void *pv, size_t size)
1090 QEMUTimer *v = pv;
1091 qemu_get_timer(f, v);
1092 return 0;
1095 static void put_timer(QEMUFile *f, void *pv, size_t size)
1097 QEMUTimer *v = pv;
1098 qemu_put_timer(f, v);
1101 const VMStateInfo vmstate_info_timer = {
1102 .name = "timer",
1103 .get = get_timer,
1104 .put = put_timer,
1107 /* uint8_t buffers */
1109 static int get_buffer(QEMUFile *f, void *pv, size_t size)
1111 uint8_t *v = pv;
1112 qemu_get_buffer(f, v, size);
1113 return 0;
1116 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1118 uint8_t *v = pv;
1119 qemu_put_buffer(f, v, size);
1122 const VMStateInfo vmstate_info_buffer = {
1123 .name = "buffer",
1124 .get = get_buffer,
1125 .put = put_buffer,
1128 /* unused buffers: space that was used for some fields that are
1129 not useful anymore */
1131 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1133 uint8_t buf[1024];
1134 int block_len;
1136 while (size > 0) {
1137 block_len = MIN(sizeof(buf), size);
1138 size -= block_len;
1139 qemu_get_buffer(f, buf, block_len);
1141 return 0;
1144 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1146 static const uint8_t buf[1024];
1147 int block_len;
1149 while (size > 0) {
1150 block_len = MIN(sizeof(buf), size);
1151 size -= block_len;
1152 qemu_put_buffer(f, buf, block_len);
1156 const VMStateInfo vmstate_info_unused_buffer = {
1157 .name = "unused_buffer",
1158 .get = get_unused_buffer,
1159 .put = put_unused_buffer,
1162 typedef struct CompatEntry {
1163 char idstr[256];
1164 int instance_id;
1165 } CompatEntry;
1167 typedef struct SaveStateEntry {
1168 QTAILQ_ENTRY(SaveStateEntry) entry;
1169 char idstr[256];
1170 int instance_id;
1171 int alias_id;
1172 int version_id;
1173 int section_id;
1174 SaveSetParamsHandler *set_params;
1175 SaveLiveStateHandler *save_live_state;
1176 SaveStateHandler *save_state;
1177 LoadStateHandler *load_state;
1178 const VMStateDescription *vmsd;
1179 void *opaque;
1180 CompatEntry *compat;
1181 int no_migrate;
1182 int is_ram;
1183 } SaveStateEntry;
1186 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1187 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1188 static int global_section_id;
1190 static int calculate_new_instance_id(const char *idstr)
1192 SaveStateEntry *se;
1193 int instance_id = 0;
1195 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1196 if (strcmp(idstr, se->idstr) == 0
1197 && instance_id <= se->instance_id) {
1198 instance_id = se->instance_id + 1;
1201 return instance_id;
1204 static int calculate_compat_instance_id(const char *idstr)
1206 SaveStateEntry *se;
1207 int instance_id = 0;
1209 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1210 if (!se->compat)
1211 continue;
1213 if (strcmp(idstr, se->compat->idstr) == 0
1214 && instance_id <= se->compat->instance_id) {
1215 instance_id = se->compat->instance_id + 1;
1218 return instance_id;
1221 /* TODO: Individual devices generally have very little idea about the rest
1222 of the system, so instance_id should be removed/replaced.
1223 Meanwhile pass -1 as instance_id if you do not already have a clearly
1224 distinguishing id for all instances of your device class. */
1225 int register_savevm_live(DeviceState *dev,
1226 const char *idstr,
1227 int instance_id,
1228 int version_id,
1229 SaveSetParamsHandler *set_params,
1230 SaveLiveStateHandler *save_live_state,
1231 SaveStateHandler *save_state,
1232 LoadStateHandler *load_state,
1233 void *opaque)
1235 SaveStateEntry *se;
1237 se = g_malloc0(sizeof(SaveStateEntry));
1238 se->version_id = version_id;
1239 se->section_id = global_section_id++;
1240 se->set_params = set_params;
1241 se->save_live_state = save_live_state;
1242 se->save_state = save_state;
1243 se->load_state = load_state;
1244 se->opaque = opaque;
1245 se->vmsd = NULL;
1246 se->no_migrate = 0;
1247 /* if this is a live_savem then set is_ram */
1248 if (save_live_state != NULL) {
1249 se->is_ram = 1;
1252 if (dev) {
1253 char *id = qdev_get_dev_path(dev);
1254 if (id) {
1255 pstrcpy(se->idstr, sizeof(se->idstr), id);
1256 pstrcat(se->idstr, sizeof(se->idstr), "/");
1257 g_free(id);
1259 se->compat = g_malloc0(sizeof(CompatEntry));
1260 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1261 se->compat->instance_id = instance_id == -1 ?
1262 calculate_compat_instance_id(idstr) : instance_id;
1263 instance_id = -1;
1266 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1268 if (instance_id == -1) {
1269 se->instance_id = calculate_new_instance_id(se->idstr);
1270 } else {
1271 se->instance_id = instance_id;
1273 assert(!se->compat || se->instance_id == 0);
1274 /* add at the end of list */
1275 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1276 return 0;
1279 int register_savevm(DeviceState *dev,
1280 const char *idstr,
1281 int instance_id,
1282 int version_id,
1283 SaveStateHandler *save_state,
1284 LoadStateHandler *load_state,
1285 void *opaque)
1287 return register_savevm_live(dev, idstr, instance_id, version_id,
1288 NULL, NULL, save_state, load_state, opaque);
1291 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1293 SaveStateEntry *se, *new_se;
1294 char id[256] = "";
1296 if (dev) {
1297 char *path = qdev_get_dev_path(dev);
1298 if (path) {
1299 pstrcpy(id, sizeof(id), path);
1300 pstrcat(id, sizeof(id), "/");
1301 g_free(path);
1304 pstrcat(id, sizeof(id), idstr);
1306 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1307 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1308 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1309 if (se->compat) {
1310 g_free(se->compat);
1312 g_free(se);
1317 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1318 const VMStateDescription *vmsd,
1319 void *opaque, int alias_id,
1320 int required_for_version)
1322 SaveStateEntry *se;
1324 /* If this triggers, alias support can be dropped for the vmsd. */
1325 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1327 se = g_malloc0(sizeof(SaveStateEntry));
1328 se->version_id = vmsd->version_id;
1329 se->section_id = global_section_id++;
1330 se->save_live_state = NULL;
1331 se->save_state = NULL;
1332 se->load_state = NULL;
1333 se->opaque = opaque;
1334 se->vmsd = vmsd;
1335 se->alias_id = alias_id;
1336 se->no_migrate = vmsd->unmigratable;
1338 if (dev) {
1339 char *id = qdev_get_dev_path(dev);
1340 if (id) {
1341 pstrcpy(se->idstr, sizeof(se->idstr), id);
1342 pstrcat(se->idstr, sizeof(se->idstr), "/");
1343 g_free(id);
1345 se->compat = g_malloc0(sizeof(CompatEntry));
1346 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1347 se->compat->instance_id = instance_id == -1 ?
1348 calculate_compat_instance_id(vmsd->name) : instance_id;
1349 instance_id = -1;
1352 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1354 if (instance_id == -1) {
1355 se->instance_id = calculate_new_instance_id(se->idstr);
1356 } else {
1357 se->instance_id = instance_id;
1359 assert(!se->compat || se->instance_id == 0);
1360 /* add at the end of list */
1361 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1362 return 0;
1365 int vmstate_register(DeviceState *dev, int instance_id,
1366 const VMStateDescription *vmsd, void *opaque)
1368 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1369 opaque, -1, 0);
1372 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1373 void *opaque)
1375 SaveStateEntry *se, *new_se;
1377 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1378 if (se->vmsd == vmsd && se->opaque == opaque) {
1379 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1380 if (se->compat) {
1381 g_free(se->compat);
1383 g_free(se);
1388 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1389 void *opaque);
1390 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1391 void *opaque);
1393 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1394 void *opaque, int version_id)
1396 VMStateField *field = vmsd->fields;
1397 int ret;
1399 if (version_id > vmsd->version_id) {
1400 return -EINVAL;
1402 if (version_id < vmsd->minimum_version_id_old) {
1403 return -EINVAL;
1405 if (version_id < vmsd->minimum_version_id) {
1406 return vmsd->load_state_old(f, opaque, version_id);
1408 if (vmsd->pre_load) {
1409 int ret = vmsd->pre_load(opaque);
1410 if (ret)
1411 return ret;
1413 while(field->name) {
1414 if ((field->field_exists &&
1415 field->field_exists(opaque, version_id)) ||
1416 (!field->field_exists &&
1417 field->version_id <= version_id)) {
1418 void *base_addr = opaque + field->offset;
1419 int i, n_elems = 1;
1420 int size = field->size;
1422 if (field->flags & VMS_VBUFFER) {
1423 size = *(int32_t *)(opaque+field->size_offset);
1424 if (field->flags & VMS_MULTIPLY) {
1425 size *= field->size;
1428 if (field->flags & VMS_ARRAY) {
1429 n_elems = field->num;
1430 } else if (field->flags & VMS_VARRAY_INT32) {
1431 n_elems = *(int32_t *)(opaque+field->num_offset);
1432 } else if (field->flags & VMS_VARRAY_UINT32) {
1433 n_elems = *(uint32_t *)(opaque+field->num_offset);
1434 } else if (field->flags & VMS_VARRAY_UINT16) {
1435 n_elems = *(uint16_t *)(opaque+field->num_offset);
1436 } else if (field->flags & VMS_VARRAY_UINT8) {
1437 n_elems = *(uint8_t *)(opaque+field->num_offset);
1439 if (field->flags & VMS_POINTER) {
1440 base_addr = *(void **)base_addr + field->start;
1442 for (i = 0; i < n_elems; i++) {
1443 void *addr = base_addr + size * i;
1445 if (field->flags & VMS_ARRAY_OF_POINTER) {
1446 addr = *(void **)addr;
1448 if (field->flags & VMS_STRUCT) {
1449 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1450 } else {
1451 ret = field->info->get(f, addr, size);
1454 if (ret < 0) {
1455 return ret;
1459 field++;
1461 ret = vmstate_subsection_load(f, vmsd, opaque);
1462 if (ret != 0) {
1463 return ret;
1465 if (vmsd->post_load) {
1466 return vmsd->post_load(opaque, version_id);
1468 return 0;
1471 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1472 void *opaque)
1474 VMStateField *field = vmsd->fields;
1476 if (vmsd->pre_save) {
1477 vmsd->pre_save(opaque);
1479 while(field->name) {
1480 if (!field->field_exists ||
1481 field->field_exists(opaque, vmsd->version_id)) {
1482 void *base_addr = opaque + field->offset;
1483 int i, n_elems = 1;
1484 int size = field->size;
1486 if (field->flags & VMS_VBUFFER) {
1487 size = *(int32_t *)(opaque+field->size_offset);
1488 if (field->flags & VMS_MULTIPLY) {
1489 size *= field->size;
1492 if (field->flags & VMS_ARRAY) {
1493 n_elems = field->num;
1494 } else if (field->flags & VMS_VARRAY_INT32) {
1495 n_elems = *(int32_t *)(opaque+field->num_offset);
1496 } else if (field->flags & VMS_VARRAY_UINT32) {
1497 n_elems = *(uint32_t *)(opaque+field->num_offset);
1498 } else if (field->flags & VMS_VARRAY_UINT16) {
1499 n_elems = *(uint16_t *)(opaque+field->num_offset);
1500 } else if (field->flags & VMS_VARRAY_UINT8) {
1501 n_elems = *(uint8_t *)(opaque+field->num_offset);
1503 if (field->flags & VMS_POINTER) {
1504 base_addr = *(void **)base_addr + field->start;
1506 for (i = 0; i < n_elems; i++) {
1507 void *addr = base_addr + size * i;
1509 if (field->flags & VMS_ARRAY_OF_POINTER) {
1510 addr = *(void **)addr;
1512 if (field->flags & VMS_STRUCT) {
1513 vmstate_save_state(f, field->vmsd, addr);
1514 } else {
1515 field->info->put(f, addr, size);
1519 field++;
1521 vmstate_subsection_save(f, vmsd, opaque);
1524 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1526 if (!se->vmsd) { /* Old style */
1527 return se->load_state(f, se->opaque, version_id);
1529 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1532 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1534 if (!se->vmsd) { /* Old style */
1535 se->save_state(f, se->opaque);
1536 return;
1538 vmstate_save_state(f,se->vmsd, se->opaque);
1541 #define QEMU_VM_FILE_MAGIC 0x5145564d
1542 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1543 #define QEMU_VM_FILE_VERSION 0x00000003
1545 #define QEMU_VM_EOF 0x00
1546 #define QEMU_VM_SECTION_START 0x01
1547 #define QEMU_VM_SECTION_PART 0x02
1548 #define QEMU_VM_SECTION_END 0x03
1549 #define QEMU_VM_SECTION_FULL 0x04
1550 #define QEMU_VM_SUBSECTION 0x05
1552 bool qemu_savevm_state_blocked(Error **errp)
1554 SaveStateEntry *se;
1556 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1557 if (se->no_migrate) {
1558 error_set(errp, QERR_MIGRATION_NOT_SUPPORTED, se->idstr);
1559 return true;
1562 return false;
1565 int qemu_savevm_state_begin(QEMUFile *f,
1566 const MigrationParams *params)
1568 SaveStateEntry *se;
1569 int ret;
1571 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1572 if(se->set_params == NULL) {
1573 continue;
1575 se->set_params(params, se->opaque);
1578 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1579 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1581 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1582 int len;
1584 if (se->save_live_state == NULL)
1585 continue;
1587 /* Section type */
1588 qemu_put_byte(f, QEMU_VM_SECTION_START);
1589 qemu_put_be32(f, se->section_id);
1591 /* ID string */
1592 len = strlen(se->idstr);
1593 qemu_put_byte(f, len);
1594 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1596 qemu_put_be32(f, se->instance_id);
1597 qemu_put_be32(f, se->version_id);
1599 ret = se->save_live_state(f, QEMU_VM_SECTION_START, se->opaque);
1600 if (ret < 0) {
1601 qemu_savevm_state_cancel(f);
1602 return ret;
1605 ret = qemu_file_get_error(f);
1606 if (ret != 0) {
1607 qemu_savevm_state_cancel(f);
1610 return ret;
1615 * this function has three return values:
1616 * negative: there was one error, and we have -errno.
1617 * 0 : We haven't finished, caller have to go again
1618 * 1 : We have finished, we can go to complete phase
1620 int qemu_savevm_state_iterate(QEMUFile *f)
1622 SaveStateEntry *se;
1623 int ret = 1;
1625 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1626 if (se->save_live_state == NULL)
1627 continue;
1629 if (qemu_file_rate_limit(f)) {
1630 return 0;
1632 trace_savevm_section_start();
1633 /* Section type */
1634 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1635 qemu_put_be32(f, se->section_id);
1637 ret = se->save_live_state(f, QEMU_VM_SECTION_PART, se->opaque);
1638 trace_savevm_section_end(se->section_id);
1640 if (ret <= 0) {
1641 /* Do not proceed to the next vmstate before this one reported
1642 completion of the current stage. This serializes the migration
1643 and reduces the probability that a faster changing state is
1644 synchronized over and over again. */
1645 break;
1648 if (ret != 0) {
1649 return ret;
1651 ret = qemu_file_get_error(f);
1652 if (ret != 0) {
1653 qemu_savevm_state_cancel(f);
1655 return ret;
1658 int qemu_savevm_state_complete(QEMUFile *f)
1660 SaveStateEntry *se;
1661 int ret;
1663 cpu_synchronize_all_states();
1665 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1666 if (se->save_live_state == NULL)
1667 continue;
1669 trace_savevm_section_start();
1670 /* Section type */
1671 qemu_put_byte(f, QEMU_VM_SECTION_END);
1672 qemu_put_be32(f, se->section_id);
1674 ret = se->save_live_state(f, QEMU_VM_SECTION_END, se->opaque);
1675 trace_savevm_section_end(se->section_id);
1676 if (ret < 0) {
1677 return ret;
1681 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1682 int len;
1684 if (se->save_state == NULL && se->vmsd == NULL)
1685 continue;
1687 trace_savevm_section_start();
1688 /* Section type */
1689 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1690 qemu_put_be32(f, se->section_id);
1692 /* ID string */
1693 len = strlen(se->idstr);
1694 qemu_put_byte(f, len);
1695 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1697 qemu_put_be32(f, se->instance_id);
1698 qemu_put_be32(f, se->version_id);
1700 vmstate_save(f, se);
1701 trace_savevm_section_end(se->section_id);
1704 qemu_put_byte(f, QEMU_VM_EOF);
1706 return qemu_file_get_error(f);
1709 void qemu_savevm_state_cancel(QEMUFile *f)
1711 SaveStateEntry *se;
1713 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1714 if (se->save_live_state) {
1715 se->save_live_state(f, -1, se->opaque);
1720 static int qemu_savevm_state(QEMUFile *f)
1722 int ret;
1723 MigrationParams params = {
1724 .blk = 0,
1725 .shared = 0
1728 if (qemu_savevm_state_blocked(NULL)) {
1729 ret = -EINVAL;
1730 goto out;
1733 ret = qemu_savevm_state_begin(f, &params);
1734 if (ret < 0)
1735 goto out;
1737 do {
1738 ret = qemu_savevm_state_iterate(f);
1739 if (ret < 0)
1740 goto out;
1741 } while (ret == 0);
1743 ret = qemu_savevm_state_complete(f);
1745 out:
1746 if (ret == 0) {
1747 ret = qemu_file_get_error(f);
1750 return ret;
1753 static int qemu_save_device_state(QEMUFile *f)
1755 SaveStateEntry *se;
1757 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1758 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1760 cpu_synchronize_all_states();
1762 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1763 int len;
1765 if (se->is_ram) {
1766 continue;
1768 if (se->save_state == NULL && se->vmsd == NULL) {
1769 continue;
1772 /* Section type */
1773 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1774 qemu_put_be32(f, se->section_id);
1776 /* ID string */
1777 len = strlen(se->idstr);
1778 qemu_put_byte(f, len);
1779 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1781 qemu_put_be32(f, se->instance_id);
1782 qemu_put_be32(f, se->version_id);
1784 vmstate_save(f, se);
1787 qemu_put_byte(f, QEMU_VM_EOF);
1789 return qemu_file_get_error(f);
1792 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1794 SaveStateEntry *se;
1796 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1797 if (!strcmp(se->idstr, idstr) &&
1798 (instance_id == se->instance_id ||
1799 instance_id == se->alias_id))
1800 return se;
1801 /* Migrating from an older version? */
1802 if (strstr(se->idstr, idstr) && se->compat) {
1803 if (!strcmp(se->compat->idstr, idstr) &&
1804 (instance_id == se->compat->instance_id ||
1805 instance_id == se->alias_id))
1806 return se;
1809 return NULL;
1812 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1814 while(sub && sub->needed) {
1815 if (strcmp(idstr, sub->vmsd->name) == 0) {
1816 return sub->vmsd;
1818 sub++;
1820 return NULL;
1823 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1824 void *opaque)
1826 while (qemu_peek_byte(f, 0) == QEMU_VM_SUBSECTION) {
1827 char idstr[256];
1828 int ret;
1829 uint8_t version_id, len, size;
1830 const VMStateDescription *sub_vmsd;
1832 len = qemu_peek_byte(f, 1);
1833 if (len < strlen(vmsd->name) + 1) {
1834 /* subsection name has be be "section_name/a" */
1835 return 0;
1837 size = qemu_peek_buffer(f, (uint8_t *)idstr, len, 2);
1838 if (size != len) {
1839 return 0;
1841 idstr[size] = 0;
1843 if (strncmp(vmsd->name, idstr, strlen(vmsd->name)) != 0) {
1844 /* it don't have a valid subsection name */
1845 return 0;
1847 sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1848 if (sub_vmsd == NULL) {
1849 return -ENOENT;
1851 qemu_file_skip(f, 1); /* subsection */
1852 qemu_file_skip(f, 1); /* len */
1853 qemu_file_skip(f, len); /* idstr */
1854 version_id = qemu_get_be32(f);
1856 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1857 if (ret) {
1858 return ret;
1861 return 0;
1864 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1865 void *opaque)
1867 const VMStateSubsection *sub = vmsd->subsections;
1869 while (sub && sub->needed) {
1870 if (sub->needed(opaque)) {
1871 const VMStateDescription *vmsd = sub->vmsd;
1872 uint8_t len;
1874 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1875 len = strlen(vmsd->name);
1876 qemu_put_byte(f, len);
1877 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1878 qemu_put_be32(f, vmsd->version_id);
1879 vmstate_save_state(f, vmsd, opaque);
1881 sub++;
1885 typedef struct LoadStateEntry {
1886 QLIST_ENTRY(LoadStateEntry) entry;
1887 SaveStateEntry *se;
1888 int section_id;
1889 int version_id;
1890 } LoadStateEntry;
1892 int qemu_loadvm_state(QEMUFile *f)
1894 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1895 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1896 LoadStateEntry *le, *new_le;
1897 uint8_t section_type;
1898 unsigned int v;
1899 int ret;
1901 if (qemu_savevm_state_blocked(NULL)) {
1902 return -EINVAL;
1905 v = qemu_get_be32(f);
1906 if (v != QEMU_VM_FILE_MAGIC)
1907 return -EINVAL;
1909 v = qemu_get_be32(f);
1910 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1911 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1912 return -ENOTSUP;
1914 if (v != QEMU_VM_FILE_VERSION)
1915 return -ENOTSUP;
1917 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1918 uint32_t instance_id, version_id, section_id;
1919 SaveStateEntry *se;
1920 char idstr[257];
1921 int len;
1923 switch (section_type) {
1924 case QEMU_VM_SECTION_START:
1925 case QEMU_VM_SECTION_FULL:
1926 /* Read section start */
1927 section_id = qemu_get_be32(f);
1928 len = qemu_get_byte(f);
1929 qemu_get_buffer(f, (uint8_t *)idstr, len);
1930 idstr[len] = 0;
1931 instance_id = qemu_get_be32(f);
1932 version_id = qemu_get_be32(f);
1934 /* Find savevm section */
1935 se = find_se(idstr, instance_id);
1936 if (se == NULL) {
1937 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1938 ret = -EINVAL;
1939 goto out;
1942 /* Validate version */
1943 if (version_id > se->version_id) {
1944 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1945 version_id, idstr, se->version_id);
1946 ret = -EINVAL;
1947 goto out;
1950 /* Add entry */
1951 le = g_malloc0(sizeof(*le));
1953 le->se = se;
1954 le->section_id = section_id;
1955 le->version_id = version_id;
1956 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1958 ret = vmstate_load(f, le->se, le->version_id);
1959 if (ret < 0) {
1960 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1961 instance_id, idstr);
1962 goto out;
1964 break;
1965 case QEMU_VM_SECTION_PART:
1966 case QEMU_VM_SECTION_END:
1967 section_id = qemu_get_be32(f);
1969 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1970 if (le->section_id == section_id) {
1971 break;
1974 if (le == NULL) {
1975 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1976 ret = -EINVAL;
1977 goto out;
1980 ret = vmstate_load(f, le->se, le->version_id);
1981 if (ret < 0) {
1982 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1983 section_id);
1984 goto out;
1986 break;
1987 default:
1988 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1989 ret = -EINVAL;
1990 goto out;
1994 cpu_synchronize_all_post_init();
1996 ret = 0;
1998 out:
1999 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
2000 QLIST_REMOVE(le, entry);
2001 g_free(le);
2004 if (ret == 0) {
2005 ret = qemu_file_get_error(f);
2008 return ret;
2011 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
2012 const char *name)
2014 QEMUSnapshotInfo *sn_tab, *sn;
2015 int nb_sns, i, ret;
2017 ret = -ENOENT;
2018 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2019 if (nb_sns < 0)
2020 return ret;
2021 for(i = 0; i < nb_sns; i++) {
2022 sn = &sn_tab[i];
2023 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
2024 *sn_info = *sn;
2025 ret = 0;
2026 break;
2029 g_free(sn_tab);
2030 return ret;
2034 * Deletes snapshots of a given name in all opened images.
2036 static int del_existing_snapshots(Monitor *mon, const char *name)
2038 BlockDriverState *bs;
2039 QEMUSnapshotInfo sn1, *snapshot = &sn1;
2040 int ret;
2042 bs = NULL;
2043 while ((bs = bdrv_next(bs))) {
2044 if (bdrv_can_snapshot(bs) &&
2045 bdrv_snapshot_find(bs, snapshot, name) >= 0)
2047 ret = bdrv_snapshot_delete(bs, name);
2048 if (ret < 0) {
2049 monitor_printf(mon,
2050 "Error while deleting snapshot on '%s'\n",
2051 bdrv_get_device_name(bs));
2052 return -1;
2057 return 0;
2060 void do_savevm(Monitor *mon, const QDict *qdict)
2062 BlockDriverState *bs, *bs1;
2063 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
2064 int ret;
2065 QEMUFile *f;
2066 int saved_vm_running;
2067 uint64_t vm_state_size;
2068 #ifdef _WIN32
2069 struct _timeb tb;
2070 struct tm *ptm;
2071 #else
2072 struct timeval tv;
2073 struct tm tm;
2074 #endif
2075 const char *name = qdict_get_try_str(qdict, "name");
2077 /* Verify if there is a device that doesn't support snapshots and is writable */
2078 bs = NULL;
2079 while ((bs = bdrv_next(bs))) {
2081 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2082 continue;
2085 if (!bdrv_can_snapshot(bs)) {
2086 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
2087 bdrv_get_device_name(bs));
2088 return;
2092 bs = bdrv_snapshots();
2093 if (!bs) {
2094 monitor_printf(mon, "No block device can accept snapshots\n");
2095 return;
2098 saved_vm_running = runstate_is_running();
2099 vm_stop(RUN_STATE_SAVE_VM);
2101 memset(sn, 0, sizeof(*sn));
2103 /* fill auxiliary fields */
2104 #ifdef _WIN32
2105 _ftime(&tb);
2106 sn->date_sec = tb.time;
2107 sn->date_nsec = tb.millitm * 1000000;
2108 #else
2109 gettimeofday(&tv, NULL);
2110 sn->date_sec = tv.tv_sec;
2111 sn->date_nsec = tv.tv_usec * 1000;
2112 #endif
2113 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
2115 if (name) {
2116 ret = bdrv_snapshot_find(bs, old_sn, name);
2117 if (ret >= 0) {
2118 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
2119 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
2120 } else {
2121 pstrcpy(sn->name, sizeof(sn->name), name);
2123 } else {
2124 #ifdef _WIN32
2125 time_t t = tb.time;
2126 ptm = localtime(&t);
2127 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
2128 #else
2129 /* cast below needed for OpenBSD where tv_sec is still 'long' */
2130 localtime_r((const time_t *)&tv.tv_sec, &tm);
2131 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
2132 #endif
2135 /* Delete old snapshots of the same name */
2136 if (name && del_existing_snapshots(mon, name) < 0) {
2137 goto the_end;
2140 /* save the VM state */
2141 f = qemu_fopen_bdrv(bs, 1);
2142 if (!f) {
2143 monitor_printf(mon, "Could not open VM state file\n");
2144 goto the_end;
2146 ret = qemu_savevm_state(f);
2147 vm_state_size = qemu_ftell(f);
2148 qemu_fclose(f);
2149 if (ret < 0) {
2150 monitor_printf(mon, "Error %d while writing VM\n", ret);
2151 goto the_end;
2154 /* create the snapshots */
2156 bs1 = NULL;
2157 while ((bs1 = bdrv_next(bs1))) {
2158 if (bdrv_can_snapshot(bs1)) {
2159 /* Write VM state size only to the image that contains the state */
2160 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2161 ret = bdrv_snapshot_create(bs1, sn);
2162 if (ret < 0) {
2163 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2164 bdrv_get_device_name(bs1));
2169 the_end:
2170 if (saved_vm_running)
2171 vm_start();
2174 void qmp_xen_save_devices_state(const char *filename, Error **errp)
2176 QEMUFile *f;
2177 int saved_vm_running;
2178 int ret;
2180 saved_vm_running = runstate_is_running();
2181 vm_stop(RUN_STATE_SAVE_VM);
2183 f = qemu_fopen(filename, "wb");
2184 if (!f) {
2185 error_set(errp, QERR_OPEN_FILE_FAILED, filename);
2186 goto the_end;
2188 ret = qemu_save_device_state(f);
2189 qemu_fclose(f);
2190 if (ret < 0) {
2191 error_set(errp, QERR_IO_ERROR);
2194 the_end:
2195 if (saved_vm_running)
2196 vm_start();
2197 return;
2200 int load_vmstate(const char *name)
2202 BlockDriverState *bs, *bs_vm_state;
2203 QEMUSnapshotInfo sn;
2204 QEMUFile *f;
2205 int ret;
2207 bs_vm_state = bdrv_snapshots();
2208 if (!bs_vm_state) {
2209 error_report("No block device supports snapshots");
2210 return -ENOTSUP;
2213 /* Don't even try to load empty VM states */
2214 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2215 if (ret < 0) {
2216 return ret;
2217 } else if (sn.vm_state_size == 0) {
2218 error_report("This is a disk-only snapshot. Revert to it offline "
2219 "using qemu-img.");
2220 return -EINVAL;
2223 /* Verify if there is any device that doesn't support snapshots and is
2224 writable and check if the requested snapshot is available too. */
2225 bs = NULL;
2226 while ((bs = bdrv_next(bs))) {
2228 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2229 continue;
2232 if (!bdrv_can_snapshot(bs)) {
2233 error_report("Device '%s' is writable but does not support snapshots.",
2234 bdrv_get_device_name(bs));
2235 return -ENOTSUP;
2238 ret = bdrv_snapshot_find(bs, &sn, name);
2239 if (ret < 0) {
2240 error_report("Device '%s' does not have the requested snapshot '%s'",
2241 bdrv_get_device_name(bs), name);
2242 return ret;
2246 /* Flush all IO requests so they don't interfere with the new state. */
2247 bdrv_drain_all();
2249 bs = NULL;
2250 while ((bs = bdrv_next(bs))) {
2251 if (bdrv_can_snapshot(bs)) {
2252 ret = bdrv_snapshot_goto(bs, name);
2253 if (ret < 0) {
2254 error_report("Error %d while activating snapshot '%s' on '%s'",
2255 ret, name, bdrv_get_device_name(bs));
2256 return ret;
2261 /* restore the VM state */
2262 f = qemu_fopen_bdrv(bs_vm_state, 0);
2263 if (!f) {
2264 error_report("Could not open VM state file");
2265 return -EINVAL;
2268 qemu_system_reset(VMRESET_SILENT);
2269 ret = qemu_loadvm_state(f);
2271 qemu_fclose(f);
2272 if (ret < 0) {
2273 error_report("Error %d while loading VM state", ret);
2274 return ret;
2277 return 0;
2280 void do_delvm(Monitor *mon, const QDict *qdict)
2282 BlockDriverState *bs, *bs1;
2283 int ret;
2284 const char *name = qdict_get_str(qdict, "name");
2286 bs = bdrv_snapshots();
2287 if (!bs) {
2288 monitor_printf(mon, "No block device supports snapshots\n");
2289 return;
2292 bs1 = NULL;
2293 while ((bs1 = bdrv_next(bs1))) {
2294 if (bdrv_can_snapshot(bs1)) {
2295 ret = bdrv_snapshot_delete(bs1, name);
2296 if (ret < 0) {
2297 if (ret == -ENOTSUP)
2298 monitor_printf(mon,
2299 "Snapshots not supported on device '%s'\n",
2300 bdrv_get_device_name(bs1));
2301 else
2302 monitor_printf(mon, "Error %d while deleting snapshot on "
2303 "'%s'\n", ret, bdrv_get_device_name(bs1));
2309 void do_info_snapshots(Monitor *mon)
2311 BlockDriverState *bs, *bs1;
2312 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2313 int nb_sns, i, ret, available;
2314 int total;
2315 int *available_snapshots;
2316 char buf[256];
2318 bs = bdrv_snapshots();
2319 if (!bs) {
2320 monitor_printf(mon, "No available block device supports snapshots\n");
2321 return;
2324 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2325 if (nb_sns < 0) {
2326 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2327 return;
2330 if (nb_sns == 0) {
2331 monitor_printf(mon, "There is no snapshot available.\n");
2332 return;
2335 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2336 total = 0;
2337 for (i = 0; i < nb_sns; i++) {
2338 sn = &sn_tab[i];
2339 available = 1;
2340 bs1 = NULL;
2342 while ((bs1 = bdrv_next(bs1))) {
2343 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2344 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2345 if (ret < 0) {
2346 available = 0;
2347 break;
2352 if (available) {
2353 available_snapshots[total] = i;
2354 total++;
2358 if (total > 0) {
2359 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2360 for (i = 0; i < total; i++) {
2361 sn = &sn_tab[available_snapshots[i]];
2362 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2364 } else {
2365 monitor_printf(mon, "There is no suitable snapshot available\n");
2368 g_free(sn_tab);
2369 g_free(available_snapshots);
2373 void vmstate_register_ram(MemoryRegion *mr, DeviceState *dev)
2375 qemu_ram_set_idstr(memory_region_get_ram_addr(mr) & TARGET_PAGE_MASK,
2376 memory_region_name(mr), dev);
2379 void vmstate_unregister_ram(MemoryRegion *mr, DeviceState *dev)
2381 /* Nothing do to while the implementation is in RAMBlock */
2384 void vmstate_register_ram_global(MemoryRegion *mr)
2386 vmstate_register_ram(mr, NULL);