blob: 9883bc9422621c86b9417a111f8ad1b9d14403dd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_PROC_FS_H
2#define _LINUX_PROC_FS_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/slab.h>
5#include <linux/fs.h>
Steven Rostedt64a07bd2006-03-26 01:36:55 -08006#include <linux/spinlock.h>
Jeff Garzike18fa702006-09-24 11:13:19 -04007#include <linux/magic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <asm/atomic.h>
9
Eric W. Biederman457c4cb2007-09-12 12:01:34 +020010struct net;
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070011struct completion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/*
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
Matt Mackallf248dcb2008-02-04 22:29:03 -080021/* Worst case buffer size needed for holding an integer. */
22#define PROC_NUMBUF 13
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/*
25 * We always define these enumerators
26 */
27
28enum {
29 PROC_ROOT_INO = 1,
30};
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032/*
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 *
Alexey Dobriyan8731f142008-04-29 01:01:58 -070043 * "owner" is used to protect module
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * from unloading while proc_dir_entry is in use
45 */
46
47typedef int (read_proc_t)(char *page, char **start, off_t off,
48 int count, int *eof, void *data);
49typedef int (write_proc_t)(struct file *file, const char __user *buffer,
50 unsigned long count, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52struct 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;
Maneesh Soni22e6c1b2006-03-26 01:37:29 -080060 loff_t size;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080061 const struct inode_operations *proc_iops;
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070062 /*
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 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080070 const struct file_operations *proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 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 */
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070077 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080};
81
82struct kcore_list {
83 struct kcore_list *next;
84 unsigned long addr;
85 size_t size;
86};
87
Vivek Goyal666bfdd2005-06-25 14:58:21 -070088struct vmcore {
89 struct list_head list;
90 unsigned long long paddr;
Vivek Goyal80e8ff62006-04-10 22:54:10 -070091 unsigned long long size;
Vivek Goyal666bfdd2005-06-25 14:58:21 -070092 loff_t offset;
93};
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#ifdef CONFIG_PROC_FS
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern struct proc_dir_entry *proc_root_kcore;
98
Steven Rostedt64a07bd2006-03-26 01:36:55 -080099extern spinlock_t proc_subdir_lock;
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101extern void proc_root_init(void);
102extern void proc_misc_init(void);
103
104struct mm_struct;
105
Eric W. Biederman48e64842006-06-26 00:25:48 -0700106void proc_flush_task(struct task_struct *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
109unsigned long task_vsize(struct mm_struct *);
110int task_statm(struct mm_struct *, int *, int *, int *, int *);
Eric W. Biedermandf5f8312008-02-08 04:18:33 -0800111void task_mem(struct seq_file *, struct mm_struct *);
112void clear_refs_smap(struct mm_struct *mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Alexey Dobriyan76956502007-05-08 00:25:45 -0700114struct proc_dir_entry *de_get(struct proc_dir_entry *de);
115void de_put(struct proc_dir_entry *de);
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
118 struct proc_dir_entry *parent);
Denis V. Lunev59b74352008-04-29 01:02:00 -0700119struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
Alexey Dobriyan2d3a4e32008-02-08 04:18:37 -0800120 struct proc_dir_entry *parent,
Denis V. Lunev59b74352008-04-29 01:02:00 -0700121 const struct file_operations *proc_fops,
122 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
124
125extern struct vfsmount *proc_mnt;
Pavel Emelyanov07543f52007-10-18 23:40:08 -0700126struct pid_namespace;
127extern int proc_fill_super(struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130/*
131 * These are generic /proc routines that use the internal
132 * "struct proc_dir_entry" tree to traverse the filesystem.
133 *
134 * The /proc root directory has extended versions to take care
135 * of the /proc/<pid> subdirectories.
136 */
137extern int proc_readdir(struct file *, void *, filldir_t);
138extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
139
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800140extern const struct file_operations proc_kcore_operations;
141extern const struct file_operations proc_kmsg_operations;
142extern const struct file_operations ppc_htab_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Pavel Emelyanov6f4e6432007-10-18 23:40:11 -0700144extern int pid_ns_prepare_proc(struct pid_namespace *ns);
145extern void pid_ns_release_proc(struct pid_namespace *ns);
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/*
148 * proc_tty.c
149 */
150struct tty_driver;
151extern void proc_tty_init(void);
152extern void proc_tty_register_driver(struct tty_driver *driver);
153extern void proc_tty_unregister_driver(struct tty_driver *driver);
154
155/*
156 * proc_devtree.c
157 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158#ifdef CONFIG_PROC_DEVICETREE
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100159struct device_node;
160struct property;
161extern void proc_device_tree_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100163extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
Dave C Boutcher898b5392006-01-12 16:07:17 -0600164extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
165 struct property *prop);
166extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
167 struct property *newprop,
168 struct property *oldprop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169#endif /* CONFIG_PROC_DEVICETREE */
170
171extern struct proc_dir_entry *proc_symlink(const char *,
172 struct proc_dir_entry *, const char *);
173extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
174extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
175 struct proc_dir_entry *parent);
176
Denis V. Lunev59b74352008-04-29 01:02:00 -0700177static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
178 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
179{
180 return proc_create_data(name, mode, parent, proc_fops, NULL);
181}
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
184 mode_t mode, struct proc_dir_entry *base,
185 read_proc_t *read_proc, void * data)
186{
187 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
188 if (res) {
189 res->read_proc=read_proc;
190 res->data=data;
191 }
192 return res;
193}
194
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200195extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
196 const char *name, mode_t mode, const struct file_operations *fops);
197extern void proc_net_remove(struct net *net, const char *name);
Denis V. Luneve5d69b92008-01-10 03:51:41 -0800198extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
199 struct proc_dir_entry *parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Matt Helsley925d1c42008-04-29 01:01:36 -0700201/* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
202 * only needed to implement /proc/<pid>|self/exe so we define them here. */
203extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
204extern struct file *get_mm_exe_file(struct mm_struct *mm);
205extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207#else
208
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200209#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200210static inline void proc_net_remove(struct net *net, const char *name) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Pavel Emelyanov60347f62007-10-18 23:40:03 -0700212static inline void proc_flush_task(struct task_struct *task)
213{
214}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216static inline struct proc_dir_entry *create_proc_entry(const char *name,
217 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
Alexey Dobriyan2d3a4e32008-02-08 04:18:37 -0800218static inline struct proc_dir_entry *proc_create(const char *name,
219 mode_t mode, struct proc_dir_entry *parent,
220 const struct file_operations *proc_fops)
221{
222 return NULL;
223}
Denis V. Lunev59b74352008-04-29 01:02:00 -0700224static inline struct proc_dir_entry *proc_create_data(const char *name,
225 mode_t mode, struct proc_dir_entry *parent,
226 const struct file_operations *proc_fops, void *data)
227{
228 return NULL;
229}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230#define remove_proc_entry(name, parent) do {} while (0)
231
232static inline struct proc_dir_entry *proc_symlink(const char *name,
233 struct proc_dir_entry *parent,const char *dest) {return NULL;}
234static inline struct proc_dir_entry *proc_mkdir(const char *name,
235 struct proc_dir_entry *parent) {return NULL;}
236
237static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
238 mode_t mode, struct proc_dir_entry *base,
239 read_proc_t *read_proc, void * data) { return NULL; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241struct tty_driver;
242static inline void proc_tty_register_driver(struct tty_driver *driver) {};
243static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
244
Pavel Emelyanov6f4e6432007-10-18 23:40:11 -0700245static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
246{
247 return 0;
248}
249
250static inline void pid_ns_release_proc(struct pid_namespace *ns)
251{
252}
253
Matt Helsley925d1c42008-04-29 01:01:36 -0700254static inline void set_mm_exe_file(struct mm_struct *mm,
255 struct file *new_exe_file)
256{}
257
258static inline struct file *get_mm_exe_file(struct mm_struct *mm)
259{
260 return NULL;
261}
262
263static inline void dup_mm_exe_file(struct mm_struct *oldmm,
264 struct mm_struct *newmm)
265{}
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#endif /* CONFIG_PROC_FS */
268
269#if !defined(CONFIG_PROC_KCORE)
270static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
271{
272}
273#else
274extern void kclist_add(struct kcore_list *, void *, size_t);
275#endif
276
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700277union proc_op {
Jan Blunck3dcd25f2008-02-14 19:38:35 -0800278 int (*proc_get_link)(struct inode *, struct path *);
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700279 int (*proc_read)(struct task_struct *task, char *page);
Eric W. Biedermanbe614082008-02-08 04:18:30 -0800280 int (*proc_show)(struct seq_file *m,
281 struct pid_namespace *ns, struct pid *pid,
282 struct task_struct *task);
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700283};
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700286 struct pid *pid;
Eric W. Biedermanaed7a6c2006-06-26 00:25:44 -0700287 int fd;
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700288 union proc_op op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct proc_dir_entry *pde;
290 struct inode vfs_inode;
291};
292
293static inline struct proc_inode *PROC_I(const struct inode *inode)
294{
295 return container_of(inode, struct proc_inode, vfs_inode);
296}
297
298static inline struct proc_dir_entry *PDE(const struct inode *inode)
299{
300 return PROC_I(inode)->pde;
301}
302
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200303static inline struct net *PDE_NET(struct proc_dir_entry *pde)
304{
305 return pde->parent->data;
306}
307
Eric W. Biederman077130c2007-09-13 09:18:57 +0200308struct net *get_proc_net(const struct inode *inode);
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200309
Eric W. Biederman99f89552006-06-26 00:25:55 -0700310struct proc_maps_private {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700311 struct pid *pid;
Eric W. Biederman99f89552006-06-26 00:25:55 -0700312 struct task_struct *task;
David Howellsdbf86852006-09-27 01:50:19 -0700313#ifdef CONFIG_MMU
Eric W. Biederman99f89552006-06-26 00:25:55 -0700314 struct vm_area_struct *tail_vma;
David Howellsdbf86852006-09-27 01:50:19 -0700315#endif
Eric W. Biederman99f89552006-06-26 00:25:55 -0700316};
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318#endif /* _LINUX_PROC_FS_H */