fs/sysfs/file.c

   1 /*
   2  * fs/sysfs/file.c - sysfs regular (text) file implementation
   3  *
   4  * Copyright (c) 2001-3 Patrick Mochel
   5  * Copyright (c) 2007 SUSE Linux Products GmbH
   6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   7  *
   8  * This file is released under the GPLv2.
   9  *
  10  * Please see Documentation/filesystems/sysfs.txt for more information.
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/kobject.h>
  15 #include <linux/kallsyms.h>
  16 #include <linux/slab.h>
  17 #include <linux/fsnotify.h>
  18 #include <linux/namei.h>
  19 #include <linux/poll.h>
  20 #include <linux/list.h>
  21 #include <linux/mutex.h>
  22 #include <linux/limits.h>
  23 #include <linux/uaccess.h>
  24
  25 #include "sysfs.h"
  26
  27 /*
  28  * There's one sysfs_open_file for each open file and one sysfs_open_dirent
  29  * for each sysfs_dirent with one or more open files.
  30  *
  31  * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open is
  32  * protected by sysfs_open_dirent_lock.
  33  *
  34  * filp->private_data points to sysfs_open_file which is chained at
  35  * sysfs_open_dirent->files, which is protected by sysfs_open_file_mutex.
  36  */
  37 static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
  38 static DEFINE_MUTEX(sysfs_open_file_mutex);
  39
  40 struct sysfs_open_dirent {
  41         atomic_t                refcnt;
  42         atomic_t                event;
  43         wait_queue_head_t       poll;
  44         struct list_head        files; /* goes through sysfs_open_file.list */
  45 };
  46
  47 struct sysfs_open_file {
  48         size_t                  count;
  49         char                    *page;
  50         struct mutex            mutex;
  51         int                     event;
  52         struct list_head        list;
  53 };
  54
  55 /*
  56  * Determine ktype->sysfs_ops for the given sysfs_dirent.  This function
  57  * must be called while holding an active reference.
  58  */
  59 static const struct sysfs_ops *sysfs_file_ops(struct sysfs_dirent *sd)
  60 {
  61         struct kobject *kobj = sd->s_parent->s_dir.kobj;
  62
  63         lockdep_assert_held(sd);
  64         return kobj->ktype ? kobj->ktype->sysfs_ops : NULL;
  65 }
  66
  67 /**
  68  *      fill_read_buffer - allocate and fill buffer from object.
  69  *      @dentry:        dentry pointer.
  70  *      @buffer:        data buffer for file.
  71  *
  72  *      Allocate @buffer->page, if it hasn't been already, then call the
  73  *      kobject's show() method to fill the buffer with this attribute's
  74  *      data.
  75  *      This is called only once, on the file's first read unless an error
  76  *      is returned.
  77  */
  78 static int fill_read_buffer(struct dentry *dentry, struct sysfs_open_file *of)
  79 {
  80         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
  81         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
  82         const struct sysfs_ops *ops;
  83         int ret = 0;
  84         ssize_t count;
  85
  86         if (!of->page)
  87                 of->page = (char *) get_zeroed_page(GFP_KERNEL);
  88         if (!of->page)
  89                 return -ENOMEM;
  90
  91         /* need attr_sd for attr and ops, its parent for kobj */
  92         if (!sysfs_get_active(attr_sd))
  93                 return -ENODEV;
  94
  95         of->event = atomic_read(&attr_sd->s_attr.open->event);
  96
  97         ops = sysfs_file_ops(attr_sd);
  98         count = ops->show(kobj, attr_sd->s_attr.attr, of->page);
  99
 100         sysfs_put_active(attr_sd);
 101
 102         /*
 103          * The code works fine with PAGE_SIZE return but it's likely to
 104          * indicate truncated result or overflow in normal use cases.
 105          */
 106         if (count >= (ssize_t)PAGE_SIZE) {
 107                 print_symbol("fill_read_buffer: %s returned bad count\n",
 108                         (unsigned long)ops->show);
 109                 /* Try to struggle along */
 110                 count = PAGE_SIZE - 1;
 111         }
 112         if (count >= 0)
 113                 of->count = count;
 114         else
 115                 ret = count;
 116         return ret;
 117 }
 118
 119 /**
 120  *      sysfs_read_file - read an attribute.
 121  *      @file:  file pointer.
 122  *      @buf:   buffer to fill.
 123  *      @count: number of bytes to read.
 124  *      @ppos:  starting offset in file.
 125  *
 126  *      Userspace wants to read an attribute file. The attribute descriptor
 127  *      is in the file's ->d_fsdata. The target object is in the directory's
 128  *      ->d_fsdata.
 129  *
 130  *      We call fill_read_buffer() to allocate and fill the buffer from the
 131  *      object's show() method exactly once (if the read is happening from
 132  *      the beginning of the file). That should fill the entire buffer with
 133  *      all the data the object has to offer for that attribute.
 134  *      We then call flush_read_buffer() to copy the buffer to userspace
 135  *      in the increments specified.
 136  */
 137
 138 static ssize_t
 139 sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 140 {
 141         struct sysfs_open_file *of = file->private_data;
 142         ssize_t retval = 0;
 143
 144         mutex_lock(&of->mutex);
 145         /*
 146          * Fill on zero offset and the first read so that silly things like
 147          * "dd bs=1 skip=N" can work on sysfs files.
 148          */
 149         if (*ppos == 0 || !of->page) {
 150                 retval = fill_read_buffer(file->f_path.dentry, of);
 151                 if (retval)
 152                         goto out;
 153         }
 154         pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
 155                  __func__, count, *ppos, of->page);
 156         retval = simple_read_from_buffer(buf, count, ppos, of->page, of->count);
 157 out:
 158         mutex_unlock(&of->mutex);
 159         return retval;
 160 }
 161
 162 /**
 163  *      fill_write_buffer - copy buffer from userspace.
 164  *      @of:            open file struct.
 165  *      @buf:           data from user.
 166  *      @count:         number of bytes in @userbuf.
 167  *
 168  *      Allocate @of->page if it hasn't been already, then copy the
 169  *      user-supplied buffer into it.
 170  */
 171 static int fill_write_buffer(struct sysfs_open_file *of,
 172                              const char __user *buf, size_t count)
 173 {
 174         int error;
 175
 176         if (!of->page)
 177                 of->page = (char *)get_zeroed_page(GFP_KERNEL);
 178         if (!of->page)
 179                 return -ENOMEM;
 180
 181         if (count >= PAGE_SIZE)
 182                 count = PAGE_SIZE - 1;
 183         error = copy_from_user(of->page, buf, count);
 184
 185         /*
 186          * If buf is assumed to contain a string, terminate it by \0, so
 187          * e.g. sscanf() can scan the string easily.
 188          */
 189         of->page[count] = 0;
 190         return error ? -EFAULT : count;
 191 }
 192
 193 /**
 194  *      flush_write_buffer - push buffer to kobject.
 195  *      @dentry:        dentry to the attribute
 196  *      @of:            open file
 197  *      @count:         number of bytes
 198  *
 199  *      Get the correct pointers for the kobject and the attribute we're
 200  *      dealing with, then call the store() method for the attribute,
 201  *      passing the buffer that we acquired in fill_write_buffer().
 202  */
 203 static int flush_write_buffer(struct dentry *dentry,
 204                               struct sysfs_open_file *of, size_t count)
 205 {
 206         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
 207         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
 208         const struct sysfs_ops *ops;
 209         int rc;
 210
 211         /* need attr_sd for attr and ops, its parent for kobj */
 212         if (!sysfs_get_active(attr_sd))
 213                 return -ENODEV;
 214
 215         ops = sysfs_file_ops(attr_sd);
 216         rc = ops->store(kobj, attr_sd->s_attr.attr, of->page, count);
 217
 218         sysfs_put_active(attr_sd);
 219
 220         return rc;
 221 }
 222
 223 /**
 224  *      sysfs_write_file - write an attribute.
 225  *      @file:  file pointer
 226  *      @buf:   data to write
 227  *      @count: number of bytes
 228  *      @ppos:  starting offset
 229  *
 230  *      Similar to sysfs_read_file(), though working in the opposite direction.
 231  *      We allocate and fill the data from the user in fill_write_buffer(),
 232  *      then push it to the kobject in flush_write_buffer().
 233  *      There is no easy way for us to know if userspace is only doing a partial
 234  *      write, so we don't support them. We expect the entire buffer to come
 235  *      on the first write.
 236  *      Hint: if you're writing a value, first read the file, modify only the
 237  *      the value you're changing, then write entire buffer back.
 238  */
 239 static ssize_t sysfs_write_file(struct file *file, const char __user *buf,
 240                                 size_t count, loff_t *ppos)
 241 {
 242         struct sysfs_open_file *of = file->private_data;
 243         ssize_t len;
 244
 245         mutex_lock(&of->mutex);
 246         len = fill_write_buffer(of, buf, count);
 247         if (len > 0)
 248                 len = flush_write_buffer(file->f_path.dentry, of, len);
 249         if (len > 0)
 250                 *ppos += len;
 251         mutex_unlock(&of->mutex);
 252         return len;
 253 }
 254
 255 /**
 256  *      sysfs_get_open_dirent - get or create sysfs_open_dirent
 257  *      @sd: target sysfs_dirent
 258  *      @of: sysfs_open_file for this instance of open
 259  *
 260  *      If @sd->s_attr.open exists, increment its reference count;
 261  *      otherwise, create one.  @of is chained to the files list.
 262  *
 263  *      LOCKING:
 264  *      Kernel thread context (may sleep).
 265  *
 266  *      RETURNS:
 267  *      0 on success, -errno on failure.
 268  */
 269 static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
 270                                  struct sysfs_open_file *of)
 271 {
 272         struct sysfs_open_dirent *od, *new_od = NULL;
 273
 274  retry:
 275         mutex_lock(&sysfs_open_file_mutex);
 276         spin_lock_irq(&sysfs_open_dirent_lock);
 277
 278         if (!sd->s_attr.open && new_od) {
 279                 sd->s_attr.open = new_od;
 280                 new_od = NULL;
 281         }
 282
 283         od = sd->s_attr.open;
 284         if (od) {
 285                 atomic_inc(&od->refcnt);
 286                 list_add_tail(&of->list, &od->files);
 287         }
 288
 289         spin_unlock_irq(&sysfs_open_dirent_lock);
 290         mutex_unlock(&sysfs_open_file_mutex);
 291
 292         if (od) {
 293                 kfree(new_od);
 294                 return 0;
 295         }
 296
 297         /* not there, initialize a new one and retry */
 298         new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
 299         if (!new_od)
 300                 return -ENOMEM;
 301
 302         atomic_set(&new_od->refcnt, 0);
 303         atomic_set(&new_od->event, 1);
 304         init_waitqueue_head(&new_od->poll);
 305         INIT_LIST_HEAD(&new_od->files);
 306         goto retry;
 307 }
 308
 309 /**
 310  *      sysfs_put_open_dirent - put sysfs_open_dirent
 311  *      @sd: target sysfs_dirent
 312  *      @of: associated sysfs_open_file
 313  *
 314  *      Put @sd->s_attr.open and unlink @of from the files list.  If
 315  *      reference count reaches zero, disassociate and free it.
 316  *
 317  *      LOCKING:
 318  *      None.
 319  */
 320 static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
 321                                   struct sysfs_open_file *of)
 322 {
 323         struct sysfs_open_dirent *od = sd->s_attr.open;
 324         unsigned long flags;
 325
 326         mutex_lock(&sysfs_open_file_mutex);
 327         spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
 328
 329         list_del(&of->list);
 330         if (atomic_dec_and_test(&od->refcnt))
 331                 sd->s_attr.open = NULL;
 332         else
 333                 od = NULL;
 334
 335         spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
 336         mutex_unlock(&sysfs_open_file_mutex);
 337
 338         kfree(od);
 339 }
 340
 341 static int sysfs_open_file(struct inode *inode, struct file *file)
 342 {
 343         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 344         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
 345         struct sysfs_open_file *of;
 346         const struct sysfs_ops *ops;
 347         int error = -EACCES;
 348
 349         /* need attr_sd for attr and ops, its parent for kobj */
 350         if (!sysfs_get_active(attr_sd))
 351                 return -ENODEV;
 352
 353         /* every kobject with an attribute needs a ktype assigned */
 354         ops = sysfs_file_ops(attr_sd);
 355         if (WARN(!ops, KERN_ERR
 356                  "missing sysfs attribute operations for kobject: %s\n",
 357                  kobject_name(kobj)))
 358                 goto err_out;
 359
 360         /* File needs write support.
 361          * The inode's perms must say it's ok,
 362          * and we must have a store method.
 363          */
 364         if (file->f_mode & FMODE_WRITE) {
 365                 if (!(inode->i_mode & S_IWUGO) || !ops->store)
 366                         goto err_out;
 367         }
 368
 369         /* File needs read support.
 370          * The inode's perms must say it's ok, and we there
 371          * must be a show method for it.
 372          */
 373         if (file->f_mode & FMODE_READ) {
 374                 if (!(inode->i_mode & S_IRUGO) || !ops->show)
 375                         goto err_out;
 376         }
 377
 378         /*
 379          * No error? Great, allocate a sysfs_open_file for the file, and
 380          * store it it in file->private_data for easy access.
 381          */
 382         error = -ENOMEM;
 383         of = kzalloc(sizeof(struct sysfs_open_file), GFP_KERNEL);
 384         if (!of)
 385                 goto err_out;
 386
 387         mutex_init(&of->mutex);
 388         file->private_data = of;
 389
 390         /* make sure we have open dirent struct */
 391         error = sysfs_get_open_dirent(attr_sd, of);
 392         if (error)
 393                 goto err_free;
 394
 395         /* open succeeded, put active references */
 396         sysfs_put_active(attr_sd);
 397         return 0;
 398
 399  err_free:
 400         kfree(of);
 401  err_out:
 402         sysfs_put_active(attr_sd);
 403         return error;
 404 }
 405
 406 static int sysfs_release(struct inode *inode, struct file *filp)
 407 {
 408         struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
 409         struct sysfs_open_file *of = filp->private_data;
 410
 411         sysfs_put_open_dirent(sd, of);
 412
 413         if (of->page)
 414                 free_page((unsigned long)of->page);
 415         kfree(of);
 416
 417         return 0;
 418 }
 419
 420 /* Sysfs attribute files are pollable.  The idea is that you read
 421  * the content and then you use 'poll' or 'select' to wait for
 422  * the content to change.  When the content changes (assuming the
 423  * manager for the kobject supports notification), poll will
 424  * return POLLERR|POLLPRI, and select will return the fd whether
 425  * it is waiting for read, write, or exceptions.
 426  * Once poll/select indicates that the value has changed, you
 427  * need to close and re-open the file, or seek to 0 and read again.
 428  * Reminder: this only works for attributes which actively support
 429  * it, and it is not possible to test an attribute from userspace
 430  * to see if it supports poll (Neither 'poll' nor 'select' return
 431  * an appropriate error code).  When in doubt, set a suitable timeout value.
 432  */
 433 static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
 434 {
 435         struct sysfs_open_file *of = filp->private_data;
 436         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
 437         struct sysfs_open_dirent *od = attr_sd->s_attr.open;
 438
 439         /* need parent for the kobj, grab both */
 440         if (!sysfs_get_active(attr_sd))
 441                 goto trigger;
 442
 443         poll_wait(filp, &od->poll, wait);
 444
 445         sysfs_put_active(attr_sd);
 446
 447         if (of->event != atomic_read(&od->event))
 448                 goto trigger;
 449
 450         return DEFAULT_POLLMASK;
 451
 452  trigger:
 453         return DEFAULT_POLLMASK|POLLERR|POLLPRI;
 454 }
 455
 456 void sysfs_notify_dirent(struct sysfs_dirent *sd)
 457 {
 458         struct sysfs_open_dirent *od;
 459         unsigned long flags;
 460
 461         spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
 462
 463         if (!WARN_ON(sysfs_type(sd) != SYSFS_KOBJ_ATTR)) {
 464                 od = sd->s_attr.open;
 465                 if (od) {
 466                         atomic_inc(&od->event);
 467                         wake_up_interruptible(&od->poll);
 468                 }
 469         }
 470
 471         spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
 472 }
 473 EXPORT_SYMBOL_GPL(sysfs_notify_dirent);
 474
 475 void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
 476 {
 477         struct sysfs_dirent *sd = k->sd;
 478
 479         mutex_lock(&sysfs_mutex);
 480
 481         if (sd && dir)
 482                 sd = sysfs_find_dirent(sd, dir, NULL);
 483         if (sd && attr)
 484                 sd = sysfs_find_dirent(sd, attr, NULL);
 485         if (sd)
 486                 sysfs_notify_dirent(sd);
 487
 488         mutex_unlock(&sysfs_mutex);
 489 }
 490 EXPORT_SYMBOL_GPL(sysfs_notify);
 491
 492 const struct file_operations sysfs_file_operations = {
 493         .read           = sysfs_read_file,
 494         .write          = sysfs_write_file,
 495         .llseek         = generic_file_llseek,
 496         .open           = sysfs_open_file,
 497         .release        = sysfs_release,
 498         .poll           = sysfs_poll,
 499 };
 500
 501 int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
 502                            const struct attribute *attr, int type,
 503                            umode_t amode, const void *ns)
 504 {
 505         umode_t mode = (amode & S_IALLUGO) | S_IFREG;
 506         struct sysfs_addrm_cxt acxt;
 507         struct sysfs_dirent *sd;
 508         int rc;
 509
 510         sd = sysfs_new_dirent(attr->name, mode, type);
 511         if (!sd)
 512                 return -ENOMEM;
 513
 514         sd->s_ns = ns;
 515         sd->s_attr.attr = (void *)attr;
 516         sysfs_dirent_init_lockdep(sd);
 517
 518         sysfs_addrm_start(&acxt);
 519         rc = sysfs_add_one(&acxt, sd, dir_sd);
 520         sysfs_addrm_finish(&acxt);
 521
 522         if (rc)
 523                 sysfs_put(sd);
 524
 525         return rc;
 526 }
 527
 528
 529 int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
 530                    int type)
 531 {
 532         return sysfs_add_file_mode_ns(dir_sd, attr, type, attr->mode, NULL);
 533 }
 534
 535 /**
 536  * sysfs_create_file_ns - create an attribute file for an object with custom ns
 537  * @kobj: object we're creating for
 538  * @attr: attribute descriptor
 539  * @ns: namespace the new file should belong to
 540  */
 541 int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
 542                          const void *ns)
 543 {
 544         BUG_ON(!kobj || !kobj->sd || !attr);
 545
 546         return sysfs_add_file_mode_ns(kobj->sd, attr, SYSFS_KOBJ_ATTR,
 547                                       attr->mode, ns);
 548
 549 }
 550 EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
 551
 552 int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
 553 {
 554         int err = 0;
 555         int i;
 556
 557         for (i = 0; ptr[i] && !err; i++)
 558                 err = sysfs_create_file(kobj, ptr[i]);
 559         if (err)
 560                 while (--i >= 0)
 561                         sysfs_remove_file(kobj, ptr[i]);
 562         return err;
 563 }
 564 EXPORT_SYMBOL_GPL(sysfs_create_files);
 565
 566 /**
 567  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
 568  * @kobj: object we're acting for.
 569  * @attr: attribute descriptor.
 570  * @group: group name.
 571  */
 572 int sysfs_add_file_to_group(struct kobject *kobj,
 573                 const struct attribute *attr, const char *group)
 574 {
 575         struct sysfs_dirent *dir_sd;
 576         int error;
 577
 578         if (group)
 579                 dir_sd = sysfs_get_dirent(kobj->sd, group);
 580         else
 581                 dir_sd = sysfs_get(kobj->sd);
 582
 583         if (!dir_sd)
 584                 return -ENOENT;
 585
 586         error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
 587         sysfs_put(dir_sd);
 588
 589         return error;
 590 }
 591 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
 592
 593 /**
 594  * sysfs_chmod_file - update the modified mode value on an object attribute.
 595  * @kobj: object we're acting for.
 596  * @attr: attribute descriptor.
 597  * @mode: file permissions.
 598  *
 599  */
 600 int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
 601                      umode_t mode)
 602 {
 603         struct sysfs_dirent *sd;
 604         struct iattr newattrs;
 605         int rc;
 606
 607         mutex_lock(&sysfs_mutex);
 608
 609         rc = -ENOENT;
 610         sd = sysfs_find_dirent(kobj->sd, attr->name, NULL);
 611         if (!sd)
 612                 goto out;
 613
 614         newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
 615         newattrs.ia_valid = ATTR_MODE;
 616         rc = sysfs_sd_setattr(sd, &newattrs);
 617
 618  out:
 619         mutex_unlock(&sysfs_mutex);
 620         return rc;
 621 }
 622 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
 623
 624 /**
 625  * sysfs_remove_file_ns - remove an object attribute with a custom ns tag
 626  * @kobj: object we're acting for
 627  * @attr: attribute descriptor
 628  * @ns: namespace tag of the file to remove
 629  *
 630  * Hash the attribute name and namespace tag and kill the victim.
 631  */
 632 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
 633                           const void *ns)
 634 {
 635         struct sysfs_dirent *dir_sd = kobj->sd;
 636
 637         sysfs_hash_and_remove(dir_sd, attr->name, ns);
 638 }
 639 EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
 640
 641 void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
 642 {
 643         int i;
 644         for (i = 0; ptr[i]; i++)
 645                 sysfs_remove_file(kobj, ptr[i]);
 646 }
 647 EXPORT_SYMBOL_GPL(sysfs_remove_files);
 648
 649 /**
 650  * sysfs_remove_file_from_group - remove an attribute file from a group.
 651  * @kobj: object we're acting for.
 652  * @attr: attribute descriptor.
 653  * @group: group name.
 654  */
 655 void sysfs_remove_file_from_group(struct kobject *kobj,
 656                 const struct attribute *attr, const char *group)
 657 {
 658         struct sysfs_dirent *dir_sd;
 659
 660         if (group)
 661                 dir_sd = sysfs_get_dirent(kobj->sd, group);
 662         else
 663                 dir_sd = sysfs_get(kobj->sd);
 664         if (dir_sd) {
 665                 sysfs_hash_and_remove(dir_sd, attr->name, NULL);
 666                 sysfs_put(dir_sd);
 667         }
 668 }
 669 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
 670
 671 struct sysfs_schedule_callback_struct {
 672         struct list_head        workq_list;
 673         struct kobject          *kobj;
 674         void                    (*func)(void *);
 675         void                    *data;
 676         struct module           *owner;
 677         struct work_struct      work;
 678 };
 679
 680 static struct workqueue_struct *sysfs_workqueue;
 681 static DEFINE_MUTEX(sysfs_workq_mutex);
 682 static LIST_HEAD(sysfs_workq);
 683 static void sysfs_schedule_callback_work(struct work_struct *work)
 684 {
 685         struct sysfs_schedule_callback_struct *ss = container_of(work,
 686                         struct sysfs_schedule_callback_struct, work);
 687
 688         (ss->func)(ss->data);
 689         kobject_put(ss->kobj);
 690         module_put(ss->owner);
 691         mutex_lock(&sysfs_workq_mutex);
 692         list_del(&ss->workq_list);
 693         mutex_unlock(&sysfs_workq_mutex);
 694         kfree(ss);
 695 }
 696
 697 /**
 698  * sysfs_schedule_callback - helper to schedule a callback for a kobject
 699  * @kobj: object we're acting for.
 700  * @func: callback function to invoke later.
 701  * @data: argument to pass to @func.
 702  * @owner: module owning the callback code
 703  *
 704  * sysfs attribute methods must not unregister themselves or their parent
 705  * kobject (which would amount to the same thing).  Attempts to do so will
 706  * deadlock, since unregistration is mutually exclusive with driver
 707  * callbacks.
 708  *
 709  * Instead methods can call this routine, which will attempt to allocate
 710  * and schedule a workqueue request to call back @func with @data as its
 711  * argument in the workqueue's process context.  @kobj will be pinned
 712  * until @func returns.
 713  *
 714  * Returns 0 if the request was submitted, -ENOMEM if storage could not
 715  * be allocated, -ENODEV if a reference to @owner isn't available,
 716  * -EAGAIN if a callback has already been scheduled for @kobj.
 717  */
 718 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 719                 void *data, struct module *owner)
 720 {
 721         struct sysfs_schedule_callback_struct *ss, *tmp;
 722
 723         if (!try_module_get(owner))
 724                 return -ENODEV;
 725
 726         mutex_lock(&sysfs_workq_mutex);
 727         list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
 728                 if (ss->kobj == kobj) {
 729                         module_put(owner);
 730                         mutex_unlock(&sysfs_workq_mutex);
 731                         return -EAGAIN;
 732                 }
 733         mutex_unlock(&sysfs_workq_mutex);
 734
 735         if (sysfs_workqueue == NULL) {
 736                 sysfs_workqueue = create_singlethread_workqueue("sysfsd");
 737                 if (sysfs_workqueue == NULL) {
 738                         module_put(owner);
 739                         return -ENOMEM;
 740                 }
 741         }
 742
 743         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
 744         if (!ss) {
 745                 module_put(owner);
 746                 return -ENOMEM;
 747         }
 748         kobject_get(kobj);
 749         ss->kobj = kobj;
 750         ss->func = func;
 751         ss->data = data;
 752         ss->owner = owner;
 753         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
 754         INIT_LIST_HEAD(&ss->workq_list);
 755         mutex_lock(&sysfs_workq_mutex);
 756         list_add_tail(&ss->workq_list, &sysfs_workq);
 757         mutex_unlock(&sysfs_workq_mutex);
 758         queue_work(sysfs_workqueue, &ss->work);
 759         return 0;
 760 }
 761 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);