* [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions
@ 2017-09-13 18:40 Thomas Huth
2017-09-14 4:30 ` Peter Xu
2017-09-19 13:38 ` Eric Blake
0 siblings, 2 replies; 5+ messages in thread
From: Thomas Huth @ 2017-09-13 18:40 UTC (permalink / raw)
To: qemu-devel, Peter Xu
Cc: Amit Shah, Paolo Bonzini, Gerd Hoffmann, Eric Blake, Markus Armbruster
A lot of tests provide code for adding and removing a device via the
device_add and device_del QMP commands. Maintaining this code in so many
places is cumbersome and error-prone (some of the code parts check the
responses for device deletion in an incorrect way, for example, we've got
to deal with both, error code and DEVICE_DEL event here). So let's provide
some proper generic functions for adding and removing a device instead.
The code for correctly unplugging a device has been taken from a patch
from Peter Xu.
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
v2:
- Use the unplug code from Peter Xu's patch
- Renamed the functions to *device_add/del instead of *hotplug/unplug
tests/libqos/pci.c | 19 ++----------
tests/libqos/usb.c | 30 ++++---------------
tests/libqtest.c | 75 ++++++++++++++++++++++++++++++++++++++++++++++
tests/libqtest.h | 19 ++++++++++++
tests/usb-hcd-uhci-test.c | 26 ++--------------
tests/usb-hcd-xhci-test.c | 51 +++----------------------------
tests/virtio-scsi-test.c | 24 ++-------------
tests/virtio-serial-test.c | 25 ++--------------
8 files changed, 113 insertions(+), 156 deletions(-)
diff --git a/tests/libqos/pci.c b/tests/libqos/pci.c
index 2dcdead..df1f98e 100644
--- a/tests/libqos/pci.c
+++ b/tests/libqos/pci.c
@@ -394,21 +394,6 @@ QPCIBar qpci_legacy_iomap(QPCIDevice *dev, uint16_t addr)
void qpci_plug_device_test(const char *driver, const char *id,
uint8_t slot, const char *opts)
{
- QDict *response;
- char *cmd;
-
- cmd = g_strdup_printf("{'execute': 'device_add',"
- " 'arguments': {"
- " 'driver': '%s',"
- " 'addr': '%d',"
- " %s%s"
- " 'id': '%s'"
- "}}", driver, slot,
- opts ? opts : "", opts ? "," : "",
- id);
- response = qmp(cmd);
- g_free(cmd);
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
+ qtest_qmp_device_add(driver, id, "'addr': '%d'%s%s", slot,
+ opts ? ", " : "", opts ? opts : "");
}
diff --git a/tests/libqos/usb.c b/tests/libqos/usb.c
index 0cdfaec..2a47604 100644
--- a/tests/libqos/usb.c
+++ b/tests/libqos/usb.c
@@ -40,34 +40,16 @@ void uhci_port_test(struct qhc *hc, int port, uint16_t expect)
void usb_test_hotplug(const char *hcd_id, const int port,
void (*port_check)(void))
{
- QDict *response;
- char *cmd;
+ char *id = g_strdup_printf("usbdev%d", port);
- cmd = g_strdup_printf("{'execute': 'device_add',"
- " 'arguments': {"
- " 'driver': 'usb-tablet',"
- " 'port': '%d',"
- " 'bus': '%s.0',"
- " 'id': 'usbdev%d'"
- "}}", port, hcd_id, port);
- response = qmp(cmd);
- g_free(cmd);
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
+ qtest_qmp_device_add("usb-tablet", id, "'port': '%d', 'bus': '%s.0'",
+ port, hcd_id);
if (port_check) {
port_check();
}
- cmd = g_strdup_printf("{'execute': 'device_del',"
- " 'arguments': {"
- " 'id': 'usbdev%d'"
- "}}", port);
- response = qmp(cmd);
- g_free(cmd);
- g_assert(response);
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
+ qtest_qmp_device_del(id);
+
+ g_free(id);
}
diff --git a/tests/libqtest.c b/tests/libqtest.c
index b9a1f18..0c12b38 100644
--- a/tests/libqtest.c
+++ b/tests/libqtest.c
@@ -987,3 +987,78 @@ void qtest_cb_for_every_machine(void (*cb)(const char *machine))
qtest_end();
QDECREF(response);
}
+
+/*
+ * Generic hot-plugging test via the device_add QMP command.
+ */
+void qtest_qmp_device_add(const char *driver, const char *id, const char *fmt,
+ ...)
+{
+ QDict *response;
+ char *cmd, *opts = NULL;
+ va_list va;
+
+ if (fmt) {
+ va_start(va, fmt);
+ opts = g_strdup_vprintf(fmt, va);
+ va_end(va);
+ }
+
+ cmd = g_strdup_printf("{'execute': 'device_add',"
+ " 'arguments': { 'driver': '%s', 'id': '%s'%s%s }}",
+ driver, id, opts ? ", " : "", opts ? opts : "");
+ g_free(opts);
+
+ response = qmp(cmd);
+ g_free(cmd);
+ g_assert(response);
+ g_assert(!qdict_haskey(response, "event")); /* We don't expect any events */
+ g_assert(!qdict_haskey(response, "error"));
+ QDECREF(response);
+}
+
+/*
+ * Generic hot-unplugging test via the device_del QMP command.
+ * Device deletion will get one response and one event. For example:
+ *
+ * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
+ *
+ * will get this one:
+ *
+ * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
+ * "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
+ * "path": "/machine/peripheral/scsi-hd"}}
+ *
+ * and this one:
+ *
+ * {"return": {}}
+ *
+ * But the order of arrival may vary - so we've got to detect both.
+ */
+void qtest_qmp_device_del(const char *id)
+{
+ QDict *response1, *response2, *event = NULL;
+ char *cmd;
+
+ cmd = g_strdup_printf("{'execute': 'device_del',"
+ " 'arguments': { 'id': '%s' }}", id);
+ response1 = qmp(cmd);
+ g_free(cmd);
+ g_assert(response1);
+ g_assert(!qdict_haskey(response1, "error"));
+
+ response2 = qmp("");
+ g_assert(response2);
+ g_assert(!qdict_haskey(response2, "error"));
+
+ if (qdict_haskey(response1, "event")) {
+ event = response1;
+ } else if (qdict_haskey(response2, "event")) {
+ event = response2;
+ }
+ g_assert(event);
+ g_assert_cmpstr(qdict_get_str(event, "event"), ==, "DEVICE_DELETED");
+
+ QDECREF(response1);
+ QDECREF(response2);
+}
diff --git a/tests/libqtest.h b/tests/libqtest.h
index 3ae5709..44803d7 100644
--- a/tests/libqtest.h
+++ b/tests/libqtest.h
@@ -927,4 +927,23 @@ QDict *qmp_fd(int fd, const char *fmt, ...);
*/
void qtest_cb_for_every_machine(void (*cb)(const char *machine));
+/**
+ * qtest_qmp_device_add:
+ * @driver: Name of the device that should be added
+ * @id: Identification string
+ * @fmt: printf-like format string for further options to device_add
+ *
+ * Generic hot-plugging test via the device_add QMP command.
+ */
+void qtest_qmp_device_add(const char *driver, const char *id, const char *fmt,
+ ...) GCC_FMT_ATTR(3, 4);
+
+/**
+ * qtest_qmp_device_del:
+ * @id: Identification string
+ *
+ * Generic hot-unplugging test via the device_del QMP command.
+ */
+void qtest_qmp_device_del(const char *id);
+
#endif
diff --git a/tests/usb-hcd-uhci-test.c b/tests/usb-hcd-uhci-test.c
index 5b500fe..62e0c78 100644
--- a/tests/usb-hcd-uhci-test.c
+++ b/tests/usb-hcd-uhci-test.c
@@ -48,31 +48,9 @@ static void test_uhci_hotplug(void)
static void test_usb_storage_hotplug(void)
{
- QDict *response;
+ qtest_qmp_device_add("usb-storage", "usbdev0", "'drive': 'drive0'");
- response = qmp("{'execute': 'device_add',"
- " 'arguments': {"
- " 'driver': 'usb-storage',"
- " 'drive': 'drive0',"
- " 'id': 'usbdev0'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("{'execute': 'device_del',"
- " 'arguments': {"
- " 'id': 'usbdev0'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("");
- g_assert(response);
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
+ qtest_qmp_device_del("usbdev0");
}
int main(int argc, char **argv)
diff --git a/tests/usb-hcd-xhci-test.c b/tests/usb-hcd-xhci-test.c
index 031764d..9c14e30 100644
--- a/tests/usb-hcd-xhci-test.c
+++ b/tests/usb-hcd-xhci-test.c
@@ -23,59 +23,16 @@ static void test_xhci_hotplug(void)
static void test_usb_uas_hotplug(void)
{
- QDict *response;
-
- response = qmp("{'execute': 'device_add',"
- " 'arguments': {"
- " 'driver': 'usb-uas',"
- " 'id': 'uas'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("{'execute': 'device_add',"
- " 'arguments': {"
- " 'driver': 'scsi-hd',"
- " 'drive': 'drive0',"
- " 'id': 'scsi-hd'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
+ qtest_qmp_device_add("usb-uas", "uas", NULL);
+ qtest_qmp_device_add("scsi-hd", "scsihd", "'drive': 'drive0'");
/* TODO:
UAS HBA driver in libqos, to check that
added disk is visible after BUS rescan
*/
- response = qmp("{'execute': 'device_del',"
- " 'arguments': {"
- " 'id': 'scsi-hd'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("");
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
-
-
- response = qmp("{'execute': 'device_del',"
- " 'arguments': {"
- " 'id': 'uas'"
- "}}");
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("");
- g_assert(response);
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
+ qtest_qmp_device_del("scsihd");
+ qtest_qmp_device_del("uas");
}
int main(int argc, char **argv)
diff --git a/tests/virtio-scsi-test.c b/tests/virtio-scsi-test.c
index 87a3b6e..d148512 100644
--- a/tests/virtio-scsi-test.c
+++ b/tests/virtio-scsi-test.c
@@ -192,32 +192,12 @@ static void pci_nop(void)
static void hotplug(void)
{
- QDict *response;
QOSState *qs;
qs = qvirtio_scsi_start(
"-drive id=drv1,if=none,file=null-co://,format=raw");
- response = qmp("{\"execute\": \"device_add\","
- " \"arguments\": {"
- " \"driver\": \"scsi-hd\","
- " \"id\": \"scsi-hd\","
- " \"drive\": \"drv1\""
- "}}");
-
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("{\"execute\": \"device_del\","
- " \"arguments\": {"
- " \"id\": \"scsi-hd\""
- "}}");
-
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
+ qtest_qmp_device_add("scsi-hd", "scsihd", "'drive': 'drv1'");
+ qtest_qmp_device_del("scsihd");
qvirtio_scsi_stop(qs);
}
diff --git a/tests/virtio-serial-test.c b/tests/virtio-serial-test.c
index b14d943..7d1517d 100644
--- a/tests/virtio-serial-test.c
+++ b/tests/virtio-serial-test.c
@@ -17,28 +17,9 @@ static void pci_nop(void)
static void hotplug(void)
{
- QDict *response;
-
- response = qmp("{\"execute\": \"device_add\","
- " \"arguments\": {"
- " \"driver\": \"virtserialport\","
- " \"id\": \"hp-port\""
- "}}");
-
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- QDECREF(response);
-
- response = qmp("{\"execute\": \"device_del\","
- " \"arguments\": {"
- " \"id\": \"hp-port\""
- "}}");
-
- g_assert(response);
- g_assert(!qdict_haskey(response, "error"));
- g_assert(qdict_haskey(response, "event"));
- g_assert(!strcmp(qdict_get_str(response, "event"), "DEVICE_DELETED"));
- QDECREF(response);
+ qtest_qmp_device_add("virtserialport", "hp-port", NULL);
+
+ qtest_qmp_device_del("hp-port");
}
int main(int argc, char **argv)
--
1.8.3.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions
2017-09-13 18:40 [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions Thomas Huth
@ 2017-09-14 4:30 ` Peter Xu
2017-09-19 13:38 ` Eric Blake
1 sibling, 0 replies; 5+ messages in thread
From: Peter Xu @ 2017-09-14 4:30 UTC (permalink / raw)
To: Thomas Huth
Cc: qemu-devel, Amit Shah, Paolo Bonzini, Gerd Hoffmann, Eric Blake,
Markus Armbruster
On Wed, Sep 13, 2017 at 08:40:54PM +0200, Thomas Huth wrote:
> A lot of tests provide code for adding and removing a device via the
> device_add and device_del QMP commands. Maintaining this code in so many
> places is cumbersome and error-prone (some of the code parts check the
> responses for device deletion in an incorrect way, for example, we've got
> to deal with both, error code and DEVICE_DEL event here). So let's provide
> some proper generic functions for adding and removing a device instead.
>
> The code for correctly unplugging a device has been taken from a patch
> from Peter Xu.
>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
Reviewed-by: Peter Xu <peterx@redhat.com>
I verified that this patch passes the "make check" either on master
branch or my private branch (which broke before this one). So:
Tested-by: Peter Xu <peterx@redhat.com>
Thanks!
--
Peter Xu
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions
2017-09-13 18:40 [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions Thomas Huth
2017-09-14 4:30 ` Peter Xu
@ 2017-09-19 13:38 ` Eric Blake
2017-09-19 15:22 ` Thomas Huth
1 sibling, 1 reply; 5+ messages in thread
From: Eric Blake @ 2017-09-19 13:38 UTC (permalink / raw)
To: Thomas Huth, qemu-devel, Peter Xu
Cc: Amit Shah, Paolo Bonzini, Gerd Hoffmann, Markus Armbruster
[-- Attachment #1: Type: text/plain, Size: 1618 bytes --]
On 09/13/2017 01:40 PM, Thomas Huth wrote:
> A lot of tests provide code for adding and removing a device via the
> device_add and device_del QMP commands. Maintaining this code in so many
> places is cumbersome and error-prone (some of the code parts check the
> responses for device deletion in an incorrect way, for example, we've got
> to deal with both, error code and DEVICE_DEL event here). So let's provide
> some proper generic functions for adding and removing a device instead.
>
> The code for correctly unplugging a device has been taken from a patch
> from Peter Xu.
>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
> + */
> +void qtest_qmp_device_del(const char *id)
> +{
> + QDict *response1, *response2, *event = NULL;
> + char *cmd;
> +
> + cmd = g_strdup_printf("{'execute': 'device_del',"
> + " 'arguments': { 'id': '%s' }}", id);
> + response1 = qmp(cmd);
> + g_free(cmd);
> + g_assert(response1);
> + g_assert(!qdict_haskey(response1, "error"));
> +
> + response2 = qmp("");
Hmm, this new use of qmp("") means I get to rebase the efforts to remove
the empty qmp command usage from the testsuite efforts. We really want
to have two low-level functions (one to send, one to receive), and then
have qmp() be the combination of both in a row; we have qmp_async() for
the send, and only qtest_receive() for the receive, so I'll have to
revive my work on unifying things...
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3266
Virtualization: qemu.org | libvirt.org
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 619 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions
2017-09-19 13:38 ` Eric Blake
@ 2017-09-19 15:22 ` Thomas Huth
2017-09-19 15:37 ` Eric Blake
0 siblings, 1 reply; 5+ messages in thread
From: Thomas Huth @ 2017-09-19 15:22 UTC (permalink / raw)
To: Eric Blake, qemu-devel, Peter Xu
Cc: Amit Shah, Paolo Bonzini, Gerd Hoffmann, Markus Armbruster
[-- Attachment #1: Type: text/plain, Size: 1426 bytes --]
On 19.09.2017 15:38, Eric Blake wrote:
> On 09/13/2017 01:40 PM, Thomas Huth wrote:
>> A lot of tests provide code for adding and removing a device via the
>> device_add and device_del QMP commands. Maintaining this code in so many
>> places is cumbersome and error-prone (some of the code parts check the
>> responses for device deletion in an incorrect way, for example, we've got
>> to deal with both, error code and DEVICE_DEL event here). So let's provide
>> some proper generic functions for adding and removing a device instead.
>>
>> The code for correctly unplugging a device has been taken from a patch
>> from Peter Xu.
[...]
>> +void qtest_qmp_device_del(const char *id)
>> +{
>> + QDict *response1, *response2, *event = NULL;
>> + char *cmd;
>> +
>> + cmd = g_strdup_printf("{'execute': 'device_del',"
>> + " 'arguments': { 'id': '%s' }}", id);
>> + response1 = qmp(cmd);
>> + g_free(cmd);
>> + g_assert(response1);
>> + g_assert(!qdict_haskey(response1, "error"));
>> +
>> + response2 = qmp("");
>
> Hmm, this new use of qmp("") means I get to rebase the efforts to remove
> the empty qmp command usage from the testsuite efforts.
Sorry about that :-/ I hope it's not too much of a hassle!
Maybe we should finally also add some assert(strlen(fmt) > 0) to that
function to avoid that the problem sneaks in again?
Thomas
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 836 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions
2017-09-19 15:22 ` Thomas Huth
@ 2017-09-19 15:37 ` Eric Blake
0 siblings, 0 replies; 5+ messages in thread
From: Eric Blake @ 2017-09-19 15:37 UTC (permalink / raw)
To: Thomas Huth, qemu-devel, Peter Xu
Cc: Amit Shah, Paolo Bonzini, Gerd Hoffmann, Markus Armbruster
[-- Attachment #1: Type: text/plain, Size: 685 bytes --]
On 09/19/2017 10:22 AM, Thomas Huth wrote:
>>> + response2 = qmp("");
>>
>> Hmm, this new use of qmp("") means I get to rebase the efforts to remove
>> the empty qmp command usage from the testsuite efforts.
>
> Sorry about that :-/ I hope it's not too much of a hassle!
>
> Maybe we should finally also add some assert(strlen(fmt) > 0) to that
> function to avoid that the problem sneaks in again?
Yep, already proposed (and thus part of my ongoing rebase work):
https://lists.gnu.org/archive/html/qemu-devel/2017-08/msg00599.html
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3266
Virtualization: qemu.org | libvirt.org
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 619 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-09-19 15:38 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-09-13 18:40 [Qemu-devel] [PATCH v2] tests: Introduce generic device hot-plug/hot-unplug functions Thomas Huth
2017-09-14 4:30 ` Peter Xu
2017-09-19 13:38 ` Eric Blake
2017-09-19 15:22 ` Thomas Huth
2017-09-19 15:37 ` Eric Blake
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.