xref: /linux/fs/proc/generic.c (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba) 
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 
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 
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 
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 
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 
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 
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 
118 static int proc_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
119 		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 
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_setattr,
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  */
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 
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  */
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 
214 void proc_free_inum(unsigned int inum)
215 {
216 	ida_free(&proc_inum_ida, inum - PROC_DYNAMIC_FIRST);
217 }
218 
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 
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  */
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 
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  */
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 
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 
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_setattr,
368 };
369 
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 */
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 	if (!S_ISDIR(dp->mode))
397 		pde_set_flags(dp);
398 
399 	write_lock(&proc_subdir_lock);
400 	dp->parent = dir;
401 	if (pde_subdir_insert(dir, dp) == false) {
402 		WARN(1, "proc_dir_entry '%s/%s' already registered\n",
403 		     dir->name, dp->name);
404 		write_unlock(&proc_subdir_lock);
405 		goto out_free_inum;
406 	}
407 	dir->nlink++;
408 	write_unlock(&proc_subdir_lock);
409 
410 	return dp;
411 out_free_inum:
412 	proc_free_inum(dp->low_ino);
413 out_free_entry:
414 	pde_free(dp);
415 	return NULL;
416 }
417 
418 static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
419 					  const char *name,
420 					  umode_t mode,
421 					  nlink_t nlink)
422 {
423 	struct proc_dir_entry *ent = NULL;
424 	const char *fn;
425 	struct qstr qstr;
426 
427 	if (xlate_proc_name(name, parent, &fn) != 0)
428 		goto out;
429 	qstr.name = fn;
430 	qstr.len = strnlen(fn, NAME_MAX + 1);
431 	if (qstr.len == 0) {
432 		WARN(1, "empty name\n");
433 		return NULL;
434 	}
435 	if (qstr.len > NAME_MAX) {
436 		WARN(1, "name too long\n");
437 		return NULL;
438 	}
439 	if (qstr.len == 1 && fn[0] == '.') {
440 		WARN(1, "name '.'\n");
441 		return NULL;
442 	}
443 	if (qstr.len == 2 && fn[0] == '.' && fn[1] == '.') {
444 		WARN(1, "name '..'\n");
445 		return NULL;
446 	}
447 	if (*parent == &proc_root && name_to_int(&qstr) != ~0U) {
448 		WARN(1, "create '/proc/%s' by hand\n", qstr.name);
449 		return NULL;
450 	}
451 	if (is_empty_pde(*parent)) {
452 		WARN(1, "attempt to add to permanently empty directory");
453 		return NULL;
454 	}
455 
456 	ent = kmem_cache_zalloc(proc_dir_entry_cache, GFP_KERNEL);
457 	if (!ent)
458 		goto out;
459 
460 	if (qstr.len + 1 <= SIZEOF_PDE_INLINE_NAME) {
461 		ent->name = ent->inline_name;
462 	} else {
463 		ent->name = kmalloc(qstr.len + 1, GFP_KERNEL);
464 		if (!ent->name) {
465 			pde_free(ent);
466 			return NULL;
467 		}
468 	}
469 
470 	memcpy(ent->name, fn, qstr.len + 1);
471 	ent->namelen = qstr.len;
472 	ent->mode = mode;
473 	ent->nlink = nlink;
474 	ent->subdir = RB_ROOT;
475 	refcount_set(&ent->refcnt, 1);
476 	spin_lock_init(&ent->pde_unload_lock);
477 	INIT_LIST_HEAD(&ent->pde_openers);
478 	proc_set_user(ent, (*parent)->uid, (*parent)->gid);
479 
480 	/* Revalidate everything under /proc/${pid}/net */
481 	if ((*parent)->flags & PROC_ENTRY_FORCE_LOOKUP)
482 		pde_force_lookup(ent);
483 
484 out:
485 	return ent;
486 }
487 
488 struct proc_dir_entry *proc_symlink(const char *name,
489 		struct proc_dir_entry *parent, const char *dest)
490 {
491 	struct proc_dir_entry *ent;
492 
493 	ent = __proc_create(&parent, name,
494 			  (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
495 
496 	if (ent) {
497 		ent->size = strlen(dest);
498 		ent->data = kmemdup(dest, ent->size + 1, GFP_KERNEL);
499 		if (ent->data) {
500 			ent->proc_iops = &proc_link_inode_operations;
501 			ent = proc_register(parent, ent);
502 		} else {
503 			pde_free(ent);
504 			ent = NULL;
505 		}
506 	}
507 	return ent;
508 }
509 EXPORT_SYMBOL(proc_symlink);
510 
511 struct proc_dir_entry *_proc_mkdir(const char *name, umode_t mode,
512 		struct proc_dir_entry *parent, void *data, bool force_lookup)
513 {
514 	struct proc_dir_entry *ent;
515 
516 	if (mode == 0)
517 		mode = S_IRUGO | S_IXUGO;
518 
519 	ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
520 	if (ent) {
521 		ent->data = data;
522 		ent->proc_dir_ops = &proc_dir_operations;
523 		ent->proc_iops = &proc_dir_inode_operations;
524 		if (force_lookup) {
525 			pde_force_lookup(ent);
526 		}
527 		ent = proc_register(parent, ent);
528 	}
529 	return ent;
530 }
531 EXPORT_SYMBOL_GPL(_proc_mkdir);
532 
533 struct proc_dir_entry *proc_mkdir_data(const char *name, umode_t mode,
534 		struct proc_dir_entry *parent, void *data)
535 {
536 	return _proc_mkdir(name, mode, parent, data, false);
537 }
538 EXPORT_SYMBOL_GPL(proc_mkdir_data);
539 
540 struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
541 				       struct proc_dir_entry *parent)
542 {
543 	return proc_mkdir_data(name, mode, parent, NULL);
544 }
545 EXPORT_SYMBOL(proc_mkdir_mode);
546 
547 struct proc_dir_entry *proc_mkdir(const char *name,
548 		struct proc_dir_entry *parent)
549 {
550 	return proc_mkdir_data(name, 0, parent, NULL);
551 }
552 EXPORT_SYMBOL(proc_mkdir);
553 
554 struct proc_dir_entry *proc_create_mount_point(const char *name)
555 {
556 	umode_t mode = S_IFDIR | S_IRUGO | S_IXUGO;
557 	struct proc_dir_entry *ent, *parent = NULL;
558 
559 	ent = __proc_create(&parent, name, mode, 2);
560 	if (ent) {
561 		ent->data = NULL;
562 		ent->proc_dir_ops = NULL;
563 		ent->proc_iops = NULL;
564 		ent = proc_register(parent, ent);
565 	}
566 	return ent;
567 }
568 EXPORT_SYMBOL(proc_create_mount_point);
569 
570 struct proc_dir_entry *proc_create_reg(const char *name, umode_t mode,
571 		struct proc_dir_entry **parent, void *data)
572 {
573 	struct proc_dir_entry *p;
574 
575 	if ((mode & S_IFMT) == 0)
576 		mode |= S_IFREG;
577 	if ((mode & S_IALLUGO) == 0)
578 		mode |= S_IRUGO;
579 	if (WARN_ON_ONCE(!S_ISREG(mode)))
580 		return NULL;
581 
582 	p = __proc_create(parent, name, mode, 1);
583 	if (p) {
584 		p->proc_iops = &proc_file_inode_operations;
585 		p->data = data;
586 	}
587 	return p;
588 }
589 
590 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
591 		struct proc_dir_entry *parent,
592 		const struct proc_ops *proc_ops, void *data)
593 {
594 	struct proc_dir_entry *p;
595 
596 	p = proc_create_reg(name, mode, &parent, data);
597 	if (!p)
598 		return NULL;
599 	p->proc_ops = proc_ops;
600 	return proc_register(parent, p);
601 }
602 EXPORT_SYMBOL(proc_create_data);
603 
604 struct proc_dir_entry *proc_create(const char *name, umode_t mode,
605 				   struct proc_dir_entry *parent,
606 				   const struct proc_ops *proc_ops)
607 {
608 	return proc_create_data(name, mode, parent, proc_ops, NULL);
609 }
610 EXPORT_SYMBOL(proc_create);
611 
612 static int proc_seq_open(struct inode *inode, struct file *file)
613 {
614 	struct proc_dir_entry *de = PDE(inode);
615 
616 	if (de->state_size)
617 		return seq_open_private(file, de->seq_ops, de->state_size);
618 	return seq_open(file, de->seq_ops);
619 }
620 
621 static int proc_seq_release(struct inode *inode, struct file *file)
622 {
623 	struct proc_dir_entry *de = PDE(inode);
624 
625 	if (de->state_size)
626 		return seq_release_private(inode, file);
627 	return seq_release(inode, file);
628 }
629 
630 static const struct proc_ops proc_seq_ops = {
631 	/* not permanent -- can call into arbitrary seq_operations */
632 	.proc_open	= proc_seq_open,
633 	.proc_read_iter	= seq_read_iter,
634 	.proc_lseek	= seq_lseek,
635 	.proc_release	= proc_seq_release,
636 };
637 
638 struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
639 		struct proc_dir_entry *parent, const struct seq_operations *ops,
640 		unsigned int state_size, void *data)
641 {
642 	struct proc_dir_entry *p;
643 
644 	p = proc_create_reg(name, mode, &parent, data);
645 	if (!p)
646 		return NULL;
647 	p->proc_ops = &proc_seq_ops;
648 	p->seq_ops = ops;
649 	p->state_size = state_size;
650 	return proc_register(parent, p);
651 }
652 EXPORT_SYMBOL(proc_create_seq_private);
653 
654 static int proc_single_open(struct inode *inode, struct file *file)
655 {
656 	struct proc_dir_entry *de = PDE(inode);
657 
658 	return single_open(file, de->single_show, de->data);
659 }
660 
661 static const struct proc_ops proc_single_ops = {
662 	/* not permanent -- can call into arbitrary ->single_show */
663 	.proc_open	= proc_single_open,
664 	.proc_read_iter = seq_read_iter,
665 	.proc_lseek	= seq_lseek,
666 	.proc_release	= single_release,
667 };
668 
669 struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode,
670 		struct proc_dir_entry *parent,
671 		int (*show)(struct seq_file *, void *), void *data)
672 {
673 	struct proc_dir_entry *p;
674 
675 	p = proc_create_reg(name, mode, &parent, data);
676 	if (!p)
677 		return NULL;
678 	p->proc_ops = &proc_single_ops;
679 	p->single_show = show;
680 	return proc_register(parent, p);
681 }
682 EXPORT_SYMBOL(proc_create_single_data);
683 
684 void proc_set_size(struct proc_dir_entry *de, loff_t size)
685 {
686 	de->size = size;
687 }
688 EXPORT_SYMBOL(proc_set_size);
689 
690 void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid)
691 {
692 	de->uid = uid;
693 	de->gid = gid;
694 }
695 EXPORT_SYMBOL(proc_set_user);
696 
697 void pde_put(struct proc_dir_entry *pde)
698 {
699 	if (refcount_dec_and_test(&pde->refcnt)) {
700 		proc_free_inum(pde->low_ino);
701 		pde_free(pde);
702 	}
703 }
704 
705 static void pde_erase(struct proc_dir_entry *pde, struct proc_dir_entry *parent)
706 {
707 	rb_erase(&pde->subdir_node, &parent->subdir);
708 	RB_CLEAR_NODE(&pde->subdir_node);
709 }
710 
711 /*
712  * Remove a /proc entry and free it if it's not currently in use.
713  */
714 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
715 {
716 	struct proc_dir_entry *de = NULL;
717 	const char *fn = name;
718 	unsigned int len;
719 
720 	write_lock(&proc_subdir_lock);
721 	if (__xlate_proc_name(name, &parent, &fn) != 0) {
722 		write_unlock(&proc_subdir_lock);
723 		return;
724 	}
725 	len = strlen(fn);
726 
727 	de = pde_subdir_find(parent, fn, len);
728 	if (de) {
729 		if (unlikely(pde_is_permanent(de))) {
730 			WARN(1, "removing permanent /proc entry '%s'", de->name);
731 			de = NULL;
732 		} else {
733 			pde_erase(de, parent);
734 			if (S_ISDIR(de->mode))
735 				parent->nlink--;
736 		}
737 	}
738 	write_unlock(&proc_subdir_lock);
739 	if (!de) {
740 		WARN(1, "name '%s'\n", name);
741 		return;
742 	}
743 
744 	proc_entry_rundown(de);
745 
746 	WARN(pde_subdir_first(de),
747 	     "%s: removing non-empty directory '%s/%s', leaking at least '%s'\n",
748 	     __func__, de->parent->name, de->name, pde_subdir_first(de)->name);
749 	pde_put(de);
750 }
751 EXPORT_SYMBOL(remove_proc_entry);
752 
753 int remove_proc_subtree(const char *name, struct proc_dir_entry *parent)
754 {
755 	struct proc_dir_entry *root = NULL, *de, *next;
756 	const char *fn = name;
757 	unsigned int len;
758 
759 	write_lock(&proc_subdir_lock);
760 	if (__xlate_proc_name(name, &parent, &fn) != 0) {
761 		write_unlock(&proc_subdir_lock);
762 		return -ENOENT;
763 	}
764 	len = strlen(fn);
765 
766 	root = pde_subdir_find(parent, fn, len);
767 	if (!root) {
768 		write_unlock(&proc_subdir_lock);
769 		return -ENOENT;
770 	}
771 	if (unlikely(pde_is_permanent(root))) {
772 		write_unlock(&proc_subdir_lock);
773 		WARN(1, "removing permanent /proc entry '%s/%s'",
774 			root->parent->name, root->name);
775 		return -EINVAL;
776 	}
777 	pde_erase(root, parent);
778 
779 	de = root;
780 	while (1) {
781 		next = pde_subdir_first(de);
782 		if (next) {
783 			if (unlikely(pde_is_permanent(next))) {
784 				write_unlock(&proc_subdir_lock);
785 				WARN(1, "removing permanent /proc entry '%s/%s'",
786 					next->parent->name, next->name);
787 				return -EINVAL;
788 			}
789 			pde_erase(next, de);
790 			de = next;
791 			continue;
792 		}
793 		next = de->parent;
794 		if (S_ISDIR(de->mode))
795 			next->nlink--;
796 		write_unlock(&proc_subdir_lock);
797 
798 		proc_entry_rundown(de);
799 		if (de == root)
800 			break;
801 		pde_put(de);
802 
803 		write_lock(&proc_subdir_lock);
804 		de = next;
805 	}
806 	pde_put(root);
807 	return 0;
808 }
809 EXPORT_SYMBOL(remove_proc_subtree);
810 
811 void *proc_get_parent_data(const struct inode *inode)
812 {
813 	struct proc_dir_entry *de = PDE(inode);
814 	return de->parent->data;
815 }
816 EXPORT_SYMBOL_GPL(proc_get_parent_data);
817 
818 void proc_remove(struct proc_dir_entry *de)
819 {
820 	if (de)
821 		remove_proc_subtree(de->name, de->parent);
822 }
823 EXPORT_SYMBOL(proc_remove);
824 
825 /*
826  * Pull a user buffer into memory and pass it to the file's write handler if
827  * one is supplied.  The ->write() method is permitted to modify the
828  * kernel-side buffer.
829  */
830 ssize_t proc_simple_write(struct file *f, const char __user *ubuf, size_t size,
831 			  loff_t *_pos)
832 {
833 	struct proc_dir_entry *pde = PDE(file_inode(f));
834 	char *buf;
835 	int ret;
836 
837 	if (!pde->write)
838 		return -EACCES;
839 	if (size == 0 || size > PAGE_SIZE - 1)
840 		return -EINVAL;
841 	buf = memdup_user_nul(ubuf, size);
842 	if (IS_ERR(buf))
843 		return PTR_ERR(buf);
844 	ret = pde->write(f, buf, size);
845 	kfree(buf);
846 	return ret == 0 ? size : ret;
847 }
848 
849 /*
850  * Not exported to modules:
851  * modules' /proc files aren't permanent because modules aren't permanent.
852  */
853 void impl_proc_make_permanent(struct proc_dir_entry *pde)
854 {
855 	if (pde)
856 		pde_make_permanent(pde);
857 }
858