savevm.c 62.8 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
/*
 * 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.
 */

blueswir1's avatar
blueswir1 committed
25
26
#include "config-host.h"

aliguori's avatar
aliguori committed
27
28
29
30
31
#ifndef _WIN32
#include <arpa/inet.h>
#endif

#ifdef _WIN32
32
#include <windows.h>
aliguori's avatar
aliguori committed
33
34
#endif

35
36
#include "qemu-common.h"
#include "hw/hw.h"
37
#include "hw/qdev.h"
Paolo Bonzini's avatar
Paolo Bonzini committed
38
#include "net/net.h"
39
#include "monitor/monitor.h"
40
#include "sysemu/sysemu.h"
41
#include "qemu/timer.h"
42
#include "audio/audio.h"
43
#include "migration/migration.h"
44
45
#include "qemu/sockets.h"
#include "qemu/queue.h"
46
#include "sysemu/cpus.h"
47
#include "exec/memory.h"
48
#include "qmp-commands.h"
49
#include "trace.h"
50
#include "qemu/bitops.h"
51

aliguori's avatar
aliguori committed
52
53
#define SELF_ANNOUNCE_ROUNDS 5

Nolan's avatar
Nolan committed
54
#ifndef ETH_P_RARP
Stefan Berger's avatar
Stefan Berger committed
55
#define ETH_P_RARP 0x8035
Nolan's avatar
Nolan committed
56
57
58
59
60
61
#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
62
63
				uint8_t *mac_addr)
{
Nolan's avatar
Nolan committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    /* 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
84
85
}

86
static void qemu_announce_self_iter(NICState *nic, void *opaque)
aliguori's avatar
aliguori committed
87
{
Nolan's avatar
Nolan committed
88
    uint8_t buf[60];
89
90
91
92
93
94
95
96
97
98
    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)
{
99
100
    static int count = SELF_ANNOUNCE_ROUNDS;
    QEMUTimer *timer = *(QEMUTimer **)opaque;
aliguori's avatar
aliguori committed
101

102
103
    qemu_foreach_nic(qemu_announce_self_iter, NULL);

Nolan's avatar
Nolan committed
104
105
    if (--count) {
        /* delay 50ms, 150ms, 250ms, ... */
106
        qemu_mod_timer(timer, qemu_get_clock_ms(rt_clock) +
Nolan's avatar
Nolan committed
107
                       50 + (SELF_ANNOUNCE_ROUNDS - count - 1) * 100);
108
109
110
111
112
113
114
115
116
    } else {
	    qemu_del_timer(timer);
	    qemu_free_timer(timer);
    }
}

void qemu_announce_self(void)
{
	static QEMUTimer *timer;
117
	timer = qemu_new_timer_ms(rt_clock, qemu_announce_self_once, &timer);
118
	qemu_announce_self_once(&timer);
aliguori's avatar
aliguori committed
119
120
121
122
123
124
125
126
}

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

#define IO_BUF_SIZE 32768

struct QEMUFile {
127
    const QEMUFileOps *ops;
aliguori's avatar
aliguori committed
128
129
130
131
132
133
134
135
136
    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];

137
    int last_error;
aliguori's avatar
aliguori committed
138
139
};

140
typedef struct QEMUFileStdio
aliguori's avatar
aliguori committed
141
{
142
    FILE *stdio_file;
aliguori's avatar
aliguori committed
143
    QEMUFile *file;
144
} QEMUFileStdio;
aliguori's avatar
aliguori committed
145
146
147
148
149
150
151

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

Paolo Bonzini's avatar
Paolo Bonzini committed
152
153
154
155
156
157
158
static int socket_get_fd(void *opaque)
{
    QEMUFileSocket *s = opaque;

    return s->fd;
}

aliguori's avatar
aliguori committed
159
160
161
162
163
static int socket_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
{
    QEMUFileSocket *s = opaque;
    ssize_t len;

164
    for (;;) {
Blue Swirl's avatar
Blue Swirl committed
165
        len = qemu_recv(s->fd, buf, size, 0);
166
167
168
169
170
171
172
173
174
175
        if (len != -1) {
            break;
        }
        if (socket_error() == EAGAIN) {
            assert(qemu_in_coroutine());
            qemu_coroutine_yield();
        } else if (socket_error() != EINTR) {
            break;
        }
    }
aliguori's avatar
aliguori committed
176

177
    if (len == -1) {
aliguori's avatar
aliguori committed
178
        len = -socket_error();
179
    }
aliguori's avatar
aliguori committed
180
181
182
183
184
185
    return len;
}

static int socket_close(void *opaque)
{
    QEMUFileSocket *s = opaque;
186
    closesocket(s->fd);
187
    g_free(s);
aliguori's avatar
aliguori committed
188
189
190
    return 0;
}

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

    return fileno(s->stdio_file);
}

198
static int stdio_put_buffer(void *opaque, const uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
199
{
200
201
    QEMUFileStdio *s = opaque;
    return fwrite(buf, 1, size, s->stdio_file);
aliguori's avatar
aliguori committed
202
203
}

204
static int stdio_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
205
{
206
207
    QEMUFileStdio *s = opaque;
    FILE *fp = s->stdio_file;
208
209
    int bytes;

210
    for (;;) {
211
212
        clearerr(fp);
        bytes = fread(buf, 1, size, fp);
213
214
215
216
217
218
219
220
221
222
        if (bytes != 0 || !ferror(fp)) {
            break;
        }
        if (errno == EAGAIN) {
            assert(qemu_in_coroutine());
            qemu_coroutine_yield();
        } else if (errno != EINTR) {
            break;
        }
    }
223
    return bytes;
aliguori's avatar
aliguori committed
224
225
}

226
227
228
static int stdio_pclose(void *opaque)
{
    QEMUFileStdio *s = opaque;
229
230
    int ret;
    ret = pclose(s->stdio_file);
231
232
233
    if (ret == -1) {
        ret = -errno;
    }
234
    g_free(s);
235
    return ret;
236
237
238
}

static int stdio_fclose(void *opaque)
aliguori's avatar
aliguori committed
239
{
240
    QEMUFileStdio *s = opaque;
241
242
243
244
    int ret = 0;
    if (fclose(s->stdio_file) == EOF) {
        ret = -errno;
    }
245
    g_free(s);
246
    return ret;
aliguori's avatar
aliguori committed
247
248
}

249
static const QEMUFileOps stdio_pipe_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
250
    .get_fd =     stdio_get_fd,
251
252
253
254
255
    .get_buffer = stdio_get_buffer,
    .close =      stdio_pclose
};

static const QEMUFileOps stdio_pipe_write_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
256
    .get_fd =     stdio_get_fd,
257
258
259
260
    .put_buffer = stdio_put_buffer,
    .close =      stdio_pclose
};

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

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

270
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
271

272
    s->stdio_file = stdio_file;
aliguori's avatar
aliguori committed
273
274

    if(mode[0] == 'r') {
275
        s->file = qemu_fopen_ops(s, &stdio_pipe_read_ops);
aliguori's avatar
aliguori committed
276
    } else {
277
        s->file = qemu_fopen_ops(s, &stdio_pipe_write_ops);
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
static const QEMUFileOps stdio_file_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
295
    .get_fd =     stdio_get_fd,
296
297
298
299
300
    .get_buffer = stdio_get_buffer,
    .close =      stdio_fclose
};

static const QEMUFileOps stdio_file_write_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
301
    .get_fd =     stdio_get_fd,
302
303
304
305
    .put_buffer = stdio_put_buffer,
    .close =      stdio_fclose
};

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

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

    if(mode[0] == 'r') {
323
        s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
Paolo Bonzini's avatar
Paolo Bonzini committed
324
    } else {
325
        s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
Paolo Bonzini's avatar
Paolo Bonzini committed
326
327
328
329
    }
    return s->file;

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

334
static const QEMUFileOps socket_read_ops = {
Paolo Bonzini's avatar
Paolo Bonzini committed
335
    .get_fd =     socket_get_fd,
336
337
338
339
    .get_buffer = socket_get_buffer,
    .close =      socket_close
};

aliguori's avatar
aliguori committed
340
341
QEMUFile *qemu_fopen_socket(int fd)
{
342
    QEMUFileSocket *s = g_malloc0(sizeof(QEMUFileSocket));
aliguori's avatar
aliguori committed
343
344

    s->fd = fd;
345
    s->file = qemu_fopen_ops(s, &socket_read_ops);
aliguori's avatar
aliguori committed
346
347
348
349
350
351
352
    return s->file;
}

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

353
354
355
    if (mode == NULL ||
	(mode[0] != 'r' && mode[0] != 'w') ||
	mode[1] != 'b' || mode[2] != 0) {
Blue Swirl's avatar
Blue Swirl committed
356
        fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
357
358
359
        return NULL;
    }

360
    s = g_malloc0(sizeof(QEMUFileStdio));
aliguori's avatar
aliguori committed
361

362
363
    s->stdio_file = fopen(filename, mode);
    if (!s->stdio_file)
aliguori's avatar
aliguori committed
364
        goto fail;
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
365
    
366
    if(mode[0] == 'w') {
367
        s->file = qemu_fopen_ops(s, &stdio_file_write_ops);
368
    } else {
369
        s->file = qemu_fopen_ops(s, &stdio_file_read_ops);
370
371
    }
    return s->file;
aliguori's avatar
aliguori committed
372
fail:
373
    g_free(s);
aliguori's avatar
aliguori committed
374
375
376
    return NULL;
}

377
static int block_put_buffer(void *opaque, const uint8_t *buf,
aliguori's avatar
aliguori committed
378
379
                           int64_t pos, int size)
{
380
    bdrv_save_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
381
382
383
    return size;
}

384
static int block_get_buffer(void *opaque, uint8_t *buf, int64_t pos, int size)
aliguori's avatar
aliguori committed
385
{
386
    return bdrv_load_vmstate(opaque, buf, pos, size);
aliguori's avatar
aliguori committed
387
388
389
390
}

static int bdrv_fclose(void *opaque)
{
391
    return bdrv_flush(opaque);
aliguori's avatar
aliguori committed
392
393
}

394
395
396
397
398
399
400
401
402
403
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
};

404
static QEMUFile *qemu_fopen_bdrv(BlockDriverState *bs, int is_writable)
aliguori's avatar
aliguori committed
405
406
{
    if (is_writable)
407
408
        return qemu_fopen_ops(bs, &bdrv_write_ops);
    return qemu_fopen_ops(bs, &bdrv_read_ops);
aliguori's avatar
aliguori committed
409
410
}

411
QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops)
aliguori's avatar
aliguori committed
412
413
414
{
    QEMUFile *f;

415
    f = g_malloc0(sizeof(QEMUFile));
aliguori's avatar
aliguori committed
416
417

    f->opaque = opaque;
418
    f->ops = ops;
aliguori's avatar
aliguori committed
419
420
421
422
423
    f->is_write = 0;

    return f;
}

424
int qemu_file_get_error(QEMUFile *f)
aliguori's avatar
aliguori committed
425
{
426
    return f->last_error;
aliguori's avatar
aliguori committed
427
428
}

429
static void qemu_file_set_error(QEMUFile *f, int ret)
430
{
431
    f->last_error = ret;
432
433
}

434
435
436
/** Flushes QEMUFile buffer
 *
 */
437
static int qemu_fflush(QEMUFile *f)
aliguori's avatar
aliguori committed
438
{
439
440
    int ret = 0;

441
    if (!f->ops->put_buffer)
442
        return 0;
aliguori's avatar
aliguori committed
443
444

    if (f->is_write && f->buf_index > 0) {
445
        ret = f->ops->put_buffer(f->opaque, f->buf, f->buf_offset, f->buf_index);
446
        if (ret >= 0) {
aliguori's avatar
aliguori committed
447
            f->buf_offset += f->buf_index;
448
        }
aliguori's avatar
aliguori committed
449
450
        f->buf_index = 0;
    }
451
    return ret;
aliguori's avatar
aliguori committed
452
453
454
455
456
}

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

459
    if (!f->ops->get_buffer)
aliguori's avatar
aliguori committed
460
461
462
463
464
        return;

    if (f->is_write)
        abort();

465
466
467
468
469
470
471
    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;

472
    len = f->ops->get_buffer(f->opaque, f->buf + pending, f->buf_offset,
473
                        IO_BUF_SIZE - pending);
aliguori's avatar
aliguori committed
474
    if (len > 0) {
475
        f->buf_size += len;
aliguori's avatar
aliguori committed
476
        f->buf_offset += len;
477
    } else if (len == 0) {
478
        qemu_file_set_error(f, -EIO);
aliguori's avatar
aliguori committed
479
    } else if (len != -EAGAIN)
480
        qemu_file_set_error(f, len);
aliguori's avatar
aliguori committed
481
482
}

Paolo Bonzini's avatar
Paolo Bonzini committed
483
484
485
486
487
488
489
490
int qemu_get_fd(QEMUFile *f)
{
    if (f->ops->get_fd) {
        return f->ops->get_fd(f->opaque);
    }
    return -1;
}

491
492
493
494
495
496
497
498
499
500
/** 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)
{
501
    int ret;
502
503
    ret = qemu_fflush(f);

504
505
    if (f->ops->close) {
        int ret2 = f->ops->close(f->opaque);
506
507
508
        if (ret >= 0) {
            ret = ret2;
        }
509
    }
510
511
512
513
514
515
    /* 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;
    }
516
    g_free(f);
aliguori's avatar
aliguori committed
517
518
519
520
521
522
523
    return ret;
}

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

524
525
526
527
528
    if (f->last_error) {
        return;
    }

    if (f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
529
530
531
532
533
        fprintf(stderr,
                "Attempted to write to buffer while read buffer is not empty\n");
        abort();
    }

534
    while (size > 0) {
aliguori's avatar
aliguori committed
535
536
537
538
539
540
541
542
        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;
543
544
        if (f->buf_index >= IO_BUF_SIZE) {
            int ret = qemu_fflush(f);
545
546
547
548
            if (ret < 0) {
                qemu_file_set_error(f, ret);
                break;
            }
549
        }
aliguori's avatar
aliguori committed
550
551
552
553
554
    }
}

void qemu_put_byte(QEMUFile *f, int v)
{
555
556
557
558
559
    if (f->last_error) {
        return;
    }

    if (f->is_write == 0 && f->buf_index > 0) {
aliguori's avatar
aliguori committed
560
561
562
563
564
565
566
        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;
567
568
    if (f->buf_index >= IO_BUF_SIZE) {
        int ret = qemu_fflush(f);
569
570
571
        if (ret < 0) {
            qemu_file_set_error(f, ret);
        }
572
    }
aliguori's avatar
aliguori committed
573
574
}

575
static void qemu_file_skip(QEMUFile *f, int size)
aliguori's avatar
aliguori committed
576
{
577
578
579
580
581
582
    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
583
{
584
585
    int pending;
    int index;
aliguori's avatar
aliguori committed
586

587
    if (f->is_write) {
aliguori's avatar
aliguori committed
588
        abort();
589
    }
aliguori's avatar
aliguori committed
590

591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
    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
621
        }
622
623
624
625
        qemu_file_skip(f, res);
        buf += res;
        pending -= res;
        done += res;
aliguori's avatar
aliguori committed
626
    }
627
    return done;
aliguori's avatar
aliguori committed
628
629
}

630
static int qemu_peek_byte(QEMUFile *f, int offset)
Juan Quintela's avatar
Juan Quintela committed
631
{
632
633
    int index = f->buf_index + offset;

634
    if (f->is_write) {
Juan Quintela's avatar
Juan Quintela committed
635
        abort();
636
    }
Juan Quintela's avatar
Juan Quintela committed
637

638
    if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
639
        qemu_fill_buffer(f);
640
641
        index = f->buf_index + offset;
        if (index >= f->buf_size) {
Juan Quintela's avatar
Juan Quintela committed
642
            return 0;
643
        }
Juan Quintela's avatar
Juan Quintela committed
644
    }
645
    return f->buf[index];
Juan Quintela's avatar
Juan Quintela committed
646
647
}

aliguori's avatar
aliguori committed
648
649
int qemu_get_byte(QEMUFile *f)
{
650
    int result;
aliguori's avatar
aliguori committed
651

652
653
    result = qemu_peek_byte(f, 0);
    qemu_file_skip(f, 1);
654
    return result;
aliguori's avatar
aliguori committed
655
656
}

Juan Quintela's avatar
Juan Quintela committed
657
static int64_t qemu_ftell(QEMUFile *f)
aliguori's avatar
aliguori committed
658
659
660
661
662
663
{
    return f->buf_offset - f->buf_size + f->buf_index;
}

int qemu_file_rate_limit(QEMUFile *f)
{
664
665
    if (f->ops->rate_limit)
        return f->ops->rate_limit(f->opaque);
aliguori's avatar
aliguori committed
666
667
668
669

    return 0;
}

670
int64_t qemu_file_get_rate_limit(QEMUFile *f)
lirans@il.ibm.com's avatar
lirans@il.ibm.com committed
671
{
672
673
    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
674
675
676
677

    return 0;
}

678
int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate)
679
{
680
681
    /* any failed or completed migration keeps its state to allow probing of
     * migration data, but has no associated file anymore */
682
683
    if (f && f->ops->set_rate_limit)
        return f->ops->set_rate_limit(f->opaque, new_rate);
684
685
686
687

    return 0;
}

aliguori's avatar
aliguori committed
688
689
690
691
692
693
694
695
696
697
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
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;
}

734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757

/* 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
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
/* 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,
};

779
780
781
782
783
784
785
786
787
/* 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;
}

788
static void put_int8(QEMUFile *f, void *pv, size_t size)
789
{
790
    int8_t *v = pv;
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
    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;
}

809
static void put_int16(QEMUFile *f, void *pv, size_t size)
810
{
811
    int16_t *v = pv;
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
    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;
}

830
static void put_int32(QEMUFile *f, void *pv, size_t size)
831
{
832
    int32_t *v = pv;
833
834
835
836
837
838
839
840
841
    qemu_put_sbe32s(f, v);
}

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

842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
/* 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,
};

862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
/* 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,
};

882
883
884
885
886
887
888
889
890
/* 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;
}

891
static void put_int64(QEMUFile *f, void *pv, size_t size)
892
{
893
    int64_t *v = pv;
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
    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;
}

912
static void put_uint8(QEMUFile *f, void *pv, size_t size)
913
{
914
    uint8_t *v = pv;
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
    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;
}

933
static void put_uint16(QEMUFile *f, void *pv, size_t size)
934
{
935
    uint16_t *v = pv;
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
    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;
}

954
static void put_uint32(QEMUFile *f, void *pv, size_t size)
955
{
956
    uint32_t *v = pv;
957
958
959
960
961
962
963
964
965
    qemu_put_be32s(f, v);
}

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

966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
/* 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,
};

987
988
989
990
991
992
993
994
995
/* 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;
}

996
static void put_uint64(QEMUFile *f, void *pv, size_t size)
997
{
998
    uint64_t *v = pv;
999
1000
1001
1002
1003
1004
1005
1006
1007
    qemu_put_be64s(f, v);
}

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

1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
/* 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 = {
1023
    .name = "uint8 equal",
1024
1025
1026
1027
    .get  = get_uint8_equal,
    .put  = put_uint8,
};

1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
/* 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,
};

1048
1049
1050
1051
1052
1053
1054
1055
1056
/* timers  */

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

1057
static void put_timer(QEMUFile *f, void *pv, size_t size)
1058
{
1059
    QEMUTimer *v = pv;
1060
1061
1062
1063
1064
1065
1066
1067
1068
    qemu_put_timer(f, v);
}

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

1069
1070
1071
1072
1073
1074
1075
1076
1077
/* 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;
}

1078
static void put_buffer(QEMUFile *f, void *pv, size_t size)
1079
{
1080
    uint8_t *v = pv;
1081
1082
1083
1084
1085
1086
1087
1088
1089
    qemu_put_buffer(f, v, size);
}

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

1090
/* unused buffers: space that was used for some fields that are
1091
   not useful anymore */
1092
1093
1094

static int get_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1095
1096
1097
1098
1099
1100
1101
1102
1103
    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;
1104
1105
1106
1107
}

static void put_unused_buffer(QEMUFile *f, void *pv, size_t size)
{
Jan Kiszka's avatar
Jan Kiszka committed
1108
1109
1110
1111
1112
1113
1114
1115
    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);
    }
1116
1117
1118
1119
1120
1121
1122
1123
}

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

1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
/* 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,
};

1164
1165
1166
1167
1168
typedef struct CompatEntry {
    char idstr[256];
    int instance_id;
} CompatEntry;

aliguori's avatar
aliguori committed
1169
typedef struct SaveStateEntry {
Blue Swirl's avatar
Blue Swirl committed
1170
    QTAILQ_ENTRY(SaveStateEntry) entry;
aliguori's avatar
aliguori committed
1171
1172
    char idstr[256];
    int instance_id;
Jan Kiszka's avatar
Jan Kiszka committed
1173
    int alias_id;
aliguori's avatar
aliguori committed
1174
1175
    int version_id;
    int section_id;
1176
    SaveVMHandlers *ops;
1177
    const VMStateDescription *vmsd;
aliguori's avatar
aliguori committed
1178
    void *opaque;
1179
    CompatEntry *compat;
1180
    int no_migrate;
1181
    int is_ram;
aliguori's avatar
aliguori committed
1182
1183
} SaveStateEntry;

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

Blue Swirl's avatar
Blue Swirl committed
1185
1186
static QTAILQ_HEAD(savevm_handlers, SaveStateEntry) savevm_handlers =
    QTAILQ_HEAD_INITIALIZER(savevm_handlers);
1187
static int global_section_id;
aliguori's avatar
aliguori committed
1188

1189
1190
1191
1192
1193
static int calculate_new_instance_id(const char *idstr)
{
    SaveStateEntry *se;
    int instance_id = 0;

Blue Swirl's avatar
Blue Swirl committed
1194
    QTAILQ_FOREACH(se, &savevm_handlers, entry) {
1195
1196
1197
1198
1199
1200
1201
1202
        if (strcmp(idstr, se->idstr) == 0
            && instance_id <= se->instance_id) {
            instance_id = se->instance_id + 1;
        }
    }
    return instance_id;
}

1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
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
1220
1221
1222
1223
/* 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. */
1224
1225
int register_savevm_live(DeviceState *dev,
                         const char *idstr,
aliguori's avatar
aliguori committed
1226
1227
                         int instance_id,
                         int version_id,
1228
                         SaveVMHandlers *ops,
aliguori's avatar
aliguori committed
1229
1230
                         void *opaque)
{
1231
    SaveStateEntry *se;
aliguori's avatar
aliguori committed
1232

1233
    se = g_malloc0(sizeof(SaveStateEntry));
aliguori's avatar
aliguori committed
1234
1235
    se->version_id = version_id;
    se->section_id = global_section_id++;
1236
    se->ops = ops;
aliguori's avatar
aliguori committed
1237
    se->opaque = opaque;
1238
    se->vmsd = NULL;
1239
    se->no_migrate = 0;
1240
    /* if this is a live_savem then set is_ram */
1241
    if (ops->save_live_setup != NULL) {
1242
1243
        se->is_ram = 1;
    }
aliguori's avatar
aliguori committed
1244

1245
1246
    if (dev) {
        char *id = qdev_get_dev_path(dev);
1247
1248
1249
        if (id) {
            pstrcpy(se->idstr, sizeof(se->idstr), id);
            pstrcat(se->idstr, sizeof(se->idstr), "/");
1250
            g_free(id);
1251

1252
            se->compat = g_malloc0(sizeof(CompatEntry));
1253
1254
1255
1256
1257
1258
1259
1260
            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);

1261
    if (instance_id == -1) {
1262
        se->instance_id = calculate_new_instance_id(se->idstr);
1263
1264
    } else {
        se->instance_id = instance_id;
aliguori's avatar
aliguori committed
1265
    }
1266
    assert(!se->compat || se->instance_id == 0);
1267
    /* add at the end of list */
Blue Swirl's avatar
Blue Swirl committed
1268
    QTAILQ_INSERT_TAIL(&savevm_handlers, se, entry);
aliguori's avatar
aliguori committed
1269
1270
1271
    return 0;
}

1272
1273
int register_savevm(DeviceState *dev,
                    const char *idstr,
aliguori's avatar
aliguori committed
1274
1275
1276
1277
1278
1279
                    int instance_id,
                    int version_id,
                    SaveStateHandler *save_state,
                    LoadStateHandler *load_state,
                    void *opaque)
{
1280
1281
1282
    SaveVMHandlers *ops = g_malloc0(sizeof(SaveVMHandlers));
    ops->save_state = save_state;
    ops->load_state = load_state;
1283
    return register_savevm_live(dev, idstr, instance_id, version_id,
1284
                                ops, opaque);
aliguori's avatar
aliguori committed
1285
1286
}

1287
void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque)