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