1 From 77a6564c9985c37990c3e90f558f2ef48d6d5f15 Mon Sep 17 00:00:00 2001
2 From: Dietmar Maurer <dietmar@proxmox.com>
3 Date: Tue, 13 Nov 2012 11:11:38 +0100
4 Subject: [PATCH v3 4/7] introduce new vma archive format
6 This is a very simple archive format, see docs/specs/vma_spec.txt
8 Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
13 docs/specs/vma_spec.txt | 24 ++
14 vma-reader.c | 801 ++++++++++++++++++++++++++++++++++++++++
15 vma-writer.c | 931 +++++++++++++++++++++++++++++++++++++++++++++++
16 vma.c | 561 ++++++++++++++++++++++++++++
18 8 files changed, 2470 insertions(+), 4 deletions(-)
19 create mode 100644 docs/specs/vma_spec.txt
20 create mode 100644 vma-reader.c
21 create mode 100644 vma-writer.c
22 create mode 100644 vma.c
23 create mode 100644 vma.h
25 diff --git a/Makefile b/Makefile
26 index 9ecbcbb..30a9268 100644
29 @@ -100,7 +100,7 @@ defconfig:
31 -include config-all-devices.mak
33 -all: $(DOCS) $(TOOLS) $(HELPERS-y) recurse-all
34 +all: $(DOCS) $(TOOLS) vma$(EXESUF) $(HELPERS-y) recurse-all
36 config-host.h: config-host.h-timestamp
37 config-host.h-timestamp: config-host.mak
38 @@ -194,6 +194,7 @@ tools-obj-$(CONFIG_POSIX) += compatfd.o
39 qemu-img$(EXESUF): qemu-img.o $(tools-obj-y) $(block-obj-y) libqemustub.a
40 qemu-nbd$(EXESUF): qemu-nbd.o $(tools-obj-y) $(block-obj-y) libqemustub.a
41 qemu-io$(EXESUF): qemu-io.o cmd.o $(tools-obj-y) $(block-obj-y) libqemustub.a
42 +vma$(EXESUF): vma.o vma-writer.o vma-reader.o $(tools-obj-y) $(block-obj-y) libqemustub.a
44 qemu-bridge-helper$(EXESUF): qemu-bridge-helper.o
46 diff --git a/Makefile.objs b/Makefile.objs
47 index cb46be5..b5732e2 100644
50 @@ -48,7 +48,7 @@ coroutine-obj-$(CONFIG_WIN32) += coroutine-win32.o
51 block-obj-y = iov.o cache-utils.o qemu-option.o module.o async.o
52 block-obj-y += nbd.o block.o blockjob.o aes.o qemu-config.o
53 block-obj-y += thread-pool.o qemu-progress.o qemu-sockets.o uri.o notify.o
54 -block-obj-y += backup.o
55 +block-obj-y += vma-writer.o backup.o
56 block-obj-y += $(coroutine-obj-y) $(qobject-obj-y) $(version-obj-y)
57 block-obj-$(CONFIG_POSIX) += event_notifier-posix.o aio-posix.o
58 block-obj-$(CONFIG_WIN32) += event_notifier-win32.o aio-win32.o
59 diff --git a/blockdev.c b/blockdev.c
60 index 68a8c55..80cb04d 100644
65 #include "arch_init.h"
69 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
71 @@ -1493,10 +1494,11 @@ char *qmp_backup(const char *backupfile, bool has_format, BackupFormat format,
72 /* Todo: try to auto-detect format based on file name */
73 format = has_format ? format : BACKUP_FORMAT_VMA;
75 - /* fixme: find driver for specifued format */
76 const BackupDriver *driver = NULL;
79 + if (format == BACKUP_FORMAT_VMA) {
80 + driver = &backup_vma_driver;
82 error_set(errp, ERROR_CLASS_GENERIC_ERROR, "unknown backup format");
85 diff --git a/docs/specs/vma_spec.txt b/docs/specs/vma_spec.txt
87 index 0000000..052c629
89 +++ b/docs/specs/vma_spec.txt
91 +=Virtual Machine Archive format (VMA)=
93 +This format contains a header which includes the VM configuration as
94 +binary blobs, and a list of devices (dev_id, name).
96 +The actual VM image data is stored inside extents. An extent contains
97 +up to 64 clusters, and start with a 512 byte header containing
98 +additional information for those clusters.
100 +We use a cluster size of 65536, and use 8 bytes for each
101 +cluster in the header to store the following information:
103 +* 1 byte dev_id (to identity the drive)
104 +* 2 bytes zero indicator (mark zero regions (16x4096))
105 +* 4 bytes cluster number
106 +* 1 byte not used (reserved)
108 +We only store non-zero blocks (such block is 4096 bytes).
110 +Each archive is marked with a uuid. The archive header and all
111 +extent headers includes that uuid and a MD5 checksum (over header
115 diff --git a/vma-reader.c b/vma-reader.c
117 index 0000000..2217a94
122 + * VMA: Virtual Machine Archive
124 + * Copyright (C) 2012 Proxmox Server Solutions
127 + * Dietmar Maurer (dietmar@proxmox.com)
129 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
130 + * See the COPYING file in the top-level directory.
139 +#include <sys/types.h>
140 +#include <sys/stat.h>
143 +#include <uuid/uuid.h>
145 +#include "qemu-common.h"
146 +#include "qemu_socket.h"
147 +#include "qemu-coroutine.h"
148 +#include "qemu-aio.h"
149 +#include "qemu/ratelimit.h"
153 +#define BITS_PER_LONG (sizeof(unsigned long) * 8)
155 +static unsigned char zero_vma_block[VMA_BLOCK_SIZE];
157 +typedef struct VmaRestoreState {
158 + BlockDriverState *bs;
160 + unsigned long *bitmap;
166 + GChecksum *md5csum;
167 + GHashTable *blob_hash;
168 + unsigned char *head_data;
169 + VmaDeviceInfo devinfo[256];
170 + VmaRestoreState rstate[256];
172 + guint8 vmstate_stream;
173 + uint32_t vmstate_clusters;
174 + /* to show restore percentage if run with -v */
176 + int64_t cluster_count;
177 + int64_t clusters_read;
178 + int clusters_read_per;
182 +g_int32_hash(gconstpointer v)
184 + return *(const uint32_t *)v;
188 +g_int32_equal(gconstpointer v1, gconstpointer v2)
190 + return *((const uint32_t *)v1) == *((const uint32_t *)v2);
193 +static int vma_reader_get_bitmap(VmaRestoreState *rstate, int64_t cluster_num)
196 + assert(rstate->bitmap);
198 + unsigned long val, idx, bit;
200 + idx = cluster_num / BITS_PER_LONG;
202 + assert(rstate->bitmap_size > idx);
204 + bit = cluster_num % BITS_PER_LONG;
205 + val = rstate->bitmap[idx];
207 + return !!(val & (1UL << bit));
210 +static void vma_reader_set_bitmap(VmaRestoreState *rstate, int64_t cluster_num,
214 + assert(rstate->bitmap);
216 + unsigned long val, idx, bit;
218 + idx = cluster_num / BITS_PER_LONG;
220 + assert(rstate->bitmap_size > idx);
222 + bit = cluster_num % BITS_PER_LONG;
223 + val = rstate->bitmap[idx];
225 + if (!(val & (1UL << bit))) {
229 + if (val & (1UL << bit)) {
230 + val &= ~(1UL << bit);
233 + rstate->bitmap[idx] = val;
236 +typedef struct VmaBlob {
242 +static const VmaBlob *get_header_blob(VmaReader *vmar, uint32_t pos)
245 + assert(vmar->blob_hash);
247 + return g_hash_table_lookup(vmar->blob_hash, &pos);
250 +static const char *get_header_str(VmaReader *vmar, uint32_t pos)
252 + const VmaBlob *blob = get_header_blob(vmar, pos);
256 + const char *res = (char *)blob->data;
257 + if (res[blob->len-1] != '\0') {
264 +safe_read(int fd, unsigned char *buf, size_t count)
269 + n = read(fd, buf, count);
270 + } while (n < 0 && errno == EINTR);
276 +full_read(int fd, unsigned char *buf, size_t len)
284 + n = safe_read(fd, buf, len);
306 +void vma_reader_destroy(VmaReader *vmar)
310 + if (vmar->fd >= 0) {
314 + if (vmar->cdata_list) {
315 + g_list_free(vmar->cdata_list);
319 + for (i = 1; i < 256; i++) {
320 + if (vmar->rstate[i].bitmap) {
321 + g_free(vmar->rstate[i].bitmap);
325 + if (vmar->md5csum) {
326 + g_checksum_free(vmar->md5csum);
329 + if (vmar->blob_hash) {
330 + g_hash_table_destroy(vmar->blob_hash);
333 + if (vmar->head_data) {
334 + g_free(vmar->head_data);
341 +static int vma_reader_read_head(VmaReader *vmar, Error **errp)
345 + assert(*errp == NULL);
347 + unsigned char md5sum[16];
351 + vmar->head_data = g_malloc(sizeof(VmaHeader));
353 + if (full_read(vmar->fd, vmar->head_data, sizeof(VmaHeader)) !=
354 + sizeof(VmaHeader)) {
355 + error_setg(errp, "can't read vma header - %s",
356 + errno ? strerror(errno) : "got EOF");
360 + VmaHeader *h = (VmaHeader *)vmar->head_data;
362 + if (h->magic != VMA_MAGIC) {
363 + error_setg(errp, "not a vma file - wrong magic number");
367 + uint32_t header_size = GUINT32_FROM_BE(h->header_size);
368 + int need = header_size - sizeof(VmaHeader);
370 + error_setg(errp, "wrong vma header size %d", header_size);
374 + vmar->head_data = g_realloc(vmar->head_data, header_size);
375 + h = (VmaHeader *)vmar->head_data;
377 + if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
379 + error_setg(errp, "can't read vma header data - %s",
380 + errno ? strerror(errno) : "got EOF");
384 + memcpy(md5sum, h->md5sum, 16);
385 + memset(h->md5sum, 0, 16);
387 + g_checksum_reset(vmar->md5csum);
388 + g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
390 + g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
392 + if (memcmp(md5sum, h->md5sum, 16) != 0) {
393 + error_setg(errp, "wrong vma header chechsum");
397 + /* we can modify header data after checksum verify */
398 + h->header_size = header_size;
400 + h->version = GUINT32_FROM_BE(h->version);
401 + if (h->version != 1) {
402 + error_setg(errp, "wrong vma version %d", h->version);
406 + h->ctime = GUINT64_FROM_BE(h->ctime);
407 + h->blob_buffer_offset = GUINT32_FROM_BE(h->blob_buffer_offset);
408 + h->blob_buffer_size = GUINT32_FROM_BE(h->blob_buffer_size);
410 + uint32_t bstart = h->blob_buffer_offset + 1;
411 + uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
413 + if (bstart <= sizeof(VmaHeader)) {
414 + error_setg(errp, "wrong vma blob buffer offset %d",
415 + h->blob_buffer_offset);
419 + if (bend > header_size) {
420 + error_setg(errp, "wrong vma blob buffer size %d/%d",
421 + h->blob_buffer_offset, h->blob_buffer_size);
425 + while ((bstart + 2) <= bend) {
426 + uint32_t size = vmar->head_data[bstart] +
427 + (vmar->head_data[bstart+1] << 8);
428 + if ((bstart + size + 2) <= bend) {
429 + VmaBlob *blob = g_new0(VmaBlob, 1);
430 + blob->start = bstart - h->blob_buffer_offset;
432 + blob->data = vmar->head_data + bstart + 2;
433 + g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
435 + bstart += size + 2;
440 + for (i = 1; i < 256; i++) {
441 + VmaDeviceInfoHeader *dih = &h->dev_info[i];
442 + uint32_t devname_ptr = GUINT32_FROM_BE(dih->devname_ptr);
443 + uint64_t size = GUINT64_FROM_BE(dih->size);
444 + const char *devname = get_header_str(vmar, devname_ptr);
446 + if (size && devname) {
448 + vmar->devinfo[i].size = size;
449 + vmar->devinfo[i].devname = devname;
451 + if (strcmp(devname, "vmstate") == 0) {
452 + vmar->vmstate_stream = i;
458 + error_setg(errp, "vma does not contain data");
462 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
463 + uint32_t name_ptr = GUINT32_FROM_BE(h->config_names[i]);
464 + uint32_t data_ptr = GUINT32_FROM_BE(h->config_data[i]);
466 + if (!(name_ptr && data_ptr)) {
469 + const char *name = get_header_str(vmar, name_ptr);
470 + const VmaBlob *blob = get_header_blob(vmar, data_ptr);
472 + if (!(name && blob)) {
473 + error_setg(errp, "vma contains invalid data pointers");
477 + VmaConfigData *cdata = g_new0(VmaConfigData, 1);
478 + cdata->name = name;
479 + cdata->data = blob->data;
480 + cdata->len = blob->len;
482 + vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
488 +VmaReader *vma_reader_create(const char *filename, Error **errp)
493 + VmaReader *vmar = g_new0(VmaReader, 1);
495 + if (strcmp(filename, "-") == 0) {
498 + vmar->fd = open(filename, O_RDONLY);
501 + if (vmar->fd < 0) {
502 + error_setg(errp, "can't open file %s - %s\n", filename,
507 + vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
508 + if (!vmar->md5csum) {
509 + error_setg(errp, "can't allocate cmsum\n");
513 + vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
516 + if (vma_reader_read_head(vmar, errp) < 0) {
524 + vma_reader_destroy(vmar);
530 +VmaHeader *vma_reader_get_header(VmaReader *vmar)
533 + assert(vmar->head_data);
535 + return (VmaHeader *)(vmar->head_data);
538 +GList *vma_reader_get_config_data(VmaReader *vmar)
541 + assert(vmar->head_data);
543 + return vmar->cdata_list;
546 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
551 + if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
552 + return &vmar->devinfo[dev_id];
558 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockDriverState *bs,
559 + bool write_zeroes, Error **errp)
562 + assert(bs != NULL);
564 + assert(vmar->rstate[dev_id].bs == NULL);
566 + int64_t size = bdrv_getlength(bs);
567 + if (size != vmar->devinfo[dev_id].size) {
568 + error_setg(errp, "vma_reader_register_bs for stream %s failed - "
569 + "unexpected size %zd != %zd", vmar->devinfo[dev_id].devname,
570 + size, vmar->devinfo[dev_id].size);
574 + vmar->rstate[dev_id].bs = bs;
575 + vmar->rstate[dev_id].write_zeroes = write_zeroes;
577 + int64_t bitmap_size = (size/BDRV_SECTOR_SIZE) +
578 + (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG - 1;
579 + bitmap_size /= (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG;
581 + vmar->rstate[dev_id].bitmap_size = bitmap_size;
582 + vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
584 + vmar->cluster_count += size/VMA_CLUSTER_SIZE;
589 +static ssize_t safe_write(int fd, void *buf, size_t count)
594 + n = write(fd, buf, count);
595 + } while (n < 0 && errno == EINTR);
600 +static size_t full_write(int fd, void *buf, size_t len)
608 + n = safe_write(fd, buf, len);
618 + /* incomplete write ? */
625 +static int restore_write_data(VmaReader *vmar, guint8 dev_id,
626 + BlockDriverState *bs, int vmstate_fd,
627 + unsigned char *buf, int64_t sector_num,
628 + int nb_sectors, Error **errp)
632 + if (dev_id == vmar->vmstate_stream) {
633 + if (vmstate_fd >= 0) {
634 + int len = nb_sectors * BDRV_SECTOR_SIZE;
635 + int res = full_write(vmstate_fd, buf, len);
637 + error_setg(errp, "write vmstate failed %d", res);
642 + int res = bdrv_write(bs, sector_num, buf, nb_sectors);
644 + error_setg(errp, "bdrv_write to %s failed (%d)",
645 + bdrv_get_device_name(bs), res);
651 +static int restore_extent(VmaReader *vmar, unsigned char *buf,
652 + int extent_size, int vmstate_fd,
653 + bool verbose, Error **errp)
658 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
659 + int start = VMA_EXTENT_HEADER_SIZE;
662 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
663 + uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
664 + uint64_t cluster_num = block_info & 0xffffffff;
665 + uint8_t dev_id = (block_info >> 32) & 0xff;
666 + uint16_t mask = block_info >> (32+16);
667 + int64_t max_sector;
673 + VmaRestoreState *rstate = &vmar->rstate[dev_id];
674 + BlockDriverState *bs = NULL;
676 + if (dev_id != vmar->vmstate_stream) {
679 + error_setg(errp, "got wrong dev id %d", dev_id);
683 + if (vma_reader_get_bitmap(rstate, cluster_num)) {
684 + error_setg(errp, "found duplicated cluster %zd for stream %s",
685 + cluster_num, vmar->devinfo[dev_id].devname);
688 + vma_reader_set_bitmap(rstate, cluster_num, 1);
690 + max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
692 + max_sector = G_MAXINT64;
693 + if (cluster_num != vmar->vmstate_clusters) {
694 + error_setg(errp, "found out of order vmstate data");
697 + vmar->vmstate_clusters++;
700 + vmar->clusters_read++;
703 + time_t duration = time(NULL) - vmar->start_time;
704 + int percent = (vmar->clusters_read*100)/vmar->cluster_count;
705 + if (percent != vmar->clusters_read_per) {
706 + printf("progress %d%% (read %zd bytes, duration %zd sec)\n",
707 + percent, vmar->clusters_read*VMA_CLUSTER_SIZE,
710 + vmar->clusters_read_per = percent;
714 + /* try to write whole clusters to speedup restore */
715 + if (mask == 0xffff) {
716 + if ((start + VMA_CLUSTER_SIZE) > extent_size) {
717 + error_setg(errp, "short vma extent - too many blocks");
720 + int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
722 + int64_t end_sector = sector_num +
723 + VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
725 + if (end_sector > max_sector) {
726 + end_sector = max_sector;
729 + if (end_sector <= sector_num) {
730 + error_setg(errp, "got wrong block address - write bejond end");
734 + int nb_sectors = end_sector - sector_num;
735 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd, buf + start,
736 + sector_num, nb_sectors, errp) < 0) {
740 + start += VMA_CLUSTER_SIZE;
745 + for (j = 0; j < 16; j++) {
746 + int64_t sector_num = (cluster_num*VMA_CLUSTER_SIZE +
747 + j*VMA_BLOCK_SIZE)/BDRV_SECTOR_SIZE;
749 + int64_t end_sector = sector_num +
750 + VMA_BLOCK_SIZE/BDRV_SECTOR_SIZE;
751 + if (end_sector > max_sector) {
752 + end_sector = max_sector;
756 + if ((start + VMA_BLOCK_SIZE) > extent_size) {
757 + error_setg(errp, "short vma extent - too many blocks");
761 + if (end_sector <= sector_num) {
762 + error_setg(errp, "got wrong block address - "
763 + "write bejond end");
767 + int nb_sectors = end_sector - sector_num;
768 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd,
769 + buf + start, sector_num,
770 + nb_sectors, errp) < 0) {
774 + start += VMA_BLOCK_SIZE;
778 + if (rstate->write_zeroes && (end_sector > sector_num)) {
779 + /* Todo: use bdrv_co_write_zeroes (but that need to
780 + * be run inside coroutine?)
782 + int nb_sectors = end_sector - sector_num;
783 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd,
784 + zero_vma_block, sector_num,
785 + nb_sectors, errp) < 0) {
796 + if (start != extent_size) {
797 + error_setg(errp, "vma extent error - missing blocks");
804 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
808 + assert(vmar->head_data);
811 + unsigned char buf[VMA_MAX_EXTENT_SIZE];
813 + unsigned char md5sum[16];
814 + VmaHeader *h = (VmaHeader *)vmar->head_data;
816 + vmar->start_time = time(NULL);
819 + int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
821 + error_setg(errp, "read failed - %s", strerror(errno));
831 + if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
832 + error_setg(errp, "read short extent (%d bytes)", buf_pos);
836 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
838 + /* extract md5sum */
839 + memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
840 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
842 + g_checksum_reset(vmar->md5csum);
843 + g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
845 + g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
847 + if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
848 + error_setg(errp, "wrong vma extent header chechsum");
852 + if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
853 + error_setg(errp, "wrong vma extent uuid");
857 + if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
858 + error_setg(errp, "wrong vma extent header magic");
862 + int block_count = GUINT16_FROM_BE(ehead->block_count);
863 + int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
865 + if (buf_pos < extent_size) {
866 + error_setg(errp, "short vma extent (%d < %d)", buf_pos,
871 + if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
876 + if (buf_pos > extent_size) {
877 + memmove(buf, buf + extent_size, buf_pos - extent_size);
878 + buf_pos = buf_pos - extent_size;
887 + for (i = 1; i < 256; i++) {
888 + VmaRestoreState *rstate = &vmar->rstate[i];
893 + if (bdrv_flush(rstate->bs) < 0) {
894 + error_setg(errp, "vma bdrv_flush %s failed",
895 + vmar->devinfo[i].devname);
899 + if (vmar->devinfo[i].size &&
900 + (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
901 + assert(rstate->bitmap);
903 + int64_t cluster_num, end;
905 + end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
908 + for (cluster_num = 0; cluster_num < end; cluster_num++) {
909 + if (!vma_reader_get_bitmap(rstate, cluster_num)) {
910 + error_setg(errp, "detected missing cluster %zd "
911 + "for stream %s", cluster_num,
912 + vmar->devinfo[i].devname);
922 diff --git a/vma-writer.c b/vma-writer.c
924 index 0000000..688af4b
929 + * VMA: Virtual Machine Archive
931 + * Copyright (C) 2012 Proxmox Server Solutions
934 + * Dietmar Maurer (dietmar@proxmox.com)
936 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
937 + * See the COPYING file in the top-level directory.
946 +#include <sys/types.h>
947 +#include <sys/stat.h>
950 +#include <uuid/uuid.h>
952 +#include "qemu-common.h"
953 +#include "qemu_socket.h"
954 +#include "qemu-coroutine.h"
955 +#include "qemu-aio.h"
956 +#include "qemu/ratelimit.h"
959 +#include "monitor.h"
963 +#define DPRINTF(fmt, ...)\
964 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
966 +#define WRITE_BUFFERS 5
968 +typedef struct VmaAIOCB VmaAIOCB;
971 + unsigned char buffer[VMA_MAX_EXTENT_SIZE];
982 + bool header_written;
985 + /* we always write extents */
986 + unsigned char outbuf[VMA_MAX_EXTENT_SIZE];
987 + int outbuf_pos; /* in bytes */
988 + int outbuf_count; /* in VMA_BLOCKS */
989 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
991 + VmaAIOCB aiocbs[WRITE_BUFFERS];
994 + GChecksum *md5csum;
995 + CoMutex writer_lock;
996 + CoMutex flush_lock;
997 + Coroutine *co_writer;
1000 + /* drive informations */
1001 + VmaStreamInfo stream_info[256];
1002 + guint stream_count;
1004 + guint8 vmstate_stream;
1005 + uint32_t vmstate_clusters;
1007 + /* header blob table */
1008 + char *header_blob_table;
1009 + uint32_t header_blob_table_size;
1010 + uint32_t header_blob_table_pos;
1012 + /* store for config blobs */
1013 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1014 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1015 + uint32_t config_count;
1018 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1022 + if (vmaw->status < 0) {
1026 + vmaw->status = -1;
1028 + va_start(ap, fmt);
1029 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1032 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1035 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1038 + if (len > 65535) {
1042 + if (!vmaw->header_blob_table ||
1043 + (vmaw->header_blob_table_size <
1044 + (vmaw->header_blob_table_pos + len + 2))) {
1045 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1047 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1048 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1049 + 0, newsize - vmaw->header_blob_table_size);
1050 + vmaw->header_blob_table_size = newsize;
1053 + uint32_t cpos = vmaw->header_blob_table_pos;
1054 + vmaw->header_blob_table[cpos] = len & 255;
1055 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1056 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1057 + vmaw->header_blob_table_pos += len + 2;
1061 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1065 + size_t len = strlen(str) + 1;
1067 + return allocate_header_blob(vmaw, str, len);
1070 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1074 + assert(!vmaw->header_written);
1075 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1080 + uint32_t name_ptr = allocate_header_string(vmaw, name);
1085 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1090 + vmaw->config_names[vmaw->config_count] = name_ptr;
1091 + vmaw->config_data[vmaw->config_count] = data_ptr;
1093 + vmaw->config_count++;
1098 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1103 + assert(!vmaw->status);
1105 + if (vmaw->header_written) {
1106 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1107 + "already written");
1111 + guint n = vmaw->stream_count + 1;
1113 + /* we can have dev_ids form 1 to 255 (0 reserved)
1114 + * 255(-1) reseverd for safety
1117 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1118 + "too many drives");
1123 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1124 + "got strange size %zd", size);
1128 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1130 + vmaw->stream_info[n].devname = g_strdup(devname);
1131 + vmaw->stream_info[n].size = size;
1133 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1136 + vmaw->stream_count = n;
1138 + if (strcmp(devname, "vmstate") == 0) {
1139 + vmaw->vmstate_stream = n;
1145 +static void vma_co_continue_write(void *opaque)
1147 + VmaWriter *vmaw = opaque;
1149 + qemu_aio_set_fd_handler(vmaw->fd, NULL, NULL, NULL, NULL);
1151 + DPRINTF("vma_co_continue_write\n");
1152 + qemu_coroutine_enter(vmaw->co_writer, NULL);
1155 +static ssize_t coroutine_fn
1156 +vma_co_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1161 + /* atomic writes (we cannot interleave writes) */
1162 + qemu_co_mutex_lock(&vmaw->writer_lock);
1164 + DPRINTF("vma_co_write enter %zd\n", bytes);
1166 + while (done < bytes) {
1167 + ret = write(vmaw->fd, buf + done, bytes - done);
1170 + DPRINTF("vma_co_write written %zd %zd\n", done, ret);
1171 + } else if (ret < 0) {
1172 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1173 + DPRINTF("vma_co_write yield %zd\n", done);
1175 + vmaw->co_writer = qemu_coroutine_self();
1176 + qemu_aio_set_fd_handler(vmaw->fd, NULL, vma_co_continue_write,
1179 + qemu_coroutine_yield();
1180 + DPRINTF("vma_co_write restart %zd\n", done);
1182 + vma_writer_set_error(vmaw, "vma_co_write write error - %s",
1184 + done = -1; /* always return failure for partial writes */
1187 + } else if (ret == 0) {
1188 + /* should not happen - simply try again */
1192 + qemu_co_mutex_unlock(&vmaw->writer_lock);
1194 + DPRINTF("vma_co_write leave %zd\n", done);
1198 +static void coroutine_fn vma_co_writer_task(void *opaque)
1200 + VmaAIOCB *cb = opaque;
1202 + DPRINTF("vma_co_writer_task start\n");
1204 + int64_t done = vma_co_write(cb->vmaw, cb->buffer, cb->bytes);
1205 + DPRINTF("vma_co_writer_task write done %zd\n", done);
1207 + if (done != cb->bytes) {
1208 + DPRINTF("vma_co_writer_task failed write %zd %zd", cb->bytes, done);
1209 + vma_writer_set_error(cb->vmaw, "vma_co_writer_task failed write %zd",
1215 + qemu_co_queue_next(&cb->vmaw->wqueue);
1217 + DPRINTF("vma_co_writer_task end\n");
1220 +static void coroutine_fn vma_queue_flush(VmaWriter *vmaw)
1222 + DPRINTF("vma_queue_flush enter\n");
1228 + VmaAIOCB *cb = NULL;
1229 + for (i = 0; i < WRITE_BUFFERS; i++) {
1230 + if (vmaw->aiocbs[i].bytes) {
1231 + cb = &vmaw->aiocbs[i];
1232 + DPRINTF("FOUND USED AIO BUFFER %d %zd\n", i,
1233 + vmaw->aiocbs[i].bytes);
1240 + qemu_co_queue_wait(&vmaw->wqueue);
1243 + DPRINTF("vma_queue_flush leave\n");
1247 + * NOTE: pipe buffer size in only 4096 bytes on linux (see 'ulimit -a')
1248 + * So we need to create a coroutione to allow 'parallel' execution.
1250 +static ssize_t coroutine_fn
1251 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1253 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1257 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1259 + VmaAIOCB *cb = NULL;
1262 + for (i = 0; i < WRITE_BUFFERS; i++) {
1263 + if (!vmaw->aiocbs[i].bytes) {
1264 + cb = &vmaw->aiocbs[i];
1269 + qemu_co_queue_wait(&vmaw->wqueue);
1273 + memcpy(cb->buffer, buf, bytes);
1274 + cb->bytes = bytes;
1277 + DPRINTF("vma_queue_write start %zd\n", bytes);
1278 + cb->co = qemu_coroutine_create(vma_co_writer_task);
1279 + qemu_coroutine_enter(cb->co, cb);
1281 + DPRINTF("vma_queue_write leave\n");
1286 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, int64_t speed,
1291 + assert(sizeof(VmaHeader) == (4096 + 8192));
1292 + assert(sizeof(VmaExtentHeader) == 512);
1294 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1297 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1298 + if (!vmaw->md5csum) {
1299 + error_setg(errp, "can't allocate cmsum\n");
1303 + if (strstart(filename, "exec:", &p)) {
1304 + vmaw->cmd = popen(p, "w");
1305 + if (vmaw->cmd == NULL) {
1306 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1310 + vmaw->fd = fileno(vmaw->cmd);
1311 + socket_set_nonblock(vmaw->fd);
1316 + const char *tmp_id_str;
1318 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1319 + oflags = O_NONBLOCK|O_WRONLY;
1320 + vmaw->fd = qemu_open(filename, oflags, 0644);
1321 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1322 + oflags = O_NONBLOCK|O_WRONLY;
1323 + vmaw->fd = qemu_open(filename, oflags, 0644);
1324 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1325 + vmaw->fd = monitor_get_fd(cur_mon, tmp_id_str, errp);
1326 + if (vmaw->fd < 0) {
1330 + oflags = O_NONBLOCK|O_WRONLY|O_CREAT|O_EXCL;
1331 + vmaw->fd = qemu_open(filename, oflags, 0644);
1334 + if (vmaw->fd < 0) {
1335 + error_setg(errp, "can't open file %s - %s\n", filename,
1341 + vmaw->outbuf_count = 0;
1342 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1344 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1346 + qemu_co_mutex_init(&vmaw->writer_lock);
1347 + qemu_co_mutex_init(&vmaw->flush_lock);
1348 + qemu_co_queue_init(&vmaw->wqueue);
1350 + uuid_copy(vmaw->uuid, uuid);
1353 + speed = 10*1024*1024*1024LLU; /* default 10GB/s */
1356 + ratelimit_set_speed(&vmaw->limit, speed, 100000000ULL /* 0.1 sec */);
1363 + pclose(vmaw->cmd);
1364 + } else if (vmaw->fd >= 0) {
1368 + if (vmaw->md5csum) {
1369 + g_checksum_free(vmaw->md5csum);
1378 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1381 + int header_clusters = 8;
1382 + char buf[65536*header_clusters];
1383 + VmaHeader *head = (VmaHeader *)buf;
1387 + DPRINTF("VMA WRITE HEADER\n");
1389 + if (vmaw->status < 0) {
1390 + return vmaw->status;
1393 + memset(buf, 0, sizeof(buf));
1395 + head->magic = VMA_MAGIC;
1396 + head->version = GUINT32_TO_BE(1); /* v1 */
1397 + memcpy(head->uuid, vmaw->uuid, 16);
1399 + time_t ctime = time(NULL);
1400 + head->ctime = GUINT64_TO_BE(ctime);
1402 + if (!vmaw->stream_count) {
1406 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1407 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1408 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1411 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1412 + for (i = 1; i <= 254; i++) {
1413 + VmaStreamInfo *si = &vmaw->stream_info[i];
1415 + assert(si->devname);
1416 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1417 + if (!devname_ptr) {
1420 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1421 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1425 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1426 + head->header_size = GUINT32_TO_BE(header_size);
1428 + if (header_size > sizeof(buf)) {
1429 + return -1; /* just to be sure */
1432 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1433 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1434 + vmaw->header_blob_table_size);
1435 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1436 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1438 + g_checksum_reset(vmaw->md5csum);
1439 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1441 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1443 + return vma_queue_write(vmaw, buf, header_size);
1446 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1453 + if (vmaw->status < 0) {
1454 + return vmaw->status;
1457 + if (!vmaw->header_written) {
1458 + vmaw->header_written = true;
1459 + ret = vma_write_header(vmaw);
1461 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1466 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1469 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1471 + ehead->magic = VMA_EXTENT_MAGIC;
1472 + ehead->reserved1 = 0;
1474 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1475 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1478 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1481 + ehead->block_count = GUINT16_TO_BE(block_count);
1483 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1484 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1486 + g_checksum_reset(vmaw->md5csum);
1487 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1489 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1491 + int bytes = vmaw->outbuf_pos;
1492 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1493 + if (ret != bytes) {
1494 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1497 + vmaw->outbuf_count = 0;
1498 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1500 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1501 + vmaw->outbuf_block_info[i] = 0;
1504 + return vmaw->status;
1507 +static int vma_count_open_streams(VmaWriter *vmaw)
1509 + g_assert(vmaw != NULL);
1512 + int open_drives = 0;
1513 + for (i = 0; i <= 255; i++) {
1514 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1519 + return open_drives;
1523 + * all jobs should call this when there is no more data
1524 + * Returns: number of remaining stream (0 ==> finished)
1527 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1529 + g_assert(vmaw != NULL);
1531 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1532 + if (!vmaw->stream_info[dev_id].size) {
1533 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1534 + "no such stream %d", dev_id);
1537 + if (vmaw->stream_info[dev_id].finished) {
1538 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1539 + "stream already closed %d", dev_id);
1543 + vmaw->stream_info[dev_id].finished = true;
1545 + int open_drives = vma_count_open_streams(vmaw);
1547 + if (open_drives <= 0) {
1548 + DPRINTF("vma_writer_set_status all drives completed\n");
1549 + qemu_co_mutex_lock(&vmaw->flush_lock);
1550 + int ret = vma_writer_flush(vmaw);
1551 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1553 + vma_writer_set_error(vmaw, "vma_writer_close_stream: flush failed");
1557 + return open_drives;
1560 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1564 + g_assert(vmaw != NULL);
1567 + status->status = vmaw->status;
1568 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1569 + for (i = 0; i <= 255; i++) {
1570 + status->stream_info[i] = vmaw->stream_info[i];
1573 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1576 + status->closed = vmaw->closed;
1578 + return vmaw->status;
1581 +static int vma_writer_get_buffer(VmaWriter *vmaw, size_t bytes)
1585 + qemu_co_mutex_lock(&vmaw->flush_lock);
1588 + uint64_t delay_ns = ratelimit_calculate_delay(&vmaw->limit, bytes);
1590 + DPRINTF("DELAY %zd\n", delay_ns);
1591 + co_sleep_ns(rt_clock, delay_ns);
1594 + /* wait until buffer is available */
1595 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1596 + ret = vma_writer_flush(vmaw);
1598 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1603 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1609 +int64_t coroutine_fn
1610 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1611 + unsigned char *buf, size_t *zero_bytes)
1613 + g_assert(vmaw != NULL);
1614 + g_assert(zero_bytes != NULL);
1618 + if (vmaw->status < 0) {
1619 + return vmaw->status;
1622 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1623 + vma_writer_set_error(vmaw, "vma_writer_write: "
1624 + "no such stream %d", dev_id);
1628 + if (vmaw->stream_info[dev_id].finished) {
1629 + vma_writer_set_error(vmaw, "vma_writer_write: "
1630 + "stream already closed %d", dev_id);
1635 + if (cluster_num >= (((uint64_t)1)<<32)) {
1636 + vma_writer_set_error(vmaw, "vma_writer_write: "
1637 + "cluster number out of range");
1641 + if (dev_id == vmaw->vmstate_stream) {
1642 + if (cluster_num != vmaw->vmstate_clusters) {
1643 + vma_writer_set_error(vmaw, "vma_writer_write: "
1644 + "non sequential vmstate write");
1646 + vmaw->vmstate_clusters++;
1647 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1648 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1652 + /* detect block containing zeroes */
1655 + uint16_t mask = 0;
1656 + size_t real_size = 0;
1657 + for (i = 0; i < 16; i++) {
1658 + unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1659 + if (!buffer_is_zero(vmablock, VMA_BLOCK_SIZE)) {
1661 + real_size += VMA_BLOCK_SIZE;
1666 + /* wait until buffer is available */
1667 + if (vma_writer_get_buffer(vmaw, real_size) < 0) {
1668 + vma_writer_set_error(vmaw, "vma_writer_write: "
1669 + "vma_writer_get_buffer failed");
1673 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1676 + for (i = 0; i < 16; i++) {
1677 + unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1679 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock, VMA_BLOCK_SIZE);
1680 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1682 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1683 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1684 + *zero_bytes += VMA_BLOCK_SIZE;
1690 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1691 + block_info |= ((uint64_t)dev_id) << 32;
1692 + block_info |= (cluster_num & 0xffffffff);
1693 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1695 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1697 + vmaw->outbuf_count++;
1699 + /** NOTE: We allways write whole clusters, but we correctly set
1700 + * transferred bytes. So transferred == size when when everything
1703 + size_t transferred = VMA_CLUSTER_SIZE;
1705 + if (dev_id != vmaw->vmstate_stream) {
1706 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1707 + if (last > vmaw->stream_info[dev_id].size) {
1708 + uint64_t diff = last - vmaw->stream_info[dev_id].size;
1709 + if (diff >= VMA_CLUSTER_SIZE) {
1710 + vma_writer_set_error(vmaw, "vma_writer_write: "
1711 + "read after last cluster");
1714 + transferred -= diff;
1718 + vmaw->stream_info[dev_id].transferred += transferred;
1720 + return transferred;
1723 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1725 + g_assert(vmaw != NULL);
1729 + vma_queue_flush(vmaw);
1731 + /* this should not happen - just to be sure */
1732 + while (!qemu_co_queue_empty(&vmaw->wqueue)) {
1733 + DPRINTF("vma_writer_close wait\n");
1734 + co_sleep_ns(rt_clock, 1000000);
1738 + if (pclose(vmaw->cmd) < 0) {
1739 + vma_writer_set_error(vmaw, "vma_writer_close: "
1740 + "pclose failed - %s", strerror(errno));
1743 + if (close(vmaw->fd) < 0) {
1744 + vma_writer_set_error(vmaw, "vma_writer_close: "
1745 + "close failed - %s", strerror(errno));
1749 + for (i = 0; i <= 255; i++) {
1750 + VmaStreamInfo *si = &vmaw->stream_info[i];
1752 + if (!si->finished) {
1753 + vma_writer_set_error(vmaw, "vma_writer_close: "
1754 + "detected open stream '%s'", si->devname);
1755 + } else if ((si->transferred != si->size) &&
1756 + (i != vmaw->vmstate_stream)) {
1757 + vma_writer_set_error(vmaw, "vma_writer_close: "
1758 + "incomplete stream '%s' (%zd != %zd)",
1759 + si->devname, si->transferred, si->size);
1764 + for (i = 0; i <= 255; i++) {
1765 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1770 + if (vmaw->status < 0 && *errp == NULL) {
1771 + error_setg(errp, "%s", vmaw->errmsg);
1774 + return vmaw->status;
1777 +void vma_writer_destroy(VmaWriter *vmaw)
1783 + for (i = 0; i <= 255; i++) {
1784 + if (vmaw->stream_info[i].devname) {
1785 + g_free(vmaw->stream_info[i].devname);
1789 + if (vmaw->md5csum) {
1790 + g_checksum_free(vmaw->md5csum);
1796 +/* backup driver plugin */
1798 +static int vma_dump_cb(void *opaque, uint8_t dev_id, int64_t cluster_num,
1799 + unsigned char *buf, size_t *zero_bytes)
1801 + VmaWriter *vmaw = opaque;
1803 + return vma_writer_write(vmaw, dev_id, cluster_num, buf, zero_bytes);
1806 +static int vma_close_cb(void *opaque, Error **errp)
1808 + VmaWriter *vmaw = opaque;
1810 + int res = vma_writer_close(vmaw, errp);
1811 + vma_writer_destroy(vmaw);
1816 +static int vma_complete_cb(void *opaque, uint8_t dev_id, int ret)
1818 + VmaWriter *vmaw = opaque;
1821 + vma_writer_set_error(vmaw, "backup_complete_cb %d", ret);
1824 + return vma_writer_close_stream(vmaw, dev_id);
1827 +static int vma_register_stream_cb(void *opaque, const char *devname,
1830 + VmaWriter *vmaw = opaque;
1832 + return vma_writer_register_stream(vmaw, devname, size);
1835 +static int vma_register_config_cb(void *opaque, const char *name,
1836 + gpointer data, size_t data_len)
1838 + VmaWriter *vmaw = opaque;
1840 + return vma_writer_add_config(vmaw, name, data, data_len);
1843 +static void *vma_open_cb(const char *filename, uuid_t uuid, int64_t speed,
1846 + return vma_writer_create(filename, uuid, speed, errp);
1849 +const BackupDriver backup_vma_driver = {
1851 + .open_cb = vma_open_cb,
1852 + .close_cb = vma_close_cb,
1853 + .register_config_cb = vma_register_config_cb,
1854 + .register_stream_cb = vma_register_stream_cb,
1855 + .dump_cb = vma_dump_cb,
1856 + .complete_cb = vma_complete_cb,
1859 diff --git a/vma.c b/vma.c
1860 new file mode 100644
1861 index 0000000..9b47b92
1866 + * VMA: Virtual Machine Archive
1868 + * Copyright (C) 2012 Proxmox Server Solutions
1871 + * Dietmar Maurer (dietmar@proxmox.com)
1873 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1874 + * See the COPYING file in the top-level directory.
1880 +#include <unistd.h>
1882 +#include <string.h>
1883 +#include <sys/types.h>
1884 +#include <sys/stat.h>
1888 +#include "qemu-common.h"
1889 +#include "qemu-option.h"
1890 +#include "qemu-error.h"
1892 +#include "sysemu.h"
1893 +#include "block_int.h"
1897 +static void help(void)
1899 + const char *help_msg =
1900 + "usage: vma command [command options]\n"
1902 + "vma list <filename>\n"
1903 + "vma create <filename> [-c config] <archive> pathname ...\n"
1904 + "vma extract <filename> [-r] <targetdir>\n"
1907 + printf("%s", help_msg);
1911 +static const char *extract_devname(const char *path, char **devname, int index)
1915 + const char *sep = strchr(path, '=');
1918 + *devname = g_strndup(path, sep - path);
1922 + *devname = g_strdup_printf("disk%d", index);
1931 +static void print_content(VmaReader *vmar)
1935 + VmaHeader *head = vma_reader_get_header(vmar);
1937 + GList *l = vma_reader_get_config_data(vmar);
1938 + while (l && l->data) {
1939 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1940 + l = g_list_next(l);
1941 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1945 + VmaDeviceInfo *di;
1946 + for (i = 1; i < 255; i++) {
1947 + di = vma_reader_get_device_info(vmar, i);
1949 + if (strcmp(di->devname, "vmstate") == 0) {
1950 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1952 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1953 + i, di->size, di->devname);
1957 + /* ctime is the last entry we print */
1958 + printf("CTIME: %s", ctime(&head->ctime));
1962 +static int list_content(int argc, char **argv)
1965 + const char *filename;
1968 + c = getopt(argc, argv, "h");
1978 + g_assert_not_reached();
1982 + /* Get the filename */
1983 + if ((optind + 1) != argc) {
1986 + filename = argv[optind++];
1988 + Error *errp = NULL;
1989 + VmaReader *vmar = vma_reader_create(filename, &errp);
1992 + g_error("%s", error_get_pretty(errp));
1995 + print_content(vmar);
1997 + vma_reader_destroy(vmar);
2002 +typedef struct RestoreMap {
2008 +static int extract_content(int argc, char **argv)
2012 + const char *filename;
2013 + const char *dirname;
2014 + const char *readmap = NULL;
2017 + c = getopt(argc, argv, "hvr:");
2037 + /* Get the filename */
2038 + if ((optind + 2) != argc) {
2041 + filename = argv[optind++];
2042 + dirname = argv[optind++];
2044 + Error *errp = NULL;
2045 + VmaReader *vmar = vma_reader_create(filename, &errp);
2048 + g_error("%s", error_get_pretty(errp));
2051 + if (mkdir(dirname, 0777) < 0) {
2052 + g_error("unable to create target directory %s - %s",
2053 + dirname, strerror(errno));
2056 + GList *l = vma_reader_get_config_data(vmar);
2057 + while (l && l->data) {
2058 + VmaConfigData *cdata = (VmaConfigData *)l->data;
2059 + l = g_list_next(l);
2060 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
2061 + GError *err = NULL;
2062 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
2064 + g_error("unable to write file: %s", err->message);
2068 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
2071 + print_content(vmar);
2073 + FILE *map = fopen(readmap, "r");
2075 + g_error("unable to open fifo %s - %s", readmap, strerror(errno));
2080 + char *line = fgets(inbuf, sizeof(inbuf), map);
2081 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
2084 + int len = strlen(line);
2085 + if (line[len - 1] == '\n') {
2086 + line[len - 1] = '\0';
2094 + if (line[0] == '0' && line[1] == ':') {
2096 + write_zero = false;
2097 + } else if (line[0] == '1' && line[1] == ':') {
2099 + write_zero = true;
2101 + g_error("read map failed - parse error ('%s')", inbuf);
2104 + char *devname = NULL;
2105 + path = extract_devname(path, &devname, -1);
2107 + g_error("read map failed - no dev name specified ('%s')",
2111 + RestoreMap *map = g_new0(RestoreMap, 1);
2112 + map->devname = g_strdup(devname);
2113 + map->path = g_strdup(path);
2114 + map->write_zero = write_zero;
2116 + g_hash_table_insert(devmap, map->devname, map);
2122 + int vmstate_fd = -1;
2123 + guint8 vmstate_stream = 0;
2125 + for (i = 1; i < 255; i++) {
2126 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2127 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2128 + vmstate_stream = i;
2129 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2130 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2131 + if (vmstate_fd < 0) {
2132 + g_error("create vmstate file '%s' failed - %s", statefn,
2137 + char *devfn = NULL;
2138 + int flags = BDRV_O_RDWR|BDRV_O_CACHE_WB;
2139 + bool write_zero = true;
2143 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2144 + if (map == NULL) {
2145 + g_error("no device name mapping for %s", di->devname);
2147 + devfn = map->path;
2148 + write_zero = map->write_zero;
2150 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2151 + dirname, di->devname);
2152 + printf("DEVINFO %s %zd\n", devfn, di->size);
2154 + if (bdrv_img_create(devfn, "raw", NULL, NULL, NULL,
2155 + di->size, flags)) {
2156 + g_error("can't create file %s", devfn);
2159 + /* Note: we created an empty file above, so there is no
2160 + * need to write zeroes (so we generate a sparse file)
2162 + write_zero = false;
2165 + BlockDriverState *bs = bdrv_new(di->devname);
2166 + if (bdrv_open(bs, devfn, flags, NULL)) {
2167 + g_error("can't open file %s", devfn);
2169 + if (vma_reader_register_bs(vmar, i, bs, write_zero, &errp) < 0) {
2170 + g_error("%s", error_get_pretty(errp));
2179 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2180 + g_error("restore failed - %s", error_get_pretty(errp));
2184 + for (i = 1; i < 255; i++) {
2185 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2186 + if (di && (i != vmstate_stream)) {
2187 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2188 + dirname, di->devname);
2189 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2190 + dirname, di->devname);
2191 + if (rename(tmpfn, fn) != 0) {
2192 + g_error("rename %s to %s failed - %s",
2193 + tmpfn, fn, strerror(errno));
2199 + vma_reader_destroy(vmar);
2206 +typedef struct BackupCB {
2211 +static int backup_dump_cb(void *opaque, BlockDriverState *bs,
2212 + int64_t cluster_num, unsigned char *buf)
2214 + BackupCB *bcb = opaque;
2216 + if (vma_writer_write(bcb->vmaw, bcb->dev_id, cluster_num, buf, &zb) < 0) {
2217 + g_warning("backup_dump_cb vma_writer_write failed");
2224 +static void backup_complete_cb(void *opaque, int ret)
2226 + BackupCB *bcb = opaque;
2229 + vma_writer_set_error(bcb->vmaw, "backup_complete_cb %d", ret);
2232 + if (vma_writer_close_stream(bcb->vmaw, bcb->dev_id) <= 0) {
2233 + Error *err = NULL;
2234 + if (vma_writer_close(bcb->vmaw, &err) != 0) {
2235 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2240 +static int create_archive(int argc, char **argv)
2244 + const char *archivename;
2245 + GList *config_files = NULL;
2248 + c = getopt(argc, argv, "hvc:");
2258 + config_files = g_list_append(config_files, optarg);
2264 + g_assert_not_reached();
2269 + /* make sure we have archive name and at least one path */
2270 + if ((optind + 2) > argc) {
2274 + archivename = argv[optind++];
2277 + uuid_generate(uuid);
2279 + Error *local_err = NULL;
2280 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, 0, &local_err);
2282 + if (vmaw == NULL) {
2283 + g_error("%s", error_get_pretty(local_err));
2286 + GList *l = config_files;
2287 + while (l && l->data) {
2288 + char *name = l->data;
2289 + char *cdata = NULL;
2291 + GError *err = NULL;
2292 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2293 + unlink(archivename);
2294 + g_error("Unable to read file: %s", err->message);
2297 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2298 + unlink(archivename);
2299 + g_error("Unable to append config data %s (len = %zd)",
2302 + l = g_list_next(l);
2306 + while (optind < argc) {
2307 + const char *path = argv[optind++];
2308 + char *devname = NULL;
2309 + path = extract_devname(path, &devname, ind++);
2311 + BlockDriver *drv = NULL;
2312 + BlockDriverState *bs = bdrv_new(devname);
2314 + res = bdrv_open(bs, path, BDRV_O_CACHE_WB , drv);
2316 + unlink(archivename);
2317 + g_error("bdrv_open '%s' failed", path);
2319 + int64_t size = bdrv_getlength(bs);
2320 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2321 + if (dev_id <= 0) {
2322 + unlink(archivename);
2323 + g_error("vma_writer_register_stream '%s' failed", devname);
2326 + BackupCB *bcb = g_new0(BackupCB, 1);
2328 + bcb->dev_id = dev_id;
2330 + if (backup_job_create(bs, backup_dump_cb, backup_complete_cb,
2332 + unlink(archivename);
2333 + g_error("backup_job_start failed");
2335 + backup_job_start(bs);
2339 + VmaStatus vmastat;
2341 + int last_percent = -1;
2344 + main_loop_wait(false);
2345 + vma_writer_get_status(vmaw, &vmastat);
2349 + uint64_t total = 0;
2350 + uint64_t transferred = 0;
2351 + uint64_t zero_bytes = 0;
2354 + for (i = 0; i < 256; i++) {
2355 + if (vmastat.stream_info[i].size) {
2356 + total += vmastat.stream_info[i].size;
2357 + transferred += vmastat.stream_info[i].transferred;
2358 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2361 + percent = (transferred*100)/total;
2362 + if (percent != last_percent) {
2363 + printf("progress %d%% %zd/%zd %zd\n", percent,
2364 + transferred, total, zero_bytes);
2366 + last_percent = percent;
2370 + if (vmastat.closed) {
2377 + vma_writer_get_status(vmaw, &vmastat);
2380 + for (i = 0; i < 256; i++) {
2381 + VmaStreamInfo *si = &vmastat.stream_info[i];
2383 + printf("image %s: size=%zd zeros=%zd saved=%zd\n", si->devname,
2384 + si->size, si->zero_bytes, si->size - si->zero_bytes);
2389 + if (vmastat.status < 0) {
2390 + unlink(archivename);
2391 + g_error("creating vma archive failed");
2397 +int main(int argc, char **argv)
2399 + const char *cmdname;
2401 + error_set_progname(argv[0]);
2403 + qemu_init_main_loop();
2411 + cmdname = argv[1];
2415 + if (!strcmp(cmdname, "list")) {
2416 + return list_content(argc, argv);
2417 + } else if (!strcmp(cmdname, "create")) {
2418 + return create_archive(argc, argv);
2419 + } else if (!strcmp(cmdname, "extract")) {
2420 + return extract_content(argc, argv);
2426 diff --git a/vma.h b/vma.h
2427 new file mode 100644
2428 index 0000000..689e639
2433 + * VMA: Virtual Machine Archive
2435 + * Copyright (C) Proxmox Server Solutions
2438 + * Dietmar Maurer (dietmar@proxmox.com)
2440 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2441 + * See the COPYING file in the top-level directory.
2445 +#ifndef BACKUP_VMA_H
2446 +#define BACKUP_VMA_H
2448 +#include "backup.h"
2451 +#define VMA_BLOCK_BITS 12
2452 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2453 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2454 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2456 +#if VMA_CLUSTER_SIZE != 65536
2457 +#error unexpected cluster size
2460 +#define VMA_EXTENT_HEADER_SIZE 512
2461 +#define VMA_BLOCKS_PER_EXTENT 59
2462 +#define VMA_MAX_CONFIGS 256
2464 +#define VMA_MAX_EXTENT_SIZE \
2465 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2466 +#if VMA_MAX_EXTENT_SIZE != 3867136
2467 +#error unexpected VMA_EXTENT_SIZE
2470 +/* File Format Definitions */
2472 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2473 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2475 +typedef struct VmaDeviceInfoHeader {
2476 + uint32_t devname_ptr; /* offset into blob_buffer table */
2477 + uint32_t reserved0;
2478 + uint64_t size; /* device size in bytes */
2479 + uint64_t reserved1;
2480 + uint64_t reserved2;
2481 +} VmaDeviceInfoHeader;
2483 +typedef struct VmaHeader {
2486 + unsigned char uuid[16];
2488 + unsigned char md5sum[16];
2490 + uint32_t blob_buffer_offset;
2491 + uint32_t blob_buffer_size;
2492 + uint32_t header_size;
2494 + unsigned char reserved[1984];
2496 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2497 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2499 + VmaDeviceInfoHeader dev_info[256];
2502 +typedef struct VmaExtentHeader {
2504 + uint16_t reserved1;
2505 + uint16_t block_count;
2506 + unsigned char uuid[16];
2507 + unsigned char md5sum[16];
2508 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2511 +/* functions/definitions to read/write vma files */
2513 +typedef struct VmaReader VmaReader;
2515 +typedef struct VmaWriter VmaWriter;
2517 +typedef struct VmaConfigData {
2523 +typedef struct VmaStreamInfo {
2525 + uint64_t cluster_count;
2526 + uint64_t transferred;
2527 + uint64_t zero_bytes;
2532 +typedef struct VmaStatus {
2535 + char errmsg[8192];
2536 + char uuid_str[37];
2537 + VmaStreamInfo stream_info[256];
2540 +typedef struct VmaDeviceInfo {
2541 + uint64_t size; /* device size in bytes */
2542 + const char *devname;
2545 +extern const BackupDriver backup_vma_driver;
2547 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, int64_t speed,
2549 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2550 +void vma_writer_destroy(VmaWriter *vmaw);
2551 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2553 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2556 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2557 + int64_t cluster_num, unsigned char *buf,
2558 + size_t *zero_bytes);
2560 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2562 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2563 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2566 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2567 +void vma_reader_destroy(VmaReader *vmar);
2568 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2569 +GList *vma_reader_get_config_data(VmaReader *vmar);
2570 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2571 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2572 + BlockDriverState *bs, bool write_zeroes,
2574 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2577 +#endif /* BACKUP_VMA_H */