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