Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
3 | * proc/fs/generic.c --- generic routines for the proc-fs | |
4 | * | |
5 | * This file contains generic proc-fs routines for handling | |
6 | * directories and files. | |
7 | * | |
8 | * Copyright (C) 1991, 1992 Linus Torvalds. | |
9 | * Copyright (C) 1997 Theodore Ts'o | |
10 | */ | |
11 | ||
b4884f23 | 12 | #include <linux/cache.h> |
1da177e4 LT |
13 | #include <linux/errno.h> |
14 | #include <linux/time.h> | |
15 | #include <linux/proc_fs.h> | |
16 | #include <linux/stat.h> | |
1025774c | 17 | #include <linux/mm.h> |
1da177e4 | 18 | #include <linux/module.h> |
1da4d377 | 19 | #include <linux/namei.h> |
5a0e3ad6 | 20 | #include <linux/slab.h> |
87ebdc00 | 21 | #include <linux/printk.h> |
1da177e4 | 22 | #include <linux/mount.h> |
1da177e4 LT |
23 | #include <linux/init.h> |
24 | #include <linux/idr.h> | |
1da177e4 | 25 | #include <linux/bitops.h> |
64a07bd8 | 26 | #include <linux/spinlock.h> |
786d7e16 | 27 | #include <linux/completion.h> |
7c0f6ba6 | 28 | #include <linux/uaccess.h> |
fddda2b7 | 29 | #include <linux/seq_file.h> |
1da177e4 | 30 | |
fee781e6 AB |
31 | #include "internal.h" |
32 | ||
ecf1a3df | 33 | static DEFINE_RWLOCK(proc_subdir_lock); |
64a07bd8 | 34 | |
b4884f23 AD |
35 | struct kmem_cache *proc_dir_entry_cache __ro_after_init; |
36 | ||
37 | void pde_free(struct proc_dir_entry *pde) | |
38 | { | |
39 | if (S_ISLNK(pde->mode)) | |
40 | kfree(pde->data); | |
41 | if (pde->name != pde->inline_name) | |
42 | kfree(pde->name); | |
43 | kmem_cache_free(proc_dir_entry_cache, pde); | |
44 | } | |
45 | ||
93ad5bc6 | 46 | static int proc_match(const char *name, struct proc_dir_entry *de, unsigned int len) |
1da177e4 | 47 | { |
710585d4 ND |
48 | if (len < de->namelen) |
49 | return -1; | |
50 | if (len > de->namelen) | |
51 | return 1; | |
52 | ||
53 | return memcmp(name, de->name, len); | |
54 | } | |
55 | ||
56 | static struct proc_dir_entry *pde_subdir_first(struct proc_dir_entry *dir) | |
57 | { | |
4f113437 AD |
58 | return rb_entry_safe(rb_first(&dir->subdir), struct proc_dir_entry, |
59 | subdir_node); | |
710585d4 ND |
60 | } |
61 | ||
62 | static struct proc_dir_entry *pde_subdir_next(struct proc_dir_entry *dir) | |
63 | { | |
2fc1e948 ND |
64 | return rb_entry_safe(rb_next(&dir->subdir_node), struct proc_dir_entry, |
65 | subdir_node); | |
710585d4 ND |
66 | } |
67 | ||
68 | static struct proc_dir_entry *pde_subdir_find(struct proc_dir_entry *dir, | |
69 | const char *name, | |
70 | unsigned int len) | |
71 | { | |
4f113437 | 72 | struct rb_node *node = dir->subdir.rb_node; |
710585d4 ND |
73 | |
74 | while (node) { | |
4e4a7fb7 GT |
75 | struct proc_dir_entry *de = rb_entry(node, |
76 | struct proc_dir_entry, | |
77 | subdir_node); | |
93ad5bc6 | 78 | int result = proc_match(name, de, len); |
710585d4 ND |
79 | |
80 | if (result < 0) | |
81 | node = node->rb_left; | |
82 | else if (result > 0) | |
83 | node = node->rb_right; | |
84 | else | |
85 | return de; | |
86 | } | |
87 | return NULL; | |
88 | } | |
89 | ||
90 | static bool pde_subdir_insert(struct proc_dir_entry *dir, | |
91 | struct proc_dir_entry *de) | |
92 | { | |
4f113437 AD |
93 | struct rb_root *root = &dir->subdir; |
94 | struct rb_node **new = &root->rb_node, *parent = NULL; | |
710585d4 ND |
95 | |
96 | /* Figure out where to put new node */ | |
97 | while (*new) { | |
4e4a7fb7 GT |
98 | struct proc_dir_entry *this = rb_entry(*new, |
99 | struct proc_dir_entry, | |
100 | subdir_node); | |
93ad5bc6 | 101 | int result = proc_match(de->name, this, de->namelen); |
710585d4 ND |
102 | |
103 | parent = *new; | |
104 | if (result < 0) | |
105 | new = &(*new)->rb_left; | |
4f113437 | 106 | else if (result > 0) |
710585d4 | 107 | new = &(*new)->rb_right; |
4f113437 | 108 | else |
710585d4 ND |
109 | return false; |
110 | } | |
111 | ||
112 | /* Add new node and rebalance tree. */ | |
113 | rb_link_node(&de->subdir_node, parent, new); | |
4f113437 | 114 | rb_insert_color(&de->subdir_node, root); |
710585d4 | 115 | return true; |
1da177e4 LT |
116 | } |
117 | ||
549c7297 CB |
118 | static int proc_notify_change(struct user_namespace *mnt_userns, |
119 | struct dentry *dentry, struct iattr *iattr) | |
1da177e4 | 120 | { |
2b0143b5 | 121 | struct inode *inode = d_inode(dentry); |
1da177e4 LT |
122 | struct proc_dir_entry *de = PDE(inode); |
123 | int error; | |
124 | ||
2f221d6f | 125 | error = setattr_prepare(&init_user_ns, dentry, iattr); |
1da177e4 | 126 | if (error) |
1025774c | 127 | return error; |
1da177e4 | 128 | |
2f221d6f | 129 | setattr_copy(&init_user_ns, inode, iattr); |
1025774c | 130 | mark_inode_dirty(inode); |
46f69557 | 131 | |
cdf7e8dd | 132 | proc_set_user(de, inode->i_uid, inode->i_gid); |
1da177e4 | 133 | de->mode = inode->i_mode; |
1025774c | 134 | return 0; |
1da177e4 LT |
135 | } |
136 | ||
549c7297 CB |
137 | static int proc_getattr(struct user_namespace *mnt_userns, |
138 | const struct path *path, struct kstat *stat, | |
a528d35e | 139 | u32 request_mask, unsigned int query_flags) |
2b579bee | 140 | { |
a528d35e | 141 | struct inode *inode = d_inode(path->dentry); |
6bee55f9 | 142 | struct proc_dir_entry *de = PDE(inode); |
e06689bf AD |
143 | if (de) { |
144 | nlink_t nlink = READ_ONCE(de->nlink); | |
145 | if (nlink > 0) { | |
146 | set_nlink(inode, nlink); | |
147 | } | |
148 | } | |
2b579bee | 149 | |
0d56a451 | 150 | generic_fillattr(&init_user_ns, inode, stat); |
2b579bee MS |
151 | return 0; |
152 | } | |
153 | ||
c5ef1c42 | 154 | static const struct inode_operations proc_file_inode_operations = { |
1da177e4 LT |
155 | .setattr = proc_notify_change, |
156 | }; | |
157 | ||
158 | /* | |
159 | * This function parses a name such as "tty/driver/serial", and | |
160 | * returns the struct proc_dir_entry for "/proc/tty/driver", and | |
161 | * returns "serial" in residual. | |
162 | */ | |
e17a5765 AD |
163 | static int __xlate_proc_name(const char *name, struct proc_dir_entry **ret, |
164 | const char **residual) | |
1da177e4 LT |
165 | { |
166 | const char *cp = name, *next; | |
167 | struct proc_dir_entry *de; | |
1da177e4 | 168 | |
7cee4e00 AD |
169 | de = *ret; |
170 | if (!de) | |
171 | de = &proc_root; | |
172 | ||
1da177e4 LT |
173 | while (1) { |
174 | next = strchr(cp, '/'); | |
175 | if (!next) | |
176 | break; | |
177 | ||
5f6354ea | 178 | de = pde_subdir_find(de, cp, next - cp); |
12bac0d9 AD |
179 | if (!de) { |
180 | WARN(1, "name '%s'\n", name); | |
e17a5765 | 181 | return -ENOENT; |
12bac0d9 | 182 | } |
5f6354ea | 183 | cp = next + 1; |
1da177e4 LT |
184 | } |
185 | *residual = cp; | |
186 | *ret = de; | |
e17a5765 AD |
187 | return 0; |
188 | } | |
189 | ||
190 | static int xlate_proc_name(const char *name, struct proc_dir_entry **ret, | |
191 | const char **residual) | |
192 | { | |
193 | int rv; | |
194 | ||
ecf1a3df | 195 | read_lock(&proc_subdir_lock); |
e17a5765 | 196 | rv = __xlate_proc_name(name, ret, residual); |
ecf1a3df | 197 | read_unlock(&proc_subdir_lock); |
e17a5765 | 198 | return rv; |
1da177e4 LT |
199 | } |
200 | ||
9a185409 | 201 | static DEFINE_IDA(proc_inum_ida); |
1da177e4 | 202 | |
67935df4 | 203 | #define PROC_DYNAMIC_FIRST 0xF0000000U |
1da177e4 LT |
204 | |
205 | /* | |
206 | * Return an inode number between PROC_DYNAMIC_FIRST and | |
207 | * 0xffffffff, or zero on failure. | |
208 | */ | |
33d6dce6 | 209 | int proc_alloc_inum(unsigned int *inum) |
1da177e4 | 210 | { |
cde1b693 | 211 | int i; |
1da177e4 | 212 | |
cde1b693 HK |
213 | i = ida_simple_get(&proc_inum_ida, 0, UINT_MAX - PROC_DYNAMIC_FIRST + 1, |
214 | GFP_KERNEL); | |
215 | if (i < 0) | |
216 | return i; | |
1da177e4 | 217 | |
cde1b693 | 218 | *inum = PROC_DYNAMIC_FIRST + (unsigned int)i; |
33d6dce6 | 219 | return 0; |
1da177e4 LT |
220 | } |
221 | ||
33d6dce6 | 222 | void proc_free_inum(unsigned int inum) |
1da177e4 | 223 | { |
cde1b693 | 224 | ida_simple_remove(&proc_inum_ida, inum - PROC_DYNAMIC_FIRST); |
1da177e4 LT |
225 | } |
226 | ||
1da4d377 AD |
227 | static int proc_misc_d_revalidate(struct dentry *dentry, unsigned int flags) |
228 | { | |
229 | if (flags & LOOKUP_RCU) | |
230 | return -ECHILD; | |
231 | ||
232 | if (atomic_read(&PDE(d_inode(dentry))->in_use) < 0) | |
233 | return 0; /* revalidate */ | |
234 | return 1; | |
235 | } | |
236 | ||
237 | static int proc_misc_d_delete(const struct dentry *dentry) | |
238 | { | |
239 | return atomic_read(&PDE(d_inode(dentry))->in_use) < 0; | |
240 | } | |
241 | ||
242 | static const struct dentry_operations proc_misc_dentry_ops = { | |
243 | .d_revalidate = proc_misc_d_revalidate, | |
244 | .d_delete = proc_misc_d_delete, | |
245 | }; | |
246 | ||
1da177e4 LT |
247 | /* |
248 | * Don't create negative dentries here, return -ENOENT by hand | |
249 | * instead. | |
250 | */ | |
93ad5bc6 AD |
251 | struct dentry *proc_lookup_de(struct inode *dir, struct dentry *dentry, |
252 | struct proc_dir_entry *de) | |
1da177e4 | 253 | { |
d3d009cb | 254 | struct inode *inode; |
1da177e4 | 255 | |
ecf1a3df | 256 | read_lock(&proc_subdir_lock); |
710585d4 ND |
257 | de = pde_subdir_find(de, dentry->d_name.name, dentry->d_name.len); |
258 | if (de) { | |
259 | pde_get(de); | |
ecf1a3df | 260 | read_unlock(&proc_subdir_lock); |
710585d4 ND |
261 | inode = proc_get_inode(dir->i_sb, de); |
262 | if (!inode) | |
263 | return ERR_PTR(-ENOMEM); | |
1fde6f21 | 264 | d_set_d_op(dentry, de->proc_dops); |
888e2b03 | 265 | return d_splice_alias(inode, dentry); |
1da177e4 | 266 | } |
ecf1a3df | 267 | read_unlock(&proc_subdir_lock); |
d3d009cb | 268 | return ERR_PTR(-ENOENT); |
1da177e4 LT |
269 | } |
270 | ||
e9720acd | 271 | struct dentry *proc_lookup(struct inode *dir, struct dentry *dentry, |
00cd8dd3 | 272 | unsigned int flags) |
e9720acd | 273 | { |
6814ef2d AG |
274 | struct proc_fs_info *fs_info = proc_sb_info(dir->i_sb); |
275 | ||
276 | if (fs_info->pidonly == PROC_PIDONLY_ON) | |
277 | return ERR_PTR(-ENOENT); | |
278 | ||
93ad5bc6 | 279 | return proc_lookup_de(dir, dentry, PDE(dir)); |
e9720acd PE |
280 | } |
281 | ||
1da177e4 LT |
282 | /* |
283 | * This returns non-zero if at EOF, so that the /proc | |
284 | * root directory can use this and check if it should | |
285 | * continue with the <pid> entries.. | |
286 | * | |
287 | * Note that the VFS-layer doesn't care about the return | |
288 | * value of the readdir() call, as long as it's non-negative | |
289 | * for success.. | |
290 | */ | |
93ad5bc6 AD |
291 | int proc_readdir_de(struct file *file, struct dir_context *ctx, |
292 | struct proc_dir_entry *de) | |
1da177e4 | 293 | { |
1da177e4 | 294 | int i; |
f0c3b509 AV |
295 | |
296 | if (!dir_emit_dots(file, ctx)) | |
297 | return 0; | |
298 | ||
8d48b2e0 | 299 | i = ctx->pos - 2; |
ecf1a3df | 300 | read_lock(&proc_subdir_lock); |
710585d4 | 301 | de = pde_subdir_first(de); |
f0c3b509 AV |
302 | for (;;) { |
303 | if (!de) { | |
ecf1a3df | 304 | read_unlock(&proc_subdir_lock); |
f0c3b509 AV |
305 | return 0; |
306 | } | |
307 | if (!i) | |
308 | break; | |
710585d4 | 309 | de = pde_subdir_next(de); |
f0c3b509 | 310 | i--; |
1da177e4 | 311 | } |
f0c3b509 AV |
312 | |
313 | do { | |
314 | struct proc_dir_entry *next; | |
315 | pde_get(de); | |
ecf1a3df | 316 | read_unlock(&proc_subdir_lock); |
f0c3b509 AV |
317 | if (!dir_emit(ctx, de->name, de->namelen, |
318 | de->low_ino, de->mode >> 12)) { | |
319 | pde_put(de); | |
320 | return 0; | |
321 | } | |
f0c3b509 | 322 | ctx->pos++; |
8d48b2e0 | 323 | read_lock(&proc_subdir_lock); |
710585d4 | 324 | next = pde_subdir_next(de); |
f0c3b509 AV |
325 | pde_put(de); |
326 | de = next; | |
327 | } while (de); | |
ecf1a3df | 328 | read_unlock(&proc_subdir_lock); |
fd3930f7 | 329 | return 1; |
1da177e4 LT |
330 | } |
331 | ||
f0c3b509 | 332 | int proc_readdir(struct file *file, struct dir_context *ctx) |
e9720acd | 333 | { |
f0c3b509 | 334 | struct inode *inode = file_inode(file); |
6814ef2d AG |
335 | struct proc_fs_info *fs_info = proc_sb_info(inode->i_sb); |
336 | ||
337 | if (fs_info->pidonly == PROC_PIDONLY_ON) | |
338 | return 1; | |
e9720acd | 339 | |
93ad5bc6 | 340 | return proc_readdir_de(file, ctx, PDE(inode)); |
e9720acd PE |
341 | } |
342 | ||
1da177e4 LT |
343 | /* |
344 | * These are the generic /proc directory operations. They | |
345 | * use the in-memory "struct proc_dir_entry" tree to parse | |
346 | * the /proc directory. | |
347 | */ | |
00977a59 | 348 | static const struct file_operations proc_dir_operations = { |
b4df2b92 | 349 | .llseek = generic_file_llseek, |
1da177e4 | 350 | .read = generic_read_dir, |
f50752ea | 351 | .iterate_shared = proc_readdir, |
1da177e4 LT |
352 | }; |
353 | ||
c6c75ded AD |
354 | static int proc_net_d_revalidate(struct dentry *dentry, unsigned int flags) |
355 | { | |
356 | return 0; | |
357 | } | |
358 | ||
359 | const struct dentry_operations proc_net_dentry_ops = { | |
360 | .d_revalidate = proc_net_d_revalidate, | |
361 | .d_delete = always_delete_dentry, | |
362 | }; | |
363 | ||
1da177e4 LT |
364 | /* |
365 | * proc directories can do almost nothing.. | |
366 | */ | |
c5ef1c42 | 367 | static const struct inode_operations proc_dir_inode_operations = { |
1da177e4 | 368 | .lookup = proc_lookup, |
2b579bee | 369 | .getattr = proc_getattr, |
1da177e4 LT |
370 | .setattr = proc_notify_change, |
371 | }; | |
372 | ||
61172eae CH |
373 | /* returns the registered entry, or frees dp and returns NULL on failure */ |
374 | struct proc_dir_entry *proc_register(struct proc_dir_entry *dir, | |
375 | struct proc_dir_entry *dp) | |
1da177e4 | 376 | { |
61172eae CH |
377 | if (proc_alloc_inum(&dp->low_ino)) |
378 | goto out_free_entry; | |
64a07bd8 | 379 | |
ecf1a3df | 380 | write_lock(&proc_subdir_lock); |
99fc06df | 381 | dp->parent = dir; |
b208d54b | 382 | if (pde_subdir_insert(dir, dp) == false) { |
710585d4 ND |
383 | WARN(1, "proc_dir_entry '%s/%s' already registered\n", |
384 | dir->name, dp->name); | |
ecf1a3df | 385 | write_unlock(&proc_subdir_lock); |
61172eae | 386 | goto out_free_inum; |
b208d54b | 387 | } |
e06689bf | 388 | dir->nlink++; |
ecf1a3df | 389 | write_unlock(&proc_subdir_lock); |
99fc06df | 390 | |
61172eae CH |
391 | return dp; |
392 | out_free_inum: | |
393 | proc_free_inum(dp->low_ino); | |
394 | out_free_entry: | |
395 | pde_free(dp); | |
396 | return NULL; | |
1da177e4 LT |
397 | } |
398 | ||
2d3a4e36 | 399 | static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent, |
1da177e4 | 400 | const char *name, |
d161a13f | 401 | umode_t mode, |
1da177e4 LT |
402 | nlink_t nlink) |
403 | { | |
404 | struct proc_dir_entry *ent = NULL; | |
dbcdb504 AD |
405 | const char *fn; |
406 | struct qstr qstr; | |
1da177e4 | 407 | |
7cee4e00 | 408 | if (xlate_proc_name(name, parent, &fn) != 0) |
1da177e4 | 409 | goto out; |
dbcdb504 AD |
410 | qstr.name = fn; |
411 | qstr.len = strlen(fn); | |
412 | if (qstr.len == 0 || qstr.len >= 256) { | |
413 | WARN(1, "name len %u\n", qstr.len); | |
414 | return NULL; | |
415 | } | |
b77d70db AD |
416 | if (qstr.len == 1 && fn[0] == '.') { |
417 | WARN(1, "name '.'\n"); | |
418 | return NULL; | |
419 | } | |
420 | if (qstr.len == 2 && fn[0] == '.' && fn[1] == '.') { | |
421 | WARN(1, "name '..'\n"); | |
422 | return NULL; | |
423 | } | |
dbcdb504 AD |
424 | if (*parent == &proc_root && name_to_int(&qstr) != ~0U) { |
425 | WARN(1, "create '/proc/%s' by hand\n", qstr.name); | |
426 | return NULL; | |
427 | } | |
eb6d38d5 EB |
428 | if (is_empty_pde(*parent)) { |
429 | WARN(1, "attempt to add to permanently empty directory"); | |
430 | return NULL; | |
431 | } | |
1da177e4 | 432 | |
b4884f23 | 433 | ent = kmem_cache_zalloc(proc_dir_entry_cache, GFP_KERNEL); |
17baa2a2 | 434 | if (!ent) |
435 | goto out; | |
1da177e4 | 436 | |
24074a35 | 437 | if (qstr.len + 1 <= SIZEOF_PDE_INLINE_NAME) { |
b4884f23 AD |
438 | ent->name = ent->inline_name; |
439 | } else { | |
440 | ent->name = kmalloc(qstr.len + 1, GFP_KERNEL); | |
441 | if (!ent->name) { | |
442 | pde_free(ent); | |
443 | return NULL; | |
444 | } | |
445 | } | |
446 | ||
dbcdb504 AD |
447 | memcpy(ent->name, fn, qstr.len + 1); |
448 | ent->namelen = qstr.len; | |
1da177e4 LT |
449 | ent->mode = mode; |
450 | ent->nlink = nlink; | |
4f113437 | 451 | ent->subdir = RB_ROOT; |
9cdd83e3 | 452 | refcount_set(&ent->refcnt, 1); |
786d7e16 | 453 | spin_lock_init(&ent->pde_unload_lock); |
881adb85 | 454 | INIT_LIST_HEAD(&ent->pde_openers); |
c110486f DT |
455 | proc_set_user(ent, (*parent)->uid, (*parent)->gid); |
456 | ||
1fde6f21 AD |
457 | ent->proc_dops = &proc_misc_dentry_ops; |
458 | ||
17baa2a2 | 459 | out: |
1da177e4 LT |
460 | return ent; |
461 | } | |
462 | ||
463 | struct proc_dir_entry *proc_symlink(const char *name, | |
464 | struct proc_dir_entry *parent, const char *dest) | |
465 | { | |
466 | struct proc_dir_entry *ent; | |
467 | ||
2d3a4e36 | 468 | ent = __proc_create(&parent, name, |
1da177e4 LT |
469 | (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1); |
470 | ||
471 | if (ent) { | |
472 | ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL); | |
473 | if (ent->data) { | |
474 | strcpy((char*)ent->data,dest); | |
d443b9fd | 475 | ent->proc_iops = &proc_link_inode_operations; |
61172eae | 476 | ent = proc_register(parent, ent); |
1da177e4 | 477 | } else { |
b4884f23 | 478 | pde_free(ent); |
1da177e4 LT |
479 | ent = NULL; |
480 | } | |
481 | } | |
482 | return ent; | |
483 | } | |
587d4a17 | 484 | EXPORT_SYMBOL(proc_symlink); |
1da177e4 | 485 | |
c6c75ded AD |
486 | struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode, |
487 | struct proc_dir_entry *parent, void *data, bool force_lookup) | |
1da177e4 LT |
488 | { |
489 | struct proc_dir_entry *ent; | |
490 | ||
270b5ac2 DH |
491 | if (mode == 0) |
492 | mode = S_IRUGO | S_IXUGO; | |
493 | ||
2d3a4e36 | 494 | ent = __proc_create(&parent, name, S_IFDIR | mode, 2); |
1da177e4 | 495 | if (ent) { |
270b5ac2 | 496 | ent->data = data; |
d56c0d45 | 497 | ent->proc_dir_ops = &proc_dir_operations; |
d443b9fd | 498 | ent->proc_iops = &proc_dir_inode_operations; |
c6c75ded AD |
499 | if (force_lookup) { |
500 | pde_force_lookup(ent); | |
501 | } | |
61172eae | 502 | ent = proc_register(parent, ent); |
1da177e4 LT |
503 | } |
504 | return ent; | |
505 | } | |
c6c75ded AD |
506 | EXPORT_SYMBOL_GPL(_proc_mkdir); |
507 | ||
508 | struct proc_dir_entry *proc_mkdir_data(const char *name, umode_t mode, | |
509 | struct proc_dir_entry *parent, void *data) | |
510 | { | |
511 | return _proc_mkdir(name, mode, parent, data, false); | |
512 | } | |
270b5ac2 | 513 | EXPORT_SYMBOL_GPL(proc_mkdir_data); |
1da177e4 | 514 | |
270b5ac2 DH |
515 | struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode, |
516 | struct proc_dir_entry *parent) | |
78e92b99 | 517 | { |
270b5ac2 | 518 | return proc_mkdir_data(name, mode, parent, NULL); |
78e92b99 | 519 | } |
270b5ac2 | 520 | EXPORT_SYMBOL(proc_mkdir_mode); |
78e92b99 | 521 | |
1da177e4 LT |
522 | struct proc_dir_entry *proc_mkdir(const char *name, |
523 | struct proc_dir_entry *parent) | |
524 | { | |
270b5ac2 | 525 | return proc_mkdir_data(name, 0, parent, NULL); |
1da177e4 | 526 | } |
587d4a17 | 527 | EXPORT_SYMBOL(proc_mkdir); |
1da177e4 | 528 | |
eb6d38d5 EB |
529 | struct proc_dir_entry *proc_create_mount_point(const char *name) |
530 | { | |
531 | umode_t mode = S_IFDIR | S_IRUGO | S_IXUGO; | |
532 | struct proc_dir_entry *ent, *parent = NULL; | |
533 | ||
534 | ent = __proc_create(&parent, name, mode, 2); | |
535 | if (ent) { | |
536 | ent->data = NULL; | |
d56c0d45 | 537 | ent->proc_dir_ops = NULL; |
eb6d38d5 | 538 | ent->proc_iops = NULL; |
61172eae | 539 | ent = proc_register(parent, ent); |
eb6d38d5 EB |
540 | } |
541 | return ent; | |
542 | } | |
f97df70b | 543 | EXPORT_SYMBOL(proc_create_mount_point); |
eb6d38d5 | 544 | |
7aed53d1 CH |
545 | struct proc_dir_entry *proc_create_reg(const char *name, umode_t mode, |
546 | struct proc_dir_entry **parent, void *data) | |
2d3a4e36 | 547 | { |
7aed53d1 CH |
548 | struct proc_dir_entry *p; |
549 | ||
b6cdc731 AV |
550 | if ((mode & S_IFMT) == 0) |
551 | mode |= S_IFREG; | |
7aed53d1 CH |
552 | if ((mode & S_IALLUGO) == 0) |
553 | mode |= S_IRUGO; | |
554 | if (WARN_ON_ONCE(!S_ISREG(mode))) | |
b6cdc731 | 555 | return NULL; |
7aed53d1 CH |
556 | |
557 | p = __proc_create(parent, name, mode, 1); | |
558 | if (p) { | |
559 | p->proc_iops = &proc_file_inode_operations; | |
560 | p->data = data; | |
2d3a4e36 | 561 | } |
7aed53d1 CH |
562 | return p; |
563 | } | |
564 | ||
d919b33d AD |
565 | static inline void pde_set_flags(struct proc_dir_entry *pde) |
566 | { | |
567 | if (pde->proc_ops->proc_flags & PROC_ENTRY_PERMANENT) | |
568 | pde->flags |= PROC_ENTRY_PERMANENT; | |
569 | } | |
570 | ||
7aed53d1 CH |
571 | struct proc_dir_entry *proc_create_data(const char *name, umode_t mode, |
572 | struct proc_dir_entry *parent, | |
d56c0d45 | 573 | const struct proc_ops *proc_ops, void *data) |
7aed53d1 CH |
574 | { |
575 | struct proc_dir_entry *p; | |
2d3a4e36 | 576 | |
7aed53d1 CH |
577 | p = proc_create_reg(name, mode, &parent, data); |
578 | if (!p) | |
579 | return NULL; | |
d56c0d45 | 580 | p->proc_ops = proc_ops; |
d919b33d | 581 | pde_set_flags(p); |
7aed53d1 | 582 | return proc_register(parent, p); |
2d3a4e36 | 583 | } |
587d4a17 | 584 | EXPORT_SYMBOL(proc_create_data); |
271a15ea | 585 | |
855d9765 AD |
586 | struct proc_dir_entry *proc_create(const char *name, umode_t mode, |
587 | struct proc_dir_entry *parent, | |
d56c0d45 | 588 | const struct proc_ops *proc_ops) |
855d9765 | 589 | { |
d56c0d45 | 590 | return proc_create_data(name, mode, parent, proc_ops, NULL); |
855d9765 AD |
591 | } |
592 | EXPORT_SYMBOL(proc_create); | |
593 | ||
fddda2b7 CH |
594 | static int proc_seq_open(struct inode *inode, struct file *file) |
595 | { | |
596 | struct proc_dir_entry *de = PDE(inode); | |
597 | ||
44414d82 CH |
598 | if (de->state_size) |
599 | return seq_open_private(file, de->seq_ops, de->state_size); | |
fddda2b7 CH |
600 | return seq_open(file, de->seq_ops); |
601 | } | |
602 | ||
877f919e CH |
603 | static int proc_seq_release(struct inode *inode, struct file *file) |
604 | { | |
605 | struct proc_dir_entry *de = PDE(inode); | |
606 | ||
607 | if (de->state_size) | |
608 | return seq_release_private(inode, file); | |
609 | return seq_release(inode, file); | |
610 | } | |
611 | ||
d56c0d45 | 612 | static const struct proc_ops proc_seq_ops = { |
d919b33d | 613 | /* not permanent -- can call into arbitrary seq_operations */ |
d56c0d45 | 614 | .proc_open = proc_seq_open, |
b24c30c6 | 615 | .proc_read_iter = seq_read_iter, |
d56c0d45 AD |
616 | .proc_lseek = seq_lseek, |
617 | .proc_release = proc_seq_release, | |
fddda2b7 CH |
618 | }; |
619 | ||
44414d82 | 620 | struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode, |
fddda2b7 | 621 | struct proc_dir_entry *parent, const struct seq_operations *ops, |
44414d82 | 622 | unsigned int state_size, void *data) |
fddda2b7 CH |
623 | { |
624 | struct proc_dir_entry *p; | |
625 | ||
626 | p = proc_create_reg(name, mode, &parent, data); | |
627 | if (!p) | |
628 | return NULL; | |
d56c0d45 | 629 | p->proc_ops = &proc_seq_ops; |
fddda2b7 | 630 | p->seq_ops = ops; |
44414d82 | 631 | p->state_size = state_size; |
fddda2b7 CH |
632 | return proc_register(parent, p); |
633 | } | |
44414d82 | 634 | EXPORT_SYMBOL(proc_create_seq_private); |
fddda2b7 | 635 | |
3f3942ac CH |
636 | static int proc_single_open(struct inode *inode, struct file *file) |
637 | { | |
638 | struct proc_dir_entry *de = PDE(inode); | |
639 | ||
640 | return single_open(file, de->single_show, de->data); | |
641 | } | |
642 | ||
d56c0d45 | 643 | static const struct proc_ops proc_single_ops = { |
d919b33d | 644 | /* not permanent -- can call into arbitrary ->single_show */ |
d56c0d45 | 645 | .proc_open = proc_single_open, |
7cfc630e | 646 | .proc_read_iter = seq_read_iter, |
d56c0d45 AD |
647 | .proc_lseek = seq_lseek, |
648 | .proc_release = single_release, | |
3f3942ac CH |
649 | }; |
650 | ||
651 | struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode, | |
652 | struct proc_dir_entry *parent, | |
653 | int (*show)(struct seq_file *, void *), void *data) | |
654 | { | |
655 | struct proc_dir_entry *p; | |
656 | ||
657 | p = proc_create_reg(name, mode, &parent, data); | |
658 | if (!p) | |
659 | return NULL; | |
d56c0d45 | 660 | p->proc_ops = &proc_single_ops; |
3f3942ac CH |
661 | p->single_show = show; |
662 | return proc_register(parent, p); | |
663 | } | |
664 | EXPORT_SYMBOL(proc_create_single_data); | |
665 | ||
271a15ea DH |
666 | void proc_set_size(struct proc_dir_entry *de, loff_t size) |
667 | { | |
668 | de->size = size; | |
669 | } | |
670 | EXPORT_SYMBOL(proc_set_size); | |
671 | ||
672 | void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) | |
673 | { | |
674 | de->uid = uid; | |
675 | de->gid = gid; | |
676 | } | |
677 | EXPORT_SYMBOL(proc_set_user); | |
2d3a4e36 | 678 | |
135d5655 AD |
679 | void pde_put(struct proc_dir_entry *pde) |
680 | { | |
9cdd83e3 | 681 | if (refcount_dec_and_test(&pde->refcnt)) { |
b4884f23 AD |
682 | proc_free_inum(pde->low_ino); |
683 | pde_free(pde); | |
684 | } | |
135d5655 AD |
685 | } |
686 | ||
8ce584c7 AV |
687 | /* |
688 | * Remove a /proc entry and free it if it's not currently in use. | |
689 | */ | |
690 | void remove_proc_entry(const char *name, struct proc_dir_entry *parent) | |
691 | { | |
8ce584c7 AV |
692 | struct proc_dir_entry *de = NULL; |
693 | const char *fn = name; | |
694 | unsigned int len; | |
695 | ||
ecf1a3df | 696 | write_lock(&proc_subdir_lock); |
8ce584c7 | 697 | if (__xlate_proc_name(name, &parent, &fn) != 0) { |
ecf1a3df | 698 | write_unlock(&proc_subdir_lock); |
8ce584c7 AV |
699 | return; |
700 | } | |
701 | len = strlen(fn); | |
702 | ||
710585d4 | 703 | de = pde_subdir_find(parent, fn, len); |
e06689bf | 704 | if (de) { |
d919b33d AD |
705 | if (unlikely(pde_is_permanent(de))) { |
706 | WARN(1, "removing permanent /proc entry '%s'", de->name); | |
707 | de = NULL; | |
708 | } else { | |
709 | rb_erase(&de->subdir_node, &parent->subdir); | |
710 | if (S_ISDIR(de->mode)) | |
711 | parent->nlink--; | |
e06689bf AD |
712 | } |
713 | } | |
ecf1a3df | 714 | write_unlock(&proc_subdir_lock); |
8ce584c7 AV |
715 | if (!de) { |
716 | WARN(1, "name '%s'\n", name); | |
717 | return; | |
718 | } | |
719 | ||
866ad9a7 | 720 | proc_entry_rundown(de); |
881adb85 | 721 | |
710585d4 ND |
722 | WARN(pde_subdir_first(de), |
723 | "%s: removing non-empty directory '%s/%s', leaking at least '%s'\n", | |
724 | __func__, de->parent->name, de->name, pde_subdir_first(de)->name); | |
135d5655 | 725 | pde_put(de); |
1da177e4 | 726 | } |
587d4a17 | 727 | EXPORT_SYMBOL(remove_proc_entry); |
8ce584c7 AV |
728 | |
729 | int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) | |
730 | { | |
8ce584c7 AV |
731 | struct proc_dir_entry *root = NULL, *de, *next; |
732 | const char *fn = name; | |
733 | unsigned int len; | |
734 | ||
ecf1a3df | 735 | write_lock(&proc_subdir_lock); |
8ce584c7 | 736 | if (__xlate_proc_name(name, &parent, &fn) != 0) { |
ecf1a3df | 737 | write_unlock(&proc_subdir_lock); |
8ce584c7 AV |
738 | return -ENOENT; |
739 | } | |
740 | len = strlen(fn); | |
741 | ||
710585d4 | 742 | root = pde_subdir_find(parent, fn, len); |
8ce584c7 | 743 | if (!root) { |
ecf1a3df | 744 | write_unlock(&proc_subdir_lock); |
8ce584c7 AV |
745 | return -ENOENT; |
746 | } | |
d919b33d AD |
747 | if (unlikely(pde_is_permanent(root))) { |
748 | write_unlock(&proc_subdir_lock); | |
749 | WARN(1, "removing permanent /proc entry '%s/%s'", | |
750 | root->parent->name, root->name); | |
751 | return -EINVAL; | |
752 | } | |
4f113437 | 753 | rb_erase(&root->subdir_node, &parent->subdir); |
710585d4 | 754 | |
8ce584c7 AV |
755 | de = root; |
756 | while (1) { | |
710585d4 | 757 | next = pde_subdir_first(de); |
8ce584c7 | 758 | if (next) { |
d919b33d AD |
759 | if (unlikely(pde_is_permanent(root))) { |
760 | write_unlock(&proc_subdir_lock); | |
761 | WARN(1, "removing permanent /proc entry '%s/%s'", | |
762 | next->parent->name, next->name); | |
763 | return -EINVAL; | |
764 | } | |
4f113437 | 765 | rb_erase(&next->subdir_node, &de->subdir); |
8ce584c7 AV |
766 | de = next; |
767 | continue; | |
768 | } | |
8ce584c7 AV |
769 | next = de->parent; |
770 | if (S_ISDIR(de->mode)) | |
771 | next->nlink--; | |
e06689bf AD |
772 | write_unlock(&proc_subdir_lock); |
773 | ||
774 | proc_entry_rundown(de); | |
8ce584c7 AV |
775 | if (de == root) |
776 | break; | |
777 | pde_put(de); | |
778 | ||
ecf1a3df | 779 | write_lock(&proc_subdir_lock); |
8ce584c7 AV |
780 | de = next; |
781 | } | |
782 | pde_put(root); | |
783 | return 0; | |
784 | } | |
785 | EXPORT_SYMBOL(remove_proc_subtree); | |
4a520d27 DH |
786 | |
787 | void *proc_get_parent_data(const struct inode *inode) | |
788 | { | |
789 | struct proc_dir_entry *de = PDE(inode); | |
790 | return de->parent->data; | |
791 | } | |
792 | EXPORT_SYMBOL_GPL(proc_get_parent_data); | |
a8ca16ea DH |
793 | |
794 | void proc_remove(struct proc_dir_entry *de) | |
795 | { | |
796 | if (de) | |
797 | remove_proc_subtree(de->name, de->parent); | |
798 | } | |
799 | EXPORT_SYMBOL(proc_remove); | |
c30480b9 DH |
800 | |
801 | void *PDE_DATA(const struct inode *inode) | |
802 | { | |
803 | return __PDE_DATA(inode); | |
804 | } | |
805 | EXPORT_SYMBOL(PDE_DATA); | |
564def71 DH |
806 | |
807 | /* | |
808 | * Pull a user buffer into memory and pass it to the file's write handler if | |
809 | * one is supplied. The ->write() method is permitted to modify the | |
810 | * kernel-side buffer. | |
811 | */ | |
812 | ssize_t proc_simple_write(struct file *f, const char __user *ubuf, size_t size, | |
813 | loff_t *_pos) | |
814 | { | |
815 | struct proc_dir_entry *pde = PDE(file_inode(f)); | |
816 | char *buf; | |
817 | int ret; | |
818 | ||
819 | if (!pde->write) | |
820 | return -EACCES; | |
821 | if (size == 0 || size > PAGE_SIZE - 1) | |
822 | return -EINVAL; | |
823 | buf = memdup_user_nul(ubuf, size); | |
824 | if (IS_ERR(buf)) | |
825 | return PTR_ERR(buf); | |
826 | ret = pde->write(f, buf, size); | |
827 | kfree(buf); | |
828 | return ret == 0 ? size : ret; | |
829 | } |