ata: libata: cancel pending work after clearing deferred_qc
Niklas Cassel
maintainerPATCH 1/1 ata: libata: cancel pending work after clearing deferred_qc
Syzbot reported a WARN_ON() in ata_scsi_deferred_qc_work(), caused by ap->ops->qc_defer() returning non-zero before issuing the deferred qc.
ata_scsi_schedule_deferred_qc() is called during each command completion. This function will check if there is a deferred QC, and if ap->ops->qc_defer() returns zero, meaning that it is possible to queue the deferred qc at this time (without being deferred), then it will queue the work which will issue the deferred qc.
Once the work get to run, which can potentially be a very long time after the work was scheduled, there is a WARN_ON() if ap->ops->qc_defer() returns non-zero.
While we hold the ap->lock both when assigning and clearing deferred_qc, and the work itself holds the ap->lock, the code currently does not cancel the work after clearing the deferred qc.
This means that the following scenario can happen:
1) One or several NCQ commands are queued.
2) A non-NCQ command is queued, gets stored in ap->deferred_qc.
3) Last NCQ command gets completed, work is queued to issue the deferred qc.
4) Timeout or error happens, ap->deferred_qc is cleared. The queued work is currently NOT canceled.
5) Port is reset.
6) One or several NCQ commands are queued.
7) A non-NCQ command is queued, gets stored in ap->deferred_qc.
8) Work is finally run. Yet at this time, there is still NCQ commands in flight.
The work in 8) really belongs to the non-NCQ command in 2), not to the non-NCQ command in 7). The reason why the work is executed when it is not supposed to, is because it was never canceled when ap->deferred_qc was cleared in 4). Thus, ensure that we always cancel the work after clearing ap->deferred_qc.
Another potential fix would have been to let ata_scsi_deferred_qc_work() do nothing if ap->ops->qc_defer() returns non-zero. However, canceling the work when clearing ap->deferred_qc seems slightly more logical, as we hold the ap->lock when clearing ap->deferred_qc, so we know that the work cannot be holding the lock. (The function could be waiting for the lock, but that is okay since it will do nothing if ap->deferred_qc is not set.)
--- drivers/ata/libata-eh.c | 1 + drivers/ata/libata-scsi.c | 1 + 2 files changed, 2 insertions(+)
drivers/ata/libata-eh.c +1 -0
@@ -659,6 +659,7 @@ void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap,*/ WARN_ON_ONCE (qc->flags &ATA_QCFLAG_ACTIVE ); ap->deferred_qc =NULL ; +cancel_work (&ap->deferred_qc_work);set_host_byte (scmd,DID_TIME_OUT );scsi_eh_finish_cmd (scmd, &ap->eh_done_q); }else if (i <ATA_MAX_QUEUE ) {
drivers/ata/libata-scsi.c +1 -0
@@ -1699,6 +1699,7 @@ void ata_scsi_requeue_deferred_qc(struct ata_port *ap) scmd = qc->scsicmd; ap->deferred_qc =NULL ; +cancel_work (&ap->deferred_qc_work);ata_qc_free (qc); scmd->result = (DID_SOFT_ERROR <<16 );scsi_done (scmd);
Signature · 1 line
2.53.0
Quoted 43 lines · Niklas Cassel
Syzbot reported a
WARN_ON()inata_scsi_deferred_qc_work(), caused byap->ops->qc_defer()returning non-zero before issuing the deferred qc.
ata_scsi_schedule_deferred_qc()is called during each command completion. This function will check if there is a deferred QC, and ifap->ops->qc_defer()returns zero, meaning that it is possible to queue the deferred qc at this time (without being deferred), then it will queue the work which will issue the deferred qc.Once the work get to run, which can potentially be a very long time after the work was scheduled, there is a
WARN_ON()ifap->ops->qc_defer()returns non-zero.While we hold the
ap->lockboth when assigning and clearingdeferred_qc, and the work itself holds theap->lock, the code currently does not cancel the work after clearing the deferred qc.This means that the following scenario can happen:
1) One or several NCQ commands are queued.
2) A non-NCQ command is queued, gets stored inap->deferred_qc.
3) Last NCQ command gets completed, work is queued to issue the deferred qc.
4) Timeout or error happens,ap->deferred_qcis cleared. The queued work is currently NOT canceled.
5) Port is reset.
6) One or several NCQ commands are queued.
7) A non-NCQ command is queued, gets stored inap->deferred_qc.
8) Work is finally run. Yet at this time, there is still NCQ commands in flight.The work in 8) really belongs to the non-NCQ command in 2), not to the non-NCQ command in 7). The reason why the work is executed when it is not supposed to, is because it was never canceled when
ap->deferred_qcwas cleared in 4). Thus, ensure that we always cancel the work after clearingap->deferred_qc.Another potential fix would have been to let
ata_scsi_deferred_qc_work()do nothing ifap->ops->qc_defer()returns non-zero. However, canceling the work when clearingap->deferred_qcseems slightly more logical, as we hold theap->lockwhen clearingap->deferred_qc, so we know that the work cannot be holding the lock. (The function could be waiting for the lock, but that is okay since it will do nothing ifap->deferred_qcis not set.)
Quoted 4 lines
Reported-by [email protected]Fixes 0ea84089dbf6 ("ata: libata-scsi: avoid Non-NCQ command starvation")Fixes eddb98ad9364 ("ata: libata-eh: correctly handle deferred qc timeouts")Signed-off-by Niklas Cassel <[email protected]>
Looks good.
Note that a followup cleanup, we may want to define a ata_scsi_cancel_deferred_qc() helper for the pattern:
ap->deferred_qc = NULL; cancel_work(&ap->deferred_qc_work);
to avoid repetitions.
Quoted 29 lines
--- drivers/ata/libata-eh.c | 1 + drivers/ata/libata-scsi.c | 1 + 2 files changed, 2 insertions(+)drivers/ata/libata-eh.c +1
-0@@ -659,6 +659,7 @@ void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap,*/ WARN_ON_ONCE (qc->flags &ATA_QCFLAG_ACTIVE ); ap->deferred_qc =NULL ; +cancel_work (&ap->deferred_qc_work);set_host_byte (scmd,DID_TIME_OUT );scsi_eh_finish_cmd (scmd, &ap->eh_done_q); }else if (i <ATA_MAX_QUEUE ) {drivers/ata/libata-scsi.c +1
-0@@ -1699,6 +1699,7 @@ void ata_scsi_requeue_deferred_qc(struct ata_port *ap) scmd = qc->scsicmd; ap->deferred_qc =NULL ; +cancel_work (&ap->deferred_qc_work);ata_qc_free (qc); scmd->result = (DID_SOFT_ERROR <<16 );scsi_done (scmd);
Signature · 2 lines
Damien Le Moal Western Digital Research
Quoted 43 lines · Niklas Cassel
Syzbot reported a
WARN_ON()inata_scsi_deferred_qc_work(), caused byap->ops->qc_defer()returning non-zero before issuing the deferred qc.
ata_scsi_schedule_deferred_qc()is called during each command completion. This function will check if there is a deferred QC, and ifap->ops->qc_defer()returns zero, meaning that it is possible to queue the deferred qc at this time (without being deferred), then it will queue the work which will issue the deferred qc.Once the work get to run, which can potentially be a very long time after the work was scheduled, there is a
WARN_ON()ifap->ops->qc_defer()returns non-zero.While we hold the
ap->lockboth when assigning and clearingdeferred_qc, and the work itself holds theap->lock, the code currently does not cancel the work after clearing the deferred qc.This means that the following scenario can happen:
1) One or several NCQ commands are queued.
2) A non-NCQ command is queued, gets stored inap->deferred_qc.
3) Last NCQ command gets completed, work is queued to issue the deferred qc.
4) Timeout or error happens,ap->deferred_qcis cleared. The queued work is currently NOT canceled.
5) Port is reset.
6) One or several NCQ commands are queued.
7) A non-NCQ command is queued, gets stored inap->deferred_qc.
8) Work is finally run. Yet at this time, there is still NCQ commands in flight.The work in 8) really belongs to the non-NCQ command in 2), not to the non-NCQ command in 7). The reason why the work is executed when it is not supposed to, is because it was never canceled when
ap->deferred_qcwas cleared in 4). Thus, ensure that we always cancel the work after clearingap->deferred_qc.Another potential fix would have been to let
ata_scsi_deferred_qc_work()do nothing ifap->ops->qc_defer()returns non-zero. However, canceling the work when clearingap->deferred_qcseems slightly more logical, as we hold theap->lockwhen clearingap->deferred_qc, so we know that the work cannot be holding the lock. (The function could be waiting for the lock, but that is okay since it will do nothing ifap->deferred_qcis not set.)
Quoted 4 lines
Reported-by [email protected]Fixes 0ea84089dbf6 ("ata: libata-scsi: avoid Non-NCQ command starvation")Fixes eddb98ad9364 ("ata: libata-eh: correctly handle deferred qc timeouts")Signed-off-by Niklas Cassel <[email protected]>
Thanks,
Igor
Quoted 10 lines · Niklas Cassel
Syzbot reported a
WARN_ON()inata_scsi_deferred_qc_work(), caused byap->ops->qc_defer()returning non-zero before issuing the deferred qc.
ata_scsi_schedule_deferred_qc()is called during each command completion. This function will check if there is a deferred QC, and ifap->ops->qc_defer()returns zero, meaning that it is possible to queue the deferred qc at this time (without being deferred), then it will queue the work which will issue the deferred qc.[...]
Applied to libata/linux.git (libata-for-7.0-fixes), thanks!
[1/1] ata: libata: cancel pending work after clearing deferred_qc
https://git.kernel.org/libata/linux/c/aac9b27f
Kind regards,
Niklas