From nobody Tue May 7 06:02:32 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569445340; cv=none; d=zoho.com; s=zohoarc; b=KhxjkegoXkNr6gopSQjD6gyU1tgSlF6/g2zU+87E+mt2bsAZBrnANIUIxUwB0PxWT1qFHbQtyqlDnVFeYE7aNbWXCAMvVxe6aupaz6TxLPW5oOJpPKY254YPk6nEJQa1CdeWE0LJhEG7kuAM9lmK3uY2tUERV1IW8clW1Q44GcU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569445340; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=6ivyX44Sqkfbw8+bWYMb6Q4il4y6ZTXoSPJ6efLaiQw=; b=fqk6L177OtwwVoIVlU9FNQt2AVp5VBUb17UTKEu4ITg7p693vshIg30Uunf5terumnLeLe3Jaq5+iLXjwd39ifO2LtpfLNhsCTvUpEJhSDLBiRV9Jncd6byDWVJKeUKCBP+jqk9/sQd+e4Q3mIf3uVqql2jN6kuuOGrfSQZPHxo= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569445340197500.0756917147319; Wed, 25 Sep 2019 14:02:20 -0700 (PDT) Received: from localhost ([::1]:57320 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDEQS-0006Jk-El for importer@patchew.org; Wed, 25 Sep 2019 17:02:16 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46642) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDEOm-0004Vy-1h for qemu-devel@nongnu.org; Wed, 25 Sep 2019 17:00:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDEOi-0008PC-1p for qemu-devel@nongnu.org; Wed, 25 Sep 2019 17:00:29 -0400 Received: from mx1.redhat.com ([209.132.183.28]:39020) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDEOh-0008Mj-QI for qemu-devel@nongnu.org; Wed, 25 Sep 2019 17:00:28 -0400 Received: from mail-wm1-f70.google.com (mail-wm1-f70.google.com [209.85.128.70]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 17FBFC01B7E2 for ; Wed, 25 Sep 2019 21:00:22 +0000 (UTC) Received: by mail-wm1-f70.google.com with SMTP id 4so18790wmj.6 for ; Wed, 25 Sep 2019 14:00:22 -0700 (PDT) Received: from auriga.brq.redhat.com (nat-pool-brq-t.redhat.com. [213.175.37.10]) by smtp.gmail.com with ESMTPSA id j1sm472889wrg.24.2019.09.25.14.00.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Sep 2019 14:00:19 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=hxB3RT155dg866dOIbs6ijaJLT3zTDnOtRgU/lBPKiY=; b=ZZRanB3PfTLxm2bi3hpkMVf285oj2OSVbiLhjfmjDS4muEA7AYsh9crJG9kdupZZCw z/THSGXutBKpsarOlbz05TZTNO3fTQ/Du38Doog1KAC4+4GYpqEIucPFrfsUEH3oqqh7 MWhPDzHtSrK3Mb21h3hkWOFzTXAbKWrCKwFg2gDwew0uhydM3CrIJmRhSsdCZmuFj1qY 0VqtjOTldnMcjiRMq26ku+Ov9O9vNMekbMpeu+R1aUtNcWc7/9V9RpaolWabHBdv06Kx SHzJb5S+ByK3SHj8ShWiw+2YGvuCTjQQ7QqiXscXiNBM1MRd91O//Hyz5BD4waOZfa1Z eyqA== X-Gm-Message-State: APjAAAW+c9o27T74UiAU5W2Urhnlxc9UbfUVvUyos/yBy+Hk20klslAL Ubp/C0qyRrFwx6W8Wh9mL+FSfmOia82hkKa9pag4rUCsjhHGG1+ZadxXxDApH73BpIHp2cjKxjT OlwTBCXDGs+t9/LQ= X-Received: by 2002:adf:fc0e:: with SMTP id i14mr221818wrr.302.1569445220368; Wed, 25 Sep 2019 14:00:20 -0700 (PDT) X-Google-Smtp-Source: APXvYqwXPDCKpNVp2dTnTeOsodRsbX0C+Q0cEzoAIjtye0pjntb9EpEL60FiWE+8h9Iq9p1YST13qw== X-Received: by 2002:adf:fc0e:: with SMTP id i14mr221805wrr.302.1569445220041; Wed, 25 Sep 2019 14:00:20 -0700 (PDT) From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Golembiovsk=C3=BD?= To: qemu-devel@nongnu.org Subject: [PATCH v3] qga: add command guest-get-devices for reporting VirtIO devices Date: Wed, 25 Sep 2019 23:00:18 +0200 Message-Id: <919bbd6e0557d2fe2d9c17de394cc0b4c6fa4426.1569445204.git.tgolembi@redhat.com> X-Mailer: git-send-email 2.23.0 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , =?UTF-8?q?Tom=C3=A1=C5=A1=20Golembiovsk=C3=BD?= , Michael Roth Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Add command for reporting devices on Windows guest. The intent is not so much to report the devices but more importantly the driver (and its version) that is assigned to the device. This gives caller the information whether VirtIO drivers are installed and/or whether inadequate driver is used on a device (e.g. QXL device with base VGA driver). Signed-off-by: Tom=C3=A1=C5=A1 Golembiovsk=C3=BD Reviewed-by: Marc-Andr=C3=A9 Lureau --- qga/commands-posix.c | 9 ++ qga/commands-win32.c | 204 ++++++++++++++++++++++++++++++++++++++++++- qga/qapi-schema.json | 32 +++++++ 3 files changed, 244 insertions(+), 1 deletion(-) diff --git a/qga/commands-posix.c b/qga/commands-posix.c index dfc05f5b8a..58e93feef9 100644 --- a/qga/commands-posix.c +++ b/qga/commands-posix.c @@ -2757,6 +2757,8 @@ GList *ga_command_blacklist_init(GList *blacklist) blacklist =3D g_list_append(blacklist, g_strdup("guest-fstrim")); #endif =20 + blacklist =3D g_list_append(blacklist, g_strdup("guest-get-devices")); + return blacklist; } =20 @@ -2977,3 +2979,10 @@ GuestOSInfo *qmp_guest_get_osinfo(Error **errp) =20 return info; } + +GuestDeviceInfoList *qmp_guest_get_devices(Error **errp) +{ + error_setg(errp, QERR_UNSUPPORTED); + + return NULL; +} diff --git a/qga/commands-win32.c b/qga/commands-win32.c index 6b67f16faf..139dbd7c9a 100644 --- a/qga/commands-win32.c +++ b/qga/commands-win32.c @@ -21,10 +21,11 @@ #ifdef CONFIG_QGA_NTDDSCSI #include #include +#endif #include #include #include -#endif +#include #include #include #include @@ -38,6 +39,36 @@ #include "qemu/host-utils.h" #include "qemu/base64.h" =20 +/* + * The following should be in devpkey.h, but it isn't. The key names were + * prefixed to avoid (future) name clashes. Once the definitions get into + * mingw the following lines can be removed. + */ +DEFINE_DEVPROPKEY(qga_DEVPKEY_NAME, 0xb725f130, 0x47ef, 0x101a, 0xa5, + 0xf1, 0x02, 0x60, 0x8c, 0x9e, 0xeb, 0xac, 10); + /* DEVPROP_TYPE_STRING */ +DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_HardwareIds, 0xa45c254e, 0xdf1c, + 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 3); + /* DEVPROP_TYPE_STRING_LIST */ +DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverDate, 0xa8b865dd, 0x2e3d, + 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 2); + /* DEVPROP_TYPE_FILETIME */ +DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverVersion, 0xa8b865dd, 0x2e3d, + 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 3); + /* DEVPROP_TYPE_STRING */ +/* The following shoud be in cfgmgr32.h, but it isn't */ +#ifndef CM_Get_DevNode_Property +CMAPI CONFIGRET WINAPI CM_Get_DevNode_PropertyW( + DEVINST dnDevInst, + CONST DEVPROPKEY * PropertyKey, + DEVPROPTYPE * PropertyType, + PBYTE PropertyBuffer, + PULONG PropertyBufferSize, + ULONG ulFlags +); +#define CM_Get_DevNode_Property CM_Get_DevNode_PropertyW +#endif + #ifndef SHTDN_REASON_FLAG_PLANNED #define SHTDN_REASON_FLAG_PLANNED 0x80000000 #endif @@ -92,6 +123,8 @@ static OpenFlags guest_file_open_modes[] =3D { g_free(suffix); \ } while (0) =20 +G_DEFINE_AUTOPTR_CLEANUP_FUNC(GuestDeviceInfo, qapi_free_GuestDeviceInfo) + static OpenFlags *find_open_flag(const char *mode_str) { int mode; @@ -2234,3 +2267,172 @@ GuestOSInfo *qmp_guest_get_osinfo(Error **errp) =20 return info; } + +/* + * Safely get device property. Returned strings are using wide characters. + * Caller is responsible for freeing the buffer. + */ +static LPBYTE cm_get_property(DEVINST devInst, const DEVPROPKEY *propName, + PDEVPROPTYPE propType) +{ + CONFIGRET cr; + g_autofree LPBYTE buffer =3D NULL; + ULONG buffer_len =3D 0; + + /* First query for needed space */ + cr =3D CM_Get_DevNode_PropertyW(devInst, propName, propType, + buffer, &buffer_len, 0); + if (cr !=3D CR_SUCCESS && cr !=3D CR_BUFFER_SMALL) { + + slog("failed to get property size, error=3D0x%lx", cr); + return NULL; + } + buffer =3D g_new0(BYTE, buffer_len + 1); + cr =3D CM_Get_DevNode_PropertyW(devInst, propName, propType, + buffer, &buffer_len, 0); + if (cr !=3D CR_SUCCESS) { + slog("failed to get device property, error=3D0x%lx", cr); + return NULL; + } + return g_steal_pointer(&buffer); +} + +static GStrv ga_get_hardware_ids(DEVINST devInstance) +{ + GStrv hw_ids =3D NULL; + GArray *values =3D NULL; + DEVPROPTYPE cm_type; + LPWSTR id; + g_autofree LPWSTR property =3D (LPWSTR)cm_get_property(devInstance, + &qga_DEVPKEY_Device_HardwareIds, &cm_type); + if (property =3D=3D NULL) { + slog("failed to get hardware IDs"); + return NULL; + } + if (*property =3D=3D '\0') { + /* empty list */ + return NULL; + } + values =3D g_array_new(TRUE, TRUE, sizeof(gchar*)); + for (id =3D property; '\0' !=3D *id; id +=3D lstrlenW(id) + 1) { + gchar* id8 =3D g_utf16_to_utf8(id, -1, NULL, NULL, NULL); + g_array_append_val(values, id8); + } + hw_ids =3D (GStrv)g_array_free(values, FALSE); + values =3D NULL; + return hw_ids; +} + +/* + * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/ident= ifiers-for-pci-devices + */ +#define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)" + +GuestDeviceInfoList *qmp_guest_get_devices(Error **errp) +{ + GuestDeviceInfoList *head =3D NULL, *cur_item =3D NULL, *item =3D NULL; + HDEVINFO dev_info =3D INVALID_HANDLE_VALUE; + SP_DEVINFO_DATA dev_info_data; + int i, j; + GError *gerr =3D NULL; + g_autoptr(GRegex) device_pci_re =3D NULL; + DEVPROPTYPE cm_type; + + device_pci_re =3D g_regex_new(DEVICE_PCI_RE, + G_REGEX_ANCHORED | G_REGEX_OPTIMIZE, 0, + &gerr); + g_assert(device_pci_re !=3D NULL); + + dev_info_data.cbSize =3D sizeof(SP_DEVINFO_DATA); + dev_info =3D SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT | DIGCF_ALLCLA= SSES); + if (dev_info =3D=3D INVALID_HANDLE_VALUE) { + error_setg(errp, "failed to get device tree"); + return NULL; + } + + slog("enumerating devices"); + for (i =3D 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++)= { + bool skip =3D true; + SYSTEMTIME utc_date; + g_autofree LPWSTR name =3D NULL; + g_autofree LPFILETIME date =3D NULL; + g_autofree LPWSTR version =3D NULL; + g_auto(GStrv) hw_ids =3D NULL; + g_autoptr(GuestDeviceInfo) device =3D g_new0(GuestDeviceInfo, 1); + g_autofree char *vendor_id =3D NULL; + g_autofree char *device_id =3D NULL; + + name =3D (LPWSTR)cm_get_property(dev_info_data.DevInst, + &qga_DEVPKEY_NAME, &cm_type); + if (name =3D=3D NULL) { + slog("failed to get device description"); + continue; + } + device->driver_name =3D g_utf16_to_utf8(name, -1, NULL, NULL, NULL= ); + if (device->driver_name =3D=3D NULL) { + error_setg(errp, "conversion to utf8 failed (driver name)"); + goto out; + } + slog("querying device: %s", device->driver_name); + hw_ids =3D ga_get_hardware_ids(dev_info_data.DevInst); + if (hw_ids =3D=3D NULL) { + continue; + } + for (j =3D 0; hw_ids[j] !=3D NULL; j++) { + GMatchInfo *match_info; + if (!g_regex_match(device_pci_re, hw_ids[j], 0, &match_info)) { + continue; + } + skip =3D false; + vendor_id =3D g_match_info_fetch(match_info, 1); + device_id =3D g_match_info_fetch(match_info, 2); + device->vendor_id =3D g_ascii_strtoull(vendor_id, NULL, 16); + device->device_id =3D g_ascii_strtoull(device_id, NULL, 16); + g_match_info_free(match_info); + } + if (skip) { + continue; + } + + version =3D (LPWSTR)cm_get_property(dev_info_data.DevInst, + &qga_DEVPKEY_Device_DriverVersion, &cm_type); + if (version =3D=3D NULL) { + slog("failed to get driver version"); + continue; + } + device->driver_version =3D g_utf16_to_utf8(version, -1, NULL, + NULL, NULL); + if (device->driver_version =3D=3D NULL) { + error_setg(errp, "conversion to utf8 failed (driver version)"); + goto out; + } + + date =3D (LPFILETIME)cm_get_property(dev_info_data.DevInst, + &qga_DEVPKEY_Device_DriverDate, &cm_type); + if (date =3D=3D NULL) { + slog("failed to get driver date"); + continue; + } + FileTimeToSystemTime(date, &utc_date); + device->driver_date =3D g_strdup_printf("%04d-%02d-%02d", + utc_date.wYear, utc_date.wMonth, utc_date.wDay); + + slog("driver: %s\ndriver version: %s,%s\n", device->driver_name, + device->driver_date, device->driver_version); + item =3D g_new0(GuestDeviceInfoList, 1); + item->value =3D g_steal_pointer(&device); + if (!cur_item) { + head =3D cur_item =3D item; + } else { + cur_item->next =3D item; + cur_item =3D item; + } + continue; + } + +out: + if (dev_info !=3D INVALID_HANDLE_VALUE) { + SetupDiDestroyDeviceInfoList(dev_info); + } + return head; +} diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index fb4605cc19..fe04ff2f39 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -1242,3 +1242,35 @@ ## { 'command': 'guest-get-osinfo', 'returns': 'GuestOSInfo' } + +## +# @GuestDeviceInfo: +# +# @vendor-id: vendor ID +# @device-id: device ID +# @driver-name: name of the associated driver +# @driver-date: driver release date in format YYYY-MM-DD +# @driver-version: driver version +# +# Since: 4.2 +## +{ 'struct': 'GuestDeviceInfo', + 'data': { + 'vendor-id': 'uint16', + 'device-id': 'uint16', + 'driver-name': 'str', + 'driver-date': 'str', + 'driver-version': 'str' + } } + +## +# @guest-get-devices: +# +# Retrieve information about device drivers in Windows guest +# +# Returns: @GuestDeviceInfo +# +# Since: 4.2 +## +{ 'command': 'guest-get-devices', + 'returns': ['GuestDeviceInfo'] } --=20 2.23.0