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 int 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
 567 int64_t qemu_ftell(QEMUFile *f)
 568 {
 569     return f->buf_offset - f->buf_size + f->buf_index;
 570 }
 571
 572 int64_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
 593 int 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
 601 size_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
 609 size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate)
 610 {
 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)
 614         return f->set_rate_limit(f->opaque, new_rate);
 615
 616     return 0;
 617 }
 618
 619 void qemu_put_be16(QEMUFile *f, unsigned int v)
 620 {
 621     qemu_put_byte(f, v >> 8);
 622     qemu_put_byte(f, v);
 623 }
 624
 625 void 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
 633 void qemu_put_be64(QEMUFile *f, uint64_t v)
 634 {
 635     qemu_put_be32(f, v >> 32);
 636     qemu_put_be32(f, v);
 637 }
 638
 639 unsigned 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
 647 unsigned 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
 657 uint64_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
 665 /* 8 bit int */
 666
 667 static 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
 674 static void put_int8(QEMUFile *f, void *pv, size_t size)
 675 {
 676     int8_t *v = pv;
 677     qemu_put_s8s(f, v);
 678 }
 679
 680 const VMStateInfo vmstate_info_int8 = {
 681     .name = "int8",
 682     .get  = get_int8,
 683     .put  = put_int8,
 684 };
 685
 686 /* 16 bit int */
 687
 688 static 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
 695 static void put_int16(QEMUFile *f, void *pv, size_t size)
 696 {
 697     int16_t *v = pv;
 698     qemu_put_sbe16s(f, v);
 699 }
 700
 701 const VMStateInfo vmstate_info_int16 = {
 702     .name = "int16",
 703     .get  = get_int16,
 704     .put  = put_int16,
 705 };
 706
 707 /* 32 bit int */
 708
 709 static 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
 716 static void put_int32(QEMUFile *f, void *pv, size_t size)
 717 {
 718     int32_t *v = pv;
 719     qemu_put_sbe32s(f, v);
 720 }
 721
 722 const VMStateInfo vmstate_info_int32 = {
 723     .name = "int32",
 724     .get  = get_int32,
 725     .put  = put_int32,
 726 };
 727
 728 /* 32 bit int. See that the received value is the same than the one
 729    in the field */
 730
 731 static 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
 742 const VMStateInfo vmstate_info_int32_equal = {
 743     .name = "int32 equal",
 744     .get  = get_int32_equal,
 745     .put  = put_int32,
 746 };
 747
 748 /* 32 bit int. See that the received value is the less or the same
 749    than the one in the field */
 750
 751 static 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
 762 const VMStateInfo vmstate_info_int32_le = {
 763     .name = "int32 equal",
 764     .get  = get_int32_le,
 765     .put  = put_int32,
 766 };
 767
 768 /* 64 bit int */
 769
 770 static 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
 777 static void put_int64(QEMUFile *f, void *pv, size_t size)
 778 {
 779     int64_t *v = pv;
 780     qemu_put_sbe64s(f, v);
 781 }
 782
 783 const VMStateInfo vmstate_info_int64 = {
 784     .name = "int64",
 785     .get  = get_int64,
 786     .put  = put_int64,
 787 };
 788
 789 /* 8 bit unsigned int */
 790
 791 static 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
 798 static void put_uint8(QEMUFile *f, void *pv, size_t size)
 799 {
 800     uint8_t *v = pv;
 801     qemu_put_8s(f, v);
 802 }
 803
 804 const VMStateInfo vmstate_info_uint8 = {
 805     .name = "uint8",
 806     .get  = get_uint8,
 807     .put  = put_uint8,
 808 };
 809
 810 /* 16 bit unsigned int */
 811
 812 static 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
 819 static void put_uint16(QEMUFile *f, void *pv, size_t size)
 820 {
 821     uint16_t *v = pv;
 822     qemu_put_be16s(f, v);
 823 }
 824
 825 const VMStateInfo vmstate_info_uint16 = {
 826     .name = "uint16",
 827     .get  = get_uint16,
 828     .put  = put_uint16,
 829 };
 830
 831 /* 32 bit unsigned int */
 832
 833 static 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
 840 static void put_uint32(QEMUFile *f, void *pv, size_t size)
 841 {
 842     uint32_t *v = pv;
 843     qemu_put_be32s(f, v);
 844 }
 845
 846 const VMStateInfo vmstate_info_uint32 = {
 847     .name = "uint32",
 848     .get  = get_uint32,
 849     .put  = put_uint32,
 850 };
 851
 852 /* 64 bit unsigned int */
 853
 854 static 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
 861 static void put_uint64(QEMUFile *f, void *pv, size_t size)
 862 {
 863     uint64_t *v = pv;
 864     qemu_put_be64s(f, v);
 865 }
 866
 867 const VMStateInfo vmstate_info_uint64 = {
 868     .name = "uint64",
 869     .get  = get_uint64,
 870     .put  = put_uint64,
 871 };
 872
 873 /* 8 bit int. See that the received value is the same than the one
 874    in the field */
 875
 876 static 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
 887 const VMStateInfo vmstate_info_uint8_equal = {
 888     .name = "uint8 equal",
 889     .get  = get_uint8_equal,
 890     .put  = put_uint8,
 891 };
 892
 893 /* 16 bit unsigned int int. See that the received value is the same than the one
 894    in the field */
 895
 896 static 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
 907 const VMStateInfo vmstate_info_uint16_equal = {
 908     .name = "uint16 equal",
 909     .get  = get_uint16_equal,
 910     .put  = put_uint16,
 911 };
 912
 913 /* timers  */
 914
 915 static 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
 922 static void put_timer(QEMUFile *f, void *pv, size_t size)
 923 {
 924     QEMUTimer *v = pv;
 925     qemu_put_timer(f, v);
 926 }
 927
 928 const VMStateInfo vmstate_info_timer = {
 929     .name = "timer",
 930     .get  = get_timer,
 931     .put  = put_timer,
 932 };
 933
 934 /* uint8_t buffers */
 935
 936 static 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
 943 static void put_buffer(QEMUFile *f, void *pv, size_t size)
 944 {
 945     uint8_t *v = pv;
 946     qemu_put_buffer(f, v, size);
 947 }
 948
 949 const VMStateInfo vmstate_info_buffer = {
 950     .name = "buffer",
 951     .get  = get_buffer,
 952     .put  = put_buffer,
 953 };
 954
 955 /* unused buffers: space that was used for some fields that are
 956    not usefull anymore */
 957
 958 static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
 959 {
 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;
 969 }
 970
 971 static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
 972 {
 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     }
 981 }
 982
 983 const VMStateInfo vmstate_info_unused_buffer = {
 984     .name = "unused_buffer",
 985     .get  = get_unused_buffer,
 986     .put  = put_unused_buffer,
 987 };
 988
 989 typedef struct CompatEntry {
 990     char idstr[256];
 991     int instance_id;
 992 } CompatEntry;
 993
 994 typedef struct SaveStateEntry {
 995     QTAILQ_ENTRY(SaveStateEntry) entry;
 996     char idstr[256];
 997     int instance_id;
 998     int alias_id;
 999     int version_id;
1000     int section_id;
1001     SaveSetParamsHandler *set_params;
1002     SaveLiveStateHandler *save_live_state;
1003     SaveStateHandler *save_state;
1004     LoadStateHandler *load_state;
1005     const VMStateDescription *vmsd;
1006     void *opaque;
1007     CompatEntry *compat;
1008 } SaveStateEntry;
1009
1010
1011 static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
1012     QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1013 static int global_section_id;
1014
1015 static int calculate_new_instance_id(const char *idstr)
1016 {
1017     SaveStateEntry *se;
1018     int instance_id = 0;
1019
1020     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
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
1029 static 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
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. */
1050 int register_savevm_live(DeviceState *dev,
1051                          const char *idstr,
1052                          int instance_id,
1053                          int version_id,
1054                          SaveSetParamsHandler *set_params,
1055                          SaveLiveStateHandler *save_live_state,
1056                          SaveStateHandler *save_state,
1057                          LoadStateHandler *load_state,
1058                          void *opaque)
1059 {
1060     SaveStateEntry *se;
1061
1062     se = qemu_mallocz(sizeof(SaveStateEntry));
1063     se->version_id = version_id;
1064     se->section_id = global_section_id++;
1065     se->set_params = set_params;
1066     se->save_live_state = save_live_state;
1067     se->save_state = save_state;
1068     se->load_state = load_state;
1069     se->opaque = opaque;
1070     se->vmsd = NULL;
1071
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
1088     if (instance_id == -1) {
1089         se->instance_id = calculate_new_instance_id(se->idstr);
1090     } else {
1091         se->instance_id = instance_id;
1092     }
1093     assert(!se->compat || se->instance_id == 0);
1094     /* add at the end of list */
1095     QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1096     return 0;
1097 }
1098
1099 int register_savevm(DeviceState *dev,
1100                     const char *idstr,
1101                     int instance_id,
1102                     int version_id,
1103                     SaveStateHandler *save_state,
1104                     LoadStateHandler *load_state,
1105                     void *opaque)
1106 {
1107     return register_savevm_live(dev, idstr, instance_id, version_id,
1108                                 NULL, NULL, save_state, load_state, opaque);
1109 }
1110
1111 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1112 {
1113     SaveStateEntry *se, *new_se;
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);
1125
1126     QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1127         if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
1128             QTAILQ_REMOVE(&savevm_handlers, se, entry);
1129             qemu_free(se);
1130         }
1131     }
1132 }
1133
1134 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
1135                                    const VMStateDescription *vmsd,
1136                                    void *opaque, int alias_id,
1137                                    int required_for_version)
1138 {
1139     SaveStateEntry *se;
1140
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
1144     se = qemu_mallocz(sizeof(SaveStateEntry));
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;
1152     se->alias_id = alias_id;
1153
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
1170     if (instance_id == -1) {
1171         se->instance_id = calculate_new_instance_id(se->idstr);
1172     } else {
1173         se->instance_id = instance_id;
1174     }
1175     assert(!se->compat || se->instance_id == 0);
1176     /* add at the end of list */
1177     QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
1178     return 0;
1179 }
1180
1181 int vmstate_register(DeviceState *dev, int instance_id,
1182                      const VMStateDescription *vmsd, void *opaque)
1183 {
1184     return vmstate_register_with_alias_id(dev, instance_id, vmsd,
1185                                           opaque, -1, 0);
1186 }
1187
1188 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1189                         void *opaque)
1190 {
1191     SaveStateEntry *se, *new_se;
1192
1193     QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1194         if (se->vmsd == vmsd && se->opaque == opaque) {
1195             QTAILQ_REMOVE(&savevm_handlers, se, entry);
1196             qemu_free(se);
1197         }
1198     }
1199 }
1200
1201 int 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     }
1215     if (vmsd->pre_load) {
1216         int ret = vmsd->pre_load(opaque);
1217         if (ret)
1218             return ret;
1219     }
1220     while(field->name) {
1221         if ((field->field_exists &&
1222              field->field_exists(opaque, version_id)) ||
1223             (!field->field_exists &&
1224              field->version_id <= version_id)) {
1225             void *base_addr = opaque + field->offset;
1226             int ret, i, n_elems = 1;
1227             int size = field->size;
1228
1229             if (field->flags & VMS_VBUFFER) {
1230                 size = *(int32_t *)(opaque+field->size_offset);
1231                 if (field->flags & VMS_MULTIPLY) {
1232                     size *= field->size;
1233                 }
1234             }
1235             if (field->flags & VMS_ARRAY) {
1236                 n_elems = field->num;
1237             } else if (field->flags & VMS_VARRAY_INT32) {
1238                 n_elems = *(int32_t *)(opaque+field->num_offset);
1239             } else if (field->flags & VMS_VARRAY_UINT16) {
1240                 n_elems = *(uint16_t *)(opaque+field->num_offset);
1241             }
1242             if (field->flags & VMS_POINTER) {
1243                 base_addr = *(void **)base_addr + field->start;
1244             }
1245             for (i = 0; i < n_elems; i++) {
1246                 void *addr = base_addr + size * i;
1247
1248                 if (field->flags & VMS_ARRAY_OF_POINTER) {
1249                     addr = *(void **)addr;
1250                 }
1251                 if (field->flags & VMS_STRUCT) {
1252                     ret = vmstate_load_state(f, field->vmsd, addr, field->vmsd->version_id);
1253                 } else {
1254                     ret = field->info->get(f, addr, size);
1255
1256                 }
1257                 if (ret < 0) {
1258                     return ret;
1259                 }
1260             }
1261         }
1262         field++;
1263     }
1264     if (vmsd->post_load) {
1265         return vmsd->post_load(opaque, version_id);
1266     }
1267     return 0;
1268 }
1269
1270 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1271                         void *opaque)
1272 {
1273     VMStateField *field = vmsd->fields;
1274
1275     if (vmsd->pre_save) {
1276         vmsd->pre_save(opaque);
1277     }
1278     while(field->name) {
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;
1283             int size = field->size;
1284
1285             if (field->flags & VMS_VBUFFER) {
1286                 size = *(int32_t *)(opaque+field->size_offset);
1287                 if (field->flags & VMS_MULTIPLY) {
1288                     size *= field->size;
1289                 }
1290             }
1291             if (field->flags & VMS_ARRAY) {
1292                 n_elems = field->num;
1293             } else if (field->flags & VMS_VARRAY_INT32) {
1294                 n_elems = *(int32_t *)(opaque+field->num_offset);
1295             } else if (field->flags & VMS_VARRAY_UINT16) {
1296                 n_elems = *(uint16_t *)(opaque+field->num_offset);
1297             }
1298             if (field->flags & VMS_POINTER) {
1299                 base_addr = *(void **)base_addr + field->start;
1300             }
1301             for (i = 0; i < n_elems; i++) {
1302                 void *addr = base_addr + size * i;
1303
1304                 if (field->flags & VMS_ARRAY_OF_POINTER) {
1305                     addr = *(void **)addr;
1306                 }
1307                 if (field->flags & VMS_STRUCT) {
1308                     vmstate_save_state(f, field->vmsd, addr);
1309                 } else {
1310                     field->info->put(f, addr, size);
1311                 }
1312             }
1313         }
1314         field++;
1315     }
1316 }
1317
1318 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
1319 {
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);
1324 }
1325
1326 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
1327 {
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);
1333 }
1334
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
1345 int qemu_savevm_state_begin(Monitor *mon, QEMUFile *f, int blk_enable,
1346                             int shared)
1347 {
1348     SaveStateEntry *se;
1349
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
1357     qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
1358     qemu_put_be32(f, QEMU_VM_FILE_VERSION);
1359
1360     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
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
1378         se->save_live_state(mon, f, QEMU_VM_SECTION_START, se->opaque);
1379     }
1380
1381     if (qemu_file_has_error(f)) {
1382         qemu_savevm_state_cancel(mon, f);
1383         return -EIO;
1384     }
1385
1386     return 0;
1387 }
1388
1389 int qemu_savevm_state_iterate(Monitor *mon, QEMUFile *f)
1390 {
1391     SaveStateEntry *se;
1392     int ret = 1;
1393
1394     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
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
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         }
1410     }
1411
1412     if (ret)
1413         return 1;
1414
1415     if (qemu_file_has_error(f)) {
1416         qemu_savevm_state_cancel(mon, f);
1417         return -EIO;
1418     }
1419
1420     return 0;
1421 }
1422
1423 int qemu_savevm_state_complete(Monitor *mon, QEMUFile *f)
1424 {
1425     SaveStateEntry *se;
1426
1427     cpu_synchronize_all_states();
1428
1429     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
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
1437         se->save_live_state(mon, f, QEMU_VM_SECTION_END, se->opaque);
1438     }
1439
1440     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1441         int len;
1442
1443         if (se->save_state == NULL && se->vmsd == NULL)
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
1458         vmstate_save(f, se);
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
1469 void qemu_savevm_state_cancel(Monitor *mon, QEMUFile *f)
1470 {
1471     SaveStateEntry *se;
1472
1473     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1474         if (se->save_live_state) {
1475             se->save_live_state(mon, f, -1, se->opaque);
1476         }
1477     }
1478 }
1479
1480 static int qemu_savevm_state(Monitor *mon, QEMUFile *f)
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
1490     ret = qemu_savevm_state_begin(mon, f, 0, 0);
1491     if (ret < 0)
1492         goto out;
1493
1494     do {
1495         ret = qemu_savevm_state_iterate(mon, f);
1496         if (ret < 0)
1497             goto out;
1498     } while (ret == 0);
1499
1500     ret = qemu_savevm_state_complete(mon, f);
1501
1502 out:
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
1512 static SaveStateEntry *find_se(const char *idstr, int instance_id)
1513 {
1514     SaveStateEntry *se;
1515
1516     QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1517         if (!strcmp(se->idstr, idstr) &&
1518             (instance_id == se->instance_id ||
1519              instance_id == se->alias_id))
1520             return se;
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         }
1528     }
1529     return NULL;
1530 }
1531
1532 typedef struct LoadStateEntry {
1533     QLIST_ENTRY(LoadStateEntry) entry;
1534     SaveStateEntry *se;
1535     int section_id;
1536     int version_id;
1537 } LoadStateEntry;
1538
1539 int qemu_loadvm_state(QEMUFile *f)
1540 {
1541     QLIST_HEAD(, LoadStateEntry) loadvm_handlers =
1542         QLIST_HEAD_INITIALIZER(loadvm_handlers);
1543     LoadStateEntry *le, *new_le;
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);
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     }
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;
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));
1595
1596             le->se = se;
1597             le->section_id = section_id;
1598             le->version_id = version_id;
1599             QLIST_INSERT_HEAD(&loadvm_handlers, le, entry);
1600
1601             ret = vmstate_load(f, le->se, le->version_id);
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             }
1607             break;
1608         case QEMU_VM_SECTION_PART:
1609         case QEMU_VM_SECTION_END:
1610             section_id = qemu_get_be32(f);
1611
1612             QLIST_FOREACH(le, &loadvm_handlers, entry) {
1613                 if (le->section_id == section_id) {
1614                     break;
1615                 }
1616             }
1617             if (le == NULL) {
1618                 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1619                 ret = -EINVAL;
1620                 goto out;
1621             }
1622
1623             ret = vmstate_load(f, le->se, le->version_id);
1624             if (ret < 0) {
1625                 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1626                         section_id);
1627                 goto out;
1628             }
1629             break;
1630         default:
1631             fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1632             ret = -EINVAL;
1633             goto out;
1634         }
1635     }
1636
1637     cpu_synchronize_all_post_init();
1638
1639     ret = 0;
1640
1641 out:
1642     QLIST_FOREACH_SAFE(le, &loadvm_handlers, entry, new_le) {
1643         QLIST_REMOVE(le, entry);
1644         qemu_free(le);
1645     }
1646
1647     if (qemu_file_has_error(f))
1648         ret = -EIO;
1649
1650     return ret;
1651 }
1652
1653 static 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
1675 /*
1676  * Deletes snapshots of a given name in all opened images.
1677  */
1678 static int del_existing_snapshots(Monitor *mon, const char *name)
1679 {
1680     BlockDriverState *bs;
1681     QEMUSnapshotInfo sn1, *snapshot = &sn1;
1682     int ret;
1683
1684     bs = NULL;
1685     while ((bs = bdrv_next(bs))) {
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
1702 void do_savevm(Monitor *mon, const QDict *qdict)
1703 {
1704     BlockDriverState *bs, *bs1;
1705     QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1706     int ret;
1707     QEMUFile *f;
1708     int saved_vm_running;
1709     uint32_t vm_state_size;
1710 #ifdef _WIN32
1711     struct _timeb tb;
1712 #else
1713     struct timeval tv;
1714 #endif
1715     const char *name = qdict_get_try_str(qdict, "name");
1716
1717     /* Verify if there is a device that doesn't support snapshots and is writable */
1718     bs = NULL;
1719     while ((bs = bdrv_next(bs))) {
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
1732     bs = bdrv_snapshots();
1733     if (!bs) {
1734         monitor_printf(mon, "No block device can accept snapshots\n");
1735         return;
1736     }
1737     /* ??? Should this occur after vm_stop?  */
1738     qemu_aio_flush();
1739
1740     saved_vm_running = vm_running;
1741     vm_stop(0);
1742
1743     memset(sn, 0, sizeof(*sn));
1744     if (name) {
1745         ret = bdrv_snapshot_find(bs, old_sn, name);
1746         if (ret >= 0) {
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 {
1750             pstrcpy(sn->name, sizeof(sn->name), name);
1751         }
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
1766     /* Delete old snapshots of the same name */
1767     if (name && del_existing_snapshots(mon, name) < 0) {
1768         goto the_end;
1769     }
1770
1771     /* save the VM state */
1772     f = qemu_fopen_bdrv(bs, 1);
1773     if (!f) {
1774         monitor_printf(mon, "Could not open VM state file\n");
1775         goto the_end;
1776     }
1777     ret = qemu_savevm_state(mon, f);
1778     vm_state_size = qemu_ftell(f);
1779     qemu_fclose(f);
1780     if (ret < 0) {
1781         monitor_printf(mon, "Error %d while writing VM\n", ret);
1782         goto the_end;
1783     }
1784
1785     /* create the snapshots */
1786
1787     bs1 = NULL;
1788     while ((bs1 = bdrv_next(bs1))) {
1789         if (bdrv_can_snapshot(bs1)) {
1790             /* Write VM state size only to the image that contains the state */
1791             sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
1792             ret = bdrv_snapshot_create(bs1, sn);
1793             if (ret < 0) {
1794                 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
1795                                bdrv_get_device_name(bs1));
1796             }
1797         }
1798     }
1799
1800  the_end:
1801     if (saved_vm_running)
1802         vm_start();
1803 }
1804
1805 int load_vmstate(const char *name)
1806 {
1807     BlockDriverState *bs, *bs1;
1808     QEMUSnapshotInfo sn;
1809     QEMUFile *f;
1810     int ret;
1811
1812     /* Verify if there is a device that doesn't support snapshots and is writable */
1813     bs = NULL;
1814     while ((bs = bdrv_next(bs))) {
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
1827     bs = bdrv_snapshots();
1828     if (!bs) {
1829         error_report("No block device supports snapshots");
1830         return -EINVAL;
1831     }
1832
1833     /* Flush all IO requests so they don't interfere with the new state.  */
1834     qemu_aio_flush();
1835
1836     bs1 = NULL;
1837     while ((bs1 = bdrv_next(bs1))) {
1838         if (bdrv_can_snapshot(bs1)) {
1839             ret = bdrv_snapshot_goto(bs1, name);
1840             if (ret < 0) {
1841                 switch(ret) {
1842                 case -ENOTSUP:
1843                     error_report("%sSnapshots not supported on device '%s'",
1844                                  bs != bs1 ? "Warning: " : "",
1845                                  bdrv_get_device_name(bs1));
1846                     break;
1847                 case -ENOENT:
1848                     error_report("%sCould not find snapshot '%s' on device '%s'",
1849                                  bs != bs1 ? "Warning: " : "",
1850                                  name, bdrv_get_device_name(bs1));
1851                     break;
1852                 default:
1853                     error_report("%sError %d while activating snapshot on '%s'",
1854                                  bs != bs1 ? "Warning: " : "",
1855                                  ret, bdrv_get_device_name(bs1));
1856                     break;
1857                 }
1858                 /* fatal on snapshot block device */
1859                 if (bs == bs1)
1860                     return 0;
1861             }
1862         }
1863     }
1864
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))
1868         return -EINVAL;
1869
1870     /* restore the VM state */
1871     f = qemu_fopen_bdrv(bs, 0);
1872     if (!f) {
1873         error_report("Could not open VM state file");
1874         return -EINVAL;
1875     }
1876     ret = qemu_loadvm_state(f);
1877     qemu_fclose(f);
1878     if (ret < 0) {
1879         error_report("Error %d while loading VM state", ret);
1880         return ret;
1881     }
1882     return 0;
1883 }
1884
1885 void do_delvm(Monitor *mon, const QDict *qdict)
1886 {
1887     BlockDriverState *bs, *bs1;
1888     int ret;
1889     const char *name = qdict_get_str(qdict, "name");
1890
1891     bs = bdrv_snapshots();
1892     if (!bs) {
1893         monitor_printf(mon, "No block device supports snapshots\n");
1894         return;
1895     }
1896
1897     bs1 = NULL;
1898     while ((bs1 = bdrv_next(bs1))) {
1899         if (bdrv_can_snapshot(bs1)) {
1900             ret = bdrv_snapshot_delete(bs1, name);
1901             if (ret < 0) {
1902                 if (ret == -ENOTSUP)
1903                     monitor_printf(mon,
1904                                    "Snapshots not supported on device '%s'\n",
1905                                    bdrv_get_device_name(bs1));
1906                 else
1907                     monitor_printf(mon, "Error %d while deleting snapshot on "
1908                                    "'%s'\n", ret, bdrv_get_device_name(bs1));
1909             }
1910         }
1911     }
1912 }
1913
1914 void do_info_snapshots(Monitor *mon)
1915 {
1916     BlockDriverState *bs, *bs1;
1917     QEMUSnapshotInfo *sn_tab, *sn;
1918     int nb_sns, i;
1919     char buf[256];
1920
1921     bs = bdrv_snapshots();
1922     if (!bs) {
1923         monitor_printf(mon, "No available block device supports snapshots\n");
1924         return;
1925     }
1926     monitor_printf(mon, "Snapshot devices:");
1927     bs1 = NULL;
1928     while ((bs1 = bdrv_next(bs1))) {
1929         if (bdrv_can_snapshot(bs1)) {
1930             if (bs == bs1)
1931                 monitor_printf(mon, " %s", bdrv_get_device_name(bs1));
1932         }
1933     }
1934     monitor_printf(mon, "\n");
1935
1936     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1937     if (nb_sns < 0) {
1938         monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
1939         return;
1940     }
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));
1944     for(i = 0; i < nb_sns; i++) {
1945         sn = &sn_tab[i];
1946         monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
1947     }
1948     qemu_free(sn_tab);
1949 }