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