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         return 0;
 113 }
 114
 115 static const struct super_operations proc_sops = {
 116         .alloc_inode    = proc_alloc_inode,
 117         .destroy_inode  = proc_destroy_inode,
 118         .drop_inode     = generic_delete_inode,
 119         .evict_inode    = proc_evict_inode,
 120         .statfs         = simple_statfs,
 121         .remount_fs     = proc_remount,
 122         .show_options   = proc_show_options,
 123 };
 124
 125 static void __pde_users_dec(struct proc_dir_entry *pde)
 126 {
 127         pde->pde_users--;
 128         if (pde->pde_unload_completion && pde->pde_users == 0)
 129                 complete(pde->pde_unload_completion);
 130 }
 131
 132 void pde_users_dec(struct proc_dir_entry *pde)
 133 {
 134         spin_lock(&pde->pde_unload_lock);
 135         __pde_users_dec(pde);
 136         spin_unlock(&pde->pde_unload_lock);
 137 }
 138
 139 static loff_t proc_reg_llseek(struct file *file, loff_t offset, int whence)
 140 {
 141         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 142         loff_t rv = -EINVAL;
 143         loff_t (*llseek)(struct file *, loff_t, int);
 144
 145         spin_lock(&pde->pde_unload_lock);
 146         /*
 147          * remove_proc_entry() is going to delete PDE (as part of module
 148          * cleanup sequence). No new callers into module allowed.
 149          */
 150         if (!pde->proc_fops) {
 151                 spin_unlock(&pde->pde_unload_lock);
 152                 return rv;
 153         }
 154         /*
 155          * Bump refcount so that remove_proc_entry will wail for ->llseek to
 156          * complete.
 157          */
 158         pde->pde_users++;
 159         /*
 160          * Save function pointer under lock, to protect against ->proc_fops
 161          * NULL'ifying right after ->pde_unload_lock is dropped.
 162          */
 163         llseek = pde->proc_fops->llseek;
 164         spin_unlock(&pde->pde_unload_lock);
 165
 166         if (!llseek)
 167                 llseek = default_llseek;
 168         rv = llseek(file, offset, whence);
 169
 170         pde_users_dec(pde);
 171         return rv;
 172 }
 173
 174 static ssize_t proc_reg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 175 {
 176         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 177         ssize_t rv = -EIO;
 178         ssize_t (*read)(struct file *, char __user *, size_t, loff_t *);
 179
 180         spin_lock(&pde->pde_unload_lock);
 181         if (!pde->proc_fops) {
 182                 spin_unlock(&pde->pde_unload_lock);
 183                 return rv;
 184         }
 185         pde->pde_users++;
 186         read = pde->proc_fops->read;
 187         spin_unlock(&pde->pde_unload_lock);
 188
 189         if (read)
 190                 rv = read(file, buf, count, ppos);
 191
 192         pde_users_dec(pde);
 193         return rv;
 194 }
 195
 196 static ssize_t proc_reg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 197 {
 198         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 199         ssize_t rv = -EIO;
 200         ssize_t (*write)(struct file *, const char __user *, size_t, loff_t *);
 201
 202         spin_lock(&pde->pde_unload_lock);
 203         if (!pde->proc_fops) {
 204                 spin_unlock(&pde->pde_unload_lock);
 205                 return rv;
 206         }
 207         pde->pde_users++;
 208         write = pde->proc_fops->write;
 209         spin_unlock(&pde->pde_unload_lock);
 210
 211         if (write)
 212                 rv = write(file, buf, count, ppos);
 213
 214         pde_users_dec(pde);
 215         return rv;
 216 }
 217
 218 static unsigned int proc_reg_poll(struct file *file, struct poll_table_struct *pts)
 219 {
 220         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 221         unsigned int rv = DEFAULT_POLLMASK;
 222         unsigned int (*poll)(struct file *, struct poll_table_struct *);
 223
 224         spin_lock(&pde->pde_unload_lock);
 225         if (!pde->proc_fops) {
 226                 spin_unlock(&pde->pde_unload_lock);
 227                 return rv;
 228         }
 229         pde->pde_users++;
 230         poll = pde->proc_fops->poll;
 231         spin_unlock(&pde->pde_unload_lock);
 232
 233         if (poll)
 234                 rv = poll(file, pts);
 235
 236         pde_users_dec(pde);
 237         return rv;
 238 }
 239
 240 static long proc_reg_unlocked_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 241 {
 242         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 243         long rv = -ENOTTY;
 244         long (*ioctl)(struct file *, unsigned int, unsigned long);
 245
 246         spin_lock(&pde->pde_unload_lock);
 247         if (!pde->proc_fops) {
 248                 spin_unlock(&pde->pde_unload_lock);
 249                 return rv;
 250         }
 251         pde->pde_users++;
 252         ioctl = pde->proc_fops->unlocked_ioctl;
 253         spin_unlock(&pde->pde_unload_lock);
 254
 255         if (ioctl)
 256                 rv = ioctl(file, cmd, arg);
 257
 258         pde_users_dec(pde);
 259         return rv;
 260 }
 261
 262 #ifdef CONFIG_COMPAT
 263 static long proc_reg_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 264 {
 265         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 266         long rv = -ENOTTY;
 267         long (*compat_ioctl)(struct file *, unsigned int, unsigned long);
 268
 269         spin_lock(&pde->pde_unload_lock);
 270         if (!pde->proc_fops) {
 271                 spin_unlock(&pde->pde_unload_lock);
 272                 return rv;
 273         }
 274         pde->pde_users++;
 275         compat_ioctl = pde->proc_fops->compat_ioctl;
 276         spin_unlock(&pde->pde_unload_lock);
 277
 278         if (compat_ioctl)
 279                 rv = compat_ioctl(file, cmd, arg);
 280
 281         pde_users_dec(pde);
 282         return rv;
 283 }
 284 #endif
 285
 286 static int proc_reg_mmap(struct file *file, struct vm_area_struct *vma)
 287 {
 288         struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
 289         int rv = -EIO;
 290         int (*mmap)(struct file *, struct vm_area_struct *);
 291
 292         spin_lock(&pde->pde_unload_lock);
 293         if (!pde->proc_fops) {
 294                 spin_unlock(&pde->pde_unload_lock);
 295                 return rv;
 296         }
 297         pde->pde_users++;
 298         mmap = pde->proc_fops->mmap;
 299         spin_unlock(&pde->pde_unload_lock);
 300
 301         if (mmap)
 302                 rv = mmap(file, vma);
 303
 304         pde_users_dec(pde);
 305         return rv;
 306 }
 307
 308 static int proc_reg_open(struct inode *inode, struct file *file)
 309 {
 310         struct proc_dir_entry *pde = PDE(inode);
 311         int rv = 0;
 312         int (*open)(struct inode *, struct file *);
 313         int (*release)(struct inode *, struct file *);
 314         struct pde_opener *pdeo;
 315
 316         /*
 317          * What for, you ask? Well, we can have open, rmmod, remove_proc_entry
 318          * sequence. ->release won't be called because ->proc_fops will be
 319          * cleared. Depending on complexity of ->release, consequences vary.
 320          *
 321          * We can't wait for mercy when close will be done for real, it's
 322          * deadlockable: rmmod foo </proc/foo . So, we're going to do ->release
 323          * by hand in remove_proc_entry(). For this, save opener's credentials
 324          * for later.
 325          */
 326         pdeo = kmalloc(sizeof(struct pde_opener), GFP_KERNEL);
 327         if (!pdeo)
 328                 return -ENOMEM;
 329
 330         spin_lock(&pde->pde_unload_lock);
 331         if (!pde->proc_fops) {
 332                 spin_unlock(&pde->pde_unload_lock);
 333                 kfree(pdeo);
 334                 return -ENOENT;
 335         }
 336         pde->pde_users++;
 337         open = pde->proc_fops->open;
 338         release = pde->proc_fops->release;
 339         spin_unlock(&pde->pde_unload_lock);
 340
 341         if (open)
 342                 rv = open(inode, file);
 343
 344         spin_lock(&pde->pde_unload_lock);
 345         if (rv == 0 && release) {
 346                 /* To know what to release. */
 347                 pdeo->inode = inode;
 348                 pdeo->file = file;
 349                 /* Strictly for "too late" ->release in proc_reg_release(). */
 350                 pdeo->release = release;
 351                 list_add(&pdeo->lh, &pde->pde_openers);
 352         } else
 353                 kfree(pdeo);
 354         __pde_users_dec(pde);
 355         spin_unlock(&pde->pde_unload_lock);
 356         return rv;
 357 }
 358
 359 static struct pde_opener *find_pde_opener(struct proc_dir_entry *pde,
 360                                         struct inode *inode, struct file *file)
 361 {
 362         struct pde_opener *pdeo;
 363
 364         list_for_each_entry(pdeo, &pde->pde_openers, lh) {
 365                 if (pdeo->inode == inode && pdeo->file == file)
 366                         return pdeo;
 367         }
 368         return NULL;
 369 }
 370
 371 static int proc_reg_release(struct inode *inode, struct file *file)
 372 {
 373         struct proc_dir_entry *pde = PDE(inode);
 374         int rv = 0;
 375         int (*release)(struct inode *, struct file *);
 376         struct pde_opener *pdeo;
 377
 378         spin_lock(&pde->pde_unload_lock);
 379         pdeo = find_pde_opener(pde, inode, file);
 380         if (!pde->proc_fops) {
 381                 /*
 382                  * Can't simply exit, __fput() will think that everything is OK,
 383                  * and move on to freeing struct file. remove_proc_entry() will
 384                  * find slacker in opener's list and will try to do non-trivial
 385                  * things with struct file. Therefore, remove opener from list.
 386                  *
 387                  * But if opener is removed from list, who will ->release it?
 388                  */
 389                 if (pdeo) {
 390                         list_del(&pdeo->lh);
 391                         spin_unlock(&pde->pde_unload_lock);
 392                         rv = pdeo->release(inode, file);
 393                         kfree(pdeo);
 394                 } else
 395                         spin_unlock(&pde->pde_unload_lock);
 396                 return rv;
 397         }
 398         pde->pde_users++;
 399         release = pde->proc_fops->release;
 400         if (pdeo) {
 401                 list_del(&pdeo->lh);
 402                 kfree(pdeo);
 403         }
 404         spin_unlock(&pde->pde_unload_lock);
 405
 406         if (release)
 407                 rv = release(inode, file);
 408
 409         pde_users_dec(pde);
 410         return rv;
 411 }
 412
 413 static const struct file_operations proc_reg_file_ops = {
 414         .llseek         = proc_reg_llseek,
 415         .read           = proc_reg_read,
 416         .write          = proc_reg_write,
 417         .poll           = proc_reg_poll,
 418         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 419 #ifdef CONFIG_COMPAT
 420         .compat_ioctl   = proc_reg_compat_ioctl,
 421 #endif
 422         .mmap           = proc_reg_mmap,
 423         .open           = proc_reg_open,
 424         .release        = proc_reg_release,
 425 };
 426
 427 #ifdef CONFIG_COMPAT
 428 static const struct file_operations proc_reg_file_ops_no_compat = {
 429         .llseek         = proc_reg_llseek,
 430         .read           = proc_reg_read,
 431         .write          = proc_reg_write,
 432         .poll           = proc_reg_poll,
 433         .unlocked_ioctl = proc_reg_unlocked_ioctl,
 434         .mmap           = proc_reg_mmap,
 435         .open           = proc_reg_open,
 436         .release        = proc_reg_release,
 437 };
 438 #endif
 439
 440 struct inode *proc_get_inode(struct super_block *sb, struct proc_dir_entry *de)
 441 {
 442         struct inode * inode;
 443
 444         inode = iget_locked(sb, de->low_ino);
 445         if (!inode)
 446                 return NULL;
 447         if (inode->i_state & I_NEW) {
 448                 inode->i_mtime = inode->i_atime = inode->i_ctime = CURRENT_TIME;
 449                 PROC_I(inode)->fd = 0;
 450                 PROC_I(inode)->pde = de;
 451
 452                 if (de->mode) {
 453                         inode->i_mode = de->mode;
 454                         inode->i_uid = de->uid;
 455                         inode->i_gid = de->gid;
 456                 }
 457                 if (de->size)
 458                         inode->i_size = de->size;
 459                 if (de->nlink)
 460                         set_nlink(inode, de->nlink);
 461                 if (de->proc_iops)
 462                         inode->i_op = de->proc_iops;
 463                 if (de->proc_fops) {
 464                         if (S_ISREG(inode->i_mode)) {
 465 #ifdef CONFIG_COMPAT
 466                                 if (!de->proc_fops->compat_ioctl)
 467                                         inode->i_fop =
 468                                                 &proc_reg_file_ops_no_compat;
 469                                 else
 470 #endif
 471                                         inode->i_fop = &proc_reg_file_ops;
 472                         } else {
 473                                 inode->i_fop = de->proc_fops;
 474                         }
 475                 }
 476                 unlock_new_inode(inode);
 477         } else
 478                pde_put(de);
 479         return inode;
 480 }
 481
 482 int proc_fill_super(struct super_block *s)
 483 {
 484         struct inode * root_inode;
 485
 486         s->s_flags |= MS_NODIRATIME | MS_NOSUID | MS_NOEXEC;
 487         s->s_blocksize = 1024;
 488         s->s_blocksize_bits = 10;
 489         s->s_magic = PROC_SUPER_MAGIC;
 490         s->s_op = &proc_sops;
 491         s->s_time_gran = 1;
 492
 493         pde_get(&proc_root);
 494         root_inode = proc_get_inode(s, &proc_root);
 495         if (!root_inode)
 496                 goto out_no_root;
 497         root_inode->i_uid = 0;
 498         root_inode->i_gid = 0;
 499         s->s_root = d_alloc_root(root_inode);
 500         if (!s->s_root)
 501                 goto out_no_root;
 502         return 0;
 503
 504 out_no_root:
 505         printk("proc_read_super: get root inode failed\n");
 506         iput(root_inode);
 507         pde_put(&proc_root);
 508         return -ENOMEM;
 509 }