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