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 #if defined(__NetBSD__)
  46 #include <net/if_tap.h>
  47 #endif
  48 #ifdef __linux__
  49 #include <linux/if_tun.h>
  50 #endif
  51 #include <arpa/inet.h>
  52 #include <dirent.h>
  53 #include <netdb.h>
  54 #include <sys/select.h>
  55 #ifdef CONFIG_BSD
  56 #include <sys/stat.h>
  57 #if defined(__FreeBSD__) || defined(__DragonFly__)
  58 #include <libutil.h>
  59 #else
  60 #include <util.h>
  61 #endif
  62 #elif defined (__GLIBC__) && defined (__FreeBSD_kernel__)
  63 #include <freebsd/stdlib.h>
  64 #else
  65 #ifdef __linux__
  66 #include <pty.h>
  67 #include <malloc.h>
  68 #include <linux/rtc.h>
  69 #endif
  70 #endif
  71 #endif
  72
  73 #ifdef _WIN32
  74 #include <windows.h>
  75 #include <malloc.h>
  76 #include <sys/timeb.h>
  77 #include <mmsystem.h>
  78 #define getopt_long_only getopt_long
  79 #define memalign(align, size) malloc(size)
  80 #endif
  81
  82 #include "qemu-common.h"
  83 #include "hw/hw.h"
  84 #include "net.h"
  85 #include "monitor.h"
  86 #include "sysemu.h"
  87 #include "qemu-timer.h"
  88 #include "qemu-char.h"
  89 #include "block.h"
  90 #include "audio/audio.h"
  91 #include "migration.h"
  92 #include "qemu_socket.h"
  93
  94 /* point to the block driver where the snapshots are managed */
  95 static BlockDriverState *bs_snapshots;
  96
  97 #define SELF_ANNOUNCE_ROUNDS 5
  98 #define ETH_P_EXPERIMENTAL 0x01F1 /* just a number */
  99 //#define ETH_P_EXPERIMENTAL 0x0012 /* make it the size of the packet */
 100 #define EXPERIMENTAL_MAGIC 0xf1f23f4f
 101
 102 static int announce_self_create(uint8_t *buf,
 103                                 uint8_t *mac_addr)
 104 {
 105     uint32_t magic = EXPERIMENTAL_MAGIC;
 106     uint16_t proto = htons(ETH_P_EXPERIMENTAL);
 107
 108     /* FIXME: should we send a different packet (arp/rarp/ping)? */
 109
 110     memset(buf, 0, 64);
 111     memset(buf, 0xff, 6);         /* h_dst */
 112     memcpy(buf + 6, mac_addr, 6); /* h_src */
 113     memcpy(buf + 12, &proto, 2);  /* h_proto */
 114     memcpy(buf + 14, &magic, 4);  /* magic */
 115
 116     return 64; /* len */
 117 }
 118
 119 static void qemu_announce_self_once(void *opaque)
 120 {
 121     int i, len;
 122     VLANState *vlan;
 123     VLANClientState *vc;
 124     uint8_t buf[256];
 125     static int count = SELF_ANNOUNCE_ROUNDS;
 126     QEMUTimer *timer = *(QEMUTimer **)opaque;
 127
 128     for (i = 0; i < MAX_NICS; i++) {
 129         if (!nd_table[i].used)
 130             continue;
 131         len = announce_self_create(buf, nd_table[i].macaddr);
 132         vlan = nd_table[i].vlan;
 133         for(vc = vlan->first_client; vc != NULL; vc = vc->next) {
 134             vc->receive(vc, buf, len);
 135         }
 136     }
 137     if (count--) {
 138             qemu_mod_timer(timer, qemu_get_clock(rt_clock) + 100);
 139     } else {
 140             qemu_del_timer(timer);
 141             qemu_free_timer(timer);
 142     }
 143 }
 144
 145 void qemu_announce_self(void)
 146 {
 147         static QEMUTimer *timer;
 148         timer = qemu_new_timer(rt_clock, qemu_announce_self_once, &timer);
 149         qemu_announce_self_once(&timer);
 150 }
 151
 152 /***********************************************************/
 153 /* savevm/loadvm support */
 154
 155 #define IO_BUF_SIZE 32768
 156
 157 struct QEMUFile {
 158     QEMUFilePutBufferFunc *put_buffer;
 159     QEMUFileGetBufferFunc *get_buffer;
 160     QEMUFileCloseFunc *close;
 161     QEMUFileRateLimit *rate_limit;
 162     QEMUFileSetRateLimit *set_rate_limit;
 163     void *opaque;
 164     int is_write;
 165
 166     int64_t buf_offset; /* start of buffer when writing, end of buffer
 167                            when reading */
 168     int buf_index;
 169     int buf_size; /* 0 when writing */
 170     uint8_t buf[IO_BUF_SIZE];
 171
 172     int has_error;
 173 };
 174
 175 typedef struct QEMUFileStdio
 176 {
 177     FILE *stdio_file;
 178     QEMUFile *file;
 179 } QEMUFileStdio;
 180
 181 typedef struct QEMUFileSocket
 182 {
 183     int fd;
 184     QEMUFile *file;
 185 } QEMUFileSocket;
 186
 187 static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
 188 {
 189     QEMUFileSocket *s = opaque;
 190     ssize_t len;
 191
 192     do {
 193         len = recv(s->fd, (void *)buf, size, 0);
 194     } while (len == -1 && socket_error() == EINTR);
 195
 196     if (len == -1)
 197         len = -socket_error();
 198
 199     return len;
 200 }
 201
 202 static int socket_close(void *opaque)
 203 {
 204     QEMUFileSocket *s = opaque;
 205     qemu_free(s);
 206     return 0;
 207 }
 208
 209 static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
 210 {
 211     QEMUFileStdio *s = opaque;
 212     return fwrite(buf, 1, size, s->stdio_file);
 213 }
 214
 215 static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
 216 {
 217     QEMUFileStdio *s = opaque;
 218     FILE *fp = s->stdio_file;
 219     int bytes;
 220
 221     do {
 222         clearerr(fp);
 223         bytes = fread(buf, 1, size, fp);
 224     } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
 225     return bytes;
 226 }
 227
 228 static int stdio_pclose(void *opaque)
 229 {
 230     QEMUFileStdio *s = opaque;
 231     pclose(s->stdio_file);
 232     qemu_free(s);
 233     return 0;
 234 }
 235
 236 static int stdio_fclose(void *opaque)
 237 {
 238     QEMUFileStdio *s = opaque;
 239     fclose(s->stdio_file);
 240     qemu_free(s);
 241     return 0;
 242 }
 243
 244 QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
 245 {
 246     QEMUFileStdio *s;
 247
 248     if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
 249         fprintf(stderr, "qemu_popen: Argument validity check failed\n");
 250         return NULL;
 251     }
 252
 253     s = qemu_mallocz(sizeof(QEMUFileStdio));
 254
 255     s->stdio_file = stdio_file;
 256
 257     if(mode[0] == 'r') {
 258         s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose, NULL, NULL);
 259     } else {
 260         s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose, NULL, NULL);
 261     }
 262     return s->file;
 263 }
 264
 265 QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
 266 {
 267     FILE *popen_file;
 268
 269     popen_file = popen(command, mode);
 270     if(popen_file == NULL) {
 271         return NULL;
 272     }
 273
 274     return qemu_popen(popen_file, mode);
 275 }
 276
 277 int qemu_stdio_fd(QEMUFile *f)
 278 {
 279     QEMUFileStdio *p;
 280     int fd;
 281
 282     p = (QEMUFileStdio *)f->opaque;
 283     fd = fileno(p->stdio_file);
 284
 285     return fd;
 286 }
 287
 288 QEMUFile *qemu_fdopen(int fd, const char *mode)
 289 {
 290     QEMUFileStdio *s;
 291
 292     if (mode == NULL ||
 293         (mode[0] != 'r' && mode[0] != 'w') ||
 294         mode[1] != 'b' || mode[2] != 0) {
 295         fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
 296         return NULL;
 297     }
 298
 299     s = qemu_mallocz(sizeof(QEMUFileStdio));
 300     s->stdio_file = fdopen(fd, mode);
 301     if (!s->stdio_file)
 302         goto fail;
 303
 304     if(mode[0] == 'r') {
 305         s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose, NULL, NULL);
 306     } else {
 307         s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose, NULL, NULL);
 308     }
 309     return s->file;
 310
 311 fail:
 312     qemu_free(s);
 313     return NULL;
 314 }
 315
 316 QEMUFile *qemu_fopen_socket(int fd)
 317 {
 318     QEMUFileSocket *s = qemu_mallocz(sizeof(QEMUFileSocket));
 319
 320     s->fd = fd;
 321     s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close, NULL, NULL);
 322     return s->file;
 323 }
 324
 325 static int file_put_buffer(void *opaque, const uint8_t *buf,
 326                             int64_t pos, int size)
 327 {
 328     QEMUFileStdio *s = opaque;
 329     fseek(s->stdio_file, pos, SEEK_SET);
 330     fwrite(buf, 1, size, s->stdio_file);
 331     return size;
 332 }
 333
 334 static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
 335 {
 336     QEMUFileStdio *s = opaque;
 337     fseek(s->stdio_file, pos, SEEK_SET);
 338     return fread(buf, 1, size, s->stdio_file);
 339 }
 340
 341 QEMUFile *qemu_fopen(const char *filename, const char *mode)
 342 {
 343     QEMUFileStdio *s;
 344
 345     if (mode == NULL ||
 346         (mode[0] != 'r' && mode[0] != 'w') ||
 347         mode[1] != 'b' || mode[2] != 0) {
 348         fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
 349         return NULL;
 350     }
 351
 352     s = qemu_mallocz(sizeof(QEMUFileStdio));
 353
 354     s->stdio_file = fopen(filename, mode);
 355     if (!s->stdio_file)
 356         goto fail;
 357
 358     if(mode[0] == 'w') {
 359         s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose, NULL, NULL);
 360     } else {
 361         s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose, NULL, NULL);
 362     }
 363     return s->file;
 364 fail:
 365     qemu_free(s);
 366     return NULL;
 367 }
 368
 369 static int block_put_buffer(void *opaque, const uint8_t *buf,
 370                            int64_t pos, int size)
 371 {
 372     bdrv_save_vmstate(opaque, buf, pos, size);
 373     return size;
 374 }
 375
 376 static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
 377 {
 378     return bdrv_load_vmstate(opaque, buf, pos, size);
 379 }
 380
 381 static int bdrv_fclose(void *opaque)
 382 {
 383     return 0;
 384 }
 385
 386 static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
 387 {
 388     if (is_writable)
 389         return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose, NULL, NULL);
 390     return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL);
 391 }
 392
 393 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
 394                          QEMUFileGetBufferFunc *get_buffer,
 395                          QEMUFileCloseFunc *close,
 396                          QEMUFileRateLimit *rate_limit,
 397                          QEMUFileSetRateLimit *set_rate_limit)
 398 {
 399     QEMUFile *f;
 400
 401     f = qemu_mallocz(sizeof(QEMUFile));
 402
 403     f->opaque = opaque;
 404     f->put_buffer = put_buffer;
 405     f->get_buffer = get_buffer;
 406     f->close = close;
 407     f->rate_limit = rate_limit;
 408     f->set_rate_limit = set_rate_limit;
 409     f->is_write = 0;
 410
 411     return f;
 412 }
 413
 414 int qemu_file_has_error(QEMUFile *f)
 415 {
 416     return f->has_error;
 417 }
 418
 419 void qemu_file_set_error(QEMUFile *f)
 420 {
 421     f->has_error = 1;
 422 }
 423
 424 void qemu_fflush(QEMUFile *f)
 425 {
 426     if (!f->put_buffer)
 427         return;
 428
 429     if (f->is_write && f->buf_index > 0) {
 430         int len;
 431
 432         len = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
 433         if (len > 0)
 434             f->buf_offset += f->buf_index;
 435         else
 436             f->has_error = 1;
 437         f->buf_index = 0;
 438     }
 439 }
 440
 441 static void qemu_fill_buffer(QEMUFile *f)
 442 {
 443     int len;
 444
 445     if (!f->get_buffer)
 446         return;
 447
 448     if (f->is_write)
 449         abort();
 450
 451     len = f->get_buffer(f->opaque, f->buf, f->buf_offset, IO_BUF_SIZE);
 452     if (len > 0) {
 453         f->buf_index = 0;
 454         f->buf_size = len;
 455         f->buf_offset += len;
 456     } else if (len != -EAGAIN)
 457         f->has_error = 1;
 458 }
 459
 460 int qemu_fclose(QEMUFile *f)
 461 {
 462     int ret = 0;
 463     qemu_fflush(f);
 464     if (f->close)
 465         ret = f->close(f->opaque);
 466     qemu_free(f);
 467     return ret;
 468 }
 469
 470 void qemu_file_put_notify(QEMUFile *f)
 471 {
 472     f->put_buffer(f->opaque, NULL, 0, 0);
 473 }
 474
 475 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
 476 {
 477     int l;
 478
 479     if (!f->has_error && f->is_write == 0 && f->buf_index > 0) {
 480         fprintf(stderr,
 481                 "Attempted to write to buffer while read buffer is not empty\n");
 482         abort();
 483     }
 484
 485     while (!f->has_error && size > 0) {
 486         l = IO_BUF_SIZE - f->buf_index;
 487         if (l > size)
 488             l = size;
 489         memcpy(f->buf + f->buf_index, buf, l);
 490         f->is_write = 1;
 491         f->buf_index += l;
 492         buf += l;
 493         size -= l;
 494         if (f->buf_index >= IO_BUF_SIZE)
 495             qemu_fflush(f);
 496     }
 497 }
 498
 499 void qemu_put_byte(QEMUFile *f, int v)
 500 {
 501     if (!f->has_error && f->is_write == 0 && f->buf_index > 0) {
 502         fprintf(stderr,
 503                 "Attempted to write to buffer while read buffer is not empty\n");
 504         abort();
 505     }
 506
 507     f->buf[f->buf_index++] = v;
 508     f->is_write = 1;
 509     if (f->buf_index >= IO_BUF_SIZE)
 510         qemu_fflush(f);
 511 }
 512
 513 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size1)
 514 {
 515     int size, l;
 516
 517     if (f->is_write)
 518         abort();
 519
 520     size = size1;
 521     while (size > 0) {
 522         l = f->buf_size - f->buf_index;
 523         if (l == 0) {
 524             qemu_fill_buffer(f);
 525             l = f->buf_size - f->buf_index;
 526             if (l == 0)
 527                 break;
 528         }
 529         if (l > size)
 530             l = size;
 531         memcpy(buf, f->buf + f->buf_index, l);
 532         f->buf_index += l;
 533         buf += l;
 534         size -= l;
 535     }
 536     return size1 - size;
 537 }
 538
 539 int qemu_get_byte(QEMUFile *f)
 540 {
 541     if (f->is_write)
 542         abort();
 543
 544     if (f->buf_index >= f->buf_size) {
 545         qemu_fill_buffer(f);
 546         if (f->buf_index >= f->buf_size)
 547             return 0;
 548     }
 549     return f->buf[f->buf_index++];
 550 }
 551
 552 int64_t qemu_ftell(QEMUFile *f)
 553 {
 554     return f->buf_offset - f->buf_size + f->buf_index;
 555 }
 556
 557 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence)
 558 {
 559     if (whence == SEEK_SET) {
 560         /* nothing to do */
 561     } else if (whence == SEEK_CUR) {
 562         pos += qemu_ftell(f);
 563     } else {
 564         /* SEEK_END not supported */
 565         return -1;
 566     }
 567     if (f->put_buffer) {
 568         qemu_fflush(f);
 569         f->buf_offset = pos;
 570     } else {
 571         f->buf_offset = pos;
 572         f->buf_index = 0;
 573         f->buf_size = 0;
 574     }
 575     return pos;
 576 }
 577
 578 int qemu_file_rate_limit(QEMUFile *f)
 579 {
 580     if (f->rate_limit)
 581         return f->rate_limit(f->opaque);
 582
 583     return 0;
 584 }
 585
 586 size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate)
 587 {
 588     /* any failed or completed migration keeps its state to allow probing of
 589      * migration data, but has no associated file anymore */
 590     if (f && f->set_rate_limit)
 591         return f->set_rate_limit(f->opaque, new_rate);
 592
 593     return 0;
 594 }
 595
 596 void qemu_put_be16(QEMUFile *f, unsigned int v)
 597 {
 598     qemu_put_byte(f, v >> 8);
 599     qemu_put_byte(f, v);
 600 }
 601
 602 void qemu_put_be32(QEMUFile *f, unsigned int v)
 603 {
 604     qemu_put_byte(f, v >> 24);
 605     qemu_put_byte(f, v >> 16);
 606     qemu_put_byte(f, v >> 8);
 607     qemu_put_byte(f, v);
 608 }
 609
 610 void qemu_put_be64(QEMUFile *f, uint64_t v)
 611 {
 612     qemu_put_be32(f, v >> 32);
 613     qemu_put_be32(f, v);
 614 }
 615
 616 unsigned int qemu_get_be16(QEMUFile *f)
 617 {
 618     unsigned int v;
 619     v = qemu_get_byte(f) << 8;
 620     v |= qemu_get_byte(f);
 621     return v;
 622 }
 623
 624 unsigned int qemu_get_be32(QEMUFile *f)
 625 {
 626     unsigned int v;
 627     v = qemu_get_byte(f) << 24;
 628     v |= qemu_get_byte(f) << 16;
 629     v |= qemu_get_byte(f) << 8;
 630     v |= qemu_get_byte(f);
 631     return v;
 632 }
 633
 634 uint64_t qemu_get_be64(QEMUFile *f)
 635 {
 636     uint64_t v;
 637     v = (uint64_t)qemu_get_be32(f) << 32;
 638     v |= qemu_get_be32(f);
 639     return v;
 640 }
 641
 642 typedef struct SaveStateEntry {
 643     char idstr[256];
 644     int instance_id;
 645     int version_id;
 646     int section_id;
 647     SaveLiveStateHandler *save_live_state;
 648     SaveStateHandler *save_state;
 649     LoadStateHandler *load_state;
 650     void *opaque;
 651     struct SaveStateEntry *next;
 652 } SaveStateEntry;
 653
 654 static SaveStateEntry *first_se;
 655
 656 /* TODO: Individual devices generally have very little idea about the rest
 657    of the system, so instance_id should be removed/replaced.
 658    Meanwhile pass -1 as instance_id if you do not already have a clearly
 659    distinguishing id for all instances of your device class. */
 660 int register_savevm_live(const char *idstr,
 661                          int instance_id,
 662                          int version_id,
 663                          SaveLiveStateHandler *save_live_state,
 664                          SaveStateHandler *save_state,
 665                          LoadStateHandler *load_state,
 666                          void *opaque)
 667 {
 668     SaveStateEntry *se, **pse;
 669     static int global_section_id;
 670
 671     se = qemu_malloc(sizeof(SaveStateEntry));
 672     pstrcpy(se->idstr, sizeof(se->idstr), idstr);
 673     se->instance_id = (instance_id == -1) ? 0 : instance_id;
 674     se->version_id = version_id;
 675     se->section_id = global_section_id++;
 676     se->save_live_state = save_live_state;
 677     se->save_state = save_state;
 678     se->load_state = load_state;
 679     se->opaque = opaque;
 680     se->next = NULL;
 681
 682     /* add at the end of list */
 683     pse = &first_se;
 684     while (*pse != NULL) {
 685         if (instance_id == -1
 686                 && strcmp(se->idstr, (*pse)->idstr) == 0
 687                 && se->instance_id <= (*pse)->instance_id)
 688             se->instance_id = (*pse)->instance_id + 1;
 689         pse = &(*pse)->next;
 690     }
 691     *pse = se;
 692     return 0;
 693 }
 694
 695 int register_savevm(const char *idstr,
 696                     int instance_id,
 697                     int version_id,
 698                     SaveStateHandler *save_state,
 699                     LoadStateHandler *load_state,
 700                     void *opaque)
 701 {
 702     return register_savevm_live(idstr, instance_id, version_id,
 703                                 NULL, save_state, load_state, opaque);
 704 }
 705
 706 void unregister_savevm(const char *idstr, void *opaque)
 707 {
 708     SaveStateEntry **pse;
 709
 710     pse = &first_se;
 711     while (*pse != NULL) {
 712         if (strcmp((*pse)->idstr, idstr) == 0 && (*pse)->opaque == opaque) {
 713             SaveStateEntry *next = (*pse)->next;
 714             qemu_free(*pse);
 715             *pse = next;
 716             continue;
 717         }
 718         pse = &(*pse)->next;
 719     }
 720 }
 721
 722 static int vmstate_load(QEMUFile *f, SaveStateEntry *se, int version_id)
 723 {
 724     return se->load_state(f, se->opaque, version_id);
 725 }
 726
 727 static void vmstate_save(QEMUFile *f, SaveStateEntry *se)
 728 {
 729     se->save_state(f, se->opaque);
 730 }
 731
 732
 733 #define QEMU_VM_FILE_MAGIC           0x5145564d
 734 #define QEMU_VM_FILE_VERSION_COMPAT  0x00000002
 735 #define QEMU_VM_FILE_VERSION         0x00000003
 736
 737 #define QEMU_VM_EOF                  0x00
 738 #define QEMU_VM_SECTION_START        0x01
 739 #define QEMU_VM_SECTION_PART         0x02
 740 #define QEMU_VM_SECTION_END          0x03
 741 #define QEMU_VM_SECTION_FULL         0x04
 742
 743 int qemu_savevm_state_begin(QEMUFile *f)
 744 {
 745     SaveStateEntry *se;
 746
 747     qemu_put_be32(f, QEMU_VM_FILE_MAGIC);
 748     qemu_put_be32(f, QEMU_VM_FILE_VERSION);
 749
 750     for (se = first_se; se != NULL; se = se->next) {
 751         int len;
 752
 753         if (se->save_live_state == NULL)
 754             continue;
 755
 756         /* Section type */
 757         qemu_put_byte(f, QEMU_VM_SECTION_START);
 758         qemu_put_be32(f, se->section_id);
 759
 760         /* ID string */
 761         len = strlen(se->idstr);
 762         qemu_put_byte(f, len);
 763         qemu_put_buffer(f, (uint8_t *)se->idstr, len);
 764
 765         qemu_put_be32(f, se->instance_id);
 766         qemu_put_be32(f, se->version_id);
 767
 768         se->save_live_state(f, QEMU_VM_SECTION_START, se->opaque);
 769     }
 770
 771     if (qemu_file_has_error(f))
 772         return -EIO;
 773
 774     return 0;
 775 }
 776
 777 int qemu_savevm_state_iterate(QEMUFile *f)
 778 {
 779     SaveStateEntry *se;
 780     int ret = 1;
 781
 782     for (se = first_se; se != NULL; se = se->next) {
 783         if (se->save_live_state == NULL)
 784             continue;
 785
 786         /* Section type */
 787         qemu_put_byte(f, QEMU_VM_SECTION_PART);
 788         qemu_put_be32(f, se->section_id);
 789
 790         ret &= !!se->save_live_state(f, QEMU_VM_SECTION_PART, se->opaque);
 791     }
 792
 793     if (ret)
 794         return 1;
 795
 796     if (qemu_file_has_error(f))
 797         return -EIO;
 798
 799     return 0;
 800 }
 801
 802 int qemu_savevm_state_complete(QEMUFile *f)
 803 {
 804     SaveStateEntry *se;
 805
 806     for (se = first_se; se != NULL; se = se->next) {
 807         if (se->save_live_state == NULL)
 808             continue;
 809
 810         /* Section type */
 811         qemu_put_byte(f, QEMU_VM_SECTION_END);
 812         qemu_put_be32(f, se->section_id);
 813
 814         se->save_live_state(f, QEMU_VM_SECTION_END, se->opaque);
 815     }
 816
 817     for(se = first_se; se != NULL; se = se->next) {
 818         int len;
 819
 820         if (se->save_state == NULL)
 821             continue;
 822
 823         /* Section type */
 824         qemu_put_byte(f, QEMU_VM_SECTION_FULL);
 825         qemu_put_be32(f, se->section_id);
 826
 827         /* ID string */
 828         len = strlen(se->idstr);
 829         qemu_put_byte(f, len);
 830         qemu_put_buffer(f, (uint8_t *)se->idstr, len);
 831
 832         qemu_put_be32(f, se->instance_id);
 833         qemu_put_be32(f, se->version_id);
 834
 835         vmstate_save(f, se);
 836     }
 837
 838     qemu_put_byte(f, QEMU_VM_EOF);
 839
 840     if (qemu_file_has_error(f))
 841         return -EIO;
 842
 843     return 0;
 844 }
 845
 846 int qemu_savevm_state(QEMUFile *f)
 847 {
 848     int saved_vm_running;
 849     int ret;
 850
 851     saved_vm_running = vm_running;
 852     vm_stop(0);
 853
 854     bdrv_flush_all();
 855
 856     ret = qemu_savevm_state_begin(f);
 857     if (ret < 0)
 858         goto out;
 859
 860     do {
 861         ret = qemu_savevm_state_iterate(f);
 862         if (ret < 0)
 863             goto out;
 864     } while (ret == 0);
 865
 866     ret = qemu_savevm_state_complete(f);
 867
 868 out:
 869     if (qemu_file_has_error(f))
 870         ret = -EIO;
 871
 872     if (!ret && saved_vm_running)
 873         vm_start();
 874
 875     return ret;
 876 }
 877
 878 static SaveStateEntry *find_se(const char *idstr, int instance_id)
 879 {
 880     SaveStateEntry *se;
 881
 882     for(se = first_se; se != NULL; se = se->next) {
 883         if (!strcmp(se->idstr, idstr) &&
 884             instance_id == se->instance_id)
 885             return se;
 886     }
 887     return NULL;
 888 }
 889
 890 typedef struct LoadStateEntry {
 891     SaveStateEntry *se;
 892     int section_id;
 893     int version_id;
 894     struct LoadStateEntry *next;
 895 } LoadStateEntry;
 896
 897 static int qemu_loadvm_state_v2(QEMUFile *f)
 898 {
 899     SaveStateEntry *se;
 900     int len, ret, instance_id, record_len, version_id;
 901     int64_t total_len, end_pos, cur_pos;
 902     char idstr[256];
 903
 904     total_len = qemu_get_be64(f);
 905     end_pos = total_len + qemu_ftell(f);
 906     for(;;) {
 907         if (qemu_ftell(f) >= end_pos)
 908             break;
 909         len = qemu_get_byte(f);
 910         qemu_get_buffer(f, (uint8_t *)idstr, len);
 911         idstr[len] = '\0';
 912         instance_id = qemu_get_be32(f);
 913         version_id = qemu_get_be32(f);
 914         record_len = qemu_get_be32(f);
 915         cur_pos = qemu_ftell(f);
 916         se = find_se(idstr, instance_id);
 917         if (!se) {
 918             fprintf(stderr, "qemu: warning: instance 0x%x of device '%s' not present in current VM\n",
 919                     instance_id, idstr);
 920         } else {
 921             ret = vmstate_load(f, se, version_id);
 922             if (ret < 0) {
 923                 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
 924                         instance_id, idstr);
 925                 return ret;
 926             }
 927         }
 928         /* always seek to exact end of record */
 929         qemu_fseek(f, cur_pos + record_len, SEEK_SET);
 930     }
 931
 932     if (qemu_file_has_error(f))
 933         return -EIO;
 934
 935     return 0;
 936 }
 937
 938 int qemu_loadvm_state(QEMUFile *f)
 939 {
 940     LoadStateEntry *first_le = NULL;
 941     uint8_t section_type;
 942     unsigned int v;
 943     int ret;
 944
 945     v = qemu_get_be32(f);
 946     if (v != QEMU_VM_FILE_MAGIC)
 947         return -EINVAL;
 948
 949     v = qemu_get_be32(f);
 950     if (v == QEMU_VM_FILE_VERSION_COMPAT)
 951         return qemu_loadvm_state_v2(f);
 952     if (v != QEMU_VM_FILE_VERSION)
 953         return -ENOTSUP;
 954
 955     while ((section_type = qemu_get_byte(f)) != QEMU_VM_EOF) {
 956         uint32_t instance_id, version_id, section_id;
 957         LoadStateEntry *le;
 958         SaveStateEntry *se;
 959         char idstr[257];
 960         int len;
 961
 962         switch (section_type) {
 963         case QEMU_VM_SECTION_START:
 964         case QEMU_VM_SECTION_FULL:
 965             /* Read section start */
 966             section_id = qemu_get_be32(f);
 967             len = qemu_get_byte(f);
 968             qemu_get_buffer(f, (uint8_t *)idstr, len);
 969             idstr[len] = 0;
 970             instance_id = qemu_get_be32(f);
 971             version_id = qemu_get_be32(f);
 972
 973             /* Find savevm section */
 974             se = find_se(idstr, instance_id);
 975             if (se == NULL) {
 976                 fprintf(stderr, "Unknown savevm section or instance '%s' %d\n", idstr, instance_id);
 977                 ret = -EINVAL;
 978                 goto out;
 979             }
 980
 981             /* Validate version */
 982             if (version_id > se->version_id) {
 983                 fprintf(stderr, "savevm: unsupported version %d for '%s' v%d\n",
 984                         version_id, idstr, se->version_id);
 985                 ret = -EINVAL;
 986                 goto out;
 987             }
 988
 989             /* Add entry */
 990             le = qemu_mallocz(sizeof(*le));
 991
 992             le->se = se;
 993             le->section_id = section_id;
 994             le->version_id = version_id;
 995             le->next = first_le;
 996             first_le = le;
 997
 998             ret = vmstate_load(f, le->se, le->version_id);
 999             if (ret < 0) {
1000                 fprintf(stderr, "qemu: warning: error while loading state for instance 0x%x of device '%s'\n",
1001                         instance_id, idstr);
1002                 goto out;
1003             }
1004             break;
1005         case QEMU_VM_SECTION_PART:
1006         case QEMU_VM_SECTION_END:
1007             section_id = qemu_get_be32(f);
1008
1009             for (le = first_le; le && le->section_id != section_id; le = le->next);
1010             if (le == NULL) {
1011                 fprintf(stderr, "Unknown savevm section %d\n", section_id);
1012                 ret = -EINVAL;
1013                 goto out;
1014             }
1015
1016             ret = vmstate_load(f, le->se, le->version_id);
1017             if (ret < 0) {
1018                 fprintf(stderr, "qemu: warning: error while loading state section id %d\n",
1019                         section_id);
1020                 goto out;
1021             }
1022             break;
1023         default:
1024             fprintf(stderr, "Unknown savevm section type %d\n", section_type);
1025             ret = -EINVAL;
1026             goto out;
1027         }
1028     }
1029
1030     ret = 0;
1031
1032 out:
1033     while (first_le) {
1034         LoadStateEntry *le = first_le;
1035         first_le = first_le->next;
1036         qemu_free(le);
1037     }
1038
1039     if (qemu_file_has_error(f))
1040         ret = -EIO;
1041
1042     return ret;
1043 }
1044
1045 /* device can contain snapshots */
1046 static int bdrv_can_snapshot(BlockDriverState *bs)
1047 {
1048     return (bs &&
1049             !bdrv_is_removable(bs) &&
1050             !bdrv_is_read_only(bs));
1051 }
1052
1053 /* device must be snapshots in order to have a reliable snapshot */
1054 static int bdrv_has_snapshot(BlockDriverState *bs)
1055 {
1056     return (bs &&
1057             !bdrv_is_removable(bs) &&
1058             !bdrv_is_read_only(bs));
1059 }
1060
1061 static BlockDriverState *get_bs_snapshots(void)
1062 {
1063     BlockDriverState *bs;
1064     DriveInfo *dinfo;
1065
1066     if (bs_snapshots)
1067         return bs_snapshots;
1068     TAILQ_FOREACH(dinfo, &drives, next) {
1069         bs = dinfo->bdrv;
1070         if (bdrv_can_snapshot(bs))
1071             goto ok;
1072     }
1073     return NULL;
1074  ok:
1075     bs_snapshots = bs;
1076     return bs;
1077 }
1078
1079 static int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
1080                               const char *name)
1081 {
1082     QEMUSnapshotInfo *sn_tab, *sn;
1083     int nb_sns, i, ret;
1084
1085     ret = -ENOENT;
1086     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1087     if (nb_sns < 0)
1088         return ret;
1089     for(i = 0; i < nb_sns; i++) {
1090         sn = &sn_tab[i];
1091         if (!strcmp(sn->id_str, name) || !strcmp(sn->name, name)) {
1092             *sn_info = *sn;
1093             ret = 0;
1094             break;
1095         }
1096     }
1097     qemu_free(sn_tab);
1098     return ret;
1099 }
1100
1101 void do_savevm(Monitor *mon, const char *name)
1102 {
1103     DriveInfo *dinfo;
1104     BlockDriverState *bs, *bs1;
1105     QEMUSnapshotInfo sn1, *sn = &sn1, old_sn1, *old_sn = &old_sn1;
1106     int must_delete, ret;
1107     QEMUFile *f;
1108     int saved_vm_running;
1109     uint32_t vm_state_size;
1110 #ifdef _WIN32
1111     struct _timeb tb;
1112 #else
1113     struct timeval tv;
1114 #endif
1115
1116     bs = get_bs_snapshots();
1117     if (!bs) {
1118         monitor_printf(mon, "No block device can accept snapshots\n");
1119         return;
1120     }
1121
1122     /* ??? Should this occur after vm_stop?  */
1123     qemu_aio_flush();
1124
1125     saved_vm_running = vm_running;
1126     vm_stop(0);
1127
1128     must_delete = 0;
1129     if (name) {
1130         ret = bdrv_snapshot_find(bs, old_sn, name);
1131         if (ret >= 0) {
1132             must_delete = 1;
1133         }
1134     }
1135     memset(sn, 0, sizeof(*sn));
1136     if (must_delete) {
1137         pstrcpy(sn->name, sizeof(sn->name), old_sn->name);
1138         pstrcpy(sn->id_str, sizeof(sn->id_str), old_sn->id_str);
1139     } else {
1140         if (name)
1141             pstrcpy(sn->name, sizeof(sn->name), name);
1142     }
1143
1144     /* fill auxiliary fields */
1145 #ifdef _WIN32
1146     _ftime(&tb);
1147     sn->date_sec = tb.time;
1148     sn->date_nsec = tb.millitm * 1000000;
1149 #else
1150     gettimeofday(&tv, NULL);
1151     sn->date_sec = tv.tv_sec;
1152     sn->date_nsec = tv.tv_usec * 1000;
1153 #endif
1154     sn->vm_clock_nsec = qemu_get_clock(vm_clock);
1155
1156     /* save the VM state */
1157     f = qemu_fopen_bdrv(bs, 1);
1158     if (!f) {
1159         monitor_printf(mon, "Could not open VM state file\n");
1160         goto the_end;
1161     }
1162     ret = qemu_savevm_state(f);
1163     vm_state_size = qemu_ftell(f);
1164     qemu_fclose(f);
1165     if (ret < 0) {
1166         monitor_printf(mon, "Error %d while writing VM\n", ret);
1167         goto the_end;
1168     }
1169
1170     /* create the snapshots */
1171
1172     TAILQ_FOREACH(dinfo, &drives, next) {
1173         bs1 = dinfo->bdrv;
1174         if (bdrv_has_snapshot(bs1)) {
1175             if (must_delete) {
1176                 ret = bdrv_snapshot_delete(bs1, old_sn->id_str);
1177                 if (ret < 0) {
1178                     monitor_printf(mon,
1179                                    "Error while deleting snapshot on '%s'\n",
1180                                    bdrv_get_device_name(bs1));
1181                 }
1182             }
1183             /* Write VM state size only to the image that contains the state */
1184             sn->vm_state_size = (bs == bs1 ? vm_state_size : 0);
1185             ret = bdrv_snapshot_create(bs1, sn);
1186             if (ret < 0) {
1187                 monitor_printf(mon, "Error while creating snapshot on '%s'\n",
1188                                bdrv_get_device_name(bs1));
1189             }
1190         }
1191     }
1192
1193  the_end:
1194     if (saved_vm_running)
1195         vm_start();
1196 }
1197
1198 int load_vmstate(Monitor *mon, const char *name)
1199 {
1200     DriveInfo *dinfo;
1201     BlockDriverState *bs, *bs1;
1202     QEMUSnapshotInfo sn;
1203     QEMUFile *f;
1204     int ret;
1205
1206     bs = get_bs_snapshots();
1207     if (!bs) {
1208         monitor_printf(mon, "No block device supports snapshots\n");
1209         return -EINVAL;
1210     }
1211
1212     /* Flush all IO requests so they don't interfere with the new state.  */
1213     qemu_aio_flush();
1214
1215     TAILQ_FOREACH(dinfo, &drives, next) {
1216         bs1 = dinfo->bdrv;
1217         if (bdrv_has_snapshot(bs1)) {
1218             ret = bdrv_snapshot_goto(bs1, name);
1219             if (ret < 0) {
1220                 if (bs != bs1)
1221                     monitor_printf(mon, "Warning: ");
1222                 switch(ret) {
1223                 case -ENOTSUP:
1224                     monitor_printf(mon,
1225                                    "Snapshots not supported on device '%s'\n",
1226                                    bdrv_get_device_name(bs1));
1227                     break;
1228                 case -ENOENT:
1229                     monitor_printf(mon, "Could not find snapshot '%s' on "
1230                                    "device '%s'\n",
1231                                    name, bdrv_get_device_name(bs1));
1232                     break;
1233                 default:
1234                     monitor_printf(mon, "Error %d while activating snapshot on"
1235                                    " '%s'\n", ret, bdrv_get_device_name(bs1));
1236                     break;
1237                 }
1238                 /* fatal on snapshot block device */
1239                 if (bs == bs1)
1240                     return 0;
1241             }
1242         }
1243     }
1244
1245     /* Don't even try to load empty VM states */
1246     ret = bdrv_snapshot_find(bs, &sn, name);
1247     if ((ret >= 0) && (sn.vm_state_size == 0))
1248         return -EINVAL;
1249
1250     /* restore the VM state */
1251     f = qemu_fopen_bdrv(bs, 0);
1252     if (!f) {
1253         monitor_printf(mon, "Could not open VM state file\n");
1254         return -EINVAL;
1255     }
1256     ret = qemu_loadvm_state(f);
1257     qemu_fclose(f);
1258     if (ret < 0) {
1259         monitor_printf(mon, "Error %d while loading VM state\n", ret);
1260         return ret;
1261     }
1262     return 0;
1263 }
1264
1265 void do_delvm(Monitor *mon, const char *name)
1266 {
1267     DriveInfo *dinfo;
1268     BlockDriverState *bs, *bs1;
1269     int ret;
1270
1271     bs = get_bs_snapshots();
1272     if (!bs) {
1273         monitor_printf(mon, "No block device supports snapshots\n");
1274         return;
1275     }
1276
1277     TAILQ_FOREACH(dinfo, &drives, next) {
1278         bs1 = dinfo->bdrv;
1279         if (bdrv_has_snapshot(bs1)) {
1280             ret = bdrv_snapshot_delete(bs1, name);
1281             if (ret < 0) {
1282                 if (ret == -ENOTSUP)
1283                     monitor_printf(mon,
1284                                    "Snapshots not supported on device '%s'\n",
1285                                    bdrv_get_device_name(bs1));
1286                 else
1287                     monitor_printf(mon, "Error %d while deleting snapshot on "
1288                                    "'%s'\n", ret, bdrv_get_device_name(bs1));
1289             }
1290         }
1291     }
1292 }
1293
1294 void do_info_snapshots(Monitor *mon)
1295 {
1296     DriveInfo *dinfo;
1297     BlockDriverState *bs, *bs1;
1298     QEMUSnapshotInfo *sn_tab, *sn;
1299     int nb_sns, i;
1300     char buf[256];
1301
1302     bs = get_bs_snapshots();
1303     if (!bs) {
1304         monitor_printf(mon, "No available block device supports snapshots\n");
1305         return;
1306     }
1307     monitor_printf(mon, "Snapshot devices:");
1308     TAILQ_FOREACH(dinfo, &drives, next) {
1309         bs1 = dinfo->bdrv;
1310         if (bdrv_has_snapshot(bs1)) {
1311             if (bs == bs1)
1312                 monitor_printf(mon, " %s", bdrv_get_device_name(bs1));
1313         }
1314     }
1315     monitor_printf(mon, "\n");
1316
1317     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1318     if (nb_sns < 0) {
1319         monitor_printf(mon, "bdrv_snapshot_list: error %d\n", nb_sns);
1320         return;
1321     }
1322     monitor_printf(mon, "Snapshot list (from %s):\n",
1323                    bdrv_get_device_name(bs));
1324     monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
1325     for(i = 0; i < nb_sns; i++) {
1326         sn = &sn_tab[i];
1327         monitor_printf(mon, "%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
1328     }
1329     qemu_free(sn_tab);
1330 }