1 // SPDX-License-Identifier: GPL-2.0
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>
15 #include <linux/uio.h>
16 #include <linux/module.h>
17 #include <linux/bpf-cgroup.h>
18 #include <linux/mount.h>
19 #include <linux/kmemleak.h>
22 #define list_for_each_table_entry(entry, header) \
23 entry = header->ctl_table; \
24 for (size_t i = 0 ; i < header->ctl_table_size && entry->procname; ++i, entry++)
26 static const struct dentry_operations proc_sys_dentry_operations;
27 static const struct file_operations proc_sys_file_operations;
28 static const struct inode_operations proc_sys_inode_operations;
29 static const struct file_operations proc_sys_dir_file_operations;
30 static const struct inode_operations proc_sys_dir_operations;
32 /* Support for permanently empty directories */
33 static struct ctl_table sysctl_mount_point[] = {
34 {.type = SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY }
38 * register_sysctl_mount_point() - registers a sysctl mount point
39 * @path: path for the mount point
41 * Used to create a permanently empty directory to serve as mount point.
42 * There are some subtle but important permission checks this allows in the
43 * case of unprivileged mounts.
45 struct ctl_table_header *register_sysctl_mount_point(const char *path)
47 return register_sysctl_sz(path, sysctl_mount_point, 0);
49 EXPORT_SYMBOL(register_sysctl_mount_point);
51 #define sysctl_is_perm_empty_ctl_table(tptr) \
52 (tptr[0].type == SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY)
53 #define sysctl_is_perm_empty_ctl_header(hptr) \
54 (sysctl_is_perm_empty_ctl_table(hptr->ctl_table))
55 #define sysctl_set_perm_empty_ctl_header(hptr) \
56 (hptr->ctl_table[0].type = SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY)
57 #define sysctl_clear_perm_empty_ctl_header(hptr) \
58 (hptr->ctl_table[0].type = SYSCTL_TABLE_TYPE_DEFAULT)
60 void proc_sys_poll_notify(struct ctl_table_poll *poll)
65 atomic_inc(&poll->event);
66 wake_up_interruptible(&poll->wait);
69 static struct ctl_table root_table[] = {
72 .mode = S_IFDIR|S_IRUGO|S_IXUGO,
76 static struct ctl_table_root sysctl_table_root = {
77 .default_set.dir.header = {
80 .ctl_table = root_table }},
81 .ctl_table_arg = root_table,
82 .root = &sysctl_table_root,
83 .set = &sysctl_table_root.default_set,
87 static DEFINE_SPINLOCK(sysctl_lock);
89 static void drop_sysctl_table(struct ctl_table_header *header);
90 static int sysctl_follow_link(struct ctl_table_header **phead,
91 struct ctl_table **pentry);
92 static int insert_links(struct ctl_table_header *head);
93 static void put_links(struct ctl_table_header *header);
95 static void sysctl_print_dir(struct ctl_dir *dir)
97 if (dir->header.parent)
98 sysctl_print_dir(dir->header.parent);
99 pr_cont("%s/", dir->header.ctl_table[0].procname);
102 static int namecmp(const char *name1, int len1, const char *name2, int len2)
106 cmp = memcmp(name1, name2, min(len1, len2));
112 /* Called under sysctl_lock */
113 static struct ctl_table *find_entry(struct ctl_table_header **phead,
114 struct ctl_dir *dir, const char *name, int namelen)
116 struct ctl_table_header *head;
117 struct ctl_table *entry;
118 struct rb_node *node = dir->root.rb_node;
122 struct ctl_node *ctl_node;
123 const char *procname;
126 ctl_node = rb_entry(node, struct ctl_node, node);
127 head = ctl_node->header;
128 entry = &head->ctl_table[ctl_node - head->node];
129 procname = entry->procname;
131 cmp = namecmp(name, namelen, procname, strlen(procname));
133 node = node->rb_left;
135 node = node->rb_right;
144 static int insert_entry(struct ctl_table_header *head, struct ctl_table *entry)
146 struct rb_node *node = &head->node[entry - head->ctl_table].node;
147 struct rb_node **p = &head->parent->root.rb_node;
148 struct rb_node *parent = NULL;
149 const char *name = entry->procname;
150 int namelen = strlen(name);
153 struct ctl_table_header *parent_head;
154 struct ctl_table *parent_entry;
155 struct ctl_node *parent_node;
156 const char *parent_name;
160 parent_node = rb_entry(parent, struct ctl_node, node);
161 parent_head = parent_node->header;
162 parent_entry = &parent_head->ctl_table[parent_node - parent_head->node];
163 parent_name = parent_entry->procname;
165 cmp = namecmp(name, namelen, parent_name, strlen(parent_name));
171 pr_err("sysctl duplicate entry: ");
172 sysctl_print_dir(head->parent);
173 pr_cont("%s\n", entry->procname);
178 rb_link_node(node, parent, p);
179 rb_insert_color(node, &head->parent->root);
183 static void erase_entry(struct ctl_table_header *head, struct ctl_table *entry)
185 struct rb_node *node = &head->node[entry - head->ctl_table].node;
187 rb_erase(node, &head->parent->root);
190 static void init_header(struct ctl_table_header *head,
191 struct ctl_table_root *root, struct ctl_table_set *set,
192 struct ctl_node *node, struct ctl_table *table, size_t table_size)
194 head->ctl_table = table;
195 head->ctl_table_size = table_size;
196 head->ctl_table_arg = table;
200 head->unregistering = NULL;
205 INIT_HLIST_HEAD(&head->inodes);
207 struct ctl_table *entry;
209 list_for_each_table_entry(entry, head) {
216 static void erase_header(struct ctl_table_header *head)
218 struct ctl_table *entry;
220 list_for_each_table_entry(entry, head)
221 erase_entry(head, entry);
224 static int insert_header(struct ctl_dir *dir, struct ctl_table_header *header)
226 struct ctl_table *entry;
227 struct ctl_table_header *dir_h = &dir->header;
231 /* Is this a permanently empty directory? */
232 if (sysctl_is_perm_empty_ctl_header(dir_h))
235 /* Am I creating a permanently empty directory? */
236 if (sysctl_is_perm_empty_ctl_table(header->ctl_table)) {
237 if (!RB_EMPTY_ROOT(&dir->root))
239 sysctl_set_perm_empty_ctl_header(dir_h);
243 header->parent = dir;
244 err = insert_links(header);
247 list_for_each_table_entry(entry, header) {
248 err = insert_entry(header, entry);
254 erase_header(header);
257 if (header->ctl_table == sysctl_mount_point)
258 sysctl_clear_perm_empty_ctl_header(dir_h);
259 header->parent = NULL;
260 drop_sysctl_table(dir_h);
264 /* called under sysctl_lock */
265 static int use_table(struct ctl_table_header *p)
267 if (unlikely(p->unregistering))
273 /* called under sysctl_lock */
274 static void unuse_table(struct ctl_table_header *p)
277 if (unlikely(p->unregistering))
278 complete(p->unregistering);
281 static void proc_sys_invalidate_dcache(struct ctl_table_header *head)
283 proc_invalidate_siblings_dcache(&head->inodes, &sysctl_lock);
286 /* called under sysctl_lock, will reacquire if has to wait */
287 static void start_unregistering(struct ctl_table_header *p)
290 * if p->used is 0, nobody will ever touch that entry again;
291 * we'll eliminate all paths to it before dropping sysctl_lock
293 if (unlikely(p->used)) {
294 struct completion wait;
295 init_completion(&wait);
296 p->unregistering = &wait;
297 spin_unlock(&sysctl_lock);
298 wait_for_completion(&wait);
300 /* anything non-NULL; we'll never dereference it */
301 p->unregistering = ERR_PTR(-EINVAL);
302 spin_unlock(&sysctl_lock);
305 * Invalidate dentries for unregistered sysctls: namespaced sysctls
306 * can have duplicate names and contaminate dcache very badly.
308 proc_sys_invalidate_dcache(p);
310 * do not remove from the list until nobody holds it; walking the
311 * list in do_sysctl() relies on that.
313 spin_lock(&sysctl_lock);
317 static struct ctl_table_header *sysctl_head_grab(struct ctl_table_header *head)
320 spin_lock(&sysctl_lock);
321 if (!use_table(head))
322 head = ERR_PTR(-ENOENT);
323 spin_unlock(&sysctl_lock);
327 static void sysctl_head_finish(struct ctl_table_header *head)
331 spin_lock(&sysctl_lock);
333 spin_unlock(&sysctl_lock);
336 static struct ctl_table_set *
337 lookup_header_set(struct ctl_table_root *root)
339 struct ctl_table_set *set = &root->default_set;
341 set = root->lookup(root);
345 static struct ctl_table *lookup_entry(struct ctl_table_header **phead,
347 const char *name, int namelen)
349 struct ctl_table_header *head;
350 struct ctl_table *entry;
352 spin_lock(&sysctl_lock);
353 entry = find_entry(&head, dir, name, namelen);
354 if (entry && use_table(head))
358 spin_unlock(&sysctl_lock);
362 static struct ctl_node *first_usable_entry(struct rb_node *node)
364 struct ctl_node *ctl_node;
366 for (;node; node = rb_next(node)) {
367 ctl_node = rb_entry(node, struct ctl_node, node);
368 if (use_table(ctl_node->header))
374 static void first_entry(struct ctl_dir *dir,
375 struct ctl_table_header **phead, struct ctl_table **pentry)
377 struct ctl_table_header *head = NULL;
378 struct ctl_table *entry = NULL;
379 struct ctl_node *ctl_node;
381 spin_lock(&sysctl_lock);
382 ctl_node = first_usable_entry(rb_first(&dir->root));
383 spin_unlock(&sysctl_lock);
385 head = ctl_node->header;
386 entry = &head->ctl_table[ctl_node - head->node];
392 static void next_entry(struct ctl_table_header **phead, struct ctl_table **pentry)
394 struct ctl_table_header *head = *phead;
395 struct ctl_table *entry = *pentry;
396 struct ctl_node *ctl_node = &head->node[entry - head->ctl_table];
398 spin_lock(&sysctl_lock);
401 ctl_node = first_usable_entry(rb_next(&ctl_node->node));
402 spin_unlock(&sysctl_lock);
405 head = ctl_node->header;
406 entry = &head->ctl_table[ctl_node - head->node];
413 * sysctl_perm does NOT grant the superuser all rights automatically, because
414 * some sysctl variables are readonly even to root.
417 static int test_perm(int mode, int op)
419 if (uid_eq(current_euid(), GLOBAL_ROOT_UID))
421 else if (in_egroup_p(GLOBAL_ROOT_GID))
423 if ((op & ~mode & (MAY_READ|MAY_WRITE|MAY_EXEC)) == 0)
428 static int sysctl_perm(struct ctl_table_header *head, struct ctl_table *table, int op)
430 struct ctl_table_root *root = head->root;
433 if (root->permissions)
434 mode = root->permissions(head, table);
438 return test_perm(mode, op);
441 static struct inode *proc_sys_make_inode(struct super_block *sb,
442 struct ctl_table_header *head, struct ctl_table *table)
444 struct ctl_table_root *root = head->root;
446 struct proc_inode *ei;
448 inode = new_inode(sb);
450 return ERR_PTR(-ENOMEM);
452 inode->i_ino = get_next_ino();
456 spin_lock(&sysctl_lock);
457 if (unlikely(head->unregistering)) {
458 spin_unlock(&sysctl_lock);
460 return ERR_PTR(-ENOENT);
463 ei->sysctl_entry = table;
464 hlist_add_head_rcu(&ei->sibling_inodes, &head->inodes);
466 spin_unlock(&sysctl_lock);
468 inode->i_mtime = inode->i_atime = inode_set_ctime_current(inode);
469 inode->i_mode = table->mode;
470 if (!S_ISDIR(table->mode)) {
471 inode->i_mode |= S_IFREG;
472 inode->i_op = &proc_sys_inode_operations;
473 inode->i_fop = &proc_sys_file_operations;
475 inode->i_mode |= S_IFDIR;
476 inode->i_op = &proc_sys_dir_operations;
477 inode->i_fop = &proc_sys_dir_file_operations;
478 if (sysctl_is_perm_empty_ctl_header(head))
479 make_empty_dir_inode(inode);
482 if (root->set_ownership)
483 root->set_ownership(head, table, &inode->i_uid, &inode->i_gid);
485 inode->i_uid = GLOBAL_ROOT_UID;
486 inode->i_gid = GLOBAL_ROOT_GID;
492 void proc_sys_evict_inode(struct inode *inode, struct ctl_table_header *head)
494 spin_lock(&sysctl_lock);
495 hlist_del_init_rcu(&PROC_I(inode)->sibling_inodes);
497 kfree_rcu(head, rcu);
498 spin_unlock(&sysctl_lock);
501 static struct ctl_table_header *grab_header(struct inode *inode)
503 struct ctl_table_header *head = PROC_I(inode)->sysctl;
505 head = &sysctl_table_root.default_set.dir.header;
506 return sysctl_head_grab(head);
509 static struct dentry *proc_sys_lookup(struct inode *dir, struct dentry *dentry,
512 struct ctl_table_header *head = grab_header(dir);
513 struct ctl_table_header *h = NULL;
514 const struct qstr *name = &dentry->d_name;
517 struct dentry *err = ERR_PTR(-ENOENT);
518 struct ctl_dir *ctl_dir;
522 return ERR_CAST(head);
524 ctl_dir = container_of(head, struct ctl_dir, header);
526 p = lookup_entry(&h, ctl_dir, name->name, name->len);
530 if (S_ISLNK(p->mode)) {
531 ret = sysctl_follow_link(&h, &p);
537 inode = proc_sys_make_inode(dir->i_sb, h ? h : head, p);
539 err = ERR_CAST(inode);
543 d_set_d_op(dentry, &proc_sys_dentry_operations);
544 err = d_splice_alias(inode, dentry);
548 sysctl_head_finish(h);
549 sysctl_head_finish(head);
553 static ssize_t proc_sys_call_handler(struct kiocb *iocb, struct iov_iter *iter,
556 struct inode *inode = file_inode(iocb->ki_filp);
557 struct ctl_table_header *head = grab_header(inode);
558 struct ctl_table *table = PROC_I(inode)->sysctl_entry;
559 size_t count = iov_iter_count(iter);
564 return PTR_ERR(head);
567 * At this point we know that the sysctl was not unregistered
568 * and won't be until we finish.
571 if (sysctl_perm(head, table, write ? MAY_WRITE : MAY_READ))
574 /* if that can happen at all, it should be -EINVAL, not -EISDIR */
576 if (!table->proc_handler)
579 /* don't even try if the size is too large */
581 if (count >= KMALLOC_MAX_SIZE)
583 kbuf = kvzalloc(count + 1, GFP_KERNEL);
589 if (!copy_from_iter_full(kbuf, count, iter))
594 error = BPF_CGROUP_RUN_PROG_SYSCTL(head, table, write, &kbuf, &count,
599 /* careful: calling conventions are nasty here */
600 error = table->proc_handler(table, write, kbuf, &count, &iocb->ki_pos);
606 if (copy_to_iter(kbuf, count, iter) < count)
614 sysctl_head_finish(head);
619 static ssize_t proc_sys_read(struct kiocb *iocb, struct iov_iter *iter)
621 return proc_sys_call_handler(iocb, iter, 0);
624 static ssize_t proc_sys_write(struct kiocb *iocb, struct iov_iter *iter)
626 return proc_sys_call_handler(iocb, iter, 1);
629 static int proc_sys_open(struct inode *inode, struct file *filp)
631 struct ctl_table_header *head = grab_header(inode);
632 struct ctl_table *table = PROC_I(inode)->sysctl_entry;
634 /* sysctl was unregistered */
636 return PTR_ERR(head);
639 filp->private_data = proc_sys_poll_event(table->poll);
641 sysctl_head_finish(head);
646 static __poll_t proc_sys_poll(struct file *filp, poll_table *wait)
648 struct inode *inode = file_inode(filp);
649 struct ctl_table_header *head = grab_header(inode);
650 struct ctl_table *table = PROC_I(inode)->sysctl_entry;
651 __poll_t ret = DEFAULT_POLLMASK;
654 /* sysctl was unregistered */
656 return EPOLLERR | EPOLLHUP;
658 if (!table->proc_handler)
664 event = (unsigned long)filp->private_data;
665 poll_wait(filp, &table->poll->wait, wait);
667 if (event != atomic_read(&table->poll->event)) {
668 filp->private_data = proc_sys_poll_event(table->poll);
669 ret = EPOLLIN | EPOLLRDNORM | EPOLLERR | EPOLLPRI;
673 sysctl_head_finish(head);
678 static bool proc_sys_fill_cache(struct file *file,
679 struct dir_context *ctx,
680 struct ctl_table_header *head,
681 struct ctl_table *table)
683 struct dentry *child, *dir = file->f_path.dentry;
687 unsigned type = DT_UNKNOWN;
689 qname.name = table->procname;
690 qname.len = strlen(table->procname);
691 qname.hash = full_name_hash(dir, qname.name, qname.len);
693 child = d_lookup(dir, &qname);
695 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
696 child = d_alloc_parallel(dir, &qname, &wq);
699 if (d_in_lookup(child)) {
701 inode = proc_sys_make_inode(dir->d_sb, head, table);
703 d_lookup_done(child);
707 d_set_d_op(child, &proc_sys_dentry_operations);
708 res = d_splice_alias(inode, child);
709 d_lookup_done(child);
720 inode = d_inode(child);
722 type = inode->i_mode >> 12;
724 return dir_emit(ctx, qname.name, qname.len, ino, type);
727 static bool proc_sys_link_fill_cache(struct file *file,
728 struct dir_context *ctx,
729 struct ctl_table_header *head,
730 struct ctl_table *table)
734 head = sysctl_head_grab(head);
738 /* It is not an error if we can not follow the link ignore it */
739 if (sysctl_follow_link(&head, &table))
742 ret = proc_sys_fill_cache(file, ctx, head, table);
744 sysctl_head_finish(head);
748 static int scan(struct ctl_table_header *head, struct ctl_table *table,
749 unsigned long *pos, struct file *file,
750 struct dir_context *ctx)
754 if ((*pos)++ < ctx->pos)
757 if (unlikely(S_ISLNK(table->mode)))
758 res = proc_sys_link_fill_cache(file, ctx, head, table);
760 res = proc_sys_fill_cache(file, ctx, head, table);
768 static int proc_sys_readdir(struct file *file, struct dir_context *ctx)
770 struct ctl_table_header *head = grab_header(file_inode(file));
771 struct ctl_table_header *h = NULL;
772 struct ctl_table *entry;
773 struct ctl_dir *ctl_dir;
777 return PTR_ERR(head);
779 ctl_dir = container_of(head, struct ctl_dir, header);
781 if (!dir_emit_dots(file, ctx))
786 for (first_entry(ctl_dir, &h, &entry); h; next_entry(&h, &entry)) {
787 if (!scan(h, entry, &pos, file, ctx)) {
788 sysctl_head_finish(h);
793 sysctl_head_finish(head);
797 static int proc_sys_permission(struct mnt_idmap *idmap,
798 struct inode *inode, int mask)
801 * sysctl entries that are not writeable,
802 * are _NOT_ writeable, capabilities or not.
804 struct ctl_table_header *head;
805 struct ctl_table *table;
808 /* Executable files are not allowed under /proc/sys/ */
809 if ((mask & MAY_EXEC) && S_ISREG(inode->i_mode))
812 head = grab_header(inode);
814 return PTR_ERR(head);
816 table = PROC_I(inode)->sysctl_entry;
817 if (!table) /* global root - r-xr-xr-x */
818 error = mask & MAY_WRITE ? -EACCES : 0;
819 else /* Use the permissions on the sysctl table entry */
820 error = sysctl_perm(head, table, mask & ~MAY_NOT_BLOCK);
822 sysctl_head_finish(head);
826 static int proc_sys_setattr(struct mnt_idmap *idmap,
827 struct dentry *dentry, struct iattr *attr)
829 struct inode *inode = d_inode(dentry);
832 if (attr->ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID))
835 error = setattr_prepare(&nop_mnt_idmap, dentry, attr);
839 setattr_copy(&nop_mnt_idmap, inode, attr);
843 static int proc_sys_getattr(struct mnt_idmap *idmap,
844 const struct path *path, struct kstat *stat,
845 u32 request_mask, unsigned int query_flags)
847 struct inode *inode = d_inode(path->dentry);
848 struct ctl_table_header *head = grab_header(inode);
849 struct ctl_table *table = PROC_I(inode)->sysctl_entry;
852 return PTR_ERR(head);
854 generic_fillattr(&nop_mnt_idmap, request_mask, inode, stat);
856 stat->mode = (stat->mode & S_IFMT) | table->mode;
858 sysctl_head_finish(head);
862 static const struct file_operations proc_sys_file_operations = {
863 .open = proc_sys_open,
864 .poll = proc_sys_poll,
865 .read_iter = proc_sys_read,
866 .write_iter = proc_sys_write,
867 .splice_read = copy_splice_read,
868 .splice_write = iter_file_splice_write,
869 .llseek = default_llseek,
872 static const struct file_operations proc_sys_dir_file_operations = {
873 .read = generic_read_dir,
874 .iterate_shared = proc_sys_readdir,
875 .llseek = generic_file_llseek,
878 static const struct inode_operations proc_sys_inode_operations = {
879 .permission = proc_sys_permission,
880 .setattr = proc_sys_setattr,
881 .getattr = proc_sys_getattr,
884 static const struct inode_operations proc_sys_dir_operations = {
885 .lookup = proc_sys_lookup,
886 .permission = proc_sys_permission,
887 .setattr = proc_sys_setattr,
888 .getattr = proc_sys_getattr,
891 static int proc_sys_revalidate(struct dentry *dentry, unsigned int flags)
893 if (flags & LOOKUP_RCU)
895 return !PROC_I(d_inode(dentry))->sysctl->unregistering;
898 static int proc_sys_delete(const struct dentry *dentry)
900 return !!PROC_I(d_inode(dentry))->sysctl->unregistering;
903 static int sysctl_is_seen(struct ctl_table_header *p)
905 struct ctl_table_set *set = p->set;
907 spin_lock(&sysctl_lock);
908 if (p->unregistering)
910 else if (!set->is_seen)
913 res = set->is_seen(set);
914 spin_unlock(&sysctl_lock);
918 static int proc_sys_compare(const struct dentry *dentry,
919 unsigned int len, const char *str, const struct qstr *name)
921 struct ctl_table_header *head;
924 /* Although proc doesn't have negative dentries, rcu-walk means
925 * that inode here can be NULL */
926 /* AV: can it, indeed? */
927 inode = d_inode_rcu(dentry);
930 if (name->len != len)
932 if (memcmp(name->name, str, len))
934 head = rcu_dereference(PROC_I(inode)->sysctl);
935 return !head || !sysctl_is_seen(head);
938 static const struct dentry_operations proc_sys_dentry_operations = {
939 .d_revalidate = proc_sys_revalidate,
940 .d_delete = proc_sys_delete,
941 .d_compare = proc_sys_compare,
944 static struct ctl_dir *find_subdir(struct ctl_dir *dir,
945 const char *name, int namelen)
947 struct ctl_table_header *head;
948 struct ctl_table *entry;
950 entry = find_entry(&head, dir, name, namelen);
952 return ERR_PTR(-ENOENT);
953 if (!S_ISDIR(entry->mode))
954 return ERR_PTR(-ENOTDIR);
955 return container_of(head, struct ctl_dir, header);
958 static struct ctl_dir *new_dir(struct ctl_table_set *set,
959 const char *name, int namelen)
961 struct ctl_table *table;
963 struct ctl_node *node;
966 new = kzalloc(sizeof(*new) + sizeof(struct ctl_node) +
967 sizeof(struct ctl_table)*2 + namelen + 1,
972 node = (struct ctl_node *)(new + 1);
973 table = (struct ctl_table *)(node + 1);
974 new_name = (char *)(table + 2);
975 memcpy(new_name, name, namelen);
976 table[0].procname = new_name;
977 table[0].mode = S_IFDIR|S_IRUGO|S_IXUGO;
978 init_header(&new->header, set->dir.header.root, set, node, table, 1);
984 * get_subdir - find or create a subdir with the specified name.
985 * @dir: Directory to create the subdirectory in
986 * @name: The name of the subdirectory to find or create
987 * @namelen: The length of name
989 * Takes a directory with an elevated reference count so we know that
990 * if we drop the lock the directory will not go away. Upon success
991 * the reference is moved from @dir to the returned subdirectory.
992 * Upon error an error code is returned and the reference on @dir is
995 static struct ctl_dir *get_subdir(struct ctl_dir *dir,
996 const char *name, int namelen)
998 struct ctl_table_set *set = dir->header.set;
999 struct ctl_dir *subdir, *new = NULL;
1002 spin_lock(&sysctl_lock);
1003 subdir = find_subdir(dir, name, namelen);
1004 if (!IS_ERR(subdir))
1006 if (PTR_ERR(subdir) != -ENOENT)
1009 spin_unlock(&sysctl_lock);
1010 new = new_dir(set, name, namelen);
1011 spin_lock(&sysctl_lock);
1012 subdir = ERR_PTR(-ENOMEM);
1016 /* Was the subdir added while we dropped the lock? */
1017 subdir = find_subdir(dir, name, namelen);
1018 if (!IS_ERR(subdir))
1020 if (PTR_ERR(subdir) != -ENOENT)
1023 /* Nope. Use the our freshly made directory entry. */
1024 err = insert_header(dir, &new->header);
1025 subdir = ERR_PTR(err);
1030 subdir->header.nreg++;
1032 if (IS_ERR(subdir)) {
1033 pr_err("sysctl could not get directory: ");
1034 sysctl_print_dir(dir);
1035 pr_cont("%*.*s %ld\n", namelen, namelen, name,
1038 drop_sysctl_table(&dir->header);
1040 drop_sysctl_table(&new->header);
1041 spin_unlock(&sysctl_lock);
1045 static struct ctl_dir *xlate_dir(struct ctl_table_set *set, struct ctl_dir *dir)
1047 struct ctl_dir *parent;
1048 const char *procname;
1049 if (!dir->header.parent)
1051 parent = xlate_dir(set, dir->header.parent);
1054 procname = dir->header.ctl_table[0].procname;
1055 return find_subdir(parent, procname, strlen(procname));
1058 static int sysctl_follow_link(struct ctl_table_header **phead,
1059 struct ctl_table **pentry)
1061 struct ctl_table_header *head;
1062 struct ctl_table_root *root;
1063 struct ctl_table_set *set;
1064 struct ctl_table *entry;
1065 struct ctl_dir *dir;
1068 spin_lock(&sysctl_lock);
1069 root = (*pentry)->data;
1070 set = lookup_header_set(root);
1071 dir = xlate_dir(set, (*phead)->parent);
1075 const char *procname = (*pentry)->procname;
1077 entry = find_entry(&head, dir, procname, strlen(procname));
1079 if (entry && use_table(head)) {
1080 unuse_table(*phead);
1087 spin_unlock(&sysctl_lock);
1091 static int sysctl_err(const char *path, struct ctl_table *table, char *fmt, ...)
1093 struct va_format vaf;
1096 va_start(args, fmt);
1100 pr_err("sysctl table check failed: %s/%s %pV\n",
1101 path, table->procname, &vaf);
1107 static int sysctl_check_table_array(const char *path, struct ctl_table *table)
1111 if ((table->proc_handler == proc_douintvec) ||
1112 (table->proc_handler == proc_douintvec_minmax)) {
1113 if (table->maxlen != sizeof(unsigned int))
1114 err |= sysctl_err(path, table, "array not allowed");
1117 if (table->proc_handler == proc_dou8vec_minmax) {
1118 if (table->maxlen != sizeof(u8))
1119 err |= sysctl_err(path, table, "array not allowed");
1122 if (table->proc_handler == proc_dobool) {
1123 if (table->maxlen != sizeof(bool))
1124 err |= sysctl_err(path, table, "array not allowed");
1130 static int sysctl_check_table(const char *path, struct ctl_table_header *header)
1132 struct ctl_table *entry;
1134 list_for_each_table_entry(entry, header) {
1135 if ((entry->proc_handler == proc_dostring) ||
1136 (entry->proc_handler == proc_dobool) ||
1137 (entry->proc_handler == proc_dointvec) ||
1138 (entry->proc_handler == proc_douintvec) ||
1139 (entry->proc_handler == proc_douintvec_minmax) ||
1140 (entry->proc_handler == proc_dointvec_minmax) ||
1141 (entry->proc_handler == proc_dou8vec_minmax) ||
1142 (entry->proc_handler == proc_dointvec_jiffies) ||
1143 (entry->proc_handler == proc_dointvec_userhz_jiffies) ||
1144 (entry->proc_handler == proc_dointvec_ms_jiffies) ||
1145 (entry->proc_handler == proc_doulongvec_minmax) ||
1146 (entry->proc_handler == proc_doulongvec_ms_jiffies_minmax)) {
1148 err |= sysctl_err(path, entry, "No data");
1150 err |= sysctl_err(path, entry, "No maxlen");
1152 err |= sysctl_check_table_array(path, entry);
1154 if (!entry->proc_handler)
1155 err |= sysctl_err(path, entry, "No proc_handler");
1157 if ((entry->mode & (S_IRUGO|S_IWUGO)) != entry->mode)
1158 err |= sysctl_err(path, entry, "bogus .mode 0%o",
1164 static struct ctl_table_header *new_links(struct ctl_dir *dir, struct ctl_table_header *head)
1166 struct ctl_table *link_table, *entry, *link;
1167 struct ctl_table_header *links;
1168 struct ctl_node *node;
1170 int nr_entries, name_bytes;
1174 list_for_each_table_entry(entry, head) {
1176 name_bytes += strlen(entry->procname) + 1;
1179 links = kzalloc(sizeof(struct ctl_table_header) +
1180 sizeof(struct ctl_node)*nr_entries +
1181 sizeof(struct ctl_table)*(nr_entries + 1) +
1188 node = (struct ctl_node *)(links + 1);
1189 link_table = (struct ctl_table *)(node + nr_entries);
1190 link_name = (char *)&link_table[nr_entries + 1];
1193 list_for_each_table_entry(entry, head) {
1194 int len = strlen(entry->procname) + 1;
1195 memcpy(link_name, entry->procname, len);
1196 link->procname = link_name;
1197 link->mode = S_IFLNK|S_IRWXUGO;
1198 link->data = head->root;
1202 init_header(links, dir->header.root, dir->header.set, node, link_table,
1203 head->ctl_table_size);
1204 links->nreg = nr_entries;
1209 static bool get_links(struct ctl_dir *dir,
1210 struct ctl_table_header *header,
1211 struct ctl_table_root *link_root)
1213 struct ctl_table_header *tmp_head;
1214 struct ctl_table *entry, *link;
1216 /* Are there links available for every entry in table? */
1217 list_for_each_table_entry(entry, header) {
1218 const char *procname = entry->procname;
1219 link = find_entry(&tmp_head, dir, procname, strlen(procname));
1222 if (S_ISDIR(link->mode) && S_ISDIR(entry->mode))
1224 if (S_ISLNK(link->mode) && (link->data == link_root))
1229 /* The checks passed. Increase the registration count on the links */
1230 list_for_each_table_entry(entry, header) {
1231 const char *procname = entry->procname;
1232 link = find_entry(&tmp_head, dir, procname, strlen(procname));
1238 static int insert_links(struct ctl_table_header *head)
1240 struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1241 struct ctl_dir *core_parent;
1242 struct ctl_table_header *links;
1245 if (head->set == root_set)
1248 core_parent = xlate_dir(root_set, head->parent);
1249 if (IS_ERR(core_parent))
1252 if (get_links(core_parent, head, head->root))
1255 core_parent->header.nreg++;
1256 spin_unlock(&sysctl_lock);
1258 links = new_links(core_parent, head);
1260 spin_lock(&sysctl_lock);
1266 if (get_links(core_parent, head, head->root)) {
1271 err = insert_header(core_parent, links);
1275 drop_sysctl_table(&core_parent->header);
1279 /* Find the directory for the ctl_table. If one is not found create it. */
1280 static struct ctl_dir *sysctl_mkdir_p(struct ctl_dir *dir, const char *path)
1282 const char *name, *nextname;
1284 for (name = path; name; name = nextname) {
1286 nextname = strchr(name, '/');
1288 namelen = nextname - name;
1291 namelen = strlen(name);
1297 * namelen ensures if name is "foo/bar/yay" only foo is
1298 * registered first. We traverse as if using mkdir -p and
1299 * return a ctl_dir for the last directory entry.
1301 dir = get_subdir(dir, name, namelen);
1309 * __register_sysctl_table - register a leaf sysctl table
1310 * @set: Sysctl tree to register on
1311 * @path: The path to the directory the sysctl table is in.
1312 * @table: the top-level table structure without any child. This table
1313 * should not be free'd after registration. So it should not be
1314 * used on stack. It can either be a global or dynamically allocated
1315 * by the caller and free'd later after sysctl unregistration.
1316 * @table_size : The number of elements in table
1318 * Register a sysctl table hierarchy. @table should be a filled in ctl_table
1319 * array. A completely 0 filled entry terminates the table.
1321 * The members of the &struct ctl_table structure are used as follows:
1323 * procname - the name of the sysctl file under /proc/sys. Set to %NULL to not
1324 * enter a sysctl file
1326 * data - a pointer to data for use by proc_handler
1328 * maxlen - the maximum size in bytes of the data
1330 * mode - the file permissions for the /proc/sys file
1332 * child - must be %NULL.
1334 * proc_handler - the text handler routine (described below)
1336 * extra1, extra2 - extra pointers usable by the proc handler routines
1337 * XXX: we should eventually modify these to use long min / max [0]
1338 * [0] https://lkml.kernel.org/87zgpte9o4.fsf@email.froward.int.ebiederm.org
1340 * Leaf nodes in the sysctl tree will be represented by a single file
1341 * under /proc; non-leaf nodes (where child is not NULL) are not allowed,
1342 * sysctl_check_table() verifies this.
1344 * There must be a proc_handler routine for any terminal nodes.
1345 * Several default handlers are available to cover common cases -
1347 * proc_dostring(), proc_dointvec(), proc_dointvec_jiffies(),
1348 * proc_dointvec_userhz_jiffies(), proc_dointvec_minmax(),
1349 * proc_doulongvec_ms_jiffies_minmax(), proc_doulongvec_minmax()
1351 * It is the handler's job to read the input buffer from user memory
1352 * and process it. The handler should return 0 on success.
1354 * This routine returns %NULL on a failure to register, and a pointer
1355 * to the table header on success.
1357 struct ctl_table_header *__register_sysctl_table(
1358 struct ctl_table_set *set,
1359 const char *path, struct ctl_table *table, size_t table_size)
1361 struct ctl_table_root *root = set->dir.header.root;
1362 struct ctl_table_header *header;
1363 struct ctl_dir *dir;
1364 struct ctl_node *node;
1366 header = kzalloc(sizeof(struct ctl_table_header) +
1367 sizeof(struct ctl_node)*table_size, GFP_KERNEL_ACCOUNT);
1371 node = (struct ctl_node *)(header + 1);
1372 init_header(header, root, set, node, table, table_size);
1373 if (sysctl_check_table(path, header))
1376 spin_lock(&sysctl_lock);
1378 /* Reference moved down the directory tree get_subdir */
1380 spin_unlock(&sysctl_lock);
1382 dir = sysctl_mkdir_p(dir, path);
1385 spin_lock(&sysctl_lock);
1386 if (insert_header(dir, header))
1387 goto fail_put_dir_locked;
1389 drop_sysctl_table(&dir->header);
1390 spin_unlock(&sysctl_lock);
1394 fail_put_dir_locked:
1395 drop_sysctl_table(&dir->header);
1396 spin_unlock(&sysctl_lock);
1403 * register_sysctl_sz - register a sysctl table
1404 * @path: The path to the directory the sysctl table is in. If the path
1405 * doesn't exist we will create it for you.
1406 * @table: the table structure. The calller must ensure the life of the @table
1407 * will be kept during the lifetime use of the syctl. It must not be freed
1408 * until unregister_sysctl_table() is called with the given returned table
1409 * with this registration. If your code is non modular then you don't need
1410 * to call unregister_sysctl_table() and can instead use something like
1411 * register_sysctl_init() which does not care for the result of the syctl
1413 * @table_size: The number of elements in table.
1415 * Register a sysctl table. @table should be a filled in ctl_table
1416 * array. A completely 0 filled entry terminates the table.
1418 * See __register_sysctl_table for more details.
1420 struct ctl_table_header *register_sysctl_sz(const char *path, struct ctl_table *table,
1423 return __register_sysctl_table(&sysctl_table_root.default_set,
1424 path, table, table_size);
1426 EXPORT_SYMBOL(register_sysctl_sz);
1429 * __register_sysctl_init() - register sysctl table to path
1430 * @path: path name for sysctl base. If that path doesn't exist we will create
1432 * @table: This is the sysctl table that needs to be registered to the path.
1433 * The caller must ensure the life of the @table will be kept during the
1434 * lifetime use of the sysctl.
1435 * @table_name: The name of sysctl table, only used for log printing when
1436 * registration fails
1437 * @table_size: The number of elements in table
1439 * The sysctl interface is used by userspace to query or modify at runtime
1440 * a predefined value set on a variable. These variables however have default
1441 * values pre-set. Code which depends on these variables will always work even
1442 * if register_sysctl() fails. If register_sysctl() fails you'd just loose the
1443 * ability to query or modify the sysctls dynamically at run time. Chances of
1444 * register_sysctl() failing on init are extremely low, and so for both reasons
1445 * this function does not return any error as it is used by initialization code.
1447 * Context: if your base directory does not exist it will be created for you.
1449 void __init __register_sysctl_init(const char *path, struct ctl_table *table,
1450 const char *table_name, size_t table_size)
1452 struct ctl_table_header *hdr = register_sysctl_sz(path, table, table_size);
1454 if (unlikely(!hdr)) {
1455 pr_err("failed when register_sysctl_sz %s to %s\n", table_name, path);
1458 kmemleak_not_leak(hdr);
1461 static void put_links(struct ctl_table_header *header)
1463 struct ctl_table_set *root_set = &sysctl_table_root.default_set;
1464 struct ctl_table_root *root = header->root;
1465 struct ctl_dir *parent = header->parent;
1466 struct ctl_dir *core_parent;
1467 struct ctl_table *entry;
1469 if (header->set == root_set)
1472 core_parent = xlate_dir(root_set, parent);
1473 if (IS_ERR(core_parent))
1476 list_for_each_table_entry(entry, header) {
1477 struct ctl_table_header *link_head;
1478 struct ctl_table *link;
1479 const char *name = entry->procname;
1481 link = find_entry(&link_head, core_parent, name, strlen(name));
1483 ((S_ISDIR(link->mode) && S_ISDIR(entry->mode)) ||
1484 (S_ISLNK(link->mode) && (link->data == root)))) {
1485 drop_sysctl_table(link_head);
1488 pr_err("sysctl link missing during unregister: ");
1489 sysctl_print_dir(parent);
1490 pr_cont("%s\n", name);
1495 static void drop_sysctl_table(struct ctl_table_header *header)
1497 struct ctl_dir *parent = header->parent;
1504 start_unregistering(header);
1507 if (!--header->count)
1508 kfree_rcu(header, rcu);
1511 drop_sysctl_table(&parent->header);
1515 * unregister_sysctl_table - unregister a sysctl table hierarchy
1516 * @header: the header returned from register_sysctl or __register_sysctl_table
1518 * Unregisters the sysctl table and all children. proc entries may not
1519 * actually be removed until they are no longer used by anyone.
1521 void unregister_sysctl_table(struct ctl_table_header * header)
1528 spin_lock(&sysctl_lock);
1529 drop_sysctl_table(header);
1530 spin_unlock(&sysctl_lock);
1532 EXPORT_SYMBOL(unregister_sysctl_table);
1534 void setup_sysctl_set(struct ctl_table_set *set,
1535 struct ctl_table_root *root,
1536 int (*is_seen)(struct ctl_table_set *))
1538 memset(set, 0, sizeof(*set));
1539 set->is_seen = is_seen;
1540 init_header(&set->dir.header, root, set, NULL, root_table, 1);
1543 void retire_sysctl_set(struct ctl_table_set *set)
1545 WARN_ON(!RB_EMPTY_ROOT(&set->dir.root));
1548 int __init proc_sys_init(void)
1550 struct proc_dir_entry *proc_sys_root;
1552 proc_sys_root = proc_mkdir("sys", NULL);
1553 proc_sys_root->proc_iops = &proc_sys_dir_operations;
1554 proc_sys_root->proc_dir_ops = &proc_sys_dir_file_operations;
1555 proc_sys_root->nlink = 0;
1557 return sysctl_init_bases();
1560 struct sysctl_alias {
1561 const char *kernel_param;
1562 const char *sysctl_param;
1566 * Historically some settings had both sysctl and a command line parameter.
1567 * With the generic sysctl. parameter support, we can handle them at a single
1568 * place and only keep the historical name for compatibility. This is not meant
1569 * to add brand new aliases. When adding existing aliases, consider whether
1570 * the possibly different moment of changing the value (e.g. from early_param
1571 * to the moment do_sysctl_args() is called) is an issue for the specific
1574 static const struct sysctl_alias sysctl_aliases[] = {
1575 {"hardlockup_all_cpu_backtrace", "kernel.hardlockup_all_cpu_backtrace" },
1576 {"hung_task_panic", "kernel.hung_task_panic" },
1577 {"numa_zonelist_order", "vm.numa_zonelist_order" },
1578 {"softlockup_all_cpu_backtrace", "kernel.softlockup_all_cpu_backtrace" },
1579 {"softlockup_panic", "kernel.softlockup_panic" },
1583 static const char *sysctl_find_alias(char *param)
1585 const struct sysctl_alias *alias;
1587 for (alias = &sysctl_aliases[0]; alias->kernel_param != NULL; alias++) {
1588 if (strcmp(alias->kernel_param, param) == 0)
1589 return alias->sysctl_param;
1595 /* Set sysctl value passed on kernel command line. */
1596 static int process_sysctl_arg(char *param, char *val,
1597 const char *unused, void *arg)
1600 struct vfsmount **proc_mnt = arg;
1601 struct file_system_type *proc_fs_type;
1608 if (strncmp(param, "sysctl", sizeof("sysctl") - 1) == 0) {
1609 param += sizeof("sysctl") - 1;
1611 if (param[0] != '/' && param[0] != '.')
1616 param = (char *) sysctl_find_alias(param);
1628 * To set sysctl options, we use a temporary mount of proc, look up the
1629 * respective sys/ file and write to it. To avoid mounting it when no
1630 * options were given, we mount it only when the first sysctl option is
1631 * found. Why not a persistent mount? There are problems with a
1632 * persistent mount of proc in that it forces userspace not to use any
1633 * proc mount options.
1636 proc_fs_type = get_fs_type("proc");
1637 if (!proc_fs_type) {
1638 pr_err("Failed to find procfs to set sysctl from command line\n");
1641 *proc_mnt = kern_mount(proc_fs_type);
1642 put_filesystem(proc_fs_type);
1643 if (IS_ERR(*proc_mnt)) {
1644 pr_err("Failed to mount procfs to set sysctl from command line\n");
1649 path = kasprintf(GFP_KERNEL, "sys/%s", param);
1651 panic("%s: Failed to allocate path for %s\n", __func__, param);
1652 strreplace(path, '.', '/');
1654 file = file_open_root_mnt(*proc_mnt, path, O_WRONLY, 0);
1656 err = PTR_ERR(file);
1658 pr_err("Failed to set sysctl parameter '%s=%s': parameter not found\n",
1660 else if (err == -EACCES)
1661 pr_err("Failed to set sysctl parameter '%s=%s': permission denied (read-only?)\n",
1664 pr_err("Error %pe opening proc file to set sysctl parameter '%s=%s'\n",
1668 wret = kernel_write(file, val, len, &pos);
1672 pr_err("Failed to set sysctl parameter '%s=%s': invalid value\n",
1675 pr_err("Error %pe writing to proc file to set sysctl parameter '%s=%s'\n",
1676 ERR_PTR(err), param, val);
1677 } else if (wret != len) {
1678 pr_err("Wrote only %zd bytes of %d writing to proc file %s to set sysctl parameter '%s=%s\n",
1679 wret, len, path, param, val);
1682 err = filp_close(file, NULL);
1684 pr_err("Error %pe closing proc file to set sysctl parameter '%s=%s\n",
1685 ERR_PTR(err), param, val);
1691 void do_sysctl_args(void)
1694 struct vfsmount *proc_mnt = NULL;
1696 command_line = kstrdup(saved_command_line, GFP_KERNEL);
1698 panic("%s: Failed to allocate copy of command line\n", __func__);
1700 parse_args("Setting sysctl args", command_line,
1701 NULL, 0, -1, -1, &proc_mnt, process_sysctl_arg);
1704 kern_unmount(proc_mnt);
1706 kfree(command_line);