file.c 14.3 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * file.c - operations for regular (text) files.
 *
 * Based on sysfs:
 * 	sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
 *
 * configfs Copyright (C) 2005 Oracle.  All rights reserved.
 */

#include <linux/fs.h>
#include <linux/module.h>
#include <linux/slab.h>
16
#include <linux/mutex.h>
17
#include <linux/vmalloc.h>
18
#include <linux/uaccess.h>
19
20
21
22

#include <linux/configfs.h>
#include "configfs_internal.h"

23
24
25
26
27
28
29
/*
 * A simple attribute can only be 4096 characters.  Why 4k?  Because the
 * original code limited it to PAGE_SIZE.  That's a bad idea, though,
 * because an attribute of 16k on ia64 won't work on x86.  So we limit to
 * 4k, our minimum common page size.
 */
#define SIMPLE_ATTR_SIZE 4096
30
31
32
33
34
35

struct configfs_buffer {
	size_t			count;
	loff_t			pos;
	char			* page;
	struct configfs_item_operations	* ops;
36
	struct mutex		mutex;
37
	int			needs_read_fill;
38
39
40
41
	bool			read_in_progress;
	bool			write_in_progress;
	char			*bin_buffer;
	int			bin_buffer_size;
42
43
44
45
46
47
48
	int			cb_max_size;
	struct config_item	*item;
	struct module		*owner;
	union {
		struct configfs_attribute	*attr;
		struct configfs_bin_attribute	*bin_attr;
	};
49
50
};

51
52
53
54
55
56
static inline struct configfs_fragment *to_frag(struct file *file)
{
	struct configfs_dirent *sd = file->f_path.dentry->d_fsdata;

	return sd->s_frag;
}
57

58
static int fill_read_buffer(struct file *file, struct configfs_buffer *buffer)
59
{
60
61
	struct configfs_fragment *frag = to_frag(file);
	ssize_t count = -ENOENT;
62
63
64
65
66
67

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

68
69
70
71
72
	down_read(&frag->frag_sem);
	if (!frag->frag_dead)
		count = buffer->attr->show(buffer->item, buffer->page);
	up_read(&frag->frag_sem);

73
74
75
76
77
78
79
	if (count < 0)
		return count;
	if (WARN_ON_ONCE(count > (ssize_t)SIMPLE_ATTR_SIZE))
		return -EIO;
	buffer->needs_read_fill = 0;
	buffer->count = count;
	return 0;
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
}

/**
 *	configfs_read_file - read an attribute.
 *	@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 item is in the directory's
 *	->d_fsdata.
 *
 *	We call fill_read_buffer() to allocate and fill the buffer from the
 *	item'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 item 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
configfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
{
104
	struct configfs_buffer *buffer = file->private_data;
105
106
	ssize_t retval = 0;

107
	mutex_lock(&buffer->mutex);
108
	if (buffer->needs_read_fill) {
109
		retval = fill_read_buffer(file, buffer);
110
		if (retval)
111
112
			goto out;
	}
113
	pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
114
		 __func__, count, *ppos, buffer->page);
115
116
	retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
					 buffer->count);
117
out:
118
	mutex_unlock(&buffer->mutex);
119
120
121
	return retval;
}

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/**
 *	configfs_read_bin_file - read a binary attribute.
 *	@file:	file pointer.
 *	@buf:	buffer to fill.
 *	@count:	number of bytes to read.
 *	@ppos:	starting offset in file.
 *
 *	Userspace wants to read a binary attribute file. The attribute
 *	descriptor is in the file's ->d_fsdata. The target item is in the
 *	directory's ->d_fsdata.
 *
 *	We check whether we need to refill the buffer. If so we will
 *	call the attributes' attr->read() twice. The first time we
 *	will pass a NULL as a buffer pointer, which the attributes' method
 *	will use to return the size of the buffer required. If no error
 *	occurs we will allocate the buffer using vmalloc and call
 *	attr->read() again passing that buffer as an argument.
 *	Then we just copy to user-space using simple_read_from_buffer.
 */

static ssize_t
configfs_read_bin_file(struct file *file, char __user *buf,
		       size_t count, loff_t *ppos)
{
146
	struct configfs_fragment *frag = to_frag(file);
147
148
149
150
151
152
153
154
155
156
157
	struct configfs_buffer *buffer = file->private_data;
	ssize_t retval = 0;
	ssize_t len = min_t(size_t, count, PAGE_SIZE);

	mutex_lock(&buffer->mutex);

	/* we don't support switching read/write modes */
	if (buffer->write_in_progress) {
		retval = -ETXTBSY;
		goto out;
	}
158
	buffer->read_in_progress = true;
159
160
161

	if (buffer->needs_read_fill) {
		/* perform first read with buf == NULL to get extent */
162
163
164
165
166
167
		down_read(&frag->frag_sem);
		if (!frag->frag_dead)
			len = buffer->bin_attr->read(buffer->item, NULL, 0);
		else
			len = -ENOENT;
		up_read(&frag->frag_sem);
168
169
170
171
172
173
		if (len <= 0) {
			retval = len;
			goto out;
		}

		/* do not exceed the maximum value */
174
		if (buffer->cb_max_size && len > buffer->cb_max_size) {
175
176
177
178
179
180
181
182
183
184
185
186
			retval = -EFBIG;
			goto out;
		}

		buffer->bin_buffer = vmalloc(len);
		if (buffer->bin_buffer == NULL) {
			retval = -ENOMEM;
			goto out;
		}
		buffer->bin_buffer_size = len;

		/* perform second read to fill buffer */
187
188
189
190
191
192
193
		down_read(&frag->frag_sem);
		if (!frag->frag_dead)
			len = buffer->bin_attr->read(buffer->item,
						     buffer->bin_buffer, len);
		else
			len = -ENOENT;
		up_read(&frag->frag_sem);
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
		if (len < 0) {
			retval = len;
			vfree(buffer->bin_buffer);
			buffer->bin_buffer_size = 0;
			buffer->bin_buffer = NULL;
			goto out;
		}

		buffer->needs_read_fill = 0;
	}

	retval = simple_read_from_buffer(buf, count, ppos, buffer->bin_buffer,
					buffer->bin_buffer_size);
out:
	mutex_unlock(&buffer->mutex);
	return retval;
}

212
213
214
215

/**
 *	fill_write_buffer - copy buffer from userspace.
 *	@buffer:	data buffer for file.
216
 *	@buf:		data from user.
217
218
219
220
221
222
223
224
225
226
227
228
 *	@count:		number of bytes in @userbuf.
 *
 *	Allocate @buffer->page if it hasn't been already, then
 *	copy the user-supplied buffer into it.
 */

static int
fill_write_buffer(struct configfs_buffer * buffer, const char __user * buf, size_t count)
{
	int error;

	if (!buffer->page)
229
		buffer->page = (char *)__get_free_pages(GFP_KERNEL, 0);
230
231
232
	if (!buffer->page)
		return -ENOMEM;

233
234
	if (count >= SIMPLE_ATTR_SIZE)
		count = SIMPLE_ATTR_SIZE - 1;
235
236
	error = copy_from_user(buffer->page,buf,count);
	buffer->needs_read_fill = 1;
237
238
239
	/* 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;
240
241
242
243
	return error ? -EFAULT : count;
}

static int
244
flush_write_buffer(struct file *file, struct configfs_buffer *buffer, size_t count)
245
{
246
247
248
249
250
251
252
253
	struct configfs_fragment *frag = to_frag(file);
	int res = -ENOENT;

	down_read(&frag->frag_sem);
	if (!frag->frag_dead)
		res = buffer->attr->store(buffer->item, buffer->page, count);
	up_read(&frag->frag_sem);
	return res;
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
}


/**
 *	configfs_write_file - write an attribute.
 *	@file:	file pointer
 *	@buf:	data to write
 *	@count:	number of bytes
 *	@ppos:	starting offset
 *
 *	Similar to configfs_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 config_item 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
 *	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.
 */

static ssize_t
configfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
{
277
	struct configfs_buffer *buffer = file->private_data;
278
	ssize_t len;
279

280
	mutex_lock(&buffer->mutex);
281
282
	len = fill_write_buffer(buffer, buf, count);
	if (len > 0)
283
		len = flush_write_buffer(file, buffer, len);
284
285
	if (len > 0)
		*ppos += len;
286
	mutex_unlock(&buffer->mutex);
287
	return len;
288
289
}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
/**
 *	configfs_write_bin_file - write a binary attribute.
 *	@file:	file pointer
 *	@buf:	data to write
 *	@count:	number of bytes
 *	@ppos:	starting offset
 *
 *	Writing to a binary attribute file is similar to a normal read.
 *	We buffer the consecutive writes (binary attribute files do not
 *	support lseek) in a continuously growing buffer, but we don't
 *	commit until the close of the file.
 */

static ssize_t
configfs_write_bin_file(struct file *file, const char __user *buf,
			size_t count, loff_t *ppos)
{
	struct configfs_buffer *buffer = file->private_data;
	void *tbuf = NULL;
	ssize_t len;

	mutex_lock(&buffer->mutex);

	/* we don't support switching read/write modes */
	if (buffer->read_in_progress) {
		len = -ETXTBSY;
		goto out;
	}
318
	buffer->write_in_progress = true;
319
320
321
322

	/* buffer grows? */
	if (*ppos + count > buffer->bin_buffer_size) {

323
324
		if (buffer->cb_max_size &&
			*ppos + count > buffer->cb_max_size) {
325
			len = -EFBIG;
326
			goto out;
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
		}

		tbuf = vmalloc(*ppos + count);
		if (tbuf == NULL) {
			len = -ENOMEM;
			goto out;
		}

		/* copy old contents */
		if (buffer->bin_buffer) {
			memcpy(tbuf, buffer->bin_buffer,
				buffer->bin_buffer_size);
			vfree(buffer->bin_buffer);
		}

		/* clear the new area */
		memset(tbuf + buffer->bin_buffer_size, 0,
			*ppos + count - buffer->bin_buffer_size);
		buffer->bin_buffer = tbuf;
		buffer->bin_buffer_size = *ppos + count;
	}

	len = simple_write_to_buffer(buffer->bin_buffer,
			buffer->bin_buffer_size, ppos, buf, count);
out:
	mutex_unlock(&buffer->mutex);
	return len;
}

356
static int __configfs_open_file(struct inode *inode, struct file *file, int type)
357
{
358
	struct dentry *dentry = file->f_path.dentry;
359
	struct configfs_fragment *frag = to_frag(file);
360
361
362
	struct configfs_attribute *attr;
	struct configfs_buffer *buffer;
	int error;
363

364
365
366
367
	error = -ENOMEM;
	buffer = kzalloc(sizeof(struct configfs_buffer), GFP_KERNEL);
	if (!buffer)
		goto out;
368

369
370
371
372
373
	error = -ENOENT;
	down_read(&frag->frag_sem);
	if (unlikely(frag->frag_dead))
		goto out_free_buffer;

374
	error = -EINVAL;
375
	buffer->item = to_item(dentry->d_parent);
376
377
378
379
380
381
382
383
384
385
386
387
388
	if (!buffer->item)
		goto out_free_buffer;

	attr = to_attr(dentry);
	if (!attr)
		goto out_put_item;

	if (type & CONFIGFS_ITEM_BIN_ATTR) {
		buffer->bin_attr = to_bin_attr(dentry);
		buffer->cb_max_size = buffer->bin_attr->cb_max_size;
	} else {
		buffer->attr = attr;
	}
389

390
	buffer->owner = attr->ca_owner;
391
	/* Grab the module reference for this attribute if we have one */
392
393
394
	error = -ENODEV;
	if (!try_module_get(buffer->owner))
		goto out_put_item;
395

396
397
398
399
400
	error = -EACCES;
	if (!buffer->item->ci_type)
		goto out_put_module;

	buffer->ops = buffer->item->ci_type->ct_item_ops;
401
402
403
404
405
406

	/* File needs write support.
	 * The inode's perms must say it's ok,
	 * and we must have a store method.
	 */
	if (file->f_mode & FMODE_WRITE) {
407
		if (!(inode->i_mode & S_IWUGO))
408
			goto out_put_module;
409
		if ((type & CONFIGFS_ITEM_ATTR) && !attr->store)
410
411
412
			goto out_put_module;
		if ((type & CONFIGFS_ITEM_BIN_ATTR) && !buffer->bin_attr->write)
			goto out_put_module;
413
414
415
416
417
418
419
	}

	/* 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) {
420
		if (!(inode->i_mode & S_IRUGO))
421
			goto out_put_module;
422
		if ((type & CONFIGFS_ITEM_ATTR) && !attr->show)
423
424
425
			goto out_put_module;
		if ((type & CONFIGFS_ITEM_BIN_ATTR) && !buffer->bin_attr->read)
			goto out_put_module;
426
427
	}

428
	mutex_init(&buffer->mutex);
429
	buffer->needs_read_fill = 1;
430
431
	buffer->read_in_progress = false;
	buffer->write_in_progress = false;
432
	file->private_data = buffer;
433
	up_read(&frag->frag_sem);
434
	return 0;
435

436
437
438
439
440
out_put_module:
	module_put(buffer->owner);
out_put_item:
	config_item_put(buffer->item);
out_free_buffer:
441
	up_read(&frag->frag_sem);
442
443
	kfree(buffer);
out:
444
445
446
	return error;
}

447
static int configfs_release(struct inode *inode, struct file *filp)
448
{
449
450
451
452
453
454
455
	struct configfs_buffer *buffer = filp->private_data;

	module_put(buffer->owner);
	if (buffer->page)
		free_page((unsigned long)buffer->page);
	mutex_destroy(&buffer->mutex);
	kfree(buffer);
456
457
458
	return 0;
}

459
460
static int configfs_open_file(struct inode *inode, struct file *filp)
{
461
	return __configfs_open_file(inode, filp, CONFIGFS_ITEM_ATTR);
462
463
464
465
}

static int configfs_open_bin_file(struct inode *inode, struct file *filp)
{
466
	return __configfs_open_file(inode, filp, CONFIGFS_ITEM_BIN_ATTR);
467
468
}

469
static int configfs_release_bin_file(struct inode *inode, struct file *file)
470
{
471
	struct configfs_buffer *buffer = file->private_data;
472

473
	buffer->read_in_progress = false;
474
475

	if (buffer->write_in_progress) {
476
		struct configfs_fragment *frag = to_frag(file);
477
		buffer->write_in_progress = false;
478

479
480
481
482
483
484
485
486
		down_read(&frag->frag_sem);
		if (!frag->frag_dead) {
			/* result of ->release() is ignored */
			buffer->bin_attr->write(buffer->item,
					buffer->bin_buffer,
					buffer->bin_buffer_size);
		}
		up_read(&frag->frag_sem);
487
488
489
490
491
492
493
		/* vfree on NULL is safe */
		vfree(buffer->bin_buffer);
		buffer->bin_buffer = NULL;
		buffer->bin_buffer_size = 0;
		buffer->needs_read_fill = 1;
	}

494
495
	configfs_release(inode, file);
	return 0;
496
497
498
}


499
const struct file_operations configfs_file_operations = {
500
501
502
503
504
505
506
	.read		= configfs_read_file,
	.write		= configfs_write_file,
	.llseek		= generic_file_llseek,
	.open		= configfs_open_file,
	.release	= configfs_release,
};

507
508
509
510
511
512
513
514
const struct file_operations configfs_bin_file_operations = {
	.read		= configfs_read_bin_file,
	.write		= configfs_write_bin_file,
	.llseek		= NULL,		/* bin file is not seekable */
	.open		= configfs_open_bin_file,
	.release	= configfs_release_bin_file,
};

515
516
517
518
519
520
521
522
/**
 *	configfs_create_file - create an attribute file for an item.
 *	@item:	item we're creating for.
 *	@attr:	atrribute descriptor.
 */

int configfs_create_file(struct config_item * item, const struct configfs_attribute * attr)
{
523
524
525
526
	struct dentry *dir = item->ci_dentry;
	struct configfs_dirent *parent_sd = dir->d_fsdata;
	umode_t mode = (attr->ca_mode & S_IALLUGO) | S_IFREG;
	int error = 0;
527

Al Viro's avatar
Al Viro committed
528
	inode_lock_nested(d_inode(dir), I_MUTEX_NORMAL);
529
	error = configfs_make_dirent(parent_sd, NULL, (void *) attr, mode,
530
				     CONFIGFS_ITEM_ATTR, parent_sd->s_frag);
Al Viro's avatar
Al Viro committed
531
	inode_unlock(d_inode(dir));
532
533

	return error;
534
535
}

536
537
538
539
540
541
542
543
544
545
546
547
548
549
/**
 *	configfs_create_bin_file - create a binary attribute file for an item.
 *	@item:	item we're creating for.
 *	@attr:	atrribute descriptor.
 */

int configfs_create_bin_file(struct config_item *item,
		const struct configfs_bin_attribute *bin_attr)
{
	struct dentry *dir = item->ci_dentry;
	struct configfs_dirent *parent_sd = dir->d_fsdata;
	umode_t mode = (bin_attr->cb_attr.ca_mode & S_IALLUGO) | S_IFREG;
	int error = 0;

Al Viro's avatar
Al Viro committed
550
	inode_lock_nested(dir->d_inode, I_MUTEX_NORMAL);
551
	error = configfs_make_dirent(parent_sd, NULL, (void *) bin_attr, mode,
552
				     CONFIGFS_ITEM_BIN_ATTR, parent_sd->s_frag);
Al Viro's avatar
Al Viro committed
553
	inode_unlock(dir->d_inode);
554
555
556

	return error;
}