Contrary to most APIs returning typed parameters, there are no constants
defined for the guest info data keys. This is was because many of the
keys needs to be dynamically constructed using one or more array index
values.
It is possible to define constants while still supporting dynamic
array indexes by simply defining the prefixes and suffixes as constants.
The consuming code can then combine the constants with array index
value.
With this approach, it is practical to add constants for the guest info
API keys.
Signed-off-by: Daniel P. Berrangé <berrange@xxxxxxxxxx>
---
include/libvirt/libvirt-domain.h | 101 +++++++++++++++++++++++++++++++
src/libvirt-domain.c | 19 +-----
src/qemu/qemu_driver.c | 25 +++++---
3 files changed, 121 insertions(+), 24 deletions(-)
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 34c931e260..002996b18c 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -6732,6 +6732,107 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain,
*/
#define VIR_DOMAIN_GUEST_INFO_FS_SUFFIX_DISK_SUFFIX_DEVICE ".device"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_COUNT:
+ *
+ * The number of disks defined on this domain as an unsigned int.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_COUNT "disk.count"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_PREFIX:
+ *
+ * The parameter name prefix to access each disk entry. Concatenate the
+ * prefix, the entry number formatted as an unsigned integer and one of the
+ * disk suffix parameters to form a complete parameter name.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "disk."
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_NAME:
+ *
+ * Device node (Linux) or device UNC (Windows) as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_NAME ".name"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_PARTITION:
+ *
+ * Whether this is a partition (true) or disk (false) as a boolean.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_PARTITION ".partition"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_COUNT:
+ *
+ * The number of device dependencies as an unsigned int.
+ *
+ * e.g. for LVs of the LVM this will hold the list of PVs, for LUKS encrypted
+ * volume this will contain the disk where the volume is placed. (Linux).
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_COUNT ".dependency.count"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_PREFIX:
+ *
+ * The parameter name prefix to access each dependency entry. Concatenate the
+ * disk prefix, the disk entry number formatted as an unsigned integer, the
+ * dependency prefix, the dependency entry number formatted as an unsigned
+ * integer and one of the dependency suffix parameters to form a complete
+ * parameter name.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_PREFIX ".dependency."
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_SUFFIX_NAME:
+ *
+ * A dependency name as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_SUFFIX_NAME ".name"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_SERIAL:
+ *
+ * Optional disk serial number as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_SERIAL ".serial"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_ALIAS:
+ *
+ * The device alias of the disk (e.g. sda) as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_ALIAS ".alias"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_GUEST_ALIAS:
+ *
+ * Optional alias assigned to the disk, on Linux this is a name assigned by
+ * device mapper, as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_GUEST_ALIAS ".guest_alias"
+
/**
* virDomainGuestInfoTypes:
*
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 324797337c..097d628c7b 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -13225,22 +13225,9 @@ virDomainSetVcpu(virDomainPtr domain,
* keys.
*
* VIR_DOMAIN_GUEST_INFO_DISKS:
- * Returns information about the disks within the domain. The typed
- * parameter keys are in this format:
- *
- * "disk.count" - the number of disks defined on this domain
- * as an unsigned int
- * "disk.<num>.name" - device node (Linux) or device UNC (Windows)
- * "disk.<num>.partition" - whether this is a partition or disk
- * "disk.<num>.dependency.count" - the number of device dependencies
- * e.g. for LVs of the LVM this will
- * hold the list of PVs, for LUKS encrypted volume this will
- * contain the disk where the volume is placed. (Linux)
- * "disk.<num>.dependency.<num>.name" - a dependency
- * "disk.<num>.serial" - optional disk serial number (as string)
- * "disk.<num>.alias" - the device alias of the disk (e.g. sda)
- * "disk.<num>.guest_alias" - optional alias assigned to the disk, on Linux
- * this is a name assigned by device mapper
+ * Returns information about the disks within the domain.
+ * The VIR_DOMAIN_GUEST_INFO_DISK_* constants define the known typed parameter
+ * keys.
*
* VIR_DOMAIN_GUEST_INFO_INTERFACES:
* Returns information about the interfaces within the domain. The typed
diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c
index 0df1732a56..a637c36170 100644
--- a/src/qemu/qemu_driver.c
+++ b/src/qemu/qemu_driver.c
@@ -19215,20 +19215,23 @@ qemuAgentDiskInfoFormatParams(qemuAgentDiskInfo **info,
size_t i, j, ndeps;
if (virTypedParamsAddUInt(params, nparams, maxparams,
- "disk.count", ndisks) < 0)
+ VIR_DOMAIN_GUEST_INFO_DISK_COUNT,
+ ndisks) < 0)
return;
for (i = 0; i < ndisks; i++) {
char param_name[VIR_TYPED_PARAM_FIELD_LENGTH];
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.name", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_NAME, i);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, info[i]->name) < 0)
return;
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.partition", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_PARTITION, i);
if (virTypedParamsAddBoolean(params, nparams, maxparams,
param_name, info[i]->partition) < 0)
return;
@@ -19236,14 +19239,17 @@ qemuAgentDiskInfoFormatParams(qemuAgentDiskInfo **info,
if (info[i]->dependencies) {
ndeps = g_strv_length(info[i]->dependencies);
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.dependency.count", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_COUNT, i);
if (ndeps &&
virTypedParamsAddUInt(params, nparams, maxparams,
param_name, ndeps) < 0)
return;
for (j = 0; j < ndeps; j++) {
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.dependency.%zu.name", i, j);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_DEPENDENCY_SUFFIX_NAME, i, j);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, info[i]->dependencies[j]) < 0)
return;
@@ -19256,7 +19262,8 @@ qemuAgentDiskInfoFormatParams(qemuAgentDiskInfo **info,
if (address->serial) {
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.serial", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_SERIAL, i);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, address->serial) < 0)
return;
@@ -19271,7 +19278,8 @@ qemuAgentDiskInfoFormatParams(qemuAgentDiskInfo **info,
address->unit);
if (diskdef) {
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.alias", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_ALIAS, i);
if (diskdef->dst &&
virTypedParamsAddString(params, nparams, maxparams,
param_name, diskdef->dst) < 0)
@@ -19281,7 +19289,8 @@ qemuAgentDiskInfoFormatParams(qemuAgentDiskInfo **info,
if (info[i]->alias) {
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "disk.%zu.guest_alias", i);
+ VIR_DOMAIN_GUEST_INFO_DISK_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_GUEST_ALIAS, i);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, info[i]->alias) < 0)
return;
--
2.48.1
