nvme: fix crash and memory leak during invalid cdev teardown
PATCH 1/1 nvme: fix crash and memory leak during invalid cdev teardown
In the NVMe multipath code, if nvme_add_ns_head_cdev() fails during nvme_mpath_set_live(), the error is ignored. However, during teardown, nvme_remove_head() unconditionally calls nvme_cdev_del(). This teardown asymmetry leads to a kernel panic if the character device was never successfully initialized.
BUG: kernel NULL pointer dereference, address: 00000000000000d0 device_del+0x39/0x3c0 cdev_device_del+0x15/0x50 nvme_cdev_del+0xe/0x20 [nvme_core] nvme_mpath_shutdown_disk+0x38/0x60 [nvme_core] nvme_ns_remove+0x177/0x1f0 [nvme_core] nvme_remove_namespaces+0xdc/0x130 [nvme_core] nvme_do_delete_ctrl+0x71/0xd0 [nvme_core]
Additionally, a memory leak exists in the nvme_cdev_add() failure path. Previously, dev_set_name() was called before ida_alloc(). If ida_alloc() subsequently failed, device_initialize() was never called, meaning put_device() could not be used to clean up the kobject, leaking the memory allocated by dev_set_name().
* Introduces the NVME_NSHEAD_CDEV_LIVE and NVME_NS_CDEV_LIVE bits to track the successful creation of the character devices. Teardown routines now check these bits before attempting deletion.
* Refactor nvme_cdev_add() to accept the formatted device name as a parameter, moving dev_set_name() after the IDA allocation and immediately before device_initialize(). This ensures any internally allocated strings are safely cleaned up by put_device() upon failure.
--- drivers/nvme/host/core.c | 33 +++++++++++++++++++++++++-------- drivers/nvme/host/multipath.c | 22 ++++++++++++++++------ drivers/nvme/host/nvme.h | 4 +++- 3 files changed, 44 insertions(+), 15 deletions(-)
drivers/nvme/host/core.c +25 -8
@@ -3856,7 +3856,7 @@ void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)put_device (cdev_device); } -int nvme_cdev_add (struct cdev *cdev,struct device *cdev_device, +int nvme_cdev_add (char *name,struct cdev *cdev,struct device *cdev_device,const struct file_operations *fops,struct module *owner) {int minor, ret;
@@ -3864,6 +3864,12 @@ int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device, minor =ida_alloc (&nvme_ns_chr_minor_ida,GFP_KERNEL );if (minor <0 )return minor; + + ret =dev_set_name (cdev_device, name); +if (ret) { +ida_free (&nvme_ns_chr_minor_ida, minor); +return ret; + } cdev_device->devt =MKDEV (MAJOR (nvme_ns_chr_devt), minor); cdev_device->class = &nvme_ns_chr_class; cdev_device->release = nvme_cdev_rel;
@@ -3901,15 +3907,24 @@ static const struct file_operations nvme_ns_chr_fops = {static int nvme_add_ns_cdev (struct nvme_ns *ns) {int ret; +char *name; ns->cdev_device.parent = ns->ctrl->device; - ret =dev_set_name (&ns->cdev_device,"ng%dn%d" , - ns->ctrl->instance, ns->head->instance); + name =kasprintf (GFP_KERNEL ,"ng%dn%d" , ns->ctrl->instance, + ns->head->instance); +if (!name) +return -ENOMEM ; + + ret =nvme_cdev_add (name, &ns->cdev, &ns->cdev_device, + &nvme_ns_chr_fops, ns->ctrl->ops->module);if (ret) -return ret; +dev_err (ns->ctrl->device,"Unable to create the %s device" , + name); +else +set_bit (NVME_NS_CDEV_LIVE , &ns->flags); -return nvme_cdev_add (&ns->cdev, &ns->cdev_device, &nvme_ns_chr_fops, - ns->ctrl->ops->module); +kfree (name); +return ret; } static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
@@ -4285,8 +4300,10 @@ static void nvme_ns_remove(struct nvme_ns *ns)/* guarantee not available in head->list */ synchronize_srcu (&ns->head->srcu); -if (!nvme_ns_head_multipath (ns->head)) -nvme_cdev_del (&ns->cdev, &ns->cdev_device); +if (!nvme_ns_head_multipath (ns->head)) { +if (test_and_clear_bit (NVME_NS_CDEV_LIVE , &ns->flags)) +nvme_cdev_del (&ns->cdev, &ns->cdev_device); + }nvme_mpath_remove_sysfs_link (ns);
drivers/nvme/host/multipath.c +16 -6
@@ -620,14 +620,23 @@ static const struct file_operations nvme_ns_head_chr_fops = {static int nvme_add_ns_head_cdev (struct nvme_ns_head *head) {int ret; +char *name; head->cdev_device.parent = &head->subsys->dev; - ret =dev_set_name (&head->cdev_device,"ng%dn%d" , - head->subsys->instance, head->instance); -if (ret) -return ret; - ret =nvme_cdev_add (&head->cdev, &head->cdev_device, + name =kasprintf (GFP_KERNEL ,"ng%dn%d" , head->subsys->instance, + head->instance); +if (!name) +return -ENOMEM ; + + ret =nvme_cdev_add (name, &head->cdev, &head->cdev_device, &nvme_ns_head_chr_fops,THIS_MODULE ); +if (ret) +dev_err (disk_to_dev (head->disk), +"Unable to create the %s device" , name); +else +set_bit (NVME_NSHEAD_CDEV_LIVE , &head->flags); + +kfree (name);return ret; }
@@ -672,7 +681,8 @@ static void nvme_remove_head(struct nvme_ns_head *head)*/ kblockd_schedule_work (&head->requeue_work); -nvme_cdev_del (&head->cdev, &head->cdev_device); +if (test_and_clear_bit (NVME_NSHEAD_CDEV_LIVE , &head->flags)) +nvme_cdev_del (&head->cdev, &head->cdev_device);synchronize_srcu (&head->srcu);del_gendisk (head->disk); }
drivers/nvme/host/nvme.h +3 -1
@@ -567,6 +567,7 @@ struct nvme_ns_head {unsigned int delayed_removal_secs;#define NVME_NSHEAD_DISK_LIVE 0#define NVME_NSHEAD_QUEUE_IF_NO_PATH 1 +#define NVME_NSHEAD_CDEV_LIVE 2struct nvme_ns __rcu *current_path[];#endif };
@@ -602,6 +603,7 @@ struct nvme_ns {#define NVME_NS_FORCE_RO 3#define NVME_NS_READY 4#define NVME_NS_SYSFS_ATTR_LINK 5 +#define NVME_NS_CDEV_LIVE 6struct cdev cdev;struct device cdev_device;
@@ -986,7 +988,7 @@ int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi, void *log, size_t size, u64 offset);bool nvme_tryget_ns_head (struct nvme_ns_head *head);void nvme_put_ns_head (struct nvme_ns_head *head); -int nvme_cdev_add (struct cdev *cdev,struct device *cdev_device, +int nvme_cdev_add (char *name,struct cdev *cdev,struct device *cdev_device,const struct file_operations *fops,struct module *owner);void nvme_cdev_del (struct cdev *cdev,struct device *cdev_device); int nvme_ioctl(struct block_device *bdev, blk_mode_t mode,
Signature · 1 line
2.54.0
Quoted 17 lines
static int
nvme_add_ns_head_cdev(struct nvme_ns_head *head){drivers/nvme/host/multipath.c +7
-5int ret; +char *name; head->cdev_device.parent = &head->subsys->dev; - ret =dev_set_name (&head->cdev_device,"ng%dn%d" , - head->subsys->instance, head->instance); -if (ret) -return ret; - ret = nvme_cdev_add(&head->cdev, &head->cdev_device, + name =kasprintf (GFP_KERNEL ,"ng%dn%d" , head->subsys->instance, + head->instance); +if (!name) +return -ENOMEM ; + + ret = nvme_cdev_add(name, &head->cdev, &head->cdev_device,
drivers/nvme/host/multipath.c static const struct file_operations nvme_ns_head_chr_fops = { · line 641
Quoted 10 lines
drivers/nvme/host/multipath.c +7
-0&nvme_ns_head_chr_fops, THIS_MODULE); +if (ret) +dev_err (disk_to_dev (head->disk), +"Unable to create the %s device" , name); +else +set_bit (NVME_NSHEAD_CDEV_LIVE , &head->flags); + +kfree (name);return ret; }
nvme_add_ns_head_cdev returns the error code but nvme_mpath_set_live handle the return code. So we either don't need to return the error code or we should do something in nvme_mpath_set_live with it.
Quoted 23 lines · Daniel Wagner
Quoted 23 lines
static int
nvme_add_ns_head_cdev(struct nvme_ns_head *head){drivers/nvme/host/multipath.c +12
-5int ret; +char *name; head->cdev_device.parent = &head->subsys->dev; - ret =dev_set_name (&head->cdev_device,"ng%dn%d" , - head->subsys->instance, head->instance); -if (ret) -return ret; - ret =nvme_cdev_add (&head->cdev, &head->cdev_device, + name =kasprintf (GFP_KERNEL ,"ng%dn%d" , head->subsys->instance, + head->instance); +if (!name) +return -ENOMEM ; + + ret =nvme_cdev_add (name, &head->cdev, &head->cdev_device, &nvme_ns_head_chr_fops,THIS_MODULE ); +if (ret) +dev_err (disk_to_dev (head->disk), +"Unable to create the %s device" , name); +else +set_bit (NVME_NSHEAD_CDEV_LIVE , &head->flags);
Quoted 8 lines
drivers/nvme/host/multipath.c static const struct file_operations nvme_ns_head_chr_fops = { · line 641
Quoted 4 lines
drivers/nvme/host/multipath.c +2
-0+ +kfree (name);return ret; }
nvme_add_ns_head_cdevreturns the error code butnvme_mpath_set_livehandle the return code. So we either don't need to return the error code or we should do something innvme_mpath_set_livewith it.
Please refer to the latest nvme-7.2 branch.
Those functions were later modified to not return error codes.
Maurizio
Quoted 2 lines · Maurizio Lombardi
Please refer to the latest nvme-7.2 branch.
Those functions were later modified to not return error codes.
Sorry, I looked at master instead nvme-7.2. My excuse is that I am still catching up from my vacations :)