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