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/module.h>
16 #include <linux/kmemleak.h>
17 #include "internal.h"
18
19 static const struct dentry_operations proc_sys_dentry_operations;
20 static const struct file_operations proc_sys_file_operations;
21 static const struct inode_operations proc_sys_inode_operations;
22 static const struct file_operations proc_sys_dir_file_operations;
23 static const struct inode_operations proc_sys_dir_operations;
24
25 /* Support for permanently empty directories */
26
27 struct ctl_table sysctl_mount_point[] = {
28 { }
29 };
30
is_empty_dir(struct ctl_table_header * head)31 static bool is_empty_dir(struct ctl_table_header *head)
32 {
33 return head->ctl_table[0].child == sysctl_mount_point;
34 }
35
set_empty_dir(struct ctl_dir * dir)36 static void set_empty_dir(struct ctl_dir *dir)
37 {
38 dir->header.ctl_table[0].child = sysctl_mount_point;
39 }
40
clear_empty_dir(struct ctl_dir * dir)41 static void clear_empty_dir(struct ctl_dir *dir)
42
43 {
44 dir->header.ctl_table[0].child = NULL;
45 }
46
proc_sys_poll_notify(struct ctl_table_poll * poll)47 void proc_sys_poll_notify(struct ctl_table_poll *poll)
48 {
49 if (!poll)
50 return;
51
52 atomic_inc(&poll->event);
53 wake_up_interruptible(&poll->wait);
54 }
55
56 static struct ctl_table root_table[] = {
57 {
58 .procname = "",
59 .mode = S_IFDIR|S_IRUGO|S_IXUGO,
60 },
61 { }
62 };
63 static struct ctl_table_root sysctl_table_root = {
64 .default_set.dir.header = {
65 {{.count = 1,
66 .nreg = 1,
67 .ctl_table = root_table }},
68 .ctl_table_arg = root_table,
69 .root = &sysctl_table_root,
70 .set = &sysctl_table_root.default_set,
71 },
72 };
73
74 static DEFINE_SPINLOCK(sysctl_lock);
75
76 static void drop_sysctl_table(struct ctl_table_header *header);
77 static int sysctl_follow_link(struct ctl_table_header **phead,
78 struct ctl_table **pentry);
79 static int insert_links(struct ctl_table_header *head);
80 static void put_links(struct ctl_table_header *header);
81
sysctl_print_dir(struct ctl_dir * dir)82 static void sysctl_print_dir(struct ctl_dir *dir)
83 {
84 if (dir->header.parent)
85 sysctl_print_dir(dir->header.parent);
86 pr_cont("%s/", dir->header.ctl_table[0].procname);
87 }
88
namecmp(const char * name1,int len1,const char * name2,int len2)89 static int namecmp(const char *name1, int len1, const char *name2, int len2)
90 {
91 int minlen;
92 int cmp;
93
94 minlen = len1;
95 if (minlen > len2)
96 minlen = len2;
97
98 cmp = memcmp(name1, name2, minlen);
99 if (cmp == 0)
100 cmp = len1 - len2;
101 return cmp;
102 }
103
104 /* Called under sysctl_lock */
find_entry(struct ctl_table_header ** phead,struct ctl_dir * dir,const char * name,int namelen)105 static struct ctl_table *find_entry(struct ctl_table_header **phead,
106 struct ctl_dir *dir, const char *name, int namelen)
107 {
108 struct ctl_table_header *head;
109 struct ctl_table *entry;
110 struct rb_node *node = dir->root.rb_node;
111
112 while (node)
113 {
114 struct ctl_node *ctl_node;
115 const char *procname;
116 int cmp;
117
118 ctl_node = rb_entry(node, struct ctl_node, node);
119 head = ctl_node->header;
120 entry = &head->ctl_table[ctl_node - head->node];
121 procname = entry->procname;
122
123 cmp = namecmp(name, namelen, procname, strlen(procname));
124 if (cmp < 0)
125 node = node->rb_left;
126 else if (cmp > 0)
127 node = node->rb_right;
128 else {
129 *phead = head;
130 return entry;
131 }
132 }
133 return NULL;
134 }
135
insert_entry(struct ctl_table_header * head,struct ctl_table * entry)136 static int insert_entry(struct ctl_table_header *head, struct ctl_table *entry)
137 {
138 struct rb_node *node = &head->node[entry - head->ctl_table].node;
139 struct rb_node **p = &head->parent->root.rb_node;
140 struct rb_node *parent = NULL;
141 const char *name = entry->procname;
142 int namelen = strlen(name);
143
144 while (*p) {
145 struct ctl_table_header *parent_head;
146 struct ctl_table *parent_entry;
147 struct ctl_node *parent_node;
148 const char *parent_name;
149 int cmp;
150
151 parent = *p;
152 parent_node = rb_entry(parent, struct ctl_node, node);
153 parent_head = parent_node->header;
154 parent_entry = &parent_head->ctl_table[parent_node - parent_head->node];
155 parent_name = parent_entry->procname;
156
157 cmp = namecmp(name, namelen, parent_name, strlen(parent_name));
158 if (cmp < 0)
159 p = &(*p)->rb_left;
160 else if (cmp > 0)
161 p = &(*p)->rb_right;
162 else {
163 pr_err("sysctl duplicate entry: ");
164 sysctl_print_dir(head->parent);
165 pr_cont("/%s\n", entry->procname);
166 return -EEXIST;
167 }
168 }
169
170 rb_link_node(node, parent, p);
171 rb_insert_color(node, &head->parent->root);
172 return 0;
173 }
174
erase_entry(struct ctl_table_header * head,struct ctl_table * entry)175 static void erase_entry(struct ctl_table_header *head, struct ctl_table *entry)
176 {
177 struct rb_node *node = &head->node[entry - head->ctl_table].node;
178
179 rb_erase(node, &head->parent->root);
180 }
181
init_header(struct ctl_table_header * head,struct ctl_table_root * root,struct ctl_table_set * set,struct ctl_node * node,struct ctl_table * table)182 static void init_header(struct ctl_table_header *head,
183 struct ctl_table_root *root, struct ctl_table_set *set,
184 struct ctl_node *node, struct ctl_table *table)
185 {
186 head->ctl_table = table;
187 head->ctl_table_arg = table;
188 head->used = 0;
189 head->count = 1;
190 head->nreg = 1;
191 head->unregistering = NULL;
192 head->root = root;
193 head->set = set;
194 head->parent = NULL;
195 head->node = node;
196 INIT_HLIST_HEAD(&head->inodes);
197 if (node) {
198 struct ctl_table *entry;
199 for (entry = table; entry->procname; entry++, node++)
200 node->header = head;
201 }
202 }
203
erase_header(struct ctl_table_header * head)204 static void erase_header(struct ctl_table_header *head)
205 {
206 struct ctl_table *entry;
207 for (entry = head->ctl_table; entry->procname; entry++)
208 erase_entry(head, entry);
209 }
210
insert_header(struct ctl_dir * dir,struct ctl_table_header * header)211 static int insert_header(struct ctl_dir *dir, struct ctl_table_header *header)
212 {
213 struct ctl_table *entry;
214 int err;
215
216 /* Is this a permanently empty directory? */
217 if (is_empty_dir(&dir->header))
218 return -EROFS;
219
220 /* Am I creating a permanently empty directory? */
221 if (header->ctl_table == sysctl_mount_point) {
222 if (!RB_EMPTY_ROOT(&dir->root))
223 return -EINVAL;
224 set_empty_dir(dir);
225 }
226
227 dir->header.nreg++;
228 header->parent = dir;
229 err = insert_links(header);
230 if (err)
231 goto fail_links;
232 for (entry = header->ctl_table; entry->procname; entry++) {
233 err = insert_entry(header, entry);
234 if (err)
235 goto fail;
236 }
237 return 0;
238 fail:
239 erase_header(header);
240 put_links(header);
241 fail_links:
242 if (header->ctl_table == sysctl_mount_point)
243 clear_empty_dir(dir);
244 header->parent = NULL;
245 drop_sysctl_table(&dir->header);
246 return err;
247 }
248
249 /* called under sysctl_lock */
use_table(struct ctl_table_header * p)250 static int use_table(struct ctl_table_header *p)
251 {
252 if (unlikely(p->unregistering))
253 return 0;
254 p->used++;
255 return 1;
256 }
257
258 /* called under sysctl_lock */
unuse_table(struct ctl_table_header * p)259 static void unuse_table(struct ctl_table_header *p)
260 {
261 if (!--p->used)
262 if (unlikely(p->unregistering))
263 complete(p->unregistering);
264 }
265
proc_sys_prune_dcache(struct ctl_table_header * head)266 static void proc_sys_prune_dcache(struct ctl_table_header *head)
267 {
268 struct inode *inode;
269 struct proc_inode *ei;
270 struct hlist_node *node;
271 struct super_block *sb;
272
273 rcu_read_lock();
274 for (;;) {
275 node = hlist_first_rcu(&head->inodes);
276 if (!node)
277 break;
278 ei = hlist_entry(node, struct proc_inode, sysctl_inodes);
279 spin_lock(&sysctl_lock);
280 hlist_del_init_rcu(&ei->sysctl_inodes);
281 spin_unlock(&sysctl_lock);
282
283 inode = &ei->vfs_inode;
284 sb = inode->i_sb;
285 if (!atomic_inc_not_zero(&sb->s_active))
286 continue;
287 inode = igrab(inode);
288 rcu_read_unlock();
289 if (unlikely(!inode)) {
290 deactivate_super(sb);
291 rcu_read_lock();
292 continue;
293 }
294
295 d_prune_aliases(inode);
296 iput(inode);
297 deactivate_super(sb);
298
299 rcu_read_lock();
300 }
301 rcu_read_unlock();
302 }
303
304 /* called under sysctl_lock, will reacquire if has to wait */
start_unregistering(struct ctl_table_header * p)305 static void start_unregistering(struct ctl_table_header *p)
306 {
307 /*
308 * if p->used is 0, nobody will ever touch that entry again;
309 * we'll eliminate all paths to it before dropping sysctl_lock
310 */
311 if (unlikely(p->used)) {
312 struct completion wait;
313 init_completion(&wait);
314 p->unregistering = &wait;
315 spin_unlock(&sysctl_lock);
316 wait_for_completion(&wait);
317 } else {
318 /* anything non-NULL; we'll never dereference it */
319 p->unregistering = ERR_PTR(-EINVAL);
320 spin_unlock(&sysctl_lock);
321 }
322 /*
323 * Prune dentries for unregistered sysctls: namespaced sysctls
324 * can have duplicate names and contaminate dcache very badly.
325 */
326 proc_sys_prune_dcache(p);
327 /*
328 * do not remove from the list until nobody holds it; walking the
329 * list in do_sysctl() relies on that.
330 */
331 spin_lock(&sysctl_lock);
332 erase_header(p);
333 }
334
sysctl_head_grab(struct ctl_table_header * head)335 static struct ctl_table_header *sysctl_head_grab(struct ctl_table_header *head)
336 {
337 BUG_ON(!head);
338 spin_lock(&sysctl_lock);
339 if (!use_table(head))
340 head = ERR_PTR(-ENOENT);
341 spin_unlock(&sysctl_lock);
342 return head;
343 }
344
sysctl_head_finish(struct ctl_table_header * head)345 static void sysctl_head_finish(struct ctl_table_header *head)
346 {
347 if (!head)
348 return;
349 spin_lock(&sysctl_lock);
350 unuse_table(head);
351 spin_unlock(&sysctl_lock);
352 }
353
354 static struct ctl_table_set *
lookup_header_set(struct ctl_table_root * root)355 lookup_header_set(struct ctl_table_root *root)
356 {
357 struct ctl_table_set *set = &root->default_set;
358 if (root->lookup)
359 set = root->lookup(root);
360 return set;
361 }
362
lookup_entry(struct ctl_table_header ** phead,struct ctl_dir * dir,const char * name,int namelen)363 static struct ctl_table *lookup_entry(struct ctl_table_header **phead,
364 struct ctl_dir *dir,
365 const char *name, int namelen)
366 {
367 struct ctl_table_header *head;
368 struct ctl_table *entry;
369
370 spin_lock(&sysctl_lock);
371 entry = find_entry(&head, dir, name, namelen);
372 if (entry && use_table(head))
373 *phead = head;
374 else
375 entry = NULL;
376 spin_unlock(&sysctl_lock);
377 return entry;
378 }
379
first_usable_entry(struct rb_node * node)380 static struct ctl_node *first_usable_entry(struct rb_node *node)
381 {
382 struct ctl_node *ctl_node;
383
384 for (;node; node = rb_next(node)) {
385 ctl_node = rb_entry(node, struct ctl_node, node);
386 if (use_table(ctl_node->header))
387 return ctl_node;
388 }
389 return NULL;
390 }
391
first_entry(struct ctl_dir * dir,struct ctl_table_header ** phead,struct ctl_table ** pentry)392 static void first_entry(struct ctl_dir *dir,
393 struct ctl_table_header **phead, struct ctl_table **pentry)
394 {
395 struct ctl_table_header *head = NULL;
396 struct ctl_table *entry = NULL;
397 struct ctl_node *ctl_node;
398
399 spin_lock(&sysctl_lock);
400 ctl_node = first_usable_entry(rb_first(&dir->root));
401 spin_unlock(&sysctl_lock);
402 if (ctl_node) {
403 head = ctl_node->header;
404 entry = &head->ctl_table[ctl_node - head->node];
405 }
406 *phead = head;
407 *pentry = entry;
408 }
409
next_entry(struct ctl_table_header ** phead,struct ctl_table ** pentry)410 static void next_entry(struct ctl_table_header **phead, struct ctl_table **pentry)
411 {
412 struct ctl_table_header *head = *phead;
413 struct ctl_table *entry = *pentry;
414 struct ctl_node *ctl_node = &head->node[entry - head->ctl_table];
415
416 spin_lock(&sysctl_lock);
417 unuse_table(head);
418
419 ctl_node = first_usable_entry(rb_next(&ctl_node->node));
420 spin_unlock(&sysctl_lock);
421 head = NULL;
422 if (ctl_node) {
423 head = ctl_node->header;
424 entry = &head->ctl_table[ctl_node - head->node];
425 }
426 *phead = head;
427 *pentry = entry;
428 }
429
430 /*
431 * sysctl_perm does NOT grant the superuser all rights automatically, because
432 * some sysctl variables are readonly even to root.
433 */
434
test_perm(int mode,int op)435 static int test_perm(int mode, int op)
436 {
437 if (uid_eq(current_euid(), GLOBAL_ROOT_UID))
438 mode >>= 6;
439 else if (in_egroup_p(GLOBAL_ROOT_GID))
440 mode >>= 3;
441 if ((op & ~mode & (MAY_READ|MAY_WRITE|MAY_EXEC)) == 0)
442 return 0;
443 return -EACCES;
444 }
445
sysctl_perm(struct ctl_table_header * head,struct ctl_table * table,int op)446 static int sysctl_perm(struct ctl_table_header *head, struct ctl_table *table, int op)
447 {
448 struct ctl_table_root *root = head->root;
449 int mode;
450
451 if (root->permissions)
452 mode = root->permissions(head, table);
453 else
454 mode = table->mode;
455
456 return test_perm(mode, op);
457 }
458
proc_sys_make_inode(struct super_block * sb,struct ctl_table_header * head,struct ctl_table * table)459 static struct inode *proc_sys_make_inode(struct super_block *sb,
460 struct ctl_table_header *head, struct ctl_table *table)
461 {
462 struct ctl_table_root *root = head->root;
463 struct inode *inode;
464 struct proc_inode *ei;
465
466 inode = new_inode(sb);
467 if (!inode)
468 return ERR_PTR(-ENOMEM);
469
470 inode->i_ino = get_next_ino();
471
472 ei = PROC_I(inode);
473
474 spin_lock(&sysctl_lock);
475 if (unlikely(head->unregistering)) {
476 spin_unlock(&sysctl_lock);
477 iput(inode);
478 return ERR_PTR(-ENOENT);
479 }
480 ei->sysctl = head;
481 ei->sysctl_entry = table;
482 hlist_add_head_rcu(&ei->sysctl_inodes, &head->inodes);
483 head->count++;
484 spin_unlock(&sysctl_lock);
485
486 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
487 inode->i_mode = table->mode;
488 if (!S_ISDIR(table->mode)) {
489 inode->i_mode |= S_IFREG;
490 inode->i_op = &proc_sys_inode_operations;
491 inode->i_fop = &proc_sys_file_operations;
492 } else {
493 inode->i_mode |= S_IFDIR;
494 inode->i_op = &proc_sys_dir_operations;
495 inode->i_fop = &proc_sys_dir_file_operations;
496 if (is_empty_dir(head))
497 make_empty_dir_inode(inode);
498 }
499
500 if (root->set_ownership)
501 root->set_ownership(head, table, &inode->i_uid, &inode->i_gid);
502 else {
503 inode->i_uid = GLOBAL_ROOT_UID;
504 inode->i_gid = GLOBAL_ROOT_GID;
505 }
506
507 return inode;
508 }
509
proc_sys_evict_inode(struct inode * inode,struct ctl_table_header * head)510 void proc_sys_evict_inode(struct inode *inode, struct ctl_table_header *head)
511 {
512 spin_lock(&sysctl_lock);
513 hlist_del_init_rcu(&PROC_I(inode)->sysctl_inodes);
514 if (!--head->count)
515 kfree_rcu(head, rcu);
516 spin_unlock(&sysctl_lock);
517 }
518
grab_header(struct inode * inode)519 static struct ctl_table_header *grab_header(struct inode *inode)
520 {
521 struct ctl_table_header *head = PROC_I(inode)->sysctl;
522 if (!head)
523 head = &sysctl_table_root.default_set.dir.header;
524 return sysctl_head_grab(head);
525 }
526
proc_sys_lookup(struct inode * dir,struct dentry * dentry,unsigned int flags)527 static struct dentry *proc_sys_lookup(struct inode *dir, struct dentry *dentry,
528 unsigned int flags)
529 {
530 struct ctl_table_header *head = grab_header(dir);
531 struct ctl_table_header *h = NULL;
532 const struct qstr *name = &dentry->d_name;
533 struct ctl_table *p;
534 struct inode *inode;
535 struct dentry *err = ERR_PTR(-ENOENT);
536 struct ctl_dir *ctl_dir;
537 int ret;
538
539 if (IS_ERR(head))
540 return ERR_CAST(head);
541
542 ctl_dir = container_of(head, struct ctl_dir, header);
543
544 p = lookup_entry(&h, ctl_dir, name->name, name->len);
545 if (!p)
546 goto out;
547
548 if (S_ISLNK(p->mode)) {
549 ret = sysctl_follow_link(&h, &p);
550 err = ERR_PTR(ret);
551 if (ret)
552 goto out;
553 }
554
555 inode = proc_sys_make_inode(dir->i_sb, h ? h : head, p);
556 if (IS_ERR(inode)) {
557 err = ERR_CAST(inode);
558 goto out;
559 }
560
561 d_set_d_op(dentry, &proc_sys_dentry_operations);
562 err = d_splice_alias(inode, dentry);
563
564 out:
565 if (h)
566 sysctl_head_finish(h);
567 sysctl_head_finish(head);
568 return err;
569 }
570
proc_sys_call_handler(struct file * filp,void __user * buf,size_t count,loff_t * ppos,int write)571 static ssize_t proc_sys_call_handler(struct file *filp, void __user *buf,
572 size_t count, loff_t *ppos, int write)
573 {
574 struct inode *inode = file_inode(filp);
575 struct ctl_table_header *head = grab_header(inode);
576 struct ctl_table *table = PROC_I(inode)->sysctl_entry;
577 ssize_t error;
578 size_t res;
579
580 if (IS_ERR(head))
581 return PTR_ERR(head);
582
583 /*
584 * At this point we know that the sysctl was not unregistered
585 * and won't be until we finish.
586 */
587 error = -EPERM;
588 if (sysctl_perm(head, table, write ? MAY_WRITE : MAY_READ))
589 goto out;
590
591 /* if that can happen at all, it should be -EINVAL, not -EISDIR */
592 error = -EINVAL;
593 if (!table->proc_handler)
594 goto out;
595
596 /* careful: calling conventions are nasty here */
597 res = count;
598 error = table->proc_handler(table, write, buf, &res, ppos);
599 if (!error)
600 error = res;
601 out:
602 sysctl_head_finish(head);
603
604 return error;
605 }
606
proc_sys_read(struct file * filp,char __user * buf,size_t count,loff_t * ppos)607 static ssize_t proc_sys_read(struct file *filp, char __user *buf,
608 size_t count, loff_t *ppos)
609 {
610 return proc_sys_call_handler(filp, (void __user *)buf, count, ppos, 0);
611 }
612
proc_sys_write(struct file * filp,const char __user * buf,size_t count,loff_t * ppos)613 static ssize_t proc_sys_write(struct file *filp, const char __user *buf,
614 size_t count, loff_t *ppos)
615 {
616 return proc_sys_call_handler(filp, (void __user *)buf, count, ppos, 1);
617 }
618
proc_sys_open(struct inode * inode,struct file * filp)619 static 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
proc_sys_poll(struct file * filp,poll_table * wait)636 static __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
662 out:
663 sysctl_head_finish(head);
664
665 return ret;
666 }
667
proc_sys_fill_cache(struct file * file,struct dir_context * ctx,struct ctl_table_header * head,struct ctl_table * table)668 static 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
proc_sys_link_fill_cache(struct file * file,struct dir_context * ctx,struct ctl_table_header * head,struct ctl_table * table)717 static 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);
733 out:
734 sysctl_head_finish(head);
735 return ret;
736 }
737
scan(struct ctl_table_header * head,struct ctl_table * table,unsigned long * pos,struct file * file,struct dir_context * ctx)738 static 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
proc_sys_readdir(struct file * file,struct dir_context * ctx)758 static 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 }
782 out:
783 sysctl_head_finish(head);
784 return 0;
785 }
786
proc_sys_permission(struct inode * inode,int mask)787 static 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
proc_sys_setattr(struct dentry * dentry,struct iattr * attr)815 static 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
proc_sys_getattr(const struct path * path,struct kstat * stat,u32 request_mask,unsigned int query_flags)832 static 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
850 static const struct file_operations proc_sys_file_operations = {
851 .open = proc_sys_open,
852 .poll = proc_sys_poll,
853 .read = proc_sys_read,
854 .write = proc_sys_write,
855 .llseek = default_llseek,
856 };
857
858 static const struct file_operations proc_sys_dir_file_operations = {
859 .read = generic_read_dir,
860 .iterate_shared = proc_sys_readdir,
861 .llseek = generic_file_llseek,
862 };
863
864 static const struct inode_operations proc_sys_inode_operations = {
865 .permission = proc_sys_permission,
866 .setattr = proc_sys_setattr,
867 .getattr = proc_sys_getattr,
868 };
869
870 static const struct inode_operations proc_sys_dir_operations = {
871 .lookup = proc_sys_lookup,
872 .permission = proc_sys_permission,
873 .setattr = proc_sys_setattr,
874 .getattr = proc_sys_getattr,
875 };
876
proc_sys_revalidate(struct dentry * dentry,unsigned int flags)877 static int proc_sys_revalidate(struct dentry *dentry, unsigned int flags)
878 {
879 if (flags & LOOKUP_RCU)
880 return -ECHILD;
881 return !PROC_I(d_inode(dentry))->sysctl->unregistering;
882 }
883
proc_sys_delete(const struct dentry * dentry)884 static int proc_sys_delete(const struct dentry *dentry)
885 {
886 return !!PROC_I(d_inode(dentry))->sysctl->unregistering;
887 }
888
sysctl_is_seen(struct ctl_table_header * p)889 static int sysctl_is_seen(struct ctl_table_header *p)
890 {
891 struct ctl_table_set *set = p->set;
892 int res;
893 spin_lock(&sysctl_lock);
894 if (p->unregistering)
895 res = 0;
896 else if (!set->is_seen)
897 res = 1;
898 else
899 res = set->is_seen(set);
900 spin_unlock(&sysctl_lock);
901 return res;
902 }
903
proc_sys_compare(const struct dentry * dentry,unsigned int len,const char * str,const struct qstr * name)904 static int proc_sys_compare(const struct dentry *dentry,
905 unsigned int len, const char *str, const struct qstr *name)
906 {
907 struct ctl_table_header *head;
908 struct inode *inode;
909
910 /* Although proc doesn't have negative dentries, rcu-walk means
911 * that inode here can be NULL */
912 /* AV: can it, indeed? */
913 inode = d_inode_rcu(dentry);
914 if (!inode)
915 return 1;
916 if (name->len != len)
917 return 1;
918 if (memcmp(name->name, str, len))
919 return 1;
920 head = rcu_dereference(PROC_I(inode)->sysctl);
921 return !head || !sysctl_is_seen(head);
922 }
923
924 static const struct dentry_operations proc_sys_dentry_operations = {
925 .d_revalidate = proc_sys_revalidate,
926 .d_delete = proc_sys_delete,
927 .d_compare = proc_sys_compare,
928 };
929
find_subdir(struct ctl_dir * dir,const char * name,int namelen)930 static struct ctl_dir *find_subdir(struct ctl_dir *dir,
931 const char *name, int namelen)
932 {
933 struct ctl_table_header *head;
934 struct ctl_table *entry;
935
936 entry = find_entry(&head, dir, name, namelen);
937 if (!entry)
938 return ERR_PTR(-ENOENT);
939 if (!S_ISDIR(entry->mode))
940 return ERR_PTR(-ENOTDIR);
941 return container_of(head, struct ctl_dir, header);
942 }
943
new_dir(struct ctl_table_set * set,const char * name,int namelen)944 static struct ctl_dir *new_dir(struct ctl_table_set *set,
945 const char *name, int namelen)
946 {
947 struct ctl_table *table;
948 struct ctl_dir *new;
949 struct ctl_node *node;
950 char *new_name;
951
952 new = kzalloc(sizeof(*new) + sizeof(struct ctl_node) +
953 sizeof(struct ctl_table)*2 + namelen + 1,
954 GFP_KERNEL);
955 if (!new)
956 return NULL;
957
958 node = (struct ctl_node *)(new + 1);
959 table = (struct ctl_table *)(node + 1);
960 new_name = (char *)(table + 2);
961 memcpy(new_name, name, namelen);
962 new_name[namelen] = '\0';
963 table[0].procname = new_name;
964 table[0].mode = S_IFDIR|S_IRUGO|S_IXUGO;
965 init_header(&new->header, set->dir.header.root, set, node, table);
966
967 return new;
968 }
969
970 /**
971 * get_subdir - find or create a subdir with the specified name.
972 * @dir: Directory to create the subdirectory in
973 * @name: The name of the subdirectory to find or create
974 * @namelen: The length of name
975 *
976 * Takes a directory with an elevated reference count so we know that
977 * if we drop the lock the directory will not go away. Upon success
978 * the reference is moved from @dir to the returned subdirectory.
979 * Upon error an error code is returned and the reference on @dir is
980 * simply dropped.
981 */
get_subdir(struct ctl_dir * dir,const char * name,int namelen)982 static struct ctl_dir *get_subdir(struct ctl_dir *dir,
983 const char *name, int namelen)
984 {
985 struct ctl_table_set *set = dir->header.set;
986 struct ctl_dir *subdir, *new = NULL;
987 int err;
988
989 spin_lock(&sysctl_lock);
990 subdir = find_subdir(dir, name, namelen);
991 if (!IS_ERR(subdir))
992 goto found;
993 if (PTR_ERR(subdir) != -ENOENT)
994 goto failed;
995
996 spin_unlock(&sysctl_lock);
997 new = new_dir(set, name, namelen);
998 spin_lock(&sysctl_lock);
999 subdir = ERR_PTR(-ENOMEM);
1000 if (!new)
1001 goto failed;
1002
1003 /* Was the subdir added while we dropped the lock? */
1004 subdir = find_subdir(dir, name, namelen);
1005 if (!IS_ERR(subdir))
1006 goto found;
1007 if (PTR_ERR(subdir) != -ENOENT)
1008 goto failed;
1009
1010 /* Nope. Use the our freshly made directory entry. */
1011 err = insert_header(dir, &new->header);
1012 subdir = ERR_PTR(err);
1013 if (err)
1014 goto failed;
1015 subdir = new;
1016 found:
1017 subdir->header.nreg++;
1018 failed:
1019 if (IS_ERR(subdir)) {
1020 pr_err("sysctl could not get directory: ");
1021 sysctl_print_dir(dir);
1022 pr_cont("/%*.*s %ld\n",
1023 namelen, namelen, name, PTR_ERR(subdir));
1024 }
1025 drop_sysctl_table(&dir->header);
1026 if (new)
1027 drop_sysctl_table(&new->header);
1028 spin_unlock(&sysctl_lock);
1029 return subdir;
1030 }
1031
xlate_dir(struct ctl_table_set * set,struct ctl_dir * dir)1032 static struct ctl_dir *xlate_dir(struct ctl_table_set *set, struct ctl_dir *dir)
1033 {
1034 struct ctl_dir *parent;
1035 const char *procname;
1036 if (!dir->header.parent)
1037 return &set->dir;
1038 parent = xlate_dir(set, dir->header.parent);
1039 if (IS_ERR(parent))
1040 return parent;
1041 procname = dir->header.ctl_table[0].procname;
1042 return find_subdir(parent, procname, strlen(procname));
1043 }
1044
sysctl_follow_link(struct ctl_table_header ** phead,struct ctl_table ** pentry)1045 static int sysctl_follow_link(struct ctl_table_header **phead,
1046 struct ctl_table **pentry)
1047 {
1048 struct ctl_table_header *head;
1049 struct ctl_table_root *root;
1050 struct ctl_table_set *set;
1051 struct ctl_table *entry;
1052 struct ctl_dir *dir;
1053 int ret;
1054
1055 ret = 0;
1056 spin_lock(&sysctl_lock);
1057 root = (*pentry)->data;
1058 set = lookup_header_set(root);
1059 dir = xlate_dir(set, (*phead)->parent);
1060 if (IS_ERR(dir))
1061 ret = PTR_ERR(dir);
1062 else {
1063 const char *procname = (*pentry)->procname;
1064 head = NULL;
1065 entry = find_entry(&head, dir, procname, strlen(procname));
1066 ret = -ENOENT;
1067 if (entry && use_table(head)) {
1068 unuse_table(*phead);
1069 *phead = head;
1070 *pentry = entry;
1071 ret = 0;
1072 }
1073 }
1074
1075 spin_unlock(&sysctl_lock);
1076 return ret;
1077 }
1078
sysctl_err(const char * path,struct ctl_table * table,char * fmt,...)1079 static int sysctl_err(const char *path, struct ctl_table *table, char *fmt, ...)
1080 {
1081 struct va_format vaf;
1082 va_list args;
1083
1084 va_start(args, fmt);
1085 vaf.fmt = fmt;
1086 vaf.va = &args;
1087
1088 pr_err("sysctl table check failed: %s/%s %pV\n",
1089 path, table->procname, &vaf);
1090
1091 va_end(args);
1092 return -EINVAL;
1093 }
1094
sysctl_check_table_array(const char * path,struct ctl_table * table)1095 static int sysctl_check_table_array(const char *path, struct ctl_table *table)
1096 {
1097 int err = 0;
1098
1099 if ((table->proc_handler == proc_douintvec) ||
1100 (table->proc_handler == proc_douintvec_minmax)) {
1101 if (table->maxlen != sizeof(unsigned int))
1102 err |= sysctl_err(path, table, "array not allowed");
1103 }
1104
1105 return err;
1106 }
1107
sysctl_check_table(const char * path,struct ctl_table * table)1108 static int sysctl_check_table(const char *path, struct ctl_table *table)
1109 {
1110 int err = 0;
1111 for (; table->procname; table++) {
1112 if (table->child)
1113 err |= sysctl_err(path, table, "Not a file");
1114
1115 if ((table->proc_handler == proc_dostring) ||
1116 (table->proc_handler == proc_dointvec) ||
1117 (table->proc_handler == proc_douintvec) ||
1118 (table->proc_handler == proc_douintvec_minmax) ||
1119 (table->proc_handler == proc_dointvec_minmax) ||
1120 (table->proc_handler == proc_dointvec_jiffies) ||
1121 (table->proc_handler == proc_dointvec_userhz_jiffies) ||
1122 (table->proc_handler == proc_dointvec_ms_jiffies) ||
1123 (table->proc_handler == proc_doulongvec_minmax) ||
1124 (table->proc_handler == proc_doulongvec_ms_jiffies_minmax)) {
1125 if (!table->data)
1126 err |= sysctl_err(path, table, "No data");
1127 if (!table->maxlen)
1128 err |= sysctl_err(path, table, "No maxlen");
1129 else
1130 err |= sysctl_check_table_array(path, table);
1131 }
1132 if (!table->proc_handler)
1133 err |= sysctl_err(path, table, "No proc_handler");
1134
1135 if ((table->mode & (S_IRUGO|S_IWUGO)) != table->mode)
1136 err |= sysctl_err(path, table, "bogus .mode 0%o",
1137 table->mode);
1138 }
1139 return err;
1140 }
1141
new_links(struct ctl_dir * dir,struct ctl_table * table,struct ctl_table_root * link_root)1142 static struct ctl_table_header *new_links(struct ctl_dir *dir, struct ctl_table *table,
1143 struct ctl_table_root *link_root)
1144 {
1145 struct ctl_table *link_table, *entry, *link;
1146 struct ctl_table_header *links;
1147 struct ctl_node *node;
1148 char *link_name;
1149 int nr_entries, name_bytes;
1150
1151 name_bytes = 0;
1152 nr_entries = 0;
1153 for (entry = table; entry->procname; entry++) {
1154 nr_entries++;
1155 name_bytes += strlen(entry->procname) + 1;
1156 }
1157
1158 links = kzalloc(sizeof(struct ctl_table_header) +
1159 sizeof(struct ctl_node)*nr_entries +
1160 sizeof(struct ctl_table)*(nr_entries + 1) +
1161 name_bytes,
1162 GFP_KERNEL);
1163
1164 if (!links)
1165 return NULL;
1166
1167 node = (struct ctl_node *)(links + 1);
1168 link_table = (struct ctl_table *)(node + nr_entries);
1169 link_name = (char *)&link_table[nr_entries + 1];
1170
1171 for (link = link_table, entry = table; entry->procname; link++, entry++) {
1172 int len = strlen(entry->procname) + 1;
1173 memcpy(link_name, entry->procname, len);
1174 link->procname = link_name;
1175 link->mode = S_IFLNK|S_IRWXUGO;
1176 link->data = link_root;
1177 link_name += len;
1178 }
1179 init_header(links, dir->header.root, dir->header.set, node, link_table);
1180 links->nreg = nr_entries;
1181
1182 return links;
1183 }
1184
get_links(struct ctl_dir * dir,struct ctl_table * table,struct ctl_table_root * link_root)1185 static bool get_links(struct ctl_dir *dir,
1186 struct ctl_table *table, struct ctl_table_root *link_root)
1187 {
1188 struct ctl_table_header *head;
1189 struct ctl_table *entry, *link;
1190
1191 /* Are there links available for every entry in table? */
1192 for (entry = table; entry->procname; entry++) {
1193 const char *procname = entry->procname;
1194 link = find_entry(&head, dir, procname, strlen(procname));
1195 if (!link)
1196 return false;
1197 if (S_ISDIR(link->mode) && S_ISDIR(entry->mode))
1198 continue;
1199 if (S_ISLNK(link->mode) && (link->data == link_root))
1200 continue;
1201 return false;
1202 }
1203
1204 /* The checks passed. Increase the registration count on the links */
1205 for (entry = table; entry->procname; entry++) {
1206 const char *procname = entry->procname;
1207 link = find_entry(&head, dir, procname, strlen(procname));
1208 head->nreg++;
1209 }
1210 return true;
1211 }
1212
insert_links(struct ctl_table_header * head)1213 static int insert_links(struct ctl_table_header *head)
1214 {
1215 struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1216 struct ctl_dir *core_parent = NULL;
1217 struct ctl_table_header *links;
1218 int err;
1219
1220 if (head->set == root_set)
1221 return 0;
1222
1223 core_parent = xlate_dir(root_set, head->parent);
1224 if (IS_ERR(core_parent))
1225 return 0;
1226
1227 if (get_links(core_parent, head->ctl_table, head->root))
1228 return 0;
1229
1230 core_parent->header.nreg++;
1231 spin_unlock(&sysctl_lock);
1232
1233 links = new_links(core_parent, head->ctl_table, head->root);
1234
1235 spin_lock(&sysctl_lock);
1236 err = -ENOMEM;
1237 if (!links)
1238 goto out;
1239
1240 err = 0;
1241 if (get_links(core_parent, head->ctl_table, head->root)) {
1242 kfree(links);
1243 goto out;
1244 }
1245
1246 err = insert_header(core_parent, links);
1247 if (err)
1248 kfree(links);
1249 out:
1250 drop_sysctl_table(&core_parent->header);
1251 return err;
1252 }
1253
1254 /**
1255 * __register_sysctl_table - register a leaf sysctl table
1256 * @set: Sysctl tree to register on
1257 * @path: The path to the directory the sysctl table is in.
1258 * @table: the top-level table structure
1259 *
1260 * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1261 * array. A completely 0 filled entry terminates the table.
1262 *
1263 * The members of the &struct ctl_table structure are used as follows:
1264 *
1265 * procname - the name of the sysctl file under /proc/sys. Set to %NULL to not
1266 * enter a sysctl file
1267 *
1268 * data - a pointer to data for use by proc_handler
1269 *
1270 * maxlen - the maximum size in bytes of the data
1271 *
1272 * mode - the file permissions for the /proc/sys file
1273 *
1274 * child - must be %NULL.
1275 *
1276 * proc_handler - the text handler routine (described below)
1277 *
1278 * extra1, extra2 - extra pointers usable by the proc handler routines
1279 *
1280 * Leaf nodes in the sysctl tree will be represented by a single file
1281 * under /proc; non-leaf nodes will be represented by directories.
1282 *
1283 * There must be a proc_handler routine for any terminal nodes.
1284 * Several default handlers are available to cover common cases -
1285 *
1286 * proc_dostring(), proc_dointvec(), proc_dointvec_jiffies(),
1287 * proc_dointvec_userhz_jiffies(), proc_dointvec_minmax(),
1288 * proc_doulongvec_ms_jiffies_minmax(), proc_doulongvec_minmax()
1289 *
1290 * It is the handler's job to read the input buffer from user memory
1291 * and process it. The handler should return 0 on success.
1292 *
1293 * This routine returns %NULL on a failure to register, and a pointer
1294 * to the table header on success.
1295 */
__register_sysctl_table(struct ctl_table_set * set,const char * path,struct ctl_table * table)1296 struct ctl_table_header *__register_sysctl_table(
1297 struct ctl_table_set *set,
1298 const char *path, struct ctl_table *table)
1299 {
1300 struct ctl_table_root *root = set->dir.header.root;
1301 struct ctl_table_header *header;
1302 const char *name, *nextname;
1303 struct ctl_dir *dir;
1304 struct ctl_table *entry;
1305 struct ctl_node *node;
1306 int nr_entries = 0;
1307
1308 for (entry = table; entry->procname; entry++)
1309 nr_entries++;
1310
1311 header = kzalloc(sizeof(struct ctl_table_header) +
1312 sizeof(struct ctl_node)*nr_entries, GFP_KERNEL);
1313 if (!header)
1314 return NULL;
1315
1316 node = (struct ctl_node *)(header + 1);
1317 init_header(header, root, set, node, table);
1318 if (sysctl_check_table(path, table))
1319 goto fail;
1320
1321 spin_lock(&sysctl_lock);
1322 dir = &set->dir;
1323 /* Reference moved down the diretory tree get_subdir */
1324 dir->header.nreg++;
1325 spin_unlock(&sysctl_lock);
1326
1327 /* Find the directory for the ctl_table */
1328 for (name = path; name; name = nextname) {
1329 int namelen;
1330 nextname = strchr(name, '/');
1331 if (nextname) {
1332 namelen = nextname - name;
1333 nextname++;
1334 } else {
1335 namelen = strlen(name);
1336 }
1337 if (namelen == 0)
1338 continue;
1339
1340 dir = get_subdir(dir, name, namelen);
1341 if (IS_ERR(dir))
1342 goto fail;
1343 }
1344
1345 spin_lock(&sysctl_lock);
1346 if (insert_header(dir, header))
1347 goto fail_put_dir_locked;
1348
1349 drop_sysctl_table(&dir->header);
1350 spin_unlock(&sysctl_lock);
1351
1352 return header;
1353
1354 fail_put_dir_locked:
1355 drop_sysctl_table(&dir->header);
1356 spin_unlock(&sysctl_lock);
1357 fail:
1358 kfree(header);
1359 dump_stack();
1360 return NULL;
1361 }
1362
1363 /**
1364 * register_sysctl - register a sysctl table
1365 * @path: The path to the directory the sysctl table is in.
1366 * @table: the table structure
1367 *
1368 * Register a sysctl table. @table should be a filled in ctl_table
1369 * array. A completely 0 filled entry terminates the table.
1370 *
1371 * See __register_sysctl_table for more details.
1372 */
register_sysctl(const char * path,struct ctl_table * table)1373 struct ctl_table_header *register_sysctl(const char *path, struct ctl_table *table)
1374 {
1375 return __register_sysctl_table(&sysctl_table_root.default_set,
1376 path, table);
1377 }
1378 EXPORT_SYMBOL(register_sysctl);
1379
1380 /**
1381 * __register_sysctl_init() - register sysctl table to path
1382 * @path: path name for sysctl base
1383 * @table: This is the sysctl table that needs to be registered to the path
1384 * @table_name: The name of sysctl table, only used for log printing when
1385 * registration fails
1386 *
1387 * The sysctl interface is used by userspace to query or modify at runtime
1388 * a predefined value set on a variable. These variables however have default
1389 * values pre-set. Code which depends on these variables will always work even
1390 * if register_sysctl() fails. If register_sysctl() fails you'd just loose the
1391 * ability to query or modify the sysctls dynamically at run time. Chances of
1392 * register_sysctl() failing on init are extremely low, and so for both reasons
1393 * this function does not return any error as it is used by initialization code.
1394 *
1395 * Context: Can only be called after your respective sysctl base path has been
1396 * registered. So for instance, most base directories are registered early on
1397 * init before init levels are processed through proc_sys_init() and
1398 * sysctl_init().
1399 */
__register_sysctl_init(const char * path,struct ctl_table * table,const char * table_name)1400 void __init __register_sysctl_init(const char *path, struct ctl_table *table,
1401 const char *table_name)
1402 {
1403 struct ctl_table_header *hdr = register_sysctl(path, table);
1404
1405 if (unlikely(!hdr)) {
1406 pr_err("failed when register_sysctl %s to %s\n", table_name, path);
1407 return;
1408 }
1409 kmemleak_not_leak(hdr);
1410 }
1411
append_path(const char * path,char * pos,const char * name)1412 static char *append_path(const char *path, char *pos, const char *name)
1413 {
1414 int namelen;
1415 namelen = strlen(name);
1416 if (((pos - path) + namelen + 2) >= PATH_MAX)
1417 return NULL;
1418 memcpy(pos, name, namelen);
1419 pos[namelen] = '/';
1420 pos[namelen + 1] = '\0';
1421 pos += namelen + 1;
1422 return pos;
1423 }
1424
count_subheaders(struct ctl_table * table)1425 static int count_subheaders(struct ctl_table *table)
1426 {
1427 int has_files = 0;
1428 int nr_subheaders = 0;
1429 struct ctl_table *entry;
1430
1431 /* special case: no directory and empty directory */
1432 if (!table || !table->procname)
1433 return 1;
1434
1435 for (entry = table; entry->procname; entry++) {
1436 if (entry->child)
1437 nr_subheaders += count_subheaders(entry->child);
1438 else
1439 has_files = 1;
1440 }
1441 return nr_subheaders + has_files;
1442 }
1443
register_leaf_sysctl_tables(const char * path,char * pos,struct ctl_table_header *** subheader,struct ctl_table_set * set,struct ctl_table * table)1444 static int register_leaf_sysctl_tables(const char *path, char *pos,
1445 struct ctl_table_header ***subheader, struct ctl_table_set *set,
1446 struct ctl_table *table)
1447 {
1448 struct ctl_table *ctl_table_arg = NULL;
1449 struct ctl_table *entry, *files;
1450 int nr_files = 0;
1451 int nr_dirs = 0;
1452 int err = -ENOMEM;
1453
1454 for (entry = table; entry->procname; entry++) {
1455 if (entry->child)
1456 nr_dirs++;
1457 else
1458 nr_files++;
1459 }
1460
1461 files = table;
1462 /* If there are mixed files and directories we need a new table */
1463 if (nr_dirs && nr_files) {
1464 struct ctl_table *new;
1465 files = kcalloc(nr_files + 1, sizeof(struct ctl_table),
1466 GFP_KERNEL);
1467 if (!files)
1468 goto out;
1469
1470 ctl_table_arg = files;
1471 for (new = files, entry = table; entry->procname; entry++) {
1472 if (entry->child)
1473 continue;
1474 *new = *entry;
1475 new++;
1476 }
1477 }
1478
1479 /* Register everything except a directory full of subdirectories */
1480 if (nr_files || !nr_dirs) {
1481 struct ctl_table_header *header;
1482 header = __register_sysctl_table(set, path, files);
1483 if (!header) {
1484 kfree(ctl_table_arg);
1485 goto out;
1486 }
1487
1488 /* Remember if we need to free the file table */
1489 header->ctl_table_arg = ctl_table_arg;
1490 **subheader = header;
1491 (*subheader)++;
1492 }
1493
1494 /* Recurse into the subdirectories. */
1495 for (entry = table; entry->procname; entry++) {
1496 char *child_pos;
1497
1498 if (!entry->child)
1499 continue;
1500
1501 err = -ENAMETOOLONG;
1502 child_pos = append_path(path, pos, entry->procname);
1503 if (!child_pos)
1504 goto out;
1505
1506 err = register_leaf_sysctl_tables(path, child_pos, subheader,
1507 set, entry->child);
1508 pos[0] = '\0';
1509 if (err)
1510 goto out;
1511 }
1512 err = 0;
1513 out:
1514 /* On failure our caller will unregister all registered subheaders */
1515 return err;
1516 }
1517
1518 /**
1519 * __register_sysctl_paths - register a sysctl table hierarchy
1520 * @set: Sysctl tree to register on
1521 * @path: The path to the directory the sysctl table is in.
1522 * @table: the top-level table structure
1523 *
1524 * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1525 * array. A completely 0 filled entry terminates the table.
1526 *
1527 * See __register_sysctl_table for more details.
1528 */
__register_sysctl_paths(struct ctl_table_set * set,const struct ctl_path * path,struct ctl_table * table)1529 struct ctl_table_header *__register_sysctl_paths(
1530 struct ctl_table_set *set,
1531 const struct ctl_path *path, struct ctl_table *table)
1532 {
1533 struct ctl_table *ctl_table_arg = table;
1534 int nr_subheaders = count_subheaders(table);
1535 struct ctl_table_header *header = NULL, **subheaders, **subheader;
1536 const struct ctl_path *component;
1537 char *new_path, *pos;
1538
1539 pos = new_path = kmalloc(PATH_MAX, GFP_KERNEL);
1540 if (!new_path)
1541 return NULL;
1542
1543 pos[0] = '\0';
1544 for (component = path; component->procname; component++) {
1545 pos = append_path(new_path, pos, component->procname);
1546 if (!pos)
1547 goto out;
1548 }
1549 while (table->procname && table->child && !table[1].procname) {
1550 pos = append_path(new_path, pos, table->procname);
1551 if (!pos)
1552 goto out;
1553 table = table->child;
1554 }
1555 if (nr_subheaders == 1) {
1556 header = __register_sysctl_table(set, new_path, table);
1557 if (header)
1558 header->ctl_table_arg = ctl_table_arg;
1559 } else {
1560 header = kzalloc(sizeof(*header) +
1561 sizeof(*subheaders)*nr_subheaders, GFP_KERNEL);
1562 if (!header)
1563 goto out;
1564
1565 subheaders = (struct ctl_table_header **) (header + 1);
1566 subheader = subheaders;
1567 header->ctl_table_arg = ctl_table_arg;
1568
1569 if (register_leaf_sysctl_tables(new_path, pos, &subheader,
1570 set, table))
1571 goto err_register_leaves;
1572 }
1573
1574 out:
1575 kfree(new_path);
1576 return header;
1577
1578 err_register_leaves:
1579 while (subheader > subheaders) {
1580 struct ctl_table_header *subh = *(--subheader);
1581 struct ctl_table *table = subh->ctl_table_arg;
1582 unregister_sysctl_table(subh);
1583 kfree(table);
1584 }
1585 kfree(header);
1586 header = NULL;
1587 goto out;
1588 }
1589
1590 /**
1591 * register_sysctl_table_path - register a sysctl table hierarchy
1592 * @path: The path to the directory the sysctl table is in.
1593 * @table: the top-level table structure
1594 *
1595 * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1596 * array. A completely 0 filled entry terminates the table.
1597 *
1598 * See __register_sysctl_paths for more details.
1599 */
register_sysctl_paths(const struct ctl_path * path,struct ctl_table * table)1600 struct ctl_table_header *register_sysctl_paths(const struct ctl_path *path,
1601 struct ctl_table *table)
1602 {
1603 return __register_sysctl_paths(&sysctl_table_root.default_set,
1604 path, table);
1605 }
1606 EXPORT_SYMBOL(register_sysctl_paths);
1607
1608 /**
1609 * register_sysctl_table - register a sysctl table hierarchy
1610 * @table: the top-level table structure
1611 *
1612 * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1613 * array. A completely 0 filled entry terminates the table.
1614 *
1615 * See register_sysctl_paths for more details.
1616 */
register_sysctl_table(struct ctl_table * table)1617 struct ctl_table_header *register_sysctl_table(struct ctl_table *table)
1618 {
1619 static const struct ctl_path null_path[] = { {} };
1620
1621 return register_sysctl_paths(null_path, table);
1622 }
1623 EXPORT_SYMBOL(register_sysctl_table);
1624
put_links(struct ctl_table_header * header)1625 static void put_links(struct ctl_table_header *header)
1626 {
1627 struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1628 struct ctl_table_root *root = header->root;
1629 struct ctl_dir *parent = header->parent;
1630 struct ctl_dir *core_parent;
1631 struct ctl_table *entry;
1632
1633 if (header->set == root_set)
1634 return;
1635
1636 core_parent = xlate_dir(root_set, parent);
1637 if (IS_ERR(core_parent))
1638 return;
1639
1640 for (entry = header->ctl_table; entry->procname; entry++) {
1641 struct ctl_table_header *link_head;
1642 struct ctl_table *link;
1643 const char *name = entry->procname;
1644
1645 link = find_entry(&link_head, core_parent, name, strlen(name));
1646 if (link &&
1647 ((S_ISDIR(link->mode) && S_ISDIR(entry->mode)) ||
1648 (S_ISLNK(link->mode) && (link->data == root)))) {
1649 drop_sysctl_table(link_head);
1650 }
1651 else {
1652 pr_err("sysctl link missing during unregister: ");
1653 sysctl_print_dir(parent);
1654 pr_cont("/%s\n", name);
1655 }
1656 }
1657 }
1658
drop_sysctl_table(struct ctl_table_header * header)1659 static void drop_sysctl_table(struct ctl_table_header *header)
1660 {
1661 struct ctl_dir *parent = header->parent;
1662
1663 if (--header->nreg)
1664 return;
1665
1666 if (parent) {
1667 put_links(header);
1668 start_unregistering(header);
1669 }
1670
1671 if (!--header->count)
1672 kfree_rcu(header, rcu);
1673
1674 if (parent)
1675 drop_sysctl_table(&parent->header);
1676 }
1677
1678 /**
1679 * unregister_sysctl_table - unregister a sysctl table hierarchy
1680 * @header: the header returned from register_sysctl_table
1681 *
1682 * Unregisters the sysctl table and all children. proc entries may not
1683 * actually be removed until they are no longer used by anyone.
1684 */
unregister_sysctl_table(struct ctl_table_header * header)1685 void unregister_sysctl_table(struct ctl_table_header * header)
1686 {
1687 int nr_subheaders;
1688 might_sleep();
1689
1690 if (header == NULL)
1691 return;
1692
1693 nr_subheaders = count_subheaders(header->ctl_table_arg);
1694 if (unlikely(nr_subheaders > 1)) {
1695 struct ctl_table_header **subheaders;
1696 int i;
1697
1698 subheaders = (struct ctl_table_header **)(header + 1);
1699 for (i = nr_subheaders -1; i >= 0; i--) {
1700 struct ctl_table_header *subh = subheaders[i];
1701 struct ctl_table *table = subh->ctl_table_arg;
1702 unregister_sysctl_table(subh);
1703 kfree(table);
1704 }
1705 kfree(header);
1706 return;
1707 }
1708
1709 spin_lock(&sysctl_lock);
1710 drop_sysctl_table(header);
1711 spin_unlock(&sysctl_lock);
1712 }
1713 EXPORT_SYMBOL(unregister_sysctl_table);
1714
setup_sysctl_set(struct ctl_table_set * set,struct ctl_table_root * root,int (* is_seen)(struct ctl_table_set *))1715 void setup_sysctl_set(struct ctl_table_set *set,
1716 struct ctl_table_root *root,
1717 int (*is_seen)(struct ctl_table_set *))
1718 {
1719 memset(set, 0, sizeof(*set));
1720 set->is_seen = is_seen;
1721 init_header(&set->dir.header, root, set, NULL, root_table);
1722 }
1723
retire_sysctl_set(struct ctl_table_set * set)1724 void retire_sysctl_set(struct ctl_table_set *set)
1725 {
1726 WARN_ON(!RB_EMPTY_ROOT(&set->dir.root));
1727 }
1728
proc_sys_init(void)1729 int __init proc_sys_init(void)
1730 {
1731 struct proc_dir_entry *proc_sys_root;
1732
1733 proc_sys_root = proc_mkdir("sys", NULL);
1734 proc_sys_root->proc_iops = &proc_sys_dir_operations;
1735 proc_sys_root->proc_fops = &proc_sys_dir_file_operations;
1736 proc_sys_root->nlink = 0;
1737
1738 return sysctl_init();
1739 }
1740