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