1 From 7592ded4c7222255085ac7cad534a9e592931f30 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/6] 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 | 935 +++++++++++++++++++++++++++++++++++++++++++++++
16 vma.c | 561 ++++++++++++++++++++++++++++
18 8 files changed, 2473 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 30f63bd..5ffd246 100644
65 #include "arch_init.h"
69 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
71 @@ -1515,10 +1516,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..6ecbaf4
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"
958 +#include "monitor.h"
962 +#define DPRINTF(fmt, ...)\
963 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
965 +#define WRITE_BUFFERS 5
967 +typedef struct VmaAIOCB VmaAIOCB;
969 + unsigned char buffer[VMA_MAX_EXTENT_SIZE];
981 + bool header_written;
984 + /* we always write extents */
985 + unsigned char outbuf[VMA_MAX_EXTENT_SIZE];
986 + int outbuf_pos; /* in bytes */
987 + int outbuf_count; /* in VMA_BLOCKS */
988 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
990 + VmaAIOCB *aiocbs[WRITE_BUFFERS];
993 + GChecksum *md5csum;
994 + CoMutex writer_lock;
995 + CoMutex flush_lock;
996 + Coroutine *co_writer;
998 + /* drive informations */
999 + VmaStreamInfo stream_info[256];
1000 + guint stream_count;
1002 + guint8 vmstate_stream;
1003 + uint32_t vmstate_clusters;
1005 + /* header blob table */
1006 + char *header_blob_table;
1007 + uint32_t header_blob_table_size;
1008 + uint32_t header_blob_table_pos;
1010 + /* store for config blobs */
1011 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1012 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1013 + uint32_t config_count;
1016 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1020 + if (vmaw->status < 0) {
1024 + vmaw->status = -1;
1026 + va_start(ap, fmt);
1027 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1030 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1033 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1036 + if (len > 65535) {
1040 + if (!vmaw->header_blob_table ||
1041 + (vmaw->header_blob_table_size <
1042 + (vmaw->header_blob_table_pos + len + 2))) {
1043 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1045 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1046 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1047 + 0, newsize - vmaw->header_blob_table_size);
1048 + vmaw->header_blob_table_size = newsize;
1051 + uint32_t cpos = vmaw->header_blob_table_pos;
1052 + vmaw->header_blob_table[cpos] = len & 255;
1053 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1054 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1055 + vmaw->header_blob_table_pos += len + 2;
1059 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1063 + size_t len = strlen(str) + 1;
1065 + return allocate_header_blob(vmaw, str, len);
1068 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1072 + assert(!vmaw->header_written);
1073 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1078 + uint32_t name_ptr = allocate_header_string(vmaw, name);
1083 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1088 + vmaw->config_names[vmaw->config_count] = name_ptr;
1089 + vmaw->config_data[vmaw->config_count] = data_ptr;
1091 + vmaw->config_count++;
1096 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1101 + assert(!vmaw->status);
1103 + if (vmaw->header_written) {
1104 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1105 + "already written");
1109 + guint n = vmaw->stream_count + 1;
1111 + /* we can have dev_ids form 1 to 255 (0 reserved)
1112 + * 255(-1) reseverd for safety
1115 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1116 + "too many drives");
1121 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1122 + "got strange size %zd", size);
1126 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1128 + vmaw->stream_info[n].devname = g_strdup(devname);
1129 + vmaw->stream_info[n].size = size;
1131 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1134 + vmaw->stream_count = n;
1136 + if (strcmp(devname, "vmstate") == 0) {
1137 + vmaw->vmstate_stream = n;
1143 +static void vma_co_continue_write(void *opaque)
1145 + VmaWriter *vmaw = opaque;
1147 + DPRINTF("vma_co_continue_write\n");
1148 + qemu_coroutine_enter(vmaw->co_writer, NULL);
1151 +static int vma_co_write_finished(void *opaque)
1153 + VmaWriter *vmaw = opaque;
1155 + return (vmaw->co_writer != 0);
1158 +static ssize_t coroutine_fn
1159 +vma_co_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1164 + /* atomic writes (we cannot interleave writes) */
1165 + qemu_co_mutex_lock(&vmaw->writer_lock);
1167 + DPRINTF("vma_co_write enter %zd\n", bytes);
1169 + assert(vmaw->co_writer == NULL);
1171 + vmaw->co_writer = qemu_coroutine_self();
1173 + qemu_aio_set_fd_handler(vmaw->fd, NULL, vma_co_continue_write,
1174 + vma_co_write_finished, vmaw);
1176 + DPRINTF("vma_co_write wait until writable\n");
1177 + qemu_coroutine_yield();
1178 + DPRINTF("vma_co_write starting %zd\n", bytes);
1180 + while (done < bytes) {
1181 + ret = write(vmaw->fd, buf + done, bytes - done);
1184 + DPRINTF("vma_co_write written %zd %zd\n", done, ret);
1185 + } else if (ret < 0) {
1186 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1187 + DPRINTF("vma_co_write yield %zd\n", done);
1188 + qemu_coroutine_yield();
1189 + DPRINTF("vma_co_write restart %zd\n", done);
1191 + vma_writer_set_error(vmaw, "vma_co_write write error - %s",
1193 + done = -1; /* always return failure for partial writes */
1196 + } else if (ret == 0) {
1197 + /* should not happen - simply try again */
1201 + qemu_aio_set_fd_handler(vmaw->fd, NULL, NULL, NULL, NULL);
1203 + vmaw->co_writer = NULL;
1205 + qemu_co_mutex_unlock(&vmaw->writer_lock);
1207 + DPRINTF("vma_co_write leave %zd\n", done);
1211 +static void coroutine_fn vma_co_writer_task(void *opaque)
1213 + VmaAIOCB *cb = opaque;
1215 + DPRINTF("vma_co_writer_task start\n");
1217 + int64_t done = vma_co_write(cb->vmaw, cb->buffer, cb->bytes);
1218 + DPRINTF("vma_co_writer_task write done %zd\n", done);
1220 + if (done != cb->bytes) {
1221 + DPRINTF("vma_co_writer_task failed write %zd %zd", cb->bytes, done);
1222 + vma_writer_set_error(cb->vmaw, "vma_co_writer_task failed write %zd",
1228 + qemu_co_queue_next(&cb->vmaw->wqueue);
1230 + DPRINTF("vma_co_writer_task end\n");
1233 +static void coroutine_fn vma_queue_flush(VmaWriter *vmaw)
1235 + DPRINTF("vma_queue_flush enter\n");
1241 + VmaAIOCB *cb = NULL;
1242 + for (i = 0; i < WRITE_BUFFERS; i++) {
1243 + if (vmaw->aiocbs[i]->bytes) {
1244 + cb = vmaw->aiocbs[i];
1245 + DPRINTF("FOUND USED AIO BUFFER %d %zd\n", i,
1246 + vmaw->aiocbs[i]->bytes);
1253 + qemu_co_queue_wait(&vmaw->wqueue);
1256 + DPRINTF("vma_queue_flush leave\n");
1260 + * NOTE: pipe buffer size in only 4096 bytes on linux (see 'ulimit -a')
1261 + * So we need to create a coroutione to allow 'parallel' execution.
1263 +static ssize_t coroutine_fn
1264 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1266 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1270 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1272 + VmaAIOCB *cb = NULL;
1275 + for (i = 0; i < WRITE_BUFFERS; i++) {
1276 + if (!vmaw->aiocbs[i]->bytes) {
1277 + cb = vmaw->aiocbs[i];
1282 + qemu_co_queue_wait(&vmaw->wqueue);
1286 + memcpy(cb->buffer, buf, bytes);
1287 + cb->bytes = bytes;
1290 + DPRINTF("vma_queue_write start %zd\n", bytes);
1291 + cb->co = qemu_coroutine_create(vma_co_writer_task);
1292 + qemu_coroutine_enter(cb->co, cb);
1294 + DPRINTF("vma_queue_write leave\n");
1299 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp)
1303 + assert(sizeof(VmaHeader) == (4096 + 8192));
1304 + assert(sizeof(VmaExtentHeader) == 512);
1306 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1309 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1310 + if (!vmaw->md5csum) {
1311 + error_setg(errp, "can't allocate cmsum\n");
1315 + if (strstart(filename, "exec:", &p)) {
1316 + vmaw->cmd = popen(p, "w");
1317 + if (vmaw->cmd == NULL) {
1318 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1322 + vmaw->fd = fileno(vmaw->cmd);
1324 + /* try to use O_NONBLOCK and O_DIRECT */
1325 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1326 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_DIRECT);
1331 + const char *tmp_id_str;
1333 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1334 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY;
1335 + vmaw->fd = qemu_open(filename, oflags, 0644);
1336 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1337 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY;
1338 + vmaw->fd = qemu_open(filename, oflags, 0644);
1339 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1340 + vmaw->fd = monitor_get_fd(cur_mon, tmp_id_str, errp);
1341 + if (vmaw->fd < 0) {
1344 + /* try to use O_NONBLOCK and O_DIRECT */
1345 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1346 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_DIRECT);
1348 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY|O_CREAT|O_EXCL;
1349 + vmaw->fd = qemu_open(filename, oflags, 0644);
1352 + if (vmaw->fd < 0) {
1353 + error_setg(errp, "can't open file %s - %s\n", filename,
1359 + /* we use O_DIRECT, so we need to align IO buffers */
1361 + for (i = 0; i < WRITE_BUFFERS; i++) {
1362 + vmaw->aiocbs[i] = qemu_memalign(512, sizeof(VmaAIOCB));
1363 + memset(vmaw->aiocbs[i], 0, sizeof(VmaAIOCB));
1366 + vmaw->outbuf_count = 0;
1367 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1369 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1371 + qemu_co_mutex_init(&vmaw->writer_lock);
1372 + qemu_co_mutex_init(&vmaw->flush_lock);
1373 + qemu_co_queue_init(&vmaw->wqueue);
1375 + uuid_copy(vmaw->uuid, uuid);
1382 + pclose(vmaw->cmd);
1383 + } else if (vmaw->fd >= 0) {
1387 + if (vmaw->md5csum) {
1388 + g_checksum_free(vmaw->md5csum);
1397 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1400 + int header_clusters = 8;
1401 + char buf[65536*header_clusters];
1402 + VmaHeader *head = (VmaHeader *)buf;
1406 + DPRINTF("VMA WRITE HEADER\n");
1408 + if (vmaw->status < 0) {
1409 + return vmaw->status;
1412 + memset(buf, 0, sizeof(buf));
1414 + head->magic = VMA_MAGIC;
1415 + head->version = GUINT32_TO_BE(1); /* v1 */
1416 + memcpy(head->uuid, vmaw->uuid, 16);
1418 + time_t ctime = time(NULL);
1419 + head->ctime = GUINT64_TO_BE(ctime);
1421 + if (!vmaw->stream_count) {
1425 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1426 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1427 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1430 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1431 + for (i = 1; i <= 254; i++) {
1432 + VmaStreamInfo *si = &vmaw->stream_info[i];
1434 + assert(si->devname);
1435 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1436 + if (!devname_ptr) {
1439 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1440 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1444 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1445 + head->header_size = GUINT32_TO_BE(header_size);
1447 + if (header_size > sizeof(buf)) {
1448 + return -1; /* just to be sure */
1451 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1452 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1453 + vmaw->header_blob_table_size);
1454 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1455 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1457 + g_checksum_reset(vmaw->md5csum);
1458 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1460 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1462 + return vma_queue_write(vmaw, buf, header_size);
1465 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1472 + if (vmaw->status < 0) {
1473 + return vmaw->status;
1476 + if (!vmaw->header_written) {
1477 + vmaw->header_written = true;
1478 + ret = vma_write_header(vmaw);
1480 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1485 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1488 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1490 + ehead->magic = VMA_EXTENT_MAGIC;
1491 + ehead->reserved1 = 0;
1493 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1494 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1497 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1500 + ehead->block_count = GUINT16_TO_BE(block_count);
1502 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1503 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1505 + g_checksum_reset(vmaw->md5csum);
1506 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1508 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1510 + int bytes = vmaw->outbuf_pos;
1511 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1512 + if (ret != bytes) {
1513 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1516 + vmaw->outbuf_count = 0;
1517 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1519 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1520 + vmaw->outbuf_block_info[i] = 0;
1523 + return vmaw->status;
1526 +static int vma_count_open_streams(VmaWriter *vmaw)
1528 + g_assert(vmaw != NULL);
1531 + int open_drives = 0;
1532 + for (i = 0; i <= 255; i++) {
1533 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1538 + return open_drives;
1542 + * all jobs should call this when there is no more data
1543 + * Returns: number of remaining stream (0 ==> finished)
1546 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1548 + g_assert(vmaw != NULL);
1550 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1551 + if (!vmaw->stream_info[dev_id].size) {
1552 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1553 + "no such stream %d", dev_id);
1556 + if (vmaw->stream_info[dev_id].finished) {
1557 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1558 + "stream already closed %d", dev_id);
1562 + vmaw->stream_info[dev_id].finished = true;
1564 + int open_drives = vma_count_open_streams(vmaw);
1566 + if (open_drives <= 0) {
1567 + DPRINTF("vma_writer_set_status all drives completed\n");
1568 + qemu_co_mutex_lock(&vmaw->flush_lock);
1569 + int ret = vma_writer_flush(vmaw);
1570 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1572 + vma_writer_set_error(vmaw, "vma_writer_close_stream: flush failed");
1576 + return open_drives;
1579 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1583 + g_assert(vmaw != NULL);
1586 + status->status = vmaw->status;
1587 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1588 + for (i = 0; i <= 255; i++) {
1589 + status->stream_info[i] = vmaw->stream_info[i];
1592 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1595 + status->closed = vmaw->closed;
1597 + return vmaw->status;
1600 +static int vma_writer_get_buffer(VmaWriter *vmaw)
1604 + qemu_co_mutex_lock(&vmaw->flush_lock);
1606 + /* wait until buffer is available */
1607 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1608 + ret = vma_writer_flush(vmaw);
1610 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1615 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1621 +int64_t coroutine_fn
1622 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1623 + unsigned char *buf, size_t *zero_bytes)
1625 + g_assert(vmaw != NULL);
1626 + g_assert(zero_bytes != NULL);
1630 + if (vmaw->status < 0) {
1631 + return vmaw->status;
1634 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1635 + vma_writer_set_error(vmaw, "vma_writer_write: "
1636 + "no such stream %d", dev_id);
1640 + if (vmaw->stream_info[dev_id].finished) {
1641 + vma_writer_set_error(vmaw, "vma_writer_write: "
1642 + "stream already closed %d", dev_id);
1647 + if (cluster_num >= (((uint64_t)1)<<32)) {
1648 + vma_writer_set_error(vmaw, "vma_writer_write: "
1649 + "cluster number out of range");
1653 + if (dev_id == vmaw->vmstate_stream) {
1654 + if (cluster_num != vmaw->vmstate_clusters) {
1655 + vma_writer_set_error(vmaw, "vma_writer_write: "
1656 + "non sequential vmstate write");
1658 + vmaw->vmstate_clusters++;
1659 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1660 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1664 + /* wait until buffer is available */
1665 + if (vma_writer_get_buffer(vmaw) < 0) {
1666 + vma_writer_set_error(vmaw, "vma_writer_write: "
1667 + "vma_writer_get_buffer failed");
1671 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1675 + uint16_t mask = 0;
1676 + for (i = 0; i < 16; i++) {
1677 + unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1678 + if (!buffer_is_zero(vmablock, VMA_BLOCK_SIZE)) {
1680 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock, VMA_BLOCK_SIZE);
1681 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1683 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1684 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1685 + *zero_bytes += VMA_BLOCK_SIZE;
1691 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1692 + block_info |= ((uint64_t)dev_id) << 32;
1693 + block_info |= (cluster_num & 0xffffffff);
1694 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1696 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1698 + vmaw->outbuf_count++;
1700 + /** NOTE: We allways write whole clusters, but we correctly set
1701 + * transferred bytes. So transferred == size when when everything
1704 + size_t transferred = VMA_CLUSTER_SIZE;
1706 + if (dev_id != vmaw->vmstate_stream) {
1707 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1708 + if (last > vmaw->stream_info[dev_id].size) {
1709 + uint64_t diff = last - vmaw->stream_info[dev_id].size;
1710 + if (diff >= VMA_CLUSTER_SIZE) {
1711 + vma_writer_set_error(vmaw, "vma_writer_write: "
1712 + "read after last cluster");
1715 + transferred -= diff;
1719 + vmaw->stream_info[dev_id].transferred += transferred;
1721 + return transferred;
1724 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1726 + g_assert(vmaw != NULL);
1730 + vma_queue_flush(vmaw);
1732 + /* this should not happen - just to be sure */
1733 + while (!qemu_co_queue_empty(&vmaw->wqueue)) {
1734 + DPRINTF("vma_writer_close wait\n");
1735 + co_sleep_ns(rt_clock, 1000000);
1739 + if (pclose(vmaw->cmd) < 0) {
1740 + vma_writer_set_error(vmaw, "vma_writer_close: "
1741 + "pclose failed - %s", strerror(errno));
1744 + if (close(vmaw->fd) < 0) {
1745 + vma_writer_set_error(vmaw, "vma_writer_close: "
1746 + "close failed - %s", strerror(errno));
1750 + for (i = 0; i <= 255; i++) {
1751 + VmaStreamInfo *si = &vmaw->stream_info[i];
1753 + if (!si->finished) {
1754 + vma_writer_set_error(vmaw, "vma_writer_close: "
1755 + "detected open stream '%s'", si->devname);
1756 + } else if ((si->transferred != si->size) &&
1757 + (i != vmaw->vmstate_stream)) {
1758 + vma_writer_set_error(vmaw, "vma_writer_close: "
1759 + "incomplete stream '%s' (%zd != %zd)",
1760 + si->devname, si->transferred, si->size);
1765 + for (i = 0; i <= 255; i++) {
1766 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1771 + if (vmaw->status < 0 && *errp == NULL) {
1772 + error_setg(errp, "%s", vmaw->errmsg);
1775 + return vmaw->status;
1778 +void vma_writer_destroy(VmaWriter *vmaw)
1784 + for (i = 0; i <= 255; i++) {
1785 + if (vmaw->stream_info[i].devname) {
1786 + g_free(vmaw->stream_info[i].devname);
1790 + if (vmaw->md5csum) {
1791 + g_checksum_free(vmaw->md5csum);
1794 + for (i = 0; i < WRITE_BUFFERS; i++) {
1795 + free(vmaw->aiocbs[i]);
1801 +/* backup driver plugin */
1803 +static int vma_dump_cb(void *opaque, uint8_t dev_id, int64_t cluster_num,
1804 + unsigned char *buf, size_t *zero_bytes)
1806 + VmaWriter *vmaw = opaque;
1808 + return vma_writer_write(vmaw, dev_id, cluster_num, buf, zero_bytes);
1811 +static int vma_close_cb(void *opaque, Error **errp)
1813 + VmaWriter *vmaw = opaque;
1815 + int res = vma_writer_close(vmaw, errp);
1816 + vma_writer_destroy(vmaw);
1821 +static int vma_complete_cb(void *opaque, uint8_t dev_id, int ret)
1823 + VmaWriter *vmaw = opaque;
1826 + vma_writer_set_error(vmaw, "backup_complete_cb %d", ret);
1829 + return vma_writer_close_stream(vmaw, dev_id);
1832 +static int vma_register_stream_cb(void *opaque, const char *devname,
1835 + VmaWriter *vmaw = opaque;
1837 + return vma_writer_register_stream(vmaw, devname, size);
1840 +static int vma_register_config_cb(void *opaque, const char *name,
1841 + gpointer data, size_t data_len)
1843 + VmaWriter *vmaw = opaque;
1845 + return vma_writer_add_config(vmaw, name, data, data_len);
1848 +static void *vma_open_cb(const char *filename, uuid_t uuid, Error **errp)
1850 + return vma_writer_create(filename, uuid, errp);
1853 +const BackupDriver backup_vma_driver = {
1855 + .open_cb = vma_open_cb,
1856 + .close_cb = vma_close_cb,
1857 + .register_config_cb = vma_register_config_cb,
1858 + .register_stream_cb = vma_register_stream_cb,
1859 + .dump_cb = vma_dump_cb,
1860 + .complete_cb = vma_complete_cb,
1863 diff --git a/vma.c b/vma.c
1864 new file mode 100644
1865 index 0000000..5d13906
1870 + * VMA: Virtual Machine Archive
1872 + * Copyright (C) 2012 Proxmox Server Solutions
1875 + * Dietmar Maurer (dietmar@proxmox.com)
1877 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1878 + * See the COPYING file in the top-level directory.
1884 +#include <unistd.h>
1886 +#include <string.h>
1887 +#include <sys/types.h>
1888 +#include <sys/stat.h>
1892 +#include "qemu-common.h"
1893 +#include "qemu-option.h"
1894 +#include "qemu-error.h"
1896 +#include "sysemu.h"
1897 +#include "block_int.h"
1901 +static void help(void)
1903 + const char *help_msg =
1904 + "usage: vma command [command options]\n"
1906 + "vma list <filename>\n"
1907 + "vma create <filename> [-c config] <archive> pathname ...\n"
1908 + "vma extract <filename> [-r] <targetdir>\n"
1911 + printf("%s", help_msg);
1915 +static const char *extract_devname(const char *path, char **devname, int index)
1919 + const char *sep = strchr(path, '=');
1922 + *devname = g_strndup(path, sep - path);
1926 + *devname = g_strdup_printf("disk%d", index);
1935 +static void print_content(VmaReader *vmar)
1939 + VmaHeader *head = vma_reader_get_header(vmar);
1941 + GList *l = vma_reader_get_config_data(vmar);
1942 + while (l && l->data) {
1943 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1944 + l = g_list_next(l);
1945 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1949 + VmaDeviceInfo *di;
1950 + for (i = 1; i < 255; i++) {
1951 + di = vma_reader_get_device_info(vmar, i);
1953 + if (strcmp(di->devname, "vmstate") == 0) {
1954 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1956 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1957 + i, di->size, di->devname);
1961 + /* ctime is the last entry we print */
1962 + printf("CTIME: %s", ctime(&head->ctime));
1966 +static int list_content(int argc, char **argv)
1969 + const char *filename;
1972 + c = getopt(argc, argv, "h");
1982 + g_assert_not_reached();
1986 + /* Get the filename */
1987 + if ((optind + 1) != argc) {
1990 + filename = argv[optind++];
1992 + Error *errp = NULL;
1993 + VmaReader *vmar = vma_reader_create(filename, &errp);
1996 + g_error("%s", error_get_pretty(errp));
1999 + print_content(vmar);
2001 + vma_reader_destroy(vmar);
2006 +typedef struct RestoreMap {
2012 +static int extract_content(int argc, char **argv)
2016 + const char *filename;
2017 + const char *dirname;
2018 + const char *readmap = NULL;
2021 + c = getopt(argc, argv, "hvr:");
2041 + /* Get the filename */
2042 + if ((optind + 2) != argc) {
2045 + filename = argv[optind++];
2046 + dirname = argv[optind++];
2048 + Error *errp = NULL;
2049 + VmaReader *vmar = vma_reader_create(filename, &errp);
2052 + g_error("%s", error_get_pretty(errp));
2055 + if (mkdir(dirname, 0777) < 0) {
2056 + g_error("unable to create target directory %s - %s",
2057 + dirname, strerror(errno));
2060 + GList *l = vma_reader_get_config_data(vmar);
2061 + while (l && l->data) {
2062 + VmaConfigData *cdata = (VmaConfigData *)l->data;
2063 + l = g_list_next(l);
2064 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
2065 + GError *err = NULL;
2066 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
2068 + g_error("unable to write file: %s", err->message);
2072 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
2075 + print_content(vmar);
2077 + FILE *map = fopen(readmap, "r");
2079 + g_error("unable to open fifo %s - %s", readmap, strerror(errno));
2084 + char *line = fgets(inbuf, sizeof(inbuf), map);
2085 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
2088 + int len = strlen(line);
2089 + if (line[len - 1] == '\n') {
2090 + line[len - 1] = '\0';
2098 + if (line[0] == '0' && line[1] == ':') {
2100 + write_zero = false;
2101 + } else if (line[0] == '1' && line[1] == ':') {
2103 + write_zero = true;
2105 + g_error("read map failed - parse error ('%s')", inbuf);
2108 + char *devname = NULL;
2109 + path = extract_devname(path, &devname, -1);
2111 + g_error("read map failed - no dev name specified ('%s')",
2115 + RestoreMap *map = g_new0(RestoreMap, 1);
2116 + map->devname = g_strdup(devname);
2117 + map->path = g_strdup(path);
2118 + map->write_zero = write_zero;
2120 + g_hash_table_insert(devmap, map->devname, map);
2126 + int vmstate_fd = -1;
2127 + guint8 vmstate_stream = 0;
2129 + for (i = 1; i < 255; i++) {
2130 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2131 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2132 + vmstate_stream = i;
2133 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2134 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2135 + if (vmstate_fd < 0) {
2136 + g_error("create vmstate file '%s' failed - %s", statefn,
2141 + char *devfn = NULL;
2142 + int flags = BDRV_O_RDWR|BDRV_O_CACHE_WB;
2143 + bool write_zero = true;
2147 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2148 + if (map == NULL) {
2149 + g_error("no device name mapping for %s", di->devname);
2151 + devfn = map->path;
2152 + write_zero = map->write_zero;
2154 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2155 + dirname, di->devname);
2156 + printf("DEVINFO %s %zd\n", devfn, di->size);
2158 + if (bdrv_img_create(devfn, "raw", NULL, NULL, NULL,
2159 + di->size, flags)) {
2160 + g_error("can't create file %s", devfn);
2163 + /* Note: we created an empty file above, so there is no
2164 + * need to write zeroes (so we generate a sparse file)
2166 + write_zero = false;
2169 + BlockDriverState *bs = bdrv_new(di->devname);
2170 + if (bdrv_open(bs, devfn, flags, NULL)) {
2171 + g_error("can't open file %s", devfn);
2173 + if (vma_reader_register_bs(vmar, i, bs, write_zero, &errp) < 0) {
2174 + g_error("%s", error_get_pretty(errp));
2183 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2184 + g_error("restore failed - %s", error_get_pretty(errp));
2188 + for (i = 1; i < 255; i++) {
2189 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2190 + if (di && (i != vmstate_stream)) {
2191 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2192 + dirname, di->devname);
2193 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2194 + dirname, di->devname);
2195 + if (rename(tmpfn, fn) != 0) {
2196 + g_error("rename %s to %s failed - %s",
2197 + tmpfn, fn, strerror(errno));
2203 + vma_reader_destroy(vmar);
2210 +typedef struct BackupCB {
2215 +static int backup_dump_cb(void *opaque, BlockDriverState *bs,
2216 + int64_t cluster_num, unsigned char *buf)
2218 + BackupCB *bcb = opaque;
2220 + if (vma_writer_write(bcb->vmaw, bcb->dev_id, cluster_num, buf, &zb) < 0) {
2221 + g_warning("backup_dump_cb vma_writer_write failed");
2228 +static void backup_complete_cb(void *opaque, int ret)
2230 + BackupCB *bcb = opaque;
2233 + vma_writer_set_error(bcb->vmaw, "backup_complete_cb %d", ret);
2236 + if (vma_writer_close_stream(bcb->vmaw, bcb->dev_id) <= 0) {
2237 + Error *err = NULL;
2238 + if (vma_writer_close(bcb->vmaw, &err) != 0) {
2239 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2244 +static int create_archive(int argc, char **argv)
2248 + const char *archivename;
2249 + GList *config_files = NULL;
2252 + c = getopt(argc, argv, "hvc:");
2262 + config_files = g_list_append(config_files, optarg);
2268 + g_assert_not_reached();
2273 + /* make sure we have archive name and at least one path */
2274 + if ((optind + 2) > argc) {
2278 + archivename = argv[optind++];
2281 + uuid_generate(uuid);
2283 + Error *local_err = NULL;
2284 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, &local_err);
2286 + if (vmaw == NULL) {
2287 + g_error("%s", error_get_pretty(local_err));
2290 + GList *l = config_files;
2291 + while (l && l->data) {
2292 + char *name = l->data;
2293 + char *cdata = NULL;
2295 + GError *err = NULL;
2296 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2297 + unlink(archivename);
2298 + g_error("Unable to read file: %s", err->message);
2301 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2302 + unlink(archivename);
2303 + g_error("Unable to append config data %s (len = %zd)",
2306 + l = g_list_next(l);
2310 + while (optind < argc) {
2311 + const char *path = argv[optind++];
2312 + char *devname = NULL;
2313 + path = extract_devname(path, &devname, ind++);
2315 + BlockDriver *drv = NULL;
2316 + BlockDriverState *bs = bdrv_new(devname);
2318 + res = bdrv_open(bs, path, BDRV_O_CACHE_WB , drv);
2320 + unlink(archivename);
2321 + g_error("bdrv_open '%s' failed", path);
2323 + int64_t size = bdrv_getlength(bs);
2324 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2325 + if (dev_id <= 0) {
2326 + unlink(archivename);
2327 + g_error("vma_writer_register_stream '%s' failed", devname);
2330 + BackupCB *bcb = g_new0(BackupCB, 1);
2332 + bcb->dev_id = dev_id;
2334 + if (backup_job_create(bs, backup_dump_cb, backup_complete_cb,
2336 + unlink(archivename);
2337 + g_error("backup_job_start failed");
2339 + backup_job_start(bs);
2343 + VmaStatus vmastat;
2345 + int last_percent = -1;
2348 + main_loop_wait(false);
2349 + vma_writer_get_status(vmaw, &vmastat);
2353 + uint64_t total = 0;
2354 + uint64_t transferred = 0;
2355 + uint64_t zero_bytes = 0;
2358 + for (i = 0; i < 256; i++) {
2359 + if (vmastat.stream_info[i].size) {
2360 + total += vmastat.stream_info[i].size;
2361 + transferred += vmastat.stream_info[i].transferred;
2362 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2365 + percent = (transferred*100)/total;
2366 + if (percent != last_percent) {
2367 + printf("progress %d%% %zd/%zd %zd\n", percent,
2368 + transferred, total, zero_bytes);
2370 + last_percent = percent;
2374 + if (vmastat.closed) {
2381 + vma_writer_get_status(vmaw, &vmastat);
2384 + for (i = 0; i < 256; i++) {
2385 + VmaStreamInfo *si = &vmastat.stream_info[i];
2387 + printf("image %s: size=%zd zeros=%zd saved=%zd\n", si->devname,
2388 + si->size, si->zero_bytes, si->size - si->zero_bytes);
2393 + if (vmastat.status < 0) {
2394 + unlink(archivename);
2395 + g_error("creating vma archive failed");
2401 +int main(int argc, char **argv)
2403 + const char *cmdname;
2405 + error_set_progname(argv[0]);
2407 + qemu_init_main_loop();
2415 + cmdname = argv[1];
2419 + if (!strcmp(cmdname, "list")) {
2420 + return list_content(argc, argv);
2421 + } else if (!strcmp(cmdname, "create")) {
2422 + return create_archive(argc, argv);
2423 + } else if (!strcmp(cmdname, "extract")) {
2424 + return extract_content(argc, argv);
2430 diff --git a/vma.h b/vma.h
2431 new file mode 100644
2432 index 0000000..76d0dc8
2437 + * VMA: Virtual Machine Archive
2439 + * Copyright (C) Proxmox Server Solutions
2442 + * Dietmar Maurer (dietmar@proxmox.com)
2444 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2445 + * See the COPYING file in the top-level directory.
2449 +#ifndef BACKUP_VMA_H
2450 +#define BACKUP_VMA_H
2452 +#include "backup.h"
2455 +#define VMA_BLOCK_BITS 12
2456 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2457 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2458 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2460 +#if VMA_CLUSTER_SIZE != 65536
2461 +#error unexpected cluster size
2464 +#define VMA_EXTENT_HEADER_SIZE 512
2465 +#define VMA_BLOCKS_PER_EXTENT 59
2466 +#define VMA_MAX_CONFIGS 256
2468 +#define VMA_MAX_EXTENT_SIZE \
2469 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2470 +#if VMA_MAX_EXTENT_SIZE != 3867136
2471 +#error unexpected VMA_EXTENT_SIZE
2474 +/* File Format Definitions */
2476 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2477 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2479 +typedef struct VmaDeviceInfoHeader {
2480 + uint32_t devname_ptr; /* offset into blob_buffer table */
2481 + uint32_t reserved0;
2482 + uint64_t size; /* device size in bytes */
2483 + uint64_t reserved1;
2484 + uint64_t reserved2;
2485 +} VmaDeviceInfoHeader;
2487 +typedef struct VmaHeader {
2490 + unsigned char uuid[16];
2492 + unsigned char md5sum[16];
2494 + uint32_t blob_buffer_offset;
2495 + uint32_t blob_buffer_size;
2496 + uint32_t header_size;
2498 + unsigned char reserved[1984];
2500 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2501 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2503 + VmaDeviceInfoHeader dev_info[256];
2506 +typedef struct VmaExtentHeader {
2508 + uint16_t reserved1;
2509 + uint16_t block_count;
2510 + unsigned char uuid[16];
2511 + unsigned char md5sum[16];
2512 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2515 +/* functions/definitions to read/write vma files */
2517 +typedef struct VmaReader VmaReader;
2519 +typedef struct VmaWriter VmaWriter;
2521 +typedef struct VmaConfigData {
2527 +typedef struct VmaStreamInfo {
2529 + uint64_t cluster_count;
2530 + uint64_t transferred;
2531 + uint64_t zero_bytes;
2536 +typedef struct VmaStatus {
2539 + char errmsg[8192];
2540 + char uuid_str[37];
2541 + VmaStreamInfo stream_info[256];
2544 +typedef struct VmaDeviceInfo {
2545 + uint64_t size; /* device size in bytes */
2546 + const char *devname;
2549 +extern const BackupDriver backup_vma_driver;
2551 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp);
2552 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2553 +void vma_writer_destroy(VmaWriter *vmaw);
2554 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2556 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2559 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2560 + int64_t cluster_num, unsigned char *buf,
2561 + size_t *zero_bytes);
2563 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2565 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2566 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2569 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2570 +void vma_reader_destroy(VmaReader *vmar);
2571 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2572 +GList *vma_reader_get_config_data(VmaReader *vmar);
2573 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2574 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2575 + BlockDriverState *bs, bool write_zeroes,
2577 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2580 +#endif /* BACKUP_VMA_H */