xref: /openbmc/linux/fs/proc/proc_sysctl.c (revision 2fa5ebe3)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * /proc/sys support
4  */
5 #include <linux/init.h>
6 #include <linux/sysctl.h>
7 #include <linux/poll.h>
8 #include <linux/proc_fs.h>
9 #include <linux/printk.h>
10 #include <linux/security.h>
11 #include <linux/sched.h>
12 #include <linux/cred.h>
13 #include <linux/namei.h>
14 #include <linux/mm.h>
15 #include <linux/uio.h>
16 #include <linux/module.h>
17 #include <linux/bpf-cgroup.h>
18 #include <linux/mount.h>
19 #include <linux/kmemleak.h>
20 #include "internal.h"
21 
22 #define list_for_each_table_entry(entry, table) \
23 	for ((entry) = (table); (entry)->procname; (entry)++)
24 
25 static const struct dentry_operations proc_sys_dentry_operations;
26 static const struct file_operations proc_sys_file_operations;
27 static const struct inode_operations proc_sys_inode_operations;
28 static const struct file_operations proc_sys_dir_file_operations;
29 static const struct inode_operations proc_sys_dir_operations;
30 
31 /* Support for permanently empty directories */
32 
33 struct ctl_table sysctl_mount_point[] = {
34 	{ }
35 };
36 
37 /**
38  * register_sysctl_mount_point() - registers a sysctl mount point
39  * @path: path for the mount point
40  *
41  * Used to create a permanently empty directory to serve as mount point.
42  * There are some subtle but important permission checks this allows in the
43  * case of unprivileged mounts.
44  */
45 struct ctl_table_header *register_sysctl_mount_point(const char *path)
46 {
47 	return register_sysctl(path, sysctl_mount_point);
48 }
49 EXPORT_SYMBOL(register_sysctl_mount_point);
50 
51 static bool is_empty_dir(struct ctl_table_header *head)
52 {
53 	return head->ctl_table[0].child == sysctl_mount_point;
54 }
55 
56 static void set_empty_dir(struct ctl_dir *dir)
57 {
58 	dir->header.ctl_table[0].child = sysctl_mount_point;
59 }
60 
61 static void clear_empty_dir(struct ctl_dir *dir)
62 
63 {
64 	dir->header.ctl_table[0].child = NULL;
65 }
66 
67 void proc_sys_poll_notify(struct ctl_table_poll *poll)
68 {
69 	if (!poll)
70 		return;
71 
72 	atomic_inc(&poll->event);
73 	wake_up_interruptible(&poll->wait);
74 }
75 
76 static struct ctl_table root_table[] = {
77 	{
78 		.procname = "",
79 		.mode = S_IFDIR|S_IRUGO|S_IXUGO,
80 	},
81 	{ }
82 };
83 static struct ctl_table_root sysctl_table_root = {
84 	.default_set.dir.header = {
85 		{{.count = 1,
86 		  .nreg = 1,
87 		  .ctl_table = root_table }},
88 		.ctl_table_arg = root_table,
89 		.root = &sysctl_table_root,
90 		.set = &sysctl_table_root.default_set,
91 	},
92 };
93 
94 static DEFINE_SPINLOCK(sysctl_lock);
95 
96 static void drop_sysctl_table(struct ctl_table_header *header);
97 static int sysctl_follow_link(struct ctl_table_header **phead,
98 	struct ctl_table **pentry);
99 static int insert_links(struct ctl_table_header *head);
100 static void put_links(struct ctl_table_header *header);
101 
102 static void sysctl_print_dir(struct ctl_dir *dir)
103 {
104 	if (dir->header.parent)
105 		sysctl_print_dir(dir->header.parent);
106 	pr_cont("%s/", dir->header.ctl_table[0].procname);
107 }
108 
109 static int namecmp(const char *name1, int len1, const char *name2, int len2)
110 {
111 	int cmp;
112 
113 	cmp = memcmp(name1, name2, min(len1, len2));
114 	if (cmp == 0)
115 		cmp = len1 - len2;
116 	return cmp;
117 }
118 
119 /* Called under sysctl_lock */
120 static struct ctl_table *find_entry(struct ctl_table_header **phead,
121 	struct ctl_dir *dir, const char *name, int namelen)
122 {
123 	struct ctl_table_header *head;
124 	struct ctl_table *entry;
125 	struct rb_node *node = dir->root.rb_node;
126 
127 	while (node)
128 	{
129 		struct ctl_node *ctl_node;
130 		const char *procname;
131 		int cmp;
132 
133 		ctl_node = rb_entry(node, struct ctl_node, node);
134 		head = ctl_node->header;
135 		entry = &head->ctl_table[ctl_node - head->node];
136 		procname = entry->procname;
137 
138 		cmp = namecmp(name, namelen, procname, strlen(procname));
139 		if (cmp < 0)
140 			node = node->rb_left;
141 		else if (cmp > 0)
142 			node = node->rb_right;
143 		else {
144 			*phead = head;
145 			return entry;
146 		}
147 	}
148 	return NULL;
149 }
150 
151 static int insert_entry(struct ctl_table_header *head, struct ctl_table *entry)
152 {
153 	struct rb_node *node = &head->node[entry - head->ctl_table].node;
154 	struct rb_node **p = &head->parent->root.rb_node;
155 	struct rb_node *parent = NULL;
156 	const char *name = entry->procname;
157 	int namelen = strlen(name);
158 
159 	while (*p) {
160 		struct ctl_table_header *parent_head;
161 		struct ctl_table *parent_entry;
162 		struct ctl_node *parent_node;
163 		const char *parent_name;
164 		int cmp;
165 
166 		parent = *p;
167 		parent_node = rb_entry(parent, struct ctl_node, node);
168 		parent_head = parent_node->header;
169 		parent_entry = &parent_head->ctl_table[parent_node - parent_head->node];
170 		parent_name = parent_entry->procname;
171 
172 		cmp = namecmp(name, namelen, parent_name, strlen(parent_name));
173 		if (cmp < 0)
174 			p = &(*p)->rb_left;
175 		else if (cmp > 0)
176 			p = &(*p)->rb_right;
177 		else {
178 			pr_err("sysctl duplicate entry: ");
179 			sysctl_print_dir(head->parent);
180 			pr_cont("%s\n", entry->procname);
181 			return -EEXIST;
182 		}
183 	}
184 
185 	rb_link_node(node, parent, p);
186 	rb_insert_color(node, &head->parent->root);
187 	return 0;
188 }
189 
190 static void erase_entry(struct ctl_table_header *head, struct ctl_table *entry)
191 {
192 	struct rb_node *node = &head->node[entry - head->ctl_table].node;
193 
194 	rb_erase(node, &head->parent->root);
195 }
196 
197 static void init_header(struct ctl_table_header *head,
198 	struct ctl_table_root *root, struct ctl_table_set *set,
199 	struct ctl_node *node, struct ctl_table *table)
200 {
201 	head->ctl_table = table;
202 	head->ctl_table_arg = table;
203 	head->used = 0;
204 	head->count = 1;
205 	head->nreg = 1;
206 	head->unregistering = NULL;
207 	head->root = root;
208 	head->set = set;
209 	head->parent = NULL;
210 	head->node = node;
211 	INIT_HLIST_HEAD(&head->inodes);
212 	if (node) {
213 		struct ctl_table *entry;
214 
215 		list_for_each_table_entry(entry, table) {
216 			node->header = head;
217 			node++;
218 		}
219 	}
220 }
221 
222 static void erase_header(struct ctl_table_header *head)
223 {
224 	struct ctl_table *entry;
225 
226 	list_for_each_table_entry(entry, head->ctl_table)
227 		erase_entry(head, entry);
228 }
229 
230 static int insert_header(struct ctl_dir *dir, struct ctl_table_header *header)
231 {
232 	struct ctl_table *entry;
233 	int err;
234 
235 	/* Is this a permanently empty directory? */
236 	if (is_empty_dir(&dir->header))
237 		return -EROFS;
238 
239 	/* Am I creating a permanently empty directory? */
240 	if (header->ctl_table == sysctl_mount_point) {
241 		if (!RB_EMPTY_ROOT(&dir->root))
242 			return -EINVAL;
243 		set_empty_dir(dir);
244 	}
245 
246 	dir->header.nreg++;
247 	header->parent = dir;
248 	err = insert_links(header);
249 	if (err)
250 		goto fail_links;
251 	list_for_each_table_entry(entry, header->ctl_table) {
252 		err = insert_entry(header, entry);
253 		if (err)
254 			goto fail;
255 	}
256 	return 0;
257 fail:
258 	erase_header(header);
259 	put_links(header);
260 fail_links:
261 	if (header->ctl_table == sysctl_mount_point)
262 		clear_empty_dir(dir);
263 	header->parent = NULL;
264 	drop_sysctl_table(&dir->header);
265 	return err;
266 }
267 
268 /* called under sysctl_lock */
269 static int use_table(struct ctl_table_header *p)
270 {
271 	if (unlikely(p->unregistering))
272 		return 0;
273 	p->used++;
274 	return 1;
275 }
276 
277 /* called under sysctl_lock */
278 static void unuse_table(struct ctl_table_header *p)
279 {
280 	if (!--p->used)
281 		if (unlikely(p->unregistering))
282 			complete(p->unregistering);
283 }
284 
285 static void proc_sys_invalidate_dcache(struct ctl_table_header *head)
286 {
287 	proc_invalidate_siblings_dcache(&head->inodes, &sysctl_lock);
288 }
289 
290 /* called under sysctl_lock, will reacquire if has to wait */
291 static void start_unregistering(struct ctl_table_header *p)
292 {
293 	/*
294 	 * if p->used is 0, nobody will ever touch that entry again;
295 	 * we'll eliminate all paths to it before dropping sysctl_lock
296 	 */
297 	if (unlikely(p->used)) {
298 		struct completion wait;
299 		init_completion(&wait);
300 		p->unregistering = &wait;
301 		spin_unlock(&sysctl_lock);
302 		wait_for_completion(&wait);
303 	} else {
304 		/* anything non-NULL; we'll never dereference it */
305 		p->unregistering = ERR_PTR(-EINVAL);
306 		spin_unlock(&sysctl_lock);
307 	}
308 	/*
309 	 * Invalidate dentries for unregistered sysctls: namespaced sysctls
310 	 * can have duplicate names and contaminate dcache very badly.
311 	 */
312 	proc_sys_invalidate_dcache(p);
313 	/*
314 	 * do not remove from the list until nobody holds it; walking the
315 	 * list in do_sysctl() relies on that.
316 	 */
317 	spin_lock(&sysctl_lock);
318 	erase_header(p);
319 }
320 
321 static struct ctl_table_header *sysctl_head_grab(struct ctl_table_header *head)
322 {
323 	BUG_ON(!head);
324 	spin_lock(&sysctl_lock);
325 	if (!use_table(head))
326 		head = ERR_PTR(-ENOENT);
327 	spin_unlock(&sysctl_lock);
328 	return head;
329 }
330 
331 static void sysctl_head_finish(struct ctl_table_header *head)
332 {
333 	if (!head)
334 		return;
335 	spin_lock(&sysctl_lock);
336 	unuse_table(head);
337 	spin_unlock(&sysctl_lock);
338 }
339 
340 static struct ctl_table_set *
341 lookup_header_set(struct ctl_table_root *root)
342 {
343 	struct ctl_table_set *set = &root->default_set;
344 	if (root->lookup)
345 		set = root->lookup(root);
346 	return set;
347 }
348 
349 static struct ctl_table *lookup_entry(struct ctl_table_header **phead,
350 				      struct ctl_dir *dir,
351 				      const char *name, int namelen)
352 {
353 	struct ctl_table_header *head;
354 	struct ctl_table *entry;
355 
356 	spin_lock(&sysctl_lock);
357 	entry = find_entry(&head, dir, name, namelen);
358 	if (entry && use_table(head))
359 		*phead = head;
360 	else
361 		entry = NULL;
362 	spin_unlock(&sysctl_lock);
363 	return entry;
364 }
365 
366 static struct ctl_node *first_usable_entry(struct rb_node *node)
367 {
368 	struct ctl_node *ctl_node;
369 
370 	for (;node; node = rb_next(node)) {
371 		ctl_node = rb_entry(node, struct ctl_node, node);
372 		if (use_table(ctl_node->header))
373 			return ctl_node;
374 	}
375 	return NULL;
376 }
377 
378 static void first_entry(struct ctl_dir *dir,
379 	struct ctl_table_header **phead, struct ctl_table **pentry)
380 {
381 	struct ctl_table_header *head = NULL;
382 	struct ctl_table *entry = NULL;
383 	struct ctl_node *ctl_node;
384 
385 	spin_lock(&sysctl_lock);
386 	ctl_node = first_usable_entry(rb_first(&dir->root));
387 	spin_unlock(&sysctl_lock);
388 	if (ctl_node) {
389 		head = ctl_node->header;
390 		entry = &head->ctl_table[ctl_node - head->node];
391 	}
392 	*phead = head;
393 	*pentry = entry;
394 }
395 
396 static void next_entry(struct ctl_table_header **phead, struct ctl_table **pentry)
397 {
398 	struct ctl_table_header *head = *phead;
399 	struct ctl_table *entry = *pentry;
400 	struct ctl_node *ctl_node = &head->node[entry - head->ctl_table];
401 
402 	spin_lock(&sysctl_lock);
403 	unuse_table(head);
404 
405 	ctl_node = first_usable_entry(rb_next(&ctl_node->node));
406 	spin_unlock(&sysctl_lock);
407 	head = NULL;
408 	if (ctl_node) {
409 		head = ctl_node->header;
410 		entry = &head->ctl_table[ctl_node - head->node];
411 	}
412 	*phead = head;
413 	*pentry = entry;
414 }
415 
416 /*
417  * sysctl_perm does NOT grant the superuser all rights automatically, because
418  * some sysctl variables are readonly even to root.
419  */
420 
421 static int test_perm(int mode, int op)
422 {
423 	if (uid_eq(current_euid(), GLOBAL_ROOT_UID))
424 		mode >>= 6;
425 	else if (in_egroup_p(GLOBAL_ROOT_GID))
426 		mode >>= 3;
427 	if ((op & ~mode & (MAY_READ|MAY_WRITE|MAY_EXEC)) == 0)
428 		return 0;
429 	return -EACCES;
430 }
431 
432 static int sysctl_perm(struct ctl_table_header *head, struct ctl_table *table, int op)
433 {
434 	struct ctl_table_root *root = head->root;
435 	int mode;
436 
437 	if (root->permissions)
438 		mode = root->permissions(head, table);
439 	else
440 		mode = table->mode;
441 
442 	return test_perm(mode, op);
443 }
444 
445 static struct inode *proc_sys_make_inode(struct super_block *sb,
446 		struct ctl_table_header *head, struct ctl_table *table)
447 {
448 	struct ctl_table_root *root = head->root;
449 	struct inode *inode;
450 	struct proc_inode *ei;
451 
452 	inode = new_inode(sb);
453 	if (!inode)
454 		return ERR_PTR(-ENOMEM);
455 
456 	inode->i_ino = get_next_ino();
457 
458 	ei = PROC_I(inode);
459 
460 	spin_lock(&sysctl_lock);
461 	if (unlikely(head->unregistering)) {
462 		spin_unlock(&sysctl_lock);
463 		iput(inode);
464 		return ERR_PTR(-ENOENT);
465 	}
466 	ei->sysctl = head;
467 	ei->sysctl_entry = table;
468 	hlist_add_head_rcu(&ei->sibling_inodes, &head->inodes);
469 	head->count++;
470 	spin_unlock(&sysctl_lock);
471 
472 	inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
473 	inode->i_mode = table->mode;
474 	if (!S_ISDIR(table->mode)) {
475 		inode->i_mode |= S_IFREG;
476 		inode->i_op = &proc_sys_inode_operations;
477 		inode->i_fop = &proc_sys_file_operations;
478 	} else {
479 		inode->i_mode |= S_IFDIR;
480 		inode->i_op = &proc_sys_dir_operations;
481 		inode->i_fop = &proc_sys_dir_file_operations;
482 		if (is_empty_dir(head))
483 			make_empty_dir_inode(inode);
484 	}
485 
486 	if (root->set_ownership)
487 		root->set_ownership(head, table, &inode->i_uid, &inode->i_gid);
488 	else {
489 		inode->i_uid = GLOBAL_ROOT_UID;
490 		inode->i_gid = GLOBAL_ROOT_GID;
491 	}
492 
493 	return inode;
494 }
495 
496 void proc_sys_evict_inode(struct inode *inode, struct ctl_table_header *head)
497 {
498 	spin_lock(&sysctl_lock);
499 	hlist_del_init_rcu(&PROC_I(inode)->sibling_inodes);
500 	if (!--head->count)
501 		kfree_rcu(head, rcu);
502 	spin_unlock(&sysctl_lock);
503 }
504 
505 static struct ctl_table_header *grab_header(struct inode *inode)
506 {
507 	struct ctl_table_header *head = PROC_I(inode)->sysctl;
508 	if (!head)
509 		head = &sysctl_table_root.default_set.dir.header;
510 	return sysctl_head_grab(head);
511 }
512 
513 static struct dentry *proc_sys_lookup(struct inode *dir, struct dentry *dentry,
514 					unsigned int flags)
515 {
516 	struct ctl_table_header *head = grab_header(dir);
517 	struct ctl_table_header *h = NULL;
518 	const struct qstr *name = &dentry->d_name;
519 	struct ctl_table *p;
520 	struct inode *inode;
521 	struct dentry *err = ERR_PTR(-ENOENT);
522 	struct ctl_dir *ctl_dir;
523 	int ret;
524 
525 	if (IS_ERR(head))
526 		return ERR_CAST(head);
527 
528 	ctl_dir = container_of(head, struct ctl_dir, header);
529 
530 	p = lookup_entry(&h, ctl_dir, name->name, name->len);
531 	if (!p)
532 		goto out;
533 
534 	if (S_ISLNK(p->mode)) {
535 		ret = sysctl_follow_link(&h, &p);
536 		err = ERR_PTR(ret);
537 		if (ret)
538 			goto out;
539 	}
540 
541 	inode = proc_sys_make_inode(dir->i_sb, h ? h : head, p);
542 	if (IS_ERR(inode)) {
543 		err = ERR_CAST(inode);
544 		goto out;
545 	}
546 
547 	d_set_d_op(dentry, &proc_sys_dentry_operations);
548 	err = d_splice_alias(inode, dentry);
549 
550 out:
551 	if (h)
552 		sysctl_head_finish(h);
553 	sysctl_head_finish(head);
554 	return err;
555 }
556 
557 static ssize_t proc_sys_call_handler(struct kiocb *iocb, struct iov_iter *iter,
558 		int write)
559 {
560 	struct inode *inode = file_inode(iocb->ki_filp);
561 	struct ctl_table_header *head = grab_header(inode);
562 	struct ctl_table *table = PROC_I(inode)->sysctl_entry;
563 	size_t count = iov_iter_count(iter);
564 	char *kbuf;
565 	ssize_t error;
566 
567 	if (IS_ERR(head))
568 		return PTR_ERR(head);
569 
570 	/*
571 	 * At this point we know that the sysctl was not unregistered
572 	 * and won't be until we finish.
573 	 */
574 	error = -EPERM;
575 	if (sysctl_perm(head, table, write ? MAY_WRITE : MAY_READ))
576 		goto out;
577 
578 	/* if that can happen at all, it should be -EINVAL, not -EISDIR */
579 	error = -EINVAL;
580 	if (!table->proc_handler)
581 		goto out;
582 
583 	/* don't even try if the size is too large */
584 	error = -ENOMEM;
585 	if (count >= KMALLOC_MAX_SIZE)
586 		goto out;
587 	kbuf = kvzalloc(count + 1, GFP_KERNEL);
588 	if (!kbuf)
589 		goto out;
590 
591 	if (write) {
592 		error = -EFAULT;
593 		if (!copy_from_iter_full(kbuf, count, iter))
594 			goto out_free_buf;
595 		kbuf[count] = '\0';
596 	}
597 
598 	error = BPF_CGROUP_RUN_PROG_SYSCTL(head, table, write, &kbuf, &count,
599 					   &iocb->ki_pos);
600 	if (error)
601 		goto out_free_buf;
602 
603 	/* careful: calling conventions are nasty here */
604 	error = table->proc_handler(table, write, kbuf, &count, &iocb->ki_pos);
605 	if (error)
606 		goto out_free_buf;
607 
608 	if (!write) {
609 		error = -EFAULT;
610 		if (copy_to_iter(kbuf, count, iter) < count)
611 			goto out_free_buf;
612 	}
613 
614 	error = count;
615 out_free_buf:
616 	kvfree(kbuf);
617 out:
618 	sysctl_head_finish(head);
619 
620 	return error;
621 }
622 
623 static ssize_t proc_sys_read(struct kiocb *iocb, struct iov_iter *iter)
624 {
625 	return proc_sys_call_handler(iocb, iter, 0);
626 }
627 
628 static ssize_t proc_sys_write(struct kiocb *iocb, struct iov_iter *iter)
629 {
630 	return proc_sys_call_handler(iocb, iter, 1);
631 }
632 
633 static int proc_sys_open(struct inode *inode, struct file *filp)
634 {
635 	struct ctl_table_header *head = grab_header(inode);
636 	struct ctl_table *table = PROC_I(inode)->sysctl_entry;
637 
638 	/* sysctl was unregistered */
639 	if (IS_ERR(head))
640 		return PTR_ERR(head);
641 
642 	if (table->poll)
643 		filp->private_data = proc_sys_poll_event(table->poll);
644 
645 	sysctl_head_finish(head);
646 
647 	return 0;
648 }
649 
650 static __poll_t proc_sys_poll(struct file *filp, poll_table *wait)
651 {
652 	struct inode *inode = file_inode(filp);
653 	struct ctl_table_header *head = grab_header(inode);
654 	struct ctl_table *table = PROC_I(inode)->sysctl_entry;
655 	__poll_t ret = DEFAULT_POLLMASK;
656 	unsigned long event;
657 
658 	/* sysctl was unregistered */
659 	if (IS_ERR(head))
660 		return EPOLLERR | EPOLLHUP;
661 
662 	if (!table->proc_handler)
663 		goto out;
664 
665 	if (!table->poll)
666 		goto out;
667 
668 	event = (unsigned long)filp->private_data;
669 	poll_wait(filp, &table->poll->wait, wait);
670 
671 	if (event != atomic_read(&table->poll->event)) {
672 		filp->private_data = proc_sys_poll_event(table->poll);
673 		ret = EPOLLIN | EPOLLRDNORM | EPOLLERR | EPOLLPRI;
674 	}
675 
676 out:
677 	sysctl_head_finish(head);
678 
679 	return ret;
680 }
681 
682 static bool proc_sys_fill_cache(struct file *file,
683 				struct dir_context *ctx,
684 				struct ctl_table_header *head,
685 				struct ctl_table *table)
686 {
687 	struct dentry *child, *dir = file->f_path.dentry;
688 	struct inode *inode;
689 	struct qstr qname;
690 	ino_t ino = 0;
691 	unsigned type = DT_UNKNOWN;
692 
693 	qname.name = table->procname;
694 	qname.len  = strlen(table->procname);
695 	qname.hash = full_name_hash(dir, qname.name, qname.len);
696 
697 	child = d_lookup(dir, &qname);
698 	if (!child) {
699 		DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
700 		child = d_alloc_parallel(dir, &qname, &wq);
701 		if (IS_ERR(child))
702 			return false;
703 		if (d_in_lookup(child)) {
704 			struct dentry *res;
705 			inode = proc_sys_make_inode(dir->d_sb, head, table);
706 			if (IS_ERR(inode)) {
707 				d_lookup_done(child);
708 				dput(child);
709 				return false;
710 			}
711 			d_set_d_op(child, &proc_sys_dentry_operations);
712 			res = d_splice_alias(inode, child);
713 			d_lookup_done(child);
714 			if (unlikely(res)) {
715 				if (IS_ERR(res)) {
716 					dput(child);
717 					return false;
718 				}
719 				dput(child);
720 				child = res;
721 			}
722 		}
723 	}
724 	inode = d_inode(child);
725 	ino  = inode->i_ino;
726 	type = inode->i_mode >> 12;
727 	dput(child);
728 	return dir_emit(ctx, qname.name, qname.len, ino, type);
729 }
730 
731 static bool proc_sys_link_fill_cache(struct file *file,
732 				    struct dir_context *ctx,
733 				    struct ctl_table_header *head,
734 				    struct ctl_table *table)
735 {
736 	bool ret = true;
737 
738 	head = sysctl_head_grab(head);
739 	if (IS_ERR(head))
740 		return false;
741 
742 	/* It is not an error if we can not follow the link ignore it */
743 	if (sysctl_follow_link(&head, &table))
744 		goto out;
745 
746 	ret = proc_sys_fill_cache(file, ctx, head, table);
747 out:
748 	sysctl_head_finish(head);
749 	return ret;
750 }
751 
752 static int scan(struct ctl_table_header *head, struct ctl_table *table,
753 		unsigned long *pos, struct file *file,
754 		struct dir_context *ctx)
755 {
756 	bool res;
757 
758 	if ((*pos)++ < ctx->pos)
759 		return true;
760 
761 	if (unlikely(S_ISLNK(table->mode)))
762 		res = proc_sys_link_fill_cache(file, ctx, head, table);
763 	else
764 		res = proc_sys_fill_cache(file, ctx, head, table);
765 
766 	if (res)
767 		ctx->pos = *pos;
768 
769 	return res;
770 }
771 
772 static int proc_sys_readdir(struct file *file, struct dir_context *ctx)
773 {
774 	struct ctl_table_header *head = grab_header(file_inode(file));
775 	struct ctl_table_header *h = NULL;
776 	struct ctl_table *entry;
777 	struct ctl_dir *ctl_dir;
778 	unsigned long pos;
779 
780 	if (IS_ERR(head))
781 		return PTR_ERR(head);
782 
783 	ctl_dir = container_of(head, struct ctl_dir, header);
784 
785 	if (!dir_emit_dots(file, ctx))
786 		goto out;
787 
788 	pos = 2;
789 
790 	for (first_entry(ctl_dir, &h, &entry); h; next_entry(&h, &entry)) {
791 		if (!scan(h, entry, &pos, file, ctx)) {
792 			sysctl_head_finish(h);
793 			break;
794 		}
795 	}
796 out:
797 	sysctl_head_finish(head);
798 	return 0;
799 }
800 
801 static int proc_sys_permission(struct mnt_idmap *idmap,
802 			       struct inode *inode, int mask)
803 {
804 	/*
805 	 * sysctl entries that are not writeable,
806 	 * are _NOT_ writeable, capabilities or not.
807 	 */
808 	struct ctl_table_header *head;
809 	struct ctl_table *table;
810 	int error;
811 
812 	/* Executable files are not allowed under /proc/sys/ */
813 	if ((mask & MAY_EXEC) && S_ISREG(inode->i_mode))
814 		return -EACCES;
815 
816 	head = grab_header(inode);
817 	if (IS_ERR(head))
818 		return PTR_ERR(head);
819 
820 	table = PROC_I(inode)->sysctl_entry;
821 	if (!table) /* global root - r-xr-xr-x */
822 		error = mask & MAY_WRITE ? -EACCES : 0;
823 	else /* Use the permissions on the sysctl table entry */
824 		error = sysctl_perm(head, table, mask & ~MAY_NOT_BLOCK);
825 
826 	sysctl_head_finish(head);
827 	return error;
828 }
829 
830 static int proc_sys_setattr(struct mnt_idmap *idmap,
831 			    struct dentry *dentry, struct iattr *attr)
832 {
833 	struct inode *inode = d_inode(dentry);
834 	int error;
835 
836 	if (attr->ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID))
837 		return -EPERM;
838 
839 	error = setattr_prepare(&nop_mnt_idmap, dentry, attr);
840 	if (error)
841 		return error;
842 
843 	setattr_copy(&nop_mnt_idmap, inode, attr);
844 	mark_inode_dirty(inode);
845 	return 0;
846 }
847 
848 static int proc_sys_getattr(struct mnt_idmap *idmap,
849 			    const struct path *path, struct kstat *stat,
850 			    u32 request_mask, unsigned int query_flags)
851 {
852 	struct inode *inode = d_inode(path->dentry);
853 	struct ctl_table_header *head = grab_header(inode);
854 	struct ctl_table *table = PROC_I(inode)->sysctl_entry;
855 
856 	if (IS_ERR(head))
857 		return PTR_ERR(head);
858 
859 	generic_fillattr(&nop_mnt_idmap, inode, stat);
860 	if (table)
861 		stat->mode = (stat->mode & S_IFMT) | table->mode;
862 
863 	sysctl_head_finish(head);
864 	return 0;
865 }
866 
867 static const struct file_operations proc_sys_file_operations = {
868 	.open		= proc_sys_open,
869 	.poll		= proc_sys_poll,
870 	.read_iter	= proc_sys_read,
871 	.write_iter	= proc_sys_write,
872 	.splice_read	= generic_file_splice_read,
873 	.splice_write	= iter_file_splice_write,
874 	.llseek		= default_llseek,
875 };
876 
877 static const struct file_operations proc_sys_dir_file_operations = {
878 	.read		= generic_read_dir,
879 	.iterate_shared	= proc_sys_readdir,
880 	.llseek		= generic_file_llseek,
881 };
882 
883 static const struct inode_operations proc_sys_inode_operations = {
884 	.permission	= proc_sys_permission,
885 	.setattr	= proc_sys_setattr,
886 	.getattr	= proc_sys_getattr,
887 };
888 
889 static const struct inode_operations proc_sys_dir_operations = {
890 	.lookup		= proc_sys_lookup,
891 	.permission	= proc_sys_permission,
892 	.setattr	= proc_sys_setattr,
893 	.getattr	= proc_sys_getattr,
894 };
895 
896 static int proc_sys_revalidate(struct dentry *dentry, unsigned int flags)
897 {
898 	if (flags & LOOKUP_RCU)
899 		return -ECHILD;
900 	return !PROC_I(d_inode(dentry))->sysctl->unregistering;
901 }
902 
903 static int proc_sys_delete(const struct dentry *dentry)
904 {
905 	return !!PROC_I(d_inode(dentry))->sysctl->unregistering;
906 }
907 
908 static int sysctl_is_seen(struct ctl_table_header *p)
909 {
910 	struct ctl_table_set *set = p->set;
911 	int res;
912 	spin_lock(&sysctl_lock);
913 	if (p->unregistering)
914 		res = 0;
915 	else if (!set->is_seen)
916 		res = 1;
917 	else
918 		res = set->is_seen(set);
919 	spin_unlock(&sysctl_lock);
920 	return res;
921 }
922 
923 static int proc_sys_compare(const struct dentry *dentry,
924 		unsigned int len, const char *str, const struct qstr *name)
925 {
926 	struct ctl_table_header *head;
927 	struct inode *inode;
928 
929 	/* Although proc doesn't have negative dentries, rcu-walk means
930 	 * that inode here can be NULL */
931 	/* AV: can it, indeed? */
932 	inode = d_inode_rcu(dentry);
933 	if (!inode)
934 		return 1;
935 	if (name->len != len)
936 		return 1;
937 	if (memcmp(name->name, str, len))
938 		return 1;
939 	head = rcu_dereference(PROC_I(inode)->sysctl);
940 	return !head || !sysctl_is_seen(head);
941 }
942 
943 static const struct dentry_operations proc_sys_dentry_operations = {
944 	.d_revalidate	= proc_sys_revalidate,
945 	.d_delete	= proc_sys_delete,
946 	.d_compare	= proc_sys_compare,
947 };
948 
949 static struct ctl_dir *find_subdir(struct ctl_dir *dir,
950 				   const char *name, int namelen)
951 {
952 	struct ctl_table_header *head;
953 	struct ctl_table *entry;
954 
955 	entry = find_entry(&head, dir, name, namelen);
956 	if (!entry)
957 		return ERR_PTR(-ENOENT);
958 	if (!S_ISDIR(entry->mode))
959 		return ERR_PTR(-ENOTDIR);
960 	return container_of(head, struct ctl_dir, header);
961 }
962 
963 static struct ctl_dir *new_dir(struct ctl_table_set *set,
964 			       const char *name, int namelen)
965 {
966 	struct ctl_table *table;
967 	struct ctl_dir *new;
968 	struct ctl_node *node;
969 	char *new_name;
970 
971 	new = kzalloc(sizeof(*new) + sizeof(struct ctl_node) +
972 		      sizeof(struct ctl_table)*2 +  namelen + 1,
973 		      GFP_KERNEL);
974 	if (!new)
975 		return NULL;
976 
977 	node = (struct ctl_node *)(new + 1);
978 	table = (struct ctl_table *)(node + 1);
979 	new_name = (char *)(table + 2);
980 	memcpy(new_name, name, namelen);
981 	table[0].procname = new_name;
982 	table[0].mode = S_IFDIR|S_IRUGO|S_IXUGO;
983 	init_header(&new->header, set->dir.header.root, set, node, table);
984 
985 	return new;
986 }
987 
988 /**
989  * get_subdir - find or create a subdir with the specified name.
990  * @dir:  Directory to create the subdirectory in
991  * @name: The name of the subdirectory to find or create
992  * @namelen: The length of name
993  *
994  * Takes a directory with an elevated reference count so we know that
995  * if we drop the lock the directory will not go away.  Upon success
996  * the reference is moved from @dir to the returned subdirectory.
997  * Upon error an error code is returned and the reference on @dir is
998  * simply dropped.
999  */
1000 static struct ctl_dir *get_subdir(struct ctl_dir *dir,
1001 				  const char *name, int namelen)
1002 {
1003 	struct ctl_table_set *set = dir->header.set;
1004 	struct ctl_dir *subdir, *new = NULL;
1005 	int err;
1006 
1007 	spin_lock(&sysctl_lock);
1008 	subdir = find_subdir(dir, name, namelen);
1009 	if (!IS_ERR(subdir))
1010 		goto found;
1011 	if (PTR_ERR(subdir) != -ENOENT)
1012 		goto failed;
1013 
1014 	spin_unlock(&sysctl_lock);
1015 	new = new_dir(set, name, namelen);
1016 	spin_lock(&sysctl_lock);
1017 	subdir = ERR_PTR(-ENOMEM);
1018 	if (!new)
1019 		goto failed;
1020 
1021 	/* Was the subdir added while we dropped the lock? */
1022 	subdir = find_subdir(dir, name, namelen);
1023 	if (!IS_ERR(subdir))
1024 		goto found;
1025 	if (PTR_ERR(subdir) != -ENOENT)
1026 		goto failed;
1027 
1028 	/* Nope.  Use the our freshly made directory entry. */
1029 	err = insert_header(dir, &new->header);
1030 	subdir = ERR_PTR(err);
1031 	if (err)
1032 		goto failed;
1033 	subdir = new;
1034 found:
1035 	subdir->header.nreg++;
1036 failed:
1037 	if (IS_ERR(subdir)) {
1038 		pr_err("sysctl could not get directory: ");
1039 		sysctl_print_dir(dir);
1040 		pr_cont("%*.*s %ld\n", namelen, namelen, name,
1041 			PTR_ERR(subdir));
1042 	}
1043 	drop_sysctl_table(&dir->header);
1044 	if (new)
1045 		drop_sysctl_table(&new->header);
1046 	spin_unlock(&sysctl_lock);
1047 	return subdir;
1048 }
1049 
1050 static struct ctl_dir *xlate_dir(struct ctl_table_set *set, struct ctl_dir *dir)
1051 {
1052 	struct ctl_dir *parent;
1053 	const char *procname;
1054 	if (!dir->header.parent)
1055 		return &set->dir;
1056 	parent = xlate_dir(set, dir->header.parent);
1057 	if (IS_ERR(parent))
1058 		return parent;
1059 	procname = dir->header.ctl_table[0].procname;
1060 	return find_subdir(parent, procname, strlen(procname));
1061 }
1062 
1063 static int sysctl_follow_link(struct ctl_table_header **phead,
1064 	struct ctl_table **pentry)
1065 {
1066 	struct ctl_table_header *head;
1067 	struct ctl_table_root *root;
1068 	struct ctl_table_set *set;
1069 	struct ctl_table *entry;
1070 	struct ctl_dir *dir;
1071 	int ret;
1072 
1073 	spin_lock(&sysctl_lock);
1074 	root = (*pentry)->data;
1075 	set = lookup_header_set(root);
1076 	dir = xlate_dir(set, (*phead)->parent);
1077 	if (IS_ERR(dir))
1078 		ret = PTR_ERR(dir);
1079 	else {
1080 		const char *procname = (*pentry)->procname;
1081 		head = NULL;
1082 		entry = find_entry(&head, dir, procname, strlen(procname));
1083 		ret = -ENOENT;
1084 		if (entry && use_table(head)) {
1085 			unuse_table(*phead);
1086 			*phead = head;
1087 			*pentry = entry;
1088 			ret = 0;
1089 		}
1090 	}
1091 
1092 	spin_unlock(&sysctl_lock);
1093 	return ret;
1094 }
1095 
1096 static int sysctl_err(const char *path, struct ctl_table *table, char *fmt, ...)
1097 {
1098 	struct va_format vaf;
1099 	va_list args;
1100 
1101 	va_start(args, fmt);
1102 	vaf.fmt = fmt;
1103 	vaf.va = &args;
1104 
1105 	pr_err("sysctl table check failed: %s/%s %pV\n",
1106 	       path, table->procname, &vaf);
1107 
1108 	va_end(args);
1109 	return -EINVAL;
1110 }
1111 
1112 static int sysctl_check_table_array(const char *path, struct ctl_table *table)
1113 {
1114 	int err = 0;
1115 
1116 	if ((table->proc_handler == proc_douintvec) ||
1117 	    (table->proc_handler == proc_douintvec_minmax)) {
1118 		if (table->maxlen != sizeof(unsigned int))
1119 			err |= sysctl_err(path, table, "array not allowed");
1120 	}
1121 
1122 	if (table->proc_handler == proc_dou8vec_minmax) {
1123 		if (table->maxlen != sizeof(u8))
1124 			err |= sysctl_err(path, table, "array not allowed");
1125 	}
1126 
1127 	if (table->proc_handler == proc_dobool) {
1128 		if (table->maxlen != sizeof(bool))
1129 			err |= sysctl_err(path, table, "array not allowed");
1130 	}
1131 
1132 	return err;
1133 }
1134 
1135 static int sysctl_check_table(const char *path, struct ctl_table *table)
1136 {
1137 	struct ctl_table *entry;
1138 	int err = 0;
1139 	list_for_each_table_entry(entry, table) {
1140 		if (entry->child)
1141 			err |= sysctl_err(path, entry, "Not a file");
1142 
1143 		if ((entry->proc_handler == proc_dostring) ||
1144 		    (entry->proc_handler == proc_dobool) ||
1145 		    (entry->proc_handler == proc_dointvec) ||
1146 		    (entry->proc_handler == proc_douintvec) ||
1147 		    (entry->proc_handler == proc_douintvec_minmax) ||
1148 		    (entry->proc_handler == proc_dointvec_minmax) ||
1149 		    (entry->proc_handler == proc_dou8vec_minmax) ||
1150 		    (entry->proc_handler == proc_dointvec_jiffies) ||
1151 		    (entry->proc_handler == proc_dointvec_userhz_jiffies) ||
1152 		    (entry->proc_handler == proc_dointvec_ms_jiffies) ||
1153 		    (entry->proc_handler == proc_doulongvec_minmax) ||
1154 		    (entry->proc_handler == proc_doulongvec_ms_jiffies_minmax)) {
1155 			if (!entry->data)
1156 				err |= sysctl_err(path, entry, "No data");
1157 			if (!entry->maxlen)
1158 				err |= sysctl_err(path, entry, "No maxlen");
1159 			else
1160 				err |= sysctl_check_table_array(path, entry);
1161 		}
1162 		if (!entry->proc_handler)
1163 			err |= sysctl_err(path, entry, "No proc_handler");
1164 
1165 		if ((entry->mode & (S_IRUGO|S_IWUGO)) != entry->mode)
1166 			err |= sysctl_err(path, entry, "bogus .mode 0%o",
1167 				entry->mode);
1168 	}
1169 	return err;
1170 }
1171 
1172 static struct ctl_table_header *new_links(struct ctl_dir *dir, struct ctl_table *table,
1173 	struct ctl_table_root *link_root)
1174 {
1175 	struct ctl_table *link_table, *entry, *link;
1176 	struct ctl_table_header *links;
1177 	struct ctl_node *node;
1178 	char *link_name;
1179 	int nr_entries, name_bytes;
1180 
1181 	name_bytes = 0;
1182 	nr_entries = 0;
1183 	list_for_each_table_entry(entry, table) {
1184 		nr_entries++;
1185 		name_bytes += strlen(entry->procname) + 1;
1186 	}
1187 
1188 	links = kzalloc(sizeof(struct ctl_table_header) +
1189 			sizeof(struct ctl_node)*nr_entries +
1190 			sizeof(struct ctl_table)*(nr_entries + 1) +
1191 			name_bytes,
1192 			GFP_KERNEL);
1193 
1194 	if (!links)
1195 		return NULL;
1196 
1197 	node = (struct ctl_node *)(links + 1);
1198 	link_table = (struct ctl_table *)(node + nr_entries);
1199 	link_name = (char *)&link_table[nr_entries + 1];
1200 	link = link_table;
1201 
1202 	list_for_each_table_entry(entry, table) {
1203 		int len = strlen(entry->procname) + 1;
1204 		memcpy(link_name, entry->procname, len);
1205 		link->procname = link_name;
1206 		link->mode = S_IFLNK|S_IRWXUGO;
1207 		link->data = link_root;
1208 		link_name += len;
1209 		link++;
1210 	}
1211 	init_header(links, dir->header.root, dir->header.set, node, link_table);
1212 	links->nreg = nr_entries;
1213 
1214 	return links;
1215 }
1216 
1217 static bool get_links(struct ctl_dir *dir,
1218 	struct ctl_table *table, struct ctl_table_root *link_root)
1219 {
1220 	struct ctl_table_header *head;
1221 	struct ctl_table *entry, *link;
1222 
1223 	/* Are there links available for every entry in table? */
1224 	list_for_each_table_entry(entry, table) {
1225 		const char *procname = entry->procname;
1226 		link = find_entry(&head, dir, procname, strlen(procname));
1227 		if (!link)
1228 			return false;
1229 		if (S_ISDIR(link->mode) && S_ISDIR(entry->mode))
1230 			continue;
1231 		if (S_ISLNK(link->mode) && (link->data == link_root))
1232 			continue;
1233 		return false;
1234 	}
1235 
1236 	/* The checks passed.  Increase the registration count on the links */
1237 	list_for_each_table_entry(entry, table) {
1238 		const char *procname = entry->procname;
1239 		link = find_entry(&head, dir, procname, strlen(procname));
1240 		head->nreg++;
1241 	}
1242 	return true;
1243 }
1244 
1245 static int insert_links(struct ctl_table_header *head)
1246 {
1247 	struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1248 	struct ctl_dir *core_parent;
1249 	struct ctl_table_header *links;
1250 	int err;
1251 
1252 	if (head->set == root_set)
1253 		return 0;
1254 
1255 	core_parent = xlate_dir(root_set, head->parent);
1256 	if (IS_ERR(core_parent))
1257 		return 0;
1258 
1259 	if (get_links(core_parent, head->ctl_table, head->root))
1260 		return 0;
1261 
1262 	core_parent->header.nreg++;
1263 	spin_unlock(&sysctl_lock);
1264 
1265 	links = new_links(core_parent, head->ctl_table, head->root);
1266 
1267 	spin_lock(&sysctl_lock);
1268 	err = -ENOMEM;
1269 	if (!links)
1270 		goto out;
1271 
1272 	err = 0;
1273 	if (get_links(core_parent, head->ctl_table, head->root)) {
1274 		kfree(links);
1275 		goto out;
1276 	}
1277 
1278 	err = insert_header(core_parent, links);
1279 	if (err)
1280 		kfree(links);
1281 out:
1282 	drop_sysctl_table(&core_parent->header);
1283 	return err;
1284 }
1285 
1286 /**
1287  * __register_sysctl_table - register a leaf sysctl table
1288  * @set: Sysctl tree to register on
1289  * @path: The path to the directory the sysctl table is in.
1290  * @table: the top-level table structure
1291  *
1292  * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1293  * array. A completely 0 filled entry terminates the table.
1294  *
1295  * The members of the &struct ctl_table structure are used as follows:
1296  *
1297  * procname - the name of the sysctl file under /proc/sys. Set to %NULL to not
1298  *            enter a sysctl file
1299  *
1300  * data - a pointer to data for use by proc_handler
1301  *
1302  * maxlen - the maximum size in bytes of the data
1303  *
1304  * mode - the file permissions for the /proc/sys file
1305  *
1306  * child - must be %NULL.
1307  *
1308  * proc_handler - the text handler routine (described below)
1309  *
1310  * extra1, extra2 - extra pointers usable by the proc handler routines
1311  *
1312  * Leaf nodes in the sysctl tree will be represented by a single file
1313  * under /proc; non-leaf nodes will be represented by directories.
1314  *
1315  * There must be a proc_handler routine for any terminal nodes.
1316  * Several default handlers are available to cover common cases -
1317  *
1318  * proc_dostring(), proc_dointvec(), proc_dointvec_jiffies(),
1319  * proc_dointvec_userhz_jiffies(), proc_dointvec_minmax(),
1320  * proc_doulongvec_ms_jiffies_minmax(), proc_doulongvec_minmax()
1321  *
1322  * It is the handler's job to read the input buffer from user memory
1323  * and process it. The handler should return 0 on success.
1324  *
1325  * This routine returns %NULL on a failure to register, and a pointer
1326  * to the table header on success.
1327  */
1328 struct ctl_table_header *__register_sysctl_table(
1329 	struct ctl_table_set *set,
1330 	const char *path, struct ctl_table *table)
1331 {
1332 	struct ctl_table_root *root = set->dir.header.root;
1333 	struct ctl_table_header *header;
1334 	const char *name, *nextname;
1335 	struct ctl_dir *dir;
1336 	struct ctl_table *entry;
1337 	struct ctl_node *node;
1338 	int nr_entries = 0;
1339 
1340 	list_for_each_table_entry(entry, table)
1341 		nr_entries++;
1342 
1343 	header = kzalloc(sizeof(struct ctl_table_header) +
1344 			 sizeof(struct ctl_node)*nr_entries, GFP_KERNEL_ACCOUNT);
1345 	if (!header)
1346 		return NULL;
1347 
1348 	node = (struct ctl_node *)(header + 1);
1349 	init_header(header, root, set, node, table);
1350 	if (sysctl_check_table(path, table))
1351 		goto fail;
1352 
1353 	spin_lock(&sysctl_lock);
1354 	dir = &set->dir;
1355 	/* Reference moved down the diretory tree get_subdir */
1356 	dir->header.nreg++;
1357 	spin_unlock(&sysctl_lock);
1358 
1359 	/* Find the directory for the ctl_table */
1360 	for (name = path; name; name = nextname) {
1361 		int namelen;
1362 		nextname = strchr(name, '/');
1363 		if (nextname) {
1364 			namelen = nextname - name;
1365 			nextname++;
1366 		} else {
1367 			namelen = strlen(name);
1368 		}
1369 		if (namelen == 0)
1370 			continue;
1371 
1372 		dir = get_subdir(dir, name, namelen);
1373 		if (IS_ERR(dir))
1374 			goto fail;
1375 	}
1376 
1377 	spin_lock(&sysctl_lock);
1378 	if (insert_header(dir, header))
1379 		goto fail_put_dir_locked;
1380 
1381 	drop_sysctl_table(&dir->header);
1382 	spin_unlock(&sysctl_lock);
1383 
1384 	return header;
1385 
1386 fail_put_dir_locked:
1387 	drop_sysctl_table(&dir->header);
1388 	spin_unlock(&sysctl_lock);
1389 fail:
1390 	kfree(header);
1391 	dump_stack();
1392 	return NULL;
1393 }
1394 
1395 /**
1396  * register_sysctl - register a sysctl table
1397  * @path: The path to the directory the sysctl table is in.
1398  * @table: the table structure
1399  *
1400  * Register a sysctl table. @table should be a filled in ctl_table
1401  * array. A completely 0 filled entry terminates the table.
1402  *
1403  * See __register_sysctl_table for more details.
1404  */
1405 struct ctl_table_header *register_sysctl(const char *path, struct ctl_table *table)
1406 {
1407 	return __register_sysctl_table(&sysctl_table_root.default_set,
1408 					path, table);
1409 }
1410 EXPORT_SYMBOL(register_sysctl);
1411 
1412 /**
1413  * __register_sysctl_init() - register sysctl table to path
1414  * @path: path name for sysctl base
1415  * @table: This is the sysctl table that needs to be registered to the path
1416  * @table_name: The name of sysctl table, only used for log printing when
1417  *              registration fails
1418  *
1419  * The sysctl interface is used by userspace to query or modify at runtime
1420  * a predefined value set on a variable. These variables however have default
1421  * values pre-set. Code which depends on these variables will always work even
1422  * if register_sysctl() fails. If register_sysctl() fails you'd just loose the
1423  * ability to query or modify the sysctls dynamically at run time. Chances of
1424  * register_sysctl() failing on init are extremely low, and so for both reasons
1425  * this function does not return any error as it is used by initialization code.
1426  *
1427  * Context: Can only be called after your respective sysctl base path has been
1428  * registered. So for instance, most base directories are registered early on
1429  * init before init levels are processed through proc_sys_init() and
1430  * sysctl_init_bases().
1431  */
1432 void __init __register_sysctl_init(const char *path, struct ctl_table *table,
1433 				 const char *table_name)
1434 {
1435 	struct ctl_table_header *hdr = register_sysctl(path, table);
1436 
1437 	if (unlikely(!hdr)) {
1438 		pr_err("failed when register_sysctl %s to %s\n", table_name, path);
1439 		return;
1440 	}
1441 	kmemleak_not_leak(hdr);
1442 }
1443 
1444 static char *append_path(const char *path, char *pos, const char *name)
1445 {
1446 	int namelen;
1447 	namelen = strlen(name);
1448 	if (((pos - path) + namelen + 2) >= PATH_MAX)
1449 		return NULL;
1450 	memcpy(pos, name, namelen);
1451 	pos[namelen] = '/';
1452 	pos[namelen + 1] = '\0';
1453 	pos += namelen + 1;
1454 	return pos;
1455 }
1456 
1457 static int count_subheaders(struct ctl_table *table)
1458 {
1459 	int has_files = 0;
1460 	int nr_subheaders = 0;
1461 	struct ctl_table *entry;
1462 
1463 	/* special case: no directory and empty directory */
1464 	if (!table || !table->procname)
1465 		return 1;
1466 
1467 	list_for_each_table_entry(entry, table) {
1468 		if (entry->child)
1469 			nr_subheaders += count_subheaders(entry->child);
1470 		else
1471 			has_files = 1;
1472 	}
1473 	return nr_subheaders + has_files;
1474 }
1475 
1476 static int register_leaf_sysctl_tables(const char *path, char *pos,
1477 	struct ctl_table_header ***subheader, struct ctl_table_set *set,
1478 	struct ctl_table *table)
1479 {
1480 	struct ctl_table *ctl_table_arg = NULL;
1481 	struct ctl_table *entry, *files;
1482 	int nr_files = 0;
1483 	int nr_dirs = 0;
1484 	int err = -ENOMEM;
1485 
1486 	list_for_each_table_entry(entry, table) {
1487 		if (entry->child)
1488 			nr_dirs++;
1489 		else
1490 			nr_files++;
1491 	}
1492 
1493 	files = table;
1494 	/* If there are mixed files and directories we need a new table */
1495 	if (nr_dirs && nr_files) {
1496 		struct ctl_table *new;
1497 		files = kcalloc(nr_files + 1, sizeof(struct ctl_table),
1498 				GFP_KERNEL);
1499 		if (!files)
1500 			goto out;
1501 
1502 		ctl_table_arg = files;
1503 		new = files;
1504 
1505 		list_for_each_table_entry(entry, table) {
1506 			if (entry->child)
1507 				continue;
1508 			*new = *entry;
1509 			new++;
1510 		}
1511 	}
1512 
1513 	/* Register everything except a directory full of subdirectories */
1514 	if (nr_files || !nr_dirs) {
1515 		struct ctl_table_header *header;
1516 		header = __register_sysctl_table(set, path, files);
1517 		if (!header) {
1518 			kfree(ctl_table_arg);
1519 			goto out;
1520 		}
1521 
1522 		/* Remember if we need to free the file table */
1523 		header->ctl_table_arg = ctl_table_arg;
1524 		**subheader = header;
1525 		(*subheader)++;
1526 	}
1527 
1528 	/* Recurse into the subdirectories. */
1529 	list_for_each_table_entry(entry, table) {
1530 		char *child_pos;
1531 
1532 		if (!entry->child)
1533 			continue;
1534 
1535 		err = -ENAMETOOLONG;
1536 		child_pos = append_path(path, pos, entry->procname);
1537 		if (!child_pos)
1538 			goto out;
1539 
1540 		err = register_leaf_sysctl_tables(path, child_pos, subheader,
1541 						  set, entry->child);
1542 		pos[0] = '\0';
1543 		if (err)
1544 			goto out;
1545 	}
1546 	err = 0;
1547 out:
1548 	/* On failure our caller will unregister all registered subheaders */
1549 	return err;
1550 }
1551 
1552 /**
1553  * __register_sysctl_paths - register a sysctl table hierarchy
1554  * @set: Sysctl tree to register on
1555  * @path: The path to the directory the sysctl table is in.
1556  * @table: the top-level table structure
1557  *
1558  * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1559  * array. A completely 0 filled entry terminates the table.
1560  *
1561  * See __register_sysctl_table for more details.
1562  */
1563 struct ctl_table_header *__register_sysctl_paths(
1564 	struct ctl_table_set *set,
1565 	const struct ctl_path *path, struct ctl_table *table)
1566 {
1567 	struct ctl_table *ctl_table_arg = table;
1568 	int nr_subheaders = count_subheaders(table);
1569 	struct ctl_table_header *header = NULL, **subheaders, **subheader;
1570 	const struct ctl_path *component;
1571 	char *new_path, *pos;
1572 
1573 	pos = new_path = kmalloc(PATH_MAX, GFP_KERNEL);
1574 	if (!new_path)
1575 		return NULL;
1576 
1577 	pos[0] = '\0';
1578 	for (component = path; component->procname; component++) {
1579 		pos = append_path(new_path, pos, component->procname);
1580 		if (!pos)
1581 			goto out;
1582 	}
1583 	while (table->procname && table->child && !table[1].procname) {
1584 		pos = append_path(new_path, pos, table->procname);
1585 		if (!pos)
1586 			goto out;
1587 		table = table->child;
1588 	}
1589 	if (nr_subheaders == 1) {
1590 		header = __register_sysctl_table(set, new_path, table);
1591 		if (header)
1592 			header->ctl_table_arg = ctl_table_arg;
1593 	} else {
1594 		header = kzalloc(sizeof(*header) +
1595 				 sizeof(*subheaders)*nr_subheaders, GFP_KERNEL);
1596 		if (!header)
1597 			goto out;
1598 
1599 		subheaders = (struct ctl_table_header **) (header + 1);
1600 		subheader = subheaders;
1601 		header->ctl_table_arg = ctl_table_arg;
1602 
1603 		if (register_leaf_sysctl_tables(new_path, pos, &subheader,
1604 						set, table))
1605 			goto err_register_leaves;
1606 	}
1607 
1608 out:
1609 	kfree(new_path);
1610 	return header;
1611 
1612 err_register_leaves:
1613 	while (subheader > subheaders) {
1614 		struct ctl_table_header *subh = *(--subheader);
1615 		struct ctl_table *table = subh->ctl_table_arg;
1616 		unregister_sysctl_table(subh);
1617 		kfree(table);
1618 	}
1619 	kfree(header);
1620 	header = NULL;
1621 	goto out;
1622 }
1623 
1624 /**
1625  * register_sysctl_paths - register a sysctl table hierarchy
1626  * @path: The path to the directory the sysctl table is in.
1627  * @table: the top-level table structure
1628  *
1629  * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1630  * array. A completely 0 filled entry terminates the table.
1631  *
1632  * See __register_sysctl_paths for more details.
1633  */
1634 struct ctl_table_header *register_sysctl_paths(const struct ctl_path *path,
1635 						struct ctl_table *table)
1636 {
1637 	return __register_sysctl_paths(&sysctl_table_root.default_set,
1638 					path, table);
1639 }
1640 EXPORT_SYMBOL(register_sysctl_paths);
1641 
1642 /**
1643  * register_sysctl_table - register a sysctl table hierarchy
1644  * @table: the top-level table structure
1645  *
1646  * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1647  * array. A completely 0 filled entry terminates the table.
1648  *
1649  * See register_sysctl_paths for more details.
1650  */
1651 struct ctl_table_header *register_sysctl_table(struct ctl_table *table)
1652 {
1653 	static const struct ctl_path null_path[] = { {} };
1654 
1655 	return register_sysctl_paths(null_path, table);
1656 }
1657 EXPORT_SYMBOL(register_sysctl_table);
1658 
1659 int __register_sysctl_base(struct ctl_table *base_table)
1660 {
1661 	struct ctl_table_header *hdr;
1662 
1663 	hdr = register_sysctl_table(base_table);
1664 	kmemleak_not_leak(hdr);
1665 	return 0;
1666 }
1667 
1668 static void put_links(struct ctl_table_header *header)
1669 {
1670 	struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1671 	struct ctl_table_root *root = header->root;
1672 	struct ctl_dir *parent = header->parent;
1673 	struct ctl_dir *core_parent;
1674 	struct ctl_table *entry;
1675 
1676 	if (header->set == root_set)
1677 		return;
1678 
1679 	core_parent = xlate_dir(root_set, parent);
1680 	if (IS_ERR(core_parent))
1681 		return;
1682 
1683 	list_for_each_table_entry(entry, header->ctl_table) {
1684 		struct ctl_table_header *link_head;
1685 		struct ctl_table *link;
1686 		const char *name = entry->procname;
1687 
1688 		link = find_entry(&link_head, core_parent, name, strlen(name));
1689 		if (link &&
1690 		    ((S_ISDIR(link->mode) && S_ISDIR(entry->mode)) ||
1691 		     (S_ISLNK(link->mode) && (link->data == root)))) {
1692 			drop_sysctl_table(link_head);
1693 		}
1694 		else {
1695 			pr_err("sysctl link missing during unregister: ");
1696 			sysctl_print_dir(parent);
1697 			pr_cont("%s\n", name);
1698 		}
1699 	}
1700 }
1701 
1702 static void drop_sysctl_table(struct ctl_table_header *header)
1703 {
1704 	struct ctl_dir *parent = header->parent;
1705 
1706 	if (--header->nreg)
1707 		return;
1708 
1709 	if (parent) {
1710 		put_links(header);
1711 		start_unregistering(header);
1712 	}
1713 
1714 	if (!--header->count)
1715 		kfree_rcu(header, rcu);
1716 
1717 	if (parent)
1718 		drop_sysctl_table(&parent->header);
1719 }
1720 
1721 /**
1722  * unregister_sysctl_table - unregister a sysctl table hierarchy
1723  * @header: the header returned from register_sysctl_table
1724  *
1725  * Unregisters the sysctl table and all children. proc entries may not
1726  * actually be removed until they are no longer used by anyone.
1727  */
1728 void unregister_sysctl_table(struct ctl_table_header * header)
1729 {
1730 	int nr_subheaders;
1731 	might_sleep();
1732 
1733 	if (header == NULL)
1734 		return;
1735 
1736 	nr_subheaders = count_subheaders(header->ctl_table_arg);
1737 	if (unlikely(nr_subheaders > 1)) {
1738 		struct ctl_table_header **subheaders;
1739 		int i;
1740 
1741 		subheaders = (struct ctl_table_header **)(header + 1);
1742 		for (i = nr_subheaders -1; i >= 0; i--) {
1743 			struct ctl_table_header *subh = subheaders[i];
1744 			struct ctl_table *table = subh->ctl_table_arg;
1745 			unregister_sysctl_table(subh);
1746 			kfree(table);
1747 		}
1748 		kfree(header);
1749 		return;
1750 	}
1751 
1752 	spin_lock(&sysctl_lock);
1753 	drop_sysctl_table(header);
1754 	spin_unlock(&sysctl_lock);
1755 }
1756 EXPORT_SYMBOL(unregister_sysctl_table);
1757 
1758 void setup_sysctl_set(struct ctl_table_set *set,
1759 	struct ctl_table_root *root,
1760 	int (*is_seen)(struct ctl_table_set *))
1761 {
1762 	memset(set, 0, sizeof(*set));
1763 	set->is_seen = is_seen;
1764 	init_header(&set->dir.header, root, set, NULL, root_table);
1765 }
1766 
1767 void retire_sysctl_set(struct ctl_table_set *set)
1768 {
1769 	WARN_ON(!RB_EMPTY_ROOT(&set->dir.root));
1770 }
1771 
1772 int __init proc_sys_init(void)
1773 {
1774 	struct proc_dir_entry *proc_sys_root;
1775 
1776 	proc_sys_root = proc_mkdir("sys", NULL);
1777 	proc_sys_root->proc_iops = &proc_sys_dir_operations;
1778 	proc_sys_root->proc_dir_ops = &proc_sys_dir_file_operations;
1779 	proc_sys_root->nlink = 0;
1780 
1781 	return sysctl_init_bases();
1782 }
1783 
1784 struct sysctl_alias {
1785 	const char *kernel_param;
1786 	const char *sysctl_param;
1787 };
1788 
1789 /*
1790  * Historically some settings had both sysctl and a command line parameter.
1791  * With the generic sysctl. parameter support, we can handle them at a single
1792  * place and only keep the historical name for compatibility. This is not meant
1793  * to add brand new aliases. When adding existing aliases, consider whether
1794  * the possibly different moment of changing the value (e.g. from early_param
1795  * to the moment do_sysctl_args() is called) is an issue for the specific
1796  * parameter.
1797  */
1798 static const struct sysctl_alias sysctl_aliases[] = {
1799 	{"hardlockup_all_cpu_backtrace",	"kernel.hardlockup_all_cpu_backtrace" },
1800 	{"hung_task_panic",			"kernel.hung_task_panic" },
1801 	{"numa_zonelist_order",			"vm.numa_zonelist_order" },
1802 	{"softlockup_all_cpu_backtrace",	"kernel.softlockup_all_cpu_backtrace" },
1803 	{"softlockup_panic",			"kernel.softlockup_panic" },
1804 	{ }
1805 };
1806 
1807 static const char *sysctl_find_alias(char *param)
1808 {
1809 	const struct sysctl_alias *alias;
1810 
1811 	for (alias = &sysctl_aliases[0]; alias->kernel_param != NULL; alias++) {
1812 		if (strcmp(alias->kernel_param, param) == 0)
1813 			return alias->sysctl_param;
1814 	}
1815 
1816 	return NULL;
1817 }
1818 
1819 /* Set sysctl value passed on kernel command line. */
1820 static int process_sysctl_arg(char *param, char *val,
1821 			       const char *unused, void *arg)
1822 {
1823 	char *path;
1824 	struct vfsmount **proc_mnt = arg;
1825 	struct file_system_type *proc_fs_type;
1826 	struct file *file;
1827 	int len;
1828 	int err;
1829 	loff_t pos = 0;
1830 	ssize_t wret;
1831 
1832 	if (strncmp(param, "sysctl", sizeof("sysctl") - 1) == 0) {
1833 		param += sizeof("sysctl") - 1;
1834 
1835 		if (param[0] != '/' && param[0] != '.')
1836 			return 0;
1837 
1838 		param++;
1839 	} else {
1840 		param = (char *) sysctl_find_alias(param);
1841 		if (!param)
1842 			return 0;
1843 	}
1844 
1845 	if (!val)
1846 		return -EINVAL;
1847 	len = strlen(val);
1848 	if (len == 0)
1849 		return -EINVAL;
1850 
1851 	/*
1852 	 * To set sysctl options, we use a temporary mount of proc, look up the
1853 	 * respective sys/ file and write to it. To avoid mounting it when no
1854 	 * options were given, we mount it only when the first sysctl option is
1855 	 * found. Why not a persistent mount? There are problems with a
1856 	 * persistent mount of proc in that it forces userspace not to use any
1857 	 * proc mount options.
1858 	 */
1859 	if (!*proc_mnt) {
1860 		proc_fs_type = get_fs_type("proc");
1861 		if (!proc_fs_type) {
1862 			pr_err("Failed to find procfs to set sysctl from command line\n");
1863 			return 0;
1864 		}
1865 		*proc_mnt = kern_mount(proc_fs_type);
1866 		put_filesystem(proc_fs_type);
1867 		if (IS_ERR(*proc_mnt)) {
1868 			pr_err("Failed to mount procfs to set sysctl from command line\n");
1869 			return 0;
1870 		}
1871 	}
1872 
1873 	path = kasprintf(GFP_KERNEL, "sys/%s", param);
1874 	if (!path)
1875 		panic("%s: Failed to allocate path for %s\n", __func__, param);
1876 	strreplace(path, '.', '/');
1877 
1878 	file = file_open_root_mnt(*proc_mnt, path, O_WRONLY, 0);
1879 	if (IS_ERR(file)) {
1880 		err = PTR_ERR(file);
1881 		if (err == -ENOENT)
1882 			pr_err("Failed to set sysctl parameter '%s=%s': parameter not found\n",
1883 				param, val);
1884 		else if (err == -EACCES)
1885 			pr_err("Failed to set sysctl parameter '%s=%s': permission denied (read-only?)\n",
1886 				param, val);
1887 		else
1888 			pr_err("Error %pe opening proc file to set sysctl parameter '%s=%s'\n",
1889 				file, param, val);
1890 		goto out;
1891 	}
1892 	wret = kernel_write(file, val, len, &pos);
1893 	if (wret < 0) {
1894 		err = wret;
1895 		if (err == -EINVAL)
1896 			pr_err("Failed to set sysctl parameter '%s=%s': invalid value\n",
1897 				param, val);
1898 		else
1899 			pr_err("Error %pe writing to proc file to set sysctl parameter '%s=%s'\n",
1900 				ERR_PTR(err), param, val);
1901 	} else if (wret != len) {
1902 		pr_err("Wrote only %zd bytes of %d writing to proc file %s to set sysctl parameter '%s=%s\n",
1903 			wret, len, path, param, val);
1904 	}
1905 
1906 	err = filp_close(file, NULL);
1907 	if (err)
1908 		pr_err("Error %pe closing proc file to set sysctl parameter '%s=%s\n",
1909 			ERR_PTR(err), param, val);
1910 out:
1911 	kfree(path);
1912 	return 0;
1913 }
1914 
1915 void do_sysctl_args(void)
1916 {
1917 	char *command_line;
1918 	struct vfsmount *proc_mnt = NULL;
1919 
1920 	command_line = kstrdup(saved_command_line, GFP_KERNEL);
1921 	if (!command_line)
1922 		panic("%s: Failed to allocate copy of command line\n", __func__);
1923 
1924 	parse_args("Setting sysctl args", command_line,
1925 		   NULL, 0, -1, -1, &proc_mnt, process_sysctl_arg);
1926 
1927 	if (proc_mnt)
1928 		kern_unmount(proc_mnt);
1929 
1930 	kfree(command_line);
1931 }
1932