file.c 20.4 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>
23
#include <linux/uaccess.h>
24
#include <linux/seq_file.h>
L
Linus Torvalds 已提交
25 26 27

#include "sysfs.h"

T
Tejun Heo 已提交
28
/*
29
 * There's one sysfs_open_file for each open file and one sysfs_open_dirent
T
Tejun Heo 已提交
30
 * for each sysfs_dirent with one or more open files.
T
Tejun Heo 已提交
31
 *
T
Tejun Heo 已提交
32 33 34
 * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open is
 * protected by sysfs_open_dirent_lock.
 *
35 36
 * filp->private_data points to seq_file whose ->private points to
 * sysfs_open_file.  sysfs_open_files are chained at
37
 * sysfs_open_dirent->files, which is protected by sysfs_open_file_mutex.
T
Tejun Heo 已提交
38
 */
J
Jiri Slaby 已提交
39
static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
T
Tejun Heo 已提交
40
static DEFINE_MUTEX(sysfs_open_file_mutex);
T
Tejun Heo 已提交
41 42 43

struct sysfs_open_dirent {
	atomic_t		refcnt;
44 45
	atomic_t		event;
	wait_queue_head_t	poll;
46
	struct list_head	files; /* goes through sysfs_open_file.list */
T
Tejun Heo 已提交
47 48
};

49
struct sysfs_open_file {
50 51
	struct sysfs_dirent	*sd;
	struct file		*file;
52
	struct mutex		mutex;
T
Tejun Heo 已提交
53
	int			event;
T
Tejun Heo 已提交
54
	struct list_head	list;
T
Tejun Heo 已提交
55
};
L
Linus Torvalds 已提交
56

57 58 59 60 61
static bool sysfs_is_bin(struct sysfs_dirent *sd)
{
	return sysfs_type(sd) == SYSFS_KOBJ_BIN_ATTR;
}

62 63 64 65 66
static struct sysfs_open_file *sysfs_of(struct file *file)
{
	return ((struct seq_file *)file->private_data)->private;
}

T
Tejun Heo 已提交
67 68 69 70 71 72 73 74 75 76 77 78
/*
 * Determine ktype->sysfs_ops for the given sysfs_dirent.  This function
 * must be called while holding an active reference.
 */
static const struct sysfs_ops *sysfs_file_ops(struct sysfs_dirent *sd)
{
	struct kobject *kobj = sd->s_parent->s_dir.kobj;

	lockdep_assert_held(sd);
	return kobj->ktype ? kobj->ktype->sysfs_ops : NULL;
}

79 80 81 82
/*
 * Reads on sysfs are handled through seq_file, which takes care of hairy
 * details like buffering and seeking.  The following function pipes
 * sysfs_ops->show() result through seq_file.
L
Linus Torvalds 已提交
83
 */
84
static int sysfs_seq_show(struct seq_file *sf, void *v)
L
Linus Torvalds 已提交
85
{
86 87
	struct sysfs_open_file *of = sf->private;
	struct kobject *kobj = of->sd->s_parent->s_dir.kobj;
T
Tejun Heo 已提交
88
	const struct sysfs_ops *ops;
89
	char *buf;
L
Linus Torvalds 已提交
90 91
	ssize_t count;

92 93 94 95 96 97
	/* acquire buffer and ensure that it's >= PAGE_SIZE */
	count = seq_get_buf(sf, &buf);
	if (count < PAGE_SIZE) {
		seq_commit(sf, -1);
		return 0;
	}
L
Linus Torvalds 已提交
98

99 100 101 102 103 104 105 106
	/*
	 * Need @of->sd for attr and ops, its parent for kobj.  @of->mutex
	 * nests outside active ref and is just to ensure that the ops
	 * aren't called concurrently for the same open file.
	 */
	mutex_lock(&of->mutex);
	if (!sysfs_get_active(of->sd)) {
		mutex_unlock(&of->mutex);
107
		return -ENODEV;
108
	}
109

110
	of->event = atomic_read(&of->sd->s_attr.open->event);
T
Tejun Heo 已提交
111

112 113 114 115 116 117 118 119 120
	/*
	 * Lookup @ops and invoke show().  Control may reach here via seq
	 * file lseek even if @ops->show() isn't implemented.
	 */
	ops = sysfs_file_ops(of->sd);
	if (ops->show)
		count = ops->show(kobj, of->sd->s_attr.attr, buf);
	else
		count = 0;
121

122 123 124 125 126
	sysfs_put_active(of->sd);
	mutex_unlock(&of->mutex);

	if (count < 0)
		return count;
127

128 129 130 131
	/*
	 * The code works fine with PAGE_SIZE return but it's likely to
	 * indicate truncated result or overflow in normal use cases.
	 */
132 133 134 135 136 137
	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;
	}
138 139
	seq_commit(sf, count);
	return 0;
L
Linus Torvalds 已提交
140 141
}

T
Tejun Heo 已提交
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
/*
 * Read method for bin files.  As reading a bin file can have side-effects,
 * the exact offset and bytes specified in read(2) call should be passed to
 * the read callback making it difficult to use seq_file.  Implement
 * simplistic custom buffering for bin files.
 */
static ssize_t sysfs_bin_read(struct file *file, char __user *userbuf,
			      size_t bytes, loff_t *off)
{
	struct sysfs_open_file *of = sysfs_of(file);
	struct bin_attribute *battr = of->sd->s_bin_attr.bin_attr;
	struct kobject *kobj = of->sd->s_parent->s_dir.kobj;
	int size = file_inode(file)->i_size;
	int count = min_t(size_t, bytes, PAGE_SIZE);
	loff_t offs = *off;
	char *buf;

	if (!bytes)
		return 0;

	if (size) {
		if (offs > size)
			return 0;
		if (offs + count > size)
			count = size - offs;
	}

	buf = kmalloc(count, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	/* need of->sd for battr, its parent for kobj */
	mutex_lock(&of->mutex);
	if (!sysfs_get_active(of->sd)) {
		count = -ENODEV;
		mutex_unlock(&of->mutex);
		goto out_free;
	}

	if (battr->read)
		count = battr->read(file, kobj, battr, buf, offs, count);
	else
		count = -EIO;

	sysfs_put_active(of->sd);
	mutex_unlock(&of->mutex);

	if (count < 0)
		goto out_free;

	if (copy_to_user(userbuf, buf, count)) {
		count = -EFAULT;
		goto out_free;
	}

	pr_debug("offs = %lld, *off = %lld, count = %d\n", offs, *off, count);

	*off = offs + count;

 out_free:
	kfree(buf);
	return count;
}

L
Linus Torvalds 已提交
206
/**
T
Tejun Heo 已提交
207 208 209
 * flush_write_buffer - push buffer to kobject
 * @of: open file
 * @buf: data buffer for file
210
 * @off: file offset to write to
T
Tejun Heo 已提交
211
 * @count: number of bytes
L
Linus Torvalds 已提交
212
 *
T
Tejun Heo 已提交
213 214
 * Get the correct pointers for the kobject and the attribute we're dealing
 * with, then call the store() method for it with @buf.
L
Linus Torvalds 已提交
215
 */
216
static int flush_write_buffer(struct sysfs_open_file *of, char *buf, loff_t off,
T
Tejun Heo 已提交
217
			      size_t count)
L
Linus Torvalds 已提交
218
{
219
	struct kobject *kobj = of->sd->s_parent->s_dir.kobj;
T
Tejun Heo 已提交
220
	int rc = 0;
221

T
Tejun Heo 已提交
222 223 224 225 226 227 228 229
	/*
	 * Need @of->sd for attr and ops, its parent for kobj.  @of->mutex
	 * nests outside active ref and is just to ensure that the ops
	 * aren't called concurrently for the same open file.
	 */
	mutex_lock(&of->mutex);
	if (!sysfs_get_active(of->sd)) {
		mutex_unlock(&of->mutex);
230
		return -ENODEV;
T
Tejun Heo 已提交
231
	}
232

233 234 235 236 237 238 239 240 241 242 243 244
	if (sysfs_is_bin(of->sd)) {
		struct bin_attribute *battr = of->sd->s_bin_attr.bin_attr;

		rc = -EIO;
		if (battr->write)
			rc = battr->write(of->file, kobj, battr, buf, off,
					  count);
	} else {
		const struct sysfs_ops *ops = sysfs_file_ops(of->sd);

		rc = ops->store(kobj, of->sd->s_attr.attr, buf, count);
	}
245

246
	sysfs_put_active(of->sd);
T
Tejun Heo 已提交
247
	mutex_unlock(&of->mutex);
L
Linus Torvalds 已提交
248

249
	return rc;
L
Linus Torvalds 已提交
250 251 252
}

/**
T
Tejun Heo 已提交
253 254 255 256 257 258 259 260
 * sysfs_write_file - write an attribute
 * @file: file pointer
 * @user_buf: data to write
 * @count: number of bytes
 * @ppos: starting offset
 *
 * Copy data in from userland and pass it to the matching
 * sysfs_ops->store() by invoking flush_write_buffer().
L
Linus Torvalds 已提交
261
 *
T
Tejun Heo 已提交
262 263 264 265 266
 * 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 on
 * the first write.  Hint: if you're writing a value, first read the file,
 * modify only the the value you're changing, then write entire buffer
 * back.
L
Linus Torvalds 已提交
267
 */
T
Tejun Heo 已提交
268
static ssize_t sysfs_write_file(struct file *file, const char __user *user_buf,
269
				size_t count, loff_t *ppos)
L
Linus Torvalds 已提交
270
{
271
	struct sysfs_open_file *of = sysfs_of(file);
272
	ssize_t len = min_t(size_t, count, PAGE_SIZE);
T
Tejun Heo 已提交
273
	char *buf;
L
Linus Torvalds 已提交
274

275 276 277 278 279 280 281 282
	if (sysfs_is_bin(of->sd)) {
		loff_t size = file_inode(file)->i_size;

		if (size <= *ppos)
			return 0;
		len = min_t(ssize_t, len, size - *ppos);
	}

T
Tejun Heo 已提交
283 284 285 286 287 288 289 290 291 292 293 294 295
	if (!len)
		return 0;

	buf = kmalloc(len + 1, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	if (copy_from_user(buf, user_buf, len)) {
		len = -EFAULT;
		goto out_free;
	}
	buf[len] = '\0';	/* guarantee string termination */

296
	len = flush_write_buffer(of, buf, *ppos, len);
L
Linus Torvalds 已提交
297 298
	if (len > 0)
		*ppos += len;
T
Tejun Heo 已提交
299 300
out_free:
	kfree(buf);
L
Linus Torvalds 已提交
301 302 303
	return len;
}

T
Tejun Heo 已提交
304 305 306
/**
 *	sysfs_get_open_dirent - get or create sysfs_open_dirent
 *	@sd: target sysfs_dirent
307
 *	@of: sysfs_open_file for this instance of open
T
Tejun Heo 已提交
308 309
 *
 *	If @sd->s_attr.open exists, increment its reference count;
310
 *	otherwise, create one.  @of is chained to the files list.
T
Tejun Heo 已提交
311 312 313 314 315 316 317 318
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	0 on success, -errno on failure.
 */
static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
319
				 struct sysfs_open_file *of)
T
Tejun Heo 已提交
320 321 322 323
{
	struct sysfs_open_dirent *od, *new_od = NULL;

 retry:
T
Tejun Heo 已提交
324
	mutex_lock(&sysfs_open_file_mutex);
325
	spin_lock_irq(&sysfs_open_dirent_lock);
T
Tejun Heo 已提交
326 327 328 329 330 331 332 333 334

	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);
335
		list_add_tail(&of->list, &od->files);
T
Tejun Heo 已提交
336 337
	}

338
	spin_unlock_irq(&sysfs_open_dirent_lock);
T
Tejun Heo 已提交
339
	mutex_unlock(&sysfs_open_file_mutex);
T
Tejun Heo 已提交
340 341 342 343 344 345 346 347 348 349 350 351

	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);
352 353
	atomic_set(&new_od->event, 1);
	init_waitqueue_head(&new_od->poll);
354
	INIT_LIST_HEAD(&new_od->files);
T
Tejun Heo 已提交
355 356 357 358 359 360
	goto retry;
}

/**
 *	sysfs_put_open_dirent - put sysfs_open_dirent
 *	@sd: target sysfs_dirent
361
 *	@of: associated sysfs_open_file
T
Tejun Heo 已提交
362
 *
363 364
 *	Put @sd->s_attr.open and unlink @of from the files list.  If
 *	reference count reaches zero, disassociate and free it.
T
Tejun Heo 已提交
365 366 367 368 369
 *
 *	LOCKING:
 *	None.
 */
static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
370
				  struct sysfs_open_file *of)
T
Tejun Heo 已提交
371 372
{
	struct sysfs_open_dirent *od = sd->s_attr.open;
373
	unsigned long flags;
T
Tejun Heo 已提交
374

T
Tejun Heo 已提交
375
	mutex_lock(&sysfs_open_file_mutex);
376
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
T
Tejun Heo 已提交
377

378
	list_del(&of->list);
T
Tejun Heo 已提交
379 380 381 382 383
	if (atomic_dec_and_test(&od->refcnt))
		sd->s_attr.open = NULL;
	else
		od = NULL;

384
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
T
Tejun Heo 已提交
385
	mutex_unlock(&sysfs_open_file_mutex);
T
Tejun Heo 已提交
386 387 388 389

	kfree(od);
}

390
static int sysfs_open_file(struct inode *inode, struct file *file)
L
Linus Torvalds 已提交
391
{
392
	struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
T
Tejun Heo 已提交
393
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
394
	struct sysfs_open_file *of;
395
	const struct sysfs_ops *ops;
396
	int error = -EACCES;
L
Linus Torvalds 已提交
397

398
	/* need attr_sd for attr and ops, its parent for kobj */
399
	if (!sysfs_get_active(attr_sd))
400
		return -ENODEV;
L
Linus Torvalds 已提交
401

402
	/* every kobject with an attribute needs a ktype assigned */
T
Tejun Heo 已提交
403 404 405 406
	ops = sysfs_file_ops(attr_sd);
	if (WARN(!ops, KERN_ERR
		 "missing sysfs attribute operations for kobject: %s\n",
		 kobject_name(kobj)))
407
		goto err_out;
L
Linus Torvalds 已提交
408 409

	/* File needs write support.
410
	 * The inode's perms must say it's ok,
L
Linus Torvalds 已提交
411 412 413 414
	 * and we must have a store method.
	 */
	if (file->f_mode & FMODE_WRITE) {
		if (!(inode->i_mode & S_IWUGO) || !ops->store)
415
			goto err_out;
L
Linus Torvalds 已提交
416 417 418 419 420 421 422 423
	}

	/* 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)
424
			goto err_out;
L
Linus Torvalds 已提交
425 426
	}

427
	/* allocate a sysfs_open_file for the file */
428
	error = -ENOMEM;
429 430
	of = kzalloc(sizeof(struct sysfs_open_file), GFP_KERNEL);
	if (!of)
431
		goto err_out;
L
Linus Torvalds 已提交
432

433
	mutex_init(&of->mutex);
434 435
	of->sd = attr_sd;
	of->file = file;
436 437 438 439 440 441 442 443 444 445 446 447 448

	/*
	 * Always instantiate seq_file even if read access is not
	 * implemented or requested.  This unifies private data access and
	 * most files are readable anyway.
	 */
	error = single_open(file, sysfs_seq_show, of);
	if (error)
		goto err_free;

	/* seq_file clears PWRITE unconditionally, restore it if WRITE */
	if (file->f_mode & FMODE_WRITE)
		file->f_mode |= FMODE_PWRITE;
449

T
Tejun Heo 已提交
450
	/* make sure we have open dirent struct */
451
	error = sysfs_get_open_dirent(attr_sd, of);
T
Tejun Heo 已提交
452
	if (error)
453
		goto err_close;
T
Tejun Heo 已提交
454

455
	/* open succeeded, put active references */
456
	sysfs_put_active(attr_sd);
457 458
	return 0;

459 460 461
err_close:
	single_release(inode, file);
err_free:
462
	kfree(of);
463
err_out:
464
	sysfs_put_active(attr_sd);
L
Linus Torvalds 已提交
465 466 467
	return error;
}

T
Tejun Heo 已提交
468
static int sysfs_release(struct inode *inode, struct file *filp)
L
Linus Torvalds 已提交
469
{
T
Tejun Heo 已提交
470
	struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
471
	struct sysfs_open_file *of = sysfs_of(filp);
L
Linus Torvalds 已提交
472

473
	sysfs_put_open_dirent(sd, of);
474
	single_release(inode, filp);
475
	kfree(of);
476

L
Linus Torvalds 已提交
477 478 479
	return 0;
}

480 481 482 483 484 485 486
/* 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
487
 * need to close and re-open the file, or seek to 0 and read again.
488 489
 * Reminder: this only works for attributes which actively support
 * it, and it is not possible to test an attribute from userspace
490
 * to see if it supports poll (Neither 'poll' nor 'select' return
491 492 493 494
 * an appropriate error code).  When in doubt, set a suitable timeout value.
 */
static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
{
495
	struct sysfs_open_file *of = sysfs_of(filp);
496
	struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
497
	struct sysfs_open_dirent *od = attr_sd->s_attr.open;
498 499

	/* need parent for the kobj, grab both */
500
	if (!sysfs_get_active(attr_sd))
501
		goto trigger;
502

503
	poll_wait(filp, &od->poll, wait);
504

505
	sysfs_put_active(attr_sd);
506

507
	if (of->event != atomic_read(&od->event))
508
		goto trigger;
509

510
	return DEFAULT_POLLMASK;
511 512

 trigger:
513
	return DEFAULT_POLLMASK|POLLERR|POLLPRI;
514 515
}

516 517 518
void sysfs_notify_dirent(struct sysfs_dirent *sd)
{
	struct sysfs_open_dirent *od;
519
	unsigned long flags;
520

521
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
522

523 524 525 526 527 528
	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);
		}
529 530
	}

531
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
532 533 534
}
EXPORT_SYMBOL_GPL(sysfs_notify_dirent);

535
void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
536
{
537
	struct sysfs_dirent *sd = k->sd;
538

539 540 541
	mutex_lock(&sysfs_mutex);

	if (sd && dir)
T
Tejun Heo 已提交
542
		sd = sysfs_find_dirent(sd, dir, NULL);
543
	if (sd && attr)
T
Tejun Heo 已提交
544
		sd = sysfs_find_dirent(sd, attr, NULL);
545 546
	if (sd)
		sysfs_notify_dirent(sd);
547 548

	mutex_unlock(&sysfs_mutex);
549 550 551
}
EXPORT_SYMBOL_GPL(sysfs_notify);

552
const struct file_operations sysfs_file_operations = {
553
	.read		= seq_read,
L
Linus Torvalds 已提交
554
	.write		= sysfs_write_file,
555
	.llseek		= seq_lseek,
L
Linus Torvalds 已提交
556 557
	.open		= sysfs_open_file,
	.release	= sysfs_release,
558
	.poll		= sysfs_poll,
L
Linus Torvalds 已提交
559 560
};

561
const struct file_operations sysfs_bin_operations = {
T
Tejun Heo 已提交
562
	.read		= sysfs_bin_read,
563 564 565 566
	.write		= sysfs_write_file,
	.llseek		= generic_file_llseek,
};

567 568 569
int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
			   const struct attribute *attr, int type,
			   umode_t amode, const void *ns)
L
Linus Torvalds 已提交
570
{
571
	umode_t mode = (amode & S_IALLUGO) | S_IFREG;
572
	struct sysfs_addrm_cxt acxt;
573
	struct sysfs_dirent *sd;
574
	int rc;
L
Linus Torvalds 已提交
575

576 577 578
	sd = sysfs_new_dirent(attr->name, mode, type);
	if (!sd)
		return -ENOMEM;
579 580

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

584 585
	sysfs_addrm_start(&acxt);
	rc = sysfs_add_one(&acxt, sd, dir_sd);
586
	sysfs_addrm_finish(&acxt);
587

588
	if (rc)
589
		sysfs_put(sd);
590

591
	return rc;
L
Linus Torvalds 已提交
592 593 594
}


595 596 597
int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
		   int type)
{
598
	return sysfs_add_file_mode_ns(dir_sd, attr, type, attr->mode, NULL);
599 600
}

L
Linus Torvalds 已提交
601
/**
602 603 604 605
 * sysfs_create_file_ns - create an attribute file for an object with custom ns
 * @kobj: object we're creating for
 * @attr: attribute descriptor
 * @ns: namespace the new file should belong to
L
Linus Torvalds 已提交
606
 */
607 608
int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
			 const void *ns)
L
Linus Torvalds 已提交
609
{
610
	BUG_ON(!kobj || !kobj->sd || !attr);
L
Linus Torvalds 已提交
611

612 613
	return sysfs_add_file_mode_ns(kobj->sd, attr, SYSFS_KOBJ_ATTR,
				      attr->mode, ns);
L
Linus Torvalds 已提交
614 615

}
616
EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
L
Linus Torvalds 已提交
617

618 619 620 621 622 623 624 625 626 627 628 629
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;
}
630
EXPORT_SYMBOL_GPL(sysfs_create_files);
L
Linus Torvalds 已提交
631

632 633 634 635 636 637 638 639 640
/**
 * 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)
{
641
	struct sysfs_dirent *dir_sd;
642 643
	int error;

644
	if (group)
T
Tejun Heo 已提交
645
		dir_sd = sysfs_get_dirent(kobj->sd, group);
646 647 648
	else
		dir_sd = sysfs_get(kobj->sd);

649 650 651 652 653 654
	if (!dir_sd)
		return -ENOENT;

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

655 656 657 658
	return error;
}
EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);

659 660 661 662 663 664 665
/**
 * sysfs_chmod_file - update the modified mode value on an object attribute.
 * @kobj: object we're acting for.
 * @attr: attribute descriptor.
 * @mode: file permissions.
 *
 */
666
int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
A
Al Viro 已提交
667
		     umode_t mode)
668
{
669
	struct sysfs_dirent *sd;
670
	struct iattr newattrs;
671 672
	int rc;

673
	mutex_lock(&sysfs_mutex);
674

675
	rc = -ENOENT;
T
Tejun Heo 已提交
676
	sd = sysfs_find_dirent(kobj->sd, attr->name, NULL);
677
	if (!sd)
678
		goto out;
679

680
	newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
681
	newattrs.ia_valid = ATTR_MODE;
682
	rc = sysfs_sd_setattr(sd, &newattrs);
683

684
 out:
685
	mutex_unlock(&sysfs_mutex);
686
	return rc;
687 688 689
}
EXPORT_SYMBOL_GPL(sysfs_chmod_file);

L
Linus Torvalds 已提交
690
/**
691 692 693 694
 * sysfs_remove_file_ns - remove an object attribute with a custom ns tag
 * @kobj: object we're acting for
 * @attr: attribute descriptor
 * @ns: namespace tag of the file to remove
L
Linus Torvalds 已提交
695
 *
696
 * Hash the attribute name and namespace tag and kill the victim.
L
Linus Torvalds 已提交
697
 */
698 699
void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
			  const void *ns)
L
Linus Torvalds 已提交
700
{
701
	struct sysfs_dirent *dir_sd = kobj->sd;
702

T
Tejun Heo 已提交
703
	sysfs_hash_and_remove(dir_sd, attr->name, ns);
L
Linus Torvalds 已提交
704
}
705
EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
L
Linus Torvalds 已提交
706

707
void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
708 709 710 711 712
{
	int i;
	for (i = 0; ptr[i]; i++)
		sysfs_remove_file(kobj, ptr[i]);
}
713
EXPORT_SYMBOL_GPL(sysfs_remove_files);
L
Linus Torvalds 已提交
714

715 716 717 718 719 720 721 722 723
/**
 * 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)
{
724
	struct sysfs_dirent *dir_sd;
725

726
	if (group)
T
Tejun Heo 已提交
727
		dir_sd = sysfs_get_dirent(kobj->sd, group);
728 729
	else
		dir_sd = sysfs_get(kobj->sd);
730
	if (dir_sd) {
T
Tejun Heo 已提交
731
		sysfs_hash_and_remove(dir_sd, attr->name, NULL);
732
		sysfs_put(dir_sd);
733 734 735 736
	}
}
EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);

737
struct sysfs_schedule_callback_struct {
738 739
	struct list_head	workq_list;
	struct kobject		*kobj;
740 741
	void			(*func)(void *);
	void			*data;
742
	struct module		*owner;
743 744 745
	struct work_struct	work;
};

746
static struct workqueue_struct *sysfs_workqueue;
747 748
static DEFINE_MUTEX(sysfs_workq_mutex);
static LIST_HEAD(sysfs_workq);
749 750 751 752 753 754 755
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);
756
	module_put(ss->owner);
757 758 759
	mutex_lock(&sysfs_workq_mutex);
	list_del(&ss->workq_list);
	mutex_unlock(&sysfs_workq_mutex);
760 761 762 763 764 765 766 767
	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.
768
 * @owner: module owning the callback code
769 770 771 772 773 774 775 776 777 778 779 780
 *
 * 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
781 782
 * be allocated, -ENODEV if a reference to @owner isn't available,
 * -EAGAIN if a callback has already been scheduled for @kobj.
783 784
 */
int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
785
		void *data, struct module *owner)
786
{
787
	struct sysfs_schedule_callback_struct *ss, *tmp;
788

789 790
	if (!try_module_get(owner))
		return -ENODEV;
791 792 793 794

	mutex_lock(&sysfs_workq_mutex);
	list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
		if (ss->kobj == kobj) {
795
			module_put(owner);
796 797 798 799 800
			mutex_unlock(&sysfs_workq_mutex);
			return -EAGAIN;
		}
	mutex_unlock(&sysfs_workq_mutex);

801
	if (sysfs_workqueue == NULL) {
802
		sysfs_workqueue = create_singlethread_workqueue("sysfsd");
803 804 805 806 807 808
		if (sysfs_workqueue == NULL) {
			module_put(owner);
			return -ENOMEM;
		}
	}

809
	ss = kmalloc(sizeof(*ss), GFP_KERNEL);
810 811
	if (!ss) {
		module_put(owner);
812
		return -ENOMEM;
813
	}
814 815 816 817
	kobject_get(kobj);
	ss->kobj = kobj;
	ss->func = func;
	ss->data = data;
818
	ss->owner = owner;
819
	INIT_WORK(&ss->work, sysfs_schedule_callback_work);
820 821 822 823
	INIT_LIST_HEAD(&ss->workq_list);
	mutex_lock(&sysfs_workq_mutex);
	list_add_tail(&ss->workq_list, &sysfs_workq);
	mutex_unlock(&sysfs_workq_mutex);
824
	queue_work(sysfs_workqueue, &ss->work);
825 826 827
	return 0;
}
EXPORT_SYMBOL_GPL(sysfs_schedule_callback);