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