Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/*
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
28/*
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;
57 loff_t size;
58 struct inode_operations * proc_iops;
59 const struct file_operations * proc_fops;
60 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 */
68 void *set;
69};
70
71struct kcore_list {
72 struct kcore_list *next;
73 unsigned long addr;
74 size_t size;
75};
76
77struct vmcore {
78 struct list_head list;
79 unsigned long long paddr;
80 unsigned long long size;
81 loff_t offset;
82};
83
84#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
94extern spinlock_t proc_subdir_lock;
95
96extern void proc_root_init(void);
97extern void proc_misc_init(void);
98
99struct mm_struct;
100
101void proc_flush_task(struct task_struct *task);
102struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
103int 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
128extern const struct file_operations proc_kcore_operations;
129extern const struct file_operations proc_kmsg_operations;
130extern const struct file_operations ppc_htab_operations;
131
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 */
143#ifdef CONFIG_PROC_DEVICETREE
144struct device_node;
145struct property;
146extern void proc_device_tree_init(void);
147extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
148extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
149extern 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);
154#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,
189 mode_t mode, const struct file_operations *fops)
190{
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
212static inline void proc_flush_task(struct task_struct *task) { }
213
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
247union proc_op {
248 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
249 int (*proc_read)(struct task_struct *task, char *page);
250};
251
252struct proc_inode {
253 struct pid *pid;
254 int fd;
255 union proc_op op;
256 struct proc_dir_entry *pde;
257 struct inode vfs_inode;
258};
259
260static inline struct proc_inode *PROC_I(const struct inode *inode)
261{
262 return container_of(inode, struct proc_inode, vfs_inode);
263}
264
265static inline struct proc_dir_entry *PDE(const struct inode *inode)
266{
267 return PROC_I(inode)->pde;
268}
269
270struct proc_maps_private {
271 struct pid *pid;
272 struct task_struct *task;
273#ifdef CONFIG_MMU
274 struct vm_area_struct *tail_vma;
275#endif
276};
277
278#endif /* _LINUX_PROC_FS_H */