Skip to contentSkip to conversation

ufs: core: add hba parameter to trace events

PATCH Superseded [email protected] 2 participants 3 messages Feb 12, 2025 – Feb 13, 2025

Subsystems (3)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ufs: core: add hba parameter to trace events

From: Peter Wang <[email protected]>

Included the ufs_hba structure as a parameter in various trace events to provide more context and improve debugging capabilities.

---
 drivers/ufs/core/ufs_trace.h | 132 ++++++++++++++++++++---------------
 drivers/ufs/core/ufshcd.c    |  66 +++++++++---------
 2 files changed, 111 insertions(+), 87 deletions(-)
drivers/ufs/core/ufs_trace.h +77 -55
index 84deca2b841d..e175020a2fcc 100644
@@ -83,17 +83,19 @@ UFS_CMD_TRACE_TSF_TYPES
 
 TRACE_EVENT(ufshcd_clk_gating,
 
-	TP_PROTO(const char *dev_name, int state),
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba, int state),
 
-	TP_ARGS(dev_name, state),
+	TP_ARGS(dev_name, hba, state),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__field(int, state)
 	),
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__entry->state = state;
 	),
 
@@ -104,13 +106,15 @@ TRACE_EVENT(ufshcd_clk_gating,
 
 TRACE_EVENT(ufshcd_clk_scaling,
 
-	TP_PROTO(const char *dev_name, const char *state, const char *clk,
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		const char *state, const char *clk,
 		u32 prev_state, u32 curr_state),
 
-	TP_ARGS(dev_name, state, clk, prev_state, curr_state),
+	TP_ARGS(dev_name, hba, state, clk, prev_state, curr_state),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__string(state, state)
 		__string(clk, clk)
 		__field(u32, prev_state)
@@ -119,6 +123,7 @@ TRACE_EVENT(ufshcd_clk_scaling,
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__assign_str(state);
 		__assign_str(clk);
 		__entry->prev_state = prev_state;
@@ -132,17 +137,19 @@ TRACE_EVENT(ufshcd_clk_scaling,
 
 TRACE_EVENT(ufshcd_auto_bkops_state,
 
-	TP_PROTO(const char *dev_name, const char *state),
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba, const char *state),
 
-	TP_ARGS(dev_name, state),
+	TP_ARGS(dev_name, hba, state),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__string(state, state)
 	),
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__assign_str(state);
 	),
 
@@ -151,13 +158,14 @@ TRACE_EVENT(ufshcd_auto_bkops_state,
 );
 
 DECLARE_EVENT_CLASS(ufshcd_profiling_template,
-	TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
-		 int err),
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		 const char *profile_info, s64 time_us, int err),
 
-	TP_ARGS(dev_name, profile_info, time_us, err),
+	TP_ARGS(dev_name, hba, profile_info, time_us, err),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__string(profile_info, profile_info)
 		__field(s64, time_us)
 		__field(int, err)
@@ -165,6 +173,7 @@ DECLARE_EVENT_CLASS(ufshcd_profiling_template,
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__assign_str(profile_info);
 		__entry->time_us = time_us;
 		__entry->err = err;
@@ -176,30 +185,31 @@ DECLARE_EVENT_CLASS(ufshcd_profiling_template,
 );
 
 DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_hibern8,
-	TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
-		 int err),
-	TP_ARGS(dev_name, profile_info, time_us, err));
+	TP_PROTO(const char *dev_name,  struct ufs_hba *hba,
+		 const char *profile_info, s64 time_us, int err),
+	TP_ARGS(dev_name, hba, profile_info, time_us, err));
 
 DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_clk_gating,
-	TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
-		 int err),
-	TP_ARGS(dev_name, profile_info, time_us, err));
+	TP_PROTO(const char *dev_name,  struct ufs_hba *hba,
+		 const char *profile_info, s64 time_us, int err),
+	TP_ARGS(dev_name, hba, profile_info, time_us, err));
 
 DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_clk_scaling,
-	TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
-		 int err),
-	TP_ARGS(dev_name, profile_info, time_us, err));
+	TP_PROTO(const char *dev_name,  struct ufs_hba *hba,
+		 const char *profile_info, s64 time_us, int err),
+	TP_ARGS(dev_name, hba, profile_info, time_us, err));
 
 DECLARE_EVENT_CLASS(ufshcd_template,
-	TP_PROTO(const char *dev_name, int err, s64 usecs,
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba, int err, s64 usecs,
 		 int dev_state, int link_state),
 
-	TP_ARGS(dev_name, err, usecs, dev_state, link_state),
+	TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state),
 
 	TP_STRUCT__entry(
 		__field(s64, usecs)
 		__field(int, err)
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__field(int, dev_state)
 		__field(int, link_state)
 	),
@@ -208,6 +218,7 @@ DECLARE_EVENT_CLASS(ufshcd_template,
 		__entry->usecs = usecs;
 		__entry->err = err;
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__entry->dev_state = dev_state;
 		__entry->link_state = link_state;
 	),
@@ -223,60 +234,62 @@ DECLARE_EVENT_CLASS(ufshcd_template,
 );
 
 DEFINE_EVENT(ufshcd_template, ufshcd_system_suspend,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_system_resume,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_runtime_suspend,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_runtime_resume,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_init,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_wl_suspend,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_wl_resume,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_wl_runtime_suspend,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 DEFINE_EVENT(ufshcd_template, ufshcd_wl_runtime_resume,
-	     TP_PROTO(const char *dev_name, int err, s64 usecs,
-		      int dev_state, int link_state),
-	     TP_ARGS(dev_name, err, usecs, dev_state, link_state));
+	     TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		      int err, s64 usecs, int dev_state, int link_state),
+	     TP_ARGS(dev_name, hba, err, usecs, dev_state, link_state));
 
 TRACE_EVENT(ufshcd_command,
-	TP_PROTO(struct scsi_device *sdev, enum ufs_trace_str_t str_t,
+	TP_PROTO(struct scsi_device *sdev, struct ufs_hba *hba,
+		 enum ufs_trace_str_t str_t,
 		 unsigned int tag, u32 doorbell, u32 hwq_id, int transfer_len,
 		 u32 intr, u64 lba, u8 opcode, u8 group_id),
 
-	TP_ARGS(sdev, str_t, tag, doorbell, hwq_id, transfer_len, intr, lba,
+	TP_ARGS(sdev, hba, str_t, tag, doorbell, hwq_id, transfer_len, intr, lba,
 		opcode, group_id),
 
 	TP_STRUCT__entry(
 		__field(struct scsi_device *, sdev)
+		__field(struct ufs_hba *, hba)
 		__field(enum ufs_trace_str_t, str_t)
 		__field(unsigned int, tag)
 		__field(u32, doorbell)
@@ -290,6 +303,7 @@ TRACE_EVENT(ufshcd_command,
 
 	TP_fast_assign(
 		__entry->sdev = sdev;
+		__entry->hba = hba;
 		__entry->str_t = str_t;
 		__entry->tag = tag;
 		__entry->doorbell = doorbell;
@@ -312,13 +326,15 @@ TRACE_EVENT(ufshcd_command,
 );
 
 TRACE_EVENT(ufshcd_uic_command,
-	TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, u32 cmd,
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		 enum ufs_trace_str_t str_t, u32 cmd,
 		 u32 arg1, u32 arg2, u32 arg3),
 
-	TP_ARGS(dev_name, str_t, cmd, arg1, arg2, arg3),
+	TP_ARGS(dev_name, hba, str_t, cmd, arg1, arg2, arg3),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__field(enum ufs_trace_str_t, str_t)
 		__field(u32, cmd)
 		__field(u32, arg1)
@@ -328,6 +344,7 @@ TRACE_EVENT(ufshcd_uic_command,
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__entry->str_t = str_t;
 		__entry->cmd = cmd;
 		__entry->arg1 = arg1;
@@ -343,13 +360,15 @@ TRACE_EVENT(ufshcd_uic_command,
 );
 
 TRACE_EVENT(ufshcd_upiu,
-	TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, void *hdr,
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba,
+		 enum ufs_trace_str_t str_t, void *hdr,
 		 void *tsf, enum ufs_trace_tsf_t tsf_t),
 
-	TP_ARGS(dev_name, str_t, hdr, tsf, tsf_t),
+	TP_ARGS(dev_name, hba, str_t, hdr, tsf, tsf_t),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__field(enum ufs_trace_str_t, str_t)
 		__array(unsigned char, hdr, 12)
 		__array(unsigned char, tsf, 16)
@@ -358,6 +377,7 @@ TRACE_EVENT(ufshcd_upiu,
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__entry->str_t = str_t;
 		memcpy(__entry->hdr, hdr, sizeof(__entry->hdr));
 		memcpy(__entry->tsf, tsf, sizeof(__entry->tsf));
@@ -375,17 +395,19 @@ TRACE_EVENT(ufshcd_upiu,
 
 TRACE_EVENT(ufshcd_exception_event,
 
-	TP_PROTO(const char *dev_name, u16 status),
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba, u16 status),
 
-	TP_ARGS(dev_name, status),
+	TP_ARGS(dev_name, hba, status),
 
 	TP_STRUCT__entry(
 		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
 		__field(u16, status)
 	),
 
 	TP_fast_assign(
 		__assign_str(dev_name);
+		__entry->hba = hba;
 		__entry->status = status;
 	),
 
drivers/ufs/core/ufshcd.c +34 -32

266 lines not on this page · raw message

Signature · 1 line
2.45.2
#1 lore raw
Quoted 15 lines · On 2/12/25 2:14 AM, [email protected] wrote:
drivers/ufs/core/ufs_trace.h +2 -2
index 84deca2b841d..e175020a2fcc 100644
@@ -83,17 +83,19 @@ UFS_CMD_TRACE_TSF_TYPES
 
  TRACE_EVENT(ufshcd_clk_gating,
 
-	TP_PROTO(const char *dev_name, int state),
+	TP_PROTO(const char *dev_name, struct ufs_hba *hba, int state),
 
-	TP_ARGS(dev_name, state),
+	TP_ARGS(dev_name, hba, state),
 
  	TP_STRUCT__entry(

drivers/ufs/core/ufs_trace.h UFS_CMD_TRACE_TSF_TYPES · line 100

Quoted 10 lines
drivers/ufs/core/ufs_trace.h +2 -0
  		__string(dev_name, dev_name)
+		__field(struct ufs_hba *, hba)
  		__field(int, state)
  	),
 
  	TP_fast_assign(
  		__assign_str(dev_name);
+		__entry->hba = hba;
  		__entry->state = state;
  	),

Why to include the HBA pointer in tracing events if this pointer is not used in any TP_printk() call?

dev_name == dev_name(hba->dev) so the dev_name argument should be left out from all tracing events that now have a HBA pointer as argument.

Thanks,

Bart.

#2 lore raw
Quoted 38 lines · Bart Van Assche

External email : Please do not click links or open attachments until you have verified the sender or the content.

Quoted 22 lines · On 2/12/25 2:14 AM, [email protected] wrote:
drivers/ufs/core/ufs_trace.h +2 -2
index 84deca2b841d..e175020a2fcc 100644
@@ -83,17 +83,19 @@ UFS_CMD_TRACE_TSF_TYPES
 
   TRACE_EVENT(ufshcd_clk_gating,
 
-     TP_PROTO(const char *dev_name, int state),
+     TP_PROTO(const char *dev_name, struct ufs_hba *hba, int
 state),
 
-     TP_ARGS(dev_name, state),
+     TP_ARGS(dev_name, hba, state),
 

      TP_STRUCT__entry(
              __string(dev_name, dev_name)
+             __field(struct ufs_hba *, hba)
              __field(int, state)
      ),

Quoted 5 lines

      TP_fast_assign(
              __assign_str(dev_name);
+             __entry->hba = hba;
              __entry->state = state;
      ),

Why to include the HBA pointer in tracing events if this pointer is not
used in any TP_printk() call?

Quoted 7 lines

dev_name == dev_name(hba->dev) so the dev_name argument should be left
out from all tracing events that now have a HBA pointer as argument.

Thanks,

Bart.

Hi Bart,

The system may have multiple HBA hosts, adding HBA helps trace which host the event belongs to.
The dev_name will be removed in the next version,

Thanks
Peter