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/hardirq.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/slab.h>
  19 #include <linux/printk.h>
  20 #include <linux/mount.h>
  21 #include <linux/init.h>
  22 #include <linux/idr.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, (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : 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 /*
 167  * As some entries in /proc are volatile, we want to
 168  * get rid of unused dentries.  This could be made
 169  * smarter: we could keep a "volatile" flag in the
 170  * inode to indicate which ones to keep.
 171  */
 172 static int proc_delete_dentry(const struct dentry * dentry)
 173 {
 174         return 1;
 175 }
 176
 177 static const struct dentry_operations proc_dentry_operations =
 178 {
 179         .d_delete       = proc_delete_dentry,
 180 };
 181
 182 /*
 183  * Don't create negative dentries here, return -ENOENT by hand
 184  * instead.
 185  */
 186 struct dentry *proc_lookup_de(struct proc_dir_entry *de, struct inode *dir,
 187                 struct dentry *dentry)
 188 {
 189         struct inode *inode;
 190
 191         spin_lock(&proc_subdir_lock);
 192         for (de = de->subdir; de ; de = de->next) {
 193                 if (de->namelen != dentry->d_name.len)
 194                         continue;
 195                 if (!memcmp(dentry->d_name.name, de->name, de->namelen)) {
 196                         pde_get(de);
 197                         spin_unlock(&proc_subdir_lock);
 198                         inode = proc_get_inode(dir->i_sb, de);
 199                         if (!inode)
 200                                 return ERR_PTR(-ENOMEM);
 201                         d_set_d_op(dentry, &proc_dentry_operations);
 202                         d_add(dentry, inode);
 203                         return NULL;
 204                 }
 205         }
 206         spin_unlock(&proc_subdir_lock);
 207         return ERR_PTR(-ENOENT);
 208 }
 209
 210 struct dentry *proc_lookup(struct inode *dir, struct dentry *dentry,
 211                 unsigned int flags)
 212 {
 213         return proc_lookup_de(PDE(dir), dir, dentry);
 214 }
 215
 216 /*
 217  * This returns non-zero if at EOF, so that the /proc
 218  * root directory can use this and check if it should
 219  * continue with the <pid> entries..
 220  *
 221  * Note that the VFS-layer doesn't care about the return
 222  * value of the readdir() call, as long as it's non-negative
 223  * for success..
 224  */
 225 int proc_readdir_de(struct proc_dir_entry *de, struct file *filp, void *dirent,
 226                 filldir_t filldir)
 227 {
 228         unsigned int ino;
 229         int i;
 230         struct inode *inode = file_inode(filp);
 231         int ret = 0;
 232
 233         ino = inode->i_ino;
 234         i = filp->f_pos;
 235         switch (i) {
 236                 case 0:
 237                         if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
 238                                 goto out;
 239                         i++;
 240                         filp->f_pos++;
 241                         /* fall through */
 242                 case 1:
 243                         if (filldir(dirent, "..", 2, i,
 244                                     parent_ino(filp->f_path.dentry),
 245                                     DT_DIR) < 0)
 246                                 goto out;
 247                         i++;
 248                         filp->f_pos++;
 249                         /* fall through */
 250                 default:
 251                         spin_lock(&proc_subdir_lock);
 252                         de = de->subdir;
 253                         i -= 2;
 254                         for (;;) {
 255                                 if (!de) {
 256                                         ret = 1;
 257                                         spin_unlock(&proc_subdir_lock);
 258                                         goto out;
 259                                 }
 260                                 if (!i)
 261                                         break;
 262                                 de = de->next;
 263                                 i--;
 264                         }
 265
 266                         do {
 267                                 struct proc_dir_entry *next;
 268
 269                                 /* filldir passes info to user space */
 270                                 pde_get(de);
 271                                 spin_unlock(&proc_subdir_lock);
 272                                 if (filldir(dirent, de->name, de->namelen, filp->f_pos,
 273                                             de->low_ino, de->mode >> 12) < 0) {
 274                                         pde_put(de);
 275                                         goto out;
 276                                 }
 277                                 spin_lock(&proc_subdir_lock);
 278                                 filp->f_pos++;
 279                                 next = de->next;
 280                                 pde_put(de);
 281                                 de = next;
 282                         } while (de);
 283                         spin_unlock(&proc_subdir_lock);
 284         }
 285         ret = 1;
 286 out:
 287         return ret;
 288 }
 289
 290 int proc_readdir(struct file *filp, void *dirent, filldir_t filldir)
 291 {
 292         struct inode *inode = file_inode(filp);
 293
 294         return proc_readdir_de(PDE(inode), filp, dirent, filldir);
 295 }
 296
 297 /*
 298  * These are the generic /proc directory operations. They
 299  * use the in-memory "struct proc_dir_entry" tree to parse
 300  * the /proc directory.
 301  */
 302 static const struct file_operations proc_dir_operations = {
 303         .llseek                 = generic_file_llseek,
 304         .read                   = generic_read_dir,
 305         .readdir                = proc_readdir,
 306 };
 307
 308 /*
 309  * proc directories can do almost nothing..
 310  */
 311 static const struct inode_operations proc_dir_inode_operations = {
 312         .lookup         = proc_lookup,
 313         .getattr        = proc_getattr,
 314         .setattr        = proc_notify_change,
 315 };
 316
 317 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
 318 {
 319         struct proc_dir_entry *tmp;
 320         int ret;
 321
 322         ret = proc_alloc_inum(&dp->low_ino);
 323         if (ret)
 324                 return ret;
 325
 326         if (S_ISDIR(dp->mode)) {
 327                 dp->proc_fops = &proc_dir_operations;
 328                 dp->proc_iops = &proc_dir_inode_operations;
 329                 dir->nlink++;
 330         } else if (S_ISLNK(dp->mode)) {
 331                 dp->proc_iops = &proc_link_inode_operations;
 332         } else if (S_ISREG(dp->mode)) {
 333                 BUG_ON(dp->proc_fops == NULL);
 334                 dp->proc_iops = &proc_file_inode_operations;
 335         } else {
 336                 WARN_ON(1);
 337                 return -EINVAL;
 338         }
 339
 340         spin_lock(&proc_subdir_lock);
 341
 342         for (tmp = dir->subdir; tmp; tmp = tmp->next)
 343                 if (strcmp(tmp->name, dp->name) == 0) {
 344                         WARN(1, "proc_dir_entry '%s/%s' already registered\n",
 345                                 dir->name, dp->name);
 346                         break;
 347                 }
 348
 349         dp->next = dir->subdir;
 350         dp->parent = dir;
 351         dir->subdir = dp;
 352         spin_unlock(&proc_subdir_lock);
 353
 354         return 0;
 355 }
 356
 357 static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
 358                                           const char *name,
 359                                           umode_t mode,
 360                                           nlink_t nlink)
 361 {
 362         struct proc_dir_entry *ent = NULL;
 363         const char *fn = name;
 364         unsigned int len;
 365
 366         /* make sure name is valid */
 367         if (!name || !strlen(name))
 368                 goto out;
 369
 370         if (xlate_proc_name(name, parent, &fn) != 0)
 371                 goto out;
 372
 373         /* At this point there must not be any '/' characters beyond *fn */
 374         if (strchr(fn, '/'))
 375                 goto out;
 376
 377         len = strlen(fn);
 378
 379         ent = kzalloc(sizeof(struct proc_dir_entry) + len + 1, (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL);
 380         if (!ent)
 381                 goto out;
 382
 383         memcpy(ent->name, fn, len + 1);
 384         ent->namelen = len;
 385         ent->mode = mode;
 386         ent->nlink = nlink;
 387         atomic_set(&ent->count, 1);
 388         spin_lock_init(&ent->pde_unload_lock);
 389         INIT_LIST_HEAD(&ent->pde_openers);
 390 out:
 391         return ent;
 392 }
 393
 394 struct proc_dir_entry *proc_symlink(const char *name,
 395                 struct proc_dir_entry *parent, const char *dest)
 396 {
 397         struct proc_dir_entry *ent;
 398
 399         ent = __proc_create(&parent, name,
 400                           (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
 401
 402         if (ent) {
 403                 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
 404                 if (ent->data) {
 405                         strcpy((char*)ent->data,dest);
 406                         if (proc_register(parent, ent) < 0) {
 407                                 kfree(ent->data);
 408                                 kfree(ent);
 409                                 ent = NULL;
 410                         }
 411                 } else {
 412                         kfree(ent);
 413                         ent = NULL;
 414                 }
 415         }
 416         return ent;
 417 }
 418 EXPORT_SYMBOL(proc_symlink);
 419
 420 struct proc_dir_entry *proc_mkdir_data(const char *name, umode_t mode,
 421                 struct proc_dir_entry *parent, void *data)
 422 {
 423         struct proc_dir_entry *ent;
 424
 425         if (mode == 0)
 426                 mode = S_IRUGO | S_IXUGO;
 427
 428         ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
 429         if (ent) {
 430                 ent->data = data;
 431                 if (proc_register(parent, ent) < 0) {
 432                         kfree(ent);
 433                         ent = NULL;
 434                 }
 435         }
 436         return ent;
 437 }
 438 EXPORT_SYMBOL_GPL(proc_mkdir_data);
 439
 440 struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 441                                        struct proc_dir_entry *parent)
 442 {
 443         return proc_mkdir_data(name, mode, parent, NULL);
 444 }
 445 EXPORT_SYMBOL(proc_mkdir_mode);
 446
 447 struct proc_dir_entry *proc_mkdir(const char *name,
 448                 struct proc_dir_entry *parent)
 449 {
 450         return proc_mkdir_data(name, 0, parent, NULL);
 451 }
 452 EXPORT_SYMBOL(proc_mkdir);
 453
 454 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 455                                         struct proc_dir_entry *parent,
 456                                         const struct file_operations *proc_fops,
 457                                         void *data)
 458 {
 459         struct proc_dir_entry *pde;
 460         if ((mode & S_IFMT) == 0)
 461                 mode |= S_IFREG;
 462
 463         if (!S_ISREG(mode)) {
 464                 WARN_ON(1);     /* use proc_mkdir() */
 465                 return NULL;
 466         }
 467
 468         if ((mode & S_IALLUGO) == 0)
 469                 mode |= S_IRUGO;
 470         pde = __proc_create(&parent, name, mode, 1);
 471         if (!pde)
 472                 goto out;
 473         pde->proc_fops = proc_fops;
 474         pde->data = data;
 475         if (proc_register(parent, pde) < 0)
 476                 goto out_free;
 477         return pde;
 478 out_free:
 479         kfree(pde);
 480 out:
 481         return NULL;
 482 }
 483 EXPORT_SYMBOL(proc_create_data);
 484
 485 void proc_set_size(struct proc_dir_entry *de, loff_t size)
 486 {
 487         de->size = size;
 488 }
 489 EXPORT_SYMBOL(proc_set_size);
 490
 491 void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid)
 492 {
 493         de->uid = uid;
 494         de->gid = gid;
 495 }
 496 EXPORT_SYMBOL(proc_set_user);
 497
 498 static void free_proc_entry(struct proc_dir_entry *de)
 499 {
 500         proc_free_inum(de->low_ino);
 501
 502         if (S_ISLNK(de->mode))
 503                 kfree(de->data);
 504         kfree(de);
 505 }
 506
 507 void pde_put(struct proc_dir_entry *pde)
 508 {
 509         if (atomic_dec_and_test(&pde->count))
 510                 free_proc_entry(pde);
 511 }
 512
 513 /*
 514  * Remove a /proc entry and free it if it's not currently in use.
 515  */
 516 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
 517 {
 518         struct proc_dir_entry **p;
 519         struct proc_dir_entry *de = NULL;
 520         const char *fn = name;
 521         unsigned int len;
 522
 523         spin_lock(&proc_subdir_lock);
 524         if (__xlate_proc_name(name, &parent, &fn) != 0) {
 525                 spin_unlock(&proc_subdir_lock);
 526                 return;
 527         }
 528         len = strlen(fn);
 529
 530         for (p = &parent->subdir; *p; p=&(*p)->next ) {
 531                 if (proc_match(len, fn, *p)) {
 532                         de = *p;
 533                         *p = de->next;
 534                         de->next = NULL;
 535                         break;
 536                 }
 537         }
 538         spin_unlock(&proc_subdir_lock);
 539         if (!de) {
 540                 WARN(1, "name '%s'\n", name);
 541                 return;
 542         }
 543
 544         proc_entry_rundown(de);
 545
 546         if (S_ISDIR(de->mode))
 547                 parent->nlink--;
 548         de->nlink = 0;
 549         WARN(de->subdir, "%s: removing non-empty directory "
 550                          "'%s/%s', leaking at least '%s'\n", __func__,
 551                          de->parent->name, de->name, de->subdir->name);
 552         pde_put(de);
 553 }
 554 EXPORT_SYMBOL(remove_proc_entry);
 555
 556 int remove_proc_subtree(const char *name, struct proc_dir_entry *parent)
 557 {
 558         struct proc_dir_entry **p;
 559         struct proc_dir_entry *root = NULL, *de, *next;
 560         const char *fn = name;
 561         unsigned int len;
 562
 563         spin_lock(&proc_subdir_lock);
 564         if (__xlate_proc_name(name, &parent, &fn) != 0) {
 565                 spin_unlock(&proc_subdir_lock);
 566                 return -ENOENT;
 567         }
 568         len = strlen(fn);
 569
 570         for (p = &parent->subdir; *p; p=&(*p)->next ) {
 571                 if (proc_match(len, fn, *p)) {
 572                         root = *p;
 573                         *p = root->next;
 574                         root->next = NULL;
 575                         break;
 576                 }
 577         }
 578         if (!root) {
 579                 spin_unlock(&proc_subdir_lock);
 580                 return -ENOENT;
 581         }
 582         de = root;
 583         while (1) {
 584                 next = de->subdir;
 585                 if (next) {
 586                         de->subdir = next->next;
 587                         next->next = NULL;
 588                         de = next;
 589                         continue;
 590                 }
 591                 spin_unlock(&proc_subdir_lock);
 592
 593                 proc_entry_rundown(de);
 594                 next = de->parent;
 595                 if (S_ISDIR(de->mode))
 596                         next->nlink--;
 597                 de->nlink = 0;
 598                 if (de == root)
 599                         break;
 600                 pde_put(de);
 601
 602                 spin_lock(&proc_subdir_lock);
 603                 de = next;
 604         }
 605         pde_put(root);
 606         return 0;
 607 }
 608 EXPORT_SYMBOL(remove_proc_subtree);
 609
 610 void *proc_get_parent_data(const struct inode *inode)
 611 {
 612         struct proc_dir_entry *de = PDE(inode);
 613         return de->parent->data;
 614 }
 615 EXPORT_SYMBOL_GPL(proc_get_parent_data);
 616
 617 void proc_remove(struct proc_dir_entry *de)
 618 {
 619         if (de)
 620                 remove_proc_subtree(de->name, de->parent);
 621 }
 622 EXPORT_SYMBOL(proc_remove);
 623
 624 void *PDE_DATA(const struct inode *inode)
 625 {
 626         return __PDE_DATA(inode);
 627 }
 628 EXPORT_SYMBOL(PDE_DATA);