debugfs: add debugfs_lookup_and_remove()
Subsystems (2)
Greg Kroah-Hartman
maintainerPATCH 1/2 debugfs: add debugfs_lookup_and_remove()
There is a very common pattern of using debugfs_remove(debufs_lookup(..)) which results in a dentry leak of the dentry that was looked up. Instead of having to open-code the correct pattern of calling dput() on the dentry, create debugfs_lookup_and_remove() to handle this pattern automatically and properly without any memory leaks.
--- fs/debugfs/inode.c | 22 ++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 28 insertions(+)
fs/debugfs/inode.c +22 -0
@@ -744,6 +744,28 @@ void debugfs_remove(struct dentry *dentry) }EXPORT_SYMBOL_GPL (debugfs_remove); +/** +* debugfs_lookup_and_remove - lookup a directory or file and recursively remove it +* @name: a pointer to a string containing the name of the item to look up. +* @parent: a pointer to the parent dentry of the item. +* +* This is the equlivant of doing something like +* debugfs_remove(debugfs_lookup(..)) but with the proper reference counting +* handled for the directory being looked up. +*/ +void debugfs_lookup_and_remove (const char *name,struct dentry *parent) +{ +struct dentry *dentry; + + dentry =debugfs_lookup (name, parent); +if (IS_ERR_OR_NULL (dentry)) +return ; + +debugfs_remove (dentry); +dput (dentry); +} +EXPORT_SYMBOL_GPL (debugfs_lookup_and_remove); +/** * debugfs_rename - rename a file/directory in the debugfs filesystem * @old_dir: a pointer to the parent dentry for the renamed object. This
include/linux/debugfs.h +6 -0
@@ -91,6 +91,8 @@ struct dentry *debugfs_create_automount(const char *name,void debugfs_remove (struct dentry *dentry);#define debugfs_remove_recursive debugfs_remove +void debugfs_lookup_and_remove (const char *name,struct dentry *parent); +const struct file_operations *debugfs_real_fops (const struct file *filp);int debugfs_file_get (struct dentry *dentry);
@@ -225,6 +227,10 @@ static inline void debugfs_remove(struct dentry *dentry)static inline void debugfs_remove_recursive (struct dentry *dentry) { } +static inline void debugfs_lookup_and_remove (const char *name, +struct dentry *parent) +{ } +const struct file_operations *debugfs_real_fops (const struct file *filp);static inline int debugfs_file_get (struct dentry *dentry)
Signature · 1 line
2.37.3
Greg Kroah-Hartman
maintainerPATCH 2/2 sched/debug: fix dentry leak in update_sched_domain_debugfs
Kuyo reports that the pattern of using debugfs_remove(debugfs_lookup()) leaks a dentry and with a hotplug stress test, the machine eventually runs out of memory.
Fix this up by using the newly created debugfs_lookup_and_remove() call instead which properly handles the dentry reference counting logic.
--- kernel/sched/debug.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/sched/debug.c +1 -1
@@ -416,7 +416,7 @@ void update_sched_domain_debugfs(void)char buf[32 ];snprintf (buf,sizeof (buf),"cpu%d" , cpu); -debugfs_remove (debugfs_lookup (buf, sd_dentry)); +debugfs_lookup_and_remove (buf, sd_dentry); d_cpu =debugfs_create_dir (buf, sd_dentry); i =0 ;
Signature · 1 line
2.37.3
Greg Kroah-Hartman
maintainerRe: [PATCH 2/2] sched/debug: fix dentry leak in update_sched_domain_debugfs
Quoted 23 lines · Greg Kroah-Hartman
Kuyo reports that the pattern of using debugfs_remove(debugfs_lookup()) leaks a dentry and with a hotplug stress test, the machine eventually runs out of memory.
Fix this up by using the newly created
debugfs_lookup_and_remove()call instead which properly handles the dentry reference counting logic.Cc Major Chen <[email protected]>Cc stable <[email protected]>Reported-by Kuyo Chang <[email protected]>Tested-by Kuyo Chang <[email protected]>Cc Ingo Molnar <[email protected]>Cc Peter Zijlstra <[email protected]>Cc Juri Lelli <[email protected]>Cc Vincent Guittot <[email protected]>Cc Dietmar Eggemann <[email protected]>Cc Steven Rostedt <[email protected]>Cc Ben Segall <[email protected]>Cc Mel Gorman <[email protected]>Cc Daniel Bristot de Oliveira <[email protected]>Cc Valentin Schneider <[email protected]>Cc Matthias Brugger <[email protected]>Signed-off-by Greg Kroah-Hartman <[email protected]>
Quoted 3 lines
--- kernel/sched/debug.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
As this needs patch 1/2 to work properly, and Kuyo has tested this out already, I'll take both of them through my driver core git tree to Linus so that we can start getting the other debugfs_lookup() leaks fixed up as well.
thanks,
greg k-h
Re: [PATCH 2/2] sched/debug: fix dentry leak in update_sched_domain_debugfs
In reply to Greg Kroah-HartmanQuoted 8 lines · Greg Kroah-Hartman
Kuyo reports that the pattern of using debugfs_remove(debugfs_lookup()) leaks a dentry and with a hotplug stress test, the machine eventually runs out of memory.
Fix this up by using the newly created
debugfs_lookup_and_remove()call instead which properly handles the dentry reference counting logic.Signed-off-by Greg Kroah-Hartman <[email protected]>
Quoted 20 lines
--- kernel/sched/debug.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)kernel/sched/debug.c +1
-1@@ -416,7 +416,7 @@ void update_sched_domain_debugfs(void)char buf[32 ];snprintf (buf,sizeof (buf),"cpu%d" , cpu); -debugfs_remove (debugfs_lookup (buf, sd_dentry)); +debugfs_lookup_and_remove (buf, sd_dentry); d_cpu =debugfs_create_dir (buf, sd_dentry); i =0 ;Signature · 1 line
2.37.3
Greg Kroah-Hartman
maintainerPATCH v2 1/2 debugfs: add debugfs_lookup_and_remove()
In reply to Greg Kroah-HartmanThere is a very common pattern of using debugfs_remove(debufs_lookup(..)) which results in a dentry leak of the dentry that was looked up. Instead of having to open-code the correct pattern of calling dput() on the dentry, create debugfs_lookup_and_remove() to handle this pattern automatically and properly without any memory leaks.
---
v2: fix up debugfs_lookup() return value check as pointed out by Al.
fs/debugfs/inode.c | 22 ++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 28 insertions(+)
fs/debugfs/inode.c +22 -0
@@ -744,6 +744,28 @@ void debugfs_remove(struct dentry *dentry) }EXPORT_SYMBOL_GPL (debugfs_remove); +/** +* debugfs_lookup_and_remove - lookup a directory or file and recursively remove it +* @name: a pointer to a string containing the name of the item to look up. +* @parent: a pointer to the parent dentry of the item. +* +* This is the equlivant of doing something like +* debugfs_remove(debugfs_lookup(..)) but with the proper reference counting +* handled for the directory being looked up. +*/ +void debugfs_lookup_and_remove (const char *name,struct dentry *parent) +{ +struct dentry *dentry; + + dentry =debugfs_lookup (name, parent); +if (!dentry) +return ; + +debugfs_remove (dentry); +dput (dentry); +} +EXPORT_SYMBOL_GPL (debugfs_lookup_and_remove); +/** * debugfs_rename - rename a file/directory in the debugfs filesystem * @old_dir: a pointer to the parent dentry for the renamed object. This
include/linux/debugfs.h +6 -0
@@ -91,6 +91,8 @@ struct dentry *debugfs_create_automount(const char *name,void debugfs_remove (struct dentry *dentry);#define debugfs_remove_recursive debugfs_remove +void debugfs_lookup_and_remove (const char *name,struct dentry *parent); +const struct file_operations *debugfs_real_fops (const struct file *filp);int debugfs_file_get (struct dentry *dentry);
@@ -225,6 +227,10 @@ static inline void debugfs_remove(struct dentry *dentry)static inline void debugfs_remove_recursive (struct dentry *dentry) { } +static inline void debugfs_lookup_and_remove (const char *name, +struct dentry *parent) +{ } +const struct file_operations *debugfs_real_fops (const struct file *filp);static inline int debugfs_file_get (struct dentry *dentry)
Signature · 1 line
2.37.3