Skip to contentSkip to conversation

doc: add documentation for debugfs

PATCH In review Shen Feng 3 participants 4 messages Apr 13, 2009 – Apr 16, 2009 Documentation

lore
Share & tools
lore

Shen Feng

author
#0 lore raw

PATCH 1/1 doc: add documentation for debugfs

debugfs is used as a virtual filesystem devoted to debugging information. But it's not documented in Documentation/filesystems. Add one for it. The content is mainly from
http://lwn.net/Articles/115405/

---
 Documentation/filesystems/debugfs.txt |   51 +++++++++++++++++++++++++++++++++
 1 files changed, 51 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/filesystems/debugfs.txt
Documentation/filesystems/debugfs.txt new file +51 -0
new file mode 100644
index 0000000..112cf0c
@@ -0,0 +1,51 @@
+        Debugfs - a virtual filesystem devoted to debugging information
+
+Debugfs is a virtual filesystem devoted to debugging information. Debugfs is
+intended to be a relatively easy and lightweight subsystem which gracefully
+disappears when configured out of the kernel.
+
+Traditionally debugfs is supposed to be mounted at /sys/kernel/debug with the
+following command:
+
+ # mount -t debugfs none /sys/kernel/debug/
+
+A developer wishing to use debugfs starts by creating a directory within the
+filesystem:
+
+    struct dentry *debugfs_create_dir(const char *name,
+                                      struct dentry *parent);
+
+The parent argument will usually be NULL, causing the directory to be created
+in the debugfs root. If debugfs is not configured into the system, the return
+value is -ENODEV; a NULL return, instead, indicates some other sort of error.
+
+The general-purpose function for creating a file in debugfs is:
+
+    struct dentry *debugfs_create_file(const char *name, mode_t mode,
+                                       struct dentry *parent, void *data,
+                                       struct file_operations *fops);
+
+The structure pointed to by fops should, of course, contain pointers to the
+functions which implement the actual operations on the file. In many cases,
+most of those functions can be the helpers provided by seq_file, making the
+task of exporting a file easy.
+
+Some additional helpers have been provided to make exporting a single value as
+easy as possible:
+
+    struct dentry *debugfs_create_u8(const char *name, mode_t mode,
+                                     struct dentry *parent, u8 *value);
+    struct dentry *debugfs_create_u16(const char *name, mode_t mode,
+                                      struct dentry *parent, u16 *value);
+    struct dentry *debugfs_create_u32(const char *name, mode_t mode,
+                                      struct dentry *parent, u32 *value);
+    struct dentry *debugfs_create_bool(const char *name, mode_t mode,
+                                       struct dentry *parent, u32 *value);
+
+Debugfs does not automatically clean up files when a module shuts down, so,
+for every file or directory created with the above functions, there must be a
+call to:
+
+    void debugfs_remove(struct dentry *dentry);
+
+See Documentation/DocBook/filesystems for more details.
Signature · 1 line
1.6.0.6
#1 lore raw
Quoted 5 lines · On Mon, 13 Apr 2009 15:12:13 +0800 Shen Feng <[email protected]> wrote:

debugfs is used as a virtual filesystem devoted to debugging information. But it's not documented in Documentation/filesystems. Add one for it. The content is mainly from
http://lwn.net/Articles/115405/

We should ask for Jon's permission, please?

That document is from 2004(!). Did anyone check that it's still correct?

maintainer
#2 lore raw
Quoted 1 line · On Wed, 15 Apr 2009 15:55:28 -0700 Andrew Morton <[email protected]>…

We should ask for Jon's permission, please?

No worries. Feel free to put my:

onto it.

Quoted 1 line

That document is from 2004(!). Did anyone check that it's still correct?

Seems unlikely, doesn't it? Even if it's correct, it may well not be complete. I'll try to take a look at it tomorrow.

jon

author
#3 lore raw
Quoted 7 lines · Jonathan Corbet
Quoted 1 line · On Wed, 15 Apr 2009 15:55:28 -0700 Andrew Morton <[email protected]>…

We should ask for Jon's permission, please?

No worries. Feel free to put my:

Quoted 8 lines

onto it.

Quoted 1 line

That document is from 2004(!). Did anyone check that it's still correct?

Seems unlikely, doesn't it? Even if it's correct, it may well not be complete. I'll try to take a look at it tomorrow.

It's not complete.
A complete API can be found at Documentation/DocBook/filesystems which is generated by kernel-doc. So I do not update it.

I also found another another virtual filesystem securityfs which is not documented. A good candidate is from here.
http://lwn.net/Articles/153366/

Quoted 4 lines

jon