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