blob: 838c1149251a1e8edff75dd2db6ef58092542386 [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;
Ben Nizette57d3c642008-06-12 15:21:31 -070012struct mm_struct;
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/*
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
Matt Mackallf248dcb2008-02-04 22:29:03 -080023/* Worst case buffer size needed for holding an integer. */
24#define PROC_NUMBUF 13
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26/*
27 * We always define these enumerators
28 */
29
30enum {
31 PROC_ROOT_INO = 1,
32};
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034/*
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).
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 */
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51struct proc_dir_entry {
52 unsigned int low_ino;
Alexey Dobriyan312ec7e2011-03-23 16:42:52 -070053 unsigned int namelen;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 const char *name;
55 mode_t mode;
56 nlink_t nlink;
57 uid_t uid;
58 gid_t gid;
Maneesh Soni22e6c1b2006-03-26 01:37:29 -080059 loff_t size;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080060 const struct inode_operations *proc_iops;
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070061 /*
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 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -080069 const struct file_operations *proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 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 */
Alexey Dobriyan786d7e12007-07-15 23:39:00 -070075 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;
Alexey Dobriyan881adb82008-07-25 01:48:29 -070078 struct list_head pde_openers; /* who did ->open, but not ->release */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
KAMEZAWA Hiroyukic30bb2a2009-09-22 16:45:43 -070081enum kcore_type {
82 KCORE_TEXT,
83 KCORE_VMALLOC,
84 KCORE_RAM,
KAMEZAWA Hiroyuki26562c52009-09-22 16:45:49 -070085 KCORE_VMEMMAP,
KAMEZAWA Hiroyukic30bb2a2009-09-22 16:45:43 -070086 KCORE_OTHER,
87};
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089struct kcore_list {
KAMEZAWA Hiroyuki2ef43ec2009-09-22 16:45:41 -070090 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 unsigned long addr;
92 size_t size;
KAMEZAWA Hiroyukic30bb2a2009-09-22 16:45:43 -070093 int type;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094};
95
Vivek Goyal666bfdd2005-06-25 14:58:21 -070096struct vmcore {
97 struct list_head list;
98 unsigned long long paddr;
Vivek Goyal80e8ff62006-04-10 22:54:10 -070099 unsigned long long size;
Vivek Goyal666bfdd2005-06-25 14:58:21 -0700100 loff_t offset;
101};
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#ifdef CONFIG_PROC_FS
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105extern void proc_root_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Eric W. Biederman48e64842006-06-26 00:25:48 -0700107void proc_flush_task(struct task_struct *task);
Alexey Dobriyan76956502007-05-08 00:25:45 -0700108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
110 struct proc_dir_entry *parent);
Denis V. Lunev59b74352008-04-29 01:02:00 -0700111struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
Alexey Dobriyan2d3a4e32008-02-08 04:18:37 -0800112 struct proc_dir_entry *parent,
Denis V. Lunev59b74352008-04-29 01:02:00 -0700113 const struct file_operations *proc_fops,
114 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
116
Pavel Emelyanov07543f52007-10-18 23:40:08 -0700117struct pid_namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Pavel Emelyanov6f4e6432007-10-18 23:40:11 -0700119extern int pid_ns_prepare_proc(struct pid_namespace *ns);
120extern void pid_ns_release_proc(struct pid_namespace *ns);
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/*
123 * proc_tty.c
124 */
125struct tty_driver;
126extern void proc_tty_init(void);
127extern void proc_tty_register_driver(struct tty_driver *driver);
128extern void proc_tty_unregister_driver(struct tty_driver *driver);
129
130/*
131 * proc_devtree.c
132 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#ifdef CONFIG_PROC_DEVICETREE
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100134struct device_node;
135struct property;
136extern void proc_device_tree_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100138extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
Dave C Boutcher898b5392006-01-12 16:07:17 -0600139extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
140 struct property *prop);
141extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
142 struct property *newprop,
143 struct property *oldprop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144#endif /* CONFIG_PROC_DEVICETREE */
145
146extern struct proc_dir_entry *proc_symlink(const char *,
147 struct proc_dir_entry *, const char *);
148extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
149extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
150 struct proc_dir_entry *parent);
151
Denis V. Lunev59b74352008-04-29 01:02:00 -0700152static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
153 struct proc_dir_entry *parent, const struct file_operations *proc_fops)
154{
155 return proc_create_data(name, mode, parent, proc_fops, NULL);
156}
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
159 mode_t mode, struct proc_dir_entry *base,
160 read_proc_t *read_proc, void * data)
161{
162 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
163 if (res) {
164 res->read_proc=read_proc;
165 res->data=data;
166 }
167 return res;
168}
169
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200170extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
171 const char *name, mode_t mode, const struct file_operations *fops);
172extern void proc_net_remove(struct net *net, const char *name);
Denis V. Luneve5d69b92008-01-10 03:51:41 -0800173extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
174 struct proc_dir_entry *parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Matt Helsley925d1c42008-04-29 01:01:36 -0700176/* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
177 * only needed to implement /proc/<pid>|self/exe so we define them here. */
178extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
179extern struct file *get_mm_exe_file(struct mm_struct *mm);
180extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182#else
183
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200184#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200185static inline void proc_net_remove(struct net *net, const char *name) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Pavel Emelyanov60347f62007-10-18 23:40:03 -0700187static inline void proc_flush_task(struct task_struct *task)
188{
189}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191static inline struct proc_dir_entry *create_proc_entry(const char *name,
192 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
Alexey Dobriyan2d3a4e32008-02-08 04:18:37 -0800193static inline struct proc_dir_entry *proc_create(const char *name,
194 mode_t mode, struct proc_dir_entry *parent,
195 const struct file_operations *proc_fops)
196{
197 return NULL;
198}
Denis V. Lunev59b74352008-04-29 01:02:00 -0700199static inline struct proc_dir_entry *proc_create_data(const char *name,
200 mode_t mode, struct proc_dir_entry *parent,
201 const struct file_operations *proc_fops, void *data)
202{
203 return NULL;
204}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#define remove_proc_entry(name, parent) do {} while (0)
206
207static inline struct proc_dir_entry *proc_symlink(const char *name,
208 struct proc_dir_entry *parent,const char *dest) {return NULL;}
209static inline struct proc_dir_entry *proc_mkdir(const char *name,
210 struct proc_dir_entry *parent) {return NULL;}
211
212static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
213 mode_t mode, struct proc_dir_entry *base,
214 read_proc_t *read_proc, void * data) { return NULL; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216struct tty_driver;
217static inline void proc_tty_register_driver(struct tty_driver *driver) {};
218static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
219
Pavel Emelyanov6f4e6432007-10-18 23:40:11 -0700220static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
221{
222 return 0;
223}
224
225static inline void pid_ns_release_proc(struct pid_namespace *ns)
226{
227}
228
Matt Helsley925d1c42008-04-29 01:01:36 -0700229static inline void set_mm_exe_file(struct mm_struct *mm,
230 struct file *new_exe_file)
231{}
232
233static inline struct file *get_mm_exe_file(struct mm_struct *mm)
234{
235 return NULL;
236}
237
238static inline void dup_mm_exe_file(struct mm_struct *oldmm,
239 struct mm_struct *newmm)
240{}
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#endif /* CONFIG_PROC_FS */
243
244#if !defined(CONFIG_PROC_KCORE)
KAMEZAWA Hiroyukic30bb2a2009-09-22 16:45:43 -0700245static inline void
246kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
248}
249#else
KAMEZAWA Hiroyukic30bb2a2009-09-22 16:45:43 -0700250extern void kclist_add(struct kcore_list *, void *, size_t, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#endif
252
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700253union proc_op {
Jan Blunck3dcd25f2008-02-14 19:38:35 -0800254 int (*proc_get_link)(struct inode *, struct path *);
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700255 int (*proc_read)(struct task_struct *task, char *page);
Eric W. Biedermanbe614082008-02-08 04:18:30 -0800256 int (*proc_show)(struct seq_file *m,
257 struct pid_namespace *ns, struct pid *pid,
258 struct task_struct *task);
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700259};
260
Al Viro9043476f2008-07-15 08:54:06 -0400261struct ctl_table_header;
262struct ctl_table;
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700265 struct pid *pid;
Eric W. Biedermanaed7a6c2006-06-26 00:25:44 -0700266 int fd;
Eric W. Biederman20cdc892006-10-02 02:17:07 -0700267 union proc_op op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 struct proc_dir_entry *pde;
Al Viro9043476f2008-07-15 08:54:06 -0400269 struct ctl_table_header *sysctl;
270 struct ctl_table *sysctl_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 struct inode vfs_inode;
272};
273
274static inline struct proc_inode *PROC_I(const struct inode *inode)
275{
276 return container_of(inode, struct proc_inode, vfs_inode);
277}
278
279static inline struct proc_dir_entry *PDE(const struct inode *inode)
280{
281 return PROC_I(inode)->pde;
282}
283
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200284static inline struct net *PDE_NET(struct proc_dir_entry *pde)
285{
286 return pde->parent->data;
287}
288
Eric W. Biederman99f89552006-06-26 00:25:55 -0700289struct proc_maps_private {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700290 struct pid *pid;
Eric W. Biederman99f89552006-06-26 00:25:55 -0700291 struct task_struct *task;
David Howellsdbf86852006-09-27 01:50:19 -0700292#ifdef CONFIG_MMU
Eric W. Biederman99f89552006-06-26 00:25:55 -0700293 struct vm_area_struct *tail_vma;
David Howellsdbf86852006-09-27 01:50:19 -0700294#endif
Eric W. Biederman99f89552006-06-26 00:25:55 -0700295};
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297#endif /* _LINUX_PROC_FS_H */