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