Skip to contentSkip to conversation

scsi: core: Report error list information in debugfs

PATCH Superseded Bart Van Assche 4 participants 6 messages Aug 21, 2023 – Oct 9, 2023 SCSI

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 scsi: core: Report error list information in debugfs

Provide information in debugfs about SCSI error handling to make it easier to debug the SCSI error handler. Additionally, report the maximum number of retries in debugfs (.allowed).

Cc Hannes Reinecke <[email protected]>
Cc Damien Le Moal <[email protected]>
Cc Mike Christie <[email protected]>
Cc John Garry <[email protected]>
Cc Ming Lei <[email protected]>
---
 drivers/scsi/scsi_debugfs.c | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)
drivers/scsi/scsi_debugfs.c +22 -3
index 217b70c678c3..a9bc5f7ce745 100644
@@ -3,6 +3,7 @@
 #include <linux/seq_file.h>
 #include <scsi/scsi_cmnd.h>
 #include <scsi/scsi_dbg.h>
+#include <scsi/scsi_host.h>
 #include "scsi_debugfs.h"
 
 #define SCSI_CMD_FLAG_NAME(name)[const_ilog2(SCMD_##name)] = #name
@@ -33,14 +34,32 @@ static int scsi_flags_show(struct seq_file *m, const unsigned long flags,
 
 void scsi_show_rq(struct seq_file *m, struct request *rq)
 {
-	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
+	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq), *cmd2;
+	struct Scsi_Host *shost = cmd->device->host;
 	int alloc_ms = jiffies_to_msecs(jiffies - cmd->jiffies_at_alloc);
 	int timeout_ms = jiffies_to_msecs(rq->timeout);
+	const char *list_info = NULL;
 	char buf[80] = "(?)";
 
+	spin_lock_irq(shost->host_lock);
+	list_for_each_entry(cmd2, &shost->eh_abort_list, eh_entry) {
+		if (cmd == cmd2) {
+			list_info = "on eh_abort_list";
+			break;
+		}
+	}
+	list_for_each_entry(cmd2, &shost->eh_cmd_q, eh_entry) {
+		if (cmd == cmd2) {
+			list_info = "on eh_cmd_q";
+			break;
+		}
+	}
+	spin_unlock_irq(shost->host_lock);
+
 	__scsi_format_command(buf, sizeof(buf), cmd->cmnd, cmd->cmd_len);
-	seq_printf(m, ", .cmd=%s, .retries=%d, .result = %#x, .flags=", buf,
-		   cmd->retries, cmd->result);
+	seq_printf(m, ", .cmd=%s, .retries=%d, .allowed=%d, .result = %#x, %s%s.flags=",
+		   buf, cmd->retries, cmd->allowed, cmd->result,
+		   list_info ? : "", list_info ? ", " : "");
 	scsi_flags_show(m, cmd->flags, scsi_cmd_flags,
 			ARRAY_SIZE(scsi_cmd_flags));
 	seq_printf(m, ", .timeout=%d.%03d, allocated %d.%03d s ago",
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · Bart Van Assche

Provide information in debugfs about SCSI error handling to make it easier to debug the SCSI error handler. Additionally, report the maximum number of retries in debugfs (.allowed).

Cc Hannes Reinecke <[email protected]>
Cc Damien Le Moal <[email protected]>
Cc Mike Christie <[email protected]>
Cc John Garry <[email protected]>
Cc Ming Lei <[email protected]>

Looks OK to me.

Signature · 2 lines
Damien Le Moal
Western Digital Research
#2 lore raw
In reply to Bart Van Assche
Quoted 36 lines · Bart Van Assche

Provide information in debugfs about SCSI error handling to make it easier to debug the SCSI error handler. Additionally, report the maximum number of retries in debugfs (.allowed).

Cc Hannes Reinecke <[email protected]>
Cc Damien Le Moal <[email protected]>
Cc Mike Christie <[email protected]>
Cc John Garry <[email protected]>
Cc Ming Lei <[email protected]>
---
  drivers/scsi/scsi_debugfs.c | 25 ++++++++++++++++++++++---
  1 file changed, 22 insertions(+), 3 deletions(-)
drivers/scsi/scsi_debugfs.c +4 -1
index 217b70c678c3..a9bc5f7ce745 100644
@@ -3,6 +3,7 @@
  #include <linux/seq_file.h>
  #include <scsi/scsi_cmnd.h>
  #include <scsi/scsi_dbg.h>
+#include <scsi/scsi_host.h>
  #include "scsi_debugfs.h"
 
  #define SCSI_CMD_FLAG_NAME(name)[const_ilog2(SCMD_##name)] = #name
@@ -33,14 +34,32 @@ static int scsi_flags_show(struct seq_file *m, const unsigned long flags,
 
  void scsi_show_rq(struct seq_file *m, struct request *rq)
  {
-	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
+	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq), *cmd2;
+	struct Scsi_Host *shost = cmd->device->host;
  	int alloc_ms = jiffies_to_msecs(jiffies - cmd->jiffies_at_alloc);
  	int timeout_ms = jiffies_to_msecs(rq->timeout);
+	const char *list_info = NULL;

drivers/scsi/scsi_debugfs.c static int scsi_flags_show(struct seq_file *m, const unsigned long flags, · line 51

Quoted 10 lines
drivers/scsi/scsi_debugfs.c +8 -0
  	char buf[80] = "(?)";
 
+	spin_lock_irq(shost->host_lock);
+	list_for_each_entry(cmd2, &shost->eh_abort_list, eh_entry) {
+		if (cmd == cmd2) {
+			list_info = "on eh_abort_list";
+			break;
+		}
+	}
+	list_for_each_entry(cmd2, &shost->eh_cmd_q, eh_entry) {

If it's on the first list, then there is not much point in checking this list. It might be even worth checking list_empty(&cmd->eh_entry) initially also to save the bother.

Having said all this, adding those checks will add lots of unpleasant indentation...

Quoted 16 lines
drivers/scsi/scsi_debugfs.c +10 -2
+		if (cmd == cmd2) {
+			list_info = "on eh_cmd_q";
+			break;
+		}
+	}
+	spin_unlock_irq(shost->host_lock);
+
  	__scsi_format_command(buf, sizeof(buf), cmd->cmnd, cmd->cmd_len);
-	seq_printf(m, ", .cmd=%s, .retries=%d, .result = %#x, .flags=", buf,
-		   cmd->retries, cmd->result);
+	seq_printf(m, ", .cmd=%s, .retries=%d, .allowed=%d, .result = %#x, %s%s.flags=",
+		   buf, cmd->retries, cmd->allowed, cmd->result,
+		   list_info ? : "", list_info ? ", " : "");
  	scsi_flags_show(m, cmd->flags, scsi_cmd_flags,
  			ARRAY_SIZE(scsi_cmd_flags));
  	seq_printf(m, ", .timeout=%d.%03d, allocated %d.%03d s ago",
#3 lore raw
Quoted 5 lines · John Garry

If it's on the first list, then there is not much point in checking this list. It might be even worth checking list_empty(&cmd->eh_entry) initially also to save the bother.

Having said all this, adding those checks will add lots of unpleasant indentation...

Since the above code is only used to export information through debugfs I don't think that it should be optimized heavily? Anyway, how about combining the (untested) patch below with the above patch?

drivers/scsi/scsi_debugfs.c +3 -2
index a9bc5f7ce745..f795848b316c 100644
@@ -45,15 +45,16 @@ void scsi_show_rq(struct seq_file *m, struct request *rq)
 	list_for_each_entry(cmd2, &shost->eh_abort_list, eh_entry) {
 		if (cmd == cmd2) {
 			list_info = "on eh_abort_list";
-			break;
+			goto unlock;
 		}
 	}
 	list_for_each_entry(cmd2, &shost->eh_cmd_q, eh_entry) {
 		if (cmd == cmd2) {
 			list_info = "on eh_cmd_q";
-			break;
+			goto unlock;
 		}
 	}
+unlock:
 	spin_unlock_irq(shost->host_lock);
 
 	__scsi_format_command(buf, sizeof(buf), cmd->cmnd, cmd->cmd_len);

Thanks,

Bart.

Reviewed-by
#4 lore raw
Quoted 9 lines · Bart Van Assche
Quoted 5 lines · John Garry

If it's on the first list, then there is not much point in checking this list. It might be even worth checking list_empty(&cmd->eh_entry) initially also to save the bother.

Having said all this, adding those checks will add lots of unpleasant indentation...

Since the above code is only used to export information through debugfs I don't think that it should be optimized heavily?

To me it's not really a matter of having the code optimized, but more about having clear and efficient code.

Quoted 13 lines

Anyway, how about combining the
(untested) patch below with the above patch?

drivers/scsi/scsi_debugfs.c +0 -1
index a9bc5f7ce745..f795848b316c 100644
@@ -45,15 +45,16 @@ void scsi_show_rq(struct seq_file *m, struct request 
 *rq)
      list_for_each_entry(cmd2, &shost->eh_abort_list, eh_entry) {
          if (cmd == cmd2) {
              list_info = "on eh_abort_list";
-            break;

drivers/scsi/scsi_debugfs.c void scsi_show_rq(struct seq_file *m, struct request · line 57

Quoted 10 lines
drivers/scsi/scsi_debugfs.c +2 -1
+            goto unlock;
          }
      }
      list_for_each_entry(cmd2, &shost->eh_cmd_q, eh_entry) {
          if (cmd == cmd2) {
              list_info = "on eh_cmd_q";
-            break;
+            goto unlock;
          }
      }

I think that list_info could be set to NULL here, rather than when declared.

Quoted 4 lines
drivers/scsi/scsi_debugfs.c +1 -0
+unlock:
      spin_unlock_irq(shost->host_lock);
 

     __scsi_format_command(buf, sizeof(buf), cmd->cmnd, cmd->cmd_len);

Regardless of comment, above:

thanks

Reviewed-by on v1 1/1
#5 lore raw
In reply to Bart Van Assche
Quoted 10 lines · Bart Van Assche

Provide information in debugfs about SCSI error handling to make it easier to debug the SCSI error handler. Additionally, report the maximum number of retries in debugfs (.allowed).

Cc Hannes Reinecke <[email protected]>
Cc Damien Le Moal <[email protected]>
Cc Mike Christie <[email protected]>
Cc John Garry <[email protected]>
Cc Ming Lei <[email protected]>
Quoted 4 lines
---
  drivers/scsi/scsi_debugfs.c | 25 ++++++++++++++++++++++---
  1 file changed, 22 insertions(+), 3 deletions(-)

Cheers,

Hannes

Signature · 5 lines
Dr. Hannes Reinecke                Kernel Storage Architect
[email protected]                              +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), Geschäftsführer: Ivo Totev, Andrew
Myers, Andrew McDonald, Martje Boudien Moerman