blob: 3435ca38dd142ee705bc57032d0fd855b8c18635 [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
10/*
11 * The proc filesystem constants/structures
12 */
13
14/*
15 * Offset of the first process in the /proc root directory..
16 */
17#define FIRST_PROCESS_ENTRY 256
18
19
20/*
21 * We always define these enumerators
22 */
23
24enum {
25 PROC_ROOT_INO = 1,
26};
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/*
29 * This is not completely implemented yet. The idea is to
30 * create an in-memory tree (like the actual /proc filesystem
31 * tree) of these proc_dir_entries, so that we can dynamically
32 * add new files to /proc.
33 *
34 * The "next" pointer creates a linked list of one /proc directory,
35 * while parent/subdir create the directory structure (every
36 * /proc file has a parent, but "subdir" is NULL for all
37 * non-directory entries).
38 *
39 * "get_info" is called at "read", while "owner" is used to protect module
40 * from unloading while proc_dir_entry is in use
41 */
42
43typedef int (read_proc_t)(char *page, char **start, off_t off,
44 int count, int *eof, void *data);
45typedef int (write_proc_t)(struct file *file, const char __user *buffer,
46 unsigned long count, void *data);
47typedef int (get_info_t)(char *, char **, off_t, int);
48
49struct proc_dir_entry {
50 unsigned int low_ino;
51 unsigned short namelen;
52 const char *name;
53 mode_t mode;
54 nlink_t nlink;
55 uid_t uid;
56 gid_t gid;
Maneesh Soni22e6c1b2006-03-26 01:37:29 -080057 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct inode_operations * proc_iops;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -080059 const struct file_operations * proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 get_info_t *get_info;
61 struct module *owner;
62 struct proc_dir_entry *next, *parent, *subdir;
63 void *data;
64 read_proc_t *read_proc;
65 write_proc_t *write_proc;
66 atomic_t count; /* use count */
67 int deleted; /* delete flag */
Al Viro330d57f2005-11-04 10:18:40 +000068 void *set;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069};
70
71struct kcore_list {
72 struct kcore_list *next;
73 unsigned long addr;
74 size_t size;
75};
76
Vivek Goyal666bfdd2005-06-25 14:58:21 -070077struct vmcore {
78 struct list_head list;
79 unsigned long long paddr;
Vivek Goyal80e8ff62006-04-10 22:54:10 -070080 unsigned long long size;
Vivek Goyal666bfdd2005-06-25 14:58:21 -070081 loff_t offset;
82};
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084#ifdef CONFIG_PROC_FS
85
86extern struct proc_dir_entry proc_root;
87extern struct proc_dir_entry *proc_root_fs;
88extern struct proc_dir_entry *proc_net;
89extern struct proc_dir_entry *proc_net_stat;
90extern struct proc_dir_entry *proc_bus;
91extern struct proc_dir_entry *proc_root_driver;
92extern struct proc_dir_entry *proc_root_kcore;
93
Steven Rostedt64a07bd2006-03-26 01:36:55 -080094extern spinlock_t proc_subdir_lock;
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096extern void proc_root_init(void);
97extern void proc_misc_init(void);
98
99struct mm_struct;
100
Eric W. Biederman48e64842006-06-26 00:25:48 -0700101void proc_flush_task(struct task_struct *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
104unsigned long task_vsize(struct mm_struct *);
105int task_statm(struct mm_struct *, int *, int *, int *, int *);
106char *task_mem(struct mm_struct *, char *);
107
108extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
109 struct proc_dir_entry *parent);
110extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
111
112extern struct vfsmount *proc_mnt;
113extern int proc_fill_super(struct super_block *,void *,int);
114extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
115
116extern int proc_match(int, const char *,struct proc_dir_entry *);
117
118/*
119 * These are generic /proc routines that use the internal
120 * "struct proc_dir_entry" tree to traverse the filesystem.
121 *
122 * The /proc root directory has extended versions to take care
123 * of the /proc/<pid> subdirectories.
124 */
125extern int proc_readdir(struct file *, void *, filldir_t);
126extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
127
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800128extern const struct file_operations proc_kcore_operations;
129extern const struct file_operations proc_kmsg_operations;
130extern const struct file_operations ppc_htab_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132/*
133 * proc_tty.c
134 */
135struct tty_driver;
136extern void proc_tty_init(void);
137extern void proc_tty_register_driver(struct tty_driver *driver);
138extern void proc_tty_unregister_driver(struct tty_driver *driver);
139
140/*
141 * proc_devtree.c
142 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#ifdef CONFIG_PROC_DEVICETREE
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100144struct device_node;
145struct property;
146extern void proc_device_tree_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100148extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
Dave C Boutcher898b5392006-01-12 16:07:17 -0600149extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
150 struct property *prop);
151extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
152 struct property *newprop,
153 struct property *oldprop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#endif /* CONFIG_PROC_DEVICETREE */
155
156extern struct proc_dir_entry *proc_symlink(const char *,
157 struct proc_dir_entry *, const char *);
158extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
159extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
160 struct proc_dir_entry *parent);
161
162static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
163 mode_t mode, struct proc_dir_entry *base,
164 read_proc_t *read_proc, void * data)
165{
166 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
167 if (res) {
168 res->read_proc=read_proc;
169 res->data=data;
170 }
171 return res;
172}
173
174static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
175 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
176{
177 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
178 if (res) res->get_info=get_info;
179 return res;
180}
181
182static inline struct proc_dir_entry *proc_net_create(const char *name,
183 mode_t mode, get_info_t *get_info)
184{
185 return create_proc_info_entry(name,mode,proc_net,get_info);
186}
187
188static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800189 mode_t mode, const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
191 struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
192 if (res)
193 res->proc_fops = fops;
194 return res;
195}
196
197static inline void proc_net_remove(const char *name)
198{
199 remove_proc_entry(name,proc_net);
200}
201
202#else
203
204#define proc_root_driver NULL
205#define proc_net NULL
206#define proc_bus NULL
207
208#define proc_net_fops_create(name, mode, fops) ({ (void)(mode), NULL; })
209#define proc_net_create(name, mode, info) ({ (void)(mode), NULL; })
210static inline void proc_net_remove(const char *name) {}
211
Eric W. Biederman48e64842006-06-26 00:25:48 -0700212static inline void proc_flush_task(struct task_struct *task) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214static inline struct proc_dir_entry *create_proc_entry(const char *name,
215 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
216
217#define remove_proc_entry(name, parent) do {} while (0)
218
219static inline struct proc_dir_entry *proc_symlink(const char *name,
220 struct proc_dir_entry *parent,const char *dest) {return NULL;}
221static inline struct proc_dir_entry *proc_mkdir(const char *name,
222 struct proc_dir_entry *parent) {return NULL;}
223
224static 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; }
227static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
228 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
229 { return NULL; }
230
231struct tty_driver;
232static inline void proc_tty_register_driver(struct tty_driver *driver) {};
233static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
234
235extern struct proc_dir_entry proc_root;
236
237#endif /* CONFIG_PROC_FS */
238
239#if !defined(CONFIG_PROC_KCORE)
240static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
241{
242}
243#else
244extern void kclist_add(struct kcore_list *, void *, size_t);
245#endif
246
247struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700248 struct pid *pid;
Eric W. Biedermanaed7a6c2006-06-26 00:25:44 -0700249 int fd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 union {
251 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
252 int (*proc_read)(struct task_struct *task, char *page);
253 } op;
254 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. Biederman99f89552006-06-26 00:25:55 -0700268struct proc_maps_private {
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700269 struct pid *pid;
Eric W. Biederman99f89552006-06-26 00:25:55 -0700270 struct task_struct *task;
271 struct vm_area_struct *tail_vma;
272};
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#endif /* _LINUX_PROC_FS_H */