sysfs: make sysfs_dirent->s_element a union
[safe/jmp/linux-2.6] / fs / sysfs / file.c
1 /*
2  * file.c - operations for regular (text) files.
3  */
4
5 #include <linux/module.h>
6 #include <linux/fsnotify.h>
7 #include <linux/kobject.h>
8 #include <linux/namei.h>
9 #include <linux/poll.h>
10 #include <linux/list.h>
11 #include <asm/uaccess.h>
12 #include <asm/semaphore.h>
13
14 #include "sysfs.h"
15
16 #define to_sattr(a) container_of(a,struct subsys_attribute, attr)
17
18 /*
19  * Subsystem file operations.
20  * These operations allow subsystems to have files that can be 
21  * read/written. 
22  */
23 static ssize_t 
24 subsys_attr_show(struct kobject * kobj, struct attribute * attr, char * page)
25 {
26         struct kset *kset = to_kset(kobj);
27         struct subsys_attribute * sattr = to_sattr(attr);
28         ssize_t ret = -EIO;
29
30         if (sattr->show)
31                 ret = sattr->show(kset, page);
32         return ret;
33 }
34
35 static ssize_t 
36 subsys_attr_store(struct kobject * kobj, struct attribute * attr, 
37                   const char * page, size_t count)
38 {
39         struct kset *kset = to_kset(kobj);
40         struct subsys_attribute * sattr = to_sattr(attr);
41         ssize_t ret = -EIO;
42
43         if (sattr->store)
44                 ret = sattr->store(kset, page, count);
45         return ret;
46 }
47
48 static struct sysfs_ops subsys_sysfs_ops = {
49         .show   = subsys_attr_show,
50         .store  = subsys_attr_store,
51 };
52
53 /**
54  *      add_to_collection - add buffer to a collection
55  *      @buffer:        buffer to be added
56  *      @node:          inode of set to add to
57  */
58
59 static inline void
60 add_to_collection(struct sysfs_buffer *buffer, struct inode *node)
61 {
62         struct sysfs_buffer_collection *set = node->i_private;
63
64         mutex_lock(&node->i_mutex);
65         list_add(&buffer->associates, &set->associates);
66         mutex_unlock(&node->i_mutex);
67 }
68
69 static inline void
70 remove_from_collection(struct sysfs_buffer *buffer, struct inode *node)
71 {
72         mutex_lock(&node->i_mutex);
73         list_del(&buffer->associates);
74         mutex_unlock(&node->i_mutex);
75 }
76
77 /**
78  *      fill_read_buffer - allocate and fill buffer from object.
79  *      @dentry:        dentry pointer.
80  *      @buffer:        data buffer for file.
81  *
82  *      Allocate @buffer->page, if it hasn't been already, then call the
83  *      kobject's show() method to fill the buffer with this attribute's 
84  *      data. 
85  *      This is called only once, on the file's first read unless an error
86  *      is returned.
87  */
88 static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
89 {
90         struct sysfs_dirent * sd = dentry->d_fsdata;
91         struct kobject * kobj = to_kobj(dentry->d_parent);
92         struct sysfs_ops * ops = buffer->ops;
93         int ret = 0;
94         ssize_t count;
95
96         if (!buffer->page)
97                 buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
98         if (!buffer->page)
99                 return -ENOMEM;
100
101         buffer->event = atomic_read(&sd->s_event);
102         count = ops->show(kobj, sd->s_elem.attr.attr, buffer->page);
103         BUG_ON(count > (ssize_t)PAGE_SIZE);
104         if (count >= 0) {
105                 buffer->needs_read_fill = 0;
106                 buffer->count = count;
107         } else {
108                 ret = count;
109         }
110         return ret;
111 }
112
113 /**
114  *      sysfs_read_file - read an attribute. 
115  *      @file:  file pointer.
116  *      @buf:   buffer to fill.
117  *      @count: number of bytes to read.
118  *      @ppos:  starting offset in file.
119  *
120  *      Userspace wants to read an attribute file. The attribute descriptor
121  *      is in the file's ->d_fsdata. The target object is in the directory's
122  *      ->d_fsdata.
123  *
124  *      We call fill_read_buffer() to allocate and fill the buffer from the
125  *      object's show() method exactly once (if the read is happening from
126  *      the beginning of the file). That should fill the entire buffer with
127  *      all the data the object has to offer for that attribute.
128  *      We then call flush_read_buffer() to copy the buffer to userspace
129  *      in the increments specified.
130  */
131
132 static ssize_t
133 sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
134 {
135         struct sysfs_buffer * buffer = file->private_data;
136         ssize_t retval = 0;
137
138         down(&buffer->sem);
139         if (buffer->needs_read_fill) {
140                 if (buffer->orphaned)
141                         retval = -ENODEV;
142                 else
143                         retval = fill_read_buffer(file->f_path.dentry,buffer);
144                 if (retval)
145                         goto out;
146         }
147         pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
148                  __FUNCTION__, count, *ppos, buffer->page);
149         retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
150                                          buffer->count);
151 out:
152         up(&buffer->sem);
153         return retval;
154 }
155
156 /**
157  *      fill_write_buffer - copy buffer from userspace.
158  *      @buffer:        data buffer for file.
159  *      @buf:           data from user.
160  *      @count:         number of bytes in @userbuf.
161  *
162  *      Allocate @buffer->page if it hasn't been already, then
163  *      copy the user-supplied buffer into it.
164  */
165
166 static int 
167 fill_write_buffer(struct sysfs_buffer * buffer, const char __user * buf, size_t count)
168 {
169         int error;
170
171         if (!buffer->page)
172                 buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
173         if (!buffer->page)
174                 return -ENOMEM;
175
176         if (count >= PAGE_SIZE)
177                 count = PAGE_SIZE - 1;
178         error = copy_from_user(buffer->page,buf,count);
179         buffer->needs_read_fill = 1;
180         /* if buf is assumed to contain a string, terminate it by \0,
181            so e.g. sscanf() can scan the string easily */
182         buffer->page[count] = 0;
183         return error ? -EFAULT : count;
184 }
185
186
187 /**
188  *      flush_write_buffer - push buffer to kobject.
189  *      @dentry:        dentry to the attribute
190  *      @buffer:        data buffer for file.
191  *      @count:         number of bytes
192  *
193  *      Get the correct pointers for the kobject and the attribute we're
194  *      dealing with, then call the store() method for the attribute, 
195  *      passing the buffer that we acquired in fill_write_buffer().
196  */
197
198 static int 
199 flush_write_buffer(struct dentry * dentry, struct sysfs_buffer * buffer, size_t count)
200 {
201         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
202         struct kobject * kobj = to_kobj(dentry->d_parent);
203         struct sysfs_ops * ops = buffer->ops;
204
205         return ops->store(kobj, attr_sd->s_elem.attr.attr, buffer->page, count);
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         down(&buffer->sem);
233         if (buffer->orphaned) {
234                 len = -ENODEV;
235                 goto out;
236         }
237         len = fill_write_buffer(buffer, buf, count);
238         if (len > 0)
239                 len = flush_write_buffer(file->f_path.dentry, buffer, len);
240         if (len > 0)
241                 *ppos += len;
242 out:
243         up(&buffer->sem);
244         return len;
245 }
246
247 static int sysfs_open_file(struct inode *inode, struct file *file)
248 {
249         struct kobject *kobj = sysfs_get_kobject(file->f_path.dentry->d_parent);
250         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
251         struct attribute *attr = attr_sd->s_elem.attr.attr;
252         struct sysfs_buffer_collection *set;
253         struct sysfs_buffer * buffer;
254         struct sysfs_ops * ops = NULL;
255         int error = 0;
256
257         if (!kobj || !attr)
258                 goto Einval;
259
260         /* Grab the module reference for this attribute if we have one */
261         if (!try_module_get(attr->owner)) {
262                 error = -ENODEV;
263                 goto Done;
264         }
265
266         /* if the kobject has no ktype, then we assume that it is a subsystem
267          * itself, and use ops for it.
268          */
269         if (kobj->kset && kobj->kset->ktype)
270                 ops = kobj->kset->ktype->sysfs_ops;
271         else if (kobj->ktype)
272                 ops = kobj->ktype->sysfs_ops;
273         else
274                 ops = &subsys_sysfs_ops;
275
276         /* No sysfs operations, either from having no subsystem,
277          * or the subsystem have no operations.
278          */
279         if (!ops)
280                 goto Eaccess;
281
282         /* make sure we have a collection to add our buffers to */
283         mutex_lock(&inode->i_mutex);
284         if (!(set = inode->i_private)) {
285                 if (!(set = inode->i_private = kmalloc(sizeof(struct sysfs_buffer_collection), GFP_KERNEL))) {
286                         error = -ENOMEM;
287                         goto Done;
288                 } else {
289                         INIT_LIST_HEAD(&set->associates);
290                 }
291         }
292         mutex_unlock(&inode->i_mutex);
293
294         /* File needs write support.
295          * The inode's perms must say it's ok, 
296          * and we must have a store method.
297          */
298         if (file->f_mode & FMODE_WRITE) {
299
300                 if (!(inode->i_mode & S_IWUGO) || !ops->store)
301                         goto Eaccess;
302
303         }
304
305         /* File needs read support.
306          * The inode's perms must say it's ok, and we there
307          * must be a show method for it.
308          */
309         if (file->f_mode & FMODE_READ) {
310                 if (!(inode->i_mode & S_IRUGO) || !ops->show)
311                         goto Eaccess;
312         }
313
314         /* No error? Great, allocate a buffer for the file, and store it
315          * it in file->private_data for easy access.
316          */
317         buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
318         if (buffer) {
319                 INIT_LIST_HEAD(&buffer->associates);
320                 init_MUTEX(&buffer->sem);
321                 buffer->needs_read_fill = 1;
322                 buffer->ops = ops;
323                 add_to_collection(buffer, inode);
324                 file->private_data = buffer;
325         } else
326                 error = -ENOMEM;
327         goto Done;
328
329  Einval:
330         error = -EINVAL;
331         goto Done;
332  Eaccess:
333         error = -EACCES;
334         module_put(attr->owner);
335  Done:
336         if (error)
337                 kobject_put(kobj);
338         return error;
339 }
340
341 static int sysfs_release(struct inode * inode, struct file * filp)
342 {
343         struct kobject * kobj = to_kobj(filp->f_path.dentry->d_parent);
344         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
345         struct attribute *attr = attr_sd->s_elem.attr.attr;
346         struct sysfs_buffer * buffer = filp->private_data;
347
348         if (buffer)
349                 remove_from_collection(buffer, inode);
350         kobject_put(kobj);
351         /* After this point, attr should not be accessed. */
352         module_put(attr->owner);
353
354         if (buffer) {
355                 if (buffer->page)
356                         free_page((unsigned long)buffer->page);
357                 kfree(buffer);
358         }
359         return 0;
360 }
361
362 /* Sysfs attribute files are pollable.  The idea is that you read
363  * the content and then you use 'poll' or 'select' to wait for
364  * the content to change.  When the content changes (assuming the
365  * manager for the kobject supports notification), poll will
366  * return POLLERR|POLLPRI, and select will return the fd whether
367  * it is waiting for read, write, or exceptions.
368  * Once poll/select indicates that the value has changed, you
369  * need to close and re-open the file, as simply seeking and reading
370  * again will not get new data, or reset the state of 'poll'.
371  * Reminder: this only works for attributes which actively support
372  * it, and it is not possible to test an attribute from userspace
373  * to see if it supports poll (Nether 'poll' or 'select' return
374  * an appropriate error code).  When in doubt, set a suitable timeout value.
375  */
376 static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
377 {
378         struct sysfs_buffer * buffer = filp->private_data;
379         struct kobject * kobj = to_kobj(filp->f_path.dentry->d_parent);
380         struct sysfs_dirent * sd = filp->f_path.dentry->d_fsdata;
381         int res = 0;
382
383         poll_wait(filp, &kobj->poll, wait);
384
385         if (buffer->event != atomic_read(&sd->s_event)) {
386                 res = POLLERR|POLLPRI;
387                 buffer->needs_read_fill = 1;
388         }
389
390         return res;
391 }
392
393
394 static struct dentry *step_down(struct dentry *dir, const char * name)
395 {
396         struct dentry * de;
397
398         if (dir == NULL || dir->d_inode == NULL)
399                 return NULL;
400
401         mutex_lock(&dir->d_inode->i_mutex);
402         de = lookup_one_len(name, dir, strlen(name));
403         mutex_unlock(&dir->d_inode->i_mutex);
404         dput(dir);
405         if (IS_ERR(de))
406                 return NULL;
407         if (de->d_inode == NULL) {
408                 dput(de);
409                 return NULL;
410         }
411         return de;
412 }
413
414 void sysfs_notify(struct kobject * k, char *dir, char *attr)
415 {
416         struct dentry *de = k->dentry;
417         if (de)
418                 dget(de);
419         if (de && dir)
420                 de = step_down(de, dir);
421         if (de && attr)
422                 de = step_down(de, attr);
423         if (de) {
424                 struct sysfs_dirent * sd = de->d_fsdata;
425                 if (sd)
426                         atomic_inc(&sd->s_event);
427                 wake_up_interruptible(&k->poll);
428                 dput(de);
429         }
430 }
431 EXPORT_SYMBOL_GPL(sysfs_notify);
432
433 const struct file_operations sysfs_file_operations = {
434         .read           = sysfs_read_file,
435         .write          = sysfs_write_file,
436         .llseek         = generic_file_llseek,
437         .open           = sysfs_open_file,
438         .release        = sysfs_release,
439         .poll           = sysfs_poll,
440 };
441
442
443 int sysfs_add_file(struct dentry * dir, const struct attribute * attr, int type)
444 {
445         struct sysfs_dirent * parent_sd = dir->d_fsdata;
446         umode_t mode = (attr->mode & S_IALLUGO) | S_IFREG;
447         struct sysfs_dirent *sd;
448         int error = 0;
449
450         mutex_lock(&dir->d_inode->i_mutex);
451
452         if (sysfs_dirent_exist(parent_sd, attr->name)) {
453                 error = -EEXIST;
454                 goto out_unlock;
455         }
456
457         sd = sysfs_new_dirent(attr->name, mode, type);
458         if (!sd) {
459                 error = -ENOMEM;
460                 goto out_unlock;
461         }
462         sd->s_elem.attr.attr = (void *)attr;
463         sysfs_attach_dirent(sd, parent_sd, NULL);
464
465  out_unlock:
466         mutex_unlock(&dir->d_inode->i_mutex);
467         return error;
468 }
469
470
471 /**
472  *      sysfs_create_file - create an attribute file for an object.
473  *      @kobj:  object we're creating for. 
474  *      @attr:  atrribute descriptor.
475  */
476
477 int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
478 {
479         BUG_ON(!kobj || !kobj->dentry || !attr);
480
481         return sysfs_add_file(kobj->dentry, attr, SYSFS_KOBJ_ATTR);
482
483 }
484
485
486 /**
487  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
488  * @kobj: object we're acting for.
489  * @attr: attribute descriptor.
490  * @group: group name.
491  */
492 int sysfs_add_file_to_group(struct kobject *kobj,
493                 const struct attribute *attr, const char *group)
494 {
495         struct dentry *dir;
496         int error;
497
498         dir = lookup_one_len(group, kobj->dentry, strlen(group));
499         if (IS_ERR(dir))
500                 error = PTR_ERR(dir);
501         else {
502                 error = sysfs_add_file(dir, attr, SYSFS_KOBJ_ATTR);
503                 dput(dir);
504         }
505         return error;
506 }
507 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
508
509
510 /**
511  * sysfs_update_file - update the modified timestamp on an object attribute.
512  * @kobj: object we're acting for.
513  * @attr: attribute descriptor.
514  */
515 int sysfs_update_file(struct kobject * kobj, const struct attribute * attr)
516 {
517         struct dentry * dir = kobj->dentry;
518         struct dentry * victim;
519         int res = -ENOENT;
520
521         mutex_lock(&dir->d_inode->i_mutex);
522         victim = lookup_one_len(attr->name, dir, strlen(attr->name));
523         if (!IS_ERR(victim)) {
524                 /* make sure dentry is really there */
525                 if (victim->d_inode && 
526                     (victim->d_parent->d_inode == dir->d_inode)) {
527                         victim->d_inode->i_mtime = CURRENT_TIME;
528                         fsnotify_modify(victim);
529                         res = 0;
530                 } else
531                         d_drop(victim);
532                 
533                 /**
534                  * Drop the reference acquired from lookup_one_len() above.
535                  */
536                 dput(victim);
537         }
538         mutex_unlock(&dir->d_inode->i_mutex);
539
540         return res;
541 }
542
543
544 /**
545  * sysfs_chmod_file - update the modified mode value on an object attribute.
546  * @kobj: object we're acting for.
547  * @attr: attribute descriptor.
548  * @mode: file permissions.
549  *
550  */
551 int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
552 {
553         struct dentry *dir = kobj->dentry;
554         struct dentry *victim;
555         struct inode * inode;
556         struct iattr newattrs;
557         int res = -ENOENT;
558
559         mutex_lock(&dir->d_inode->i_mutex);
560         victim = lookup_one_len(attr->name, dir, strlen(attr->name));
561         if (!IS_ERR(victim)) {
562                 if (victim->d_inode &&
563                     (victim->d_parent->d_inode == dir->d_inode)) {
564                         inode = victim->d_inode;
565                         mutex_lock(&inode->i_mutex);
566                         newattrs.ia_mode = (mode & S_IALLUGO) |
567                                                 (inode->i_mode & ~S_IALLUGO);
568                         newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
569                         res = notify_change(victim, &newattrs);
570                         mutex_unlock(&inode->i_mutex);
571                 }
572                 dput(victim);
573         }
574         mutex_unlock(&dir->d_inode->i_mutex);
575
576         return res;
577 }
578 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
579
580
581 /**
582  *      sysfs_remove_file - remove an object attribute.
583  *      @kobj:  object we're acting for.
584  *      @attr:  attribute descriptor.
585  *
586  *      Hash the attribute name and kill the victim.
587  */
588
589 void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
590 {
591         sysfs_hash_and_remove(kobj->dentry, attr->name);
592 }
593
594
595 /**
596  * sysfs_remove_file_from_group - remove an attribute file from a group.
597  * @kobj: object we're acting for.
598  * @attr: attribute descriptor.
599  * @group: group name.
600  */
601 void sysfs_remove_file_from_group(struct kobject *kobj,
602                 const struct attribute *attr, const char *group)
603 {
604         struct dentry *dir;
605
606         dir = lookup_one_len(group, kobj->dentry, strlen(group));
607         if (!IS_ERR(dir)) {
608                 sysfs_hash_and_remove(dir, attr->name);
609                 dput(dir);
610         }
611 }
612 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
613
614 struct sysfs_schedule_callback_struct {
615         struct kobject          *kobj;
616         void                    (*func)(void *);
617         void                    *data;
618         struct module           *owner;
619         struct work_struct      work;
620 };
621
622 static void sysfs_schedule_callback_work(struct work_struct *work)
623 {
624         struct sysfs_schedule_callback_struct *ss = container_of(work,
625                         struct sysfs_schedule_callback_struct, work);
626
627         (ss->func)(ss->data);
628         kobject_put(ss->kobj);
629         module_put(ss->owner);
630         kfree(ss);
631 }
632
633 /**
634  * sysfs_schedule_callback - helper to schedule a callback for a kobject
635  * @kobj: object we're acting for.
636  * @func: callback function to invoke later.
637  * @data: argument to pass to @func.
638  * @owner: module owning the callback code
639  *
640  * sysfs attribute methods must not unregister themselves or their parent
641  * kobject (which would amount to the same thing).  Attempts to do so will
642  * deadlock, since unregistration is mutually exclusive with driver
643  * callbacks.
644  *
645  * Instead methods can call this routine, which will attempt to allocate
646  * and schedule a workqueue request to call back @func with @data as its
647  * argument in the workqueue's process context.  @kobj will be pinned
648  * until @func returns.
649  *
650  * Returns 0 if the request was submitted, -ENOMEM if storage could not
651  * be allocated, -ENODEV if a reference to @owner isn't available.
652  */
653 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
654                 void *data, struct module *owner)
655 {
656         struct sysfs_schedule_callback_struct *ss;
657
658         if (!try_module_get(owner))
659                 return -ENODEV;
660         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
661         if (!ss) {
662                 module_put(owner);
663                 return -ENOMEM;
664         }
665         kobject_get(kobj);
666         ss->kobj = kobj;
667         ss->func = func;
668         ss->data = data;
669         ss->owner = owner;
670         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
671         schedule_work(&ss->work);
672         return 0;
673 }
674 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);
675
676
677 EXPORT_SYMBOL_GPL(sysfs_create_file);
678 EXPORT_SYMBOL_GPL(sysfs_remove_file);
679 EXPORT_SYMBOL_GPL(sysfs_update_file);