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