sysfs: fix up space coding style issues
[firefly-linux-kernel-4.4.55.git] / 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 <asm/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
189 flush_write_buffer(struct dentry *dentry, 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
225 static ssize_t
226 sysfs_write_file(struct file *file, const char __user *buf, 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 "missing sysfs attribute operations for "
341                        "kobject: %s\n", 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, NULL, dir);
470         if (sd && attr)
471                 sd = sysfs_find_dirent(sd, NULL, attr);
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 static int sysfs_attr_ns(struct kobject *kobj, const struct attribute *attr,
489                          const void **pns)
490 {
491         struct sysfs_dirent *dir_sd = kobj->sd;
492         const struct sysfs_ops *ops;
493         const void *ns = NULL;
494         int err;
495
496         if (!dir_sd) {
497                 WARN(1, KERN_ERR "sysfs: kobject %s without dirent\n",
498                         kobject_name(kobj));
499                 return -ENOENT;
500         }
501
502         err = 0;
503         if (!sysfs_ns_type(dir_sd))
504                 goto out;
505
506         err = -EINVAL;
507         if (!kobj->ktype)
508                 goto out;
509         ops = kobj->ktype->sysfs_ops;
510         if (!ops)
511                 goto out;
512         if (!ops->namespace)
513                 goto out;
514
515         err = 0;
516         ns = ops->namespace(kobj, attr);
517 out:
518         if (err) {
519                 WARN(1, KERN_ERR "missing sysfs namespace attribute operation for "
520                      "kobject: %s\n", kobject_name(kobj));
521         }
522         *pns = ns;
523         return err;
524 }
525
526 int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
527                         const struct attribute *attr, int type, umode_t amode)
528 {
529         umode_t mode = (amode & S_IALLUGO) | S_IFREG;
530         struct sysfs_addrm_cxt acxt;
531         struct sysfs_dirent *sd;
532         const void *ns;
533         int rc;
534
535         rc = sysfs_attr_ns(dir_sd->s_dir.kobj, attr, &ns);
536         if (rc)
537                 return rc;
538
539         sd = sysfs_new_dirent(attr->name, mode, type);
540         if (!sd)
541                 return -ENOMEM;
542
543         sd->s_ns = ns;
544         sd->s_attr.attr = (void *)attr;
545         sysfs_dirent_init_lockdep(sd);
546
547         sysfs_addrm_start(&acxt, dir_sd);
548         rc = sysfs_add_one(&acxt, sd);
549         sysfs_addrm_finish(&acxt);
550
551         if (rc)
552                 sysfs_put(sd);
553
554         return rc;
555 }
556
557
558 int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
559                    int type)
560 {
561         return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
562 }
563
564
565 /**
566  *      sysfs_create_file - create an attribute file for an object.
567  *      @kobj:  object we're creating for.
568  *      @attr:  attribute descriptor.
569  */
570 int sysfs_create_file(struct kobject *kobj, const struct attribute *attr)
571 {
572         BUG_ON(!kobj || !kobj->sd || !attr);
573
574         return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
575
576 }
577 EXPORT_SYMBOL_GPL(sysfs_create_file);
578
579 int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
580 {
581         int err = 0;
582         int i;
583
584         for (i = 0; ptr[i] && !err; i++)
585                 err = sysfs_create_file(kobj, ptr[i]);
586         if (err)
587                 while (--i >= 0)
588                         sysfs_remove_file(kobj, ptr[i]);
589         return err;
590 }
591 EXPORT_SYMBOL_GPL(sysfs_create_files);
592
593 /**
594  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
595  * @kobj: object we're acting for.
596  * @attr: attribute descriptor.
597  * @group: group name.
598  */
599 int sysfs_add_file_to_group(struct kobject *kobj,
600                 const struct attribute *attr, const char *group)
601 {
602         struct sysfs_dirent *dir_sd;
603         int error;
604
605         if (group)
606                 dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
607         else
608                 dir_sd = sysfs_get(kobj->sd);
609
610         if (!dir_sd)
611                 return -ENOENT;
612
613         error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
614         sysfs_put(dir_sd);
615
616         return error;
617 }
618 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
619
620 /**
621  * sysfs_chmod_file - update the modified mode value on an object attribute.
622  * @kobj: object we're acting for.
623  * @attr: attribute descriptor.
624  * @mode: file permissions.
625  *
626  */
627 int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
628                      umode_t mode)
629 {
630         struct sysfs_dirent *sd;
631         struct iattr newattrs;
632         const void *ns;
633         int rc;
634
635         rc = sysfs_attr_ns(kobj, attr, &ns);
636         if (rc)
637                 return rc;
638
639         mutex_lock(&sysfs_mutex);
640
641         rc = -ENOENT;
642         sd = sysfs_find_dirent(kobj->sd, ns, attr->name);
643         if (!sd)
644                 goto out;
645
646         newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
647         newattrs.ia_valid = ATTR_MODE;
648         rc = sysfs_sd_setattr(sd, &newattrs);
649
650  out:
651         mutex_unlock(&sysfs_mutex);
652         return rc;
653 }
654 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
655
656 /**
657  *      sysfs_remove_file - remove an object attribute.
658  *      @kobj:  object we're acting for.
659  *      @attr:  attribute descriptor.
660  *
661  *      Hash the attribute name and kill the victim.
662  */
663 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr)
664 {
665         const void *ns;
666
667         if (sysfs_attr_ns(kobj, attr, &ns))
668                 return;
669
670         sysfs_hash_and_remove(kobj->sd, ns, attr->name);
671 }
672 EXPORT_SYMBOL_GPL(sysfs_remove_file);
673
674 void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
675 {
676         int i;
677         for (i = 0; ptr[i]; i++)
678                 sysfs_remove_file(kobj, ptr[i]);
679 }
680 EXPORT_SYMBOL_GPL(sysfs_remove_files);
681
682 /**
683  * sysfs_remove_file_from_group - remove an attribute file from a group.
684  * @kobj: object we're acting for.
685  * @attr: attribute descriptor.
686  * @group: group name.
687  */
688 void sysfs_remove_file_from_group(struct kobject *kobj,
689                 const struct attribute *attr, const char *group)
690 {
691         struct sysfs_dirent *dir_sd;
692
693         if (group)
694                 dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
695         else
696                 dir_sd = sysfs_get(kobj->sd);
697         if (dir_sd) {
698                 sysfs_hash_and_remove(dir_sd, NULL, attr->name);
699                 sysfs_put(dir_sd);
700         }
701 }
702 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
703
704 struct sysfs_schedule_callback_struct {
705         struct list_head        workq_list;
706         struct kobject          *kobj;
707         void                    (*func)(void *);
708         void                    *data;
709         struct module           *owner;
710         struct work_struct      work;
711 };
712
713 static struct workqueue_struct *sysfs_workqueue;
714 static DEFINE_MUTEX(sysfs_workq_mutex);
715 static LIST_HEAD(sysfs_workq);
716 static void sysfs_schedule_callback_work(struct work_struct *work)
717 {
718         struct sysfs_schedule_callback_struct *ss = container_of(work,
719                         struct sysfs_schedule_callback_struct, work);
720
721         (ss->func)(ss->data);
722         kobject_put(ss->kobj);
723         module_put(ss->owner);
724         mutex_lock(&sysfs_workq_mutex);
725         list_del(&ss->workq_list);
726         mutex_unlock(&sysfs_workq_mutex);
727         kfree(ss);
728 }
729
730 /**
731  * sysfs_schedule_callback - helper to schedule a callback for a kobject
732  * @kobj: object we're acting for.
733  * @func: callback function to invoke later.
734  * @data: argument to pass to @func.
735  * @owner: module owning the callback code
736  *
737  * sysfs attribute methods must not unregister themselves or their parent
738  * kobject (which would amount to the same thing).  Attempts to do so will
739  * deadlock, since unregistration is mutually exclusive with driver
740  * callbacks.
741  *
742  * Instead methods can call this routine, which will attempt to allocate
743  * and schedule a workqueue request to call back @func with @data as its
744  * argument in the workqueue's process context.  @kobj will be pinned
745  * until @func returns.
746  *
747  * Returns 0 if the request was submitted, -ENOMEM if storage could not
748  * be allocated, -ENODEV if a reference to @owner isn't available,
749  * -EAGAIN if a callback has already been scheduled for @kobj.
750  */
751 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
752                 void *data, struct module *owner)
753 {
754         struct sysfs_schedule_callback_struct *ss, *tmp;
755
756         if (!try_module_get(owner))
757                 return -ENODEV;
758
759         mutex_lock(&sysfs_workq_mutex);
760         list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
761                 if (ss->kobj == kobj) {
762                         module_put(owner);
763                         mutex_unlock(&sysfs_workq_mutex);
764                         return -EAGAIN;
765                 }
766         mutex_unlock(&sysfs_workq_mutex);
767
768         if (sysfs_workqueue == NULL) {
769                 sysfs_workqueue = create_singlethread_workqueue("sysfsd");
770                 if (sysfs_workqueue == NULL) {
771                         module_put(owner);
772                         return -ENOMEM;
773                 }
774         }
775
776         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
777         if (!ss) {
778                 module_put(owner);
779                 return -ENOMEM;
780         }
781         kobject_get(kobj);
782         ss->kobj = kobj;
783         ss->func = func;
784         ss->data = data;
785         ss->owner = owner;
786         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
787         INIT_LIST_HEAD(&ss->workq_list);
788         mutex_lock(&sysfs_workq_mutex);
789         list_add_tail(&ss->workq_list, &sysfs_workq);
790         mutex_unlock(&sysfs_workq_mutex);
791         queue_work(sysfs_workqueue, &ss->work);
792         return 0;
793 }
794 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);