Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_PROC_FS_H |
2 | #define _LINUX_PROC_FS_H | |
3 | ||
1da177e4 LT |
4 | #include <linux/slab.h> |
5 | #include <linux/fs.h> | |
64a07bd8 | 6 | #include <linux/spinlock.h> |
e18fa700 | 7 | #include <linux/magic.h> |
60063497 | 8 | #include <linux/atomic.h> |
1da177e4 | 9 | |
457c4cbc | 10 | struct net; |
786d7e16 | 11 | struct completion; |
57d3c64f BN |
12 | struct mm_struct; |
13 | ||
1da177e4 LT |
14 | /* |
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 | ||
f248dcb3 MM |
23 | /* Worst case buffer size needed for holding an integer. */ |
24 | #define PROC_NUMBUF 13 | |
1da177e4 LT |
25 | |
26 | /* | |
27 | * We always define these enumerators | |
28 | */ | |
29 | ||
30 | enum { | |
31 | PROC_ROOT_INO = 1, | |
32 | }; | |
33 | ||
1da177e4 LT |
34 | /* |
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). | |
1da177e4 LT |
44 | */ |
45 | ||
46 | typedef int (read_proc_t)(char *page, char **start, off_t off, | |
47 | int count, int *eof, void *data); | |
48 | typedef int (write_proc_t)(struct file *file, const char __user *buffer, | |
49 | unsigned long count, void *data); | |
1da177e4 LT |
50 | |
51 | struct proc_dir_entry { | |
52 | unsigned int low_ino; | |
d161a13f | 53 | umode_t mode; |
1da177e4 | 54 | nlink_t nlink; |
dcb0f222 EB |
55 | kuid_t uid; |
56 | kgid_t gid; | |
22e6c1b3 | 57 | loff_t size; |
c5ef1c42 | 58 | const struct inode_operations *proc_iops; |
786d7e16 AD |
59 | /* |
60 | * NULL ->proc_fops means "PDE is going away RSN" or | |
61 | * "PDE is just created". In either case, e.g. ->read_proc won't be | |
62 | * called because it's too late or too early, respectively. | |
63 | * | |
64 | * If you're allocating ->proc_fops dynamically, save a pointer | |
65 | * somewhere. | |
66 | */ | |
c5ef1c42 | 67 | const struct file_operations *proc_fops; |
1da177e4 LT |
68 | struct proc_dir_entry *next, *parent, *subdir; |
69 | void *data; | |
70 | read_proc_t *read_proc; | |
71 | write_proc_t *write_proc; | |
72 | atomic_t count; /* use count */ | |
786d7e16 | 73 | int pde_users; /* number of callers into module in progress */ |
786d7e16 | 74 | struct completion *pde_unload_completion; |
881adb85 | 75 | struct list_head pde_openers; /* who did ->open, but not ->release */ |
09570f91 DH |
76 | spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */ |
77 | u8 namelen; | |
78 | char name[]; | |
1da177e4 LT |
79 | }; |
80 | ||
c30bb2a2 KH |
81 | enum kcore_type { |
82 | KCORE_TEXT, | |
83 | KCORE_VMALLOC, | |
84 | KCORE_RAM, | |
26562c59 | 85 | KCORE_VMEMMAP, |
c30bb2a2 KH |
86 | KCORE_OTHER, |
87 | }; | |
88 | ||
1da177e4 | 89 | struct kcore_list { |
2ef43ec7 | 90 | struct list_head list; |
1da177e4 LT |
91 | unsigned long addr; |
92 | size_t size; | |
c30bb2a2 | 93 | int type; |
1da177e4 LT |
94 | }; |
95 | ||
666bfddb VG |
96 | struct vmcore { |
97 | struct list_head list; | |
98 | unsigned long long paddr; | |
80e8ff63 | 99 | unsigned long long size; |
666bfddb VG |
100 | loff_t offset; |
101 | }; | |
102 | ||
1da177e4 LT |
103 | #ifdef CONFIG_PROC_FS |
104 | ||
1da177e4 | 105 | extern void proc_root_init(void); |
1da177e4 | 106 | |
48e6484d | 107 | void proc_flush_task(struct task_struct *task); |
7695650a | 108 | |
d161a13f | 109 | extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode, |
1da177e4 | 110 | struct proc_dir_entry *parent); |
d161a13f | 111 | struct proc_dir_entry *proc_create_data(const char *name, umode_t mode, |
2d3a4e36 | 112 | struct proc_dir_entry *parent, |
59b74351 DL |
113 | const struct file_operations *proc_fops, |
114 | void *data); | |
1da177e4 LT |
115 | extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent); |
116 | ||
07543f5c | 117 | struct pid_namespace; |
1da177e4 | 118 | |
6f4e6433 PE |
119 | extern int pid_ns_prepare_proc(struct pid_namespace *ns); |
120 | extern void pid_ns_release_proc(struct pid_namespace *ns); | |
121 | ||
1da177e4 LT |
122 | /* |
123 | * proc_tty.c | |
124 | */ | |
125 | struct tty_driver; | |
126 | extern void proc_tty_init(void); | |
127 | extern void proc_tty_register_driver(struct tty_driver *driver); | |
128 | extern void proc_tty_unregister_driver(struct tty_driver *driver); | |
129 | ||
130 | /* | |
131 | * proc_devtree.c | |
132 | */ | |
183d0202 | 133 | #ifdef CONFIG_PROC_DEVICETREE |
1da177e4 | 134 | struct device_node; |
183d0202 | 135 | struct property; |
1da177e4 | 136 | extern void proc_device_tree_init(void); |
1da177e4 | 137 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); |
183d0202 | 138 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); |
898b5395 DB |
139 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, |
140 | struct property *prop); | |
141 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, | |
142 | struct property *newprop, | |
143 | struct property *oldprop); | |
1da177e4 LT |
144 | #endif /* CONFIG_PROC_DEVICETREE */ |
145 | ||
146 | extern struct proc_dir_entry *proc_symlink(const char *, | |
147 | struct proc_dir_entry *, const char *); | |
148 | extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *); | |
d161a13f | 149 | extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode, |
1da177e4 LT |
150 | struct proc_dir_entry *parent); |
151 | ||
d161a13f | 152 | static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode, |
59b74351 DL |
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 | ||
1da177e4 | 158 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, |
d161a13f | 159 | umode_t mode, struct proc_dir_entry *base, |
1da177e4 LT |
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 | ||
457c4cbc | 170 | extern struct proc_dir_entry *proc_net_fops_create(struct net *net, |
d161a13f | 171 | const char *name, umode_t mode, const struct file_operations *fops); |
457c4cbc | 172 | extern void proc_net_remove(struct net *net, const char *name); |
e5d69b9f DL |
173 | extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name, |
174 | struct proc_dir_entry *parent); | |
1da177e4 | 175 | |
6b4e306a EB |
176 | extern struct file *proc_ns_fget(int fd); |
177 | ||
1da177e4 LT |
178 | #else |
179 | ||
457c4cbc | 180 | #define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; }) |
457c4cbc | 181 | static inline void proc_net_remove(struct net *net, const char *name) {} |
1da177e4 | 182 | |
60347f67 PE |
183 | static inline void proc_flush_task(struct task_struct *task) |
184 | { | |
185 | } | |
1da177e4 LT |
186 | |
187 | static inline struct proc_dir_entry *create_proc_entry(const char *name, | |
d161a13f | 188 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } |
2d3a4e36 | 189 | static inline struct proc_dir_entry *proc_create(const char *name, |
d161a13f | 190 | umode_t mode, struct proc_dir_entry *parent, |
2d3a4e36 AD |
191 | const struct file_operations *proc_fops) |
192 | { | |
193 | return NULL; | |
194 | } | |
59b74351 | 195 | static inline struct proc_dir_entry *proc_create_data(const char *name, |
d161a13f | 196 | umode_t mode, struct proc_dir_entry *parent, |
59b74351 DL |
197 | const struct file_operations *proc_fops, void *data) |
198 | { | |
199 | return NULL; | |
200 | } | |
1da177e4 LT |
201 | #define remove_proc_entry(name, parent) do {} while (0) |
202 | ||
203 | static inline struct proc_dir_entry *proc_symlink(const char *name, | |
204 | struct proc_dir_entry *parent,const char *dest) {return NULL;} | |
205 | static inline struct proc_dir_entry *proc_mkdir(const char *name, | |
206 | struct proc_dir_entry *parent) {return NULL;} | |
f12a20fc | 207 | static inline struct proc_dir_entry *proc_mkdir_mode(const char *name, |
d161a13f | 208 | umode_t mode, struct proc_dir_entry *parent) { return NULL; } |
1da177e4 LT |
209 | |
210 | static inline struct proc_dir_entry *create_proc_read_entry(const char *name, | |
d161a13f | 211 | umode_t mode, struct proc_dir_entry *base, |
1da177e4 | 212 | read_proc_t *read_proc, void * data) { return NULL; } |
1da177e4 LT |
213 | |
214 | struct tty_driver; | |
215 | static inline void proc_tty_register_driver(struct tty_driver *driver) {}; | |
216 | static inline void proc_tty_unregister_driver(struct tty_driver *driver) {}; | |
217 | ||
6f4e6433 PE |
218 | static inline int pid_ns_prepare_proc(struct pid_namespace *ns) |
219 | { | |
220 | return 0; | |
221 | } | |
222 | ||
223 | static inline void pid_ns_release_proc(struct pid_namespace *ns) | |
224 | { | |
225 | } | |
226 | ||
6b4e306a EB |
227 | static inline struct file *proc_ns_fget(int fd) |
228 | { | |
229 | return ERR_PTR(-EINVAL); | |
230 | } | |
231 | ||
1da177e4 LT |
232 | #endif /* CONFIG_PROC_FS */ |
233 | ||
234 | #if !defined(CONFIG_PROC_KCORE) | |
c30bb2a2 KH |
235 | static inline void |
236 | kclist_add(struct kcore_list *new, void *addr, size_t size, int type) | |
1da177e4 LT |
237 | { |
238 | } | |
239 | #else | |
c30bb2a2 | 240 | extern void kclist_add(struct kcore_list *, void *, size_t, int type); |
1da177e4 LT |
241 | #endif |
242 | ||
6b4e306a EB |
243 | struct nsproxy; |
244 | struct proc_ns_operations { | |
245 | const char *name; | |
246 | int type; | |
247 | void *(*get)(struct task_struct *task); | |
248 | void (*put)(void *ns); | |
249 | int (*install)(struct nsproxy *nsproxy, void *ns); | |
250 | }; | |
13b6f576 | 251 | extern const struct proc_ns_operations netns_operations; |
34482e89 | 252 | extern const struct proc_ns_operations utsns_operations; |
a00eaf11 | 253 | extern const struct proc_ns_operations ipcns_operations; |
6b4e306a | 254 | |
20cdc894 | 255 | union proc_op { |
7773fbc5 | 256 | int (*proc_get_link)(struct dentry *, struct path *); |
20cdc894 | 257 | int (*proc_read)(struct task_struct *task, char *page); |
be614086 EB |
258 | int (*proc_show)(struct seq_file *m, |
259 | struct pid_namespace *ns, struct pid *pid, | |
260 | struct task_struct *task); | |
20cdc894 EB |
261 | }; |
262 | ||
9043476f AV |
263 | struct ctl_table_header; |
264 | struct ctl_table; | |
265 | ||
1da177e4 | 266 | struct proc_inode { |
13b41b09 | 267 | struct pid *pid; |
aed7a6c4 | 268 | int fd; |
20cdc894 | 269 | union proc_op op; |
1da177e4 | 270 | struct proc_dir_entry *pde; |
9043476f AV |
271 | struct ctl_table_header *sysctl; |
272 | struct ctl_table *sysctl_entry; | |
6b4e306a EB |
273 | void *ns; |
274 | const struct proc_ns_operations *ns_ops; | |
1da177e4 LT |
275 | struct inode vfs_inode; |
276 | }; | |
277 | ||
278 | static inline struct proc_inode *PROC_I(const struct inode *inode) | |
279 | { | |
280 | return container_of(inode, struct proc_inode, vfs_inode); | |
281 | } | |
282 | ||
283 | static inline struct proc_dir_entry *PDE(const struct inode *inode) | |
284 | { | |
285 | return PROC_I(inode)->pde; | |
286 | } | |
287 | ||
457c4cbc EB |
288 | static inline struct net *PDE_NET(struct proc_dir_entry *pde) |
289 | { | |
290 | return pde->parent->data; | |
291 | } | |
292 | ||
1da177e4 | 293 | #endif /* _LINUX_PROC_FS_H */ |