cxl/trace: Standardize device information output

The trace points were written to take a struct device input for the
trace.  In CXL multiple device objects are associated with each CXL
hardware device.  Using different device objects in the trace point can
lead to confusion for users.

The PCIe device is nice to have, but the user space tooling relies on
the memory device naming.  It is better to have those device names
reported.

Change all trace points to take struct cxl_memdev as a standard and
report that name.

Furthermore, standardize on the name 'memdev' in both
/sys/kernel/tracing/trace and cxl-cli monitor output.

Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Link: https://lore.kernel.org/r/20230208-cxl-event-names-v2-1-fca130c2c68b@intel.com
Signed-off-by: Dan Williams <dan.j.williams@intel.com>

diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c
index a12255907852fa217e9508a403aaa52038afe4d2..eec100f0007b521b95ead7c256df055c43155ed3 100644 (file)
--- a/drivers/cxl/core/mbox.c
+++ b/drivers/cxl/core/mbox.c
@@ -743,7 +743,7 @@ static const uuid_t mem_mod_event_uuid =
        UUID_INIT(0xfe927475, 0xdd59, 0x4339,
                  0xa5, 0x86, 0x79, 0xba, 0xb1, 0x13, 0xb7, 0x74);
 
-static void cxl_event_trace_record(const struct device *dev,
+static void cxl_event_trace_record(const struct cxl_memdev *cxlmd,
                                   enum cxl_event_log_type type,
                                   struct cxl_event_record_raw *record)
 {
@@ -753,19 +753,19 @@ static void cxl_event_trace_record(const struct device *dev,
                struct cxl_event_gen_media *rec =
                                (struct cxl_event_gen_media *)record;
 
-               trace_cxl_general_media(dev, type, rec);
+               trace_cxl_general_media(cxlmd, type, rec);
        } else if (uuid_equal(id, &dram_event_uuid)) {
                struct cxl_event_dram *rec = (struct cxl_event_dram *)record;
 
-               trace_cxl_dram(dev, type, rec);
+               trace_cxl_dram(cxlmd, type, 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(dev, type, rec);
+               trace_cxl_memory_module(cxlmd, type, rec);
        } else {
                /* For unknown record types print just the header */
-               trace_cxl_generic_event(dev, type, record);
+               trace_cxl_generic_event(cxlmd, type, record);
        }
 }
 
@@ -872,11 +872,11 @@ static void cxl_mem_get_records_log(struct cxl_dev_state *cxlds,
                        break;
 
                for (i = 0; i < nr_rec; i++)
-                       cxl_event_trace_record(cxlds->dev, type,
+                       cxl_event_trace_record(cxlds->cxlmd, type,
                                               &payload->records[i]);
 
                if (payload->flags & CXL_GET_EVENT_FLAG_OVERFLOW)
-                       trace_cxl_overflow(cxlds->dev, type, payload);
+                       trace_cxl_overflow(cxlds->cxlmd, type, payload);
 
                rc = cxl_clear_event_record(cxlds, type, payload);
                if (rc) {

diff --git a/drivers/cxl/core/pci.c b/drivers/cxl/core/pci.c
index 1d1492440287c9762829d3a603d35663a42c1e81..fa263370d65a728780816e0cc5dcf60d20f919eb 100644 (file)
--- a/drivers/cxl/core/pci.c
+++ b/drivers/cxl/core/pci.c
@@ -627,8 +627,6 @@ EXPORT_SYMBOL_NS_GPL(read_cdat_data, CXL);
 void cxl_cor_error_detected(struct pci_dev *pdev)
 {
        struct cxl_dev_state *cxlds = pci_get_drvdata(pdev);
-       struct cxl_memdev *cxlmd = cxlds->cxlmd;
-       struct device *dev = &cxlmd->dev;
        void __iomem *addr;
        u32 status;
 
@@ -639,7 +637,7 @@ void cxl_cor_error_detected(struct pci_dev *pdev)
        status = readl(addr);
        if (status & CXL_RAS_CORRECTABLE_STATUS_MASK) {
                writel(status & CXL_RAS_CORRECTABLE_STATUS_MASK, addr);
-               trace_cxl_aer_correctable_error(dev, status);
+               trace_cxl_aer_correctable_error(cxlds->cxlmd, status);
        }
 }
 EXPORT_SYMBOL_NS_GPL(cxl_cor_error_detected, CXL);
@@ -667,8 +665,6 @@ static void header_log_copy(struct cxl_dev_state *cxlds, u32 *log)
  */
 static bool cxl_report_and_clear(struct cxl_dev_state *cxlds)
 {
-       struct cxl_memdev *cxlmd = cxlds->cxlmd;
-       struct device *dev = &cxlmd->dev;
        u32 hl[CXL_HEADERLOG_SIZE_U32];
        void __iomem *addr;
        u32 status;
@@ -691,7 +687,7 @@ static bool cxl_report_and_clear(struct cxl_dev_state *cxlds)
        }
 
        header_log_copy(cxlds, hl);
-       trace_cxl_aer_uncorrectable_error(dev, status, fe, hl);
+       trace_cxl_aer_uncorrectable_error(cxlds->cxlmd, status, fe, hl);
        writel(status & CXL_RAS_UNCORRECTABLE_STATUS_MASK, addr);
 
        return true;

diff --git a/drivers/cxl/core/trace.h b/drivers/cxl/core/trace.h
index c72ef9321cfed371a9cbe9ca5b81be6c94fccc9a..93ac651a2f21422b00b0440157bd401351c0e8cb 100644 (file)
--- a/drivers/cxl/core/trace.h
+++ b/drivers/cxl/core/trace.h
@@ -47,16 +47,16 @@
 )
 
 TRACE_EVENT(cxl_aer_uncorrectable_error,
-       TP_PROTO(const struct device *dev, u32 status, u32 fe, u32 *hl),
-       TP_ARGS(dev, status, fe, hl),
+       TP_PROTO(const struct cxl_memdev *cxlmd, u32 status, u32 fe, u32 *hl),
+       TP_ARGS(cxlmd, status, fe, hl),
        TP_STRUCT__entry(
-               __string(dev_name, dev_name(dev))
+               __string(memdev, dev_name(&cxlmd->dev))
                __field(u32, status)
                __field(u32, first_error)
                __array(u32, header_log, CXL_HEADERLOG_SIZE_U32)
        ),
        TP_fast_assign(
-               __assign_str(dev_name, dev_name(dev));
+               __assign_str(memdev, dev_name(&cxlmd->dev));
                __entry->status = status;
                __entry->first_error = fe;
                /*
@@ -65,8 +65,8 @@ TRACE_EVENT(cxl_aer_uncorrectable_error,
                 */
                memcpy(__entry->header_log, hl, CXL_HEADERLOG_SIZE);
        ),
-       TP_printk("%s: status: '%s' first_error: '%s'",
-                 __get_str(dev_name),
+       TP_printk("memdev=%s: status: '%s' first_error: '%s'",
+                 __get_str(memdev),
                  show_uc_errs(__entry->status),
                  show_uc_errs(__entry->first_error)
        )
@@ -91,18 +91,18 @@ TRACE_EVENT(cxl_aer_uncorrectable_error,
 )
 
 TRACE_EVENT(cxl_aer_correctable_error,
-       TP_PROTO(const struct device *dev, u32 status),
-       TP_ARGS(dev, status),
+       TP_PROTO(const struct cxl_memdev *cxlmd, u32 status),
+       TP_ARGS(cxlmd, status),
        TP_STRUCT__entry(
-               __string(dev_name, dev_name(dev))
+               __string(memdev, dev_name(&cxlmd->dev))
                __field(u32, status)
        ),
        TP_fast_assign(
-               __assign_str(dev_name, dev_name(dev));
+               __assign_str(memdev, dev_name(&cxlmd->dev));
                __entry->status = status;
        ),
-       TP_printk("%s: status: '%s'",
-                 __get_str(dev_name), show_ce_errs(__entry->status)
+       TP_printk("memdev=%s: status: '%s'",
+                 __get_str(memdev), show_ce_errs(__entry->status)
        )
 );
 
@@ -115,13 +115,13 @@ TRACE_EVENT(cxl_aer_correctable_error,
 
 TRACE_EVENT(cxl_overflow,
 
-       TP_PROTO(const struct device *dev, enum cxl_event_log_type log,
+       TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
                 struct cxl_get_event_payload *payload),
 
-       TP_ARGS(dev, log, payload),
+       TP_ARGS(cxlmd, log, payload),
 
        TP_STRUCT__entry(
-               __string(dev_name, dev_name(dev))
+               __string(memdev, dev_name(&cxlmd->dev))
                __field(int, log)
                __field(u64, first_ts)
                __field(u64, last_ts)
@@ -129,15 +129,15 @@ TRACE_EVENT(cxl_overflow,
        ),
 
        TP_fast_assign(
-               __assign_str(dev_name, dev_name(dev));
+               __assign_str(memdev, dev_name(&cxlmd->dev));
                __entry->log = log;
                __entry->count = le16_to_cpu(payload->overflow_err_count);
                __entry->first_ts = le64_to_cpu(payload->first_overflow_timestamp);
                __entry->last_ts = le64_to_cpu(payload->last_overflow_timestamp);
        ),
 
-       TP_printk("%s: log=%s : %u records from %llu to %llu",
-               __get_str(dev_name), cxl_event_log_type_str(__entry->log),
+       TP_printk("memdev=%s: log=%s : %u records from %llu to %llu",
+               __get_str(memdev), cxl_event_log_type_str(__entry->log),
                __entry->count, __entry->first_ts, __entry->last_ts)
 
 );
@@ -170,7 +170,7 @@ TRACE_EVENT(cxl_overflow,
  * See the generic_event tracepoint as an example.
  */
 #define CXL_EVT_TP_entry                                       \
-       __string(dev_name, dev_name(dev))                       \
+       __string(memdev, dev_name(&cxlmd->dev))                 \
        __field(int, log)                                       \
        __field_struct(uuid_t, hdr_uuid)                        \
        __field(u32, hdr_flags)                                 \
@@ -180,8 +180,8 @@ TRACE_EVENT(cxl_overflow,
        __field(u8, hdr_length)                                 \
        __field(u8, hdr_maint_op_class)
 
-#define CXL_EVT_TP_fast_assign(dev, l, hdr)                                    \
-       __assign_str(dev_name, dev_name(dev));                                  \
+#define CXL_EVT_TP_fast_assign(cxlmd, l, hdr)                                  \
+       __assign_str(memdev, dev_name(&(cxlmd)->dev));                          \
        __entry->log = (l);                                                     \
        memcpy(&__entry->hdr_uuid, &(hdr).id, sizeof(uuid_t));                  \
        __entry->hdr_length = (hdr).length;                                     \
@@ -192,10 +192,10 @@ TRACE_EVENT(cxl_overflow,
        __entry->hdr_maint_op_class = (hdr).maint_op_class
 
 #define CXL_EVT_TP_printk(fmt, ...) \
-       TP_printk("%s log=%s : time=%llu uuid=%pUb len=%d flags='%s' "          \
+       TP_printk("memdev=%s log=%s : time=%llu uuid=%pUb len=%d flags='%s' "   \
                "handle=%x related_handle=%x maint_op_class=%u"                 \
                " : " fmt,                                                      \
-               __get_str(dev_name), cxl_event_log_type_str(__entry->log),      \
+               __get_str(memdev), cxl_event_log_type_str(__entry->log),        \
                __entry->hdr_timestamp, &__entry->hdr_uuid, __entry->hdr_length,\
                show_hdr_flags(__entry->hdr_flags), __entry->hdr_handle,        \
                __entry->hdr_related_handle, __entry->hdr_maint_op_class,       \
@@ -203,10 +203,10 @@ TRACE_EVENT(cxl_overflow,
 
 TRACE_EVENT(cxl_generic_event,
 
-       TP_PROTO(const struct device *dev, enum cxl_event_log_type log,
+       TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
                 struct cxl_event_record_raw *rec),
 
-       TP_ARGS(dev, log, rec),
+       TP_ARGS(cxlmd, log, rec),
 
        TP_STRUCT__entry(
                CXL_EVT_TP_entry
@@ -214,7 +214,7 @@ TRACE_EVENT(cxl_generic_event,
        ),
 
        TP_fast_assign(
-               CXL_EVT_TP_fast_assign(dev, log, rec->hdr);
+               CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
                memcpy(__entry->data, &rec->data, CXL_EVENT_RECORD_DATA_LENGTH);
        ),
 
@@ -293,10 +293,10 @@ TRACE_EVENT(cxl_generic_event,
 
 TRACE_EVENT(cxl_general_media,
 
-       TP_PROTO(const struct device *dev, enum cxl_event_log_type log,
+       TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
                 struct cxl_event_gen_media *rec),
 
-       TP_ARGS(dev, log, rec),
+       TP_ARGS(cxlmd, log, rec),
 
        TP_STRUCT__entry(
                CXL_EVT_TP_entry
@@ -315,7 +315,7 @@ TRACE_EVENT(cxl_general_media,
        ),
 
        TP_fast_assign(
-               CXL_EVT_TP_fast_assign(dev, log, rec->hdr);
+               CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
 
                /* General Media */
                __entry->dpa = le64_to_cpu(rec->phys_addr);
@@ -376,10 +376,10 @@ TRACE_EVENT(cxl_general_media,
 
 TRACE_EVENT(cxl_dram,
 
-       TP_PROTO(const struct device *dev, enum cxl_event_log_type log,
+       TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
                 struct cxl_event_dram *rec),
 
-       TP_ARGS(dev, log, rec),
+       TP_ARGS(cxlmd, log, rec),
 
        TP_STRUCT__entry(
                CXL_EVT_TP_entry
@@ -401,7 +401,7 @@ TRACE_EVENT(cxl_dram,
        ),
 
        TP_fast_assign(
-               CXL_EVT_TP_fast_assign(dev, log, rec->hdr);
+               CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
 
                /* DRAM */
                __entry->dpa = le64_to_cpu(rec->phys_addr);
@@ -525,10 +525,10 @@ TRACE_EVENT(cxl_dram,
 
 TRACE_EVENT(cxl_memory_module,
 
-       TP_PROTO(const struct device *dev, enum cxl_event_log_type log,
+       TP_PROTO(const struct cxl_memdev *cxlmd, enum cxl_event_log_type log,
                 struct cxl_event_mem_module *rec),
 
-       TP_ARGS(dev, log, rec),
+       TP_ARGS(cxlmd, log, rec),
 
        TP_STRUCT__entry(
                CXL_EVT_TP_entry
@@ -548,7 +548,7 @@ TRACE_EVENT(cxl_memory_module,
        ),
 
        TP_fast_assign(
-               CXL_EVT_TP_fast_assign(dev, log, rec->hdr);
+               CXL_EVT_TP_fast_assign(cxlmd, log, rec->hdr);
 
                /* Memory Module Event */
                __entry->event_type = rec->event_type;