Release 4.15 include/linux/debugfs.h

// SPDX-License-Identifier: GPL-2.0
/*
 *  debugfs.h - a tiny little debug file system
 *
 *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
 *  Copyright (C) 2004 IBM Inc.
 *
 *  debugfs is for people to use instead of /proc or /sys.
 *  See Documentation/filesystems/ for more details.
 */

#ifndef _DEBUGFS_H_

#define _DEBUGFS_H_

#include <linux/fs.h>
#include <linux/seq_file.h>

#include <linux/types.h>
#include <linux/compiler.h>

struct device;
struct file_operations;


struct debugfs_blob_wrapper {
	
void *data;
	
unsigned long size;
};


struct debugfs_reg32 {
	
char *name;
	
unsigned long offset;
};


struct debugfs_regset32 {
	
const struct debugfs_reg32 *regs;
	
int nregs;
	
void __iomem *base;
};

extern struct dentry *arch_debugfs_dir;


#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt)		\
static int __fops ## _open(struct inode *inode, struct file *file)      \
{                                                                       \
        __simple_attr_check_format(__fmt, 0ull);                        \
        return simple_attr_open(inode, file, __get, __set, __fmt);      \
}                                                                       \
static const struct file_operations __fops = {                          \
        .owner   = THIS_MODULE,                                         \
        .open    = __fops ## _open,                                     \
        .release = simple_attr_release,                                 \
        .read    = debugfs_attr_read,                                   \
        .write   = debugfs_attr_write,                                  \
        .llseek  = no_llseek,                                           \
}

#if defined(CONFIG_DEBUG_FS)

struct dentry *debugfs_lookup(const char *name, struct dentry *parent);

struct dentry *debugfs_create_file(const char *name, umode_t mode,
				   struct dentry *parent, void *data,
				   const struct file_operations *fops);
struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
				   struct dentry *parent, void *data,
				   const struct file_operations *fops);

struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops,
					loff_t file_size);

struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);

struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
				      const char *dest);


typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
struct dentry *debugfs_create_automount(const char *name,
					struct dentry *parent,
					debugfs_automount_t f,
					void *data);

void debugfs_remove(struct dentry *dentry);
void debugfs_remove_recursive(struct dentry *dentry);

const struct file_operations *debugfs_real_fops(const struct file *filp);

int debugfs_file_get(struct dentry *dentry);
void debugfs_file_put(struct dentry *dentry);

ssize_t debugfs_attr_read(struct file *file, char __user *buf,
			size_t len, loff_t *ppos);
ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
			size_t len, loff_t *ppos);

struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
                struct dentry *new_dir, const char *new_name);

struct dentry *debugfs_create_u8(const char *name, umode_t mode,
				 struct dentry *parent, u8 *value);
struct dentry *debugfs_create_u16(const char *name, umode_t mode,
				  struct dentry *parent, u16 *value);
struct dentry *debugfs_create_u32(const char *name, umode_t mode,
				  struct dentry *parent, u32 *value);
struct dentry *debugfs_create_u64(const char *name, umode_t mode,
				  struct dentry *parent, u64 *value);
struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
				    struct dentry *parent, unsigned long *value);
struct dentry *debugfs_create_x8(const char *name, umode_t mode,
				 struct dentry *parent, u8 *value);
struct dentry *debugfs_create_x16(const char *name, umode_t mode,
				  struct dentry *parent, u16 *value);
struct dentry *debugfs_create_x32(const char *name, umode_t mode,
				  struct dentry *parent, u32 *value);
struct dentry *debugfs_create_x64(const char *name, umode_t mode,
				  struct dentry *parent, u64 *value);
struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
				     struct dentry *parent, size_t *value);
struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
				     struct dentry *parent, atomic_t *value);
struct dentry *debugfs_create_bool(const char *name, umode_t mode,
				  struct dentry *parent, bool *value);

struct dentry *debugfs_create_blob(const char *name, umode_t mode,
				  struct dentry *parent,
				  struct debugfs_blob_wrapper *blob);

struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
				     struct dentry *parent,
				     struct debugfs_regset32 *regset);

void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
			  int nregs, void __iomem *base, char *prefix);

struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
					struct dentry *parent,
					u32 *array, u32 elements);

struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
					   struct dentry *parent,
					   int (*read_fn)(struct seq_file *s,
							  void *data));

bool debugfs_initialized(void);

ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
			       size_t count, loff_t *ppos);

ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
				size_t count, loff_t *ppos);

#else

#include <linux/err.h>

/*
 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
 * so users have a chance to detect if there was a real error or not.  We don't
 * want to duplicate the design decision mistakes of procfs and devfs again.
 */



static inline struct dentry *debugfs_lookup(const char *name,
					    struct dentry *parent)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Omar Sandoval
26
100.00%
1
100.00%
Total
26
100.00%
1
100.00%



static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
37
94.87%
1
33.33%
Jean Delvare
1
2.56%
1
33.33%
Al Viro
1
2.56%
1
33.33%
Total
39
100.00%
3
100.00%



static inline struct dentry *debugfs_create_file_unsafe(const char *name,
					umode_t mode, struct dentry *parent,
					void *data,
					const struct file_operations *fops)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Viresh Kumar
39
100.00%
1
100.00%
Total
39
100.00%
1
100.00%



static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops,
					loff_t file_size)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Howells
42
100.00%
1
100.00%
Total
42
100.00%
1
100.00%



static inline struct dentry *debugfs_create_dir(const char *name,
						struct dentry *parent)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
26
100.00%
1
100.00%
Total
26
100.00%
1
100.00%



static inline struct dentry *debugfs_create_symlink(const char *name,
						    struct dentry *parent,
						    const char *dest)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Peter Oberparleiter
31
100.00%
1
100.00%
Total
31
100.00%
1
100.00%


static inline struct dentry *debugfs_create_automount(const char *name,
					struct dentry *parent,
					struct vfsmount *(*f)(void *),
					void *data)
{
	return ERR_PTR(-ENODEV);
}



static inline void debugfs_remove(struct dentry *dentry)
{ }

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
11
100.00%
1
100.00%
Total
11
100.00%
1
100.00%



static inline void debugfs_remove_recursive(struct dentry *dentry)
{ }

Contributors
Person
Tokens
Prop
Commits
CommitProp
Håvard Skinnemoen
11
100.00%
1
100.00%
Total
11
100.00%
1
100.00%

const struct file_operations *debugfs_real_fops(const struct file *filp);



static inline int debugfs_file_get(struct dentry *dentry)
{
	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Nicolai Stange
15
100.00%
1
100.00%
Total
15
100.00%
1
100.00%



static inline void debugfs_file_put(struct dentry *dentry)
{ }

Contributors
Person
Tokens
Prop
Commits
CommitProp
Nicolai Stange
11
100.00%
1
100.00%
Total
11
100.00%
1
100.00%



static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
					size_t len, loff_t *ppos)
{
	return -ENODEV;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Arnd Bergmann
23
82.14%
1
50.00%
Nicolai Stange
5
17.86%
1
50.00%
Total
28
100.00%
2
100.00%



static inline ssize_t debugfs_attr_write(struct file *file,
					const char __user *buf,
					size_t len, loff_t *ppos)
{
	return -ENODEV;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Arnd Bergmann
29
100.00%
1
100.00%
Total
29
100.00%
1
100.00%



static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
                struct dentry *new_dir, char *new_name)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Jan Kara
35
100.00%
1
100.00%
Total
35
100.00%
1
100.00%



static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
					       struct dentry *parent,
					       u8 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
32
96.97%
1
50.00%
Al Viro
1
3.03%
1
50.00%
Total
33
100.00%
2
100.00%



static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
						struct dentry *parent,
						u16 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
31
93.94%
1
33.33%
Michal Ostrowski
1
3.03%
1
33.33%
Al Viro
1
3.03%
1
33.33%
Total
33
100.00%
3
100.00%



static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
						struct dentry *parent,
						u32 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
31
93.94%
1
33.33%
Michal Ostrowski
1
3.03%
1
33.33%
Al Viro
1
3.03%
1
33.33%
Total
33
100.00%
3
100.00%



static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
						struct dentry *parent,
						u64 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Michael Ellerman
32
96.97%
1
50.00%
Al Viro
1
3.03%
1
50.00%
Total
33
100.00%
2
100.00%



static inline struct dentry *debugfs_create_ulong(const char *name,
						umode_t mode,
						struct dentry *parent,
						unsigned long *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Viresh Kumar
34
100.00%
1
100.00%
Total
34
100.00%
1
100.00%



static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
					       struct dentry *parent,
					       u8 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Robin Getz
32
96.97%
1
50.00%
Al Viro
1
3.03%
1
50.00%
Total
33
100.00%
2
100.00%



static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
						struct dentry *parent,
						u16 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Robin Getz
32
96.97%
1
50.00%
Al Viro
1
3.03%
1
50.00%
Total
33
100.00%
2
100.00%



static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
						struct dentry *parent,
						u32 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Robin Getz
23
69.70%
1
33.33%
Johannes Berg
9
27.27%
1
33.33%
Al Viro
1
3.03%
1
33.33%
Total
33
100.00%
3
100.00%



static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
						struct dentry *parent,
						u64 *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Johannes Berg
24
72.73%
1
50.00%
Robin Getz
9
27.27%
1
50.00%
Total
33
100.00%
2
100.00%



static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
				     struct dentry *parent,
				     size_t *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Iñaky Pérez-González
30
90.91%
1
33.33%
Linus Torvalds
2
6.06%
1
33.33%
Al Viro
1
3.03%
1
33.33%
Total
33
100.00%
3
100.00%



static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
				     struct dentry *parent, atomic_t *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Weijie Yang
33
100.00%
1
100.00%
Total
33
100.00%
1
100.00%



static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
						 struct dentry *parent,
						 bool *value)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
30
90.91%
1
25.00%
Al Viro
1
3.03%
1
25.00%
Andrew Morton
1
3.03%
1
25.00%
Viresh Kumar
1
3.03%
1
25.00%
Total
33
100.00%
4
100.00%



static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
				  struct dentry *parent,
				  struct debugfs_blob_wrapper *blob)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Michael Ellerman
33
97.06%
1
50.00%
Al Viro
1
2.94%
1
50.00%
Total
34
100.00%
2
100.00%



static inline struct dentry *debugfs_create_regset32(const char *name,
				   umode_t mode, struct dentry *parent,
				   struct debugfs_regset32 *regset)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Alessandro Rubini
33
97.06%
1
50.00%
Al Viro
1
2.94%
1
50.00%
Total
34
100.00%
2
100.00%



static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
			 int nregs, void __iomem *base, char *prefix)
{
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Weijie Yang
27
93.10%
1
50.00%
Joe Perches
2
6.90%
1
50.00%
Total
29
100.00%
2
100.00%



static inline bool debugfs_initialized(void)
{
	return false;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Frédéric Weisbecker
12
100.00%
1
100.00%
Total
12
100.00%
1
100.00%



static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
					struct dentry *parent,
					u32 *array, u32 elements)
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Srivatsa Vaddagiri
36
100.00%
1
100.00%
Total
36
100.00%
1
100.00%



static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
							 const char *name,
							 struct dentry *parent,
					   int (*read_fn)(struct seq_file *s,
							  void *data))
{
	return ERR_PTR(-ENODEV);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Arend Van Spriel
47
100.00%
1
100.00%
Total
47
100.00%
1
100.00%



static inline ssize_t debugfs_read_file_bool(struct file *file,
					     char __user *user_buf,
					     size_t count, loff_t *ppos)
{
	return -ENODEV;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Richard Fitzgerald
28
100.00%
1
100.00%
Total
28
100.00%
1
100.00%



static inline ssize_t debugfs_write_file_bool(struct file *file,
					      const char __user *user_buf,
					      size_t count, loff_t *ppos)
{
	return -ENODEV;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Richard Fitzgerald
29
100.00%
1
100.00%
Total
29
100.00%
1
100.00%

#endif

#endif
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
Greg Kroah-Hartman
357
18.63%
3
6.00%
Robin Getz
162
8.46%
1
2.00%
Nicolai Stange
137
7.15%
5
10.00%
Michael Ellerman
123
6.42%
2
4.00%
Alessandro Rubini
116
6.05%
2
4.00%
Richard Fitzgerald
100
5.22%
1
2.00%
Viresh Kumar
99
5.17%
3
6.00%
Arend Van Spriel
88
4.59%
2
4.00%
Arnd Bergmann
78
4.07%
2
4.00%
David Howells
74
3.86%
1
2.00%
Srivatsa Vaddagiri
62
3.24%
1
2.00%
Jan Kara
61
3.18%
1
2.00%
Weijie Yang
60
3.13%
1
2.00%
Peter Oberparleiter
52
2.71%
1
2.00%
Iñaky Pérez-González
52
2.71%
2
4.00%
Omar Sandoval
42
2.19%
1
2.00%
Jiaxing Wang
42
2.19%
1
2.00%
Al Viro
37
1.93%
3
6.00%
Johannes Berg
33
1.72%
1
2.00%
Eric W. Biedermann
28
1.46%
1
2.00%
Seth Jennings
23
1.20%
1
2.00%
Huang Ying
22
1.15%
1
2.00%
Håvard Skinnemoen
20
1.04%
1
2.00%
Frédéric Weisbecker
18
0.94%
1
2.00%
Roland Dreier
9
0.47%
1
2.00%
Venkatesh Pallipadi
6
0.31%
1
2.00%
Jeff Garzik
3
0.16%
1
2.00%
Joe Perches
3
0.16%
1
2.00%
Michal Ostrowski
2
0.10%
1
2.00%
Linus Torvalds
2
0.10%
1
2.00%
Arjan van de Ven
1
0.05%
1
2.00%
Andrew Morton
1
0.05%
1
2.00%
Geliang Tang
1
0.05%
1
2.00%
Jean Delvare
1
0.05%
1
2.00%
Felipe Balbi
1
0.05%
1
2.00%
Total
1916
100.00%
50
100.00%
Directory: include/linux

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.