Add Control-Program Identification data to the QEMU Object
Model (QOM), along with the timestamp in which the data was received.
Example:
virsh # qemu-monitor-command vm --pretty '{
"execute": "qom-get",
"arguments": {
"path": "/machine/sclp/s390-sclp-event-facility/sclpcpi",
"property": "control-program-id" }}'
{
"return": {
"timestamp": 1742390410685762000,
"system-level": 74872343805430528,
"sysplex-name": "PLEX ",
"system-name": "TESTVM ",
"system-type": "LINUX "
},
"id": "libvirt-15"
}
Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
---
hw/s390x/sclpcpi.c | 39 +++++++++++++++++++++
include/hw/s390x/event-facility.h | 9 +++++
qapi/machine.json | 58 +++++++++++++++++++++++++++++++
3 files changed, 106 insertions(+)
diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
index 13589459b1..dcc8bd3245 100644
--- a/hw/s390x/sclpcpi.c
+++ b/hw/s390x/sclpcpi.c
@@ -18,7 +18,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;
@@ -58,11 +61,39 @@ 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->cpi.system_type, (char *)cpim->data.system_type, 8);
+ ascii_put(e->cpi.system_name, (char *)cpim->data.system_name, 8);
+ ascii_put(e->cpi.sysplex_name, (char *)cpim->data.sysplex_name, 8);
+ e->cpi.system_level = ldq_be_p(&cpim->data.system_level);
+ e->cpi.timestamp = qemu_clock_get_ns(QEMU_CLOCK_HOST);
cpim->ebh.flags = SCLP_EVENT_BUFFER_ACCEPTED;
return SCLP_RC_NORMAL_COMPLETION;
}
+static void get_control_program_id(Object *obj, Visitor *v,
+ const char *name, void *opaque,
+ Error **errp)
+{
+ SCLPEventCPI *e = SCLP_EVENT_CPI(obj);
+ S390ControlProgramId *cpi;
+
+ cpi = &(S390ControlProgramId){
+ .system_type = g_strndup((char *) e->cpi.system_type,
+ sizeof(e->cpi.system_type)),
+ .system_name = g_strndup((char *) e->cpi.system_name,
+ sizeof(e->cpi.system_name)),
+ .system_level = e->cpi.system_level,
+ .sysplex_name = g_strndup((char *) e->cpi.sysplex_name,
+ sizeof(e->cpi.sysplex_name)),
+ .timestamp = e->cpi.timestamp
+ };
+
+ visit_type_S390ControlProgramId(v, name, &cpi, errp);
+}
+
static void cpi_class_init(ObjectClass *klass, void *data)
{
DeviceClass *dc = DEVICE_CLASS(klass);
@@ -74,6 +105,14 @@ static void cpi_class_init(ObjectClass *klass, 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(klass, "control-program-id",
+ "S390ControlProgramId",
+ get_control_program_id,
+ NULL, NULL, NULL);
+ object_class_property_set_description(klass, "control-program-id",
+ "Control-program identifiers provide data about the guest "
+ "operating system");
}
static const TypeInfo sclp_cpi_info = {
diff --git a/include/hw/s390x/event-facility.h b/include/hw/s390x/event-facility.h
index ef469e62ae..123c4ac49c 100644
--- a/include/hw/s390x/event-facility.h
+++ b/include/hw/s390x/event-facility.h
@@ -199,9 +199,18 @@ typedef struct SCLPEventCPI SCLPEventCPI;
OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
SCLP_EVENT_CPI)
+typedef struct ControlProgramId {
+ uint8_t system_type[8];
+ uint8_t system_name[8];
+ uint64_t system_level;
+ uint8_t sysplex_name[8];
+ uint64_t timestamp;
+} ControlProgramId;
+
struct SCLPEventCPI {
DeviceState qdev;
SCLPEvent event;
+ ControlProgramId cpi;
};
#define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
diff --git a/qapi/machine.json b/qapi/machine.json
index a6b8795b09..cd2bcd2d13 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1898,3 +1898,61 @@
{ 'command': 'x-query-interrupt-controllers',
'returns': 'HumanReadableText',
'features': [ 'unstable' ]}
+
+##
+# @S390ControlProgramId:
+#
+# 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 one hexadecimal byte, 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.
+#
+# @system-type: operating system (e.g. "LINUX ")
+#
+# @system-name: user configurable name of the VM (e.g. "TESTVM ")
+#
+# @system-level: distribution and kernel version in Linux
+#
+# @sysplex-name: sysplex which the VM belongs to, if any (e.g. "PLEX ")
+#
+# @timestamp: latest update of CPI data in nanoseconds since the UNIX EPOCH
+#
+# Since: 10.0
+##
+{ 'struct': 'S390ControlProgramId', 'data': {
+ 'system-type': 'str',
+ 'system-name': 'str',
+ 'system-level': 'uint64',
+ 'sysplex-name': 'str',
+ 'timestamp': 'uint64' } }
--
2.49.0On 10/04/2025 17.09, Shalini Chellathurai Saroja wrote:
> Add Control-Program Identification data to the QEMU Object
> Model (QOM), along with the timestamp in which the data was received.
...
> diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
> index 13589459b1..dcc8bd3245 100644
> --- a/hw/s390x/sclpcpi.c
> +++ b/hw/s390x/sclpcpi.c
> @@ -18,7 +18,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;
> @@ -58,11 +61,39 @@ 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->cpi.system_type, (char *)cpim->data.system_type, 8);
> + ascii_put(e->cpi.system_name, (char *)cpim->data.system_name, 8);
> + ascii_put(e->cpi.sysplex_name, (char *)cpim->data.sysplex_name, 8);
Would it be possible to use sizeof() instead of hard-coding "8" here?
Thanks,
Thomas
On 2025-04-30 12:34, Thomas Huth wrote:
> On 10/04/2025 17.09, Shalini Chellathurai Saroja wrote:
>> Add Control-Program Identification data to the QEMU Object
>> Model (QOM), along with the timestamp in which the data was received.
> ...
>> diff --git a/hw/s390x/sclpcpi.c b/hw/s390x/sclpcpi.c
>> index 13589459b1..dcc8bd3245 100644
>> --- a/hw/s390x/sclpcpi.c
>> +++ b/hw/s390x/sclpcpi.c
>> @@ -18,7 +18,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;
>> @@ -58,11 +61,39 @@ 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->cpi.system_type, (char *)cpim->data.system_type, 8);
>> + ascii_put(e->cpi.system_name, (char *)cpim->data.system_name, 8);
>> + ascii_put(e->cpi.sysplex_name, (char *)cpim->data.sysplex_name,
>> 8);
>
> Would it be possible to use sizeof() instead of hard-coding "8" here?
Hello Thomas,
Yes, it is. I will do so. Thank you very much for the review.
I will also move the property use_cpi to ccw_machine_10_0_class_options,
as version 10.0 is already released.
>
> 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
On Thu, 2025-04-10 at 17:09 +0200, Shalini Chellathurai Saroja wrote:
> Add Control-Program Identification data to the QEMU Object
> Model (QOM), along with the timestamp in which the data was received.
>
> Example:
> virsh # qemu-monitor-command vm --pretty '{
> "execute": "qom-get",
> "arguments": {
> "path": "/machine/sclp/s390-sclp-event-facility/sclpcpi",
> "property": "control-program-id" }}'
> {
> "return": {
> "timestamp": 1742390410685762000,
> "system-level": 74872343805430528,
> "sysplex-name": "PLEX ",
> "system-name": "TESTVM ",
> "system-type": "LINUX "
> },
> "id": "libvirt-15"
> }
>
> Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
> ---
> hw/s390x/sclpcpi.c | 39 +++++++++++++++++++++
> include/hw/s390x/event-facility.h | 9 +++++
> qapi/machine.json | 58 +++++++++++++++++++++++++++++++
> 3 files changed, 106 insertions(+)
[...]
> --- a/include/hw/s390x/event-facility.h
> +++ b/include/hw/s390x/event-facility.h
> @@ -199,9 +199,18 @@ typedef struct SCLPEventCPI SCLPEventCPI;
> OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
> SCLP_EVENT_CPI)
>
> +typedef struct ControlProgramId {
> + uint8_t system_type[8];
> + uint8_t system_name[8];
> + uint64_t system_level;
> + uint8_t sysplex_name[8];
> + uint64_t timestamp;
> +} ControlProgramId;
> +
> struct SCLPEventCPI {
> DeviceState qdev;
> SCLPEvent event;
> + ControlProgramId cpi;
Now that this struct exists I would go ahead and inline ControlProgramId.
> };
>
> #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
[...]
--
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
On 2025-04-28 14:01, Nina Schoetterl-Glausch wrote:
> On Thu, 2025-04-10 at 17:09 +0200, Shalini Chellathurai Saroja wrote:
>> Add Control-Program Identification data to the QEMU Object
>> Model (QOM), along with the timestamp in which the data was received.
>>
>> Example:
>> virsh # qemu-monitor-command vm --pretty '{
>> "execute": "qom-get",
>> "arguments": {
>> "path": "/machine/sclp/s390-sclp-event-facility/sclpcpi",
>> "property": "control-program-id" }}'
>> {
>> "return": {
>> "timestamp": 1742390410685762000,
>> "system-level": 74872343805430528,
>> "sysplex-name": "PLEX ",
>> "system-name": "TESTVM ",
>> "system-type": "LINUX "
>> },
>> "id": "libvirt-15"
>> }
>>
>> Signed-off-by: Shalini Chellathurai Saroja <shalini@linux.ibm.com>
>> ---
>> hw/s390x/sclpcpi.c | 39 +++++++++++++++++++++
>> include/hw/s390x/event-facility.h | 9 +++++
>> qapi/machine.json | 58
>> +++++++++++++++++++++++++++++++
>> 3 files changed, 106 insertions(+)
>
> [...]
>
>> --- a/include/hw/s390x/event-facility.h
>> +++ b/include/hw/s390x/event-facility.h
>> @@ -199,9 +199,18 @@ typedef struct SCLPEventCPI SCLPEventCPI;
>> OBJECT_DECLARE_TYPE(SCLPEventCPI, SCLPEventCPIClass,
>> SCLP_EVENT_CPI)
>>
>> +typedef struct ControlProgramId {
>> + uint8_t system_type[8];
>> + uint8_t system_name[8];
>> + uint64_t system_level;
>> + uint8_t sysplex_name[8];
>> + uint64_t timestamp;
>> +} ControlProgramId;
>> +
>> struct SCLPEventCPI {
>> DeviceState qdev;
>> SCLPEvent event;
>> + ControlProgramId cpi;
>
> Now that this struct exists I would go ahead and inline
> ControlProgramId.
Ok, I will do so, thank you.
>
>> };
>>
>> #define TYPE_SCLP_EVENT_FACILITY "s390-sclp-event-facility"
>
> [...]
--
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
© 2016 - 2025 Red Hat, Inc.