[PATCH v6 0/3] Add SCLP event type CPI

[PATCH v6 0/3] Add SCLP event type CPI

[Shalini Chellathurai Saroja]

Implement the Service-Call Logical Processor (SCLP) event
type Control-Program Identification (CPI) in QEMU.

Changed since v5:
- Add identifiers as class properties instead of object properties
- Add description for all the class properties
- Remove S390ControlProgramId as it is not needed anymore
- Update description of system_level identifier
- Add Reviewed-by tags

Changed since v4:
- Remove the object control-program-id and add the CPI attributes
  directly to the sclpcpi object
- Instantiate sclpcpi device from v10.1 instead of v10.0
- Other minor changes

Changed since v3:
- Add QOM object sclpcpi from ccw_init()
- Add SCLPEventCPI state to store the CPI data in the sclpcpi device
- Other minor changes

Changed since v2:
- Add SPDX license tag in the new file hw/s390x/sclpcpi.c
- Store the control-program Identification data in the sclpcpi device
- Update the description of CPI attributes
- Use ldq_be_p() intead of be64_to_cpu()
- Return the CPI attribute system-level as an integer in QMP
- Add compat handling for backward migration
- Other minor changes

Shalini Chellathurai Saroja (3):
  hw/s390x: add SCLP event type CPI
  hw/s390x: add Control-Program Identification to QOM
  hw/s390x: support migration of CPI data

 hw/s390x/event-facility.c          |   2 +
 hw/s390x/meson.build               |   1 +
 hw/s390x/s390-virtio-ccw.c         |  22 +++
 hw/s390x/sclpcpi.c                 | 213 +++++++++++++++++++++++++++++
 include/hw/s390x/event-facility.h  |  17 +++
 include/hw/s390x/s390-virtio-ccw.h |   1 +
 6 files changed, 256 insertions(+)
 create mode 100644 hw/s390x/sclpcpi.c

-- 
2.49.0

[PATCH v6 1/3] hw/s390x: add SCLP event type CPI

[Shalini Chellathurai Saroja]

Implement the Service-Call Logical Processor (SCLP) event
type Control-Program Identification (CPI) in QEMU. This
event is used to send CPI identifiers from the guest to the
host. The CPI identifiers are: system type, system name,
system level and sysplex name.

System type: operating system of the guest (e.g. "LINUX   ").
System name: user configurable name of the guest (e.g. "TESTVM  ").
System level: distribution and kernel version, if the system type is Linux
(e.g. 74872343805430528).
Sysplex name: name of the cluster which the guest belongs to (if any)
(e.g. "PLEX").

The SCLP event CPI is supported only from "s390-ccw-virtio-10.1" machine
and higher.

Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
Reviewed-by: Nina Schoetterl-Glausch <nsg@linux.ibm.com>
Reviewed-by: Thomas Huth <thuth@redhat.com>
---
 hw/s390x/event-facility.c          |   2 +
 hw/s390x/meson.build               |   1 +
 hw/s390x/s390-virtio-ccw.c         |  22 +++++
 hw/s390x/sclpcpi.c                 | 124 +++++++++++++++++++++++++++++
 include/hw/s390x/event-facility.h  |  12 +++
 include/hw/s390x/s390-virtio-ccw.h |   1 +
 6 files changed, 162 insertions(+)
 create mode 100644 hw/s390x/sclpcpi.c

diff --git a/hw/s390x/event-facility.c b/hw/s390x/event-facility.c
index 7b7bf237fe..fee286ea63 100644
--- a/hw/s390x/event-facility.c
+++ b/hw/s390x/event-facility.c
@@ -4,6 +4,7 @@
  *       handles SCLP event types
  *          - Signal Quiesce - system power down
  *          - ASCII Console Data - VT220 read and write
+ *          - Control-Program Identification - Send OS data from guest to host
  *
  * Copyright IBM, Corp. 2012
  *
@@ -40,6 +41,7 @@ struct SCLPEventFacility {
     SysBusDevice parent_obj;
     SCLPEventsBus sbus;
     SCLPEvent quiesce, cpu_hotplug;
+    SCLPEventCPI cpi;
     /* guest's receive mask */
     union {
         uint32_t receive_mask_pieces[2];
diff --git a/hw/s390x/meson.build b/hw/s390x/meson.build
index 99cbcbd7d6..1bc8583799 100644
--- a/hw/s390x/meson.build
+++ b/hw/s390x/meson.build
@@ -13,6 +13,7 @@ s390x_ss.add(files(
   's390-skeys.c',
   's390-stattrib.c',
   'sclp.c',
+  'sclpcpi.c',
   'sclpcpu.c',
   'sclpquiesce.c',
   'tod.c',
diff --git a/hw/s390x/s390-virtio-ccw.c b/hw/s390x/s390-virtio-ccw.c
index ce3c13defb..a79bd13275 100644
--- a/hw/s390x/s390-virtio-ccw.c
+++ b/hw/s390x/s390-virtio-ccw.c
@@ -260,9 +260,21 @@ static void s390_create_sclpconsole(SCLPDevice *sclp,
     qdev_realize_and_unref(dev, ev_fac_bus, &error_fatal);
 }
 
+static void s390_create_sclpcpi(SCLPDevice *sclp)
+{
+    SCLPEventFacility *ef = sclp->event_facility;
+    BusState *ev_fac_bus = sclp_get_event_facility_bus(ef);
+    DeviceState *dev;
+
+    dev = qdev_new(TYPE_SCLP_EVENT_CPI);
+    object_property_add_child(OBJECT(ef), "sclpcpi", OBJECT(dev));
+    qdev_realize_and_unref(dev, ev_fac_bus, &error_fatal);
+}
+
 static void ccw_init(MachineState *machine)
 {
     MachineClass *mc = MACHINE_GET_CLASS(machine);
+    S390CcwMachineClass *s390mc = S390_CCW_MACHINE_CLASS(mc);
     S390CcwMachineState *ms = S390_CCW_MACHINE(machine);
     int ret;
     VirtualCssBus *css_bus;
@@ -323,6 +335,12 @@ static void ccw_init(MachineState *machine)
 
     /* init the TOD clock */
     s390_init_tod();
+
+    /* init SCLP event Control-Program Identification */
+    if (s390mc->use_cpi) {
+        s390_create_sclpcpi(ms->sclp);
+    }
+
 }
 
 static void s390_cpu_plug(HotplugHandler *hotplug_dev,
@@ -783,6 +801,7 @@ static void ccw_machine_class_init(ObjectClass *oc, const void *data)
     DumpSKeysInterface *dsi = DUMP_SKEYS_INTERFACE_CLASS(oc);
 
     s390mc->max_threads = 1;
+    s390mc->use_cpi = true;
     mc->reset = s390_machine_reset;
     mc->block_default_type = IF_VIRTIO;
     mc->no_cdrom = 1;
@@ -908,6 +927,9 @@ static void ccw_machine_10_0_instance_options(MachineState *machine)
 
 static void ccw_machine_10_0_class_options(MachineClass *mc)
 {
+    S390CcwMachineClass *s390mc = S390_CCW_MACHINE_CLASS(mc);
+    s390mc->use_cpi = false;
+
     ccw_machine_10_1_class_options(mc);
     compat_props_add(mc->compat_props, hw_compat_10_0, hw_compat_10_0_len);
 }
diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
new file mode 100644
index 0000000000..a0b175c5d5
--- /dev/null
+++ b/hw/s390x/sclpcpi.c
@@ -0,0 +1,124 @@
+ /*
+  * SPDX-License-Identifier: GPL-2.0-or-later
+  *
+  * SCLP event type 11 - Control-Program Identification (CPI):
+  *    CPI is used to send program identifiers from the guest to the
+  *    Service-Call Logical Processor (SCLP). It is not sent by the SCLP.
+  *
+  *    Control-program identifiers provide data about the guest operating
+  *    system.  The control-program identifiers are: system type, system name,
+  *    system level and sysplex name.
+  *
+  *    In Linux, all the control-program identifiers are user configurable. The
+  *    system type, system name, and sysplex name use EBCDIC characters from
+  *    this set: capital A-Z, 0-9, $, @, #, and blank.  In Linux, the system
+  *    type, system name and sysplex name are arbitrary free-form texts.
+  *
+  *    In Linux, the 8-byte hexadecimal system-level has the format
+  *    0x<a><b><cc><dd><eeee><ff><gg><hh>, where:
+  *    <a>: is a 4-bit digit, its most significant bit indicates hypervisor use
+  *    <b>: is one digit that represents Linux distributions as follows
+  *    0: generic Linux
+  *    1: Red Hat Enterprise Linux
+  *    2: SUSE Linux Enterprise Server
+  *    3: Canonical Ubuntu
+  *    4: Fedora
+  *    5: openSUSE Leap
+  *    6: Debian GNU/Linux
+  *    7: Red Hat Enterprise Linux CoreOS
+  *    <cc>: are two digits for a distribution-specific encoding of the major
+  *    version of the distribution
+  *    <dd>: are two digits for a distribution-specific encoding of the minor
+  *    version of the distribution
+  *    <eeee>: are four digits for the patch level of the distribution
+  *    <ff>: are two digits for the major version of the kernel
+  *    <gg>: are two digits for the minor version of the kernel
+  *    <hh>: are two digits for the stable version of the kernel
+  *    (e.g. 74872343805430528, when converted to hex is 0x010a000000060b00). On
+  *    machines prior to z16, some of the values are not available to display.
+  *
+  *    Sysplex refers to a cluster of logical partitions that communicates and
+  *    co-operates with each other.
+  *
+  *    The CPI feature is supported since 10.1.
+  *
+  * Copyright IBM, Corp. 2024
+  *
+  * Authors:
+  *  Shalini Chellathurai Saroja <shalini@linux.ibm.com>
+  *
+  */
+
+#include "qemu/osdep.h"
+#include "hw/s390x/event-facility.h"
+
+typedef struct Data {
+    uint8_t id_format;
+    uint8_t reserved0;
+    uint8_t system_type[8];
+    uint64_t reserved1;
+    uint8_t system_name[8];
+    uint64_t reserved2;
+    uint64_t system_level;
+    uint64_t reserved3;
+    uint8_t sysplex_name[8];
+    uint8_t reserved4[16];
+} QEMU_PACKED Data;
+
+typedef struct ControlProgramIdMsg {
+    EventBufferHeader ebh;
+    Data data;
+} QEMU_PACKED ControlProgramIdMsg;
+
+static bool can_handle_event(uint8_t type)
+{
+    return type == SCLP_EVENT_CTRL_PGM_ID;
+}
+
+static sccb_mask_t send_mask(void)
+{
+    return 0;
+}
+
+/* Enable SCLP to accept buffers of event type CPI from the control-program. */
+static sccb_mask_t receive_mask(void)
+{
+    return SCLP_EVENT_MASK_CTRL_PGM_ID;
+}
+
+static int write_event_data(SCLPEvent *event, EventBufferHeader *evt_buf_hdr)
+{
+    ControlProgramIdMsg *cpim = container_of(evt_buf_hdr, ControlProgramIdMsg,
+                                             ebh);
+
+    cpim->ebh.flags = SCLP_EVENT_BUFFER_ACCEPTED;
+    return SCLP_RC_NORMAL_COMPLETION;
+}
+
+static void cpi_class_init(ObjectClass *klass, const void *data)
+{
+    DeviceClass *dc = DEVICE_CLASS(klass);
+    SCLPEventClass *k = SCLP_EVENT_CLASS(klass);
+
+    dc->user_creatable = false;
+
+    k->can_handle_event = can_handle_event;
+    k->get_send_mask = send_mask;
+    k->get_receive_mask = receive_mask;
+    k->write_event_data = write_event_data;
+}
+
+static const TypeInfo sclp_cpi_info = {
+    .name          = TYPE_SCLP_EVENT_CPI,
+    .parent        = TYPE_SCLP_EVENT,
+    .instance_size = sizeof(SCLPEventCPI),
+    .class_init    = cpi_class_init,
+};
+
+static void sclp_cpi_register_types(void)
+{
+    type_register_static(&sclp_cpi_info);
+}
+
+type_init(sclp_cpi_register_types)
+
diff --git a/include/hw/s390x/event-facility.h b/include/hw/s390x/event-facility.h
index ff874e792d..e81bc80498 100644
--- a/include/hw/s390x/event-facility.h
+++ b/include/hw/s390x/event-facility.h
@@ -25,6 +25,7 @@
 #define SCLP_EVENT_MESSAGE                      0x02
 #define SCLP_EVENT_CONFIG_MGT_DATA              0x04
 #define SCLP_EVENT_PMSGCMD                      0x09
+#define SCLP_EVENT_CTRL_PGM_ID                  0x0b
 #define SCLP_EVENT_ASCII_CONSOLE_DATA           0x1a
 #define SCLP_EVENT_SIGNAL_QUIESCE               0x1d
 
@@ -35,6 +36,7 @@
 #define SCLP_EVENT_MASK_MSG             SCLP_EVMASK(SCLP_EVENT_MESSAGE)
 #define SCLP_EVENT_MASK_CONFIG_MGT_DATA SCLP_EVMASK(SCLP_EVENT_CONFIG_MGT_DATA)
 #define SCLP_EVENT_MASK_PMSGCMD         SCLP_EVMASK(SCLP_EVENT_PMSGCMD)
+#define SCLP_EVENT_MASK_CTRL_PGM_ID     SCLP_EVMASK(SCLP_EVENT_CTRL_PGM_ID)
 #define SCLP_EVENT_MASK_MSG_ASCII       SCLP_EVMASK(SCLP_EVENT_ASCII_CONSOLE_DATA)
 #define SCLP_EVENT_MASK_SIGNAL_QUIESCE  SCLP_EVMASK(SCLP_EVENT_SIGNAL_QUIESCE)
 
@@ -191,6 +193,16 @@ struct SCLPEventClass {
     bool (*can_handle_event)(uint8_t type);
 };
 
+#define TYPE_SCLP_EVENT_CPI "sclpcpi"
+typedef struct SCLPEventCPIClass SCLPEventCPIClass;
+typedef struct SCLPEventCPI SCLPEventCPI;
+OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
+                    SCLP_EVENT_CPI)
+
+struct SCLPEventCPI {
+    SCLPEvent event;
+};
+
 #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
 typedef struct SCLPEventFacility SCLPEventFacility;
 typedef struct SCLPEventFacilityClass SCLPEventFacilityClass;
diff --git a/include/hw/s390x/s390-virtio-ccw.h b/include/hw/s390x/s390-virtio-ccw.h
index 321b26df30..526078a4e2 100644
--- a/include/hw/s390x/s390-virtio-ccw.h
+++ b/include/hw/s390x/s390-virtio-ccw.h
@@ -54,6 +54,7 @@ struct S390CcwMachineClass {
 
     /*< public >*/
     int max_threads;
+    bool use_cpi;
 };
 
 #endif
-- 
2.49.0

[PATCH v6 2/3] hw/s390x: add Control-Program Identification to QOM

[Shalini Chellathurai Saroja]

Add Control-Program Identification (CPI) data to the QEMU Object
Model (QOM), along with the timestamp in which the data was received
as shown below.

virsh # qemu-monitor-command vm --pretty '{"execute":"qom-list",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi"}}'
{
  "return": [
    [...]
    {
      "name": "system_level",
      "type": "uint64"
    },
    {
      "name": "system_name",
      "type": "string"
    },
    {
      "name": "system_type",
      "type": "string"
    },
    {
      "name": "timestamp",
      "type": "uint64"
    },
    {
      "name": "sysplex_name",
      "type": "string"
    }
  ],
  "id": "libvirt-14"
}

Example CPI data:
virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property":"system_type"}}'
{
  "return": "LINUX   ",
  "id": "libvirt-18"
}
virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property":"system_name"}}'
{
  "return": "TESTVM  ",
  "id": "libvirt-19"
}
virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property":"sysplex_name"}}'
{
  "return": "PLEX    ",
  "id": "libvirt-20"
}
virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property":"system_level"}}'
{
  "return": 74872343805430528,
  "id": "libvirt-21"
}
virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
"arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property":"timestamp"}}'
{
  "return": 1748866753433923000,
  "id": "libvirt-22"
}

Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
---
 hw/s390x/sclpcpi.c                | 74 +++++++++++++++++++++++++++++++
 include/hw/s390x/event-facility.h |  5 +++
 2 files changed, 79 insertions(+)

diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
index a0b175c5d5..352ef0461d 100644
--- a/hw/s390x/sclpcpi.c
+++ b/hw/s390x/sclpcpi.c
@@ -50,7 +50,10 @@
   */
 
 #include "qemu/osdep.h"
+#include "qemu/timer.h"
 #include "hw/s390x/event-facility.h"
+#include "hw/s390x/ebcdic.h"
+#include "qapi/qapi-visit-machine.h"
 
 typedef struct Data {
     uint8_t id_format;
@@ -90,11 +93,58 @@ static int write_event_data(SCLPEvent *event, EventBufferHeader *evt_buf_hdr)
 {
     ControlProgramIdMsg *cpim = container_of(evt_buf_hdr, ControlProgramIdMsg,
                                              ebh);
+    SCLPEventCPI *e = SCLP_EVENT_CPI(event);
+
+    ascii_put(e->system_type, (char *)cpim->data.system_type,
+              sizeof(cpim->data.system_type));
+    ascii_put(e->system_name, (char *)cpim->data.system_name,
+              sizeof(cpim->data.system_name));
+    ascii_put(e->sysplex_name, (char *)cpim->data.sysplex_name,
+              sizeof(cpim->data.sysplex_name));
+    e->system_level = ldq_be_p(&cpim->data.system_level);
+    e->timestamp = qemu_clock_get_ns(QEMU_CLOCK_HOST);
 
     cpim->ebh.flags = SCLP_EVENT_BUFFER_ACCEPTED;
     return SCLP_RC_NORMAL_COMPLETION;
 }
 
+static char *get_system_type(Object *obj, Error **errp)
+{
+    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+
+    return g_strndup((char *) e->system_type, sizeof(e->system_type));
+}
+
+static char *get_system_name(Object *obj, Error **errp)
+{
+    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+
+    return g_strndup((char *) e->system_name, sizeof(e->system_name));
+}
+
+static char *get_sysplex_name(Object *obj, Error **errp)
+{
+    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+
+    return g_strndup((char *) e->sysplex_name, sizeof(e->sysplex_name));
+}
+
+static void get_system_level(Object *obj, Visitor *v, const char *name,
+                             void *opaque, Error **errp)
+{
+    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+
+    visit_type_uint64(v, name, &e->system_level, errp);
+}
+
+static void get_timestamp(Object *obj, Visitor *v, const char *name,
+                             void *opaque, Error **errp)
+{
+    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+
+    visit_type_uint64(v, name, &e->timestamp, errp);
+}
+
 static void cpi_class_init(ObjectClass *klass, const void *data)
 {
     DeviceClass *dc = DEVICE_CLASS(klass);
@@ -106,6 +156,30 @@ static void cpi_class_init(ObjectClass *klass, const void *data)
     k->get_send_mask = send_mask;
     k->get_receive_mask = receive_mask;
     k->write_event_data = write_event_data;
+
+    object_class_property_add_str(klass, "system_type", get_system_type, NULL);
+    object_class_property_set_description(klass, "system_type",
+            "operating system e.g. \"LINUX   \"");
+
+    object_class_property_add_str(klass, "system_name", get_system_name, NULL);
+    object_class_property_set_description(klass, "system_name",
+            "user configurable name of the VM e.g. \"TESTVM  \"");
+
+    object_class_property_add_str(klass, "sysplex_name", get_sysplex_name,
+                                  NULL);
+    object_class_property_set_description(klass, "sysplex_name",
+            "name of the cluster which the VM belongs to, if any"
+            " e.g. \"PLEX    \"");
+
+    object_class_property_add(klass, "system_level", "uint64", get_system_level,
+                              NULL, NULL, NULL);
+    object_class_property_set_description(klass, "system_level",
+            "distribution and kernel version in Linux e.g. 74872343805430528");
+
+    object_class_property_add(klass, "timestamp", "uint64", get_timestamp,
+                              NULL, NULL, NULL);
+    object_class_property_set_description(klass, "timestamp",
+            "latest update of CPI data in nanoseconds since the UNIX EPOCH");
 }
 
 static const TypeInfo sclp_cpi_info = {
diff --git a/include/hw/s390x/event-facility.h b/include/hw/s390x/event-facility.h
index e81bc80498..eac7a51100 100644
--- a/include/hw/s390x/event-facility.h
+++ b/include/hw/s390x/event-facility.h
@@ -201,6 +201,11 @@ OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
 
 struct SCLPEventCPI {
     SCLPEvent event;
+    uint8_t system_type[8];
+    uint8_t system_name[8];
+    uint64_t system_level;
+    uint8_t sysplex_name[8];
+    uint64_t timestamp;
 };
 
 #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
-- 
2.49.0

[PATCH v6 3/3] hw/s390x: support migration of CPI data

[Shalini Chellathurai Saroja]

Register Control-Program Identification data with the live
migration infrastructure.

Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
Reviewed-by: Nina Schoetterl-Glausch <nsg@linux.ibm.com>
Reviewed-by: Thomas Huth <thuth@redhat.com>
---
 hw/s390x/sclpcpi.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
index 352ef0461d..88012f2279 100644
--- a/hw/s390x/sclpcpi.c
+++ b/hw/s390x/sclpcpi.c
@@ -54,6 +54,7 @@
 #include "hw/s390x/event-facility.h"
 #include "hw/s390x/ebcdic.h"
 #include "qapi/qapi-visit-machine.h"
+#include "migration/vmstate.h"
 
 typedef struct Data {
     uint8_t id_format;
@@ -145,12 +146,26 @@ static void get_timestamp(Object *obj, Visitor *v, const char *name,
     visit_type_uint64(v, name, &e->timestamp, errp);
 }
 
+static const VMStateDescription vmstate_sclpcpi = {
+    .name = "s390_control_program_id",
+    .version_id = 0,
+    .fields = (const VMStateField[]) {
+        VMSTATE_UINT8_ARRAY(system_type, SCLPEventCPI, 8),
+        VMSTATE_UINT8_ARRAY(system_name, SCLPEventCPI, 8),
+        VMSTATE_UINT64(system_level, SCLPEventCPI),
+        VMSTATE_UINT8_ARRAY(sysplex_name, SCLPEventCPI, 8),
+        VMSTATE_UINT64(timestamp, SCLPEventCPI),
+        VMSTATE_END_OF_LIST()
+    }
+};
+
 static void cpi_class_init(ObjectClass *klass, const void *data)
 {
     DeviceClass *dc = DEVICE_CLASS(klass);
     SCLPEventClass *k = SCLP_EVENT_CLASS(klass);
 
     dc->user_creatable = false;
+    dc->vmsd =  &vmstate_sclpcpi;
 
     k->can_handle_event = can_handle_event;
     k->get_send_mask = send_mask;
-- 
2.49.0

Re: [PATCH v6 2/3] hw/s390x: add Control-Program Identification to QOM

[Nina Schoetterl-Glausch]

On Mon, 2025-06-16 at 16:01 +0200, Shalini Chellathurai Saroja wrote:
> Add Control-Program Identification (CPI) data to the QEMU Object
> Model (QOM), along with the timestamp in which the data was received
> as shown below.
> 
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-list",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi"}}'
> {
>   "return": [
>     [...]
>     {
>       "name": "system_level",
>       "type": "uint64"
>     },
>     {
>       "name": "system_name",
>       "type": "string"
>     },
>     {
>       "name": "system_type",
>       "type": "string"
>     },
>     {
>       "name": "timestamp",
>       "type": "uint64"
>     },
>     {
>       "name": "sysplex_name",
>       "type": "string"
>     }
>   ],
>   "id": "libvirt-14"
> }
> 
> Example CPI data:
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_type"}}'
> {
>   "return": "LINUX   ",
>   "id": "libvirt-18"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_name"}}'
> {
>   "return": "TESTVM  ",
>   "id": "libvirt-19"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"sysplex_name"}}'
> {
>   "return": "PLEX    ",
>   "id": "libvirt-20"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_level"}}'
> {
>   "return": 74872343805430528,
>   "id": "libvirt-21"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"timestamp"}}'
> {
>   "return": 1748866753433923000,
>   "id": "libvirt-22"
> }
> 
> Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
> ---
>  hw/s390x/sclpcpi.c                | 74 +++++++++++++++++++++++++++++++
>  include/hw/s390x/event-facility.h |  5 +++
>  2 files changed, 79 insertions(+)
> 
> diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
> index a0b175c5d5..352ef0461d 100644
> --- a/hw/s390x/sclpcpi.c
> +++ b/hw/s390x/sclpcpi.c
> @@ -50,7 +50,10 @@
>    */
>  
>  #include "qemu/osdep.h"
> +#include "qemu/timer.h"
>  #include "hw/s390x/event-facility.h"
> +#include "hw/s390x/ebcdic.h"
> +#include "qapi/qapi-visit-machine.h"
>  
>  typedef struct Data {
>      uint8_t id_format;
> @@ -90,11 +93,58 @@ static int write_event_data(SCLPEvent *event, EventBufferHeader *evt_buf_hdr)
>  {
>      ControlProgramIdMsg *cpim = container_of(evt_buf_hdr, ControlProgramIdMsg,
>                                               ebh);
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(event);
> +
> +    ascii_put(e->system_type, (char *)cpim->data.system_type,
> +              sizeof(cpim->data.system_type));
> +    ascii_put(e->system_name, (char *)cpim->data.system_name,
> +              sizeof(cpim->data.system_name));
> +    ascii_put(e->sysplex_name, (char *)cpim->data.sysplex_name,
> +              sizeof(cpim->data.sysplex_name));
> +    e->system_level = ldq_be_p(&cpim->data.system_level);
> +    e->timestamp = qemu_clock_get_ns(QEMU_CLOCK_HOST);
>  
>      cpim->ebh.flags = SCLP_EVENT_BUFFER_ACCEPTED;
>      return SCLP_RC_NORMAL_COMPLETION;
>  }
>  
> +static char *get_system_type(Object *obj, Error **errp)
> +{
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
> +
> +    return g_strndup((char *) e->system_type, sizeof(e->system_type));
> +}
> +
> +static char *get_system_name(Object *obj, Error **errp)
> +{
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
> +
> +    return g_strndup((char *) e->system_name, sizeof(e->system_name));
> +}
> +
> +static char *get_sysplex_name(Object *obj, Error **errp)
> +{
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
> +
> +    return g_strndup((char *) e->sysplex_name, sizeof(e->sysplex_name));
> +}
> +
> +static void get_system_level(Object *obj, Visitor *v, const char *name,
> +                             void *opaque, Error **errp)
> +{
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
> +
> +    visit_type_uint64(v, name, &e->system_level, errp);
> +}
> +
> +static void get_timestamp(Object *obj, Visitor *v, const char *name,
> +                             void *opaque, Error **errp)
> +{
> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
> +
> +    visit_type_uint64(v, name, &e->timestamp, errp);
> +}
> +
>  static void cpi_class_init(ObjectClass *klass, const void *data)
>  {
>      DeviceClass *dc = DEVICE_CLASS(klass);
> @@ -106,6 +156,30 @@ static void cpi_class_init(ObjectClass *klass, const void *data)
>      k->get_send_mask = send_mask;
>      k->get_receive_mask = receive_mask;
>      k->write_event_data = write_event_data;
> +
> +    object_class_property_add_str(klass, "system_type", get_system_type, NULL);
> +    object_class_property_set_description(klass, "system_type",
> +            "operating system e.g. \"LINUX   \"");
> +
> +    object_class_property_add_str(klass, "system_name", get_system_name, NULL);
> +    object_class_property_set_description(klass, "system_name",
> +            "user configurable name of the VM e.g. \"TESTVM  \"");
> +
> +    object_class_property_add_str(klass, "sysplex_name", get_sysplex_name,
> +                                  NULL);
> +    object_class_property_set_description(klass, "sysplex_name",
> +            "name of the cluster which the VM belongs to, if any"
> +            " e.g. \"PLEX    \"");
> +
> +    object_class_property_add(klass, "system_level", "uint64", get_system_level,
> +                              NULL, NULL, NULL);
> +    object_class_property_set_description(klass, "system_level",
> +            "distribution and kernel version in Linux e.g. 74872343805430528");
> +
> +    object_class_property_add(klass, "timestamp", "uint64", get_timestamp,
> +                              NULL, NULL, NULL);
> +    object_class_property_set_description(klass, "timestamp",
> +            "latest update of CPI data in nanoseconds since the UNIX EPOCH");
>  }
>  
>  static const TypeInfo sclp_cpi_info = {
> diff --git a/include/hw/s390x/event-facility.h b/include/hw/s390x/event-facility.h
> index e81bc80498..eac7a51100 100644
> --- a/include/hw/s390x/event-facility.h
> +++ b/include/hw/s390x/event-facility.h
> @@ -201,6 +201,11 @@ OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
>  
>  struct SCLPEventCPI {
>      SCLPEvent event;
> +    uint8_t system_type[8];
> +    uint8_t system_name[8];
> +    uint64_t system_level;
> +    uint8_t sysplex_name[8];
> +    uint64_t timestamp;
>  };
>  
>  #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"

Might want to make the uint8_ts into chars since it's ascii, but not important.
Reviewed-by: Nina Schoetterl-Glausch <nsg@linux.ibm.com>


-- 
IBM Deutschland Research & Development GmbH
Vorsitzender des Aufsichtsrats: Wolfgang Wendt
Geschäftsführung: David Faller
Sitz der Gesellschaft: Böblingen / Registergericht: Amtsgericht Stuttgart, HRB 243294

Re: [PATCH v6 2/3] hw/s390x: add Control-Program Identification to QOM

[Shalini Chellathurai Saroja]

On 2025-06-17 19:09, Nina Schoetterl-Glausch wrote:
> On Mon, 2025-06-16 at 16:01 +0200, Shalini Chellathurai Saroja wrote:
>> Add Control-Program Identification (CPI) data to the QEMU Object
>> Model (QOM), along with the timestamp in which the data was received
>> as shown below.
>> 
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-list",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi"}}'
>> {
>>   "return": [
>>     [...]
>>     {
>>       "name": "system_level",
>>       "type": "uint64"
>>     },
>>     {
>>       "name": "system_name",
>>       "type": "string"
>>     },
>>     {
>>       "name": "system_type",
>>       "type": "string"
>>     },
>>     {
>>       "name": "timestamp",
>>       "type": "uint64"
>>     },
>>     {
>>       "name": "sysplex_name",
>>       "type": "string"
>>     }
>>   ],
>>   "id": "libvirt-14"
>> }
>> 
>> Example CPI data:
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property":"system_type"}}'
>> {
>>   "return": "LINUX   ",
>>   "id": "libvirt-18"
>> }
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property":"system_name"}}'
>> {
>>   "return": "TESTVM  ",
>>   "id": "libvirt-19"
>> }
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property":"sysplex_name"}}'
>> {
>>   "return": "PLEX    ",
>>   "id": "libvirt-20"
>> }
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property":"system_level"}}'
>> {
>>   "return": 74872343805430528,
>>   "id": "libvirt-21"
>> }
>> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
>> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property":"timestamp"}}'
>> {
>>   "return": 1748866753433923000,
>>   "id": "libvirt-22"
>> }
>> 
>> Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
>> ---
>>  hw/s390x/sclpcpi.c                | 74 
>> +++++++++++++++++++++++++++++++
>>  include/hw/s390x/event-facility.h |  5 +++
>>  2 files changed, 79 insertions(+)
>> 
>> diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
>> index a0b175c5d5..352ef0461d 100644
>> --- a/hw/s390x/sclpcpi.c
>> +++ b/hw/s390x/sclpcpi.c
>> @@ -50,7 +50,10 @@
>>    */
>> 
>>  #include "qemu/osdep.h"
>> +#include "qemu/timer.h"
>>  #include "hw/s390x/event-facility.h"
>> +#include "hw/s390x/ebcdic.h"
>> +#include "qapi/qapi-visit-machine.h"
>> 
>>  typedef struct Data {
>>      uint8_t id_format;
>> @@ -90,11 +93,58 @@ static int write_event_data(SCLPEvent *event, 
>> EventBufferHeader *evt_buf_hdr)
>>  {
>>      ControlProgramIdMsg *cpim = container_of(evt_buf_hdr, 
>> ControlProgramIdMsg,
>>                                               ebh);
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(event);
>> +
>> +    ascii_put(e->system_type, (char *)cpim->data.system_type,
>> +              sizeof(cpim->data.system_type));
>> +    ascii_put(e->system_name, (char *)cpim->data.system_name,
>> +              sizeof(cpim->data.system_name));
>> +    ascii_put(e->sysplex_name, (char *)cpim->data.sysplex_name,
>> +              sizeof(cpim->data.sysplex_name));
>> +    e->system_level = ldq_be_p(&cpim->data.system_level);
>> +    e->timestamp = qemu_clock_get_ns(QEMU_CLOCK_HOST);
>> 
>>      cpim->ebh.flags = SCLP_EVENT_BUFFER_ACCEPTED;
>>      return SCLP_RC_NORMAL_COMPLETION;
>>  }
>> 
>> +static char *get_system_type(Object *obj, Error **errp)
>> +{
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
>> +
>> +    return g_strndup((char *) e->system_type, 
>> sizeof(e->system_type));
>> +}
>> +
>> +static char *get_system_name(Object *obj, Error **errp)
>> +{
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
>> +
>> +    return g_strndup((char *) e->system_name, 
>> sizeof(e->system_name));
>> +}
>> +
>> +static char *get_sysplex_name(Object *obj, Error **errp)
>> +{
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
>> +
>> +    return g_strndup((char *) e->sysplex_name, 
>> sizeof(e->sysplex_name));
>> +}
>> +
>> +static void get_system_level(Object *obj, Visitor *v, const char 
>> *name,
>> +                             void *opaque, Error **errp)
>> +{
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
>> +
>> +    visit_type_uint64(v, name, &e->system_level, errp);
>> +}
>> +
>> +static void get_timestamp(Object *obj, Visitor *v, const char *name,
>> +                             void *opaque, Error **errp)
>> +{
>> +    SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
>> +
>> +    visit_type_uint64(v, name, &e->timestamp, errp);
>> +}
>> +
>>  static void cpi_class_init(ObjectClass *klass, const void *data)
>>  {
>>      DeviceClass *dc = DEVICE_CLASS(klass);
>> @@ -106,6 +156,30 @@ static void cpi_class_init(ObjectClass *klass, 
>> const void *data)
>>      k->get_send_mask = send_mask;
>>      k->get_receive_mask = receive_mask;
>>      k->write_event_data = write_event_data;
>> +
>> +    object_class_property_add_str(klass, "system_type", 
>> get_system_type, NULL);
>> +    object_class_property_set_description(klass, "system_type",
>> +            "operating system e.g. \"LINUX   \"");
>> +
>> +    object_class_property_add_str(klass, "system_name", 
>> get_system_name, NULL);
>> +    object_class_property_set_description(klass, "system_name",
>> +            "user configurable name of the VM e.g. \"TESTVM  \"");
>> +
>> +    object_class_property_add_str(klass, "sysplex_name", 
>> get_sysplex_name,
>> +                                  NULL);
>> +    object_class_property_set_description(klass, "sysplex_name",
>> +            "name of the cluster which the VM belongs to, if any"
>> +            " e.g. \"PLEX    \"");
>> +
>> +    object_class_property_add(klass, "system_level", "uint64", 
>> get_system_level,
>> +                              NULL, NULL, NULL);
>> +    object_class_property_set_description(klass, "system_level",
>> +            "distribution and kernel version in Linux e.g. 
>> 74872343805430528");
>> +
>> +    object_class_property_add(klass, "timestamp", "uint64", 
>> get_timestamp,
>> +                              NULL, NULL, NULL);
>> +    object_class_property_set_description(klass, "timestamp",
>> +            "latest update of CPI data in nanoseconds since the UNIX 
>> EPOCH");
>>  }
>> 
>>  static const TypeInfo sclp_cpi_info = {
>> diff --git a/include/hw/s390x/event-facility.h 
>> b/include/hw/s390x/event-facility.h
>> index e81bc80498..eac7a51100 100644
>> --- a/include/hw/s390x/event-facility.h
>> +++ b/include/hw/s390x/event-facility.h
>> @@ -201,6 +201,11 @@ OBJECT_DECLARE_TYPE(SCLPEventCPI, 
>> SCLPEventCPIClass,
>> 
>>  struct SCLPEventCPI {
>>      SCLPEvent event;
>> +    uint8_t system_type[8];
>> +    uint8_t system_name[8];
>> +    uint64_t system_level;
>> +    uint8_t sysplex_name[8];
>> +    uint64_t timestamp;
>>  };
>> 
>>  #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
> 
> Might want to make the uint8_ts into chars since it's ascii, but not 
> important.
> Reviewed-by: Nina Schoetterl-Glausch <nsg@linux.ibm.com>

Hello Nina,

Thank you very much for the quick review.

-- 
Mit freundlichen Grüßen / Kind regards
Shalini Chellathurai Saroja
Software Developer
Linux on IBM Z & KVM Development
IBM Deutschland Research & Development GmbH
Dept 1419, Schoenaicher Str. 220, 71032 Boeblingen
Vorsitzender des Aufsichtsrats: Wolfgang Wendt
Geschäftsführung: David Faller
Sitz der Gesellschaft: Böblingen / Registergericht: Amtsgericht 
Stuttgart, HRB 243294

Re: [PATCH v6 2/3] hw/s390x: add Control-Program Identification to QOM

[Thomas Huth]

On 16/06/2025 16.01, Shalini Chellathurai Saroja wrote:
> Add Control-Program Identification (CPI) data to the QEMU Object
> Model (QOM), along with the timestamp in which the data was received
> as shown below.
> 
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-list",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi"}}'
> {
>    "return": [
>      [...]
>      {
>        "name": "system_level",
>        "type": "uint64"
>      },
>      {
>        "name": "system_name",
>        "type": "string"
>      },
>      {
>        "name": "system_type",
>        "type": "string"
>      },
>      {
>        "name": "timestamp",
>        "type": "uint64"
>      },
>      {
>        "name": "sysplex_name",
>        "type": "string"
>      }
>    ],
>    "id": "libvirt-14"
> }
> 
> Example CPI data:
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_type"}}'
> {
>    "return": "LINUX   ",
>    "id": "libvirt-18"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_name"}}'
> {
>    "return": "TESTVM  ",
>    "id": "libvirt-19"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"sysplex_name"}}'
> {
>    "return": "PLEX    ",
>    "id": "libvirt-20"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"system_level"}}'
> {
>    "return": 74872343805430528,
>    "id": "libvirt-21"
> }
> virsh # qemu-monitor-command vm --pretty '{"execute":"qom-get",
> "arguments":{"path":"/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property":"timestamp"}}'
> {
>    "return": 1748866753433923000,
>    "id": "libvirt-22"
> }
> 
> Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
> ---
>   hw/s390x/sclpcpi.c                | 74 +++++++++++++++++++++++++++++++
>   include/hw/s390x/event-facility.h |  5 +++
>   2 files changed, 79 insertions(+)

Reviewed-by: Thomas Huth <thuth@redhat.com>

Re: [PATCH v6 0/3] Add SCLP event type CPI

[Thomas Huth]

On 16/06/2025 16.01, Shalini Chellathurai Saroja wrote:
> Implement the Service-Call Logical Processor (SCLP) event
> type Control-Program Identification (CPI) in QEMU.
> 
> Changed since v5:
> - Add identifiers as class properties instead of object properties
> - Add description for all the class properties
> - Remove S390ControlProgramId as it is not needed anymore
> - Update description of system_level identifier
> - Add Reviewed-by tags

  Hi Shalini!

Thanks, I've picked this up for my next pull request.

If you've got some spare time, could you maybe also look into writing a 
regression test for this, e.g. by extending one of the tests in 
tests/functional/test_s390x_ccw_virtio.py to see whether the guests provide 
the expected information via CPI there? (I hope the guests in that test are 
recent enough for this feature, otherwise we might want to update them)

  Thanks,
   Thomas

Re: [PATCH v6 0/3] Add SCLP event type CPI

[Shalini Chellathurai Saroja]

On 2025-06-24 12:25, Thomas Huth wrote:
> On 16/06/2025 16.01, Shalini Chellathurai Saroja wrote:
>> Implement the Service-Call Logical Processor (SCLP) event
>> type Control-Program Identification (CPI) in QEMU.
>> 
>> Changed since v5:
>> - Add identifiers as class properties instead of object properties
>> - Add description for all the class properties
>> - Remove S390ControlProgramId as it is not needed anymore
>> - Update description of system_level identifier
>> - Add Reviewed-by tags
> 
>  Hi Shalini!
> 
> Thanks, I've picked this up for my next pull request.
> 
> If you've got some spare time, could you maybe also look into writing
> a regression test for this, e.g. by extending one of the tests in
> tests/functional/test_s390x_ccw_virtio.py to see whether the guests
> provide the expected information via CPI there? (I hope the guests in
> that test are recent enough for this feature, otherwise we might want
> to update them)
> 

Hello Thomas,

Thank you very much. Yes, I will do so.

>  Thanks,
>   Thomas

-- 
Mit freundlichen Grüßen / Kind regards
Shalini Chellathurai Saroja
Software Developer
Linux on IBM Z & KVM Development
IBM Deutschland Research & Development GmbH
Dept 1419, Schoenaicher Str. 220, 71032 Boeblingen
Vorsitzender des Aufsichtsrats: Wolfgang Wendt
Geschäftsführung: David Faller
Sitz der Gesellschaft: Böblingen / Registergericht: Amtsgericht 
Stuttgart, HRB 243294