tests: Add a simple device_del test for PCI devices
PATCH 1/1 tests: Add a simple device_del test for PCI devices
The issue with testing asynchronous unplug requests it that they usually require a running guest to handle the request. However, to test if unplug of PCI devices works, we can apply a nice little trick on some architectures:
On system reset, x86 ACPI, s390x and spapr will perform the unplug, resulting in the device of interest to get deleted and a DEVICE_DELETED event getting sent.
On s390x, we still get a warning
qemu-system-s390x: -device virtio-mouse-pci,id=dev0:
warning: Plugging a PCI/zPCI device without the 'zpci' CPU feature enabled; the guest will not be able to see/use this device
This will be fixed soon, when we enable the zpci CPU feature always (Conny already has a patch for this queued).
--- tests/Makefile.include | 4 ++ tests/device_del-test.c | 103 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 tests/device_del-test.c
tests/Makefile.include +4 -0
@@ -192,6 +192,7 @@ check-qtest-i386-$(CONFIG_ISA_IPMI_KCS) += tests/ipmi-kcs-test$(EXESUF) # check-qtest-i386-$(CONFIG_ISA_IPMI_BT) += tests/ipmi-bt-test$(EXESUF) check-qtest-i386-y += tests/i440fx-test$(EXESUF) check-qtest-i386-y += tests/fw_cfg-test$(EXESUF) +check-qtest-i386-y += tests/device_del-test$(EXESUF) check-qtest-i386-y += tests/drive_del-test$(EXESUF) check-qtest-i386-$(CONFIG_WDT_IB700) += tests/wdt_ib700-test$(EXESUF) check-qtest-i386-y += tests/tco-test$(EXESUF)
@@ -256,6 +257,7 @@ check-qtest-ppc-$(CONFIG_M48T59) += tests/m48t59-test$(EXESUF) check-qtest-ppc64-y += $(check-qtest-ppc-y) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/spapr-phb-test$(EXESUF) +check-qtest-ppc64-$(CONFIG_PSERIES) += tests/device_del-test$(EXESUF) check-qtest-ppc64-$(CONFIG_POWERNV) += tests/pnv-xscom-test$(EXESUF) check-qtest-ppc64-y += tests/migration-test$(EXESUF) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/rtas-test$(EXESUF)
@@ -310,6 +312,7 @@ check-qtest-s390x-$(CONFIG_SLIRP) += tests/test-netfilter$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-mirror$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-redirector$(EXESUF) check-qtest-s390x-y += tests/drive_del-test$(EXESUF) +check-qtest-s390x-y += tests/device_del-test$(EXESUF) check-qtest-s390x-y += tests/virtio-ccw-test$(EXESUF) check-qtest-s390x-y += tests/cpu-plug-test$(EXESUF) check-qtest-s390x-y += tests/migration-test$(EXESUF)
@@ -750,6 +753,7 @@ tests/ipoctal232-test$(EXESUF): tests/ipoctal232-test.o tests/qom-test$(EXESUF): tests/qom-test.o tests/test-hmp$(EXESUF): tests/test-hmp.o tests/machine-none-test$(EXESUF): tests/machine-none-test.o +tests/device_del-test$(EXESUF): tests/device_del-test.o tests/drive_del-test$(EXESUF): tests/drive_del-test.o $(libqos-virtio-obj-y) tests/nvme-test$(EXESUF): tests/nvme-test.o $(libqos-pc-obj-y) tests/pvpanic-test$(EXESUF): tests/pvpanic-test.o
tests/device_del-test.c new file +103 -0
103 lines not on this page · raw message
Signature · 1 line
2.17.2
Quoted 17 lines · David Hildenbrand
The issue with testing asynchronous unplug requests it that they usually require a running guest to handle the request. However, to test if unplug of PCI devices works, we can apply a nice little trick on some architectures:
On system reset, x86 ACPI, s390x and spapr will perform the unplug, resulting in the device of interest to get deleted and a
DEVICE_DELETEDevent getting sent.On s390x, we still get a warning
qemu-system-s390x: -device virtio-mouse-pci,id=dev0:
warning: Plugging a PCI/zPCI device without the 'zpci' CPU feature enabled; the guest will not be able to see/use this deviceThis will be fixed soon, when we enable the zpci CPU feature always (Conny already has a patch for this queued).
Quoted 13 lines
Cc Collin Walling <[email protected]>Cc Cornelia Huck <[email protected]>Cc Pierre Morel <[email protected]>Cc Michael S. Tsirkin <[email protected]>Cc Marcel Apfelbaum <[email protected]>Cc David Gibson <[email protected]>Cc Greg Kurz <[email protected]>Cc Igor Mammedov <[email protected]>Cc Eduardo Habkost <[email protected]>Cc Thomas Huth <[email protected]>Cc Laurent Vivier <[email protected]>Cc Paolo Bonzini <[email protected]>Signed-off-by David Hildenbrand <[email protected]>
Nice trick.
(on both x86 and ppc64le host)
Quoted 151 lines
--- tests/Makefile.include | 4 ++ tests/device_del-test.c | 103 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 tests/device_del-test.ctests/Makefile.include +4
-0@@ -192,6 +192,7 @@ check-qtest-i386-$(CONFIG_ISA_IPMI_KCS) += tests/ipmi-kcs-test$(EXESUF) # check-qtest-i386-$(CONFIG_ISA_IPMI_BT) += tests/ipmi-bt-test$(EXESUF) check-qtest-i386-y += tests/i440fx-test$(EXESUF) check-qtest-i386-y += tests/fw_cfg-test$(EXESUF) +check-qtest-i386-y += tests/device_del-test$(EXESUF) check-qtest-i386-y += tests/drive_del-test$(EXESUF) check-qtest-i386-$(CONFIG_WDT_IB700) += tests/wdt_ib700-test$(EXESUF) check-qtest-i386-y += tests/tco-test$(EXESUF)@@ -256,6 +257,7 @@ check-qtest-ppc-$(CONFIG_M48T59) += tests/m48t59-test$(EXESUF) check-qtest-ppc64-y += $(check-qtest-ppc-y) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/spapr-phb-test$(EXESUF) +check-qtest-ppc64-$(CONFIG_PSERIES) += tests/device_del-test$(EXESUF) check-qtest-ppc64-$(CONFIG_POWERNV) += tests/pnv-xscom-test$(EXESUF) check-qtest-ppc64-y += tests/migration-test$(EXESUF) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/rtas-test$(EXESUF)@@ -310,6 +312,7 @@ check-qtest-s390x-$(CONFIG_SLIRP) += tests/test-netfilter$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-mirror$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-redirector$(EXESUF) check-qtest-s390x-y += tests/drive_del-test$(EXESUF) +check-qtest-s390x-y += tests/device_del-test$(EXESUF) check-qtest-s390x-y += tests/virtio-ccw-test$(EXESUF) check-qtest-s390x-y += tests/cpu-plug-test$(EXESUF) check-qtest-s390x-y += tests/migration-test$(EXESUF)@@ -750,6 +753,7 @@ tests/ipoctal232-test$(EXESUF): tests/ipoctal232-test.o tests/qom-test$(EXESUF): tests/qom-test.o tests/test-hmp$(EXESUF): tests/test-hmp.o tests/machine-none-test$(EXESUF): tests/machine-none-test.o +tests/device_del-test$(EXESUF): tests/device_del-test.o tests/drive_del-test$(EXESUF): tests/drive_del-test.o $(libqos-virtio-obj-y) tests/nvme-test$(EXESUF): tests/nvme-test.o $(libqos-pc-obj-y) tests/pvpanic-test$(EXESUF): tests/pvpanic-test.otests/device_del-test.c new file +103
-0@@ -0,0 +1,103 @@ +/* +* QEMU device_del handling +* +* Copyright (C) 2019 Red Hat Inc. +* +* Authors: +* David Hildenbrand <[email protected]> +* +* This work is licensed under the terms of the GNU GPL, version 2 or later. +* See the COPYING file in the top-level directory. +*/ + +#include "qemu/osdep.h" +#include "libqtest.h" +#include "qapi/qmp/qdict.h" +#include "qapi/qmp/qstring.h" + +static void device_del_request (const char *id) +{ +QDict *resp; + + resp =qmp ("{'execute': 'device_del', 'arguments': { 'id': %s } }" , id); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void system_reset (void ) +{ +QDict *resp; + + resp =qmp ("{'execute': 'system_reset'}" ); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void wait_device_deleted_event (const char *id) +{ +QDict *resp, *data; +QObject *device; +QString *qstr; + +/* +* Other devices might get removed along with the removed device. Skip +* these. +*/ +for (;;) { + resp =qtest_qmp_eventwait_ref (global_qtest,"DEVICE_DELETED" ); + data =qdict_get_qdict (resp,"data" ); +if (!data) { +qobject_unref (resp); +continue ; + } + device =qdict_get (data,"device" ); +if (!device) { +qobject_unref (resp); +continue ; + } + qstr =qobject_to (QString, device); +g_assert (qstr); +if (!strcmp (qstring_get_str (qstr), id)) { +qobject_unref (data); +qobject_unref (resp); +break ; + } +qobject_unref (data); +qobject_unref (resp); + } +} + +static void test_pci_device_del_request (void ) +{ +char *args; + + args =g_strdup_printf ("-device virtio-mouse-pci,id=dev0" ); +qtest_start (args); + +/* +* Request device removal. As the guest is not running, the request won't +* be processed. However during system reset, the removal will be +* handled, removing the device. +*/ +device_del_request ("dev0" ); +system_reset (); +wait_device_deleted_event ("dev0" ); + +qtest_end (); +g_free (args); +} + +int main (int argc,char **argv) +{ +g_test_init (&argc, &argv,NULL ); + +/* +* We need a system that will process unplug requests during system resets +* and does not do PCI surprise removal. This holds for x86 ACPI, +* s390x and spapr. +*/ +qtest_add_func ("/device_del/pci_device_del_request" , + test_pci_device_del_request); + +return g_test_run (); +}
Signature · 4 lines
David Gibson | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_ | _way_ _around_! http://www.ozlabs.org/~dgibson
Quoted 8 lines · David Hildenbrand
The issue with testing asynchronous unplug requests it that they usually require a running guest to handle the request. However, to test if unplug of PCI devices works, we can apply a nice little trick on some architectures:
On system reset, x86 ACPI, s390x and spapr will perform the unplug, resulting in the device of interest to get deleted and a
DEVICE_DELETEDevent getting sent.
Good idea, and thanks for writing the test! Some comments below...
Quoted 43 lines
tests/device_del-test.c new file +37
-0@@ -0,0 +1,103 @@ +/* +* QEMU device_del handling +* +* Copyright (C) 2019 Red Hat Inc. +* +* Authors: +* David Hildenbrand <[email protected]> +* +* This work is licensed under the terms of the GNU GPL, version 2 or later. +* See the COPYING file in the top-level directory. +*/ + +#include "qemu/osdep.h" +#include "libqtest.h" +#include "qapi/qmp/qdict.h" +#include "qapi/qmp/qstring.h" + +static void device_del_request (const char *id) +{ +QDict *resp; + + resp =qmp ("{'execute': 'device_del', 'arguments': { 'id': %s } }" , id); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void system_reset (void ) +{ +QDict *resp; + + resp =qmp ("{'execute': 'system_reset'}" ); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void wait_device_deleted_event (const char *id) +{
tests/device_del-test.c line 47
Quoted 10 lines
tests/device_del-test.c new file +10
-0+QDict *resp, *data; +QObject *device; +QString *qstr; + +/* +* Other devices might get removed along with the removed device. Skip +* these. +*/ +for (;;) { + resp =qtest_qmp_eventwait_ref (global_qtest,"DEVICE_DELETED" );
Please avoid global_qtest in new code. We should get rid of that global variable in the long run - it causes trouble each time we want to re-use code in tests with multiple test instances.
Quoted 18 lines
tests/device_del-test.c new file +18
-0+ data =qdict_get_qdict (resp,"data" ); +if (!data) { +qobject_unref (resp); +continue ; + } + device =qdict_get (data,"device" ); +if (!device) { +qobject_unref (resp); +continue ; + } + qstr =qobject_to (QString, device); +g_assert (qstr); +if (!strcmp (qstring_get_str (qstr), id)) { +qobject_unref (data); +qobject_unref (resp); +break ; + } +qobject_unref (data);
tests/device_del-test.c line 75
Quoted 10 lines
tests/device_del-test.c new file +10
-0+qobject_unref (resp); + } +} + +static void test_pci_device_del_request (void ) +{ +char *args; + + args =g_strdup_printf ("-device virtio-mouse-pci,id=dev0" ); +qtest_start (args);
Please use qtest_initf() instead and pass its return value to wait_device_deleted_event(), so you can use it there instead of global_qtest.
Also there is no need for the g_strdup_printf() here - simply pass the string directly to the qtest_initf function.
Quoted 17 lines
tests/device_del-test.c new file +17
-0+/* +* Request device removal. As the guest is not running, the request won't +* be processed. However during system reset, the removal will be +* handled, removing the device. +*/ +device_del_request ("dev0" ); +system_reset (); +wait_device_deleted_event ("dev0" ); + +qtest_end (); +g_free (args); +} + +int main (int argc,char **argv) +{ +g_test_init (&argc, &argv,NULL ); +
tests/device_del-test.c line 103
Quoted 10 lines
tests/device_del-test.c new file +10
-0+/* +* We need a system that will process unplug requests during system resets +* and does not do PCI surprise removal. This holds for x86 ACPI, +* s390x and spapr. +*/ +qtest_add_func ("/device_del/pci_device_del_request" , + test_pci_device_del_request); + +return g_test_run (); +}
When you respin, could you maybe also rename the file to device-plug-test.c instead? ... I still have got some plans for some device_add tests, that would likely also be a good fit here...
Thomas
Quoted 30 lines · On Thu, 14 Feb 2019 18:11:28 +0100 David Hildenbrand <[email protected]> wrote:
The issue with testing asynchronous unplug requests it that they usually require a running guest to handle the request. However, to test if unplug of PCI devices works, we can apply a nice little trick on some architectures:
On system reset, x86 ACPI, s390x and spapr will perform the unplug, resulting in the device of interest to get deleted and a
DEVICE_DELETEDevent getting sent.On s390x, we still get a warning
qemu-system-s390x: -device virtio-mouse-pci,id=dev0:
warning: Plugging a PCI/zPCI device without the 'zpci' CPU feature enabled; the guest will not be able to see/use this deviceThis will be fixed soon, when we enable the zpci CPU feature always (Conny already has a patch for this queued).
Cc Collin Walling <[email protected]>Cc Cornelia Huck <[email protected]>Cc Pierre Morel <[email protected]>Cc Michael S. Tsirkin <[email protected]>Cc Marcel Apfelbaum <[email protected]>Cc David Gibson <[email protected]>Cc Greg Kurz <[email protected]>Cc Igor Mammedov <[email protected]>Cc Eduardo Habkost <[email protected]>Cc Thomas Huth <[email protected]>Cc Laurent Vivier <[email protected]>Cc Paolo Bonzini <[email protected]>Signed-off-by David Hildenbrand <[email protected]>
Quoted 1 line
---
Nice trick indeed, but...
Quoted 98 lines
tests/Makefile.include | 4 ++ tests/device_del-test.c | 103 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 tests/device_del-test.ctests/Makefile.include +4
-0@@ -192,6 +192,7 @@ check-qtest-i386-$(CONFIG_ISA_IPMI_KCS) += tests/ipmi-kcs-test$(EXESUF) # check-qtest-i386-$(CONFIG_ISA_IPMI_BT) += tests/ipmi-bt-test$(EXESUF) check-qtest-i386-y += tests/i440fx-test$(EXESUF) check-qtest-i386-y += tests/fw_cfg-test$(EXESUF) +check-qtest-i386-y += tests/device_del-test$(EXESUF) check-qtest-i386-y += tests/drive_del-test$(EXESUF) check-qtest-i386-$(CONFIG_WDT_IB700) += tests/wdt_ib700-test$(EXESUF) check-qtest-i386-y += tests/tco-test$(EXESUF)@@ -256,6 +257,7 @@ check-qtest-ppc-$(CONFIG_M48T59) += tests/m48t59-test$(EXESUF) check-qtest-ppc64-y += $(check-qtest-ppc-y) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/spapr-phb-test$(EXESUF) +check-qtest-ppc64-$(CONFIG_PSERIES) += tests/device_del-test$(EXESUF) check-qtest-ppc64-$(CONFIG_POWERNV) += tests/pnv-xscom-test$(EXESUF) check-qtest-ppc64-y += tests/migration-test$(EXESUF) check-qtest-ppc64-$(CONFIG_PSERIES) += tests/rtas-test$(EXESUF)@@ -310,6 +312,7 @@ check-qtest-s390x-$(CONFIG_SLIRP) += tests/test-netfilter$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-mirror$(EXESUF) check-qtest-s390x-$(CONFIG_POSIX) += tests/test-filter-redirector$(EXESUF) check-qtest-s390x-y += tests/drive_del-test$(EXESUF) +check-qtest-s390x-y += tests/device_del-test$(EXESUF) check-qtest-s390x-y += tests/virtio-ccw-test$(EXESUF) check-qtest-s390x-y += tests/cpu-plug-test$(EXESUF) check-qtest-s390x-y += tests/migration-test$(EXESUF)@@ -750,6 +753,7 @@ tests/ipoctal232-test$(EXESUF): tests/ipoctal232-test.o tests/qom-test$(EXESUF): tests/qom-test.o tests/test-hmp$(EXESUF): tests/test-hmp.o tests/machine-none-test$(EXESUF): tests/machine-none-test.o +tests/device_del-test$(EXESUF): tests/device_del-test.o tests/drive_del-test$(EXESUF): tests/drive_del-test.o $(libqos-virtio-obj-y) tests/nvme-test$(EXESUF): tests/nvme-test.o $(libqos-pc-obj-y) tests/pvpanic-test$(EXESUF): tests/pvpanic-test.otests/device_del-test.c new file +51
-0@@ -0,0 +1,103 @@ +/* +* QEMU device_del handling +* +* Copyright (C) 2019 Red Hat Inc. +* +* Authors: +* David Hildenbrand <[email protected]> +* +* This work is licensed under the terms of the GNU GPL, version 2 or later. +* See the COPYING file in the top-level directory. +*/ + +#include "qemu/osdep.h" +#include "libqtest.h" +#include "qapi/qmp/qdict.h" +#include "qapi/qmp/qstring.h" + +static void device_del_request (const char *id) +{ +QDict *resp; + + resp =qmp ("{'execute': 'device_del', 'arguments': { 'id': %s } }" , id); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void system_reset (void ) +{ +QDict *resp; + + resp =qmp ("{'execute': 'system_reset'}" ); +g_assert (qdict_haskey (resp,"return" )); +qobject_unref (resp); +} + +static void wait_device_deleted_event (const char *id) +{ +QDict *resp, *data; +QObject *device; +QString *qstr; + +/* +* Other devices might get removed along with the removed device. Skip +* these. +*/ +for (;;) { + resp =qtest_qmp_eventwait_ref (global_qtest,"DEVICE_DELETED" ); + data =qdict_get_qdict (resp,"data" ); +if (!data) { +qobject_unref (resp); +continue ;
tests/device_del-test.c line 61
Quoted 10 lines
tests/device_del-test.c new file +10
-0+ } + device =qdict_get (data,"device" ); +if (!device) { +qobject_unref (resp); +continue ; + } + qstr =qobject_to (QString, device); +g_assert (qstr); +if (!strcmp (qstring_get_str (qstr), id)) { +qobject_unref (data);
... this ^^ causes...
tests/device_del-test.c line 62
Quoted 1 line
tests/device_del-test.c new file +1
-0+qobject_unref (resp);
... this ^^ to crash with:
/ppc64/device_del/pci_device_del_request: *** Error in `tests/device_del-test': corrupted double-linked list: 0x0000010021d58c10 ***
IIUC, qobject_unref(resp) eventually calls qobject_unref(data) internally, so you shouldn't do it. If I drop the line, the test passes like a charm.
tests/device_del-test.c line 65
Quoted 3 lines
tests/device_del-test.c new file +3
-0+break ; + } +qobject_unref (data);
I couldn't have the test executing this path but I guess it has the very same problem.
Quoted 38 lines
tests/device_del-test.c new file +38
-0+qobject_unref (resp); + } +} + +static void test_pci_device_del_request (void ) +{ +char *args; + + args =g_strdup_printf ("-device virtio-mouse-pci,id=dev0" ); +qtest_start (args); + +/* +* Request device removal. As the guest is not running, the request won't +* be processed. However during system reset, the removal will be +* handled, removing the device. +*/ +device_del_request ("dev0" ); +system_reset (); +wait_device_deleted_event ("dev0" ); + +qtest_end (); +g_free (args); +} + +int main (int argc,char **argv) +{ +g_test_init (&argc, &argv,NULL ); + +/* +* We need a system that will process unplug requests during system resets +* and does not do PCI surprise removal. This holds for x86 ACPI, +* s390x and spapr. +*/ +qtest_add_func ("/device_del/pci_device_del_request" , + test_pci_device_del_request); + +return g_test_run (); +}