Skip to contentSkip to conversation

nvme: introduce nvme_disk_is_ns_head helper

PATCH Applied Guixin Liu 5 participants 6 messages Dec 27, 2023 – Jan 3, 2024 NVMe

lore
Share & tools
lore

Guixin Liu

author
#0 lore raw

PATCH v3 1/1 nvme: introduce nvme_disk_is_ns_head helper

We currently rely on gendisk's file operations (fops) to distinguish between a namespace head (ns_head) and a regular namespace. To enhance code readability, introduce a helper function. Additionally, we must ensure that the device is not an ns_head before calling nvme_get_ns_from_dev(). To enforce this, add a WARN_ON check within the nvme_get_ns_from_dev().

---
Changes from v2 to v3:
- simplify to disk->fops == &nvme_ns_head_ops.

Changes from v1 to v2:
- change helper name from nvme_gendisk_is_ns_head to nvme_disk_is_ns_head.
- remove redundant comment.

 drivers/nvme/host/nvme.h  | 10 +++++++++-
 drivers/nvme/host/pr.c    |  2 +-
 drivers/nvme/host/sysfs.c |  9 +++++----
 3 files changed, 15 insertions(+), 6 deletions(-)
drivers/nvme/host/nvme.h +9 -1
index e7411dac00f7..3dcbf48e9fdf 100644
@@ -1029,9 +1029,17 @@ static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf)
 }
 #endif
 
+static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
+{
+	return disk->fops == &nvme_ns_head_ops;
+}
+
 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
 {
-	return dev_to_disk(dev)->private_data;
+	struct gendisk *disk = dev_to_disk(dev);
+
+	WARN_ON(nvme_disk_is_ns_head(disk));
+	return disk->private_data;
 }
 
 #ifdef CONFIG_NVME_HWMON
drivers/nvme/host/pr.c +1 -1
index 391b1465ebfd..fc3eed00f9ff 100644
@@ -98,7 +98,7 @@ static int nvme_send_pr_command(struct block_device *bdev,
 		struct nvme_command *c, void *data, unsigned int data_len)
 {
 	if (IS_ENABLED(CONFIG_NVME_MULTIPATH) &&
-	    bdev->bd_disk->fops == &nvme_ns_head_ops)
+	    nvme_disk_is_ns_head(bdev->bd_disk))
 		return nvme_send_ns_head_pr_command(bdev, c, data, data_len);
 
 	return nvme_send_ns_pr_command(bdev->bd_disk->private_data, c, data,
drivers/nvme/host/sysfs.c +5 -4
index c6b7fbd4d34d..925042ca728b 100644
@@ -39,10 +39,10 @@ static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
 {
 	struct gendisk *disk = dev_to_disk(dev);
 
-	if (disk->fops == &nvme_bdev_ops)
-		return nvme_get_ns_from_dev(dev)->head;
-	else
+	if (nvme_disk_is_ns_head(disk))
 		return disk->private_data;
+	else
+		return nvme_get_ns_from_dev(dev)->head;
 }
 
 static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
@@ -148,7 +148,8 @@ static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
 	}
 #ifdef CONFIG_NVME_MULTIPATH
 	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
-		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
+		/* per-path attr */
+		if (nvme_disk_is_ns_head(dev_to_disk(dev)))
 			return 0;
 		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
 			return 0;
Signature · 1 line
2.43.0
Reviewed-by on v3 1/1
#1 lore raw

Using helper functions makes the code more readable.

Quoted 86 lines · Guixin Liu

We currently rely on gendisk's file operations (fops) to distinguish between a namespace head (ns_head) and a regular namespace. To enhance code readability, introduce a helper function. Additionally, we must ensure that the device is not an ns_head before calling nvme_get_ns_from_dev(). To enforce this, add a WARN_ON check within the nvme_get_ns_from_dev().

---
Changes from v2 to v3:
- simplify to disk->fops == &nvme_ns_head_ops.

Changes from v1 to v2:
- change helper name from nvme_gendisk_is_ns_head to nvme_disk_is_ns_head.
- remove redundant comment.

  drivers/nvme/host/nvme.h  | 10 +++++++++-
  drivers/nvme/host/pr.c    |  2 +-
  drivers/nvme/host/sysfs.c |  9 +++++----
  3 files changed, 15 insertions(+), 6 deletions(-)
drivers/nvme/host/nvme.h +9 -1
index e7411dac00f7..3dcbf48e9fdf 100644
@@ -1029,9 +1029,17 @@ static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf)
  }
  #endif
 
+static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
+{
+	return disk->fops == &nvme_ns_head_ops;
+}
+
  static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
  {
-	return dev_to_disk(dev)->private_data;
+	struct gendisk *disk = dev_to_disk(dev);
+
+	WARN_ON(nvme_disk_is_ns_head(disk));
+	return disk->private_data;
  }
 
  #ifdef CONFIG_NVME_HWMON
drivers/nvme/host/pr.c +1 -1
index 391b1465ebfd..fc3eed00f9ff 100644
@@ -98,7 +98,7 @@ static int nvme_send_pr_command(struct block_device *bdev,
  		struct nvme_command *c, void *data, unsigned int data_len)
  {
  	if (IS_ENABLED(CONFIG_NVME_MULTIPATH) &&
-	    bdev->bd_disk->fops == &nvme_ns_head_ops)
+	    nvme_disk_is_ns_head(bdev->bd_disk))
  		return nvme_send_ns_head_pr_command(bdev, c, data, data_len);
 
  	return nvme_send_ns_pr_command(bdev->bd_disk->private_data, c, data,
drivers/nvme/host/sysfs.c +5 -4
index c6b7fbd4d34d..925042ca728b 100644
@@ -39,10 +39,10 @@ static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
  {
  	struct gendisk *disk = dev_to_disk(dev);
 
-	if (disk->fops == &nvme_bdev_ops)
-		return nvme_get_ns_from_dev(dev)->head;
-	else
+	if (nvme_disk_is_ns_head(disk))
  		return disk->private_data;
+	else
+		return nvme_get_ns_from_dev(dev)->head;
  }
 
  static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
@@ -148,7 +148,8 @@ static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
  	}
  #ifdef CONFIG_NVME_MULTIPATH
  	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
-		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
+		/* per-path attr */
+		if (nvme_disk_is_ns_head(dev_to_disk(dev)))
  			return 0;
  		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
  			return 0;
maintainer Reviewed-by on v3 1/1
#2 lore raw
In reply to Guixin Liu

Looks good:

drivers/nvme/host/sysfs.c static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev) · line 46

Quoted 5 lines
drivers/nvme/host/sysfs.c +3 -0
+	if (nvme_disk_is_ns_head(disk))
 		return disk->private_data;
+	else
+		return nvme_get_ns_from_dev(dev)->head;
 }

Keith, maybe you can drop the superflous (pre-existing) else here when applying.

maintainer Applied
#4 lore raw
In reply to Guixin Liu
Quoted 6 lines · Guixin Liu

We currently rely on gendisk's file operations (fops) to distinguish between a namespace head (ns_head) and a regular namespace. To enhance code readability, introduce a helper function. Additionally, we must ensure that the device is not an ns_head before calling nvme_get_ns_from_dev(). To enforce this, add a WARN_ON check within the nvme_get_ns_from_dev().

Thanks, applied to nvme-6.8 with Christoph's suggestion folded in.

maintainer
#5 lore raw
Quoted 9 lines · Keith Busch
Quoted 6 lines · Guixin Liu

We currently rely on gendisk's file operations (fops) to distinguish between a namespace head (ns_head) and a regular namespace. To enhance code readability, introduce a helper function. Additionally, we must ensure that the device is not an ns_head before calling nvme_get_ns_from_dev(). To enforce this, add a WARN_ON check within the nvme_get_ns_from_dev().

Thanks, applied to nvme-6.8 with Christoph's suggestion folded in.

Patch updated to include fix for build breakage:

https://lists.infradead.org/pipermail/linux-nvme/2024-January/044120.html

Final form is currently here if you want to double check what I did:

https://git.infradead.org/nvme.git/commitdiff/620a6a938a716c6bd10129ec265731d5cb098a27