Skip to contentSkip to conversation

nvme-pci: enhance timeout kernel log

PATCH In review Keith Busch 4 participants 4 messages Jan 5, 2024 – Jan 8, 2024 NVMe

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 nvme-pci: enhance timeout kernel log

From: Keith Busch <[email protected]>

Kernel configs don't necessarily have opcode decoding, and some opcodes are not even decodable. It is still interesting for debugging SSD issues to know what opcode is timing out, what request type it came from, and the data size (if applicable).

Also print the command_id along side blk-mq's tag to help match commands with protocol wire traces and firmware logs,

---
v2->v3: formatting updates and print out the command_id too

 drivers/nvme/host/pci.c | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)
drivers/nvme/host/pci.c +14 -10
index f272026807419..698c6e497a22e 100644
@@ -1284,6 +1284,7 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 	struct request *abort_req;
 	struct nvme_command cmd = { };
 	u32 csts = readl(dev->bar + NVME_REG_CSTS);
+	u8 opcode;
 
 	/* If PCI error recovery process is happening, we cannot reset or
 	 * the recovery mechanism will surely fail.
@@ -1310,8 +1311,8 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 
 	if (blk_mq_rq_state(req) != MQ_RQ_IN_FLIGHT) {
 		dev_warn(dev->ctrl.device,
-			 "I/O %d QID %d timeout, completion polled\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) QID %d timeout, completion polled\n",
+			 req->tag, nvme_cid(req), nvmeq->qid);
 		return BLK_EH_DONE;
 	}
 
@@ -1327,8 +1328,8 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 		fallthrough;
 	case NVME_CTRL_DELETING:
 		dev_warn_ratelimited(dev->ctrl.device,
-			 "I/O %d QID %d timeout, disable controller\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) QID %d timeout, disable controller\n",
+			 req->tag, nvme_cid(req), nvmeq->qid);
 		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
 		nvme_dev_disable(dev, true);
 		return BLK_EH_DONE;
@@ -1343,10 +1344,13 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 	 * command was already aborted once before and still hasn't been
 	 * returned to the driver, or if this is the admin queue.
 	 */
+	opcode = nvme_req(req)->cmd->common.opcode;
 	if (!nvmeq->qid || iod->aborted) {
 		dev_warn(dev->ctrl.device,
-			 "I/O %d QID %d timeout, reset controller\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) opcode %s %x QID %d timeout, reset controller\n",
+			 req->tag, nvme_cid(req),
+			 nvme_opcode_str(nvmeq->qid, opcode, 0), opcode,
+			 nvmeq->qid);
 		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
 		goto disable;
 	}
@@ -1362,10 +1366,10 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 	cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
 
 	dev_warn(nvmeq->dev->ctrl.device,
-		"I/O %d (%s) QID %d timeout, aborting\n",
-		 req->tag,
-		 nvme_get_opcode_str(nvme_req(req)->cmd->common.opcode),
-		 nvmeq->qid);
+		 "I/O tag %d (%04x) opcode %s %x QID %d timeout, aborting req_op:%s(%u) size:%u\n",
+		 req->tag, nvme_cid(req), nvme_get_opcode_str(opcode), opcode,
+		 nvmeq->qid, blk_op_str(req_op(req)), req_op(req),
+		 blk_rq_bytes(req));
 
 	abort_req = blk_mq_alloc_request(dev->ctrl.admin_q, nvme_req_op(&cmd),
 					 BLK_MQ_REQ_NOWAIT);
Signature · 1 line
2.34.1
Reviewed-by on v3 1/1
#1 lore raw
Quoted 52 lines · Keith Busch

From: Keith Busch <[email protected]>

Kernel configs don't necessarily have opcode decoding, and some opcodes are not even decodable. It is still interesting for debugging SSD issues to know what opcode is timing out, what request type it came from, and the data size (if applicable).

Also print the command_id along side blk-mq's tag to help match commands with protocol wire traces and firmware logs,

---
v2->v3: formatting updates and print out the command_id too

  drivers/nvme/host/pci.c | 24 ++++++++++++++----------
  1 file changed, 14 insertions(+), 10 deletions(-)
drivers/nvme/host/pci.c +5 -4
index f272026807419..698c6e497a22e 100644
@@ -1284,6 +1284,7 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
  	struct request *abort_req;
  	struct nvme_command cmd = { };
  	u32 csts = readl(dev->bar + NVME_REG_CSTS);
+	u8 opcode;
 
  	/* If PCI error recovery process is happening, we cannot reset or
  	 * the recovery mechanism will surely fail.
@@ -1310,8 +1311,8 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
 
  	if (blk_mq_rq_state(req) != MQ_RQ_IN_FLIGHT) {
  		dev_warn(dev->ctrl.device,
-			 "I/O %d QID %d timeout, completion polled\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) QID %d timeout, completion polled\n",
+			 req->tag, nvme_cid(req), nvmeq->qid);
  		return BLK_EH_DONE;
  	}
 
@@ -1327,8 +1328,8 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
  		fallthrough;
  	case NVME_CTRL_DELETING:
  		dev_warn_ratelimited(dev->ctrl.device,
-			 "I/O %d QID %d timeout, disable controller\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) QID %d timeout, disable controller\n",
+			 req->tag, nvme_cid(req), nvmeq->qid);
  		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
  		nvme_dev_disable(dev, true);
  		return BLK_EH_DONE;

drivers/nvme/host/pci.c static enum blk_eh_timer_return nvme_timeout(struct request *req) · line 1350

Quoted 9 lines
drivers/nvme/host/pci.c +2 -2
@@ -1343,10 +1344,13 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
  	 * command was already aborted once before and still hasn't been
  	 * returned to the driver, or if this is the admin queue.
  	 */
+	opcode = nvme_req(req)->cmd->common.opcode;
  	if (!nvmeq->qid || iod->aborted) {
  		dev_warn(dev->ctrl.device,
-			 "I/O %d QID %d timeout, reset controller\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) opcode %s %x QID %d timeout, reset controller\n",

maybe:

"I/O tag %d (%04x) opcode %#x (%s) QID %d timeout, reset controller\n",

I'm sending patches to align rdma and tcp to print tag and cid as well.

otherwise looks good,

Quoted 21 lines
drivers/nvme/host/pci.c +7 -4
+			 req->tag, nvme_cid(req),
+			 nvme_opcode_str(nvmeq->qid, opcode, 0), opcode,
+			 nvmeq->qid);
  		nvme_req(req)->flags |= NVME_REQ_CANCELLED;
  		goto disable;
  	}
@@ -1362,10 +1366,10 @@ static enum blk_eh_timer_return nvme_timeout(struct request *req)
  	cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
 
  	dev_warn(nvmeq->dev->ctrl.device,
-		"I/O %d (%s) QID %d timeout, aborting\n",
-		 req->tag,
-		 nvme_get_opcode_str(nvme_req(req)->cmd->common.opcode),
-		 nvmeq->qid);
+		 "I/O tag %d (%04x) opcode %s %x QID %d timeout, aborting req_op:%s(%u) size:%u\n",
+		 req->tag, nvme_cid(req), nvme_get_opcode_str(opcode), opcode,
+		 nvmeq->qid, blk_op_str(req_op(req)), req_op(req),
+		 blk_rq_bytes(req));
 
  	abort_req = blk_mq_alloc_request(dev->ctrl.admin_q, nvme_req_op(&cmd),
  					 BLK_MQ_REQ_NOWAIT);
#2 lore raw
Quoted 3 lines · Max Gurtovoy

"I/O tag %d (%04x) opcode %#x (%s) QID %d timeout, reset controller\n",

I'm sending patches to align rdma and tcp to print tag and cid as well.

Yes, that sounds good to me.

maintainer
#3 lore raw
In reply to Max Gurtovoy
Quoted 12 lines · Max Gurtovoy

drivers/nvme/host/pci.c static enum blk_eh_timer_return nvme_timeout(struct request *req) · line 1350

Quoted 8 lines · Keith Busch

* returned to the driver, or if this is the admin queue. */

drivers/nvme/host/pci.c +2 -2
+	opcode = nvme_req(req)->cmd->common.opcode;
  	if (!nvmeq->qid || iod->aborted) {
  		dev_warn(dev->ctrl.device,
-			 "I/O %d QID %d timeout, reset controller\n",
-			 req->tag, nvmeq->qid);
+			 "I/O tag %d (%04x) opcode %s %x QID %d timeout, reset controller\n",

maybe:

Quoted 7 lines

"I/O tag %d (%04x) opcode %#x (%s) QID %d timeout, reset controller\n",

I'm sending patches to align rdma and tcp to print tag and cid as well.

otherwise looks good,

Thanks for the suggestion. Applied to nvme-6.8.