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