savevm.c 63 KB
Newer Older
aliguori's avatar
aliguori committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*
 * QEMU System Emulator
 *
 * Copyright (c) 2003-2008 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include <unistd.h>
#include <fcntl.h>
#include <time.h>
#include <errno.h>
#include <sys/time.h>
#include <zlib.h>

Juan Quintela's avatar
Juan Quintela committed
31
/* Needed early for CONFIG_BSD etc. */
blueswir1's avatar
blueswir1 committed
32
33
#include "config-host.h"

aliguori's avatar
aliguori committed
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#ifndef _WIN32
#include <sys/times.h>
#include <sys/wait.h>
#include <termios.h>
#include <sys/mman.h>
#include <sys/ioctl.h>
#include <sys/resource.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <net/if.h>
#include <arpa/inet.h>
#include <dirent.h>
#include <netdb.h>
#include <sys/select.h>
Juan Quintela's avatar
Juan Quintela committed
48
#ifdef CONFIG_BSD
aliguori's avatar
aliguori committed
49
#include <sys/stat.h>
Aurelien Jarno's avatar
Aurelien Jarno committed
50
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
aliguori's avatar
aliguori committed
51
52
53
54
55
56
57
58
59
60
61
62
63
#include <libutil.h>
#else
#include <util.h>
#endif
#ifdef __linux__
#include <pty.h>
#include <malloc.h>
#include <linux/rtc.h>
#endif
#endif
#endif

#ifdef _WIN32
64
#include <windows.h>
aliguori's avatar
aliguori committed
65
66
67
68
69
70
71
#include <malloc.h>
#include <sys/timeb.h>
#include <mmsystem.h>
#define getopt_long_only getopt_long
#define memalign(align, size) malloc(size)
#endif

72
73
#include "qemu-common.h"
#include "hw/hw.h"
74
#include "hw/qdev.h"
75
76
77
78
79
80
81
82
#include "net.h"
#include "monitor.h"
#include "sysemu.h"
#include "qemu-timer.h"
#include "qemu-char.h"
#include "audio/audio.h"
#include "migration.h"
#include "qemu_socket.h"
Blue Swirl's avatar
Blue Swirl committed
83
#include "qemu-queue.h"
84
#include "qemu-timer.h"
85
#include "cpus.h"
86
#include "memory.h"
87
#include "qmp-commands.h"
88
#include "trace.h"
89
#include "bitops.h"
90

aliguori's avatar
aliguori committed
91
92
#define SELF_ANNOUNCE_ROUNDS 5

Nolan's avatar
Nolan committed
93
#ifndef ETH_P_RARP
Stefan Berger's avatar
Stefan Berger committed
94
#define ETH_P_RARP 0x8035
Nolan's avatar
Nolan committed
95
96
97
98
99
100
#endif
#define ARP_HTYPE_ETH 0x0001
#define ARP_PTYPE_IP 0x0800
#define ARP_OP_REQUEST_REV 0x3

static int announce_self_create(uint8_t *buf,
aliguori's avatar
aliguori committed
101
102
				uint8_t *mac_addr)
{
Nolan's avatar
Nolan committed
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
    /* Ethernet header. */
    memset(buf, 0xff, 6);         /* destination MAC addr */
    memcpy(buf + 6, mac_addr, 6); /* source MAC addr */
    *(uint16_t *)(buf + 12) = htons(ETH_P_RARP); /* ethertype */

    /* RARP header. */
    *(uint16_t *)(buf + 14) = htons(ARP_HTYPE_ETH); /* hardware addr space */
    *(uint16_t *)(buf + 16) = htons(ARP_PTYPE_IP); /* protocol addr space */
    *(buf + 18) = 6; /* hardware addr length (ethernet) */
    *(buf + 19) = 4; /* protocol addr length (IPv4) */
    *(uint16_t *)(buf + 20) = htons(ARP_OP_REQUEST_REV); /* opcode */
    memcpy(buf + 22, mac_addr, 6); /* source hw addr */
    memset(buf + 28, 0x00, 4);     /* source protocol addr */
    memcpy(buf + 32, mac_addr, 6); /* target hw addr */
    memset(buf + 38, 0x00, 4);     /* target protocol addr */

    /* Padding to get up to 60 bytes (ethernet min packet size, minus FCS). */
    memset(buf + 42, 0x00, 18);

    return 60; /* len (FCS will be added by hardware) */
aliguori's avatar
aliguori committed
123
124
}

125
static void qemu_announce_self_iter(NICState *nic, void *opaque)
aliguori's avatar
aliguori committed
126
{
Nolan's avatar
Nolan committed
127
    uint8_t buf[60];
128
129
130
131
132
133
134
135
136
137
    int len;

    len = announce_self_create(buf, nic->conf->macaddr.a);

    qemu_send_packet_raw(&nic->nc, buf, len);
}


static void qemu_announce_self_once(void *opaque)
{
138
139
    static int count = SELF_ANNOUNCE_ROUNDS;
    QEMUTimer *timer = *(QEMUTimer **)opaque;
aliguori's avatar
aliguori committed
140

141
142
    qemu_foreach_nic(qemu_announce_self_iter, NULL);

Nolan's avatar
Nolan committed
143
144
    if (--count) {
        /* delay 50ms, 150ms, 250ms, ... */
145
        qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
Nolan's avatar
Nolan committed
146
                       50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
147
148
149
150
151
152
153
154
155
    } else {
	    qemu_del_timer(timer);
	    qemu_free_timer(timer);
    }
}

void qemu_announce_self(void)
{
	static QEMUTimer *timer;
156
	timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
157
	qemu_announce_self_once(&timer);
aliguori's avatar
aliguori committed
158
159
160
161
162
163
164
165
}

/***********************************************************/
/* savevm/loadvm support */

#define IO_BUF_SIZE 32768

struct QEMUFile {
166
    const QEMUFileOps *ops;
aliguori's avatar
aliguori committed
167
168
169
170
171
172
173
174
175
    void *opaque;
    int is_write;

    int64_t buf_offset; /* start of buffer when writing, end of buffer
                           when reading */
    int buf_index;
    int buf_size; /* 0 when writing */
    uint8_t buf[IO_BUF_SIZE];

176
    int last_error;
aliguori's avatar
aliguori committed
177
178
};

179
typedef struct QEMUFileStdio
aliguori's avatar
aliguori committed
180
{
181
    FILE *stdio_file;
aliguori's avatar
aliguori committed
182
    QEMUFile *file;
183
} QEMUFileStdio;
aliguori's avatar
aliguori committed
184
185
186
187
188
189
190

typedef struct QEMUFileSocket
{
    int fd;
    QEMUFile *file;
} QEMUFileSocket;

Paolo Bonzini's avatar
Paolo Bonzini committed
191
192
193
194
195
196
197
static int socket_get_fd(void *opaque)
{
    QEMUFileSocket *s = opaque;

    return s->fd;
}

aliguori's avatar
aliguori committed
198
199
200
201
202
203
static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
{
    QEMUFileSocket *s = opaque;
    ssize_t len;

    do {
Blue Swirl's avatar
Blue Swirl committed
204
        len = qemu_recv(s->fd, buf, size, 0);
aliguori's avatar
aliguori committed
205
206
207
208
209
210
211
212
213
214
215
    } while (len == -1 && socket_error() == EINTR);

    if (len == -1)
        len = -socket_error();

    return len;
}

static int socket_close(void *opaque)
{
    QEMUFileSocket *s = opaque;
216
    g_free(s);
aliguori's avatar
aliguori committed
217
218
219
    return 0;
}

Paolo Bonzini's avatar
Paolo Bonzini committed
220
221
222
223
224
225
226
static int stdio_get_fd(void *opaque)
{
    QEMUFileStdio *s = opaque;

    return fileno(s->stdio_file);
}

227
static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
228
{
229
230
    QEMUFileStdio *s = opaque;
    return fwrite(buf, 1, size, s->stdio_file);
aliguori's avatar
aliguori committed
231
232
}

233
static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
234
{
235
236
    QEMUFileStdio *s = opaque;
    FILE *fp = s->stdio_file;
237
238
239
240
241
242
243
    int bytes;

    do {
        clearerr(fp);
        bytes = fread(buf, 1, size, fp);
    } while ((bytes == 0) && ferror(fp) && (errno == EINTR));
    return bytes;
aliguori's avatar
aliguori committed
244
245
}

246
247
248
static int stdio_pclose(void *opaque)
{
    QEMUFileStdio *s = opaque;
249
250
    int ret;
    ret = pclose(s->stdio_file);
251
252
253
    if (ret == -1) {
        ret = -errno;
    }
254
    g_free(s);
255
    return ret;
256
257
258
}

static int stdio_fclose(void *opaque)
aliguori's avatar
aliguori committed
259
{
260
    QEMUFileStdio *s = opaque;
261
262
263
264
    int ret = 0;
    if (fclose(s->stdio_file) == EOF) {
        ret = -errno;
    }
265
    g_free(s);
266
    return ret;
aliguori's avatar
aliguori committed
267
268
}

269
static const QEMUFileOps stdio_pipe_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
270
    .get_fd =     stdio_get_fd,
271
272
273
274
275
    .get_buffer = stdio_get_buffer,
    .close =      stdio_pclose
};

static const QEMUFileOps stdio_pipe_write_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
276
    .get_fd =     stdio_get_fd,
277
278
279
280
    .put_buffer = stdio_put_buffer,
    .close =      stdio_pclose
};

281
QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
aliguori's avatar
aliguori committed
282
{
283
    QEMUFileStdio *s;
aliguori's avatar
aliguori committed
284

285
    if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
aliguori's avatar
aliguori committed
286
287
288
289
        fprintf(stderr, "qemu_popen: Argument validity check failed\n");
        return NULL;
    }

290
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
291

292
    s->stdio_file = stdio_file;
aliguori's avatar
aliguori committed
293
294

    if(mode[0] == 'r') {
295
        s->file = qemu_fopen_ops(s, &stdio_pipe_read_ops);
aliguori's avatar
aliguori committed
296
    } else {
297
        s->file = qemu_fopen_ops(s, &stdio_pipe_write_ops);
aliguori's avatar
aliguori committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
    }
    return s->file;
}

QEMUFile *qemu_popen_cmd(const char *command, const char *mode)
{
    FILE *popen_file;

    popen_file = popen(command, mode);
    if(popen_file == NULL) {
        return NULL;
    }

    return qemu_popen(popen_file, mode);
}

314
int qemu_stdio_fd(QEMUFile *f)
315
{
316
    QEMUFileStdio *p;
317
318
    int fd;

319
320
    p = (QEMUFileStdio *)f->opaque;
    fd = fileno(p->stdio_file);
321
322
323
324

    return fd;
}

325
static const QEMUFileOps stdio_file_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
326
    .get_fd =     stdio_get_fd,
327
328
329
330
331
    .get_buffer = stdio_get_buffer,
    .close =      stdio_fclose
};

static const QEMUFileOps stdio_file_write_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
332
    .get_fd =     stdio_get_fd,
333
334
335
336
    .put_buffer = stdio_put_buffer,
    .close =      stdio_fclose
};

Paolo Bonzini's avatar
Paolo Bonzini committed
337
338
339
340
341
342
343
344
345
346
347
QEMUFile *qemu_fdopen(int fd, const char *mode)
{
    QEMUFileStdio *s;

    if (mode == NULL ||
	(mode[0] != 'r' && mode[0] != 'w') ||
	mode[1] != 'b' || mode[2] != 0) {
        fprintf(stderr, "qemu_fdopen: Argument validity check failed\n");
        return NULL;
    }

348
    s = g_malloc0(sizeof(QEMUFileStdio));
Paolo Bonzini's avatar
Paolo Bonzini committed
349
350
351
352
353
    s->stdio_file = fdopen(fd, mode);
    if (!s->stdio_file)
        goto fail;

    if(mode[0] == 'r') {
354
        s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
Paolo Bonzini's avatar
Paolo Bonzini committed
355
    } else {
356
        s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
Paolo Bonzini's avatar
Paolo Bonzini committed
357
358
359
360
    }
    return s->file;

fail:
361
    g_free(s);
Paolo Bonzini's avatar
Paolo Bonzini committed
362
363
364
    return NULL;
}

365
static const QEMUFileOps socket_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
366
    .get_fd =     socket_get_fd,
367
368
369
370
    .get_buffer = socket_get_buffer,
    .close =      socket_close
};

aliguori's avatar
aliguori committed
371
372
QEMUFile *qemu_fopen_socket(int fd)
{
373
    QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
aliguori's avatar
aliguori committed
374
375

    s->fd = fd;
376
    s->file = qemu_fopen_ops(s, &socket_read_ops);
aliguori's avatar
aliguori committed
377
378
379
380
381
382
383
    return s->file;
}

QEMUFile *qemu_fopen(const char *filename, const char *mode)
{
    QEMUFileStdio *s;

384
385
386
    if (mode == NULL ||
	(mode[0] != 'r' && mode[0] != 'w') ||
	mode[1] != 'b' || mode[2] != 0) {
Blue Swirl's avatar
Blue Swirl committed
387
        fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
388
389
390
        return NULL;
    }

391
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
392

393
394
    s->stdio_file = fopen(filename, mode);
    if (!s->stdio_file)
aliguori's avatar
aliguori committed
395
        goto fail;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
396
    
397
    if(mode[0] == 'w') {
398
        s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
399
    } else {
400
        s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
401
402
    }
    return s->file;
aliguori's avatar
aliguori committed
403
fail:
404
    g_free(s);
aliguori's avatar
aliguori committed
405
406
407
    return NULL;
}

408
static int block_put_buffer(void *opaque, const uint8_t *buf,
aliguori's avatar
aliguori committed
409
410
                           int64_t pos, int size)
{
411
    bdrv_save_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
412
413
414
    return size;
}

415
static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
416
{
417
    return bdrv_load_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
418
419
420
421
}

static int bdrv_fclose(void *opaque)
{
422
    return bdrv_flush(opaque);
aliguori's avatar
aliguori committed
423
424
}

425
426
427
428
429
430
431
432
433
434
static const QEMUFileOps bdrv_read_ops = {
    .get_buffer = block_get_buffer,
    .close =      bdrv_fclose
};

static const QEMUFileOps bdrv_write_ops = {
    .put_buffer = block_put_buffer,
    .close =      bdrv_fclose
};

435
static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
aliguori's avatar
aliguori committed
436
437
{
    if (is_writable)
438
439
        return qemu_fopen_ops(bs, &bdrv_write_ops);
    return qemu_fopen_ops(bs, &bdrv_read_ops);
aliguori's avatar
aliguori committed
440
441
}

442
QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops)
aliguori's avatar
aliguori committed
443
444
445
{
    QEMUFile *f;

446
    f = g_malloc0(sizeof(QEMUFile));
aliguori's avatar
aliguori committed
447
448

    f->opaque = opaque;
449
    f->ops = ops;
aliguori's avatar
aliguori committed
450
451
452
453
454
    f->is_write = 0;

    return f;
}

455
int qemu_file_get_error(QEMUFile *f)
aliguori's avatar
aliguori committed
456
{
457
    return f->last_error;
aliguori's avatar
aliguori committed
458
459
}

460
static void qemu_file_set_error(QEMUFile *f, int ret)
461
{
462
    f->last_error = ret;
463
464
}

465
466
467
/** Flushes QEMUFile buffer
 *
 */
468
static int qemu_fflush(QEMUFile *f)
aliguori's avatar
aliguori committed
469
{
470
471
    int ret = 0;

472
    if (!f->ops->put_buffer)
473
        return 0;
aliguori's avatar
aliguori committed
474
475

    if (f->is_write && f->buf_index > 0) {
476
        ret = f->ops->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
477
        if (ret >= 0) {
aliguori's avatar
aliguori committed
478
            f->buf_offset += f->buf_index;
479
        }
aliguori's avatar
aliguori committed
480
481
        f->buf_index = 0;
    }
482
    return ret;
aliguori's avatar
aliguori committed
483
484
485
486
487
}

static void qemu_fill_buffer(QEMUFile *f)
{
    int len;
488
    int pending;
aliguori's avatar
aliguori committed
489

490
    if (!f->ops->get_buffer)
aliguori's avatar
aliguori committed
491
492
493
494
495
        return;

    if (f->is_write)
        abort();

496
497
498
499
500
501
502
    pending = f->buf_size - f->buf_index;
    if (pending > 0) {
        memmove(f->buf, f->buf + f->buf_index, pending);
    }
    f->buf_index = 0;
    f->buf_size = pending;

503
    len = f->ops->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
504
                        IO_BUF_SIZE - pending);
aliguori's avatar
aliguori committed
505
    if (len > 0) {
506
        f->buf_size += len;
aliguori's avatar
aliguori committed
507
        f->buf_offset += len;
508
    } else if (len == 0) {
509
        qemu_file_set_error(f, -EIO);
aliguori's avatar
aliguori committed
510
    } else if (len != -EAGAIN)
511
        qemu_file_set_error(f, len);
aliguori's avatar
aliguori committed
512
513
}

Paolo Bonzini's avatar
Paolo Bonzini committed
514
515
516
517
518
519
520
521
int qemu_get_fd(QEMUFile *f)
{
    if (f->ops->get_fd) {
        return f->ops->get_fd(f->opaque);
    }
    return -1;
}

522
523
524
525
526
527
528
529
530
531
/** Closes the file
 *
 * Returns negative error value if any error happened on previous operations or
 * while closing the file. Returns 0 or positive number on success.
 *
 * The meaning of return value on success depends on the specific backend
 * being used.
 */
int qemu_fclose(QEMUFile *f)
{
532
    int ret;
533
534
    ret = qemu_fflush(f);

535
536
    if (f->ops->close) {
        int ret2 = f->ops->close(f->opaque);
537
538
539
        if (ret >= 0) {
            ret = ret2;
        }
540
    }
541
542
543
544
545
546
    /* If any error was spotted before closing, we should report it
     * instead of the close() return value.
     */
    if (f->last_error) {
        ret = f->last_error;
    }
547
    g_free(f);
aliguori's avatar
aliguori committed
548
549
550
    return ret;
}

551
int qemu_file_put_notify(QEMUFile *f)
aliguori's avatar
aliguori committed
552
{
553
    return f->ops->put_buffer(f->opaque, NULL, 0, 0);
aliguori's avatar
aliguori committed
554
555
556
557
558
559
}

void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size)
{
    int l;

560
561
562
563
564
    if (f->last_error) {
        return;
    }

    if (f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
565
566
567
568
569
        fprintf(stderr,
                "Attempted to write to buffer while read buffer is not empty\n");
        abort();
    }

570
    while (size > 0) {
aliguori's avatar
aliguori committed
571
572
573
574
575
576
577
578
        l = IO_BUF_SIZE - f->buf_index;
        if (l > size)
            l = size;
        memcpy(f->buf + f->buf_index, buf, l);
        f->is_write = 1;
        f->buf_index += l;
        buf += l;
        size -= l;
579
580
        if (f->buf_index >= IO_BUF_SIZE) {
            int ret = qemu_fflush(f);
581
582
583
584
            if (ret < 0) {
                qemu_file_set_error(f, ret);
                break;
            }
585
        }
aliguori's avatar
aliguori committed
586
587
588
589
590
    }
}

void qemu_put_byte(QEMUFile *f, int v)
{
591
592
593
594
595
    if (f->last_error) {
        return;
    }

    if (f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
596
597
598
599
600
601
602
        fprintf(stderr,
                "Attempted to write to buffer while read buffer is not empty\n");
        abort();
    }

    f->buf[f->buf_index++] = v;
    f->is_write = 1;
603
604
    if (f->buf_index >= IO_BUF_SIZE) {
        int ret = qemu_fflush(f);
605
606
607
        if (ret < 0) {
            qemu_file_set_error(f, ret);
        }
608
    }
aliguori's avatar
aliguori committed
609
610
}

611
static void qemu_file_skip(QEMUFile *f, int size)
aliguori's avatar
aliguori committed
612
{
613
614
615
616
617
618
    if (f->buf_index + size <= f->buf_size) {
        f->buf_index += size;
    }
}

static int qemu_peek_buffer(QEMUFile *f, uint8_t *buf, int size, size_t offset)
aliguori's avatar
aliguori committed
619
{
620
621
    int pending;
    int index;
aliguori's avatar
aliguori committed
622

623
    if (f->is_write) {
aliguori's avatar
aliguori committed
624
        abort();
625
    }
aliguori's avatar
aliguori committed
626

627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
    index = f->buf_index + offset;
    pending = f->buf_size - index;
    if (pending < size) {
        qemu_fill_buffer(f);
        index = f->buf_index + offset;
        pending = f->buf_size - index;
    }

    if (pending <= 0) {
        return 0;
    }
    if (size > pending) {
        size = pending;
    }

    memcpy(buf, f->buf + index, size);
    return size;
}

int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size)
{
    int pending = size;
    int done = 0;

    while (pending > 0) {
        int res;

        res = qemu_peek_buffer(f, buf, pending, 0);
        if (res == 0) {
            return done;
aliguori's avatar
aliguori committed
657
        }
658
659
660
661
        qemu_file_skip(f, res);
        buf += res;
        pending -= res;
        done += res;
aliguori's avatar
aliguori committed
662
    }
663
    return done;
aliguori's avatar
aliguori committed
664
665
}

666
static int qemu_peek_byte(QEMUFile *f, int offset)
Juan Quintela's avatar
Juan Quintela committed
667
{
668
669
    int index = f->buf_index + offset;

670
    if (f->is_write) {
Juan Quintela's avatar
Juan Quintela committed
671
        abort();
672
    }
Juan Quintela's avatar
Juan Quintela committed
673

674
    if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
675
        qemu_fill_buffer(f);
676
677
        index = f->buf_index + offset;
        if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
678
            return 0;
679
        }
Juan Quintela's avatar
Juan Quintela committed
680
    }
681
    return f->buf[index];
Juan Quintela's avatar
Juan Quintela committed
682
683
}

aliguori's avatar
aliguori committed
684
685
int qemu_get_byte(QEMUFile *f)
{
686
    int result;
aliguori's avatar
aliguori committed
687

688
689
    result = qemu_peek_byte(f, 0);
    qemu_file_skip(f, 1);
690
    return result;
aliguori's avatar
aliguori committed
691
692
}

Juan Quintela's avatar
Juan Quintela committed
693
static int64_t qemu_ftell(QEMUFile *f)
aliguori's avatar
aliguori committed
694
695
696
697
698
699
{
    return f->buf_offset - f->buf_size + f->buf_index;
}

int qemu_file_rate_limit(QEMUFile *f)
{
700
701
    if (f->ops->rate_limit)
        return f->ops->rate_limit(f->opaque);
aliguori's avatar
aliguori committed
702
703
704
705

    return 0;
}

706
int64_t qemu_file_get_rate_limit(QEMUFile *f)
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
707
{
708
709
    if (f->ops->get_rate_limit)
        return f->ops->get_rate_limit(f->opaque);
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
710
711
712
713

    return 0;
}

714
int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
715
{
716
717
    /* any failed or completed migration keeps its state to allow probing of
     * migration data, but has no associated file anymore */
718
719
    if (f && f->ops->set_rate_limit)
        return f->ops->set_rate_limit(f->opaque, new_rate);
720
721
722
723

    return 0;
}

aliguori's avatar
aliguori committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
void qemu_put_be16(QEMUFile *f, unsigned int v)
{
    qemu_put_byte(f, v >> 8);
    qemu_put_byte(f, v);
}

void qemu_put_be32(QEMUFile *f, unsigned int v)
{
    qemu_put_byte(f, v >> 24);
    qemu_put_byte(f, v >> 16);
    qemu_put_byte(f, v >> 8);
    qemu_put_byte(f, v);
}

void qemu_put_be64(QEMUFile *f, uint64_t v)
{
    qemu_put_be32(f, v >> 32);
    qemu_put_be32(f, v);
}

unsigned int qemu_get_be16(QEMUFile *f)
{
    unsigned int v;
    v = qemu_get_byte(f) << 8;
    v |= qemu_get_byte(f);
    return v;
}

unsigned int qemu_get_be32(QEMUFile *f)
{
    unsigned int v;
    v = qemu_get_byte(f) << 24;
    v |= qemu_get_byte(f) << 16;
    v |= qemu_get_byte(f) << 8;
    v |= qemu_get_byte(f);
    return v;
}

uint64_t qemu_get_be64(QEMUFile *f)
{
    uint64_t v;
    v = (uint64_t)qemu_get_be32(f) << 32;
    v |= qemu_get_be32(f);
    return v;
}

770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793

/* timer */

void qemu_put_timer(QEMUFile *f, QEMUTimer *ts)
{
    uint64_t expire_time;

    expire_time = qemu_timer_expire_time_ns(ts);
    qemu_put_be64(f, expire_time);
}

void qemu_get_timer(QEMUFile *f, QEMUTimer *ts)
{
    uint64_t expire_time;

    expire_time = qemu_get_be64(f);
    if (expire_time != -1) {
        qemu_mod_timer_ns(ts, expire_time);
    } else {
        qemu_del_timer(ts);
    }
}


Gerd Hoffmann's avatar
Gerd Hoffmann committed
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
/* bool */

static int get_bool(QEMUFile *f, void *pv, size_t size)
{
    bool *v = pv;
    *v = qemu_get_byte(f);
    return 0;
}

static void put_bool(QEMUFile *f, void *pv, size_t size)
{
    bool *v = pv;
    qemu_put_byte(f, *v);
}

const VMStateInfo vmstate_info_bool = {
    .name = "bool",
    .get  = get_bool,
    .put  = put_bool,
};

815
816
817
818
819
820
821
822
823
/* 8 bit int */

static int get_int8(QEMUFile *f, void *pv, size_t size)
{
    int8_t *v = pv;
    qemu_get_s8s(f, v);
    return 0;
}

824
static void put_int8(QEMUFile *f, void *pv, size_t size)
825
{
826
    int8_t *v = pv;
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
    qemu_put_s8s(f, v);
}

const VMStateInfo vmstate_info_int8 = {
    .name = "int8",
    .get  = get_int8,
    .put  = put_int8,
};

/* 16 bit int */

static int get_int16(QEMUFile *f, void *pv, size_t size)
{
    int16_t *v = pv;
    qemu_get_sbe16s(f, v);
    return 0;
}

845
static void put_int16(QEMUFile *f, void *pv, size_t size)
846
{
847
    int16_t *v = pv;
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
    qemu_put_sbe16s(f, v);
}

const VMStateInfo vmstate_info_int16 = {
    .name = "int16",
    .get  = get_int16,
    .put  = put_int16,
};

/* 32 bit int */

static int get_int32(QEMUFile *f, void *pv, size_t size)
{
    int32_t *v = pv;
    qemu_get_sbe32s(f, v);
    return 0;
}

866
static void put_int32(QEMUFile *f, void *pv, size_t size)
867
{
868
    int32_t *v = pv;
869
870
871
872
873
874
875
876
877
    qemu_put_sbe32s(f, v);
}

const VMStateInfo vmstate_info_int32 = {
    .name = "int32",
    .get  = get_int32,
    .put  = put_int32,
};

878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
/* 32 bit int. See that the received value is the same than the one
   in the field */

static int get_int32_equal(QEMUFile *f, void *pv, size_t size)
{
    int32_t *v = pv;
    int32_t v2;
    qemu_get_sbe32s(f, &v2);

    if (*v == v2)
        return 0;
    return -EINVAL;
}

const VMStateInfo vmstate_info_int32_equal = {
    .name = "int32 equal",
    .get  = get_int32_equal,
    .put  = put_int32,
};

898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
/* 32 bit int. See that the received value is the less or the same
   than the one in the field */

static int get_int32_le(QEMUFile *f, void *pv, size_t size)
{
    int32_t *old = pv;
    int32_t new;
    qemu_get_sbe32s(f, &new);

    if (*old <= new)
        return 0;
    return -EINVAL;
}

const VMStateInfo vmstate_info_int32_le = {
    .name = "int32 equal",
    .get  = get_int32_le,
    .put  = put_int32,
};

918
919
920
921
922
923
924
925
926
/* 64 bit int */

static int get_int64(QEMUFile *f, void *pv, size_t size)
{
    int64_t *v = pv;
    qemu_get_sbe64s(f, v);
    return 0;
}

927
static void put_int64(QEMUFile *f, void *pv, size_t size)
928
{
929
    int64_t *v = pv;
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
    qemu_put_sbe64s(f, v);
}

const VMStateInfo vmstate_info_int64 = {
    .name = "int64",
    .get  = get_int64,
    .put  = put_int64,
};

/* 8 bit unsigned int */

static int get_uint8(QEMUFile *f, void *pv, size_t size)
{
    uint8_t *v = pv;
    qemu_get_8s(f, v);
    return 0;
}

948
static void put_uint8(QEMUFile *f, void *pv, size_t size)
949
{
950
    uint8_t *v = pv;
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    qemu_put_8s(f, v);
}

const VMStateInfo vmstate_info_uint8 = {
    .name = "uint8",
    .get  = get_uint8,
    .put  = put_uint8,
};

/* 16 bit unsigned int */

static int get_uint16(QEMUFile *f, void *pv, size_t size)
{
    uint16_t *v = pv;
    qemu_get_be16s(f, v);
    return 0;
}

969
static void put_uint16(QEMUFile *f, void *pv, size_t size)
970
{
971
    uint16_t *v = pv;
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
    qemu_put_be16s(f, v);
}

const VMStateInfo vmstate_info_uint16 = {
    .name = "uint16",
    .get  = get_uint16,
    .put  = put_uint16,
};

/* 32 bit unsigned int */

static int get_uint32(QEMUFile *f, void *pv, size_t size)
{
    uint32_t *v = pv;
    qemu_get_be32s(f, v);
    return 0;
}

990
static void put_uint32(QEMUFile *f, void *pv, size_t size)
991
{
992
    uint32_t *v = pv;
993
994
995
996
997
998
999
1000
1001
    qemu_put_be32s(f, v);
}

const VMStateInfo vmstate_info_uint32 = {
    .name = "uint32",
    .get  = get_uint32,
    .put  = put_uint32,
};

1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
/* 32 bit uint. See that the received value is the same than the one
   in the field */

static int get_uint32_equal(QEMUFile *f, void *pv, size_t size)
{
    uint32_t *v = pv;
    uint32_t v2;
    qemu_get_be32s(f, &v2);

    if (*v == v2) {
        return 0;
    }
    return -EINVAL;
}

const VMStateInfo vmstate_info_uint32_equal = {
    .name = "uint32 equal",
    .get  = get_uint32_equal,
    .put  = put_uint32,
};

1023
1024
1025
1026
1027
1028
1029
1030
1031
/* 64 bit unsigned int */

static int get_uint64(QEMUFile *f, void *pv, size_t size)
{
    uint64_t *v = pv;
    qemu_get_be64s(f, v);
    return 0;
}

1032
static void put_uint64(QEMUFile *f, void *pv, size_t size)
1033
{
1034
    uint64_t *v = pv;
1035
1036
1037
1038
1039
1040
1041
1042
1043
    qemu_put_be64s(f, v);
}

const VMStateInfo vmstate_info_uint64 = {
    .name = "uint64",
    .get  = get_uint64,
    .put  = put_uint64,
};

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
/* 8 bit int. See that the received value is the same than the one
   in the field */

static int get_uint8_equal(QEMUFile *f, void *pv, size_t size)
{
    uint8_t *v = pv;
    uint8_t v2;
    qemu_get_8s(f, &v2);

    if (*v == v2)
        return 0;
    return -EINVAL;
}

const VMStateInfo vmstate_info_uint8_equal = {
1059
    .name = "uint8 equal",
1060
1061
1062
1063
    .get  = get_uint8_equal,
    .put  = put_uint8,
};

1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
/* 16 bit unsigned int int. See that the received value is the same than the one
   in the field */

static int get_uint16_equal(QEMUFile *f, void *pv, size_t size)
{
    uint16_t *v = pv;
    uint16_t v2;
    qemu_get_be16s(f, &v2);

    if (*v == v2)
        return 0;
    return -EINVAL;
}

const VMStateInfo vmstate_info_uint16_equal = {
    .name = "uint16 equal",
    .get  = get_uint16_equal,
    .put  = put_uint16,
};

1084
1085
1086
1087
1088
1089
1090
1091
1092
/* timers  */

static int get_timer(QEMUFile *f, void *pv, size_t size)
{
    QEMUTimer *v = pv;
    qemu_get_timer(f, v);
    return 0;
}

1093
static void put_timer(QEMUFile *f, void *pv, size_t size)
1094
{
1095
    QEMUTimer *v = pv;
1096
1097
1098
1099
1100
1101
1102
1103
1104
    qemu_put_timer(f, v);
}

const VMStateInfo vmstate_info_timer = {
    .name = "timer",
    .get  = get_timer,
    .put  = put_timer,
};

1105
1106
1107
1108
1109
1110
1111
1112
1113
/* uint8_t buffers */

static int get_buffer(QEMUFile *f, void *pv, size_t size)
{
    uint8_t *v = pv;
    qemu_get_buffer(f, v, size);
    return 0;
}

1114
static void put_buffer(QEMUFile *f, void *pv, size_t size)
1115
{
1116
    uint8_t *v = pv;
1117
1118
1119
1120
1121
1122
1123
1124
1125
    qemu_put_buffer(f, v, size);
}

const VMStateInfo vmstate_info_buffer = {
    .name = "buffer",
    .get  = get_buffer,
    .put  = put_buffer,
};

1126
/* unused buffers: space that was used for some fields that are
1127
   not useful anymore */
1128
1129
1130

static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1131
1132
1133
1134
1135
1136
1137
1138
1139
    uint8_t buf[1024];
    int block_len;

    while (size > 0) {
        block_len = MIN(sizeof(buf), size);
        size -= block_len;
        qemu_get_buffer(f, buf, block_len);
    }
   return 0;
1140
1141
1142
1143
}

static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1144
1145
1146
1147
1148
1149
1150
1151
    static const uint8_t buf[1024];
    int block_len;

    while (size > 0) {
        block_len = MIN(sizeof(buf), size);
        size -= block_len;
        qemu_put_buffer(f, buf, block_len);
    }
1152
1153
1154
1155
1156
1157
1158
1159
}

const VMStateInfo vmstate_info_unused_buffer = {
    .name = "unused_buffer",
    .get  = get_unused_buffer,
    .put  = put_unused_buffer,
};

1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
/* bitmaps (as defined by bitmap.h). Note that size here is the size
 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
 * bit words with the bits in big endian order. The in-memory format
 * is an array of 'unsigned long', which may be either 32 or 64 bits.
 */
/* This is the number of 64 bit words sent over the wire */
#define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
static int get_bitmap(QEMUFile *f, void *pv, size_t size)
{
    unsigned long *bmp = pv;
    int i, idx = 0;
    for (i = 0; i < BITS_TO_U64S(size); i++) {
        uint64_t w = qemu_get_be64(f);
        bmp[idx++] = w;
        if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
            bmp[idx++] = w >> 32;
        }
    }
    return 0;
}

static void put_bitmap(QEMUFile *f, void *pv, size_t size)
{
    unsigned long *bmp = pv;
    int i, idx = 0;
    for (i = 0; i < BITS_TO_U64S(size); i++) {
        uint64_t w = bmp[idx++];
        if (sizeof(unsigned long) == 4 && idx < BITS_TO_LONGS(size)) {
            w |= ((uint64_t)bmp[idx++]) << 32;
        }
        qemu_put_be64(f, w);
    }
}

const VMStateInfo vmstate_info_bitmap = {
    .name = "bitmap",
    .get = get_bitmap,
    .put = put_bitmap,
};

1200
1201
1202
1203
1204
typedef struct CompatEntry {
    char idstr[256];
    int instance_id;
} CompatEntry;

aliguori's avatar
aliguori committed
1205
typedef struct SaveStateEntry {
Blue Swirl's avatar
Blue Swirl committed
1206
    QTAILQ_ENTRY(SaveStateEntry) entry;
aliguori's avatar
aliguori committed
1207
1208
    char idstr[256];
    int instance_id;
Jan Kiszka's avatar
Jan Kiszka committed
1209
    int alias_id;
aliguori's avatar
aliguori committed
1210
1211
    int version_id;
    int section_id;
1212
    SaveVMHandlers *ops;
1213
    const VMStateDescription *vmsd;
aliguori's avatar
aliguori committed
1214
    void *opaque;
1215
    CompatEntry *compat;
1216
    int no_migrate;
1217
    int is_ram;
aliguori's avatar
aliguori committed
1218
1219
} SaveStateEntry;

lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
1220

Blue Swirl's avatar
Blue Swirl committed
1221
1222
static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
    QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1223
static int global_section_id;
aliguori's avatar
aliguori committed
1224

1225
1226
1227
1228
1229
static int calculate_new_instance_id(const char *idstr)
{
    SaveStateEntry *se;
    int instance_id = 0;

Blue Swirl's avatar
Blue Swirl committed
1230
    QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1231
1232
1233
1234
1235
1236
1237
1238
        if (strcmp(idstr, se->idstr) == 0
            && instance_id <= se->instance_id) {
            instance_id = se->instance_id + 1;
        }
    }
    return instance_id;
}

1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
static int calculate_compat_instance_id(const char *idstr)
{
    SaveStateEntry *se;
    int instance_id = 0;

    QTAILQ_FOREACH(se, &savevm_handlers, entry) {
        if (!se->compat)
            continue;

        if (strcmp(idstr, se->compat->idstr) == 0
            && instance_id <= se->compat->instance_id) {
            instance_id = se->compat->instance_id + 1;
        }
    }
    return instance_id;
}

aliguori's avatar
aliguori committed
1256
1257
1258
1259
/* TODO: Individual devices generally have very little idea about the rest
   of the system, so instance_id should be removed/replaced.
   Meanwhile pass -1 as instance_id if you do not already have a clearly
   distinguishing id for all instances of your device class. */
1260
1261
int register_savevm_live(DeviceState *dev,
                         const char *idstr,
aliguori's avatar
aliguori committed
1262
1263
                         int instance_id,
                         int version_id,
1264
                         SaveVMHandlers *ops,
aliguori's avatar
aliguori committed
1265
1266
                         void *opaque)
{
1267
    SaveStateEntry *se;
aliguori's avatar
aliguori committed
1268

1269
    se = g_malloc0(sizeof(SaveStateEntry));
aliguori's avatar
aliguori committed
1270
1271
    se->version_id = version_id;
    se->section_id = global_section_id++;
1272
    se->ops = ops;
aliguori's avatar
aliguori committed
1273
    se->opaque = opaque;
1274
    se->vmsd = NULL;
1275
    se->no_migrate = 0;
1276
    /* if this is a live_savem then set is_ram */
1277
    if (ops->save_live_setup != NULL) {
1278
1279
        se->is_ram = 1;
    }
aliguori's avatar
aliguori committed
1280

1281
1282
    if (dev) {
        char *id = qdev_get_dev_path(dev);
1283
1284
1285
        if (id) {
            pstrcpy(se->idstr, sizeof(se->idstr), id);
            pstrcat(se->idstr, sizeof(se->idstr), "/");
1286
            g_free(id);
1287

1288
            se->compat = g_malloc0(sizeof(CompatEntry));
1289
1290
1291
1292
1293
1294
1295
1296
            pstrcpy(se->compat->idstr, sizeof(se->compat->idstr), idstr);
            se->compat->instance_id = instance_id == -1 ?
                         calculate_compat_instance_id(idstr) : instance_id;
            instance_id = -1;
        }
    }
    pstrcat(se->idstr, sizeof(se->idstr), idstr);

1297
    if (instance_id == -1) {
1298
        se->instance_id = calculate_new_instance_id(se->idstr);
1299
1300
    } else {
        se->instance_id = instance_id;
aliguori's avatar
aliguori committed
1301
    }
1302
    assert(!se->compat || se->instance_id == 0);
1303
    /* add at the end of list */
Blue Swirl's avatar
Blue Swirl committed
1304
    QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
aliguori's avatar
aliguori committed
1305
1306
1307
    return 0;
}

1308
1309
int register_savevm(DeviceState *dev,
                    const char *idstr,
aliguori's avatar
aliguori committed
1310
1311
1312
1313
1314
1315
                    int instance_id,
                    int version_id,
                    SaveStateHandler *save_state,
                    LoadStateHandler *load_state,
                    void *opaque)
{
1316
1317
1318
    SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
    ops->save