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/config.h>
5#include <linux/slab.h>
6#include <linux/fs.h>
7#include <linux/spinlock.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#define PROC_SUPER_MAGIC 0x9fa0
29
30/*
31 * This is not completely implemented yet. The idea is to
32 * create an in-memory tree (like the actual /proc filesystem
33 * tree) of these proc_dir_entries, so that we can dynamically
34 * add new files to /proc.
35 *
36 * The "next" pointer creates a linked list of one /proc directory,
37 * while parent/subdir create the directory structure (every
38 * /proc file has a parent, but "subdir" is NULL for all
39 * non-directory entries).
40 *
41 * "get_info" is called at "read", while "owner" is used to protect module
42 * from unloading while proc_dir_entry is in use
43 */
44
45typedef int (read_proc_t)(char *page, char **start, off_t off,
46 int count, int *eof, void *data);
47typedef int (write_proc_t)(struct file *file, const char __user *buffer,
48 unsigned long count, void *data);
49typedef int (get_info_t)(char *, char **, off_t, int);
50
51struct proc_dir_entry {
52 unsigned int low_ino;
53 unsigned short namelen;
54 const char *name;
55 mode_t mode;
56 nlink_t nlink;
57 uid_t uid;
58 gid_t gid;
59 loff_t size;
60 struct inode_operations * proc_iops;
61 const struct file_operations * proc_fops;
62 get_info_t *get_info;
63 struct module *owner;
64 struct proc_dir_entry *next, *parent, *subdir;
65 void *data;
66 read_proc_t *read_proc;
67 write_proc_t *write_proc;
68 atomic_t count; /* use count */
69 int deleted; /* delete flag */
70 void *set;
71};
72
73struct kcore_list {
74 struct kcore_list *next;
75 unsigned long addr;
76 size_t size;
77};
78
79struct vmcore {
80 struct list_head list;
81 unsigned long long paddr;
82 unsigned long long size;
83 loff_t offset;
84};
85
86#ifdef CONFIG_PROC_FS
87
88extern struct proc_dir_entry proc_root;
89extern struct proc_dir_entry *proc_root_fs;
90extern struct proc_dir_entry *proc_net;
91extern struct proc_dir_entry *proc_net_stat;
92extern struct proc_dir_entry *proc_bus;
93extern struct proc_dir_entry *proc_root_driver;
94extern struct proc_dir_entry *proc_root_kcore;
95
96extern spinlock_t proc_subdir_lock;
97
98extern void proc_root_init(void);
99extern void proc_misc_init(void);
100
101struct mm_struct;
102
103struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
104struct dentry *proc_pid_unhash(struct task_struct *p);
105void proc_pid_flush(struct dentry *proc_dentry);
106int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
107unsigned long task_vsize(struct mm_struct *);
108int task_statm(struct mm_struct *, int *, int *, int *, int *);
109char *task_mem(struct mm_struct *, char *);
110
111extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
112 struct proc_dir_entry *parent);
113extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
114
115extern struct vfsmount *proc_mnt;
116extern int proc_fill_super(struct super_block *,void *,int);
117extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
118
119extern int proc_match(int, const char *,struct proc_dir_entry *);
120
121/*
122 * These are generic /proc routines that use the internal
123 * "struct proc_dir_entry" tree to traverse the filesystem.
124 *
125 * The /proc root directory has extended versions to take care
126 * of the /proc/<pid> subdirectories.
127 */
128extern int proc_readdir(struct file *, void *, filldir_t);
129extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
130
131extern const struct file_operations proc_kcore_operations;
132extern const struct file_operations proc_kmsg_operations;
133extern const struct file_operations ppc_htab_operations;
134
135/*
136 * proc_tty.c
137 */
138struct tty_driver;
139extern void proc_tty_init(void);
140extern void proc_tty_register_driver(struct tty_driver *driver);
141extern void proc_tty_unregister_driver(struct tty_driver *driver);
142
143/*
144 * proc_devtree.c
145 */
146#ifdef CONFIG_PROC_DEVICETREE
147struct device_node;
148struct property;
149extern void proc_device_tree_init(void);
150extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
151extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
152extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
153 struct property *prop);
154extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
155 struct property *newprop,
156 struct property *oldprop);
157#endif /* CONFIG_PROC_DEVICETREE */
158
159extern struct proc_dir_entry *proc_symlink(const char *,
160 struct proc_dir_entry *, const char *);
161extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
162extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
163 struct proc_dir_entry *parent);
164
165static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
166 mode_t mode, struct proc_dir_entry *base,
167 read_proc_t *read_proc, void * data)
168{
169 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
170 if (res) {
171 res->read_proc=read_proc;
172 res->data=data;
173 }
174 return res;
175}
176
177static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
178 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
179{
180 struct proc_dir_entry *res=create_proc_entry(name,mode,base);
181 if (res) res->get_info=get_info;
182 return res;
183}
184
185static inline struct proc_dir_entry *proc_net_create(const char *name,
186 mode_t mode, get_info_t *get_info)
187{
188 return create_proc_info_entry(name,mode,proc_net,get_info);
189}
190
191static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
192 mode_t mode, const struct file_operations *fops)
193{
194 struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
195 if (res)
196 res->proc_fops = fops;
197 return res;
198}
199
200static inline void proc_net_remove(const char *name)
201{
202 remove_proc_entry(name,proc_net);
203}
204
205#else
206
207#define proc_root_driver NULL
208#define proc_net NULL
209#define proc_bus NULL
210
211#define proc_net_fops_create(name, mode, fops) ({ (void)(mode), NULL; })
212#define proc_net_create(name, mode, info) ({ (void)(mode), NULL; })
213static inline void proc_net_remove(const char *name) {}
214
215static inline struct dentry *proc_pid_unhash(struct task_struct *p) { return NULL; }
216static inline void proc_pid_flush(struct dentry *proc_dentry) { }
217
218static inline struct proc_dir_entry *create_proc_entry(const char *name,
219 mode_t mode, struct proc_dir_entry *parent) { return NULL; }
220
221#define remove_proc_entry(name, parent) do {} while (0)
222
223static inline struct proc_dir_entry *proc_symlink(const char *name,
224 struct proc_dir_entry *parent,const char *dest) {return NULL;}
225static inline struct proc_dir_entry *proc_mkdir(const char *name,
226 struct proc_dir_entry *parent) {return NULL;}
227
228static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
229 mode_t mode, struct proc_dir_entry *base,
230 read_proc_t *read_proc, void * data) { return NULL; }
231static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
232 mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
233 { return NULL; }
234
235struct tty_driver;
236static inline void proc_tty_register_driver(struct tty_driver *driver) {};
237static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
238
239extern struct proc_dir_entry proc_root;
240
241#endif /* CONFIG_PROC_FS */
242
243#if !defined(CONFIG_PROC_KCORE)
244static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
245{
246}
247#else
248extern void kclist_add(struct kcore_list *, void *, size_t);
249#endif
250
251struct proc_inode {
252 struct task_struct *task;
253 int type;
254 union {
255 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
256 int (*proc_read)(struct task_struct *task, char *page);
257 } op;
258 struct proc_dir_entry *pde;
259 struct inode vfs_inode;
260};
261
262static inline struct proc_inode *PROC_I(const struct inode *inode)
263{
264 return container_of(inode, struct proc_inode, vfs_inode);
265}
266
267static inline struct proc_dir_entry *PDE(const struct inode *inode)
268{
269 return PROC_I(inode)->pde;
270}
271
272#endif /* _LINUX_PROC_FS_H */