Skip to contentSkip to conversation

nvme: Restore device naming sanity

PATCH In review Keith Busch 3 participants 3 messages Sep 4, 2019 – Sep 7, 2019 NVMe

lore
Share & tools
lore

Keith Busch

author maintainer
#0 lore raw

PATCH 1/1 nvme: Restore device naming sanity

The namespace names must be unique for the lifetime of the subsystem. This was accomplished by using their parent subsystems' instances which was independent of the controllers connected to that subsystem.

The consequence of that naming scheme meant that name prefixes given to namespaces may match a controller from an unrelated subsystem. This has understandbly invited confusion when examining device nodes.

Ensure the namespace's subsystem instance never clashes with a controller instance of another subsystem by transferring the instance ownership to parent subsystem from the first controller discovered in that subsystem.

---
 drivers/nvme/host/core.c | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)
drivers/nvme/host/core.c +10 -11
index 14c0bfb55615..8a8279ece5ee 100644
@@ -81,7 +81,6 @@ EXPORT_SYMBOL_GPL(nvme_reset_wq);
 struct workqueue_struct *nvme_delete_wq;
 EXPORT_SYMBOL_GPL(nvme_delete_wq);
 
-static DEFINE_IDA(nvme_subsystems_ida);
 static LIST_HEAD(nvme_subsystems);
 static DEFINE_MUTEX(nvme_subsystems_lock);
 
@@ -2344,7 +2343,8 @@ static void nvme_release_subsystem(struct device *dev)
 	struct nvme_subsystem *subsys =
 		container_of(dev, struct nvme_subsystem, dev);
 
-	ida_simple_remove(&nvme_subsystems_ida, subsys->instance);
+	if (subsys->instance >= 0)
+		ida_simple_remove(&nvme_instance_ida, subsys->instance);
 	kfree(subsys);
 }
 
@@ -2473,12 +2473,8 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
 	subsys = kzalloc(sizeof(*subsys), GFP_KERNEL);
 	if (!subsys)
 		return -ENOMEM;
-	ret = ida_simple_get(&nvme_subsystems_ida, 0, 0, GFP_KERNEL);
-	if (ret < 0) {
-		kfree(subsys);
-		return ret;
-	}
-	subsys->instance = ret;
+
+	subsys->instance = -1;
 	mutex_init(&subsys->lock);
 	kref_init(&subsys->ref);
 	INIT_LIST_HEAD(&subsys->ctrls);
@@ -2497,7 +2493,7 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
 	subsys->dev.class = nvme_subsys_class;
 	subsys->dev.release = nvme_release_subsystem;
 	subsys->dev.groups = nvme_subsys_attrs_groups;
-	dev_set_name(&subsys->dev, "nvme-subsys%d", subsys->instance);
+	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
 	device_initialize(&subsys->dev);
 
 	mutex_lock(&nvme_subsystems_lock);
@@ -2528,6 +2524,8 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
 		goto out_put_subsystem;
 	}
 
+	if (!found)
+		subsys->instance = ctrl->instance;
 	ctrl->subsys = subsys;
 	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
 	mutex_unlock(&nvme_subsystems_lock);
@@ -3803,7 +3801,9 @@ static void nvme_free_ctrl(struct device *dev)
 		container_of(dev, struct nvme_ctrl, ctrl_device);
 	struct nvme_subsystem *subsys = ctrl->subsys;
 
-	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
+	if (subsys && ctrl->instance != subsys->instance)
+		ida_simple_remove(&nvme_instance_ida, ctrl->instance);
+
 	kfree(ctrl->effects);
 	nvme_mpath_uninit(ctrl);
 	__free_page(ctrl->discard_page);
@@ -4085,7 +4085,6 @@ static int __init nvme_core_init(void)
 
 static void __exit nvme_core_exit(void)
 {
-	ida_destroy(&nvme_subsystems_ida);
 	class_destroy(nvme_subsys_class);
 	class_destroy(nvme_class);
 	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
Signature · 1 line
2.14.5
#1 lore raw
Quoted 4 lines · Keith Busch

The namespace names must be unique for the lifetime of the subsystem. This was accomplished by using their parent subsystems' instances which was independent of the controllers connected to that subsystem.

Quoted 8 lines

The consequence of that naming scheme meant that name prefixes given to namespaces may match a controller from an unrelated subsystem. This has understandbly invited confusion when examining device nodes.

Ensure the namespace's subsystem instance never clashes with a controller instance of another subsystem by transferring the instance ownership to parent subsystem from the first controller discovered in that subsystem.

Sanitity sounds a little exaggerated. The nvme naming isn't really that different except that the block devices uses number where say scsi uses letters. So maybe tone down that claim a bit, but otherwise the patch looks fine.

Reviewed-by on v1 1/1
#2 lore raw
In reply to Keith Busch

Apart from the some nits, this looks okay.

May be subject line should be 's/nvme/nvme-core/' ?

Quoted 7 lines · Keith Busch

The namespace names must be unique for the lifetime of the subsystem. This was accomplished by using their parent subsystems' instances which was independent of the controllers connected to that subsystem.

The consequence of that naming scheme meant that name prefixes given to namespaces may match a controller from an unrelated subsystem. This has understandbly invited confusion when examining device nodes.

's/understandbly/understandably/'

Quoted 87 lines

Ensure the namespace's subsystem instance never clashes with a controller instance of another subsystem by transferring the instance ownership to parent subsystem from the first controller discovered in that subsystem.

---
  drivers/nvme/host/core.c | 21 ++++++++++-----------
  1 file changed, 10 insertions(+), 11 deletions(-)
drivers/nvme/host/core.c +10 -11
index 14c0bfb55615..8a8279ece5ee 100644
@@ -81,7 +81,6 @@ EXPORT_SYMBOL_GPL(nvme_reset_wq);
  struct workqueue_struct *nvme_delete_wq;
  EXPORT_SYMBOL_GPL(nvme_delete_wq);
 
-static DEFINE_IDA(nvme_subsystems_ida);
  static LIST_HEAD(nvme_subsystems);
  static DEFINE_MUTEX(nvme_subsystems_lock);
 
@@ -2344,7 +2343,8 @@ static void nvme_release_subsystem(struct device *dev)
  	struct nvme_subsystem *subsys =
  		container_of(dev, struct nvme_subsystem, dev);
 
-	ida_simple_remove(&nvme_subsystems_ida, subsys->instance);
+	if (subsys->instance >= 0)
+		ida_simple_remove(&nvme_instance_ida, subsys->instance);
  	kfree(subsys);
  }
 
@@ -2473,12 +2473,8 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
  	subsys = kzalloc(sizeof(*subsys), GFP_KERNEL);
  	if (!subsys)
  		return -ENOMEM;
-	ret = ida_simple_get(&nvme_subsystems_ida, 0, 0, GFP_KERNEL);
-	if (ret < 0) {
-		kfree(subsys);
-		return ret;
-	}
-	subsys->instance = ret;
+
+	subsys->instance = -1;
  	mutex_init(&subsys->lock);
  	kref_init(&subsys->ref);
  	INIT_LIST_HEAD(&subsys->ctrls);
@@ -2497,7 +2493,7 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
  	subsys->dev.class = nvme_subsys_class;
  	subsys->dev.release = nvme_release_subsystem;
  	subsys->dev.groups = nvme_subsys_attrs_groups;
-	dev_set_name(&subsys->dev, "nvme-subsys%d", subsys->instance);
+	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
  	device_initialize(&subsys->dev);
 
  	mutex_lock(&nvme_subsystems_lock);
@@ -2528,6 +2524,8 @@ static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
  		goto out_put_subsystem;
  	}
 
+	if (!found)
+		subsys->instance = ctrl->instance;
  	ctrl->subsys = subsys;
  	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
  	mutex_unlock(&nvme_subsystems_lock);
@@ -3803,7 +3801,9 @@ static void nvme_free_ctrl(struct device *dev)
  		container_of(dev, struct nvme_ctrl, ctrl_device);
  	struct nvme_subsystem *subsys = ctrl->subsys;
 
-	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
+	if (subsys && ctrl->instance != subsys->instance)
+		ida_simple_remove(&nvme_instance_ida, ctrl->instance);
+
  	kfree(ctrl->effects);
  	nvme_mpath_uninit(ctrl);
  	__free_page(ctrl->discard_page);
@@ -4085,7 +4085,6 @@ static int __init nvme_core_init(void)
 
  static void __exit nvme_core_exit(void)
  {
-	ida_destroy(&nvme_subsystems_ida);
  	class_destroy(nvme_subsys_class);
  	class_destroy(nvme_class);
  	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);