78c8c41ea9ccbac788e7a326fcb15330642a01b9
[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_fs;
101 extern struct proc_dir_entry *proc_root_driver;
102 extern struct proc_dir_entry *proc_root_kcore;
103
104 extern spinlock_t proc_subdir_lock;
105
106 extern void proc_root_init(void);
107 extern void proc_misc_init(void);
108
109 struct mm_struct;
110
111 void proc_flush_task(struct task_struct *task);
112 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
113 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
114 unsigned long task_vsize(struct mm_struct *);
115 int task_statm(struct mm_struct *, int *, int *, int *, int *);
116 void task_mem(struct seq_file *, struct mm_struct *);
117 void clear_refs_smap(struct mm_struct *mm);
118
119 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
120 void de_put(struct proc_dir_entry *de);
121
122 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
123                                                 struct proc_dir_entry *parent);
124 struct proc_dir_entry *proc_create(const char *name, mode_t mode,
125                                 struct proc_dir_entry *parent,
126                                 const struct file_operations *proc_fops);
127 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
128
129 extern struct vfsmount *proc_mnt;
130 struct pid_namespace;
131 extern int proc_fill_super(struct super_block *);
132 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
133
134 /*
135  * These are generic /proc routines that use the internal
136  * "struct proc_dir_entry" tree to traverse the filesystem.
137  *
138  * The /proc root directory has extended versions to take care
139  * of the /proc/<pid> subdirectories.
140  */
141 extern int proc_readdir(struct file *, void *, filldir_t);
142 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
143
144 extern const struct file_operations proc_kcore_operations;
145 extern const struct file_operations proc_kmsg_operations;
146 extern const struct file_operations ppc_htab_operations;
147
148 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
149 extern void pid_ns_release_proc(struct pid_namespace *ns);
150
151 /*
152  * proc_tty.c
153  */
154 struct tty_driver;
155 extern void proc_tty_init(void);
156 extern void proc_tty_register_driver(struct tty_driver *driver);
157 extern void proc_tty_unregister_driver(struct tty_driver *driver);
158
159 /*
160  * proc_devtree.c
161  */
162 #ifdef CONFIG_PROC_DEVICETREE
163 struct device_node;
164 struct property;
165 extern void proc_device_tree_init(void);
166 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
167 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
168 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
169                                          struct property *prop);
170 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
171                                          struct property *newprop,
172                                          struct property *oldprop);
173 #endif /* CONFIG_PROC_DEVICETREE */
174
175 extern struct proc_dir_entry *proc_symlink(const char *,
176                 struct proc_dir_entry *, const char *);
177 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
178 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
179                         struct proc_dir_entry *parent);
180
181 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
182         mode_t mode, struct proc_dir_entry *base, 
183         read_proc_t *read_proc, void * data)
184 {
185         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
186         if (res) {
187                 res->read_proc=read_proc;
188                 res->data=data;
189         }
190         return res;
191 }
192  
193 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
194         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
195 {
196         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
197         if (res) res->get_info=get_info;
198         return res;
199 }
200
201 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
202         const char *name, mode_t mode, const struct file_operations *fops);
203 extern void proc_net_remove(struct net *net, const char *name);
204 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
205         struct proc_dir_entry *parent);
206
207 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
208  * only needed to implement /proc/<pid>|self/exe so we define them here. */
209 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
210 extern struct file *get_mm_exe_file(struct mm_struct *mm);
211 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
212
213 #else
214
215 #define proc_root_driver NULL
216
217 #define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
218 static inline void proc_net_remove(struct net *net, const char *name) {}
219
220 static inline void proc_flush_task(struct task_struct *task)
221 {
222 }
223
224 static inline struct proc_dir_entry *create_proc_entry(const char *name,
225         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
226 static inline struct proc_dir_entry *proc_create(const char *name,
227         mode_t mode, struct proc_dir_entry *parent,
228         const struct file_operations *proc_fops)
229 {
230         return NULL;
231 }
232 #define remove_proc_entry(name, parent) do {} while (0)
233
234 static inline struct proc_dir_entry *proc_symlink(const char *name,
235                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
236 static inline struct proc_dir_entry *proc_mkdir(const char *name,
237         struct proc_dir_entry *parent) {return NULL;}
238
239 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
240         mode_t mode, struct proc_dir_entry *base, 
241         read_proc_t *read_proc, void * data) { return NULL; }
242 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
243         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
244         { return NULL; }
245
246 struct tty_driver;
247 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
248 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
249
250 extern struct proc_dir_entry proc_root;
251
252 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
253 {
254         return 0;
255 }
256
257 static inline void pid_ns_release_proc(struct pid_namespace *ns)
258 {
259 }
260
261 static inline void set_mm_exe_file(struct mm_struct *mm,
262                                    struct file *new_exe_file)
263 {}
264
265 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
266 {
267         return NULL;
268 }
269
270 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
271                                    struct mm_struct *newmm)
272 {}
273
274 #endif /* CONFIG_PROC_FS */
275
276 #if !defined(CONFIG_PROC_KCORE)
277 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
278 {
279 }
280 #else
281 extern void kclist_add(struct kcore_list *, void *, size_t);
282 #endif
283
284 union proc_op {
285         int (*proc_get_link)(struct inode *, struct path *);
286         int (*proc_read)(struct task_struct *task, char *page);
287         int (*proc_show)(struct seq_file *m,
288                 struct pid_namespace *ns, struct pid *pid,
289                 struct task_struct *task);
290 };
291
292 struct proc_inode {
293         struct pid *pid;
294         int fd;
295         union proc_op op;
296         struct proc_dir_entry *pde;
297         struct inode vfs_inode;
298 };
299
300 static inline struct proc_inode *PROC_I(const struct inode *inode)
301 {
302         return container_of(inode, struct proc_inode, vfs_inode);
303 }
304
305 static inline struct proc_dir_entry *PDE(const struct inode *inode)
306 {
307         return PROC_I(inode)->pde;
308 }
309
310 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
311 {
312         return pde->parent->data;
313 }
314
315 struct net *get_proc_net(const struct inode *inode);
316
317 struct proc_maps_private {
318         struct pid *pid;
319         struct task_struct *task;
320 #ifdef CONFIG_MMU
321         struct vm_area_struct *tail_vma;
322 #endif
323 };
324
325 #endif /* _LINUX_PROC_FS_H */