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 | 88 ++++++++++++++++++++++++++++++++
src/libvirt-domain.c | 13 ++---
src/qemu/qemu_driver.c | 24 ++++++---
3 files changed, 108 insertions(+), 17 deletions(-)
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 002996b18c..1d988daf96 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -6833,6 +6833,94 @@ int virDomainSetLaunchSecurityState(virDomainPtr domain,
*/
#define VIR_DOMAIN_GUEST_INFO_DISK_SUFFIX_GUEST_ALIAS ".guest_alias"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_COUNT:
+ *
+ * The number of interfaces defined on this domain as an unsigned int.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_COUNT "if.count"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_PREFIX:
+ *
+ * The parameter name prefix to access each interface entry. Concatenate the
+ * prefix, the entry number formatted as an unsigned integer and one of the
+ * interface suffix parameters to form a complete parameter name.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_PREFIX "if."
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_NAME:
+ *
+ * Name in the guest (e.g. ``eth0``) for the interface as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_NAME ".name"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_HWADDR:
+ *
+ * Hardware address in the guest of the interface as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_HWADDR ".hwaddr"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_COUNT:
+ *
+ * The number of IP addresses of interface as an unsigned int.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_COUNT ".addr.count"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_PREFIX:
+ *
+ * The parameter name prefix to access each address entry. Concatenate the
+ * interface prefix, the interface entry number formatted as an unsigned
+ * integer, the address prefix, the address entry number formatted as an
+ * unsigned integer and one of the address suffix parameters to form a
+ * complete parameter name.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_PREFIX ".addr."
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_TYPE:
+ *
+ * The IP address type (e.g. ipv4) as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_TYPE ".type"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_ADDR:
+ *
+ * The IP address as a string.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_ADDR ".addr"
+
+/**
+ * VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_PREFIX:
+ *
+ * The prefix of IP address as an unsigned int.
+ *
+ * Since: 11.2.0
+ */
+#define VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_PREFIX ".prefix"
+
/**
* virDomainGuestInfoTypes:
*
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 097d628c7b..b945f22efe 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -13230,16 +13230,9 @@ virDomainSetVcpu(virDomainPtr domain,
* keys.
*
* VIR_DOMAIN_GUEST_INFO_INTERFACES:
- * Returns information about the interfaces within the domain. The typed
- * parameter keys are in this format:
- *
- * "if.count" - the number of interfaces defined on this domain
- * "if.<num>.name" - name in the guest (e.g. ``eth0``) for interface <num>
- * "if.<num>.hwaddr" - hardware address in the guest for interface <num>
- * "if.<num>.addr.count - the number of IP addresses of interface <num>
- * "if.<num>.addr.<num1>.type" - the IP address type of addr <num1> (e.g. ipv4)
- * "if.<num>.addr.<num1>.addr" - the IP address of addr <num1>
- * "if.<num>.addr.<num1>.prefix" - the prefix of IP address of addr <num1>
+ * Returns information about the interfaces within the domain.
+ * The VIR_DOMAIN_GUEST_INFO_IF_* constants define the known typed parameter
+ * keys.
*
* Using 0 for @types returns all information groups supported by the given
* hypervisor.
diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c
index a637c36170..b091e3f850 100644
--- a/src/qemu/qemu_driver.c
+++ b/src/qemu/qemu_driver.c
@@ -19411,26 +19411,30 @@ virDomainInterfaceFormatParams(virDomainInterfacePtr *ifaces,
size_t j;
if (virTypedParamsAddUInt(params, nparams, maxparams,
- "if.count", nifaces) < 0)
+ VIR_DOMAIN_GUEST_INFO_IF_COUNT,
+ nifaces) < 0)
return;
for (i = 0; i < nifaces; i++) {
char param_name[VIR_TYPED_PARAM_FIELD_LENGTH];
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.name", i);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_NAME, i);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, ifaces[i]->name) < 0)
return;
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.hwaddr", i);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_HWADDR, i);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, ifaces[i]->hwaddr) < 0)
return;
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.addr.count", i);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_COUNT, i);
if (virTypedParamsAddUInt(params, nparams, maxparams,
param_name, ifaces[i]->naddrs) < 0)
return;
@@ -19448,19 +19452,25 @@ virDomainInterfaceFormatParams(virDomainInterfacePtr *ifaces,
}
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.addr.%zu.type", i, j);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_TYPE, i, j);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, type) < 0)
return;
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.addr.%zu.addr", i, j);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_ADDR, i, j);
if (virTypedParamsAddString(params, nparams, maxparams,
param_name, ifaces[i]->addrs[j].addr) < 0)
return;
g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH,
- "if.%zu.addr.%zu.prefix", i, j);
+ VIR_DOMAIN_GUEST_INFO_IF_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_PREFIX "%zu"
+ VIR_DOMAIN_GUEST_INFO_IF_SUFFIX_ADDR_SUFFIX_PREFIX, i, j);
if (virTypedParamsAddUInt(params, nparams, maxparams,
param_name, ifaces[i]->addrs[j].prefix) < 0)
return;
--
2.48.1
