| Message ID | 20240925095546.19492-1-peter.wang@mediatek.com |
|---|---|
| Headers | show |
| Series | fix abort defect | expand |
On 9/25/24 2:55 AM, peter.wang@mediatek.com wrote: > case OCS_INVALID_COMMAND_STATUS: > result |= DID_REQUEUE << 16; > + dev_warn(hba->dev, > + "OCS invaild from controller for tag %d\n", > + lrbp->task_tag); Please change "invaild" into "invalid". Once that change has been made, feel free to add: Reviewed-by: Bart Van Assche <bvanassche@acm.org>
On Wed, 2024-09-25 at 09:49 -0700, Bart Van Assche wrote: > > External email : Please do not click links or open attachments until > you have verified the sender or the content. > On 9/25/24 2:55 AM, peter.wang@mediatek.com wrote: > > case OCS_INVALID_COMMAND_STATUS: > > result |= DID_REQUEUE << 16; > > +dev_warn(hba->dev, > > +"OCS invaild from controller for tag %d\n", > > +lrbp->task_tag); > > Please change "invaild" into "invalid". Once that change has been > made, > feel free to add: > > Reviewed-by: Bart Van Assche <bvanassche@acm.org> Hi Bart, Sorry, this typo wasn't corrected. However, I still feel that this patch is not quite reasonable. The reason is that in the first patch, "ufs: core: fix the issue of ICU failure" we corrected the ICU problem, allowing the SQ to clean up correctly, while the CQ will have a corresponding response. But the second patch directly ignores the CQ's response and continues to use a workaround to release the command right after ufshcd_try_to_abort_task. The Legacy SDB mode's approach would not release the command after ufshcd_try_to_abort_task. Instead, it releases after the DBR is cleared. Therefore, as I previously suggested, it would probably be more reasonable to directly requeue the ABORTED commands as shown in the patch below. --------------------------------------------------------------------- --- diff --git a/drivers/ufs/core/ufshcd.c b/drivers/ufs/core/ufshcd.c index 24a32e2fd75e..06aa4ed1a9e6 100644 --- a/drivers/ufs/core/ufshcd.c +++ b/drivers/ufs/core/ufshcd.c @@ -5417,10 +5417,12 @@ ufshcd_transfer_rsp_status(struct ufs_hba *hba, struct ufshcd_lrb *lrbp, } break; case OCS_ABORTED: - result |= DID_ABORT << 16; - break; case OCS_INVALID_COMMAND_STATUS: result |= DID_REQUEUE << 16; + dev_warn(hba->dev, + "OCS %s from controller for tag %d\n", + (ocs == OCS_ABORTED? "aborted" : "invalid"), + lrbp->task_tag); break; case OCS_INVALID_CMD_TABLE_ATTR: case OCS_INVALID_PRDT_ATTR: @@ -6466,26 +6468,12 @@ static bool ufshcd_abort_one(struct request *rq, void *priv) struct scsi_device *sdev = cmd->device; struct Scsi_Host *shost = sdev->host; struct ufs_hba *hba = shost_priv(shost); - struct ufshcd_lrb *lrbp = &hba->lrb[tag]; - struct ufs_hw_queue *hwq; - unsigned long flags; *ret = ufshcd_try_to_abort_task(hba, tag); dev_err(hba->dev, "Aborting tag %d / CDB %#02x %s\n", tag, hba->lrb[tag].cmd ? hba->lrb[tag].cmd->cmnd[0] : -1, *ret ? "failed" : "succeeded"); - /* Release cmd in MCQ mode if abort succeeds */ - if (hba->mcq_enabled && (*ret == 0)) { - hwq = ufshcd_mcq_req_to_hwq(hba, scsi_cmd_to_rq(lrbp- >cmd)); - if (!hwq) - return 0; - spin_lock_irqsave(&hwq->cq_lock, flags); - if (ufshcd_cmd_inflight(lrbp->cmd)) - ufshcd_release_scsi_cmd(hba, lrbp); - spin_unlock_irqrestore(&hwq->cq_lock, flags); - } - return *ret == 0; } --------------------------------------------------------------------- --- This patch has several advantages: 1. It makes the patch 'ufs: core: fix the issue of ICU failure' seem valuable. 2. The patch is more concise. 3. There is no need to fetch OCS to determine OCS: ABORTED on every CQ completion, which increases ISR time. 4. The err_handler flow for SDB and MCQ would be consistent. 5. There is no need for the MediaTek SDB quirk. What do you think?"
On 9/25/24 8:45 PM, Peter Wang (王信友) wrote: > diff --git a/drivers/ufs/core/ufshcd.c b/drivers/ufs/core/ufshcd.c > index 24a32e2fd75e..06aa4ed1a9e6 100644 > --- a/drivers/ufs/core/ufshcd.c > +++ b/drivers/ufs/core/ufshcd.c > @@ -5417,10 +5417,12 @@ ufshcd_transfer_rsp_status(struct ufs_hba *hba, > struct ufshcd_lrb *lrbp, > } > break; > case OCS_ABORTED: > - result |= DID_ABORT << 16; > - break; > case OCS_INVALID_COMMAND_STATUS: > result |= DID_REQUEUE << 16; > + dev_warn(hba->dev, > + "OCS %s from controller for tag %d\n", > + (ocs == OCS_ABORTED? "aborted" : > "invalid"), > + lrbp->task_tag); > break; > case OCS_INVALID_CMD_TABLE_ATTR: > case OCS_INVALID_PRDT_ATTR: > @@ -6466,26 +6468,12 @@ static bool ufshcd_abort_one(struct request > *rq, void *priv) > struct scsi_device *sdev = cmd->device; > struct Scsi_Host *shost = sdev->host; > struct ufs_hba *hba = shost_priv(shost); > - struct ufshcd_lrb *lrbp = &hba->lrb[tag]; > - struct ufs_hw_queue *hwq; > - unsigned long flags; > > *ret = ufshcd_try_to_abort_task(hba, tag); > dev_err(hba->dev, "Aborting tag %d / CDB %#02x %s\n", tag, > hba->lrb[tag].cmd ? hba->lrb[tag].cmd->cmnd[0] : -1, > *ret ? "failed" : "succeeded"); > > - /* Release cmd in MCQ mode if abort succeeds */ > - if (hba->mcq_enabled && (*ret == 0)) { > - hwq = ufshcd_mcq_req_to_hwq(hba, scsi_cmd_to_rq(lrbp- >> cmd)); > - if (!hwq) > - return 0; > - spin_lock_irqsave(&hwq->cq_lock, flags); > - if (ufshcd_cmd_inflight(lrbp->cmd)) > - ufshcd_release_scsi_cmd(hba, lrbp); > - spin_unlock_irqrestore(&hwq->cq_lock, flags); > - } > - > return *ret == 0; > } > > --------------------------------------------------------------------- > > > This patch has several advantages: > > 1. It makes the patch 'ufs: core: fix the issue of ICU failure' > seem valuable. > 2. The patch is more concise. > 3. There is no need to fetch OCS to determine OCS: ABORTED > on every CQ completion, which increases ISR time. > 4. The err_handler flow for SDB and MCQ would be consistent. > 5. There is no need for the MediaTek SDB quirk. > > > What do you think?" Hi Peter, Is the above patch sufficient? In MCQ mode, aborting a command happens as follows (simplified): (1) Send the ABORT TASK TMF. If this TMF succeeds, no SQE will be generated. If this TMF succeeds it means that the SCSI command has reached the UFS device and hence is no longer present in any submission queue (SQ). (2) If the command is still in a submission queue, nullify the SQE. In this case a CQE will be generated with status ABORTED. It seems to me that the above patch handles (2) but not (1)? Thanks, Bart.
On Thu, 2024-09-26 at 11:26 -0700, Bart Van Assche wrote: > > External email : Please do not click links or open attachments until > you have verified the sender or the content. > On 9/25/24 8:45 PM, Peter Wang (王信友) wrote: > > diff --git a/drivers/ufs/core/ufshcd.c b/drivers/ufs/core/ufshcd.c > > index 24a32e2fd75e..06aa4ed1a9e6 100644 > > --- a/drivers/ufs/core/ufshcd.c > > +++ b/drivers/ufs/core/ufshcd.c > > @@ -5417,10 +5417,12 @@ ufshcd_transfer_rsp_status(struct ufs_hba > *hba, > > struct ufshcd_lrb *lrbp, > > } > > break; > > case OCS_ABORTED: > > -result |= DID_ABORT << 16; > > -break; > > case OCS_INVALID_COMMAND_STATUS: > > result |= DID_REQUEUE << 16; > > +dev_warn(hba->dev, > > +"OCS %s from controller for tag %d\n", > > +(ocs == OCS_ABORTED? "aborted" : > > "invalid"), > > +lrbp->task_tag); > > break; > > case OCS_INVALID_CMD_TABLE_ATTR: > > case OCS_INVALID_PRDT_ATTR: > > @@ -6466,26 +6468,12 @@ static bool ufshcd_abort_one(struct request > > *rq, void *priv) > > struct scsi_device *sdev = cmd->device; > > struct Scsi_Host *shost = sdev->host; > > struct ufs_hba *hba = shost_priv(shost); > > -struct ufshcd_lrb *lrbp = &hba->lrb[tag]; > > -struct ufs_hw_queue *hwq; > > -unsigned long flags; > > > > *ret = ufshcd_try_to_abort_task(hba, tag); > > dev_err(hba->dev, "Aborting tag %d / CDB %#02x %s\n", tag, > > hba->lrb[tag].cmd ? hba->lrb[tag].cmd->cmnd[0] : -1, > > *ret ? "failed" : "succeeded"); > > > > -/* Release cmd in MCQ mode if abort succeeds */ > > -if (hba->mcq_enabled && (*ret == 0)) { > > -hwq = ufshcd_mcq_req_to_hwq(hba, scsi_cmd_to_rq(lrbp- > >> cmd)); > > -if (!hwq) > > -return 0; > > -spin_lock_irqsave(&hwq->cq_lock, flags); > > -if (ufshcd_cmd_inflight(lrbp->cmd)) > > -ufshcd_release_scsi_cmd(hba, lrbp); > > -spin_unlock_irqrestore(&hwq->cq_lock, flags); > > -} > > - > > return *ret == 0; > > } > > > > ----------------------------------------------------------------- > ---- > > > > > > This patch has several advantages: > > > > 1. It makes the patch 'ufs: core: fix the issue of ICU failure' > > seem valuable. > > 2. The patch is more concise. > > 3. There is no need to fetch OCS to determine OCS: ABORTED > > on every CQ completion, which increases ISR time. > > 4. The err_handler flow for SDB and MCQ would be consistent. > > 5. There is no need for the MediaTek SDB quirk. > > > > > > What do you think?" > > Hi Peter, > > Is the above patch sufficient? In MCQ mode, aborting a command > happens > as follows (simplified): > (1) Send the ABORT TASK TMF. If this TMF succeeds, no SQE will be > generated. If this TMF succeeds it means that the SCSI command > has > reached the UFS device and hence is no longer present in any > submission queue (SQ). > (2) If the command is still in a submission queue, nullify the SQE. > In > this case a CQE will be generated with status ABORTED. > > It seems to me that the above patch handles (2) but not (1)? > > Thanks, > > Bart. Hi Bart, Regarding your description of 'ABORT TMF success' and 'SQE' I think there might be some misunderstanding. In this section of the UFSHCI 4.0 specification. 4.4.6 (Informative) Processing Abort in MCQ mode: An Implementation Example There are three case for MCQ abort: 1. When the host controller has already sent out the SQE and the UFS device has already responded with the corresponding response, the CQ Entry will automatically increment by 1. This case is the simplest, the SQE will have a corresponding CQE for the host to cleanup resources. 2. When the host controller has not yet sent out this SQE (SQ is not empty), the software can fill in 'nullify' to notify the host controller that there is no need to send it, and directly fill the corresponding response into the CQ with OCS: ABORTED. This scenario is also straightforward, the UFS device won't be aware, and only the host controller needs to clean up the related resources. 3. When the host controller has already sent out the SQE and is waiting for the response from the UFS device (CQE), the software can initiate cleanup to notify the host controller that there is no need to wait, and directly fill the corresponding response into the CQ with OCS: ABORTED. Therefore, when a TMF is successfully executed, for example, tag 0 has been aborted, the software will know that the UFS device will no longer return a response for tag 0. Thus, the host controller needs to initiate cleanup, allowing the CQE corresponding to this SQE to return, while also cleaning the resources for tag 0. In both the second and third cases, no matter which one occurs, they will result in the CQE corresponding to the SQE being filled with OCS: ABORTED. So, as long as we directly requeue when OCS: ABORTED, it will satisfy both of these situations. Thanks Peter
On 9/27/24 12:51 AM, Peter Wang (王信友) wrote: > In this section of the UFSHCI 4.0 specification. > 4.4.6 (Informative) Processing Abort in MCQ mode: An Implementation > Example > There are three case for MCQ abort: > > 1. When the host controller has already sent out the SQE > and the UFS device has already responded with the > corresponding response, the CQ Entry will automatically > increment by 1. This case is the simplest, the SQE > will have a corresponding CQE for the host to cleanup > resources. > > 2. When the host controller has not yet sent out this SQE > (SQ is not empty), the software can fill in 'nullify' to > notify the host controller that there is no need to send > it, and directly fill the corresponding response into the > CQ with OCS: ABORTED. This scenario is also straightforward, > the UFS device won't be aware, and only the host controller > needs to clean up the related resources. > > 3. When the host controller has already sent out the SQE > and is waiting for the response from the UFS device (CQE), > the software can initiate cleanup to notify the host > controller that there is no need to wait, and directly fill > the corresponding response into the CQ with OCS: ABORTED. Hi Peter, Thank you for having drawn my attention to the above text. Regarding the code changes included in your previous email, do you agree that the completion code must not call scsi_done() if the CQE status is ABORTED and if the SCSI command has been aborted by the SCSI core since in this case calling scsi_done() could result in a use-after-free? Thanks, Bart.
On Sat, 2024-09-28 at 16:10 -0700, Bart Van Assche wrote: > > Hi Peter, > > Thank you for having drawn my attention to the above text. Regarding > the code changes included in your previous email, do you agree that > the > completion code must not call scsi_done() if the CQE status is > ABORTED > and if the SCSI command has been aborted by the SCSI core since in > this > case calling scsi_done() could result in a use-after-free? > > Thanks, > > Bart. Hi Bart, I'm not quite sure what you mean. Are you suggesting that scsi_done() should not be called in the case of a SCSI Abort? This should be unrelated to OCS: ABORTED (MCQ), because in the case of OCS: INVALID (SDB), scsi_done() might also be called, and calling scsi_done() should not cause any issues. This is because it has already been aborted by the SCSI timeout, so the test bit(SCMD_STATE_COMPLETE) would directly return. Below is the call flow: scsi_done scsi_done_internal if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state))) return; Thanks. Peter
On 9/29/24 11:45 PM, Peter Wang (王信友) wrote: > I'm not quite sure what you mean. Are you suggesting that scsi_done() > should not be called in the case of a SCSI Abort? This should be > unrelated to OCS: ABORTED (MCQ), because in the case of OCS: INVALID > (SDB), scsi_done() might also be called, and calling scsi_done() > should > not cause any issues. This is because it has already been aborted > by the SCSI timeout, so the test bit(SCMD_STATE_COMPLETE) would > directly return. Below is the call flow: > > scsi_done > scsi_done_internal > if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state))) > return; Hi Peter, The purpose of the SCMD_STATE_COMPLETE bit is to prevent that the SCSI core tries to abort a SCSI command concurrently with the SCSI LLD (UFS driver in this case) calling scsi_done(). Making scsi_done() calls no- ops while an .eh_abort_handler() implementation is in progress is an undocumented side effect of this mechanism. But since it is unlikely that this behavior will change in the SCSI core, I'm OK with relying on this behavior. ufshcd_abort_one() does not set the SCMD_STATE_COMPLETE bit before it tries to abort a SCSI command. I think this is wrong because plenty of code in ufshcd_try_to_abort_task() relies on the assumption that scsi_done() is not called while that function is in progress. Do you agree that SCMD_STATE_COMPLETE should be set by ufshcd_abort_one() before it calls ufshcd_try_to_abort_task()? If this change is made, a consequence is that the completion handler won't inform the SCSI core anymore that abortion of a command by ufshcd_abort_one() has completed. Hence, the cmd->result value won't matter anymore for commands aborted by ufshcd_abort_one() and how ufshcd_transfer_rsp_status() translates OCS_ABORTED won't matter anymore either. Thanks, Bart.
On Mon, 2024-09-30 at 10:25 -0700, Bart Van Assche wrote: > > Hi Peter, > > The purpose of the SCMD_STATE_COMPLETE bit is to prevent that the > SCSI > core tries to abort a SCSI command concurrently with the SCSI LLD > (UFS > driver in this case) calling scsi_done(). Making scsi_done() calls > no- > ops while an .eh_abort_handler() implementation is in progress is an > undocumented side effect of this mechanism. But since it is unlikely > that this behavior will change in the SCSI core, I'm OK with relying > on > this behavior. Hi Bart, Yes, the SCMD_STATE_COMPLETE bit is there to protect against a scsi command timeout and finish occurring simultaneously. Regardless of whether the timeout or finish happens first, the other will not proceed with its subsequent actions. Therefore, it is within expectations that scsi_done will not perform any actions after SCSI notified that the command has already been timeout aborted. > > ufshcd_abort_one() does not set the SCMD_STATE_COMPLETE bit before it > tries to abort a SCSI command. I think this is wrong because plenty > of > code in ufshcd_try_to_abort_task() relies on the assumption that > scsi_done() is not called while that function is in progress. Do you > agree that SCMD_STATE_COMPLETE should be set by ufshcd_abort_one() > before it calls ufshcd_try_to_abort_task()? If this change is made, a > consequence is that the completion handler won't inform the SCSI core > anymore that abortion of a command by ufshcd_abort_one() has > completed. > Hence, the cmd->result value won't matter anymore for commands > aborted > by ufshcd_abort_one() and how ufshcd_transfer_rsp_status() translates > OCS_ABORTED won't matter anymore either. > > Thanks, > SCMD_STATE_COMPLETE should not be set outside of the SCSI core. It is reasonable to set it through scsi_done(), as setting this flag also requires notifying the block layer on how to handle the completed command. If the UFS driver sets this flag, the driver would have to bypass the SCSI layer and directly notify the block layer, which is clearly not a reasonable situation. Additionally, when a command completes, the SCSI layer needs to determine how to handle it based on the result. This is obviously not something the UFS driver layer can handle on its own. Notifying the SCSI layer through the result on how to proceed is what the UFS driver should do. Furthermore, ufshcd_try_to_abort_task() is responsible for comunication between the UFS host controller and the UFS device, unrelated to the SCSI layer. Notifying SCSI layter based on the outcome of ufshcd_try_to_abort_task() should be the correct and reasonable approach, as has always been the case in SDB mode. The current difference is only that the OCS and result in SDB mode and MCQ is differ. Aligning both to the same result would likely be a more reasonable approach, wouldn't it?" Thanks. Peter > Bart.
From: Peter Wang <peter.wang@mediatek.com> V9: - Revise the OCS content printed. V8: - Remove the abort variable to simplify the abort process. - Correct error handler successfully aborts release flow. - Ingore MCQ OCS: ABORTED. V7: - Use a variable instead of a flag. - Add a check for MCQ mode when setting this variable to UFS_ERR_HANDLER. - Print OCS information for OCS_ABORTED and OCS_INVALID_COMMAND_STATUS. - Add a MediaTek quirk for handling OCS_ABORTED in SDB mode. - Skip notifying SCSI from ISR during SCSI abort (ufshcd_abort()). V6: - Add err handler check before set flag true. V5: - Change flag name. - Amend comment and patch description. V4: - Remove nullify SQ entry abort requeue. - Add more comment for flag usage and set description. - Fix build warning. V3: - Change comment and use variable(rtc) for error print - Change flag name and move flag set before ufshcd_clear_cmd - Add SDB mode clear UTRLCLR tag receive OCS_ABORTED requeue V2: - Fix mcq_enabled build error. Peter Wang (3): ufs: core: fix the issue of ICU failure ufs: core: fix error handler process for MCQ abort ufs: core: add a quirk for MediaTek SDB mode aborted drivers/ufs/core/ufs-mcq.c | 15 ++++++++------- drivers/ufs/core/ufshcd.c | 28 ++++++++++++++++++++++++++-- drivers/ufs/host/ufs-mediatek.c | 1 + include/ufs/ufshcd.h | 6 ++++++ 4 files changed, 41 insertions(+), 9 deletions(-)