fs/proc/inode.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  linux/fs/proc/inode.c
   4  *
   5  *  Copyright (C) 1991, 1992  Linus Torvalds
   6  */
   7
   8 #include <linux/cache.h>
   9 #include <linux/time.h>
  10 #include <linux/proc_fs.h>
  11 #include <linux/kernel.h>
  12 #include <linux/pid_namespace.h>
  13 #include <linux/mm.h>
  14 #include <linux/string.h>
  15 #include <linux/stat.h>
  16 #include <linux/completion.h>
  17 #include <linux/poll.h>
  18 #include <linux/printk.h>
  19 #include <linux/file.h>
  20 #include <linux/limits.h>
  21 #include <linux/init.h>
  22 #include <linux/module.h>
  23 #include <linux/sysctl.h>
  24 #include <linux/seq_file.h>
  25 #include <linux/slab.h>
  26 #include <linux/mount.h>
  27
  28 #include <linux/uaccess.h>
  29
  30 #include "internal.h"
  31
  32 static void proc_evict_inode(struct inode *inode)
  33 {
  34         struct proc_dir_entry *de;
  35         struct ctl_table_header *head;
  36         struct proc_inode *ei = PROC_I(inode);
  37
  38         truncate_inode_pages_final(&inode->i_data);
  39         clear_inode(inode);
  40
  41         /* Stop tracking associated processes */
  42         if (ei->pid) {
  43                 proc_pid_evict_inode(ei);
  44                 ei->pid = NULL;
  45         }
  46
  47         /* Let go of any associated proc directory entry */
  48         de = ei->pde;
  49         if (de) {
  50                 pde_put(de);
  51                 ei->pde = NULL;
  52         }
  53
  54         head = ei->sysctl;
  55         if (head) {
  56                 RCU_INIT_POINTER(ei->sysctl, NULL);
  57                 proc_sys_evict_inode(inode, head);
  58         }
  59 }
  60
  61 static struct kmem_cache *proc_inode_cachep __ro_after_init;
  62 static struct kmem_cache *pde_opener_cache __ro_after_init;
  63
  64 static struct inode *proc_alloc_inode(struct super_block *sb)
  65 {
  66         struct proc_inode *ei;
  67
  68         ei = kmem_cache_alloc(proc_inode_cachep, GFP_KERNEL);
  69         if (!ei)
  70                 return NULL;
  71         ei->pid = NULL;
  72         ei->fd = 0;
  73         ei->op.proc_get_link = NULL;
  74         ei->pde = NULL;
  75         ei->sysctl = NULL;
  76         ei->sysctl_entry = NULL;
  77         INIT_HLIST_NODE(&ei->sibling_inodes);
  78         ei->ns_ops = NULL;
  79         return &ei->vfs_inode;
  80 }
  81
  82 static void proc_free_inode(struct inode *inode)
  83 {
  84         kmem_cache_free(proc_inode_cachep, PROC_I(inode));
  85 }
  86
  87 static void init_once(void *foo)
  88 {
  89         struct proc_inode *ei = (struct proc_inode *) foo;
  90
  91         inode_init_once(&ei->vfs_inode);
  92 }
  93
  94 void __init proc_init_kmemcache(void)
  95 {
  96         proc_inode_cachep = kmem_cache_create("proc_inode_cache",
  97                                              sizeof(struct proc_inode),
  98                                              0, (SLAB_RECLAIM_ACCOUNT|
  99                                                 SLAB_MEM_SPREAD|SLAB_ACCOUNT|
 100                                                 SLAB_PANIC),
 101                                              init_once);
 102         pde_opener_cache =
 103                 kmem_cache_create("pde_opener", sizeof(struct pde_opener), 0,
 104                                   SLAB_ACCOUNT|SLAB_PANIC, NULL);
 105         proc_dir_entry_cache = kmem_cache_create_usercopy(
 106                 "proc_dir_entry", SIZEOF_PDE, 0, SLAB_PANIC,
 107                 offsetof(struct proc_dir_entry, inline_name),
 108                 SIZEOF_PDE_INLINE_NAME, NULL);
 109         BUILD_BUG_ON(sizeof(struct proc_dir_entry) >= SIZEOF_PDE);
 110 }
 111
 112 void proc_invalidate_siblings_dcache(struct hlist_head *inodes, spinlock_t *lock)
 113 {
 114         struct inode *inode;
 115         struct proc_inode *ei;
 116         struct hlist_node *node;
 117         struct super_block *old_sb = NULL;
 118
 119         rcu_read_lock();
 120         for (;;) {
 121                 struct super_block *sb;
 122                 node = hlist_first_rcu(inodes);
 123                 if (!node)
 124                         break;
 125                 ei = hlist_entry(node, struct proc_inode, sibling_inodes);
 126                 spin_lock(lock);
 127                 hlist_del_init_rcu(&ei->sibling_inodes);
 128                 spin_unlock(lock);
 129
 130                 inode = &ei->vfs_inode;
 131                 sb = inode->i_sb;
 132                 if ((sb != old_sb) && !atomic_inc_not_zero(&sb->s_active))
 133                         continue;
 134                 inode = igrab(inode);
 135                 rcu_read_unlock();
 136                 if (sb != old_sb) {
 137                         if (old_sb)
 138                                 deactivate_super(old_sb);
 139                         old_sb = sb;
 140                 }
 141                 if (unlikely(!inode)) {
 142                         rcu_read_lock();
 143                         continue;
 144                 }
 145
 146                 if (S_ISDIR(inode->i_mode)) {
 147                         struct dentry *dir = d_find_any_alias(inode);
 148                         if (dir) {
 149                                 d_invalidate(dir);
 150                                 dput(dir);
 151                         }
 152                 } else {
 153                         struct dentry *dentry;
 154                         while ((dentry = d_find_alias(inode))) {
 155                                 d_invalidate(dentry);
 156                                 dput(dentry);
 157                         }
 158                 }
 159                 iput(inode);
 160
 161                 rcu_read_lock();
 162         }
 163         rcu_read_unlock();
 164         if (old_sb)
 165                 deactivate_super(old_sb);
 166 }
 167
 168 static int proc_show_options(struct seq_file *seq, struct dentry *root)
 169 {
 170         struct proc_fs_info *fs_info = proc_sb_info(root->d_sb);
 171
 172         if (!gid_eq(fs_info->pid_gid, GLOBAL_ROOT_GID))
 173                 seq_printf(seq, ",gid=%u", from_kgid_munged(&init_user_ns, fs_info->pid_gid));
 174         if (fs_info->hide_pid != HIDEPID_OFF)
 175                 seq_printf(seq, ",hidepid=%u", fs_info->hide_pid);
 176
 177         return 0;
 178 }
 179
 180 const struct super_operations proc_sops = {
 181         .alloc_inode    = proc_alloc_inode,
 182         .free_inode     = proc_free_inode,
 183         .drop_inode     = generic_delete_inode,
 184         .evict_inode    = proc_evict_inode,
 185         .statfs         = simple_statfs,
 186         .show_options   = proc_show_options,
 187 };
 188
 189 enum {BIAS = -1U<<31};
 190
 191 static inline int use_pde(struct proc_dir_entry *pde)
 192 {
 193         return likely(atomic_inc_unless_negative(&pde->in_use));
 194 }
 195
 196 static void unuse_pde(struct proc_dir_entry *pde)
 197 {
 198         if (unlikely(atomic_dec_return(&pde->in_use) == BIAS))
 199                 complete(pde->pde_unload_completion);
 200 }
 201
 202 /* pde is locked on entry, unlocked on exit */
 203 static void close_pdeo(struct proc_dir_entry *pde, struct pde_opener *pdeo)
 204         __releases(&pde->pde_unload_lock)
 205 {
 206         /*
 207          * close() (proc_reg_release()) can't delete an entry and proceed:
 208          * ->release hook needs to be available at the right moment.
 209          *
 210          * rmmod (remove_proc_entry() et al) can't delete an entry and proceed:
 211          * "struct file" needs to be available at the right moment.
 212          *
 213          * Therefore, first process to enter this function does ->release() and
 214          * signals its completion to the other process which does nothing.
 215          */
 216         if (pdeo->closing) {
 217                 /* somebody else is doing that, just wait */
 218                 DECLARE_COMPLETION_ONSTACK(c);
 219                 pdeo->c = &c;
 220                 spin_unlock(&pde->pde_unload_lock);
 221                 wait_for_completion(&c);
 222         } else {
 223                 struct file *file;
 224                 struct completion *c;
 225
 226                 pdeo->closing = true;
 227                 spin_unlock(&pde->pde_unload_lock);
 228                 file = pdeo->file;
 229                 pde->proc_ops->proc_release(file_inode(file), file);
 230                 spin_lock(&pde->pde_unload_lock);
 231                 /* After ->release. */
 232                 list_del(&pdeo->lh);
 233                 c = pdeo->c;
 234                 spin_unlock(&pde->pde_unload_lock);
 235                 if (unlikely(c))
 236                         complete(c);
 237                 kmem_cache_free(pde_opener_cache, pdeo);
 238         }
 239 }
 240
 241 void proc_entry_rundown(struct proc_dir_entry *de)
 242 {
 243         DECLARE_COMPLETION_ONSTACK(c);
 244         /* Wait until all existing callers into module are done. */
 245         de->pde_unload_completion = &c;
 246         if (atomic_add_return(BIAS, &de->in_use) != BIAS)
 247                 wait_for_completion(&c);
 248
 249         /* ->pde_openers list can't grow from now on. */
 250
 251         spin_lock(&de->pde_unload_lock);
 252         while (!list_empty(&de->pde_openers)) {
 253                 struct pde_opener *pdeo;
 254                 pdeo = list_first_entry(&de->pde_openers, struct pde_opener, lh);
 255                 close_pdeo(de, pdeo);
 256                 spin_lock(&de->pde_unload_lock);
 257         }
 258         spin_unlock(&de->pde_unload_lock);
 259 }
 260
 261 static loff_t pde_lseek(struct proc_dir_entry *pde, struct file *file, loff_t offset, int whence)
 262 {
 263         typeof_member(struct proc_ops, proc_lseek) lseek;
 264
 265         lseek = pde->proc_ops->proc_lseek;
 266         if (!lseek)
 267                 lseek = default_llseek;
 268         return lseek(file, offset, whence);
 269 }
 270
 271 static loff_t proc_reg_llseek(struct file *file, loff_t offset, int whence)
 272 {
 273         struct proc_dir_entry *pde = PDE(file_inode(file));
 274         loff_t rv = -EINVAL;
 275
 276         if (pde_is_permanent(pde)) {
 277                 return pde_lseek(pde, file, offset, whence);
 278         } else if (use_pde(pde)) {
 279                 rv = pde_lseek(pde, file, offset, whence);
 280                 unuse_pde(pde);
 281         }
 282         return rv;
 283 }
 284
 285 static ssize_t pde_read(struct proc_dir_entry *pde, struct file *file, char __user *buf, size_t count, loff_t *ppos)
 286 {
 287         typeof_member(struct proc_ops, proc_read) read;
 288
 289         read = pde->proc_ops->proc_read;
 290         if (read)
 291                 return read(file, buf, count, ppos);
 292         return -EIO;
 293 }
 294
 295 static ssize_t proc_reg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 296 {
 297         struct proc_dir_entry *pde = PDE(file_inode(file));
 298         ssize_t rv = -EIO;
 299
 300         if (pde_is_permanent(pde)) {
 301                 return pde_read(pde, file, buf, count, ppos);
 302         } else if (use_pde(pde)) {
 303                 rv = pde_read(pde, file, buf, count, ppos);
 304                 unuse_pde(pde);
 305         }
 306         return rv;
 307 }
 308
 309 static ssize_t pde_write(struct proc_dir_entry *pde, struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 310 {
 311         typeof_member(struct proc_ops, proc_write) write;
 312
 313         write = pde->proc_ops->proc_write;
 314         if (write)
 315                 return write(file, buf, count, ppos);
 316         return -EIO;
 317 }
 318
 319 static ssize_t proc_reg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 320 {
 321         struct proc_dir_entry *pde = PDE(file_inode(file));
 322         ssize_t rv = -EIO;
 323
 324         if (pde_is_permanent(pde)) {
 325                 return pde_write(pde, file, buf, count, ppos);
 326         } else if (use_pde(pde)) {
 327                 rv = pde_write(pde, file, buf, count, ppos);
 328                 unuse_pde(pde);
 329         }
 330         return rv;
 331 }
 332
 333 static __poll_t pde_poll(struct proc_dir_entry *pde, struct file *file, struct poll_table_struct *pts)
 334 {
 335         typeof_member(struct proc_ops, proc_poll) poll;
 336
 337         poll = pde->proc_ops->proc_poll;
 338         if (poll)
 339                 return poll(file, pts);
 340         return DEFAULT_POLLMASK;
 341 }
 342
 343 static __poll_t proc_reg_poll(struct file *file, struct poll_table_struct *pts)
 344 {
 345         struct proc_dir_entry *pde = PDE(file_inode(file));
 346         __poll_t rv = DEFAULT_POLLMASK;
 347
 348         if (pde_is_permanent(pde)) {
 349                 return pde_poll(pde, file, pts);
 350         } else if (use_pde(pde)) {
 351                 rv = pde_poll(pde, file, pts);
 352                 unuse_pde(pde);
 353         }
 354         return rv;
 355 }
 356
 357 static long pde_ioctl(struct proc_dir_entry *pde, struct file *file, unsigned int cmd, unsigned long arg)
 358 {
 359         typeof_member(struct proc_ops, proc_ioctl) ioctl;
 360
 361         ioctl = pde->proc_ops->proc_ioctl;
 362         if (ioctl)
 363                 return ioctl(file, cmd, arg);
 364         return -ENOTTY;
 365 }
 366
 367 static long proc_reg_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 368 {
 369         struct proc_dir_entry *pde = PDE(file_inode(file));
 370         long rv = -ENOTTY;
 371
 372         if (pde_is_permanent(pde)) {
 373                 return pde_ioctl(pde, file, cmd, arg);
 374         } else if (use_pde(pde)) {
 375                 rv = pde_ioctl(pde, file, cmd, arg);
 376                 unuse_pde(pde);
 377         }
 378         return rv;
 379 }
 380
 381 #ifdef CONFIG_COMPAT
 382 static long pde_compat_ioctl(struct proc_dir_entry *pde, struct file *file, unsigned int cmd, unsigned long arg)
 383 {
 384         typeof_member(struct proc_ops, proc_compat_ioctl) compat_ioctl;
 385
 386         compat_ioctl = pde->proc_ops->proc_compat_ioctl;
 387         if (compat_ioctl)
 388                 return compat_ioctl(file, cmd, arg);
 389         return -ENOTTY;
 390 }
 391
 392 static long proc_reg_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 393 {
 394         struct proc_dir_entry *pde = PDE(file_inode(file));
 395         long rv = -ENOTTY;
 396         if (pde_is_permanent(pde)) {
 397                 return pde_compat_ioctl(pde, file, cmd, arg);
 398         } else if (use_pde(pde)) {
 399                 rv = pde_compat_ioctl(pde, file, cmd, arg);
 400                 unuse_pde(pde);
 401         }
 402         return rv;
 403 }
 404 #endif
 405
 406 static int pde_mmap(struct proc_dir_entry *pde, struct file *file, struct vm_area_struct *vma)
 407 {
 408         typeof_member(struct proc_ops, proc_mmap) mmap;
 409
 410         mmap = pde->proc_ops->proc_mmap;
 411         if (mmap)
 412                 return mmap(file, vma);
 413         return -EIO;
 414 }
 415
 416 static int proc_reg_mmap(struct file *file, struct vm_area_struct *vma)
 417 {
 418         struct proc_dir_entry *pde = PDE(file_inode(file));
 419         int rv = -EIO;
 420
 421         if (pde_is_permanent(pde)) {
 422                 return pde_mmap(pde, file, vma);
 423         } else if (use_pde(pde)) {
 424                 rv = pde_mmap(pde, file, vma);
 425                 unuse_pde(pde);
 426         }
 427         return rv;
 428 }
 429
 430 static unsigned long
 431 pde_get_unmapped_area(struct proc_dir_entry *pde, struct file *file, unsigned long orig_addr,
 432                            unsigned long len, unsigned long pgoff,
 433                            unsigned long flags)
 434 {
 435         typeof_member(struct proc_ops, proc_get_unmapped_area) get_area;
 436
 437         get_area = pde->proc_ops->proc_get_unmapped_area;
 438 #ifdef CONFIG_MMU
 439         if (!get_area)
 440                 get_area = current->mm->get_unmapped_area;
 441 #endif
 442         if (get_area)
 443                 return get_area(file, orig_addr, len, pgoff, flags);
 444         return orig_addr;
 445 }
 446
 447 static unsigned long
 448 proc_reg_get_unmapped_area(struct file *file, unsigned long orig_addr,
 449                            unsigned long len, unsigned long pgoff,
 450                            unsigned long flags)
 451 {
 452         struct proc_dir_entry *pde = PDE(file_inode(file));
 453         unsigned long rv = -EIO;
 454
 455         if (pde_is_permanent(pde)) {
 456                 return pde_get_unmapped_area(pde, file, orig_addr, len, pgoff, flags);
 457         } else if (use_pde(pde)) {
 458                 rv = pde_get_unmapped_area(pde, file, orig_addr, len, pgoff, flags);
 459                 unuse_pde(pde);
 460         }
 461         return rv;
 462 }
 463
 464 static int proc_reg_open(struct inode *inode, struct file *file)
 465 {
 466         struct proc_dir_entry *pde = PDE(inode);
 467         int rv = 0;
 468         typeof_member(struct proc_ops, proc_open) open;
 469         typeof_member(struct proc_ops, proc_release) release;
 470         struct pde_opener *pdeo;
 471
 472         if (pde_is_permanent(pde)) {
 473                 open = pde->proc_ops->proc_open;
 474                 if (open)
 475                         rv = open(inode, file);
 476                 return rv;
 477         }
 478
 479         /*
 480          * Ensure that
 481          * 1) PDE's ->release hook will be called no matter what
 482          *    either normally by close()/->release, or forcefully by
 483          *    rmmod/remove_proc_entry.
 484          *
 485          * 2) rmmod isn't blocked by opening file in /proc and sitting on
 486          *    the descriptor (including "rmmod foo </proc/foo" scenario).
 487          *
 488          * Save every "struct file" with custom ->release hook.
 489          */
 490         if (!use_pde(pde))
 491                 return -ENOENT;
 492
 493         release = pde->proc_ops->proc_release;
 494         if (release) {
 495                 pdeo = kmem_cache_alloc(pde_opener_cache, GFP_KERNEL);
 496                 if (!pdeo) {
 497                         rv = -ENOMEM;
 498                         goto out_unuse;
 499                 }
 500         }
 501
 502         open = pde->proc_ops->proc_open;
 503         if (open)
 504                 rv = open(inode, file);
 505
 506         if (release) {
 507                 if (rv == 0) {
 508                         /* To know what to release. */
 509                         pdeo->file = file;
 510                         pdeo->closing = false;
 511                         pdeo->c = NULL;
 512                         spin_lock(&pde->pde_unload_lock);
 513                         list_add(&pdeo->lh, &pde->pde_openers);
 514                         spin_unlock(&pde->pde_unload_lock);
 515                 } else
 516                         kmem_cache_free(pde_opener_cache, pdeo);
 517         }
 518
 519 out_unuse:
 520         unuse_pde(pde);
 521         return rv;
 522 }
 523
 524 static int proc_reg_release(struct inode *inode, struct file *file)
 525 {
 526         struct proc_dir_entry *pde = PDE(inode);
 527         struct pde_opener *pdeo;
 528
 529         if (pde_is_permanent(pde)) {
 530                 typeof_member(struct proc_ops, proc_release) release;
 531
 532                 release = pde->proc_ops->proc_release;
 533                 if (release) {
 534                         return release(inode, file);
 535                 }
 536                 return 0;
 537         }
 538
 539         spin_lock(&pde->pde_unload_lock);
 540         list_for_each_entry(pdeo, &pde->pde_openers, lh) {
 541                 if (pdeo->file == file) {
 542                         close_pdeo(pde, pdeo);
 543                         return 0;
 544                 }
 545         }
 546         spin_unlock(&pde->pde_unload_lock);
 547         return 0;
 548 }
 549
 550 static const struct file_operations proc_reg_file_ops = {
 551         .llseek         = proc_reg_llseek,
 552         .read           = proc_reg_read,
 553         .write          = proc_reg_write,
 554         .poll           = proc_reg_poll,
 555         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 556 #ifdef CONFIG_COMPAT
 557         .compat_ioctl   = proc_reg_compat_ioctl,
 558 #endif
 559         .mmap           = proc_reg_mmap,
 560         .get_unmapped_area = proc_reg_get_unmapped_area,
 561         .open           = proc_reg_open,
 562         .release        = proc_reg_release,
 563 };
 564
 565 #ifdef CONFIG_COMPAT
 566 static const struct file_operations proc_reg_file_ops_no_compat = {
 567         .llseek         = proc_reg_llseek,
 568         .read           = proc_reg_read,
 569         .write          = proc_reg_write,
 570         .poll           = proc_reg_poll,
 571         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 572         .mmap           = proc_reg_mmap,
 573         .get_unmapped_area = proc_reg_get_unmapped_area,
 574         .open           = proc_reg_open,
 575         .release        = proc_reg_release,
 576 };
 577 #endif
 578
 579 static void proc_put_link(void *p)
 580 {
 581         unuse_pde(p);
 582 }
 583
 584 static const char *proc_get_link(struct dentry *dentry,
 585                                  struct inode *inode,
 586                                  struct delayed_call *done)
 587 {
 588         struct proc_dir_entry *pde = PDE(inode);
 589         if (!use_pde(pde))
 590                 return ERR_PTR(-EINVAL);
 591         set_delayed_call(done, proc_put_link, pde);
 592         return pde->data;
 593 }
 594
 595 const struct inode_operations proc_link_inode_operations = {
 596         .get_link       = proc_get_link,
 597 };
 598
 599 struct inode *proc_get_inode(struct super_block *sb, struct proc_dir_entry *de)
 600 {
 601         struct inode *inode = new_inode_pseudo(sb);
 602
 603         if (inode) {
 604                 inode->i_ino = de->low_ino;
 605                 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
 606                 PROC_I(inode)->pde = de;
 607
 608                 if (is_empty_pde(de)) {
 609                         make_empty_dir_inode(inode);
 610                         return inode;
 611                 }
 612                 if (de->mode) {
 613                         inode->i_mode = de->mode;
 614                         inode->i_uid = de->uid;
 615                         inode->i_gid = de->gid;
 616                 }
 617                 if (de->size)
 618                         inode->i_size = de->size;
 619                 if (de->nlink)
 620                         set_nlink(inode, de->nlink);
 621
 622                 if (S_ISREG(inode->i_mode)) {
 623                         inode->i_op = de->proc_iops;
 624                         inode->i_fop = &proc_reg_file_ops;
 625 #ifdef CONFIG_COMPAT
 626                         if (!de->proc_ops->proc_compat_ioctl) {
 627                                 inode->i_fop = &proc_reg_file_ops_no_compat;
 628                         }
 629 #endif
 630                 } else if (S_ISDIR(inode->i_mode)) {
 631                         inode->i_op = de->proc_iops;
 632                         inode->i_fop = de->proc_dir_ops;
 633                 } else if (S_ISLNK(inode->i_mode)) {
 634                         inode->i_op = de->proc_iops;
 635                         inode->i_fop = NULL;
 636                 } else
 637                         BUG();
 638         } else
 639                pde_put(de);
 640         return inode;
 641 }