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