savevm.c 62 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

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

Nolan's avatar
Nolan committed
92
#ifndef ETH_P_RARP
Stefan Berger's avatar
Stefan Berger committed
93
#define ETH_P_RARP 0x8035
Nolan's avatar
Nolan committed
94
95
96
97
98
99
#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
100
101
				uint8_t *mac_addr)
{
Nolan's avatar
Nolan committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
    /* 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
122
123
}

124
static void qemu_announce_self_iter(NICState *nic, void *opaque)
aliguori's avatar
aliguori committed
125
{
Nolan's avatar
Nolan committed
126
    uint8_t buf[60];
127
128
129
130
131
132
133
134
135
136
    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)
{
137
138
    static int count = SELF_ANNOUNCE_ROUNDS;
    QEMUTimer *timer = *(QEMUTimer **)opaque;
aliguori's avatar
aliguori committed
139

140
141
    qemu_foreach_nic(qemu_announce_self_iter, NULL);

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

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

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

#define IO_BUF_SIZE 32768

struct QEMUFile {
    QEMUFilePutBufferFunc *put_buffer;
    QEMUFileGetBufferFunc *get_buffer;
    QEMUFileCloseFunc *close;
    QEMUFileRateLimit *rate_limit;
169
    QEMUFileSetRateLimit *set_rate_limit;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
170
    QEMUFileGetRateLimit *get_rate_limit;
aliguori's avatar
aliguori committed
171
172
173
174
175
176
177
178
179
    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];

180
    int last_error;
aliguori's avatar
aliguori committed
181
182
};

183
typedef struct QEMUFileStdio
aliguori's avatar
aliguori committed
184
{
185
    FILE *stdio_file;
aliguori's avatar
aliguori committed
186
    QEMUFile *file;
187
} QEMUFileStdio;
aliguori's avatar
aliguori committed
188
189
190
191
192
193
194
195
196
197
198
199
200

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

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
201
        len = qemu_recv(s->fd, buf, size, 0);
aliguori's avatar
aliguori committed
202
203
204
205
206
207
208
209
210
211
212
    } while (len == -1 && socket_error() == EINTR);

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

    return len;
}

static int socket_close(void *opaque)
{
    QEMUFileSocket *s = opaque;
213
    g_free(s);
aliguori's avatar
aliguori committed
214
215
216
    return 0;
}

217
static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
218
{
219
220
    QEMUFileStdio *s = opaque;
    return fwrite(buf, 1, size, s->stdio_file);
aliguori's avatar
aliguori committed
221
222
}

223
static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
224
{
225
226
    QEMUFileStdio *s = opaque;
    FILE *fp = s->stdio_file;
227
228
229
230
231
232
233
    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
234
235
}

236
237
238
static int stdio_pclose(void *opaque)
{
    QEMUFileStdio *s = opaque;
239
240
    int ret;
    ret = pclose(s->stdio_file);
241
242
243
    if (ret == -1) {
        ret = -errno;
    }
244
    g_free(s);
245
    return ret;
246
247
248
}

static int stdio_fclose(void *opaque)
aliguori's avatar
aliguori committed
249
{
250
    QEMUFileStdio *s = opaque;
251
252
253
254
    int ret = 0;
    if (fclose(s->stdio_file) == EOF) {
        ret = -errno;
    }
255
    g_free(s);
256
    return ret;
aliguori's avatar
aliguori committed
257
258
}

259
QEMUFile *qemu_popen(FILE *stdio_file, const char *mode)
aliguori's avatar
aliguori committed
260
{
261
    QEMUFileStdio *s;
aliguori's avatar
aliguori committed
262

263
    if (stdio_file == NULL || mode == NULL || (mode[0] != 'r' && mode[0] != 'w') || mode[1] != 0) {
aliguori's avatar
aliguori committed
264
265
266
267
        fprintf(stderr, "qemu_popen: Argument validity check failed\n");
        return NULL;
    }

268
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
269

270
    s->stdio_file = stdio_file;
aliguori's avatar
aliguori committed
271
272

    if(mode[0] == 'r') {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
273
274
        s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_pclose, 
				 NULL, NULL, NULL);
aliguori's avatar
aliguori committed
275
    } else {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
276
277
        s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_pclose, 
				 NULL, NULL, NULL);
aliguori's avatar
aliguori committed
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
    }
    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);
}

294
int qemu_stdio_fd(QEMUFile *f)
295
{
296
    QEMUFileStdio *p;
297
298
    int fd;

299
300
    p = (QEMUFileStdio *)f->opaque;
    fd = fileno(p->stdio_file);
301
302
303
304

    return fd;
}

Paolo Bonzini's avatar
Paolo Bonzini committed
305
306
307
308
309
310
311
312
313
314
315
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;
    }

316
    s = g_malloc0(sizeof(QEMUFileStdio));
Paolo Bonzini's avatar
Paolo Bonzini committed
317
318
319
320
321
    s->stdio_file = fdopen(fd, mode);
    if (!s->stdio_file)
        goto fail;

    if(mode[0] == 'r') {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
322
323
        s->file = qemu_fopen_ops(s, NULL, stdio_get_buffer, stdio_fclose, 
				 NULL, NULL, NULL);
Paolo Bonzini's avatar
Paolo Bonzini committed
324
    } else {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
325
326
        s->file = qemu_fopen_ops(s, stdio_put_buffer, NULL, stdio_fclose, 
				 NULL, NULL, NULL);
Paolo Bonzini's avatar
Paolo Bonzini committed
327
328
329
330
    }
    return s->file;

fail:
331
    g_free(s);
Paolo Bonzini's avatar
Paolo Bonzini committed
332
333
334
    return NULL;
}

aliguori's avatar
aliguori committed
335
336
QEMUFile *qemu_fopen_socket(int fd)
{
337
    QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
aliguori's avatar
aliguori committed
338
339

    s->fd = fd;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
340
341
    s->file = qemu_fopen_ops(s, NULL, socket_get_buffer, socket_close, 
			     NULL, NULL, NULL);
aliguori's avatar
aliguori committed
342
343
344
345
346
347
348
    return s->file;
}

static int file_put_buffer(void *opaque, const uint8_t *buf,
                            int64_t pos, int size)
{
    QEMUFileStdio *s = opaque;
349
    fseek(s->stdio_file, pos, SEEK_SET);
350
    return fwrite(buf, 1, size, s->stdio_file);
aliguori's avatar
aliguori committed
351
352
353
354
355
}

static int file_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
{
    QEMUFileStdio *s = opaque;
356
357
    fseek(s->stdio_file, pos, SEEK_SET);
    return fread(buf, 1, size, s->stdio_file);
aliguori's avatar
aliguori committed
358
359
360
361
362
363
}

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

364
365
366
    if (mode == NULL ||
	(mode[0] != 'r' && mode[0] != 'w') ||
	mode[1] != 'b' || mode[2] != 0) {
Blue Swirl's avatar
Blue Swirl committed
367
        fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
368
369
370
        return NULL;
    }

371
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
372

373
374
    s->stdio_file = fopen(filename, mode);
    if (!s->stdio_file)
aliguori's avatar
aliguori committed
375
        goto fail;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
376
    
377
    if(mode[0] == 'w') {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
378
379
        s->file = qemu_fopen_ops(s, file_put_buffer, NULL, stdio_fclose, 
				 NULL, NULL, NULL);
380
    } else {
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
381
382
        s->file = qemu_fopen_ops(s, NULL, file_get_buffer, stdio_fclose, 
			       NULL, NULL, NULL);
383
384
    }
    return s->file;
aliguori's avatar
aliguori committed
385
fail:
386
    g_free(s);
aliguori's avatar
aliguori committed
387
388
389
    return NULL;
}

390
static int block_put_buffer(void *opaque, const uint8_t *buf,
aliguori's avatar
aliguori committed
391
392
                           int64_t pos, int size)
{
393
    bdrv_save_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
394
395
396
    return size;
}

397
static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
398
{
399
    return bdrv_load_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
400
401
402
403
}

static int bdrv_fclose(void *opaque)
{
404
    return bdrv_flush(opaque);
aliguori's avatar
aliguori committed
405
406
}

407
static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
aliguori's avatar
aliguori committed
408
409
{
    if (is_writable)
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
410
411
412
        return qemu_fopen_ops(bs, block_put_buffer, NULL, bdrv_fclose, 
			      NULL, NULL, NULL);
    return qemu_fopen_ops(bs, NULL, block_get_buffer, bdrv_fclose, NULL, NULL, NULL);
aliguori's avatar
aliguori committed
413
414
415
416
417
}

QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
                         QEMUFileGetBufferFunc *get_buffer,
                         QEMUFileCloseFunc *close,
418
                         QEMUFileRateLimit *rate_limit,
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
419
420
                         QEMUFileSetRateLimit *set_rate_limit,
                         QEMUFileGetRateLimit *get_rate_limit)
aliguori's avatar
aliguori committed
421
422
423
{
    QEMUFile *f;

424
    f = g_malloc0(sizeof(QEMUFile));
aliguori's avatar
aliguori committed
425
426
427
428
429
430

    f->opaque = opaque;
    f->put_buffer = put_buffer;
    f->get_buffer = get_buffer;
    f->close = close;
    f->rate_limit = rate_limit;
431
    f->set_rate_limit = set_rate_limit;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
432
    f->get_rate_limit = get_rate_limit;
aliguori's avatar
aliguori committed
433
434
435
436
437
    f->is_write = 0;

    return f;
}

438
int qemu_file_get_error(QEMUFile *f)
aliguori's avatar
aliguori committed
439
{
440
    return f->last_error;
aliguori's avatar
aliguori committed
441
442
}

443
void qemu_file_set_error(QEMUFile *f, int ret)
444
{
445
    f->last_error = ret;
446
447
}

448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
/** Sets last_error conditionally
 *
 * Sets last_error only if ret is negative _and_ no error
 * was set before.
 */
static void qemu_file_set_if_error(QEMUFile *f, int ret)
{
    if (ret < 0 && !f->last_error) {
        qemu_file_set_error(f, ret);
    }
}

/** Flushes QEMUFile buffer
 *
 */
463
static int qemu_fflush(QEMUFile *f)
aliguori's avatar
aliguori committed
464
{
465
466
    int ret = 0;

aliguori's avatar
aliguori committed
467
    if (!f->put_buffer)
468
        return 0;
aliguori's avatar
aliguori committed
469
470

    if (f->is_write && f->buf_index > 0) {
471
472
        ret = f->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
        if (ret >= 0) {
aliguori's avatar
aliguori committed
473
            f->buf_offset += f->buf_index;
474
        }
aliguori's avatar
aliguori committed
475
476
        f->buf_index = 0;
    }
477
    return ret;
aliguori's avatar
aliguori committed
478
479
480
481
482
}

static void qemu_fill_buffer(QEMUFile *f)
{
    int len;
483
    int pending;
aliguori's avatar
aliguori committed
484
485
486
487
488
489
490

    if (!f->get_buffer)
        return;

    if (f->is_write)
        abort();

491
492
493
494
495
496
497
498
499
    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;

    len = f->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
                        IO_BUF_SIZE - pending);
aliguori's avatar
aliguori committed
500
    if (len > 0) {
501
        f->buf_size += len;
aliguori's avatar
aliguori committed
502
        f->buf_offset += len;
503
504
    } else if (len == 0) {
        f->last_error = -EIO;
aliguori's avatar
aliguori committed
505
    } else if (len != -EAGAIN)
506
        qemu_file_set_error(f, len);
aliguori's avatar
aliguori committed
507
508
}

509
510
511
512
513
514
515
516
517
518
/** 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)
{
519
    int ret;
520
521
    ret = qemu_fflush(f);

522
523
524
525
526
    if (f->close) {
        int ret2 = f->close(f->opaque);
        if (ret >= 0) {
            ret = ret2;
        }
527
    }
528
529
530
531
532
533
    /* 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;
    }
534
    g_free(f);
aliguori's avatar
aliguori committed
535
536
537
538
539
540
541
542
543
544
545
546
    return ret;
}

void qemu_file_put_notify(QEMUFile *f)
{
    f->put_buffer(f->opaque, NULL, 0, 0);
}

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

547
    if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
548
549
550
551
552
        fprintf(stderr,
                "Attempted to write to buffer while read buffer is not empty\n");
        abort();
    }

553
    while (!f->last_error && size > 0) {
aliguori's avatar
aliguori committed
554
555
556
557
558
559
560
561
        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;
562
563
564
565
        if (f->buf_index >= IO_BUF_SIZE) {
            int ret = qemu_fflush(f);
            qemu_file_set_if_error(f, ret);
        }
aliguori's avatar
aliguori committed
566
567
568
569
570
    }
}

void qemu_put_byte(QEMUFile *f, int v)
{
571
    if (!f->last_error && f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
572
573
574
575
576
577
578
        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;
579
580
581
582
    if (f->buf_index >= IO_BUF_SIZE) {
        int ret = qemu_fflush(f);
        qemu_file_set_if_error(f, ret);
    }
aliguori's avatar
aliguori committed
583
584
}

585
static void qemu_file_skip(QEMUFile *f, int size)
aliguori's avatar
aliguori committed
586
{
587
588
589
590
591
592
    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
593
{
594
595
    int pending;
    int index;
aliguori's avatar
aliguori committed
596

597
    if (f->is_write) {
aliguori's avatar
aliguori committed
598
        abort();
599
    }
aliguori's avatar
aliguori committed
600

601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
    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
631
        }
632
633
634
635
        qemu_file_skip(f, res);
        buf += res;
        pending -= res;
        done += res;
aliguori's avatar
aliguori committed
636
    }
637
    return done;
aliguori's avatar
aliguori committed
638
639
}

640
static int qemu_peek_byte(QEMUFile *f, int offset)
Juan Quintela's avatar
Juan Quintela committed
641
{
642
643
    int index = f->buf_index + offset;

644
    if (f->is_write) {
Juan Quintela's avatar
Juan Quintela committed
645
        abort();
646
    }
Juan Quintela's avatar
Juan Quintela committed
647

648
    if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
649
        qemu_fill_buffer(f);
650
651
        index = f->buf_index + offset;
        if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
652
            return 0;
653
        }
Juan Quintela's avatar
Juan Quintela committed
654
    }
655
    return f->buf[index];
Juan Quintela's avatar
Juan Quintela committed
656
657
}

aliguori's avatar
aliguori committed
658
659
int qemu_get_byte(QEMUFile *f)
{
660
    int result;
aliguori's avatar
aliguori committed
661

662
663
    result = qemu_peek_byte(f, 0);
    qemu_file_skip(f, 1);
664
    return result;
aliguori's avatar
aliguori committed
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
}

int64_t qemu_ftell(QEMUFile *f)
{
    return f->buf_offset - f->buf_size + f->buf_index;
}

int qemu_file_rate_limit(QEMUFile *f)
{
    if (f->rate_limit)
        return f->rate_limit(f->opaque);

    return 0;
}

680
int64_t qemu_file_get_rate_limit(QEMUFile *f)
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
681
682
683
684
685
686
687
{
    if (f->get_rate_limit)
        return f->get_rate_limit(f->opaque);

    return 0;
}

688
int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
689
{
690
691
692
    /* any failed or completed migration keeps its state to allow probing of
     * migration data, but has no associated file anymore */
    if (f && f->set_rate_limit)
693
694
695
696
697
        return f->set_rate_limit(f->opaque, new_rate);

    return 0;
}

aliguori's avatar
aliguori committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
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;
}

744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767

/* 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
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
/* 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,
};

789
790
791
792
793
794
795
796
797
/* 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;
}

798
static void put_int8(QEMUFile *f, void *pv, size_t size)
799
{
800
    int8_t *v = pv;
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
    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;
}

819
static void put_int16(QEMUFile *f, void *pv, size_t size)
820
{
821
    int16_t *v = pv;
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
    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;
}

840
static void put_int32(QEMUFile *f, void *pv, size_t size)
841
{
842
    int32_t *v = pv;
843
844
845
846
847
848
849
850
851
    qemu_put_sbe32s(f, v);
}

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

852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
/* 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,
};

872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
/* 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,
};

892
893
894
895
896
897
898
899
900
/* 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;
}

901
static void put_int64(QEMUFile *f, void *pv, size_t size)
902
{
903
    int64_t *v = pv;
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
    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;
}

922
static void put_uint8(QEMUFile *f, void *pv, size_t size)
923
{
924
    uint8_t *v = pv;
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
    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;
}

943
static void put_uint16(QEMUFile *f, void *pv, size_t size)
944
{
945
    uint16_t *v = pv;
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
    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;
}

964
static void put_uint32(QEMUFile *f, void *pv, size_t size)
965
{
966
    uint32_t *v = pv;
967
968
969
970
971
972
973
974
975
    qemu_put_be32s(f, v);
}

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

976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
/* 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,
};

997
998
999
1000
1001
1002
1003
1004
1005
/* 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;
}

1006
static void put_uint64(QEMUFile *f, void *pv, size_t size)
1007
{
1008
    uint64_t *v = pv;
1009
1010
1011
1012
1013
1014
1015
1016
1017
    qemu_put_be64s(f, v);
}

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

1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
/* 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 = {
1033
    .name = "uint8 equal",
1034
1035
1036
1037
    .get  = get_uint8_equal,
    .put  = put_uint8,
};

1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
/* 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,
};

1058
1059
1060
1061
1062
1063
1064
1065
1066
/* timers  */

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

1067
static void put_timer(QEMUFile *f, void *pv, size_t size)
1068
{
1069
    QEMUTimer *v = pv;
1070
1071
1072
1073
1074
1075
1076
1077
1078
    qemu_put_timer(f, v);
}

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

1079
1080
1081
1082
1083
1084
1085
1086
1087
/* 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;
}

1088
static void put_buffer(QEMUFile *f, void *pv, size_t size)
1089
{
1090
    uint8_t *v = pv;
1091
1092
1093
1094
1095
1096
1097
1098
1099
    qemu_put_buffer(f, v, size);
}

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

1100
/* unused buffers: space that was used for some fields that are
1101
   not useful anymore */
1102
1103
1104

static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1105
1106
1107
1108
1109
1110
1111
1112
1113
    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;
1114
1115
1116
1117
}

static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1118
1119
1120
1121
1122
1123
1124
1125
    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);
    }
1126
1127
1128
1129
1130
1131
1132
1133
}

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

1134
1135
1136
1137
1138
typedef struct CompatEntry {
    char idstr[256];
    int instance_id;
} CompatEntry;

aliguori's avatar
aliguori committed
1139
typedef struct SaveStateEntry {
Blue Swirl's avatar
Blue Swirl committed
1140
    QTAILQ_ENTRY(SaveStateEntry) entry;
aliguori's avatar
aliguori committed
1141
1142
    char idstr[256];
    int instance_id;
Jan Kiszka's avatar
Jan Kiszka committed
1143
    int alias_id;
aliguori's avatar
aliguori committed
1144
1145
    int version_id;
    int section_id;
1146
    SaveVMHandlers *ops;
1147
    const VMStateDescription *vmsd;
aliguori's avatar
aliguori committed
1148
    void *opaque;
1149
    CompatEntry *compat;
1150
    int no_migrate;
1151
    int is_ram;
aliguori's avatar
aliguori committed
1152
1153
} SaveStateEntry;

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

Blue Swirl's avatar
Blue Swirl committed
1155
1156
static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
    QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1157
static int global_section_id;
aliguori's avatar
aliguori committed
1158

1159
1160
1161
1162
1163
static int calculate_new_instance_id(const char *idstr)
{
    SaveStateEntry *se;
    int instance_id = 0;

Blue Swirl's avatar
Blue Swirl committed
1164
    QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1165
1166
1167
1168
1169
1170
1171
1172
        if (strcmp(idstr, se->idstr) == 0
            && instance_id <= se->instance_id) {
            instance_id = se->instance_id + 1;
        }
    }
    return instance_id;
}

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
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
1190
1191
1192
1193
/* 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. */
1194
1195
int register_savevm_live(DeviceState *dev,
                         const char *idstr,
aliguori's avatar
aliguori committed
1196
1197
                         int instance_id,
                         int version_id,
1198
                         SaveVMHandlers *ops,
aliguori's avatar
aliguori committed
1199
1200
                         void *opaque)
{
1201
    SaveStateEntry *se;
aliguori's avatar
aliguori committed
1202

1203
    se = g_malloc0(sizeof(SaveStateEntry));
aliguori's avatar
aliguori committed
1204
1205
    se->version_id = version_id;
    se->section_id = global_section_id++;
1206
    se->ops = ops;
aliguori's avatar
aliguori committed
1207
    se->opaque = opaque;
1208
    se->vmsd = NULL;
1209
    se->no_migrate = 0;
1210
    /* if this is a live_savem then set is_ram */
1211
    if (ops->save_live_setup != NULL) {
1212
1213
        se->is_ram = 1;
    }
aliguori's avatar
aliguori committed
1214

1215
1216
    if (dev) {
        char *id = qdev_get_dev_path(dev);
1217
1218
1219
        if (id) {
            pstrcpy(se->idstr, sizeof(se->idstr), id);
            pstrcat(se->idstr, sizeof(se->idstr), "/");
1220
            g_free(id);
1221

1222
            se->compat = g_malloc0(sizeof(CompatEntry));
1223
1224
1225
1226
1227
1228
1229
1230
            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);

1231
    if (instance_id == -1) {
1232
        se->instance_id = calculate_new_instance_id(se->idstr);
1233
1234
    } else {
        se->instance_id = instance_id;
aliguori's avatar
aliguori committed
1235
    }
1236
    assert(!se->compat || se->instance_id == 0);
1237
    /* add at the end of list */
Blue Swirl's avatar
Blue Swirl committed
1238
    QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
aliguori's avatar
aliguori committed
1239
1240
1241
    return 0;
}

1242
1243
int register_savevm(DeviceState *dev,
                    const char *idstr,
aliguori's avatar
aliguori committed
1244
1245
1246
1247
1248
1249
                    int instance_id,
                    int version_id,
                    SaveStateHandler *save_state,
                    LoadStateHandler *load_state,
                    void *opaque)
{
1250
1251
1252
    SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
    ops->save_state = save_state;
    ops->load_state = load_state;
1253
    return register_savevm_live(dev, idstr, instance_id, version_id,
1254
                                ops, opaque);
aliguori's avatar
aliguori committed
1255
1256
}

1257
void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)
1258
{
1259
    SaveStateEntry *se, *new_se;
1260
1261
    char id[256] = "";

1262
1263
    if (dev) {
        char *path = qdev_get_dev_path(dev);
1264
1265
1266
        if (path) {
            pstrcpy(id, sizeof(id), path);
            pstrcat(id, sizeof(id), "/");
1267
            g_free(path);
1268
1269
1270
        }
    }
    pstrcat(id, sizeof(id), idstr);
1271

Blue Swirl's avatar
Blue Swirl committed
1272
    QTAILQ_FOREACH_SAFE(se, &savevm_handlers, entry, new_se) {
1273
        if (strcmp(se->idstr, id) == 0 && se->opaque == opaque) {
Blue Swirl's avatar
Blue Swirl committed
1274
            QTAILQ_REMOVE(&savevm_handlers, se, entry);
1275
            if (se->compat) {
1276
                g_free(se->compat);
1277
            }
1278
            g_free(se->ops);
1279
            g_free(se);
1280
1281
1282
1283
        }
    }
}

1284
int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
Jan Kiszka's avatar
Jan Kiszka committed
1285
1286
1287
                                   const VMStateDescription *vmsd,
                                   void *opaque, int alias_id,
                                   int required_for_version)
1288
{
1289
    SaveStateEntry *se;
1290

Jan Kiszka's avatar
Jan Kiszka committed
1291
1292
1293
    /* If this triggers, alias support can be dropped for the vmsd. */
    assert(alias_id == -1 || required_for_version >= vmsd->minimum_version_id);

1294
    se = g_malloc0(sizeof(SaveStateEntry));
1295
1296
1297
1298
    se->version_id = vmsd->version_id;
    se->section_id = global_section_id++;
    se->opaque = opaque;
    se->vmsd = vmsd;
Jan Kiszka's avatar
Jan Kiszka committed
1299
    se->alias_id = alias_id;
1300
    se->no_migrate = vmsd->unmigratable;
1301

1302
1303
    if (dev) {
        char *id = qdev_get_dev_path(dev);
1304
1305
1306
        if (id) {
            pstrcpy(se->idstr, sizeof(se->idstr), id);
            pstrcat(se->idstr, sizeof(se->idstr), "/");