fs/proc/proc_sysctl.c

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