1 From 6289a43696ca6f713a5d3bb9f95a5adb608a5e13 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 v5 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 | 799 ++++++++++++++++++++++++++++++++++++++++
15 vma-writer.c | 940 +++++++++++++++++++++++++++++++++++++++++++++++
16 vma.c | 561 ++++++++++++++++++++++++++++
18 8 files changed, 2476 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
26 ===================================================================
27 --- new.orig/Makefile 2013-11-27 10:51:32.000000000 +0100
28 +++ new/Makefile 2013-11-28 09:57:02.000000000 +0100
30 include $(SRC_PATH)/libcacard/Makefile
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
39 qemu-img$(EXESUF): qemu-img.o $(block-obj-y) libqemuutil.a libqemustub.a
40 qemu-nbd$(EXESUF): qemu-nbd.o $(block-obj-y) libqemuutil.a libqemustub.a
41 qemu-io$(EXESUF): qemu-io.o $(block-obj-y) libqemuutil.a libqemustub.a
42 +vma$(EXESUF): vma.o vma-writer.o vma-reader.o $(block-obj-y) libqemuutil.a libqemustub.a
44 qemu-bridge-helper$(EXESUF): qemu-bridge-helper.o
46 Index: new/docs/specs/vma_spec.txt
47 ===================================================================
48 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
49 +++ new/docs/specs/vma_spec.txt 2013-11-28 09:55:29.000000000 +0100
51 +=Virtual Machine Archive format (VMA)=
53 +This format contains a header which includes the VM configuration as
54 +binary blobs, and a list of devices (dev_id, name).
56 +The actual VM image data is stored inside extents. An extent contains
57 +up to 64 clusters, and start with a 512 byte header containing
58 +additional information for those clusters.
60 +We use a cluster size of 65536, and use 8 bytes for each
61 +cluster in the header to store the following information:
63 +* 1 byte dev_id (to identity the drive)
64 +* 1 byte not used (reserved)
65 +* 2 bytes zero indicator (mark zero regions (16x4096))
66 +* 4 bytes cluster number
68 +We only store non-zero blocks (such block is 4096 bytes).
70 +Each archive is marked with a uuid. The archive header and all
71 +extent headers includes that uuid and a MD5 checksum (over header
75 Index: new/vma-reader.c
76 ===================================================================
77 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
78 +++ new/vma-reader.c 2013-11-28 09:55:29.000000000 +0100
81 + * VMA: Virtual Machine Archive
83 + * Copyright (C) 2012 Proxmox Server Solutions
86 + * Dietmar Maurer (dietmar@proxmox.com)
88 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
89 + * See the COPYING file in the top-level directory.
98 +#include <sys/types.h>
99 +#include <sys/stat.h>
102 +#include <uuid/uuid.h>
104 +#include "qemu-common.h"
105 +#include "qemu/timer.h"
106 +#include "qemu/ratelimit.h"
108 +#include "block/block.h"
110 +#define BITS_PER_LONG (sizeof(unsigned long) * CHAR_BIT)
112 +static unsigned char zero_vma_block[VMA_BLOCK_SIZE];
114 +typedef struct VmaRestoreState {
115 + BlockDriverState *bs;
117 + unsigned long *bitmap;
123 + GChecksum *md5csum;
124 + GHashTable *blob_hash;
125 + unsigned char *head_data;
126 + VmaDeviceInfo devinfo[256];
127 + VmaRestoreState rstate[256];
129 + guint8 vmstate_stream;
130 + uint32_t vmstate_clusters;
131 + /* to show restore percentage if run with -v */
133 + int64_t cluster_count;
134 + int64_t clusters_read;
135 + int clusters_read_per;
139 +g_int32_hash(gconstpointer v)
141 + return *(const uint32_t *)v;
145 +g_int32_equal(gconstpointer v1, gconstpointer v2)
147 + return *((const uint32_t *)v1) == *((const uint32_t *)v2);
150 +static int vma_reader_get_bitmap(VmaRestoreState *rstate, int64_t cluster_num)
153 + assert(rstate->bitmap);
155 + unsigned long val, idx, bit;
157 + idx = cluster_num / BITS_PER_LONG;
159 + assert(rstate->bitmap_size > idx);
161 + bit = cluster_num % BITS_PER_LONG;
162 + val = rstate->bitmap[idx];
164 + return !!(val & (1UL << bit));
167 +static void vma_reader_set_bitmap(VmaRestoreState *rstate, int64_t cluster_num,
171 + assert(rstate->bitmap);
173 + unsigned long val, idx, bit;
175 + idx = cluster_num / BITS_PER_LONG;
177 + assert(rstate->bitmap_size > idx);
179 + bit = cluster_num % BITS_PER_LONG;
180 + val = rstate->bitmap[idx];
182 + if (!(val & (1UL << bit))) {
186 + if (val & (1UL << bit)) {
187 + val &= ~(1UL << bit);
190 + rstate->bitmap[idx] = val;
193 +typedef struct VmaBlob {
199 +static const VmaBlob *get_header_blob(VmaReader *vmar, uint32_t pos)
202 + assert(vmar->blob_hash);
204 + return g_hash_table_lookup(vmar->blob_hash, &pos);
207 +static const char *get_header_str(VmaReader *vmar, uint32_t pos)
209 + const VmaBlob *blob = get_header_blob(vmar, pos);
213 + const char *res = (char *)blob->data;
214 + if (res[blob->len-1] != '\0') {
221 +safe_read(int fd, unsigned char *buf, size_t count)
226 + n = read(fd, buf, count);
227 + } while (n < 0 && errno == EINTR);
233 +full_read(int fd, unsigned char *buf, size_t len)
241 + n = safe_read(fd, buf, len);
263 +void vma_reader_destroy(VmaReader *vmar)
267 + if (vmar->fd >= 0) {
271 + if (vmar->cdata_list) {
272 + g_list_free(vmar->cdata_list);
276 + for (i = 1; i < 256; i++) {
277 + if (vmar->rstate[i].bitmap) {
278 + g_free(vmar->rstate[i].bitmap);
282 + if (vmar->md5csum) {
283 + g_checksum_free(vmar->md5csum);
286 + if (vmar->blob_hash) {
287 + g_hash_table_destroy(vmar->blob_hash);
290 + if (vmar->head_data) {
291 + g_free(vmar->head_data);
298 +static int vma_reader_read_head(VmaReader *vmar, Error **errp)
302 + assert(*errp == NULL);
304 + unsigned char md5sum[16];
308 + vmar->head_data = g_malloc(sizeof(VmaHeader));
310 + if (full_read(vmar->fd, vmar->head_data, sizeof(VmaHeader)) !=
311 + sizeof(VmaHeader)) {
312 + error_setg(errp, "can't read vma header - %s",
313 + errno ? g_strerror(errno) : "got EOF");
317 + VmaHeader *h = (VmaHeader *)vmar->head_data;
319 + if (h->magic != VMA_MAGIC) {
320 + error_setg(errp, "not a vma file - wrong magic number");
324 + uint32_t header_size = GUINT32_FROM_BE(h->header_size);
325 + int need = header_size - sizeof(VmaHeader);
327 + error_setg(errp, "wrong vma header size %d", header_size);
331 + vmar->head_data = g_realloc(vmar->head_data, header_size);
332 + h = (VmaHeader *)vmar->head_data;
334 + if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
336 + error_setg(errp, "can't read vma header data - %s",
337 + errno ? g_strerror(errno) : "got EOF");
341 + memcpy(md5sum, h->md5sum, 16);
342 + memset(h->md5sum, 0, 16);
344 + g_checksum_reset(vmar->md5csum);
345 + g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
347 + g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
349 + if (memcmp(md5sum, h->md5sum, 16) != 0) {
350 + error_setg(errp, "wrong vma header chechsum");
354 + /* we can modify header data after checksum verify */
355 + h->header_size = header_size;
357 + h->version = GUINT32_FROM_BE(h->version);
358 + if (h->version != 1) {
359 + error_setg(errp, "wrong vma version %d", h->version);
363 + h->ctime = GUINT64_FROM_BE(h->ctime);
364 + h->blob_buffer_offset = GUINT32_FROM_BE(h->blob_buffer_offset);
365 + h->blob_buffer_size = GUINT32_FROM_BE(h->blob_buffer_size);
367 + uint32_t bstart = h->blob_buffer_offset + 1;
368 + uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
370 + if (bstart <= sizeof(VmaHeader)) {
371 + error_setg(errp, "wrong vma blob buffer offset %d",
372 + h->blob_buffer_offset);
376 + if (bend > header_size) {
377 + error_setg(errp, "wrong vma blob buffer size %d/%d",
378 + h->blob_buffer_offset, h->blob_buffer_size);
382 + while ((bstart + 2) <= bend) {
383 + uint32_t size = vmar->head_data[bstart] +
384 + (vmar->head_data[bstart+1] << 8);
385 + if ((bstart + size + 2) <= bend) {
386 + VmaBlob *blob = g_new0(VmaBlob, 1);
387 + blob->start = bstart - h->blob_buffer_offset;
389 + blob->data = vmar->head_data + bstart + 2;
390 + g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
392 + bstart += size + 2;
397 + for (i = 1; i < 256; i++) {
398 + VmaDeviceInfoHeader *dih = &h->dev_info[i];
399 + uint32_t devname_ptr = GUINT32_FROM_BE(dih->devname_ptr);
400 + uint64_t size = GUINT64_FROM_BE(dih->size);
401 + const char *devname = get_header_str(vmar, devname_ptr);
403 + if (size && devname) {
405 + vmar->devinfo[i].size = size;
406 + vmar->devinfo[i].devname = devname;
408 + if (strcmp(devname, "vmstate") == 0) {
409 + vmar->vmstate_stream = i;
415 + error_setg(errp, "vma does not contain data");
419 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
420 + uint32_t name_ptr = GUINT32_FROM_BE(h->config_names[i]);
421 + uint32_t data_ptr = GUINT32_FROM_BE(h->config_data[i]);
423 + if (!(name_ptr && data_ptr)) {
426 + const char *name = get_header_str(vmar, name_ptr);
427 + const VmaBlob *blob = get_header_blob(vmar, data_ptr);
429 + if (!(name && blob)) {
430 + error_setg(errp, "vma contains invalid data pointers");
434 + VmaConfigData *cdata = g_new0(VmaConfigData, 1);
435 + cdata->name = name;
436 + cdata->data = blob->data;
437 + cdata->len = blob->len;
439 + vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
445 +VmaReader *vma_reader_create(const char *filename, Error **errp)
450 + VmaReader *vmar = g_new0(VmaReader, 1);
452 + if (strcmp(filename, "-") == 0) {
455 + vmar->fd = open(filename, O_RDONLY);
458 + if (vmar->fd < 0) {
459 + error_setg(errp, "can't open file %s - %s\n", filename,
460 + g_strerror(errno));
464 + vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
465 + if (!vmar->md5csum) {
466 + error_setg(errp, "can't allocate cmsum\n");
470 + vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
473 + if (vma_reader_read_head(vmar, errp) < 0) {
481 + vma_reader_destroy(vmar);
487 +VmaHeader *vma_reader_get_header(VmaReader *vmar)
490 + assert(vmar->head_data);
492 + return (VmaHeader *)(vmar->head_data);
495 +GList *vma_reader_get_config_data(VmaReader *vmar)
498 + assert(vmar->head_data);
500 + return vmar->cdata_list;
503 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
508 + if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
509 + return &vmar->devinfo[dev_id];
515 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockDriverState *bs,
516 + bool write_zeroes, Error **errp)
519 + assert(bs != NULL);
521 + assert(vmar->rstate[dev_id].bs == NULL);
523 + int64_t size = bdrv_getlength(bs);
524 + if (size != vmar->devinfo[dev_id].size) {
525 + error_setg(errp, "vma_reader_register_bs for stream %s failed - "
526 + "unexpected size %zd != %zd", vmar->devinfo[dev_id].devname,
527 + size, vmar->devinfo[dev_id].size);
531 + vmar->rstate[dev_id].bs = bs;
532 + vmar->rstate[dev_id].write_zeroes = write_zeroes;
534 + int64_t bitmap_size = (size/BDRV_SECTOR_SIZE) +
535 + (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG - 1;
536 + bitmap_size /= (VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE) * BITS_PER_LONG;
538 + vmar->rstate[dev_id].bitmap_size = bitmap_size;
539 + vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
541 + vmar->cluster_count += size/VMA_CLUSTER_SIZE;
546 +static ssize_t safe_write(int fd, void *buf, size_t count)
551 + n = write(fd, buf, count);
552 + } while (n < 0 && errno == EINTR);
557 +static size_t full_write(int fd, void *buf, size_t len)
565 + n = safe_write(fd, buf, len);
575 + /* incomplete write ? */
582 +static int restore_write_data(VmaReader *vmar, guint8 dev_id,
583 + BlockDriverState *bs, int vmstate_fd,
584 + unsigned char *buf, int64_t sector_num,
585 + int nb_sectors, Error **errp)
589 + if (dev_id == vmar->vmstate_stream) {
590 + if (vmstate_fd >= 0) {
591 + int len = nb_sectors * BDRV_SECTOR_SIZE;
592 + int res = full_write(vmstate_fd, buf, len);
594 + error_setg(errp, "write vmstate failed %d", res);
599 + int res = bdrv_write(bs, sector_num, buf, nb_sectors);
601 + error_setg(errp, "bdrv_write to %s failed (%d)",
602 + bdrv_get_device_name(bs), res);
608 +static int restore_extent(VmaReader *vmar, unsigned char *buf,
609 + int extent_size, int vmstate_fd,
610 + bool verbose, Error **errp)
615 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
616 + int start = VMA_EXTENT_HEADER_SIZE;
619 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
620 + uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
621 + uint64_t cluster_num = block_info & 0xffffffff;
622 + uint8_t dev_id = (block_info >> 32) & 0xff;
623 + uint16_t mask = block_info >> (32+16);
624 + int64_t max_sector;
630 + VmaRestoreState *rstate = &vmar->rstate[dev_id];
631 + BlockDriverState *bs = NULL;
633 + if (dev_id != vmar->vmstate_stream) {
636 + error_setg(errp, "got wrong dev id %d", dev_id);
640 + if (vma_reader_get_bitmap(rstate, cluster_num)) {
641 + error_setg(errp, "found duplicated cluster %zd for stream %s",
642 + cluster_num, vmar->devinfo[dev_id].devname);
645 + vma_reader_set_bitmap(rstate, cluster_num, 1);
647 + max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
649 + max_sector = G_MAXINT64;
650 + if (cluster_num != vmar->vmstate_clusters) {
651 + error_setg(errp, "found out of order vmstate data");
654 + vmar->vmstate_clusters++;
657 + vmar->clusters_read++;
660 + time_t duration = time(NULL) - vmar->start_time;
661 + int percent = (vmar->clusters_read*100)/vmar->cluster_count;
662 + if (percent != vmar->clusters_read_per) {
663 + printf("progress %d%% (read %zd bytes, duration %zd sec)\n",
664 + percent, vmar->clusters_read*VMA_CLUSTER_SIZE,
667 + vmar->clusters_read_per = percent;
671 + /* try to write whole clusters to speedup restore */
672 + if (mask == 0xffff) {
673 + if ((start + VMA_CLUSTER_SIZE) > extent_size) {
674 + error_setg(errp, "short vma extent - too many blocks");
677 + int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
679 + int64_t end_sector = sector_num +
680 + VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
682 + if (end_sector > max_sector) {
683 + end_sector = max_sector;
686 + if (end_sector <= sector_num) {
687 + error_setg(errp, "got wrong block address - write bejond end");
691 + int nb_sectors = end_sector - sector_num;
692 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd, buf + start,
693 + sector_num, nb_sectors, errp) < 0) {
697 + start += VMA_CLUSTER_SIZE;
702 + for (j = 0; j < 16; j++) {
703 + int64_t sector_num = (cluster_num*VMA_CLUSTER_SIZE +
704 + j*VMA_BLOCK_SIZE)/BDRV_SECTOR_SIZE;
706 + int64_t end_sector = sector_num +
707 + VMA_BLOCK_SIZE/BDRV_SECTOR_SIZE;
708 + if (end_sector > max_sector) {
709 + end_sector = max_sector;
713 + if ((start + VMA_BLOCK_SIZE) > extent_size) {
714 + error_setg(errp, "short vma extent - too many blocks");
718 + if (end_sector <= sector_num) {
719 + error_setg(errp, "got wrong block address - "
720 + "write bejond end");
724 + int nb_sectors = end_sector - sector_num;
725 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd,
726 + buf + start, sector_num,
727 + nb_sectors, errp) < 0) {
731 + start += VMA_BLOCK_SIZE;
735 + if (rstate->write_zeroes && (end_sector > sector_num)) {
736 + /* Todo: use bdrv_co_write_zeroes (but that need to
737 + * be run inside coroutine?)
739 + int nb_sectors = end_sector - sector_num;
740 + if (restore_write_data(vmar, dev_id, bs, vmstate_fd,
741 + zero_vma_block, sector_num,
742 + nb_sectors, errp) < 0) {
753 + if (start != extent_size) {
754 + error_setg(errp, "vma extent error - missing blocks");
761 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
765 + assert(vmar->head_data);
768 + unsigned char buf[VMA_MAX_EXTENT_SIZE];
770 + unsigned char md5sum[16];
771 + VmaHeader *h = (VmaHeader *)vmar->head_data;
773 + vmar->start_time = time(NULL);
776 + int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
778 + error_setg(errp, "read failed - %s", g_strerror(errno));
788 + if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
789 + error_setg(errp, "read short extent (%d bytes)", buf_pos);
793 + VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
795 + /* extract md5sum */
796 + memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
797 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
799 + g_checksum_reset(vmar->md5csum);
800 + g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
802 + g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
804 + if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
805 + error_setg(errp, "wrong vma extent header chechsum");
809 + if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
810 + error_setg(errp, "wrong vma extent uuid");
814 + if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
815 + error_setg(errp, "wrong vma extent header magic");
819 + int block_count = GUINT16_FROM_BE(ehead->block_count);
820 + int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
822 + if (buf_pos < extent_size) {
823 + error_setg(errp, "short vma extent (%d < %d)", buf_pos,
828 + if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
833 + if (buf_pos > extent_size) {
834 + memmove(buf, buf + extent_size, buf_pos - extent_size);
835 + buf_pos = buf_pos - extent_size;
844 + for (i = 1; i < 256; i++) {
845 + VmaRestoreState *rstate = &vmar->rstate[i];
850 + if (bdrv_flush(rstate->bs) < 0) {
851 + error_setg(errp, "vma bdrv_flush %s failed",
852 + vmar->devinfo[i].devname);
856 + if (vmar->devinfo[i].size &&
857 + (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
858 + assert(rstate->bitmap);
860 + int64_t cluster_num, end;
862 + end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
865 + for (cluster_num = 0; cluster_num < end; cluster_num++) {
866 + if (!vma_reader_get_bitmap(rstate, cluster_num)) {
867 + error_setg(errp, "detected missing cluster %zd "
868 + "for stream %s", cluster_num,
869 + vmar->devinfo[i].devname);
879 Index: new/vma-writer.c
880 ===================================================================
881 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
882 +++ new/vma-writer.c 2013-11-28 11:03:52.000000000 +0100
885 + * VMA: Virtual Machine Archive
887 + * Copyright (C) 2012 Proxmox Server Solutions
890 + * Dietmar Maurer (dietmar@proxmox.com)
892 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
893 + * See the COPYING file in the top-level directory.
902 +#include <sys/types.h>
903 +#include <sys/stat.h>
906 +#include <uuid/uuid.h>
908 +#include "qemu-common.h"
910 +#include "block/block.h"
911 +#include "monitor/monitor.h"
915 +#define DPRINTF(fmt, ...)\
916 + do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
918 +#define WRITE_BUFFERS 5
920 +typedef struct VmaAIOCB VmaAIOCB;
922 + unsigned char buffer[VMA_MAX_EXTENT_SIZE];
934 + bool header_written;
937 + /* we always write extents */
938 + unsigned char outbuf[VMA_MAX_EXTENT_SIZE];
939 + int outbuf_pos; /* in bytes */
940 + int outbuf_count; /* in VMA_BLOCKS */
941 + uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
943 + VmaAIOCB *aiocbs[WRITE_BUFFERS];
946 + GChecksum *md5csum;
947 + CoMutex writer_lock;
948 + CoMutex flush_lock;
949 + Coroutine *co_writer;
951 + /* drive informations */
952 + VmaStreamInfo stream_info[256];
953 + guint stream_count;
955 + guint8 vmstate_stream;
956 + uint32_t vmstate_clusters;
958 + /* header blob table */
959 + char *header_blob_table;
960 + uint32_t header_blob_table_size;
961 + uint32_t header_blob_table_pos;
963 + /* store for config blobs */
964 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
965 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
966 + uint32_t config_count;
969 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
973 + if (vmaw->status < 0) {
980 + g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
983 + DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
986 +static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
993 + if (!vmaw->header_blob_table ||
994 + (vmaw->header_blob_table_size <
995 + (vmaw->header_blob_table_pos + len + 2))) {
996 + int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
998 + vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
999 + memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1000 + 0, newsize - vmaw->header_blob_table_size);
1001 + vmaw->header_blob_table_size = newsize;
1004 + uint32_t cpos = vmaw->header_blob_table_pos;
1005 + vmaw->header_blob_table[cpos] = len & 255;
1006 + vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1007 + memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1008 + vmaw->header_blob_table_pos += len + 2;
1012 +static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1016 + size_t len = strlen(str) + 1;
1018 + return allocate_header_blob(vmaw, str, len);
1021 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1025 + assert(!vmaw->header_written);
1026 + assert(vmaw->config_count < VMA_MAX_CONFIGS);
1031 + uint32_t name_ptr = allocate_header_string(vmaw, name);
1036 + uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1041 + vmaw->config_names[vmaw->config_count] = name_ptr;
1042 + vmaw->config_data[vmaw->config_count] = data_ptr;
1044 + vmaw->config_count++;
1049 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1054 + assert(!vmaw->status);
1056 + if (vmaw->header_written) {
1057 + vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1058 + "already written");
1062 + guint n = vmaw->stream_count + 1;
1064 + /* we can have dev_ids form 1 to 255 (0 reserved)
1065 + * 255(-1) reseverd for safety
1068 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1069 + "too many drives");
1074 + vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1075 + "got strange size %zd", size);
1079 + DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1081 + vmaw->stream_info[n].devname = g_strdup(devname);
1082 + vmaw->stream_info[n].size = size;
1084 + vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1087 + vmaw->stream_count = n;
1089 + if (strcmp(devname, "vmstate") == 0) {
1090 + vmaw->vmstate_stream = n;
1096 +static void vma_co_continue_write(void *opaque)
1098 + VmaWriter *vmaw = opaque;
1100 + DPRINTF("vma_co_continue_write\n");
1101 + qemu_coroutine_enter(vmaw->co_writer, NULL);
1104 +static ssize_t coroutine_fn
1105 +vma_co_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1110 + /* atomic writes (we cannot interleave writes) */
1111 + qemu_co_mutex_lock(&vmaw->writer_lock);
1113 + DPRINTF("vma_co_write enter %zd\n", bytes);
1115 + assert(vmaw->co_writer == NULL);
1117 + vmaw->co_writer = qemu_coroutine_self();
1119 + qemu_aio_set_fd_handler(vmaw->fd, NULL, vma_co_continue_write, vmaw);
1121 + DPRINTF("vma_co_write wait until writable\n");
1122 + qemu_coroutine_yield();
1123 + DPRINTF("vma_co_write starting %zd\n", bytes);
1125 + while (done < bytes) {
1126 + ret = write(vmaw->fd, buf + done, bytes - done);
1129 + DPRINTF("vma_co_write written %zd %zd\n", done, ret);
1130 + } else if (ret < 0) {
1131 + if (errno == EAGAIN || errno == EWOULDBLOCK) {
1132 + DPRINTF("vma_co_write yield %zd\n", done);
1133 + qemu_coroutine_yield();
1134 + DPRINTF("vma_co_write restart %zd\n", done);
1136 + vma_writer_set_error(vmaw, "vma_co_write write error - %s",
1137 + g_strerror(errno));
1138 + done = -1; /* always return failure for partial writes */
1141 + } else if (ret == 0) {
1142 + /* should not happen - simply try again */
1146 + qemu_aio_set_fd_handler(vmaw->fd, NULL, NULL, NULL);
1148 + vmaw->co_writer = NULL;
1150 + qemu_co_mutex_unlock(&vmaw->writer_lock);
1152 + DPRINTF("vma_co_write leave %zd\n", done);
1156 +static void coroutine_fn vma_co_writer_task(void *opaque)
1158 + VmaAIOCB *cb = opaque;
1160 + DPRINTF("vma_co_writer_task start\n");
1162 + int64_t done = vma_co_write(cb->vmaw, cb->buffer, cb->bytes);
1163 + DPRINTF("vma_co_writer_task write done %zd\n", done);
1165 + if (done != cb->bytes) {
1166 + DPRINTF("vma_co_writer_task failed write %zd %zd", cb->bytes, done);
1167 + vma_writer_set_error(cb->vmaw, "vma_co_writer_task failed write %zd",
1173 + qemu_co_queue_next(&cb->vmaw->wqueue);
1175 + DPRINTF("vma_co_writer_task end\n");
1178 +static void coroutine_fn vma_queue_flush(VmaWriter *vmaw)
1180 + DPRINTF("vma_queue_flush enter\n");
1186 + VmaAIOCB *cb = NULL;
1187 + for (i = 0; i < WRITE_BUFFERS; i++) {
1188 + if (vmaw->aiocbs[i]->bytes) {
1189 + cb = vmaw->aiocbs[i];
1190 + DPRINTF("FOUND USED AIO BUFFER %d %zd\n", i,
1191 + vmaw->aiocbs[i]->bytes);
1198 + qemu_co_queue_wait(&vmaw->wqueue);
1201 + DPRINTF("vma_queue_flush leave\n");
1205 + * NOTE: pipe buffer size in only 4096 bytes on linux (see 'ulimit -a')
1206 + * So we need to create a coroutione to allow 'parallel' execution.
1208 +static ssize_t coroutine_fn
1209 +vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1211 + DPRINTF("vma_queue_write enter %zd\n", bytes);
1215 + assert(bytes <= VMA_MAX_EXTENT_SIZE);
1217 + VmaAIOCB *cb = NULL;
1220 + for (i = 0; i < WRITE_BUFFERS; i++) {
1221 + if (!vmaw->aiocbs[i]->bytes) {
1222 + cb = vmaw->aiocbs[i];
1227 + qemu_co_queue_wait(&vmaw->wqueue);
1231 + memcpy(cb->buffer, buf, bytes);
1232 + cb->bytes = bytes;
1235 + DPRINTF("vma_queue_write start %zd\n", bytes);
1236 + cb->co = qemu_coroutine_create(vma_co_writer_task);
1237 + qemu_coroutine_enter(cb->co, cb);
1239 + DPRINTF("vma_queue_write leave\n");
1244 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp)
1248 + assert(sizeof(VmaHeader) == (4096 + 8192));
1249 + assert(sizeof(VmaExtentHeader) == 512);
1251 + VmaWriter *vmaw = g_new0(VmaWriter, 1);
1254 + vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1255 + if (!vmaw->md5csum) {
1256 + error_setg(errp, "can't allocate cmsum\n");
1260 + if (strstart(filename, "exec:", &p)) {
1261 + vmaw->cmd = popen(p, "w");
1262 + if (vmaw->cmd == NULL) {
1263 + error_setg(errp, "can't popen command '%s' - %s\n", p,
1264 + g_strerror(errno));
1267 + vmaw->fd = fileno(vmaw->cmd);
1269 + /* try to use O_NONBLOCK and O_DIRECT */
1270 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1271 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_DIRECT);
1276 + const char *tmp_id_str;
1278 + if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1279 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY;
1280 + vmaw->fd = qemu_open(filename, oflags, 0644);
1281 + } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1282 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY;
1283 + vmaw->fd = qemu_open(filename, oflags, 0644);
1284 + } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1285 + vmaw->fd = monitor_get_fd(cur_mon, tmp_id_str, errp);
1286 + if (vmaw->fd < 0) {
1289 + /* try to use O_NONBLOCK and O_DIRECT */
1290 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_NONBLOCK);
1291 + fcntl(vmaw->fd, F_SETFL, fcntl(vmaw->fd, F_GETFL)|O_DIRECT);
1293 + oflags = O_NONBLOCK|O_DIRECT|O_WRONLY|O_CREAT|O_EXCL;
1294 + vmaw->fd = qemu_open(filename, oflags, 0644);
1297 + if (vmaw->fd < 0) {
1298 + error_setg(errp, "can't open file %s - %s\n", filename,
1299 + g_strerror(errno));
1304 + /* we use O_DIRECT, so we need to align IO buffers */
1306 + for (i = 0; i < WRITE_BUFFERS; i++) {
1307 + vmaw->aiocbs[i] = qemu_memalign(512, sizeof(VmaAIOCB));
1308 + memset(vmaw->aiocbs[i], 0, sizeof(VmaAIOCB));
1311 + vmaw->outbuf_count = 0;
1312 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1314 + vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1316 + qemu_co_mutex_init(&vmaw->writer_lock);
1317 + qemu_co_mutex_init(&vmaw->flush_lock);
1318 + qemu_co_queue_init(&vmaw->wqueue);
1320 + uuid_copy(vmaw->uuid, uuid);
1327 + pclose(vmaw->cmd);
1328 + } else if (vmaw->fd >= 0) {
1332 + if (vmaw->md5csum) {
1333 + g_checksum_free(vmaw->md5csum);
1342 +static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1345 + int header_clusters = 8;
1346 + char buf[65536*header_clusters];
1347 + VmaHeader *head = (VmaHeader *)buf;
1351 + DPRINTF("VMA WRITE HEADER\n");
1353 + if (vmaw->status < 0) {
1354 + return vmaw->status;
1357 + memset(buf, 0, sizeof(buf));
1359 + head->magic = VMA_MAGIC;
1360 + head->version = GUINT32_TO_BE(1); /* v1 */
1361 + memcpy(head->uuid, vmaw->uuid, 16);
1363 + time_t ctime = time(NULL);
1364 + head->ctime = GUINT64_TO_BE(ctime);
1366 + if (!vmaw->stream_count) {
1370 + for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1371 + head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1372 + head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1375 + /* 32 bytes per device (12 used currently) = 8192 bytes max */
1376 + for (i = 1; i <= 254; i++) {
1377 + VmaStreamInfo *si = &vmaw->stream_info[i];
1379 + assert(si->devname);
1380 + uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1381 + if (!devname_ptr) {
1384 + head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1385 + head->dev_info[i].size = GUINT64_TO_BE(si->size);
1389 + uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1390 + head->header_size = GUINT32_TO_BE(header_size);
1392 + if (header_size > sizeof(buf)) {
1393 + return -1; /* just to be sure */
1396 + uint32_t blob_buffer_offset = sizeof(VmaHeader);
1397 + memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1398 + vmaw->header_blob_table_size);
1399 + head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1400 + head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1402 + g_checksum_reset(vmaw->md5csum);
1403 + g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1405 + g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1407 + return vma_queue_write(vmaw, buf, header_size);
1410 +static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1417 + if (vmaw->status < 0) {
1418 + return vmaw->status;
1421 + if (!vmaw->header_written) {
1422 + vmaw->header_written = true;
1423 + ret = vma_write_header(vmaw);
1425 + vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1430 + DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1433 + VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1435 + ehead->magic = VMA_EXTENT_MAGIC;
1436 + ehead->reserved1 = 0;
1438 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1439 + ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1442 + guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1445 + ehead->block_count = GUINT16_TO_BE(block_count);
1447 + memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1448 + memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1450 + g_checksum_reset(vmaw->md5csum);
1451 + g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1453 + g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1455 + int bytes = vmaw->outbuf_pos;
1456 + ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1457 + if (ret != bytes) {
1458 + vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1461 + vmaw->outbuf_count = 0;
1462 + vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1464 + for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1465 + vmaw->outbuf_block_info[i] = 0;
1468 + return vmaw->status;
1471 +static int vma_count_open_streams(VmaWriter *vmaw)
1473 + g_assert(vmaw != NULL);
1476 + int open_drives = 0;
1477 + for (i = 0; i <= 255; i++) {
1478 + if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1483 + return open_drives;
1487 + * all jobs should call this when there is no more data
1488 + * Returns: number of remaining stream (0 ==> finished)
1491 +vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1493 + g_assert(vmaw != NULL);
1495 + DPRINTF("vma_writer_set_status %d\n", dev_id);
1496 + if (!vmaw->stream_info[dev_id].size) {
1497 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1498 + "no such stream %d", dev_id);
1501 + if (vmaw->stream_info[dev_id].finished) {
1502 + vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1503 + "stream already closed %d", dev_id);
1507 + vmaw->stream_info[dev_id].finished = true;
1509 + int open_drives = vma_count_open_streams(vmaw);
1511 + if (open_drives <= 0) {
1512 + DPRINTF("vma_writer_set_status all drives completed\n");
1513 + qemu_co_mutex_lock(&vmaw->flush_lock);
1514 + int ret = vma_writer_flush(vmaw);
1515 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1517 + vma_writer_set_error(vmaw, "vma_writer_close_stream: flush failed");
1521 + return open_drives;
1524 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1528 + g_assert(vmaw != NULL);
1531 + status->status = vmaw->status;
1532 + g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1533 + for (i = 0; i <= 255; i++) {
1534 + status->stream_info[i] = vmaw->stream_info[i];
1537 + uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1540 + status->closed = vmaw->closed;
1542 + return vmaw->status;
1545 +static int vma_writer_get_buffer(VmaWriter *vmaw)
1549 + qemu_co_mutex_lock(&vmaw->flush_lock);
1551 + /* wait until buffer is available */
1552 + while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1553 + ret = vma_writer_flush(vmaw);
1555 + vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1560 + qemu_co_mutex_unlock(&vmaw->flush_lock);
1566 +int64_t coroutine_fn
1567 +vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1568 + unsigned char *buf, size_t *zero_bytes)
1570 + g_assert(vmaw != NULL);
1571 + g_assert(zero_bytes != NULL);
1575 + if (vmaw->status < 0) {
1576 + return vmaw->status;
1579 + if (!dev_id || !vmaw->stream_info[dev_id].size) {
1580 + vma_writer_set_error(vmaw, "vma_writer_write: "
1581 + "no such stream %d", dev_id);
1585 + if (vmaw->stream_info[dev_id].finished) {
1586 + vma_writer_set_error(vmaw, "vma_writer_write: "
1587 + "stream already closed %d", dev_id);
1592 + if (cluster_num >= (((uint64_t)1)<<32)) {
1593 + vma_writer_set_error(vmaw, "vma_writer_write: "
1594 + "cluster number out of range");
1598 + if (dev_id == vmaw->vmstate_stream) {
1599 + if (cluster_num != vmaw->vmstate_clusters) {
1600 + vma_writer_set_error(vmaw, "vma_writer_write: "
1601 + "non sequential vmstate write");
1603 + vmaw->vmstate_clusters++;
1604 + } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1605 + vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1609 + /* wait until buffer is available */
1610 + if (vma_writer_get_buffer(vmaw) < 0) {
1611 + vma_writer_set_error(vmaw, "vma_writer_write: "
1612 + "vma_writer_get_buffer failed");
1616 + DPRINTF("VMA WRITE %d %zd\n", dev_id, cluster_num);
1618 + uint16_t mask = 0;
1623 + for (i = 0; i < 16; i++) {
1624 + unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1625 + if (!buffer_is_zero(vmablock, VMA_BLOCK_SIZE)) {
1627 + memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock,
1629 + vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1631 + DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1632 + vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1633 + *zero_bytes += VMA_BLOCK_SIZE;
1639 + DPRINTF("VMA WRITE %zd ZERO CLUSTER\n", cluster_num);
1640 + vmaw->stream_info[dev_id].zero_bytes += VMA_CLUSTER_SIZE;
1641 + *zero_bytes += VMA_CLUSTER_SIZE;
1644 + uint64_t block_info = ((uint64_t)mask) << (32+16);
1645 + block_info |= ((uint64_t)dev_id) << 32;
1646 + block_info |= (cluster_num & 0xffffffff);
1647 + vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1649 + DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1651 + vmaw->outbuf_count++;
1653 + /** NOTE: We allways write whole clusters, but we correctly set
1654 + * transferred bytes. So transferred == size when when everything
1657 + size_t transferred = VMA_CLUSTER_SIZE;
1659 + if (dev_id != vmaw->vmstate_stream) {
1660 + uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1661 + if (last > vmaw->stream_info[dev_id].size) {
1662 + uint64_t diff = last - vmaw->stream_info[dev_id].size;
1663 + if (diff >= VMA_CLUSTER_SIZE) {
1664 + vma_writer_set_error(vmaw, "vma_writer_write: "
1665 + "read after last cluster");
1668 + transferred -= diff;
1672 + vmaw->stream_info[dev_id].transferred += transferred;
1674 + return transferred;
1677 +int vma_writer_close(VmaWriter *vmaw, Error **errp)
1679 + g_assert(vmaw != NULL);
1683 + vma_queue_flush(vmaw);
1685 + /* this should not happen - just to be sure */
1686 + while (!qemu_co_queue_empty(&vmaw->wqueue)) {
1687 + DPRINTF("vma_writer_close wait\n");
1688 + co_sleep_ns(QEMU_CLOCK_REALTIME, 1000000);
1692 + if (pclose(vmaw->cmd) < 0) {
1693 + vma_writer_set_error(vmaw, "vma_writer_close: "
1694 + "pclose failed - %s", g_strerror(errno));
1697 + if (close(vmaw->fd) < 0) {
1698 + vma_writer_set_error(vmaw, "vma_writer_close: "
1699 + "close failed - %s", g_strerror(errno));
1703 + for (i = 0; i <= 255; i++) {
1704 + VmaStreamInfo *si = &vmaw->stream_info[i];
1706 + if (!si->finished) {
1707 + vma_writer_set_error(vmaw, "vma_writer_close: "
1708 + "detected open stream '%s'", si->devname);
1709 + } else if ((si->transferred != si->size) &&
1710 + (i != vmaw->vmstate_stream)) {
1711 + vma_writer_set_error(vmaw, "vma_writer_close: "
1712 + "incomplete stream '%s' (%zd != %zd)",
1713 + si->devname, si->transferred, si->size);
1718 + for (i = 0; i <= 255; i++) {
1719 + vmaw->stream_info[i].finished = 1; /* mark as closed */
1724 + if (vmaw->status < 0 && *errp == NULL) {
1725 + error_setg(errp, "%s", vmaw->errmsg);
1728 + return vmaw->status;
1731 +void vma_writer_destroy(VmaWriter *vmaw)
1737 + for (i = 0; i <= 255; i++) {
1738 + if (vmaw->stream_info[i].devname) {
1739 + g_free(vmaw->stream_info[i].devname);
1743 + if (vmaw->md5csum) {
1744 + g_checksum_free(vmaw->md5csum);
1747 + for (i = 0; i < WRITE_BUFFERS; i++) {
1748 + free(vmaw->aiocbs[i]);
1754 ===================================================================
1755 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
1756 +++ new/vma.c 2013-11-28 12:08:39.000000000 +0100
1759 + * VMA: Virtual Machine Archive
1761 + * Copyright (C) 2012-2013 Proxmox Server Solutions
1764 + * Dietmar Maurer (dietmar@proxmox.com)
1766 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
1767 + * See the COPYING file in the top-level directory.
1773 +#include <unistd.h>
1775 +#include <string.h>
1776 +#include <sys/types.h>
1777 +#include <sys/stat.h>
1782 +#include "qemu-common.h"
1783 +#include "qemu/error-report.h"
1784 +#include "qemu/main-loop.h"
1786 +static void help(void)
1788 + const char *help_msg =
1789 + "usage: vma command [command options]\n"
1791 + "vma list <filename>\n"
1792 + "vma create <filename> [-c config] <archive> pathname ...\n"
1793 + "vma extract <filename> [-r] <targetdir>\n"
1796 + printf("%s", help_msg);
1800 +static const char *extract_devname(const char *path, char **devname, int index)
1804 + const char *sep = strchr(path, '=');
1807 + *devname = g_strndup(path, sep - path);
1811 + *devname = g_strdup_printf("disk%d", index);
1820 +static void print_content(VmaReader *vmar)
1824 + VmaHeader *head = vma_reader_get_header(vmar);
1826 + GList *l = vma_reader_get_config_data(vmar);
1827 + while (l && l->data) {
1828 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1829 + l = g_list_next(l);
1830 + printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1834 + VmaDeviceInfo *di;
1835 + for (i = 1; i < 255; i++) {
1836 + di = vma_reader_get_device_info(vmar, i);
1838 + if (strcmp(di->devname, "vmstate") == 0) {
1839 + printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1841 + printf("DEV: dev_id=%d size: %zd devname: %s\n",
1842 + i, di->size, di->devname);
1846 + /* ctime is the last entry we print */
1847 + printf("CTIME: %s", ctime(&head->ctime));
1851 +static int list_content(int argc, char **argv)
1854 + const char *filename;
1857 + c = getopt(argc, argv, "h");
1867 + g_assert_not_reached();
1871 + /* Get the filename */
1872 + if ((optind + 1) != argc) {
1875 + filename = argv[optind++];
1877 + Error *errp = NULL;
1878 + VmaReader *vmar = vma_reader_create(filename, &errp);
1881 + g_error("%s", error_get_pretty(errp));
1884 + print_content(vmar);
1886 + vma_reader_destroy(vmar);
1891 +typedef struct RestoreMap {
1897 +static int extract_content(int argc, char **argv)
1901 + const char *filename;
1902 + const char *dirname;
1903 + const char *readmap = NULL;
1906 + c = getopt(argc, argv, "hvr:");
1926 + /* Get the filename */
1927 + if ((optind + 2) != argc) {
1930 + filename = argv[optind++];
1931 + dirname = argv[optind++];
1933 + Error *errp = NULL;
1934 + VmaReader *vmar = vma_reader_create(filename, &errp);
1937 + g_error("%s", error_get_pretty(errp));
1940 + if (mkdir(dirname, 0777) < 0) {
1941 + g_error("unable to create target directory %s - %s",
1942 + dirname, g_strerror(errno));
1945 + GList *l = vma_reader_get_config_data(vmar);
1946 + while (l && l->data) {
1947 + VmaConfigData *cdata = (VmaConfigData *)l->data;
1948 + l = g_list_next(l);
1949 + char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
1950 + GError *err = NULL;
1951 + if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
1953 + g_error("unable to write file: %s", err->message);
1957 + GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
1960 + print_content(vmar);
1962 + FILE *map = fopen(readmap, "r");
1964 + g_error("unable to open fifo %s - %s", readmap, g_strerror(errno));
1969 + char *line = fgets(inbuf, sizeof(inbuf), map);
1970 + if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
1973 + int len = strlen(line);
1974 + if (line[len - 1] == '\n') {
1975 + line[len - 1] = '\0';
1983 + if (line[0] == '0' && line[1] == ':') {
1985 + write_zero = false;
1986 + } else if (line[0] == '1' && line[1] == ':') {
1988 + write_zero = true;
1990 + g_error("read map failed - parse error ('%s')", inbuf);
1993 + char *devname = NULL;
1994 + path = extract_devname(path, &devname, -1);
1996 + g_error("read map failed - no dev name specified ('%s')",
2000 + RestoreMap *map = g_new0(RestoreMap, 1);
2001 + map->devname = g_strdup(devname);
2002 + map->path = g_strdup(path);
2003 + map->write_zero = write_zero;
2005 + g_hash_table_insert(devmap, map->devname, map);
2011 + int vmstate_fd = -1;
2012 + guint8 vmstate_stream = 0;
2014 + for (i = 1; i < 255; i++) {
2015 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2016 + if (di && (strcmp(di->devname, "vmstate") == 0)) {
2017 + vmstate_stream = i;
2018 + char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2019 + vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2020 + if (vmstate_fd < 0) {
2021 + g_error("create vmstate file '%s' failed - %s", statefn,
2022 + g_strerror(errno));
2026 + char *devfn = NULL;
2027 + int flags = BDRV_O_RDWR|BDRV_O_CACHE_WB;
2028 + bool write_zero = true;
2032 + map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2033 + if (map == NULL) {
2034 + g_error("no device name mapping for %s", di->devname);
2036 + devfn = map->path;
2037 + write_zero = map->write_zero;
2039 + devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2040 + dirname, di->devname);
2041 + printf("DEVINFO %s %zd\n", devfn, di->size);
2043 + bdrv_img_create(devfn, "raw", NULL, NULL, NULL, di->size,
2045 + if (error_is_set(&errp)) {
2046 + g_error("can't create file %s: %s", devfn,
2047 + error_get_pretty(errp));
2050 + /* Note: we created an empty file above, so there is no
2051 + * need to write zeroes (so we generate a sparse file)
2053 + write_zero = false;
2056 + BlockDriverState *bs = bdrv_new(di->devname);
2057 + if (bdrv_open(bs, devfn, NULL, flags, NULL, &errp)) {
2058 + g_error("can't open file %s - %s", devfn,
2059 + error_get_pretty(errp));
2061 + if (vma_reader_register_bs(vmar, i, bs, write_zero, &errp) < 0) {
2062 + g_error("%s", error_get_pretty(errp));
2071 + if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
2072 + g_error("restore failed - %s", error_get_pretty(errp));
2076 + for (i = 1; i < 255; i++) {
2077 + VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2078 + if (di && (i != vmstate_stream)) {
2079 + char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2080 + dirname, di->devname);
2081 + char *fn = g_strdup_printf("%s/disk-%s.raw",
2082 + dirname, di->devname);
2083 + if (rename(tmpfn, fn) != 0) {
2084 + g_error("rename %s to %s failed - %s",
2085 + tmpfn, fn, g_strerror(errno));
2091 + vma_reader_destroy(vmar);
2098 +typedef struct BackupJob {
2099 + BlockDriverState *bs;
2106 +static int backup_dump_cb(void *opaque, BlockDriverState *bs,
2107 + int64_t cluster_num, unsigned char *buf)
2109 + BackupCB *bcb = opaque;
2111 + if (vma_writer_write(bcb->vmaw, bcb->dev_id, cluster_num, buf, &zb) < 0) {
2112 + g_warning("backup_dump_cb vma_writer_write failed");
2119 +static void backup_complete_cb(void *opaque, int ret)
2121 + BackupCB *bcb = opaque;
2124 + vma_writer_set_error(bcb->vmaw, "backup_complete_cb %d", ret);
2127 + if (vma_writer_close_stream(bcb->vmaw, bcb->dev_id) <= 0) {
2128 + Error *err = NULL;
2129 + if (vma_writer_close(bcb->vmaw, &err) != 0) {
2130 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2136 +#define BACKUP_SECTORS_PER_CLUSTER (VMA_CLUSTER_SIZE / BDRV_SECTOR_SIZE)
2138 +static void coroutine_fn backup_run(void *opaque)
2140 + BackupJob *job = (BackupJob *)opaque;
2142 + QEMUIOVector qiov;
2144 + int64_t start, end;
2147 + unsigned char *buf = qemu_blockalign(job->bs, VMA_CLUSTER_SIZE);
2150 + end = DIV_ROUND_UP(job->len / BDRV_SECTOR_SIZE,
2151 + BACKUP_SECTORS_PER_CLUSTER);
2153 + for (; start < end; start++) {
2154 + iov.iov_base = buf;
2155 + iov.iov_len = VMA_CLUSTER_SIZE;
2156 + qemu_iovec_init_external(&qiov, &iov, 1);
2158 + ret = bdrv_co_readv(job->bs, start * BACKUP_SECTORS_PER_CLUSTER,
2159 + BACKUP_SECTORS_PER_CLUSTER, &qiov);
2161 + vma_writer_set_error(job->vmaw, "read error", -1);
2166 + if (vma_writer_write(job->vmaw, job->dev_id, start, buf, &zb) < 0) {
2167 + vma_writer_set_error(job->vmaw, "backup_dump_cb vma_writer_write failed", -1);
2174 + if (vma_writer_close_stream(job->vmaw, job->dev_id) <= 0) {
2175 + Error *err = NULL;
2176 + if (vma_writer_close(job->vmaw, &err) != 0) {
2177 + g_warning("vma_writer_close failed %s", error_get_pretty(err));
2182 +static int create_archive(int argc, char **argv)
2186 + const char *archivename;
2187 + GList *config_files = NULL;
2190 + c = getopt(argc, argv, "hvc:");
2200 + config_files = g_list_append(config_files, optarg);
2206 + g_assert_not_reached();
2211 + /* make sure we have archive name and at least one path */
2212 + if ((optind + 2) > argc) {
2216 + archivename = argv[optind++];
2219 + uuid_generate(uuid);
2221 + Error *local_err = NULL;
2222 + VmaWriter *vmaw = vma_writer_create(archivename, uuid, &local_err);
2224 + if (vmaw == NULL) {
2225 + g_error("%s", error_get_pretty(local_err));
2228 + GList *l = config_files;
2229 + while (l && l->data) {
2230 + char *name = l->data;
2231 + char *cdata = NULL;
2233 + GError *err = NULL;
2234 + if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2235 + unlink(archivename);
2236 + g_error("Unable to read file: %s", err->message);
2239 + if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2240 + unlink(archivename);
2241 + g_error("Unable to append config data %s (len = %zd)",
2244 + l = g_list_next(l);
2248 + while (optind < argc) {
2249 + const char *path = argv[optind++];
2250 + char *devname = NULL;
2251 + path = extract_devname(path, &devname, ind++);
2253 + BlockDriver *drv = NULL;
2254 + BlockDriverState *bs = bdrv_new(devname);
2255 + Error *errp = NULL;
2257 + res = bdrv_open(bs, path, NULL, BDRV_O_CACHE_WB , drv, &errp);
2259 + unlink(archivename);
2260 + g_error("bdrv_open '%s' failed - %s", path, error_get_pretty(errp));
2262 + int64_t size = bdrv_getlength(bs);
2263 + int dev_id = vma_writer_register_stream(vmaw, devname, size);
2264 + if (dev_id <= 0) {
2265 + unlink(archivename);
2266 + g_error("vma_writer_register_stream '%s' failed", devname);
2269 + BackupJob *job = g_new0(BackupJob, 1);
2273 + job->dev_id = dev_id;
2275 + Coroutine *co = qemu_coroutine_create(backup_run);
2276 + qemu_coroutine_enter(co, job);
2278 + //BlockDriverState *target = NULL;
2279 + //backup_start(bs, target, 0, MIRROR_SYNC_MODE_FULL,
2280 + // BLOCKDEV_ON_ERROR_STOP, BLOCKDEV_ON_ERROR_STOP,
2281 + // NULL, bcb, &errp);
2283 + //if (backup_job_create(bs, backup_dump_cb, backup_complete_cb,
2285 + // unlink(archivename);
2286 + // g_error("backup_job_start failed");
2288 + // backup_job_start(bs, false);
2292 + VmaStatus vmastat;
2294 + int last_percent = -1;
2297 + main_loop_wait(false);
2298 + vma_writer_get_status(vmaw, &vmastat);
2302 + uint64_t total = 0;
2303 + uint64_t transferred = 0;
2304 + uint64_t zero_bytes = 0;
2307 + for (i = 0; i < 256; i++) {
2308 + if (vmastat.stream_info[i].size) {
2309 + total += vmastat.stream_info[i].size;
2310 + transferred += vmastat.stream_info[i].transferred;
2311 + zero_bytes += vmastat.stream_info[i].zero_bytes;
2314 + percent = (transferred*100)/total;
2315 + if (percent != last_percent) {
2316 + fprintf(stderr, "progress %d%% %zd/%zd %zd\n", percent,
2317 + transferred, total, zero_bytes);
2320 + last_percent = percent;
2324 + if (vmastat.closed) {
2331 + vma_writer_get_status(vmaw, &vmastat);
2334 + for (i = 0; i < 256; i++) {
2335 + VmaStreamInfo *si = &vmastat.stream_info[i];
2337 + fprintf(stderr, "image %s: size=%zd zeros=%zd saved=%zd\n",
2338 + si->devname, si->size, si->zero_bytes,
2339 + si->size - si->zero_bytes);
2344 + if (vmastat.status < 0) {
2345 + unlink(archivename);
2346 + g_error("creating vma archive failed");
2352 +int main(int argc, char **argv)
2354 + const char *cmdname;
2356 + error_set_progname(argv[0]);
2358 + qemu_init_main_loop();
2366 + cmdname = argv[1];
2370 + if (!strcmp(cmdname, "list")) {
2371 + return list_content(argc, argv);
2372 + } else if (!strcmp(cmdname, "create")) {
2373 + return create_archive(argc, argv);
2374 + } else if (!strcmp(cmdname, "extract")) {
2375 + return extract_content(argc, argv);
2382 ===================================================================
2383 --- /dev/null 1970-01-01 00:00:00.000000000 +0000
2384 +++ new/vma.h 2013-11-28 12:04:49.000000000 +0100
2387 + * VMA: Virtual Machine Archive
2389 + * Copyright (C) Proxmox Server Solutions
2392 + * Dietmar Maurer (dietmar@proxmox.com)
2394 + * This work is licensed under the terms of the GNU GPL, version 2 or later.
2395 + * See the COPYING file in the top-level directory.
2399 +#ifndef BACKUP_VMA_H
2400 +#define BACKUP_VMA_H
2402 +#include <uuid/uuid.h>
2403 +#include "qapi/error.h"
2404 +#include "block/block.h"
2406 +#define VMA_BLOCK_BITS 12
2407 +#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2408 +#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2409 +#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2411 +#if VMA_CLUSTER_SIZE != 65536
2412 +#error unexpected cluster size
2415 +#define VMA_EXTENT_HEADER_SIZE 512
2416 +#define VMA_BLOCKS_PER_EXTENT 59
2417 +#define VMA_MAX_CONFIGS 256
2419 +#define VMA_MAX_EXTENT_SIZE \
2420 + (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2421 +#if VMA_MAX_EXTENT_SIZE != 3867136
2422 +#error unexpected VMA_EXTENT_SIZE
2425 +/* File Format Definitions */
2427 +#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2428 +#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2430 +typedef struct VmaDeviceInfoHeader {
2431 + uint32_t devname_ptr; /* offset into blob_buffer table */
2432 + uint32_t reserved0;
2433 + uint64_t size; /* device size in bytes */
2434 + uint64_t reserved1;
2435 + uint64_t reserved2;
2436 +} VmaDeviceInfoHeader;
2438 +typedef struct VmaHeader {
2441 + unsigned char uuid[16];
2443 + unsigned char md5sum[16];
2445 + uint32_t blob_buffer_offset;
2446 + uint32_t blob_buffer_size;
2447 + uint32_t header_size;
2449 + unsigned char reserved[1984];
2451 + uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2452 + uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2454 + VmaDeviceInfoHeader dev_info[256];
2457 +typedef struct VmaExtentHeader {
2459 + uint16_t reserved1;
2460 + uint16_t block_count;
2461 + unsigned char uuid[16];
2462 + unsigned char md5sum[16];
2463 + uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2466 +/* functions/definitions to read/write vma files */
2468 +typedef struct VmaReader VmaReader;
2470 +typedef struct VmaWriter VmaWriter;
2472 +typedef struct VmaConfigData {
2478 +typedef struct VmaStreamInfo {
2480 + uint64_t cluster_count;
2481 + uint64_t transferred;
2482 + uint64_t zero_bytes;
2487 +typedef struct VmaStatus {
2490 + char errmsg[8192];
2491 + char uuid_str[37];
2492 + VmaStreamInfo stream_info[256];
2495 +typedef struct VmaDeviceInfo {
2496 + uint64_t size; /* device size in bytes */
2497 + const char *devname;
2500 +VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, Error **errp);
2501 +int vma_writer_close(VmaWriter *vmaw, Error **errp);
2502 +void vma_writer_destroy(VmaWriter *vmaw);
2503 +int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2505 +int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2508 +int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2509 + int64_t cluster_num, unsigned char *buf,
2510 + size_t *zero_bytes);
2512 +int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2514 +int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2515 +void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2518 +VmaReader *vma_reader_create(const char *filename, Error **errp);
2519 +void vma_reader_destroy(VmaReader *vmar);
2520 +VmaHeader *vma_reader_get_header(VmaReader *vmar);
2521 +GList *vma_reader_get_config_data(VmaReader *vmar);
2522 +VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2523 +int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2524 + BlockDriverState *bs, bool write_zeroes,
2526 +int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2529 +#endif /* BACKUP_VMA_H */