Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7;
Date:   Thu, 7 Dec 2023 16:30:58 -0800
From:   Dan Williams <dan.j.williams@intel.com>
To:     Ira Weiny <ira.weiny@intel.com>,
        Dan Williams <dan.j.williams@intel.com>,
        Jonathan Cameron <jonathan.cameron@huawei.com>,
        Smita Koralahalli <Smita.KoralahalliChannabasappa@amd.com>,
        Shiju Jose <shiju.jose@huawei.com>
CC:     Yazen Ghannam <yazen.ghannam@amd.com>,
        Davidlohr Bueso <dave@stgolabs.net>,
        Dave Jiang <dave.jiang@intel.com>,
        Alison Schofield <alison.schofield@intel.com>,
        Vishal Verma <vishal.l.verma@intel.com>,
        "Ard Biesheuvel" <ardb@kernel.org>, <linux-efi@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>, <linux-cxl@vger.kernel.org>,
        Ira Weiny <ira.weiny@intel.com>
Subject: RE: [PATCH 1/6] cxl/trace: Pass uuid explicitly to event traces
Message-ID: <657263c249c4c_45e0129471@dwillia2-xfh.jf.intel.com.notmuch>
References: <20230601-cxl-cper-v1-0-d19f1ac18ab6@intel.com>
 <20230601-cxl-cper-v1-1-d19f1ac18ab6@intel.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20230601-cxl-cper-v1-1-d19f1ac18ab6@intel.com>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?KQ6Dlf3b3D//V+8YkH4vmeZHKNjbnqIjDxl9lqaGbKgBe3rmvgqwZrCgBOMk?=
 =?us-ascii?Q?9uwjNv4TcL84E9cVqYLv+5KKu8OjjgS43VtQsFpqV0L5vP7JWXjtkRWOlFQK?=
 =?us-ascii?Q?Y0i58YryhJGGu20BvK8sPox2x0q4fqwhHMSGlOG3Bo6Ma7UlNBHVvkm6Rtxd?=
 =?us-ascii?Q?j/qEDYfJCZdazc6ZJ+wQ1TV4ifkwTauK65kmrYzAi2nGSWDSmJ5ERIEpA5zy?=
 =?us-ascii?Q?brnpk3RD256hwZO3IgadwypVHEbb1NstosdT2xMJJH6c/1wcOXYh2kS2/Qox?=
 =?us-ascii?Q?BeOr9s2psRzxRcUxA0bPkJGevoAs4sAG8ux9U1Rv/C0FQn88TJ3C1tvp6hpz?=
 =?us-ascii?Q?YHHYvsPermCWmGFmHM9aml3Y9wDfbZ3PWzKqziv7kDDF6DSV0CYyKs2xdzpX?=
 =?us-ascii?Q?D4m7/JaOY1HPZZxXdG5r4NvW+BA2Bn5fpBB0b1NpG2PT9VH3DZMrV8NHVcEz?=
 =?us-ascii?Q?SAmPNX1oTOBjTb3wPFtEi9ZSmRHDTSqBLhcm8sqljXQLWQFD7OxGasgb5MwT?=
 =?us-ascii?Q?vrhQ2az4qOWGAnp096/7TCc9gzZN9BGF/OzEm/FoOh/OT15WBjBXGyS7/SiI?=
 =?us-ascii?Q?EWBbsp0T2KMd6Kd5oWualDWlpU1bIsAfIBiKI7ZKtg6qO4kVgGHlRNMDzV/0?=
 =?us-ascii?Q?LiYo9KoULIXO0sjhIqZIBMALiS4LFxw2XWeql27oRqBhbPf3Ny4dlcIVhYcn?=
 =?us-ascii?Q?h26NpFodIb5NXthfn4qOpQyG69xmKptNZlp7Nsr7vmY0GBY2a5BNiDPuGVin?=
 =?us-ascii?Q?K9CX2IukbVowVse6D3TtKNlu02bVNQ0JgcOmQXqGh8ggJvFhwBJdYYOPQLOz?=
 =?us-ascii?Q?/UoRolBHXaUyTVt8gQBvtj70kAZvVF4Wsmth5DMRnEetyFy7PcvapPFVF5R0?=
 =?us-ascii?Q?cqRWX6dux5vhviP5Tx7+B1Y+3vvOkr+m7ezh0QWO678flKldlMONYsns1Bfc?=
 =?us-ascii?Q?9Szk6ZDQOksN6sW0RIzHS281uy9dO9BUtVzK9zbdUJ4+dOjXADF2qzKa5FJA?=
 =?us-ascii?Q?JNWUPKVBcZ3dGvLQXzrA55Zqilu4wxQY/ZA+ui2CeCI9eAltC7MY8wDYOlZR?=
 =?us-ascii?Q?jRWiSIE4Ck6Wpy7q7cGYVGKUMrE4+w/0nrjm5/5CEFMmP6x2R24Htt9qdw0w?=
 =?us-ascii?Q?ETEGlxK4JsZW/CgTwUCu4I+/1eH+pnYH4PYDY1f2e5JKAdvKlZ+uCmmvKu6+?=
 =?us-ascii?Q?63STcaN2Pt+oliwgKX+3b/nzOosjjnF8w1m/ycIUqCChNwYn3mw+POB+3FXB?=
 =?us-ascii?Q?qJUCc99YiQpisUyNJIVTH7MYATK6X1TxucA3m/iZ7FGeCaSDcZkqLkqgECBj?=
 =?us-ascii?Q?U/yizW1fRYePJ0I1VZGUUaLvT8Z1mCcuVfS+tt+cy2bVxAdGb9y7Ng1yi+Zh?=
 =?us-ascii?Q?B6tiF00sjP3gzDrH8xhccrP0dn794hkNFToHPzAaxVpD49BSjPhp92FkroKS?=
 =?us-ascii?Q?MY7mXUwudXmdhs/9UeihzESHsyEz4laKIUZxFP2/BDMshF0LoLnixM2dH7hb?=
 =?us-ascii?Q?wK/0JehMcI/gRq7omRhcCbrNgy4gzyW9AaKt48SzEFCfp7zsQG+YTynCLfsk?=
 =?us-ascii?Q?EIYi86DQdTJRqaIFENCjrSS9OraIvlK0F4xfKc74DD1nXBU9szQt6iOtvjiG?=
 =?us-ascii?Q?uw=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 58ad20c9-8312-4430-020f-08dbf784f444
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Dec 2023 00:31:01.4921
 (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: n5k0gamr82En54cu2/khUyMK2pXvjiJOEuV0eqIpplh+ubzVMwElw3WXLj2Aodzmm6KBD9WNIgH6OXcYMmaj7cGmu1ZGwD2s1f28UWzJLrA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR11MB6349
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,
        SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Thu, 07 Dec 2023 16:31:44 -0800 (PST)

Ira Weiny wrote:
> CPER CXL events do not have a UUID associated with them.  It is
> desirable to share event structures between the CPER CXL event and the
> CXL event log events.

This parses strange to me, maybe it is trying to capture too many
changes in too few sentences? Something like this instead?

"CXL CPER events are identified by the CPER Section Type GUID. The GUID
correlates with the CXL UUID for the event record. It turns out that a
CXL CPER record is a strict subset of the CXL event record, only the
UUID header field is chopped.

In order to unify handling between native and CPER flavors of CXL
events, prepare the code for the UUID to be passed in rather than
inferred from the record itself.

Later patches update the passed in record to only refer to the common
data between the formats."

> 
> Pass the UUID explicitly to each trace event to be able to remove the
> UUID from the event structures.
> 
> Originally it was desirable to remove the UUID from the well known event
> because the UUID value was redundant.  However, the trace API was
> already in place.[1]
> 
> [1] https://lore.kernel.org/all/36f2d12934d64a278f2c0313cbd01abc@huawei.com/
> 
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>
> ---
>  drivers/cxl/core/mbox.c  |  8 ++++----
>  drivers/cxl/core/trace.h | 32 ++++++++++++++++----------------
>  2 files changed, 20 insertions(+), 20 deletions(-)
> 
> diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c
> index 36270dcfb42e..00f429c440df 100644
> --- a/drivers/cxl/core/mbox.c
> +++ b/drivers/cxl/core/mbox.c
> @@ -870,19 +870,19 @@ static void cxl_event_trace_record(const struct cxl_memdev *cxlmd,
>  		struct cxl_event_gen_media *rec =
>  				(struct cxl_event_gen_media *)record;
>  
> -		trace_cxl_general_media(cxlmd, type, rec);
> +		trace_cxl_general_media(cxlmd, type, id, rec);
>  	} else if (uuid_equal(id, &dram_event_uuid)) {
>  		struct cxl_event_dram *rec = (struct cxl_event_dram *)record;
>  
> -		trace_cxl_dram(cxlmd, type, rec);
> +		trace_cxl_dram(cxlmd, type, id, rec);
>  	} else if (uuid_equal(id, &mem_mod_event_uuid)) {
>  		struct cxl_event_mem_module *rec =
>  				(struct cxl_event_mem_module *)record;
>  
> -		trace_cxl_memory_module(cxlmd, type, rec);
> +		trace_cxl_memory_module(cxlmd, type, id, rec);
>  	} else {
>  		/* For unknown record types print just the header */
> -		trace_cxl_generic_event(cxlmd, type, record);
> +		trace_cxl_generic_event(cxlmd, type, id, record);
>  	}
>  }
>  
> diff --git a/drivers/cxl/core/trace.h b/drivers/cxl/core/trace.h
> index a0b5819bc70b..2aef185f4cd0 100644
> --- a/drivers/cxl/core/trace.h
> +++ b/drivers/cxl/core/trace.h
> @@ -189,7 +189,7 @@ TRACE_EVENT(cxl_overflow,
>  	__string(memdev, dev_name(&cxlmd->dev))			\
>  	__string(host, dev_name(cxlmd->dev.parent))		\
>  	__field(int, log)					\
> -	__field_struct(uuid_t, hdr_uuid)			\
> +	__field_struct(uuid_t, uuid)				\

Hmm, is it too late to make this rename? I.e. would a script that is
looking for "hdr_uuid" in one kernel be broken by the rename of the
field to "uuid" in the next?

>  	__field(u64, serial)					\
>  	__field(u32, hdr_flags)					\
>  	__field(u16, hdr_handle)				\
> @@ -198,12 +198,12 @@ TRACE_EVENT(cxl_overflow,
>  	__field(u8, hdr_length)					\
>  	__field(u8, hdr_maint_op_class)
>  
> -#define CXL_EVT_TP_fast_assign(cxlmd, l, hdr)					\
> +#define CXL_EVT_TP_fast_assign(cxlmd, l, uuid, hdr)				\
>  	__assign_str(memdev, dev_name(&(cxlmd)->dev));				\
>  	__assign_str(host, dev_name((cxlmd)->dev.parent));			\
>  	__entry->log = (l);							\
>  	__entry->serial = (cxlmd)->cxlds->serial;				\
> -	memcpy(&__entry->hdr_uuid, &(hdr).id, sizeof(uuid_t));			\
> +	memcpy(&__entry->uuid, (uuid), sizeof(uuid_t));				\

Per above this would be:

	memcpy(&__entry->hdr_uuid, (uuid), sizeof(uuid_t));				\

>  	__entry->hdr_length = (hdr).length;					\
>  	__entry->hdr_flags = get_unaligned_le24((hdr).flags);			\
>  	__entry->hdr_handle = le16_to_cpu((hdr).handle);			\
> @@ -217,7 +217,7 @@ TRACE_EVENT(cxl_overflow,
>  		"maint_op_class=%u : " fmt,					\
>  		__get_str(memdev), __get_str(host), __entry->serial,		\
>  		cxl_event_log_type_str(__entry->log),				\
> -		__entry->hdr_timestamp, &__entry->hdr_uuid, __entry->hdr_length,\
> +		__entry->hdr_timestamp, &__entry->uuid, __entry->hdr_length,	\

...and this change could be dropped.

Other than that, this looks good to me.