Skip to contentSkip to conversation

scsi: ufs: Quiesce all scsi devices before shutdown

RFC PATCH Superseded Stanley Chu 3 participants 5 messages Jul 6, 2020 – Jul 27, 2020

Subsystems (2)

v3 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

RFC PATCH v3 1/1 scsi: ufs: Quiesce all scsi devices before shutdown

Currently I/O request could be still submitted to UFS device while UFS is working on shutdown flow. This may lead to racing as below scenarios and finally system may crash due to unclocked register accesses.

To fix this kind of issues, specifically quiesce all SCSI devices before UFS shutdown to block all I/O request sending from block layer.

Example of racing scenario: While UFS device is runtime-suspended

Thread #1: Executing UFS shutdown flow, e.g.,
ufshcd_suspend(UFS_SHUTDOWN_PM)
Thread #2: Executing runtime resume flow triggered by I/O request,
e.g., ufshcd_resume(UFS_RUNTIME_PM)

This breaks the assumption that UFS PM flows can not be running concurrently and some unexpected racing behavior may happen.

---
 drivers/scsi/ufs/ufshcd.c | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
drivers/scsi/ufs/ufshcd.c +38 -0
index 59358bb75014..104173c03492 100644
@@ -158,6 +158,12 @@ struct ufs_pm_lvl_states ufs_pm_lvl_states[] = {
 	{UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE},
 };
 
+#define ufshcd_scsi_for_each_sdev(fn) \
+	list_for_each_entry(starget, &hba->host->__targets, siblings) { \
+		__starget_for_each_device(starget, NULL, \
+					  fn); \
+	}
+
 static inline enum ufs_dev_pwr_mode
 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl)
 {
@@ -8588,6 +8594,19 @@ int ufshcd_runtime_idle(struct ufs_hba *hba)
 }
 EXPORT_SYMBOL(ufshcd_runtime_idle);
 
+static void ufshcd_cleanup_queue(struct scsi_device *sdev, void *data)
+{
+	if (sdev->request_queue)
+		blk_cleanup_queue(sdev->request_queue);
+}
+
+static void ufshcd_quiece_sdev(struct scsi_device *sdev, void *data)
+{
+	/* Suspended devices are already quiecsed and shall be skipped */
+	if (!pm_runtime_suspended(&sdev->sdev_gendev))
+		scsi_device_quiesce(sdev);
+}
+
 /**
  * ufshcd_shutdown - shutdown routine
  * @hba: per adapter instance
@@ -8599,6 +8618,7 @@ EXPORT_SYMBOL(ufshcd_runtime_idle);
 int ufshcd_shutdown(struct ufs_hba *hba)
 {
 	int ret = 0;
+	struct scsi_target *starget;
 
 	if (!hba->is_powered)
 		goto out;
@@ -8612,7 +8632,25 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 			goto out;
 	}
 
+	/*
+	 * Quiesce all SCSI devices to prevent any non-PM requests sending
+	 * from block layer during and after shutdown.
+	 *
+	 * Here we can not use blk_cleanup_queue() since PM requests
+	 * (with BLK_MQ_REQ_PREEMPT flag) are still required to be sent
+	 * through block layer. Therefore SCSI command queued after the
+	 * scsi_target_quiesce() call returned will block until
+	 * blk_cleanup_queue() is called.
+	 *
+	 * Besides, scsi_target_"un"quiesce (e.g., scsi_target_resume) can
+	 * be ignored since shutdown is one-way flow.
+	 */
+	ufshcd_scsi_for_each_sdev(ufshcd_quiece_sdev);
+
 	ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
+
+	/* Set queue as dying to not block queueing commands */
+	ufshcd_scsi_for_each_sdev(ufshcd_cleanup_queue);
 out:
 	if (ret)
 		dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);
Signature · 1 line
2.18.0
#1 lore raw

Hi Bart, Avri,

May I know if you have any suggestion for this RFC fix?

Very appreciated : )

Quoted 95 lines · Stanley Chu

Currently I/O request could be still submitted to UFS device while UFS is working on shutdown flow. This may lead to racing as below scenarios and finally system may crash due to unclocked register accesses.

To fix this kind of issues, specifically quiesce all SCSI devices before UFS shutdown to block all I/O request sending from block layer.

Example of racing scenario: While UFS device is runtime-suspended

Thread #1: Executing UFS shutdown flow, e.g.,
ufshcd_suspend(UFS_SHUTDOWN_PM)
Thread #2: Executing runtime resume flow triggered by I/O request,
e.g., ufshcd_resume(UFS_RUNTIME_PM)

This breaks the assumption that UFS PM flows can not be running concurrently and some unexpected racing behavior may happen.

---
 drivers/scsi/ufs/ufshcd.c | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
drivers/scsi/ufs/ufshcd.c +38 -0
index 59358bb75014..104173c03492 100644
@@ -158,6 +158,12 @@ struct ufs_pm_lvl_states ufs_pm_lvl_states[] = {
 	{UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE},
 };
 
+#define ufshcd_scsi_for_each_sdev(fn) \
+	list_for_each_entry(starget, &hba->host->__targets, siblings) { \
+		__starget_for_each_device(starget, NULL, \
+					  fn); \
+	}
+
 static inline enum ufs_dev_pwr_mode
 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl)
 {
@@ -8588,6 +8594,19 @@ int ufshcd_runtime_idle(struct ufs_hba *hba)
 }
 EXPORT_SYMBOL(ufshcd_runtime_idle);
 
+static void ufshcd_cleanup_queue(struct scsi_device *sdev, void *data)
+{
+	if (sdev->request_queue)
+		blk_cleanup_queue(sdev->request_queue);
+}
+
+static void ufshcd_quiece_sdev(struct scsi_device *sdev, void *data)
+{
+	/* Suspended devices are already quiecsed and shall be skipped */
+	if (!pm_runtime_suspended(&sdev->sdev_gendev))
+		scsi_device_quiesce(sdev);
+}
+
 /**
  * ufshcd_shutdown - shutdown routine
  * @hba: per adapter instance
@@ -8599,6 +8618,7 @@ EXPORT_SYMBOL(ufshcd_runtime_idle);
 int ufshcd_shutdown(struct ufs_hba *hba)
 {
 	int ret = 0;
+	struct scsi_target *starget;
 
 	if (!hba->is_powered)
 		goto out;
@@ -8612,7 +8632,25 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 			goto out;
 	}
 
+	/*
+	 * Quiesce all SCSI devices to prevent any non-PM requests sending
+	 * from block layer during and after shutdown.
+	 *
+	 * Here we can not use blk_cleanup_queue() since PM requests
+	 * (with BLK_MQ_REQ_PREEMPT flag) are still required to be sent
+	 * through block layer. Therefore SCSI command queued after the
+	 * scsi_target_quiesce() call returned will block until
+	 * blk_cleanup_queue() is called.
+	 *
+	 * Besides, scsi_target_"un"quiesce (e.g., scsi_target_resume) can
+	 * be ignored since shutdown is one-way flow.
+	 */
+	ufshcd_scsi_for_each_sdev(ufshcd_quiece_sdev);
+
 	ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
+
+	/* Set queue as dying to not block queueing commands */
+	ufshcd_scsi_for_each_sdev(ufshcd_cleanup_queue);
 out:
 	if (ret)
 		dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);
#2 lore raw
In reply to Stanley Chu

drivers/scsi/ufs/ufshcd.c int ufshcd_runtime_idle(struct ufs_hba *hba) · line 8601

Quoted 5 lines · Stanley Chu
drivers/scsi/ufs/ufshcd.c +5 -0
+static void ufshcd_cleanup_queue(struct scsi_device *sdev, void *data)
+{
+	if (sdev->request_queue)
+		blk_cleanup_queue(sdev->request_queue);
+}

No SCSI LLD should ever call blk_cleanup_queue() directly for sdev->request_queue. Only the SCSI core should call blk_cleanup_queue() directly for that queue.

Quoted 24 lines

int ufshcd_shutdown(struct ufs_hba *hba)
{

drivers/scsi/ufs/ufshcd.c +13 -0
 	int ret = 0;
+	struct scsi_target *starget;
 
 	if (!hba->is_powered)
 		goto out;
@@ -8612,7 +8632,25 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 			goto out;
 	}
 
+	/*
+	 * Quiesce all SCSI devices to prevent any non-PM requests sending
+	 * from block layer during and after shutdown.
+	 *
+	 * Here we can not use blk_cleanup_queue() since PM requests
+	 * (with BLK_MQ_REQ_PREEMPT flag) are still required to be sent
+	 * through block layer. Therefore SCSI command queued after the
+	 * scsi_target_quiesce() call returned will block until
+	 * blk_cleanup_queue() is called.
+	 *
+	 * Besides, scsi_target_"un"quiesce (e.g., scsi_target_resume) can
+	 * be ignored since shutdown is one-way flow.

drivers/scsi/ufs/ufshcd.c int ufshcd_shutdown(struct ufs_hba *hba) · line 8656

Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +6 -0
+	 */
+	ufshcd_scsi_for_each_sdev(ufshcd_quiece_sdev);
+
 	ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
+
+	/* Set queue as dying to not block queueing commands */
+	ufshcd_scsi_for_each_sdev(ufshcd_cleanup_queue);
 out:
 	if (ret)
 		dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);

What is the purpose of ufshcd_shutdown()? Why does this function exist? How about removing the calls to ufshcd_shutdown() and invoking power down code from inside sd_suspend_common() instead?

Thanks,

Bart.

#3 lore raw

Hi Bart,

Quoted 10 lines · Bart Van Assche

drivers/scsi/ufs/ufshcd.c int ufshcd_runtime_idle(struct ufs_hba *hba) · line 8601

Quoted 5 lines · Stanley Chu
drivers/scsi/ufs/ufshcd.c +5 -0
+static void ufshcd_cleanup_queue(struct scsi_device *sdev, void *data)
+{
+	if (sdev->request_queue)
+		blk_cleanup_queue(sdev->request_queue);
+}

No SCSI LLD should ever call blk_cleanup_queue() directly for sdev->request_queue. Only the SCSI core should call blk_cleanup_queue() directly for that queue.

Got it.

So may I focus on fixing racing first by quiecsing all SCSI devices only and do not touch blk_cleanup_queue() in UFS driver, just like v2?

Quoted 30 lines
Quoted 30 lines

int ufshcd_shutdown(struct ufs_hba *hba)
{

drivers/scsi/ufs/ufshcd.c +19 -0
 	int ret = 0;
+	struct scsi_target *starget;
 
 	if (!hba->is_powered)
 		goto out;
@@ -8612,7 +8632,25 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 			goto out;
 	}
 
+	/*
+	 * Quiesce all SCSI devices to prevent any non-PM requests sending
+	 * from block layer during and after shutdown.
+	 *
+	 * Here we can not use blk_cleanup_queue() since PM requests
+	 * (with BLK_MQ_REQ_PREEMPT flag) are still required to be sent
+	 * through block layer. Therefore SCSI command queued after the
+	 * scsi_target_quiesce() call returned will block until
+	 * blk_cleanup_queue() is called.
+	 *
+	 * Besides, scsi_target_"un"quiesce (e.g., scsi_target_resume) can
+	 * be ignored since shutdown is one-way flow.
+	 */
+	ufshcd_scsi_for_each_sdev(ufshcd_quiece_sdev);
+
 	ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
+
+	/* Set queue as dying to not block queueing commands */
+	ufshcd_scsi_for_each_sdev(ufshcd_cleanup_queue);
Quoted 8 lines

drivers/scsi/ufs/ufshcd.c int ufshcd_shutdown(struct ufs_hba *hba) · line 8656

Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +0 -0
 out:
 	if (ret)
 		dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);

What is the purpose of ufshcd_shutdown()? Why does this function exist? How about removing the calls to ufshcd_shutdown() and invoking power down code from inside sd_suspend_common() instead?

ufshcd_shutdown() configures below things different from or more than what sd_suspend_common() can do now,

- Set link as OFF state
- Regulator and clock toggling according to required low-power state for shutdown
- Auto BKOP toggling
- Vendor-specific shutdown flow ...etc.

Therefore UFS shutdown callback would be still required.

Thanks,
Stanley Chu

#4 lore raw
Quoted 64 lines

Hi Bart,

Quoted 10 lines · Bart Van Assche

drivers/scsi/ufs/ufshcd.c int ufshcd_runtime_idle(struct ufs_hba *hba) · line 8601

Quoted 5 lines · Stanley Chu
drivers/scsi/ufs/ufshcd.c +5 -0
+static void ufshcd_cleanup_queue(struct scsi_device *sdev, void *data)
+{
+   if (sdev->request_queue)
+           blk_cleanup_queue(sdev->request_queue);
+}

No SCSI LLD should ever call blk_cleanup_queue() directly for sdev->request_queue. Only the SCSI core should call blk_cleanup_queue() directly for that queue.

Got it.

So may I focus on fixing racing first by quiecsing all SCSI devices only and do not touch blk_cleanup_queue() in UFS driver, just like v2?

Quoted 29 lines
Quoted 29 lines

int ufshcd_shutdown(struct ufs_hba *hba)

 {
    int ret = 0;
drivers/scsi/ufs/ufshcd.c +18 -0
+   struct scsi_target *starget;
 
    if (!hba->is_powered)
            goto out;
@@ -8612,7 +8632,25 @@ int ufshcd_shutdown(struct ufs_hba *hba)
                    goto out;
    }
 
+   /*
+    * Quiesce all SCSI devices to prevent any non-PM requests sending
+    * from block layer during and after shutdown.
+    *
+    * Here we can not use blk_cleanup_queue() since PM requests
+    * (with BLK_MQ_REQ_PREEMPT flag) are still required to be sent
+    * through block layer. Therefore SCSI command queued after the
+    * scsi_target_quiesce() call returned will block until
+    * blk_cleanup_queue() is called.
+    *
+    * Besides, scsi_target_"un"quiesce (e.g., scsi_target_resume) can
+    * be ignored since shutdown is one-way flow.
+    */
+   ufshcd_scsi_for_each_sdev(ufshcd_quiece_sdev);
+
    ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
+
+   /* Set queue as dying to not block queueing commands */
Quoted 8 lines

drivers/scsi/ufs/ufshcd.c int ufshcd_shutdown(struct ufs_hba *hba) · line 8656

Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +1 -0
+   ufshcd_scsi_for_each_sdev(ufshcd_cleanup_queue);
 out:
    if (ret)
            dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);

What is the purpose of ufshcd_shutdown()? Why does this function exist? How about removing the calls to ufshcd_shutdown() and invoking power

down

Quoted 1 line

code from inside sd_suspend_common() instead?

ufshcd_shutdown() configures below things different from or more than what sd_suspend_common() can do now,

Quoted 7 lines

- Set link as OFF state
- Regulator and clock toggling according to required low-power state for shutdown
- Auto BKOP toggling
- Vendor-specific shutdown flow ...etc.

Therefore UFS shutdown callback would be still required.

And this is also why, that each chipset vendor implement its own dev_pm_ops.

Thanks,
Avri

Quoted 3 lines

Thanks,
Stanley Chu