]> Git Repo - linux.git/blame - fs/sysfs/file.c
Merge tag 'irqdomain-for-linus' of git://git.secretlab.ca/git/linux
[linux.git] / fs / sysfs / file.c
CommitLineData
1da177e4 1/*
6d66f5cd
TH
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 <[email protected]>
7 *
8 * This file is released under the GPLv2.
9 *
10 * Please see Documentation/filesystems/sysfs.txt for more information.
1da177e4
LT
11 */
12
13#include <linux/module.h>
1da177e4 14#include <linux/kobject.h>
815d2d50 15#include <linux/kallsyms.h>
c6f87733 16#include <linux/slab.h>
93265d13 17#include <linux/fsnotify.h>
5f45f1a7 18#include <linux/namei.h>
4508a7a7 19#include <linux/poll.h>
94bebf4d 20#include <linux/list.h>
52e8c209 21#include <linux/mutex.h>
ae87221d 22#include <linux/limits.h>
1da177e4 23#include <asm/uaccess.h>
1da177e4
LT
24
25#include "sysfs.h"
26
85a4ffad
TH
27/*
28 * There's one sysfs_buffer for each open file and one
29 * sysfs_open_dirent for each sysfs_dirent with one or more open
30 * files.
31 *
32 * filp->private_data points to sysfs_buffer and
33 * sysfs_dirent->s_attr.open points to sysfs_open_dirent. s_attr.open
34 * is protected by sysfs_open_dirent_lock.
35 */
d7b37889 36static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
85a4ffad
TH
37
38struct sysfs_open_dirent {
39 atomic_t refcnt;
a4e8b912
TH
40 atomic_t event;
41 wait_queue_head_t poll;
85a4ffad
TH
42 struct list_head buffers; /* goes through sysfs_buffer.list */
43};
44
73107cb3
TH
45struct sysfs_buffer {
46 size_t count;
47 loff_t pos;
48 char * page;
52cf25d0 49 const struct sysfs_ops * ops;
52e8c209 50 struct mutex mutex;
73107cb3
TH
51 int needs_read_fill;
52 int event;
85a4ffad 53 struct list_head list;
73107cb3 54};
1da177e4
LT
55
56/**
57 * fill_read_buffer - allocate and fill buffer from object.
58 * @dentry: dentry pointer.
59 * @buffer: data buffer for file.
60 *
61 * Allocate @buffer->page, if it hasn't been already, then call the
62 * kobject's show() method to fill the buffer with this attribute's
63 * data.
82244b16
ON
64 * This is called only once, on the file's first read unless an error
65 * is returned.
1da177e4
LT
66 */
67static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
68{
0ab66088 69 struct sysfs_dirent *attr_sd = dentry->d_fsdata;
b1fc3d61 70 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
52cf25d0 71 const struct sysfs_ops * ops = buffer->ops;
1da177e4
LT
72 int ret = 0;
73 ssize_t count;
74
75 if (!buffer->page)
76 buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
77 if (!buffer->page)
78 return -ENOMEM;
79
0ab66088 80 /* need attr_sd for attr and ops, its parent for kobj */
e72ceb8c 81 if (!sysfs_get_active(attr_sd))
0ab66088
TH
82 return -ENODEV;
83
a4e8b912 84 buffer->event = atomic_read(&attr_sd->s_attr.open->event);
b1fc3d61 85 count = ops->show(kobj, attr_sd->s_attr.attr, buffer->page);
0ab66088 86
e72ceb8c 87 sysfs_put_active(attr_sd);
0ab66088 88
8118a859
MX
89 /*
90 * The code works fine with PAGE_SIZE return but it's likely to
91 * indicate truncated result or overflow in normal use cases.
92 */
815d2d50
AM
93 if (count >= (ssize_t)PAGE_SIZE) {
94 print_symbol("fill_read_buffer: %s returned bad count\n",
95 (unsigned long)ops->show);
96 /* Try to struggle along */
97 count = PAGE_SIZE - 1;
98 }
82244b16
ON
99 if (count >= 0) {
100 buffer->needs_read_fill = 0;
1da177e4 101 buffer->count = count;
82244b16 102 } else {
1da177e4 103 ret = count;
82244b16 104 }
1da177e4
LT
105 return ret;
106}
107
1da177e4
LT
108/**
109 * sysfs_read_file - read an attribute.
110 * @file: file pointer.
111 * @buf: buffer to fill.
112 * @count: number of bytes to read.
113 * @ppos: starting offset in file.
114 *
115 * Userspace wants to read an attribute file. The attribute descriptor
116 * is in the file's ->d_fsdata. The target object is in the directory's
117 * ->d_fsdata.
118 *
119 * We call fill_read_buffer() to allocate and fill the buffer from the
120 * object's show() method exactly once (if the read is happening from
121 * the beginning of the file). That should fill the entire buffer with
122 * all the data the object has to offer for that attribute.
123 * We then call flush_read_buffer() to copy the buffer to userspace
124 * in the increments specified.
125 */
126
127static ssize_t
128sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
129{
130 struct sysfs_buffer * buffer = file->private_data;
131 ssize_t retval = 0;
132
52e8c209 133 mutex_lock(&buffer->mutex);
2424b5dd 134 if (buffer->needs_read_fill || *ppos == 0) {
73107cb3 135 retval = fill_read_buffer(file->f_path.dentry,buffer);
e7b0d26a 136 if (retval)
1da177e4
LT
137 goto out;
138 }
5c1fdf41 139 pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
8e24eea7 140 __func__, count, *ppos, buffer->page);
92f4c701
AM
141 retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
142 buffer->count);
1da177e4 143out:
52e8c209 144 mutex_unlock(&buffer->mutex);
1da177e4
LT
145 return retval;
146}
147
1da177e4
LT
148/**
149 * fill_write_buffer - copy buffer from userspace.
150 * @buffer: data buffer for file.
67be2dd1 151 * @buf: data from user.
1da177e4
LT
152 * @count: number of bytes in @userbuf.
153 *
154 * Allocate @buffer->page if it hasn't been already, then
155 * copy the user-supplied buffer into it.
156 */
157
158static int
159fill_write_buffer(struct sysfs_buffer * buffer, const char __user * buf, size_t count)
160{
161 int error;
162
163 if (!buffer->page)
164 buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
165 if (!buffer->page)
166 return -ENOMEM;
167
168 if (count >= PAGE_SIZE)
6e0dd741 169 count = PAGE_SIZE - 1;
1da177e4
LT
170 error = copy_from_user(buffer->page,buf,count);
171 buffer->needs_read_fill = 1;
035ed7a4
TM
172 /* if buf is assumed to contain a string, terminate it by \0,
173 so e.g. sscanf() can scan the string easily */
174 buffer->page[count] = 0;
1da177e4
LT
175 return error ? -EFAULT : count;
176}
177
178
179/**
180 * flush_write_buffer - push buffer to kobject.
3d41088f 181 * @dentry: dentry to the attribute
1da177e4 182 * @buffer: data buffer for file.
3d41088f 183 * @count: number of bytes
1da177e4
LT
184 *
185 * Get the correct pointers for the kobject and the attribute we're
186 * dealing with, then call the store() method for the attribute,
187 * passing the buffer that we acquired in fill_write_buffer().
188 */
189
0ab66088 190static int
1da177e4
LT
191flush_write_buffer(struct dentry * dentry, struct sysfs_buffer * buffer, size_t count)
192{
3e519038 193 struct sysfs_dirent *attr_sd = dentry->d_fsdata;
b1fc3d61 194 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
52cf25d0 195 const struct sysfs_ops * ops = buffer->ops;
0ab66088
TH
196 int rc;
197
198 /* need attr_sd for attr and ops, its parent for kobj */
e72ceb8c 199 if (!sysfs_get_active(attr_sd))
0ab66088
TH
200 return -ENODEV;
201
b1fc3d61 202 rc = ops->store(kobj, attr_sd->s_attr.attr, buffer->page, count);
0ab66088 203
e72ceb8c 204 sysfs_put_active(attr_sd);
1da177e4 205
0ab66088 206 return rc;
1da177e4
LT
207}
208
209
210/**
211 * sysfs_write_file - write an attribute.
212 * @file: file pointer
213 * @buf: data to write
214 * @count: number of bytes
215 * @ppos: starting offset
216 *
217 * Similar to sysfs_read_file(), though working in the opposite direction.
218 * We allocate and fill the data from the user in fill_write_buffer(),
219 * then push it to the kobject in flush_write_buffer().
220 * There is no easy way for us to know if userspace is only doing a partial
221 * write, so we don't support them. We expect the entire buffer to come
222 * on the first write.
223 * Hint: if you're writing a value, first read the file, modify only the
224 * the value you're changing, then write entire buffer back.
225 */
226
227static ssize_t
228sysfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
229{
230 struct sysfs_buffer * buffer = file->private_data;
231 ssize_t len;
232
52e8c209 233 mutex_lock(&buffer->mutex);
1da177e4
LT
234 len = fill_write_buffer(buffer, buf, count);
235 if (len > 0)
f427f5d5 236 len = flush_write_buffer(file->f_path.dentry, buffer, len);
1da177e4
LT
237 if (len > 0)
238 *ppos += len;
52e8c209 239 mutex_unlock(&buffer->mutex);
1da177e4
LT
240 return len;
241}
242
85a4ffad
TH
243/**
244 * sysfs_get_open_dirent - get or create sysfs_open_dirent
245 * @sd: target sysfs_dirent
246 * @buffer: sysfs_buffer for this instance of open
247 *
248 * If @sd->s_attr.open exists, increment its reference count;
249 * otherwise, create one. @buffer is chained to the buffers
250 * list.
251 *
252 * LOCKING:
253 * Kernel thread context (may sleep).
254 *
255 * RETURNS:
256 * 0 on success, -errno on failure.
257 */
258static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
259 struct sysfs_buffer *buffer)
260{
261 struct sysfs_open_dirent *od, *new_od = NULL;
262
263 retry:
83db93f4 264 spin_lock_irq(&sysfs_open_dirent_lock);
85a4ffad
TH
265
266 if (!sd->s_attr.open && new_od) {
267 sd->s_attr.open = new_od;
268 new_od = NULL;
269 }
270
271 od = sd->s_attr.open;
272 if (od) {
273 atomic_inc(&od->refcnt);
274 list_add_tail(&buffer->list, &od->buffers);
275 }
276
83db93f4 277 spin_unlock_irq(&sysfs_open_dirent_lock);
85a4ffad
TH
278
279 if (od) {
280 kfree(new_od);
281 return 0;
282 }
283
284 /* not there, initialize a new one and retry */
285 new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
286 if (!new_od)
287 return -ENOMEM;
288
289 atomic_set(&new_od->refcnt, 0);
a4e8b912
TH
290 atomic_set(&new_od->event, 1);
291 init_waitqueue_head(&new_od->poll);
85a4ffad
TH
292 INIT_LIST_HEAD(&new_od->buffers);
293 goto retry;
294}
295
296/**
297 * sysfs_put_open_dirent - put sysfs_open_dirent
298 * @sd: target sysfs_dirent
299 * @buffer: associated sysfs_buffer
300 *
301 * Put @sd->s_attr.open and unlink @buffer from the buffers list.
302 * If reference count reaches zero, disassociate and free it.
303 *
304 * LOCKING:
305 * None.
306 */
307static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
308 struct sysfs_buffer *buffer)
309{
310 struct sysfs_open_dirent *od = sd->s_attr.open;
83db93f4 311 unsigned long flags;
85a4ffad 312
83db93f4 313 spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
85a4ffad
TH
314
315 list_del(&buffer->list);
316 if (atomic_dec_and_test(&od->refcnt))
317 sd->s_attr.open = NULL;
318 else
319 od = NULL;
320
83db93f4 321 spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
85a4ffad
TH
322
323 kfree(od);
324}
325
94bebf4d 326static int sysfs_open_file(struct inode *inode, struct file *file)
1da177e4 327{
3e519038 328 struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
b1fc3d61 329 struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
000f2a4d 330 struct sysfs_buffer *buffer;
52cf25d0 331 const struct sysfs_ops *ops;
000f2a4d 332 int error = -EACCES;
1da177e4 333
0ab66088 334 /* need attr_sd for attr and ops, its parent for kobj */
e72ceb8c 335 if (!sysfs_get_active(attr_sd))
0ab66088 336 return -ENODEV;
1da177e4 337
000f2a4d
KS
338 /* every kobject with an attribute needs a ktype assigned */
339 if (kobj->ktype && kobj->ktype->sysfs_ops)
1da177e4 340 ops = kobj->ktype->sysfs_ops;
000f2a4d 341 else {
99fcd77d 342 WARN(1, KERN_ERR "missing sysfs attribute operations for "
000f2a4d 343 "kobject: %s\n", kobject_name(kobj));
7b595756 344 goto err_out;
000f2a4d 345 }
1da177e4
LT
346
347 /* File needs write support.
348 * The inode's perms must say it's ok,
349 * and we must have a store method.
350 */
351 if (file->f_mode & FMODE_WRITE) {
1da177e4 352 if (!(inode->i_mode & S_IWUGO) || !ops->store)
7b595756 353 goto err_out;
1da177e4
LT
354 }
355
356 /* File needs read support.
357 * The inode's perms must say it's ok, and we there
358 * must be a show method for it.
359 */
360 if (file->f_mode & FMODE_READ) {
361 if (!(inode->i_mode & S_IRUGO) || !ops->show)
7b595756 362 goto err_out;
1da177e4
LT
363 }
364
365 /* No error? Great, allocate a buffer for the file, and store it
366 * it in file->private_data for easy access.
367 */
0ab66088 368 error = -ENOMEM;
58d49283 369 buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
0ab66088 370 if (!buffer)
7b595756 371 goto err_out;
1da177e4 372
52e8c209 373 mutex_init(&buffer->mutex);
0ab66088
TH
374 buffer->needs_read_fill = 1;
375 buffer->ops = ops;
0ab66088
TH
376 file->private_data = buffer;
377
85a4ffad
TH
378 /* make sure we have open dirent struct */
379 error = sysfs_get_open_dirent(attr_sd, buffer);
380 if (error)
381 goto err_free;
382
b05f0548 383 /* open succeeded, put active references */
e72ceb8c 384 sysfs_put_active(attr_sd);
0ab66088
TH
385 return 0;
386
85a4ffad
TH
387 err_free:
388 kfree(buffer);
7b595756 389 err_out:
e72ceb8c 390 sysfs_put_active(attr_sd);
1da177e4
LT
391 return error;
392}
393
85a4ffad 394static int sysfs_release(struct inode *inode, struct file *filp)
1da177e4 395{
85a4ffad 396 struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
73107cb3 397 struct sysfs_buffer *buffer = filp->private_data;
1da177e4 398
85a4ffad
TH
399 sysfs_put_open_dirent(sd, buffer);
400
50ab1a72
TH
401 if (buffer->page)
402 free_page((unsigned long)buffer->page);
403 kfree(buffer);
404
1da177e4
LT
405 return 0;
406}
407
4508a7a7
N
408/* Sysfs attribute files are pollable. The idea is that you read
409 * the content and then you use 'poll' or 'select' to wait for
410 * the content to change. When the content changes (assuming the
411 * manager for the kobject supports notification), poll will
412 * return POLLERR|POLLPRI, and select will return the fd whether
413 * it is waiting for read, write, or exceptions.
414 * Once poll/select indicates that the value has changed, you
2424b5dd 415 * need to close and re-open the file, or seek to 0 and read again.
4508a7a7
N
416 * Reminder: this only works for attributes which actively support
417 * it, and it is not possible to test an attribute from userspace
a93720ee 418 * to see if it supports poll (Neither 'poll' nor 'select' return
4508a7a7
N
419 * an appropriate error code). When in doubt, set a suitable timeout value.
420 */
421static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
422{
423 struct sysfs_buffer * buffer = filp->private_data;
0ab66088 424 struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
a4e8b912 425 struct sysfs_open_dirent *od = attr_sd->s_attr.open;
0ab66088
TH
426
427 /* need parent for the kobj, grab both */
e72ceb8c 428 if (!sysfs_get_active(attr_sd))
0ab66088 429 goto trigger;
4508a7a7 430
a4e8b912 431 poll_wait(filp, &od->poll, wait);
4508a7a7 432
e72ceb8c 433 sysfs_put_active(attr_sd);
0ab66088 434
a4e8b912 435 if (buffer->event != atomic_read(&od->event))
0ab66088 436 goto trigger;
4508a7a7 437
1af3557a 438 return DEFAULT_POLLMASK;
0ab66088
TH
439
440 trigger:
441 buffer->needs_read_fill = 1;
1af3557a 442 return DEFAULT_POLLMASK|POLLERR|POLLPRI;
4508a7a7
N
443}
444
f1282c84
NB
445void sysfs_notify_dirent(struct sysfs_dirent *sd)
446{
447 struct sysfs_open_dirent *od;
83db93f4 448 unsigned long flags;
f1282c84 449
83db93f4 450 spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
f1282c84 451
fc60bb83
ND
452 if (!WARN_ON(sysfs_type(sd) != SYSFS_KOBJ_ATTR)) {
453 od = sd->s_attr.open;
454 if (od) {
455 atomic_inc(&od->event);
456 wake_up_interruptible(&od->poll);
457 }
f1282c84
NB
458 }
459
83db93f4 460 spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
f1282c84
NB
461}
462EXPORT_SYMBOL_GPL(sysfs_notify_dirent);
463
8c0e3998 464void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
4508a7a7 465{
51225039 466 struct sysfs_dirent *sd = k->sd;
4508a7a7 467
51225039
TH
468 mutex_lock(&sysfs_mutex);
469
470 if (sd && dir)
3ff195b0 471 sd = sysfs_find_dirent(sd, NULL, dir);
51225039 472 if (sd && attr)
3ff195b0 473 sd = sysfs_find_dirent(sd, NULL, attr);
f1282c84
NB
474 if (sd)
475 sysfs_notify_dirent(sd);
51225039
TH
476
477 mutex_unlock(&sysfs_mutex);
4508a7a7
N
478}
479EXPORT_SYMBOL_GPL(sysfs_notify);
480
4b6f5d20 481const struct file_operations sysfs_file_operations = {
1da177e4
LT
482 .read = sysfs_read_file,
483 .write = sysfs_write_file,
484 .llseek = generic_file_llseek,
485 .open = sysfs_open_file,
486 .release = sysfs_release,
4508a7a7 487 .poll = sysfs_poll,
1da177e4
LT
488};
489
1f20dfda
JT
490static int sysfs_attr_ns(struct kobject *kobj, const struct attribute *attr,
491 const void **pns)
487505c2
EB
492{
493 struct sysfs_dirent *dir_sd = kobj->sd;
494 const struct sysfs_ops *ops;
495 const void *ns = NULL;
496 int err;
497
ce597919
EB
498 if (!dir_sd) {
499 WARN(1, KERN_ERR "sysfs: kobject %s without dirent\n",
500 kobject_name(kobj));
501 return -ENOENT;
502 }
503
487505c2
EB
504 err = 0;
505 if (!sysfs_ns_type(dir_sd))
506 goto out;
507
508 err = -EINVAL;
509 if (!kobj->ktype)
510 goto out;
511 ops = kobj->ktype->sysfs_ops;
512 if (!ops)
513 goto out;
514 if (!ops->namespace)
515 goto out;
516
517 err = 0;
518 ns = ops->namespace(kobj, attr);
519out:
520 if (err) {
521 WARN(1, KERN_ERR "missing sysfs namespace attribute operation for "
522 "kobject: %s\n", kobject_name(kobj));
523 }
524 *pns = ns;
525 return err;
526}
527
0f423895 528int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
faef2b6c 529 const struct attribute *attr, int type, umode_t amode)
1da177e4 530{
0f423895 531 umode_t mode = (amode & S_IALLUGO) | S_IFREG;
fb6896da 532 struct sysfs_addrm_cxt acxt;
a26cd722 533 struct sysfs_dirent *sd;
487505c2 534 const void *ns;
23dc2799 535 int rc;
1da177e4 536
487505c2
EB
537 rc = sysfs_attr_ns(dir_sd->s_dir.kobj, attr, &ns);
538 if (rc)
539 return rc;
540
3007e997
TH
541 sd = sysfs_new_dirent(attr->name, mode, type);
542 if (!sd)
543 return -ENOMEM;
487505c2
EB
544
545 sd->s_ns = ns;
b1fc3d61 546 sd->s_attr.attr = (void *)attr;
a2db6842 547 sysfs_dirent_init_lockdep(sd);
1da177e4 548
fb6896da 549 sysfs_addrm_start(&acxt, dir_sd);
23dc2799
TH
550 rc = sysfs_add_one(&acxt, sd);
551 sysfs_addrm_finish(&acxt);
a26cd722 552
23dc2799 553 if (rc)
967e35dc 554 sysfs_put(sd);
3007e997 555
23dc2799 556 return rc;
1da177e4
LT
557}
558
559
0f423895
JB
560int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
561 int type)
562{
563 return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
564}
565
566
1da177e4
LT
567/**
568 * sysfs_create_file - create an attribute file for an object.
569 * @kobj: object we're creating for.
3932bf60 570 * @attr: attribute descriptor.
1da177e4
LT
571 */
572
573int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
574{
608e266a 575 BUG_ON(!kobj || !kobj->sd || !attr);
1da177e4 576
608e266a 577 return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
1da177e4
LT
578
579}
580
1c205ae1
AK
581int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
582{
583 int err = 0;
584 int i;
585
586 for (i = 0; ptr[i] && !err; i++)
587 err = sysfs_create_file(kobj, ptr[i]);
588 if (err)
589 while (--i >= 0)
590 sysfs_remove_file(kobj, ptr[i]);
591 return err;
592}
1da177e4 593
dfa87c82
AS
594/**
595 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
596 * @kobj: object we're acting for.
597 * @attr: attribute descriptor.
598 * @group: group name.
599 */
600int sysfs_add_file_to_group(struct kobject *kobj,
601 const struct attribute *attr, const char *group)
602{
608e266a 603 struct sysfs_dirent *dir_sd;
dfa87c82
AS
604 int error;
605
11f24fbd 606 if (group)
3ff195b0 607 dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
11f24fbd
JB
608 else
609 dir_sd = sysfs_get(kobj->sd);
610
608e266a
TH
611 if (!dir_sd)
612 return -ENOENT;
613
614 error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
615 sysfs_put(dir_sd);
616
dfa87c82
AS
617 return error;
618}
619EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
620
31e5abe9
KS
621/**
622 * sysfs_chmod_file - update the modified mode value on an object attribute.
623 * @kobj: object we're acting for.
624 * @attr: attribute descriptor.
625 * @mode: file permissions.
626 *
627 */
49c19400 628int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
48176a97 629 umode_t mode)
31e5abe9 630{
06fc0d66 631 struct sysfs_dirent *sd;
bc062b1b 632 struct iattr newattrs;
487505c2 633 const void *ns;
51225039
TH
634 int rc;
635
487505c2
EB
636 rc = sysfs_attr_ns(kobj, attr, &ns);
637 if (rc)
638 return rc;
639
06fc0d66 640 mutex_lock(&sysfs_mutex);
51225039 641
06fc0d66 642 rc = -ENOENT;
487505c2 643 sd = sysfs_find_dirent(kobj->sd, ns, attr->name);
06fc0d66 644 if (!sd)
51225039 645 goto out;
f88123ea 646
06fc0d66 647 newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
4c6974f5 648 newattrs.ia_valid = ATTR_MODE;
06fc0d66 649 rc = sysfs_sd_setattr(sd, &newattrs);
f88123ea 650
51225039 651 out:
06fc0d66 652 mutex_unlock(&sysfs_mutex);
51225039 653 return rc;
31e5abe9
KS
654}
655EXPORT_SYMBOL_GPL(sysfs_chmod_file);
656
657
1da177e4
LT
658/**
659 * sysfs_remove_file - remove an object attribute.
660 * @kobj: object we're acting for.
661 * @attr: attribute descriptor.
662 *
663 * Hash the attribute name and kill the victim.
664 */
665
666void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
667{
487505c2
EB
668 const void *ns;
669
670 if (sysfs_attr_ns(kobj, attr, &ns))
671 return;
672
673 sysfs_hash_and_remove(kobj->sd, ns, attr->name);
1da177e4
LT
674}
675
1c205ae1
AK
676void sysfs_remove_files(struct kobject * kobj, const struct attribute **ptr)
677{
678 int i;
679 for (i = 0; ptr[i]; i++)
680 sysfs_remove_file(kobj, ptr[i]);
681}
1da177e4 682
dfa87c82
AS
683/**
684 * sysfs_remove_file_from_group - remove an attribute file from a group.
685 * @kobj: object we're acting for.
686 * @attr: attribute descriptor.
687 * @group: group name.
688 */
689void sysfs_remove_file_from_group(struct kobject *kobj,
690 const struct attribute *attr, const char *group)
691{
608e266a 692 struct sysfs_dirent *dir_sd;
dfa87c82 693
11f24fbd 694 if (group)
3ff195b0 695 dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
11f24fbd
JB
696 else
697 dir_sd = sysfs_get(kobj->sd);
608e266a 698 if (dir_sd) {
3ff195b0 699 sysfs_hash_and_remove(dir_sd, NULL, attr->name);
608e266a 700 sysfs_put(dir_sd);
dfa87c82
AS
701 }
702}
703EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
704
d9a9cdfb 705struct sysfs_schedule_callback_struct {
66942064
AC
706 struct list_head workq_list;
707 struct kobject *kobj;
d9a9cdfb
AS
708 void (*func)(void *);
709 void *data;
523ded71 710 struct module *owner;
d9a9cdfb
AS
711 struct work_struct work;
712};
713
d110271e 714static struct workqueue_struct *sysfs_workqueue;
66942064
AC
715static DEFINE_MUTEX(sysfs_workq_mutex);
716static LIST_HEAD(sysfs_workq);
d9a9cdfb
AS
717static void sysfs_schedule_callback_work(struct work_struct *work)
718{
719 struct sysfs_schedule_callback_struct *ss = container_of(work,
720 struct sysfs_schedule_callback_struct, work);
721
722 (ss->func)(ss->data);
723 kobject_put(ss->kobj);
523ded71 724 module_put(ss->owner);
66942064
AC
725 mutex_lock(&sysfs_workq_mutex);
726 list_del(&ss->workq_list);
727 mutex_unlock(&sysfs_workq_mutex);
d9a9cdfb
AS
728 kfree(ss);
729}
730
731/**
732 * sysfs_schedule_callback - helper to schedule a callback for a kobject
733 * @kobj: object we're acting for.
734 * @func: callback function to invoke later.
735 * @data: argument to pass to @func.
523ded71 736 * @owner: module owning the callback code
d9a9cdfb
AS
737 *
738 * sysfs attribute methods must not unregister themselves or their parent
739 * kobject (which would amount to the same thing). Attempts to do so will
740 * deadlock, since unregistration is mutually exclusive with driver
741 * callbacks.
742 *
743 * Instead methods can call this routine, which will attempt to allocate
744 * and schedule a workqueue request to call back @func with @data as its
745 * argument in the workqueue's process context. @kobj will be pinned
746 * until @func returns.
747 *
748 * Returns 0 if the request was submitted, -ENOMEM if storage could not
66942064
AC
749 * be allocated, -ENODEV if a reference to @owner isn't available,
750 * -EAGAIN if a callback has already been scheduled for @kobj.
d9a9cdfb
AS
751 */
752int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
523ded71 753 void *data, struct module *owner)
d9a9cdfb 754{
66942064 755 struct sysfs_schedule_callback_struct *ss, *tmp;
d9a9cdfb 756
523ded71
AS
757 if (!try_module_get(owner))
758 return -ENODEV;
66942064
AC
759
760 mutex_lock(&sysfs_workq_mutex);
761 list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
762 if (ss->kobj == kobj) {
d110271e 763 module_put(owner);
66942064
AC
764 mutex_unlock(&sysfs_workq_mutex);
765 return -EAGAIN;
766 }
767 mutex_unlock(&sysfs_workq_mutex);
768
d110271e 769 if (sysfs_workqueue == NULL) {
086a377e 770 sysfs_workqueue = create_singlethread_workqueue("sysfsd");
d110271e
AC
771 if (sysfs_workqueue == NULL) {
772 module_put(owner);
773 return -ENOMEM;
774 }
775 }
776
d9a9cdfb 777 ss = kmalloc(sizeof(*ss), GFP_KERNEL);
523ded71
AS
778 if (!ss) {
779 module_put(owner);
d9a9cdfb 780 return -ENOMEM;
523ded71 781 }
d9a9cdfb
AS
782 kobject_get(kobj);
783 ss->kobj = kobj;
784 ss->func = func;
785 ss->data = data;
523ded71 786 ss->owner = owner;
d9a9cdfb 787 INIT_WORK(&ss->work, sysfs_schedule_callback_work);
66942064
AC
788 INIT_LIST_HEAD(&ss->workq_list);
789 mutex_lock(&sysfs_workq_mutex);
790 list_add_tail(&ss->workq_list, &sysfs_workq);
791 mutex_unlock(&sysfs_workq_mutex);
d110271e 792 queue_work(sysfs_workqueue, &ss->work);
d9a9cdfb
AS
793 return 0;
794}
795EXPORT_SYMBOL_GPL(sysfs_schedule_callback);
796
dfa87c82 797
1da177e4
LT
798EXPORT_SYMBOL_GPL(sysfs_create_file);
799EXPORT_SYMBOL_GPL(sysfs_remove_file);
1c205ae1
AK
800EXPORT_SYMBOL_GPL(sysfs_remove_files);
801EXPORT_SYMBOL_GPL(sysfs_create_files);
This page took 0.862431 seconds and 4 git commands to generate.