proc: remove proc_root_driver
[linux-2.6.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 <asm/atomic.h>
9
10 struct net;
11 struct completion;
12 /*
13  * The proc filesystem constants/structures
14  */
15
16 /*
17  * Offset of the first process in the /proc root directory..
18  */
19 #define FIRST_PROCESS_ENTRY 256
20
21 /* Worst case buffer size needed for holding an integer. */
22 #define PROC_NUMBUF 13
23
24 /*
25  * We always define these enumerators
26  */
27
28 enum {
29         PROC_ROOT_INO = 1,
30 };
31
32 /*
33  * This is not completely implemented yet. The idea is to
34  * create an in-memory tree (like the actual /proc filesystem
35  * tree) of these proc_dir_entries, so that we can dynamically
36  * add new files to /proc.
37  *
38  * The "next" pointer creates a linked list of one /proc directory,
39  * while parent/subdir create the directory structure (every
40  * /proc file has a parent, but "subdir" is NULL for all
41  * non-directory entries).
42  *
43  * "get_info" is called at "read", while "owner" is used to protect module
44  * from unloading while proc_dir_entry is in use
45  */
46
47 typedef int (read_proc_t)(char *page, char **start, off_t off,
48                           int count, int *eof, void *data);
49 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
50                            unsigned long count, void *data);
51 typedef int (get_info_t)(char *, char **, off_t, int);
52
53 struct proc_dir_entry {
54         unsigned int low_ino;
55         unsigned short namelen;
56         const char *name;
57         mode_t mode;
58         nlink_t nlink;
59         uid_t uid;
60         gid_t gid;
61         loff_t size;
62         const struct inode_operations *proc_iops;
63         /*
64          * NULL ->proc_fops means "PDE is going away RSN" or
65          * "PDE is just created". In either case, e.g. ->read_proc won't be
66          * called because it's too late or too early, respectively.
67          *
68          * If you're allocating ->proc_fops dynamically, save a pointer
69          * somewhere.
70          */
71         const struct file_operations *proc_fops;
72         get_info_t *get_info;
73         struct module *owner;
74         struct proc_dir_entry *next, *parent, *subdir;
75         void *data;
76         read_proc_t *read_proc;
77         write_proc_t *write_proc;
78         atomic_t count;         /* use count */
79         int pde_users;  /* number of callers into module in progress */
80         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
81         struct completion *pde_unload_completion;
82 };
83
84 struct kcore_list {
85         struct kcore_list *next;
86         unsigned long addr;
87         size_t size;
88 };
89
90 struct vmcore {
91         struct list_head list;
92         unsigned long long paddr;
93         unsigned long long size;
94         loff_t offset;
95 };
96
97 #ifdef CONFIG_PROC_FS
98
99 extern struct proc_dir_entry proc_root;
100 extern struct proc_dir_entry *proc_root_kcore;
101
102 extern spinlock_t proc_subdir_lock;
103
104 extern void proc_root_init(void);
105 extern void proc_misc_init(void);
106
107 struct mm_struct;
108
109 void proc_flush_task(struct task_struct *task);
110 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
111 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
112 unsigned long task_vsize(struct mm_struct *);
113 int task_statm(struct mm_struct *, int *, int *, int *, int *);
114 void task_mem(struct seq_file *, struct mm_struct *);
115 void clear_refs_smap(struct mm_struct *mm);
116
117 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
118 void de_put(struct proc_dir_entry *de);
119
120 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
121                                                 struct proc_dir_entry *parent);
122 struct proc_dir_entry *proc_create(const char *name, mode_t mode,
123                                 struct proc_dir_entry *parent,
124                                 const struct file_operations *proc_fops);
125 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
126
127 extern struct vfsmount *proc_mnt;
128 struct pid_namespace;
129 extern int proc_fill_super(struct super_block *);
130 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
131
132 /*
133  * These are generic /proc routines that use the internal
134  * "struct proc_dir_entry" tree to traverse the filesystem.
135  *
136  * The /proc root directory has extended versions to take care
137  * of the /proc/<pid> subdirectories.
138  */
139 extern int proc_readdir(struct file *, void *, filldir_t);
140 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
141
142 extern const struct file_operations proc_kcore_operations;
143 extern const struct file_operations proc_kmsg_operations;
144 extern const struct file_operations ppc_htab_operations;
145
146 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
147 extern void pid_ns_release_proc(struct pid_namespace *ns);
148
149 /*
150  * proc_tty.c
151  */
152 struct tty_driver;
153 extern void proc_tty_init(void);
154 extern void proc_tty_register_driver(struct tty_driver *driver);
155 extern void proc_tty_unregister_driver(struct tty_driver *driver);
156
157 /*
158  * proc_devtree.c
159  */
160 #ifdef CONFIG_PROC_DEVICETREE
161 struct device_node;
162 struct property;
163 extern void proc_device_tree_init(void);
164 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
165 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
166 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
167                                          struct property *prop);
168 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
169                                          struct property *newprop,
170                                          struct property *oldprop);
171 #endif /* CONFIG_PROC_DEVICETREE */
172
173 extern struct proc_dir_entry *proc_symlink(const char *,
174                 struct proc_dir_entry *, const char *);
175 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
176 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
177                         struct proc_dir_entry *parent);
178
179 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
180         mode_t mode, struct proc_dir_entry *base, 
181         read_proc_t *read_proc, void * data)
182 {
183         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
184         if (res) {
185                 res->read_proc=read_proc;
186                 res->data=data;
187         }
188         return res;
189 }
190  
191 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
192         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
193 {
194         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
195         if (res) res->get_info=get_info;
196         return res;
197 }
198
199 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
200         const char *name, mode_t mode, const struct file_operations *fops);
201 extern void proc_net_remove(struct net *net, const char *name);
202 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
203         struct proc_dir_entry *parent);
204
205 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
206  * only needed to implement /proc/<pid>|self/exe so we define them here. */
207 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
208 extern struct file *get_mm_exe_file(struct mm_struct *mm);
209 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
210
211 #else
212
213 #define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
214 static inline void proc_net_remove(struct net *net, const char *name) {}
215
216 static inline void proc_flush_task(struct task_struct *task)
217 {
218 }
219
220 static inline struct proc_dir_entry *create_proc_entry(const char *name,
221         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
222 static inline struct proc_dir_entry *proc_create(const char *name,
223         mode_t mode, struct proc_dir_entry *parent,
224         const struct file_operations *proc_fops)
225 {
226         return NULL;
227 }
228 #define remove_proc_entry(name, parent) do {} while (0)
229
230 static inline struct proc_dir_entry *proc_symlink(const char *name,
231                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
232 static inline struct proc_dir_entry *proc_mkdir(const char *name,
233         struct proc_dir_entry *parent) {return NULL;}
234
235 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
236         mode_t mode, struct proc_dir_entry *base, 
237         read_proc_t *read_proc, void * data) { return NULL; }
238 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
239         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
240         { return NULL; }
241
242 struct tty_driver;
243 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
244 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
245
246 extern struct proc_dir_entry proc_root;
247
248 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
249 {
250         return 0;
251 }
252
253 static inline void pid_ns_release_proc(struct pid_namespace *ns)
254 {
255 }
256
257 static inline void set_mm_exe_file(struct mm_struct *mm,
258                                    struct file *new_exe_file)
259 {}
260
261 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
262 {
263         return NULL;
264 }
265
266 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
267                                    struct mm_struct *newmm)
268 {}
269
270 #endif /* CONFIG_PROC_FS */
271
272 #if !defined(CONFIG_PROC_KCORE)
273 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
274 {
275 }
276 #else
277 extern void kclist_add(struct kcore_list *, void *, size_t);
278 #endif
279
280 union proc_op {
281         int (*proc_get_link)(struct inode *, struct path *);
282         int (*proc_read)(struct task_struct *task, char *page);
283         int (*proc_show)(struct seq_file *m,
284                 struct pid_namespace *ns, struct pid *pid,
285                 struct task_struct *task);
286 };
287
288 struct proc_inode {
289         struct pid *pid;
290         int fd;
291         union proc_op op;
292         struct proc_dir_entry *pde;
293         struct inode vfs_inode;
294 };
295
296 static inline struct proc_inode *PROC_I(const struct inode *inode)
297 {
298         return container_of(inode, struct proc_inode, vfs_inode);
299 }
300
301 static inline struct proc_dir_entry *PDE(const struct inode *inode)
302 {
303         return PROC_I(inode)->pde;
304 }
305
306 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
307 {
308         return pde->parent->data;
309 }
310
311 struct net *get_proc_net(const struct inode *inode);
312
313 struct proc_maps_private {
314         struct pid *pid;
315         struct task_struct *task;
316 #ifdef CONFIG_MMU
317         struct vm_area_struct *tail_vma;
318 #endif
319 };
320
321 #endif /* _LINUX_PROC_FS_H */