1 From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
2 From: Dietmar Maurer <dietmar@proxmox.com>
3 Date: Mon, 6 Apr 2020 12:16:57 +0200
4 Subject: [PATCH] PVE-Backup: add vma backup format code
6 Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
7 [FE: create: register all streams before entering coroutines]
8 Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
10 block/meson.build | 2 +
12 vma-reader.c | 857 ++++++++++++++++++++++++++++++++++++++++++++++
13 vma-writer.c | 790 ++++++++++++++++++++++++++++++++++++++++++
14 vma.c | 851 +++++++++++++++++++++++++++++++++++++++++++++
16 6 files changed, 2655 insertions(+)
17 create mode 100644 vma-reader.c
18 create mode 100644 vma-writer.c
19 create mode 100644 vma.c
20 create mode 100644 vma.h
22 diff --git a/block/meson.build b/block/meson.build
23 index c9d1fdca7d..72081a9974 100644
24 --- a/block/meson.build
25 +++ b/block/meson.build
26 @@ -44,6 +44,8 @@ block_ss.add(files(
28 ), zstd, zlib, gnutls)
30 +block_ss.add(files('../vma-writer.c'), libuuid)
32 softmmu_ss.add(when: 'CONFIG_TCG', if_true: files('blkreplay.c'))
34 block_ss.add(when: 'CONFIG_QCOW1', if_true: files('qcow.c'))
35 diff --git a/meson.build b/meson.build
36 index 96de1a6ef9..54c23b9567 100644
39 @@ -1202,6 +1202,8 @@ keyutils = dependency('libkeyutils', required: false,
41 has_gettid = cc.has_function('gettid')
43 +libuuid = cc.find_library('uuid', required: true)
46 selinux = dependency('libselinux',
47 required: get_option('selinux'),
48 @@ -3070,6 +3072,9 @@ if have_tools
49 dependencies: [blockdev, qemuutil, gnutls, selinux],
52 + vma = executable('vma', files('vma.c', 'vma-reader.c') + genh,
53 + dependencies: [authz, block, crypto, io, qom], install: true)
55 subdir('storage-daemon')
56 subdir('contrib/rdmacm-mux')
57 subdir('contrib/elf2dmp')
58 diff --git a/vma-reader.c b/vma-reader.c
60 index 0000000000..2b1d1cdab3
65 + * VMA: Virtual Machine Archive
67 + * Copyright (C) 2012 Proxmox Server Solutions
70 + * Dietmar Maurer (dietmar@proxmox.com)
72 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
73 + * See the COPYING file in the top-level directory.
77 +#include "qemu/osdep.h"
79 +#include <uuid/uuid.h>
81 +#include "qemu-common.h"
82 +#include "qemu/timer.h"
83 +#include "qemu/ratelimit.h"
85 +#include "block/block.h"
86 +#include "sysemu/block-backend.h"
88 +static unsigned char zero_vma_block[VMA_BLOCK_SIZE];
90 +typedef struct VmaRestoreState {
91 + BlockBackend *target;
93 + unsigned long *bitmap;
100 + GHashTable *blob_hash;
101 + unsigned char *head_data;
102 + VmaDeviceInfo devinfo[256];
103 + VmaRestoreState rstate[256];
105 + guint8 vmstate_stream;
106 + uint32_t vmstate_clusters;
107 + /* to show restore percentage if run with -v */
109 + int64_t cluster_count;
110 + int64_t clusters_read;
111 + int64_t zero_cluster_data;
112 + int64_t partial_zero_cluster_data;
113 + int clusters_read_per;
117 +g_int32_hash(gconstpointer v)
119 + return *(const uint32_t *)v;
123 +g_int32_equal(gconstpointer v1, gconstpointer v2)
125 + return *((const uint32_t *)v1) == *((const uint32_t *)v2);
128 +static int vma_reader_get_bitmap(VmaRestoreState *rstate, int64_t cluster_num)
131 + assert(rstate->bitmap);
133 + unsigned long val, idx, bit;
135 + idx = cluster_num / BITS_PER_LONG;
137 + assert(rstate->bitmap_size > idx);
139 + bit = cluster_num % BITS_PER_LONG;
140 + val = rstate->bitmap[idx];
142 + return !!(val & (1UL << bit));
145 +static void vma_reader_set_bitmap(VmaRestoreState *rstate, int64_t cluster_num,
149 + assert(rstate->bitmap);
151 + unsigned long val, idx, bit;
153 + idx = cluster_num / BITS_PER_LONG;
155 + assert(rstate->bitmap_size > idx);
157 + bit = cluster_num % BITS_PER_LONG;
158 + val = rstate->bitmap[idx];
160 + if (!(val & (1UL << bit))) {
164 + if (val & (1UL << bit)) {
165 + val &= ~(1UL << bit);
168 + rstate->bitmap[idx] = val;
171 +typedef struct VmaBlob {
177 +static const VmaBlob *get_header_blob(VmaReader *vmar, uint32_t pos)
180 + assert(vmar->blob_hash);
182 + return g_hash_table_lookup(vmar->blob_hash, &pos);
185 +static const char *get_header_str(VmaReader *vmar, uint32_t pos)
187 + const VmaBlob *blob = get_header_blob(vmar, pos);
191 + const char *res = (char *)blob->data;
192 + if (res[blob->len-1] != '\0') {
199 +safe_read(int fd, unsigned char *buf, size_t count)
204 + n = read(fd, buf, count);
205 + } while (n < 0 && errno == EINTR);
211 +full_read(int fd, unsigned char *buf, size_t len)
219 + n = safe_read(fd, buf, len);
241 +void vma_reader_destroy(VmaReader *vmar)
245 + if (vmar->fd >= 0) {
249 + if (vmar->cdata_list) {
250 + g_list_free(vmar->cdata_list);
254 + for (i = 1; i < 256; i++) {
255 + if (vmar->rstate[i].bitmap) {
256 + g_free(vmar->rstate[i].bitmap);
260 + if (vmar->md5csum) {
261 + g_checksum_free(vmar->md5csum);
264 + if (vmar->blob_hash) {
265 + g_hash_table_destroy(vmar->blob_hash);
268 + if (vmar->head_data) {
269 + g_free(vmar->head_data);
276 +static int vma_reader_read_head(VmaReader *vmar, Error **errp)
280 + assert(*errp == NULL);
282 + unsigned char md5sum[16];
286 + vmar->head_data = g_malloc(sizeof(VmaHeader));
288 + if (full_read(vmar->fd, vmar->head_data, sizeof(VmaHeader)) !=
289 + sizeof(VmaHeader)) {
290 + error_setg(errp, "can't read vma header - %s",
291 + errno ? g_strerror(errno) : "got EOF");
295 + VmaHeader *h = (VmaHeader *)vmar->head_data;
297 + if (h->magic != VMA_MAGIC) {
298 + error_setg(errp, "not a vma file - wrong magic number");
302 + uint32_t header_size = GUINT32_FROM_BE(h->header_size);
303 + int need = header_size - sizeof(VmaHeader);
305 + error_setg(errp, "wrong vma header size %d", header_size);
309 + vmar->head_data = g_realloc(vmar->head_data, header_size);
310 + h = (VmaHeader *)vmar->head_data;
312 + if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
314 + error_setg(errp, "can't read vma header data - %s",
315 + errno ? g_strerror(errno) : "got EOF");
319 + memcpy(md5sum, h->md5sum, 16);
320 + memset(h->md5sum, 0, 16);
322 + g_checksum_reset(vmar->md5csum);
323 + g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
325 + g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
327 + if (memcmp(md5sum, h->md5sum, 16) != 0) {
328 + error_setg(errp, "wrong vma header chechsum");
332 + /* we can modify header data after checksum verify */
333 + h->header_size = header_size;
335 + h->version = GUINT32_FROM_BE(h->version);
336 + if (h->version != 1) {
337 + error_setg(errp, "wrong vma version %d", h->version);
341 + h->ctime = GUINT64_FROM_BE(h->ctime);
342 + h->blob_buffer_offset = GUINT32_FROM_BE(h->blob_buffer_offset);
343 + h->blob_buffer_size = GUINT32_FROM_BE(h->blob_buffer_size);
345 + uint32_t bstart = h->blob_buffer_offset + 1;
346 + uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
348 + if (bstart <= sizeof(VmaHeader)) {
349 + error_setg(errp, "wrong vma blob buffer offset %d",
350 + h->blob_buffer_offset);
354 + if (bend > header_size) {
355 + error_setg(errp, "wrong vma blob buffer size %d/%d",
356 + h->blob_buffer_offset, h->blob_buffer_size);
360 + while ((bstart + 2) <= bend) {
361 + uint32_t size = vmar->head_data[bstart] +
362 + (vmar->head_data[bstart+1] << 8);
363 + if ((bstart + size + 2) <= bend) {
364 + VmaBlob *blob = g_new0(VmaBlob, 1);
365 + blob->start = bstart - h->blob_buffer_offset;
367 + blob->data = vmar->head_data + bstart + 2;
368 + g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
370 + bstart += size + 2;
375 + for (i = 1; i < 256; i++) {
376 + VmaDeviceInfoHeader *dih = &h->dev_info[i];
377 + uint32_t devname_ptr = GUINT32_FROM_BE(dih->devname_ptr);
378 + uint64_t size = GUINT64_FROM_BE(dih->size);
379 + const char *devname = get_header_str(vmar, devname_ptr);
381 + if (size && devname) {
383 + vmar->devinfo[i].size = size;
384 + vmar->devinfo[i].devname = devname;
386 + if (strcmp(devname, "vmstate") == 0) {
387 + vmar->vmstate_stream = i;
392 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
393 + uint32_t name_ptr = GUINT32_FROM_BE(h->config_names[i]);
394 + uint32_t data_ptr = GUINT32_FROM_BE(h->config_data[i]);
396 + if (!(name_ptr && data_ptr)) {
399 + const char *name = get_header_str(vmar, name_ptr);
400 + const VmaBlob *blob = get_header_blob(vmar, data_ptr);
402 + if (!(name && blob)) {
403 + error_setg(errp, "vma contains invalid data pointers");
407 + VmaConfigData *cdata = g_new0(VmaConfigData, 1);
408 + cdata->name = name;
409 + cdata->data = blob->data;
410 + cdata->len = blob->len;
412 + vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
418 +VmaReader *vma_reader_create(const char *filename, Error **errp)
423 + VmaReader *vmar = g_new0(VmaReader, 1);
425 + if (strcmp(filename, "-") == 0) {
428 + vmar->fd = open(filename, O_RDONLY);
431 + if (vmar->fd < 0) {
432 + error_setg(errp, "can't open file %s - %s\n", filename,
433 + g_strerror(errno));
437 + vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
438 + if (!vmar->md5csum) {
439 + error_setg(errp, "can't allocate cmsum\n");
443 + vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
446 + if (vma_reader_read_head(vmar, errp) < 0) {
454 + vma_reader_destroy(vmar);
460 +VmaHeader *vma_reader_get_header(VmaReader *vmar)
463 + assert(vmar->head_data);
465 + return (VmaHeader *)(vmar->head_data);
468 +GList *vma_reader_get_config_data(VmaReader *vmar)
471 + assert(vmar->head_data);
473 + return vmar->cdata_list;
476 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
481 + if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
482 + return &vmar->devinfo[dev_id];
488 +static void allocate_rstate(VmaReader *vmar, guint8 dev_id,
489 + BlockBackend *target, bool write_zeroes)
494 + vmar->rstate[dev_id].target = target;
495 + vmar->rstate[dev_id].write_zeroes = write_zeroes;
497 + int64_t size = vmar->devinfo[dev_id].size;
499 + int64_t bitmap_size = (size/BDRV_SECTOR_SIZE) +
500 + (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG - 1;
501 + bitmap_size /= (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG;
503 + vmar->rstate[dev_id].bitmap_size = bitmap_size;
504 + vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
506 + vmar->cluster_count += size/VMA_CLUSTER_SIZE;
509 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockBackend *target,
510 + bool write_zeroes, Error **errp)
513 + assert(target != NULL);
515 + assert(vmar->rstate[dev_id].target == NULL);
517 + int64_t size = blk_getlength(target);
518 + int64_t size_diff = size - vmar->devinfo[dev_id].size;
520 + /* storage types can have different size restrictions, so it
521 + * is not always possible to create an image with exact size.
522 + * So we tolerate a size difference up to 4MB.
524 + if ((size_diff < 0) || (size_diff > 4*1024*1024)) {
525 + error_setg(errp, "vma_reader_register_bs for stream %s failed - "
526 + "unexpected size %zd != %zd", vmar->devinfo[dev_id].devname,
527 + size, vmar->devinfo[dev_id].size);
531 + allocate_rstate(vmar, dev_id, target, write_zeroes);
536 +static ssize_t safe_write(int fd, void *buf, size_t count)
541 + n = write(fd, buf, count);
542 + } while (n < 0 && errno == EINTR);
547 +static size_t full_write(int fd, void *buf, size_t len)
555 + n = safe_write(fd, buf, len);
565 + /* incomplete write ? */
572 +static int restore_write_data(VmaReader *vmar, guint8 dev_id,
573 + BlockBackend *target, int vmstate_fd,
574 + unsigned char *buf, int64_t sector_num,
575 + int nb_sectors, Error **errp)
579 + if (dev_id == vmar->vmstate_stream) {
580 + if (vmstate_fd >= 0) {
581 + int len = nb_sectors * BDRV_SECTOR_SIZE;
582 + int res = full_write(vmstate_fd, buf, len);
584 + error_setg(errp, "write vmstate failed %d", res);
589 + int res = blk_pwrite(target, sector_num * BDRV_SECTOR_SIZE, buf, nb_sectors * BDRV_SECTOR_SIZE, 0);
591 + error_setg(errp, "blk_pwrite to %s failed (%d)",
592 + bdrv_get_device_name(blk_bs(target)), res);
599 +static int restore_extent(VmaReader *vmar, unsigned char *buf,
600 + int extent_size, int vmstate_fd,
601 + bool verbose, bool verify, Error **errp)
606 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
607 + int start = VMA_EXTENT_HEADER_SIZE;
610 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
611 + uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
612 + uint64_t cluster_num = block_info & 0xffffffff;
613 + uint8_t dev_id = (block_info >> 32) & 0xff;
614 + uint16_t mask = block_info >> (32+16);
615 + int64_t max_sector;
621 + VmaRestoreState *rstate = &vmar->rstate[dev_id];
622 + BlockBackend *target = NULL;
624 + if (dev_id != vmar->vmstate_stream) {
625 + target = rstate->target;
626 + if (!verify && !target) {
627 + error_setg(errp, "got wrong dev id %d", dev_id);
631 + if (vma_reader_get_bitmap(rstate, cluster_num)) {
632 + error_setg(errp, "found duplicated cluster %zd for stream %s",
633 + cluster_num, vmar->devinfo[dev_id].devname);
636 + vma_reader_set_bitmap(rstate, cluster_num, 1);
638 + max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
640 + max_sector = G_MAXINT64;
641 + if (cluster_num != vmar->vmstate_clusters) {
642 + error_setg(errp, "found out of order vmstate data");
645 + vmar->vmstate_clusters++;
648 + vmar->clusters_read++;
651 + time_t duration = time(NULL) - vmar->start_time;
652 + int percent = (vmar->clusters_read*100)/vmar->cluster_count;
653 + if (percent != vmar->clusters_read_per) {
654 + printf("progress %d%% (read %zd bytes, duration %zd sec)\n",
655 + percent, vmar->clusters_read*VMA_CLUSTER_SIZE,
658 + vmar->clusters_read_per = percent;
662 + /* try to write whole clusters to speedup restore */
663 + if (mask == 0xffff) {
664 + if ((start + VMA_CLUSTER_SIZE) > extent_size) {
665 + error_setg(errp, "short vma extent - too many blocks");
668 + int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
670 + int64_t end_sector = sector_num +
671 + VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
673 + if (end_sector > max_sector) {
674 + end_sector = max_sector;
677 + if (end_sector <= sector_num) {
678 + error_setg(errp, "got wrong block address - write beyond end");
683 + int nb_sectors = end_sector - sector_num;
684 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
685 + buf + start, sector_num, nb_sectors,
691 + start += VMA_CLUSTER_SIZE;
696 + for (j = 0; j < 16; j++) {
697 + int64_t sector_num = (cluster_num*VMA_CLUSTER_SIZE +
698 + j*VMA_BLOCK_SIZE)/BDRV_SECTOR_SIZE;
700 + int64_t end_sector = sector_num +
701 + VMA_BLOCK_SIZE/BDRV_SECTOR_SIZE;
702 + if (end_sector > max_sector) {
703 + end_sector = max_sector;
707 + if ((start + VMA_BLOCK_SIZE) > extent_size) {
708 + error_setg(errp, "short vma extent - too many blocks");
712 + if (end_sector <= sector_num) {
713 + error_setg(errp, "got wrong block address - "
714 + "write beyond end");
719 + int nb_sectors = end_sector - sector_num;
720 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
721 + buf + start, sector_num,
722 + nb_sectors, errp) < 0) {
727 + start += VMA_BLOCK_SIZE;
732 + if (end_sector > sector_num) {
733 + /* Todo: use bdrv_co_write_zeroes (but that need to
734 + * be run inside coroutine?)
736 + int nb_sectors = end_sector - sector_num;
737 + int zero_size = BDRV_SECTOR_SIZE*nb_sectors;
738 + vmar->zero_cluster_data += zero_size;
740 + vmar->partial_zero_cluster_data += zero_size;
743 + if (rstate->write_zeroes && !verify) {
744 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
745 + zero_vma_block, sector_num,
746 + nb_sectors, errp) < 0) {
758 + if (start != extent_size) {
759 + error_setg(errp, "vma extent error - missing blocks");
766 +static int vma_reader_restore_full(VmaReader *vmar, int vmstate_fd,
767 + bool verbose, bool verify,
771 + assert(vmar->head_data);
774 + unsigned char buf[VMA_MAX_EXTENT_SIZE];
776 + unsigned char md5sum[16];
777 + VmaHeader *h = (VmaHeader *)vmar->head_data;
779 + vmar->start_time = time(NULL);
782 + int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
784 + error_setg(errp, "read failed - %s", g_strerror(errno));
794 + if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
795 + error_setg(errp, "read short extent (%d bytes)", buf_pos);
799 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
801 + /* extract md5sum */
802 + memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
803 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
805 + g_checksum_reset(vmar->md5csum);
806 + g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
808 + g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
810 + if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
811 + error_setg(errp, "wrong vma extent header chechsum");
815 + if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
816 + error_setg(errp, "wrong vma extent uuid");
820 + if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
821 + error_setg(errp, "wrong vma extent header magic");
825 + int block_count = GUINT16_FROM_BE(ehead->block_count);
826 + int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
828 + if (buf_pos < extent_size) {
829 + error_setg(errp, "short vma extent (%d < %d)", buf_pos,
834 + if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
835 + verify, errp) < 0) {
839 + if (buf_pos > extent_size) {
840 + memmove(buf, buf + extent_size, buf_pos - extent_size);
841 + buf_pos = buf_pos - extent_size;
850 + for (i = 1; i < 256; i++) {
851 + VmaRestoreState *rstate = &vmar->rstate[i];
852 + if (!rstate->target) {
856 + if (blk_flush(rstate->target) < 0) {
857 + error_setg(errp, "vma blk_flush %s failed",
858 + vmar->devinfo[i].devname);
862 + if (vmar->devinfo[i].size &&
863 + (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
864 + assert(rstate->bitmap);
866 + int64_t cluster_num, end;
868 + end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
871 + for (cluster_num = 0; cluster_num < end; cluster_num++) {
872 + if (!vma_reader_get_bitmap(rstate, cluster_num)) {
873 + error_setg(errp, "detected missing cluster %zd "
874 + "for stream %s", cluster_num,
875 + vmar->devinfo[i].devname);
883 + if (vmar->clusters_read) {
884 + printf("total bytes read %zd, sparse bytes %zd (%.3g%%)\n",
885 + vmar->clusters_read*VMA_CLUSTER_SIZE,
886 + vmar->zero_cluster_data,
887 + (double)(100.0*vmar->zero_cluster_data)/
888 + (vmar->clusters_read*VMA_CLUSTER_SIZE));
890 + int64_t datasize = vmar->clusters_read*VMA_CLUSTER_SIZE-vmar->zero_cluster_data;
891 + if (datasize) { // this does not make sense for empty files
892 + printf("space reduction due to 4K zero blocks %.3g%%\n",
893 + (double)(100.0*vmar->partial_zero_cluster_data) / datasize);
896 + printf("vma archive contains no image data\n");
902 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
905 + return vma_reader_restore_full(vmar, vmstate_fd, verbose, false, errp);
908 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp)
912 + for (dev_id = 1; dev_id < 255; dev_id++) {
913 + if (vma_reader_get_device_info(vmar, dev_id)) {
914 + allocate_rstate(vmar, dev_id, NULL, false);
918 + return vma_reader_restore_full(vmar, -1, verbose, true, errp);
921 diff --git a/vma-writer.c b/vma-writer.c
923 index 0000000000..11d8321ffd
928 + * VMA: Virtual Machine Archive
930 + * Copyright (C) 2012 Proxmox Server Solutions
933 + * Dietmar Maurer (dietmar@proxmox.com)
935 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
936 + * See the COPYING file in the top-level directory.
940 +#include "qemu/osdep.h"
942 +#include <uuid/uuid.h>
945 +#include "block/block.h"
946 +#include "monitor/monitor.h"
947 +#include "qemu/main-loop.h"
948 +#include "qemu/coroutine.h"
949 +#include "qemu/cutils.h"
953 +#define DPRINTF(fmt, ...)\
954 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
956 +#define WRITE_BUFFERS 5
957 +#define HEADER_CLUSTERS 8
958 +#define HEADERBUF_SIZE (VMA_CLUSTER_SIZE*HEADER_CLUSTERS)
966 + bool header_written;
969 + /* we always write extents */
970 + unsigned char *outbuf;
971 + int outbuf_pos; /* in bytes */
972 + int outbuf_count; /* in VMA_BLOCKS */
973 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
975 + unsigned char *headerbuf;
977 + GChecksum *md5csum;
978 + CoMutex flush_lock;
979 + Coroutine *co_writer;
981 + /* drive informations */
982 + VmaStreamInfo stream_info[256];
983 + guint stream_count;
985 + guint8 vmstate_stream;
986 + uint32_t vmstate_clusters;
988 + /* header blob table */
989 + char *header_blob_table;
990 + uint32_t header_blob_table_size;
991 + uint32_t header_blob_table_pos;
993 + /* store for config blobs */
994 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
995 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
996 + uint32_t config_count;
999 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1003 + if (vmaw->status < 0) {
1007 + vmaw->status = -1;
1009 + va_start(ap, fmt);
1010 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1013 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1016 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1019 + if (len > 65535) {
1023 + if (!vmaw->header_blob_table ||
1024 + (vmaw->header_blob_table_size <
1025 + (vmaw->header_blob_table_pos + len + 2))) {
1026 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1028 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1029 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1030 + 0, newsize - vmaw->header_blob_table_size);
1031 + vmaw->header_blob_table_size = newsize;
1034 + uint32_t cpos = vmaw->header_blob_table_pos;
1035 + vmaw->header_blob_table[cpos] = len & 255;
1036 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1037 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1038 + vmaw->header_blob_table_pos += len + 2;
1042 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1046 + size_t len = strlen(str) + 1;
1048 + return allocate_header_blob(vmaw, str, len);
1051 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1055 + assert(!vmaw->header_written);
1056 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1060 + gchar *basename = g_path_get_basename(name);
1061 + uint32_t name_ptr = allocate_header_string(vmaw, basename);
1068 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1073 + vmaw->config_names[vmaw->config_count] = name_ptr;
1074 + vmaw->config_data[vmaw->config_count] = data_ptr;
1076 + vmaw->config_count++;
1081 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1086 + assert(!vmaw->status);
1088 + if (vmaw->header_written) {
1089 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1090 + "already written");
1094 + guint n = vmaw->stream_count + 1;
1096 + /* we can have dev_ids form 1 to 255 (0 reserved)
1097 + * 255(-1) reseverd for safety
1100 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1101 + "too many drives");
1106 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1107 + "got strange size %zd", size);
1111 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1113 + vmaw->stream_info[n].devname = g_strdup(devname);
1114 + vmaw->stream_info[n].size = size;
1116 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1119 + vmaw->stream_count = n;
1121 + if (strcmp(devname, "vmstate") == 0) {
1122 + vmaw->vmstate_stream = n;
1128 +static void coroutine_fn yield_until_fd_writable(int fd)
1130 + assert(qemu_in_coroutine());
1131 + AioContext *ctx = qemu_get_current_aio_context();
1132 + aio_set_fd_handler(ctx, fd, false, NULL, (IOHandler *)qemu_coroutine_enter,
1133 + NULL, qemu_coroutine_self());
1134 + qemu_coroutine_yield();
1135 + aio_set_fd_handler(ctx, fd, false, NULL, NULL, NULL, NULL);
1138 +static ssize_t coroutine_fn
1139 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1141 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1145 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1150 + assert(vmaw->co_writer == NULL);
1152 + vmaw->co_writer = qemu_coroutine_self();
1154 + while (done < bytes) {
1155 + if (vmaw->status < 0) {
1156 + DPRINTF("vma_queue_write detected canceled backup\n");
1160 + yield_until_fd_writable(vmaw->fd);
1161 + ret = write(vmaw->fd, buf + done, bytes - done);
1164 + DPRINTF("vma_queue_write written %zd %zd\n", done, ret);
1165 + } else if (ret < 0) {
1166 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1169 + vma_writer_set_error(vmaw, "vma_queue_write: write error - %s",
1170 + g_strerror(errno));
1171 + done = -1; /* always return failure for partial writes */
1174 + } else if (ret == 0) {
1175 + /* should not happen - simply try again */
1179 + vmaw->co_writer = NULL;
1181 + return (done == bytes) ? bytes : -1;
1184 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp)
1188 + assert(sizeof(VmaHeader) == (4096 + 8192));
1189 + assert(G_STRUCT_OFFSET(VmaHeader, config_names) == 2044);
1190 + assert(G_STRUCT_OFFSET(VmaHeader, config_data) == 3068);
1191 + assert(G_STRUCT_OFFSET(VmaHeader, dev_info) == 4096);
1192 + assert(sizeof(VmaExtentHeader) == 512);
1194 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1197 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1198 + if (!vmaw->md5csum) {
1199 + error_setg(errp, "can't allocate cmsum\n");
1203 + if (strstart(filename, "exec:", &p)) {
1204 + vmaw->cmd = popen(p, "w");
1205 + if (vmaw->cmd == NULL) {
1206 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1207 + g_strerror(errno));
1210 + vmaw->fd = fileno(vmaw->cmd);
1212 + /* try to use O_NONBLOCK */
1213 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1218 + const char *tmp_id_str;
1220 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1221 + oflags = O_NONBLOCK|O_WRONLY;
1222 + vmaw->fd = qemu_open(filename, oflags, errp);
1223 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1224 + oflags = O_NONBLOCK|O_WRONLY;
1225 + vmaw->fd = qemu_open(filename, oflags, errp);
1226 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1227 + vmaw->fd = monitor_get_fd(monitor_cur(), tmp_id_str, errp);
1228 + if (vmaw->fd < 0) {
1231 + /* try to use O_NONBLOCK */
1232 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1234 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY|O_EXCL;
1235 + vmaw->fd = qemu_create(filename, oflags, 0644, errp);
1238 + if (vmaw->fd < 0) {
1239 + error_setg(errp, "can't open file %s - %s\n", filename,
1240 + g_strerror(errno));
1245 + /* we use O_DIRECT, so we need to align IO buffers */
1247 + vmaw->outbuf = qemu_memalign(512, VMA_MAX_EXTENT_SIZE);
1248 + vmaw->headerbuf = qemu_memalign(512, HEADERBUF_SIZE);
1250 + vmaw->outbuf_count = 0;
1251 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1253 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1255 + qemu_co_mutex_init(&vmaw->flush_lock);
1257 + uuid_copy(vmaw->uuid, uuid);
1264 + pclose(vmaw->cmd);
1265 + } else if (vmaw->fd >= 0) {
1269 + if (vmaw->md5csum) {
1270 + g_checksum_free(vmaw->md5csum);
1279 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1282 + unsigned char *buf = vmaw->headerbuf;
1283 + VmaHeader *head = (VmaHeader *)buf;
1287 + DPRINTF("VMA WRITE HEADER\n");
1289 + if (vmaw->status < 0) {
1290 + return vmaw->status;
1293 + memset(buf, 0, HEADERBUF_SIZE);
1295 + head->magic = VMA_MAGIC;
1296 + head->version = GUINT32_TO_BE(1); /* v1 */
1297 + memcpy(head->uuid, vmaw->uuid, 16);
1299 + time_t ctime = time(NULL);
1300 + head->ctime = GUINT64_TO_BE(ctime);
1302 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1303 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1304 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1307 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1308 + for (i = 1; i <= 254; i++) {
1309 + VmaStreamInfo *si = &vmaw->stream_info[i];
1311 + assert(si->devname);
1312 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1313 + if (!devname_ptr) {
1316 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1317 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1321 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1322 + head->header_size = GUINT32_TO_BE(header_size);
1324 + if (header_size > HEADERBUF_SIZE) {
1325 + return -1; /* just to be sure */
1328 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1329 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1330 + vmaw->header_blob_table_size);
1331 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1332 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1334 + g_checksum_reset(vmaw->md5csum);
1335 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1337 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1339 + return vma_queue_write(vmaw, buf, header_size);
1342 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1349 + if (vmaw->status < 0) {
1350 + return vmaw->status;
1353 + if (!vmaw->header_written) {
1354 + vmaw->header_written = true;
1355 + ret = vma_write_header(vmaw);
1357 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1362 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1365 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1367 + ehead->magic = VMA_EXTENT_MAGIC;
1368 + ehead->reserved1 = 0;
1370 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1371 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1374 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1377 + ehead->block_count = GUINT16_TO_BE(block_count);
1379 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1380 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1382 + g_checksum_reset(vmaw->md5csum);
1383 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1385 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1387 + int bytes = vmaw->outbuf_pos;
1388 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1389 + if (ret != bytes) {
1390 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1393 + vmaw->outbuf_count = 0;
1394 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1396 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1397 + vmaw->outbuf_block_info[i] = 0;
1400 + return vmaw->status;
1403 +static int vma_count_open_streams(VmaWriter *vmaw)
1405 + g_assert(vmaw != NULL);
1408 + int open_drives = 0;
1409 + for (i = 0; i <= 255; i++) {
1410 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1415 + return open_drives;
1420 + * You need to call this if the vma archive does not contain
1421 + * any data stream.
1424 +vma_writer_flush_output(VmaWriter *vmaw)
1426 + qemu_co_mutex_lock(&vmaw->flush_lock);
1427 + int ret = vma_writer_flush(vmaw);
1428 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1430 + vma_writer_set_error(vmaw, "vma_writer_flush_header failed");
1436 + * all jobs should call this when there is no more data
1437 + * Returns: number of remaining stream (0 ==> finished)
1440 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1442 + g_assert(vmaw != NULL);
1444 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1445 + if (!vmaw->stream_info[dev_id].size) {
1446 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1447 + "no such stream %d", dev_id);
1450 + if (vmaw->stream_info[dev_id].finished) {
1451 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1452 + "stream already closed %d", dev_id);
1456 + vmaw->stream_info[dev_id].finished = true;
1458 + int open_drives = vma_count_open_streams(vmaw);
1460 + if (open_drives <= 0) {
1461 + DPRINTF("vma_writer_set_status all drives completed\n");
1462 + vma_writer_flush_output(vmaw);
1465 + return open_drives;
1468 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1472 + g_assert(vmaw != NULL);
1475 + status->status = vmaw->status;
1476 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1477 + for (i = 0; i <= 255; i++) {
1478 + status->stream_info[i] = vmaw->stream_info[i];
1481 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1484 + status->closed = vmaw->closed;
1486 + return vmaw->status;
1489 +static int vma_writer_get_buffer(VmaWriter *vmaw)
1493 + qemu_co_mutex_lock(&vmaw->flush_lock);
1495 + /* wait until buffer is available */
1496 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1497 + ret = vma_writer_flush(vmaw);
1499 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1504 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1510 +int64_t coroutine_fn
1511 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1512 + const unsigned char *buf, size_t *zero_bytes)
1514 + g_assert(vmaw != NULL);
1515 + g_assert(zero_bytes != NULL);
1519 + if (vmaw->status < 0) {
1520 + return vmaw->status;
1523 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1524 + vma_writer_set_error(vmaw, "vma_writer_write: "
1525 + "no such stream %d", dev_id);
1529 + if (vmaw->stream_info[dev_id].finished) {
1530 + vma_writer_set_error(vmaw, "vma_writer_write: "
1531 + "stream already closed %d", dev_id);
1536 + if (cluster_num >= (((uint64_t)1)<<32)) {
1537 + vma_writer_set_error(vmaw, "vma_writer_write: "
1538 + "cluster number out of range");
1542 + if (dev_id == vmaw->vmstate_stream) {
1543 + if (cluster_num != vmaw->vmstate_clusters) {
1544 + vma_writer_set_error(vmaw, "vma_writer_write: "
1545 + "non sequential vmstate write");
1547 + vmaw->vmstate_clusters++;
1548 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1549 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1553 + /* wait until buffer is available */
1554 + if (vma_writer_get_buffer(vmaw) < 0) {
1555 + vma_writer_set_error(vmaw, "vma_writer_write: "
1556 + "vma_writer_get_buffer failed");
1560 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1562 + uint64_t dev_size = vmaw->stream_info[dev_id].size;
1563 + uint16_t mask = 0;
1568 + uint64_t byte_offset = cluster_num * VMA_CLUSTER_SIZE;
1569 + for (i = 0; i < 16; i++) {
1570 + const unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1572 + // Note: If the source is not 64k-aligned, we might reach 4k blocks
1573 + // after the end of the device. Always mark these as zero in the
1574 + // mask, so the restore handles them correctly.
1575 + if (byte_offset < dev_size &&
1576 + !buffer_is_zero(vmablock, VMA_BLOCK_SIZE))
1579 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock,
1582 + // prevent memory leakage on unaligned last block
1583 + if (byte_offset + VMA_BLOCK_SIZE > dev_size) {
1584 + uint64_t real_data_in_block = dev_size - byte_offset;
1585 + memset(vmaw->outbuf + vmaw->outbuf_pos + real_data_in_block,
1586 + 0, VMA_BLOCK_SIZE - real_data_in_block);
1589 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1591 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1592 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1593 + *zero_bytes += VMA_BLOCK_SIZE;
1596 + byte_offset += VMA_BLOCK_SIZE;
1600 + DPRINTF("VMA WRITE %zd ZERO CLUSTER\n", cluster_num);
1601 + vmaw->stream_info[dev_id].zero_bytes += VMA_CLUSTER_SIZE;
1602 + *zero_bytes += VMA_CLUSTER_SIZE;
1605 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1606 + block_info |= ((uint64_t)dev_id) << 32;
1607 + block_info |= (cluster_num & 0xffffffff);
1608 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1610 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1612 + vmaw->outbuf_count++;
1614 + /** NOTE: We allways write whole clusters, but we correctly set
1615 + * transferred bytes. So transferred == size when when everything
1618 + size_t transferred = VMA_CLUSTER_SIZE;
1620 + if (dev_id != vmaw->vmstate_stream) {
1621 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1622 + if (last > dev_size) {
1623 + uint64_t diff = last - dev_size;
1624 + if (diff >= VMA_CLUSTER_SIZE) {
1625 + vma_writer_set_error(vmaw, "vma_writer_write: "
1626 + "read after last cluster");
1629 + transferred -= diff;
1633 + vmaw->stream_info[dev_id].transferred += transferred;
1635 + return transferred;
1638 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp)
1640 + if (vmaw->status < 0 && *errp == NULL) {
1641 + error_setg(errp, "%s", vmaw->errmsg);
1645 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1647 + g_assert(vmaw != NULL);
1651 + qemu_co_mutex_lock(&vmaw->flush_lock); // wait for pending writes
1653 + assert(vmaw->co_writer == NULL);
1656 + if (pclose(vmaw->cmd) < 0) {
1657 + vma_writer_set_error(vmaw, "vma_writer_close: "
1658 + "pclose failed - %s", g_strerror(errno));
1661 + if (close(vmaw->fd) < 0) {
1662 + vma_writer_set_error(vmaw, "vma_writer_close: "
1663 + "close failed - %s", g_strerror(errno));
1667 + for (i = 0; i <= 255; i++) {
1668 + VmaStreamInfo *si = &vmaw->stream_info[i];
1670 + if (!si->finished) {
1671 + vma_writer_set_error(vmaw, "vma_writer_close: "
1672 + "detected open stream '%s'", si->devname);
1673 + } else if ((si->transferred != si->size) &&
1674 + (i != vmaw->vmstate_stream)) {
1675 + vma_writer_set_error(vmaw, "vma_writer_close: "
1676 + "incomplete stream '%s' (%zd != %zd)",
1677 + si->devname, si->transferred, si->size);
1682 + for (i = 0; i <= 255; i++) {
1683 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1688 + if (vmaw->status < 0 && *errp == NULL) {
1689 + error_setg(errp, "%s", vmaw->errmsg);
1692 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1694 + return vmaw->status;
1697 +void vma_writer_destroy(VmaWriter *vmaw)
1703 + for (i = 0; i <= 255; i++) {
1704 + if (vmaw->stream_info[i].devname) {
1705 + g_free(vmaw->stream_info[i].devname);
1709 + if (vmaw->md5csum) {
1710 + g_checksum_free(vmaw->md5csum);
1713 + qemu_vfree(vmaw->headerbuf);
1714 + qemu_vfree(vmaw->outbuf);
1717 diff --git a/vma.c b/vma.c
1718 new file mode 100644
1719 index 0000000000..df542b7732
1724 + * VMA: Virtual Machine Archive
1726 + * Copyright (C) 2012-2013 Proxmox Server Solutions
1729 + * Dietmar Maurer (dietmar@proxmox.com)
1731 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1732 + * See the COPYING file in the top-level directory.
1736 +#include "qemu/osdep.h"
1740 +#include "qemu-common.h"
1741 +#include "qemu/module.h"
1742 +#include "qemu/error-report.h"
1743 +#include "qemu/main-loop.h"
1744 +#include "qemu/cutils.h"
1745 +#include "qapi/qmp/qdict.h"
1746 +#include "sysemu/block-backend.h"
1748 +static void help(void)
1750 + const char *help_msg =
1751 + "usage: vma command [command options]\n"
1753 + "vma list <filename>\n"
1754 + "vma config <filename> [-c config]\n"
1755 + "vma create <filename> [-c config] pathname ...\n"
1756 + "vma extract <filename> [-r <fifo>] <targetdir>\n"
1757 + "vma verify <filename> [-v]\n"
1760 + printf("%s", help_msg);
1764 +static const char *extract_devname(const char *path, char **devname, int index)
1768 + const char *sep = strchr(path, '=');
1771 + *devname = g_strndup(path, sep - path);
1775 + *devname = g_strdup_printf("disk%d", index);
1784 +static void print_content(VmaReader *vmar)
1788 + VmaHeader *head = vma_reader_get_header(vmar);
1790 + GList *l = vma_reader_get_config_data(vmar);
1791 + while (l && l->data) {
1792 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1793 + l = g_list_next(l);
1794 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1798 + VmaDeviceInfo *di;
1799 + for (i = 1; i < 255; i++) {
1800 + di = vma_reader_get_device_info(vmar, i);
1802 + if (strcmp(di->devname, "vmstate") == 0) {
1803 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1805 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1806 + i, di->size, di->devname);
1810 + /* ctime is the last entry we print */
1811 + printf("CTIME: %s", ctime(&head->ctime));
1815 +static int list_content(int argc, char **argv)
1818 + const char *filename;
1821 + c = getopt(argc, argv, "h");
1831 + g_assert_not_reached();
1835 + /* Get the filename */
1836 + if ((optind + 1) != argc) {
1839 + filename = argv[optind++];
1841 + Error *errp = NULL;
1842 + VmaReader *vmar = vma_reader_create(filename, &errp);
1845 + g_error("%s", error_get_pretty(errp));
1848 + print_content(vmar);
1850 + vma_reader_destroy(vmar);
1855 +typedef struct RestoreMap {
1859 + uint64_t throttling_bps;
1860 + char *throttling_group;
1865 +static bool try_parse_option(char **line, const char *optname, char **out, const char *inbuf) {
1866 + size_t optlen = strlen(optname);
1867 + if (strncmp(*line, optname, optlen) != 0 || (*line)[optlen] != '=') {
1871 + g_error("read map failed - duplicate value for option '%s'", optname);
1873 + char *value = (*line) + optlen + 1; /* including a '=' */
1874 + char *colon = strchr(value, ':');
1876 + g_error("read map failed - option '%s' not terminated ('%s')",
1880 + *out = g_strndup(value, colon - value);
1884 +static uint64_t verify_u64(const char *text) {
1886 + const char *endptr = NULL;
1887 + if (qemu_strtou64(text, &endptr, 0, &value) != 0 || !endptr || *endptr) {
1888 + g_error("read map failed - not a number: %s", text);
1893 +static int extract_content(int argc, char **argv)
1897 + const char *filename;
1898 + const char *dirname;
1899 + const char *readmap = NULL;
1902 + c = getopt(argc, argv, "hvr:");
1922 + /* Get the filename */
1923 + if ((optind + 2) != argc) {
1926 + filename = argv[optind++];
1927 + dirname = argv[optind++];
1929 + Error *errp = NULL;
1930 + VmaReader *vmar = vma_reader_create(filename, &errp);
1933 + g_error("%s", error_get_pretty(errp));
1936 + if (mkdir(dirname, 0777) < 0) {
1937 + g_error("unable to create target directory %s - %s",
1938 + dirname, g_strerror(errno));
1941 + GList *l = vma_reader_get_config_data(vmar);
1942 + while (l && l->data) {
1943 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1944 + l = g_list_next(l);
1945 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
1946 + GError *err = NULL;
1947 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
1949 + g_error("unable to write file: %s", err->message);
1953 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
1956 + print_content(vmar);
1958 + FILE *map = fopen(readmap, "r");
1960 + g_error("unable to open fifo %s - %s", readmap, g_strerror(errno));
1965 + char *line = fgets(inbuf, sizeof(inbuf), map);
1966 + char *format = NULL;
1968 + char *group = NULL;
1969 + char *cache = NULL;
1970 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
1973 + int len = strlen(line);
1974 + if (line[len - 1] == '\n') {
1975 + line[len - 1] = '\0';
1982 + if (!try_parse_option(&line, "format", &format, inbuf) &&
1983 + !try_parse_option(&line, "throttling.bps", &bps, inbuf) &&
1984 + !try_parse_option(&line, "throttling.group", &group, inbuf) &&
1985 + !try_parse_option(&line, "cache", &cache, inbuf))
1991 + uint64_t bps_value = 0;
1993 + bps_value = verify_u64(bps);
1999 + if (line[0] == '0' && line[1] == ':') {
2001 + write_zero = false;
2002 + } else if (line[0] == '1' && line[1] == ':') {
2004 + write_zero = true;
2006 + g_error("read map failed - parse error ('%s')", inbuf);
2009 + char *devname = NULL;
2010 + path = extract_devname(path, &devname, -1);
2012 + g_error("read map failed - no dev name specified ('%s')",
2016 + RestoreMap *map = g_new0(RestoreMap, 1);
2017 + map->devname = g_strdup(devname);
2018 + map->path = g_strdup(path);
2019 + map->format = format;
2020 + map->throttling_bps = bps_value;
2021 + map->throttling_group = group;
2022 + map->cache = cache;
2023 + map->write_zero = write_zero;
2025 + g_hash_table_insert(devmap, map->devname, map);
2031 + int vmstate_fd = -1;
2032 + guint8 vmstate_stream = 0;
2034 + BlockBackend *blk = NULL;
2036 + for (i = 1; i < 255; i++) {
2037 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2038 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2039 + vmstate_stream = i;
2040 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2041 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2042 + if (vmstate_fd < 0) {
2043 + g_error("create vmstate file '%s' failed - %s", statefn,
2044 + g_strerror(errno));
2048 + char *devfn = NULL;
2049 + const char *format = NULL;
2050 + uint64_t throttling_bps = 0;
2051 + const char *throttling_group = NULL;
2052 + const char *cache = NULL;
2053 + int flags = BDRV_O_RDWR;
2054 + bool write_zero = true;
2058 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2059 + if (map == NULL) {
2060 + g_error("no device name mapping for %s", di->devname);
2062 + devfn = map->path;
2063 + format = map->format;
2064 + throttling_bps = map->throttling_bps;
2065 + throttling_group = map->throttling_group;
2066 + cache = map->cache;
2067 + write_zero = map->write_zero;
2069 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2070 + dirname, di->devname);
2071 + printf("DEVINFO %s %zd\n", devfn, di->size);
2073 + bdrv_img_create(devfn, "raw", NULL, NULL, NULL, di->size,
2074 + flags, true, &errp);
2076 + g_error("can't create file %s: %s", devfn,
2077 + error_get_pretty(errp));
2080 + /* Note: we created an empty file above, so there is no
2081 + * need to write zeroes (so we generate a sparse file)
2083 + write_zero = false;
2086 + size_t devlen = strlen(devfn);
2087 + QDict *options = NULL;
2088 + bool writethrough;
2090 + /* explicit format from commandline */
2091 + options = qdict_new();
2092 + qdict_put_str(options, "driver", format);
2093 + } else if ((devlen > 4 && strcmp(devfn+devlen-4, ".raw") == 0) ||
2094 + strncmp(devfn, "/dev/", 5) == 0)
2096 + /* This part is now deprecated for PVE as well (just as qemu
2097 + * deprecated not specifying an explicit raw format, too.
2099 + /* explicit raw format */
2100 + options = qdict_new();
2101 + qdict_put_str(options, "driver", "raw");
2103 + if (cache && bdrv_parse_cache_mode(cache, &flags, &writethrough)) {
2104 + g_error("invalid cache option: %s\n", cache);
2107 + if (errp || !(blk = blk_new_open(devfn, NULL, options, flags, &errp))) {
2108 + g_error("can't open file %s - %s", devfn,
2109 + error_get_pretty(errp));
2113 + blk_set_enable_write_cache(blk, !writethrough);
2116 + if (throttling_group) {
2117 + blk_io_limits_enable(blk, throttling_group);
2120 + if (throttling_bps) {
2121 + if (!throttling_group) {
2122 + blk_io_limits_enable(blk, devfn);
2125 + ThrottleConfig cfg;
2126 + throttle_config_init(&cfg);
2127 + cfg.buckets[THROTTLE_BPS_WRITE].avg = throttling_bps;
2128 + Error *err = NULL;
2129 + if (!throttle_is_valid(&cfg, &err)) {
2130 + error_report_err(err);
2131 + g_error("failed to apply throttling");
2133 + blk_set_io_limits(blk, &cfg);
2136 + if (vma_reader_register_bs(vmar, i, blk, write_zero, &errp) < 0) {
2137 + g_error("%s", error_get_pretty(errp));
2146 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2147 + g_error("restore failed - %s", error_get_pretty(errp));
2151 + for (i = 1; i < 255; i++) {
2152 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2153 + if (di && (i != vmstate_stream)) {
2154 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2155 + dirname, di->devname);
2156 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2157 + dirname, di->devname);
2158 + if (rename(tmpfn, fn) != 0) {
2159 + g_error("rename %s to %s failed - %s",
2160 + tmpfn, fn, g_strerror(errno));
2166 + vma_reader_destroy(vmar);
2175 +static int verify_content(int argc, char **argv)
2179 + const char *filename;
2182 + c = getopt(argc, argv, "hv");
2199 + /* Get the filename */
2200 + if ((optind + 1) != argc) {
2203 + filename = argv[optind++];
2205 + Error *errp = NULL;
2206 + VmaReader *vmar = vma_reader_create(filename, &errp);
2209 + g_error("%s", error_get_pretty(errp));
2213 + print_content(vmar);
2216 + if (vma_reader_verify(vmar, verbose, &errp) < 0) {
2217 + g_error("verify failed - %s", error_get_pretty(errp));
2220 + vma_reader_destroy(vmar);
2227 +typedef struct BackupJob {
2228 + BlockBackend *target;
2234 +#define BACKUP_SECTORS_PER_CLUSTER (VMA_CLUSTER_SIZE / BDRV_SECTOR_SIZE)
2236 +static void coroutine_fn backup_run_empty(void *opaque)
2238 + VmaWriter *vmaw = (VmaWriter *)opaque;
2240 + vma_writer_flush_output(vmaw);
2242 + Error *err = NULL;
2243 + if (vma_writer_close(vmaw, &err) != 0) {
2244 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2248 +static void coroutine_fn backup_run(void *opaque)
2250 + BackupJob *job = (BackupJob *)opaque;
2252 + QEMUIOVector qiov;
2254 + int64_t start, end;
2257 + unsigned char *buf = blk_blockalign(job->target, VMA_CLUSTER_SIZE);
2260 + end = DIV_ROUND_UP(job->len / BDRV_SECTOR_SIZE,
2261 + BACKUP_SECTORS_PER_CLUSTER);
2263 + for (; start < end; start++) {
2264 + iov.iov_base = buf;
2265 + iov.iov_len = VMA_CLUSTER_SIZE;
2266 + qemu_iovec_init_external(&qiov, &iov, 1);
2268 + ret = blk_co_preadv(job->target, start * VMA_CLUSTER_SIZE,
2269 + VMA_CLUSTER_SIZE, &qiov, 0);
2271 + vma_writer_set_error(job->vmaw, "read error", -1);
2276 + if (vma_writer_write(job->vmaw, job->dev_id, start, buf, &zb) < 0) {
2277 + vma_writer_set_error(job->vmaw, "backup_dump_cb vma_writer_write failed", -1);
2284 + if (vma_writer_close_stream(job->vmaw, job->dev_id) <= 0) {
2285 + Error *err = NULL;
2286 + if (vma_writer_close(job->vmaw, &err) != 0) {
2287 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2293 +static int create_archive(int argc, char **argv)
2297 + const char *archivename;
2298 + GList *backup_coroutines = NULL;
2299 + GList *config_files = NULL;
2302 + c = getopt(argc, argv, "hvc:");
2312 + config_files = g_list_append(config_files, optarg);
2318 + g_assert_not_reached();
2323 + /* make sure we an archive name */
2324 + if ((optind + 1) > argc) {
2328 + archivename = argv[optind++];
2331 + uuid_generate(uuid);
2333 + Error *local_err = NULL;
2334 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, &local_err);
2336 + if (vmaw == NULL) {
2337 + g_error("%s", error_get_pretty(local_err));
2340 + GList *l = config_files;
2341 + while (l && l->data) {
2342 + char *name = l->data;
2343 + char *cdata = NULL;
2345 + GError *err = NULL;
2346 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2347 + unlink(archivename);
2348 + g_error("Unable to read file: %s", err->message);
2351 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2352 + unlink(archivename);
2353 + g_error("Unable to append config data %s (len = %zd)",
2356 + l = g_list_next(l);
2360 + while (optind < argc) {
2361 + const char *path = argv[optind++];
2362 + char *devname = NULL;
2363 + path = extract_devname(path, &devname, devcount++);
2365 + Error *errp = NULL;
2366 + BlockBackend *target;
2368 + target = blk_new_open(path, NULL, NULL, 0, &errp);
2370 + unlink(archivename);
2371 + g_error("bdrv_open '%s' failed - %s", path, error_get_pretty(errp));
2373 + int64_t size = blk_getlength(target);
2374 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2375 + if (dev_id <= 0) {
2376 + unlink(archivename);
2377 + g_error("vma_writer_register_stream '%s' failed", devname);
2380 + BackupJob *job = g_new0(BackupJob, 1);
2382 + job->target = target;
2384 + job->dev_id = dev_id;
2386 + Coroutine *co = qemu_coroutine_create(backup_run, job);
2387 + // Don't enter coroutine yet, because it might write the header before
2388 + // all streams can be registered.
2389 + backup_coroutines = g_list_append(backup_coroutines, co);
2392 + VmaStatus vmastat;
2394 + int last_percent = -1;
2397 + GList *entry = backup_coroutines;
2398 + while (entry && entry->data) {
2399 + Coroutine *co = entry->data;
2400 + qemu_coroutine_enter(co);
2401 + entry = g_list_next(entry);
2405 + main_loop_wait(false);
2406 + vma_writer_get_status(vmaw, &vmastat);
2410 + uint64_t total = 0;
2411 + uint64_t transferred = 0;
2412 + uint64_t zero_bytes = 0;
2415 + for (i = 0; i < 256; i++) {
2416 + if (vmastat.stream_info[i].size) {
2417 + total += vmastat.stream_info[i].size;
2418 + transferred += vmastat.stream_info[i].transferred;
2419 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2422 + percent = (transferred*100)/total;
2423 + if (percent != last_percent) {
2424 + fprintf(stderr, "progress %d%% %zd/%zd %zd\n", percent,
2425 + transferred, total, zero_bytes);
2428 + last_percent = percent;
2432 + if (vmastat.closed) {
2437 + Coroutine *co = qemu_coroutine_create(backup_run_empty, vmaw);
2438 + qemu_coroutine_enter(co);
2440 + main_loop_wait(false);
2441 + vma_writer_get_status(vmaw, &vmastat);
2442 + if (vmastat.closed) {
2450 + vma_writer_get_status(vmaw, &vmastat);
2453 + for (i = 0; i < 256; i++) {
2454 + VmaStreamInfo *si = &vmastat.stream_info[i];
2456 + fprintf(stderr, "image %s: size=%zd zeros=%zd saved=%zd\n",
2457 + si->devname, si->size, si->zero_bytes,
2458 + si->size - si->zero_bytes);
2463 + if (vmastat.status < 0) {
2464 + unlink(archivename);
2465 + g_error("creating vma archive failed");
2468 + g_list_free(backup_coroutines);
2469 + g_list_free(config_files);
2470 + vma_writer_destroy(vmaw);
2474 +static int dump_config(int argc, char **argv)
2477 + const char *filename;
2478 + const char *config_name = "qemu-server.conf";
2481 + c = getopt(argc, argv, "hc:");
2491 + config_name = optarg;
2498 + /* Get the filename */
2499 + if ((optind + 1) != argc) {
2502 + filename = argv[optind++];
2504 + Error *errp = NULL;
2505 + VmaReader *vmar = vma_reader_create(filename, &errp);
2508 + g_error("%s", error_get_pretty(errp));
2512 + GList *l = vma_reader_get_config_data(vmar);
2513 + while (l && l->data) {
2514 + VmaConfigData *cdata = (VmaConfigData *)l->data;
2515 + l = g_list_next(l);
2516 + if (strcmp(cdata->name, config_name) == 0) {
2518 + fwrite(cdata->data, cdata->len, 1, stdout);
2523 + vma_reader_destroy(vmar);
2528 + fprintf(stderr, "unable to find configuration data '%s'\n", config_name);
2535 +int main(int argc, char **argv)
2537 + const char *cmdname;
2538 + Error *main_loop_err = NULL;
2540 + error_init(argv[0]);
2541 + module_call_init(MODULE_INIT_TRACE);
2542 + qemu_init_exec_dir(argv[0]);
2544 + if (qemu_init_main_loop(&main_loop_err)) {
2545 + g_error("%s", error_get_pretty(main_loop_err));
2549 + module_call_init(MODULE_INIT_QOM);
2555 + cmdname = argv[1];
2559 + if (!strcmp(cmdname, "list")) {
2560 + return list_content(argc, argv);
2561 + } else if (!strcmp(cmdname, "create")) {
2562 + return create_archive(argc, argv);
2563 + } else if (!strcmp(cmdname, "extract")) {
2564 + return extract_content(argc, argv);
2565 + } else if (!strcmp(cmdname, "verify")) {
2566 + return verify_content(argc, argv);
2567 + } else if (!strcmp(cmdname, "config")) {
2568 + return dump_config(argc, argv);
2574 diff --git a/vma.h b/vma.h
2575 new file mode 100644
2576 index 0000000000..c895c97f6d
2581 + * VMA: Virtual Machine Archive
2583 + * Copyright (C) Proxmox Server Solutions
2586 + * Dietmar Maurer (dietmar@proxmox.com)
2588 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2589 + * See the COPYING file in the top-level directory.
2593 +#ifndef BACKUP_VMA_H
2594 +#define BACKUP_VMA_H
2596 +#include <uuid/uuid.h>
2597 +#include "qapi/error.h"
2598 +#include "block/block.h"
2600 +#define VMA_BLOCK_BITS 12
2601 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2602 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2603 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2605 +#if VMA_CLUSTER_SIZE != 65536
2606 +#error unexpected cluster size
2609 +#define VMA_EXTENT_HEADER_SIZE 512
2610 +#define VMA_BLOCKS_PER_EXTENT 59
2611 +#define VMA_MAX_CONFIGS 256
2613 +#define VMA_MAX_EXTENT_SIZE \
2614 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2615 +#if VMA_MAX_EXTENT_SIZE != 3867136
2616 +#error unexpected VMA_EXTENT_SIZE
2619 +/* File Format Definitions */
2621 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2622 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2624 +typedef struct VmaDeviceInfoHeader {
2625 + uint32_t devname_ptr; /* offset into blob_buffer table */
2626 + uint32_t reserved0;
2627 + uint64_t size; /* device size in bytes */
2628 + uint64_t reserved1;
2629 + uint64_t reserved2;
2630 +} VmaDeviceInfoHeader;
2632 +typedef struct VmaHeader {
2635 + unsigned char uuid[16];
2637 + unsigned char md5sum[16];
2639 + uint32_t blob_buffer_offset;
2640 + uint32_t blob_buffer_size;
2641 + uint32_t header_size;
2643 + unsigned char reserved[1984];
2645 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2646 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2648 + uint32_t reserved1;
2650 + VmaDeviceInfoHeader dev_info[256];
2653 +typedef struct VmaExtentHeader {
2655 + uint16_t reserved1;
2656 + uint16_t block_count;
2657 + unsigned char uuid[16];
2658 + unsigned char md5sum[16];
2659 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2662 +/* functions/definitions to read/write vma files */
2664 +typedef struct VmaReader VmaReader;
2666 +typedef struct VmaWriter VmaWriter;
2668 +typedef struct VmaConfigData {
2674 +typedef struct VmaStreamInfo {
2676 + uint64_t cluster_count;
2677 + uint64_t transferred;
2678 + uint64_t zero_bytes;
2683 +typedef struct VmaStatus {
2686 + char errmsg[8192];
2687 + char uuid_str[37];
2688 + VmaStreamInfo stream_info[256];
2691 +typedef struct VmaDeviceInfo {
2692 + uint64_t size; /* device size in bytes */
2693 + const char *devname;
2696 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp);
2697 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2698 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp);
2699 +void vma_writer_destroy(VmaWriter *vmaw);
2700 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2702 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2705 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2706 + int64_t cluster_num,
2707 + const unsigned char *buf,
2708 + size_t *zero_bytes);
2710 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2711 +int coroutine_fn vma_writer_flush_output(VmaWriter *vmaw);
2713 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2714 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2717 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2718 +void vma_reader_destroy(VmaReader *vmar);
2719 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2720 +GList *vma_reader_get_config_data(VmaReader *vmar);
2721 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2722 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2723 + BlockBackend *target, bool write_zeroes,
2725 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2727 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp);
2729 +#endif /* BACKUP_VMA_H */