Skip to contentSkip to conversation

debugfs: provide pr_fmt() macro

PATCH In review Greg Kroah-Hartman 4 participants 9 messages Jul 3, 2019 Driver core

lore
Share & tools
lore

Greg Kroah-Hartman

author maintainer
#0 lore raw

PATCH 1/2 debugfs: provide pr_fmt() macro

Use a common "debugfs: " prefix for all pr_* calls in a single place.

Cc Mark Brown <[email protected]>
Cc Takashi Iwai <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
---
 fs/debugfs/inode.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
fs/debugfs/inode.c +3 -1
index acef14ad53db..f04c8475d9a1 100644
@@ -9,6 +9,8 @@
  *  See ./Documentation/core-api/kernel-api.rst for more details.
  */
 
+#define pr_fmt(fmt)	"debugfs: " fmt
+
 #include <linux/module.h>
 #include <linux/fs.h>
 #include <linux/mount.h>
@@ -285,7 +287,7 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 	struct dentry *dentry;
 	int error;
 
-	pr_debug("debugfs: creating file '%s'\n",name);
+	pr_debug("creating file '%s'\n", name);
 
 	if (IS_ERR(parent))
 		return parent;
Signature · 1 line
2.22.0
author maintainer
#1 lore raw

PATCH 2/2 debugfs: log errors when something goes wrong

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +20 -5
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
 	error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
 			      &debugfs_mount_count);
-	if (error)
+	if (error) {
+		pr_err("Unable to pin filesystem for file '%s'\n", name);
 		return ERR_PTR(error);
+	}
 
 	/* If the parent is not specified, we create it in the root.
 	 * We need the root dentry to do this, which is in the super
@@ -309,6 +312,7 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 	dentry = lookup_one_len(name, parent, strlen(name));
 	if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
 		dput(dentry);
+		pr_err("File '%s' already present!\n", name);
 		dentry = ERR_PTR(-EEXIST);
 	}
 
@@ -351,8 +355,11 @@ static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
 		return dentry;
 
 	inode = debugfs_get_inode(dentry->d_sb);
-	if (unlikely(!inode))
+	if (unlikely(!inode)) {
+		pr_err("out of free dentries, can not create file '%s'\n",
+		       name);
 		return failed_creating(dentry);
+	}
 
 	inode->i_mode = mode;
 	inode->i_private = data;
@@ -513,8 +520,11 @@ struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
 		return dentry;
 
 	inode = debugfs_get_inode(dentry->d_sb);
-	if (unlikely(!inode))
+	if (unlikely(!inode)) {
+		pr_err("out of free dentries, can not create directory '%s'\n",
+		       name);
 		return failed_creating(dentry);
+	}
 
 	inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
 	inode->i_op = &simple_dir_inode_operations;
@@ -552,8 +562,11 @@ struct dentry *debugfs_create_automount(const char *name,
 		return dentry;
 
 	inode = debugfs_get_inode(dentry->d_sb);
-	if (unlikely(!inode))
+	if (unlikely(!inode)) {
+		pr_err("out of free dentries, can not create automount '%s'\n",
+		       name);
 		return failed_creating(dentry);
+	}
 
 	make_empty_dir_inode(inode);
 	inode->i_flags |= S_AUTOMOUNT;
@@ -608,6 +621,8 @@ struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 
 	inode = debugfs_get_inode(dentry->d_sb);
 	if (unlikely(!inode)) {
+		pr_err("out of free dentries, can not create symlink '%s'\n",
+		       name);
 		kfree(link);
 		return failed_creating(dentry);
 	}
Signature · 1 line
2.22.0
maintainer Reviewed-by on v1 2/2
#2 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

Quoted 8 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

Quoted 4 lines

Generally speaking

Quoted 20 lines
---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +2 -1
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.

fs/debugfs/inode.c static struct dentry *start_creating(const char *name, struct dentry *parent) · line 299

Quoted 6 lines
fs/debugfs/inode.c +2 -1
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
        error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
                              &debugfs_mount_count);
-       if (error)
+       if (error) {
+               pr_err("Unable to pin filesystem for file '%s'\n", name);

But I'm not sure about the log level here. Particularly, why would pr_info() not work?

Quoted 64 lines
fs/debugfs/inode.c +16 -4
                return ERR_PTR(error);
+       }
 
        /* If the parent is not specified, we create it in the root.
         * We need the root dentry to do this, which is in the super
@@ -309,6 +312,7 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
        dentry = lookup_one_len(name, parent, strlen(name));
        if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
                dput(dentry);
+               pr_err("File '%s' already present!\n", name);
                dentry = ERR_PTR(-EEXIST);
        }
 
@@ -351,8 +355,11 @@ static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
                return dentry;
 
        inode = debugfs_get_inode(dentry->d_sb);
-       if (unlikely(!inode))
+       if (unlikely(!inode)) {
+               pr_err("out of free dentries, can not create file '%s'\n",
+                      name);
                return failed_creating(dentry);
+       }
 
        inode->i_mode = mode;
        inode->i_private = data;
@@ -513,8 +520,11 @@ struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
                return dentry;
 
        inode = debugfs_get_inode(dentry->d_sb);
-       if (unlikely(!inode))
+       if (unlikely(!inode)) {
+               pr_err("out of free dentries, can not create directory '%s'\n",
+                      name);
                return failed_creating(dentry);
+       }
 
        inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
        inode->i_op = &simple_dir_inode_operations;
@@ -552,8 +562,11 @@ struct dentry *debugfs_create_automount(const char *name,
                return dentry;
 
        inode = debugfs_get_inode(dentry->d_sb);
-       if (unlikely(!inode))
+       if (unlikely(!inode)) {
+               pr_err("out of free dentries, can not create automount '%s'\n",
+                      name);
                return failed_creating(dentry);
+       }
 
        make_empty_dir_inode(inode);
        inode->i_flags |= S_AUTOMOUNT;
@@ -608,6 +621,8 @@ struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 
        inode = debugfs_get_inode(dentry->d_sb);
        if (unlikely(!inode)) {
+               pr_err("out of free dentries, can not create symlink '%s'\n",
+                      name);
                kfree(link);
                return failed_creating(dentry);
        }
--

2.22.0

author maintainer
#3 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

Quoted 40 lines · Rafael J. Wysocki
Quoted 8 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

Quoted 4 lines

Generally speaking

Quoted 21 lines
---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +2 -1
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
Quoted 8 lines

fs/debugfs/inode.c static struct dentry *start_creating(const char *name, struct dentry *parent) · line 299

Quoted 5 lines
fs/debugfs/inode.c +2 -1
        error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
                              &debugfs_mount_count);
-       if (error)
+       if (error) {
+               pr_err("Unable to pin filesystem for file '%s'\n", name);

But I'm not sure about the log level here. Particularly, why would pr_info() not work?

It could, but it is an error in that debugfs didn't do what was asked of it. I really don't care either way, the odds of anyone ever seeing this message is almost none :)

thanks,

greg k-h

Reviewed-by
#4 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

Quoted 51 lines · Greg Kroah-Hartman
Quoted 40 lines · Rafael J. Wysocki
Quoted 8 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

Quoted 4 lines

Generally speaking

Quoted 21 lines
---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +2 -1
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
Quoted 8 lines

fs/debugfs/inode.c static struct dentry *start_creating(const char *name, struct dentry *parent) · line 299

Quoted 5 lines
fs/debugfs/inode.c +2 -1
        error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
                              &debugfs_mount_count);
-       if (error)
+       if (error) {
+               pr_err("Unable to pin filesystem for file '%s'\n", name);

But I'm not sure about the log level here. Particularly, why would pr_info() not work?

Quoted 3 lines

It could, but it is an error in that debugfs didn't do what was asked of it. I really don't care either way, the odds of anyone ever seeing this message is almost none :)

Yes, that's an obvious error and I see no big reason to hide it.

For both:

Thanks!

Takashi

author maintainer
#5 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

Quoted 53 lines · Takashi Iwai
Quoted 51 lines · Greg Kroah-Hartman
Quoted 48 lines · Rafael J. Wysocki
Quoted 8 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

Quoted 4 lines

Generally speaking

Quoted 20 lines
---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +2 -1
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.

fs/debugfs/inode.c static struct dentry *start_creating(const char *name, struct dentry *parent) · line 299

Quoted 6 lines
fs/debugfs/inode.c +2 -1
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
        error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
                              &debugfs_mount_count);
-       if (error)
+       if (error) {
+               pr_err("Unable to pin filesystem for file '%s'\n", name);

But I'm not sure about the log level here. Particularly, why would pr_info() not work?

Quoted 8 lines
Quoted 3 lines

It could, but it is an error in that debugfs didn't do what was asked of it. I really don't care either way, the odds of anyone ever seeing this message is almost none :)

Yes, that's an obvious error and I see no big reason to hide it.

For both:

Thanks all for the review, I'll go apply these to my tree now.

greg k-h

#6 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

In reply to Greg Kroah-Hartman
Quoted 51 lines · Greg Kroah-Hartman
Quoted 40 lines · Rafael J. Wysocki
Quoted 8 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

Quoted 4 lines

Generally speaking

Quoted 21 lines
---
 fs/debugfs/inode.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
fs/debugfs/inode.c +2 -1
index f04c8475d9a1..7f43c8acfcbf 100644
@@ -2,8 +2,9 @@
 /*
  *  inode.c - part of debugfs, a tiny little debug file system
  *
- *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
+ *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
  *  Copyright (C) 2004 IBM Inc.
+ *  Copyright (C) 2019 Linux Foundation <[email protected]>
  *
  *  debugfs is for people to use instead of /proc or /sys.
  *  See ./Documentation/core-api/kernel-api.rst for more details.
@@ -294,8 +295,10 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
 
Quoted 8 lines

fs/debugfs/inode.c static struct dentry *start_creating(const char *name, struct dentry *parent) · line 299

Quoted 5 lines
fs/debugfs/inode.c +2 -1
        error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
                              &debugfs_mount_count);
-       if (error)
+       if (error) {
+               pr_err("Unable to pin filesystem for file '%s'\n", name);

But I'm not sure about the log level here. Particularly, why would pr_info() not work?

Quoted 3 lines

It could, but it is an error in that debugfs didn't do what was asked of it. I really don't care either way, the odds of anyone ever seeing this message is almost none :)

Fair enough.

Reviewed-by on v1 2/2
#7 lore raw

Re: [PATCH 2/2] debugfs: log errors when something goes wrong

In reply to Greg Kroah-Hartman
Quoted 6 lines · Greg Kroah-Hartman

As it is not recommended that debugfs calls be checked, it was pointed out that major errors should still be logged somewhere so that developers and users have a chance to figure out what went wrong. To help with this, error logging has been added to the debugfs core so that it is not needed to be present in every individual file that calls debugfs.

maintainer Reviewed-by on v1 1/2
#8 lore raw
In reply to Greg Kroah-Hartman
Quoted 7 lines · Greg Kroah-Hartman

Use a common "debugfs: " prefix for all pr_* calls in a single place.

Cc Mark Brown <[email protected]>
Cc Takashi Iwai <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Quoted 29 lines
---
 fs/debugfs/inode.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
fs/debugfs/inode.c +3 -2
index acef14ad53db..f04c8475d9a1 100644
@@ -9,6 +9,8 @@
  *  See ./Documentation/core-api/kernel-api.rst for more details.
  */
 
+#define pr_fmt(fmt)    "debugfs: " fmt
+
 #include <linux/module.h>
 #include <linux/fs.h>
 #include <linux/mount.h>
@@ -285,7 +287,7 @@ static struct dentry *start_creating(const char *name, struct dentry *parent)
        struct dentry *dentry;
        int error;
 
-       pr_debug("debugfs: creating file '%s'\n",name);
+       pr_debug("creating file '%s'\n", name);
 
        if (IS_ERR(parent))
                return parent;
--

2.22.0