file.c 19.8 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
T
Tejun Heo 已提交
2 3 4 5 6 7 8 9 10
 * fs/sysfs/file.c - sysfs regular (text) file implementation
 *
 * Copyright (c) 2001-3 Patrick Mochel
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
 *
 * This file is released under the GPLv2.
 *
 * Please see Documentation/filesystems/sysfs.txt for more information.
L
Linus Torvalds 已提交
11 12 13 14
 */

#include <linux/module.h>
#include <linux/kobject.h>
15
#include <linux/kallsyms.h>
16
#include <linux/slab.h>
M
Miklos Szeredi 已提交
17
#include <linux/fsnotify.h>
18
#include <linux/namei.h>
19
#include <linux/poll.h>
20
#include <linux/list.h>
21
#include <linux/mutex.h>
A
Andrew Morton 已提交
22
#include <linux/limits.h>
L
Linus Torvalds 已提交
23 24 25 26
#include <asm/uaccess.h>

#include "sysfs.h"

T
Tejun Heo 已提交
27 28 29 30 31 32 33 34 35
/*
 * There's one sysfs_buffer for each open file and one
 * sysfs_open_dirent for each sysfs_dirent with one or more open
 * files.
 *
 * filp->private_data points to sysfs_buffer and
 * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open
 * is protected by sysfs_open_dirent_lock.
 */
J
Jiri Slaby 已提交
36
static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
T
Tejun Heo 已提交
37 38 39

struct sysfs_open_dirent {
	atomic_t		refcnt;
40 41
	atomic_t		event;
	wait_queue_head_t	poll;
T
Tejun Heo 已提交
42 43 44
	struct list_head	buffers; /* goes through sysfs_buffer.list */
};

T
Tejun Heo 已提交
45 46 47
struct sysfs_buffer {
	size_t			count;
	loff_t			pos;
48 49
	char			*page;
	const struct sysfs_ops	*ops;
50
	struct mutex		mutex;
T
Tejun Heo 已提交
51 52
	int			needs_read_fill;
	int			event;
T
Tejun Heo 已提交
53
	struct list_head	list;
T
Tejun Heo 已提交
54
};
L
Linus Torvalds 已提交
55 56 57 58 59 60 61

/**
 *	fill_read_buffer - allocate and fill buffer from object.
 *	@dentry:	dentry pointer.
 *	@buffer:	data buffer for file.
 *
 *	Allocate @buffer->page, if it hasn't been already, then call the
62 63
 *	kobject's show() method to fill the buffer with this attribute's
 *	data.
64 65
 *	This is called only once, on the file's first read unless an error
 *	is returned.
L
Linus Torvalds 已提交
66
 */
67
static int fill_read_buffer(struct dentry *dentry, struct sysfs_buffer *buffer)
L
Linus Torvalds 已提交
68
{
69
	struct sysfs_dirent *attr_sd = dentry->d_fsdata;
T
Tejun Heo 已提交
70
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
71
	const struct sysfs_ops *ops = buffer->ops;
L
Linus Torvalds 已提交
72 73 74 75 76 77 78 79
	int ret = 0;
	ssize_t count;

	if (!buffer->page)
		buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
	if (!buffer->page)
		return -ENOMEM;

80
	/* need attr_sd for attr and ops, its parent for kobj */
81
	if (!sysfs_get_active(attr_sd))
82 83
		return -ENODEV;

84
	buffer->event = atomic_read(&attr_sd->s_attr.open->event);
T
Tejun Heo 已提交
85
	count = ops->show(kobj, attr_sd->s_attr.attr, buffer->page);
86

87
	sysfs_put_active(attr_sd);
88

89 90 91 92
	/*
	 * The code works fine with PAGE_SIZE return but it's likely to
	 * indicate truncated result or overflow in normal use cases.
	 */
93 94 95 96 97 98
	if (count >= (ssize_t)PAGE_SIZE) {
		print_symbol("fill_read_buffer: %s returned bad count\n",
			(unsigned long)ops->show);
		/* Try to struggle along */
		count = PAGE_SIZE - 1;
	}
99 100
	if (count >= 0) {
		buffer->needs_read_fill = 0;
L
Linus Torvalds 已提交
101
		buffer->count = count;
102
	} else {
L
Linus Torvalds 已提交
103
		ret = count;
104
	}
L
Linus Torvalds 已提交
105 106 107 108
	return ret;
}

/**
109
 *	sysfs_read_file - read an attribute.
L
Linus Torvalds 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
 *	@file:	file pointer.
 *	@buf:	buffer to fill.
 *	@count:	number of bytes to read.
 *	@ppos:	starting offset in file.
 *
 *	Userspace wants to read an attribute file. The attribute descriptor
 *	is in the file's ->d_fsdata. The target object is in the directory's
 *	->d_fsdata.
 *
 *	We call fill_read_buffer() to allocate and fill the buffer from the
 *	object's show() method exactly once (if the read is happening from
 *	the beginning of the file). That should fill the entire buffer with
 *	all the data the object has to offer for that attribute.
 *	We then call flush_read_buffer() to copy the buffer to userspace
 *	in the increments specified.
 */

static ssize_t
sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
{
130
	struct sysfs_buffer *buffer = file->private_data;
L
Linus Torvalds 已提交
131 132
	ssize_t retval = 0;

133
	mutex_lock(&buffer->mutex);
134
	if (buffer->needs_read_fill || *ppos == 0) {
135
		retval = fill_read_buffer(file->f_path.dentry, buffer);
136
		if (retval)
L
Linus Torvalds 已提交
137 138
			goto out;
	}
139
	pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
140
		 __func__, count, *ppos, buffer->page);
141 142
	retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
					 buffer->count);
L
Linus Torvalds 已提交
143
out:
144
	mutex_unlock(&buffer->mutex);
L
Linus Torvalds 已提交
145 146 147 148 149 150
	return retval;
}

/**
 *	fill_write_buffer - copy buffer from userspace.
 *	@buffer:	data buffer for file.
151
 *	@buf:		data from user.
L
Linus Torvalds 已提交
152 153 154 155 156
 *	@count:		number of bytes in @userbuf.
 *
 *	Allocate @buffer->page if it hasn't been already, then
 *	copy the user-supplied buffer into it.
 */
157 158
static int fill_write_buffer(struct sysfs_buffer *buffer,
			     const char __user *buf, size_t count)
L
Linus Torvalds 已提交
159 160 161 162 163 164 165 166 167
{
	int error;

	if (!buffer->page)
		buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
	if (!buffer->page)
		return -ENOMEM;

	if (count >= PAGE_SIZE)
168
		count = PAGE_SIZE - 1;
169
	error = copy_from_user(buffer->page, buf, count);
L
Linus Torvalds 已提交
170
	buffer->needs_read_fill = 1;
171 172 173
	/* if buf is assumed to contain a string, terminate it by \0,
	   so e.g. sscanf() can scan the string easily */
	buffer->page[count] = 0;
L
Linus Torvalds 已提交
174 175 176 177 178 179
	return error ? -EFAULT : count;
}


/**
 *	flush_write_buffer - push buffer to kobject.
M
Martin Waitz 已提交
180
 *	@dentry:	dentry to the attribute
L
Linus Torvalds 已提交
181
 *	@buffer:	data buffer for file.
M
Martin Waitz 已提交
182
 *	@count:		number of bytes
L
Linus Torvalds 已提交
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,
L
Linus Torvalds 已提交
186 187
 *	passing the buffer that we acquired in fill_write_buffer().
 */
188 189
static int flush_write_buffer(struct dentry *dentry,
			      struct sysfs_buffer *buffer, size_t count)
L
Linus Torvalds 已提交
190
{
191
	struct sysfs_dirent *attr_sd = dentry->d_fsdata;
T
Tejun Heo 已提交
192
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
193
	const struct sysfs_ops *ops = buffer->ops;
194 195 196
	int rc;

	/* need attr_sd for attr and ops, its parent for kobj */
197
	if (!sysfs_get_active(attr_sd))
198 199
		return -ENODEV;

T
Tejun Heo 已提交
200
	rc = ops->store(kobj, attr_sd->s_attr.attr, buffer->page, count);
201

202
	sysfs_put_active(attr_sd);
L
Linus Torvalds 已提交
203

204
	return rc;
L
Linus Torvalds 已提交
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
}


/**
 *	sysfs_write_file - write an attribute.
 *	@file:	file pointer
 *	@buf:	data to write
 *	@count:	number of bytes
 *	@ppos:	starting offset
 *
 *	Similar to sysfs_read_file(), though working in the opposite direction.
 *	We allocate and fill the data from the user in fill_write_buffer(),
 *	then push it to the kobject in flush_write_buffer().
 *	There is no easy way for us to know if userspace is only doing a partial
 *	write, so we don't support them. We expect the entire buffer to come
220
 *	on the first write.
L
Linus Torvalds 已提交
221
 *	Hint: if you're writing a value, first read the file, modify only the
222
 *	the value you're changing, then write entire buffer back.
L
Linus Torvalds 已提交
223
 */
224 225
static ssize_t sysfs_write_file(struct file *file, const char __user *buf,
				size_t count, loff_t *ppos)
L
Linus Torvalds 已提交
226
{
227
	struct sysfs_buffer *buffer = file->private_data;
L
Linus Torvalds 已提交
228 229
	ssize_t len;

230
	mutex_lock(&buffer->mutex);
L
Linus Torvalds 已提交
231 232
	len = fill_write_buffer(buffer, buf, count);
	if (len > 0)
233
		len = flush_write_buffer(file->f_path.dentry, buffer, len);
L
Linus Torvalds 已提交
234 235
	if (len > 0)
		*ppos += len;
236
	mutex_unlock(&buffer->mutex);
L
Linus Torvalds 已提交
237 238 239
	return len;
}

T
Tejun Heo 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
/**
 *	sysfs_get_open_dirent - get or create sysfs_open_dirent
 *	@sd: target sysfs_dirent
 *	@buffer: sysfs_buffer for this instance of open
 *
 *	If @sd->s_attr.open exists, increment its reference count;
 *	otherwise, create one.  @buffer is chained to the buffers
 *	list.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	0 on success, -errno on failure.
 */
static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
				 struct sysfs_buffer *buffer)
{
	struct sysfs_open_dirent *od, *new_od = NULL;

 retry:
261
	spin_lock_irq(&sysfs_open_dirent_lock);
T
Tejun Heo 已提交
262 263 264 265 266 267 268 269 270 271 272 273

	if (!sd->s_attr.open && new_od) {
		sd->s_attr.open = new_od;
		new_od = NULL;
	}

	od = sd->s_attr.open;
	if (od) {
		atomic_inc(&od->refcnt);
		list_add_tail(&buffer->list, &od->buffers);
	}

274
	spin_unlock_irq(&sysfs_open_dirent_lock);
T
Tejun Heo 已提交
275 276 277 278 279 280 281 282 283 284 285 286

	if (od) {
		kfree(new_od);
		return 0;
	}

	/* not there, initialize a new one and retry */
	new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
	if (!new_od)
		return -ENOMEM;

	atomic_set(&new_od->refcnt, 0);
287 288
	atomic_set(&new_od->event, 1);
	init_waitqueue_head(&new_od->poll);
T
Tejun Heo 已提交
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
	INIT_LIST_HEAD(&new_od->buffers);
	goto retry;
}

/**
 *	sysfs_put_open_dirent - put sysfs_open_dirent
 *	@sd: target sysfs_dirent
 *	@buffer: associated sysfs_buffer
 *
 *	Put @sd->s_attr.open and unlink @buffer from the buffers list.
 *	If reference count reaches zero, disassociate and free it.
 *
 *	LOCKING:
 *	None.
 */
static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
				  struct sysfs_buffer *buffer)
{
	struct sysfs_open_dirent *od = sd->s_attr.open;
308
	unsigned long flags;
T
Tejun Heo 已提交
309

310
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
T
Tejun Heo 已提交
311 312 313 314 315 316 317

	list_del(&buffer->list);
	if (atomic_dec_and_test(&od->refcnt))
		sd->s_attr.open = NULL;
	else
		od = NULL;

318
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
T
Tejun Heo 已提交
319 320 321 322

	kfree(od);
}

323
static int sysfs_open_file(struct inode *inode, struct file *file)
L
Linus Torvalds 已提交
324
{
325
	struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
T
Tejun Heo 已提交
326
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
327
	struct sysfs_buffer *buffer;
328
	const struct sysfs_ops *ops;
329
	int error = -EACCES;
L
Linus Torvalds 已提交
330

331
	/* need attr_sd for attr and ops, its parent for kobj */
332
	if (!sysfs_get_active(attr_sd))
333
		return -ENODEV;
L
Linus Torvalds 已提交
334

335 336
	/* every kobject with an attribute needs a ktype assigned */
	if (kobj->ktype && kobj->ktype->sysfs_ops)
L
Linus Torvalds 已提交
337
		ops = kobj->ktype->sysfs_ops;
338
	else {
A
Arjan van de Ven 已提交
339
		WARN(1, KERN_ERR "missing sysfs attribute operations for "
340
		       "kobject: %s\n", kobject_name(kobj));
341
		goto err_out;
342
	}
L
Linus Torvalds 已提交
343 344

	/* File needs write support.
345
	 * The inode's perms must say it's ok,
L
Linus Torvalds 已提交
346 347 348 349
	 * and we must have a store method.
	 */
	if (file->f_mode & FMODE_WRITE) {
		if (!(inode->i_mode & S_IWUGO) || !ops->store)
350
			goto err_out;
L
Linus Torvalds 已提交
351 352 353 354 355 356 357 358
	}

	/* File needs read support.
	 * The inode's perms must say it's ok, and we there
	 * must be a show method for it.
	 */
	if (file->f_mode & FMODE_READ) {
		if (!(inode->i_mode & S_IRUGO) || !ops->show)
359
			goto err_out;
L
Linus Torvalds 已提交
360 361 362 363 364
	}

	/* No error? Great, allocate a buffer for the file, and store it
	 * it in file->private_data for easy access.
	 */
365
	error = -ENOMEM;
366
	buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
367
	if (!buffer)
368
		goto err_out;
L
Linus Torvalds 已提交
369

370
	mutex_init(&buffer->mutex);
371 372 373 374
	buffer->needs_read_fill = 1;
	buffer->ops = ops;
	file->private_data = buffer;

T
Tejun Heo 已提交
375 376 377 378 379
	/* make sure we have open dirent struct */
	error = sysfs_get_open_dirent(attr_sd, buffer);
	if (error)
		goto err_free;

380
	/* open succeeded, put active references */
381
	sysfs_put_active(attr_sd);
382 383
	return 0;

T
Tejun Heo 已提交
384 385
 err_free:
	kfree(buffer);
386
 err_out:
387
	sysfs_put_active(attr_sd);
L
Linus Torvalds 已提交
388 389 390
	return error;
}

T
Tejun Heo 已提交
391
static int sysfs_release(struct inode *inode, struct file *filp)
L
Linus Torvalds 已提交
392
{
T
Tejun Heo 已提交
393
	struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
T
Tejun Heo 已提交
394
	struct sysfs_buffer *buffer = filp->private_data;
L
Linus Torvalds 已提交
395

T
Tejun Heo 已提交
396 397
	sysfs_put_open_dirent(sd, buffer);

398 399 400 401
	if (buffer->page)
		free_page((unsigned long)buffer->page);
	kfree(buffer);

L
Linus Torvalds 已提交
402 403 404
	return 0;
}

405 406 407 408 409 410 411
/* Sysfs attribute files are pollable.  The idea is that you read
 * the content and then you use 'poll' or 'select' to wait for
 * the content to change.  When the content changes (assuming the
 * manager for the kobject supports notification), poll will
 * return POLLERR|POLLPRI, and select will return the fd whether
 * it is waiting for read, write, or exceptions.
 * Once poll/select indicates that the value has changed, you
412
 * need to close and re-open the file, or seek to 0 and read again.
413 414
 * Reminder: this only works for attributes which actively support
 * it, and it is not possible to test an attribute from userspace
415
 * to see if it supports poll (Neither 'poll' nor 'select' return
416 417 418 419
 * an appropriate error code).  When in doubt, set a suitable timeout value.
 */
static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
{
420
	struct sysfs_buffer *buffer = filp->private_data;
421
	struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
422
	struct sysfs_open_dirent *od = attr_sd->s_attr.open;
423 424

	/* need parent for the kobj, grab both */
425
	if (!sysfs_get_active(attr_sd))
426
		goto trigger;
427

428
	poll_wait(filp, &od->poll, wait);
429

430
	sysfs_put_active(attr_sd);
431

432
	if (buffer->event != atomic_read(&od->event))
433
		goto trigger;
434

435
	return DEFAULT_POLLMASK;
436 437 438

 trigger:
	buffer->needs_read_fill = 1;
439
	return DEFAULT_POLLMASK|POLLERR|POLLPRI;
440 441
}

442 443 444
void sysfs_notify_dirent(struct sysfs_dirent *sd)
{
	struct sysfs_open_dirent *od;
445
	unsigned long flags;
446

447
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
448

449 450 451 452 453 454
	if (!WARN_ON(sysfs_type(sd) != SYSFS_KOBJ_ATTR)) {
		od = sd->s_attr.open;
		if (od) {
			atomic_inc(&od->event);
			wake_up_interruptible(&od->poll);
		}
455 456
	}

457
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
458 459 460
}
EXPORT_SYMBOL_GPL(sysfs_notify_dirent);

461
void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
462
{
463
	struct sysfs_dirent *sd = k->sd;
464

465 466 467
	mutex_lock(&sysfs_mutex);

	if (sd && dir)
468
		sd = sysfs_find_dirent(sd, NULL, dir);
469
	if (sd && attr)
470
		sd = sysfs_find_dirent(sd, NULL, attr);
471 472
	if (sd)
		sysfs_notify_dirent(sd);
473 474

	mutex_unlock(&sysfs_mutex);
475 476 477
}
EXPORT_SYMBOL_GPL(sysfs_notify);

478
const struct file_operations sysfs_file_operations = {
L
Linus Torvalds 已提交
479 480 481 482 483
	.read		= sysfs_read_file,
	.write		= sysfs_write_file,
	.llseek		= generic_file_llseek,
	.open		= sysfs_open_file,
	.release	= sysfs_release,
484
	.poll		= sysfs_poll,
L
Linus Torvalds 已提交
485 486
};

J
Josh Triplett 已提交
487 488
static int sysfs_attr_ns(struct kobject *kobj, const struct attribute *attr,
			 const void **pns)
489 490 491 492 493 494
{
	struct sysfs_dirent *dir_sd = kobj->sd;
	const struct sysfs_ops *ops;
	const void *ns = NULL;
	int err;

495 496 497 498 499 500
	if (!dir_sd) {
		WARN(1, KERN_ERR "sysfs: kobject %s without dirent\n",
			kobject_name(kobj));
		return -ENOENT;
	}

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	err = 0;
	if (!sysfs_ns_type(dir_sd))
		goto out;

	err = -EINVAL;
	if (!kobj->ktype)
		goto out;
	ops = kobj->ktype->sysfs_ops;
	if (!ops)
		goto out;
	if (!ops->namespace)
		goto out;

	err = 0;
	ns = ops->namespace(kobj, attr);
out:
	if (err) {
		WARN(1, KERN_ERR "missing sysfs namespace attribute operation for "
		     "kobject: %s\n", kobject_name(kobj));
	}
	*pns = ns;
	return err;
}

525
int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
A
Al Viro 已提交
526
			const struct attribute *attr, int type, umode_t amode)
L
Linus Torvalds 已提交
527
{
528
	umode_t mode = (amode & S_IALLUGO) | S_IFREG;
529
	struct sysfs_addrm_cxt acxt;
530
	struct sysfs_dirent *sd;
531
	const void *ns;
532
	int rc;
L
Linus Torvalds 已提交
533

534 535 536 537
	rc = sysfs_attr_ns(dir_sd->s_dir.kobj, attr, &ns);
	if (rc)
		return rc;

538 539 540
	sd = sysfs_new_dirent(attr->name, mode, type);
	if (!sd)
		return -ENOMEM;
541 542

	sd->s_ns = ns;
T
Tejun Heo 已提交
543
	sd->s_attr.attr = (void *)attr;
544
	sysfs_dirent_init_lockdep(sd);
L
Linus Torvalds 已提交
545

546
	sysfs_addrm_start(&acxt, dir_sd);
547 548
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
549

550
	if (rc)
551
		sysfs_put(sd);
552

553
	return rc;
L
Linus Torvalds 已提交
554 555 556
}


557 558 559 560 561 562 563
int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
		   int type)
{
	return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
}


L
Linus Torvalds 已提交
564 565
/**
 *	sysfs_create_file - create an attribute file for an object.
566
 *	@kobj:	object we're creating for.
567
 *	@attr:	attribute descriptor.
L
Linus Torvalds 已提交
568
 */
569
int sysfs_create_file(struct kobject *kobj, const struct attribute *attr)
L
Linus Torvalds 已提交
570
{
571
	BUG_ON(!kobj || !kobj->sd || !attr);
L
Linus Torvalds 已提交
572

573
	return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
L
Linus Torvalds 已提交
574 575

}
576
EXPORT_SYMBOL_GPL(sysfs_create_file);
L
Linus Torvalds 已提交
577

578 579 580 581 582 583 584 585 586 587 588 589
int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
{
	int err = 0;
	int i;

	for (i = 0; ptr[i] && !err; i++)
		err = sysfs_create_file(kobj, ptr[i]);
	if (err)
		while (--i >= 0)
			sysfs_remove_file(kobj, ptr[i]);
	return err;
}
590
EXPORT_SYMBOL_GPL(sysfs_create_files);
L
Linus Torvalds 已提交
591

592 593 594 595 596 597 598 599 600
/**
 * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
 * @kobj: object we're acting for.
 * @attr: attribute descriptor.
 * @group: group name.
 */
int sysfs_add_file_to_group(struct kobject *kobj,
		const struct attribute *attr, const char *group)
{
601
	struct sysfs_dirent *dir_sd;
602 603
	int error;

604
	if (group)
605
		dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
606 607 608
	else
		dir_sd = sysfs_get(kobj->sd);

609 610 611 612 613 614
	if (!dir_sd)
		return -ENOENT;

	error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
	sysfs_put(dir_sd);

615 616 617 618
	return error;
}
EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);

619 620 621 622 623 624 625
/**
 * sysfs_chmod_file - update the modified mode value on an object attribute.
 * @kobj: object we're acting for.
 * @attr: attribute descriptor.
 * @mode: file permissions.
 *
 */
626
int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
A
Al Viro 已提交
627
		     umode_t mode)
628
{
629
	struct sysfs_dirent *sd;
630
	struct iattr newattrs;
631
	const void *ns;
632 633
	int rc;

634 635 636 637
	rc = sysfs_attr_ns(kobj, attr, &ns);
	if (rc)
		return rc;

638
	mutex_lock(&sysfs_mutex);
639

640
	rc = -ENOENT;
641
	sd = sysfs_find_dirent(kobj->sd, ns, attr->name);
642
	if (!sd)
643
		goto out;
644

645
	newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
646
	newattrs.ia_valid = ATTR_MODE;
647
	rc = sysfs_sd_setattr(sd, &newattrs);
648

649
 out:
650
	mutex_unlock(&sysfs_mutex);
651
	return rc;
652 653 654
}
EXPORT_SYMBOL_GPL(sysfs_chmod_file);

L
Linus Torvalds 已提交
655 656 657 658 659 660 661
/**
 *	sysfs_remove_file - remove an object attribute.
 *	@kobj:	object we're acting for.
 *	@attr:	attribute descriptor.
 *
 *	Hash the attribute name and kill the victim.
 */
662
void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr)
L
Linus Torvalds 已提交
663
{
664 665 666 667 668 669
	const void *ns;

	if (sysfs_attr_ns(kobj, attr, &ns))
		return;

	sysfs_hash_and_remove(kobj->sd, ns, attr->name);
L
Linus Torvalds 已提交
670
}
671
EXPORT_SYMBOL_GPL(sysfs_remove_file);
L
Linus Torvalds 已提交
672

673
void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
674 675 676 677 678
{
	int i;
	for (i = 0; ptr[i]; i++)
		sysfs_remove_file(kobj, ptr[i]);
}
679
EXPORT_SYMBOL_GPL(sysfs_remove_files);
L
Linus Torvalds 已提交
680

681 682 683 684 685 686 687 688 689
/**
 * sysfs_remove_file_from_group - remove an attribute file from a group.
 * @kobj: object we're acting for.
 * @attr: attribute descriptor.
 * @group: group name.
 */
void sysfs_remove_file_from_group(struct kobject *kobj,
		const struct attribute *attr, const char *group)
{
690
	struct sysfs_dirent *dir_sd;
691

692
	if (group)
693
		dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
694 695
	else
		dir_sd = sysfs_get(kobj->sd);
696
	if (dir_sd) {
697
		sysfs_hash_and_remove(dir_sd, NULL, attr->name);
698
		sysfs_put(dir_sd);
699 700 701 702
	}
}
EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);

703
struct sysfs_schedule_callback_struct {
704 705
	struct list_head	workq_list;
	struct kobject		*kobj;
706 707
	void			(*func)(void *);
	void			*data;
708
	struct module		*owner;
709 710 711
	struct work_struct	work;
};

712
static struct workqueue_struct *sysfs_workqueue;
713 714
static DEFINE_MUTEX(sysfs_workq_mutex);
static LIST_HEAD(sysfs_workq);
715 716 717 718 719 720 721
static void sysfs_schedule_callback_work(struct work_struct *work)
{
	struct sysfs_schedule_callback_struct *ss = container_of(work,
			struct sysfs_schedule_callback_struct, work);

	(ss->func)(ss->data);
	kobject_put(ss->kobj);
722
	module_put(ss->owner);
723 724 725
	mutex_lock(&sysfs_workq_mutex);
	list_del(&ss->workq_list);
	mutex_unlock(&sysfs_workq_mutex);
726 727 728 729 730 731 732 733
	kfree(ss);
}

/**
 * sysfs_schedule_callback - helper to schedule a callback for a kobject
 * @kobj: object we're acting for.
 * @func: callback function to invoke later.
 * @data: argument to pass to @func.
734
 * @owner: module owning the callback code
735 736 737 738 739 740 741 742 743 744 745 746
 *
 * sysfs attribute methods must not unregister themselves or their parent
 * kobject (which would amount to the same thing).  Attempts to do so will
 * deadlock, since unregistration is mutually exclusive with driver
 * callbacks.
 *
 * Instead methods can call this routine, which will attempt to allocate
 * and schedule a workqueue request to call back @func with @data as its
 * argument in the workqueue's process context.  @kobj will be pinned
 * until @func returns.
 *
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
747 748
 * be allocated, -ENODEV if a reference to @owner isn't available,
 * -EAGAIN if a callback has already been scheduled for @kobj.
749 750
 */
int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
751
		void *data, struct module *owner)
752
{
753
	struct sysfs_schedule_callback_struct *ss, *tmp;
754

755 756
	if (!try_module_get(owner))
		return -ENODEV;
757 758 759 760

	mutex_lock(&sysfs_workq_mutex);
	list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
		if (ss->kobj == kobj) {
761
			module_put(owner);
762 763 764 765 766
			mutex_unlock(&sysfs_workq_mutex);
			return -EAGAIN;
		}
	mutex_unlock(&sysfs_workq_mutex);

767
	if (sysfs_workqueue == NULL) {
768
		sysfs_workqueue = create_singlethread_workqueue("sysfsd");
769 770 771 772 773 774
		if (sysfs_workqueue == NULL) {
			module_put(owner);
			return -ENOMEM;
		}
	}

775
	ss = kmalloc(sizeof(*ss), GFP_KERNEL);
776 777
	if (!ss) {
		module_put(owner);
778
		return -ENOMEM;
779
	}
780 781 782 783
	kobject_get(kobj);
	ss->kobj = kobj;
	ss->func = func;
	ss->data = data;
784
	ss->owner = owner;
785
	INIT_WORK(&ss->work, sysfs_schedule_callback_work);
786 787 788 789
	INIT_LIST_HEAD(&ss->workq_list);
	mutex_lock(&sysfs_workq_mutex);
	list_add_tail(&ss->workq_list, &sysfs_workq);
	mutex_unlock(&sysfs_workq_mutex);
790
	queue_work(sysfs_workqueue, &ss->work);
791 792 793
	return 0;
}
EXPORT_SYMBOL_GPL(sysfs_schedule_callback);