Merge branch 'release-2.6.27' of git://git.kernel.org/pub/scm/linux/kernel/git/ak...
[linux-2.6] / 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 <asm/uaccess.h>
23
24 #include "sysfs.h"
25
26 /*
27  * There's one sysfs_buffer for each open file and one
28  * sysfs_open_dirent for each sysfs_dirent with one or more open
29  * files.
30  *
31  * filp->private_data points to sysfs_buffer and
32  * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open
33  * is protected by sysfs_open_dirent_lock.
34  */
35 static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
36
37 struct sysfs_open_dirent {
38         atomic_t                refcnt;
39         atomic_t                event;
40         wait_queue_head_t       poll;
41         struct list_head        buffers; /* goes through sysfs_buffer.list */
42 };
43
44 struct sysfs_buffer {
45         size_t                  count;
46         loff_t                  pos;
47         char                    * page;
48         struct sysfs_ops        * ops;
49         struct mutex            mutex;
50         int                     needs_read_fill;
51         int                     event;
52         struct list_head        list;
53 };
54
55 /**
56  *      fill_read_buffer - allocate and fill buffer from object.
57  *      @dentry:        dentry pointer.
58  *      @buffer:        data buffer for file.
59  *
60  *      Allocate @buffer->page, if it hasn't been already, then call the
61  *      kobject's show() method to fill the buffer with this attribute's 
62  *      data. 
63  *      This is called only once, on the file's first read unless an error
64  *      is returned.
65  */
66 static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
67 {
68         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
69         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
70         struct sysfs_ops * ops = buffer->ops;
71         int ret = 0;
72         ssize_t count;
73
74         if (!buffer->page)
75                 buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
76         if (!buffer->page)
77                 return -ENOMEM;
78
79         /* need attr_sd for attr and ops, its parent for kobj */
80         if (!sysfs_get_active_two(attr_sd))
81                 return -ENODEV;
82
83         buffer->event = atomic_read(&attr_sd->s_attr.open->event);
84         count = ops->show(kobj, attr_sd->s_attr.attr, buffer->page);
85
86         sysfs_put_active_two(attr_sd);
87
88         /*
89          * The code works fine with PAGE_SIZE return but it's likely to
90          * indicate truncated result or overflow in normal use cases.
91          */
92         if (count >= (ssize_t)PAGE_SIZE) {
93                 print_symbol("fill_read_buffer: %s returned bad count\n",
94                         (unsigned long)ops->show);
95                 /* Try to struggle along */
96                 count = PAGE_SIZE - 1;
97         }
98         if (count >= 0) {
99                 buffer->needs_read_fill = 0;
100                 buffer->count = count;
101         } else {
102                 ret = count;
103         }
104         return ret;
105 }
106
107 /**
108  *      sysfs_read_file - read an attribute. 
109  *      @file:  file pointer.
110  *      @buf:   buffer to fill.
111  *      @count: number of bytes to read.
112  *      @ppos:  starting offset in file.
113  *
114  *      Userspace wants to read an attribute file. The attribute descriptor
115  *      is in the file's ->d_fsdata. The target object is in the directory's
116  *      ->d_fsdata.
117  *
118  *      We call fill_read_buffer() to allocate and fill the buffer from the
119  *      object's show() method exactly once (if the read is happening from
120  *      the beginning of the file). That should fill the entire buffer with
121  *      all the data the object has to offer for that attribute.
122  *      We then call flush_read_buffer() to copy the buffer to userspace
123  *      in the increments specified.
124  */
125
126 static ssize_t
127 sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
128 {
129         struct sysfs_buffer * buffer = file->private_data;
130         ssize_t retval = 0;
131
132         mutex_lock(&buffer->mutex);
133         if (buffer->needs_read_fill || *ppos == 0) {
134                 retval = fill_read_buffer(file->f_path.dentry,buffer);
135                 if (retval)
136                         goto out;
137         }
138         pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
139                  __func__, count, *ppos, buffer->page);
140         retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
141                                          buffer->count);
142 out:
143         mutex_unlock(&buffer->mutex);
144         return retval;
145 }
146
147 /**
148  *      fill_write_buffer - copy buffer from userspace.
149  *      @buffer:        data buffer for file.
150  *      @buf:           data from user.
151  *      @count:         number of bytes in @userbuf.
152  *
153  *      Allocate @buffer->page if it hasn't been already, then
154  *      copy the user-supplied buffer into it.
155  */
156
157 static int 
158 fill_write_buffer(struct sysfs_buffer * buffer, 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
189 static int
190 flush_write_buffer(struct dentry * dentry, 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         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_two(attr_sd))
199                 return -ENODEV;
200
201         rc = ops->store(kobj, attr_sd->s_attr.attr, buffer->page, count);
202
203         sysfs_put_active_two(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
226 static ssize_t
227 sysfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
228 {
229         struct sysfs_buffer * buffer = file->private_data;
230         ssize_t len;
231
232         mutex_lock(&buffer->mutex);
233         len = fill_write_buffer(buffer, buf, count);
234         if (len > 0)
235                 len = flush_write_buffer(file->f_path.dentry, buffer, len);
236         if (len > 0)
237                 *ppos += len;
238         mutex_unlock(&buffer->mutex);
239         return len;
240 }
241
242 /**
243  *      sysfs_get_open_dirent - get or create sysfs_open_dirent
244  *      @sd: target sysfs_dirent
245  *      @buffer: sysfs_buffer for this instance of open
246  *
247  *      If @sd->s_attr.open exists, increment its reference count;
248  *      otherwise, create one.  @buffer is chained to the buffers
249  *      list.
250  *
251  *      LOCKING:
252  *      Kernel thread context (may sleep).
253  *
254  *      RETURNS:
255  *      0 on success, -errno on failure.
256  */
257 static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
258                                  struct sysfs_buffer *buffer)
259 {
260         struct sysfs_open_dirent *od, *new_od = NULL;
261
262  retry:
263         spin_lock(&sysfs_open_dirent_lock);
264
265         if (!sd->s_attr.open && new_od) {
266                 sd->s_attr.open = new_od;
267                 new_od = NULL;
268         }
269
270         od = sd->s_attr.open;
271         if (od) {
272                 atomic_inc(&od->refcnt);
273                 list_add_tail(&buffer->list, &od->buffers);
274         }
275
276         spin_unlock(&sysfs_open_dirent_lock);
277
278         if (od) {
279                 kfree(new_od);
280                 return 0;
281         }
282
283         /* not there, initialize a new one and retry */
284         new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
285         if (!new_od)
286                 return -ENOMEM;
287
288         atomic_set(&new_od->refcnt, 0);
289         atomic_set(&new_od->event, 1);
290         init_waitqueue_head(&new_od->poll);
291         INIT_LIST_HEAD(&new_od->buffers);
292         goto retry;
293 }
294
295 /**
296  *      sysfs_put_open_dirent - put sysfs_open_dirent
297  *      @sd: target sysfs_dirent
298  *      @buffer: associated sysfs_buffer
299  *
300  *      Put @sd->s_attr.open and unlink @buffer from the buffers list.
301  *      If reference count reaches zero, disassociate and free it.
302  *
303  *      LOCKING:
304  *      None.
305  */
306 static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
307                                   struct sysfs_buffer *buffer)
308 {
309         struct sysfs_open_dirent *od = sd->s_attr.open;
310
311         spin_lock(&sysfs_open_dirent_lock);
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(&sysfs_open_dirent_lock);
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         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_two(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                 printk(KERN_ERR "missing sysfs attribute operations for "
341                        "kobject: %s\n", kobject_name(kobj));
342                 WARN_ON(1);
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->needs_read_fill = 1;
374         buffer->ops = ops;
375         file->private_data = buffer;
376
377         /* make sure we have open dirent struct */
378         error = sysfs_get_open_dirent(attr_sd, buffer);
379         if (error)
380                 goto err_free;
381
382         /* open succeeded, put active references */
383         sysfs_put_active_two(attr_sd);
384         return 0;
385
386  err_free:
387         kfree(buffer);
388  err_out:
389         sysfs_put_active_two(attr_sd);
390         return error;
391 }
392
393 static int sysfs_release(struct inode *inode, struct file *filp)
394 {
395         struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
396         struct sysfs_buffer *buffer = filp->private_data;
397
398         sysfs_put_open_dirent(sd, buffer);
399
400         if (buffer->page)
401                 free_page((unsigned long)buffer->page);
402         kfree(buffer);
403
404         return 0;
405 }
406
407 /* Sysfs attribute files are pollable.  The idea is that you read
408  * the content and then you use 'poll' or 'select' to wait for
409  * the content to change.  When the content changes (assuming the
410  * manager for the kobject supports notification), poll will
411  * return POLLERR|POLLPRI, and select will return the fd whether
412  * it is waiting for read, write, or exceptions.
413  * Once poll/select indicates that the value has changed, you
414  * need to close and re-open the file, or seek to 0 and read again.
415  * Reminder: this only works for attributes which actively support
416  * it, and it is not possible to test an attribute from userspace
417  * to see if it supports poll (Neither 'poll' nor 'select' return
418  * an appropriate error code).  When in doubt, set a suitable timeout value.
419  */
420 static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
421 {
422         struct sysfs_buffer * buffer = filp->private_data;
423         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
424         struct sysfs_open_dirent *od = attr_sd->s_attr.open;
425
426         /* need parent for the kobj, grab both */
427         if (!sysfs_get_active_two(attr_sd))
428                 goto trigger;
429
430         poll_wait(filp, &od->poll, wait);
431
432         sysfs_put_active_two(attr_sd);
433
434         if (buffer->event != atomic_read(&od->event))
435                 goto trigger;
436
437         return 0;
438
439  trigger:
440         buffer->needs_read_fill = 1;
441         return POLLERR|POLLPRI;
442 }
443
444 void sysfs_notify(struct kobject *k, char *dir, char *attr)
445 {
446         struct sysfs_dirent *sd = k->sd;
447
448         mutex_lock(&sysfs_mutex);
449
450         if (sd && dir)
451                 sd = sysfs_find_dirent(sd, dir);
452         if (sd && attr)
453                 sd = sysfs_find_dirent(sd, attr);
454         if (sd) {
455                 struct sysfs_open_dirent *od;
456
457                 spin_lock(&sysfs_open_dirent_lock);
458
459                 od = sd->s_attr.open;
460                 if (od) {
461                         atomic_inc(&od->event);
462                         wake_up_interruptible(&od->poll);
463                 }
464
465                 spin_unlock(&sysfs_open_dirent_lock);
466         }
467
468         mutex_unlock(&sysfs_mutex);
469 }
470 EXPORT_SYMBOL_GPL(sysfs_notify);
471
472 const struct file_operations sysfs_file_operations = {
473         .read           = sysfs_read_file,
474         .write          = sysfs_write_file,
475         .llseek         = generic_file_llseek,
476         .open           = sysfs_open_file,
477         .release        = sysfs_release,
478         .poll           = sysfs_poll,
479 };
480
481 int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
482                         const struct attribute *attr, int type, mode_t amode)
483 {
484         umode_t mode = (amode & S_IALLUGO) | S_IFREG;
485         struct sysfs_addrm_cxt acxt;
486         struct sysfs_dirent *sd;
487         int rc;
488
489         sd = sysfs_new_dirent(attr->name, mode, type);
490         if (!sd)
491                 return -ENOMEM;
492         sd->s_attr.attr = (void *)attr;
493
494         sysfs_addrm_start(&acxt, dir_sd);
495         rc = sysfs_add_one(&acxt, sd);
496         sysfs_addrm_finish(&acxt);
497
498         if (rc)
499                 sysfs_put(sd);
500
501         return rc;
502 }
503
504
505 int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
506                    int type)
507 {
508         return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
509 }
510
511
512 /**
513  *      sysfs_create_file - create an attribute file for an object.
514  *      @kobj:  object we're creating for. 
515  *      @attr:  attribute descriptor.
516  */
517
518 int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
519 {
520         BUG_ON(!kobj || !kobj->sd || !attr);
521
522         return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
523
524 }
525
526
527 /**
528  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
529  * @kobj: object we're acting for.
530  * @attr: attribute descriptor.
531  * @group: group name.
532  */
533 int sysfs_add_file_to_group(struct kobject *kobj,
534                 const struct attribute *attr, const char *group)
535 {
536         struct sysfs_dirent *dir_sd;
537         int error;
538
539         if (group)
540                 dir_sd = sysfs_get_dirent(kobj->sd, group);
541         else
542                 dir_sd = sysfs_get(kobj->sd);
543
544         if (!dir_sd)
545                 return -ENOENT;
546
547         error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
548         sysfs_put(dir_sd);
549
550         return error;
551 }
552 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
553
554 /**
555  * sysfs_chmod_file - update the modified mode value on an object attribute.
556  * @kobj: object we're acting for.
557  * @attr: attribute descriptor.
558  * @mode: file permissions.
559  *
560  */
561 int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
562 {
563         struct sysfs_dirent *victim_sd = NULL;
564         struct dentry *victim = NULL;
565         struct inode * inode;
566         struct iattr newattrs;
567         int rc;
568
569         rc = -ENOENT;
570         victim_sd = sysfs_get_dirent(kobj->sd, attr->name);
571         if (!victim_sd)
572                 goto out;
573
574         mutex_lock(&sysfs_rename_mutex);
575         victim = sysfs_get_dentry(victim_sd);
576         mutex_unlock(&sysfs_rename_mutex);
577         if (IS_ERR(victim)) {
578                 rc = PTR_ERR(victim);
579                 victim = NULL;
580                 goto out;
581         }
582
583         inode = victim->d_inode;
584
585         mutex_lock(&inode->i_mutex);
586
587         newattrs.ia_mode = (mode & S_IALLUGO) | (inode->i_mode & ~S_IALLUGO);
588         newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
589         newattrs.ia_ctime = current_fs_time(inode->i_sb);
590         rc = sysfs_setattr(victim, &newattrs);
591
592         if (rc == 0) {
593                 fsnotify_change(victim, newattrs.ia_valid);
594                 mutex_lock(&sysfs_mutex);
595                 victim_sd->s_mode = newattrs.ia_mode;
596                 mutex_unlock(&sysfs_mutex);
597         }
598
599         mutex_unlock(&inode->i_mutex);
600  out:
601         dput(victim);
602         sysfs_put(victim_sd);
603         return rc;
604 }
605 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
606
607
608 /**
609  *      sysfs_remove_file - remove an object attribute.
610  *      @kobj:  object we're acting for.
611  *      @attr:  attribute descriptor.
612  *
613  *      Hash the attribute name and kill the victim.
614  */
615
616 void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
617 {
618         sysfs_hash_and_remove(kobj->sd, attr->name);
619 }
620
621
622 /**
623  * sysfs_remove_file_from_group - remove an attribute file from a group.
624  * @kobj: object we're acting for.
625  * @attr: attribute descriptor.
626  * @group: group name.
627  */
628 void sysfs_remove_file_from_group(struct kobject *kobj,
629                 const struct attribute *attr, const char *group)
630 {
631         struct sysfs_dirent *dir_sd;
632
633         if (group)
634                 dir_sd = sysfs_get_dirent(kobj->sd, group);
635         else
636                 dir_sd = sysfs_get(kobj->sd);
637         if (dir_sd) {
638                 sysfs_hash_and_remove(dir_sd, attr->name);
639                 sysfs_put(dir_sd);
640         }
641 }
642 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
643
644 struct sysfs_schedule_callback_struct {
645         struct kobject          *kobj;
646         void                    (*func)(void *);
647         void                    *data;
648         struct module           *owner;
649         struct work_struct      work;
650 };
651
652 static void sysfs_schedule_callback_work(struct work_struct *work)
653 {
654         struct sysfs_schedule_callback_struct *ss = container_of(work,
655                         struct sysfs_schedule_callback_struct, work);
656
657         (ss->func)(ss->data);
658         kobject_put(ss->kobj);
659         module_put(ss->owner);
660         kfree(ss);
661 }
662
663 /**
664  * sysfs_schedule_callback - helper to schedule a callback for a kobject
665  * @kobj: object we're acting for.
666  * @func: callback function to invoke later.
667  * @data: argument to pass to @func.
668  * @owner: module owning the callback code
669  *
670  * sysfs attribute methods must not unregister themselves or their parent
671  * kobject (which would amount to the same thing).  Attempts to do so will
672  * deadlock, since unregistration is mutually exclusive with driver
673  * callbacks.
674  *
675  * Instead methods can call this routine, which will attempt to allocate
676  * and schedule a workqueue request to call back @func with @data as its
677  * argument in the workqueue's process context.  @kobj will be pinned
678  * until @func returns.
679  *
680  * Returns 0 if the request was submitted, -ENOMEM if storage could not
681  * be allocated, -ENODEV if a reference to @owner isn't available.
682  */
683 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
684                 void *data, struct module *owner)
685 {
686         struct sysfs_schedule_callback_struct *ss;
687
688         if (!try_module_get(owner))
689                 return -ENODEV;
690         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
691         if (!ss) {
692                 module_put(owner);
693                 return -ENOMEM;
694         }
695         kobject_get(kobj);
696         ss->kobj = kobj;
697         ss->func = func;
698         ss->data = data;
699         ss->owner = owner;
700         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
701         schedule_work(&ss->work);
702         return 0;
703 }
704 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);
705
706
707 EXPORT_SYMBOL_GPL(sysfs_create_file);
708 EXPORT_SYMBOL_GPL(sysfs_remove_file);