[v2] scripts/qcow2-to-stdout.py: Add script to write qcow2 images to stdout

This tool converts a disk image to qcow2, writing the result directly
to stdout. This can be used for example to send the generated file
over the network.

This is equivalent to using qemu-img to convert a file to qcow2 and
then writing the result to stdout, with the difference that this tool
does not need to create this temporary qcow2 file and therefore does
not need any additional disk space.

Implementing this directly in qemu-img is not really an option because
it expects the output file to be seekable and it is also meant to be a
generic tool that supports all combinations of file formats and image
options. Instead, this tool can only produce qcow2 files with the
basic options, without compression, encryption or other features.

The input file is read twice. The first pass is used to determine
which clusters contain non-zero data and that information is used to
create the qcow2 header, refcount table and blocks, and L1 and L2
tables. After all that metadata is created then the second pass is
used to write the guest data.

By default qcow2-to-stdout.py expects the input to be a raw file, but
if qemu-storage-daemon is available then it can also be used to read
images in other formats. Alternatively the user can also run qemu-ndb
or qemu-storage-daemon manually instead.

Signed-off-by: Alberto Garcia <berto@igalia.com>
Signed-off-by: Madeeha Javed <javed@igalia.com>
---
 scripts/qcow2-to-stdout.py | 377 +++++++++++++++++++++++++++++++++++++
 1 file changed, 377 insertions(+)
 create mode 100755 scripts/qcow2-to-stdout.py

v2:
- Define the QCOW2_V3_HDR_LENGTH and QCOW2_FEATURE_NAME_TABLE constants [Manos]
- Define the QEMU_STORAGE_DAEMON constant
- Use isfile() instead of exists() for the input file
- Refuse to write to stdout if it's a tty [Manos]
- Move the bulk of the code to a function called from __main__ [Manos]
- Remove the qcow2_ prefix from qcow2_cluster_size and qcow2_refcount_bits
- Formatting fixes suggested by the Python black formatter [Manos]
- On error pass the string directly to sys.exit()
- Capture the output of qemu-storage-daemon [Manos]
- Use a contextmanager to run qemu-storage-daemon [Manos]
- Update patch description to mention why this cannot be implemeted directly in qemu-img [Manos]

v1: https://lists.gnu.org/archive/html/qemu-block/2024-06/msg00073.html

ping

On Mon, Jul 01, 2024 at 05:11:40PM +0200, Alberto Garcia wrote:
> This tool converts a disk image to qcow2, writing the result directly
> to stdout. This can be used for example to send the generated file
> over the network.

On Mon, 01 Jul 2024 18:11, Alberto Garcia <berto@igalia.com> wrote:
>This tool converts a disk image to qcow2, writing the result directly
>to stdout. This can be used for example to send the generated file
>over the network.
>
>This is equivalent to using qemu-img to convert a file to qcow2 and
>then writing the result to stdout, with the difference that this tool
>does not need to create this temporary qcow2 file and therefore does
>not need any additional disk space.
>
>Implementing this directly in qemu-img is not really an option because
>it expects the output file to be seekable and it is also meant to be a
>generic tool that supports all combinations of file formats and image
>options. Instead, this tool can only produce qcow2 files with the
>basic options, without compression, encryption or other features.
>
>The input file is read twice. The first pass is used to determine
>which clusters contain non-zero data and that information is used to
>create the qcow2 header, refcount table and blocks, and L1 and L2
>tables. After all that metadata is created then the second pass is
>used to write the guest data.
>
>By default qcow2-to-stdout.py expects the input to be a raw file, but
>if qemu-storage-daemon is available then it can also be used to read
>images in other formats. Alternatively the user can also run qemu-ndb
>or qemu-storage-daemon manually instead.
>
>Signed-off-by: Alberto Garcia <berto@igalia.com>
>Signed-off-by: Madeeha Javed <javed@igalia.com>
>---
> scripts/qcow2-to-stdout.py | 377 +++++++++++++++++++++++++++++++++++++
> 1 file changed, 377 insertions(+)
> create mode 100755 scripts/qcow2-to-stdout.py
>
>v2:
>- Define the QCOW2_V3_HDR_LENGTH and QCOW2_FEATURE_NAME_TABLE constants [Manos]
>- Define the QEMU_STORAGE_DAEMON constant
>- Use isfile() instead of exists() for the input file
>- Refuse to write to stdout if it's a tty [Manos]
>- Move the bulk of the code to a function called from __main__ [Manos]
>- Remove the qcow2_ prefix from qcow2_cluster_size and qcow2_refcount_bits
>- Formatting fixes suggested by the Python black formatter [Manos]
>- On error pass the string directly to sys.exit()
>- Capture the output of qemu-storage-daemon [Manos]
>- Use a contextmanager to run qemu-storage-daemon [Manos]
>- Update patch description to mention why this cannot be implemeted directly in qemu-img [Manos]
>
>v1: https://lists.gnu.org/archive/html/qemu-block/2024-06/msg00073.html
>
>diff --git a/scripts/qcow2-to-stdout.py b/scripts/qcow2-to-stdout.py
>new file mode 100755
>index 0000000000..d486a80e86
>--- /dev/null
>+++ b/scripts/qcow2-to-stdout.py
>@@ -0,0 +1,377 @@
>+#!/usr/bin/env python3
>+
>+# This tool reads a disk image in any format and converts it to qcow2,
>+# writing the result directly to stdout.
>+#
>+# Copyright (C) 2024 Igalia, S.L.
>+#
>+# Authors: Alberto Garcia <berto@igalia.com>
>+#          Madeeha Javed <javed@igalia.com>
>+#
>+# SPDX-License-Identifier: GPL-2.0-or-later
>+#
>+# qcow2 files produced by this script are always arranged like this:
>+#
>+# - qcow2 header
>+# - refcount table
>+# - refcount blocks
>+# - L1 table
>+# - L2 tables
>+# - Data clusters
>+#
>+# A note about variable names: in qcow2 there is one refcount table
>+# and one (active) L1 table, although each can occupy several
>+# clusters. For the sake of simplicity the code sometimes talks about
>+# refcount tables and L1 tables when referring to those clusters.
>+
>+import argparse
>+import atexit
>+import math
>+import os
>+import signal
>+import struct
>+import subprocess
>+import sys
>+import tempfile
>+import time
>+from contextlib import contextmanager
>+
>+QCOW2_DEFAULT_CLUSTER_SIZE = 65536
>+QCOW2_DEFAULT_REFCOUNT_BITS = 16
>+QCOW2_DEFAULT_VERSION = 3
>+QCOW2_FEATURE_NAME_TABLE = 0x6803F857
>+QCOW2_V3_HEADER_LENGTH = 112  # Header length in QEMU 9.0. Must be a multiple of 8
>+QCOW_OFLAG_COPIED = 1 << 63
>+QEMU_STORAGE_DAEMON = "qemu-storage-daemon"
>+
>+
>+def bitmap_set(bitmap, idx):
>+    bitmap[int(idx / 8)] |= 1 << (idx % 8)
>+
>+
>+def bitmap_test(bitmap, idx):
>+    return (bitmap[int(idx / 8)] & (1 << (idx % 8))) != 0
>+
>+
>+# create_qcow2_file() expects a raw input file. If we have a different
>+# format we can use qemu-storage-daemon to make it appear as raw.
>+@contextmanager
>+def get_input_as_raw_file(input_file, input_format):
>+    if input_format == "raw":
>+        yield input_file
>+        return
>+    try:
>+        temp_dir = tempfile.mkdtemp()
>+        pid_file = temp_dir + "/pid"
>+        raw_file = temp_dir + "/raw"
>+        open(raw_file, "wb").close()
>+        ret = subprocess.run(
>+            [
>+                QEMU_STORAGE_DAEMON,
>+                "--daemonize",
>+                "--pidfile", pid_file,
>+                "--blockdev", f"driver=file,node-name=file0,driver=file,filename={input_file},read-only=on",
>+                "--blockdev", f"driver={input_format},node-name=disk0,file=file0,read-only=on",
>+                "--export", f"type=fuse,id=export0,node-name=disk0,mountpoint={raw_file},writable=off",
>+            ],
>+            capture_output=True,
>+        )
>+        if ret.returncode != 0:
>+            sys.exit("[Error] Could not start the qemu-storage-daemon:\n" +
>+                     ret.stderr.decode().rstrip('\n'))
>+        yield raw_file
>+    finally:
>+        # Kill the storage daemon on exit
>+        # and remove all temporary files
>+        if os.path.exists(pid_file):
>+            with open(pid_file, "r") as f:
>+                pid = int(f.readline())
>+            os.kill(pid, signal.SIGTERM)
>+            while os.path.exists(pid_file):
>+                time.sleep(0.1)
>+        os.unlink(raw_file)
>+        os.rmdir(temp_dir)
>+
>+
>+def write_features(cluster, offset):
>+    qcow2_features = [
>+        # Incompatible
>+        (0, 0, "dirty bit"),
>+        (0, 1, "corrupt bit"),
>+        (0, 2, "external data file"),
>+        (0, 3, "compression type"),
>+        (0, 4, "extended L2 entries"),
>+        # Compatible
>+        (1, 0, "lazy refcounts"),
>+        # Autoclear
>+        (2, 0, "bitmaps"),
>+        (2, 1, "raw external data"),
>+    ]
>+    struct.pack_into(">I", cluster, offset, QCOW2_FEATURE_NAME_TABLE)
>+    struct.pack_into(">I", cluster, offset + 4, len(qcow2_features) * 48)
>+    offset += 8
>+    for feature_type, feature_bit, feature_name in qcow2_features:
>+        struct.pack_into(">BB46s", cluster, offset,
>+                         feature_type, feature_bit, feature_name.encode("ascii"))
>+        offset += 48
>+
>+
>+def create_qcow2_file(input_file, cluster_size, refcount_bits, qcow2_version):
>+    # Some basic values
>+    l1_entries_per_table = int(cluster_size / 8)
>+    l2_entries_per_table = int(cluster_size / 8)
>+    refcounts_per_table  = int(cluster_size / 8)
>+    refcounts_per_block  = int(cluster_size * 8 / refcount_bits)
>+
>+    # Virtual disk size, number of data clusters and L1 entries
>+    disk_size = math.ceil(os.path.getsize(input_file) / 512) * 512 # Round up to the nearest multiple of 512
>+    total_data_clusters = math.ceil(disk_size / cluster_size)
>+    l1_entries = math.ceil(total_data_clusters / l2_entries_per_table)
>+    allocated_l1_tables = math.ceil(l1_entries / l1_entries_per_table)
>+
>+    # Max L1 table size is 32 MB (QCOW_MAX_L1_SIZE in block/qcow2.h)
>+    if (l1_entries * 8) > (32 * 1024 * 1024):
>+        sys.exit("[Error] The image size is too large. Try using a larger cluster size.")
>+
>+    # Two bitmaps indicating which L1 and L2 entries are set
>+    l1_bitmap = bytearray(int(allocated_l1_tables * l1_entries_per_table / 8))
>+    l2_bitmap = bytearray(int(allocated_l1_tables * l1_entries_per_table * l2_entries_per_table / 8))
>+    allocated_l2_tables = 0
>+    allocated_data_clusters = 0
>+    with open(input_file, "rb") as reader:
>+        zero_cluster = bytes(cluster_size)
>+        # Read all clusters from the input file
>+        for idx in range(total_data_clusters):
>+            cluster = reader.read(cluster_size)
>+            # If the last cluster is smaller than cluster_size pad it with zeroes
>+            if len(cluster) < cluster_size:
>+                cluster += bytes(cluster_size - len(cluster))
>+            # If a cluster has non-zero data then it must be allocated
>+            # in the output file and its L2 entry must be set
>+            if cluster != zero_cluster:
>+                bitmap_set(l2_bitmap, idx)
>+                allocated_data_clusters += 1
>+                # Allocated data clusters also need their corresponding L1 entry and L2 table
>+                l1_idx = math.floor(idx / l2_entries_per_table)
>+                if not bitmap_test(l1_bitmap, l1_idx):
>+                    bitmap_set(l1_bitmap, l1_idx)
>+                    allocated_l2_tables += 1
>+
>+    # Total amount of allocated clusters excluding the refcount blocks and table
>+    total_allocated_clusters = 1 + allocated_l1_tables + allocated_l2_tables + allocated_data_clusters
>+
>+    # Clusters allocated for the refcount blocks and table
>+    allocated_refcount_blocks = math.ceil(total_allocated_clusters  / refcounts_per_block)
>+    allocated_refcount_tables = math.ceil(allocated_refcount_blocks / refcounts_per_table)
>+
>+    # Now we have a problem because allocated_refcount_blocks and allocated_refcount_tables...
>+    # (a) increase total_allocated_clusters, and
>+    # (b) need to be recalculated when total_allocated_clusters is increased
>+    # So we need to repeat the calculation as long as the numbers change
>+    while True:
>+        new_total_allocated_clusters = total_allocated_clusters + allocated_refcount_tables + allocated_refcount_blocks
>+        new_allocated_refcount_blocks = math.ceil(new_total_allocated_clusters / refcounts_per_block)
>+        if new_allocated_refcount_blocks > allocated_refcount_blocks:
>+            allocated_refcount_blocks = new_allocated_refcount_blocks
>+            allocated_refcount_tables = math.ceil(allocated_refcount_blocks / refcounts_per_table)
>+        else:
>+            break
>+
>+    # Now that we have the final numbers we can update total_allocated_clusters
>+    total_allocated_clusters += allocated_refcount_tables + allocated_refcount_blocks
>+
>+    # At this point we have the exact number of clusters that the output
>+    # image is going to use so we can calculate all the offsets.
>+    current_cluster_idx = 1
>+
>+    refcount_table_offset = current_cluster_idx * cluster_size
>+    current_cluster_idx += allocated_refcount_tables
>+
>+    refcount_block_offset = current_cluster_idx * cluster_size
>+    current_cluster_idx += allocated_refcount_blocks
>+
>+    l1_table_offset = current_cluster_idx * cluster_size
>+    current_cluster_idx += allocated_l1_tables
>+
>+    l2_table_offset = current_cluster_idx * cluster_size
>+    current_cluster_idx += allocated_l2_tables
>+
>+    data_clusters_offset = current_cluster_idx * cluster_size
>+
>+    # Calculate some values used in the qcow2 header
>+    if allocated_l1_tables == 0:
>+        l1_table_offset = 0
>+
>+    hdr_cluster_bits = int(math.log2(cluster_size))
>+    hdr_refcount_bits = 0
>+    hdr_length = 0
>+    if qcow2_version == 3:
>+        hdr_refcount_bits = int(math.log2(refcount_bits))
>+        hdr_length = QCOW2_V3_HEADER_LENGTH
>+
>+    ### Write qcow2 header
>+    cluster = bytearray(cluster_size)
>+    struct.pack_into(">4sIQIIQIIQQIIQQQQII", cluster, 0,
>+        b"QFI\xfb",            # QCOW magic string
>+        qcow2_version,
>+        0,                     # backing file offset
>+        0,                     # backing file sizes
>+        hdr_cluster_bits,
>+        disk_size,
>+        0,                     # encryption method
>+        l1_entries,
>+        l1_table_offset,
>+        refcount_table_offset,
>+        allocated_refcount_tables,
>+        0,                     # number of snapshots
>+        0,                     # snapshot table offset
>+        0,                     # compatible features
>+        0,                     # incompatible features
>+        0,                     # autoclear features
>+        hdr_refcount_bits,
>+        hdr_length,
>+    )
>+
>+    if qcow2_version == 3:
>+        write_features(cluster, hdr_length)
>+
>+    sys.stdout.buffer.write(cluster)
>+
>+    ### Write refcount table
>+    cur_offset = refcount_block_offset
>+    remaining_refcount_table_entries = allocated_refcount_blocks # Each entry is a pointer to a refcount block
>+    while remaining_refcount_table_entries > 0:
>+        cluster = bytearray(cluster_size)
>+        to_write = min(remaining_refcount_table_entries, refcounts_per_table)
>+        remaining_refcount_table_entries -= to_write
>+        for idx in range(to_write):
>+            struct.pack_into(">Q", cluster, idx * 8, cur_offset)
>+            cur_offset += cluster_size
>+        sys.stdout.buffer.write(cluster)
>+
>+    ### Write refcount blocks
>+    remaining_refcount_block_entries = total_allocated_clusters # One entry for each allocated cluster
>+    for tbl in range(allocated_refcount_blocks):
>+        cluster = bytearray(cluster_size)
>+        to_write = min(remaining_refcount_block_entries, refcounts_per_block)
>+        remaining_refcount_block_entries -= to_write
>+        # All refcount entries contain the number 1. The only difference
>+        # is their bit width, defined when the image is created.
>+        for idx in range(to_write):
>+            if refcount_bits == 64:
>+                struct.pack_into(">Q", cluster, idx * 8, 1)
>+            elif refcount_bits == 32:
>+                struct.pack_into(">L", cluster, idx * 4, 1)
>+            elif refcount_bits == 16:
>+                struct.pack_into(">H", cluster, idx * 2, 1)
>+            elif refcount_bits == 8:
>+                cluster[idx] = 1
>+            elif refcount_bits == 4:
>+                cluster[int(idx / 2)] |= 1 << ((idx % 2) * 4)
>+            elif refcount_bits == 2:
>+                cluster[int(idx / 4)] |= 1 << ((idx % 4) * 2)
>+            elif refcount_bits == 1:
>+                cluster[int(idx / 8)] |= 1 << (idx % 8)
>+        sys.stdout.buffer.write(cluster)
>+
>+    ### Write L1 table
>+    cur_offset = l2_table_offset
>+    for tbl in range(allocated_l1_tables):
>+        cluster = bytearray(cluster_size)
>+        for idx in range(l1_entries_per_table):
>+            l1_idx = tbl * l1_entries_per_table + idx
>+            if bitmap_test(l1_bitmap, l1_idx):
>+                struct.pack_into(">Q", cluster, idx * 8, cur_offset | QCOW_OFLAG_COPIED)
>+                cur_offset += cluster_size
>+        sys.stdout.buffer.write(cluster)
>+
>+    ### Write L2 tables
>+    cur_offset = data_clusters_offset
>+    for tbl in range(l1_entries):
>+        # Skip the empty L2 tables. We can identify them because
>+        # there is no L1 entry pointing at them.
>+        if bitmap_test(l1_bitmap, tbl):
>+            cluster = bytearray(cluster_size)
>+            for idx in range(l2_entries_per_table):
>+                l2_idx = tbl * l2_entries_per_table + idx
>+                if bitmap_test(l2_bitmap, l2_idx):
>+                    struct.pack_into(">Q", cluster, idx * 8, cur_offset | QCOW_OFLAG_COPIED)
>+                    cur_offset += cluster_size
>+            sys.stdout.buffer.write(cluster)
>+
>+    ### Write data clusters
>+    with open(input_file, "rb") as reader:
>+        skip = 0
>+        for idx in range(total_data_clusters):
>+            if bitmap_test(l2_bitmap, idx):
>+                if skip > 0:
>+                    reader.seek(cluster_size * skip, 1)
>+                    skip = 0
>+                cluster = reader.read(cluster_size)
>+                # If the last cluster is smaller than cluster_size pad it with zeroes
>+                if len(cluster) < cluster_size:
>+                    cluster += bytes(cluster_size - len(cluster))
>+                sys.stdout.buffer.write(cluster)
>+            else:
>+                skip += 1
>+
>+
>+if __name__ == "__main__":
>+    # Command-line arguments
>+    parser = argparse.ArgumentParser(
>+        description="This program converts a QEMU disk image to qcow2 "
>+        "and writes it to the standard output"
>+    )
>+    parser.add_argument("input_file", help="name of the input file")
>+    parser.add_argument(
>+        "-f",
>+        dest="input_format",
>+        metavar="input_format",
>+        default="raw",
>+        help="format of the input file (default: raw)",
>+    )
>+    parser.add_argument(
>+        "-c",
>+        dest="cluster_size",
>+        metavar="cluster_size",
>+        help=f"qcow2 cluster size (default: {QCOW2_DEFAULT_CLUSTER_SIZE})",
>+        default=QCOW2_DEFAULT_CLUSTER_SIZE,
>+        type=int,
>+        choices=[1 << x for x in range(9, 22)],
>+    )
>+    parser.add_argument(
>+        "-r",
>+        dest="refcount_bits",
>+        metavar="refcount_bits",
>+        help=f"width of the reference count entries (default: {QCOW2_DEFAULT_REFCOUNT_BITS})",
>+        default=QCOW2_DEFAULT_REFCOUNT_BITS,
>+        type=int,
>+        choices=[1 << x for x in range(7)],
>+    )
>+    parser.add_argument(
>+        "-v",
>+        dest="qcow2_version",
>+        metavar="qcow2_version",
>+        help=f"qcow2 version (default: {QCOW2_DEFAULT_VERSION})",
>+        default=QCOW2_DEFAULT_VERSION,
>+        type=int,
>+        choices=[2, 3],
>+    )
>+    args = parser.parse_args()
>+
>+    if not os.path.isfile(args.input_file):
>+        sys.exit(f"[Error] {args.input_file} does not exist or is not a regular file.")
>+
>+    if args.refcount_bits != 16 and args.qcow2_version != 3:
>+        sys.exit(f"[Error] refcount_bits={args.refcount_bits} is only supported with qcow2_version=3.")
>+
>+    if sys.stdout.isatty():
>+        sys.exit("[Error] Refusing to write to a tty. Try redirecting stdout.")
>+
>+    with get_input_as_raw_file(args.input_file, args.input_format) as raw_file:
>+        create_qcow2_file(
>+            raw_file,
>+            args.cluster_size,
>+            args.refcount_bits,
>+            args.qcow2_version,
>+        )
>-- 
>2.39.2
>

Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

On Mon, Jul 1, 2024 at 6:13 PM Alberto Garcia <berto@igalia.com> wrote:
>
> This tool converts a disk image to qcow2, writing the result directly
> to stdout. This can be used for example to send the generated file
> over the network.
>
> This is equivalent to using qemu-img to convert a file to qcow2 and
> then writing the result to stdout, with the difference that this tool
> does not need to create this temporary qcow2 file and therefore does
> not need any additional disk space.
>
> Implementing this directly in qemu-img is not really an option because
> it expects the output file to be seekable and it is also meant to be a
> generic tool that supports all combinations of file formats and image
> options. Instead, this tool can only produce qcow2 files with the
> basic options, without compression, encryption or other features.
>
> The input file is read twice. The first pass is used to determine
> which clusters contain non-zero data and that information is used to
> create the qcow2 header, refcount table and blocks, and L1 and L2
> tables. After all that metadata is created then the second pass is
> used to write the guest data.
> By default qcow2-to-stdout.py expects the input to be a raw file, but
> if qemu-storage-daemon is available then it can also be used to read
> images in other formats. Alternatively the user can also run qemu-ndb
> or qemu-storage-daemon manually instead.
>
> Signed-off-by: Alberto Garcia <berto@igalia.com>
> Signed-off-by: Madeeha Javed <javed@igalia.com>
> ---
>  scripts/qcow2-to-stdout.py | 377 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 377 insertions(+)
>  create mode 100755 scripts/qcow2-to-stdout.py
>
> v2:
> - Define the QCOW2_V3_HDR_LENGTH and QCOW2_FEATURE_NAME_TABLE constants [Manos]
> - Define the QEMU_STORAGE_DAEMON constant
> - Use isfile() instead of exists() for the input file
> - Refuse to write to stdout if it's a tty [Manos]
> - Move the bulk of the code to a function called from __main__ [Manos]
> - Remove the qcow2_ prefix from qcow2_cluster_size and qcow2_refcount_bits
> - Formatting fixes suggested by the Python black formatter [Manos]
> - On error pass the string directly to sys.exit()
> - Capture the output of qemu-storage-daemon [Manos]
> - Use a contextmanager to run qemu-storage-daemon [Manos]
> - Update patch description to mention why this cannot be implemeted directly in qemu-img [Manos]
>
> v1: https://lists.gnu.org/archive/html/qemu-block/2024-06/msg00073.html
>
> diff --git a/scripts/qcow2-to-stdout.py b/scripts/qcow2-to-stdout.py
> new file mode 100755
> index 0000000000..d486a80e86
> --- /dev/null
> +++ b/scripts/qcow2-to-stdout.py
> @@ -0,0 +1,377 @@
> +#!/usr/bin/env python3
> +
> +# This tool reads a disk image in any format and converts it to qcow2,
> +# writing the result directly to stdout.
> +#
> +# Copyright (C) 2024 Igalia, S.L.
> +#
> +# Authors: Alberto Garcia <berto@igalia.com>
> +#          Madeeha Javed <javed@igalia.com>
> +#
> +# SPDX-License-Identifier: GPL-2.0-or-later
> +#
> +# qcow2 files produced by this script are always arranged like this:
> +#
> +# - qcow2 header
> +# - refcount table
> +# - refcount blocks
> +# - L1 table
> +# - L2 tables
> +# - Data clusters
> +#
> +# A note about variable names: in qcow2 there is one refcount table
> +# and one (active) L1 table, although each can occupy several
> +# clusters. For the sake of simplicity the code sometimes talks about
> +# refcount tables and L1 tables when referring to those clusters.
> +
> +import argparse
> +import atexit

This is unused now

> +import math
> +import os
> +import signal
> +import struct
> +import subprocess
> +import sys
> +import tempfile
> +import time
> +from contextlib import contextmanager
> +
> +QCOW2_DEFAULT_CLUSTER_SIZE = 65536
> +QCOW2_DEFAULT_REFCOUNT_BITS = 16
> +QCOW2_DEFAULT_VERSION = 3
> +QCOW2_FEATURE_NAME_TABLE = 0x6803F857
> +QCOW2_V3_HEADER_LENGTH = 112  # Header length in QEMU 9.0. Must be a multiple of 8
> +QCOW_OFLAG_COPIED = 1 << 63
> +QEMU_STORAGE_DAEMON = "qemu-storage-daemon"
> +
> +
> +def bitmap_set(bitmap, idx):
> +    bitmap[int(idx / 8)] |= 1 << (idx % 8)

Should use floor division operator (//):

    bitmap[idx // 8] |= 1 << (idx % 8)

Same for bitmap_test().

> +
> +
> +def bitmap_test(bitmap, idx):

bitmap_is_set() can be more clear. For example it is obvious that it
returns True if the bit is set

> +    return (bitmap[int(idx / 8)] & (1 << (idx % 8))) != 0
> +
> +
> +# create_qcow2_file() expects a raw input file. If we have a different
> +# format we can use qemu-storage-daemon to make it appear as raw.
> +@contextmanager
> +def get_input_as_raw_file(input_file, input_format):
> +    if input_format == "raw":
> +        yield input_file
> +        return
> +    try:
> +        temp_dir = tempfile.mkdtemp()
> +        pid_file = temp_dir + "/pid"
> +        raw_file = temp_dir + "/raw"

This is fragile, better to use os.path.join()

> +        open(raw_file, "wb").close()
> +        ret = subprocess.run(
> +            [
> +                QEMU_STORAGE_DAEMON,
> +                "--daemonize",

Any reason to daemonize? managing the child process is easier if you
don't daemonize.
There is no need to read the pid file and since the child process is a
child of this process
the pid returned by subprocess.Popen() is always valid.

> +                "--pidfile", pid_file,
> +                "--blockdev", f"driver=file,node-name=file0,driver=file,filename={input_file},read-only=on",
> +                "--blockdev", f"driver={input_format},node-name=disk0,file=file0,read-only=on",
> +                "--export", f"type=fuse,id=export0,node-name=disk0,mountpoint={raw_file},writable=off",
> +            ],
> +            capture_output=True,
> +        )
> +        if ret.returncode != 0:
> +            sys.exit("[Error] Could not start the qemu-storage-daemon:\n" +
> +                     ret.stderr.decode().rstrip('\n'))
> +        yield raw_file
> +    finally:
> +        # Kill the storage daemon on exit

Looks like a good approach...

> +        # and remove all temporary files
> +        if os.path.exists(pid_file):

If the pid file is deleted, this leaves qemu-storage-daemon running
(avoided by running qsd as a child process)

> +            with open(pid_file, "r") as f:
> +                pid = int(f.readline())

This pid can be reused now by another unrelated process (avoided by
running qsd as a child process).

> +            os.kill(pid, signal.SIGTERM)

You don't kill as promised above - I guess because you want to wait
for the pid file.

> +            while os.path.exists(pid_file):
> +                time.sleep(0.1)

If qsd is a child process we could simply use p.wait()

> +        os.unlink(raw_file)
> +        os.rmdir(temp_dir)

We could avoid both by using tempfile.TempoaryDirectory():

    with tempfile.TemporaryDirectory() as tmp_dir:
        ...
        p = subprocess.Popen(cmd, stdout=subprocess.DEVNULL)
        try:
            yield raw_file
        finally:
            p.kill()
            p.wait()

> +
> +
> +def write_features(cluster, offset):
> +    qcow2_features = [
> +        # Incompatible
> +        (0, 0, "dirty bit"),
> +        (0, 1, "corrupt bit"),
> +        (0, 2, "external data file"),
> +        (0, 3, "compression type"),
> +        (0, 4, "extended L2 entries"),
> +        # Compatible
> +        (1, 0, "lazy refcounts"),
> +        # Autoclear
> +        (2, 0, "bitmaps"),
> +        (2, 1, "raw external data"),
> +    ]
> +    struct.pack_into(">I", cluster, offset, QCOW2_FEATURE_NAME_TABLE)
> +    struct.pack_into(">I", cluster, offset + 4, len(qcow2_features) * 48)
> +    offset += 8
> +    for feature_type, feature_bit, feature_name in qcow2_features:
> +        struct.pack_into(">BB46s", cluster, offset,
> +                         feature_type, feature_bit, feature_name.encode("ascii"))
> +        offset += 48
> +
> +
> +def create_qcow2_file(input_file, cluster_size, refcount_bits, qcow2_version):
> +    # Some basic values
> +    l1_entries_per_table = int(cluster_size / 8)
> +    l2_entries_per_table = int(cluster_size / 8)
> +    refcounts_per_table  = int(cluster_size / 8)
> +    refcounts_per_block  = int(cluster_size * 8 / refcount_bits)
> +
> +    # Virtual disk size, number of data clusters and L1 entries
> +    disk_size = math.ceil(os.path.getsize(input_file) / 512) * 512 # Round up to the nearest multiple of 512
> +    total_data_clusters = math.ceil(disk_size / cluster_size)
> +    l1_entries = math.ceil(total_data_clusters / l2_entries_per_table)
> +    allocated_l1_tables = math.ceil(l1_entries / l1_entries_per_table)
> +
> +    # Max L1 table size is 32 MB (QCOW_MAX_L1_SIZE in block/qcow2.h)
> +    if (l1_entries * 8) > (32 * 1024 * 1024):
> +        sys.exit("[Error] The image size is too large. Try using a larger cluster size.")
> +
> +    # Two bitmaps indicating which L1 and L2 entries are set
> +    l1_bitmap = bytearray(int(allocated_l1_tables * l1_entries_per_table / 8))
> +    l2_bitmap = bytearray(int(allocated_l1_tables * l1_entries_per_table * l2_entries_per_table / 8))
> +    allocated_l2_tables = 0
> +    allocated_data_clusters = 0
> +    with open(input_file, "rb") as reader:
> +        zero_cluster = bytes(cluster_size)
> +        # Read all clusters from the input file
> +        for idx in range(total_data_clusters):
> +            cluster = reader.read(cluster_size)
> +            # If the last cluster is smaller than cluster_size pad it with zeroes
> +            if len(cluster) < cluster_size:
> +                cluster += bytes(cluster_size - len(cluster))

This should be done only for the last cluster.

> +            # If a cluster has non-zero data then it must be allocated
> +            # in the output file and its L2 entry must be set
> +            if cluster != zero_cluster:
> +                bitmap_set(l2_bitmap, idx)
> +                allocated_data_clusters += 1
> +                # Allocated data clusters also need their corresponding L1 entry and L2 table
> +                l1_idx = math.floor(idx / l2_entries_per_table)
> +                if not bitmap_test(l1_bitmap, l1_idx):
> +                    bitmap_set(l1_bitmap, l1_idx)
> +                    allocated_l2_tables += 1

This could be much more efficient using SEEK_DATA/SEEK_HOLE, avoiding reading
the entire image twice. Or using "qemu-img map --output json" to simplify.

For example:

    $ qemu-img create -f raw test.raw 1t
    Formatting 'test.raw', fmt=raw size=1099511627776

    $ time dd if=test.raw bs=1M of=/dev/null
    1048576+0 records in
    1048576+0 records out
    1099511627776 bytes (1.1 TB, 1.0 TiB) copied, 322.051 s, 3.4 GB/s

    real 5m22.054s
    user 0m0.463s
    sys 5m18.054s

    $ time qemu-img map --output json test.raw
    [{ "start": 0, "length": 262144, "depth": 0, "present": true,
"zero": false, "data": true, "offset": 0},
    { "start": 262144, "length": 1099511365632, "depth": 0, "present":
true, "zero": true, "data": false, "offset": 262144}]

    real 0m0.010s
    user 0m0.003s
    sys 0m0.006s

I think we can create the l2_bitmap from the json easily. If you want
to do zero detection you need to
read twice only the allocated clusters.

Parsing json from a big image can be slow but much faster than reading
the entire image
and doing zero detection by comparing 64k bytes.

> +
> +    # Total amount of allocated clusters excluding the refcount blocks and table
> +    total_allocated_clusters = 1 + allocated_l1_tables + allocated_l2_tables + allocated_data_clusters
> +
> +    # Clusters allocated for the refcount blocks and table
> +    allocated_refcount_blocks = math.ceil(total_allocated_clusters  / refcounts_per_block)
> +    allocated_refcount_tables = math.ceil(allocated_refcount_blocks / refcounts_per_table)
> +
> +    # Now we have a problem because allocated_refcount_blocks and allocated_refcount_tables...
> +    # (a) increase total_allocated_clusters, and
> +    # (b) need to be recalculated when total_allocated_clusters is increased
> +    # So we need to repeat the calculation as long as the numbers change
> +    while True:
> +        new_total_allocated_clusters = total_allocated_clusters + allocated_refcount_tables + allocated_refcount_blocks
> +        new_allocated_refcount_blocks = math.ceil(new_total_allocated_clusters / refcounts_per_block)
> +        if new_allocated_refcount_blocks > allocated_refcount_blocks:
> +            allocated_refcount_blocks = new_allocated_refcount_blocks
> +            allocated_refcount_tables = math.ceil(allocated_refcount_blocks / refcounts_per_table)
> +        else:
> +            break
> +
> +    # Now that we have the final numbers we can update total_allocated_clusters
> +    total_allocated_clusters += allocated_refcount_tables + allocated_refcount_blocks
> +
> +    # At this point we have the exact number of clusters that the output
> +    # image is going to use so we can calculate all the offsets.
> +    current_cluster_idx = 1
> +
> +    refcount_table_offset = current_cluster_idx * cluster_size
> +    current_cluster_idx += allocated_refcount_tables
> +
> +    refcount_block_offset = current_cluster_idx * cluster_size
> +    current_cluster_idx += allocated_refcount_blocks
> +
> +    l1_table_offset = current_cluster_idx * cluster_size
> +    current_cluster_idx += allocated_l1_tables
> +
> +    l2_table_offset = current_cluster_idx * cluster_size
> +    current_cluster_idx += allocated_l2_tables
> +
> +    data_clusters_offset = current_cluster_idx * cluster_size
> +
> +    # Calculate some values used in the qcow2 header
> +    if allocated_l1_tables == 0:
> +        l1_table_offset = 0
> +
> +    hdr_cluster_bits = int(math.log2(cluster_size))
> +    hdr_refcount_bits = 0
> +    hdr_length = 0
> +    if qcow2_version == 3:
> +        hdr_refcount_bits = int(math.log2(refcount_bits))
> +        hdr_length = QCOW2_V3_HEADER_LENGTH
> +
> +    ### Write qcow2 header
> +    cluster = bytearray(cluster_size)
> +    struct.pack_into(">4sIQIIQIIQQIIQQQQII", cluster, 0,
> +        b"QFI\xfb",            # QCOW magic string
> +        qcow2_version,
> +        0,                     # backing file offset
> +        0,                     # backing file sizes
> +        hdr_cluster_bits,
> +        disk_size,
> +        0,                     # encryption method
> +        l1_entries,
> +        l1_table_offset,
> +        refcount_table_offset,
> +        allocated_refcount_tables,
> +        0,                     # number of snapshots
> +        0,                     # snapshot table offset
> +        0,                     # compatible features
> +        0,                     # incompatible features
> +        0,                     # autoclear features
> +        hdr_refcount_bits,
> +        hdr_length,
> +    )
> +
> +    if qcow2_version == 3:
> +        write_features(cluster, hdr_length)
> +
> +    sys.stdout.buffer.write(cluster)
> +
> +    ### Write refcount table
> +    cur_offset = refcount_block_offset
> +    remaining_refcount_table_entries = allocated_refcount_blocks # Each entry is a pointer to a refcount block
> +    while remaining_refcount_table_entries > 0:
> +        cluster = bytearray(cluster_size)
> +        to_write = min(remaining_refcount_table_entries, refcounts_per_table)
> +        remaining_refcount_table_entries -= to_write
> +        for idx in range(to_write):
> +            struct.pack_into(">Q", cluster, idx * 8, cur_offset)
> +            cur_offset += cluster_size
> +        sys.stdout.buffer.write(cluster)
> +
> +    ### Write refcount blocks
> +    remaining_refcount_block_entries = total_allocated_clusters # One entry for each allocated cluster
> +    for tbl in range(allocated_refcount_blocks):
> +        cluster = bytearray(cluster_size)
> +        to_write = min(remaining_refcount_block_entries, refcounts_per_block)
> +        remaining_refcount_block_entries -= to_write
> +        # All refcount entries contain the number 1. The only difference
> +        # is their bit width, defined when the image is created.
> +        for idx in range(to_write):
> +            if refcount_bits == 64:
> +                struct.pack_into(">Q", cluster, idx * 8, 1)
> +            elif refcount_bits == 32:
> +                struct.pack_into(">L", cluster, idx * 4, 1)
> +            elif refcount_bits == 16:
> +                struct.pack_into(">H", cluster, idx * 2, 1)
> +            elif refcount_bits == 8:
> +                cluster[idx] = 1
> +            elif refcount_bits == 4:
> +                cluster[int(idx / 2)] |= 1 << ((idx % 2) * 4)
> +            elif refcount_bits == 2:
> +                cluster[int(idx / 4)] |= 1 << ((idx % 4) * 2)
> +            elif refcount_bits == 1:
> +                cluster[int(idx / 8)] |= 1 << (idx % 8)
> +        sys.stdout.buffer.write(cluster)
> +
> +    ### Write L1 table
> +    cur_offset = l2_table_offset
> +    for tbl in range(allocated_l1_tables):
> +        cluster = bytearray(cluster_size)
> +        for idx in range(l1_entries_per_table):
> +            l1_idx = tbl * l1_entries_per_table + idx
> +            if bitmap_test(l1_bitmap, l1_idx):
> +                struct.pack_into(">Q", cluster, idx * 8, cur_offset | QCOW_OFLAG_COPIED)
> +                cur_offset += cluster_size
> +        sys.stdout.buffer.write(cluster)
> +
> +    ### Write L2 tables
> +    cur_offset = data_clusters_offset
> +    for tbl in range(l1_entries):
> +        # Skip the empty L2 tables. We can identify them because
> +        # there is no L1 entry pointing at them.
> +        if bitmap_test(l1_bitmap, tbl):
> +            cluster = bytearray(cluster_size)
> +            for idx in range(l2_entries_per_table):
> +                l2_idx = tbl * l2_entries_per_table + idx
> +                if bitmap_test(l2_bitmap, l2_idx):
> +                    struct.pack_into(">Q", cluster, idx * 8, cur_offset | QCOW_OFLAG_COPIED)
> +                    cur_offset += cluster_size
> +            sys.stdout.buffer.write(cluster)
> +
> +    ### Write data clusters
> +    with open(input_file, "rb") as reader:
> +        skip = 0
> +        for idx in range(total_data_clusters):
> +            if bitmap_test(l2_bitmap, idx):
> +                if skip > 0:
> +                    reader.seek(cluster_size * skip, 1)
> +                    skip = 0
> +                cluster = reader.read(cluster_size)
> +                # If the last cluster is smaller than cluster_size pad it with zeroes
> +                if len(cluster) < cluster_size:
> +                    cluster += bytes(cluster_size - len(cluster))

This can be done only for the last cluster.

> +                sys.stdout.buffer.write(cluster)
> +            else:
> +                skip += 1

If would be easier to work with if you add a function iterating over the
l2_entries, yielding the he cluster index to copy:

  def iter_l2_entries(bitmap, clusters):
    for idx in range(clusters):
      if bitmap_test(bitmap, idx):
        yield idx

The copy loop can read using os.pread():

    for idx in iter_l2_entries(l2_bitmap, total_data_clusters):
        cluster = os.pread(fd, cluster_size, cluster_size * idx)
        sys.stdout.buffer.write(cluster)

I'm not sure the offset is right in my example, it is hard to
understand the semantics
of skip in your code.

> +
> +
> +if __name__ == "__main__":

Usually code is easier to work with when __main__  calls main().

For example:

  def main():
    args = parse_args()
    validate args...
    actual work...

  if __name__ == '__main__':
    main()

This does not leak unwanted global variables from code parsing
arguments, and we can test any function
if needed. This is also more consistent since we can write any script
using this style.

> +    # Command-line arguments
> +    parser = argparse.ArgumentParser(

parser is global - is this intended?

> +        description="This program converts a QEMU disk image to qcow2 "
> +        "and writes it to the standard output"
> +    )
> +    parser.add_argument("input_file", help="name of the input file")
> +    parser.add_argument(
> +        "-f",
> +        dest="input_format",
> +        metavar="input_format",
> +        default="raw",
> +        help="format of the input file (default: raw)",
> +    )
> +    parser.add_argument(
> +        "-c",
> +        dest="cluster_size",
> +        metavar="cluster_size",
> +        help=f"qcow2 cluster size (default: {QCOW2_DEFAULT_CLUSTER_SIZE})",
> +        default=QCOW2_DEFAULT_CLUSTER_SIZE,
> +        type=int,
> +        choices=[1 << x for x in range(9, 22)],
> +    )
> +    parser.add_argument(
> +        "-r",
> +        dest="refcount_bits",
> +        metavar="refcount_bits",
> +        help=f"width of the reference count entries (default: {QCOW2_DEFAULT_REFCOUNT_BITS})",
> +        default=QCOW2_DEFAULT_REFCOUNT_BITS,
> +        type=int,
> +        choices=[1 << x for x in range(7)],
> +    )
> +    parser.add_argument(
> +        "-v",
> +        dest="qcow2_version",
> +        metavar="qcow2_version",
> +        help=f"qcow2 version (default: {QCOW2_DEFAULT_VERSION})",
> +        default=QCOW2_DEFAULT_VERSION,
> +        type=int,
> +        choices=[2, 3],
> +    )
> +    args = parser.parse_args()

args is global, is this intended?

> +
> +    if not os.path.isfile(args.input_file):
> +        sys.exit(f"[Error] {args.input_file} does not exist or is not a regular file.")
> +
> +    if args.refcount_bits != 16 and args.qcow2_version != 3:
> +        sys.exit(f"[Error] refcount_bits={args.refcount_bits} is only supported with qcow2_version=3.")
> +
> +    if sys.stdout.isatty():
> +        sys.exit("[Error] Refusing to write to a tty. Try redirecting stdout.")
> +
> +    with get_input_as_raw_file(args.input_file, args.input_format) as raw_file:

raw_file is global, is this intended?

> +        create_qcow2_file(

The name does not reflect what the function does - this does not
create a qcow2 file, but write
a qcow2 content to stdout. Maybe write_qcow2_content()?

> +            raw_file,
> +            args.cluster_size,
> +            args.refcount_bits,
> +            args.qcow2_version,
> +        )
> --
> 2.39.2
>
>

Nir

On Sun 28 Jul 2024 01:01:07 AM +03, Nir Soffer wrote:
>> +def bitmap_set(bitmap, idx):
>> +    bitmap[int(idx / 8)] |= 1 << (idx % 8)
>
> Should use floor division operator (//):
>
>     bitmap[idx // 8] |= 1 << (idx % 8)
>
> Same for bitmap_test().

Right, also for all other cases of int(foo / bar). I'll update them.

>> +        ret = subprocess.run(
>> +            [
>> +                QEMU_STORAGE_DAEMON,
>> +                "--daemonize",
>
> Any reason to daemonize? managing the child process is easier if you
> don't daemonize.

--daemonize guarantees that when subprocess.run() returns the exported
raw_file is ready to use.

>> +            if len(cluster) < cluster_size:
>> +                cluster += bytes(cluster_size - len(cluster))
>
> This should be done only for the last cluster.

But that's what that condition is for, we'll only read less than
cluster_size bytes at the end of the file.

>> +                if not bitmap_test(l1_bitmap, l1_idx):
>> +                    bitmap_set(l1_bitmap, l1_idx)
>> +                    allocated_l2_tables += 1
>
> This could be much more efficient using SEEK_DATA/SEEK_HOLE, avoiding
> reading the entire image twice. Or using "qemu-img map --output json"
> to simplify.

I prefer not to have external dependencies(*) so I would rather not use
qemu-img, but I certainly can use SEEK_DATA/SEEK_HOLE to avoid reading
data that is known to be zero in the first pass.

(*) there is of course qemu-storage-daemon but that one is optional and
    I anyway cannot implement its functionality in this script.

>> +                sys.stdout.buffer.write(cluster)
>> +            else:
>> +                skip += 1
>
> If would be easier to work with if you add a function iterating over
> the l2_entries, yielding the he cluster index to copy:
>
>   def iter_l2_entries(bitmap, clusters):
>     for idx in range(clusters):
>       if bitmap_test(bitmap, idx):
>         yield idx
>
> The copy loop can read using os.pread():
>
>     for idx in iter_l2_entries(l2_bitmap, total_data_clusters):
>         cluster = os.pread(fd, cluster_size, cluster_size * idx)
>         sys.stdout.buffer.write(cluster)
>
> I'm not sure the offset is right in my example, it is hard to
> understand the semantics of skip in your code.

That part reads the input file sequentially from start to end, but
instead of reading empty clusters we use seek() to skip them. The 'skip'
variable keeps a counter of empty clusters since the last read.

Your proposal requires an additional function but I see that it can make
the code more readable, so I'll give it a try.

>> +if __name__ == "__main__":
>
> Usually code is easier to work with when __main__  calls main().

Good idea.

Thanks for the detailed review!

Berto