kcore: add kclist types
[linux-3.10.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 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 };
33
34 /*
35  * This is not completely implemented yet. The idea is to
36  * create an in-memory tree (like the actual /proc filesystem
37  * tree) of these proc_dir_entries, so that we can dynamically
38  * add new files to /proc.
39  *
40  * The "next" pointer creates a linked list of one /proc directory,
41  * while parent/subdir create the directory structure (every
42  * /proc file has a parent, but "subdir" is NULL for all
43  * non-directory entries).
44  */
45
46 typedef int (read_proc_t)(char *page, char **start, off_t off,
47                           int count, int *eof, void *data);
48 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
49                            unsigned long count, void *data);
50
51 struct proc_dir_entry {
52         unsigned int low_ino;
53         unsigned short namelen;
54         const char *name;
55         mode_t mode;
56         nlink_t nlink;
57         uid_t uid;
58         gid_t gid;
59         loff_t size;
60         const struct inode_operations *proc_iops;
61         /*
62          * NULL ->proc_fops means "PDE is going away RSN" or
63          * "PDE is just created". In either case, e.g. ->read_proc won't be
64          * called because it's too late or too early, respectively.
65          *
66          * If you're allocating ->proc_fops dynamically, save a pointer
67          * somewhere.
68          */
69         const struct file_operations *proc_fops;
70         struct proc_dir_entry *next, *parent, *subdir;
71         void *data;
72         read_proc_t *read_proc;
73         write_proc_t *write_proc;
74         atomic_t count;         /* use count */
75         int pde_users;  /* number of callers into module in progress */
76         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
77         struct completion *pde_unload_completion;
78         struct list_head pde_openers;   /* who did ->open, but not ->release */
79 };
80
81 enum kcore_type {
82         KCORE_TEXT,
83         KCORE_VMALLOC,
84         KCORE_RAM,
85         KCORE_OTHER,
86 };
87
88 struct kcore_list {
89         struct list_head list;
90         unsigned long addr;
91         size_t size;
92         int type;
93 };
94
95 struct vmcore {
96         struct list_head list;
97         unsigned long long paddr;
98         unsigned long long size;
99         loff_t offset;
100 };
101
102 #ifdef CONFIG_PROC_FS
103
104 extern void proc_root_init(void);
105
106 void proc_flush_task(struct task_struct *task);
107
108 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
109                                                 struct proc_dir_entry *parent);
110 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
111                                 struct proc_dir_entry *parent,
112                                 const struct file_operations *proc_fops,
113                                 void *data);
114 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
115
116 struct pid_namespace;
117
118 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
119 extern void pid_ns_release_proc(struct pid_namespace *ns);
120
121 /*
122  * proc_tty.c
123  */
124 struct tty_driver;
125 extern void proc_tty_init(void);
126 extern void proc_tty_register_driver(struct tty_driver *driver);
127 extern void proc_tty_unregister_driver(struct tty_driver *driver);
128
129 /*
130  * proc_devtree.c
131  */
132 #ifdef CONFIG_PROC_DEVICETREE
133 struct device_node;
134 struct property;
135 extern void proc_device_tree_init(void);
136 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
137 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
138 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
139                                          struct property *prop);
140 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
141                                          struct property *newprop,
142                                          struct property *oldprop);
143 #endif /* CONFIG_PROC_DEVICETREE */
144
145 extern struct proc_dir_entry *proc_symlink(const char *,
146                 struct proc_dir_entry *, const char *);
147 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
148 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
149                         struct proc_dir_entry *parent);
150
151 static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
152         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
153 {
154         return proc_create_data(name, mode, parent, proc_fops, NULL);
155 }
156
157 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
158         mode_t mode, struct proc_dir_entry *base, 
159         read_proc_t *read_proc, void * data)
160 {
161         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
162         if (res) {
163                 res->read_proc=read_proc;
164                 res->data=data;
165         }
166         return res;
167 }
168  
169 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
170         const char *name, mode_t mode, const struct file_operations *fops);
171 extern void proc_net_remove(struct net *net, const char *name);
172 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
173         struct proc_dir_entry *parent);
174
175 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
176  * only needed to implement /proc/<pid>|self/exe so we define them here. */
177 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
178 extern struct file *get_mm_exe_file(struct mm_struct *mm);
179 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
180
181 #else
182
183 #define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
184 static inline void proc_net_remove(struct net *net, const char *name) {}
185
186 static inline void proc_flush_task(struct task_struct *task)
187 {
188 }
189
190 static inline struct proc_dir_entry *create_proc_entry(const char *name,
191         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
192 static inline struct proc_dir_entry *proc_create(const char *name,
193         mode_t mode, struct proc_dir_entry *parent,
194         const struct file_operations *proc_fops)
195 {
196         return NULL;
197 }
198 static inline struct proc_dir_entry *proc_create_data(const char *name,
199         mode_t mode, struct proc_dir_entry *parent,
200         const struct file_operations *proc_fops, void *data)
201 {
202         return NULL;
203 }
204 #define remove_proc_entry(name, parent) do {} while (0)
205
206 static inline struct proc_dir_entry *proc_symlink(const char *name,
207                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
208 static inline struct proc_dir_entry *proc_mkdir(const char *name,
209         struct proc_dir_entry *parent) {return NULL;}
210
211 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
212         mode_t mode, struct proc_dir_entry *base, 
213         read_proc_t *read_proc, void * data) { return NULL; }
214
215 struct tty_driver;
216 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
217 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
218
219 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
220 {
221         return 0;
222 }
223
224 static inline void pid_ns_release_proc(struct pid_namespace *ns)
225 {
226 }
227
228 static inline void set_mm_exe_file(struct mm_struct *mm,
229                                    struct file *new_exe_file)
230 {}
231
232 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
233 {
234         return NULL;
235 }
236
237 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
238                                    struct mm_struct *newmm)
239 {}
240
241 #endif /* CONFIG_PROC_FS */
242
243 #if !defined(CONFIG_PROC_KCORE)
244 static inline void
245 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
246 {
247 }
248 #else
249 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
250 #endif
251
252 union proc_op {
253         int (*proc_get_link)(struct inode *, struct path *);
254         int (*proc_read)(struct task_struct *task, char *page);
255         int (*proc_show)(struct seq_file *m,
256                 struct pid_namespace *ns, struct pid *pid,
257                 struct task_struct *task);
258 };
259
260 struct ctl_table_header;
261 struct ctl_table;
262
263 struct proc_inode {
264         struct pid *pid;
265         int fd;
266         union proc_op op;
267         struct proc_dir_entry *pde;
268         struct ctl_table_header *sysctl;
269         struct ctl_table *sysctl_entry;
270         struct inode vfs_inode;
271 };
272
273 static inline struct proc_inode *PROC_I(const struct inode *inode)
274 {
275         return container_of(inode, struct proc_inode, vfs_inode);
276 }
277
278 static inline struct proc_dir_entry *PDE(const struct inode *inode)
279 {
280         return PROC_I(inode)->pde;
281 }
282
283 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
284 {
285         return pde->parent->data;
286 }
287
288 struct proc_maps_private {
289         struct pid *pid;
290         struct task_struct *task;
291 #ifdef CONFIG_MMU
292         struct vm_area_struct *tail_vma;
293 #endif
294 };
295
296 #endif /* _LINUX_PROC_FS_H */