2 * file.c - operations for regular (text) files.
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>
16 #define to_subsys(k) container_of(k,struct subsystem,kset.kobj)
17 #define to_sattr(a) container_of(a,struct subsys_attribute,attr)
20 * Subsystem file operations.
21 * These operations allow subsystems to have files that can be
25 subsys_attr_show(struct kobject
* kobj
, struct attribute
* attr
, char * page
)
27 struct subsystem
* s
= to_subsys(kobj
);
28 struct subsys_attribute
* sattr
= to_sattr(attr
);
32 ret
= sattr
->show(s
,page
);
37 subsys_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
38 const char * page
, size_t count
)
40 struct subsystem
* s
= to_subsys(kobj
);
41 struct subsys_attribute
* sattr
= to_sattr(attr
);
45 ret
= sattr
->store(s
,page
,count
);
49 static struct sysfs_ops subsys_sysfs_ops
= {
50 .show
= subsys_attr_show
,
51 .store
= subsys_attr_store
,
55 * add_to_collection - add buffer to a collection
56 * @buffer: buffer to be added
57 * @node: inode of set to add to
61 add_to_collection(struct sysfs_buffer
*buffer
, struct inode
*node
)
63 struct sysfs_buffer_collection
*set
= node
->i_private
;
65 mutex_lock(&node
->i_mutex
);
66 list_add(&buffer
->associates
, &set
->associates
);
67 mutex_unlock(&node
->i_mutex
);
71 remove_from_collection(struct sysfs_buffer
*buffer
, struct inode
*node
)
73 mutex_lock(&node
->i_mutex
);
74 list_del(&buffer
->associates
);
75 mutex_unlock(&node
->i_mutex
);
79 * fill_read_buffer - allocate and fill buffer from object.
80 * @dentry: dentry pointer.
81 * @buffer: data buffer for file.
83 * Allocate @buffer->page, if it hasn't been already, then call the
84 * kobject's show() method to fill the buffer with this attribute's
86 * This is called only once, on the file's first read unless an error
89 static int fill_read_buffer(struct dentry
* dentry
, struct sysfs_buffer
* buffer
)
91 struct sysfs_dirent
* sd
= dentry
->d_fsdata
;
92 struct attribute
* attr
= to_attr(dentry
);
93 struct kobject
* kobj
= to_kobj(dentry
->d_parent
);
94 struct sysfs_ops
* ops
= buffer
->ops
;
99 buffer
->page
= (char *) get_zeroed_page(GFP_KERNEL
);
103 buffer
->event
= atomic_read(&sd
->s_event
);
104 count
= ops
->show(kobj
,attr
,buffer
->page
);
105 BUG_ON(count
> (ssize_t
)PAGE_SIZE
);
107 buffer
->needs_read_fill
= 0;
108 buffer
->count
= count
;
117 * flush_read_buffer - push buffer to userspace.
118 * @buffer: data buffer for file.
119 * @buf: user-passed buffer.
120 * @count: number of bytes requested.
121 * @ppos: file position.
123 * Copy the buffer we filled in fill_read_buffer() to userspace.
124 * This is done at the reader's leisure, copying and advancing
125 * the amount they specify each time.
126 * This may be called continuously until the buffer is empty.
128 static int flush_read_buffer(struct sysfs_buffer
* buffer
, char __user
* buf
,
129 size_t count
, loff_t
* ppos
)
133 if (*ppos
> buffer
->count
)
136 if (count
> (buffer
->count
- *ppos
))
137 count
= buffer
->count
- *ppos
;
139 error
= copy_to_user(buf
,buffer
->page
+ *ppos
,count
);
142 return error
? -EFAULT
: count
;
146 * sysfs_read_file - read an attribute.
147 * @file: file pointer.
148 * @buf: buffer to fill.
149 * @count: number of bytes to read.
150 * @ppos: starting offset in file.
152 * Userspace wants to read an attribute file. The attribute descriptor
153 * is in the file's ->d_fsdata. The target object is in the directory's
156 * We call fill_read_buffer() to allocate and fill the buffer from the
157 * object's show() method exactly once (if the read is happening from
158 * the beginning of the file). That should fill the entire buffer with
159 * all the data the object has to offer for that attribute.
160 * We then call flush_read_buffer() to copy the buffer to userspace
161 * in the increments specified.
165 sysfs_read_file(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*ppos
)
167 struct sysfs_buffer
* buffer
= file
->private_data
;
171 if (buffer
->orphaned
) {
175 if (buffer
->needs_read_fill
) {
176 if ((retval
= fill_read_buffer(file
->f_path
.dentry
,buffer
)))
179 pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
180 __FUNCTION__
, count
, *ppos
, buffer
->page
);
181 retval
= flush_read_buffer(buffer
,buf
,count
,ppos
);
188 * fill_write_buffer - copy buffer from userspace.
189 * @buffer: data buffer for file.
190 * @buf: data from user.
191 * @count: number of bytes in @userbuf.
193 * Allocate @buffer->page if it hasn't been already, then
194 * copy the user-supplied buffer into it.
198 fill_write_buffer(struct sysfs_buffer
* buffer
, const char __user
* buf
, size_t count
)
203 buffer
->page
= (char *)get_zeroed_page(GFP_KERNEL
);
207 if (count
>= PAGE_SIZE
)
208 count
= PAGE_SIZE
- 1;
209 error
= copy_from_user(buffer
->page
,buf
,count
);
210 buffer
->needs_read_fill
= 1;
211 /* if buf is assumed to contain a string, terminate it by \0,
212 so e.g. sscanf() can scan the string easily */
213 buffer
->page
[count
] = 0;
214 return error
? -EFAULT
: count
;
219 * flush_write_buffer - push buffer to kobject.
220 * @dentry: dentry to the attribute
221 * @buffer: data buffer for file.
222 * @count: number of bytes
224 * Get the correct pointers for the kobject and the attribute we're
225 * dealing with, then call the store() method for the attribute,
226 * passing the buffer that we acquired in fill_write_buffer().
230 flush_write_buffer(struct dentry
* dentry
, struct sysfs_buffer
* buffer
, size_t count
)
232 struct attribute
* attr
= to_attr(dentry
);
233 struct kobject
* kobj
= to_kobj(dentry
->d_parent
);
234 struct sysfs_ops
* ops
= buffer
->ops
;
236 return ops
->store(kobj
,attr
,buffer
->page
,count
);
241 * sysfs_write_file - write an attribute.
242 * @file: file pointer
243 * @buf: data to write
244 * @count: number of bytes
245 * @ppos: starting offset
247 * Similar to sysfs_read_file(), though working in the opposite direction.
248 * We allocate and fill the data from the user in fill_write_buffer(),
249 * then push it to the kobject in flush_write_buffer().
250 * There is no easy way for us to know if userspace is only doing a partial
251 * write, so we don't support them. We expect the entire buffer to come
252 * on the first write.
253 * Hint: if you're writing a value, first read the file, modify only the
254 * the value you're changing, then write entire buffer back.
258 sysfs_write_file(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*ppos
)
260 struct sysfs_buffer
* buffer
= file
->private_data
;
264 if (buffer
->orphaned
) {
268 len
= fill_write_buffer(buffer
, buf
, count
);
270 len
= flush_write_buffer(file
->f_path
.dentry
, buffer
, len
);
278 static int sysfs_open_file(struct inode
*inode
, struct file
*file
)
280 struct kobject
*kobj
= sysfs_get_kobject(file
->f_path
.dentry
->d_parent
);
281 struct attribute
* attr
= to_attr(file
->f_path
.dentry
);
282 struct sysfs_buffer_collection
*set
;
283 struct sysfs_buffer
* buffer
;
284 struct sysfs_ops
* ops
= NULL
;
290 /* Grab the module reference for this attribute if we have one */
291 if (!try_module_get(attr
->owner
)) {
296 /* if the kobject has no ktype, then we assume that it is a subsystem
297 * itself, and use ops for it.
299 if (kobj
->kset
&& kobj
->kset
->ktype
)
300 ops
= kobj
->kset
->ktype
->sysfs_ops
;
301 else if (kobj
->ktype
)
302 ops
= kobj
->ktype
->sysfs_ops
;
304 ops
= &subsys_sysfs_ops
;
306 /* No sysfs operations, either from having no subsystem,
307 * or the subsystem have no operations.
312 /* make sure we have a collection to add our buffers to */
313 mutex_lock(&inode
->i_mutex
);
314 if (!(set
= inode
->i_private
)) {
315 if (!(set
= inode
->i_private
= kmalloc(sizeof(struct sysfs_buffer_collection
), GFP_KERNEL
))) {
319 INIT_LIST_HEAD(&set
->associates
);
322 mutex_unlock(&inode
->i_mutex
);
324 /* File needs write support.
325 * The inode's perms must say it's ok,
326 * and we must have a store method.
328 if (file
->f_mode
& FMODE_WRITE
) {
330 if (!(inode
->i_mode
& S_IWUGO
) || !ops
->store
)
335 /* File needs read support.
336 * The inode's perms must say it's ok, and we there
337 * must be a show method for it.
339 if (file
->f_mode
& FMODE_READ
) {
340 if (!(inode
->i_mode
& S_IRUGO
) || !ops
->show
)
344 /* No error? Great, allocate a buffer for the file, and store it
345 * it in file->private_data for easy access.
347 buffer
= kzalloc(sizeof(struct sysfs_buffer
), GFP_KERNEL
);
349 INIT_LIST_HEAD(&buffer
->associates
);
350 init_MUTEX(&buffer
->sem
);
351 buffer
->needs_read_fill
= 1;
353 add_to_collection(buffer
, inode
);
354 file
->private_data
= buffer
;
364 module_put(attr
->owner
);
371 static int sysfs_release(struct inode
* inode
, struct file
* filp
)
373 struct kobject
* kobj
= to_kobj(filp
->f_path
.dentry
->d_parent
);
374 struct attribute
* attr
= to_attr(filp
->f_path
.dentry
);
375 struct module
* owner
= attr
->owner
;
376 struct sysfs_buffer
* buffer
= filp
->private_data
;
379 remove_from_collection(buffer
, inode
);
381 /* After this point, attr should not be accessed. */
386 free_page((unsigned long)buffer
->page
);
392 /* Sysfs attribute files are pollable. The idea is that you read
393 * the content and then you use 'poll' or 'select' to wait for
394 * the content to change. When the content changes (assuming the
395 * manager for the kobject supports notification), poll will
396 * return POLLERR|POLLPRI, and select will return the fd whether
397 * it is waiting for read, write, or exceptions.
398 * Once poll/select indicates that the value has changed, you
399 * need to close and re-open the file, as simply seeking and reading
400 * again will not get new data, or reset the state of 'poll'.
401 * Reminder: this only works for attributes which actively support
402 * it, and it is not possible to test an attribute from userspace
403 * to see if it supports poll (Nether 'poll' or 'select' return
404 * an appropriate error code). When in doubt, set a suitable timeout value.
406 static unsigned int sysfs_poll(struct file
*filp
, poll_table
*wait
)
408 struct sysfs_buffer
* buffer
= filp
->private_data
;
409 struct kobject
* kobj
= to_kobj(filp
->f_path
.dentry
->d_parent
);
410 struct sysfs_dirent
* sd
= filp
->f_path
.dentry
->d_fsdata
;
413 poll_wait(filp
, &kobj
->poll
, wait
);
415 if (buffer
->event
!= atomic_read(&sd
->s_event
)) {
416 res
= POLLERR
|POLLPRI
;
417 buffer
->needs_read_fill
= 1;
424 static struct dentry
*step_down(struct dentry
*dir
, const char * name
)
428 if (dir
== NULL
|| dir
->d_inode
== NULL
)
431 mutex_lock(&dir
->d_inode
->i_mutex
);
432 de
= lookup_one_len(name
, dir
, strlen(name
));
433 mutex_unlock(&dir
->d_inode
->i_mutex
);
437 if (de
->d_inode
== NULL
) {
444 void sysfs_notify(struct kobject
* k
, char *dir
, char *attr
)
446 struct dentry
*de
= k
->dentry
;
450 de
= step_down(de
, dir
);
452 de
= step_down(de
, attr
);
454 struct sysfs_dirent
* sd
= de
->d_fsdata
;
456 atomic_inc(&sd
->s_event
);
457 wake_up_interruptible(&k
->poll
);
461 EXPORT_SYMBOL_GPL(sysfs_notify
);
463 const struct file_operations sysfs_file_operations
= {
464 .read
= sysfs_read_file
,
465 .write
= sysfs_write_file
,
466 .llseek
= generic_file_llseek
,
467 .open
= sysfs_open_file
,
468 .release
= sysfs_release
,
473 int sysfs_add_file(struct dentry
* dir
, const struct attribute
* attr
, int type
)
475 struct sysfs_dirent
* parent_sd
= dir
->d_fsdata
;
476 umode_t mode
= (attr
->mode
& S_IALLUGO
) | S_IFREG
;
479 mutex_lock(&dir
->d_inode
->i_mutex
);
480 if (!sysfs_dirent_exist(parent_sd
, attr
->name
))
481 error
= sysfs_make_dirent(parent_sd
, NULL
, (void *)attr
,
483 mutex_unlock(&dir
->d_inode
->i_mutex
);
490 * sysfs_create_file - create an attribute file for an object.
491 * @kobj: object we're creating for.
492 * @attr: atrribute descriptor.
495 int sysfs_create_file(struct kobject
* kobj
, const struct attribute
* attr
)
497 BUG_ON(!kobj
|| !kobj
->dentry
|| !attr
);
499 return sysfs_add_file(kobj
->dentry
, attr
, SYSFS_KOBJ_ATTR
);
505 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
506 * @kobj: object we're acting for.
507 * @attr: attribute descriptor.
508 * @group: group name.
510 int sysfs_add_file_to_group(struct kobject
*kobj
,
511 const struct attribute
*attr
, const char *group
)
516 dir
= lookup_one_len(group
, kobj
->dentry
, strlen(group
));
518 error
= PTR_ERR(dir
);
520 error
= sysfs_add_file(dir
, attr
, SYSFS_KOBJ_ATTR
);
525 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group
);
529 * sysfs_update_file - update the modified timestamp on an object attribute.
530 * @kobj: object we're acting for.
531 * @attr: attribute descriptor.
533 int sysfs_update_file(struct kobject
* kobj
, const struct attribute
* attr
)
535 struct dentry
* dir
= kobj
->dentry
;
536 struct dentry
* victim
;
539 mutex_lock(&dir
->d_inode
->i_mutex
);
540 victim
= lookup_one_len(attr
->name
, dir
, strlen(attr
->name
));
541 if (!IS_ERR(victim
)) {
542 /* make sure dentry is really there */
543 if (victim
->d_inode
&&
544 (victim
->d_parent
->d_inode
== dir
->d_inode
)) {
545 victim
->d_inode
->i_mtime
= CURRENT_TIME
;
546 fsnotify_modify(victim
);
552 * Drop the reference acquired from lookup_one_len() above.
556 mutex_unlock(&dir
->d_inode
->i_mutex
);
563 * sysfs_chmod_file - update the modified mode value on an object attribute.
564 * @kobj: object we're acting for.
565 * @attr: attribute descriptor.
566 * @mode: file permissions.
569 int sysfs_chmod_file(struct kobject
*kobj
, struct attribute
*attr
, mode_t mode
)
571 struct dentry
*dir
= kobj
->dentry
;
572 struct dentry
*victim
;
573 struct inode
* inode
;
574 struct iattr newattrs
;
577 mutex_lock(&dir
->d_inode
->i_mutex
);
578 victim
= lookup_one_len(attr
->name
, dir
, strlen(attr
->name
));
579 if (!IS_ERR(victim
)) {
580 if (victim
->d_inode
&&
581 (victim
->d_parent
->d_inode
== dir
->d_inode
)) {
582 inode
= victim
->d_inode
;
583 mutex_lock(&inode
->i_mutex
);
584 newattrs
.ia_mode
= (mode
& S_IALLUGO
) |
585 (inode
->i_mode
& ~S_IALLUGO
);
586 newattrs
.ia_valid
= ATTR_MODE
| ATTR_CTIME
;
587 res
= notify_change(victim
, &newattrs
);
588 mutex_unlock(&inode
->i_mutex
);
592 mutex_unlock(&dir
->d_inode
->i_mutex
);
596 EXPORT_SYMBOL_GPL(sysfs_chmod_file
);
600 * sysfs_remove_file - remove an object attribute.
601 * @kobj: object we're acting for.
602 * @attr: attribute descriptor.
604 * Hash the attribute name and kill the victim.
607 void sysfs_remove_file(struct kobject
* kobj
, const struct attribute
* attr
)
609 sysfs_hash_and_remove(kobj
->dentry
, attr
->name
);
614 * sysfs_remove_file_from_group - remove an attribute file from a group.
615 * @kobj: object we're acting for.
616 * @attr: attribute descriptor.
617 * @group: group name.
619 void sysfs_remove_file_from_group(struct kobject
*kobj
,
620 const struct attribute
*attr
, const char *group
)
624 dir
= lookup_one_len(group
, kobj
->dentry
, strlen(group
));
626 sysfs_hash_and_remove(dir
, attr
->name
);
630 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group
);
632 struct sysfs_schedule_callback_struct
{
633 struct kobject
*kobj
;
634 void (*func
)(void *);
636 struct work_struct work
;
639 static void sysfs_schedule_callback_work(struct work_struct
*work
)
641 struct sysfs_schedule_callback_struct
*ss
= container_of(work
,
642 struct sysfs_schedule_callback_struct
, work
);
644 (ss
->func
)(ss
->data
);
645 kobject_put(ss
->kobj
);
650 * sysfs_schedule_callback - helper to schedule a callback for a kobject
651 * @kobj: object we're acting for.
652 * @func: callback function to invoke later.
653 * @data: argument to pass to @func.
655 * sysfs attribute methods must not unregister themselves or their parent
656 * kobject (which would amount to the same thing). Attempts to do so will
657 * deadlock, since unregistration is mutually exclusive with driver
660 * Instead methods can call this routine, which will attempt to allocate
661 * and schedule a workqueue request to call back @func with @data as its
662 * argument in the workqueue's process context. @kobj will be pinned
663 * until @func returns.
665 * Returns 0 if the request was submitted, -ENOMEM if storage could not
668 int sysfs_schedule_callback(struct kobject
*kobj
, void (*func
)(void *),
671 struct sysfs_schedule_callback_struct
*ss
;
673 ss
= kmalloc(sizeof(*ss
), GFP_KERNEL
);
680 INIT_WORK(&ss
->work
, sysfs_schedule_callback_work
);
681 schedule_work(&ss
->work
);
684 EXPORT_SYMBOL_GPL(sysfs_schedule_callback
);
687 EXPORT_SYMBOL_GPL(sysfs_create_file
);
688 EXPORT_SYMBOL_GPL(sysfs_remove_file
);
689 EXPORT_SYMBOL_GPL(sysfs_update_file
);