Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * fs/sysfs/group.c - Operations for adding/removing multiple files at once.
4 *
5 * Copyright (c) 2003 Patrick Mochel
6 * Copyright (c) 2003 Open Source Development Lab
7 * Copyright (c) 2013 Greg Kroah-Hartman
8 * Copyright (c) 2013 The Linux Foundation
9 */
10
11#include <linux/kobject.h>
12#include <linux/module.h>
13#include <linux/dcache.h>
14#include <linux/namei.h>
15#include <linux/err.h>
16#include <linux/fs.h>
17#include "sysfs.h"
18
19
20static void remove_files(struct kernfs_node *parent,
21 const struct attribute_group *grp)
22{
23 struct attribute *const *attr;
24 struct bin_attribute *const *bin_attr;
25
26 if (grp->attrs)
27 for (attr = grp->attrs; *attr; attr++)
28 kernfs_remove_by_name(parent, (*attr)->name);
29 if (grp->bin_attrs)
30 for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++)
31 kernfs_remove_by_name(parent, (*bin_attr)->attr.name);
32}
33
34static umode_t __first_visible(const struct attribute_group *grp, struct kobject *kobj)
35{
36 if (grp->attrs && grp->attrs[0] && grp->is_visible)
37 return grp->is_visible(kobj, grp->attrs[0], 0);
38
39 if (grp->bin_attrs && grp->bin_attrs[0] && grp->is_bin_visible)
40 return grp->is_bin_visible(kobj, grp->bin_attrs[0], 0);
41
42 return 0;
43}
44
45static int create_files(struct kernfs_node *parent, struct kobject *kobj,
46 kuid_t uid, kgid_t gid,
47 const struct attribute_group *grp, int update)
48{
49 struct attribute *const *attr;
50 struct bin_attribute *const *bin_attr;
51 int error = 0, i;
52
53 if (grp->attrs) {
54 for (i = 0, attr = grp->attrs; *attr && !error; i++, attr++) {
55 umode_t mode = (*attr)->mode;
56
57 /*
58 * In update mode, we're changing the permissions or
59 * visibility. Do this by first removing then
60 * re-adding (if required) the file.
61 */
62 if (update)
63 kernfs_remove_by_name(parent, (*attr)->name);
64 if (grp->is_visible) {
65 mode = grp->is_visible(kobj, *attr, i);
66 mode &= ~SYSFS_GROUP_INVISIBLE;
67 if (!mode)
68 continue;
69 }
70
71 WARN(mode & ~(SYSFS_PREALLOC | 0664),
72 "Attribute %s: Invalid permissions 0%o\n",
73 (*attr)->name, mode);
74
75 mode &= SYSFS_PREALLOC | 0664;
76 error = sysfs_add_file_mode_ns(parent, *attr, mode, uid,
77 gid, NULL);
78 if (unlikely(error))
79 break;
80 }
81 if (error) {
82 remove_files(parent, grp);
83 goto exit;
84 }
85 }
86
87 if (grp->bin_attrs) {
88 for (i = 0, bin_attr = grp->bin_attrs; *bin_attr; i++, bin_attr++) {
89 umode_t mode = (*bin_attr)->attr.mode;
90 size_t size = (*bin_attr)->size;
91
92 if (update)
93 kernfs_remove_by_name(parent,
94 (*bin_attr)->attr.name);
95 if (grp->is_bin_visible) {
96 mode = grp->is_bin_visible(kobj, *bin_attr, i);
97 mode &= ~SYSFS_GROUP_INVISIBLE;
98 if (!mode)
99 continue;
100 }
101 if (grp->bin_size)
102 size = grp->bin_size(kobj, *bin_attr, i);
103
104 WARN(mode & ~(SYSFS_PREALLOC | 0664),
105 "Attribute %s: Invalid permissions 0%o\n",
106 (*bin_attr)->attr.name, mode);
107
108 mode &= SYSFS_PREALLOC | 0664;
109 error = sysfs_add_bin_file_mode_ns(parent, *bin_attr,
110 mode, size, uid, gid,
111 NULL);
112 if (error)
113 break;
114 }
115 if (error)
116 remove_files(parent, grp);
117 }
118exit:
119 return error;
120}
121
122
123static int internal_create_group(struct kobject *kobj, int update,
124 const struct attribute_group *grp)
125{
126 struct kernfs_node *kn;
127 kuid_t uid;
128 kgid_t gid;
129 int error;
130
131 if (WARN_ON(!kobj || (!update && !kobj->sd)))
132 return -EINVAL;
133
134 /* Updates may happen before the object has been instantiated */
135 if (unlikely(update && !kobj->sd))
136 return -EINVAL;
137
138 if (!grp->attrs && !grp->bin_attrs) {
139 pr_debug("sysfs: (bin_)attrs not set by subsystem for group: %s/%s, skipping\n",
140 kobj->name, grp->name ?: "");
141 return 0;
142 }
143
144 kobject_get_ownership(kobj, &uid, &gid);
145 if (grp->name) {
146 umode_t mode = __first_visible(grp, kobj);
147
148 if (mode & SYSFS_GROUP_INVISIBLE)
149 mode = 0;
150 else
151 mode = S_IRWXU | S_IRUGO | S_IXUGO;
152
153 if (update) {
154 kn = kernfs_find_and_get(kobj->sd, grp->name);
155 if (!kn) {
156 pr_debug("attr grp %s/%s not created yet\n",
157 kobj->name, grp->name);
158 /* may have been invisible prior to this update */
159 update = 0;
160 } else if (!mode) {
161 sysfs_remove_group(kobj, grp);
162 kernfs_put(kn);
163 return 0;
164 }
165 }
166
167 if (!update) {
168 if (!mode)
169 return 0;
170 kn = kernfs_create_dir_ns(kobj->sd, grp->name, mode,
171 uid, gid, kobj, NULL);
172 if (IS_ERR(kn)) {
173 if (PTR_ERR(kn) == -EEXIST)
174 sysfs_warn_dup(kobj->sd, grp->name);
175 return PTR_ERR(kn);
176 }
177 }
178 } else {
179 kn = kobj->sd;
180 }
181
182 kernfs_get(kn);
183 error = create_files(kn, kobj, uid, gid, grp, update);
184 if (error) {
185 if (grp->name)
186 kernfs_remove(kn);
187 }
188 kernfs_put(kn);
189
190 if (grp->name && update)
191 kernfs_put(kn);
192
193 return error;
194}
195
196/**
197 * sysfs_create_group - given a directory kobject, create an attribute group
198 * @kobj: The kobject to create the group on
199 * @grp: The attribute group to create
200 *
201 * This function creates a group for the first time. It will explicitly
202 * warn and error if any of the attribute files being created already exist.
203 *
204 * Returns 0 on success or error code on failure.
205 */
206int sysfs_create_group(struct kobject *kobj,
207 const struct attribute_group *grp)
208{
209 return internal_create_group(kobj, 0, grp);
210}
211EXPORT_SYMBOL_GPL(sysfs_create_group);
212
213static int internal_create_groups(struct kobject *kobj, int update,
214 const struct attribute_group **groups)
215{
216 int error = 0;
217 int i;
218
219 if (!groups)
220 return 0;
221
222 for (i = 0; groups[i]; i++) {
223 error = internal_create_group(kobj, update, groups[i]);
224 if (error) {
225 while (--i >= 0)
226 sysfs_remove_group(kobj, groups[i]);
227 break;
228 }
229 }
230 return error;
231}
232
233/**
234 * sysfs_create_groups - given a directory kobject, create a bunch of attribute groups
235 * @kobj: The kobject to create the group on
236 * @groups: The attribute groups to create, NULL terminated
237 *
238 * This function creates a bunch of attribute groups. If an error occurs when
239 * creating a group, all previously created groups will be removed, unwinding
240 * everything back to the original state when this function was called.
241 * It will explicitly warn and error if any of the attribute files being
242 * created already exist.
243 *
244 * Returns 0 on success or error code from sysfs_create_group on failure.
245 */
246int sysfs_create_groups(struct kobject *kobj,
247 const struct attribute_group **groups)
248{
249 return internal_create_groups(kobj, 0, groups);
250}
251EXPORT_SYMBOL_GPL(sysfs_create_groups);
252
253/**
254 * sysfs_update_groups - given a directory kobject, create a bunch of attribute groups
255 * @kobj: The kobject to update the group on
256 * @groups: The attribute groups to update, NULL terminated
257 *
258 * This function update a bunch of attribute groups. If an error occurs when
259 * updating a group, all previously updated groups will be removed together
260 * with already existing (not updated) attributes.
261 *
262 * Returns 0 on success or error code from sysfs_update_group on failure.
263 */
264int sysfs_update_groups(struct kobject *kobj,
265 const struct attribute_group **groups)
266{
267 return internal_create_groups(kobj, 1, groups);
268}
269EXPORT_SYMBOL_GPL(sysfs_update_groups);
270
271/**
272 * sysfs_update_group - given a directory kobject, update an attribute group
273 * @kobj: The kobject to update the group on
274 * @grp: The attribute group to update
275 *
276 * This function updates an attribute group. Unlike
277 * sysfs_create_group(), it will explicitly not warn or error if any
278 * of the attribute files being created already exist. Furthermore,
279 * if the visibility of the files has changed through the is_visible()
280 * callback, it will update the permissions and add or remove the
281 * relevant files. Changing a group's name (subdirectory name under
282 * kobj's directory in sysfs) is not allowed.
283 *
284 * The primary use for this function is to call it after making a change
285 * that affects group visibility.
286 *
287 * Returns 0 on success or error code on failure.
288 */
289int sysfs_update_group(struct kobject *kobj,
290 const struct attribute_group *grp)
291{
292 return internal_create_group(kobj, 1, grp);
293}
294EXPORT_SYMBOL_GPL(sysfs_update_group);
295
296/**
297 * sysfs_remove_group: remove a group from a kobject
298 * @kobj: kobject to remove the group from
299 * @grp: group to remove
300 *
301 * This function removes a group of attributes from a kobject. The attributes
302 * previously have to have been created for this group, otherwise it will fail.
303 */
304void sysfs_remove_group(struct kobject *kobj,
305 const struct attribute_group *grp)
306{
307 struct kernfs_node *parent = kobj->sd;
308 struct kernfs_node *kn;
309
310 if (grp->name) {
311 kn = kernfs_find_and_get(parent, grp->name);
312 if (!kn) {
313 pr_debug("sysfs group '%s' not found for kobject '%s'\n",
314 grp->name, kobject_name(kobj));
315 return;
316 }
317 } else {
318 kn = parent;
319 kernfs_get(kn);
320 }
321
322 remove_files(kn, grp);
323 if (grp->name)
324 kernfs_remove(kn);
325
326 kernfs_put(kn);
327}
328EXPORT_SYMBOL_GPL(sysfs_remove_group);
329
330/**
331 * sysfs_remove_groups - remove a list of groups
332 *
333 * @kobj: The kobject for the groups to be removed from
334 * @groups: NULL terminated list of groups to be removed
335 *
336 * If groups is not NULL, remove the specified groups from the kobject.
337 */
338void sysfs_remove_groups(struct kobject *kobj,
339 const struct attribute_group **groups)
340{
341 int i;
342
343 if (!groups)
344 return;
345 for (i = 0; groups[i]; i++)
346 sysfs_remove_group(kobj, groups[i]);
347}
348EXPORT_SYMBOL_GPL(sysfs_remove_groups);
349
350/**
351 * sysfs_merge_group - merge files into a pre-existing named attribute group.
352 * @kobj: The kobject containing the group.
353 * @grp: The files to create and the attribute group they belong to.
354 *
355 * This function returns an error if the group doesn't exist, the .name field is
356 * NULL or any of the files already exist in that group, in which case none of
357 * the new files are created.
358 */
359int sysfs_merge_group(struct kobject *kobj,
360 const struct attribute_group *grp)
361{
362 struct kernfs_node *parent;
363 kuid_t uid;
364 kgid_t gid;
365 int error = 0;
366 struct attribute *const *attr;
367 int i;
368
369 parent = kernfs_find_and_get(kobj->sd, grp->name);
370 if (!parent)
371 return -ENOENT;
372
373 kobject_get_ownership(kobj, &uid, &gid);
374
375 for ((i = 0, attr = grp->attrs); *attr && !error; (++i, ++attr))
376 error = sysfs_add_file_mode_ns(parent, *attr, (*attr)->mode,
377 uid, gid, NULL);
378 if (error) {
379 while (--i >= 0)
380 kernfs_remove_by_name(parent, (*--attr)->name);
381 }
382 kernfs_put(parent);
383
384 return error;
385}
386EXPORT_SYMBOL_GPL(sysfs_merge_group);
387
388/**
389 * sysfs_unmerge_group - remove files from a pre-existing named attribute group.
390 * @kobj: The kobject containing the group.
391 * @grp: The files to remove and the attribute group they belong to.
392 */
393void sysfs_unmerge_group(struct kobject *kobj,
394 const struct attribute_group *grp)
395{
396 struct kernfs_node *parent;
397 struct attribute *const *attr;
398
399 parent = kernfs_find_and_get(kobj->sd, grp->name);
400 if (parent) {
401 for (attr = grp->attrs; *attr; ++attr)
402 kernfs_remove_by_name(parent, (*attr)->name);
403 kernfs_put(parent);
404 }
405}
406EXPORT_SYMBOL_GPL(sysfs_unmerge_group);
407
408/**
409 * sysfs_add_link_to_group - add a symlink to an attribute group.
410 * @kobj: The kobject containing the group.
411 * @group_name: The name of the group.
412 * @target: The target kobject of the symlink to create.
413 * @link_name: The name of the symlink to create.
414 */
415int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
416 struct kobject *target, const char *link_name)
417{
418 struct kernfs_node *parent;
419 int error = 0;
420
421 parent = kernfs_find_and_get(kobj->sd, group_name);
422 if (!parent)
423 return -ENOENT;
424
425 error = sysfs_create_link_sd(parent, target, link_name);
426 kernfs_put(parent);
427
428 return error;
429}
430EXPORT_SYMBOL_GPL(sysfs_add_link_to_group);
431
432/**
433 * sysfs_remove_link_from_group - remove a symlink from an attribute group.
434 * @kobj: The kobject containing the group.
435 * @group_name: The name of the group.
436 * @link_name: The name of the symlink to remove.
437 */
438void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
439 const char *link_name)
440{
441 struct kernfs_node *parent;
442
443 parent = kernfs_find_and_get(kobj->sd, group_name);
444 if (parent) {
445 kernfs_remove_by_name(parent, link_name);
446 kernfs_put(parent);
447 }
448}
449EXPORT_SYMBOL_GPL(sysfs_remove_link_from_group);
450
451/**
452 * compat_only_sysfs_link_entry_to_kobj - add a symlink to a kobject pointing
453 * to a group or an attribute
454 * @kobj: The kobject containing the group.
455 * @target_kobj: The target kobject.
456 * @target_name: The name of the target group or attribute.
457 * @symlink_name: The name of the symlink file (target_name will be
458 * considered if symlink_name is NULL).
459 */
460int compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj,
461 struct kobject *target_kobj,
462 const char *target_name,
463 const char *symlink_name)
464{
465 struct kernfs_node *target;
466 struct kernfs_node *entry;
467 struct kernfs_node *link;
468
469 /*
470 * We don't own @target_kobj and it may be removed at any time.
471 * Synchronize using sysfs_symlink_target_lock. See sysfs_remove_dir()
472 * for details.
473 */
474 spin_lock(&sysfs_symlink_target_lock);
475 target = target_kobj->sd;
476 if (target)
477 kernfs_get(target);
478 spin_unlock(&sysfs_symlink_target_lock);
479 if (!target)
480 return -ENOENT;
481
482 entry = kernfs_find_and_get(target, target_name);
483 if (!entry) {
484 kernfs_put(target);
485 return -ENOENT;
486 }
487
488 if (!symlink_name)
489 symlink_name = target_name;
490
491 link = kernfs_create_link(kobj->sd, symlink_name, entry);
492 if (PTR_ERR(link) == -EEXIST)
493 sysfs_warn_dup(kobj->sd, symlink_name);
494
495 kernfs_put(entry);
496 kernfs_put(target);
497 return PTR_ERR_OR_ZERO(link);
498}
499EXPORT_SYMBOL_GPL(compat_only_sysfs_link_entry_to_kobj);
500
501static int sysfs_group_attrs_change_owner(struct kernfs_node *grp_kn,
502 const struct attribute_group *grp,
503 struct iattr *newattrs)
504{
505 struct kernfs_node *kn;
506 int error;
507
508 if (grp->attrs) {
509 struct attribute *const *attr;
510
511 for (attr = grp->attrs; *attr; attr++) {
512 kn = kernfs_find_and_get(grp_kn, (*attr)->name);
513 if (!kn)
514 return -ENOENT;
515
516 error = kernfs_setattr(kn, newattrs);
517 kernfs_put(kn);
518 if (error)
519 return error;
520 }
521 }
522
523 if (grp->bin_attrs) {
524 struct bin_attribute *const *bin_attr;
525
526 for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++) {
527 kn = kernfs_find_and_get(grp_kn, (*bin_attr)->attr.name);
528 if (!kn)
529 return -ENOENT;
530
531 error = kernfs_setattr(kn, newattrs);
532 kernfs_put(kn);
533 if (error)
534 return error;
535 }
536 }
537
538 return 0;
539}
540
541/**
542 * sysfs_group_change_owner - change owner of an attribute group.
543 * @kobj: The kobject containing the group.
544 * @grp: The attribute group.
545 * @kuid: new owner's kuid
546 * @kgid: new owner's kgid
547 *
548 * Returns 0 on success or error code on failure.
549 */
550int sysfs_group_change_owner(struct kobject *kobj,
551 const struct attribute_group *grp, kuid_t kuid,
552 kgid_t kgid)
553{
554 struct kernfs_node *grp_kn;
555 int error;
556 struct iattr newattrs = {
557 .ia_valid = ATTR_UID | ATTR_GID,
558 .ia_uid = kuid,
559 .ia_gid = kgid,
560 };
561
562 if (!kobj->state_in_sysfs)
563 return -EINVAL;
564
565 if (grp->name) {
566 grp_kn = kernfs_find_and_get(kobj->sd, grp->name);
567 } else {
568 kernfs_get(kobj->sd);
569 grp_kn = kobj->sd;
570 }
571 if (!grp_kn)
572 return -ENOENT;
573
574 error = kernfs_setattr(grp_kn, &newattrs);
575 if (!error)
576 error = sysfs_group_attrs_change_owner(grp_kn, grp, &newattrs);
577
578 kernfs_put(grp_kn);
579
580 return error;
581}
582EXPORT_SYMBOL_GPL(sysfs_group_change_owner);
583
584/**
585 * sysfs_groups_change_owner - change owner of a set of attribute groups.
586 * @kobj: The kobject containing the groups.
587 * @groups: The attribute groups.
588 * @kuid: new owner's kuid
589 * @kgid: new owner's kgid
590 *
591 * Returns 0 on success or error code on failure.
592 */
593int sysfs_groups_change_owner(struct kobject *kobj,
594 const struct attribute_group **groups,
595 kuid_t kuid, kgid_t kgid)
596{
597 int error = 0, i;
598
599 if (!kobj->state_in_sysfs)
600 return -EINVAL;
601
602 if (!groups)
603 return 0;
604
605 for (i = 0; groups[i]; i++) {
606 error = sysfs_group_change_owner(kobj, groups[i], kuid, kgid);
607 if (error)
608 break;
609 }
610
611 return error;
612}
613EXPORT_SYMBOL_GPL(sysfs_groups_change_owner);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * fs/sysfs/group.c - Operations for adding/removing multiple files at once.
4 *
5 * Copyright (c) 2003 Patrick Mochel
6 * Copyright (c) 2003 Open Source Development Lab
7 * Copyright (c) 2013 Greg Kroah-Hartman
8 * Copyright (c) 2013 The Linux Foundation
9 */
10
11#include <linux/kobject.h>
12#include <linux/module.h>
13#include <linux/dcache.h>
14#include <linux/namei.h>
15#include <linux/err.h>
16#include <linux/fs.h>
17#include "sysfs.h"
18
19
20static void remove_files(struct kernfs_node *parent,
21 const struct attribute_group *grp)
22{
23 struct attribute *const *attr;
24 struct bin_attribute *const *bin_attr;
25
26 if (grp->attrs)
27 for (attr = grp->attrs; *attr; attr++)
28 kernfs_remove_by_name(parent, (*attr)->name);
29 if (grp->bin_attrs)
30 for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++)
31 kernfs_remove_by_name(parent, (*bin_attr)->attr.name);
32}
33
34static int create_files(struct kernfs_node *parent, struct kobject *kobj,
35 kuid_t uid, kgid_t gid,
36 const struct attribute_group *grp, int update)
37{
38 struct attribute *const *attr;
39 struct bin_attribute *const *bin_attr;
40 int error = 0, i;
41
42 if (grp->attrs) {
43 for (i = 0, attr = grp->attrs; *attr && !error; i++, attr++) {
44 umode_t mode = (*attr)->mode;
45
46 /*
47 * In update mode, we're changing the permissions or
48 * visibility. Do this by first removing then
49 * re-adding (if required) the file.
50 */
51 if (update)
52 kernfs_remove_by_name(parent, (*attr)->name);
53 if (grp->is_visible) {
54 mode = grp->is_visible(kobj, *attr, i);
55 if (!mode)
56 continue;
57 }
58
59 WARN(mode & ~(SYSFS_PREALLOC | 0664),
60 "Attribute %s: Invalid permissions 0%o\n",
61 (*attr)->name, mode);
62
63 mode &= SYSFS_PREALLOC | 0664;
64 error = sysfs_add_file_mode_ns(parent, *attr, false,
65 mode, uid, gid, NULL);
66 if (unlikely(error))
67 break;
68 }
69 if (error) {
70 remove_files(parent, grp);
71 goto exit;
72 }
73 }
74
75 if (grp->bin_attrs) {
76 for (i = 0, bin_attr = grp->bin_attrs; *bin_attr; i++, bin_attr++) {
77 umode_t mode = (*bin_attr)->attr.mode;
78
79 if (update)
80 kernfs_remove_by_name(parent,
81 (*bin_attr)->attr.name);
82 if (grp->is_bin_visible) {
83 mode = grp->is_bin_visible(kobj, *bin_attr, i);
84 if (!mode)
85 continue;
86 }
87
88 WARN(mode & ~(SYSFS_PREALLOC | 0664),
89 "Attribute %s: Invalid permissions 0%o\n",
90 (*bin_attr)->attr.name, mode);
91
92 mode &= SYSFS_PREALLOC | 0664;
93 error = sysfs_add_file_mode_ns(parent,
94 &(*bin_attr)->attr, true,
95 mode,
96 uid, gid, NULL);
97 if (error)
98 break;
99 }
100 if (error)
101 remove_files(parent, grp);
102 }
103exit:
104 return error;
105}
106
107
108static int internal_create_group(struct kobject *kobj, int update,
109 const struct attribute_group *grp)
110{
111 struct kernfs_node *kn;
112 kuid_t uid;
113 kgid_t gid;
114 int error;
115
116 if (WARN_ON(!kobj || (!update && !kobj->sd)))
117 return -EINVAL;
118
119 /* Updates may happen before the object has been instantiated */
120 if (unlikely(update && !kobj->sd))
121 return -EINVAL;
122 if (!grp->attrs && !grp->bin_attrs) {
123 WARN(1, "sysfs: (bin_)attrs not set by subsystem for group: %s/%s\n",
124 kobj->name, grp->name ?: "");
125 return -EINVAL;
126 }
127 kobject_get_ownership(kobj, &uid, &gid);
128 if (grp->name) {
129 if (update) {
130 kn = kernfs_find_and_get(kobj->sd, grp->name);
131 if (!kn) {
132 pr_warn("Can't update unknown attr grp name: %s/%s\n",
133 kobj->name, grp->name);
134 return -EINVAL;
135 }
136 } else {
137 kn = kernfs_create_dir_ns(kobj->sd, grp->name,
138 S_IRWXU | S_IRUGO | S_IXUGO,
139 uid, gid, kobj, NULL);
140 if (IS_ERR(kn)) {
141 if (PTR_ERR(kn) == -EEXIST)
142 sysfs_warn_dup(kobj->sd, grp->name);
143 return PTR_ERR(kn);
144 }
145 }
146 } else
147 kn = kobj->sd;
148 kernfs_get(kn);
149 error = create_files(kn, kobj, uid, gid, grp, update);
150 if (error) {
151 if (grp->name)
152 kernfs_remove(kn);
153 }
154 kernfs_put(kn);
155
156 if (grp->name && update)
157 kernfs_put(kn);
158
159 return error;
160}
161
162/**
163 * sysfs_create_group - given a directory kobject, create an attribute group
164 * @kobj: The kobject to create the group on
165 * @grp: The attribute group to create
166 *
167 * This function creates a group for the first time. It will explicitly
168 * warn and error if any of the attribute files being created already exist.
169 *
170 * Returns 0 on success or error code on failure.
171 */
172int sysfs_create_group(struct kobject *kobj,
173 const struct attribute_group *grp)
174{
175 return internal_create_group(kobj, 0, grp);
176}
177EXPORT_SYMBOL_GPL(sysfs_create_group);
178
179static int internal_create_groups(struct kobject *kobj, int update,
180 const struct attribute_group **groups)
181{
182 int error = 0;
183 int i;
184
185 if (!groups)
186 return 0;
187
188 for (i = 0; groups[i]; i++) {
189 error = internal_create_group(kobj, update, groups[i]);
190 if (error) {
191 while (--i >= 0)
192 sysfs_remove_group(kobj, groups[i]);
193 break;
194 }
195 }
196 return error;
197}
198
199/**
200 * sysfs_create_groups - given a directory kobject, create a bunch of attribute groups
201 * @kobj: The kobject to create the group on
202 * @groups: The attribute groups to create, NULL terminated
203 *
204 * This function creates a bunch of attribute groups. If an error occurs when
205 * creating a group, all previously created groups will be removed, unwinding
206 * everything back to the original state when this function was called.
207 * It will explicitly warn and error if any of the attribute files being
208 * created already exist.
209 *
210 * Returns 0 on success or error code from sysfs_create_group on failure.
211 */
212int sysfs_create_groups(struct kobject *kobj,
213 const struct attribute_group **groups)
214{
215 return internal_create_groups(kobj, 0, groups);
216}
217EXPORT_SYMBOL_GPL(sysfs_create_groups);
218
219/**
220 * sysfs_update_groups - given a directory kobject, create a bunch of attribute groups
221 * @kobj: The kobject to update the group on
222 * @groups: The attribute groups to update, NULL terminated
223 *
224 * This function update a bunch of attribute groups. If an error occurs when
225 * updating a group, all previously updated groups will be removed together
226 * with already existing (not updated) attributes.
227 *
228 * Returns 0 on success or error code from sysfs_update_group on failure.
229 */
230int sysfs_update_groups(struct kobject *kobj,
231 const struct attribute_group **groups)
232{
233 return internal_create_groups(kobj, 1, groups);
234}
235EXPORT_SYMBOL_GPL(sysfs_update_groups);
236
237/**
238 * sysfs_update_group - given a directory kobject, update an attribute group
239 * @kobj: The kobject to update the group on
240 * @grp: The attribute group to update
241 *
242 * This function updates an attribute group. Unlike
243 * sysfs_create_group(), it will explicitly not warn or error if any
244 * of the attribute files being created already exist. Furthermore,
245 * if the visibility of the files has changed through the is_visible()
246 * callback, it will update the permissions and add or remove the
247 * relevant files. Changing a group's name (subdirectory name under
248 * kobj's directory in sysfs) is not allowed.
249 *
250 * The primary use for this function is to call it after making a change
251 * that affects group visibility.
252 *
253 * Returns 0 on success or error code on failure.
254 */
255int sysfs_update_group(struct kobject *kobj,
256 const struct attribute_group *grp)
257{
258 return internal_create_group(kobj, 1, grp);
259}
260EXPORT_SYMBOL_GPL(sysfs_update_group);
261
262/**
263 * sysfs_remove_group: remove a group from a kobject
264 * @kobj: kobject to remove the group from
265 * @grp: group to remove
266 *
267 * This function removes a group of attributes from a kobject. The attributes
268 * previously have to have been created for this group, otherwise it will fail.
269 */
270void sysfs_remove_group(struct kobject *kobj,
271 const struct attribute_group *grp)
272{
273 struct kernfs_node *parent = kobj->sd;
274 struct kernfs_node *kn;
275
276 if (grp->name) {
277 kn = kernfs_find_and_get(parent, grp->name);
278 if (!kn) {
279 WARN(!kn, KERN_WARNING
280 "sysfs group '%s' not found for kobject '%s'\n",
281 grp->name, kobject_name(kobj));
282 return;
283 }
284 } else {
285 kn = parent;
286 kernfs_get(kn);
287 }
288
289 remove_files(kn, grp);
290 if (grp->name)
291 kernfs_remove(kn);
292
293 kernfs_put(kn);
294}
295EXPORT_SYMBOL_GPL(sysfs_remove_group);
296
297/**
298 * sysfs_remove_groups - remove a list of groups
299 *
300 * @kobj: The kobject for the groups to be removed from
301 * @groups: NULL terminated list of groups to be removed
302 *
303 * If groups is not NULL, remove the specified groups from the kobject.
304 */
305void sysfs_remove_groups(struct kobject *kobj,
306 const struct attribute_group **groups)
307{
308 int i;
309
310 if (!groups)
311 return;
312 for (i = 0; groups[i]; i++)
313 sysfs_remove_group(kobj, groups[i]);
314}
315EXPORT_SYMBOL_GPL(sysfs_remove_groups);
316
317/**
318 * sysfs_merge_group - merge files into a pre-existing attribute group.
319 * @kobj: The kobject containing the group.
320 * @grp: The files to create and the attribute group they belong to.
321 *
322 * This function returns an error if the group doesn't exist or any of the
323 * files already exist in that group, in which case none of the new files
324 * are created.
325 */
326int sysfs_merge_group(struct kobject *kobj,
327 const struct attribute_group *grp)
328{
329 struct kernfs_node *parent;
330 kuid_t uid;
331 kgid_t gid;
332 int error = 0;
333 struct attribute *const *attr;
334 int i;
335
336 parent = kernfs_find_and_get(kobj->sd, grp->name);
337 if (!parent)
338 return -ENOENT;
339
340 kobject_get_ownership(kobj, &uid, &gid);
341
342 for ((i = 0, attr = grp->attrs); *attr && !error; (++i, ++attr))
343 error = sysfs_add_file_mode_ns(parent, *attr, false,
344 (*attr)->mode, uid, gid, NULL);
345 if (error) {
346 while (--i >= 0)
347 kernfs_remove_by_name(parent, (*--attr)->name);
348 }
349 kernfs_put(parent);
350
351 return error;
352}
353EXPORT_SYMBOL_GPL(sysfs_merge_group);
354
355/**
356 * sysfs_unmerge_group - remove files from a pre-existing attribute group.
357 * @kobj: The kobject containing the group.
358 * @grp: The files to remove and the attribute group they belong to.
359 */
360void sysfs_unmerge_group(struct kobject *kobj,
361 const struct attribute_group *grp)
362{
363 struct kernfs_node *parent;
364 struct attribute *const *attr;
365
366 parent = kernfs_find_and_get(kobj->sd, grp->name);
367 if (parent) {
368 for (attr = grp->attrs; *attr; ++attr)
369 kernfs_remove_by_name(parent, (*attr)->name);
370 kernfs_put(parent);
371 }
372}
373EXPORT_SYMBOL_GPL(sysfs_unmerge_group);
374
375/**
376 * sysfs_add_link_to_group - add a symlink to an attribute group.
377 * @kobj: The kobject containing the group.
378 * @group_name: The name of the group.
379 * @target: The target kobject of the symlink to create.
380 * @link_name: The name of the symlink to create.
381 */
382int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
383 struct kobject *target, const char *link_name)
384{
385 struct kernfs_node *parent;
386 int error = 0;
387
388 parent = kernfs_find_and_get(kobj->sd, group_name);
389 if (!parent)
390 return -ENOENT;
391
392 error = sysfs_create_link_sd(parent, target, link_name);
393 kernfs_put(parent);
394
395 return error;
396}
397EXPORT_SYMBOL_GPL(sysfs_add_link_to_group);
398
399/**
400 * sysfs_remove_link_from_group - remove a symlink from an attribute group.
401 * @kobj: The kobject containing the group.
402 * @group_name: The name of the group.
403 * @link_name: The name of the symlink to remove.
404 */
405void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
406 const char *link_name)
407{
408 struct kernfs_node *parent;
409
410 parent = kernfs_find_and_get(kobj->sd, group_name);
411 if (parent) {
412 kernfs_remove_by_name(parent, link_name);
413 kernfs_put(parent);
414 }
415}
416EXPORT_SYMBOL_GPL(sysfs_remove_link_from_group);
417
418/**
419 * compat_only_sysfs_link_entry_to_kobj - add a symlink to a kobject pointing
420 * to a group or an attribute
421 * @kobj: The kobject containing the group.
422 * @target_kobj: The target kobject.
423 * @target_name: The name of the target group or attribute.
424 * @symlink_name: The name of the symlink file (target_name will be
425 * considered if symlink_name is NULL).
426 */
427int compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj,
428 struct kobject *target_kobj,
429 const char *target_name,
430 const char *symlink_name)
431{
432 struct kernfs_node *target;
433 struct kernfs_node *entry;
434 struct kernfs_node *link;
435
436 /*
437 * We don't own @target_kobj and it may be removed at any time.
438 * Synchronize using sysfs_symlink_target_lock. See sysfs_remove_dir()
439 * for details.
440 */
441 spin_lock(&sysfs_symlink_target_lock);
442 target = target_kobj->sd;
443 if (target)
444 kernfs_get(target);
445 spin_unlock(&sysfs_symlink_target_lock);
446 if (!target)
447 return -ENOENT;
448
449 entry = kernfs_find_and_get(target_kobj->sd, target_name);
450 if (!entry) {
451 kernfs_put(target);
452 return -ENOENT;
453 }
454
455 if (!symlink_name)
456 symlink_name = target_name;
457
458 link = kernfs_create_link(kobj->sd, symlink_name, entry);
459 if (PTR_ERR(link) == -EEXIST)
460 sysfs_warn_dup(kobj->sd, symlink_name);
461
462 kernfs_put(entry);
463 kernfs_put(target);
464 return PTR_ERR_OR_ZERO(link);
465}
466EXPORT_SYMBOL_GPL(compat_only_sysfs_link_entry_to_kobj);
467
468static int sysfs_group_attrs_change_owner(struct kernfs_node *grp_kn,
469 const struct attribute_group *grp,
470 struct iattr *newattrs)
471{
472 struct kernfs_node *kn;
473 int error;
474
475 if (grp->attrs) {
476 struct attribute *const *attr;
477
478 for (attr = grp->attrs; *attr; attr++) {
479 kn = kernfs_find_and_get(grp_kn, (*attr)->name);
480 if (!kn)
481 return -ENOENT;
482
483 error = kernfs_setattr(kn, newattrs);
484 kernfs_put(kn);
485 if (error)
486 return error;
487 }
488 }
489
490 if (grp->bin_attrs) {
491 struct bin_attribute *const *bin_attr;
492
493 for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++) {
494 kn = kernfs_find_and_get(grp_kn, (*bin_attr)->attr.name);
495 if (!kn)
496 return -ENOENT;
497
498 error = kernfs_setattr(kn, newattrs);
499 kernfs_put(kn);
500 if (error)
501 return error;
502 }
503 }
504
505 return 0;
506}
507
508/**
509 * sysfs_group_change_owner - change owner of an attribute group.
510 * @kobj: The kobject containing the group.
511 * @grp: The attribute group.
512 * @kuid: new owner's kuid
513 * @kgid: new owner's kgid
514 *
515 * Returns 0 on success or error code on failure.
516 */
517int sysfs_group_change_owner(struct kobject *kobj,
518 const struct attribute_group *grp, kuid_t kuid,
519 kgid_t kgid)
520{
521 struct kernfs_node *grp_kn;
522 int error;
523 struct iattr newattrs = {
524 .ia_valid = ATTR_UID | ATTR_GID,
525 .ia_uid = kuid,
526 .ia_gid = kgid,
527 };
528
529 if (!kobj->state_in_sysfs)
530 return -EINVAL;
531
532 if (grp->name) {
533 grp_kn = kernfs_find_and_get(kobj->sd, grp->name);
534 } else {
535 kernfs_get(kobj->sd);
536 grp_kn = kobj->sd;
537 }
538 if (!grp_kn)
539 return -ENOENT;
540
541 error = kernfs_setattr(grp_kn, &newattrs);
542 if (!error)
543 error = sysfs_group_attrs_change_owner(grp_kn, grp, &newattrs);
544
545 kernfs_put(grp_kn);
546
547 return error;
548}
549EXPORT_SYMBOL_GPL(sysfs_group_change_owner);
550
551/**
552 * sysfs_groups_change_owner - change owner of a set of attribute groups.
553 * @kobj: The kobject containing the groups.
554 * @groups: The attribute groups.
555 * @kuid: new owner's kuid
556 * @kgid: new owner's kgid
557 *
558 * Returns 0 on success or error code on failure.
559 */
560int sysfs_groups_change_owner(struct kobject *kobj,
561 const struct attribute_group **groups,
562 kuid_t kuid, kgid_t kgid)
563{
564 int error = 0, i;
565
566 if (!kobj->state_in_sysfs)
567 return -EINVAL;
568
569 if (!groups)
570 return 0;
571
572 for (i = 0; groups[i]; i++) {
573 error = sysfs_group_change_owner(kobj, groups[i], kuid, kgid);
574 if (error)
575 break;
576 }
577
578 return error;
579}
580EXPORT_SYMBOL_GPL(sysfs_groups_change_owner);