Skip to contentSkip to conversation

don't drop the queue reference in blk_mq_destroy_queue

PATCH In review Christoph Hellwig 7 participants 20 messages Oct 18, 2022 – Oct 25, 2022

Subsystems (5)
lore
Share & tools
lore

Christoph Hellwig

author maintainer
#0 lore raw

Hi all,

currently blk_mq_destroy_queue not only shuts down the queue, but also drops a queue references, which leads to the NVMe PCIe/Apple drivers and scsi grabbing an extra references. Fix this to help with unifying more code between the various NVMe drivers (and to make the code a little saner even on it's own).

Diffstat:

 block/blk-mq.c            |    4 +---
 block/bsg-lib.c           |    2 ++
 drivers/nvme/host/apple.c |    8 --------
 drivers/nvme/host/core.c  |   10 ++++++++--
 drivers/nvme/host/pci.c   |    5 -----
 drivers/scsi/scsi_scan.c  |    1 -
 drivers/ufs/core/ufshcd.c |    2 ++
 7 files changed, 13 insertions(+), 19 deletions(-)
author maintainer
#1 lore raw

PATCH 1/4 blk-mq: move the call to blk_put_queue out of blk_mq_destroy_queue

The fact that blk_mq_destroy_queue also drops a queue reference leads to various places having to grab an extra reference. Move the call to blk_put_queue into the callers to allow removing the extra references.

---
 block/blk-mq.c            |  4 +---
 block/bsg-lib.c           |  2 ++
 drivers/nvme/host/apple.c |  1 +
 drivers/nvme/host/core.c  | 10 ++++++++--
 drivers/nvme/host/pci.c   |  1 +
 drivers/scsi/scsi_sysfs.c |  1 +
 drivers/ufs/core/ufshcd.c |  2 ++
 7 files changed, 16 insertions(+), 5 deletions(-)
block/blk-mq.c +1 -3
index 8070b6c10e8d5..ee644444e0f33 100644
@@ -4007,9 +4007,6 @@ void blk_mq_destroy_queue(struct request_queue *q)
 	blk_sync_queue(q);
 	blk_mq_cancel_work_sync(q);
 	blk_mq_exit_queue(q);
-
-	/* @q is and will stay empty, shutdown and put */
-	blk_put_queue(q);
 }
 EXPORT_SYMBOL(blk_mq_destroy_queue);
 
@@ -4026,6 +4023,7 @@ struct gendisk *__blk_mq_alloc_disk(struct blk_mq_tag_set *set, void *queuedata,
 	disk = __alloc_disk_node(q, set->numa_node, lkclass);
 	if (!disk) {
 		blk_mq_destroy_queue(q);
+		blk_put_queue(q);
 		return ERR_PTR(-ENOMEM);
 	}
 	set_bit(GD_OWNS_QUEUE, &disk->state);
block/bsg-lib.c +2 -0
index d6f5dcdce748c..435c32373cd68 100644
@@ -325,6 +325,7 @@ void bsg_remove_queue(struct request_queue *q)
 
 		bsg_unregister_queue(bset->bd);
 		blk_mq_destroy_queue(q);
+		blk_put_queue(q);
 		blk_mq_free_tag_set(&bset->tag_set);
 		kfree(bset);
 	}
@@ -400,6 +401,7 @@ struct request_queue *bsg_setup_queue(struct device *dev, const char *name,
 	return q;
 out_cleanup_queue:
 	blk_mq_destroy_queue(q);
+	blk_put_queue(q);
 out_queue:
 	blk_mq_free_tag_set(set);
 out_tag_set:
drivers/nvme/host/apple.c +1 -0
index 5fc5ea196b400..42b17439dfd57 100644
@@ -1508,6 +1508,7 @@ static int apple_nvme_probe(struct platform_device *pdev)
 	if (!blk_get_queue(anv->ctrl.admin_q)) {
 		nvme_start_admin_queue(&anv->ctrl);
 		blk_mq_destroy_queue(anv->ctrl.admin_q);
+		blk_put_queue(anv->ctrl.admin_q);
 		anv->ctrl.admin_q = NULL;
 		ret = -ENODEV;
 		goto put_dev;
drivers/nvme/host/core.c +8 -2
index 059737c1a2c19..07381673170b9 100644
@@ -4847,6 +4847,7 @@ int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
 
 out_cleanup_admin_q:
 	blk_mq_destroy_queue(ctrl->fabrics_q);
+	blk_put_queue(ctrl->fabrics_q);
 out_free_tagset:
 	blk_mq_free_tag_set(ctrl->admin_tagset);
 	return ret;
@@ -4856,8 +4857,11 @@ EXPORT_SYMBOL_GPL(nvme_alloc_admin_tag_set);
 void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl)
 {
 	blk_mq_destroy_queue(ctrl->admin_q);
-	if (ctrl->ops->flags & NVME_F_FABRICS)
+	blk_put_queue(ctrl->admin_q);
+	if (ctrl->ops->flags & NVME_F_FABRICS) {
 		blk_mq_destroy_queue(ctrl->fabrics_q);
+		blk_put_queue(ctrl->fabrics_q);
+	}
 	blk_mq_free_tag_set(ctrl->admin_tagset);
 }
 EXPORT_SYMBOL_GPL(nvme_remove_admin_tag_set);
@@ -4903,8 +4907,10 @@ EXPORT_SYMBOL_GPL(nvme_alloc_io_tag_set);
 
 void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl)
 {
-	if (ctrl->ops->flags & NVME_F_FABRICS)
+	if (ctrl->ops->flags & NVME_F_FABRICS) {
 		blk_mq_destroy_queue(ctrl->connect_q);
+		blk_put_queue(ctrl->connect_q);
+	}
 	blk_mq_free_tag_set(ctrl->tagset);
 }
 EXPORT_SYMBOL_GPL(nvme_remove_io_tag_set);
drivers/nvme/host/pci.c +1 -0
index bcbef6bc5672f..16509b8d92e59 100644
@@ -1749,6 +1749,7 @@ static void nvme_dev_remove_admin(struct nvme_dev *dev)
 		 */
 		nvme_start_admin_queue(&dev->ctrl);
 		blk_mq_destroy_queue(dev->ctrl.admin_q);
+		blk_put_queue(dev->ctrl.admin_q);
 		blk_mq_free_tag_set(&dev->admin_tagset);
 	}
 }
drivers/scsi/scsi_sysfs.c +1 -0
index c95177ca6ed26..1214c6f07bc64 100644
@@ -1478,6 +1478,7 @@ void __scsi_remove_device(struct scsi_device *sdev)
 	mutex_unlock(&sdev->state_mutex);
 
 	blk_mq_destroy_queue(sdev->request_queue);
+	blk_put_queue(sdev->request_queue);
 	kref_put(&sdev->host->tagset_refcnt, scsi_mq_free_tags);
 	cancel_work_sync(&sdev->requeue_work);
 
drivers/ufs/core/ufshcd.c +2 -0
index 7256e6c43ca68..8ee0ac168ff2b 100644
@@ -9544,6 +9544,7 @@ void ufshcd_remove(struct ufs_hba *hba)
 	ufshpb_remove(hba);
 	ufs_sysfs_remove_nodes(hba->dev);
 	blk_mq_destroy_queue(hba->tmf_queue);
+	blk_put_queue(hba->tmf_queue);
 	blk_mq_free_tag_set(&hba->tmf_tag_set);
 	scsi_remove_host(hba->host);
 	/* disable interrupts */
@@ -9840,6 +9841,7 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
 
 free_tmf_queue:
 	blk_mq_destroy_queue(hba->tmf_queue);
+	blk_put_queue(hba->tmf_queue);
 free_tmf_tag_set:
 	blk_mq_free_tag_set(&hba->tmf_tag_set);
 out_remove_scsi_host:
Signature · 1 line
2.30.2
Reviewed-by on v1 1/4
#2 lore raw

Re: [PATCH 1/4] blk-mq: move the call to blk_put_queue out of blk_mq_destroy_queue

Quoted 5 lines · Christoph Hellwig

The fact that blk_mq_destroy_queue also drops a queue reference leads to various places having to grab an extra reference. Move the call to blk_put_queue into the callers to allow removing the extra references.

Makes sense.

-ck

maintainer
#4 lore raw

Re: [PATCH 1/4] blk-mq: move the call to blk_put_queue out of blk_mq_destroy_queue

In reply to Christoph Hellwig

drivers/nvme/host/core.c int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, · line 4853

Quoted 12 lines
drivers/nvme/host/core.c +1 -0
index 059737c1a2c19..07381673170b9 100644
@@ -4847,6 +4847,7 @@ int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
 
 out_cleanup_admin_q:
 	blk_mq_destroy_queue(ctrl->fabrics_q);
+	blk_put_queue(ctrl->fabrics_q);
 out_free_tagset:
 	blk_mq_free_tag_set(ctrl->admin_tagset);
 	return ret;

This is wrong and doesn't apply because it got fixed upstream:

commit 4739824e2d7878dcea88397a6758e31e3c5c124e

Author: Dan Carpenter <[email protected]>
Date:   Sat Oct 15 11:25:56 2022 +0300

nvme: fix error pointer dereference in error handling

Can you respin this series so we can get it applied?

Signature · 1 line
Jens Axboe
maintainer
#5 lore raw

Re: [PATCH 1/4] blk-mq: move the call to blk_put_queue out of blk_mq_destroy_queue

Quoted 14 lines · Jens Axboe

drivers/nvme/host/core.c int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, · line 4853

Quoted 12 lines
drivers/nvme/host/core.c +1 -0
index 059737c1a2c19..07381673170b9 100644
@@ -4847,6 +4847,7 @@ int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
 
 out_cleanup_admin_q:
 	blk_mq_destroy_queue(ctrl->fabrics_q);
+	blk_put_queue(ctrl->fabrics_q);
 out_free_tagset:
 	blk_mq_free_tag_set(ctrl->admin_tagset);
 	return ret;

This is wrong and doesn't apply because it got fixed upstream:

Quoted 7 lines

commit 4739824e2d7878dcea88397a6758e31e3c5c124e

Author: Dan Carpenter <[email protected]>
Date:   Sat Oct 15 11:25:56 2022 +0300

nvme: fix error pointer dereference in error handling

Can you respin this series so we can get it applied?

I just made the trivial edit in the patch itself, rest was fine.

Signature · 1 line
Jens Axboe
author maintainer
#6 lore raw

PATCH 2/4 scsi: remove an extra queue reference

In reply to Christoph Hellwig

Now that blk_mq_destroy_queue does not release the queue reference, there is no need for a second queue reference to be held by the scsi_device.

---
 drivers/scsi/scsi_scan.c  | 1 -
 drivers/scsi/scsi_sysfs.c | 1 -
 2 files changed, 2 deletions(-)
drivers/scsi/scsi_scan.c +0 -1
index 5d27f5196de6f..0a95fa787fdf4 100644
@@ -344,7 +344,6 @@ static struct scsi_device *scsi_alloc_sdev(struct scsi_target *starget,
 	sdev->request_queue = q;
 	q->queuedata = sdev;
 	__scsi_init_queue(sdev->host, q);
-	WARN_ON_ONCE(!blk_get_queue(q));
 
 	depth = sdev->host->cmd_per_lun ?: 1;
 
drivers/scsi/scsi_sysfs.c +0 -1
index 1214c6f07bc64..c95177ca6ed26 100644
@@ -1478,7 +1478,6 @@ void __scsi_remove_device(struct scsi_device *sdev)
 	mutex_unlock(&sdev->state_mutex);
 
 	blk_mq_destroy_queue(sdev->request_queue);
-	blk_put_queue(sdev->request_queue);
 	kref_put(&sdev->host->tagset_refcnt, scsi_mq_free_tags);
 	cancel_work_sync(&sdev->requeue_work);
 
Signature · 1 line
2.30.2
#8 lore raw

Re: [PATCH 2/4] scsi: remove an extra queue reference

In reply to Christoph Hellwig
Quoted 26 lines · Christoph Hellwig

Now that blk_mq_destroy_queue does not release the queue reference, there is no need for a second queue reference to be held by the scsi_device.

---
 drivers/scsi/scsi_scan.c  | 1 -
 drivers/scsi/scsi_sysfs.c | 1 -
 2 files changed, 2 deletions(-)
drivers/scsi/scsi_scan.c +0 -1
index 5d27f5196de6f..0a95fa787fdf4 100644
@@ -344,7 +344,6 @@ static struct scsi_device *scsi_alloc_sdev(struct scsi_target *starget,
 	sdev->request_queue = q;
 	q->queuedata = sdev;
 	__scsi_init_queue(sdev->host, q);
-	WARN_ON_ONCE(!blk_get_queue(q));
 
 	depth = sdev->host->cmd_per_lun ?: 1;
 
drivers/scsi/scsi_sysfs.c +0 -0
index 1214c6f07bc64..c95177ca6ed26 100644

drivers/scsi/scsi_sysfs.c void __scsi_remove_device(struct scsi_device *sdev) · line 1481

Quoted 4 lines
drivers/scsi/scsi_sysfs.c +0 -1
@@ -1478,7 +1478,6 @@ void __scsi_remove_device(struct scsi_device *sdev)
 	mutex_unlock(&sdev->state_mutex);
 
 	blk_mq_destroy_queue(sdev->request_queue);
-	blk_put_queue(sdev->request_queue);

The above put is counter-pair of blk_get_queue() in scsi_alloc_sdev, and the original blk_put_queue() in blk_mq_destroy_queue() is counter-pair of the initial get in blk_alloc_queue().

Now blk_put_queue() is moved out of blk_mq_destroy_queue(), I am wondering how the scsi queue lifetime can work correctly with this patch? Or is there bug in current scsi code?

Thanks,
Ming

#9 lore raw

Re: [PATCH 2/4] scsi: remove an extra queue reference

Quoted 36 lines · Ming Lei
Quoted 26 lines · Christoph Hellwig

Now that blk_mq_destroy_queue does not release the queue reference, there is no need for a second queue reference to be held by the scsi_device.

---
 drivers/scsi/scsi_scan.c  | 1 -
 drivers/scsi/scsi_sysfs.c | 1 -
 2 files changed, 2 deletions(-)
drivers/scsi/scsi_scan.c +0 -1
index 5d27f5196de6f..0a95fa787fdf4 100644
@@ -344,7 +344,6 @@ static struct scsi_device *scsi_alloc_sdev(struct scsi_target *starget,
 	sdev->request_queue = q;
 	q->queuedata = sdev;
 	__scsi_init_queue(sdev->host, q);
-	WARN_ON_ONCE(!blk_get_queue(q));
 
 	depth = sdev->host->cmd_per_lun ?: 1;
 
drivers/scsi/scsi_sysfs.c +0 -0
index 1214c6f07bc64..c95177ca6ed26 100644

drivers/scsi/scsi_sysfs.c void __scsi_remove_device(struct scsi_device *sdev) · line 1481

Quoted 4 lines
drivers/scsi/scsi_sysfs.c +0 -1
@@ -1478,7 +1478,6 @@ void __scsi_remove_device(struct scsi_device *sdev)
 	mutex_unlock(&sdev->state_mutex);
 
 	blk_mq_destroy_queue(sdev->request_queue);
-	blk_put_queue(sdev->request_queue);

The above put is counter-pair of blk_get_queue() in scsi_alloc_sdev, and the original blk_put_queue() in blk_mq_destroy_queue() is counter-pair of the initial get in blk_alloc_queue().

Quoted 3 lines

Now blk_put_queue() is moved out of blk_mq_destroy_queue(), I am wondering how the scsi queue lifetime can work correctly with this patch? Or is there bug in current scsi code?

oops, the above blk_put_queue() is actually added in the 1st patch, so this patch is fine, sorry for the noise.

thanks,
Ming

author maintainer
#11 lore raw

PATCH 3/4 nvme-pci: remove an extra queue reference

In reply to Christoph Hellwig

Now that blk_mq_destroy_queue does not release the queue reference, there is no need for a second admin queue reference to be held by the nvme_dev.

---
 drivers/nvme/host/pci.c | 6 ------
 1 file changed, 6 deletions(-)
drivers/nvme/host/pci.c +0 -6
index 16509b8d92e59..efea468a2a5bb 100644
@@ -1749,7 +1749,6 @@ static void nvme_dev_remove_admin(struct nvme_dev *dev)
 		 */
 		nvme_start_admin_queue(&dev->ctrl);
 		blk_mq_destroy_queue(dev->ctrl.admin_q);
-		blk_put_queue(dev->ctrl.admin_q);
 		blk_mq_free_tag_set(&dev->admin_tagset);
 	}
 }
@@ -1778,11 +1777,6 @@ static int nvme_pci_alloc_admin_tag_set(struct nvme_dev *dev)
 		dev->ctrl.admin_q = NULL;
 		return -ENOMEM;
 	}
-	if (!blk_get_queue(dev->ctrl.admin_q)) {
-		nvme_dev_remove_admin(dev);
-		dev->ctrl.admin_q = NULL;
-		return -ENODEV;
-	}
 	return 0;
 }
 
Signature · 1 line
2.30.2
author maintainer
#14 lore raw

PATCH 4/4 nvme-apple: remove an extra queue reference

In reply to Christoph Hellwig

Now that blk_mq_destroy_queue does not release the queue reference, there is no need for a second admin queue reference to be held by the apple_nvme structure.

---
 drivers/nvme/host/apple.c | 9 ---------
 1 file changed, 9 deletions(-)
drivers/nvme/host/apple.c +0 -9
index 42b17439dfd57..fe7f0444a8e46 100644
@@ -1505,15 +1505,6 @@ static int apple_nvme_probe(struct platform_device *pdev)
 		goto put_dev;
 	}
 
-	if (!blk_get_queue(anv->ctrl.admin_q)) {
-		nvme_start_admin_queue(&anv->ctrl);
-		blk_mq_destroy_queue(anv->ctrl.admin_q);
-		blk_put_queue(anv->ctrl.admin_q);
-		anv->ctrl.admin_q = NULL;
-		ret = -ENODEV;
-		goto put_dev;
-	}
-
 	nvme_reset_ctrl(&anv->ctrl);
 	async_schedule(apple_nvme_async_probe, anv);
 
Signature · 1 line
2.30.2
maintainer Applied
#19 lore raw
In reply to Christoph Hellwig
Quoted 16 lines · Christoph Hellwig

currently blk_mq_destroy_queue not only shuts down the queue, but also drops a queue references, which leads to the NVMe PCIe/Apple drivers and scsi grabbing an extra references. Fix this to help with unifying more code between the various NVMe drivers (and to make the code a little saner even on it's own).

Diffstat:

 block/blk-mq.c            |    4 +---
 block/bsg-lib.c           |    2 ++
 drivers/nvme/host/apple.c |    8 --------
 drivers/nvme/host/core.c  |   10 ++++++++--
 drivers/nvme/host/pci.c   |    5 -----
 drivers/scsi/scsi_scan.c  |    1 -
 drivers/ufs/core/ufshcd.c |    2 ++
 7 files changed, 13 insertions(+), 19 deletions(-)
Quoted 1 line

[...]

Applied, thanks!

[1/4] blk-mq: move the call to blk_put_queue out of blk_mq_destroy_queue

      commit: 2b3f056f72e56fa07df69b4705e0b46a6c08e77c
[2/4] scsi: remove an extra queue reference
      commit: dc917c361422388f0d39d3f0dc2bc5a188c01156
[3/4] nvme-pci: remove an extra queue reference
      commit: 7dcebef90d35de13a326f765dd787538880566f9
[4/4] nvme-apple: remove an extra queue reference
      commit: 941f7298c70c7668416e7845fa76eb72c07d966b

Best regards,

Signature · 1 line
Jens Axboe