block: second batch of add_disk() error handling conversions
Subsystems (9)
v2 cover block: second batch of add_disk() error handling conversions
This is the second series of driver conversions for add_disk() error handling. You can find this set and the rest of the 7th set of driver conversions on my 20210927-for-axboe-add-disk-error-handling branch [0].
Changes on this v2 since the last first version of this patch series:
- rebased onto linux-next tag 20210927
- nvme-multipath: used test_and_set_bit() as suggested by Keith Busch, and justified this in the code with a comment as this race was not obvious
- Added reviewed-by / Acked-by tags where one was provided
Luis Chamberlain (10):
block/brd: add error handling support for add_disk()
bcache: add error handling support for add_disk()
nvme-multipath: add error handling support for add_disk() nvdimm/btt: do not call del_gendisk() if not needed nvdimm/btt: use goto error labels on btt_blk_init() nvdimm/btt: add error handling support for add_disk() nvdimm/blk: avoid calling del_gendisk() on early failures nvdimm/blk: add error handling support for add_disk()
xen-blkfront: add error handling support for add_disk()
zram: add error handling support for add_disk()
drivers/block/brd.c | 10 ++++++++-- drivers/block/xen-blkfront.c | 8 +++++++- drivers/block/zram/zram_drv.c | 6 +++++- drivers/md/bcache/super.c | 17 ++++++++++++----- drivers/nvdimm/blk.c | 21 +++++++++++++++------ drivers/nvdimm/btt.c | 24 +++++++++++++++--------- drivers/nvme/host/multipath.c | 13 +++++++++++-- 7 files changed, 73 insertions(+), 26 deletions(-)
Signature · 1 line
2.30.2
PATCH v2 1/10 block/brd: add error handling support for add_disk()
We never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
--- drivers/block/brd.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
drivers/block/brd.c +8 -2
@@ -372,6 +372,7 @@ static int brd_alloc(int i)struct brd_device *brd;struct gendisk *disk;char buf[DISK_NAME_LEN ]; +int err = -ENOMEM ; brd =kzalloc (sizeof (*brd),GFP_KERNEL );if (!brd)
@@ -410,14 +411,19 @@ static int brd_alloc(int i)/* Tell the block layer that this is not a rotational device */ blk_queue_flag_set (QUEUE_FLAG_NONROT , disk->queue);blk_queue_flag_clear (QUEUE_FLAG_ADD_RANDOM , disk->queue); -add_disk (disk); + err =add_disk (disk); +if (err) + goto out_cleanup_disk; +list_add_tail (&brd->brd_list, &brd_devices);return 0 ; +out_cleanup_disk: +blk_cleanup_disk (disk); out_free_dev:kfree (brd); -return -ENOMEM ; +return err; }static void brd_probe (dev_t dev)
Signature · 1 line
2.30.2
PATCH v2 2/10 bcache: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
This driver doesn't do any unwinding with blk_cleanup_disk() even on errors after add_disk() and so we follow that tradition.
--- drivers/md/bcache/super.c | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-)
drivers/md/bcache/super.c +12 -5
@@ -1082,7 +1082,9 @@ int bch_cached_dev_run(struct cached_dev *dc)closure_sync (&cl); } -add_disk (d->disk); + ret =add_disk (d->disk); +if (ret) + goto out;bd_link_disk_holder (dc->bdev, dc->disk.disk);/* * won't show up in the uevent file, use udevadm monitor -e instead
@@ -1534,10 +1536,11 @@ static void flash_dev_flush(struct closure *cl)static int flash_dev_run (struct cache_set *c,struct uuid_entry *u) { +int err = -ENOMEM ;struct bcache_device *d =kzalloc (sizeof (struct bcache_device ),GFP_KERNEL );if (!d) -return -ENOMEM ; + goto err_ret;closure_init (&d->cl,NULL );set_closure_fn (&d->cl, flash_dev_flush, system_wq);
@@ -1551,9 +1554,12 @@ static int flash_dev_run(struct cache_set *c, struct uuid_entry *u)bcache_device_attach (d, c, u - c->uuids);bch_sectors_dirty_init (d);bch_flash_dev_request_init (d); -add_disk (d->disk); + err =add_disk (d->disk); +if (err) + goto err; -if (kobject_add (&d->kobj, &disk_to_dev (d->disk)->kobj,"bcache" )) + err =kobject_add (&d->kobj, &disk_to_dev (d->disk)->kobj,"bcache" ); +if (err) goto err;bcache_device_link (d, c,"volume" );
@@ -1567,7 +1573,8 @@ static int flash_dev_run(struct cache_set *c, struct uuid_entry *u)return 0 ; err:kobject_put (&d->kobj); -return -ENOMEM ; +err_ret: +return err; }static int flash_devs_run (struct cache_set *c)
Signature · 1 line
2.30.2
PATCH v2 3/10 nvme-multipath: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
Since we now can tell for sure when a disk was added, move setting the bit NVME_NSHEAD_DISK_LIVE only when we did add the disk successfully.
Nothing to do here as the cleanup is done elsewhere. We take care and use test_and_set_bit() because it is protects against two nvme paths simultaneously calling device_add_disk() on the same namespace head.
--- drivers/nvme/host/multipath.c | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/nvme/host/multipath.c +11 -2
@@ -496,13 +496,22 @@ int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, struct nvme_ns_head *head)static void nvme_mpath_set_live (struct nvme_ns *ns) {struct nvme_ns_head *head = ns->head; +int rc;if (!head->disk)return ; +/* +* test_and_set_bit() is used because it is protecting against two nvme +* paths simultaneously calling device_add_disk() on the same namespace +* head. +*/ if (!test_and_set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags)) { -device_add_disk (&head->subsys->dev, head->disk, - nvme_ns_id_attr_groups); + rc =device_add_disk (&head->subsys->dev, head->disk, + nvme_ns_id_attr_groups); +if (rc) +return ; +set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags);nvme_add_ns_head_cdev (head); }
Signature · 1 line
2.30.2
Keith Busch
maintainerRe: [PATCH v2 03/10] nvme-multipath: add error handling support for add_disk()
drivers/nvme/host/multipath.c int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, struct nvme_ns_head *head) · line 514
Quoted 13 lines · Luis Chamberlain
drivers/nvme/host/multipath.c +10
-2+/* +* test_and_set_bit() is used because it is protecting against two nvme +* paths simultaneously calling device_add_disk() on the same namespace +* head. +*/ if (!test_and_set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags)) { -device_add_disk (&head->subsys->dev, head->disk, - nvme_ns_id_attr_groups); + rc =device_add_disk (&head->subsys->dev, head->disk, + nvme_ns_id_attr_groups); +if (rc) +return ; +set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags);
No need to set_bit() here since the test_and_set_bit() already took care of that.
Re: [PATCH v2 03/10] nvme-multipath: add error handling support for add_disk()
In reply to Luis ChamberlainQuoted 47 lines · Luis Chamberlain
We never checked for errors on
add_disk()as this function returned void. Now that this is fixed, use the shiny new error handling.Since we now can tell for sure when a disk was added, move setting the bit
NVME_NSHEAD_DISK_LIVEonly when we did add the disk successfully.Nothing to do here as the cleanup is done elsewhere. We take care and use
test_and_set_bit()because it is protects against two nvme paths simultaneously callingdevice_add_disk()on the same namespace head.Signed-off-by Luis Chamberlain <[email protected]>--- drivers/nvme/host/multipath.c | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)drivers/nvme/host/multipath.c +11
-2@@ -496,13 +496,22 @@ int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, struct nvme_ns_head *head)static void nvme_mpath_set_live (struct nvme_ns *ns) {struct nvme_ns_head *head = ns->head; +int rc;if (!head->disk)return ; +/* +* test_and_set_bit() is used because it is protecting against two nvme +* paths simultaneously calling device_add_disk() on the same namespace +* head. +*/ if (!test_and_set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags)) { -device_add_disk (&head->subsys->dev, head->disk, - nvme_ns_id_attr_groups); + rc =device_add_disk (&head->subsys->dev, head->disk, + nvme_ns_id_attr_groups); +if (rc) +return ; +set_bit (NVME_NSHEAD_DISK_LIVE , &head->flags);nvme_add_ns_head_cdev (head); }
Quoted 1 line
Errm.
Setting the same bit twice?
And shouldn't you unset the bit if 'device_add_disk()' fails?
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg HRB 36809 (AG Nürnberg), Geschäftsführer: Felix Imendörffer
PATCH v2 4/10 nvdimm/btt: do not call del_gendisk() if not needed
In reply to Luis ChamberlainWe know we don't need del_gendisk() if we haven't added the disk, so just skip it. This should fix a bug on older kernels, as del_gendisk() became able to deal with disks not added only recently, after the patch titled "block: add flag for add_disk() completion notation".
--- drivers/nvdimm/btt.c | 1 - 1 file changed, 1 deletion(-)
drivers/nvdimm/btt.c +0 -1
@@ -1538,7 +1538,6 @@ static int btt_blk_init(struct btt *btt)int rc =nd_integrity_init (btt->btt_disk,btt_meta_size (btt));if (rc) { -del_gendisk (btt->btt_disk);blk_cleanup_disk (btt->btt_disk);return rc; }
Signature · 1 line
2.30.2
PATCH v2 5/10 nvdimm/btt: use goto error labels on btt_blk_init()
In reply to Luis ChamberlainThis will make it easier to share common error paths.
--- drivers/nvdimm/btt.c | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-)
drivers/nvdimm/btt.c +12 -7
@@ -1520,10 +1520,11 @@ static int btt_blk_init(struct btt *btt) {struct nd_btt *nd_btt = btt->nd_btt;struct nd_namespace_common *ndns = nd_btt->ndns; +int rc = -ENOMEM ; btt->btt_disk =blk_alloc_disk (NUMA_NO_NODE );if (!btt->btt_disk) -return -ENOMEM ; + goto out;nvdimm_namespace_disk_name (ndns, btt->btt_disk->disk_name); btt->btt_disk->first_minor =0 ;
@@ -1535,19 +1536,23 @@ static int btt_blk_init(struct btt *btt)blk_queue_flag_set (QUEUE_FLAG_NONROT , btt->btt_disk->queue);if (btt_meta_size (btt)) { -int rc =nd_integrity_init (btt->btt_disk,btt_meta_size (btt)); - -if (rc) { -blk_cleanup_disk (btt->btt_disk); -return rc; - } + rc =nd_integrity_init (btt->btt_disk,btt_meta_size (btt)); +if (rc) + goto out_cleanup_disk; } +set_capacity (btt->btt_disk, btt->nlba * btt->sector_size >>9 );device_add_disk (&btt->nd_btt->dev, btt->btt_disk,NULL ); + btt->nd_btt->size = btt->nlba * (u64 )btt->sector_size;nvdimm_check_and_set_ro (btt->btt_disk);return 0 ; + +out_cleanup_disk: +blk_cleanup_disk (btt->btt_disk); +out: +return rc; }static void btt_blk_cleanup (struct btt *btt)
Signature · 1 line
2.30.2
PATCH v2 6/10 nvdimm/btt: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
--- drivers/nvdimm/btt.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/nvdimm/btt.c +3 -1
@@ -1542,7 +1542,9 @@ static int btt_blk_init(struct btt *btt) }set_capacity (btt->btt_disk, btt->nlba * btt->sector_size >>9 ); -device_add_disk (&btt->nd_btt->dev, btt->btt_disk,NULL ); + rc =device_add_disk (&btt->nd_btt->dev, btt->btt_disk,NULL ); +if (rc) + goto out_cleanup_disk; btt->nd_btt->size = btt->nlba * (u64 )btt->sector_size;nvdimm_check_and_set_ro (btt->btt_disk);
Signature · 1 line
2.30.2
PATCH v2 7/10 nvdimm/blk: avoid calling del_gendisk() on early failures
In reply to Luis ChamberlainIf nd_integrity_init() fails we'd get del_gendisk() called, but that's not correct as we should only call that if we're done with device_add_disk(). Fix this by providing unwinding prior to the devm call being registered and moving the devm registration to the very end.
This should fix calling del_gendisk() if nd_integrity_init() fails. I only spotted this issue through code inspection. It does not fix any real world bug.
--- drivers/nvdimm/blk.c | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-)
drivers/nvdimm/blk.c +12 -5
@@ -240,6 +240,7 @@ static int nsblk_attach_disk(struct nd_namespace_blk *nsblk)resource_size_t available_disk_size;struct gendisk *disk;u64 internal_nlba; +int rc; internal_nlba =div_u64 (nsblk->size,nsblk_internal_lbasize (nsblk)); available_disk_size = internal_nlba *nsblk_sector_size (nsblk);
@@ -256,20 +257,26 @@ static int nsblk_attach_disk(struct nd_namespace_blk *nsblk)blk_queue_logical_block_size (disk->queue,nsblk_sector_size (nsblk));blk_queue_flag_set (QUEUE_FLAG_NONROT , disk->queue); -if (devm_add_action_or_reset (dev, nd_blk_release_disk, disk)) -return -ENOMEM ; -if (nsblk_meta_size (nsblk)) { -int rc =nd_integrity_init (disk,nsblk_meta_size (nsblk)); + rc =nd_integrity_init (disk,nsblk_meta_size (nsblk));if (rc) -return rc; + goto out_before_devm_err; }set_capacity (disk, available_disk_size >>SECTOR_SHIFT );device_add_disk (dev, disk,NULL ); + +/* nd_blk_release_disk() is called if this fails */ +if (devm_add_action_or_reset (dev, nd_blk_release_disk, disk)) +return -ENOMEM ; +nvdimm_check_and_set_ro (disk);return 0 ; + +out_before_devm_err: +blk_cleanup_disk (disk); +return rc; }static int nd_blk_probe (struct device *dev)
Signature · 1 line
2.30.2
PATCH v2 8/10 nvdimm/blk: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
Since nvdimm/blk uses devm we just need to move the devm registration towards the end. And in hindsight, that seems to also provide a fix given del_gendisk() should not be called unless the disk was already added via add_disk(). The probably of that issue happening is low though, like OOM while calling devm_add_action(), so the fix is minor.
We manually unwind in case of add_disk() failure prior to the devm registration.
--- drivers/nvdimm/blk.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/nvdimm/blk.c +3 -1
@@ -265,7 +265,9 @@ static int nsblk_attach_disk(struct nd_namespace_blk *nsblk) }set_capacity (disk, available_disk_size >>SECTOR_SHIFT ); -device_add_disk (dev, disk,NULL ); + rc =device_add_disk (dev, disk,NULL ); +if (rc) + goto out_before_devm_err;/* nd_blk_release_disk() is called if this fails */ if (devm_add_action_or_reset (dev, nd_blk_release_disk, disk))
Signature · 1 line
2.30.2
PATCH v2 9/10 xen-blkfront: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on device_add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling. The function xlvbd_alloc_gendisk() typically does the unwinding on error on allocating the disk and creating the tag, but since all that error handling was stuffed inside xlvbd_alloc_gendisk() we must repeat the tag free'ing as well.
We set the info->rq to NULL to ensure blkif_free() doesn't crash on blk_mq_stop_hw_queues() on device_add_disk() error as the queue will be long gone by then.
--- drivers/block/xen-blkfront.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
drivers/block/xen-blkfront.c +7 -1
@@ -2385,7 +2385,13 @@ static void blkfront_connect(struct blkfront_info *info)for_each_rinfo (info, rinfo, i)kick_pending_request_queues (rinfo); -device_add_disk (&info->xbdev->dev, info->gd,NULL ); + err =device_add_disk (&info->xbdev->dev, info->gd,NULL ); +if (err) { +blk_cleanup_disk (info->gd); +blk_mq_free_tag_set (&info->tag_set); + info->rq =NULL ; + goto fail; + } info->is_ready =1 ;return ;
Signature · 1 line
2.30.2
Re: [PATCH v2 09/10] xen-blkfront: add error handling support for add_disk()
Quoted 7 lines · Luis Chamberlain
We never checked for errors on
device_add_disk()as this function returned void. Now that this is fixed, use the shiny new error handling. The functionxlvbd_alloc_gendisk()typically does the unwinding on error on allocating the disk and creating the tag, but since all that error handling was stuffed insidexlvbd_alloc_gendisk()we must repeat the tag free'ing as well.
Quoted 5 lines
We set the
info->rqto NULL to ensureblkif_free()doesn't crash onblk_mq_stop_hw_queues()ondevice_add_disk()error as the queue will be long gone by then.Signed-off-by Luis Chamberlain <[email protected]>
Juergen
PATCH v2 10/10 zram: add error handling support for add_disk()
In reply to Luis ChamberlainWe never checked for errors on add_disk() as this function returned void. Now that this is fixed, use the shiny new error handling.
--- drivers/block/zram/zram_drv.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
drivers/block/zram/zram_drv.c +5 -1
@@ -1953,7 +1953,9 @@ static int zram_add(void)blk_queue_max_write_zeroes_sectors (zram->disk->queue,UINT_MAX );blk_queue_flag_set (QUEUE_FLAG_STABLE_WRITES , zram->disk->queue); -device_add_disk (NULL , zram->disk, zram_disk_attr_groups); + ret =device_add_disk (NULL , zram->disk, zram_disk_attr_groups); +if (ret) + goto out_cleanup_disk;strlcpy (zram->compressor, default_compressor,sizeof (zram->compressor));
@@ -1961,6 +1963,8 @@ static int zram_add(void)pr_info ("Added device: %s\n" , zram->disk->disk_name);return device_id; +out_cleanup_disk: +blk_cleanup_disk (zram->disk); out_free_idr:idr_remove (&zram_index_idr, device_id); out_free_dev:
Signature · 1 line
2.30.2
Jens Axboe
maintainerQuoted 4 lines · Luis Chamberlain
This is the second series of driver conversions for
add_disk()error handling. You can find this set and the rest of the 7th set of driver conversions on my 20210927-for-axboe-add-disk-error-handling branch [0].
Applied 1, thanks.
Signature · 1 line
Jens Axboe