fs/proc/generic.c

   1 /*
   2  * proc/fs/generic.c --- generic routines for the proc-fs
   3  *
   4  * This file contains generic proc-fs routines for handling
   5  * directories and files.
   6  *
   7  * Copyright (C) 1991, 1992 Linus Torvalds.
   8  * Copyright (C) 1997 Theodore Ts'o
   9  */
  10
  11 #include <linux/errno.h>
  12 #include <linux/time.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/stat.h>
  15 #include <linux/mm.h>
  16 #include <linux/module.h>
  17 #include <linux/slab.h>
  18 #include <linux/printk.h>
  19 #include <linux/mount.h>
  20 #include <linux/init.h>
  21 #include <linux/idr.h>
  22 #include <linux/namei.h>
  23 #include <linux/bitops.h>
  24 #include <linux/spinlock.h>
  25 #include <linux/completion.h>
  26 #include <asm/uaccess.h>
  27
  28 #include "internal.h"
  29
  30 static DEFINE_SPINLOCK(proc_subdir_lock);
  31
  32 static int proc_match(unsigned int len, const char *name, struct proc_dir_entry *de)
  33 {
  34         if (len < de->namelen)
  35                 return -1;
  36         if (len > de->namelen)
  37                 return 1;
  38
  39         return memcmp(name, de->name, len);
  40 }
  41
  42 static struct proc_dir_entry *pde_subdir_first(struct proc_dir_entry *dir)
  43 {
  44         return rb_entry_safe(rb_first(&dir->subdir), struct proc_dir_entry,
  45                              subdir_node);
  46 }
  47
  48 static struct proc_dir_entry *pde_subdir_next(struct proc_dir_entry *dir)
  49 {
  50         return rb_entry_safe(rb_next(&dir->subdir_node), struct proc_dir_entry,
  51                              subdir_node);
  52 }
  53
  54 static struct proc_dir_entry *pde_subdir_find(struct proc_dir_entry *dir,
  55                                               const char *name,
  56                                               unsigned int len)
  57 {
  58         struct rb_node *node = dir->subdir.rb_node;
  59
  60         while (node) {
  61                 struct proc_dir_entry *de = container_of(node,
  62                                                          struct proc_dir_entry,
  63                                                          subdir_node);
  64                 int result = proc_match(len, name, de);
  65
  66                 if (result < 0)
  67                         node = node->rb_left;
  68                 else if (result > 0)
  69                         node = node->rb_right;
  70                 else
  71                         return de;
  72         }
  73         return NULL;
  74 }
  75
  76 static bool pde_subdir_insert(struct proc_dir_entry *dir,
  77                               struct proc_dir_entry *de)
  78 {
  79         struct rb_root *root = &dir->subdir;
  80         struct rb_node **new = &root->rb_node, *parent = NULL;
  81
  82         /* Figure out where to put new node */
  83         while (*new) {
  84                 struct proc_dir_entry *this =
  85                         container_of(*new, struct proc_dir_entry, subdir_node);
  86                 int result = proc_match(de->namelen, de->name, this);
  87
  88                 parent = *new;
  89                 if (result < 0)
  90                         new = &(*new)->rb_left;
  91                 else if (result > 0)
  92                         new = &(*new)->rb_right;
  93                 else
  94                         return false;
  95         }
  96
  97         /* Add new node and rebalance tree. */
  98         rb_link_node(&de->subdir_node, parent, new);
  99         rb_insert_color(&de->subdir_node, root);
 100         return true;
 101 }
 102
 103 static int proc_notify_change(struct dentry *dentry, struct iattr *iattr)
 104 {
 105         struct inode *inode = dentry->d_inode;
 106         struct proc_dir_entry *de = PDE(inode);
 107         int error;
 108
 109         error = inode_change_ok(inode, iattr);
 110         if (error)
 111                 return error;
 112
 113         setattr_copy(inode, iattr);
 114         mark_inode_dirty(inode);
 115
 116         proc_set_user(de, inode->i_uid, inode->i_gid);
 117         de->mode = inode->i_mode;
 118         return 0;
 119 }
 120
 121 static int proc_getattr(struct vfsmount *mnt, struct dentry *dentry,
 122                         struct kstat *stat)
 123 {
 124         struct inode *inode = dentry->d_inode;
 125         struct proc_dir_entry *de = PDE(inode);
 126         if (de && de->nlink)
 127                 set_nlink(inode, de->nlink);
 128
 129         generic_fillattr(inode, stat);
 130         return 0;
 131 }
 132
 133 static const struct inode_operations proc_file_inode_operations = {
 134         .setattr        = proc_notify_change,
 135 };
 136
 137 /*
 138  * This function parses a name such as "tty/driver/serial", and
 139  * returns the struct proc_dir_entry for "/proc/tty/driver", and
 140  * returns "serial" in residual.
 141  */
 142 static int __xlate_proc_name(const char *name, struct proc_dir_entry **ret,
 143                              const char **residual)
 144 {
 145         const char              *cp = name, *next;
 146         struct proc_dir_entry   *de;
 147         unsigned int            len;
 148
 149         de = *ret;
 150         if (!de)
 151                 de = &proc_root;
 152
 153         while (1) {
 154                 next = strchr(cp, '/');
 155                 if (!next)
 156                         break;
 157
 158                 len = next - cp;
 159                 de = pde_subdir_find(de, cp, len);
 160                 if (!de) {
 161                         WARN(1, "name '%s'\n", name);
 162                         return -ENOENT;
 163                 }
 164                 cp += len + 1;
 165         }
 166         *residual = cp;
 167         *ret = de;
 168         return 0;
 169 }
 170
 171 static int xlate_proc_name(const char *name, struct proc_dir_entry **ret,
 172                            const char **residual)
 173 {
 174         int rv;
 175
 176         spin_lock(&proc_subdir_lock);
 177         rv = __xlate_proc_name(name, ret, residual);
 178         spin_unlock(&proc_subdir_lock);
 179         return rv;
 180 }
 181
 182 static DEFINE_IDA(proc_inum_ida);
 183 static DEFINE_SPINLOCK(proc_inum_lock); /* protects the above */
 184
 185 #define PROC_DYNAMIC_FIRST 0xF0000000U
 186
 187 /*
 188  * Return an inode number between PROC_DYNAMIC_FIRST and
 189  * 0xffffffff, or zero on failure.
 190  */
 191 int proc_alloc_inum(unsigned int *inum)
 192 {
 193         unsigned int i;
 194         int error;
 195
 196 retry:
 197         if (!ida_pre_get(&proc_inum_ida, GFP_KERNEL))
 198                 return -ENOMEM;
 199
 200         spin_lock_irq(&proc_inum_lock);
 201         error = ida_get_new(&proc_inum_ida, &i);
 202         spin_unlock_irq(&proc_inum_lock);
 203         if (error == -EAGAIN)
 204                 goto retry;
 205         else if (error)
 206                 return error;
 207
 208         if (i > UINT_MAX - PROC_DYNAMIC_FIRST) {
 209                 spin_lock_irq(&proc_inum_lock);
 210                 ida_remove(&proc_inum_ida, i);
 211                 spin_unlock_irq(&proc_inum_lock);
 212                 return -ENOSPC;
 213         }
 214         *inum = PROC_DYNAMIC_FIRST + i;
 215         return 0;
 216 }
 217
 218 void proc_free_inum(unsigned int inum)
 219 {
 220         unsigned long flags;
 221         spin_lock_irqsave(&proc_inum_lock, flags);
 222         ida_remove(&proc_inum_ida, inum - PROC_DYNAMIC_FIRST);
 223         spin_unlock_irqrestore(&proc_inum_lock, flags);
 224 }
 225
 226 static void *proc_follow_link(struct dentry *dentry, struct nameidata *nd)
 227 {
 228         nd_set_link(nd, __PDE_DATA(dentry->d_inode));
 229         return NULL;
 230 }
 231
 232 static const struct inode_operations proc_link_inode_operations = {
 233         .readlink       = generic_readlink,
 234         .follow_link    = proc_follow_link,
 235 };
 236
 237 /*
 238  * Don't create negative dentries here, return -ENOENT by hand
 239  * instead.
 240  */
 241 struct dentry *proc_lookup_de(struct proc_dir_entry *de, struct inode *dir,
 242                 struct dentry *dentry)
 243 {
 244         struct inode *inode;
 245
 246         spin_lock(&proc_subdir_lock);
 247         de = pde_subdir_find(de, dentry->d_name.name, dentry->d_name.len);
 248         if (de) {
 249                 pde_get(de);
 250                 spin_unlock(&proc_subdir_lock);
 251                 inode = proc_get_inode(dir->i_sb, de);
 252                 if (!inode)
 253                         return ERR_PTR(-ENOMEM);
 254                 d_set_d_op(dentry, &simple_dentry_operations);
 255                 d_add(dentry, inode);
 256                 return NULL;
 257         }
 258         spin_unlock(&proc_subdir_lock);
 259         return ERR_PTR(-ENOENT);
 260 }
 261
 262 struct dentry *proc_lookup(struct inode *dir, struct dentry *dentry,
 263                 unsigned int flags)
 264 {
 265         return proc_lookup_de(PDE(dir), dir, dentry);
 266 }
 267
 268 /*
 269  * This returns non-zero if at EOF, so that the /proc
 270  * root directory can use this and check if it should
 271  * continue with the <pid> entries..
 272  *
 273  * Note that the VFS-layer doesn't care about the return
 274  * value of the readdir() call, as long as it's non-negative
 275  * for success..
 276  */
 277 int proc_readdir_de(struct proc_dir_entry *de, struct file *file,
 278                     struct dir_context *ctx)
 279 {
 280         int i;
 281
 282         if (!dir_emit_dots(file, ctx))
 283                 return 0;
 284
 285         spin_lock(&proc_subdir_lock);
 286         de = pde_subdir_first(de);
 287         i = ctx->pos - 2;
 288         for (;;) {
 289                 if (!de) {
 290                         spin_unlock(&proc_subdir_lock);
 291                         return 0;
 292                 }
 293                 if (!i)
 294                         break;
 295                 de = pde_subdir_next(de);
 296                 i--;
 297         }
 298
 299         do {
 300                 struct proc_dir_entry *next;
 301                 pde_get(de);
 302                 spin_unlock(&proc_subdir_lock);
 303                 if (!dir_emit(ctx, de->name, de->namelen,
 304                             de->low_ino, de->mode >> 12)) {
 305                         pde_put(de);
 306                         return 0;
 307                 }
 308                 spin_lock(&proc_subdir_lock);
 309                 ctx->pos++;
 310                 next = pde_subdir_next(de);
 311                 pde_put(de);
 312                 de = next;
 313         } while (de);
 314         spin_unlock(&proc_subdir_lock);
 315         return 1;
 316 }
 317
 318 int proc_readdir(struct file *file, struct dir_context *ctx)
 319 {
 320         struct inode *inode = file_inode(file);
 321
 322         return proc_readdir_de(PDE(inode), file, ctx);
 323 }
 324
 325 /*
 326  * These are the generic /proc directory operations. They
 327  * use the in-memory "struct proc_dir_entry" tree to parse
 328  * the /proc directory.
 329  */
 330 static const struct file_operations proc_dir_operations = {
 331         .llseek                 = generic_file_llseek,
 332         .read                   = generic_read_dir,
 333         .iterate                = proc_readdir,
 334 };
 335
 336 /*
 337  * proc directories can do almost nothing..
 338  */
 339 static const struct inode_operations proc_dir_inode_operations = {
 340         .lookup         = proc_lookup,
 341         .getattr        = proc_getattr,
 342         .setattr        = proc_notify_change,
 343 };
 344
 345 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
 346 {
 347         int ret;
 348
 349         ret = proc_alloc_inum(&dp->low_ino);
 350         if (ret)
 351                 return ret;
 352
 353         spin_lock(&proc_subdir_lock);
 354         dp->parent = dir;
 355         if (pde_subdir_insert(dir, dp) == false) {
 356                 WARN(1, "proc_dir_entry '%s/%s' already registered\n",
 357                      dir->name, dp->name);
 358                 spin_unlock(&proc_subdir_lock);
 359                 proc_free_inum(dp->low_ino);
 360                 return -EEXIST;
 361         }
 362         spin_unlock(&proc_subdir_lock);
 363
 364         return 0;
 365 }
 366
 367 static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
 368                                           const char *name,
 369                                           umode_t mode,
 370                                           nlink_t nlink)
 371 {
 372         struct proc_dir_entry *ent = NULL;
 373         const char *fn;
 374         struct qstr qstr;
 375
 376         if (xlate_proc_name(name, parent, &fn) != 0)
 377                 goto out;
 378         qstr.name = fn;
 379         qstr.len = strlen(fn);
 380         if (qstr.len == 0 || qstr.len >= 256) {
 381                 WARN(1, "name len %u\n", qstr.len);
 382                 return NULL;
 383         }
 384         if (*parent == &proc_root && name_to_int(&qstr) != ~0U) {
 385                 WARN(1, "create '/proc/%s' by hand\n", qstr.name);
 386                 return NULL;
 387         }
 388
 389         ent = kzalloc(sizeof(struct proc_dir_entry) + qstr.len + 1, GFP_KERNEL);
 390         if (!ent)
 391                 goto out;
 392
 393         memcpy(ent->name, fn, qstr.len + 1);
 394         ent->namelen = qstr.len;
 395         ent->mode = mode;
 396         ent->nlink = nlink;
 397         ent->subdir = RB_ROOT;
 398         atomic_set(&ent->count, 1);
 399         spin_lock_init(&ent->pde_unload_lock);
 400         INIT_LIST_HEAD(&ent->pde_openers);
 401 out:
 402         return ent;
 403 }
 404
 405 struct proc_dir_entry *proc_symlink(const char *name,
 406                 struct proc_dir_entry *parent, const char *dest)
 407 {
 408         struct proc_dir_entry *ent;
 409
 410         ent = __proc_create(&parent, name,
 411                           (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
 412
 413         if (ent) {
 414                 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
 415                 if (ent->data) {
 416                         strcpy((char*)ent->data,dest);
 417                         ent->proc_iops = &proc_link_inode_operations;
 418                         if (proc_register(parent, ent) < 0) {
 419                                 kfree(ent->data);
 420                                 kfree(ent);
 421                                 ent = NULL;
 422                         }
 423                 } else {
 424                         kfree(ent);
 425                         ent = NULL;
 426                 }
 427         }
 428         return ent;
 429 }
 430 EXPORT_SYMBOL(proc_symlink);
 431
 432 struct proc_dir_entry *proc_mkdir_data(const char *name, umode_t mode,
 433                 struct proc_dir_entry *parent, void *data)
 434 {
 435         struct proc_dir_entry *ent;
 436
 437         if (mode == 0)
 438                 mode = S_IRUGO | S_IXUGO;
 439
 440         ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
 441         if (ent) {
 442                 ent->data = data;
 443                 ent->proc_fops = &proc_dir_operations;
 444                 ent->proc_iops = &proc_dir_inode_operations;
 445                 parent->nlink++;
 446                 if (proc_register(parent, ent) < 0) {
 447                         kfree(ent);
 448                         parent->nlink--;
 449                         ent = NULL;
 450                 }
 451         }
 452         return ent;
 453 }
 454 EXPORT_SYMBOL_GPL(proc_mkdir_data);
 455
 456 struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 457                                        struct proc_dir_entry *parent)
 458 {
 459         return proc_mkdir_data(name, mode, parent, NULL);
 460 }
 461 EXPORT_SYMBOL(proc_mkdir_mode);
 462
 463 struct proc_dir_entry *proc_mkdir(const char *name,
 464                 struct proc_dir_entry *parent)
 465 {
 466         return proc_mkdir_data(name, 0, parent, NULL);
 467 }
 468 EXPORT_SYMBOL(proc_mkdir);
 469
 470 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 471                                         struct proc_dir_entry *parent,
 472                                         const struct file_operations *proc_fops,
 473                                         void *data)
 474 {
 475         struct proc_dir_entry *pde;
 476         if ((mode & S_IFMT) == 0)
 477                 mode |= S_IFREG;
 478
 479         if (!S_ISREG(mode)) {
 480                 WARN_ON(1);     /* use proc_mkdir() */
 481                 return NULL;
 482         }
 483
 484         BUG_ON(proc_fops == NULL);
 485
 486         if ((mode & S_IALLUGO) == 0)
 487                 mode |= S_IRUGO;
 488         pde = __proc_create(&parent, name, mode, 1);
 489         if (!pde)
 490                 goto out;
 491         pde->proc_fops = proc_fops;
 492         pde->data = data;
 493         pde->proc_iops = &proc_file_inode_operations;
 494         if (proc_register(parent, pde) < 0)
 495                 goto out_free;
 496         return pde;
 497 out_free:
 498         kfree(pde);
 499 out:
 500         return NULL;
 501 }
 502 EXPORT_SYMBOL(proc_create_data);
 503
 504 void proc_set_size(struct proc_dir_entry *de, loff_t size)
 505 {
 506         de->size = size;
 507 }
 508 EXPORT_SYMBOL(proc_set_size);
 509
 510 void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid)
 511 {
 512         de->uid = uid;
 513         de->gid = gid;
 514 }
 515 EXPORT_SYMBOL(proc_set_user);
 516
 517 static void free_proc_entry(struct proc_dir_entry *de)
 518 {
 519         proc_free_inum(de->low_ino);
 520
 521         if (S_ISLNK(de->mode))
 522                 kfree(de->data);
 523         kfree(de);
 524 }
 525
 526 void pde_put(struct proc_dir_entry *pde)
 527 {
 528         if (atomic_dec_and_test(&pde->count))
 529                 free_proc_entry(pde);
 530 }
 531
 532 /*
 533  * Remove a /proc entry and free it if it's not currently in use.
 534  */
 535 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
 536 {
 537         struct proc_dir_entry *de = NULL;
 538         const char *fn = name;
 539         unsigned int len;
 540
 541         spin_lock(&proc_subdir_lock);
 542         if (__xlate_proc_name(name, &parent, &fn) != 0) {
 543                 spin_unlock(&proc_subdir_lock);
 544                 return;
 545         }
 546         len = strlen(fn);
 547
 548         de = pde_subdir_find(parent, fn, len);
 549         if (de)
 550                 rb_erase(&de->subdir_node, &parent->subdir);
 551         spin_unlock(&proc_subdir_lock);
 552         if (!de) {
 553                 WARN(1, "name '%s'\n", name);
 554                 return;
 555         }
 556
 557         proc_entry_rundown(de);
 558
 559         if (S_ISDIR(de->mode))
 560                 parent->nlink--;
 561         de->nlink = 0;
 562         WARN(pde_subdir_first(de),
 563              "%s: removing non-empty directory '%s/%s', leaking at least '%s'\n",
 564              __func__, de->parent->name, de->name, pde_subdir_first(de)->name);
 565         pde_put(de);
 566 }
 567 EXPORT_SYMBOL(remove_proc_entry);
 568
 569 int remove_proc_subtree(const char *name, struct proc_dir_entry *parent)
 570 {
 571         struct proc_dir_entry *root = NULL, *de, *next;
 572         const char *fn = name;
 573         unsigned int len;
 574
 575         spin_lock(&proc_subdir_lock);
 576         if (__xlate_proc_name(name, &parent, &fn) != 0) {
 577                 spin_unlock(&proc_subdir_lock);
 578                 return -ENOENT;
 579         }
 580         len = strlen(fn);
 581
 582         root = pde_subdir_find(parent, fn, len);
 583         if (!root) {
 584                 spin_unlock(&proc_subdir_lock);
 585                 return -ENOENT;
 586         }
 587         rb_erase(&root->subdir_node, &parent->subdir);
 588
 589         de = root;
 590         while (1) {
 591                 next = pde_subdir_first(de);
 592                 if (next) {
 593                         rb_erase(&next->subdir_node, &de->subdir);
 594                         de = next;
 595                         continue;
 596                 }
 597                 spin_unlock(&proc_subdir_lock);
 598
 599                 proc_entry_rundown(de);
 600                 next = de->parent;
 601                 if (S_ISDIR(de->mode))
 602                         next->nlink--;
 603                 de->nlink = 0;
 604                 if (de == root)
 605                         break;
 606                 pde_put(de);
 607
 608                 spin_lock(&proc_subdir_lock);
 609                 de = next;
 610         }
 611         pde_put(root);
 612         return 0;
 613 }
 614 EXPORT_SYMBOL(remove_proc_subtree);
 615
 616 void *proc_get_parent_data(const struct inode *inode)
 617 {
 618         struct proc_dir_entry *de = PDE(inode);
 619         return de->parent->data;
 620 }
 621 EXPORT_SYMBOL_GPL(proc_get_parent_data);
 622
 623 void proc_remove(struct proc_dir_entry *de)
 624 {
 625         if (de)
 626                 remove_proc_subtree(de->name, de->parent);
 627 }
 628 EXPORT_SYMBOL(proc_remove);
 629
 630 void *PDE_DATA(const struct inode *inode)
 631 {
 632         return __PDE_DATA(inode);
 633 }
 634 EXPORT_SYMBOL(PDE_DATA);