fs/proc/inode.c

   1 /*
   2  *  linux/fs/proc/inode.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  */
   6
   7 #include <linux/time.h>
   8 #include <linux/proc_fs.h>
   9 #include <linux/kernel.h>
  10 #include <linux/pid_namespace.h>
  11 #include <linux/mm.h>
  12 #include <linux/string.h>
  13 #include <linux/stat.h>
  14 #include <linux/completion.h>
  15 #include <linux/poll.h>
  16 #include <linux/file.h>
  17 #include <linux/limits.h>
  18 #include <linux/init.h>
  19 #include <linux/module.h>
  20 #include <linux/sysctl.h>
  21 #include <linux/seq_file.h>
  22 #include <linux/slab.h>
  23 #include <linux/mount.h>
  24
  25 #include <asm/system.h>
  26 #include <asm/uaccess.h>
  27
  28 #include "internal.h"
  29
  30 static void proc_evict_inode(struct inode *inode)
  31 {
  32         struct proc_dir_entry *de;
  33         struct ctl_table_header *head;
  34         const struct proc_ns_operations *ns_ops;
  35         void *ns;
  36
  37         truncate_inode_pages(&inode->i_data, 0);
  38         end_writeback(inode);
  39
  40         /* Stop tracking associated processes */
  41         put_pid(PROC_I(inode)->pid);
  42
  43         /* Let go of any associated proc directory entry */
  44         de = PROC_I(inode)->pde;
  45         if (de)
  46                 pde_put(de);
  47         head = PROC_I(inode)->sysctl;
  48         if (head) {
  49                 rcu_assign_pointer(PROC_I(inode)->sysctl, NULL);
  50                 sysctl_head_put(head);
  51         }
  52         /* Release any associated namespace */
  53         ns_ops = PROC_I(inode)->ns_ops;
  54         ns = PROC_I(inode)->ns;
  55         if (ns_ops && ns)
  56                 ns_ops->put(ns);
  57 }
  58
  59 static struct kmem_cache * proc_inode_cachep;
  60
  61 static struct inode *proc_alloc_inode(struct super_block *sb)
  62 {
  63         struct proc_inode *ei;
  64         struct inode *inode;
  65
  66         ei = (struct proc_inode *)kmem_cache_alloc(proc_inode_cachep, GFP_KERNEL);
  67         if (!ei)
  68                 return NULL;
  69         ei->pid = NULL;
  70         ei->fd = 0;
  71         ei->op.proc_get_link = NULL;
  72         ei->pde = NULL;
  73         ei->sysctl = NULL;
  74         ei->sysctl_entry = NULL;
  75         ei->ns = NULL;
  76         ei->ns_ops = NULL;
  77         inode = &ei->vfs_inode;
  78         inode->i_mtime = inode->i_atime = inode->i_ctime = CURRENT_TIME;
  79         return inode;
  80 }
  81
  82 static void proc_i_callback(struct rcu_head *head)
  83 {
  84         struct inode *inode = container_of(head, struct inode, i_rcu);
  85         INIT_LIST_HEAD(&inode->i_dentry);
  86         kmem_cache_free(proc_inode_cachep, PROC_I(inode));
  87 }
  88
  89 static void proc_destroy_inode(struct inode *inode)
  90 {
  91         call_rcu(&inode->i_rcu, proc_i_callback);
  92 }
  93
  94 static void init_once(void *foo)
  95 {
  96         struct proc_inode *ei = (struct proc_inode *) foo;
  97
  98         inode_init_once(&ei->vfs_inode);
  99 }
 100
 101 void __init proc_init_inodecache(void)
 102 {
 103         proc_inode_cachep = kmem_cache_create("proc_inode_cache",
 104                                              sizeof(struct proc_inode),
 105                                              0, (SLAB_RECLAIM_ACCOUNT|
 106                                                 SLAB_MEM_SPREAD|SLAB_PANIC),
 107                                              init_once);
 108 }
 109
 110 static int proc_show_options(struct seq_file *seq, struct vfsmount *vfs)
 111 {
 112         struct super_block *sb = vfs->mnt_sb;
 113         struct pid_namespace *pid = sb->s_fs_info;
 114
 115         if (pid->pid_gid)
 116                 seq_printf(seq, ",gid=%lu", (unsigned long)pid->pid_gid);
 117         if (pid->hide_pid != 0)
 118                 seq_printf(seq, ",hidepid=%u", pid->hide_pid);
 119
 120         return 0;
 121 }
 122
 123 static const struct super_operations proc_sops = {
 124         .alloc_inode    = proc_alloc_inode,
 125         .destroy_inode  = proc_destroy_inode,
 126         .drop_inode     = generic_delete_inode,
 127         .evict_inode    = proc_evict_inode,
 128         .statfs         = simple_statfs,
 129         .remount_fs     = proc_remount,
 130         .show_options   = proc_show_options,
 131 };
 132
 133 static void __pde_users_dec(struct proc_dir_entry *pde)
 134 {
 135         pde->pde_users--;
 136         if (pde->pde_unload_completion && pde->pde_users == 0)
 137                 complete(pde->pde_unload_completion);
 138 }
 139
 140 void pde_users_dec(struct proc_dir_entry *pde)
 141 {
 142         spin_lock(&pde->pde_unload_lock);
 143         __pde_users_dec(pde);
 144         spin_unlock(&pde->pde_unload_lock);
 145 }
 146
 147 static loff_t proc_reg_llseek(struct file *file, loff_t offset, int whence)
 148 {
 149         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 150         loff_t rv = -EINVAL;
 151         loff_t (*llseek)(struct file *, loff_t, int);
 152
 153         spin_lock(&pde->pde_unload_lock);
 154         /*
 155          * remove_proc_entry() is going to delete PDE (as part of module
 156          * cleanup sequence). No new callers into module allowed.
 157          */
 158         if (!pde->proc_fops) {
 159                 spin_unlock(&pde->pde_unload_lock);
 160                 return rv;
 161         }
 162         /*
 163          * Bump refcount so that remove_proc_entry will wail for ->llseek to
 164          * complete.
 165          */
 166         pde->pde_users++;
 167         /*
 168          * Save function pointer under lock, to protect against ->proc_fops
 169          * NULL'ifying right after ->pde_unload_lock is dropped.
 170          */
 171         llseek = pde->proc_fops->llseek;
 172         spin_unlock(&pde->pde_unload_lock);
 173
 174         if (!llseek)
 175                 llseek = default_llseek;
 176         rv = llseek(file, offset, whence);
 177
 178         pde_users_dec(pde);
 179         return rv;
 180 }
 181
 182 static ssize_t proc_reg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 183 {
 184         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 185         ssize_t rv = -EIO;
 186         ssize_t (*read)(struct file *, char __user *, size_t, loff_t *);
 187
 188         spin_lock(&pde->pde_unload_lock);
 189         if (!pde->proc_fops) {
 190                 spin_unlock(&pde->pde_unload_lock);
 191                 return rv;
 192         }
 193         pde->pde_users++;
 194         read = pde->proc_fops->read;
 195         spin_unlock(&pde->pde_unload_lock);
 196
 197         if (read)
 198                 rv = read(file, buf, count, ppos);
 199
 200         pde_users_dec(pde);
 201         return rv;
 202 }
 203
 204 static ssize_t proc_reg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 205 {
 206         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 207         ssize_t rv = -EIO;
 208         ssize_t (*write)(struct file *, const char __user *, size_t, loff_t *);
 209
 210         spin_lock(&pde->pde_unload_lock);
 211         if (!pde->proc_fops) {
 212                 spin_unlock(&pde->pde_unload_lock);
 213                 return rv;
 214         }
 215         pde->pde_users++;
 216         write = pde->proc_fops->write;
 217         spin_unlock(&pde->pde_unload_lock);
 218
 219         if (write)
 220                 rv = write(file, buf, count, ppos);
 221
 222         pde_users_dec(pde);
 223         return rv;
 224 }
 225
 226 static unsigned int proc_reg_poll(struct file *file, struct poll_table_struct *pts)
 227 {
 228         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 229         unsigned int rv = DEFAULT_POLLMASK;
 230         unsigned int (*poll)(struct file *, struct poll_table_struct *);
 231
 232         spin_lock(&pde->pde_unload_lock);
 233         if (!pde->proc_fops) {
 234                 spin_unlock(&pde->pde_unload_lock);
 235                 return rv;
 236         }
 237         pde->pde_users++;
 238         poll = pde->proc_fops->poll;
 239         spin_unlock(&pde->pde_unload_lock);
 240
 241         if (poll)
 242                 rv = poll(file, pts);
 243
 244         pde_users_dec(pde);
 245         return rv;
 246 }
 247
 248 static long proc_reg_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 249 {
 250         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 251         long rv = -ENOTTY;
 252         long (*ioctl)(struct file *, unsigned int, unsigned long);
 253
 254         spin_lock(&pde->pde_unload_lock);
 255         if (!pde->proc_fops) {
 256                 spin_unlock(&pde->pde_unload_lock);
 257                 return rv;
 258         }
 259         pde->pde_users++;
 260         ioctl = pde->proc_fops->unlocked_ioctl;
 261         spin_unlock(&pde->pde_unload_lock);
 262
 263         if (ioctl)
 264                 rv = ioctl(file, cmd, arg);
 265
 266         pde_users_dec(pde);
 267         return rv;
 268 }
 269
 270 #ifdef CONFIG_COMPAT
 271 static long proc_reg_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 272 {
 273         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 274         long rv = -ENOTTY;
 275         long (*compat_ioctl)(struct file *, unsigned int, unsigned long);
 276
 277         spin_lock(&pde->pde_unload_lock);
 278         if (!pde->proc_fops) {
 279                 spin_unlock(&pde->pde_unload_lock);
 280                 return rv;
 281         }
 282         pde->pde_users++;
 283         compat_ioctl = pde->proc_fops->compat_ioctl;
 284         spin_unlock(&pde->pde_unload_lock);
 285
 286         if (compat_ioctl)
 287                 rv = compat_ioctl(file, cmd, arg);
 288
 289         pde_users_dec(pde);
 290         return rv;
 291 }
 292 #endif
 293
 294 static int proc_reg_mmap(struct file *file, struct vm_area_struct *vma)
 295 {
 296         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 297         int rv = -EIO;
 298         int (*mmap)(struct file *, struct vm_area_struct *);
 299
 300         spin_lock(&pde->pde_unload_lock);
 301         if (!pde->proc_fops) {
 302                 spin_unlock(&pde->pde_unload_lock);
 303                 return rv;
 304         }
 305         pde->pde_users++;
 306         mmap = pde->proc_fops->mmap;
 307         spin_unlock(&pde->pde_unload_lock);
 308
 309         if (mmap)
 310                 rv = mmap(file, vma);
 311
 312         pde_users_dec(pde);
 313         return rv;
 314 }
 315
 316 static int proc_reg_open(struct inode *inode, struct file *file)
 317 {
 318         struct proc_dir_entry *pde = PDE(inode);
 319         int rv = 0;
 320         int (*open)(struct inode *, struct file *);
 321         int (*release)(struct inode *, struct file *);
 322         struct pde_opener *pdeo;
 323
 324         /*
 325          * What for, you ask? Well, we can have open, rmmod, remove_proc_entry
 326          * sequence. ->release won't be called because ->proc_fops will be
 327          * cleared. Depending on complexity of ->release, consequences vary.
 328          *
 329          * We can't wait for mercy when close will be done for real, it's
 330          * deadlockable: rmmod foo </proc/foo . So, we're going to do ->release
 331          * by hand in remove_proc_entry(). For this, save opener's credentials
 332          * for later.
 333          */
 334         pdeo = kmalloc(sizeof(struct pde_opener), GFP_KERNEL);
 335         if (!pdeo)
 336                 return -ENOMEM;
 337
 338         spin_lock(&pde->pde_unload_lock);
 339         if (!pde->proc_fops) {
 340                 spin_unlock(&pde->pde_unload_lock);
 341                 kfree(pdeo);
 342                 return -ENOENT;
 343         }
 344         pde->pde_users++;
 345         open = pde->proc_fops->open;
 346         release = pde->proc_fops->release;
 347         spin_unlock(&pde->pde_unload_lock);
 348
 349         if (open)
 350                 rv = open(inode, file);
 351
 352         spin_lock(&pde->pde_unload_lock);
 353         if (rv == 0 && release) {
 354                 /* To know what to release. */
 355                 pdeo->inode = inode;
 356                 pdeo->file = file;
 357                 /* Strictly for "too late" ->release in proc_reg_release(). */
 358                 pdeo->release = release;
 359                 list_add(&pdeo->lh, &pde->pde_openers);
 360         } else
 361                 kfree(pdeo);
 362         __pde_users_dec(pde);
 363         spin_unlock(&pde->pde_unload_lock);
 364         return rv;
 365 }
 366
 367 static struct pde_opener *find_pde_opener(struct proc_dir_entry *pde,
 368                                         struct inode *inode, struct file *file)
 369 {
 370         struct pde_opener *pdeo;
 371
 372         list_for_each_entry(pdeo, &pde->pde_openers, lh) {
 373                 if (pdeo->inode == inode && pdeo->file == file)
 374                         return pdeo;
 375         }
 376         return NULL;
 377 }
 378
 379 static int proc_reg_release(struct inode *inode, struct file *file)
 380 {
 381         struct proc_dir_entry *pde = PDE(inode);
 382         int rv = 0;
 383         int (*release)(struct inode *, struct file *);
 384         struct pde_opener *pdeo;
 385
 386         spin_lock(&pde->pde_unload_lock);
 387         pdeo = find_pde_opener(pde, inode, file);
 388         if (!pde->proc_fops) {
 389                 /*
 390                  * Can't simply exit, __fput() will think that everything is OK,
 391                  * and move on to freeing struct file. remove_proc_entry() will
 392                  * find slacker in opener's list and will try to do non-trivial
 393                  * things with struct file. Therefore, remove opener from list.
 394                  *
 395                  * But if opener is removed from list, who will ->release it?
 396                  */
 397                 if (pdeo) {
 398                         list_del(&pdeo->lh);
 399                         spin_unlock(&pde->pde_unload_lock);
 400                         rv = pdeo->release(inode, file);
 401                         kfree(pdeo);
 402                 } else
 403                         spin_unlock(&pde->pde_unload_lock);
 404                 return rv;
 405         }
 406         pde->pde_users++;
 407         release = pde->proc_fops->release;
 408         if (pdeo) {
 409                 list_del(&pdeo->lh);
 410                 kfree(pdeo);
 411         }
 412         spin_unlock(&pde->pde_unload_lock);
 413
 414         if (release)
 415                 rv = release(inode, file);
 416
 417         pde_users_dec(pde);
 418         return rv;
 419 }
 420
 421 static const struct file_operations proc_reg_file_ops = {
 422         .llseek         = proc_reg_llseek,
 423         .read           = proc_reg_read,
 424         .write          = proc_reg_write,
 425         .poll           = proc_reg_poll,
 426         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 427 #ifdef CONFIG_COMPAT
 428         .compat_ioctl   = proc_reg_compat_ioctl,
 429 #endif
 430         .mmap           = proc_reg_mmap,
 431         .open           = proc_reg_open,
 432         .release        = proc_reg_release,
 433 };
 434
 435 #ifdef CONFIG_COMPAT
 436 static const struct file_operations proc_reg_file_ops_no_compat = {
 437         .llseek         = proc_reg_llseek,
 438         .read           = proc_reg_read,
 439         .write          = proc_reg_write,
 440         .poll           = proc_reg_poll,
 441         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 442         .mmap           = proc_reg_mmap,
 443         .open           = proc_reg_open,
 444         .release        = proc_reg_release,
 445 };
 446 #endif
 447
 448 struct inode *proc_get_inode(struct super_block *sb, struct proc_dir_entry *de)
 449 {
 450         struct inode * inode;
 451
 452         inode = iget_locked(sb, de->low_ino);
 453         if (!inode)
 454                 return NULL;
 455         if (inode->i_state & I_NEW) {
 456                 inode->i_mtime = inode->i_atime = inode->i_ctime = CURRENT_TIME;
 457                 PROC_I(inode)->fd = 0;
 458                 PROC_I(inode)->pde = de;
 459
 460                 if (de->mode) {
 461                         inode->i_mode = de->mode;
 462                         inode->i_uid = de->uid;
 463                         inode->i_gid = de->gid;
 464                 }
 465                 if (de->size)
 466                         inode->i_size = de->size;
 467                 if (de->nlink)
 468                         set_nlink(inode, de->nlink);
 469                 if (de->proc_iops)
 470                         inode->i_op = de->proc_iops;
 471                 if (de->proc_fops) {
 472                         if (S_ISREG(inode->i_mode)) {
 473 #ifdef CONFIG_COMPAT
 474                                 if (!de->proc_fops->compat_ioctl)
 475                                         inode->i_fop =
 476                                                 &proc_reg_file_ops_no_compat;
 477                                 else
 478 #endif
 479                                         inode->i_fop = &proc_reg_file_ops;
 480                         } else {
 481                                 inode->i_fop = de->proc_fops;
 482                         }
 483                 }
 484                 unlock_new_inode(inode);
 485         } else
 486                pde_put(de);
 487         return inode;
 488 }
 489
 490 int proc_fill_super(struct super_block *s)
 491 {
 492         struct inode * root_inode;
 493
 494         s->s_flags |= MS_NODIRATIME | MS_NOSUID | MS_NOEXEC;
 495         s->s_blocksize = 1024;
 496         s->s_blocksize_bits = 10;
 497         s->s_magic = PROC_SUPER_MAGIC;
 498         s->s_op = &proc_sops;
 499         s->s_time_gran = 1;
 500
 501         pde_get(&proc_root);
 502         root_inode = proc_get_inode(s, &proc_root);
 503         if (!root_inode)
 504                 goto out_no_root;
 505         root_inode->i_uid = 0;
 506         root_inode->i_gid = 0;
 507         s->s_root = d_alloc_root(root_inode);
 508         if (!s->s_root)
 509                 goto out_no_root;
 510         return 0;
 511
 512 out_no_root:
 513         printk("proc_read_super: get root inode failed\n");
 514         iput(root_inode);
 515         pde_put(&proc_root);
 516         return -ENOMEM;
 517 }