SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/sysfs/file.c

   1 /*
   2  * file.c - operations for regular (text) files.
   3  */
   4
   5 #include <linux/module.h>
   6 #include <linux/fsnotify.h>
   7 #include <linux/kobject.h>
   8 #include <linux/namei.h>
   9 #include <linux/poll.h>
  10 #include <linux/list.h>
  11 #include <asm/uaccess.h>
  12 #include <asm/semaphore.h>
  13
  14 #include "sysfs.h"
  15
  16 #define to_sattr(a) container_of(a,struct subsys_attribute, attr)
  17
  18 /*
  19  * Subsystem file operations.
  20  * These operations allow subsystems to have files that can be
  21  * read/written.
  22  */
  23 static ssize_t
  24 subsys_attr_show(struct kobject * kobj, struct attribute * attr, char * page)
  25 {
  26         struct kset *kset = to_kset(kobj);
  27         struct subsys_attribute * sattr = to_sattr(attr);
  28         ssize_t ret = -EIO;
  29
  30         if (sattr->show)
  31                 ret = sattr->show(kset, page);
  32         return ret;
  33 }
  34
  35 static ssize_t
  36 subsys_attr_store(struct kobject * kobj, struct attribute * attr,
  37                   const char * page, size_t count)
  38 {
  39         struct kset *kset = to_kset(kobj);
  40         struct subsys_attribute * sattr = to_sattr(attr);
  41         ssize_t ret = -EIO;
  42
  43         if (sattr->store)
  44                 ret = sattr->store(kset, page, count);
  45         return ret;
  46 }
  47
  48 static struct sysfs_ops subsys_sysfs_ops = {
  49         .show   = subsys_attr_show,
  50         .store  = subsys_attr_store,
  51 };
  52
  53 struct sysfs_buffer {
  54         size_t                  count;
  55         loff_t                  pos;
  56         char                    * page;
  57         struct sysfs_ops        * ops;
  58         struct semaphore        sem;
  59         int                     needs_read_fill;
  60         int                     event;
  61 };
  62
  63 /**
  64  *      fill_read_buffer - allocate and fill buffer from object.
  65  *      @dentry:        dentry pointer.
  66  *      @buffer:        data buffer for file.
  67  *
  68  *      Allocate @buffer->page, if it hasn't been already, then call the
  69  *      kobject's show() method to fill the buffer with this attribute's
  70  *      data.
  71  *      This is called only once, on the file's first read unless an error
  72  *      is returned.
  73  */
  74 static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
  75 {
  76         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
  77         struct kobject *kobj = attr_sd->s_parent->s_elem.dir.kobj;
  78         struct sysfs_ops * ops = buffer->ops;
  79         int ret = 0;
  80         ssize_t count;
  81
  82         if (!buffer->page)
  83                 buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
  84         if (!buffer->page)
  85                 return -ENOMEM;
  86
  87         /* need attr_sd for attr and ops, its parent for kobj */
  88         if (!sysfs_get_active_two(attr_sd))
  89                 return -ENODEV;
  90
  91         buffer->event = atomic_read(&attr_sd->s_event);
  92         count = ops->show(kobj, attr_sd->s_elem.attr.attr, buffer->page);
  93
  94         sysfs_put_active_two(attr_sd);
  95
  96         BUG_ON(count > (ssize_t)PAGE_SIZE);
  97         if (count >= 0) {
  98                 buffer->needs_read_fill = 0;
  99                 buffer->count = count;
 100         } else {
 101                 ret = count;
 102         }
 103         return ret;
 104 }
 105
 106 /**
 107  *      sysfs_read_file - read an attribute.
 108  *      @file:  file pointer.
 109  *      @buf:   buffer to fill.
 110  *      @count: number of bytes to read.
 111  *      @ppos:  starting offset in file.
 112  *
 113  *      Userspace wants to read an attribute file. The attribute descriptor
 114  *      is in the file's ->d_fsdata. The target object is in the directory's
 115  *      ->d_fsdata.
 116  *
 117  *      We call fill_read_buffer() to allocate and fill the buffer from the
 118  *      object's show() method exactly once (if the read is happening from
 119  *      the beginning of the file). That should fill the entire buffer with
 120  *      all the data the object has to offer for that attribute.
 121  *      We then call flush_read_buffer() to copy the buffer to userspace
 122  *      in the increments specified.
 123  */
 124
 125 static ssize_t
 126 sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 127 {
 128         struct sysfs_buffer * buffer = file->private_data;
 129         ssize_t retval = 0;
 130
 131         down(&buffer->sem);
 132         if (buffer->needs_read_fill) {
 133                 retval = fill_read_buffer(file->f_path.dentry,buffer);
 134                 if (retval)
 135                         goto out;
 136         }
 137         pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
 138                  __FUNCTION__, count, *ppos, buffer->page);
 139         retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
 140                                          buffer->count);
 141 out:
 142         up(&buffer->sem);
 143         return retval;
 144 }
 145
 146 /**
 147  *      fill_write_buffer - copy buffer from userspace.
 148  *      @buffer:        data buffer for file.
 149  *      @buf:           data from user.
 150  *      @count:         number of bytes in @userbuf.
 151  *
 152  *      Allocate @buffer->page if it hasn't been already, then
 153  *      copy the user-supplied buffer into it.
 154  */
 155
 156 static int
 157 fill_write_buffer(struct sysfs_buffer * buffer, const char __user * buf, size_t count)
 158 {
 159         int error;
 160
 161         if (!buffer->page)
 162                 buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
 163         if (!buffer->page)
 164                 return -ENOMEM;
 165
 166         if (count >= PAGE_SIZE)
 167                 count = PAGE_SIZE - 1;
 168         error = copy_from_user(buffer->page,buf,count);
 169         buffer->needs_read_fill = 1;
 170         /* if buf is assumed to contain a string, terminate it by \0,
 171            so e.g. sscanf() can scan the string easily */
 172         buffer->page[count] = 0;
 173         return error ? -EFAULT : count;
 174 }
 175
 176
 177 /**
 178  *      flush_write_buffer - push buffer to kobject.
 179  *      @dentry:        dentry to the attribute
 180  *      @buffer:        data buffer for file.
 181  *      @count:         number of bytes
 182  *
 183  *      Get the correct pointers for the kobject and the attribute we're
 184  *      dealing with, then call the store() method for the attribute,
 185  *      passing the buffer that we acquired in fill_write_buffer().
 186  */
 187
 188 static int
 189 flush_write_buffer(struct dentry * dentry, struct sysfs_buffer * buffer, size_t count)
 190 {
 191         struct sysfs_dirent *attr_sd = dentry->d_fsdata;
 192         struct kobject *kobj = attr_sd->s_parent->s_elem.dir.kobj;
 193         struct sysfs_ops * ops = buffer->ops;
 194         int rc;
 195
 196         /* need attr_sd for attr and ops, its parent for kobj */
 197         if (!sysfs_get_active_two(attr_sd))
 198                 return -ENODEV;
 199
 200         rc = ops->store(kobj, attr_sd->s_elem.attr.attr, buffer->page, count);
 201
 202         sysfs_put_active_two(attr_sd);
 203
 204         return rc;
 205 }
 206
 207
 208 /**
 209  *      sysfs_write_file - write an attribute.
 210  *      @file:  file pointer
 211  *      @buf:   data to write
 212  *      @count: number of bytes
 213  *      @ppos:  starting offset
 214  *
 215  *      Similar to sysfs_read_file(), though working in the opposite direction.
 216  *      We allocate and fill the data from the user in fill_write_buffer(),
 217  *      then push it to the kobject in flush_write_buffer().
 218  *      There is no easy way for us to know if userspace is only doing a partial
 219  *      write, so we don't support them. We expect the entire buffer to come
 220  *      on the first write.
 221  *      Hint: if you're writing a value, first read the file, modify only the
 222  *      the value you're changing, then write entire buffer back.
 223  */
 224
 225 static ssize_t
 226 sysfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 227 {
 228         struct sysfs_buffer * buffer = file->private_data;
 229         ssize_t len;
 230
 231         down(&buffer->sem);
 232         len = fill_write_buffer(buffer, buf, count);
 233         if (len > 0)
 234                 len = flush_write_buffer(file->f_path.dentry, buffer, len);
 235         if (len > 0)
 236                 *ppos += len;
 237         up(&buffer->sem);
 238         return len;
 239 }
 240
 241 static int sysfs_open_file(struct inode *inode, struct file *file)
 242 {
 243         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 244         struct kobject *kobj = attr_sd->s_parent->s_elem.dir.kobj;
 245         struct sysfs_buffer * buffer;
 246         struct sysfs_ops * ops = NULL;
 247         int error;
 248
 249         /* need attr_sd for attr and ops, its parent for kobj */
 250         if (!sysfs_get_active_two(attr_sd))
 251                 return -ENODEV;
 252
 253         /* if the kobject has no ktype, then we assume that it is a subsystem
 254          * itself, and use ops for it.
 255          */
 256         if (kobj->kset && kobj->kset->ktype)
 257                 ops = kobj->kset->ktype->sysfs_ops;
 258         else if (kobj->ktype)
 259                 ops = kobj->ktype->sysfs_ops;
 260         else
 261                 ops = &subsys_sysfs_ops;
 262
 263         error = -EACCES;
 264
 265         /* No sysfs operations, either from having no subsystem,
 266          * or the subsystem have no operations.
 267          */
 268         if (!ops)
 269                 goto err_out;
 270
 271         /* File needs write support.
 272          * The inode's perms must say it's ok,
 273          * and we must have a store method.
 274          */
 275         if (file->f_mode & FMODE_WRITE) {
 276                 if (!(inode->i_mode & S_IWUGO) || !ops->store)
 277                         goto err_out;
 278         }
 279
 280         /* File needs read support.
 281          * The inode's perms must say it's ok, and we there
 282          * must be a show method for it.
 283          */
 284         if (file->f_mode & FMODE_READ) {
 285                 if (!(inode->i_mode & S_IRUGO) || !ops->show)
 286                         goto err_out;
 287         }
 288
 289         /* No error? Great, allocate a buffer for the file, and store it
 290          * it in file->private_data for easy access.
 291          */
 292         error = -ENOMEM;
 293         buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
 294         if (!buffer)
 295                 goto err_out;
 296
 297         init_MUTEX(&buffer->sem);
 298         buffer->needs_read_fill = 1;
 299         buffer->ops = ops;
 300         file->private_data = buffer;
 301
 302         /* open succeeded, put active references and pin attr_sd */
 303         sysfs_put_active_two(attr_sd);
 304         sysfs_get(attr_sd);
 305         return 0;
 306
 307  err_out:
 308         sysfs_put_active_two(attr_sd);
 309         return error;
 310 }
 311
 312 static int sysfs_release(struct inode * inode, struct file * filp)
 313 {
 314         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
 315         struct sysfs_buffer *buffer = filp->private_data;
 316
 317         sysfs_put(attr_sd);
 318
 319         if (buffer) {
 320                 if (buffer->page)
 321                         free_page((unsigned long)buffer->page);
 322                 kfree(buffer);
 323         }
 324         return 0;
 325 }
 326
 327 /* Sysfs attribute files are pollable.  The idea is that you read
 328  * the content and then you use 'poll' or 'select' to wait for
 329  * the content to change.  When the content changes (assuming the
 330  * manager for the kobject supports notification), poll will
 331  * return POLLERR|POLLPRI, and select will return the fd whether
 332  * it is waiting for read, write, or exceptions.
 333  * Once poll/select indicates that the value has changed, you
 334  * need to close and re-open the file, as simply seeking and reading
 335  * again will not get new data, or reset the state of 'poll'.
 336  * Reminder: this only works for attributes which actively support
 337  * it, and it is not possible to test an attribute from userspace
 338  * to see if it supports poll (Nether 'poll' or 'select' return
 339  * an appropriate error code).  When in doubt, set a suitable timeout value.
 340  */
 341 static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
 342 {
 343         struct sysfs_buffer * buffer = filp->private_data;
 344         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
 345         struct kobject *kobj = attr_sd->s_parent->s_elem.dir.kobj;
 346
 347         /* need parent for the kobj, grab both */
 348         if (!sysfs_get_active_two(attr_sd))
 349                 goto trigger;
 350
 351         poll_wait(filp, &kobj->poll, wait);
 352
 353         sysfs_put_active_two(attr_sd);
 354
 355         if (buffer->event != atomic_read(&attr_sd->s_event))
 356                 goto trigger;
 357
 358         return 0;
 359
 360  trigger:
 361         buffer->needs_read_fill = 1;
 362         return POLLERR|POLLPRI;
 363 }
 364
 365
 366 static struct dentry *step_down(struct dentry *dir, const char * name)
 367 {
 368         struct dentry * de;
 369
 370         if (dir == NULL || dir->d_inode == NULL)
 371                 return NULL;
 372
 373         mutex_lock(&dir->d_inode->i_mutex);
 374         de = lookup_one_len(name, dir, strlen(name));
 375         mutex_unlock(&dir->d_inode->i_mutex);
 376         dput(dir);
 377         if (IS_ERR(de))
 378                 return NULL;
 379         if (de->d_inode == NULL) {
 380                 dput(de);
 381                 return NULL;
 382         }
 383         return de;
 384 }
 385
 386 void sysfs_notify(struct kobject * k, char *dir, char *attr)
 387 {
 388         struct dentry *de = k->dentry;
 389         if (de)
 390                 dget(de);
 391         if (de && dir)
 392                 de = step_down(de, dir);
 393         if (de && attr)
 394                 de = step_down(de, attr);
 395         if (de) {
 396                 struct sysfs_dirent * sd = de->d_fsdata;
 397                 if (sd)
 398                         atomic_inc(&sd->s_event);
 399                 wake_up_interruptible(&k->poll);
 400                 dput(de);
 401         }
 402 }
 403 EXPORT_SYMBOL_GPL(sysfs_notify);
 404
 405 const struct file_operations sysfs_file_operations = {
 406         .read           = sysfs_read_file,
 407         .write          = sysfs_write_file,
 408         .llseek         = generic_file_llseek,
 409         .open           = sysfs_open_file,
 410         .release        = sysfs_release,
 411         .poll           = sysfs_poll,
 412 };
 413
 414
 415 int sysfs_add_file(struct dentry * dir, const struct attribute * attr, int type)
 416 {
 417         struct sysfs_dirent * parent_sd = dir->d_fsdata;
 418         umode_t mode = (attr->mode & S_IALLUGO) | S_IFREG;
 419         struct sysfs_dirent *sd;
 420         int error = 0;
 421
 422         mutex_lock(&dir->d_inode->i_mutex);
 423
 424         if (sysfs_find_dirent(parent_sd, attr->name)) {
 425                 error = -EEXIST;
 426                 goto out_unlock;
 427         }
 428
 429         sd = sysfs_new_dirent(attr->name, mode, type);
 430         if (!sd) {
 431                 error = -ENOMEM;
 432                 goto out_unlock;
 433         }
 434         sd->s_elem.attr.attr = (void *)attr;
 435         sysfs_attach_dirent(sd, parent_sd, NULL);
 436
 437  out_unlock:
 438         mutex_unlock(&dir->d_inode->i_mutex);
 439         return error;
 440 }
 441
 442
 443 /**
 444  *      sysfs_create_file - create an attribute file for an object.
 445  *      @kobj:  object we're creating for.
 446  *      @attr:  atrribute descriptor.
 447  */
 448
 449 int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
 450 {
 451         BUG_ON(!kobj || !kobj->dentry || !attr);
 452
 453         return sysfs_add_file(kobj->dentry, attr, SYSFS_KOBJ_ATTR);
 454
 455 }
 456
 457
 458 /**
 459  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
 460  * @kobj: object we're acting for.
 461  * @attr: attribute descriptor.
 462  * @group: group name.
 463  */
 464 int sysfs_add_file_to_group(struct kobject *kobj,
 465                 const struct attribute *attr, const char *group)
 466 {
 467         struct dentry *dir;
 468         int error;
 469
 470         dir = lookup_one_len(group, kobj->dentry, strlen(group));
 471         if (IS_ERR(dir))
 472                 error = PTR_ERR(dir);
 473         else {
 474                 error = sysfs_add_file(dir, attr, SYSFS_KOBJ_ATTR);
 475                 dput(dir);
 476         }
 477         return error;
 478 }
 479 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
 480
 481
 482 /**
 483  * sysfs_update_file - update the modified timestamp on an object attribute.
 484  * @kobj: object we're acting for.
 485  * @attr: attribute descriptor.
 486  */
 487 int sysfs_update_file(struct kobject * kobj, const struct attribute * attr)
 488 {
 489         struct dentry * dir = kobj->dentry;
 490         struct dentry * victim;
 491         int res = -ENOENT;
 492
 493         mutex_lock(&dir->d_inode->i_mutex);
 494         victim = lookup_one_len(attr->name, dir, strlen(attr->name));
 495         if (!IS_ERR(victim)) {
 496                 /* make sure dentry is really there */
 497                 if (victim->d_inode &&
 498                     (victim->d_parent->d_inode == dir->d_inode)) {
 499                         victim->d_inode->i_mtime = CURRENT_TIME;
 500                         fsnotify_modify(victim);
 501                         res = 0;
 502                 } else
 503                         d_drop(victim);
 504
 505                 /**
 506                  * Drop the reference acquired from lookup_one_len() above.
 507                  */
 508                 dput(victim);
 509         }
 510         mutex_unlock(&dir->d_inode->i_mutex);
 511
 512         return res;
 513 }
 514
 515
 516 /**
 517  * sysfs_chmod_file - update the modified mode value on an object attribute.
 518  * @kobj: object we're acting for.
 519  * @attr: attribute descriptor.
 520  * @mode: file permissions.
 521  *
 522  */
 523 int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 524 {
 525         struct dentry *dir = kobj->dentry;
 526         struct dentry *victim;
 527         struct inode * inode;
 528         struct iattr newattrs;
 529         int res = -ENOENT;
 530
 531         mutex_lock(&dir->d_inode->i_mutex);
 532         victim = lookup_one_len(attr->name, dir, strlen(attr->name));
 533         if (!IS_ERR(victim)) {
 534                 if (victim->d_inode &&
 535                     (victim->d_parent->d_inode == dir->d_inode)) {
 536                         inode = victim->d_inode;
 537                         mutex_lock(&inode->i_mutex);
 538                         newattrs.ia_mode = (mode & S_IALLUGO) |
 539                                                 (inode->i_mode & ~S_IALLUGO);
 540                         newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
 541                         res = notify_change(victim, &newattrs);
 542                         mutex_unlock(&inode->i_mutex);
 543                 }
 544                 dput(victim);
 545         }
 546         mutex_unlock(&dir->d_inode->i_mutex);
 547
 548         return res;
 549 }
 550 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
 551
 552
 553 /**
 554  *      sysfs_remove_file - remove an object attribute.
 555  *      @kobj:  object we're acting for.
 556  *      @attr:  attribute descriptor.
 557  *
 558  *      Hash the attribute name and kill the victim.
 559  */
 560
 561 void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
 562 {
 563         sysfs_hash_and_remove(kobj->dentry, attr->name);
 564 }
 565
 566
 567 /**
 568  * sysfs_remove_file_from_group - remove an attribute file from a group.
 569  * @kobj: object we're acting for.
 570  * @attr: attribute descriptor.
 571  * @group: group name.
 572  */
 573 void sysfs_remove_file_from_group(struct kobject *kobj,
 574                 const struct attribute *attr, const char *group)
 575 {
 576         struct dentry *dir;
 577
 578         dir = lookup_one_len(group, kobj->dentry, strlen(group));
 579         if (!IS_ERR(dir)) {
 580                 sysfs_hash_and_remove(dir, attr->name);
 581                 dput(dir);
 582         }
 583 }
 584 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
 585
 586 struct sysfs_schedule_callback_struct {
 587         struct kobject          *kobj;
 588         void                    (*func)(void *);
 589         void                    *data;
 590         struct module           *owner;
 591         struct work_struct      work;
 592 };
 593
 594 static void sysfs_schedule_callback_work(struct work_struct *work)
 595 {
 596         struct sysfs_schedule_callback_struct *ss = container_of(work,
 597                         struct sysfs_schedule_callback_struct, work);
 598
 599         (ss->func)(ss->data);
 600         kobject_put(ss->kobj);
 601         module_put(ss->owner);
 602         kfree(ss);
 603 }
 604
 605 /**
 606  * sysfs_schedule_callback - helper to schedule a callback for a kobject
 607  * @kobj: object we're acting for.
 608  * @func: callback function to invoke later.
 609  * @data: argument to pass to @func.
 610  * @owner: module owning the callback code
 611  *
 612  * sysfs attribute methods must not unregister themselves or their parent
 613  * kobject (which would amount to the same thing).  Attempts to do so will
 614  * deadlock, since unregistration is mutually exclusive with driver
 615  * callbacks.
 616  *
 617  * Instead methods can call this routine, which will attempt to allocate
 618  * and schedule a workqueue request to call back @func with @data as its
 619  * argument in the workqueue's process context.  @kobj will be pinned
 620  * until @func returns.
 621  *
 622  * Returns 0 if the request was submitted, -ENOMEM if storage could not
 623  * be allocated, -ENODEV if a reference to @owner isn't available.
 624  */
 625 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 626                 void *data, struct module *owner)
 627 {
 628         struct sysfs_schedule_callback_struct *ss;
 629
 630         if (!try_module_get(owner))
 631                 return -ENODEV;
 632         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
 633         if (!ss) {
 634                 module_put(owner);
 635                 return -ENOMEM;
 636         }
 637         kobject_get(kobj);
 638         ss->kobj = kobj;
 639         ss->func = func;
 640         ss->data = data;
 641         ss->owner = owner;
 642         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
 643         schedule_work(&ss->work);
 644         return 0;
 645 }
 646 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);
 647
 648
 649 EXPORT_SYMBOL_GPL(sysfs_create_file);
 650 EXPORT_SYMBOL_GPL(sysfs_remove_file);
 651 EXPORT_SYMBOL_GPL(sysfs_update_file);