Re: [PATCH v5] cxl/events: Use a common struct for DRAM and General Media events
From: Fabio M. De Francesco
Date: Sun Jun 02 2024 - 15:12:07 EST
On Sunday, June 2, 2024 8:31:29 PM GMT+2 Fabio M. De Francesco wrote:
> cxl_event_common was an unfortunate naming choice and caused confusion with
> the existing Common Event Record. Furthermore, its fields didn't map all
> the common information between DRAM and General Media Events.
>
> Remove cxl_event_common and introduce cxl_event_media_hdr to record common
> information between DRAM and General Media events.
>
> cxl_event_media_hdr, which is embedded in both cxl_event_gen_media and
> cxl_event_dram, leverages the commonalities between the two events to
> simplify their respective handling.
>
> Suggested-by: Dan Williams <dan.j.williams@xxxxxxxxx>
Please discard this v5 because the Reviewed-by tags are missing.
Fabio
> Signed-off-by: Fabio M. De Francesco <fabio.m.de.francesco@xxxxxxxxxxxxxxx>
> ---
>
> - Changes for v5 -
>
> - Rebase on v6.10-rc1
>
> - Changes for v4 -
>
> - Initialise cxl_test_dram and cxl_test_gen_media without
> unnecessary extra de-references (Dan)
> - Add a comment for media_hdr in union cxl_event (Alison)
>
> - Changes for v3 -
>
> - Rework the layout of cxl_event_dram and cxl_event_gen_media to
> make a simpler change (Dan)
> - Remove a "Fixes" tag (Dan)
> - Don't use unnecessary struct_group[_tagged] (Jonathan, Ira)
> - Rewrite end extend the commit message
>
> - Link to v4 -
>
> https://lore.kernel.org/linux-cxl/20240521140750.26035-1-fabio.m.de.francesco@xxxxxxxxxxxxxxx/
>
> drivers/cxl/core/mbox.c | 2 +-
> drivers/cxl/core/trace.h | 32 ++++++++++-----------
> include/linux/cxl-event.h | 41 ++++++++++-----------------
> tools/testing/cxl/test/mem.c | 54 +++++++++++++++++++-----------------
> 4 files changed, 61 insertions(+), 68 deletions(-)
>
> diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c
> index 2626f3fff201..a08f050cc1ca 100644
> --- a/drivers/cxl/core/mbox.c
> +++ b/drivers/cxl/core/mbox.c
> @@ -875,7 +875,7 @@ void cxl_event_trace_record(const struct cxl_memdev
*cxlmd,
> guard(rwsem_read)(&cxl_region_rwsem);
> guard(rwsem_read)(&cxl_dpa_rwsem);
>
> - dpa = le64_to_cpu(evt->common.phys_addr) &
CXL_DPA_MASK;
> + dpa = le64_to_cpu(evt->media_hdr.phys_addr) &
CXL_DPA_MASK;
> cxlr = cxl_dpa_to_region(cxlmd, dpa);
> if (cxlr)
> hpa = cxl_trace_hpa(cxlr, cxlmd, dpa);
> diff --git a/drivers/cxl/core/trace.h b/drivers/cxl/core/trace.h
> index ee5cd4eb2f16..6d8b71d8f6c4 100644
> --- a/drivers/cxl/core/trace.h
> +++ b/drivers/cxl/core/trace.h
> @@ -340,23 +340,23 @@ TRACE_EVENT(cxl_general_media,
> ),
>
> TP_fast_assign(
> - CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
> + CXL_EVT_TP_fast_assign(cxlmd, log, rec->media_hdr.hdr);
> __entry->hdr_uuid = CXL_EVENT_GEN_MEDIA_UUID;
>
> /* General Media */
> - __entry->dpa = le64_to_cpu(rec->phys_addr);
> + __entry->dpa = le64_to_cpu(rec->media_hdr.phys_addr);
> __entry->dpa_flags = __entry->dpa & CXL_DPA_FLAGS_MASK;
> /* Mask after flags have been parsed */
> __entry->dpa &= CXL_DPA_MASK;
> - __entry->descriptor = rec->descriptor;
> - __entry->type = rec->type;
> - __entry->transaction_type = rec->transaction_type;
> - __entry->channel = rec->channel;
> - __entry->rank = rec->rank;
> + __entry->descriptor = rec->media_hdr.descriptor;
> + __entry->type = rec->media_hdr.type;
> + __entry->transaction_type = rec-
>media_hdr.transaction_type;
> + __entry->channel = rec->media_hdr.channel;
> + __entry->rank = rec->media_hdr.rank;
> __entry->device = get_unaligned_le24(rec->device);
> memcpy(__entry->comp_id, &rec->component_id,
> CXL_EVENT_GEN_MED_COMP_ID_SIZE);
> - __entry->validity_flags = get_unaligned_le16(&rec-
>validity_flags);
> + __entry->validity_flags = get_unaligned_le16(&rec-
>media_hdr.validity_flags);
> __entry->hpa = hpa;
> if (cxlr) {
> __assign_str(region_name);
> @@ -440,19 +440,19 @@ TRACE_EVENT(cxl_dram,
> ),
>
> TP_fast_assign(
> - CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
> + CXL_EVT_TP_fast_assign(cxlmd, log, rec->media_hdr.hdr);
> __entry->hdr_uuid = CXL_EVENT_DRAM_UUID;
>
> /* DRAM */
> - __entry->dpa = le64_to_cpu(rec->phys_addr);
> + __entry->dpa = le64_to_cpu(rec->media_hdr.phys_addr);
> __entry->dpa_flags = __entry->dpa & CXL_DPA_FLAGS_MASK;
> __entry->dpa &= CXL_DPA_MASK;
> - __entry->descriptor = rec->descriptor;
> - __entry->type = rec->type;
> - __entry->transaction_type = rec->transaction_type;
> - __entry->validity_flags = get_unaligned_le16(rec-
>validity_flags);
> - __entry->channel = rec->channel;
> - __entry->rank = rec->rank;
> + __entry->descriptor = rec->media_hdr.descriptor;
> + __entry->type = rec->media_hdr.type;
> + __entry->transaction_type = rec-
>media_hdr.transaction_type;
> + __entry->validity_flags = get_unaligned_le16(rec-
>media_hdr.validity_flags);
> + __entry->channel = rec->media_hdr.channel;
> + __entry->rank = rec->media_hdr.rank;
> __entry->nibble_mask = get_unaligned_le24(rec-
>nibble_mask);
> __entry->bank_group = rec->bank_group;
> __entry->bank = rec->bank;
> diff --git a/include/linux/cxl-event.h b/include/linux/cxl-event.h
> index 60b25020281f..1119d0bbb091 100644
> --- a/include/linux/cxl-event.h
> +++ b/include/linux/cxl-event.h
> @@ -21,6 +21,17 @@ struct cxl_event_record_hdr {
> u8 reserved[15];
> } __packed;
>
> +struct cxl_event_media_hdr {
> + struct cxl_event_record_hdr hdr;
> + __le64 phys_addr;
> + u8 descriptor;
> + u8 type;
> + u8 transaction_type;
> + u8 validity_flags[2];
> + u8 channel;
> + u8 rank;
> +} __packed;
> +
> #define CXL_EVENT_RECORD_DATA_LENGTH 0x50
> struct cxl_event_generic {
> struct cxl_event_record_hdr hdr;
> @@ -33,14 +44,7 @@ struct cxl_event_generic {
> */
> #define CXL_EVENT_GEN_MED_COMP_ID_SIZE 0x10
> struct cxl_event_gen_media {
> - struct cxl_event_record_hdr hdr;
> - __le64 phys_addr;
> - u8 descriptor;
> - u8 type;
> - u8 transaction_type;
> - u8 validity_flags[2];
> - u8 channel;
> - u8 rank;
> + struct cxl_event_media_hdr media_hdr;
> u8 device[3];
> u8 component_id[CXL_EVENT_GEN_MED_COMP_ID_SIZE];
> u8 reserved[46];
> @@ -52,14 +56,7 @@ struct cxl_event_gen_media {
> */
> #define CXL_EVENT_DER_CORRECTION_MASK_SIZE 0x20
> struct cxl_event_dram {
> - struct cxl_event_record_hdr hdr;
> - __le64 phys_addr;
> - u8 descriptor;
> - u8 type;
> - u8 transaction_type;
> - u8 validity_flags[2];
> - u8 channel;
> - u8 rank;
> + struct cxl_event_media_hdr media_hdr;
> u8 nibble_mask[3];
> u8 bank_group;
> u8 bank;
> @@ -95,21 +92,13 @@ struct cxl_event_mem_module {
> u8 reserved[0x3d];
> } __packed;
>
> -/*
> - * General Media or DRAM Event Common Fields
> - * - provides common access to phys_addr
> - */
> -struct cxl_event_common {
> - struct cxl_event_record_hdr hdr;
> - __le64 phys_addr;
> -} __packed;
> -
> union cxl_event {
> struct cxl_event_generic generic;
> struct cxl_event_gen_media gen_media;
> struct cxl_event_dram dram;
> struct cxl_event_mem_module mem_module;
> - struct cxl_event_common common;
> + /* dram & gen_media event header */
> + struct cxl_event_media_hdr media_hdr;
> } __packed;
>
> /*
> diff --git a/tools/testing/cxl/test/mem.c b/tools/testing/cxl/test/mem.c
> index 6584443144de..142333e63cdf 100644
> --- a/tools/testing/cxl/test/mem.c
> +++ b/tools/testing/cxl/test/mem.c
> @@ -384,19 +384,21 @@ struct cxl_test_gen_media {
> struct cxl_test_gen_media gen_media = {
> .id = CXL_EVENT_GEN_MEDIA_UUID,
> .rec = {
> - .hdr = {
> - .length = sizeof(struct cxl_test_gen_media),
> - .flags[0] = CXL_EVENT_RECORD_FLAG_PERMANENT,
> - /* .handle = Set dynamically */
> - .related_handle = cpu_to_le16(0),
> + .media_hdr = {
> + .hdr = {
> + .length = sizeof(struct
cxl_test_gen_media),
> + .flags[0] =
CXL_EVENT_RECORD_FLAG_PERMANENT,
> + /* .handle = Set dynamically */
> + .related_handle = cpu_to_le16(0),
> + },
> + .phys_addr = cpu_to_le64(0x2000),
> + .descriptor =
CXL_GMER_EVT_DESC_UNCORECTABLE_EVENT,
> + .type =
CXL_GMER_MEM_EVT_TYPE_DATA_PATH_ERROR,
> + .transaction_type =
CXL_GMER_TRANS_HOST_WRITE,
> + /* .validity_flags = <set below> */
> + .channel = 1,
> + .rank = 30,
> },
> - .phys_addr = cpu_to_le64(0x2000),
> - .descriptor = CXL_GMER_EVT_DESC_UNCORECTABLE_EVENT,
> - .type = CXL_GMER_MEM_EVT_TYPE_DATA_PATH_ERROR,
> - .transaction_type = CXL_GMER_TRANS_HOST_WRITE,
> - /* .validity_flags = <set below> */
> - .channel = 1,
> - .rank = 30
> },
> };
>
> @@ -408,18 +410,20 @@ struct cxl_test_dram {
> struct cxl_test_dram dram = {
> .id = CXL_EVENT_DRAM_UUID,
> .rec = {
> - .hdr = {
> - .length = sizeof(struct cxl_test_dram),
> - .flags[0] =
CXL_EVENT_RECORD_FLAG_PERF_DEGRADED,
> - /* .handle = Set dynamically */
> - .related_handle = cpu_to_le16(0),
> + .media_hdr = {
> + .hdr = {
> + .length = sizeof(struct
cxl_test_dram),
> + .flags[0] =
CXL_EVENT_RECORD_FLAG_PERF_DEGRADED,
> + /* .handle = Set dynamically */
> + .related_handle = cpu_to_le16(0),
> + },
> + .phys_addr = cpu_to_le64(0x8000),
> + .descriptor =
CXL_GMER_EVT_DESC_THRESHOLD_EVENT,
> + .type = CXL_GMER_MEM_EVT_TYPE_INV_ADDR,
> + .transaction_type =
CXL_GMER_TRANS_INTERNAL_MEDIA_SCRUB,
> + /* .validity_flags = <set below> */
> + .channel = 1,
> },
> - .phys_addr = cpu_to_le64(0x8000),
> - .descriptor = CXL_GMER_EVT_DESC_THRESHOLD_EVENT,
> - .type = CXL_GMER_MEM_EVT_TYPE_INV_ADDR,
> - .transaction_type =
CXL_GMER_TRANS_INTERNAL_MEDIA_SCRUB,
> - /* .validity_flags = <set below> */
> - .channel = 1,
> .bank_group = 5,
> .bank = 2,
> .column = {0xDE, 0xAD},
> @@ -473,11 +477,11 @@ static int mock_set_timestamp(struct cxl_dev_state
*cxlds,
> static void cxl_mock_add_event_logs(struct mock_event_store *mes)
> {
> put_unaligned_le16(CXL_GMER_VALID_CHANNEL | CXL_GMER_VALID_RANK,
> - &gen_media.rec.validity_flags);
> + &gen_media.rec.media_hdr.validity_flags);
>
> put_unaligned_le16(CXL_DER_VALID_CHANNEL |
CXL_DER_VALID_BANK_GROUP |
> CXL_DER_VALID_BANK |
CXL_DER_VALID_COLUMN,
> - &dram.rec.validity_flags);
> + &dram.rec.media_hdr.validity_flags);
>
> mes_add_event(mes, CXL_EVENT_TYPE_INFO, &maint_needed);
> mes_add_event(mes, CXL_EVENT_TYPE_INFO,
>