DEVICE_UNPLUG_ERROR QAPI event
v3 cover DEVICE_UNPLUG_ERROR QAPI event
Hi,
In this new version we're now sending both MEM_UNPLUG_ERROR and the new DEVICE_UNPLUG_ERROR events to avoid breaking existing listeners of MEM_UNPLUG_ERROR, which is now marked as deprecated.
All emitters of MEM_UNPLUG_ERROR are now emitting DEVICE_UNPLUG_ERROR as well.
changes from v2:
- patch 1:
* moved DEVICE_UNPLUG_ERROR declaration to qapi/qdev.json
* updated 'device_del' description
* added 'deprecated' notice on MEM_UNPLUG_ERROR
* added MEM_UNPLUG_ERROR 'deprecated' info in docs/system/deprecated.rst
- patch 2:
* send both MEM_UNPLUG_ERROR and DEVICE_UNPLUG_ERROR
- patch 3 (new):
* send DEVICE_UNPLUG_ERROR in acpi/memory_hotplug.c
- v2 link: https://lists.gnu.org/archive/html/qemu-devel/2021-06/msg01304.html
changes from v1:
- former patches 1 and 2: dropped
- patch 1 (former 3): changed the version to '6.1'
- patch 2 (former 4): add a DEVICE_UNPLUG_ERROR event in the device unplug error path of CPUs and DIMMs
- v1 link: https://lists.gnu.org/archive/html/qemu-devel/2021-03/msg04682.html
Daniel Henrique Barboza (3):
qapi/qdev.json: add DEVICE_UNPLUG_ERROR QAPI event
spapr: use DEVICE_UNPLUG_ERROR to report unplug errors memory_hotplug.c: send DEVICE_UNPLUG_ERROR in
acpi_memory_hotplug_write()
docs/system/deprecated.rst | 10 ++++++++++ hw/acpi/memory_hotplug.c | 13 +++++++++++-- hw/ppc/spapr.c | 8 ++++++++ hw/ppc/spapr_drc.c | 15 +++++++++------ qapi/machine.json | 6 +++++- qapi/qdev.json | 27 ++++++++++++++++++++++++++- 6 files changed, 69 insertions(+), 10 deletions(-)
Signature · 1 line
2.31.1
PATCH v3 1/3 qapi/qdev.json: add DEVICE_UNPLUG_ERROR QAPI event
At this moment we only provide one event to report a hotunplug error, MEM_UNPLUG_ERROR. As of Linux kernel 5.12 and QEMU 6.0.0, the pseries machine is now able to report unplug errors for other device types, such
as CPUs. Instead of creating a (device_type)_UNPLUG_ERROR for each new device, create a generic DEVICE_UNPLUG_ERROR event that can be used by all unplug errors in the future. With this new generic event, MEM_UNPLUG_ERROR is now marked as deprecated. Signed-off-by: Daniel Henrique Barboza <[email protected]> --- docs/system/deprecated.rst | 10 ++++++++++ qapi/machine.json | 6 +++++- qapi/qdev.json | 27 ++++++++++++++++++++++++++- 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst index e2e0090878..c8200d99d4 100644 --- a/docs/system/deprecated.rst +++ b/docs/system/deprecated.rst @@ -192,6 +192,16 @@ The ``I7200`` guest CPU relies on the nanoMIPS ISA, which is deprecated (the ISA has never been upstreamed to a compiler toolchain). Therefore this CPU is also deprecated. + +QEMU API (QAPI) events +---------------------- + +``MEM_UNPLUG_ERROR`` (since 6.1) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Use the more generic event ``DEVICE_UNPLUG_ERROR`` instead. + + System emulator machines ------------------------ diff --git a/qapi/machine.json b/qapi/machine.json index e4d0f9b24f..91dc520734 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -1271,6 +1271,9 @@ # # @msg: Informative message # +# Features: +# @deprecated: This event is deprecated. Use @DEVICE_UNPLUG_ERROR instead. +# # Since: 2.4 # # Example: @@ -1283,4 +1286,5 @@ # ## { 'event': 'MEM_UNPLUG_ERROR', - 'data': { 'device': 'str', 'msg': 'str' } } + 'data': { 'device': 'str', 'msg': 'str' }, + 'features': ['deprecated'] } diff --git a/qapi/qdev.json b/qapi/qdev.json index b83178220b..349d7439fa 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -84,7 +84,9 @@ # This command merely requests that the guest begin the hot removal # process. Completion of the device removal process is signaled with a # DEVICE_DELETED event. Guest reset will automatically complete removal -# for all devices. +# for all devices. If an error in the hot removal process is detected, +# the device will not be removed and a DEVICE_UNPLUG_ERROR event is +# sent. # # Since: 0.14 # @@ -124,3 +126,26 @@ ## { 'event': 'DEVICE_DELETED', 'data': { '*device': 'str', 'path': 'str' } } + +## +# @DEVICE_UNPLUG_ERROR: +# +# Emitted when a device hot unplug error occurs. +# +# @device: device name +# +# @msg: Informative message +# +# Since: 6.1 +# +# Example: +# +# <- { "event": "DEVICE_UNPLUG_ERROR" +# "data": { "device": "dimm1", +# "msg": "Memory hotunplug rejected by the guest for device dimm1" +# }, +# "timestamp": { "seconds": 1615570772, "microseconds": 202844 } } +# +## +{ 'event': 'DEVICE_UNPLUG_ERROR', + 'data': { 'device': 'str', 'msg': 'str' } } -- 2.31.1
PATCH v3 2/3 spapr: use DEVICE_UNPLUG_ERROR to report unplug errors
In reply to Daniel Henrique BarbozaLinux Kernel 5.12 is now unisolating CPU DRCs in the device_removal error path, signalling that the hotunplug process wasn't successful. This allow us to send a DEVICE_UNPLUG_ERROR in drc_unisolate_logical() to signal this error to the management layer.
We also have another error path in spapr_memory_unplug_rollback() for configured LMB DRCs. Kernels older than 5.13 will not unisolate the LMBs in the hotunplug error path, but it will reconfigure them. Let's send the DEVICE_UNPLUG_ERROR event in that code path as well to cover the case of older kernels.
--- hw/ppc/spapr.c | 8 ++++++++ hw/ppc/spapr_drc.c | 15 +++++++++------ 2 files changed, 17 insertions(+), 6 deletions(-)
hw/ppc/spapr.c +8 -0
@@ -29,6 +29,7 @@#include "qemu/datadir.h" #include "qapi/error.h" #include "qapi/qapi-events-machine.h" +#include "qapi/qapi-events-qdev.h" #include "qapi/visitor.h" #include "sysemu/sysemu.h" #include "sysemu/hostmem.h"
@@ -3641,7 +3642,14 @@ void spapr_memory_unplug_rollback(SpaprMachineState *spapr, DeviceState *dev)*/ qapi_error =g_strdup_printf ("Memory hotunplug rejected by the guest " "for device %s" , dev->id); + +/* +* Send both MEM_UNPLUG_ERROR and DEVICE_UNPLUG_ERROR +* while the deprecation of MEM_UNPLUG_ERROR is +* pending. +*/ qapi_event_send_mem_unplug_error (dev->id, qapi_error); +qapi_event_send_device_unplug_error (dev->id, qapi_error); }/* Callback to be called during DRC release. */
hw/ppc/spapr_drc.c +9 -6
@@ -17,6 +17,8 @@#include "hw/ppc/spapr_drc.h" #include "qom/object.h" #include "migration/vmstate.h" +#include "qapi/error.h" +#include "qapi/qapi-events-qdev.h" #include "qapi/visitor.h" #include "qemu/error-report.h" #include "hw/ppc/spapr.h" /* for RTAS return codes */
@@ -160,6 +162,10 @@ static uint32_t drc_unisolate_logical(SpaprDrc *drc)* means that the kernel is refusing the removal. */ if (drc->unplug_requested && drc->dev) { +const char qapi_error_fmt[] ="Device hotunplug rejected by the " +"guest for device %s" ; + g_autofree char *qapi_error = NULL; +if (spapr_drc_type (drc) ==SPAPR_DR_CONNECTOR_TYPE_LMB ) { spapr =SPAPR_MACHINE (qdev_get_machine ());
@@ -167,13 +173,10 @@ static uint32_t drc_unisolate_logical(SpaprDrc *drc) } drc->unplug_requested = false; -error_report ("Device hotunplug rejected by the guest " -"for device %s" , drc->dev->id); +error_report (qapi_error_fmt, drc->dev->id); -/* -* TODO: send a QAPI DEVICE_UNPLUG_ERROR event when -* it is implemented. -*/ + qapi_error =g_strdup_printf (qapi_error_fmt, drc->dev->id); +qapi_event_send_device_unplug_error (drc->dev->id, qapi_error); }return RTAS_OUT_SUCCESS ;/* Nothing to do */
Signature · 1 line
2.31.1
PATCH v3 3/3 memory_hotplug.c: send DEVICE_UNPLUG_ERROR in acpi_memory_hotplug_write()
In reply to Daniel Henrique BarbozaMEM_UNPLUG_ERROR is deprecated since the introduction of DEVICE_UNPLUG_ERROR. Keep emitting both while the deprecation of MEM_UNPLUG_ERROR is pending.
--- hw/acpi/memory_hotplug.c | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
hw/acpi/memory_hotplug.c +11 -2
@@ -8,6 +8,7 @@#include "qapi/error.h" #include "qapi/qapi-events-acpi.h" #include "qapi/qapi-events-machine.h" +#include "qapi/qapi-events-qdev.h" #define MEMORY_SLOTS_NUMBER "MDNR"#define MEMORY_HOTPLUG_IO_REGION "HPMR"
@@ -177,9 +178,17 @@ static void acpi_memory_hotplug_write(void *opaque, hwaddr addr, uint64_t data,/* call pc-dimm unplug cb */ hotplug_handler_unplug (hotplug_ctrl, dev, &local_err);if (local_err) { +const char *error_pretty =error_get_pretty (local_err); +trace_mhp_acpi_pc_dimm_delete_failed (mem_st->selector); -qapi_event_send_mem_unplug_error (dev->id, -error_get_pretty (local_err)); + +/* +* Send both MEM_UNPLUG_ERROR and DEVICE_UNPLUG_ERROR +* while the deprecation of MEM_UNPLUG_ERROR is +* pending. +*/ +qapi_event_send_mem_unplug_error (dev->id, error_pretty); +qapi_event_send_device_unplug_error (dev->id, error_pretty);error_free (local_err);break ; }
Signature · 1 line
2.31.1
Re: [PATCH v3 3/3] memory_hotplug.c: send DEVICE_UNPLUG_ERROR in acpi_memory_hotplug_write()
Quoted 7 lines · Daniel Henrique Barboza
MEM_UNPLUG_ERRORis deprecated since the introduction ofDEVICE_UNPLUG_ERROR. Keep emitting both while the deprecation ofMEM_UNPLUG_ERRORis pending.CC Michael S. Tsirkin <[email protected]>CC Igor Mammedov <[email protected]>Signed-off-by Daniel Henrique Barboza <[email protected]>
Quoted 36 lines
--- hw/acpi/memory_hotplug.c | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)hw/acpi/memory_hotplug.c +11
-2@@ -8,6 +8,7 @@#include "qapi/error.h" #include "qapi/qapi-events-acpi.h" #include "qapi/qapi-events-machine.h" +#include "qapi/qapi-events-qdev.h" #define MEMORY_SLOTS_NUMBER "MDNR"#define MEMORY_HOTPLUG_IO_REGION "HPMR"@@ -177,9 +178,17 @@ static void acpi_memory_hotplug_write(void *opaque, hwaddr addr, uint64_t data,/* call pc-dimm unplug cb */ hotplug_handler_unplug (hotplug_ctrl, dev, &local_err);if (local_err) { +const char *error_pretty =error_get_pretty (local_err); +trace_mhp_acpi_pc_dimm_delete_failed (mem_st->selector); -qapi_event_send_mem_unplug_error (dev->id, -error_get_pretty (local_err)); + +/* +* Send both MEM_UNPLUG_ERROR and DEVICE_UNPLUG_ERROR +* while the deprecation of MEM_UNPLUG_ERROR is +* pending. +*/ +qapi_event_send_mem_unplug_error (dev->id, error_pretty); +qapi_event_send_device_unplug_error (dev->id, error_pretty);error_free (local_err);break ; }
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
Re: [PATCH v3 1/3] qapi/qdev.json: add DEVICE_UNPLUG_ERROR QAPI event
In reply to Daniel Henrique BarbozaQuoted 4 lines · Daniel Henrique Barboza
At this moment we only provide one event to report a hotunplug error,
MEM_UNPLUG_ERROR. As of Linux kernel 5.12 and QEMU 6.0.0, the pseries machine is now able to report unplug errors for other device types, such
as CPUs.
Something seems to have gone weirdly wrong with the formatting here.
Quoted 7 lines
Instead of creating a (device_type)_UNPLUG_ERROR for each new device, create a generic
DEVICE_UNPLUG_ERRORevent that can be used by all unplug errors in the future.With this new generic event,
MEM_UNPLUG_ERRORis now marked as deprecated.Signed-off-by Daniel Henrique Barboza <[email protected]>
Apart from that
Quoted 91 lines
---
docs/system/deprecated.rst | 10 ++++++++++
qapi/machine.json | 6 +++++-
qapi/qdev.json | 27 ++++++++++++++++++++++++++-
3 files changed, 41 insertions(+), 2 deletions(-)
diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index e2e0090878..c8200d99d4 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -192,6 +192,16 @@ The ``I7200`` guest CPU relies on the nanoMIPS ISA, which is deprecated
(the ISA has never been upstreamed to a compiler toolchain). Therefore
this CPU is also deprecated.
+
+QEMU API (QAPI) events
+----------------------
+
+``MEM_UNPLUG_ERROR`` (since 6.1)
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Use the more generic event ``DEVICE_UNPLUG_ERROR`` instead.
+
+
System emulator machines
------------------------
diff --git a/qapi/machine.json b/qapi/machine.json
index e4d0f9b24f..91dc520734 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1271,6 +1271,9 @@
#
# @msg: Informative message
#
+# Features:
+# @deprecated: This event is deprecated. Use @DEVICE_UNPLUG_ERROR instead.
+#
# Since: 2.4
#
# Example:
@@ -1283,4 +1286,5 @@
#
##
{ 'event': 'MEM_UNPLUG_ERROR',
- 'data': { 'device': 'str', 'msg': 'str' } }
+ 'data': { 'device': 'str', 'msg': 'str' },
+ 'features': ['deprecated'] }
diff --git a/qapi/qdev.json b/qapi/qdev.json
index b83178220b..349d7439fa 100644
--- a/qapi/qdev.json
+++ b/qapi/qdev.json
@@ -84,7 +84,9 @@
# This command merely requests that the guest begin the hot removal
# process. Completion of the device removal process is signaled with a
# DEVICE_DELETED event. Guest reset will automatically complete removal
-# for all devices.
+# for all devices. If an error in the hot removal process is detected,
+# the device will not be removed and a DEVICE_UNPLUG_ERROR event is
+# sent.
#
# Since: 0.14
#
@@ -124,3 +126,26 @@
##
{ 'event': 'DEVICE_DELETED',
'data': { '*device': 'str', 'path': 'str' } }
+
+##
+# @DEVICE_UNPLUG_ERROR:
+#
+# Emitted when a device hot unplug error occurs.
+#
+# @device: device name
+#
+# @msg: Informative message
+#
+# Since: 6.1
+#
+# Example:
+#
+# <- { "event": "DEVICE_UNPLUG_ERROR"
+# "data": { "device": "dimm1",
+# "msg": "Memory hotunplug rejected by the guest for device dimm1"
+# },
+# "timestamp": { "seconds": 1615570772, "microseconds": 202844 } }
+#
+##
+{ 'event': 'DEVICE_UNPLUG_ERROR',
+ 'data': { 'device': 'str', 'msg': 'str' } }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
Re: [PATCH v3 2/3] spapr: use DEVICE_UNPLUG_ERROR to report unplug errors
In reply to Daniel Henrique BarbozaQuoted 5 lines · Daniel Henrique Barboza
Linux Kernel 5.12 is now unisolating CPU DRCs in the
device_removalerror path, signalling that the hotunplug process wasn't successful. This allow us to send aDEVICE_UNPLUG_ERRORindrc_unisolate_logical()to signal this error to the management layer.
Quoted 7 lines
We also have another error path in
spapr_memory_unplug_rollback()for configured LMB DRCs. Kernels older than 5.13 will not unisolate the LMBs in the hotunplug error path, but it will reconfigure them. Let's send theDEVICE_UNPLUG_ERRORevent in that code path as well to cover the case of older kernels.Signed-off-by Daniel Henrique Barboza <[email protected]>
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
Re: [PATCH v3 1/3] qapi/qdev.json: add DEVICE_UNPLUG_ERROR QAPI event
In reply to David GibsonQuoted 7 lines · David Gibson
Quoted 4 lines · Daniel Henrique Barboza
At this moment we only provide one event to report a hotunplug error,
MEM_UNPLUG_ERROR. As of Linux kernel 5.12 and QEMU 6.0.0, the pseries machine is now able to report unplug errors for other device types, such
as CPUs.Something seems to have gone weirdly wrong with the formatting here.
I have no idea what happened lol
Quoted 11 lines
Quoted 8 lines
Instead of creating a (device_type)_UNPLUG_ERROR for each new device, create a generic
DEVICE_UNPLUG_ERRORevent that can be used by all unplug errors in the future.With this new generic event,
MEM_UNPLUG_ERRORis now marked as deprecated.Signed-off-by Daniel Henrique Barboza <[email protected]>Apart from that
Reviewed-by David Gibson <[email protected]>
Thanks for the reviews! I'll resend the series (hopefully with the proper formatting) with your R-bs.
Daniel
Quoted 93 lines
Quoted 92 lines
--- docs/system/deprecated.rst | 10 ++++++++++ qapi/machine.json | 6 +++++- qapi/qdev.json | 27 ++++++++++++++++++++++++++- 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst index e2e0090878..c8200d99d4 100644 --- a/docs/system/deprecated.rst +++ b/docs/system/deprecated.rst @@ -192,6 +192,16 @@ The ``I7200`` guest CPU relies on the nanoMIPS ISA, which is deprecated (the ISA has never been upstreamed to a compiler toolchain). Therefore this CPU is also deprecated. + +QEMU API (QAPI) events +---------------------- + +``MEM_UNPLUG_ERROR`` (since 6.1) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Use the more generic event ``DEVICE_UNPLUG_ERROR`` instead. + + System emulator machines ------------------------ diff --git a/qapi/machine.json b/qapi/machine.json index e4d0f9b24f..91dc520734 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -1271,6 +1271,9 @@ # # @msg: Informative message # +# Features: +# @deprecated: This event is deprecated. Use @DEVICE_UNPLUG_ERROR instead. +# # Since: 2.4 # # Example: @@ -1283,4 +1286,5 @@ # ## { 'event': 'MEM_UNPLUG_ERROR', - 'data': { 'device': 'str', 'msg': 'str' } } + 'data': { 'device': 'str', 'msg': 'str' }, + 'features': ['deprecated'] } diff --git a/qapi/qdev.json b/qapi/qdev.json index b83178220b..349d7439fa 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -84,7 +84,9 @@ # This command merely requests that the guest begin the hot removal # process. Completion of the device removal process is signaled with a # DEVICE_DELETED event. Guest reset will automatically complete removal -# for all devices. +# for all devices. If an error in the hot removal process is detected, +# the device will not be removed and a DEVICE_UNPLUG_ERROR event is +# sent. # # Since: 0.14 # @@ -124,3 +126,26 @@ ## { 'event': 'DEVICE_DELETED', 'data': { '*device': 'str', 'path': 'str' } } + +## +# @DEVICE_UNPLUG_ERROR: +# +# Emitted when a device hot unplug error occurs. +# +# @device: device name +# +# @msg: Informative message +# +# Since: 6.1 +# +# Example: +# +# <- { "event": "DEVICE_UNPLUG_ERROR" +# "data": { "device": "dimm1", +# "msg": "Memory hotunplug rejected by the guest for device dimm1" +# }, +# "timestamp": { "seconds": 1615570772, "microseconds": 202844 } } +# +## +{ 'event': 'DEVICE_UNPLUG_ERROR', + 'data': { 'device': 'str', 'msg': 'str' } }