user namespace: add the framework
[linux-2.6.git] / include / linux / debugfs.h
1 /*
2  *  debugfs.h - a tiny little debug file system
3  *
4  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5  *  Copyright (C) 2004 IBM Inc.
6  *
7  *      This program is free software; you can redistribute it and/or
8  *      modify it under the terms of the GNU General Public License version
9  *      2 as published by the Free Software Foundation.
10  *
11  *  debugfs is for people to use instead of /proc or /sys.
12  *  See Documentation/DocBook/kernel-api for more details.
13  */
14
15 #ifndef _DEBUGFS_H_
16 #define _DEBUGFS_H_
17
18 #include <linux/fs.h>
19
20 #include <linux/types.h>
21
22 struct file_operations;
23
24 struct debugfs_blob_wrapper {
25         void *data;
26         unsigned long size;
27 };
28
29 #if defined(CONFIG_DEBUG_FS)
30 struct dentry *debugfs_create_file(const char *name, mode_t mode,
31                                    struct dentry *parent, void *data,
32                                    const struct file_operations *fops);
33
34 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
35
36 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
37                                       const char *dest);
38
39 void debugfs_remove(struct dentry *dentry);
40
41 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
42                 struct dentry *new_dir, const char *new_name);
43
44 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
45                                  struct dentry *parent, u8 *value);
46 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
47                                   struct dentry *parent, u16 *value);
48 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
49                                   struct dentry *parent, u32 *value);
50 struct dentry *debugfs_create_u64(const char *name, mode_t mode,
51                                   struct dentry *parent, u64 *value);
52 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
53                                   struct dentry *parent, u32 *value);
54
55 struct dentry *debugfs_create_blob(const char *name, mode_t mode,
56                                   struct dentry *parent,
57                                   struct debugfs_blob_wrapper *blob);
58 #else
59
60 #include <linux/err.h>
61
62 /* 
63  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
64  * so users have a chance to detect if there was a real error or not.  We don't
65  * want to duplicate the design decision mistakes of procfs and devfs again.
66  */
67
68 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
69                                         struct dentry *parent, void *data,
70                                         const struct file_operations *fops)
71 {
72         return ERR_PTR(-ENODEV);
73 }
74
75 static inline struct dentry *debugfs_create_dir(const char *name,
76                                                 struct dentry *parent)
77 {
78         return ERR_PTR(-ENODEV);
79 }
80
81 static inline struct dentry *debugfs_create_symlink(const char *name,
82                                                     struct dentry *parent,
83                                                     const char *dest)
84 {
85         return ERR_PTR(-ENODEV);
86 }
87
88 static inline void debugfs_remove(struct dentry *dentry)
89 { }
90
91 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
92                 struct dentry *new_dir, char *new_name)
93 {
94         return ERR_PTR(-ENODEV);
95 }
96
97 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
98                                                struct dentry *parent,
99                                                u8 *value)
100 {
101         return ERR_PTR(-ENODEV);
102 }
103
104 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
105                                                 struct dentry *parent,
106                                                 u16 *value)
107 {
108         return ERR_PTR(-ENODEV);
109 }
110
111 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
112                                                 struct dentry *parent,
113                                                 u32 *value)
114 {
115         return ERR_PTR(-ENODEV);
116 }
117
118 static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
119                                                 struct dentry *parent,
120                                                 u64 *value)
121 {
122         return ERR_PTR(-ENODEV);
123 }
124
125 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
126                                                  struct dentry *parent,
127                                                  u32 *value)
128 {
129         return ERR_PTR(-ENODEV);
130 }
131
132 static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
133                                   struct dentry *parent,
134                                   struct debugfs_blob_wrapper *blob)
135 {
136         return ERR_PTR(-ENODEV);
137 }
138
139 #endif
140
141 #endif