ata: Annotate functions in the issuing path with __must_hold()

Annotate the following functions used in the issuing path:
ata_qc_issue(), ata_sas_queuecmd(), ata_scsi_qc_issue(),
ata_scsi_translate(), __ata_scsi_queuecmd()

These functions are all used in the issuing path, so context analysis will
be able to verify that the ap lock is held, from it is taken in
sas_queuecommand() or ata_scsi_queuecmd() all the way down to
ata_qc_issue().

Commenting out the spin_lock_irqsave() successfully results in a compiler
error on Clang 23.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Co-developed-by: Niklas Cassel <cassel@kernel.org>
Reviewed-by: Hannes Reinecke <hare@kernel.org>
Signed-off-by: Niklas Cassel <cassel@kernel.org>

diff --git a/drivers/ata/libata-core.c b/drivers/ata/libata-core.c
index 938e95138a8f518ec83fa4e5c279cc491a483eba..3b6243f0f91e74397f62f7c01dd24eb9651c34c0 100644 (file)
--- a/drivers/ata/libata-core.c
+++ b/drivers/ata/libata-core.c
@@ -5162,6 +5162,7 @@ EXPORT_SYMBOL_GPL(ata_qc_get_active);
  *     spin_lock_irqsave(host lock)
  */
 void ata_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc)
+       __must_hold(ap->lock)
 {
        struct ata_link *link = qc->dev->link;
        u8 prot = qc->tf.protocol;

diff --git a/drivers/ata/libata-sata.c b/drivers/ata/libata-sata.c
index 5e5be6bbf32ad2265121a6f0cefd9b007a6e7f10..b0706c30da052c9e8b4bd0bdb107a8778cafd482 100644 (file)
--- a/drivers/ata/libata-sata.c
+++ b/drivers/ata/libata-sata.c
@@ -1377,6 +1377,7 @@ EXPORT_SYMBOL_GPL(ata_sas_sdev_configure);
  */
 
 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
+       __must_hold(ap->lock)
 {
        if (likely(ata_dev_enabled(ap->link.device)))
                return __ata_scsi_queuecmd(cmd, ap->link.device, ap);

diff --git a/drivers/ata/libata-scsi.c b/drivers/ata/libata-scsi.c
index 0375c5c2d2f33306e3ef90841c3f6b3bb87b1943..d54ec1631e9a6325d6bb4ab4af8dc693afc226b1 100644 (file)
--- a/drivers/ata/libata-scsi.c
+++ b/drivers/ata/libata-scsi.c
@@ -1769,6 +1769,7 @@ static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
 }
 
 static int ata_scsi_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc)
+       __must_hold(ap->lock)
 {
        struct ata_link *link = qc->dev->link;
        int ret;
@@ -1864,6 +1865,7 @@ free_qc:
  */
 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
                              ata_xlat_func_t xlat_func, struct ata_port *ap)
+       __must_hold(ap->lock)
 {
        struct ata_queued_cmd *qc;
 
@@ -4523,6 +4525,7 @@ static void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
 enum scsi_qc_status __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
                                        struct ata_device *dev,
                                        struct ata_port *ap)
+       __must_hold(ap->lock)
 {
        u8 scsi_op = scmd->cmnd[0];
        ata_xlat_func_t xlat_func;

diff --git a/drivers/ata/libata.h b/drivers/ata/libata.h
index 16d0818b2b16a6cf25b14d0944ed51ed7d717e0a..0dd735c2e5b555b407a51f5330c95159f0faa01d 100644 (file)
--- a/drivers/ata/libata.h
+++ b/drivers/ata/libata.h
@@ -88,7 +88,8 @@ extern int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel);
 extern unsigned int ata_dev_set_feature(struct ata_device *dev,
                                        u8 subcmd, u8 action);
 extern void ata_qc_free(struct ata_queued_cmd *qc);
-extern void ata_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc);
+extern void ata_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc)
+       __must_hold(ap->lock);
 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
 extern int atapi_check_dma(struct ata_queued_cmd *qc);
 extern void swap_buf_le16(u16 *buf, unsigned int buf_words);
@@ -167,7 +168,8 @@ int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,
                struct ata_device *dev);
 enum scsi_qc_status __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
                                        struct ata_device *dev,
-                                       struct ata_port *ap);
+                                       struct ata_port *ap)
+       __must_hold(ap->lock);
 void ata_scsi_deferred_qc_work(struct work_struct *work);
 void ata_scsi_requeue_deferred_qc(struct ata_port *ap);
 

diff --git a/include/linux/libata.h b/include/linux/libata.h
index 7091bc903c05f9f895ce07751e5c93c41fd9ee0d..96e626d6a7cab9d3cfcf6e272c7070a8271d31bd 100644 (file)
--- a/include/linux/libata.h
+++ b/include/linux/libata.h
@@ -1315,7 +1315,8 @@ extern int ata_tport_add(struct device *parent, struct ata_port *ap);
 extern void ata_tport_delete(struct ata_port *ap);
 int ata_sas_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim,
                           struct ata_port *ap);
-extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
+extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
+       __must_hold(ap->lock);
 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
                          u8 pmp, int is_cmd, u8 *fis);
 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);