1 // SPDX-License-Identifier: GPL-2.0
3 * fs/sysfs/file.c - sysfs regular (text) file implementation
5 * Copyright (c) 2001-3 Patrick Mochel
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
9 * Please see Documentation/filesystems/sysfs.rst for more information.
12 #include <linux/module.h>
13 #include <linux/kobject.h>
14 #include <linux/slab.h>
15 #include <linux/list.h>
16 #include <linux/mutex.h>
17 #include <linux/seq_file.h>
23 * Determine ktype->sysfs_ops for the given kernfs_node. This function
24 * must be called while holding an active reference.
26 static const struct sysfs_ops
*sysfs_file_ops(struct kernfs_node
*kn
)
28 struct kobject
*kobj
= kn
->parent
->priv
;
30 if (kn
->flags
& KERNFS_LOCKDEP
)
31 lockdep_assert_held(kn
);
32 return kobj
->ktype
? kobj
->ktype
->sysfs_ops
: NULL
;
36 * Reads on sysfs are handled through seq_file, which takes care of hairy
37 * details like buffering and seeking. The following function pipes
38 * sysfs_ops->show() result through seq_file.
40 static int sysfs_kf_seq_show(struct seq_file
*sf
, void *v
)
42 struct kernfs_open_file
*of
= sf
->private;
43 struct kobject
*kobj
= of
->kn
->parent
->priv
;
44 const struct sysfs_ops
*ops
= sysfs_file_ops(of
->kn
);
48 if (WARN_ON_ONCE(!ops
->show
))
51 /* acquire buffer and ensure that it's >= PAGE_SIZE and clear */
52 count
= seq_get_buf(sf
, &buf
);
53 if (count
< PAGE_SIZE
) {
57 memset(buf
, 0, PAGE_SIZE
);
59 count
= ops
->show(kobj
, of
->kn
->priv
, buf
);
64 * The code works fine with PAGE_SIZE return but it's likely to
65 * indicate truncated result or overflow in normal use cases.
67 if (count
>= (ssize_t
)PAGE_SIZE
) {
68 printk("fill_read_buffer: %pS returned bad count\n",
70 /* Try to struggle along */
71 count
= PAGE_SIZE
- 1;
73 seq_commit(sf
, count
);
77 static ssize_t
sysfs_kf_bin_read(struct kernfs_open_file
*of
, char *buf
,
78 size_t count
, loff_t pos
)
80 struct bin_attribute
*battr
= of
->kn
->priv
;
81 struct kobject
*kobj
= of
->kn
->parent
->priv
;
82 loff_t size
= file_inode(of
->file
)->i_size
;
90 if (pos
+ count
> size
)
94 if (!battr
->read
&& !battr
->read_new
)
98 return battr
->read_new(of
->file
, kobj
, battr
, buf
, pos
, count
);
100 return battr
->read(of
->file
, kobj
, battr
, buf
, pos
, count
);
103 /* kernfs read callback for regular sysfs files with pre-alloc */
104 static ssize_t
sysfs_kf_read(struct kernfs_open_file
*of
, char *buf
,
105 size_t count
, loff_t pos
)
107 const struct sysfs_ops
*ops
= sysfs_file_ops(of
->kn
);
108 struct kobject
*kobj
= of
->kn
->parent
->priv
;
112 * If buf != of->prealloc_buf, we don't know how
113 * large it is, so cannot safely pass it to ->show
115 if (WARN_ON_ONCE(buf
!= of
->prealloc_buf
))
117 len
= ops
->show(kobj
, of
->kn
->priv
, buf
);
124 memmove(buf
, buf
+ pos
, len
);
126 return min_t(ssize_t
, count
, len
);
129 /* kernfs write callback for regular sysfs files */
130 static ssize_t
sysfs_kf_write(struct kernfs_open_file
*of
, char *buf
,
131 size_t count
, loff_t pos
)
133 const struct sysfs_ops
*ops
= sysfs_file_ops(of
->kn
);
134 struct kobject
*kobj
= of
->kn
->parent
->priv
;
139 return ops
->store(kobj
, of
->kn
->priv
, buf
, count
);
142 /* kernfs write callback for bin sysfs files */
143 static ssize_t
sysfs_kf_bin_write(struct kernfs_open_file
*of
, char *buf
,
144 size_t count
, loff_t pos
)
146 struct bin_attribute
*battr
= of
->kn
->priv
;
147 struct kobject
*kobj
= of
->kn
->parent
->priv
;
148 loff_t size
= file_inode(of
->file
)->i_size
;
153 count
= min_t(ssize_t
, count
, size
- pos
);
158 if (!battr
->write
&& !battr
->write_new
)
161 if (battr
->write_new
)
162 return battr
->write_new(of
->file
, kobj
, battr
, buf
, pos
, count
);
164 return battr
->write(of
->file
, kobj
, battr
, buf
, pos
, count
);
167 static int sysfs_kf_bin_mmap(struct kernfs_open_file
*of
,
168 struct vm_area_struct
*vma
)
170 struct bin_attribute
*battr
= of
->kn
->priv
;
171 struct kobject
*kobj
= of
->kn
->parent
->priv
;
173 return battr
->mmap(of
->file
, kobj
, battr
, vma
);
176 static loff_t
sysfs_kf_bin_llseek(struct kernfs_open_file
*of
, loff_t offset
,
179 struct bin_attribute
*battr
= of
->kn
->priv
;
180 struct kobject
*kobj
= of
->kn
->parent
->priv
;
183 return battr
->llseek(of
->file
, kobj
, battr
, offset
, whence
);
185 return generic_file_llseek(of
->file
, offset
, whence
);
188 static int sysfs_kf_bin_open(struct kernfs_open_file
*of
)
190 struct bin_attribute
*battr
= of
->kn
->priv
;
192 if (battr
->f_mapping
)
193 of
->file
->f_mapping
= battr
->f_mapping();
198 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
)
200 struct kernfs_node
*kn
= kobj
->sd
, *tmp
;
203 kn
= kernfs_find_and_get(kn
, dir
);
208 tmp
= kernfs_find_and_get(kn
, attr
);
218 EXPORT_SYMBOL_GPL(sysfs_notify
);
220 static const struct kernfs_ops sysfs_file_kfops_empty
= {
223 static const struct kernfs_ops sysfs_file_kfops_ro
= {
224 .seq_show
= sysfs_kf_seq_show
,
227 static const struct kernfs_ops sysfs_file_kfops_wo
= {
228 .write
= sysfs_kf_write
,
231 static const struct kernfs_ops sysfs_file_kfops_rw
= {
232 .seq_show
= sysfs_kf_seq_show
,
233 .write
= sysfs_kf_write
,
236 static const struct kernfs_ops sysfs_prealloc_kfops_ro
= {
237 .read
= sysfs_kf_read
,
241 static const struct kernfs_ops sysfs_prealloc_kfops_wo
= {
242 .write
= sysfs_kf_write
,
246 static const struct kernfs_ops sysfs_prealloc_kfops_rw
= {
247 .read
= sysfs_kf_read
,
248 .write
= sysfs_kf_write
,
252 static const struct kernfs_ops sysfs_bin_kfops_ro
= {
253 .read
= sysfs_kf_bin_read
,
256 static const struct kernfs_ops sysfs_bin_kfops_wo
= {
257 .write
= sysfs_kf_bin_write
,
260 static const struct kernfs_ops sysfs_bin_kfops_rw
= {
261 .read
= sysfs_kf_bin_read
,
262 .write
= sysfs_kf_bin_write
,
265 static const struct kernfs_ops sysfs_bin_kfops_mmap
= {
266 .read
= sysfs_kf_bin_read
,
267 .write
= sysfs_kf_bin_write
,
268 .mmap
= sysfs_kf_bin_mmap
,
269 .open
= sysfs_kf_bin_open
,
270 .llseek
= sysfs_kf_bin_llseek
,
273 int sysfs_add_file_mode_ns(struct kernfs_node
*parent
,
274 const struct attribute
*attr
, umode_t mode
, kuid_t uid
,
275 kgid_t gid
, const void *ns
)
277 struct kobject
*kobj
= parent
->priv
;
278 const struct sysfs_ops
*sysfs_ops
= kobj
->ktype
->sysfs_ops
;
279 struct lock_class_key
*key
= NULL
;
280 const struct kernfs_ops
*ops
= NULL
;
281 struct kernfs_node
*kn
;
283 /* every kobject with an attribute needs a ktype assigned */
284 if (WARN(!sysfs_ops
, KERN_ERR
285 "missing sysfs attribute operations for kobject: %s\n",
289 if (mode
& SYSFS_PREALLOC
) {
290 if (sysfs_ops
->show
&& sysfs_ops
->store
)
291 ops
= &sysfs_prealloc_kfops_rw
;
292 else if (sysfs_ops
->show
)
293 ops
= &sysfs_prealloc_kfops_ro
;
294 else if (sysfs_ops
->store
)
295 ops
= &sysfs_prealloc_kfops_wo
;
297 if (sysfs_ops
->show
&& sysfs_ops
->store
)
298 ops
= &sysfs_file_kfops_rw
;
299 else if (sysfs_ops
->show
)
300 ops
= &sysfs_file_kfops_ro
;
301 else if (sysfs_ops
->store
)
302 ops
= &sysfs_file_kfops_wo
;
306 ops
= &sysfs_file_kfops_empty
;
308 #ifdef CONFIG_DEBUG_LOCK_ALLOC
309 if (!attr
->ignore_lockdep
)
310 key
= attr
->key
?: (struct lock_class_key
*)&attr
->skey
;
313 kn
= __kernfs_create_file(parent
, attr
->name
, mode
& 0777, uid
, gid
,
314 PAGE_SIZE
, ops
, (void *)attr
, ns
, key
);
316 if (PTR_ERR(kn
) == -EEXIST
)
317 sysfs_warn_dup(parent
, attr
->name
);
323 int sysfs_add_bin_file_mode_ns(struct kernfs_node
*parent
,
324 const struct bin_attribute
*battr
, umode_t mode
, size_t size
,
325 kuid_t uid
, kgid_t gid
, const void *ns
)
327 const struct attribute
*attr
= &battr
->attr
;
328 struct lock_class_key
*key
= NULL
;
329 const struct kernfs_ops
*ops
;
330 struct kernfs_node
*kn
;
332 if (battr
->read
&& battr
->read_new
)
335 if (battr
->write
&& battr
->write_new
)
339 ops
= &sysfs_bin_kfops_mmap
;
340 else if ((battr
->read
|| battr
->read_new
) && (battr
->write
|| battr
->write_new
))
341 ops
= &sysfs_bin_kfops_rw
;
342 else if (battr
->read
|| battr
->read_new
)
343 ops
= &sysfs_bin_kfops_ro
;
344 else if (battr
->write
|| battr
->write_new
)
345 ops
= &sysfs_bin_kfops_wo
;
347 ops
= &sysfs_file_kfops_empty
;
349 #ifdef CONFIG_DEBUG_LOCK_ALLOC
350 if (!attr
->ignore_lockdep
)
351 key
= attr
->key
?: (struct lock_class_key
*)&attr
->skey
;
354 kn
= __kernfs_create_file(parent
, attr
->name
, mode
& 0777, uid
, gid
,
355 size
, ops
, (void *)attr
, ns
, key
);
357 if (PTR_ERR(kn
) == -EEXIST
)
358 sysfs_warn_dup(parent
, attr
->name
);
365 * sysfs_create_file_ns - create an attribute file for an object with custom ns
366 * @kobj: object we're creating for
367 * @attr: attribute descriptor
368 * @ns: namespace the new file should belong to
370 int sysfs_create_file_ns(struct kobject
*kobj
, const struct attribute
*attr
,
376 if (WARN_ON(!kobj
|| !kobj
->sd
|| !attr
))
379 kobject_get_ownership(kobj
, &uid
, &gid
);
380 return sysfs_add_file_mode_ns(kobj
->sd
, attr
, attr
->mode
, uid
, gid
, ns
);
382 EXPORT_SYMBOL_GPL(sysfs_create_file_ns
);
384 int sysfs_create_files(struct kobject
*kobj
, const struct attribute
* const *ptr
)
389 for (i
= 0; ptr
[i
] && !err
; i
++)
390 err
= sysfs_create_file(kobj
, ptr
[i
]);
393 sysfs_remove_file(kobj
, ptr
[i
]);
396 EXPORT_SYMBOL_GPL(sysfs_create_files
);
399 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
400 * @kobj: object we're acting for.
401 * @attr: attribute descriptor.
402 * @group: group name.
404 int sysfs_add_file_to_group(struct kobject
*kobj
,
405 const struct attribute
*attr
, const char *group
)
407 struct kernfs_node
*parent
;
413 parent
= kernfs_find_and_get(kobj
->sd
, group
);
422 kobject_get_ownership(kobj
, &uid
, &gid
);
423 error
= sysfs_add_file_mode_ns(parent
, attr
, attr
->mode
, uid
, gid
,
429 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group
);
432 * sysfs_chmod_file - update the modified mode value on an object attribute.
433 * @kobj: object we're acting for.
434 * @attr: attribute descriptor.
435 * @mode: file permissions.
438 int sysfs_chmod_file(struct kobject
*kobj
, const struct attribute
*attr
,
441 struct kernfs_node
*kn
;
442 struct iattr newattrs
;
445 kn
= kernfs_find_and_get(kobj
->sd
, attr
->name
);
449 newattrs
.ia_mode
= (mode
& S_IALLUGO
) | (kn
->mode
& ~S_IALLUGO
);
450 newattrs
.ia_valid
= ATTR_MODE
;
452 rc
= kernfs_setattr(kn
, &newattrs
);
457 EXPORT_SYMBOL_GPL(sysfs_chmod_file
);
460 * sysfs_break_active_protection - break "active" protection
461 * @kobj: The kernel object @attr is associated with.
462 * @attr: The attribute to break the "active" protection for.
464 * With sysfs, just like kernfs, deletion of an attribute is postponed until
465 * all active .show() and .store() callbacks have finished unless this function
466 * is called. Hence this function is useful in methods that implement self
469 struct kernfs_node
*sysfs_break_active_protection(struct kobject
*kobj
,
470 const struct attribute
*attr
)
472 struct kernfs_node
*kn
;
475 kn
= kernfs_find_and_get(kobj
->sd
, attr
->name
);
477 kernfs_break_active_protection(kn
);
482 EXPORT_SYMBOL_GPL(sysfs_break_active_protection
);
485 * sysfs_unbreak_active_protection - restore "active" protection
486 * @kn: Pointer returned by sysfs_break_active_protection().
488 * Undo the effects of sysfs_break_active_protection(). Since this function
489 * calls kernfs_put() on the kernfs node that corresponds to the 'attr'
490 * argument passed to sysfs_break_active_protection() that attribute may have
491 * been removed between the sysfs_break_active_protection() and
492 * sysfs_unbreak_active_protection() calls, it is not safe to access @kn after
493 * this function has returned.
495 void sysfs_unbreak_active_protection(struct kernfs_node
*kn
)
497 struct kobject
*kobj
= kn
->parent
->priv
;
499 kernfs_unbreak_active_protection(kn
);
503 EXPORT_SYMBOL_GPL(sysfs_unbreak_active_protection
);
506 * sysfs_remove_file_ns - remove an object attribute with a custom ns tag
507 * @kobj: object we're acting for
508 * @attr: attribute descriptor
509 * @ns: namespace tag of the file to remove
511 * Hash the attribute name and namespace tag and kill the victim.
513 void sysfs_remove_file_ns(struct kobject
*kobj
, const struct attribute
*attr
,
516 struct kernfs_node
*parent
= kobj
->sd
;
518 kernfs_remove_by_name_ns(parent
, attr
->name
, ns
);
520 EXPORT_SYMBOL_GPL(sysfs_remove_file_ns
);
523 * sysfs_remove_file_self - remove an object attribute from its own method
524 * @kobj: object we're acting for
525 * @attr: attribute descriptor
527 * See kernfs_remove_self() for details.
529 bool sysfs_remove_file_self(struct kobject
*kobj
, const struct attribute
*attr
)
531 struct kernfs_node
*parent
= kobj
->sd
;
532 struct kernfs_node
*kn
;
535 kn
= kernfs_find_and_get(parent
, attr
->name
);
536 if (WARN_ON_ONCE(!kn
))
539 ret
= kernfs_remove_self(kn
);
544 EXPORT_SYMBOL_GPL(sysfs_remove_file_self
);
546 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
* const *ptr
)
550 for (i
= 0; ptr
[i
]; i
++)
551 sysfs_remove_file(kobj
, ptr
[i
]);
553 EXPORT_SYMBOL_GPL(sysfs_remove_files
);
556 * sysfs_remove_file_from_group - remove an attribute file from a group.
557 * @kobj: object we're acting for.
558 * @attr: attribute descriptor.
559 * @group: group name.
561 void sysfs_remove_file_from_group(struct kobject
*kobj
,
562 const struct attribute
*attr
, const char *group
)
564 struct kernfs_node
*parent
;
567 parent
= kernfs_find_and_get(kobj
->sd
, group
);
574 kernfs_remove_by_name(parent
, attr
->name
);
578 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group
);
581 * sysfs_create_bin_file - create binary file for object.
583 * @attr: attribute descriptor.
585 int sysfs_create_bin_file(struct kobject
*kobj
,
586 const struct bin_attribute
*attr
)
591 if (WARN_ON(!kobj
|| !kobj
->sd
|| !attr
))
594 kobject_get_ownership(kobj
, &uid
, &gid
);
595 return sysfs_add_bin_file_mode_ns(kobj
->sd
, attr
, attr
->attr
.mode
,
596 attr
->size
, uid
, gid
, NULL
);
598 EXPORT_SYMBOL_GPL(sysfs_create_bin_file
);
601 * sysfs_remove_bin_file - remove binary file for object.
603 * @attr: attribute descriptor.
605 void sysfs_remove_bin_file(struct kobject
*kobj
,
606 const struct bin_attribute
*attr
)
608 kernfs_remove_by_name(kobj
->sd
, attr
->attr
.name
);
610 EXPORT_SYMBOL_GPL(sysfs_remove_bin_file
);
612 static int internal_change_owner(struct kernfs_node
*kn
, kuid_t kuid
,
615 struct iattr newattrs
= {
616 .ia_valid
= ATTR_UID
| ATTR_GID
,
620 return kernfs_setattr(kn
, &newattrs
);
624 * sysfs_link_change_owner - change owner of a sysfs file.
625 * @kobj: object of the kernfs_node the symlink is located in.
626 * @targ: object of the kernfs_node the symlink points to.
627 * @name: name of the link.
628 * @kuid: new owner's kuid
629 * @kgid: new owner's kgid
631 * This function looks up the sysfs symlink entry @name under @kobj and changes
632 * the ownership to @kuid/@kgid. The symlink is looked up in the namespace of
635 * Returns 0 on success or error code on failure.
637 int sysfs_link_change_owner(struct kobject
*kobj
, struct kobject
*targ
,
638 const char *name
, kuid_t kuid
, kgid_t kgid
)
640 struct kernfs_node
*kn
= NULL
;
643 if (!name
|| !kobj
->state_in_sysfs
|| !targ
->state_in_sysfs
)
647 kn
= kernfs_find_and_get_ns(kobj
->sd
, name
, targ
->sd
->ns
);
652 if (kernfs_type(kn
) != KERNFS_LINK
)
654 if (kn
->symlink
.target_kn
->priv
!= targ
)
657 error
= internal_change_owner(kn
, kuid
, kgid
);
665 * sysfs_file_change_owner - change owner of a sysfs file.
667 * @name: name of the file to change.
668 * @kuid: new owner's kuid
669 * @kgid: new owner's kgid
671 * This function looks up the sysfs entry @name under @kobj and changes the
672 * ownership to @kuid/@kgid.
674 * Returns 0 on success or error code on failure.
676 int sysfs_file_change_owner(struct kobject
*kobj
, const char *name
, kuid_t kuid
,
679 struct kernfs_node
*kn
;
685 if (!kobj
->state_in_sysfs
)
688 kn
= kernfs_find_and_get(kobj
->sd
, name
);
692 error
= internal_change_owner(kn
, kuid
, kgid
);
698 EXPORT_SYMBOL_GPL(sysfs_file_change_owner
);
701 * sysfs_change_owner - change owner of the given object.
703 * @kuid: new owner's kuid
704 * @kgid: new owner's kgid
706 * Change the owner of the default directory, files, groups, and attributes of
707 * @kobj to @kuid/@kgid. Note that sysfs_change_owner mirrors how the sysfs
708 * entries for a kobject are added by driver core. In summary,
709 * sysfs_change_owner() takes care of the default directory entry for @kobj,
710 * the default attributes associated with the ktype of @kobj and the default
711 * attributes associated with the ktype of @kobj.
712 * Additional properties not added by driver core have to be changed by the
713 * driver or subsystem which created them. This is similar to how
714 * driver/subsystem specific entries are removed.
716 * Returns 0 on success or error code on failure.
718 int sysfs_change_owner(struct kobject
*kobj
, kuid_t kuid
, kgid_t kgid
)
721 const struct kobj_type
*ktype
;
723 if (!kobj
->state_in_sysfs
)
726 /* Change the owner of the kobject itself. */
727 error
= internal_change_owner(kobj
->sd
, kuid
, kgid
);
731 ktype
= get_ktype(kobj
);
734 * Change owner of the default groups associated with the
737 error
= sysfs_groups_change_owner(kobj
, ktype
->default_groups
,
745 EXPORT_SYMBOL_GPL(sysfs_change_owner
);
748 * sysfs_emit - scnprintf equivalent, aware of PAGE_SIZE buffer.
749 * @buf: start of PAGE_SIZE buffer.
751 * @...: optional arguments to @format
754 * Returns number of characters written to @buf.
756 int sysfs_emit(char *buf
, const char *fmt
, ...)
761 if (WARN(!buf
|| offset_in_page(buf
),
762 "invalid sysfs_emit: buf:%p\n", buf
))
766 len
= vscnprintf(buf
, PAGE_SIZE
, fmt
, args
);
771 EXPORT_SYMBOL_GPL(sysfs_emit
);
774 * sysfs_emit_at - scnprintf equivalent, aware of PAGE_SIZE buffer.
775 * @buf: start of PAGE_SIZE buffer.
776 * @at: offset in @buf to start write in bytes
777 * @at must be >= 0 && < PAGE_SIZE
779 * @...: optional arguments to @fmt
782 * Returns number of characters written starting at &@buf[@at].
784 int sysfs_emit_at(char *buf
, int at
, const char *fmt
, ...)
789 if (WARN(!buf
|| offset_in_page(buf
) || at
< 0 || at
>= PAGE_SIZE
,
790 "invalid sysfs_emit_at: buf:%p at:%d\n", buf
, at
))
794 len
= vscnprintf(buf
+ at
, PAGE_SIZE
- at
, fmt
, args
);
799 EXPORT_SYMBOL_GPL(sysfs_emit_at
);
802 * sysfs_bin_attr_simple_read - read callback to simply copy from memory.
803 * @file: attribute file which is being read.
804 * @kobj: object to which the attribute belongs.
805 * @attr: attribute descriptor.
806 * @buf: destination buffer.
807 * @off: offset in bytes from which to read.
808 * @count: maximum number of bytes to read.
810 * Simple ->read() callback for bin_attributes backed by a buffer in memory.
811 * The @private and @size members in struct bin_attribute must be set to the
812 * buffer's location and size before the bin_attribute is created in sysfs.
814 * Bounds check for @off and @count is done in sysfs_kf_bin_read().
815 * Negative value check for @off is done in vfs_setpos() and default_llseek().
817 * Returns number of bytes written to @buf.
819 ssize_t
sysfs_bin_attr_simple_read(struct file
*file
, struct kobject
*kobj
,
820 struct bin_attribute
*attr
, char *buf
,
821 loff_t off
, size_t count
)
823 memcpy(buf
, attr
->private + off
, count
);
826 EXPORT_SYMBOL_GPL(sysfs_bin_attr_simple_read
);