]> git.proxmox.com Git - qemu.git/blame - savevm.c
pc: Avoid registering zero sized memory
[qemu.git] / savevm.c
CommitLineData
a672b469
AL
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 */
a672b469
AL
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
71e72a19 32/* Needed early for CONFIG_BSD etc. */
d40cdb10
BS
33#include "config-host.h"
34
a672b469
AL
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>
a672b469
AL
45#include <arpa/inet.h>
46#include <dirent.h>
47#include <netdb.h>
48#include <sys/select.h>
71e72a19 49#ifdef CONFIG_BSD
a672b469 50#include <sys/stat.h>
a167ba50 51#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
a672b469
AL
52#include <libutil.h>
53#else
54#include <util.h>
55#endif
a672b469
AL
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
49dc768d 65#include <windows.h>
a672b469
AL
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
511d2b14
BS
73#include "qemu-common.h"
74#include "hw/hw.h"
7685ee6a 75#include "hw/qdev.h"
511d2b14
BS
76#include "net.h"
77#include "monitor.h"
78#include "sysemu.h"
79#include "qemu-timer.h"
80#include "qemu-char.h"
666daa68 81#include "blockdev.h"
511d2b14
BS
82#include "audio/audio.h"
83#include "migration.h"
84#include "qemu_socket.h"
72cf2d4f 85#include "qemu-queue.h"
511d2b14 86
a672b469 87#define SELF_ANNOUNCE_ROUNDS 5
a672b469 88
18995b98 89#ifndef ETH_P_RARP
f8778a77 90#define ETH_P_RARP 0x8035
18995b98
N
91#endif
92#define ARP_HTYPE_ETH 0x0001
93#define ARP_PTYPE_IP 0x0800
94#define ARP_OP_REQUEST_REV 0x3
95
96static int announce_self_create(uint8_t *buf,
a672b469
AL
97 uint8_t *mac_addr)
98{
18995b98
N
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) */
a672b469
AL
119}
120
f401ca22 121static void qemu_announce_self_iter(NICState *nic, void *opaque)
a672b469 122{
18995b98 123 uint8_t buf[60];
f401ca22
MM
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
132static void qemu_announce_self_once(void *opaque)
133{
ed8b330b
GN
134 static int count = SELF_ANNOUNCE_ROUNDS;
135 QEMUTimer *timer = *(QEMUTimer **)opaque;
a672b469 136
f401ca22
MM
137 qemu_foreach_nic(qemu_announce_self_iter, NULL);
138
18995b98
N
139 if (--count) {
140 /* delay 50ms, 150ms, 250ms, ... */
141 qemu_mod_timer(timer, qemu_get_clock(rt_clock) +
142 50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
ed8b330b
GN
143 } else {
144 qemu_del_timer(timer);
145 qemu_free_timer(timer);
146 }
147}
148
149void qemu_announce_self(void)
150{
151 static QEMUTimer *timer;
152 timer = qemu_new_timer(rt_clock, qemu_announce_self_once, &timer);
153 qemu_announce_self_once(&timer);
a672b469
AL
154}
155
156/***********************************************************/
157/* savevm/loadvm support */
158
159#define IO_BUF_SIZE 32768
160
161struct QEMUFile {
162 QEMUFilePutBufferFunc *put_buffer;
163 QEMUFileGetBufferFunc *get_buffer;
164 QEMUFileCloseFunc *close;
165 QEMUFileRateLimit *rate_limit;
19629537 166 QEMUFileSetRateLimit *set_rate_limit;
c163b5ca 167 QEMUFileGetRateLimit *get_rate_limit;
a672b469
AL
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
7f79dd28 180typedef struct QEMUFileStdio
a672b469 181{
7f79dd28 182 FILE *stdio_file;
a672b469 183 QEMUFile *file;
7f79dd28 184} QEMUFileStdio;
a672b469
AL
185
186typedef struct QEMUFileSocket
187{
188 int fd;
189 QEMUFile *file;
190} QEMUFileSocket;
191
192static 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 {
c5b76b38 198 len = recv(s->fd, (void *)buf, size, 0);
a672b469
AL
199 } while (len == -1 && socket_error() == EINTR);
200
201 if (len == -1)
202 len = -socket_error();
203
204 return len;
205}
206
207static int socket_close(void *opaque)
208{
209 QEMUFileSocket *s = opaque;
210 qemu_free(s);
211 return 0;
212}
213
7f79dd28 214static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
a672b469 215{
7f79dd28
PB
216 QEMUFileStdio *s = opaque;
217 return fwrite(buf, 1, size, s->stdio_file);
a672b469
AL
218}
219
7f79dd28 220static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
a672b469 221{
7f79dd28
PB
222 QEMUFileStdio *s = opaque;
223 FILE *fp = s->stdio_file;
8a67ec4d
UL
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;
a672b469
AL
231}
232
7f79dd28
PB
233static int stdio_pclose(void *opaque)
234{
235 QEMUFileStdio *s = opaque;
41ef56e6
AL
236 int ret;
237 ret = pclose(s->stdio_file);
7f79dd28 238 qemu_free(s);
41ef56e6 239 return ret;
7f79dd28
PB
240}
241
242static int stdio_fclose(void *opaque)
a672b469 243{
7f79dd28
PB
244 QEMUFileStdio *s = opaque;
245 fclose(s->stdio_file);
a672b469
AL
246 qemu_free(s);
247 return 0;
248}
249
7f79dd28 250QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
a672b469 251{
7f79dd28 252 QEMUFileStdio *s;
a672b469 253
7f79dd28 254 if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
a672b469
AL
255 fprintf(stderr, "qemu_popen: Argument validity check failed\n");
256 return NULL;
257 }
258
7f79dd28 259 s = qemu_mallocz(sizeof(QEMUFileStdio));
a672b469 260
7f79dd28 261 s->stdio_file = stdio_file;
a672b469
AL
262
263 if(mode[0] == 'r') {
c163b5ca 264 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose,
265 NULL, NULL, NULL);
a672b469 266 } else {
c163b5ca 267 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose,
268 NULL, NULL, NULL);
a672b469 269 }
a672b469
AL
270 return s->file;
271}
272
273QEMUFile *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
7f79dd28 285int qemu_stdio_fd(QEMUFile *f)
8a43b1ea 286{
7f79dd28 287 QEMUFileStdio *p;
8a43b1ea
CL
288 int fd;
289
7f79dd28
PB
290 p = (QEMUFileStdio *)f->opaque;
291 fd = fileno(p->stdio_file);
8a43b1ea
CL
292
293 return fd;
294}
295
5ac1fad3
PB
296QEMUFile *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') {
c163b5ca 313 s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose,
314 NULL, NULL, NULL);
5ac1fad3 315 } else {
c163b5ca 316 s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose,
317 NULL, NULL, NULL);
5ac1fad3
PB
318 }
319 return s->file;
320
321fail:
322 qemu_free(s);
323 return NULL;
324}
325
a672b469
AL
326QEMUFile *qemu_fopen_socket(int fd)
327{
328 QEMUFileSocket *s = qemu_mallocz(sizeof(QEMUFileSocket));
329
a672b469 330 s->fd = fd;
c163b5ca 331 s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close,
332 NULL, NULL, NULL);
a672b469
AL
333 return s->file;
334}
335
a672b469
AL
336static int file_put_buffer(void *opaque, const uint8_t *buf,
337 int64_t pos, int size)
338{
339 QEMUFileStdio *s = opaque;
7f79dd28 340 fseek(s->stdio_file, pos, SEEK_SET);
5fdb3aa1 341 return fwrite(buf, 1, size, s->stdio_file);
a672b469
AL
342}
343
344static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
345{
346 QEMUFileStdio *s = opaque;
7f79dd28
PB
347 fseek(s->stdio_file, pos, SEEK_SET);
348 return fread(buf, 1, size, s->stdio_file);
a672b469
AL
349}
350
351QEMUFile *qemu_fopen(const char *filename, const char *mode)
352{
353 QEMUFileStdio *s;
354
7f79dd28
PB
355 if (mode == NULL ||
356 (mode[0] != 'r' && mode[0] != 'w') ||
357 mode[1] != 'b' || mode[2] != 0) {
090414a3 358 fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
7f79dd28
PB
359 return NULL;
360 }
361
a672b469 362 s = qemu_mallocz(sizeof(QEMUFileStdio));
a672b469 363
7f79dd28
PB
364 s->stdio_file = fopen(filename, mode);
365 if (!s->stdio_file)
a672b469 366 goto fail;
c163b5ca 367
7f79dd28 368 if(mode[0] == 'w') {
c163b5ca 369 s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose,
370 NULL, NULL, NULL);
7f79dd28 371 } else {
c163b5ca 372 s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose,
373 NULL, NULL, NULL);
7f79dd28
PB
374 }
375 return s->file;
a672b469 376fail:
a672b469
AL
377 qemu_free(s);
378 return NULL;
379}
380
178e08a5 381static int block_put_buffer(void *opaque, const uint8_t *buf,
a672b469
AL
382 int64_t pos, int size)
383{
45566e9c 384 bdrv_save_vmstate(opaque, buf, pos, size);
a672b469
AL
385 return size;
386}
387
178e08a5 388static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
a672b469 389{
45566e9c 390 return bdrv_load_vmstate(opaque, buf, pos, size);
a672b469
AL
391}
392
393static int bdrv_fclose(void *opaque)
394{
a672b469
AL
395 return 0;
396}
397
45566e9c 398static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
a672b469 399{
a672b469 400 if (is_writable)
c163b5ca 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);
a672b469
AL
404}
405
406QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
407 QEMUFileGetBufferFunc *get_buffer,
408 QEMUFileCloseFunc *close,
19629537 409 QEMUFileRateLimit *rate_limit,
c163b5ca 410 QEMUFileSetRateLimit *set_rate_limit,
411 QEMUFileGetRateLimit *get_rate_limit)
a672b469
AL
412{
413 QEMUFile *f;
414
415 f = qemu_mallocz(sizeof(QEMUFile));
a672b469
AL
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;
19629537 422 f->set_rate_limit = set_rate_limit;
c163b5ca 423 f->get_rate_limit = get_rate_limit;
a672b469
AL
424 f->is_write = 0;
425
426 return f;
427}
428
429int qemu_file_has_error(QEMUFile *f)
430{
431 return f->has_error;
432}
433
4dabe248
AL
434void qemu_file_set_error(QEMUFile *f)
435{
436 f->has_error = 1;
437}
438
a672b469
AL
439void 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
456static 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
475int 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
485void qemu_file_put_notify(QEMUFile *f)
486{
487 f->put_buffer(f->opaque, NULL, 0, 0);
488}
489
490void 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
514void 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
528int 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
554int qemu_get_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
567int64_t qemu_ftell(QEMUFile *f)
568{
569 return f->buf_offset - f->buf_size + f->buf_index;
570}
571
572int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
573{
574 if (whence == SEEK_SET) {
575 /* nothing to do */
576 } else if (whence == SEEK_CUR) {
577 pos += qemu_ftell(f);
578 } else {
579 /* SEEK_END not supported */
580 return -1;
581 }
582 if (f->put_buffer) {
583 qemu_fflush(f);
584 f->buf_offset = pos;
585 } else {
586 f->buf_offset = pos;
587 f->buf_index = 0;
588 f->buf_size = 0;
589 }
590 return pos;
591}
592
593int qemu_file_rate_limit(QEMUFile *f)
594{
595 if (f->rate_limit)
596 return f->rate_limit(f->opaque);
597
598 return 0;
599}
600
c163b5ca 601size_t qemu_file_get_rate_limit(QEMUFile *f)
602{
603 if (f->get_rate_limit)
604 return f->get_rate_limit(f->opaque);
605
606 return 0;
607}
608
19629537
GC
609size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate)
610{
0bb05eaf
GC
611 /* any failed or completed migration keeps its state to allow probing of
612 * migration data, but has no associated file anymore */
613 if (f && f->set_rate_limit)
19629537
GC
614 return f->set_rate_limit(f->opaque, new_rate);
615
616 return 0;
617}
618
a672b469
AL
619void qemu_put_be16(QEMUFile *f, unsigned int v)
620{
621 qemu_put_byte(f, v >> 8);
622 qemu_put_byte(f, v);
623}
624
625void qemu_put_be32(QEMUFile *f, unsigned int v)
626{
627 qemu_put_byte(f, v >> 24);
628 qemu_put_byte(f, v >> 16);
629 qemu_put_byte(f, v >> 8);
630 qemu_put_byte(f, v);
631}
632
633void qemu_put_be64(QEMUFile *f, uint64_t v)
634{
635 qemu_put_be32(f, v >> 32);
636 qemu_put_be32(f, v);
637}
638
639unsigned int qemu_get_be16(QEMUFile *f)
640{
641 unsigned int v;
642 v = qemu_get_byte(f) << 8;
643 v |= qemu_get_byte(f);
644 return v;
645}
646
647unsigned int qemu_get_be32(QEMUFile *f)
648{
649 unsigned int v;
650 v = qemu_get_byte(f) << 24;
651 v |= qemu_get_byte(f) << 16;
652 v |= qemu_get_byte(f) << 8;
653 v |= qemu_get_byte(f);
654 return v;
655}
656
657uint64_t qemu_get_be64(QEMUFile *f)
658{
659 uint64_t v;
660 v = (uint64_t)qemu_get_be32(f) << 32;
661 v |= qemu_get_be32(f);
662 return v;
663}
664
9ed7d6ae
JQ
665/* 8 bit int */
666
667static int get_int8(QEMUFile *f, void *pv, size_t size)
668{
669 int8_t *v = pv;
670 qemu_get_s8s(f, v);
671 return 0;
672}
673
84e2e3eb 674static void put_int8(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 675{
84e2e3eb 676 int8_t *v = pv;
9ed7d6ae
JQ
677 qemu_put_s8s(f, v);
678}
679
680const VMStateInfo vmstate_info_int8 = {
681 .name = "int8",
682 .get = get_int8,
683 .put = put_int8,
684};
685
686/* 16 bit int */
687
688static int get_int16(QEMUFile *f, void *pv, size_t size)
689{
690 int16_t *v = pv;
691 qemu_get_sbe16s(f, v);
692 return 0;
693}
694
84e2e3eb 695static void put_int16(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 696{
84e2e3eb 697 int16_t *v = pv;
9ed7d6ae
JQ
698 qemu_put_sbe16s(f, v);
699}
700
701const VMStateInfo vmstate_info_int16 = {
702 .name = "int16",
703 .get = get_int16,
704 .put = put_int16,
705};
706
707/* 32 bit int */
708
709static int get_int32(QEMUFile *f, void *pv, size_t size)
710{
711 int32_t *v = pv;
712 qemu_get_sbe32s(f, v);
713 return 0;
714}
715
84e2e3eb 716static void put_int32(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 717{
84e2e3eb 718 int32_t *v = pv;
9ed7d6ae
JQ
719 qemu_put_sbe32s(f, v);
720}
721
722const VMStateInfo vmstate_info_int32 = {
723 .name = "int32",
724 .get = get_int32,
725 .put = put_int32,
726};
727
82501660
JQ
728/* 32 bit int. See that the received value is the same than the one
729 in the field */
730
731static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
732{
733 int32_t *v = pv;
734 int32_t v2;
735 qemu_get_sbe32s(f, &v2);
736
737 if (*v == v2)
738 return 0;
739 return -EINVAL;
740}
741
742const VMStateInfo vmstate_info_int32_equal = {
743 .name = "int32 equal",
744 .get = get_int32_equal,
745 .put = put_int32,
746};
747
0a031e0a
JQ
748/* 32 bit int. See that the received value is the less or the same
749 than the one in the field */
750
751static int get_int32_le(QEMUFile *f, void *pv, size_t size)
752{
753 int32_t *old = pv;
754 int32_t new;
755 qemu_get_sbe32s(f, &new);
756
757 if (*old <= new)
758 return 0;
759 return -EINVAL;
760}
761
762const VMStateInfo vmstate_info_int32_le = {
763 .name = "int32 equal",
764 .get = get_int32_le,
765 .put = put_int32,
766};
767
9ed7d6ae
JQ
768/* 64 bit int */
769
770static int get_int64(QEMUFile *f, void *pv, size_t size)
771{
772 int64_t *v = pv;
773 qemu_get_sbe64s(f, v);
774 return 0;
775}
776
84e2e3eb 777static void put_int64(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 778{
84e2e3eb 779 int64_t *v = pv;
9ed7d6ae
JQ
780 qemu_put_sbe64s(f, v);
781}
782
783const VMStateInfo vmstate_info_int64 = {
784 .name = "int64",
785 .get = get_int64,
786 .put = put_int64,
787};
788
789/* 8 bit unsigned int */
790
791static int get_uint8(QEMUFile *f, void *pv, size_t size)
792{
793 uint8_t *v = pv;
794 qemu_get_8s(f, v);
795 return 0;
796}
797
84e2e3eb 798static void put_uint8(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 799{
84e2e3eb 800 uint8_t *v = pv;
9ed7d6ae
JQ
801 qemu_put_8s(f, v);
802}
803
804const VMStateInfo vmstate_info_uint8 = {
805 .name = "uint8",
806 .get = get_uint8,
807 .put = put_uint8,
808};
809
810/* 16 bit unsigned int */
811
812static int get_uint16(QEMUFile *f, void *pv, size_t size)
813{
814 uint16_t *v = pv;
815 qemu_get_be16s(f, v);
816 return 0;
817}
818
84e2e3eb 819static void put_uint16(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 820{
84e2e3eb 821 uint16_t *v = pv;
9ed7d6ae
JQ
822 qemu_put_be16s(f, v);
823}
824
825const VMStateInfo vmstate_info_uint16 = {
826 .name = "uint16",
827 .get = get_uint16,
828 .put = put_uint16,
829};
830
831/* 32 bit unsigned int */
832
833static int get_uint32(QEMUFile *f, void *pv, size_t size)
834{
835 uint32_t *v = pv;
836 qemu_get_be32s(f, v);
837 return 0;
838}
839
84e2e3eb 840static void put_uint32(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 841{
84e2e3eb 842 uint32_t *v = pv;
9ed7d6ae
JQ
843 qemu_put_be32s(f, v);
844}
845
846const VMStateInfo vmstate_info_uint32 = {
847 .name = "uint32",
848 .get = get_uint32,
849 .put = put_uint32,
850};
851
852/* 64 bit unsigned int */
853
854static int get_uint64(QEMUFile *f, void *pv, size_t size)
855{
856 uint64_t *v = pv;
857 qemu_get_be64s(f, v);
858 return 0;
859}
860
84e2e3eb 861static void put_uint64(QEMUFile *f, void *pv, size_t size)
9ed7d6ae 862{
84e2e3eb 863 uint64_t *v = pv;
9ed7d6ae
JQ
864 qemu_put_be64s(f, v);
865}
866
867const VMStateInfo vmstate_info_uint64 = {
868 .name = "uint64",
869 .get = get_uint64,
870 .put = put_uint64,
871};
872
80cd83e7
JQ
873/* 8 bit int. See that the received value is the same than the one
874 in the field */
875
876static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
877{
878 uint8_t *v = pv;
879 uint8_t v2;
880 qemu_get_8s(f, &v2);
881
882 if (*v == v2)
883 return 0;
884 return -EINVAL;
885}
886
887const VMStateInfo vmstate_info_uint8_equal = {
aa1cce69 888 .name = "uint8 equal",
80cd83e7
JQ
889 .get = get_uint8_equal,
890 .put = put_uint8,
891};
892
dc3b83a0
JQ
893/* 16 bit unsigned int int. See that the received value is the same than the one
894 in the field */
895
896static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
897{
898 uint16_t *v = pv;
899 uint16_t v2;
900 qemu_get_be16s(f, &v2);
901
902 if (*v == v2)
903 return 0;
904 return -EINVAL;
905}
906
907const VMStateInfo vmstate_info_uint16_equal = {
908 .name = "uint16 equal",
909 .get = get_uint16_equal,
910 .put = put_uint16,
911};
912
dde0463b
JQ
913/* timers */
914
915static int get_timer(QEMUFile *f, void *pv, size_t size)
916{
917 QEMUTimer *v = pv;
918 qemu_get_timer(f, v);
919 return 0;
920}
921
84e2e3eb 922static void put_timer(QEMUFile *f, void *pv, size_t size)
dde0463b 923{
84e2e3eb 924 QEMUTimer *v = pv;
dde0463b
JQ
925 qemu_put_timer(f, v);
926}
927
928const VMStateInfo vmstate_info_timer = {
929 .name = "timer",
930 .get = get_timer,
931 .put = put_timer,
932};
933
6f67c50f
JQ
934/* uint8_t buffers */
935
936static int get_buffer(QEMUFile *f, void *pv, size_t size)
937{
938 uint8_t *v = pv;
939 qemu_get_buffer(f, v, size);
940 return 0;
941}
942
84e2e3eb 943static void put_buffer(QEMUFile *f, void *pv, size_t size)
6f67c50f 944{
84e2e3eb 945 uint8_t *v = pv;
6f67c50f
JQ
946 qemu_put_buffer(f, v, size);
947}
948
949const VMStateInfo vmstate_info_buffer = {
950 .name = "buffer",
951 .get = get_buffer,
952 .put = put_buffer,
953};
954
76507c75
JQ
955/* unused buffers: space that was used for some fields that are
956 not usefull anymore */
957
958static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
959{
21174c34
JK
960 uint8_t buf[1024];
961 int block_len;
962
963 while (size > 0) {
964 block_len = MIN(sizeof(buf), size);
965 size -= block_len;
966 qemu_get_buffer(f, buf, block_len);
967 }
968 return 0;
76507c75
JQ
969}
970
971static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
972{
21174c34
JK
973 static const uint8_t buf[1024];
974 int block_len;
975
976 while (size > 0) {
977 block_len = MIN(sizeof(buf), size);
978 size -= block_len;
979 qemu_put_buffer(f, buf, block_len);
980 }
76507c75
JQ
981}
982
983const VMStateInfo vmstate_info_unused_buffer = {
984 .name = "unused_buffer",
985 .get = get_unused_buffer,
986 .put = put_unused_buffer,
987};
988
7685ee6a
AW
989typedef struct CompatEntry {
990 char idstr[256];
991 int instance_id;
992} CompatEntry;
993
a672b469 994typedef struct SaveStateEntry {
72cf2d4f 995 QTAILQ_ENTRY(SaveStateEntry) entry;
a672b469
AL
996 char idstr[256];
997 int instance_id;
4d2ffa08 998 int alias_id;
a672b469
AL
999 int version_id;
1000 int section_id;
c163b5ca 1001 SaveSetParamsHandler *set_params;
a672b469
AL
1002 SaveLiveStateHandler *save_live_state;
1003 SaveStateHandler *save_state;
1004 LoadStateHandler *load_state;
9ed7d6ae 1005 const VMStateDescription *vmsd;
a672b469 1006 void *opaque;
7685ee6a 1007 CompatEntry *compat;
a672b469
AL
1008} SaveStateEntry;
1009
c163b5ca 1010
72cf2d4f
BS
1011static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1012 QTAILQ_HEAD_INITIALIZER(savevm_handlers);
9ed7d6ae 1013static int global_section_id;
a672b469 1014
8718e999
JQ
1015static int calculate_new_instance_id(const char *idstr)
1016{
1017 SaveStateEntry *se;
1018 int instance_id = 0;
1019
72cf2d4f 1020 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
8718e999
JQ
1021 if (strcmp(idstr, se->idstr) == 0
1022 && instance_id <= se->instance_id) {
1023 instance_id = se->instance_id + 1;
1024 }
1025 }
1026 return instance_id;
1027}
1028
7685ee6a
AW
1029static int calculate_compat_instance_id(const char *idstr)
1030{
1031 SaveStateEntry *se;
1032 int instance_id = 0;
1033
1034 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1035 if (!se->compat)
1036 continue;
1037
1038 if (strcmp(idstr, se->compat->idstr) == 0
1039 && instance_id <= se->compat->instance_id) {
1040 instance_id = se->compat->instance_id + 1;
1041 }
1042 }
1043 return instance_id;
1044}
1045
a672b469
AL
1046/* TODO: Individual devices generally have very little idea about the rest
1047 of the system, so instance_id should be removed/replaced.
1048 Meanwhile pass -1 as instance_id if you do not already have a clearly
1049 distinguishing id for all instances of your device class. */
0be71e32
AW
1050int register_savevm_live(DeviceState *dev,
1051 const char *idstr,
a672b469
AL
1052 int instance_id,
1053 int version_id,
c163b5ca 1054 SaveSetParamsHandler *set_params,
a672b469
AL
1055 SaveLiveStateHandler *save_live_state,
1056 SaveStateHandler *save_state,
1057 LoadStateHandler *load_state,
1058 void *opaque)
1059{
8718e999 1060 SaveStateEntry *se;
a672b469 1061
c163b5ca 1062 se = qemu_mallocz(sizeof(SaveStateEntry));
a672b469
AL
1063 se->version_id = version_id;
1064 se->section_id = global_section_id++;
c163b5ca 1065 se->set_params = set_params;
a672b469
AL
1066 se->save_live_state = save_live_state;
1067 se->save_state = save_state;
1068 se->load_state = load_state;
1069 se->opaque = opaque;
9ed7d6ae 1070 se->vmsd = NULL;
a672b469 1071
7685ee6a
AW
1072 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1073 char *id = dev->parent_bus->info->get_dev_path(dev);
1074 if (id) {
1075 pstrcpy(se->idstr, sizeof(se->idstr), id);
1076 pstrcat(se->idstr, sizeof(se->idstr), "/");
1077 qemu_free(id);
1078
1079 se->compat = qemu_mallocz(sizeof(CompatEntry));
1080 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1081 se->compat->instance_id = instance_id == -1 ?
1082 calculate_compat_instance_id(idstr) : instance_id;
1083 instance_id = -1;
1084 }
1085 }
1086 pstrcat(se->idstr, sizeof(se->idstr), idstr);
1087
8718e999 1088 if (instance_id == -1) {
7685ee6a 1089 se->instance_id = calculate_new_instance_id(se->idstr);
8718e999
JQ
1090 } else {
1091 se->instance_id = instance_id;
a672b469 1092 }
7685ee6a 1093 assert(!se->compat || se->instance_id == 0);
8718e999 1094 /* add at the end of list */
72cf2d4f 1095 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
a672b469
AL
1096 return 0;
1097}
1098
0be71e32
AW
1099int register_savevm(DeviceState *dev,
1100 const char *idstr,
a672b469
AL
1101 int instance_id,
1102 int version_id,
1103 SaveStateHandler *save_state,
1104 LoadStateHandler *load_state,
1105 void *opaque)
1106{
0be71e32 1107 return register_savevm_live(dev, idstr, instance_id, version_id,
c163b5ca 1108 NULL, NULL, save_state, load_state, opaque);
a672b469
AL
1109}
1110
0be71e32 1111void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
41bd13af 1112{
8718e999 1113 SaveStateEntry *se, *new_se;
7685ee6a
AW
1114 char id[256] = "";
1115
1116 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1117 char *path = dev->parent_bus->info->get_dev_path(dev);
1118 if (path) {
1119 pstrcpy(id, sizeof(id), path);
1120 pstrcat(id, sizeof(id), "/");
1121 qemu_free(path);
1122 }
1123 }
1124 pstrcat(id, sizeof(id), idstr);
41bd13af 1125
72cf2d4f 1126 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
7685ee6a 1127 if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
72cf2d4f 1128 QTAILQ_REMOVE(&savevm_handlers, se, entry);
8718e999 1129 qemu_free(se);
41bd13af 1130 }
41bd13af
AL
1131 }
1132}
1133
0be71e32 1134int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
4d2ffa08
JK
1135 const VMStateDescription *vmsd,
1136 void *opaque, int alias_id,
1137 int required_for_version)
9ed7d6ae 1138{
8718e999 1139 SaveStateEntry *se;
9ed7d6ae 1140
4d2ffa08
JK
1141 /* If this triggers, alias support can be dropped for the vmsd. */
1142 assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1143
c163b5ca 1144 se = qemu_mallocz(sizeof(SaveStateEntry));
9ed7d6ae
JQ
1145 se->version_id = vmsd->version_id;
1146 se->section_id = global_section_id++;
1147 se->save_live_state = NULL;
1148 se->save_state = NULL;
1149 se->load_state = NULL;
1150 se->opaque = opaque;
1151 se->vmsd = vmsd;
4d2ffa08 1152 se->alias_id = alias_id;
9ed7d6ae 1153
7685ee6a
AW
1154 if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1155 char *id = dev->parent_bus->info->get_dev_path(dev);
1156 if (id) {
1157 pstrcpy(se->idstr, sizeof(se->idstr), id);
1158 pstrcat(se->idstr, sizeof(se->idstr), "/");
1159 qemu_free(id);
1160
1161 se->compat = qemu_mallocz(sizeof(CompatEntry));
1162 pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1163 se->compat->instance_id = instance_id == -1 ?
1164 calculate_compat_instance_id(vmsd->name) : instance_id;
1165 instance_id = -1;
1166 }
1167 }
1168 pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1169
8718e999 1170 if (instance_id == -1) {
7685ee6a 1171 se->instance_id = calculate_new_instance_id(se->idstr);
8718e999
JQ
1172 } else {
1173 se->instance_id = instance_id;
9ed7d6ae 1174 }
7685ee6a 1175 assert(!se->compat || se->instance_id == 0);
8718e999 1176 /* add at the end of list */
72cf2d4f 1177 QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
9ed7d6ae
JQ
1178 return 0;
1179}
1180
0be71e32
AW
1181int vmstate_register(DeviceState *dev, int instance_id,
1182 const VMStateDescription *vmsd, void *opaque)
4d2ffa08 1183{
0be71e32
AW
1184 return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1185 opaque, -1, 0);
4d2ffa08
JK
1186}
1187
0be71e32
AW
1188void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1189 void *opaque)
9ed7d6ae 1190{
1eb7538b
JQ
1191 SaveStateEntry *se, *new_se;
1192
72cf2d4f 1193 QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1eb7538b 1194 if (se->vmsd == vmsd && se->opaque == opaque) {
72cf2d4f 1195 QTAILQ_REMOVE(&savevm_handlers, se, entry);
1eb7538b
JQ
1196 qemu_free(se);
1197 }
1198 }
9ed7d6ae
JQ
1199}
1200
1201int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1202 void *opaque, int version_id)
1203{
1204 VMStateField *field = vmsd->fields;
1205
1206 if (version_id > vmsd->version_id) {
1207 return -EINVAL;
1208 }
1209 if (version_id < vmsd->minimum_version_id_old) {
1210 return -EINVAL;
1211 }
1212 if (version_id < vmsd->minimum_version_id) {
1213 return vmsd->load_state_old(f, opaque, version_id);
1214 }
fd4d52de
JQ
1215 if (vmsd->pre_load) {
1216 int ret = vmsd->pre_load(opaque);
1217 if (ret)
1218 return ret;
1219 }
9ed7d6ae 1220 while(field->name) {
f11f6a5f
JQ
1221 if ((field->field_exists &&
1222 field->field_exists(opaque, version_id)) ||
1223 (!field->field_exists &&
1224 field->version_id <= version_id)) {
f752a6aa
JQ
1225 void *base_addr = opaque + field->offset;
1226 int ret, i, n_elems = 1;
e61a1e0a 1227 int size = field->size;
9ed7d6ae 1228
e61a1e0a
JQ
1229 if (field->flags & VMS_VBUFFER) {
1230 size = *(int32_t *)(opaque+field->size_offset);
33599e2a
JQ
1231 if (field->flags & VMS_MULTIPLY) {
1232 size *= field->size;
1233 }
e61a1e0a 1234 }
f752a6aa
JQ
1235 if (field->flags & VMS_ARRAY) {
1236 n_elems = field->num;
d6698281
JQ
1237 } else if (field->flags & VMS_VARRAY_INT32) {
1238 n_elems = *(int32_t *)(opaque+field->num_offset);
bdb4941d
JQ
1239 } else if (field->flags & VMS_VARRAY_UINT16) {
1240 n_elems = *(uint16_t *)(opaque+field->num_offset);
f752a6aa 1241 }
dde0463b 1242 if (field->flags & VMS_POINTER) {
e61a1e0a 1243 base_addr = *(void **)base_addr + field->start;
dde0463b 1244 }
f752a6aa 1245 for (i = 0; i < n_elems; i++) {
e61a1e0a 1246 void *addr = base_addr + size * i;
ec245e21 1247
19df438b
JQ
1248 if (field->flags & VMS_ARRAY_OF_POINTER) {
1249 addr = *(void **)addr;
1250 }
ec245e21 1251 if (field->flags & VMS_STRUCT) {
fa3aad24 1252 ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
ec245e21 1253 } else {
e61a1e0a 1254 ret = field->info->get(f, addr, size);
ec245e21
JQ
1255
1256 }
f752a6aa
JQ
1257 if (ret < 0) {
1258 return ret;
1259 }
9ed7d6ae
JQ
1260 }
1261 }
1262 field++;
1263 }
752ff2fa 1264 if (vmsd->post_load) {
e59fb374 1265 return vmsd->post_load(opaque, version_id);
752ff2fa 1266 }
9ed7d6ae
JQ
1267 return 0;
1268}
1269
1270void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
84e2e3eb 1271 void *opaque)
9ed7d6ae
JQ
1272{
1273 VMStateField *field = vmsd->fields;
1274
8fb0791d
JQ
1275 if (vmsd->pre_save) {
1276 vmsd->pre_save(opaque);
1277 }
9ed7d6ae 1278 while(field->name) {
f11f6a5f
JQ
1279 if (!field->field_exists ||
1280 field->field_exists(opaque, vmsd->version_id)) {
1281 void *base_addr = opaque + field->offset;
1282 int i, n_elems = 1;
e61a1e0a 1283 int size = field->size;
dde0463b 1284
e61a1e0a
JQ
1285 if (field->flags & VMS_VBUFFER) {
1286 size = *(int32_t *)(opaque+field->size_offset);
33599e2a
JQ
1287 if (field->flags & VMS_MULTIPLY) {
1288 size *= field->size;
1289 }
e61a1e0a 1290 }
f11f6a5f
JQ
1291 if (field->flags & VMS_ARRAY) {
1292 n_elems = field->num;
d6698281
JQ
1293 } else if (field->flags & VMS_VARRAY_INT32) {
1294 n_elems = *(int32_t *)(opaque+field->num_offset);
bdb4941d
JQ
1295 } else if (field->flags & VMS_VARRAY_UINT16) {
1296 n_elems = *(uint16_t *)(opaque+field->num_offset);
f11f6a5f
JQ
1297 }
1298 if (field->flags & VMS_POINTER) {
e61a1e0a 1299 base_addr = *(void **)base_addr + field->start;
f11f6a5f
JQ
1300 }
1301 for (i = 0; i < n_elems; i++) {
e61a1e0a 1302 void *addr = base_addr + size * i;
ec245e21 1303
8595387e
JQ
1304 if (field->flags & VMS_ARRAY_OF_POINTER) {
1305 addr = *(void **)addr;
1306 }
f11f6a5f
JQ
1307 if (field->flags & VMS_STRUCT) {
1308 vmstate_save_state(f, field->vmsd, addr);
1309 } else {
e61a1e0a 1310 field->info->put(f, addr, size);
f11f6a5f 1311 }
ec245e21 1312 }
dde0463b 1313 }
9ed7d6ae
JQ
1314 field++;
1315 }
1316}
1317
4082be4d
JQ
1318static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1319{
9ed7d6ae
JQ
1320 if (!se->vmsd) { /* Old style */
1321 return se->load_state(f, se->opaque, version_id);
1322 }
1323 return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
4082be4d
JQ
1324}
1325
1326static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1327{
9ed7d6ae
JQ
1328 if (!se->vmsd) { /* Old style */
1329 se->save_state(f, se->opaque);
1330 return;
1331 }
1332 vmstate_save_state(f,se->vmsd, se->opaque);
4082be4d
JQ
1333}
1334
a672b469
AL
1335#define QEMU_VM_FILE_MAGIC 0x5145564d
1336#define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
1337#define QEMU_VM_FILE_VERSION 0x00000003
1338
1339#define QEMU_VM_EOF 0x00
1340#define QEMU_VM_SECTION_START 0x01
1341#define QEMU_VM_SECTION_PART 0x02
1342#define QEMU_VM_SECTION_END 0x03
1343#define QEMU_VM_SECTION_FULL 0x04
1344
f327aa0c
JK
1345int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1346 int shared)
a672b469
AL
1347{
1348 SaveStateEntry *se;
1349
c163b5ca 1350 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1351 if(se->set_params == NULL) {
1352 continue;
1353 }
1354 se->set_params(blk_enable, shared, se->opaque);
1355 }
1356
a672b469
AL
1357 qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1358 qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1359
72cf2d4f 1360 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
a672b469
AL
1361 int len;
1362
1363 if (se->save_live_state == NULL)
1364 continue;
1365
1366 /* Section type */
1367 qemu_put_byte(f, QEMU_VM_SECTION_START);
1368 qemu_put_be32(f, se->section_id);
1369
1370 /* ID string */
1371 len = strlen(se->idstr);
1372 qemu_put_byte(f, len);
1373 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1374
1375 qemu_put_be32(f, se->instance_id);
1376 qemu_put_be32(f, se->version_id);
1377
f327aa0c 1378 se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
a672b469
AL
1379 }
1380
4ec7fcc7 1381 if (qemu_file_has_error(f)) {
f327aa0c 1382 qemu_savevm_state_cancel(mon, f);
a672b469 1383 return -EIO;
4ec7fcc7 1384 }
a672b469
AL
1385
1386 return 0;
1387}
1388
f327aa0c 1389int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
a672b469
AL
1390{
1391 SaveStateEntry *se;
1392 int ret = 1;
1393
72cf2d4f 1394 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
a672b469
AL
1395 if (se->save_live_state == NULL)
1396 continue;
1397
1398 /* Section type */
1399 qemu_put_byte(f, QEMU_VM_SECTION_PART);
1400 qemu_put_be32(f, se->section_id);
1401
90697be8
JK
1402 ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1403 if (!ret) {
1404 /* Do not proceed to the next vmstate before this one reported
1405 completion of the current stage. This serializes the migration
1406 and reduces the probability that a faster changing state is
1407 synchronized over and over again. */
1408 break;
1409 }
a672b469
AL
1410 }
1411
1412 if (ret)
1413 return 1;
1414
4ec7fcc7 1415 if (qemu_file_has_error(f)) {
f327aa0c 1416 qemu_savevm_state_cancel(mon, f);
a672b469 1417 return -EIO;
4ec7fcc7 1418 }
a672b469
AL
1419
1420 return 0;
1421}
1422
f327aa0c 1423int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
a672b469
AL
1424{
1425 SaveStateEntry *se;
1426
ea375f9a
JK
1427 cpu_synchronize_all_states();
1428
72cf2d4f 1429 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
a672b469
AL
1430 if (se->save_live_state == NULL)
1431 continue;
1432
1433 /* Section type */
1434 qemu_put_byte(f, QEMU_VM_SECTION_END);
1435 qemu_put_be32(f, se->section_id);
1436
f327aa0c 1437 se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
a672b469
AL
1438 }
1439
72cf2d4f 1440 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
a672b469
AL
1441 int len;
1442
9ed7d6ae 1443 if (se->save_state == NULL && se->vmsd == NULL)
a672b469
AL
1444 continue;
1445
1446 /* Section type */
1447 qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1448 qemu_put_be32(f, se->section_id);
1449
1450 /* ID string */
1451 len = strlen(se->idstr);
1452 qemu_put_byte(f, len);
1453 qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1454
1455 qemu_put_be32(f, se->instance_id);
1456 qemu_put_be32(f, se->version_id);
1457
4082be4d 1458 vmstate_save(f, se);
a672b469
AL
1459 }
1460
1461 qemu_put_byte(f, QEMU_VM_EOF);
1462
1463 if (qemu_file_has_error(f))
1464 return -EIO;
1465
1466 return 0;
1467}
1468
f327aa0c 1469void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
4ec7fcc7
JK
1470{
1471 SaveStateEntry *se;
1472
1473 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1474 if (se->save_live_state) {
f327aa0c 1475 se->save_live_state(mon, f, -1, se->opaque);
4ec7fcc7
JK
1476 }
1477 }
1478}
1479
f327aa0c 1480static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
a672b469
AL
1481{
1482 int saved_vm_running;
1483 int ret;
1484
1485 saved_vm_running = vm_running;
1486 vm_stop(0);
1487
1488 bdrv_flush_all();
1489
f327aa0c 1490 ret = qemu_savevm_state_begin(mon, f, 0, 0);
a672b469
AL
1491 if (ret < 0)
1492 goto out;
1493
1494 do {
f327aa0c 1495 ret = qemu_savevm_state_iterate(mon, f);
a672b469
AL
1496 if (ret < 0)
1497 goto out;
1498 } while (ret == 0);
1499
f327aa0c 1500 ret = qemu_savevm_state_complete(mon, f);
a672b469
AL
1501
1502out:
1503 if (qemu_file_has_error(f))
1504 ret = -EIO;
1505
1506 if (!ret && saved_vm_running)
1507 vm_start();
1508
1509 return ret;
1510}
1511
1512static SaveStateEntry *find_se(const char *idstr, int instance_id)
1513{
1514 SaveStateEntry *se;
1515
72cf2d4f 1516 QTAILQ_FOREACH(se, &savevm_handlers, entry) {
a672b469 1517 if (!strcmp(se->idstr, idstr) &&
4d2ffa08
JK
1518 (instance_id == se->instance_id ||
1519 instance_id == se->alias_id))
a672b469 1520 return se;
7685ee6a
AW
1521 /* Migrating from an older version? */
1522 if (strstr(se->idstr, idstr) && se->compat) {
1523 if (!strcmp(se->compat->idstr, idstr) &&
1524 (instance_id == se->compat->instance_id ||
1525 instance_id == se->alias_id))
1526 return se;
1527 }
a672b469
AL
1528 }
1529 return NULL;
1530}
1531
1532typedef struct LoadStateEntry {
72cf2d4f 1533 QLIST_ENTRY(LoadStateEntry) entry;
a672b469
AL
1534 SaveStateEntry *se;
1535 int section_id;
1536 int version_id;
a672b469
AL
1537} LoadStateEntry;
1538
a672b469
AL
1539int qemu_loadvm_state(QEMUFile *f)
1540{
72cf2d4f
BS
1541 QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1542 QLIST_HEAD_INITIALIZER(loadvm_handlers);
f4dbb8dd 1543 LoadStateEntry *le, *new_le;
a672b469
AL
1544 uint8_t section_type;
1545 unsigned int v;
1546 int ret;
1547
1548 v = qemu_get_be32(f);
1549 if (v != QEMU_VM_FILE_MAGIC)
1550 return -EINVAL;
1551
1552 v = qemu_get_be32(f);
bbfe1408
JQ
1553 if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1554 fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1555 return -ENOTSUP;
1556 }
a672b469
AL
1557 if (v != QEMU_VM_FILE_VERSION)
1558 return -ENOTSUP;
1559
1560 while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1561 uint32_t instance_id, version_id, section_id;
a672b469
AL
1562 SaveStateEntry *se;
1563 char idstr[257];
1564 int len;
1565
1566 switch (section_type) {
1567 case QEMU_VM_SECTION_START:
1568 case QEMU_VM_SECTION_FULL:
1569 /* Read section start */
1570 section_id = qemu_get_be32(f);
1571 len = qemu_get_byte(f);
1572 qemu_get_buffer(f, (uint8_t *)idstr, len);
1573 idstr[len] = 0;
1574 instance_id = qemu_get_be32(f);
1575 version_id = qemu_get_be32(f);
1576
1577 /* Find savevm section */
1578 se = find_se(idstr, instance_id);
1579 if (se == NULL) {
1580 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1581 ret = -EINVAL;
1582 goto out;
1583 }
1584
1585 /* Validate version */
1586 if (version_id > se->version_id) {
1587 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1588 version_id, idstr, se->version_id);
1589 ret = -EINVAL;
1590 goto out;
1591 }
1592
1593 /* Add entry */
1594 le = qemu_mallocz(sizeof(*le));
a672b469
AL
1595
1596 le->se = se;
1597 le->section_id = section_id;
1598 le->version_id = version_id;
72cf2d4f 1599 QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
a672b469 1600
4082be4d 1601 ret = vmstate_load(f, le->se, le->version_id);
b5a22e4a
JQ
1602 if (ret < 0) {
1603 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1604 instance_id, idstr);
1605 goto out;
1606 }
a672b469
AL
1607 break;
1608 case QEMU_VM_SECTION_PART:
1609 case QEMU_VM_SECTION_END:
1610 section_id = qemu_get_be32(f);
1611
72cf2d4f 1612 QLIST_FOREACH(le, &loadvm_handlers, entry) {
f4dbb8dd
JQ
1613 if (le->section_id == section_id) {
1614 break;
1615 }
1616 }
a672b469
AL
1617 if (le == NULL) {
1618 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1619 ret = -EINVAL;
1620 goto out;
1621 }
1622
4082be4d 1623 ret = vmstate_load(f, le->se, le->version_id);
b5a22e4a
JQ
1624 if (ret < 0) {
1625 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1626 section_id);
1627 goto out;
1628 }
a672b469
AL
1629 break;
1630 default:
1631 fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1632 ret = -EINVAL;
1633 goto out;
1634 }
1635 }
1636
ea375f9a
JK
1637 cpu_synchronize_all_post_init();
1638
a672b469
AL
1639 ret = 0;
1640
1641out:
72cf2d4f
BS
1642 QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1643 QLIST_REMOVE(le, entry);
a672b469
AL
1644 qemu_free(le);
1645 }
1646
1647 if (qemu_file_has_error(f))
1648 ret = -EIO;
1649
1650 return ret;
1651}
1652
a672b469
AL
1653static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1654 const char *name)
1655{
1656 QEMUSnapshotInfo *sn_tab, *sn;
1657 int nb_sns, i, ret;
1658
1659 ret = -ENOENT;
1660 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1661 if (nb_sns < 0)
1662 return ret;
1663 for(i = 0; i < nb_sns; i++) {
1664 sn = &sn_tab[i];
1665 if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1666 *sn_info = *sn;
1667 ret = 0;
1668 break;
1669 }
1670 }
1671 qemu_free(sn_tab);
1672 return ret;
1673}
1674
cb499fb2
KW
1675/*
1676 * Deletes snapshots of a given name in all opened images.
1677 */
1678static int del_existing_snapshots(Monitor *mon, const char *name)
1679{
1680 BlockDriverState *bs;
cb499fb2
KW
1681 QEMUSnapshotInfo sn1, *snapshot = &sn1;
1682 int ret;
1683
dbc13590
MA
1684 bs = NULL;
1685 while ((bs = bdrv_next(bs))) {
cb499fb2
KW
1686 if (bdrv_can_snapshot(bs) &&
1687 bdrv_snapshot_find(bs, snapshot, name) >= 0)
1688 {
1689 ret = bdrv_snapshot_delete(bs, name);
1690 if (ret < 0) {
1691 monitor_printf(mon,
1692 "Error while deleting snapshot on '%s'\n",
1693 bdrv_get_device_name(bs));
1694 return -1;
1695 }
1696 }
1697 }
1698
1699 return 0;
1700}
1701
d54908a5 1702void do_savevm(Monitor *mon, const QDict *qdict)
a672b469
AL
1703{
1704 BlockDriverState *bs, *bs1;
1705 QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
cb499fb2 1706 int ret;
a672b469
AL
1707 QEMUFile *f;
1708 int saved_vm_running;
2d22b18f 1709 uint32_t vm_state_size;
a672b469
AL
1710#ifdef _WIN32
1711 struct _timeb tb;
1712#else
1713 struct timeval tv;
1714#endif
d54908a5 1715 const char *name = qdict_get_try_str(qdict, "name");
a672b469 1716
feeee5ac 1717 /* Verify if there is a device that doesn't support snapshots and is writable */
dbc13590
MA
1718 bs = NULL;
1719 while ((bs = bdrv_next(bs))) {
feeee5ac
MDCF
1720
1721 if (bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
1722 continue;
1723 }
1724
1725 if (!bdrv_can_snapshot(bs)) {
1726 monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1727 bdrv_get_device_name(bs));
1728 return;
1729 }
1730 }
1731
f9092b10 1732 bs = bdrv_snapshots();
a672b469 1733 if (!bs) {
376253ec 1734 monitor_printf(mon, "No block device can accept snapshots\n");
a672b469
AL
1735 return;
1736 }
a672b469
AL
1737 /* ??? Should this occur after vm_stop? */
1738 qemu_aio_flush();
1739
1740 saved_vm_running = vm_running;
1741 vm_stop(0);
1742
cb499fb2 1743 memset(sn, 0, sizeof(*sn));
a672b469
AL
1744 if (name) {
1745 ret = bdrv_snapshot_find(bs, old_sn, name);
1746 if (ret >= 0) {
cb499fb2
KW
1747 pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
1748 pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
1749 } else {
a672b469 1750 pstrcpy(sn->name, sizeof(sn->name), name);
cb499fb2 1751 }
a672b469
AL
1752 }
1753
1754 /* fill auxiliary fields */
1755#ifdef _WIN32
1756 _ftime(&tb);
1757 sn->date_sec = tb.time;
1758 sn->date_nsec = tb.millitm * 1000000;
1759#else
1760 gettimeofday(&tv, NULL);
1761 sn->date_sec = tv.tv_sec;
1762 sn->date_nsec = tv.tv_usec * 1000;
1763#endif
1764 sn->vm_clock_nsec = qemu_get_clock(vm_clock);
1765
cb499fb2 1766 /* Delete old snapshots of the same name */
f139a412 1767 if (name && del_existing_snapshots(mon, name) < 0) {
cb499fb2
KW
1768 goto the_end;
1769 }
1770
a672b469 1771 /* save the VM state */
45566e9c 1772 f = qemu_fopen_bdrv(bs, 1);
a672b469 1773 if (!f) {
376253ec 1774 monitor_printf(mon, "Could not open VM state file\n");
a672b469
AL
1775 goto the_end;
1776 }
f327aa0c 1777 ret = qemu_savevm_state(mon, f);
2d22b18f 1778 vm_state_size = qemu_ftell(f);
a672b469
AL
1779 qemu_fclose(f);
1780 if (ret < 0) {
376253ec 1781 monitor_printf(mon, "Error %d while writing VM\n", ret);
a672b469
AL
1782 goto the_end;
1783 }
1784
1785 /* create the snapshots */
1786
dbc13590
MA
1787 bs1 = NULL;
1788 while ((bs1 = bdrv_next(bs1))) {
feeee5ac 1789 if (bdrv_can_snapshot(bs1)) {
2d22b18f
AL
1790 /* Write VM state size only to the image that contains the state */
1791 sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
a672b469
AL
1792 ret = bdrv_snapshot_create(bs1, sn);
1793 if (ret < 0) {
376253ec
AL
1794 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
1795 bdrv_get_device_name(bs1));
a672b469
AL
1796 }
1797 }
1798 }
1799
1800 the_end:
1801 if (saved_vm_running)
1802 vm_start();
1803}
1804
03cd4655 1805int load_vmstate(const char *name)
a672b469
AL
1806{
1807 BlockDriverState *bs, *bs1;
2d22b18f 1808 QEMUSnapshotInfo sn;
a672b469 1809 QEMUFile *f;
751c6a17 1810 int ret;
a672b469 1811
feeee5ac 1812 /* Verify if there is a device that doesn't support snapshots and is writable */
dbc13590
MA
1813 bs = NULL;
1814 while ((bs = bdrv_next(bs))) {
feeee5ac
MDCF
1815
1816 if (bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
1817 continue;
1818 }
1819
1820 if (!bdrv_can_snapshot(bs)) {
1821 error_report("Device '%s' is writable but does not support snapshots.",
1822 bdrv_get_device_name(bs));
1823 return -ENOTSUP;
1824 }
1825 }
1826
f9092b10 1827 bs = bdrv_snapshots();
a672b469 1828 if (!bs) {
1ecda02b 1829 error_report("No block device supports snapshots");
05f2401e 1830 return -EINVAL;
a672b469
AL
1831 }
1832
1833 /* Flush all IO requests so they don't interfere with the new state. */
1834 qemu_aio_flush();
1835
dbc13590
MA
1836 bs1 = NULL;
1837 while ((bs1 = bdrv_next(bs1))) {
feeee5ac 1838 if (bdrv_can_snapshot(bs1)) {
a672b469
AL
1839 ret = bdrv_snapshot_goto(bs1, name);
1840 if (ret < 0) {
a672b469
AL
1841 switch(ret) {
1842 case -ENOTSUP:
1ecda02b
MA
1843 error_report("%sSnapshots not supported on device '%s'",
1844 bs != bs1 ? "Warning: " : "",
1845 bdrv_get_device_name(bs1));
a672b469
AL
1846 break;
1847 case -ENOENT:
1ecda02b
MA
1848 error_report("%sCould not find snapshot '%s' on device '%s'",
1849 bs != bs1 ? "Warning: " : "",
1850 name, bdrv_get_device_name(bs1));
a672b469
AL
1851 break;
1852 default:
1ecda02b
MA
1853 error_report("%sError %d while activating snapshot on '%s'",
1854 bs != bs1 ? "Warning: " : "",
1855 ret, bdrv_get_device_name(bs1));
a672b469
AL
1856 break;
1857 }
1858 /* fatal on snapshot block device */
1859 if (bs == bs1)
05f2401e 1860 return 0;
a672b469
AL
1861 }
1862 }
1863 }
1864
2d22b18f
AL
1865 /* Don't even try to load empty VM states */
1866 ret = bdrv_snapshot_find(bs, &sn, name);
1867 if ((ret >= 0) && (sn.vm_state_size == 0))
05f2401e 1868 return -EINVAL;
2d22b18f 1869
a672b469 1870 /* restore the VM state */
45566e9c 1871 f = qemu_fopen_bdrv(bs, 0);
a672b469 1872 if (!f) {
1ecda02b 1873 error_report("Could not open VM state file");
05f2401e 1874 return -EINVAL;
a672b469
AL
1875 }
1876 ret = qemu_loadvm_state(f);
1877 qemu_fclose(f);
1878 if (ret < 0) {
1ecda02b 1879 error_report("Error %d while loading VM state", ret);
05f2401e 1880 return ret;
a672b469 1881 }
05f2401e 1882 return 0;
7b630349
JQ
1883}
1884
d54908a5 1885void do_delvm(Monitor *mon, const QDict *qdict)
a672b469
AL
1886{
1887 BlockDriverState *bs, *bs1;
751c6a17 1888 int ret;
d54908a5 1889 const char *name = qdict_get_str(qdict, "name");
a672b469 1890
f9092b10 1891 bs = bdrv_snapshots();
a672b469 1892 if (!bs) {
376253ec 1893 monitor_printf(mon, "No block device supports snapshots\n");
a672b469
AL
1894 return;
1895 }
1896
dbc13590
MA
1897 bs1 = NULL;
1898 while ((bs1 = bdrv_next(bs1))) {
feeee5ac 1899 if (bdrv_can_snapshot(bs1)) {
a672b469
AL
1900 ret = bdrv_snapshot_delete(bs1, name);
1901 if (ret < 0) {
1902 if (ret == -ENOTSUP)
376253ec
AL
1903 monitor_printf(mon,
1904 "Snapshots not supported on device '%s'\n",
1905 bdrv_get_device_name(bs1));
a672b469 1906 else
376253ec
AL
1907 monitor_printf(mon, "Error %d while deleting snapshot on "
1908 "'%s'\n", ret, bdrv_get_device_name(bs1));
a672b469
AL
1909 }
1910 }
1911 }
1912}
1913
376253ec 1914void do_info_snapshots(Monitor *mon)
a672b469
AL
1915{
1916 BlockDriverState *bs, *bs1;
1917 QEMUSnapshotInfo *sn_tab, *sn;
1918 int nb_sns, i;
1919 char buf[256];
1920
f9092b10 1921 bs = bdrv_snapshots();
a672b469 1922 if (!bs) {
376253ec 1923 monitor_printf(mon, "No available block device supports snapshots\n");
a672b469
AL
1924 return;
1925 }
376253ec 1926 monitor_printf(mon, "Snapshot devices:");
dbc13590
MA
1927 bs1 = NULL;
1928 while ((bs1 = bdrv_next(bs1))) {
feeee5ac 1929 if (bdrv_can_snapshot(bs1)) {
a672b469 1930 if (bs == bs1)
376253ec 1931 monitor_printf(mon, " %s", bdrv_get_device_name(bs1));
a672b469
AL
1932 }
1933 }
376253ec 1934 monitor_printf(mon, "\n");
a672b469
AL
1935
1936 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1937 if (nb_sns < 0) {
376253ec 1938 monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
a672b469
AL
1939 return;
1940 }
376253ec
AL
1941 monitor_printf(mon, "Snapshot list (from %s):\n",
1942 bdrv_get_device_name(bs));
1943 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
a672b469
AL
1944 for(i = 0; i < nb_sns; i++) {
1945 sn = &sn_tab[i];
376253ec 1946 monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
a672b469
AL
1947 }
1948 qemu_free(sn_tab);
1949}