Blame view
fs/sysfs/group.c
10.8 KB
1da177e4c
|
1 2 3 4 5 |
/* * fs/sysfs/group.c - Operations for adding/removing multiple files at once. * * Copyright (c) 2003 Patrick Mochel * Copyright (c) 2003 Open Source Development Lab |
9e2a47ed6
|
6 7 |
* Copyright (c) 2013 Greg Kroah-Hartman * Copyright (c) 2013 The Linux Foundation |
1da177e4c
|
8 |
* |
e6c56920f
|
9 |
* This file is released undert the GPL v2. |
1da177e4c
|
10 11 12 13 14 15 |
* */ #include <linux/kobject.h> #include <linux/module.h> #include <linux/dcache.h> |
5f45f1a78
|
16 |
#include <linux/namei.h> |
1da177e4c
|
17 18 |
#include <linux/err.h> #include "sysfs.h" |
9f70a4012
|
19 |
static void remove_files(struct kernfs_node *parent, |
608e266a2
|
20 |
const struct attribute_group *grp) |
1da177e4c
|
21 |
{ |
995d8ed94
|
22 23 |
struct attribute *const *attr; struct bin_attribute *const *bin_attr; |
1da177e4c
|
24 |
|
6ab9cea16
|
25 26 |
if (grp->attrs) for (attr = grp->attrs; *attr; attr++) |
324a56e16
|
27 |
kernfs_remove_by_name(parent, (*attr)->name); |
6ab9cea16
|
28 29 |
if (grp->bin_attrs) for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++) |
9f70a4012
|
30 |
kernfs_remove_by_name(parent, (*bin_attr)->attr.name); |
1da177e4c
|
31 |
} |
324a56e16
|
32 |
static int create_files(struct kernfs_node *parent, struct kobject *kobj, |
0f4238958
|
33 |
const struct attribute_group *grp, int update) |
1da177e4c
|
34 |
{ |
995d8ed94
|
35 36 |
struct attribute *const *attr; struct bin_attribute *const *bin_attr; |
d4acd722b
|
37 |
int error = 0, i; |
1da177e4c
|
38 |
|
6ab9cea16
|
39 40 |
if (grp->attrs) { for (i = 0, attr = grp->attrs; *attr && !error; i++, attr++) { |
da4759c73
|
41 |
umode_t mode = (*attr)->mode; |
0f4238958
|
42 |
|
6ab9cea16
|
43 44 45 46 47 48 |
/* * In update mode, we're changing the permissions or * visibility. Do this by first removing then * re-adding (if required) the file. */ if (update) |
324a56e16
|
49 |
kernfs_remove_by_name(parent, (*attr)->name); |
6ab9cea16
|
50 51 52 53 54 |
if (grp->is_visible) { mode = grp->is_visible(kobj, *attr, i); if (!mode) continue; } |
d8bf8c92e
|
55 56 57 58 59 60 61 |
WARN(mode & ~(SYSFS_PREALLOC | 0664), "Attribute %s: Invalid permissions 0%o ", (*attr)->name, mode); mode &= SYSFS_PREALLOC | 0664; |
324a56e16
|
62 |
error = sysfs_add_file_mode_ns(parent, *attr, false, |
da4759c73
|
63 |
mode, NULL); |
6ab9cea16
|
64 65 66 67 |
if (unlikely(error)) break; } if (error) { |
9f70a4012
|
68 |
remove_files(parent, grp); |
6ab9cea16
|
69 70 71 72 73 |
goto exit; } } if (grp->bin_attrs) { |
7f5028cf6
|
74 75 |
for (i = 0, bin_attr = grp->bin_attrs; *bin_attr; i++, bin_attr++) { umode_t mode = (*bin_attr)->attr.mode; |
6ab9cea16
|
76 |
if (update) |
aabaf4c20
|
77 78 |
kernfs_remove_by_name(parent, (*bin_attr)->attr.name); |
7f5028cf6
|
79 80 81 82 83 84 85 86 87 88 89 90 |
if (grp->is_bin_visible) { mode = grp->is_bin_visible(kobj, *bin_attr, i); if (!mode) continue; } WARN(mode & ~(SYSFS_PREALLOC | 0664), "Attribute %s: Invalid permissions 0%o ", (*bin_attr)->attr.name, mode); mode &= SYSFS_PREALLOC | 0664; |
aabaf4c20
|
91 92 |
error = sysfs_add_file_mode_ns(parent, &(*bin_attr)->attr, true, |
7f5028cf6
|
93 |
mode, NULL); |
6ab9cea16
|
94 95 |
if (error) break; |
0f4238958
|
96 |
} |
6ab9cea16
|
97 |
if (error) |
9f70a4012
|
98 |
remove_files(parent, grp); |
0f4238958
|
99 |
} |
6ab9cea16
|
100 |
exit: |
1da177e4c
|
101 102 |
return error; } |
0f4238958
|
103 104 |
static int internal_create_group(struct kobject *kobj, int update, const struct attribute_group *grp) |
1da177e4c
|
105 |
{ |
324a56e16
|
106 |
struct kernfs_node *kn; |
1da177e4c
|
107 |
int error; |
0f4238958
|
108 109 110 111 112 |
BUG_ON(!kobj || (!update && !kobj->sd)); /* Updates may happen before the object has been instantiated */ if (unlikely(update && !kobj->sd)) return -EINVAL; |
388a8c353
|
113 114 115 |
if (!grp->attrs && !grp->bin_attrs) { WARN(1, "sysfs: (bin_)attrs not set by subsystem for group: %s/%s ", |
adf305f77
|
116 |
kobj->name, grp->name ?: ""); |
5631f2c18
|
117 118 |
return -EINVAL; } |
1da177e4c
|
119 |
if (grp->name) { |
bb8b9d095
|
120 121 |
kn = kernfs_create_dir(kobj->sd, grp->name, S_IRWXU | S_IRUGO | S_IXUGO, kobj); |
324a56e16
|
122 123 |
if (IS_ERR(kn)) { if (PTR_ERR(kn) == -EEXIST) |
93b2b8e4a
|
124 |
sysfs_warn_dup(kobj->sd, grp->name); |
324a56e16
|
125 |
return PTR_ERR(kn); |
93b2b8e4a
|
126 |
} |
1da177e4c
|
127 |
} else |
324a56e16
|
128 129 130 |
kn = kobj->sd; kernfs_get(kn); error = create_files(kn, kobj, grp, update); |
608e266a2
|
131 |
if (error) { |
1da177e4c
|
132 |
if (grp->name) |
324a56e16
|
133 |
kernfs_remove(kn); |
1da177e4c
|
134 |
} |
324a56e16
|
135 |
kernfs_put(kn); |
1da177e4c
|
136 137 |
return error; } |
0f4238958
|
138 139 140 141 142 143 144 145 |
/** * sysfs_create_group - given a directory kobject, create an attribute group * @kobj: The kobject to create the group on * @grp: The attribute group to create * * This function creates a group for the first time. It will explicitly * warn and error if any of the attribute files being created already exist. * |
ed1dc8a89
|
146 |
* Returns 0 on success or error code on failure. |
0f4238958
|
147 148 149 150 151 152 |
*/ int sysfs_create_group(struct kobject *kobj, const struct attribute_group *grp) { return internal_create_group(kobj, 0, grp); } |
d363bc53e
|
153 |
EXPORT_SYMBOL_GPL(sysfs_create_group); |
0f4238958
|
154 155 |
/** |
3e9b2bae8
|
156 157 158 159 160 161 162 163 164 165 |
* sysfs_create_groups - given a directory kobject, create a bunch of attribute groups * @kobj: The kobject to create the group on * @groups: The attribute groups to create, NULL terminated * * This function creates a bunch of attribute groups. If an error occurs when * creating a group, all previously created groups will be removed, unwinding * everything back to the original state when this function was called. * It will explicitly warn and error if any of the attribute files being * created already exist. * |
ed1dc8a89
|
166 |
* Returns 0 on success or error code from sysfs_create_group on failure. |
3e9b2bae8
|
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
*/ int sysfs_create_groups(struct kobject *kobj, const struct attribute_group **groups) { int error = 0; int i; if (!groups) return 0; for (i = 0; groups[i]; i++) { error = sysfs_create_group(kobj, groups[i]); if (error) { while (--i >= 0) sysfs_remove_group(kobj, groups[i]); break; } } return error; } EXPORT_SYMBOL_GPL(sysfs_create_groups); /** |
1f8e1cdac
|
190 191 192 |
* sysfs_update_group - given a directory kobject, update an attribute group * @kobj: The kobject to update the group on * @grp: The attribute group to update |
0f4238958
|
193 194 195 196 197 198 199 200 201 202 203 |
* * This function updates an attribute group. Unlike * sysfs_create_group(), it will explicitly not warn or error if any * of the attribute files being created already exist. Furthermore, * if the visibility of the files has changed through the is_visible() * callback, it will update the permissions and add or remove the * relevant files. * * The primary use for this function is to call it after making a change * that affects group visibility. * |
ed1dc8a89
|
204 |
* Returns 0 on success or error code on failure. |
0f4238958
|
205 206 207 208 209 210 |
*/ int sysfs_update_group(struct kobject *kobj, const struct attribute_group *grp) { return internal_create_group(kobj, 1, grp); } |
d363bc53e
|
211 |
EXPORT_SYMBOL_GPL(sysfs_update_group); |
0f4238958
|
212 |
|
f9ae443b5
|
213 214 215 216 217 218 219 220 |
/** * sysfs_remove_group: remove a group from a kobject * @kobj: kobject to remove the group from * @grp: group to remove * * This function removes a group of attributes from a kobject. The attributes * previously have to have been created for this group, otherwise it will fail. */ |
995d8ed94
|
221 222 |
void sysfs_remove_group(struct kobject *kobj, const struct attribute_group *grp) |
1da177e4c
|
223 |
{ |
324a56e16
|
224 225 |
struct kernfs_node *parent = kobj->sd; struct kernfs_node *kn; |
1da177e4c
|
226 |
|
057f6c019
|
227 |
if (grp->name) { |
324a56e16
|
228 229 230 |
kn = kernfs_find_and_get(parent, grp->name); if (!kn) { WARN(!kn, KERN_WARNING |
16aebf1c5
|
231 232 233 |
"sysfs group %p not found for kobject '%s' ", grp, kobject_name(kobj)); |
969affd27
|
234 235 |
return; } |
ccf73cf33
|
236 |
} else { |
324a56e16
|
237 238 |
kn = parent; kernfs_get(kn); |
ccf73cf33
|
239 |
} |
1da177e4c
|
240 |
|
9f70a4012
|
241 |
remove_files(kn, grp); |
1da177e4c
|
242 |
if (grp->name) |
324a56e16
|
243 |
kernfs_remove(kn); |
608e266a2
|
244 |
|
324a56e16
|
245 |
kernfs_put(kn); |
1da177e4c
|
246 |
} |
d363bc53e
|
247 |
EXPORT_SYMBOL_GPL(sysfs_remove_group); |
1da177e4c
|
248 |
|
69d44ffbd
|
249 |
/** |
3e9b2bae8
|
250 251 |
* sysfs_remove_groups - remove a list of groups * |
f9ae443b5
|
252 253 |
* @kobj: The kobject for the groups to be removed from * @groups: NULL terminated list of groups to be removed |
3e9b2bae8
|
254 |
* |
09239ed4a
|
255 |
* If groups is not NULL, remove the specified groups from the kobject. |
3e9b2bae8
|
256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
*/ void sysfs_remove_groups(struct kobject *kobj, const struct attribute_group **groups) { int i; if (!groups) return; for (i = 0; groups[i]; i++) sysfs_remove_group(kobj, groups[i]); } EXPORT_SYMBOL_GPL(sysfs_remove_groups); /** |
69d44ffbd
|
270 271 272 273 274 275 276 277 278 279 280 |
* sysfs_merge_group - merge files into a pre-existing attribute group. * @kobj: The kobject containing the group. * @grp: The files to create and the attribute group they belong to. * * This function returns an error if the group doesn't exist or any of the * files already exist in that group, in which case none of the new files * are created. */ int sysfs_merge_group(struct kobject *kobj, const struct attribute_group *grp) { |
324a56e16
|
281 |
struct kernfs_node *parent; |
69d44ffbd
|
282 283 284 |
int error = 0; struct attribute *const *attr; int i; |
324a56e16
|
285 286 |
parent = kernfs_find_and_get(kobj->sd, grp->name); if (!parent) |
69d44ffbd
|
287 288 289 |
return -ENOENT; for ((i = 0, attr = grp->attrs); *attr && !error; (++i, ++attr)) |
324a56e16
|
290 |
error = sysfs_add_file(parent, *attr, false); |
69d44ffbd
|
291 292 |
if (error) { while (--i >= 0) |
324a56e16
|
293 |
kernfs_remove_by_name(parent, (*--attr)->name); |
69d44ffbd
|
294 |
} |
324a56e16
|
295 |
kernfs_put(parent); |
69d44ffbd
|
296 297 298 299 300 301 302 303 304 305 306 307 308 |
return error; } EXPORT_SYMBOL_GPL(sysfs_merge_group); /** * sysfs_unmerge_group - remove files from a pre-existing attribute group. * @kobj: The kobject containing the group. * @grp: The files to remove and the attribute group they belong to. */ void sysfs_unmerge_group(struct kobject *kobj, const struct attribute_group *grp) { |
324a56e16
|
309 |
struct kernfs_node *parent; |
69d44ffbd
|
310 |
struct attribute *const *attr; |
324a56e16
|
311 312 |
parent = kernfs_find_and_get(kobj->sd, grp->name); if (parent) { |
69d44ffbd
|
313 |
for (attr = grp->attrs; *attr; ++attr) |
324a56e16
|
314 315 |
kernfs_remove_by_name(parent, (*attr)->name); kernfs_put(parent); |
69d44ffbd
|
316 317 318 |
} } EXPORT_SYMBOL_GPL(sysfs_unmerge_group); |
0bb8f3d6a
|
319 320 321 322 323 324 325 326 327 328 |
/** * sysfs_add_link_to_group - add a symlink to an attribute group. * @kobj: The kobject containing the group. * @group_name: The name of the group. * @target: The target kobject of the symlink to create. * @link_name: The name of the symlink to create. */ int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name, struct kobject *target, const char *link_name) { |
324a56e16
|
329 |
struct kernfs_node *parent; |
0bb8f3d6a
|
330 |
int error = 0; |
324a56e16
|
331 332 |
parent = kernfs_find_and_get(kobj->sd, group_name); if (!parent) |
0bb8f3d6a
|
333 |
return -ENOENT; |
324a56e16
|
334 335 |
error = sysfs_create_link_sd(parent, target, link_name); kernfs_put(parent); |
0bb8f3d6a
|
336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
return error; } EXPORT_SYMBOL_GPL(sysfs_add_link_to_group); /** * sysfs_remove_link_from_group - remove a symlink from an attribute group. * @kobj: The kobject containing the group. * @group_name: The name of the group. * @link_name: The name of the symlink to remove. */ void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name, const char *link_name) { |
324a56e16
|
350 |
struct kernfs_node *parent; |
0bb8f3d6a
|
351 |
|
324a56e16
|
352 353 354 355 |
parent = kernfs_find_and_get(kobj->sd, group_name); if (parent) { kernfs_remove_by_name(parent, link_name); kernfs_put(parent); |
0bb8f3d6a
|
356 357 358 |
} } EXPORT_SYMBOL_GPL(sysfs_remove_link_from_group); |
37c1c04cc
|
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
/** * __compat_only_sysfs_link_entry_to_kobj - add a symlink to a kobject pointing * to a group or an attribute * @kobj: The kobject containing the group. * @target_kobj: The target kobject. * @target_name: The name of the target group or attribute. */ int __compat_only_sysfs_link_entry_to_kobj(struct kobject *kobj, struct kobject *target_kobj, const char *target_name) { struct kernfs_node *target; struct kernfs_node *entry; struct kernfs_node *link; /* * We don't own @target_kobj and it may be removed at any time. * Synchronize using sysfs_symlink_target_lock. See sysfs_remove_dir() * for details. */ spin_lock(&sysfs_symlink_target_lock); target = target_kobj->sd; if (target) kernfs_get(target); spin_unlock(&sysfs_symlink_target_lock); if (!target) return -ENOENT; entry = kernfs_find_and_get(target_kobj->sd, target_name); if (!entry) { kernfs_put(target); return -ENOENT; } link = kernfs_create_link(kobj->sd, target_name, entry); if (IS_ERR(link) && PTR_ERR(link) == -EEXIST) sysfs_warn_dup(kobj->sd, target_name); kernfs_put(entry); kernfs_put(target); return IS_ERR(link) ? PTR_ERR(link) : 0; } EXPORT_SYMBOL_GPL(__compat_only_sysfs_link_entry_to_kobj); |