2
* fs/sysfs/bin.c - sysfs binary file implementation
4
* Copyright (c) 2003 Patrick Mochel
5
* Copyright (c) 2003 Matthew Wilcox
6
* Copyright (c) 2004 Silicon Graphics, Inc.
7
* Copyright (c) 2007 SUSE Linux Products GmbH
8
* Copyright (c) 2007 Tejun Heo <teheo@suse.de>
10
* This file is released under the GPLv2.
12
* Please see Documentation/filesystems/sysfs.txt for more information.
17
#include <linux/errno.h>
19
#include <linux/kernel.h>
20
#include <linux/kobject.h>
21
#include <linux/module.h>
22
#include <linux/slab.h>
23
#include <linux/mutex.h>
26
#include <asm/uaccess.h>
31
* There's one bin_buffer for each open file.
33
* filp->private_data points to bin_buffer and
34
* sysfs_dirent->s_bin_attr.buffers points to a the bin_buffer s
35
* sysfs_dirent->s_bin_attr.buffers is protected by sysfs_bin_lock
37
static DEFINE_MUTEX(sysfs_bin_lock);
43
const struct vm_operations_struct *vm_ops;
45
struct hlist_node list;
49
fill_read(struct file *file, char *buffer, loff_t off, size_t count)
51
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
52
struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
53
struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
56
/* need attr_sd for attr, its parent for kobj */
57
if (!sysfs_get_active(attr_sd))
62
rc = attr->read(file, kobj, attr, buffer, off, count);
64
sysfs_put_active(attr_sd);
70
read(struct file *file, char __user *userbuf, size_t bytes, loff_t *off)
72
struct bin_buffer *bb = file->private_data;
73
int size = file->f_path.dentry->d_inode->i_size;
75
int count = min_t(size_t, bytes, PAGE_SIZE);
84
if (offs + count > size)
88
temp = kmalloc(count, GFP_KERNEL);
92
mutex_lock(&bb->mutex);
94
count = fill_read(file, bb->buffer, offs, count);
96
mutex_unlock(&bb->mutex);
100
memcpy(temp, bb->buffer, count);
102
mutex_unlock(&bb->mutex);
104
if (copy_to_user(userbuf, temp, count)) {
109
pr_debug("offs = %lld, *off = %lld, count = %d\n", offs, *off, count);
119
flush_write(struct file *file, char *buffer, loff_t offset, size_t count)
121
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
122
struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
123
struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
126
/* need attr_sd for attr, its parent for kobj */
127
if (!sysfs_get_active(attr_sd))
132
rc = attr->write(file, kobj, attr, buffer, offset, count);
134
sysfs_put_active(attr_sd);
139
static ssize_t write(struct file *file, const char __user *userbuf,
140
size_t bytes, loff_t *off)
142
struct bin_buffer *bb = file->private_data;
143
int size = file->f_path.dentry->d_inode->i_size;
145
int count = min_t(size_t, bytes, PAGE_SIZE);
154
if (offs + count > size)
158
temp = memdup_user(userbuf, count);
160
return PTR_ERR(temp);
162
mutex_lock(&bb->mutex);
164
memcpy(bb->buffer, temp, count);
166
count = flush_write(file, bb->buffer, offs, count);
167
mutex_unlock(&bb->mutex);
176
static void bin_vma_open(struct vm_area_struct *vma)
178
struct file *file = vma->vm_file;
179
struct bin_buffer *bb = file->private_data;
180
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
185
if (!sysfs_get_active(attr_sd))
188
if (bb->vm_ops->open)
189
bb->vm_ops->open(vma);
191
sysfs_put_active(attr_sd);
194
static int bin_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
196
struct file *file = vma->vm_file;
197
struct bin_buffer *bb = file->private_data;
198
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
202
return VM_FAULT_SIGBUS;
204
if (!sysfs_get_active(attr_sd))
205
return VM_FAULT_SIGBUS;
207
ret = VM_FAULT_SIGBUS;
208
if (bb->vm_ops->fault)
209
ret = bb->vm_ops->fault(vma, vmf);
211
sysfs_put_active(attr_sd);
215
static int bin_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
217
struct file *file = vma->vm_file;
218
struct bin_buffer *bb = file->private_data;
219
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
223
return VM_FAULT_SIGBUS;
225
if (!sysfs_get_active(attr_sd))
226
return VM_FAULT_SIGBUS;
229
if (bb->vm_ops->page_mkwrite)
230
ret = bb->vm_ops->page_mkwrite(vma, vmf);
232
sysfs_put_active(attr_sd);
236
static int bin_access(struct vm_area_struct *vma, unsigned long addr,
237
void *buf, int len, int write)
239
struct file *file = vma->vm_file;
240
struct bin_buffer *bb = file->private_data;
241
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
247
if (!sysfs_get_active(attr_sd))
251
if (bb->vm_ops->access)
252
ret = bb->vm_ops->access(vma, addr, buf, len, write);
254
sysfs_put_active(attr_sd);
259
static int bin_set_policy(struct vm_area_struct *vma, struct mempolicy *new)
261
struct file *file = vma->vm_file;
262
struct bin_buffer *bb = file->private_data;
263
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
269
if (!sysfs_get_active(attr_sd))
273
if (bb->vm_ops->set_policy)
274
ret = bb->vm_ops->set_policy(vma, new);
276
sysfs_put_active(attr_sd);
280
static struct mempolicy *bin_get_policy(struct vm_area_struct *vma,
283
struct file *file = vma->vm_file;
284
struct bin_buffer *bb = file->private_data;
285
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
286
struct mempolicy *pol;
289
return vma->vm_policy;
291
if (!sysfs_get_active(attr_sd))
292
return vma->vm_policy;
294
pol = vma->vm_policy;
295
if (bb->vm_ops->get_policy)
296
pol = bb->vm_ops->get_policy(vma, addr);
298
sysfs_put_active(attr_sd);
302
static int bin_migrate(struct vm_area_struct *vma, const nodemask_t *from,
303
const nodemask_t *to, unsigned long flags)
305
struct file *file = vma->vm_file;
306
struct bin_buffer *bb = file->private_data;
307
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
313
if (!sysfs_get_active(attr_sd))
317
if (bb->vm_ops->migrate)
318
ret = bb->vm_ops->migrate(vma, from, to, flags);
320
sysfs_put_active(attr_sd);
325
static const struct vm_operations_struct bin_vm_ops = {
326
.open = bin_vma_open,
328
.page_mkwrite = bin_page_mkwrite,
329
.access = bin_access,
331
.set_policy = bin_set_policy,
332
.get_policy = bin_get_policy,
333
.migrate = bin_migrate,
337
static int mmap(struct file *file, struct vm_area_struct *vma)
339
struct bin_buffer *bb = file->private_data;
340
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
341
struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
342
struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
345
mutex_lock(&bb->mutex);
347
/* need attr_sd for attr, its parent for kobj */
349
if (!sysfs_get_active(attr_sd))
356
rc = attr->mmap(file, kobj, attr, vma);
361
* PowerPC's pci_mmap of legacy_mem uses shmem_zero_setup()
362
* to satisfy versions of X which crash if the mmap fails: that
363
* substitutes a new vm_file, and we don't then want bin_vm_ops.
365
if (vma->vm_file != file)
369
if (bb->mmapped && bb->vm_ops != vma->vm_ops)
373
* It is not possible to successfully wrap close.
374
* So error if someone is trying to use close.
377
if (vma->vm_ops && vma->vm_ops->close)
382
bb->vm_ops = vma->vm_ops;
383
vma->vm_ops = &bin_vm_ops;
385
sysfs_put_active(attr_sd);
387
mutex_unlock(&bb->mutex);
392
static int open(struct inode * inode, struct file * file)
394
struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
395
struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
396
struct bin_buffer *bb = NULL;
399
/* binary file operations requires both @sd and its parent */
400
if (!sysfs_get_active(attr_sd))
404
if ((file->f_mode & FMODE_WRITE) && !(attr->write || attr->mmap))
406
if ((file->f_mode & FMODE_READ) && !(attr->read || attr->mmap))
410
bb = kzalloc(sizeof(*bb), GFP_KERNEL);
414
bb->buffer = kmalloc(PAGE_SIZE, GFP_KERNEL);
418
mutex_init(&bb->mutex);
420
file->private_data = bb;
422
mutex_lock(&sysfs_bin_lock);
423
hlist_add_head(&bb->list, &attr_sd->s_bin_attr.buffers);
424
mutex_unlock(&sysfs_bin_lock);
426
/* open succeeded, put active references */
427
sysfs_put_active(attr_sd);
431
sysfs_put_active(attr_sd);
436
static int release(struct inode * inode, struct file * file)
438
struct bin_buffer *bb = file->private_data;
440
mutex_lock(&sysfs_bin_lock);
441
hlist_del(&bb->list);
442
mutex_unlock(&sysfs_bin_lock);
449
const struct file_operations bin_fops = {
453
.llseek = generic_file_llseek,
459
void unmap_bin_file(struct sysfs_dirent *attr_sd)
461
struct bin_buffer *bb;
462
struct hlist_node *tmp;
464
if (sysfs_type(attr_sd) != SYSFS_KOBJ_BIN_ATTR)
467
mutex_lock(&sysfs_bin_lock);
469
hlist_for_each_entry(bb, tmp, &attr_sd->s_bin_attr.buffers, list) {
470
struct inode *inode = bb->file->f_path.dentry->d_inode;
472
unmap_mapping_range(inode->i_mapping, 0, 0, 1);
475
mutex_unlock(&sysfs_bin_lock);
479
* sysfs_create_bin_file - create binary file for object.
481
* @attr: attribute descriptor.
484
int sysfs_create_bin_file(struct kobject *kobj,
485
const struct bin_attribute *attr)
487
BUG_ON(!kobj || !kobj->sd || !attr);
489
return sysfs_add_file(kobj->sd, &attr->attr, SYSFS_KOBJ_BIN_ATTR);
494
* sysfs_remove_bin_file - remove binary file for object.
496
* @attr: attribute descriptor.
499
void sysfs_remove_bin_file(struct kobject *kobj,
500
const struct bin_attribute *attr)
502
sysfs_hash_and_remove(kobj->sd, NULL, attr->attr.name);
505
EXPORT_SYMBOL_GPL(sysfs_create_bin_file);
506
EXPORT_SYMBOL_GPL(sysfs_remove_bin_file);