]> git.proxmox.com Git - qemu.git/blob - savevm.c
savevm: teach qemu_fill_buffer to do partial refills
[qemu.git] / savevm.c
1 /*
2 * QEMU System Emulator
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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.
23 */
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>
30
31 /* Needed early for CONFIG_BSD etc. */
32 #include "config-host.h"
33
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
62
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
71
72 #include "qemu-common.h"
73 #include "hw/hw.h"
74 #include "hw/qdev.h"
75 #include "net.h"
76 #include "monitor.h"
77 #include "sysemu.h"
78 #include "qemu-timer.h"
79 #include "qemu-char.h"
80 #include "audio/audio.h"
81 #include "migration.h"
82 #include "qemu_socket.h"
83 #include "qemu-queue.h"
84 #include "cpus.h"
85
86 #define SELF_ANNOUNCE_ROUNDS 5
87
88 #ifndef ETH_P_RARP
89 #define ETH_P_RARP 0x8035
90 #endif
91 #define ARP_HTYPE_ETH 0x0001
92 #define ARP_PTYPE_IP 0x0800
93 #define ARP_OP_REQUEST_REV 0x3
94
95 static int announce_self_create(uint8_t *buf,
96 uint8_t *mac_addr)
97 {
98 /* Ethernet header. */
99 memset(buf, 0xff, 6); /* destination MAC addr */
100 memcpy(buf + 6, mac_addr, 6); /* source MAC addr */
101 *(uint16_t *)(buf + 12) = htons(ETH_P_RARP); /* ethertype */
102
103 /* RARP header. */
104 *(uint16_t *)(buf + 14) = htons(ARP_HTYPE_ETH); /* hardware addr space */
105 *(uint16_t *)(buf + 16) = htons(ARP_PTYPE_IP); /* protocol addr space */
106 *(buf + 18) = 6; /* hardware addr length (ethernet) */
107 *(buf + 19) = 4; /* protocol addr length (IPv4) */
108 *(uint16_t *)(buf + 20) = htons(ARP_OP_REQUEST_REV); /* opcode */
109 memcpy(buf + 22, mac_addr, 6); /* source hw addr */
110 memset(buf + 28, 0x00, 4); /* source protocol addr */
111 memcpy(buf + 32, mac_addr, 6); /* target hw addr */
112 memset(buf + 38, 0x00, 4); /* target protocol addr */
113
114 /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
115 memset(buf + 42, 0x00, 18);
116
117 return 60; /* len (FCS will be added by hardware) */
118 }
119
120 static void qemu_announce_self_iter(NICState *nic, void *opaque)
121 {
122 uint8_t buf[60];
123 int len;
124
125 len = announce_self_create(buf, nic->conf->macaddr.a);
126
127 qemu_send_packet_raw(&nic->nc, buf, len);
128 }
129
130
131 static void qemu_announce_self_once(void *opaque)
132 {
133 static int count = SELF_ANNOUNCE_ROUNDS;
134 QEMUTimer *timer = *(QEMUTimer **)opaque;
135
136 qemu_foreach_nic(qemu_announce_self_iter, NULL);
137
138 if (--count) {
139 /* delay 50ms, 150ms, 250ms, ... */
140 qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
141 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
142 } else {
143 qemu_del_timer(timer);
144 qemu_free_timer(timer);
145 }
146 }
147
148 void qemu_announce_self(void)
149 {
150 static QEMUTimer *timer;
151 timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
152 qemu_announce_self_once(&timer);
153 }
154
155 /***********************************************************/
156 /* savevm/loadvm support */
157
158 #define IO_BUF_SIZE 32768
159
160 struct QEMUFile {
161 QEMUFilePutBufferFunc *put_buffer;
162 QEMUFileGetBufferFunc *get_buffer;
163 QEMUFileCloseFunc *close;
164 QEMUFileRateLimit *rate_limit;
165 QEMUFileSetRateLimit *set_rate_limit;
166 QEMUFileGetRateLimit *get_rate_limit;
167 void *opaque;
168 int is_write;
169
170 int64_t buf_offset; /* start of buffer when writing, end of buffer
171 when reading */
172 int buf_index;
173 int buf_size; /* 0 when writing */
174 uint8_t buf[IO_BUF_SIZE];
175
176 int has_error;
177 };
178
179 typedef struct QEMUFileStdio
180 {
181 FILE *stdio_file;
182 QEMUFile *file;
183 } QEMUFileStdio;
184
185 typedef struct QEMUFileSocket
186 {
187 int fd;
188 QEMUFile *file;
189 } QEMUFileSocket;
190
191 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
192 {
193 QEMUFileSocket *s = opaque;
194 ssize_t len;
195
196 do {
197 len = qemu_recv(s->fd, buf, size, 0);
198 } while (len == -1 && socket_error() == EINTR);
199
200 if (len == -1)
201 len = -socket_error();
202
203 return len;
204 }
205
206 static int socket_close(void *opaque)
207 {
208 QEMUFileSocket *s = opaque;
209 g_free(s);
210 return 0;
211 }
212
213 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
214 {
215 QEMUFileStdio *s = opaque;
216 return fwrite(buf, 1, size, s->stdio_file);
217 }
218
219 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
220 {
221 QEMUFileStdio *s = opaque;
222 FILE *fp = s->stdio_file;
223 int bytes;
224
225 do {
226 clearerr(fp);
227 bytes = fread(buf, 1, size, fp);
228 } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
229 return bytes;
230 }
231
232 static int stdio_pclose(void *opaque)
233 {
234 QEMUFileStdio *s = opaque;
235 int ret;
236 ret = pclose(s->stdio_file);
237 g_free(s);
238 return ret;
239 }
240
241 static int stdio_fclose(void *opaque)
242 {
243 QEMUFileStdio *s = opaque;
244 fclose(s->stdio_file);
245 g_free(s);
246 return 0;
247 }
248
249 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
250 {
251 QEMUFileStdio *s;
252
253 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
254 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
255 return NULL;
256 }
257
258 s = g_malloc0(sizeof(QEMUFileStdio));
259
260 s->stdio_file = stdio_file;
261
262 if(mode[0] == 'r') {
263 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose,
264 NULL, NULL, NULL);
265 } else {
266 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose,
267 NULL, NULL, NULL);
268 }
269 return s->file;
270 }
271
272 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
273 {
274 FILE *popen_file;
275
276 popen_file = popen(command, mode);
277 if(popen_file == NULL) {
278 return NULL;
279 }
280
281 return qemu_popen(popen_file, mode);
282 }
283
284 int qemu_stdio_fd(QEMUFile *f)
285 {
286 QEMUFileStdio *p;
287 int fd;
288
289 p = (QEMUFileStdio *)f->opaque;
290 fd = fileno(p->stdio_file);
291
292 return fd;
293 }
294
295 QEMUFile *qemu_fdopen(int fd, const char *mode)
296 {
297 QEMUFileStdio *s;
298
299 if (mode == NULL ||
300 (mode[0] != 'r' && mode[0] != 'w') ||
301 mode[1] != 'b' || mode[2] != 0) {
302 fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
303 return NULL;
304 }
305
306 s = g_malloc0(sizeof(QEMUFileStdio));
307 s->stdio_file = fdopen(fd, mode);
308 if (!s->stdio_file)
309 goto fail;
310
311 if(mode[0] == 'r') {
312 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose,
313 NULL, NULL, NULL);
314 } else {
315 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose,
316 NULL, NULL, NULL);
317 }
318 return s->file;
319
320 fail:
321 g_free(s);
322 return NULL;
323 }
324
325 QEMUFile *qemu_fopen_socket(int fd)
326 {
327 QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
328
329 s->fd = fd;
330 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close,
331 NULL, NULL, NULL);
332 return s->file;
333 }
334
335 static int file_put_buffer(void *opaque, const uint8_t *buf,
336 int64_t pos, int size)
337 {
338 QEMUFileStdio *s = opaque;
339 fseek(s->stdio_file, pos, SEEK_SET);
340 return fwrite(buf, 1, size, s->stdio_file);
341 }
342
343 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
344 {
345 QEMUFileStdio *s = opaque;
346 fseek(s->stdio_file, pos, SEEK_SET);
347 return fread(buf, 1, size, s->stdio_file);
348 }
349
350 QEMUFile *qemu_fopen(const char *filename, const char *mode)
351 {
352 QEMUFileStdio *s;
353
354 if (mode == NULL ||
355 (mode[0] != 'r' && mode[0] != 'w') ||
356 mode[1] != 'b' || mode[2] != 0) {
357 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
358 return NULL;
359 }
360
361 s = g_malloc0(sizeof(QEMUFileStdio));
362
363 s->stdio_file = fopen(filename, mode);
364 if (!s->stdio_file)
365 goto fail;
366
367 if(mode[0] == 'w') {
368 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose,
369 NULL, NULL, NULL);
370 } else {
371 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose,
372 NULL, NULL, NULL);
373 }
374 return s->file;
375 fail:
376 g_free(s);
377 return NULL;
378 }
379
380 static int block_put_buffer(void *opaque, const uint8_t *buf,
381 int64_t pos, int size)
382 {
383 bdrv_save_vmstate(opaque, buf, pos, size);
384 return size;
385 }
386
387 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
388 {
389 return bdrv_load_vmstate(opaque, buf, pos, size);
390 }
391
392 static int bdrv_fclose(void *opaque)
393 {
394 return 0;
395 }
396
397 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
398 {
399 if (is_writable)
400 return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose,
401 NULL, NULL, NULL);
402 return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL, NULL);
403 }
404
405 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
406 QEMUFileGetBufferFunc *get_buffer,
407 QEMUFileCloseFunc *close,
408 QEMUFileRateLimit *rate_limit,
409 QEMUFileSetRateLimit *set_rate_limit,
410 QEMUFileGetRateLimit *get_rate_limit)
411 {
412 QEMUFile *f;
413
414 f = g_malloc0(sizeof(QEMUFile));
415
416 f->opaque = opaque;
417 f->put_buffer = put_buffer;
418 f->get_buffer = get_buffer;
419 f->close = close;
420 f->rate_limit = rate_limit;
421 f->set_rate_limit = set_rate_limit;
422 f->get_rate_limit = get_rate_limit;
423 f->is_write = 0;
424
425 return f;
426 }
427
428 int qemu_file_has_error(QEMUFile *f)
429 {
430 return f->has_error;
431 }
432
433 void qemu_file_set_error(QEMUFile *f)
434 {
435 f->has_error = 1;
436 }
437
438 void qemu_fflush(QEMUFile *f)
439 {
440 if (!f->put_buffer)
441 return;
442
443 if (f->is_write && f->buf_index > 0) {
444 int len;
445
446 len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
447 if (len > 0)
448 f->buf_offset += f->buf_index;
449 else
450 f->has_error = 1;
451 f->buf_index = 0;
452 }
453 }
454
455 static void qemu_fill_buffer(QEMUFile *f)
456 {
457 int len;
458 int pending;
459
460 if (!f->get_buffer)
461 return;
462
463 if (f->is_write)
464 abort();
465
466 pending = f->buf_size - f->buf_index;
467 if (pending > 0) {
468 memmove(f->buf, f->buf + f->buf_index, pending);
469 }
470 f->buf_index = 0;
471 f->buf_size = pending;
472
473 len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
474 IO_BUF_SIZE - pending);
475 if (len > 0) {
476 f->buf_size += len;
477 f->buf_offset += len;
478 } else if (len != -EAGAIN)
479 f->has_error = 1;
480 }
481
482 int qemu_fclose(QEMUFile *f)
483 {
484 int ret = 0;
485 qemu_fflush(f);
486 if (f->close)
487 ret = f->close(f->opaque);
488 g_free(f);
489 return ret;
490 }
491
492 void qemu_file_put_notify(QEMUFile *f)
493 {
494 f->put_buffer(f->opaque, NULL, 0, 0);
495 }
496
497 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
498 {
499 int l;
500
501 if (!f->has_error && f->is_write == 0 && f->buf_index > 0) {
502 fprintf(stderr,
503 "Attempted to write to buffer while read buffer is not empty\n");
504 abort();
505 }
506
507 while (!f->has_error && size > 0) {
508 l = IO_BUF_SIZE - f->buf_index;
509 if (l > size)
510 l = size;
511 memcpy(f->buf + f->buf_index, buf, l);
512 f->is_write = 1;
513 f->buf_index += l;
514 buf += l;
515 size -= l;
516 if (f->buf_index >= IO_BUF_SIZE)
517 qemu_fflush(f);
518 }
519 }
520
521 void qemu_put_byte(QEMUFile *f, int v)
522 {
523 if (!f->has_error && f->is_write == 0 && f->buf_index > 0) {
524 fprintf(stderr,
525 "Attempted to write to buffer while read buffer is not empty\n");
526 abort();
527 }
528
529 f->buf[f->buf_index++] = v;
530 f->is_write = 1;
531 if (f->buf_index >= IO_BUF_SIZE)
532 qemu_fflush(f);
533 }
534
535 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size1)
536 {
537 int size, l;
538
539 if (f->is_write)
540 abort();
541
542 size = size1;
543 while (size > 0) {
544 l = f->buf_size - f->buf_index;
545 if (l == 0) {
546 qemu_fill_buffer(f);
547 l = f->buf_size - f->buf_index;
548 if (l == 0)
549 break;
550 }
551 if (l > size)
552 l = size;
553 memcpy(buf, f->buf + f->buf_index, l);
554 f->buf_index += l;
555 buf += l;
556 size -= l;
557 }
558 return size1 - size;
559 }
560
561 static int qemu_peek_byte(QEMUFile *f)
562 {
563 if (f->is_write)
564 abort();
565
566 if (f->buf_index >= f->buf_size) {
567 qemu_fill_buffer(f);
568 if (f->buf_index >= f->buf_size)
569 return 0;
570 }
571 return f->buf[f->buf_index];
572 }
573
574 int qemu_get_byte(QEMUFile *f)
575 {
576 if (f->is_write)
577 abort();
578
579 if (f->buf_index >= f->buf_size) {
580 qemu_fill_buffer(f);
581 if (f->buf_index >= f->buf_size)
582 return 0;
583 }
584 return f->buf[f->buf_index++];
585 }
586
587 int64_t qemu_ftell(QEMUFile *f)
588 {
589 return f->buf_offset - f->buf_size + f->buf_index;
590 }
591
592 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
593 {
594 if (whence == SEEK_SET) {
595 /* nothing to do */
596 } else if (whence == SEEK_CUR) {
597 pos += qemu_ftell(f);
598 } else {
599 /* SEEK_END not supported */
600 return -1;
601 }
602 if (f->put_buffer) {
603 qemu_fflush(f);
604 f->buf_offset = pos;
605 } else {
606 f->buf_offset = pos;
607 f->buf_index = 0;
608 f->buf_size = 0;
609 }
610 return pos;
611 }
612
613 int qemu_file_rate_limit(QEMUFile *f)
614 {
615 if (f->rate_limit)
616 return f->rate_limit(f->opaque);
617
618 return 0;
619 }
620
621 int64_t qemu_file_get_rate_limit(QEMUFile *f)
622 {
623 if (f->get_rate_limit)
624 return f->get_rate_limit(f->opaque);
625
626 return 0;
627 }
628
629 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
630 {
631 /* any failed or completed migration keeps its state to allow probing of
632 * migration data, but has no associated file anymore */
633 if (f && f->set_rate_limit)
634 return f->set_rate_limit(f->opaque, new_rate);
635
636 return 0;
637 }
638
639 void qemu_put_be16(QEMUFile *f, unsigned int v)
640 {
641 qemu_put_byte(f, v >> 8);
642 qemu_put_byte(f, v);
643 }
644
645 void qemu_put_be32(QEMUFile *f, unsigned int v)
646 {
647 qemu_put_byte(f, v >> 24);
648 qemu_put_byte(f, v >> 16);
649 qemu_put_byte(f, v >> 8);
650 qemu_put_byte(f, v);
651 }
652
653 void qemu_put_be64(QEMUFile *f, uint64_t v)
654 {
655 qemu_put_be32(f, v >> 32);
656 qemu_put_be32(f, v);
657 }
658
659 unsigned int qemu_get_be16(QEMUFile *f)
660 {
661 unsigned int v;
662 v = qemu_get_byte(f) << 8;
663 v |= qemu_get_byte(f);
664 return v;
665 }
666
667 unsigned int qemu_get_be32(QEMUFile *f)
668 {
669 unsigned int v;
670 v = qemu_get_byte(f) << 24;
671 v |= qemu_get_byte(f) << 16;
672 v |= qemu_get_byte(f) << 8;
673 v |= qemu_get_byte(f);
674 return v;
675 }
676
677 uint64_t qemu_get_be64(QEMUFile *f)
678 {
679 uint64_t v;
680 v = (uint64_t)qemu_get_be32(f) << 32;
681 v |= qemu_get_be32(f);
682 return v;
683 }
684
685 /* bool */
686
687 static int get_bool(QEMUFile *f, void *pv, size_t size)
688 {
689 bool *v = pv;
690 *v = qemu_get_byte(f);
691 return 0;
692 }
693
694 static void put_bool(QEMUFile *f, void *pv, size_t size)
695 {
696 bool *v = pv;
697 qemu_put_byte(f, *v);
698 }
699
700 const VMStateInfo vmstate_info_bool = {
701 .name = "bool",
702 .get = get_bool,
703 .put = put_bool,
704 };
705
706 /* 8 bit int */
707
708 static int get_int8(QEMUFile *f, void *pv, size_t size)
709 {
710 int8_t *v = pv;
711 qemu_get_s8s(f, v);
712 return 0;
713 }
714
715 static void put_int8(QEMUFile *f, void *pv, size_t size)
716 {
717 int8_t *v = pv;
718 qemu_put_s8s(f, v);
719 }
720
721 const VMStateInfo vmstate_info_int8 = {
722 .name = "int8",
723 .get = get_int8,
724 .put = put_int8,
725 };
726
727 /* 16 bit int */
728
729 static int get_int16(QEMUFile *f, void *pv, size_t size)
730 {
731 int16_t *v = pv;
732 qemu_get_sbe16s(f, v);
733 return 0;
734 }
735
736 static void put_int16(QEMUFile *f, void *pv, size_t size)
737 {
738 int16_t *v = pv;
739 qemu_put_sbe16s(f, v);
740 }
741
742 const VMStateInfo vmstate_info_int16 = {
743 .name = "int16",
744 .get = get_int16,
745 .put = put_int16,
746 };
747
748 /* 32 bit int */
749
750 static int get_int32(QEMUFile *f, void *pv, size_t size)
751 {
752 int32_t *v = pv;
753 qemu_get_sbe32s(f, v);
754 return 0;
755 }
756
757 static void put_int32(QEMUFile *f, void *pv, size_t size)
758 {
759 int32_t *v = pv;
760 qemu_put_sbe32s(f, v);
761 }
762
763 const VMStateInfo vmstate_info_int32 = {
764 .name = "int32",
765 .get = get_int32,
766 .put = put_int32,
767 };
768
769 /* 32 bit int. See that the received value is the same than the one
770 in the field */
771
772 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
773 {
774 int32_t *v = pv;
775 int32_t v2;
776 qemu_get_sbe32s(f, &v2);
777
778 if (*v == v2)
779 return 0;
780 return -EINVAL;
781 }
782
783 const VMStateInfo vmstate_info_int32_equal = {
784 .name = "int32 equal",
785 .get = get_int32_equal,
786 .put = put_int32,
787 };
788
789 /* 32 bit int. See that the received value is the less or the same
790 than the one in the field */
791
792 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
793 {
794 int32_t *old = pv;
795 int32_t new;
796 qemu_get_sbe32s(f, &new);
797
798 if (*old <= new)
799 return 0;
800 return -EINVAL;
801 }
802
803 const VMStateInfo vmstate_info_int32_le = {
804 .name = "int32 equal",
805 .get = get_int32_le,
806 .put = put_int32,
807 };
808
809 /* 64 bit int */
810
811 static int get_int64(QEMUFile *f, void *pv, size_t size)
812 {
813 int64_t *v = pv;
814 qemu_get_sbe64s(f, v);
815 return 0;
816 }
817
818 static void put_int64(QEMUFile *f, void *pv, size_t size)
819 {
820 int64_t *v = pv;
821 qemu_put_sbe64s(f, v);
822 }
823
824 const VMStateInfo vmstate_info_int64 = {
825 .name = "int64",
826 .get = get_int64,
827 .put = put_int64,
828 };
829
830 /* 8 bit unsigned int */
831
832 static int get_uint8(QEMUFile *f, void *pv, size_t size)
833 {
834 uint8_t *v = pv;
835 qemu_get_8s(f, v);
836 return 0;
837 }
838
839 static void put_uint8(QEMUFile *f, void *pv, size_t size)
840 {
841 uint8_t *v = pv;
842 qemu_put_8s(f, v);
843 }
844
845 const VMStateInfo vmstate_info_uint8 = {
846 .name = "uint8",
847 .get = get_uint8,
848 .put = put_uint8,
849 };
850
851 /* 16 bit unsigned int */
852
853 static int get_uint16(QEMUFile *f, void *pv, size_t size)
854 {
855 uint16_t *v = pv;
856 qemu_get_be16s(f, v);
857 return 0;
858 }
859
860 static void put_uint16(QEMUFile *f, void *pv, size_t size)
861 {
862 uint16_t *v = pv;
863 qemu_put_be16s(f, v);
864 }
865
866 const VMStateInfo vmstate_info_uint16 = {
867 .name = "uint16",
868 .get = get_uint16,
869 .put = put_uint16,
870 };
871
872 /* 32 bit unsigned int */
873
874 static int get_uint32(QEMUFile *f, void *pv, size_t size)
875 {
876 uint32_t *v = pv;
877 qemu_get_be32s(f, v);
878 return 0;
879 }
880
881 static void put_uint32(QEMUFile *f, void *pv, size_t size)
882 {
883 uint32_t *v = pv;
884 qemu_put_be32s(f, v);
885 }
886
887 const VMStateInfo vmstate_info_uint32 = {
888 .name = "uint32",
889 .get = get_uint32,
890 .put = put_uint32,
891 };
892
893 /* 32 bit uint. See that the received value is the same than the one
894 in the field */
895
896 static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
897 {
898 uint32_t *v = pv;
899 uint32_t v2;
900 qemu_get_be32s(f, &v2);
901
902 if (*v == v2) {
903 return 0;
904 }
905 return -EINVAL;
906 }
907
908 const VMStateInfo vmstate_info_uint32_equal = {
909 .name = "uint32 equal",
910 .get = get_uint32_equal,
911 .put = put_uint32,
912 };
913
914 /* 64 bit unsigned int */
915
916 static int get_uint64(QEMUFile *f, void *pv, size_t size)
917 {
918 uint64_t *v = pv;
919 qemu_get_be64s(f, v);
920 return 0;
921 }
922
923 static void put_uint64(QEMUFile *f, void *pv, size_t size)
924 {
925 uint64_t *v = pv;
926 qemu_put_be64s(f, v);
927 }
928
929 const VMStateInfo vmstate_info_uint64 = {
930 .name = "uint64",
931 .get = get_uint64,
932 .put = put_uint64,
933 };
934
935 /* 8 bit int. See that the received value is the same than the one
936 in the field */
937
938 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
939 {
940 uint8_t *v = pv;
941 uint8_t v2;
942 qemu_get_8s(f, &v2);
943
944 if (*v == v2)
945 return 0;
946 return -EINVAL;
947 }
948
949 const VMStateInfo vmstate_info_uint8_equal = {
950 .name = "uint8 equal",
951 .get = get_uint8_equal,
952 .put = put_uint8,
953 };
954
955 /* 16 bit unsigned int int. See that the received value is the same than the one
956 in the field */
957
958 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
959 {
960 uint16_t *v = pv;
961 uint16_t v2;
962 qemu_get_be16s(f, &v2);
963
964 if (*v == v2)
965 return 0;
966 return -EINVAL;
967 }
968
969 const VMStateInfo vmstate_info_uint16_equal = {
970 .name = "uint16 equal",
971 .get = get_uint16_equal,
972 .put = put_uint16,
973 };
974
975 /* timers */
976
977 static int get_timer(QEMUFile *f, void *pv, size_t size)
978 {
979 QEMUTimer *v = pv;
980 qemu_get_timer(f, v);
981 return 0;
982 }
983
984 static void put_timer(QEMUFile *f, void *pv, size_t size)
985 {
986 QEMUTimer *v = pv;
987 qemu_put_timer(f, v);
988 }
989
990 const VMStateInfo vmstate_info_timer = {
991 .name = "timer",
992 .get = get_timer,
993 .put = put_timer,
994 };
995
996 /* uint8_t buffers */
997
998 static int get_buffer(QEMUFile *f, void *pv, size_t size)
999 {
1000 uint8_t *v = pv;
1001 qemu_get_buffer(f, v, size);
1002 return 0;
1003 }
1004
1005 static void put_buffer(QEMUFile *f, void *pv, size_t size)
1006 {
1007 uint8_t *v = pv;
1008 qemu_put_buffer(f, v, size);
1009 }
1010
1011 const VMStateInfo vmstate_info_buffer = {
1012 .name = "buffer",
1013 .get = get_buffer,
1014 .put = put_buffer,
1015 };
1016
1017 /* unused buffers: space that was used for some fields that are
1018 not useful anymore */
1019
1020 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
1021 {
1022 uint8_t buf[1024];
1023 int block_len;
1024
1025 while (size > 0) {
1026 block_len = MIN(sizeof(buf), size);
1027 size -= block_len;
1028 qemu_get_buffer(f, buf, block_len);
1029 }
1030 return 0;
1031 }
1032
1033 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
1034 {
1035 static const uint8_t buf[1024];
1036 int block_len;
1037
1038 while (size > 0) {
1039 block_len = MIN(sizeof(buf), size);
1040 size -= block_len;
1041 qemu_put_buffer(f, buf, block_len);
1042 }
1043 }
1044
1045 const VMStateInfo vmstate_info_unused_buffer = {
1046 .name = "unused_buffer",
1047 .get = get_unused_buffer,
1048 .put = put_unused_buffer,
1049 };
1050
1051 typedef struct CompatEntry {
1052 char idstr[256];
1053 int instance_id;
1054 } CompatEntry;
1055
1056 typedef struct SaveStateEntry {
1057 QTAILQ_ENTRY(SaveStateEntry) entry;
1058 char idstr[256];
1059 int instance_id;
1060 int alias_id;
1061 int version_id;
1062 int section_id;
1063 SaveSetParamsHandler *set_params;
1064 SaveLiveStateHandler *save_live_state;
1065 SaveStateHandler *save_state;
1066 LoadStateHandler *load_state;
1067 const VMStateDescription *vmsd;
1068 void *opaque;
1069 CompatEntry *compat;
1070 int no_migrate;
1071 } SaveStateEntry;
1072
1073
1074 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1075 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1076 static int global_section_id;
1077
1078 static int calculate_new_instance_id(const char *idstr)
1079 {
1080 SaveStateEntry *se;
1081 int instance_id = 0;
1082
1083 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1084 if (strcmp(idstr, se->idstr) == 0
1085 && instance_id <= se->instance_id) {
1086 instance_id = se->instance_id + 1;
1087 }
1088 }
1089 return instance_id;
1090 }
1091
1092 static int calculate_compat_instance_id(const char *idstr)
1093 {
1094 SaveStateEntry *se;
1095 int instance_id = 0;
1096
1097 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1098 if (!se->compat)
1099 continue;
1100
1101 if (strcmp(idstr, se->compat->idstr) == 0
1102 && instance_id <= se->compat->instance_id) {
1103 instance_id = se->compat->instance_id + 1;
1104 }
1105 }
1106 return instance_id;
1107 }
1108
1109 /* TODO: Individual devices generally have very little idea about the rest
1110 of the system, so instance_id should be removed/replaced.
1111 Meanwhile pass -1 as instance_id if you do not already have a clearly
1112 distinguishing id for all instances of your device class. */
1113 int register_savevm_live(DeviceState *dev,
1114 const char *idstr,
1115 int instance_id,
1116 int version_id,
1117 SaveSetParamsHandler *set_params,
1118 SaveLiveStateHandler *save_live_state,
1119 SaveStateHandler *save_state,
1120 LoadStateHandler *load_state,
1121 void *opaque)
1122 {
1123 SaveStateEntry *se;
1124
1125 se = g_malloc0(sizeof(SaveStateEntry));
1126 se->version_id = version_id;
1127 se->section_id = global_section_id++;
1128 se->set_params = set_params;
1129 se->save_live_state = save_live_state;
1130 se->save_state = save_state;
1131 se->load_state = load_state;
1132 se->opaque = opaque;
1133 se->vmsd = NULL;
1134 se->no_migrate = 0;
1135
1136 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1137 char *id = dev->parent_bus->info->get_dev_path(dev);
1138 if (id) {
1139 pstrcpy(se->idstr, sizeof(se->idstr), id);
1140 pstrcat(se->idstr, sizeof(se->idstr), "/");
1141 g_free(id);
1142
1143 se->compat = g_malloc0(sizeof(CompatEntry));
1144 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1145 se->compat->instance_id = instance_id == -1 ?
1146 calculate_compat_instance_id(idstr) : instance_id;
1147 instance_id = -1;
1148 }
1149 }
1150 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1151
1152 if (instance_id == -1) {
1153 se->instance_id = calculate_new_instance_id(se->idstr);
1154 } else {
1155 se->instance_id = instance_id;
1156 }
1157 assert(!se->compat || se->instance_id == 0);
1158 /* add at the end of list */
1159 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1160 return 0;
1161 }
1162
1163 int register_savevm(DeviceState *dev,
1164 const char *idstr,
1165 int instance_id,
1166 int version_id,
1167 SaveStateHandler *save_state,
1168 LoadStateHandler *load_state,
1169 void *opaque)
1170 {
1171 return register_savevm_live(dev, idstr, instance_id, version_id,
1172 NULL, NULL, save_state, load_state, opaque);
1173 }
1174
1175 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1176 {
1177 SaveStateEntry *se, *new_se;
1178 char id[256] = "";
1179
1180 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1181 char *path = dev->parent_bus->info->get_dev_path(dev);
1182 if (path) {
1183 pstrcpy(id, sizeof(id), path);
1184 pstrcat(id, sizeof(id), "/");
1185 g_free(path);
1186 }
1187 }
1188 pstrcat(id, sizeof(id), idstr);
1189
1190 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1191 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1192 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1193 if (se->compat) {
1194 g_free(se->compat);
1195 }
1196 g_free(se);
1197 }
1198 }
1199 }
1200
1201 /* mark a device as not to be migrated, that is the device should be
1202 unplugged before migration */
1203 void register_device_unmigratable(DeviceState *dev, const char *idstr,
1204 void *opaque)
1205 {
1206 SaveStateEntry *se;
1207 char id[256] = "";
1208
1209 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1210 char *path = dev->parent_bus->info->get_dev_path(dev);
1211 if (path) {
1212 pstrcpy(id, sizeof(id), path);
1213 pstrcat(id, sizeof(id), "/");
1214 g_free(path);
1215 }
1216 }
1217 pstrcat(id, sizeof(id), idstr);
1218
1219 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1220 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1221 se->no_migrate = 1;
1222 }
1223 }
1224 }
1225
1226 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1227 const VMStateDescription *vmsd,
1228 void *opaque, int alias_id,
1229 int required_for_version)
1230 {
1231 SaveStateEntry *se;
1232
1233 /* If this triggers, alias support can be dropped for the vmsd. */
1234 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1235
1236 se = g_malloc0(sizeof(SaveStateEntry));
1237 se->version_id = vmsd->version_id;
1238 se->section_id = global_section_id++;
1239 se->save_live_state = NULL;
1240 se->save_state = NULL;
1241 se->load_state = NULL;
1242 se->opaque = opaque;
1243 se->vmsd = vmsd;
1244 se->alias_id = alias_id;
1245 se->no_migrate = vmsd->unmigratable;
1246
1247 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1248 char *id = dev->parent_bus->info->get_dev_path(dev);
1249 if (id) {
1250 pstrcpy(se->idstr, sizeof(se->idstr), id);
1251 pstrcat(se->idstr, sizeof(se->idstr), "/");
1252 g_free(id);
1253
1254 se->compat = g_malloc0(sizeof(CompatEntry));
1255 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1256 se->compat->instance_id = instance_id == -1 ?
1257 calculate_compat_instance_id(vmsd->name) : instance_id;
1258 instance_id = -1;
1259 }
1260 }
1261 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1262
1263 if (instance_id == -1) {
1264 se->instance_id = calculate_new_instance_id(se->idstr);
1265 } else {
1266 se->instance_id = instance_id;
1267 }
1268 assert(!se->compat || se->instance_id == 0);
1269 /* add at the end of list */
1270 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1271 return 0;
1272 }
1273
1274 int vmstate_register(DeviceState *dev, int instance_id,
1275 const VMStateDescription *vmsd, void *opaque)
1276 {
1277 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1278 opaque, -1, 0);
1279 }
1280
1281 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1282 void *opaque)
1283 {
1284 SaveStateEntry *se, *new_se;
1285
1286 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1287 if (se->vmsd == vmsd && se->opaque == opaque) {
1288 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1289 if (se->compat) {
1290 g_free(se->compat);
1291 }
1292 g_free(se);
1293 }
1294 }
1295 }
1296
1297 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1298 void *opaque);
1299 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1300 void *opaque);
1301
1302 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1303 void *opaque, int version_id)
1304 {
1305 VMStateField *field = vmsd->fields;
1306 int ret;
1307
1308 if (version_id > vmsd->version_id) {
1309 return -EINVAL;
1310 }
1311 if (version_id < vmsd->minimum_version_id_old) {
1312 return -EINVAL;
1313 }
1314 if (version_id < vmsd->minimum_version_id) {
1315 return vmsd->load_state_old(f, opaque, version_id);
1316 }
1317 if (vmsd->pre_load) {
1318 int ret = vmsd->pre_load(opaque);
1319 if (ret)
1320 return ret;
1321 }
1322 while(field->name) {
1323 if ((field->field_exists &&
1324 field->field_exists(opaque, version_id)) ||
1325 (!field->field_exists &&
1326 field->version_id <= version_id)) {
1327 void *base_addr = opaque + field->offset;
1328 int i, n_elems = 1;
1329 int size = field->size;
1330
1331 if (field->flags & VMS_VBUFFER) {
1332 size = *(int32_t *)(opaque+field->size_offset);
1333 if (field->flags & VMS_MULTIPLY) {
1334 size *= field->size;
1335 }
1336 }
1337 if (field->flags & VMS_ARRAY) {
1338 n_elems = field->num;
1339 } else if (field->flags & VMS_VARRAY_INT32) {
1340 n_elems = *(int32_t *)(opaque+field->num_offset);
1341 } else if (field->flags & VMS_VARRAY_UINT32) {
1342 n_elems = *(uint32_t *)(opaque+field->num_offset);
1343 } else if (field->flags & VMS_VARRAY_UINT16) {
1344 n_elems = *(uint16_t *)(opaque+field->num_offset);
1345 } else if (field->flags & VMS_VARRAY_UINT8) {
1346 n_elems = *(uint8_t *)(opaque+field->num_offset);
1347 }
1348 if (field->flags & VMS_POINTER) {
1349 base_addr = *(void **)base_addr + field->start;
1350 }
1351 for (i = 0; i < n_elems; i++) {
1352 void *addr = base_addr + size * i;
1353
1354 if (field->flags & VMS_ARRAY_OF_POINTER) {
1355 addr = *(void **)addr;
1356 }
1357 if (field->flags & VMS_STRUCT) {
1358 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1359 } else {
1360 ret = field->info->get(f, addr, size);
1361
1362 }
1363 if (ret < 0) {
1364 return ret;
1365 }
1366 }
1367 }
1368 field++;
1369 }
1370 ret = vmstate_subsection_load(f, vmsd, opaque);
1371 if (ret != 0) {
1372 return ret;
1373 }
1374 if (vmsd->post_load) {
1375 return vmsd->post_load(opaque, version_id);
1376 }
1377 return 0;
1378 }
1379
1380 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1381 void *opaque)
1382 {
1383 VMStateField *field = vmsd->fields;
1384
1385 if (vmsd->pre_save) {
1386 vmsd->pre_save(opaque);
1387 }
1388 while(field->name) {
1389 if (!field->field_exists ||
1390 field->field_exists(opaque, vmsd->version_id)) {
1391 void *base_addr = opaque + field->offset;
1392 int i, n_elems = 1;
1393 int size = field->size;
1394
1395 if (field->flags & VMS_VBUFFER) {
1396 size = *(int32_t *)(opaque+field->size_offset);
1397 if (field->flags & VMS_MULTIPLY) {
1398 size *= field->size;
1399 }
1400 }
1401 if (field->flags & VMS_ARRAY) {
1402 n_elems = field->num;
1403 } else if (field->flags & VMS_VARRAY_INT32) {
1404 n_elems = *(int32_t *)(opaque+field->num_offset);
1405 } else if (field->flags & VMS_VARRAY_UINT16) {
1406 n_elems = *(uint16_t *)(opaque+field->num_offset);
1407 } else if (field->flags & VMS_VARRAY_UINT8) {
1408 n_elems = *(uint8_t *)(opaque+field->num_offset);
1409 }
1410 if (field->flags & VMS_POINTER) {
1411 base_addr = *(void **)base_addr + field->start;
1412 }
1413 for (i = 0; i < n_elems; i++) {
1414 void *addr = base_addr + size * i;
1415
1416 if (field->flags & VMS_ARRAY_OF_POINTER) {
1417 addr = *(void **)addr;
1418 }
1419 if (field->flags & VMS_STRUCT) {
1420 vmstate_save_state(f, field->vmsd, addr);
1421 } else {
1422 field->info->put(f, addr, size);
1423 }
1424 }
1425 }
1426 field++;
1427 }
1428 vmstate_subsection_save(f, vmsd, opaque);
1429 }
1430
1431 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1432 {
1433 if (!se->vmsd) { /* Old style */
1434 return se->load_state(f, se->opaque, version_id);
1435 }
1436 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1437 }
1438
1439 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1440 {
1441 if (!se->vmsd) { /* Old style */
1442 se->save_state(f, se->opaque);
1443 return;
1444 }
1445 vmstate_save_state(f,se->vmsd, se->opaque);
1446 }
1447
1448 #define QEMU_VM_FILE_MAGIC 0x5145564d
1449 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1450 #define QEMU_VM_FILE_VERSION 0x00000003
1451
1452 #define QEMU_VM_EOF 0x00
1453 #define QEMU_VM_SECTION_START 0x01
1454 #define QEMU_VM_SECTION_PART 0x02
1455 #define QEMU_VM_SECTION_END 0x03
1456 #define QEMU_VM_SECTION_FULL 0x04
1457 #define QEMU_VM_SUBSECTION 0x05
1458
1459 bool qemu_savevm_state_blocked(Monitor *mon)
1460 {
1461 SaveStateEntry *se;
1462
1463 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1464 if (se->no_migrate) {
1465 monitor_printf(mon, "state blocked by non-migratable device '%s'\n",
1466 se->idstr);
1467 return true;
1468 }
1469 }
1470 return false;
1471 }
1472
1473 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1474 int shared)
1475 {
1476 SaveStateEntry *se;
1477
1478 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1479 if(se->set_params == NULL) {
1480 continue;
1481 }
1482 se->set_params(blk_enable, shared, se->opaque);
1483 }
1484
1485 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1486 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1487
1488 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1489 int len;
1490
1491 if (se->save_live_state == NULL)
1492 continue;
1493
1494 /* Section type */
1495 qemu_put_byte(f, QEMU_VM_SECTION_START);
1496 qemu_put_be32(f, se->section_id);
1497
1498 /* ID string */
1499 len = strlen(se->idstr);
1500 qemu_put_byte(f, len);
1501 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1502
1503 qemu_put_be32(f, se->instance_id);
1504 qemu_put_be32(f, se->version_id);
1505
1506 se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1507 }
1508
1509 if (qemu_file_has_error(f)) {
1510 qemu_savevm_state_cancel(mon, f);
1511 return -EIO;
1512 }
1513
1514 return 0;
1515 }
1516
1517 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1518 {
1519 SaveStateEntry *se;
1520 int ret = 1;
1521
1522 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1523 if (se->save_live_state == NULL)
1524 continue;
1525
1526 /* Section type */
1527 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1528 qemu_put_be32(f, se->section_id);
1529
1530 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1531 if (!ret) {
1532 /* Do not proceed to the next vmstate before this one reported
1533 completion of the current stage. This serializes the migration
1534 and reduces the probability that a faster changing state is
1535 synchronized over and over again. */
1536 break;
1537 }
1538 }
1539
1540 if (ret)
1541 return 1;
1542
1543 if (qemu_file_has_error(f)) {
1544 qemu_savevm_state_cancel(mon, f);
1545 return -EIO;
1546 }
1547
1548 return 0;
1549 }
1550
1551 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1552 {
1553 SaveStateEntry *se;
1554
1555 cpu_synchronize_all_states();
1556
1557 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1558 if (se->save_live_state == NULL)
1559 continue;
1560
1561 /* Section type */
1562 qemu_put_byte(f, QEMU_VM_SECTION_END);
1563 qemu_put_be32(f, se->section_id);
1564
1565 se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1566 }
1567
1568 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1569 int len;
1570
1571 if (se->save_state == NULL && se->vmsd == NULL)
1572 continue;
1573
1574 /* Section type */
1575 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1576 qemu_put_be32(f, se->section_id);
1577
1578 /* ID string */
1579 len = strlen(se->idstr);
1580 qemu_put_byte(f, len);
1581 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1582
1583 qemu_put_be32(f, se->instance_id);
1584 qemu_put_be32(f, se->version_id);
1585
1586 vmstate_save(f, se);
1587 }
1588
1589 qemu_put_byte(f, QEMU_VM_EOF);
1590
1591 if (qemu_file_has_error(f))
1592 return -EIO;
1593
1594 return 0;
1595 }
1596
1597 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1598 {
1599 SaveStateEntry *se;
1600
1601 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1602 if (se->save_live_state) {
1603 se->save_live_state(mon, f, -1, se->opaque);
1604 }
1605 }
1606 }
1607
1608 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
1609 {
1610 int saved_vm_running;
1611 int ret;
1612
1613 saved_vm_running = runstate_is_running();
1614 vm_stop(RUN_STATE_SAVE_VM);
1615
1616 if (qemu_savevm_state_blocked(mon)) {
1617 ret = -EINVAL;
1618 goto out;
1619 }
1620
1621 ret = qemu_savevm_state_begin(mon, f, 0, 0);
1622 if (ret < 0)
1623 goto out;
1624
1625 do {
1626 ret = qemu_savevm_state_iterate(mon, f);
1627 if (ret < 0)
1628 goto out;
1629 } while (ret == 0);
1630
1631 ret = qemu_savevm_state_complete(mon, f);
1632
1633 out:
1634 if (qemu_file_has_error(f))
1635 ret = -EIO;
1636
1637 if (!ret && saved_vm_running)
1638 vm_start();
1639
1640 return ret;
1641 }
1642
1643 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1644 {
1645 SaveStateEntry *se;
1646
1647 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1648 if (!strcmp(se->idstr, idstr) &&
1649 (instance_id == se->instance_id ||
1650 instance_id == se->alias_id))
1651 return se;
1652 /* Migrating from an older version? */
1653 if (strstr(se->idstr, idstr) && se->compat) {
1654 if (!strcmp(se->compat->idstr, idstr) &&
1655 (instance_id == se->compat->instance_id ||
1656 instance_id == se->alias_id))
1657 return se;
1658 }
1659 }
1660 return NULL;
1661 }
1662
1663 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1664 {
1665 while(sub && sub->needed) {
1666 if (strcmp(idstr, sub->vmsd->name) == 0) {
1667 return sub->vmsd;
1668 }
1669 sub++;
1670 }
1671 return NULL;
1672 }
1673
1674 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1675 void *opaque)
1676 {
1677 const VMStateSubsection *sub = vmsd->subsections;
1678
1679 if (!sub || !sub->needed) {
1680 return 0;
1681 }
1682
1683 while (qemu_peek_byte(f) == QEMU_VM_SUBSECTION) {
1684 char idstr[256];
1685 int ret;
1686 uint8_t version_id, len;
1687 const VMStateDescription *sub_vmsd;
1688
1689 qemu_get_byte(f); /* subsection */
1690 len = qemu_get_byte(f);
1691 qemu_get_buffer(f, (uint8_t *)idstr, len);
1692 idstr[len] = 0;
1693 version_id = qemu_get_be32(f);
1694
1695 sub_vmsd = vmstate_get_subsection(sub, idstr);
1696 if (sub_vmsd == NULL) {
1697 return -ENOENT;
1698 }
1699 assert(!sub_vmsd->subsections);
1700 ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1701 if (ret) {
1702 return ret;
1703 }
1704 }
1705 return 0;
1706 }
1707
1708 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1709 void *opaque)
1710 {
1711 const VMStateSubsection *sub = vmsd->subsections;
1712
1713 while (sub && sub->needed) {
1714 if (sub->needed(opaque)) {
1715 const VMStateDescription *vmsd = sub->vmsd;
1716 uint8_t len;
1717
1718 qemu_put_byte(f, QEMU_VM_SUBSECTION);
1719 len = strlen(vmsd->name);
1720 qemu_put_byte(f, len);
1721 qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1722 qemu_put_be32(f, vmsd->version_id);
1723 assert(!vmsd->subsections);
1724 vmstate_save_state(f, vmsd, opaque);
1725 }
1726 sub++;
1727 }
1728 }
1729
1730 typedef struct LoadStateEntry {
1731 QLIST_ENTRY(LoadStateEntry) entry;
1732 SaveStateEntry *se;
1733 int section_id;
1734 int version_id;
1735 } LoadStateEntry;
1736
1737 int qemu_loadvm_state(QEMUFile *f)
1738 {
1739 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1740 QLIST_HEAD_INITIALIZER(loadvm_handlers);
1741 LoadStateEntry *le, *new_le;
1742 uint8_t section_type;
1743 unsigned int v;
1744 int ret;
1745
1746 if (qemu_savevm_state_blocked(default_mon)) {
1747 return -EINVAL;
1748 }
1749
1750 v = qemu_get_be32(f);
1751 if (v != QEMU_VM_FILE_MAGIC)
1752 return -EINVAL;
1753
1754 v = qemu_get_be32(f);
1755 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1756 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1757 return -ENOTSUP;
1758 }
1759 if (v != QEMU_VM_FILE_VERSION)
1760 return -ENOTSUP;
1761
1762 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1763 uint32_t instance_id, version_id, section_id;
1764 SaveStateEntry *se;
1765 char idstr[257];
1766 int len;
1767
1768 switch (section_type) {
1769 case QEMU_VM_SECTION_START:
1770 case QEMU_VM_SECTION_FULL:
1771 /* Read section start */
1772 section_id = qemu_get_be32(f);
1773 len = qemu_get_byte(f);
1774 qemu_get_buffer(f, (uint8_t *)idstr, len);
1775 idstr[len] = 0;
1776 instance_id = qemu_get_be32(f);
1777 version_id = qemu_get_be32(f);
1778
1779 /* Find savevm section */
1780 se = find_se(idstr, instance_id);
1781 if (se == NULL) {
1782 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1783 ret = -EINVAL;
1784 goto out;
1785 }
1786
1787 /* Validate version */
1788 if (version_id > se->version_id) {
1789 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1790 version_id, idstr, se->version_id);
1791 ret = -EINVAL;
1792 goto out;
1793 }
1794
1795 /* Add entry */
1796 le = g_malloc0(sizeof(*le));
1797
1798 le->se = se;
1799 le->section_id = section_id;
1800 le->version_id = version_id;
1801 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1802
1803 ret = vmstate_load(f, le->se, le->version_id);
1804 if (ret < 0) {
1805 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1806 instance_id, idstr);
1807 goto out;
1808 }
1809 break;
1810 case QEMU_VM_SECTION_PART:
1811 case QEMU_VM_SECTION_END:
1812 section_id = qemu_get_be32(f);
1813
1814 QLIST_FOREACH(le, &loadvm_handlers, entry) {
1815 if (le->section_id == section_id) {
1816 break;
1817 }
1818 }
1819 if (le == NULL) {
1820 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1821 ret = -EINVAL;
1822 goto out;
1823 }
1824
1825 ret = vmstate_load(f, le->se, le->version_id);
1826 if (ret < 0) {
1827 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1828 section_id);
1829 goto out;
1830 }
1831 break;
1832 default:
1833 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1834 ret = -EINVAL;
1835 goto out;
1836 }
1837 }
1838
1839 cpu_synchronize_all_post_init();
1840
1841 ret = 0;
1842
1843 out:
1844 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1845 QLIST_REMOVE(le, entry);
1846 g_free(le);
1847 }
1848
1849 if (qemu_file_has_error(f))
1850 ret = -EIO;
1851
1852 return ret;
1853 }
1854
1855 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1856 const char *name)
1857 {
1858 QEMUSnapshotInfo *sn_tab, *sn;
1859 int nb_sns, i, ret;
1860
1861 ret = -ENOENT;
1862 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1863 if (nb_sns < 0)
1864 return ret;
1865 for(i = 0; i < nb_sns; i++) {
1866 sn = &sn_tab[i];
1867 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1868 *sn_info = *sn;
1869 ret = 0;
1870 break;
1871 }
1872 }
1873 g_free(sn_tab);
1874 return ret;
1875 }
1876
1877 /*
1878 * Deletes snapshots of a given name in all opened images.
1879 */
1880 static int del_existing_snapshots(Monitor *mon, const char *name)
1881 {
1882 BlockDriverState *bs;
1883 QEMUSnapshotInfo sn1, *snapshot = &sn1;
1884 int ret;
1885
1886 bs = NULL;
1887 while ((bs = bdrv_next(bs))) {
1888 if (bdrv_can_snapshot(bs) &&
1889 bdrv_snapshot_find(bs, snapshot, name) >= 0)
1890 {
1891 ret = bdrv_snapshot_delete(bs, name);
1892 if (ret < 0) {
1893 monitor_printf(mon,
1894 "Error while deleting snapshot on '%s'\n",
1895 bdrv_get_device_name(bs));
1896 return -1;
1897 }
1898 }
1899 }
1900
1901 return 0;
1902 }
1903
1904 void do_savevm(Monitor *mon, const QDict *qdict)
1905 {
1906 BlockDriverState *bs, *bs1;
1907 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1908 int ret;
1909 QEMUFile *f;
1910 int saved_vm_running;
1911 uint32_t vm_state_size;
1912 #ifdef _WIN32
1913 struct _timeb tb;
1914 struct tm *ptm;
1915 #else
1916 struct timeval tv;
1917 struct tm tm;
1918 #endif
1919 const char *name = qdict_get_try_str(qdict, "name");
1920
1921 /* Verify if there is a device that doesn't support snapshots and is writable */
1922 bs = NULL;
1923 while ((bs = bdrv_next(bs))) {
1924
1925 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
1926 continue;
1927 }
1928
1929 if (!bdrv_can_snapshot(bs)) {
1930 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1931 bdrv_get_device_name(bs));
1932 return;
1933 }
1934 }
1935
1936 bs = bdrv_snapshots();
1937 if (!bs) {
1938 monitor_printf(mon, "No block device can accept snapshots\n");
1939 return;
1940 }
1941
1942 saved_vm_running = runstate_is_running();
1943 vm_stop(RUN_STATE_SAVE_VM);
1944
1945 memset(sn, 0, sizeof(*sn));
1946
1947 /* fill auxiliary fields */
1948 #ifdef _WIN32
1949 _ftime(&tb);
1950 sn->date_sec = tb.time;
1951 sn->date_nsec = tb.millitm * 1000000;
1952 #else
1953 gettimeofday(&tv, NULL);
1954 sn->date_sec = tv.tv_sec;
1955 sn->date_nsec = tv.tv_usec * 1000;
1956 #endif
1957 sn->vm_clock_nsec = qemu_get_clock_ns(vm_clock);
1958
1959 if (name) {
1960 ret = bdrv_snapshot_find(bs, old_sn, name);
1961 if (ret >= 0) {
1962 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
1963 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
1964 } else {
1965 pstrcpy(sn->name, sizeof(sn->name), name);
1966 }
1967 } else {
1968 #ifdef _WIN32
1969 ptm = localtime(&tb.time);
1970 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", ptm);
1971 #else
1972 /* cast below needed for OpenBSD where tv_sec is still 'long' */
1973 localtime_r((const time_t *)&tv.tv_sec, &tm);
1974 strftime(sn->name, sizeof(sn->name), "vm-%Y%m%d%H%M%S", &tm);
1975 #endif
1976 }
1977
1978 /* Delete old snapshots of the same name */
1979 if (name && del_existing_snapshots(mon, name) < 0) {
1980 goto the_end;
1981 }
1982
1983 /* save the VM state */
1984 f = qemu_fopen_bdrv(bs, 1);
1985 if (!f) {
1986 monitor_printf(mon, "Could not open VM state file\n");
1987 goto the_end;
1988 }
1989 ret = qemu_savevm_state(mon, f);
1990 vm_state_size = qemu_ftell(f);
1991 qemu_fclose(f);
1992 if (ret < 0) {
1993 monitor_printf(mon, "Error %d while writing VM\n", ret);
1994 goto the_end;
1995 }
1996
1997 /* create the snapshots */
1998
1999 bs1 = NULL;
2000 while ((bs1 = bdrv_next(bs1))) {
2001 if (bdrv_can_snapshot(bs1)) {
2002 /* Write VM state size only to the image that contains the state */
2003 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
2004 ret = bdrv_snapshot_create(bs1, sn);
2005 if (ret < 0) {
2006 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
2007 bdrv_get_device_name(bs1));
2008 }
2009 }
2010 }
2011
2012 the_end:
2013 if (saved_vm_running)
2014 vm_start();
2015 }
2016
2017 int load_vmstate(const char *name)
2018 {
2019 BlockDriverState *bs, *bs_vm_state;
2020 QEMUSnapshotInfo sn;
2021 QEMUFile *f;
2022 int ret;
2023
2024 bs_vm_state = bdrv_snapshots();
2025 if (!bs_vm_state) {
2026 error_report("No block device supports snapshots");
2027 return -ENOTSUP;
2028 }
2029
2030 /* Don't even try to load empty VM states */
2031 ret = bdrv_snapshot_find(bs_vm_state, &sn, name);
2032 if (ret < 0) {
2033 return ret;
2034 } else if (sn.vm_state_size == 0) {
2035 error_report("This is a disk-only snapshot. Revert to it offline "
2036 "using qemu-img.");
2037 return -EINVAL;
2038 }
2039
2040 /* Verify if there is any device that doesn't support snapshots and is
2041 writable and check if the requested snapshot is available too. */
2042 bs = NULL;
2043 while ((bs = bdrv_next(bs))) {
2044
2045 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
2046 continue;
2047 }
2048
2049 if (!bdrv_can_snapshot(bs)) {
2050 error_report("Device '%s' is writable but does not support snapshots.",
2051 bdrv_get_device_name(bs));
2052 return -ENOTSUP;
2053 }
2054
2055 ret = bdrv_snapshot_find(bs, &sn, name);
2056 if (ret < 0) {
2057 error_report("Device '%s' does not have the requested snapshot '%s'",
2058 bdrv_get_device_name(bs), name);
2059 return ret;
2060 }
2061 }
2062
2063 /* Flush all IO requests so they don't interfere with the new state. */
2064 qemu_aio_flush();
2065
2066 bs = NULL;
2067 while ((bs = bdrv_next(bs))) {
2068 if (bdrv_can_snapshot(bs)) {
2069 ret = bdrv_snapshot_goto(bs, name);
2070 if (ret < 0) {
2071 error_report("Error %d while activating snapshot '%s' on '%s'",
2072 ret, name, bdrv_get_device_name(bs));
2073 return ret;
2074 }
2075 }
2076 }
2077
2078 /* restore the VM state */
2079 f = qemu_fopen_bdrv(bs_vm_state, 0);
2080 if (!f) {
2081 error_report("Could not open VM state file");
2082 return -EINVAL;
2083 }
2084
2085 qemu_system_reset(VMRESET_SILENT);
2086 ret = qemu_loadvm_state(f);
2087
2088 qemu_fclose(f);
2089 if (ret < 0) {
2090 error_report("Error %d while loading VM state", ret);
2091 return ret;
2092 }
2093
2094 return 0;
2095 }
2096
2097 void do_delvm(Monitor *mon, const QDict *qdict)
2098 {
2099 BlockDriverState *bs, *bs1;
2100 int ret;
2101 const char *name = qdict_get_str(qdict, "name");
2102
2103 bs = bdrv_snapshots();
2104 if (!bs) {
2105 monitor_printf(mon, "No block device supports snapshots\n");
2106 return;
2107 }
2108
2109 bs1 = NULL;
2110 while ((bs1 = bdrv_next(bs1))) {
2111 if (bdrv_can_snapshot(bs1)) {
2112 ret = bdrv_snapshot_delete(bs1, name);
2113 if (ret < 0) {
2114 if (ret == -ENOTSUP)
2115 monitor_printf(mon,
2116 "Snapshots not supported on device '%s'\n",
2117 bdrv_get_device_name(bs1));
2118 else
2119 monitor_printf(mon, "Error %d while deleting snapshot on "
2120 "'%s'\n", ret, bdrv_get_device_name(bs1));
2121 }
2122 }
2123 }
2124 }
2125
2126 void do_info_snapshots(Monitor *mon)
2127 {
2128 BlockDriverState *bs, *bs1;
2129 QEMUSnapshotInfo *sn_tab, *sn, s, *sn_info = &s;
2130 int nb_sns, i, ret, available;
2131 int total;
2132 int *available_snapshots;
2133 char buf[256];
2134
2135 bs = bdrv_snapshots();
2136 if (!bs) {
2137 monitor_printf(mon, "No available block device supports snapshots\n");
2138 return;
2139 }
2140
2141 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2142 if (nb_sns < 0) {
2143 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2144 return;
2145 }
2146
2147 if (nb_sns == 0) {
2148 monitor_printf(mon, "There is no snapshot available.\n");
2149 return;
2150 }
2151
2152 available_snapshots = g_malloc0(sizeof(int) * nb_sns);
2153 total = 0;
2154 for (i = 0; i < nb_sns; i++) {
2155 sn = &sn_tab[i];
2156 available = 1;
2157 bs1 = NULL;
2158
2159 while ((bs1 = bdrv_next(bs1))) {
2160 if (bdrv_can_snapshot(bs1) && bs1 != bs) {
2161 ret = bdrv_snapshot_find(bs1, sn_info, sn->id_str);
2162 if (ret < 0) {
2163 available = 0;
2164 break;
2165 }
2166 }
2167 }
2168
2169 if (available) {
2170 available_snapshots[total] = i;
2171 total++;
2172 }
2173 }
2174
2175 if (total > 0) {
2176 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2177 for (i = 0; i < total; i++) {
2178 sn = &sn_tab[available_snapshots[i]];
2179 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2180 }
2181 } else {
2182 monitor_printf(mon, "There is no suitable snapshot available\n");
2183 }
2184
2185 g_free(sn_tab);
2186 g_free(available_snapshots);
2187
2188 }