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