Prevent non-NCQ command starvation
Damien Le Moal
maintainerv2 cover Prevent non-NCQ command starvation
This small patch series addresses potential command starvation issues with non-NCQ passthrough commands issued to a device accessed through a multi-queue libsas HBA. In such setup, a non-NCQ passthrough command issued by an application may suffer long delays and even complete starvation if the device is under constant NCQ read/write workload.
This issue is avoided by limiting the requeing through the block layer and instead explicitly waiting for the device command queue to drain before issuing the non-NCQ command. This is done reliably by not trying to second guess ata EH in case of error or device reset, by always requeuing a deferred command whenever EH is scheduled for the device port.
When a non-ncq command is deferred waiting for the device queue to drain, all new incoming commands are always requeued through the regular busy mechanism, thus avoiding the need to manage an internal command queue.
With this, the long latencies observed when executing non-NCQ passthrough commands under a heavy NCQ read/write workload at high queue depth is resolved: the non-NCQ command latency only depends on how long it takes for all in-flight commands to complete.
Changes from v1:
- Fixed ac leak in ata_scsi_defer() in patch 2.
- Added Hannes review tag
Damien Le Moal (2):
ata: libata-scsi: refactor ata_scsi_translate()
ata: libata-scsi: avoid passthrough command starvation
drivers/ata/libata-core.c | 1 + drivers/ata/libata-eh.c | 6 ++ drivers/ata/libata-scsi.c | 157 ++++++++++++++++++++++++++++++++------ drivers/ata/libata.h | 2 + include/linux/libata.h | 3 + 5 files changed, 144 insertions(+), 25 deletions(-)
Signature · 1 line
2.52.0
Damien Le Moal
maintainerPATCH v2 1/2 ata: libata-scsi: refactor ata_scsi_translate()
Factor out of ata_scsi_translate() the code handling queued command deferral using the port qc_defer callback into the new function ata_scsi_defer(), and simplify the goto used in ata_scsi_translate(). While at it, also add a lockdep annotation to check that the port lock is held when ata_scsi_translate() is called.
No functional changes.
--- drivers/ata/libata-scsi.c | 66 ++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 26 deletions(-)
drivers/ata/libata-scsi.c +40 -26
@@ -1691,6 +1691,30 @@ static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)ata_qc_done (qc); } +static int ata_scsi_defer (struct ata_port *ap,struct ata_queued_cmd *qc) +{ +int ret; + +if (!ap->ops->qc_defer) +return 0 ; + + ret = ap->ops->qc_defer (qc); +if (!ret) +return 0 ; + +ata_qc_free (qc); + +switch (ret) { +case ATA_DEFER_LINK : +return SCSI_MLQUEUE_DEVICE_BUSY ; +case ATA_DEFER_PORT : +return SCSI_MLQUEUE_HOST_BUSY ; +default : +WARN_ON_ONCE (1 ); +return SCSI_MLQUEUE_HOST_BUSY ; + } +} +/** * ata_scsi_translate - Translate then issue SCSI command to ATA device * @dev: ATA device to which the command is addressed
@@ -1714,8 +1738,8 @@ static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)* spin_lock_irqsave(host lock) * * RETURNS: -* 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command -* needs to be deferred. +* 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY or SCSI_MLQUEUE_HOST_BUSY if the +* command needs to be deferred. */ static int ata_scsi_translate (struct ata_device *dev,struct scsi_cmnd *cmd,ata_xlat_func_t xlat_func)
@@ -1724,56 +1748,46 @@ static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,struct ata_queued_cmd *qc;int rc; +lockdep_assert_held (ap->lock); + +/* +* If we fail to allocate a qc, simply return without reporting an error +* as scsi_done(cmd) is already called. +*/ qc =ata_scsi_qc_new (dev, cmd);if (!qc) - goto err_mem; +return 0 ;/* data is present; dma-map it */ if (cmd->sc_data_direction ==DMA_FROM_DEVICE || cmd->sc_data_direction ==DMA_TO_DEVICE ) {if (unlikely (scsi_bufflen (cmd) <1 )) {ata_dev_warn (dev,"WARNING: zero len r/w req\n" ); - goto err_did; + cmd->result = (DID_ERROR <<16 ); + goto done; }ata_sg_init (qc,scsi_sglist (cmd),scsi_sg_count (cmd)); - qc->dma_dir = cmd->sc_data_direction; } qc->complete_fn = ata_scsi_qc_complete;if (xlat_func (qc)) - goto early_finish; + goto done; -if (ap->ops->qc_defer) { -if ((rc = ap->ops->qc_defer (qc))) - goto defer; - } + rc =ata_scsi_defer (ap, qc); +if (rc) +return rc; -/* select device, send command to hardware */ ata_qc_issue (qc);return 0 ; -early_finish: -ata_qc_free (qc); -scsi_done (cmd); -return 0 ; - -err_did: +done:ata_qc_free (qc); - cmd->result = (DID_ERROR <<16 );scsi_done (cmd); -err_mem:return 0 ; - -defer: -ata_qc_free (qc); -if (rc ==ATA_DEFER_LINK ) -return SCSI_MLQUEUE_DEVICE_BUSY ; -else -return SCSI_MLQUEUE_HOST_BUSY ; }/**
Signature · 1 line
2.52.0
Re: [PATCH v2 1/2] ata: libata-scsi: refactor ata_scsi_translate()
Quoted 18 lines
drivers/ata/libata-scsi.c +4
-2+} +/** * ata_scsi_translate - Translate then issue SCSI command to ATA device * @dev: ATA device to which the command is addressed @@ -1714,8 +1738,8 @@ static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)* spin_lock_irqsave(host lock) * * RETURNS: -* 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command -* needs to be deferred. +* 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY or SCSI_MLQUEUE_HOST_BUSY if the +* command needs to be deferred. */ static int ata_scsi_translate (struct ata_device *dev,struct scsi_cmnd *cmd,ata_xlat_func_t xlat_func)
drivers/ata/libata-scsi.c static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd, · line 1755
Quoted 8 lines
drivers/ata/libata-scsi.c +5
-0@@ -1724,56 +1748,46 @@ static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,struct ata_queued_cmd *qc;int rc; +lockdep_assert_held (ap->lock); + +/* +* If we fail to allocate a qc, simply return without reporting an error +* as scsi_done(cmd) is already called.
nit: I find the wording a bit vague here, specifically "scsi_done(cmd) is already called". Can we explicitly mention that ata_scsi_qc_new() would have called scsi_done() with an error (when we fail to allocate the qc)?
Damien Le Moal
maintainerPATCH v2 2/2 ata: libata-scsi: avoid passthrough command starvation
In reply to Damien Le MoalWhen a non-NCQ passthrough command is issued while NCQ commands are being executed, ata_scsi_defer() indicates to ata_scsi_translate() that ata_qc_issue() should not be called for the passthrough command, and instead returns SCSI_MLQUEUE_XXX_BUSY to defer the command execution. This command deferring is correct and as mandated by the ACS specifications since NCQ and non-NCQ commands cannot be mixed.
However, in the case of a host adapter using multiple submission queues, when the target device is under a constant load of NCQ read or write commands, there are no guarantees that requeueing the non-NCQ command will lead to it not being deferred again repeatedly, since other submission queues can constantly issue NCQ commands from different CPUs ahead of the non-NCQ command. This can lead to very long delays for the execution of non-NCQ passthrough commands, and even complete starvation in the worst case scenario.
Since the block layer and the SCSI layer do not distinguish between queuable (NCQ) and non queueable (non-NCQ) commands, libata-scsi SAT implementation must ensure forward progress for non-NCQ commands in the presence of NCQ command traffic. This is similar to what SAS HBAs with a hardware/firmware based implementation do.
Implement such forward progress guarantee by limiting requeueing of non-NCQ commands: when a non-NCQ command is received and NCQ commands are in-flight, do not force a requeue of the non-NCQ command by returning SCSI_MLQUEUE_XXX_BUSY in ata_scsi_translate() and instead hold on to the qc using the new deferred_qc field of struct ata_port.
This deferred qc will be issued using the work item deferred_qc_work running the function ata_scsi_deferred_qc_work() once all in-flight commands complete, which is checked with the port qc_defer() callback indicating that no further delay is necessary. This check is done using the helper function ata_scsi_schedule_deferred_qc() which is called from ata_scsi_qc_complete(). This thus excludes this mechanism from all internal non-NCQ commands issued by ATA EH.
When a port deferred_qc is non NULL, that is, the port has a command waiting for the device queue to drain, the issuing of all incoming commands (both NCQ and non-NCQ) is deferred using the regular busy mechanism. This simplifies the code and also avoids potential denial of service problems if a user issues too many non-NCQ passthrough commands.
Finally, whenever ata EH is scheduled, regardless of the reason, a deferred qc is always requeued so that it can be retried once EH completes. This is done by calling the function ata_scsi_requeue_deferred_qc() from ata_eh_set_pending(). This avoids the need for any special processing for the deferred qc in case of NCQ error, link or device reset, or device timeout.
--- drivers/ata/libata-core.c | 1 + drivers/ata/libata-eh.c | 6 +++ drivers/ata/libata-scsi.c | 95 ++++++++++++++++++++++++++++++++++++++- drivers/ata/libata.h | 2 + include/linux/libata.h | 3 ++ 5 files changed, 106 insertions(+), 1 deletion(-)
drivers/ata/libata-core.c +1 -0
@@ -5558,6 +5558,7 @@ struct ata_port *ata_port_alloc(struct ata_host *host)mutex_init (&ap->scsi_scan_mutex);INIT_DELAYED_WORK (&ap->hotplug_task, ata_scsi_hotplug);INIT_DELAYED_WORK (&ap->scsi_rescan_task, ata_scsi_dev_rescan); +INIT_WORK (&ap->deferred_qc_work, ata_scsi_deferred_qc_work);INIT_LIST_HEAD (&ap->eh_done_q);init_waitqueue_head (&ap->eh_wait_q);init_completion (&ap->park_req_pending);
drivers/ata/libata-eh.c +6 -0
@@ -917,6 +917,12 @@ static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain) ap->pflags |=ATA_PFLAG_EH_PENDING ; +/* +* If we have a deferred qc, requeue it so that it is retried once EH +* completes. +*/ +ata_scsi_requeue_deferred_qc (ap); +if (!fastdrain)return ;
drivers/ata/libata-scsi.c +94 -1
128 lines not on this page · raw message
drivers/ata/libata.h +2 -0
@@ -165,6 +165,8 @@ void ata_scsi_sdev_config(struct scsi_device *sdev);int ata_scsi_dev_config (struct scsi_device *sdev,struct queue_limits *lim,struct ata_device *dev);int __ata_scsi_queuecmd (struct scsi_cmnd *scmd,struct ata_device *dev); +void ata_scsi_deferred_qc_work (struct work_struct *work); +void ata_scsi_requeue_deferred_qc (struct ata_port *ap);/* libata-eh.c */ extern unsigned int ata_internal_cmd_timeout (struct ata_device *dev,u8 cmd);
include/linux/libata.h +3 -0
@@ -903,6 +903,9 @@ struct ata_port {u64 qc_active;int nr_active_links;/* #links with active qcs */ +struct work_struct deferred_qc_work; +struct ata_queued_cmd *deferred_qc; +struct ata_link link;/* host default link */ struct ata_link *slave_link;/* see ata_slave_link_init() */
Signature · 1 line
2.52.0
Re: [PATCH v2 2/2] ata: libata-scsi: avoid passthrough command starvation
drivers/ata/libata-eh.c static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain) · line 921
Quoted 12 lines
init_waitqueue_head(&ap->eh_wait_q); init_completion(&ap->park_req_pending);drivers/ata/libata-eh.c +2
-0@@ -917,6 +917,12 @@ static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain) ap->pflags |=ATA_PFLAG_EH_PENDING ; +/* +* If we have a deferred qc, requeue it so that it is retried once EH
big nitpick: qc or QC? It seems quite inconsistent.
Quoted 32 lines
drivers/ata/libata-eh.c +4
-0+* completes. +*/ +ata_scsi_requeue_deferred_qc (ap); +if (!fastdrain)return ;drivers/ata/libata-scsi.c +17
-0@@ -1658,8 +1658,75 @@ static void ata_qc_done(struct ata_queued_cmd *qc)done (cmd); } +void ata_scsi_deferred_qc_work (struct work_struct *work) +{ +struct ata_port *ap = + container_of(work, struct ata_port, deferred_qc_work); +struct ata_queued_cmd *qc; +unsigned long flags; + +spin_lock_irqsave (ap->lock, flags); + +/* +* If we still have a deferred QC and we are not in EH, issue it. In +* such case, we should not need any more deferring the QC, so warn if +* qc_defer() says otherwise. +*/ + qc = ap->deferred_qc; +if (qc && !ata_port_eh_scheduled (ap)) { +WARN_ON_ONCE (ap->ops->qc_defer (qc));
drivers/ata/libata-scsi.c static void ata_qc_done(struct ata_queued_cmd *qc) · line 1687
Quoted 10 lines
drivers/ata/libata-scsi.c +10
-0+ ap->deferred_qc =NULL ; +ata_qc_issue (qc); + } + +spin_unlock_irqrestore (ap->lock, flags); +} + +void ata_scsi_requeue_deferred_qc (struct ata_port *ap) +{ +struct ata_queued_cmd *qc = ap->deferred_qc;
I think that you can just return early for !qc, no need to always be doing the lockdep_assert_held check. However, lockdep is slow anyway and I don't think that lockdep_assert_held does anything when lockdep is disabled (so returning early does not nothing, apart from reduce indentation).
drivers/ata/libata-scsi.c static void ata_qc_done(struct ata_queued_cmd *qc) · line 1692
Quoted 5 lines
drivers/ata/libata-scsi.c +5
-0+ +lockdep_assert_held (ap->lock); + +/* +* If we have a differed QC when a reset occurs or NCQ commands fail, do
deferred
Quoted 5 lines
drivers/ata/libata-scsi.c +5
-0+* not try to be smart about what to do with this deferred command and +* simply retry it by completing it with DID_SOFT_ERROR. +*/ +if (qc) { +struct scsi_cmnd *scmd = qc->scsicmd;
drivers/ata/libata-scsi.c static void ata_qc_done(struct ata_queued_cmd *qc) · line 1707
Quoted 10 lines
drivers/ata/libata-scsi.c +10
-0+ + ap->deferred_qc =NULL ; +ata_qc_free (qc); + scmd->result = (DID_SOFT_ERROR <<16 ); +scsi_done (scmd); + } +} + +static void ata_scsi_schedule_deferred_qc (struct ata_port *ap) +{
Same comment as for ata_scsi_requeue_deferred_qc (which may have not value)
Quoted 34 lines
drivers/ata/libata-scsi.c +22
-0+struct ata_queued_cmd *qc = ap->deferred_qc; + +lockdep_assert_held (ap->lock); + +/* +* If we have a differed QC, then qc_defer() is defined and we can use +* this callback to determine if this QC is good to go, unless EH has +* been scheduled. +*/ +if (qc) { +if (ata_port_eh_scheduled (ap)) { +ata_scsi_requeue_deferred_qc (ap); +return ; + } +if (!ap->ops->qc_defer (qc)) +queue_work (system_highpri_wq, &ap->deferred_qc_work); + } +} +static void ata_scsi_qc_complete (struct ata_queued_cmd *qc) { +struct ata_port *ap = qc->ap;struct scsi_cmnd *cmd = qc->scsicmd;u8 *cdb = cmd->cmnd;bool have_sense = qc->flags &ATA_QCFLAG_SENSE_VALID ;@@ -1689,12 +1756,24 @@ static void ata_scsi_qc_complete(struct ata_queued_cmd *qc) }ata_qc_done (qc); + +ata_scsi_schedule_deferred_qc (ap); }static int ata_scsi_defer (struct ata_port *ap,struct ata_queued_cmd *qc)
drivers/ata/libata-scsi.c static void ata_scsi_qc_complete(struct ata_queued_cmd *qc) · line 1773
Quoted 10 lines
drivers/ata/libata-scsi.c +7
-0{int ret; +/* +* If we already have a deferred QC, then rely on the SCSI layer to +* defer and requeue all incoming commands until the deferred QC is +* processed, once all on-going commands are completed. +*/ +if (ap->deferred_qc) { +ata_qc_free (qc);
Would adding WARN_ON_ONCE(ap->deferred_qc == qc) be totally unnecessary?
Quoted 64 lines
drivers/ata/libata-scsi.c +18
-1+return SCSI_MLQUEUE_DEVICE_BUSY ; + } +if (!ap->ops->qc_defer)return 0 ;@@ -1702,6 +1781,17 @@ static int ata_scsi_defer(struct ata_port *ap, struct ata_queued_cmd *qc)if (!ret)return 0 ; +/* +* We must defer this QC: if this is not an NCQ command, keep this QC +* as a deferred one and wait for all on-going NCQ commands to complete +* before issuing it with the deferred QC work. +*/ +if (!ata_is_ncq (qc->tf.protocol)) { + ap->deferred_qc = qc; +return SCSI_MLQUEUE_DEVICE_BUSY ; + } + +/* Use the SCSI layer to defer and requeue the command. */ ata_qc_free (qc);switch (ret) {@@ -1777,8 +1867,11 @@ static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd, goto done; rc =ata_scsi_defer (ap, qc); -if (rc) +if (rc) { +if (qc == ap->deferred_qc) +return 0 ;return rc; + }ata_qc_issue (qc);drivers/ata/libata.h +2
-0@@ -165,6 +165,8 @@ void ata_scsi_sdev_config(struct scsi_device *sdev);int ata_scsi_dev_config (struct scsi_device *sdev,struct queue_limits *lim,struct ata_device *dev);int __ata_scsi_queuecmd (struct scsi_cmnd *scmd,struct ata_device *dev); +void ata_scsi_deferred_qc_work (struct work_struct *work); +void ata_scsi_requeue_deferred_qc (struct ata_port *ap);/* libata-eh.c */ extern unsigned int ata_internal_cmd_timeout (struct ata_device *dev,u8 cmd);include/linux/libata.h +3
-0@@ -903,6 +903,9 @@ struct ata_port {u64 qc_active;int nr_active_links;/* #links with active qcs */ +struct work_struct deferred_qc_work; +struct ata_queued_cmd *deferred_qc; +struct ata_link link;/* host default link */ struct ata_link *slave_link;/* see ata_slave_link_init() */
Damien Le Moal
maintainerRe: [PATCH v2 2/2] ata: libata-scsi: avoid passthrough command starvation
Quoted 8 lines · John Garry
Quoted 8 lines
init_waitqueue_head(&ap->eh_wait_q); init_completion(&ap->park_req_pending);drivers/ata/libata-eh.c +0
-0@@ -917,6 +917,12 @@ static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain)
Quoted 6 lines
drivers/ata/libata-eh.c static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain) · line 921
Quoted 4 lines
drivers/ata/libata-eh.c +2
-0ap->pflags |=ATA_PFLAG_EH_PENDING ; +/* +* If we have a deferred qc, requeue it so that it is retried once EH big nitpick: qc or QC? It seems quite inconsistent.
Yeah. "qc" I think, as that is what is being used most often. libata-eh has a couple of "QC" in a comment though.
Quoted 9 lines
drivers/ata/libata-eh.c static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain) · line 924
Quoted 3 lines
drivers/ata/libata-eh.c +3
-0+void ata_scsi_requeue_deferred_qc (struct ata_port *ap) +{ +struct ata_queued_cmd *qc = ap->deferred_qc;I think that you can just return early for !qc, no need to always be doing the
lockdep_assert_heldcheck. However, lockdep is slow anyway and I don't think thatlockdep_assert_helddoes anything when lockdep is disabled (so returning early does not nothing, apart from reduce indentation).
OK for the return early. Bu even for that case, we should have the lockdep annotation since we are not supposed to be looking at ap->deferred_qc without holding the port lock. But granted, the lockdep assert may be overkill. Let me check if we really need/want it.
Quoted 4 lines
Quoted 4 lines
drivers/ata/libata-eh.c +0
-0static int ata_scsi_defer (struct ata_port *ap,struct ata_queued_cmd *qc) {int ret;
Quoted 9 lines
drivers/ata/libata-eh.c static void ata_eh_set_pending(struct ata_port *ap, bool fastdrain)
Quoted 7 lines
drivers/ata/libata-eh.c +7
-0+/* +* If we already have a deferred QC, then rely on the SCSI layer to +* defer and requeue all incoming commands until the deferred QC is +* processed, once all on-going commands are completed. +*/ +if (ap->deferred_qc) { +ata_qc_free (qc);Would adding
WARN_ON_ONCE(ap->deferred_qc == qc)be totally unnecessary?
If such warning trigger, I think things would be really very broken, and likely all sorts of failures/hangs would already be happening. Talking from experience here as the initial versions of this patch where less than perfect :)
Signature · 2 lines
Damien Le Moal Western Digital Research