debugfs: Add a helper to export atomic64_t values
cover debugfs: Add a helper to export atomic64_t values
Here's my story:
Once upon a time, there lived a developer that wanted to export an atomic64_t value to userspace using debugfs to help with debugging. But that developer found there was no helper function to do so and was very sad.
The End.
Yeah, it's a sad story. Here's my patch, merge me maybe?
Anand K Mistry (1):
debugfs: Add a helper to export atomic64_t values
fs/debugfs/file.c | 37 +++++++++++++++++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 43 insertions(+)
Signature · 1 line
2.29.1.341.ge80a0c044ae-goog
PATCH 1/1 debugfs: Add a helper to export atomic64_t values
This mirrors support for exporting atomic_t values.
---
fs/debugfs/file.c | 37 +++++++++++++++++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 43 insertions(+)
fs/debugfs/file.c +37 -0
@@ -770,6 +770,43 @@ void debugfs_create_atomic_t(const char *name, umode_t mode, }EXPORT_SYMBOL_GPL (debugfs_create_atomic_t); +static int debugfs_atomic64_t_set (void *data,u64 val) +{ +atomic64_set ((atomic64_t *)data, val); +return 0 ; +} +static int debugfs_atomic64_t_get (void *data,u64 *val) +{ + *val =atomic64_read ((atomic64_t *)data); +return 0 ; +} +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t, debugfs_atomic64_t_get, + debugfs_atomic64_t_set,"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_ro, debugfs_atomic64_t_get,NULL , +"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_wo,NULL , debugfs_atomic64_t_set, +"%lld\n" ); + +/** +* debugfs_create_atomic64_t - create a debugfs file that is used to read and +* write an atomic64_t value +* @name: a pointer to a string containing the name of the file to create. +* @mode: the permission that the file should have +* @parent: a pointer to the parent dentry for this file. This should be a +* directory dentry if set. If this parameter is %NULL, then the +* file will be created in the root of the debugfs filesystem. +* @value: a pointer to the variable that the file should read to and write +* from. +*/ +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ +debugfs_create_mode_unsafe (name, mode, parent, value, + &fops_atomic64_t, &fops_atomic64_t_ro, + &fops_atomic64_t_wo); +} +EXPORT_SYMBOL_GPL (debugfs_create_atomic64_t); +ssize_t debugfs_read_file_bool (struct file *file,char __user *user_buf,size_t count,loff_t *ppos) {
include/linux/debugfs.h +6 -0
@@ -126,6 +126,8 @@ void debugfs_create_size_t(const char *name, umode_t mode, struct dentry *parent, size_t *value);void debugfs_create_atomic_t (const char *name,umode_t mode,struct dentry *parent,atomic_t *value); +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value);struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value);
@@ -291,6 +293,10 @@ static inline void debugfs_create_atomic_t(const char *name, umode_t mode, atomic_t *value) { } +static inline void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ } +static inline struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value)
Signature · 1 line
2.29.1.341.ge80a0c044ae-goog
Greg Kroah-Hartman
maintainerQuoted 72 lines · Anand K Mistry
This mirrors support for exporting
atomic_tvalues.Signed-off-by Anand K Mistry <[email protected]>---
fs/debugfs/file.c | 37 +++++++++++++++++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 43 insertions(+)fs/debugfs/file.c +37
-0@@ -770,6 +770,43 @@ void debugfs_create_atomic_t(const char *name, umode_t mode, }EXPORT_SYMBOL_GPL (debugfs_create_atomic_t); +static int debugfs_atomic64_t_set (void *data,u64 val) +{ +atomic64_set ((atomic64_t *)data, val); +return 0 ; +} +static int debugfs_atomic64_t_get (void *data,u64 *val) +{ + *val =atomic64_read ((atomic64_t *)data); +return 0 ; +} +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t, debugfs_atomic64_t_get, + debugfs_atomic64_t_set,"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_ro, debugfs_atomic64_t_get,NULL , +"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_wo,NULL , debugfs_atomic64_t_set, +"%lld\n" ); + +/** +* debugfs_create_atomic64_t - create a debugfs file that is used to read and +* write an atomic64_t value +* @name: a pointer to a string containing the name of the file to create. +* @mode: the permission that the file should have +* @parent: a pointer to the parent dentry for this file. This should be a +* directory dentry if set. If this parameter is %NULL, then the +* file will be created in the root of the debugfs filesystem. +* @value: a pointer to the variable that the file should read to and write +* from. +*/ +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ +debugfs_create_mode_unsafe (name, mode, parent, value, + &fops_atomic64_t, &fops_atomic64_t_ro, + &fops_atomic64_t_wo); +} +EXPORT_SYMBOL_GPL (debugfs_create_atomic64_t); +ssize_t debugfs_read_file_bool (struct file *file,char __user *user_buf,size_t count,loff_t *ppos) {include/linux/debugfs.h +2
-0@@ -126,6 +126,8 @@ void debugfs_create_size_t(const char *name, umode_t mode, struct dentry *parent, size_t *value);void debugfs_create_atomic_t (const char *name,umode_t mode,struct dentry *parent,atomic_t *value); +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value);struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value);
include/linux/debugfs.h static inline void debugfs_create_atomic_t(const char *name, umode_t mode, · line 302
Quoted 10 lines
include/linux/debugfs.h +4
-0@@ -291,6 +293,10 @@ static inline void debugfs_create_atomic_t(const char *name, umode_t mode, atomic_t *value) { } +static inline void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ } +static inline struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value)
Looks good, but where is the user of this code? I can't add new apis without a user.
And are you _SURE_ you want to be using an atomic64_t in the first place? We are starting to reduce the "raw" usage of atomic variables as almost no one needs them, they should be using something else instead, or just a u64 as atomics are not needed for simple statistics.
thanks,
greg k-h
Quoted 77 lines · Greg Kroah-Hartman
Quoted 75 lines · Anand K Mistry
This mirrors support for exporting
atomic_tvalues.Signed-off-by Anand K Mistry <[email protected]>---
fs/debugfs/file.c | 37 +++++++++++++++++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 43 insertions(+)fs/debugfs/file.c +37
-0@@ -770,6 +770,43 @@ void debugfs_create_atomic_t(const char *name, umode_t mode, }EXPORT_SYMBOL_GPL (debugfs_create_atomic_t); +static int debugfs_atomic64_t_set (void *data,u64 val) +{ +atomic64_set ((atomic64_t *)data, val); +return 0 ; +} +static int debugfs_atomic64_t_get (void *data,u64 *val) +{ + *val =atomic64_read ((atomic64_t *)data); +return 0 ; +} +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t, debugfs_atomic64_t_get, + debugfs_atomic64_t_set,"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_ro, debugfs_atomic64_t_get,NULL , +"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_wo,NULL , debugfs_atomic64_t_set, +"%lld\n" ); + +/** +* debugfs_create_atomic64_t - create a debugfs file that is used to read and +* write an atomic64_t value +* @name: a pointer to a string containing the name of the file to create. +* @mode: the permission that the file should have +* @parent: a pointer to the parent dentry for this file. This should be a +* directory dentry if set. If this parameter is %NULL, then the +* file will be created in the root of the debugfs filesystem. +* @value: a pointer to the variable that the file should read to and write +* from. +*/ +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ +debugfs_create_mode_unsafe (name, mode, parent, value, + &fops_atomic64_t, &fops_atomic64_t_ro, + &fops_atomic64_t_wo); +} +EXPORT_SYMBOL_GPL (debugfs_create_atomic64_t); +ssize_t debugfs_read_file_bool (struct file *file,char __user *user_buf,size_t count,loff_t *ppos) {include/linux/debugfs.h +2
-0@@ -126,6 +126,8 @@ void debugfs_create_size_t(const char *name, umode_t mode, struct dentry *parent, size_t *value);void debugfs_create_atomic_t (const char *name,umode_t mode,struct dentry *parent,atomic_t *value); +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value);struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value);@@ -291,6 +293,10 @@ static inline void debugfs_create_atomic_t(const char *name, umode_t mode, atomic_t *value) { }
Quoted 10 lines
include/linux/debugfs.h static inline void debugfs_create_atomic_t(const char *name, umode_t mode, · line 302
Quoted 7 lines
include/linux/debugfs.h +4
-0+static inline void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ } +static inline struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value)Looks good, but where is the user of this code? I can't add new apis without a user.
Fair enough. Right now, the user is just some local debugging/performance measuring which will never be upstreamed. Happy to let this drop.
Quoted 5 lines
And are you _SURE_ you want to be using an
atomic64_tin the first place? We are starting to reduce the "raw" usage of atomic variables as almost no one needs them, they should be using something else instead, or just a u64 as atomics are not needed for simple statistics.
I understand, and would generally never use atomics in real code. I used an atomic since I wanted accuracy
(for some of the benchmarks I want to run) but can't use anything that blocks (spinlock/mutex) since
the code is somewhere inside the scheduler.
Quoted 4 lines
thanks,
greg k-h
Signature · 3 lines
Anand K. Mistry Software Engineer Google Australia
Greg Kroah-Hartman
maintainerQuoted 90 lines · Anand K. Mistry
Quoted 77 lines · Greg Kroah-Hartman
Quoted 75 lines · Anand K Mistry
This mirrors support for exporting
atomic_tvalues.Signed-off-by Anand K Mistry <[email protected]>---
fs/debugfs/file.c | 37 +++++++++++++++++++++++++++++++++++++ include/linux/debugfs.h | 6 ++++++ 2 files changed, 43 insertions(+)fs/debugfs/file.c +37
-0@@ -770,6 +770,43 @@ void debugfs_create_atomic_t(const char *name, umode_t mode, }EXPORT_SYMBOL_GPL (debugfs_create_atomic_t); +static int debugfs_atomic64_t_set (void *data,u64 val) +{ +atomic64_set ((atomic64_t *)data, val); +return 0 ; +} +static int debugfs_atomic64_t_get (void *data,u64 *val) +{ + *val =atomic64_read ((atomic64_t *)data); +return 0 ; +} +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t, debugfs_atomic64_t_get, + debugfs_atomic64_t_set,"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_ro, debugfs_atomic64_t_get,NULL , +"%lld\n" ); +DEFINE_DEBUGFS_ATTRIBUTE (fops_atomic64_t_wo,NULL , debugfs_atomic64_t_set, +"%lld\n" ); + +/** +* debugfs_create_atomic64_t - create a debugfs file that is used to read and +* write an atomic64_t value +* @name: a pointer to a string containing the name of the file to create. +* @mode: the permission that the file should have +* @parent: a pointer to the parent dentry for this file. This should be a +* directory dentry if set. If this parameter is %NULL, then the +* file will be created in the root of the debugfs filesystem. +* @value: a pointer to the variable that the file should read to and write +* from. +*/ +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ +debugfs_create_mode_unsafe (name, mode, parent, value, + &fops_atomic64_t, &fops_atomic64_t_ro, + &fops_atomic64_t_wo); +} +EXPORT_SYMBOL_GPL (debugfs_create_atomic64_t); +ssize_t debugfs_read_file_bool (struct file *file,char __user *user_buf,size_t count,loff_t *ppos) {include/linux/debugfs.h +2
-0@@ -126,6 +126,8 @@ void debugfs_create_size_t(const char *name, umode_t mode, struct dentry *parent, size_t *value);void debugfs_create_atomic_t (const char *name,umode_t mode,struct dentry *parent,atomic_t *value); +void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value);struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value);@@ -291,6 +293,10 @@ static inline void debugfs_create_atomic_t(const char *name, umode_t mode, atomic_t *value) { }Quoted 10 lines
include/linux/debugfs.h static inline void debugfs_create_atomic_t(const char *name, umode_t mode, · line 302
Quoted 7 lines
include/linux/debugfs.h +4
-0+static inline void debugfs_create_atomic64_t (const char *name,umode_t mode, +struct dentry *parent,atomic64_t *value) +{ } +static inline struct dentry *debugfs_create_bool (const char *name,umode_t mode,struct dentry *parent,bool *value)Looks good, but where is the user of this code? I can't add new apis without a user.
Quoted 3 lines
Fair enough. Right now, the user is just some local debugging/performance measuring which will never be upstreamed. Happy to let this drop.
Now dropped!
Quoted 9 lines
Quoted 4 lines
And are you _SURE_ you want to be using an
atomic64_tin the first place? We are starting to reduce the "raw" usage of atomic variables as almost no one needs them, they should be using something else instead, or just a u64 as atomics are not needed for simple statistics.I understand, and would generally never use atomics in real code. I used an atomic since I wanted accuracy (for some of the benchmarks I want to run) but can't use anything that blocks (spinlock/mutex) since the code is somewhere inside the scheduler.
You can't be "accurate" for a single value from a single file read by userspace as you don't know if it changed right after you read the value :)
Again, people abuse atomic values thinking they are something they really aren't...
thanks,
greg k-h