Skip to contentSkip to conversation

ufs: core: Improve error handling

PATCH Superseded Bart Van Assche 2 participants 7 messages Aug 12

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Bart Van Assche

author reviewer
#0 lore raw

cover ufs: core: Improve error handling

Hi Martin,

This patch series fixes two subtle race conditions related to UFS error handling. Please consider these changes for the next merge window.

Thanks,

Bart.

Bart Van Assche (3):
ufs: core: Simplify timeout handling for START STOP UNIT commands
ufs: core: Fix a race condition triggered by ufshcd_eh_timed_out()
ufs: core: Do not forcibly complete SCSI commands

 drivers/ufs/core/ufs-mcq.c     | 26 ----------
 drivers/ufs/core/ufshcd-priv.h |  2 -
 drivers/ufs/core/ufshcd.c      | 88 ++++++++--------------------------
 3 files changed, 19 insertions(+), 97 deletions(-)
author reviewer
#1 lore raw

PATCH 1/3 ufs: core: Simplify timeout handling for START STOP UNIT commands

The set_host_byte(cmd, DID_REQUEUE) code has been copied from ufshcd_mcq_force_compl_one(). That completion status is useful for SCSI commands that should be retried but not for START STOP UNIT commands, the only type of SCSI command for which ufshcd_eh_timed_out() calls set_host_byte(). The SCMD_FAIL_IF_RECOVERING flag is set for START STOP UNIT commands. This causes scsi_queue_rq() to fail SCSI commands. Simplify timeout handling for START STOP UNIT commands by skipping command resubmission and by failing START STOP UNIT commands directly. See also commit 01d5e237b339 ("scsi: ufs: core: Handle PM commands timeout before SCSI EH").

---
 drivers/ufs/core/ufshcd.c | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)
drivers/ufs/core/ufshcd.c +2 -6
index a51e071916cf..73f1e8817f44 100644
@@ -9604,13 +9604,9 @@ static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd)
 			spin_unlock_irqrestore(&hba->outstanding_lock, flags);
 		}
 
-		if (ufshcd_is_scsi_cmd(scmd)) {
-			set_host_byte(scmd, DID_REQUEUE);
+		set_host_byte(scmd, DID_TIME_OUT);
+		if (ufshcd_is_scsi_cmd(scmd))
 			ufshcd_release_scsi_cmd(hba, scmd);
-		} else {
-			set_host_byte(scmd, DID_TIME_OUT);
-		}
-
 		scsi_done(scmd);
 	}
 
#2 lore raw

Re: [PATCH 1/3] ufs: core: Simplify timeout handling for START STOP UNIT commands

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [High] Replacing DID_REQUEUE with DID_TIME_OUT for START STOP UNIT commands inadvertently routes them to…

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] Replacing DID_REQUEUE with DID_TIME_OUT for START STOP UNIT commands inadvertently routes them to the SCSI Error Handler, risking deadlock and breaking PM recovery. --

--- Patch [1]: [PATCH 1/3] ufs: core: Simplify timeout handling for START STOP UNIT commands --- commit 457c19a7449f41757fe8a8fc3aa57e02dd255499
Author: Bart Van Assche <[email protected]>

ufs: core: Simplify timeout handling for START STOP UNIT commands

This commit simplifies timeout handling for START STOP UNIT commands by failing them directly instead of requeuing them. It updates the ufshcd_eh_timed_out handler to use DID_TIME_OUT rather than DID_REQUEUE for SCSI commands.

drivers/ufs/core/ufshcd.c static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd) · line 9575

Quoted 10 lines
drivers/ufs/core/ufshcd.c +1 -2
@@ -9572,13 +9572,9 @@ static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd)
 			spin_unlock_irqrestore(&hba->outstanding_lock, flags);
 		}
 
-		if (ufshcd_is_scsi_cmd(scmd)) {
-			set_host_byte(scmd, DID_REQUEUE);
+		set_host_byte(scmd, DID_TIME_OUT);

[Severity: High]
Will this inadvertently route START STOP UNIT commands to the SCSI Error Handler and risk deadlocks during PM recovery?

Looking at scsi_decide_disposition(), setting DID_TIME_OUT for commands other than INQUIRY or TEST_UNIT_READY (such as START STOP UNIT, opcode 0x1B) evaluates to FAILED. The SCSI core then proceeds to call scsi_eh_scmd_add(), which flags the host for SHOST_RECOVERY and wakes the SCSI Error Handler thread.

Waking the EH thread during PM transitions appears to break the UFS subsystem's custom inline recovery and reintroduces the deadlocks that commit 01d5e237b339 originally resolved.

If the goal is to fail the command directly without retries and without invoking the EH, would an error status that evaluates to SUCCESS in scsi_decide_disposition() (such as DID_BAD_TARGET) be more appropriate here?

Quoted 8 lines
drivers/ufs/core/ufshcd.c +1 -4
+		if (ufshcd_is_scsi_cmd(scmd))
 			ufshcd_release_scsi_cmd(hba, scmd);
-		} else {
-			set_host_byte(scmd, DID_TIME_OUT);
-		}
-
 		scsi_done(scmd);
 	}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
author reviewer
#3 lore raw

PATCH 2/3 ufs: core: Fix a race condition triggered by ufshcd_eh_timed_out()

In reply to Bart Van Assche

If a START STOP UNIT command times out, the ufshcd_link_recovery() call in ufshcd_eh_timed_out() may call scsi_done() for that command via the force-completion mechanism. This may cause ufshcd_set_dev_pwr_mode() to return before link recovery has finished. Fix this race condition by moving the ufshcd_link_recovery() call into ufshcd_set_dev_pwr_mode().

Fixes 7029e2151a7c ("scsi: ufs: Fix a deadlock between PM and the SCSI error handler")
---
 drivers/ufs/core/ufshcd.c | 36 ++++++++++++------------------------
 1 file changed, 12 insertions(+), 24 deletions(-)
drivers/ufs/core/ufshcd.c +12 -24
index 73f1e8817f44..0618712be32c 100644
@@ -9582,34 +9582,18 @@ static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd)
 		return SCSI_EH_NOT_HANDLED;
 	}
 
-	/*
-	 * Handle the timeout directly to prevent a deadlock between
-	 * ufshcd_set_dev_pwr_mode() and ufshcd_err_handler().
-	 */
-	ufshcd_link_recovery(hba);
-	dev_info(hba->dev, "%s() finished; outstanding_tasks = %#lx.\n",
-		 __func__, hba->outstanding_tasks);
-
-	/*
-	 * ufshcd_link_recovery() may already have completed @scmd, e.g. via
-	 * the existing MCQ force-completion path.
-	 */
-	if (!test_bit(SCMD_STATE_COMPLETE, &scmd->state)) {
-		if (!hba->mcq_enabled) {
-			unsigned long flags;
-			struct request *rq = scsi_cmd_to_rq(scmd);
+	if (!hba->mcq_enabled) {
+		struct request *rq = scsi_cmd_to_rq(scmd);
 
-			spin_lock_irqsave(&hba->outstanding_lock, flags);
+		scoped_guard(spinlock_irqsave, &hba->outstanding_lock)
 			__clear_bit(rq->tag, &hba->outstanding_reqs);
-			spin_unlock_irqrestore(&hba->outstanding_lock, flags);
-		}
-
-		set_host_byte(scmd, DID_TIME_OUT);
-		if (ufshcd_is_scsi_cmd(scmd))
-			ufshcd_release_scsi_cmd(hba, scmd);
-		scsi_done(scmd);
 	}
 
+	set_host_byte(scmd, DID_TIME_OUT);
+	if (ufshcd_is_scsi_cmd(scmd))
+		ufshcd_release_scsi_cmd(hba, scmd);
+	scsi_done(scmd);
+
 	return SCSI_EH_DONE;
 }
 
@@ -10123,9 +10107,13 @@ static int ufshcd_set_dev_pwr_mode(struct ufs_hba *hba,
 		sdev_printk(KERN_WARNING, sdp,
 			    "START_STOP failed for power mode: %d, result %x\n",
 			    pwr_mode, ret);
+
+		ufshcd_link_recovery(hba);
+
 		if (ret > 0) {
 			if (scsi_sense_valid(&sshdr))
 				scsi_print_sense_hdr(sdp, NULL, &sshdr);
+
 			ret = -EIO;
 		}
 	} else {
#4 lore raw

Re: [PATCH 2/3] ufs: core: Fix a race condition triggered by ufshcd_eh_timed_out()

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [Critical] Race condition with hardware completions leading to double-release of DMA and PM resources.…

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Critical] Race condition with hardware completions leading to double-release of DMA and PM resources.
- [High] Unconditional hardware link recovery for non-timeout START STOP UNIT failures. --

--- Patch [2]: [PATCH 2/3] ufs: core: Fix a race condition triggered by ufshcd_eh_timed_out() --- commit 5124f897a6830560d1ea1c644750541f1ef1fc0b
Author: Bart Van Assche <[email protected]>

ufs: core: Fix a race condition triggered by ufshcd_eh_timed_out()

This patch moves ufshcd_link_recovery() out of the timeout handler and into ufshcd_set_dev_pwr_mode() to prevent deadlocks. It also removes the checking of SCMD_STATE_COMPLETE before command cleanup in the timeout handler.

Quoted 32 lines
drivers/ufs/core/ufshcd.c +3 -19
index 6b94f0d91790c..cdfcd3d4c4c97 100644
@@ -9550,34 +9550,18 @@ static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd)
 		return SCSI_EH_NOT_HANDLED;
 	}
 
-	/*
-	 * Handle the timeout directly to prevent a deadlock between
-	 * ufshcd_set_dev_pwr_mode() and ufshcd_err_handler().
-	 */
-	ufshcd_link_recovery(hba);
-	dev_info(hba->dev, "%s() finished; outstanding_tasks = %#lx.\n",
-		 __func__, hba->outstanding_tasks);
-
-	/*
-	 * ufshcd_link_recovery() may already have completed @scmd, e.g. via
-	 * the existing MCQ force-completion path.
-	 */
-	if (!test_bit(SCMD_STATE_COMPLETE, &scmd->state)) {
-		if (!hba->mcq_enabled) {
-			unsigned long flags;
-			struct request *rq = scsi_cmd_to_rq(scmd);
+	if (!hba->mcq_enabled) {
+		struct request *rq = scsi_cmd_to_rq(scmd);
 
-			spin_lock_irqsave(&hba->outstanding_lock, flags);
+		scoped_guard(spinlock_irqsave, &hba->outstanding_lock)
 			__clear_bit(rq->tag, &hba->outstanding_reqs);
-			spin_unlock_irqrestore(&hba->outstanding_lock, flags);
-		}

drivers/ufs/core/ufshcd.c static enum scsi_timeout_action ufshcd_eh_timed_out(struct scsi_cmnd *scmd) · line 9562

Quoted 10 lines
drivers/ufs/core/ufshcd.c +3 -5
-
-		set_host_byte(scmd, DID_TIME_OUT);
-		if (ufshcd_is_scsi_cmd(scmd))
-			ufshcd_release_scsi_cmd(hba, scmd);
-		scsi_done(scmd);
 	}
 
+	set_host_byte(scmd, DID_TIME_OUT);
+	if (ufshcd_is_scsi_cmd(scmd))
+		ufshcd_release_scsi_cmd(hba, scmd);

[Severity: Critical]
Since the synchronous ufshcd_link_recovery() call has been removed from this handler, the controller is still running and could complete this command concurrently.

By removing the check for SCMD_STATE_COMPLETE, doesn't this create a race where both the timeout handler and the hardware completion interrupt (via ufshcd_compl_one_cqe()) might call ufshcd_release_scsi_cmd() on the same command simultaneously?

This could lead to double-unmapping DMA regions and decrementing PM clock gating refcounts twice.

drivers/ufs/core/ufshcd.c static int ufshcd_set_dev_pwr_mode(struct ufs_hba *hba, · line 10079

Quoted 11 lines
drivers/ufs/core/ufshcd.c +4 -0
+	scsi_done(scmd);
+
 	return SCSI_EH_DONE;
 }
 
@@ -10091,9 +10075,13 @@ static int ufshcd_set_dev_pwr_mode(struct ufs_hba *hba,
 		sdev_printk(KERN_WARNING, sdp,
 			    "START_STOP failed for power mode: %d, result %x\n",
 			    pwr_mode, ret);
+
+		ufshcd_link_recovery(hba);

[Severity: High]
Does this unconditionally trigger a full hardware link recovery for any non-zero return value from scsi_execute_cmd()?

The scsi_execute_cmd() call can fail for reasons other than timeouts, such as memory pressure returning -ENOMEM or normal device check conditions. Calling ufshcd_link_recovery() in these scenarios seems like it would cause severe performance degradation and disruptive device resets for routine errors.

Should this check the specific failure reason, like DID_TIME_OUT, before initiating recovery?

Quoted 8 lines
drivers/ufs/core/ufshcd.c +2 -0
+
 		if (ret > 0) {
 			if (scsi_sense_valid(&sshdr))
 				scsi_print_sense_hdr(sdp, NULL, &sshdr);
+
 			ret = -EIO;
 		}
 	} else {
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
author reviewer
#5 lore raw

PATCH 3/3 ufs: core: Do not forcibly complete SCSI commands

In reply to Bart Van Assche

The SCSI core error handler is responsible for deciding whether to abort or to requeue SCSI commands. A SCSI LLD shouldn't interfere with this decision. Hence, do not forcibly complete SCSI commands from inside the UFS error handler. This patch makes the MCQ behavior consistent with the behavior for legacy mode.

Fixes ab248643d3d6 ("scsi: ufs: core: Add error handling for MCQ mode")
---
 drivers/ufs/core/ufs-mcq.c     | 26 ------------------
 drivers/ufs/core/ufshcd-priv.h |  2 --
 drivers/ufs/core/ufshcd.c      | 48 +++++-----------------------------
 3 files changed, 7 insertions(+), 69 deletions(-)
drivers/ufs/core/ufs-mcq.c +0 -26
index 8106d55f4041..55ed72d15ada 100644
@@ -328,32 +328,6 @@ static void ufshcd_mcq_process_cqe(struct ufs_hba *hba,
 	}
 }
 
-/*
- * This function is called from the UFS error handler with the UFS host
- * controller disabled (HCE = 0). Reading host controller registers, e.g. the
- * CQ tail pointer (CQTPy), may not be safe with the host controller disabled.
- * Hence, iterate over all completion queue entries. This won't result in
- * double completions because ufshcd_mcq_process_cqe() clears a CQE after it
- * has been processed.
- */
-void ufshcd_mcq_compl_all_cqes_lock(struct ufs_hba *hba,
-				    struct ufs_hw_queue *hwq)
-{
-	unsigned long flags;
-	u32 entries = hwq->max_entries;
-
-	spin_lock_irqsave(&hwq->cq_lock, flags);
-	while (entries > 0) {
-		ufshcd_mcq_process_cqe(hba, hwq);
-		ufshcd_mcq_inc_cq_head_slot(hwq);
-		entries--;
-	}
-
-	ufshcd_mcq_update_cq_tail_slot(hwq);
-	hwq->cq_head_slot = hwq->cq_tail_slot;
-	spin_unlock_irqrestore(&hwq->cq_lock, flags);
-}
-
 unsigned long ufshcd_mcq_poll_cqe_lock(struct ufs_hba *hba,
 				       struct ufs_hw_queue *hwq)
 {
drivers/ufs/core/ufshcd-priv.h +0 -2
index e55c2a02c1f5..8ddc19143abf 100644
@@ -73,8 +73,6 @@ int ufshcd_get_hba_mac(struct ufs_hba *hba);
 int ufshcd_mcq_memory_alloc(struct ufs_hba *hba);
 struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,
 					   struct request *req);
-void ufshcd_mcq_compl_all_cqes_lock(struct ufs_hba *hba,
-				    struct ufs_hw_queue *hwq);
 bool ufshcd_cmd_inflight(struct scsi_cmnd *cmd);
 int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag);
 int ufshcd_mcq_abort(struct scsi_cmnd *cmd);
drivers/ufs/core/ufshcd.c +7 -41

88 lines not on this page · raw message

#6 lore raw

Re: [PATCH 3/3] ufs: core: Do not forcibly complete SCSI commands

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Critical] Polling the MCQ Completion Queue by reading hardware registers while the host controller is…

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Critical] Polling the MCQ Completion Queue by reading hardware registers while the host controller is disabled (HCE=0) causes a hard CPU lockup due to an infinite loop. --

--- Patch [3]: [PATCH 3/3] ufs: core: Do not forcibly complete SCSI commands --- commit af070348e9f00f73ade393f3d9421e41e0afb4fb
Author: Bart Van Assche <[email protected]>

ufs: core: Do not forcibly complete SCSI commands

This patch removes the forced completion of SCSI commands from the UFS error handler for MCQ mode, delegating abort and requeue decisions to the SCSI core. It makes MCQ behavior consistent with legacy mode by removing ufshcd_mcq_compl_all_cqes_lock and the force_compl flag.

Quoted 4 lines
drivers/ufs/core/ufshcd.c +0 -0
index cdfcd3d4c4c97..26bc2b0c08124 100644

[ ... ]

drivers/ufs/core/ufshcd.c static int ufshcd_host_reset_and_restore(struct ufs_hba *hba) · line 8166

Quoted 6 lines
drivers/ufs/core/ufshcd.c +1 -1
@@ -8197,7 +8163,7 @@ static int ufshcd_host_reset_and_restore(struct ufs_hba *hba)
 	 */
 	ufshcd_hba_stop(hba);
 	hba->silence_err_logs = true;
-	ufshcd_complete_requests(hba, true);
+	ufshcd_complete_requests(hba);

[Severity: Critical]
Can this lead to an infinite loop and hard lockup during error recovery?

After ufshcd_hba_stop() disables the host controller, ufshcd_complete_requests() now eventually calls ufshcd_mcq_poll_cqe_lock():

ufshcd_host_reset_and_restore()
ufshcd_hba_stop()
ufshcd_complete_requests()

    ufshcd_mcq_compl_pending_transfer()
      blk_mq_tagset_busy_iter(..., ufshcd_mcq_compl_one, ...)
        ufshcd_mcq_compl_one()
          ufshcd_mcq_poll_cqe_lock()

In ufshcd_mcq_poll_cqe_lock():

    ufshcd_mcq_update_cq_tail_slot(hwq);
    while (!ufshcd_mcq_is_cq_empty(hwq)) {
        ...
        ufshcd_mcq_inc_cq_head_slot(hwq);
    }

If reading the disabled MMIO register in ufshcd_mcq_update_cq_tail_slot() returns 0xFFFFFFFF, the tail slot becomes out-of-bounds. Since the head slot wraps around at hwq->max_entries, ufshcd_mcq_is_cq_empty() will never evaluate to true.

Because this loop runs with the hwq->cq_lock spinlock held and interrupts disabled, will this permanently hang the CPU?

Quoted 3 lines
drivers/ufs/core/ufshcd.c +0 -0
 	hba->silence_err_logs = false;
 
 	/* scale up clocks to max frequency before full reinitialization */
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3