fs/sysfs/file.c

   1 /*
   2  * fs/sysfs/file.c - sysfs regular (text) file implementation
   3  *
   4  * Copyright (c) 2001-3 Patrick Mochel
   5  * Copyright (c) 2007 SUSE Linux Products GmbH
   6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   7  *
   8  * This file is released under the GPLv2.
   9  *
  10  * Please see Documentation/filesystems/sysfs.txt for more information.
  11  */
  12
  13 #include <linux/module.h>
  14 #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>
  22 #include <linux/limits.h>
  23 #include <linux/uaccess.h>
  24 #include <linux/seq_file.h>
  25 #include <linux/mm.h>
  26
  27 #include "sysfs.h"
  28
  29 /*
  30  * There's one sysfs_open_file for each open file and one sysfs_open_dirent
  31  * for each sysfs_dirent with one or more open files.
  32  *
  33  * sysfs_dirent->s_attr.open points to sysfs_open_dirent.  s_attr.open is
  34  * protected by sysfs_open_dirent_lock.
  35  *
  36  * filp->private_data points to seq_file whose ->private points to
  37  * sysfs_open_file.  sysfs_open_files are chained at
  38  * sysfs_open_dirent->files, which is protected by sysfs_open_file_mutex.
  39  */
  40 static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
  41 static DEFINE_MUTEX(sysfs_open_file_mutex);
  42
  43 struct sysfs_open_dirent {
  44         atomic_t                refcnt;
  45         atomic_t                event;
  46         wait_queue_head_t       poll;
  47         struct list_head        files; /* goes through sysfs_open_file.list */
  48 };
  49
  50 static bool sysfs_is_bin(struct sysfs_dirent *sd)
  51 {
  52         return sysfs_type(sd) == SYSFS_KOBJ_BIN_ATTR;
  53 }
  54
  55 static struct sysfs_open_file *sysfs_of(struct file *file)
  56 {
  57         return ((struct seq_file *)file->private_data)->private;
  58 }
  59
  60 /*
  61  * Determine the kernfs_ops for the given sysfs_dirent.  This function must
  62  * be called while holding an active reference.
  63  */
  64 static const struct kernfs_ops *kernfs_ops(struct sysfs_dirent *sd)
  65 {
  66         if (!sysfs_ignore_lockdep(sd))
  67                 lockdep_assert_held(sd);
  68         return sd->s_attr.ops;
  69 }
  70
  71 /*
  72  * Determine ktype->sysfs_ops for the given sysfs_dirent.  This function
  73  * must be called while holding an active reference.
  74  */
  75 static const struct sysfs_ops *sysfs_file_ops(struct sysfs_dirent *sd)
  76 {
  77         struct kobject *kobj = sd->s_parent->priv;
  78
  79         if (!sysfs_ignore_lockdep(sd))
  80                 lockdep_assert_held(sd);
  81         return kobj->ktype ? kobj->ktype->sysfs_ops : NULL;
  82 }
  83
  84 /*
  85  * Reads on sysfs are handled through seq_file, which takes care of hairy
  86  * details like buffering and seeking.  The following function pipes
  87  * sysfs_ops->show() result through seq_file.
  88  */
  89 static int sysfs_kf_seq_show(struct seq_file *sf, void *v)
  90 {
  91         struct sysfs_open_file *of = sf->private;
  92         struct kobject *kobj = of->sd->s_parent->priv;
  93         const struct sysfs_ops *ops = sysfs_file_ops(of->sd);
  94         ssize_t count;
  95         char *buf;
  96
  97         /* acquire buffer and ensure that it's >= PAGE_SIZE */
  98         count = seq_get_buf(sf, &buf);
  99         if (count < PAGE_SIZE) {
 100                 seq_commit(sf, -1);
 101                 return 0;
 102         }
 103
 104         /*
 105          * Invoke show().  Control may reach here via seq file lseek even
 106          * if @ops->show() isn't implemented.
 107          */
 108         if (ops->show) {
 109                 count = ops->show(kobj, of->sd->priv, buf);
 110                 if (count < 0)
 111                         return count;
 112         }
 113
 114         /*
 115          * The code works fine with PAGE_SIZE return but it's likely to
 116          * indicate truncated result or overflow in normal use cases.
 117          */
 118         if (count >= (ssize_t)PAGE_SIZE) {
 119                 print_symbol("fill_read_buffer: %s returned bad count\n",
 120                         (unsigned long)ops->show);
 121                 /* Try to struggle along */
 122                 count = PAGE_SIZE - 1;
 123         }
 124         seq_commit(sf, count);
 125         return 0;
 126 }
 127
 128 static ssize_t sysfs_kf_bin_read(struct sysfs_open_file *of, char *buf,
 129                                  size_t count, loff_t pos)
 130 {
 131         struct bin_attribute *battr = of->sd->priv;
 132         struct kobject *kobj = of->sd->s_parent->priv;
 133         loff_t size = file_inode(of->file)->i_size;
 134
 135         if (!count)
 136                 return 0;
 137
 138         if (size) {
 139                 if (pos > size)
 140                         return 0;
 141                 if (pos + count > size)
 142                         count = size - pos;
 143         }
 144
 145         if (!battr->read)
 146                 return -EIO;
 147
 148         return battr->read(of->file, kobj, battr, buf, pos, count);
 149 }
 150
 151 static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)
 152 {
 153         struct sysfs_open_file *of = sf->private;
 154
 155         /*
 156          * @of->mutex nests outside active ref and is just to ensure that
 157          * the ops aren't called concurrently for the same open file.
 158          */
 159         mutex_lock(&of->mutex);
 160         if (!sysfs_get_active(of->sd))
 161                 return ERR_PTR(-ENODEV);
 162
 163         /*
 164          * The same behavior and code as single_open().  Returns !NULL if
 165          * pos is at the beginning; otherwise, NULL.
 166          */
 167         return NULL + !*ppos;
 168 }
 169
 170 static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos)
 171 {
 172         /*
 173          * The same behavior and code as single_open(), always terminate
 174          * after the initial read.
 175          */
 176         ++*ppos;
 177         return NULL;
 178 }
 179
 180 static void kernfs_seq_stop(struct seq_file *sf, void *v)
 181 {
 182         struct sysfs_open_file *of = sf->private;
 183
 184         sysfs_put_active(of->sd);
 185         mutex_unlock(&of->mutex);
 186 }
 187
 188 static int kernfs_seq_show(struct seq_file *sf, void *v)
 189 {
 190         struct sysfs_open_file *of = sf->private;
 191
 192         of->event = atomic_read(&of->sd->s_attr.open->event);
 193
 194         return of->sd->s_attr.ops->seq_show(sf, v);
 195 }
 196
 197 static const struct seq_operations kernfs_seq_ops = {
 198         .start = kernfs_seq_start,
 199         .next = kernfs_seq_next,
 200         .stop = kernfs_seq_stop,
 201         .show = kernfs_seq_show,
 202 };
 203
 204 /*
 205  * As reading a bin file can have side-effects, the exact offset and bytes
 206  * specified in read(2) call should be passed to the read callback making
 207  * it difficult to use seq_file.  Implement simplistic custom buffering for
 208  * bin files.
 209  */
 210 static ssize_t kernfs_file_direct_read(struct sysfs_open_file *of,
 211                                        char __user *user_buf, size_t count,
 212                                        loff_t *ppos)
 213 {
 214         ssize_t len = min_t(size_t, count, PAGE_SIZE);
 215         const struct kernfs_ops *ops;
 216         char *buf;
 217
 218         buf = kmalloc(len, GFP_KERNEL);
 219         if (!buf)
 220                 return -ENOMEM;
 221
 222         /*
 223          * @of->mutex nests outside active ref and is just to ensure that
 224          * the ops aren't called concurrently for the same open file.
 225          */
 226         mutex_lock(&of->mutex);
 227         if (!sysfs_get_active(of->sd)) {
 228                 len = -ENODEV;
 229                 mutex_unlock(&of->mutex);
 230                 goto out_free;
 231         }
 232
 233         ops = kernfs_ops(of->sd);
 234         if (ops->read)
 235                 len = ops->read(of, buf, len, *ppos);
 236         else
 237                 len = -EINVAL;
 238
 239         sysfs_put_active(of->sd);
 240         mutex_unlock(&of->mutex);
 241
 242         if (len < 0)
 243                 goto out_free;
 244
 245         if (copy_to_user(user_buf, buf, len)) {
 246                 len = -EFAULT;
 247                 goto out_free;
 248         }
 249
 250         *ppos += len;
 251
 252  out_free:
 253         kfree(buf);
 254         return len;
 255 }
 256
 257 /**
 258  * kernfs_file_read - kernfs vfs read callback
 259  * @file: file pointer
 260  * @user_buf: data to write
 261  * @count: number of bytes
 262  * @ppos: starting offset
 263  */
 264 static ssize_t kernfs_file_read(struct file *file, char __user *user_buf,
 265                                 size_t count, loff_t *ppos)
 266 {
 267         struct sysfs_open_file *of = sysfs_of(file);
 268
 269         if (of->sd->s_flags & SYSFS_FLAG_HAS_SEQ_SHOW)
 270                 return seq_read(file, user_buf, count, ppos);
 271         else
 272                 return kernfs_file_direct_read(of, user_buf, count, ppos);
 273 }
 274
 275 /* kernfs write callback for regular sysfs files */
 276 static ssize_t sysfs_kf_write(struct sysfs_open_file *of, char *buf,
 277                               size_t count, loff_t pos)
 278 {
 279         const struct sysfs_ops *ops = sysfs_file_ops(of->sd);
 280         struct kobject *kobj = of->sd->s_parent->priv;
 281
 282         if (!count)
 283                 return 0;
 284
 285         return ops->store(kobj, of->sd->priv, buf, count);
 286 }
 287
 288 /* kernfs write callback for bin sysfs files */
 289 static ssize_t sysfs_kf_bin_write(struct sysfs_open_file *of, char *buf,
 290                                   size_t count, loff_t pos)
 291 {
 292         struct bin_attribute *battr = of->sd->priv;
 293         struct kobject *kobj = of->sd->s_parent->priv;
 294         loff_t size = file_inode(of->file)->i_size;
 295
 296         if (size) {
 297                 if (size <= pos)
 298                         return 0;
 299                 count = min_t(ssize_t, count, size - pos);
 300         }
 301         if (!count)
 302                 return 0;
 303
 304         if (!battr->write)
 305                 return -EIO;
 306
 307         return battr->write(of->file, kobj, battr, buf, pos, count);
 308 }
 309
 310 /**
 311  * kernfs_file_write - kernfs vfs write callback
 312  * @file: file pointer
 313  * @user_buf: data to write
 314  * @count: number of bytes
 315  * @ppos: starting offset
 316  *
 317  * Copy data in from userland and pass it to the matching kernfs write
 318  * operation.
 319  *
 320  * There is no easy way for us to know if userspace is only doing a partial
 321  * write, so we don't support them. We expect the entire buffer to come on
 322  * the first write.  Hint: if you're writing a value, first read the file,
 323  * modify only the the value you're changing, then write entire buffer
 324  * back.
 325  */
 326 static ssize_t kernfs_file_write(struct file *file, const char __user *user_buf,
 327                                  size_t count, loff_t *ppos)
 328 {
 329         struct sysfs_open_file *of = sysfs_of(file);
 330         ssize_t len = min_t(size_t, count, PAGE_SIZE);
 331         const struct kernfs_ops *ops;
 332         char *buf;
 333
 334         buf = kmalloc(len + 1, GFP_KERNEL);
 335         if (!buf)
 336                 return -ENOMEM;
 337
 338         if (copy_from_user(buf, user_buf, len)) {
 339                 len = -EFAULT;
 340                 goto out_free;
 341         }
 342         buf[len] = '\0';        /* guarantee string termination */
 343
 344         /*
 345          * @of->mutex nests outside active ref and is just to ensure that
 346          * the ops aren't called concurrently for the same open file.
 347          */
 348         mutex_lock(&of->mutex);
 349         if (!sysfs_get_active(of->sd)) {
 350                 mutex_unlock(&of->mutex);
 351                 len = -ENODEV;
 352                 goto out_free;
 353         }
 354
 355         ops = kernfs_ops(of->sd);
 356         if (ops->write)
 357                 len = ops->write(of, buf, len, *ppos);
 358         else
 359                 len = -EINVAL;
 360
 361         sysfs_put_active(of->sd);
 362         mutex_unlock(&of->mutex);
 363
 364         if (len > 0)
 365                 *ppos += len;
 366 out_free:
 367         kfree(buf);
 368         return len;
 369 }
 370
 371 static int sysfs_kf_bin_mmap(struct sysfs_open_file *of,
 372                              struct vm_area_struct *vma)
 373 {
 374         struct bin_attribute *battr = of->sd->priv;
 375         struct kobject *kobj = of->sd->s_parent->priv;
 376
 377         if (!battr->mmap)
 378                 return -ENODEV;
 379
 380         return battr->mmap(of->file, kobj, battr, vma);
 381 }
 382
 383 static void kernfs_vma_open(struct vm_area_struct *vma)
 384 {
 385         struct file *file = vma->vm_file;
 386         struct sysfs_open_file *of = sysfs_of(file);
 387
 388         if (!of->vm_ops)
 389                 return;
 390
 391         if (!sysfs_get_active(of->sd))
 392                 return;
 393
 394         if (of->vm_ops->open)
 395                 of->vm_ops->open(vma);
 396
 397         sysfs_put_active(of->sd);
 398 }
 399
 400 static int kernfs_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 401 {
 402         struct file *file = vma->vm_file;
 403         struct sysfs_open_file *of = sysfs_of(file);
 404         int ret;
 405
 406         if (!of->vm_ops)
 407                 return VM_FAULT_SIGBUS;
 408
 409         if (!sysfs_get_active(of->sd))
 410                 return VM_FAULT_SIGBUS;
 411
 412         ret = VM_FAULT_SIGBUS;
 413         if (of->vm_ops->fault)
 414                 ret = of->vm_ops->fault(vma, vmf);
 415
 416         sysfs_put_active(of->sd);
 417         return ret;
 418 }
 419
 420 static int kernfs_vma_page_mkwrite(struct vm_area_struct *vma,
 421                                    struct vm_fault *vmf)
 422 {
 423         struct file *file = vma->vm_file;
 424         struct sysfs_open_file *of = sysfs_of(file);
 425         int ret;
 426
 427         if (!of->vm_ops)
 428                 return VM_FAULT_SIGBUS;
 429
 430         if (!sysfs_get_active(of->sd))
 431                 return VM_FAULT_SIGBUS;
 432
 433         ret = 0;
 434         if (of->vm_ops->page_mkwrite)
 435                 ret = of->vm_ops->page_mkwrite(vma, vmf);
 436         else
 437                 file_update_time(file);
 438
 439         sysfs_put_active(of->sd);
 440         return ret;
 441 }
 442
 443 static int kernfs_vma_access(struct vm_area_struct *vma, unsigned long addr,
 444                              void *buf, int len, int write)
 445 {
 446         struct file *file = vma->vm_file;
 447         struct sysfs_open_file *of = sysfs_of(file);
 448         int ret;
 449
 450         if (!of->vm_ops)
 451                 return -EINVAL;
 452
 453         if (!sysfs_get_active(of->sd))
 454                 return -EINVAL;
 455
 456         ret = -EINVAL;
 457         if (of->vm_ops->access)
 458                 ret = of->vm_ops->access(vma, addr, buf, len, write);
 459
 460         sysfs_put_active(of->sd);
 461         return ret;
 462 }
 463
 464 #ifdef CONFIG_NUMA
 465 static int kernfs_vma_set_policy(struct vm_area_struct *vma,
 466                                  struct mempolicy *new)
 467 {
 468         struct file *file = vma->vm_file;
 469         struct sysfs_open_file *of = sysfs_of(file);
 470         int ret;
 471
 472         if (!of->vm_ops)
 473                 return 0;
 474
 475         if (!sysfs_get_active(of->sd))
 476                 return -EINVAL;
 477
 478         ret = 0;
 479         if (of->vm_ops->set_policy)
 480                 ret = of->vm_ops->set_policy(vma, new);
 481
 482         sysfs_put_active(of->sd);
 483         return ret;
 484 }
 485
 486 static struct mempolicy *kernfs_vma_get_policy(struct vm_area_struct *vma,
 487                                                unsigned long addr)
 488 {
 489         struct file *file = vma->vm_file;
 490         struct sysfs_open_file *of = sysfs_of(file);
 491         struct mempolicy *pol;
 492
 493         if (!of->vm_ops)
 494                 return vma->vm_policy;
 495
 496         if (!sysfs_get_active(of->sd))
 497                 return vma->vm_policy;
 498
 499         pol = vma->vm_policy;
 500         if (of->vm_ops->get_policy)
 501                 pol = of->vm_ops->get_policy(vma, addr);
 502
 503         sysfs_put_active(of->sd);
 504         return pol;
 505 }
 506
 507 static int kernfs_vma_migrate(struct vm_area_struct *vma,
 508                               const nodemask_t *from, const nodemask_t *to,
 509                               unsigned long flags)
 510 {
 511         struct file *file = vma->vm_file;
 512         struct sysfs_open_file *of = sysfs_of(file);
 513         int ret;
 514
 515         if (!of->vm_ops)
 516                 return 0;
 517
 518         if (!sysfs_get_active(of->sd))
 519                 return 0;
 520
 521         ret = 0;
 522         if (of->vm_ops->migrate)
 523                 ret = of->vm_ops->migrate(vma, from, to, flags);
 524
 525         sysfs_put_active(of->sd);
 526         return ret;
 527 }
 528 #endif
 529
 530 static const struct vm_operations_struct kernfs_vm_ops = {
 531         .open           = kernfs_vma_open,
 532         .fault          = kernfs_vma_fault,
 533         .page_mkwrite   = kernfs_vma_page_mkwrite,
 534         .access         = kernfs_vma_access,
 535 #ifdef CONFIG_NUMA
 536         .set_policy     = kernfs_vma_set_policy,
 537         .get_policy     = kernfs_vma_get_policy,
 538         .migrate        = kernfs_vma_migrate,
 539 #endif
 540 };
 541
 542 static int kernfs_file_mmap(struct file *file, struct vm_area_struct *vma)
 543 {
 544         struct sysfs_open_file *of = sysfs_of(file);
 545         const struct kernfs_ops *ops;
 546         int rc;
 547
 548         mutex_lock(&of->mutex);
 549
 550         rc = -ENODEV;
 551         if (!sysfs_get_active(of->sd))
 552                 goto out_unlock;
 553
 554         ops = kernfs_ops(of->sd);
 555         if (ops->mmap)
 556                 rc = ops->mmap(of, vma);
 557         if (rc)
 558                 goto out_put;
 559
 560         /*
 561          * PowerPC's pci_mmap of legacy_mem uses shmem_zero_setup()
 562          * to satisfy versions of X which crash if the mmap fails: that
 563          * substitutes a new vm_file, and we don't then want bin_vm_ops.
 564          */
 565         if (vma->vm_file != file)
 566                 goto out_put;
 567
 568         rc = -EINVAL;
 569         if (of->mmapped && of->vm_ops != vma->vm_ops)
 570                 goto out_put;
 571
 572         /*
 573          * It is not possible to successfully wrap close.
 574          * So error if someone is trying to use close.
 575          */
 576         rc = -EINVAL;
 577         if (vma->vm_ops && vma->vm_ops->close)
 578                 goto out_put;
 579
 580         rc = 0;
 581         of->mmapped = 1;
 582         of->vm_ops = vma->vm_ops;
 583         vma->vm_ops = &kernfs_vm_ops;
 584 out_put:
 585         sysfs_put_active(of->sd);
 586 out_unlock:
 587         mutex_unlock(&of->mutex);
 588
 589         return rc;
 590 }
 591
 592 /**
 593  *      sysfs_get_open_dirent - get or create sysfs_open_dirent
 594  *      @sd: target sysfs_dirent
 595  *      @of: sysfs_open_file for this instance of open
 596  *
 597  *      If @sd->s_attr.open exists, increment its reference count;
 598  *      otherwise, create one.  @of is chained to the files list.
 599  *
 600  *      LOCKING:
 601  *      Kernel thread context (may sleep).
 602  *
 603  *      RETURNS:
 604  *      0 on success, -errno on failure.
 605  */
 606 static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
 607                                  struct sysfs_open_file *of)
 608 {
 609         struct sysfs_open_dirent *od, *new_od = NULL;
 610
 611  retry:
 612         mutex_lock(&sysfs_open_file_mutex);
 613         spin_lock_irq(&sysfs_open_dirent_lock);
 614
 615         if (!sd->s_attr.open && new_od) {
 616                 sd->s_attr.open = new_od;
 617                 new_od = NULL;
 618         }
 619
 620         od = sd->s_attr.open;
 621         if (od) {
 622                 atomic_inc(&od->refcnt);
 623                 list_add_tail(&of->list, &od->files);
 624         }
 625
 626         spin_unlock_irq(&sysfs_open_dirent_lock);
 627         mutex_unlock(&sysfs_open_file_mutex);
 628
 629         if (od) {
 630                 kfree(new_od);
 631                 return 0;
 632         }
 633
 634         /* not there, initialize a new one and retry */
 635         new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
 636         if (!new_od)
 637                 return -ENOMEM;
 638
 639         atomic_set(&new_od->refcnt, 0);
 640         atomic_set(&new_od->event, 1);
 641         init_waitqueue_head(&new_od->poll);
 642         INIT_LIST_HEAD(&new_od->files);
 643         goto retry;
 644 }
 645
 646 /**
 647  *      sysfs_put_open_dirent - put sysfs_open_dirent
 648  *      @sd: target sysfs_dirent
 649  *      @of: associated sysfs_open_file
 650  *
 651  *      Put @sd->s_attr.open and unlink @of from the files list.  If
 652  *      reference count reaches zero, disassociate and free it.
 653  *
 654  *      LOCKING:
 655  *      None.
 656  */
 657 static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
 658                                   struct sysfs_open_file *of)
 659 {
 660         struct sysfs_open_dirent *od = sd->s_attr.open;
 661         unsigned long flags;
 662
 663         mutex_lock(&sysfs_open_file_mutex);
 664         spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
 665
 666         if (of)
 667                 list_del(&of->list);
 668
 669         if (atomic_dec_and_test(&od->refcnt))
 670                 sd->s_attr.open = NULL;
 671         else
 672                 od = NULL;
 673
 674         spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
 675         mutex_unlock(&sysfs_open_file_mutex);
 676
 677         kfree(od);
 678 }
 679
 680 static int kernfs_file_open(struct inode *inode, struct file *file)
 681 {
 682         struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
 683         const struct kernfs_ops *ops;
 684         struct sysfs_open_file *of;
 685         bool has_read, has_write, has_mmap;
 686         int error = -EACCES;
 687
 688         if (!sysfs_get_active(attr_sd))
 689                 return -ENODEV;
 690
 691         ops = kernfs_ops(attr_sd);
 692
 693         has_read = ops->seq_show || ops->read || ops->mmap;
 694         has_write = ops->write || ops->mmap;
 695         has_mmap = ops->mmap;
 696
 697         /* check perms and supported operations */
 698         if ((file->f_mode & FMODE_WRITE) &&
 699             (!(inode->i_mode & S_IWUGO) || !has_write))
 700                 goto err_out;
 701
 702         if ((file->f_mode & FMODE_READ) &&
 703             (!(inode->i_mode & S_IRUGO) || !has_read))
 704                 goto err_out;
 705
 706         /* allocate a sysfs_open_file for the file */
 707         error = -ENOMEM;
 708         of = kzalloc(sizeof(struct sysfs_open_file), GFP_KERNEL);
 709         if (!of)
 710                 goto err_out;
 711
 712         /*
 713          * The following is done to give a different lockdep key to
 714          * @of->mutex for files which implement mmap.  This is a rather
 715          * crude way to avoid false positive lockdep warning around
 716          * mm->mmap_sem - mmap nests @of->mutex under mm->mmap_sem and
 717          * reading /sys/block/sda/trace/act_mask grabs sr_mutex, under
 718          * which mm->mmap_sem nests, while holding @of->mutex.  As each
 719          * open file has a separate mutex, it's okay as long as those don't
 720          * happen on the same file.  At this point, we can't easily give
 721          * each file a separate locking class.  Let's differentiate on
 722          * whether the file has mmap or not for now.
 723          */
 724         if (has_mmap)
 725                 mutex_init(&of->mutex);
 726         else
 727                 mutex_init(&of->mutex);
 728
 729         of->sd = attr_sd;
 730         of->file = file;
 731
 732         /*
 733          * Always instantiate seq_file even if read access doesn't use
 734          * seq_file or is not requested.  This unifies private data access
 735          * and readable regular files are the vast majority anyway.
 736          */
 737         if (ops->seq_show)
 738                 error = seq_open(file, &kernfs_seq_ops);
 739         else
 740                 error = seq_open(file, NULL);
 741         if (error)
 742                 goto err_free;
 743
 744         ((struct seq_file *)file->private_data)->private = of;
 745
 746         /* seq_file clears PWRITE unconditionally, restore it if WRITE */
 747         if (file->f_mode & FMODE_WRITE)
 748                 file->f_mode |= FMODE_PWRITE;
 749
 750         /* make sure we have open dirent struct */
 751         error = sysfs_get_open_dirent(attr_sd, of);
 752         if (error)
 753                 goto err_close;
 754
 755         /* open succeeded, put active references */
 756         sysfs_put_active(attr_sd);
 757         return 0;
 758
 759 err_close:
 760         seq_release(inode, file);
 761 err_free:
 762         kfree(of);
 763 err_out:
 764         sysfs_put_active(attr_sd);
 765         return error;
 766 }
 767
 768 static int kernfs_file_release(struct inode *inode, struct file *filp)
 769 {
 770         struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
 771         struct sysfs_open_file *of = sysfs_of(filp);
 772
 773         sysfs_put_open_dirent(sd, of);
 774         seq_release(inode, filp);
 775         kfree(of);
 776
 777         return 0;
 778 }
 779
 780 void sysfs_unmap_bin_file(struct sysfs_dirent *sd)
 781 {
 782         struct sysfs_open_dirent *od;
 783         struct sysfs_open_file *of;
 784
 785         if (!(sd->s_flags & SYSFS_FLAG_HAS_MMAP))
 786                 return;
 787
 788         spin_lock_irq(&sysfs_open_dirent_lock);
 789         od = sd->s_attr.open;
 790         if (od)
 791                 atomic_inc(&od->refcnt);
 792         spin_unlock_irq(&sysfs_open_dirent_lock);
 793         if (!od)
 794                 return;
 795
 796         mutex_lock(&sysfs_open_file_mutex);
 797         list_for_each_entry(of, &od->files, list) {
 798                 struct inode *inode = file_inode(of->file);
 799                 unmap_mapping_range(inode->i_mapping, 0, 0, 1);
 800         }
 801         mutex_unlock(&sysfs_open_file_mutex);
 802
 803         sysfs_put_open_dirent(sd, NULL);
 804 }
 805
 806 /* Sysfs attribute files are pollable.  The idea is that you read
 807  * the content and then you use 'poll' or 'select' to wait for
 808  * the content to change.  When the content changes (assuming the
 809  * manager for the kobject supports notification), poll will
 810  * return POLLERR|POLLPRI, and select will return the fd whether
 811  * it is waiting for read, write, or exceptions.
 812  * Once poll/select indicates that the value has changed, you
 813  * need to close and re-open the file, or seek to 0 and read again.
 814  * Reminder: this only works for attributes which actively support
 815  * it, and it is not possible to test an attribute from userspace
 816  * to see if it supports poll (Neither 'poll' nor 'select' return
 817  * an appropriate error code).  When in doubt, set a suitable timeout value.
 818  */
 819 static unsigned int kernfs_file_poll(struct file *filp, poll_table *wait)
 820 {
 821         struct sysfs_open_file *of = sysfs_of(filp);
 822         struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
 823         struct sysfs_open_dirent *od = attr_sd->s_attr.open;
 824
 825         /* need parent for the kobj, grab both */
 826         if (!sysfs_get_active(attr_sd))
 827                 goto trigger;
 828
 829         poll_wait(filp, &od->poll, wait);
 830
 831         sysfs_put_active(attr_sd);
 832
 833         if (of->event != atomic_read(&od->event))
 834                 goto trigger;
 835
 836         return DEFAULT_POLLMASK;
 837
 838  trigger:
 839         return DEFAULT_POLLMASK|POLLERR|POLLPRI;
 840 }
 841
 842 void sysfs_notify_dirent(struct sysfs_dirent *sd)
 843 {
 844         struct sysfs_open_dirent *od;
 845         unsigned long flags;
 846
 847         spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
 848
 849         if (!WARN_ON(sysfs_type(sd) != SYSFS_KOBJ_ATTR)) {
 850                 od = sd->s_attr.open;
 851                 if (od) {
 852                         atomic_inc(&od->event);
 853                         wake_up_interruptible(&od->poll);
 854                 }
 855         }
 856
 857         spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
 858 }
 859 EXPORT_SYMBOL_GPL(sysfs_notify_dirent);
 860
 861 void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
 862 {
 863         struct sysfs_dirent *sd = k->sd;
 864
 865         mutex_lock(&sysfs_mutex);
 866
 867         if (sd && dir)
 868                 sd = sysfs_find_dirent(sd, dir, NULL);
 869         if (sd && attr)
 870                 sd = sysfs_find_dirent(sd, attr, NULL);
 871         if (sd)
 872                 sysfs_notify_dirent(sd);
 873
 874         mutex_unlock(&sysfs_mutex);
 875 }
 876 EXPORT_SYMBOL_GPL(sysfs_notify);
 877
 878 const struct file_operations kernfs_file_operations = {
 879         .read           = kernfs_file_read,
 880         .write          = kernfs_file_write,
 881         .llseek         = generic_file_llseek,
 882         .mmap           = kernfs_file_mmap,
 883         .open           = kernfs_file_open,
 884         .release        = kernfs_file_release,
 885         .poll           = kernfs_file_poll,
 886 };
 887
 888 static const struct kernfs_ops sysfs_file_kfops_empty = {
 889 };
 890
 891 static const struct kernfs_ops sysfs_file_kfops_ro = {
 892         .seq_show       = sysfs_kf_seq_show,
 893 };
 894
 895 static const struct kernfs_ops sysfs_file_kfops_wo = {
 896         .write          = sysfs_kf_write,
 897 };
 898
 899 static const struct kernfs_ops sysfs_file_kfops_rw = {
 900         .seq_show       = sysfs_kf_seq_show,
 901         .write          = sysfs_kf_write,
 902 };
 903
 904 static const struct kernfs_ops sysfs_bin_kfops_ro = {
 905         .read           = sysfs_kf_bin_read,
 906 };
 907
 908 static const struct kernfs_ops sysfs_bin_kfops_wo = {
 909         .write          = sysfs_kf_bin_write,
 910 };
 911
 912 static const struct kernfs_ops sysfs_bin_kfops_rw = {
 913         .read           = sysfs_kf_bin_read,
 914         .write          = sysfs_kf_bin_write,
 915         .mmap           = sysfs_kf_bin_mmap,
 916 };
 917
 918 int sysfs_add_file_mode_ns(struct sysfs_dirent *dir_sd,
 919                            const struct attribute *attr, int type,
 920                            umode_t amode, const void *ns)
 921 {
 922         umode_t mode = (amode & S_IALLUGO) | S_IFREG;
 923         const struct kernfs_ops *ops;
 924         struct sysfs_addrm_cxt acxt;
 925         struct sysfs_dirent *sd;
 926         int rc;
 927
 928         if (type == SYSFS_KOBJ_ATTR) {
 929                 struct kobject *kobj = dir_sd->priv;
 930                 const struct sysfs_ops *sysfs_ops = kobj->ktype->sysfs_ops;
 931
 932                 /* every kobject with an attribute needs a ktype assigned */
 933                 if (WARN(!sysfs_ops, KERN_ERR
 934                          "missing sysfs attribute operations for kobject: %s\n",
 935                          kobject_name(kobj)))
 936                         return -EINVAL;
 937
 938                 if (sysfs_ops->show && sysfs_ops->store)
 939                         ops = &sysfs_file_kfops_rw;
 940                 else if (sysfs_ops->show)
 941                         ops = &sysfs_file_kfops_ro;
 942                 else if (sysfs_ops->store)
 943                         ops = &sysfs_file_kfops_wo;
 944                 else
 945                         ops = &sysfs_file_kfops_empty;
 946         } else {
 947                 struct bin_attribute *battr = (void *)attr;
 948
 949                 if ((battr->read && battr->write) || battr->mmap)
 950                         ops = &sysfs_bin_kfops_rw;
 951                 else if (battr->read)
 952                         ops = &sysfs_bin_kfops_ro;
 953                 else if (battr->write)
 954                         ops = &sysfs_bin_kfops_wo;
 955                 else
 956                         ops = &sysfs_file_kfops_empty;
 957         }
 958
 959         sd = sysfs_new_dirent(attr->name, mode, type);
 960         if (!sd)
 961                 return -ENOMEM;
 962
 963         sd->s_attr.ops = ops;
 964         sd->s_ns = ns;
 965         sd->priv = (void *)attr;
 966         sysfs_dirent_init_lockdep(sd);
 967
 968         /*
 969          * sd->s_attr.ops is accesible only while holding active ref.  We
 970          * need to know whether some ops are implemented outside active
 971          * ref.  Cache their existence in flags.
 972          */
 973         if (ops->seq_show)
 974                 sd->s_flags |= SYSFS_FLAG_HAS_SEQ_SHOW;
 975         if (ops->mmap)
 976                 sd->s_flags |= SYSFS_FLAG_HAS_MMAP;
 977
 978         sysfs_addrm_start(&acxt);
 979         rc = sysfs_add_one(&acxt, sd, dir_sd);
 980         sysfs_addrm_finish(&acxt);
 981
 982         if (rc)
 983                 sysfs_put(sd);
 984
 985         return rc;
 986 }
 987
 988
 989 int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
 990                    int type)
 991 {
 992         return sysfs_add_file_mode_ns(dir_sd, attr, type, attr->mode, NULL);
 993 }
 994
 995 /**
 996  * sysfs_create_file_ns - create an attribute file for an object with custom ns
 997  * @kobj: object we're creating for
 998  * @attr: attribute descriptor
 999  * @ns: namespace the new file should belong to
1000  */
1001 int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
1002                          const void *ns)
1003 {
1004         BUG_ON(!kobj || !kobj->sd || !attr);
1005
1006         return sysfs_add_file_mode_ns(kobj->sd, attr, SYSFS_KOBJ_ATTR,
1007                                       attr->mode, ns);
1008
1009 }
1010 EXPORT_SYMBOL_GPL(sysfs_create_file_ns);
1011
1012 int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
1013 {
1014         int err = 0;
1015         int i;
1016
1017         for (i = 0; ptr[i] && !err; i++)
1018                 err = sysfs_create_file(kobj, ptr[i]);
1019         if (err)
1020                 while (--i >= 0)
1021                         sysfs_remove_file(kobj, ptr[i]);
1022         return err;
1023 }
1024 EXPORT_SYMBOL_GPL(sysfs_create_files);
1025
1026 /**
1027  * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
1028  * @kobj: object we're acting for.
1029  * @attr: attribute descriptor.
1030  * @group: group name.
1031  */
1032 int sysfs_add_file_to_group(struct kobject *kobj,
1033                 const struct attribute *attr, const char *group)
1034 {
1035         struct sysfs_dirent *dir_sd;
1036         int error;
1037
1038         if (group)
1039                 dir_sd = sysfs_get_dirent(kobj->sd, group);
1040         else
1041                 dir_sd = sysfs_get(kobj->sd);
1042
1043         if (!dir_sd)
1044                 return -ENOENT;
1045
1046         error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
1047         sysfs_put(dir_sd);
1048
1049         return error;
1050 }
1051 EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
1052
1053 /**
1054  * sysfs_chmod_file - update the modified mode value on an object attribute.
1055  * @kobj: object we're acting for.
1056  * @attr: attribute descriptor.
1057  * @mode: file permissions.
1058  *
1059  */
1060 int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
1061                      umode_t mode)
1062 {
1063         struct sysfs_dirent *sd;
1064         struct iattr newattrs;
1065         int rc;
1066
1067         sd = sysfs_get_dirent(kobj->sd, attr->name);
1068         if (!sd)
1069                 return -ENOENT;
1070
1071         newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
1072         newattrs.ia_valid = ATTR_MODE;
1073
1074         rc = kernfs_setattr(sd, &newattrs);
1075
1076         sysfs_put(sd);
1077         return rc;
1078 }
1079 EXPORT_SYMBOL_GPL(sysfs_chmod_file);
1080
1081 /**
1082  * sysfs_remove_file_ns - remove an object attribute with a custom ns tag
1083  * @kobj: object we're acting for
1084  * @attr: attribute descriptor
1085  * @ns: namespace tag of the file to remove
1086  *
1087  * Hash the attribute name and namespace tag and kill the victim.
1088  */
1089 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
1090                           const void *ns)
1091 {
1092         struct sysfs_dirent *dir_sd = kobj->sd;
1093
1094         kernfs_remove_by_name_ns(dir_sd, attr->name, ns);
1095 }
1096 EXPORT_SYMBOL_GPL(sysfs_remove_file_ns);
1097
1098 void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
1099 {
1100         int i;
1101         for (i = 0; ptr[i]; i++)
1102                 sysfs_remove_file(kobj, ptr[i]);
1103 }
1104 EXPORT_SYMBOL_GPL(sysfs_remove_files);
1105
1106 /**
1107  * sysfs_remove_file_from_group - remove an attribute file from a group.
1108  * @kobj: object we're acting for.
1109  * @attr: attribute descriptor.
1110  * @group: group name.
1111  */
1112 void sysfs_remove_file_from_group(struct kobject *kobj,
1113                 const struct attribute *attr, const char *group)
1114 {
1115         struct sysfs_dirent *dir_sd;
1116
1117         if (group)
1118                 dir_sd = sysfs_get_dirent(kobj->sd, group);
1119         else
1120                 dir_sd = sysfs_get(kobj->sd);
1121         if (dir_sd) {
1122                 kernfs_remove_by_name(dir_sd, attr->name);
1123                 sysfs_put(dir_sd);
1124         }
1125 }
1126 EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
1127
1128 /**
1129  *      sysfs_create_bin_file - create binary file for object.
1130  *      @kobj:  object.
1131  *      @attr:  attribute descriptor.
1132  */
1133 int sysfs_create_bin_file(struct kobject *kobj,
1134                           const struct bin_attribute *attr)
1135 {
1136         BUG_ON(!kobj || !kobj->sd || !attr);
1137
1138         return sysfs_add_file(kobj->sd, &attr->attr, SYSFS_KOBJ_BIN_ATTR);
1139 }
1140 EXPORT_SYMBOL_GPL(sysfs_create_bin_file);
1141
1142 /**
1143  *      sysfs_remove_bin_file - remove binary file for object.
1144  *      @kobj:  object.
1145  *      @attr:  attribute descriptor.
1146  */
1147 void sysfs_remove_bin_file(struct kobject *kobj,
1148                            const struct bin_attribute *attr)
1149 {
1150         kernfs_remove_by_name(kobj->sd, attr->attr.name);
1151 }
1152 EXPORT_SYMBOL_GPL(sysfs_remove_bin_file);
1153
1154 struct sysfs_schedule_callback_struct {
1155         struct list_head        workq_list;
1156         struct kobject          *kobj;
1157         void                    (*func)(void *);
1158         void                    *data;
1159         struct module           *owner;
1160         struct work_struct      work;
1161 };
1162
1163 static struct workqueue_struct *sysfs_workqueue;
1164 static DEFINE_MUTEX(sysfs_workq_mutex);
1165 static LIST_HEAD(sysfs_workq);
1166 static void sysfs_schedule_callback_work(struct work_struct *work)
1167 {
1168         struct sysfs_schedule_callback_struct *ss = container_of(work,
1169                         struct sysfs_schedule_callback_struct, work);
1170
1171         (ss->func)(ss->data);
1172         kobject_put(ss->kobj);
1173         module_put(ss->owner);
1174         mutex_lock(&sysfs_workq_mutex);
1175         list_del(&ss->workq_list);
1176         mutex_unlock(&sysfs_workq_mutex);
1177         kfree(ss);
1178 }
1179
1180 /**
1181  * sysfs_schedule_callback - helper to schedule a callback for a kobject
1182  * @kobj: object we're acting for.
1183  * @func: callback function to invoke later.
1184  * @data: argument to pass to @func.
1185  * @owner: module owning the callback code
1186  *
1187  * sysfs attribute methods must not unregister themselves or their parent
1188  * kobject (which would amount to the same thing).  Attempts to do so will
1189  * deadlock, since unregistration is mutually exclusive with driver
1190  * callbacks.
1191  *
1192  * Instead methods can call this routine, which will attempt to allocate
1193  * and schedule a workqueue request to call back @func with @data as its
1194  * argument in the workqueue's process context.  @kobj will be pinned
1195  * until @func returns.
1196  *
1197  * Returns 0 if the request was submitted, -ENOMEM if storage could not
1198  * be allocated, -ENODEV if a reference to @owner isn't available,
1199  * -EAGAIN if a callback has already been scheduled for @kobj.
1200  */
1201 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
1202                 void *data, struct module *owner)
1203 {
1204         struct sysfs_schedule_callback_struct *ss, *tmp;
1205
1206         if (!try_module_get(owner))
1207                 return -ENODEV;
1208
1209         mutex_lock(&sysfs_workq_mutex);
1210         list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
1211                 if (ss->kobj == kobj) {
1212                         module_put(owner);
1213                         mutex_unlock(&sysfs_workq_mutex);
1214                         return -EAGAIN;
1215                 }
1216         mutex_unlock(&sysfs_workq_mutex);
1217
1218         if (sysfs_workqueue == NULL) {
1219                 sysfs_workqueue = create_singlethread_workqueue("sysfsd");
1220                 if (sysfs_workqueue == NULL) {
1221                         module_put(owner);
1222                         return -ENOMEM;
1223                 }
1224         }
1225
1226         ss = kmalloc(sizeof(*ss), GFP_KERNEL);
1227         if (!ss) {
1228                 module_put(owner);
1229                 return -ENOMEM;
1230         }
1231         kobject_get(kobj);
1232         ss->kobj = kobj;
1233         ss->func = func;
1234         ss->data = data;
1235         ss->owner = owner;
1236         INIT_WORK(&ss->work, sysfs_schedule_callback_work);
1237         INIT_LIST_HEAD(&ss->workq_list);
1238         mutex_lock(&sysfs_workq_mutex);
1239         list_add_tail(&ss->workq_list, &sysfs_workq);
1240         mutex_unlock(&sysfs_workq_mutex);
1241         queue_work(sysfs_workqueue, &ss->work);
1242         return 0;
1243 }
1244 EXPORT_SYMBOL_GPL(sysfs_schedule_callback);