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