file.c 19.5 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
Tejun Heo's avatar
Tejun Heo committed
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.
Linus Torvalds's avatar
Linus Torvalds committed
11
12
13
14
 */

#include <linux/module.h>
#include <linux/kobject.h>
15
#include <linux/kallsyms.h>
16
#include <linux/slab.h>
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>
Andrew Morton's avatar
Andrew Morton committed
22
#include <linux/limits.h>
23
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
24
25
26

#include "sysfs.h"

Tejun Heo's avatar
Tejun Heo committed
27
/*
28
 * There's one sysfs_open_file for each open file and one sysfs_open_dirent
Tejun Heo's avatar
Tejun Heo committed
29
 * for each sysfs_dirent with one or more open files.
Tejun Heo's avatar
Tejun Heo committed
30
 *
Tejun Heo's avatar
Tejun Heo committed
31
32
33
 * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open is
 * protected by sysfs_open_dirent_lock.
 *
34
35
 * filp->private_data points to sysfs_open_file which is chained at
 * sysfs_open_dirent->files, which is protected by sysfs_open_file_mutex.
Tejun Heo's avatar
Tejun Heo committed
36
 */
Jiri Slaby's avatar
Jiri Slaby committed
37
static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
Tejun Heo's avatar
Tejun Heo committed
38
static DEFINE_MUTEX(sysfs_open_file_mutex);
Tejun Heo's avatar
Tejun Heo committed
39
40
41

struct sysfs_open_dirent {
	atomic_t		refcnt;
42
43
	atomic_t		event;
	wait_queue_head_t	poll;
44
	struct list_head	files; /* goes through sysfs_open_file.list */
Tejun Heo's avatar
Tejun Heo committed
45
46
};

47
struct sysfs_open_file {
48
	size_t			count;
49
	char			*page;
50
	struct mutex		mutex;
51
	int			event;
Tejun Heo's avatar
Tejun Heo committed
52
	struct list_head	list;
53
};
Linus Torvalds's avatar
Linus Torvalds committed
54

Tejun Heo's avatar
Tejun Heo committed
55
56
57
58
59
60
61
62
63
64
65
66
/*
 * 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;
}

Linus Torvalds's avatar
Linus Torvalds committed
67
68
69
70
71
72
/**
 *	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
73
74
 *	kobject's show() method to fill the buffer with this attribute's
 *	data.
75
76
 *	This is called only once, on the file's first read unless an error
 *	is returned.
Linus Torvalds's avatar
Linus Torvalds committed
77
 */
78
static int fill_read_buffer(struct dentry *dentry, struct sysfs_open_file *of)
Linus Torvalds's avatar
Linus Torvalds committed
79
{
80
	struct sysfs_dirent *attr_sd = dentry->d_fsdata;
81
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
Tejun Heo's avatar
Tejun Heo committed
82
	const struct sysfs_ops *ops;
Linus Torvalds's avatar
Linus Torvalds committed
83
84
85
	int ret = 0;
	ssize_t count;

86
87
88
	if (!of->page)
		of->page = (char *) get_zeroed_page(GFP_KERNEL);
	if (!of->page)
Linus Torvalds's avatar
Linus Torvalds committed
89
90
		return -ENOMEM;

91
	/* need attr_sd for attr and ops, its parent for kobj */
92
	if (!sysfs_get_active(attr_sd))
93
94
		return -ENODEV;

95
	of->event = atomic_read(&attr_sd->s_attr.open->event);
Tejun Heo's avatar
Tejun Heo committed
96
97

	ops = sysfs_file_ops(attr_sd);
98
	count = ops->show(kobj, attr_sd->s_attr.attr, of->page);
99

100
	sysfs_put_active(attr_sd);
101

102
103
104
105
	/*
	 * The code works fine with PAGE_SIZE return but it's likely to
	 * indicate truncated result or overflow in normal use cases.
	 */
106
107
108
109
110
111
	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;
	}
112
	if (count >= 0)
113
		of->count = count;
114
	else
Linus Torvalds's avatar
Linus Torvalds committed
115
116
117
118
119
		ret = count;
	return ret;
}

/**
120
 *	sysfs_read_file - read an attribute.
Linus Torvalds's avatar
Linus Torvalds committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 *	@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)
{
141
	struct sysfs_open_file *of = file->private_data;
Linus Torvalds's avatar
Linus Torvalds committed
142
143
	ssize_t retval = 0;

144
	mutex_lock(&of->mutex);
145
146
147
148
	/*
	 * Fill on zero offset and the first read so that silly things like
	 * "dd bs=1 skip=N" can work on sysfs files.
	 */
149
150
	if (*ppos == 0 || !of->page) {
		retval = fill_read_buffer(file->f_path.dentry, of);
151
		if (retval)
Linus Torvalds's avatar
Linus Torvalds committed
152
153
			goto out;
	}
154
	pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
155
156
		 __func__, count, *ppos, of->page);
	retval = simple_read_from_buffer(buf, count, ppos, of->page, of->count);
Linus Torvalds's avatar
Linus Torvalds committed
157
out:
158
	mutex_unlock(&of->mutex);
Linus Torvalds's avatar
Linus Torvalds committed
159
160
161
162
163
	return retval;
}

/**
 *	fill_write_buffer - copy buffer from userspace.
164
 *	@of:		open file struct.
165
 *	@buf:		data from user.
Linus Torvalds's avatar
Linus Torvalds committed
166
167
 *	@count:		number of bytes in @userbuf.
 *
168
169
 *	Allocate @of->page if it hasn't been already, then copy the
 *	user-supplied buffer into it.
Linus Torvalds's avatar
Linus Torvalds committed
170
 */
171
static int fill_write_buffer(struct sysfs_open_file *of,
172
			     const char __user *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
173
174
175
{
	int error;

176
177
178
	if (!of->page)
		of->page = (char *)get_zeroed_page(GFP_KERNEL);
	if (!of->page)
Linus Torvalds's avatar
Linus Torvalds committed
179
180
181
		return -ENOMEM;

	if (count >= PAGE_SIZE)
182
		count = PAGE_SIZE - 1;
183
	error = copy_from_user(of->page, buf, count);
184
185
186
187
188

	/*
	 * If buf is assumed to contain a string, terminate it by \0, so
	 * e.g. sscanf() can scan the string easily.
	 */
189
	of->page[count] = 0;
Linus Torvalds's avatar
Linus Torvalds committed
190
191
192
193
194
	return error ? -EFAULT : count;
}

/**
 *	flush_write_buffer - push buffer to kobject.
195
 *	@dentry:	dentry to the attribute
196
 *	@of:		open file
197
 *	@count:		number of bytes
Linus Torvalds's avatar
Linus Torvalds committed
198
199
 *
 *	Get the correct pointers for the kobject and the attribute we're
200
 *	dealing with, then call the store() method for the attribute,
Linus Torvalds's avatar
Linus Torvalds committed
201
202
 *	passing the buffer that we acquired in fill_write_buffer().
 */
203
static int flush_write_buffer(struct dentry *dentry,
204
			      struct sysfs_open_file *of, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
205
{
206
	struct sysfs_dirent *attr_sd = dentry->d_fsdata;
207
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
Tejun Heo's avatar
Tejun Heo committed
208
	const struct sysfs_ops *ops;
209
210
211
	int rc;

	/* need attr_sd for attr and ops, its parent for kobj */
212
	if (!sysfs_get_active(attr_sd))
213
214
		return -ENODEV;

Tejun Heo's avatar
Tejun Heo committed
215
	ops = sysfs_file_ops(attr_sd);
216
	rc = ops->store(kobj, attr_sd->s_attr.attr, of->page, count);
217

218
	sysfs_put_active(attr_sd);
Linus Torvalds's avatar
Linus Torvalds committed
219

220
	return rc;
Linus Torvalds's avatar
Linus Torvalds committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
}

/**
 *	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
235
 *	on the first write.
Linus Torvalds's avatar
Linus Torvalds committed
236
 *	Hint: if you're writing a value, first read the file, modify only the
237
 *	the value you're changing, then write entire buffer back.
Linus Torvalds's avatar
Linus Torvalds committed
238
 */
239
240
static ssize_t sysfs_write_file(struct file *file, const char __user *buf,
				size_t count, loff_t *ppos)
Linus Torvalds's avatar
Linus Torvalds committed
241
{
242
	struct sysfs_open_file *of = file->private_data;
Linus Torvalds's avatar
Linus Torvalds committed
243
244
	ssize_t len;

245
246
	mutex_lock(&of->mutex);
	len = fill_write_buffer(of, buf, count);
Linus Torvalds's avatar
Linus Torvalds committed
247
	if (len > 0)
248
		len = flush_write_buffer(file->f_path.dentry, of, len);
Linus Torvalds's avatar
Linus Torvalds committed
249
250
	if (len > 0)
		*ppos += len;
251
	mutex_unlock(&of->mutex);
Linus Torvalds's avatar
Linus Torvalds committed
252
253
254
	return len;
}

Tejun Heo's avatar
Tejun Heo committed
255
256
257
/**
 *	sysfs_get_open_dirent - get or create sysfs_open_dirent
 *	@sd: target sysfs_dirent
258
 *	@of: sysfs_open_file for this instance of open
Tejun Heo's avatar
Tejun Heo committed
259
260
 *
 *	If @sd->s_attr.open exists, increment its reference count;
261
 *	otherwise, create one.  @of is chained to the files list.
Tejun Heo's avatar
Tejun Heo committed
262
263
264
265
266
267
268
269
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	0 on success, -errno on failure.
 */
static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
270
				 struct sysfs_open_file *of)
Tejun Heo's avatar
Tejun Heo committed
271
272
273
274
{
	struct sysfs_open_dirent *od, *new_od = NULL;

 retry:
Tejun Heo's avatar
Tejun Heo committed
275
	mutex_lock(&sysfs_open_file_mutex);
276
	spin_lock_irq(&sysfs_open_dirent_lock);
Tejun Heo's avatar
Tejun Heo committed
277
278
279
280
281
282
283
284
285

	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);
286
		list_add_tail(&of->list, &od->files);
Tejun Heo's avatar
Tejun Heo committed
287
288
	}

289
	spin_unlock_irq(&sysfs_open_dirent_lock);
Tejun Heo's avatar
Tejun Heo committed
290
	mutex_unlock(&sysfs_open_file_mutex);
Tejun Heo's avatar
Tejun Heo committed
291
292
293
294
295
296
297
298
299
300
301
302

	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);
303
304
	atomic_set(&new_od->event, 1);
	init_waitqueue_head(&new_od->poll);
305
	INIT_LIST_HEAD(&new_od->files);
Tejun Heo's avatar
Tejun Heo committed
306
307
308
309
310
311
	goto retry;
}

/**
 *	sysfs_put_open_dirent - put sysfs_open_dirent
 *	@sd: target sysfs_dirent
312
 *	@of: associated sysfs_open_file
Tejun Heo's avatar
Tejun Heo committed
313
 *
314
315
 *	Put @sd->s_attr.open and unlink @of from the files list.  If
 *	reference count reaches zero, disassociate and free it.
Tejun Heo's avatar
Tejun Heo committed
316
317
318
319
320
 *
 *	LOCKING:
 *	None.
 */
static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
321
				  struct sysfs_open_file *of)
Tejun Heo's avatar
Tejun Heo committed
322
323
{
	struct sysfs_open_dirent *od = sd->s_attr.open;
324
	unsigned long flags;
Tejun Heo's avatar
Tejun Heo committed
325

Tejun Heo's avatar
Tejun Heo committed
326
	mutex_lock(&sysfs_open_file_mutex);
327
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
Tejun Heo's avatar
Tejun Heo committed
328

329
	list_del(&of->list);
Tejun Heo's avatar
Tejun Heo committed
330
331
332
333
334
	if (atomic_dec_and_test(&od->refcnt))
		sd->s_attr.open = NULL;
	else
		od = NULL;

335
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
Tejun Heo's avatar
Tejun Heo committed
336
	mutex_unlock(&sysfs_open_file_mutex);
Tejun Heo's avatar
Tejun Heo committed
337
338
339
340

	kfree(od);
}

341
static int sysfs_open_file(struct inode *inode, struct file *file)
Linus Torvalds's avatar
Linus Torvalds committed
342
{
343
	struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
344
	struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
345
	struct sysfs_open_file *of;
346
	const struct sysfs_ops *ops;
347
	int error = -EACCES;
Linus Torvalds's avatar
Linus Torvalds committed
348

349
	/* need attr_sd for attr and ops, its parent for kobj */
350
	if (!sysfs_get_active(attr_sd))
351
		return -ENODEV;
Linus Torvalds's avatar
Linus Torvalds committed
352

353
	/* every kobject with an attribute needs a ktype assigned */
Tejun Heo's avatar
Tejun Heo committed
354
355
356
357
	ops = sysfs_file_ops(attr_sd);
	if (WARN(!ops, KERN_ERR
		 "missing sysfs attribute operations for kobject: %s\n",
		 kobject_name(kobj)))
358
		goto err_out;
Linus Torvalds's avatar
Linus Torvalds committed
359
360

	/* File needs write support.
361
	 * The inode's perms must say it's ok,
Linus Torvalds's avatar
Linus Torvalds committed
362
363
364
365
	 * and we must have a store method.
	 */
	if (file->f_mode & FMODE_WRITE) {
		if (!(inode->i_mode & S_IWUGO) || !ops->store)
366
			goto err_out;
Linus Torvalds's avatar
Linus Torvalds committed
367
368
369
370
371
372
373
374
	}

	/* 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)
375
			goto err_out;
Linus Torvalds's avatar
Linus Torvalds committed
376
377
	}

378
379
380
	/*
	 * No error? Great, allocate a sysfs_open_file for the file, and
	 * store it it in file->private_data for easy access.
Linus Torvalds's avatar
Linus Torvalds committed
381
	 */
382
	error = -ENOMEM;
383
384
	of = kzalloc(sizeof(struct sysfs_open_file), GFP_KERNEL);
	if (!of)
385
		goto err_out;
Linus Torvalds's avatar
Linus Torvalds committed
386

387
388
	mutex_init(&of->mutex);
	file->private_data = of;
389

Tejun Heo's avatar
Tejun Heo committed
390
	/* make sure we have open dirent struct */
391
	error = sysfs_get_open_dirent(attr_sd, of);
Tejun Heo's avatar
Tejun Heo committed
392
393
394
	if (error)
		goto err_free;

395
	/* open succeeded, put active references */
396
	sysfs_put_active(attr_sd);
397
398
	return 0;

Tejun Heo's avatar
Tejun Heo committed
399
 err_free:
400
	kfree(of);
401
 err_out:
402
	sysfs_put_active(attr_sd);
Linus Torvalds's avatar
Linus Torvalds committed
403
404
405
	return error;
}

Tejun Heo's avatar
Tejun Heo committed
406
static int sysfs_release(struct inode *inode, struct file *filp)
Linus Torvalds's avatar
Linus Torvalds committed
407
{
Tejun Heo's avatar
Tejun Heo committed
408
	struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
409
	struct sysfs_open_file *of = filp->private_data;
Linus Torvalds's avatar
Linus Torvalds committed
410

411
	sysfs_put_open_dirent(sd, of);
Tejun Heo's avatar
Tejun Heo committed
412

413
414
415
	if (of->page)
		free_page((unsigned long)of->page);
	kfree(of);
416

Linus Torvalds's avatar
Linus Torvalds committed
417
418
419
	return 0;
}

420
421
422
423
424
425
426
/* 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
427
 * need to close and re-open the file, or seek to 0 and read again.
428
429
 * Reminder: this only works for attributes which actively support
 * it, and it is not possible to test an attribute from userspace
430
 * to see if it supports poll (Neither 'poll' nor 'select' return
431
432
433
434
 * an appropriate error code).  When in doubt, set a suitable timeout value.
 */
static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
{
435
	struct sysfs_open_file *of = filp->private_data;
436
	struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
437
	struct sysfs_open_dirent *od = attr_sd->s_attr.open;
438
439

	/* need parent for the kobj, grab both */
440
	if (!sysfs_get_active(attr_sd))
441
		goto trigger;
442

443
	poll_wait(filp, &od->poll, wait);
444

445
	sysfs_put_active(attr_sd);
446

447
	if (of->event != atomic_read(&od->event))
448
		goto trigger;
449

450
	return DEFAULT_POLLMASK;
451
452

 trigger:
453
	return DEFAULT_POLLMASK|POLLERR|POLLPRI;
454
455
}

456
457
458
void sysfs_notify_dirent(struct sysfs_dirent *sd)
{
	struct sysfs_open_dirent *od;
459
	unsigned long flags;
460

461
	spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
462

463
464
465
466
467
468
	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);
		}
469
470
	}

471
	spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
472
473
474
}
EXPORT_SYMBOL_GPL(sysfs_notify_dirent);

475
void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
476
{
477
	struct sysfs_dirent *sd = k->sd;
478

479
480
481
	mutex_lock(&sysfs_mutex);

	if (sd && dir)
Tejun Heo's avatar
Tejun Heo committed
482
		sd = sysfs_find_dirent(sd, dir, NULL);
483
	if (sd && attr)
Tejun Heo's avatar
Tejun Heo committed
484
		sd = sysfs_find_dirent(sd, attr, NULL);
485
486
	if (sd)
		sysfs_notify_dirent(sd);
487
488

	mutex_unlock(&sysfs_mutex);
489
490
491
}
EXPORT_SYMBOL_GPL(sysfs_notify);

492
const struct file_operations sysfs_file_operations = {
Linus Torvalds's avatar
Linus Torvalds committed
493
494
495
496
497
	.read		= sysfs_read_file,
	.write		= sysfs_write_file,
	.llseek		= generic_file_llseek,
	.open		= sysfs_open_file,
	.release	= sysfs_release,
498
	.poll		= sysfs_poll,
Linus Torvalds's avatar
Linus Torvalds committed
499
500
};

501
502
503
int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
			   const struct attribute *attr, int type,
			   umode_t amode, const void *ns)
Linus Torvalds's avatar
Linus Torvalds committed
504
{
505
	umode_t mode = (amode & S_IALLUGO) | S_IFREG;
506
	struct sysfs_addrm_cxt acxt;
507
	struct sysfs_dirent *sd;
508
	int rc;
Linus Torvalds's avatar
Linus Torvalds committed
509

510
511
512
	sd = sysfs_new_dirent(attr->name, mode, type);
	if (!sd)
		return -ENOMEM;
513
514

	sd->s_ns = ns;
515
	sd->s_attr.attr = (void *)attr;
516
	sysfs_dirent_init_lockdep(sd);
Linus Torvalds's avatar
Linus Torvalds committed
517

518
519
	sysfs_addrm_start(&acxt);
	rc = sysfs_add_one(&acxt, sd, dir_sd);
520
	sysfs_addrm_finish(&acxt);
521

522
	if (rc)
523
		sysfs_put(sd);
524

525
	return rc;
Linus Torvalds's avatar
Linus Torvalds committed
526
527
528
}


529
530
531
int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
		   int type)
{
532
	return sysfs_add_file_mode_ns(dir_sd, attr, type, attr->mode, NULL);
533
534
}

Linus Torvalds's avatar
Linus Torvalds committed
535
/**
536
537
538
539
 * 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
Linus Torvalds's avatar
Linus Torvalds committed
540
 */
541
542
int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
			 const void *ns)
Linus Torvalds's avatar
Linus Torvalds committed
543
{
544
	BUG_ON(!kobj || !kobj->sd || !attr);
Linus Torvalds's avatar
Linus Torvalds committed
545

546
547
	return sysfs_add_file_mode_ns(kobj->sd, attr, SYSFS_KOBJ_ATTR,
				      attr->mode, ns);
Linus Torvalds's avatar
Linus Torvalds committed
548
549

}
550
EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
Linus Torvalds's avatar
Linus Torvalds committed
551

552
553
554
555
556
557
558
559
560
561
562
563
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;
}
564
EXPORT_SYMBOL_GPL(sysfs_create_files);
Linus Torvalds's avatar
Linus Torvalds committed
565

566
567
568
569
570
571
572
573
574
/**
 * 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)
{
575
	struct sysfs_dirent *dir_sd;
576
577
	int error;

578
	if (group)
Tejun Heo's avatar
Tejun Heo committed
579
		dir_sd = sysfs_get_dirent(kobj->sd, group);
580
581
582
	else
		dir_sd = sysfs_get(kobj->sd);

583
584
585
586
587
588
	if (!dir_sd)
		return -ENOENT;

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

589
590
591
592
	return error;
}
EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);

593
594
595
596
597
598
599
/**
 * sysfs_chmod_file - update the modified mode value on an object attribute.
 * @kobj: object we're acting for.
 * @attr: attribute descriptor.
 * @mode: file permissions.
 *
 */
600
int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
Al Viro's avatar
Al Viro committed
601
		     umode_t mode)
602
{
603
	struct sysfs_dirent *sd;
604
	struct iattr newattrs;
605
606
	int rc;

607
	mutex_lock(&sysfs_mutex);
608

609
	rc = -ENOENT;
Tejun Heo's avatar
Tejun Heo committed
610
	sd = sysfs_find_dirent(kobj->sd, attr->name, NULL);
611
	if (!sd)
612
		goto out;
613

614
	newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
615
	newattrs.ia_valid = ATTR_MODE;
616
	rc = sysfs_sd_setattr(sd, &newattrs);
617

618
 out:
619
	mutex_unlock(&sysfs_mutex);
620
	return rc;
621
622
623
}
EXPORT_SYMBOL_GPL(sysfs_chmod_file);

Linus Torvalds's avatar
Linus Torvalds committed
624
/**
625
626
627
628
 * 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
Linus Torvalds's avatar
Linus Torvalds committed
629
 *
630
 * Hash the attribute name and namespace tag and kill the victim.
Linus Torvalds's avatar
Linus Torvalds committed
631
 */
632
633
void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
			  const void *ns)
Linus Torvalds's avatar
Linus Torvalds committed
634
{
635
	struct sysfs_dirent *dir_sd = kobj->sd;
636

Tejun Heo's avatar
Tejun Heo committed
637
	sysfs_hash_and_remove(dir_sd, attr->name, ns);
Linus Torvalds's avatar
Linus Torvalds committed
638
}
639
EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
Linus Torvalds's avatar
Linus Torvalds committed
640

641
void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
642
643
644
645
646
{
	int i;
	for (i = 0; ptr[i]; i++)
		sysfs_remove_file(kobj, ptr[i]);
}
647
EXPORT_SYMBOL_GPL(sysfs_remove_files);
Linus Torvalds's avatar
Linus Torvalds committed
648

649
650
651
652
653
654
655
656
657
/**
 * 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)
{
658
	struct sysfs_dirent *dir_sd;
659

660
	if (group)
Tejun Heo's avatar
Tejun Heo committed
661
		dir_sd = sysfs_get_dirent(kobj->sd, group);
662
663
	else
		dir_sd = sysfs_get(kobj->sd);
664
	if (dir_sd) {
Tejun Heo's avatar
Tejun Heo committed
665
		sysfs_hash_and_remove(dir_sd, attr->name, NULL);
666
		sysfs_put(dir_sd);
667
668
669
670
	}
}
EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);

671
struct sysfs_schedule_callback_struct {
672
673
	struct list_head	workq_list;
	struct kobject		*kobj;
674
675
	void			(*func)(void *);
	void			*data;
676
	struct module		*owner;
677
678
679
	struct work_struct	work;
};

680
static struct workqueue_struct *sysfs_workqueue;
681
682
static DEFINE_MUTEX(sysfs_workq_mutex);
static LIST_HEAD(sysfs_workq);
683
684
685
686
687
688
689
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);
690
	module_put(ss->owner);
691
692
693
	mutex_lock(&sysfs_workq_mutex);
	list_del(&ss->workq_list);
	mutex_unlock(&sysfs_workq_mutex);
694
695
696
697
698
699
700
701
	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.
702
 * @owner: module owning the callback code
703
704
705
706
707
708
709
710
711
712
713
714
 *
 * 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
715
716
 * be allocated, -ENODEV if a reference to @owner isn't available,
 * -EAGAIN if a callback has already been scheduled for @kobj.
717
718
 */
int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
719
		void *data, struct module *owner)
720
{
721
	struct sysfs_schedule_callback_struct *ss, *tmp;
722

723
724
	if (!try_module_get(owner))
		return -ENODEV;
725
726
727
728

	mutex_lock(&sysfs_workq_mutex);
	list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
		if (ss->kobj == kobj) {
729
			module_put(owner);
730
731
732
733
734
			mutex_unlock(&sysfs_workq_mutex);
			return -EAGAIN;
		}
	mutex_unlock(&sysfs_workq_mutex);

735
	if (sysfs_workqueue == NULL) {
736
		sysfs_workqueue = create_singlethread_workqueue("sysfsd");
737
738
739
740
741
742
		if (sysfs_workqueue == NULL) {
			module_put(owner);
			return -ENOMEM;
		}
	}

743
	ss = kmalloc(sizeof(*ss), GFP_KERNEL);
744
745
	if (!ss) {
		module_put(owner);
746
		return -ENOMEM;
747
	}
748
749
750
751
	kobject_get(kobj);
	ss->kobj = kobj;
	ss->func = func;
	ss->data = data;
752
	ss->owner = owner;
753
	INIT_WORK(&ss->work, sysfs_schedule_callback_work);
754
755
756
757
	INIT_LIST_HEAD(&ss->workq_list);
	mutex_lock(&sysfs_workq_mutex);
	list_add_tail(&ss->workq_list, &sysfs_workq);
	mutex_unlock(&sysfs_workq_mutex);
758
	queue_work(sysfs_workqueue, &ss->work);
759
760
761
	return 0;
}
EXPORT_SYMBOL_GPL(sysfs_schedule_callback);