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 | 860 ++++++++++++++++++++++++++++++++++++++++++++++
13 vma-writer.c | 791 ++++++++++++++++++++++++++++++++++++++++++
14 vma.c | 850 +++++++++++++++++++++++++++++++++++++++++++++
16 6 files changed, 2658 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 9451fc3ccd..819eb80951 100644
24 --- a/block/meson.build
25 +++ b/block/meson.build
26 @@ -46,6 +46,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 if get_option('qcow1').allowed()
35 diff --git a/meson.build b/meson.build
36 index 861de93c4f..96a91b95e4 100644
39 @@ -1267,6 +1267,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 @@ -3359,6 +3361,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..4f4ee2b47b
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);
258 + if (vmar->rstate[i].target) {
259 + blk_unref(vmar->rstate[i].target);
263 + if (vmar->md5csum) {
264 + g_checksum_free(vmar->md5csum);
267 + if (vmar->blob_hash) {
268 + g_hash_table_destroy(vmar->blob_hash);
271 + if (vmar->head_data) {
272 + g_free(vmar->head_data);
279 +static int vma_reader_read_head(VmaReader *vmar, Error **errp)
283 + assert(*errp == NULL);
285 + unsigned char md5sum[16];
289 + vmar->head_data = g_malloc(sizeof(VmaHeader));
291 + if (full_read(vmar->fd, vmar->head_data, sizeof(VmaHeader)) !=
292 + sizeof(VmaHeader)) {
293 + error_setg(errp, "can't read vma header - %s",
294 + errno ? g_strerror(errno) : "got EOF");
298 + VmaHeader *h = (VmaHeader *)vmar->head_data;
300 + if (h->magic != VMA_MAGIC) {
301 + error_setg(errp, "not a vma file - wrong magic number");
305 + uint32_t header_size = GUINT32_FROM_BE(h->header_size);
306 + int need = header_size - sizeof(VmaHeader);
308 + error_setg(errp, "wrong vma header size %d", header_size);
312 + vmar->head_data = g_realloc(vmar->head_data, header_size);
313 + h = (VmaHeader *)vmar->head_data;
315 + if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
317 + error_setg(errp, "can't read vma header data - %s",
318 + errno ? g_strerror(errno) : "got EOF");
322 + memcpy(md5sum, h->md5sum, 16);
323 + memset(h->md5sum, 0, 16);
325 + g_checksum_reset(vmar->md5csum);
326 + g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
328 + g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
330 + if (memcmp(md5sum, h->md5sum, 16) != 0) {
331 + error_setg(errp, "wrong vma header chechsum");
335 + /* we can modify header data after checksum verify */
336 + h->header_size = header_size;
338 + h->version = GUINT32_FROM_BE(h->version);
339 + if (h->version != 1) {
340 + error_setg(errp, "wrong vma version %d", h->version);
344 + h->ctime = GUINT64_FROM_BE(h->ctime);
345 + h->blob_buffer_offset = GUINT32_FROM_BE(h->blob_buffer_offset);
346 + h->blob_buffer_size = GUINT32_FROM_BE(h->blob_buffer_size);
348 + uint32_t bstart = h->blob_buffer_offset + 1;
349 + uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
351 + if (bstart <= sizeof(VmaHeader)) {
352 + error_setg(errp, "wrong vma blob buffer offset %d",
353 + h->blob_buffer_offset);
357 + if (bend > header_size) {
358 + error_setg(errp, "wrong vma blob buffer size %d/%d",
359 + h->blob_buffer_offset, h->blob_buffer_size);
363 + while ((bstart + 2) <= bend) {
364 + uint32_t size = vmar->head_data[bstart] +
365 + (vmar->head_data[bstart+1] << 8);
366 + if ((bstart + size + 2) <= bend) {
367 + VmaBlob *blob = g_new0(VmaBlob, 1);
368 + blob->start = bstart - h->blob_buffer_offset;
370 + blob->data = vmar->head_data + bstart + 2;
371 + g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
373 + bstart += size + 2;
378 + for (i = 1; i < 256; i++) {
379 + VmaDeviceInfoHeader *dih = &h->dev_info[i];
380 + uint32_t devname_ptr = GUINT32_FROM_BE(dih->devname_ptr);
381 + uint64_t size = GUINT64_FROM_BE(dih->size);
382 + const char *devname = get_header_str(vmar, devname_ptr);
384 + if (size && devname) {
386 + vmar->devinfo[i].size = size;
387 + vmar->devinfo[i].devname = devname;
389 + if (strcmp(devname, "vmstate") == 0) {
390 + vmar->vmstate_stream = i;
395 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
396 + uint32_t name_ptr = GUINT32_FROM_BE(h->config_names[i]);
397 + uint32_t data_ptr = GUINT32_FROM_BE(h->config_data[i]);
399 + if (!(name_ptr && data_ptr)) {
402 + const char *name = get_header_str(vmar, name_ptr);
403 + const VmaBlob *blob = get_header_blob(vmar, data_ptr);
405 + if (!(name && blob)) {
406 + error_setg(errp, "vma contains invalid data pointers");
410 + VmaConfigData *cdata = g_new0(VmaConfigData, 1);
411 + cdata->name = name;
412 + cdata->data = blob->data;
413 + cdata->len = blob->len;
415 + vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
421 +VmaReader *vma_reader_create(const char *filename, Error **errp)
426 + VmaReader *vmar = g_new0(VmaReader, 1);
428 + if (strcmp(filename, "-") == 0) {
431 + vmar->fd = open(filename, O_RDONLY);
434 + if (vmar->fd < 0) {
435 + error_setg(errp, "can't open file %s - %s\n", filename,
436 + g_strerror(errno));
440 + vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
441 + if (!vmar->md5csum) {
442 + error_setg(errp, "can't allocate cmsum\n");
446 + vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
449 + if (vma_reader_read_head(vmar, errp) < 0) {
457 + vma_reader_destroy(vmar);
463 +VmaHeader *vma_reader_get_header(VmaReader *vmar)
466 + assert(vmar->head_data);
468 + return (VmaHeader *)(vmar->head_data);
471 +GList *vma_reader_get_config_data(VmaReader *vmar)
474 + assert(vmar->head_data);
476 + return vmar->cdata_list;
479 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
484 + if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
485 + return &vmar->devinfo[dev_id];
491 +static void allocate_rstate(VmaReader *vmar, guint8 dev_id,
492 + BlockBackend *target, bool write_zeroes)
497 + vmar->rstate[dev_id].target = target;
498 + vmar->rstate[dev_id].write_zeroes = write_zeroes;
500 + int64_t size = vmar->devinfo[dev_id].size;
502 + int64_t bitmap_size = (size/BDRV_SECTOR_SIZE) +
503 + (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG - 1;
504 + bitmap_size /= (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG;
506 + vmar->rstate[dev_id].bitmap_size = bitmap_size;
507 + vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
509 + vmar->cluster_count += size/VMA_CLUSTER_SIZE;
512 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockBackend *target,
513 + bool write_zeroes, Error **errp)
516 + assert(target != NULL);
518 + assert(vmar->rstate[dev_id].target == NULL);
520 + int64_t size = blk_getlength(target);
521 + int64_t size_diff = size - vmar->devinfo[dev_id].size;
523 + /* storage types can have different size restrictions, so it
524 + * is not always possible to create an image with exact size.
525 + * So we tolerate a size difference up to 4MB.
527 + if ((size_diff < 0) || (size_diff > 4*1024*1024)) {
528 + error_setg(errp, "vma_reader_register_bs for stream %s failed - "
529 + "unexpected size %zd != %zd", vmar->devinfo[dev_id].devname,
530 + size, vmar->devinfo[dev_id].size);
534 + allocate_rstate(vmar, dev_id, target, write_zeroes);
539 +static ssize_t safe_write(int fd, void *buf, size_t count)
544 + n = write(fd, buf, count);
545 + } while (n < 0 && errno == EINTR);
550 +static size_t full_write(int fd, void *buf, size_t len)
558 + n = safe_write(fd, buf, len);
568 + /* incomplete write ? */
575 +static int restore_write_data(VmaReader *vmar, guint8 dev_id,
576 + BlockBackend *target, int vmstate_fd,
577 + unsigned char *buf, int64_t sector_num,
578 + int nb_sectors, Error **errp)
582 + if (dev_id == vmar->vmstate_stream) {
583 + if (vmstate_fd >= 0) {
584 + int len = nb_sectors * BDRV_SECTOR_SIZE;
585 + int res = full_write(vmstate_fd, buf, len);
587 + error_setg(errp, "write vmstate failed %d", res);
592 + int res = blk_pwrite(target, sector_num * BDRV_SECTOR_SIZE, buf, nb_sectors * BDRV_SECTOR_SIZE, 0);
594 + error_setg(errp, "blk_pwrite to %s failed (%d)",
595 + bdrv_get_device_name(blk_bs(target)), res);
602 +static int restore_extent(VmaReader *vmar, unsigned char *buf,
603 + int extent_size, int vmstate_fd,
604 + bool verbose, bool verify, Error **errp)
609 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
610 + int start = VMA_EXTENT_HEADER_SIZE;
613 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
614 + uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
615 + uint64_t cluster_num = block_info & 0xffffffff;
616 + uint8_t dev_id = (block_info >> 32) & 0xff;
617 + uint16_t mask = block_info >> (32+16);
618 + int64_t max_sector;
624 + VmaRestoreState *rstate = &vmar->rstate[dev_id];
625 + BlockBackend *target = NULL;
627 + if (dev_id != vmar->vmstate_stream) {
628 + target = rstate->target;
629 + if (!verify && !target) {
630 + error_setg(errp, "got wrong dev id %d", dev_id);
634 + if (vma_reader_get_bitmap(rstate, cluster_num)) {
635 + error_setg(errp, "found duplicated cluster %zd for stream %s",
636 + cluster_num, vmar->devinfo[dev_id].devname);
639 + vma_reader_set_bitmap(rstate, cluster_num, 1);
641 + max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
643 + max_sector = G_MAXINT64;
644 + if (cluster_num != vmar->vmstate_clusters) {
645 + error_setg(errp, "found out of order vmstate data");
648 + vmar->vmstate_clusters++;
651 + vmar->clusters_read++;
654 + time_t duration = time(NULL) - vmar->start_time;
655 + int percent = (vmar->clusters_read*100)/vmar->cluster_count;
656 + if (percent != vmar->clusters_read_per) {
657 + printf("progress %d%% (read %zd bytes, duration %zd sec)\n",
658 + percent, vmar->clusters_read*VMA_CLUSTER_SIZE,
661 + vmar->clusters_read_per = percent;
665 + /* try to write whole clusters to speedup restore */
666 + if (mask == 0xffff) {
667 + if ((start + VMA_CLUSTER_SIZE) > extent_size) {
668 + error_setg(errp, "short vma extent - too many blocks");
671 + int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
673 + int64_t end_sector = sector_num +
674 + VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
676 + if (end_sector > max_sector) {
677 + end_sector = max_sector;
680 + if (end_sector <= sector_num) {
681 + error_setg(errp, "got wrong block address - write beyond end");
686 + int nb_sectors = end_sector - sector_num;
687 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
688 + buf + start, sector_num, nb_sectors,
694 + start += VMA_CLUSTER_SIZE;
699 + for (j = 0; j < 16; j++) {
700 + int64_t sector_num = (cluster_num*VMA_CLUSTER_SIZE +
701 + j*VMA_BLOCK_SIZE)/BDRV_SECTOR_SIZE;
703 + int64_t end_sector = sector_num +
704 + VMA_BLOCK_SIZE/BDRV_SECTOR_SIZE;
705 + if (end_sector > max_sector) {
706 + end_sector = max_sector;
710 + if ((start + VMA_BLOCK_SIZE) > extent_size) {
711 + error_setg(errp, "short vma extent - too many blocks");
715 + if (end_sector <= sector_num) {
716 + error_setg(errp, "got wrong block address - "
717 + "write beyond end");
722 + int nb_sectors = end_sector - sector_num;
723 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
724 + buf + start, sector_num,
725 + nb_sectors, errp) < 0) {
730 + start += VMA_BLOCK_SIZE;
735 + if (end_sector > sector_num) {
736 + /* Todo: use bdrv_co_write_zeroes (but that need to
737 + * be run inside coroutine?)
739 + int nb_sectors = end_sector - sector_num;
740 + int zero_size = BDRV_SECTOR_SIZE*nb_sectors;
741 + vmar->zero_cluster_data += zero_size;
743 + vmar->partial_zero_cluster_data += zero_size;
746 + if (rstate->write_zeroes && !verify) {
747 + if (restore_write_data(vmar, dev_id, target, vmstate_fd,
748 + zero_vma_block, sector_num,
749 + nb_sectors, errp) < 0) {
761 + if (start != extent_size) {
762 + error_setg(errp, "vma extent error - missing blocks");
769 +static int vma_reader_restore_full(VmaReader *vmar, int vmstate_fd,
770 + bool verbose, bool verify,
774 + assert(vmar->head_data);
777 + unsigned char buf[VMA_MAX_EXTENT_SIZE];
779 + unsigned char md5sum[16];
780 + VmaHeader *h = (VmaHeader *)vmar->head_data;
782 + vmar->start_time = time(NULL);
785 + int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
787 + error_setg(errp, "read failed - %s", g_strerror(errno));
797 + if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
798 + error_setg(errp, "read short extent (%d bytes)", buf_pos);
802 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
804 + /* extract md5sum */
805 + memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
806 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
808 + g_checksum_reset(vmar->md5csum);
809 + g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
811 + g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
813 + if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
814 + error_setg(errp, "wrong vma extent header chechsum");
818 + if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
819 + error_setg(errp, "wrong vma extent uuid");
823 + if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
824 + error_setg(errp, "wrong vma extent header magic");
828 + int block_count = GUINT16_FROM_BE(ehead->block_count);
829 + int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
831 + if (buf_pos < extent_size) {
832 + error_setg(errp, "short vma extent (%d < %d)", buf_pos,
837 + if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
838 + verify, errp) < 0) {
842 + if (buf_pos > extent_size) {
843 + memmove(buf, buf + extent_size, buf_pos - extent_size);
844 + buf_pos = buf_pos - extent_size;
853 + for (i = 1; i < 256; i++) {
854 + VmaRestoreState *rstate = &vmar->rstate[i];
855 + if (!rstate->target) {
859 + if (blk_flush(rstate->target) < 0) {
860 + error_setg(errp, "vma blk_flush %s failed",
861 + vmar->devinfo[i].devname);
865 + if (vmar->devinfo[i].size &&
866 + (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
867 + assert(rstate->bitmap);
869 + int64_t cluster_num, end;
871 + end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
874 + for (cluster_num = 0; cluster_num < end; cluster_num++) {
875 + if (!vma_reader_get_bitmap(rstate, cluster_num)) {
876 + error_setg(errp, "detected missing cluster %zd "
877 + "for stream %s", cluster_num,
878 + vmar->devinfo[i].devname);
886 + if (vmar->clusters_read) {
887 + printf("total bytes read %zd, sparse bytes %zd (%.3g%%)\n",
888 + vmar->clusters_read*VMA_CLUSTER_SIZE,
889 + vmar->zero_cluster_data,
890 + (double)(100.0*vmar->zero_cluster_data)/
891 + (vmar->clusters_read*VMA_CLUSTER_SIZE));
893 + int64_t datasize = vmar->clusters_read*VMA_CLUSTER_SIZE-vmar->zero_cluster_data;
894 + if (datasize) { // this does not make sense for empty files
895 + printf("space reduction due to 4K zero blocks %.3g%%\n",
896 + (double)(100.0*vmar->partial_zero_cluster_data) / datasize);
899 + printf("vma archive contains no image data\n");
905 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
908 + return vma_reader_restore_full(vmar, vmstate_fd, verbose, false, errp);
911 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp)
915 + for (dev_id = 1; dev_id < 255; dev_id++) {
916 + if (vma_reader_get_device_info(vmar, dev_id)) {
917 + allocate_rstate(vmar, dev_id, NULL, false);
921 + return vma_reader_restore_full(vmar, -1, verbose, true, errp);
924 diff --git a/vma-writer.c b/vma-writer.c
926 index 0000000000..df4b20793d
931 + * VMA: Virtual Machine Archive
933 + * Copyright (C) 2012 Proxmox Server Solutions
936 + * Dietmar Maurer (dietmar@proxmox.com)
938 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
939 + * See the COPYING file in the top-level directory.
943 +#include "qemu/osdep.h"
945 +#include <uuid/uuid.h>
948 +#include "block/block.h"
949 +#include "monitor/monitor.h"
950 +#include "qemu/main-loop.h"
951 +#include "qemu/coroutine.h"
952 +#include "qemu/cutils.h"
953 +#include "qemu/memalign.h"
957 +#define DPRINTF(fmt, ...)\
958 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
960 +#define WRITE_BUFFERS 5
961 +#define HEADER_CLUSTERS 8
962 +#define HEADERBUF_SIZE (VMA_CLUSTER_SIZE*HEADER_CLUSTERS)
970 + bool header_written;
973 + /* we always write extents */
974 + unsigned char *outbuf;
975 + int outbuf_pos; /* in bytes */
976 + int outbuf_count; /* in VMA_BLOCKS */
977 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
979 + unsigned char *headerbuf;
981 + GChecksum *md5csum;
982 + CoMutex flush_lock;
983 + Coroutine *co_writer;
985 + /* drive informations */
986 + VmaStreamInfo stream_info[256];
987 + guint stream_count;
989 + guint8 vmstate_stream;
990 + uint32_t vmstate_clusters;
992 + /* header blob table */
993 + char *header_blob_table;
994 + uint32_t header_blob_table_size;
995 + uint32_t header_blob_table_pos;
997 + /* store for config blobs */
998 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
999 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1000 + uint32_t config_count;
1003 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1007 + if (vmaw->status < 0) {
1011 + vmaw->status = -1;
1013 + va_start(ap, fmt);
1014 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1017 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1020 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1023 + if (len > 65535) {
1027 + if (!vmaw->header_blob_table ||
1028 + (vmaw->header_blob_table_size <
1029 + (vmaw->header_blob_table_pos + len + 2))) {
1030 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1032 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1033 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1034 + 0, newsize - vmaw->header_blob_table_size);
1035 + vmaw->header_blob_table_size = newsize;
1038 + uint32_t cpos = vmaw->header_blob_table_pos;
1039 + vmaw->header_blob_table[cpos] = len & 255;
1040 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1041 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1042 + vmaw->header_blob_table_pos += len + 2;
1046 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1050 + size_t len = strlen(str) + 1;
1052 + return allocate_header_blob(vmaw, str, len);
1055 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1059 + assert(!vmaw->header_written);
1060 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1064 + gchar *basename = g_path_get_basename(name);
1065 + uint32_t name_ptr = allocate_header_string(vmaw, basename);
1072 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1077 + vmaw->config_names[vmaw->config_count] = name_ptr;
1078 + vmaw->config_data[vmaw->config_count] = data_ptr;
1080 + vmaw->config_count++;
1085 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1090 + assert(!vmaw->status);
1092 + if (vmaw->header_written) {
1093 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1094 + "already written");
1098 + guint n = vmaw->stream_count + 1;
1100 + /* we can have dev_ids form 1 to 255 (0 reserved)
1101 + * 255(-1) reseverd for safety
1104 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1105 + "too many drives");
1110 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1111 + "got strange size %zd", size);
1115 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1117 + vmaw->stream_info[n].devname = g_strdup(devname);
1118 + vmaw->stream_info[n].size = size;
1120 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1123 + vmaw->stream_count = n;
1125 + if (strcmp(devname, "vmstate") == 0) {
1126 + vmaw->vmstate_stream = n;
1132 +static void coroutine_fn yield_until_fd_writable(int fd)
1134 + assert(qemu_in_coroutine());
1135 + AioContext *ctx = qemu_get_current_aio_context();
1136 + aio_set_fd_handler(ctx, fd, false, NULL, (IOHandler *)qemu_coroutine_enter,
1137 + NULL, NULL, qemu_coroutine_self());
1138 + qemu_coroutine_yield();
1139 + aio_set_fd_handler(ctx, fd, false, NULL, NULL, NULL, NULL, NULL);
1142 +static ssize_t coroutine_fn
1143 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1145 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1149 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1154 + assert(vmaw->co_writer == NULL);
1156 + vmaw->co_writer = qemu_coroutine_self();
1158 + while (done < bytes) {
1159 + if (vmaw->status < 0) {
1160 + DPRINTF("vma_queue_write detected canceled backup\n");
1164 + yield_until_fd_writable(vmaw->fd);
1165 + ret = write(vmaw->fd, buf + done, bytes - done);
1168 + DPRINTF("vma_queue_write written %zd %zd\n", done, ret);
1169 + } else if (ret < 0) {
1170 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1173 + vma_writer_set_error(vmaw, "vma_queue_write: write error - %s",
1174 + g_strerror(errno));
1175 + done = -1; /* always return failure for partial writes */
1178 + } else if (ret == 0) {
1179 + /* should not happen - simply try again */
1183 + vmaw->co_writer = NULL;
1185 + return (done == bytes) ? bytes : -1;
1188 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp)
1192 + assert(sizeof(VmaHeader) == (4096 + 8192));
1193 + assert(G_STRUCT_OFFSET(VmaHeader, config_names) == 2044);
1194 + assert(G_STRUCT_OFFSET(VmaHeader, config_data) == 3068);
1195 + assert(G_STRUCT_OFFSET(VmaHeader, dev_info) == 4096);
1196 + assert(sizeof(VmaExtentHeader) == 512);
1198 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1201 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1202 + if (!vmaw->md5csum) {
1203 + error_setg(errp, "can't allocate cmsum\n");
1207 + if (strstart(filename, "exec:", &p)) {
1208 + vmaw->cmd = popen(p, "w");
1209 + if (vmaw->cmd == NULL) {
1210 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1211 + g_strerror(errno));
1214 + vmaw->fd = fileno(vmaw->cmd);
1216 + /* try to use O_NONBLOCK */
1217 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1222 + const char *tmp_id_str;
1224 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1225 + oflags = O_NONBLOCK|O_WRONLY;
1226 + vmaw->fd = qemu_open(filename, oflags, errp);
1227 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1228 + oflags = O_NONBLOCK|O_WRONLY;
1229 + vmaw->fd = qemu_open(filename, oflags, errp);
1230 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1231 + vmaw->fd = monitor_get_fd(monitor_cur(), tmp_id_str, errp);
1232 + if (vmaw->fd < 0) {
1235 + /* try to use O_NONBLOCK */
1236 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1238 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY|O_EXCL;
1239 + vmaw->fd = qemu_create(filename, oflags, 0644, errp);
1242 + if (vmaw->fd < 0) {
1243 + error_setg(errp, "can't open file %s - %s\n", filename,
1244 + g_strerror(errno));
1249 + /* we use O_DIRECT, so we need to align IO buffers */
1251 + vmaw->outbuf = qemu_memalign(512, VMA_MAX_EXTENT_SIZE);
1252 + vmaw->headerbuf = qemu_memalign(512, HEADERBUF_SIZE);
1254 + vmaw->outbuf_count = 0;
1255 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1257 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1259 + qemu_co_mutex_init(&vmaw->flush_lock);
1261 + uuid_copy(vmaw->uuid, uuid);
1268 + pclose(vmaw->cmd);
1269 + } else if (vmaw->fd >= 0) {
1273 + if (vmaw->md5csum) {
1274 + g_checksum_free(vmaw->md5csum);
1283 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1286 + unsigned char *buf = vmaw->headerbuf;
1287 + VmaHeader *head = (VmaHeader *)buf;
1291 + DPRINTF("VMA WRITE HEADER\n");
1293 + if (vmaw->status < 0) {
1294 + return vmaw->status;
1297 + memset(buf, 0, HEADERBUF_SIZE);
1299 + head->magic = VMA_MAGIC;
1300 + head->version = GUINT32_TO_BE(1); /* v1 */
1301 + memcpy(head->uuid, vmaw->uuid, 16);
1303 + time_t ctime = time(NULL);
1304 + head->ctime = GUINT64_TO_BE(ctime);
1306 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1307 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1308 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1311 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1312 + for (i = 1; i <= 254; i++) {
1313 + VmaStreamInfo *si = &vmaw->stream_info[i];
1315 + assert(si->devname);
1316 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1317 + if (!devname_ptr) {
1320 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1321 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1325 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1326 + head->header_size = GUINT32_TO_BE(header_size);
1328 + if (header_size > HEADERBUF_SIZE) {
1329 + return -1; /* just to be sure */
1332 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1333 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1334 + vmaw->header_blob_table_size);
1335 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1336 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1338 + g_checksum_reset(vmaw->md5csum);
1339 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1341 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1343 + return vma_queue_write(vmaw, buf, header_size);
1346 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1353 + if (vmaw->status < 0) {
1354 + return vmaw->status;
1357 + if (!vmaw->header_written) {
1358 + vmaw->header_written = true;
1359 + ret = vma_write_header(vmaw);
1361 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1366 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1369 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1371 + ehead->magic = VMA_EXTENT_MAGIC;
1372 + ehead->reserved1 = 0;
1374 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1375 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1378 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1381 + ehead->block_count = GUINT16_TO_BE(block_count);
1383 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1384 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1386 + g_checksum_reset(vmaw->md5csum);
1387 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1389 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1391 + int bytes = vmaw->outbuf_pos;
1392 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1393 + if (ret != bytes) {
1394 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1397 + vmaw->outbuf_count = 0;
1398 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1400 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1401 + vmaw->outbuf_block_info[i] = 0;
1404 + return vmaw->status;
1407 +static int vma_count_open_streams(VmaWriter *vmaw)
1409 + g_assert(vmaw != NULL);
1412 + int open_drives = 0;
1413 + for (i = 0; i <= 255; i++) {
1414 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1419 + return open_drives;
1424 + * You need to call this if the vma archive does not contain
1425 + * any data stream.
1428 +vma_writer_flush_output(VmaWriter *vmaw)
1430 + qemu_co_mutex_lock(&vmaw->flush_lock);
1431 + int ret = vma_writer_flush(vmaw);
1432 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1434 + vma_writer_set_error(vmaw, "vma_writer_flush_header failed");
1440 + * all jobs should call this when there is no more data
1441 + * Returns: number of remaining stream (0 ==> finished)
1444 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1446 + g_assert(vmaw != NULL);
1448 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1449 + if (!vmaw->stream_info[dev_id].size) {
1450 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1451 + "no such stream %d", dev_id);
1454 + if (vmaw->stream_info[dev_id].finished) {
1455 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1456 + "stream already closed %d", dev_id);
1460 + vmaw->stream_info[dev_id].finished = true;
1462 + int open_drives = vma_count_open_streams(vmaw);
1464 + if (open_drives <= 0) {
1465 + DPRINTF("vma_writer_set_status all drives completed\n");
1466 + vma_writer_flush_output(vmaw);
1469 + return open_drives;
1472 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1476 + g_assert(vmaw != NULL);
1479 + status->status = vmaw->status;
1480 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1481 + for (i = 0; i <= 255; i++) {
1482 + status->stream_info[i] = vmaw->stream_info[i];
1485 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1488 + status->closed = vmaw->closed;
1490 + return vmaw->status;
1493 +static int vma_writer_get_buffer(VmaWriter *vmaw)
1497 + qemu_co_mutex_lock(&vmaw->flush_lock);
1499 + /* wait until buffer is available */
1500 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1501 + ret = vma_writer_flush(vmaw);
1503 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1508 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1514 +int64_t coroutine_fn
1515 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1516 + const unsigned char *buf, size_t *zero_bytes)
1518 + g_assert(vmaw != NULL);
1519 + g_assert(zero_bytes != NULL);
1523 + if (vmaw->status < 0) {
1524 + return vmaw->status;
1527 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1528 + vma_writer_set_error(vmaw, "vma_writer_write: "
1529 + "no such stream %d", dev_id);
1533 + if (vmaw->stream_info[dev_id].finished) {
1534 + vma_writer_set_error(vmaw, "vma_writer_write: "
1535 + "stream already closed %d", dev_id);
1540 + if (cluster_num >= (((uint64_t)1)<<32)) {
1541 + vma_writer_set_error(vmaw, "vma_writer_write: "
1542 + "cluster number out of range");
1546 + if (dev_id == vmaw->vmstate_stream) {
1547 + if (cluster_num != vmaw->vmstate_clusters) {
1548 + vma_writer_set_error(vmaw, "vma_writer_write: "
1549 + "non sequential vmstate write");
1551 + vmaw->vmstate_clusters++;
1552 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1553 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1557 + /* wait until buffer is available */
1558 + if (vma_writer_get_buffer(vmaw) < 0) {
1559 + vma_writer_set_error(vmaw, "vma_writer_write: "
1560 + "vma_writer_get_buffer failed");
1564 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1566 + uint64_t dev_size = vmaw->stream_info[dev_id].size;
1567 + uint16_t mask = 0;
1572 + uint64_t byte_offset = cluster_num * VMA_CLUSTER_SIZE;
1573 + for (i = 0; i < 16; i++) {
1574 + const unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1576 + // Note: If the source is not 64k-aligned, we might reach 4k blocks
1577 + // after the end of the device. Always mark these as zero in the
1578 + // mask, so the restore handles them correctly.
1579 + if (byte_offset < dev_size &&
1580 + !buffer_is_zero(vmablock, VMA_BLOCK_SIZE))
1583 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock,
1586 + // prevent memory leakage on unaligned last block
1587 + if (byte_offset + VMA_BLOCK_SIZE > dev_size) {
1588 + uint64_t real_data_in_block = dev_size - byte_offset;
1589 + memset(vmaw->outbuf + vmaw->outbuf_pos + real_data_in_block,
1590 + 0, VMA_BLOCK_SIZE - real_data_in_block);
1593 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1595 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1596 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1597 + *zero_bytes += VMA_BLOCK_SIZE;
1600 + byte_offset += VMA_BLOCK_SIZE;
1604 + DPRINTF("VMA WRITE %zd ZERO CLUSTER\n", cluster_num);
1605 + vmaw->stream_info[dev_id].zero_bytes += VMA_CLUSTER_SIZE;
1606 + *zero_bytes += VMA_CLUSTER_SIZE;
1609 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1610 + block_info |= ((uint64_t)dev_id) << 32;
1611 + block_info |= (cluster_num & 0xffffffff);
1612 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1614 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1616 + vmaw->outbuf_count++;
1618 + /** NOTE: We allways write whole clusters, but we correctly set
1619 + * transferred bytes. So transferred == size when when everything
1622 + size_t transferred = VMA_CLUSTER_SIZE;
1624 + if (dev_id != vmaw->vmstate_stream) {
1625 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1626 + if (last > dev_size) {
1627 + uint64_t diff = last - dev_size;
1628 + if (diff >= VMA_CLUSTER_SIZE) {
1629 + vma_writer_set_error(vmaw, "vma_writer_write: "
1630 + "read after last cluster");
1633 + transferred -= diff;
1637 + vmaw->stream_info[dev_id].transferred += transferred;
1639 + return transferred;
1642 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp)
1644 + if (vmaw->status < 0 && *errp == NULL) {
1645 + error_setg(errp, "%s", vmaw->errmsg);
1649 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1651 + g_assert(vmaw != NULL);
1655 + qemu_co_mutex_lock(&vmaw->flush_lock); // wait for pending writes
1657 + assert(vmaw->co_writer == NULL);
1660 + if (pclose(vmaw->cmd) < 0) {
1661 + vma_writer_set_error(vmaw, "vma_writer_close: "
1662 + "pclose failed - %s", g_strerror(errno));
1665 + if (close(vmaw->fd) < 0) {
1666 + vma_writer_set_error(vmaw, "vma_writer_close: "
1667 + "close failed - %s", g_strerror(errno));
1671 + for (i = 0; i <= 255; i++) {
1672 + VmaStreamInfo *si = &vmaw->stream_info[i];
1674 + if (!si->finished) {
1675 + vma_writer_set_error(vmaw, "vma_writer_close: "
1676 + "detected open stream '%s'", si->devname);
1677 + } else if ((si->transferred != si->size) &&
1678 + (i != vmaw->vmstate_stream)) {
1679 + vma_writer_set_error(vmaw, "vma_writer_close: "
1680 + "incomplete stream '%s' (%zd != %zd)",
1681 + si->devname, si->transferred, si->size);
1686 + for (i = 0; i <= 255; i++) {
1687 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1692 + if (vmaw->status < 0 && *errp == NULL) {
1693 + error_setg(errp, "%s", vmaw->errmsg);
1696 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1698 + return vmaw->status;
1701 +void vma_writer_destroy(VmaWriter *vmaw)
1707 + for (i = 0; i <= 255; i++) {
1708 + if (vmaw->stream_info[i].devname) {
1709 + g_free(vmaw->stream_info[i].devname);
1713 + if (vmaw->md5csum) {
1714 + g_checksum_free(vmaw->md5csum);
1717 + qemu_vfree(vmaw->headerbuf);
1718 + qemu_vfree(vmaw->outbuf);
1721 diff --git a/vma.c b/vma.c
1722 new file mode 100644
1723 index 0000000000..91612d50a2
1728 + * VMA: Virtual Machine Archive
1730 + * Copyright (C) 2012-2013 Proxmox Server Solutions
1733 + * Dietmar Maurer (dietmar@proxmox.com)
1735 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1736 + * See the COPYING file in the top-level directory.
1740 +#include "qemu/osdep.h"
1744 +#include "qemu-common.h"
1745 +#include "qemu/module.h"
1746 +#include "qemu/error-report.h"
1747 +#include "qemu/main-loop.h"
1748 +#include "qemu/cutils.h"
1749 +#include "qemu/memalign.h"
1750 +#include "qapi/qmp/qdict.h"
1751 +#include "sysemu/block-backend.h"
1753 +static void help(void)
1755 + const char *help_msg =
1756 + "usage: vma command [command options]\n"
1758 + "vma list <filename>\n"
1759 + "vma config <filename> [-c config]\n"
1760 + "vma create <filename> [-c config] pathname ...\n"
1761 + "vma extract <filename> [-r <fifo>] <targetdir>\n"
1762 + "vma verify <filename> [-v]\n"
1765 + printf("%s", help_msg);
1769 +static const char *extract_devname(const char *path, char **devname, int index)
1773 + const char *sep = strchr(path, '=');
1776 + *devname = g_strndup(path, sep - path);
1780 + *devname = g_strdup_printf("disk%d", index);
1789 +static void print_content(VmaReader *vmar)
1793 + VmaHeader *head = vma_reader_get_header(vmar);
1795 + GList *l = vma_reader_get_config_data(vmar);
1796 + while (l && l->data) {
1797 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1798 + l = g_list_next(l);
1799 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1803 + VmaDeviceInfo *di;
1804 + for (i = 1; i < 255; i++) {
1805 + di = vma_reader_get_device_info(vmar, i);
1807 + if (strcmp(di->devname, "vmstate") == 0) {
1808 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1810 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1811 + i, di->size, di->devname);
1815 + /* ctime is the last entry we print */
1816 + printf("CTIME: %s", ctime(&head->ctime));
1820 +static int list_content(int argc, char **argv)
1823 + const char *filename;
1826 + c = getopt(argc, argv, "h");
1836 + g_assert_not_reached();
1840 + /* Get the filename */
1841 + if ((optind + 1) != argc) {
1844 + filename = argv[optind++];
1846 + Error *errp = NULL;
1847 + VmaReader *vmar = vma_reader_create(filename, &errp);
1850 + g_error("%s", error_get_pretty(errp));
1853 + print_content(vmar);
1855 + vma_reader_destroy(vmar);
1860 +typedef struct RestoreMap {
1864 + uint64_t throttling_bps;
1865 + char *throttling_group;
1870 +static bool try_parse_option(char **line, const char *optname, char **out, const char *inbuf) {
1871 + size_t optlen = strlen(optname);
1872 + if (strncmp(*line, optname, optlen) != 0 || (*line)[optlen] != '=') {
1876 + g_error("read map failed - duplicate value for option '%s'", optname);
1878 + char *value = (*line) + optlen + 1; /* including a '=' */
1879 + char *colon = strchr(value, ':');
1881 + g_error("read map failed - option '%s' not terminated ('%s')",
1885 + *out = g_strndup(value, colon - value);
1889 +static uint64_t verify_u64(const char *text) {
1891 + const char *endptr = NULL;
1892 + if (qemu_strtou64(text, &endptr, 0, &value) != 0 || !endptr || *endptr) {
1893 + g_error("read map failed - not a number: %s", text);
1898 +static int extract_content(int argc, char **argv)
1902 + const char *filename;
1903 + const char *dirname;
1904 + const char *readmap = NULL;
1907 + c = getopt(argc, argv, "hvr:");
1927 + /* Get the filename */
1928 + if ((optind + 2) != argc) {
1931 + filename = argv[optind++];
1932 + dirname = argv[optind++];
1934 + Error *errp = NULL;
1935 + VmaReader *vmar = vma_reader_create(filename, &errp);
1938 + g_error("%s", error_get_pretty(errp));
1941 + if (mkdir(dirname, 0777) < 0) {
1942 + g_error("unable to create target directory %s - %s",
1943 + dirname, g_strerror(errno));
1946 + GList *l = vma_reader_get_config_data(vmar);
1947 + while (l && l->data) {
1948 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1949 + l = g_list_next(l);
1950 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
1951 + GError *err = NULL;
1952 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
1954 + g_error("unable to write file: %s", err->message);
1958 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
1961 + print_content(vmar);
1963 + FILE *map = fopen(readmap, "r");
1965 + g_error("unable to open fifo %s - %s", readmap, g_strerror(errno));
1970 + char *line = fgets(inbuf, sizeof(inbuf), map);
1971 + char *format = NULL;
1973 + char *group = NULL;
1974 + char *cache = NULL;
1975 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
1978 + int len = strlen(line);
1979 + if (line[len - 1] == '\n') {
1980 + line[len - 1] = '\0';
1987 + if (!try_parse_option(&line, "format", &format, inbuf) &&
1988 + !try_parse_option(&line, "throttling.bps", &bps, inbuf) &&
1989 + !try_parse_option(&line, "throttling.group", &group, inbuf) &&
1990 + !try_parse_option(&line, "cache", &cache, inbuf))
1996 + uint64_t bps_value = 0;
1998 + bps_value = verify_u64(bps);
2004 + if (line[0] == '0' && line[1] == ':') {
2006 + write_zero = false;
2007 + } else if (line[0] == '1' && line[1] == ':') {
2009 + write_zero = true;
2011 + g_error("read map failed - parse error ('%s')", inbuf);
2014 + char *devname = NULL;
2015 + path = extract_devname(path, &devname, -1);
2017 + g_error("read map failed - no dev name specified ('%s')",
2021 + RestoreMap *map = g_new0(RestoreMap, 1);
2022 + map->devname = g_strdup(devname);
2023 + map->path = g_strdup(path);
2024 + map->format = format;
2025 + map->throttling_bps = bps_value;
2026 + map->throttling_group = group;
2027 + map->cache = cache;
2028 + map->write_zero = write_zero;
2030 + g_hash_table_insert(devmap, map->devname, map);
2036 + int vmstate_fd = -1;
2037 + guint8 vmstate_stream = 0;
2039 + for (i = 1; i < 255; i++) {
2040 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2041 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2042 + vmstate_stream = i;
2043 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2044 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2045 + if (vmstate_fd < 0) {
2046 + g_error("create vmstate file '%s' failed - %s", statefn,
2047 + g_strerror(errno));
2051 + char *devfn = NULL;
2052 + const char *format = NULL;
2053 + uint64_t throttling_bps = 0;
2054 + const char *throttling_group = NULL;
2055 + const char *cache = NULL;
2056 + int flags = BDRV_O_RDWR;
2057 + bool write_zero = true;
2059 + BlockBackend *blk = NULL;
2063 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2064 + if (map == NULL) {
2065 + g_error("no device name mapping for %s", di->devname);
2067 + devfn = map->path;
2068 + format = map->format;
2069 + throttling_bps = map->throttling_bps;
2070 + throttling_group = map->throttling_group;
2071 + cache = map->cache;
2072 + write_zero = map->write_zero;
2074 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2075 + dirname, di->devname);
2076 + printf("DEVINFO %s %zd\n", devfn, di->size);
2078 + bdrv_img_create(devfn, "raw", NULL, NULL, NULL, di->size,
2079 + flags, true, &errp);
2081 + g_error("can't create file %s: %s", devfn,
2082 + error_get_pretty(errp));
2085 + /* Note: we created an empty file above, so there is no
2086 + * need to write zeroes (so we generate a sparse file)
2088 + write_zero = false;
2091 + size_t devlen = strlen(devfn);
2092 + QDict *options = NULL;
2093 + bool writethrough;
2095 + /* explicit format from commandline */
2096 + options = qdict_new();
2097 + qdict_put_str(options, "driver", format);
2098 + } else if ((devlen > 4 && strcmp(devfn+devlen-4, ".raw") == 0) ||
2099 + strncmp(devfn, "/dev/", 5) == 0)
2101 + /* This part is now deprecated for PVE as well (just as qemu
2102 + * deprecated not specifying an explicit raw format, too.
2104 + /* explicit raw format */
2105 + options = qdict_new();
2106 + qdict_put_str(options, "driver", "raw");
2108 + if (cache && bdrv_parse_cache_mode(cache, &flags, &writethrough)) {
2109 + g_error("invalid cache option: %s\n", cache);
2112 + if (errp || !(blk = blk_new_open(devfn, NULL, options, flags, &errp))) {
2113 + g_error("can't open file %s - %s", devfn,
2114 + error_get_pretty(errp));
2118 + blk_set_enable_write_cache(blk, !writethrough);
2121 + if (throttling_group) {
2122 + blk_io_limits_enable(blk, throttling_group);
2125 + if (throttling_bps) {
2126 + if (!throttling_group) {
2127 + blk_io_limits_enable(blk, devfn);
2130 + ThrottleConfig cfg;
2131 + throttle_config_init(&cfg);
2132 + cfg.buckets[THROTTLE_BPS_WRITE].avg = throttling_bps;
2133 + Error *err = NULL;
2134 + if (!throttle_is_valid(&cfg, &err)) {
2135 + error_report_err(err);
2136 + g_error("failed to apply throttling");
2138 + blk_set_io_limits(blk, &cfg);
2141 + if (vma_reader_register_bs(vmar, i, blk, write_zero, &errp) < 0) {
2142 + g_error("%s", error_get_pretty(errp));
2151 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2152 + g_error("restore failed - %s", error_get_pretty(errp));
2156 + for (i = 1; i < 255; i++) {
2157 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2158 + if (di && (i != vmstate_stream)) {
2159 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2160 + dirname, di->devname);
2161 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2162 + dirname, di->devname);
2163 + if (rename(tmpfn, fn) != 0) {
2164 + g_error("rename %s to %s failed - %s",
2165 + tmpfn, fn, g_strerror(errno));
2171 + vma_reader_destroy(vmar);
2178 +static int verify_content(int argc, char **argv)
2182 + const char *filename;
2185 + c = getopt(argc, argv, "hv");
2202 + /* Get the filename */
2203 + if ((optind + 1) != argc) {
2206 + filename = argv[optind++];
2208 + Error *errp = NULL;
2209 + VmaReader *vmar = vma_reader_create(filename, &errp);
2212 + g_error("%s", error_get_pretty(errp));
2216 + print_content(vmar);
2219 + if (vma_reader_verify(vmar, verbose, &errp) < 0) {
2220 + g_error("verify failed - %s", error_get_pretty(errp));
2223 + vma_reader_destroy(vmar);
2230 +typedef struct BackupJob {
2231 + BlockBackend *target;
2237 +#define BACKUP_SECTORS_PER_CLUSTER (VMA_CLUSTER_SIZE / BDRV_SECTOR_SIZE)
2239 +static void coroutine_fn backup_run_empty(void *opaque)
2241 + VmaWriter *vmaw = (VmaWriter *)opaque;
2243 + vma_writer_flush_output(vmaw);
2245 + Error *err = NULL;
2246 + if (vma_writer_close(vmaw, &err) != 0) {
2247 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2251 +static void coroutine_fn backup_run(void *opaque)
2253 + BackupJob *job = (BackupJob *)opaque;
2255 + QEMUIOVector qiov;
2257 + int64_t start, end;
2260 + unsigned char *buf = blk_blockalign(job->target, VMA_CLUSTER_SIZE);
2263 + end = DIV_ROUND_UP(job->len / BDRV_SECTOR_SIZE,
2264 + BACKUP_SECTORS_PER_CLUSTER);
2266 + for (; start < end; start++) {
2267 + iov.iov_base = buf;
2268 + iov.iov_len = VMA_CLUSTER_SIZE;
2269 + qemu_iovec_init_external(&qiov, &iov, 1);
2271 + ret = blk_co_preadv(job->target, start * VMA_CLUSTER_SIZE,
2272 + VMA_CLUSTER_SIZE, &qiov, 0);
2274 + vma_writer_set_error(job->vmaw, "read error", -1);
2279 + if (vma_writer_write(job->vmaw, job->dev_id, start, buf, &zb) < 0) {
2280 + vma_writer_set_error(job->vmaw, "backup_dump_cb vma_writer_write failed", -1);
2287 + if (vma_writer_close_stream(job->vmaw, job->dev_id) <= 0) {
2288 + Error *err = NULL;
2289 + if (vma_writer_close(job->vmaw, &err) != 0) {
2290 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2296 +static int create_archive(int argc, char **argv)
2300 + const char *archivename;
2301 + GList *backup_coroutines = NULL;
2302 + GList *config_files = NULL;
2305 + c = getopt(argc, argv, "hvc:");
2315 + config_files = g_list_append(config_files, optarg);
2321 + g_assert_not_reached();
2326 + /* make sure we an archive name */
2327 + if ((optind + 1) > argc) {
2331 + archivename = argv[optind++];
2334 + uuid_generate(uuid);
2336 + Error *local_err = NULL;
2337 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, &local_err);
2339 + if (vmaw == NULL) {
2340 + g_error("%s", error_get_pretty(local_err));
2343 + GList *l = config_files;
2344 + while (l && l->data) {
2345 + char *name = l->data;
2346 + char *cdata = NULL;
2348 + GError *err = NULL;
2349 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2350 + unlink(archivename);
2351 + g_error("Unable to read file: %s", err->message);
2354 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2355 + unlink(archivename);
2356 + g_error("Unable to append config data %s (len = %zd)",
2359 + l = g_list_next(l);
2363 + while (optind < argc) {
2364 + const char *path = argv[optind++];
2365 + char *devname = NULL;
2366 + path = extract_devname(path, &devname, devcount++);
2368 + Error *errp = NULL;
2369 + BlockBackend *target;
2371 + target = blk_new_open(path, NULL, NULL, 0, &errp);
2373 + unlink(archivename);
2374 + g_error("bdrv_open '%s' failed - %s", path, error_get_pretty(errp));
2376 + int64_t size = blk_getlength(target);
2377 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2378 + if (dev_id <= 0) {
2379 + unlink(archivename);
2380 + g_error("vma_writer_register_stream '%s' failed", devname);
2383 + BackupJob *job = g_new0(BackupJob, 1);
2385 + job->target = target;
2387 + job->dev_id = dev_id;
2389 + Coroutine *co = qemu_coroutine_create(backup_run, job);
2390 + // Don't enter coroutine yet, because it might write the header before
2391 + // all streams can be registered.
2392 + backup_coroutines = g_list_append(backup_coroutines, co);
2395 + VmaStatus vmastat;
2397 + int last_percent = -1;
2400 + GList *entry = backup_coroutines;
2401 + while (entry && entry->data) {
2402 + Coroutine *co = entry->data;
2403 + qemu_coroutine_enter(co);
2404 + entry = g_list_next(entry);
2408 + main_loop_wait(false);
2409 + vma_writer_get_status(vmaw, &vmastat);
2413 + uint64_t total = 0;
2414 + uint64_t transferred = 0;
2415 + uint64_t zero_bytes = 0;
2418 + for (i = 0; i < 256; i++) {
2419 + if (vmastat.stream_info[i].size) {
2420 + total += vmastat.stream_info[i].size;
2421 + transferred += vmastat.stream_info[i].transferred;
2422 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2425 + percent = (transferred*100)/total;
2426 + if (percent != last_percent) {
2427 + fprintf(stderr, "progress %d%% %zd/%zd %zd\n", percent,
2428 + transferred, total, zero_bytes);
2431 + last_percent = percent;
2435 + if (vmastat.closed) {
2440 + Coroutine *co = qemu_coroutine_create(backup_run_empty, vmaw);
2441 + qemu_coroutine_enter(co);
2443 + main_loop_wait(false);
2444 + vma_writer_get_status(vmaw, &vmastat);
2445 + if (vmastat.closed) {
2453 + vma_writer_get_status(vmaw, &vmastat);
2456 + for (i = 0; i < 256; i++) {
2457 + VmaStreamInfo *si = &vmastat.stream_info[i];
2459 + fprintf(stderr, "image %s: size=%zd zeros=%zd saved=%zd\n",
2460 + si->devname, si->size, si->zero_bytes,
2461 + si->size - si->zero_bytes);
2466 + if (vmastat.status < 0) {
2467 + unlink(archivename);
2468 + g_error("creating vma archive failed");
2471 + g_list_free(backup_coroutines);
2472 + g_list_free(config_files);
2473 + vma_writer_destroy(vmaw);
2477 +static int dump_config(int argc, char **argv)
2480 + const char *filename;
2481 + const char *config_name = "qemu-server.conf";
2484 + c = getopt(argc, argv, "hc:");
2494 + config_name = optarg;
2501 + /* Get the filename */
2502 + if ((optind + 1) != argc) {
2505 + filename = argv[optind++];
2507 + Error *errp = NULL;
2508 + VmaReader *vmar = vma_reader_create(filename, &errp);
2511 + g_error("%s", error_get_pretty(errp));
2515 + GList *l = vma_reader_get_config_data(vmar);
2516 + while (l && l->data) {
2517 + VmaConfigData *cdata = (VmaConfigData *)l->data;
2518 + l = g_list_next(l);
2519 + if (strcmp(cdata->name, config_name) == 0) {
2521 + fwrite(cdata->data, cdata->len, 1, stdout);
2526 + vma_reader_destroy(vmar);
2531 + fprintf(stderr, "unable to find configuration data '%s'\n", config_name);
2538 +int main(int argc, char **argv)
2540 + const char *cmdname;
2541 + Error *main_loop_err = NULL;
2543 + error_init(argv[0]);
2544 + module_call_init(MODULE_INIT_TRACE);
2545 + qemu_init_exec_dir(argv[0]);
2547 + if (qemu_init_main_loop(&main_loop_err)) {
2548 + g_error("%s", error_get_pretty(main_loop_err));
2552 + module_call_init(MODULE_INIT_QOM);
2558 + cmdname = argv[1];
2562 + if (!strcmp(cmdname, "list")) {
2563 + return list_content(argc, argv);
2564 + } else if (!strcmp(cmdname, "create")) {
2565 + return create_archive(argc, argv);
2566 + } else if (!strcmp(cmdname, "extract")) {
2567 + return extract_content(argc, argv);
2568 + } else if (!strcmp(cmdname, "verify")) {
2569 + return verify_content(argc, argv);
2570 + } else if (!strcmp(cmdname, "config")) {
2571 + return dump_config(argc, argv);
2577 diff --git a/vma.h b/vma.h
2578 new file mode 100644
2579 index 0000000000..c895c97f6d
2584 + * VMA: Virtual Machine Archive
2586 + * Copyright (C) Proxmox Server Solutions
2589 + * Dietmar Maurer (dietmar@proxmox.com)
2591 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2592 + * See the COPYING file in the top-level directory.
2596 +#ifndef BACKUP_VMA_H
2597 +#define BACKUP_VMA_H
2599 +#include <uuid/uuid.h>
2600 +#include "qapi/error.h"
2601 +#include "block/block.h"
2603 +#define VMA_BLOCK_BITS 12
2604 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2605 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2606 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2608 +#if VMA_CLUSTER_SIZE != 65536
2609 +#error unexpected cluster size
2612 +#define VMA_EXTENT_HEADER_SIZE 512
2613 +#define VMA_BLOCKS_PER_EXTENT 59
2614 +#define VMA_MAX_CONFIGS 256
2616 +#define VMA_MAX_EXTENT_SIZE \
2617 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2618 +#if VMA_MAX_EXTENT_SIZE != 3867136
2619 +#error unexpected VMA_EXTENT_SIZE
2622 +/* File Format Definitions */
2624 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2625 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2627 +typedef struct VmaDeviceInfoHeader {
2628 + uint32_t devname_ptr; /* offset into blob_buffer table */
2629 + uint32_t reserved0;
2630 + uint64_t size; /* device size in bytes */
2631 + uint64_t reserved1;
2632 + uint64_t reserved2;
2633 +} VmaDeviceInfoHeader;
2635 +typedef struct VmaHeader {
2638 + unsigned char uuid[16];
2640 + unsigned char md5sum[16];
2642 + uint32_t blob_buffer_offset;
2643 + uint32_t blob_buffer_size;
2644 + uint32_t header_size;
2646 + unsigned char reserved[1984];
2648 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2649 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2651 + uint32_t reserved1;
2653 + VmaDeviceInfoHeader dev_info[256];
2656 +typedef struct VmaExtentHeader {
2658 + uint16_t reserved1;
2659 + uint16_t block_count;
2660 + unsigned char uuid[16];
2661 + unsigned char md5sum[16];
2662 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2665 +/* functions/definitions to read/write vma files */
2667 +typedef struct VmaReader VmaReader;
2669 +typedef struct VmaWriter VmaWriter;
2671 +typedef struct VmaConfigData {
2677 +typedef struct VmaStreamInfo {
2679 + uint64_t cluster_count;
2680 + uint64_t transferred;
2681 + uint64_t zero_bytes;
2686 +typedef struct VmaStatus {
2689 + char errmsg[8192];
2690 + char uuid_str[37];
2691 + VmaStreamInfo stream_info[256];
2694 +typedef struct VmaDeviceInfo {
2695 + uint64_t size; /* device size in bytes */
2696 + const char *devname;
2699 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp);
2700 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2701 +void vma_writer_error_propagate(VmaWriter *vmaw, Error **errp);
2702 +void vma_writer_destroy(VmaWriter *vmaw);
2703 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2705 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2708 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2709 + int64_t cluster_num,
2710 + const unsigned char *buf,
2711 + size_t *zero_bytes);
2713 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2714 +int coroutine_fn vma_writer_flush_output(VmaWriter *vmaw);
2716 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2717 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2720 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2721 +void vma_reader_destroy(VmaReader *vmar);
2722 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2723 +GList *vma_reader_get_config_data(VmaReader *vmar);
2724 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2725 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2726 + BlockBackend *target, bool write_zeroes,
2728 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2730 +int vma_reader_verify(VmaReader *vmar, bool verbose, Error **errp);
2732 +#endif /* BACKUP_VMA_H */