group.c 9.31 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
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
6
7
 * Copyright (c) 2013 Greg Kroah-Hartman
 * Copyright (c) 2013 The Linux Foundation
Linus Torvalds's avatar
Linus Torvalds committed
8
 *
9
 * This file is released undert the GPL v2.
Linus Torvalds's avatar
Linus Torvalds committed
10
11
12
13
14
15
 *
 */

#include <linux/kobject.h>
#include <linux/module.h>
#include <linux/dcache.h>
16
#include <linux/namei.h>
Linus Torvalds's avatar
Linus Torvalds committed
17
18
19
20
#include <linux/err.h>
#include "sysfs.h"


21
static void remove_files(struct sysfs_dirent *dir_sd, struct kobject *kobj,
22
			 const struct attribute_group *grp)
Linus Torvalds's avatar
Linus Torvalds committed
23
{
24
25
	struct attribute *const *attr;
	struct bin_attribute *const *bin_attr;
Linus Torvalds's avatar
Linus Torvalds committed
26

27
28
	if (grp->attrs)
		for (attr = grp->attrs; *attr; attr++)
Tejun Heo's avatar
Tejun Heo committed
29
			sysfs_hash_and_remove(dir_sd, (*attr)->name, NULL);
30
31
32
	if (grp->bin_attrs)
		for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++)
			sysfs_remove_bin_file(kobj, *bin_attr);
Linus Torvalds's avatar
Linus Torvalds committed
33
34
}

35
static int create_files(struct sysfs_dirent *dir_sd, struct kobject *kobj,
36
			const struct attribute_group *grp, int update)
Linus Torvalds's avatar
Linus Torvalds committed
37
{
38
39
	struct attribute *const *attr;
	struct bin_attribute *const *bin_attr;
40
	int error = 0, i;
Linus Torvalds's avatar
Linus Torvalds committed
41

42
43
44
	if (grp->attrs) {
		for (i = 0, attr = grp->attrs; *attr && !error; i++, attr++) {
			umode_t mode = 0;
45

46
47
48
49
50
51
			/*
			 * In update mode, we're changing the permissions or
			 * visibility.  Do this by first removing then
			 * re-adding (if required) the file.
			 */
			if (update)
Tejun Heo's avatar
Tejun Heo committed
52
53
				sysfs_hash_and_remove(dir_sd, (*attr)->name,
						      NULL);
54
55
56
57
58
			if (grp->is_visible) {
				mode = grp->is_visible(kobj, *attr, i);
				if (!mode)
					continue;
			}
59
60
61
62
			error = sysfs_add_file_mode_ns(dir_sd, *attr,
						       SYSFS_KOBJ_ATTR,
						       (*attr)->mode | mode,
						       NULL);
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
			if (unlikely(error))
				break;
		}
		if (error) {
			remove_files(dir_sd, kobj, grp);
			goto exit;
		}
	}

	if (grp->bin_attrs) {
		for (bin_attr = grp->bin_attrs; *bin_attr; bin_attr++) {
			if (update)
				sysfs_remove_bin_file(kobj, *bin_attr);
			error = sysfs_create_bin_file(kobj, *bin_attr);
			if (error)
				break;
79
		}
80
81
		if (error)
			remove_files(dir_sd, kobj, grp);
82
	}
83
exit:
Linus Torvalds's avatar
Linus Torvalds committed
84
85
86
87
	return error;
}


88
89
static int internal_create_group(struct kobject *kobj, int update,
				 const struct attribute_group *grp)
Linus Torvalds's avatar
Linus Torvalds committed
90
{
91
	struct sysfs_dirent *sd;
Linus Torvalds's avatar
Linus Torvalds committed
92
93
	int error;

94
95
96
97
98
	BUG_ON(!kobj || (!update && !kobj->sd));

	/* Updates may happen before the object has been instantiated */
	if (unlikely(update && !kobj->sd))
		return -EINVAL;
99
100
	if (!grp->attrs && !grp->bin_attrs) {
		WARN(1, "sysfs: (bin_)attrs not set by subsystem for group: %s/%s\n",
101
102
103
			kobj->name, grp->name ? "" : grp->name);
		return -EINVAL;
	}
Linus Torvalds's avatar
Linus Torvalds committed
104
	if (grp->name) {
105
		error = sysfs_create_subdir(kobj, grp->name, &sd);
Linus Torvalds's avatar
Linus Torvalds committed
106
107
108
		if (error)
			return error;
	} else
109
110
		sd = kobj->sd;
	sysfs_get(sd);
111
	error = create_files(sd, kobj, grp, update);
112
	if (error) {
Linus Torvalds's avatar
Linus Torvalds committed
113
		if (grp->name)
114
			sysfs_remove(sd);
Linus Torvalds's avatar
Linus Torvalds committed
115
	}
116
	sysfs_put(sd);
Linus Torvalds's avatar
Linus Torvalds committed
117
118
119
	return error;
}

120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/**
 * 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.
 *
 * Returns 0 on success or error.
 */
int sysfs_create_group(struct kobject *kobj,
		       const struct attribute_group *grp)
{
	return internal_create_group(kobj, 0, grp);
}
135
EXPORT_SYMBOL_GPL(sysfs_create_group);
136

137
138
139
140
141
142
143
144
145
146
147
/**
 * 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.
 *
148
 * Returns 0 on success or error code from sysfs_create_group on error.
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 */
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);

171
/**
172
173
174
 * 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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 *
 * 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.
 *
 * Returns 0 on success or error.
 */
int sysfs_update_group(struct kobject *kobj,
		       const struct attribute_group *grp)
{
	return internal_create_group(kobj, 1, grp);
}
193
EXPORT_SYMBOL_GPL(sysfs_update_group);
194

195
196
197
198
199
200
201
202
/**
 * 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.
 */
203
204
void sysfs_remove_group(struct kobject *kobj,
			const struct attribute_group *grp)
Linus Torvalds's avatar
Linus Torvalds committed
205
{
206
207
	struct sysfs_dirent *dir_sd = kobj->sd;
	struct sysfs_dirent *sd;
Linus Torvalds's avatar
Linus Torvalds committed
208

209
210
211
212
213
214
215
216
217
	/*
	 * Sysfs directories are now removed recursively by
	 * sysfs_remove_dir(). This means that the function can be called
	 * for a group whose sysfs entry is already removed. In that case
	 * all its groups are guaranteed to be already removed.
	 */
	if (dir_sd->s_flags & SYSFS_FLAG_REMOVED)
		return;

218
	if (grp->name) {
Tejun Heo's avatar
Tejun Heo committed
219
		sd = sysfs_get_dirent(dir_sd, grp->name);
220
		if (!sd) {
221
222
223
			WARN(!sd, KERN_WARNING
			     "sysfs group %p not found for kobject '%s'\n",
			     grp, kobject_name(kobj));
224
225
			return;
		}
226
227
	} else
		sd = sysfs_get(dir_sd);
Linus Torvalds's avatar
Linus Torvalds committed
228

229
	remove_files(sd, kobj, grp);
Linus Torvalds's avatar
Linus Torvalds committed
230
	if (grp->name)
231
		sysfs_remove(sd);
232
233

	sysfs_put(sd);
Linus Torvalds's avatar
Linus Torvalds committed
234
}
235
EXPORT_SYMBOL_GPL(sysfs_remove_group);
Linus Torvalds's avatar
Linus Torvalds committed
236

237
238
239
/**
 * sysfs_remove_groups - remove a list of groups
 *
240
241
 * @kobj:	The kobject for the groups to be removed from
 * @groups:	NULL terminated list of groups to be removed
242
 *
243
 * If groups is not NULL, remove the specified groups from the kobject.
244
245
246
247
248
249
250
251
252
253
254
255
256
 */
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);

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
/**
 * 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)
{
	struct sysfs_dirent *dir_sd;
	int error = 0;
	struct attribute *const *attr;
	int i;

Tejun Heo's avatar
Tejun Heo committed
274
	dir_sd = sysfs_get_dirent(kobj->sd, grp->name);
275
276
277
278
279
280
281
	if (!dir_sd)
		return -ENOENT;

	for ((i = 0, attr = grp->attrs); *attr && !error; (++i, ++attr))
		error = sysfs_add_file(dir_sd, *attr, SYSFS_KOBJ_ATTR);
	if (error) {
		while (--i >= 0)
Tejun Heo's avatar
Tejun Heo committed
282
			sysfs_hash_and_remove(dir_sd, (*--attr)->name, NULL);
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
	}
	sysfs_put(dir_sd);

	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)
{
	struct sysfs_dirent *dir_sd;
	struct attribute *const *attr;

Tejun Heo's avatar
Tejun Heo committed
301
	dir_sd = sysfs_get_dirent(kobj->sd, grp->name);
302
303
	if (dir_sd) {
		for (attr = grp->attrs; *attr; ++attr)
Tejun Heo's avatar
Tejun Heo committed
304
			sysfs_hash_and_remove(dir_sd, (*attr)->name, NULL);
305
306
307
308
309
		sysfs_put(dir_sd);
	}
}
EXPORT_SYMBOL_GPL(sysfs_unmerge_group);

310
311
312
313
314
315
316
317
318
319
320
321
322
/**
 * 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)
{
	struct sysfs_dirent *dir_sd;
	int error = 0;

Tejun Heo's avatar
Tejun Heo committed
323
	dir_sd = sysfs_get_dirent(kobj->sd, group_name);
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
	if (!dir_sd)
		return -ENOENT;

	error = sysfs_create_link_sd(dir_sd, target, link_name);
	sysfs_put(dir_sd);

	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)
{
	struct sysfs_dirent *dir_sd;

Tejun Heo's avatar
Tejun Heo committed
345
	dir_sd = sysfs_get_dirent(kobj->sd, group_name);
346
	if (dir_sd) {
Tejun Heo's avatar
Tejun Heo committed
347
		sysfs_hash_and_remove(dir_sd, link_name, NULL);
348
349
350
351
		sysfs_put(dir_sd);
	}
}
EXPORT_SYMBOL_GPL(sysfs_remove_link_from_group);