From: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; Signed-off-by: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; --- src/qemu/qemu_agent.c | 2 +- src/qemu/qemu_agent.h | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c index beb42449ce..ba07d6bfdf 100644 --- a/src/qemu/qemu_agent.c +++ b/src/qemu/qemu_agent.c @@ -1815,7 +1815,7 @@ qemuAgentSetTime(qemuAgentPtr agent, return ret; } -static void +void qemuAgentDiskAddressFree(qemuAgentDiskAddressPtr info) { if (!info) diff --git a/src/qemu/qemu_agent.h b/src/qemu/qemu_agent.h index 185d09aeca..62d68b165a 100644 --- a/src/qemu/qemu_agent.h +++ b/src/qemu/qemu_agent.h @@ -78,6 +78,8 @@ struct _qemuAgentDiskAddress { unsigned int unit; char *devnode; }; +void qemuAgentDiskAddressFree(qemuAgentDiskAddressPtr addr); +G_DEFINE_AUTOPTR_CLEANUP_FUNC(qemuAgentDiskAddress, qemuAgentDiskAddressFree); typedef struct _qemuAgentFSInfo qemuAgentFSInfo; typedef qemuAgentFSInfo *qemuAgentFSInfoPtr; -- 2.29.0

From: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; Signed-off-by: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; --- src/libvirt_private.syms | 1 + src/util/virjson.c | 30 ++++++++++++++++++++++++++++++ src/util/virjson.h | 1 + 3 files changed, 32 insertions(+) diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms index 79a23f34cb..0f8447cfbb 100644 --- a/src/libvirt_private.syms +++ b/src/libvirt_private.syms @@ -2408,6 +2408,7 @@ virJSONValueObjectGetNumberUint; virJSONValueObjectGetNumberUlong; virJSONValueObjectGetObject; virJSONValueObjectGetString; +virJSONValueObjectGetStringArray; virJSONValueObjectGetValue; virJSONValueObjectHasKey; virJSONValueObjectIsNull; diff --git a/src/util/virjson.c b/src/util/virjson.c index 3fa9a9ca24..05c4804410 100644 --- a/src/util/virjson.c +++ b/src/util/virjson.c @@ -1463,6 +1463,36 @@ virJSONValueObjectIsNull(virJSONValuePtr object, return virJSONValueIsNull(val); } +char ** +virJSONValueObjectGetStringArray(virJSONValuePtr object, const char *key) +{ + g_auto(GStrv) ret = NULL; + virJSONValuePtr data; + size_t n; + size_t i; + + data = virJSONValueObjectGetArray(object, key); + if (!data) + return NULL; + + n = virJSONValueArraySize(data); + ret = g_new0(char *, n + 1); + for (i = 0; i < n; i++) { + virJSONValuePtr child = virJSONValueArrayGet(data, i); + const char *tmp; + + if (!(tmp = virJSONValueGetString(child))) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("%s array element does not contain a string"), + key); + return NULL; + } + + ret[i] = g_strdup(tmp); + } + + return g_steal_pointer(&ret); +} /** * virJSONValueObjectForeachKeyValue: diff --git a/src/util/virjson.h b/src/util/virjson.h index 588c977650..4dc7ed1a2d 100644 --- a/src/util/virjson.h +++ b/src/util/virjson.h @@ -117,6 +117,7 @@ virJSONValuePtr virJSONValueObjectStealObject(virJSONValuePtr object, const char *key); const char *virJSONValueObjectGetString(virJSONValuePtr object, const char *key); +char **virJSONValueObjectGetStringArray(virJSONValuePtr object, const char *key); const char *virJSONValueObjectGetStringOrNumber(virJSONValuePtr object, const char *key); int virJSONValueObjectGetNumberInt(virJSONValuePtr object, const char *key, int *value); int virJSONValueObjectGetNumberUint(virJSONValuePtr object, const char *key, unsigned int *value); -- 2.29.0

On 11/20/20 7:09 PM, marcandre.lureau(a)redhat.com wrote: Quick git grep showed two more: qemuAgentSSHGetAuthorizedKeys() and qemuMonitorJSONGetStringListProperty(). But that can be done in a separate patch. We can ditch the @list variable and assign to *array directly. How about this squashed in: diff --git c/src/qemu/qemu_monitor_json.c i/src/qemu/qemu_monitor_json.c index 3588a0c426..e7aa6b6ffd 100644 --- c/src/qemu/qemu_monitor_json.c +++ i/src/qemu/qemu_monitor_json.c @@ -7533,7 +7533,6 @@ qemuMonitorJSONGetStringArray(qemuMonitorPtr mon, const char *qmpCmd, int ret = -1; virJSONValuePtr cmd; virJSONValuePtr reply = NULL; - g_auto(GStrv) list = NULL; *array = NULL; @@ -7551,11 +7550,10 @@ qemuMonitorJSONGetStringArray(qemuMonitorPtr mon, const char *qmpCmd, if (qemuMonitorJSONCheckReply(cmd, reply, VIR_JSON_TYPE_ARRAY) < 0) goto cleanup; - list = virJSONValueObjectGetStringArray(reply, "return"); - if (!list) + if (!(*array = virJSONValueObjectGetStringArray(reply, "return"))) goto cleanup; - ret = g_strv_length(list); - *array = g_steal_pointer(&list); + + ret = g_strv_length(*array); cleanup: virJSONValueFree(cmd); Michal

From: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; guest-get-disks is available since QEMU 5.2: https://wiki.qemu.org/ChangeLog/5.2#Guest_agent Note that the test response was manually edited based on a reply on my bare-metal computer. It shows partial results due to pcieport driver not being currently supported by QGA. Signed-off-by: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; --- src/qemu/qemu_agent.c | 91 ++++++++++++++++++++++++++++++++++ src/qemu/qemu_agent.h | 15 ++++++ tests/qemuagenttest.c | 111 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c index 31f26eedd1..8698e5cfaf 100644 --- a/src/qemu/qemu_agent.c +++ b/src/qemu/qemu_agent.c @@ -1827,6 +1827,21 @@ qemuAgentDiskAddressFree(qemuAgentDiskAddressPtr info) g_free(info); } + +void +qemuAgentDiskInfoFree(qemuAgentDiskInfoPtr info) +{ + if (!info) + return; + + g_free(info->name); + g_strfreev(info->dependencies); + qemuAgentDiskAddressFree(info->address); + g_free(info->alias); + g_free(info); +} + + void qemuAgentFSInfoFree(qemuAgentFSInfoPtr info) { @@ -2640,3 +2655,79 @@ qemuAgentSSHRemoveAuthorizedKeys(qemuAgentPtr agent, return qemuAgentCommand(agent, cmd, &reply, agent->timeout); } + + +int qemuAgentGetDisks(qemuAgentPtr agent, + qemuAgentDiskInfoPtr **disks, + bool report_unsupported) +{ + g_autoptr(virJSONValue) cmd = NULL; + g_autoptr(virJSONValue) reply = NULL; + virJSONValuePtr data = NULL; + size_t ndata; + size_t i; + + if (!(cmd = qemuAgentMakeCommand("guest-get-disks", NULL))) + return -1; + + if (qemuAgentCommandFull(agent, cmd, &reply, agent->timeout, + report_unsupported) < 0) + return -1; + + if (!(data = virJSONValueObjectGetArray(reply, "return"))) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("qemu agent didn't return an array of disks")); + return -1; + } + + ndata = virJSONValueArraySize(data); + + *disks = g_new0(qemuAgentDiskInfoPtr, ndata); + + for (i = 0; i < ndata; i++) { + virJSONValuePtr addr; + virJSONValuePtr entry = virJSONValueArrayGet(data, i); + qemuAgentDiskInfoPtr disk; + + if (!entry) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("array element missing in guest-get-disks return " + "value")); + goto error; + } + + disk = g_new0(qemuAgentDiskInfo, 1); + (*disks)[i] = disk; + + disk->name = g_strdup(virJSONValueObjectGetString(entry, "name")); + if (!disk->name) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("'name' missing in reply of guest-get-disks")); + goto error; + } + + if (virJSONValueObjectGetBoolean(entry, "partition", &disk->partition) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("'partition' missing in reply of guest-get-disks")); + goto error; + } + + disk->dependencies = virJSONValueObjectGetStringArray(entry, "dependencies"); + disk->alias = g_strdup(virJSONValueObjectGetString(entry, "alias")); + addr = virJSONValueObjectGetObject(entry, "address"); + if (addr) { + disk->address = qemuAgentGetDiskAddress(addr); + if (!disk->address) + goto error; + } + } + + return ndata; + + error: + for (i = 0; i < ndata; i++) { + qemuAgentDiskInfoFree((*disks)[i]); + } + g_free(*disks); + return -1; +} diff --git a/src/qemu/qemu_agent.h b/src/qemu/qemu_agent.h index 62d68b165a..74f1410760 100644 --- a/src/qemu/qemu_agent.h +++ b/src/qemu/qemu_agent.h @@ -81,6 +81,17 @@ struct _qemuAgentDiskAddress { void qemuAgentDiskAddressFree(qemuAgentDiskAddressPtr addr); G_DEFINE_AUTOPTR_CLEANUP_FUNC(qemuAgentDiskAddress, qemuAgentDiskAddressFree); +typedef struct _qemuAgentDiskInfo qemuAgentDiskInfo; +typedef qemuAgentDiskInfo *qemuAgentDiskInfoPtr; +struct _qemuAgentDiskInfo { + char *name; + bool partition; + char **dependencies; + qemuAgentDiskAddressPtr address; + char *alias; +}; +void qemuAgentDiskInfoFree(qemuAgentDiskInfoPtr info); + typedef struct _qemuAgentFSInfo qemuAgentFSInfo; typedef qemuAgentFSInfo *qemuAgentFSInfoPtr; struct _qemuAgentFSInfo { @@ -187,3 +198,7 @@ int qemuAgentSSHRemoveAuthorizedKeys(qemuAgentPtr agent, const char *user, const char **keys, size_t nkeys); + +int qemuAgentGetDisks(qemuAgentPtr mon, + qemuAgentDiskInfoPtr **disks, + bool report_unsupported); diff --git a/tests/qemuagenttest.c b/tests/qemuagenttest.c index 47ff92733a..bf295496e1 100644 --- a/tests/qemuagenttest.c +++ b/tests/qemuagenttest.c @@ -1022,6 +1022,116 @@ testQemuAgentGetInterfaces(const void *data) return ret; } + +/* this is a bit of a pathological response on a real hw */ +static const char testQemuAgentGetDisksResponse[] = + "{\"return\": " + " [" + " {\"alias\" : \"fedora_localhost--live-home\"," + " \"dependencies\" : " + " [" + " \"/dev/dm-0\"" + " ]," + " \"name\" : \"/dev/dm-3\"," + " \"partition\" : false" + " }," + " {\"address\" : " + " {\"bus\" : 0," + " \"bus-type\" : \"unknown\"," + " \"dev\" : \"/dev/nvme0n1\"," + " \"pci-controller\" : " + " {\"bus\" : -1," + " \"domain\" : -1," + " \"function\" : -1," + " \"slot\" : -1" + " }," + " \"serial\" : \"GIGABYTE GP-ASM2NE6100TTTD_SN202208900567\"," + " \"target\" : 0," + " \"unit\" : 0" + " }," + " \"dependencies\" : []," + " \"name\" : \"/dev/nvme0n1\"," + " \"partition\" : false" + " }" + " ]" + "}"; + +static int +testQemuAgentGetDisks(const void *data) +{ + virDomainXMLOptionPtr xmlopt = (virDomainXMLOptionPtr)data; + qemuMonitorTestPtr test = qemuMonitorTestNewAgent(xmlopt); + size_t i; + int ret = -1; + int disks_count = 0; + qemuAgentDiskInfoPtr *disks = NULL; + + if (!test) + return -1; + + if (qemuMonitorTestAddAgentSyncResponse(test) < 0) + goto cleanup; + + if (qemuMonitorTestAddItem(test, "guest-get-disks", + testQemuAgentGetDisksResponse) < 0) + goto cleanup; + + if ((disks_count = qemuAgentGetDisks(qemuMonitorTestGetAgent(test), + &disks, true)) < 0) + goto cleanup; + + if (disks_count != 2) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "expected 2 disks, got %d", ret); + goto cleanup; + } + + if (STRNEQ(disks[0]->name, "/dev/dm-3") || + STRNEQ(disks[1]->name, "/dev/nvme0n1")) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "unexpected return values for disks names"); + goto cleanup; + } + + if (STRNEQ(disks[0]->alias, "fedora_localhost--live-home") || + disks[1]->alias != NULL) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "unexpected return values for disks aliases"); + goto cleanup; + } + + if (STRNEQ(disks[0]->dependencies[0], "/dev/dm-0") || + disks[0]->dependencies[1] != NULL || + disks[1]->dependencies[0] != NULL) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "unexpected return values for disks dependencies"); + goto cleanup; + } + + if (disks[0]->address != NULL || + disks[1]->address->bus != 0 || + disks[1]->address->target != 0 || + disks[1]->address->unit != 0 || + STRNEQ(disks[1]->address->serial, "GIGABYTE GP-ASM2NE6100TTTD_SN202208900567") || + STRNEQ(disks[1]->address->bus_type, "unknown")) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "unexpected return values for disks addresses"); + goto cleanup; + } + ret = 0; + + cleanup: + qemuMonitorTestFree(test); + if (disks) { + for (i = 0; i < disks_count; i++) + qemuAgentDiskInfoFree(disks[i]); + } + VIR_FREE(disks); + + return ret; +} + + static const char testQemuAgentUsersResponse[] = "{\"return\": " " [" @@ -1394,6 +1504,7 @@ mymain(void) DO_TEST(OSInfo); DO_TEST(Timezone); DO_TEST(SSHKeys); + DO_TEST(GetDisks); DO_TEST(Timeout); /* Timeout should always be called last */ -- 2.29.0

From: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; Signed-off-by: Marc-André Lureau <marcandre.lureau(a)redhat.com&gt; --- src/qemu/qemu_driver.c | 99 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 96 insertions(+), 3 deletions(-) diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index a8760f82b1..8d3e09da69 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -19820,7 +19820,8 @@ static const unsigned int qemuDomainGetGuestInfoSupportedTypes = VIR_DOMAIN_GUEST_INFO_OS | VIR_DOMAIN_GUEST_INFO_TIMEZONE | VIR_DOMAIN_GUEST_INFO_HOSTNAME | - VIR_DOMAIN_GUEST_INFO_FILESYSTEM; + VIR_DOMAIN_GUEST_INFO_FILESYSTEM | + VIR_DOMAIN_GUEST_INFO_DISKS; static int qemuDomainGetGuestInfoCheckSupport(unsigned int types, @@ -19843,6 +19844,80 @@ qemuDomainGetGuestInfoCheckSupport(unsigned int types, return 0; } + +static void +qemuAgentDiskInfoFormatParams(qemuAgentDiskInfoPtr *info, + int ndisks, + virDomainDefPtr vmdef, + virTypedParameterPtr *params, + int *nparams, int *maxparams) +{ + size_t i, j, ndeps; + + if (virTypedParamsAddUInt(params, nparams, maxparams, + "disks.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, + "disks.%zu.name", i); + if (virTypedParamsAddString(params, nparams, maxparams, + param_name, info[i]->name) < 0) + return; + + g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH, + "disks.%zu.partition", i); + if (virTypedParamsAddBoolean(params, nparams, maxparams, + param_name, info[i]->partition) < 0) + return; + + ndeps = g_strv_length(info[i]->dependencies); + g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH, + "disks.%zu.dependencies.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, + "disks.%zu.dependencies.%zu.name", i, j); + if (virTypedParamsAddString(params, nparams, maxparams, + param_name, info[i]->dependencies[j]) < 0) + return; + } + + if (info[i]->address) { + virDomainDiskDefPtr diskdef = NULL; + + /* match the disk to the target in the vm definition */ + diskdef = virDomainDiskByAddress(vmdef, + &info[i]->address->pci_controller, + info[i]->address->bus, + info[i]->address->target, + info[i]->address->unit); + if (diskdef) { + g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH, + "disks.%zu.alias", i); + if (diskdef->dst && + virTypedParamsAddString(params, nparams, maxparams, + param_name, diskdef->dst) < 0) + return; + } + } + + if (info[i]->alias) { + g_snprintf(param_name, VIR_TYPED_PARAM_FIELD_LENGTH, + "disks.%zu.guest_alias", i); + if (virTypedParamsAddString(params, nparams, maxparams, + param_name, info[i]->alias) < 0) + return; + } + } +} + + static void qemuAgentFSInfoFormatParams(qemuAgentFSInfoPtr *fsinfo, int nfs, @@ -19951,6 +20026,8 @@ qemuDomainGetGuestInfo(virDomainPtr dom, int rc; size_t nfs = 0; qemuAgentFSInfoPtr *agentfsinfo = NULL; + size_t ndisks = 0; + qemuAgentDiskInfoPtr *agentdiskinfo = NULL; size_t i; virCheckFlags(0, -1); @@ -20007,6 +20084,15 @@ qemuDomainGetGuestInfo(virDomainPtr dom, } } + if (supportedTypes & VIR_DOMAIN_GUEST_INFO_DISKS) { + rc = qemuAgentGetDisks(agent, &agentdiskinfo, report_unsupported); + if (rc == -1) { + goto exitagent; + } else if (rc >= 0) { + ndisks = rc; + } + } + ret = 0; exitagent: @@ -20015,7 +20101,7 @@ qemuDomainGetGuestInfo(virDomainPtr dom, endagentjob: qemuDomainObjEndAgentJob(vm); - if (nfs > 0) { + if (nfs > 0 || ndisks > 0) { if (qemuDomainObjBeginJob(driver, vm, QEMU_JOB_QUERY) < 0) goto cleanup; @@ -20024,7 +20110,11 @@ qemuDomainGetGuestInfo(virDomainPtr dom, /* we need to convert the agent fsinfo struct to parameters and match * it to the vm disk target */ - qemuAgentFSInfoFormatParams(agentfsinfo, nfs, vm->def, params, nparams, &maxparams); + if (nfs) + qemuAgentFSInfoFormatParams(agentfsinfo, nfs, vm->def, params, nparams, &maxparams); + + if (ndisks > 0) + qemuAgentDiskInfoFormatParams(agentdiskinfo, ndisks, vm->def, params, nparams, &maxparams); endjob: qemuDomainObjEndJob(driver, vm); @@ -20034,6 +20124,9 @@ qemuDomainGetGuestInfo(virDomainPtr dom, for (i = 0; i < nfs; i++) qemuAgentFSInfoFree(agentfsinfo[i]); g_free(agentfsinfo); + for (i = 0; i < ndisks; i++) + qemuAgentDiskInfoFree(agentdiskinfo[i]); + g_free(agentdiskinfo); virDomainObjEndAPI(&vm); return ret; -- 2.29.0

On 11/20/20 7:09 PM, marcandre.lureau(a)redhat.com wrote: Missing manpage addition. How about: diff --git i/docs/manpages/virsh.rst w/docs/manpages/virsh.rst index 86deaa486d..9ef6b68422 100644 --- i/docs/manpages/virsh.rst +++ w/docs/manpages/virsh.rst @@ -2679,6 +2679,7 @@ guestinfo :: guestinfo domain [--user] [--os] [--timezone] [--hostname] [--filesystem] + [--disks] Print information about the guest from the point of view of the guest agent. Note that this command requires a guest agent to be configured and running in @@ -2689,7 +2690,7 @@ are supported by the guest agent. You can limit the types of information that are returned by specifying one or more flags. If a requested information type is not supported, the processes will provide an exit code of 1. Available information types flags are *--user*, *--os*, -*--timezone*, *--hostname*, and *--filesystem*. +*--timezone*, *--hostname*, *--filesystem* and *--disks*. Note that depending on the hypervisor type and the version of the guest agent running within the domain, not all of the following information may be @@ -2746,6 +2747,16 @@ returned: * ``fs.<num>.disk.<num>.serial`` - the serial number of disk <num> * ``fs.<num>.disk.<num>.device`` - the device node of disk <num> +*--disks* returns: + +* ``disks.count`` - the number of disks defined on this domain +* ``disks.<num>.name`` - device node (Linux) or device UNC (Windows) +* ``disks.<num>.partition`` - whether this is a partition or disk +* ``disks.<num>.dependencies.count`` - the number of device dependencies +* ``disks.<num>.dependencies.<num>.name`` - a dependency name +* ``disks.<num>.alias`` - the device alias of the disk (e.g. sda) +* ``disks.<num>.guest_alias`` - optional alias assigned to the disk + guestvcpus ---------- Michal