]> git.proxmox.com Git - pve-qemu-kvm.git/blame - debian/patches/0004-introduce-new-vma-archive-format.patch
fix vma patch
[pve-qemu-kvm.git] / debian / patches / 0004-introduce-new-vma-archive-format.patch
CommitLineData
9de54cd3 1From 9fb6fd584178db5b5a9f0b59f78c30b3c3066f73 Mon Sep 17 00:00:00 2001
5ad5891c
DM
2From: Dietmar Maurer <dietmar@proxmox.com>
3Date: Tue, 13 Nov 2012 11:11:38 +0100
4Subject: [PATCH v3 4/6] introduce new vma archive format
5
6This is a very simple archive format, see docs/specs/vma_spec.txt
7
8Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
9---
10 Makefile | 3 +-
11 Makefile.objs | 2 +-
12 blockdev.c | 6 +-
13 docs/specs/vma_spec.txt | 24 ++
4244016d 14 vma-reader.c | 801 +++++++++++++++++++++++++++++++++++++++++
3f350e0d 15 vma-writer.c | 920 +++++++++++++++++++++++++++++++++++++++++++++++
4244016d
DM
16 vma.c | 558 ++++++++++++++++++++++++++++
17 vma.h | 146 ++++++++
18 8 files changed, 2456 insertions(+), 4 deletions(-)
5ad5891c
DM
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
24
25diff --git a/Makefile b/Makefile
26index 9ecbcbb..30a9268 100644
27--- a/Makefile
28+++ b/Makefile
29@@ -100,7 +100,7 @@ defconfig:
30
31 -include config-all-devices.mak
32
33-all: $(DOCS) $(TOOLS) $(HELPERS-y) recurse-all
34+all: $(DOCS) $(TOOLS) vma$(EXESUF) $(HELPERS-y) recurse-all
35
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
43
44 qemu-bridge-helper$(EXESUF): qemu-bridge-helper.o
45
46diff --git a/Makefile.objs b/Makefile.objs
47index cb46be5..b5732e2 100644
48--- a/Makefile.objs
49+++ b/Makefile.objs
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
59diff --git a/blockdev.c b/blockdev.c
b09e7646 60index e89aa14..6764e73 100644
5ad5891c
DM
61--- a/blockdev.c
62+++ b/blockdev.c
63@@ -21,6 +21,7 @@
64 #include "trace.h"
65 #include "arch_init.h"
66 #include "backup.h"
67+#include "vma.h"
68
69 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
70
71@@ -1483,10 +1484,11 @@ char *qmp_backup(const char *backupfile, bool has_format, const char *format,
72 /* Todo: try to auto-detect format based on file name */
73 format = has_format ? format : "vma";
74
75- /* fixme: find driver for specifued format */
76 const BackupDriver *driver = NULL;
77
78- if (!driver) {
79+ if (strcmp(format, "vma") == 0) {
80+ driver = &backup_vma_driver;
81+ } else {
82 error_set(errp, ERROR_CLASS_GENERIC_ERROR,
83 "no backup driver for format '%s'", format);
84 return NULL;
85diff --git a/docs/specs/vma_spec.txt b/docs/specs/vma_spec.txt
86new file mode 100644
87index 0000000..052c629
88--- /dev/null
89+++ b/docs/specs/vma_spec.txt
90@@ -0,0 +1,24 @@
91+=Virtual Machine Archive format (VMA)=
92+
93+This format contains a header which includes the VM configuration as
94+binary blobs, and a list of devices (dev_id, name).
95+
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.
99+
100+We use a cluster size of 65536, and use 8 bytes for each
101+cluster in the header to store the following information:
102+
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)
107+
108+We only store non-zero blocks (such block is 4096 bytes).
109+
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
112+data).
113+
114+
115diff --git a/vma-reader.c b/vma-reader.c
116new file mode 100644
4244016d 117index 0000000..b6a550b
5ad5891c
DM
118--- /dev/null
119+++ b/vma-reader.c
4244016d 120@@ -0,0 +1,801 @@
5ad5891c
DM
121+/*
122+ * VMA: Virtual Machine Archive
123+ *
124+ * Copyright (C) 2012 Proxmox Server Solutions
125+ *
126+ * Authors:
127+ * Dietmar Maurer (dietmar@proxmox.com)
128+ *
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.
131+ *
132+ */
133+
134+#include <stdio.h>
135+#include <errno.h>
136+#include <unistd.h>
137+#include <stdio.h>
138+#include <string.h>
139+#include <sys/types.h>
140+#include <sys/stat.h>
141+#include <fcntl.h>
142+#include <glib.h>
143+#include <uuid/uuid.h>
144+
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"
150+#include "vma.h"
151+#include "block.h"
152+
153+#define BITS_PER_LONG (sizeof(unsigned long) * 8)
154+
155+static unsigned char zero_vma_block[VMA_BLOCK_SIZE];
156+
157+typedef struct VmaRestoreState {
158+ BlockDriverState *bs;
159+ bool write_zeroes;
160+ unsigned long *bitmap;
161+ int bitmap_size;
162+} VmaRestoreState;
163+
164+struct VmaReader {
165+ int fd;
166+ GChecksum *md5csum;
167+ GHashTable *blob_hash;
168+ unsigned char *head_data;
169+ VmaDeviceInfo devinfo[256];
170+ VmaRestoreState rstate[256];
171+ GList *cdata_list;
172+ guint8 vmstate_stream;
173+ uint32_t vmstate_clusters;
4244016d
DM
174+ /* to show restore percentage if run with -v */
175+ time_t start_time;
176+ int64_t cluster_count;
177+ int64_t clusters_read;
178+ int clusters_read_per;
5ad5891c
DM
179+};
180+
181+static guint
182+g_int32_hash(gconstpointer v)
183+{
184+ return *(const uint32_t *)v;
185+}
186+
187+static gboolean
188+g_int32_equal(gconstpointer v1, gconstpointer v2)
189+{
190+ return *((const uint32_t *)v1) == *((const uint32_t *)v2);
191+}
192+
193+static int vma_reader_get_bitmap(VmaRestoreState *rstate, int64_t cluster_num)
194+{
195+ assert(rstate);
196+ assert(rstate->bitmap);
197+
198+ unsigned long val, idx, bit;
199+
200+ idx = cluster_num / BITS_PER_LONG;
201+
202+ assert(rstate->bitmap_size > idx);
203+
204+ bit = cluster_num % BITS_PER_LONG;
205+ val = rstate->bitmap[idx];
206+
207+ return !!(val & (1UL << bit));
208+}
209+
210+static void vma_reader_set_bitmap(VmaRestoreState *rstate, int64_t cluster_num,
211+ int dirty)
212+{
213+ assert(rstate);
214+ assert(rstate->bitmap);
215+
216+ unsigned long val, idx, bit;
217+
218+ idx = cluster_num / BITS_PER_LONG;
219+
220+ assert(rstate->bitmap_size > idx);
221+
222+ bit = cluster_num % BITS_PER_LONG;
223+ val = rstate->bitmap[idx];
224+ if (dirty) {
225+ if (!(val & (1UL << bit))) {
226+ val |= 1UL << bit;
227+ }
228+ } else {
229+ if (val & (1UL << bit)) {
230+ val &= ~(1UL << bit);
231+ }
232+ }
233+ rstate->bitmap[idx] = val;
234+}
235+
236+typedef struct VmaBlob {
237+ uint32_t start;
238+ uint32_t len;
239+ void *data;
240+} VmaBlob;
241+
242+static const VmaBlob *get_header_blob(VmaReader *vmar, uint32_t pos)
243+{
244+ assert(vmar);
245+ assert(vmar->blob_hash);
246+
247+ return g_hash_table_lookup(vmar->blob_hash, &pos);
248+}
249+
250+static const char *get_header_str(VmaReader *vmar, uint32_t pos)
251+{
252+ const VmaBlob *blob = get_header_blob(vmar, pos);
253+ if (!blob) {
254+ return NULL;
255+ }
256+ const char *res = (char *)blob->data;
257+ if (res[blob->len-1] != '\0') {
258+ return NULL;
259+ }
260+ return res;
261+}
262+
263+static ssize_t
264+safe_read(int fd, unsigned char *buf, size_t count)
265+{
266+ ssize_t n;
267+
268+ do {
269+ n = read(fd, buf, count);
270+ } while (n < 0 && errno == EINTR);
271+
272+ return n;
273+}
274+
275+static ssize_t
276+full_read(int fd, unsigned char *buf, size_t len)
277+{
278+ ssize_t n;
279+ size_t total;
280+
281+ total = 0;
282+
283+ while (len > 0) {
284+ n = safe_read(fd, buf, len);
285+
286+ if (n == 0) {
287+ return total;
288+ }
289+
290+ if (n <= 0) {
291+ break;
292+ }
293+
294+ buf += n;
295+ total += n;
296+ len -= n;
297+ }
298+
299+ if (len) {
300+ return -1;
301+ }
302+
303+ return total;
304+}
305+
306+void vma_reader_destroy(VmaReader *vmar)
307+{
308+ assert(vmar);
309+
310+ if (vmar->fd >= 0) {
311+ close(vmar->fd);
312+ }
313+
314+ if (vmar->cdata_list) {
315+ g_list_free(vmar->cdata_list);
316+ }
317+
318+ int i;
319+ for (i = 1; i < 256; i++) {
320+ if (vmar->rstate[i].bitmap) {
321+ g_free(vmar->rstate[i].bitmap);
322+ }
323+ }
324+
325+ if (vmar->md5csum) {
326+ g_checksum_free(vmar->md5csum);
327+ }
328+
329+ if (vmar->blob_hash) {
330+ g_hash_table_destroy(vmar->blob_hash);
331+ }
332+
333+ if (vmar->head_data) {
334+ g_free(vmar->head_data);
335+ }
336+
337+ g_free(vmar);
338+
339+};
340+
341+static int vma_reader_read_head(VmaReader *vmar, Error **errp)
342+{
343+ assert(vmar);
344+ assert(errp);
345+ assert(*errp == NULL);
346+
347+ unsigned char md5sum[16];
348+ int i;
349+ int ret = 0;
350+
351+ vmar->head_data = g_malloc(sizeof(VmaHeader));
352+
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");
357+ return -1;
358+ }
359+
360+ VmaHeader *h = (VmaHeader *)vmar->head_data;
361+
362+ if (h->magic != VMA_MAGIC) {
363+ error_setg(errp, "not a vma file - wrong magic number");
364+ return -1;
365+ }
366+
367+ uint32_t header_size = GUINT32_FROM_BE(h->header_size);
368+ int need = header_size - sizeof(VmaHeader);
369+ if (need <= 0) {
370+ error_setg(errp, "wrong vma header size %d", header_size);
371+ return -1;
372+ }
373+
374+ vmar->head_data = g_realloc(vmar->head_data, header_size);
375+ h = (VmaHeader *)vmar->head_data;
376+
377+ if (full_read(vmar->fd, vmar->head_data + sizeof(VmaHeader), need) !=
378+ need) {
379+ error_setg(errp, "can't read vma header data - %s",
380+ errno ? strerror(errno) : "got EOF");
381+ return -1;
382+ }
383+
384+ memcpy(md5sum, h->md5sum, 16);
385+ memset(h->md5sum, 0, 16);
386+
387+ g_checksum_reset(vmar->md5csum);
388+ g_checksum_update(vmar->md5csum, vmar->head_data, header_size);
389+ gsize csize = 16;
390+ g_checksum_get_digest(vmar->md5csum, (guint8 *)(h->md5sum), &csize);
391+
392+ if (memcmp(md5sum, h->md5sum, 16) != 0) {
393+ error_setg(errp, "wrong vma header chechsum");
394+ return -1;
395+ }
396+
397+ /* we can modify header data after checksum verify */
398+ h->header_size = header_size;
399+
400+ h->version = GUINT32_FROM_BE(h->version);
401+ if (h->version != 1) {
402+ error_setg(errp, "wrong vma version %d", h->version);
403+ return -1;
404+ }
405+
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);
409+
410+ uint32_t bstart = h->blob_buffer_offset + 1;
411+ uint32_t bend = h->blob_buffer_offset + h->blob_buffer_size;
412+
413+ if (bstart <= sizeof(VmaHeader)) {
414+ error_setg(errp, "wrong vma blob buffer offset %d",
415+ h->blob_buffer_offset);
416+ return -1;
417+ }
418+
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);
422+ return -1;
423+ }
424+
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;
431+ blob->len = size;
432+ blob->data = vmar->head_data + bstart + 2;
433+ g_hash_table_insert(vmar->blob_hash, &blob->start, blob);
434+ }
435+ bstart += size + 2;
436+ }
437+
438+
439+ int count = 0;
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);
445+
446+ if (size && devname) {
447+ count++;
448+ vmar->devinfo[i].size = size;
449+ vmar->devinfo[i].devname = devname;
450+
451+ if (strcmp(devname, "vmstate") == 0) {
452+ vmar->vmstate_stream = i;
453+ }
454+ }
455+ }
456+
457+ if (!count) {
458+ error_setg(errp, "vma does not contain data");
459+ return -1;
460+ }
461+
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]);
465+
466+ if (!(name_ptr && data_ptr)) {
467+ continue;
468+ }
469+ const char *name = get_header_str(vmar, name_ptr);
470+ const VmaBlob *blob = get_header_blob(vmar, data_ptr);
471+
472+ if (!(name && blob)) {
473+ error_setg(errp, "vma contains invalid data pointers");
474+ return -1;
475+ }
476+
477+ VmaConfigData *cdata = g_new0(VmaConfigData, 1);
478+ cdata->name = name;
479+ cdata->data = blob->data;
480+ cdata->len = blob->len;
481+
482+ vmar->cdata_list = g_list_append(vmar->cdata_list, cdata);
483+ }
484+
485+ return ret;
486+};
487+
488+VmaReader *vma_reader_create(const char *filename, Error **errp)
489+{
490+ assert(filename);
491+ assert(errp);
492+
493+ VmaReader *vmar = g_new0(VmaReader, 1);
494+
3f350e0d
DM
495+ if (strcmp(filename, "-") == 0) {
496+ vmar->fd = dup(0);
497+ } else {
498+ vmar->fd = open(filename, O_RDONLY);
499+ }
5ad5891c
DM
500+
501+ if (vmar->fd < 0) {
502+ error_setg(errp, "can't open file %s - %s\n", filename,
503+ strerror(errno));
504+ goto err;
505+ }
506+
507+ vmar->md5csum = g_checksum_new(G_CHECKSUM_MD5);
508+ if (!vmar->md5csum) {
509+ error_setg(errp, "can't allocate cmsum\n");
510+ goto err;
511+ }
512+
513+ vmar->blob_hash = g_hash_table_new_full(g_int32_hash, g_int32_equal,
514+ NULL, g_free);
515+
516+ if (vma_reader_read_head(vmar, errp) < 0) {
517+ goto err;
518+ }
519+
520+ return vmar;
521+
522+err:
523+ if (vmar) {
524+ vma_reader_destroy(vmar);
525+ }
526+
527+ return NULL;
528+}
529+
530+VmaHeader *vma_reader_get_header(VmaReader *vmar)
531+{
532+ assert(vmar);
533+ assert(vmar->head_data);
534+
535+ return (VmaHeader *)(vmar->head_data);
536+}
537+
538+GList *vma_reader_get_config_data(VmaReader *vmar)
539+{
540+ assert(vmar);
541+ assert(vmar->head_data);
542+
543+ return vmar->cdata_list;
544+}
545+
546+VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id)
547+{
548+ assert(vmar);
549+ assert(dev_id);
550+
551+ if (vmar->devinfo[dev_id].size && vmar->devinfo[dev_id].devname) {
552+ return &vmar->devinfo[dev_id];
553+ }
554+
555+ return NULL;
556+}
557+
558+int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id, BlockDriverState *bs,
559+ bool write_zeroes, Error **errp)
560+{
561+ assert(vmar);
562+ assert(bs != NULL);
563+ assert(dev_id);
564+ assert(vmar->rstate[dev_id].bs == NULL);
565+
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);
571+ return -1;
572+ }
573+
574+ vmar->rstate[dev_id].bs = bs;
575+ vmar->rstate[dev_id].write_zeroes = write_zeroes;
576+
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;
580+
581+ vmar->rstate[dev_id].bitmap_size = bitmap_size;
582+ vmar->rstate[dev_id].bitmap = g_new0(unsigned long, bitmap_size);
583+
4244016d
DM
584+ vmar->cluster_count += size/VMA_CLUSTER_SIZE;
585+
5ad5891c
DM
586+ return 0;
587+}
588+
589+static ssize_t safe_write(int fd, void *buf, size_t count)
590+{
591+ ssize_t n;
592+
593+ do {
594+ n = write(fd, buf, count);
595+ } while (n < 0 && errno == EINTR);
596+
597+ return n;
598+}
599+
600+static size_t full_write(int fd, void *buf, size_t len)
601+{
602+ ssize_t n;
603+ size_t total;
604+
605+ total = 0;
606+
607+ while (len > 0) {
608+ n = safe_write(fd, buf, len);
609+ if (n < 0) {
610+ return n;
611+ }
612+ buf += n;
613+ total += n;
614+ len -= n;
615+ }
616+
617+ if (len) {
618+ /* incomplete write ? */
619+ return -1;
620+ }
621+
622+ return total;
623+}
624+
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)
629+{
630+ assert(vmar);
631+
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);
636+ if (res < 0) {
637+ error_setg(errp, "write vmstate failed %d", res);
638+ return -1;
639+ }
640+ }
641+ } else {
642+ int res = bdrv_write(bs, sector_num, buf, nb_sectors);
643+ if (res < 0) {
644+ error_setg(errp, "bdrv_write to %s failed (%d)",
645+ bdrv_get_device_name(bs), res);
646+ return -1;
647+ }
648+ }
649+ return 0;
650+}
651+static int restore_extent(VmaReader *vmar, unsigned char *buf,
4244016d
DM
652+ int extent_size, int vmstate_fd,
653+ bool verbose, Error **errp)
5ad5891c
DM
654+{
655+ assert(vmar);
656+ assert(buf);
657+
658+ VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
659+ int start = VMA_EXTENT_HEADER_SIZE;
660+ int i;
661+
662+ for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
663+ uint64_t block_info = GUINT64_FROM_BE(ehead->blockinfo[i]);
4244016d
DM
664+ uint64_t cluster_num = block_info & 0xffffffff;
665+ uint8_t dev_id = (block_info >> 32) & 0xff;
5ad5891c
DM
666+ uint16_t mask = block_info >> (32+16);
667+ int64_t max_sector;
668+
669+ if (!dev_id) {
670+ continue;
671+ }
672+
673+ VmaRestoreState *rstate = &vmar->rstate[dev_id];
674+ BlockDriverState *bs = NULL;
675+
676+ if (dev_id != vmar->vmstate_stream) {
677+ bs = rstate->bs;
678+ if (!bs) {
679+ error_setg(errp, "got wrong dev id %d", dev_id);
680+ return -1;
681+ }
682+
683+ if (vma_reader_get_bitmap(rstate, cluster_num)) {
4244016d 684+ error_setg(errp, "found duplicated cluster %zd for stream %s",
5ad5891c
DM
685+ cluster_num, vmar->devinfo[dev_id].devname);
686+ return -1;
687+ }
688+ vma_reader_set_bitmap(rstate, cluster_num, 1);
689+
690+ max_sector = vmar->devinfo[dev_id].size/BDRV_SECTOR_SIZE;
691+ } else {
692+ max_sector = G_MAXINT64;
693+ if (cluster_num != vmar->vmstate_clusters) {
694+ error_setg(errp, "found out of order vmstate data");
695+ return -1;
696+ }
697+ vmar->vmstate_clusters++;
698+ }
699+
4244016d
DM
700+ vmar->clusters_read++;
701+
702+ if (verbose) {
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,
708+ duration);
709+ fflush(stdout);
710+ vmar->clusters_read_per = percent;
711+ }
712+ }
713+
5ad5891c
DM
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");
718+ return -1;
719+ }
720+ int64_t sector_num = (cluster_num * VMA_CLUSTER_SIZE) /
721+ BDRV_SECTOR_SIZE;
722+ int64_t end_sector = sector_num +
723+ VMA_CLUSTER_SIZE/BDRV_SECTOR_SIZE;
724+
725+ if (end_sector > max_sector) {
726+ end_sector = max_sector;
727+ }
728+
729+ if (end_sector <= sector_num) {
730+ error_setg(errp, "got wrong block address - write bejond end");
731+ return -1;
732+ }
733+
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) {
737+ return -1;
738+ }
739+
740+ start += VMA_CLUSTER_SIZE;
741+ } else {
742+ int j;
743+ int bit = 1;
744+
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;
748+
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;
753+ }
754+
755+ if (mask & bit) {
756+ if ((start + VMA_BLOCK_SIZE) > extent_size) {
757+ error_setg(errp, "short vma extent - too many blocks");
758+ return -1;
759+ }
760+
761+ if (end_sector <= sector_num) {
762+ error_setg(errp, "got wrong block address - "
763+ "write bejond end");
764+ return -1;
765+ }
766+
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) {
771+ return -1;
772+ }
773+
774+ start += VMA_BLOCK_SIZE;
775+
776+ } else {
777+
4244016d 778+ if (rstate->write_zeroes && (end_sector > sector_num)) {
5ad5891c
DM
779+ /* Todo: use bdrv_co_write_zeroes (but that need to
780+ * be run inside coroutine?)
781+ */
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) {
786+ return -1;
787+ }
788+ }
789+ }
790+
791+ bit = bit << 1;
792+ }
793+ }
794+ }
795+
796+ if (start != extent_size) {
797+ error_setg(errp, "vma extent error - missing blocks");
798+ return -1;
799+ }
800+
801+ return 0;
802+}
803+
4244016d
DM
804+int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
805+ Error **errp)
5ad5891c
DM
806+{
807+ assert(vmar);
808+ assert(vmar->head_data);
809+
810+ int ret = 0;
811+ unsigned char buf[VMA_MAX_EXTENT_SIZE];
812+ int buf_pos = 0;
813+ unsigned char md5sum[16];
814+ VmaHeader *h = (VmaHeader *)vmar->head_data;
815+
4244016d 816+ vmar->start_time = time(NULL);
5ad5891c
DM
817+
818+ while (1) {
819+ int bytes = full_read(vmar->fd, buf + buf_pos, sizeof(buf) - buf_pos);
820+ if (bytes < 0) {
821+ error_setg(errp, "read failed - %s", strerror(errno));
822+ return -1;
823+ }
824+
825+ buf_pos += bytes;
826+
827+ if (!buf_pos) {
828+ break; /* EOF */
829+ }
830+
831+ if (buf_pos < VMA_EXTENT_HEADER_SIZE) {
832+ error_setg(errp, "read short extent (%d bytes)", buf_pos);
833+ return -1;
834+ }
835+
836+ VmaExtentHeader *ehead = (VmaExtentHeader *)buf;
837+
838+ /* extract md5sum */
839+ memcpy(md5sum, ehead->md5sum, sizeof(ehead->md5sum));
840+ memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
841+
842+ g_checksum_reset(vmar->md5csum);
843+ g_checksum_update(vmar->md5csum, buf, VMA_EXTENT_HEADER_SIZE);
844+ gsize csize = 16;
845+ g_checksum_get_digest(vmar->md5csum, ehead->md5sum, &csize);
846+
847+ if (memcmp(md5sum, ehead->md5sum, 16) != 0) {
848+ error_setg(errp, "wrong vma extent header chechsum");
849+ return -1;
850+ }
851+
852+ if (memcmp(h->uuid, ehead->uuid, sizeof(ehead->uuid)) != 0) {
853+ error_setg(errp, "wrong vma extent uuid");
854+ return -1;
855+ }
856+
857+ if (ehead->magic != VMA_EXTENT_MAGIC || ehead->reserved1 != 0) {
858+ error_setg(errp, "wrong vma extent header magic");
859+ return -1;
860+ }
861+
862+ int block_count = GUINT16_FROM_BE(ehead->block_count);
863+ int extent_size = VMA_EXTENT_HEADER_SIZE + block_count*VMA_BLOCK_SIZE;
864+
865+ if (buf_pos < extent_size) {
866+ error_setg(errp, "short vma extent (%d < %d)", buf_pos,
867+ extent_size);
868+ return -1;
869+ }
870+
4244016d
DM
871+ if (restore_extent(vmar, buf, extent_size, vmstate_fd, verbose,
872+ errp) < 0) {
5ad5891c
DM
873+ return -1;
874+ }
875+
876+ if (buf_pos > extent_size) {
877+ memmove(buf, buf + extent_size, buf_pos - extent_size);
878+ buf_pos = buf_pos - extent_size;
879+ } else {
880+ buf_pos = 0;
881+ }
882+ }
883+
884+ bdrv_drain_all();
885+
886+ int i;
887+ for (i = 1; i < 256; i++) {
888+ VmaRestoreState *rstate = &vmar->rstate[i];
889+ if (!rstate->bs) {
890+ continue;
891+ }
892+
893+ if (bdrv_flush(rstate->bs) < 0) {
894+ error_setg(errp, "vma bdrv_flush %s failed",
895+ vmar->devinfo[i].devname);
896+ return -1;
897+ }
898+
899+ if (vmar->devinfo[i].size &&
900+ (strcmp(vmar->devinfo[i].devname, "vmstate") != 0)) {
901+ assert(rstate->bitmap);
902+
903+ int64_t cluster_num, end;
904+
905+ end = (vmar->devinfo[i].size + VMA_CLUSTER_SIZE - 1) /
906+ VMA_CLUSTER_SIZE;
907+
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);
913+ return -1;
914+ }
915+ }
916+ }
917+ }
918+
919+ return ret;
920+}
921+
922diff --git a/vma-writer.c b/vma-writer.c
923new file mode 100644
3f350e0d 924index 0000000..c1e1afe
5ad5891c
DM
925--- /dev/null
926+++ b/vma-writer.c
3f350e0d 927@@ -0,0 +1,920 @@
5ad5891c
DM
928+/*
929+ * VMA: Virtual Machine Archive
930+ *
931+ * Copyright (C) 2012 Proxmox Server Solutions
932+ *
933+ * Authors:
934+ * Dietmar Maurer (dietmar@proxmox.com)
935+ *
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.
938+ *
939+ */
940+
941+#include <stdio.h>
942+#include <errno.h>
943+#include <unistd.h>
944+#include <stdio.h>
945+#include <string.h>
946+#include <sys/types.h>
947+#include <sys/stat.h>
948+#include <fcntl.h>
949+#include <glib.h>
950+#include <uuid/uuid.h>
951+
952+#include "qemu-common.h"
953+#include "qemu_socket.h"
954+#include "qemu-coroutine.h"
955+#include "qemu-aio.h"
956+#include "qemu/ratelimit.h"
957+#include "vma.h"
958+#include "block.h"
3f350e0d 959+#include "monitor.h"
5ad5891c
DM
960+
961+#define DEBUG_VMA 0
962+
963+#define DPRINTF(fmt, ...)\
964+ do { if (DEBUG_VMA) { printf("vma: " fmt, ## __VA_ARGS__); } } while (0)
965+
966+#define WRITE_BUFFERS 5
967+
968+typedef struct VmaAIOCB VmaAIOCB;
969+struct VmaAIOCB {
970+ VmaWriter *vmaw;
971+ unsigned char buffer[VMA_MAX_EXTENT_SIZE];
972+ size_t bytes;
973+ Coroutine *co;
974+};
975+
976+struct VmaWriter {
977+ int fd;
978+ FILE *cmd;
979+ int status;
980+ char errmsg[8192];
981+ uuid_t uuid;
982+ bool header_written;
983+ bool closed;
984+
985+ /* we always write extents */
986+ unsigned char outbuf[VMA_MAX_EXTENT_SIZE];
987+ int outbuf_pos; /* in bytes */
988+ int outbuf_count; /* in VMA_BLOCKS */
989+ uint64_t outbuf_block_info[VMA_BLOCKS_PER_EXTENT];
990+
991+ VmaAIOCB aiocbs[WRITE_BUFFERS];
992+ CoQueue wqueue;
993+
994+ GChecksum *md5csum;
995+ CoMutex writer_lock;
996+ CoMutex flush_lock;
997+ Coroutine *co_writer;
998+ RateLimit limit;
999+ uint64_t delay_ns;
1000+
1001+ /* drive informations */
1002+ VmaStreamInfo stream_info[256];
1003+ guint stream_count;
1004+
1005+ guint8 vmstate_stream;
1006+ uint32_t vmstate_clusters;
1007+
1008+ /* header blob table */
1009+ char *header_blob_table;
1010+ uint32_t header_blob_table_size;
1011+ uint32_t header_blob_table_pos;
1012+
1013+ /* store for config blobs */
1014+ uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1015+ uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
1016+ uint32_t config_count;
1017+};
1018+
1019+void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...)
1020+{
1021+ va_list ap;
1022+
1023+ if (vmaw->status < 0) {
1024+ return;
1025+ }
1026+
1027+ vmaw->status = -1;
1028+
1029+ va_start(ap, fmt);
1030+ g_vsnprintf(vmaw->errmsg, sizeof(vmaw->errmsg), fmt, ap);
1031+ va_end(ap);
1032+
1033+ DPRINTF("vma_writer_set_error: %s\n", vmaw->errmsg);
1034+}
1035+
1036+static uint32_t allocate_header_blob(VmaWriter *vmaw, const char *data,
1037+ size_t len)
1038+{
1039+ if (len > 65535) {
1040+ return 0;
1041+ }
1042+
1043+ if (!vmaw->header_blob_table ||
1044+ (vmaw->header_blob_table_size <
1045+ (vmaw->header_blob_table_pos + len + 2))) {
1046+ int newsize = vmaw->header_blob_table_size + ((len + 2 + 511)/512)*512;
1047+
1048+ vmaw->header_blob_table = g_realloc(vmaw->header_blob_table, newsize);
1049+ memset(vmaw->header_blob_table + vmaw->header_blob_table_size,
1050+ 0, newsize - vmaw->header_blob_table_size);
1051+ vmaw->header_blob_table_size = newsize;
1052+ }
1053+
1054+ uint32_t cpos = vmaw->header_blob_table_pos;
1055+ vmaw->header_blob_table[cpos] = len & 255;
1056+ vmaw->header_blob_table[cpos+1] = (len >> 8) & 255;
1057+ memcpy(vmaw->header_blob_table + cpos + 2, data, len);
1058+ vmaw->header_blob_table_pos += len + 2;
1059+ return cpos;
1060+}
1061+
1062+static uint32_t allocate_header_string(VmaWriter *vmaw, const char *str)
1063+{
1064+ assert(vmaw);
1065+
1066+ size_t len = strlen(str) + 1;
1067+
1068+ return allocate_header_blob(vmaw, str, len);
1069+}
1070+
1071+int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
1072+ gsize len)
1073+{
1074+ assert(vmaw);
1075+ assert(!vmaw->header_written);
1076+ assert(vmaw->config_count < VMA_MAX_CONFIGS);
1077+ assert(name);
1078+ assert(data);
1079+ assert(len);
1080+
1081+ uint32_t name_ptr = allocate_header_string(vmaw, name);
1082+ if (!name_ptr) {
1083+ return -1;
1084+ }
1085+
1086+ uint32_t data_ptr = allocate_header_blob(vmaw, data, len);
1087+ if (!data_ptr) {
1088+ return -1;
1089+ }
1090+
1091+ vmaw->config_names[vmaw->config_count] = name_ptr;
1092+ vmaw->config_data[vmaw->config_count] = data_ptr;
1093+
1094+ vmaw->config_count++;
1095+
1096+ return 0;
1097+}
1098+
1099+int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
1100+ size_t size)
1101+{
1102+ assert(vmaw);
1103+ assert(devname);
1104+ assert(!vmaw->status);
1105+
1106+ if (vmaw->header_written) {
1107+ vma_writer_set_error(vmaw, "vma_writer_register_stream: header "
1108+ "already written");
1109+ return -1;
1110+ }
1111+
1112+ guint n = vmaw->stream_count + 1;
1113+
1114+ /* we can have dev_ids form 1 to 255 (0 reserved)
1115+ * 255(-1) reseverd for safety
1116+ */
1117+ if (n > 254) {
1118+ vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1119+ "too many drives");
1120+ return -1;
1121+ }
1122+
1123+ if (size <= 0) {
1124+ vma_writer_set_error(vmaw, "vma_writer_register_stream: "
1125+ "got strange size %zd", size);
1126+ return -1;
1127+ }
1128+
1129+ DPRINTF("vma_writer_register_stream %s %zu %d\n", devname, size, n);
1130+
1131+ vmaw->stream_info[n].devname = g_strdup(devname);
1132+ vmaw->stream_info[n].size = size;
1133+
1134+ vmaw->stream_info[n].cluster_count = (size + VMA_CLUSTER_SIZE - 1) /
1135+ VMA_CLUSTER_SIZE;
1136+
1137+ vmaw->stream_count = n;
1138+
1139+ if (strcmp(devname, "vmstate") == 0) {
1140+ vmaw->vmstate_stream = n;
1141+ }
1142+
1143+ return n;
1144+}
1145+
1146+static void vma_co_continue_write(void *opaque)
1147+{
1148+ VmaWriter *vmaw = opaque;
1149+
1150+ qemu_aio_set_fd_handler(vmaw->fd, NULL, NULL, NULL, NULL);
1151+
1152+ DPRINTF("vma_co_continue_write\n");
1153+ qemu_coroutine_enter(vmaw->co_writer, NULL);
1154+}
1155+
1156+static ssize_t coroutine_fn
1157+vma_co_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1158+{
1159+ size_t done = 0;
1160+ ssize_t ret;
1161+
1162+ /* atomic writes (we cannot interleave writes) */
1163+ qemu_co_mutex_lock(&vmaw->writer_lock);
1164+
1165+ DPRINTF("vma_co_write enter %zd\n", bytes);
1166+
1167+ while (done < bytes) {
1168+ ret = write(vmaw->fd, buf + done, bytes - done);
1169+ if (ret > 0) {
1170+ done += ret;
1171+ DPRINTF("vma_co_write written %zd %zd\n", done, ret);
1172+ } else if (ret < 0) {
1173+ if (errno == EAGAIN || errno == EWOULDBLOCK) {
1174+ DPRINTF("vma_co_write yield %zd\n", done);
1175+
1176+ vmaw->co_writer = qemu_coroutine_self();
1177+ qemu_aio_set_fd_handler(vmaw->fd, NULL, vma_co_continue_write,
1178+ NULL, vmaw);
1179+
1180+ qemu_coroutine_yield();
1181+ DPRINTF("vma_co_write restart %zd\n", done);
1182+ } else {
1183+ vma_writer_set_error(vmaw, "vma_co_write write error - %s",
1184+ strerror(errno));
1185+ done = -1; /* always return failure for partial writes */
1186+ break;
1187+ }
1188+ } else if (ret == 0) {
1189+ /* should not happen - simply try again */
1190+ }
1191+ }
1192+
1193+ qemu_co_mutex_unlock(&vmaw->writer_lock);
1194+
1195+ DPRINTF("vma_co_write leave %zd\n", done);
1196+ return done;
1197+}
1198+
1199+static void coroutine_fn vma_co_writer_task(void *opaque)
1200+{
1201+ VmaAIOCB *cb = opaque;
1202+
1203+ DPRINTF("vma_co_writer_task start\n");
1204+
1205+ int64_t done = vma_co_write(cb->vmaw, cb->buffer, cb->bytes);
1206+ DPRINTF("vma_co_writer_task write done %zd\n", done);
1207+
1208+ if (done != cb->bytes) {
1209+ DPRINTF("vma_co_writer_task failed write %zd %zd", cb->bytes, done);
1210+ vma_writer_set_error(cb->vmaw, "vma_co_writer_task failed write %zd",
1211+ done);
1212+ }
1213+
1214+ cb->bytes = 0;
1215+
1216+ qemu_co_queue_next(&cb->vmaw->wqueue);
1217+
1218+ DPRINTF("vma_co_writer_task end\n");
1219+}
1220+
1221+static void coroutine_fn vma_queue_flush(VmaWriter *vmaw)
1222+{
1223+ DPRINTF("vma_queue_flush enter\n");
1224+
1225+ assert(vmaw);
1226+
1227+ while (1) {
1228+ int i;
1229+ VmaAIOCB *cb = NULL;
1230+ for (i = 0; i < WRITE_BUFFERS; i++) {
1231+ if (vmaw->aiocbs[i].bytes) {
1232+ cb = &vmaw->aiocbs[i];
1233+ DPRINTF("FOUND USED AIO BUFFER %d %zd\n", i,
1234+ vmaw->aiocbs[i].bytes);
1235+ break;
1236+ }
1237+ }
1238+ if (!cb) {
1239+ break;
1240+ }
1241+ qemu_co_queue_wait(&vmaw->wqueue);
1242+ }
1243+
1244+ DPRINTF("vma_queue_flush leave\n");
1245+}
1246+
1247+/**
1248+ * NOTE: pipe buffer size in only 4096 bytes on linux (see 'ulimit -a')
1249+ * So we need to create a coroutione to allow 'parallel' execution.
1250+ */
1251+static ssize_t coroutine_fn
1252+vma_queue_write(VmaWriter *vmaw, const void *buf, size_t bytes)
1253+{
1254+ DPRINTF("vma_queue_write enter %zd\n", bytes);
1255+
1256+ assert(vmaw);
1257+ assert(buf);
1258+ assert(bytes <= VMA_MAX_EXTENT_SIZE);
1259+
1260+ VmaAIOCB *cb = NULL;
1261+ while (!cb) {
1262+ int i;
1263+ for (i = 0; i < WRITE_BUFFERS; i++) {
1264+ if (!vmaw->aiocbs[i].bytes) {
1265+ cb = &vmaw->aiocbs[i];
1266+ break;
1267+ }
1268+ }
1269+ if (!cb) {
1270+ qemu_co_queue_wait(&vmaw->wqueue);
1271+ }
1272+ }
1273+
1274+ memcpy(cb->buffer, buf, bytes);
1275+ cb->bytes = bytes;
1276+ cb->vmaw = vmaw;
1277+
1278+ DPRINTF("vma_queue_write start %zd\n", bytes);
1279+ cb->co = qemu_coroutine_create(vma_co_writer_task);
1280+ qemu_coroutine_enter(cb->co, cb);
1281+
1282+ DPRINTF("vma_queue_write leave\n");
1283+
1284+ return bytes;
1285+}
1286+
1287+VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, int64_t speed,
1288+ Error **errp)
1289+{
1290+ const char *p;
1291+
1292+ assert(sizeof(VmaHeader) == (4096 + 8192));
1293+ assert(sizeof(VmaExtentHeader) == 512);
1294+
1295+ VmaWriter *vmaw = g_new0(VmaWriter, 1);
1296+ vmaw->fd = -1;
1297+
1298+ vmaw->md5csum = g_checksum_new(G_CHECKSUM_MD5);
1299+ if (!vmaw->md5csum) {
1300+ error_setg(errp, "can't allocate cmsum\n");
1301+ goto err;
1302+ }
1303+
1304+ if (strstart(filename, "exec:", &p)) {
1305+ vmaw->cmd = popen(p, "w");
1306+ if (vmaw->cmd == NULL) {
1307+ error_setg(errp, "can't popen command '%s' - %s\n", p,
1308+ strerror(errno));
1309+ goto err;
1310+ }
1311+ vmaw->fd = fileno(vmaw->cmd);
1312+ socket_set_nonblock(vmaw->fd);
1313+
1314+ } else {
efa8e5de
DM
1315+ struct stat st;
1316+ int oflags;
3f350e0d
DM
1317+ const char *tmp_id_str;
1318+
efa8e5de
DM
1319+ if ((stat(filename, &st) == 0) && S_ISFIFO(st.st_mode)) {
1320+ oflags = O_NONBLOCK|O_WRONLY;
3f350e0d
DM
1321+ vmaw->fd = qemu_open(filename, oflags, 0644);
1322+ } else if (strstart(filename, "/dev/fdset/", &tmp_id_str)) {
1323+ oflags = O_NONBLOCK|O_WRONLY;
1324+ vmaw->fd = qemu_open(filename, oflags, 0644);
1325+ } else if (strstart(filename, "/dev/fdname/", &tmp_id_str)) {
1326+ vmaw->fd = monitor_get_fd(cur_mon, tmp_id_str, errp);
1327+ if (vmaw->fd < 0) {
1328+ goto err;
1329+ }
1330+ } else {
efa8e5de 1331+ oflags = O_NONBLOCK|O_WRONLY|O_CREAT|O_EXCL;
3f350e0d 1332+ vmaw->fd = qemu_open(filename, oflags, 0644);
efa8e5de 1333+ }
3f350e0d 1334+
5ad5891c
DM
1335+ if (vmaw->fd < 0) {
1336+ error_setg(errp, "can't open file %s - %s\n", filename,
1337+ strerror(errno));
1338+ goto err;
1339+ }
1340+ }
1341+
1342+ vmaw->outbuf_count = 0;
1343+ vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1344+
1345+ vmaw->header_blob_table_pos = 1; /* start at pos 1 */
1346+
1347+ qemu_co_mutex_init(&vmaw->writer_lock);
1348+ qemu_co_mutex_init(&vmaw->flush_lock);
1349+ qemu_co_queue_init(&vmaw->wqueue);
1350+
1351+ uuid_copy(vmaw->uuid, uuid);
1352+
1353+ if (speed <= 0) {
1354+ speed = 10*1024*1024*1024LLU; /* default 10GB/s */
1355+ }
1356+
1357+ ratelimit_set_speed(&vmaw->limit, speed, 100000000ULL /* 0.1 sec */);
1358+
1359+ return vmaw;
1360+
1361+err:
1362+ if (vmaw) {
1363+ if (vmaw->cmd) {
1364+ pclose(vmaw->cmd);
1365+ } else if (vmaw->fd >= 0) {
1366+ close(vmaw->fd);
1367+ }
1368+
1369+ if (vmaw->md5csum) {
1370+ g_checksum_free(vmaw->md5csum);
1371+ }
1372+
1373+ g_free(vmaw);
1374+ }
1375+
1376+ return NULL;
1377+}
1378+
1379+static int coroutine_fn vma_write_header(VmaWriter *vmaw)
1380+{
1381+ assert(vmaw);
1382+ int header_clusters = 8;
1383+ char buf[65536*header_clusters];
1384+ VmaHeader *head = (VmaHeader *)buf;
1385+
1386+ int i;
1387+
1388+ DPRINTF("VMA WRITE HEADER\n");
1389+
1390+ if (vmaw->status < 0) {
1391+ return vmaw->status;
1392+ }
1393+
1394+ memset(buf, 0, sizeof(buf));
1395+
1396+ head->magic = VMA_MAGIC;
1397+ head->version = GUINT32_TO_BE(1); /* v1 */
1398+ memcpy(head->uuid, vmaw->uuid, 16);
1399+
1400+ time_t ctime = time(NULL);
1401+ head->ctime = GUINT64_TO_BE(ctime);
1402+
1403+ if (!vmaw->stream_count) {
1404+ return -1;
1405+ }
1406+
1407+ for (i = 0; i < VMA_MAX_CONFIGS; i++) {
1408+ head->config_names[i] = GUINT32_TO_BE(vmaw->config_names[i]);
1409+ head->config_data[i] = GUINT32_TO_BE(vmaw->config_data[i]);
1410+ }
1411+
1412+ /* 32 bytes per device (12 used currently) = 8192 bytes max */
1413+ for (i = 1; i <= 254; i++) {
1414+ VmaStreamInfo *si = &vmaw->stream_info[i];
1415+ if (si->size) {
1416+ assert(si->devname);
1417+ uint32_t devname_ptr = allocate_header_string(vmaw, si->devname);
1418+ if (!devname_ptr) {
1419+ return -1;
1420+ }
1421+ head->dev_info[i].devname_ptr = GUINT32_TO_BE(devname_ptr);
1422+ head->dev_info[i].size = GUINT64_TO_BE(si->size);
1423+ }
1424+ }
1425+
1426+ uint32_t header_size = sizeof(VmaHeader) + vmaw->header_blob_table_size;
1427+ head->header_size = GUINT32_TO_BE(header_size);
1428+
1429+ if (header_size > sizeof(buf)) {
1430+ return -1; /* just to be sure */
1431+ }
1432+
1433+ uint32_t blob_buffer_offset = sizeof(VmaHeader);
1434+ memcpy(buf + blob_buffer_offset, vmaw->header_blob_table,
1435+ vmaw->header_blob_table_size);
1436+ head->blob_buffer_offset = GUINT32_TO_BE(blob_buffer_offset);
1437+ head->blob_buffer_size = GUINT32_TO_BE(vmaw->header_blob_table_pos);
1438+
1439+ g_checksum_reset(vmaw->md5csum);
1440+ g_checksum_update(vmaw->md5csum, (const guchar *)buf, header_size);
1441+ gsize csize = 16;
1442+ g_checksum_get_digest(vmaw->md5csum, (guint8 *)(head->md5sum), &csize);
1443+
1444+ return vma_queue_write(vmaw, buf, header_size);
1445+}
1446+
1447+static int coroutine_fn vma_writer_flush(VmaWriter *vmaw)
1448+{
1449+ assert(vmaw);
1450+
1451+ int ret;
1452+ int i;
1453+
1454+ if (vmaw->status < 0) {
1455+ return vmaw->status;
1456+ }
1457+
1458+ if (!vmaw->header_written) {
1459+ vmaw->header_written = true;
1460+ ret = vma_write_header(vmaw);
1461+ if (ret < 0) {
1462+ vma_writer_set_error(vmaw, "vma_writer_flush: write header failed");
1463+ return ret;
1464+ }
1465+ }
1466+
1467+ DPRINTF("VMA WRITE FLUSH %d %d\n", vmaw->outbuf_count, vmaw->outbuf_pos);
1468+
1469+
1470+ VmaExtentHeader *ehead = (VmaExtentHeader *)vmaw->outbuf;
1471+
1472+ ehead->magic = VMA_EXTENT_MAGIC;
1473+ ehead->reserved1 = 0;
1474+
1475+ for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1476+ ehead->blockinfo[i] = GUINT64_TO_BE(vmaw->outbuf_block_info[i]);
1477+ }
1478+
1479+ guint16 block_count = (vmaw->outbuf_pos - VMA_EXTENT_HEADER_SIZE) /
1480+ VMA_BLOCK_SIZE;
1481+
1482+ ehead->block_count = GUINT16_TO_BE(block_count);
1483+
1484+ memcpy(ehead->uuid, vmaw->uuid, sizeof(ehead->uuid));
1485+ memset(ehead->md5sum, 0, sizeof(ehead->md5sum));
1486+
1487+ g_checksum_reset(vmaw->md5csum);
1488+ g_checksum_update(vmaw->md5csum, vmaw->outbuf, VMA_EXTENT_HEADER_SIZE);
1489+ gsize csize = 16;
1490+ g_checksum_get_digest(vmaw->md5csum, ehead->md5sum, &csize);
1491+
1492+ int bytes = vmaw->outbuf_pos;
1493+ ret = vma_queue_write(vmaw, vmaw->outbuf, bytes);
1494+ if (ret != bytes) {
1495+ vma_writer_set_error(vmaw, "vma_writer_flush: failed write");
1496+ }
1497+
1498+ vmaw->outbuf_count = 0;
1499+ vmaw->outbuf_pos = VMA_EXTENT_HEADER_SIZE;
1500+
1501+ for (i = 0; i < VMA_BLOCKS_PER_EXTENT; i++) {
1502+ vmaw->outbuf_block_info[i] = 0;
1503+ }
1504+
1505+ return vmaw->status;
1506+}
1507+
1508+static int vma_count_open_streams(VmaWriter *vmaw)
1509+{
1510+ g_assert(vmaw != NULL);
1511+
1512+ int i;
1513+ int open_drives = 0;
1514+ for (i = 0; i <= 255; i++) {
1515+ if (vmaw->stream_info[i].size && !vmaw->stream_info[i].finished) {
1516+ open_drives++;
1517+ }
1518+ }
1519+
1520+ return open_drives;
1521+}
1522+
1523+/**
1524+ * all jobs should call this when there is no more data
1525+ * Returns: number of remaining stream (0 ==> finished)
1526+ */
1527+int coroutine_fn
1528+vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id)
1529+{
1530+ g_assert(vmaw != NULL);
1531+
1532+ DPRINTF("vma_writer_set_status %d\n", dev_id);
1533+ if (!vmaw->stream_info[dev_id].size) {
1534+ vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1535+ "no such stream %d", dev_id);
1536+ return -1;
1537+ }
1538+ if (vmaw->stream_info[dev_id].finished) {
1539+ vma_writer_set_error(vmaw, "vma_writer_close_stream: "
1540+ "stream already closed %d", dev_id);
1541+ return -1;
1542+ }
1543+
1544+ vmaw->stream_info[dev_id].finished = true;
1545+
1546+ int open_drives = vma_count_open_streams(vmaw);
1547+
1548+ if (open_drives <= 0) {
1549+ DPRINTF("vma_writer_set_status all drives completed\n");
1550+ qemu_co_mutex_lock(&vmaw->flush_lock);
1551+ int ret = vma_writer_flush(vmaw);
1552+ qemu_co_mutex_unlock(&vmaw->flush_lock);
1553+ if (ret < 0) {
1554+ vma_writer_set_error(vmaw, "vma_writer_close_stream: flush failed");
1555+ }
1556+ }
1557+
1558+ return open_drives;
1559+}
1560+
1561+int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status)
1562+{
1563+ int i;
1564+
1565+ g_assert(vmaw != NULL);
1566+
1567+ if (status) {
1568+ status->status = vmaw->status;
1569+ g_strlcpy(status->errmsg, vmaw->errmsg, sizeof(status->errmsg));
1570+ for (i = 0; i <= 255; i++) {
1571+ status->stream_info[i] = vmaw->stream_info[i];
1572+ }
1573+
1574+ uuid_unparse_lower(vmaw->uuid, status->uuid_str);
1575+ }
1576+
1577+ status->closed = vmaw->closed;
1578+
1579+ return vmaw->status;
1580+}
1581+
1582+static int vma_writer_get_buffer(VmaWriter *vmaw)
1583+{
1584+
1585+ /* wait until buffer is available */
1586+ while (vmaw->outbuf_count >= (VMA_BLOCKS_PER_EXTENT - 1)) {
1587+ int res = 0;
1588+
1589+ qemu_co_mutex_lock(&vmaw->flush_lock);
1590+ res = vma_writer_flush(vmaw);
1591+ qemu_co_mutex_unlock(&vmaw->flush_lock);
1592+
1593+ if (res < 0) {
1594+ vma_writer_set_error(vmaw, "vma_writer_get_buffer: flush failed");
1595+ return -1;
1596+ }
1597+ }
1598+
1599+ return 0;
1600+}
1601+
1602+
1603+int64_t coroutine_fn
1604+vma_writer_write(VmaWriter *vmaw, uint8_t dev_id, int64_t cluster_num,
1605+ unsigned char *buf, size_t *zero_bytes)
1606+{
1607+ g_assert(vmaw != NULL);
1608+ g_assert(zero_bytes != NULL);
1609+
1610+ *zero_bytes = 0;
1611+
1612+ if (vmaw->status < 0) {
1613+ return vmaw->status;
1614+ }
1615+
1616+ if (!dev_id || !vmaw->stream_info[dev_id].size) {
1617+ vma_writer_set_error(vmaw, "vma_writer_write: "
1618+ "no such stream %d", dev_id);
1619+ return -1;
1620+ }
1621+
1622+ if (vmaw->stream_info[dev_id].finished) {
1623+ vma_writer_set_error(vmaw, "vma_writer_write: "
1624+ "stream already closed %d", dev_id);
1625+ return -1;
1626+ }
1627+
1628+
1629+ if (cluster_num >= (((uint64_t)1)<<32)) {
1630+ vma_writer_set_error(vmaw, "vma_writer_write: "
1631+ "cluster number out of range");
1632+ return -1;
1633+ }
1634+
1635+ if (dev_id == vmaw->vmstate_stream) {
1636+ if (cluster_num != vmaw->vmstate_clusters) {
1637+ vma_writer_set_error(vmaw, "vma_writer_write: "
1638+ "non sequential vmstate write");
1639+ }
1640+ vmaw->vmstate_clusters++;
1641+ } else if (cluster_num >= vmaw->stream_info[dev_id].cluster_count) {
1642+ vma_writer_set_error(vmaw, "vma_writer_write: cluster number too big");
1643+ return -1;
1644+ }
1645+
1646+ /* wait until buffer is available */
1647+ if (vma_writer_get_buffer(vmaw) < 0) {
1648+ vma_writer_set_error(vmaw, "vma_writer_write: "
1649+ "vma_writer_get_buffer failed");
1650+ return -1;
1651+ }
1652+
1653+ DPRINTF("VMA WRITE %zd\n", cluster_num);
1654+
1655+ int i;
1656+ int bit = 1;
1657+ uint16_t mask = 0;
1658+ for (i = 0; i < 16; i++) {
1659+ unsigned char *vmablock = buf + (i*VMA_BLOCK_SIZE);
1660+ if (buffer_is_zero(vmablock, VMA_BLOCK_SIZE)) {
1661+ DPRINTF("VMA WRITE %zd ZERO BLOCK %d\n", cluster_num, i);
1662+ vmaw->stream_info[dev_id].zero_bytes += VMA_BLOCK_SIZE;
1663+ *zero_bytes += VMA_BLOCK_SIZE;
1664+ } else {
1665+ mask |= bit;
1666+ memcpy(vmaw->outbuf + vmaw->outbuf_pos, vmablock, VMA_BLOCK_SIZE);
1667+ vmaw->outbuf_pos += VMA_BLOCK_SIZE;
1668+
1669+ vmaw->delay_ns = ratelimit_calculate_delay(&vmaw->limit,
1670+ VMA_BLOCK_SIZE);
1671+ if (vmaw->delay_ns) {
1672+ co_sleep_ns(rt_clock, vmaw->delay_ns);
1673+ }
1674+ }
1675+
1676+ bit = bit << 1;
1677+ }
1678+
1679+ uint64_t block_info = ((uint64_t)mask) << (32+16);
1680+ block_info |= ((uint64_t)dev_id) << 32;
1681+ block_info |= (cluster_num & 0xffffffff);
1682+ vmaw->outbuf_block_info[vmaw->outbuf_count] = block_info;
1683+
1684+ DPRINTF("VMA WRITE MASK %zd %zx\n", cluster_num, block_info);
1685+
1686+ vmaw->outbuf_count++;
1687+
1688+ /** NOTE: We allways write whole clusters, but we correctly set
1689+ * transferred bytes. So transferred == size when when everything
1690+ * went OK.
1691+ */
1692+ size_t transferred = VMA_CLUSTER_SIZE;
1693+
1694+ if (dev_id != vmaw->vmstate_stream) {
1695+ uint64_t last = (cluster_num + 1) * VMA_CLUSTER_SIZE;
1696+ if (last > vmaw->stream_info[dev_id].size) {
1697+ uint64_t diff = last - vmaw->stream_info[dev_id].size;
1698+ if (diff >= VMA_CLUSTER_SIZE) {
1699+ vma_writer_set_error(vmaw, "vma_writer_write: "
1700+ "read after last cluster");
1701+ return -1;
1702+ }
1703+ transferred -= diff;
1704+ }
1705+ }
1706+
1707+ vmaw->stream_info[dev_id].transferred += transferred;
1708+
1709+ return transferred;
1710+}
1711+
1712+int vma_writer_close(VmaWriter *vmaw, Error **errp)
1713+{
1714+ g_assert(vmaw != NULL);
1715+
1716+ int i;
1717+
1718+ vma_queue_flush(vmaw);
1719+
1720+ /* this should not happen - just to be sure */
1721+ while (!qemu_co_queue_empty(&vmaw->wqueue)) {
1722+ DPRINTF("vma_writer_close wait\n");
1723+ co_sleep_ns(rt_clock, 1000000);
1724+ }
1725+
1726+ if (vmaw->cmd) {
1727+ if (pclose(vmaw->cmd) < 0) {
1728+ vma_writer_set_error(vmaw, "vma_writer_close: "
1729+ "pclose failed - %s", strerror(errno));
1730+ }
1731+ } else {
1732+ if (close(vmaw->fd) < 0) {
1733+ vma_writer_set_error(vmaw, "vma_writer_close: "
1734+ "close failed - %s", strerror(errno));
1735+ }
1736+ }
1737+
1738+ for (i = 0; i <= 255; i++) {
1739+ VmaStreamInfo *si = &vmaw->stream_info[i];
1740+ if (si->size) {
1741+ if (!si->finished) {
1742+ vma_writer_set_error(vmaw, "vma_writer_close: "
1743+ "detected open stream '%s'", si->devname);
1744+ } else if ((si->transferred != si->size) &&
1745+ (i != vmaw->vmstate_stream)) {
1746+ vma_writer_set_error(vmaw, "vma_writer_close: "
1747+ "incomplete stream '%s' (%zd != %zd)",
1748+ si->devname, si->transferred, si->size);
1749+ }
1750+ }
1751+ }
1752+
1753+ for (i = 0; i <= 255; i++) {
1754+ vmaw->stream_info[i].finished = 1; /* mark as closed */
1755+ }
1756+
1757+ vmaw->closed = 1;
1758+
1759+ if (vmaw->status < 0 && *errp == NULL) {
1760+ error_setg(errp, "%s", vmaw->errmsg);
1761+ }
1762+
1763+ return vmaw->status;
1764+}
1765+
1766+void vma_writer_destroy(VmaWriter *vmaw)
1767+{
1768+ assert(vmaw);
1769+
1770+ int i;
1771+
1772+ for (i = 0; i <= 255; i++) {
1773+ if (vmaw->stream_info[i].devname) {
1774+ g_free(vmaw->stream_info[i].devname);
1775+ }
1776+ }
1777+
1778+ if (vmaw->md5csum) {
1779+ g_checksum_free(vmaw->md5csum);
1780+ }
1781+
1782+ g_free(vmaw);
1783+}
1784+
1785+/* backup driver plugin */
1786+
1787+static int vma_dump_cb(void *opaque, uint8_t dev_id, int64_t cluster_num,
1788+ unsigned char *buf, size_t *zero_bytes)
1789+{
1790+ VmaWriter *vmaw = opaque;
1791+
1792+ return vma_writer_write(vmaw, dev_id, cluster_num, buf, zero_bytes);
1793+}
1794+
1795+static int vma_close_cb(void *opaque, Error **errp)
1796+{
1797+ VmaWriter *vmaw = opaque;
1798+
1799+ int res = vma_writer_close(vmaw, errp);
1800+ vma_writer_destroy(vmaw);
1801+
1802+ return res;
1803+}
1804+
1805+static int vma_complete_cb(void *opaque, uint8_t dev_id, int ret)
1806+{
1807+ VmaWriter *vmaw = opaque;
1808+
1809+ if (ret < 0) {
1810+ vma_writer_set_error(vmaw, "backup_complete_cb %d", ret);
1811+ }
1812+
1813+ return vma_writer_close_stream(vmaw, dev_id);
1814+}
1815+
1816+static int vma_register_stream_cb(void *opaque, const char *devname,
1817+ size_t size)
1818+{
1819+ VmaWriter *vmaw = opaque;
1820+
1821+ return vma_writer_register_stream(vmaw, devname, size);
1822+}
1823+
1824+static int vma_register_config_cb(void *opaque, const char *name,
1825+ gpointer data, size_t data_len)
1826+{
1827+ VmaWriter *vmaw = opaque;
1828+
1829+ return vma_writer_add_config(vmaw, name, data, data_len);
1830+}
1831+
1832+static void *vma_open_cb(const char *filename, uuid_t uuid, int64_t speed,
1833+ Error **errp)
1834+{
1835+ return vma_writer_create(filename, uuid, speed, errp);
1836+}
1837+
1838+const BackupDriver backup_vma_driver = {
1839+ .format = "vma",
1840+ .open_cb = vma_open_cb,
1841+ .close_cb = vma_close_cb,
1842+ .register_config_cb = vma_register_config_cb,
1843+ .register_stream_cb = vma_register_stream_cb,
1844+ .dump_cb = vma_dump_cb,
1845+ .complete_cb = vma_complete_cb,
1846+};
1847+
1848diff --git a/vma.c b/vma.c
1849new file mode 100644
9de54cd3 1850index 0000000..d50a312
5ad5891c
DM
1851--- /dev/null
1852+++ b/vma.c
4244016d 1853@@ -0,0 +1,558 @@
5ad5891c
DM
1854+/*
1855+ * VMA: Virtual Machine Archive
1856+ *
1857+ * Copyright (C) 2012 Proxmox Server Solutions
1858+ *
1859+ * Authors:
1860+ * Dietmar Maurer (dietmar@proxmox.com)
1861+ *
1862+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
1863+ * See the COPYING file in the top-level directory.
1864+ *
1865+ */
1866+
1867+#include <stdio.h>
1868+#include <errno.h>
1869+#include <unistd.h>
1870+#include <stdio.h>
1871+#include <string.h>
1872+#include <sys/types.h>
1873+#include <sys/stat.h>
1874+#include <fcntl.h>
1875+#include <glib.h>
1876+
1877+#include "qemu-common.h"
1878+#include "qemu-option.h"
1879+#include "qemu-error.h"
1880+#include "osdep.h"
1881+#include "sysemu.h"
1882+#include "block_int.h"
1883+#include <stdio.h>
1884+#include "vma.h"
1885+
1886+static void help(void)
1887+{
1888+ const char *help_msg =
1889+ "usage: vma command [command options]\n"
1890+ "\n"
1891+ "vma list <filename>\n"
1892+ "vma create <filename> [-c config] <archive> pathname ...\n"
1893+ "vma extract <filename> [-r] <targetdir>\n"
1894+ ;
1895+
1896+ printf("%s", help_msg);
1897+ exit(1);
1898+}
1899+
1900+static const char *extract_devname(const char *path, char **devname, int index)
1901+{
1902+ assert(path);
1903+
1904+ const char *sep = strchr(path, '=');
1905+
1906+ if (sep) {
1907+ *devname = g_strndup(path, sep - path);
1908+ path = sep + 1;
1909+ } else {
1910+ if (index >= 0) {
1911+ *devname = g_strdup_printf("disk%d", index);
1912+ } else {
1913+ *devname = NULL;
1914+ }
1915+ }
1916+
1917+ return path;
1918+}
1919+
1920+static void print_content(VmaReader *vmar)
1921+{
1922+ assert(vmar);
1923+
1924+ VmaHeader *head = vma_reader_get_header(vmar);
1925+
5ad5891c
DM
1926+ GList *l = vma_reader_get_config_data(vmar);
1927+ while (l && l->data) {
1928+ VmaConfigData *cdata = (VmaConfigData *)l->data;
1929+ l = g_list_next(l);
1930+ printf("CFG: size: %d name: %s\n", cdata->len, cdata->name);
1931+ }
1932+
1933+ int i;
1934+ VmaDeviceInfo *di;
1935+ for (i = 1; i < 255; i++) {
1936+ di = vma_reader_get_device_info(vmar, i);
1937+ if (di) {
1938+ if (strcmp(di->devname, "vmstate") == 0) {
1939+ printf("VMSTATE: dev_id=%d memory: %zd\n", i, di->size);
1940+ } else {
1941+ printf("DEV: dev_id=%d size: %zd devname: %s\n",
1942+ i, di->size, di->devname);
1943+ }
1944+ }
1945+ }
d95c8c31
DM
1946+ /* ctime is the last entry we print */
1947+ printf("CTIME: %s", ctime(&head->ctime));
1948+ fflush(stdout);
5ad5891c
DM
1949+}
1950+
1951+static int list_content(int argc, char **argv)
1952+{
1953+ int c, ret = 0;
1954+ const char *filename;
1955+
1956+ for (;;) {
1957+ c = getopt(argc, argv, "h");
1958+ if (c == -1) {
1959+ break;
1960+ }
1961+ switch (c) {
1962+ case '?':
1963+ case 'h':
1964+ help();
1965+ break;
1966+ default:
1967+ g_assert_not_reached();
1968+ }
1969+ }
1970+
1971+ /* Get the filename */
1972+ if ((optind + 1) != argc) {
1973+ help();
1974+ }
1975+ filename = argv[optind++];
1976+
1977+ Error *errp = NULL;
1978+ VmaReader *vmar = vma_reader_create(filename, &errp);
1979+
1980+ if (!vmar) {
1981+ g_error("%s", error_get_pretty(errp));
1982+ }
1983+
1984+ print_content(vmar);
1985+
1986+ vma_reader_destroy(vmar);
1987+
1988+ return ret;
1989+}
1990+
1991+typedef struct RestoreMap {
1992+ char *devname;
1993+ char *path;
1994+ bool write_zero;
1995+} RestoreMap;
1996+
1997+static int extract_content(int argc, char **argv)
1998+{
1999+ int c, ret = 0;
4244016d 2000+ int verbose = 0;
5ad5891c
DM
2001+ const char *filename;
2002+ const char *dirname;
3f350e0d 2003+ const char *readmap = NULL;
5ad5891c
DM
2004+
2005+ for (;;) {
4244016d 2006+ c = getopt(argc, argv, "hvr:");
5ad5891c
DM
2007+ if (c == -1) {
2008+ break;
2009+ }
2010+ switch (c) {
2011+ case '?':
2012+ case 'h':
2013+ help();
2014+ break;
2015+ case 'r':
3f350e0d 2016+ readmap = optarg;
5ad5891c 2017+ break;
4244016d
DM
2018+ case 'v':
2019+ verbose = 1;
2020+ break;
5ad5891c
DM
2021+ default:
2022+ help();
2023+ }
2024+ }
2025+
2026+ /* Get the filename */
2027+ if ((optind + 2) != argc) {
2028+ help();
2029+ }
2030+ filename = argv[optind++];
2031+ dirname = argv[optind++];
2032+
2033+ Error *errp = NULL;
2034+ VmaReader *vmar = vma_reader_create(filename, &errp);
2035+
2036+ if (!vmar) {
2037+ g_error("%s", error_get_pretty(errp));
2038+ }
2039+
2040+ if (mkdir(dirname, 0777) < 0) {
2041+ g_error("unable to create target directory %s - %s",
2042+ dirname, strerror(errno));
2043+ }
2044+
2045+ GList *l = vma_reader_get_config_data(vmar);
2046+ while (l && l->data) {
2047+ VmaConfigData *cdata = (VmaConfigData *)l->data;
2048+ l = g_list_next(l);
2049+ char *cfgfn = g_strdup_printf("%s/%s", dirname, cdata->name);
2050+ GError *err = NULL;
2051+ if (!g_file_set_contents(cfgfn, (gchar *)cdata->data, cdata->len,
2052+ &err)) {
3f350e0d 2053+ g_error("unable to write file: %s", err->message);
5ad5891c
DM
2054+ }
2055+ }
2056+
2057+ GHashTable *devmap = g_hash_table_new(g_str_hash, g_str_equal);
2058+
2059+ if (readmap) {
2060+ print_content(vmar);
2061+
3f350e0d
DM
2062+ FILE *map = fopen(readmap, "r");
2063+ if (!map) {
2064+ g_error("unable to open fifo %s - %s", readmap, strerror(errno));
2065+ }
2066+
5ad5891c
DM
2067+ while (1) {
2068+ char inbuf[8192];
3f350e0d 2069+ char *line = fgets(inbuf, sizeof(inbuf), map);
5ad5891c
DM
2070+ if (!line || line[0] == '\0' || !strcmp(line, "done\n")) {
2071+ break;
2072+ }
2073+ int len = strlen(line);
2074+ if (line[len - 1] == '\n') {
2075+ line[len - 1] = '\0';
2076+ if (len == 1) {
2077+ break;
2078+ }
2079+ }
2080+
2081+ const char *path;
2082+ bool write_zero;
2083+ if (line[0] == '0' && line[1] == ':') {
2084+ path = inbuf + 2;
2085+ write_zero = false;
2086+ } else if (line[0] == '1' && line[1] == ':') {
2087+ path = inbuf + 2;
2088+ write_zero = true;
3f350e0d 2089+ } else {
5ad5891c
DM
2090+ g_error("read map failed - parse error ('%s')", inbuf);
2091+ }
2092+
2093+ char *devname = NULL;
2094+ path = extract_devname(path, &devname, -1);
2095+ if (!devname) {
2096+ g_error("read map failed - no dev name specified ('%s')",
2097+ inbuf);
2098+ }
2099+
5ad5891c
DM
2100+ RestoreMap *map = g_new0(RestoreMap, 1);
2101+ map->devname = g_strdup(devname);
2102+ map->path = g_strdup(path);
2103+ map->write_zero = write_zero;
2104+
2105+ g_hash_table_insert(devmap, map->devname, map);
2106+
2107+ };
2108+ }
2109+
2110+ int i;
2111+ int vmstate_fd = -1;
2112+ guint8 vmstate_stream = 0;
2113+
2114+ for (i = 1; i < 255; i++) {
2115+ VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2116+ if (di && (strcmp(di->devname, "vmstate") == 0)) {
2117+ vmstate_stream = i;
2118+ char *statefn = g_strdup_printf("%s/vmstate.bin", dirname);
2119+ vmstate_fd = open(statefn, O_WRONLY|O_CREAT|O_EXCL, 0644);
2120+ if (vmstate_fd < 0) {
2121+ g_error("create vmstate file '%s' failed - %s", statefn,
2122+ strerror(errno));
2123+ }
2124+ g_free(statefn);
2125+ } else if (di) {
2126+ char *devfn = NULL;
2127+ int flags = BDRV_O_RDWR|BDRV_O_CACHE_WB;
2128+ bool write_zero = true;
2129+
2130+ if (readmap) {
2131+ RestoreMap *map;
2132+ map = (RestoreMap *)g_hash_table_lookup(devmap, di->devname);
2133+ if (map == NULL) {
2134+ g_error("no device name mapping for %s", di->devname);
2135+ }
2136+ devfn = map->path;
2137+ write_zero = map->write_zero;
2138+ } else {
2139+ devfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2140+ dirname, di->devname);
2141+ printf("DEVINFO %s %zd\n", devfn, di->size);
2142+
2143+ if (bdrv_img_create(devfn, "raw", NULL, NULL, NULL,
2144+ di->size, flags)) {
2145+ g_error("can't create file %s", devfn);
2146+ }
2147+
2148+ /* Note: we created an empty file above, so there is no
2149+ * need to write zeroes (so we generate a sparse file)
2150+ */
2151+ write_zero = false;
2152+ }
2153+
9de54cd3
DM
2154+ BlockDriverState *bs = bdrv_new(di->devname);
2155+ if (bdrv_open(bs, devfn, flags, NULL)) {
5ad5891c
DM
2156+ g_error("can't open file %s", devfn);
2157+ }
2158+ if (vma_reader_register_bs(vmar, i, bs, write_zero, &errp) < 0) {
2159+ g_error("%s", error_get_pretty(errp));
2160+ }
2161+
2162+ if (!readmap) {
2163+ g_free(devfn);
2164+ }
2165+ }
2166+ }
2167+
4244016d 2168+ if (vma_reader_restore(vmar, vmstate_fd, verbose, &errp) < 0) {
5ad5891c
DM
2169+ g_error("restore failed - %s", error_get_pretty(errp));
2170+ }
2171+
2172+ if (!readmap) {
2173+ for (i = 1; i < 255; i++) {
2174+ VmaDeviceInfo *di = vma_reader_get_device_info(vmar, i);
2175+ if (di && (i != vmstate_stream)) {
2176+ char *tmpfn = g_strdup_printf("%s/tmp-disk-%s.raw",
2177+ dirname, di->devname);
2178+ char *fn = g_strdup_printf("%s/disk-%s.raw",
2179+ dirname, di->devname);
2180+ if (rename(tmpfn, fn) != 0) {
2181+ g_error("rename %s to %s failed - %s",
2182+ tmpfn, fn, strerror(errno));
2183+ }
2184+ }
2185+ }
2186+ }
2187+
2188+ vma_reader_destroy(vmar);
2189+
2190+ bdrv_close_all();
2191+
2192+ return ret;
2193+}
2194+
2195+typedef struct BackupCB {
2196+ VmaWriter *vmaw;
2197+ uint8_t dev_id;
2198+} BackupCB;
2199+
2200+static int backup_dump_cb(void *opaque, BlockDriverState *bs,
2201+ int64_t cluster_num, unsigned char *buf)
2202+{
2203+ BackupCB *bcb = opaque;
2204+ size_t zb = 0;
2205+ if (vma_writer_write(bcb->vmaw, bcb->dev_id, cluster_num, buf, &zb) < 0) {
2206+ g_warning("backup_dump_cb vma_writer_write failed");
2207+ return -1;
2208+ }
2209+
2210+ return 0;
2211+}
2212+
2213+static void backup_complete_cb(void *opaque, int ret)
2214+{
2215+ BackupCB *bcb = opaque;
2216+
2217+ if (ret < 0) {
2218+ vma_writer_set_error(bcb->vmaw, "backup_complete_cb %d", ret);
2219+ }
2220+
2221+ if (vma_writer_close_stream(bcb->vmaw, bcb->dev_id) <= 0) {
2222+ Error *err = NULL;
2223+ if (vma_writer_close(bcb->vmaw, &err) != 0) {
2224+ g_warning("vma_writer_close failed %s", error_get_pretty(err));
2225+ }
2226+ }
2227+}
2228+
2229+static int create_archive(int argc, char **argv)
2230+{
2231+ int i, c, res;
2232+ int verbose = 0;
2233+ const char *archivename;
2234+ GList *config_files = NULL;
2235+
2236+ for (;;) {
2237+ c = getopt(argc, argv, "hvc:");
2238+ if (c == -1) {
2239+ break;
2240+ }
2241+ switch (c) {
2242+ case '?':
2243+ case 'h':
2244+ help();
2245+ break;
2246+ case 'c':
2247+ config_files = g_list_append(config_files, optarg);
2248+ break;
2249+ case 'v':
2250+ verbose = 1;
2251+ break;
2252+ default:
2253+ g_assert_not_reached();
2254+ }
2255+ }
2256+
2257+
2258+ /* make sure we have archive name and at least one path */
2259+ if ((optind + 2) > argc) {
2260+ help();
2261+ }
2262+
2263+ archivename = argv[optind++];
2264+
2265+ uuid_t uuid;
2266+ uuid_generate(uuid);
2267+
2268+ Error *local_err = NULL;
2269+ VmaWriter *vmaw = vma_writer_create(archivename, uuid, 0, &local_err);
2270+
2271+ if (vmaw == NULL) {
2272+ g_error("%s", error_get_pretty(local_err));
2273+ }
2274+
2275+ GList *l = config_files;
2276+ while (l && l->data) {
2277+ char *name = l->data;
2278+ char *cdata = NULL;
2279+ gsize clen = 0;
2280+ GError *err = NULL;
2281+ if (!g_file_get_contents(name, &cdata, &clen, &err)) {
2282+ unlink(archivename);
2283+ g_error("Unable to read file: %s", err->message);
2284+ }
2285+
2286+ if (vma_writer_add_config(vmaw, name, cdata, clen) != 0) {
2287+ unlink(archivename);
2288+ g_error("Unable to append config data %s (len = %zd)",
2289+ name, clen);
2290+ }
2291+ l = g_list_next(l);
2292+ }
2293+
2294+ int ind = 0;
2295+ while (optind < argc) {
2296+ const char *path = argv[optind++];
2297+ char *devname = NULL;
2298+ path = extract_devname(path, &devname, ind++);
2299+
2300+ BlockDriver *drv = NULL;
2301+ BlockDriverState *bs = bdrv_new(devname);
2302+
2303+ res = bdrv_open(bs, path, BDRV_O_CACHE_WB , drv);
2304+ if (res < 0) {
2305+ unlink(archivename);
2306+ g_error("bdrv_open '%s' failed", path);
2307+ }
2308+ int64_t size = bdrv_getlength(bs);
2309+ int dev_id = vma_writer_register_stream(vmaw, devname, size);
2310+ if (dev_id <= 0) {
2311+ unlink(archivename);
2312+ g_error("vma_writer_register_stream '%s' failed", devname);
2313+ }
2314+
2315+ BackupCB *bcb = g_new0(BackupCB, 1);
2316+ bcb->vmaw = vmaw;
2317+ bcb->dev_id = dev_id;
2318+
2319+ if (backup_job_start(bs, backup_dump_cb, backup_complete_cb, bcb) < 0) {
2320+ unlink(archivename);
2321+ g_error("backup_job_start failed");
2322+ }
2323+ }
2324+
2325+ VmaStatus vmastat;
2326+ int percent = 0;
2327+ int last_percent = -1;
2328+
2329+ while (1) {
2330+ main_loop_wait(false);
2331+ vma_writer_get_status(vmaw, &vmastat);
2332+
2333+ if (verbose) {
2334+
2335+ uint64_t total = 0;
2336+ uint64_t transferred = 0;
2337+ uint64_t zero_bytes = 0;
2338+
2339+ int i;
2340+ for (i = 0; i < 256; i++) {
2341+ if (vmastat.stream_info[i].size) {
2342+ total += vmastat.stream_info[i].size;
2343+ transferred += vmastat.stream_info[i].transferred;
2344+ zero_bytes += vmastat.stream_info[i].zero_bytes;
2345+ }
2346+ }
2347+ percent = (transferred*100)/total;
2348+ if (percent != last_percent) {
2349+ printf("progress %d%% %zd/%zd %zd\n", percent,
2350+ transferred, total, zero_bytes);
2351+
2352+ last_percent = percent;
2353+ }
2354+ }
2355+
2356+ if (vmastat.closed) {
2357+ break;
2358+ }
2359+ }
2360+
2361+ bdrv_drain_all();
2362+
2363+ vma_writer_get_status(vmaw, &vmastat);
2364+
2365+ if (verbose) {
2366+ for (i = 0; i < 256; i++) {
2367+ VmaStreamInfo *si = &vmastat.stream_info[i];
2368+ if (si->size) {
2369+ printf("image %s: size=%zd zeros=%zd saved=%zd\n", si->devname,
2370+ si->size, si->zero_bytes, si->size - si->zero_bytes);
2371+ }
2372+ }
2373+ }
2374+
2375+ if (vmastat.status < 0) {
2376+ unlink(archivename);
2377+ g_error("creating vma archive failed");
2378+ }
2379+
2380+ return 0;
2381+}
2382+
2383+int main(int argc, char **argv)
2384+{
2385+ const char *cmdname;
2386+
2387+ error_set_progname(argv[0]);
2388+
2389+ qemu_init_main_loop();
2390+
2391+ bdrv_init();
2392+
2393+ if (argc < 2) {
2394+ help();
2395+ }
2396+
2397+ cmdname = argv[1];
2398+ argc--; argv++;
2399+
2400+
2401+ if (!strcmp(cmdname, "list")) {
2402+ return list_content(argc, argv);
2403+ } else if (!strcmp(cmdname, "create")) {
2404+ return create_archive(argc, argv);
2405+ } else if (!strcmp(cmdname, "extract")) {
2406+ return extract_content(argc, argv);
2407+ }
2408+
2409+ help();
2410+ return 0;
2411+}
2412diff --git a/vma.h b/vma.h
2413new file mode 100644
4244016d 2414index 0000000..f30a2bc
5ad5891c
DM
2415--- /dev/null
2416+++ b/vma.h
4244016d 2417@@ -0,0 +1,146 @@
5ad5891c
DM
2418+/*
2419+ * VMA: Virtual Machine Archive
2420+ *
2421+ * Copyright (C) Proxmox Server Solutions
2422+ *
2423+ * Authors:
2424+ * Dietmar Maurer (dietmar@proxmox.com)
2425+ *
2426+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
2427+ * See the COPYING file in the top-level directory.
2428+ *
2429+ */
2430+
2431+#ifndef BACKUP_VMA_H
2432+#define BACKUP_VMA_H
2433+
2434+#include "backup.h"
2435+#include "error.h"
2436+
2437+#define VMA_BLOCK_BITS 12
2438+#define VMA_BLOCK_SIZE (1<<VMA_BLOCK_BITS)
2439+#define VMA_CLUSTER_BITS (VMA_BLOCK_BITS+4)
2440+#define VMA_CLUSTER_SIZE (1<<VMA_CLUSTER_BITS)
2441+
2442+#if VMA_CLUSTER_SIZE != 65536
2443+#error unexpected cluster size
2444+#endif
2445+
2446+#define VMA_EXTENT_HEADER_SIZE 512
2447+#define VMA_BLOCKS_PER_EXTENT 59
2448+#define VMA_MAX_CONFIGS 256
2449+
2450+#define VMA_MAX_EXTENT_SIZE \
2451+ (VMA_EXTENT_HEADER_SIZE+VMA_CLUSTER_SIZE*VMA_BLOCKS_PER_EXTENT)
2452+#if VMA_MAX_EXTENT_SIZE != 3867136
2453+#error unexpected VMA_EXTENT_SIZE
2454+#endif
2455+
2456+/* File Format Definitions */
2457+
2458+#define VMA_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|0x00))
2459+#define VMA_EXTENT_MAGIC (GUINT32_TO_BE(('V'<<24)|('M'<<16)|('A'<<8)|'E'))
2460+
2461+typedef struct VmaDeviceInfoHeader {
2462+ uint32_t devname_ptr; /* offset into blob_buffer table */
2463+ uint32_t reserved0;
2464+ uint64_t size; /* device size in bytes */
2465+ uint64_t reserved1;
2466+ uint64_t reserved2;
2467+} VmaDeviceInfoHeader;
2468+
2469+typedef struct VmaHeader {
2470+ uint32_t magic;
2471+ uint32_t version;
2472+ unsigned char uuid[16];
2473+ int64_t ctime;
2474+ unsigned char md5sum[16];
2475+
2476+ uint32_t blob_buffer_offset;
2477+ uint32_t blob_buffer_size;
2478+ uint32_t header_size;
2479+
2480+ unsigned char reserved[1984];
2481+
2482+ uint32_t config_names[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2483+ uint32_t config_data[VMA_MAX_CONFIGS]; /* offset into blob_buffer table */
2484+
2485+ VmaDeviceInfoHeader dev_info[256];
2486+} VmaHeader;
2487+
2488+typedef struct VmaExtentHeader {
2489+ uint32_t magic;
2490+ uint16_t reserved1;
2491+ uint16_t block_count;
2492+ unsigned char uuid[16];
2493+ unsigned char md5sum[16];
2494+ uint64_t blockinfo[VMA_BLOCKS_PER_EXTENT];
2495+} VmaExtentHeader;
2496+
2497+/* functions/definitions to read/write vma files */
2498+
2499+typedef struct VmaReader VmaReader;
2500+
2501+typedef struct VmaWriter VmaWriter;
2502+
2503+typedef struct VmaConfigData {
2504+ const char *name;
2505+ const void *data;
2506+ uint32_t len;
2507+} VmaConfigData;
2508+
2509+typedef struct VmaStreamInfo {
2510+ uint64_t size;
2511+ uint64_t cluster_count;
2512+ uint64_t transferred;
2513+ uint64_t zero_bytes;
2514+ int finished;
2515+ char *devname;
2516+} VmaStreamInfo;
2517+
2518+typedef struct VmaStatus {
2519+ int status;
2520+ bool closed;
2521+ char errmsg[8192];
2522+ char uuid_str[37];
2523+ VmaStreamInfo stream_info[256];
2524+} VmaStatus;
2525+
2526+typedef struct VmaDeviceInfo {
2527+ uint64_t size; /* device size in bytes */
2528+ const char *devname;
2529+} VmaDeviceInfo;
2530+
2531+extern const BackupDriver backup_vma_driver;
2532+
2533+VmaWriter *vma_writer_create(const char *filename, uuid_t uuid, int64_t speed,
2534+ Error **errp);
2535+int vma_writer_close(VmaWriter *vmaw, Error **errp);
2536+void vma_writer_destroy(VmaWriter *vmaw);
2537+int vma_writer_add_config(VmaWriter *vmaw, const char *name, gpointer data,
2538+ size_t len);
2539+int vma_writer_register_stream(VmaWriter *vmaw, const char *devname,
2540+ size_t size);
2541+
2542+int64_t coroutine_fn vma_writer_write(VmaWriter *vmaw, uint8_t dev_id,
2543+ int64_t cluster_num, unsigned char *buf,
2544+ size_t *zero_bytes);
2545+
2546+int coroutine_fn vma_writer_close_stream(VmaWriter *vmaw, uint8_t dev_id);
2547+
2548+int vma_writer_get_status(VmaWriter *vmaw, VmaStatus *status);
2549+void vma_writer_set_error(VmaWriter *vmaw, const char *fmt, ...);
2550+
2551+
2552+VmaReader *vma_reader_create(const char *filename, Error **errp);
2553+void vma_reader_destroy(VmaReader *vmar);
2554+VmaHeader *vma_reader_get_header(VmaReader *vmar);
2555+GList *vma_reader_get_config_data(VmaReader *vmar);
2556+VmaDeviceInfo *vma_reader_get_device_info(VmaReader *vmar, guint8 dev_id);
2557+int vma_reader_register_bs(VmaReader *vmar, guint8 dev_id,
2558+ BlockDriverState *bs, bool write_zeroes,
2559+ Error **errp);
4244016d
DM
2560+int vma_reader_restore(VmaReader *vmar, int vmstate_fd, bool verbose,
2561+ Error **errp);
5ad5891c
DM
2562+
2563+#endif /* BACKUP_VMA_H */
2564--
25651.7.2.5
2566