Skip to contentSkip to conversation

*** nvme: add some commands tracing ***

PATCH Superseded Guixin Liu 3 participants 11 messages Jan 29, 2024 – Jan 31, 2024 NVMe

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Guixin Liu

author
#0 lore raw

cover *** nvme: add some commands tracing ***

Hi guys:
I found that there are no reservation commands tracing and some
commands's parsing aren't fit the newest NVMe spec, and aren't readble.
Changed as follow:

Guixin Liu (3):
nvme: add tracing of reservation commands
nvme: parse dsm command detailly when tracing
nvme: parse format command's lbafu when tracing

 drivers/nvme/host/trace.c | 74 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 70 insertions(+), 4 deletions(-)
Signature · 1 line
2.43.0
author
#1 lore raw

PATCH 1/3 nvme: add tracing of reservation commands

Add detailed parsing of reservation commands to make the trace log more consistent and human-readable.

---
 drivers/nvme/host/trace.c | 62 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
drivers/nvme/host/trace.c +62 -0
index 1c36fcedea20..95572c85b22a 100644
@@ -191,6 +191,60 @@ static const char *nvme_trace_zone_mgmt_recv(struct trace_seq *p, u8 *cdw10)
 	return ret;
 }
 
+static const char *nvme_trace_resv_reg(struct trace_seq *p, u8 *cdw10)
+{
+	const char *ret = trace_seq_buffer_ptr(p);
+	u8 rrega = cdw10[0] & 0x7;
+	u8 iekey = (cdw10[0] >> 3) & 0x1;
+	u8 ptpl = (cdw10[3] >> 6) & 0x3;
+
+	trace_seq_printf(p, "rrega=%u, iekey=%u, ptpl=%u",
+			 rrega, iekey, ptpl);
+	trace_seq_putc(p, 0);
+
+	return ret;
+}
+
+static const char *nvme_trace_resv_acq(struct trace_seq *p, u8 *cdw10)
+{
+	const char *ret = trace_seq_buffer_ptr(p);
+	u8 racqa = cdw10[0] & 0x7;
+	u8 iekey = (cdw10[0] >> 3) & 0x1;
+	u8 rtype = cdw10[1];
+
+	trace_seq_printf(p, "racqa=%u, iekey=%u, rtype=%u",
+			 racqa, iekey, rtype);
+	trace_seq_putc(p, 0);
+
+	return ret;
+}
+
+static const char *nvme_trace_resv_rel(struct trace_seq *p, u8 *cdw10)
+{
+	const char *ret = trace_seq_buffer_ptr(p);
+	u8 rrela = cdw10[0] & 0x7;
+	u8 iekey = (cdw10[0] >> 3) & 0x1;
+	u8 rtype = cdw10[1];
+
+	trace_seq_printf(p, "rrela=%u, iekey=%u, rtype=%u",
+			 rrela, iekey, rtype);
+	trace_seq_putc(p, 0);
+
+	return ret;
+}
+
+static const char *nvme_trace_resv_report(struct trace_seq *p, u8 *cdw10)
+{
+	const char *ret = trace_seq_buffer_ptr(p);
+	u32 numd = get_unaligned_le32(cdw10);
+	u8 eds = cdw10[4] & 0x1;
+
+	trace_seq_printf(p, "numd=%u, eds=%u", numd, eds);
+	trace_seq_putc(p, 0);
+
+	return ret;
+}
+
 static const char *nvme_trace_common(struct trace_seq *p, u8 *cdw10)
 {
 	const char *ret = trace_seq_buffer_ptr(p);
@@ -243,6 +297,14 @@ const char *nvme_trace_parse_nvm_cmd(struct trace_seq *p,
 		return nvme_trace_zone_mgmt_send(p, cdw10);
 	case nvme_cmd_zone_mgmt_recv:
 		return nvme_trace_zone_mgmt_recv(p, cdw10);
+	case nvme_cmd_resv_register:
+		return nvme_trace_resv_reg(p, cdw10);
+	case nvme_cmd_resv_acquire:
+		return nvme_trace_resv_acq(p, cdw10);
+	case nvme_cmd_resv_release:
+		return nvme_trace_resv_rel(p, cdw10);
+	case nvme_cmd_resv_report:
+		return nvme_trace_resv_report(p, cdw10);
 	default:
 		return nvme_trace_common(p, cdw10);
 	}
Signature · 1 line
2.43.0
author
#2 lore raw

PATCH 2/3 nvme: parse dsm command detailly when tracing

In reply to Guixin Liu

Add detailed parse of dsm command to make the trace log more consistent and human-readable.

---
 drivers/nvme/host/trace.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/nvme/host/trace.c +5 -3
index 95572c85b22a..b383d51c1a0c 100644
@@ -153,10 +153,12 @@ static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10)
 static const char *nvme_trace_dsm(struct trace_seq *p, u8 *cdw10)
 {
 	const char *ret = trace_seq_buffer_ptr(p);
+	u8 nr = cdw10[0];
+	u8 idr = cdw10[4] & 0x1;
+	u8 idw = (cdw10[4] >> 1) & 0x1;
+	u8 ad = (cdw10[4] >> 2) & 0x1;
 
-	trace_seq_printf(p, "nr=%u, attributes=%u",
-			 get_unaligned_le32(cdw10),
-			 get_unaligned_le32(cdw10 + 4));
+	trace_seq_printf(p, "nr=%u, idr=%u, idw=%u, ad=%u", nr, idr, idw, ad);
 	trace_seq_putc(p, 0);
 
 	return ret;
Signature · 1 line
2.43.0
#3 lore raw

Re: [PATCH 2/3] nvme: parse dsm command detailly when tracing

Quoted 18 lines · Guixin Liu

Add detailed parse of dsm command to make the trace log more consistent and human-readable.

---
  drivers/nvme/host/trace.c | 8 +++++---
  1 file changed, 5 insertions(+), 3 deletions(-)
drivers/nvme/host/trace.c +2 -0
index 95572c85b22a..b383d51c1a0c 100644
@@ -153,10 +153,12 @@ static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10)
  static const char *nvme_trace_dsm(struct trace_seq *p, u8 *cdw10)
  {
  	const char *ret = trace_seq_buffer_ptr(p);
+	u8 nr = cdw10[0];
+	u8 idr = cdw10[4] & 0x1;

drivers/nvme/host/trace.c static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10) · line 164

Quoted 10 lines
drivers/nvme/host/trace.c +3 -3
+	u8 idw = (cdw10[4] >> 1) & 0x1;
+	u8 ad = (cdw10[4] >> 2) & 0x1;
 
-	trace_seq_printf(p, "nr=%u, attributes=%u",
-			 get_unaligned_le32(cdw10),
-			 get_unaligned_le32(cdw10 + 4));
+	trace_seq_printf(p, "nr=%u, idr=%u, idw=%u, ad=%u", nr, idr, idw, ad);
  	trace_seq_putc(p, 0);
 
  	return ret;

I'm really not sure if we need to decode idw/idr as I've not seen those fields so far
used by anybody maybe I'm not aware here, but can you please provide a usecase where
you need these fields to be decoded ?

-ck

author
#4 lore raw

Re: [PATCH 2/3] nvme: parse dsm command detailly when tracing

Quoted 28 lines · Chaitanya Kulkarni
Quoted 27 lines · Guixin Liu

Add detailed parse of dsm command to make the trace log more consistent and human-readable.

---
   drivers/nvme/host/trace.c | 8 +++++---
   1 file changed, 5 insertions(+), 3 deletions(-)
drivers/nvme/host/trace.c +5 -3
index 95572c85b22a..b383d51c1a0c 100644
@@ -153,10 +153,12 @@ static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10)
   static const char *nvme_trace_dsm(struct trace_seq *p, u8 *cdw10)
   {
   	const char *ret = trace_seq_buffer_ptr(p);
+	u8 nr = cdw10[0];
+	u8 idr = cdw10[4] & 0x1;
+	u8 idw = (cdw10[4] >> 1) & 0x1;
+	u8 ad = (cdw10[4] >> 2) & 0x1;
 
-	trace_seq_printf(p, "nr=%u, attributes=%u",
-			 get_unaligned_le32(cdw10),
-			 get_unaligned_le32(cdw10 + 4));
+	trace_seq_printf(p, "nr=%u, idr=%u, idw=%u, ad=%u", nr, idr, idw, ad);
   	trace_seq_putc(p, 0);
 
Quoted 8 lines

drivers/nvme/host/trace.c static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10) · line 164

Quoted 1 line
drivers/nvme/host/trace.c +0 -0
   	return ret;

I'm really not sure if we need to decode idw/idr as I've not seen those fields so far
used by anybody maybe I'm not aware here, but can you please provide a usecase where
you need these fields to be decoded ?

-ck

Mostly we only use "ad" filed, but sometimes our tester will set idw/idr to

see whether any errors have been reported by our target. Well this is a

low-persuasive usecase, but I still insist it's better to follow the spec.

Best regadrs,

Guixin Liu

Quoted 2 lines
#5 lore raw

Re: [PATCH 2/3] nvme: parse dsm command detailly when tracing

Quoted 11 lines
Quoted 8 lines

I'm really not sure if we need to decode idw/idr as I've not seen those fields so far
used by anybody maybe I'm not aware here, but can you please provide a usecase where
you need these fields to be decoded ?

-ck

Mostly we only use "ad" filed, but sometimes our tester will set idw/idr to

Quoted 9 lines

see whether any errors have been reported by our target. Well this is a

low-persuasive usecase, but I still insist it's better to follow the spec.

Best regadrs,

Guixin Liu

Quoted 1 line

But why ? do you have a valid implementation that shows clear benefits for idw/idr ? if not I'm not sure why we need to decode these fields, unless others think it's a good idea let's not do that.

Following spec only makes sense where there is a valid implementation for the fields we are printing and not sure if it applies to idw/idr ...

I'm fine with AD and NR they are useful ...

-ck

author
#6 lore raw

Re: [PATCH 2/3] nvme: parse dsm command detailly when tracing

Quoted 21 lines · Chaitanya Kulkarni
Quoted 9 lines
Quoted 7 lines

I'm really not sure if we need to decode idw/idr as I've not seen those fields so far
used by anybody maybe I'm not aware here, but can you please provide a usecase where
you need these fields to be decoded ?

-ck

Mostly we only use "ad" filed, but sometimes our tester will set idw/idr to

Quoted 8 lines

see whether any errors have been reported by our target. Well this is a

low-persuasive usecase, but I still insist it's better to follow the spec.

Best regadrs,

Guixin Liu

But why ? do you have a valid implementation that shows clear benefits for idw/idr ? if not I'm not sure why we need to decode these fields, unless others think it's a good idea let's not do that.

Quoted 6 lines

Following spec only makes sense where there is a valid implementation for the fields we are printing and not sure if it applies to idw/idr ...

I'm fine with AD and NR they are useful ...

-ck

Okay, it will be changed in v2.

Quoted 1 line
maintainer
#7 lore raw

Re: [PATCH 2/3] nvme: parse dsm command detailly when tracing

In reply to Chaitanya Kulkarni
Quoted 28 lines · Chaitanya Kulkarni
Quoted 27 lines · Guixin Liu

Add detailed parse of dsm command to make the trace log more consistent and human-readable.

---
  drivers/nvme/host/trace.c | 8 +++++---
  1 file changed, 5 insertions(+), 3 deletions(-)
drivers/nvme/host/trace.c +5 -3
index 95572c85b22a..b383d51c1a0c 100644
@@ -153,10 +153,12 @@ static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10)
  static const char *nvme_trace_dsm(struct trace_seq *p, u8 *cdw10)
  {
  	const char *ret = trace_seq_buffer_ptr(p);
+	u8 nr = cdw10[0];
+	u8 idr = cdw10[4] & 0x1;
+	u8 idw = (cdw10[4] >> 1) & 0x1;
+	u8 ad = (cdw10[4] >> 2) & 0x1;
 
-	trace_seq_printf(p, "nr=%u, attributes=%u",
-			 get_unaligned_le32(cdw10),
-			 get_unaligned_le32(cdw10 + 4));
+	trace_seq_printf(p, "nr=%u, idr=%u, idw=%u, ad=%u", nr, idr, idw, ad);
  	trace_seq_putc(p, 0);
 
Quoted 7 lines

drivers/nvme/host/trace.c static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10) · line 164

Quoted 1 line
drivers/nvme/host/trace.c +0 -0
  	return ret;

I'm really not sure if we need to decode idw/idr as I've not seen those fields so far
used by anybody maybe I'm not aware here, but can you please provide a usecase where
you need these fields to be decoded ?

It's only reachable through passthrough. I'm not aware of a production use case, but I know there are test cases that do muck with idr/idw attributes.

I'm generally not a fan of decoding complex fields because it's not forward compatible: a newer drive in an older linux can't trace command bits that are currently reserved.

author
#8 lore raw

PATCH 3/3 nvme: parse format command's lbafu when tracing

In reply to Guixin Liu

Add the parse of format command's lbafu to calculate lbaf.

---
 drivers/nvme/host/trace.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/nvme/host/trace.c +3 -1
index b383d51c1a0c..3ccb33646794 100644
@@ -119,7 +119,9 @@ static const char *nvme_trace_get_lba_status(struct trace_seq *p,
 static const char *nvme_trace_admin_format_nvm(struct trace_seq *p, u8 *cdw10)
 {
 	const char *ret = trace_seq_buffer_ptr(p);
-	u8 lbaf = cdw10[0] & 0xF;
+	u8 lbafl = cdw10[0] & 0xF;
+	u8 lbafu = (cdw10[1] >> 4) & 0x3;
+	u8 lbaf = (lbafu << 4) | lbafl;
 	u8 mset = (cdw10[0] >> 4) & 0x1;
 	u8 pi = (cdw10[0] >> 5) & 0x7;
 	u8 pil = cdw10[1] & 0x1;
Signature · 1 line
2.43.0
#9 lore raw

Re: [PATCH 3/3] nvme: parse format command's lbafu when tracing

Quoted 12 lines · Guixin Liu

Add the parse of format command's lbafu to calculate lbaf.

---
  drivers/nvme/host/trace.c | 4 +++-
  1 file changed, 3 insertions(+), 1 deletion(-)
drivers/nvme/host/trace.c +0 -0
index b383d51c1a0c..3ccb33646794 100644

drivers/nvme/host/trace.c static const char *nvme_trace_get_lba_status(struct trace_seq *p, · line 127

Quoted 10 lines
drivers/nvme/host/trace.c +3 -1
@@ -119,7 +119,9 @@ static const char *nvme_trace_get_lba_status(struct trace_seq *p,
  static const char *nvme_trace_admin_format_nvm(struct trace_seq *p, u8 *cdw10)
  {
  	const char *ret = trace_seq_buffer_ptr(p);
-	u8 lbaf = cdw10[0] & 0xF;
+	u8 lbafl = cdw10[0] & 0xF;
+	u8 lbafu = (cdw10[1] >> 4) & 0x3;
+	u8 lbaf = (lbafu << 4) | lbafl;
  	u8 mset = (cdw10[0] >> 4) & 0x1;
  	u8 pi = (cdw10[0] >> 5) & 0x7;
  	u8 pil = cdw10[1] & 0x1;

as I don't see the newly added variables used in printing a trace do we really need
the calculation or a meaningful comment is would work ?

-ck

author
#10 lore raw

Re: [PATCH 3/3] nvme: parse format command's lbafu when tracing

Quoted 27 lines · Chaitanya Kulkarni
Quoted 12 lines · Guixin Liu

Add the parse of format command's lbafu to calculate lbaf.

---
   drivers/nvme/host/trace.c | 4 +++-
   1 file changed, 3 insertions(+), 1 deletion(-)
drivers/nvme/host/trace.c +0 -0
index b383d51c1a0c..3ccb33646794 100644

drivers/nvme/host/trace.c static const char *nvme_trace_get_lba_status(struct trace_seq *p, · line 127

Quoted 10 lines
drivers/nvme/host/trace.c +3 -1
@@ -119,7 +119,9 @@ static const char *nvme_trace_get_lba_status(struct trace_seq *p,
   static const char *nvme_trace_admin_format_nvm(struct trace_seq *p, u8 *cdw10)
   {
   	const char *ret = trace_seq_buffer_ptr(p);
-	u8 lbaf = cdw10[0] & 0xF;
+	u8 lbafl = cdw10[0] & 0xF;
+	u8 lbafu = (cdw10[1] >> 4) & 0x3;
+	u8 lbaf = (lbafu << 4) | lbafl;
   	u8 mset = (cdw10[0] >> 4) & 0x1;
   	u8 pi = (cdw10[0] >> 5) & 0x7;
   	u8 pil = cdw10[1] & 0x1;

as I don't see the newly added variables used in printing a trace do we really need
the calculation or a meaningful comment is would work ?

Quoted 1 line

-ck

OK, I will delete lbafl and lbafu variables, and add a comment for lbaf.

Quoted 2 lines