2 * fs/sysfs/file.c - sysfs regular (text) file implementation
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8 * This file is released under the GPLv2.
10 * Please see Documentation/filesystems/sysfs.txt for more information.
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>
27 /* used in crash dumps to help with debugging */
28 static char last_sysfs_file[PATH_MAX];
29 void sysfs_printk_last_file(void)
31 printk(KERN_EMERG "last sysfs file: %s\n", last_sysfs_file);
35 * There's one sysfs_buffer for each open file and one
36 * sysfs_open_dirent for each sysfs_dirent with one or more open
39 * filp->private_data points to sysfs_buffer and
40 * sysfs_dirent->s_attr.open points to sysfs_open_dirent. s_attr.open
41 * is protected by sysfs_open_dirent_lock.
43 static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
45 struct sysfs_open_dirent {
48 wait_queue_head_t poll;
49 struct list_head buffers; /* goes through sysfs_buffer.list */
56 struct sysfs_ops * ops;
60 struct list_head list;
64 * fill_read_buffer - allocate and fill buffer from object.
65 * @dentry: dentry pointer.
66 * @buffer: data buffer for file.
68 * Allocate @buffer->page, if it hasn't been already, then call the
69 * kobject's show() method to fill the buffer with this attribute's
71 * This is called only once, on the file's first read unless an error
74 static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
76 struct sysfs_dirent *attr_sd = dentry->d_fsdata;
77 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
78 struct sysfs_ops * ops = buffer->ops;
83 buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
87 /* need attr_sd for attr and ops, its parent for kobj */
88 if (!sysfs_get_active_two(attr_sd))
91 buffer->event = atomic_read(&attr_sd->s_attr.open->event);
92 count = ops->show(kobj, attr_sd->s_attr.attr, buffer->page);
94 sysfs_put_active_two(attr_sd);
97 * The code works fine with PAGE_SIZE return but it's likely to
98 * indicate truncated result or overflow in normal use cases.
100 if (count >= (ssize_t)PAGE_SIZE) {
101 print_symbol("fill_read_buffer: %s returned bad count\n",
102 (unsigned long)ops->show);
103 /* Try to struggle along */
104 count = PAGE_SIZE - 1;
107 buffer->needs_read_fill = 0;
108 buffer->count = count;
116 * sysfs_read_file - read an attribute.
117 * @file: file pointer.
118 * @buf: buffer to fill.
119 * @count: number of bytes to read.
120 * @ppos: starting offset in file.
122 * Userspace wants to read an attribute file. The attribute descriptor
123 * is in the file's ->d_fsdata. The target object is in the directory's
126 * We call fill_read_buffer() to allocate and fill the buffer from the
127 * object's show() method exactly once (if the read is happening from
128 * the beginning of the file). That should fill the entire buffer with
129 * all the data the object has to offer for that attribute.
130 * We then call flush_read_buffer() to copy the buffer to userspace
131 * in the increments specified.
135 sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
137 struct sysfs_buffer * buffer = file->private_data;
140 mutex_lock(&buffer->mutex);
141 if (buffer->needs_read_fill || *ppos == 0) {
142 retval = fill_read_buffer(file->f_path.dentry,buffer);
146 pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
147 __func__, count, *ppos, buffer->page);
148 retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
151 mutex_unlock(&buffer->mutex);
156 * fill_write_buffer - copy buffer from userspace.
157 * @buffer: data buffer for file.
158 * @buf: data from user.
159 * @count: number of bytes in @userbuf.
161 * Allocate @buffer->page if it hasn't been already, then
162 * copy the user-supplied buffer into it.
166 fill_write_buffer(struct sysfs_buffer * buffer, const char __user * buf, size_t count)
171 buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
175 if (count >= PAGE_SIZE)
176 count = PAGE_SIZE - 1;
177 error = copy_from_user(buffer->page,buf,count);
178 buffer->needs_read_fill = 1;
179 /* if buf is assumed to contain a string, terminate it by \0,
180 so e.g. sscanf() can scan the string easily */
181 buffer->page[count] = 0;
182 return error ? -EFAULT : count;
187 * flush_write_buffer - push buffer to kobject.
188 * @dentry: dentry to the attribute
189 * @buffer: data buffer for file.
190 * @count: number of bytes
192 * Get the correct pointers for the kobject and the attribute we're
193 * dealing with, then call the store() method for the attribute,
194 * passing the buffer that we acquired in fill_write_buffer().
198 flush_write_buffer(struct dentry * dentry, struct sysfs_buffer * buffer, size_t count)
200 struct sysfs_dirent *attr_sd = dentry->d_fsdata;
201 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
202 struct sysfs_ops * ops = buffer->ops;
205 /* need attr_sd for attr and ops, its parent for kobj */
206 if (!sysfs_get_active_two(attr_sd))
209 rc = ops->store(kobj, attr_sd->s_attr.attr, buffer->page, count);
211 sysfs_put_active_two(attr_sd);
218 * sysfs_write_file - write an attribute.
219 * @file: file pointer
220 * @buf: data to write
221 * @count: number of bytes
222 * @ppos: starting offset
224 * Similar to sysfs_read_file(), though working in the opposite direction.
225 * We allocate and fill the data from the user in fill_write_buffer(),
226 * then push it to the kobject in flush_write_buffer().
227 * There is no easy way for us to know if userspace is only doing a partial
228 * write, so we don't support them. We expect the entire buffer to come
229 * on the first write.
230 * Hint: if you're writing a value, first read the file, modify only the
231 * the value you're changing, then write entire buffer back.
235 sysfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
237 struct sysfs_buffer * buffer = file->private_data;
240 mutex_lock(&buffer->mutex);
241 len = fill_write_buffer(buffer, buf, count);
243 len = flush_write_buffer(file->f_path.dentry, buffer, len);
246 mutex_unlock(&buffer->mutex);
251 * sysfs_get_open_dirent - get or create sysfs_open_dirent
252 * @sd: target sysfs_dirent
253 * @buffer: sysfs_buffer for this instance of open
255 * If @sd->s_attr.open exists, increment its reference count;
256 * otherwise, create one. @buffer is chained to the buffers
260 * Kernel thread context (may sleep).
263 * 0 on success, -errno on failure.
265 static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
266 struct sysfs_buffer *buffer)
268 struct sysfs_open_dirent *od, *new_od = NULL;
271 spin_lock(&sysfs_open_dirent_lock);
273 if (!sd->s_attr.open && new_od) {
274 sd->s_attr.open = new_od;
278 od = sd->s_attr.open;
280 atomic_inc(&od->refcnt);
281 list_add_tail(&buffer->list, &od->buffers);
284 spin_unlock(&sysfs_open_dirent_lock);
291 /* not there, initialize a new one and retry */
292 new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
296 atomic_set(&new_od->refcnt, 0);
297 atomic_set(&new_od->event, 1);
298 init_waitqueue_head(&new_od->poll);
299 INIT_LIST_HEAD(&new_od->buffers);
304 * sysfs_put_open_dirent - put sysfs_open_dirent
305 * @sd: target sysfs_dirent
306 * @buffer: associated sysfs_buffer
308 * Put @sd->s_attr.open and unlink @buffer from the buffers list.
309 * If reference count reaches zero, disassociate and free it.
314 static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
315 struct sysfs_buffer *buffer)
317 struct sysfs_open_dirent *od = sd->s_attr.open;
319 spin_lock(&sysfs_open_dirent_lock);
321 list_del(&buffer->list);
322 if (atomic_dec_and_test(&od->refcnt))
323 sd->s_attr.open = NULL;
327 spin_unlock(&sysfs_open_dirent_lock);
332 static int sysfs_open_file(struct inode *inode, struct file *file)
334 struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
335 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
336 struct sysfs_buffer *buffer;
337 struct sysfs_ops *ops;
341 p = d_path(&file->f_path, last_sysfs_file, sizeof(last_sysfs_file));
343 memmove(last_sysfs_file, p, strlen(p) + 1);
345 /* need attr_sd for attr and ops, its parent for kobj */
346 if (!sysfs_get_active_two(attr_sd))
349 /* every kobject with an attribute needs a ktype assigned */
350 if (kobj->ktype && kobj->ktype->sysfs_ops)
351 ops = kobj->ktype->sysfs_ops;
353 WARN(1, KERN_ERR "missing sysfs attribute operations for "
354 "kobject: %s\n", kobject_name(kobj));
358 /* File needs write support.
359 * The inode's perms must say it's ok,
360 * and we must have a store method.
362 if (file->f_mode & FMODE_WRITE) {
363 if (!(inode->i_mode & S_IWUGO) || !ops->store)
367 /* File needs read support.
368 * The inode's perms must say it's ok, and we there
369 * must be a show method for it.
371 if (file->f_mode & FMODE_READ) {
372 if (!(inode->i_mode & S_IRUGO) || !ops->show)
376 /* No error? Great, allocate a buffer for the file, and store it
377 * it in file->private_data for easy access.
380 buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
384 mutex_init(&buffer->mutex);
385 buffer->needs_read_fill = 1;
387 file->private_data = buffer;
389 /* make sure we have open dirent struct */
390 error = sysfs_get_open_dirent(attr_sd, buffer);
394 /* open succeeded, put active references */
395 sysfs_put_active_two(attr_sd);
401 sysfs_put_active_two(attr_sd);
405 static int sysfs_release(struct inode *inode, struct file *filp)
407 struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
408 struct sysfs_buffer *buffer = filp->private_data;
410 sysfs_put_open_dirent(sd, buffer);
413 free_page((unsigned long)buffer->page);
419 /* Sysfs attribute files are pollable. The idea is that you read
420 * the content and then you use 'poll' or 'select' to wait for
421 * the content to change. When the content changes (assuming the
422 * manager for the kobject supports notification), poll will
423 * return POLLERR|POLLPRI, and select will return the fd whether
424 * it is waiting for read, write, or exceptions.
425 * Once poll/select indicates that the value has changed, you
426 * need to close and re-open the file, or seek to 0 and read again.
427 * Reminder: this only works for attributes which actively support
428 * it, and it is not possible to test an attribute from userspace
429 * to see if it supports poll (Neither 'poll' nor 'select' return
430 * an appropriate error code). When in doubt, set a suitable timeout value.
432 static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
434 struct sysfs_buffer * buffer = filp->private_data;
435 struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
436 struct sysfs_open_dirent *od = attr_sd->s_attr.open;
438 /* need parent for the kobj, grab both */
439 if (!sysfs_get_active_two(attr_sd))
442 poll_wait(filp, &od->poll, wait);
444 sysfs_put_active_two(attr_sd);
446 if (buffer->event != atomic_read(&od->event))
449 return DEFAULT_POLLMASK;
452 buffer->needs_read_fill = 1;
453 return DEFAULT_POLLMASK|POLLERR|POLLPRI;
456 void sysfs_notify_dirent(struct sysfs_dirent *sd)
458 struct sysfs_open_dirent *od;
460 spin_lock(&sysfs_open_dirent_lock);
462 od = sd->s_attr.open;
464 atomic_inc(&od->event);
465 wake_up_interruptible(&od->poll);
468 spin_unlock(&sysfs_open_dirent_lock);
470 EXPORT_SYMBOL_GPL(sysfs_notify_dirent);
472 void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
474 struct sysfs_dirent *sd = k->sd;
476 mutex_lock(&sysfs_mutex);
479 sd = sysfs_find_dirent(sd, dir);
481 sd = sysfs_find_dirent(sd, attr);
483 sysfs_notify_dirent(sd);
485 mutex_unlock(&sysfs_mutex);
487 EXPORT_SYMBOL_GPL(sysfs_notify);
489 const struct file_operations sysfs_file_operations = {
490 .read = sysfs_read_file,
491 .write = sysfs_write_file,
492 .llseek = generic_file_llseek,
493 .open = sysfs_open_file,
494 .release = sysfs_release,
498 int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
499 const struct attribute *attr, int type, mode_t amode)
501 umode_t mode = (amode & S_IALLUGO) | S_IFREG;
502 struct sysfs_addrm_cxt acxt;
503 struct sysfs_dirent *sd;
506 sd = sysfs_new_dirent(attr->name, mode, type);
509 sd->s_attr.attr = (void *)attr;
511 sysfs_addrm_start(&acxt, dir_sd);
512 rc = sysfs_add_one(&acxt, sd);
513 sysfs_addrm_finish(&acxt);
522 int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
525 return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
530 * sysfs_create_file - create an attribute file for an object.
531 * @kobj: object we're creating for.
532 * @attr: attribute descriptor.
535 int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
537 BUG_ON(!kobj || !kobj->sd || !attr);
539 return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
545 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
546 * @kobj: object we're acting for.
547 * @attr: attribute descriptor.
548 * @group: group name.
550 int sysfs_add_file_to_group(struct kobject *kobj,
551 const struct attribute *attr, const char *group)
553 struct sysfs_dirent *dir_sd;
557 dir_sd = sysfs_get_dirent(kobj->sd, group);
559 dir_sd = sysfs_get(kobj->sd);
564 error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
569 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
572 * sysfs_chmod_file - update the modified mode value on an object attribute.
573 * @kobj: object we're acting for.
574 * @attr: attribute descriptor.
575 * @mode: file permissions.
578 int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
580 struct sysfs_dirent *victim_sd = NULL;
581 struct dentry *victim = NULL;
582 struct inode * inode;
583 struct iattr newattrs;
587 victim_sd = sysfs_get_dirent(kobj->sd, attr->name);
591 mutex_lock(&sysfs_rename_mutex);
592 victim = sysfs_get_dentry(victim_sd);
593 mutex_unlock(&sysfs_rename_mutex);
594 if (IS_ERR(victim)) {
595 rc = PTR_ERR(victim);
600 inode = victim->d_inode;
602 mutex_lock(&inode->i_mutex);
604 newattrs.ia_mode = (mode & S_IALLUGO) | (inode->i_mode & ~S_IALLUGO);
605 newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
606 newattrs.ia_ctime = current_fs_time(inode->i_sb);
607 rc = sysfs_setattr(victim, &newattrs);
610 fsnotify_change(victim, newattrs.ia_valid);
611 mutex_lock(&sysfs_mutex);
612 victim_sd->s_mode = newattrs.ia_mode;
613 mutex_unlock(&sysfs_mutex);
616 mutex_unlock(&inode->i_mutex);
619 sysfs_put(victim_sd);
622 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
626 * sysfs_remove_file - remove an object attribute.
627 * @kobj: object we're acting for.
628 * @attr: attribute descriptor.
630 * Hash the attribute name and kill the victim.
633 void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
635 sysfs_hash_and_remove(kobj->sd, attr->name);
640 * sysfs_remove_file_from_group - remove an attribute file from a group.
641 * @kobj: object we're acting for.
642 * @attr: attribute descriptor.
643 * @group: group name.
645 void sysfs_remove_file_from_group(struct kobject *kobj,
646 const struct attribute *attr, const char *group)
648 struct sysfs_dirent *dir_sd;
651 dir_sd = sysfs_get_dirent(kobj->sd, group);
653 dir_sd = sysfs_get(kobj->sd);
655 sysfs_hash_and_remove(dir_sd, attr->name);
659 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
661 struct sysfs_schedule_callback_struct {
662 struct list_head workq_list;
663 struct kobject *kobj;
664 void (*func)(void *);
666 struct module *owner;
667 struct work_struct work;
670 static struct workqueue_struct *sysfs_workqueue;
671 static DEFINE_MUTEX(sysfs_workq_mutex);
672 static LIST_HEAD(sysfs_workq);
673 static void sysfs_schedule_callback_work(struct work_struct *work)
675 struct sysfs_schedule_callback_struct *ss = container_of(work,
676 struct sysfs_schedule_callback_struct, work);
678 (ss->func)(ss->data);
679 kobject_put(ss->kobj);
680 module_put(ss->owner);
681 mutex_lock(&sysfs_workq_mutex);
682 list_del(&ss->workq_list);
683 mutex_unlock(&sysfs_workq_mutex);
688 * sysfs_schedule_callback - helper to schedule a callback for a kobject
689 * @kobj: object we're acting for.
690 * @func: callback function to invoke later.
691 * @data: argument to pass to @func.
692 * @owner: module owning the callback code
694 * sysfs attribute methods must not unregister themselves or their parent
695 * kobject (which would amount to the same thing). Attempts to do so will
696 * deadlock, since unregistration is mutually exclusive with driver
699 * Instead methods can call this routine, which will attempt to allocate
700 * and schedule a workqueue request to call back @func with @data as its
701 * argument in the workqueue's process context. @kobj will be pinned
702 * until @func returns.
704 * Returns 0 if the request was submitted, -ENOMEM if storage could not
705 * be allocated, -ENODEV if a reference to @owner isn't available,
706 * -EAGAIN if a callback has already been scheduled for @kobj.
708 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
709 void *data, struct module *owner)
711 struct sysfs_schedule_callback_struct *ss, *tmp;
713 if (!try_module_get(owner))
716 mutex_lock(&sysfs_workq_mutex);
717 list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
718 if (ss->kobj == kobj) {
720 mutex_unlock(&sysfs_workq_mutex);
723 mutex_unlock(&sysfs_workq_mutex);
725 if (sysfs_workqueue == NULL) {
726 sysfs_workqueue = create_workqueue("sysfsd");
727 if (sysfs_workqueue == NULL) {
733 ss = kmalloc(sizeof(*ss), GFP_KERNEL);
743 INIT_WORK(&ss->work, sysfs_schedule_callback_work);
744 INIT_LIST_HEAD(&ss->workq_list);
745 mutex_lock(&sysfs_workq_mutex);
746 list_add_tail(&ss->workq_list, &sysfs_workq);
747 mutex_unlock(&sysfs_workq_mutex);
748 queue_work(sysfs_workqueue, &ss->work);
751 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);
754 EXPORT_SYMBOL_GPL(sysfs_create_file);
755 EXPORT_SYMBOL_GPL(sysfs_remove_file);