proc: Delete create_proc_read_entry()
[~shefty/rdma-dev.git] / include / linux / proc_fs.h
1 #ifndef _LINUX_PROC_FS_H
2 #define _LINUX_PROC_FS_H
3
4 #include <linux/slab.h>
5 #include <linux/fs.h>
6 #include <linux/spinlock.h>
7 #include <linux/magic.h>
8 #include <linux/atomic.h>
9
10 struct net;
11 struct completion;
12 struct mm_struct;
13
14 /*
15  * The proc filesystem constants/structures
16  */
17
18 /*
19  * Offset of the first process in the /proc root directory..
20  */
21 #define FIRST_PROCESS_ENTRY 256
22
23 /* Worst case buffer size needed for holding an integer. */
24 #define PROC_NUMBUF 13
25
26 /*
27  * We always define these enumerators
28  */
29
30 enum {
31         PROC_ROOT_INO           = 1,
32         PROC_IPC_INIT_INO       = 0xEFFFFFFFU,
33         PROC_UTS_INIT_INO       = 0xEFFFFFFEU,
34         PROC_USER_INIT_INO      = 0xEFFFFFFDU,
35         PROC_PID_INIT_INO       = 0xEFFFFFFCU,
36 };
37
38 /*
39  * This is not completely implemented yet. The idea is to
40  * create an in-memory tree (like the actual /proc filesystem
41  * tree) of these proc_dir_entries, so that we can dynamically
42  * add new files to /proc.
43  *
44  * The "next" pointer creates a linked list of one /proc directory,
45  * while parent/subdir create the directory structure (every
46  * /proc file has a parent, but "subdir" is NULL for all
47  * non-directory entries).
48  */
49
50 struct proc_dir_entry {
51         unsigned int low_ino;
52         umode_t mode;
53         nlink_t nlink;
54         kuid_t uid;
55         kgid_t gid;
56         loff_t size;
57         const struct inode_operations *proc_iops;
58         const struct file_operations *proc_fops;
59         struct proc_dir_entry *next, *parent, *subdir;
60         void *data;
61         atomic_t count;         /* use count */
62         atomic_t in_use;        /* number of callers into module in progress; */
63                         /* negative -> it's going away RSN */
64         struct completion *pde_unload_completion;
65         struct list_head pde_openers;   /* who did ->open, but not ->release */
66         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
67         u8 namelen;
68         char name[];
69 };
70
71 enum kcore_type {
72         KCORE_TEXT,
73         KCORE_VMALLOC,
74         KCORE_RAM,
75         KCORE_VMEMMAP,
76         KCORE_OTHER,
77 };
78
79 struct kcore_list {
80         struct list_head list;
81         unsigned long addr;
82         size_t size;
83         int type;
84 };
85
86 struct vmcore {
87         struct list_head list;
88         unsigned long long paddr;
89         unsigned long long size;
90         loff_t offset;
91 };
92
93 #ifdef CONFIG_PROC_FS
94
95 extern void proc_root_init(void);
96
97 void proc_flush_task(struct task_struct *task);
98
99 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
100                                 struct proc_dir_entry *parent,
101                                 const struct file_operations *proc_fops,
102                                 void *data);
103 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
104 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
105
106 struct pid_namespace;
107
108 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
109 extern void pid_ns_release_proc(struct pid_namespace *ns);
110
111 /*
112  * proc_tty.c
113  */
114 struct tty_driver;
115 #ifdef CONFIG_TTY
116 extern void proc_tty_init(void);
117 #else
118 static inline void proc_tty_init(void)
119 { }
120 #endif
121 extern void proc_tty_register_driver(struct tty_driver *driver);
122 extern void proc_tty_unregister_driver(struct tty_driver *driver);
123
124 /*
125  * proc_devtree.c
126  */
127 #ifdef CONFIG_PROC_DEVICETREE
128 struct device_node;
129 struct property;
130 extern void proc_device_tree_init(void);
131 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
132 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
133 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
134                                          struct property *prop);
135 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
136                                          struct property *newprop,
137                                          struct property *oldprop);
138 #endif /* CONFIG_PROC_DEVICETREE */
139
140 extern struct proc_dir_entry *proc_symlink(const char *,
141                 struct proc_dir_entry *, const char *);
142 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
143 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
144                         struct proc_dir_entry *parent);
145
146 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
147         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
148 {
149         return proc_create_data(name, mode, parent, proc_fops, NULL);
150 }
151  
152 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
153         struct proc_dir_entry *parent);
154
155 extern struct file *proc_ns_fget(int fd);
156 extern bool proc_ns_inode(struct inode *inode);
157
158 extern int proc_alloc_inum(unsigned int *pino);
159 extern void proc_free_inum(unsigned int inum);
160 #else
161
162 static inline void proc_flush_task(struct task_struct *task)
163 {
164 }
165
166 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
167
168 static inline struct proc_dir_entry *proc_create_data(const char *name,
169         umode_t mode, struct proc_dir_entry *parent,
170         const struct file_operations *proc_fops, void *data)
171 {
172         return NULL;
173 }
174 #define remove_proc_entry(name, parent) do {} while (0)
175 #define remove_proc_subtree(name, parent) do {} while (0)
176
177 static inline struct proc_dir_entry *proc_symlink(const char *name,
178                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
179 static inline struct proc_dir_entry *proc_mkdir(const char *name,
180         struct proc_dir_entry *parent) {return NULL;}
181 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
182         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
183
184 struct tty_driver;
185 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
186 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
187
188 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
189 {
190         return 0;
191 }
192
193 static inline void pid_ns_release_proc(struct pid_namespace *ns)
194 {
195 }
196
197 static inline struct file *proc_ns_fget(int fd)
198 {
199         return ERR_PTR(-EINVAL);
200 }
201
202 static inline bool proc_ns_inode(struct inode *inode)
203 {
204         return false;
205 }
206
207 static inline int proc_alloc_inum(unsigned int *inum)
208 {
209         *inum = 1;
210         return 0;
211 }
212 static inline void proc_free_inum(unsigned int inum)
213 {
214 }
215 #endif /* CONFIG_PROC_FS */
216
217 #if !defined(CONFIG_PROC_KCORE)
218 static inline void
219 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
220 {
221 }
222 #else
223 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
224 #endif
225
226 struct nsproxy;
227 struct proc_ns_operations {
228         const char *name;
229         int type;
230         void *(*get)(struct task_struct *task);
231         void (*put)(void *ns);
232         int (*install)(struct nsproxy *nsproxy, void *ns);
233         unsigned int (*inum)(void *ns);
234 };
235 extern const struct proc_ns_operations netns_operations;
236 extern const struct proc_ns_operations utsns_operations;
237 extern const struct proc_ns_operations ipcns_operations;
238 extern const struct proc_ns_operations pidns_operations;
239 extern const struct proc_ns_operations userns_operations;
240 extern const struct proc_ns_operations mntns_operations;
241
242 union proc_op {
243         int (*proc_get_link)(struct dentry *, struct path *);
244         int (*proc_read)(struct task_struct *task, char *page);
245         int (*proc_show)(struct seq_file *m,
246                 struct pid_namespace *ns, struct pid *pid,
247                 struct task_struct *task);
248 };
249
250 struct ctl_table_header;
251 struct ctl_table;
252
253 struct proc_inode {
254         struct pid *pid;
255         int fd;
256         union proc_op op;
257         struct proc_dir_entry *pde;
258         struct ctl_table_header *sysctl;
259         struct ctl_table *sysctl_entry;
260         void *ns;
261         const struct proc_ns_operations *ns_ops;
262         struct inode vfs_inode;
263 };
264
265 static inline struct proc_inode *PROC_I(const struct inode *inode)
266 {
267         return container_of(inode, struct proc_inode, vfs_inode);
268 }
269
270 static inline struct proc_dir_entry *PDE(const struct inode *inode)
271 {
272         return PROC_I(inode)->pde;
273 }
274
275 static inline void *PDE_DATA(const struct inode *inode)
276 {
277         return PROC_I(inode)->pde->data;
278 }
279
280 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
281 {
282         return pde->parent->data;
283 }
284
285 #include <linux/signal.h>
286
287 void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
288 #endif /* _LINUX_PROC_FS_H */