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 const 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
116/*
117 * These are generic /proc routines that use the internal
118 * "struct proc_dir_entry" tree to traverse the filesystem.
119 *
120 * The /proc root directory has extended versions to take care
121 * of the /proc/<pid> subdirectories.
122 */
123extern int proc_readdir(struct file *, void *, filldir_t);
124extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
125
126extern const struct file_operations proc_kcore_operations;
127extern const struct file_operations proc_kmsg_operations;
128extern const struct file_operations ppc_htab_operations;
129
130/*
131 * proc_tty.c
132 */
133struct tty_driver;
134extern void proc_tty_init(void);
135extern void proc_tty_register_driver(struct tty_driver *driver);
136extern void proc_tty_unregister_driver(struct tty_driver *driver);
137
138/*
139 * proc_devtree.c
140 */
141#ifdef CONFIG_PROC_DEVICETREE
142struct device_node;
143struct property;
144extern void proc_device_tree_init(void);
145extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
146extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
147extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
148 struct property *prop);
149extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
150 struct property *newprop,
151 struct property *oldprop);
152#endif /* CONFIG_PROC_DEVICETREE */
153
154extern struct proc_dir_entry *proc_symlink(const char *,
155 struct proc_dir_entry *, const char *);
156extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
157extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
158 struct proc_dir_entry *parent);
159
160static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
161 mode_t mode, struct proc_dir_entry *base,
162 read_proc_t *read_proc, void * data)
163{
164 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
165 if (res) {
166 res->read_proc=read_proc;
167 res->data=data;
168 }
169 return res;
170}
171
172static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
173 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
174{
175 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
176 if (res) res->get_info=get_info;
177 return res;
178}
179
180static inline struct proc_dir_entry *proc_net_create(const char *name,
181 mode_t mode, get_info_t *get_info)
182{
183 return create_proc_info_entry(name,mode,proc_net,get_info);
184}
185
186static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
187 mode_t mode, const struct file_operations *fops)
188{
189 struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
190 if (res)
191 res->proc_fops = fops;
192 return res;
193}
194
195static inline void proc_net_remove(const char *name)
196{
197 remove_proc_entry(name,proc_net);
198}
199
200#else
201
202#define proc_root_driver NULL
203#define proc_net NULL
204#define proc_bus NULL
205
206#define proc_net_fops_create(name, mode, fops) ({ (void)(mode), NULL; })
207#define proc_net_create(name, mode, info) ({ (void)(mode), NULL; })
208static inline void proc_net_remove(const char *name) {}
209
210static inline void proc_flush_task(struct task_struct *task) { }
211
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
245union 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
250struct proc_inode {
251 struct pid *pid;
252 int fd;
253 union proc_op 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
268struct proc_maps_private {
269 struct pid *pid;
270 struct task_struct *task;
271#ifdef CONFIG_MMU
272 struct vm_area_struct *tail_vma;
273#endif
274};
275
276#endif /* _LINUX_PROC_FS_H */