From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id 52BC91FF164
for <inbox@lore.proxmox.com>; Fri, 23 May 2025 15:32:30 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 8E94E1BAB7;
Fri, 23 May 2025 15:32:05 +0200 (CEST)
From: Fiona Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Fri, 23 May 2025 15:31:47 +0200
Message-Id: <20250523133156.617227-2-f.ebner@proxmox.com>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250523133156.617227-1-f.ebner@proxmox.com>
References: <20250523133156.617227-1-f.ebner@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.033 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: [pve-devel] [RFC v2 qemu 01/10] block/rbd: support selected
key-value-pairs via QAPI
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>
Currently, most Ceph configuration options are not exposed via QAPI.
While it is possible to specify a dedicated Ceph configuration file,
specialized options are often only required for a selection of images
on the RBD storage, not all of them. To avoid the need to generate a
dedicated Ceph configuration file for each image (or for each required
combination of options), support a selection of key-value pairs via
QAPI.
Initially, this is just 'rbd_cache_policy'. For example, this is
useful with small images used as a pflash for EFI variables. Setting
the 'rbd_cache_policy' to 'writeback' yields a substantial improvement
there [0].
The function qemu_rbd_extract_key_value_pairs() was copied/adapted
from the existing qemu_rbd_extract_encryption_create_options().
[0]: https://bugzilla.proxmox.com/show_bug.cgi?id=3329#c9
Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---
New in v2.
block/rbd.c | 73 ++++++++++++++++++++++++++++++++++++++++++++
qapi/block-core.json | 37 ++++++++++++++++++++++
2 files changed, 110 insertions(+)
diff --git a/block/rbd.c b/block/rbd.c
index 24e820d056..3928d8fee4 100644
--- a/block/rbd.c
+++ b/block/rbd.c
@@ -293,6 +293,27 @@ static int qemu_rbd_set_auth(rados_t cluster, BlockdevOptionsRbd *opts,
return 0;
}
+static int qemu_rbd_set_key_value_pairs(rados_t cluster,
+ RbdKeyValuePairs *key_value_pairs,
+ Error **errp)
+{
+ if (!key_value_pairs) {
+ return 0;
+ }
+
+ if (key_value_pairs->has_rbd_cache_policy) {
+ RbdCachePolicy value = key_value_pairs->rbd_cache_policy;
+ int r = rados_conf_set(cluster, "rbd_cache_policy",
+ RbdCachePolicy_str(value));
+ if (r < 0) {
+ error_setg_errno(errp, -r, "could not set 'rbd_cache_policy'");
+ return -EINVAL;
+ }
+ }
+
+ return 0;
+}
+
static int qemu_rbd_set_keypairs(rados_t cluster, const char *keypairs_json,
Error **errp)
{
@@ -786,6 +807,44 @@ exit:
return ret;
}
+static int qemu_rbd_extract_key_value_pairs(
+ QemuOpts *opts,
+ RbdKeyValuePairs **key_value_pairs,
+ Error **errp)
+{
+ QDict *opts_qdict;
+ QDict *key_value_pairs_qdict;
+ Visitor *v;
+ int ret = 0;
+
+ opts_qdict = qemu_opts_to_qdict(opts, NULL);
+ qdict_extract_subqdict(opts_qdict, &key_value_pairs_qdict,
+ "key-value-pairs.");
+ qobject_unref(opts_qdict);
+ if (!qdict_size(key_value_pairs_qdict)) {
+ *key_value_pairs = NULL;
+ goto exit;
+ }
+
+ /* Convert options into a QAPI object */
+ v = qobject_input_visitor_new_flat_confused(key_value_pairs_qdict, errp);
+ if (!v) {
+ ret = -EINVAL;
+ goto exit;
+ }
+
+ visit_type_RbdKeyValuePairs(v, NULL, key_value_pairs, errp);
+ visit_free(v);
+ if (!*key_value_pairs) {
+ ret = -EINVAL;
+ goto exit;
+ }
+
+exit:
+ qobject_unref(key_value_pairs_qdict);
+ return ret;
+}
+
static int coroutine_fn qemu_rbd_co_create_opts(BlockDriver *drv,
const char *filename,
QemuOpts *opts,
@@ -795,6 +854,7 @@ static int coroutine_fn qemu_rbd_co_create_opts(BlockDriver *drv,
BlockdevCreateOptionsRbd *rbd_opts;
BlockdevOptionsRbd *loc;
RbdEncryptionCreateOptions *encrypt = NULL;
+ RbdKeyValuePairs *key_value_pairs = NULL;
Error *local_err = NULL;
const char *keypairs, *password_secret;
QDict *options = NULL;
@@ -843,6 +903,13 @@ static int coroutine_fn qemu_rbd_co_create_opts(BlockDriver *drv,
loc->image = g_strdup(qdict_get_try_str(options, "image"));
keypairs = qdict_get_try_str(options, "=keyvalue-pairs");
+ /* These are the key-value pairs coming in via the QAPI. */
+ ret = qemu_rbd_extract_key_value_pairs(opts, &key_value_pairs, errp);
+ if (ret < 0) {
+ goto exit;
+ }
+ loc->key_value_pairs = key_value_pairs;
+
ret = qemu_rbd_do_create(create_options, keypairs, password_secret, errp);
if (ret < 0) {
goto exit;
@@ -932,6 +999,12 @@ static int qemu_rbd_connect(rados_t *cluster, rados_ioctx_t *io_ctx,
goto failed_shutdown;
}
+ /* For the key-value pairs coming via QAPI. */
+ r = qemu_rbd_set_key_value_pairs(*cluster, opts->key_value_pairs, errp);
+ if (r < 0) {
+ goto failed_shutdown;
+ }
+
if (mon_host) {
r = rados_conf_set(*cluster, "mon_host", mon_host);
if (r < 0) {
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 02c043f0f7..360f467f6e 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -4645,6 +4645,39 @@
'data': { 'luks': 'RbdEncryptionCreateOptionsLUKS',
'luks2': 'RbdEncryptionCreateOptionsLUKS2' } }
+##
+# @RbdCachePolicy:
+#
+# An enumeration of values for the 'rbd_cache_policy' Ceph
+# configuration setting. See the Ceph documentation for details.
+#
+# @writearound: cachable writes return immediately, reads are not
+# served from the cache.
+#
+# @writeback: cachable writes return immediately, reads are served
+# from the cache.
+#
+# @writethrough: writes return only when the data is on disk for all
+# replicas, reads are served from the cache.
+#
+# Since 10.1
+##
+{ 'enum' : 'RbdCachePolicy',
+ 'data' : [ 'writearound', 'writeback', 'writethrough' ] }
+
+
+##
+# @RbdKeyValuePairs:
+#
+# Key-value pairs for Ceph configuration.
+#
+# @rbd-cache-policy: Ceph configuration option 'rbd_cache_policy'.
+#
+# Since 10.1
+##
+{ 'struct': 'RbdKeyValuePairs',
+ 'data': { '*rbd-cache-policy': 'RbdCachePolicy' } }
+
##
# @BlockdevOptionsRbd:
#
@@ -4671,6 +4704,9 @@
# authentication. This maps to Ceph configuration option "key".
# (Since 3.0)
#
+# @key-value-pairs: Key-value pairs for additional Ceph configuraton.
+# (Since 10.1)
+#
# @server: Monitor host address and port. This maps to the "mon_host"
# Ceph option.
#
@@ -4686,6 +4722,7 @@
'*user': 'str',
'*auth-client-required': ['RbdAuthMode'],
'*key-secret': 'str',
+ '*key-value-pairs' : 'RbdKeyValuePairs',
'*server': ['InetSocketAddressBase'] } }
##
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel