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/module.h>
  16 #include <linux/mount.h>
  17 #include <linux/smp_lock.h>
  18 #include <linux/init.h>
  19 #include <linux/idr.h>
  20 #include <linux/vs_base.h>
  21 #include <linux/vserver/inode.h>
  22 #include <linux/namei.h>
  23 #include <asm/uaccess.h>
  24 #include <asm/bitops.h>
  25
  26 static ssize_t proc_file_read(struct file *file, char __user *buf,
  27                               size_t nbytes, loff_t *ppos);
  28 static ssize_t proc_file_write(struct file *file, const char __user *buffer,
  29                                size_t count, loff_t *ppos);
  30 static loff_t proc_file_lseek(struct file *, loff_t, int);
  31
  32 int proc_match(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 struct file_operations proc_file_operations = {
  40         .llseek         = proc_file_lseek,
  41         .read           = proc_file_read,
  42         .write          = proc_file_write,
  43 };
  44
  45 /* buffer size is one page but our output routines use some slack for overruns */
  46 #define PROC_BLOCK_SIZE (PAGE_SIZE - 1024)
  47
  48 static ssize_t
  49 proc_file_read(struct file *file, char __user *buf, size_t nbytes,
  50                loff_t *ppos)
  51 {
  52         struct inode * inode = file->f_dentry->d_inode;
  53         char    *page;
  54         ssize_t retval=0;
  55         int     eof=0;
  56         ssize_t n, count;
  57         char    *start;
  58         struct proc_dir_entry * dp;
  59
  60         dp = PDE(inode);
  61         if (!(page = (char*) __get_free_page(GFP_KERNEL)))
  62                 return -ENOMEM;
  63
  64         while ((nbytes > 0) && !eof) {
  65                 count = min_t(ssize_t, PROC_BLOCK_SIZE, nbytes);
  66
  67                 start = NULL;
  68                 if (dp->get_info) {
  69                         /* Handle old net routines */
  70                         n = dp->get_info(page, &start, *ppos, count);
  71                         if (n < count)
  72                                 eof = 1;
  73                 } else if (dp->read_proc) {
  74                         /*
  75                          * How to be a proc read function
  76                          * ------------------------------
  77                          * Prototype:
  78                          *    int f(char *buffer, char **start, off_t offset,
  79                          *          int count, int *peof, void *dat)
  80                          *
  81                          * Assume that the buffer is "count" bytes in size.
  82                          *
  83                          * If you know you have supplied all the data you
  84                          * have, set *peof.
  85                          *
  86                          * You have three ways to return data:
  87                          * 0) Leave *start = NULL.  (This is the default.)
  88                          *    Put the data of the requested offset at that
  89                          *    offset within the buffer.  Return the number (n)
  90                          *    of bytes there are from the beginning of the
  91                          *    buffer up to the last byte of data.  If the
  92                          *    number of supplied bytes (= n - offset) is
  93                          *    greater than zero and you didn't signal eof
  94                          *    and the reader is prepared to take more data
  95                          *    you will be called again with the requested
  96                          *    offset advanced by the number of bytes
  97                          *    absorbed.  This interface is useful for files
  98                          *    no larger than the buffer.
  99                          * 1) Set *start = an unsigned long value less than
 100                          *    the buffer address but greater than zero.
 101                          *    Put the data of the requested offset at the
 102                          *    beginning of the buffer.  Return the number of
 103                          *    bytes of data placed there.  If this number is
 104                          *    greater than zero and you didn't signal eof
 105                          *    and the reader is prepared to take more data
 106                          *    you will be called again with the requested
 107                          *    offset advanced by *start.  This interface is
 108                          *    useful when you have a large file consisting
 109                          *    of a series of blocks which you want to count
 110                          *    and return as wholes.
 111                          *    (Hack by Paul.Russell@rustcorp.com.au)
 112                          * 2) Set *start = an address within the buffer.
 113                          *    Put the data of the requested offset at *start.
 114                          *    Return the number of bytes of data placed there.
 115                          *    If this number is greater than zero and you
 116                          *    didn't signal eof and the reader is prepared to
 117                          *    take more data you will be called again with the
 118                          *    requested offset advanced by the number of bytes
 119                          *    absorbed.
 120                          */
 121                         n = dp->read_proc(page, &start, *ppos,
 122                                           count, &eof, dp->data);
 123                 } else
 124                         break;
 125
 126                 if (n == 0)   /* end of file */
 127                         break;
 128                 if (n < 0) {  /* error */
 129                         if (retval == 0)
 130                                 retval = n;
 131                         break;
 132                 }
 133
 134                 if (start == NULL) {
 135                         if (n > PAGE_SIZE) {
 136                                 printk(KERN_ERR
 137                                        "proc_file_read: Apparent buffer overflow!\n");
 138                                 n = PAGE_SIZE;
 139                         }
 140                         n -= *ppos;
 141                         if (n <= 0)
 142                                 break;
 143                         if (n > count)
 144                                 n = count;
 145                         start = page + *ppos;
 146                 } else if (start < page) {
 147                         if (n > PAGE_SIZE) {
 148                                 printk(KERN_ERR
 149                                        "proc_file_read: Apparent buffer overflow!\n");
 150                                 n = PAGE_SIZE;
 151                         }
 152                         if (n > count) {
 153                                 /*
 154                                  * Don't reduce n because doing so might
 155                                  * cut off part of a data block.
 156                                  */
 157                                 printk(KERN_WARNING
 158                                        "proc_file_read: Read count exceeded\n");
 159                         }
 160                 } else /* start >= page */ {
 161                         unsigned long startoff = (unsigned long)(start - page);
 162                         if (n > (PAGE_SIZE - startoff)) {
 163                                 printk(KERN_ERR
 164                                        "proc_file_read: Apparent buffer overflow!\n");
 165                                 n = PAGE_SIZE - startoff;
 166                         }
 167                         if (n > count)
 168                                 n = count;
 169                 }
 170
 171                 n -= copy_to_user(buf, start < page ? page : start, n);
 172                 if (n == 0) {
 173                         if (retval == 0)
 174                                 retval = -EFAULT;
 175                         break;
 176                 }
 177
 178                 *ppos += start < page ? (unsigned long)start : n;
 179                 nbytes -= n;
 180                 buf += n;
 181                 retval += n;
 182         }
 183         free_page((unsigned long) page);
 184         return retval;
 185 }
 186
 187 static ssize_t
 188 proc_file_write(struct file *file, const char __user *buffer,
 189                 size_t count, loff_t *ppos)
 190 {
 191         struct inode *inode = file->f_dentry->d_inode;
 192         struct proc_dir_entry * dp;
 193
 194         dp = PDE(inode);
 195
 196         if (!dp->write_proc)
 197                 return -EIO;
 198
 199         /* FIXME: does this routine need ppos?  probably... */
 200         return dp->write_proc(file, buffer, count, dp->data);
 201 }
 202
 203
 204 static loff_t
 205 proc_file_lseek(struct file *file, loff_t offset, int orig)
 206 {
 207     lock_kernel();
 208
 209     switch (orig) {
 210     case 0:
 211         if (offset < 0)
 212             goto out;
 213         file->f_pos = offset;
 214         unlock_kernel();
 215         return(file->f_pos);
 216     case 1:
 217         if (offset + file->f_pos < 0)
 218             goto out;
 219         file->f_pos += offset;
 220         unlock_kernel();
 221         return(file->f_pos);
 222     case 2:
 223         goto out;
 224     default:
 225         goto out;
 226     }
 227
 228 out:
 229     unlock_kernel();
 230     return -EINVAL;
 231 }
 232
 233 static int proc_notify_change(struct dentry *dentry, struct iattr *iattr)
 234 {
 235         struct inode *inode = dentry->d_inode;
 236         struct proc_dir_entry *de = PDE(inode);
 237         int error;
 238
 239         error = inode_change_ok(inode, iattr);
 240         if (error)
 241                 goto out;
 242
 243         error = inode_setattr(inode, iattr);
 244         if (error)
 245                 goto out;
 246
 247         de->uid = inode->i_uid;
 248         de->gid = inode->i_gid;
 249         de->mode = inode->i_mode;
 250 out:
 251         return error;
 252 }
 253
 254 static struct inode_operations proc_file_inode_operations = {
 255         .setattr        = proc_notify_change,
 256 };
 257
 258 /*
 259  * This function parses a name such as "tty/driver/serial", and
 260  * returns the struct proc_dir_entry for "/proc/tty/driver", and
 261  * returns "serial" in residual.
 262  */
 263 static int xlate_proc_name(const char *name,
 264                            struct proc_dir_entry **ret, const char **residual)
 265 {
 266         const char              *cp = name, *next;
 267         struct proc_dir_entry   *de;
 268         int                     len;
 269
 270         de = &proc_root;
 271         while (1) {
 272                 next = strchr(cp, '/');
 273                 if (!next)
 274                         break;
 275
 276                 len = next - cp;
 277                 for (de = de->subdir; de ; de = de->next) {
 278                         if (proc_match(len, cp, de))
 279                                 break;
 280                 }
 281                 if (!de)
 282                         return -ENOENT;
 283                 cp += len + 1;
 284         }
 285         *residual = cp;
 286         *ret = de;
 287         return 0;
 288 }
 289
 290 static DEFINE_IDR(proc_inum_idr);
 291 static spinlock_t proc_inum_lock = SPIN_LOCK_UNLOCKED; /* protects the above */
 292
 293 #define PROC_DYNAMIC_FIRST 0xF0000000UL
 294
 295 /*
 296  * Return an inode number between PROC_DYNAMIC_FIRST and
 297  * 0xffffffff, or zero on failure.
 298  */
 299 static unsigned int get_inode_number(void)
 300 {
 301         int i, inum = 0;
 302         int error;
 303
 304 retry:
 305         if (idr_pre_get(&proc_inum_idr, GFP_KERNEL) == 0)
 306                 return 0;
 307
 308         spin_lock(&proc_inum_lock);
 309         error = idr_get_new(&proc_inum_idr, NULL, &i);
 310         spin_unlock(&proc_inum_lock);
 311         if (error == -EAGAIN)
 312                 goto retry;
 313         else if (error)
 314                 return 0;
 315
 316         inum = (i & MAX_ID_MASK) + PROC_DYNAMIC_FIRST;
 317
 318         /* inum will never be more than 0xf0ffffff, so no check
 319          * for overflow.
 320          */
 321
 322         return inum;
 323 }
 324
 325 static void release_inode_number(unsigned int inum)
 326 {
 327         int id = (inum - PROC_DYNAMIC_FIRST) | ~MAX_ID_MASK;
 328
 329         spin_lock(&proc_inum_lock);
 330         idr_remove(&proc_inum_idr, id);
 331         spin_unlock(&proc_inum_lock);
 332 }
 333
 334 static int proc_follow_link(struct dentry *dentry, struct nameidata *nd)
 335 {
 336         nd_set_link(nd, PDE(dentry->d_inode)->data);
 337         return 0;
 338 }
 339
 340 static struct inode_operations proc_link_inode_operations = {
 341         .readlink       = generic_readlink,
 342         .follow_link    = proc_follow_link,
 343 };
 344
 345 /*
 346  * As some entries in /proc are volatile, we want to
 347  * get rid of unused dentries.  This could be made
 348  * smarter: we could keep a "volatile" flag in the
 349  * inode to indicate which ones to keep.
 350  */
 351 static int proc_delete_dentry(struct dentry * dentry)
 352 {
 353         return 1;
 354 }
 355
 356 static int proc_revalidate_dentry(struct dentry *de, struct nameidata *nd)
 357 {
 358         /* maybe add a check if it's really necessary? */
 359         return 0;
 360 }
 361
 362 static struct dentry_operations proc_dentry_operations =
 363 {
 364         .d_revalidate   = proc_revalidate_dentry,
 365         .d_delete       = proc_delete_dentry,
 366 };
 367
 368 /*
 369  * Don't create negative dentries here, return -ENOENT by hand
 370  * instead.
 371  */
 372 struct dentry *proc_lookup(struct inode * dir, struct dentry *dentry, struct nameidata *nd)
 373 {
 374         struct inode *inode = NULL;
 375         struct proc_dir_entry * de;
 376         int error = -ENOENT;
 377
 378         lock_kernel();
 379         de = PDE(dir);
 380         if (de) {
 381                 for (de = de->subdir; de ; de = de->next) {
 382                         if (de->namelen != dentry->d_name.len)
 383                                 continue;
 384                         if (!vx_hide_check(0, de->vx_flags))
 385                                 continue;
 386                         if (!memcmp(dentry->d_name.name, de->name, de->namelen)) {
 387                                 unsigned int ino = de->low_ino;
 388
 389                                 error = -EINVAL;
 390                                 inode = proc_get_inode(dir->i_sb, ino, de);
 391                                 break;
 392                         }
 393                 }
 394         }
 395         unlock_kernel();
 396
 397         if (inode) {
 398                 dentry->d_op = &proc_dentry_operations;
 399                 d_add(dentry, inode);
 400                 return NULL;
 401         }
 402         return ERR_PTR(error);
 403 }
 404
 405 /*
 406  * This returns non-zero if at EOF, so that the /proc
 407  * root directory can use this and check if it should
 408  * continue with the <pid> entries..
 409  *
 410  * Note that the VFS-layer doesn't care about the return
 411  * value of the readdir() call, as long as it's non-negative
 412  * for success..
 413  */
 414 int proc_readdir(struct file * filp,
 415         void * dirent, filldir_t filldir)
 416 {
 417         struct proc_dir_entry * de;
 418         unsigned int ino;
 419         int i;
 420         struct inode *inode = filp->f_dentry->d_inode;
 421         int ret = 0;
 422
 423         lock_kernel();
 424
 425         ino = inode->i_ino;
 426         de = PDE(inode);
 427         if (!de) {
 428                 ret = -EINVAL;
 429                 goto out;
 430         }
 431         i = filp->f_pos;
 432         switch (i) {
 433                 case 0:
 434                         if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
 435                                 goto out;
 436                         i++;
 437                         filp->f_pos++;
 438                         /* fall through */
 439                 case 1:
 440                         if (filldir(dirent, "..", 2, i,
 441                                     parent_ino(filp->f_dentry),
 442                                     DT_DIR) < 0)
 443                                 goto out;
 444                         i++;
 445                         filp->f_pos++;
 446                         /* fall through */
 447                 default:
 448                         de = de->subdir;
 449                         i -= 2;
 450                         for (;;) {
 451                                 if (!de) {
 452                                         ret = 1;
 453                                         goto out;
 454                                 }
 455                                 if (!i)
 456                                         break;
 457                                 de = de->next;
 458                                 i--;
 459                         }
 460
 461                         do {
 462                                 if (!vx_hide_check(0, de->vx_flags))
 463                                         goto skip;
 464                                 if (filldir(dirent, de->name, de->namelen, filp->f_pos,
 465                                             de->low_ino, de->mode >> 12) < 0)
 466                                         goto out;
 467                         skip:
 468                                 filp->f_pos++;
 469                                 de = de->next;
 470                         } while (de);
 471         }
 472         ret = 1;
 473 out:    unlock_kernel();
 474         return ret;
 475 }
 476
 477 /*
 478  * These are the generic /proc directory operations. They
 479  * use the in-memory "struct proc_dir_entry" tree to parse
 480  * the /proc directory.
 481  */
 482 static struct file_operations proc_dir_operations = {
 483         .read                   = generic_read_dir,
 484         .readdir                = proc_readdir,
 485 };
 486
 487 /*
 488  * proc directories can do almost nothing..
 489  */
 490 static struct inode_operations proc_dir_inode_operations = {
 491         .lookup         = proc_lookup,
 492         .setattr        = proc_notify_change,
 493 };
 494
 495 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
 496 {
 497         unsigned int i;
 498
 499         i = get_inode_number();
 500         if (i == 0)
 501                 return -EAGAIN;
 502         dp->low_ino = i;
 503         dp->next = dir->subdir;
 504         dp->parent = dir;
 505         dir->subdir = dp;
 506         if (S_ISDIR(dp->mode)) {
 507                 if (dp->proc_iops == NULL) {
 508                         dp->proc_fops = &proc_dir_operations;
 509                         dp->proc_iops = &proc_dir_inode_operations;
 510                 }
 511                 dir->nlink++;
 512         } else if (S_ISLNK(dp->mode)) {
 513                 if (dp->proc_iops == NULL)
 514                         dp->proc_iops = &proc_link_inode_operations;
 515         } else if (S_ISREG(dp->mode)) {
 516                 if (dp->proc_fops == NULL)
 517                         dp->proc_fops = &proc_file_operations;
 518                 if (dp->proc_iops == NULL)
 519                         dp->proc_iops = &proc_file_inode_operations;
 520         }
 521         return 0;
 522 }
 523
 524 /*
 525  * Kill an inode that got unregistered..
 526  */
 527 static void proc_kill_inodes(struct proc_dir_entry *de)
 528 {
 529         struct list_head *p;
 530         struct super_block *sb = proc_mnt->mnt_sb;
 531
 532         /*
 533          * Actually it's a partial revoke().
 534          */
 535         file_list_lock();
 536         list_for_each(p, &sb->s_files) {
 537                 struct file * filp = list_entry(p, struct file, f_list);
 538                 struct dentry * dentry = filp->f_dentry;
 539                 struct inode * inode;
 540                 struct file_operations *fops;
 541
 542                 if (dentry->d_op != &proc_dentry_operations)
 543                         continue;
 544                 inode = dentry->d_inode;
 545                 if (PDE(inode) != de)
 546                         continue;
 547                 fops = filp->f_op;
 548                 filp->f_op = NULL;
 549                 fops_put(fops);
 550         }
 551         file_list_unlock();
 552 }
 553
 554 static struct proc_dir_entry *proc_create(struct proc_dir_entry **parent,
 555                                           const char *name,
 556                                           mode_t mode,
 557                                           nlink_t nlink)
 558 {
 559         struct proc_dir_entry *ent = NULL;
 560         const char *fn = name;
 561         int len;
 562
 563         /* make sure name is valid */
 564         if (!name || !strlen(name)) goto out;
 565
 566         if (!(*parent) && xlate_proc_name(name, parent, &fn) != 0)
 567                 goto out;
 568         len = strlen(fn);
 569
 570         ent = kmalloc(sizeof(struct proc_dir_entry) + len + 1, GFP_KERNEL);
 571         if (!ent) goto out;
 572
 573         memset(ent, 0, sizeof(struct proc_dir_entry));
 574         memcpy(((char *) ent) + sizeof(struct proc_dir_entry), fn, len + 1);
 575         ent->name = ((char *) ent) + sizeof(*ent);
 576         ent->namelen = len;
 577         ent->mode = mode;
 578         ent->nlink = nlink;
 579         ent->vx_flags = IATTR_PROC_DEFAULT;
 580  out:
 581         return ent;
 582 }
 583
 584 struct proc_dir_entry *proc_symlink(const char *name,
 585                 struct proc_dir_entry *parent, const char *dest)
 586 {
 587         struct proc_dir_entry *ent;
 588
 589         ent = proc_create(&parent,name,
 590                           (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
 591
 592         if (ent) {
 593                 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
 594                 if (ent->data) {
 595                         strcpy((char*)ent->data,dest);
 596                         if (proc_register(parent, ent) < 0) {
 597                                 kfree(ent->data);
 598                                 kfree(ent);
 599                                 ent = NULL;
 600                         } else
 601                                 ent->vx_flags = IATTR_PROC_SYMLINK;
 602                 } else {
 603                         kfree(ent);
 604                         ent = NULL;
 605                 }
 606         }
 607         return ent;
 608 }
 609
 610 struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 611                 struct proc_dir_entry *parent)
 612 {
 613         struct proc_dir_entry *ent;
 614
 615         ent = proc_create(&parent, name, S_IFDIR | mode, 2);
 616         if (ent) {
 617                 ent->proc_fops = &proc_dir_operations;
 618                 ent->proc_iops = &proc_dir_inode_operations;
 619
 620                 if (proc_register(parent, ent) < 0) {
 621                         kfree(ent);
 622                         ent = NULL;
 623                 }
 624         }
 625         return ent;
 626 }
 627
 628 struct proc_dir_entry *proc_mkdir(const char *name,
 629                 struct proc_dir_entry *parent)
 630 {
 631         return proc_mkdir_mode(name, S_IRUGO | S_IXUGO, parent);
 632 }
 633
 634 struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 635                                          struct proc_dir_entry *parent)
 636 {
 637         struct proc_dir_entry *ent;
 638         nlink_t nlink;
 639
 640         if (S_ISDIR(mode)) {
 641                 if ((mode & S_IALLUGO) == 0)
 642                         mode |= S_IRUGO | S_IXUGO;
 643                 nlink = 2;
 644         } else {
 645                 if ((mode & S_IFMT) == 0)
 646                         mode |= S_IFREG;
 647                 if ((mode & S_IALLUGO) == 0)
 648                         mode |= S_IRUGO;
 649                 nlink = 1;
 650         }
 651
 652         ent = proc_create(&parent,name,mode,nlink);
 653         if (ent) {
 654                 if (S_ISDIR(mode)) {
 655                         ent->proc_fops = &proc_dir_operations;
 656                         ent->proc_iops = &proc_dir_inode_operations;
 657                 }
 658                 if (proc_register(parent, ent) < 0) {
 659                         kfree(ent);
 660                         ent = NULL;
 661                 }
 662         }
 663         return ent;
 664 }
 665
 666 void free_proc_entry(struct proc_dir_entry *de)
 667 {
 668         unsigned int ino = de->low_ino;
 669
 670         if (ino < PROC_DYNAMIC_FIRST)
 671                 return;
 672
 673         release_inode_number(ino);
 674
 675         if (S_ISLNK(de->mode) && de->data)
 676                 kfree(de->data);
 677         kfree(de);
 678 }
 679
 680 /*
 681  * Remove a /proc entry and free it if it's not currently in use.
 682  * If it is in use, we set the 'deleted' flag.
 683  */
 684 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
 685 {
 686         struct proc_dir_entry **p;
 687         struct proc_dir_entry *de;
 688         const char *fn = name;
 689         int len;
 690
 691         if (!parent && xlate_proc_name(name, &parent, &fn) != 0)
 692                 goto out;
 693         len = strlen(fn);
 694         for (p = &parent->subdir; *p; p=&(*p)->next ) {
 695                 if (!proc_match(len, fn, *p))
 696                         continue;
 697                 de = *p;
 698                 *p = de->next;
 699                 de->next = NULL;
 700                 if (S_ISDIR(de->mode))
 701                         parent->nlink--;
 702                 proc_kill_inodes(de);
 703                 de->nlink = 0;
 704                 BUG_ON(de->subdir);
 705                 if (!atomic_read(&de->count))
 706                         free_proc_entry(de);
 707                 else {
 708                         de->deleted = 1;
 709                         printk("remove_proc_entry: %s/%s busy, count=%d\n",
 710                                 parent->name, de->name, atomic_read(&de->count));
 711                 }
 712                 break;
 713         }
 714 out:
 715         return;
 716 }