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