fs/sysfs/bin.c

   1 /*
   2  * fs/sysfs/bin.c - sysfs binary file implementation
   3  *
   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>
   9  *
  10  * This file is released under the GPLv2.
  11  *
  12  * Please see Documentation/filesystems/sysfs.txt for more information.
  13  */
  14
  15 #undef DEBUG
  16
  17 #include <linux/errno.h>
  18 #include <linux/fs.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>
  24 #include <linux/mm.h>
  25
  26 #include <asm/uaccess.h>
  27
  28 #include "sysfs.h"
  29
  30 /*
  31  * There's one bin_buffer for each open file.
  32  *
  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
  36  */
  37 static DEFINE_MUTEX(sysfs_bin_lock);
  38
  39 struct bin_buffer {
  40         struct mutex                    mutex;
  41         void                            *buffer;
  42         int                             mmapped;
  43         struct vm_operations_struct     *vm_ops;
  44         struct file                     *file;
  45         struct hlist_node               list;
  46 };
  47
  48 static int
  49 fill_read(struct dentry *dentry, char *buffer, loff_t off, size_t count)
  50 {
  51         struct sysfs_dirent *attr_sd = 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;
  54         int rc;
  55
  56         /* need attr_sd for attr, its parent for kobj */
  57         if (!sysfs_get_active_two(attr_sd))
  58                 return -ENODEV;
  59
  60         rc = -EIO;
  61         if (attr->read)
  62                 rc = attr->read(kobj, attr, buffer, off, count);
  63
  64         sysfs_put_active_two(attr_sd);
  65
  66         return rc;
  67 }
  68
  69 static ssize_t
  70 read(struct file *file, char __user *userbuf, size_t bytes, loff_t *off)
  71 {
  72         struct bin_buffer *bb = file->private_data;
  73         struct dentry *dentry = file->f_path.dentry;
  74         int size = dentry->d_inode->i_size;
  75         loff_t offs = *off;
  76         int count = min_t(size_t, bytes, PAGE_SIZE);
  77         char *temp;
  78
  79         if (!bytes)
  80                 return 0;
  81
  82         if (size) {
  83                 if (offs > size)
  84                         return 0;
  85                 if (offs + count > size)
  86                         count = size - offs;
  87         }
  88
  89         temp = kmalloc(count, GFP_KERNEL);
  90         if (!temp)
  91                 return -ENOMEM;
  92
  93         mutex_lock(&bb->mutex);
  94
  95         count = fill_read(dentry, bb->buffer, offs, count);
  96         if (count < 0) {
  97                 mutex_unlock(&bb->mutex);
  98                 goto out_free;
  99         }
 100
 101         memcpy(temp, bb->buffer, count);
 102
 103         mutex_unlock(&bb->mutex);
 104
 105         if (copy_to_user(userbuf, temp, count)) {
 106                 count = -EFAULT;
 107                 goto out_free;
 108         }
 109
 110         pr_debug("offs = %lld, *off = %lld, count = %d\n", offs, *off, count);
 111
 112         *off = offs + count;
 113
 114  out_free:
 115         kfree(temp);
 116         return count;
 117 }
 118
 119 static int
 120 flush_write(struct dentry *dentry, char *buffer, loff_t offset, size_t count)
 121 {
 122         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
 123         struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
 124         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
 125         int rc;
 126
 127         /* need attr_sd for attr, its parent for kobj */
 128         if (!sysfs_get_active_two(attr_sd))
 129                 return -ENODEV;
 130
 131         rc = -EIO;
 132         if (attr->write)
 133                 rc = attr->write(kobj, attr, buffer, offset, count);
 134
 135         sysfs_put_active_two(attr_sd);
 136
 137         return rc;
 138 }
 139
 140 static ssize_t write(struct file *file, const char __user *userbuf,
 141                      size_t bytes, loff_t *off)
 142 {
 143         struct bin_buffer *bb = file->private_data;
 144         struct dentry *dentry = file->f_path.dentry;
 145         int size = dentry->d_inode->i_size;
 146         loff_t offs = *off;
 147         int count = min_t(size_t, bytes, PAGE_SIZE);
 148         char *temp;
 149
 150         if (!bytes)
 151                 return 0;
 152
 153         if (size) {
 154                 if (offs > size)
 155                         return 0;
 156                 if (offs + count > size)
 157                         count = size - offs;
 158         }
 159
 160         temp = kmalloc(count, GFP_KERNEL);
 161         if (!temp)
 162                 return -ENOMEM;
 163
 164         if (copy_from_user(temp, userbuf, count)) {
 165                 count = -EFAULT;
 166                 goto out_free;
 167         }
 168
 169         mutex_lock(&bb->mutex);
 170
 171         memcpy(bb->buffer, temp, count);
 172
 173         count = flush_write(dentry, bb->buffer, offs, count);
 174         mutex_unlock(&bb->mutex);
 175
 176         if (count > 0)
 177                 *off = offs + count;
 178
 179 out_free:
 180         kfree(temp);
 181         return count;
 182 }
 183
 184 static void bin_vma_open(struct vm_area_struct *vma)
 185 {
 186         struct file *file = vma->vm_file;
 187         struct bin_buffer *bb = file->private_data;
 188         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 189
 190         if (!bb->vm_ops || !bb->vm_ops->open)
 191                 return;
 192
 193         if (!sysfs_get_active_two(attr_sd))
 194                 return;
 195
 196         bb->vm_ops->open(vma);
 197
 198         sysfs_put_active_two(attr_sd);
 199 }
 200
 201 static void bin_vma_close(struct vm_area_struct *vma)
 202 {
 203         struct file *file = vma->vm_file;
 204         struct bin_buffer *bb = file->private_data;
 205         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 206
 207         if (!bb->vm_ops || !bb->vm_ops->close)
 208                 return;
 209
 210         if (!sysfs_get_active_two(attr_sd))
 211                 return;
 212
 213         bb->vm_ops->close(vma);
 214
 215         sysfs_put_active_two(attr_sd);
 216 }
 217
 218 static int bin_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 219 {
 220         struct file *file = vma->vm_file;
 221         struct bin_buffer *bb = file->private_data;
 222         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 223         int ret;
 224
 225         if (!bb->vm_ops || !bb->vm_ops->fault)
 226                 return VM_FAULT_SIGBUS;
 227
 228         if (!sysfs_get_active_two(attr_sd))
 229                 return VM_FAULT_SIGBUS;
 230
 231         ret = bb->vm_ops->fault(vma, vmf);
 232
 233         sysfs_put_active_two(attr_sd);
 234         return ret;
 235 }
 236
 237 static int bin_page_mkwrite(struct vm_area_struct *vma, struct page *page)
 238 {
 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;
 242         int ret;
 243
 244         if (!bb->vm_ops || !bb->vm_ops->page_mkwrite)
 245                 return -EINVAL;
 246
 247         if (!sysfs_get_active_two(attr_sd))
 248                 return -EINVAL;
 249
 250         ret = bb->vm_ops->page_mkwrite(vma, page);
 251
 252         sysfs_put_active_two(attr_sd);
 253         return ret;
 254 }
 255
 256 static int bin_access(struct vm_area_struct *vma, unsigned long addr,
 257                   void *buf, int len, int write)
 258 {
 259         struct file *file = vma->vm_file;
 260         struct bin_buffer *bb = file->private_data;
 261         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 262         int ret;
 263
 264         if (!bb->vm_ops || !bb->vm_ops->access)
 265                 return -EINVAL;
 266
 267         if (!sysfs_get_active_two(attr_sd))
 268                 return -EINVAL;
 269
 270         ret = bb->vm_ops->access(vma, addr, buf, len, write);
 271
 272         sysfs_put_active_two(attr_sd);
 273         return ret;
 274 }
 275
 276 static struct vm_operations_struct bin_vm_ops = {
 277         .open           = bin_vma_open,
 278         .close          = bin_vma_close,
 279         .fault          = bin_fault,
 280         .page_mkwrite   = bin_page_mkwrite,
 281         .access         = bin_access,
 282 };
 283
 284 static int mmap(struct file *file, struct vm_area_struct *vma)
 285 {
 286         struct bin_buffer *bb = file->private_data;
 287         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 288         struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
 289         struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
 290         struct vm_operations_struct *vm_ops;
 291         int rc;
 292
 293         mutex_lock(&bb->mutex);
 294
 295         /* need attr_sd for attr, its parent for kobj */
 296         rc = -ENODEV;
 297         if (!sysfs_get_active_two(attr_sd))
 298                 goto out_unlock;
 299
 300         rc = -EINVAL;
 301         if (!attr->mmap)
 302                 goto out_put;
 303
 304         rc = attr->mmap(kobj, attr, vma);
 305         vm_ops = vma->vm_ops;
 306         vma->vm_ops = &bin_vm_ops;
 307         if (rc)
 308                 goto out_put;
 309
 310         rc = -EINVAL;
 311         if (bb->mmapped && bb->vm_ops != vma->vm_ops)
 312                 goto out_put;
 313
 314 #ifdef CONFIG_NUMA
 315         rc = -EINVAL;
 316         if (vm_ops && ((vm_ops->set_policy || vm_ops->get_policy || vm_ops->migrate)))
 317                 goto out_put;
 318 #endif
 319
 320         rc = 0;
 321         bb->mmapped = 1;
 322         bb->vm_ops = vm_ops;
 323 out_put:
 324         sysfs_put_active_two(attr_sd);
 325 out_unlock:
 326         mutex_unlock(&bb->mutex);
 327
 328         return rc;
 329 }
 330
 331 static int open(struct inode * inode, struct file * file)
 332 {
 333         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 334         struct bin_attribute *attr = attr_sd->s_bin_attr.bin_attr;
 335         struct bin_buffer *bb = NULL;
 336         int error;
 337
 338         /* binary file operations requires both @sd and its parent */
 339         if (!sysfs_get_active_two(attr_sd))
 340                 return -ENODEV;
 341
 342         error = -EACCES;
 343         if ((file->f_mode & FMODE_WRITE) && !(attr->write || attr->mmap))
 344                 goto err_out;
 345         if ((file->f_mode & FMODE_READ) && !(attr->read || attr->mmap))
 346                 goto err_out;
 347
 348         error = -ENOMEM;
 349         bb = kzalloc(sizeof(*bb), GFP_KERNEL);
 350         if (!bb)
 351                 goto err_out;
 352
 353         bb->buffer = kmalloc(PAGE_SIZE, GFP_KERNEL);
 354         if (!bb->buffer)
 355                 goto err_out;
 356
 357         mutex_init(&bb->mutex);
 358         bb->file = file;
 359         file->private_data = bb;
 360
 361         mutex_lock(&sysfs_bin_lock);
 362         hlist_add_head(&bb->list, &attr_sd->s_bin_attr.buffers);
 363         mutex_unlock(&sysfs_bin_lock);
 364
 365         /* open succeeded, put active references */
 366         sysfs_put_active_two(attr_sd);
 367         return 0;
 368
 369  err_out:
 370         sysfs_put_active_two(attr_sd);
 371         kfree(bb);
 372         return error;
 373 }
 374
 375 static int release(struct inode * inode, struct file * file)
 376 {
 377         struct bin_buffer *bb = file->private_data;
 378
 379         mutex_lock(&sysfs_bin_lock);
 380         hlist_del(&bb->list);
 381         mutex_unlock(&sysfs_bin_lock);
 382
 383         kfree(bb->buffer);
 384         kfree(bb);
 385         return 0;
 386 }
 387
 388 const struct file_operations bin_fops = {
 389         .read           = read,
 390         .write          = write,
 391         .mmap           = mmap,
 392         .llseek         = generic_file_llseek,
 393         .open           = open,
 394         .release        = release,
 395 };
 396
 397
 398 void unmap_bin_file(struct sysfs_dirent *attr_sd)
 399 {
 400         struct bin_buffer *bb;
 401         struct hlist_node *tmp;
 402
 403         if (sysfs_type(attr_sd) != SYSFS_KOBJ_BIN_ATTR)
 404                 return;
 405
 406         mutex_lock(&sysfs_bin_lock);
 407
 408         hlist_for_each_entry(bb, tmp, &attr_sd->s_bin_attr.buffers, list) {
 409                 struct inode *inode = bb->file->f_path.dentry->d_inode;
 410
 411                 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
 412         }
 413
 414         mutex_unlock(&sysfs_bin_lock);
 415 }
 416
 417 /**
 418  *      sysfs_create_bin_file - create binary file for object.
 419  *      @kobj:  object.
 420  *      @attr:  attribute descriptor.
 421  */
 422
 423 int sysfs_create_bin_file(struct kobject * kobj, struct bin_attribute * attr)
 424 {
 425         BUG_ON(!kobj || !kobj->sd || !attr);
 426
 427         return sysfs_add_file(kobj->sd, &attr->attr, SYSFS_KOBJ_BIN_ATTR);
 428 }
 429
 430
 431 /**
 432  *      sysfs_remove_bin_file - remove binary file for object.
 433  *      @kobj:  object.
 434  *      @attr:  attribute descriptor.
 435  */
 436
 437 void sysfs_remove_bin_file(struct kobject * kobj, struct bin_attribute * attr)
 438 {
 439         sysfs_hash_and_remove(kobj->sd, attr->attr.name);
 440 }
 441
 442 EXPORT_SYMBOL_GPL(sysfs_create_bin_file);
 443 EXPORT_SYMBOL_GPL(sysfs_remove_bin_file);