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