diff mbox

[v2,5/9] block: vhdx - break endian translation functions out

Message ID b621422e46c48e62b7065d02be87f3a8e529d665.1375325971.git.jcody@redhat.com
State New
Headers show

Commit Message

Jeff Cody Aug. 1, 2013, 3:23 a.m. UTC 
This moves the endian translation functions out from the vhdx.c source,
into a separate source file. In addition to the previously defined
endian functions, new endian translation functions for log support are
added as well.

Signed-off-by: Jeff Cody <jcody@redhat.com>
---
 block/Makefile.objs |   2 +-
 block/vhdx-endian.c | 141 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 block/vhdx.c        |  43 ----------------
 block/vhdx.h        |  13 +++++
 4 files changed, 155 insertions(+), 44 deletions(-)
 create mode 100644 block/vhdx-endian.c

Comments

Stefan Hajnoczi Aug. 1, 2013, 3:03 p.m. UTC | #1 
On Wed, Jul 31, 2013 at 11:23:50PM -0400, Jeff Cody wrote:
> diff --git a/block/vhdx.h b/block/vhdx.h
> index 2db6615..5e0a1d3 100644
> --- a/block/vhdx.h
> +++ b/block/vhdx.h
> @@ -398,4 +398,17 @@ static inline void cpu_to_leguids(MSGUID *guid)
>      cpu_to_le16s(&guid->data3);
>  }
>  
> +void vhdx_header_le_import(VHDXHeader *h);
> +void vhdx_header_le_export(VHDXHeader *orig_h, VHDXHeader *new_h);
> +void vhdx_log_desc_le_import(VHDXLogDescriptor *d);
> +void vhdx_log_desc_le_export(VHDXLogDescriptor *d);
> +void vhdx_log_data_le_export(VHDXLogDataSector *d);
> +void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr);
> +void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr);
> +
> +
> +
> +
> +
> +
>  #endif

You are a generous man when it comes to newlines!
Jeff Cody Aug. 1, 2013, 3:14 p.m. UTC | #2 
On Thu, Aug 01, 2013 at 05:03:39PM +0200, Stefan Hajnoczi wrote:
> On Wed, Jul 31, 2013 at 11:23:50PM -0400, Jeff Cody wrote:
> > diff --git a/block/vhdx.h b/block/vhdx.h
> > index 2db6615..5e0a1d3 100644
> > --- a/block/vhdx.h
> > +++ b/block/vhdx.h
> > @@ -398,4 +398,17 @@ static inline void cpu_to_leguids(MSGUID *guid)
> >      cpu_to_le16s(&guid->data3);
> >  }
> >  
> > +void vhdx_header_le_import(VHDXHeader *h);
> > +void vhdx_header_le_export(VHDXHeader *orig_h, VHDXHeader *new_h);
> > +void vhdx_log_desc_le_import(VHDXLogDescriptor *d);
> > +void vhdx_log_desc_le_export(VHDXLogDescriptor *d);
> > +void vhdx_log_data_le_export(VHDXLogDataSector *d);
> > +void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr);
> > +void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr);
> > +
> > +
> > +
> > +
> > +
> > +
> >  #endif
> 
> You are a generous man when it comes to newlines!

Thanks!










-Jeff
Kevin Wolf Aug. 7, 2013, 3:29 p.m. UTC | #3 
Am 01.08.2013 um 05:23 hat Jeff Cody geschrieben:
> This moves the endian translation functions out from the vhdx.c source,
> into a separate source file. In addition to the previously defined
> endian functions, new endian translation functions for log support are
> added as well.
> 
> Signed-off-by: Jeff Cody <jcody@redhat.com>

> +void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr)
> +{
> +    assert(hdr != NULL);
> +
> +    le32_to_cpus(&hdr->signature);
> +    le32_to_cpus(&hdr->checksum);
> +    le32_to_cpus(&hdr->entry_length);
> +    le32_to_cpus(&hdr->tail);
> +    le64_to_cpus(&hdr->sequence_number);
> +    le32_to_cpus(&hdr->descriptor_count);
> +    leguid_to_cpus(&hdr->log_guid);
> +    le64_to_cpus(&hdr->flushed_file_offset);
> +    le64_to_cpus(&hdr->last_file_offset);
> +}
> +
> +void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr)
> +{
> +    assert(hdr != NULL);
> +
> +    cpu_to_le32s(&hdr->signature);
> +    cpu_to_le32s(&hdr->checksum);
> +    cpu_to_le32s(&hdr->entry_length);
> +    cpu_to_le32s(&hdr->tail);
> +    cpu_to_le64s(&hdr->sequence_number);
> +    cpu_to_le32s(&hdr->descriptor_count);
> +    cpu_to_le64s(&hdr->flushed_file_offset);
> +    cpu_to_le64s(&hdr->last_file_offset);
> +    cpu_to_leguids(&hdr->log_guid);
> +}

Almost as critical as Stefan's comment: Can you keep the order of fields
consistent between import and export?

Kevin
Jeff Cody Aug. 7, 2013, 5:21 p.m. UTC | #4 
On Wed, Aug 07, 2013 at 05:29:04PM +0200, Kevin Wolf wrote:
> Am 01.08.2013 um 05:23 hat Jeff Cody geschrieben:
> > This moves the endian translation functions out from the vhdx.c source,
> > into a separate source file. In addition to the previously defined
> > endian functions, new endian translation functions for log support are
> > added as well.
> > 
> > Signed-off-by: Jeff Cody <jcody@redhat.com>
> 
> > +void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr)
> > +{
> > +    assert(hdr != NULL);
> > +
> > +    le32_to_cpus(&hdr->signature);
> > +    le32_to_cpus(&hdr->checksum);
> > +    le32_to_cpus(&hdr->entry_length);
> > +    le32_to_cpus(&hdr->tail);
> > +    le64_to_cpus(&hdr->sequence_number);
> > +    le32_to_cpus(&hdr->descriptor_count);
> > +    leguid_to_cpus(&hdr->log_guid);
> > +    le64_to_cpus(&hdr->flushed_file_offset);
> > +    le64_to_cpus(&hdr->last_file_offset);
> > +}
> > +
> > +void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr)
> > +{
> > +    assert(hdr != NULL);
> > +
> > +    cpu_to_le32s(&hdr->signature);
> > +    cpu_to_le32s(&hdr->checksum);
> > +    cpu_to_le32s(&hdr->entry_length);
> > +    cpu_to_le32s(&hdr->tail);
> > +    cpu_to_le64s(&hdr->sequence_number);
> > +    cpu_to_le32s(&hdr->descriptor_count);
> > +    cpu_to_le64s(&hdr->flushed_file_offset);
> > +    cpu_to_le64s(&hdr->last_file_offset);
> > +    cpu_to_leguids(&hdr->log_guid);
> > +}
> 
> Almost as critical as Stefan's comment: Can you keep the order of fields
> consistent between import and export?
> 

Absolutely! :)
diff mbox

Patch

diff --git a/block/Makefile.objs b/block/Makefile.objs
index e5e54e6..e6f5d33 100644
--- a/block/Makefile.objs
+++ b/block/Makefile.objs
@@ -2,7 +2,7 @@  block-obj-y += raw.o cow.o qcow.o vdi.o vmdk.o cloop.o dmg.o bochs.o vpc.o vvfat
 block-obj-y += qcow2.o qcow2-refcount.o qcow2-cluster.o qcow2-snapshot.o qcow2-cache.o
 block-obj-y += qed.o qed-gencb.o qed-l2-cache.o qed-table.o qed-cluster.o
 block-obj-y += qed-check.o
-block-obj-$(CONFIG_VHDX) += vhdx.o
+block-obj-$(CONFIG_VHDX) += vhdx.o vhdx-endian.o
 block-obj-y += parallels.o blkdebug.o blkverify.o
 block-obj-y += snapshot.o qapi.o
 block-obj-$(CONFIG_WIN32) += raw-win32.o win32-aio.o
diff --git a/block/vhdx-endian.c b/block/vhdx-endian.c
new file mode 100644
index 0000000..f7a59c5
--- /dev/null
+++ b/block/vhdx-endian.c
@@ -0,0 +1,141 @@ 
+/*
+ * Block driver for Hyper-V VHDX Images
+ *
+ * Copyright (c) 2013 Red Hat, Inc.,
+ *
+ * Authors:
+ *  Jeff Cody <jcody@redhat.com>
+ *
+ *  This is based on the "VHDX Format Specification v1.00", published 8/25/2012
+ *  by Microsoft:
+ *      https://www.microsoft.com/en-us/download/details.aspx?id=34750
+ *
+ * This work is licensed under the terms of the GNU LGPL, version 2 or later.
+ * See the COPYING.LIB file in the top-level directory.
+ *
+ */
+
+#include "qemu-common.h"
+#include "block/block_int.h"
+#include "block/vhdx.h"
+
+#include <uuid/uuid.h>
+
+
+/*
+ * All the VHDX formats on disk are little endian - the following
+ * are helper import/export functions to correctly convert
+ * endianness from disk read to native cpu format, and back again.
+ */
+
+
+/* VHDX File Header */
+
+
+void vhdx_header_le_import(VHDXHeader *h)
+{
+    assert(h != NULL);
+
+    le32_to_cpus(&h->signature);
+    le32_to_cpus(&h->checksum);
+    le64_to_cpus(&h->sequence_number);
+
+    leguid_to_cpus(&h->file_write_guid);
+    leguid_to_cpus(&h->data_write_guid);
+    leguid_to_cpus(&h->log_guid);
+
+    le16_to_cpus(&h->log_version);
+    le16_to_cpus(&h->version);
+    le32_to_cpus(&h->log_length);
+    le64_to_cpus(&h->log_offset);
+}
+
+void vhdx_header_le_export(VHDXHeader *orig_h, VHDXHeader *new_h)
+{
+    assert(orig_h != NULL);
+    assert(new_h != NULL);
+
+    new_h->signature       = cpu_to_le32(orig_h->signature);
+    new_h->checksum        = cpu_to_le32(orig_h->checksum);
+    new_h->sequence_number = cpu_to_le64(orig_h->sequence_number);
+
+    memcpy(&new_h->file_write_guid, &orig_h->file_write_guid, sizeof(MSGUID));
+    memcpy(&new_h->data_write_guid, &orig_h->data_write_guid, sizeof(MSGUID));
+    memcpy(&new_h->log_guid,        &orig_h->log_guid,        sizeof(MSGUID));
+
+    cpu_to_leguids(&new_h->file_write_guid);
+    cpu_to_leguids(&new_h->data_write_guid);
+    cpu_to_leguids(&new_h->log_guid);
+
+    new_h->log_version     = cpu_to_le16(orig_h->log_version);
+    new_h->version         = cpu_to_le16(orig_h->version);
+    new_h->log_length      = cpu_to_le32(orig_h->log_length);
+    new_h->log_offset      = cpu_to_le64(orig_h->log_offset);
+}
+
+
+/* VHDX Log Headers */
+
+
+void vhdx_log_desc_le_import(VHDXLogDescriptor *d)
+{
+    assert(d != NULL);
+
+    le32_to_cpus(&d->signature);
+    le32_to_cpus(&d->trailing_bytes);
+    le64_to_cpus(&d->leading_bytes);
+    le64_to_cpus(&d->file_offset);
+    le64_to_cpus(&d->sequence_number);
+}
+
+void vhdx_log_desc_le_export(VHDXLogDescriptor *d)
+{
+    assert(d != NULL);
+
+    cpu_to_le32s(&d->signature);
+    cpu_to_le32s(&d->trailing_bytes);
+    cpu_to_le64s(&d->leading_bytes);
+    cpu_to_le64s(&d->file_offset);
+    cpu_to_le64s(&d->sequence_number);
+}
+
+void vhdx_log_data_le_export(VHDXLogDataSector *d)
+{
+    assert(d != NULL);
+
+    cpu_to_le32s(&d->data_signature);
+    cpu_to_le32s(&d->sequence_high);
+    cpu_to_le32s(&d->sequence_low);
+}
+
+void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr)
+{
+    assert(hdr != NULL);
+
+    le32_to_cpus(&hdr->signature);
+    le32_to_cpus(&hdr->checksum);
+    le32_to_cpus(&hdr->entry_length);
+    le32_to_cpus(&hdr->tail);
+    le64_to_cpus(&hdr->sequence_number);
+    le32_to_cpus(&hdr->descriptor_count);
+    leguid_to_cpus(&hdr->log_guid);
+    le64_to_cpus(&hdr->flushed_file_offset);
+    le64_to_cpus(&hdr->last_file_offset);
+}
+
+void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr)
+{
+    assert(hdr != NULL);
+
+    cpu_to_le32s(&hdr->signature);
+    cpu_to_le32s(&hdr->checksum);
+    cpu_to_le32s(&hdr->entry_length);
+    cpu_to_le32s(&hdr->tail);
+    cpu_to_le64s(&hdr->sequence_number);
+    cpu_to_le32s(&hdr->descriptor_count);
+    cpu_to_le64s(&hdr->flushed_file_offset);
+    cpu_to_le64s(&hdr->last_file_offset);
+    cpu_to_leguids(&hdr->log_guid);
+}
+
+
diff --git a/block/vhdx.c b/block/vhdx.c
index 57223d5..9802b74 100644
--- a/block/vhdx.c
+++ b/block/vhdx.c
@@ -227,49 +227,6 @@  static int vhdx_probe(const uint8_t *buf, int buf_size, const char *filename)
     return 0;
 }
 
-/* All VHDX structures on disk are little endian */
-static void vhdx_header_le_import(VHDXHeader *h)
-{
-    assert(h != NULL);
-
-    le32_to_cpus(&h->signature);
-    le32_to_cpus(&h->checksum);
-    le64_to_cpus(&h->sequence_number);
-
-    leguid_to_cpus(&h->file_write_guid);
-    leguid_to_cpus(&h->data_write_guid);
-    leguid_to_cpus(&h->log_guid);
-
-    le16_to_cpus(&h->log_version);
-    le16_to_cpus(&h->version);
-    le32_to_cpus(&h->log_length);
-    le64_to_cpus(&h->log_offset);
-}
-
-/* All VHDX structures on disk are little endian */
-static void vhdx_header_le_export(VHDXHeader *orig_h, VHDXHeader *new_h)
-{
-    assert(orig_h != NULL);
-    assert(new_h != NULL);
-
-    new_h->signature       = cpu_to_le32(orig_h->signature);
-    new_h->checksum        = cpu_to_le32(orig_h->checksum);
-    new_h->sequence_number = cpu_to_le64(orig_h->sequence_number);
-
-    memcpy(&new_h->file_write_guid, &orig_h->file_write_guid, sizeof(MSGUID));
-    memcpy(&new_h->data_write_guid, &orig_h->data_write_guid, sizeof(MSGUID));
-    memcpy(&new_h->log_guid,        &orig_h->log_guid,        sizeof(MSGUID));
-
-    cpu_to_leguids(&new_h->file_write_guid);
-    cpu_to_leguids(&new_h->data_write_guid);
-    cpu_to_leguids(&new_h->log_guid);
-
-    new_h->log_version     = cpu_to_le16(orig_h->log_version);
-    new_h->version         = cpu_to_le16(orig_h->version);
-    new_h->log_length      = cpu_to_le32(orig_h->log_length);
-    new_h->log_offset      = cpu_to_le64(orig_h->log_offset);
-}
-
 /* Update the VHDX headers
  *
  * This follows the VHDX spec procedures for header updates.
diff --git a/block/vhdx.h b/block/vhdx.h
index 2db6615..5e0a1d3 100644
--- a/block/vhdx.h
+++ b/block/vhdx.h
@@ -398,4 +398,17 @@  static inline void cpu_to_leguids(MSGUID *guid)
     cpu_to_le16s(&guid->data3);
 }
 
+void vhdx_header_le_import(VHDXHeader *h);
+void vhdx_header_le_export(VHDXHeader *orig_h, VHDXHeader *new_h);
+void vhdx_log_desc_le_import(VHDXLogDescriptor *d);
+void vhdx_log_desc_le_export(VHDXLogDescriptor *d);
+void vhdx_log_data_le_export(VHDXLogDataSector *d);
+void vhdx_log_entry_hdr_le_import(VHDXLogEntryHeader *hdr);
+void vhdx_log_entry_hdr_le_export(VHDXLogEntryHeader *hdr);
+
+
+
+
+
+
 #endif