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 | 859 ++++++++++++++++++++++++++++++++++++++++++++++
13 vma-writer.c | 791 ++++++++++++++++++++++++++++++++++++++++++
14 vma.c | 849 +++++++++++++++++++++++++++++++++++++++++++++
16 6 files changed, 2656 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 253fe49fa2..744b698a82 100644
24 --- a/block/meson.build
25 +++ b/block/meson.build
26 @@ -47,6 +47,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'))
33 softmmu_ss.add(files('block-ram-registrar.c'))
35 diff --git a/meson.build b/meson.build
36 index c44d05a13f..b9bc31b01c 100644
39 @@ -1527,6 +1527,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 @@ -3645,6 +3647,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..e65f1e8415
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/timer.h"
82 +#include "qemu/ratelimit.h"
84 +#include "block/block.h"
85 +#include "sysemu/block-backend.h"
87 +static unsigned char zero_vma_block[VMA_BLOCK_SIZE];
89 +typedef struct VmaRestoreState {
90 + BlockBackend *target;
92 + unsigned long *bitmap;
99 + GHashTable *blob_hash;
100 + unsigned char *head_data;
101 + VmaDeviceInfo devinfo[256];
102 + VmaRestoreState rstate[256];
104 + guint8 vmstate_stream;
105 + uint32_t vmstate_clusters;
106 + /* to show restore percentage if run with -v */
108 + int64_t cluster_count;
109 + int64_t clusters_read;
110 + int64_t zero_cluster_data;
111 + int64_t partial_zero_cluster_data;
112 + int clusters_read_per;
116 +g_int32_hash(gconstpointer v)
118 + return *(const uint32_t *)v;
122 +g_int32_equal(gconstpointer v1, gconstpointer v2)
124 + return *((const uint32_t *)v1) == *((const uint32_t *)v2);
127 +static int vma_reader_get_bitmap(VmaRestoreState *rstate, int64_t cluster_num)
130 + assert(rstate->bitmap);
132 + unsigned long val, idx, bit;
134 + idx = cluster_num / BITS_PER_LONG;
136 + assert(rstate->bitmap_size > idx);
138 + bit = cluster_num % BITS_PER_LONG;
139 + val = rstate->bitmap[idx];
141 + return !!(val & (1UL << bit));
144 +static void vma_reader_set_bitmap(VmaRestoreState *rstate, int64_t cluster_num,
148 + assert(rstate->bitmap);
150 + unsigned long val, idx, bit;
152 + idx = cluster_num / BITS_PER_LONG;
154 + assert(rstate->bitmap_size > idx);
156 + bit = cluster_num % BITS_PER_LONG;
157 + val = rstate->bitmap[idx];
159 + if (!(val & (1UL << bit))) {
163 + if (val & (1UL << bit)) {
164 + val &= ~(1UL << bit);
167 + rstate->bitmap[idx] = val;
170 +typedef struct VmaBlob {
176 +static const VmaBlob *get_header_blob(VmaReader *vmar, uint32_t pos)
179 + assert(vmar->blob_hash);
181 + return g_hash_table_lookup(vmar->blob_hash, &pos);
184 +static const char *get_header_str(VmaReader *vmar, uint32_t pos)
186 + const VmaBlob *blob = get_header_blob(vmar, pos);
190 + const char *res = (char *)blob->data;
191 + if (res[blob->len-1] != '\0') {
198 +safe_read(int fd, unsigned char *buf, size_t count)
203 + n = read(fd, buf, count);
204 + } while (n < 0 && errno == EINTR);
210 +full_read(int fd, unsigned char *buf, size_t len)
218 + n = safe_read(fd, buf, len);
240 +void vma_reader_destroy(VmaReader *vmar)
244 + if (vmar->fd >= 0) {
248 + if (vmar->cdata_list) {
249 + g_list_free(vmar->cdata_list);
253 + for (i = 1; i < 256; i++) {
254 + if (vmar->rstate[i].bitmap) {
255 + g_free(vmar->rstate[i].bitmap);
257 + if (vmar->rstate[i].target) {
258 + blk_unref(vmar->rstate[i].target);
262 + if (vmar->md5csum) {
263 + g_checksum_free(vmar->md5csum);
266 + if (vmar->blob_hash) {
267 + g_hash_table_destroy(vmar->blob_hash);
270 + if (vmar->head_data) {
271 + g_free(vmar->head_data);
278 +static int vma_reader_read_head(VmaReader *vmar, Error **errp)
282 + assert(*errp == NULL);
284 + unsigned char md5sum[16];
288 + vmar->head_data = g_malloc(sizeof(VmaHeader));
290 + if (full_read(vmar->fd, vmar->head_data, sizeof(VmaHeader)) !=
291 + sizeof(VmaHeader)) {
292 + error_setg(errp, "can't read vma header - %s",
293 + errno ? g_strerror(errno) : "got EOF");
297 + VmaHeader *h = (VmaHeader *)vmar->head_data;
299 + if (h->magic != VMA_MAGIC) {
300 + error_setg(errp, "not a vma file - wrong magic number");
304 + uint32_t header_size = GUINT32_FROM_BE(h->header_size);
305 + int need = header_size - sizeof(VmaHeader);
307 + error_setg(errp, "wrong vma header size %d", header_size);
311 + vmar->head_data = g_realloc(vmar->head_data, header_size);
312 + h = (VmaHeader *)vmar->head_data;
314 + if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
316 + error_setg(errp, "can't read vma header data - %s",
317 + errno ? g_strerror(errno) : "got EOF");
321 + memcpy(md5sum, h->md5sum, 16);
322 + memset(h->md5sum, 0, 16);
324 + g_checksum_reset(vmar->md5csum);
325 + g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
327 + g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
329 + if (memcmp(md5sum, h->md5sum, 16) != 0) {
330 + error_setg(errp, "wrong vma header chechsum");
334 + /* we can modify header data after checksum verify */
335 + h->header_size = header_size;
337 + h->version = GUINT32_FROM_BE(h->version);
338 + if (h->version != 1) {
339 + error_setg(errp, "wrong vma version %d", h->version);
343 + h->ctime = GUINT64_FROM_BE(h->ctime);
344 + h->blob_buffer_offset = GUINT32_FROM_BE(h->blob_buffer_offset);
345 + h->blob_buffer_size = GUINT32_FROM_BE(h->blob_buffer_size);
347 + uint32_t bstart = h->blob_buffer_offset + 1;
348 + uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
350 + if (bstart <= sizeof(VmaHeader)) {
351 + error_setg(errp, "wrong vma blob buffer offset %d",
352 + h->blob_buffer_offset);
356 + if (bend > header_size) {
357 + error_setg(errp, "wrong vma blob buffer size %d/%d",
358 + h->blob_buffer_offset, h->blob_buffer_size);
362 + while ((bstart + 2) <= bend) {
363 + uint32_t size = vmar->head_data[bstart] +
364 + (vmar->head_data[bstart+1] << 8);
365 + if ((bstart + size + 2) <= bend) {
366 + VmaBlob *blob = g_new0(VmaBlob, 1);
367 + blob->start = bstart - h->blob_buffer_offset;
369 + blob->data = vmar->head_data + bstart + 2;
370 + g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
372 + bstart += size + 2;
377 + for (i = 1; i < 256; i++) {
378 + VmaDeviceInfoHeader *dih = &h->dev_info[i];
379 + uint32_t devname_ptr = GUINT32_FROM_BE(dih->devname_ptr);
380 + uint64_t size = GUINT64_FROM_BE(dih->size);
381 + const char *devname = get_header_str(vmar, devname_ptr);
383 + if (size && devname) {
385 + vmar->devinfo[i].size = size;
386 + vmar->devinfo[i].devname = devname;
388 + if (strcmp(devname, "vmstate") == 0) {
389 + vmar->vmstate_stream = i;
394 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
395 + uint32_t name_ptr = GUINT32_FROM_BE(h->config_names[i]);
396 + uint32_t data_ptr = GUINT32_FROM_BE(h->config_data[i]);
398 + if (!(name_ptr && data_ptr)) {
401 + const char *name = get_header_str(vmar, name_ptr);
402 + const VmaBlob *blob = get_header_blob(vmar, data_ptr);
404 + if (!(name && blob)) {
405 + error_setg(errp, "vma contains invalid data pointers");
409 + VmaConfigData *cdata = g_new0(VmaConfigData, 1);
410 + cdata->name = name;
411 + cdata->data = blob->data;
412 + cdata->len = blob->len;
414 + vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
420 +VmaReader *vma_reader_create(const char *filename, Error **errp)
425 + VmaReader *vmar = g_new0(VmaReader, 1);
427 + if (strcmp(filename, "-") == 0) {
430 + vmar->fd = open(filename, O_RDONLY);
433 + if (vmar->fd < 0) {
434 + error_setg(errp, "can't open file %s - %s\n", filename,
435 + g_strerror(errno));
439 + vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
440 + if (!vmar->md5csum) {
441 + error_setg(errp, "can't allocate cmsum\n");
445 + vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
448 + if (vma_reader_read_head(vmar, errp) < 0) {
456 + vma_reader_destroy(vmar);
462 +VmaHeader *vma_reader_get_header(VmaReader *vmar)
465 + assert(vmar->head_data);
467 + return (VmaHeader *)(vmar->head_data);
470 +GList *vma_reader_get_config_data(VmaReader *vmar)
473 + assert(vmar->head_data);
475 + return vmar->cdata_list;
478 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
483 + if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
484 + return &vmar->devinfo[dev_id];
490 +static void allocate_rstate(VmaReader *vmar, guint8 dev_id,
491 + BlockBackend *target, bool write_zeroes)
496 + vmar->rstate[dev_id].target = target;
497 + vmar->rstate[dev_id].write_zeroes = write_zeroes;
499 + int64_t size = vmar->devinfo[dev_id].size;
501 + int64_t bitmap_size = (size/BDRV_SECTOR_SIZE) +
502 + (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG - 1;
503 + bitmap_size /= (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG;
505 + vmar->rstate[dev_id].bitmap_size = bitmap_size;
506 + vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
508 + vmar->cluster_count += size/VMA_CLUSTER_SIZE;
511 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockBackend *target,
512 + bool write_zeroes, Error **errp)
515 + assert(target != NULL);
517 + assert(vmar->rstate[dev_id].target == NULL);
519 + int64_t size = blk_getlength(target);
520 + int64_t size_diff = size - vmar->devinfo[dev_id].size;
522 + /* storage types can have different size restrictions, so it
523 + * is not always possible to create an image with exact size.
524 + * So we tolerate a size difference up to 4MB.
526 + if ((size_diff < 0) || (size_diff > 4*1024*1024)) {
527 + error_setg(errp, "vma_reader_register_bs for stream %s failed - "
528 + "unexpected size %zd != %zd", vmar->devinfo[dev_id].devname,
529 + size, vmar->devinfo[dev_id].size);
533 + allocate_rstate(vmar, dev_id, target, write_zeroes);
538 +static ssize_t safe_write(int fd, void *buf, size_t count)
543 + n = write(fd, buf, count);
544 + } while (n < 0 && errno == EINTR);
549 +static size_t full_write(int fd, void *buf, size_t len)
557 + n = safe_write(fd, buf, len);
567 + /* incomplete write ? */
574 +static int restore_write_data(VmaReader *vmar, guint8 dev_id,
575 + BlockBackend *target, int vmstate_fd,
576 + unsigned char *buf, int64_t sector_num,
577 + int nb_sectors, Error **errp)
581 + if (dev_id == vmar->vmstate_stream) {
582 + if (vmstate_fd >= 0) {
583 + int len = nb_sectors * BDRV_SECTOR_SIZE;
584 + int res = full_write(vmstate_fd, buf, len);
586 + error_setg(errp, "write vmstate failed %d", res);
591 + int res = blk_pwrite(target, sector_num * BDRV_SECTOR_SIZE, nb_sectors * BDRV_SECTOR_SIZE, buf, 0);
593 + error_setg(errp, "blk_pwrite to %s failed (%d)",
594 + bdrv_get_device_name(blk_bs(target)), res);
601 +static int restore_extent(VmaReader *vmar, unsigned char *buf,
602 + int extent_size, int vmstate_fd,
603 + bool verbose, bool verify, Error **errp)
608 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
609 + int start = VMA_EXTENT_HEADER_SIZE;
612 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
613 + uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
614 + uint64_t cluster_num = block_info & 0xffffffff;
615 + uint8_t dev_id = (block_info >> 32) & 0xff;
616 + uint16_t mask = block_info >> (32+16);
617 + int64_t max_sector;
623 + VmaRestoreState *rstate = &vmar->rstate[dev_id];
624 + BlockBackend *target = NULL;
626 + if (dev_id != vmar->vmstate_stream) {
627 + target = rstate->target;
628 + if (!verify && !target) {
629 + error_setg(errp, "got wrong dev id %d", dev_id);
633 + if (vma_reader_get_bitmap(rstate, cluster_num)) {
634 + error_setg(errp, "found duplicated cluster %zd for stream %s",
635 + cluster_num, vmar->devinfo[dev_id].devname);
638 + vma_reader_set_bitmap(rstate, cluster_num, 1);
640 + max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
642 + max_sector = G_MAXINT64;
643 + if (cluster_num != vmar->vmstate_clusters) {
644 + error_setg(errp, "found out of order vmstate data");
647 + vmar->vmstate_clusters++;
650 + vmar->clusters_read++;
653 + time_t duration = time(NULL) - vmar->start_time;
654 + int percent = (vmar->clusters_read*100)/vmar->cluster_count;
655 + if (percent != vmar->clusters_read_per) {
656 + printf("progress %d%% (read %zd bytes, duration %zd sec)\n",
657 + percent, vmar->clusters_read*VMA_CLUSTER_SIZE,
660 + vmar->clusters_read_per = percent;
664 + /* try to write whole clusters to speedup restore */
665 + if (mask == 0xffff) {
666 + if ((start + VMA_CLUSTER_SIZE) > extent_size) {
667 + error_setg(errp, "short vma extent - too many blocks");
670 + int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
672 + int64_t end_sector = sector_num +
673 + VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
675 + if (end_sector > max_sector) {
676 + end_sector = max_sector;
679 + if (end_sector <= sector_num) {
680 + error_setg(errp, "got wrong block address - write beyond end");
685 + int nb_sectors = end_sector - sector_num;
686 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
687 + buf + start, sector_num, nb_sectors,
693 + start += VMA_CLUSTER_SIZE;
698 + for (j = 0; j < 16; j++) {
699 + int64_t sector_num = (cluster_num*VMA_CLUSTER_SIZE +
700 + j*VMA_BLOCK_SIZE)/BDRV_SECTOR_SIZE;
702 + int64_t end_sector = sector_num +
703 + VMA_BLOCK_SIZE/BDRV_SECTOR_SIZE;
704 + if (end_sector > max_sector) {
705 + end_sector = max_sector;
709 + if ((start + VMA_BLOCK_SIZE) > extent_size) {
710 + error_setg(errp, "short vma extent - too many blocks");
714 + if (end_sector <= sector_num) {
715 + error_setg(errp, "got wrong block address - "
716 + "write beyond end");
721 + int nb_sectors = end_sector - sector_num;
722 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
723 + buf + start, sector_num,
724 + nb_sectors, errp) < 0) {
729 + start += VMA_BLOCK_SIZE;
734 + if (end_sector > sector_num) {
735 + /* Todo: use bdrv_co_write_zeroes (but that need to
736 + * be run inside coroutine?)
738 + int nb_sectors = end_sector - sector_num;
739 + int zero_size = BDRV_SECTOR_SIZE*nb_sectors;
740 + vmar->zero_cluster_data += zero_size;
742 + vmar->partial_zero_cluster_data += zero_size;
745 + if (rstate->write_zeroes && !verify) {
746 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
747 + zero_vma_block, sector_num,
748 + nb_sectors, errp) < 0) {
760 + if (start != extent_size) {
761 + error_setg(errp, "vma extent error - missing blocks");
768 +static int vma_reader_restore_full(VmaReader *vmar, int vmstate_fd,
769 + bool verbose, bool verify,
773 + assert(vmar->head_data);
776 + unsigned char buf[VMA_MAX_EXTENT_SIZE];
778 + unsigned char md5sum[16];
779 + VmaHeader *h = (VmaHeader *)vmar->head_data;
781 + vmar->start_time = time(NULL);
784 + int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
786 + error_setg(errp, "read failed - %s", g_strerror(errno));
796 + if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
797 + error_setg(errp, "read short extent (%d bytes)", buf_pos);
801 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
803 + /* extract md5sum */
804 + memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
805 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
807 + g_checksum_reset(vmar->md5csum);
808 + g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
810 + g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
812 + if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
813 + error_setg(errp, "wrong vma extent header chechsum");
817 + if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
818 + error_setg(errp, "wrong vma extent uuid");
822 + if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
823 + error_setg(errp, "wrong vma extent header magic");
827 + int block_count = GUINT16_FROM_BE(ehead->block_count);
828 + int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
830 + if (buf_pos < extent_size) {
831 + error_setg(errp, "short vma extent (%d < %d)", buf_pos,
836 + if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
837 + verify, errp) < 0) {
841 + if (buf_pos > extent_size) {
842 + memmove(buf, buf + extent_size, buf_pos - extent_size);
843 + buf_pos = buf_pos - extent_size;
852 + for (i = 1; i < 256; i++) {
853 + VmaRestoreState *rstate = &vmar->rstate[i];
854 + if (!rstate->target) {
858 + if (blk_flush(rstate->target) < 0) {
859 + error_setg(errp, "vma blk_flush %s failed",
860 + vmar->devinfo[i].devname);
864 + if (vmar->devinfo[i].size &&
865 + (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
866 + assert(rstate->bitmap);
868 + int64_t cluster_num, end;
870 + end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
873 + for (cluster_num = 0; cluster_num < end; cluster_num++) {
874 + if (!vma_reader_get_bitmap(rstate, cluster_num)) {
875 + error_setg(errp, "detected missing cluster %zd "
876 + "for stream %s", cluster_num,
877 + vmar->devinfo[i].devname);
885 + if (vmar->clusters_read) {
886 + printf("total bytes read %zd, sparse bytes %zd (%.3g%%)\n",
887 + vmar->clusters_read*VMA_CLUSTER_SIZE,
888 + vmar->zero_cluster_data,
889 + (double)(100.0*vmar->zero_cluster_data)/
890 + (vmar->clusters_read*VMA_CLUSTER_SIZE));
892 + int64_t datasize = vmar->clusters_read*VMA_CLUSTER_SIZE-vmar->zero_cluster_data;
893 + if (datasize) { // this does not make sense for empty files
894 + printf("space reduction due to 4K zero blocks %.3g%%\n",
895 + (double)(100.0*vmar->partial_zero_cluster_data) / datasize);
898 + printf("vma archive contains no image data\n");
904 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
907 + return vma_reader_restore_full(vmar, vmstate_fd, verbose, false, errp);
910 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp)
914 + for (dev_id = 1; dev_id < 255; dev_id++) {
915 + if (vma_reader_get_device_info(vmar, dev_id)) {
916 + allocate_rstate(vmar, dev_id, NULL, false);
920 + return vma_reader_restore_full(vmar, -1, verbose, true, errp);
923 diff --git a/vma-writer.c b/vma-writer.c
925 index 0000000000..df4b20793d
930 + * VMA: Virtual Machine Archive
932 + * Copyright (C) 2012 Proxmox Server Solutions
935 + * Dietmar Maurer (dietmar@proxmox.com)
937 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
938 + * See the COPYING file in the top-level directory.
942 +#include "qemu/osdep.h"
944 +#include <uuid/uuid.h>
947 +#include "block/block.h"
948 +#include "monitor/monitor.h"
949 +#include "qemu/main-loop.h"
950 +#include "qemu/coroutine.h"
951 +#include "qemu/cutils.h"
952 +#include "qemu/memalign.h"
956 +#define DPRINTF(fmt, ...)\
957 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
959 +#define WRITE_BUFFERS 5
960 +#define HEADER_CLUSTERS 8
961 +#define HEADERBUF_SIZE (VMA_CLUSTER_SIZE*HEADER_CLUSTERS)
969 + bool header_written;
972 + /* we always write extents */
973 + unsigned char *outbuf;
974 + int outbuf_pos; /* in bytes */
975 + int outbuf_count; /* in VMA_BLOCKS */
976 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
978 + unsigned char *headerbuf;
980 + GChecksum *md5csum;
981 + CoMutex flush_lock;
982 + Coroutine *co_writer;
984 + /* drive informations */
985 + VmaStreamInfo stream_info[256];
986 + guint stream_count;
988 + guint8 vmstate_stream;
989 + uint32_t vmstate_clusters;
991 + /* header blob table */
992 + char *header_blob_table;
993 + uint32_t header_blob_table_size;
994 + uint32_t header_blob_table_pos;
996 + /* store for config blobs */
997 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
998 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
999 + uint32_t config_count;
1002 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1006 + if (vmaw->status < 0) {
1010 + vmaw->status = -1;
1012 + va_start(ap, fmt);
1013 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1016 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1019 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1022 + if (len > 65535) {
1026 + if (!vmaw->header_blob_table ||
1027 + (vmaw->header_blob_table_size <
1028 + (vmaw->header_blob_table_pos + len + 2))) {
1029 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1031 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1032 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1033 + 0, newsize - vmaw->header_blob_table_size);
1034 + vmaw->header_blob_table_size = newsize;
1037 + uint32_t cpos = vmaw->header_blob_table_pos;
1038 + vmaw->header_blob_table[cpos] = len & 255;
1039 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1040 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1041 + vmaw->header_blob_table_pos += len + 2;
1045 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1049 + size_t len = strlen(str) + 1;
1051 + return allocate_header_blob(vmaw, str, len);
1054 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1058 + assert(!vmaw->header_written);
1059 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1063 + gchar *basename = g_path_get_basename(name);
1064 + uint32_t name_ptr = allocate_header_string(vmaw, basename);
1071 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1076 + vmaw->config_names[vmaw->config_count] = name_ptr;
1077 + vmaw->config_data[vmaw->config_count] = data_ptr;
1079 + vmaw->config_count++;
1084 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1089 + assert(!vmaw->status);
1091 + if (vmaw->header_written) {
1092 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1093 + "already written");
1097 + guint n = vmaw->stream_count + 1;
1099 + /* we can have dev_ids form 1 to 255 (0 reserved)
1100 + * 255(-1) reseverd for safety
1103 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1104 + "too many drives");
1109 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1110 + "got strange size %zd", size);
1114 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1116 + vmaw->stream_info[n].devname = g_strdup(devname);
1117 + vmaw->stream_info[n].size = size;
1119 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1122 + vmaw->stream_count = n;
1124 + if (strcmp(devname, "vmstate") == 0) {
1125 + vmaw->vmstate_stream = n;
1131 +static void coroutine_fn yield_until_fd_writable(int fd)
1133 + assert(qemu_in_coroutine());
1134 + AioContext *ctx = qemu_get_current_aio_context();
1135 + aio_set_fd_handler(ctx, fd, false, NULL, (IOHandler *)qemu_coroutine_enter,
1136 + NULL, NULL, qemu_coroutine_self());
1137 + qemu_coroutine_yield();
1138 + aio_set_fd_handler(ctx, fd, false, NULL, NULL, NULL, NULL, NULL);
1141 +static ssize_t coroutine_fn
1142 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1144 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1148 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1153 + assert(vmaw->co_writer == NULL);
1155 + vmaw->co_writer = qemu_coroutine_self();
1157 + while (done < bytes) {
1158 + if (vmaw->status < 0) {
1159 + DPRINTF("vma_queue_write detected canceled backup\n");
1163 + yield_until_fd_writable(vmaw->fd);
1164 + ret = write(vmaw->fd, buf + done, bytes - done);
1167 + DPRINTF("vma_queue_write written %zd %zd\n", done, ret);
1168 + } else if (ret < 0) {
1169 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1172 + vma_writer_set_error(vmaw, "vma_queue_write: write error - %s",
1173 + g_strerror(errno));
1174 + done = -1; /* always return failure for partial writes */
1177 + } else if (ret == 0) {
1178 + /* should not happen - simply try again */
1182 + vmaw->co_writer = NULL;
1184 + return (done == bytes) ? bytes : -1;
1187 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp)
1191 + assert(sizeof(VmaHeader) == (4096 + 8192));
1192 + assert(G_STRUCT_OFFSET(VmaHeader, config_names) == 2044);
1193 + assert(G_STRUCT_OFFSET(VmaHeader, config_data) == 3068);
1194 + assert(G_STRUCT_OFFSET(VmaHeader, dev_info) == 4096);
1195 + assert(sizeof(VmaExtentHeader) == 512);
1197 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1200 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1201 + if (!vmaw->md5csum) {
1202 + error_setg(errp, "can't allocate cmsum\n");
1206 + if (strstart(filename, "exec:", &p)) {
1207 + vmaw->cmd = popen(p, "w");
1208 + if (vmaw->cmd == NULL) {
1209 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1210 + g_strerror(errno));
1213 + vmaw->fd = fileno(vmaw->cmd);
1215 + /* try to use O_NONBLOCK */
1216 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1221 + const char *tmp_id_str;
1223 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1224 + oflags = O_NONBLOCK|O_WRONLY;
1225 + vmaw->fd = qemu_open(filename, oflags, errp);
1226 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1227 + oflags = O_NONBLOCK|O_WRONLY;
1228 + vmaw->fd = qemu_open(filename, oflags, errp);
1229 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1230 + vmaw->fd = monitor_get_fd(monitor_cur(), tmp_id_str, errp);
1231 + if (vmaw->fd < 0) {
1234 + /* try to use O_NONBLOCK */
1235 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1237 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY|O_EXCL;
1238 + vmaw->fd = qemu_create(filename, oflags, 0644, errp);
1241 + if (vmaw->fd < 0) {
1242 + error_setg(errp, "can't open file %s - %s\n", filename,
1243 + g_strerror(errno));
1248 + /* we use O_DIRECT, so we need to align IO buffers */
1250 + vmaw->outbuf = qemu_memalign(512, VMA_MAX_EXTENT_SIZE);
1251 + vmaw->headerbuf = qemu_memalign(512, HEADERBUF_SIZE);
1253 + vmaw->outbuf_count = 0;
1254 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1256 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1258 + qemu_co_mutex_init(&vmaw->flush_lock);
1260 + uuid_copy(vmaw->uuid, uuid);
1267 + pclose(vmaw->cmd);
1268 + } else if (vmaw->fd >= 0) {
1272 + if (vmaw->md5csum) {
1273 + g_checksum_free(vmaw->md5csum);
1282 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1285 + unsigned char *buf = vmaw->headerbuf;
1286 + VmaHeader *head = (VmaHeader *)buf;
1290 + DPRINTF("VMA WRITE HEADER\n");
1292 + if (vmaw->status < 0) {
1293 + return vmaw->status;
1296 + memset(buf, 0, HEADERBUF_SIZE);
1298 + head->magic = VMA_MAGIC;
1299 + head->version = GUINT32_TO_BE(1); /* v1 */
1300 + memcpy(head->uuid, vmaw->uuid, 16);
1302 + time_t ctime = time(NULL);
1303 + head->ctime = GUINT64_TO_BE(ctime);
1305 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1306 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1307 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1310 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1311 + for (i = 1; i <= 254; i++) {
1312 + VmaStreamInfo *si = &vmaw->stream_info[i];
1314 + assert(si->devname);
1315 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1316 + if (!devname_ptr) {
1319 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1320 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1324 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1325 + head->header_size = GUINT32_TO_BE(header_size);
1327 + if (header_size > HEADERBUF_SIZE) {
1328 + return -1; /* just to be sure */
1331 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1332 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1333 + vmaw->header_blob_table_size);
1334 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1335 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1337 + g_checksum_reset(vmaw->md5csum);
1338 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1340 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1342 + return vma_queue_write(vmaw, buf, header_size);
1345 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1352 + if (vmaw->status < 0) {
1353 + return vmaw->status;
1356 + if (!vmaw->header_written) {
1357 + vmaw->header_written = true;
1358 + ret = vma_write_header(vmaw);
1360 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1365 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1368 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1370 + ehead->magic = VMA_EXTENT_MAGIC;
1371 + ehead->reserved1 = 0;
1373 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1374 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1377 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1380 + ehead->block_count = GUINT16_TO_BE(block_count);
1382 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1383 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1385 + g_checksum_reset(vmaw->md5csum);
1386 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1388 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1390 + int bytes = vmaw->outbuf_pos;
1391 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1392 + if (ret != bytes) {
1393 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1396 + vmaw->outbuf_count = 0;
1397 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1399 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1400 + vmaw->outbuf_block_info[i] = 0;
1403 + return vmaw->status;
1406 +static int vma_count_open_streams(VmaWriter *vmaw)
1408 + g_assert(vmaw != NULL);
1411 + int open_drives = 0;
1412 + for (i = 0; i <= 255; i++) {
1413 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1418 + return open_drives;
1423 + * You need to call this if the vma archive does not contain
1424 + * any data stream.
1427 +vma_writer_flush_output(VmaWriter *vmaw)
1429 + qemu_co_mutex_lock(&vmaw->flush_lock);
1430 + int ret = vma_writer_flush(vmaw);
1431 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1433 + vma_writer_set_error(vmaw, "vma_writer_flush_header failed");
1439 + * all jobs should call this when there is no more data
1440 + * Returns: number of remaining stream (0 ==> finished)
1443 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1445 + g_assert(vmaw != NULL);
1447 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1448 + if (!vmaw->stream_info[dev_id].size) {
1449 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1450 + "no such stream %d", dev_id);
1453 + if (vmaw->stream_info[dev_id].finished) {
1454 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1455 + "stream already closed %d", dev_id);
1459 + vmaw->stream_info[dev_id].finished = true;
1461 + int open_drives = vma_count_open_streams(vmaw);
1463 + if (open_drives <= 0) {
1464 + DPRINTF("vma_writer_set_status all drives completed\n");
1465 + vma_writer_flush_output(vmaw);
1468 + return open_drives;
1471 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1475 + g_assert(vmaw != NULL);
1478 + status->status = vmaw->status;
1479 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1480 + for (i = 0; i <= 255; i++) {
1481 + status->stream_info[i] = vmaw->stream_info[i];
1484 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1487 + status->closed = vmaw->closed;
1489 + return vmaw->status;
1492 +static int vma_writer_get_buffer(VmaWriter *vmaw)
1496 + qemu_co_mutex_lock(&vmaw->flush_lock);
1498 + /* wait until buffer is available */
1499 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1500 + ret = vma_writer_flush(vmaw);
1502 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1507 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1513 +int64_t coroutine_fn
1514 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1515 + const unsigned char *buf, size_t *zero_bytes)
1517 + g_assert(vmaw != NULL);
1518 + g_assert(zero_bytes != NULL);
1522 + if (vmaw->status < 0) {
1523 + return vmaw->status;
1526 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1527 + vma_writer_set_error(vmaw, "vma_writer_write: "
1528 + "no such stream %d", dev_id);
1532 + if (vmaw->stream_info[dev_id].finished) {
1533 + vma_writer_set_error(vmaw, "vma_writer_write: "
1534 + "stream already closed %d", dev_id);
1539 + if (cluster_num >= (((uint64_t)1)<<32)) {
1540 + vma_writer_set_error(vmaw, "vma_writer_write: "
1541 + "cluster number out of range");
1545 + if (dev_id == vmaw->vmstate_stream) {
1546 + if (cluster_num != vmaw->vmstate_clusters) {
1547 + vma_writer_set_error(vmaw, "vma_writer_write: "
1548 + "non sequential vmstate write");
1550 + vmaw->vmstate_clusters++;
1551 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1552 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1556 + /* wait until buffer is available */
1557 + if (vma_writer_get_buffer(vmaw) < 0) {
1558 + vma_writer_set_error(vmaw, "vma_writer_write: "
1559 + "vma_writer_get_buffer failed");
1563 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1565 + uint64_t dev_size = vmaw->stream_info[dev_id].size;
1566 + uint16_t mask = 0;
1571 + uint64_t byte_offset = cluster_num * VMA_CLUSTER_SIZE;
1572 + for (i = 0; i < 16; i++) {
1573 + const unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1575 + // Note: If the source is not 64k-aligned, we might reach 4k blocks
1576 + // after the end of the device. Always mark these as zero in the
1577 + // mask, so the restore handles them correctly.
1578 + if (byte_offset < dev_size &&
1579 + !buffer_is_zero(vmablock, VMA_BLOCK_SIZE))
1582 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock,
1585 + // prevent memory leakage on unaligned last block
1586 + if (byte_offset + VMA_BLOCK_SIZE > dev_size) {
1587 + uint64_t real_data_in_block = dev_size - byte_offset;
1588 + memset(vmaw->outbuf + vmaw->outbuf_pos + real_data_in_block,
1589 + 0, VMA_BLOCK_SIZE - real_data_in_block);
1592 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1594 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1595 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1596 + *zero_bytes += VMA_BLOCK_SIZE;
1599 + byte_offset += VMA_BLOCK_SIZE;
1603 + DPRINTF("VMA WRITE %zd ZERO CLUSTER\n", cluster_num);
1604 + vmaw->stream_info[dev_id].zero_bytes += VMA_CLUSTER_SIZE;
1605 + *zero_bytes += VMA_CLUSTER_SIZE;
1608 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1609 + block_info |= ((uint64_t)dev_id) << 32;
1610 + block_info |= (cluster_num & 0xffffffff);
1611 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1613 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1615 + vmaw->outbuf_count++;
1617 + /** NOTE: We allways write whole clusters, but we correctly set
1618 + * transferred bytes. So transferred == size when when everything
1621 + size_t transferred = VMA_CLUSTER_SIZE;
1623 + if (dev_id != vmaw->vmstate_stream) {
1624 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1625 + if (last > dev_size) {
1626 + uint64_t diff = last - dev_size;
1627 + if (diff >= VMA_CLUSTER_SIZE) {
1628 + vma_writer_set_error(vmaw, "vma_writer_write: "
1629 + "read after last cluster");
1632 + transferred -= diff;
1636 + vmaw->stream_info[dev_id].transferred += transferred;
1638 + return transferred;
1641 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp)
1643 + if (vmaw->status < 0 && *errp == NULL) {
1644 + error_setg(errp, "%s", vmaw->errmsg);
1648 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1650 + g_assert(vmaw != NULL);
1654 + qemu_co_mutex_lock(&vmaw->flush_lock); // wait for pending writes
1656 + assert(vmaw->co_writer == NULL);
1659 + if (pclose(vmaw->cmd) < 0) {
1660 + vma_writer_set_error(vmaw, "vma_writer_close: "
1661 + "pclose failed - %s", g_strerror(errno));
1664 + if (close(vmaw->fd) < 0) {
1665 + vma_writer_set_error(vmaw, "vma_writer_close: "
1666 + "close failed - %s", g_strerror(errno));
1670 + for (i = 0; i <= 255; i++) {
1671 + VmaStreamInfo *si = &vmaw->stream_info[i];
1673 + if (!si->finished) {
1674 + vma_writer_set_error(vmaw, "vma_writer_close: "
1675 + "detected open stream '%s'", si->devname);
1676 + } else if ((si->transferred != si->size) &&
1677 + (i != vmaw->vmstate_stream)) {
1678 + vma_writer_set_error(vmaw, "vma_writer_close: "
1679 + "incomplete stream '%s' (%zd != %zd)",
1680 + si->devname, si->transferred, si->size);
1685 + for (i = 0; i <= 255; i++) {
1686 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1691 + if (vmaw->status < 0 && *errp == NULL) {
1692 + error_setg(errp, "%s", vmaw->errmsg);
1695 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1697 + return vmaw->status;
1700 +void vma_writer_destroy(VmaWriter *vmaw)
1706 + for (i = 0; i <= 255; i++) {
1707 + if (vmaw->stream_info[i].devname) {
1708 + g_free(vmaw->stream_info[i].devname);
1712 + if (vmaw->md5csum) {
1713 + g_checksum_free(vmaw->md5csum);
1716 + qemu_vfree(vmaw->headerbuf);
1717 + qemu_vfree(vmaw->outbuf);
1720 diff --git a/vma.c b/vma.c
1721 new file mode 100644
1722 index 0000000000..e8dffb43e0
1727 + * VMA: Virtual Machine Archive
1729 + * Copyright (C) 2012-2013 Proxmox Server Solutions
1732 + * Dietmar Maurer (dietmar@proxmox.com)
1734 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1735 + * See the COPYING file in the top-level directory.
1739 +#include "qemu/osdep.h"
1743 +#include "qemu/module.h"
1744 +#include "qemu/error-report.h"
1745 +#include "qemu/main-loop.h"
1746 +#include "qemu/cutils.h"
1747 +#include "qemu/memalign.h"
1748 +#include "qapi/qmp/qdict.h"
1749 +#include "sysemu/block-backend.h"
1751 +static void help(void)
1753 + const char *help_msg =
1754 + "usage: vma command [command options]\n"
1756 + "vma list <filename>\n"
1757 + "vma config <filename> [-c config]\n"
1758 + "vma create <filename> [-c config] pathname ...\n"
1759 + "vma extract <filename> [-r <fifo>] <targetdir>\n"
1760 + "vma verify <filename> [-v]\n"
1763 + printf("%s", help_msg);
1767 +static const char *extract_devname(const char *path, char **devname, int index)
1771 + const char *sep = strchr(path, '=');
1774 + *devname = g_strndup(path, sep - path);
1778 + *devname = g_strdup_printf("disk%d", index);
1787 +static void print_content(VmaReader *vmar)
1791 + VmaHeader *head = vma_reader_get_header(vmar);
1793 + GList *l = vma_reader_get_config_data(vmar);
1794 + while (l && l->data) {
1795 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1796 + l = g_list_next(l);
1797 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1801 + VmaDeviceInfo *di;
1802 + for (i = 1; i < 255; i++) {
1803 + di = vma_reader_get_device_info(vmar, i);
1805 + if (strcmp(di->devname, "vmstate") == 0) {
1806 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1808 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1809 + i, di->size, di->devname);
1813 + /* ctime is the last entry we print */
1814 + printf("CTIME: %s", ctime(&head->ctime));
1818 +static int list_content(int argc, char **argv)
1821 + const char *filename;
1824 + c = getopt(argc, argv, "h");
1834 + g_assert_not_reached();
1838 + /* Get the filename */
1839 + if ((optind + 1) != argc) {
1842 + filename = argv[optind++];
1844 + Error *errp = NULL;
1845 + VmaReader *vmar = vma_reader_create(filename, &errp);
1848 + g_error("%s", error_get_pretty(errp));
1851 + print_content(vmar);
1853 + vma_reader_destroy(vmar);
1858 +typedef struct RestoreMap {
1862 + uint64_t throttling_bps;
1863 + char *throttling_group;
1868 +static bool try_parse_option(char **line, const char *optname, char **out, const char *inbuf) {
1869 + size_t optlen = strlen(optname);
1870 + if (strncmp(*line, optname, optlen) != 0 || (*line)[optlen] != '=') {
1874 + g_error("read map failed - duplicate value for option '%s'", optname);
1876 + char *value = (*line) + optlen + 1; /* including a '=' */
1877 + char *colon = strchr(value, ':');
1879 + g_error("read map failed - option '%s' not terminated ('%s')",
1883 + *out = g_strndup(value, colon - value);
1887 +static uint64_t verify_u64(const char *text) {
1889 + const char *endptr = NULL;
1890 + if (qemu_strtou64(text, &endptr, 0, &value) != 0 || !endptr || *endptr) {
1891 + g_error("read map failed - not a number: %s", text);
1896 +static int extract_content(int argc, char **argv)
1900 + const char *filename;
1901 + const char *dirname;
1902 + const char *readmap = NULL;
1905 + c = getopt(argc, argv, "hvr:");
1925 + /* Get the filename */
1926 + if ((optind + 2) != argc) {
1929 + filename = argv[optind++];
1930 + dirname = argv[optind++];
1932 + Error *errp = NULL;
1933 + VmaReader *vmar = vma_reader_create(filename, &errp);
1936 + g_error("%s", error_get_pretty(errp));
1939 + if (mkdir(dirname, 0777) < 0) {
1940 + g_error("unable to create target directory %s - %s",
1941 + dirname, g_strerror(errno));
1944 + GList *l = vma_reader_get_config_data(vmar);
1945 + while (l && l->data) {
1946 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1947 + l = g_list_next(l);
1948 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
1949 + GError *err = NULL;
1950 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
1952 + g_error("unable to write file: %s", err->message);
1956 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
1959 + print_content(vmar);
1961 + FILE *map = fopen(readmap, "r");
1963 + g_error("unable to open fifo %s - %s", readmap, g_strerror(errno));
1968 + char *line = fgets(inbuf, sizeof(inbuf), map);
1969 + char *format = NULL;
1971 + char *group = NULL;
1972 + char *cache = NULL;
1973 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
1976 + int len = strlen(line);
1977 + if (line[len - 1] == '\n') {
1978 + line[len - 1] = '\0';
1985 + if (!try_parse_option(&line, "format", &format, inbuf) &&
1986 + !try_parse_option(&line, "throttling.bps", &bps, inbuf) &&
1987 + !try_parse_option(&line, "throttling.group", &group, inbuf) &&
1988 + !try_parse_option(&line, "cache", &cache, inbuf))
1994 + uint64_t bps_value = 0;
1996 + bps_value = verify_u64(bps);
2002 + if (line[0] == '0' && line[1] == ':') {
2004 + write_zero = false;
2005 + } else if (line[0] == '1' && line[1] == ':') {
2007 + write_zero = true;
2009 + g_error("read map failed - parse error ('%s')", inbuf);
2012 + char *devname = NULL;
2013 + path = extract_devname(path, &devname, -1);
2015 + g_error("read map failed - no dev name specified ('%s')",
2019 + RestoreMap *map = g_new0(RestoreMap, 1);
2020 + map->devname = g_strdup(devname);
2021 + map->path = g_strdup(path);
2022 + map->format = format;
2023 + map->throttling_bps = bps_value;
2024 + map->throttling_group = group;
2025 + map->cache = cache;
2026 + map->write_zero = write_zero;
2028 + g_hash_table_insert(devmap, map->devname, map);
2034 + int vmstate_fd = -1;
2035 + guint8 vmstate_stream = 0;
2037 + for (i = 1; i < 255; i++) {
2038 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2039 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2040 + vmstate_stream = i;
2041 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2042 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2043 + if (vmstate_fd < 0) {
2044 + g_error("create vmstate file '%s' failed - %s", statefn,
2045 + g_strerror(errno));
2049 + char *devfn = NULL;
2050 + const char *format = NULL;
2051 + uint64_t throttling_bps = 0;
2052 + const char *throttling_group = NULL;
2053 + const char *cache = NULL;
2054 + int flags = BDRV_O_RDWR;
2055 + bool write_zero = true;
2057 + BlockBackend *blk = NULL;
2061 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2062 + if (map == NULL) {
2063 + g_error("no device name mapping for %s", di->devname);
2065 + devfn = map->path;
2066 + format = map->format;
2067 + throttling_bps = map->throttling_bps;
2068 + throttling_group = map->throttling_group;
2069 + cache = map->cache;
2070 + write_zero = map->write_zero;
2072 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2073 + dirname, di->devname);
2074 + printf("DEVINFO %s %zd\n", devfn, di->size);
2076 + bdrv_img_create(devfn, "raw", NULL, NULL, NULL, di->size,
2077 + flags, true, &errp);
2079 + g_error("can't create file %s: %s", devfn,
2080 + error_get_pretty(errp));
2083 + /* Note: we created an empty file above, so there is no
2084 + * need to write zeroes (so we generate a sparse file)
2086 + write_zero = false;
2089 + size_t devlen = strlen(devfn);
2090 + QDict *options = NULL;
2091 + bool writethrough;
2093 + /* explicit format from commandline */
2094 + options = qdict_new();
2095 + qdict_put_str(options, "driver", format);
2096 + } else if ((devlen > 4 && strcmp(devfn+devlen-4, ".raw") == 0) ||
2097 + strncmp(devfn, "/dev/", 5) == 0)
2099 + /* This part is now deprecated for PVE as well (just as qemu
2100 + * deprecated not specifying an explicit raw format, too.
2102 + /* explicit raw format */
2103 + options = qdict_new();
2104 + qdict_put_str(options, "driver", "raw");
2106 + if (cache && bdrv_parse_cache_mode(cache, &flags, &writethrough)) {
2107 + g_error("invalid cache option: %s\n", cache);
2110 + if (errp || !(blk = blk_new_open(devfn, NULL, options, flags, &errp))) {
2111 + g_error("can't open file %s - %s", devfn,
2112 + error_get_pretty(errp));
2116 + blk_set_enable_write_cache(blk, !writethrough);
2119 + if (throttling_group) {
2120 + blk_io_limits_enable(blk, throttling_group);
2123 + if (throttling_bps) {
2124 + if (!throttling_group) {
2125 + blk_io_limits_enable(blk, devfn);
2128 + ThrottleConfig cfg;
2129 + throttle_config_init(&cfg);
2130 + cfg.buckets[THROTTLE_BPS_WRITE].avg = throttling_bps;
2131 + Error *err = NULL;
2132 + if (!throttle_is_valid(&cfg, &err)) {
2133 + error_report_err(err);
2134 + g_error("failed to apply throttling");
2136 + blk_set_io_limits(blk, &cfg);
2139 + if (vma_reader_register_bs(vmar, i, blk, write_zero, &errp) < 0) {
2140 + g_error("%s", error_get_pretty(errp));
2149 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2150 + g_error("restore failed - %s", error_get_pretty(errp));
2154 + for (i = 1; i < 255; i++) {
2155 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2156 + if (di && (i != vmstate_stream)) {
2157 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2158 + dirname, di->devname);
2159 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2160 + dirname, di->devname);
2161 + if (rename(tmpfn, fn) != 0) {
2162 + g_error("rename %s to %s failed - %s",
2163 + tmpfn, fn, g_strerror(errno));
2169 + vma_reader_destroy(vmar);
2176 +static int verify_content(int argc, char **argv)
2180 + const char *filename;
2183 + c = getopt(argc, argv, "hv");
2200 + /* Get the filename */
2201 + if ((optind + 1) != argc) {
2204 + filename = argv[optind++];
2206 + Error *errp = NULL;
2207 + VmaReader *vmar = vma_reader_create(filename, &errp);
2210 + g_error("%s", error_get_pretty(errp));
2214 + print_content(vmar);
2217 + if (vma_reader_verify(vmar, verbose, &errp) < 0) {
2218 + g_error("verify failed - %s", error_get_pretty(errp));
2221 + vma_reader_destroy(vmar);
2228 +typedef struct BackupJob {
2229 + BlockBackend *target;
2235 +#define BACKUP_SECTORS_PER_CLUSTER (VMA_CLUSTER_SIZE / BDRV_SECTOR_SIZE)
2237 +static void coroutine_fn backup_run_empty(void *opaque)
2239 + VmaWriter *vmaw = (VmaWriter *)opaque;
2241 + vma_writer_flush_output(vmaw);
2243 + Error *err = NULL;
2244 + if (vma_writer_close(vmaw, &err) != 0) {
2245 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2249 +static void coroutine_fn backup_run(void *opaque)
2251 + BackupJob *job = (BackupJob *)opaque;
2253 + QEMUIOVector qiov;
2255 + int64_t start, end;
2258 + unsigned char *buf = blk_blockalign(job->target, VMA_CLUSTER_SIZE);
2261 + end = DIV_ROUND_UP(job->len / BDRV_SECTOR_SIZE,
2262 + BACKUP_SECTORS_PER_CLUSTER);
2264 + for (; start < end; start++) {
2265 + iov.iov_base = buf;
2266 + iov.iov_len = VMA_CLUSTER_SIZE;
2267 + qemu_iovec_init_external(&qiov, &iov, 1);
2269 + ret = blk_co_preadv(job->target, start * VMA_CLUSTER_SIZE,
2270 + VMA_CLUSTER_SIZE, &qiov, 0);
2272 + vma_writer_set_error(job->vmaw, "read error", -1);
2277 + if (vma_writer_write(job->vmaw, job->dev_id, start, buf, &zb) < 0) {
2278 + vma_writer_set_error(job->vmaw, "backup_dump_cb vma_writer_write failed", -1);
2285 + if (vma_writer_close_stream(job->vmaw, job->dev_id) <= 0) {
2286 + Error *err = NULL;
2287 + if (vma_writer_close(job->vmaw, &err) != 0) {
2288 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2294 +static int create_archive(int argc, char **argv)
2298 + const char *archivename;
2299 + GList *backup_coroutines = NULL;
2300 + GList *config_files = NULL;
2303 + c = getopt(argc, argv, "hvc:");
2313 + config_files = g_list_append(config_files, optarg);
2319 + g_assert_not_reached();
2324 + /* make sure we an archive name */
2325 + if ((optind + 1) > argc) {
2329 + archivename = argv[optind++];
2332 + uuid_generate(uuid);
2334 + Error *local_err = NULL;
2335 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, &local_err);
2337 + if (vmaw == NULL) {
2338 + g_error("%s", error_get_pretty(local_err));
2341 + GList *l = config_files;
2342 + while (l && l->data) {
2343 + char *name = l->data;
2344 + char *cdata = NULL;
2346 + GError *err = NULL;
2347 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2348 + unlink(archivename);
2349 + g_error("Unable to read file: %s", err->message);
2352 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2353 + unlink(archivename);
2354 + g_error("Unable to append config data %s (len = %zd)",
2357 + l = g_list_next(l);
2361 + while (optind < argc) {
2362 + const char *path = argv[optind++];
2363 + char *devname = NULL;
2364 + path = extract_devname(path, &devname, devcount++);
2366 + Error *errp = NULL;
2367 + BlockBackend *target;
2369 + target = blk_new_open(path, NULL, NULL, 0, &errp);
2371 + unlink(archivename);
2372 + g_error("bdrv_open '%s' failed - %s", path, error_get_pretty(errp));
2374 + int64_t size = blk_getlength(target);
2375 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2376 + if (dev_id <= 0) {
2377 + unlink(archivename);
2378 + g_error("vma_writer_register_stream '%s' failed", devname);
2381 + BackupJob *job = g_new0(BackupJob, 1);
2383 + job->target = target;
2385 + job->dev_id = dev_id;
2387 + Coroutine *co = qemu_coroutine_create(backup_run, job);
2388 + // Don't enter coroutine yet, because it might write the header before
2389 + // all streams can be registered.
2390 + backup_coroutines = g_list_append(backup_coroutines, co);
2393 + VmaStatus vmastat;
2395 + int last_percent = -1;
2398 + GList *entry = backup_coroutines;
2399 + while (entry && entry->data) {
2400 + Coroutine *co = entry->data;
2401 + qemu_coroutine_enter(co);
2402 + entry = g_list_next(entry);
2406 + main_loop_wait(false);
2407 + vma_writer_get_status(vmaw, &vmastat);
2411 + uint64_t total = 0;
2412 + uint64_t transferred = 0;
2413 + uint64_t zero_bytes = 0;
2416 + for (i = 0; i < 256; i++) {
2417 + if (vmastat.stream_info[i].size) {
2418 + total += vmastat.stream_info[i].size;
2419 + transferred += vmastat.stream_info[i].transferred;
2420 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2423 + percent = (transferred*100)/total;
2424 + if (percent != last_percent) {
2425 + fprintf(stderr, "progress %d%% %zd/%zd %zd\n", percent,
2426 + transferred, total, zero_bytes);
2429 + last_percent = percent;
2433 + if (vmastat.closed) {
2438 + Coroutine *co = qemu_coroutine_create(backup_run_empty, vmaw);
2439 + qemu_coroutine_enter(co);
2441 + main_loop_wait(false);
2442 + vma_writer_get_status(vmaw, &vmastat);
2443 + if (vmastat.closed) {
2451 + vma_writer_get_status(vmaw, &vmastat);
2454 + for (i = 0; i < 256; i++) {
2455 + VmaStreamInfo *si = &vmastat.stream_info[i];
2457 + fprintf(stderr, "image %s: size=%zd zeros=%zd saved=%zd\n",
2458 + si->devname, si->size, si->zero_bytes,
2459 + si->size - si->zero_bytes);
2464 + if (vmastat.status < 0) {
2465 + unlink(archivename);
2466 + g_error("creating vma archive failed");
2469 + g_list_free(backup_coroutines);
2470 + g_list_free(config_files);
2471 + vma_writer_destroy(vmaw);
2475 +static int dump_config(int argc, char **argv)
2478 + const char *filename;
2479 + const char *config_name = "qemu-server.conf";
2482 + c = getopt(argc, argv, "hc:");
2492 + config_name = optarg;
2499 + /* Get the filename */
2500 + if ((optind + 1) != argc) {
2503 + filename = argv[optind++];
2505 + Error *errp = NULL;
2506 + VmaReader *vmar = vma_reader_create(filename, &errp);
2509 + g_error("%s", error_get_pretty(errp));
2513 + GList *l = vma_reader_get_config_data(vmar);
2514 + while (l && l->data) {
2515 + VmaConfigData *cdata = (VmaConfigData *)l->data;
2516 + l = g_list_next(l);
2517 + if (strcmp(cdata->name, config_name) == 0) {
2519 + fwrite(cdata->data, cdata->len, 1, stdout);
2524 + vma_reader_destroy(vmar);
2529 + fprintf(stderr, "unable to find configuration data '%s'\n", config_name);
2536 +int main(int argc, char **argv)
2538 + const char *cmdname;
2539 + Error *main_loop_err = NULL;
2541 + error_init(argv[0]);
2542 + module_call_init(MODULE_INIT_TRACE);
2543 + qemu_init_exec_dir(argv[0]);
2545 + if (qemu_init_main_loop(&main_loop_err)) {
2546 + g_error("%s", error_get_pretty(main_loop_err));
2550 + module_call_init(MODULE_INIT_QOM);
2556 + cmdname = argv[1];
2560 + if (!strcmp(cmdname, "list")) {
2561 + return list_content(argc, argv);
2562 + } else if (!strcmp(cmdname, "create")) {
2563 + return create_archive(argc, argv);
2564 + } else if (!strcmp(cmdname, "extract")) {
2565 + return extract_content(argc, argv);
2566 + } else if (!strcmp(cmdname, "verify")) {
2567 + return verify_content(argc, argv);
2568 + } else if (!strcmp(cmdname, "config")) {
2569 + return dump_config(argc, argv);
2575 diff --git a/vma.h b/vma.h
2576 new file mode 100644
2577 index 0000000000..c895c97f6d
2582 + * VMA: Virtual Machine Archive
2584 + * Copyright (C) Proxmox Server Solutions
2587 + * Dietmar Maurer (dietmar@proxmox.com)
2589 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2590 + * See the COPYING file in the top-level directory.
2594 +#ifndef BACKUP_VMA_H
2595 +#define BACKUP_VMA_H
2597 +#include <uuid/uuid.h>
2598 +#include "qapi/error.h"
2599 +#include "block/block.h"
2601 +#define VMA_BLOCK_BITS 12
2602 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2603 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2604 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2606 +#if VMA_CLUSTER_SIZE != 65536
2607 +#error unexpected cluster size
2610 +#define VMA_EXTENT_HEADER_SIZE 512
2611 +#define VMA_BLOCKS_PER_EXTENT 59
2612 +#define VMA_MAX_CONFIGS 256
2614 +#define VMA_MAX_EXTENT_SIZE \
2615 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2616 +#if VMA_MAX_EXTENT_SIZE != 3867136
2617 +#error unexpected VMA_EXTENT_SIZE
2620 +/* File Format Definitions */
2622 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2623 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2625 +typedef struct VmaDeviceInfoHeader {
2626 + uint32_t devname_ptr; /* offset into blob_buffer table */
2627 + uint32_t reserved0;
2628 + uint64_t size; /* device size in bytes */
2629 + uint64_t reserved1;
2630 + uint64_t reserved2;
2631 +} VmaDeviceInfoHeader;
2633 +typedef struct VmaHeader {
2636 + unsigned char uuid[16];
2638 + unsigned char md5sum[16];
2640 + uint32_t blob_buffer_offset;
2641 + uint32_t blob_buffer_size;
2642 + uint32_t header_size;
2644 + unsigned char reserved[1984];
2646 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2647 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2649 + uint32_t reserved1;
2651 + VmaDeviceInfoHeader dev_info[256];
2654 +typedef struct VmaExtentHeader {
2656 + uint16_t reserved1;
2657 + uint16_t block_count;
2658 + unsigned char uuid[16];
2659 + unsigned char md5sum[16];
2660 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2663 +/* functions/definitions to read/write vma files */
2665 +typedef struct VmaReader VmaReader;
2667 +typedef struct VmaWriter VmaWriter;
2669 +typedef struct VmaConfigData {
2675 +typedef struct VmaStreamInfo {
2677 + uint64_t cluster_count;
2678 + uint64_t transferred;
2679 + uint64_t zero_bytes;
2684 +typedef struct VmaStatus {
2687 + char errmsg[8192];
2688 + char uuid_str[37];
2689 + VmaStreamInfo stream_info[256];
2692 +typedef struct VmaDeviceInfo {
2693 + uint64_t size; /* device size in bytes */
2694 + const char *devname;
2697 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp);
2698 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2699 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp);
2700 +void vma_writer_destroy(VmaWriter *vmaw);
2701 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2703 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2706 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2707 + int64_t cluster_num,
2708 + const unsigned char *buf,
2709 + size_t *zero_bytes);
2711 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2712 +int coroutine_fn vma_writer_flush_output(VmaWriter *vmaw);
2714 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2715 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2718 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2719 +void vma_reader_destroy(VmaReader *vmar);
2720 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2721 +GList *vma_reader_get_config_data(VmaReader *vmar);
2722 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2723 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2724 + BlockBackend *target, bool write_zeroes,
2726 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2728 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp);
2730 +#endif /* BACKUP_VMA_H */