blob: 20741f668f7bebbba1cd018a07bab5810ae93428 [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;
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013/*
14 * The proc filesystem constants/structures
15 */
16
17/*
18 * Offset of the first process in the /proc root directory..
19 */
20#define FIRST_PROCESS_ENTRY 256
21
22
23/*
24 * We always define these enumerators
25 */
26
27enum {
28 PROC_ROOT_INO = 1,
29};
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/*
32 * This is not completely implemented yet. The idea is to
33 * create an in-memory tree (like the actual /proc filesystem
34 * tree) of these proc_dir_entries, so that we can dynamically
35 * add new files to /proc.
36 *
37 * The "next" pointer creates a linked list of one /proc directory,
38 * while parent/subdir create the directory structure (every
39 * /proc file has a parent, but "subdir" is NULL for all
40 * non-directory entries).
41 *
42 * "get_info" is called at "read", while "owner" is used to protect module
43 * from unloading while proc_dir_entry is in use
44 */
45
46typedef int (read_proc_t)(char *page, char **start, off_t off,
47 int count, int *eof, void *data);
48typedef int (write_proc_t)(struct file *file, const char __user *buffer,
49 unsigned long count, void *data);
50typedef int (get_info_t)(char *, char **, off_t, int);
51
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 get_info_t *get_info;
72 struct module *owner;
73 struct proc_dir_entry *next, *parent, *subdir;
74 void *data;
75 read_proc_t *read_proc;
76 write_proc_t *write_proc;
77 atomic_t count; /* use count */
78 int deleted; /* delete flag */
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070079 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
84struct kcore_list {
85 struct kcore_list *next;
86 unsigned long addr;
87 size_t size;
88};
89
Vivek Goyal666bfdd2005-06-25 14:58:21 -070090struct vmcore {
91 struct list_head list;
92 unsigned long long paddr;
Vivek Goyal80e8ff62006-04-10 22:54:10 -070093 unsigned long long size;
Vivek Goyal666bfdd2005-06-25 14:58:21 -070094 loff_t offset;
95};
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#ifdef CONFIG_PROC_FS
98
99extern struct proc_dir_entry proc_root;
100extern struct proc_dir_entry *proc_root_fs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101extern struct proc_dir_entry *proc_bus;
102extern struct proc_dir_entry *proc_root_driver;
103extern struct proc_dir_entry *proc_root_kcore;
104
Steven Rostedt64a07bd2006-03-26 01:36:55 -0800105extern spinlock_t proc_subdir_lock;
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107extern void proc_root_init(void);
108extern void proc_misc_init(void);
109
110struct mm_struct;
111
Eric W. Biederman48e64842006-06-26 00:25:48 -0700112void proc_flush_task(struct task_struct *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
115unsigned long task_vsize(struct mm_struct *);
116int task_statm(struct mm_struct *, int *, int *, int *, int *);
117char *task_mem(struct mm_struct *, char *);
David Rientjesb813e932007-05-06 14:49:24 -0700118void clear_refs_smap(struct mm_struct *mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Alexey Dobriyan76956502007-05-08 00:25:45 -0700120struct proc_dir_entry *de_get(struct proc_dir_entry *de);
121void de_put(struct proc_dir_entry *de);
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
124 struct proc_dir_entry *parent);
125extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
126
127extern struct vfsmount *proc_mnt;
128extern int proc_fill_super(struct super_block *,void *,int);
129extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131/*
132 * These are generic /proc routines that use the internal
133 * "struct proc_dir_entry" tree to traverse the filesystem.
134 *
135 * The /proc root directory has extended versions to take care
136 * of the /proc/<pid> subdirectories.
137 */
138extern int proc_readdir(struct file *, void *, filldir_t);
139extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
140
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800141extern const struct file_operations proc_kcore_operations;
142extern const struct file_operations proc_kmsg_operations;
143extern const struct file_operations ppc_htab_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145/*
146 * proc_tty.c
147 */
148struct tty_driver;
149extern void proc_tty_init(void);
150extern void proc_tty_register_driver(struct tty_driver *driver);
151extern void proc_tty_unregister_driver(struct tty_driver *driver);
152
153/*
154 * proc_devtree.c
155 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156#ifdef CONFIG_PROC_DEVICETREE
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100157struct device_node;
158struct property;
159extern void proc_device_tree_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100161extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
Dave C Boutcher898b5392006-01-12 16:07:17 -0600162extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
163 struct property *prop);
164extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
165 struct property *newprop,
166 struct property *oldprop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167#endif /* CONFIG_PROC_DEVICETREE */
168
169extern struct proc_dir_entry *proc_symlink(const char *,
170 struct proc_dir_entry *, const char *);
171extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
172extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
173 struct proc_dir_entry *parent);
174
175static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
176 mode_t mode, struct proc_dir_entry *base,
177 read_proc_t *read_proc, void * data)
178{
179 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
180 if (res) {
181 res->read_proc=read_proc;
182 res->data=data;
183 }
184 return res;
185}
186
187static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
188 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
189{
190 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
191 if (res) res->get_info=get_info;
192 return res;
193}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200195extern struct proc_dir_entry *proc_net_create(struct net *net,
196 const char *name, mode_t mode, get_info_t *get_info);
197extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
198 const char *name, mode_t mode, const struct file_operations *fops);
199extern void proc_net_remove(struct net *net, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201#else
202
203#define proc_root_driver NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#define proc_bus NULL
205
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200206#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
207#define proc_net_create(net, name, mode, info) ({ (void)(mode), NULL; })
208static inline void proc_net_remove(struct net *net, const char *name) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Eric W. Biederman48e64842006-06-26 00:25:48 -0700210static inline void proc_flush_task(struct task_struct *task) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212static inline struct proc_dir_entry *create_proc_entry(const char *name,
213 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
214
215#define remove_proc_entry(name, parent) do {} while (0)
216
217static inline struct proc_dir_entry *proc_symlink(const char *name,
218 struct proc_dir_entry *parent,const char *dest) {return NULL;}
219static inline struct proc_dir_entry *proc_mkdir(const char *name,
220 struct proc_dir_entry *parent) {return NULL;}
221
222static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
223 mode_t mode, struct proc_dir_entry *base,
224 read_proc_t *read_proc, void * data) { return NULL; }
225static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
226 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
227 { return NULL; }
228
229struct tty_driver;
230static inline void proc_tty_register_driver(struct tty_driver *driver) {};
231static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
232
233extern struct proc_dir_entry proc_root;
234
235#endif /* CONFIG_PROC_FS */
236
237#if !defined(CONFIG_PROC_KCORE)
238static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
239{
240}
241#else
242extern void kclist_add(struct kcore_list *, void *, size_t);
243#endif
244
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700245union proc_op {
246 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
247 int (*proc_read)(struct task_struct *task, char *page);
248};
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700251 struct pid *pid;
Eric W. Biedermanaed7a6c2006-06-26 00:25:44 -0700252 int fd;
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700253 union proc_op op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct proc_dir_entry *pde;
255 struct inode vfs_inode;
256};
257
258static inline struct proc_inode *PROC_I(const struct inode *inode)
259{
260 return container_of(inode, struct proc_inode, vfs_inode);
261}
262
263static inline struct proc_dir_entry *PDE(const struct inode *inode)
264{
265 return PROC_I(inode)->pde;
266}
267
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200268static inline struct net *PDE_NET(struct proc_dir_entry *pde)
269{
270 return pde->parent->data;
271}
272
Eric W. Biederman077130c2007-09-13 09:18:57 +0200273struct net *get_proc_net(const struct inode *inode);
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200274
Eric W. Biederman99f89552006-06-26 00:25:55 -0700275struct proc_maps_private {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700276 struct pid *pid;
Eric W. Biederman99f89552006-06-26 00:25:55 -0700277 struct task_struct *task;
David Howellsdbf86852006-09-27 01:50:19 -0700278#ifdef CONFIG_MMU
Eric W. Biederman99f89552006-06-26 00:25:55 -0700279 struct vm_area_struct *tail_vma;
David Howellsdbf86852006-09-27 01:50:19 -0700280#endif
Eric W. Biederman99f89552006-06-26 00:25:55 -0700281};
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#endif /* _LINUX_PROC_FS_H */