Received-SPF: pass (google.com: domain of linux-kernel+bounces-181660-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Thu, 16 May 2024 17:43:33 -0700
From: Dan Williams <dan.j.williams@intel.com>
To: "Fabio M. De Francesco" <fabio.m.de.francesco@linux.intel.com>, "Davidlohr
 Bueso" <dave@stgolabs.net>, Jonathan Cameron <jonathan.cameron@huawei.com>,
	Dave Jiang <dave.jiang@intel.com>, Alison Schofield
	<alison.schofield@intel.com>, Vishal Verma <vishal.l.verma@intel.com>, "Ira
 Weiny" <ira.weiny@intel.com>, Dan Williams <dan.j.williams@intel.com>,
	<linux-cxl@vger.kernel.org>, <linux-kernel@vger.kernel.org>
CC: "Fabio M. De Francesco" <fabio.m.de.francesco@linux.intel.com>
Subject: RE: [PATCH v2] cxl/events: Use a common struct for DRAM and General
 Media events
Message-ID: <6646a835ac144_2c26294da@dwillia2-xfh.jf.intel.com.notmuch>
References: <20240516102116.3512377-1-fabio.m.de.francesco@linux.intel.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20240516102116.3512377-1-fabio.m.de.francesco@linux.intel.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?ivMPDXyPqlr4MiPyzK9ZT2BBh5lqR+elnPEXgfOPIMtZtreWexx4oYGMg/sm?=
 =?us-ascii?Q?zbv0MYakSZJWmZX24y7u5RBDR225nO2GgQzwu0o2sMi9+K5M3ixyHnUFoZVb?=
 =?us-ascii?Q?ITT+MDqLhVh8sgiaPMRbf1F12tENWopMtTBZmvTIslBIH0sEp66bOB9KcfiN?=
 =?us-ascii?Q?2fqIXMEjfphI01xJ3UAU0vVz37sPhf1WMXqBF/K2Hzc0O0gKvBYvYLoybWTo?=
 =?us-ascii?Q?al/eNOx6BlIP2ydLiJyVIGS3sA1Aoo6wdXv5VzY9xhQ/YTRFP70CCS8whVIm?=
 =?us-ascii?Q?FWuwrp0xdpx9tcLASeqAZeFsQMk+3KJLmP50hXPidn77LY6YCOs/kE+z7ppn?=
 =?us-ascii?Q?SQwzMArJqfdP4bg8nb/6d3Zth4Pl38I9AWRWdu21GXwIDmnt+m4sFLXI0YsS?=
 =?us-ascii?Q?dugTyqUDkSfhAB+wH5ihfvI8ZOB86Kyu7Y32l3EM5ETSbUbgatxR+oKgJOGx?=
 =?us-ascii?Q?8HTBq5h6kTUGGpFwvO9uuESspc2I3nSQfDGBqGXSrzSRwnT9DoD76O6ytYL7?=
 =?us-ascii?Q?7PvhxZOlcO+8K9jqTBvoilchR2FO7y9SOf/akn3GrF3HHoCWmXf4i842Rc19?=
 =?us-ascii?Q?dNcZzIAagka4Vgp+V6TsDMq2tkbqX+2jXOm8hItai7CHgvOfhmYNQQGkNGv3?=
 =?us-ascii?Q?iY1TXFTG+qBy4+fw44zAamU9HARNKKhea5qxrTLX4EnkvhjKFPNRFQgHb6hC?=
 =?us-ascii?Q?6gZYydBbjW85ndtES4j2Y9V5Jn1JAdFs7Sm0soxDaUTkqcFy6Ag6k2rNOolO?=
 =?us-ascii?Q?DsNrWctguLC7LKiTi1wVnocng2e8uidVLDexGuMkJMqwiOab7FRnRPOvn30j?=
 =?us-ascii?Q?rQAS+C2tVQynQL4NBfnWzPB3odPmv70eFgZdHRGC55Pzeb5RQMNPIgZOyOlR?=
 =?us-ascii?Q?Hdc5lfl1wkOi8UZT5riya9tR0J11Of+gxuWMwG6NxNpDtjppqhO1i/0aTkC0?=
 =?us-ascii?Q?9RHEslX0GMOaI/mdmfXXgjFd8bqwF1IdjGDlGqxqJGGV7x4E/C+xFVVFX9y7?=
 =?us-ascii?Q?oSMCpwJH7kPSfvc3RVwQsH76/+bv7zgU21uYL5F77pAx9SO6DWUl7zoRN5V0?=
 =?us-ascii?Q?rvQB7Qnr0bVRVCCO7hydJq416WDh9KU0uLX8kJeNvG5sg1jBhPOvpT2bpG0v?=
 =?us-ascii?Q?sVBtRY9DWAf0B6LRBMXKvzWOX13E9JtEmD5YM+9Y6W1hN+Z75XdXsFA1epDi?=
 =?us-ascii?Q?fCGh2sq7xZiyJSiRM/uH10sTndOmQf4K3iKI9TGD0kWizyuGie8V9OBTxz88?=
 =?us-ascii?Q?c6UeR0tMNoo48nk6Fpzu2wJZ56YM2lHA0YuFArAX5wKMvbS6e5wBSfp3zkwB?=
 =?us-ascii?Q?aokxh6omvNwkfZi9dzFxa7hpx1v+sMQ06p3xqlNdwZ6YSIC1hW5u49tIIhUS?=
 =?us-ascii?Q?hjaHG9/hog2hxDTdXhkn4+paidnP1AoF6vhx+sSt9rI5aSo2jZjGUatcEXWC?=
 =?us-ascii?Q?aygbiXuj0zQLYIfdIXQ2pCpqWOTrZvIrLTf7DWIOV9wKx/BJVkZ1kCve5kr8?=
 =?us-ascii?Q?GxvMeutli707WqegBaKdr/yM3Hm7QW3NFhN3jouxEq6CzRjcTXIyWQKdhrvC?=
 =?us-ascii?Q?KwpdynO4oMtKaP1gIZCk3Jvfz+1kpdl+qPcSd777p50+NqFqizpiuT4pYqbw?=
 =?us-ascii?Q?Tw=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: b2f1142b-ecd5-4500-f93b-08dc760a62f6
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 May 2024 00:43:36.2942
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Olmm1ZDSJpRSy0n2Joob/psRBCB0BFxweHT7/RiuK0DKniqvCnuGXwg09I136NJ9hXy51EJxHDfSsCrbyUz83Vvpmuh2Mp2mmCVOSkcucKI=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB6694
X-OriginatorOrg: intel.com

Fabio M. De Francesco wrote:
> cxl_event_common was a poor naming choice and caused confusion with the
> existing Common Event Record.

I would say "unfortunate" rather than "poor".

> Use cxl_event_media as a common structure to record information about DRAM
> and General Media events because it simplifies handling the two events.
> 
> Suggested-by: Dan Williams <dan.j.williams@intel.com>
> Fixes: 6aec00139d3a ("cxl/core: Add region info to cxl_general_media and cxl_dram events")

What is the fix? There is no user visible behavior changes that results from
this cleanup, right?

> Signed-off-by: Fabio M. De Francesco <fabio.m.de.francesco@linux.intel.com>
> ---
> 
> Changes for v2:
> 	- Extend the commit message (Alison);
> 	- Add a "Fixes" tag (Alison, thanks).
> 
>  drivers/cxl/core/mbox.c      |  6 ++--
>  drivers/cxl/core/trace.h     |  4 +--
>  include/linux/cxl-event.h    | 70 +++++++++++++++---------------------
>  tools/testing/cxl/test/mem.c |  4 +--
>  4 files changed, 36 insertions(+), 48 deletions(-)

Oh, nice, net reduction in code I was not expecting.

> 
> diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c
> index 2626f3fff201..ad4d7b0f7f4d 100644
> --- a/drivers/cxl/core/mbox.c
> +++ b/drivers/cxl/core/mbox.c
> @@ -875,16 +875,16 @@ 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_common.phys_addr) & CXL_DPA_MASK;

I was hoping at the end of this to get rid of the word "common" to avoid any
more "common event record confusion".

>  		cxlr = cxl_dpa_to_region(cxlmd, dpa);
>  		if (cxlr)
>  			hpa = cxl_trace_hpa(cxlr, cxlmd, dpa);
>  
>  		if (event_type == CXL_CPER_EVENT_GEN_MEDIA)
>  			trace_cxl_general_media(cxlmd, type, cxlr, hpa,
> -						&evt->gen_media);
> +						&evt->media_general);
>  		else if (event_type == CXL_CPER_EVENT_DRAM)
> -			trace_cxl_dram(cxlmd, type, cxlr, hpa, &evt->dram);
> +			trace_cxl_dram(cxlmd, type, cxlr, hpa, &evt->media_dram);
>  	}
>  }
>  EXPORT_SYMBOL_NS_GPL(cxl_event_trace_record, CXL);
> diff --git a/drivers/cxl/core/trace.h b/drivers/cxl/core/trace.h
> index 07a0394b1d99..2c7293761bb2 100644
> --- a/drivers/cxl/core/trace.h
> +++ b/drivers/cxl/core/trace.h
> @@ -316,7 +316,7 @@ TRACE_EVENT(cxl_generic_event,
>  TRACE_EVENT(cxl_general_media,
>  
>  	TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
> -		 struct cxl_region *cxlr, u64 hpa, struct cxl_event_gen_media *rec),
> +		 struct cxl_region *cxlr, u64 hpa, struct cxl_event_media *rec),
>  
>  	TP_ARGS(cxlmd, log, cxlr, hpa, rec),
>  
> @@ -413,7 +413,7 @@ TRACE_EVENT(cxl_general_media,
>  TRACE_EVENT(cxl_dram,
>  
>  	TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
> -		 struct cxl_region *cxlr, u64 hpa, struct cxl_event_dram *rec),
> +		 struct cxl_region *cxlr, u64 hpa, struct cxl_event_media *rec),
>  
>  	TP_ARGS(cxlmd, log, cxlr, hpa, rec),
>  
> diff --git a/include/linux/cxl-event.h b/include/linux/cxl-event.h
> index 60b25020281f..e417556cc120 100644
> --- a/include/linux/cxl-event.h
> +++ b/include/linux/cxl-event.h
> @@ -32,41 +32,38 @@ struct cxl_event_generic {
>   * CXL rev 3.0 Section 8.2.9.2.1.1; Table 8-43
>   */
>  #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;
> -	u8 device[3];
> -	u8 component_id[CXL_EVENT_GEN_MED_COMP_ID_SIZE];
> -	u8 reserved[46];
> -} __packed;
> -
>  /*
>   * DRAM Event Record - DER
>   * CXL rev 3.0 section 8.2.9.2.1.2; Table 3-44
>   */
>  #define CXL_EVENT_DER_CORRECTION_MASK_SIZE	0x20
> -struct cxl_event_dram {
> +struct cxl_event_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;
> -	u8 nibble_mask[3];
> -	u8 bank_group;
> -	u8 bank;
> -	u8 row[3];
> -	u8 column[2];
> -	u8 correction_mask[CXL_EVENT_DER_CORRECTION_MASK_SIZE];
> -	u8 reserved[0x17];
> +	struct_group_tagged(cxl_event_media_hdr, media_hdr,
> +		__le64 phys_addr;
> +		u8 descriptor;
> +		u8 type;
> +		u8 transaction_type;
> +		u8 validity_flags[2];
> +		u8 channel;
> +		u8 rank;
> +	);

Oh nice you went for the full 'struct_group_tagged' proposal. However, given
that Jonathan is already asking questions about "__packed", lets do the simpler
change, something like this, what do you think? This also preserves type-safety.

diff --git a/include/linux/cxl-event.h b/include/linux/cxl-event.h
index 60b25020281f..f48b59943977 100644
--- a/include/linux/cxl-event.h
+++ b/include/linux/cxl-event.h
@@ -33,14 +33,16 @@ 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 {
+               struct cxl_event_record_hdr hdr;
+               __le64 phys_addr;
+               u8 descriptor;
+               u8 type;
+               u8 transaction_type;
+               u8 validity_flags[2];
+               u8 channel;
+               u8 rank;
+       } hdr;
        u8 device[3];
        u8 component_id[CXL_EVENT_GEN_MED_COMP_ID_SIZE];
        u8 reserved[46];
@@ -52,14 +54,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 hdr;
        u8 nibble_mask[3];
        u8 bank_group;
        u8 bank;
@@ -109,7 +104,7 @@ union cxl_event {
        struct cxl_event_gen_media gen_media;
        struct cxl_event_dram dram;
        struct cxl_event_mem_module mem_module;
-       struct cxl_event_common common;
+       struct cxl_event_media_hdr media_hdr;
 } __packed;
 
 /*