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