Skip to contentSkip to conversation

class: add class_find_and_get_file_ns() helper function

PATCH RESEND In review Taehee Yoo 2 participants 3 messages Mar 24, 2020

Subsystems (3)
lore
Share & tools
lore

Taehee Yoo

author
#0 lore raw

PATCH RESEND 1/3 class: add class_find_and_get_file_ns() helper function

The new helper function is to find and get a class file. This function is useful for checking whether the class file is existing or not. This function will be used by networking stack to check "/sys/class/net/*" file.

Reported-by [email protected]
Fixes b76cdba9cdb2 ("[PATCH] bonding: add sysfs functionality to bonding (large)")
---
 drivers/base/class.c         | 12 ++++++++++++
 include/linux/device/class.h |  4 +++-
 2 files changed, 15 insertions(+), 1 deletion(-)
drivers/base/class.c +12 -0
index bcd410e6d70a..dedf41f32f0d 100644
@@ -105,6 +105,17 @@ void class_remove_file_ns(struct class *cls, const struct class_attribute *attr,
 		sysfs_remove_file_ns(&cls->p->subsys.kobj, &attr->attr, ns);
 }
 
+struct kernfs_node *class_find_and_get_file_ns(struct class *cls,
+					       const char *name,
+					       const void *ns)
+{
+	struct kernfs_node *kn = NULL;
+
+	if (cls)
+		kn = kernfs_find_and_get_ns(cls->p->subsys.kobj.sd, name, ns);
+	return kn;
+}
+
 static struct class *class_get(struct class *cls)
 {
 	if (cls)
@@ -580,6 +591,7 @@ int __init classes_init(void)
 
 EXPORT_SYMBOL_GPL(class_create_file_ns);
 EXPORT_SYMBOL_GPL(class_remove_file_ns);
+EXPORT_SYMBOL_GPL(class_find_and_get_file_ns);
 EXPORT_SYMBOL_GPL(class_unregister);
 EXPORT_SYMBOL_GPL(class_destroy);
 
include/linux/device/class.h +3 -1
index e8d470c457d1..230cf2ce6d3f 100644
@@ -209,7 +209,9 @@ extern int __must_check class_create_file_ns(struct class *class,
 extern void class_remove_file_ns(struct class *class,
 				 const struct class_attribute *attr,
 				 const void *ns);
-
+struct kernfs_node *class_find_and_get_file_ns(struct class *cls,
+					       const char *name,
+					       const void *ns);
 static inline int __must_check class_create_file(struct class *class,
 					const struct class_attribute *attr)
 {
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 22 lines · Taehee Yoo

The new helper function is to find and get a class file. This function is useful for checking whether the class file is existing or not. This function will be used by networking stack to check "/sys/class/net/*" file.

Reported-by [email protected]
Fixes b76cdba9cdb2 ("[PATCH] bonding: add sysfs functionality to bonding (large)")
---
 drivers/base/class.c         | 12 ++++++++++++
 include/linux/device/class.h |  4 +++-
 2 files changed, 15 insertions(+), 1 deletion(-)
drivers/base/class.c +1 -0
index bcd410e6d70a..dedf41f32f0d 100644
@@ -105,6 +105,17 @@ void class_remove_file_ns(struct class *cls, const struct class_attribute *attr,
 		sysfs_remove_file_ns(&cls->p->subsys.kobj, &attr->attr, ns);
 }
 
+struct kernfs_node *class_find_and_get_file_ns(struct class *cls,

drivers/base/class.c void class_remove_file_ns(struct class *cls, const struct class_attribute *attr, · line 118

Quoted 10 lines
drivers/base/class.c +10 -0
+					       const char *name,
+					       const void *ns)
+{
+	struct kernfs_node *kn = NULL;
+
+	if (cls)
+		kn = kernfs_find_and_get_ns(cls->p->subsys.kobj.sd, name, ns);
+	return kn;
+}
+

You can put the EXPORT_SYMBOL_GPL() under here.

And can you document what this function actually is in some kerneldoc?

But, returning a kernfs_node from a driver core is _REALLY_ odd. Why do you need this and who cares about kernfs here?

thanks,

greg k-h

author
#2 lore raw
Quoted 1 line · Greg KH

Hi Greg,
Thank you for the review!

Quoted 22 lines · Taehee Yoo
Quoted 21 lines

The new helper function is to find and get a class file. This function is useful for checking whether the class file is existing or not. This function will be used by networking stack to check "/sys/class/net/*" file.

Reported-by [email protected]
Fixes b76cdba9cdb2 ("[PATCH] bonding: add sysfs functionality to bonding (large)")
---
 drivers/base/class.c         | 12 ++++++++++++
 include/linux/device/class.h |  4 +++-
 2 files changed, 15 insertions(+), 1 deletion(-)
drivers/base/class.c +0 -0
index bcd410e6d70a..dedf41f32f0d 100644
@@ -105,6 +105,17 @@ void class_remove_file_ns(struct class *cls, const struct class_attribute *attr,
              sysfs_remove_file_ns(&cls->p->subsys.kobj, &attr->attr, ns);
 }
 
Quoted 14 lines

drivers/base/class.c void class_remove_file_ns(struct class *cls, const struct class_attribute *attr, · line 118

Quoted 11 lines
drivers/base/class.c +11 -0
+struct kernfs_node *class_find_and_get_file_ns(struct class *cls,
+                                            const char *name,
+                                            const void *ns)
+{
+     struct kernfs_node *kn = NULL;
+
+     if (cls)
+             kn = kernfs_find_and_get_ns(cls->p->subsys.kobj.sd, name, ns);
+     return kn;
+}
+

You can put the EXPORT_SYMBOL_GPL() under here.

Okay, I will change this.

Quoted 2 lines

And can you document what this function actually is in some kerneldoc?

Thanks, I will add some kernel-doc comment.

Quoted 3 lines

But, returning a kernfs_node from a driver core is _REALLY_ odd. Why do you need this and who cares about kernfs here?

I fully agree with that.
My previous version of this function was here:

bool class_has_file_ns(struct class *cls, const char *name,
const void *ns)

{
        struct kernfs_node *kn = NULL;

        if (cls) {
                kn = kernfs_find_and_get_ns(cls->p->subsys.kobj.sd, name, ns);
                if (kn) {
                        kernfs_put(kn);
                        return true;
                }
        }
        return false;
}

I wanted this function could be used in general cases. But I thought this function couldn't be used in general cases. So, I made class_find_and_get_file_ns() but I couldn't find a more appropriate return type.
I think I'd rather to use class_has_file_ns() instead of class_find_and_get_file_ns() because of an awkward return type. How do you think about it?

Quoted 3 lines

thanks,

greg k-h

Thanks a lot,
Taehee Yoo