From: Stefan Hajnoczi <stefanha@redhat.com>
To: <qemu-devel@nongnu.org>
Cc: <qemu-block@nongnu.org>, Kevin Wolf <kwolf@redhat.com>,
mjt@tls.msk.ru, Stefan Hajnoczi <stefanha@redhat.com>
Subject: [PATCH 4/5] docs: flesh out qcow2 format driver description
Date: Wed, 1 Feb 2023 16:12:33 -0500 [thread overview]
Message-ID: <20230201211234.301918-5-stefanha@redhat.com> (raw)
In-Reply-To: <20230201211234.301918-1-stefanha@redhat.com>
Put the create options in alphabetical order, add compression_type and
extended_l2, and also mention the common runtime options. I did not add
rarely-used runtime options because I think it's too much information.
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
docs/system/qemu-block-drivers.rst.inc | 91 ++++++++++++++++++++------
1 file changed, 70 insertions(+), 21 deletions(-)
diff --git a/docs/system/qemu-block-drivers.rst.inc b/docs/system/qemu-block-drivers.rst.inc
index ec9ebb2066..af72817763 100644
--- a/docs/system/qemu-block-drivers.rst.inc
+++ b/docs/system/qemu-block-drivers.rst.inc
@@ -59,13 +59,27 @@ options that are supported for it.
.. option:: qcow2
QEMU image format, the most versatile format. Use it to have smaller
- images (useful if your filesystem does not supports holes, for example
- on Windows), zlib based compression and support of multiple VM
+ images (useful if your filesystem does not support holes, for example
+ on Windows), zlib/zstd compression and support of multiple VM
snapshots.
- Supported options:
+ Supported create options:
.. program:: qcow2
+ .. option:: backing_file
+
+ File name of a base image (see ``create`` subcommand)
+
+ .. option:: backing_fmt
+
+ Image format of the base image
+
+ .. option:: cluster_size
+
+ Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
+ sizes can improve the image file size whereas larger cluster sizes generally
+ provide better performance.
+
.. option:: compat
Determines the qcow2 version to use. ``compat=0.10`` uses the
@@ -74,13 +88,9 @@ options that are supported for it.
newer understand (this is the default). Amongst others, this includes
zero clusters, which allow efficient copy-on-read for sparse images.
- .. option:: backing_file
+ .. option:: compression_type
- File name of a base image (see ``create`` subcommand)
-
- .. option:: backing_fmt
-
- Image format of the base image
+ Selects the compression algorithm (zlib or zstd).
.. option:: encryption
@@ -150,19 +160,11 @@ options that are supported for it.
Amount of time, in milliseconds, to use for PBKDF algorithm per key slot.
Defaults to ``2000``. Only used when ``encrypt.format=luks``.
- .. option:: cluster_size
+ .. option:: extended_l2
- Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
- sizes can improve the image file size whereas larger cluster sizes generally
- provide better performance.
-
- .. option:: preallocation
-
- Preallocation mode (allowed values: ``off``, ``metadata``, ``falloc``,
- ``full``). An image with preallocated metadata is initially larger but can
- improve performance when the image needs to grow. ``falloc`` and ``full``
- preallocations are like the same options of ``raw`` format, but sets up
- metadata also.
+ Enables the Extended L2 Entries feature that divides each cluster into 32
+ separately allocated sub-clusters. A larger cluster size can be used, thus
+ reducing metadata overhead, while still allowing fine-grained allocation.
.. option:: lazy_refcounts
@@ -196,6 +198,53 @@ options that are supported for it.
filename`` to check if the NOCOW flag is set or not (Capital 'C' is
NOCOW flag).
+ .. option:: preallocation
+
+ Preallocation mode (allowed values: ``off``, ``metadata``, ``falloc``,
+ ``full``). An image with preallocated metadata is initially larger but can
+ improve performance when the image needs to grow. ``falloc`` and ``full``
+ preallocations are like the same options of ``raw`` format, but sets up
+ metadata also.
+
+ Supported runtime options:
+
+ .. program:: qcow2
+ .. option:: cache-clean-interval
+
+ Clean unused cache entries after this time (in seconds).
+
+ .. option:: cache-size
+
+ Maximum combined metadata (L2 tables and refcount blocks) cache size.
+
+ .. option:: encrypt.key-secret
+
+ ID of secret providing qcow2 AES key or LUKS passphrase.
+
+ .. option:: l2-cache-size
+
+ Maximum L2 table cache size.
+
+ .. option:: l2-cache-entry-size
+
+ Size of each entry in the L2 cache.
+
+ .. option:: pass-discard-request
+
+ Pass guest discard requests to the layer below (on/off).
+
+ .. option:: pass-discard-snapshot
+
+ Generate discard requests when snapshot related space is freed (on/off).
+
+ .. option:: pass-discard-other
+
+ Generate discard requests when other clusters are freed (on/off).
+
+ .. option:: refcount-cache-size
+
+ Maximum refcount block cache size.
+
.. program:: image-formats
.. option:: qed
--
2.39.1
next prev parent reply other threads:[~2023-02-01 21:13 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-01 21:12 [PATCH 0/5] docs: expand block driver documentation Stefan Hajnoczi
2023-02-01 21:12 ` [PATCH 1/5] docs: expand introduction to disk images Stefan Hajnoczi
2023-02-03 22:52 ` Eric Blake
2023-02-01 21:12 ` [PATCH 2/5] docs: differentiate between block driver create and runtime opts Stefan Hajnoczi
2023-02-03 22:53 ` Eric Blake
2023-02-01 21:12 ` [PATCH 3/5] docs: flesh out raw format driver description Stefan Hajnoczi
2023-02-02 9:17 ` Daniel P. Berrangé
2023-02-01 21:12 ` Stefan Hajnoczi [this message]
2023-02-03 22:57 ` [PATCH 4/5] docs: flesh out qcow2 " Eric Blake
2023-02-01 21:12 ` [PATCH 5/5] docs: add throttle filter description Stefan Hajnoczi
2023-02-03 23:00 ` Eric Blake
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230201211234.301918-5-stefanha@redhat.com \
--to=stefanha@redhat.com \
--cc=kwolf@redhat.com \
--cc=mjt@tls.msk.ru \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).