Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * fs/sysfs/file.c - sysfs regular (text) file implementation
4 *
5 * Copyright (c) 2001-3 Patrick Mochel
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8 *
9 * Please see Documentation/filesystems/sysfs.rst for more information.
10 */
11
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>
18#include <linux/mm.h>
19
20#include "sysfs.h"
21
22/*
23 * Determine ktype->sysfs_ops for the given kernfs_node. This function
24 * must be called while holding an active reference.
25 */
26static const struct sysfs_ops *sysfs_file_ops(struct kernfs_node *kn)
27{
28 struct kobject *kobj = kn->parent->priv;
29
30 if (kn->flags & KERNFS_LOCKDEP)
31 lockdep_assert_held(kn);
32 return kobj->ktype ? kobj->ktype->sysfs_ops : NULL;
33}
34
35/*
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.
39 */
40static int sysfs_kf_seq_show(struct seq_file *sf, void *v)
41{
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);
45 ssize_t count;
46 char *buf;
47
48 if (WARN_ON_ONCE(!ops->show))
49 return -EINVAL;
50
51 /* acquire buffer and ensure that it's >= PAGE_SIZE and clear */
52 count = seq_get_buf(sf, &buf);
53 if (count < PAGE_SIZE) {
54 seq_commit(sf, -1);
55 return 0;
56 }
57 memset(buf, 0, PAGE_SIZE);
58
59 count = ops->show(kobj, of->kn->priv, buf);
60 if (count < 0)
61 return count;
62
63 /*
64 * The code works fine with PAGE_SIZE return but it's likely to
65 * indicate truncated result or overflow in normal use cases.
66 */
67 if (count >= (ssize_t)PAGE_SIZE) {
68 printk("fill_read_buffer: %pS returned bad count\n",
69 ops->show);
70 /* Try to struggle along */
71 count = PAGE_SIZE - 1;
72 }
73 seq_commit(sf, count);
74 return 0;
75}
76
77static ssize_t sysfs_kf_bin_read(struct kernfs_open_file *of, char *buf,
78 size_t count, loff_t pos)
79{
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;
83
84 if (!count)
85 return 0;
86
87 if (size) {
88 if (pos >= size)
89 return 0;
90 if (pos + count > size)
91 count = size - pos;
92 }
93
94 if (!battr->read)
95 return -EIO;
96
97 return battr->read(of->file, kobj, battr, buf, pos, count);
98}
99
100/* kernfs read callback for regular sysfs files with pre-alloc */
101static ssize_t sysfs_kf_read(struct kernfs_open_file *of, char *buf,
102 size_t count, loff_t pos)
103{
104 const struct sysfs_ops *ops = sysfs_file_ops(of->kn);
105 struct kobject *kobj = of->kn->parent->priv;
106 ssize_t len;
107
108 /*
109 * If buf != of->prealloc_buf, we don't know how
110 * large it is, so cannot safely pass it to ->show
111 */
112 if (WARN_ON_ONCE(buf != of->prealloc_buf))
113 return 0;
114 len = ops->show(kobj, of->kn->priv, buf);
115 if (len < 0)
116 return len;
117 if (pos) {
118 if (len <= pos)
119 return 0;
120 len -= pos;
121 memmove(buf, buf + pos, len);
122 }
123 return min_t(ssize_t, count, len);
124}
125
126/* kernfs write callback for regular sysfs files */
127static ssize_t sysfs_kf_write(struct kernfs_open_file *of, char *buf,
128 size_t count, loff_t pos)
129{
130 const struct sysfs_ops *ops = sysfs_file_ops(of->kn);
131 struct kobject *kobj = of->kn->parent->priv;
132
133 if (!count)
134 return 0;
135
136 return ops->store(kobj, of->kn->priv, buf, count);
137}
138
139/* kernfs write callback for bin sysfs files */
140static ssize_t sysfs_kf_bin_write(struct kernfs_open_file *of, char *buf,
141 size_t count, loff_t pos)
142{
143 struct bin_attribute *battr = of->kn->priv;
144 struct kobject *kobj = of->kn->parent->priv;
145 loff_t size = file_inode(of->file)->i_size;
146
147 if (size) {
148 if (size <= pos)
149 return -EFBIG;
150 count = min_t(ssize_t, count, size - pos);
151 }
152 if (!count)
153 return 0;
154
155 if (!battr->write)
156 return -EIO;
157
158 return battr->write(of->file, kobj, battr, buf, pos, count);
159}
160
161static int sysfs_kf_bin_mmap(struct kernfs_open_file *of,
162 struct vm_area_struct *vma)
163{
164 struct bin_attribute *battr = of->kn->priv;
165 struct kobject *kobj = of->kn->parent->priv;
166
167 return battr->mmap(of->file, kobj, battr, vma);
168}
169
170static int sysfs_kf_bin_open(struct kernfs_open_file *of)
171{
172 struct bin_attribute *battr = of->kn->priv;
173
174 if (battr->f_mapping)
175 of->file->f_mapping = battr->f_mapping();
176
177 return 0;
178}
179
180void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr)
181{
182 struct kernfs_node *kn = kobj->sd, *tmp;
183
184 if (kn && dir)
185 kn = kernfs_find_and_get(kn, dir);
186 else
187 kernfs_get(kn);
188
189 if (kn && attr) {
190 tmp = kernfs_find_and_get(kn, attr);
191 kernfs_put(kn);
192 kn = tmp;
193 }
194
195 if (kn) {
196 kernfs_notify(kn);
197 kernfs_put(kn);
198 }
199}
200EXPORT_SYMBOL_GPL(sysfs_notify);
201
202static const struct kernfs_ops sysfs_file_kfops_empty = {
203};
204
205static const struct kernfs_ops sysfs_file_kfops_ro = {
206 .seq_show = sysfs_kf_seq_show,
207};
208
209static const struct kernfs_ops sysfs_file_kfops_wo = {
210 .write = sysfs_kf_write,
211};
212
213static const struct kernfs_ops sysfs_file_kfops_rw = {
214 .seq_show = sysfs_kf_seq_show,
215 .write = sysfs_kf_write,
216};
217
218static const struct kernfs_ops sysfs_prealloc_kfops_ro = {
219 .read = sysfs_kf_read,
220 .prealloc = true,
221};
222
223static const struct kernfs_ops sysfs_prealloc_kfops_wo = {
224 .write = sysfs_kf_write,
225 .prealloc = true,
226};
227
228static const struct kernfs_ops sysfs_prealloc_kfops_rw = {
229 .read = sysfs_kf_read,
230 .write = sysfs_kf_write,
231 .prealloc = true,
232};
233
234static const struct kernfs_ops sysfs_bin_kfops_ro = {
235 .read = sysfs_kf_bin_read,
236};
237
238static const struct kernfs_ops sysfs_bin_kfops_wo = {
239 .write = sysfs_kf_bin_write,
240};
241
242static const struct kernfs_ops sysfs_bin_kfops_rw = {
243 .read = sysfs_kf_bin_read,
244 .write = sysfs_kf_bin_write,
245};
246
247static const struct kernfs_ops sysfs_bin_kfops_mmap = {
248 .read = sysfs_kf_bin_read,
249 .write = sysfs_kf_bin_write,
250 .mmap = sysfs_kf_bin_mmap,
251 .open = sysfs_kf_bin_open,
252};
253
254int sysfs_add_file_mode_ns(struct kernfs_node *parent,
255 const struct attribute *attr, umode_t mode, kuid_t uid,
256 kgid_t gid, const void *ns)
257{
258 struct kobject *kobj = parent->priv;
259 const struct sysfs_ops *sysfs_ops = kobj->ktype->sysfs_ops;
260 struct lock_class_key *key = NULL;
261 const struct kernfs_ops *ops = NULL;
262 struct kernfs_node *kn;
263
264 /* every kobject with an attribute needs a ktype assigned */
265 if (WARN(!sysfs_ops, KERN_ERR
266 "missing sysfs attribute operations for kobject: %s\n",
267 kobject_name(kobj)))
268 return -EINVAL;
269
270 if (mode & SYSFS_PREALLOC) {
271 if (sysfs_ops->show && sysfs_ops->store)
272 ops = &sysfs_prealloc_kfops_rw;
273 else if (sysfs_ops->show)
274 ops = &sysfs_prealloc_kfops_ro;
275 else if (sysfs_ops->store)
276 ops = &sysfs_prealloc_kfops_wo;
277 } else {
278 if (sysfs_ops->show && sysfs_ops->store)
279 ops = &sysfs_file_kfops_rw;
280 else if (sysfs_ops->show)
281 ops = &sysfs_file_kfops_ro;
282 else if (sysfs_ops->store)
283 ops = &sysfs_file_kfops_wo;
284 }
285
286 if (!ops)
287 ops = &sysfs_file_kfops_empty;
288
289#ifdef CONFIG_DEBUG_LOCK_ALLOC
290 if (!attr->ignore_lockdep)
291 key = attr->key ?: (struct lock_class_key *)&attr->skey;
292#endif
293
294 kn = __kernfs_create_file(parent, attr->name, mode & 0777, uid, gid,
295 PAGE_SIZE, ops, (void *)attr, ns, key);
296 if (IS_ERR(kn)) {
297 if (PTR_ERR(kn) == -EEXIST)
298 sysfs_warn_dup(parent, attr->name);
299 return PTR_ERR(kn);
300 }
301 return 0;
302}
303
304int sysfs_add_bin_file_mode_ns(struct kernfs_node *parent,
305 const struct bin_attribute *battr, umode_t mode,
306 kuid_t uid, kgid_t gid, const void *ns)
307{
308 const struct attribute *attr = &battr->attr;
309 struct lock_class_key *key = NULL;
310 const struct kernfs_ops *ops;
311 struct kernfs_node *kn;
312
313 if (battr->mmap)
314 ops = &sysfs_bin_kfops_mmap;
315 else if (battr->read && battr->write)
316 ops = &sysfs_bin_kfops_rw;
317 else if (battr->read)
318 ops = &sysfs_bin_kfops_ro;
319 else if (battr->write)
320 ops = &sysfs_bin_kfops_wo;
321 else
322 ops = &sysfs_file_kfops_empty;
323
324#ifdef CONFIG_DEBUG_LOCK_ALLOC
325 if (!attr->ignore_lockdep)
326 key = attr->key ?: (struct lock_class_key *)&attr->skey;
327#endif
328
329 kn = __kernfs_create_file(parent, attr->name, mode & 0777, uid, gid,
330 battr->size, ops, (void *)attr, ns, key);
331 if (IS_ERR(kn)) {
332 if (PTR_ERR(kn) == -EEXIST)
333 sysfs_warn_dup(parent, attr->name);
334 return PTR_ERR(kn);
335 }
336 return 0;
337}
338
339/**
340 * sysfs_create_file_ns - create an attribute file for an object with custom ns
341 * @kobj: object we're creating for
342 * @attr: attribute descriptor
343 * @ns: namespace the new file should belong to
344 */
345int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
346 const void *ns)
347{
348 kuid_t uid;
349 kgid_t gid;
350
351 if (WARN_ON(!kobj || !kobj->sd || !attr))
352 return -EINVAL;
353
354 kobject_get_ownership(kobj, &uid, &gid);
355 return sysfs_add_file_mode_ns(kobj->sd, attr, attr->mode, uid, gid, ns);
356}
357EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
358
359int sysfs_create_files(struct kobject *kobj, const struct attribute * const *ptr)
360{
361 int err = 0;
362 int i;
363
364 for (i = 0; ptr[i] && !err; i++)
365 err = sysfs_create_file(kobj, ptr[i]);
366 if (err)
367 while (--i >= 0)
368 sysfs_remove_file(kobj, ptr[i]);
369 return err;
370}
371EXPORT_SYMBOL_GPL(sysfs_create_files);
372
373/**
374 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
375 * @kobj: object we're acting for.
376 * @attr: attribute descriptor.
377 * @group: group name.
378 */
379int sysfs_add_file_to_group(struct kobject *kobj,
380 const struct attribute *attr, const char *group)
381{
382 struct kernfs_node *parent;
383 kuid_t uid;
384 kgid_t gid;
385 int error;
386
387 if (group) {
388 parent = kernfs_find_and_get(kobj->sd, group);
389 } else {
390 parent = kobj->sd;
391 kernfs_get(parent);
392 }
393
394 if (!parent)
395 return -ENOENT;
396
397 kobject_get_ownership(kobj, &uid, &gid);
398 error = sysfs_add_file_mode_ns(parent, attr, attr->mode, uid, gid,
399 NULL);
400 kernfs_put(parent);
401
402 return error;
403}
404EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
405
406/**
407 * sysfs_chmod_file - update the modified mode value on an object attribute.
408 * @kobj: object we're acting for.
409 * @attr: attribute descriptor.
410 * @mode: file permissions.
411 *
412 */
413int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
414 umode_t mode)
415{
416 struct kernfs_node *kn;
417 struct iattr newattrs;
418 int rc;
419
420 kn = kernfs_find_and_get(kobj->sd, attr->name);
421 if (!kn)
422 return -ENOENT;
423
424 newattrs.ia_mode = (mode & S_IALLUGO) | (kn->mode & ~S_IALLUGO);
425 newattrs.ia_valid = ATTR_MODE;
426
427 rc = kernfs_setattr(kn, &newattrs);
428
429 kernfs_put(kn);
430 return rc;
431}
432EXPORT_SYMBOL_GPL(sysfs_chmod_file);
433
434/**
435 * sysfs_break_active_protection - break "active" protection
436 * @kobj: The kernel object @attr is associated with.
437 * @attr: The attribute to break the "active" protection for.
438 *
439 * With sysfs, just like kernfs, deletion of an attribute is postponed until
440 * all active .show() and .store() callbacks have finished unless this function
441 * is called. Hence this function is useful in methods that implement self
442 * deletion.
443 */
444struct kernfs_node *sysfs_break_active_protection(struct kobject *kobj,
445 const struct attribute *attr)
446{
447 struct kernfs_node *kn;
448
449 kobject_get(kobj);
450 kn = kernfs_find_and_get(kobj->sd, attr->name);
451 if (kn)
452 kernfs_break_active_protection(kn);
453 return kn;
454}
455EXPORT_SYMBOL_GPL(sysfs_break_active_protection);
456
457/**
458 * sysfs_unbreak_active_protection - restore "active" protection
459 * @kn: Pointer returned by sysfs_break_active_protection().
460 *
461 * Undo the effects of sysfs_break_active_protection(). Since this function
462 * calls kernfs_put() on the kernfs node that corresponds to the 'attr'
463 * argument passed to sysfs_break_active_protection() that attribute may have
464 * been removed between the sysfs_break_active_protection() and
465 * sysfs_unbreak_active_protection() calls, it is not safe to access @kn after
466 * this function has returned.
467 */
468void sysfs_unbreak_active_protection(struct kernfs_node *kn)
469{
470 struct kobject *kobj = kn->parent->priv;
471
472 kernfs_unbreak_active_protection(kn);
473 kernfs_put(kn);
474 kobject_put(kobj);
475}
476EXPORT_SYMBOL_GPL(sysfs_unbreak_active_protection);
477
478/**
479 * sysfs_remove_file_ns - remove an object attribute with a custom ns tag
480 * @kobj: object we're acting for
481 * @attr: attribute descriptor
482 * @ns: namespace tag of the file to remove
483 *
484 * Hash the attribute name and namespace tag and kill the victim.
485 */
486void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
487 const void *ns)
488{
489 struct kernfs_node *parent = kobj->sd;
490
491 kernfs_remove_by_name_ns(parent, attr->name, ns);
492}
493EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
494
495/**
496 * sysfs_remove_file_self - remove an object attribute from its own method
497 * @kobj: object we're acting for
498 * @attr: attribute descriptor
499 *
500 * See kernfs_remove_self() for details.
501 */
502bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr)
503{
504 struct kernfs_node *parent = kobj->sd;
505 struct kernfs_node *kn;
506 bool ret;
507
508 kn = kernfs_find_and_get(parent, attr->name);
509 if (WARN_ON_ONCE(!kn))
510 return false;
511
512 ret = kernfs_remove_self(kn);
513
514 kernfs_put(kn);
515 return ret;
516}
517EXPORT_SYMBOL_GPL(sysfs_remove_file_self);
518
519void sysfs_remove_files(struct kobject *kobj, const struct attribute * const *ptr)
520{
521 int i;
522
523 for (i = 0; ptr[i]; i++)
524 sysfs_remove_file(kobj, ptr[i]);
525}
526EXPORT_SYMBOL_GPL(sysfs_remove_files);
527
528/**
529 * sysfs_remove_file_from_group - remove an attribute file from a group.
530 * @kobj: object we're acting for.
531 * @attr: attribute descriptor.
532 * @group: group name.
533 */
534void sysfs_remove_file_from_group(struct kobject *kobj,
535 const struct attribute *attr, const char *group)
536{
537 struct kernfs_node *parent;
538
539 if (group) {
540 parent = kernfs_find_and_get(kobj->sd, group);
541 } else {
542 parent = kobj->sd;
543 kernfs_get(parent);
544 }
545
546 if (parent) {
547 kernfs_remove_by_name(parent, attr->name);
548 kernfs_put(parent);
549 }
550}
551EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
552
553/**
554 * sysfs_create_bin_file - create binary file for object.
555 * @kobj: object.
556 * @attr: attribute descriptor.
557 */
558int sysfs_create_bin_file(struct kobject *kobj,
559 const struct bin_attribute *attr)
560{
561 kuid_t uid;
562 kgid_t gid;
563
564 if (WARN_ON(!kobj || !kobj->sd || !attr))
565 return -EINVAL;
566
567 kobject_get_ownership(kobj, &uid, &gid);
568 return sysfs_add_bin_file_mode_ns(kobj->sd, attr, attr->attr.mode, uid,
569 gid, NULL);
570}
571EXPORT_SYMBOL_GPL(sysfs_create_bin_file);
572
573/**
574 * sysfs_remove_bin_file - remove binary file for object.
575 * @kobj: object.
576 * @attr: attribute descriptor.
577 */
578void sysfs_remove_bin_file(struct kobject *kobj,
579 const struct bin_attribute *attr)
580{
581 kernfs_remove_by_name(kobj->sd, attr->attr.name);
582}
583EXPORT_SYMBOL_GPL(sysfs_remove_bin_file);
584
585static int internal_change_owner(struct kernfs_node *kn, kuid_t kuid,
586 kgid_t kgid)
587{
588 struct iattr newattrs = {
589 .ia_valid = ATTR_UID | ATTR_GID,
590 .ia_uid = kuid,
591 .ia_gid = kgid,
592 };
593 return kernfs_setattr(kn, &newattrs);
594}
595
596/**
597 * sysfs_link_change_owner - change owner of a sysfs file.
598 * @kobj: object of the kernfs_node the symlink is located in.
599 * @targ: object of the kernfs_node the symlink points to.
600 * @name: name of the link.
601 * @kuid: new owner's kuid
602 * @kgid: new owner's kgid
603 *
604 * This function looks up the sysfs symlink entry @name under @kobj and changes
605 * the ownership to @kuid/@kgid. The symlink is looked up in the namespace of
606 * @targ.
607 *
608 * Returns 0 on success or error code on failure.
609 */
610int sysfs_link_change_owner(struct kobject *kobj, struct kobject *targ,
611 const char *name, kuid_t kuid, kgid_t kgid)
612{
613 struct kernfs_node *kn = NULL;
614 int error;
615
616 if (!name || !kobj->state_in_sysfs || !targ->state_in_sysfs)
617 return -EINVAL;
618
619 error = -ENOENT;
620 kn = kernfs_find_and_get_ns(kobj->sd, name, targ->sd->ns);
621 if (!kn)
622 goto out;
623
624 error = -EINVAL;
625 if (kernfs_type(kn) != KERNFS_LINK)
626 goto out;
627 if (kn->symlink.target_kn->priv != targ)
628 goto out;
629
630 error = internal_change_owner(kn, kuid, kgid);
631
632out:
633 kernfs_put(kn);
634 return error;
635}
636
637/**
638 * sysfs_file_change_owner - change owner of a sysfs file.
639 * @kobj: object.
640 * @name: name of the file to change.
641 * @kuid: new owner's kuid
642 * @kgid: new owner's kgid
643 *
644 * This function looks up the sysfs entry @name under @kobj and changes the
645 * ownership to @kuid/@kgid.
646 *
647 * Returns 0 on success or error code on failure.
648 */
649int sysfs_file_change_owner(struct kobject *kobj, const char *name, kuid_t kuid,
650 kgid_t kgid)
651{
652 struct kernfs_node *kn;
653 int error;
654
655 if (!name)
656 return -EINVAL;
657
658 if (!kobj->state_in_sysfs)
659 return -EINVAL;
660
661 kn = kernfs_find_and_get(kobj->sd, name);
662 if (!kn)
663 return -ENOENT;
664
665 error = internal_change_owner(kn, kuid, kgid);
666
667 kernfs_put(kn);
668
669 return error;
670}
671EXPORT_SYMBOL_GPL(sysfs_file_change_owner);
672
673/**
674 * sysfs_change_owner - change owner of the given object.
675 * @kobj: object.
676 * @kuid: new owner's kuid
677 * @kgid: new owner's kgid
678 *
679 * Change the owner of the default directory, files, groups, and attributes of
680 * @kobj to @kuid/@kgid. Note that sysfs_change_owner mirrors how the sysfs
681 * entries for a kobject are added by driver core. In summary,
682 * sysfs_change_owner() takes care of the default directory entry for @kobj,
683 * the default attributes associated with the ktype of @kobj and the default
684 * attributes associated with the ktype of @kobj.
685 * Additional properties not added by driver core have to be changed by the
686 * driver or subsystem which created them. This is similar to how
687 * driver/subsystem specific entries are removed.
688 *
689 * Returns 0 on success or error code on failure.
690 */
691int sysfs_change_owner(struct kobject *kobj, kuid_t kuid, kgid_t kgid)
692{
693 int error;
694 const struct kobj_type *ktype;
695
696 if (!kobj->state_in_sysfs)
697 return -EINVAL;
698
699 /* Change the owner of the kobject itself. */
700 error = internal_change_owner(kobj->sd, kuid, kgid);
701 if (error)
702 return error;
703
704 ktype = get_ktype(kobj);
705 if (ktype) {
706 /*
707 * Change owner of the default groups associated with the
708 * ktype of @kobj.
709 */
710 error = sysfs_groups_change_owner(kobj, ktype->default_groups,
711 kuid, kgid);
712 if (error)
713 return error;
714 }
715
716 return 0;
717}
718EXPORT_SYMBOL_GPL(sysfs_change_owner);
719
720/**
721 * sysfs_emit - scnprintf equivalent, aware of PAGE_SIZE buffer.
722 * @buf: start of PAGE_SIZE buffer.
723 * @fmt: format
724 * @...: optional arguments to @format
725 *
726 *
727 * Returns number of characters written to @buf.
728 */
729int sysfs_emit(char *buf, const char *fmt, ...)
730{
731 va_list args;
732 int len;
733
734 if (WARN(!buf || offset_in_page(buf),
735 "invalid sysfs_emit: buf:%p\n", buf))
736 return 0;
737
738 va_start(args, fmt);
739 len = vscnprintf(buf, PAGE_SIZE, fmt, args);
740 va_end(args);
741
742 return len;
743}
744EXPORT_SYMBOL_GPL(sysfs_emit);
745
746/**
747 * sysfs_emit_at - scnprintf equivalent, aware of PAGE_SIZE buffer.
748 * @buf: start of PAGE_SIZE buffer.
749 * @at: offset in @buf to start write in bytes
750 * @at must be >= 0 && < PAGE_SIZE
751 * @fmt: format
752 * @...: optional arguments to @fmt
753 *
754 *
755 * Returns number of characters written starting at &@buf[@at].
756 */
757int sysfs_emit_at(char *buf, int at, const char *fmt, ...)
758{
759 va_list args;
760 int len;
761
762 if (WARN(!buf || offset_in_page(buf) || at < 0 || at >= PAGE_SIZE,
763 "invalid sysfs_emit_at: buf:%p at:%d\n", buf, at))
764 return 0;
765
766 va_start(args, fmt);
767 len = vscnprintf(buf + at, PAGE_SIZE - at, fmt, args);
768 va_end(args);
769
770 return len;
771}
772EXPORT_SYMBOL_GPL(sysfs_emit_at);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * fs/sysfs/file.c - sysfs regular (text) file implementation
4 *
5 * Copyright (c) 2001-3 Patrick Mochel
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8 *
9 * Please see Documentation/filesystems/sysfs.rst for more information.
10 */
11
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>
18#include <linux/mm.h>
19
20#include "sysfs.h"
21
22/*
23 * Determine ktype->sysfs_ops for the given kernfs_node. This function
24 * must be called while holding an active reference.
25 */
26static const struct sysfs_ops *sysfs_file_ops(struct kernfs_node *kn)
27{
28 struct kobject *kobj = kn->parent->priv;
29
30 if (kn->flags & KERNFS_LOCKDEP)
31 lockdep_assert_held(kn);
32 return kobj->ktype ? kobj->ktype->sysfs_ops : NULL;
33}
34
35/*
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.
39 */
40static int sysfs_kf_seq_show(struct seq_file *sf, void *v)
41{
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);
45 ssize_t count;
46 char *buf;
47
48 if (WARN_ON_ONCE(!ops->show))
49 return -EINVAL;
50
51 /* acquire buffer and ensure that it's >= PAGE_SIZE and clear */
52 count = seq_get_buf(sf, &buf);
53 if (count < PAGE_SIZE) {
54 seq_commit(sf, -1);
55 return 0;
56 }
57 memset(buf, 0, PAGE_SIZE);
58
59 count = ops->show(kobj, of->kn->priv, buf);
60 if (count < 0)
61 return count;
62
63 /*
64 * The code works fine with PAGE_SIZE return but it's likely to
65 * indicate truncated result or overflow in normal use cases.
66 */
67 if (count >= (ssize_t)PAGE_SIZE) {
68 printk("fill_read_buffer: %pS returned bad count\n",
69 ops->show);
70 /* Try to struggle along */
71 count = PAGE_SIZE - 1;
72 }
73 seq_commit(sf, count);
74 return 0;
75}
76
77static ssize_t sysfs_kf_bin_read(struct kernfs_open_file *of, char *buf,
78 size_t count, loff_t pos)
79{
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;
83
84 if (!count)
85 return 0;
86
87 if (size) {
88 if (pos >= size)
89 return 0;
90 if (pos + count > size)
91 count = size - pos;
92 }
93
94 if (!battr->read && !battr->read_new)
95 return -EIO;
96
97 if (battr->read_new)
98 return battr->read_new(of->file, kobj, battr, buf, pos, count);
99
100 return battr->read(of->file, kobj, battr, buf, pos, count);
101}
102
103/* kernfs read callback for regular sysfs files with pre-alloc */
104static ssize_t sysfs_kf_read(struct kernfs_open_file *of, char *buf,
105 size_t count, loff_t pos)
106{
107 const struct sysfs_ops *ops = sysfs_file_ops(of->kn);
108 struct kobject *kobj = of->kn->parent->priv;
109 ssize_t len;
110
111 /*
112 * If buf != of->prealloc_buf, we don't know how
113 * large it is, so cannot safely pass it to ->show
114 */
115 if (WARN_ON_ONCE(buf != of->prealloc_buf))
116 return 0;
117 len = ops->show(kobj, of->kn->priv, buf);
118 if (len < 0)
119 return len;
120 if (pos) {
121 if (len <= pos)
122 return 0;
123 len -= pos;
124 memmove(buf, buf + pos, len);
125 }
126 return min_t(ssize_t, count, len);
127}
128
129/* kernfs write callback for regular sysfs files */
130static ssize_t sysfs_kf_write(struct kernfs_open_file *of, char *buf,
131 size_t count, loff_t pos)
132{
133 const struct sysfs_ops *ops = sysfs_file_ops(of->kn);
134 struct kobject *kobj = of->kn->parent->priv;
135
136 if (!count)
137 return 0;
138
139 return ops->store(kobj, of->kn->priv, buf, count);
140}
141
142/* kernfs write callback for bin sysfs files */
143static ssize_t sysfs_kf_bin_write(struct kernfs_open_file *of, char *buf,
144 size_t count, loff_t pos)
145{
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;
149
150 if (size) {
151 if (size <= pos)
152 return -EFBIG;
153 count = min_t(ssize_t, count, size - pos);
154 }
155 if (!count)
156 return 0;
157
158 if (!battr->write && !battr->write_new)
159 return -EIO;
160
161 if (battr->write_new)
162 return battr->write_new(of->file, kobj, battr, buf, pos, count);
163
164 return battr->write(of->file, kobj, battr, buf, pos, count);
165}
166
167static int sysfs_kf_bin_mmap(struct kernfs_open_file *of,
168 struct vm_area_struct *vma)
169{
170 struct bin_attribute *battr = of->kn->priv;
171 struct kobject *kobj = of->kn->parent->priv;
172
173 return battr->mmap(of->file, kobj, battr, vma);
174}
175
176static loff_t sysfs_kf_bin_llseek(struct kernfs_open_file *of, loff_t offset,
177 int whence)
178{
179 struct bin_attribute *battr = of->kn->priv;
180 struct kobject *kobj = of->kn->parent->priv;
181
182 if (battr->llseek)
183 return battr->llseek(of->file, kobj, battr, offset, whence);
184 else
185 return generic_file_llseek(of->file, offset, whence);
186}
187
188static int sysfs_kf_bin_open(struct kernfs_open_file *of)
189{
190 struct bin_attribute *battr = of->kn->priv;
191
192 if (battr->f_mapping)
193 of->file->f_mapping = battr->f_mapping();
194
195 return 0;
196}
197
198void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr)
199{
200 struct kernfs_node *kn = kobj->sd, *tmp;
201
202 if (kn && dir)
203 kn = kernfs_find_and_get(kn, dir);
204 else
205 kernfs_get(kn);
206
207 if (kn && attr) {
208 tmp = kernfs_find_and_get(kn, attr);
209 kernfs_put(kn);
210 kn = tmp;
211 }
212
213 if (kn) {
214 kernfs_notify(kn);
215 kernfs_put(kn);
216 }
217}
218EXPORT_SYMBOL_GPL(sysfs_notify);
219
220static const struct kernfs_ops sysfs_file_kfops_empty = {
221};
222
223static const struct kernfs_ops sysfs_file_kfops_ro = {
224 .seq_show = sysfs_kf_seq_show,
225};
226
227static const struct kernfs_ops sysfs_file_kfops_wo = {
228 .write = sysfs_kf_write,
229};
230
231static const struct kernfs_ops sysfs_file_kfops_rw = {
232 .seq_show = sysfs_kf_seq_show,
233 .write = sysfs_kf_write,
234};
235
236static const struct kernfs_ops sysfs_prealloc_kfops_ro = {
237 .read = sysfs_kf_read,
238 .prealloc = true,
239};
240
241static const struct kernfs_ops sysfs_prealloc_kfops_wo = {
242 .write = sysfs_kf_write,
243 .prealloc = true,
244};
245
246static const struct kernfs_ops sysfs_prealloc_kfops_rw = {
247 .read = sysfs_kf_read,
248 .write = sysfs_kf_write,
249 .prealloc = true,
250};
251
252static const struct kernfs_ops sysfs_bin_kfops_ro = {
253 .read = sysfs_kf_bin_read,
254};
255
256static const struct kernfs_ops sysfs_bin_kfops_wo = {
257 .write = sysfs_kf_bin_write,
258};
259
260static const struct kernfs_ops sysfs_bin_kfops_rw = {
261 .read = sysfs_kf_bin_read,
262 .write = sysfs_kf_bin_write,
263};
264
265static 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,
271};
272
273int 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)
276{
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;
282
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",
286 kobject_name(kobj)))
287 return -EINVAL;
288
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;
296 } else {
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;
303 }
304
305 if (!ops)
306 ops = &sysfs_file_kfops_empty;
307
308#ifdef CONFIG_DEBUG_LOCK_ALLOC
309 if (!attr->ignore_lockdep)
310 key = attr->key ?: (struct lock_class_key *)&attr->skey;
311#endif
312
313 kn = __kernfs_create_file(parent, attr->name, mode & 0777, uid, gid,
314 PAGE_SIZE, ops, (void *)attr, ns, key);
315 if (IS_ERR(kn)) {
316 if (PTR_ERR(kn) == -EEXIST)
317 sysfs_warn_dup(parent, attr->name);
318 return PTR_ERR(kn);
319 }
320 return 0;
321}
322
323int 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)
326{
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;
331
332 if (battr->read && battr->read_new)
333 return -EINVAL;
334
335 if (battr->write && battr->write_new)
336 return -EINVAL;
337
338 if (battr->mmap)
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;
346 else
347 ops = &sysfs_file_kfops_empty;
348
349#ifdef CONFIG_DEBUG_LOCK_ALLOC
350 if (!attr->ignore_lockdep)
351 key = attr->key ?: (struct lock_class_key *)&attr->skey;
352#endif
353
354 kn = __kernfs_create_file(parent, attr->name, mode & 0777, uid, gid,
355 size, ops, (void *)attr, ns, key);
356 if (IS_ERR(kn)) {
357 if (PTR_ERR(kn) == -EEXIST)
358 sysfs_warn_dup(parent, attr->name);
359 return PTR_ERR(kn);
360 }
361 return 0;
362}
363
364/**
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
369 */
370int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
371 const void *ns)
372{
373 kuid_t uid;
374 kgid_t gid;
375
376 if (WARN_ON(!kobj || !kobj->sd || !attr))
377 return -EINVAL;
378
379 kobject_get_ownership(kobj, &uid, &gid);
380 return sysfs_add_file_mode_ns(kobj->sd, attr, attr->mode, uid, gid, ns);
381}
382EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
383
384int sysfs_create_files(struct kobject *kobj, const struct attribute * const *ptr)
385{
386 int err = 0;
387 int i;
388
389 for (i = 0; ptr[i] && !err; i++)
390 err = sysfs_create_file(kobj, ptr[i]);
391 if (err)
392 while (--i >= 0)
393 sysfs_remove_file(kobj, ptr[i]);
394 return err;
395}
396EXPORT_SYMBOL_GPL(sysfs_create_files);
397
398/**
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.
403 */
404int sysfs_add_file_to_group(struct kobject *kobj,
405 const struct attribute *attr, const char *group)
406{
407 struct kernfs_node *parent;
408 kuid_t uid;
409 kgid_t gid;
410 int error;
411
412 if (group) {
413 parent = kernfs_find_and_get(kobj->sd, group);
414 } else {
415 parent = kobj->sd;
416 kernfs_get(parent);
417 }
418
419 if (!parent)
420 return -ENOENT;
421
422 kobject_get_ownership(kobj, &uid, &gid);
423 error = sysfs_add_file_mode_ns(parent, attr, attr->mode, uid, gid,
424 NULL);
425 kernfs_put(parent);
426
427 return error;
428}
429EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
430
431/**
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.
436 *
437 */
438int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
439 umode_t mode)
440{
441 struct kernfs_node *kn;
442 struct iattr newattrs;
443 int rc;
444
445 kn = kernfs_find_and_get(kobj->sd, attr->name);
446 if (!kn)
447 return -ENOENT;
448
449 newattrs.ia_mode = (mode & S_IALLUGO) | (kn->mode & ~S_IALLUGO);
450 newattrs.ia_valid = ATTR_MODE;
451
452 rc = kernfs_setattr(kn, &newattrs);
453
454 kernfs_put(kn);
455 return rc;
456}
457EXPORT_SYMBOL_GPL(sysfs_chmod_file);
458
459/**
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.
463 *
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
467 * deletion.
468 */
469struct kernfs_node *sysfs_break_active_protection(struct kobject *kobj,
470 const struct attribute *attr)
471{
472 struct kernfs_node *kn;
473
474 kobject_get(kobj);
475 kn = kernfs_find_and_get(kobj->sd, attr->name);
476 if (kn)
477 kernfs_break_active_protection(kn);
478 else
479 kobject_put(kobj);
480 return kn;
481}
482EXPORT_SYMBOL_GPL(sysfs_break_active_protection);
483
484/**
485 * sysfs_unbreak_active_protection - restore "active" protection
486 * @kn: Pointer returned by sysfs_break_active_protection().
487 *
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.
494 */
495void sysfs_unbreak_active_protection(struct kernfs_node *kn)
496{
497 struct kobject *kobj = kn->parent->priv;
498
499 kernfs_unbreak_active_protection(kn);
500 kernfs_put(kn);
501 kobject_put(kobj);
502}
503EXPORT_SYMBOL_GPL(sysfs_unbreak_active_protection);
504
505/**
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
510 *
511 * Hash the attribute name and namespace tag and kill the victim.
512 */
513void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
514 const void *ns)
515{
516 struct kernfs_node *parent = kobj->sd;
517
518 kernfs_remove_by_name_ns(parent, attr->name, ns);
519}
520EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
521
522/**
523 * sysfs_remove_file_self - remove an object attribute from its own method
524 * @kobj: object we're acting for
525 * @attr: attribute descriptor
526 *
527 * See kernfs_remove_self() for details.
528 */
529bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr)
530{
531 struct kernfs_node *parent = kobj->sd;
532 struct kernfs_node *kn;
533 bool ret;
534
535 kn = kernfs_find_and_get(parent, attr->name);
536 if (WARN_ON_ONCE(!kn))
537 return false;
538
539 ret = kernfs_remove_self(kn);
540
541 kernfs_put(kn);
542 return ret;
543}
544EXPORT_SYMBOL_GPL(sysfs_remove_file_self);
545
546void sysfs_remove_files(struct kobject *kobj, const struct attribute * const *ptr)
547{
548 int i;
549
550 for (i = 0; ptr[i]; i++)
551 sysfs_remove_file(kobj, ptr[i]);
552}
553EXPORT_SYMBOL_GPL(sysfs_remove_files);
554
555/**
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.
560 */
561void sysfs_remove_file_from_group(struct kobject *kobj,
562 const struct attribute *attr, const char *group)
563{
564 struct kernfs_node *parent;
565
566 if (group) {
567 parent = kernfs_find_and_get(kobj->sd, group);
568 } else {
569 parent = kobj->sd;
570 kernfs_get(parent);
571 }
572
573 if (parent) {
574 kernfs_remove_by_name(parent, attr->name);
575 kernfs_put(parent);
576 }
577}
578EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
579
580/**
581 * sysfs_create_bin_file - create binary file for object.
582 * @kobj: object.
583 * @attr: attribute descriptor.
584 */
585int sysfs_create_bin_file(struct kobject *kobj,
586 const struct bin_attribute *attr)
587{
588 kuid_t uid;
589 kgid_t gid;
590
591 if (WARN_ON(!kobj || !kobj->sd || !attr))
592 return -EINVAL;
593
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);
597}
598EXPORT_SYMBOL_GPL(sysfs_create_bin_file);
599
600/**
601 * sysfs_remove_bin_file - remove binary file for object.
602 * @kobj: object.
603 * @attr: attribute descriptor.
604 */
605void sysfs_remove_bin_file(struct kobject *kobj,
606 const struct bin_attribute *attr)
607{
608 kernfs_remove_by_name(kobj->sd, attr->attr.name);
609}
610EXPORT_SYMBOL_GPL(sysfs_remove_bin_file);
611
612static int internal_change_owner(struct kernfs_node *kn, kuid_t kuid,
613 kgid_t kgid)
614{
615 struct iattr newattrs = {
616 .ia_valid = ATTR_UID | ATTR_GID,
617 .ia_uid = kuid,
618 .ia_gid = kgid,
619 };
620 return kernfs_setattr(kn, &newattrs);
621}
622
623/**
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
630 *
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
633 * @targ.
634 *
635 * Returns 0 on success or error code on failure.
636 */
637int sysfs_link_change_owner(struct kobject *kobj, struct kobject *targ,
638 const char *name, kuid_t kuid, kgid_t kgid)
639{
640 struct kernfs_node *kn = NULL;
641 int error;
642
643 if (!name || !kobj->state_in_sysfs || !targ->state_in_sysfs)
644 return -EINVAL;
645
646 error = -ENOENT;
647 kn = kernfs_find_and_get_ns(kobj->sd, name, targ->sd->ns);
648 if (!kn)
649 goto out;
650
651 error = -EINVAL;
652 if (kernfs_type(kn) != KERNFS_LINK)
653 goto out;
654 if (kn->symlink.target_kn->priv != targ)
655 goto out;
656
657 error = internal_change_owner(kn, kuid, kgid);
658
659out:
660 kernfs_put(kn);
661 return error;
662}
663
664/**
665 * sysfs_file_change_owner - change owner of a sysfs file.
666 * @kobj: object.
667 * @name: name of the file to change.
668 * @kuid: new owner's kuid
669 * @kgid: new owner's kgid
670 *
671 * This function looks up the sysfs entry @name under @kobj and changes the
672 * ownership to @kuid/@kgid.
673 *
674 * Returns 0 on success or error code on failure.
675 */
676int sysfs_file_change_owner(struct kobject *kobj, const char *name, kuid_t kuid,
677 kgid_t kgid)
678{
679 struct kernfs_node *kn;
680 int error;
681
682 if (!name)
683 return -EINVAL;
684
685 if (!kobj->state_in_sysfs)
686 return -EINVAL;
687
688 kn = kernfs_find_and_get(kobj->sd, name);
689 if (!kn)
690 return -ENOENT;
691
692 error = internal_change_owner(kn, kuid, kgid);
693
694 kernfs_put(kn);
695
696 return error;
697}
698EXPORT_SYMBOL_GPL(sysfs_file_change_owner);
699
700/**
701 * sysfs_change_owner - change owner of the given object.
702 * @kobj: object.
703 * @kuid: new owner's kuid
704 * @kgid: new owner's kgid
705 *
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.
715 *
716 * Returns 0 on success or error code on failure.
717 */
718int sysfs_change_owner(struct kobject *kobj, kuid_t kuid, kgid_t kgid)
719{
720 int error;
721 const struct kobj_type *ktype;
722
723 if (!kobj->state_in_sysfs)
724 return -EINVAL;
725
726 /* Change the owner of the kobject itself. */
727 error = internal_change_owner(kobj->sd, kuid, kgid);
728 if (error)
729 return error;
730
731 ktype = get_ktype(kobj);
732 if (ktype) {
733 /*
734 * Change owner of the default groups associated with the
735 * ktype of @kobj.
736 */
737 error = sysfs_groups_change_owner(kobj, ktype->default_groups,
738 kuid, kgid);
739 if (error)
740 return error;
741 }
742
743 return 0;
744}
745EXPORT_SYMBOL_GPL(sysfs_change_owner);
746
747/**
748 * sysfs_emit - scnprintf equivalent, aware of PAGE_SIZE buffer.
749 * @buf: start of PAGE_SIZE buffer.
750 * @fmt: format
751 * @...: optional arguments to @format
752 *
753 *
754 * Returns number of characters written to @buf.
755 */
756int sysfs_emit(char *buf, const char *fmt, ...)
757{
758 va_list args;
759 int len;
760
761 if (WARN(!buf || offset_in_page(buf),
762 "invalid sysfs_emit: buf:%p\n", buf))
763 return 0;
764
765 va_start(args, fmt);
766 len = vscnprintf(buf, PAGE_SIZE, fmt, args);
767 va_end(args);
768
769 return len;
770}
771EXPORT_SYMBOL_GPL(sysfs_emit);
772
773/**
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
778 * @fmt: format
779 * @...: optional arguments to @fmt
780 *
781 *
782 * Returns number of characters written starting at &@buf[@at].
783 */
784int sysfs_emit_at(char *buf, int at, const char *fmt, ...)
785{
786 va_list args;
787 int len;
788
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))
791 return 0;
792
793 va_start(args, fmt);
794 len = vscnprintf(buf + at, PAGE_SIZE - at, fmt, args);
795 va_end(args);
796
797 return len;
798}
799EXPORT_SYMBOL_GPL(sysfs_emit_at);
800
801/**
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.
809 *
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.
813 *
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().
816 *
817 * Returns number of bytes written to @buf.
818 */
819ssize_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)
822{
823 memcpy(buf, attr->private + off, count);
824 return count;
825}
826EXPORT_SYMBOL_GPL(sysfs_bin_attr_simple_read);