savevm.c

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <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 "blockdev.h"
  82 #include "audio/audio.h"
  83 #include "migration.h"
  84 #include "qemu_socket.h"
  85 #include "qemu-queue.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(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(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 size_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 size_t qemu_file_set_rate_limit(QEMUFile *f, size_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 /* 8 bit int */
 679
 680 static int get_int8(QEMUFile *f, void *pv, size_t size)
 681 {
 682     int8_t *v = pv;
 683     qemu_get_s8s(f, v);
 684     return 0;
 685 }
 686
 687 static void put_int8(QEMUFile *f, void *pv, size_t size)
 688 {
 689     int8_t *v = pv;
 690     qemu_put_s8s(f, v);
 691 }
 692
 693 const VMStateInfo vmstate_info_int8 = {
 694     .name = "int8",
 695     .get  = get_int8,
 696     .put  = put_int8,
 697 };
 698
 699 /* 16 bit int */
 700
 701 static int get_int16(QEMUFile *f, void *pv, size_t size)
 702 {
 703     int16_t *v = pv;
 704     qemu_get_sbe16s(f, v);
 705     return 0;
 706 }
 707
 708 static void put_int16(QEMUFile *f, void *pv, size_t size)
 709 {
 710     int16_t *v = pv;
 711     qemu_put_sbe16s(f, v);
 712 }
 713
 714 const VMStateInfo vmstate_info_int16 = {
 715     .name = "int16",
 716     .get  = get_int16,
 717     .put  = put_int16,
 718 };
 719
 720 /* 32 bit int */
 721
 722 static int get_int32(QEMUFile *f, void *pv, size_t size)
 723 {
 724     int32_t *v = pv;
 725     qemu_get_sbe32s(f, v);
 726     return 0;
 727 }
 728
 729 static void put_int32(QEMUFile *f, void *pv, size_t size)
 730 {
 731     int32_t *v = pv;
 732     qemu_put_sbe32s(f, v);
 733 }
 734
 735 const VMStateInfo vmstate_info_int32 = {
 736     .name = "int32",
 737     .get  = get_int32,
 738     .put  = put_int32,
 739 };
 740
 741 /* 32 bit int. See that the received value is the same than the one
 742    in the field */
 743
 744 static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
 745 {
 746     int32_t *v = pv;
 747     int32_t v2;
 748     qemu_get_sbe32s(f, &v2);
 749
 750     if (*v == v2)
 751         return 0;
 752     return -EINVAL;
 753 }
 754
 755 const VMStateInfo vmstate_info_int32_equal = {
 756     .name = "int32 equal",
 757     .get  = get_int32_equal,
 758     .put  = put_int32,
 759 };
 760
 761 /* 32 bit int. See that the received value is the less or the same
 762    than the one in the field */
 763
 764 static int get_int32_le(QEMUFile *f, void *pv, size_t size)
 765 {
 766     int32_t *old = pv;
 767     int32_t new;
 768     qemu_get_sbe32s(f, &new);
 769
 770     if (*old <= new)
 771         return 0;
 772     return -EINVAL;
 773 }
 774
 775 const VMStateInfo vmstate_info_int32_le = {
 776     .name = "int32 equal",
 777     .get  = get_int32_le,
 778     .put  = put_int32,
 779 };
 780
 781 /* 64 bit int */
 782
 783 static int get_int64(QEMUFile *f, void *pv, size_t size)
 784 {
 785     int64_t *v = pv;
 786     qemu_get_sbe64s(f, v);
 787     return 0;
 788 }
 789
 790 static void put_int64(QEMUFile *f, void *pv, size_t size)
 791 {
 792     int64_t *v = pv;
 793     qemu_put_sbe64s(f, v);
 794 }
 795
 796 const VMStateInfo vmstate_info_int64 = {
 797     .name = "int64",
 798     .get  = get_int64,
 799     .put  = put_int64,
 800 };
 801
 802 /* 8 bit unsigned int */
 803
 804 static int get_uint8(QEMUFile *f, void *pv, size_t size)
 805 {
 806     uint8_t *v = pv;
 807     qemu_get_8s(f, v);
 808     return 0;
 809 }
 810
 811 static void put_uint8(QEMUFile *f, void *pv, size_t size)
 812 {
 813     uint8_t *v = pv;
 814     qemu_put_8s(f, v);
 815 }
 816
 817 const VMStateInfo vmstate_info_uint8 = {
 818     .name = "uint8",
 819     .get  = get_uint8,
 820     .put  = put_uint8,
 821 };
 822
 823 /* 16 bit unsigned int */
 824
 825 static int get_uint16(QEMUFile *f, void *pv, size_t size)
 826 {
 827     uint16_t *v = pv;
 828     qemu_get_be16s(f, v);
 829     return 0;
 830 }
 831
 832 static void put_uint16(QEMUFile *f, void *pv, size_t size)
 833 {
 834     uint16_t *v = pv;
 835     qemu_put_be16s(f, v);
 836 }
 837
 838 const VMStateInfo vmstate_info_uint16 = {
 839     .name = "uint16",
 840     .get  = get_uint16,
 841     .put  = put_uint16,
 842 };
 843
 844 /* 32 bit unsigned int */
 845
 846 static int get_uint32(QEMUFile *f, void *pv, size_t size)
 847 {
 848     uint32_t *v = pv;
 849     qemu_get_be32s(f, v);
 850     return 0;
 851 }
 852
 853 static void put_uint32(QEMUFile *f, void *pv, size_t size)
 854 {
 855     uint32_t *v = pv;
 856     qemu_put_be32s(f, v);
 857 }
 858
 859 const VMStateInfo vmstate_info_uint32 = {
 860     .name = "uint32",
 861     .get  = get_uint32,
 862     .put  = put_uint32,
 863 };
 864
 865 /* 64 bit unsigned int */
 866
 867 static int get_uint64(QEMUFile *f, void *pv, size_t size)
 868 {
 869     uint64_t *v = pv;
 870     qemu_get_be64s(f, v);
 871     return 0;
 872 }
 873
 874 static void put_uint64(QEMUFile *f, void *pv, size_t size)
 875 {
 876     uint64_t *v = pv;
 877     qemu_put_be64s(f, v);
 878 }
 879
 880 const VMStateInfo vmstate_info_uint64 = {
 881     .name = "uint64",
 882     .get  = get_uint64,
 883     .put  = put_uint64,
 884 };
 885
 886 /* 8 bit int. See that the received value is the same than the one
 887    in the field */
 888
 889 static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
 890 {
 891     uint8_t *v = pv;
 892     uint8_t v2;
 893     qemu_get_8s(f, &v2);
 894
 895     if (*v == v2)
 896         return 0;
 897     return -EINVAL;
 898 }
 899
 900 const VMStateInfo vmstate_info_uint8_equal = {
 901     .name = "uint8 equal",
 902     .get  = get_uint8_equal,
 903     .put  = put_uint8,
 904 };
 905
 906 /* 16 bit unsigned int int. See that the received value is the same than the one
 907    in the field */
 908
 909 static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
 910 {
 911     uint16_t *v = pv;
 912     uint16_t v2;
 913     qemu_get_be16s(f, &v2);
 914
 915     if (*v == v2)
 916         return 0;
 917     return -EINVAL;
 918 }
 919
 920 const VMStateInfo vmstate_info_uint16_equal = {
 921     .name = "uint16 equal",
 922     .get  = get_uint16_equal,
 923     .put  = put_uint16,
 924 };
 925
 926 /* timers  */
 927
 928 static int get_timer(QEMUFile *f, void *pv, size_t size)
 929 {
 930     QEMUTimer *v = pv;
 931     qemu_get_timer(f, v);
 932     return 0;
 933 }
 934
 935 static void put_timer(QEMUFile *f, void *pv, size_t size)
 936 {
 937     QEMUTimer *v = pv;
 938     qemu_put_timer(f, v);
 939 }
 940
 941 const VMStateInfo vmstate_info_timer = {
 942     .name = "timer",
 943     .get  = get_timer,
 944     .put  = put_timer,
 945 };
 946
 947 /* uint8_t buffers */
 948
 949 static int get_buffer(QEMUFile *f, void *pv, size_t size)
 950 {
 951     uint8_t *v = pv;
 952     qemu_get_buffer(f, v, size);
 953     return 0;
 954 }
 955
 956 static void put_buffer(QEMUFile *f, void *pv, size_t size)
 957 {
 958     uint8_t *v = pv;
 959     qemu_put_buffer(f, v, size);
 960 }
 961
 962 const VMStateInfo vmstate_info_buffer = {
 963     .name = "buffer",
 964     .get  = get_buffer,
 965     .put  = put_buffer,
 966 };
 967
 968 /* unused buffers: space that was used for some fields that are
 969    not usefull anymore */
 970
 971 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
 972 {
 973     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_get_buffer(f, buf, block_len);
 980     }
 981    return 0;
 982 }
 983
 984 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
 985 {
 986     static const uint8_t buf[1024];
 987     int block_len;
 988
 989     while (size > 0) {
 990         block_len = MIN(sizeof(buf), size);
 991         size -= block_len;
 992         qemu_put_buffer(f, buf, block_len);
 993     }
 994 }
 995
 996 const VMStateInfo vmstate_info_unused_buffer = {
 997     .name = "unused_buffer",
 998     .get  = get_unused_buffer,
 999     .put  = put_unused_buffer,
1000 };
1001
1002 typedef struct CompatEntry {
1003     char idstr[256];
1004     int instance_id;
1005 } CompatEntry;
1006
1007 typedef struct SaveStateEntry {
1008     QTAILQ_ENTRY(SaveStateEntry) entry;
1009     char idstr[256];
1010     int instance_id;
1011     int alias_id;
1012     int version_id;
1013     int section_id;
1014     SaveSetParamsHandler *set_params;
1015     SaveLiveStateHandler *save_live_state;
1016     SaveStateHandler *save_state;
1017     LoadStateHandler *load_state;
1018     const VMStateDescription *vmsd;
1019     void *opaque;
1020     CompatEntry *compat;
1021 } SaveStateEntry;
1022
1023
1024 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1025     QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1026 static int global_section_id;
1027
1028 static int calculate_new_instance_id(const char *idstr)
1029 {
1030     SaveStateEntry *se;
1031     int instance_id = 0;
1032
1033     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1034         if (strcmp(idstr, se->idstr) == 0
1035             && instance_id <= se->instance_id) {
1036             instance_id = se->instance_id + 1;
1037         }
1038     }
1039     return instance_id;
1040 }
1041
1042 static int calculate_compat_instance_id(const char *idstr)
1043 {
1044     SaveStateEntry *se;
1045     int instance_id = 0;
1046
1047     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1048         if (!se->compat)
1049             continue;
1050
1051         if (strcmp(idstr, se->compat->idstr) == 0
1052             && instance_id <= se->compat->instance_id) {
1053             instance_id = se->compat->instance_id + 1;
1054         }
1055     }
1056     return instance_id;
1057 }
1058
1059 /* TODO: Individual devices generally have very little idea about the rest
1060    of the system, so instance_id should be removed/replaced.
1061    Meanwhile pass -1 as instance_id if you do not already have a clearly
1062    distinguishing id for all instances of your device class. */
1063 int register_savevm_live(DeviceState *dev,
1064                          const char *idstr,
1065                          int instance_id,
1066                          int version_id,
1067                          SaveSetParamsHandler *set_params,
1068                          SaveLiveStateHandler *save_live_state,
1069                          SaveStateHandler *save_state,
1070                          LoadStateHandler *load_state,
1071                          void *opaque)
1072 {
1073     SaveStateEntry *se;
1074
1075     se = qemu_mallocz(sizeof(SaveStateEntry));
1076     se->version_id = version_id;
1077     se->section_id = global_section_id++;
1078     se->set_params = set_params;
1079     se->save_live_state = save_live_state;
1080     se->save_state = save_state;
1081     se->load_state = load_state;
1082     se->opaque = opaque;
1083     se->vmsd = NULL;
1084
1085     if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1086         char *id = dev->parent_bus->info->get_dev_path(dev);
1087         if (id) {
1088             pstrcpy(se->idstr, sizeof(se->idstr), id);
1089             pstrcat(se->idstr, sizeof(se->idstr), "/");
1090             qemu_free(id);
1091
1092             se->compat = qemu_mallocz(sizeof(CompatEntry));
1093             pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
1094             se->compat->instance_id = instance_id == -1 ?
1095                          calculate_compat_instance_id(idstr) : instance_id;
1096             instance_id = -1;
1097         }
1098     }
1099     pstrcat(se->idstr, sizeof(se->idstr), idstr);
1100
1101     if (instance_id == -1) {
1102         se->instance_id = calculate_new_instance_id(se->idstr);
1103     } else {
1104         se->instance_id = instance_id;
1105     }
1106     assert(!se->compat || se->instance_id == 0);
1107     /* add at the end of list */
1108     QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1109     return 0;
1110 }
1111
1112 int register_savevm(DeviceState *dev,
1113                     const char *idstr,
1114                     int instance_id,
1115                     int version_id,
1116                     SaveStateHandler *save_state,
1117                     LoadStateHandler *load_state,
1118                     void *opaque)
1119 {
1120     return register_savevm_live(dev, idstr, instance_id, version_id,
1121                                 NULL, NULL, save_state, load_state, opaque);
1122 }
1123
1124 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1125 {
1126     SaveStateEntry *se, *new_se;
1127     char id[256] = "";
1128
1129     if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1130         char *path = dev->parent_bus->info->get_dev_path(dev);
1131         if (path) {
1132             pstrcpy(id, sizeof(id), path);
1133             pstrcat(id, sizeof(id), "/");
1134             qemu_free(path);
1135         }
1136     }
1137     pstrcat(id, sizeof(id), idstr);
1138
1139     QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1140         if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1141             QTAILQ_REMOVE(&savevm_handlers, se, entry);
1142             if (se->compat) {
1143                 qemu_free(se->compat);
1144             }
1145             qemu_free(se);
1146         }
1147     }
1148 }
1149
1150 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1151                                    const VMStateDescription *vmsd,
1152                                    void *opaque, int alias_id,
1153                                    int required_for_version)
1154 {
1155     SaveStateEntry *se;
1156
1157     /* If this triggers, alias support can be dropped for the vmsd. */
1158     assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);
1159
1160     se = qemu_mallocz(sizeof(SaveStateEntry));
1161     se->version_id = vmsd->version_id;
1162     se->section_id = global_section_id++;
1163     se->save_live_state = NULL;
1164     se->save_state = NULL;
1165     se->load_state = NULL;
1166     se->opaque = opaque;
1167     se->vmsd = vmsd;
1168     se->alias_id = alias_id;
1169
1170     if (dev && dev->parent_bus && dev->parent_bus->info->get_dev_path) {
1171         char *id = dev->parent_bus->info->get_dev_path(dev);
1172         if (id) {
1173             pstrcpy(se->idstr, sizeof(se->idstr), id);
1174             pstrcat(se->idstr, sizeof(se->idstr), "/");
1175             qemu_free(id);
1176
1177             se->compat = qemu_mallocz(sizeof(CompatEntry));
1178             pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), vmsd->name);
1179             se->compat->instance_id = instance_id == -1 ?
1180                          calculate_compat_instance_id(vmsd->name) : instance_id;
1181             instance_id = -1;
1182         }
1183     }
1184     pstrcat(se->idstr, sizeof(se->idstr), vmsd->name);
1185
1186     if (instance_id == -1) {
1187         se->instance_id = calculate_new_instance_id(se->idstr);
1188     } else {
1189         se->instance_id = instance_id;
1190     }
1191     assert(!se->compat || se->instance_id == 0);
1192     /* add at the end of list */
1193     QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1194     return 0;
1195 }
1196
1197 int vmstate_register(DeviceState *dev, int instance_id,
1198                      const VMStateDescription *vmsd, void *opaque)
1199 {
1200     return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1201                                           opaque, -1, 0);
1202 }
1203
1204 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1205                         void *opaque)
1206 {
1207     SaveStateEntry *se, *new_se;
1208
1209     QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1210         if (se->vmsd == vmsd && se->opaque == opaque) {
1211             QTAILQ_REMOVE(&savevm_handlers, se, entry);
1212             if (se->compat) {
1213                 qemu_free(se->compat);
1214             }
1215             qemu_free(se);
1216         }
1217     }
1218 }
1219
1220 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1221                                     void *opaque);
1222 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1223                                    void *opaque);
1224
1225 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1226                        void *opaque, int version_id)
1227 {
1228     VMStateField *field = vmsd->fields;
1229     int ret;
1230
1231     if (version_id > vmsd->version_id) {
1232         return -EINVAL;
1233     }
1234     if (version_id < vmsd->minimum_version_id_old) {
1235         return -EINVAL;
1236     }
1237     if  (version_id < vmsd->minimum_version_id) {
1238         return vmsd->load_state_old(f, opaque, version_id);
1239     }
1240     if (vmsd->pre_load) {
1241         int ret = vmsd->pre_load(opaque);
1242         if (ret)
1243             return ret;
1244     }
1245     while(field->name) {
1246         if ((field->field_exists &&
1247              field->field_exists(opaque, version_id)) ||
1248             (!field->field_exists &&
1249              field->version_id <= version_id)) {
1250             void *base_addr = opaque + field->offset;
1251             int i, n_elems = 1;
1252             int size = field->size;
1253
1254             if (field->flags & VMS_VBUFFER) {
1255                 size = *(int32_t *)(opaque+field->size_offset);
1256                 if (field->flags & VMS_MULTIPLY) {
1257                     size *= field->size;
1258                 }
1259             }
1260             if (field->flags & VMS_ARRAY) {
1261                 n_elems = field->num;
1262             } else if (field->flags & VMS_VARRAY_INT32) {
1263                 n_elems = *(int32_t *)(opaque+field->num_offset);
1264             } else if (field->flags & VMS_VARRAY_UINT16) {
1265                 n_elems = *(uint16_t *)(opaque+field->num_offset);
1266             }
1267             if (field->flags & VMS_POINTER) {
1268                 base_addr = *(void **)base_addr + field->start;
1269             }
1270             for (i = 0; i < n_elems; i++) {
1271                 void *addr = base_addr + size * i;
1272
1273                 if (field->flags & VMS_ARRAY_OF_POINTER) {
1274                     addr = *(void **)addr;
1275                 }
1276                 if (field->flags & VMS_STRUCT) {
1277                     ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1278                 } else {
1279                     ret = field->info->get(f, addr, size);
1280
1281                 }
1282                 if (ret < 0) {
1283                     return ret;
1284                 }
1285             }
1286         }
1287         field++;
1288     }
1289     ret = vmstate_subsection_load(f, vmsd, opaque);
1290     if (ret != 0) {
1291         return ret;
1292     }
1293     if (vmsd->post_load) {
1294         return vmsd->post_load(opaque, version_id);
1295     }
1296     return 0;
1297 }
1298
1299 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1300                         void *opaque)
1301 {
1302     VMStateField *field = vmsd->fields;
1303
1304     if (vmsd->pre_save) {
1305         vmsd->pre_save(opaque);
1306     }
1307     while(field->name) {
1308         if (!field->field_exists ||
1309             field->field_exists(opaque, vmsd->version_id)) {
1310             void *base_addr = opaque + field->offset;
1311             int i, n_elems = 1;
1312             int size = field->size;
1313
1314             if (field->flags & VMS_VBUFFER) {
1315                 size = *(int32_t *)(opaque+field->size_offset);
1316                 if (field->flags & VMS_MULTIPLY) {
1317                     size *= field->size;
1318                 }
1319             }
1320             if (field->flags & VMS_ARRAY) {
1321                 n_elems = field->num;
1322             } else if (field->flags & VMS_VARRAY_INT32) {
1323                 n_elems = *(int32_t *)(opaque+field->num_offset);
1324             } else if (field->flags & VMS_VARRAY_UINT16) {
1325                 n_elems = *(uint16_t *)(opaque+field->num_offset);
1326             }
1327             if (field->flags & VMS_POINTER) {
1328                 base_addr = *(void **)base_addr + field->start;
1329             }
1330             for (i = 0; i < n_elems; i++) {
1331                 void *addr = base_addr + size * i;
1332
1333                 if (field->flags & VMS_ARRAY_OF_POINTER) {
1334                     addr = *(void **)addr;
1335                 }
1336                 if (field->flags & VMS_STRUCT) {
1337                     vmstate_save_state(f, field->vmsd, addr);
1338                 } else {
1339                     field->info->put(f, addr, size);
1340                 }
1341             }
1342         }
1343         field++;
1344     }
1345     vmstate_subsection_save(f, vmsd, opaque);
1346 }
1347
1348 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1349 {
1350     if (!se->vmsd) {         /* Old style */
1351         return se->load_state(f, se->opaque, version_id);
1352     }
1353     return vmstate_load_state(f, se->vmsd, se->opaque, version_id);
1354 }
1355
1356 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1357 {
1358     if (!se->vmsd) {         /* Old style */
1359         se->save_state(f, se->opaque);
1360         return;
1361     }
1362     vmstate_save_state(f,se->vmsd, se->opaque);
1363 }
1364
1365 #define QEMU_VM_FILE_MAGIC           0x5145564d
1366 #define QEMU_VM_FILE_VERSION_COMPAT  0x00000002
1367 #define QEMU_VM_FILE_VERSION         0x00000003
1368
1369 #define QEMU_VM_EOF                  0x00
1370 #define QEMU_VM_SECTION_START        0x01
1371 #define QEMU_VM_SECTION_PART         0x02
1372 #define QEMU_VM_SECTION_END          0x03
1373 #define QEMU_VM_SECTION_FULL         0x04
1374 #define QEMU_VM_SUBSECTION           0x05
1375
1376 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1377                             int shared)
1378 {
1379     SaveStateEntry *se;
1380
1381     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1382         if(se->set_params == NULL) {
1383             continue;
1384         }
1385         se->set_params(blk_enable, shared, se->opaque);
1386     }
1387
1388     qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1389     qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1390
1391     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1392         int len;
1393
1394         if (se->save_live_state == NULL)
1395             continue;
1396
1397         /* Section type */
1398         qemu_put_byte(f, QEMU_VM_SECTION_START);
1399         qemu_put_be32(f, se->section_id);
1400
1401         /* ID string */
1402         len = strlen(se->idstr);
1403         qemu_put_byte(f, len);
1404         qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1405
1406         qemu_put_be32(f, se->instance_id);
1407         qemu_put_be32(f, se->version_id);
1408
1409         se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1410     }
1411
1412     if (qemu_file_has_error(f)) {
1413         qemu_savevm_state_cancel(mon, f);
1414         return -EIO;
1415     }
1416
1417     return 0;
1418 }
1419
1420 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1421 {
1422     SaveStateEntry *se;
1423     int ret = 1;
1424
1425     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1426         if (se->save_live_state == NULL)
1427             continue;
1428
1429         /* Section type */
1430         qemu_put_byte(f, QEMU_VM_SECTION_PART);
1431         qemu_put_be32(f, se->section_id);
1432
1433         ret = se->save_live_state(mon, f, QEMU_VM_SECTION_PART, se->opaque);
1434         if (!ret) {
1435             /* Do not proceed to the next vmstate before this one reported
1436                completion of the current stage. This serializes the migration
1437                and reduces the probability that a faster changing state is
1438                synchronized over and over again. */
1439             break;
1440         }
1441     }
1442
1443     if (ret)
1444         return 1;
1445
1446     if (qemu_file_has_error(f)) {
1447         qemu_savevm_state_cancel(mon, f);
1448         return -EIO;
1449     }
1450
1451     return 0;
1452 }
1453
1454 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1455 {
1456     SaveStateEntry *se;
1457
1458     cpu_synchronize_all_states();
1459
1460     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1461         if (se->save_live_state == NULL)
1462             continue;
1463
1464         /* Section type */
1465         qemu_put_byte(f, QEMU_VM_SECTION_END);
1466         qemu_put_be32(f, se->section_id);
1467
1468         se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1469     }
1470
1471     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1472         int len;
1473
1474         if (se->save_state == NULL && se->vmsd == NULL)
1475             continue;
1476
1477         /* Section type */
1478         qemu_put_byte(f, QEMU_VM_SECTION_FULL);
1479         qemu_put_be32(f, se->section_id);
1480
1481         /* ID string */
1482         len = strlen(se->idstr);
1483         qemu_put_byte(f, len);
1484         qemu_put_buffer(f, (uint8_t *)se->idstr, len);
1485
1486         qemu_put_be32(f, se->instance_id);
1487         qemu_put_be32(f, se->version_id);
1488
1489         vmstate_save(f, se);
1490     }
1491
1492     qemu_put_byte(f, QEMU_VM_EOF);
1493
1494     if (qemu_file_has_error(f))
1495         return -EIO;
1496
1497     return 0;
1498 }
1499
1500 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1501 {
1502     SaveStateEntry *se;
1503
1504     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1505         if (se->save_live_state) {
1506             se->save_live_state(mon, f, -1, se->opaque);
1507         }
1508     }
1509 }
1510
1511 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
1512 {
1513     int saved_vm_running;
1514     int ret;
1515
1516     saved_vm_running = vm_running;
1517     vm_stop(0);
1518
1519     bdrv_flush_all();
1520
1521     ret = qemu_savevm_state_begin(mon, f, 0, 0);
1522     if (ret < 0)
1523         goto out;
1524
1525     do {
1526         ret = qemu_savevm_state_iterate(mon, f);
1527         if (ret < 0)
1528             goto out;
1529     } while (ret == 0);
1530
1531     ret = qemu_savevm_state_complete(mon, f);
1532
1533 out:
1534     if (qemu_file_has_error(f))
1535         ret = -EIO;
1536
1537     if (!ret && saved_vm_running)
1538         vm_start();
1539
1540     return ret;
1541 }
1542
1543 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1544 {
1545     SaveStateEntry *se;
1546
1547     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1548         if (!strcmp(se->idstr, idstr) &&
1549             (instance_id == se->instance_id ||
1550              instance_id == se->alias_id))
1551             return se;
1552         /* Migrating from an older version? */
1553         if (strstr(se->idstr, idstr) && se->compat) {
1554             if (!strcmp(se->compat->idstr, idstr) &&
1555                 (instance_id == se->compat->instance_id ||
1556                  instance_id == se->alias_id))
1557                 return se;
1558         }
1559     }
1560     return NULL;
1561 }
1562
1563 static const VMStateDescription *vmstate_get_subsection(const VMStateSubsection *sub, char *idstr)
1564 {
1565     while(sub && sub->needed) {
1566         if (strcmp(idstr, sub->vmsd->name) == 0) {
1567             return sub->vmsd;
1568         }
1569         sub++;
1570     }
1571     return NULL;
1572 }
1573
1574 static int vmstate_subsection_load(QEMUFile *f, const VMStateDescription *vmsd,
1575                                    void *opaque)
1576 {
1577     while (qemu_peek_byte(f) == QEMU_VM_SUBSECTION) {
1578         char idstr[256];
1579         int ret;
1580         uint8_t version_id, subsection, len;
1581         const VMStateDescription *sub_vmsd;
1582
1583         subsection = qemu_get_byte(f);
1584         len = qemu_get_byte(f);
1585         qemu_get_buffer(f, (uint8_t *)idstr, len);
1586         idstr[len] = 0;
1587         version_id = qemu_get_be32(f);
1588
1589         sub_vmsd = vmstate_get_subsection(vmsd->subsections, idstr);
1590         if (sub_vmsd == NULL) {
1591             return -ENOENT;
1592         }
1593         ret = vmstate_load_state(f, sub_vmsd, opaque, version_id);
1594         if (ret) {
1595             return ret;
1596         }
1597     }
1598     return 0;
1599 }
1600
1601 static void vmstate_subsection_save(QEMUFile *f, const VMStateDescription *vmsd,
1602                                     void *opaque)
1603 {
1604     const VMStateSubsection *sub = vmsd->subsections;
1605
1606     while (sub && sub->needed) {
1607         if (sub->needed(opaque)) {
1608             const VMStateDescription *vmsd = sub->vmsd;
1609             uint8_t len;
1610
1611             qemu_put_byte(f, QEMU_VM_SUBSECTION);
1612             len = strlen(vmsd->name);
1613             qemu_put_byte(f, len);
1614             qemu_put_buffer(f, (uint8_t *)vmsd->name, len);
1615             qemu_put_be32(f, vmsd->version_id);
1616             vmstate_save_state(f, vmsd, opaque);
1617         }
1618         sub++;
1619     }
1620 }
1621
1622 typedef struct LoadStateEntry {
1623     QLIST_ENTRY(LoadStateEntry) entry;
1624     SaveStateEntry *se;
1625     int section_id;
1626     int version_id;
1627 } LoadStateEntry;
1628
1629 int qemu_loadvm_state(QEMUFile *f)
1630 {
1631     QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1632         QLIST_HEAD_INITIALIZER(loadvm_handlers);
1633     LoadStateEntry *le, *new_le;
1634     uint8_t section_type;
1635     unsigned int v;
1636     int ret;
1637
1638     v = qemu_get_be32(f);
1639     if (v != QEMU_VM_FILE_MAGIC)
1640         return -EINVAL;
1641
1642     v = qemu_get_be32(f);
1643     if (v == QEMU_VM_FILE_VERSION_COMPAT) {
1644         fprintf(stderr, "SaveVM v2 format is obsolete and don't work anymore\n");
1645         return -ENOTSUP;
1646     }
1647     if (v != QEMU_VM_FILE_VERSION)
1648         return -ENOTSUP;
1649
1650     while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
1651         uint32_t instance_id, version_id, section_id;
1652         SaveStateEntry *se;
1653         char idstr[257];
1654         int len;
1655
1656         switch (section_type) {
1657         case QEMU_VM_SECTION_START:
1658         case QEMU_VM_SECTION_FULL:
1659             /* Read section start */
1660             section_id = qemu_get_be32(f);
1661             len = qemu_get_byte(f);
1662             qemu_get_buffer(f, (uint8_t *)idstr, len);
1663             idstr[len] = 0;
1664             instance_id = qemu_get_be32(f);
1665             version_id = qemu_get_be32(f);
1666
1667             /* Find savevm section */
1668             se = find_se(idstr, instance_id);
1669             if (se == NULL) {
1670                 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
1671                 ret = -EINVAL;
1672                 goto out;
1673             }
1674
1675             /* Validate version */
1676             if (version_id > se->version_id) {
1677                 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
1678                         version_id, idstr, se->version_id);
1679                 ret = -EINVAL;
1680                 goto out;
1681             }
1682
1683             /* Add entry */
1684             le = qemu_mallocz(sizeof(*le));
1685
1686             le->se = se;
1687             le->section_id = section_id;
1688             le->version_id = version_id;
1689             QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1690
1691             ret = vmstate_load(f, le->se, le->version_id);
1692             if (ret < 0) {
1693                 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1694                         instance_id, idstr);
1695                 goto out;
1696             }
1697             break;
1698         case QEMU_VM_SECTION_PART:
1699         case QEMU_VM_SECTION_END:
1700             section_id = qemu_get_be32(f);
1701
1702             QLIST_FOREACH(le, &loadvm_handlers, entry) {
1703                 if (le->section_id == section_id) {
1704                     break;
1705                 }
1706             }
1707             if (le == NULL) {
1708                 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1709                 ret = -EINVAL;
1710                 goto out;
1711             }
1712
1713             ret = vmstate_load(f, le->se, le->version_id);
1714             if (ret < 0) {
1715                 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1716                         section_id);
1717                 goto out;
1718             }
1719             break;
1720         default:
1721             fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1722             ret = -EINVAL;
1723             goto out;
1724         }
1725     }
1726
1727     cpu_synchronize_all_post_init();
1728
1729     ret = 0;
1730
1731 out:
1732     QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1733         QLIST_REMOVE(le, entry);
1734         qemu_free(le);
1735     }
1736
1737     if (qemu_file_has_error(f))
1738         ret = -EIO;
1739
1740     return ret;
1741 }
1742
1743 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1744                               const char *name)
1745 {
1746     QEMUSnapshotInfo *sn_tab, *sn;
1747     int nb_sns, i, ret;
1748
1749     ret = -ENOENT;
1750     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1751     if (nb_sns < 0)
1752         return ret;
1753     for(i = 0; i < nb_sns; i++) {
1754         sn = &sn_tab[i];
1755         if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1756             *sn_info = *sn;
1757             ret = 0;
1758             break;
1759         }
1760     }
1761     qemu_free(sn_tab);
1762     return ret;
1763 }
1764
1765 /*
1766  * Deletes snapshots of a given name in all opened images.
1767  */
1768 static int del_existing_snapshots(Monitor *mon, const char *name)
1769 {
1770     BlockDriverState *bs;
1771     QEMUSnapshotInfo sn1, *snapshot = &sn1;
1772     int ret;
1773
1774     bs = NULL;
1775     while ((bs = bdrv_next(bs))) {
1776         if (bdrv_can_snapshot(bs) &&
1777             bdrv_snapshot_find(bs, snapshot, name) >= 0)
1778         {
1779             ret = bdrv_snapshot_delete(bs, name);
1780             if (ret < 0) {
1781                 monitor_printf(mon,
1782                                "Error while deleting snapshot on '%s'\n",
1783                                bdrv_get_device_name(bs));
1784                 return -1;
1785             }
1786         }
1787     }
1788
1789     return 0;
1790 }
1791
1792 void do_savevm(Monitor *mon, const QDict *qdict)
1793 {
1794     BlockDriverState *bs, *bs1;
1795     QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1796     int ret;
1797     QEMUFile *f;
1798     int saved_vm_running;
1799     uint32_t vm_state_size;
1800 #ifdef _WIN32
1801     struct _timeb tb;
1802 #else
1803     struct timeval tv;
1804 #endif
1805     const char *name = qdict_get_try_str(qdict, "name");
1806
1807     /* Verify if there is a device that doesn't support snapshots and is writable */
1808     bs = NULL;
1809     while ((bs = bdrv_next(bs))) {
1810
1811         if (bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
1812             continue;
1813         }
1814
1815         if (!bdrv_can_snapshot(bs)) {
1816             monitor_printf(mon, "Device '%s' is writable but does not support snapshots.\n",
1817                                bdrv_get_device_name(bs));
1818             return;
1819         }
1820     }
1821
1822     bs = bdrv_snapshots();
1823     if (!bs) {
1824         monitor_printf(mon, "No block device can accept snapshots\n");
1825         return;
1826     }
1827     /* ??? Should this occur after vm_stop?  */
1828     qemu_aio_flush();
1829
1830     saved_vm_running = vm_running;
1831     vm_stop(0);
1832
1833     memset(sn, 0, sizeof(*sn));
1834     if (name) {
1835         ret = bdrv_snapshot_find(bs, old_sn, name);
1836         if (ret >= 0) {
1837             pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
1838             pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
1839         } else {
1840             pstrcpy(sn->name, sizeof(sn->name), name);
1841         }
1842     }
1843
1844     /* fill auxiliary fields */
1845 #ifdef _WIN32
1846     _ftime(&tb);
1847     sn->date_sec = tb.time;
1848     sn->date_nsec = tb.millitm * 1000000;
1849 #else
1850     gettimeofday(&tv, NULL);
1851     sn->date_sec = tv.tv_sec;
1852     sn->date_nsec = tv.tv_usec * 1000;
1853 #endif
1854     sn->vm_clock_nsec = qemu_get_clock(vm_clock);
1855
1856     /* Delete old snapshots of the same name */
1857     if (name && del_existing_snapshots(mon, name) < 0) {
1858         goto the_end;
1859     }
1860
1861     /* save the VM state */
1862     f = qemu_fopen_bdrv(bs, 1);
1863     if (!f) {
1864         monitor_printf(mon, "Could not open VM state file\n");
1865         goto the_end;
1866     }
1867     ret = qemu_savevm_state(mon, f);
1868     vm_state_size = qemu_ftell(f);
1869     qemu_fclose(f);
1870     if (ret < 0) {
1871         monitor_printf(mon, "Error %d while writing VM\n", ret);
1872         goto the_end;
1873     }
1874
1875     /* create the snapshots */
1876
1877     bs1 = NULL;
1878     while ((bs1 = bdrv_next(bs1))) {
1879         if (bdrv_can_snapshot(bs1)) {
1880             /* Write VM state size only to the image that contains the state */
1881             sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
1882             ret = bdrv_snapshot_create(bs1, sn);
1883             if (ret < 0) {
1884                 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
1885                                bdrv_get_device_name(bs1));
1886             }
1887         }
1888     }
1889
1890  the_end:
1891     if (saved_vm_running)
1892         vm_start();
1893 }
1894
1895 int load_vmstate(const char *name)
1896 {
1897     BlockDriverState *bs, *bs1;
1898     QEMUSnapshotInfo sn;
1899     QEMUFile *f;
1900     int ret;
1901
1902     /* Verify if there is a device that doesn't support snapshots and is writable */
1903     bs = NULL;
1904     while ((bs = bdrv_next(bs))) {
1905
1906         if (bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
1907             continue;
1908         }
1909
1910         if (!bdrv_can_snapshot(bs)) {
1911             error_report("Device '%s' is writable but does not support snapshots.",
1912                                bdrv_get_device_name(bs));
1913             return -ENOTSUP;
1914         }
1915     }
1916
1917     bs = bdrv_snapshots();
1918     if (!bs) {
1919         error_report("No block device supports snapshots");
1920         return -EINVAL;
1921     }
1922
1923     /* Flush all IO requests so they don't interfere with the new state.  */
1924     qemu_aio_flush();
1925
1926     bs1 = NULL;
1927     while ((bs1 = bdrv_next(bs1))) {
1928         if (bdrv_can_snapshot(bs1)) {
1929             ret = bdrv_snapshot_goto(bs1, name);
1930             if (ret < 0) {
1931                 switch(ret) {
1932                 case -ENOTSUP:
1933                     error_report("%sSnapshots not supported on device '%s'",
1934                                  bs != bs1 ? "Warning: " : "",
1935                                  bdrv_get_device_name(bs1));
1936                     break;
1937                 case -ENOENT:
1938                     error_report("%sCould not find snapshot '%s' on device '%s'",
1939                                  bs != bs1 ? "Warning: " : "",
1940                                  name, bdrv_get_device_name(bs1));
1941                     break;
1942                 default:
1943                     error_report("%sError %d while activating snapshot on '%s'",
1944                                  bs != bs1 ? "Warning: " : "",
1945                                  ret, bdrv_get_device_name(bs1));
1946                     break;
1947                 }
1948                 /* fatal on snapshot block device */
1949                 if (bs == bs1)
1950                     return 0;
1951             }
1952         }
1953     }
1954
1955     /* Don't even try to load empty VM states */
1956     ret = bdrv_snapshot_find(bs, &sn, name);
1957     if ((ret >= 0) && (sn.vm_state_size == 0))
1958         return -EINVAL;
1959
1960     /* restore the VM state */
1961     f = qemu_fopen_bdrv(bs, 0);
1962     if (!f) {
1963         error_report("Could not open VM state file");
1964         return -EINVAL;
1965     }
1966     ret = qemu_loadvm_state(f);
1967     qemu_fclose(f);
1968     if (ret < 0) {
1969         error_report("Error %d while loading VM state", ret);
1970         return ret;
1971     }
1972     return 0;
1973 }
1974
1975 void do_delvm(Monitor *mon, const QDict *qdict)
1976 {
1977     BlockDriverState *bs, *bs1;
1978     int ret;
1979     const char *name = qdict_get_str(qdict, "name");
1980
1981     bs = bdrv_snapshots();
1982     if (!bs) {
1983         monitor_printf(mon, "No block device supports snapshots\n");
1984         return;
1985     }
1986
1987     bs1 = NULL;
1988     while ((bs1 = bdrv_next(bs1))) {
1989         if (bdrv_can_snapshot(bs1)) {
1990             ret = bdrv_snapshot_delete(bs1, name);
1991             if (ret < 0) {
1992                 if (ret == -ENOTSUP)
1993                     monitor_printf(mon,
1994                                    "Snapshots not supported on device '%s'\n",
1995                                    bdrv_get_device_name(bs1));
1996                 else
1997                     monitor_printf(mon, "Error %d while deleting snapshot on "
1998                                    "'%s'\n", ret, bdrv_get_device_name(bs1));
1999             }
2000         }
2001     }
2002 }
2003
2004 void do_info_snapshots(Monitor *mon)
2005 {
2006     BlockDriverState *bs, *bs1;
2007     QEMUSnapshotInfo *sn_tab, *sn;
2008     int nb_sns, i;
2009     char buf[256];
2010
2011     bs = bdrv_snapshots();
2012     if (!bs) {
2013         monitor_printf(mon, "No available block device supports snapshots\n");
2014         return;
2015     }
2016     monitor_printf(mon, "Snapshot devices:");
2017     bs1 = NULL;
2018     while ((bs1 = bdrv_next(bs1))) {
2019         if (bdrv_can_snapshot(bs1)) {
2020             if (bs == bs1)
2021                 monitor_printf(mon, " %s", bdrv_get_device_name(bs1));
2022         }
2023     }
2024     monitor_printf(mon, "\n");
2025
2026     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2027     if (nb_sns < 0) {
2028         monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
2029         return;
2030     }
2031     monitor_printf(mon, "Snapshot list (from %s):\n",
2032                    bdrv_get_device_name(bs));
2033     monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
2034     for(i = 0; i < nb_sns; i++) {
2035         sn = &sn_tab[i];
2036         monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
2037     }
2038     qemu_free(sn_tab);
2039 }